OSDN Git Service

* doc/invoke.texi (SPARC options): Further improve.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo  -Wsynth}
192
193 @item Objective-C Language Options
194 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
195 @gccoptlist{
196 -fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime @gol
198 -fno-nil-receivers @gol
199 -fobjc-exceptions @gol
200 -freplace-objc-classes @gol
201 -fzero-link @gol
202 -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
204
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{-fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
213 -w  -Wextra  -Wall  -Waggregate-return @gol
214 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
215 -Wconversion  -Wno-deprecated-declarations @gol
216 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
217 -Werror  -Werror-implicit-function-declaration @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wno-format-extra-args -Wformat-nonliteral @gol
220 -Wformat-security  -Wformat-y2k @gol
221 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
222 -Wimport  -Wno-import  -Winit-self  -Winline @gol
223 -Wno-invalid-offsetof  -Winvalid-pch @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
228 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
229 -Wreturn-type  -Wsequence-point  -Wshadow @gol
230 -Wsign-compare  -Wstrict-aliasing @gol
231 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
232 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings}
236
237 @item C-only Warning Options
238 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
239 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
240 -Wstrict-prototypes  -Wtraditional @gol
241 -Wdeclaration-after-statement}
242
243 @item Debugging Options
244 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
245 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
246 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
249 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
251 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
252 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
253 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report @gol
255 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
265 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
266 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
267 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
268 -fcaller-saves  -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -floop-optimize @gol
274 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations  -ffinite-math-only @gol
282 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -fprofile-generate -fprofile-use @gol
286 -freduce-all-givs  -fregmove  -frename-registers @gol
287 -freorder-blocks  -freorder-functions @gol
288 -frerun-cse-after-loop  -frerun-loop-opt @gol
289 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
290 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
291 -fsched-spec-load-dangerous  @gol
292 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
293 -fsched2-use-superblocks @gol
294 -fsched2-use-traces  -fsignaling-nans @gol
295 -fsingle-precision-constant  @gol
296 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
297 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
298 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
299 --param @var{name}=@var{value}
300 -O  -O0  -O1  -O2  -O3  -Os}
301
302 @item Preprocessor Options
303 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
304 @gccoptlist{-A@var{question}=@var{answer} @gol
305 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
306 -C  -dD  -dI  -dM  -dN @gol
307 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
308 -idirafter @var{dir} @gol
309 -include @var{file}  -imacros @var{file} @gol
310 -iprefix @var{file}  -iwithprefix @var{dir} @gol
311 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
312 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
313 -P  -fworking-directory  -remap @gol
314 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
315 -Xpreprocessor @var{option}}
316
317 @item Assembler Option
318 @xref{Assembler Options,,Passing Options to the Assembler}.
319 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
320
321 @item Linker Options
322 @xref{Link Options,,Options for Linking}.
323 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
324 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
325 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
326 -Wl,@var{option}  -Xlinker @var{option} @gol
327 -u @var{symbol}}
328
329 @item Directory Options
330 @xref{Directory Options,,Options for Directory Search}.
331 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
332
333 @item Target Options
334 @c I wrote this xref this way to avoid overfull hbox. -- rms
335 @xref{Target Options}.
336 @gccoptlist{-V @var{version}  -b @var{machine}}
337
338 @item Machine Dependent Options
339 @xref{Submodel Options,,Hardware Models and Configurations}.
340
341 @emph{M680x0 Options}
342 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
343 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
344 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
345 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
346 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
347
348 @emph{M68hc1x Options}
349 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
350 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
351 -msoft-reg-count=@var{count}}
352
353 @emph{VAX Options}
354 @gccoptlist{-mg  -mgnu  -munix}
355
356 @emph{SPARC Options}
357 @gccoptlist{-mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32  -m64  -mapp-regs  -mno-app-regs @gol
361 -mfaster-structs  -mno-faster-structs @gol
362 -mflat  -mno-flat  -mfpu  -mno-fpu @gol
363 -mhard-float  -msoft-float @gol
364 -mhard-quad-float  -msoft-quad-float @gol
365 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
366 -mstack-bias  -mno-stack-bias @gol
367 -munaligned-doubles  -mno-unaligned-doubles @gol
368 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
369 -mcypress  -mf930  -mf934 @gol
370 -msparclite  -msupersparc  -mv8}
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-call  -mno-xl-call  -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 -mpni -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  -mno-dwarf2-asm @gol
609 -mfixed-range=@var{register-range}}
610
611 @emph{D30V Options}
612 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
613 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
614
615 @emph{S/390 and zSeries Options}
616 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
617 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
618 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
619 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
620
621 @emph{CRIS Options}
622 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
623 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
624 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
625 -mstack-align  -mdata-align  -mconst-align @gol
626 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
627 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
628
629 @emph{PDP-11 Options}
630 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
631 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
632 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
633 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
634 -mbranch-expensive  -mbranch-cheap @gol
635 -msplit  -mno-split  -munix-asm  -mdec-asm}
636
637 @emph{Xstormy16 Options}
638 @gccoptlist{-msim}
639
640 @emph{Xtensa Options}
641 @gccoptlist{-mconst16 -mno-const16 @gol
642 -mfused-madd  -mno-fused-madd @gol
643 -mtext-section-literals  -mno-text-section-literals @gol
644 -mtarget-align  -mno-target-align @gol
645 -mlongcalls  -mno-longcalls}
646
647 @emph{FRV Options}
648 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
649 -mhard-float  -msoft-float @gol
650 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
651 -mdouble  -mno-double @gol
652 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
653 -mlibrary-pic  -macc-4 -macc-8 @gol
654 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
655 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
656 -mvliw-branch  -mno-vliw-branch @gol
657 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
658 -mno-nested-cond-exec  -mtomcat-stats @gol
659 -mcpu=@var{cpu}}
660
661 @item Code Generation Options
662 @xref{Code Gen Options,,Options for Code Generation Conventions}.
663 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
664 -ffixed-@var{reg}  -fexceptions @gol
665 -fnon-call-exceptions  -funwind-tables @gol
666 -fasynchronous-unwind-tables @gol
667 -finhibit-size-directive  -finstrument-functions @gol
668 -fno-common  -fno-ident @gol
669 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
670 -freg-struct-return  -fshared-data  -fshort-enums @gol
671 -fshort-double  -fshort-wchar @gol
672 -fverbose-asm  -fpack-struct  -fstack-check @gol
673 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
674 -fargument-alias  -fargument-noalias @gol
675 -fargument-noalias-global  -fleading-underscore @gol
676 -ftls-model=@var{model} @gol
677 -ftrapv  -fwrapv  -fbounds-check}
678 @end table
679
680 @menu
681 * Overall Options::     Controlling the kind of output:
682                         an executable, object files, assembler files,
683                         or preprocessed source.
684 * C Dialect Options::   Controlling the variant of C language compiled.
685 * C++ Dialect Options:: Variations on C++.
686 * Objective-C Dialect Options:: Variations on Objective-C.
687 * Language Independent Options:: Controlling how diagnostics should be
688                         formatted.
689 * Warning Options::     How picky should the compiler be?
690 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
691 * Optimize Options::    How much optimization?
692 * Preprocessor Options:: Controlling header files and macro definitions.
693                          Also, getting dependency information for Make.
694 * Assembler Options::   Passing options to the assembler.
695 * Link Options::        Specifying libraries and so on.
696 * Directory Options::   Where to find header files and libraries.
697                         Where to find the compiler executable files.
698 * Spec Files::          How to pass switches to sub-processes.
699 * Target Options::      Running a cross-compiler, or an old version of GCC.
700 @end menu
701
702 @node Overall Options
703 @section Options Controlling the Kind of Output
704
705 Compilation can involve up to four stages: preprocessing, compilation
706 proper, assembly and linking, always in that order.  GCC is capable of
707 preprocessing and compiling several files either into several
708 assembler input files, or into one assembler input file; then each
709 assembler input file produces an object file, and linking combines all
710 the object files (those newly compiled, and those specified as input)
711 into an executable file.
712
713 @cindex file name suffix
714 For any given input file, the file name suffix determines what kind of
715 compilation is done:
716
717 @table @gcctabopt
718 @item @var{file}.c
719 C source code which must be preprocessed.
720
721 @item @var{file}.i
722 C source code which should not be preprocessed.
723
724 @item @var{file}.ii
725 C++ source code which should not be preprocessed.
726
727 @item @var{file}.m
728 Objective-C source code.  Note that you must link with the library
729 @file{libobjc.a} to make an Objective-C program work.
730
731 @item @var{file}.mi
732 Objective-C source code which should not be preprocessed.
733
734 @item @var{file}.h
735 C or C++ header file to be turned into a precompiled header.
736
737 @item @var{file}.cc
738 @itemx @var{file}.cp
739 @itemx @var{file}.cxx
740 @itemx @var{file}.cpp
741 @itemx @var{file}.CPP
742 @itemx @var{file}.c++
743 @itemx @var{file}.C
744 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
745 the last two letters must both be literally @samp{x}.  Likewise,
746 @samp{.C} refers to a literal capital C@.
747
748 @item @var{file}.hh
749 @itemx @var{file}.H
750 C++ header file to be turned into a precompiled header.
751
752 @item @var{file}.f
753 @itemx @var{file}.for
754 @itemx @var{file}.FOR
755 Fortran source code which should not be preprocessed.
756
757 @item @var{file}.F
758 @itemx @var{file}.fpp
759 @itemx @var{file}.FPP
760 Fortran source code which must be preprocessed (with the traditional
761 preprocessor).
762
763 @item @var{file}.r
764 Fortran source code which must be preprocessed with a RATFOR
765 preprocessor (not included with GCC)@.
766
767 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
768 Using and Porting GNU Fortran}, for more details of the handling of
769 Fortran input files.
770
771 @c FIXME: Descriptions of Java file types.
772 @c @var{file}.java
773 @c @var{file}.class
774 @c @var{file}.zip
775 @c @var{file}.jar
776
777 @item @var{file}.ads
778 Ada source code file which contains a library unit declaration (a
779 declaration of a package, subprogram, or generic, or a generic
780 instantiation), or a library unit renaming declaration (a package,
781 generic, or subprogram renaming declaration).  Such files are also
782 called @dfn{specs}.
783
784 @itemx @var{file}.adb
785 Ada source code file containing a library unit body (a subprogram or
786 package body).  Such files are also called @dfn{bodies}.
787
788 @c GCC also knows about some suffixes for languages not yet included:
789 @c Pascal:
790 @c @var{file}.p
791 @c @var{file}.pas
792
793 @item @var{file}.s
794 Assembler code.
795
796 @item @var{file}.S
797 Assembler code which must be preprocessed.
798
799 @item @var{other}
800 An object file to be fed straight into linking.
801 Any file name with no recognized suffix is treated this way.
802 @end table
803
804 @opindex x
805 You can specify the input language explicitly with the @option{-x} option:
806
807 @table @gcctabopt
808 @item -x @var{language}
809 Specify explicitly the @var{language} for the following input files
810 (rather than letting the compiler choose a default based on the file
811 name suffix).  This option applies to all following input files until
812 the next @option{-x} option.  Possible values for @var{language} are:
813 @smallexample
814 c  c-header  cpp-output
815 c++  c++-header  c++-cpp-output
816 objective-c  objective-c-header  objc-cpp-output
817 assembler  assembler-with-cpp
818 ada
819 f77  f77-cpp-input  ratfor
820 java
821 treelang
822 @end smallexample
823
824 @item -x none
825 Turn off any specification of a language, so that subsequent files are
826 handled according to their file name suffixes (as they are if @option{-x}
827 has not been used at all).
828
829 @item -pass-exit-codes
830 @opindex pass-exit-codes
831 Normally the @command{gcc} program will exit with the code of 1 if any
832 phase of the compiler returns a non-success return code.  If you specify
833 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
834 numerically highest error produced by any phase that returned an error
835 indication.
836 @end table
837
838 If you only want some of the stages of compilation, you can use
839 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
840 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
841 @command{gcc} is to stop.  Note that some combinations (for example,
842 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
843
844 @table @gcctabopt
845 @item -c
846 @opindex c
847 Compile or assemble the source files, but do not link.  The linking
848 stage simply is not done.  The ultimate output is in the form of an
849 object file for each source file.
850
851 By default, the object file name for a source file is made by replacing
852 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
853
854 Unrecognized input files, not requiring compilation or assembly, are
855 ignored.
856
857 @item -S
858 @opindex S
859 Stop after the stage of compilation proper; do not assemble.  The output
860 is in the form of an assembler code file for each non-assembler input
861 file specified.
862
863 By default, the assembler file name for a source file is made by
864 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
865
866 Input files that don't require compilation are ignored.
867
868 @item -E
869 @opindex E
870 Stop after the preprocessing stage; do not run the compiler proper.  The
871 output is in the form of preprocessed source code, which is sent to the
872 standard output.
873
874 Input files which don't require preprocessing are ignored.
875
876 @cindex output file option
877 @item -o @var{file}
878 @opindex o
879 Place output in file @var{file}.  This applies regardless to whatever
880 sort of output is being produced, whether it be an executable file,
881 an object file, an assembler file or preprocessed C code.
882
883 If you specify @option{-o} when compiling more than one input file, or
884 you are producing an executable file as output, all the source files
885 on the command line will be compiled at once.
886
887 If @option{-o} is not specified, the default is to put an executable file
888 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
889 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
890 all preprocessed C source on standard output.
891
892 @item -v
893 @opindex v
894 Print (on standard error output) the commands executed to run the stages
895 of compilation.  Also print the version number of the compiler driver
896 program and of the preprocessor and the compiler proper.
897
898 @item -###
899 @opindex ###
900 Like @option{-v} except the commands are not executed and all command
901 arguments are quoted.  This is useful for shell scripts to capture the
902 driver-generated command lines.
903
904 @item -pipe
905 @opindex pipe
906 Use pipes rather than temporary files for communication between the
907 various stages of compilation.  This fails to work on some systems where
908 the assembler is unable to read from a pipe; but the GNU assembler has
909 no trouble.
910
911 @item --help
912 @opindex help
913 Print (on the standard output) a description of the command line options
914 understood by @command{gcc}.  If the @option{-v} option is also specified
915 then @option{--help} will also be passed on to the various processes
916 invoked by @command{gcc}, so that they can display the command line options
917 they accept.  If the @option{-Wextra} option is also specified then command
918 line options which have no documentation associated with them will also
919 be displayed.
920
921 @item --target-help
922 @opindex target-help
923 Print (on the standard output) a description of target specific command
924 line options for each tool.
925
926 @item --version
927 @opindex version
928 Display the version number and copyrights of the invoked GCC.
929 @end table
930
931 @node Invoking G++
932 @section Compiling C++ Programs
933
934 @cindex suffixes for C++ source
935 @cindex C++ source file suffixes
936 C++ source files conventionally use one of the suffixes @samp{.C},
937 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
938 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
939 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
940 files with these names and compiles them as C++ programs even if you
941 call the compiler the same way as for compiling C programs (usually
942 with the name @command{gcc}).
943
944 @findex g++
945 @findex c++
946 However, C++ programs often require class libraries as well as a
947 compiler that understands the C++ language---and under some
948 circumstances, you might want to compile programs or header files from
949 standard input, or otherwise without a suffix that flags them as C++
950 programs.  You might also like to precompile a C header file with a
951 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
952 program that calls GCC with the default language set to C++, and
953 automatically specifies linking against the C++ library.  On many
954 systems, @command{g++} is also installed with the name @command{c++}.
955
956 @cindex invoking @command{g++}
957 When you compile C++ programs, you may specify many of the same
958 command-line options that you use for compiling programs in any
959 language; or command-line options meaningful for C and related
960 languages; or options that are meaningful only for C++ programs.
961 @xref{C Dialect Options,,Options Controlling C Dialect}, for
962 explanations of options for languages related to C@.
963 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
964 explanations of options that are meaningful only for C++ programs.
965
966 @node C Dialect Options
967 @section Options Controlling C Dialect
968 @cindex dialect options
969 @cindex language dialect options
970 @cindex options, dialect
971
972 The following options control the dialect of C (or languages derived
973 from C, such as C++ and Objective-C) that the compiler accepts:
974
975 @table @gcctabopt
976 @cindex ANSI support
977 @cindex ISO support
978 @item -ansi
979 @opindex ansi
980 In C mode, support all ISO C90 programs.  In C++ mode,
981 remove GNU extensions that conflict with ISO C++.
982
983 This turns off certain features of GCC that are incompatible with ISO
984 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
985 such as the @code{asm} and @code{typeof} keywords, and
986 predefined macros such as @code{unix} and @code{vax} that identify the
987 type of system you are using.  It also enables the undesirable and
988 rarely used ISO trigraph feature.  For the C compiler,
989 it disables recognition of C++ style @samp{//} comments as well as
990 the @code{inline} keyword.
991
992 The alternate keywords @code{__asm__}, @code{__extension__},
993 @code{__inline__} and @code{__typeof__} continue to work despite
994 @option{-ansi}.  You would not want to use them in an ISO C program, of
995 course, but it is useful to put them in header files that might be included
996 in compilations done with @option{-ansi}.  Alternate predefined macros
997 such as @code{__unix__} and @code{__vax__} are also available, with or
998 without @option{-ansi}.
999
1000 The @option{-ansi} option does not cause non-ISO programs to be
1001 rejected gratuitously.  For that, @option{-pedantic} is required in
1002 addition to @option{-ansi}.  @xref{Warning Options}.
1003
1004 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1005 option is used.  Some header files may notice this macro and refrain
1006 from declaring certain functions or defining certain macros that the
1007 ISO standard doesn't call for; this is to avoid interfering with any
1008 programs that might use these names for other things.
1009
1010 Functions which would normally be built in but do not have semantics
1011 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1012 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1013 built-in functions provided by GCC}, for details of the functions
1014 affected.
1015
1016 @item -std=
1017 @opindex std
1018 Determine the language standard.  This option is currently only
1019 supported when compiling C or C++.  A value for this option must be
1020 provided; possible values are
1021
1022 @table @samp
1023 @item c89
1024 @itemx iso9899:1990
1025 ISO C90 (same as @option{-ansi}).
1026
1027 @item iso9899:199409
1028 ISO C90 as modified in amendment 1.
1029
1030 @item c99
1031 @itemx c9x
1032 @itemx iso9899:1999
1033 @itemx iso9899:199x
1034 ISO C99.  Note that this standard is not yet fully supported; see
1035 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1036 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1037
1038 @item gnu89
1039 Default, ISO C90 plus GNU extensions (including some C99 features).
1040
1041 @item gnu99
1042 @itemx gnu9x
1043 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1044 this will become the default.  The name @samp{gnu9x} is deprecated.
1045
1046 @item c++98
1047 The 1998 ISO C++ standard plus amendments.
1048
1049 @item gnu++98
1050 The same as @option{-std=c++98} plus GNU extensions.  This is the
1051 default for C++ code.
1052 @end table
1053
1054 Even when this option is not specified, you can still use some of the
1055 features of newer standards in so far as they do not conflict with
1056 previous C standards.  For example, you may use @code{__restrict__} even
1057 when @option{-std=c99} is not specified.
1058
1059 The @option{-std} options specifying some version of ISO C have the same
1060 effects as @option{-ansi}, except that features that were not in ISO C90
1061 but are in the specified version (for example, @samp{//} comments and
1062 the @code{inline} keyword in ISO C99) are not disabled.
1063
1064 @xref{Standards,,Language Standards Supported by GCC}, for details of
1065 these standard versions.
1066
1067 @item -aux-info @var{filename}
1068 @opindex aux-info
1069 Output to the given filename prototyped declarations for all functions
1070 declared and/or defined in a translation unit, including those in header
1071 files.  This option is silently ignored in any language other than C@.
1072
1073 Besides declarations, the file indicates, in comments, the origin of
1074 each declaration (source file and line), whether the declaration was
1075 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1076 @samp{O} for old, respectively, in the first character after the line
1077 number and the colon), and whether it came from a declaration or a
1078 definition (@samp{C} or @samp{F}, respectively, in the following
1079 character).  In the case of function definitions, a K&R-style list of
1080 arguments followed by their declarations is also provided, inside
1081 comments, after the declaration.
1082
1083 @item -fno-asm
1084 @opindex fno-asm
1085 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1086 keyword, so that code can use these words as identifiers.  You can use
1087 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1088 instead.  @option{-ansi} implies @option{-fno-asm}.
1089
1090 In C++, this switch only affects the @code{typeof} keyword, since
1091 @code{asm} and @code{inline} are standard keywords.  You may want to
1092 use the @option{-fno-gnu-keywords} flag instead, which has the same
1093 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1094 switch only affects the @code{asm} and @code{typeof} keywords, since
1095 @code{inline} is a standard keyword in ISO C99.
1096
1097 @item -fno-builtin
1098 @itemx -fno-builtin-@var{function}
1099 @opindex fno-builtin
1100 @cindex built-in functions
1101 Don't recognize built-in functions that do not begin with
1102 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1103 functions provided by GCC}, for details of the functions affected,
1104 including those which are not built-in functions when @option{-ansi} or
1105 @option{-std} options for strict ISO C conformance are used because they
1106 do not have an ISO standard meaning.
1107
1108 GCC normally generates special code to handle certain built-in functions
1109 more efficiently; for instance, calls to @code{alloca} may become single
1110 instructions that adjust the stack directly, and calls to @code{memcpy}
1111 may become inline copy loops.  The resulting code is often both smaller
1112 and faster, but since the function calls no longer appear as such, you
1113 cannot set a breakpoint on those calls, nor can you change the behavior
1114 of the functions by linking with a different library.
1115
1116 With the @option{-fno-builtin-@var{function}} option
1117 only the built-in function @var{function} is
1118 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1119 function is named this is not built-in in this version of GCC, this
1120 option is ignored.  There is no corresponding
1121 @option{-fbuiltin-@var{function}} option; if you wish to enable
1122 built-in functions selectively when using @option{-fno-builtin} or
1123 @option{-ffreestanding}, you may define macros such as:
1124
1125 @smallexample
1126 #define abs(n)          __builtin_abs ((n))
1127 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1128 @end smallexample
1129
1130 @item -fhosted
1131 @opindex fhosted
1132 @cindex hosted environment
1133
1134 Assert that compilation takes place in a hosted environment.  This implies
1135 @option{-fbuiltin}.  A hosted environment is one in which the
1136 entire standard library is available, and in which @code{main} has a return
1137 type of @code{int}.  Examples are nearly everything except a kernel.
1138 This is equivalent to @option{-fno-freestanding}.
1139
1140 @item -ffreestanding
1141 @opindex ffreestanding
1142 @cindex hosted environment
1143
1144 Assert that compilation takes place in a freestanding environment.  This
1145 implies @option{-fno-builtin}.  A freestanding environment
1146 is one in which the standard library may not exist, and program startup may
1147 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1148 This is equivalent to @option{-fno-hosted}.
1149
1150 @xref{Standards,,Language Standards Supported by GCC}, for details of
1151 freestanding and hosted environments.
1152
1153 @item -fms-extensions
1154 @opindex fms-extensions
1155 Accept some non-standard constructs used in Microsoft header files.
1156
1157 @item -trigraphs
1158 @opindex trigraphs
1159 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1160 options for strict ISO C conformance) implies @option{-trigraphs}.
1161
1162 @item -no-integrated-cpp
1163 @opindex no-integrated-cpp
1164 Performs a compilation in two passes: preprocessing and compiling.  This
1165 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1166 @option{-B} option. The user supplied compilation step can then add in
1167 an additional preprocessing step after normal preprocessing but before
1168 compiling. The default is to use the integrated cpp (internal cpp)
1169
1170 The semantics of this option will change if "cc1", "cc1plus", and
1171 "cc1obj" are merged.
1172
1173 @cindex traditional C language
1174 @cindex C language, traditional
1175 @item -traditional
1176 @itemx -traditional-cpp
1177 @opindex traditional-cpp
1178 @opindex traditional
1179 Formerly, these options caused GCC to attempt to emulate a pre-standard
1180 C compiler.  They are now only supported with the @option{-E} switch.
1181 The preprocessor continues to support a pre-standard mode.  See the GNU
1182 CPP manual for details.
1183
1184 @item -fcond-mismatch
1185 @opindex fcond-mismatch
1186 Allow conditional expressions with mismatched types in the second and
1187 third arguments.  The value of such an expression is void.  This option
1188 is not supported for C++.
1189
1190 @item -funsigned-char
1191 @opindex funsigned-char
1192 Let the type @code{char} be unsigned, like @code{unsigned char}.
1193
1194 Each kind of machine has a default for what @code{char} should
1195 be.  It is either like @code{unsigned char} by default or like
1196 @code{signed char} by default.
1197
1198 Ideally, a portable program should always use @code{signed char} or
1199 @code{unsigned char} when it depends on the signedness of an object.
1200 But many programs have been written to use plain @code{char} and
1201 expect it to be signed, or expect it to be unsigned, depending on the
1202 machines they were written for.  This option, and its inverse, let you
1203 make such a program work with the opposite default.
1204
1205 The type @code{char} is always a distinct type from each of
1206 @code{signed char} or @code{unsigned char}, even though its behavior
1207 is always just like one of those two.
1208
1209 @item -fsigned-char
1210 @opindex fsigned-char
1211 Let the type @code{char} be signed, like @code{signed char}.
1212
1213 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1214 the negative form of @option{-funsigned-char}.  Likewise, the option
1215 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1216
1217 @item -fsigned-bitfields
1218 @itemx -funsigned-bitfields
1219 @itemx -fno-signed-bitfields
1220 @itemx -fno-unsigned-bitfields
1221 @opindex fsigned-bitfields
1222 @opindex funsigned-bitfields
1223 @opindex fno-signed-bitfields
1224 @opindex fno-unsigned-bitfields
1225 These options control whether a bit-field is signed or unsigned, when the
1226 declaration does not use either @code{signed} or @code{unsigned}.  By
1227 default, such a bit-field is signed, because this is consistent: the
1228 basic integer types such as @code{int} are signed types.
1229
1230 @item -fwritable-strings
1231 @opindex fwritable-strings
1232 Store string constants in the writable data segment and don't uniquize
1233 them.  This is for compatibility with old programs which assume they can
1234 write into string constants.
1235
1236 Writing into string constants is a very bad idea; ``constants'' should
1237 be constant.
1238
1239 This option is deprecated.
1240 @end table
1241
1242 @node C++ Dialect Options
1243 @section Options Controlling C++ Dialect
1244
1245 @cindex compiler options, C++
1246 @cindex C++ options, command line
1247 @cindex options, C++
1248 This section describes the command-line options that are only meaningful
1249 for C++ programs; but you can also use most of the GNU compiler options
1250 regardless of what language your program is in.  For example, you
1251 might compile a file @code{firstClass.C} like this:
1252
1253 @smallexample
1254 g++ -g -frepo -O -c firstClass.C
1255 @end smallexample
1256
1257 @noindent
1258 In this example, only @option{-frepo} is an option meant
1259 only for C++ programs; you can use the other options with any
1260 language supported by GCC@.
1261
1262 Here is a list of options that are @emph{only} for compiling C++ programs:
1263
1264 @table @gcctabopt
1265
1266 @item -fabi-version=@var{n}
1267 @opindex fabi-version
1268 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1269 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1270 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1271 the version that conforms most closely to the C++ ABI specification.
1272 Therefore, the ABI obtained using version 0 will change as ABI bugs
1273 are fixed.
1274
1275 The default is version 1.
1276
1277 @item -fno-access-control
1278 @opindex fno-access-control
1279 Turn off all access checking.  This switch is mainly useful for working
1280 around bugs in the access control code.
1281
1282 @item -fcheck-new
1283 @opindex fcheck-new
1284 Check that the pointer returned by @code{operator new} is non-null
1285 before attempting to modify the storage allocated.  This check is
1286 normally unnecessary because the C++ standard specifies that
1287 @code{operator new} will only return @code{0} if it is declared
1288 @samp{throw()}, in which case the compiler will always check the
1289 return value even without this option.  In all other cases, when
1290 @code{operator new} has a non-empty exception specification, memory
1291 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1292 @samp{new (nothrow)}.
1293
1294 @item -fconserve-space
1295 @opindex fconserve-space
1296 Put uninitialized or runtime-initialized global variables into the
1297 common segment, as C does.  This saves space in the executable at the
1298 cost of not diagnosing duplicate definitions.  If you compile with this
1299 flag and your program mysteriously crashes after @code{main()} has
1300 completed, you may have an object that is being destroyed twice because
1301 two definitions were merged.
1302
1303 This option is no longer useful on most targets, now that support has
1304 been added for putting variables into BSS without making them common.
1305
1306 @item -fno-const-strings
1307 @opindex fno-const-strings
1308 Give string constants type @code{char *} instead of type @code{const
1309 char *}.  By default, G++ uses type @code{const char *} as required by
1310 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1311 actually modify the value of a string constant, unless you also use
1312 @option{-fwritable-strings}.
1313
1314 This option might be removed in a future release of G++.  For maximum
1315 portability, you should structure your code so that it works with
1316 string constants that have type @code{const char *}.
1317
1318 @item -fno-elide-constructors
1319 @opindex fno-elide-constructors
1320 The C++ standard allows an implementation to omit creating a temporary
1321 which is only used to initialize another object of the same type.
1322 Specifying this option disables that optimization, and forces G++ to
1323 call the copy constructor in all cases.
1324
1325 @item -fno-enforce-eh-specs
1326 @opindex fno-enforce-eh-specs
1327 Don't check for violation of exception specifications at runtime.  This
1328 option violates the C++ standard, but may be useful for reducing code
1329 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1330 will still optimize based on the exception specifications.
1331
1332 @item -ffor-scope
1333 @itemx -fno-for-scope
1334 @opindex ffor-scope
1335 @opindex fno-for-scope
1336 If @option{-ffor-scope} is specified, the scope of variables declared in
1337 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1338 as specified by the C++ standard.
1339 If @option{-fno-for-scope} is specified, the scope of variables declared in
1340 a @i{for-init-statement} extends to the end of the enclosing scope,
1341 as was the case in old versions of G++, and other (traditional)
1342 implementations of C++.
1343
1344 The default if neither flag is given to follow the standard,
1345 but to allow and give a warning for old-style code that would
1346 otherwise be invalid, or have different behavior.
1347
1348 @item -fno-gnu-keywords
1349 @opindex fno-gnu-keywords
1350 Do not recognize @code{typeof} as a keyword, so that code can use this
1351 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1352 @option{-ansi} implies @option{-fno-gnu-keywords}.
1353
1354 @item -fno-implicit-templates
1355 @opindex fno-implicit-templates
1356 Never emit code for non-inline templates which are instantiated
1357 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1358 @xref{Template Instantiation}, for more information.
1359
1360 @item -fno-implicit-inline-templates
1361 @opindex fno-implicit-inline-templates
1362 Don't emit code for implicit instantiations of inline templates, either.
1363 The default is to handle inlines differently so that compiles with and
1364 without optimization will need the same set of explicit instantiations.
1365
1366 @item -fno-implement-inlines
1367 @opindex fno-implement-inlines
1368 To save space, do not emit out-of-line copies of inline functions
1369 controlled by @samp{#pragma implementation}.  This will cause linker
1370 errors if these functions are not inlined everywhere they are called.
1371
1372 @item -fms-extensions
1373 @opindex fms-extensions
1374 Disable pedantic warnings about constructs used in MFC, such as implicit
1375 int and getting a pointer to member function via non-standard syntax.
1376
1377 @item -fno-nonansi-builtins
1378 @opindex fno-nonansi-builtins
1379 Disable built-in declarations of functions that are not mandated by
1380 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1381 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1382
1383 @item -fno-operator-names
1384 @opindex fno-operator-names
1385 Do not treat the operator name keywords @code{and}, @code{bitand},
1386 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1387 synonyms as keywords.
1388
1389 @item -fno-optional-diags
1390 @opindex fno-optional-diags
1391 Disable diagnostics that the standard says a compiler does not need to
1392 issue.  Currently, the only such diagnostic issued by G++ is the one for
1393 a name having multiple meanings within a class.
1394
1395 @item -fpermissive
1396 @opindex fpermissive
1397 Downgrade some diagnostics about nonconformant code from errors to
1398 warnings.  Thus, using @option{-fpermissive} will allow some
1399 nonconforming code to compile.
1400
1401 @item -frepo
1402 @opindex frepo
1403 Enable automatic template instantiation at link time.  This option also
1404 implies @option{-fno-implicit-templates}.  @xref{Template
1405 Instantiation}, for more information.
1406
1407 @item -fno-rtti
1408 @opindex fno-rtti
1409 Disable generation of information about every class with virtual
1410 functions for use by the C++ runtime type identification features
1411 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1412 of the language, you can save some space by using this flag.  Note that
1413 exception handling uses the same information, but it will generate it as
1414 needed.
1415
1416 @item -fstats
1417 @opindex fstats
1418 Emit statistics about front-end processing at the end of the compilation.
1419 This information is generally only useful to the G++ development team.
1420
1421 @item -ftemplate-depth-@var{n}
1422 @opindex ftemplate-depth
1423 Set the maximum instantiation depth for template classes to @var{n}.
1424 A limit on the template instantiation depth is needed to detect
1425 endless recursions during template class instantiation.  ANSI/ISO C++
1426 conforming programs must not rely on a maximum depth greater than 17.
1427
1428 @item -fuse-cxa-atexit
1429 @opindex fuse-cxa-atexit
1430 Register destructors for objects with static storage duration with the
1431 @code{__cxa_atexit} function rather than the @code{atexit} function.
1432 This option is required for fully standards-compliant handling of static
1433 destructors, but will only work if your C library supports
1434 @code{__cxa_atexit}.
1435
1436 @item -fno-weak
1437 @opindex fno-weak
1438 Do not use weak symbol support, even if it is provided by the linker.
1439 By default, G++ will use weak symbols if they are available.  This
1440 option exists only for testing, and should not be used by end-users;
1441 it will result in inferior code and has no benefits.  This option may
1442 be removed in a future release of G++.
1443
1444 @item -nostdinc++
1445 @opindex nostdinc++
1446 Do not search for header files in the standard directories specific to
1447 C++, but do still search the other standard directories.  (This option
1448 is used when building the C++ library.)
1449 @end table
1450
1451 In addition, these optimization, warning, and code generation options
1452 have meanings only for C++ programs:
1453
1454 @table @gcctabopt
1455 @item -fno-default-inline
1456 @opindex fno-default-inline
1457 Do not assume @samp{inline} for functions defined inside a class scope.
1458 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1459 functions will have linkage like inline functions; they just won't be
1460 inlined by default.
1461
1462 @item -Wabi @r{(C++ only)}
1463 @opindex Wabi
1464 Warn when G++ generates code that is probably not compatible with the
1465 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1466 all such cases, there are probably some cases that are not warned about,
1467 even though G++ is generating incompatible code.  There may also be
1468 cases where warnings are emitted even though the code that is generated
1469 will be compatible.
1470
1471 You should rewrite your code to avoid these warnings if you are
1472 concerned about the fact that code generated by G++ may not be binary
1473 compatible with code generated by other compilers.
1474
1475 The known incompatibilities at this point include:
1476
1477 @itemize @bullet
1478
1479 @item
1480 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1481 pack data into the same byte as a base class.  For example:
1482
1483 @smallexample
1484 struct A @{ virtual void f(); int f1 : 1; @};
1485 struct B : public A @{ int f2 : 1; @};
1486 @end smallexample
1487
1488 @noindent
1489 In this case, G++ will place @code{B::f2} into the same byte
1490 as@code{A::f1}; other compilers will not.  You can avoid this problem
1491 by explicitly padding @code{A} so that its size is a multiple of the
1492 byte size on your platform; that will cause G++ and other compilers to
1493 layout @code{B} identically.
1494
1495 @item
1496 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1497 tail padding when laying out virtual bases.  For example:
1498
1499 @smallexample
1500 struct A @{ virtual void f(); char c1; @};
1501 struct B @{ B(); char c2; @};
1502 struct C : public A, public virtual B @{@};
1503 @end smallexample
1504
1505 @noindent
1506 In this case, G++ will not place @code{B} into the tail-padding for
1507 @code{A}; other compilers will.  You can avoid this problem by
1508 explicitly padding @code{A} so that its size is a multiple of its
1509 alignment (ignoring virtual base classes); that will cause G++ and other
1510 compilers to layout @code{C} identically.
1511
1512 @item
1513 Incorrect handling of bit-fields with declared widths greater than that
1514 of their underlying types, when the bit-fields appear in a union.  For
1515 example:
1516
1517 @smallexample
1518 union U @{ int i : 4096; @};
1519 @end smallexample
1520
1521 @noindent
1522 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1523 union too small by the number of bits in an @code{int}.
1524
1525 @item
1526 Empty classes can be placed at incorrect offsets.  For example:
1527
1528 @smallexample
1529 struct A @{@};
1530
1531 struct B @{
1532   A a;
1533   virtual void f ();
1534 @};
1535
1536 struct C : public B, public A @{@};
1537 @end smallexample
1538
1539 @noindent
1540 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1541 it should be placed at offset zero.  G++ mistakenly believes that the
1542 @code{A} data member of @code{B} is already at offset zero.
1543
1544 @item
1545 Names of template functions whose types involve @code{typename} or
1546 template template parameters can be mangled incorrectly.
1547
1548 @smallexample
1549 template <typename Q>
1550 void f(typename Q::X) @{@}
1551
1552 template <template <typename> class Q>
1553 void f(typename Q<int>::X) @{@}
1554 @end smallexample
1555
1556 @noindent
1557 Instantiations of these templates may be mangled incorrectly.
1558
1559 @end itemize
1560
1561 @item -Wctor-dtor-privacy @r{(C++ only)}
1562 @opindex Wctor-dtor-privacy
1563 Warn when a class seems unusable because all the constructors or
1564 destructors in that class are private, and it has neither friends nor
1565 public static member functions.
1566
1567 @item -Wnon-virtual-dtor @r{(C++ only)}
1568 @opindex Wnon-virtual-dtor
1569 Warn when a class appears to be polymorphic, thereby requiring a virtual
1570 destructor, yet it declares a non-virtual one.
1571 This warning is enabled by @option{-Wall}.
1572
1573 @item -Wreorder @r{(C++ only)}
1574 @opindex Wreorder
1575 @cindex reordering, warning
1576 @cindex warning for reordering of member initializers
1577 Warn when the order of member initializers given in the code does not
1578 match the order in which they must be executed.  For instance:
1579
1580 @smallexample
1581 struct A @{
1582   int i;
1583   int j;
1584   A(): j (0), i (1) @{ @}
1585 @};
1586 @end smallexample
1587
1588 The compiler will rearrange the member initializers for @samp{i}
1589 and @samp{j} to match the declaration order of the members, emitting
1590 a warning to that effect.  This warning is enabled by @option{-Wall}.
1591 @end table
1592
1593 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1594
1595 @table @gcctabopt
1596 @item -Weffc++ @r{(C++ only)}
1597 @opindex Weffc++
1598 Warn about violations of the following style guidelines from Scott Meyers'
1599 @cite{Effective C++} book:
1600
1601 @itemize @bullet
1602 @item
1603 Item 11:  Define a copy constructor and an assignment operator for classes
1604 with dynamically allocated memory.
1605
1606 @item
1607 Item 12:  Prefer initialization to assignment in constructors.
1608
1609 @item
1610 Item 14:  Make destructors virtual in base classes.
1611
1612 @item
1613 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1614
1615 @item
1616 Item 23:  Don't try to return a reference when you must return an object.
1617
1618 @end itemize
1619
1620 Also warn about violations of the following style guidelines from
1621 Scott Meyers' @cite{More Effective C++} book:
1622
1623 @itemize @bullet
1624 @item
1625 Item 6:  Distinguish between prefix and postfix forms of increment and
1626 decrement operators.
1627
1628 @item
1629 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1630
1631 @end itemize
1632
1633 When selecting this option, be aware that the standard library
1634 headers do not obey all of these guidelines; use @samp{grep -v}
1635 to filter out those warnings.
1636
1637 @item -Wno-deprecated @r{(C++ only)}
1638 @opindex Wno-deprecated
1639 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1640
1641 @item -Wno-non-template-friend @r{(C++ only)}
1642 @opindex Wno-non-template-friend
1643 Disable warnings when non-templatized friend functions are declared
1644 within a template.  Since the advent of explicit template specification
1645 support in G++, if the name of the friend is an unqualified-id (i.e.,
1646 @samp{friend foo(int)}), the C++ language specification demands that the
1647 friend declare or define an ordinary, nontemplate function.  (Section
1648 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1649 could be interpreted as a particular specialization of a templatized
1650 function.  Because this non-conforming behavior is no longer the default
1651 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1652 check existing code for potential trouble spots and is on by default.
1653 This new compiler behavior can be turned off with
1654 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1655 but disables the helpful warning.
1656
1657 @item -Wold-style-cast @r{(C++ only)}
1658 @opindex Wold-style-cast
1659 Warn if an old-style (C-style) cast to a non-void type is used within
1660 a C++ program.  The new-style casts (@samp{static_cast},
1661 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1662 unintended effects and much easier to search for.
1663
1664 @item -Woverloaded-virtual @r{(C++ only)}
1665 @opindex Woverloaded-virtual
1666 @cindex overloaded virtual fn, warning
1667 @cindex warning for overloaded virtual fn
1668 Warn when a function declaration hides virtual functions from a
1669 base class.  For example, in:
1670
1671 @smallexample
1672 struct A @{
1673   virtual void f();
1674 @};
1675
1676 struct B: public A @{
1677   void f(int);
1678 @};
1679 @end smallexample
1680
1681 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1682 like:
1683
1684 @smallexample
1685 B* b;
1686 b->f();
1687 @end smallexample
1688
1689 will fail to compile.
1690
1691 @item -Wno-pmf-conversions @r{(C++ only)}
1692 @opindex Wno-pmf-conversions
1693 Disable the diagnostic for converting a bound pointer to member function
1694 to a plain pointer.
1695
1696 @item -Wsign-promo @r{(C++ only)}
1697 @opindex Wsign-promo
1698 Warn when overload resolution chooses a promotion from unsigned or
1699 enumeral type to a signed type, over a conversion to an unsigned type of
1700 the same size.  Previous versions of G++ would try to preserve
1701 unsignedness, but the standard mandates the current behavior.
1702
1703 @item -Wsynth @r{(C++ only)}
1704 @opindex Wsynth
1705 @cindex warning for synthesized methods
1706 @cindex synthesized methods, warning
1707 Warn when G++'s synthesis behavior does not match that of cfront.  For
1708 instance:
1709
1710 @smallexample
1711 struct A @{
1712   operator int ();
1713   A& operator = (int);
1714 @};
1715
1716 main ()
1717 @{
1718   A a,b;
1719   a = b;
1720 @}
1721 @end smallexample
1722
1723 In this example, G++ will synthesize a default @samp{A& operator =
1724 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1725 @end table
1726
1727 @node Objective-C Dialect Options
1728 @section Options Controlling Objective-C Dialect
1729
1730 @cindex compiler options, Objective-C
1731 @cindex Objective-C options, command line
1732 @cindex options, Objective-C
1733 (NOTE: This manual does not describe the Objective-C language itself.  See
1734 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1735
1736 This section describes the command-line options that are only meaningful
1737 for Objective-C programs, but you can also use most of the GNU compiler
1738 options regardless of what language your program is in.  For example,
1739 you might compile a file @code{some_class.m} like this:
1740
1741 @smallexample
1742 gcc -g -fgnu-runtime -O -c some_class.m
1743 @end smallexample
1744
1745 @noindent
1746 In this example, @option{-fgnu-runtime} is an option meant only for
1747 Objective-C programs; you can use the other options with any language
1748 supported by GCC@.
1749
1750 Here is a list of options that are @emph{only} for compiling Objective-C
1751 programs:
1752
1753 @table @gcctabopt
1754 @item -fconstant-string-class=@var{class-name}
1755 @opindex fconstant-string-class
1756 Use @var{class-name} as the name of the class to instantiate for each
1757 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1758 class name is @code{NXConstantString} if the GNU runtime is being used, and
1759 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1760 @option{-fconstant-cfstrings} option, if also present, will override the
1761 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1762 to be laid out as constant CoreFoundation strings.
1763
1764 @item -fgnu-runtime
1765 @opindex fgnu-runtime
1766 Generate object code compatible with the standard GNU Objective-C
1767 runtime.  This is the default for most types of systems.
1768
1769 @item -fnext-runtime
1770 @opindex fnext-runtime
1771 Generate output compatible with the NeXT runtime.  This is the default
1772 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1773 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1774 used.
1775
1776 @item -fno-nil-receivers
1777 @opindex -fno-nil-receivers
1778 Assume that all Objective-C message dispatches (e.g.,
1779 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1780 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1781 used.  Currently, this option is only available in conjunction with
1782 the NeXT runtime on Mac OS X 10.3 and later.
1783
1784 @item -fobjc-exceptions
1785 @opindex -fobjc-exceptions
1786 Enable syntactic support for structured exception handling in Objective-C,
1787 similar to what is offered by C++ and Java.  Currently, this option is only
1788 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1789
1790 @smallexample
1791   @@try @{
1792     @dots{}
1793        @@throw expr;
1794     @dots{}
1795   @}
1796   @@catch (AnObjCClass *exc) @{
1797     @dots{}
1798       @@throw expr;
1799     @dots{}
1800       @@throw;
1801     @dots{}
1802   @}
1803   @@catch (AnotherClass *exc) @{
1804     @dots{}
1805   @}
1806   @@catch (id allOthers) @{
1807     @dots{}
1808   @}
1809   @@finally @{
1810     @dots{}
1811       @@throw expr;
1812     @dots{}
1813   @}
1814 @end smallexample
1815
1816 The @code{@@throw} statement may appear anywhere in an Objective-C or
1817 Objective-C++ program; when used inside of a @code{@@catch} block, the
1818 @code{@@throw} may appear without an argument (as shown above), in which case
1819 the object caught by the @code{@@catch} will be rethrown.
1820
1821 Note that only (pointers to) Objective-C objects may be thrown and
1822 caught using this scheme.  When an object is thrown, it will be caught
1823 by the nearest @code{@@catch} clause capable of handling objects of that type,
1824 analogously to how @code{catch} blocks work in C++ and Java.  A
1825 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1826 any and all Objective-C exceptions not caught by previous @code{@@catch}
1827 clauses (if any).
1828
1829 The @code{@@finally} clause, if present, will be executed upon exit from the
1830 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1831 regardless of whether any exceptions are thrown, caught or rethrown
1832 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1833 of the @code{finally} clause in Java.
1834
1835 There are several caveats to using the new exception mechanism:
1836
1837 @itemize @bullet
1838 @item
1839 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1840 idioms provided by the @code{NSException} class, the new
1841 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1842 systems, due to additional functionality needed in the (NeXT) Objective-C
1843 runtime.
1844
1845 @item
1846 As mentioned above, the new exceptions do not support handling
1847 types other than Objective-C objects.   Furthermore, when used from
1848 Objective-C++, the Objective-C exception model does not interoperate with C++
1849 exceptions at this time.  This means you cannot @code{@@throw} an exception
1850 from Objective-C and @code{catch} it in C++, or vice versa
1851 (i.e., @code{throw @dots{} @@catch}).
1852 @end itemize
1853
1854 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1855 blocks for thread-safe execution:
1856
1857 @smallexample
1858   @@synchronized (ObjCClass *guard) @{
1859     @dots{}
1860   @}
1861 @end smallexample
1862
1863 Upon entering the @code{@@synchronized} block, a thread of execution shall
1864 first check whether a lock has been placed on the corresponding @code{guard}
1865 object by another thread.  If it has, the current thread shall wait until
1866 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1867 the current thread will place its own lock on it, execute the code contained in
1868 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1869 making @code{guard} available to other threads).
1870
1871 Unlike Java, Objective-C does not allow for entire methods to be marked
1872 @code{@@synchronized}.  Note that throwing exceptions out of
1873 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1874 to be unlocked properly.
1875
1876 @item -freplace-objc-classes
1877 @opindex -freplace-objc-classes
1878 Emit a special marker instructing @command{ld(1)} not to statically link in
1879 the resulting object file, and allow @command{dyld(1)} to load it in at
1880 run time instead.  This is used in conjunction with the Fix-and-Continue
1881 debugging mode, where the object file in question may be recompiled and
1882 dynamically reloaded in the course of program execution, without the need
1883 to restart the program itself.  Currently, Fix-and-Continue functionality
1884 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1885 and later.
1886
1887 @item -fzero-link
1888 @opindex -fzero-link
1889 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1890 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1891 compile time) with static class references that get initialized at load time,
1892 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1893 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1894 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1895 for individual class implementations to be modified during program execution.
1896
1897 @item -gen-decls
1898 @opindex gen-decls
1899 Dump interface declarations for all classes seen in the source file to a
1900 file named @file{@var{sourcename}.decl}.
1901
1902 @item -Wno-protocol
1903 @opindex Wno-protocol
1904 If a class is declared to implement a protocol, a warning is issued for
1905 every method in the protocol that is not implemented by the class.  The
1906 default behavior is to issue a warning for every method not explicitly
1907 implemented in the class, even if a method implementation is inherited
1908 from the superclass.  If you use the @code{-Wno-protocol} option, then
1909 methods inherited from the superclass are considered to be implemented,
1910 and no warning is issued for them.
1911
1912 @item -Wselector
1913 @opindex Wselector
1914 Warn if multiple methods of different types for the same selector are
1915 found during compilation.  The check is performed on the list of methods
1916 in the final stage of compilation.  Additionally, a check is performed
1917 for each selector appearing in a @code{@@selector(@dots{})}
1918 expression, and a corresponding method for that selector has been found
1919 during compilation.  Because these checks scan the method table only at
1920 the end of compilation, these warnings are not produced if the final
1921 stage of compilation is not reached, for example because an error is
1922 found during compilation, or because the @code{-fsyntax-only} option is
1923 being used.
1924
1925 @item -Wundeclared-selector
1926 @opindex Wundeclared-selector
1927 Warn if a @code{@@selector(@dots{})} expression referring to an
1928 undeclared selector is found.  A selector is considered undeclared if no
1929 method with that name has been declared before the
1930 @code{@@selector(@dots{})} expression, either explicitly in an
1931 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1932 an @code{@@implementation} section.  This option always performs its
1933 checks as soon as a @code{@@selector(@dots{})} expression is found,
1934 while @code{-Wselector} only performs its checks in the final stage of
1935 compilation.  This also enforces the coding style convention
1936 that methods and selectors must be declared before being used.
1937
1938 @item -print-objc-runtime-info
1939 @opindex -print-objc-runtime-info
1940 Generate C header describing the largest structure that is passed by
1941 value, if any.
1942
1943 @end table
1944
1945 @node Language Independent Options
1946 @section Options to Control Diagnostic Messages Formatting
1947 @cindex options to control diagnostics formatting
1948 @cindex diagnostic messages
1949 @cindex message formatting
1950
1951 Traditionally, diagnostic messages have been formatted irrespective of
1952 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1953 below can be used to control the diagnostic messages formatting
1954 algorithm, e.g.@: how many characters per line, how often source location
1955 information should be reported.  Right now, only the C++ front end can
1956 honor these options.  However it is expected, in the near future, that
1957 the remaining front ends would be able to digest them correctly.
1958
1959 @table @gcctabopt
1960 @item -fmessage-length=@var{n}
1961 @opindex fmessage-length
1962 Try to format error messages so that they fit on lines of about @var{n}
1963 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1964 the front ends supported by GCC@.  If @var{n} is zero, then no
1965 line-wrapping will be done; each error message will appear on a single
1966 line.
1967
1968 @opindex fdiagnostics-show-location
1969 @item -fdiagnostics-show-location=once
1970 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1971 reporter to emit @emph{once} source location information; that is, in
1972 case the message is too long to fit on a single physical line and has to
1973 be wrapped, the source location won't be emitted (as prefix) again,
1974 over and over, in subsequent continuation lines.  This is the default
1975 behavior.
1976
1977 @item -fdiagnostics-show-location=every-line
1978 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1979 messages reporter to emit the same source location information (as
1980 prefix) for physical lines that result from the process of breaking
1981 a message which is too long to fit on a single line.
1982
1983 @end table
1984
1985 @node Warning Options
1986 @section Options to Request or Suppress Warnings
1987 @cindex options to control warnings
1988 @cindex warning messages
1989 @cindex messages, warning
1990 @cindex suppressing warnings
1991
1992 Warnings are diagnostic messages that report constructions which
1993 are not inherently erroneous but which are risky or suggest there
1994 may have been an error.
1995
1996 You can request many specific warnings with options beginning @samp{-W},
1997 for example @option{-Wimplicit} to request warnings on implicit
1998 declarations.  Each of these specific warning options also has a
1999 negative form beginning @samp{-Wno-} to turn off warnings;
2000 for example, @option{-Wno-implicit}.  This manual lists only one of the
2001 two forms, whichever is not the default.
2002
2003 The following options control the amount and kinds of warnings produced
2004 by GCC; for further, language-specific options also refer to
2005 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2006
2007 @table @gcctabopt
2008 @cindex syntax checking
2009 @item -fsyntax-only
2010 @opindex fsyntax-only
2011 Check the code for syntax errors, but don't do anything beyond that.
2012
2013 @item -pedantic
2014 @opindex pedantic
2015 Issue all the warnings demanded by strict ISO C and ISO C++;
2016 reject all programs that use forbidden extensions, and some other
2017 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2018 version of the ISO C standard specified by any @option{-std} option used.
2019
2020 Valid ISO C and ISO C++ programs should compile properly with or without
2021 this option (though a rare few will require @option{-ansi} or a
2022 @option{-std} option specifying the required version of ISO C)@.  However,
2023 without this option, certain GNU extensions and traditional C and C++
2024 features are supported as well.  With this option, they are rejected.
2025
2026 @option{-pedantic} does not cause warning messages for use of the
2027 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2028 warnings are also disabled in the expression that follows
2029 @code{__extension__}.  However, only system header files should use
2030 these escape routes; application programs should avoid them.
2031 @xref{Alternate Keywords}.
2032
2033 Some users try to use @option{-pedantic} to check programs for strict ISO
2034 C conformance.  They soon find that it does not do quite what they want:
2035 it finds some non-ISO practices, but not all---only those for which
2036 ISO C @emph{requires} a diagnostic, and some others for which
2037 diagnostics have been added.
2038
2039 A feature to report any failure to conform to ISO C might be useful in
2040 some instances, but would require considerable additional work and would
2041 be quite different from @option{-pedantic}.  We don't have plans to
2042 support such a feature in the near future.
2043
2044 Where the standard specified with @option{-std} represents a GNU
2045 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2046 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2047 extended dialect is based.  Warnings from @option{-pedantic} are given
2048 where they are required by the base standard.  (It would not make sense
2049 for such warnings to be given only for features not in the specified GNU
2050 C dialect, since by definition the GNU dialects of C include all
2051 features the compiler supports with the given option, and there would be
2052 nothing to warn about.)
2053
2054 @item -pedantic-errors
2055 @opindex pedantic-errors
2056 Like @option{-pedantic}, except that errors are produced rather than
2057 warnings.
2058
2059 @item -w
2060 @opindex w
2061 Inhibit all warning messages.
2062
2063 @item -Wno-import
2064 @opindex Wno-import
2065 Inhibit warning messages about the use of @samp{#import}.
2066
2067 @item -Wchar-subscripts
2068 @opindex Wchar-subscripts
2069 Warn if an array subscript has type @code{char}.  This is a common cause
2070 of error, as programmers often forget that this type is signed on some
2071 machines.
2072
2073 @item -Wcomment
2074 @opindex Wcomment
2075 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2076 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2077
2078 @item -Wformat
2079 @opindex Wformat
2080 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2081 the arguments supplied have types appropriate to the format string
2082 specified, and that the conversions specified in the format string make
2083 sense.  This includes standard functions, and others specified by format
2084 attributes (@pxref{Function Attributes}), in the @code{printf},
2085 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2086 not in the C standard) families.
2087
2088 The formats are checked against the format features supported by GNU
2089 libc version 2.2.  These include all ISO C90 and C99 features, as well
2090 as features from the Single Unix Specification and some BSD and GNU
2091 extensions.  Other library implementations may not support all these
2092 features; GCC does not support warning about features that go beyond a
2093 particular library's limitations.  However, if @option{-pedantic} is used
2094 with @option{-Wformat}, warnings will be given about format features not
2095 in the selected standard version (but not for @code{strfmon} formats,
2096 since those are not in any version of the C standard).  @xref{C Dialect
2097 Options,,Options Controlling C Dialect}.
2098
2099 Since @option{-Wformat} also checks for null format arguments for
2100 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2101
2102 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2103 aspects of format checking, the options @option{-Wformat-y2k},
2104 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2105 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2106 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2107
2108 @item -Wformat-y2k
2109 @opindex Wformat-y2k
2110 If @option{-Wformat} is specified, also warn about @code{strftime}
2111 formats which may yield only a two-digit year.
2112
2113 @item -Wno-format-extra-args
2114 @opindex Wno-format-extra-args
2115 If @option{-Wformat} is specified, do not warn about excess arguments to a
2116 @code{printf} or @code{scanf} format function.  The C standard specifies
2117 that such arguments are ignored.
2118
2119 Where the unused arguments lie between used arguments that are
2120 specified with @samp{$} operand number specifications, normally
2121 warnings are still given, since the implementation could not know what
2122 type to pass to @code{va_arg} to skip the unused arguments.  However,
2123 in the case of @code{scanf} formats, this option will suppress the
2124 warning if the unused arguments are all pointers, since the Single
2125 Unix Specification says that such unused arguments are allowed.
2126
2127 @item -Wno-format-zero-length
2128 @opindex Wno-format-zero-length
2129 If @option{-Wformat} is specified, do not warn about zero-length formats.
2130 The C standard specifies that zero-length formats are allowed.
2131
2132 @item -Wformat-nonliteral
2133 @opindex Wformat-nonliteral
2134 If @option{-Wformat} is specified, also warn if the format string is not a
2135 string literal and so cannot be checked, unless the format function
2136 takes its format arguments as a @code{va_list}.
2137
2138 @item -Wformat-security
2139 @opindex Wformat-security
2140 If @option{-Wformat} is specified, also warn about uses of format
2141 functions that represent possible security problems.  At present, this
2142 warns about calls to @code{printf} and @code{scanf} functions where the
2143 format string is not a string literal and there are no format arguments,
2144 as in @code{printf (foo);}.  This may be a security hole if the format
2145 string came from untrusted input and contains @samp{%n}.  (This is
2146 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2147 in future warnings may be added to @option{-Wformat-security} that are not
2148 included in @option{-Wformat-nonliteral}.)
2149
2150 @item -Wformat=2
2151 @opindex Wformat=2
2152 Enable @option{-Wformat} plus format checks not included in
2153 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2154 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2155
2156 @item -Wnonnull
2157 @opindex Wnonnull
2158 Warn about passing a null pointer for arguments marked as
2159 requiring a non-null value by the @code{nonnull} function attribute.
2160
2161 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2162 can be disabled with the @option{-Wno-nonnull} option.
2163
2164 @item -Winit-self @r{(C, C++, and Objective-C only)}
2165 @opindex Winit-self
2166 Warn about uninitialized variables which are initialized with themselves.
2167 Note this option can only be used with the @option{-Wuninitialized} option,
2168 which in turn only works with @option{-O1} and above.
2169
2170 For example, GCC will warn about @code{i} being uninitialized in the
2171 following snippet only when @option{-Winit-self} has been specified:
2172 @smallexample
2173 @group
2174 int f()
2175 @{
2176   int i = i;
2177   return i;
2178 @}
2179 @end group
2180 @end smallexample
2181
2182 @item -Wimplicit-int
2183 @opindex Wimplicit-int
2184 Warn when a declaration does not specify a type.
2185
2186 @item -Wimplicit-function-declaration
2187 @itemx -Werror-implicit-function-declaration
2188 @opindex Wimplicit-function-declaration
2189 @opindex Werror-implicit-function-declaration
2190 Give a warning (or error) whenever a function is used before being
2191 declared.
2192
2193 @item -Wimplicit
2194 @opindex Wimplicit
2195 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2196
2197 @item -Wmain
2198 @opindex Wmain
2199 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2200 function with external linkage, returning int, taking either zero
2201 arguments, two, or three arguments of appropriate types.
2202
2203 @item -Wmissing-braces
2204 @opindex Wmissing-braces
2205 Warn if an aggregate or union initializer is not fully bracketed.  In
2206 the following example, the initializer for @samp{a} is not fully
2207 bracketed, but that for @samp{b} is fully bracketed.
2208
2209 @smallexample
2210 int a[2][2] = @{ 0, 1, 2, 3 @};
2211 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2212 @end smallexample
2213
2214 @item -Wparentheses
2215 @opindex Wparentheses
2216 Warn if parentheses are omitted in certain contexts, such
2217 as when there is an assignment in a context where a truth value
2218 is expected, or when operators are nested whose precedence people
2219 often get confused about.
2220
2221 Also warn about constructions where there may be confusion to which
2222 @code{if} statement an @code{else} branch belongs.  Here is an example of
2223 such a case:
2224
2225 @smallexample
2226 @group
2227 @{
2228   if (a)
2229     if (b)
2230       foo ();
2231   else
2232     bar ();
2233 @}
2234 @end group
2235 @end smallexample
2236
2237 In C, every @code{else} branch belongs to the innermost possible @code{if}
2238 statement, which in this example is @code{if (b)}.  This is often not
2239 what the programmer expected, as illustrated in the above example by
2240 indentation the programmer chose.  When there is the potential for this
2241 confusion, GCC will issue a warning when this flag is specified.
2242 To eliminate the warning, add explicit braces around the innermost
2243 @code{if} statement so there is no way the @code{else} could belong to
2244 the enclosing @code{if}.  The resulting code would look like this:
2245
2246 @smallexample
2247 @group
2248 @{
2249   if (a)
2250     @{
2251       if (b)
2252         foo ();
2253       else
2254         bar ();
2255     @}
2256 @}
2257 @end group
2258 @end smallexample
2259
2260 @item -Wsequence-point
2261 @opindex Wsequence-point
2262 Warn about code that may have undefined semantics because of violations
2263 of sequence point rules in the C standard.
2264
2265 The C standard defines the order in which expressions in a C program are
2266 evaluated in terms of @dfn{sequence points}, which represent a partial
2267 ordering between the execution of parts of the program: those executed
2268 before the sequence point, and those executed after it.  These occur
2269 after the evaluation of a full expression (one which is not part of a
2270 larger expression), after the evaluation of the first operand of a
2271 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2272 function is called (but after the evaluation of its arguments and the
2273 expression denoting the called function), and in certain other places.
2274 Other than as expressed by the sequence point rules, the order of
2275 evaluation of subexpressions of an expression is not specified.  All
2276 these rules describe only a partial order rather than a total order,
2277 since, for example, if two functions are called within one expression
2278 with no sequence point between them, the order in which the functions
2279 are called is not specified.  However, the standards committee have
2280 ruled that function calls do not overlap.
2281
2282 It is not specified when between sequence points modifications to the
2283 values of objects take effect.  Programs whose behavior depends on this
2284 have undefined behavior; the C standard specifies that ``Between the
2285 previous and next sequence point an object shall have its stored value
2286 modified at most once by the evaluation of an expression.  Furthermore,
2287 the prior value shall be read only to determine the value to be
2288 stored.''.  If a program breaks these rules, the results on any
2289 particular implementation are entirely unpredictable.
2290
2291 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2292 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2293 diagnosed by this option, and it may give an occasional false positive
2294 result, but in general it has been found fairly effective at detecting
2295 this sort of problem in programs.
2296
2297 The present implementation of this option only works for C programs.  A
2298 future implementation may also work for C++ programs.
2299
2300 The C standard is worded confusingly, therefore there is some debate
2301 over the precise meaning of the sequence point rules in subtle cases.
2302 Links to discussions of the problem, including proposed formal
2303 definitions, may be found on our readings page, at
2304 @w{@uref{http://gcc.gnu.org/readings.html}}.
2305
2306 @item -Wreturn-type
2307 @opindex Wreturn-type
2308 Warn whenever a function is defined with a return-type that defaults to
2309 @code{int}.  Also warn about any @code{return} statement with no
2310 return-value in a function whose return-type is not @code{void}.
2311
2312 For C++, a function without return type always produces a diagnostic
2313 message, even when @option{-Wno-return-type} is specified.  The only
2314 exceptions are @samp{main} and functions defined in system headers.
2315
2316 @item -Wswitch
2317 @opindex Wswitch
2318 Warn whenever a @code{switch} statement has an index of enumeral type
2319 and lacks a @code{case} for one or more of the named codes of that
2320 enumeration.  (The presence of a @code{default} label prevents this
2321 warning.)  @code{case} labels outside the enumeration range also
2322 provoke warnings when this option is used.
2323
2324 @item -Wswitch-default
2325 @opindex Wswitch-switch
2326 Warn whenever a @code{switch} statement does not have a @code{default}
2327 case.
2328
2329 @item -Wswitch-enum
2330 @opindex Wswitch-enum
2331 Warn whenever a @code{switch} statement has an index of enumeral type
2332 and lacks a @code{case} for one or more of the named codes of that
2333 enumeration.  @code{case} labels outside the enumeration range also
2334 provoke warnings when this option is used.
2335
2336 @item -Wtrigraphs
2337 @opindex Wtrigraphs
2338 Warn if any trigraphs are encountered that might change the meaning of
2339 the program (trigraphs within comments are not warned about).
2340
2341 @item -Wunused-function
2342 @opindex Wunused-function
2343 Warn whenever a static function is declared but not defined or a
2344 non\-inline static function is unused.
2345
2346 @item -Wunused-label
2347 @opindex Wunused-label
2348 Warn whenever a label is declared but not used.
2349
2350 To suppress this warning use the @samp{unused} attribute
2351 (@pxref{Variable Attributes}).
2352
2353 @item -Wunused-parameter
2354 @opindex Wunused-parameter
2355 Warn whenever a function parameter is unused aside from its declaration.
2356
2357 To suppress this warning use the @samp{unused} attribute
2358 (@pxref{Variable Attributes}).
2359
2360 @item -Wunused-variable
2361 @opindex Wunused-variable
2362 Warn whenever a local variable or non-constant static variable is unused
2363 aside from its declaration
2364
2365 To suppress this warning use the @samp{unused} attribute
2366 (@pxref{Variable Attributes}).
2367
2368 @item -Wunused-value
2369 @opindex Wunused-value
2370 Warn whenever a statement computes a result that is explicitly not used.
2371
2372 To suppress this warning cast the expression to @samp{void}.
2373
2374 @item -Wunused
2375 @opindex Wunused
2376 All the above @option{-Wunused} options combined.
2377
2378 In order to get a warning about an unused function parameter, you must
2379 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2380 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2381
2382 @item -Wuninitialized
2383 @opindex Wuninitialized
2384 Warn if an automatic variable is used without first being initialized or
2385 if a variable may be clobbered by a @code{setjmp} call.
2386
2387 These warnings are possible only in optimizing compilation,
2388 because they require data flow information that is computed only
2389 when optimizing.  If you don't specify @option{-O}, you simply won't
2390 get these warnings.
2391
2392 If you want to warn about code which uses the uninitialized value of the
2393 variable in its own initializer, use the @option{-Winit-self} option.
2394
2395 These warnings occur only for variables that are candidates for
2396 register allocation.  Therefore, they do not occur for a variable that
2397 is declared @code{volatile}, or whose address is taken, or whose size
2398 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2399 structures, unions or arrays, even when they are in registers.
2400
2401 Note that there may be no warning about a variable that is used only
2402 to compute a value that itself is never used, because such
2403 computations may be deleted by data flow analysis before the warnings
2404 are printed.
2405
2406 These warnings are made optional because GCC is not smart
2407 enough to see all the reasons why the code might be correct
2408 despite appearing to have an error.  Here is one example of how
2409 this can happen:
2410
2411 @smallexample
2412 @group
2413 @{
2414   int x;
2415   switch (y)
2416     @{
2417     case 1: x = 1;
2418       break;
2419     case 2: x = 4;
2420       break;
2421     case 3: x = 5;
2422     @}
2423   foo (x);
2424 @}
2425 @end group
2426 @end smallexample
2427
2428 @noindent
2429 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2430 always initialized, but GCC doesn't know this.  Here is
2431 another common case:
2432
2433 @smallexample
2434 @{
2435   int save_y;
2436   if (change_y) save_y = y, y = new_y;
2437   @dots{}
2438   if (change_y) y = save_y;
2439 @}
2440 @end smallexample
2441
2442 @noindent
2443 This has no bug because @code{save_y} is used only if it is set.
2444
2445 @cindex @code{longjmp} warnings
2446 This option also warns when a non-volatile automatic variable might be
2447 changed by a call to @code{longjmp}.  These warnings as well are possible
2448 only in optimizing compilation.
2449
2450 The compiler sees only the calls to @code{setjmp}.  It cannot know
2451 where @code{longjmp} will be called; in fact, a signal handler could
2452 call it at any point in the code.  As a result, you may get a warning
2453 even when there is in fact no problem because @code{longjmp} cannot
2454 in fact be called at the place which would cause a problem.
2455
2456 Some spurious warnings can be avoided if you declare all the functions
2457 you use that never return as @code{noreturn}.  @xref{Function
2458 Attributes}.
2459
2460 @item -Wunknown-pragmas
2461 @opindex Wunknown-pragmas
2462 @cindex warning for unknown pragmas
2463 @cindex unknown pragmas, warning
2464 @cindex pragmas, warning of unknown
2465 Warn when a #pragma directive is encountered which is not understood by
2466 GCC@.  If this command line option is used, warnings will even be issued
2467 for unknown pragmas in system header files.  This is not the case if
2468 the warnings were only enabled by the @option{-Wall} command line option.
2469
2470 @item -Wstrict-aliasing
2471 @opindex Wstrict-aliasing
2472 This option is only active when @option{-fstrict-aliasing} is active.
2473 It warns about code which might break the strict aliasing rules that the
2474 compiler is using for optimization. The warning does not catch all
2475 cases, but does attempt to catch the more common pitfalls. It is
2476 included in @option{-Wall}.
2477
2478 @item -Wall
2479 @opindex Wall
2480 All of the above @samp{-W} options combined.  This enables all the
2481 warnings about constructions that some users consider questionable, and
2482 that are easy to avoid (or modify to prevent the warning), even in
2483 conjunction with macros.  This also enables some language-specific
2484 warnings described in @ref{C++ Dialect Options} and
2485 @ref{Objective-C Dialect Options}.
2486 @end table
2487
2488 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2489 Some of them warn about constructions that users generally do not
2490 consider questionable, but which occasionally you might wish to check
2491 for; others warn about constructions that are necessary or hard to avoid
2492 in some cases, and there is no simple way to modify the code to suppress
2493 the warning.
2494
2495 @table @gcctabopt
2496 @item -Wextra
2497 @opindex W
2498 @opindex Wextra
2499 (This option used to be called @option{-W}.  The older name is still
2500 supported, but the newer name is more descriptive.)  Print extra warning
2501 messages for these events:
2502
2503 @itemize @bullet
2504 @item
2505 A function can return either with or without a value.  (Falling
2506 off the end of the function body is considered returning without
2507 a value.)  For example, this function would evoke such a
2508 warning:
2509
2510 @smallexample
2511 @group
2512 foo (a)
2513 @{
2514   if (a > 0)
2515     return a;
2516 @}
2517 @end group
2518 @end smallexample
2519
2520 @item
2521 An expression-statement or the left-hand side of a comma expression
2522 contains no side effects.
2523 To suppress the warning, cast the unused expression to void.
2524 For example, an expression such as @samp{x[i,j]} will cause a warning,
2525 but @samp{x[(void)i,j]} will not.
2526
2527 @item
2528 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2529
2530 @item
2531 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2532 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2533 that of ordinary mathematical notation.
2534
2535 @item
2536 Storage-class specifiers like @code{static} are not the first things in
2537 a declaration.  According to the C Standard, this usage is obsolescent.
2538
2539 @item
2540 The return type of a function has a type qualifier such as @code{const}.
2541 Such a type qualifier has no effect, since the value returned by a
2542 function is not an lvalue.  (But don't warn about the GNU extension of
2543 @code{volatile void} return types.  That extension will be warned about
2544 if @option{-pedantic} is specified.)
2545
2546 @item
2547 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2548 arguments.
2549
2550 @item
2551 A comparison between signed and unsigned values could produce an
2552 incorrect result when the signed value is converted to unsigned.
2553 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2554
2555 @item
2556 An aggregate has an initializer which does not initialize all members.
2557 For example, the following code would cause such a warning, because
2558 @code{x.h} would be implicitly initialized to zero:
2559
2560 @smallexample
2561 struct s @{ int f, g, h; @};
2562 struct s x = @{ 3, 4 @};
2563 @end smallexample
2564
2565 @item
2566 A function parameter is declared without a type specifier in K&R-style
2567 functions:
2568
2569 @smallexample
2570 void foo(bar) @{ @}
2571 @end smallexample
2572
2573 @item
2574 An empty body occurs in an @samp{if} or @samp{else} statement.
2575
2576 @item
2577 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2578 @samp{>}, or @samp{>=}.
2579
2580 @item
2581 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2582
2583 @item
2584 Any of several floating-point events that often indicate errors, such as
2585 overflow, underflow, loss of precision, etc.
2586
2587 @item @r{(C++ only)}
2588 An enumerator and a non-enumerator both appear in a conditional expression.
2589
2590 @item @r{(C++ only)}
2591 A non-static reference or non-static @samp{const} member appears in a
2592 class without constructors.
2593
2594 @item @r{(C++ only)}
2595 Ambiguous virtual bases.
2596
2597 @item @r{(C++ only)}
2598 Subscripting an array which has been declared @samp{register}.
2599
2600 @item @r{(C++ only)}
2601 Taking the address of a variable which has been declared @samp{register}.
2602
2603 @item @r{(C++ only)}
2604 A base class is not initialized in a derived class' copy constructor.
2605 @end itemize
2606
2607 @item -Wno-div-by-zero
2608 @opindex Wno-div-by-zero
2609 @opindex Wdiv-by-zero
2610 Do not warn about compile-time integer division by zero.  Floating point
2611 division by zero is not warned about, as it can be a legitimate way of
2612 obtaining infinities and NaNs.
2613
2614 @item -Wsystem-headers
2615 @opindex Wsystem-headers
2616 @cindex warnings from system headers
2617 @cindex system headers, warnings from
2618 Print warning messages for constructs found in system header files.
2619 Warnings from system headers are normally suppressed, on the assumption
2620 that they usually do not indicate real problems and would only make the
2621 compiler output harder to read.  Using this command line option tells
2622 GCC to emit warnings from system headers as if they occurred in user
2623 code.  However, note that using @option{-Wall} in conjunction with this
2624 option will @emph{not} warn about unknown pragmas in system
2625 headers---for that, @option{-Wunknown-pragmas} must also be used.
2626
2627 @item -Wfloat-equal
2628 @opindex Wfloat-equal
2629 Warn if floating point values are used in equality comparisons.
2630
2631 The idea behind this is that sometimes it is convenient (for the
2632 programmer) to consider floating-point values as approximations to
2633 infinitely precise real numbers.  If you are doing this, then you need
2634 to compute (by analyzing the code, or in some other way) the maximum or
2635 likely maximum error that the computation introduces, and allow for it
2636 when performing comparisons (and when producing output, but that's a
2637 different problem).  In particular, instead of testing for equality, you
2638 would check to see whether the two values have ranges that overlap; and
2639 this is done with the relational operators, so equality comparisons are
2640 probably mistaken.
2641
2642 @item -Wtraditional @r{(C only)}
2643 @opindex Wtraditional
2644 Warn about certain constructs that behave differently in traditional and
2645 ISO C@.  Also warn about ISO C constructs that have no traditional C
2646 equivalent, and/or problematic constructs which should be avoided.
2647
2648 @itemize @bullet
2649 @item
2650 Macro parameters that appear within string literals in the macro body.
2651 In traditional C macro replacement takes place within string literals,
2652 but does not in ISO C@.
2653
2654 @item
2655 In traditional C, some preprocessor directives did not exist.
2656 Traditional preprocessors would only consider a line to be a directive
2657 if the @samp{#} appeared in column 1 on the line.  Therefore
2658 @option{-Wtraditional} warns about directives that traditional C
2659 understands but would ignore because the @samp{#} does not appear as the
2660 first character on the line.  It also suggests you hide directives like
2661 @samp{#pragma} not understood by traditional C by indenting them.  Some
2662 traditional implementations would not recognize @samp{#elif}, so it
2663 suggests avoiding it altogether.
2664
2665 @item
2666 A function-like macro that appears without arguments.
2667
2668 @item
2669 The unary plus operator.
2670
2671 @item
2672 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2673 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2674 constants.)  Note, these suffixes appear in macros defined in the system
2675 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2676 Use of these macros in user code might normally lead to spurious
2677 warnings, however gcc's integrated preprocessor has enough context to
2678 avoid warning in these cases.
2679
2680 @item
2681 A function declared external in one block and then used after the end of
2682 the block.
2683
2684 @item
2685 A @code{switch} statement has an operand of type @code{long}.
2686
2687 @item
2688 A non-@code{static} function declaration follows a @code{static} one.
2689 This construct is not accepted by some traditional C compilers.
2690
2691 @item
2692 The ISO type of an integer constant has a different width or
2693 signedness from its traditional type.  This warning is only issued if
2694 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2695 typically represent bit patterns, are not warned about.
2696
2697 @item
2698 Usage of ISO string concatenation is detected.
2699
2700 @item
2701 Initialization of automatic aggregates.
2702
2703 @item
2704 Identifier conflicts with labels.  Traditional C lacks a separate
2705 namespace for labels.
2706
2707 @item
2708 Initialization of unions.  If the initializer is zero, the warning is
2709 omitted.  This is done under the assumption that the zero initializer in
2710 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2711 initializer warnings and relies on default initialization to zero in the
2712 traditional C case.
2713
2714 @item
2715 Conversions by prototypes between fixed/floating point values and vice
2716 versa.  The absence of these prototypes when compiling with traditional
2717 C would cause serious problems.  This is a subset of the possible
2718 conversion warnings, for the full set use @option{-Wconversion}.
2719
2720 @item
2721 Use of ISO C style function definitions.  This warning intentionally is
2722 @emph{not} issued for prototype declarations or variadic functions
2723 because these ISO C features will appear in your code when using
2724 libiberty's traditional C compatibility macros, @code{PARAMS} and
2725 @code{VPARAMS}.  This warning is also bypassed for nested functions
2726 because that feature is already a gcc extension and thus not relevant to
2727 traditional C compatibility.
2728 @end itemize
2729
2730 @item -Wdeclaration-after-statement @r{(C only)}
2731 @opindex Wdeclaration-after-statement
2732 Warn when a declaration is found after a statement in a block.  This
2733 construct, known from C++, was introduced with ISO C99 and is by default
2734 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2735 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2736
2737 @item -Wundef
2738 @opindex Wundef
2739 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2740
2741 @item -Wendif-labels
2742 @opindex Wendif-labels
2743 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2744
2745 @item -Wshadow
2746 @opindex Wshadow
2747 Warn whenever a local variable shadows another local variable, parameter or
2748 global variable or whenever a built-in function is shadowed.
2749
2750 @item -Wlarger-than-@var{len}
2751 @opindex Wlarger-than
2752 Warn whenever an object of larger than @var{len} bytes is defined.
2753
2754 @item -Wpointer-arith
2755 @opindex Wpointer-arith
2756 Warn about anything that depends on the ``size of'' a function type or
2757 of @code{void}.  GNU C assigns these types a size of 1, for
2758 convenience in calculations with @code{void *} pointers and pointers
2759 to functions.
2760
2761 @item -Wbad-function-cast @r{(C only)}
2762 @opindex Wbad-function-cast
2763 Warn whenever a function call is cast to a non-matching type.
2764 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2765
2766 @item -Wcast-qual
2767 @opindex Wcast-qual
2768 Warn whenever a pointer is cast so as to remove a type qualifier from
2769 the target type.  For example, warn if a @code{const char *} is cast
2770 to an ordinary @code{char *}.
2771
2772 @item -Wcast-align
2773 @opindex Wcast-align
2774 Warn whenever a pointer is cast such that the required alignment of the
2775 target is increased.  For example, warn if a @code{char *} is cast to
2776 an @code{int *} on machines where integers can only be accessed at
2777 two- or four-byte boundaries.
2778
2779 @item -Wwrite-strings
2780 @opindex Wwrite-strings
2781 When compiling C, give string constants the type @code{const
2782 char[@var{length}]} so that
2783 copying the address of one into a non-@code{const} @code{char *}
2784 pointer will get a warning; when compiling C++, warn about the
2785 deprecated conversion from string constants to @code{char *}.
2786 These warnings will help you find at
2787 compile time code that can try to write into a string constant, but
2788 only if you have been very careful about using @code{const} in
2789 declarations and prototypes.  Otherwise, it will just be a nuisance;
2790 this is why we did not make @option{-Wall} request these warnings.
2791
2792 @item -Wconversion
2793 @opindex Wconversion
2794 Warn if a prototype causes a type conversion that is different from what
2795 would happen to the same argument in the absence of a prototype.  This
2796 includes conversions of fixed point to floating and vice versa, and
2797 conversions changing the width or signedness of a fixed point argument
2798 except when the same as the default promotion.
2799
2800 Also, warn if a negative integer constant expression is implicitly
2801 converted to an unsigned type.  For example, warn about the assignment
2802 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2803 casts like @code{(unsigned) -1}.
2804
2805 @item -Wsign-compare
2806 @opindex Wsign-compare
2807 @cindex warning for comparison of signed and unsigned values
2808 @cindex comparison of signed and unsigned values, warning
2809 @cindex signed and unsigned values, comparison warning
2810 Warn when a comparison between signed and unsigned values could produce
2811 an incorrect result when the signed value is converted to unsigned.
2812 This warning is also enabled by @option{-Wextra}; to get the other warnings
2813 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2814
2815 @item -Waggregate-return
2816 @opindex Waggregate-return
2817 Warn if any functions that return structures or unions are defined or
2818 called.  (In languages where you can return an array, this also elicits
2819 a warning.)
2820
2821 @item -Wstrict-prototypes @r{(C only)}
2822 @opindex Wstrict-prototypes
2823 Warn if a function is declared or defined without specifying the
2824 argument types.  (An old-style function definition is permitted without
2825 a warning if preceded by a declaration which specifies the argument
2826 types.)
2827
2828 @item -Wold-style-definition @r{(C only)}
2829 @opindex Wold-style-definition
2830 Warn if an old-style function definition is used.  A warning is given
2831 even if there is a previous prototype.
2832
2833 @item -Wmissing-prototypes @r{(C only)}
2834 @opindex Wmissing-prototypes
2835 Warn if a global function is defined without a previous prototype
2836 declaration.  This warning is issued even if the definition itself
2837 provides a prototype.  The aim is to detect global functions that fail
2838 to be declared in header files.
2839
2840 @item -Wmissing-declarations @r{(C only)}
2841 @opindex Wmissing-declarations
2842 Warn if a global function is defined without a previous declaration.
2843 Do so even if the definition itself provides a prototype.
2844 Use this option to detect global functions that are not declared in
2845 header files.
2846
2847 @item -Wmissing-noreturn
2848 @opindex Wmissing-noreturn
2849 Warn about functions which might be candidates for attribute @code{noreturn}.
2850 Note these are only possible candidates, not absolute ones.  Care should
2851 be taken to manually verify functions actually do not ever return before
2852 adding the @code{noreturn} attribute, otherwise subtle code generation
2853 bugs could be introduced.  You will not get a warning for @code{main} in
2854 hosted C environments.
2855
2856 @item -Wmissing-format-attribute
2857 @opindex Wmissing-format-attribute
2858 @opindex Wformat
2859 If @option{-Wformat} is enabled, also warn about functions which might be
2860 candidates for @code{format} attributes.  Note these are only possible
2861 candidates, not absolute ones.  GCC will guess that @code{format}
2862 attributes might be appropriate for any function that calls a function
2863 like @code{vprintf} or @code{vscanf}, but this might not always be the
2864 case, and some functions for which @code{format} attributes are
2865 appropriate may not be detected.  This option has no effect unless
2866 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2867
2868 @item -Wno-multichar
2869 @opindex Wno-multichar
2870 @opindex Wmultichar
2871 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2872 Usually they indicate a typo in the user's code, as they have
2873 implementation-defined values, and should not be used in portable code.
2874
2875 @item -Wno-deprecated-declarations
2876 @opindex Wno-deprecated-declarations
2877 Do not warn about uses of functions, variables, and types marked as
2878 deprecated by using the @code{deprecated} attribute.
2879 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2880 @pxref{Type Attributes}.)
2881
2882 @item -Wpacked
2883 @opindex Wpacked
2884 Warn if a structure is given the packed attribute, but the packed
2885 attribute has no effect on the layout or size of the structure.
2886 Such structures may be mis-aligned for little benefit.  For
2887 instance, in this code, the variable @code{f.x} in @code{struct bar}
2888 will be misaligned even though @code{struct bar} does not itself
2889 have the packed attribute:
2890
2891 @smallexample
2892 @group
2893 struct foo @{
2894   int x;
2895   char a, b, c, d;
2896 @} __attribute__((packed));
2897 struct bar @{
2898   char z;
2899   struct foo f;
2900 @};
2901 @end group
2902 @end smallexample
2903
2904 @item -Wpadded
2905 @opindex Wpadded
2906 Warn if padding is included in a structure, either to align an element
2907 of the structure or to align the whole structure.  Sometimes when this
2908 happens it is possible to rearrange the fields of the structure to
2909 reduce the padding and so make the structure smaller.
2910
2911 @item -Wredundant-decls
2912 @opindex Wredundant-decls
2913 Warn if anything is declared more than once in the same scope, even in
2914 cases where multiple declaration is valid and changes nothing.
2915
2916 @item -Wnested-externs @r{(C only)}
2917 @opindex Wnested-externs
2918 Warn if an @code{extern} declaration is encountered within a function.
2919
2920 @item -Wunreachable-code
2921 @opindex Wunreachable-code
2922 Warn if the compiler detects that code will never be executed.
2923
2924 This option is intended to warn when the compiler detects that at
2925 least a whole line of source code will never be executed, because
2926 some condition is never satisfied or because it is after a
2927 procedure that never returns.
2928
2929 It is possible for this option to produce a warning even though there
2930 are circumstances under which part of the affected line can be executed,
2931 so care should be taken when removing apparently-unreachable code.
2932
2933 For instance, when a function is inlined, a warning may mean that the
2934 line is unreachable in only one inlined copy of the function.
2935
2936 This option is not made part of @option{-Wall} because in a debugging
2937 version of a program there is often substantial code which checks
2938 correct functioning of the program and is, hopefully, unreachable
2939 because the program does work.  Another common use of unreachable
2940 code is to provide behavior which is selectable at compile-time.
2941
2942 @item -Winline
2943 @opindex Winline
2944 Warn if a function can not be inlined and it was declared as inline.
2945 Even with this option, the compiler will not warn about failures to
2946 inline functions declared in system headers.
2947
2948 The compiler uses a variety of heuristics to determine whether or not
2949 to inline a function.  For example, the compiler takes into account
2950 the size of the function being inlined and the the amount of inlining
2951 that has already been done in the current function.  Therefore,
2952 seemingly insignificant changes in the source program can cause the
2953 warnings produced by @option{-Winline} to appear or disappear.
2954
2955 @item -Wno-invalid-offsetof @r{(C++ only)}
2956 @opindex Wno-invalid-offsetof
2957 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2958 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2959 to a non-POD type is undefined.  In existing C++ implementations,
2960 however, @samp{offsetof} typically gives meaningful results even when
2961 applied to certain kinds of non-POD types. (Such as a simple
2962 @samp{struct} that fails to be a POD type only by virtue of having a
2963 constructor.)  This flag is for users who are aware that they are
2964 writing nonportable code and who have deliberately chosen to ignore the
2965 warning about it.
2966
2967 The restrictions on @samp{offsetof} may be relaxed in a future version
2968 of the C++ standard.
2969
2970 @item -Winvalid-pch
2971 @opindex Winvalid-pch
2972 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2973 the search path but can't be used.
2974
2975 @item -Wlong-long
2976 @opindex Wlong-long
2977 @opindex Wno-long-long
2978 Warn if @samp{long long} type is used.  This is default.  To inhibit
2979 the warning messages, use @option{-Wno-long-long}.  Flags
2980 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2981 only when @option{-pedantic} flag is used.
2982
2983 @item -Wdisabled-optimization
2984 @opindex Wdisabled-optimization
2985 Warn if a requested optimization pass is disabled.  This warning does
2986 not generally indicate that there is anything wrong with your code; it
2987 merely indicates that GCC's optimizers were unable to handle the code
2988 effectively.  Often, the problem is that your code is too big or too
2989 complex; GCC will refuse to optimize programs when the optimization
2990 itself is likely to take inordinate amounts of time.
2991
2992 @item -Werror
2993 @opindex Werror
2994 Make all warnings into errors.
2995 @end table
2996
2997 @node Debugging Options
2998 @section Options for Debugging Your Program or GCC
2999 @cindex options, debugging
3000 @cindex debugging information options
3001
3002 GCC has various special options that are used for debugging
3003 either your program or GCC:
3004
3005 @table @gcctabopt
3006 @item -g
3007 @opindex g
3008 Produce debugging information in the operating system's native format
3009 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3010 information.
3011
3012 On most systems that use stabs format, @option{-g} enables use of extra
3013 debugging information that only GDB can use; this extra information
3014 makes debugging work better in GDB but will probably make other debuggers
3015 crash or
3016 refuse to read the program.  If you want to control for certain whether
3017 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3018 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3019
3020 Unlike most other C compilers, GCC allows you to use @option{-g} with
3021 @option{-O}.  The shortcuts taken by optimized code may occasionally
3022 produce surprising results: some variables you declared may not exist
3023 at all; flow of control may briefly move where you did not expect it;
3024 some statements may not be executed because they compute constant
3025 results or their values were already at hand; some statements may
3026 execute in different places because they were moved out of loops.
3027
3028 Nevertheless it proves possible to debug optimized output.  This makes
3029 it reasonable to use the optimizer for programs that might have bugs.
3030
3031 The following options are useful when GCC is generated with the
3032 capability for more than one debugging format.
3033
3034 @item -ggdb
3035 @opindex ggdb
3036 Produce debugging information for use by GDB@.  This means to use the
3037 most expressive format available (DWARF 2, stabs, or the native format
3038 if neither of those are supported), including GDB extensions if at all
3039 possible.
3040
3041 @item -gstabs
3042 @opindex gstabs
3043 Produce debugging information in stabs format (if that is supported),
3044 without GDB extensions.  This is the format used by DBX on most BSD
3045 systems.  On MIPS, Alpha and System V Release 4 systems this option
3046 produces stabs debugging output which is not understood by DBX or SDB@.
3047 On System V Release 4 systems this option requires the GNU assembler.
3048
3049 @item -feliminate-unused-debug-symbols
3050 @opindex feliminate-unused-debug-symbols
3051 Produce debugging information in stabs format (if that is supported),
3052 for only symbols that are actually used.
3053
3054 @item -gstabs+
3055 @opindex gstabs+
3056 Produce debugging information in stabs format (if that is supported),
3057 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3058 use of these extensions is likely to make other debuggers crash or
3059 refuse to read the program.
3060
3061 @item -gcoff
3062 @opindex gcoff
3063 Produce debugging information in COFF format (if that is supported).
3064 This is the format used by SDB on most System V systems prior to
3065 System V Release 4.
3066
3067 @item -gxcoff
3068 @opindex gxcoff
3069 Produce debugging information in XCOFF format (if that is supported).
3070 This is the format used by the DBX debugger on IBM RS/6000 systems.
3071
3072 @item -gxcoff+
3073 @opindex gxcoff+
3074 Produce debugging information in XCOFF format (if that is supported),
3075 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3076 use of these extensions is likely to make other debuggers crash or
3077 refuse to read the program, and may cause assemblers other than the GNU
3078 assembler (GAS) to fail with an error.
3079
3080 @item -gdwarf-2
3081 @opindex gdwarf-2
3082 Produce debugging information in DWARF version 2 format (if that is
3083 supported).  This is the format used by DBX on IRIX 6.
3084
3085 @item -gvms
3086 @opindex gvms
3087 Produce debugging information in VMS debug format (if that is
3088 supported).  This is the format used by DEBUG on VMS systems.
3089
3090 @item -g@var{level}
3091 @itemx -ggdb@var{level}
3092 @itemx -gstabs@var{level}
3093 @itemx -gcoff@var{level}
3094 @itemx -gxcoff@var{level}
3095 @itemx -gvms@var{level}
3096 Request debugging information and also use @var{level} to specify how
3097 much information.  The default level is 2.
3098
3099 Level 1 produces minimal information, enough for making backtraces in
3100 parts of the program that you don't plan to debug.  This includes
3101 descriptions of functions and external variables, but no information
3102 about local variables and no line numbers.
3103
3104 Level 3 includes extra information, such as all the macro definitions
3105 present in the program.  Some debuggers support macro expansion when
3106 you use @option{-g3}.
3107
3108 Note that in order to avoid confusion between DWARF1 debug level 2,
3109 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3110 level.  Instead use an additional @option{-g@var{level}} option to
3111 change the debug level for DWARF2.
3112
3113 @item -feliminate-dwarf2-dups
3114 @opindex feliminate-dwarf2-dups
3115 Compress DWARF2 debugging information by eliminating duplicated
3116 information about each symbol.  This option only makes sense when
3117 generating DWARF2 debugging information with @option{-gdwarf-2}.
3118
3119 @cindex @command{prof}
3120 @item -p
3121 @opindex p
3122 Generate extra code to write profile information suitable for the
3123 analysis program @command{prof}.  You must use this option when compiling
3124 the source files you want data about, and you must also use it when
3125 linking.
3126
3127 @cindex @command{gprof}
3128 @item -pg
3129 @opindex pg
3130 Generate extra code to write profile information suitable for the
3131 analysis program @command{gprof}.  You must use this option when compiling
3132 the source files you want data about, and you must also use it when
3133 linking.
3134
3135 @item -Q
3136 @opindex Q
3137 Makes the compiler print out each function name as it is compiled, and
3138 print some statistics about each pass when it finishes.
3139
3140 @item -ftime-report
3141 @opindex ftime-report
3142 Makes the compiler print some statistics about the time consumed by each
3143 pass when it finishes.
3144
3145 @item -fmem-report
3146 @opindex fmem-report
3147 Makes the compiler print some statistics about permanent memory
3148 allocation when it finishes.
3149
3150 @item -fprofile-arcs
3151 @opindex fprofile-arcs
3152 Add code so that program flow @dfn{arcs} are instrumented.  During
3153 execution the program records how many times each branch and call is
3154 executed and how many times it is taken or returns.  When the compiled
3155 program exits it saves this data to a file called
3156 @file{@var{auxname}.gcda} for each source file. The data may be used for
3157 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3158 test coverage analysis (@option{-ftest-coverage}). Each object file's
3159 @var{auxname} is generated from the name of the output file, if
3160 explicitly specified and it is not the final executable, otherwise it is
3161 the basename of the source file. In both cases any suffix is removed
3162 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3163 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3164
3165 @itemize
3166
3167 @item
3168 Compile the source files with @option{-fprofile-arcs} plus optimization
3169 and code generation options. For test coverage analysis, use the
3170 additional @option{-ftest-coverage} option. You do not need to profile
3171 every source file in a program.
3172
3173 @item
3174 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3175 (the latter implies the former).
3176
3177 @item
3178 Run the program on a representative workload to generate the arc profile
3179 information. This may be repeated any number of times. You can run
3180 concurrent instances of your program, and provided that the file system
3181 supports locking, the data files will be correctly updated. Also
3182 @code{fork} calls are detected and correctly handled (double counting
3183 will not happen).
3184
3185 @item
3186 For profile-directed optimizations, compile the source files again with
3187 the same optimization and code generation options plus
3188 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3189 Control Optimization}).
3190
3191 @item
3192 For test coverage analysis, use @command{gcov} to produce human readable
3193 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3194 @command{gcov} documentation for further information.
3195
3196 @end itemize
3197
3198 With @option{-fprofile-arcs}, for each function of your program GCC
3199 creates a program flow graph, then finds a spanning tree for the graph.
3200 Only arcs that are not on the spanning tree have to be instrumented: the
3201 compiler adds code to count the number of times that these arcs are
3202 executed.  When an arc is the only exit or only entrance to a block, the
3203 instrumentation code can be added to the block; otherwise, a new basic
3204 block must be created to hold the instrumentation code.
3205
3206 @need 2000
3207 @item -ftest-coverage
3208 @opindex ftest-coverage
3209 Produce a notes file that the @command{gcov} code-coverage utility
3210 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3211 show program coverage. Each source file's note file is called
3212 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3213 above for a description of @var{auxname} and instructions on how to
3214 generate test coverage data. Coverage data will match the source files
3215 more closely, if you do not optimize.
3216
3217 @item -d@var{letters}
3218 @opindex d
3219 Says to make debugging dumps during compilation at times specified by
3220 @var{letters}.  This is used for debugging the compiler.  The file names
3221 for most of the dumps are made by appending a pass number and a word to
3222 the @var{dumpname}. @var{dumpname} is generated from the name of the
3223 output file, if explicitly specified and it is not an executable,
3224 otherwise it is the basename of the source file. In both cases any
3225 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3226 Here are the possible letters for use in @var{letters}, and their
3227 meanings:
3228
3229 @table @samp
3230 @item A
3231 @opindex dA
3232 Annotate the assembler output with miscellaneous debugging information.
3233 @item b
3234 @opindex db
3235 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3236 @item B
3237 @opindex dB
3238 Dump after block reordering, to @file{@var{file}.31.bbro}.
3239 @item c
3240 @opindex dc
3241 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3242 @item C
3243 @opindex dC
3244 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3245 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3246 @item d
3247 @opindex dd
3248 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3249 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3250 @item D
3251 @opindex dD
3252 Dump all macro definitions, at the end of preprocessing, in addition to
3253 normal output.
3254 @item E
3255 @opindex dE
3256 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3257 @item f
3258 @opindex df
3259 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3260 Also dump after life analysis, to @file{@var{file}.19.life}.
3261 @item F
3262 @opindex dF
3263 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3264 @item g
3265 @opindex dg
3266 Dump after global register allocation, to @file{@var{file}.25.greg}.
3267 @item G
3268 @opindex dG
3269 Dump after GCSE, to @file{@var{file}.08.gcse}.
3270 Also dump after jump bypassing and control flow optimizations, to
3271 @file{@var{file}.10.bypass}.
3272 @item h
3273 @opindex dh
3274 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3275 @item i
3276 @opindex di
3277 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3278 @item j
3279 @opindex dj
3280 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3281 @item k
3282 @opindex dk
3283 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3284 @item l
3285 @opindex dl
3286 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3287 @item L
3288 @opindex dL
3289 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3290 @file{@var{file}.16.loop2}.
3291 @item M
3292 @opindex dM
3293 Dump after performing the machine dependent reorganization pass, to
3294 @file{@var{file}.35.mach}.
3295 @item n
3296 @opindex dn
3297 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3298 @item N
3299 @opindex dN
3300 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3301 @item o
3302 @opindex do
3303 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3304 @item r
3305 @opindex dr
3306 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3307 @item R
3308 @opindex dR
3309 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3310 @item s
3311 @opindex ds
3312 Dump after CSE (including the jump optimization that sometimes follows
3313 CSE), to @file{@var{file}.06.cse}.
3314 @item S
3315 @opindex dS
3316 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3317 @item t
3318 @opindex dt
3319 Dump after the second CSE pass (including the jump optimization that
3320 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3321 @item T
3322 @opindex dT
3323 Dump after running tracer, to @file{@var{file}.15.tracer}.
3324 @item u
3325 @opindex du
3326 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3327 @item U
3328 @opindex dU
3329 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3330 @item V
3331 @opindex dV
3332 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3333 @item w
3334 @opindex dw
3335 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3336 @item z
3337 @opindex dz
3338 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3339 @item Z
3340 @opindex dZ
3341 Dump after constructing the web, to @file{@var{file}.17.web}.
3342 @item a
3343 @opindex da
3344 Produce all the dumps listed above.
3345 @item H
3346 @opindex dH
3347 Produce a core dump whenever an error occurs.
3348 @item m
3349 @opindex dm
3350 Print statistics on memory usage, at the end of the run, to
3351 standard error.
3352 @item p
3353 @opindex dp
3354 Annotate the assembler output with a comment indicating which
3355 pattern and alternative was used.  The length of each instruction is
3356 also printed.
3357 @item P
3358 @opindex dP
3359 Dump the RTL in the assembler output as a comment before each instruction.
3360 Also turns on @option{-dp} annotation.
3361 @item v
3362 @opindex dv
3363 For each of the other indicated dump files (except for
3364 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3365 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3366 @item x
3367 @opindex dx
3368 Just generate RTL for a function instead of compiling it.  Usually used
3369 with @samp{r}.
3370 @item y
3371 @opindex dy
3372 Dump debugging information during parsing, to standard error.
3373 @end table
3374
3375 @item -fdump-unnumbered
3376 @opindex fdump-unnumbered
3377 When doing debugging dumps (see @option{-d} option above), suppress instruction
3378 numbers and line number note output.  This makes it more feasible to
3379 use diff on debugging dumps for compiler invocations with different
3380 options, in particular with and without @option{-g}.
3381
3382 @item -fdump-translation-unit @r{(C and C++ only)}
3383 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3384 @opindex fdump-translation-unit
3385 Dump a representation of the tree structure for the entire translation
3386 unit to a file.  The file name is made by appending @file{.tu} to the
3387 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3388 controls the details of the dump as described for the
3389 @option{-fdump-tree} options.
3390
3391 @item -fdump-class-hierarchy @r{(C++ only)}
3392 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3393 @opindex fdump-class-hierarchy
3394 Dump a representation of each class's hierarchy and virtual function
3395 table layout to a file.  The file name is made by appending @file{.class}
3396 to the source file name.  If the @samp{-@var{options}} form is used,
3397 @var{options} controls the details of the dump as described for the
3398 @option{-fdump-tree} options.
3399
3400 @item -fdump-tree-@var{switch} @r{(C++ only)}
3401 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3402 @opindex fdump-tree
3403 Control the dumping at various stages of processing the intermediate
3404 language tree to a file.  The file name is generated by appending a switch
3405 specific suffix to the source file name.  If the @samp{-@var{options}}
3406 form is used, @var{options} is a list of @samp{-} separated options that
3407 control the details of the dump. Not all options are applicable to all
3408 dumps, those which are not meaningful will be ignored. The following
3409 options are available
3410
3411 @table @samp
3412 @item address
3413 Print the address of each node.  Usually this is not meaningful as it
3414 changes according to the environment and source file. Its primary use
3415 is for tying up a dump file with a debug environment.
3416 @item slim
3417 Inhibit dumping of members of a scope or body of a function merely
3418 because that scope has been reached. Only dump such items when they
3419 are directly reachable by some other path.
3420 @item all
3421 Turn on all options.
3422 @end table
3423
3424 The following tree dumps are possible:
3425 @table @samp
3426 @item original
3427 Dump before any tree based optimization, to @file{@var{file}.original}.
3428 @item optimized
3429 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3430 @item inlined
3431 Dump after function inlining, to @file{@var{file}.inlined}.
3432 @end table
3433
3434 @item -frandom-seed=@var{string}
3435 @opindex frandom-string
3436 This option provides a seed that GCC uses when it would otherwise use
3437 random numbers.  It is used to generate certain symbol names
3438 that have to be different in every compiled file. It is also used to
3439 place unique stamps in coverage data files and the object files that
3440 produce them. You can use the @option{-frandom-seed} option to produce
3441 reproducibly identical object files.
3442
3443 The @var{string} should be different for every file you compile.
3444
3445 @item -fsched-verbose=@var{n}
3446 @opindex fsched-verbose
3447 On targets that use instruction scheduling, this option controls the
3448 amount of debugging output the scheduler prints.  This information is
3449 written to standard error, unless @option{-dS} or @option{-dR} is
3450 specified, in which case it is output to the usual dump
3451 listing file, @file{.sched} or @file{.sched2} respectively.  However
3452 for @var{n} greater than nine, the output is always printed to standard
3453 error.
3454
3455 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3456 same information as @option{-dRS}.  For @var{n} greater than one, it
3457 also output basic block probabilities, detailed ready list information
3458 and unit/insn info.  For @var{n} greater than two, it includes RTL
3459 at abort point, control-flow and regions info.  And for @var{n} over
3460 four, @option{-fsched-verbose} also includes dependence info.
3461
3462 @item -save-temps
3463 @opindex save-temps
3464 Store the usual ``temporary'' intermediate files permanently; place them
3465 in the current directory and name them based on the source file.  Thus,
3466 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3467 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3468 preprocessed @file{foo.i} output file even though the compiler now
3469 normally uses an integrated preprocessor.
3470
3471 @item -time
3472 @opindex time
3473 Report the CPU time taken by each subprocess in the compilation
3474 sequence.  For C source files, this is the compiler proper and assembler
3475 (plus the linker if linking is done).  The output looks like this:
3476
3477 @smallexample
3478 # cc1 0.12 0.01
3479 # as 0.00 0.01
3480 @end smallexample
3481
3482 The first number on each line is the ``user time,'' that is time spent
3483 executing the program itself.  The second number is ``system time,''
3484 time spent executing operating system routines on behalf of the program.
3485 Both numbers are in seconds.
3486
3487 @item -print-file-name=@var{library}
3488 @opindex print-file-name
3489 Print the full absolute name of the library file @var{library} that
3490 would be used when linking---and don't do anything else.  With this
3491 option, GCC does not compile or link anything; it just prints the
3492 file name.
3493
3494 @item -print-multi-directory
3495 @opindex print-multi-directory
3496 Print the directory name corresponding to the multilib selected by any
3497 other switches present in the command line.  This directory is supposed
3498 to exist in @env{GCC_EXEC_PREFIX}.
3499
3500 @item -print-multi-lib
3501 @opindex print-multi-lib
3502 Print the mapping from multilib directory names to compiler switches
3503 that enable them.  The directory name is separated from the switches by
3504 @samp{;}, and each switch starts with an @samp{@@} instead of the
3505 @samp{-}, without spaces between multiple switches.  This is supposed to
3506 ease shell-processing.
3507
3508 @item -print-prog-name=@var{program}
3509 @opindex print-prog-name
3510 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3511
3512 @item -print-libgcc-file-name
3513 @opindex print-libgcc-file-name
3514 Same as @option{-print-file-name=libgcc.a}.
3515
3516 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3517 but you do want to link with @file{libgcc.a}.  You can do
3518
3519 @smallexample
3520 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3521 @end smallexample
3522
3523 @item -print-search-dirs
3524 @opindex print-search-dirs
3525 Print the name of the configured installation directory and a list of
3526 program and library directories gcc will search---and don't do anything else.
3527
3528 This is useful when gcc prints the error message
3529 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3530 To resolve this you either need to put @file{cpp0} and the other compiler
3531 components where gcc expects to find them, or you can set the environment
3532 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3533 Don't forget the trailing '/'.
3534 @xref{Environment Variables}.
3535
3536 @item -dumpmachine
3537 @opindex dumpmachine
3538 Print the compiler's target machine (for example,
3539 @samp{i686-pc-linux-gnu})---and don't do anything else.
3540
3541 @item -dumpversion
3542 @opindex dumpversion
3543 Print the compiler version (for example, @samp{3.0})---and don't do
3544 anything else.
3545
3546 @item -dumpspecs
3547 @opindex dumpspecs
3548 Print the compiler's built-in specs---and don't do anything else.  (This
3549 is used when GCC itself is being built.)  @xref{Spec Files}.
3550
3551 @item -feliminate-unused-debug-types
3552 @opindex feliminate-unused-debug-types
3553 Normally, when producing DWARF2 output, GCC will emit debugging
3554 information for all types declared in a compilation
3555 unit, regardless of whether or not they are actually used
3556 in that compilation unit.  Sometimes this is useful, such as
3557 if, in the debugger, you want to cast a value to a type that is
3558 not actually used in your program (but is declared).  More often,
3559 however, this results in a significant amount of wasted space.
3560 With this option, GCC will avoid producing debug symbol output
3561 for types that are nowhere used in the source file being compiled.
3562 @end table
3563
3564 @node Optimize Options
3565 @section Options That Control Optimization
3566 @cindex optimize options
3567 @cindex options, optimization
3568
3569 These options control various sorts of optimizations.
3570
3571 Without any optimization option, the compiler's goal is to reduce the
3572 cost of compilation and to make debugging produce the expected
3573 results.  Statements are independent: if you stop the program with a
3574 breakpoint between statements, you can then assign a new value to any
3575 variable or change the program counter to any other statement in the
3576 function and get exactly the results you would expect from the source
3577 code.
3578
3579 Turning on optimization flags makes the compiler attempt to improve
3580 the performance and/or code size at the expense of compilation time
3581 and possibly the ability to debug the program.
3582
3583 The compiler performs optimization based on the knowledge it has of
3584 the program.  Using the @option{-funit-at-a-time} flag will allow the
3585 compiler to consider information gained from later functions in the
3586 file when compiling a function.  Compiling multiple files at once to a
3587 single output file (and using @option{-funit-at-a-time}) will allow
3588 the compiler to use information gained from all of the files when
3589 compiling each of them.
3590
3591 Not all optimizations are controlled directly by a flag.  Only
3592 optimizations that have a flag are listed.
3593
3594 @table @gcctabopt
3595 @item -O
3596 @itemx -O1
3597 @opindex O
3598 @opindex O1
3599 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3600 more memory for a large function.
3601
3602 With @option{-O}, the compiler tries to reduce code size and execution
3603 time, without performing any optimizations that take a great deal of
3604 compilation time.
3605
3606 @option{-O} turns on the following optimization flags:
3607 @gccoptlist{-fdefer-pop @gol
3608 -fmerge-constants @gol
3609 -fthread-jumps @gol
3610 -floop-optimize @gol
3611 -fif-conversion @gol
3612 -fif-conversion2 @gol
3613 -fdelayed-branch @gol
3614 -fguess-branch-probability @gol
3615 -fcprop-registers}
3616
3617 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3618 where doing so does not interfere with debugging.
3619
3620 @item -O2
3621 @opindex O2
3622 Optimize even more.  GCC performs nearly all supported optimizations
3623 that do not involve a space-speed tradeoff.  The compiler does not
3624 perform loop unrolling or function inlining when you specify @option{-O2}.
3625 As compared to @option{-O}, this option increases both compilation time
3626 and the performance of the generated code.
3627
3628 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3629 also turns on the following optimization flags:
3630 @gccoptlist{-fforce-mem @gol
3631 -foptimize-sibling-calls @gol
3632 -fstrength-reduce @gol
3633 -fcse-follow-jumps  -fcse-skip-blocks @gol
3634 -frerun-cse-after-loop  -frerun-loop-opt @gol
3635 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3636 -fdelete-null-pointer-checks @gol
3637 -fexpensive-optimizations @gol
3638 -fregmove @gol
3639 -fschedule-insns  -fschedule-insns2 @gol
3640 -fsched-interblock  -fsched-spec @gol
3641 -fcaller-saves @gol
3642 -fpeephole2 @gol
3643 -freorder-blocks  -freorder-functions @gol
3644 -fstrict-aliasing @gol
3645 -funit-at-a-time @gol
3646 -falign-functions  -falign-jumps @gol
3647 -falign-loops  -falign-labels @gol
3648 -fcrossjumping}
3649
3650 Please note the warning under @option{-fgcse} about
3651 invoking @option{-O2} on programs that use computed gotos.
3652
3653 @item -O3
3654 @opindex O3
3655 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3656 @option{-O2} and also turns on the @option{-finline-functions},
3657 @option{-fweb} and @option{-frename-registers} options.
3658
3659 @item -O0
3660 @opindex O0
3661 Do not optimize.  This is the default.
3662
3663 @item -Os
3664 @opindex Os
3665 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3666 do not typically increase code size.  It also performs further
3667 optimizations designed to reduce code size.
3668
3669 @option{-Os} disables the following optimization flags:
3670 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3671 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3672
3673 If you use multiple @option{-O} options, with or without level numbers,
3674 the last such option is the one that is effective.
3675 @end table
3676
3677 Options of the form @option{-f@var{flag}} specify machine-independent
3678 flags.  Most flags have both positive and negative forms; the negative
3679 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3680 below, only one of the forms is listed---the one you typically will
3681 use.  You can figure out the other form by either removing @samp{no-}
3682 or adding it.
3683
3684 The following options control specific optimizations.  They are either
3685 activated by @option{-O} options or are related to ones that are.  You
3686 can use the following flags in the rare cases when ``fine-tuning'' of
3687 optimizations to be performed is desired.
3688
3689 @table @gcctabopt
3690 @item -fno-default-inline
3691 @opindex fno-default-inline
3692 Do not make member functions inline by default merely because they are
3693 defined inside the class scope (C++ only).  Otherwise, when you specify
3694 @w{@option{-O}}, member functions defined inside class scope are compiled
3695 inline by default; i.e., you don't need to add @samp{inline} in front of
3696 the member function name.
3697
3698 @item -fno-defer-pop
3699 @opindex fno-defer-pop
3700 Always pop the arguments to each function call as soon as that function
3701 returns.  For machines which must pop arguments after a function call,
3702 the compiler normally lets arguments accumulate on the stack for several
3703 function calls and pops them all at once.
3704
3705 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3706
3707 @item -fforce-mem
3708 @opindex fforce-mem
3709 Force memory operands to be copied into registers before doing
3710 arithmetic on them.  This produces better code by making all memory
3711 references potential common subexpressions.  When they are not common
3712 subexpressions, instruction combination should eliminate the separate
3713 register-load.
3714
3715 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3716
3717 @item -fforce-addr
3718 @opindex fforce-addr
3719 Force memory address constants to be copied into registers before
3720 doing arithmetic on them.  This may produce better code just as
3721 @option{-fforce-mem} may.
3722
3723 @item -fomit-frame-pointer
3724 @opindex fomit-frame-pointer
3725 Don't keep the frame pointer in a register for functions that
3726 don't need one.  This avoids the instructions to save, set up and
3727 restore frame pointers; it also makes an extra register available
3728 in many functions.  @strong{It also makes debugging impossible on
3729 some machines.}
3730
3731 On some machines, such as the VAX, this flag has no effect, because
3732 the standard calling sequence automatically handles the frame pointer
3733 and nothing is saved by pretending it doesn't exist.  The
3734 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3735 whether a target machine supports this flag.  @xref{Registers,,Register
3736 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3737
3738 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3739
3740 @item -foptimize-sibling-calls
3741 @opindex foptimize-sibling-calls
3742 Optimize sibling and tail recursive calls.
3743
3744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3745
3746 @item -fno-inline
3747 @opindex fno-inline
3748 Don't pay attention to the @code{inline} keyword.  Normally this option
3749 is used to keep the compiler from expanding any functions inline.
3750 Note that if you are not optimizing, no functions can be expanded inline.
3751
3752 @item -finline-functions
3753 @opindex finline-functions
3754 Integrate all simple functions into their callers.  The compiler
3755 heuristically decides which functions are simple enough to be worth
3756 integrating in this way.
3757
3758 If all calls to a given function are integrated, and the function is
3759 declared @code{static}, then the function is normally not output as
3760 assembler code in its own right.
3761
3762 Enabled at level @option{-O3}.
3763
3764 @item -finline-limit=@var{n}
3765 @opindex finline-limit
3766 By default, gcc limits the size of functions that can be inlined.  This flag
3767 allows the control of this limit for functions that are explicitly marked as
3768 inline (i.e., marked with the inline keyword or defined within the class
3769 definition in c++).  @var{n} is the size of functions that can be inlined in
3770 number of pseudo instructions (not counting parameter handling).  The default
3771 value of @var{n} is 600.
3772 Increasing this value can result in more inlined code at
3773 the cost of compilation time and memory consumption.  Decreasing usually makes
3774 the compilation faster and less code will be inlined (which presumably
3775 means slower programs).  This option is particularly useful for programs that
3776 use inlining heavily such as those based on recursive templates with C++.
3777
3778 Inlining is actually controlled by a number of parameters, which may be
3779 specified individually by using @option{--param @var{name}=@var{value}}.
3780 The @option{-finline-limit=@var{n}} option sets some of these parameters
3781 as follows:
3782
3783 @table @gcctabopt
3784  @item max-inline-insns-single
3785   is set to @var{n}/2.
3786  @item max-inline-insns-auto
3787   is set to @var{n}/2.
3788  @item min-inline-insns
3789   is set to 130 or @var{n}/4, whichever is smaller.
3790  @item max-inline-insns-rtl
3791   is set to @var{n}.
3792 @end table
3793
3794 See below for a documentation of the individual
3795 parameters controlling inlining.
3796
3797 @emph{Note:} pseudo instruction represents, in this particular context, an
3798 abstract measurement of function's size.  In no way, it represents a count
3799 of assembly instructions and as such its exact meaning might change from one
3800 release to an another.
3801
3802 @item -fkeep-inline-functions
3803 @opindex fkeep-inline-functions
3804 Even if all calls to a given function are integrated, and the function
3805 is declared @code{static}, nevertheless output a separate run-time
3806 callable version of the function.  This switch does not affect
3807 @code{extern inline} functions.
3808
3809 @item -fkeep-static-consts
3810 @opindex fkeep-static-consts
3811 Emit variables declared @code{static const} when optimization isn't turned
3812 on, even if the variables aren't referenced.
3813
3814 GCC enables this option by default.  If you want to force the compiler to
3815 check if the variable was referenced, regardless of whether or not
3816 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3817
3818 @item -fmerge-constants
3819 Attempt to merge identical constants (string constants and floating point
3820 constants) across compilation units.
3821
3822 This option is the default for optimized compilation if the assembler and
3823 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3824 behavior.
3825
3826 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3827
3828 @item -fmerge-all-constants
3829 Attempt to merge identical constants and identical variables.
3830
3831 This option implies @option{-fmerge-constants}.  In addition to
3832 @option{-fmerge-constants} this considers e.g. even constant initialized
3833 arrays or initialized constant variables with integral or floating point
3834 types.  Languages like C or C++ require each non-automatic variable to
3835 have distinct location, so using this option will result in non-conforming
3836 behavior.
3837
3838 @item -fnew-ra
3839 @opindex fnew-ra
3840 Use a graph coloring register allocator.  Currently this option is meant
3841 for testing, so we are interested to hear about miscompilations with
3842 @option{-fnew-ra}.
3843
3844 @item -fno-branch-count-reg
3845 @opindex fno-branch-count-reg
3846 Do not use ``decrement and branch'' instructions on a count register,
3847 but instead generate a sequence of instructions that decrement a
3848 register, compare it against zero, then branch based upon the result.
3849 This option is only meaningful on architectures that support such
3850 instructions, which include x86, PowerPC, IA-64 and S/390.
3851
3852 The default is @option{-fbranch-count-reg}, enabled when
3853 @option{-fstrength-reduce} is enabled.
3854
3855 @item -fno-function-cse
3856 @opindex fno-function-cse
3857 Do not put function addresses in registers; make each instruction that
3858 calls a constant function contain the function's address explicitly.
3859
3860 This option results in less efficient code, but some strange hacks
3861 that alter the assembler output may be confused by the optimizations
3862 performed when this option is not used.
3863
3864 The default is @option{-ffunction-cse}
3865
3866 @item -fno-zero-initialized-in-bss
3867 @opindex fno-zero-initialized-in-bss
3868 If the target supports a BSS section, GCC by default puts variables that
3869 are initialized to zero into BSS@.  This can save space in the resulting
3870 code.
3871
3872 This option turns off this behavior because some programs explicitly
3873 rely on variables going to the data section.  E.g., so that the
3874 resulting executable can find the beginning of that section and/or make
3875 assumptions based on that.
3876
3877 The default is @option{-fzero-initialized-in-bss}.
3878
3879 @item -fstrength-reduce
3880 @opindex fstrength-reduce
3881 Perform the optimizations of loop strength reduction and
3882 elimination of iteration variables.
3883
3884 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3885
3886 @item -fthread-jumps
3887 @opindex fthread-jumps
3888 Perform optimizations where we check to see if a jump branches to a
3889 location where another comparison subsumed by the first is found.  If
3890 so, the first branch is redirected to either the destination of the
3891 second branch or a point immediately following it, depending on whether
3892 the condition is known to be true or false.
3893
3894 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3895
3896 @item -fcse-follow-jumps
3897 @opindex fcse-follow-jumps
3898 In common subexpression elimination, scan through jump instructions
3899 when the target of the jump is not reached by any other path.  For
3900 example, when CSE encounters an @code{if} statement with an
3901 @code{else} clause, CSE will follow the jump when the condition
3902 tested is false.
3903
3904 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3905
3906 @item -fcse-skip-blocks
3907 @opindex fcse-skip-blocks
3908 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3909 follow jumps which conditionally skip over blocks.  When CSE
3910 encounters a simple @code{if} statement with no else clause,
3911 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3912 body of the @code{if}.
3913
3914 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3915
3916 @item -frerun-cse-after-loop
3917 @opindex frerun-cse-after-loop
3918 Re-run common subexpression elimination after loop optimizations has been
3919 performed.
3920
3921 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3922
3923 @item -frerun-loop-opt
3924 @opindex frerun-loop-opt
3925 Run the loop optimizer twice.
3926
3927 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3928
3929 @item -fgcse
3930 @opindex fgcse
3931 Perform a global common subexpression elimination pass.
3932 This pass also performs global constant and copy propagation.
3933
3934 @emph{Note:} When compiling a program using computed gotos, a GCC
3935 extension, you may get better runtime performance if you disable
3936 the global common subexpression elimination pass by adding
3937 @option{-fno-gcse} to the command line.
3938
3939 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3940
3941 @item -fgcse-lm
3942 @opindex fgcse-lm
3943 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3944 attempt to move loads which are only killed by stores into themselves.  This
3945 allows a loop containing a load/store sequence to be changed to a load outside
3946 the loop, and a copy/store within the loop.
3947
3948 Enabled by default when gcse is enabled.
3949
3950 @item -fgcse-sm
3951 @opindex fgcse-sm
3952 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3953 global common subexpression elimination.  This pass will attempt to move
3954 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3955 loops containing a load/store sequence can be changed to a load before
3956 the loop and a store after the loop.
3957
3958 Enabled by default when gcse is enabled.
3959
3960 @item -fgcse-las
3961 @opindex fgcse-las
3962 When @option{-fgcse-las} is enabled, the global common subexpression
3963 elimination pass eliminates redundant loads that come after stores to the
3964 same memory location (both partial and full redundancies).
3965
3966 Enabled by default when gcse is enabled.
3967
3968 @item -floop-optimize
3969 @opindex floop-optimize
3970 Perform loop optimizations: move constant expressions out of loops, simplify
3971 exit test conditions and optionally do strength-reduction and loop unrolling as
3972 well.
3973
3974 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3975
3976 @item -fcrossjumping
3977 @opindex crossjumping
3978 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3979 resulting code may or may not perform better than without cross-jumping.
3980
3981 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3982
3983 @item -fif-conversion
3984 @opindex if-conversion
3985 Attempt to transform conditional jumps into branch-less equivalents.  This
3986 include use of conditional moves, min, max, set flags and abs instructions, and
3987 some tricks doable by standard arithmetics.  The use of conditional execution
3988 on chips where it is available is controlled by @code{if-conversion2}.
3989
3990 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3991
3992 @item -fif-conversion2
3993 @opindex if-conversion2
3994 Use conditional execution (where available) to transform conditional jumps into
3995 branch-less equivalents.
3996
3997 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3998
3999 @item -fdelete-null-pointer-checks
4000 @opindex fdelete-null-pointer-checks
4001 Use global dataflow analysis to identify and eliminate useless checks
4002 for null pointers.  The compiler assumes that dereferencing a null
4003 pointer would have halted the program.  If a pointer is checked after
4004 it has already been dereferenced, it cannot be null.
4005
4006 In some environments, this assumption is not true, and programs can
4007 safely dereference null pointers.  Use
4008 @option{-fno-delete-null-pointer-checks} to disable this optimization
4009 for programs which depend on that behavior.
4010
4011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4012
4013 @item -fexpensive-optimizations
4014 @opindex fexpensive-optimizations
4015 Perform a number of minor optimizations that are relatively expensive.
4016
4017 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4018
4019 @item -foptimize-register-move
4020 @itemx -fregmove
4021 @opindex foptimize-register-move
4022 @opindex fregmove
4023 Attempt to reassign register numbers in move instructions and as
4024 operands of other simple instructions in order to maximize the amount of
4025 register tying.  This is especially helpful on machines with two-operand
4026 instructions.
4027
4028 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4029 optimization.
4030
4031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4032
4033 @item -fdelayed-branch
4034 @opindex fdelayed-branch
4035 If supported for the target machine, attempt to reorder instructions
4036 to exploit instruction slots available after delayed branch
4037 instructions.
4038
4039 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4040
4041 @item -fschedule-insns
4042 @opindex fschedule-insns
4043 If supported for the target machine, attempt to reorder instructions to
4044 eliminate execution stalls due to required data being unavailable.  This
4045 helps machines that have slow floating point or memory load instructions
4046 by allowing other instructions to be issued until the result of the load
4047 or floating point instruction is required.
4048
4049 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4050
4051 @item -fschedule-insns2
4052 @opindex fschedule-insns2
4053 Similar to @option{-fschedule-insns}, but requests an additional pass of
4054 instruction scheduling after register allocation has been done.  This is
4055 especially useful on machines with a relatively small number of
4056 registers and where memory load instructions take more than one cycle.
4057
4058 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4059
4060 @item -fno-sched-interblock
4061 @opindex fno-sched-interblock
4062 Don't schedule instructions across basic blocks.  This is normally
4063 enabled by default when scheduling before register allocation, i.e.@:
4064 with @option{-fschedule-insns} or at @option{-O2} or higher.
4065
4066 @item -fno-sched-spec
4067 @opindex fno-sched-spec
4068 Don't allow speculative motion of non-load instructions.  This is normally
4069 enabled by default when scheduling before register allocation, i.e.@:
4070 with @option{-fschedule-insns} or at @option{-O2} or higher.
4071
4072 @item -fsched-spec-load
4073 @opindex fsched-spec-load
4074 Allow speculative motion of some load instructions.  This only makes
4075 sense when scheduling before register allocation, i.e.@: with
4076 @option{-fschedule-insns} or at @option{-O2} or higher.
4077
4078 @item -fsched-spec-load-dangerous
4079 @opindex fsched-spec-load-dangerous
4080 Allow speculative motion of more load instructions.  This only makes
4081 sense when scheduling before register allocation, i.e.@: with
4082 @option{-fschedule-insns} or at @option{-O2} or higher.
4083
4084 @item -fsched-stalled-insns=@var{n}
4085 @opindex fsched-stalled-insns
4086 Define how many insns (if any) can be moved prematurely from the queue
4087 of stalled insns into the ready list, during the second scheduling pass.
4088
4089 @item -fsched-stalled-insns-dep=@var{n}
4090 @opindex fsched-stalled-insns-dep
4091 Define how many insn groups (cycles) will be examined for a dependency
4092 on a stalled insn that is candidate for premature removal from the queue
4093 of stalled insns.  Has an effect only during the second scheduling pass,
4094 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4095
4096 @item -fsched2-use-superblocks
4097 @opindex fsched2-use-superblocks
4098 When scheduling after register allocation, do use superblock scheduling
4099 algorithm.  Superblock scheduling allows motion across basic block boundaries
4100 resulting on faster schedules.  This option is experimental, as not all machine
4101 descriptions used by GCC model the CPU closely enough to avoid unreliable
4102 results from the algorithm.
4103
4104 This only makes sense when scheduling after register allocation, i.e.@: with
4105 @option{-fschedule-insns2} or at @option{-O2} or higher.
4106
4107 @item -fsched2-use-traces
4108 @opindex fsched2-use-traces
4109 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4110 allocation and additionally perform code duplication in order to increase the
4111 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4112 trace formation.
4113
4114 This mode should produce faster but significantly longer programs.  Also
4115 without @code{-fbranch-probabilities} the traces constructed may not match the
4116 reality and hurt the performance.  This only makes
4117 sense when scheduling after register allocation, i.e.@: with
4118 @option{-fschedule-insns2} or at @option{-O2} or higher.
4119
4120 @item -fcaller-saves
4121 @opindex fcaller-saves
4122 Enable values to be allocated in registers that will be clobbered by
4123 function calls, by emitting extra instructions to save and restore the
4124 registers around such calls.  Such allocation is done only when it
4125 seems to result in better code than would otherwise be produced.
4126
4127 This option is always enabled by default on certain machines, usually
4128 those which have no call-preserved registers to use instead.
4129
4130 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4131
4132 @item -fmove-all-movables
4133 @opindex fmove-all-movables
4134 Forces all invariant computations in loops to be moved
4135 outside the loop.
4136
4137 @item -freduce-all-givs
4138 @opindex freduce-all-givs
4139 Forces all general-induction variables in loops to be
4140 strength-reduced.
4141
4142 @emph{Note:} When compiling programs written in Fortran,
4143 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4144 by default when you use the optimizer.
4145
4146 These options may generate better or worse code; results are highly
4147 dependent on the structure of loops within the source code.
4148
4149 These two options are intended to be removed someday, once
4150 they have helped determine the efficacy of various
4151 approaches to improving loop optimizations.
4152
4153 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4154 know how use of these options affects
4155 the performance of your production code.
4156 We're very interested in code that runs @emph{slower}
4157 when these options are @emph{enabled}.
4158
4159 @item -fno-peephole
4160 @itemx -fno-peephole2
4161 @opindex fno-peephole
4162 @opindex fno-peephole2
4163 Disable any machine-specific peephole optimizations.  The difference
4164 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4165 are implemented in the compiler; some targets use one, some use the
4166 other, a few use both.
4167
4168 @option{-fpeephole} is enabled by default.
4169 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4170
4171 @item -fno-guess-branch-probability
4172 @opindex fno-guess-branch-probability
4173 Do not guess branch probabilities using a randomized model.
4174
4175 Sometimes gcc will opt to use a randomized model to guess branch
4176 probabilities, when none are available from either profiling feedback
4177 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4178 different runs of the compiler on the same program may produce different
4179 object code.
4180
4181 In a hard real-time system, people don't want different runs of the
4182 compiler to produce code that has different behavior; minimizing
4183 non-determinism is of paramount import.  This switch allows users to
4184 reduce non-determinism, possibly at the expense of inferior
4185 optimization.
4186
4187 The default is @option{-fguess-branch-probability} at levels
4188 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4189
4190 @item -freorder-blocks
4191 @opindex freorder-blocks
4192 Reorder basic blocks in the compiled function in order to reduce number of
4193 taken branches and improve code locality.
4194
4195 Enabled at levels @option{-O2}, @option{-O3}.
4196
4197 @item -freorder-functions
4198 @opindex freorder-functions
4199 Reorder basic blocks in the compiled function in order to reduce number of
4200 taken branches and improve code locality. This is implemented by using special
4201 subsections @code{text.hot} for most frequently executed functions and
4202 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4203 the linker so object file format must support named sections and linker must
4204 place them in a reasonable way.
4205
4206 Also profile feedback must be available in to make this option effective.  See
4207 @option{-fprofile-arcs} for details.
4208
4209 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4210
4211 @item -fstrict-aliasing
4212 @opindex fstrict-aliasing
4213 Allows the compiler to assume the strictest aliasing rules applicable to
4214 the language being compiled.  For C (and C++), this activates
4215 optimizations based on the type of expressions.  In particular, an
4216 object of one type is assumed never to reside at the same address as an
4217 object of a different type, unless the types are almost the same.  For
4218 example, an @code{unsigned int} can alias an @code{int}, but not a
4219 @code{void*} or a @code{double}.  A character type may alias any other
4220 type.
4221
4222 Pay special attention to code like this:
4223 @smallexample
4224 union a_union @{
4225   int i;
4226   double d;
4227 @};
4228
4229 int f() @{
4230   a_union t;
4231   t.d = 3.0;
4232   return t.i;
4233 @}
4234 @end smallexample
4235 The practice of reading from a different union member than the one most
4236 recently written to (called ``type-punning'') is common.  Even with
4237 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4238 is accessed through the union type.  So, the code above will work as
4239 expected.  However, this code might not:
4240 @smallexample
4241 int f() @{
4242   a_union t;
4243   int* ip;
4244   t.d = 3.0;
4245   ip = &t.i;
4246   return *ip;
4247 @}
4248 @end smallexample
4249
4250 Every language that wishes to perform language-specific alias analysis
4251 should define a function that computes, given an @code{tree}
4252 node, an alias set for the node.  Nodes in different alias sets are not
4253 allowed to alias.  For an example, see the C front-end function
4254 @code{c_get_alias_set}.
4255
4256 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4257
4258 @item -falign-functions
4259 @itemx -falign-functions=@var{n}
4260 @opindex falign-functions
4261 Align the start of functions to the next power-of-two greater than
4262 @var{n}, skipping up to @var{n} bytes.  For instance,
4263 @option{-falign-functions=32} aligns functions to the next 32-byte
4264 boundary, but @option{-falign-functions=24} would align to the next
4265 32-byte boundary only if this can be done by skipping 23 bytes or less.
4266
4267 @option{-fno-align-functions} and @option{-falign-functions=1} are
4268 equivalent and mean that functions will not be aligned.
4269
4270 Some assemblers only support this flag when @var{n} is a power of two;
4271 in that case, it is rounded up.
4272
4273 If @var{n} is not specified or is zero, use a machine-dependent default.
4274
4275 Enabled at levels @option{-O2}, @option{-O3}.
4276
4277 @item -falign-labels
4278 @itemx -falign-labels=@var{n}
4279 @opindex falign-labels
4280 Align all branch targets to a power-of-two boundary, skipping up to
4281 @var{n} bytes like @option{-falign-functions}.  This option can easily
4282 make code slower, because it must insert dummy operations for when the
4283 branch target is reached in the usual flow of the code.
4284
4285 @option{-fno-align-labels} and @option{-falign-labels=1} are
4286 equivalent and mean that labels will not be aligned.
4287
4288 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4289 are greater than this value, then their values are used instead.
4290
4291 If @var{n} is not specified or is zero, use a machine-dependent default
4292 which is very likely to be @samp{1}, meaning no alignment.
4293
4294 Enabled at levels @option{-O2}, @option{-O3}.
4295
4296 @item -falign-loops
4297 @itemx -falign-loops=@var{n}
4298 @opindex falign-loops
4299 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4300 like @option{-falign-functions}.  The hope is that the loop will be
4301 executed many times, which will make up for any execution of the dummy
4302 operations.
4303
4304 @option{-fno-align-loops} and @option{-falign-loops=1} are
4305 equivalent and mean that loops will not be aligned.
4306
4307 If @var{n} is not specified or is zero, use a machine-dependent default.
4308
4309 Enabled at levels @option{-O2}, @option{-O3}.
4310
4311 @item -falign-jumps
4312 @itemx -falign-jumps=@var{n}
4313 @opindex falign-jumps
4314 Align branch targets to a power-of-two boundary, for branch targets
4315 where the targets can only be reached by jumping, skipping up to @var{n}
4316 bytes like @option{-falign-functions}.  In this case, no dummy operations
4317 need be executed.
4318
4319 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4320 equivalent and mean that loops will not be aligned.
4321
4322 If @var{n} is not specified or is zero, use a machine-dependent default.
4323
4324 Enabled at levels @option{-O2}, @option{-O3}.
4325
4326 @item -frename-registers
4327 @opindex frename-registers
4328 Attempt to avoid false dependencies in scheduled code by making use
4329 of registers left over after register allocation.  This optimization
4330 will most benefit processors with lots of registers.  It can, however,
4331 make debugging impossible, since variables will no longer stay in
4332 a ``home register''.
4333
4334 @item -fweb
4335 @opindex fweb
4336 Constructs webs as commonly used for register allocation purposes and assign
4337 each web individual pseudo register.  This allows our register allocation pass
4338 to operate on pseudos directly, but also strengthens several other optimization
4339 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4340 however, make debugging impossible, since variables will no longer stay in a
4341 ``home register''.
4342
4343 Enabled at levels @option{-O3}.
4344
4345 @item -fno-cprop-registers
4346 @opindex fno-cprop-registers
4347 After register allocation and post-register allocation instruction splitting,
4348 we perform a copy-propagation pass to try to reduce scheduling dependencies
4349 and occasionally eliminate the copy.
4350
4351 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4352
4353 @item -fprofile-generate
4354 @opindex fprofile-generate
4355 Enable options usually used for instrumenting application to produce profile usefull
4356 for later recompilation profile feedback based optimization.
4357
4358 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}
4359
4360 @item -fprofile-use
4361 @opindex fprofile-use
4362 Enable profile feedback directed optimizations, and optimizations
4363 generally profitable only with profile feedback available.
4364
4365 The following options are enabled: @code{-fbranch-probabilities},
4366 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4367
4368 @end table
4369
4370 The following options control compiler behavior regarding floating
4371 point arithmetic.  These options trade off between speed and
4372 correctness.  All must be specifically enabled.
4373
4374 @table @gcctabopt
4375 @item -ffloat-store
4376 @opindex ffloat-store
4377 Do not store floating point variables in registers, and inhibit other
4378 options that might change whether a floating point value is taken from a
4379 register or memory.
4380
4381 @cindex floating point precision
4382 This option prevents undesirable excess precision on machines such as
4383 the 68000 where the floating registers (of the 68881) keep more
4384 precision than a @code{double} is supposed to have.  Similarly for the
4385 x86 architecture.  For most programs, the excess precision does only
4386 good, but a few programs rely on the precise definition of IEEE floating
4387 point.  Use @option{-ffloat-store} for such programs, after modifying
4388 them to store all pertinent intermediate computations into variables.
4389
4390 @item -ffast-math
4391 @opindex ffast-math
4392 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4393 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4394 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4395
4396 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4397
4398 This option should never be turned on by any @option{-O} option since
4399 it can result in incorrect output for programs which depend on
4400 an exact implementation of IEEE or ISO rules/specifications for
4401 math functions.
4402
4403 @item -fno-math-errno
4404 @opindex fno-math-errno
4405 Do not set ERRNO after calling math functions that are executed
4406 with a single instruction, e.g., sqrt.  A program that relies on
4407 IEEE exceptions for math error handling may want to use this flag
4408 for speed while maintaining IEEE arithmetic compatibility.
4409
4410 This option should never be turned on by any @option{-O} option since
4411 it can result in incorrect output for programs which depend on
4412 an exact implementation of IEEE or ISO rules/specifications for
4413 math functions.
4414
4415 The default is @option{-fmath-errno}.
4416
4417 @item -funsafe-math-optimizations
4418 @opindex funsafe-math-optimizations
4419 Allow optimizations for floating-point arithmetic that (a) assume
4420 that arguments and results are valid and (b) may violate IEEE or
4421 ANSI standards.  When used at link-time, it may include libraries
4422 or startup files that change the default FPU control word or other
4423 similar optimizations.
4424
4425 This option should never be turned on by any @option{-O} option since
4426 it can result in incorrect output for programs which depend on
4427 an exact implementation of IEEE or ISO rules/specifications for
4428 math functions.
4429
4430 The default is @option{-fno-unsafe-math-optimizations}.
4431
4432 @item -ffinite-math-only
4433 @opindex ffinite-math-only
4434 Allow optimizations for floating-point arithmetic that assume
4435 that arguments and results are not NaNs or +-Infs.
4436
4437 This option should never be turned on by any @option{-O} option since
4438 it can result in incorrect output for programs which depend on
4439 an exact implementation of IEEE or ISO rules/specifications.
4440
4441 The default is @option{-fno-finite-math-only}.
4442
4443 @item -fno-trapping-math
4444 @opindex fno-trapping-math
4445 Compile code assuming that floating-point operations cannot generate
4446 user-visible traps.  These traps include division by zero, overflow,
4447 underflow, inexact result and invalid operation.  This option implies
4448 @option{-fno-signaling-nans}.  Setting this option may allow faster
4449 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4450
4451 This option should never be turned on by any @option{-O} option since
4452 it can result in incorrect output for programs which depend on
4453 an exact implementation of IEEE or ISO rules/specifications for
4454 math functions.
4455
4456 The default is @option{-ftrapping-math}.
4457
4458 @item -frounding-math
4459 @opindex frounding-math
4460 Disable transformations and optimizations that assume default floating
4461 point rounding behavior.  This is round-to-zero for all floating point
4462 to integer conversions, and round-to-nearest for all other arithmetic
4463 truncations.  This option should be specified for programs that change
4464 the FP rounding mode dynamically, or that may be executed with a
4465 non-default rounding mode.  This option disables constant folding of
4466 floating point expressions at compile-time (which may be affected by
4467 rounding mode) and arithmetic transformations that are unsafe in the
4468 presence of sign-dependent rounding modes.
4469
4470 The default is @option{-fno-rounding-math}.
4471
4472 This option is experimental and does not currently guarantee to
4473 disable all GCC optimizations that are affected by rounding mode.
4474 Future versions of gcc may provide finer control of this setting
4475 using C99's @code{FENV_ACCESS} pragma.  This command line option
4476 will be used to specify the default state for @code{FENV_ACCESS}.
4477
4478 @item -fsignaling-nans
4479 @opindex fsignaling-nans
4480 Compile code assuming that IEEE signaling NaNs may generate user-visible
4481 traps during floating-point operations.  Setting this option disables
4482 optimizations that may change the number of exceptions visible with
4483 signaling NaNs.  This option implies @option{-ftrapping-math}.
4484
4485 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4486 be defined.
4487
4488 The default is @option{-fno-signaling-nans}.
4489
4490 This option is experimental and does not currently guarantee to
4491 disable all GCC optimizations that affect signaling NaN behavior.
4492
4493 @item -fsingle-precision-constant
4494 @opindex fsingle-precision-constant
4495 Treat floating point constant as single precision constant instead of
4496 implicitly converting it to double precision constant.
4497
4498
4499 @end table
4500
4501 The following options control optimizations that may improve
4502 performance, but are not enabled by any @option{-O} options.  This
4503 section includes experimental options that may produce broken code.
4504
4505 @table @gcctabopt
4506 @item -fbranch-probabilities
4507 @opindex fbranch-probabilities
4508 After running a program compiled with @option{-fprofile-arcs}
4509 (@pxref{Debugging Options,, Options for Debugging Your Program or
4510 @command{gcc}}), you can compile it a second time using
4511 @option{-fbranch-probabilities}, to improve optimizations based on
4512 the number of times each branch was taken.  When the program
4513 compiled with @option{-fprofile-arcs} exits it saves arc execution
4514 counts to a file called @file{@var{sourcename}.gcda} for each source
4515 file  The information in this data file is very dependent on the
4516 structure of the generated code, so you must use the same source code
4517 and the same optimization options for both compilations.
4518
4519 With @option{-fbranch-probabilities}, GCC puts a
4520 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4521 These can be used to improve optimization.  Currently, they are only
4522 used in one place: in @file{reorg.c}, instead of guessing which path a
4523 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4524 exactly determine which path is taken more often.
4525
4526 @item -fprofile-values
4527 @opindex fprofile-values
4528 If combined with @option{-fprofile-arcs}, it adds code so that some
4529 data about values of expressions in the program is gathered.
4530
4531 With @option{-fbranch-probabilities}, it reads back the data gathered
4532 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4533 notes to instructions for their later usage in optimizations.
4534
4535 @item -fvpt
4536 @opindex fvpt
4537 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4538 a code to gather information about values of expressions.
4539
4540 With @option{-fbranch-probabilities}, it reads back the data gathered
4541 and actually performs the optimizations based on them.
4542 Currently the optimizations include specialization of division operation
4543 using the knowledge about the value of the denominator.
4544
4545 @item -fnew-ra
4546 @opindex fnew-ra
4547 Use a graph coloring register allocator.  Currently this option is meant
4548 for testing, so we are interested to hear about miscompilations with
4549 @option{-fnew-ra}.
4550
4551 @item -ftracer
4552 @opindex ftracer
4553 Perform tail duplication to enlarge superblock size. This transformation
4554 simplifies the control flow of the function allowing other optimizations to do
4555 better job.
4556
4557 @item -funit-at-a-time
4558 @opindex funit-at-a-time
4559 Parse the whole compilation unit before starting to produce code.
4560 This allows some extra optimizations to take place but consumes more
4561 memory.
4562
4563 @item -funroll-loops
4564 @opindex funroll-loops
4565 Unroll loops whose number of iterations can be determined at compile time or
4566 upon entry to the loop.  @option{-funroll-loops} implies
4567 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4568 (i.e. complete removal of loops with small constant number of iterations).
4569 This option makes code larger, and may or may not make it run faster.
4570
4571 @item -funroll-all-loops
4572 @opindex funroll-all-loops
4573 Unroll all loops, even if their number of iterations is uncertain when
4574 the loop is entered.  This usually makes programs run more slowly.
4575 @option{-funroll-all-loops} implies the same options as
4576 @option{-funroll-loops}.
4577
4578 @item -fpeel-loops
4579 @opindex fpeel-loops
4580 Peels the loops for that there is enough information that they do not
4581 roll much (from profile feedback).  It also turns on complete loop peeling
4582 (i.e. complete removal of loops with small constant number of iterations).
4583
4584 @item -funswitch-loops
4585 @opindex funswitch-loops
4586 Move branches with loop invariant conditions out of the loop, with duplicates
4587 of the loop on both branches (modified according to result of the condition).
4588
4589 @item -fold-unroll-loops
4590 @opindex fold-unroll-loops
4591 Unroll loops whose number of iterations can be determined at compile
4592 time or upon entry to the loop, using the old loop unroller whose loop
4593 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4594 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4595 option makes code larger, and may or may not make it run faster.
4596
4597 @item -fold-unroll-all-loops
4598 @opindex fold-unroll-all-loops
4599 Unroll all loops, even if their number of iterations is uncertain when
4600 the loop is entered. This is done using the old loop unroller whose loop
4601 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4602 @option{-fold-unroll-all-loops} implies the same options as
4603 @option{-fold-unroll-loops}.
4604
4605 @item -funswitch-loops
4606 @opindex funswitch-loops
4607 Move branches with loop invariant conditions out of the loop, with duplicates
4608 of the loop on both branches (modified according to result of the condition).
4609
4610 @item -funswitch-loops
4611 @opindex funswitch-loops
4612 Move branches with loop invariant conditions out of the loop, with duplicates
4613 of the loop on both branches (modified according to result of the condition).
4614
4615 @item -fprefetch-loop-arrays
4616 @opindex fprefetch-loop-arrays
4617 If supported by the target machine, generate instructions to prefetch
4618 memory to improve the performance of loops that access large arrays.
4619
4620 Disabled at level @option{-Os}.
4621
4622 @item -ffunction-sections
4623 @itemx -fdata-sections
4624 @opindex ffunction-sections
4625 @opindex fdata-sections
4626 Place each function or data item into its own section in the output
4627 file if the target supports arbitrary sections.  The name of the
4628 function or the name of the data item determines the section's name
4629 in the output file.
4630
4631 Use these options on systems where the linker can perform optimizations
4632 to improve locality of reference in the instruction space.  Most systems
4633 using the ELF object format and SPARC processors running Solaris 2 have
4634 linkers with such optimizations.  AIX may have these optimizations in
4635 the future.
4636
4637 Only use these options when there are significant benefits from doing
4638 so.  When you specify these options, the assembler and linker will
4639 create larger object and executable files and will also be slower.
4640 You will not be able to use @code{gprof} on all systems if you
4641 specify this option and you may have problems with debugging if
4642 you specify both this option and @option{-g}.
4643
4644 @item -fbranch-target-load-optimize
4645 @opindex fbranch-target-load-optimize
4646 Perform branch target register load optimization before prologue / epilogue
4647 threading.
4648 The use of target registers can typically be exposed only during reload,
4649 thus hoisting loads out of loops and doing inter-block scheduling needs
4650 a separate optimization pass.
4651
4652 @item -fbranch-target-load-optimize2
4653 @opindex fbranch-target-load-optimize2
4654 Perform branch target register load optimization after prologue / epilogue
4655 threading.
4656
4657 @item -fbtr-bb-exclusive
4658 @opindex fbtr-bb-exclusive
4659 WHen performing branch target register load optimization, don't reuse
4660 branch target registers in within any basic block.
4661
4662 @item --param @var{name}=@var{value}
4663 @opindex param
4664 In some places, GCC uses various constants to control the amount of
4665 optimization that is done.  For example, GCC will not inline functions
4666 that contain more that a certain number of instructions.  You can
4667 control some of these constants on the command-line using the
4668 @option{--param} option.
4669
4670 The names of specific parameters, and the meaning of the values, are
4671 tied to the internals of the compiler, and are subject to change
4672 without notice in future releases.
4673
4674 In each case, the @var{value} is an integer.  The allowable choices for
4675 @var{name} are given in the following table:
4676
4677 @table @gcctabopt
4678 @item max-crossjump-edges
4679 The maximum number of incoming edges to consider for crossjumping.
4680 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4681 the number of edges incoming to each block.  Increasing values mean
4682 more aggressive optimization, making the compile time increase with
4683 probably small improvement in executable size.
4684
4685 @item max-delay-slot-insn-search
4686 The maximum number of instructions to consider when looking for an
4687 instruction to fill a delay slot.  If more than this arbitrary number of
4688 instructions is searched, the time savings from filling the delay slot
4689 will be minimal so stop searching.  Increasing values mean more
4690 aggressive optimization, making the compile time increase with probably
4691 small improvement in executable run time.
4692
4693 @item max-delay-slot-live-search
4694 When trying to fill delay slots, the maximum number of instructions to
4695 consider when searching for a block with valid live register
4696 information.  Increasing this arbitrarily chosen value means more
4697 aggressive optimization, increasing the compile time.  This parameter
4698 should be removed when the delay slot code is rewritten to maintain the
4699 control-flow graph.
4700
4701 @item max-gcse-memory
4702 The approximate maximum amount of memory that will be allocated in
4703 order to perform the global common subexpression elimination
4704 optimization.  If more memory than specified is required, the
4705 optimization will not be done.
4706
4707 @item max-gcse-passes
4708 The maximum number of passes of GCSE to run.
4709
4710 @item max-pending-list-length
4711 The maximum number of pending dependencies scheduling will allow
4712 before flushing the current state and starting over.  Large functions
4713 with few branches or calls can create excessively large lists which
4714 needlessly consume memory and resources.
4715
4716 @item max-inline-insns-single
4717 Several parameters control the tree inliner used in gcc.
4718 This number sets the maximum number of instructions (counted in gcc's
4719 internal representation) in a single function that the tree inliner
4720 will consider for inlining.  This only affects functions declared
4721 inline and methods implemented in a class declaration (C++).
4722 The default value is 500.
4723
4724 @item max-inline-insns-auto
4725 When you use @option{-finline-functions} (included in @option{-O3}),
4726 a lot of functions that would otherwise not be considered for inlining
4727 by the compiler will be investigated.  To those functions, a different
4728 (more restrictive) limit compared to functions declared inline can
4729 be applied.
4730 The default value is 120.
4731
4732 @item large-function-insns
4733 The limit specifying really large functions.  For functions greater than this
4734 limit inlining is constrained by @option{--param large-function-growth}.
4735 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4736 algorithms used by the backend.
4737 This parameter is ignored when @option{-funit-at-a-time} is not used.
4738 The default value is 3000.
4739
4740 @item large-function-growth
4741 Specifies maximal growth of large function caused by inlining in percents.
4742 This parameter is ignored when @option{-funit-at-a-time} is not used.
4743 The default value is 200.
4744
4745 @item inline-unit-growth
4746 Specifies maximal overall growth of the compilation unit caused by inlining.
4747 This parameter is ignored when @option{-funit-at-a-time} is not used.
4748 The default value is 150.
4749
4750 @item max-inline-insns-rtl
4751 For languages that use the RTL inliner (this happens at a later stage
4752 than tree inlining), you can set the maximum allowable size (counted
4753 in RTL instructions) for the RTL inliner with this parameter.
4754 The default value is 600.
4755
4756 @item max-unrolled-insns
4757 The maximum number of instructions that a loop should have if that loop
4758 is unrolled, and if the loop is unrolled, it determines how many times
4759 the loop code is unrolled.
4760
4761 @item max-average-unrolled-insns
4762 The maximum number of instructions biased by probabilities of their execution
4763 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4764 it determines how many times the loop code is unrolled.
4765
4766 @item max-unroll-times
4767 The maximum number of unrollings of a single loop.
4768
4769 @item max-peeled-insns
4770 The maximum number of instructions that a loop should have if that loop
4771 is peeled, and if the loop is peeled, it determines how many times
4772 the loop code is peeled.
4773
4774 @item max-peel-times
4775 The maximum number of peelings of a single loop.
4776
4777 @item max-completely-peeled-insns
4778 The maximum number of insns of a completely peeled loop.
4779
4780 @item max-completely-peel-times
4781 The maximum number of iterations of a loop to be suitable for complete peeling.
4782
4783 @item max-unswitch-insns
4784 The maximum number of insns of an unswitched loop.
4785
4786 @item max-unswitch-level
4787 The maximum number of branches unswitched in a single loop.
4788
4789 @item hot-bb-count-fraction
4790 Select fraction of the maximal count of repetitions of basic block in program
4791 given basic block needs to have to be considered hot.
4792
4793 @item hot-bb-frequency-fraction
4794 Select fraction of the maximal frequency of executions of basic block in
4795 function given basic block needs to have to be considered hot
4796
4797 @item tracer-dynamic-coverage
4798 @itemx tracer-dynamic-coverage-feedback
4799
4800 This value is used to limit superblock formation once the given percentage of
4801 executed instructions is covered.  This limits unnecessary code size
4802 expansion.
4803
4804 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4805 feedback is available.  The real profiles (as opposed to statically estimated
4806 ones) are much less balanced allowing the threshold to be larger value.
4807
4808 @item tracer-max-code-growth
4809 Stop tail duplication once code growth has reached given percentage.  This is
4810 rather hokey argument, as most of the duplicates will be eliminated later in
4811 cross jumping, so it may be set to much higher values than is the desired code
4812 growth.
4813
4814 @item tracer-min-branch-ratio
4815
4816 Stop reverse growth when the reverse probability of best edge is less than this
4817 threshold (in percent).
4818
4819 @item tracer-min-branch-ratio
4820 @itemx tracer-min-branch-ratio-feedback
4821
4822 Stop forward growth if the best edge do have probability lower than this
4823 threshold.
4824
4825 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4826 compilation for profile feedback and one for compilation without.  The value
4827 for compilation with profile feedback needs to be more conservative (higher) in
4828 order to make tracer effective.
4829
4830 @item max-cse-path-length
4831
4832 Maximum number of basic blocks on path that cse considers.
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 GNU linker that
5117 does not support option @option{--eh-frame-hdr}, it will link the shared
5118 version of @file{libgcc} into shared libraries by default.  Otherwise,
5119 it will take advantage of the linker and optimize away the linking with
5120 the shared version of @file{libgcc}, linking with the static version of
5121 libgcc by default.  This allows exceptions to propagate through such
5122 shared libraries, without incurring relocation costs at library load
5123 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.
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.
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: the program must be linked
6403 in the low 32 bits of the address space.  Pointers are 64 bits.
6404 Programs can be statically or dynamically linked.
6405
6406 @item -mcmodel=medmid
6407 @opindex mcmodel=medmid
6408 Generate code for the Medium/Middle code model: the program must be linked
6409 in the low 44 bits of the address space, the text segment must be less than
6410 2G bytes, and data segment must be within 2G of the text segment.
6411 Pointers are 64 bits.
6412
6413 @item -mcmodel=medany
6414 @opindex mcmodel=medany
6415 Generate code for the Medium/Anywhere code model: the program may be linked
6416 anywhere in the address space, the text segment must be less than
6417 2G bytes, and data segment must be within 2G of the text segment.
6418 Pointers are 64 bits.
6419
6420 @item -mcmodel=embmedany
6421 @opindex mcmodel=embmedany
6422 Generate code for the Medium/Anywhere code model for embedded systems:
6423 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6424 (determined at link time).  Register %g4 points to the base of the
6425 data segment.  Pointers are still 64 bits.
6426 Programs are statically linked, 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 @node ARM Options
6439 @subsection ARM Options
6440 @cindex ARM options
6441
6442 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6443 architectures:
6444
6445 @table @gcctabopt
6446 @item -mapcs-frame
6447 @opindex mapcs-frame
6448 Generate a stack frame that is compliant with the ARM Procedure Call
6449 Standard for all functions, even if this is not strictly necessary for
6450 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6451 with this option will cause the stack frames not to be generated for
6452 leaf functions.  The default is @option{-mno-apcs-frame}.
6453
6454 @item -mapcs
6455 @opindex mapcs
6456 This is a synonym for @option{-mapcs-frame}.
6457
6458 @item -mapcs-26
6459 @opindex mapcs-26
6460 Generate code for a processor running with a 26-bit program counter,
6461 and conforming to the function calling standards for the APCS 26-bit
6462 option.  This option replaces the @option{-m2} and @option{-m3} options
6463 of previous releases of the compiler.
6464
6465 @item -mapcs-32
6466 @opindex mapcs-32
6467 Generate code for a processor running with a 32-bit program counter,
6468 and conforming to the function calling standards for the APCS 32-bit
6469 option.  This option replaces the @option{-m6} option of previous releases
6470 of the compiler.
6471
6472 @ignore
6473 @c not currently implemented
6474 @item -mapcs-stack-check
6475 @opindex mapcs-stack-check
6476 Generate code to check the amount of stack space available upon entry to
6477 every function (that actually uses some stack space).  If there is
6478 insufficient space available then either the function
6479 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6480 called, depending upon the amount of stack space required.  The run time
6481 system is required to provide these functions.  The default is
6482 @option{-mno-apcs-stack-check}, since this produces smaller code.
6483
6484 @c not currently implemented
6485 @item -mapcs-float
6486 @opindex mapcs-float
6487 Pass floating point arguments using the float point registers.  This is
6488 one of the variants of the APCS@.  This option is recommended if the
6489 target hardware has a floating point unit or if a lot of floating point
6490 arithmetic is going to be performed by the code.  The default is
6491 @option{-mno-apcs-float}, since integer only code is slightly increased in
6492 size if @option{-mapcs-float} is used.
6493
6494 @c not currently implemented
6495 @item -mapcs-reentrant
6496 @opindex mapcs-reentrant
6497 Generate reentrant, position independent code.  The default is
6498 @option{-mno-apcs-reentrant}.
6499 @end ignore
6500
6501 @item -mthumb-interwork
6502 @opindex mthumb-interwork
6503 Generate code which supports calling between the ARM and Thumb
6504 instruction sets.  Without this option the two instruction sets cannot
6505 be reliably used inside one program.  The default is
6506 @option{-mno-thumb-interwork}, since slightly larger code is generated
6507 when @option{-mthumb-interwork} is specified.
6508
6509 @item -mno-sched-prolog
6510 @opindex mno-sched-prolog
6511 Prevent the reordering of instructions in the function prolog, or the
6512 merging of those instruction with the instructions in the function's
6513 body.  This means that all functions will start with a recognizable set
6514 of instructions (or in fact one of a choice from a small set of
6515 different function prologues), and this information can be used to
6516 locate the start if functions inside an executable piece of code.  The
6517 default is @option{-msched-prolog}.
6518
6519 @item -mhard-float
6520 @opindex mhard-float
6521 Generate output containing floating point instructions.  This is the
6522 default.
6523
6524 @item -msoft-float
6525 @opindex msoft-float
6526 Generate output containing library calls for floating point.
6527 @strong{Warning:} the requisite libraries are not available for all ARM
6528 targets.  Normally the facilities of the machine's usual C compiler are
6529 used, but this cannot be done directly in cross-compilation.  You must make
6530 your own arrangements to provide suitable library functions for
6531 cross-compilation.
6532
6533 @option{-msoft-float} changes the calling convention in the output file;
6534 therefore, it is only useful if you compile @emph{all} of a program with
6535 this option.  In particular, you need to compile @file{libgcc.a}, the
6536 library that comes with GCC, with @option{-msoft-float} in order for
6537 this to work.
6538
6539 @item -mlittle-endian
6540 @opindex mlittle-endian
6541 Generate code for a processor running in little-endian mode.  This is
6542 the default for all standard configurations.
6543
6544 @item -mbig-endian
6545 @opindex mbig-endian
6546 Generate code for a processor running in big-endian mode; the default is
6547 to compile code for a little-endian processor.
6548
6549 @item -mwords-little-endian
6550 @opindex mwords-little-endian
6551 This option only applies when generating code for big-endian processors.
6552 Generate code for a little-endian word order but a big-endian byte
6553 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6554 option should only be used if you require compatibility with code for
6555 big-endian ARM processors generated by versions of the compiler prior to
6556 2.8.
6557
6558 @item -malignment-traps
6559 @opindex malignment-traps
6560 Generate code that will not trap if the MMU has alignment traps enabled.
6561 On ARM architectures prior to ARMv4, there were no instructions to
6562 access half-word objects stored in memory.  However, when reading from
6563 memory a feature of the ARM architecture allows a word load to be used,
6564 even if the address is unaligned, and the processor core will rotate the
6565 data as it is being loaded.  This option tells the compiler that such
6566 misaligned accesses will cause a MMU trap and that it should instead
6567 synthesize the access as a series of byte accesses.  The compiler can
6568 still use word accesses to load half-word data if it knows that the
6569 address is aligned to a word boundary.
6570
6571 This option is ignored when compiling for ARM architecture 4 or later,
6572 since these processors have instructions to directly access half-word
6573 objects in memory.
6574
6575 @item -mno-alignment-traps
6576 @opindex mno-alignment-traps
6577 Generate code that assumes that the MMU will not trap unaligned
6578 accesses.  This produces better code when the target instruction set
6579 does not have half-word memory operations (i.e.@: implementations prior to
6580 ARMv4).
6581
6582 Note that you cannot use this option to access unaligned word objects,
6583 since the processor will only fetch one 32-bit aligned object from
6584 memory.
6585
6586 The default setting for most targets is @option{-mno-alignment-traps}, since
6587 this produces better code when there are no half-word memory
6588 instructions available.
6589
6590 @item -mshort-load-bytes
6591 @itemx -mno-short-load-words
6592 @opindex mshort-load-bytes
6593 @opindex mno-short-load-words
6594 These are deprecated aliases for @option{-malignment-traps}.
6595
6596 @item -mno-short-load-bytes
6597 @itemx -mshort-load-words
6598 @opindex mno-short-load-bytes
6599 @opindex mshort-load-words
6600 This are deprecated aliases for @option{-mno-alignment-traps}.
6601
6602 @item -mcpu=@var{name}
6603 @opindex mcpu
6604 This specifies the name of the target ARM processor.  GCC uses this name
6605 to determine what kind of instructions it can emit when generating
6606 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6607 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6608 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6609 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6610 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6611 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6612 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6613 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6614 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6615 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6616 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6617 @samp{ep9312}.
6618
6619 @itemx -mtune=@var{name}
6620 @opindex mtune
6621 This option is very similar to the @option{-mcpu=} option, except that
6622 instead of specifying the actual target processor type, and hence
6623 restricting which instructions can be used, it specifies that GCC should
6624 tune the performance of the code as if the target were of the type
6625 specified in this option, but still choosing the instructions that it
6626 will generate based on the cpu specified by a @option{-mcpu=} option.
6627 For some ARM implementations better performance can be obtained by using
6628 this option.
6629
6630 @item -march=@var{name}
6631 @opindex march
6632 This specifies the name of the target ARM architecture.  GCC uses this
6633 name to determine what kind of instructions it can emit when generating
6634 assembly code.  This option can be used in conjunction with or instead
6635 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6636 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6637 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6638 @samp{iwmmxt}, @samp{ep9312}.
6639
6640 @item -mfpe=@var{number}
6641 @itemx -mfp=@var{number}
6642 @opindex mfpe
6643 @opindex mfp
6644 This specifies the version of the floating point emulation available on
6645 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6646 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6647
6648 @item -mstructure-size-boundary=@var{n}
6649 @opindex mstructure-size-boundary
6650 The size of all structures and unions will be rounded up to a multiple
6651 of the number of bits set by this option.  Permissible values are 8 and
6652 32.  The default value varies for different toolchains.  For the COFF
6653 targeted toolchain the default value is 8.  Specifying the larger number
6654 can produce faster, more efficient code, but can also increase the size
6655 of the program.  The two values are potentially incompatible.  Code
6656 compiled with one value cannot necessarily expect to work with code or
6657 libraries compiled with the other value, if they exchange information
6658 using structures or unions.
6659
6660 @item -mabort-on-noreturn
6661 @opindex mabort-on-noreturn
6662 Generate a call to the function @code{abort} at the end of a
6663 @code{noreturn} function.  It will be executed if the function tries to
6664 return.
6665
6666 @item -mlong-calls
6667 @itemx -mno-long-calls
6668 @opindex mlong-calls
6669 @opindex mno-long-calls
6670 Tells the compiler to perform function calls by first loading the
6671 address of the function into a register and then performing a subroutine
6672 call on this register.  This switch is needed if the target function
6673 will lie outside of the 64 megabyte addressing range of the offset based
6674 version of subroutine call instruction.
6675
6676 Even if this switch is enabled, not all function calls will be turned
6677 into long calls.  The heuristic is that static functions, functions
6678 which have the @samp{short-call} attribute, functions that are inside
6679 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6680 definitions have already been compiled within the current compilation
6681 unit, will not be turned into long calls.  The exception to this rule is
6682 that weak function definitions, functions with the @samp{long-call}
6683 attribute or the @samp{section} attribute, and functions that are within
6684 the scope of a @samp{#pragma long_calls} directive, will always be
6685 turned into long calls.
6686
6687 This feature is not enabled by default.  Specifying
6688 @option{-mno-long-calls} will restore the default behavior, as will
6689 placing the function calls within the scope of a @samp{#pragma
6690 long_calls_off} directive.  Note these switches have no effect on how
6691 the compiler generates code to handle function calls via function
6692 pointers.
6693
6694 @item -mnop-fun-dllimport
6695 @opindex mnop-fun-dllimport
6696 Disable support for the @code{dllimport} attribute.
6697
6698 @item -msingle-pic-base
6699 @opindex msingle-pic-base
6700 Treat the register used for PIC addressing as read-only, rather than
6701 loading it in the prologue for each function.  The run-time system is
6702 responsible for initializing this register with an appropriate value
6703 before execution begins.
6704
6705 @item -mpic-register=@var{reg}
6706 @opindex mpic-register
6707 Specify the register to be used for PIC addressing.  The default is R10
6708 unless stack-checking is enabled, when R9 is used.
6709
6710 @item -mcirrus-fix-invalid-insns
6711 @opindex mcirrus-fix-invalid-insns
6712 @opindex mno-cirrus-fix-invalid-insns
6713 Insert NOPs into the instruction stream to in order to work around
6714 problems with invalid Maverick instruction combinations.  This option
6715 is only valid if the @option{-mcpu=ep9312} option has been used to
6716 enable generation of instructions for the Cirrus Maverick floating
6717 point co-processor.  This option is not enabled by default, since the
6718 problem is only present in older Maverick implementations.  The default
6719 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6720 switch.
6721
6722 @item -mpoke-function-name
6723 @opindex mpoke-function-name
6724 Write the name of each function into the text section, directly
6725 preceding the function prologue.  The generated code is similar to this:
6726
6727 @smallexample
6728      t0
6729          .ascii "arm_poke_function_name", 0
6730          .align
6731      t1
6732          .word 0xff000000 + (t1 - t0)
6733      arm_poke_function_name
6734          mov     ip, sp
6735          stmfd   sp!, @{fp, ip, lr, pc@}
6736          sub     fp, ip, #4
6737 @end smallexample
6738
6739 When performing a stack backtrace, code can inspect the value of
6740 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6741 location @code{pc - 12} and the top 8 bits are set, then we know that
6742 there is a function name embedded immediately preceding this location
6743 and has length @code{((pc[-3]) & 0xff000000)}.
6744
6745 @item -mthumb
6746 @opindex mthumb
6747 Generate code for the 16-bit Thumb instruction set.  The default is to
6748 use the 32-bit ARM instruction set.
6749
6750 @item -mtpcs-frame
6751 @opindex mtpcs-frame
6752 Generate a stack frame that is compliant with the Thumb Procedure Call
6753 Standard for all non-leaf functions.  (A leaf function is one that does
6754 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6755
6756 @item -mtpcs-leaf-frame
6757 @opindex mtpcs-leaf-frame
6758 Generate a stack frame that is compliant with the Thumb Procedure Call
6759 Standard for all leaf functions.  (A leaf function is one that does
6760 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6761
6762 @item -mcallee-super-interworking
6763 @opindex mcallee-super-interworking
6764 Gives all externally visible functions in the file being compiled an ARM
6765 instruction set header which switches to Thumb mode before executing the
6766 rest of the function.  This allows these functions to be called from
6767 non-interworking code.
6768
6769 @item -mcaller-super-interworking
6770 @opindex mcaller-super-interworking
6771 Allows calls via function pointers (including virtual functions) to
6772 execute correctly regardless of whether the target code has been
6773 compiled for interworking or not.  There is a small overhead in the cost
6774 of executing a function pointer if this option is enabled.
6775
6776 @end table
6777
6778 @node MN10300 Options
6779 @subsection MN10300 Options
6780 @cindex MN10300 options
6781
6782 These @option{-m} options are defined for Matsushita MN10300 architectures:
6783
6784 @table @gcctabopt
6785 @item -mmult-bug
6786 @opindex mmult-bug
6787 Generate code to avoid bugs in the multiply instructions for the MN10300
6788 processors.  This is the default.
6789
6790 @item -mno-mult-bug
6791 @opindex mno-mult-bug
6792 Do not generate code to avoid bugs in the multiply instructions for the
6793 MN10300 processors.
6794
6795 @item -mam33
6796 @opindex mam33
6797 Generate code which uses features specific to the AM33 processor.
6798
6799 @item -mno-am33
6800 @opindex mno-am33
6801 Do not generate code which uses features specific to the AM33 processor.  This
6802 is the default.
6803
6804 @item -mno-crt0
6805 @opindex mno-crt0
6806 Do not link in the C run-time initialization object file.
6807
6808 @item -mrelax
6809 @opindex mrelax
6810 Indicate to the linker that it should perform a relaxation optimization pass
6811 to shorten branches, calls and absolute memory addresses.  This option only
6812 has an effect when used on the command line for the final link step.
6813
6814 This option makes symbolic debugging impossible.
6815 @end table
6816
6817
6818 @node M32R/D Options
6819 @subsection M32R/D Options
6820 @cindex M32R/D options
6821
6822 These @option{-m} options are defined for Renesas M32R/D architectures:
6823
6824 @table @gcctabopt
6825 @item -m32r2
6826 @opindex m32r2
6827 Generate code for the M32R/2@.
6828
6829 @item -m32rx
6830 @opindex m32rx
6831 Generate code for the M32R/X@.
6832
6833 @item -m32r
6834 @opindex m32r
6835 Generate code for the M32R@.  This is the default.
6836
6837 @item -mmodel=small
6838 @opindex mmodel=small
6839 Assume all objects live in the lower 16MB of memory (so that their addresses
6840 can be loaded with the @code{ld24} instruction), and assume all subroutines
6841 are reachable with the @code{bl} instruction.
6842 This is the default.
6843
6844 The addressability of a particular object can be set with the
6845 @code{model} attribute.
6846
6847 @item -mmodel=medium
6848 @opindex mmodel=medium
6849 Assume objects may be anywhere in the 32-bit address space (the compiler
6850 will generate @code{seth/add3} instructions to load their addresses), and
6851 assume all subroutines are reachable with the @code{bl} instruction.
6852
6853 @item -mmodel=large
6854 @opindex mmodel=large
6855 Assume objects may be anywhere in the 32-bit address space (the compiler
6856 will generate @code{seth/add3} instructions to load their addresses), and
6857 assume subroutines may not be reachable with the @code{bl} instruction
6858 (the compiler will generate the much slower @code{seth/add3/jl}
6859 instruction sequence).
6860
6861 @item -msdata=none
6862 @opindex msdata=none
6863 Disable use of the small data area.  Variables will be put into
6864 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6865 @code{section} attribute has been specified).
6866 This is the default.
6867
6868 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6869 Objects may be explicitly put in the small data area with the
6870 @code{section} attribute using one of these sections.
6871
6872 @item -msdata=sdata
6873 @opindex msdata=sdata
6874 Put small global and static data in the small data area, but do not
6875 generate special code to reference them.
6876
6877 @item -msdata=use
6878 @opindex msdata=use
6879 Put small global and static data in the small data area, and generate
6880 special instructions to reference them.
6881
6882 @item -G @var{num}
6883 @opindex G
6884 @cindex smaller data references
6885 Put global and static objects less than or equal to @var{num} bytes
6886 into the small data or bss sections instead of the normal data or bss
6887 sections.  The default value of @var{num} is 8.
6888 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6889 for this option to have any effect.
6890
6891 All modules should be compiled with the same @option{-G @var{num}} value.
6892 Compiling with different values of @var{num} may or may not work; if it
6893 doesn't the linker will give an error message---incorrect code will not be
6894 generated.
6895
6896 @item -mdebug
6897 @opindex -mdebug
6898 Makes the M32R specific code in the compiler display some statistics
6899 that might help in debugging programs.
6900
6901 @item -malign-loops
6902 @opindex malign-loops
6903 Align all loops to a 32-byte boundary.
6904
6905 @item -mno-align-loops
6906 @opindex mno-align-loops
6907 Do not enforce a 32-byte alignment for loops.  This is the default.
6908
6909 @item -missue-rate=@var{number}
6910 @opindex missue-rate=@var{number}
6911 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6912 or 2.
6913
6914 @item -mbranch-cost=@var{number}
6915 @opindex mbranch-cost=@var{number}
6916 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6917 preferred over conditional code, if it is 2, then the opposite will
6918 apply.
6919
6920 @item -mflush-trap=@var{number}
6921 @opindex mflush-trap=@var{number}
6922 Specifies the trap number to use to flush the cache.  The default is
6923 12.  Valid numbers are between 0 and 15 inclusive.
6924
6925 @item -mno-flush-trap
6926 @opindex mno-flush-trap
6927 Specifies that the cache cannot be flushed by using a trap.
6928
6929 @item -mflush-func=@var{name}
6930 @opindex mflush-func=@var{name}
6931 Specifies the name of the operating system function to call to flush
6932 the cache.  The default is @emph{_flush_cache}, but a function call
6933 will only be used if a trap is not available.
6934
6935 @item -mno-flush-func
6936 @opindex mno-flush-func
6937 Indicates that there is no OS function for flushing the cache.
6938
6939 @end table
6940
6941 @node RS/6000 and PowerPC Options
6942 @subsection IBM RS/6000 and PowerPC Options
6943 @cindex RS/6000 and PowerPC Options
6944 @cindex IBM RS/6000 and PowerPC Options
6945
6946 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6947 @table @gcctabopt
6948 @item -mpower
6949 @itemx -mno-power
6950 @itemx -mpower2
6951 @itemx -mno-power2
6952 @itemx -mpowerpc
6953 @itemx -mno-powerpc
6954 @itemx -mpowerpc-gpopt
6955 @itemx -mno-powerpc-gpopt
6956 @itemx -mpowerpc-gfxopt
6957 @itemx -mno-powerpc-gfxopt
6958 @itemx -mpowerpc64
6959 @itemx -mno-powerpc64
6960 @opindex mpower
6961 @opindex mno-power
6962 @opindex mpower2
6963 @opindex mno-power2
6964 @opindex mpowerpc
6965 @opindex mno-powerpc
6966 @opindex mpowerpc-gpopt
6967 @opindex mno-powerpc-gpopt
6968 @opindex mpowerpc-gfxopt
6969 @opindex mno-powerpc-gfxopt
6970 @opindex mpowerpc64
6971 @opindex mno-powerpc64
6972 GCC supports two related instruction set architectures for the
6973 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6974 instructions supported by the @samp{rios} chip set used in the original
6975 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6976 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6977 the IBM 4xx microprocessors.
6978
6979 Neither architecture is a subset of the other.  However there is a
6980 large common subset of instructions supported by both.  An MQ
6981 register is included in processors supporting the POWER architecture.
6982
6983 You use these options to specify which instructions are available on the
6984 processor you are using.  The default value of these options is
6985 determined when configuring GCC@.  Specifying the
6986 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6987 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6988 rather than the options listed above.
6989
6990 The @option{-mpower} option allows GCC to generate instructions that
6991 are found only in the POWER architecture and to use the MQ register.
6992 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6993 to generate instructions that are present in the POWER2 architecture but
6994 not the original POWER architecture.
6995
6996 The @option{-mpowerpc} option allows GCC to generate instructions that
6997 are found only in the 32-bit subset of the PowerPC architecture.
6998 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6999 GCC to use the optional PowerPC architecture instructions in the
7000 General Purpose group, including floating-point square root.  Specifying
7001 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7002 use the optional PowerPC architecture instructions in the Graphics
7003 group, including floating-point select.
7004
7005 The @option{-mpowerpc64} option allows GCC to generate the additional
7006 64-bit instructions that are found in the full PowerPC64 architecture
7007 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7008 @option{-mno-powerpc64}.
7009
7010 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7011 will use only the instructions in the common subset of both
7012 architectures plus some special AIX common-mode calls, and will not use
7013 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7014 permits GCC to use any instruction from either architecture and to
7015 allow use of the MQ register; specify this for the Motorola MPC601.
7016
7017 @item -mnew-mnemonics
7018 @itemx -mold-mnemonics
7019 @opindex mnew-mnemonics
7020 @opindex mold-mnemonics
7021 Select which mnemonics to use in the generated assembler code.  With
7022 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7023 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7024 assembler mnemonics defined for the POWER architecture.  Instructions
7025 defined in only one architecture have only one mnemonic; GCC uses that
7026 mnemonic irrespective of which of these options is specified.
7027
7028 GCC defaults to the mnemonics appropriate for the architecture in
7029 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7030 value of these option.  Unless you are building a cross-compiler, you
7031 should normally not specify either @option{-mnew-mnemonics} or
7032 @option{-mold-mnemonics}, but should instead accept the default.
7033
7034 @item -mcpu=@var{cpu_type}
7035 @opindex mcpu
7036 Set architecture type, register usage, choice of mnemonics, and
7037 instruction scheduling parameters for machine type @var{cpu_type}.
7038 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7039 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7040 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7041 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7042 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7043 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7044 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7045 @samp{power4}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
7046 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7047
7048 @option{-mcpu=common} selects a completely generic processor.  Code
7049 generated under this option will run on any POWER or PowerPC processor.
7050 GCC will use only the instructions in the common subset of both
7051 architectures, and will not use the MQ register.  GCC assumes a generic
7052 processor model for scheduling purposes.
7053
7054 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7055 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7056 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7057 types, with an appropriate, generic processor model assumed for
7058 scheduling purposes.
7059
7060 The other options specify a specific processor.  Code generated under
7061 those options will run best on that processor, and may not run at all on
7062 others.
7063
7064 The @option{-mcpu} options automatically enable or disable the
7065 following options: @option{-maltivec}, @option{-mhard-float},
7066 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7067 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7068 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7069 @option{-mstring}.  The particular options set for any particular CPU
7070 will vary between compiler versions, depending on what setting seems
7071 to produce optimal code for that CPU; it doesn't necessarily reflect
7072 the actual hardware's capabilities.  If you wish to set an individual
7073 option to a particular value, you may specify it after the
7074 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7075
7076 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7077 not enabled or disabled by the @option{-mcpu} option at present, since
7078 AIX does not have full support for these options.  You may still
7079 enable or disable them individually if you're sure it'll work in your
7080 environment.
7081
7082 @item -mtune=@var{cpu_type}
7083 @opindex mtune
7084 Set the instruction scheduling parameters for machine type
7085 @var{cpu_type}, but do not set the architecture type, register usage, or
7086 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7087 values for @var{cpu_type} are used for @option{-mtune} as for
7088 @option{-mcpu}.  If both are specified, the code generated will use the
7089 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7090 scheduling parameters set by @option{-mtune}.
7091
7092 @item -maltivec
7093 @itemx -mno-altivec
7094 @opindex maltivec
7095 @opindex mno-altivec
7096 These switches enable or disable the use of built-in functions that
7097 allow access to the AltiVec instruction set.  You may also need to set
7098 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7099 enhancements.
7100
7101 @item -mabi=spe
7102 @opindex mabi=spe
7103 Extend the current ABI with SPE ABI extensions.  This does not change
7104 the default ABI, instead it adds the SPE ABI extensions to the current
7105 ABI@.
7106
7107 @item -mabi=no-spe
7108 @opindex mabi=no-spe
7109 Disable Booke SPE ABI extensions for the current ABI.
7110
7111 @item -misel=@var{yes/no}
7112 @itemx -misel
7113 @opindex misel
7114 This switch enables or disables the generation of ISEL instructions.
7115
7116 @item -mspe=@var{yes/no}
7117 @itemx -mspe
7118 @opindex mspe
7119 This switch enables or disables the generation of SPE simd
7120 instructions.
7121
7122 @item -mfloat-gprs=@var{yes/no}
7123 @itemx -mfloat-gprs
7124 @opindex mfloat-gprs
7125 This switch enables or disables the generation of floating point
7126 operations on the general purpose registers for architectures that
7127 support it.  This option is currently only available on the MPC8540.
7128
7129 @item -mfull-toc
7130 @itemx -mno-fp-in-toc
7131 @itemx -mno-sum-in-toc
7132 @itemx -mminimal-toc
7133 @opindex mfull-toc
7134 @opindex mno-fp-in-toc
7135 @opindex mno-sum-in-toc
7136 @opindex mminimal-toc
7137 Modify generation of the TOC (Table Of Contents), which is created for
7138 every executable file.  The @option{-mfull-toc} option is selected by
7139 default.  In that case, GCC will allocate at least one TOC entry for
7140 each unique non-automatic variable reference in your program.  GCC
7141 will also place floating-point constants in the TOC@.  However, only
7142 16,384 entries are available in the TOC@.
7143
7144 If you receive a linker error message that saying you have overflowed
7145 the available TOC space, you can reduce the amount of TOC space used
7146 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7147 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7148 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7149 generate code to calculate the sum of an address and a constant at
7150 run-time instead of putting that sum into the TOC@.  You may specify one
7151 or both of these options.  Each causes GCC to produce very slightly
7152 slower and larger code at the expense of conserving TOC space.
7153
7154 If you still run out of space in the TOC even when you specify both of
7155 these options, specify @option{-mminimal-toc} instead.  This option causes
7156 GCC to make only one TOC entry for every file.  When you specify this
7157 option, GCC will produce code that is slower and larger but which
7158 uses extremely little TOC space.  You may wish to use this option
7159 only on files that contain less frequently executed code.
7160
7161 @item -maix64
7162 @itemx -maix32
7163 @opindex maix64
7164 @opindex maix32
7165 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7166 @code{long} type, and the infrastructure needed to support them.
7167 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7168 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7169 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7170
7171 @item -mxl-call
7172 @itemx -mno-xl-call
7173 @opindex mxl-call
7174 @opindex mno-xl-call
7175 On AIX, pass floating-point arguments to prototyped functions beyond the
7176 register save area (RSA) on the stack in addition to argument FPRs.  The
7177 AIX calling convention was extended but not initially documented to
7178 handle an obscure K&R C case of calling a function that takes the
7179 address of its arguments with fewer arguments than declared.  AIX XL
7180 compilers access floating point arguments which do not fit in the
7181 RSA from the stack when a subroutine is compiled without
7182 optimization.  Because always storing floating-point arguments on the
7183 stack is inefficient and rarely needed, this option is not enabled by
7184 default and only is necessary when calling subroutines compiled by AIX
7185 XL compilers without optimization.
7186
7187 @item -mpe
7188 @opindex mpe
7189 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7190 application written to use message passing with special startup code to
7191 enable the application to run.  The system must have PE installed in the
7192 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7193 must be overridden with the @option{-specs=} option to specify the
7194 appropriate directory location.  The Parallel Environment does not
7195 support threads, so the @option{-mpe} option and the @option{-pthread}
7196 option are incompatible.
7197
7198 @item -malign-natural
7199 @itemx -malign-power
7200 @opindex malign-natural
7201 @opindex malign-power
7202 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
7203 @option{-malign-natural} overrides the ABI-defined alignment of larger
7204 types, such as floating-point doubles, on their natural size-based boundary.
7205 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7206 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7207
7208 @item -msoft-float
7209 @itemx -mhard-float
7210 @opindex msoft-float
7211 @opindex mhard-float
7212 Generate code that does not use (uses) the floating-point register set.
7213 Software floating point emulation is provided if you use the
7214 @option{-msoft-float} option, and pass the option to GCC when linking.
7215
7216 @item -mmultiple
7217 @itemx -mno-multiple
7218 @opindex mmultiple
7219 @opindex mno-multiple
7220 Generate code that uses (does not use) the load multiple word
7221 instructions and the store multiple word instructions.  These
7222 instructions are generated by default on POWER systems, and not
7223 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7224 endian PowerPC systems, since those instructions do not work when the
7225 processor is in little endian mode.  The exceptions are PPC740 and
7226 PPC750 which permit the instructions usage in little endian mode.
7227
7228 @item -mstring
7229 @itemx -mno-string
7230 @opindex mstring
7231 @opindex mno-string
7232 Generate code that uses (does not use) the load string instructions
7233 and the store string word instructions to save multiple registers and
7234 do small block moves.  These instructions are generated by default on
7235 POWER systems, and not generated on PowerPC systems.  Do not use
7236 @option{-mstring} on little endian PowerPC systems, since those
7237 instructions do not work when the processor is in little endian mode.
7238 The exceptions are PPC740 and PPC750 which permit the instructions
7239 usage in little endian mode.
7240
7241 @item -mupdate
7242 @itemx -mno-update
7243 @opindex mupdate
7244 @opindex mno-update
7245 Generate code that uses (does not use) the load or store instructions
7246 that update the base register to the address of the calculated memory
7247 location.  These instructions are generated by default.  If you use
7248 @option{-mno-update}, there is a small window between the time that the
7249 stack pointer is updated and the address of the previous frame is
7250 stored, which means code that walks the stack frame across interrupts or
7251 signals may get corrupted data.
7252
7253 @item -mfused-madd
7254 @itemx -mno-fused-madd
7255 @opindex mfused-madd
7256 @opindex mno-fused-madd
7257 Generate code that uses (does not use) the floating point multiply and
7258 accumulate instructions.  These instructions are generated by default if
7259 hardware floating is used.
7260
7261 @item -mno-bit-align
7262 @itemx -mbit-align
7263 @opindex mno-bit-align
7264 @opindex mbit-align
7265 On System V.4 and embedded PowerPC systems do not (do) force structures
7266 and unions that contain bit-fields to be aligned to the base type of the
7267 bit-field.
7268
7269 For example, by default a structure containing nothing but 8
7270 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7271 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7272 the structure would be aligned to a 1 byte boundary and be one byte in
7273 size.
7274
7275 @item -mno-strict-align
7276 @itemx -mstrict-align
7277 @opindex mno-strict-align
7278 @opindex mstrict-align
7279 On System V.4 and embedded PowerPC systems do not (do) assume that
7280 unaligned memory references will be handled by the system.
7281
7282 @item -mrelocatable
7283 @itemx -mno-relocatable
7284 @opindex mrelocatable
7285 @opindex mno-relocatable
7286 On embedded PowerPC systems generate code that allows (does not allow)
7287 the program to be relocated to a different address at runtime.  If you
7288 use @option{-mrelocatable} on any module, all objects linked together must
7289 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7290
7291 @item -mrelocatable-lib
7292 @itemx -mno-relocatable-lib
7293 @opindex mrelocatable-lib
7294 @opindex mno-relocatable-lib
7295 On embedded PowerPC systems generate code that allows (does not allow)
7296 the program to be relocated to a different address at runtime.  Modules
7297 compiled with @option{-mrelocatable-lib} can be linked with either modules
7298 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7299 with modules compiled with the @option{-mrelocatable} options.
7300
7301 @item -mno-toc
7302 @itemx -mtoc
7303 @opindex mno-toc
7304 @opindex mtoc
7305 On System V.4 and embedded PowerPC systems do not (do) assume that
7306 register 2 contains a pointer to a global area pointing to the addresses
7307 used in the program.
7308
7309 @item -mlittle
7310 @itemx -mlittle-endian
7311 @opindex mlittle
7312 @opindex mlittle-endian
7313 On System V.4 and embedded PowerPC systems compile code for the
7314 processor in little endian mode.  The @option{-mlittle-endian} option is
7315 the same as @option{-mlittle}.
7316
7317 @item -mbig
7318 @itemx -mbig-endian
7319 @opindex mbig
7320 @opindex mbig-endian
7321 On System V.4 and embedded PowerPC systems compile code for the
7322 processor in big endian mode.  The @option{-mbig-endian} option is
7323 the same as @option{-mbig}.
7324
7325 @item -mdynamic-no-pic
7326 @opindex mdynamic-no-pic
7327 On Darwin and Mac OS X systems, compile code so that it is not
7328 relocatable, but that its external references are relocatable.  The
7329 resulting code is suitable for applications, but not shared
7330 libraries.
7331
7332 @item -mprioritize-restricted-insns=@var{priority}
7333 @opindex mprioritize-restricted-insns
7334 This option controls the priority that is assigned to
7335 dispatch-slot restricted instructions during the second scheduling
7336 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
7337 @var{no/highest/second-highest} priority to dispatch slot restricted
7338 instructions.
7339
7340 @item -msched-costly-dep=@var{dependence_type}
7341 @opindex msched-costly-dep
7342 This option controls which dependences are considered costly
7343 by the target during instruction scheduling.  The argument
7344 @var{dependence_type} takes one of the following values:
7345 @var{no}: no dependence is costly,
7346 @var{all}: all dependences are costly,
7347 @var{true_store_to_load}: a true dependence from store to load is costly,
7348 @var{store_to_load}: any dependence from store to load is costly,
7349 @var{number}: any dependence which latency >= @var{number} is costly.
7350
7351 @item -minsert-sched-nops=@var{scheme}
7352 @opindex minsert-sched-nops
7353 This option controls which nop insertion scheme will be used during
7354 the second scheduling pass. The argument @var{scheme} takes one of the
7355 following values:
7356 @var{no}: Don't insert nops.
7357 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7358 according to the scheduler's grouping.
7359 @var{regroup_exact}: Insert nops to force costly dependent insns into
7360 separate groups.  Insert exactly as many nops as needed to force an insn
7361 to a new group, according to the estimated processor grouping.
7362 @var{number}: Insert nops to force costly dependent insns into
7363 separate groups.  Insert @var{number} nops to force an insn to a new group.
7364
7365 @item -mcall-sysv
7366 @opindex mcall-sysv
7367 On System V.4 and embedded PowerPC systems compile code using calling
7368 conventions that adheres to the March 1995 draft of the System V
7369 Application Binary Interface, PowerPC processor supplement.  This is the
7370 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7371
7372 @item -mcall-sysv-eabi
7373 @opindex mcall-sysv-eabi
7374 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7375
7376 @item -mcall-sysv-noeabi
7377 @opindex mcall-sysv-noeabi
7378 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7379
7380 @item -mcall-solaris
7381 @opindex mcall-solaris
7382 On System V.4 and embedded PowerPC systems compile code for the Solaris
7383 operating system.
7384
7385 @item -mcall-linux
7386 @opindex mcall-linux
7387 On System V.4 and embedded PowerPC systems compile code for the
7388 Linux-based GNU system.
7389
7390 @item -mcall-gnu
7391 @opindex mcall-gnu
7392 On System V.4 and embedded PowerPC systems compile code for the
7393 Hurd-based GNU system.
7394
7395 @item -mcall-netbsd
7396 @opindex mcall-netbsd
7397 On System V.4 and embedded PowerPC systems compile code for the
7398 NetBSD operating system.
7399
7400 @item -maix-struct-return
7401 @opindex maix-struct-return
7402 Return all structures in memory (as specified by the AIX ABI)@.
7403
7404 @item -msvr4-struct-return
7405 @opindex msvr4-struct-return
7406 Return structures smaller than 8 bytes in registers (as specified by the
7407 SVR4 ABI)@.
7408
7409 @item -mabi=altivec
7410 @opindex mabi=altivec
7411 Extend the current ABI with AltiVec ABI extensions.  This does not
7412 change the default ABI, instead it adds the AltiVec ABI extensions to
7413 the current ABI@.
7414
7415 @item -mabi=no-altivec
7416 @opindex mabi=no-altivec
7417 Disable AltiVec ABI extensions for the current ABI.
7418
7419 @item -mprototype
7420 @itemx -mno-prototype
7421 @opindex mprototype
7422 @opindex mno-prototype
7423 On System V.4 and embedded PowerPC systems assume that all calls to
7424 variable argument functions are properly prototyped.  Otherwise, the
7425 compiler must insert an instruction before every non prototyped call to
7426 set or clear bit 6 of the condition code register (@var{CR}) to
7427 indicate whether floating point values were passed in the floating point
7428 registers in case the function takes a variable arguments.  With
7429 @option{-mprototype}, only calls to prototyped variable argument functions
7430 will set or clear the bit.
7431
7432 @item -msim
7433 @opindex msim
7434 On embedded PowerPC systems, assume that the startup module is called
7435 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7436 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7437 configurations.
7438
7439 @item -mmvme
7440 @opindex mmvme
7441 On embedded PowerPC systems, assume that the startup module is called
7442 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7443 @file{libc.a}.
7444
7445 @item -mads
7446 @opindex mads
7447 On embedded PowerPC systems, assume that the startup module is called
7448 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7449 @file{libc.a}.
7450
7451 @item -myellowknife
7452 @opindex myellowknife
7453 On embedded PowerPC systems, assume that the startup module is called
7454 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7455 @file{libc.a}.
7456
7457 @item -mvxworks
7458 @opindex mvxworks
7459 On System V.4 and embedded PowerPC systems, specify that you are
7460 compiling for a VxWorks system.
7461
7462 @item -mwindiss
7463 @opindex mwindiss
7464 Specify that you are compiling for the WindISS simulation environment.
7465
7466 @item -memb
7467 @opindex memb
7468 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7469 header to indicate that @samp{eabi} extended relocations are used.
7470
7471 @item -meabi
7472 @itemx -mno-eabi
7473 @opindex meabi
7474 @opindex mno-eabi
7475 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7476 Embedded Applications Binary Interface (eabi) which is a set of
7477 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7478 means that the stack is aligned to an 8 byte boundary, a function
7479 @code{__eabi} is called to from @code{main} to set up the eabi
7480 environment, and the @option{-msdata} option can use both @code{r2} and
7481 @code{r13} to point to two separate small data areas.  Selecting
7482 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7483 do not call an initialization function from @code{main}, and the
7484 @option{-msdata} option will only use @code{r13} to point to a single
7485 small data area.  The @option{-meabi} option is on by default if you
7486 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7487
7488 @item -msdata=eabi
7489 @opindex msdata=eabi
7490 On System V.4 and embedded PowerPC systems, put small initialized
7491 @code{const} global and static data in the @samp{.sdata2} section, which
7492 is pointed to by register @code{r2}.  Put small initialized
7493 non-@code{const} global and static data in the @samp{.sdata} section,
7494 which is pointed to by register @code{r13}.  Put small uninitialized
7495 global and static data in the @samp{.sbss} section, which is adjacent to
7496 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7497 incompatible with the @option{-mrelocatable} option.  The
7498 @option{-msdata=eabi} option also sets the @option{-memb} option.
7499
7500 @item -msdata=sysv
7501 @opindex msdata=sysv
7502 On System V.4 and embedded PowerPC systems, put small global and static
7503 data in the @samp{.sdata} section, which is pointed to by register
7504 @code{r13}.  Put small uninitialized global and static data in the
7505 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7506 The @option{-msdata=sysv} option is incompatible with the
7507 @option{-mrelocatable} option.
7508
7509 @item -msdata=default
7510 @itemx -msdata
7511 @opindex msdata=default
7512 @opindex msdata
7513 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7514 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7515 same as @option{-msdata=sysv}.
7516
7517 @item -msdata-data
7518 @opindex msdata-data
7519 On System V.4 and embedded PowerPC systems, put small global and static
7520 data in the @samp{.sdata} section.  Put small uninitialized global and
7521 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7522 to address small data however.  This is the default behavior unless
7523 other @option{-msdata} options are used.
7524
7525 @item -msdata=none
7526 @itemx -mno-sdata
7527 @opindex msdata=none
7528 @opindex mno-sdata
7529 On embedded PowerPC systems, put all initialized global and static data
7530 in the @samp{.data} section, and all uninitialized data in the
7531 @samp{.bss} section.
7532
7533 @item -G @var{num}
7534 @opindex G
7535 @cindex smaller data references (PowerPC)
7536 @cindex .sdata/.sdata2 references (PowerPC)
7537 On embedded PowerPC systems, put global and static items less than or
7538 equal to @var{num} bytes into the small data or bss sections instead of
7539 the normal data or bss section.  By default, @var{num} is 8.  The
7540 @option{-G @var{num}} switch is also passed to the linker.
7541 All modules should be compiled with the same @option{-G @var{num}} value.
7542
7543 @item -mregnames
7544 @itemx -mno-regnames
7545 @opindex mregnames
7546 @opindex mno-regnames
7547 On System V.4 and embedded PowerPC systems do (do not) emit register
7548 names in the assembly language output using symbolic forms.
7549
7550 @item -mlongcall
7551 @itemx -mno-longcall
7552 @opindex mlongcall
7553 @opindex mno-longcall
7554 Default to making all function calls via pointers, so that functions
7555 which reside further than 64 megabytes (67,108,864 bytes) from the
7556 current location can be called.  This setting can be overridden by the
7557 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7558
7559 Some linkers are capable of detecting out-of-range calls and generating
7560 glue code on the fly.  On these systems, long calls are unnecessary and
7561 generate slower code.  As of this writing, the AIX linker can do this,
7562 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7563 to the GNU linker for 32-bit PowerPC systems as well.
7564
7565 On Mach-O (Darwin) systems, this option directs the compiler emit to
7566 the glue for every direct call, and the Darwin linker decides whether
7567 to use or discard it.
7568
7569 In the future, we may cause GCC to ignore all longcall specifications
7570 when the linker is known to generate glue.
7571
7572 @item -pthread
7573 @opindex pthread
7574 Adds support for multithreading with the @dfn{pthreads} library.
7575 This option sets flags for both the preprocessor and linker.
7576
7577 @end table
7578
7579 @node Darwin Options
7580 @subsection Darwin Options
7581 @cindex Darwin options
7582
7583 These options are defined for all architectures running the Darwin operating
7584 system.  They are useful for compatibility with other Mac OS compilers.
7585
7586 @table @gcctabopt
7587 @item -all_load
7588 @opindex all_load
7589 Loads all members of static archive libraries.
7590 See man ld(1) for more information.
7591
7592 @item -arch_errors_fatal
7593 @opindex arch_errors_fatal
7594 Cause the errors having to do with files that have the wrong architecture
7595 to be fatal.
7596
7597 @item -bind_at_load
7598 @opindex bind_at_load
7599 Causes the output file to be marked such that the dynamic linker will
7600 bind all undefined references when the file is loaded or launched.
7601
7602 @item -bundle
7603 @opindex bundle
7604 Produce a Mach-o bundle format file.
7605 See man ld(1) for more information.
7606
7607 @item -bundle_loader @var{executable}
7608 @opindex bundle_loader
7609 This specifies the @var{executable} that will be loading the build
7610 output file being linked. See man ld(1) for more information.
7611
7612 @item -allowable_client  @var{client_name}
7613 @itemx -arch_only
7614
7615 @itemx -client_name
7616 @itemx -compatibility_version
7617 @itemx -current_version
7618 @itemx -dependency-file
7619 @itemx -dylib_file
7620 @itemx -dylinker_install_name
7621 @itemx -dynamic
7622 @itemx -dynamiclib
7623 @itemx -exported_symbols_list
7624 @itemx -filelist
7625 @itemx -flat_namespace
7626 @itemx -force_cpusubtype_ALL
7627 @itemx -force_flat_namespace
7628 @itemx -headerpad_max_install_names
7629 @itemx -image_base
7630 @itemx -init
7631 @itemx -install_name
7632 @itemx -keep_private_externs
7633 @itemx -multi_module
7634 @itemx -multiply_defined
7635 @itemx -multiply_defined_unused
7636 @itemx -noall_load
7637 @itemx -nofixprebinding
7638 @itemx -nomultidefs
7639 @itemx -noprebind
7640 @itemx -noseglinkedit
7641 @itemx -pagezero_size
7642 @itemx -prebind
7643 @itemx -prebind_all_twolevel_modules
7644 @itemx -private_bundle
7645 @itemx -read_only_relocs
7646 @itemx -sectalign
7647 @itemx -sectobjectsymbols
7648 @itemx -whyload
7649 @itemx -seg1addr
7650 @itemx -sectcreate
7651 @itemx -sectobjectsymbols
7652 @itemx -sectorder
7653 @itemx -seg_addr_table
7654 @itemx -seg_addr_table_filename
7655 @itemx -seglinkedit
7656 @itemx -segprot
7657 @itemx -segs_read_only_addr
7658 @itemx -segs_read_write_addr
7659 @itemx -single_module
7660 @itemx -static
7661 @itemx -sub_library
7662 @itemx -sub_umbrella
7663 @itemx -twolevel_namespace
7664 @itemx -umbrella
7665 @itemx -undefined
7666 @itemx -unexported_symbols_list
7667 @itemx -weak_reference_mismatches
7668 @itemx -whatsloaded
7669
7670 @opindex allowable_client
7671 @opindex arch_only
7672 @opindex client_name
7673 @opindex compatibility_version
7674 @opindex current_version
7675 @opindex dependency-file
7676 @opindex dylib_file
7677 @opindex dylinker_install_name
7678 @opindex dynamic
7679 @opindex dynamiclib
7680 @opindex exported_symbols_list
7681 @opindex filelist
7682 @opindex flat_namespace
7683 @opindex force_cpusubtype_ALL
7684 @opindex force_flat_namespace
7685 @opindex headerpad_max_install_names
7686 @opindex image_base
7687 @opindex init
7688 @opindex install_name
7689 @opindex keep_private_externs
7690 @opindex multi_module
7691 @opindex multiply_defined
7692 @opindex multiply_defined_unused
7693 @opindex noall_load
7694 @opindex nofixprebinding
7695 @opindex nomultidefs
7696 @opindex noprebind
7697 @opindex noseglinkedit
7698 @opindex pagezero_size
7699 @opindex prebind
7700 @opindex prebind_all_twolevel_modules
7701 @opindex private_bundle
7702 @opindex read_only_relocs
7703 @opindex sectalign
7704 @opindex sectobjectsymbols
7705 @opindex whyload
7706 @opindex seg1addr
7707 @opindex sectcreate
7708 @opindex sectobjectsymbols
7709 @opindex sectorder
7710 @opindex seg_addr_table
7711 @opindex seg_addr_table_filename
7712 @opindex seglinkedit
7713 @opindex segprot
7714 @opindex segs_read_only_addr
7715 @opindex segs_read_write_addr
7716 @opindex single_module
7717 @opindex static
7718 @opindex sub_library
7719 @opindex sub_umbrella
7720 @opindex twolevel_namespace
7721 @opindex umbrella
7722 @opindex undefined
7723 @opindex unexported_symbols_list
7724 @opindex weak_reference_mismatches
7725 @opindex whatsloaded
7726
7727 These options are available for Darwin linker. Darwin linker man page
7728 describes them in detail.
7729 @end table
7730
7731
7732 @node MIPS Options
7733 @subsection MIPS Options
7734 @cindex MIPS options
7735
7736 @table @gcctabopt
7737
7738 @item -EB
7739 @opindex EB
7740 Generate big-endian code.
7741
7742 @item -EL
7743 @opindex EL
7744 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
7745 configurations.
7746
7747 @item -march=@var{arch}
7748 @opindex march
7749 Generate code that will run on @var{arch}, which can be the name of a
7750 generic MIPS ISA, or the name of a particular processor.
7751 The ISA names are:
7752 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7753 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7754 The processor names are:
7755 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7756 @samp{m4k},
7757 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7758 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7759 @samp{rm9000},
7760 @samp{orion},
7761 @samp{sb1},
7762 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7763 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7764 The special value @samp{from-abi} selects the
7765 most compatible architecture for the selected ABI (that is,
7766 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7767
7768 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7769 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7770 @samp{vr} may be written @samp{r}.
7771
7772 GCC defines two macros based on the value of this option.  The first
7773 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7774 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7775 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7776 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7777 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7778
7779 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7780 above.  In other words, it will have the full prefix and will not
7781 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7782 the macro names the resolved architecture (either @samp{"mips1"} or
7783 @samp{"mips3"}).  It names the default architecture when no
7784 @option{-march} option is given.
7785
7786 @item -mtune=@var{arch}
7787 @opindex mtune
7788 Optimize for @var{arch}.  Among other things, this option controls
7789 the way instructions are scheduled, and the perceived cost of arithmetic
7790 operations.  The list of @var{arch} values is the same as for
7791 @option{-march}.
7792
7793 When this option is not used, GCC will optimize for the processor
7794 specified by @option{-march}.  By using @option{-march} and
7795 @option{-mtune} together, it is possible to generate code that will
7796 run on a family of processors, but optimize the code for one
7797 particular member of that family.
7798
7799 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7800 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7801 @samp{-march} ones described above.
7802
7803 @item -mips1
7804 @opindex mips1
7805 Equivalent to @samp{-march=mips1}.
7806
7807 @item -mips2
7808 @opindex mips2
7809 Equivalent to @samp{-march=mips2}.
7810
7811 @item -mips3
7812 @opindex mips3
7813 Equivalent to @samp{-march=mips3}.
7814
7815 @item -mips4
7816 @opindex mips4
7817 Equivalent to @samp{-march=mips4}.
7818
7819 @item -mips32
7820 @opindex mips32
7821 Equivalent to @samp{-march=mips32}.
7822
7823 @item -mips32r2
7824 @opindex mips32r2
7825 Equivalent to @samp{-march=mips32r2}.
7826
7827 @item -mips64
7828 @opindex mips64
7829 Equivalent to @samp{-march=mips64}.
7830
7831 @item -mips16
7832 @itemx -mno-mips16
7833 @opindex mips16
7834 @opindex mno-mips16
7835 Use (do not use) the MIPS16 ISA.
7836
7837 @item -mabi=32
7838 @itemx -mabi=o64
7839 @itemx -mabi=n32
7840 @itemx -mabi=64
7841 @itemx -mabi=eabi
7842 @opindex mabi=32
7843 @opindex mabi=o64
7844 @opindex mabi=n32
7845 @opindex mabi=64
7846 @opindex mabi=eabi
7847 Generate code for the given ABI@.
7848
7849 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
7850 generates 64-bit code when you select a 64-bit architecture, but you
7851 can use @option{-mgp32} to get 32-bit code instead.
7852
7853 @item -mabicalls
7854 @itemx -mno-abicalls
7855 @opindex mabicalls
7856 @opindex mno-abicalls
7857 Generate (do not generate) SVR4-style position-independent code.
7858 @option{-mabicalls} is the default for SVR4-based systems.
7859
7860 @item -mxgot
7861 @itemx -mno-xgot
7862 @opindex mxgot
7863 @opindex mno-xgot
7864 Lift (do not lift) the usual restrictions on the size of the global
7865 offset table.
7866
7867 GCC normally uses a single instruction to load values from the GOT.
7868 While this is relatively efficient, it will only work if the GOT
7869 is smaller than about 64k.  Anything larger will cause the linker
7870 to report an error such as:
7871
7872 @cindex relocation truncated to fit (MIPS)
7873 @smallexample
7874 relocation truncated to fit: R_MIPS_GOT16 foobar
7875 @end smallexample
7876
7877 If this happens, you should recompile your code with @option{-mxgot}.
7878 It should then work with very large GOTs, although it will also be
7879 less efficient, since it will take three instructions to fetch the
7880 value of a global symbol.
7881
7882 Note that some linkers can create multiple GOTs.  If you have such a
7883 linker, you should only need to use @option{-mxgot} when a single object
7884 file accesses more than 64k's worth of GOT entries.  Very few do.
7885
7886 These options have no effect unless GCC is generating position
7887 independent code.
7888
7889 @item -membedded-pic
7890 @itemx -mno-embedded-pic
7891 @opindex membedded-pic
7892 @opindex mno-embedded-pic
7893 Generate (do not generate) position-independent code suitable for some
7894 embedded systems.  All calls are made using PC relative addresses, and
7895 all data is addressed using the $gp register.  No more than 65536
7896 bytes of global data may be used.  This requires GNU as and GNU ld,
7897 which do most of the work.
7898
7899 @item -mgp32
7900 @opindex mgp32
7901 Assume that general-purpose registers are 32 bits wide.
7902
7903 @item -mgp64
7904 @opindex mgp64
7905 Assume that general-purpose registers are 64 bits wide.
7906
7907 @item -mfp32
7908 @opindex mfp32
7909 Assume that floating-point registers are 32 bits wide.
7910
7911 @item -mfp64
7912 @opindex mfp64
7913 Assume that floating-point registers are 64 bits wide.
7914
7915 @item -mhard-float
7916 @opindex mhard-float
7917 Use floating-point coprocessor instructions.
7918
7919 @item -msoft-float
7920 @opindex msoft-float
7921 Do not use floating-point coprocessor instructions.  Implement
7922 floating-point calculations using library calls instead.
7923
7924 @item -msingle-float
7925 @opindex msingle-float
7926 Assume that the floating-point coprocessor only supports single-precision
7927 operations.
7928
7929 @itemx -mdouble-float
7930 @opindex mdouble-float
7931 Assume that the floating-point coprocessor supports double-precision
7932 operations.  This is the default.
7933
7934 @item -mint64
7935 @opindex mint64
7936 Force @code{int} and @code{long} types to be 64 bits wide.  See
7937 @option{-mlong32} for an explanation of the default and the way
7938 that the pointer size is determined.
7939
7940 @item -mlong64
7941 @opindex mlong64
7942 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
7943 an explanation of the default and the way that the pointer size is
7944 determined.
7945
7946 @item -mlong32
7947 @opindex mlong32
7948 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7949
7950 The default size of @code{int}s, @code{long}s and pointers depends on
7951 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
7952 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7953 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
7954 or the same size as integer registers, whichever is smaller.
7955
7956 @item -G @var{num}
7957 @opindex G
7958 @cindex smaller data references (MIPS)
7959 @cindex gp-relative references (MIPS)
7960 Put global and static items less than or equal to @var{num} bytes into
7961 the small data or bss section instead of the normal data or bss section.
7962 This allows the data to be accessed using a single instruction.
7963
7964 All modules should be compiled with the same @option{-G @var{num}}
7965 value.
7966
7967 @item -membedded-data
7968 @itemx -mno-embedded-data
7969 @opindex membedded-data
7970 @opindex mno-embedded-data
7971 Allocate variables to the read-only data section first if possible, then
7972 next in the small data section if possible, otherwise in data.  This gives
7973 slightly slower code than the default, but reduces the amount of RAM required
7974 when executing, and thus may be preferred for some embedded systems.
7975
7976 @item -muninit-const-in-rodata
7977 @itemx -mno-uninit-const-in-rodata
7978 @opindex muninit-const-in-rodata
7979 @opindex mno-uninit-const-in-rodata
7980 Put uninitialized @code{const} variables in the read-only data section.
7981 This option is only meaningful in conjunction with @option{-membedded-data}.
7982
7983 @item -msplit-addresses
7984 @itemx -mno-split-addresses
7985 @opindex msplit-addresses
7986 @opindex mno-split-addresses
7987 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
7988 relocation operators.  This option has been superceded by
7989 @option{-mexplicit-relocs} but is retained for backwards compatibility.
7990
7991 @item -mexplicit-relocs
7992 @itemx -mno-explicit-relocs
7993 @opindex mexplicit-relocs
7994 @opindex mno-explicit-relocs
7995 Use (do not use) assembler relocation operators when dealing with symbolic
7996 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
7997 is to use assembler macros instead.
7998
7999 @option{-mexplicit-relocs} is usually the default if GCC was
8000 configured to use an assembler that supports relocation operators.
8001 However, there are two exceptions:
8002
8003 @itemize @bullet
8004 @item
8005 GCC is not yet able to generate explicit relocations for the combination
8006 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
8007 in a future release.
8008
8009 @item
8010 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
8011 implies @option{-mno-explicit-relocs} unless explicitly overridden.
8012 This is because, when generating abicalls, the choice of relocation
8013 depends on whether a symbol is local or global.  In some rare cases,
8014 GCC will not be able to decide this until the whole compilation unit
8015 has been read.
8016 @end itemize
8017
8018 @item -mrnames
8019 @itemx -mno-rnames
8020 @opindex mrnames
8021 @opindex mno-rnames
8022 Generate (do not generate) code that refers to registers using their
8023 software names.  The default is @option{-mno-rnames}, which tells GCC
8024 to use hardware names like @samp{$4} instead of software names like
8025 @samp{a0}.  The only assembler known to support @option{-rnames} is
8026 the Algorithmics assembler.
8027
8028 @item -mcheck-zero-division
8029 @itemx -mno-check-zero-division
8030 @opindex mcheck-zero-division
8031 @opindex mno-check-zero-division
8032 Trap (do not trap) on integer division by zero.  The default is
8033 @option{-mcheck-zero-division}.
8034
8035 @item -mmemcpy
8036 @itemx -mno-memcpy
8037 @opindex mmemcpy
8038 @opindex mno-memcpy
8039 Force (do not force) the use of @code{memcpy()} for non-trivial block
8040 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8041 most constant-sized copies.
8042
8043 @item -mlong-calls
8044 @itemx -mno-long-calls
8045 @opindex mlong-calls
8046 @opindex mno-long-calls
8047 Disable (do not disable) use of the @code{jal} instruction.  Calling
8048 functions using @code{jal} is more efficient but requires the caller
8049 and callee to be in the same 256 megabyte segment.
8050
8051 This option has no effect on abicalls code.  The default is
8052 @option{-mno-long-calls}.
8053
8054 @item -mmad
8055 @itemx -mno-mad
8056 @opindex mmad
8057 @opindex mno-mad
8058 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8059 instructions, as provided by the R4650 ISA.
8060
8061 @item -mfused-madd
8062 @itemx -mno-fused-madd
8063 @opindex mfused-madd
8064 @opindex mno-fused-madd
8065 Enable (disable) use of the floating point multiply-accumulate
8066 instructions, when they are available.  The default is
8067 @option{-mfused-madd}.
8068
8069 When multiply-accumulate instructions are used, the intermediate
8070 product is calculated to infinite precision and is not subject to
8071 the FCSR Flush to Zero bit.  This may be undesirable in some
8072 circumstances.
8073
8074 @item -nocpp
8075 @opindex nocpp
8076 Tell the MIPS assembler to not run its preprocessor over user
8077 assembler files (with a @samp{.s} suffix) when assembling them.
8078
8079 @item -mfix-sb1
8080 @itemx -mno-fix-sb1
8081 @opindex mfix-sb1
8082 Work around certain SB-1 CPU core errata.
8083 (This flag currently works around the SB-1 revision 2
8084 ``F1'' and ``F2'' floating point errata.)
8085
8086 @item -mflush-func=@var{func}
8087 @itemx -mno-flush-func
8088 @opindex mflush-func
8089 Specifies the function to call to flush the I and D caches, or to not
8090 call any such function.  If called, the function must take the same
8091 arguments as the common @code{_flush_func()}, that is, the address of the
8092 memory range for which the cache is being flushed, the size of the
8093 memory range, and the number 3 (to flush both caches).  The default
8094 depends on the target gcc was configured for, but commonly is either
8095 @samp{_flush_func} or @samp{__cpu_flush}.
8096
8097 @item -mbranch-likely
8098 @itemx -mno-branch-likely
8099 @opindex mbranch-likely
8100 @opindex mno-branch-likely
8101 Enable or disable use of Branch Likely instructions, regardless of the
8102 default for the selected architecture.  By default, Branch Likely
8103 instructions may be generated if they are supported by the selected
8104 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8105 and processors which implement those architectures; for those, Branch
8106 Likely instructions will not be generated by default because the MIPS32
8107 and MIPS64 architectures specifically deprecate their use.
8108 @end table
8109
8110 @node i386 and x86-64 Options
8111 @subsection Intel 386 and AMD x86-64 Options
8112 @cindex i386 Options
8113 @cindex x86-64 Options
8114 @cindex Intel 386 Options
8115 @cindex AMD x86-64 Options
8116
8117 These @samp{-m} options are defined for the i386 and x86-64 family of
8118 computers:
8119
8120 @table @gcctabopt
8121 @item -mtune=@var{cpu-type}
8122 @opindex mtune
8123 Tune to @var{cpu-type} everything applicable about the generated code, except
8124 for the ABI and the set of available instructions.  The choices for
8125 @var{cpu-type} are:
8126 @table @emph
8127 @item i386
8128 Original Intel's i386 CPU.
8129 @item i486
8130 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8131 @item i586, pentium
8132 Intel Pentium CPU with no MMX support.
8133 @item pentium-mmx
8134 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8135 @item i686, pentiumpro
8136 Intel PentiumPro CPU.
8137 @item pentium2
8138 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8139 @item pentium3
8140 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8141 support.
8142 @item pentium4
8143 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8144 @item k6
8145 AMD K6 CPU with MMX instruction set support.
8146 @item k6-2, k6-3
8147 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8148 @item athlon, athlon-tbird
8149 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8150 support.
8151 @item athlon-4, athlon-xp, athlon-mp
8152 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8153 instruction set support.
8154 @item k8, opteron, athlon64, athlon-fx
8155 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8156 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8157 @item winchip-c6
8158 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8159 set support.
8160 @item winchip2
8161 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8162 instruction set support.
8163 @item c3
8164 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8165 implemented for this chip.)
8166 @item c3-2
8167 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8168 implemented for this chip.)
8169 @end table
8170
8171 While picking a specific @var{cpu-type} will schedule things appropriately
8172 for that particular chip, the compiler will not generate any code that
8173 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8174 being used.
8175
8176 @item -march=@var{cpu-type}
8177 @opindex march
8178 Generate instructions for the machine type @var{cpu-type}.  The choices
8179 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8180 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8181
8182 @item -mcpu=@var{cpu-type}
8183 @opindex mcpu
8184 A deprecated synonym for @option{-mtune}.
8185
8186 @item -m386
8187 @itemx -m486
8188 @itemx -mpentium
8189 @itemx -mpentiumpro
8190 @opindex m386
8191 @opindex m486
8192 @opindex mpentium
8193 @opindex mpentiumpro
8194 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8195 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8196 These synonyms are deprecated.
8197
8198 @item -mfpmath=@var{unit}
8199 @opindex march
8200 generate floating point arithmetics for selected unit @var{unit}.  the choices
8201 for @var{unit} are:
8202
8203 @table @samp
8204 @item 387
8205 Use the standard 387 floating point coprocessor present majority of chips and
8206 emulated otherwise.  Code compiled with this option will run almost everywhere.
8207 The temporary results are computed in 80bit precision instead of precision
8208 specified by the type resulting in slightly different results compared to most
8209 of other chips. See @option{-ffloat-store} for more detailed description.
8210
8211 This is the default choice for i386 compiler.
8212
8213 @item sse
8214 Use scalar floating point instructions present in the SSE instruction set.
8215 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8216 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8217 instruction set supports only single precision arithmetics, thus the double and
8218 extended precision arithmetics is still done using 387.  Later version, present
8219 only in Pentium4 and the future AMD x86-64 chips supports double precision
8220 arithmetics too.
8221
8222 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8223 @option{-msse2} switches to enable SSE extensions and make this option
8224 effective.  For x86-64 compiler, these extensions are enabled by default.
8225
8226 The resulting code should be considerably faster in majority of cases and avoid
8227 the numerical instability problems of 387 code, but may break some existing
8228 code that expects temporaries to be 80bit.
8229
8230 This is the default choice for x86-64 compiler.
8231
8232 @item pni
8233 Use all SSE extensions enabled by @option{-msse2} as well as the new
8234 SSE extensions in Prescott New Instructions. @option{-mpni} also
8235 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8236 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8237 @code{mwait}.
8238
8239 @item sse,387
8240 Attempt to utilize both instruction sets at once.  This effectively double the
8241 amount of available registers and on chips with separate execution units for
8242 387 and SSE the execution resources too.  Use this option with care, as it is
8243 still experimental, because gcc register allocator does not model separate
8244 functional units well resulting in instable performance.
8245 @end table
8246
8247 @item -masm=@var{dialect}
8248 @opindex masm=@var{dialect}
8249 Output asm instructions using selected @var{dialect}. Supported choices are
8250 @samp{intel} or @samp{att} (the default one).
8251
8252 @item -mieee-fp
8253 @itemx -mno-ieee-fp
8254 @opindex mieee-fp
8255 @opindex mno-ieee-fp
8256 Control whether or not the compiler uses IEEE floating point
8257 comparisons.  These handle correctly the case where the result of a
8258 comparison is unordered.
8259
8260 @item -msoft-float
8261 @opindex msoft-float
8262 Generate output containing library calls for floating point.
8263 @strong{Warning:} the requisite libraries are not part of GCC@.
8264 Normally the facilities of the machine's usual C compiler are used, but
8265 this can't be done directly in cross-compilation.  You must make your
8266 own arrangements to provide suitable library functions for
8267 cross-compilation.
8268
8269 On machines where a function returns floating point results in the 80387
8270 register stack, some floating point opcodes may be emitted even if
8271 @option{-msoft-float} is used.
8272
8273 @item -mno-fp-ret-in-387
8274 @opindex mno-fp-ret-in-387
8275 Do not use the FPU registers for return values of functions.
8276
8277 The usual calling convention has functions return values of types
8278 @code{float} and @code{double} in an FPU register, even if there
8279 is no FPU@.  The idea is that the operating system should emulate
8280 an FPU@.
8281
8282 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8283 in ordinary CPU registers instead.
8284
8285 @item -mno-fancy-math-387
8286 @opindex mno-fancy-math-387
8287 Some 387 emulators do not support the @code{sin}, @code{cos} and
8288 @code{sqrt} instructions for the 387.  Specify this option to avoid
8289 generating those instructions.  This option is the default on FreeBSD,
8290 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8291 indicates that the target cpu will always have an FPU and so the
8292 instruction will not need emulation.  As of revision 2.6.1, these
8293 instructions are not generated unless you also use the
8294 @option{-funsafe-math-optimizations} switch.
8295
8296 @item -malign-double
8297 @itemx -mno-align-double
8298 @opindex malign-double
8299 @opindex mno-align-double
8300 Control whether GCC aligns @code{double}, @code{long double}, and
8301 @code{long long} variables on a two word boundary or a one word
8302 boundary.  Aligning @code{double} variables on a two word boundary will
8303 produce code that runs somewhat faster on a @samp{Pentium} at the
8304 expense of more memory.
8305
8306 @strong{Warning:} if you use the @option{-malign-double} switch,
8307 structures containing the above types will be aligned differently than
8308 the published application binary interface specifications for the 386
8309 and will not be binary compatible with structures in code compiled
8310 without that switch.
8311
8312 @item -m96bit-long-double
8313 @itemx -m128bit-long-double
8314 @opindex m96bit-long-double
8315 @opindex m128bit-long-double
8316 These switches control the size of @code{long double} type. The i386
8317 application binary interface specifies the size to be 96 bits,
8318 so @option{-m96bit-long-double} is the default in 32 bit mode.
8319
8320 Modern architectures (Pentium and newer) would prefer @code{long double}
8321 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8322 conforming to the ABI, this would not be possible.  So specifying a
8323 @option{-m128bit-long-double} will align @code{long double}
8324 to a 16 byte boundary by padding the @code{long double} with an additional
8325 32 bit zero.
8326
8327 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8328 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8329
8330 Notice that neither of these options enable any extra precision over the x87
8331 standard of 80 bits for a @code{long double}.
8332
8333 @strong{Warning:} if you override the default value for your target ABI, the
8334 structures and arrays containing @code{long double} will change their size as
8335 well as function calling convention for function taking @code{long double}
8336 will be modified.  Hence they will not be binary compatible with arrays or
8337 structures in code compiled without that switch.
8338
8339
8340 @item -msvr3-shlib
8341 @itemx -mno-svr3-shlib
8342 @opindex msvr3-shlib
8343 @opindex mno-svr3-shlib
8344 Control whether GCC places uninitialized local variables into the
8345 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8346 into @code{bss}.  These options are meaningful only on System V Release 3.
8347
8348 @item -mrtd
8349 @opindex mrtd
8350 Use a different function-calling convention, in which functions that
8351 take a fixed number of arguments return with the @code{ret} @var{num}
8352 instruction, which pops their arguments while returning.  This saves one
8353 instruction in the caller since there is no need to pop the arguments
8354 there.
8355
8356 You can specify that an individual function is called with this calling
8357 sequence with the function attribute @samp{stdcall}.  You can also
8358 override the @option{-mrtd} option by using the function attribute
8359 @samp{cdecl}.  @xref{Function Attributes}.
8360
8361 @strong{Warning:} this calling convention is incompatible with the one
8362 normally used on Unix, so you cannot use it if you need to call
8363 libraries compiled with the Unix compiler.
8364
8365 Also, you must provide function prototypes for all functions that
8366 take variable numbers of arguments (including @code{printf});
8367 otherwise incorrect code will be generated for calls to those
8368 functions.
8369
8370 In addition, seriously incorrect code will result if you call a
8371 function with too many arguments.  (Normally, extra arguments are
8372 harmlessly ignored.)
8373
8374 @item -mregparm=@var{num}
8375 @opindex mregparm
8376 Control how many registers are used to pass integer arguments.  By
8377 default, no registers are used to pass arguments, and at most 3
8378 registers can be used.  You can control this behavior for a specific
8379 function by using the function attribute @samp{regparm}.
8380 @xref{Function Attributes}.
8381
8382 @strong{Warning:} if you use this switch, and
8383 @var{num} is nonzero, then you must build all modules with the same
8384 value, including any libraries.  This includes the system libraries and
8385 startup modules.
8386
8387 @item -mpreferred-stack-boundary=@var{num}
8388 @opindex mpreferred-stack-boundary
8389 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8390 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8391 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8392 size (@option{-Os}), in which case the default is the minimum correct
8393 alignment (4 bytes for x86, and 8 bytes for x86-64).
8394
8395 On Pentium and PentiumPro, @code{double} and @code{long double} values
8396 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8397 suffer significant run time performance penalties.  On Pentium III, the
8398 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8399 penalties if it is not 16 byte aligned.
8400
8401 To ensure proper alignment of this values on the stack, the stack boundary
8402 must be as aligned as that required by any value stored on the stack.
8403 Further, every function must be generated such that it keeps the stack
8404 aligned.  Thus calling a function compiled with a higher preferred
8405 stack boundary from a function compiled with a lower preferred stack
8406 boundary will most likely misalign the stack.  It is recommended that
8407 libraries that use callbacks always use the default setting.
8408
8409 This extra alignment does consume extra stack space, and generally
8410 increases code size.  Code that is sensitive to stack space usage, such
8411 as embedded systems and operating system kernels, may want to reduce the
8412 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8413
8414 @item -mmmx
8415 @itemx -mno-mmx
8416 @item -msse
8417 @itemx -mno-sse
8418 @item -msse2
8419 @itemx -mno-sse2
8420 @item -mpni
8421 @itemx -mno-pni
8422 @item -m3dnow
8423 @itemx -mno-3dnow
8424 @opindex mmmx
8425 @opindex mno-mmx
8426 @opindex msse
8427 @opindex mno-sse
8428 @opindex m3dnow
8429 @opindex mno-3dnow
8430 These switches enable or disable the use of built-in functions that allow
8431 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8432
8433 @xref{X86 Built-in Functions}, for details of the functions enabled
8434 and disabled by these switches.
8435
8436 To have SSE/SSE2 instructions generated automatically from floating-point
8437 code, see @option{-mfpmath=sse}.
8438
8439 @item -mpush-args
8440 @itemx -mno-push-args
8441 @opindex mpush-args
8442 @opindex mno-push-args
8443 Use PUSH operations to store outgoing parameters.  This method is shorter
8444 and usually equally fast as method using SUB/MOV operations and is enabled
8445 by default.  In some cases disabling it may improve performance because of
8446 improved scheduling and reduced dependencies.
8447
8448 @item -maccumulate-outgoing-args
8449 @opindex maccumulate-outgoing-args
8450 If enabled, the maximum amount of space required for outgoing arguments will be
8451 computed in the function prologue.  This is faster on most modern CPUs
8452 because of reduced dependencies, improved scheduling and reduced stack usage
8453 when preferred stack boundary is not equal to 2.  The drawback is a notable
8454 increase in code size.  This switch implies @option{-mno-push-args}.
8455
8456 @item -mthreads
8457 @opindex mthreads
8458 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8459 on thread-safe exception handling must compile and link all code with the
8460 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8461 @option{-D_MT}; when linking, it links in a special thread helper library
8462 @option{-lmingwthrd} which cleans up per thread exception handling data.
8463
8464 @item -mno-align-stringops
8465 @opindex mno-align-stringops
8466 Do not align destination of inlined string operations.  This switch reduces
8467 code size and improves performance in case the destination is already aligned,
8468 but gcc don't know about it.
8469
8470 @item -minline-all-stringops
8471 @opindex minline-all-stringops
8472 By default GCC inlines string operations only when destination is known to be
8473 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8474 size, but may improve performance of code that depends on fast memcpy, strlen
8475 and memset for short lengths.
8476
8477 @item -momit-leaf-frame-pointer
8478 @opindex momit-leaf-frame-pointer
8479 Don't keep the frame pointer in a register for leaf functions.  This
8480 avoids the instructions to save, set up and restore frame pointers and
8481 makes an extra register available in leaf functions.  The option
8482 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8483 which might make debugging harder.
8484
8485 @item -mtls-direct-seg-refs
8486 @itemx -mno-tls-direct-seg-refs
8487 @opindex mtls-direct-seg-refs
8488 Controls whether TLS variables may be accessed with offsets from the
8489 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8490 or whether the thread base pointer must be added.  Whether or not this
8491 is legal depends on the operating system, and whether it maps the
8492 segment to cover the entire TLS area.
8493
8494 For systems that use GNU libc, the default is on.
8495 @end table
8496
8497 These @samp{-m} switches are supported in addition to the above
8498 on AMD x86-64 processors in 64-bit environments.
8499
8500 @table @gcctabopt
8501 @item -m32
8502 @itemx -m64
8503 @opindex m32
8504 @opindex m64
8505 Generate code for a 32-bit or 64-bit environment.
8506 The 32-bit environment sets int, long and pointer to 32 bits and
8507 generates code that runs on any i386 system.
8508 The 64-bit environment sets int to 32 bits and long and pointer
8509 to 64 bits and generates code for AMD's x86-64 architecture.
8510
8511 @item -mno-red-zone
8512 @opindex no-red-zone
8513 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8514 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8515 stack pointer that will not be modified by signal or interrupt handlers
8516 and therefore can be used for temporary data without adjusting the stack
8517 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8518
8519 @item -mcmodel=small
8520 @opindex mcmodel=small
8521 Generate code for the small code model: the program and its symbols must
8522 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8523 Programs can be statically or dynamically linked.  This is the default
8524 code model.
8525
8526 @item -mcmodel=kernel
8527 @opindex mcmodel=kernel
8528 Generate code for the kernel code model.  The kernel runs in the
8529 negative 2 GB of the address space.
8530 This model has to be used for Linux kernel code.
8531
8532 @item -mcmodel=medium
8533 @opindex mcmodel=medium
8534 Generate code for the medium model: The program is linked in the lower 2
8535 GB of the address space but symbols can be located anywhere in the
8536 address space.  Programs can be statically or dynamically linked, but
8537 building of shared libraries are not supported with the medium model.
8538
8539 @item -mcmodel=large
8540 @opindex mcmodel=large
8541 Generate code for the large model: This model makes no assumptions
8542 about addresses and sizes of sections.  Currently GCC does not implement
8543 this model.
8544 @end table
8545
8546 @node HPPA Options
8547 @subsection HPPA Options
8548 @cindex HPPA Options
8549
8550 These @samp{-m} options are defined for the HPPA family of computers:
8551
8552 @table @gcctabopt
8553 @item -march=@var{architecture-type}
8554 @opindex march
8555 Generate code for the specified architecture.  The choices for
8556 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8557 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8558 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8559 architecture option for your machine.  Code compiled for lower numbered
8560 architectures will run on higher numbered architectures, but not the
8561 other way around.
8562
8563 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8564 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8565 support.
8566
8567 @item -mpa-risc-1-0
8568 @itemx -mpa-risc-1-1
8569 @itemx -mpa-risc-2-0
8570 @opindex mpa-risc-1-0
8571 @opindex mpa-risc-1-1
8572 @opindex mpa-risc-2-0
8573 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8574
8575 @item -mbig-switch
8576 @opindex mbig-switch
8577 Generate code suitable for big switch tables.  Use this option only if
8578 the assembler/linker complain about out of range branches within a switch
8579 table.
8580
8581 @item -mjump-in-delay
8582 @opindex mjump-in-delay
8583 Fill delay slots of function calls with unconditional jump instructions
8584 by modifying the return pointer for the function call to be the target
8585 of the conditional jump.
8586
8587 @item -mdisable-fpregs
8588 @opindex mdisable-fpregs
8589 Prevent floating point registers from being used in any manner.  This is
8590 necessary for compiling kernels which perform lazy context switching of
8591 floating point registers.  If you use this option and attempt to perform
8592 floating point operations, the compiler will abort.
8593
8594 @item -mdisable-indexing
8595 @opindex mdisable-indexing
8596 Prevent the compiler from using indexing address modes.  This avoids some
8597 rather obscure problems when compiling MIG generated code under MACH@.
8598
8599 @item -mno-space-regs
8600 @opindex mno-space-regs
8601 Generate code that assumes the target has no space registers.  This allows
8602 GCC to generate faster indirect calls and use unscaled index address modes.
8603
8604 Such code is suitable for level 0 PA systems and kernels.
8605
8606 @item -mfast-indirect-calls
8607 @opindex mfast-indirect-calls
8608 Generate code that assumes calls never cross space boundaries.  This
8609 allows GCC to emit code which performs faster indirect calls.
8610
8611 This option will not work in the presence of shared libraries or nested
8612 functions.
8613
8614 @item -mlong-load-store
8615 @opindex mlong-load-store
8616 Generate 3-instruction load and store sequences as sometimes required by
8617 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8618 the HP compilers.
8619
8620 @item -mportable-runtime
8621 @opindex mportable-runtime
8622 Use the portable calling conventions proposed by HP for ELF systems.
8623
8624 @item -mgas
8625 @opindex mgas
8626 Enable the use of assembler directives only GAS understands.
8627
8628 @item -mschedule=@var{cpu-type}
8629 @opindex mschedule
8630 Schedule code according to the constraints for the machine type
8631 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8632 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8633 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8634 proper scheduling option for your machine.  The default scheduling is
8635 @samp{8000}.
8636
8637 @item -mlinker-opt
8638 @opindex mlinker-opt
8639 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8640 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8641 linkers in which they give bogus error messages when linking some programs.
8642
8643 @item -msoft-float
8644 @opindex msoft-float
8645 Generate output containing library calls for floating point.
8646 @strong{Warning:} the requisite libraries are not available for all HPPA
8647 targets.  Normally the facilities of the machine's usual C compiler are
8648 used, but this cannot be done directly in cross-compilation.  You must make
8649 your own arrangements to provide suitable library functions for
8650 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8651 does provide software floating point support.
8652
8653 @option{-msoft-float} changes the calling convention in the output file;
8654 therefore, it is only useful if you compile @emph{all} of a program with
8655 this option.  In particular, you need to compile @file{libgcc.a}, the
8656 library that comes with GCC, with @option{-msoft-float} in order for
8657 this to work.
8658
8659 @item -msio
8660 @opindex msio
8661 Generate the predefine, @code{_SIO}, for server IO.  The default is
8662 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8663 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8664 options are available under HP-UX and HI-UX.
8665
8666 @item -mgnu-ld
8667 @opindex gnu-ld
8668 Use GNU ld specific options.  This passes @option{-shared} to ld when
8669 building a shared library.  It is the default when GCC is configured,
8670 explicitly or implicitly, with the GNU linker.  This option does not
8671 have any affect on which ld is called, it only changes what parameters
8672 are passed to that ld.  The ld that is called is determined by the
8673 @option{--with-ld} configure option, gcc's program search path, and
8674 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8675 using @samp{which `gcc -print-prog-name=ld`}.
8676
8677 @item -mhp-ld
8678 @opindex hp-ld
8679 Use HP ld specific options.  This passes @option{-b} to ld when building
8680 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8681 links.  It is the default when GCC is configured, explicitly or
8682 implicitly, with the HP linker.  This option does not have any affect on
8683 which ld is called, it only changes what parameters are passed to that
8684 ld.  The ld that is called is determined by the @option{--with-ld}
8685 configure option, gcc's program search path, and finally by the user's
8686 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8687 `gcc -print-prog-name=ld`}.
8688
8689 @item -mlong-calls
8690 @opindex mno-long-calls
8691 Generate code that uses long call sequences.  This ensures that a call
8692 is always able to reach linker generated stubs.  The default is to generate
8693 long calls only when the distance from the call site to the beginning
8694 of the function or translation unit, as the case may be, exceeds a
8695 predefined limit set by the branch type being used.  The limits for
8696 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8697 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8698 240,000 bytes.
8699
8700 Distances are measured from the beginning of functions when using the
8701 @option{-ffunction-sections} option, or when using the @option{-mgas}
8702 and @option{-mno-portable-runtime} options together under HP-UX with
8703 the SOM linker.
8704
8705 It is normally not desirable to use this option as it will degrade
8706 performance.  However, it may be useful in large applications,
8707 particularly when partial linking is used to build the application.
8708
8709 The types of long calls used depends on the capabilities of the
8710 assembler and linker, and the type of code being generated.  The
8711 impact on systems that support long absolute calls, and long pic
8712 symbol-difference or pc-relative calls should be relatively small.
8713 However, an indirect call is used on 32-bit ELF systems in pic code
8714 and it is quite long.
8715
8716 @item -nolibdld
8717 @opindex nolibdld
8718 Suppress the generation of link options to search libdld.sl when the
8719 @option{-static} option is specified on HP-UX 10 and later.
8720
8721 @item -static
8722 @opindex static
8723 The HP-UX implementation of setlocale in libc has a dependency on
8724 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8725 when the @option{-static} option is specified, special link options
8726 are needed to resolve this dependency.
8727
8728 On HP-UX 10 and later, the GCC driver adds the necessary options to
8729 link with libdld.sl when the @option{-static} option is specified.
8730 This causes the resulting binary to be dynamic.  On the 64-bit port,
8731 the linkers generate dynamic binaries by default in any case.  The
8732 @option{-nolibdld} option can be used to prevent the GCC driver from
8733 adding these link options.
8734
8735 @item -threads
8736 @opindex threads
8737 Add support for multithreading with the @dfn{dce thread} library
8738 under HP-UX.  This option sets flags for both the preprocessor and
8739 linker.
8740 @end table
8741
8742 @node Intel 960 Options
8743 @subsection Intel 960 Options
8744
8745 These @samp{-m} options are defined for the Intel 960 implementations:
8746
8747 @table @gcctabopt
8748 @item -m@var{cpu-type}
8749 @opindex mka
8750 @opindex mkb
8751 @opindex mmc
8752 @opindex mca
8753 @opindex mcf
8754 @opindex msa
8755 @opindex msb
8756 Assume the defaults for the machine type @var{cpu-type} for some of
8757 the other options, including instruction scheduling, floating point
8758 support, and addressing modes.  The choices for @var{cpu-type} are
8759 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8760 @samp{sa}, and @samp{sb}.
8761 The default is
8762 @samp{kb}.
8763
8764 @item -mnumerics
8765 @itemx -msoft-float
8766 @opindex mnumerics
8767 @opindex msoft-float
8768 The @option{-mnumerics} option indicates that the processor does support
8769 floating-point instructions.  The @option{-msoft-float} option indicates
8770 that floating-point support should not be assumed.
8771
8772 @item -mleaf-procedures
8773 @itemx -mno-leaf-procedures
8774 @opindex mleaf-procedures
8775 @opindex mno-leaf-procedures
8776 Do (or do not) attempt to alter leaf procedures to be callable with the
8777 @code{bal} instruction as well as @code{call}.  This will result in more
8778 efficient code for explicit calls when the @code{bal} instruction can be
8779 substituted by the assembler or linker, but less efficient code in other
8780 cases, such as calls via function pointers, or using a linker that doesn't
8781 support this optimization.
8782
8783 @item -mtail-call
8784 @itemx -mno-tail-call
8785 @opindex mtail-call
8786 @opindex mno-tail-call
8787 Do (or do not) make additional attempts (beyond those of the
8788 machine-independent portions of the compiler) to optimize tail-recursive
8789 calls into branches.  You may not want to do this because the detection of
8790 cases where this is not valid is not totally complete.  The default is
8791 @option{-mno-tail-call}.
8792
8793 @item -mcomplex-addr
8794 @itemx -mno-complex-addr
8795 @opindex mcomplex-addr
8796 @opindex mno-complex-addr
8797 Assume (or do not assume) that the use of a complex addressing mode is a
8798 win on this implementation of the i960.  Complex addressing modes may not
8799 be worthwhile on the K-series, but they definitely are on the C-series.
8800 The default is currently @option{-mcomplex-addr} for all processors except
8801 the CB and CC@.
8802
8803 @item -mcode-align
8804 @itemx -mno-code-align
8805 @opindex mcode-align
8806 @opindex mno-code-align
8807 Align code to 8-byte boundaries for faster fetching (or don't bother).
8808 Currently turned on by default for C-series implementations only.
8809
8810 @ignore
8811 @item -mclean-linkage
8812 @itemx -mno-clean-linkage
8813 @opindex mclean-linkage
8814 @opindex mno-clean-linkage
8815 These options are not fully implemented.
8816 @end ignore
8817
8818 @item -mic-compat
8819 @itemx -mic2.0-compat
8820 @itemx -mic3.0-compat
8821 @opindex mic-compat
8822 @opindex mic2.0-compat
8823 @opindex mic3.0-compat
8824 Enable compatibility with iC960 v2.0 or v3.0.
8825
8826 @item -masm-compat
8827 @itemx -mintel-asm
8828 @opindex masm-compat
8829 @opindex mintel-asm
8830 Enable compatibility with the iC960 assembler.
8831
8832 @item -mstrict-align
8833 @itemx -mno-strict-align
8834 @opindex mstrict-align
8835 @opindex mno-strict-align
8836 Do not permit (do permit) unaligned accesses.
8837
8838 @item -mold-align
8839 @opindex mold-align
8840 Enable structure-alignment compatibility with Intel's gcc release version
8841 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8842
8843 @item -mlong-double-64
8844 @opindex mlong-double-64
8845 Implement type @samp{long double} as 64-bit floating point numbers.
8846 Without the option @samp{long double} is implemented by 80-bit
8847 floating point numbers.  The only reason we have it because there is
8848 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8849 is only useful for people using soft-float targets.  Otherwise, we
8850 should recommend against use of it.
8851
8852 @end table
8853
8854 @node DEC Alpha Options
8855 @subsection DEC Alpha Options
8856
8857 These @samp{-m} options are defined for the DEC Alpha implementations:
8858
8859 @table @gcctabopt
8860 @item -mno-soft-float
8861 @itemx -msoft-float
8862 @opindex mno-soft-float
8863 @opindex msoft-float
8864 Use (do not use) the hardware floating-point instructions for
8865 floating-point operations.  When @option{-msoft-float} is specified,
8866 functions in @file{libgcc.a} will be used to perform floating-point
8867 operations.  Unless they are replaced by routines that emulate the
8868 floating-point operations, or compiled in such a way as to call such
8869 emulations routines, these routines will issue floating-point
8870 operations.   If you are compiling for an Alpha without floating-point
8871 operations, you must ensure that the library is built so as not to call
8872 them.
8873
8874 Note that Alpha implementations without floating-point operations are
8875 required to have floating-point registers.
8876
8877 @item -mfp-reg
8878 @itemx -mno-fp-regs
8879 @opindex mfp-reg
8880 @opindex mno-fp-regs
8881 Generate code that uses (does not use) the floating-point register set.
8882 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8883 register set is not used, floating point operands are passed in integer
8884 registers as if they were integers and floating-point results are passed
8885 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8886 so any function with a floating-point argument or return value called by code
8887 compiled with @option{-mno-fp-regs} must also be compiled with that
8888 option.
8889
8890 A typical use of this option is building a kernel that does not use,
8891 and hence need not save and restore, any floating-point registers.
8892
8893 @item -mieee
8894 @opindex mieee
8895 The Alpha architecture implements floating-point hardware optimized for
8896 maximum performance.  It is mostly compliant with the IEEE floating
8897 point standard.  However, for full compliance, software assistance is
8898 required.  This option generates code fully IEEE compliant code
8899 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8900 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8901 defined during compilation.  The resulting code is less efficient but is
8902 able to correctly support denormalized numbers and exceptional IEEE
8903 values such as not-a-number and plus/minus infinity.  Other Alpha
8904 compilers call this option @option{-ieee_with_no_inexact}.
8905
8906 @item -mieee-with-inexact
8907 @opindex mieee-with-inexact
8908 This is like @option{-mieee} except the generated code also maintains
8909 the IEEE @var{inexact-flag}.  Turning on this option causes the
8910 generated code to implement fully-compliant IEEE math.  In addition to
8911 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8912 macro.  On some Alpha implementations the resulting code may execute
8913 significantly slower than the code generated by default.  Since there is
8914 very little code that depends on the @var{inexact-flag}, you should
8915 normally not specify this option.  Other Alpha compilers call this
8916 option @option{-ieee_with_inexact}.
8917
8918 @item -mfp-trap-mode=@var{trap-mode}
8919 @opindex mfp-trap-mode
8920 This option controls what floating-point related traps are enabled.
8921 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8922 The trap mode can be set to one of four values:
8923
8924 @table @samp
8925 @item n
8926 This is the default (normal) setting.  The only traps that are enabled
8927 are the ones that cannot be disabled in software (e.g., division by zero
8928 trap).
8929
8930 @item u
8931 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8932 as well.
8933
8934 @item su
8935 Like @samp{su}, but the instructions are marked to be safe for software
8936 completion (see Alpha architecture manual for details).
8937
8938 @item sui
8939 Like @samp{su}, but inexact traps are enabled as well.
8940 @end table
8941
8942 @item -mfp-rounding-mode=@var{rounding-mode}
8943 @opindex mfp-rounding-mode
8944 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8945 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8946 of:
8947
8948 @table @samp
8949 @item n
8950 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8951 the nearest machine number or towards the even machine number in case
8952 of a tie.
8953
8954 @item m
8955 Round towards minus infinity.
8956
8957 @item c
8958 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8959
8960 @item d
8961 Dynamic rounding mode.  A field in the floating point control register
8962 (@var{fpcr}, see Alpha architecture reference manual) controls the
8963 rounding mode in effect.  The C library initializes this register for
8964 rounding towards plus infinity.  Thus, unless your program modifies the
8965 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8966 @end table
8967
8968 @item -mtrap-precision=@var{trap-precision}
8969 @opindex mtrap-precision
8970 In the Alpha architecture, floating point traps are imprecise.  This
8971 means without software assistance it is impossible to recover from a
8972 floating trap and program execution normally needs to be terminated.
8973 GCC can generate code that can assist operating system trap handlers
8974 in determining the exact location that caused a floating point trap.
8975 Depending on the requirements of an application, different levels of
8976 precisions can be selected:
8977
8978 @table @samp
8979 @item p
8980 Program precision.  This option is the default and means a trap handler
8981 can only identify which program caused a floating point exception.
8982
8983 @item f
8984 Function precision.  The trap handler can determine the function that
8985 caused a floating point exception.
8986
8987 @item i
8988 Instruction precision.  The trap handler can determine the exact
8989 instruction that caused a floating point exception.
8990 @end table
8991
8992 Other Alpha compilers provide the equivalent options called
8993 @option{-scope_safe} and @option{-resumption_safe}.
8994
8995 @item -mieee-conformant
8996 @opindex mieee-conformant
8997 This option marks the generated code as IEEE conformant.  You must not
8998 use this option unless you also specify @option{-mtrap-precision=i} and either
8999 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9000 is to emit the line @samp{.eflag 48} in the function prologue of the
9001 generated assembly file.  Under DEC Unix, this has the effect that
9002 IEEE-conformant math library routines will be linked in.
9003
9004 @item -mbuild-constants
9005 @opindex mbuild-constants
9006 Normally GCC examines a 32- or 64-bit integer constant to
9007 see if it can construct it from smaller constants in two or three
9008 instructions.  If it cannot, it will output the constant as a literal and
9009 generate code to load it from the data segment at runtime.
9010
9011 Use this option to require GCC to construct @emph{all} integer constants
9012 using code, even if it takes more instructions (the maximum is six).
9013
9014 You would typically use this option to build a shared library dynamic
9015 loader.  Itself a shared library, it must relocate itself in memory
9016 before it can find the variables and constants in its own data segment.
9017
9018 @item -malpha-as
9019 @itemx -mgas
9020 @opindex malpha-as
9021 @opindex mgas
9022 Select whether to generate code to be assembled by the vendor-supplied
9023 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9024
9025 @item -mbwx
9026 @itemx -mno-bwx
9027 @itemx -mcix
9028 @itemx -mno-cix
9029 @itemx -mfix
9030 @itemx -mno-fix
9031 @itemx -mmax
9032 @itemx -mno-max
9033 @opindex mbwx
9034 @opindex mno-bwx
9035 @opindex mcix
9036 @opindex mno-cix
9037 @opindex mfix
9038 @opindex mno-fix
9039 @opindex mmax
9040 @opindex mno-max
9041 Indicate whether GCC should generate code to use the optional BWX,
9042 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9043 sets supported by the CPU type specified via @option{-mcpu=} option or that
9044 of the CPU on which GCC was built if none was specified.
9045
9046 @item -mfloat-vax
9047 @itemx -mfloat-ieee
9048 @opindex mfloat-vax
9049 @opindex mfloat-ieee
9050 Generate code that uses (does not use) VAX F and G floating point
9051 arithmetic instead of IEEE single and double precision.
9052
9053 @item -mexplicit-relocs
9054 @itemx -mno-explicit-relocs
9055 @opindex mexplicit-relocs
9056 @opindex mno-explicit-relocs
9057 Older Alpha assemblers provided no way to generate symbol relocations
9058 except via assembler macros.  Use of these macros does not allow
9059 optimal instruction scheduling.  GNU binutils as of version 2.12
9060 supports a new syntax that allows the compiler to explicitly mark
9061 which relocations should apply to which instructions.  This option
9062 is mostly useful for debugging, as GCC detects the capabilities of
9063 the assembler when it is built and sets the default accordingly.
9064
9065 @item -msmall-data
9066 @itemx -mlarge-data
9067 @opindex msmall-data
9068 @opindex mlarge-data
9069 When @option{-mexplicit-relocs} is in effect, static data is
9070 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9071 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9072 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9073 16-bit relocations off of the @code{$gp} register.  This limits the
9074 size of the small data area to 64KB, but allows the variables to be
9075 directly accessed via a single instruction.
9076
9077 The default is @option{-mlarge-data}.  With this option the data area
9078 is limited to just below 2GB.  Programs that require more than 2GB of
9079 data must use @code{malloc} or @code{mmap} to allocate the data in the
9080 heap instead of in the program's data segment.
9081
9082 When generating code for shared libraries, @option{-fpic} implies
9083 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9084
9085 @item -msmall-text
9086 @itemx -mlarge-text
9087 @opindex msmall-text
9088 @opindex mlarge-text
9089 When @option{-msmall-text} is used, the compiler assumes that the
9090 code of the entire program (or shared library) fits in 4MB, and is
9091 thus reachable with a branch instruction.  When @option{-msmall-data}
9092 is used, the compiler can assume that all local symbols share the
9093 same @code{$gp} value, and thus reduce the number of instructions
9094 required for a function call from 4 to 1.
9095
9096 The default is @option{-mlarge-text}.
9097
9098 @item -mcpu=@var{cpu_type}
9099 @opindex mcpu
9100 Set the instruction set and instruction scheduling parameters for
9101 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9102 style name or the corresponding chip number.  GCC supports scheduling
9103 parameters for the EV4, EV5 and EV6 family of processors and will
9104 choose the default values for the instruction set from the processor
9105 you specify.  If you do not specify a processor type, GCC will default
9106 to the processor on which the compiler was built.
9107
9108 Supported values for @var{cpu_type} are
9109
9110 @table @samp
9111 @item ev4
9112 @itemx ev45
9113 @itemx 21064
9114 Schedules as an EV4 and has no instruction set extensions.
9115
9116 @item ev5
9117 @itemx 21164
9118 Schedules as an EV5 and has no instruction set extensions.
9119
9120 @item ev56
9121 @itemx 21164a
9122 Schedules as an EV5 and supports the BWX extension.
9123
9124 @item pca56
9125 @itemx 21164pc
9126 @itemx 21164PC
9127 Schedules as an EV5 and supports the BWX and MAX extensions.
9128
9129 @item ev6
9130 @itemx 21264
9131 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9132
9133 @item ev67
9134 @itemx 21264a
9135 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9136 @end table
9137
9138 @item -mtune=@var{cpu_type}
9139 @opindex mtune
9140 Set only the instruction scheduling parameters for machine type
9141 @var{cpu_type}.  The instruction set is not changed.
9142
9143 @item -mmemory-latency=@var{time}
9144 @opindex mmemory-latency
9145 Sets the latency the scheduler should assume for typical memory
9146 references as seen by the application.  This number is highly
9147 dependent on the memory access patterns used by the application
9148 and the size of the external cache on the machine.
9149
9150 Valid options for @var{time} are
9151
9152 @table @samp
9153 @item @var{number}
9154 A decimal number representing clock cycles.
9155
9156 @item L1
9157 @itemx L2
9158 @itemx L3
9159 @itemx main
9160 The compiler contains estimates of the number of clock cycles for
9161 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9162 (also called Dcache, Scache, and Bcache), as well as to main memory.
9163 Note that L3 is only valid for EV5.
9164
9165 @end table
9166 @end table
9167
9168 @node DEC Alpha/VMS Options
9169 @subsection DEC Alpha/VMS Options
9170
9171 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9172
9173 @table @gcctabopt
9174 @item -mvms-return-codes
9175 @opindex mvms-return-codes
9176 Return VMS condition codes from main.  The default is to return POSIX
9177 style condition (e.g.@ error) codes.
9178 @end table
9179
9180 @node H8/300 Options
9181 @subsection H8/300 Options
9182
9183 These @samp{-m} options are defined for the H8/300 implementations:
9184
9185 @table @gcctabopt
9186 @item -mrelax
9187 @opindex mrelax
9188 Shorten some address references at link time, when possible; uses the
9189 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9190 ld, Using ld}, for a fuller description.
9191
9192 @item -mh
9193 @opindex mh
9194 Generate code for the H8/300H@.
9195
9196 @item -ms
9197 @opindex ms
9198 Generate code for the H8S@.
9199
9200 @item -mn
9201 @opindex mn
9202 Generate code for the H8S and H8/300H in the normal mode.  This switch
9203 must be used either with -mh or -ms.
9204
9205 @item -ms2600
9206 @opindex ms2600
9207 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9208
9209 @item -mint32
9210 @opindex mint32
9211 Make @code{int} data 32 bits by default.
9212
9213 @item -malign-300
9214 @opindex malign-300
9215 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9216 The default for the H8/300H and H8S is to align longs and floats on 4
9217 byte boundaries.
9218 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9219 This option has no effect on the H8/300.
9220 @end table
9221
9222 @node SH Options
9223 @subsection SH Options
9224
9225 These @samp{-m} options are defined for the SH implementations:
9226
9227 @table @gcctabopt
9228 @item -m1
9229 @opindex m1
9230 Generate code for the SH1.
9231
9232 @item -m2
9233 @opindex m2
9234 Generate code for the SH2.
9235
9236 @item -m2e
9237 Generate code for the SH2e.
9238
9239 @item -m3
9240 @opindex m3
9241 Generate code for the SH3.
9242
9243 @item -m3e
9244 @opindex m3e
9245 Generate code for the SH3e.
9246
9247 @item -m4-nofpu
9248 @opindex m4-nofpu
9249 Generate code for the SH4 without a floating-point unit.
9250
9251 @item -m4-single-only
9252 @opindex m4-single-only
9253 Generate code for the SH4 with a floating-point unit that only
9254 supports single-precision arithmetic.
9255
9256 @item -m4-single
9257 @opindex m4-single
9258 Generate code for the SH4 assuming the floating-point unit is in
9259 single-precision mode by default.
9260
9261 @item -m4
9262 @opindex m4
9263 Generate code for the SH4.
9264
9265 @item -mb
9266 @opindex mb
9267 Compile code for the processor in big endian mode.
9268
9269 @item -ml
9270 @opindex ml
9271 Compile code for the processor in little endian mode.
9272
9273 @item -mdalign
9274 @opindex mdalign
9275 Align doubles at 64-bit boundaries.  Note that this changes the calling
9276 conventions, and thus some functions from the standard C library will
9277 not work unless you recompile it first with @option{-mdalign}.
9278
9279 @item -mrelax
9280 @opindex mrelax
9281 Shorten some address references at link time, when possible; uses the
9282 linker option @option{-relax}.
9283
9284 @item -mbigtable
9285 @opindex mbigtable
9286 Use 32-bit offsets in @code{switch} tables.  The default is to use
9287 16-bit offsets.
9288
9289 @item -mfmovd
9290 @opindex mfmovd
9291 Enable the use of the instruction @code{fmovd}.
9292
9293 @item -mhitachi
9294 @opindex mhitachi
9295 Comply with the calling conventions defined by Renesas.
9296
9297 @item -mnomacsave
9298 @opindex mnomacsave
9299 Mark the @code{MAC} register as call-clobbered, even if
9300 @option{-mhitachi} is given.
9301
9302 @item -mieee
9303 @opindex mieee
9304 Increase IEEE-compliance of floating-point code.
9305
9306 @item -misize
9307 @opindex misize
9308 Dump instruction size and location in the assembly code.
9309
9310 @item -mpadstruct
9311 @opindex mpadstruct
9312 This option is deprecated.  It pads structures to multiple of 4 bytes,
9313 which is incompatible with the SH ABI@.
9314
9315 @item -mspace
9316 @opindex mspace
9317 Optimize for space instead of speed.  Implied by @option{-Os}.
9318
9319 @item -mprefergot
9320 @opindex mprefergot
9321 When generating position-independent code, emit function calls using
9322 the Global Offset Table instead of the Procedure Linkage Table.
9323
9324 @item -musermode
9325 @opindex musermode
9326 Generate a library function call to invalidate instruction cache
9327 entries, after fixing up a trampoline.  This library function call
9328 doesn't assume it can write to the whole memory address space.  This
9329 is the default when the target is @code{sh-*-linux*}.
9330 @end table
9331
9332 @node System V Options
9333 @subsection Options for System V
9334
9335 These additional options are available on System V Release 4 for
9336 compatibility with other compilers on those systems:
9337
9338 @table @gcctabopt
9339 @item -G
9340 @opindex G
9341 Create a shared object.
9342 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9343
9344 @item -Qy
9345 @opindex Qy
9346 Identify the versions of each tool used by the compiler, in a
9347 @code{.ident} assembler directive in the output.
9348
9349 @item -Qn
9350 @opindex Qn
9351 Refrain from adding @code{.ident} directives to the output file (this is
9352 the default).
9353
9354 @item -YP,@var{dirs}
9355 @opindex YP
9356 Search the directories @var{dirs}, and no others, for libraries
9357 specified with @option{-l}.
9358
9359 @item -Ym,@var{dir}
9360 @opindex Ym
9361 Look in the directory @var{dir} to find the M4 preprocessor.
9362 The assembler uses this option.
9363 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9364 @c the generic assembler that comes with Solaris takes just -Ym.
9365 @end table
9366
9367 @node TMS320C3x/C4x Options
9368 @subsection TMS320C3x/C4x Options
9369 @cindex TMS320C3x/C4x Options
9370
9371 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9372
9373 @table @gcctabopt
9374
9375 @item -mcpu=@var{cpu_type}
9376 @opindex mcpu
9377 Set the instruction set, register set, and instruction scheduling
9378 parameters for machine type @var{cpu_type}.  Supported values for
9379 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9380 @samp{c44}.  The default is @samp{c40} to generate code for the
9381 TMS320C40.
9382
9383 @item -mbig-memory
9384 @itemx -mbig
9385 @itemx -msmall-memory
9386 @itemx -msmall
9387 @opindex mbig-memory
9388 @opindex mbig
9389 @opindex msmall-memory
9390 @opindex msmall
9391 Generates code for the big or small memory model.  The small memory
9392 model assumed that all data fits into one 64K word page.  At run-time
9393 the data page (DP) register must be set to point to the 64K page
9394 containing the .bss and .data program sections.  The big memory model is
9395 the default and requires reloading of the DP register for every direct
9396 memory access.
9397
9398 @item -mbk
9399 @itemx -mno-bk
9400 @opindex mbk
9401 @opindex mno-bk
9402 Allow (disallow) allocation of general integer operands into the block
9403 count register BK@.
9404
9405 @item -mdb
9406 @itemx -mno-db
9407 @opindex mdb
9408 @opindex mno-db
9409 Enable (disable) generation of code using decrement and branch,
9410 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9411 on the safe side, this is disabled for the C3x, since the maximum
9412 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9413 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9414 that it can utilize the decrement and branch instruction, but will give
9415 up if there is more than one memory reference in the loop.  Thus a loop
9416 where the loop counter is decremented can generate slightly more
9417 efficient code, in cases where the RPTB instruction cannot be utilized.
9418
9419 @item -mdp-isr-reload
9420 @itemx -mparanoid
9421 @opindex mdp-isr-reload
9422 @opindex mparanoid
9423 Force the DP register to be saved on entry to an interrupt service
9424 routine (ISR), reloaded to point to the data section, and restored on
9425 exit from the ISR@.  This should not be required unless someone has
9426 violated the small memory model by modifying the DP register, say within
9427 an object library.
9428
9429 @item -mmpyi
9430 @itemx -mno-mpyi
9431 @opindex mmpyi
9432 @opindex mno-mpyi
9433 For the C3x use the 24-bit MPYI instruction for integer multiplies
9434 instead of a library call to guarantee 32-bit results.  Note that if one
9435 of the operands is a constant, then the multiplication will be performed
9436 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9437 then squaring operations are performed inline instead of a library call.
9438
9439 @item -mfast-fix
9440 @itemx -mno-fast-fix
9441 @opindex mfast-fix
9442 @opindex mno-fast-fix
9443 The C3x/C4x FIX instruction to convert a floating point value to an
9444 integer value chooses the nearest integer less than or equal to the
9445 floating point value rather than to the nearest integer.  Thus if the
9446 floating point number is negative, the result will be incorrectly
9447 truncated an additional code is necessary to detect and correct this
9448 case.  This option can be used to disable generation of the additional
9449 code required to correct the result.
9450
9451 @item -mrptb
9452 @itemx -mno-rptb
9453 @opindex mrptb
9454 @opindex mno-rptb
9455 Enable (disable) generation of repeat block sequences using the RPTB
9456 instruction for zero overhead looping.  The RPTB construct is only used
9457 for innermost loops that do not call functions or jump across the loop
9458 boundaries.  There is no advantage having nested RPTB loops due to the
9459 overhead required to save and restore the RC, RS, and RE registers.
9460 This is enabled by default with @option{-O2}.
9461
9462 @item -mrpts=@var{count}
9463 @itemx -mno-rpts
9464 @opindex mrpts
9465 @opindex mno-rpts
9466 Enable (disable) the use of the single instruction repeat instruction
9467 RPTS@.  If a repeat block contains a single instruction, and the loop
9468 count can be guaranteed to be less than the value @var{count}, GCC will
9469 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9470 then a RPTS will be emitted even if the loop count cannot be determined
9471 at compile time.  Note that the repeated instruction following RPTS does
9472 not have to be reloaded from memory each iteration, thus freeing up the
9473 CPU buses for operands.  However, since interrupts are blocked by this
9474 instruction, it is disabled by default.
9475
9476 @item -mloop-unsigned
9477 @itemx -mno-loop-unsigned
9478 @opindex mloop-unsigned
9479 @opindex mno-loop-unsigned
9480 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9481 is @math{2^{31} + 1} since these instructions test if the iteration count is
9482 negative to terminate the loop.  If the iteration count is unsigned
9483 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9484 exceeded.  This switch allows an unsigned iteration count.
9485
9486 @item -mti
9487 @opindex mti
9488 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9489 with.  This also enforces compatibility with the API employed by the TI
9490 C3x C compiler.  For example, long doubles are passed as structures
9491 rather than in floating point registers.
9492
9493 @item -mregparm
9494 @itemx -mmemparm
9495 @opindex mregparm
9496 @opindex mmemparm
9497 Generate code that uses registers (stack) for passing arguments to functions.
9498 By default, arguments are passed in registers where possible rather
9499 than by pushing arguments on to the stack.
9500
9501 @item -mparallel-insns
9502 @itemx -mno-parallel-insns
9503 @opindex mparallel-insns
9504 @opindex mno-parallel-insns
9505 Allow the generation of parallel instructions.  This is enabled by
9506 default with @option{-O2}.
9507
9508 @item -mparallel-mpy
9509 @itemx -mno-parallel-mpy
9510 @opindex mparallel-mpy
9511 @opindex mno-parallel-mpy
9512 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9513 provided @option{-mparallel-insns} is also specified.  These instructions have
9514 tight register constraints which can pessimize the code generation
9515 of large functions.
9516
9517 @end table
9518
9519 @node V850 Options
9520 @subsection V850 Options
9521 @cindex V850 Options
9522
9523 These @samp{-m} options are defined for V850 implementations:
9524
9525 @table @gcctabopt
9526 @item -mlong-calls
9527 @itemx -mno-long-calls
9528 @opindex mlong-calls
9529 @opindex mno-long-calls
9530 Treat all calls as being far away (near).  If calls are assumed to be
9531 far away, the compiler will always load the functions address up into a
9532 register, and call indirect through the pointer.
9533
9534 @item -mno-ep
9535 @itemx -mep
9536 @opindex mno-ep
9537 @opindex mep
9538 Do not optimize (do optimize) basic blocks that use the same index
9539 pointer 4 or more times to copy pointer into the @code{ep} register, and
9540 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9541 option is on by default if you optimize.
9542
9543 @item -mno-prolog-function
9544 @itemx -mprolog-function
9545 @opindex mno-prolog-function
9546 @opindex mprolog-function
9547 Do not use (do use) external functions to save and restore registers
9548 at the prologue and epilogue of a function.  The external functions
9549 are slower, but use less code space if more than one function saves
9550 the same number of registers.  The @option{-mprolog-function} option
9551 is on by default if you optimize.
9552
9553 @item -mspace
9554 @opindex mspace
9555 Try to make the code as small as possible.  At present, this just turns
9556 on the @option{-mep} and @option{-mprolog-function} options.
9557
9558 @item -mtda=@var{n}
9559 @opindex mtda
9560 Put static or global variables whose size is @var{n} bytes or less into
9561 the tiny data area that register @code{ep} points to.  The tiny data
9562 area can hold up to 256 bytes in total (128 bytes for byte references).
9563
9564 @item -msda=@var{n}
9565 @opindex msda
9566 Put static or global variables whose size is @var{n} bytes or less into
9567 the small data area that register @code{gp} points to.  The small data
9568 area can hold up to 64 kilobytes.
9569
9570 @item -mzda=@var{n}
9571 @opindex mzda
9572 Put static or global variables whose size is @var{n} bytes or less into
9573 the first 32 kilobytes of memory.
9574
9575 @item -mv850
9576 @opindex mv850
9577 Specify that the target processor is the V850.
9578
9579 @item -mbig-switch
9580 @opindex mbig-switch
9581 Generate code suitable for big switch tables.  Use this option only if
9582 the assembler/linker complain about out of range branches within a switch
9583 table.
9584
9585 @item -mapp-regs
9586 @opindex mapp-regs
9587 This option will cause r2 and r5 to be used in the code generated by
9588 the compiler.  This setting is the default.
9589
9590 @item -mno-app-regs
9591 @opindex mno-app-regs
9592 This option will cause r2 and r5 to be treated as fixed registers.
9593
9594 @item -mv850e1
9595 @opindex mv850e1
9596 Specify that the target processor is the V850E1.  The preprocessor
9597 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9598 this option is used.
9599
9600 @item -mv850e
9601 @opindex mv850e
9602 Specify that the target processor is the V850E.  The preprocessor
9603 constant @samp{__v850e__} will be defined if this option is used.
9604
9605 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9606 are defined then a default target processor will be chosen and the
9607 relevant @samp{__v850*__} preprocessor constant will be defined.
9608
9609 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9610 defined, regardless of which processor variant is the target.
9611
9612 @item -mdisable-callt
9613 @opindex mdisable-callt
9614 This option will suppress generation of the CALLT instruction for the
9615 v850e and v850e1 flavors of the v850 architecture.  The default is
9616 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9617
9618 @end table
9619
9620 @node ARC Options
9621 @subsection ARC Options
9622 @cindex ARC Options
9623
9624 These options are defined for ARC implementations:
9625
9626 @table @gcctabopt
9627 @item -EL
9628 @opindex EL
9629 Compile code for little endian mode.  This is the default.
9630
9631 @item -EB
9632 @opindex EB
9633 Compile code for big endian mode.
9634
9635 @item -mmangle-cpu
9636 @opindex mmangle-cpu
9637 Prepend the name of the cpu to all public symbol names.
9638 In multiple-processor systems, there are many ARC variants with different
9639 instruction and register set characteristics.  This flag prevents code
9640 compiled for one cpu to be linked with code compiled for another.
9641 No facility exists for handling variants that are ``almost identical''.
9642 This is an all or nothing option.
9643
9644 @item -mcpu=@var{cpu}
9645 @opindex mcpu
9646 Compile code for ARC variant @var{cpu}.
9647 Which variants are supported depend on the configuration.
9648 All variants support @option{-mcpu=base}, this is the default.
9649
9650 @item -mtext=@var{text-section}
9651 @itemx -mdata=@var{data-section}
9652 @itemx -mrodata=@var{readonly-data-section}
9653 @opindex mtext
9654 @opindex mdata
9655 @opindex mrodata
9656 Put functions, data, and readonly data in @var{text-section},
9657 @var{data-section}, and @var{readonly-data-section} respectively
9658 by default.  This can be overridden with the @code{section} attribute.
9659 @xref{Variable Attributes}.
9660
9661 @end table
9662
9663 @node NS32K Options
9664 @subsection NS32K Options
9665 @cindex NS32K options
9666
9667 These are the @samp{-m} options defined for the 32000 series.  The default
9668 values for these options depends on which style of 32000 was selected when
9669 the compiler was configured; the defaults for the most common choices are
9670 given below.
9671
9672 @table @gcctabopt
9673 @item -m32032
9674 @itemx -m32032
9675 @opindex m32032
9676 @opindex m32032
9677 Generate output for a 32032.  This is the default
9678 when the compiler is configured for 32032 and 32016 based systems.
9679
9680 @item -m32332
9681 @itemx -m32332
9682 @opindex m32332
9683 @opindex m32332
9684 Generate output for a 32332.  This is the default
9685 when the compiler is configured for 32332-based systems.
9686
9687 @item -m32532
9688 @itemx -m32532
9689 @opindex m32532
9690 @opindex m32532
9691 Generate output for a 32532.  This is the default
9692 when the compiler is configured for 32532-based systems.
9693
9694 @item -m32081
9695 @opindex m32081
9696 Generate output containing 32081 instructions for floating point.
9697 This is the default for all systems.
9698
9699 @item -m32381
9700 @opindex m32381
9701 Generate output containing 32381 instructions for floating point.  This
9702 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9703 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9704
9705 @item -mmulti-add
9706 @opindex mmulti-add
9707 Try and generate multiply-add floating point instructions @code{polyF}
9708 and @code{dotF}.  This option is only available if the @option{-m32381}
9709 option is in effect.  Using these instructions requires changes to
9710 register allocation which generally has a negative impact on
9711 performance.  This option should only be enabled when compiling code
9712 particularly likely to make heavy use of multiply-add instructions.
9713
9714 @item -mnomulti-add
9715 @opindex mnomulti-add
9716 Do not try and generate multiply-add floating point instructions
9717 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9718
9719 @item -msoft-float
9720 @opindex msoft-float
9721 Generate output containing library calls for floating point.
9722 @strong{Warning:} the requisite libraries may not be available.
9723
9724 @item -mieee-compare
9725 @itemx -mno-ieee-compare
9726 @opindex mieee-compare
9727 @opindex mno-ieee-compare
9728 Control whether or not the compiler uses IEEE floating point
9729 comparisons.  These handle correctly the case where the result of a
9730 comparison is unordered.
9731 @strong{Warning:} the requisite kernel support may not be available.
9732
9733 @item -mnobitfield
9734 @opindex mnobitfield
9735 Do not use the bit-field instructions.  On some machines it is faster to
9736 use shifting and masking operations.  This is the default for the pc532.
9737
9738 @item -mbitfield
9739 @opindex mbitfield
9740 Do use the bit-field instructions.  This is the default for all platforms
9741 except the pc532.
9742
9743 @item -mrtd
9744 @opindex mrtd
9745 Use a different function-calling convention, in which functions
9746 that take a fixed number of arguments return pop their
9747 arguments on return with the @code{ret} instruction.
9748
9749 This calling convention is incompatible with the one normally
9750 used on Unix, so you cannot use it if you need to call libraries
9751 compiled with the Unix compiler.
9752
9753 Also, you must provide function prototypes for all functions that
9754 take variable numbers of arguments (including @code{printf});
9755 otherwise incorrect code will be generated for calls to those
9756 functions.
9757
9758 In addition, seriously incorrect code will result if you call a
9759 function with too many arguments.  (Normally, extra arguments are
9760 harmlessly ignored.)
9761
9762 This option takes its name from the 680x0 @code{rtd} instruction.
9763
9764
9765 @item -mregparam
9766 @opindex mregparam
9767 Use a different function-calling convention where the first two arguments
9768 are passed in registers.
9769
9770 This calling convention is incompatible with the one normally
9771 used on Unix, so you cannot use it if you need to call libraries
9772 compiled with the Unix compiler.
9773
9774 @item -mnoregparam
9775 @opindex mnoregparam
9776 Do not pass any arguments in registers.  This is the default for all
9777 targets.
9778
9779 @item -msb
9780 @opindex msb
9781 It is OK to use the sb as an index register which is always loaded with
9782 zero.  This is the default for the pc532-netbsd target.
9783
9784 @item -mnosb
9785 @opindex mnosb
9786 The sb register is not available for use or has not been initialized to
9787 zero by the run time system.  This is the default for all targets except
9788 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9789 @option{-fpic} is set.
9790
9791 @item -mhimem
9792 @opindex mhimem
9793 Many ns32000 series addressing modes use displacements of up to 512MB@.
9794 If an address is above 512MB then displacements from zero can not be used.
9795 This option causes code to be generated which can be loaded above 512MB@.
9796 This may be useful for operating systems or ROM code.
9797
9798 @item -mnohimem
9799 @opindex mnohimem
9800 Assume code will be loaded in the first 512MB of virtual address space.
9801 This is the default for all platforms.
9802
9803
9804 @end table
9805
9806 @node AVR Options
9807 @subsection AVR Options
9808 @cindex AVR Options
9809
9810 These options are defined for AVR implementations:
9811
9812 @table @gcctabopt
9813 @item -mmcu=@var{mcu}
9814 @opindex mmcu
9815 Specify ATMEL AVR instruction set or MCU type.
9816
9817 Instruction set avr1 is for the minimal AVR core, not supported by the C
9818 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9819 attiny11, attiny12, attiny15, attiny28).
9820
9821 Instruction set avr2 (default) is for the classic AVR core with up to
9822 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9823 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9824 at90c8534, at90s8535).
9825
9826 Instruction set avr3 is for the classic AVR core with up to 128K program
9827 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9828
9829 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9830 memory space (MCU types: atmega8, atmega83, atmega85).
9831
9832 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9833 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9834 atmega64, atmega128, at43usb355, at94k).
9835
9836 @item -msize
9837 @opindex msize
9838 Output instruction sizes to the asm file.
9839
9840 @item -minit-stack=@var{N}
9841 @opindex minit-stack
9842 Specify the initial stack address, which may be a symbol or numeric value,
9843 @samp{__stack} is the default.
9844
9845 @item -mno-interrupts
9846 @opindex mno-interrupts
9847 Generated code is not compatible with hardware interrupts.
9848 Code size will be smaller.
9849
9850 @item -mcall-prologues
9851 @opindex mcall-prologues
9852 Functions prologues/epilogues expanded as call to appropriate
9853 subroutines.  Code size will be smaller.
9854
9855 @item -mno-tablejump
9856 @opindex mno-tablejump
9857 Do not generate tablejump insns which sometimes increase code size.
9858
9859 @item -mtiny-stack
9860 @opindex mtiny-stack
9861 Change only the low 8 bits of the stack pointer.
9862 @end table
9863
9864 @node MCore Options
9865 @subsection MCore Options
9866 @cindex MCore options
9867
9868 These are the @samp{-m} options defined for the Motorola M*Core
9869 processors.
9870
9871 @table @gcctabopt
9872
9873 @item -mhardlit
9874 @itemx -mno-hardlit
9875 @opindex mhardlit
9876 @opindex mno-hardlit
9877 Inline constants into the code stream if it can be done in two
9878 instructions or less.
9879
9880 @item -mdiv
9881 @itemx -mno-div
9882 @opindex mdiv
9883 @opindex mno-div
9884 Use the divide instruction.  (Enabled by default).
9885
9886 @item -mrelax-immediate
9887 @itemx -mno-relax-immediate
9888 @opindex mrelax-immediate
9889 @opindex mno-relax-immediate
9890 Allow arbitrary sized immediates in bit operations.
9891
9892 @item -mwide-bitfields
9893 @itemx -mno-wide-bitfields
9894 @opindex mwide-bitfields
9895 @opindex mno-wide-bitfields
9896 Always treat bit-fields as int-sized.
9897
9898 @item -m4byte-functions
9899 @itemx -mno-4byte-functions
9900 @opindex m4byte-functions
9901 @opindex mno-4byte-functions
9902 Force all functions to be aligned to a four byte boundary.
9903
9904 @item -mcallgraph-data
9905 @itemx -mno-callgraph-data
9906 @opindex mcallgraph-data
9907 @opindex mno-callgraph-data
9908 Emit callgraph information.
9909
9910 @item -mslow-bytes
9911 @itemx -mno-slow-bytes
9912 @opindex mslow-bytes
9913 @opindex mno-slow-bytes
9914 Prefer word access when reading byte quantities.
9915
9916 @item -mlittle-endian
9917 @itemx -mbig-endian
9918 @opindex mlittle-endian
9919 @opindex mbig-endian
9920 Generate code for a little endian target.
9921
9922 @item -m210
9923 @itemx -m340
9924 @opindex m210
9925 @opindex m340
9926 Generate code for the 210 processor.
9927 @end table
9928
9929 @node IA-64 Options
9930 @subsection IA-64 Options
9931 @cindex IA-64 Options
9932
9933 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9934
9935 @table @gcctabopt
9936 @item -mbig-endian
9937 @opindex mbig-endian
9938 Generate code for a big endian target.  This is the default for HP-UX@.
9939
9940 @item -mlittle-endian
9941 @opindex mlittle-endian
9942 Generate code for a little endian target.  This is the default for AIX5
9943 and GNU/Linux.
9944
9945 @item -mgnu-as
9946 @itemx -mno-gnu-as
9947 @opindex mgnu-as
9948 @opindex mno-gnu-as
9949 Generate (or don't) code for the GNU assembler.  This is the default.
9950 @c Also, this is the default if the configure option @option{--with-gnu-as}
9951 @c is used.
9952
9953 @item -mgnu-ld
9954 @itemx -mno-gnu-ld
9955 @opindex mgnu-ld
9956 @opindex mno-gnu-ld
9957 Generate (or don't) code for the GNU linker.  This is the default.
9958 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9959 @c is used.
9960
9961 @item -mno-pic
9962 @opindex mno-pic
9963 Generate code that does not use a global pointer register.  The result
9964 is not position independent code, and violates the IA-64 ABI@.
9965
9966 @item -mvolatile-asm-stop
9967 @itemx -mno-volatile-asm-stop
9968 @opindex mvolatile-asm-stop
9969 @opindex mno-volatile-asm-stop
9970 Generate (or don't) a stop bit immediately before and after volatile asm
9971 statements.
9972
9973 @item -mb-step
9974 @opindex mb-step
9975 Generate code that works around Itanium B step errata.
9976
9977 @item -mregister-names
9978 @itemx -mno-register-names
9979 @opindex mregister-names
9980 @opindex mno-register-names
9981 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9982 the stacked registers.  This may make assembler output more readable.
9983
9984 @item -mno-sdata
9985 @itemx -msdata
9986 @opindex mno-sdata
9987 @opindex msdata
9988 Disable (or enable) optimizations that use the small data section.  This may
9989 be useful for working around optimizer bugs.
9990
9991 @item -mconstant-gp
9992 @opindex mconstant-gp
9993 Generate code that uses a single constant global pointer value.  This is
9994 useful when compiling kernel code.
9995
9996 @item -mauto-pic
9997 @opindex mauto-pic
9998 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9999 This is useful when compiling firmware code.
10000
10001 @item -minline-float-divide-min-latency
10002 @opindex minline-float-divide-min-latency
10003 Generate code for inline divides of floating point values
10004 using the minimum latency algorithm.
10005
10006 @item -minline-float-divide-max-throughput
10007 @opindex minline-float-divide-max-throughput
10008 Generate code for inline divides of floating point values
10009 using the maximum throughput algorithm.
10010
10011 @item -minline-int-divide-min-latency
10012 @opindex minline-int-divide-min-latency
10013 Generate code for inline divides of integer values
10014 using the minimum latency algorithm.
10015
10016 @item -minline-int-divide-max-throughput
10017 @opindex minline-int-divide-max-throughput
10018 Generate code for inline divides of integer values
10019 using the maximum throughput algorithm.
10020
10021 @item -mno-dwarf2-asm
10022 @itemx -mdwarf2-asm
10023 @opindex mno-dwarf2-asm
10024 @opindex mdwarf2-asm
10025 Don't (or do) generate assembler code for the DWARF2 line number debugging
10026 info.  This may be useful when not using the GNU assembler.
10027
10028 @item -mfixed-range=@var{register-range}
10029 @opindex mfixed-range
10030 Generate code treating the given register range as fixed registers.
10031 A fixed register is one that the register allocator can not use.  This is
10032 useful when compiling kernel code.  A register range is specified as
10033 two registers separated by a dash.  Multiple register ranges can be
10034 specified separated by a comma.
10035
10036 @item -mearly-stop-bits
10037 @itemx -mno-early-stop-bits
10038 @opindex mearly-stop-bits
10039 @opindex mno-early-stop-bits
10040 Allow stop bits to be placed earlier than immediately preceding the
10041 instruction that triggered the stop bit.  This can improve instruction
10042 scheduling, but does not always do so.
10043 @end table
10044
10045 @node D30V Options
10046 @subsection D30V Options
10047 @cindex D30V Options
10048
10049 These @samp{-m} options are defined for D30V implementations:
10050
10051 @table @gcctabopt
10052 @item -mextmem
10053 @opindex mextmem
10054 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10055 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10056 memory, which starts at location @code{0x80000000}.
10057
10058 @item -mextmemory
10059 @opindex mextmemory
10060 Same as the @option{-mextmem} switch.
10061
10062 @item -monchip
10063 @opindex monchip
10064 Link the @samp{.text} section into onchip text memory, which starts at
10065 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10066 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10067 into onchip data memory, which starts at location @code{0x20000000}.
10068
10069 @item -mno-asm-optimize
10070 @itemx -masm-optimize
10071 @opindex mno-asm-optimize
10072 @opindex masm-optimize
10073 Disable (enable) passing @option{-O} to the assembler when optimizing.
10074 The assembler uses the @option{-O} option to automatically parallelize
10075 adjacent short instructions where possible.
10076
10077 @item -mbranch-cost=@var{n}
10078 @opindex mbranch-cost
10079 Increase the internal costs of branches to @var{n}.  Higher costs means
10080 that the compiler will issue more instructions to avoid doing a branch.
10081 The default is 2.
10082
10083 @item -mcond-exec=@var{n}
10084 @opindex mcond-exec
10085 Specify the maximum number of conditionally executed instructions that
10086 replace a branch.  The default is 4.
10087 @end table
10088
10089 @node S/390 and zSeries Options
10090 @subsection S/390 and zSeries Options
10091 @cindex S/390 and zSeries Options
10092
10093 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10094
10095 @table @gcctabopt
10096 @item -mhard-float
10097 @itemx -msoft-float
10098 @opindex mhard-float
10099 @opindex msoft-float
10100 Use (do not use) the hardware floating-point instructions and registers
10101 for floating-point operations.  When @option{-msoft-float} is specified,
10102 functions in @file{libgcc.a} will be used to perform floating-point
10103 operations.  When @option{-mhard-float} is specified, the compiler
10104 generates IEEE floating-point instructions.  This is the default.
10105
10106 @item -mbackchain
10107 @itemx -mno-backchain
10108 @opindex mbackchain
10109 @opindex mno-backchain
10110 Generate (or do not generate) code which maintains an explicit
10111 backchain within the stack frame that points to the caller's frame.
10112 This may be needed to allow debugging using tools that do not understand
10113 DWARF-2 call frame information.  The default is not to generate the
10114 backchain.
10115
10116 @item -msmall-exec
10117 @itemx -mno-small-exec
10118 @opindex msmall-exec
10119 @opindex mno-small-exec
10120 Generate (or do not generate) code using the @code{bras} instruction
10121 to do subroutine calls.
10122 This only works reliably if the total executable size does not
10123 exceed 64k.  The default is to use the @code{basr} instruction instead,
10124 which does not have this limitation.
10125
10126 @item -m64
10127 @itemx -m31
10128 @opindex m64
10129 @opindex m31
10130 When @option{-m31} is specified, generate code compliant to the
10131 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10132 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10133 particular to generate 64-bit instructions.  For the @samp{s390}
10134 targets, the default is @option{-m31}, while the @samp{s390x}
10135 targets default to @option{-m64}.
10136
10137 @item -mzarch
10138 @itemx -mesa
10139 @opindex mzarch
10140 @opindex mesa
10141 When @option{-mzarch} is specified, generate code using the
10142 instructions available on z/Architecture.
10143 When @option{-mesa} is specified, generate code using the
10144 instructions available on ESA/390. Note that @option{-mesa} is
10145 not possible with @option{-m64}.
10146 When generating code compliant to the GNU/Linux for S/390 ABI,
10147 the default is @option{-mesa}.  When generating code compliant
10148 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10149
10150 @item -mmvcle
10151 @itemx -mno-mvcle
10152 @opindex mmvcle
10153 @opindex mno-mvcle
10154 Generate (or do not generate) code using the @code{mvcle} instruction
10155 to perform block moves.  When @option{-mno-mvcle} is specified,
10156 use a @code{mvc} loop instead.  This is the default.
10157
10158 @item -mdebug
10159 @itemx -mno-debug
10160 @opindex mdebug
10161 @opindex mno-debug
10162 Print (or do not print) additional debug information when compiling.
10163 The default is to not print debug information.
10164
10165 @item -march=@var{cpu-type}
10166 @opindex march
10167 Generate code that will run on @var{cpu-type}, which is the name of a system
10168 representing a certain processor type. Possible values for
10169 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10170 When generating code using the instructions available on z/Architecture,
10171 the default is @option{-march=z900}.  Otherwise, the default is
10172 @option{-march=g5}.
10173
10174 @item -mtune=@var{cpu-type}
10175 @opindex mtune
10176 Tune to @var{cpu-type} everything applicable about the generated code,
10177 except for the ABI and the set of available instructions.
10178 The list of @var{cpu-type} values is the same as for @option{-march}.
10179 The default is the value used for @option{-march}.
10180
10181 @item -mfused-madd
10182 @itemx -mno-fused-madd
10183 @opindex mfused-madd
10184 @opindex mno-fused-madd
10185 Generate code that uses (does not use) the floating point multiply and
10186 accumulate instructions.  These instructions are generated by default if
10187 hardware floating point is used.
10188 @end table
10189
10190 @node CRIS Options
10191 @subsection CRIS Options
10192 @cindex CRIS Options
10193
10194 These options are defined specifically for the CRIS ports.
10195
10196 @table @gcctabopt
10197 @item -march=@var{architecture-type}
10198 @itemx -mcpu=@var{architecture-type}
10199 @opindex march
10200 @opindex mcpu
10201 Generate code for the specified architecture.  The choices for
10202 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10203 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10204 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10205 @samp{v10}.
10206
10207 @item -mtune=@var{architecture-type}
10208 @opindex mtune
10209 Tune to @var{architecture-type} everything applicable about the generated
10210 code, except for the ABI and the set of available instructions.  The
10211 choices for @var{architecture-type} are the same as for
10212 @option{-march=@var{architecture-type}}.
10213
10214 @item -mmax-stack-frame=@var{n}
10215 @opindex mmax-stack-frame
10216 Warn when the stack frame of a function exceeds @var{n} bytes.
10217
10218 @item -melinux-stacksize=@var{n}
10219 @opindex melinux-stacksize
10220 Only available with the @samp{cris-axis-aout} target.  Arranges for
10221 indications in the program to the kernel loader that the stack of the
10222 program should be set to @var{n} bytes.
10223
10224 @item -metrax4
10225 @itemx -metrax100
10226 @opindex metrax4
10227 @opindex metrax100
10228 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10229 @option{-march=v3} and @option{-march=v8} respectively.
10230
10231 @item -mpdebug
10232 @opindex mpdebug
10233 Enable CRIS-specific verbose debug-related information in the assembly
10234 code.  This option also has the effect to turn off the @samp{#NO_APP}
10235 formatted-code indicator to the assembler at the beginning of the
10236 assembly file.
10237
10238 @item -mcc-init
10239 @opindex mcc-init
10240 Do not use condition-code results from previous instruction; always emit
10241 compare and test instructions before use of condition codes.
10242
10243 @item -mno-side-effects
10244 @opindex mno-side-effects
10245 Do not emit instructions with side-effects in addressing modes other than
10246 post-increment.
10247
10248 @item -mstack-align
10249 @itemx -mno-stack-align
10250 @itemx -mdata-align
10251 @itemx -mno-data-align
10252 @itemx -mconst-align
10253 @itemx -mno-const-align
10254 @opindex mstack-align
10255 @opindex mno-stack-align
10256 @opindex mdata-align
10257 @opindex mno-data-align
10258 @opindex mconst-align
10259 @opindex mno-const-align
10260 These options (no-options) arranges (eliminate arrangements) for the
10261 stack-frame, individual data and constants to be aligned for the maximum
10262 single data access size for the chosen CPU model.  The default is to
10263 arrange for 32-bit alignment.  ABI details such as structure layout are
10264 not affected by these options.
10265
10266 @item -m32-bit
10267 @itemx -m16-bit
10268 @itemx -m8-bit
10269 @opindex m32-bit
10270 @opindex m16-bit
10271 @opindex m8-bit
10272 Similar to the stack- data- and const-align options above, these options
10273 arrange for stack-frame, writable data and constants to all be 32-bit,
10274 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10275
10276 @item -mno-prologue-epilogue
10277 @itemx -mprologue-epilogue
10278 @opindex mno-prologue-epilogue
10279 @opindex mprologue-epilogue
10280 With @option{-mno-prologue-epilogue}, the normal function prologue and
10281 epilogue that sets up the stack-frame are omitted and no return
10282 instructions or return sequences are generated in the code.  Use this
10283 option only together with visual inspection of the compiled code: no
10284 warnings or errors are generated when call-saved registers must be saved,
10285 or storage for local variable needs to be allocated.
10286
10287 @item -mno-gotplt
10288 @itemx -mgotplt
10289 @opindex mno-gotplt
10290 @opindex mgotplt
10291 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10292 instruction sequences that load addresses for functions from the PLT part
10293 of the GOT rather than (traditional on other architectures) calls to the
10294 PLT.  The default is @option{-mgotplt}.
10295
10296 @item -maout
10297 @opindex maout
10298 Legacy no-op option only recognized with the cris-axis-aout target.
10299
10300 @item -melf
10301 @opindex melf
10302 Legacy no-op option only recognized with the cris-axis-elf and
10303 cris-axis-linux-gnu targets.
10304
10305 @item -melinux
10306 @opindex melinux
10307 Only recognized with the cris-axis-aout target, where it selects a
10308 GNU/linux-like multilib, include files and instruction set for
10309 @option{-march=v8}.
10310
10311 @item -mlinux
10312 @opindex mlinux
10313 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10314
10315 @item -sim
10316 @opindex sim
10317 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10318 to link with input-output functions from a simulator library.  Code,
10319 initialized data and zero-initialized data are allocated consecutively.
10320
10321 @item -sim2
10322 @opindex sim2
10323 Like @option{-sim}, but pass linker options to locate initialized data at
10324 0x40000000 and zero-initialized data at 0x80000000.
10325 @end table
10326
10327 @node MMIX Options
10328 @subsection MMIX Options
10329 @cindex MMIX Options
10330
10331 These options are defined for the MMIX:
10332
10333 @table @gcctabopt
10334 @item -mlibfuncs
10335 @itemx -mno-libfuncs
10336 @opindex mlibfuncs
10337 @opindex mno-libfuncs
10338 Specify that intrinsic library functions are being compiled, passing all
10339 values in registers, no matter the size.
10340
10341 @item -mepsilon
10342 @itemx -mno-epsilon
10343 @opindex mepsilon
10344 @opindex mno-epsilon
10345 Generate floating-point comparison instructions that compare with respect
10346 to the @code{rE} epsilon register.
10347
10348 @item -mabi=mmixware
10349 @itemx -mabi=gnu
10350 @opindex mabi-mmixware
10351 @opindex mabi=gnu
10352 Generate code that passes function parameters and return values that (in
10353 the called function) are seen as registers @code{$0} and up, as opposed to
10354 the GNU ABI which uses global registers @code{$231} and up.
10355
10356 @item -mzero-extend
10357 @itemx -mno-zero-extend
10358 @opindex mzero-extend
10359 @opindex mno-zero-extend
10360 When reading data from memory in sizes shorter than 64 bits, use (do not
10361 use) zero-extending load instructions by default, rather than
10362 sign-extending ones.
10363
10364 @item -mknuthdiv
10365 @itemx -mno-knuthdiv
10366 @opindex mknuthdiv
10367 @opindex mno-knuthdiv
10368 Make the result of a division yielding a remainder have the same sign as
10369 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10370 remainder follows the sign of the dividend.  Both methods are
10371 arithmetically valid, the latter being almost exclusively used.
10372
10373 @item -mtoplevel-symbols
10374 @itemx -mno-toplevel-symbols
10375 @opindex mtoplevel-symbols
10376 @opindex mno-toplevel-symbols
10377 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10378 code can be used with the @code{PREFIX} assembly directive.
10379
10380 @item -melf
10381 @opindex melf
10382 Generate an executable in the ELF format, rather than the default
10383 @samp{mmo} format used by the @command{mmix} simulator.
10384
10385 @item -mbranch-predict
10386 @itemx -mno-branch-predict
10387 @opindex mbranch-predict
10388 @opindex mno-branch-predict
10389 Use (do not use) the probable-branch instructions, when static branch
10390 prediction indicates a probable branch.
10391
10392 @item -mbase-addresses
10393 @itemx -mno-base-addresses
10394 @opindex mbase-addresses
10395 @opindex mno-base-addresses
10396 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10397 base address automatically generates a request (handled by the assembler
10398 and the linker) for a constant to be set up in a global register.  The
10399 register is used for one or more base address requests within the range 0
10400 to 255 from the value held in the register.  The generally leads to short
10401 and fast code, but the number of different data items that can be
10402 addressed is limited.  This means that a program that uses lots of static
10403 data may require @option{-mno-base-addresses}.
10404
10405 @item -msingle-exit
10406 @itemx -mno-single-exit
10407 @opindex msingle-exit
10408 @opindex mno-single-exit
10409 Force (do not force) generated code to have a single exit point in each
10410 function.
10411 @end table
10412
10413 @node PDP-11 Options
10414 @subsection PDP-11 Options
10415 @cindex PDP-11 Options
10416
10417 These options are defined for the PDP-11:
10418
10419 @table @gcctabopt
10420 @item -mfpu
10421 @opindex mfpu
10422 Use hardware FPP floating point.  This is the default.  (FIS floating
10423 point on the PDP-11/40 is not supported.)
10424
10425 @item -msoft-float
10426 @opindex msoft-float
10427 Do not use hardware floating point.
10428
10429 @item -mac0
10430 @opindex mac0
10431 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10432
10433 @item -mno-ac0
10434 @opindex mno-ac0
10435 Return floating-point results in memory.  This is the default.
10436
10437 @item -m40
10438 @opindex m40
10439 Generate code for a PDP-11/40.
10440
10441 @item -m45
10442 @opindex m45
10443 Generate code for a PDP-11/45.  This is the default.
10444
10445 @item -m10
10446 @opindex m10
10447 Generate code for a PDP-11/10.
10448
10449 @item -mbcopy-builtin
10450 @opindex bcopy-builtin
10451 Use inline @code{movstrhi} patterns for copying memory.  This is the
10452 default.
10453
10454 @item -mbcopy
10455 @opindex mbcopy
10456 Do not use inline @code{movstrhi} patterns for copying memory.
10457
10458 @item -mint16
10459 @itemx -mno-int32
10460 @opindex mint16
10461 @opindex mno-int32
10462 Use 16-bit @code{int}.  This is the default.
10463
10464 @item -mint32
10465 @itemx -mno-int16
10466 @opindex mint32
10467 @opindex mno-int16
10468 Use 32-bit @code{int}.
10469
10470 @item -mfloat64
10471 @itemx -mno-float32
10472 @opindex mfloat64
10473 @opindex mno-float32
10474 Use 64-bit @code{float}.  This is the default.
10475
10476 @item -mfloat32
10477 @itemx -mno-float64
10478 @opindex mfloat32
10479 @opindex mno-float64
10480 Use 32-bit @code{float}.
10481
10482 @item -mabshi
10483 @opindex mabshi
10484 Use @code{abshi2} pattern.  This is the default.
10485
10486 @item -mno-abshi
10487 @opindex mno-abshi
10488 Do not use @code{abshi2} pattern.
10489
10490 @item -mbranch-expensive
10491 @opindex mbranch-expensive
10492 Pretend that branches are expensive.  This is for experimenting with
10493 code generation only.
10494
10495 @item -mbranch-cheap
10496 @opindex mbranch-cheap
10497 Do not pretend that branches are expensive.  This is the default.
10498
10499 @item -msplit
10500 @opindex msplit
10501 Generate code for a system with split I&D.
10502
10503 @item -mno-split
10504 @opindex mno-split
10505 Generate code for a system without split I&D.  This is the default.
10506
10507 @item -munix-asm
10508 @opindex munix-asm
10509 Use Unix assembler syntax.  This is the default when configured for
10510 @samp{pdp11-*-bsd}.
10511
10512 @item -mdec-asm
10513 @opindex mdec-asm
10514 Use DEC assembler syntax.  This is the default when configured for any
10515 PDP-11 target other than @samp{pdp11-*-bsd}.
10516 @end table
10517
10518 @node Xstormy16 Options
10519 @subsection Xstormy16 Options
10520 @cindex Xstormy16 Options
10521
10522 These options are defined for Xstormy16:
10523
10524 @table @gcctabopt
10525 @item -msim
10526 @opindex msim
10527 Choose startup files and linker script suitable for the simulator.
10528 @end table
10529
10530 @node FRV Options
10531 @subsection FRV Options
10532 @cindex FRV Options
10533
10534 @table @gcctabopt
10535 @item -mgpr-32
10536 @opindex mgpr-32
10537
10538 Only use the first 32 general purpose registers.
10539
10540 @item -mgpr-64
10541 @opindex mgpr-64
10542
10543 Use all 64 general purpose registers.
10544
10545 @item -mfpr-32
10546 @opindex mfpr-32
10547
10548 Use only the first 32 floating point registers.
10549
10550 @item -mfpr-64
10551 @opindex mfpr-64
10552
10553 Use all 64 floating point registers
10554
10555 @item -mhard-float
10556 @opindex mhard-float
10557
10558 Use hardware instructions for floating point operations.
10559
10560 @item -msoft-float
10561 @opindex msoft-float
10562
10563 Use library routines for floating point operations.
10564
10565 @item -malloc-cc
10566 @opindex malloc-cc
10567
10568 Dynamically allocate condition code registers.
10569
10570 @item -mfixed-cc
10571 @opindex mfixed-cc
10572
10573 Do not try to dynamically allocate condition code registers, only
10574 use @code{icc0} and @code{fcc0}.
10575
10576 @item -mdword
10577 @opindex mdword
10578
10579 Change ABI to use double word insns.
10580
10581 @item -mno-dword
10582 @opindex mno-dword
10583
10584 Do not use double word instructions.
10585
10586 @item -mdouble
10587 @opindex mdouble
10588
10589 Use floating point double instructions.
10590
10591 @item -mno-double
10592 @opindex mno-double
10593
10594 Do not use floating point double instructions.
10595
10596 @item -mmedia
10597 @opindex mmedia
10598
10599 Use media instructions.
10600
10601 @item -mno-media
10602 @opindex mno-media
10603
10604 Do not use media instructions.
10605
10606 @item -mmuladd
10607 @opindex mmuladd
10608
10609 Use multiply and add/subtract instructions.
10610
10611 @item -mno-muladd
10612 @opindex mno-muladd
10613
10614 Do not use multiply and add/subtract instructions.
10615
10616 @item -mlibrary-pic
10617 @opindex mlibrary-pic
10618
10619 Enable PIC support for building libraries
10620
10621 @item -macc-4
10622 @opindex macc-4
10623
10624 Use only the first four media accumulator registers.
10625
10626 @item -macc-8
10627 @opindex macc-8
10628
10629 Use all eight media accumulator registers.
10630
10631 @item -mpack
10632 @opindex mpack
10633
10634 Pack VLIW instructions.
10635
10636 @item -mno-pack
10637 @opindex mno-pack
10638
10639 Do not pack VLIW instructions.
10640
10641 @item -mno-eflags
10642 @opindex mno-eflags
10643
10644 Do not mark ABI switches in e_flags.
10645
10646 @item -mcond-move
10647 @opindex mcond-move
10648
10649 Enable the use of conditional-move instructions (default).
10650
10651 This switch is mainly for debugging the compiler and will likely be removed
10652 in a future version.
10653
10654 @item -mno-cond-move
10655 @opindex mno-cond-move
10656
10657 Disable the use of conditional-move instructions.
10658
10659 This switch is mainly for debugging the compiler and will likely be removed
10660 in a future version.
10661
10662 @item -mscc
10663 @opindex mscc
10664
10665 Enable the use of conditional set instructions (default).
10666
10667 This switch is mainly for debugging the compiler and will likely be removed
10668 in a future version.
10669
10670 @item -mno-scc
10671 @opindex mno-scc
10672
10673 Disable the use of conditional set instructions.
10674
10675 This switch is mainly for debugging the compiler and will likely be removed
10676 in a future version.
10677
10678 @item -mcond-exec
10679 @opindex mcond-exec
10680
10681 Enable the use of conditional execution (default).
10682
10683 This switch is mainly for debugging the compiler and will likely be removed
10684 in a future version.
10685
10686 @item -mno-cond-exec
10687 @opindex mno-cond-exec
10688
10689 Disable the use of conditional execution.
10690
10691 This switch is mainly for debugging the compiler and will likely be removed
10692 in a future version.
10693
10694 @item -mvliw-branch
10695 @opindex mvliw-branch
10696
10697 Run a pass to pack branches into VLIW instructions (default).
10698
10699 This switch is mainly for debugging the compiler and will likely be removed
10700 in a future version.
10701
10702 @item -mno-vliw-branch
10703 @opindex mno-vliw-branch
10704
10705 Do not run a pass to pack branches into VLIW instructions.
10706
10707 This switch is mainly for debugging the compiler and will likely be removed
10708 in a future version.
10709
10710 @item -mmulti-cond-exec
10711 @opindex mmulti-cond-exec
10712
10713 Enable optimization of @code{&&} and @code{||} in conditional execution
10714 (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-multi-cond-exec
10720 @opindex mno-multi-cond-exec
10721
10722 Disable optimization of @code{&&} and @code{||} in conditional execution.
10723
10724 This switch is mainly for debugging the compiler and will likely be removed
10725 in a future version.
10726
10727 @item -mnested-cond-exec
10728 @opindex mnested-cond-exec
10729
10730 Enable nested conditional execution optimizations (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-nested-cond-exec
10736 @opindex mno-nested-cond-exec
10737
10738 Disable nested conditional execution optimizations.
10739
10740 This switch is mainly for debugging the compiler and will likely be removed
10741 in a future version.
10742
10743 @item -mtomcat-stats
10744 @opindex mtomcat-stats
10745
10746 Cause gas to print out tomcat statistics.
10747
10748 @item -mcpu=@var{cpu}
10749 @opindex mcpu
10750
10751 Select the processor type for which to generate code.  Possible values are
10752 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10753 @samp{frv}.
10754
10755 @end table
10756
10757 @node Xtensa Options
10758 @subsection Xtensa Options
10759 @cindex Xtensa Options
10760
10761 These options are supported for Xtensa targets:
10762
10763 @table @gcctabopt
10764 @item -mconst16
10765 @itemx -mno-const16
10766 @opindex mconst16
10767 @opindex mno-const16
10768 Enable or disable use of @code{CONST16} instructions for loading
10769 constant values.  The @code{CONST16} instruction is currently not a
10770 standard option from Tensilica.  When enabled, @code{CONST16}
10771 instructions are always used in place of the standard @code{L32R}
10772 instructions.  The use of @code{CONST16} is enabled by default only if
10773 the @code{L32R} instruction is not available.
10774
10775 @item -mfused-madd
10776 @itemx -mno-fused-madd
10777 @opindex mfused-madd
10778 @opindex mno-fused-madd
10779 Enable or disable use of fused multiply/add and multiply/subtract
10780 instructions in the floating-point option.  This has no effect if the
10781 floating-point option is not also enabled.  Disabling fused multiply/add
10782 and multiply/subtract instructions forces the compiler to use separate
10783 instructions for the multiply and add/subtract operations.  This may be
10784 desirable in some cases where strict IEEE 754-compliant results are
10785 required: the fused multiply add/subtract instructions do not round the
10786 intermediate result, thereby producing results with @emph{more} bits of
10787 precision than specified by the IEEE standard.  Disabling fused multiply
10788 add/subtract instructions also ensures that the program output is not
10789 sensitive to the compiler's ability to combine multiply and add/subtract
10790 operations.
10791
10792 @item -mtext-section-literals
10793 @itemx -mno-text-section-literals
10794 @opindex mtext-section-literals
10795 @opindex mno-text-section-literals
10796 Control the treatment of literal pools.  The default is
10797 @option{-mno-text-section-literals}, which places literals in a separate
10798 section in the output file.  This allows the literal pool to be placed
10799 in a data RAM/ROM, and it also allows the linker to combine literal
10800 pools from separate object files to remove redundant literals and
10801 improve code size.  With @option{-mtext-section-literals}, the literals
10802 are interspersed in the text section in order to keep them as close as
10803 possible to their references.  This may be necessary for large assembly
10804 files.
10805
10806 @item -mtarget-align
10807 @itemx -mno-target-align
10808 @opindex mtarget-align
10809 @opindex mno-target-align
10810 When this option is enabled, GCC instructs the assembler to
10811 automatically align instructions to reduce branch penalties at the
10812 expense of some code density.  The assembler attempts to widen density
10813 instructions to align branch targets and the instructions following call
10814 instructions.  If there are not enough preceding safe density
10815 instructions to align a target, no widening will be performed.  The
10816 default is @option{-mtarget-align}.  These options do not affect the
10817 treatment of auto-aligned instructions like @code{LOOP}, which the
10818 assembler will always align, either by widening density instructions or
10819 by inserting no-op instructions.
10820
10821 @item -mlongcalls
10822 @itemx -mno-longcalls
10823 @opindex mlongcalls
10824 @opindex mno-longcalls
10825 When this option is enabled, GCC instructs the assembler to translate
10826 direct calls to indirect calls unless it can determine that the target
10827 of a direct call is in the range allowed by the call instruction.  This
10828 translation typically occurs for calls to functions in other source
10829 files.  Specifically, the assembler translates a direct @code{CALL}
10830 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10831 The default is @option{-mno-longcalls}.  This option should be used in
10832 programs where the call target can potentially be out of range.  This
10833 option is implemented in the assembler, not the compiler, so the
10834 assembly code generated by GCC will still show direct call
10835 instructions---look at the disassembled object code to see the actual
10836 instructions.  Note that the assembler will use an indirect call for
10837 every cross-file call, not just those that really will be out of range.
10838 @end table
10839
10840 @node Code Gen Options
10841 @section Options for Code Generation Conventions
10842 @cindex code generation conventions
10843 @cindex options, code generation
10844 @cindex run-time options
10845
10846 These machine-independent options control the interface conventions
10847 used in code generation.
10848
10849 Most of them have both positive and negative forms; the negative form
10850 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10851 one of the forms is listed---the one which is not the default.  You
10852 can figure out the other form by either removing @samp{no-} or adding
10853 it.
10854
10855 @table @gcctabopt
10856 @item -fbounds-check
10857 @opindex fbounds-check
10858 For front-ends that support it, generate additional code to check that
10859 indices used to access arrays are within the declared range.  This is
10860 currently only supported by the Java and Fortran 77 front-ends, where
10861 this option defaults to true and false respectively.
10862
10863 @item -ftrapv
10864 @opindex ftrapv
10865 This option generates traps for signed overflow on addition, subtraction,
10866 multiplication operations.
10867
10868 @item -fwrapv
10869 @opindex fwrapv
10870 This option instructs the compiler to assume that signed arithmetic
10871 overflow of addition, subtraction and multiplication wraps around
10872 using twos-complement representation.  This flag enables some optimizations
10873 and disables other.  This option is enabled by default for the Java
10874 front-end, as required by the Java language specification.
10875
10876 @item -fexceptions
10877 @opindex fexceptions
10878 Enable exception handling.  Generates extra code needed to propagate
10879 exceptions.  For some targets, this implies GCC will generate frame
10880 unwind information for all functions, which can produce significant data
10881 size overhead, although it does not affect execution.  If you do not
10882 specify this option, GCC will enable it by default for languages like
10883 C++ which normally require exception handling, and disable it for
10884 languages like C that do not normally require it.  However, you may need
10885 to enable this option when compiling C code that needs to interoperate
10886 properly with exception handlers written in C++.  You may also wish to
10887 disable this option if you are compiling older C++ programs that don't
10888 use exception handling.
10889
10890 @item -fnon-call-exceptions
10891 @opindex fnon-call-exceptions
10892 Generate code that allows trapping instructions to throw exceptions.
10893 Note that this requires platform-specific runtime support that does
10894 not exist everywhere.  Moreover, it only allows @emph{trapping}
10895 instructions to throw exceptions, i.e.@: memory references or floating
10896 point instructions.  It does not allow exceptions to be thrown from
10897 arbitrary signal handlers such as @code{SIGALRM}.
10898
10899 @item -funwind-tables
10900 @opindex funwind-tables
10901 Similar to @option{-fexceptions}, except that it will just generate any needed
10902 static data, but will not affect the generated code in any other way.
10903 You will normally not enable this option; instead, a language processor
10904 that needs this handling would enable it on your behalf.
10905
10906 @item -fasynchronous-unwind-tables
10907 @opindex funwind-tables
10908 Generate unwind table in dwarf2 format, if supported by target machine.  The
10909 table is exact at each instruction boundary, so it can be used for stack
10910 unwinding from asynchronous events (such as debugger or garbage collector).
10911
10912 @item -fpcc-struct-return
10913 @opindex fpcc-struct-return
10914 Return ``short'' @code{struct} and @code{union} values in memory like
10915 longer ones, rather than in registers.  This convention is less
10916 efficient, but it has the advantage of allowing intercallability between
10917 GCC-compiled files and files compiled with other compilers, particularly
10918 the Portable C Compiler (pcc).
10919
10920 The precise convention for returning structures in memory depends
10921 on the target configuration macros.
10922
10923 Short structures and unions are those whose size and alignment match
10924 that of some integer type.
10925
10926 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10927 switch is not binary compatible with code compiled with the
10928 @option{-freg-struct-return} switch.
10929 Use it to conform to a non-default application binary interface.
10930
10931 @item -freg-struct-return
10932 @opindex freg-struct-return
10933 Return @code{struct} and @code{union} values in registers when possible.
10934 This is more efficient for small structures than
10935 @option{-fpcc-struct-return}.
10936
10937 If you specify neither @option{-fpcc-struct-return} nor
10938 @option{-freg-struct-return}, GCC defaults to whichever convention is
10939 standard for the target.  If there is no standard convention, GCC
10940 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10941 the principal compiler.  In those cases, we can choose the standard, and
10942 we chose the more efficient register return alternative.
10943
10944 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10945 switch is not binary compatible with code compiled with the
10946 @option{-fpcc-struct-return} switch.
10947 Use it to conform to a non-default application binary interface.
10948
10949 @item -fshort-enums
10950 @opindex fshort-enums
10951 Allocate to an @code{enum} type only as many bytes as it needs for the
10952 declared range of possible values.  Specifically, the @code{enum} type
10953 will be equivalent to the smallest integer type which has enough room.
10954
10955 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10956 code that is not binary compatible with code generated without that switch.
10957 Use it to conform to a non-default application binary interface.
10958
10959 @item -fshort-double
10960 @opindex fshort-double
10961 Use the same size for @code{double} as for @code{float}.
10962
10963 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10964 code that is not binary compatible with code generated without that switch.
10965 Use it to conform to a non-default application binary interface.
10966
10967 @item -fshort-wchar
10968 @opindex fshort-wchar
10969 Override the underlying type for @samp{wchar_t} to be @samp{short
10970 unsigned int} instead of the default for the target.  This option is
10971 useful for building programs to run under WINE@.
10972
10973 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10974 code that is not binary compatible with code generated without that switch.
10975 Use it to conform to a non-default application binary interface.
10976
10977 @item -fshared-data
10978 @opindex fshared-data
10979 Requests that the data and non-@code{const} variables of this
10980 compilation be shared data rather than private data.  The distinction
10981 makes sense only on certain operating systems, where shared data is
10982 shared between processes running the same program, while private data
10983 exists in one copy per process.
10984
10985 @item -fno-common
10986 @opindex fno-common
10987 In C, allocate even uninitialized global variables in the data section of the
10988 object file, rather than generating them as common blocks.  This has the
10989 effect that if the same variable is declared (without @code{extern}) in
10990 two different compilations, you will get an error when you link them.
10991 The only reason this might be useful is if you wish to verify that the
10992 program will work on other systems which always work this way.
10993
10994 @item -fno-ident
10995 @opindex fno-ident
10996 Ignore the @samp{#ident} directive.
10997
10998 @item -finhibit-size-directive
10999 @opindex finhibit-size-directive
11000 Don't output a @code{.size} assembler directive, or anything else that
11001 would cause trouble if the function is split in the middle, and the
11002 two halves are placed at locations far apart in memory.  This option is
11003 used when compiling @file{crtstuff.c}; you should not need to use it
11004 for anything else.
11005
11006 @item -fverbose-asm
11007 @opindex fverbose-asm
11008 Put extra commentary information in the generated assembly code to
11009 make it more readable.  This option is generally only of use to those
11010 who actually need to read the generated assembly code (perhaps while
11011 debugging the compiler itself).
11012
11013 @option{-fno-verbose-asm}, the default, causes the
11014 extra information to be omitted and is useful when comparing two assembler
11015 files.
11016
11017 @item -fpic
11018 @opindex fpic
11019 @cindex global offset table
11020 @cindex PIC
11021 Generate position-independent code (PIC) suitable for use in a shared
11022 library, if supported for the target machine.  Such code accesses all
11023 constant addresses through a global offset table (GOT)@.  The dynamic
11024 loader resolves the GOT entries when the program starts (the dynamic
11025 loader is not part of GCC; it is part of the operating system).  If
11026 the GOT size for the linked executable exceeds a machine-specific
11027 maximum size, you get an error message from the linker indicating that
11028 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11029 instead.  (These maximums are 8k on the SPARC and 32k
11030 on the m68k and RS/6000.  The 386 has no such limit.)
11031
11032 Position-independent code requires special support, and therefore works
11033 only on certain machines.  For the 386, GCC supports PIC for System V
11034 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11035 position-independent.
11036
11037 @item -fPIC
11038 @opindex fPIC
11039 If supported for the target machine, emit position-independent code,
11040 suitable for dynamic linking and avoiding any limit on the size of the
11041 global offset table.  This option makes a difference on the m68k
11042 and the SPARC.
11043
11044 Position-independent code requires special support, and therefore works
11045 only on certain machines.
11046
11047 @item -fpie
11048 @itemx -fPIE
11049 @opindex fpie
11050 @opindex fPIE
11051 These options are similar to @option{-fpic} and @option{-fPIC}, but
11052 generated position independent code can be only linked into executables.
11053 Usually these options are used when @option{-pie} GCC option will be
11054 used during linking.
11055
11056 @item -ffixed-@var{reg}
11057 @opindex ffixed
11058 Treat the register named @var{reg} as a fixed register; generated code
11059 should never refer to it (except perhaps as a stack pointer, frame
11060 pointer or in some other fixed role).
11061
11062 @var{reg} must be the name of a register.  The register names accepted
11063 are machine-specific and are defined in the @code{REGISTER_NAMES}
11064 macro in the machine description macro file.
11065
11066 This flag does not have a negative form, because it specifies a
11067 three-way choice.
11068
11069 @item -fcall-used-@var{reg}
11070 @opindex fcall-used
11071 Treat the register named @var{reg} as an allocable register that is
11072 clobbered by function calls.  It may be allocated for temporaries or
11073 variables that do not live across a call.  Functions compiled this way
11074 will not save and restore the register @var{reg}.
11075
11076 It is an error to used this flag with the frame pointer or stack pointer.
11077 Use of this flag for other registers that have fixed pervasive roles in
11078 the machine's execution model will produce disastrous results.
11079
11080 This flag does not have a negative form, because it specifies a
11081 three-way choice.
11082
11083 @item -fcall-saved-@var{reg}
11084 @opindex fcall-saved
11085 Treat the register named @var{reg} as an allocable register saved by
11086 functions.  It may be allocated even for temporaries or variables that
11087 live across a call.  Functions compiled this way will save and restore
11088 the register @var{reg} if they use it.
11089
11090 It is an error to used this flag with the frame pointer or stack pointer.
11091 Use of this flag for other registers that have fixed pervasive roles in
11092 the machine's execution model will produce disastrous results.
11093
11094 A different sort of disaster will result from the use of this flag for
11095 a register in which function values may be returned.
11096
11097 This flag does not have a negative form, because it specifies a
11098 three-way choice.
11099
11100 @item -fpack-struct
11101 @opindex fpack-struct
11102 Pack all structure members together without holes.
11103
11104 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11105 code that is not binary compatible with code generated without that switch.
11106 Additionally, it makes the code suboptimal.
11107 Use it to conform to a non-default application binary interface.
11108
11109 @item -finstrument-functions
11110 @opindex finstrument-functions
11111 Generate instrumentation calls for entry and exit to functions.  Just
11112 after function entry and just before function exit, the following
11113 profiling functions will be called with the address of the current
11114 function and its call site.  (On some platforms,
11115 @code{__builtin_return_address} does not work beyond the current
11116 function, so the call site information may not be available to the
11117 profiling functions otherwise.)
11118
11119 @smallexample
11120 void __cyg_profile_func_enter (void *this_fn,
11121                                void *call_site);
11122 void __cyg_profile_func_exit  (void *this_fn,
11123                                void *call_site);
11124 @end smallexample
11125
11126 The first argument is the address of the start of the current function,
11127 which may be looked up exactly in the symbol table.
11128
11129 This instrumentation is also done for functions expanded inline in other
11130 functions.  The profiling calls will indicate where, conceptually, the
11131 inline function is entered and exited.  This means that addressable
11132 versions of such functions must be available.  If all your uses of a
11133 function are expanded inline, this may mean an additional expansion of
11134 code size.  If you use @samp{extern inline} in your C code, an
11135 addressable version of such functions must be provided.  (This is
11136 normally the case anyways, but if you get lucky and the optimizer always
11137 expands the functions inline, you might have gotten away without
11138 providing static copies.)
11139
11140 A function may be given the attribute @code{no_instrument_function}, in
11141 which case this instrumentation will not be done.  This can be used, for
11142 example, for the profiling functions listed above, high-priority
11143 interrupt routines, and any functions from which the profiling functions
11144 cannot safely be called (perhaps signal handlers, if the profiling
11145 routines generate output or allocate memory).
11146
11147 @item -fstack-check
11148 @opindex fstack-check
11149 Generate code to verify that you do not go beyond the boundary of the
11150 stack.  You should specify this flag if you are running in an
11151 environment with multiple threads, but only rarely need to specify it in
11152 a single-threaded environment since stack overflow is automatically
11153 detected on nearly all systems if there is only one stack.
11154
11155 Note that this switch does not actually cause checking to be done; the
11156 operating system must do that.  The switch causes generation of code
11157 to ensure that the operating system sees the stack being extended.
11158
11159 @item -fstack-limit-register=@var{reg}
11160 @itemx -fstack-limit-symbol=@var{sym}
11161 @itemx -fno-stack-limit
11162 @opindex fstack-limit-register
11163 @opindex fstack-limit-symbol
11164 @opindex fno-stack-limit
11165 Generate code to ensure that the stack does not grow beyond a certain value,
11166 either the value of a register or the address of a symbol.  If the stack
11167 would grow beyond the value, a signal is raised.  For most targets,
11168 the signal is raised before the stack overruns the boundary, so
11169 it is possible to catch the signal without taking special precautions.
11170
11171 For instance, if the stack starts at absolute address @samp{0x80000000}
11172 and grows downwards, you can use the flags
11173 @option{-fstack-limit-symbol=__stack_limit} and
11174 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11175 of 128KB@.  Note that this may only work with the GNU linker.
11176
11177 @cindex aliasing of parameters
11178 @cindex parameters, aliased
11179 @item -fargument-alias
11180 @itemx -fargument-noalias
11181 @itemx -fargument-noalias-global
11182 @opindex fargument-alias
11183 @opindex fargument-noalias
11184 @opindex fargument-noalias-global
11185 Specify the possible relationships among parameters and between
11186 parameters and global data.
11187
11188 @option{-fargument-alias} specifies that arguments (parameters) may
11189 alias each other and may alias global storage.@*
11190 @option{-fargument-noalias} specifies that arguments do not alias
11191 each other, but may alias global storage.@*
11192 @option{-fargument-noalias-global} specifies that arguments do not
11193 alias each other and do not alias global storage.
11194
11195 Each language will automatically use whatever option is required by
11196 the language standard.  You should not need to use these options yourself.
11197
11198 @item -fleading-underscore
11199 @opindex fleading-underscore
11200 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11201 change the way C symbols are represented in the object file.  One use
11202 is to help link with legacy assembly code.
11203
11204 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11205 generate code that is not binary compatible with code generated without that
11206 switch.  Use it to conform to a non-default application binary interface.
11207 Not all targets provide complete support for this switch.
11208
11209 @item -ftls-model=@var{model}
11210 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11211 The @var{model} argument should be one of @code{global-dynamic},
11212 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11213
11214 The default without @option{-fpic} is @code{initial-exec}; with
11215 @option{-fpic} the default is @code{global-dynamic}.
11216 @end table
11217
11218 @c man end
11219
11220 @node Environment Variables
11221 @section Environment Variables Affecting GCC
11222 @cindex environment variables
11223
11224 @c man begin ENVIRONMENT
11225 This section describes several environment variables that affect how GCC
11226 operates.  Some of them work by specifying directories or prefixes to use
11227 when searching for various kinds of files.  Some are used to specify other
11228 aspects of the compilation environment.
11229
11230 Note that you can also specify places to search using options such as
11231 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11232 take precedence over places specified using environment variables, which
11233 in turn take precedence over those specified by the configuration of GCC@.
11234 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11235 GNU Compiler Collection (GCC) Internals}.
11236
11237 @table @env
11238 @item LANG
11239 @itemx LC_CTYPE
11240 @c @itemx LC_COLLATE
11241 @itemx LC_MESSAGES
11242 @c @itemx LC_MONETARY
11243 @c @itemx LC_NUMERIC
11244 @c @itemx LC_TIME
11245 @itemx LC_ALL
11246 @findex LANG
11247 @findex LC_CTYPE
11248 @c @findex LC_COLLATE
11249 @findex LC_MESSAGES
11250 @c @findex LC_MONETARY
11251 @c @findex LC_NUMERIC
11252 @c @findex LC_TIME
11253 @findex LC_ALL
11254 @cindex locale
11255 These environment variables control the way that GCC uses
11256 localization information that allow GCC to work with different
11257 national conventions.  GCC inspects the locale categories
11258 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11259 so.  These locale categories can be set to any value supported by your
11260 installation.  A typical value is @samp{en_UK} for English in the United
11261 Kingdom.
11262
11263 The @env{LC_CTYPE} environment variable specifies character
11264 classification.  GCC uses it to determine the character boundaries in
11265 a string; this is needed for some multibyte encodings that contain quote
11266 and escape characters that would otherwise be interpreted as a string
11267 end or escape.
11268
11269 The @env{LC_MESSAGES} environment variable specifies the language to
11270 use in diagnostic messages.
11271
11272 If the @env{LC_ALL} environment variable is set, it overrides the value
11273 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11274 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11275 environment variable.  If none of these variables are set, GCC
11276 defaults to traditional C English behavior.
11277
11278 @item TMPDIR
11279 @findex TMPDIR
11280 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11281 files.  GCC uses temporary files to hold the output of one stage of
11282 compilation which is to be used as input to the next stage: for example,
11283 the output of the preprocessor, which is the input to the compiler
11284 proper.
11285
11286 @item GCC_EXEC_PREFIX
11287 @findex GCC_EXEC_PREFIX
11288 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11289 names of the subprograms executed by the compiler.  No slash is added
11290 when this prefix is combined with the name of a subprogram, but you can
11291 specify a prefix that ends with a slash if you wish.
11292
11293 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11294 an appropriate prefix to use based on the pathname it was invoked with.
11295
11296 If GCC cannot find the subprogram using the specified prefix, it
11297 tries looking in the usual places for the subprogram.
11298
11299 The default value of @env{GCC_EXEC_PREFIX} is
11300 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11301 of @code{prefix} when you ran the @file{configure} script.
11302
11303 Other prefixes specified with @option{-B} take precedence over this prefix.
11304
11305 This prefix is also used for finding files such as @file{crt0.o} that are
11306 used for linking.
11307
11308 In addition, the prefix is used in an unusual way in finding the
11309 directories to search for header files.  For each of the standard
11310 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11311 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11312 replacing that beginning with the specified prefix to produce an
11313 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11314 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11315 These alternate directories are searched first; the standard directories
11316 come next.
11317
11318 @item COMPILER_PATH
11319 @findex COMPILER_PATH
11320 The value of @env{COMPILER_PATH} is a colon-separated list of
11321 directories, much like @env{PATH}.  GCC tries the directories thus
11322 specified when searching for subprograms, if it can't find the
11323 subprograms using @env{GCC_EXEC_PREFIX}.
11324
11325 @item LIBRARY_PATH
11326 @findex LIBRARY_PATH
11327 The value of @env{LIBRARY_PATH} is a colon-separated list of
11328 directories, much like @env{PATH}.  When configured as a native compiler,
11329 GCC tries the directories thus specified when searching for special
11330 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11331 using GCC also uses these directories when searching for ordinary
11332 libraries for the @option{-l} option (but directories specified with
11333 @option{-L} come first).
11334
11335 @item LANG
11336 @findex LANG
11337 @cindex locale definition
11338 This variable is used to pass locale information to the compiler.  One way in
11339 which this information is used is to determine the character set to be used
11340 when character literals, string literals and comments are parsed in C and C++.
11341 When the compiler is configured to allow multibyte characters,
11342 the following values for @env{LANG} are recognized:
11343
11344 @table @samp
11345 @item C-JIS
11346 Recognize JIS characters.
11347 @item C-SJIS
11348 Recognize SJIS characters.
11349 @item C-EUCJP
11350 Recognize EUCJP characters.
11351 @end table
11352
11353 If @env{LANG} is not defined, or if it has some other value, then the
11354 compiler will use mblen and mbtowc as defined by the default locale to
11355 recognize and translate multibyte characters.
11356 @end table
11357
11358 @noindent
11359 Some additional environments variables affect the behavior of the
11360 preprocessor.
11361
11362 @include cppenv.texi
11363
11364 @c man end
11365
11366 @node Precompiled Headers
11367 @section Using Precompiled Headers
11368 @cindex precompiled headers
11369 @cindex speed of compilation
11370
11371 Often large projects have many header files that are included in every
11372 source file.  The time the compiler takes to process these header files
11373 over and over again can account for nearly all of the time required to
11374 build the project.  To make builds faster, GCC allows users to
11375 `precompile' a header file; then, if builds can use the precompiled
11376 header file they will be much faster.
11377
11378 To create a precompiled header file, simply compile it as you would any
11379 other file, if necessary using the @option{-x} option to make the driver
11380 treat it as a C or C++ header file.  You will probably want to use a
11381 tool like @command{make} to keep the precompiled header up-to-date when
11382 the headers it contains change.
11383
11384 A precompiled header file will be searched for when @code{#include} is
11385 seen in the compilation.  As it searches for the included file
11386 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11387 compiler looks for a precompiled header in each directory just before it
11388 looks for the include file in that directory.  The name searched for is
11389 the name specified in the @code{#include} with @samp{.gch} appended.  If
11390 the precompiled header file can't be used, it is ignored.
11391
11392 For instance, if you have @code{#include "all.h"}, and you have
11393 @file{all.h.gch} in the same directory as @file{all.h}, then the
11394 precompiled header file will be used if possible, and the original
11395 header will be used otherwise.
11396
11397 Alternatively, you might decide to put the precompiled header file in a
11398 directory and use @option{-I} to ensure that directory is searched
11399 before (or instead of) the directory containing the original header.
11400 Then, if you want to check that the precompiled header file is always
11401 used, you can put a file of the same name as the original header in this
11402 directory containing an @code{#error} command.
11403
11404 This also works with @option{-include}.  So yet another way to use
11405 precompiled headers, good for projects not designed with precompiled
11406 header files in mind, is to simply take most of the header files used by
11407 a project, include them from another header file, precompile that header
11408 file, and @option{-include} the precompiled header.  If the header files
11409 have guards against multiple inclusion, they will be skipped because
11410 they've already been included (in the precompiled header).
11411
11412 If you need to precompile the same header file for different
11413 languages, targets, or compiler options, you can instead make a
11414 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11415 header in the directory.  (It doesn't matter what you call the files
11416 in the directory, every precompiled header in the directory will be
11417 considered.)  The first precompiled header encountered in the
11418 directory that is valid for this compilation will be used; they're
11419 searched in no particular order.
11420
11421 There are many other possibilities, limited only by your imagination,
11422 good sense, and the constraints of your build system.
11423
11424 A precompiled header file can be used only when these conditions apply:
11425
11426 @itemize
11427 @item
11428 Only one precompiled header can be used in a particular compilation.
11429 @item
11430 A precompiled header can't be used once the first C token is seen.  You
11431 can have preprocessor directives before a precompiled header; you can
11432 even include a precompiled header from inside another header, so long as
11433 there are no C tokens before the @code{#include}.
11434 @item
11435 The precompiled header file must be produced for the same language as
11436 the current compilation.  You can't use a C precompiled header for a C++
11437 compilation.
11438 @item
11439 The precompiled header file must be produced by the same compiler
11440 version and configuration as the current compilation is using.
11441 The easiest way to guarantee this is to use the same compiler binary
11442 for creating and using precompiled headers.
11443 @item
11444 Any macros defined before the precompiled header (including with
11445 @option{-D}) must either be defined in the same way as when the
11446 precompiled header was generated, or must not affect the precompiled
11447 header, which usually means that the they don't appear in the
11448 precompiled header at all.
11449 @item
11450 Certain command-line options must be defined in the same way as when the
11451 precompiled header was generated.  At present, it's not clear which
11452 options are safe to change and which are not; the safest choice is to
11453 use exactly the same options when generating and using the precompiled
11454 header.
11455 @end itemize
11456
11457 For all of these but the last, the compiler will automatically ignore
11458 the precompiled header if the conditions aren't met.  For the last item,
11459 some option changes will cause the precompiled header to be rejected,
11460 but not all incompatible option combinations have yet been found.  If
11461 you find a new incompatible combination, please consider filing a bug
11462 report, see @ref{Bugs}.
11463
11464 @node Running Protoize
11465 @section Running Protoize
11466
11467 The program @code{protoize} is an optional part of GCC@.  You can use
11468 it to add prototypes to a program, thus converting the program to ISO
11469 C in one respect.  The companion program @code{unprotoize} does the
11470 reverse: it removes argument types from any prototypes that are found.
11471
11472 When you run these programs, you must specify a set of source files as
11473 command line arguments.  The conversion programs start out by compiling
11474 these files to see what functions they define.  The information gathered
11475 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11476
11477 After scanning comes actual conversion.  The specified files are all
11478 eligible to be converted; any files they include (whether sources or
11479 just headers) are eligible as well.
11480
11481 But not all the eligible files are converted.  By default,
11482 @code{protoize} and @code{unprotoize} convert only source and header
11483 files in the current directory.  You can specify additional directories
11484 whose files should be converted with the @option{-d @var{directory}}
11485 option.  You can also specify particular files to exclude with the
11486 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11487 directory name matches one of the specified directory names, and its
11488 name within the directory has not been excluded.
11489
11490 Basic conversion with @code{protoize} consists of rewriting most
11491 function definitions and function declarations to specify the types of
11492 the arguments.  The only ones not rewritten are those for varargs
11493 functions.
11494
11495 @code{protoize} optionally inserts prototype declarations at the
11496 beginning of the source file, to make them available for any calls that
11497 precede the function's definition.  Or it can insert prototype
11498 declarations with block scope in the blocks where undeclared functions
11499 are called.
11500
11501 Basic conversion with @code{unprotoize} consists of rewriting most
11502 function declarations to remove any argument types, and rewriting
11503 function definitions to the old-style pre-ISO form.
11504
11505 Both conversion programs print a warning for any function declaration or
11506 definition that they can't convert.  You can suppress these warnings
11507 with @option{-q}.
11508
11509 The output from @code{protoize} or @code{unprotoize} replaces the
11510 original source file.  The original file is renamed to a name ending
11511 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11512 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11513 for DOS) file already exists, then the source file is simply discarded.
11514
11515 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11516 scan the program and collect information about the functions it uses.
11517 So neither of these programs will work until GCC is installed.
11518
11519 Here is a table of the options you can use with @code{protoize} and
11520 @code{unprotoize}.  Each option works with both programs unless
11521 otherwise stated.
11522
11523 @table @code
11524 @item -B @var{directory}
11525 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11526 usual directory (normally @file{/usr/local/lib}).  This file contains
11527 prototype information about standard system functions.  This option
11528 applies only to @code{protoize}.
11529
11530 @item -c @var{compilation-options}
11531 Use @var{compilation-options} as the options when running @command{gcc} to
11532 produce the @samp{.X} files.  The special option @option{-aux-info} is
11533 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11534
11535 Note that the compilation options must be given as a single argument to
11536 @code{protoize} or @code{unprotoize}.  If you want to specify several
11537 @command{gcc} options, you must quote the entire set of compilation options
11538 to make them a single word in the shell.
11539
11540 There are certain @command{gcc} arguments that you cannot use, because they
11541 would produce the wrong kind of output.  These include @option{-g},
11542 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11543 the @var{compilation-options}, they are ignored.
11544
11545 @item -C
11546 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11547 systems) instead of @samp{.c}.  This is convenient if you are converting
11548 a C program to C++.  This option applies only to @code{protoize}.
11549
11550 @item -g
11551 Add explicit global declarations.  This means inserting explicit
11552 declarations at the beginning of each source file for each function
11553 that is called in the file and was not declared.  These declarations
11554 precede the first function definition that contains a call to an
11555 undeclared function.  This option applies only to @code{protoize}.
11556
11557 @item -i @var{string}
11558 Indent old-style parameter declarations with the string @var{string}.
11559 This option applies only to @code{protoize}.
11560
11561 @code{unprotoize} converts prototyped function definitions to old-style
11562 function definitions, where the arguments are declared between the
11563 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11564 uses five spaces as the indentation.  If you want to indent with just
11565 one space instead, use @option{-i " "}.
11566
11567 @item -k
11568 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11569 is finished.
11570
11571 @item -l
11572 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11573 a prototype declaration for each function in each block which calls the
11574 function without any declaration.  This option applies only to
11575 @code{protoize}.
11576
11577 @item -n
11578 Make no real changes.  This mode just prints information about the conversions
11579 that would have been done without @option{-n}.
11580
11581 @item -N
11582 Make no @samp{.save} files.  The original files are simply deleted.
11583 Use this option with caution.
11584
11585 @item -p @var{program}
11586 Use the program @var{program} as the compiler.  Normally, the name
11587 @file{gcc} is used.
11588
11589 @item -q
11590 Work quietly.  Most warnings are suppressed.
11591
11592 @item -v
11593 Print the version number, just like @option{-v} for @command{gcc}.
11594 @end table
11595
11596 If you need special compiler options to compile one of your program's
11597 source files, then you should generate that file's @samp{.X} file
11598 specially, by running @command{gcc} on that source file with the
11599 appropriate options and the option @option{-aux-info}.  Then run
11600 @code{protoize} on the entire set of files.  @code{protoize} will use
11601 the existing @samp{.X} file because it is newer than the source file.
11602 For example:
11603
11604 @smallexample
11605 gcc -Dfoo=bar file1.c -aux-info file1.X
11606 protoize *.c
11607 @end smallexample
11608
11609 @noindent
11610 You need to include the special files along with the rest in the
11611 @code{protoize} command, even though their @samp{.X} files already
11612 exist, because otherwise they won't get converted.
11613
11614 @xref{Protoize Caveats}, for more information on how to use
11615 @code{protoize} successfully.