Update in-tree GCC to 3.4.4.
[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, 2005 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, 2005 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}
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 -threads -pthreads}
371
372 @emph{ARM Options}
373 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
374 -mapcs-26  -mapcs-32 @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -malignment-traps  -mno-alignment-traps @gol
381 -msoft-float  -mhard-float  -mfpe @gol
382 -mthumb-interwork  -mno-thumb-interwork @gol
383 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
384 -mstructure-size-boundary=@var{n} @gol
385 -mabort-on-noreturn @gol
386 -mlong-calls  -mno-long-calls @gol
387 -msingle-pic-base  -mno-single-pic-base @gol
388 -mpic-register=@var{reg} @gol
389 -mnop-fun-dllimport @gol
390 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
391 -mpoke-function-name @gol
392 -mthumb  -marm @gol
393 -mtpcs-frame  -mtpcs-leaf-frame @gol
394 -mcaller-super-interworking  -mcallee-super-interworking}
395
396 @emph{MN10300 Options}
397 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
398 -mam33  -mno-am33 @gol
399 -mam33-2  -mno-am33-2 @gol
400 -mno-crt0  -mrelax}
401
402 @emph{M32R/D Options}
403 @gccoptlist{-m32r2 -m32rx -m32r @gol
404 -mdebug @gol
405 -malign-loops -mno-align-loops @gol
406 -missue-rate=@var{number} @gol
407 -mbranch-cost=@var{number} @gol
408 -mmodel=@var{code-size-model-type} @gol
409 -msdata=@var{sdata-type} @gol
410 -mno-flush-func -mflush-func=@var{name} @gol
411 -mno-flush-trap -mflush-trap=@var{number} @gol
412 -G @var{num}}
413
414 @emph{RS/6000 and PowerPC Options}
415 @gccoptlist{-mcpu=@var{cpu-type} @gol
416 -mtune=@var{cpu-type} @gol
417 -mpower  -mno-power  -mpower2  -mno-power2 @gol
418 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
419 -maltivec  -mno-altivec @gol
420 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
421 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
422 -mnew-mnemonics  -mold-mnemonics @gol
423 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
424 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
425 -malign-power  -malign-natural @gol
426 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
427 -mstring  -mno-string  -mupdate  -mno-update @gol
428 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
429 -mstrict-align  -mno-strict-align  -mrelocatable @gol
430 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
431 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
432 -mdynamic-no-pic @gol
433 -mprioritize-restricted-insns=@var{priority} @gol
434 -msched-costly-dep=@var{dependence_type} @gol
435 -minsert-sched-nops=@var{scheme} @gol
436 -mcall-sysv  -mcall-netbsd @gol
437 -maix-struct-return  -msvr4-struct-return @gol
438 -mabi=altivec  -mabi=no-altivec @gol
439 -mabi=spe  -mabi=no-spe @gol
440 -misel=yes  -misel=no @gol
441 -mspe=yes  -mspe=no @gol
442 -mfloat-gprs=yes  -mfloat-gprs=no @gol
443 -mprototype  -mno-prototype @gol
444 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
445 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
446
447 @emph{Darwin Options}
448 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
449 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
450 -client_name  -compatibility_version  -current_version @gol
451 -dependency-file  -dylib_file  -dylinker_install_name @gol
452 -dynamic  -dynamiclib  -exported_symbols_list @gol
453 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
454 -force_flat_namespace  -headerpad_max_install_names @gol
455 -image_base  -init  -install_name  -keep_private_externs @gol
456 -multi_module  -multiply_defined  -multiply_defined_unused @gol
457 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
458 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
459 -private_bundle  -read_only_relocs  -sectalign @gol
460 -sectobjectsymbols  -whyload  -seg1addr @gol
461 -sectcreate  -sectobjectsymbols  -sectorder @gol
462 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
463 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
464 -single_module  -static  -sub_library  -sub_umbrella @gol
465 -twolevel_namespace  -umbrella  -undefined @gol
466 -unexported_symbols_list  -weak_reference_mismatches @gol
467 -whatsloaded}
468
469 @emph{MIPS Options}
470 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
471 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
472 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
473 -mxgot  -mno-xgot  -membedded-pic  -mno-embedded-pic @gol
474 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
475 -msingle-float  -mdouble-float  -mint64  -mlong64  -mlong32 @gol
476 -G@var{num}  -membedded-data  -mno-embedded-data @gol
477 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
478 -msplit-addresses  -mno-split-addresses  @gol
479 -mexplicit-relocs  -mno-explicit-relocs  @gol
480 -mrnames  -mno-rnames @gol
481 -mcheck-zero-division  -mno-check-zero-division @gol
482 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
483 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
484 -mfix-sb1  -mno-fix-sb1  -mflush-func=@var{func} @gol
485 -mno-flush-func  -mbranch-likely  -mno-branch-likely}
486
487 @emph{i386 and x86-64 Options}
488 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
489 -mfpmath=@var{unit} @gol
490 -masm=@var{dialect}  -mno-fancy-math-387 @gol
491 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
492 -mno-wide-multiply  -mrtd  -malign-double @gol
493 -mpreferred-stack-boundary=@var{num} @gol
494 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
495 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
496 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
497 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
498 -mno-red-zone -mno-tls-direct-seg-refs @gol
499 -mcmodel=@var{code-model} @gol
500 -m32  -m64}
501
502 @emph{HPPA Options}
503 @gccoptlist{-march=@var{architecture-type} @gol
504 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
505 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
506 -mjump-in-delay -mlinker-opt -mlong-calls @gol
507 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
508 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
509 -mno-jump-in-delay  -mno-long-load-store @gol
510 -mno-portable-runtime  -mno-soft-float @gol
511 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
512 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
513 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
514 -nolibdld  -static  -threads}
515
516 @emph{Intel 960 Options}
517 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
518 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
519 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
520 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
521 -mno-complex-addr  -mno-leaf-procedures @gol
522 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
523 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
524 -mtail-call}
525
526 @emph{DEC Alpha Options}
527 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
528 -mieee  -mieee-with-inexact  -mieee-conformant @gol
529 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
530 -mtrap-precision=@var{mode}  -mbuild-constants @gol
531 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
532 -mbwx  -mmax  -mfix  -mcix @gol
533 -mfloat-vax  -mfloat-ieee @gol
534 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
535 -msmall-text  -mlarge-text @gol
536 -mmemory-latency=@var{time}}
537
538 @emph{DEC Alpha/VMS Options}
539 @gccoptlist{-mvms-return-codes}
540
541 @emph{H8/300 Options}
542 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
543
544 @emph{SH Options}
545 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
546 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
547 -m5-64media  -m5-64media-nofpu @gol
548 -m5-32media  -m5-32media-nofpu @gol
549 -m5-compact  -m5-compact-nofpu @gol
550 -mb  -ml  -mdalign  -mrelax @gol
551 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
552 -mieee  -misize  -mpadstruct  -mspace @gol
553 -mprefergot  -musermode}
554
555 @emph{System V Options}
556 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
557
558 @emph{ARC Options}
559 @gccoptlist{-EB  -EL @gol
560 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
561 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
562
563 @emph{TMS320C3x/C4x Options}
564 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
565 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
566 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
567 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
568
569 @emph{V850 Options}
570 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
571 -mprolog-function  -mno-prolog-function  -mspace @gol
572 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
573 -mapp-regs  -mno-app-regs @gol
574 -mdisable-callt  -mno-disable-callt @gol
575 -mv850e1 @gol
576 -mv850e @gol
577 -mv850  -mbig-switch}
578
579 @emph{NS32K Options}
580 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
581 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
582 -mregparam  -mnoregparam  -msb  -mnosb @gol
583 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
584
585 @emph{AVR Options}
586 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
587 -mcall-prologues  -mno-tablejump  -mtiny-stack}
588
589 @emph{MCore Options}
590 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
591 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
592 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
593 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
594 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
595
596 @emph{MMIX Options}
597 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
598 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
599 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
600 -mno-base-addresses  -msingle-exit  -mno-single-exit}
601
602 @emph{IA-64 Options}
603 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
604 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
605 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
606 -minline-float-divide-max-throughput @gol
607 -minline-int-divide-min-latency @gol
608 -minline-int-divide-max-throughput  @gol
609 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
610 -mno-dwarf2-asm -mearly-stop-bits @gol
611 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
612 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
613
614 @emph{D30V Options}
615 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
616 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
617
618 @emph{S/390 and zSeries Options}
619 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
620 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
621 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
622 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
623
624 @emph{CRIS Options}
625 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
626 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
627 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
628 -mstack-align  -mdata-align  -mconst-align @gol
629 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
630 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
631 -mmul-bug-workaround  -mno-mul-bug-workaround}
632
633 @emph{PDP-11 Options}
634 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
635 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
636 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
637 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
638 -mbranch-expensive  -mbranch-cheap @gol
639 -msplit  -mno-split  -munix-asm  -mdec-asm}
640
641 @emph{Xstormy16 Options}
642 @gccoptlist{-msim}
643
644 @emph{Xtensa Options}
645 @gccoptlist{-mconst16 -mno-const16 @gol
646 -mfused-madd  -mno-fused-madd @gol
647 -mtext-section-literals  -mno-text-section-literals @gol
648 -mtarget-align  -mno-target-align @gol
649 -mlongcalls  -mno-longcalls}
650
651 @emph{FRV Options}
652 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
653 -mhard-float  -msoft-float @gol
654 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
655 -mdouble  -mno-double @gol
656 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
657 -mlibrary-pic  -macc-4 -macc-8 @gol
658 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
659 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
660 -mvliw-branch  -mno-vliw-branch @gol
661 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
662 -mno-nested-cond-exec  -mtomcat-stats @gol
663 -mcpu=@var{cpu}}
664
665 @item Code Generation Options
666 @xref{Code Gen Options,,Options for Code Generation Conventions}.
667 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
668 -ffixed-@var{reg}  -fexceptions @gol
669 -fnon-call-exceptions  -funwind-tables @gol
670 -fasynchronous-unwind-tables @gol
671 -finhibit-size-directive  -finstrument-functions @gol
672 -fno-common  -fno-ident @gol
673 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
674 -freg-struct-return  -fshared-data  -fshort-enums @gol
675 -fshort-double  -fshort-wchar @gol
676 -fverbose-asm  -fpack-struct  -fstack-check @gol
677 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
678 -fargument-alias  -fargument-noalias @gol
679 -fargument-noalias-global  -fleading-underscore @gol
680 -ftls-model=@var{model} @gol
681 -ftrapv  -fwrapv  -fbounds-check}
682 @end table
683
684 @menu
685 * Overall Options::     Controlling the kind of output:
686                         an executable, object files, assembler files,
687                         or preprocessed source.
688 * C Dialect Options::   Controlling the variant of C language compiled.
689 * C++ Dialect Options:: Variations on C++.
690 * Objective-C Dialect Options:: Variations on Objective-C.
691 * Language Independent Options:: Controlling how diagnostics should be
692                         formatted.
693 * Warning Options::     How picky should the compiler be?
694 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
695 * Optimize Options::    How much optimization?
696 * Preprocessor Options:: Controlling header files and macro definitions.
697                          Also, getting dependency information for Make.
698 * Assembler Options::   Passing options to the assembler.
699 * Link Options::        Specifying libraries and so on.
700 * Directory Options::   Where to find header files and libraries.
701                         Where to find the compiler executable files.
702 * Spec Files::          How to pass switches to sub-processes.
703 * Target Options::      Running a cross-compiler, or an old version of GCC.
704 @end menu
705
706 @node Overall Options
707 @section Options Controlling the Kind of Output
708
709 Compilation can involve up to four stages: preprocessing, compilation
710 proper, assembly and linking, always in that order.  GCC is capable of
711 preprocessing and compiling several files either into several
712 assembler input files, or into one assembler input file; then each
713 assembler input file produces an object file, and linking combines all
714 the object files (those newly compiled, and those specified as input)
715 into an executable file.
716
717 @cindex file name suffix
718 For any given input file, the file name suffix determines what kind of
719 compilation is done:
720
721 @table @gcctabopt
722 @item @var{file}.c
723 C source code which must be preprocessed.
724
725 @item @var{file}.i
726 C source code which should not be preprocessed.
727
728 @item @var{file}.ii
729 C++ source code which should not be preprocessed.
730
731 @item @var{file}.m
732 Objective-C source code.  Note that you must link with the library
733 @file{libobjc.a} to make an Objective-C program work.
734
735 @item @var{file}.mi
736 Objective-C source code which should not be preprocessed.
737
738 @item @var{file}.h
739 C or C++ header file to be turned into a precompiled header.
740
741 @item @var{file}.cc
742 @itemx @var{file}.cp
743 @itemx @var{file}.cxx
744 @itemx @var{file}.cpp
745 @itemx @var{file}.CPP
746 @itemx @var{file}.c++
747 @itemx @var{file}.C
748 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
749 the last two letters must both be literally @samp{x}.  Likewise,
750 @samp{.C} refers to a literal capital C@.
751
752 @item @var{file}.hh
753 @itemx @var{file}.H
754 C++ header file to be turned into a precompiled header.
755
756 @item @var{file}.f
757 @itemx @var{file}.for
758 @itemx @var{file}.FOR
759 Fortran source code which should not be preprocessed.
760
761 @item @var{file}.F
762 @itemx @var{file}.fpp
763 @itemx @var{file}.FPP
764 Fortran source code which must be preprocessed (with the traditional
765 preprocessor).
766
767 @item @var{file}.r
768 Fortran source code which must be preprocessed with a RATFOR
769 preprocessor (not included with GCC)@.
770
771 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
772 Using and Porting GNU Fortran}, for more details of the handling of
773 Fortran input files.
774
775 @c FIXME: Descriptions of Java file types.
776 @c @var{file}.java
777 @c @var{file}.class
778 @c @var{file}.zip
779 @c @var{file}.jar
780
781 @item @var{file}.ads
782 Ada source code file which contains a library unit declaration (a
783 declaration of a package, subprogram, or generic, or a generic
784 instantiation), or a library unit renaming declaration (a package,
785 generic, or subprogram renaming declaration).  Such files are also
786 called @dfn{specs}.
787
788 @itemx @var{file}.adb
789 Ada source code file containing a library unit body (a subprogram or
790 package body).  Such files are also called @dfn{bodies}.
791
792 @c GCC also knows about some suffixes for languages not yet included:
793 @c Pascal:
794 @c @var{file}.p
795 @c @var{file}.pas
796
797 @item @var{file}.s
798 Assembler code.
799
800 @item @var{file}.S
801 Assembler code which must be preprocessed.
802
803 @item @var{other}
804 An object file to be fed straight into linking.
805 Any file name with no recognized suffix is treated this way.
806 @end table
807
808 @opindex x
809 You can specify the input language explicitly with the @option{-x} option:
810
811 @table @gcctabopt
812 @item -x @var{language}
813 Specify explicitly the @var{language} for the following input files
814 (rather than letting the compiler choose a default based on the file
815 name suffix).  This option applies to all following input files until
816 the next @option{-x} option.  Possible values for @var{language} are:
817 @smallexample
818 c  c-header  cpp-output
819 c++  c++-header  c++-cpp-output
820 objective-c  objective-c-header  objc-cpp-output
821 assembler  assembler-with-cpp
822 ada
823 f77  f77-cpp-input  ratfor
824 java
825 treelang
826 @end smallexample
827
828 @item -x none
829 Turn off any specification of a language, so that subsequent files are
830 handled according to their file name suffixes (as they are if @option{-x}
831 has not been used at all).
832
833 @item -pass-exit-codes
834 @opindex pass-exit-codes
835 Normally the @command{gcc} program will exit with the code of 1 if any
836 phase of the compiler returns a non-success return code.  If you specify
837 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
838 numerically highest error produced by any phase that returned an error
839 indication.
840 @end table
841
842 If you only want some of the stages of compilation, you can use
843 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
844 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
845 @command{gcc} is to stop.  Note that some combinations (for example,
846 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
847
848 @table @gcctabopt
849 @item -c
850 @opindex c
851 Compile or assemble the source files, but do not link.  The linking
852 stage simply is not done.  The ultimate output is in the form of an
853 object file for each source file.
854
855 By default, the object file name for a source file is made by replacing
856 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
857
858 Unrecognized input files, not requiring compilation or assembly, are
859 ignored.
860
861 @item -S
862 @opindex S
863 Stop after the stage of compilation proper; do not assemble.  The output
864 is in the form of an assembler code file for each non-assembler input
865 file specified.
866
867 By default, the assembler file name for a source file is made by
868 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
869
870 Input files that don't require compilation are ignored.
871
872 @item -E
873 @opindex E
874 Stop after the preprocessing stage; do not run the compiler proper.  The
875 output is in the form of preprocessed source code, which is sent to the
876 standard output.
877
878 Input files which don't require preprocessing are ignored.
879
880 @cindex output file option
881 @item -o @var{file}
882 @opindex o
883 Place output in file @var{file}.  This applies regardless to whatever
884 sort of output is being produced, whether it be an executable file,
885 an object file, an assembler file or preprocessed C code.
886
887 If you specify @option{-o} when compiling more than one input file, or
888 you are producing an executable file as output, all the source files
889 on the command line will be compiled at once.
890
891 If @option{-o} is not specified, the default is to put an executable file
892 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
893 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
894 all preprocessed C source on standard output.
895
896 @item -v
897 @opindex v
898 Print (on standard error output) the commands executed to run the stages
899 of compilation.  Also print the version number of the compiler driver
900 program and of the preprocessor and the compiler proper.
901
902 @item -###
903 @opindex ###
904 Like @option{-v} except the commands are not executed and all command
905 arguments are quoted.  This is useful for shell scripts to capture the
906 driver-generated command lines.
907
908 @item -pipe
909 @opindex pipe
910 Use pipes rather than temporary files for communication between the
911 various stages of compilation.  This fails to work on some systems where
912 the assembler is unable to read from a pipe; but the GNU assembler has
913 no trouble.
914
915 @item --help
916 @opindex help
917 Print (on the standard output) a description of the command line options
918 understood by @command{gcc}.  If the @option{-v} option is also specified
919 then @option{--help} will also be passed on to the various processes
920 invoked by @command{gcc}, so that they can display the command line options
921 they accept.  If the @option{-Wextra} option is also specified then command
922 line options which have no documentation associated with them will also
923 be displayed.
924
925 @item --target-help
926 @opindex target-help
927 Print (on the standard output) a description of target specific command
928 line options for each tool.
929
930 @item --version
931 @opindex version
932 Display the version number and copyrights of the invoked GCC.
933 @end table
934
935 @node Invoking G++
936 @section Compiling C++ Programs
937
938 @cindex suffixes for C++ source
939 @cindex C++ source file suffixes
940 C++ source files conventionally use one of the suffixes @samp{.C},
941 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
942 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
943 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
944 files with these names and compiles them as C++ programs even if you
945 call the compiler the same way as for compiling C programs (usually
946 with the name @command{gcc}).
947
948 @findex g++
949 @findex c++
950 However, C++ programs often require class libraries as well as a
951 compiler that understands the C++ language---and under some
952 circumstances, you might want to compile programs or header files from
953 standard input, or otherwise without a suffix that flags them as C++
954 programs.  You might also like to precompile a C header file with a
955 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
956 program that calls GCC with the default language set to C++, and
957 automatically specifies linking against the C++ library.  On many
958 systems, @command{g++} is also installed with the name @command{c++}.
959
960 @cindex invoking @command{g++}
961 When you compile C++ programs, you may specify many of the same
962 command-line options that you use for compiling programs in any
963 language; or command-line options meaningful for C and related
964 languages; or options that are meaningful only for C++ programs.
965 @xref{C Dialect Options,,Options Controlling C Dialect}, for
966 explanations of options for languages related to C@.
967 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
968 explanations of options that are meaningful only for C++ programs.
969
970 @node C Dialect Options
971 @section Options Controlling C Dialect
972 @cindex dialect options
973 @cindex language dialect options
974 @cindex options, dialect
975
976 The following options control the dialect of C (or languages derived
977 from C, such as C++ and Objective-C) that the compiler accepts:
978
979 @table @gcctabopt
980 @cindex ANSI support
981 @cindex ISO support
982 @item -ansi
983 @opindex ansi
984 In C mode, support all ISO C90 programs.  In C++ mode,
985 remove GNU extensions that conflict with ISO C++.
986
987 This turns off certain features of GCC that are incompatible with ISO
988 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
989 such as the @code{asm} and @code{typeof} keywords, and
990 predefined macros such as @code{unix} and @code{vax} that identify the
991 type of system you are using.  It also enables the undesirable and
992 rarely used ISO trigraph feature.  For the C compiler,
993 it disables recognition of C++ style @samp{//} comments as well as
994 the @code{inline} keyword.
995
996 The alternate keywords @code{__asm__}, @code{__extension__},
997 @code{__inline__} and @code{__typeof__} continue to work despite
998 @option{-ansi}.  You would not want to use them in an ISO C program, of
999 course, but it is useful to put them in header files that might be included
1000 in compilations done with @option{-ansi}.  Alternate predefined macros
1001 such as @code{__unix__} and @code{__vax__} are also available, with or
1002 without @option{-ansi}.
1003
1004 The @option{-ansi} option does not cause non-ISO programs to be
1005 rejected gratuitously.  For that, @option{-pedantic} is required in
1006 addition to @option{-ansi}.  @xref{Warning Options}.
1007
1008 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1009 option is used.  Some header files may notice this macro and refrain
1010 from declaring certain functions or defining certain macros that the
1011 ISO standard doesn't call for; this is to avoid interfering with any
1012 programs that might use these names for other things.
1013
1014 Functions which would normally be built in but do not have semantics
1015 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1016 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1017 built-in functions provided by GCC}, for details of the functions
1018 affected.
1019
1020 @item -std=
1021 @opindex std
1022 Determine the language standard.  This option is currently only
1023 supported when compiling C or C++.  A value for this option must be
1024 provided; possible values are
1025
1026 @table @samp
1027 @item c89
1028 @itemx iso9899:1990
1029 ISO C90 (same as @option{-ansi}).
1030
1031 @item iso9899:199409
1032 ISO C90 as modified in amendment 1.
1033
1034 @item c99
1035 @itemx c9x
1036 @itemx iso9899:1999
1037 @itemx iso9899:199x
1038 ISO C99.  Note that this standard is not yet fully supported; see
1039 @w{@uref{http://gcc.gnu.org/gcc-3.4/c99status.html}} for more information.  The
1040 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1041
1042 @item gnu89
1043 Default, ISO C90 plus GNU extensions (including some C99 features).
1044
1045 @item gnu99
1046 @itemx gnu9x
1047 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1048 this will become the default.  The name @samp{gnu9x} is deprecated.
1049
1050 @item c++98
1051 The 1998 ISO C++ standard plus amendments.
1052
1053 @item gnu++98
1054 The same as @option{-std=c++98} plus GNU extensions.  This is the
1055 default for C++ code.
1056 @end table
1057
1058 Even when this option is not specified, you can still use some of the
1059 features of newer standards in so far as they do not conflict with
1060 previous C standards.  For example, you may use @code{__restrict__} even
1061 when @option{-std=c99} is not specified.
1062
1063 The @option{-std} options specifying some version of ISO C have the same
1064 effects as @option{-ansi}, except that features that were not in ISO C90
1065 but are in the specified version (for example, @samp{//} comments and
1066 the @code{inline} keyword in ISO C99) are not disabled.
1067
1068 @xref{Standards,,Language Standards Supported by GCC}, for details of
1069 these standard versions.
1070
1071 @item -aux-info @var{filename}
1072 @opindex aux-info
1073 Output to the given filename prototyped declarations for all functions
1074 declared and/or defined in a translation unit, including those in header
1075 files.  This option is silently ignored in any language other than C@.
1076
1077 Besides declarations, the file indicates, in comments, the origin of
1078 each declaration (source file and line), whether the declaration was
1079 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1080 @samp{O} for old, respectively, in the first character after the line
1081 number and the colon), and whether it came from a declaration or a
1082 definition (@samp{C} or @samp{F}, respectively, in the following
1083 character).  In the case of function definitions, a K&R-style list of
1084 arguments followed by their declarations is also provided, inside
1085 comments, after the declaration.
1086
1087 @item -fno-asm
1088 @opindex fno-asm
1089 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1090 keyword, so that code can use these words as identifiers.  You can use
1091 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1092 instead.  @option{-ansi} implies @option{-fno-asm}.
1093
1094 In C++, this switch only affects the @code{typeof} keyword, since
1095 @code{asm} and @code{inline} are standard keywords.  You may want to
1096 use the @option{-fno-gnu-keywords} flag instead, which has the same
1097 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1098 switch only affects the @code{asm} and @code{typeof} keywords, since
1099 @code{inline} is a standard keyword in ISO C99.
1100
1101 @item -fno-builtin
1102 @itemx -fno-builtin-@var{function}
1103 @opindex fno-builtin
1104 @cindex built-in functions
1105 Don't recognize built-in functions that do not begin with
1106 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1107 functions provided by GCC}, for details of the functions affected,
1108 including those which are not built-in functions when @option{-ansi} or
1109 @option{-std} options for strict ISO C conformance are used because they
1110 do not have an ISO standard meaning.
1111
1112 GCC normally generates special code to handle certain built-in functions
1113 more efficiently; for instance, calls to @code{alloca} may become single
1114 instructions that adjust the stack directly, and calls to @code{memcpy}
1115 may become inline copy loops.  The resulting code is often both smaller
1116 and faster, but since the function calls no longer appear as such, you
1117 cannot set a breakpoint on those calls, nor can you change the behavior
1118 of the functions by linking with a different library.
1119
1120 With the @option{-fno-builtin-@var{function}} option
1121 only the built-in function @var{function} is
1122 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1123 function is named this is not built-in in this version of GCC, this
1124 option is ignored.  There is no corresponding
1125 @option{-fbuiltin-@var{function}} option; if you wish to enable
1126 built-in functions selectively when using @option{-fno-builtin} or
1127 @option{-ffreestanding}, you may define macros such as:
1128
1129 @smallexample
1130 #define abs(n)          __builtin_abs ((n))
1131 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1132 @end smallexample
1133
1134 @item -fhosted
1135 @opindex fhosted
1136 @cindex hosted environment
1137
1138 Assert that compilation takes place in a hosted environment.  This implies
1139 @option{-fbuiltin}.  A hosted environment is one in which the
1140 entire standard library is available, and in which @code{main} has a return
1141 type of @code{int}.  Examples are nearly everything except a kernel.
1142 This is equivalent to @option{-fno-freestanding}.
1143
1144 @item -ffreestanding
1145 @opindex ffreestanding
1146 @cindex hosted environment
1147
1148 Assert that compilation takes place in a freestanding environment.  This
1149 implies @option{-fno-builtin}.  A freestanding environment
1150 is one in which the standard library may not exist, and program startup may
1151 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1152 This is equivalent to @option{-fno-hosted}.
1153
1154 @xref{Standards,,Language Standards Supported by GCC}, for details of
1155 freestanding and hosted environments.
1156
1157 @item -fms-extensions
1158 @opindex fms-extensions
1159 Accept some non-standard constructs used in Microsoft header files.
1160
1161 @item -trigraphs
1162 @opindex trigraphs
1163 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1164 options for strict ISO C conformance) implies @option{-trigraphs}.
1165
1166 @item -no-integrated-cpp
1167 @opindex no-integrated-cpp
1168 Performs a compilation in two passes: preprocessing and compiling.  This
1169 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1170 @option{-B} option. The user supplied compilation step can then add in
1171 an additional preprocessing step after normal preprocessing but before
1172 compiling. The default is to use the integrated cpp (internal cpp)
1173
1174 The semantics of this option will change if "cc1", "cc1plus", and
1175 "cc1obj" are merged.
1176
1177 @cindex traditional C language
1178 @cindex C language, traditional
1179 @item -traditional
1180 @itemx -traditional-cpp
1181 @opindex traditional-cpp
1182 @opindex traditional
1183 Formerly, these options caused GCC to attempt to emulate a pre-standard
1184 C compiler.  They are now only supported with the @option{-E} switch.
1185 The preprocessor continues to support a pre-standard mode.  See the GNU
1186 CPP manual for details.
1187
1188 @item -fcond-mismatch
1189 @opindex fcond-mismatch
1190 Allow conditional expressions with mismatched types in the second and
1191 third arguments.  The value of such an expression is void.  This option
1192 is not supported for C++.
1193
1194 @item -funsigned-char
1195 @opindex funsigned-char
1196 Let the type @code{char} be unsigned, like @code{unsigned char}.
1197
1198 Each kind of machine has a default for what @code{char} should
1199 be.  It is either like @code{unsigned char} by default or like
1200 @code{signed char} by default.
1201
1202 Ideally, a portable program should always use @code{signed char} or
1203 @code{unsigned char} when it depends on the signedness of an object.
1204 But many programs have been written to use plain @code{char} and
1205 expect it to be signed, or expect it to be unsigned, depending on the
1206 machines they were written for.  This option, and its inverse, let you
1207 make such a program work with the opposite default.
1208
1209 The type @code{char} is always a distinct type from each of
1210 @code{signed char} or @code{unsigned char}, even though its behavior
1211 is always just like one of those two.
1212
1213 @item -fsigned-char
1214 @opindex fsigned-char
1215 Let the type @code{char} be signed, like @code{signed char}.
1216
1217 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1218 the negative form of @option{-funsigned-char}.  Likewise, the option
1219 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1220
1221 @item -fsigned-bitfields
1222 @itemx -funsigned-bitfields
1223 @itemx -fno-signed-bitfields
1224 @itemx -fno-unsigned-bitfields
1225 @opindex fsigned-bitfields
1226 @opindex funsigned-bitfields
1227 @opindex fno-signed-bitfields
1228 @opindex fno-unsigned-bitfields
1229 These options control whether a bit-field is signed or unsigned, when the
1230 declaration does not use either @code{signed} or @code{unsigned}.  By
1231 default, such a bit-field is signed, because this is consistent: the
1232 basic integer types such as @code{int} are signed types.
1233
1234 @item -fwritable-strings
1235 @opindex fwritable-strings
1236 Store string constants in the writable data segment and don't uniquize
1237 them.  This is for compatibility with old programs which assume they can
1238 write into string constants.
1239
1240 Writing into string constants is a very bad idea; ``constants'' should
1241 be constant.
1242
1243 This option is deprecated.
1244 @end table
1245
1246 @node C++ Dialect Options
1247 @section Options Controlling C++ Dialect
1248
1249 @cindex compiler options, C++
1250 @cindex C++ options, command line
1251 @cindex options, C++
1252 This section describes the command-line options that are only meaningful
1253 for C++ programs; but you can also use most of the GNU compiler options
1254 regardless of what language your program is in.  For example, you
1255 might compile a file @code{firstClass.C} like this:
1256
1257 @smallexample
1258 g++ -g -frepo -O -c firstClass.C
1259 @end smallexample
1260
1261 @noindent
1262 In this example, only @option{-frepo} is an option meant
1263 only for C++ programs; you can use the other options with any
1264 language supported by GCC@.
1265
1266 Here is a list of options that are @emph{only} for compiling C++ programs:
1267
1268 @table @gcctabopt
1269
1270 @item -fabi-version=@var{n}
1271 @opindex fabi-version
1272 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1273 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1274 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1275 the version that conforms most closely to the C++ ABI specification.
1276 Therefore, the ABI obtained using version 0 will change as ABI bugs
1277 are fixed.
1278
1279 The default is version 2.
1280
1281 @item -fno-access-control
1282 @opindex fno-access-control
1283 Turn off all access checking.  This switch is mainly useful for working
1284 around bugs in the access control code.
1285
1286 @item -fcheck-new
1287 @opindex fcheck-new
1288 Check that the pointer returned by @code{operator new} is non-null
1289 before attempting to modify the storage allocated.  This check is
1290 normally unnecessary because the C++ standard specifies that
1291 @code{operator new} will only return @code{0} if it is declared
1292 @samp{throw()}, in which case the compiler will always check the
1293 return value even without this option.  In all other cases, when
1294 @code{operator new} has a non-empty exception specification, memory
1295 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1296 @samp{new (nothrow)}.
1297
1298 @item -fconserve-space
1299 @opindex fconserve-space
1300 Put uninitialized or runtime-initialized global variables into the
1301 common segment, as C does.  This saves space in the executable at the
1302 cost of not diagnosing duplicate definitions.  If you compile with this
1303 flag and your program mysteriously crashes after @code{main()} has
1304 completed, you may have an object that is being destroyed twice because
1305 two definitions were merged.
1306
1307 This option is no longer useful on most targets, now that support has
1308 been added for putting variables into BSS without making them common.
1309
1310 @item -fno-const-strings
1311 @opindex fno-const-strings
1312 Give string constants type @code{char *} instead of type @code{const
1313 char *}.  By default, G++ uses type @code{const char *} as required by
1314 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1315 actually modify the value of a string constant, unless you also use
1316 @option{-fwritable-strings}.
1317
1318 This option might be removed in a future release of G++.  For maximum
1319 portability, you should structure your code so that it works with
1320 string constants that have type @code{const char *}.
1321
1322 @item -fno-elide-constructors
1323 @opindex fno-elide-constructors
1324 The C++ standard allows an implementation to omit creating a temporary
1325 which is only used to initialize another object of the same type.
1326 Specifying this option disables that optimization, and forces G++ to
1327 call the copy constructor in all cases.
1328
1329 @item -fno-enforce-eh-specs
1330 @opindex fno-enforce-eh-specs
1331 Don't check for violation of exception specifications at runtime.  This
1332 option violates the C++ standard, but may be useful for reducing code
1333 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1334 will still optimize based on the exception specifications.
1335
1336 @item -ffor-scope
1337 @itemx -fno-for-scope
1338 @opindex ffor-scope
1339 @opindex fno-for-scope
1340 If @option{-ffor-scope} is specified, the scope of variables declared in
1341 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1342 as specified by the C++ standard.
1343 If @option{-fno-for-scope} is specified, the scope of variables declared in
1344 a @i{for-init-statement} extends to the end of the enclosing scope,
1345 as was the case in old versions of G++, and other (traditional)
1346 implementations of C++.
1347
1348 The default if neither flag is given to follow the standard,
1349 but to allow and give a warning for old-style code that would
1350 otherwise be invalid, or have different behavior.
1351
1352 @item -fno-gnu-keywords
1353 @opindex fno-gnu-keywords
1354 Do not recognize @code{typeof} as a keyword, so that code can use this
1355 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1356 @option{-ansi} implies @option{-fno-gnu-keywords}.
1357
1358 @item -fno-implicit-templates
1359 @opindex fno-implicit-templates
1360 Never emit code for non-inline templates which are instantiated
1361 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1362 @xref{Template Instantiation}, for more information.
1363
1364 @item -fno-implicit-inline-templates
1365 @opindex fno-implicit-inline-templates
1366 Don't emit code for implicit instantiations of inline templates, either.
1367 The default is to handle inlines differently so that compiles with and
1368 without optimization will need the same set of explicit instantiations.
1369
1370 @item -fno-implement-inlines
1371 @opindex fno-implement-inlines
1372 To save space, do not emit out-of-line copies of inline functions
1373 controlled by @samp{#pragma implementation}.  This will cause linker
1374 errors if these functions are not inlined everywhere they are called.
1375
1376 @item -fms-extensions
1377 @opindex fms-extensions
1378 Disable pedantic warnings about constructs used in MFC, such as implicit
1379 int and getting a pointer to member function via non-standard syntax.
1380
1381 @item -fno-nonansi-builtins
1382 @opindex fno-nonansi-builtins
1383 Disable built-in declarations of functions that are not mandated by
1384 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1385 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1386
1387 @item -fno-operator-names
1388 @opindex fno-operator-names
1389 Do not treat the operator name keywords @code{and}, @code{bitand},
1390 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1391 synonyms as keywords.
1392
1393 @item -fno-optional-diags
1394 @opindex fno-optional-diags
1395 Disable diagnostics that the standard says a compiler does not need to
1396 issue.  Currently, the only such diagnostic issued by G++ is the one for
1397 a name having multiple meanings within a class.
1398
1399 @item -fpermissive
1400 @opindex fpermissive
1401 Downgrade some diagnostics about nonconformant code from errors to
1402 warnings.  Thus, using @option{-fpermissive} will allow some
1403 nonconforming code to compile.
1404
1405 @item -frepo
1406 @opindex frepo
1407 Enable automatic template instantiation at link time.  This option also
1408 implies @option{-fno-implicit-templates}.  @xref{Template
1409 Instantiation}, for more information.
1410
1411 @item -fno-rtti
1412 @opindex fno-rtti
1413 Disable generation of information about every class with virtual
1414 functions for use by the C++ runtime type identification features
1415 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1416 of the language, you can save some space by using this flag.  Note that
1417 exception handling uses the same information, but it will generate it as
1418 needed.
1419
1420 @item -fstats
1421 @opindex fstats
1422 Emit statistics about front-end processing at the end of the compilation.
1423 This information is generally only useful to the G++ development team.
1424
1425 @item -ftemplate-depth-@var{n}
1426 @opindex ftemplate-depth
1427 Set the maximum instantiation depth for template classes to @var{n}.
1428 A limit on the template instantiation depth is needed to detect
1429 endless recursions during template class instantiation.  ANSI/ISO C++
1430 conforming programs must not rely on a maximum depth greater than 17.
1431
1432 @item -fuse-cxa-atexit
1433 @opindex fuse-cxa-atexit
1434 Register destructors for objects with static storage duration with the
1435 @code{__cxa_atexit} function rather than the @code{atexit} function.
1436 This option is required for fully standards-compliant handling of static
1437 destructors, but will only work if your C library supports
1438 @code{__cxa_atexit}.
1439
1440 @item -fno-weak
1441 @opindex fno-weak
1442 Do not use weak symbol support, even if it is provided by the linker.
1443 By default, G++ will use weak symbols if they are available.  This
1444 option exists only for testing, and should not be used by end-users;
1445 it will result in inferior code and has no benefits.  This option may
1446 be removed in a future release of G++.
1447
1448 @item -nostdinc++
1449 @opindex nostdinc++
1450 Do not search for header files in the standard directories specific to
1451 C++, but do still search the other standard directories.  (This option
1452 is used when building the C++ library.)
1453 @end table
1454
1455 In addition, these optimization, warning, and code generation options
1456 have meanings only for C++ programs:
1457
1458 @table @gcctabopt
1459 @item -fno-default-inline
1460 @opindex fno-default-inline
1461 Do not assume @samp{inline} for functions defined inside a class scope.
1462 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1463 functions will have linkage like inline functions; they just won't be
1464 inlined by default.
1465
1466 @item -Wabi @r{(C++ only)}
1467 @opindex Wabi
1468 Warn when G++ generates code that is probably not compatible with the
1469 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1470 all such cases, there are probably some cases that are not warned about,
1471 even though G++ is generating incompatible code.  There may also be
1472 cases where warnings are emitted even though the code that is generated
1473 will be compatible.
1474
1475 You should rewrite your code to avoid these warnings if you are
1476 concerned about the fact that code generated by G++ may not be binary
1477 compatible with code generated by other compilers.
1478
1479 The known incompatibilities at this point include:
1480
1481 @itemize @bullet
1482
1483 @item
1484 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1485 pack data into the same byte as a base class.  For example:
1486
1487 @smallexample
1488 struct A @{ virtual void f(); int f1 : 1; @};
1489 struct B : public A @{ int f2 : 1; @};
1490 @end smallexample
1491
1492 @noindent
1493 In this case, G++ will place @code{B::f2} into the same byte
1494 as@code{A::f1}; other compilers will not.  You can avoid this problem
1495 by explicitly padding @code{A} so that its size is a multiple of the
1496 byte size on your platform; that will cause G++ and other compilers to
1497 layout @code{B} identically.
1498
1499 @item
1500 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1501 tail padding when laying out virtual bases.  For example:
1502
1503 @smallexample
1504 struct A @{ virtual void f(); char c1; @};
1505 struct B @{ B(); char c2; @};
1506 struct C : public A, public virtual B @{@};
1507 @end smallexample
1508
1509 @noindent
1510 In this case, G++ will not place @code{B} into the tail-padding for
1511 @code{A}; other compilers will.  You can avoid this problem by
1512 explicitly padding @code{A} so that its size is a multiple of its
1513 alignment (ignoring virtual base classes); that will cause G++ and other
1514 compilers to layout @code{C} identically.
1515
1516 @item
1517 Incorrect handling of bit-fields with declared widths greater than that
1518 of their underlying types, when the bit-fields appear in a union.  For
1519 example:
1520
1521 @smallexample
1522 union U @{ int i : 4096; @};
1523 @end smallexample
1524
1525 @noindent
1526 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1527 union too small by the number of bits in an @code{int}.
1528
1529 @item
1530 Empty classes can be placed at incorrect offsets.  For example:
1531
1532 @smallexample
1533 struct A @{@};
1534
1535 struct B @{
1536   A a;
1537   virtual void f ();
1538 @};
1539
1540 struct C : public B, public A @{@};
1541 @end smallexample
1542
1543 @noindent
1544 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1545 it should be placed at offset zero.  G++ mistakenly believes that the
1546 @code{A} data member of @code{B} is already at offset zero.
1547
1548 @item
1549 Names of template functions whose types involve @code{typename} or
1550 template template parameters can be mangled incorrectly.
1551
1552 @smallexample
1553 template <typename Q>
1554 void f(typename Q::X) @{@}
1555
1556 template <template <typename> class Q>
1557 void f(typename Q<int>::X) @{@}
1558 @end smallexample
1559
1560 @noindent
1561 Instantiations of these templates may be mangled incorrectly.
1562
1563 @end itemize
1564
1565 @item -Wctor-dtor-privacy @r{(C++ only)}
1566 @opindex Wctor-dtor-privacy
1567 Warn when a class seems unusable because all the constructors or
1568 destructors in that class are private, and it has neither friends nor
1569 public static member functions.
1570
1571 @item -Wnon-virtual-dtor @r{(C++ only)}
1572 @opindex Wnon-virtual-dtor
1573 Warn when a class appears to be polymorphic, thereby requiring a virtual
1574 destructor, yet it declares a non-virtual one.
1575 This warning is enabled by @option{-Wall}.
1576
1577 @item -Wreorder @r{(C++ only)}
1578 @opindex Wreorder
1579 @cindex reordering, warning
1580 @cindex warning for reordering of member initializers
1581 Warn when the order of member initializers given in the code does not
1582 match the order in which they must be executed.  For instance:
1583
1584 @smallexample
1585 struct A @{
1586   int i;
1587   int j;
1588   A(): j (0), i (1) @{ @}
1589 @};
1590 @end smallexample
1591
1592 The compiler will rearrange the member initializers for @samp{i}
1593 and @samp{j} to match the declaration order of the members, emitting
1594 a warning to that effect.  This warning is enabled by @option{-Wall}.
1595 @end table
1596
1597 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1598
1599 @table @gcctabopt
1600 @item -Weffc++ @r{(C++ only)}
1601 @opindex Weffc++
1602 Warn about violations of the following style guidelines from Scott Meyers'
1603 @cite{Effective C++} book:
1604
1605 @itemize @bullet
1606 @item
1607 Item 11:  Define a copy constructor and an assignment operator for classes
1608 with dynamically allocated memory.
1609
1610 @item
1611 Item 12:  Prefer initialization to assignment in constructors.
1612
1613 @item
1614 Item 14:  Make destructors virtual in base classes.
1615
1616 @item
1617 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1618
1619 @item
1620 Item 23:  Don't try to return a reference when you must return an object.
1621
1622 @end itemize
1623
1624 Also warn about violations of the following style guidelines from
1625 Scott Meyers' @cite{More Effective C++} book:
1626
1627 @itemize @bullet
1628 @item
1629 Item 6:  Distinguish between prefix and postfix forms of increment and
1630 decrement operators.
1631
1632 @item
1633 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1634
1635 @end itemize
1636
1637 When selecting this option, be aware that the standard library
1638 headers do not obey all of these guidelines; use @samp{grep -v}
1639 to filter out those warnings.
1640
1641 @item -Wno-deprecated @r{(C++ only)}
1642 @opindex Wno-deprecated
1643 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1644
1645 @item -Wno-non-template-friend @r{(C++ only)}
1646 @opindex Wno-non-template-friend
1647 Disable warnings when non-templatized friend functions are declared
1648 within a template.  Since the advent of explicit template specification
1649 support in G++, if the name of the friend is an unqualified-id (i.e.,
1650 @samp{friend foo(int)}), the C++ language specification demands that the
1651 friend declare or define an ordinary, nontemplate function.  (Section
1652 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1653 could be interpreted as a particular specialization of a templatized
1654 function.  Because this non-conforming behavior is no longer the default
1655 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1656 check existing code for potential trouble spots and is on by default.
1657 This new compiler behavior can be turned off with
1658 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1659 but disables the helpful warning.
1660
1661 @item -Wold-style-cast @r{(C++ only)}
1662 @opindex Wold-style-cast
1663 Warn if an old-style (C-style) cast to a non-void type is used within
1664 a C++ program.  The new-style casts (@samp{static_cast},
1665 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1666 unintended effects and much easier to search for.
1667
1668 @item -Woverloaded-virtual @r{(C++ only)}
1669 @opindex Woverloaded-virtual
1670 @cindex overloaded virtual fn, warning
1671 @cindex warning for overloaded virtual fn
1672 Warn when a function declaration hides virtual functions from a
1673 base class.  For example, in:
1674
1675 @smallexample
1676 struct A @{
1677   virtual void f();
1678 @};
1679
1680 struct B: public A @{
1681   void f(int);
1682 @};
1683 @end smallexample
1684
1685 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1686 like:
1687
1688 @smallexample
1689 B* b;
1690 b->f();
1691 @end smallexample
1692
1693 will fail to compile.
1694
1695 @item -Wno-pmf-conversions @r{(C++ only)}
1696 @opindex Wno-pmf-conversions
1697 Disable the diagnostic for converting a bound pointer to member function
1698 to a plain pointer.
1699
1700 @item -Wsign-promo @r{(C++ only)}
1701 @opindex Wsign-promo
1702 Warn when overload resolution chooses a promotion from unsigned or
1703 enumerated type to a signed type, over a conversion to an unsigned type of
1704 the same size.  Previous versions of G++ would try to preserve
1705 unsignedness, but the standard mandates the current behavior.
1706
1707 @smallexample
1708 struct A @{
1709   operator int ();
1710   A& operator = (int);
1711 @};
1712
1713 main ()
1714 @{
1715   A a,b;
1716   a = b;
1717 @}
1718 @end smallexample
1719
1720 In this example, G++ will synthesize a default @samp{A& operator =
1721 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1722 @end table
1723
1724 @node Objective-C Dialect Options
1725 @section Options Controlling Objective-C Dialect
1726
1727 @cindex compiler options, Objective-C
1728 @cindex Objective-C options, command line
1729 @cindex options, Objective-C
1730 (NOTE: This manual does not describe the Objective-C language itself.  See
1731 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1732
1733 This section describes the command-line options that are only meaningful
1734 for Objective-C programs, but you can also use most of the GNU compiler
1735 options regardless of what language your program is in.  For example,
1736 you might compile a file @code{some_class.m} like this:
1737
1738 @smallexample
1739 gcc -g -fgnu-runtime -O -c some_class.m
1740 @end smallexample
1741
1742 @noindent
1743 In this example, @option{-fgnu-runtime} is an option meant only for
1744 Objective-C programs; you can use the other options with any language
1745 supported by GCC@.
1746
1747 Here is a list of options that are @emph{only} for compiling Objective-C
1748 programs:
1749
1750 @table @gcctabopt
1751 @item -fconstant-string-class=@var{class-name}
1752 @opindex fconstant-string-class
1753 Use @var{class-name} as the name of the class to instantiate for each
1754 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1755 class name is @code{NXConstantString} if the GNU runtime is being used, and
1756 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1757 @option{-fconstant-cfstrings} option, if also present, will override the
1758 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1759 to be laid out as constant CoreFoundation strings.
1760
1761 @item -fgnu-runtime
1762 @opindex fgnu-runtime
1763 Generate object code compatible with the standard GNU Objective-C
1764 runtime.  This is the default for most types of systems.
1765
1766 @item -fnext-runtime
1767 @opindex fnext-runtime
1768 Generate output compatible with the NeXT runtime.  This is the default
1769 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1770 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1771 used.
1772
1773 @item -fno-nil-receivers
1774 @opindex fno-nil-receivers
1775 Assume that all Objective-C message dispatches (e.g.,
1776 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1777 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1778 used.  Currently, this option is only available in conjunction with
1779 the NeXT runtime on Mac OS X 10.3 and later.
1780
1781 @item -fobjc-exceptions
1782 @opindex fobjc-exceptions
1783 Enable syntactic support for structured exception handling in Objective-C,
1784 similar to what is offered by C++ and Java.  Currently, this option is only
1785 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1786
1787 @smallexample
1788   @@try @{
1789     @dots{}
1790        @@throw expr;
1791     @dots{}
1792   @}
1793   @@catch (AnObjCClass *exc) @{
1794     @dots{}
1795       @@throw expr;
1796     @dots{}
1797       @@throw;
1798     @dots{}
1799   @}
1800   @@catch (AnotherClass *exc) @{
1801     @dots{}
1802   @}
1803   @@catch (id allOthers) @{
1804     @dots{}
1805   @}
1806   @@finally @{
1807     @dots{}
1808       @@throw expr;
1809     @dots{}
1810   @}
1811 @end smallexample
1812
1813 The @code{@@throw} statement may appear anywhere in an Objective-C or
1814 Objective-C++ program; when used inside of a @code{@@catch} block, the
1815 @code{@@throw} may appear without an argument (as shown above), in which case
1816 the object caught by the @code{@@catch} will be rethrown.
1817
1818 Note that only (pointers to) Objective-C objects may be thrown and
1819 caught using this scheme.  When an object is thrown, it will be caught
1820 by the nearest @code{@@catch} clause capable of handling objects of that type,
1821 analogously to how @code{catch} blocks work in C++ and Java.  A
1822 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1823 any and all Objective-C exceptions not caught by previous @code{@@catch}
1824 clauses (if any).
1825
1826 The @code{@@finally} clause, if present, will be executed upon exit from the
1827 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1828 regardless of whether any exceptions are thrown, caught or rethrown
1829 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1830 of the @code{finally} clause in Java.
1831
1832 There are several caveats to using the new exception mechanism:
1833
1834 @itemize @bullet
1835 @item
1836 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1837 idioms provided by the @code{NSException} class, the new
1838 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1839 systems, due to additional functionality needed in the (NeXT) Objective-C
1840 runtime.
1841
1842 @item
1843 As mentioned above, the new exceptions do not support handling
1844 types other than Objective-C objects.   Furthermore, when used from
1845 Objective-C++, the Objective-C exception model does not interoperate with C++
1846 exceptions at this time.  This means you cannot @code{@@throw} an exception
1847 from Objective-C and @code{catch} it in C++, or vice versa
1848 (i.e., @code{throw @dots{} @@catch}).
1849 @end itemize
1850
1851 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1852 blocks for thread-safe execution:
1853
1854 @smallexample
1855   @@synchronized (ObjCClass *guard) @{
1856     @dots{}
1857   @}
1858 @end smallexample
1859
1860 Upon entering the @code{@@synchronized} block, a thread of execution shall
1861 first check whether a lock has been placed on the corresponding @code{guard}
1862 object by another thread.  If it has, the current thread shall wait until
1863 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1864 the current thread will place its own lock on it, execute the code contained in
1865 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1866 making @code{guard} available to other threads).
1867
1868 Unlike Java, Objective-C does not allow for entire methods to be marked
1869 @code{@@synchronized}.  Note that throwing exceptions out of
1870 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1871 to be unlocked properly.
1872
1873 @item -freplace-objc-classes
1874 @opindex freplace-objc-classes
1875 Emit a special marker instructing @command{ld(1)} not to statically link in
1876 the resulting object file, and allow @command{dyld(1)} to load it in at
1877 run time instead.  This is used in conjunction with the Fix-and-Continue
1878 debugging mode, where the object file in question may be recompiled and
1879 dynamically reloaded in the course of program execution, without the need
1880 to restart the program itself.  Currently, Fix-and-Continue functionality
1881 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1882 and later.
1883
1884 @item -fzero-link
1885 @opindex fzero-link
1886 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1887 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1888 compile time) with static class references that get initialized at load time,
1889 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1890 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1891 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1892 for individual class implementations to be modified during program execution.
1893
1894 @item -gen-decls
1895 @opindex gen-decls
1896 Dump interface declarations for all classes seen in the source file to a
1897 file named @file{@var{sourcename}.decl}.
1898
1899 @item -Wno-protocol
1900 @opindex Wno-protocol
1901 If a class is declared to implement a protocol, a warning is issued for
1902 every method in the protocol that is not implemented by the class.  The
1903 default behavior is to issue a warning for every method not explicitly
1904 implemented in the class, even if a method implementation is inherited
1905 from the superclass.  If you use the @code{-Wno-protocol} option, then
1906 methods inherited from the superclass are considered to be implemented,
1907 and no warning is issued for them.
1908
1909 @item -Wselector
1910 @opindex Wselector
1911 Warn if multiple methods of different types for the same selector are
1912 found during compilation.  The check is performed on the list of methods
1913 in the final stage of compilation.  Additionally, a check is performed
1914 for each selector appearing in a @code{@@selector(@dots{})}
1915 expression, and a corresponding method for that selector has been found
1916 during compilation.  Because these checks scan the method table only at
1917 the end of compilation, these warnings are not produced if the final
1918 stage of compilation is not reached, for example because an error is
1919 found during compilation, or because the @code{-fsyntax-only} option is
1920 being used.
1921
1922 @item -Wundeclared-selector
1923 @opindex Wundeclared-selector
1924 Warn if a @code{@@selector(@dots{})} expression referring to an
1925 undeclared selector is found.  A selector is considered undeclared if no
1926 method with that name has been declared before the
1927 @code{@@selector(@dots{})} expression, either explicitly in an
1928 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1929 an @code{@@implementation} section.  This option always performs its
1930 checks as soon as a @code{@@selector(@dots{})} expression is found,
1931 while @code{-Wselector} only performs its checks in the final stage of
1932 compilation.  This also enforces the coding style convention
1933 that methods and selectors must be declared before being used.
1934
1935 @item -print-objc-runtime-info
1936 @opindex print-objc-runtime-info
1937 Generate C header describing the largest structure that is passed by
1938 value, if any.
1939
1940 @end table
1941
1942 @node Language Independent Options
1943 @section Options to Control Diagnostic Messages Formatting
1944 @cindex options to control diagnostics formatting
1945 @cindex diagnostic messages
1946 @cindex message formatting
1947
1948 Traditionally, diagnostic messages have been formatted irrespective of
1949 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1950 below can be used to control the diagnostic messages formatting
1951 algorithm, e.g.@: how many characters per line, how often source location
1952 information should be reported.  Right now, only the C++ front end can
1953 honor these options.  However it is expected, in the near future, that
1954 the remaining front ends would be able to digest them correctly.
1955
1956 @table @gcctabopt
1957 @item -fmessage-length=@var{n}
1958 @opindex fmessage-length
1959 Try to format error messages so that they fit on lines of about @var{n}
1960 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1961 the front ends supported by GCC@.  If @var{n} is zero, then no
1962 line-wrapping will be done; each error message will appear on a single
1963 line.
1964
1965 @opindex fdiagnostics-show-location
1966 @item -fdiagnostics-show-location=once
1967 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1968 reporter to emit @emph{once} source location information; that is, in
1969 case the message is too long to fit on a single physical line and has to
1970 be wrapped, the source location won't be emitted (as prefix) again,
1971 over and over, in subsequent continuation lines.  This is the default
1972 behavior.
1973
1974 @item -fdiagnostics-show-location=every-line
1975 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1976 messages reporter to emit the same source location information (as
1977 prefix) for physical lines that result from the process of breaking
1978 a message which is too long to fit on a single line.
1979
1980 @end table
1981
1982 @node Warning Options
1983 @section Options to Request or Suppress Warnings
1984 @cindex options to control warnings
1985 @cindex warning messages
1986 @cindex messages, warning
1987 @cindex suppressing warnings
1988
1989 Warnings are diagnostic messages that report constructions which
1990 are not inherently erroneous but which are risky or suggest there
1991 may have been an error.
1992
1993 You can request many specific warnings with options beginning @samp{-W},
1994 for example @option{-Wimplicit} to request warnings on implicit
1995 declarations.  Each of these specific warning options also has a
1996 negative form beginning @samp{-Wno-} to turn off warnings;
1997 for example, @option{-Wno-implicit}.  This manual lists only one of the
1998 two forms, whichever is not the default.
1999
2000 The following options control the amount and kinds of warnings produced
2001 by GCC; for further, language-specific options also refer to
2002 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2003
2004 @table @gcctabopt
2005 @cindex syntax checking
2006 @item -fsyntax-only
2007 @opindex fsyntax-only
2008 Check the code for syntax errors, but don't do anything beyond that.
2009
2010 @item -pedantic
2011 @opindex pedantic
2012 Issue all the warnings demanded by strict ISO C and ISO C++;
2013 reject all programs that use forbidden extensions, and some other
2014 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2015 version of the ISO C standard specified by any @option{-std} option used.
2016
2017 Valid ISO C and ISO C++ programs should compile properly with or without
2018 this option (though a rare few will require @option{-ansi} or a
2019 @option{-std} option specifying the required version of ISO C)@.  However,
2020 without this option, certain GNU extensions and traditional C and C++
2021 features are supported as well.  With this option, they are rejected.
2022
2023 @option{-pedantic} does not cause warning messages for use of the
2024 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2025 warnings are also disabled in the expression that follows
2026 @code{__extension__}.  However, only system header files should use
2027 these escape routes; application programs should avoid them.
2028 @xref{Alternate Keywords}.
2029
2030 Some users try to use @option{-pedantic} to check programs for strict ISO
2031 C conformance.  They soon find that it does not do quite what they want:
2032 it finds some non-ISO practices, but not all---only those for which
2033 ISO C @emph{requires} a diagnostic, and some others for which
2034 diagnostics have been added.
2035
2036 A feature to report any failure to conform to ISO C might be useful in
2037 some instances, but would require considerable additional work and would
2038 be quite different from @option{-pedantic}.  We don't have plans to
2039 support such a feature in the near future.
2040
2041 Where the standard specified with @option{-std} represents a GNU
2042 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2043 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2044 extended dialect is based.  Warnings from @option{-pedantic} are given
2045 where they are required by the base standard.  (It would not make sense
2046 for such warnings to be given only for features not in the specified GNU
2047 C dialect, since by definition the GNU dialects of C include all
2048 features the compiler supports with the given option, and there would be
2049 nothing to warn about.)
2050
2051 @item -pedantic-errors
2052 @opindex pedantic-errors
2053 Like @option{-pedantic}, except that errors are produced rather than
2054 warnings.
2055
2056 @item -w
2057 @opindex w
2058 Inhibit all warning messages.
2059
2060 @item -Wno-import
2061 @opindex Wno-import
2062 Inhibit warning messages about the use of @samp{#import}.
2063
2064 @item -Wchar-subscripts
2065 @opindex Wchar-subscripts
2066 Warn if an array subscript has type @code{char}.  This is a common cause
2067 of error, as programmers often forget that this type is signed on some
2068 machines.
2069
2070 @item -Wcomment
2071 @opindex Wcomment
2072 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2073 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2074
2075 @item -Wformat
2076 @opindex Wformat
2077 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2078 the arguments supplied have types appropriate to the format string
2079 specified, and that the conversions specified in the format string make
2080 sense.  This includes standard functions, and others specified by format
2081 attributes (@pxref{Function Attributes}), in the @code{printf},
2082 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2083 not in the C standard) families.
2084
2085 The formats are checked against the format features supported by GNU
2086 libc version 2.2.  These include all ISO C90 and C99 features, as well
2087 as features from the Single Unix Specification and some BSD and GNU
2088 extensions.  Other library implementations may not support all these
2089 features; GCC does not support warning about features that go beyond a
2090 particular library's limitations.  However, if @option{-pedantic} is used
2091 with @option{-Wformat}, warnings will be given about format features not
2092 in the selected standard version (but not for @code{strfmon} formats,
2093 since those are not in any version of the C standard).  @xref{C Dialect
2094 Options,,Options Controlling C Dialect}.
2095
2096 Since @option{-Wformat} also checks for null format arguments for
2097 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2098
2099 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2100 aspects of format checking, the options @option{-Wformat-y2k},
2101 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2102 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2103 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2104
2105 @item -Wformat-y2k
2106 @opindex Wformat-y2k
2107 If @option{-Wformat} is specified, also warn about @code{strftime}
2108 formats which may yield only a two-digit year.
2109
2110 @item -Wno-format-extra-args
2111 @opindex Wno-format-extra-args
2112 If @option{-Wformat} is specified, do not warn about excess arguments to a
2113 @code{printf} or @code{scanf} format function.  The C standard specifies
2114 that such arguments are ignored.
2115
2116 Where the unused arguments lie between used arguments that are
2117 specified with @samp{$} operand number specifications, normally
2118 warnings are still given, since the implementation could not know what
2119 type to pass to @code{va_arg} to skip the unused arguments.  However,
2120 in the case of @code{scanf} formats, this option will suppress the
2121 warning if the unused arguments are all pointers, since the Single
2122 Unix Specification says that such unused arguments are allowed.
2123
2124 @item -Wno-format-zero-length
2125 @opindex Wno-format-zero-length
2126 If @option{-Wformat} is specified, do not warn about zero-length formats.
2127 The C standard specifies that zero-length formats are allowed.
2128
2129 @item -Wformat-nonliteral
2130 @opindex Wformat-nonliteral
2131 If @option{-Wformat} is specified, also warn if the format string is not a
2132 string literal and so cannot be checked, unless the format function
2133 takes its format arguments as a @code{va_list}.
2134
2135 @item -Wformat-security
2136 @opindex Wformat-security
2137 If @option{-Wformat} is specified, also warn about uses of format
2138 functions that represent possible security problems.  At present, this
2139 warns about calls to @code{printf} and @code{scanf} functions where the
2140 format string is not a string literal and there are no format arguments,
2141 as in @code{printf (foo);}.  This may be a security hole if the format
2142 string came from untrusted input and contains @samp{%n}.  (This is
2143 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2144 in future warnings may be added to @option{-Wformat-security} that are not
2145 included in @option{-Wformat-nonliteral}.)
2146
2147 @item -Wformat=2
2148 @opindex Wformat=2
2149 Enable @option{-Wformat} plus format checks not included in
2150 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2151 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2152
2153 @item -Wnonnull
2154 @opindex Wnonnull
2155 Warn about passing a null pointer for arguments marked as
2156 requiring a non-null value by the @code{nonnull} function attribute.
2157
2158 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2159 can be disabled with the @option{-Wno-nonnull} option.
2160
2161 @item -Winit-self @r{(C, C++, and Objective-C only)}
2162 @opindex Winit-self
2163 Warn about uninitialized variables which are initialized with themselves.
2164 Note this option can only be used with the @option{-Wuninitialized} option,
2165 which in turn only works with @option{-O1} and above.
2166
2167 For example, GCC will warn about @code{i} being uninitialized in the
2168 following snippet only when @option{-Winit-self} has been specified:
2169 @smallexample
2170 @group
2171 int f()
2172 @{
2173   int i = i;
2174   return i;
2175 @}
2176 @end group
2177 @end smallexample
2178
2179 @item -Wimplicit-int
2180 @opindex Wimplicit-int
2181 Warn when a declaration does not specify a type.
2182
2183 @item -Wimplicit-function-declaration
2184 @itemx -Werror-implicit-function-declaration
2185 @opindex Wimplicit-function-declaration
2186 @opindex Werror-implicit-function-declaration
2187 Give a warning (or error) whenever a function is used before being
2188 declared.
2189
2190 @item -Wimplicit
2191 @opindex Wimplicit
2192 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2193
2194 @item -Wmain
2195 @opindex Wmain
2196 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2197 function with external linkage, returning int, taking either zero
2198 arguments, two, or three arguments of appropriate types.
2199
2200 @item -Wmissing-braces
2201 @opindex Wmissing-braces
2202 Warn if an aggregate or union initializer is not fully bracketed.  In
2203 the following example, the initializer for @samp{a} is not fully
2204 bracketed, but that for @samp{b} is fully bracketed.
2205
2206 @smallexample
2207 int a[2][2] = @{ 0, 1, 2, 3 @};
2208 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2209 @end smallexample
2210
2211 @item -Wparentheses
2212 @opindex Wparentheses
2213 Warn if parentheses are omitted in certain contexts, such
2214 as when there is an assignment in a context where a truth value
2215 is expected, or when operators are nested whose precedence people
2216 often get confused about.
2217
2218 Also warn about constructions where there may be confusion to which
2219 @code{if} statement an @code{else} branch belongs.  Here is an example of
2220 such a case:
2221
2222 @smallexample
2223 @group
2224 @{
2225   if (a)
2226     if (b)
2227       foo ();
2228   else
2229     bar ();
2230 @}
2231 @end group
2232 @end smallexample
2233
2234 In C, every @code{else} branch belongs to the innermost possible @code{if}
2235 statement, which in this example is @code{if (b)}.  This is often not
2236 what the programmer expected, as illustrated in the above example by
2237 indentation the programmer chose.  When there is the potential for this
2238 confusion, GCC will issue a warning when this flag is specified.
2239 To eliminate the warning, add explicit braces around the innermost
2240 @code{if} statement so there is no way the @code{else} could belong to
2241 the enclosing @code{if}.  The resulting code would look like this:
2242
2243 @smallexample
2244 @group
2245 @{
2246   if (a)
2247     @{
2248       if (b)
2249         foo ();
2250       else
2251         bar ();
2252     @}
2253 @}
2254 @end group
2255 @end smallexample
2256
2257 @item -Wsequence-point
2258 @opindex Wsequence-point
2259 Warn about code that may have undefined semantics because of violations
2260 of sequence point rules in the C standard.
2261
2262 The C standard defines the order in which expressions in a C program are
2263 evaluated in terms of @dfn{sequence points}, which represent a partial
2264 ordering between the execution of parts of the program: those executed
2265 before the sequence point, and those executed after it.  These occur
2266 after the evaluation of a full expression (one which is not part of a
2267 larger expression), after the evaluation of the first operand of a
2268 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2269 function is called (but after the evaluation of its arguments and the
2270 expression denoting the called function), and in certain other places.
2271 Other than as expressed by the sequence point rules, the order of
2272 evaluation of subexpressions of an expression is not specified.  All
2273 these rules describe only a partial order rather than a total order,
2274 since, for example, if two functions are called within one expression
2275 with no sequence point between them, the order in which the functions
2276 are called is not specified.  However, the standards committee have
2277 ruled that function calls do not overlap.
2278
2279 It is not specified when between sequence points modifications to the
2280 values of objects take effect.  Programs whose behavior depends on this
2281 have undefined behavior; the C standard specifies that ``Between the
2282 previous and next sequence point an object shall have its stored value
2283 modified at most once by the evaluation of an expression.  Furthermore,
2284 the prior value shall be read only to determine the value to be
2285 stored.''.  If a program breaks these rules, the results on any
2286 particular implementation are entirely unpredictable.
2287
2288 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2289 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2290 diagnosed by this option, and it may give an occasional false positive
2291 result, but in general it has been found fairly effective at detecting
2292 this sort of problem in programs.
2293
2294 The present implementation of this option only works for C programs.  A
2295 future implementation may also work for C++ programs.
2296
2297 The C standard is worded confusingly, therefore there is some debate
2298 over the precise meaning of the sequence point rules in subtle cases.
2299 Links to discussions of the problem, including proposed formal
2300 definitions, may be found on the GCC readings page, at
2301 @w{@uref{http://gcc.gnu.org/readings.html}}.
2302
2303 @item -Wreturn-type
2304 @opindex Wreturn-type
2305 Warn whenever a function is defined with a return-type that defaults to
2306 @code{int}.  Also warn about any @code{return} statement with no
2307 return-value in a function whose return-type is not @code{void}.
2308
2309 For C++, a function without return type always produces a diagnostic
2310 message, even when @option{-Wno-return-type} is specified.  The only
2311 exceptions are @samp{main} and functions defined in system headers.
2312
2313 @item -Wswitch
2314 @opindex Wswitch
2315 Warn whenever a @code{switch} statement has an index of enumerated type
2316 and lacks a @code{case} for one or more of the named codes of that
2317 enumeration.  (The presence of a @code{default} label prevents this
2318 warning.)  @code{case} labels outside the enumeration range also
2319 provoke warnings when this option is used.
2320
2321 @item -Wswitch-default
2322 @opindex Wswitch-switch
2323 Warn whenever a @code{switch} statement does not have a @code{default}
2324 case.
2325
2326 @item -Wswitch-enum
2327 @opindex Wswitch-enum
2328 Warn whenever a @code{switch} statement has an index of enumerated type
2329 and lacks a @code{case} for one or more of the named codes of that
2330 enumeration.  @code{case} labels outside the enumeration range also
2331 provoke warnings when this option is used.
2332
2333 @item -Wtrigraphs
2334 @opindex Wtrigraphs
2335 Warn if any trigraphs are encountered that might change the meaning of
2336 the program (trigraphs within comments are not warned about).
2337
2338 @item -Wunused-function
2339 @opindex Wunused-function
2340 Warn whenever a static function is declared but not defined or a
2341 non\-inline static function is unused.
2342
2343 @item -Wunused-label
2344 @opindex Wunused-label
2345 Warn whenever a label is declared but not used.
2346
2347 To suppress this warning use the @samp{unused} attribute
2348 (@pxref{Variable Attributes}).
2349
2350 @item -Wunused-parameter
2351 @opindex Wunused-parameter
2352 Warn whenever a function parameter is unused aside from its declaration.
2353
2354 To suppress this warning use the @samp{unused} attribute
2355 (@pxref{Variable Attributes}).
2356
2357 @item -Wunused-variable
2358 @opindex Wunused-variable
2359 Warn whenever a local variable or non-constant static variable is unused
2360 aside from its declaration
2361
2362 To suppress this warning use the @samp{unused} attribute
2363 (@pxref{Variable Attributes}).
2364
2365 @item -Wunused-value
2366 @opindex Wunused-value
2367 Warn whenever a statement computes a result that is explicitly not used.
2368
2369 To suppress this warning cast the expression to @samp{void}.
2370
2371 @item -Wunused
2372 @opindex Wunused
2373 All the above @option{-Wunused} options combined.
2374
2375 In order to get a warning about an unused function parameter, you must
2376 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2377 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2378
2379 @item -Wuninitialized
2380 @opindex Wuninitialized
2381 Warn if an automatic variable is used without first being initialized or
2382 if a variable may be clobbered by a @code{setjmp} call.
2383
2384 These warnings are possible only in optimizing compilation,
2385 because they require data flow information that is computed only
2386 when optimizing.  If you don't specify @option{-O}, you simply won't
2387 get these warnings.
2388
2389 If you want to warn about code which uses the uninitialized value of the
2390 variable in its own initializer, use the @option{-Winit-self} option.
2391
2392 These warnings occur only for variables that are candidates for
2393 register allocation.  Therefore, they do not occur for a variable that
2394 is declared @code{volatile}, or whose address is taken, or whose size
2395 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2396 structures, unions or arrays, even when they are in registers.
2397
2398 Note that there may be no warning about a variable that is used only
2399 to compute a value that itself is never used, because such
2400 computations may be deleted by data flow analysis before the warnings
2401 are printed.
2402
2403 These warnings are made optional because GCC is not smart
2404 enough to see all the reasons why the code might be correct
2405 despite appearing to have an error.  Here is one example of how
2406 this can happen:
2407
2408 @smallexample
2409 @group
2410 @{
2411   int x;
2412   switch (y)
2413     @{
2414     case 1: x = 1;
2415       break;
2416     case 2: x = 4;
2417       break;
2418     case 3: x = 5;
2419     @}
2420   foo (x);
2421 @}
2422 @end group
2423 @end smallexample
2424
2425 @noindent
2426 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2427 always initialized, but GCC doesn't know this.  Here is
2428 another common case:
2429
2430 @smallexample
2431 @{
2432   int save_y;
2433   if (change_y) save_y = y, y = new_y;
2434   @dots{}
2435   if (change_y) y = save_y;
2436 @}
2437 @end smallexample
2438
2439 @noindent
2440 This has no bug because @code{save_y} is used only if it is set.
2441
2442 @cindex @code{longjmp} warnings
2443 This option also warns when a non-volatile automatic variable might be
2444 changed by a call to @code{longjmp}.  These warnings as well are possible
2445 only in optimizing compilation.
2446
2447 The compiler sees only the calls to @code{setjmp}.  It cannot know
2448 where @code{longjmp} will be called; in fact, a signal handler could
2449 call it at any point in the code.  As a result, you may get a warning
2450 even when there is in fact no problem because @code{longjmp} cannot
2451 in fact be called at the place which would cause a problem.
2452
2453 Some spurious warnings can be avoided if you declare all the functions
2454 you use that never return as @code{noreturn}.  @xref{Function
2455 Attributes}.
2456
2457 @item -Wunknown-pragmas
2458 @opindex Wunknown-pragmas
2459 @cindex warning for unknown pragmas
2460 @cindex unknown pragmas, warning
2461 @cindex pragmas, warning of unknown
2462 Warn when a #pragma directive is encountered which is not understood by
2463 GCC@.  If this command line option is used, warnings will even be issued
2464 for unknown pragmas in system header files.  This is not the case if
2465 the warnings were only enabled by the @option{-Wall} command line option.
2466
2467 @item -Wstrict-aliasing
2468 @opindex Wstrict-aliasing
2469 This option is only active when @option{-fstrict-aliasing} is active.
2470 It warns about code which might break the strict aliasing rules that the
2471 compiler is using for optimization. The warning does not catch all
2472 cases, but does attempt to catch the more common pitfalls. It is
2473 included in @option{-Wall}.
2474
2475 @item -Wall
2476 @opindex Wall
2477 All of the above @samp{-W} options combined.  This enables all the
2478 warnings about constructions that some users consider questionable, and
2479 that are easy to avoid (or modify to prevent the warning), even in
2480 conjunction with macros.  This also enables some language-specific
2481 warnings described in @ref{C++ Dialect Options} and
2482 @ref{Objective-C Dialect Options}.
2483 @end table
2484
2485 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2486 Some of them warn about constructions that users generally do not
2487 consider questionable, but which occasionally you might wish to check
2488 for; others warn about constructions that are necessary or hard to avoid
2489 in some cases, and there is no simple way to modify the code to suppress
2490 the warning.
2491
2492 @table @gcctabopt
2493 @item -Wextra
2494 @opindex W
2495 @opindex Wextra
2496 (This option used to be called @option{-W}.  The older name is still
2497 supported, but the newer name is more descriptive.)  Print extra warning
2498 messages for these events:
2499
2500 @itemize @bullet
2501 @item
2502 A function can return either with or without a value.  (Falling
2503 off the end of the function body is considered returning without
2504 a value.)  For example, this function would evoke such a
2505 warning:
2506
2507 @smallexample
2508 @group
2509 foo (a)
2510 @{
2511   if (a > 0)
2512     return a;
2513 @}
2514 @end group
2515 @end smallexample
2516
2517 @item
2518 An expression-statement or the left-hand side of a comma expression
2519 contains no side effects.
2520 To suppress the warning, cast the unused expression to void.
2521 For example, an expression such as @samp{x[i,j]} will cause a warning,
2522 but @samp{x[(void)i,j]} will not.
2523
2524 @item
2525 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2526
2527 @item
2528 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2529 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2530 that of ordinary mathematical notation.
2531
2532 @item
2533 Storage-class specifiers like @code{static} are not the first things in
2534 a declaration.  According to the C Standard, this usage is obsolescent.
2535
2536 @item
2537 The return type of a function has a type qualifier such as @code{const}.
2538 Such a type qualifier has no effect, since the value returned by a
2539 function is not an lvalue.  (But don't warn about the GNU extension of
2540 @code{volatile void} return types.  That extension will be warned about
2541 if @option{-pedantic} is specified.)
2542
2543 @item
2544 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2545 arguments.
2546
2547 @item
2548 A comparison between signed and unsigned values could produce an
2549 incorrect result when the signed value is converted to unsigned.
2550 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2551
2552 @item
2553 An aggregate has an initializer which does not initialize all members.
2554 For example, the following code would cause such a warning, because
2555 @code{x.h} would be implicitly initialized to zero:
2556
2557 @smallexample
2558 struct s @{ int f, g, h; @};
2559 struct s x = @{ 3, 4 @};
2560 @end smallexample
2561
2562 @item
2563 A function parameter is declared without a type specifier in K&R-style
2564 functions:
2565
2566 @smallexample
2567 void foo(bar) @{ @}
2568 @end smallexample
2569
2570 @item
2571 An empty body occurs in an @samp{if} or @samp{else} statement.
2572
2573 @item
2574 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2575 @samp{>}, or @samp{>=}.
2576
2577 @item
2578 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2579
2580 @item
2581 Any of several floating-point events that often indicate errors, such as
2582 overflow, underflow, loss of precision, etc.
2583
2584 @item @r{(C++ only)}
2585 An enumerator and a non-enumerator both appear in a conditional expression.
2586
2587 @item @r{(C++ only)}
2588 A non-static reference or non-static @samp{const} member appears in a
2589 class without constructors.
2590
2591 @item @r{(C++ only)}
2592 Ambiguous virtual bases.
2593
2594 @item @r{(C++ only)}
2595 Subscripting an array which has been declared @samp{register}.
2596
2597 @item @r{(C++ only)}
2598 Taking the address of a variable which has been declared @samp{register}.
2599
2600 @item @r{(C++ only)}
2601 A base class is not initialized in a derived class' copy constructor.
2602 @end itemize
2603
2604 @item -Wno-div-by-zero
2605 @opindex Wno-div-by-zero
2606 @opindex Wdiv-by-zero
2607 Do not warn about compile-time integer division by zero.  Floating point
2608 division by zero is not warned about, as it can be a legitimate way of
2609 obtaining infinities and NaNs.
2610
2611 @item -Wsystem-headers
2612 @opindex Wsystem-headers
2613 @cindex warnings from system headers
2614 @cindex system headers, warnings from
2615 Print warning messages for constructs found in system header files.
2616 Warnings from system headers are normally suppressed, on the assumption
2617 that they usually do not indicate real problems and would only make the
2618 compiler output harder to read.  Using this command line option tells
2619 GCC to emit warnings from system headers as if they occurred in user
2620 code.  However, note that using @option{-Wall} in conjunction with this
2621 option will @emph{not} warn about unknown pragmas in system
2622 headers---for that, @option{-Wunknown-pragmas} must also be used.
2623
2624 @item -Wfloat-equal
2625 @opindex Wfloat-equal
2626 Warn if floating point values are used in equality comparisons.
2627
2628 The idea behind this is that sometimes it is convenient (for the
2629 programmer) to consider floating-point values as approximations to
2630 infinitely precise real numbers.  If you are doing this, then you need
2631 to compute (by analyzing the code, or in some other way) the maximum or
2632 likely maximum error that the computation introduces, and allow for it
2633 when performing comparisons (and when producing output, but that's a
2634 different problem).  In particular, instead of testing for equality, you
2635 would check to see whether the two values have ranges that overlap; and
2636 this is done with the relational operators, so equality comparisons are
2637 probably mistaken.
2638
2639 @item -Wtraditional @r{(C only)}
2640 @opindex Wtraditional
2641 Warn about certain constructs that behave differently in traditional and
2642 ISO C@.  Also warn about ISO C constructs that have no traditional C
2643 equivalent, and/or problematic constructs which should be avoided.
2644
2645 @itemize @bullet
2646 @item
2647 Macro parameters that appear within string literals in the macro body.
2648 In traditional C macro replacement takes place within string literals,
2649 but does not in ISO C@.
2650
2651 @item
2652 In traditional C, some preprocessor directives did not exist.
2653 Traditional preprocessors would only consider a line to be a directive
2654 if the @samp{#} appeared in column 1 on the line.  Therefore
2655 @option{-Wtraditional} warns about directives that traditional C
2656 understands but would ignore because the @samp{#} does not appear as the
2657 first character on the line.  It also suggests you hide directives like
2658 @samp{#pragma} not understood by traditional C by indenting them.  Some
2659 traditional implementations would not recognize @samp{#elif}, so it
2660 suggests avoiding it altogether.
2661
2662 @item
2663 A function-like macro that appears without arguments.
2664
2665 @item
2666 The unary plus operator.
2667
2668 @item
2669 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2670 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2671 constants.)  Note, these suffixes appear in macros defined in the system
2672 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2673 Use of these macros in user code might normally lead to spurious
2674 warnings, however GCC's integrated preprocessor has enough context to
2675 avoid warning in these cases.
2676
2677 @item
2678 A function declared external in one block and then used after the end of
2679 the block.
2680
2681 @item
2682 A @code{switch} statement has an operand of type @code{long}.
2683
2684 @item
2685 A non-@code{static} function declaration follows a @code{static} one.
2686 This construct is not accepted by some traditional C compilers.
2687
2688 @item
2689 The ISO type of an integer constant has a different width or
2690 signedness from its traditional type.  This warning is only issued if
2691 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2692 typically represent bit patterns, are not warned about.
2693
2694 @item
2695 Usage of ISO string concatenation is detected.
2696
2697 @item
2698 Initialization of automatic aggregates.
2699
2700 @item
2701 Identifier conflicts with labels.  Traditional C lacks a separate
2702 namespace for labels.
2703
2704 @item
2705 Initialization of unions.  If the initializer is zero, the warning is
2706 omitted.  This is done under the assumption that the zero initializer in
2707 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2708 initializer warnings and relies on default initialization to zero in the
2709 traditional C case.
2710
2711 @item
2712 Conversions by prototypes between fixed/floating point values and vice
2713 versa.  The absence of these prototypes when compiling with traditional
2714 C would cause serious problems.  This is a subset of the possible
2715 conversion warnings, for the full set use @option{-Wconversion}.
2716
2717 @item
2718 Use of ISO C style function definitions.  This warning intentionally is
2719 @emph{not} issued for prototype declarations or variadic functions
2720 because these ISO C features will appear in your code when using
2721 libiberty's traditional C compatibility macros, @code{PARAMS} and
2722 @code{VPARAMS}.  This warning is also bypassed for nested functions
2723 because that feature is already a GCC extension and thus not relevant to
2724 traditional C compatibility.
2725 @end itemize
2726
2727 @item -Wdeclaration-after-statement @r{(C only)}
2728 @opindex Wdeclaration-after-statement
2729 Warn when a declaration is found after a statement in a block.  This
2730 construct, known from C++, was introduced with ISO C99 and is by default
2731 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2732 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2733
2734 @item -Wundef
2735 @opindex Wundef
2736 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2737
2738 @item -Wendif-labels
2739 @opindex Wendif-labels
2740 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2741
2742 @item -Wshadow
2743 @opindex Wshadow
2744 Warn whenever a local variable shadows another local variable, parameter or
2745 global variable or whenever a built-in function is shadowed.
2746
2747 @item -Wlarger-than-@var{len}
2748 @opindex Wlarger-than
2749 Warn whenever an object of larger than @var{len} bytes is defined.
2750
2751 @item -Wpointer-arith
2752 @opindex Wpointer-arith
2753 Warn about anything that depends on the ``size of'' a function type or
2754 of @code{void}.  GNU C assigns these types a size of 1, for
2755 convenience in calculations with @code{void *} pointers and pointers
2756 to functions.
2757
2758 @item -Wbad-function-cast @r{(C only)}
2759 @opindex Wbad-function-cast
2760 Warn whenever a function call is cast to a non-matching type.
2761 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2762
2763 @item -Wcast-qual
2764 @opindex Wcast-qual
2765 Warn whenever a pointer is cast so as to remove a type qualifier from
2766 the target type.  For example, warn if a @code{const char *} is cast
2767 to an ordinary @code{char *}.
2768
2769 @item -Wcast-align
2770 @opindex Wcast-align
2771 Warn whenever a pointer is cast such that the required alignment of the
2772 target is increased.  For example, warn if a @code{char *} is cast to
2773 an @code{int *} on machines where integers can only be accessed at
2774 two- or four-byte boundaries.
2775
2776 @item -Wwrite-strings
2777 @opindex Wwrite-strings
2778 When compiling C, give string constants the type @code{const
2779 char[@var{length}]} so that
2780 copying the address of one into a non-@code{const} @code{char *}
2781 pointer will get a warning; when compiling C++, warn about the
2782 deprecated conversion from string constants to @code{char *}.
2783 These warnings will help you find at
2784 compile time code that can try to write into a string constant, but
2785 only if you have been very careful about using @code{const} in
2786 declarations and prototypes.  Otherwise, it will just be a nuisance;
2787 this is why we did not make @option{-Wall} request these warnings.
2788
2789 @item -Wconversion
2790 @opindex Wconversion
2791 Warn if a prototype causes a type conversion that is different from what
2792 would happen to the same argument in the absence of a prototype.  This
2793 includes conversions of fixed point to floating and vice versa, and
2794 conversions changing the width or signedness of a fixed point argument
2795 except when the same as the default promotion.
2796
2797 Also, warn if a negative integer constant expression is implicitly
2798 converted to an unsigned type.  For example, warn about the assignment
2799 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2800 casts like @code{(unsigned) -1}.
2801
2802 @item -Wsign-compare
2803 @opindex Wsign-compare
2804 @cindex warning for comparison of signed and unsigned values
2805 @cindex comparison of signed and unsigned values, warning
2806 @cindex signed and unsigned values, comparison warning
2807 Warn when a comparison between signed and unsigned values could produce
2808 an incorrect result when the signed value is converted to unsigned.
2809 This warning is also enabled by @option{-Wextra}; to get the other warnings
2810 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2811
2812 @item -Waggregate-return
2813 @opindex Waggregate-return
2814 Warn if any functions that return structures or unions are defined or
2815 called.  (In languages where you can return an array, this also elicits
2816 a warning.)
2817
2818 @item -Wstrict-prototypes @r{(C only)}
2819 @opindex Wstrict-prototypes
2820 Warn if a function is declared or defined without specifying the
2821 argument types.  (An old-style function definition is permitted without
2822 a warning if preceded by a declaration which specifies the argument
2823 types.)
2824
2825 @item -Wold-style-definition @r{(C only)}
2826 @opindex Wold-style-definition
2827 Warn if an old-style function definition is used.  A warning is given
2828 even if there is a previous prototype.
2829
2830 @item -Wmissing-prototypes @r{(C only)}
2831 @opindex Wmissing-prototypes
2832 Warn if a global function is defined without a previous prototype
2833 declaration.  This warning is issued even if the definition itself
2834 provides a prototype.  The aim is to detect global functions that fail
2835 to be declared in header files.
2836
2837 @item -Wmissing-declarations @r{(C only)}
2838 @opindex Wmissing-declarations
2839 Warn if a global function is defined without a previous declaration.
2840 Do so even if the definition itself provides a prototype.
2841 Use this option to detect global functions that are not declared in
2842 header files.
2843
2844 @item -Wmissing-noreturn
2845 @opindex Wmissing-noreturn
2846 Warn about functions which might be candidates for attribute @code{noreturn}.
2847 Note these are only possible candidates, not absolute ones.  Care should
2848 be taken to manually verify functions actually do not ever return before
2849 adding the @code{noreturn} attribute, otherwise subtle code generation
2850 bugs could be introduced.  You will not get a warning for @code{main} in
2851 hosted C environments.
2852
2853 @item -Wmissing-format-attribute
2854 @opindex Wmissing-format-attribute
2855 @opindex Wformat
2856 If @option{-Wformat} is enabled, also warn about functions which might be
2857 candidates for @code{format} attributes.  Note these are only possible
2858 candidates, not absolute ones.  GCC will guess that @code{format}
2859 attributes might be appropriate for any function that calls a function
2860 like @code{vprintf} or @code{vscanf}, but this might not always be the
2861 case, and some functions for which @code{format} attributes are
2862 appropriate may not be detected.  This option has no effect unless
2863 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2864
2865 @item -Wno-multichar
2866 @opindex Wno-multichar
2867 @opindex Wmultichar
2868 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2869 Usually they indicate a typo in the user's code, as they have
2870 implementation-defined values, and should not be used in portable code.
2871
2872 @item -Wno-deprecated-declarations
2873 @opindex Wno-deprecated-declarations
2874 Do not warn about uses of functions, variables, and types marked as
2875 deprecated by using the @code{deprecated} attribute.
2876 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2877 @pxref{Type Attributes}.)
2878
2879 @item -Wpacked
2880 @opindex Wpacked
2881 Warn if a structure is given the packed attribute, but the packed
2882 attribute has no effect on the layout or size of the structure.
2883 Such structures may be mis-aligned for little benefit.  For
2884 instance, in this code, the variable @code{f.x} in @code{struct bar}
2885 will be misaligned even though @code{struct bar} does not itself
2886 have the packed attribute:
2887
2888 @smallexample
2889 @group
2890 struct foo @{
2891   int x;
2892   char a, b, c, d;
2893 @} __attribute__((packed));
2894 struct bar @{
2895   char z;
2896   struct foo f;
2897 @};
2898 @end group
2899 @end smallexample
2900
2901 @item -Wpadded
2902 @opindex Wpadded
2903 Warn if padding is included in a structure, either to align an element
2904 of the structure or to align the whole structure.  Sometimes when this
2905 happens it is possible to rearrange the fields of the structure to
2906 reduce the padding and so make the structure smaller.
2907
2908 @item -Wredundant-decls
2909 @opindex Wredundant-decls
2910 Warn if anything is declared more than once in the same scope, even in
2911 cases where multiple declaration is valid and changes nothing.
2912
2913 @item -Wnested-externs @r{(C only)}
2914 @opindex Wnested-externs
2915 Warn if an @code{extern} declaration is encountered within a function.
2916
2917 @item -Wunreachable-code
2918 @opindex Wunreachable-code
2919 Warn if the compiler detects that code will never be executed.
2920
2921 This option is intended to warn when the compiler detects that at
2922 least a whole line of source code will never be executed, because
2923 some condition is never satisfied or because it is after a
2924 procedure that never returns.
2925
2926 It is possible for this option to produce a warning even though there
2927 are circumstances under which part of the affected line can be executed,
2928 so care should be taken when removing apparently-unreachable code.
2929
2930 For instance, when a function is inlined, a warning may mean that the
2931 line is unreachable in only one inlined copy of the function.
2932
2933 This option is not made part of @option{-Wall} because in a debugging
2934 version of a program there is often substantial code which checks
2935 correct functioning of the program and is, hopefully, unreachable
2936 because the program does work.  Another common use of unreachable
2937 code is to provide behavior which is selectable at compile-time.
2938
2939 @item -Winline
2940 @opindex Winline
2941 Warn if a function can not be inlined and it was declared as inline.
2942 Even with this option, the compiler will not warn about failures to
2943 inline functions declared in system headers.
2944
2945 The compiler uses a variety of heuristics to determine whether or not
2946 to inline a function.  For example, the compiler takes into account
2947 the size of the function being inlined and the the amount of inlining
2948 that has already been done in the current function.  Therefore,
2949 seemingly insignificant changes in the source program can cause the
2950 warnings produced by @option{-Winline} to appear or disappear.
2951
2952 @item -Wno-invalid-offsetof @r{(C++ only)}
2953 @opindex Wno-invalid-offsetof
2954 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2955 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2956 to a non-POD type is undefined.  In existing C++ implementations,
2957 however, @samp{offsetof} typically gives meaningful results even when
2958 applied to certain kinds of non-POD types. (Such as a simple
2959 @samp{struct} that fails to be a POD type only by virtue of having a
2960 constructor.)  This flag is for users who are aware that they are
2961 writing nonportable code and who have deliberately chosen to ignore the
2962 warning about it.
2963
2964 The restrictions on @samp{offsetof} may be relaxed in a future version
2965 of the C++ standard.
2966
2967 @item -Winvalid-pch
2968 @opindex Winvalid-pch
2969 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2970 the search path but can't be used.
2971
2972 @item -Wlong-long
2973 @opindex Wlong-long
2974 @opindex Wno-long-long
2975 Warn if @samp{long long} type is used.  This is default.  To inhibit
2976 the warning messages, use @option{-Wno-long-long}.  Flags
2977 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2978 only when @option{-pedantic} flag is used.
2979
2980 @item -Wdisabled-optimization
2981 @opindex Wdisabled-optimization
2982 Warn if a requested optimization pass is disabled.  This warning does
2983 not generally indicate that there is anything wrong with your code; it
2984 merely indicates that GCC's optimizers were unable to handle the code
2985 effectively.  Often, the problem is that your code is too big or too
2986 complex; GCC will refuse to optimize programs when the optimization
2987 itself is likely to take inordinate amounts of time.
2988
2989 @item -Werror
2990 @opindex Werror
2991 Make all warnings into errors.
2992 @end table
2993
2994 @node Debugging Options
2995 @section Options for Debugging Your Program or GCC
2996 @cindex options, debugging
2997 @cindex debugging information options
2998
2999 GCC has various special options that are used for debugging
3000 either your program or GCC:
3001
3002 @table @gcctabopt
3003 @item -g
3004 @opindex g
3005 Produce debugging information in the operating system's native format
3006 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3007 information.
3008
3009 On most systems that use stabs format, @option{-g} enables use of extra
3010 debugging information that only GDB can use; this extra information
3011 makes debugging work better in GDB but will probably make other debuggers
3012 crash or
3013 refuse to read the program.  If you want to control for certain whether
3014 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3015 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3016
3017 Unlike most other C compilers, GCC allows you to use @option{-g} with
3018 @option{-O}.  The shortcuts taken by optimized code may occasionally
3019 produce surprising results: some variables you declared may not exist
3020 at all; flow of control may briefly move where you did not expect it;
3021 some statements may not be executed because they compute constant
3022 results or their values were already at hand; some statements may
3023 execute in different places because they were moved out of loops.
3024
3025 Nevertheless it proves possible to debug optimized output.  This makes
3026 it reasonable to use the optimizer for programs that might have bugs.
3027
3028 The following options are useful when GCC is generated with the
3029 capability for more than one debugging format.
3030
3031 @item -ggdb
3032 @opindex ggdb
3033 Produce debugging information for use by GDB@.  This means to use the
3034 most expressive format available (DWARF 2, stabs, or the native format
3035 if neither of those are supported), including GDB extensions if at all
3036 possible.
3037
3038 @item -gstabs
3039 @opindex gstabs
3040 Produce debugging information in stabs format (if that is supported),
3041 without GDB extensions.  This is the format used by DBX on most BSD
3042 systems.  On MIPS, Alpha and System V Release 4 systems this option
3043 produces stabs debugging output which is not understood by DBX or SDB@.
3044 On System V Release 4 systems this option requires the GNU assembler.
3045
3046 @item -feliminate-unused-debug-symbols
3047 @opindex feliminate-unused-debug-symbols
3048 Produce debugging information in stabs format (if that is supported),
3049 for only symbols that are actually used.
3050
3051 @item -gstabs+
3052 @opindex gstabs+
3053 Produce debugging information in stabs format (if that is supported),
3054 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3055 use of these extensions is likely to make other debuggers crash or
3056 refuse to read the program.
3057
3058 @item -gcoff
3059 @opindex gcoff
3060 Produce debugging information in COFF format (if that is supported).
3061 This is the format used by SDB on most System V systems prior to
3062 System V Release 4.
3063
3064 @item -gxcoff
3065 @opindex gxcoff
3066 Produce debugging information in XCOFF format (if that is supported).
3067 This is the format used by the DBX debugger on IBM RS/6000 systems.
3068
3069 @item -gxcoff+
3070 @opindex gxcoff+
3071 Produce debugging information in XCOFF format (if that is supported),
3072 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3073 use of these extensions is likely to make other debuggers crash or
3074 refuse to read the program, and may cause assemblers other than the GNU
3075 assembler (GAS) to fail with an error.
3076
3077 @item -gdwarf-2
3078 @opindex gdwarf-2
3079 Produce debugging information in DWARF version 2 format (if that is
3080 supported).  This is the format used by DBX on IRIX 6.
3081
3082 @item -gvms
3083 @opindex gvms
3084 Produce debugging information in VMS debug format (if that is
3085 supported).  This is the format used by DEBUG on VMS systems.
3086
3087 @item -g@var{level}
3088 @itemx -ggdb@var{level}
3089 @itemx -gstabs@var{level}
3090 @itemx -gcoff@var{level}
3091 @itemx -gxcoff@var{level}
3092 @itemx -gvms@var{level}
3093 Request debugging information and also use @var{level} to specify how
3094 much information.  The default level is 2.
3095
3096 Level 1 produces minimal information, enough for making backtraces in
3097 parts of the program that you don't plan to debug.  This includes
3098 descriptions of functions and external variables, but no information
3099 about local variables and no line numbers.
3100
3101 Level 3 includes extra information, such as all the macro definitions
3102 present in the program.  Some debuggers support macro expansion when
3103 you use @option{-g3}.
3104
3105 Note that in order to avoid confusion between DWARF1 debug level 2,
3106 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3107 level.  Instead use an additional @option{-g@var{level}} option to
3108 change the debug level for DWARF2.
3109
3110 @item -feliminate-dwarf2-dups
3111 @opindex feliminate-dwarf2-dups
3112 Compress DWARF2 debugging information by eliminating duplicated
3113 information about each symbol.  This option only makes sense when
3114 generating DWARF2 debugging information with @option{-gdwarf-2}.
3115
3116 @cindex @command{prof}
3117 @item -p
3118 @opindex p
3119 Generate extra code to write profile information suitable for the
3120 analysis program @command{prof}.  You must use this option when compiling
3121 the source files you want data about, and you must also use it when
3122 linking.
3123
3124 @cindex @command{gprof}
3125 @item -pg
3126 @opindex pg
3127 Generate extra code to write profile information suitable for the
3128 analysis program @command{gprof}.  You must use this option when compiling
3129 the source files you want data about, and you must also use it when
3130 linking.
3131
3132 @item -Q
3133 @opindex Q
3134 Makes the compiler print out each function name as it is compiled, and
3135 print some statistics about each pass when it finishes.
3136
3137 @item -ftime-report
3138 @opindex ftime-report
3139 Makes the compiler print some statistics about the time consumed by each
3140 pass when it finishes.
3141
3142 @item -fmem-report
3143 @opindex fmem-report
3144 Makes the compiler print some statistics about permanent memory
3145 allocation when it finishes.
3146
3147 @item -fprofile-arcs
3148 @opindex fprofile-arcs
3149 Add code so that program flow @dfn{arcs} are instrumented.  During
3150 execution the program records how many times each branch and call is
3151 executed and how many times it is taken or returns.  When the compiled
3152 program exits it saves this data to a file called
3153 @file{@var{auxname}.gcda} for each source file. The data may be used for
3154 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3155 test coverage analysis (@option{-ftest-coverage}). Each object file's
3156 @var{auxname} is generated from the name of the output file, if
3157 explicitly specified and it is not the final executable, otherwise it is
3158 the basename of the source file. In both cases any suffix is removed
3159 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3160 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3161
3162 @itemize
3163
3164 @item
3165 Compile the source files with @option{-fprofile-arcs} plus optimization
3166 and code generation options. For test coverage analysis, use the
3167 additional @option{-ftest-coverage} option. You do not need to profile
3168 every source file in a program.
3169
3170 @item
3171 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3172 (the latter implies the former).
3173
3174 @item
3175 Run the program on a representative workload to generate the arc profile
3176 information. This may be repeated any number of times. You can run
3177 concurrent instances of your program, and provided that the file system
3178 supports locking, the data files will be correctly updated. Also
3179 @code{fork} calls are detected and correctly handled (double counting
3180 will not happen).
3181
3182 @item
3183 For profile-directed optimizations, compile the source files again with
3184 the same optimization and code generation options plus
3185 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3186 Control Optimization}).
3187
3188 @item
3189 For test coverage analysis, use @command{gcov} to produce human readable
3190 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3191 @command{gcov} documentation for further information.
3192
3193 @end itemize
3194
3195 With @option{-fprofile-arcs}, for each function of your program GCC
3196 creates a program flow graph, then finds a spanning tree for the graph.
3197 Only arcs that are not on the spanning tree have to be instrumented: the
3198 compiler adds code to count the number of times that these arcs are
3199 executed.  When an arc is the only exit or only entrance to a block, the
3200 instrumentation code can be added to the block; otherwise, a new basic
3201 block must be created to hold the instrumentation code.
3202
3203 @need 2000
3204 @item -ftest-coverage
3205 @opindex ftest-coverage
3206 Produce a notes file that the @command{gcov} code-coverage utility
3207 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3208 show program coverage. Each source file's note file is called
3209 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3210 above for a description of @var{auxname} and instructions on how to
3211 generate test coverage data. Coverage data will match the source files
3212 more closely, if you do not optimize.
3213
3214 @item -d@var{letters}
3215 @opindex d
3216 Says to make debugging dumps during compilation at times specified by
3217 @var{letters}.  This is used for debugging the compiler.  The file names
3218 for most of the dumps are made by appending a pass number and a word to
3219 the @var{dumpname}. @var{dumpname} is generated from the name of the
3220 output file, if explicitly specified and it is not an executable,
3221 otherwise it is the basename of the source file. In both cases any
3222 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3223 Here are the possible letters for use in @var{letters}, and their
3224 meanings:
3225
3226 @table @samp
3227 @item A
3228 @opindex dA
3229 Annotate the assembler output with miscellaneous debugging information.
3230 @item b
3231 @opindex db
3232 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3233 @item B
3234 @opindex dB
3235 Dump after block reordering, to @file{@var{file}.31.bbro}.
3236 @item c
3237 @opindex dc
3238 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3239 @item C
3240 @opindex dC
3241 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3242 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3243 @item d
3244 @opindex dd
3245 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3246 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3247 @item D
3248 @opindex dD
3249 Dump all macro definitions, at the end of preprocessing, in addition to
3250 normal output.
3251 @item E
3252 @opindex dE
3253 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3254 @item f
3255 @opindex df
3256 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3257 Also dump after life analysis, to @file{@var{file}.19.life}.
3258 @item F
3259 @opindex dF
3260 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3261 @item g
3262 @opindex dg
3263 Dump after global register allocation, to @file{@var{file}.25.greg}.
3264 @item G
3265 @opindex dG
3266 Dump after GCSE, to @file{@var{file}.08.gcse}.
3267 Also dump after jump bypassing and control flow optimizations, to
3268 @file{@var{file}.10.bypass}.
3269 @item h
3270 @opindex dh
3271 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3272 @item i
3273 @opindex di
3274 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3275 @item j
3276 @opindex dj
3277 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3278 @item k
3279 @opindex dk
3280 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3281 @item l
3282 @opindex dl
3283 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3284 @item L
3285 @opindex dL
3286 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3287 @file{@var{file}.16.loop2}.
3288 @item M
3289 @opindex dM
3290 Dump after performing the machine dependent reorganization pass, to
3291 @file{@var{file}.35.mach}.
3292 @item n
3293 @opindex dn
3294 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3295 @item N
3296 @opindex dN
3297 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3298 @item o
3299 @opindex do
3300 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3301 @item r
3302 @opindex dr
3303 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3304 @item R
3305 @opindex dR
3306 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3307 @item s
3308 @opindex ds
3309 Dump after CSE (including the jump optimization that sometimes follows
3310 CSE), to @file{@var{file}.06.cse}.
3311 @item S
3312 @opindex dS
3313 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3314 @item t
3315 @opindex dt
3316 Dump after the second CSE pass (including the jump optimization that
3317 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3318 @item T
3319 @opindex dT
3320 Dump after running tracer, to @file{@var{file}.15.tracer}.
3321 @item u
3322 @opindex du
3323 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3324 @item U
3325 @opindex dU
3326 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3327 @item V
3328 @opindex dV
3329 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3330 @item w
3331 @opindex dw
3332 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3333 @item z
3334 @opindex dz
3335 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3336 @item Z
3337 @opindex dZ
3338 Dump after constructing the web, to @file{@var{file}.17.web}.
3339 @item a
3340 @opindex da
3341 Produce all the dumps listed above.
3342 @item H
3343 @opindex dH
3344 Produce a core dump whenever an error occurs.
3345 @item m
3346 @opindex dm
3347 Print statistics on memory usage, at the end of the run, to
3348 standard error.
3349 @item p
3350 @opindex dp
3351 Annotate the assembler output with a comment indicating which
3352 pattern and alternative was used.  The length of each instruction is
3353 also printed.
3354 @item P
3355 @opindex dP
3356 Dump the RTL in the assembler output as a comment before each instruction.
3357 Also turns on @option{-dp} annotation.
3358 @item v
3359 @opindex dv
3360 For each of the other indicated dump files (except for
3361 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3362 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3363 @item x
3364 @opindex dx
3365 Just generate RTL for a function instead of compiling it.  Usually used
3366 with @samp{r}.
3367 @item y
3368 @opindex dy
3369 Dump debugging information during parsing, to standard error.
3370 @end table
3371
3372 @item -fdump-unnumbered
3373 @opindex fdump-unnumbered
3374 When doing debugging dumps (see @option{-d} option above), suppress instruction
3375 numbers and line number note output.  This makes it more feasible to
3376 use diff on debugging dumps for compiler invocations with different
3377 options, in particular with and without @option{-g}.
3378
3379 @item -fdump-translation-unit @r{(C and C++ only)}
3380 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3381 @opindex fdump-translation-unit
3382 Dump a representation of the tree structure for the entire translation
3383 unit to a file.  The file name is made by appending @file{.tu} to the
3384 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3385 controls the details of the dump as described for the
3386 @option{-fdump-tree} options.
3387
3388 @item -fdump-class-hierarchy @r{(C++ only)}
3389 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3390 @opindex fdump-class-hierarchy
3391 Dump a representation of each class's hierarchy and virtual function
3392 table layout to a file.  The file name is made by appending @file{.class}
3393 to the source file name.  If the @samp{-@var{options}} form is used,
3394 @var{options} controls the details of the dump as described for the
3395 @option{-fdump-tree} options.
3396
3397 @item -fdump-tree-@var{switch} @r{(C++ only)}
3398 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3399 @opindex fdump-tree
3400 Control the dumping at various stages of processing the intermediate
3401 language tree to a file.  The file name is generated by appending a switch
3402 specific suffix to the source file name.  If the @samp{-@var{options}}
3403 form is used, @var{options} is a list of @samp{-} separated options that
3404 control the details of the dump. Not all options are applicable to all
3405 dumps, those which are not meaningful will be ignored. The following
3406 options are available
3407
3408 @table @samp
3409 @item address
3410 Print the address of each node.  Usually this is not meaningful as it
3411 changes according to the environment and source file. Its primary use
3412 is for tying up a dump file with a debug environment.
3413 @item slim
3414 Inhibit dumping of members of a scope or body of a function merely
3415 because that scope has been reached. Only dump such items when they
3416 are directly reachable by some other path.
3417 @item all
3418 Turn on all options.
3419 @end table
3420
3421 The following tree dumps are possible:
3422 @table @samp
3423 @item original
3424 Dump before any tree based optimization, to @file{@var{file}.original}.
3425 @item optimized
3426 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3427 @item inlined
3428 Dump after function inlining, to @file{@var{file}.inlined}.
3429 @end table
3430
3431 @item -frandom-seed=@var{string}
3432 @opindex frandom-string
3433 This option provides a seed that GCC uses when it would otherwise use
3434 random numbers.  It is used to generate certain symbol names
3435 that have to be different in every compiled file. It is also used to
3436 place unique stamps in coverage data files and the object files that
3437 produce them. You can use the @option{-frandom-seed} option to produce
3438 reproducibly identical object files.
3439
3440 The @var{string} should be different for every file you compile.
3441
3442 @item -fsched-verbose=@var{n}
3443 @opindex fsched-verbose
3444 On targets that use instruction scheduling, this option controls the
3445 amount of debugging output the scheduler prints.  This information is
3446 written to standard error, unless @option{-dS} or @option{-dR} is
3447 specified, in which case it is output to the usual dump
3448 listing file, @file{.sched} or @file{.sched2} respectively.  However
3449 for @var{n} greater than nine, the output is always printed to standard
3450 error.
3451
3452 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3453 same information as @option{-dRS}.  For @var{n} greater than one, it
3454 also output basic block probabilities, detailed ready list information
3455 and unit/insn info.  For @var{n} greater than two, it includes RTL
3456 at abort point, control-flow and regions info.  And for @var{n} over
3457 four, @option{-fsched-verbose} also includes dependence info.
3458
3459 @item -save-temps
3460 @opindex save-temps
3461 Store the usual ``temporary'' intermediate files permanently; place them
3462 in the current directory and name them based on the source file.  Thus,
3463 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3464 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3465 preprocessed @file{foo.i} output file even though the compiler now
3466 normally uses an integrated preprocessor.
3467
3468 @item -time
3469 @opindex time
3470 Report the CPU time taken by each subprocess in the compilation
3471 sequence.  For C source files, this is the compiler proper and assembler
3472 (plus the linker if linking is done).  The output looks like this:
3473
3474 @smallexample
3475 # cc1 0.12 0.01
3476 # as 0.00 0.01
3477 @end smallexample
3478
3479 The first number on each line is the ``user time,'' that is time spent
3480 executing the program itself.  The second number is ``system time,''
3481 time spent executing operating system routines on behalf of the program.
3482 Both numbers are in seconds.
3483
3484 @item -print-file-name=@var{library}
3485 @opindex print-file-name
3486 Print the full absolute name of the library file @var{library} that
3487 would be used when linking---and don't do anything else.  With this
3488 option, GCC does not compile or link anything; it just prints the
3489 file name.
3490
3491 @item -print-multi-directory
3492 @opindex print-multi-directory
3493 Print the directory name corresponding to the multilib selected by any
3494 other switches present in the command line.  This directory is supposed
3495 to exist in @env{GCC_EXEC_PREFIX}.
3496
3497 @item -print-multi-lib
3498 @opindex print-multi-lib
3499 Print the mapping from multilib directory names to compiler switches
3500 that enable them.  The directory name is separated from the switches by
3501 @samp{;}, and each switch starts with an @samp{@@} instead of the
3502 @samp{-}, without spaces between multiple switches.  This is supposed to
3503 ease shell-processing.
3504
3505 @item -print-prog-name=@var{program}
3506 @opindex print-prog-name
3507 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3508
3509 @item -print-libgcc-file-name
3510 @opindex print-libgcc-file-name
3511 Same as @option{-print-file-name=libgcc.a}.
3512
3513 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3514 but you do want to link with @file{libgcc.a}.  You can do
3515
3516 @smallexample
3517 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3518 @end smallexample
3519
3520 @item -print-search-dirs
3521 @opindex print-search-dirs
3522 Print the name of the configured installation directory and a list of
3523 program and library directories @command{gcc} will search---and don't do anything else.
3524
3525 This is useful when @command{gcc} prints the error message
3526 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3527 To resolve this you either need to put @file{cpp0} and the other compiler
3528 components where @command{gcc} expects to find them, or you can set the environment
3529 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3530 Don't forget the trailing '/'.
3531 @xref{Environment Variables}.
3532
3533 @item -dumpmachine
3534 @opindex dumpmachine
3535 Print the compiler's target machine (for example,
3536 @samp{i686-pc-linux-gnu})---and don't do anything else.
3537
3538 @item -dumpversion
3539 @opindex dumpversion
3540 Print the compiler version (for example, @samp{3.0})---and don't do
3541 anything else.
3542
3543 @item -dumpspecs
3544 @opindex dumpspecs
3545 Print the compiler's built-in specs---and don't do anything else.  (This
3546 is used when GCC itself is being built.)  @xref{Spec Files}.
3547
3548 @item -feliminate-unused-debug-types
3549 @opindex feliminate-unused-debug-types
3550 Normally, when producing DWARF2 output, GCC will emit debugging
3551 information for all types declared in a compilation
3552 unit, regardless of whether or not they are actually used
3553 in that compilation unit.  Sometimes this is useful, such as
3554 if, in the debugger, you want to cast a value to a type that is
3555 not actually used in your program (but is declared).  More often,
3556 however, this results in a significant amount of wasted space.
3557 With this option, GCC will avoid producing debug symbol output
3558 for types that are nowhere used in the source file being compiled.
3559 @end table
3560
3561 @node Optimize Options
3562 @section Options That Control Optimization
3563 @cindex optimize options
3564 @cindex options, optimization
3565
3566 These options control various sorts of optimizations.
3567
3568 Without any optimization option, the compiler's goal is to reduce the
3569 cost of compilation and to make debugging produce the expected
3570 results.  Statements are independent: if you stop the program with a
3571 breakpoint between statements, you can then assign a new value to any
3572 variable or change the program counter to any other statement in the
3573 function and get exactly the results you would expect from the source
3574 code.
3575
3576 Turning on optimization flags makes the compiler attempt to improve
3577 the performance and/or code size at the expense of compilation time
3578 and possibly the ability to debug the program.
3579
3580 The compiler performs optimization based on the knowledge it has of
3581 the program.  Using the @option{-funit-at-a-time} flag will allow the
3582 compiler to consider information gained from later functions in the
3583 file when compiling a function.  Compiling multiple files at once to a
3584 single output file (and using @option{-funit-at-a-time}) will allow
3585 the compiler to use information gained from all of the files when
3586 compiling each of them.
3587
3588 Not all optimizations are controlled directly by a flag.  Only
3589 optimizations that have a flag are listed.
3590
3591 @table @gcctabopt
3592 @item -O
3593 @itemx -O1
3594 @opindex O
3595 @opindex O1
3596 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3597 more memory for a large function.
3598
3599 With @option{-O}, the compiler tries to reduce code size and execution
3600 time, without performing any optimizations that take a great deal of
3601 compilation time.
3602
3603 @option{-O} turns on the following optimization flags:
3604 @gccoptlist{-fdefer-pop @gol
3605 -fmerge-constants @gol
3606 -fthread-jumps @gol
3607 -floop-optimize @gol
3608 -fif-conversion @gol
3609 -fif-conversion2 @gol
3610 -fdelayed-branch @gol
3611 -fguess-branch-probability @gol
3612 -fcprop-registers}
3613
3614 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3615 where doing so does not interfere with debugging.
3616
3617 @item -O2
3618 @opindex O2
3619 Optimize even more.  GCC performs nearly all supported optimizations
3620 that do not involve a space-speed tradeoff.  The compiler does not
3621 perform loop unrolling or function inlining when you specify @option{-O2}.
3622 As compared to @option{-O}, this option increases both compilation time
3623 and the performance of the generated code.
3624
3625 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3626 also turns on the following optimization flags:
3627 @gccoptlist{-fforce-mem @gol
3628 -foptimize-sibling-calls @gol
3629 -fstrength-reduce @gol
3630 -fcse-follow-jumps  -fcse-skip-blocks @gol
3631 -frerun-cse-after-loop  -frerun-loop-opt @gol
3632 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3633 -fdelete-null-pointer-checks @gol
3634 -fexpensive-optimizations @gol
3635 -fregmove @gol
3636 -fschedule-insns  -fschedule-insns2 @gol
3637 -fsched-interblock  -fsched-spec @gol
3638 -fcaller-saves @gol
3639 -fpeephole2 @gol
3640 -freorder-blocks  -freorder-functions @gol
3641 -fstrict-aliasing @gol
3642 -funit-at-a-time @gol
3643 -falign-functions  -falign-jumps @gol
3644 -falign-loops  -falign-labels @gol
3645 -fcrossjumping}
3646
3647 Please note the warning under @option{-fgcse} about
3648 invoking @option{-O2} on programs that use computed gotos.
3649
3650 @item -O3
3651 @opindex O3
3652 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3653 @option{-O2} and also turns on the @option{-finline-functions},
3654 @option{-fweb} and @option{-frename-registers} options.
3655
3656 @item -O0
3657 @opindex O0
3658 Do not optimize.  This is the default.
3659
3660 @item -Os
3661 @opindex Os
3662 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3663 do not typically increase code size.  It also performs further
3664 optimizations designed to reduce code size.
3665
3666 @option{-Os} disables the following optimization flags:
3667 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3668 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3669
3670 If you use multiple @option{-O} options, with or without level numbers,
3671 the last such option is the one that is effective.
3672 @end table
3673
3674 Options of the form @option{-f@var{flag}} specify machine-independent
3675 flags.  Most flags have both positive and negative forms; the negative
3676 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3677 below, only one of the forms is listed---the one you typically will
3678 use.  You can figure out the other form by either removing @samp{no-}
3679 or adding it.
3680
3681 The following options control specific optimizations.  They are either
3682 activated by @option{-O} options or are related to ones that are.  You
3683 can use the following flags in the rare cases when ``fine-tuning'' of
3684 optimizations to be performed is desired.
3685
3686 @table @gcctabopt
3687 @item -fno-default-inline
3688 @opindex fno-default-inline
3689 Do not make member functions inline by default merely because they are
3690 defined inside the class scope (C++ only).  Otherwise, when you specify
3691 @w{@option{-O}}, member functions defined inside class scope are compiled
3692 inline by default; i.e., you don't need to add @samp{inline} in front of
3693 the member function name.
3694
3695 @item -fno-defer-pop
3696 @opindex fno-defer-pop
3697 Always pop the arguments to each function call as soon as that function
3698 returns.  For machines which must pop arguments after a function call,
3699 the compiler normally lets arguments accumulate on the stack for several
3700 function calls and pops them all at once.
3701
3702 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3703
3704 @item -fforce-mem
3705 @opindex fforce-mem
3706 Force memory operands to be copied into registers before doing
3707 arithmetic on them.  This produces better code by making all memory
3708 references potential common subexpressions.  When they are not common
3709 subexpressions, instruction combination should eliminate the separate
3710 register-load.
3711
3712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3713
3714 @item -fforce-addr
3715 @opindex fforce-addr
3716 Force memory address constants to be copied into registers before
3717 doing arithmetic on them.  This may produce better code just as
3718 @option{-fforce-mem} may.
3719
3720 @item -fomit-frame-pointer
3721 @opindex fomit-frame-pointer
3722 Don't keep the frame pointer in a register for functions that
3723 don't need one.  This avoids the instructions to save, set up and
3724 restore frame pointers; it also makes an extra register available
3725 in many functions.  @strong{It also makes debugging impossible on
3726 some machines.}
3727
3728 On some machines, such as the VAX, this flag has no effect, because
3729 the standard calling sequence automatically handles the frame pointer
3730 and nothing is saved by pretending it doesn't exist.  The
3731 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3732 whether a target machine supports this flag.  @xref{Registers,,Register
3733 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3734
3735 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3736
3737 @item -foptimize-sibling-calls
3738 @opindex foptimize-sibling-calls
3739 Optimize sibling and tail recursive calls.
3740
3741 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3742
3743 @item -fno-inline
3744 @opindex fno-inline
3745 Don't pay attention to the @code{inline} keyword.  Normally this option
3746 is used to keep the compiler from expanding any functions inline.
3747 Note that if you are not optimizing, no functions can be expanded inline.
3748
3749 @item -finline-functions
3750 @opindex finline-functions
3751 Integrate all simple functions into their callers.  The compiler
3752 heuristically decides which functions are simple enough to be worth
3753 integrating in this way.
3754
3755 If all calls to a given function are integrated, and the function is
3756 declared @code{static}, then the function is normally not output as
3757 assembler code in its own right.
3758
3759 Enabled at level @option{-O3}.
3760
3761 @item -finline-limit=@var{n}
3762 @opindex finline-limit
3763 By default, GCC limits the size of functions that can be inlined.  This flag
3764 allows the control of this limit for functions that are explicitly marked as
3765 inline (i.e., marked with the inline keyword or defined within the class
3766 definition in c++).  @var{n} is the size of functions that can be inlined in
3767 number of pseudo instructions (not counting parameter handling).  The default
3768 value of @var{n} is 600.
3769 Increasing this value can result in more inlined code at
3770 the cost of compilation time and memory consumption.  Decreasing usually makes
3771 the compilation faster and less code will be inlined (which presumably
3772 means slower programs).  This option is particularly useful for programs that
3773 use inlining heavily such as those based on recursive templates with C++.
3774
3775 Inlining is actually controlled by a number of parameters, which may be
3776 specified individually by using @option{--param @var{name}=@var{value}}.
3777 The @option{-finline-limit=@var{n}} option sets some of these parameters
3778 as follows:
3779
3780 @table @gcctabopt
3781  @item max-inline-insns-single
3782   is set to @var{n}/2.
3783  @item max-inline-insns-auto
3784   is set to @var{n}/2.
3785  @item min-inline-insns
3786   is set to 130 or @var{n}/4, whichever is smaller.
3787  @item max-inline-insns-rtl
3788   is set to @var{n}.
3789 @end table
3790
3791 See below for a documentation of the individual
3792 parameters controlling inlining.
3793
3794 @emph{Note:} pseudo instruction represents, in this particular context, an
3795 abstract measurement of function's size.  In no way, it represents a count
3796 of assembly instructions and as such its exact meaning might change from one
3797 release to an another.
3798
3799 @item -fkeep-inline-functions
3800 @opindex fkeep-inline-functions
3801 Even if all calls to a given function are integrated, and the function
3802 is declared @code{static}, nevertheless output a separate run-time
3803 callable version of the function.  This switch does not affect
3804 @code{extern inline} functions.
3805
3806 @item -fkeep-static-consts
3807 @opindex fkeep-static-consts
3808 Emit variables declared @code{static const} when optimization isn't turned
3809 on, even if the variables aren't referenced.
3810
3811 GCC enables this option by default.  If you want to force the compiler to
3812 check if the variable was referenced, regardless of whether or not
3813 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3814
3815 @item -fmerge-constants
3816 Attempt to merge identical constants (string constants and floating point
3817 constants) across compilation units.
3818
3819 This option is the default for optimized compilation if the assembler and
3820 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3821 behavior.
3822
3823 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3824
3825 @item -fmerge-all-constants
3826 Attempt to merge identical constants and identical variables.
3827
3828 This option implies @option{-fmerge-constants}.  In addition to
3829 @option{-fmerge-constants} this considers e.g. even constant initialized
3830 arrays or initialized constant variables with integral or floating point
3831 types.  Languages like C or C++ require each non-automatic variable to
3832 have distinct location, so using this option will result in non-conforming
3833 behavior.
3834
3835 @item -fnew-ra
3836 @opindex fnew-ra
3837 Use a graph coloring register allocator.  Currently this option is meant
3838 only for testing.  Users should not specify this option, since it is not
3839 yet ready for production use.
3840
3841 @item -fno-branch-count-reg
3842 @opindex fno-branch-count-reg
3843 Do not use ``decrement and branch'' instructions on a count register,
3844 but instead generate a sequence of instructions that decrement a
3845 register, compare it against zero, then branch based upon the result.
3846 This option is only meaningful on architectures that support such
3847 instructions, which include x86, PowerPC, IA-64 and S/390.
3848
3849 The default is @option{-fbranch-count-reg}, enabled when
3850 @option{-fstrength-reduce} is enabled.
3851
3852 @item -fno-function-cse
3853 @opindex fno-function-cse
3854 Do not put function addresses in registers; make each instruction that
3855 calls a constant function contain the function's address explicitly.
3856
3857 This option results in less efficient code, but some strange hacks
3858 that alter the assembler output may be confused by the optimizations
3859 performed when this option is not used.
3860
3861 The default is @option{-ffunction-cse}
3862
3863 @item -fno-zero-initialized-in-bss
3864 @opindex fno-zero-initialized-in-bss
3865 If the target supports a BSS section, GCC by default puts variables that
3866 are initialized to zero into BSS@.  This can save space in the resulting
3867 code.
3868
3869 This option turns off this behavior because some programs explicitly
3870 rely on variables going to the data section.  E.g., so that the
3871 resulting executable can find the beginning of that section and/or make
3872 assumptions based on that.
3873
3874 The default is @option{-fzero-initialized-in-bss}.
3875
3876 @item -fstrength-reduce
3877 @opindex fstrength-reduce
3878 Perform the optimizations of loop strength reduction and
3879 elimination of iteration variables.
3880
3881 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3882
3883 @item -fthread-jumps
3884 @opindex fthread-jumps
3885 Perform optimizations where we check to see if a jump branches to a
3886 location where another comparison subsumed by the first is found.  If
3887 so, the first branch is redirected to either the destination of the
3888 second branch or a point immediately following it, depending on whether
3889 the condition is known to be true or false.
3890
3891 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3892
3893 @item -fcse-follow-jumps
3894 @opindex fcse-follow-jumps
3895 In common subexpression elimination, scan through jump instructions
3896 when the target of the jump is not reached by any other path.  For
3897 example, when CSE encounters an @code{if} statement with an
3898 @code{else} clause, CSE will follow the jump when the condition
3899 tested is false.
3900
3901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3902
3903 @item -fcse-skip-blocks
3904 @opindex fcse-skip-blocks
3905 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3906 follow jumps which conditionally skip over blocks.  When CSE
3907 encounters a simple @code{if} statement with no else clause,
3908 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3909 body of the @code{if}.
3910
3911 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3912
3913 @item -frerun-cse-after-loop
3914 @opindex frerun-cse-after-loop
3915 Re-run common subexpression elimination after loop optimizations has been
3916 performed.
3917
3918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3919
3920 @item -frerun-loop-opt
3921 @opindex frerun-loop-opt
3922 Run the loop optimizer twice.
3923
3924 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3925
3926 @item -fgcse
3927 @opindex fgcse
3928 Perform a global common subexpression elimination pass.
3929 This pass also performs global constant and copy propagation.
3930
3931 @emph{Note:} When compiling a program using computed gotos, a GCC
3932 extension, you may get better runtime performance if you disable
3933 the global common subexpression elimination pass by adding
3934 @option{-fno-gcse} to the command line.
3935
3936 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3937
3938 @item -fgcse-lm
3939 @opindex fgcse-lm
3940 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3941 attempt to move loads which are only killed by stores into themselves.  This
3942 allows a loop containing a load/store sequence to be changed to a load outside
3943 the loop, and a copy/store within the loop.
3944
3945 Enabled by default when gcse is enabled.
3946
3947 @item -fgcse-sm
3948 @opindex fgcse-sm
3949 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3950 global common subexpression elimination.  This pass will attempt to move
3951 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3952 loops containing a load/store sequence can be changed to a load before
3953 the loop and a store after the loop.
3954
3955 Enabled by default when gcse is enabled.
3956
3957 @item -fgcse-las
3958 @opindex fgcse-las
3959 When @option{-fgcse-las} is enabled, the global common subexpression
3960 elimination pass eliminates redundant loads that come after stores to the
3961 same memory location (both partial and full redundancies).
3962
3963 Enabled by default when gcse is enabled.
3964
3965 @item -floop-optimize
3966 @opindex floop-optimize
3967 Perform loop optimizations: move constant expressions out of loops, simplify
3968 exit test conditions and optionally do strength-reduction and loop unrolling as
3969 well.
3970
3971 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3972
3973 @item -fcrossjumping
3974 @opindex crossjumping
3975 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3976 resulting code may or may not perform better than without cross-jumping.
3977
3978 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3979
3980 @item -fif-conversion
3981 @opindex if-conversion
3982 Attempt to transform conditional jumps into branch-less equivalents.  This
3983 include use of conditional moves, min, max, set flags and abs instructions, and
3984 some tricks doable by standard arithmetics.  The use of conditional execution
3985 on chips where it is available is controlled by @code{if-conversion2}.
3986
3987 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3988
3989 @item -fif-conversion2
3990 @opindex if-conversion2
3991 Use conditional execution (where available) to transform conditional jumps into
3992 branch-less equivalents.
3993
3994 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3995
3996 @item -fdelete-null-pointer-checks
3997 @opindex fdelete-null-pointer-checks
3998 Use global dataflow analysis to identify and eliminate useless checks
3999 for null pointers.  The compiler assumes that dereferencing a null
4000 pointer would have halted the program.  If a pointer is checked after
4001 it has already been dereferenced, it cannot be null.
4002
4003 In some environments, this assumption is not true, and programs can
4004 safely dereference null pointers.  Use
4005 @option{-fno-delete-null-pointer-checks} to disable this optimization
4006 for programs which depend on that behavior.
4007
4008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4009
4010 @item -fexpensive-optimizations
4011 @opindex fexpensive-optimizations
4012 Perform a number of minor optimizations that are relatively expensive.
4013
4014 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015
4016 @item -foptimize-register-move
4017 @itemx -fregmove
4018 @opindex foptimize-register-move
4019 @opindex fregmove
4020 Attempt to reassign register numbers in move instructions and as
4021 operands of other simple instructions in order to maximize the amount of
4022 register tying.  This is especially helpful on machines with two-operand
4023 instructions.
4024
4025 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4026 optimization.
4027
4028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fdelayed-branch
4031 @opindex fdelayed-branch
4032 If supported for the target machine, attempt to reorder instructions
4033 to exploit instruction slots available after delayed branch
4034 instructions.
4035
4036 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4037
4038 @item -fschedule-insns
4039 @opindex fschedule-insns
4040 If supported for the target machine, attempt to reorder instructions to
4041 eliminate execution stalls due to required data being unavailable.  This
4042 helps machines that have slow floating point or memory load instructions
4043 by allowing other instructions to be issued until the result of the load
4044 or floating point instruction is required.
4045
4046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4047
4048 @item -fschedule-insns2
4049 @opindex fschedule-insns2
4050 Similar to @option{-fschedule-insns}, but requests an additional pass of
4051 instruction scheduling after register allocation has been done.  This is
4052 especially useful on machines with a relatively small number of
4053 registers and where memory load instructions take more than one cycle.
4054
4055 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4056
4057 @item -fno-sched-interblock
4058 @opindex fno-sched-interblock
4059 Don't schedule instructions across basic blocks.  This is normally
4060 enabled by default when scheduling before register allocation, i.e.@:
4061 with @option{-fschedule-insns} or at @option{-O2} or higher.
4062
4063 @item -fno-sched-spec
4064 @opindex fno-sched-spec
4065 Don't allow speculative motion of non-load instructions.  This is normally
4066 enabled by default when scheduling before register allocation, i.e.@:
4067 with @option{-fschedule-insns} or at @option{-O2} or higher.
4068
4069 @item -fsched-spec-load
4070 @opindex fsched-spec-load
4071 Allow speculative motion of some load instructions.  This only makes
4072 sense when scheduling before register allocation, i.e.@: with
4073 @option{-fschedule-insns} or at @option{-O2} or higher.
4074
4075 @item -fsched-spec-load-dangerous
4076 @opindex fsched-spec-load-dangerous
4077 Allow speculative motion of more load instructions.  This only makes
4078 sense when scheduling before register allocation, i.e.@: with
4079 @option{-fschedule-insns} or at @option{-O2} or higher.
4080
4081 @item -fsched-stalled-insns=@var{n}
4082 @opindex fsched-stalled-insns
4083 Define how many insns (if any) can be moved prematurely from the queue
4084 of stalled insns into the ready list, during the second scheduling pass.
4085
4086 @item -fsched-stalled-insns-dep=@var{n}
4087 @opindex fsched-stalled-insns-dep
4088 Define how many insn groups (cycles) will be examined for a dependency
4089 on a stalled insn that is candidate for premature removal from the queue
4090 of stalled insns.  Has an effect only during the second scheduling pass,
4091 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4092
4093 @item -fsched2-use-superblocks
4094 @opindex fsched2-use-superblocks
4095 When scheduling after register allocation, do use superblock scheduling
4096 algorithm.  Superblock scheduling allows motion across basic block boundaries
4097 resulting on faster schedules.  This option is experimental, as not all machine
4098 descriptions used by GCC model the CPU closely enough to avoid unreliable
4099 results from the algorithm.
4100
4101 This only makes sense when scheduling after register allocation, i.e.@: with
4102 @option{-fschedule-insns2} or at @option{-O2} or higher.
4103
4104 @item -fsched2-use-traces
4105 @opindex fsched2-use-traces
4106 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4107 allocation and additionally perform code duplication in order to increase the
4108 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4109 trace formation.
4110
4111 This mode should produce faster but significantly longer programs.  Also
4112 without @code{-fbranch-probabilities} the traces constructed may not match the
4113 reality and hurt the performance.  This only makes
4114 sense when scheduling after register allocation, i.e.@: with
4115 @option{-fschedule-insns2} or at @option{-O2} or higher.
4116
4117 @item -fcaller-saves
4118 @opindex fcaller-saves
4119 Enable values to be allocated in registers that will be clobbered by
4120 function calls, by emitting extra instructions to save and restore the
4121 registers around such calls.  Such allocation is done only when it
4122 seems to result in better code than would otherwise be produced.
4123
4124 This option is always enabled by default on certain machines, usually
4125 those which have no call-preserved registers to use instead.
4126
4127 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4128
4129 @item -fmove-all-movables
4130 @opindex fmove-all-movables
4131 Forces all invariant computations in loops to be moved
4132 outside the loop.
4133
4134 @item -freduce-all-givs
4135 @opindex freduce-all-givs
4136 Forces all general-induction variables in loops to be
4137 strength-reduced.
4138
4139 @emph{Note:} When compiling programs written in Fortran,
4140 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4141 by default when you use the optimizer.
4142
4143 These options may generate better or worse code; results are highly
4144 dependent on the structure of loops within the source code.
4145
4146 These two options are intended to be removed someday, once
4147 they have helped determine the efficacy of various
4148 approaches to improving loop optimizations.
4149
4150 Please contact @w{@email{gcc@@gcc.gnu.org}}, and describe how use of
4151 these options affects the performance of your production code.
4152 Examples of code that runs @emph{slower} when these options are
4153 @emph{enabled} are very valuable.
4154
4155 @item -fno-peephole
4156 @itemx -fno-peephole2
4157 @opindex fno-peephole
4158 @opindex fno-peephole2
4159 Disable any machine-specific peephole optimizations.  The difference
4160 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4161 are implemented in the compiler; some targets use one, some use the
4162 other, a few use both.
4163
4164 @option{-fpeephole} is enabled by default.
4165 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4166
4167 @item -fno-guess-branch-probability
4168 @opindex fno-guess-branch-probability
4169 Do not guess branch probabilities using a randomized model.
4170
4171 Sometimes GCC will opt to use a randomized model to guess branch
4172 probabilities, when none are available from either profiling feedback
4173 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4174 different runs of the compiler on the same program may produce different
4175 object code.
4176
4177 In a hard real-time system, people don't want different runs of the
4178 compiler to produce code that has different behavior; minimizing
4179 non-determinism is of paramount import.  This switch allows users to
4180 reduce non-determinism, possibly at the expense of inferior
4181 optimization.
4182
4183 The default is @option{-fguess-branch-probability} at levels
4184 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4185
4186 @item -freorder-blocks
4187 @opindex freorder-blocks
4188 Reorder basic blocks in the compiled function in order to reduce number of
4189 taken branches and improve code locality.
4190
4191 Enabled at levels @option{-O2}, @option{-O3}.
4192
4193 @item -freorder-functions
4194 @opindex freorder-functions
4195 Reorder basic blocks in the compiled function in order to reduce number of
4196 taken branches and improve code locality. This is implemented by using special
4197 subsections @code{.text.hot} for most frequently executed functions and
4198 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4199 the linker so object file format must support named sections and linker must
4200 place them in a reasonable way.
4201
4202 Also profile feedback must be available in to make this option effective.  See
4203 @option{-fprofile-arcs} for details.
4204
4205 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4206
4207 @item -fstrict-aliasing
4208 @opindex fstrict-aliasing
4209 Allows the compiler to assume the strictest aliasing rules applicable to
4210 the language being compiled.  For C (and C++), this activates
4211 optimizations based on the type of expressions.  In particular, an
4212 object of one type is assumed never to reside at the same address as an
4213 object of a different type, unless the types are almost the same.  For
4214 example, an @code{unsigned int} can alias an @code{int}, but not a
4215 @code{void*} or a @code{double}.  A character type may alias any other
4216 type.
4217
4218 Pay special attention to code like this:
4219 @smallexample
4220 union a_union @{
4221   int i;
4222   double d;
4223 @};
4224
4225 int f() @{
4226   a_union t;
4227   t.d = 3.0;
4228   return t.i;
4229 @}
4230 @end smallexample
4231 The practice of reading from a different union member than the one most
4232 recently written to (called ``type-punning'') is common.  Even with
4233 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4234 is accessed through the union type.  So, the code above will work as
4235 expected.  However, this code might not:
4236 @smallexample
4237 int f() @{
4238   a_union t;
4239   int* ip;
4240   t.d = 3.0;
4241   ip = &t.i;
4242   return *ip;
4243 @}
4244 @end smallexample
4245
4246 Every language that wishes to perform language-specific alias analysis
4247 should define a function that computes, given an @code{tree}
4248 node, an alias set for the node.  Nodes in different alias sets are not
4249 allowed to alias.  For an example, see the C front-end function
4250 @code{c_get_alias_set}.
4251
4252 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4253
4254 @item -falign-functions
4255 @itemx -falign-functions=@var{n}
4256 @opindex falign-functions
4257 Align the start of functions to the next power-of-two greater than
4258 @var{n}, skipping up to @var{n} bytes.  For instance,
4259 @option{-falign-functions=32} aligns functions to the next 32-byte
4260 boundary, but @option{-falign-functions=24} would align to the next
4261 32-byte boundary only if this can be done by skipping 23 bytes or less.
4262
4263 @option{-fno-align-functions} and @option{-falign-functions=1} are
4264 equivalent and mean that functions will not be aligned.
4265
4266 Some assemblers only support this flag when @var{n} is a power of two;
4267 in that case, it is rounded up.
4268
4269 If @var{n} is not specified or is zero, use a machine-dependent default.
4270
4271 Enabled at levels @option{-O2}, @option{-O3}.
4272
4273 @item -falign-labels
4274 @itemx -falign-labels=@var{n}
4275 @opindex falign-labels
4276 Align all branch targets to a power-of-two boundary, skipping up to
4277 @var{n} bytes like @option{-falign-functions}.  This option can easily
4278 make code slower, because it must insert dummy operations for when the
4279 branch target is reached in the usual flow of the code.
4280
4281 @option{-fno-align-labels} and @option{-falign-labels=1} are
4282 equivalent and mean that labels will not be aligned.
4283
4284 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4285 are greater than this value, then their values are used instead.
4286
4287 If @var{n} is not specified or is zero, use a machine-dependent default
4288 which is very likely to be @samp{1}, meaning no alignment.
4289
4290 Enabled at levels @option{-O2}, @option{-O3}.
4291
4292 @item -falign-loops
4293 @itemx -falign-loops=@var{n}
4294 @opindex falign-loops
4295 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4296 like @option{-falign-functions}.  The hope is that the loop will be
4297 executed many times, which will make up for any execution of the dummy
4298 operations.
4299
4300 @option{-fno-align-loops} and @option{-falign-loops=1} are
4301 equivalent and mean that loops will not be aligned.
4302
4303 If @var{n} is not specified or is zero, use a machine-dependent default.
4304
4305 Enabled at levels @option{-O2}, @option{-O3}.
4306
4307 @item -falign-jumps
4308 @itemx -falign-jumps=@var{n}
4309 @opindex falign-jumps
4310 Align branch targets to a power-of-two boundary, for branch targets
4311 where the targets can only be reached by jumping, skipping up to @var{n}
4312 bytes like @option{-falign-functions}.  In this case, no dummy operations
4313 need be executed.
4314
4315 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4316 equivalent and mean that loops will not be aligned.
4317
4318 If @var{n} is not specified or is zero, use a machine-dependent default.
4319
4320 Enabled at levels @option{-O2}, @option{-O3}.
4321
4322 @item -frename-registers
4323 @opindex frename-registers
4324 Attempt to avoid false dependencies in scheduled code by making use
4325 of registers left over after register allocation.  This optimization
4326 will most benefit processors with lots of registers.  It can, however,
4327 make debugging impossible, since variables will no longer stay in
4328 a ``home register''.
4329
4330 @item -fweb
4331 @opindex fweb
4332 Constructs webs as commonly used for register allocation purposes and assign
4333 each web individual pseudo register.  This allows the register allocation pass
4334 to operate on pseudos directly, but also strengthens several other optimization
4335 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4336 however, make debugging impossible, since variables will no longer stay in a
4337 ``home register''.
4338
4339 Enabled at levels @option{-O3}.
4340
4341 @item -fno-cprop-registers
4342 @opindex fno-cprop-registers
4343 After register allocation and post-register allocation instruction splitting,
4344 we perform a copy-propagation pass to try to reduce scheduling dependencies
4345 and occasionally eliminate the copy.
4346
4347 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4348
4349 @item -fprofile-generate
4350 @opindex fprofile-generate
4351
4352 Enable options usually used for instrumenting application to produce
4353 profile useful for later recompilation with profile feedback based
4354 optimization.  You must use @code{-fprofile-generate} both when
4355 compiling and when linking your program.
4356
4357 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4358
4359 @item -fprofile-use
4360 @opindex fprofile-use
4361 Enable profile feedback directed optimizations, and optimizations
4362 generally profitable only with profile feedback available.
4363
4364 The following options are enabled: @code{-fbranch-probabilities},
4365 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4366
4367 @end table
4368
4369 The following options control compiler behavior regarding floating
4370 point arithmetic.  These options trade off between speed and
4371 correctness.  All must be specifically enabled.
4372
4373 @table @gcctabopt
4374 @item -ffloat-store
4375 @opindex ffloat-store
4376 Do not store floating point variables in registers, and inhibit other
4377 options that might change whether a floating point value is taken from a
4378 register or memory.
4379
4380 @cindex floating point precision
4381 This option prevents undesirable excess precision on machines such as
4382 the 68000 where the floating registers (of the 68881) keep more
4383 precision than a @code{double} is supposed to have.  Similarly for the
4384 x86 architecture.  For most programs, the excess precision does only
4385 good, but a few programs rely on the precise definition of IEEE floating
4386 point.  Use @option{-ffloat-store} for such programs, after modifying
4387 them to store all pertinent intermediate computations into variables.
4388
4389 @item -ffast-math
4390 @opindex ffast-math
4391 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4392 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4393 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4394
4395 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4396
4397 This option should never be turned on by any @option{-O} option since
4398 it can result in incorrect output for programs which depend on
4399 an exact implementation of IEEE or ISO rules/specifications for
4400 math functions.
4401
4402 @item -fno-math-errno
4403 @opindex fno-math-errno
4404 Do not set ERRNO after calling math functions that are executed
4405 with a single instruction, e.g., sqrt.  A program that relies on
4406 IEEE exceptions for math error handling may want to use this flag
4407 for speed while maintaining IEEE arithmetic compatibility.
4408
4409 This option should never be turned on by any @option{-O} option since
4410 it can result in incorrect output for programs which depend on
4411 an exact implementation of IEEE or ISO rules/specifications for
4412 math functions.
4413
4414 The default is @option{-fmath-errno}.
4415
4416 @item -funsafe-math-optimizations
4417 @opindex funsafe-math-optimizations
4418 Allow optimizations for floating-point arithmetic that (a) assume
4419 that arguments and results are valid and (b) may violate IEEE or
4420 ANSI standards.  When used at link-time, it may include libraries
4421 or startup files that change the default FPU control word or other
4422 similar optimizations.
4423
4424 This option should never be turned on by any @option{-O} option since
4425 it can result in incorrect output for programs which depend on
4426 an exact implementation of IEEE or ISO rules/specifications for
4427 math functions.
4428
4429 The default is @option{-fno-unsafe-math-optimizations}.
4430
4431 @item -ffinite-math-only
4432 @opindex ffinite-math-only
4433 Allow optimizations for floating-point arithmetic that assume
4434 that arguments and results are not NaNs or +-Infs.
4435
4436 This option should never be turned on by any @option{-O} option since
4437 it can result in incorrect output for programs which depend on
4438 an exact implementation of IEEE or ISO rules/specifications.
4439
4440 The default is @option{-fno-finite-math-only}.
4441
4442 @item -fno-trapping-math
4443 @opindex fno-trapping-math
4444 Compile code assuming that floating-point operations cannot generate
4445 user-visible traps.  These traps include division by zero, overflow,
4446 underflow, inexact result and invalid operation.  This option implies
4447 @option{-fno-signaling-nans}.  Setting this option may allow faster
4448 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4449
4450 This option should never be turned on by any @option{-O} option since
4451 it can result in incorrect output for programs which depend on
4452 an exact implementation of IEEE or ISO rules/specifications for
4453 math functions.
4454
4455 The default is @option{-ftrapping-math}.
4456
4457 @item -frounding-math
4458 @opindex frounding-math
4459 Disable transformations and optimizations that assume default floating
4460 point rounding behavior.  This is round-to-zero for all floating point
4461 to integer conversions, and round-to-nearest for all other arithmetic
4462 truncations.  This option should be specified for programs that change
4463 the FP rounding mode dynamically, or that may be executed with a
4464 non-default rounding mode.  This option disables constant folding of
4465 floating point expressions at compile-time (which may be affected by
4466 rounding mode) and arithmetic transformations that are unsafe in the
4467 presence of sign-dependent rounding modes.
4468
4469 The default is @option{-fno-rounding-math}.
4470
4471 This option is experimental and does not currently guarantee to
4472 disable all GCC optimizations that are affected by rounding mode.
4473 Future versions of GCC may provide finer control of this setting
4474 using C99's @code{FENV_ACCESS} pragma.  This command line option
4475 will be used to specify the default state for @code{FENV_ACCESS}.
4476
4477 @item -fsignaling-nans
4478 @opindex fsignaling-nans
4479 Compile code assuming that IEEE signaling NaNs may generate user-visible
4480 traps during floating-point operations.  Setting this option disables
4481 optimizations that may change the number of exceptions visible with
4482 signaling NaNs.  This option implies @option{-ftrapping-math}.
4483
4484 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4485 be defined.
4486
4487 The default is @option{-fno-signaling-nans}.
4488
4489 This option is experimental and does not currently guarantee to
4490 disable all GCC optimizations that affect signaling NaN behavior.
4491
4492 @item -fsingle-precision-constant
4493 @opindex fsingle-precision-constant
4494 Treat floating point constant as single precision constant instead of
4495 implicitly converting it to double precision constant.
4496
4497
4498 @end table
4499
4500 The following options control optimizations that may improve
4501 performance, but are not enabled by any @option{-O} options.  This
4502 section includes experimental options that may produce broken code.
4503
4504 @table @gcctabopt
4505 @item -fbranch-probabilities
4506 @opindex fbranch-probabilities
4507 After running a program compiled with @option{-fprofile-arcs}
4508 (@pxref{Debugging Options,, Options for Debugging Your Program or
4509 @command{gcc}}), you can compile it a second time using
4510 @option{-fbranch-probabilities}, to improve optimizations based on
4511 the number of times each branch was taken.  When the program
4512 compiled with @option{-fprofile-arcs} exits it saves arc execution
4513 counts to a file called @file{@var{sourcename}.gcda} for each source
4514 file  The information in this data file is very dependent on the
4515 structure of the generated code, so you must use the same source code
4516 and the same optimization options for both compilations.
4517
4518 With @option{-fbranch-probabilities}, GCC puts a
4519 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4520 These can be used to improve optimization.  Currently, they are only
4521 used in one place: in @file{reorg.c}, instead of guessing which path a
4522 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4523 exactly determine which path is taken more often.
4524
4525 @item -fprofile-values
4526 @opindex fprofile-values
4527 If combined with @option{-fprofile-arcs}, it adds code so that some
4528 data about values of expressions in the program is gathered.
4529
4530 With @option{-fbranch-probabilities}, it reads back the data gathered
4531 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4532 notes to instructions for their later usage in optimizations.
4533
4534 @item -fvpt
4535 @opindex fvpt
4536 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4537 a code to gather information about values of expressions.
4538
4539 With @option{-fbranch-probabilities}, it reads back the data gathered
4540 and actually performs the optimizations based on them.
4541 Currently the optimizations include specialization of division operation
4542 using the knowledge about the value of the denominator.
4543
4544 @item -fnew-ra
4545 @opindex fnew-ra
4546 Use a graph coloring register allocator.  Currently this option is meant
4547 for testing, so we are interested to hear about miscompilations with
4548 @option{-fnew-ra}.
4549
4550 @item -ftracer
4551 @opindex ftracer
4552 Perform tail duplication to enlarge superblock size. This transformation
4553 simplifies the control flow of the function allowing other optimizations to do
4554 better job.
4555
4556 @item -funit-at-a-time
4557 @opindex funit-at-a-time
4558 Parse the whole compilation unit before starting to produce code.
4559 This allows some extra optimizations to take place but consumes more
4560 memory.
4561
4562 @item -funroll-loops
4563 @opindex funroll-loops
4564 Unroll loops whose number of iterations can be determined at compile time or
4565 upon entry to the loop.  @option{-funroll-loops} implies
4566 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4567 (i.e. complete removal of loops with small constant number of iterations).
4568 This option makes code larger, and may or may not make it run faster.
4569
4570 @item -funroll-all-loops
4571 @opindex funroll-all-loops
4572 Unroll all loops, even if their number of iterations is uncertain when
4573 the loop is entered.  This usually makes programs run more slowly.
4574 @option{-funroll-all-loops} implies the same options as
4575 @option{-funroll-loops}.
4576
4577 @item -fpeel-loops
4578 @opindex fpeel-loops
4579 Peels the loops for that there is enough information that they do not
4580 roll much (from profile feedback).  It also turns on complete loop peeling
4581 (i.e. complete removal of loops with small constant number of iterations).
4582
4583 @item -funswitch-loops
4584 @opindex funswitch-loops
4585 Move branches with loop invariant conditions out of the loop, with duplicates
4586 of the loop on both branches (modified according to result of the condition).
4587
4588 @item -fold-unroll-loops
4589 @opindex fold-unroll-loops
4590 Unroll loops whose number of iterations can be determined at compile
4591 time or upon entry to the loop, using the old loop unroller whose loop
4592 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4593 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4594 option makes code larger, and may or may not make it run faster.
4595
4596 @item -fold-unroll-all-loops
4597 @opindex fold-unroll-all-loops
4598 Unroll all loops, even if their number of iterations is uncertain when
4599 the loop is entered. This is done using the old loop unroller whose loop
4600 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4601 @option{-fold-unroll-all-loops} implies the same options as
4602 @option{-fold-unroll-loops}.
4603
4604 @item -funswitch-loops
4605 @opindex funswitch-loops
4606 Move branches with loop invariant conditions out of the loop, with duplicates
4607 of the loop on both branches (modified according to result of the condition).
4608
4609 @item -funswitch-loops
4610 @opindex funswitch-loops
4611 Move branches with loop invariant conditions out of the loop, with duplicates
4612 of the loop on both branches (modified according to result of the condition).
4613
4614 @item -fprefetch-loop-arrays
4615 @opindex fprefetch-loop-arrays
4616 If supported by the target machine, generate instructions to prefetch
4617 memory to improve the performance of loops that access large arrays.
4618
4619 Disabled at level @option{-Os}.
4620
4621 @item -ffunction-sections
4622 @itemx -fdata-sections
4623 @opindex ffunction-sections
4624 @opindex fdata-sections
4625 Place each function or data item into its own section in the output
4626 file if the target supports arbitrary sections.  The name of the
4627 function or the name of the data item determines the section's name
4628 in the output file.
4629
4630 Use these options on systems where the linker can perform optimizations
4631 to improve locality of reference in the instruction space.  Most systems
4632 using the ELF object format and SPARC processors running Solaris 2 have
4633 linkers with such optimizations.  AIX may have these optimizations in
4634 the future.
4635
4636 Only use these options when there are significant benefits from doing
4637 so.  When you specify these options, the assembler and linker will
4638 create larger object and executable files and will also be slower.
4639 You will not be able to use @code{gprof} on all systems if you
4640 specify this option and you may have problems with debugging if
4641 you specify both this option and @option{-g}.
4642
4643 @item -fbranch-target-load-optimize
4644 @opindex fbranch-target-load-optimize
4645 Perform branch target register load optimization before prologue / epilogue
4646 threading.
4647 The use of target registers can typically be exposed only during reload,
4648 thus hoisting loads out of loops and doing inter-block scheduling needs
4649 a separate optimization pass.
4650
4651 @item -fbranch-target-load-optimize2
4652 @opindex fbranch-target-load-optimize2
4653 Perform branch target register load optimization after prologue / epilogue
4654 threading.
4655
4656 @item --param @var{name}=@var{value}
4657 @opindex param
4658 In some places, GCC uses various constants to control the amount of
4659 optimization that is done.  For example, GCC will not inline functions
4660 that contain more that a certain number of instructions.  You can
4661 control some of these constants on the command-line using the
4662 @option{--param} option.
4663
4664 The names of specific parameters, and the meaning of the values, are
4665 tied to the internals of the compiler, and are subject to change
4666 without notice in future releases.
4667
4668 In each case, the @var{value} is an integer.  The allowable choices for
4669 @var{name} are given in the following table:
4670
4671 @table @gcctabopt
4672 @item max-crossjump-edges
4673 The maximum number of incoming edges to consider for crossjumping.
4674 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4675 the number of edges incoming to each block.  Increasing values mean
4676 more aggressive optimization, making the compile time increase with
4677 probably small improvement in executable size.
4678
4679 @item max-delay-slot-insn-search
4680 The maximum number of instructions to consider when looking for an
4681 instruction to fill a delay slot.  If more than this arbitrary number of
4682 instructions is searched, the time savings from filling the delay slot
4683 will be minimal so stop searching.  Increasing values mean more
4684 aggressive optimization, making the compile time increase with probably
4685 small improvement in executable run time.
4686
4687 @item max-delay-slot-live-search
4688 When trying to fill delay slots, the maximum number of instructions to
4689 consider when searching for a block with valid live register
4690 information.  Increasing this arbitrarily chosen value means more
4691 aggressive optimization, increasing the compile time.  This parameter
4692 should be removed when the delay slot code is rewritten to maintain the
4693 control-flow graph.
4694
4695 @item max-gcse-memory
4696 The approximate maximum amount of memory that will be allocated in
4697 order to perform the global common subexpression elimination
4698 optimization.  If more memory than specified is required, the
4699 optimization will not be done.
4700
4701 @item max-gcse-passes
4702 The maximum number of passes of GCSE to run.
4703
4704 @item max-pending-list-length
4705 The maximum number of pending dependencies scheduling will allow
4706 before flushing the current state and starting over.  Large functions
4707 with few branches or calls can create excessively large lists which
4708 needlessly consume memory and resources.
4709
4710 @item max-inline-insns-single
4711 Several parameters control the tree inliner used in gcc.
4712 This number sets the maximum number of instructions (counted in GCC's
4713 internal representation) in a single function that the tree inliner
4714 will consider for inlining.  This only affects functions declared
4715 inline and methods implemented in a class declaration (C++).
4716 The default value is 500.
4717
4718 @item max-inline-insns-auto
4719 When you use @option{-finline-functions} (included in @option{-O3}),
4720 a lot of functions that would otherwise not be considered for inlining
4721 by the compiler will be investigated.  To those functions, a different
4722 (more restrictive) limit compared to functions declared inline can
4723 be applied.
4724 The default value is 100.
4725
4726 @item large-function-insns
4727 The limit specifying really large functions.  For functions greater than this
4728 limit inlining is constrained by @option{--param large-function-growth}.
4729 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4730 algorithms used by the backend.
4731 This parameter is ignored when @option{-funit-at-a-time} is not used.
4732 The default value is 3000.
4733
4734 @item large-function-growth
4735 Specifies maximal growth of large function caused by inlining in percents.
4736 This parameter is ignored when @option{-funit-at-a-time} is not used.
4737 The default value is 200.
4738
4739 @item inline-unit-growth
4740 Specifies maximal overall growth of the compilation unit caused by inlining.
4741 This parameter is ignored when @option{-funit-at-a-time} is not used.
4742 The default value is 150.
4743
4744 @item max-inline-insns-rtl
4745 For languages that use the RTL inliner (this happens at a later stage
4746 than tree inlining), you can set the maximum allowable size (counted
4747 in RTL instructions) for the RTL inliner with this parameter.
4748 The default value is 600.
4749
4750 @item max-unrolled-insns
4751 The maximum number of instructions that a loop should have if that loop
4752 is unrolled, and if the loop is unrolled, it determines how many times
4753 the loop code is unrolled.
4754
4755 @item max-average-unrolled-insns
4756 The maximum number of instructions biased by probabilities of their execution
4757 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4758 it determines how many times the loop code is unrolled.
4759
4760 @item max-unroll-times
4761 The maximum number of unrollings of a single loop.
4762
4763 @item max-peeled-insns
4764 The maximum number of instructions that a loop should have if that loop
4765 is peeled, and if the loop is peeled, it determines how many times
4766 the loop code is peeled.
4767
4768 @item max-peel-times
4769 The maximum number of peelings of a single loop.
4770
4771 @item max-completely-peeled-insns
4772 The maximum number of insns of a completely peeled loop.
4773
4774 @item max-completely-peel-times
4775 The maximum number of iterations of a loop to be suitable for complete peeling.
4776
4777 @item max-unswitch-insns
4778 The maximum number of insns of an unswitched loop.
4779
4780 @item max-unswitch-level
4781 The maximum number of branches unswitched in a single loop.
4782
4783 @item hot-bb-count-fraction
4784 Select fraction of the maximal count of repetitions of basic block in program
4785 given basic block needs to have to be considered hot.
4786
4787 @item hot-bb-frequency-fraction
4788 Select fraction of the maximal frequency of executions of basic block in
4789 function given basic block needs to have to be considered hot
4790
4791 @item tracer-dynamic-coverage
4792 @itemx tracer-dynamic-coverage-feedback
4793
4794 This value is used to limit superblock formation once the given percentage of
4795 executed instructions is covered.  This limits unnecessary code size
4796 expansion.
4797
4798 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4799 feedback is available.  The real profiles (as opposed to statically estimated
4800 ones) are much less balanced allowing the threshold to be larger value.
4801
4802 @item tracer-max-code-growth
4803 Stop tail duplication once code growth has reached given percentage.  This is
4804 rather hokey argument, as most of the duplicates will be eliminated later in
4805 cross jumping, so it may be set to much higher values than is the desired code
4806 growth.
4807
4808 @item tracer-min-branch-ratio
4809
4810 Stop reverse growth when the reverse probability of best edge is less than this
4811 threshold (in percent).
4812
4813 @item tracer-min-branch-ratio
4814 @itemx tracer-min-branch-ratio-feedback
4815
4816 Stop forward growth if the best edge do have probability lower than this
4817 threshold.
4818
4819 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4820 compilation for profile feedback and one for compilation without.  The value
4821 for compilation with profile feedback needs to be more conservative (higher) in
4822 order to make tracer effective.
4823
4824 @item max-cse-path-length
4825
4826 Maximum number of basic blocks on path that cse considers.
4827
4828 @item max-last-value-rtl
4829
4830 The maximum size measured as number of RTLs that can be recorded in an
4831 expression in combiner for a pseudo register as last known value of that
4832 register.  The default is 10000.
4833
4834 @item ggc-min-expand
4835
4836 GCC uses a garbage collector to manage its own memory allocation.  This
4837 parameter specifies the minimum percentage by which the garbage
4838 collector's heap should be allowed to expand between collections.
4839 Tuning this may improve compilation speed; it has no effect on code
4840 generation.
4841
4842 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4843 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4844 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4845 GCC is not able to calculate RAM on a particular platform, the lower
4846 bound of 30% is used.  Setting this parameter and
4847 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4848 every opportunity.  This is extremely slow, but can be useful for
4849 debugging.
4850
4851 @item ggc-min-heapsize
4852
4853 Minimum size of the garbage collector's heap before it begins bothering
4854 to collect garbage.  The first collection occurs after the heap expands
4855 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4856 tuning this may improve compilation speed, and has no effect on code
4857 generation.
4858
4859 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4860 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4861 available, the notion of "RAM" is the smallest of actual RAM,
4862 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4863 RAM on a particular platform, the lower bound is used.  Setting this
4864 parameter very large effectively disables garbage collection.  Setting
4865 this parameter and @option{ggc-min-expand} to zero causes a full
4866 collection to occur at every opportunity.
4867
4868 @item max-reload-search-insns
4869 The maximum number of instruction reload should look backward for equivalent
4870 register.  Increasing values mean more aggressive optimization, making the
4871 compile time increase with probably slightly better performance.  The default
4872 value is 100.
4873
4874 @item max-cselib-memory-location
4875 The maximum number of memory locations cselib should take into acount.
4876 Increasing values mean more aggressive optimization, making the compile time
4877 increase with probably slightly better performance.  The default value is 500.
4878
4879 @item reorder-blocks-duplicate
4880 @itemx reorder-blocks-duplicate-feedback
4881
4882 Used by basic block reordering pass to decide whether to use unconditional
4883 branch or duplicate the code on its destination.  Code is duplicated when its
4884 estimated size is smaller than this value multiplied by the estimated size of
4885 unconditional jump in the hot spots of the program.
4886
4887 The @option{reorder-block-duplicate-feedback} is used only when profile
4888 feedback is available and may be set to higher values than
4889 @option{reorder-block-duplicate} since information about the hot spots is more
4890 accurate.
4891 @end table
4892 @end table
4893
4894 @node Preprocessor Options
4895 @section Options Controlling the Preprocessor
4896 @cindex preprocessor options
4897 @cindex options, preprocessor
4898
4899 These options control the C preprocessor, which is run on each C source
4900 file before actual compilation.
4901
4902 If you use the @option{-E} option, nothing is done except preprocessing.
4903 Some of these options make sense only together with @option{-E} because
4904 they cause the preprocessor output to be unsuitable for actual
4905 compilation.
4906
4907 @table @gcctabopt
4908 @opindex Wp
4909 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4910 and pass @var{option} directly through to the preprocessor.  If
4911 @var{option} contains commas, it is split into multiple options at the
4912 commas.  However, many options are modified, translated or interpreted
4913 by the compiler driver before being passed to the preprocessor, and
4914 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4915 interface is undocumented and subject to change, so whenever possible
4916 you should avoid using @option{-Wp} and let the driver handle the
4917 options instead.
4918
4919 @item -Xpreprocessor @var{option}
4920 @opindex preprocessor
4921 Pass @var{option} as an option to the preprocessor.  You can use this to
4922 supply system-specific preprocessor options which GCC does not know how to
4923 recognize.
4924
4925 If you want to pass an option that takes an argument, you must use
4926 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4927 @end table
4928
4929 @include cppopts.texi
4930
4931 @node Assembler Options
4932 @section Passing Options to the Assembler
4933
4934 @c prevent bad page break with this line
4935 You can pass options to the assembler.
4936
4937 @table @gcctabopt
4938 @item -Wa,@var{option}
4939 @opindex Wa
4940 Pass @var{option} as an option to the assembler.  If @var{option}
4941 contains commas, it is split into multiple options at the commas.
4942
4943 @item -Xassembler @var{option}
4944 @opindex Xassembler
4945 Pass @var{option} as an option to the assembler.  You can use this to
4946 supply system-specific assembler options which GCC does not know how to
4947 recognize.
4948
4949 If you want to pass an option that takes an argument, you must use
4950 @option{-Xassembler} twice, once for the option and once for the argument.
4951
4952 @end table
4953
4954 @node Link Options
4955 @section Options for Linking
4956 @cindex link options
4957 @cindex options, linking
4958
4959 These options come into play when the compiler links object files into
4960 an executable output file.  They are meaningless if the compiler is
4961 not doing a link step.
4962
4963 @table @gcctabopt
4964 @cindex file names
4965 @item @var{object-file-name}
4966 A file name that does not end in a special recognized suffix is
4967 considered to name an object file or library.  (Object files are
4968 distinguished from libraries by the linker according to the file
4969 contents.)  If linking is done, these object files are used as input
4970 to the linker.
4971
4972 @item -c
4973 @itemx -S
4974 @itemx -E
4975 @opindex c
4976 @opindex S
4977 @opindex E
4978 If any of these options is used, then the linker is not run, and
4979 object file names should not be used as arguments.  @xref{Overall
4980 Options}.
4981
4982 @cindex Libraries
4983 @item -l@var{library}
4984 @itemx -l @var{library}
4985 @opindex l
4986 Search the library named @var{library} when linking.  (The second
4987 alternative with the library as a separate argument is only for
4988 POSIX compliance and is not recommended.)
4989
4990 It makes a difference where in the command you write this option; the
4991 linker searches and processes libraries and object files in the order they
4992 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4993 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4994 to functions in @samp{z}, those functions may not be loaded.
4995
4996 The linker searches a standard list of directories for the library,
4997 which is actually a file named @file{lib@var{library}.a}.  The linker
4998 then uses this file as if it had been specified precisely by name.
4999
5000 The directories searched include several standard system directories
5001 plus any that you specify with @option{-L}.
5002
5003 Normally the files found this way are library files---archive files
5004 whose members are object files.  The linker handles an archive file by
5005 scanning through it for members which define symbols that have so far
5006 been referenced but not defined.  But if the file that is found is an
5007 ordinary object file, it is linked in the usual fashion.  The only
5008 difference between using an @option{-l} option and specifying a file name
5009 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5010 and searches several directories.
5011
5012 @item -lobjc
5013 @opindex lobjc
5014 You need this special case of the @option{-l} option in order to
5015 link an Objective-C program.
5016
5017 @item -nostartfiles
5018 @opindex nostartfiles
5019 Do not use the standard system startup files when linking.
5020 The standard system libraries are used normally, unless @option{-nostdlib}
5021 or @option{-nodefaultlibs} is used.
5022
5023 @item -nodefaultlibs
5024 @opindex nodefaultlibs
5025 Do not use the standard system libraries when linking.
5026 Only the libraries you specify will be passed to the linker.
5027 The standard startup files are used normally, unless @option{-nostartfiles}
5028 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5029 for System V (and ISO C) environments or to bcopy and bzero for
5030 BSD environments.  These entries are usually resolved by entries in
5031 libc.  These entry points should be supplied through some other
5032 mechanism when this option is specified.
5033
5034 @item -nostdlib
5035 @opindex nostdlib
5036 Do not use the standard system startup files or libraries when linking.
5037 No startup files and only the libraries you specify will be passed to
5038 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5039 for System V (and ISO C) environments or to bcopy and bzero for
5040 BSD environments.  These entries are usually resolved by entries in
5041 libc.  These entry points should be supplied through some other
5042 mechanism when this option is specified.
5043
5044 @cindex @option{-lgcc}, use with @option{-nostdlib}
5045 @cindex @option{-nostdlib} and unresolved references
5046 @cindex unresolved references and @option{-nostdlib}
5047 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5048 @cindex @option{-nodefaultlibs} and unresolved references
5049 @cindex unresolved references and @option{-nodefaultlibs}
5050 One of the standard libraries bypassed by @option{-nostdlib} and
5051 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5052 that GCC uses to overcome shortcomings of particular machines, or special
5053 needs for some languages.
5054 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5055 Collection (GCC) Internals},
5056 for more discussion of @file{libgcc.a}.)
5057 In most cases, you need @file{libgcc.a} even when you want to avoid
5058 other standard libraries.  In other words, when you specify @option{-nostdlib}
5059 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5060 This ensures that you have no unresolved references to internal GCC
5061 library subroutines.  (For example, @samp{__main}, used to ensure C++
5062 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5063 GNU Compiler Collection (GCC) Internals}.)
5064
5065 @item -pie
5066 @opindex pie
5067 Produce a position independent executable on targets which support it.
5068 For predictable results, you must also specify the same set of options
5069 that were used to generate code (@option{-fpie}, @option{-fPIE},
5070 or model suboptions) when you specify this option.
5071
5072 @item -s
5073 @opindex s
5074 Remove all symbol table and relocation information from the executable.
5075
5076 @item -static
5077 @opindex static
5078 On systems that support dynamic linking, this prevents linking with the shared
5079 libraries.  On other systems, this option has no effect.
5080
5081 @item -shared
5082 @opindex shared
5083 Produce a shared object which can then be linked with other objects to
5084 form an executable.  Not all systems support this option.  For predictable
5085 results, you must also specify the same set of options that were used to
5086 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5087 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5088 needs to build supplementary stub code for constructors to work.  On
5089 multi-libbed systems, @samp{gcc -shared} must select the correct support
5090 libraries to link against.  Failing to supply the correct flags may lead
5091 to subtle defects.  Supplying them in cases where they are not necessary
5092 is innocuous.}
5093
5094 @item -shared-libgcc
5095 @itemx -static-libgcc
5096 @opindex shared-libgcc
5097 @opindex static-libgcc
5098 On systems that provide @file{libgcc} as a shared library, these options
5099 force the use of either the shared or static version respectively.
5100 If no shared version of @file{libgcc} was built when the compiler was
5101 configured, these options have no effect.
5102
5103 There are several situations in which an application should use the
5104 shared @file{libgcc} instead of the static version.  The most common
5105 of these is when the application wishes to throw and catch exceptions
5106 across different shared libraries.  In that case, each of the libraries
5107 as well as the application itself should use the shared @file{libgcc}.
5108
5109 Therefore, the G++ and GCJ drivers automatically add
5110 @option{-shared-libgcc} whenever you build a shared library or a main
5111 executable, because C++ and Java programs typically use exceptions, so
5112 this is the right thing to do.
5113
5114 If, instead, you use the GCC driver to create shared libraries, you may
5115 find that they will not always be linked with the shared @file{libgcc}.
5116 If GCC finds, at its configuration time, that you have a non-GNU linker
5117 or a GNU linker that does not support option @option{--eh-frame-hdr},
5118 it will link the shared version of @file{libgcc} into shared libraries
5119 by default.  Otherwise, it will take advantage of the linker and optimize
5120 away the linking with the shared version of @file{libgcc}, linking with
5121 the static version of libgcc by default.  This allows exceptions to
5122 propagate through such shared libraries, without incurring relocation
5123 costs at library load time.
5124
5125 However, if a library or main executable is supposed to throw or catch
5126 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5127 for the languages used in the program, or using the option
5128 @option{-shared-libgcc}, such that it is linked with the shared
5129 @file{libgcc}.
5130
5131 @item -symbolic
5132 @opindex symbolic
5133 Bind references to global symbols when building a shared object.  Warn
5134 about any unresolved references (unless overridden by the link editor
5135 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5136 this option.
5137
5138 @item -Xlinker @var{option}
5139 @opindex Xlinker
5140 Pass @var{option} as an option to the linker.  You can use this to
5141 supply system-specific linker options which GCC does not know how to
5142 recognize.
5143
5144 If you want to pass an option that takes an argument, you must use
5145 @option{-Xlinker} twice, once for the option and once for the argument.
5146 For example, to pass @option{-assert definitions}, you must write
5147 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5148 @option{-Xlinker "-assert definitions"}, because this passes the entire
5149 string as a single argument, which is not what the linker expects.
5150
5151 @item -Wl,@var{option}
5152 @opindex Wl
5153 Pass @var{option} as an option to the linker.  If @var{option} contains
5154 commas, it is split into multiple options at the commas.
5155
5156 @item -u @var{symbol}
5157 @opindex u
5158 Pretend the symbol @var{symbol} is undefined, to force linking of
5159 library modules to define it.  You can use @option{-u} multiple times with
5160 different symbols to force loading of additional library modules.
5161 @end table
5162
5163 @node Directory Options
5164 @section Options for Directory Search
5165 @cindex directory options
5166 @cindex options, directory search
5167 @cindex search path
5168
5169 These options specify directories to search for header files, for
5170 libraries and for parts of the compiler:
5171
5172 @table @gcctabopt
5173 @item -I@var{dir}
5174 @opindex I
5175 Add the directory @var{dir} to the head of the list of directories to be
5176 searched for header files.  This can be used to override a system header
5177 file, substituting your own version, since these directories are
5178 searched before the system header file directories.  However, you should
5179 not use this option to add directories that contain vendor-supplied
5180 system header files (use @option{-isystem} for that).  If you use more than
5181 one @option{-I} option, the directories are scanned in left-to-right
5182 order; the standard system directories come after.
5183
5184 If a standard system include directory, or a directory specified with
5185 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5186 option will be ignored.  The directory will still be searched but as a
5187 system directory at its normal position in the system include chain.
5188 This is to ensure that GCC's procedure to fix buggy system headers and
5189 the ordering for the include_next directive are not inadvertently changed.
5190 If you really need to change the search order for system directories,
5191 use the @option{-nostdinc} and/or @option{-isystem} options.
5192
5193 @item -I-
5194 @opindex I-
5195 Any directories you specify with @option{-I} options before the @option{-I-}
5196 option are searched only for the case of @samp{#include "@var{file}"};
5197 they are not searched for @samp{#include <@var{file}>}.
5198
5199 If additional directories are specified with @option{-I} options after
5200 the @option{-I-}, these directories are searched for all @samp{#include}
5201 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5202 this way.)
5203
5204 In addition, the @option{-I-} option inhibits the use of the current
5205 directory (where the current input file came from) as the first search
5206 directory for @samp{#include "@var{file}"}.  There is no way to
5207 override this effect of @option{-I-}.  With @option{-I.} you can specify
5208 searching the directory which was current when the compiler was
5209 invoked.  That is not exactly the same as what the preprocessor does
5210 by default, but it is often satisfactory.
5211
5212 @option{-I-} does not inhibit the use of the standard system directories
5213 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5214 independent.
5215
5216 @item -L@var{dir}
5217 @opindex L
5218 Add directory @var{dir} to the list of directories to be searched
5219 for @option{-l}.
5220
5221 @item -B@var{prefix}
5222 @opindex B
5223 This option specifies where to find the executables, libraries,
5224 include files, and data files of the compiler itself.
5225
5226 The compiler driver program runs one or more of the subprograms
5227 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5228 @var{prefix} as a prefix for each program it tries to run, both with and
5229 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5230
5231 For each subprogram to be run, the compiler driver first tries the
5232 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5233 was not specified, the driver tries two standard prefixes, which are
5234 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5235 those results in a file name that is found, the unmodified program
5236 name is searched for using the directories specified in your
5237 @env{PATH} environment variable.
5238
5239 The compiler will check to see if the path provided by the @option{-B}
5240 refers to a directory, and if necessary it will add a directory
5241 separator character at the end of the path.
5242
5243 @option{-B} prefixes that effectively specify directory names also apply
5244 to libraries in the linker, because the compiler translates these
5245 options into @option{-L} options for the linker.  They also apply to
5246 includes files in the preprocessor, because the compiler translates these
5247 options into @option{-isystem} options for the preprocessor.  In this case,
5248 the compiler appends @samp{include} to the prefix.
5249
5250 The run-time support file @file{libgcc.a} can also be searched for using
5251 the @option{-B} prefix, if needed.  If it is not found there, the two
5252 standard prefixes above are tried, and that is all.  The file is left
5253 out of the link if it is not found by those means.
5254
5255 Another way to specify a prefix much like the @option{-B} prefix is to use
5256 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5257 Variables}.
5258
5259 As a special kludge, if the path provided by @option{-B} is
5260 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5261 9, then it will be replaced by @file{[dir/]include}.  This is to help
5262 with boot-strapping the compiler.
5263
5264 @item -specs=@var{file}
5265 @opindex specs
5266 Process @var{file} after the compiler reads in the standard @file{specs}
5267 file, in order to override the defaults that the @file{gcc} driver
5268 program uses when determining what switches to pass to @file{cc1},
5269 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5270 @option{-specs=@var{file}} can be specified on the command line, and they
5271 are processed in order, from left to right.
5272 @end table
5273
5274 @c man end
5275
5276 @node Spec Files
5277 @section Specifying subprocesses and the switches to pass to them
5278 @cindex Spec Files
5279
5280 @command{gcc} is a driver program.  It performs its job by invoking a
5281 sequence of other programs to do the work of compiling, assembling and
5282 linking.  GCC interprets its command-line parameters and uses these to
5283 deduce which programs it should invoke, and which command-line options
5284 it ought to place on their command lines.  This behavior is controlled
5285 by @dfn{spec strings}.  In most cases there is one spec string for each
5286 program that GCC can invoke, but a few programs have multiple spec
5287 strings to control their behavior.  The spec strings built into GCC can
5288 be overridden by using the @option{-specs=} command-line switch to specify
5289 a spec file.
5290
5291 @dfn{Spec files} are plaintext files that are used to construct spec
5292 strings.  They consist of a sequence of directives separated by blank
5293 lines.  The type of directive is determined by the first non-whitespace
5294 character on the line and it can be one of the following:
5295
5296 @table @code
5297 @item %@var{command}
5298 Issues a @var{command} to the spec file processor.  The commands that can
5299 appear here are:
5300
5301 @table @code
5302 @item %include <@var{file}>
5303 @cindex %include
5304 Search for @var{file} and insert its text at the current point in the
5305 specs file.
5306
5307 @item %include_noerr <@var{file}>
5308 @cindex %include_noerr
5309 Just like @samp{%include}, but do not generate an error message if the include
5310 file cannot be found.
5311
5312 @item %rename @var{old_name} @var{new_name}
5313 @cindex %rename
5314 Rename the spec string @var{old_name} to @var{new_name}.
5315
5316 @end table
5317
5318 @item *[@var{spec_name}]:
5319 This tells the compiler to create, override or delete the named spec
5320 string.  All lines after this directive up to the next directive or
5321 blank line are considered to be the text for the spec string.  If this
5322 results in an empty string then the spec will be deleted.  (Or, if the
5323 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5324 does not currently exist a new spec will be created.  If the spec does
5325 exist then its contents will be overridden by the text of this
5326 directive, unless the first character of that text is the @samp{+}
5327 character, in which case the text will be appended to the spec.
5328
5329 @item [@var{suffix}]:
5330 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5331 and up to the next directive or blank line are considered to make up the
5332 spec string for the indicated suffix.  When the compiler encounters an
5333 input file with the named suffix, it will processes the spec string in
5334 order to work out how to compile that file.  For example:
5335
5336 @smallexample
5337 .ZZ:
5338 z-compile -input %i
5339 @end smallexample
5340
5341 This says that any input file whose name ends in @samp{.ZZ} should be
5342 passed to the program @samp{z-compile}, which should be invoked with the
5343 command-line switch @option{-input} and with the result of performing the
5344 @samp{%i} substitution.  (See below.)
5345
5346 As an alternative to providing a spec string, the text that follows a
5347 suffix directive can be one of the following:
5348
5349 @table @code
5350 @item @@@var{language}
5351 This says that the suffix is an alias for a known @var{language}.  This is
5352 similar to using the @option{-x} command-line switch to GCC to specify a
5353 language explicitly.  For example:
5354
5355 @smallexample
5356 .ZZ:
5357 @@c++
5358 @end smallexample
5359
5360 Says that .ZZ files are, in fact, C++ source files.
5361
5362 @item #@var{name}
5363 This causes an error messages saying:
5364
5365 @smallexample
5366 @var{name} compiler not installed on this system.
5367 @end smallexample
5368 @end table
5369
5370 GCC already has an extensive list of suffixes built into it.
5371 This directive will add an entry to the end of the list of suffixes, but
5372 since the list is searched from the end backwards, it is effectively
5373 possible to override earlier entries using this technique.
5374
5375 @end table
5376
5377 GCC has the following spec strings built into it.  Spec files can
5378 override these strings or create their own.  Note that individual
5379 targets can also add their own spec strings to this list.
5380
5381 @smallexample
5382 asm          Options to pass to the assembler
5383 asm_final    Options to pass to the assembler post-processor
5384 cpp          Options to pass to the C preprocessor
5385 cc1          Options to pass to the C compiler
5386 cc1plus      Options to pass to the C++ compiler
5387 endfile      Object files to include at the end of the link
5388 link         Options to pass to the linker
5389 lib          Libraries to include on the command line to the linker
5390 libgcc       Decides which GCC support library to pass to the linker
5391 linker       Sets the name of the linker
5392 predefines   Defines to be passed to the C preprocessor
5393 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5394              by default
5395 startfile    Object files to include at the start of the link
5396 @end smallexample
5397
5398 Here is a small example of a spec file:
5399
5400 @smallexample
5401 %rename lib                 old_lib
5402
5403 *lib:
5404 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5405 @end smallexample
5406
5407 This example renames the spec called @samp{lib} to @samp{old_lib} and
5408 then overrides the previous definition of @samp{lib} with a new one.
5409 The new definition adds in some extra command-line options before
5410 including the text of the old definition.
5411
5412 @dfn{Spec strings} are a list of command-line options to be passed to their
5413 corresponding program.  In addition, the spec strings can contain
5414 @samp{%}-prefixed sequences to substitute variable text or to
5415 conditionally insert text into the command line.  Using these constructs
5416 it is possible to generate quite complex command lines.
5417
5418 Here is a table of all defined @samp{%}-sequences for spec
5419 strings.  Note that spaces are not generated automatically around the
5420 results of expanding these sequences.  Therefore you can concatenate them
5421 together or combine them with constant text in a single argument.
5422
5423 @table @code
5424 @item %%
5425 Substitute one @samp{%} into the program name or argument.
5426
5427 @item %i
5428 Substitute the name of the input file being processed.
5429
5430 @item %b
5431 Substitute the basename of the input file being processed.
5432 This is the substring up to (and not including) the last period
5433 and not including the directory.
5434
5435 @item %B
5436 This is the same as @samp{%b}, but include the file suffix (text after
5437 the last period).
5438
5439 @item %d
5440 Marks the argument containing or following the @samp{%d} as a
5441 temporary file name, so that that file will be deleted if GCC exits
5442 successfully.  Unlike @samp{%g}, this contributes no text to the
5443 argument.
5444
5445 @item %g@var{suffix}
5446 Substitute a file name that has suffix @var{suffix} and is chosen
5447 once per compilation, and mark the argument in the same way as
5448 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5449 name is now chosen in a way that is hard to predict even when previously
5450 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5451 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5452 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5453 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5454 was simply substituted with a file name chosen once per compilation,
5455 without regard to any appended suffix (which was therefore treated
5456 just like ordinary text), making such attacks more likely to succeed.
5457
5458 @item %u@var{suffix}
5459 Like @samp{%g}, but generates a new temporary file name even if
5460 @samp{%u@var{suffix}} was already seen.
5461
5462 @item %U@var{suffix}
5463 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5464 new one if there is no such last file name.  In the absence of any
5465 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5466 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5467 would involve the generation of two distinct file names, one
5468 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5469 simply substituted with a file name chosen for the previous @samp{%u},
5470 without regard to any appended suffix.
5471
5472 @item %j@var{suffix}
5473 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5474 writable, and if save-temps is off; otherwise, substitute the name
5475 of a temporary file, just like @samp{%u}.  This temporary file is not
5476 meant for communication between processes, but rather as a junk
5477 disposal mechanism.
5478
5479 @item %|@var{suffix}
5480 @itemx %m@var{suffix}
5481 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5482 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5483 all.  These are the two most common ways to instruct a program that it
5484 should read from standard input or write to standard output.  If you
5485 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5486 construct: see for example @file{f/lang-specs.h}.
5487
5488 @item %.@var{SUFFIX}
5489 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5490 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5491 terminated by the next space or %.
5492
5493 @item %w
5494 Marks the argument containing or following the @samp{%w} as the
5495 designated output file of this compilation.  This puts the argument
5496 into the sequence of arguments that @samp{%o} will substitute later.
5497
5498 @item %o
5499 Substitutes the names of all the output files, with spaces
5500 automatically placed around them.  You should write spaces
5501 around the @samp{%o} as well or the results are undefined.
5502 @samp{%o} is for use in the specs for running the linker.
5503 Input files whose names have no recognized suffix are not compiled
5504 at all, but they are included among the output files, so they will
5505 be linked.
5506
5507 @item %O
5508 Substitutes the suffix for object files.  Note that this is
5509 handled specially when it immediately follows @samp{%g, %u, or %U},
5510 because of the need for those to form complete file names.  The
5511 handling is such that @samp{%O} is treated exactly as if it had already
5512 been substituted, except that @samp{%g, %u, and %U} do not currently
5513 support additional @var{suffix} characters following @samp{%O} as they would
5514 following, for example, @samp{.o}.
5515
5516 @item %p
5517 Substitutes the standard macro predefinitions for the
5518 current target machine.  Use this when running @code{cpp}.
5519
5520 @item %P
5521 Like @samp{%p}, but puts @samp{__} before and after the name of each
5522 predefined macro, except for macros that start with @samp{__} or with
5523 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5524 C@.
5525
5526 @item %I
5527 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5528 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5529 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5530 as necessary.
5531
5532 @item %s
5533 Current argument is the name of a library or startup file of some sort.
5534 Search for that file in a standard list of directories and substitute
5535 the full name found.
5536
5537 @item %e@var{str}
5538 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5539 Use this when inconsistent options are detected.
5540
5541 @item %(@var{name})
5542 Substitute the contents of spec string @var{name} at this point.
5543
5544 @item %[@var{name}]
5545 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5546
5547 @item %x@{@var{option}@}
5548 Accumulate an option for @samp{%X}.
5549
5550 @item %X
5551 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5552 spec string.
5553
5554 @item %Y
5555 Output the accumulated assembler options specified by @option{-Wa}.
5556
5557 @item %Z
5558 Output the accumulated preprocessor options specified by @option{-Wp}.
5559
5560 @item %a
5561 Process the @code{asm} spec.  This is used to compute the
5562 switches to be passed to the assembler.
5563
5564 @item %A
5565 Process the @code{asm_final} spec.  This is a spec string for
5566 passing switches to an assembler post-processor, if such a program is
5567 needed.
5568
5569 @item %l
5570 Process the @code{link} spec.  This is the spec for computing the
5571 command line passed to the linker.  Typically it will make use of the
5572 @samp{%L %G %S %D and %E} sequences.
5573
5574 @item %D
5575 Dump out a @option{-L} option for each directory that GCC believes might
5576 contain startup files.  If the target supports multilibs then the
5577 current multilib directory will be prepended to each of these paths.
5578
5579 @item %M
5580 Output the multilib directory with directory separators replaced with
5581 @samp{_}.  If multilib directories are not set, or the multilib directory is
5582 @file{.} then this option emits nothing.
5583
5584 @item %L
5585 Process the @code{lib} spec.  This is a spec string for deciding which
5586 libraries should be included on the command line to the linker.
5587
5588 @item %G
5589 Process the @code{libgcc} spec.  This is a spec string for deciding
5590 which GCC support library should be included on the command line to the linker.
5591
5592 @item %S
5593 Process the @code{startfile} spec.  This is a spec for deciding which
5594 object files should be the first ones passed to the linker.  Typically
5595 this might be a file named @file{crt0.o}.
5596
5597 @item %E
5598 Process the @code{endfile} spec.  This is a spec string that specifies
5599 the last object files that will be passed to the linker.
5600
5601 @item %C
5602 Process the @code{cpp} spec.  This is used to construct the arguments
5603 to be passed to the C preprocessor.
5604
5605 @item %c
5606 Process the @code{signed_char} spec.  This is intended to be used
5607 to tell cpp whether a char is signed.  It typically has the definition:
5608 @smallexample
5609 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5610 @end smallexample
5611
5612 @item %1
5613 Process the @code{cc1} spec.  This is used to construct the options to be
5614 passed to the actual C compiler (@samp{cc1}).
5615
5616 @item %2
5617 Process the @code{cc1plus} spec.  This is used to construct the options to be
5618 passed to the actual C++ compiler (@samp{cc1plus}).
5619
5620 @item %*
5621 Substitute the variable part of a matched option.  See below.
5622 Note that each comma in the substituted string is replaced by
5623 a single space.
5624
5625 @item %<@code{S}
5626 Remove all occurrences of @code{-S} from the command line.  Note---this
5627 command is position dependent.  @samp{%} commands in the spec string
5628 before this one will see @code{-S}, @samp{%} commands in the spec string
5629 after this one will not.
5630
5631 @item %:@var{function}(@var{args})
5632 Call the named function @var{function}, passing it @var{args}.
5633 @var{args} is first processed as a nested spec string, then split
5634 into an argument vector in the usual fashion.  The function returns
5635 a string which is processed as if it had appeared literally as part
5636 of the current spec.
5637
5638 The following built-in spec functions are provided:
5639
5640 @table @code
5641 @item @code{if-exists}
5642 The @code{if-exists} spec function takes one argument, an absolute
5643 pathname to a file.  If the file exists, @code{if-exists} returns the
5644 pathname.  Here is a small example of its usage:
5645
5646 @smallexample
5647 *startfile:
5648 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5649 @end smallexample
5650
5651 @item @code{if-exists-else}
5652 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5653 spec function, except that it takes two arguments.  The first argument is
5654 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5655 returns the pathname.  If it does not exist, it returns the second argument.
5656 This way, @code{if-exists-else} can be used to select one file or another,
5657 based on the existence of the first.  Here is a small example of its usage:
5658
5659 @smallexample
5660 *startfile:
5661 crt0%O%s %:if-exists(crti%O%s) \
5662 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5663 @end smallexample
5664 @end table
5665
5666 @item %@{@code{S}@}
5667 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5668 If that switch was not specified, this substitutes nothing.  Note that
5669 the leading dash is omitted when specifying this option, and it is
5670 automatically inserted if the substitution is performed.  Thus the spec
5671 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5672 and would output the command line option @option{-foo}.
5673
5674 @item %W@{@code{S}@}
5675 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5676 deleted on failure.
5677
5678 @item %@{@code{S}*@}
5679 Substitutes all the switches specified to GCC whose names start
5680 with @code{-S}, but which also take an argument.  This is used for
5681 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5682 GCC considers @option{-o foo} as being
5683 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5684 text, including the space.  Thus two arguments would be generated.
5685
5686 @item %@{@code{S}*&@code{T}*@}
5687 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5688 (the order of @code{S} and @code{T} in the spec is not significant).
5689 There can be any number of ampersand-separated variables; for each the
5690 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5691
5692 @item %@{@code{S}:@code{X}@}
5693 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5694
5695 @item %@{!@code{S}:@code{X}@}
5696 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5697
5698 @item %@{@code{S}*:@code{X}@}
5699 Substitutes @code{X} if one or more switches whose names start with
5700 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5701 once, no matter how many such switches appeared.  However, if @code{%*}
5702 appears somewhere in @code{X}, then @code{X} will be substituted once
5703 for each matching switch, with the @code{%*} replaced by the part of
5704 that switch that matched the @code{*}.
5705
5706 @item %@{.@code{S}:@code{X}@}
5707 Substitutes @code{X}, if processing a file with suffix @code{S}.
5708
5709 @item %@{!.@code{S}:@code{X}@}
5710 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5711
5712 @item %@{@code{S}|@code{P}:@code{X}@}
5713 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5714 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5715 although they have a stronger binding than the @samp{|}.  If @code{%*}
5716 appears in @code{X}, all of the alternatives must be starred, and only
5717 the first matching alternative is substituted.
5718
5719 For example, a spec string like this:
5720
5721 @smallexample
5722 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5723 @end smallexample
5724
5725 will output the following command-line options from the following input
5726 command-line options:
5727
5728 @smallexample
5729 fred.c        -foo -baz
5730 jim.d         -bar -boggle
5731 -d fred.c     -foo -baz -boggle
5732 -d jim.d      -bar -baz -boggle
5733 @end smallexample
5734
5735 @item %@{S:X; T:Y; :D@}
5736
5737 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5738 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5739 be as many clauses as you need.  This may be combined with @code{.},
5740 @code{!}, @code{|}, and @code{*} as needed.
5741
5742
5743 @end table
5744
5745 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5746 construct may contain other nested @samp{%} constructs or spaces, or
5747 even newlines.  They are processed as usual, as described above.
5748 Trailing white space in @code{X} is ignored.  White space may also
5749 appear anywhere on the left side of the colon in these constructs,
5750 except between @code{.} or @code{*} and the corresponding word.
5751
5752 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5753 handled specifically in these constructs.  If another value of
5754 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5755 @option{-W} switch is found later in the command line, the earlier
5756 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5757 just one letter, which passes all matching options.
5758
5759 The character @samp{|} at the beginning of the predicate text is used to
5760 indicate that a command should be piped to the following command, but
5761 only if @option{-pipe} is specified.
5762
5763 It is built into GCC which switches take arguments and which do not.
5764 (You might think it would be useful to generalize this to allow each
5765 compiler's spec to say which switches take arguments.  But this cannot
5766 be done in a consistent fashion.  GCC cannot even decide which input
5767 files have been specified without knowing which switches take arguments,
5768 and it must know which input files to compile in order to tell which
5769 compilers to run).
5770
5771 GCC also knows implicitly that arguments starting in @option{-l} are to be
5772 treated as compiler output files, and passed to the linker in their
5773 proper position among the other output files.
5774
5775 @c man begin OPTIONS
5776
5777 @node Target Options
5778 @section Specifying Target Machine and Compiler Version
5779 @cindex target options
5780 @cindex cross compiling
5781 @cindex specifying machine version
5782 @cindex specifying compiler version and target machine
5783 @cindex compiler version, specifying
5784 @cindex target machine, specifying
5785
5786 The usual way to run GCC is to run the executable called @file{gcc}, or
5787 @file{<machine>-gcc} when cross-compiling, or
5788 @file{<machine>-gcc-<version>} to run a version other than the one that
5789 was installed last.  Sometimes this is inconvenient, so GCC provides
5790 options that will switch to another cross-compiler or version.
5791
5792 @table @gcctabopt
5793 @item -b @var{machine}
5794 @opindex b
5795 The argument @var{machine} specifies the target machine for compilation.
5796
5797 The value to use for @var{machine} is the same as was specified as the
5798 machine type when configuring GCC as a cross-compiler.  For
5799 example, if a cross-compiler was configured with @samp{configure
5800 i386v}, meaning to compile for an 80386 running System V, then you
5801 would specify @option{-b i386v} to run that cross compiler.
5802
5803 @item -V @var{version}
5804 @opindex V
5805 The argument @var{version} specifies which version of GCC to run.
5806 This is useful when multiple versions are installed.  For example,
5807 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5808 @end table
5809
5810 The @option{-V} and @option{-b} options work by running the
5811 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5812 use them if you can just run that directly.
5813
5814 @node Submodel Options
5815 @section Hardware Models and Configurations
5816 @cindex submodel options
5817 @cindex specifying hardware config
5818 @cindex hardware models and configurations, specifying
5819 @cindex machine dependent options
5820
5821 Earlier we discussed the standard option @option{-b} which chooses among
5822 different installed compilers for completely different target
5823 machines, such as VAX vs.@: 68000 vs.@: 80386.
5824
5825 In addition, each of these target machine types can have its own
5826 special options, starting with @samp{-m}, to choose among various
5827 hardware models or configurations---for example, 68010 vs 68020,
5828 floating coprocessor or none.  A single installed version of the
5829 compiler can compile for any model or configuration, according to the
5830 options specified.
5831
5832 Some configurations of the compiler also support additional special
5833 options, usually for compatibility with other compilers on the same
5834 platform.
5835
5836 These options are defined by the macro @code{TARGET_SWITCHES} in the
5837 machine description.  The default for the options is also defined by
5838 that macro, which enables you to change the defaults.
5839
5840 @menu
5841 * M680x0 Options::
5842 * M68hc1x Options::
5843 * VAX Options::
5844 * SPARC Options::
5845 * ARM Options::
5846 * MN10300 Options::
5847 * M32R/D Options::
5848 * RS/6000 and PowerPC Options::
5849 * Darwin Options::
5850 * MIPS Options::
5851 * i386 and x86-64 Options::
5852 * HPPA Options::
5853 * Intel 960 Options::
5854 * DEC Alpha Options::
5855 * DEC Alpha/VMS Options::
5856 * H8/300 Options::
5857 * SH Options::
5858 * System V Options::
5859 * TMS320C3x/C4x Options::
5860 * V850 Options::
5861 * ARC Options::
5862 * NS32K Options::
5863 * AVR Options::
5864 * MCore Options::
5865 * IA-64 Options::
5866 * D30V Options::
5867 * S/390 and zSeries Options::
5868 * CRIS Options::
5869 * MMIX Options::
5870 * PDP-11 Options::
5871 * Xstormy16 Options::
5872 * Xtensa Options::
5873 * FRV Options::
5874 @end menu
5875
5876 @node M680x0 Options
5877 @subsection M680x0 Options
5878 @cindex M680x0 options
5879
5880 These are the @samp{-m} options defined for the 68000 series.  The default
5881 values for these options depends on which style of 68000 was selected when
5882 the compiler was configured; the defaults for the most common choices are
5883 given below.
5884
5885 @table @gcctabopt
5886 @item -m68000
5887 @itemx -mc68000
5888 @opindex m68000
5889 @opindex mc68000
5890 Generate output for a 68000.  This is the default
5891 when the compiler is configured for 68000-based systems.
5892
5893 Use this option for microcontrollers with a 68000 or EC000 core,
5894 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5895
5896 @item -m68020
5897 @itemx -mc68020
5898 @opindex m68020
5899 @opindex mc68020
5900 Generate output for a 68020.  This is the default
5901 when the compiler is configured for 68020-based systems.
5902
5903 @item -m68881
5904 @opindex m68881
5905 Generate output containing 68881 instructions for floating point.
5906 This is the default for most 68020 systems unless @option{--nfp} was
5907 specified when the compiler was configured.
5908
5909 @item -m68030
5910 @opindex m68030
5911 Generate output for a 68030.  This is the default when the compiler is
5912 configured for 68030-based systems.
5913
5914 @item -m68040
5915 @opindex m68040
5916 Generate output for a 68040.  This is the default when the compiler is
5917 configured for 68040-based systems.
5918
5919 This option inhibits the use of 68881/68882 instructions that have to be
5920 emulated by software on the 68040.  Use this option if your 68040 does not
5921 have code to emulate those instructions.
5922
5923 @item -m68060
5924 @opindex m68060
5925 Generate output for a 68060.  This is the default when the compiler is
5926 configured for 68060-based systems.
5927
5928 This option inhibits the use of 68020 and 68881/68882 instructions that
5929 have to be emulated by software on the 68060.  Use this option if your 68060
5930 does not have code to emulate those instructions.
5931
5932 @item -mcpu32
5933 @opindex mcpu32
5934 Generate output for a CPU32.  This is the default
5935 when the compiler is configured for CPU32-based systems.
5936
5937 Use this option for microcontrollers with a
5938 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5939 68336, 68340, 68341, 68349 and 68360.
5940
5941 @item -m5200
5942 @opindex m5200
5943 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5944 when the compiler is configured for 520X-based systems.
5945
5946 Use this option for microcontroller with a 5200 core, including
5947 the MCF5202, MCF5203, MCF5204 and MCF5202.
5948
5949
5950 @item -m68020-40
5951 @opindex m68020-40
5952 Generate output for a 68040, without using any of the new instructions.
5953 This results in code which can run relatively efficiently on either a
5954 68020/68881 or a 68030 or a 68040.  The generated code does use the
5955 68881 instructions that are emulated on the 68040.
5956
5957 @item -m68020-60
5958 @opindex m68020-60
5959 Generate output for a 68060, without using any of the new instructions.
5960 This results in code which can run relatively efficiently on either a
5961 68020/68881 or a 68030 or a 68040.  The generated code does use the
5962 68881 instructions that are emulated on the 68060.
5963
5964 @item -msoft-float
5965 @opindex msoft-float
5966 Generate output containing library calls for floating point.
5967 @strong{Warning:} the requisite libraries are not available for all m68k
5968 targets.  Normally the facilities of the machine's usual C compiler are
5969 used, but this can't be done directly in cross-compilation.  You must
5970 make your own arrangements to provide suitable library functions for
5971 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5972 @samp{m68k-*-coff} do provide software floating point support.
5973
5974 @item -mshort
5975 @opindex mshort
5976 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5977
5978 @item -mnobitfield
5979 @opindex mnobitfield
5980 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5981 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5982
5983 @item -mbitfield
5984 @opindex mbitfield
5985 Do use the bit-field instructions.  The @option{-m68020} option implies
5986 @option{-mbitfield}.  This is the default if you use a configuration
5987 designed for a 68020.
5988
5989 @item -mrtd
5990 @opindex mrtd
5991 Use a different function-calling convention, in which functions
5992 that take a fixed number of arguments return with the @code{rtd}
5993 instruction, which pops their arguments while returning.  This
5994 saves one instruction in the caller since there is no need to pop
5995 the arguments there.
5996
5997 This calling convention is incompatible with the one normally
5998 used on Unix, so you cannot use it if you need to call libraries
5999 compiled with the Unix compiler.
6000
6001 Also, you must provide function prototypes for all functions that
6002 take variable numbers of arguments (including @code{printf});
6003 otherwise incorrect code will be generated for calls to those
6004 functions.
6005
6006 In addition, seriously incorrect code will result if you call a
6007 function with too many arguments.  (Normally, extra arguments are
6008 harmlessly ignored.)
6009
6010 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6011 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6012
6013 @item -malign-int
6014 @itemx -mno-align-int
6015 @opindex malign-int
6016 @opindex mno-align-int
6017 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6018 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6019 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6020 Aligning variables on 32-bit boundaries produces code that runs somewhat
6021 faster on processors with 32-bit busses at the expense of more memory.
6022
6023 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6024 align structures containing the above types  differently than
6025 most published application binary interface specifications for the m68k.
6026
6027 @item -mpcrel
6028 @opindex mpcrel
6029 Use the pc-relative addressing mode of the 68000 directly, instead of
6030 using a global offset table.  At present, this option implies @option{-fpic},
6031 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6032 not presently supported with @option{-mpcrel}, though this could be supported for
6033 68020 and higher processors.
6034
6035 @item -mno-strict-align
6036 @itemx -mstrict-align
6037 @opindex mno-strict-align
6038 @opindex mstrict-align
6039 Do not (do) assume that unaligned memory references will be handled by
6040 the system.
6041
6042 @item -msep-data
6043 Generate code that allows the data segment to be located in a different
6044 area of memory from the text segment.  This allows for execute in place in
6045 an environment without virtual memory management.  This option implies -fPIC.
6046
6047 @item -mno-sep-data
6048 Generate code that assumes that the data segment follows the text segment.
6049 This is the default.
6050
6051 @item -mid-shared-library
6052 Generate code that supports shared libraries via the library ID method.
6053 This allows for execute in place and shared libraries in an environment
6054 without virtual memory management.  This option implies -fPIC.
6055
6056 @item -mno-id-shared-library
6057 Generate code that doesn't assume ID based shared libraries are being used.
6058 This is the default.
6059
6060 @item -mshared-library-id=n
6061 Specified the identification number of the ID based shared library being
6062 compiled.  Specifying a value of 0 will generate more compact code, specifying
6063 other values will force the allocation of that number to the current
6064 library but is no more space or time efficient than omitting this option.
6065
6066 @end table
6067
6068 @node M68hc1x Options
6069 @subsection M68hc1x Options
6070 @cindex M68hc1x options
6071
6072 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6073 microcontrollers.  The default values for these options depends on
6074 which style of microcontroller was selected when the compiler was configured;
6075 the defaults for the most common choices are given below.
6076
6077 @table @gcctabopt
6078 @item -m6811
6079 @itemx -m68hc11
6080 @opindex m6811
6081 @opindex m68hc11
6082 Generate output for a 68HC11.  This is the default
6083 when the compiler is configured for 68HC11-based systems.
6084
6085 @item -m6812
6086 @itemx -m68hc12
6087 @opindex m6812
6088 @opindex m68hc12
6089 Generate output for a 68HC12.  This is the default
6090 when the compiler is configured for 68HC12-based systems.
6091
6092 @item -m68S12
6093 @itemx -m68hcs12
6094 @opindex m68S12
6095 @opindex m68hcs12
6096 Generate output for a 68HCS12.
6097
6098 @item -mauto-incdec
6099 @opindex mauto-incdec
6100 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6101 addressing modes.
6102
6103 @item -minmax
6104 @itemx -nominmax
6105 @opindex minmax
6106 @opindex mnominmax
6107 Enable the use of 68HC12 min and max instructions.
6108
6109 @item -mlong-calls
6110 @itemx -mno-long-calls
6111 @opindex mlong-calls
6112 @opindex mno-long-calls
6113 Treat all calls as being far away (near).  If calls are assumed to be
6114 far away, the compiler will use the @code{call} instruction to
6115 call a function and the @code{rtc} instruction for returning.
6116
6117 @item -mshort
6118 @opindex mshort
6119 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6120
6121 @item -msoft-reg-count=@var{count}
6122 @opindex msoft-reg-count
6123 Specify the number of pseudo-soft registers which are used for the
6124 code generation.  The maximum number is 32.  Using more pseudo-soft
6125 register may or may not result in better code depending on the program.
6126 The default is 4 for 68HC11 and 2 for 68HC12.
6127
6128 @end table
6129
6130 @node VAX Options
6131 @subsection VAX Options
6132 @cindex VAX options
6133
6134 These @samp{-m} options are defined for the VAX:
6135
6136 @table @gcctabopt
6137 @item -munix
6138 @opindex munix
6139 Do not output certain jump instructions (@code{aobleq} and so on)
6140 that the Unix assembler for the VAX cannot handle across long
6141 ranges.
6142
6143 @item -mgnu
6144 @opindex mgnu
6145 Do output those jump instructions, on the assumption that you
6146 will assemble with the GNU assembler.
6147
6148 @item -mg
6149 @opindex mg
6150 Output code for g-format floating point numbers instead of d-format.
6151 @end table
6152
6153 @node SPARC Options
6154 @subsection SPARC Options
6155 @cindex SPARC options
6156
6157 These @samp{-m} options are supported on the SPARC:
6158
6159 @table @gcctabopt
6160 @item -mno-app-regs
6161 @itemx -mapp-regs
6162 @opindex mno-app-regs
6163 @opindex mapp-regs
6164 Specify @option{-mapp-regs} to generate output using the global registers
6165 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6166 is the default, except on Solaris.
6167
6168 To be fully SVR4 ABI compliant at the cost of some performance loss,
6169 specify @option{-mno-app-regs}.  You should compile libraries and system
6170 software with this option.
6171
6172 @item -mfpu
6173 @itemx -mhard-float
6174 @opindex mfpu
6175 @opindex mhard-float
6176 Generate output containing floating point instructions.  This is the
6177 default.
6178
6179 @item -mno-fpu
6180 @itemx -msoft-float
6181 @opindex mno-fpu
6182 @opindex msoft-float
6183 Generate output containing library calls for floating point.
6184 @strong{Warning:} the requisite libraries are not available for all SPARC
6185 targets.  Normally the facilities of the machine's usual C compiler are
6186 used, but this cannot be done directly in cross-compilation.  You must make
6187 your own arrangements to provide suitable library functions for
6188 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6189 @samp{sparclite-*-*} do provide software floating point support.
6190
6191 @option{-msoft-float} changes the calling convention in the output file;
6192 therefore, it is only useful if you compile @emph{all} of a program with
6193 this option.  In particular, you need to compile @file{libgcc.a}, the
6194 library that comes with GCC, with @option{-msoft-float} in order for
6195 this to work.
6196
6197 @item -mhard-quad-float
6198 @opindex mhard-quad-float
6199 Generate output containing quad-word (long double) floating point
6200 instructions.
6201
6202 @item -msoft-quad-float
6203 @opindex msoft-quad-float
6204 Generate output containing library calls for quad-word (long double)
6205 floating point instructions.  The functions called are those specified
6206 in the SPARC ABI@.  This is the default.
6207
6208 As of this writing, there are no SPARC implementations that have hardware
6209 support for the quad-word floating point instructions.  They all invoke
6210 a trap handler for one of these instructions, and then the trap handler
6211 emulates the effect of the instruction.  Because of the trap handler overhead,
6212 this is much slower than calling the ABI library routines.  Thus the
6213 @option{-msoft-quad-float} option is the default.
6214
6215 @item -mno-flat
6216 @itemx -mflat
6217 @opindex mno-flat
6218 @opindex mflat
6219 With @option{-mflat}, the compiler does not generate save/restore instructions
6220 and will use a ``flat'' or single register window calling convention.
6221 This model uses %i7 as the frame pointer and is compatible with the normal
6222 register window model.  Code from either may be intermixed.
6223 The local registers and the input registers (0--5) are still treated as
6224 ``call saved'' registers and will be saved on the stack as necessary.
6225
6226 With @option{-mno-flat} (the default), the compiler emits save/restore
6227 instructions (except for leaf functions) and is the normal mode of operation.
6228
6229 These options are deprecated and will be deleted in a future GCC release.
6230
6231 @item -mno-unaligned-doubles
6232 @itemx -munaligned-doubles
6233 @opindex mno-unaligned-doubles
6234 @opindex munaligned-doubles
6235 Assume that doubles have 8 byte alignment.  This is the default.
6236
6237 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6238 alignment only if they are contained in another type, or if they have an
6239 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6240 Specifying this option avoids some rare compatibility problems with code
6241 generated by other compilers.  It is not the default because it results
6242 in a performance loss, especially for floating point code.
6243
6244 @item -mno-faster-structs
6245 @itemx -mfaster-structs
6246 @opindex mno-faster-structs
6247 @opindex mfaster-structs
6248 With @option{-mfaster-structs}, the compiler assumes that structures
6249 should have 8 byte alignment.  This enables the use of pairs of
6250 @code{ldd} and @code{std} instructions for copies in structure
6251 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6252 However, the use of this changed alignment directly violates the SPARC
6253 ABI@.  Thus, it's intended only for use on targets where the developer
6254 acknowledges that their resulting code will not be directly in line with
6255 the rules of the ABI@.
6256
6257 @item -mimpure-text
6258 @opindex mimpure-text
6259 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6260 the compiler to not pass @option{-z text} to the linker when linking a
6261 shared object.  Using this option, you can link position-dependent
6262 code into a shared object.
6263
6264 @option{-mimpure-text} suppresses the ``relocations remain against
6265 allocatable but non-writable sections'' linker error message.
6266 However, the necessary relocations will trigger copy-on-write, and the
6267 shared object is not actually shared across processes.  Instead of
6268 using @option{-mimpure-text}, you should compile all source code with
6269 @option{-fpic} or @option{-fPIC}.
6270
6271 This option is only available on SunOS and Solaris.
6272
6273 @item -mv8
6274 @itemx -msparclite
6275 @opindex mv8
6276 @opindex msparclite
6277 These two options select variations on the SPARC architecture.
6278 These options are deprecated and will be deleted in a future GCC release.
6279 They have been replaced with @option{-mcpu=xxx}.
6280
6281 @item -mcypress
6282 @itemx -msupersparc
6283 @itemx -mf930
6284 @itemx -mf934
6285 @opindex mcypress
6286 @opindex msupersparc
6287 @opindex -mf930
6288 @opindex -mf934
6289 These four options select the processor for which the code is optimized.
6290 These options are deprecated and will be deleted in a future GCC release.
6291 They have been replaced with @option{-mcpu=xxx}.
6292
6293 @item -mcpu=@var{cpu_type}
6294 @opindex mcpu
6295 Set the instruction set, register set, and instruction scheduling parameters
6296 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6297 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6298 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
6299 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6300 @samp{ultrasparc3}.
6301
6302 Default instruction scheduling parameters are used for values that select
6303 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6304 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6305
6306 Here is a list of each supported architecture and their supported
6307 implementations.
6308
6309 @smallexample
6310     v7:             cypress
6311     v8:             supersparc, hypersparc
6312     sparclite:      f930, f934, sparclite86x
6313     sparclet:       tsc701
6314     v9:             ultrasparc, ultrasparc3
6315 @end smallexample
6316
6317 By default (unless configured otherwise), GCC generates code for the V7
6318 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
6319 additionally optimizes it for the Cypress CY7C602 chip, as used in the
6320 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
6321 SPARCStation 1, 2, IPX etc.
6322
6323 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
6324 architecture.  The only difference from V7 code is that the compiler emits
6325 the integer multiply and integer divide instructions which exist in SPARC-V8
6326 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
6327 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
6328 2000 series.
6329
6330 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
6331 the SPARC architecture.  This adds the integer multiply, integer divide step
6332 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
6333 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
6334 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
6335 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
6336 MB86934 chip, which is the more recent SPARClite with FPU.
6337
6338 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
6339 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
6340 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
6341 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
6342 optimizes it for the TEMIC SPARClet chip.
6343
6344 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
6345 architecture.  This adds 64-bit integer and floating-point move instructions,
6346 3 additional floating-point condition code registers and conditional move
6347 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
6348 optimizes it for the Sun UltraSPARC I/II chips.  With
6349 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
6350 Sun UltraSPARC III chip.
6351
6352 @item -mtune=@var{cpu_type}
6353 @opindex mtune
6354 Set the instruction scheduling parameters for machine type
6355 @var{cpu_type}, but do not set the instruction set or register set that the
6356 option @option{-mcpu=@var{cpu_type}} would.
6357
6358 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6359 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6360 that select a particular cpu implementation.  Those are @samp{cypress},
6361 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6362 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6363 @samp{ultrasparc3}.
6364
6365 @item -mv8plus
6366 @itemx -mno-v8plus
6367 @opindex mv8plus
6368 @opindex mno-v8plus
6369 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
6370 difference from the V8 ABI is that the global and out registers are
6371 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
6372 mode for all SPARC-V9 processors.
6373
6374 @item -mvis
6375 @itemx -mno-vis
6376 @opindex mvis
6377 @opindex mno-vis
6378 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
6379 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
6380 @end table
6381
6382 These @samp{-m} options are supported in addition to the above
6383 on SPARC-V9 processors in 64-bit environments:
6384
6385 @table @gcctabopt
6386 @item -mlittle-endian
6387 @opindex mlittle-endian
6388 Generate code for a processor running in little-endian mode. It is only
6389 available for a few configurations and most notably not on Solaris and Linux.
6390
6391 @item -m32
6392 @itemx -m64
6393 @opindex m32
6394 @opindex m64
6395 Generate code for a 32-bit or 64-bit environment.
6396 The 32-bit environment sets int, long and pointer to 32 bits.
6397 The 64-bit environment sets int to 32 bits and long and pointer
6398 to 64 bits.
6399
6400 @item -mcmodel=medlow
6401 @opindex mcmodel=medlow
6402 Generate code for the Medium/Low code model: 64-bit addresses, programs
6403 must be linked in the low 32 bits of memory.  Programs can be statically
6404 or dynamically linked.
6405
6406 @item -mcmodel=medmid
6407 @opindex mcmodel=medmid
6408 Generate code for the Medium/Middle code model: 64-bit addresses, programs
6409 must be linked in the low 44 bits of memory, the text and data segments must
6410 be less than 2GB in size and the data segment must be located within 2GB of
6411 the text segment.
6412
6413 @item -mcmodel=medany
6414 @opindex mcmodel=medany
6415 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
6416 may be linked anywhere in memory, the text and data segments must be less
6417 than 2GB in size and the data segment must be located within 2GB of the
6418 text segment.
6419
6420 @item -mcmodel=embmedany
6421 @opindex mcmodel=embmedany
6422 Generate code for the Medium/Anywhere code model for embedded systems:
6423 64-bit addresses, the text and data segments must be less than 2GB in
6424 size, both starting anywhere in memory (determined at link time).  The
6425 global register %g4 points to the base of the data segment.  Programs
6426 are statically linked and PIC is not supported.
6427
6428 @item -mstack-bias
6429 @itemx -mno-stack-bias
6430 @opindex mstack-bias
6431 @opindex mno-stack-bias
6432 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6433 frame pointer if present, are offset by @minus{}2047 which must be added back
6434 when making stack frame references.  This is the default in 64-bit mode.
6435 Otherwise, assume no such offset is present.
6436 @end table
6437
6438 These switches are supported in addition to the above on Solaris:
6439
6440 @table @gcctabopt
6441 @item -threads
6442 @opindex threads
6443 Add support for multithreading using the Solaris threads library.  This
6444 option sets flags for both the preprocessor and linker.  This option does
6445 not affect the thread safety of object code produced by the compiler or
6446 that of libraries supplied with it.
6447
6448 @item -pthreads
6449 @opindex pthreads
6450 Add support for multithreading using the POSIX threads library.  This
6451 option sets flags for both the preprocessor and linker.  This option does
6452 not affect the thread safety of object code produced  by the compiler or
6453 that of libraries supplied with it.
6454 @end table
6455
6456 @node ARM Options
6457 @subsection ARM Options
6458 @cindex ARM options
6459
6460 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6461 architectures:
6462
6463 @table @gcctabopt
6464 @item -mapcs-frame
6465 @opindex mapcs-frame
6466 Generate a stack frame that is compliant with the ARM Procedure Call
6467 Standard for all functions, even if this is not strictly necessary for
6468 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6469 with this option will cause the stack frames not to be generated for
6470 leaf functions.  The default is @option{-mno-apcs-frame}.
6471
6472 @item -mapcs
6473 @opindex mapcs
6474 This is a synonym for @option{-mapcs-frame}.
6475
6476 @item -mapcs-26
6477 @opindex mapcs-26
6478 Generate code for a processor running with a 26-bit program counter,
6479 and conforming to the function calling standards for the APCS 26-bit
6480 option.
6481
6482 This option is deprecated.  Future releases of the GCC will only support
6483 generating code that runs in apcs-32 mode.
6484
6485 @item -mapcs-32
6486 @opindex mapcs-32
6487 Generate code for a processor running with a 32-bit program counter,
6488 and conforming to the function calling standards for the APCS 32-bit
6489 option.
6490
6491 This flag is deprecated.  Future releases of GCC will make this flag
6492 unconditional.
6493
6494 @ignore
6495 @c not currently implemented
6496 @item -mapcs-stack-check
6497 @opindex mapcs-stack-check
6498 Generate code to check the amount of stack space available upon entry to
6499 every function (that actually uses some stack space).  If there is
6500 insufficient space available then either the function
6501 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6502 called, depending upon the amount of stack space required.  The run time
6503 system is required to provide these functions.  The default is
6504 @option{-mno-apcs-stack-check}, since this produces smaller code.
6505
6506 @c not currently implemented
6507 @item -mapcs-float
6508 @opindex mapcs-float
6509 Pass floating point arguments using the float point registers.  This is
6510 one of the variants of the APCS@.  This option is recommended if the
6511 target hardware has a floating point unit or if a lot of floating point
6512 arithmetic is going to be performed by the code.  The default is
6513 @option{-mno-apcs-float}, since integer only code is slightly increased in
6514 size if @option{-mapcs-float} is used.
6515
6516 @c not currently implemented
6517 @item -mapcs-reentrant
6518 @opindex mapcs-reentrant
6519 Generate reentrant, position independent code.  The default is
6520 @option{-mno-apcs-reentrant}.
6521 @end ignore
6522
6523 @item -mthumb-interwork
6524 @opindex mthumb-interwork
6525 Generate code which supports calling between the ARM and Thumb
6526 instruction sets.  Without this option the two instruction sets cannot
6527 be reliably used inside one program.  The default is
6528 @option{-mno-thumb-interwork}, since slightly larger code is generated
6529 when @option{-mthumb-interwork} is specified.
6530
6531 @item -mno-sched-prolog
6532 @opindex mno-sched-prolog
6533 Prevent the reordering of instructions in the function prolog, or the
6534 merging of those instruction with the instructions in the function's
6535 body.  This means that all functions will start with a recognizable set
6536 of instructions (or in fact one of a choice from a small set of
6537 different function prologues), and this information can be used to
6538 locate the start if functions inside an executable piece of code.  The
6539 default is @option{-msched-prolog}.
6540
6541 @item -mhard-float
6542 @opindex mhard-float
6543 Generate output containing floating point instructions.  This is the
6544 default.
6545
6546 @item -msoft-float
6547 @opindex msoft-float
6548 Generate output containing library calls for floating point.
6549 @strong{Warning:} the requisite libraries are not available for all ARM
6550 targets.  Normally the facilities of the machine's usual C compiler are
6551 used, but this cannot be done directly in cross-compilation.  You must make
6552 your own arrangements to provide suitable library functions for
6553 cross-compilation.
6554
6555 @option{-msoft-float} changes the calling convention in the output file;
6556 therefore, it is only useful if you compile @emph{all} of a program with
6557 this option.  In particular, you need to compile @file{libgcc.a}, the
6558 library that comes with GCC, with @option{-msoft-float} in order for
6559 this to work.
6560
6561 @item -mlittle-endian
6562 @opindex mlittle-endian
6563 Generate code for a processor running in little-endian mode.  This is
6564 the default for all standard configurations.
6565
6566 @item -mbig-endian
6567 @opindex mbig-endian
6568 Generate code for a processor running in big-endian mode; the default is
6569 to compile code for a little-endian processor.
6570
6571 @item -mwords-little-endian
6572 @opindex mwords-little-endian
6573 This option only applies when generating code for big-endian processors.
6574 Generate code for a little-endian word order but a big-endian byte
6575 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6576 option should only be used if you require compatibility with code for
6577 big-endian ARM processors generated by versions of the compiler prior to
6578 2.8.
6579
6580 @item -malignment-traps
6581 @opindex malignment-traps
6582 Generate code that will not trap if the MMU has alignment traps enabled.
6583 On ARM architectures prior to ARMv4, there were no instructions to
6584 access half-word objects stored in memory.  However, when reading from
6585 memory a feature of the ARM architecture allows a word load to be used,
6586 even if the address is unaligned, and the processor core will rotate the
6587 data as it is being loaded.  This option tells the compiler that such
6588 misaligned accesses will cause a MMU trap and that it should instead
6589 synthesize the access as a series of byte accesses.  The compiler can
6590 still use word accesses to load half-word data if it knows that the
6591 address is aligned to a word boundary.
6592
6593 This option has no effect when compiling for ARM architecture 4 or later,
6594 since these processors have instructions to directly access half-word
6595 objects in memory.
6596
6597 @item -mno-alignment-traps
6598 @opindex mno-alignment-traps
6599 Generate code that assumes that the MMU will not trap unaligned
6600 accesses.  This produces better code when the target instruction set
6601 does not have half-word memory operations (i.e.@: implementations prior to
6602 ARMv4).
6603
6604 Note that you cannot use this option to access unaligned word objects,
6605 since the processor will only fetch one 32-bit aligned object from
6606 memory.
6607
6608 The default setting is @option{-malignment-traps}, since this produces
6609 code that will also run on processors implementing ARM architecture
6610 version 6 or later.
6611
6612 This option is deprecated and will be removed in the next release of GCC.
6613
6614 @item -mcpu=@var{name}
6615 @opindex mcpu
6616 This specifies the name of the target ARM processor.  GCC uses this name
6617 to determine what kind of instructions it can emit when generating
6618 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6619 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6620 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6621 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6622 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6623 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6624 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6625 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6626 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6627 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6628 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6629 @samp{ep9312}.
6630
6631 @itemx -mtune=@var{name}
6632 @opindex mtune
6633 This option is very similar to the @option{-mcpu=} option, except that
6634 instead of specifying the actual target processor type, and hence
6635 restricting which instructions can be used, it specifies that GCC should
6636 tune the performance of the code as if the target were of the type
6637 specified in this option, but still choosing the instructions that it
6638 will generate based on the cpu specified by a @option{-mcpu=} option.
6639 For some ARM implementations better performance can be obtained by using
6640 this option.
6641
6642 @item -march=@var{name}
6643 @opindex march
6644 This specifies the name of the target ARM architecture.  GCC uses this
6645 name to determine what kind of instructions it can emit when generating
6646 assembly code.  This option can be used in conjunction with or instead
6647 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6648 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6649 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6650 @samp{iwmmxt}, @samp{ep9312}.
6651
6652 @item -mfpe=@var{number}
6653 @itemx -mfp=@var{number}
6654 @opindex mfpe
6655 @opindex mfp
6656 This specifies the version of the floating point emulation available on
6657 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6658 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6659
6660 @item -mstructure-size-boundary=@var{n}
6661 @opindex mstructure-size-boundary
6662 The size of all structures and unions will be rounded up to a multiple
6663 of the number of bits set by this option.  Permissible values are 8 and
6664 32.  The default value varies for different toolchains.  For the COFF
6665 targeted toolchain the default value is 8.  Specifying the larger number
6666 can produce faster, more efficient code, but can also increase the size
6667 of the program.  The two values are potentially incompatible.  Code
6668 compiled with one value cannot necessarily expect to work with code or
6669 libraries compiled with the other value, if they exchange information
6670 using structures or unions.
6671
6672 @item -mabort-on-noreturn
6673 @opindex mabort-on-noreturn
6674 Generate a call to the function @code{abort} at the end of a
6675 @code{noreturn} function.  It will be executed if the function tries to
6676 return.
6677
6678 @item -mlong-calls
6679 @itemx -mno-long-calls
6680 @opindex mlong-calls
6681 @opindex mno-long-calls
6682 Tells the compiler to perform function calls by first loading the
6683 address of the function into a register and then performing a subroutine
6684 call on this register.  This switch is needed if the target function
6685 will lie outside of the 64 megabyte addressing range of the offset based
6686 version of subroutine call instruction.
6687
6688 Even if this switch is enabled, not all function calls will be turned
6689 into long calls.  The heuristic is that static functions, functions
6690 which have the @samp{short-call} attribute, functions that are inside
6691 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6692 definitions have already been compiled within the current compilation
6693 unit, will not be turned into long calls.  The exception to this rule is
6694 that weak function definitions, functions with the @samp{long-call}
6695 attribute or the @samp{section} attribute, and functions that are within
6696 the scope of a @samp{#pragma long_calls} directive, will always be
6697 turned into long calls.
6698
6699 This feature is not enabled by default.  Specifying
6700 @option{-mno-long-calls} will restore the default behavior, as will
6701 placing the function calls within the scope of a @samp{#pragma
6702 long_calls_off} directive.  Note these switches have no effect on how
6703 the compiler generates code to handle function calls via function
6704 pointers.
6705
6706 @item -mnop-fun-dllimport
6707 @opindex mnop-fun-dllimport
6708 Disable support for the @code{dllimport} attribute.
6709
6710 @item -msingle-pic-base
6711 @opindex msingle-pic-base
6712 Treat the register used for PIC addressing as read-only, rather than
6713 loading it in the prologue for each function.  The run-time system is
6714 responsible for initializing this register with an appropriate value
6715 before execution begins.
6716
6717 @item -mpic-register=@var{reg}
6718 @opindex mpic-register
6719 Specify the register to be used for PIC addressing.  The default is R10
6720 unless stack-checking is enabled, when R9 is used.
6721
6722 @item -mcirrus-fix-invalid-insns
6723 @opindex mcirrus-fix-invalid-insns
6724 @opindex mno-cirrus-fix-invalid-insns
6725 Insert NOPs into the instruction stream to in order to work around
6726 problems with invalid Maverick instruction combinations.  This option
6727 is only valid if the @option{-mcpu=ep9312} option has been used to
6728 enable generation of instructions for the Cirrus Maverick floating
6729 point co-processor.  This option is not enabled by default, since the
6730 problem is only present in older Maverick implementations.  The default
6731 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6732 switch.
6733
6734 @item -mpoke-function-name
6735 @opindex mpoke-function-name
6736 Write the name of each function into the text section, directly
6737 preceding the function prologue.  The generated code is similar to this:
6738
6739 @smallexample
6740      t0
6741          .ascii "arm_poke_function_name", 0
6742          .align
6743      t1
6744          .word 0xff000000 + (t1 - t0)
6745      arm_poke_function_name
6746          mov     ip, sp
6747          stmfd   sp!, @{fp, ip, lr, pc@}
6748          sub     fp, ip, #4
6749 @end smallexample
6750
6751 When performing a stack backtrace, code can inspect the value of
6752 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6753 location @code{pc - 12} and the top 8 bits are set, then we know that
6754 there is a function name embedded immediately preceding this location
6755 and has length @code{((pc[-3]) & 0xff000000)}.
6756
6757 @item -mthumb
6758 @opindex mthumb
6759 Generate code for the 16-bit Thumb instruction set.  The default is to
6760 use the 32-bit ARM instruction set.
6761
6762 @item -mtpcs-frame
6763 @opindex mtpcs-frame
6764 Generate a stack frame that is compliant with the Thumb Procedure Call
6765 Standard for all non-leaf functions.  (A leaf function is one that does
6766 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6767
6768 @item -mtpcs-leaf-frame
6769 @opindex mtpcs-leaf-frame
6770 Generate a stack frame that is compliant with the Thumb Procedure Call
6771 Standard for all leaf functions.  (A leaf function is one that does
6772 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6773
6774 @item -mcallee-super-interworking
6775 @opindex mcallee-super-interworking
6776 Gives all externally visible functions in the file being compiled an ARM
6777 instruction set header which switches to Thumb mode before executing the
6778 rest of the function.  This allows these functions to be called from
6779 non-interworking code.
6780
6781 @item -mcaller-super-interworking
6782 @opindex mcaller-super-interworking
6783 Allows calls via function pointers (including virtual functions) to
6784 execute correctly regardless of whether the target code has been
6785 compiled for interworking or not.  There is a small overhead in the cost
6786 of executing a function pointer if this option is enabled.
6787
6788 @end table
6789
6790 @node MN10300 Options
6791 @subsection MN10300 Options
6792 @cindex MN10300 options
6793
6794 These @option{-m} options are defined for Matsushita MN10300 architectures:
6795
6796 @table @gcctabopt
6797 @item -mmult-bug
6798 @opindex mmult-bug
6799 Generate code to avoid bugs in the multiply instructions for the MN10300
6800 processors.  This is the default.
6801
6802 @item -mno-mult-bug
6803 @opindex mno-mult-bug
6804 Do not generate code to avoid bugs in the multiply instructions for the
6805 MN10300 processors.
6806
6807 @item -mam33
6808 @opindex mam33
6809 Generate code which uses features specific to the AM33 processor.
6810
6811 @item -mno-am33
6812 @opindex mno-am33
6813 Do not generate code which uses features specific to the AM33 processor.  This
6814 is the default.
6815
6816 @item -mno-crt0
6817 @opindex mno-crt0
6818 Do not link in the C run-time initialization object file.
6819
6820 @item -mrelax
6821 @opindex mrelax
6822 Indicate to the linker that it should perform a relaxation optimization pass
6823 to shorten branches, calls and absolute memory addresses.  This option only
6824 has an effect when used on the command line for the final link step.
6825
6826 This option makes symbolic debugging impossible.
6827 @end table
6828
6829
6830 @node M32R/D Options
6831 @subsection M32R/D Options
6832 @cindex M32R/D options
6833
6834 These @option{-m} options are defined for Renesas M32R/D architectures:
6835
6836 @table @gcctabopt
6837 @item -m32r2
6838 @opindex m32r2
6839 Generate code for the M32R/2@.
6840
6841 @item -m32rx
6842 @opindex m32rx
6843 Generate code for the M32R/X@.
6844
6845 @item -m32r
6846 @opindex m32r
6847 Generate code for the M32R@.  This is the default.
6848
6849 @item -mmodel=small
6850 @opindex mmodel=small
6851 Assume all objects live in the lower 16MB of memory (so that their addresses
6852 can be loaded with the @code{ld24} instruction), and assume all subroutines
6853 are reachable with the @code{bl} instruction.
6854 This is the default.
6855
6856 The addressability of a particular object can be set with the
6857 @code{model} attribute.
6858
6859 @item -mmodel=medium
6860 @opindex mmodel=medium
6861 Assume objects may be anywhere in the 32-bit address space (the compiler
6862 will generate @code{seth/add3} instructions to load their addresses), and
6863 assume all subroutines are reachable with the @code{bl} instruction.
6864
6865 @item -mmodel=large
6866 @opindex mmodel=large
6867 Assume objects may be anywhere in the 32-bit address space (the compiler
6868 will generate @code{seth/add3} instructions to load their addresses), and
6869 assume subroutines may not be reachable with the @code{bl} instruction
6870 (the compiler will generate the much slower @code{seth/add3/jl}
6871 instruction sequence).
6872
6873 @item -msdata=none
6874 @opindex msdata=none
6875 Disable use of the small data area.  Variables will be put into
6876 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6877 @code{section} attribute has been specified).
6878 This is the default.
6879
6880 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6881 Objects may be explicitly put in the small data area with the
6882 @code{section} attribute using one of these sections.
6883
6884 @item -msdata=sdata
6885 @opindex msdata=sdata
6886 Put small global and static data in the small data area, but do not
6887 generate special code to reference them.
6888
6889 @item -msdata=use
6890 @opindex msdata=use
6891 Put small global and static data in the small data area, and generate
6892 special instructions to reference them.
6893
6894 @item -G @var{num}
6895 @opindex G
6896 @cindex smaller data references
6897 Put global and static objects less than or equal to @var{num} bytes
6898 into the small data or bss sections instead of the normal data or bss
6899 sections.  The default value of @var{num} is 8.
6900 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6901 for this option to have any effect.
6902
6903 All modules should be compiled with the same @option{-G @var{num}} value.
6904 Compiling with different values of @var{num} may or may not work; if it
6905 doesn't the linker will give an error message---incorrect code will not be
6906 generated.
6907
6908 @item -mdebug
6909 @opindex mdebug
6910 Makes the M32R specific code in the compiler display some statistics
6911 that might help in debugging programs.
6912
6913 @item -malign-loops
6914 @opindex malign-loops
6915 Align all loops to a 32-byte boundary.
6916
6917 @item -mno-align-loops
6918 @opindex mno-align-loops
6919 Do not enforce a 32-byte alignment for loops.  This is the default.
6920
6921 @item -missue-rate=@var{number}
6922 @opindex missue-rate=@var{number}
6923 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6924 or 2.
6925
6926 @item -mbranch-cost=@var{number}
6927 @opindex mbranch-cost=@var{number}
6928 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6929 preferred over conditional code, if it is 2, then the opposite will
6930 apply.
6931
6932 @item -mflush-trap=@var{number}
6933 @opindex mflush-trap=@var{number}
6934 Specifies the trap number to use to flush the cache.  The default is
6935 12.  Valid numbers are between 0 and 15 inclusive.
6936
6937 @item -mno-flush-trap
6938 @opindex mno-flush-trap
6939 Specifies that the cache cannot be flushed by using a trap.
6940
6941 @item -mflush-func=@var{name}
6942 @opindex mflush-func=@var{name}
6943 Specifies the name of the operating system function to call to flush
6944 the cache.  The default is @emph{_flush_cache}, but a function call
6945 will only be used if a trap is not available.
6946
6947 @item -mno-flush-func
6948 @opindex mno-flush-func
6949 Indicates that there is no OS function for flushing the cache.
6950
6951 @end table
6952
6953 @node RS/6000 and PowerPC Options
6954 @subsection IBM RS/6000 and PowerPC Options
6955 @cindex RS/6000 and PowerPC Options
6956 @cindex IBM RS/6000 and PowerPC Options
6957
6958 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6959 @table @gcctabopt
6960 @item -mpower
6961 @itemx -mno-power
6962 @itemx -mpower2
6963 @itemx -mno-power2
6964 @itemx -mpowerpc
6965 @itemx -mno-powerpc
6966 @itemx -mpowerpc-gpopt
6967 @itemx -mno-powerpc-gpopt
6968 @itemx -mpowerpc-gfxopt
6969 @itemx -mno-powerpc-gfxopt
6970 @itemx -mpowerpc64
6971 @itemx -mno-powerpc64
6972 @opindex mpower
6973 @opindex mno-power
6974 @opindex mpower2
6975 @opindex mno-power2
6976 @opindex mpowerpc
6977 @opindex mno-powerpc
6978 @opindex mpowerpc-gpopt
6979 @opindex mno-powerpc-gpopt
6980 @opindex mpowerpc-gfxopt
6981 @opindex mno-powerpc-gfxopt
6982 @opindex mpowerpc64
6983 @opindex mno-powerpc64
6984 GCC supports two related instruction set architectures for the
6985 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6986 instructions supported by the @samp{rios} chip set used in the original
6987 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6988 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6989 the IBM 4xx microprocessors.
6990
6991 Neither architecture is a subset of the other.  However there is a
6992 large common subset of instructions supported by both.  An MQ
6993 register is included in processors supporting the POWER architecture.
6994
6995 You use these options to specify which instructions are available on the
6996 processor you are using.  The default value of these options is
6997 determined when configuring GCC@.  Specifying the
6998 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6999 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
7000 rather than the options listed above.
7001
7002 The @option{-mpower} option allows GCC to generate instructions that
7003 are found only in the POWER architecture and to use the MQ register.
7004 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7005 to generate instructions that are present in the POWER2 architecture but
7006 not the original POWER architecture.
7007
7008 The @option{-mpowerpc} option allows GCC to generate instructions that
7009 are found only in the 32-bit subset of the PowerPC architecture.
7010 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7011 GCC to use the optional PowerPC architecture instructions in the
7012 General Purpose group, including floating-point square root.  Specifying
7013 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7014 use the optional PowerPC architecture instructions in the Graphics
7015 group, including floating-point select.
7016
7017 The @option{-mpowerpc64} option allows GCC to generate the additional
7018 64-bit instructions that are found in the full PowerPC64 architecture
7019 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7020 @option{-mno-powerpc64}.
7021
7022 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7023 will use only the instructions in the common subset of both
7024 architectures plus some special AIX common-mode calls, and will not use
7025 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7026 permits GCC to use any instruction from either architecture and to
7027 allow use of the MQ register; specify this for the Motorola MPC601.
7028
7029 @item -mnew-mnemonics
7030 @itemx -mold-mnemonics
7031 @opindex mnew-mnemonics
7032 @opindex mold-mnemonics
7033 Select which mnemonics to use in the generated assembler code.  With
7034 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7035 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7036 assembler mnemonics defined for the POWER architecture.  Instructions
7037 defined in only one architecture have only one mnemonic; GCC uses that
7038 mnemonic irrespective of which of these options is specified.
7039
7040 GCC defaults to the mnemonics appropriate for the architecture in
7041 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7042 value of these option.  Unless you are building a cross-compiler, you
7043 should normally not specify either @option{-mnew-mnemonics} or
7044 @option{-mold-mnemonics}, but should instead accept the default.
7045
7046 @item -mcpu=@var{cpu_type}
7047 @opindex mcpu
7048 Set architecture type, register usage, choice of mnemonics, and
7049 instruction scheduling parameters for machine type @var{cpu_type}.
7050 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7051 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7052 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7053 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7054 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7055 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
7056 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7057 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
7058 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7059
7060 @option{-mcpu=common} selects a completely generic processor.  Code
7061 generated under this option will run on any POWER or PowerPC processor.
7062 GCC will use only the instructions in the common subset of both
7063 architectures, and will not use the MQ register.  GCC assumes a generic
7064 processor model for scheduling purposes.
7065
7066 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7067 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7068 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7069 types, with an appropriate, generic processor model assumed for
7070 scheduling purposes.
7071
7072 The other options specify a specific processor.  Code generated under
7073 those options will run best on that processor, and may not run at all on
7074 others.
7075
7076 The @option{-mcpu} options automatically enable or disable the
7077 following options: @option{-maltivec}, @option{-mhard-float},
7078 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7079 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7080 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7081 @option{-mstring}.  The particular options set for any particular CPU
7082 will vary between compiler versions, depending on what setting seems
7083 to produce optimal code for that CPU; it doesn't necessarily reflect
7084 the actual hardware's capabilities.  If you wish to set an individual
7085 option to a particular value, you may specify it after the
7086 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7087
7088 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7089 not enabled or disabled by the @option{-mcpu} option at present, since
7090 AIX does not have full support for these options.  You may still
7091 enable or disable them individually if you're sure it'll work in your
7092 environment.
7093
7094 @item -mtune=@var{cpu_type}
7095 @opindex mtune
7096 Set the instruction scheduling parameters for machine type
7097 @var{cpu_type}, but do not set the architecture type, register usage, or
7098 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7099 values for @var{cpu_type} are used for @option{-mtune} as for
7100 @option{-mcpu}.  If both are specified, the code generated will use the
7101 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7102 scheduling parameters set by @option{-mtune}.
7103
7104 @item -maltivec
7105 @itemx -mno-altivec
7106 @opindex maltivec
7107 @opindex mno-altivec
7108 These switches enable or disable the use of built-in functions that
7109 allow access to the AltiVec instruction set.  You may also need to set
7110 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7111 enhancements.
7112
7113 @item -mabi=spe
7114 @opindex mabi=spe
7115 Extend the current ABI with SPE ABI extensions.  This does not change
7116 the default ABI, instead it adds the SPE ABI extensions to the current
7117 ABI@.
7118
7119 @item -mabi=no-spe
7120 @opindex mabi=no-spe
7121 Disable Booke SPE ABI extensions for the current ABI.
7122
7123 @item -misel=@var{yes/no}
7124 @itemx -misel
7125 @opindex misel
7126 This switch enables or disables the generation of ISEL instructions.
7127
7128 @item -mspe=@var{yes/no}
7129 @itemx -mspe
7130 @opindex mspe
7131 This switch enables or disables the generation of SPE simd
7132 instructions.
7133
7134 @item -mfloat-gprs=@var{yes/no}
7135 @itemx -mfloat-gprs
7136 @opindex mfloat-gprs
7137 This switch enables or disables the generation of floating point
7138 operations on the general purpose registers for architectures that
7139 support it.  This option is currently only available on the MPC8540.
7140
7141 @item -mfull-toc
7142 @itemx -mno-fp-in-toc
7143 @itemx -mno-sum-in-toc
7144 @itemx -mminimal-toc
7145 @opindex mfull-toc
7146 @opindex mno-fp-in-toc
7147 @opindex mno-sum-in-toc
7148 @opindex mminimal-toc
7149 Modify generation of the TOC (Table Of Contents), which is created for
7150 every executable file.  The @option{-mfull-toc} option is selected by
7151 default.  In that case, GCC will allocate at least one TOC entry for
7152 each unique non-automatic variable reference in your program.  GCC
7153 will also place floating-point constants in the TOC@.  However, only
7154 16,384 entries are available in the TOC@.
7155
7156 If you receive a linker error message that saying you have overflowed
7157 the available TOC space, you can reduce the amount of TOC space used
7158 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7159 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7160 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7161 generate code to calculate the sum of an address and a constant at
7162 run-time instead of putting that sum into the TOC@.  You may specify one
7163 or both of these options.  Each causes GCC to produce very slightly
7164 slower and larger code at the expense of conserving TOC space.
7165
7166 If you still run out of space in the TOC even when you specify both of
7167 these options, specify @option{-mminimal-toc} instead.  This option causes
7168 GCC to make only one TOC entry for every file.  When you specify this
7169 option, GCC will produce code that is slower and larger but which
7170 uses extremely little TOC space.  You may wish to use this option
7171 only on files that contain less frequently executed code.
7172
7173 @item -maix64
7174 @itemx -maix32
7175 @opindex maix64
7176 @opindex maix32
7177 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7178 @code{long} type, and the infrastructure needed to support them.
7179 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7180 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7181 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7182
7183 @item -mxl-compat
7184 @itemx -mno-xl-compat
7185 @opindex mxl-compat
7186 @opindex mno-xl-compat
7187 Produce code that conforms more closely to IBM XLC semantics when using
7188 AIX-compatible ABI.  Pass floating-point arguments to prototyped
7189 functions beyond the register save area (RSA) on the stack in addition
7190 to argument FPRs.  Do not assume that most significant double in 128
7191 bit long double value is properly rounded when comparing values.
7192
7193 The AIX calling convention was extended but not initially documented to
7194 handle an obscure K&R C case of calling a function that takes the
7195 address of its arguments with fewer arguments than declared.  AIX XL
7196 compilers access floating point arguments which do not fit in the
7197 RSA from the stack when a subroutine is compiled without
7198 optimization.  Because always storing floating-point arguments on the
7199 stack is inefficient and rarely needed, this option is not enabled by
7200 default and only is necessary when calling subroutines compiled by AIX
7201 XL compilers without optimization.
7202
7203 @item -mpe
7204 @opindex mpe
7205 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7206 application written to use message passing with special startup code to
7207 enable the application to run.  The system must have PE installed in the
7208 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7209 must be overridden with the @option{-specs=} option to specify the
7210 appropriate directory location.  The Parallel Environment does not
7211 support threads, so the @option{-mpe} option and the @option{-pthread}
7212 option are incompatible.
7213
7214 @item -malign-natural
7215 @itemx -malign-power
7216 @opindex malign-natural
7217 @opindex malign-power
7218 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
7219 @option{-malign-natural} overrides the ABI-defined alignment of larger
7220 types, such as floating-point doubles, on their natural size-based boundary.
7221 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7222 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7223
7224 @item -msoft-float
7225 @itemx -mhard-float
7226 @opindex msoft-float
7227 @opindex mhard-float
7228 Generate code that does not use (uses) the floating-point register set.
7229 Software floating point emulation is provided if you use the
7230 @option{-msoft-float} option, and pass the option to GCC when linking.
7231
7232 @item -mmultiple
7233 @itemx -mno-multiple
7234 @opindex mmultiple
7235 @opindex mno-multiple
7236 Generate code that uses (does not use) the load multiple word
7237 instructions and the store multiple word instructions.  These
7238 instructions are generated by default on POWER systems, and not
7239 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7240 endian PowerPC systems, since those instructions do not work when the
7241 processor is in little endian mode.  The exceptions are PPC740 and
7242 PPC750 which permit the instructions usage in little endian mode.
7243
7244 @item -mstring
7245 @itemx -mno-string
7246 @opindex mstring
7247 @opindex mno-string
7248 Generate code that uses (does not use) the load string instructions
7249 and the store string word instructions to save multiple registers and
7250 do small block moves.  These instructions are generated by default on
7251 POWER systems, and not generated on PowerPC systems.  Do not use
7252 @option{-mstring} on little endian PowerPC systems, since those
7253 instructions do not work when the processor is in little endian mode.
7254 The exceptions are PPC740 and PPC750 which permit the instructions
7255 usage in little endian mode.
7256
7257 @item -mupdate
7258 @itemx -mno-update
7259 @opindex mupdate
7260 @opindex mno-update
7261 Generate code that uses (does not use) the load or store instructions
7262 that update the base register to the address of the calculated memory
7263 location.  These instructions are generated by default.  If you use
7264 @option{-mno-update}, there is a small window between the time that the
7265 stack pointer is updated and the address of the previous frame is
7266 stored, which means code that walks the stack frame across interrupts or
7267 signals may get corrupted data.
7268
7269 @item -mfused-madd
7270 @itemx -mno-fused-madd
7271 @opindex mfused-madd
7272 @opindex mno-fused-madd
7273 Generate code that uses (does not use) the floating point multiply and
7274 accumulate instructions.  These instructions are generated by default if
7275 hardware floating is used.
7276
7277 @item -mno-bit-align
7278 @itemx -mbit-align
7279 @opindex mno-bit-align
7280 @opindex mbit-align
7281 On System V.4 and embedded PowerPC systems do not (do) force structures
7282 and unions that contain bit-fields to be aligned to the base type of the
7283 bit-field.
7284
7285 For example, by default a structure containing nothing but 8
7286 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7287 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7288 the structure would be aligned to a 1 byte boundary and be one byte in
7289 size.
7290
7291 @item -mno-strict-align
7292 @itemx -mstrict-align
7293 @opindex mno-strict-align
7294 @opindex mstrict-align
7295 On System V.4 and embedded PowerPC systems do not (do) assume that
7296 unaligned memory references will be handled by the system.
7297
7298 @item -mrelocatable
7299 @itemx -mno-relocatable
7300 @opindex mrelocatable
7301 @opindex mno-relocatable
7302 On embedded PowerPC systems generate code that allows (does not allow)
7303 the program to be relocated to a different address at runtime.  If you
7304 use @option{-mrelocatable} on any module, all objects linked together must
7305 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7306
7307 @item -mrelocatable-lib
7308 @itemx -mno-relocatable-lib
7309 @opindex mrelocatable-lib
7310 @opindex mno-relocatable-lib
7311 On embedded PowerPC systems generate code that allows (does not allow)
7312 the program to be relocated to a different address at runtime.  Modules
7313 compiled with @option{-mrelocatable-lib} can be linked with either modules
7314 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7315 with modules compiled with the @option{-mrelocatable} options.
7316
7317 @item -mno-toc
7318 @itemx -mtoc
7319 @opindex mno-toc
7320 @opindex mtoc
7321 On System V.4 and embedded PowerPC systems do not (do) assume that
7322 register 2 contains a pointer to a global area pointing to the addresses
7323 used in the program.
7324
7325 @item -mlittle
7326 @itemx -mlittle-endian
7327 @opindex mlittle
7328 @opindex mlittle-endian
7329 On System V.4 and embedded PowerPC systems compile code for the
7330 processor in little endian mode.  The @option{-mlittle-endian} option is
7331 the same as @option{-mlittle}.
7332
7333 @item -mbig
7334 @itemx -mbig-endian
7335 @opindex mbig
7336 @opindex mbig-endian
7337 On System V.4 and embedded PowerPC systems compile code for the
7338 processor in big endian mode.  The @option{-mbig-endian} option is
7339 the same as @option{-mbig}.
7340
7341 @item -mdynamic-no-pic
7342 @opindex mdynamic-no-pic
7343 On Darwin and Mac OS X systems, compile code so that it is not
7344 relocatable, but that its external references are relocatable.  The
7345 resulting code is suitable for applications, but not shared
7346 libraries.
7347
7348 @item -mprioritize-restricted-insns=@var{priority}
7349 @opindex mprioritize-restricted-insns
7350 This option controls the priority that is assigned to
7351 dispatch-slot restricted instructions during the second scheduling
7352 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
7353 @var{no/highest/second-highest} priority to dispatch slot restricted
7354 instructions.
7355
7356 @item -msched-costly-dep=@var{dependence_type}
7357 @opindex msched-costly-dep
7358 This option controls which dependences are considered costly
7359 by the target during instruction scheduling.  The argument
7360 @var{dependence_type} takes one of the following values:
7361 @var{no}: no dependence is costly,
7362 @var{all}: all dependences are costly,
7363 @var{true_store_to_load}: a true dependence from store to load is costly,
7364 @var{store_to_load}: any dependence from store to load is costly,
7365 @var{number}: any dependence which latency >= @var{number} is costly.
7366
7367 @item -minsert-sched-nops=@var{scheme}
7368 @opindex minsert-sched-nops
7369 This option controls which nop insertion scheme will be used during
7370 the second scheduling pass. The argument @var{scheme} takes one of the
7371 following values:
7372 @var{no}: Don't insert nops.
7373 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7374 according to the scheduler's grouping.
7375 @var{regroup_exact}: Insert nops to force costly dependent insns into
7376 separate groups.  Insert exactly as many nops as needed to force an insn
7377 to a new group, according to the estimated processor grouping.
7378 @var{number}: Insert nops to force costly dependent insns into
7379 separate groups.  Insert @var{number} nops to force an insn to a new group.
7380
7381 @item -mcall-sysv
7382 @opindex mcall-sysv
7383 On System V.4 and embedded PowerPC systems compile code using calling
7384 conventions that adheres to the March 1995 draft of the System V
7385 Application Binary Interface, PowerPC processor supplement.  This is the
7386 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7387
7388 @item -mcall-sysv-eabi
7389 @opindex mcall-sysv-eabi
7390 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7391
7392 @item -mcall-sysv-noeabi
7393 @opindex mcall-sysv-noeabi
7394 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7395
7396 @item -mcall-solaris
7397 @opindex mcall-solaris
7398 On System V.4 and embedded PowerPC systems compile code for the Solaris
7399 operating system.
7400
7401 @item -mcall-linux
7402 @opindex mcall-linux
7403 On System V.4 and embedded PowerPC systems compile code for the
7404 Linux-based GNU system.
7405
7406 @item -mcall-gnu
7407 @opindex mcall-gnu
7408 On System V.4 and embedded PowerPC systems compile code for the
7409 Hurd-based GNU system.
7410
7411 @item -mcall-netbsd
7412 @opindex mcall-netbsd
7413 On System V.4 and embedded PowerPC systems compile code for the
7414 NetBSD operating system.
7415
7416 @item -maix-struct-return
7417 @opindex maix-struct-return
7418 Return all structures in memory (as specified by the AIX ABI)@.
7419
7420 @item -msvr4-struct-return
7421 @opindex msvr4-struct-return
7422 Return structures smaller than 8 bytes in registers (as specified by the
7423 SVR4 ABI)@.
7424
7425 @item -mabi=altivec
7426 @opindex mabi=altivec
7427 Extend the current ABI with AltiVec ABI extensions.  This does not
7428 change the default ABI, instead it adds the AltiVec ABI extensions to
7429 the current ABI@.
7430
7431 @item -mabi=no-altivec
7432 @opindex mabi=no-altivec
7433 Disable AltiVec ABI extensions for the current ABI.
7434
7435 @item -mprototype
7436 @itemx -mno-prototype
7437 @opindex mprototype
7438 @opindex mno-prototype
7439 On System V.4 and embedded PowerPC systems assume that all calls to
7440 variable argument functions are properly prototyped.  Otherwise, the
7441 compiler must insert an instruction before every non prototyped call to
7442 set or clear bit 6 of the condition code register (@var{CR}) to
7443 indicate whether floating point values were passed in the floating point
7444 registers in case the function takes a variable arguments.  With
7445 @option{-mprototype}, only calls to prototyped variable argument functions
7446 will set or clear the bit.
7447
7448 @item -msim
7449 @opindex msim
7450 On embedded PowerPC systems, assume that the startup module is called
7451 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7452 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7453 configurations.
7454
7455 @item -mmvme
7456 @opindex mmvme
7457 On embedded PowerPC systems, assume that the startup module is called
7458 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7459 @file{libc.a}.
7460
7461 @item -mads
7462 @opindex mads
7463 On embedded PowerPC systems, assume that the startup module is called
7464 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7465 @file{libc.a}.
7466
7467 @item -myellowknife
7468 @opindex myellowknife
7469 On embedded PowerPC systems, assume that the startup module is called
7470 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7471 @file{libc.a}.
7472
7473 @item -mvxworks
7474 @opindex mvxworks
7475 On System V.4 and embedded PowerPC systems, specify that you are
7476 compiling for a VxWorks system.
7477
7478 @item -mwindiss
7479 @opindex mwindiss
7480 Specify that you are compiling for the WindISS simulation environment.
7481
7482 @item -memb
7483 @opindex memb
7484 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7485 header to indicate that @samp{eabi} extended relocations are used.
7486
7487 @item -meabi
7488 @itemx -mno-eabi
7489 @opindex meabi
7490 @opindex mno-eabi
7491 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7492 Embedded Applications Binary Interface (eabi) which is a set of
7493 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7494 means that the stack is aligned to an 8 byte boundary, a function
7495 @code{__eabi} is called to from @code{main} to set up the eabi
7496 environment, and the @option{-msdata} option can use both @code{r2} and
7497 @code{r13} to point to two separate small data areas.  Selecting
7498 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7499 do not call an initialization function from @code{main}, and the
7500 @option{-msdata} option will only use @code{r13} to point to a single
7501 small data area.  The @option{-meabi} option is on by default if you
7502 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7503
7504 @item -msdata=eabi
7505 @opindex msdata=eabi
7506 On System V.4 and embedded PowerPC systems, put small initialized
7507 @code{const} global and static data in the @samp{.sdata2} section, which
7508 is pointed to by register @code{r2}.  Put small initialized
7509 non-@code{const} global and static data in the @samp{.sdata} section,
7510 which is pointed to by register @code{r13}.  Put small uninitialized
7511 global and static data in the @samp{.sbss} section, which is adjacent to
7512 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7513 incompatible with the @option{-mrelocatable} option.  The
7514 @option{-msdata=eabi} option also sets the @option{-memb} option.
7515
7516 @item -msdata=sysv
7517 @opindex msdata=sysv
7518 On System V.4 and embedded PowerPC systems, put small global and static
7519 data in the @samp{.sdata} section, which is pointed to by register
7520 @code{r13}.  Put small uninitialized global and static data in the
7521 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7522 The @option{-msdata=sysv} option is incompatible with the
7523 @option{-mrelocatable} option.
7524
7525 @item -msdata=default
7526 @itemx -msdata
7527 @opindex msdata=default
7528 @opindex msdata
7529 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7530 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7531 same as @option{-msdata=sysv}.
7532
7533 @item -msdata-data
7534 @opindex msdata-data
7535 On System V.4 and embedded PowerPC systems, put small global and static
7536 data in the @samp{.sdata} section.  Put small uninitialized global and
7537 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7538 to address small data however.  This is the default behavior unless
7539 other @option{-msdata} options are used.
7540
7541 @item -msdata=none
7542 @itemx -mno-sdata
7543 @opindex msdata=none
7544 @opindex mno-sdata
7545 On embedded PowerPC systems, put all initialized global and static data
7546 in the @samp{.data} section, and all uninitialized data in the
7547 @samp{.bss} section.
7548
7549 @item -G @var{num}
7550 @opindex G
7551 @cindex smaller data references (PowerPC)
7552 @cindex .sdata/.sdata2 references (PowerPC)
7553 On embedded PowerPC systems, put global and static items less than or
7554 equal to @var{num} bytes into the small data or bss sections instead of
7555 the normal data or bss section.  By default, @var{num} is 8.  The
7556 @option{-G @var{num}} switch is also passed to the linker.
7557 All modules should be compiled with the same @option{-G @var{num}} value.
7558
7559 @item -mregnames
7560 @itemx -mno-regnames
7561 @opindex mregnames
7562 @opindex mno-regnames
7563 On System V.4 and embedded PowerPC systems do (do not) emit register
7564 names in the assembly language output using symbolic forms.
7565
7566 @item -mlongcall
7567 @itemx -mno-longcall
7568 @opindex mlongcall
7569 @opindex mno-longcall
7570 Default to making all function calls via pointers, so that functions
7571 which reside further than 64 megabytes (67,108,864 bytes) from the
7572 current location can be called.  This setting can be overridden by the
7573 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7574
7575 Some linkers are capable of detecting out-of-range calls and generating
7576 glue code on the fly.  On these systems, long calls are unnecessary and
7577 generate slower code.  As of this writing, the AIX linker can do this,
7578 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7579 to the GNU linker for 32-bit PowerPC systems as well.
7580
7581 On Mach-O (Darwin) systems, this option directs the compiler emit to
7582 the glue for every direct call, and the Darwin linker decides whether
7583 to use or discard it.
7584
7585 In the future, we may cause GCC to ignore all longcall specifications
7586 when the linker is known to generate glue.
7587
7588 @item -pthread
7589 @opindex pthread
7590 Adds support for multithreading with the @dfn{pthreads} library.
7591 This option sets flags for both the preprocessor and linker.
7592
7593 @end table
7594
7595 @node Darwin Options
7596 @subsection Darwin Options
7597 @cindex Darwin options
7598
7599 These options are defined for all architectures running the Darwin operating
7600 system.  They are useful for compatibility with other Mac OS compilers.
7601
7602 @table @gcctabopt
7603 @item -all_load
7604 @opindex all_load
7605 Loads all members of static archive libraries.
7606 See man ld(1) for more information.
7607
7608 @item -arch_errors_fatal
7609 @opindex arch_errors_fatal
7610 Cause the errors having to do with files that have the wrong architecture
7611 to be fatal.
7612
7613 @item -bind_at_load
7614 @opindex bind_at_load
7615 Causes the output file to be marked such that the dynamic linker will
7616 bind all undefined references when the file is loaded or launched.
7617
7618 @item -bundle
7619 @opindex bundle
7620 Produce a Mach-o bundle format file.
7621 See man ld(1) for more information.
7622
7623 @item -bundle_loader @var{executable}
7624 @opindex bundle_loader
7625 This specifies the @var{executable} that will be loading the build
7626 output file being linked. See man ld(1) for more information.
7627
7628 @item -allowable_client  @var{client_name}
7629 @itemx -arch_only
7630
7631 @itemx -client_name
7632 @itemx -compatibility_version
7633 @itemx -current_version
7634 @itemx -dependency-file
7635 @itemx -dylib_file
7636 @itemx -dylinker_install_name
7637 @itemx -dynamic
7638 @itemx -dynamiclib
7639 @itemx -exported_symbols_list
7640 @itemx -filelist
7641 @itemx -flat_namespace
7642 @itemx -force_cpusubtype_ALL
7643 @itemx -force_flat_namespace
7644 @itemx -headerpad_max_install_names
7645 @itemx -image_base
7646 @itemx -init
7647 @itemx -install_name
7648 @itemx -keep_private_externs
7649 @itemx -multi_module
7650 @itemx -multiply_defined
7651 @itemx -multiply_defined_unused
7652 @itemx -noall_load
7653 @itemx -nofixprebinding
7654 @itemx -nomultidefs
7655 @itemx -noprebind
7656 @itemx -noseglinkedit
7657 @itemx -pagezero_size
7658 @itemx -prebind
7659 @itemx -prebind_all_twolevel_modules
7660 @itemx -private_bundle
7661 @itemx -read_only_relocs
7662 @itemx -sectalign
7663 @itemx -sectobjectsymbols
7664 @itemx -whyload
7665 @itemx -seg1addr
7666 @itemx -sectcreate
7667 @itemx -sectobjectsymbols
7668 @itemx -sectorder
7669 @itemx -seg_addr_table
7670 @itemx -seg_addr_table_filename
7671 @itemx -seglinkedit
7672 @itemx -segprot
7673 @itemx -segs_read_only_addr
7674 @itemx -segs_read_write_addr
7675 @itemx -single_module
7676 @itemx -static
7677 @itemx -sub_library
7678 @itemx -sub_umbrella
7679 @itemx -twolevel_namespace
7680 @itemx -umbrella
7681 @itemx -undefined
7682 @itemx -unexported_symbols_list
7683 @itemx -weak_reference_mismatches
7684 @itemx -whatsloaded
7685
7686 @opindex allowable_client
7687 @opindex arch_only
7688 @opindex client_name
7689 @opindex compatibility_version
7690 @opindex current_version
7691 @opindex dependency-file
7692 @opindex dylib_file
7693 @opindex dylinker_install_name
7694 @opindex dynamic
7695 @opindex dynamiclib
7696 @opindex exported_symbols_list
7697 @opindex filelist
7698 @opindex flat_namespace
7699 @opindex force_cpusubtype_ALL
7700 @opindex force_flat_namespace
7701 @opindex headerpad_max_install_names
7702 @opindex image_base
7703 @opindex init
7704 @opindex install_name
7705 @opindex keep_private_externs
7706 @opindex multi_module
7707 @opindex multiply_defined
7708 @opindex multiply_defined_unused
7709 @opindex noall_load
7710 @opindex nofixprebinding
7711 @opindex nomultidefs
7712 @opindex noprebind
7713 @opindex noseglinkedit
7714 @opindex pagezero_size
7715 @opindex prebind
7716 @opindex prebind_all_twolevel_modules
7717 @opindex private_bundle
7718 @opindex read_only_relocs
7719 @opindex sectalign
7720 @opindex sectobjectsymbols
7721 @opindex whyload
7722 @opindex seg1addr
7723 @opindex sectcreate
7724 @opindex sectobjectsymbols
7725 @opindex sectorder
7726 @opindex seg_addr_table
7727 @opindex seg_addr_table_filename
7728 @opindex seglinkedit
7729 @opindex segprot
7730 @opindex segs_read_only_addr
7731 @opindex segs_read_write_addr
7732 @opindex single_module
7733 @opindex static
7734 @opindex sub_library
7735 @opindex sub_umbrella
7736 @opindex twolevel_namespace
7737 @opindex umbrella
7738 @opindex undefined
7739 @opindex unexported_symbols_list
7740 @opindex weak_reference_mismatches
7741 @opindex whatsloaded
7742
7743 These options are available for Darwin linker. Darwin linker man page
7744 describes them in detail.
7745 @end table
7746
7747
7748 @node MIPS Options
7749 @subsection MIPS Options
7750 @cindex MIPS options
7751
7752 @table @gcctabopt
7753
7754 @item -EB
7755 @opindex EB
7756 Generate big-endian code.
7757
7758 @item -EL
7759 @opindex EL
7760 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
7761 configurations.
7762
7763 @item -march=@var{arch}
7764 @opindex march
7765 Generate code that will run on @var{arch}, which can be the name of a
7766 generic MIPS ISA, or the name of a particular processor.
7767 The ISA names are:
7768 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7769 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7770 The processor names are:
7771 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7772 @samp{m4k},
7773 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7774 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7775 @samp{rm9000},
7776 @samp{orion},
7777 @samp{sb1},
7778 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7779 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7780 The special value @samp{from-abi} selects the
7781 most compatible architecture for the selected ABI (that is,
7782 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7783
7784 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7785 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7786 @samp{vr} may be written @samp{r}.
7787
7788 GCC defines two macros based on the value of this option.  The first
7789 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7790 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7791 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7792 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7793 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7794
7795 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7796 above.  In other words, it will have the full prefix and will not
7797 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7798 the macro names the resolved architecture (either @samp{"mips1"} or
7799 @samp{"mips3"}).  It names the default architecture when no
7800 @option{-march} option is given.
7801
7802 @item -mtune=@var{arch}
7803 @opindex mtune
7804 Optimize for @var{arch}.  Among other things, this option controls
7805 the way instructions are scheduled, and the perceived cost of arithmetic
7806 operations.  The list of @var{arch} values is the same as for
7807 @option{-march}.
7808
7809 When this option is not used, GCC will optimize for the processor
7810 specified by @option{-march}.  By using @option{-march} and
7811 @option{-mtune} together, it is possible to generate code that will
7812 run on a family of processors, but optimize the code for one
7813 particular member of that family.
7814
7815 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7816 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7817 @samp{-march} ones described above.
7818
7819 @item -mips1
7820 @opindex mips1
7821 Equivalent to @samp{-march=mips1}.
7822
7823 @item -mips2
7824 @opindex mips2
7825 Equivalent to @samp{-march=mips2}.
7826
7827 @item -mips3
7828 @opindex mips3
7829 Equivalent to @samp{-march=mips3}.
7830
7831 @item -mips4
7832 @opindex mips4
7833 Equivalent to @samp{-march=mips4}.
7834
7835 @item -mips32
7836 @opindex mips32
7837 Equivalent to @samp{-march=mips32}.
7838
7839 @item -mips32r2
7840 @opindex mips32r2
7841 Equivalent to @samp{-march=mips32r2}.
7842
7843 @item -mips64
7844 @opindex mips64
7845 Equivalent to @samp{-march=mips64}.
7846
7847 @item -mips16
7848 @itemx -mno-mips16
7849 @opindex mips16
7850 @opindex mno-mips16
7851 Use (do not use) the MIPS16 ISA.
7852
7853 @item -mabi=32
7854 @itemx -mabi=o64
7855 @itemx -mabi=n32
7856 @itemx -mabi=64
7857 @itemx -mabi=eabi
7858 @opindex mabi=32
7859 @opindex mabi=o64
7860 @opindex mabi=n32
7861 @opindex mabi=64
7862 @opindex mabi=eabi
7863 Generate code for the given ABI@.
7864
7865 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
7866 generates 64-bit code when you select a 64-bit architecture, but you
7867 can use @option{-mgp32} to get 32-bit code instead.
7868
7869 @item -mabicalls
7870 @itemx -mno-abicalls
7871 @opindex mabicalls
7872 @opindex mno-abicalls
7873 Generate (do not generate) SVR4-style position-independent code.
7874 @option{-mabicalls} is the default for SVR4-based systems.
7875
7876 @item -mxgot
7877 @itemx -mno-xgot
7878 @opindex mxgot
7879 @opindex mno-xgot
7880 Lift (do not lift) the usual restrictions on the size of the global
7881 offset table.
7882
7883 GCC normally uses a single instruction to load values from the GOT.
7884 While this is relatively efficient, it will only work if the GOT
7885 is smaller than about 64k.  Anything larger will cause the linker
7886 to report an error such as:
7887
7888 @cindex relocation truncated to fit (MIPS)
7889 @smallexample
7890 relocation truncated to fit: R_MIPS_GOT16 foobar
7891 @end smallexample
7892
7893 If this happens, you should recompile your code with @option{-mxgot}.
7894 It should then work with very large GOTs, although it will also be
7895 less efficient, since it will take three instructions to fetch the
7896 value of a global symbol.
7897
7898 Note that some linkers can create multiple GOTs.  If you have such a
7899 linker, you should only need to use @option{-mxgot} when a single object
7900 file accesses more than 64k's worth of GOT entries.  Very few do.
7901
7902 These options have no effect unless GCC is generating position
7903 independent code.
7904
7905 @item -membedded-pic
7906 @itemx -mno-embedded-pic
7907 @opindex membedded-pic
7908 @opindex mno-embedded-pic
7909 Generate (do not generate) position-independent code suitable for some
7910 embedded systems.  All calls are made using PC relative addresses, and
7911 all data is addressed using the $gp register.  No more than 65536
7912 bytes of global data may be used.  This requires GNU as and GNU ld,
7913 which do most of the work.
7914
7915 @item -mgp32
7916 @opindex mgp32
7917 Assume that general-purpose registers are 32 bits wide.
7918
7919 @item -mgp64
7920 @opindex mgp64
7921 Assume that general-purpose registers are 64 bits wide.
7922
7923 @item -mfp32
7924 @opindex mfp32
7925 Assume that floating-point registers are 32 bits wide.
7926
7927 @item -mfp64
7928 @opindex mfp64
7929 Assume that floating-point registers are 64 bits wide.
7930
7931 @item -mhard-float
7932 @opindex mhard-float
7933 Use floating-point coprocessor instructions.
7934
7935 @item -msoft-float
7936 @opindex msoft-float
7937 Do not use floating-point coprocessor instructions.  Implement
7938 floating-point calculations using library calls instead.
7939
7940 @item -msingle-float
7941 @opindex msingle-float
7942 Assume that the floating-point coprocessor only supports single-precision
7943 operations.
7944
7945 @itemx -mdouble-float
7946 @opindex mdouble-float
7947 Assume that the floating-point coprocessor supports double-precision
7948 operations.  This is the default.
7949
7950 @item -mint64
7951 @opindex mint64
7952 Force @code{int} and @code{long} types to be 64 bits wide.  See
7953 @option{-mlong32} for an explanation of the default and the way
7954 that the pointer size is determined.
7955
7956 @item -mlong64
7957 @opindex mlong64
7958 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
7959 an explanation of the default and the way that the pointer size is
7960 determined.
7961
7962 @item -mlong32
7963 @opindex mlong32
7964 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7965
7966 The default size of @code{int}s, @code{long}s and pointers depends on
7967 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
7968 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7969 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
7970 or the same size as integer registers, whichever is smaller.
7971
7972 @item -G @var{num}
7973 @opindex G
7974 @cindex smaller data references (MIPS)
7975 @cindex gp-relative references (MIPS)
7976 Put global and static items less than or equal to @var{num} bytes into
7977 the small data or bss section instead of the normal data or bss section.
7978 This allows the data to be accessed using a single instruction.
7979
7980 All modules should be compiled with the same @option{-G @var{num}}
7981 value.
7982
7983 @item -membedded-data
7984 @itemx -mno-embedded-data
7985 @opindex membedded-data
7986 @opindex mno-embedded-data
7987 Allocate variables to the read-only data section first if possible, then
7988 next in the small data section if possible, otherwise in data.  This gives
7989 slightly slower code than the default, but reduces the amount of RAM required
7990 when executing, and thus may be preferred for some embedded systems.
7991
7992 @item -muninit-const-in-rodata
7993 @itemx -mno-uninit-const-in-rodata
7994 @opindex muninit-const-in-rodata
7995 @opindex mno-uninit-const-in-rodata
7996 Put uninitialized @code{const} variables in the read-only data section.
7997 This option is only meaningful in conjunction with @option{-membedded-data}.
7998
7999 @item -msplit-addresses
8000 @itemx -mno-split-addresses
8001 @opindex msplit-addresses
8002 @opindex mno-split-addresses
8003 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
8004 relocation operators.  This option has been superceded by
8005 @option{-mexplicit-relocs} but is retained for backwards compatibility.
8006
8007 @item -mexplicit-relocs
8008 @itemx -mno-explicit-relocs
8009 @opindex mexplicit-relocs
8010 @opindex mno-explicit-relocs
8011 Use (do not use) assembler relocation operators when dealing with symbolic
8012 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
8013 is to use assembler macros instead.
8014
8015 @option{-mexplicit-relocs} is usually the default if GCC was
8016 configured to use an assembler that supports relocation operators.
8017 However, there are two exceptions:
8018
8019 @itemize @bullet
8020 @item
8021 GCC is not yet able to generate explicit relocations for the combination
8022 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
8023 in a future release.
8024
8025 @item
8026 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
8027 implies @option{-mno-explicit-relocs} unless explicitly overridden.
8028 This is because, when generating abicalls, the choice of relocation
8029 depends on whether a symbol is local or global.  In some rare cases,
8030 GCC will not be able to decide this until the whole compilation unit
8031 has been read.
8032 @end itemize
8033
8034 @item -mrnames
8035 @itemx -mno-rnames
8036 @opindex mrnames
8037 @opindex mno-rnames
8038 Generate (do not generate) code that refers to registers using their
8039 software names.  The default is @option{-mno-rnames}, which tells GCC
8040 to use hardware names like @samp{$4} instead of software names like
8041 @samp{a0}.  The only assembler known to support @option{-rnames} is
8042 the Algorithmics assembler.
8043
8044 @item -mcheck-zero-division
8045 @itemx -mno-check-zero-division
8046 @opindex mcheck-zero-division
8047 @opindex mno-check-zero-division
8048 Trap (do not trap) on integer division by zero.  The default is
8049 @option{-mcheck-zero-division}.
8050
8051 @item -mmemcpy
8052 @itemx -mno-memcpy
8053 @opindex mmemcpy
8054 @opindex mno-memcpy
8055 Force (do not force) the use of @code{memcpy()} for non-trivial block
8056 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8057 most constant-sized copies.
8058
8059 @item -mlong-calls
8060 @itemx -mno-long-calls
8061 @opindex mlong-calls
8062 @opindex mno-long-calls
8063 Disable (do not disable) use of the @code{jal} instruction.  Calling
8064 functions using @code{jal} is more efficient but requires the caller
8065 and callee to be in the same 256 megabyte segment.
8066
8067 This option has no effect on abicalls code.  The default is
8068 @option{-mno-long-calls}.
8069
8070 @item -mmad
8071 @itemx -mno-mad
8072 @opindex mmad
8073 @opindex mno-mad
8074 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8075 instructions, as provided by the R4650 ISA.
8076
8077 @item -mfused-madd
8078 @itemx -mno-fused-madd
8079 @opindex mfused-madd
8080 @opindex mno-fused-madd
8081 Enable (disable) use of the floating point multiply-accumulate
8082 instructions, when they are available.  The default is
8083 @option{-mfused-madd}.
8084
8085 When multiply-accumulate instructions are used, the intermediate
8086 product is calculated to infinite precision and is not subject to
8087 the FCSR Flush to Zero bit.  This may be undesirable in some
8088 circumstances.
8089
8090 @item -nocpp
8091 @opindex nocpp
8092 Tell the MIPS assembler to not run its preprocessor over user
8093 assembler files (with a @samp{.s} suffix) when assembling them.
8094
8095 @item -mfix-sb1
8096 @itemx -mno-fix-sb1
8097 @opindex mfix-sb1
8098 Work around certain SB-1 CPU core errata.
8099 (This flag currently works around the SB-1 revision 2
8100 ``F1'' and ``F2'' floating point errata.)
8101
8102 @item -mflush-func=@var{func}
8103 @itemx -mno-flush-func
8104 @opindex mflush-func
8105 Specifies the function to call to flush the I and D caches, or to not
8106 call any such function.  If called, the function must take the same
8107 arguments as the common @code{_flush_func()}, that is, the address of the
8108 memory range for which the cache is being flushed, the size of the
8109 memory range, and the number 3 (to flush both caches).  The default
8110 depends on the target GCC was configured for, but commonly is either
8111 @samp{_flush_func} or @samp{__cpu_flush}.
8112
8113 @item -mbranch-likely
8114 @itemx -mno-branch-likely
8115 @opindex mbranch-likely
8116 @opindex mno-branch-likely
8117 Enable or disable use of Branch Likely instructions, regardless of the
8118 default for the selected architecture.  By default, Branch Likely
8119 instructions may be generated if they are supported by the selected
8120 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8121 and processors which implement those architectures; for those, Branch
8122 Likely instructions will not be generated by default because the MIPS32
8123 and MIPS64 architectures specifically deprecate their use.
8124 @end table
8125
8126 @node i386 and x86-64 Options
8127 @subsection Intel 386 and AMD x86-64 Options
8128 @cindex i386 Options
8129 @cindex x86-64 Options
8130 @cindex Intel 386 Options
8131 @cindex AMD x86-64 Options
8132
8133 These @samp{-m} options are defined for the i386 and x86-64 family of
8134 computers:
8135
8136 @table @gcctabopt
8137 @item -mtune=@var{cpu-type}
8138 @opindex mtune
8139 Tune to @var{cpu-type} everything applicable about the generated code, except
8140 for the ABI and the set of available instructions.  The choices for
8141 @var{cpu-type} are:
8142 @table @emph
8143 @item i386
8144 Original Intel's i386 CPU.
8145 @item i486
8146 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8147 @item i586, pentium
8148 Intel Pentium CPU with no MMX support.
8149 @item pentium-mmx
8150 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8151 @item i686, pentiumpro
8152 Intel PentiumPro CPU.
8153 @item pentium2
8154 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8155 @item pentium3, pentium3m
8156 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8157 support.
8158 @item pentium-m
8159 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8160 support.  Used by Centrino notebooks.
8161 @item pentium4, pentium4m
8162 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8163 @item prescott
8164 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8165 set support.
8166 @item nocona
8167 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8168 SSE2 and SSE3 instruction set support.
8169 @item k6
8170 AMD K6 CPU with MMX instruction set support.
8171 @item k6-2, k6-3
8172 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8173 @item athlon, athlon-tbird
8174 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8175 support.
8176 @item athlon-4, athlon-xp, athlon-mp
8177 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8178 instruction set support.
8179 @item k8, opteron, athlon64, athlon-fx
8180 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8181 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8182 @item winchip-c6
8183 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8184 set support.
8185 @item winchip2
8186 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8187 instruction set support.
8188 @item c3
8189 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8190 implemented for this chip.)
8191 @item c3-2
8192 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8193 implemented for this chip.)
8194 @end table
8195
8196 While picking a specific @var{cpu-type} will schedule things appropriately
8197 for that particular chip, the compiler will not generate any code that
8198 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8199 being used.
8200
8201 @item -march=@var{cpu-type}
8202 @opindex march
8203 Generate instructions for the machine type @var{cpu-type}.  The choices
8204 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8205 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8206
8207 @item -mcpu=@var{cpu-type}
8208 @opindex mcpu
8209 A deprecated synonym for @option{-mtune}.
8210
8211 @item -m386
8212 @itemx -m486
8213 @itemx -mpentium
8214 @itemx -mpentiumpro
8215 @opindex m386
8216 @opindex m486
8217 @opindex mpentium
8218 @opindex mpentiumpro
8219 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8220 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8221 These synonyms are deprecated.
8222
8223 @item -mfpmath=@var{unit}
8224 @opindex march
8225 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8226 for @var{unit} are:
8227
8228 @table @samp
8229 @item 387
8230 Use the standard 387 floating point coprocessor present majority of chips and
8231 emulated otherwise.  Code compiled with this option will run almost everywhere.
8232 The temporary results are computed in 80bit precision instead of precision
8233 specified by the type resulting in slightly different results compared to most
8234 of other chips. See @option{-ffloat-store} for more detailed description.
8235
8236 This is the default choice for i386 compiler.
8237
8238 @item sse
8239 Use scalar floating point instructions present in the SSE instruction set.
8240 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8241 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8242 instruction set supports only single precision arithmetics, thus the double and
8243 extended precision arithmetics is still done using 387.  Later version, present
8244 only in Pentium4 and the future AMD x86-64 chips supports double precision
8245 arithmetics too.
8246
8247 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8248 @option{-msse2} switches to enable SSE extensions and make this option
8249 effective.  For x86-64 compiler, these extensions are enabled by default.
8250
8251 The resulting code should be considerably faster in the majority of cases and avoid
8252 the numerical instability problems of 387 code, but may break some existing
8253 code that expects temporaries to be 80bit.
8254
8255 This is the default choice for the x86-64 compiler.
8256
8257 @item sse,387
8258 Attempt to utilize both instruction sets at once.  This effectively double the
8259 amount of available registers and on chips with separate execution units for
8260 387 and SSE the execution resources too.  Use this option with care, as it is
8261 still experimental, because the GCC register allocator does not model separate
8262 functional units well resulting in instable performance.
8263 @end table
8264
8265 @item -masm=@var{dialect}
8266 @opindex masm=@var{dialect}
8267 Output asm instructions using selected @var{dialect}. Supported choices are
8268 @samp{intel} or @samp{att} (the default one).
8269
8270 @item -mieee-fp
8271 @itemx -mno-ieee-fp
8272 @opindex mieee-fp
8273 @opindex mno-ieee-fp
8274 Control whether or not the compiler uses IEEE floating point
8275 comparisons.  These handle correctly the case where the result of a
8276 comparison is unordered.
8277
8278 @item -msoft-float
8279 @opindex msoft-float
8280 Generate output containing library calls for floating point.
8281 @strong{Warning:} the requisite libraries are not part of GCC@.
8282 Normally the facilities of the machine's usual C compiler are used, but
8283 this can't be done directly in cross-compilation.  You must make your
8284 own arrangements to provide suitable library functions for
8285 cross-compilation.
8286
8287 On machines where a function returns floating point results in the 80387
8288 register stack, some floating point opcodes may be emitted even if
8289 @option{-msoft-float} is used.
8290
8291 @item -mno-fp-ret-in-387
8292 @opindex mno-fp-ret-in-387
8293 Do not use the FPU registers for return values of functions.
8294
8295 The usual calling convention has functions return values of types
8296 @code{float} and @code{double} in an FPU register, even if there
8297 is no FPU@.  The idea is that the operating system should emulate
8298 an FPU@.
8299
8300 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8301 in ordinary CPU registers instead.
8302
8303 @item -mno-fancy-math-387
8304 @opindex mno-fancy-math-387
8305 Some 387 emulators do not support the @code{sin}, @code{cos} and
8306 @code{sqrt} instructions for the 387.  Specify this option to avoid
8307 generating those instructions.  This option is the default on FreeBSD,
8308 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8309 indicates that the target cpu will always have an FPU and so the
8310 instruction will not need emulation.  As of revision 2.6.1, these
8311 instructions are not generated unless you also use the
8312 @option{-funsafe-math-optimizations} switch.
8313
8314 @item -malign-double
8315 @itemx -mno-align-double
8316 @opindex malign-double
8317 @opindex mno-align-double
8318 Control whether GCC aligns @code{double}, @code{long double}, and
8319 @code{long long} variables on a two word boundary or a one word
8320 boundary.  Aligning @code{double} variables on a two word boundary will
8321 produce code that runs somewhat faster on a @samp{Pentium} at the
8322 expense of more memory.
8323
8324 @strong{Warning:} if you use the @option{-malign-double} switch,
8325 structures containing the above types will be aligned differently than
8326 the published application binary interface specifications for the 386
8327 and will not be binary compatible with structures in code compiled
8328 without that switch.
8329
8330 @item -m96bit-long-double
8331 @itemx -m128bit-long-double
8332 @opindex m96bit-long-double
8333 @opindex m128bit-long-double
8334 These switches control the size of @code{long double} type. The i386
8335 application binary interface specifies the size to be 96 bits,
8336 so @option{-m96bit-long-double} is the default in 32 bit mode.
8337
8338 Modern architectures (Pentium and newer) would prefer @code{long double}
8339 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8340 conforming to the ABI, this would not be possible.  So specifying a
8341 @option{-m128bit-long-double} will align @code{long double}
8342 to a 16 byte boundary by padding the @code{long double} with an additional
8343 32 bit zero.
8344
8345 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8346 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8347
8348 Notice that neither of these options enable any extra precision over the x87
8349 standard of 80 bits for a @code{long double}.
8350
8351 @strong{Warning:} if you override the default value for your target ABI, the
8352 structures and arrays containing @code{long double} variables will change
8353 their size as well as function calling convention for function taking
8354 @code{long double} will be modified.  Hence they will not be binary
8355 compatible with arrays or structures in code compiled without that switch.
8356
8357
8358 @item -msvr3-shlib
8359 @itemx -mno-svr3-shlib
8360 @opindex msvr3-shlib
8361 @opindex mno-svr3-shlib
8362 Control whether GCC places uninitialized local variables into the
8363 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8364 into @code{bss}.  These options are meaningful only on System V Release 3.
8365
8366 @item -mrtd
8367 @opindex mrtd
8368 Use a different function-calling convention, in which functions that
8369 take a fixed number of arguments return with the @code{ret} @var{num}
8370 instruction, which pops their arguments while returning.  This saves one
8371 instruction in the caller since there is no need to pop the arguments
8372 there.
8373
8374 You can specify that an individual function is called with this calling
8375 sequence with the function attribute @samp{stdcall}.  You can also
8376 override the @option{-mrtd} option by using the function attribute
8377 @samp{cdecl}.  @xref{Function Attributes}.
8378
8379 @strong{Warning:} this calling convention is incompatible with the one
8380 normally used on Unix, so you cannot use it if you need to call
8381 libraries compiled with the Unix compiler.
8382
8383 Also, you must provide function prototypes for all functions that
8384 take variable numbers of arguments (including @code{printf});
8385 otherwise incorrect code will be generated for calls to those
8386 functions.
8387
8388 In addition, seriously incorrect code will result if you call a
8389 function with too many arguments.  (Normally, extra arguments are
8390 harmlessly ignored.)
8391
8392 @item -mregparm=@var{num}
8393 @opindex mregparm
8394 Control how many registers are used to pass integer arguments.  By
8395 default, no registers are used to pass arguments, and at most 3
8396 registers can be used.  You can control this behavior for a specific
8397 function by using the function attribute @samp{regparm}.
8398 @xref{Function Attributes}.
8399
8400 @strong{Warning:} if you use this switch, and
8401 @var{num} is nonzero, then you must build all modules with the same
8402 value, including any libraries.  This includes the system libraries and
8403 startup modules.
8404
8405 @item -mpreferred-stack-boundary=@var{num}
8406 @opindex mpreferred-stack-boundary
8407 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8408 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8409 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8410 size (@option{-Os}), in which case the default is the minimum correct
8411 alignment (4 bytes for x86, and 8 bytes for x86-64).
8412
8413 On Pentium and PentiumPro, @code{double} and @code{long double} values
8414 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8415 suffer significant run time performance penalties.  On Pentium III, the
8416 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8417 penalties if it is not 16 byte aligned.
8418
8419 To ensure proper alignment of this values on the stack, the stack boundary
8420 must be as aligned as that required by any value stored on the stack.
8421 Further, every function must be generated such that it keeps the stack
8422 aligned.  Thus calling a function compiled with a higher preferred
8423 stack boundary from a function compiled with a lower preferred stack
8424 boundary will most likely misalign the stack.  It is recommended that
8425 libraries that use callbacks always use the default setting.
8426
8427 This extra alignment does consume extra stack space, and generally
8428 increases code size.  Code that is sensitive to stack space usage, such
8429 as embedded systems and operating system kernels, may want to reduce the
8430 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8431
8432 @item -mmmx
8433 @itemx -mno-mmx
8434 @item -msse
8435 @itemx -mno-sse
8436 @item -msse2
8437 @itemx -mno-sse2
8438 @item -msse3
8439 @itemx -mno-sse3
8440 @item -m3dnow
8441 @itemx -mno-3dnow
8442 @opindex mmmx
8443 @opindex mno-mmx
8444 @opindex msse
8445 @opindex mno-sse
8446 @opindex m3dnow
8447 @opindex mno-3dnow
8448 These switches enable or disable the use of built-in functions that allow
8449 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8450 instruction set.
8451
8452 @xref{X86 Built-in Functions}, for details of the functions enabled
8453 and disabled by these switches.
8454
8455 To have SSE/SSE2 instructions generated automatically from floating-point
8456 code, see @option{-mfpmath=sse}.
8457
8458 @item -mpush-args
8459 @itemx -mno-push-args
8460 @opindex mpush-args
8461 @opindex mno-push-args
8462 Use PUSH operations to store outgoing parameters.  This method is shorter
8463 and usually equally fast as method using SUB/MOV operations and is enabled
8464 by default.  In some cases disabling it may improve performance because of
8465 improved scheduling and reduced dependencies.
8466
8467 @item -maccumulate-outgoing-args
8468 @opindex maccumulate-outgoing-args
8469 If enabled, the maximum amount of space required for outgoing arguments will be
8470 computed in the function prologue.  This is faster on most modern CPUs
8471 because of reduced dependencies, improved scheduling and reduced stack usage
8472 when preferred stack boundary is not equal to 2.  The drawback is a notable
8473 increase in code size.  This switch implies @option{-mno-push-args}.
8474
8475 @item -mthreads
8476 @opindex mthreads
8477 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8478 on thread-safe exception handling must compile and link all code with the
8479 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8480 @option{-D_MT}; when linking, it links in a special thread helper library
8481 @option{-lmingwthrd} which cleans up per thread exception handling data.
8482
8483 @item -mno-align-stringops
8484 @opindex mno-align-stringops
8485 Do not align destination of inlined string operations.  This switch reduces
8486 code size and improves performance in case the destination is already aligned,
8487 but GCC doesn't know about it.
8488
8489 @item -minline-all-stringops
8490 @opindex minline-all-stringops
8491 By default GCC inlines string operations only when destination is known to be
8492 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8493 size, but may improve performance of code that depends on fast memcpy, strlen
8494 and memset for short lengths.
8495
8496 @item -momit-leaf-frame-pointer
8497 @opindex momit-leaf-frame-pointer
8498 Don't keep the frame pointer in a register for leaf functions.  This
8499 avoids the instructions to save, set up and restore frame pointers and
8500 makes an extra register available in leaf functions.  The option
8501 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8502 which might make debugging harder.
8503
8504 @item -mtls-direct-seg-refs
8505 @itemx -mno-tls-direct-seg-refs
8506 @opindex mtls-direct-seg-refs
8507 Controls whether TLS variables may be accessed with offsets from the
8508 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8509 or whether the thread base pointer must be added.  Whether or not this
8510 is legal depends on the operating system, and whether it maps the
8511 segment to cover the entire TLS area.
8512
8513 For systems that use GNU libc, the default is on.
8514 @end table
8515
8516 These @samp{-m} switches are supported in addition to the above
8517 on AMD x86-64 processors in 64-bit environments.
8518
8519 @table @gcctabopt
8520 @item -m32
8521 @itemx -m64
8522 @opindex m32
8523 @opindex m64
8524 Generate code for a 32-bit or 64-bit environment.
8525 The 32-bit environment sets int, long and pointer to 32 bits and
8526 generates code that runs on any i386 system.
8527 The 64-bit environment sets int to 32 bits and long and pointer
8528 to 64 bits and generates code for AMD's x86-64 architecture.
8529
8530 @item -mno-red-zone
8531 @opindex no-red-zone
8532 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8533 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8534 stack pointer that will not be modified by signal or interrupt handlers
8535 and therefore can be used for temporary data without adjusting the stack
8536 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8537
8538 @item -mcmodel=small
8539 @opindex mcmodel=small
8540 Generate code for the small code model: the program and its symbols must
8541 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8542 Programs can be statically or dynamically linked.  This is the default
8543 code model.
8544
8545 @item -mcmodel=kernel
8546 @opindex mcmodel=kernel
8547 Generate code for the kernel code model.  The kernel runs in the
8548 negative 2 GB of the address space.
8549 This model has to be used for Linux kernel code.
8550
8551 @item -mcmodel=medium
8552 @opindex mcmodel=medium
8553 Generate code for the medium model: The program is linked in the lower 2
8554 GB of the address space but symbols can be located anywhere in the
8555 address space.  Programs can be statically or dynamically linked, but
8556 building of shared libraries are not supported with the medium model.
8557
8558 @item -mcmodel=large
8559 @opindex mcmodel=large
8560 Generate code for the large model: This model makes no assumptions
8561 about addresses and sizes of sections.  Currently GCC does not implement
8562 this model.
8563 @end table
8564
8565 @node HPPA Options
8566 @subsection HPPA Options
8567 @cindex HPPA Options
8568
8569 These @samp{-m} options are defined for the HPPA family of computers:
8570
8571 @table @gcctabopt
8572 @item -march=@var{architecture-type}
8573 @opindex march
8574 Generate code for the specified architecture.  The choices for
8575 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8576 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8577 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8578 architecture option for your machine.  Code compiled for lower numbered
8579 architectures will run on higher numbered architectures, but not the
8580 other way around.
8581
8582 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8583 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8584 support.
8585
8586 @item -mpa-risc-1-0
8587 @itemx -mpa-risc-1-1
8588 @itemx -mpa-risc-2-0
8589 @opindex mpa-risc-1-0
8590 @opindex mpa-risc-1-1
8591 @opindex mpa-risc-2-0
8592 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8593
8594 @item -mbig-switch
8595 @opindex mbig-switch
8596 Generate code suitable for big switch tables.  Use this option only if
8597 the assembler/linker complain about out of range branches within a switch
8598 table.
8599
8600 @item -mjump-in-delay
8601 @opindex mjump-in-delay
8602 Fill delay slots of function calls with unconditional jump instructions
8603 by modifying the return pointer for the function call to be the target
8604 of the conditional jump.
8605
8606 @item -mdisable-fpregs
8607 @opindex mdisable-fpregs
8608 Prevent floating point registers from being used in any manner.  This is
8609 necessary for compiling kernels which perform lazy context switching of
8610 floating point registers.  If you use this option and attempt to perform
8611 floating point operations, the compiler will abort.
8612
8613 @item -mdisable-indexing
8614 @opindex mdisable-indexing
8615 Prevent the compiler from using indexing address modes.  This avoids some
8616 rather obscure problems when compiling MIG generated code under MACH@.
8617
8618 @item -mno-space-regs
8619 @opindex mno-space-regs
8620 Generate code that assumes the target has no space registers.  This allows
8621 GCC to generate faster indirect calls and use unscaled index address modes.
8622
8623 Such code is suitable for level 0 PA systems and kernels.
8624
8625 @item -mfast-indirect-calls
8626 @opindex mfast-indirect-calls
8627 Generate code that assumes calls never cross space boundaries.  This
8628 allows GCC to emit code which performs faster indirect calls.
8629
8630 This option will not work in the presence of shared libraries or nested
8631 functions.
8632
8633 @item -mlong-load-store
8634 @opindex mlong-load-store
8635 Generate 3-instruction load and store sequences as sometimes required by
8636 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8637 the HP compilers.
8638
8639 @item -mportable-runtime
8640 @opindex mportable-runtime
8641 Use the portable calling conventions proposed by HP for ELF systems.
8642
8643 @item -mgas
8644 @opindex mgas
8645 Enable the use of assembler directives only GAS understands.
8646
8647 @item -mschedule=@var{cpu-type}
8648 @opindex mschedule
8649 Schedule code according to the constraints for the machine type
8650 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8651 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8652 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8653 proper scheduling option for your machine.  The default scheduling is
8654 @samp{8000}.
8655
8656 @item -mlinker-opt
8657 @opindex mlinker-opt
8658 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8659 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8660 linkers in which they give bogus error messages when linking some programs.
8661
8662 @item -msoft-float
8663 @opindex msoft-float
8664 Generate output containing library calls for floating point.
8665 @strong{Warning:} the requisite libraries are not available for all HPPA
8666 targets.  Normally the facilities of the machine's usual C compiler are
8667 used, but this cannot be done directly in cross-compilation.  You must make
8668 your own arrangements to provide suitable library functions for
8669 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8670 does provide software floating point support.
8671
8672 @option{-msoft-float} changes the calling convention in the output file;
8673 therefore, it is only useful if you compile @emph{all} of a program with
8674 this option.  In particular, you need to compile @file{libgcc.a}, the
8675 library that comes with GCC, with @option{-msoft-float} in order for
8676 this to work.
8677
8678 @item -msio
8679 @opindex msio
8680 Generate the predefine, @code{_SIO}, for server IO.  The default is
8681 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8682 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8683 options are available under HP-UX and HI-UX.
8684
8685 @item -mgnu-ld
8686 @opindex gnu-ld
8687 Use GNU ld specific options.  This passes @option{-shared} to ld when
8688 building a shared library.  It is the default when GCC is configured,
8689 explicitly or implicitly, with the GNU linker.  This option does not
8690 have any affect on which ld is called, it only changes what parameters
8691 are passed to that ld.  The ld that is called is determined by the
8692 @option{--with-ld} configure option, GCC's program search path, and
8693 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8694 using @samp{which `gcc -print-prog-name=ld`}.
8695
8696 @item -mhp-ld
8697 @opindex hp-ld
8698 Use HP ld specific options.  This passes @option{-b} to ld when building
8699 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8700 links.  It is the default when GCC is configured, explicitly or
8701 implicitly, with the HP linker.  This option does not have any affect on
8702 which ld is called, it only changes what parameters are passed to that
8703 ld.  The ld that is called is determined by the @option{--with-ld}
8704 configure option, GCC's program search path, and finally by the user's
8705 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8706 `gcc -print-prog-name=ld`}.
8707
8708 @item -mlong-calls
8709 @opindex mno-long-calls
8710 Generate code that uses long call sequences.  This ensures that a call
8711 is always able to reach linker generated stubs.  The default is to generate
8712 long calls only when the distance from the call site to the beginning
8713 of the function or translation unit, as the case may be, exceeds a
8714 predefined limit set by the branch type being used.  The limits for
8715 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8716 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8717 240,000 bytes.
8718
8719 Distances are measured from the beginning of functions when using the
8720 @option{-ffunction-sections} option, or when using the @option{-mgas}
8721 and @option{-mno-portable-runtime} options together under HP-UX with
8722 the SOM linker.
8723
8724 It is normally not desirable to use this option as it will degrade
8725 performance.  However, it may be useful in large applications,
8726 particularly when partial linking is used to build the application.
8727
8728 The types of long calls used depends on the capabilities of the
8729 assembler and linker, and the type of code being generated.  The
8730 impact on systems that support long absolute calls, and long pic
8731 symbol-difference or pc-relative calls should be relatively small.
8732 However, an indirect call is used on 32-bit ELF systems in pic code
8733 and it is quite long.
8734
8735 @item -nolibdld
8736 @opindex nolibdld
8737 Suppress the generation of link options to search libdld.sl when the
8738 @option{-static} option is specified on HP-UX 10 and later.
8739
8740 @item -static
8741 @opindex static
8742 The HP-UX implementation of setlocale in libc has a dependency on
8743 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8744 when the @option{-static} option is specified, special link options
8745 are needed to resolve this dependency.
8746
8747 On HP-UX 10 and later, the GCC driver adds the necessary options to
8748 link with libdld.sl when the @option{-static} option is specified.
8749 This causes the resulting binary to be dynamic.  On the 64-bit port,
8750 the linkers generate dynamic binaries by default in any case.  The
8751 @option{-nolibdld} option can be used to prevent the GCC driver from
8752 adding these link options.
8753
8754 @item -threads
8755 @opindex threads
8756 Add support for multithreading with the @dfn{dce thread} library
8757 under HP-UX.  This option sets flags for both the preprocessor and
8758 linker.
8759 @end table
8760
8761 @node Intel 960 Options
8762 @subsection Intel 960 Options
8763
8764 These @samp{-m} options are defined for the Intel 960 implementations:
8765
8766 @table @gcctabopt
8767 @item -m@var{cpu-type}
8768 @opindex mka
8769 @opindex mkb
8770 @opindex mmc
8771 @opindex mca
8772 @opindex mcf
8773 @opindex msa
8774 @opindex msb
8775 Assume the defaults for the machine type @var{cpu-type} for some of
8776 the other options, including instruction scheduling, floating point
8777 support, and addressing modes.  The choices for @var{cpu-type} are
8778 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8779 @samp{sa}, and @samp{sb}.
8780 The default is
8781 @samp{kb}.
8782
8783 @item -mnumerics
8784 @itemx -msoft-float
8785 @opindex mnumerics
8786 @opindex msoft-float
8787 The @option{-mnumerics} option indicates that the processor does support
8788 floating-point instructions.  The @option{-msoft-float} option indicates
8789 that floating-point support should not be assumed.
8790
8791 @item -mleaf-procedures
8792 @itemx -mno-leaf-procedures
8793 @opindex mleaf-procedures
8794 @opindex mno-leaf-procedures
8795 Do (or do not) attempt to alter leaf procedures to be callable with the
8796 @code{bal} instruction as well as @code{call}.  This will result in more
8797 efficient code for explicit calls when the @code{bal} instruction can be
8798 substituted by the assembler or linker, but less efficient code in other
8799 cases, such as calls via function pointers, or using a linker that doesn't
8800 support this optimization.
8801
8802 @item -mtail-call
8803 @itemx -mno-tail-call
8804 @opindex mtail-call
8805 @opindex mno-tail-call
8806 Do (or do not) make additional attempts (beyond those of the
8807 machine-independent portions of the compiler) to optimize tail-recursive
8808 calls into branches.  You may not want to do this because the detection of
8809 cases where this is not valid is not totally complete.  The default is
8810 @option{-mno-tail-call}.
8811
8812 @item -mcomplex-addr
8813 @itemx -mno-complex-addr
8814 @opindex mcomplex-addr
8815 @opindex mno-complex-addr
8816 Assume (or do not assume) that the use of a complex addressing mode is a
8817 win on this implementation of the i960.  Complex addressing modes may not
8818 be worthwhile on the K-series, but they definitely are on the C-series.
8819 The default is currently @option{-mcomplex-addr} for all processors except
8820 the CB and CC@.
8821
8822 @item -mcode-align
8823 @itemx -mno-code-align
8824 @opindex mcode-align
8825 @opindex mno-code-align
8826 Align code to 8-byte boundaries for faster fetching (or don't bother).
8827 Currently turned on by default for C-series implementations only.
8828
8829 @ignore
8830 @item -mclean-linkage
8831 @itemx -mno-clean-linkage
8832 @opindex mclean-linkage
8833 @opindex mno-clean-linkage
8834 These options are not fully implemented.
8835 @end ignore
8836
8837 @item -mic-compat
8838 @itemx -mic2.0-compat
8839 @itemx -mic3.0-compat
8840 @opindex mic-compat
8841 @opindex mic2.0-compat
8842 @opindex mic3.0-compat
8843 Enable compatibility with iC960 v2.0 or v3.0.
8844
8845 @item -masm-compat
8846 @itemx -mintel-asm
8847 @opindex masm-compat
8848 @opindex mintel-asm
8849 Enable compatibility with the iC960 assembler.
8850
8851 @item -mstrict-align
8852 @itemx -mno-strict-align
8853 @opindex mstrict-align
8854 @opindex mno-strict-align
8855 Do not permit (do permit) unaligned accesses.
8856
8857 @item -mold-align
8858 @opindex mold-align
8859 Enable structure-alignment compatibility with Intel's gcc release version
8860 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8861
8862 @item -mlong-double-64
8863 @opindex mlong-double-64
8864 Implement type @samp{long double} as 64-bit floating point numbers.
8865 Without the option @samp{long double} is implemented by 80-bit
8866 floating point numbers.  The only reason we have it because there is
8867 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8868 is only useful for people using soft-float targets.  Otherwise, we
8869 should recommend against use of it.
8870
8871 @end table
8872
8873 @node DEC Alpha Options
8874 @subsection DEC Alpha Options
8875
8876 These @samp{-m} options are defined for the DEC Alpha implementations:
8877
8878 @table @gcctabopt
8879 @item -mno-soft-float
8880 @itemx -msoft-float
8881 @opindex mno-soft-float
8882 @opindex msoft-float
8883 Use (do not use) the hardware floating-point instructions for
8884 floating-point operations.  When @option{-msoft-float} is specified,
8885 functions in @file{libgcc.a} will be used to perform floating-point
8886 operations.  Unless they are replaced by routines that emulate the
8887 floating-point operations, or compiled in such a way as to call such
8888 emulations routines, these routines will issue floating-point
8889 operations.   If you are compiling for an Alpha without floating-point
8890 operations, you must ensure that the library is built so as not to call
8891 them.
8892
8893 Note that Alpha implementations without floating-point operations are
8894 required to have floating-point registers.
8895
8896 @item -mfp-reg
8897 @itemx -mno-fp-regs
8898 @opindex mfp-reg
8899 @opindex mno-fp-regs
8900 Generate code that uses (does not use) the floating-point register set.
8901 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8902 register set is not used, floating point operands are passed in integer
8903 registers as if they were integers and floating-point results are passed
8904 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8905 so any function with a floating-point argument or return value called by code
8906 compiled with @option{-mno-fp-regs} must also be compiled with that
8907 option.
8908
8909 A typical use of this option is building a kernel that does not use,
8910 and hence need not save and restore, any floating-point registers.
8911
8912 @item -mieee
8913 @opindex mieee
8914 The Alpha architecture implements floating-point hardware optimized for
8915 maximum performance.  It is mostly compliant with the IEEE floating
8916 point standard.  However, for full compliance, software assistance is
8917 required.  This option generates code fully IEEE compliant code
8918 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8919 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8920 defined during compilation.  The resulting code is less efficient but is
8921 able to correctly support denormalized numbers and exceptional IEEE
8922 values such as not-a-number and plus/minus infinity.  Other Alpha
8923 compilers call this option @option{-ieee_with_no_inexact}.
8924
8925 @item -mieee-with-inexact
8926 @opindex mieee-with-inexact
8927 This is like @option{-mieee} except the generated code also maintains
8928 the IEEE @var{inexact-flag}.  Turning on this option causes the
8929 generated code to implement fully-compliant IEEE math.  In addition to
8930 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8931 macro.  On some Alpha implementations the resulting code may execute
8932 significantly slower than the code generated by default.  Since there is
8933 very little code that depends on the @var{inexact-flag}, you should
8934 normally not specify this option.  Other Alpha compilers call this
8935 option @option{-ieee_with_inexact}.
8936
8937 @item -mfp-trap-mode=@var{trap-mode}
8938 @opindex mfp-trap-mode
8939 This option controls what floating-point related traps are enabled.
8940 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8941 The trap mode can be set to one of four values:
8942
8943 @table @samp
8944 @item n
8945 This is the default (normal) setting.  The only traps that are enabled
8946 are the ones that cannot be disabled in software (e.g., division by zero
8947 trap).
8948
8949 @item u
8950 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8951 as well.
8952
8953 @item su
8954 Like @samp{su}, but the instructions are marked to be safe for software
8955 completion (see Alpha architecture manual for details).
8956
8957 @item sui
8958 Like @samp{su}, but inexact traps are enabled as well.
8959 @end table
8960
8961 @item -mfp-rounding-mode=@var{rounding-mode}
8962 @opindex mfp-rounding-mode
8963 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8964 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8965 of:
8966
8967 @table @samp
8968 @item n
8969 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8970 the nearest machine number or towards the even machine number in case
8971 of a tie.
8972
8973 @item m
8974 Round towards minus infinity.
8975
8976 @item c
8977 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8978
8979 @item d
8980 Dynamic rounding mode.  A field in the floating point control register
8981 (@var{fpcr}, see Alpha architecture reference manual) controls the
8982 rounding mode in effect.  The C library initializes this register for
8983 rounding towards plus infinity.  Thus, unless your program modifies the
8984 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8985 @end table
8986
8987 @item -mtrap-precision=@var{trap-precision}
8988 @opindex mtrap-precision
8989 In the Alpha architecture, floating point traps are imprecise.  This
8990 means without software assistance it is impossible to recover from a
8991 floating trap and program execution normally needs to be terminated.
8992 GCC can generate code that can assist operating system trap handlers
8993 in determining the exact location that caused a floating point trap.
8994 Depending on the requirements of an application, different levels of
8995 precisions can be selected:
8996
8997 @table @samp
8998 @item p
8999 Program precision.  This option is the default and means a trap handler
9000 can only identify which program caused a floating point exception.
9001
9002 @item f
9003 Function precision.  The trap handler can determine the function that
9004 caused a floating point exception.
9005
9006 @item i
9007 Instruction precision.  The trap handler can determine the exact
9008 instruction that caused a floating point exception.
9009 @end table
9010
9011 Other Alpha compilers provide the equivalent options called
9012 @option{-scope_safe} and @option{-resumption_safe}.
9013
9014 @item -mieee-conformant
9015 @opindex mieee-conformant
9016 This option marks the generated code as IEEE conformant.  You must not
9017 use this option unless you also specify @option{-mtrap-precision=i} and either
9018 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9019 is to emit the line @samp{.eflag 48} in the function prologue of the
9020 generated assembly file.  Under DEC Unix, this has the effect that
9021 IEEE-conformant math library routines will be linked in.
9022
9023 @item -mbuild-constants
9024 @opindex mbuild-constants
9025 Normally GCC examines a 32- or 64-bit integer constant to
9026 see if it can construct it from smaller constants in two or three
9027 instructions.  If it cannot, it will output the constant as a literal and
9028 generate code to load it from the data segment at runtime.
9029
9030 Use this option to require GCC to construct @emph{all} integer constants
9031 using code, even if it takes more instructions (the maximum is six).
9032
9033 You would typically use this option to build a shared library dynamic
9034 loader.  Itself a shared library, it must relocate itself in memory
9035 before it can find the variables and constants in its own data segment.
9036
9037 @item -malpha-as
9038 @itemx -mgas
9039 @opindex malpha-as
9040 @opindex mgas
9041 Select whether to generate code to be assembled by the vendor-supplied
9042 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9043
9044 @item -mbwx
9045 @itemx -mno-bwx
9046 @itemx -mcix
9047 @itemx -mno-cix
9048 @itemx -mfix
9049 @itemx -mno-fix
9050 @itemx -mmax
9051 @itemx -mno-max
9052 @opindex mbwx
9053 @opindex mno-bwx
9054 @opindex mcix
9055 @opindex mno-cix
9056 @opindex mfix
9057 @opindex mno-fix
9058 @opindex mmax
9059 @opindex mno-max
9060 Indicate whether GCC should generate code to use the optional BWX,
9061 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9062 sets supported by the CPU type specified via @option{-mcpu=} option or that
9063 of the CPU on which GCC was built if none was specified.
9064
9065 @item -mfloat-vax
9066 @itemx -mfloat-ieee
9067 @opindex mfloat-vax
9068 @opindex mfloat-ieee
9069 Generate code that uses (does not use) VAX F and G floating point
9070 arithmetic instead of IEEE single and double precision.
9071
9072 @item -mexplicit-relocs
9073 @itemx -mno-explicit-relocs
9074 @opindex mexplicit-relocs
9075 @opindex mno-explicit-relocs
9076 Older Alpha assemblers provided no way to generate symbol relocations
9077 except via assembler macros.  Use of these macros does not allow
9078 optimal instruction scheduling.  GNU binutils as of version 2.12
9079 supports a new syntax that allows the compiler to explicitly mark
9080 which relocations should apply to which instructions.  This option
9081 is mostly useful for debugging, as GCC detects the capabilities of
9082 the assembler when it is built and sets the default accordingly.
9083
9084 @item -msmall-data
9085 @itemx -mlarge-data
9086 @opindex msmall-data
9087 @opindex mlarge-data
9088 When @option{-mexplicit-relocs} is in effect, static data is
9089 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9090 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9091 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9092 16-bit relocations off of the @code{$gp} register.  This limits the
9093 size of the small data area to 64KB, but allows the variables to be
9094 directly accessed via a single instruction.
9095
9096 The default is @option{-mlarge-data}.  With this option the data area
9097 is limited to just below 2GB.  Programs that require more than 2GB of
9098 data must use @code{malloc} or @code{mmap} to allocate the data in the
9099 heap instead of in the program's data segment.
9100
9101 When generating code for shared libraries, @option{-fpic} implies
9102 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9103
9104 @item -msmall-text
9105 @itemx -mlarge-text
9106 @opindex msmall-text
9107 @opindex mlarge-text
9108 When @option{-msmall-text} is used, the compiler assumes that the
9109 code of the entire program (or shared library) fits in 4MB, and is
9110 thus reachable with a branch instruction.  When @option{-msmall-data}
9111 is used, the compiler can assume that all local symbols share the
9112 same @code{$gp} value, and thus reduce the number of instructions
9113 required for a function call from 4 to 1.
9114
9115 The default is @option{-mlarge-text}.
9116
9117 @item -mcpu=@var{cpu_type}
9118 @opindex mcpu
9119 Set the instruction set and instruction scheduling parameters for
9120 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9121 style name or the corresponding chip number.  GCC supports scheduling
9122 parameters for the EV4, EV5 and EV6 family of processors and will
9123 choose the default values for the instruction set from the processor
9124 you specify.  If you do not specify a processor type, GCC will default
9125 to the processor on which the compiler was built.
9126
9127 Supported values for @var{cpu_type} are
9128
9129 @table @samp
9130 @item ev4
9131 @itemx ev45
9132 @itemx 21064
9133 Schedules as an EV4 and has no instruction set extensions.
9134
9135 @item ev5
9136 @itemx 21164
9137 Schedules as an EV5 and has no instruction set extensions.
9138
9139 @item ev56
9140 @itemx 21164a
9141 Schedules as an EV5 and supports the BWX extension.
9142
9143 @item pca56
9144 @itemx 21164pc
9145 @itemx 21164PC
9146 Schedules as an EV5 and supports the BWX and MAX extensions.
9147
9148 @item ev6
9149 @itemx 21264
9150 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9151
9152 @item ev67
9153 @itemx 21264a
9154 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9155 @end table
9156
9157 @item -mtune=@var{cpu_type}
9158 @opindex mtune
9159 Set only the instruction scheduling parameters for machine type
9160 @var{cpu_type}.  The instruction set is not changed.
9161
9162 @item -mmemory-latency=@var{time}
9163 @opindex mmemory-latency
9164 Sets the latency the scheduler should assume for typical memory
9165 references as seen by the application.  This number is highly
9166 dependent on the memory access patterns used by the application
9167 and the size of the external cache on the machine.
9168
9169 Valid options for @var{time} are
9170
9171 @table @samp
9172 @item @var{number}
9173 A decimal number representing clock cycles.
9174
9175 @item L1
9176 @itemx L2
9177 @itemx L3
9178 @itemx main
9179 The compiler contains estimates of the number of clock cycles for
9180 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9181 (also called Dcache, Scache, and Bcache), as well as to main memory.
9182 Note that L3 is only valid for EV5.
9183
9184 @end table
9185 @end table
9186
9187 @node DEC Alpha/VMS Options
9188 @subsection DEC Alpha/VMS Options
9189
9190 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9191
9192 @table @gcctabopt
9193 @item -mvms-return-codes
9194 @opindex mvms-return-codes
9195 Return VMS condition codes from main.  The default is to return POSIX
9196 style condition (e.g.@ error) codes.
9197 @end table
9198
9199 @node H8/300 Options
9200 @subsection H8/300 Options
9201
9202 These @samp{-m} options are defined for the H8/300 implementations:
9203
9204 @table @gcctabopt
9205 @item -mrelax
9206 @opindex mrelax
9207 Shorten some address references at link time, when possible; uses the
9208 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9209 ld, Using ld}, for a fuller description.
9210
9211 @item -mh
9212 @opindex mh
9213 Generate code for the H8/300H@.
9214
9215 @item -ms
9216 @opindex ms
9217 Generate code for the H8S@.
9218
9219 @item -mn
9220 @opindex mn
9221 Generate code for the H8S and H8/300H in the normal mode.  This switch
9222 must be used either with -mh or -ms.
9223
9224 @item -ms2600
9225 @opindex ms2600
9226 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9227
9228 @item -mint32
9229 @opindex mint32
9230 Make @code{int} data 32 bits by default.
9231
9232 @item -malign-300
9233 @opindex malign-300
9234 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9235 The default for the H8/300H and H8S is to align longs and floats on 4
9236 byte boundaries.
9237 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9238 This option has no effect on the H8/300.
9239 @end table
9240
9241 @node SH Options
9242 @subsection SH Options
9243
9244 These @samp{-m} options are defined for the SH implementations:
9245
9246 @table @gcctabopt
9247 @item -m1
9248 @opindex m1
9249 Generate code for the SH1.
9250
9251 @item -m2
9252 @opindex m2
9253 Generate code for the SH2.
9254
9255 @item -m2e
9256 Generate code for the SH2e.
9257
9258 @item -m3
9259 @opindex m3
9260 Generate code for the SH3.
9261
9262 @item -m3e
9263 @opindex m3e
9264 Generate code for the SH3e.
9265
9266 @item -m4-nofpu
9267 @opindex m4-nofpu
9268 Generate code for the SH4 without a floating-point unit.
9269
9270 @item -m4-single-only
9271 @opindex m4-single-only
9272 Generate code for the SH4 with a floating-point unit that only
9273 supports single-precision arithmetic.
9274
9275 @item -m4-single
9276 @opindex m4-single
9277 Generate code for the SH4 assuming the floating-point unit is in
9278 single-precision mode by default.
9279
9280 @item -m4
9281 @opindex m4
9282 Generate code for the SH4.
9283
9284 @item -mb
9285 @opindex mb
9286 Compile code for the processor in big endian mode.
9287
9288 @item -ml
9289 @opindex ml
9290 Compile code for the processor in little endian mode.
9291
9292 @item -mdalign
9293 @opindex mdalign
9294 Align doubles at 64-bit boundaries.  Note that this changes the calling
9295 conventions, and thus some functions from the standard C library will
9296 not work unless you recompile it first with @option{-mdalign}.
9297
9298 @item -mrelax
9299 @opindex mrelax
9300 Shorten some address references at link time, when possible; uses the
9301 linker option @option{-relax}.
9302
9303 @item -mbigtable
9304 @opindex mbigtable
9305 Use 32-bit offsets in @code{switch} tables.  The default is to use
9306 16-bit offsets.
9307
9308 @item -mfmovd
9309 @opindex mfmovd
9310 Enable the use of the instruction @code{fmovd}.
9311
9312 @item -mhitachi
9313 @opindex mhitachi
9314 Comply with the calling conventions defined by Renesas.
9315
9316 @item -mnomacsave
9317 @opindex mnomacsave
9318 Mark the @code{MAC} register as call-clobbered, even if
9319 @option{-mhitachi} is given.
9320
9321 @item -mieee
9322 @opindex mieee
9323 Increase IEEE-compliance of floating-point code.
9324
9325 @item -misize
9326 @opindex misize
9327 Dump instruction size and location in the assembly code.
9328
9329 @item -mpadstruct
9330 @opindex mpadstruct
9331 This option is deprecated.  It pads structures to multiple of 4 bytes,
9332 which is incompatible with the SH ABI@.
9333
9334 @item -mspace
9335 @opindex mspace
9336 Optimize for space instead of speed.  Implied by @option{-Os}.
9337
9338 @item -mprefergot
9339 @opindex mprefergot
9340 When generating position-independent code, emit function calls using
9341 the Global Offset Table instead of the Procedure Linkage Table.
9342
9343 @item -musermode
9344 @opindex musermode
9345 Generate a library function call to invalidate instruction cache
9346 entries, after fixing up a trampoline.  This library function call
9347 doesn't assume it can write to the whole memory address space.  This
9348 is the default when the target is @code{sh-*-linux*}.
9349 @end table
9350
9351 @node System V Options
9352 @subsection Options for System V
9353
9354 These additional options are available on System V Release 4 for
9355 compatibility with other compilers on those systems:
9356
9357 @table @gcctabopt
9358 @item -G
9359 @opindex G
9360 Create a shared object.
9361 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9362
9363 @item -Qy
9364 @opindex Qy
9365 Identify the versions of each tool used by the compiler, in a
9366 @code{.ident} assembler directive in the output.
9367
9368 @item -Qn
9369 @opindex Qn
9370 Refrain from adding @code{.ident} directives to the output file (this is
9371 the default).
9372
9373 @item -YP,@var{dirs}
9374 @opindex YP
9375 Search the directories @var{dirs}, and no others, for libraries
9376 specified with @option{-l}.
9377
9378 @item -Ym,@var{dir}
9379 @opindex Ym
9380 Look in the directory @var{dir} to find the M4 preprocessor.
9381 The assembler uses this option.
9382 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9383 @c the generic assembler that comes with Solaris takes just -Ym.
9384 @end table
9385
9386 @node TMS320C3x/C4x Options
9387 @subsection TMS320C3x/C4x Options
9388 @cindex TMS320C3x/C4x Options
9389
9390 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9391
9392 @table @gcctabopt
9393
9394 @item -mcpu=@var{cpu_type}
9395 @opindex mcpu
9396 Set the instruction set, register set, and instruction scheduling
9397 parameters for machine type @var{cpu_type}.  Supported values for
9398 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9399 @samp{c44}.  The default is @samp{c40} to generate code for the
9400 TMS320C40.
9401
9402 @item -mbig-memory
9403 @itemx -mbig
9404 @itemx -msmall-memory
9405 @itemx -msmall
9406 @opindex mbig-memory
9407 @opindex mbig
9408 @opindex msmall-memory
9409 @opindex msmall
9410 Generates code for the big or small memory model.  The small memory
9411 model assumed that all data fits into one 64K word page.  At run-time
9412 the data page (DP) register must be set to point to the 64K page
9413 containing the .bss and .data program sections.  The big memory model is
9414 the default and requires reloading of the DP register for every direct
9415 memory access.
9416
9417 @item -mbk
9418 @itemx -mno-bk
9419 @opindex mbk
9420 @opindex mno-bk
9421 Allow (disallow) allocation of general integer operands into the block
9422 count register BK@.
9423
9424 @item -mdb
9425 @itemx -mno-db
9426 @opindex mdb
9427 @opindex mno-db
9428 Enable (disable) generation of code using decrement and branch,
9429 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9430 on the safe side, this is disabled for the C3x, since the maximum
9431 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9432 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9433 that it can utilize the decrement and branch instruction, but will give
9434 up if there is more than one memory reference in the loop.  Thus a loop
9435 where the loop counter is decremented can generate slightly more
9436 efficient code, in cases where the RPTB instruction cannot be utilized.
9437
9438 @item -mdp-isr-reload
9439 @itemx -mparanoid
9440 @opindex mdp-isr-reload
9441 @opindex mparanoid
9442 Force the DP register to be saved on entry to an interrupt service
9443 routine (ISR), reloaded to point to the data section, and restored on
9444 exit from the ISR@.  This should not be required unless someone has
9445 violated the small memory model by modifying the DP register, say within
9446 an object library.
9447
9448 @item -mmpyi
9449 @itemx -mno-mpyi
9450 @opindex mmpyi
9451 @opindex mno-mpyi
9452 For the C3x use the 24-bit MPYI instruction for integer multiplies
9453 instead of a library call to guarantee 32-bit results.  Note that if one
9454 of the operands is a constant, then the multiplication will be performed
9455 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9456 then squaring operations are performed inline instead of a library call.
9457
9458 @item -mfast-fix
9459 @itemx -mno-fast-fix
9460 @opindex mfast-fix
9461 @opindex mno-fast-fix
9462 The C3x/C4x FIX instruction to convert a floating point value to an
9463 integer value chooses the nearest integer less than or equal to the
9464 floating point value rather than to the nearest integer.  Thus if the
9465 floating point number is negative, the result will be incorrectly
9466 truncated an additional code is necessary to detect and correct this
9467 case.  This option can be used to disable generation of the additional
9468 code required to correct the result.
9469
9470 @item -mrptb
9471 @itemx -mno-rptb
9472 @opindex mrptb
9473 @opindex mno-rptb
9474 Enable (disable) generation of repeat block sequences using the RPTB
9475 instruction for zero overhead looping.  The RPTB construct is only used
9476 for innermost loops that do not call functions or jump across the loop
9477 boundaries.  There is no advantage having nested RPTB loops due to the
9478 overhead required to save and restore the RC, RS, and RE registers.
9479 This is enabled by default with @option{-O2}.
9480
9481 @item -mrpts=@var{count}
9482 @itemx -mno-rpts
9483 @opindex mrpts
9484 @opindex mno-rpts
9485 Enable (disable) the use of the single instruction repeat instruction
9486 RPTS@.  If a repeat block contains a single instruction, and the loop
9487 count can be guaranteed to be less than the value @var{count}, GCC will
9488 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9489 then a RPTS will be emitted even if the loop count cannot be determined
9490 at compile time.  Note that the repeated instruction following RPTS does
9491 not have to be reloaded from memory each iteration, thus freeing up the
9492 CPU buses for operands.  However, since interrupts are blocked by this
9493 instruction, it is disabled by default.
9494
9495 @item -mloop-unsigned
9496 @itemx -mno-loop-unsigned
9497 @opindex mloop-unsigned
9498 @opindex mno-loop-unsigned
9499 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9500 is @math{2^{31} + 1} since these instructions test if the iteration count is
9501 negative to terminate the loop.  If the iteration count is unsigned
9502 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9503 exceeded.  This switch allows an unsigned iteration count.
9504
9505 @item -mti
9506 @opindex mti
9507 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9508 with.  This also enforces compatibility with the API employed by the TI
9509 C3x C compiler.  For example, long doubles are passed as structures
9510 rather than in floating point registers.
9511
9512 @item -mregparm
9513 @itemx -mmemparm
9514 @opindex mregparm
9515 @opindex mmemparm
9516 Generate code that uses registers (stack) for passing arguments to functions.
9517 By default, arguments are passed in registers where possible rather
9518 than by pushing arguments on to the stack.
9519
9520 @item -mparallel-insns
9521 @itemx -mno-parallel-insns
9522 @opindex mparallel-insns
9523 @opindex mno-parallel-insns
9524 Allow the generation of parallel instructions.  This is enabled by
9525 default with @option{-O2}.
9526
9527 @item -mparallel-mpy
9528 @itemx -mno-parallel-mpy
9529 @opindex mparallel-mpy
9530 @opindex mno-parallel-mpy
9531 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9532 provided @option{-mparallel-insns} is also specified.  These instructions have
9533 tight register constraints which can pessimize the code generation
9534 of large functions.
9535
9536 @end table
9537
9538 @node V850 Options
9539 @subsection V850 Options
9540 @cindex V850 Options
9541
9542 These @samp{-m} options are defined for V850 implementations:
9543
9544 @table @gcctabopt
9545 @item -mlong-calls
9546 @itemx -mno-long-calls
9547 @opindex mlong-calls
9548 @opindex mno-long-calls
9549 Treat all calls as being far away (near).  If calls are assumed to be
9550 far away, the compiler will always load the functions address up into a
9551 register, and call indirect through the pointer.
9552
9553 @item -mno-ep
9554 @itemx -mep
9555 @opindex mno-ep
9556 @opindex mep
9557 Do not optimize (do optimize) basic blocks that use the same index
9558 pointer 4 or more times to copy pointer into the @code{ep} register, and
9559 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9560 option is on by default if you optimize.
9561
9562 @item -mno-prolog-function
9563 @itemx -mprolog-function
9564 @opindex mno-prolog-function
9565 @opindex mprolog-function
9566 Do not use (do use) external functions to save and restore registers
9567 at the prologue and epilogue of a function.  The external functions
9568 are slower, but use less code space if more than one function saves
9569 the same number of registers.  The @option{-mprolog-function} option
9570 is on by default if you optimize.
9571
9572 @item -mspace
9573 @opindex mspace
9574 Try to make the code as small as possible.  At present, this just turns
9575 on the @option{-mep} and @option{-mprolog-function} options.
9576
9577 @item -mtda=@var{n}
9578 @opindex mtda
9579 Put static or global variables whose size is @var{n} bytes or less into
9580 the tiny data area that register @code{ep} points to.  The tiny data
9581 area can hold up to 256 bytes in total (128 bytes for byte references).
9582
9583 @item -msda=@var{n}
9584 @opindex msda
9585 Put static or global variables whose size is @var{n} bytes or less into
9586 the small data area that register @code{gp} points to.  The small data
9587 area can hold up to 64 kilobytes.
9588
9589 @item -mzda=@var{n}
9590 @opindex mzda
9591 Put static or global variables whose size is @var{n} bytes or less into
9592 the first 32 kilobytes of memory.
9593
9594 @item -mv850
9595 @opindex mv850
9596 Specify that the target processor is the V850.
9597
9598 @item -mbig-switch
9599 @opindex mbig-switch
9600 Generate code suitable for big switch tables.  Use this option only if
9601 the assembler/linker complain about out of range branches within a switch
9602 table.
9603
9604 @item -mapp-regs
9605 @opindex mapp-regs
9606 This option will cause r2 and r5 to be used in the code generated by
9607 the compiler.  This setting is the default.
9608
9609 @item -mno-app-regs
9610 @opindex mno-app-regs
9611 This option will cause r2 and r5 to be treated as fixed registers.
9612
9613 @item -mv850e1
9614 @opindex mv850e1
9615 Specify that the target processor is the V850E1.  The preprocessor
9616 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9617 this option is used.
9618
9619 @item -mv850e
9620 @opindex mv850e
9621 Specify that the target processor is the V850E.  The preprocessor
9622 constant @samp{__v850e__} will be defined if this option is used.
9623
9624 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9625 are defined then a default target processor will be chosen and the
9626 relevant @samp{__v850*__} preprocessor constant will be defined.
9627
9628 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9629 defined, regardless of which processor variant is the target.
9630
9631 @item -mdisable-callt
9632 @opindex mdisable-callt
9633 This option will suppress generation of the CALLT instruction for the
9634 v850e and v850e1 flavors of the v850 architecture.  The default is
9635 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9636
9637 @end table
9638
9639 @node ARC Options
9640 @subsection ARC Options
9641 @cindex ARC Options
9642
9643 These options are defined for ARC implementations:
9644
9645 @table @gcctabopt
9646 @item -EL
9647 @opindex EL
9648 Compile code for little endian mode.  This is the default.
9649
9650 @item -EB
9651 @opindex EB
9652 Compile code for big endian mode.
9653
9654 @item -mmangle-cpu
9655 @opindex mmangle-cpu
9656 Prepend the name of the cpu to all public symbol names.
9657 In multiple-processor systems, there are many ARC variants with different
9658 instruction and register set characteristics.  This flag prevents code
9659 compiled for one cpu to be linked with code compiled for another.
9660 No facility exists for handling variants that are ``almost identical''.
9661 This is an all or nothing option.
9662
9663 @item -mcpu=@var{cpu}
9664 @opindex mcpu
9665 Compile code for ARC variant @var{cpu}.
9666 Which variants are supported depend on the configuration.
9667 All variants support @option{-mcpu=base}, this is the default.
9668
9669 @item -mtext=@var{text-section}
9670 @itemx -mdata=@var{data-section}
9671 @itemx -mrodata=@var{readonly-data-section}
9672 @opindex mtext
9673 @opindex mdata
9674 @opindex mrodata
9675 Put functions, data, and readonly data in @var{text-section},
9676 @var{data-section}, and @var{readonly-data-section} respectively
9677 by default.  This can be overridden with the @code{section} attribute.
9678 @xref{Variable Attributes}.
9679
9680 @end table
9681
9682 @node NS32K Options
9683 @subsection NS32K Options
9684 @cindex NS32K options
9685
9686 These are the @samp{-m} options defined for the 32000 series.  The default
9687 values for these options depends on which style of 32000 was selected when
9688 the compiler was configured; the defaults for the most common choices are
9689 given below.
9690
9691 @table @gcctabopt
9692 @item -m32032
9693 @itemx -m32032
9694 @opindex m32032
9695 @opindex m32032
9696 Generate output for a 32032.  This is the default
9697 when the compiler is configured for 32032 and 32016 based systems.
9698
9699 @item -m32332
9700 @itemx -m32332
9701 @opindex m32332
9702 @opindex m32332
9703 Generate output for a 32332.  This is the default
9704 when the compiler is configured for 32332-based systems.
9705
9706 @item -m32532
9707 @itemx -m32532
9708 @opindex m32532
9709 @opindex m32532
9710 Generate output for a 32532.  This is the default
9711 when the compiler is configured for 32532-based systems.
9712
9713 @item -m32081
9714 @opindex m32081
9715 Generate output containing 32081 instructions for floating point.
9716 This is the default for all systems.
9717
9718 @item -m32381
9719 @opindex m32381
9720 Generate output containing 32381 instructions for floating point.  This
9721 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9722 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9723
9724 @item -mmulti-add
9725 @opindex mmulti-add
9726 Try and generate multiply-add floating point instructions @code{polyF}
9727 and @code{dotF}.  This option is only available if the @option{-m32381}
9728 option is in effect.  Using these instructions requires changes to
9729 register allocation which generally has a negative impact on
9730 performance.  This option should only be enabled when compiling code
9731 particularly likely to make heavy use of multiply-add instructions.
9732
9733 @item -mnomulti-add
9734 @opindex mnomulti-add
9735 Do not try and generate multiply-add floating point instructions
9736 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9737
9738 @item -msoft-float
9739 @opindex msoft-float
9740 Generate output containing library calls for floating point.
9741 @strong{Warning:} the requisite libraries may not be available.
9742
9743 @item -mieee-compare
9744 @itemx -mno-ieee-compare
9745 @opindex mieee-compare
9746 @opindex mno-ieee-compare
9747 Control whether or not the compiler uses IEEE floating point
9748 comparisons.  These handle correctly the case where the result of a
9749 comparison is unordered.
9750 @strong{Warning:} the requisite kernel support may not be available.
9751
9752 @item -mnobitfield
9753 @opindex mnobitfield
9754 Do not use the bit-field instructions.  On some machines it is faster to
9755 use shifting and masking operations.  This is the default for the pc532.
9756
9757 @item -mbitfield
9758 @opindex mbitfield
9759 Do use the bit-field instructions.  This is the default for all platforms
9760 except the pc532.
9761
9762 @item -mrtd
9763 @opindex mrtd
9764 Use a different function-calling convention, in which functions
9765 that take a fixed number of arguments return pop their
9766 arguments on return with the @code{ret} instruction.
9767
9768 This calling convention is incompatible with the one normally
9769 used on Unix, so you cannot use it if you need to call libraries
9770 compiled with the Unix compiler.
9771
9772 Also, you must provide function prototypes for all functions that
9773 take variable numbers of arguments (including @code{printf});
9774 otherwise incorrect code will be generated for calls to those
9775 functions.
9776
9777 In addition, seriously incorrect code will result if you call a
9778 function with too many arguments.  (Normally, extra arguments are
9779 harmlessly ignored.)
9780
9781 This option takes its name from the 680x0 @code{rtd} instruction.
9782
9783
9784 @item -mregparam
9785 @opindex mregparam
9786 Use a different function-calling convention where the first two arguments
9787 are passed in registers.
9788
9789 This calling convention is incompatible with the one normally
9790 used on Unix, so you cannot use it if you need to call libraries
9791 compiled with the Unix compiler.
9792
9793 @item -mnoregparam
9794 @opindex mnoregparam
9795 Do not pass any arguments in registers.  This is the default for all
9796 targets.
9797
9798 @item -msb
9799 @opindex msb
9800 It is OK to use the sb as an index register which is always loaded with
9801 zero.  This is the default for the pc532-netbsd target.
9802
9803 @item -mnosb
9804 @opindex mnosb
9805 The sb register is not available for use or has not been initialized to
9806 zero by the run time system.  This is the default for all targets except
9807 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9808 @option{-fpic} is set.
9809
9810 @item -mhimem
9811 @opindex mhimem
9812 Many ns32000 series addressing modes use displacements of up to 512MB@.
9813 If an address is above 512MB then displacements from zero can not be used.
9814 This option causes code to be generated which can be loaded above 512MB@.
9815 This may be useful for operating systems or ROM code.
9816
9817 @item -mnohimem
9818 @opindex mnohimem
9819 Assume code will be loaded in the first 512MB of virtual address space.
9820 This is the default for all platforms.
9821
9822
9823 @end table
9824
9825 @node AVR Options
9826 @subsection AVR Options
9827 @cindex AVR Options
9828
9829 These options are defined for AVR implementations:
9830
9831 @table @gcctabopt
9832 @item -mmcu=@var{mcu}
9833 @opindex mmcu
9834 Specify ATMEL AVR instruction set or MCU type.
9835
9836 Instruction set avr1 is for the minimal AVR core, not supported by the C
9837 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9838 attiny11, attiny12, attiny15, attiny28).
9839
9840 Instruction set avr2 (default) is for the classic AVR core with up to
9841 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9842 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9843 at90c8534, at90s8535).
9844
9845 Instruction set avr3 is for the classic AVR core with up to 128K program
9846 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9847
9848 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9849 memory space (MCU types: atmega8, atmega83, atmega85).
9850
9851 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9852 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9853 atmega64, atmega128, at43usb355, at94k).
9854
9855 @item -msize
9856 @opindex msize
9857 Output instruction sizes to the asm file.
9858
9859 @item -minit-stack=@var{N}
9860 @opindex minit-stack
9861 Specify the initial stack address, which may be a symbol or numeric value,
9862 @samp{__stack} is the default.
9863
9864 @item -mno-interrupts
9865 @opindex mno-interrupts
9866 Generated code is not compatible with hardware interrupts.
9867 Code size will be smaller.
9868
9869 @item -mcall-prologues
9870 @opindex mcall-prologues
9871 Functions prologues/epilogues expanded as call to appropriate
9872 subroutines.  Code size will be smaller.
9873
9874 @item -mno-tablejump
9875 @opindex mno-tablejump
9876 Do not generate tablejump insns which sometimes increase code size.
9877
9878 @item -mtiny-stack
9879 @opindex mtiny-stack
9880 Change only the low 8 bits of the stack pointer.
9881 @end table
9882
9883 @node MCore Options
9884 @subsection MCore Options
9885 @cindex MCore options
9886
9887 These are the @samp{-m} options defined for the Motorola M*Core
9888 processors.
9889
9890 @table @gcctabopt
9891
9892 @item -mhardlit
9893 @itemx -mno-hardlit
9894 @opindex mhardlit
9895 @opindex mno-hardlit
9896 Inline constants into the code stream if it can be done in two
9897 instructions or less.
9898
9899 @item -mdiv
9900 @itemx -mno-div
9901 @opindex mdiv
9902 @opindex mno-div
9903 Use the divide instruction.  (Enabled by default).
9904
9905 @item -mrelax-immediate
9906 @itemx -mno-relax-immediate
9907 @opindex mrelax-immediate
9908 @opindex mno-relax-immediate
9909 Allow arbitrary sized immediates in bit operations.
9910
9911 @item -mwide-bitfields
9912 @itemx -mno-wide-bitfields
9913 @opindex mwide-bitfields
9914 @opindex mno-wide-bitfields
9915 Always treat bit-fields as int-sized.
9916
9917 @item -m4byte-functions
9918 @itemx -mno-4byte-functions
9919 @opindex m4byte-functions
9920 @opindex mno-4byte-functions
9921 Force all functions to be aligned to a four byte boundary.
9922
9923 @item -mcallgraph-data
9924 @itemx -mno-callgraph-data
9925 @opindex mcallgraph-data
9926 @opindex mno-callgraph-data
9927 Emit callgraph information.
9928
9929 @item -mslow-bytes
9930 @itemx -mno-slow-bytes
9931 @opindex mslow-bytes
9932 @opindex mno-slow-bytes
9933 Prefer word access when reading byte quantities.
9934
9935 @item -mlittle-endian
9936 @itemx -mbig-endian
9937 @opindex mlittle-endian
9938 @opindex mbig-endian
9939 Generate code for a little endian target.
9940
9941 @item -m210
9942 @itemx -m340
9943 @opindex m210
9944 @opindex m340
9945 Generate code for the 210 processor.
9946 @end table
9947
9948 @node IA-64 Options
9949 @subsection IA-64 Options
9950 @cindex IA-64 Options
9951
9952 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9953
9954 @table @gcctabopt
9955 @item -mbig-endian
9956 @opindex mbig-endian
9957 Generate code for a big endian target.  This is the default for HP-UX@.
9958
9959 @item -mlittle-endian
9960 @opindex mlittle-endian
9961 Generate code for a little endian target.  This is the default for AIX5
9962 and GNU/Linux.
9963
9964 @item -mgnu-as
9965 @itemx -mno-gnu-as
9966 @opindex mgnu-as
9967 @opindex mno-gnu-as
9968 Generate (or don't) code for the GNU assembler.  This is the default.
9969 @c Also, this is the default if the configure option @option{--with-gnu-as}
9970 @c is used.
9971
9972 @item -mgnu-ld
9973 @itemx -mno-gnu-ld
9974 @opindex mgnu-ld
9975 @opindex mno-gnu-ld
9976 Generate (or don't) code for the GNU linker.  This is the default.
9977 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9978 @c is used.
9979
9980 @item -mno-pic
9981 @opindex mno-pic
9982 Generate code that does not use a global pointer register.  The result
9983 is not position independent code, and violates the IA-64 ABI@.
9984
9985 @item -mvolatile-asm-stop
9986 @itemx -mno-volatile-asm-stop
9987 @opindex mvolatile-asm-stop
9988 @opindex mno-volatile-asm-stop
9989 Generate (or don't) a stop bit immediately before and after volatile asm
9990 statements.
9991
9992 @item -mb-step
9993 @opindex mb-step
9994 Generate code that works around Itanium B step errata.
9995
9996 @item -mregister-names
9997 @itemx -mno-register-names
9998 @opindex mregister-names
9999 @opindex mno-register-names
10000 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10001 the stacked registers.  This may make assembler output more readable.
10002
10003 @item -mno-sdata
10004 @itemx -msdata
10005 @opindex mno-sdata
10006 @opindex msdata
10007 Disable (or enable) optimizations that use the small data section.  This may
10008 be useful for working around optimizer bugs.
10009
10010 @item -mconstant-gp
10011 @opindex mconstant-gp
10012 Generate code that uses a single constant global pointer value.  This is
10013 useful when compiling kernel code.
10014
10015 @item -mauto-pic
10016 @opindex mauto-pic
10017 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10018 This is useful when compiling firmware code.
10019
10020 @item -minline-float-divide-min-latency
10021 @opindex minline-float-divide-min-latency
10022 Generate code for inline divides of floating point values
10023 using the minimum latency algorithm.
10024
10025 @item -minline-float-divide-max-throughput
10026 @opindex minline-float-divide-max-throughput
10027 Generate code for inline divides of floating point values
10028 using the maximum throughput algorithm.
10029
10030 @item -minline-int-divide-min-latency
10031 @opindex minline-int-divide-min-latency
10032 Generate code for inline divides of integer values
10033 using the minimum latency algorithm.
10034
10035 @item -minline-int-divide-max-throughput
10036 @opindex minline-int-divide-max-throughput
10037 Generate code for inline divides of integer values
10038 using the maximum throughput algorithm.
10039
10040 @item -minline-sqrt-min-latency
10041 @opindex minline-sqrt-min-latency
10042 Generate code for inline square roots
10043 using the minimum latency algorithm.
10044
10045 @item -minline-sqrt-max-throughput
10046 @opindex minline-sqrt-max-throughput
10047 Generate code for inline square roots
10048 using the maximum throughput algorithm.
10049
10050 @item -mno-dwarf2-asm
10051 @itemx -mdwarf2-asm
10052 @opindex mno-dwarf2-asm
10053 @opindex mdwarf2-asm
10054 Don't (or do) generate assembler code for the DWARF2 line number debugging
10055 info.  This may be useful when not using the GNU assembler.
10056
10057 @item -mearly-stop-bits
10058 @itemx -mno-early-stop-bits
10059 @opindex mearly-stop-bits
10060 @opindex mno-early-stop-bits
10061 Allow stop bits to be placed earlier than immediately preceding the
10062 instruction that triggered the stop bit.  This can improve instruction
10063 scheduling, but does not always do so.
10064
10065 @item -mfixed-range=@var{register-range}
10066 @opindex mfixed-range
10067 Generate code treating the given register range as fixed registers.
10068 A fixed register is one that the register allocator can not use.  This is
10069 useful when compiling kernel code.  A register range is specified as
10070 two registers separated by a dash.  Multiple register ranges can be
10071 specified separated by a comma.
10072
10073 @item -mtls-size=@var{tls-size}
10074 @opindex mtls-size
10075 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
10076 64.
10077
10078 @item -mtune-arch=@var{cpu-type}
10079 @opindex mtune-arch
10080 Tune the instruction scheduling for a particular CPU, Valid values are
10081 itanium, itanium1, merced, itanium2, and mckinley.
10082
10083 @item -mt
10084 @itemx -pthread
10085 @opindex mt
10086 @opindex pthread
10087 Add support for multithreading using the POSIX threads library.  This
10088 option sets flags for both the preprocessor and linker.  It does
10089 not affect the thread safety of object code produced by the compiler or
10090 that of libraries supplied with it.  These are HP-UX specific flags.
10091
10092 @item -milp32
10093 @itemx -mlp64
10094 @opindex milp32
10095 @opindex mlp64
10096 Generate code for a 32-bit or 64-bit environment.
10097 The 32-bit environment sets int, long and pointer to 32 bits.
10098 The 64-bit environment sets int to 32 bits and long and pointer
10099 to 64 bits.  These are HP-UX specific flags.
10100
10101 @end table
10102
10103 @node D30V Options
10104 @subsection D30V Options
10105 @cindex D30V Options
10106
10107 These @samp{-m} options are defined for D30V implementations:
10108
10109 @table @gcctabopt
10110 @item -mextmem
10111 @opindex mextmem
10112 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10113 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10114 memory, which starts at location @code{0x80000000}.
10115
10116 @item -mextmemory
10117 @opindex mextmemory
10118 Same as the @option{-mextmem} switch.
10119
10120 @item -monchip
10121 @opindex monchip
10122 Link the @samp{.text} section into onchip text memory, which starts at
10123 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10124 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10125 into onchip data memory, which starts at location @code{0x20000000}.
10126
10127 @item -mno-asm-optimize
10128 @itemx -masm-optimize
10129 @opindex mno-asm-optimize
10130 @opindex masm-optimize
10131 Disable (enable) passing @option{-O} to the assembler when optimizing.
10132 The assembler uses the @option{-O} option to automatically parallelize
10133 adjacent short instructions where possible.
10134
10135 @item -mbranch-cost=@var{n}
10136 @opindex mbranch-cost
10137 Increase the internal costs of branches to @var{n}.  Higher costs means
10138 that the compiler will issue more instructions to avoid doing a branch.
10139 The default is 2.
10140
10141 @item -mcond-exec=@var{n}
10142 @opindex mcond-exec
10143 Specify the maximum number of conditionally executed instructions that
10144 replace a branch.  The default is 4.
10145 @end table
10146
10147 @node S/390 and zSeries Options
10148 @subsection S/390 and zSeries Options
10149 @cindex S/390 and zSeries Options
10150
10151 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10152
10153 @table @gcctabopt
10154 @item -mhard-float
10155 @itemx -msoft-float
10156 @opindex mhard-float
10157 @opindex msoft-float
10158 Use (do not use) the hardware floating-point instructions and registers
10159 for floating-point operations.  When @option{-msoft-float} is specified,
10160 functions in @file{libgcc.a} will be used to perform floating-point
10161 operations.  When @option{-mhard-float} is specified, the compiler
10162 generates IEEE floating-point instructions.  This is the default.
10163
10164 @item -mbackchain
10165 @itemx -mno-backchain
10166 @opindex mbackchain
10167 @opindex mno-backchain
10168 Generate (or do not generate) code which maintains an explicit
10169 backchain within the stack frame that points to the caller's frame.
10170 This may be needed to allow debugging using tools that do not understand
10171 DWARF-2 call frame information.  The default is not to generate the
10172 backchain.
10173
10174 @item -msmall-exec
10175 @itemx -mno-small-exec
10176 @opindex msmall-exec
10177 @opindex mno-small-exec
10178 Generate (or do not generate) code using the @code{bras} instruction
10179 to do subroutine calls.
10180 This only works reliably if the total executable size does not
10181 exceed 64k.  The default is to use the @code{basr} instruction instead,
10182 which does not have this limitation.
10183
10184 @item -m64
10185 @itemx -m31
10186 @opindex m64
10187 @opindex m31
10188 When @option{-m31} is specified, generate code compliant to the
10189 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10190 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10191 particular to generate 64-bit instructions.  For the @samp{s390}
10192 targets, the default is @option{-m31}, while the @samp{s390x}
10193 targets default to @option{-m64}.
10194
10195 @item -mzarch
10196 @itemx -mesa
10197 @opindex mzarch
10198 @opindex mesa
10199 When @option{-mzarch} is specified, generate code using the
10200 instructions available on z/Architecture.
10201 When @option{-mesa} is specified, generate code using the
10202 instructions available on ESA/390. Note that @option{-mesa} is
10203 not possible with @option{-m64}.
10204 When generating code compliant to the GNU/Linux for S/390 ABI,
10205 the default is @option{-mesa}.  When generating code compliant
10206 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10207
10208 @item -mmvcle
10209 @itemx -mno-mvcle
10210 @opindex mmvcle
10211 @opindex mno-mvcle
10212 Generate (or do not generate) code using the @code{mvcle} instruction
10213 to perform block moves.  When @option{-mno-mvcle} is specified,
10214 use a @code{mvc} loop instead.  This is the default.
10215
10216 @item -mdebug
10217 @itemx -mno-debug
10218 @opindex mdebug
10219 @opindex mno-debug
10220 Print (or do not print) additional debug information when compiling.
10221 The default is to not print debug information.
10222
10223 @item -march=@var{cpu-type}
10224 @opindex march
10225 Generate code that will run on @var{cpu-type}, which is the name of a system
10226 representing a certain processor type. Possible values for
10227 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10228 When generating code using the instructions available on z/Architecture,
10229 the default is @option{-march=z900}.  Otherwise, the default is
10230 @option{-march=g5}.
10231
10232 @item -mtune=@var{cpu-type}
10233 @opindex mtune
10234 Tune to @var{cpu-type} everything applicable about the generated code,
10235 except for the ABI and the set of available instructions.
10236 The list of @var{cpu-type} values is the same as for @option{-march}.
10237 The default is the value used for @option{-march}.
10238
10239 @item -mfused-madd
10240 @itemx -mno-fused-madd
10241 @opindex mfused-madd
10242 @opindex mno-fused-madd
10243 Generate code that uses (does not use) the floating point multiply and
10244 accumulate instructions.  These instructions are generated by default if
10245 hardware floating point is used.
10246 @end table
10247
10248 @node CRIS Options
10249 @subsection CRIS Options
10250 @cindex CRIS Options
10251
10252 These options are defined specifically for the CRIS ports.
10253
10254 @table @gcctabopt
10255 @item -march=@var{architecture-type}
10256 @itemx -mcpu=@var{architecture-type}
10257 @opindex march
10258 @opindex mcpu
10259 Generate code for the specified architecture.  The choices for
10260 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10261 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10262 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10263 @samp{v10}.
10264
10265 @item -mtune=@var{architecture-type}
10266 @opindex mtune
10267 Tune to @var{architecture-type} everything applicable about the generated
10268 code, except for the ABI and the set of available instructions.  The
10269 choices for @var{architecture-type} are the same as for
10270 @option{-march=@var{architecture-type}}.
10271
10272 @item -mmax-stack-frame=@var{n}
10273 @opindex mmax-stack-frame
10274 Warn when the stack frame of a function exceeds @var{n} bytes.
10275
10276 @item -melinux-stacksize=@var{n}
10277 @opindex melinux-stacksize
10278 Only available with the @samp{cris-axis-aout} target.  Arranges for
10279 indications in the program to the kernel loader that the stack of the
10280 program should be set to @var{n} bytes.
10281
10282 @item -metrax4
10283 @itemx -metrax100
10284 @opindex metrax4
10285 @opindex metrax100
10286 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10287 @option{-march=v3} and @option{-march=v8} respectively.
10288
10289 @item -mmul-bug-workaround
10290 @itemx -mno-mul-bug-workaround
10291 @opindex mmul-bug-workaround
10292 @opindex mno-mul-bug-workaround
10293 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10294 models where it applies.  This option is active by default.
10295
10296 @item -mpdebug
10297 @opindex mpdebug
10298 Enable CRIS-specific verbose debug-related information in the assembly
10299 code.  This option also has the effect to turn off the @samp{#NO_APP}
10300 formatted-code indicator to the assembler at the beginning of the
10301 assembly file.
10302
10303 @item -mcc-init
10304 @opindex mcc-init
10305 Do not use condition-code results from previous instruction; always emit
10306 compare and test instructions before use of condition codes.
10307
10308 @item -mno-side-effects
10309 @opindex mno-side-effects
10310 Do not emit instructions with side-effects in addressing modes other than
10311 post-increment.
10312
10313 @item -mstack-align
10314 @itemx -mno-stack-align
10315 @itemx -mdata-align
10316 @itemx -mno-data-align
10317 @itemx -mconst-align
10318 @itemx -mno-const-align
10319 @opindex mstack-align
10320 @opindex mno-stack-align
10321 @opindex mdata-align
10322 @opindex mno-data-align
10323 @opindex mconst-align
10324 @opindex mno-const-align
10325 These options (no-options) arranges (eliminate arrangements) for the
10326 stack-frame, individual data and constants to be aligned for the maximum
10327 single data access size for the chosen CPU model.  The default is to
10328 arrange for 32-bit alignment.  ABI details such as structure layout are
10329 not affected by these options.
10330
10331 @item -m32-bit
10332 @itemx -m16-bit
10333 @itemx -m8-bit
10334 @opindex m32-bit
10335 @opindex m16-bit
10336 @opindex m8-bit
10337 Similar to the stack- data- and const-align options above, these options
10338 arrange for stack-frame, writable data and constants to all be 32-bit,
10339 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10340
10341 @item -mno-prologue-epilogue
10342 @itemx -mprologue-epilogue
10343 @opindex mno-prologue-epilogue
10344 @opindex mprologue-epilogue
10345 With @option{-mno-prologue-epilogue}, the normal function prologue and
10346 epilogue that sets up the stack-frame are omitted and no return
10347 instructions or return sequences are generated in the code.  Use this
10348 option only together with visual inspection of the compiled code: no
10349 warnings or errors are generated when call-saved registers must be saved,
10350 or storage for local variable needs to be allocated.
10351
10352 @item -mno-gotplt
10353 @itemx -mgotplt
10354 @opindex mno-gotplt
10355 @opindex mgotplt
10356 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10357 instruction sequences that load addresses for functions from the PLT part
10358 of the GOT rather than (traditional on other architectures) calls to the
10359 PLT.  The default is @option{-mgotplt}.
10360
10361 @item -maout
10362 @opindex maout
10363 Legacy no-op option only recognized with the cris-axis-aout target.
10364
10365 @item -melf
10366 @opindex melf
10367 Legacy no-op option only recognized with the cris-axis-elf and
10368 cris-axis-linux-gnu targets.
10369
10370 @item -melinux
10371 @opindex melinux
10372 Only recognized with the cris-axis-aout target, where it selects a
10373 GNU/linux-like multilib, include files and instruction set for
10374 @option{-march=v8}.
10375
10376 @item -mlinux
10377 @opindex mlinux
10378 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10379
10380 @item -sim
10381 @opindex sim
10382 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10383 to link with input-output functions from a simulator library.  Code,
10384 initialized data and zero-initialized data are allocated consecutively.
10385
10386 @item -sim2
10387 @opindex sim2
10388 Like @option{-sim}, but pass linker options to locate initialized data at
10389 0x40000000 and zero-initialized data at 0x80000000.
10390 @end table
10391
10392 @node MMIX Options
10393 @subsection MMIX Options
10394 @cindex MMIX Options
10395
10396 These options are defined for the MMIX:
10397
10398 @table @gcctabopt
10399 @item -mlibfuncs
10400 @itemx -mno-libfuncs
10401 @opindex mlibfuncs
10402 @opindex mno-libfuncs
10403 Specify that intrinsic library functions are being compiled, passing all
10404 values in registers, no matter the size.
10405
10406 @item -mepsilon
10407 @itemx -mno-epsilon
10408 @opindex mepsilon
10409 @opindex mno-epsilon
10410 Generate floating-point comparison instructions that compare with respect
10411 to the @code{rE} epsilon register.
10412
10413 @item -mabi=mmixware
10414 @itemx -mabi=gnu
10415 @opindex mabi-mmixware
10416 @opindex mabi=gnu
10417 Generate code that passes function parameters and return values that (in
10418 the called function) are seen as registers @code{$0} and up, as opposed to
10419 the GNU ABI which uses global registers @code{$231} and up.
10420
10421 @item -mzero-extend
10422 @itemx -mno-zero-extend
10423 @opindex mzero-extend
10424 @opindex mno-zero-extend
10425 When reading data from memory in sizes shorter than 64 bits, use (do not
10426 use) zero-extending load instructions by default, rather than
10427 sign-extending ones.
10428
10429 @item -mknuthdiv
10430 @itemx -mno-knuthdiv
10431 @opindex mknuthdiv
10432 @opindex mno-knuthdiv
10433 Make the result of a division yielding a remainder have the same sign as
10434 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10435 remainder follows the sign of the dividend.  Both methods are
10436 arithmetically valid, the latter being almost exclusively used.
10437
10438 @item -mtoplevel-symbols
10439 @itemx -mno-toplevel-symbols
10440 @opindex mtoplevel-symbols
10441 @opindex mno-toplevel-symbols
10442 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10443 code can be used with the @code{PREFIX} assembly directive.
10444
10445 @item -melf
10446 @opindex melf
10447 Generate an executable in the ELF format, rather than the default
10448 @samp{mmo} format used by the @command{mmix} simulator.
10449
10450 @item -mbranch-predict
10451 @itemx -mno-branch-predict
10452 @opindex mbranch-predict
10453 @opindex mno-branch-predict
10454 Use (do not use) the probable-branch instructions, when static branch
10455 prediction indicates a probable branch.
10456
10457 @item -mbase-addresses
10458 @itemx -mno-base-addresses
10459 @opindex mbase-addresses
10460 @opindex mno-base-addresses
10461 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10462 base address automatically generates a request (handled by the assembler
10463 and the linker) for a constant to be set up in a global register.  The
10464 register is used for one or more base address requests within the range 0
10465 to 255 from the value held in the register.  The generally leads to short
10466 and fast code, but the number of different data items that can be
10467 addressed is limited.  This means that a program that uses lots of static
10468 data may require @option{-mno-base-addresses}.
10469
10470 @item -msingle-exit
10471 @itemx -mno-single-exit
10472 @opindex msingle-exit
10473 @opindex mno-single-exit
10474 Force (do not force) generated code to have a single exit point in each
10475 function.
10476 @end table
10477
10478 @node PDP-11 Options
10479 @subsection PDP-11 Options
10480 @cindex PDP-11 Options
10481
10482 These options are defined for the PDP-11:
10483
10484 @table @gcctabopt
10485 @item -mfpu
10486 @opindex mfpu
10487 Use hardware FPP floating point.  This is the default.  (FIS floating
10488 point on the PDP-11/40 is not supported.)
10489
10490 @item -msoft-float
10491 @opindex msoft-float
10492 Do not use hardware floating point.
10493
10494 @item -mac0
10495 @opindex mac0
10496 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10497
10498 @item -mno-ac0
10499 @opindex mno-ac0
10500 Return floating-point results in memory.  This is the default.
10501
10502 @item -m40
10503 @opindex m40
10504 Generate code for a PDP-11/40.
10505
10506 @item -m45
10507 @opindex m45
10508 Generate code for a PDP-11/45.  This is the default.
10509
10510 @item -m10
10511 @opindex m10
10512 Generate code for a PDP-11/10.
10513
10514 @item -mbcopy-builtin
10515 @opindex bcopy-builtin
10516 Use inline @code{movstrhi} patterns for copying memory.  This is the
10517 default.
10518
10519 @item -mbcopy
10520 @opindex mbcopy
10521 Do not use inline @code{movstrhi} patterns for copying memory.
10522
10523 @item -mint16
10524 @itemx -mno-int32
10525 @opindex mint16
10526 @opindex mno-int32
10527 Use 16-bit @code{int}.  This is the default.
10528
10529 @item -mint32
10530 @itemx -mno-int16
10531 @opindex mint32
10532 @opindex mno-int16
10533 Use 32-bit @code{int}.
10534
10535 @item -mfloat64
10536 @itemx -mno-float32
10537 @opindex mfloat64
10538 @opindex mno-float32
10539 Use 64-bit @code{float}.  This is the default.
10540
10541 @item -mfloat32
10542 @itemx -mno-float64
10543 @opindex mfloat32
10544 @opindex mno-float64
10545 Use 32-bit @code{float}.
10546
10547 @item -mabshi
10548 @opindex mabshi
10549 Use @code{abshi2} pattern.  This is the default.
10550
10551 @item -mno-abshi
10552 @opindex mno-abshi
10553 Do not use @code{abshi2} pattern.
10554
10555 @item -mbranch-expensive
10556 @opindex mbranch-expensive
10557 Pretend that branches are expensive.  This is for experimenting with
10558 code generation only.
10559
10560 @item -mbranch-cheap
10561 @opindex mbranch-cheap
10562 Do not pretend that branches are expensive.  This is the default.
10563
10564 @item -msplit
10565 @opindex msplit
10566 Generate code for a system with split I&D.
10567
10568 @item -mno-split
10569 @opindex mno-split
10570 Generate code for a system without split I&D.  This is the default.
10571
10572 @item -munix-asm
10573 @opindex munix-asm
10574 Use Unix assembler syntax.  This is the default when configured for
10575 @samp{pdp11-*-bsd}.
10576
10577 @item -mdec-asm
10578 @opindex mdec-asm
10579 Use DEC assembler syntax.  This is the default when configured for any
10580 PDP-11 target other than @samp{pdp11-*-bsd}.
10581 @end table
10582
10583 @node Xstormy16 Options
10584 @subsection Xstormy16 Options
10585 @cindex Xstormy16 Options
10586
10587 These options are defined for Xstormy16:
10588
10589 @table @gcctabopt
10590 @item -msim
10591 @opindex msim
10592 Choose startup files and linker script suitable for the simulator.
10593 @end table
10594
10595 @node FRV Options
10596 @subsection FRV Options
10597 @cindex FRV Options
10598
10599 @table @gcctabopt
10600 @item -mgpr-32
10601 @opindex mgpr-32
10602
10603 Only use the first 32 general purpose registers.
10604
10605 @item -mgpr-64
10606 @opindex mgpr-64
10607
10608 Use all 64 general purpose registers.
10609
10610 @item -mfpr-32
10611 @opindex mfpr-32
10612
10613 Use only the first 32 floating point registers.
10614
10615 @item -mfpr-64
10616 @opindex mfpr-64
10617
10618 Use all 64 floating point registers
10619
10620 @item -mhard-float
10621 @opindex mhard-float
10622
10623 Use hardware instructions for floating point operations.
10624
10625 @item -msoft-float
10626 @opindex msoft-float
10627
10628 Use library routines for floating point operations.
10629
10630 @item -malloc-cc
10631 @opindex malloc-cc
10632
10633 Dynamically allocate condition code registers.
10634
10635 @item -mfixed-cc
10636 @opindex mfixed-cc
10637
10638 Do not try to dynamically allocate condition code registers, only
10639 use @code{icc0} and @code{fcc0}.
10640
10641 @item -mdword
10642 @opindex mdword
10643
10644 Change ABI to use double word insns.
10645
10646 @item -mno-dword
10647 @opindex mno-dword
10648
10649 Do not use double word instructions.
10650
10651 @item -mdouble
10652 @opindex mdouble
10653
10654 Use floating point double instructions.
10655
10656 @item -mno-double
10657 @opindex mno-double
10658
10659 Do not use floating point double instructions.
10660
10661 @item -mmedia
10662 @opindex mmedia
10663
10664 Use media instructions.
10665
10666 @item -mno-media
10667 @opindex mno-media
10668
10669 Do not use media instructions.
10670
10671 @item -mmuladd
10672 @opindex mmuladd
10673
10674 Use multiply and add/subtract instructions.
10675
10676 @item -mno-muladd
10677 @opindex mno-muladd
10678
10679 Do not use multiply and add/subtract instructions.
10680
10681 @item -mlibrary-pic
10682 @opindex mlibrary-pic
10683
10684 Enable PIC support for building libraries
10685
10686 @item -macc-4
10687 @opindex macc-4
10688
10689 Use only the first four media accumulator registers.
10690
10691 @item -macc-8
10692 @opindex macc-8
10693
10694 Use all eight media accumulator registers.
10695
10696 @item -mpack
10697 @opindex mpack
10698
10699 Pack VLIW instructions.
10700
10701 @item -mno-pack
10702 @opindex mno-pack
10703
10704 Do not pack VLIW instructions.
10705
10706 @item -mno-eflags
10707 @opindex mno-eflags
10708
10709 Do not mark ABI switches in e_flags.
10710
10711 @item -mcond-move
10712 @opindex mcond-move
10713
10714 Enable the use of conditional-move instructions (default).
10715
10716 This switch is mainly for debugging the compiler and will likely be removed
10717 in a future version.
10718
10719 @item -mno-cond-move
10720 @opindex mno-cond-move
10721
10722 Disable the use of conditional-move instructions.
10723
10724 This switch is mainly for debugging the compiler and will likely be removed
10725 in a future version.
10726
10727 @item -mscc
10728 @opindex mscc
10729
10730 Enable the use of conditional set instructions (default).
10731
10732 This switch is mainly for debugging the compiler and will likely be removed
10733 in a future version.
10734
10735 @item -mno-scc
10736 @opindex mno-scc
10737
10738 Disable the use of conditional set instructions.
10739
10740 This switch is mainly for debugging the compiler and will likely be removed
10741 in a future version.
10742
10743 @item -mcond-exec
10744 @opindex mcond-exec
10745
10746 Enable the use of conditional execution (default).
10747
10748 This switch is mainly for debugging the compiler and will likely be removed
10749 in a future version.
10750
10751 @item -mno-cond-exec
10752 @opindex mno-cond-exec
10753
10754 Disable the use of conditional execution.
10755
10756 This switch is mainly for debugging the compiler and will likely be removed
10757 in a future version.
10758
10759 @item -mvliw-branch
10760 @opindex mvliw-branch
10761
10762 Run a pass to pack branches into VLIW instructions (default).
10763
10764 This switch is mainly for debugging the compiler and will likely be removed
10765 in a future version.
10766
10767 @item -mno-vliw-branch
10768 @opindex mno-vliw-branch
10769
10770 Do not run a pass to pack branches into VLIW instructions.
10771
10772 This switch is mainly for debugging the compiler and will likely be removed
10773 in a future version.
10774
10775 @item -mmulti-cond-exec
10776 @opindex mmulti-cond-exec
10777
10778 Enable optimization of @code{&&} and @code{||} in conditional execution
10779 (default).
10780
10781 This switch is mainly for debugging the compiler and will likely be removed
10782 in a future version.
10783
10784 @item -mno-multi-cond-exec
10785 @opindex mno-multi-cond-exec
10786
10787 Disable optimization of @code{&&} and @code{||} in conditional execution.
10788
10789 This switch is mainly for debugging the compiler and will likely be removed
10790 in a future version.
10791
10792 @item -mnested-cond-exec
10793 @opindex mnested-cond-exec
10794
10795 Enable nested conditional execution optimizations (default).
10796
10797 This switch is mainly for debugging the compiler and will likely be removed
10798 in a future version.
10799
10800 @item -mno-nested-cond-exec
10801 @opindex mno-nested-cond-exec
10802
10803 Disable nested conditional execution optimizations.
10804
10805 This switch is mainly for debugging the compiler and will likely be removed
10806 in a future version.
10807
10808 @item -mtomcat-stats
10809 @opindex mtomcat-stats
10810
10811 Cause gas to print out tomcat statistics.
10812
10813 @item -mcpu=@var{cpu}
10814 @opindex mcpu
10815
10816 Select the processor type for which to generate code.  Possible values are
10817 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10818 @samp{frv}.
10819
10820 @end table
10821
10822 @node Xtensa Options
10823 @subsection Xtensa Options
10824 @cindex Xtensa Options
10825
10826 These options are supported for Xtensa targets:
10827
10828 @table @gcctabopt
10829 @item -mconst16
10830 @itemx -mno-const16
10831 @opindex mconst16
10832 @opindex mno-const16
10833 Enable or disable use of @code{CONST16} instructions for loading
10834 constant values.  The @code{CONST16} instruction is currently not a
10835 standard option from Tensilica.  When enabled, @code{CONST16}
10836 instructions are always used in place of the standard @code{L32R}
10837 instructions.  The use of @code{CONST16} is enabled by default only if
10838 the @code{L32R} instruction is not available.
10839
10840 @item -mfused-madd
10841 @itemx -mno-fused-madd
10842 @opindex mfused-madd
10843 @opindex mno-fused-madd
10844 Enable or disable use of fused multiply/add and multiply/subtract
10845 instructions in the floating-point option.  This has no effect if the
10846 floating-point option is not also enabled.  Disabling fused multiply/add
10847 and multiply/subtract instructions forces the compiler to use separate
10848 instructions for the multiply and add/subtract operations.  This may be
10849 desirable in some cases where strict IEEE 754-compliant results are
10850 required: the fused multiply add/subtract instructions do not round the
10851 intermediate result, thereby producing results with @emph{more} bits of
10852 precision than specified by the IEEE standard.  Disabling fused multiply
10853 add/subtract instructions also ensures that the program output is not
10854 sensitive to the compiler's ability to combine multiply and add/subtract
10855 operations.
10856
10857 @item -mtext-section-literals
10858 @itemx -mno-text-section-literals
10859 @opindex mtext-section-literals
10860 @opindex mno-text-section-literals
10861 Control the treatment of literal pools.  The default is
10862 @option{-mno-text-section-literals}, which places literals in a separate
10863 section in the output file.  This allows the literal pool to be placed
10864 in a data RAM/ROM, and it also allows the linker to combine literal
10865 pools from separate object files to remove redundant literals and
10866 improve code size.  With @option{-mtext-section-literals}, the literals
10867 are interspersed in the text section in order to keep them as close as
10868 possible to their references.  This may be necessary for large assembly
10869 files.
10870
10871 @item -mtarget-align
10872 @itemx -mno-target-align
10873 @opindex mtarget-align
10874 @opindex mno-target-align
10875 When this option is enabled, GCC instructs the assembler to
10876 automatically align instructions to reduce branch penalties at the
10877 expense of some code density.  The assembler attempts to widen density
10878 instructions to align branch targets and the instructions following call
10879 instructions.  If there are not enough preceding safe density
10880 instructions to align a target, no widening will be performed.  The
10881 default is @option{-mtarget-align}.  These options do not affect the
10882 treatment of auto-aligned instructions like @code{LOOP}, which the
10883 assembler will always align, either by widening density instructions or
10884 by inserting no-op instructions.
10885
10886 @item -mlongcalls
10887 @itemx -mno-longcalls
10888 @opindex mlongcalls
10889 @opindex mno-longcalls
10890 When this option is enabled, GCC instructs the assembler to translate
10891 direct calls to indirect calls unless it can determine that the target
10892 of a direct call is in the range allowed by the call instruction.  This
10893 translation typically occurs for calls to functions in other source
10894 files.  Specifically, the assembler translates a direct @code{CALL}
10895 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10896 The default is @option{-mno-longcalls}.  This option should be used in
10897 programs where the call target can potentially be out of range.  This
10898 option is implemented in the assembler, not the compiler, so the
10899 assembly code generated by GCC will still show direct call
10900 instructions---look at the disassembled object code to see the actual
10901 instructions.  Note that the assembler will use an indirect call for
10902 every cross-file call, not just those that really will be out of range.
10903 @end table
10904
10905 @node Code Gen Options
10906 @section Options for Code Generation Conventions
10907 @cindex code generation conventions
10908 @cindex options, code generation
10909 @cindex run-time options
10910
10911 These machine-independent options control the interface conventions
10912 used in code generation.
10913
10914 Most of them have both positive and negative forms; the negative form
10915 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10916 one of the forms is listed---the one which is not the default.  You
10917 can figure out the other form by either removing @samp{no-} or adding
10918 it.
10919
10920 @table @gcctabopt
10921 @item -fbounds-check
10922 @opindex fbounds-check
10923 For front-ends that support it, generate additional code to check that
10924 indices used to access arrays are within the declared range.  This is
10925 currently only supported by the Java and Fortran 77 front-ends, where
10926 this option defaults to true and false respectively.
10927
10928 @item -ftrapv
10929 @opindex ftrapv
10930 This option generates traps for signed overflow on addition, subtraction,
10931 multiplication operations.
10932
10933 @item -fwrapv
10934 @opindex fwrapv
10935 This option instructs the compiler to assume that signed arithmetic
10936 overflow of addition, subtraction and multiplication wraps around
10937 using twos-complement representation.  This flag enables some optimizations
10938 and disables other.  This option is enabled by default for the Java
10939 front-end, as required by the Java language specification.
10940
10941 @item -fexceptions
10942 @opindex fexceptions
10943 Enable exception handling.  Generates extra code needed to propagate
10944 exceptions.  For some targets, this implies GCC will generate frame
10945 unwind information for all functions, which can produce significant data
10946 size overhead, although it does not affect execution.  If you do not
10947 specify this option, GCC will enable it by default for languages like
10948 C++ which normally require exception handling, and disable it for
10949 languages like C that do not normally require it.  However, you may need
10950 to enable this option when compiling C code that needs to interoperate
10951 properly with exception handlers written in C++.  You may also wish to
10952 disable this option if you are compiling older C++ programs that don't
10953 use exception handling.
10954
10955 @item -fnon-call-exceptions
10956 @opindex fnon-call-exceptions
10957 Generate code that allows trapping instructions to throw exceptions.
10958 Note that this requires platform-specific runtime support that does
10959 not exist everywhere.  Moreover, it only allows @emph{trapping}
10960 instructions to throw exceptions, i.e.@: memory references or floating
10961 point instructions.  It does not allow exceptions to be thrown from
10962 arbitrary signal handlers such as @code{SIGALRM}.
10963
10964 @item -funwind-tables
10965 @opindex funwind-tables
10966 Similar to @option{-fexceptions}, except that it will just generate any needed
10967 static data, but will not affect the generated code in any other way.
10968 You will normally not enable this option; instead, a language processor
10969 that needs this handling would enable it on your behalf.
10970
10971 @item -fasynchronous-unwind-tables
10972 @opindex funwind-tables
10973 Generate unwind table in dwarf2 format, if supported by target machine.  The
10974 table is exact at each instruction boundary, so it can be used for stack
10975 unwinding from asynchronous events (such as debugger or garbage collector).
10976
10977 @item -fpcc-struct-return
10978 @opindex fpcc-struct-return
10979 Return ``short'' @code{struct} and @code{union} values in memory like
10980 longer ones, rather than in registers.  This convention is less
10981 efficient, but it has the advantage of allowing intercallability between
10982 GCC-compiled files and files compiled with other compilers, particularly
10983 the Portable C Compiler (pcc).
10984
10985 The precise convention for returning structures in memory depends
10986 on the target configuration macros.
10987
10988 Short structures and unions are those whose size and alignment match
10989 that of some integer type.
10990
10991 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10992 switch is not binary compatible with code compiled with the
10993 @option{-freg-struct-return} switch.
10994 Use it to conform to a non-default application binary interface.
10995
10996 @item -freg-struct-return
10997 @opindex freg-struct-return
10998 Return @code{struct} and @code{union} values in registers when possible.
10999 This is more efficient for small structures than
11000 @option{-fpcc-struct-return}.
11001
11002 If you specify neither @option{-fpcc-struct-return} nor
11003 @option{-freg-struct-return}, GCC defaults to whichever convention is
11004 standard for the target.  If there is no standard convention, GCC
11005 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11006 the principal compiler.  In those cases, we can choose the standard, and
11007 we chose the more efficient register return alternative.
11008
11009 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11010 switch is not binary compatible with code compiled with the
11011 @option{-fpcc-struct-return} switch.
11012 Use it to conform to a non-default application binary interface.
11013
11014 @item -fshort-enums
11015 @opindex fshort-enums
11016 Allocate to an @code{enum} type only as many bytes as it needs for the
11017 declared range of possible values.  Specifically, the @code{enum} type
11018 will be equivalent to the smallest integer type which has enough room.
11019
11020 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11021 code that is not binary compatible with code generated without that switch.
11022 Use it to conform to a non-default application binary interface.
11023
11024 @item -fshort-double
11025 @opindex fshort-double
11026 Use the same size for @code{double} as for @code{float}.
11027
11028 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11029 code that is not binary compatible with code generated without that switch.
11030 Use it to conform to a non-default application binary interface.
11031
11032 @item -fshort-wchar
11033 @opindex fshort-wchar
11034 Override the underlying type for @samp{wchar_t} to be @samp{short
11035 unsigned int} instead of the default for the target.  This option is
11036 useful for building programs to run under WINE@.
11037
11038 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11039 code that is not binary compatible with code generated without that switch.
11040 Use it to conform to a non-default application binary interface.
11041
11042 @item -fshared-data
11043 @opindex fshared-data
11044 Requests that the data and non-@code{const} variables of this
11045 compilation be shared data rather than private data.  The distinction
11046 makes sense only on certain operating systems, where shared data is
11047 shared between processes running the same program, while private data
11048 exists in one copy per process.
11049
11050 @item -fno-common
11051 @opindex fno-common
11052 In C, allocate even uninitialized global variables in the data section of the
11053 object file, rather than generating them as common blocks.  This has the
11054 effect that if the same variable is declared (without @code{extern}) in
11055 two different compilations, you will get an error when you link them.
11056 The only reason this might be useful is if you wish to verify that the
11057 program will work on other systems which always work this way.
11058
11059 @item -fno-ident
11060 @opindex fno-ident
11061 Ignore the @samp{#ident} directive.
11062
11063 @item -finhibit-size-directive
11064 @opindex finhibit-size-directive
11065 Don't output a @code{.size} assembler directive, or anything else that
11066 would cause trouble if the function is split in the middle, and the
11067 two halves are placed at locations far apart in memory.  This option is
11068 used when compiling @file{crtstuff.c}; you should not need to use it
11069 for anything else.
11070
11071 @item -fverbose-asm
11072 @opindex fverbose-asm
11073 Put extra commentary information in the generated assembly code to
11074 make it more readable.  This option is generally only of use to those
11075 who actually need to read the generated assembly code (perhaps while
11076 debugging the compiler itself).
11077
11078 @option{-fno-verbose-asm}, the default, causes the
11079 extra information to be omitted and is useful when comparing two assembler
11080 files.
11081
11082 @item -fpic
11083 @opindex fpic
11084 @cindex global offset table
11085 @cindex PIC
11086 Generate position-independent code (PIC) suitable for use in a shared
11087 library, if supported for the target machine.  Such code accesses all
11088 constant addresses through a global offset table (GOT)@.  The dynamic
11089 loader resolves the GOT entries when the program starts (the dynamic
11090 loader is not part of GCC; it is part of the operating system).  If
11091 the GOT size for the linked executable exceeds a machine-specific
11092 maximum size, you get an error message from the linker indicating that
11093 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11094 instead.  (These maximums are 8k on the SPARC and 32k
11095 on the m68k and RS/6000.  The 386 has no such limit.)
11096
11097 Position-independent code requires special support, and therefore works
11098 only on certain machines.  For the 386, GCC supports PIC for System V
11099 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11100 position-independent.
11101
11102 @item -fPIC
11103 @opindex fPIC
11104 If supported for the target machine, emit position-independent code,
11105 suitable for dynamic linking and avoiding any limit on the size of the
11106 global offset table.  This option makes a difference on the m68k
11107 and the SPARC.
11108
11109 Position-independent code requires special support, and therefore works
11110 only on certain machines.
11111
11112 @item -fpie
11113 @itemx -fPIE
11114 @opindex fpie
11115 @opindex fPIE
11116 These options are similar to @option{-fpic} and @option{-fPIC}, but
11117 generated position independent code can be only linked into executables.
11118 Usually these options are used when @option{-pie} GCC option will be
11119 used during linking.
11120
11121 @item -ffixed-@var{reg}
11122 @opindex ffixed
11123 Treat the register named @var{reg} as a fixed register; generated code
11124 should never refer to it (except perhaps as a stack pointer, frame
11125 pointer or in some other fixed role).
11126
11127 @var{reg} must be the name of a register.  The register names accepted
11128 are machine-specific and are defined in the @code{REGISTER_NAMES}
11129 macro in the machine description macro file.
11130
11131 This flag does not have a negative form, because it specifies a
11132 three-way choice.
11133
11134 @item -fcall-used-@var{reg}
11135 @opindex fcall-used
11136 Treat the register named @var{reg} as an allocable register that is
11137 clobbered by function calls.  It may be allocated for temporaries or
11138 variables that do not live across a call.  Functions compiled this way
11139 will not save and restore the register @var{reg}.
11140
11141 It is an error to used this flag with the frame pointer or stack pointer.
11142 Use of this flag for other registers that have fixed pervasive roles in
11143 the machine's execution model will produce disastrous results.
11144
11145 This flag does not have a negative form, because it specifies a
11146 three-way choice.
11147
11148 @item -fcall-saved-@var{reg}
11149 @opindex fcall-saved
11150 Treat the register named @var{reg} as an allocable register saved by
11151 functions.  It may be allocated even for temporaries or variables that
11152 live across a call.  Functions compiled this way will save and restore
11153 the register @var{reg} if they use it.
11154
11155 It is an error to used this flag with the frame pointer or stack pointer.
11156 Use of this flag for other registers that have fixed pervasive roles in
11157 the machine's execution model will produce disastrous results.
11158
11159 A different sort of disaster will result from the use of this flag for
11160 a register in which function values may be returned.
11161
11162 This flag does not have a negative form, because it specifies a
11163 three-way choice.
11164
11165 @item -fpack-struct
11166 @opindex fpack-struct
11167 Pack all structure members together without holes.
11168
11169 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11170 code that is not binary compatible with code generated without that switch.
11171 Additionally, it makes the code suboptimal.
11172 Use it to conform to a non-default application binary interface.
11173
11174 @item -finstrument-functions
11175 @opindex finstrument-functions
11176 Generate instrumentation calls for entry and exit to functions.  Just
11177 after function entry and just before function exit, the following
11178 profiling functions will be called with the address of the current
11179 function and its call site.  (On some platforms,
11180 @code{__builtin_return_address} does not work beyond the current
11181 function, so the call site information may not be available to the
11182 profiling functions otherwise.)
11183
11184 @smallexample
11185 void __cyg_profile_func_enter (void *this_fn,
11186                                void *call_site);
11187 void __cyg_profile_func_exit  (void *this_fn,
11188                                void *call_site);
11189 @end smallexample
11190
11191 The first argument is the address of the start of the current function,
11192 which may be looked up exactly in the symbol table.
11193
11194 This currently disables function inlining.  This restriction is
11195 expected to be removed in future releases.
11196
11197 A function may be given the attribute @code{no_instrument_function}, in
11198 which case this instrumentation will not be done.  This can be used, for
11199 example, for the profiling functions listed above, high-priority
11200 interrupt routines, and any functions from which the profiling functions
11201 cannot safely be called (perhaps signal handlers, if the profiling
11202 routines generate output or allocate memory).
11203
11204 @item -fstack-check
11205 @opindex fstack-check
11206 Generate code to verify that you do not go beyond the boundary of the
11207 stack.  You should specify this flag if you are running in an
11208 environment with multiple threads, but only rarely need to specify it in
11209 a single-threaded environment since stack overflow is automatically
11210 detected on nearly all systems if there is only one stack.
11211
11212 Note that this switch does not actually cause checking to be done; the
11213 operating system must do that.  The switch causes generation of code
11214 to ensure that the operating system sees the stack being extended.
11215
11216 @item -fstack-limit-register=@var{reg}
11217 @itemx -fstack-limit-symbol=@var{sym}
11218 @itemx -fno-stack-limit
11219 @opindex fstack-limit-register
11220 @opindex fstack-limit-symbol
11221 @opindex fno-stack-limit
11222 Generate code to ensure that the stack does not grow beyond a certain value,
11223 either the value of a register or the address of a symbol.  If the stack
11224 would grow beyond the value, a signal is raised.  For most targets,
11225 the signal is raised before the stack overruns the boundary, so
11226 it is possible to catch the signal without taking special precautions.
11227
11228 For instance, if the stack starts at absolute address @samp{0x80000000}
11229 and grows downwards, you can use the flags
11230 @option{-fstack-limit-symbol=__stack_limit} and
11231 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11232 of 128KB@.  Note that this may only work with the GNU linker.
11233
11234 @cindex aliasing of parameters
11235 @cindex parameters, aliased
11236 @item -fargument-alias
11237 @itemx -fargument-noalias
11238 @itemx -fargument-noalias-global
11239 @opindex fargument-alias
11240 @opindex fargument-noalias
11241 @opindex fargument-noalias-global
11242 Specify the possible relationships among parameters and between
11243 parameters and global data.
11244
11245 @option{-fargument-alias} specifies that arguments (parameters) may
11246 alias each other and may alias global storage.@*
11247 @option{-fargument-noalias} specifies that arguments do not alias
11248 each other, but may alias global storage.@*
11249 @option{-fargument-noalias-global} specifies that arguments do not
11250 alias each other and do not alias global storage.
11251
11252 Each language will automatically use whatever option is required by
11253 the language standard.  You should not need to use these options yourself.
11254
11255 @item -fleading-underscore
11256 @opindex fleading-underscore
11257 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11258 change the way C symbols are represented in the object file.  One use
11259 is to help link with legacy assembly code.
11260
11261 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11262 generate code that is not binary compatible with code generated without that
11263 switch.  Use it to conform to a non-default application binary interface.
11264 Not all targets provide complete support for this switch.
11265
11266 @item -ftls-model=@var{model}
11267 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11268 The @var{model} argument should be one of @code{global-dynamic},
11269 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11270
11271 The default without @option{-fpic} is @code{initial-exec}; with
11272 @option{-fpic} the default is @code{global-dynamic}.
11273 @end table
11274
11275 @c man end
11276
11277 @node Environment Variables
11278 @section Environment Variables Affecting GCC
11279 @cindex environment variables
11280
11281 @c man begin ENVIRONMENT
11282 This section describes several environment variables that affect how GCC
11283 operates.  Some of them work by specifying directories or prefixes to use
11284 when searching for various kinds of files.  Some are used to specify other
11285 aspects of the compilation environment.
11286
11287 Note that you can also specify places to search using options such as
11288 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11289 take precedence over places specified using environment variables, which
11290 in turn take precedence over those specified by the configuration of GCC@.
11291 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11292 GNU Compiler Collection (GCC) Internals}.
11293
11294 @table @env
11295 @item LANG
11296 @itemx LC_CTYPE
11297 @c @itemx LC_COLLATE
11298 @itemx LC_MESSAGES
11299 @c @itemx LC_MONETARY
11300 @c @itemx LC_NUMERIC
11301 @c @itemx LC_TIME
11302 @itemx LC_ALL
11303 @findex LANG
11304 @findex LC_CTYPE
11305 @c @findex LC_COLLATE
11306 @findex LC_MESSAGES
11307 @c @findex LC_MONETARY
11308 @c @findex LC_NUMERIC
11309 @c @findex LC_TIME
11310 @findex LC_ALL
11311 @cindex locale
11312 These environment variables control the way that GCC uses
11313 localization information that allow GCC to work with different
11314 national conventions.  GCC inspects the locale categories
11315 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11316 so.  These locale categories can be set to any value supported by your
11317 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
11318 Kingdom encoded in UTF-8.
11319
11320 The @env{LC_CTYPE} environment variable specifies character
11321 classification.  GCC uses it to determine the character boundaries in
11322 a string; this is needed for some multibyte encodings that contain quote
11323 and escape characters that would otherwise be interpreted as a string
11324 end or escape.
11325
11326 The @env{LC_MESSAGES} environment variable specifies the language to
11327 use in diagnostic messages.
11328
11329 If the @env{LC_ALL} environment variable is set, it overrides the value
11330 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11331 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11332 environment variable.  If none of these variables are set, GCC
11333 defaults to traditional C English behavior.
11334
11335 @item TMPDIR
11336 @findex TMPDIR
11337 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11338 files.  GCC uses temporary files to hold the output of one stage of
11339 compilation which is to be used as input to the next stage: for example,
11340 the output of the preprocessor, which is the input to the compiler
11341 proper.
11342
11343 @item GCC_EXEC_PREFIX
11344 @findex GCC_EXEC_PREFIX
11345 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11346 names of the subprograms executed by the compiler.  No slash is added
11347 when this prefix is combined with the name of a subprogram, but you can
11348 specify a prefix that ends with a slash if you wish.
11349
11350 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11351 an appropriate prefix to use based on the pathname it was invoked with.
11352
11353 If GCC cannot find the subprogram using the specified prefix, it
11354 tries looking in the usual places for the subprogram.
11355
11356 The default value of @env{GCC_EXEC_PREFIX} is
11357 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11358 of @code{prefix} when you ran the @file{configure} script.
11359
11360 Other prefixes specified with @option{-B} take precedence over this prefix.
11361
11362 This prefix is also used for finding files such as @file{crt0.o} that are
11363 used for linking.
11364
11365 In addition, the prefix is used in an unusual way in finding the
11366 directories to search for header files.  For each of the standard
11367 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11368 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11369 replacing that beginning with the specified prefix to produce an
11370 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11371 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11372 These alternate directories are searched first; the standard directories
11373 come next.
11374
11375 @item COMPILER_PATH
11376 @findex COMPILER_PATH
11377 The value of @env{COMPILER_PATH} is a colon-separated list of
11378 directories, much like @env{PATH}.  GCC tries the directories thus
11379 specified when searching for subprograms, if it can't find the
11380 subprograms using @env{GCC_EXEC_PREFIX}.
11381
11382 @item LIBRARY_PATH
11383 @findex LIBRARY_PATH
11384 The value of @env{LIBRARY_PATH} is a colon-separated list of
11385 directories, much like @env{PATH}.  When configured as a native compiler,
11386 GCC tries the directories thus specified when searching for special
11387 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11388 using GCC also uses these directories when searching for ordinary
11389 libraries for the @option{-l} option (but directories specified with
11390 @option{-L} come first).
11391
11392 @item LANG
11393 @findex LANG
11394 @cindex locale definition
11395 This variable is used to pass locale information to the compiler.  One way in
11396 which this information is used is to determine the character set to be used
11397 when character literals, string literals and comments are parsed in C and C++.
11398 When the compiler is configured to allow multibyte characters,
11399 the following values for @env{LANG} are recognized:
11400
11401 @table @samp
11402 @item C-JIS
11403 Recognize JIS characters.
11404 @item C-SJIS
11405 Recognize SJIS characters.
11406 @item C-EUCJP
11407 Recognize EUCJP characters.
11408 @end table
11409
11410 If @env{LANG} is not defined, or if it has some other value, then the
11411 compiler will use mblen and mbtowc as defined by the default locale to
11412 recognize and translate multibyte characters.
11413 @end table
11414
11415 @noindent
11416 Some additional environments variables affect the behavior of the
11417 preprocessor.
11418
11419 @include cppenv.texi
11420
11421 @c man end
11422
11423 @node Precompiled Headers
11424 @section Using Precompiled Headers
11425 @cindex precompiled headers
11426 @cindex speed of compilation
11427
11428 Often large projects have many header files that are included in every
11429 source file.  The time the compiler takes to process these header files
11430 over and over again can account for nearly all of the time required to
11431 build the project.  To make builds faster, GCC allows users to
11432 `precompile' a header file; then, if builds can use the precompiled
11433 header file they will be much faster.
11434
11435 @strong{Caution:} There are a few known situations where GCC will
11436 crash when trying to use a precompiled header.  If you have trouble
11437 with a precompiled header, you should remove the precompiled header
11438 and compile without it.  In addition, please use GCC's on-line
11439 defect-tracking system to report any problems you encounter with
11440 precompiled headers.  @xref{Bugs}.
11441
11442 To create a precompiled header file, simply compile it as you would any
11443 other file, if necessary using the @option{-x} option to make the driver
11444 treat it as a C or C++ header file.  You will probably want to use a
11445 tool like @command{make} to keep the precompiled header up-to-date when
11446 the headers it contains change.
11447
11448 A precompiled header file will be searched for when @code{#include} is
11449 seen in the compilation.  As it searches for the included file
11450 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11451 compiler looks for a precompiled header in each directory just before it
11452 looks for the include file in that directory.  The name searched for is
11453 the name specified in the @code{#include} with @samp{.gch} appended.  If
11454 the precompiled header file can't be used, it is ignored.
11455
11456 For instance, if you have @code{#include "all.h"}, and you have
11457 @file{all.h.gch} in the same directory as @file{all.h}, then the
11458 precompiled header file will be used if possible, and the original
11459 header will be used otherwise.
11460
11461 Alternatively, you might decide to put the precompiled header file in a
11462 directory and use @option{-I} to ensure that directory is searched
11463 before (or instead of) the directory containing the original header.
11464 Then, if you want to check that the precompiled header file is always
11465 used, you can put a file of the same name as the original header in this
11466 directory containing an @code{#error} command.
11467
11468 This also works with @option{-include}.  So yet another way to use
11469 precompiled headers, good for projects not designed with precompiled
11470 header files in mind, is to simply take most of the header files used by
11471 a project, include them from another header file, precompile that header
11472 file, and @option{-include} the precompiled header.  If the header files
11473 have guards against multiple inclusion, they will be skipped because
11474 they've already been included (in the precompiled header).
11475
11476 If you need to precompile the same header file for different
11477 languages, targets, or compiler options, you can instead make a
11478 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11479 header in the directory.  (It doesn't matter what you call the files
11480 in the directory, every precompiled header in the directory will be
11481 considered.)  The first precompiled header encountered in the
11482 directory that is valid for this compilation will be used; they're
11483 searched in no particular order.
11484
11485 There are many other possibilities, limited only by your imagination,
11486 good sense, and the constraints of your build system.
11487
11488 A precompiled header file can be used only when these conditions apply:
11489
11490 @itemize
11491 @item
11492 Only one precompiled header can be used in a particular compilation.
11493 @item
11494 A precompiled header can't be used once the first C token is seen.  You
11495 can have preprocessor directives before a precompiled header; you can
11496 even include a precompiled header from inside another header, so long as
11497 there are no C tokens before the @code{#include}.
11498 @item
11499 The precompiled header file must be produced for the same language as
11500 the current compilation.  You can't use a C precompiled header for a C++
11501 compilation.
11502 @item
11503 The precompiled header file must be produced by the same compiler
11504 version and configuration as the current compilation is using.
11505 The easiest way to guarantee this is to use the same compiler binary
11506 for creating and using precompiled headers.
11507 @item
11508 Any macros defined before the precompiled header (including with
11509 @option{-D}) must either be defined in the same way as when the
11510 precompiled header was generated, or must not affect the precompiled
11511 header, which usually means that the they don't appear in the
11512 precompiled header at all.
11513 @item
11514 Certain command-line options must be defined in the same way as when the
11515 precompiled header was generated.  At present, it's not clear which
11516 options are safe to change and which are not; the safest choice is to
11517 use exactly the same options when generating and using the precompiled
11518 header.
11519 @end itemize
11520
11521 For all of these but the last, the compiler will automatically ignore
11522 the precompiled header if the conditions aren't met.  For the last item,
11523 some option changes will cause the precompiled header to be rejected,
11524 but not all incompatible option combinations have yet been found.  If
11525 you find a new incompatible combination, please consider filing a bug
11526 report, see @ref{Bugs}.
11527
11528 @node Running Protoize
11529 @section Running Protoize
11530
11531 The program @code{protoize} is an optional part of GCC@.  You can use
11532 it to add prototypes to a program, thus converting the program to ISO
11533 C in one respect.  The companion program @code{unprotoize} does the
11534 reverse: it removes argument types from any prototypes that are found.
11535
11536 When you run these programs, you must specify a set of source files as
11537 command line arguments.  The conversion programs start out by compiling
11538 these files to see what functions they define.  The information gathered
11539 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11540
11541 After scanning comes actual conversion.  The specified files are all
11542 eligible to be converted; any files they include (whether sources or
11543 just headers) are eligible as well.
11544
11545 But not all the eligible files are converted.  By default,
11546 @code{protoize} and @code{unprotoize} convert only source and header
11547 files in the current directory.  You can specify additional directories
11548 whose files should be converted with the @option{-d @var{directory}}
11549 option.  You can also specify particular files to exclude with the
11550 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11551 directory name matches one of the specified directory names, and its
11552 name within the directory has not been excluded.
11553
11554 Basic conversion with @code{protoize} consists of rewriting most
11555 function definitions and function declarations to specify the types of
11556 the arguments.  The only ones not rewritten are those for varargs
11557 functions.
11558
11559 @code{protoize} optionally inserts prototype declarations at the
11560 beginning of the source file, to make them available for any calls that
11561 precede the function's definition.  Or it can insert prototype
11562 declarations with block scope in the blocks where undeclared functions
11563 are called.
11564
11565 Basic conversion with @code{unprotoize} consists of rewriting most
11566 function declarations to remove any argument types, and rewriting
11567 function definitions to the old-style pre-ISO form.
11568
11569 Both conversion programs print a warning for any function declaration or
11570 definition that they can't convert.  You can suppress these warnings
11571 with @option{-q}.
11572
11573 The output from @code{protoize} or @code{unprotoize} replaces the
11574 original source file.  The original file is renamed to a name ending
11575 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11576 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11577 for DOS) file already exists, then the source file is simply discarded.
11578
11579 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11580 scan the program and collect information about the functions it uses.
11581 So neither of these programs will work until GCC is installed.
11582
11583 Here is a table of the options you can use with @code{protoize} and
11584 @code{unprotoize}.  Each option works with both programs unless
11585 otherwise stated.
11586
11587 @table @code
11588 @item -B @var{directory}
11589 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11590 usual directory (normally @file{/usr/local/lib}).  This file contains
11591 prototype information about standard system functions.  This option
11592 applies only to @code{protoize}.
11593
11594 @item -c @var{compilation-options}
11595 Use @var{compilation-options} as the options when running @command{gcc} to
11596 produce the @samp{.X} files.  The special option @option{-aux-info} is
11597 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11598
11599 Note that the compilation options must be given as a single argument to
11600 @code{protoize} or @code{unprotoize}.  If you want to specify several
11601 @command{gcc} options, you must quote the entire set of compilation options
11602 to make them a single word in the shell.
11603
11604 There are certain @command{gcc} arguments that you cannot use, because they
11605 would produce the wrong kind of output.  These include @option{-g},
11606 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11607 the @var{compilation-options}, they are ignored.
11608
11609 @item -C
11610 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11611 systems) instead of @samp{.c}.  This is convenient if you are converting
11612 a C program to C++.  This option applies only to @code{protoize}.
11613
11614 @item -g
11615 Add explicit global declarations.  This means inserting explicit
11616 declarations at the beginning of each source file for each function
11617 that is called in the file and was not declared.  These declarations
11618 precede the first function definition that contains a call to an
11619 undeclared function.  This option applies only to @code{protoize}.
11620
11621 @item -i @var{string}
11622 Indent old-style parameter declarations with the string @var{string}.
11623 This option applies only to @code{protoize}.
11624
11625 @code{unprotoize} converts prototyped function definitions to old-style
11626 function definitions, where the arguments are declared between the
11627 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11628 uses five spaces as the indentation.  If you want to indent with just
11629 one space instead, use @option{-i " "}.
11630
11631 @item -k
11632 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11633 is finished.
11634
11635 @item -l
11636 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11637 a prototype declaration for each function in each block which calls the
11638 function without any declaration.  This option applies only to
11639 @code{protoize}.
11640
11641 @item -n
11642 Make no real changes.  This mode just prints information about the conversions
11643 that would have been done without @option{-n}.
11644
11645 @item -N
11646 Make no @samp{.save} files.  The original files are simply deleted.
11647 Use this option with caution.
11648
11649 @item -p @var{program}
11650 Use the program @var{program} as the compiler.  Normally, the name
11651 @file{gcc} is used.
11652
11653 @item -q
11654 Work quietly.  Most warnings are suppressed.
11655
11656 @item -v
11657 Print the version number, just like @option{-v} for @command{gcc}.
11658 @end table
11659
11660 If you need special compiler options to compile one of your program's
11661 source files, then you should generate that file's @samp{.X} file
11662 specially, by running @command{gcc} on that source file with the
11663 appropriate options and the option @option{-aux-info}.  Then run
11664 @code{protoize} on the entire set of files.  @code{protoize} will use
11665 the existing @samp{.X} file because it is newer than the source file.
11666 For example:
11667
11668 @smallexample
11669 gcc -Dfoo=bar file1.c -aux-info file1.X
11670 protoize *.c
11671 @end smallexample
11672
11673 @noindent
11674 You need to include the special files along with the rest in the
11675 @code{protoize} command, even though their @samp{.X} files already
11676 exist, because otherwise they won't get converted.
11677
11678 @xref{Protoize Caveats}, for more information on how to use
11679 @code{protoize} successfully.