Initial import of binutils 2.22 on the new vendor branch
[dragonfly.git] / contrib / gcc-4.1 / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @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}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and 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}  -combine -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}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -ffriend-injection  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstack-protector @gol
242 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
243 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
244 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
245 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
246 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
247 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
248 -Wvolatile-register-var  -Wwrite-strings}
249
250 @item C-only Warning Options
251 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
252 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
253 -Wstrict-prototypes  -Wtraditional @gol
254 -Wdeclaration-after-statement -Wpointer-sign}
255
256 @item Debugging Options
257 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
258 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
259 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
260 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
261 -fdump-ipa-all -fdump-ipa-cgraph @gol
262 -fdump-tree-all @gol
263 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
264 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
267 -fdump-tree-ch @gol
268 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-nrv -fdump-tree-vect @gol
277 -fdump-tree-sink @gol
278 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-salias @gol
280 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
282 -ftree-vectorizer-verbose=@var{n} @gol
283 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
284 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
285 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
286 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
287 -ftest-coverage  -ftime-report -fvar-tracking @gol
288 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
289 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
290 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
291 -print-multi-directory  -print-multi-lib @gol
292 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
293 -save-temps  -time}
294
295 @item Optimization Options
296 @xref{Optimize Options,,Options that Control Optimization}.
297 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
298 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
299 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
300 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
301 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
302 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
303 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
304 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
305 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
306 -fforce-addr  -ffunction-sections @gol
307 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
308 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
309 -finline-functions  -finline-functions-called-once @gol
310 -finline-limit=@var{n}  -fkeep-inline-functions @gol
311 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
312 -fmodulo-sched -fno-branch-count-reg @gol
313 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
314 -fno-function-cse  -fno-guess-branch-probability @gol
315 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
316 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
317 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
318 -fomit-frame-pointer  -foptimize-register-move @gol
319 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
320 -fprofile-generate -fprofile-use @gol
321 -fregmove  -frename-registers @gol
322 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
323 -frerun-cse-after-loop  -frerun-loop-opt @gol
324 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
325 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
326 -fsched-spec-load-dangerous  @gol
327 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
328 -fsched2-use-superblocks @gol
329 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
330 -fsignaling-nans -fsingle-precision-constant  @gol
331 -fstack-protector  -fstack-protector-all @gol
332 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
333 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
334 -fsplit-ivs-in-unroller -funswitch-loops @gol
335 -fvariable-expansion-in-unroller @gol
336 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
337 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
338 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
339 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
340 -ftree-vect-loop-version -ftree-salias -fweb @gol
341 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
342 --param @var{name}=@var{value}
343 -O  -O0  -O1  -O2  -O3  -Os}
344
345 @item Preprocessor Options
346 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
347 @gccoptlist{-A@var{question}=@var{answer} @gol
348 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
349 -C  -dD  -dI  -dM  -dN @gol
350 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
351 -idirafter @var{dir} @gol
352 -include @var{file}  -imacros @var{file} @gol
353 -iprefix @var{file}  -iwithprefix @var{dir} @gol
354 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
355 -isysroot @var{dir} @gol
356 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
357 -P  -fworking-directory  -remap @gol
358 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
359 -Xpreprocessor @var{option}}
360
361 @item Assembler Option
362 @xref{Assembler Options,,Passing Options to the Assembler}.
363 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
364
365 @item Linker Options
366 @xref{Link Options,,Options for Linking}.
367 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
368 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
369 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
370 -Wl,@var{option}  -Xlinker @var{option} @gol
371 -u @var{symbol}}
372
373 @item Directory Options
374 @xref{Directory Options,,Options for Directory Search}.
375 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
376 -specs=@var{file}  -I- --sysroot=@var{dir}}
377
378 @item Target Options
379 @c I wrote this xref this way to avoid overfull hbox. -- rms
380 @xref{Target Options}.
381 @gccoptlist{-V @var{version}  -b @var{machine}}
382
383 @item Machine Dependent Options
384 @xref{Submodel Options,,Hardware Models and Configurations}.
385 @c This list is ordered alphanumerically by subsection name.
386 @c Try and put the significant identifier (CPU or system) first,
387 @c so users have a clue at guessing where the ones they want will be.
388
389 @emph{ARC Options}
390 @gccoptlist{-EB  -EL @gol
391 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
392 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
393
394 @emph{ARM Options}
395 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
396 -mabi=@var{name} @gol
397 -mapcs-stack-check  -mno-apcs-stack-check @gol
398 -mapcs-float  -mno-apcs-float @gol
399 -mapcs-reentrant  -mno-apcs-reentrant @gol
400 -msched-prolog  -mno-sched-prolog @gol
401 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
402 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
403 -mthumb-interwork  -mno-thumb-interwork @gol
404 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
405 -mstructure-size-boundary=@var{n} @gol
406 -mabort-on-noreturn @gol
407 -mlong-calls  -mno-long-calls @gol
408 -msingle-pic-base  -mno-single-pic-base @gol
409 -mpic-register=@var{reg} @gol
410 -mnop-fun-dllimport @gol
411 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
412 -mpoke-function-name @gol
413 -mthumb  -marm @gol
414 -mtpcs-frame  -mtpcs-leaf-frame @gol
415 -mcaller-super-interworking  -mcallee-super-interworking @gol
416 -mtp=@var{name}}
417
418 @emph{AVR Options}
419 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
420 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
421
422 @emph{Blackfin Options}
423 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
424 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
425 -mlow-64k -mno-low64k -mid-shared-library @gol
426 -mno-id-shared-library -mshared-library-id=@var{n} @gol
427 -mlong-calls  -mno-long-calls}
428
429 @emph{CRIS Options}
430 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
431 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
432 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
433 -mstack-align  -mdata-align  -mconst-align @gol
434 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
435 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
436 -mmul-bug-workaround  -mno-mul-bug-workaround}
437
438 @emph{CRX Options}
439 @gccoptlist{-mmac -mpush-args}
440
441 @emph{Darwin Options}
442 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
443 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
444 -client_name  -compatibility_version  -current_version @gol
445 -dead_strip @gol
446 -dependency-file  -dylib_file  -dylinker_install_name @gol
447 -dynamic  -dynamiclib  -exported_symbols_list @gol
448 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
449 -force_flat_namespace  -headerpad_max_install_names @gol
450 -image_base  -init  -install_name  -keep_private_externs @gol
451 -multi_module  -multiply_defined  -multiply_defined_unused @gol
452 -noall_load   -no_dead_strip_inits_and_terms @gol
453 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
454 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
455 -private_bundle  -read_only_relocs  -sectalign @gol
456 -sectobjectsymbols  -whyload  -seg1addr @gol
457 -sectcreate  -sectobjectsymbols  -sectorder @gol
458 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
459 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
460 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
461 -single_module  -static  -sub_library  -sub_umbrella @gol
462 -twolevel_namespace  -umbrella  -undefined @gol
463 -unexported_symbols_list  -weak_reference_mismatches @gol
464 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
465 -mone-byte-bool}
466
467 @emph{DEC Alpha Options}
468 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
469 -mieee  -mieee-with-inexact  -mieee-conformant @gol
470 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
471 -mtrap-precision=@var{mode}  -mbuild-constants @gol
472 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
473 -mbwx  -mmax  -mfix  -mcix @gol
474 -mfloat-vax  -mfloat-ieee @gol
475 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
476 -msmall-text  -mlarge-text @gol
477 -mmemory-latency=@var{time}}
478
479 @emph{DEC Alpha/VMS Options}
480 @gccoptlist{-mvms-return-codes}
481
482 @emph{FRV Options}
483 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
484 -mhard-float  -msoft-float @gol
485 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
486 -mdouble  -mno-double @gol
487 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
488 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
489 -mlinked-fp  -mlong-calls  -malign-labels @gol
490 -mlibrary-pic  -macc-4  -macc-8 @gol
491 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
492 -moptimize-membar -mno-optimize-membar @gol
493 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
494 -mvliw-branch  -mno-vliw-branch @gol
495 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
496 -mno-nested-cond-exec  -mtomcat-stats @gol
497 -mTLS -mtls @gol
498 -mcpu=@var{cpu}}
499
500 @emph{H8/300 Options}
501 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
502
503 @emph{HPPA Options}
504 @gccoptlist{-march=@var{architecture-type} @gol
505 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
506 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
507 -mfixed-range=@var{register-range} @gol
508 -mjump-in-delay -mlinker-opt -mlong-calls @gol
509 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
510 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
511 -mno-jump-in-delay  -mno-long-load-store @gol
512 -mno-portable-runtime  -mno-soft-float @gol
513 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
514 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
515 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
516 -munix=@var{unix-std}  -nolibdld  -static  -threads}
517
518 @emph{i386 and x86-64 Options}
519 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
520 -mfpmath=@var{unit} @gol
521 -masm=@var{dialect}  -mno-fancy-math-387 @gol
522 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
523 -mno-wide-multiply  -mrtd  -malign-double @gol
524 -mpreferred-stack-boundary=@var{num} @gol
525 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
526 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
527 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
528 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
529 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
530 -mcmodel=@var{code-model} @gol
531 -m32  -m64 -mlarge-data-threshold=@var{num}}
532
533 @emph{IA-64 Options}
534 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
535 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
536 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
537 -minline-float-divide-max-throughput @gol
538 -minline-int-divide-min-latency @gol
539 -minline-int-divide-max-throughput  @gol
540 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
541 -mno-dwarf2-asm -mearly-stop-bits @gol
542 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
543 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
544
545 @emph{M32R/D Options}
546 @gccoptlist{-m32r2 -m32rx -m32r @gol
547 -mdebug @gol
548 -malign-loops -mno-align-loops @gol
549 -missue-rate=@var{number} @gol
550 -mbranch-cost=@var{number} @gol
551 -mmodel=@var{code-size-model-type} @gol
552 -msdata=@var{sdata-type} @gol
553 -mno-flush-func -mflush-func=@var{name} @gol
554 -mno-flush-trap -mflush-trap=@var{number} @gol
555 -G @var{num}}
556
557 @emph{M32C Options}
558 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
559
560 @emph{M680x0 Options}
561 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
562 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
563 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
564 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
565 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
566
567 @emph{M68hc1x Options}
568 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
569 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
570 -msoft-reg-count=@var{count}}
571
572 @emph{MCore Options}
573 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
574 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
575 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
576 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
577 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
578
579 @emph{MIPS Options}
580 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
581 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
582 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
583 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
584 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
585 -mdsp  -mpaired-single  -mips3d @gol
586 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
587 -G@var{num}  -membedded-data  -mno-embedded-data @gol
588 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
589 -msplit-addresses  -mno-split-addresses  @gol
590 -mexplicit-relocs  -mno-explicit-relocs  @gol
591 -mcheck-zero-division  -mno-check-zero-division @gol
592 -mdivide-traps  -mdivide-breaks @gol
593 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
594 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
595 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
596 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
597 -mfix-sb1  -mno-fix-sb1 @gol
598 -mflush-func=@var{func}  -mno-flush-func @gol
599 -mbranch-likely  -mno-branch-likely @gol
600 -mfp-exceptions -mno-fp-exceptions @gol
601 -mvr4130-align -mno-vr4130-align}
602
603 @emph{MMIX Options}
604 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
605 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
606 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
607 -mno-base-addresses  -msingle-exit  -mno-single-exit}
608
609 @emph{MN10300 Options}
610 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
611 -mam33  -mno-am33 @gol
612 -mam33-2  -mno-am33-2 @gol
613 -mreturn-pointer-on-d0 @gol
614 -mno-crt0  -mrelax}
615
616 @emph{MT Options}
617 @gccoptlist{-mno-crt0 -mbacc -msim @gol
618 -march=@var{cpu-type} }
619
620 @emph{PDP-11 Options}
621 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
622 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
623 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
624 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
625 -mbranch-expensive  -mbranch-cheap @gol
626 -msplit  -mno-split  -munix-asm  -mdec-asm}
627
628 @emph{PowerPC Options}
629 See RS/6000 and PowerPC Options.
630
631 @emph{RS/6000 and PowerPC Options}
632 @gccoptlist{-mcpu=@var{cpu-type} @gol
633 -mtune=@var{cpu-type} @gol
634 -mpower  -mno-power  -mpower2  -mno-power2 @gol
635 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
636 -maltivec  -mno-altivec @gol
637 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
638 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
639 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
640 -mnew-mnemonics  -mold-mnemonics @gol
641 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
642 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
643 -malign-power  -malign-natural @gol
644 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
645 -mstring  -mno-string  -mupdate  -mno-update @gol
646 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
647 -mstrict-align  -mno-strict-align  -mrelocatable @gol
648 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
649 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
650 -mdynamic-no-pic  -maltivec  -mswdiv @gol
651 -mprioritize-restricted-insns=@var{priority} @gol
652 -msched-costly-dep=@var{dependence_type} @gol
653 -minsert-sched-nops=@var{scheme} @gol
654 -mcall-sysv  -mcall-netbsd @gol
655 -maix-struct-return  -msvr4-struct-return @gol
656 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
657 -misel -mno-isel @gol
658 -misel=yes  -misel=no @gol
659 -mspe -mno-spe @gol
660 -mspe=yes  -mspe=no @gol
661 -mvrsave -mno-vrsave @gol
662 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
663 -mprototype  -mno-prototype @gol
664 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
665 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
666
667 @emph{S/390 and zSeries Options}
668 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
669 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
670 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
671 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
672 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
673 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
674 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
675
676 @emph{SH Options}
677 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
678 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
679 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
680 -m5-64media  -m5-64media-nofpu @gol
681 -m5-32media  -m5-32media-nofpu @gol
682 -m5-compact  -m5-compact-nofpu @gol
683 -mb  -ml  -mdalign  -mrelax @gol
684 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
685 -mieee  -misize  -mpadstruct  -mspace @gol
686 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
687 -mdivsi3_libfunc=@var{name}  @gol
688 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
689  -minvalid-symbols}
690
691 @emph{SPARC Options}
692 @gccoptlist{-mcpu=@var{cpu-type} @gol
693 -mtune=@var{cpu-type} @gol
694 -mcmodel=@var{code-model} @gol
695 -m32  -m64  -mapp-regs  -mno-app-regs @gol
696 -mfaster-structs  -mno-faster-structs @gol
697 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
698 -mhard-quad-float  -msoft-quad-float @gol
699 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
700 -mstack-bias  -mno-stack-bias @gol
701 -munaligned-doubles  -mno-unaligned-doubles @gol
702 -mv8plus  -mno-v8plus  -mvis  -mno-vis
703 -threads -pthreads -pthread}
704
705 @emph{System V Options}
706 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
707
708 @emph{TMS320C3x/C4x Options}
709 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
710 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
711 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
712 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
713
714 @emph{V850 Options}
715 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
716 -mprolog-function  -mno-prolog-function  -mspace @gol
717 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
718 -mapp-regs  -mno-app-regs @gol
719 -mdisable-callt  -mno-disable-callt @gol
720 -mv850e1 @gol
721 -mv850e @gol
722 -mv850  -mbig-switch}
723
724 @emph{VAX Options}
725 @gccoptlist{-mg  -mgnu  -munix}
726
727 @emph{x86-64 Options}
728 See i386 and x86-64 Options.
729
730 @emph{Xstormy16 Options}
731 @gccoptlist{-msim}
732
733 @emph{Xtensa Options}
734 @gccoptlist{-mconst16 -mno-const16 @gol
735 -mfused-madd  -mno-fused-madd @gol
736 -mtext-section-literals  -mno-text-section-literals @gol
737 -mtarget-align  -mno-target-align @gol
738 -mlongcalls  -mno-longcalls}
739
740 @emph{zSeries Options}
741 See S/390 and zSeries Options.
742
743 @item Code Generation Options
744 @xref{Code Gen Options,,Options for Code Generation Conventions}.
745 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
746 -ffixed-@var{reg}  -fexceptions @gol
747 -fnon-call-exceptions  -funwind-tables @gol
748 -fasynchronous-unwind-tables @gol
749 -finhibit-size-directive  -finstrument-functions @gol
750 -fno-common  -fno-ident @gol
751 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
752 -fno-jump-tables @gol
753 -freg-struct-return  -fshared-data  -fshort-enums @gol
754 -fshort-double  -fshort-wchar @gol
755 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
756 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
757 -fargument-alias  -fargument-noalias @gol
758 -fargument-noalias-global  -fleading-underscore @gol
759 -ftls-model=@var{model} @gol
760 -ftrapv  -fwrapv  -fbounds-check @gol
761 -fvisibility}
762 @end table
763
764 @menu
765 * Overall Options::     Controlling the kind of output:
766                         an executable, object files, assembler files,
767                         or preprocessed source.
768 * C Dialect Options::   Controlling the variant of C language compiled.
769 * C++ Dialect Options:: Variations on C++.
770 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
771                         and Objective-C++.
772 * Language Independent Options:: Controlling how diagnostics should be
773                         formatted.
774 * Warning Options::     How picky should the compiler be?
775 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
776 * Optimize Options::    How much optimization?
777 * Preprocessor Options:: Controlling header files and macro definitions.
778                          Also, getting dependency information for Make.
779 * Assembler Options::   Passing options to the assembler.
780 * Link Options::        Specifying libraries and so on.
781 * Directory Options::   Where to find header files and libraries.
782                         Where to find the compiler executable files.
783 * Spec Files::          How to pass switches to sub-processes.
784 * Target Options::      Running a cross-compiler, or an old version of GCC.
785 @end menu
786
787 @node Overall Options
788 @section Options Controlling the Kind of Output
789
790 Compilation can involve up to four stages: preprocessing, compilation
791 proper, assembly and linking, always in that order.  GCC is capable of
792 preprocessing and compiling several files either into several
793 assembler input files, or into one assembler input file; then each
794 assembler input file produces an object file, and linking combines all
795 the object files (those newly compiled, and those specified as input)
796 into an executable file.
797
798 @cindex file name suffix
799 For any given input file, the file name suffix determines what kind of
800 compilation is done:
801
802 @table @gcctabopt
803 @item @var{file}.c
804 C source code which must be preprocessed.
805
806 @item @var{file}.i
807 C source code which should not be preprocessed.
808
809 @item @var{file}.ii
810 C++ source code which should not be preprocessed.
811
812 @item @var{file}.m
813 Objective-C source code.  Note that you must link with the @file{libobjc}
814 library to make an Objective-C program work.
815
816 @item @var{file}.mi
817 Objective-C source code which should not be preprocessed.
818
819 @item @var{file}.mm
820 @itemx @var{file}.M
821 Objective-C++ source code.  Note that you must link with the @file{libobjc}
822 library to make an Objective-C++ program work.  Note that @samp{.M} refers
823 to a literal capital M@.
824
825 @item @var{file}.mii
826 Objective-C++ source code which should not be preprocessed.
827
828 @item @var{file}.h
829 C, C++, Objective-C or Objective-C++ header file to be turned into a
830 precompiled header.
831
832 @item @var{file}.cc
833 @itemx @var{file}.cp
834 @itemx @var{file}.cxx
835 @itemx @var{file}.cpp
836 @itemx @var{file}.CPP
837 @itemx @var{file}.c++
838 @itemx @var{file}.C
839 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
840 the last two letters must both be literally @samp{x}.  Likewise,
841 @samp{.C} refers to a literal capital C@.
842
843 @item @var{file}.mm
844 @itemx @var{file}.M
845 Objective-C++ source code which must be preprocessed.
846
847 @item @var{file}.mii
848 Objective-C++ source code which should not be preprocessed.
849
850 @item @var{file}.hh
851 @itemx @var{file}.H
852 C++ header file to be turned into a precompiled header.
853
854 @item @var{file}.f
855 @itemx @var{file}.for
856 @itemx @var{file}.FOR
857 Fixed form Fortran source code which should not be preprocessed.
858
859 @item @var{file}.F
860 @itemx @var{file}.fpp
861 @itemx @var{file}.FPP
862 Fixed form Fortran source code which must be preprocessed (with the traditional
863 preprocessor).
864
865 @item @var{file}.f90
866 @itemx @var{file}.f95
867 Free form Fortran source code which should not be preprocessed.
868
869 @item @var{file}.F90
870 @itemx @var{file}.F95
871 Free form Fortran source code which must be preprocessed (with the
872 traditional preprocessor).
873
874 @c FIXME: Descriptions of Java file types.
875 @c @var{file}.java
876 @c @var{file}.class
877 @c @var{file}.zip
878 @c @var{file}.jar
879
880 @item @var{file}.ads
881 Ada source code file which contains a library unit declaration (a
882 declaration of a package, subprogram, or generic, or a generic
883 instantiation), or a library unit renaming declaration (a package,
884 generic, or subprogram renaming declaration).  Such files are also
885 called @dfn{specs}.
886
887 @itemx @var{file}.adb
888 Ada source code file containing a library unit body (a subprogram or
889 package body).  Such files are also called @dfn{bodies}.
890
891 @c GCC also knows about some suffixes for languages not yet included:
892 @c Pascal:
893 @c @var{file}.p
894 @c @var{file}.pas
895 @c Ratfor:
896 @c @var{file}.r
897
898 @item @var{file}.s
899 Assembler code.
900
901 @item @var{file}.S
902 Assembler code which must be preprocessed.
903
904 @item @var{other}
905 An object file to be fed straight into linking.
906 Any file name with no recognized suffix is treated this way.
907 @end table
908
909 @opindex x
910 You can specify the input language explicitly with the @option{-x} option:
911
912 @table @gcctabopt
913 @item -x @var{language}
914 Specify explicitly the @var{language} for the following input files
915 (rather than letting the compiler choose a default based on the file
916 name suffix).  This option applies to all following input files until
917 the next @option{-x} option.  Possible values for @var{language} are:
918 @smallexample
919 c  c-header  c-cpp-output
920 c++  c++-header  c++-cpp-output
921 objective-c  objective-c-header  objective-c-cpp-output
922 objective-c++ objective-c++-header objective-c++-cpp-output
923 assembler  assembler-with-cpp
924 ada
925 f95  f95-cpp-input
926 java
927 treelang
928 @end smallexample
929
930 @item -x none
931 Turn off any specification of a language, so that subsequent files are
932 handled according to their file name suffixes (as they are if @option{-x}
933 has not been used at all).
934
935 @item -pass-exit-codes
936 @opindex pass-exit-codes
937 Normally the @command{gcc} program will exit with the code of 1 if any
938 phase of the compiler returns a non-success return code.  If you specify
939 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
940 numerically highest error produced by any phase that returned an error
941 indication.
942 @end table
943
944 If you only want some of the stages of compilation, you can use
945 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
946 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
947 @command{gcc} is to stop.  Note that some combinations (for example,
948 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
949
950 @table @gcctabopt
951 @item -c
952 @opindex c
953 Compile or assemble the source files, but do not link.  The linking
954 stage simply is not done.  The ultimate output is in the form of an
955 object file for each source file.
956
957 By default, the object file name for a source file is made by replacing
958 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
959
960 Unrecognized input files, not requiring compilation or assembly, are
961 ignored.
962
963 @item -S
964 @opindex S
965 Stop after the stage of compilation proper; do not assemble.  The output
966 is in the form of an assembler code file for each non-assembler input
967 file specified.
968
969 By default, the assembler file name for a source file is made by
970 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
971
972 Input files that don't require compilation are ignored.
973
974 @item -E
975 @opindex E
976 Stop after the preprocessing stage; do not run the compiler proper.  The
977 output is in the form of preprocessed source code, which is sent to the
978 standard output.
979
980 Input files which don't require preprocessing are ignored.
981
982 @cindex output file option
983 @item -o @var{file}
984 @opindex o
985 Place output in file @var{file}.  This applies regardless to whatever
986 sort of output is being produced, whether it be an executable file,
987 an object file, an assembler file or preprocessed C code.
988
989 If @option{-o} is not specified, the default is to put an executable
990 file in @file{a.out}, the object file for
991 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
992 assembler file in @file{@var{source}.s}, a precompiled header file in
993 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
994 standard output.
995
996 @item -v
997 @opindex v
998 Print (on standard error output) the commands executed to run the stages
999 of compilation.  Also print the version number of the compiler driver
1000 program and of the preprocessor and the compiler proper.
1001
1002 @item -###
1003 @opindex ###
1004 Like @option{-v} except the commands are not executed and all command
1005 arguments are quoted.  This is useful for shell scripts to capture the
1006 driver-generated command lines.
1007
1008 @item -pipe
1009 @opindex pipe
1010 Use pipes rather than temporary files for communication between the
1011 various stages of compilation.  This fails to work on some systems where
1012 the assembler is unable to read from a pipe; but the GNU assembler has
1013 no trouble.
1014
1015 @item -combine
1016 @opindex combine
1017 If you are compiling multiple source files, this option tells the driver
1018 to pass all the source files to the compiler at once (for those
1019 languages for which the compiler can handle this).  This will allow
1020 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1021 language for which this is supported is C@.  If you pass source files for
1022 multiple languages to the driver, using this option, the driver will invoke
1023 the compiler(s) that support IMA once each, passing each compiler all the
1024 source files appropriate for it.  For those languages that do not support
1025 IMA this option will be ignored, and the compiler will be invoked once for
1026 each source file in that language.  If you use this option in conjunction
1027 with @option{-save-temps}, the compiler will generate multiple
1028 pre-processed files
1029 (one for each source file), but only one (combined) @file{.o} or
1030 @file{.s} file.
1031
1032 @item --help
1033 @opindex help
1034 Print (on the standard output) a description of the command line options
1035 understood by @command{gcc}.  If the @option{-v} option is also specified
1036 then @option{--help} will also be passed on to the various processes
1037 invoked by @command{gcc}, so that they can display the command line options
1038 they accept.  If the @option{-Wextra} option is also specified then command
1039 line options which have no documentation associated with them will also
1040 be displayed.
1041
1042 @item --target-help
1043 @opindex target-help
1044 Print (on the standard output) a description of target specific command
1045 line options for each tool.
1046
1047 @item --version
1048 @opindex version
1049 Display the version number and copyrights of the invoked GCC@.
1050 @end table
1051
1052 @node Invoking G++
1053 @section Compiling C++ Programs
1054
1055 @cindex suffixes for C++ source
1056 @cindex C++ source file suffixes
1057 C++ source files conventionally use one of the suffixes @samp{.C},
1058 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1059 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1060 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1061 files with these names and compiles them as C++ programs even if you
1062 call the compiler the same way as for compiling C programs (usually
1063 with the name @command{gcc}).
1064
1065 @findex g++
1066 @findex c++
1067 However, C++ programs often require class libraries as well as a
1068 compiler that understands the C++ language---and under some
1069 circumstances, you might want to compile programs or header files from
1070 standard input, or otherwise without a suffix that flags them as C++
1071 programs.  You might also like to precompile a C header file with a
1072 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1073 program that calls GCC with the default language set to C++, and
1074 automatically specifies linking against the C++ library.  On many
1075 systems, @command{g++} is also installed with the name @command{c++}.
1076
1077 @cindex invoking @command{g++}
1078 When you compile C++ programs, you may specify many of the same
1079 command-line options that you use for compiling programs in any
1080 language; or command-line options meaningful for C and related
1081 languages; or options that are meaningful only for C++ programs.
1082 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1083 explanations of options for languages related to C@.
1084 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1085 explanations of options that are meaningful only for C++ programs.
1086
1087 @node C Dialect Options
1088 @section Options Controlling C Dialect
1089 @cindex dialect options
1090 @cindex language dialect options
1091 @cindex options, dialect
1092
1093 The following options control the dialect of C (or languages derived
1094 from C, such as C++, Objective-C and Objective-C++) that the compiler
1095 accepts:
1096
1097 @table @gcctabopt
1098 @cindex ANSI support
1099 @cindex ISO support
1100 @item -ansi
1101 @opindex ansi
1102 In C mode, support all ISO C90 programs.  In C++ mode,
1103 remove GNU extensions that conflict with ISO C++.
1104
1105 This turns off certain features of GCC that are incompatible with ISO
1106 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1107 such as the @code{asm} and @code{typeof} keywords, and
1108 predefined macros such as @code{unix} and @code{vax} that identify the
1109 type of system you are using.  It also enables the undesirable and
1110 rarely used ISO trigraph feature.  For the C compiler,
1111 it disables recognition of C++ style @samp{//} comments as well as
1112 the @code{inline} keyword.
1113
1114 The alternate keywords @code{__asm__}, @code{__extension__},
1115 @code{__inline__} and @code{__typeof__} continue to work despite
1116 @option{-ansi}.  You would not want to use them in an ISO C program, of
1117 course, but it is useful to put them in header files that might be included
1118 in compilations done with @option{-ansi}.  Alternate predefined macros
1119 such as @code{__unix__} and @code{__vax__} are also available, with or
1120 without @option{-ansi}.
1121
1122 The @option{-ansi} option does not cause non-ISO programs to be
1123 rejected gratuitously.  For that, @option{-pedantic} is required in
1124 addition to @option{-ansi}.  @xref{Warning Options}.
1125
1126 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1127 option is used.  Some header files may notice this macro and refrain
1128 from declaring certain functions or defining certain macros that the
1129 ISO standard doesn't call for; this is to avoid interfering with any
1130 programs that might use these names for other things.
1131
1132 Functions which would normally be built in but do not have semantics
1133 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1134 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1135 built-in functions provided by GCC}, for details of the functions
1136 affected.
1137
1138 @item -std=
1139 @opindex std
1140 Determine the language standard.  This option is currently only
1141 supported when compiling C or C++.  A value for this option must be
1142 provided; possible values are
1143
1144 @table @samp
1145 @item c89
1146 @itemx iso9899:1990
1147 ISO C90 (same as @option{-ansi}).
1148
1149 @item iso9899:199409
1150 ISO C90 as modified in amendment 1.
1151
1152 @item c99
1153 @itemx c9x
1154 @itemx iso9899:1999
1155 @itemx iso9899:199x
1156 ISO C99.  Note that this standard is not yet fully supported; see
1157 @w{@uref{http://gcc.gnu.org/gcc-4.1/c99status.html}} for more information.  The
1158 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1159
1160 @item gnu89
1161 Default, ISO C90 plus GNU extensions (including some C99 features).
1162
1163 @item gnu99
1164 @itemx gnu9x
1165 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1166 this will become the default.  The name @samp{gnu9x} is deprecated.
1167
1168 @item c++98
1169 The 1998 ISO C++ standard plus amendments.
1170
1171 @item gnu++98
1172 The same as @option{-std=c++98} plus GNU extensions.  This is the
1173 default for C++ code.
1174 @end table
1175
1176 Even when this option is not specified, you can still use some of the
1177 features of newer standards in so far as they do not conflict with
1178 previous C standards.  For example, you may use @code{__restrict__} even
1179 when @option{-std=c99} is not specified.
1180
1181 The @option{-std} options specifying some version of ISO C have the same
1182 effects as @option{-ansi}, except that features that were not in ISO C90
1183 but are in the specified version (for example, @samp{//} comments and
1184 the @code{inline} keyword in ISO C99) are not disabled.
1185
1186 @xref{Standards,,Language Standards Supported by GCC}, for details of
1187 these standard versions.
1188
1189 @item -aux-info @var{filename}
1190 @opindex aux-info
1191 Output to the given filename prototyped declarations for all functions
1192 declared and/or defined in a translation unit, including those in header
1193 files.  This option is silently ignored in any language other than C@.
1194
1195 Besides declarations, the file indicates, in comments, the origin of
1196 each declaration (source file and line), whether the declaration was
1197 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1198 @samp{O} for old, respectively, in the first character after the line
1199 number and the colon), and whether it came from a declaration or a
1200 definition (@samp{C} or @samp{F}, respectively, in the following
1201 character).  In the case of function definitions, a K&R-style list of
1202 arguments followed by their declarations is also provided, inside
1203 comments, after the declaration.
1204
1205 @item -fno-asm
1206 @opindex fno-asm
1207 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1208 keyword, so that code can use these words as identifiers.  You can use
1209 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1210 instead.  @option{-ansi} implies @option{-fno-asm}.
1211
1212 In C++, this switch only affects the @code{typeof} keyword, since
1213 @code{asm} and @code{inline} are standard keywords.  You may want to
1214 use the @option{-fno-gnu-keywords} flag instead, which has the same
1215 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1216 switch only affects the @code{asm} and @code{typeof} keywords, since
1217 @code{inline} is a standard keyword in ISO C99.
1218
1219 @item -fno-builtin
1220 @itemx -fno-builtin-@var{function}
1221 @opindex fno-builtin
1222 @cindex built-in functions
1223 Don't recognize built-in functions that do not begin with
1224 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1225 functions provided by GCC}, for details of the functions affected,
1226 including those which are not built-in functions when @option{-ansi} or
1227 @option{-std} options for strict ISO C conformance are used because they
1228 do not have an ISO standard meaning.
1229
1230 GCC normally generates special code to handle certain built-in functions
1231 more efficiently; for instance, calls to @code{alloca} may become single
1232 instructions that adjust the stack directly, and calls to @code{memcpy}
1233 may become inline copy loops.  The resulting code is often both smaller
1234 and faster, but since the function calls no longer appear as such, you
1235 cannot set a breakpoint on those calls, nor can you change the behavior
1236 of the functions by linking with a different library.  In addition,
1237 when a function is recognized as a built-in function, GCC may use
1238 information about that function to warn about problems with calls to
1239 that function, or to generate more efficient code, even if the
1240 resulting code still contains calls to that function.  For example,
1241 warnings are given with @option{-Wformat} for bad calls to
1242 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1243 known not to modify global memory.
1244
1245 With the @option{-fno-builtin-@var{function}} option
1246 only the built-in function @var{function} is
1247 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1248 function is named this is not built-in in this version of GCC, this
1249 option is ignored.  There is no corresponding
1250 @option{-fbuiltin-@var{function}} option; if you wish to enable
1251 built-in functions selectively when using @option{-fno-builtin} or
1252 @option{-ffreestanding}, you may define macros such as:
1253
1254 @smallexample
1255 #define abs(n)          __builtin_abs ((n))
1256 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1257 @end smallexample
1258
1259 @item -fhosted
1260 @opindex fhosted
1261 @cindex hosted environment
1262
1263 Assert that compilation takes place in a hosted environment.  This implies
1264 @option{-fbuiltin}.  A hosted environment is one in which the
1265 entire standard library is available, and in which @code{main} has a return
1266 type of @code{int}.  Examples are nearly everything except a kernel.
1267 This is equivalent to @option{-fno-freestanding}.
1268
1269 @item -ffreestanding
1270 @opindex ffreestanding
1271 @cindex hosted environment
1272
1273 Assert that compilation takes place in a freestanding environment.  This
1274 implies @option{-fno-builtin}.  A freestanding environment
1275 is one in which the standard library may not exist, and program startup may
1276 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1277 This is equivalent to @option{-fno-hosted}.
1278
1279 @xref{Standards,,Language Standards Supported by GCC}, for details of
1280 freestanding and hosted environments.
1281
1282 @item -fms-extensions
1283 @opindex fms-extensions
1284 Accept some non-standard constructs used in Microsoft header files.
1285
1286 Some cases of unnamed fields in structures and unions are only
1287 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1288 fields within structs/unions}, for details.
1289
1290 @item -trigraphs
1291 @opindex trigraphs
1292 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1293 options for strict ISO C conformance) implies @option{-trigraphs}.
1294
1295 @item -no-integrated-cpp
1296 @opindex no-integrated-cpp
1297 Performs a compilation in two passes: preprocessing and compiling.  This
1298 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1299 @option{-B} option.  The user supplied compilation step can then add in
1300 an additional preprocessing step after normal preprocessing but before
1301 compiling.  The default is to use the integrated cpp (internal cpp)
1302
1303 The semantics of this option will change if "cc1", "cc1plus", and
1304 "cc1obj" are merged.
1305
1306 @cindex traditional C language
1307 @cindex C language, traditional
1308 @item -traditional
1309 @itemx -traditional-cpp
1310 @opindex traditional-cpp
1311 @opindex traditional
1312 Formerly, these options caused GCC to attempt to emulate a pre-standard
1313 C compiler.  They are now only supported with the @option{-E} switch.
1314 The preprocessor continues to support a pre-standard mode.  See the GNU
1315 CPP manual for details.
1316
1317 @item -fcond-mismatch
1318 @opindex fcond-mismatch
1319 Allow conditional expressions with mismatched types in the second and
1320 third arguments.  The value of such an expression is void.  This option
1321 is not supported for C++.
1322
1323 @item -funsigned-char
1324 @opindex funsigned-char
1325 Let the type @code{char} be unsigned, like @code{unsigned char}.
1326
1327 Each kind of machine has a default for what @code{char} should
1328 be.  It is either like @code{unsigned char} by default or like
1329 @code{signed char} by default.
1330
1331 Ideally, a portable program should always use @code{signed char} or
1332 @code{unsigned char} when it depends on the signedness of an object.
1333 But many programs have been written to use plain @code{char} and
1334 expect it to be signed, or expect it to be unsigned, depending on the
1335 machines they were written for.  This option, and its inverse, let you
1336 make such a program work with the opposite default.
1337
1338 The type @code{char} is always a distinct type from each of
1339 @code{signed char} or @code{unsigned char}, even though its behavior
1340 is always just like one of those two.
1341
1342 @item -fsigned-char
1343 @opindex fsigned-char
1344 Let the type @code{char} be signed, like @code{signed char}.
1345
1346 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1347 the negative form of @option{-funsigned-char}.  Likewise, the option
1348 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1349
1350 @item -fsigned-bitfields
1351 @itemx -funsigned-bitfields
1352 @itemx -fno-signed-bitfields
1353 @itemx -fno-unsigned-bitfields
1354 @opindex fsigned-bitfields
1355 @opindex funsigned-bitfields
1356 @opindex fno-signed-bitfields
1357 @opindex fno-unsigned-bitfields
1358 These options control whether a bit-field is signed or unsigned, when the
1359 declaration does not use either @code{signed} or @code{unsigned}.  By
1360 default, such a bit-field is signed, because this is consistent: the
1361 basic integer types such as @code{int} are signed types.
1362 @end table
1363
1364 @node C++ Dialect Options
1365 @section Options Controlling C++ Dialect
1366
1367 @cindex compiler options, C++
1368 @cindex C++ options, command line
1369 @cindex options, C++
1370 This section describes the command-line options that are only meaningful
1371 for C++ programs; but you can also use most of the GNU compiler options
1372 regardless of what language your program is in.  For example, you
1373 might compile a file @code{firstClass.C} like this:
1374
1375 @smallexample
1376 g++ -g -frepo -O -c firstClass.C
1377 @end smallexample
1378
1379 @noindent
1380 In this example, only @option{-frepo} is an option meant
1381 only for C++ programs; you can use the other options with any
1382 language supported by GCC@.
1383
1384 Here is a list of options that are @emph{only} for compiling C++ programs:
1385
1386 @table @gcctabopt
1387
1388 @item -fabi-version=@var{n}
1389 @opindex fabi-version
1390 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1391 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1392 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1393 the version that conforms most closely to the C++ ABI specification.
1394 Therefore, the ABI obtained using version 0 will change as ABI bugs
1395 are fixed.
1396
1397 The default is version 2.
1398
1399 @item -fno-access-control
1400 @opindex fno-access-control
1401 Turn off all access checking.  This switch is mainly useful for working
1402 around bugs in the access control code.
1403
1404 @item -fcheck-new
1405 @opindex fcheck-new
1406 Check that the pointer returned by @code{operator new} is non-null
1407 before attempting to modify the storage allocated.  This check is
1408 normally unnecessary because the C++ standard specifies that
1409 @code{operator new} will only return @code{0} if it is declared
1410 @samp{throw()}, in which case the compiler will always check the
1411 return value even without this option.  In all other cases, when
1412 @code{operator new} has a non-empty exception specification, memory
1413 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1414 @samp{new (nothrow)}.
1415
1416 @item -fconserve-space
1417 @opindex fconserve-space
1418 Put uninitialized or runtime-initialized global variables into the
1419 common segment, as C does.  This saves space in the executable at the
1420 cost of not diagnosing duplicate definitions.  If you compile with this
1421 flag and your program mysteriously crashes after @code{main()} has
1422 completed, you may have an object that is being destroyed twice because
1423 two definitions were merged.
1424
1425 This option is no longer useful on most targets, now that support has
1426 been added for putting variables into BSS without making them common.
1427
1428 @item -ffriend-injection
1429 @opindex ffriend-injection
1430 Inject friend functions into the enclosing namespace, so that they are
1431 visible outside the scope of the class in which they are declared.
1432 Friend functions were documented to work this way in the old Annotated
1433 C++ Reference Manual, and versions of G++ before 4.1 always worked
1434 that way.  However, in ISO C++ a friend function which is not declared
1435 in an enclosing scope can only be found using argument dependent
1436 lookup.  This option causes friends to be injected as they were in
1437 earlier releases.
1438
1439 This option is for compatibility, and may be removed in a future
1440 release of G++.
1441
1442 @item -fno-const-strings
1443 @opindex fno-const-strings
1444 Give string constants type @code{char *} instead of type @code{const
1445 char *}.  By default, G++ uses type @code{const char *} as required by
1446 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1447 actually modify the value of a string constant.
1448
1449 This option might be removed in a future release of G++.  For maximum
1450 portability, you should structure your code so that it works with
1451 string constants that have type @code{const char *}.
1452
1453 @item -fno-elide-constructors
1454 @opindex fno-elide-constructors
1455 The C++ standard allows an implementation to omit creating a temporary
1456 which is only used to initialize another object of the same type.
1457 Specifying this option disables that optimization, and forces G++ to
1458 call the copy constructor in all cases.
1459
1460 @item -fno-enforce-eh-specs
1461 @opindex fno-enforce-eh-specs
1462 Don't generate code to check for violation of exception specifications
1463 at runtime.  This option violates the C++ standard, but may be useful
1464 for reducing code size in production builds, much like defining
1465 @samp{NDEBUG}.  This does not give user code permission to throw
1466 exceptions in violation of the exception specifications; the compiler
1467 will still optimize based on the specifications, so throwing an
1468 unexpected exception will result in undefined behavior.
1469
1470 @item -ffor-scope
1471 @itemx -fno-for-scope
1472 @opindex ffor-scope
1473 @opindex fno-for-scope
1474 If @option{-ffor-scope} is specified, the scope of variables declared in
1475 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1476 as specified by the C++ standard.
1477 If @option{-fno-for-scope} is specified, the scope of variables declared in
1478 a @i{for-init-statement} extends to the end of the enclosing scope,
1479 as was the case in old versions of G++, and other (traditional)
1480 implementations of C++.
1481
1482 The default if neither flag is given to follow the standard,
1483 but to allow and give a warning for old-style code that would
1484 otherwise be invalid, or have different behavior.
1485
1486 @item -fno-gnu-keywords
1487 @opindex fno-gnu-keywords
1488 Do not recognize @code{typeof} as a keyword, so that code can use this
1489 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1490 @option{-ansi} implies @option{-fno-gnu-keywords}.
1491
1492 @item -fno-implicit-templates
1493 @opindex fno-implicit-templates
1494 Never emit code for non-inline templates which are instantiated
1495 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1496 @xref{Template Instantiation}, for more information.
1497
1498 @item -fno-implicit-inline-templates
1499 @opindex fno-implicit-inline-templates
1500 Don't emit code for implicit instantiations of inline templates, either.
1501 The default is to handle inlines differently so that compiles with and
1502 without optimization will need the same set of explicit instantiations.
1503
1504 @item -fno-implement-inlines
1505 @opindex fno-implement-inlines
1506 To save space, do not emit out-of-line copies of inline functions
1507 controlled by @samp{#pragma implementation}.  This will cause linker
1508 errors if these functions are not inlined everywhere they are called.
1509
1510 @item -fms-extensions
1511 @opindex fms-extensions
1512 Disable pedantic warnings about constructs used in MFC, such as implicit
1513 int and getting a pointer to member function via non-standard syntax.
1514
1515 @item -fno-nonansi-builtins
1516 @opindex fno-nonansi-builtins
1517 Disable built-in declarations of functions that are not mandated by
1518 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1519 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1520
1521 @item -fno-operator-names
1522 @opindex fno-operator-names
1523 Do not treat the operator name keywords @code{and}, @code{bitand},
1524 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1525 synonyms as keywords.
1526
1527 @item -fno-optional-diags
1528 @opindex fno-optional-diags
1529 Disable diagnostics that the standard says a compiler does not need to
1530 issue.  Currently, the only such diagnostic issued by G++ is the one for
1531 a name having multiple meanings within a class.
1532
1533 @item -fpermissive
1534 @opindex fpermissive
1535 Downgrade some diagnostics about nonconformant code from errors to
1536 warnings.  Thus, using @option{-fpermissive} will allow some
1537 nonconforming code to compile.
1538
1539 @item -frepo
1540 @opindex frepo
1541 Enable automatic template instantiation at link time.  This option also
1542 implies @option{-fno-implicit-templates}.  @xref{Template
1543 Instantiation}, for more information.
1544
1545 @item -fno-rtti
1546 @opindex fno-rtti
1547 Disable generation of information about every class with virtual
1548 functions for use by the C++ runtime type identification features
1549 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1550 of the language, you can save some space by using this flag.  Note that
1551 exception handling uses the same information, but it will generate it as
1552 needed.
1553
1554 @item -fstats
1555 @opindex fstats
1556 Emit statistics about front-end processing at the end of the compilation.
1557 This information is generally only useful to the G++ development team.
1558
1559 @item -ftemplate-depth-@var{n}
1560 @opindex ftemplate-depth
1561 Set the maximum instantiation depth for template classes to @var{n}.
1562 A limit on the template instantiation depth is needed to detect
1563 endless recursions during template class instantiation.  ANSI/ISO C++
1564 conforming programs must not rely on a maximum depth greater than 17.
1565
1566 @item -fno-threadsafe-statics
1567 @opindex fno-threadsafe-statics
1568 Do not emit the extra code to use the routines specified in the C++
1569 ABI for thread-safe initialization of local statics.  You can use this
1570 option to reduce code size slightly in code that doesn't need to be
1571 thread-safe.
1572
1573 @item -fuse-cxa-atexit
1574 @opindex fuse-cxa-atexit
1575 Register destructors for objects with static storage duration with the
1576 @code{__cxa_atexit} function rather than the @code{atexit} function.
1577 This option is required for fully standards-compliant handling of static
1578 destructors, but will only work if your C library supports
1579 @code{__cxa_atexit}.
1580
1581 @item -fvisibility-inlines-hidden
1582 @opindex fvisibility-inlines-hidden
1583 Causes all inlined methods to be marked with
1584 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1585 appear in the export table of a DSO and do not require a PLT indirection
1586 when used within the DSO@.  Enabling this option can have a dramatic effect
1587 on load and link times of a DSO as it massively reduces the size of the
1588 dynamic export table when the library makes heavy use of templates.  While
1589 it can cause bloating through duplication of code within each DSO where
1590 it is used, often the wastage is less than the considerable space occupied
1591 by a long symbol name in the export table which is typical when using
1592 templates and namespaces.  For even more savings, combine with the
1593 @option{-fvisibility=hidden} switch.
1594
1595 @item -fno-weak
1596 @opindex fno-weak
1597 Do not use weak symbol support, even if it is provided by the linker.
1598 By default, G++ will use weak symbols if they are available.  This
1599 option exists only for testing, and should not be used by end-users;
1600 it will result in inferior code and has no benefits.  This option may
1601 be removed in a future release of G++.
1602
1603 @item -nostdinc++
1604 @opindex nostdinc++
1605 Do not search for header files in the standard directories specific to
1606 C++, but do still search the other standard directories.  (This option
1607 is used when building the C++ library.)
1608 @end table
1609
1610 In addition, these optimization, warning, and code generation options
1611 have meanings only for C++ programs:
1612
1613 @table @gcctabopt
1614 @item -fno-default-inline
1615 @opindex fno-default-inline
1616 Do not assume @samp{inline} for functions defined inside a class scope.
1617 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1618 functions will have linkage like inline functions; they just won't be
1619 inlined by default.
1620
1621 @item -Wabi @r{(C++ only)}
1622 @opindex Wabi
1623 Warn when G++ generates code that is probably not compatible with the
1624 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1625 all such cases, there are probably some cases that are not warned about,
1626 even though G++ is generating incompatible code.  There may also be
1627 cases where warnings are emitted even though the code that is generated
1628 will be compatible.
1629
1630 You should rewrite your code to avoid these warnings if you are
1631 concerned about the fact that code generated by G++ may not be binary
1632 compatible with code generated by other compilers.
1633
1634 The known incompatibilities at this point include:
1635
1636 @itemize @bullet
1637
1638 @item
1639 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1640 pack data into the same byte as a base class.  For example:
1641
1642 @smallexample
1643 struct A @{ virtual void f(); int f1 : 1; @};
1644 struct B : public A @{ int f2 : 1; @};
1645 @end smallexample
1646
1647 @noindent
1648 In this case, G++ will place @code{B::f2} into the same byte
1649 as@code{A::f1}; other compilers will not.  You can avoid this problem
1650 by explicitly padding @code{A} so that its size is a multiple of the
1651 byte size on your platform; that will cause G++ and other compilers to
1652 layout @code{B} identically.
1653
1654 @item
1655 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1656 tail padding when laying out virtual bases.  For example:
1657
1658 @smallexample
1659 struct A @{ virtual void f(); char c1; @};
1660 struct B @{ B(); char c2; @};
1661 struct C : public A, public virtual B @{@};
1662 @end smallexample
1663
1664 @noindent
1665 In this case, G++ will not place @code{B} into the tail-padding for
1666 @code{A}; other compilers will.  You can avoid this problem by
1667 explicitly padding @code{A} so that its size is a multiple of its
1668 alignment (ignoring virtual base classes); that will cause G++ and other
1669 compilers to layout @code{C} identically.
1670
1671 @item
1672 Incorrect handling of bit-fields with declared widths greater than that
1673 of their underlying types, when the bit-fields appear in a union.  For
1674 example:
1675
1676 @smallexample
1677 union U @{ int i : 4096; @};
1678 @end smallexample
1679
1680 @noindent
1681 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1682 union too small by the number of bits in an @code{int}.
1683
1684 @item
1685 Empty classes can be placed at incorrect offsets.  For example:
1686
1687 @smallexample
1688 struct A @{@};
1689
1690 struct B @{
1691   A a;
1692   virtual void f ();
1693 @};
1694
1695 struct C : public B, public A @{@};
1696 @end smallexample
1697
1698 @noindent
1699 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1700 it should be placed at offset zero.  G++ mistakenly believes that the
1701 @code{A} data member of @code{B} is already at offset zero.
1702
1703 @item
1704 Names of template functions whose types involve @code{typename} or
1705 template template parameters can be mangled incorrectly.
1706
1707 @smallexample
1708 template <typename Q>
1709 void f(typename Q::X) @{@}
1710
1711 template <template <typename> class Q>
1712 void f(typename Q<int>::X) @{@}
1713 @end smallexample
1714
1715 @noindent
1716 Instantiations of these templates may be mangled incorrectly.
1717
1718 @end itemize
1719
1720 @item -Wctor-dtor-privacy @r{(C++ only)}
1721 @opindex Wctor-dtor-privacy
1722 Warn when a class seems unusable because all the constructors or
1723 destructors in that class are private, and it has neither friends nor
1724 public static member functions.
1725
1726 @item -Wnon-virtual-dtor @r{(C++ only)}
1727 @opindex Wnon-virtual-dtor
1728 Warn when a class appears to be polymorphic, thereby requiring a virtual
1729 destructor, yet it declares a non-virtual one.
1730 This warning is enabled by @option{-Wall}.
1731
1732 @item -Wreorder @r{(C++ only)}
1733 @opindex Wreorder
1734 @cindex reordering, warning
1735 @cindex warning for reordering of member initializers
1736 Warn when the order of member initializers given in the code does not
1737 match the order in which they must be executed.  For instance:
1738
1739 @smallexample
1740 struct A @{
1741   int i;
1742   int j;
1743   A(): j (0), i (1) @{ @}
1744 @};
1745 @end smallexample
1746
1747 The compiler will rearrange the member initializers for @samp{i}
1748 and @samp{j} to match the declaration order of the members, emitting
1749 a warning to that effect.  This warning is enabled by @option{-Wall}.
1750 @end table
1751
1752 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1753
1754 @table @gcctabopt
1755 @item -Weffc++ @r{(C++ only)}
1756 @opindex Weffc++
1757 Warn about violations of the following style guidelines from Scott Meyers'
1758 @cite{Effective C++} book:
1759
1760 @itemize @bullet
1761 @item
1762 Item 11:  Define a copy constructor and an assignment operator for classes
1763 with dynamically allocated memory.
1764
1765 @item
1766 Item 12:  Prefer initialization to assignment in constructors.
1767
1768 @item
1769 Item 14:  Make destructors virtual in base classes.
1770
1771 @item
1772 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1773
1774 @item
1775 Item 23:  Don't try to return a reference when you must return an object.
1776
1777 @end itemize
1778
1779 Also warn about violations of the following style guidelines from
1780 Scott Meyers' @cite{More Effective C++} book:
1781
1782 @itemize @bullet
1783 @item
1784 Item 6:  Distinguish between prefix and postfix forms of increment and
1785 decrement operators.
1786
1787 @item
1788 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1789
1790 @end itemize
1791
1792 When selecting this option, be aware that the standard library
1793 headers do not obey all of these guidelines; use @samp{grep -v}
1794 to filter out those warnings.
1795
1796 @item -Wno-deprecated @r{(C++ only)}
1797 @opindex Wno-deprecated
1798 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1799
1800 @item -Wstrict-null-sentinel @r{(C++ only)}
1801 @opindex Wstrict-null-sentinel
1802 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1803 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1804 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1805 it is guaranteed to of the same size as a pointer.  But this use is
1806 not portable across different compilers.
1807
1808 @item -Wno-non-template-friend @r{(C++ only)}
1809 @opindex Wno-non-template-friend
1810 Disable warnings when non-templatized friend functions are declared
1811 within a template.  Since the advent of explicit template specification
1812 support in G++, if the name of the friend is an unqualified-id (i.e.,
1813 @samp{friend foo(int)}), the C++ language specification demands that the
1814 friend declare or define an ordinary, nontemplate function.  (Section
1815 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1816 could be interpreted as a particular specialization of a templatized
1817 function.  Because this non-conforming behavior is no longer the default
1818 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1819 check existing code for potential trouble spots and is on by default.
1820 This new compiler behavior can be turned off with
1821 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1822 but disables the helpful warning.
1823
1824 @item -Wold-style-cast @r{(C++ only)}
1825 @opindex Wold-style-cast
1826 Warn if an old-style (C-style) cast to a non-void type is used within
1827 a C++ program.  The new-style casts (@samp{dynamic_cast},
1828 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1829 less vulnerable to unintended effects and much easier to search for.
1830
1831 @item -Woverloaded-virtual @r{(C++ only)}
1832 @opindex Woverloaded-virtual
1833 @cindex overloaded virtual fn, warning
1834 @cindex warning for overloaded virtual fn
1835 Warn when a function declaration hides virtual functions from a
1836 base class.  For example, in:
1837
1838 @smallexample
1839 struct A @{
1840   virtual void f();
1841 @};
1842
1843 struct B: public A @{
1844   void f(int);
1845 @};
1846 @end smallexample
1847
1848 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1849 like:
1850
1851 @smallexample
1852 B* b;
1853 b->f();
1854 @end smallexample
1855
1856 will fail to compile.
1857
1858 @item -Wno-pmf-conversions @r{(C++ only)}
1859 @opindex Wno-pmf-conversions
1860 Disable the diagnostic for converting a bound pointer to member function
1861 to a plain pointer.
1862
1863 @item -Wsign-promo @r{(C++ only)}
1864 @opindex Wsign-promo
1865 Warn when overload resolution chooses a promotion from unsigned or
1866 enumerated type to a signed type, over a conversion to an unsigned type of
1867 the same size.  Previous versions of G++ would try to preserve
1868 unsignedness, but the standard mandates the current behavior.
1869
1870 @smallexample
1871 struct A @{
1872   operator int ();
1873   A& operator = (int);
1874 @};
1875
1876 main ()
1877 @{
1878   A a,b;
1879   a = b;
1880 @}
1881 @end smallexample
1882
1883 In this example, G++ will synthesize a default @samp{A& operator =
1884 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1885 @end table
1886
1887 @node Objective-C and Objective-C++ Dialect Options
1888 @section Options Controlling Objective-C and Objective-C++ Dialects
1889
1890 @cindex compiler options, Objective-C and Objective-C++
1891 @cindex Objective-C and Objective-C++ options, command line
1892 @cindex options, Objective-C and Objective-C++
1893 (NOTE: This manual does not describe the Objective-C and Objective-C++
1894 languages themselves.  See @xref{Standards,,Language Standards
1895 Supported by GCC}, for references.)
1896
1897 This section describes the command-line options that are only meaningful
1898 for Objective-C and Objective-C++ programs, but you can also use most of
1899 the language-independent GNU compiler options.
1900 For example, you might compile a file @code{some_class.m} like this:
1901
1902 @smallexample
1903 gcc -g -fgnu-runtime -O -c some_class.m
1904 @end smallexample
1905
1906 @noindent
1907 In this example, @option{-fgnu-runtime} is an option meant only for
1908 Objective-C and Objective-C++ programs; you can use the other options with
1909 any language supported by GCC@.
1910
1911 Note that since Objective-C is an extension of the C language, Objective-C
1912 compilations may also use options specific to the C front-end (e.g.,
1913 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1914 C++-specific options (e.g., @option{-Wabi}).
1915
1916 Here is a list of options that are @emph{only} for compiling Objective-C
1917 and Objective-C++ programs:
1918
1919 @table @gcctabopt
1920 @item -fconstant-string-class=@var{class-name}
1921 @opindex fconstant-string-class
1922 Use @var{class-name} as the name of the class to instantiate for each
1923 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1924 class name is @code{NXConstantString} if the GNU runtime is being used, and
1925 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1926 @option{-fconstant-cfstrings} option, if also present, will override the
1927 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1928 to be laid out as constant CoreFoundation strings.
1929
1930 @item -fgnu-runtime
1931 @opindex fgnu-runtime
1932 Generate object code compatible with the standard GNU Objective-C
1933 runtime.  This is the default for most types of systems.
1934
1935 @item -fnext-runtime
1936 @opindex fnext-runtime
1937 Generate output compatible with the NeXT runtime.  This is the default
1938 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1939 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1940 used.
1941
1942 @item -fno-nil-receivers
1943 @opindex fno-nil-receivers
1944 Assume that all Objective-C message dispatches (e.g.,
1945 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1946 is not @code{nil}.  This allows for more efficient entry points in the runtime
1947 to be used.  Currently, this option is only available in conjunction with
1948 the NeXT runtime on Mac OS X 10.3 and later.
1949
1950 @item -fobjc-call-cxx-cdtors
1951 @opindex fobjc-call-cxx-cdtors
1952 For each Objective-C class, check if any of its instance variables is a
1953 C++ object with a non-trivial default constructor.  If so, synthesize a
1954 special @code{- (id) .cxx_construct} instance method that will run
1955 non-trivial default constructors on any such instance variables, in order,
1956 and then return @code{self}.  Similarly, check if any instance variable
1957 is a C++ object with a non-trivial destructor, and if so, synthesize a
1958 special @code{- (void) .cxx_destruct} method that will run
1959 all such default destructors, in reverse order.
1960
1961 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1962 thusly generated will only operate on instance variables declared in the
1963 current Objective-C class, and not those inherited from superclasses.  It
1964 is the responsibility of the Objective-C runtime to invoke all such methods
1965 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1966 will be invoked by the runtime immediately after a new object
1967 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1968 be invoked immediately before the runtime deallocates an object instance.
1969
1970 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1971 support for invoking the @code{- (id) .cxx_construct} and
1972 @code{- (void) .cxx_destruct} methods.
1973
1974 @item -fobjc-direct-dispatch
1975 @opindex fobjc-direct-dispatch
1976 Allow fast jumps to the message dispatcher.  On Darwin this is
1977 accomplished via the comm page.
1978
1979 @item -fobjc-exceptions
1980 @opindex fobjc-exceptions
1981 Enable syntactic support for structured exception handling in Objective-C,
1982 similar to what is offered by C++ and Java.  Currently, this option is only
1983 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1984
1985 @smallexample
1986   @@try @{
1987     @dots{}
1988        @@throw expr;
1989     @dots{}
1990   @}
1991   @@catch (AnObjCClass *exc) @{
1992     @dots{}
1993       @@throw expr;
1994     @dots{}
1995       @@throw;
1996     @dots{}
1997   @}
1998   @@catch (AnotherClass *exc) @{
1999     @dots{}
2000   @}
2001   @@catch (id allOthers) @{
2002     @dots{}
2003   @}
2004   @@finally @{
2005     @dots{}
2006       @@throw expr;
2007     @dots{}
2008   @}
2009 @end smallexample
2010
2011 The @code{@@throw} statement may appear anywhere in an Objective-C or
2012 Objective-C++ program; when used inside of a @code{@@catch} block, the
2013 @code{@@throw} may appear without an argument (as shown above), in which case
2014 the object caught by the @code{@@catch} will be rethrown.
2015
2016 Note that only (pointers to) Objective-C objects may be thrown and
2017 caught using this scheme.  When an object is thrown, it will be caught
2018 by the nearest @code{@@catch} clause capable of handling objects of that type,
2019 analogously to how @code{catch} blocks work in C++ and Java.  A
2020 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2021 any and all Objective-C exceptions not caught by previous @code{@@catch}
2022 clauses (if any).
2023
2024 The @code{@@finally} clause, if present, will be executed upon exit from the
2025 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2026 regardless of whether any exceptions are thrown, caught or rethrown
2027 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2028 of the @code{finally} clause in Java.
2029
2030 There are several caveats to using the new exception mechanism:
2031
2032 @itemize @bullet
2033 @item
2034 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2035 idioms provided by the @code{NSException} class, the new
2036 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2037 systems, due to additional functionality needed in the (NeXT) Objective-C
2038 runtime.
2039
2040 @item
2041 As mentioned above, the new exceptions do not support handling
2042 types other than Objective-C objects.   Furthermore, when used from
2043 Objective-C++, the Objective-C exception model does not interoperate with C++
2044 exceptions at this time.  This means you cannot @code{@@throw} an exception
2045 from Objective-C and @code{catch} it in C++, or vice versa
2046 (i.e., @code{throw @dots{} @@catch}).
2047 @end itemize
2048
2049 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2050 blocks for thread-safe execution:
2051
2052 @smallexample
2053   @@synchronized (ObjCClass *guard) @{
2054     @dots{}
2055   @}
2056 @end smallexample
2057
2058 Upon entering the @code{@@synchronized} block, a thread of execution shall
2059 first check whether a lock has been placed on the corresponding @code{guard}
2060 object by another thread.  If it has, the current thread shall wait until
2061 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2062 the current thread will place its own lock on it, execute the code contained in
2063 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2064 making @code{guard} available to other threads).
2065
2066 Unlike Java, Objective-C does not allow for entire methods to be marked
2067 @code{@@synchronized}.  Note that throwing exceptions out of
2068 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2069 to be unlocked properly.
2070
2071 @item -fobjc-gc
2072 @opindex fobjc-gc
2073 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2074
2075 @item -freplace-objc-classes
2076 @opindex freplace-objc-classes
2077 Emit a special marker instructing @command{ld(1)} not to statically link in
2078 the resulting object file, and allow @command{dyld(1)} to load it in at
2079 run time instead.  This is used in conjunction with the Fix-and-Continue
2080 debugging mode, where the object file in question may be recompiled and
2081 dynamically reloaded in the course of program execution, without the need
2082 to restart the program itself.  Currently, Fix-and-Continue functionality
2083 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2084 and later.
2085
2086 @item -fzero-link
2087 @opindex fzero-link
2088 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2089 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2090 compile time) with static class references that get initialized at load time,
2091 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2092 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2093 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2094 for individual class implementations to be modified during program execution.
2095
2096 @item -gen-decls
2097 @opindex gen-decls
2098 Dump interface declarations for all classes seen in the source file to a
2099 file named @file{@var{sourcename}.decl}.
2100
2101 @item -Wassign-intercept
2102 @opindex Wassign-intercept
2103 Warn whenever an Objective-C assignment is being intercepted by the
2104 garbage collector.
2105
2106 @item -Wno-protocol
2107 @opindex Wno-protocol
2108 If a class is declared to implement a protocol, a warning is issued for
2109 every method in the protocol that is not implemented by the class.  The
2110 default behavior is to issue a warning for every method not explicitly
2111 implemented in the class, even if a method implementation is inherited
2112 from the superclass.  If you use the @option{-Wno-protocol} option, then
2113 methods inherited from the superclass are considered to be implemented,
2114 and no warning is issued for them.
2115
2116 @item -Wselector
2117 @opindex Wselector
2118 Warn if multiple methods of different types for the same selector are
2119 found during compilation.  The check is performed on the list of methods
2120 in the final stage of compilation.  Additionally, a check is performed
2121 for each selector appearing in a @code{@@selector(@dots{})}
2122 expression, and a corresponding method for that selector has been found
2123 during compilation.  Because these checks scan the method table only at
2124 the end of compilation, these warnings are not produced if the final
2125 stage of compilation is not reached, for example because an error is
2126 found during compilation, or because the @option{-fsyntax-only} option is
2127 being used.
2128
2129 @item -Wstrict-selector-match
2130 @opindex Wstrict-selector-match
2131 Warn if multiple methods with differing argument and/or return types are
2132 found for a given selector when attempting to send a message using this
2133 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2134 is off (which is the default behavior), the compiler will omit such warnings
2135 if any differences found are confined to types which share the same size
2136 and alignment.
2137
2138 @item -Wundeclared-selector
2139 @opindex Wundeclared-selector
2140 Warn if a @code{@@selector(@dots{})} expression referring to an
2141 undeclared selector is found.  A selector is considered undeclared if no
2142 method with that name has been declared before the
2143 @code{@@selector(@dots{})} expression, either explicitly in an
2144 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2145 an @code{@@implementation} section.  This option always performs its
2146 checks as soon as a @code{@@selector(@dots{})} expression is found,
2147 while @option{-Wselector} only performs its checks in the final stage of
2148 compilation.  This also enforces the coding style convention
2149 that methods and selectors must be declared before being used.
2150
2151 @item -print-objc-runtime-info
2152 @opindex print-objc-runtime-info
2153 Generate C header describing the largest structure that is passed by
2154 value, if any.
2155
2156 @end table
2157
2158 @node Language Independent Options
2159 @section Options to Control Diagnostic Messages Formatting
2160 @cindex options to control diagnostics formatting
2161 @cindex diagnostic messages
2162 @cindex message formatting
2163
2164 Traditionally, diagnostic messages have been formatted irrespective of
2165 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2166 below can be used to control the diagnostic messages formatting
2167 algorithm, e.g.@: how many characters per line, how often source location
2168 information should be reported.  Right now, only the C++ front end can
2169 honor these options.  However it is expected, in the near future, that
2170 the remaining front ends would be able to digest them correctly.
2171
2172 @table @gcctabopt
2173 @item -fmessage-length=@var{n}
2174 @opindex fmessage-length
2175 Try to format error messages so that they fit on lines of about @var{n}
2176 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2177 the front ends supported by GCC@.  If @var{n} is zero, then no
2178 line-wrapping will be done; each error message will appear on a single
2179 line.
2180
2181 @opindex fdiagnostics-show-location
2182 @item -fdiagnostics-show-location=once
2183 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2184 reporter to emit @emph{once} source location information; that is, in
2185 case the message is too long to fit on a single physical line and has to
2186 be wrapped, the source location won't be emitted (as prefix) again,
2187 over and over, in subsequent continuation lines.  This is the default
2188 behavior.
2189
2190 @item -fdiagnostics-show-location=every-line
2191 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2192 messages reporter to emit the same source location information (as
2193 prefix) for physical lines that result from the process of breaking
2194 a message which is too long to fit on a single line.
2195
2196 @item -fdiagnostics-show-options
2197 @opindex fdiagnostics-show-options
2198 This option instructs the diagnostic machinery to add text to each
2199 diagnostic emitted, which indicates which command line option directly
2200 controls that diagnostic, when such an option is known to the
2201 diagnostic machinery.
2202
2203 @end table
2204
2205 @node Warning Options
2206 @section Options to Request or Suppress Warnings
2207 @cindex options to control warnings
2208 @cindex warning messages
2209 @cindex messages, warning
2210 @cindex suppressing warnings
2211
2212 Warnings are diagnostic messages that report constructions which
2213 are not inherently erroneous but which are risky or suggest there
2214 may have been an error.
2215
2216 You can request many specific warnings with options beginning @samp{-W},
2217 for example @option{-Wimplicit} to request warnings on implicit
2218 declarations.  Each of these specific warning options also has a
2219 negative form beginning @samp{-Wno-} to turn off warnings;
2220 for example, @option{-Wno-implicit}.  This manual lists only one of the
2221 two forms, whichever is not the default.
2222
2223 The following options control the amount and kinds of warnings produced
2224 by GCC; for further, language-specific options also refer to
2225 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2226 Options}.
2227
2228 @table @gcctabopt
2229 @cindex syntax checking
2230 @item -fsyntax-only
2231 @opindex fsyntax-only
2232 Check the code for syntax errors, but don't do anything beyond that.
2233
2234 @item -pedantic
2235 @opindex pedantic
2236 Issue all the warnings demanded by strict ISO C and ISO C++;
2237 reject all programs that use forbidden extensions, and some other
2238 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2239 version of the ISO C standard specified by any @option{-std} option used.
2240
2241 Valid ISO C and ISO C++ programs should compile properly with or without
2242 this option (though a rare few will require @option{-ansi} or a
2243 @option{-std} option specifying the required version of ISO C)@.  However,
2244 without this option, certain GNU extensions and traditional C and C++
2245 features are supported as well.  With this option, they are rejected.
2246
2247 @option{-pedantic} does not cause warning messages for use of the
2248 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2249 warnings are also disabled in the expression that follows
2250 @code{__extension__}.  However, only system header files should use
2251 these escape routes; application programs should avoid them.
2252 @xref{Alternate Keywords}.
2253
2254 Some users try to use @option{-pedantic} to check programs for strict ISO
2255 C conformance.  They soon find that it does not do quite what they want:
2256 it finds some non-ISO practices, but not all---only those for which
2257 ISO C @emph{requires} a diagnostic, and some others for which
2258 diagnostics have been added.
2259
2260 A feature to report any failure to conform to ISO C might be useful in
2261 some instances, but would require considerable additional work and would
2262 be quite different from @option{-pedantic}.  We don't have plans to
2263 support such a feature in the near future.
2264
2265 Where the standard specified with @option{-std} represents a GNU
2266 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2267 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2268 extended dialect is based.  Warnings from @option{-pedantic} are given
2269 where they are required by the base standard.  (It would not make sense
2270 for such warnings to be given only for features not in the specified GNU
2271 C dialect, since by definition the GNU dialects of C include all
2272 features the compiler supports with the given option, and there would be
2273 nothing to warn about.)
2274
2275 @item -pedantic-errors
2276 @opindex pedantic-errors
2277 Like @option{-pedantic}, except that errors are produced rather than
2278 warnings.
2279
2280 @item -w
2281 @opindex w
2282 Inhibit all warning messages.
2283
2284 @item -Wno-import
2285 @opindex Wno-import
2286 Inhibit warning messages about the use of @samp{#import}.
2287
2288 @item -Wchar-subscripts
2289 @opindex Wchar-subscripts
2290 Warn if an array subscript has type @code{char}.  This is a common cause
2291 of error, as programmers often forget that this type is signed on some
2292 machines.
2293 This warning is enabled by @option{-Wall}.
2294
2295 @item -Wcomment
2296 @opindex Wcomment
2297 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2298 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2299 This warning is enabled by @option{-Wall}.
2300
2301 @item -Wfatal-errors
2302 @opindex Wfatal-errors
2303 This option causes the compiler to abort compilation on the first error
2304 occurred rather than trying to keep going and printing further error
2305 messages.
2306
2307 @item -Wformat
2308 @opindex Wformat
2309 @opindex ffreestanding
2310 @opindex fno-builtin
2311 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2312 the arguments supplied have types appropriate to the format string
2313 specified, and that the conversions specified in the format string make
2314 sense.  This includes standard functions, and others specified by format
2315 attributes (@pxref{Function Attributes}), in the @code{printf},
2316 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2317 not in the C standard) families (or other target-specific families).
2318 Which functions are checked without format attributes having been
2319 specified depends on the standard version selected, and such checks of
2320 functions without the attribute specified are disabled by
2321 @option{-ffreestanding} or @option{-fno-builtin}.
2322
2323 The formats are checked against the format features supported by GNU
2324 libc version 2.2.  These include all ISO C90 and C99 features, as well
2325 as features from the Single Unix Specification and some BSD and GNU
2326 extensions.  Other library implementations may not support all these
2327 features; GCC does not support warning about features that go beyond a
2328 particular library's limitations.  However, if @option{-pedantic} is used
2329 with @option{-Wformat}, warnings will be given about format features not
2330 in the selected standard version (but not for @code{strfmon} formats,
2331 since those are not in any version of the C standard).  @xref{C Dialect
2332 Options,,Options Controlling C Dialect}.
2333
2334 Since @option{-Wformat} also checks for null format arguments for
2335 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2336
2337 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2338 aspects of format checking, the options @option{-Wformat-y2k},
2339 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2340 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2341 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2342
2343 @item -Wformat-y2k
2344 @opindex Wformat-y2k
2345 If @option{-Wformat} is specified, also warn about @code{strftime}
2346 formats which may yield only a two-digit year.
2347
2348 @item -Wno-format-extra-args
2349 @opindex Wno-format-extra-args
2350 If @option{-Wformat} is specified, do not warn about excess arguments to a
2351 @code{printf} or @code{scanf} format function.  The C standard specifies
2352 that such arguments are ignored.
2353
2354 Where the unused arguments lie between used arguments that are
2355 specified with @samp{$} operand number specifications, normally
2356 warnings are still given, since the implementation could not know what
2357 type to pass to @code{va_arg} to skip the unused arguments.  However,
2358 in the case of @code{scanf} formats, this option will suppress the
2359 warning if the unused arguments are all pointers, since the Single
2360 Unix Specification says that such unused arguments are allowed.
2361
2362 @item -Wno-format-zero-length
2363 @opindex Wno-format-zero-length
2364 If @option{-Wformat} is specified, do not warn about zero-length formats.
2365 The C standard specifies that zero-length formats are allowed.
2366
2367 @item -Wformat-nonliteral
2368 @opindex Wformat-nonliteral
2369 If @option{-Wformat} is specified, also warn if the format string is not a
2370 string literal and so cannot be checked, unless the format function
2371 takes its format arguments as a @code{va_list}.
2372
2373 @item -Wformat-security
2374 @opindex Wformat-security
2375 If @option{-Wformat} is specified, also warn about uses of format
2376 functions that represent possible security problems.  At present, this
2377 warns about calls to @code{printf} and @code{scanf} functions where the
2378 format string is not a string literal and there are no format arguments,
2379 as in @code{printf (foo);}.  This may be a security hole if the format
2380 string came from untrusted input and contains @samp{%n}.  (This is
2381 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2382 in future warnings may be added to @option{-Wformat-security} that are not
2383 included in @option{-Wformat-nonliteral}.)
2384
2385 @item -Wformat=2
2386 @opindex Wformat=2
2387 Enable @option{-Wformat} plus format checks not included in
2388 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2389 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2390
2391 @item -Wnonnull
2392 @opindex Wnonnull
2393 Warn about passing a null pointer for arguments marked as
2394 requiring a non-null value by the @code{nonnull} function attribute.
2395
2396 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2397 can be disabled with the @option{-Wno-nonnull} option.
2398
2399 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2400 @opindex Winit-self
2401 Warn about uninitialized variables which are initialized with themselves.
2402 Note this option can only be used with the @option{-Wuninitialized} option,
2403 which in turn only works with @option{-O1} and above.
2404
2405 For example, GCC will warn about @code{i} being uninitialized in the
2406 following snippet only when @option{-Winit-self} has been specified:
2407 @smallexample
2408 @group
2409 int f()
2410 @{
2411   int i = i;
2412   return i;
2413 @}
2414 @end group
2415 @end smallexample
2416
2417 @item -Wimplicit-int
2418 @opindex Wimplicit-int
2419 Warn when a declaration does not specify a type.
2420 This warning is enabled by @option{-Wall}.
2421
2422 @item -Wimplicit-function-declaration
2423 @itemx -Werror-implicit-function-declaration
2424 @opindex Wimplicit-function-declaration
2425 @opindex Werror-implicit-function-declaration
2426 Give a warning (or error) whenever a function is used before being
2427 declared.  The form @option{-Wno-error-implicit-function-declaration}
2428 is not supported.
2429 This warning is enabled by @option{-Wall} (as a warning, not an error).
2430
2431 @item -Wimplicit
2432 @opindex Wimplicit
2433 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2434 This warning is enabled by @option{-Wall}.
2435
2436 @item -Wmain
2437 @opindex Wmain
2438 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2439 function with external linkage, returning int, taking either zero
2440 arguments, two, or three arguments of appropriate types.
2441 This warning is enabled by @option{-Wall}.
2442
2443 @item -Wmissing-braces
2444 @opindex Wmissing-braces
2445 Warn if an aggregate or union initializer is not fully bracketed.  In
2446 the following example, the initializer for @samp{a} is not fully
2447 bracketed, but that for @samp{b} is fully bracketed.
2448
2449 @smallexample
2450 int a[2][2] = @{ 0, 1, 2, 3 @};
2451 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2452 @end smallexample
2453
2454 This warning is enabled by @option{-Wall}.
2455
2456 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2457 @opindex Wmissing-include-dirs
2458 Warn if a user-supplied include directory does not exist.
2459
2460 @item -Wparentheses
2461 @opindex Wparentheses
2462 Warn if parentheses are omitted in certain contexts, such
2463 as when there is an assignment in a context where a truth value
2464 is expected, or when operators are nested whose precedence people
2465 often get confused about.  Only the warning for an assignment used as
2466 a truth value is supported when compiling C++; the other warnings are
2467 only supported when compiling C@.
2468
2469 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2470 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2471 interpretation from that of ordinary mathematical notation.
2472
2473 Also warn about constructions where there may be confusion to which
2474 @code{if} statement an @code{else} branch belongs.  Here is an example of
2475 such a case:
2476
2477 @smallexample
2478 @group
2479 @{
2480   if (a)
2481     if (b)
2482       foo ();
2483   else
2484     bar ();
2485 @}
2486 @end group
2487 @end smallexample
2488
2489 In C, every @code{else} branch belongs to the innermost possible @code{if}
2490 statement, which in this example is @code{if (b)}.  This is often not
2491 what the programmer expected, as illustrated in the above example by
2492 indentation the programmer chose.  When there is the potential for this
2493 confusion, GCC will issue a warning when this flag is specified.
2494 To eliminate the warning, add explicit braces around the innermost
2495 @code{if} statement so there is no way the @code{else} could belong to
2496 the enclosing @code{if}.  The resulting code would look like this:
2497
2498 @smallexample
2499 @group
2500 @{
2501   if (a)
2502     @{
2503       if (b)
2504         foo ();
2505       else
2506         bar ();
2507     @}
2508 @}
2509 @end group
2510 @end smallexample
2511
2512 This warning is enabled by @option{-Wall}.
2513
2514 @item -Wsequence-point
2515 @opindex Wsequence-point
2516 Warn about code that may have undefined semantics because of violations
2517 of sequence point rules in the C standard.
2518
2519 The C standard defines the order in which expressions in a C program are
2520 evaluated in terms of @dfn{sequence points}, which represent a partial
2521 ordering between the execution of parts of the program: those executed
2522 before the sequence point, and those executed after it.  These occur
2523 after the evaluation of a full expression (one which is not part of a
2524 larger expression), after the evaluation of the first operand of a
2525 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2526 function is called (but after the evaluation of its arguments and the
2527 expression denoting the called function), and in certain other places.
2528 Other than as expressed by the sequence point rules, the order of
2529 evaluation of subexpressions of an expression is not specified.  All
2530 these rules describe only a partial order rather than a total order,
2531 since, for example, if two functions are called within one expression
2532 with no sequence point between them, the order in which the functions
2533 are called is not specified.  However, the standards committee have
2534 ruled that function calls do not overlap.
2535
2536 It is not specified when between sequence points modifications to the
2537 values of objects take effect.  Programs whose behavior depends on this
2538 have undefined behavior; the C standard specifies that ``Between the
2539 previous and next sequence point an object shall have its stored value
2540 modified at most once by the evaluation of an expression.  Furthermore,
2541 the prior value shall be read only to determine the value to be
2542 stored.''.  If a program breaks these rules, the results on any
2543 particular implementation are entirely unpredictable.
2544
2545 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2546 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2547 diagnosed by this option, and it may give an occasional false positive
2548 result, but in general it has been found fairly effective at detecting
2549 this sort of problem in programs.
2550
2551 The present implementation of this option only works for C programs.  A
2552 future implementation may also work for C++ programs.
2553
2554 The C standard is worded confusingly, therefore there is some debate
2555 over the precise meaning of the sequence point rules in subtle cases.
2556 Links to discussions of the problem, including proposed formal
2557 definitions, may be found on the GCC readings page, at
2558 @w{@uref{http://gcc.gnu.org/readings.html}}.
2559
2560 This warning is enabled by @option{-Wall}.
2561
2562 @item -Wreturn-type
2563 @opindex Wreturn-type
2564 Warn whenever a function is defined with a return-type that defaults to
2565 @code{int}.  Also warn about any @code{return} statement with no
2566 return-value in a function whose return-type is not @code{void}.
2567
2568 For C, also warn if the return type of a function has a type qualifier
2569 such as @code{const}.  Such a type qualifier has no effect, since the
2570 value returned by a function is not an lvalue.  ISO C prohibits
2571 qualified @code{void} return types on function definitions, so such
2572 return types always receive a warning even without this option.
2573
2574 For C++, a function without return type always produces a diagnostic
2575 message, even when @option{-Wno-return-type} is specified.  The only
2576 exceptions are @samp{main} and functions defined in system headers.
2577
2578 This warning is enabled by @option{-Wall}.
2579
2580 @item -Wswitch
2581 @opindex Wswitch
2582 Warn whenever a @code{switch} statement has an index of enumerated type
2583 and lacks a @code{case} for one or more of the named codes of that
2584 enumeration.  (The presence of a @code{default} label prevents this
2585 warning.)  @code{case} labels outside the enumeration range also
2586 provoke warnings when this option is used.
2587 This warning is enabled by @option{-Wall}.
2588
2589 @item -Wswitch-default
2590 @opindex Wswitch-switch
2591 Warn whenever a @code{switch} statement does not have a @code{default}
2592 case.
2593
2594 @item -Wswitch-enum
2595 @opindex Wswitch-enum
2596 Warn whenever a @code{switch} statement has an index of enumerated type
2597 and lacks a @code{case} for one or more of the named codes of that
2598 enumeration.  @code{case} labels outside the enumeration range also
2599 provoke warnings when this option is used.
2600
2601 @item -Wtrigraphs
2602 @opindex Wtrigraphs
2603 Warn if any trigraphs are encountered that might change the meaning of
2604 the program (trigraphs within comments are not warned about).
2605 This warning is enabled by @option{-Wall}.
2606
2607 @item -Wunused-function
2608 @opindex Wunused-function
2609 Warn whenever a static function is declared but not defined or a
2610 non-inline static function is unused.
2611 This warning is enabled by @option{-Wall}.
2612
2613 @item -Wunused-label
2614 @opindex Wunused-label
2615 Warn whenever a label is declared but not used.
2616 This warning is enabled by @option{-Wall}.
2617
2618 To suppress this warning use the @samp{unused} attribute
2619 (@pxref{Variable Attributes}).
2620
2621 @item -Wunused-parameter
2622 @opindex Wunused-parameter
2623 Warn whenever a function parameter is unused aside from its declaration.
2624
2625 To suppress this warning use the @samp{unused} attribute
2626 (@pxref{Variable Attributes}).
2627
2628 @item -Wunused-variable
2629 @opindex Wunused-variable
2630 Warn whenever a local variable or non-constant static variable is unused
2631 aside from its declaration.
2632 This warning is enabled by @option{-Wall}.
2633
2634 To suppress this warning use the @samp{unused} attribute
2635 (@pxref{Variable Attributes}).
2636
2637 @item -Wunused-value
2638 @opindex Wunused-value
2639 Warn whenever a statement computes a result that is explicitly not used.
2640 This warning is enabled by @option{-Wall}.
2641
2642 To suppress this warning cast the expression to @samp{void}.
2643
2644 @item -Wunused
2645 @opindex Wunused
2646 All the above @option{-Wunused} options combined.
2647
2648 In order to get a warning about an unused function parameter, you must
2649 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2650 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2651
2652 @item -Wuninitialized
2653 @opindex Wuninitialized
2654 Warn if an automatic variable is used without first being initialized or
2655 if a variable may be clobbered by a @code{setjmp} call.
2656
2657 These warnings are possible only in optimizing compilation,
2658 because they require data flow information that is computed only
2659 when optimizing.  If you don't specify @option{-O}, you simply won't
2660 get these warnings.
2661
2662 If you want to warn about code which uses the uninitialized value of the
2663 variable in its own initializer, use the @option{-Winit-self} option.
2664
2665 These warnings occur for individual uninitialized or clobbered
2666 elements of structure, union or array variables as well as for
2667 variables which are uninitialized or clobbered as a whole.  They do
2668 not occur for variables or elements declared @code{volatile}.  Because
2669 these warnings depend on optimization, the exact variables or elements
2670 for which there are warnings will depend on the precise optimization
2671 options and version of GCC used.
2672
2673 Note that there may be no warning about a variable that is used only
2674 to compute a value that itself is never used, because such
2675 computations may be deleted by data flow analysis before the warnings
2676 are printed.
2677
2678 These warnings are made optional because GCC is not smart
2679 enough to see all the reasons why the code might be correct
2680 despite appearing to have an error.  Here is one example of how
2681 this can happen:
2682
2683 @smallexample
2684 @group
2685 @{
2686   int x;
2687   switch (y)
2688     @{
2689     case 1: x = 1;
2690       break;
2691     case 2: x = 4;
2692       break;
2693     case 3: x = 5;
2694     @}
2695   foo (x);
2696 @}
2697 @end group
2698 @end smallexample
2699
2700 @noindent
2701 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2702 always initialized, but GCC doesn't know this.  Here is
2703 another common case:
2704
2705 @smallexample
2706 @{
2707   int save_y;
2708   if (change_y) save_y = y, y = new_y;
2709   @dots{}
2710   if (change_y) y = save_y;
2711 @}
2712 @end smallexample
2713
2714 @noindent
2715 This has no bug because @code{save_y} is used only if it is set.
2716
2717 @cindex @code{longjmp} warnings
2718 This option also warns when a non-volatile automatic variable might be
2719 changed by a call to @code{longjmp}.  These warnings as well are possible
2720 only in optimizing compilation.
2721
2722 The compiler sees only the calls to @code{setjmp}.  It cannot know
2723 where @code{longjmp} will be called; in fact, a signal handler could
2724 call it at any point in the code.  As a result, you may get a warning
2725 even when there is in fact no problem because @code{longjmp} cannot
2726 in fact be called at the place which would cause a problem.
2727
2728 Some spurious warnings can be avoided if you declare all the functions
2729 you use that never return as @code{noreturn}.  @xref{Function
2730 Attributes}.
2731
2732 This warning is enabled by @option{-Wall}.
2733
2734 @item -Wunknown-pragmas
2735 @opindex Wunknown-pragmas
2736 @cindex warning for unknown pragmas
2737 @cindex unknown pragmas, warning
2738 @cindex pragmas, warning of unknown
2739 Warn when a #pragma directive is encountered which is not understood by
2740 GCC@.  If this command line option is used, warnings will even be issued
2741 for unknown pragmas in system header files.  This is not the case if
2742 the warnings were only enabled by the @option{-Wall} command line option.
2743
2744 @item -Wno-pragmas
2745 @opindex Wno-pragmas
2746 @opindex Wpragmas
2747 Do not warn about misuses of pragmas, such as incorrect parameters,
2748 invalid syntax, or conflicts between pragmas.  See also
2749 @samp{-Wunknown-pragmas}.
2750
2751 @item -Wstrict-aliasing
2752 @opindex Wstrict-aliasing
2753 This option is only active when @option{-fstrict-aliasing} is active.
2754 It warns about code which might break the strict aliasing rules that the
2755 compiler is using for optimization.  The warning does not catch all
2756 cases, but does attempt to catch the more common pitfalls.  It is
2757 included in @option{-Wall}.
2758
2759 @item -Wstrict-aliasing=2
2760 @opindex Wstrict-aliasing=2
2761 This option is only active when @option{-fstrict-aliasing} is active.
2762 It warns about code which might break the strict aliasing rules that the
2763 compiler is using for optimization.  This warning catches more cases than
2764 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2765 cases that are safe.
2766
2767 @item -Wall
2768 @opindex Wall
2769 All of the above @samp{-W} options combined.  This enables all the
2770 warnings about constructions that some users consider questionable, and
2771 that are easy to avoid (or modify to prevent the warning), even in
2772 conjunction with macros.  This also enables some language-specific
2773 warnings described in @ref{C++ Dialect Options} and
2774 @ref{Objective-C and Objective-C++ Dialect Options}.
2775 @end table
2776
2777 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2778 Some of them warn about constructions that users generally do not
2779 consider questionable, but which occasionally you might wish to check
2780 for; others warn about constructions that are necessary or hard to avoid
2781 in some cases, and there is no simple way to modify the code to suppress
2782 the warning.
2783
2784 @table @gcctabopt
2785 @item -Wextra
2786 @opindex W
2787 @opindex Wextra
2788 (This option used to be called @option{-W}.  The older name is still
2789 supported, but the newer name is more descriptive.)  Print extra warning
2790 messages for these events:
2791
2792 @itemize @bullet
2793 @item
2794 A function can return either with or without a value.  (Falling
2795 off the end of the function body is considered returning without
2796 a value.)  For example, this function would evoke such a
2797 warning:
2798
2799 @smallexample
2800 @group
2801 foo (a)
2802 @{
2803   if (a > 0)
2804     return a;
2805 @}
2806 @end group
2807 @end smallexample
2808
2809 @item
2810 An expression-statement or the left-hand side of a comma expression
2811 contains no side effects.
2812 To suppress the warning, cast the unused expression to void.
2813 For example, an expression such as @samp{x[i,j]} will cause a warning,
2814 but @samp{x[(void)i,j]} will not.
2815
2816 @item
2817 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2818
2819 @item
2820 Storage-class specifiers like @code{static} are not the first things in
2821 a declaration.  According to the C Standard, this usage is obsolescent.
2822
2823 @item
2824 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2825 arguments.
2826
2827 @item
2828 A comparison between signed and unsigned values could produce an
2829 incorrect result when the signed value is converted to unsigned.
2830 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2831
2832 @item
2833 An aggregate has an initializer which does not initialize all members.
2834 This warning can be independently controlled by
2835 @option{-Wmissing-field-initializers}.
2836
2837 @item
2838 A function parameter is declared without a type specifier in K&R-style
2839 functions:
2840
2841 @smallexample
2842 void foo(bar) @{ @}
2843 @end smallexample
2844
2845 @item
2846 An empty body occurs in an @samp{if} or @samp{else} statement.
2847
2848 @item
2849 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2850 @samp{>}, or @samp{>=}.
2851
2852 @item
2853 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2854
2855 @item
2856 Any of several floating-point events that often indicate errors, such as
2857 overflow, underflow, loss of precision, etc.
2858
2859 @item @r{(C++ only)}
2860 An enumerator and a non-enumerator both appear in a conditional expression.
2861
2862 @item @r{(C++ only)}
2863 A non-static reference or non-static @samp{const} member appears in a
2864 class without constructors.
2865
2866 @item @r{(C++ only)}
2867 Ambiguous virtual bases.
2868
2869 @item @r{(C++ only)}
2870 Subscripting an array which has been declared @samp{register}.
2871
2872 @item @r{(C++ only)}
2873 Taking the address of a variable which has been declared @samp{register}.
2874
2875 @item @r{(C++ only)}
2876 A base class is not initialized in a derived class' copy constructor.
2877 @end itemize
2878
2879 @item -Wno-div-by-zero
2880 @opindex Wno-div-by-zero
2881 @opindex Wdiv-by-zero
2882 Do not warn about compile-time integer division by zero.  Floating point
2883 division by zero is not warned about, as it can be a legitimate way of
2884 obtaining infinities and NaNs.
2885
2886 @item -Wsystem-headers
2887 @opindex Wsystem-headers
2888 @cindex warnings from system headers
2889 @cindex system headers, warnings from
2890 Print warning messages for constructs found in system header files.
2891 Warnings from system headers are normally suppressed, on the assumption
2892 that they usually do not indicate real problems and would only make the
2893 compiler output harder to read.  Using this command line option tells
2894 GCC to emit warnings from system headers as if they occurred in user
2895 code.  However, note that using @option{-Wall} in conjunction with this
2896 option will @emph{not} warn about unknown pragmas in system
2897 headers---for that, @option{-Wunknown-pragmas} must also be used.
2898
2899 @item -Wfloat-equal
2900 @opindex Wfloat-equal
2901 Warn if floating point values are used in equality comparisons.
2902
2903 The idea behind this is that sometimes it is convenient (for the
2904 programmer) to consider floating-point values as approximations to
2905 infinitely precise real numbers.  If you are doing this, then you need
2906 to compute (by analyzing the code, or in some other way) the maximum or
2907 likely maximum error that the computation introduces, and allow for it
2908 when performing comparisons (and when producing output, but that's a
2909 different problem).  In particular, instead of testing for equality, you
2910 would check to see whether the two values have ranges that overlap; and
2911 this is done with the relational operators, so equality comparisons are
2912 probably mistaken.
2913
2914 @item -Wtraditional @r{(C only)}
2915 @opindex Wtraditional
2916 Warn about certain constructs that behave differently in traditional and
2917 ISO C@.  Also warn about ISO C constructs that have no traditional C
2918 equivalent, and/or problematic constructs which should be avoided.
2919
2920 @itemize @bullet
2921 @item
2922 Macro parameters that appear within string literals in the macro body.
2923 In traditional C macro replacement takes place within string literals,
2924 but does not in ISO C@.
2925
2926 @item
2927 In traditional C, some preprocessor directives did not exist.
2928 Traditional preprocessors would only consider a line to be a directive
2929 if the @samp{#} appeared in column 1 on the line.  Therefore
2930 @option{-Wtraditional} warns about directives that traditional C
2931 understands but would ignore because the @samp{#} does not appear as the
2932 first character on the line.  It also suggests you hide directives like
2933 @samp{#pragma} not understood by traditional C by indenting them.  Some
2934 traditional implementations would not recognize @samp{#elif}, so it
2935 suggests avoiding it altogether.
2936
2937 @item
2938 A function-like macro that appears without arguments.
2939
2940 @item
2941 The unary plus operator.
2942
2943 @item
2944 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2945 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2946 constants.)  Note, these suffixes appear in macros defined in the system
2947 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2948 Use of these macros in user code might normally lead to spurious
2949 warnings, however GCC's integrated preprocessor has enough context to
2950 avoid warning in these cases.
2951
2952 @item
2953 A function declared external in one block and then used after the end of
2954 the block.
2955
2956 @item
2957 A @code{switch} statement has an operand of type @code{long}.
2958
2959 @item
2960 A non-@code{static} function declaration follows a @code{static} one.
2961 This construct is not accepted by some traditional C compilers.
2962
2963 @item
2964 The ISO type of an integer constant has a different width or
2965 signedness from its traditional type.  This warning is only issued if
2966 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2967 typically represent bit patterns, are not warned about.
2968
2969 @item
2970 Usage of ISO string concatenation is detected.
2971
2972 @item
2973 Initialization of automatic aggregates.
2974
2975 @item
2976 Identifier conflicts with labels.  Traditional C lacks a separate
2977 namespace for labels.
2978
2979 @item
2980 Initialization of unions.  If the initializer is zero, the warning is
2981 omitted.  This is done under the assumption that the zero initializer in
2982 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2983 initializer warnings and relies on default initialization to zero in the
2984 traditional C case.
2985
2986 @item
2987 Conversions by prototypes between fixed/floating point values and vice
2988 versa.  The absence of these prototypes when compiling with traditional
2989 C would cause serious problems.  This is a subset of the possible
2990 conversion warnings, for the full set use @option{-Wconversion}.
2991
2992 @item
2993 Use of ISO C style function definitions.  This warning intentionally is
2994 @emph{not} issued for prototype declarations or variadic functions
2995 because these ISO C features will appear in your code when using
2996 libiberty's traditional C compatibility macros, @code{PARAMS} and
2997 @code{VPARAMS}.  This warning is also bypassed for nested functions
2998 because that feature is already a GCC extension and thus not relevant to
2999 traditional C compatibility.
3000 @end itemize
3001
3002 @item -Wdeclaration-after-statement @r{(C only)}
3003 @opindex Wdeclaration-after-statement
3004 Warn when a declaration is found after a statement in a block.  This
3005 construct, known from C++, was introduced with ISO C99 and is by default
3006 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3007 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3008
3009 @item -Wundef
3010 @opindex Wundef
3011 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3012
3013 @item -Wno-endif-labels
3014 @opindex Wno-endif-labels
3015 @opindex Wendif-labels
3016 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3017
3018 @item -Wshadow
3019 @opindex Wshadow
3020 Warn whenever a local variable shadows another local variable, parameter or
3021 global variable or whenever a built-in function is shadowed.
3022
3023 @item -Wlarger-than-@var{len}
3024 @opindex Wlarger-than
3025 Warn whenever an object of larger than @var{len} bytes is defined.
3026
3027 @item -Wunsafe-loop-optimizations
3028 @opindex Wunsafe-loop-optimizations
3029 Warn if the loop cannot be optimized because the compiler could not
3030 assume anything on the bounds of the loop indices.  With
3031 @option{-funsafe-loop-optimizations} warn if the compiler made
3032 such assumptions.
3033
3034 @item -Wpointer-arith
3035 @opindex Wpointer-arith
3036 Warn about anything that depends on the ``size of'' a function type or
3037 of @code{void}.  GNU C assigns these types a size of 1, for
3038 convenience in calculations with @code{void *} pointers and pointers
3039 to functions.
3040
3041 @item -Wbad-function-cast @r{(C only)}
3042 @opindex Wbad-function-cast
3043 Warn whenever a function call is cast to a non-matching type.
3044 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3045
3046 @item -Wc++-compat
3047 Warn about ISO C constructs that are outside of the common subset of
3048 ISO C and ISO C++, e.g.@: request for implicit conversion from
3049 @code{void *} to a pointer to non-@code{void} type.
3050
3051 @item -Wcast-qual
3052 @opindex Wcast-qual
3053 Warn whenever a pointer is cast so as to remove a type qualifier from
3054 the target type.  For example, warn if a @code{const char *} is cast
3055 to an ordinary @code{char *}.
3056
3057 @item -Wcast-align
3058 @opindex Wcast-align
3059 Warn whenever a pointer is cast such that the required alignment of the
3060 target is increased.  For example, warn if a @code{char *} is cast to
3061 an @code{int *} on machines where integers can only be accessed at
3062 two- or four-byte boundaries.
3063
3064 @item -Wwrite-strings
3065 @opindex Wwrite-strings
3066 When compiling C, give string constants the type @code{const
3067 char[@var{length}]} so that
3068 copying the address of one into a non-@code{const} @code{char *}
3069 pointer will get a warning; when compiling C++, warn about the
3070 deprecated conversion from string constants to @code{char *}.
3071 These warnings will help you find at
3072 compile time code that can try to write into a string constant, but
3073 only if you have been very careful about using @code{const} in
3074 declarations and prototypes.  Otherwise, it will just be a nuisance;
3075 this is why we did not make @option{-Wall} request these warnings.
3076
3077 @item -Wconversion
3078 @opindex Wconversion
3079 Warn if a prototype causes a type conversion that is different from what
3080 would happen to the same argument in the absence of a prototype.  This
3081 includes conversions of fixed point to floating and vice versa, and
3082 conversions changing the width or signedness of a fixed point argument
3083 except when the same as the default promotion.
3084
3085 Also, warn if a negative integer constant expression is implicitly
3086 converted to an unsigned type.  For example, warn about the assignment
3087 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3088 casts like @code{(unsigned) -1}.
3089
3090 @item -Wsign-compare
3091 @opindex Wsign-compare
3092 @cindex warning for comparison of signed and unsigned values
3093 @cindex comparison of signed and unsigned values, warning
3094 @cindex signed and unsigned values, comparison warning
3095 Warn when a comparison between signed and unsigned values could produce
3096 an incorrect result when the signed value is converted to unsigned.
3097 This warning is also enabled by @option{-Wextra}; to get the other warnings
3098 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3099
3100 @item -Waggregate-return
3101 @opindex Waggregate-return
3102 Warn if any functions that return structures or unions are defined or
3103 called.  (In languages where you can return an array, this also elicits
3104 a warning.)
3105
3106 @item -Wno-attributes
3107 @opindex Wno-attributes
3108 @opindex Wattributes
3109 Do not warn if an unexpected @code{__attribute__} is used, such as
3110 unrecognized attributes, function attributes applied to variables,
3111 etc.  This will not stop errors for incorrect use of supported
3112 attributes.
3113
3114 @item -Wstrict-prototypes @r{(C only)}
3115 @opindex Wstrict-prototypes
3116 Warn if a function is declared or defined without specifying the
3117 argument types.  (An old-style function definition is permitted without
3118 a warning if preceded by a declaration which specifies the argument
3119 types.)
3120
3121 @item -Wold-style-definition @r{(C only)}
3122 @opindex Wold-style-definition
3123 Warn if an old-style function definition is used.  A warning is given
3124 even if there is a previous prototype.
3125
3126 @item -Wmissing-prototypes @r{(C only)}
3127 @opindex Wmissing-prototypes
3128 Warn if a global function is defined without a previous prototype
3129 declaration.  This warning is issued even if the definition itself
3130 provides a prototype.  The aim is to detect global functions that fail
3131 to be declared in header files.
3132
3133 @item -Wmissing-declarations @r{(C only)}
3134 @opindex Wmissing-declarations
3135 Warn if a global function is defined without a previous declaration.
3136 Do so even if the definition itself provides a prototype.
3137 Use this option to detect global functions that are not declared in
3138 header files.
3139
3140 @item -Wmissing-field-initializers
3141 @opindex Wmissing-field-initializers
3142 @opindex W
3143 @opindex Wextra
3144 Warn if a structure's initializer has some fields missing.  For
3145 example, the following code would cause such a warning, because
3146 @code{x.h} is implicitly zero:
3147
3148 @smallexample
3149 struct s @{ int f, g, h; @};
3150 struct s x = @{ 3, 4 @};
3151 @end smallexample
3152
3153 This option does not warn about designated initializers, so the following
3154 modification would not trigger a warning:
3155
3156 @smallexample
3157 struct s @{ int f, g, h; @};
3158 struct s x = @{ .f = 3, .g = 4 @};
3159 @end smallexample
3160
3161 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3162 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3163
3164 @item -Wmissing-noreturn
3165 @opindex Wmissing-noreturn
3166 Warn about functions which might be candidates for attribute @code{noreturn}.
3167 Note these are only possible candidates, not absolute ones.  Care should
3168 be taken to manually verify functions actually do not ever return before
3169 adding the @code{noreturn} attribute, otherwise subtle code generation
3170 bugs could be introduced.  You will not get a warning for @code{main} in
3171 hosted C environments.
3172
3173 @item -Wmissing-format-attribute
3174 @opindex Wmissing-format-attribute
3175 @opindex Wformat
3176 Warn about function pointers which might be candidates for @code{format}
3177 attributes.  Note these are only possible candidates, not absolute ones.
3178 GCC will guess that function pointers with @code{format} attributes that
3179 are used in assignment, initialization, parameter passing or return
3180 statements should have a corresponding @code{format} attribute in the
3181 resulting type.  I.e.@: the left-hand side of the assignment or
3182 initialization, the type of the parameter variable, or the return type
3183 of the containing function respectively should also have a @code{format}
3184 attribute to avoid the warning.
3185
3186 GCC will also warn about function definitions which might be
3187 candidates for @code{format} attributes.  Again, these are only
3188 possible candidates.  GCC will guess that @code{format} attributes
3189 might be appropriate for any function that calls a function like
3190 @code{vprintf} or @code{vscanf}, but this might not always be the
3191 case, and some functions for which @code{format} attributes are
3192 appropriate may not be detected.
3193
3194 @item -Wno-multichar
3195 @opindex Wno-multichar
3196 @opindex Wmultichar
3197 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3198 Usually they indicate a typo in the user's code, as they have
3199 implementation-defined values, and should not be used in portable code.
3200
3201 @item -Wnormalized=<none|id|nfc|nfkc>
3202 @opindex Wnormalized
3203 @cindex NFC
3204 @cindex NFKC
3205 @cindex character set, input normalization
3206 In ISO C and ISO C++, two identifiers are different if they are
3207 different sequences of characters.  However, sometimes when characters
3208 outside the basic ASCII character set are used, you can have two
3209 different character sequences that look the same.  To avoid confusion,
3210 the ISO 10646 standard sets out some @dfn{normalization rules} which
3211 when applied ensure that two sequences that look the same are turned into
3212 the same sequence.  GCC can warn you if you are using identifiers which
3213 have not been normalized; this option controls that warning.
3214
3215 There are four levels of warning that GCC supports.  The default is
3216 @option{-Wnormalized=nfc}, which warns about any identifier which is
3217 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3218 recommended form for most uses.
3219
3220 Unfortunately, there are some characters which ISO C and ISO C++ allow
3221 in identifiers that when turned into NFC aren't allowable as
3222 identifiers.  That is, there's no way to use these symbols in portable
3223 ISO C or C++ and have all your identifiers in NFC.
3224 @option{-Wnormalized=id} suppresses the warning for these characters.
3225 It is hoped that future versions of the standards involved will correct
3226 this, which is why this option is not the default.
3227
3228 You can switch the warning off for all characters by writing
3229 @option{-Wnormalized=none}.  You would only want to do this if you
3230 were using some other normalization scheme (like ``D''), because
3231 otherwise you can easily create bugs that are literally impossible to see.
3232
3233 Some characters in ISO 10646 have distinct meanings but look identical
3234 in some fonts or display methodologies, especially once formatting has
3235 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3236 LETTER N'', will display just like a regular @code{n} which has been
3237 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3238 normalisation scheme to convert all these into a standard form as
3239 well, and GCC will warn if your code is not in NFKC if you use
3240 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3241 about every identifier that contains the letter O because it might be
3242 confused with the digit 0, and so is not the default, but may be
3243 useful as a local coding convention if the programming environment is
3244 unable to be fixed to display these characters distinctly.
3245
3246 @item -Wno-deprecated-declarations
3247 @opindex Wno-deprecated-declarations
3248 Do not warn about uses of functions, variables, and types marked as
3249 deprecated by using the @code{deprecated} attribute.
3250 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3251 @pxref{Type Attributes}.)
3252
3253 @item -Wpacked
3254 @opindex Wpacked
3255 Warn if a structure is given the packed attribute, but the packed
3256 attribute has no effect on the layout or size of the structure.
3257 Such structures may be mis-aligned for little benefit.  For
3258 instance, in this code, the variable @code{f.x} in @code{struct bar}
3259 will be misaligned even though @code{struct bar} does not itself
3260 have the packed attribute:
3261
3262 @smallexample
3263 @group
3264 struct foo @{
3265   int x;
3266   char a, b, c, d;
3267 @} __attribute__((packed));
3268 struct bar @{
3269   char z;
3270   struct foo f;
3271 @};
3272 @end group
3273 @end smallexample
3274
3275 @item -Wpadded
3276 @opindex Wpadded
3277 Warn if padding is included in a structure, either to align an element
3278 of the structure or to align the whole structure.  Sometimes when this
3279 happens it is possible to rearrange the fields of the structure to
3280 reduce the padding and so make the structure smaller.
3281
3282 @item -Wredundant-decls
3283 @opindex Wredundant-decls
3284 Warn if anything is declared more than once in the same scope, even in
3285 cases where multiple declaration is valid and changes nothing.
3286
3287 @item -Wnested-externs @r{(C only)}
3288 @opindex Wnested-externs
3289 Warn if an @code{extern} declaration is encountered within a function.
3290
3291 @item -Wunreachable-code
3292 @opindex Wunreachable-code
3293 Warn if the compiler detects that code will never be executed.
3294
3295 This option is intended to warn when the compiler detects that at
3296 least a whole line of source code will never be executed, because
3297 some condition is never satisfied or because it is after a
3298 procedure that never returns.
3299
3300 It is possible for this option to produce a warning even though there
3301 are circumstances under which part of the affected line can be executed,
3302 so care should be taken when removing apparently-unreachable code.
3303
3304 For instance, when a function is inlined, a warning may mean that the
3305 line is unreachable in only one inlined copy of the function.
3306
3307 This option is not made part of @option{-Wall} because in a debugging
3308 version of a program there is often substantial code which checks
3309 correct functioning of the program and is, hopefully, unreachable
3310 because the program does work.  Another common use of unreachable
3311 code is to provide behavior which is selectable at compile-time.
3312
3313 @item -Winline
3314 @opindex Winline
3315 Warn if a function can not be inlined and it was declared as inline.
3316 Even with this option, the compiler will not warn about failures to
3317 inline functions declared in system headers.
3318
3319 The compiler uses a variety of heuristics to determine whether or not
3320 to inline a function.  For example, the compiler takes into account
3321 the size of the function being inlined and the amount of inlining
3322 that has already been done in the current function.  Therefore,
3323 seemingly insignificant changes in the source program can cause the
3324 warnings produced by @option{-Winline} to appear or disappear.
3325
3326 @item -Wno-invalid-offsetof @r{(C++ only)}
3327 @opindex Wno-invalid-offsetof
3328 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3329 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3330 to a non-POD type is undefined.  In existing C++ implementations,
3331 however, @samp{offsetof} typically gives meaningful results even when
3332 applied to certain kinds of non-POD types. (Such as a simple
3333 @samp{struct} that fails to be a POD type only by virtue of having a
3334 constructor.)  This flag is for users who are aware that they are
3335 writing nonportable code and who have deliberately chosen to ignore the
3336 warning about it.
3337
3338 The restrictions on @samp{offsetof} may be relaxed in a future version
3339 of the C++ standard.
3340
3341 @item -Wno-int-to-pointer-cast @r{(C only)}
3342 @opindex Wno-int-to-pointer-cast
3343 Suppress warnings from casts to pointer type of an integer of a
3344 different size.
3345
3346 @item -Wno-pointer-to-int-cast @r{(C only)}
3347 @opindex Wno-pointer-to-int-cast
3348 Suppress warnings from casts from a pointer to an integer type of a
3349 different size.
3350
3351 @item -Winvalid-pch
3352 @opindex Winvalid-pch
3353 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3354 the search path but can't be used.
3355
3356 @item -Wlong-long
3357 @opindex Wlong-long
3358 @opindex Wno-long-long
3359 Warn if @samp{long long} type is used.  This is default.  To inhibit
3360 the warning messages, use @option{-Wno-long-long}.  Flags
3361 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3362 only when @option{-pedantic} flag is used.
3363
3364 @item -Wvariadic-macros
3365 @opindex Wvariadic-macros
3366 @opindex Wno-variadic-macros
3367 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3368 alternate syntax when in pedantic ISO C99 mode.  This is default.
3369 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3370
3371 @item -Wvolatile-register-var
3372 @opindex Wvolatile-register-var
3373 @opindex Wno-volatile-register-var
3374 Warn if a register variable is declared volatile.  The volatile
3375 modifier does not inhibit all optimizations that may eliminate reads
3376 and/or writes to register variables.
3377
3378 @item -Wdisabled-optimization
3379 @opindex Wdisabled-optimization
3380 Warn if a requested optimization pass is disabled.  This warning does
3381 not generally indicate that there is anything wrong with your code; it
3382 merely indicates that GCC's optimizers were unable to handle the code
3383 effectively.  Often, the problem is that your code is too big or too
3384 complex; GCC will refuse to optimize programs when the optimization
3385 itself is likely to take inordinate amounts of time.
3386
3387 @item -Wpointer-sign
3388 @opindex Wpointer-sign
3389 @opindex Wno-pointer-sign
3390 Warn for pointer argument passing or assignment with different signedness.
3391 This option is only supported for C and Objective-C@.  It is implied by
3392 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3393 @option{-Wno-pointer-sign}.
3394
3395 @item -Werror
3396 @opindex Werror
3397 Make all warnings into errors.
3398
3399 @item -Wstack-protector
3400 This option is only active when @option{-fstack-protector} is active.  It
3401 warns about functions that will not be protected against stack smashing.
3402
3403 @end table
3404
3405 @node Debugging Options
3406 @section Options for Debugging Your Program or GCC
3407 @cindex options, debugging
3408 @cindex debugging information options
3409
3410 GCC has various special options that are used for debugging
3411 either your program or GCC:
3412
3413 @table @gcctabopt
3414 @item -g
3415 @opindex g
3416 Produce debugging information in the operating system's native format
3417 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3418 information.
3419
3420 On most systems that use stabs format, @option{-g} enables use of extra
3421 debugging information that only GDB can use; this extra information
3422 makes debugging work better in GDB but will probably make other debuggers
3423 crash or
3424 refuse to read the program.  If you want to control for certain whether
3425 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3426 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3427
3428 GCC allows you to use @option{-g} with
3429 @option{-O}.  The shortcuts taken by optimized code may occasionally
3430 produce surprising results: some variables you declared may not exist
3431 at all; flow of control may briefly move where you did not expect it;
3432 some statements may not be executed because they compute constant
3433 results or their values were already at hand; some statements may
3434 execute in different places because they were moved out of loops.
3435
3436 Nevertheless it proves possible to debug optimized output.  This makes
3437 it reasonable to use the optimizer for programs that might have bugs.
3438
3439 The following options are useful when GCC is generated with the
3440 capability for more than one debugging format.
3441
3442 @item -ggdb
3443 @opindex ggdb
3444 Produce debugging information for use by GDB@.  This means to use the
3445 most expressive format available (DWARF 2, stabs, or the native format
3446 if neither of those are supported), including GDB extensions if at all
3447 possible.
3448
3449 @item -gstabs
3450 @opindex gstabs
3451 Produce debugging information in stabs format (if that is supported),
3452 without GDB extensions.  This is the format used by DBX on most BSD
3453 systems.  On MIPS, Alpha and System V Release 4 systems this option
3454 produces stabs debugging output which is not understood by DBX or SDB@.
3455 On System V Release 4 systems this option requires the GNU assembler.
3456
3457 @item -feliminate-unused-debug-symbols
3458 @opindex feliminate-unused-debug-symbols
3459 Produce debugging information in stabs format (if that is supported),
3460 for only symbols that are actually used.
3461
3462 @item -gstabs+
3463 @opindex gstabs+
3464 Produce debugging information in stabs format (if that is supported),
3465 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3466 use of these extensions is likely to make other debuggers crash or
3467 refuse to read the program.
3468
3469 @item -gcoff
3470 @opindex gcoff
3471 Produce debugging information in COFF format (if that is supported).
3472 This is the format used by SDB on most System V systems prior to
3473 System V Release 4.
3474
3475 @item -gxcoff
3476 @opindex gxcoff
3477 Produce debugging information in XCOFF format (if that is supported).
3478 This is the format used by the DBX debugger on IBM RS/6000 systems.
3479
3480 @item -gxcoff+
3481 @opindex gxcoff+
3482 Produce debugging information in XCOFF format (if that is supported),
3483 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3484 use of these extensions is likely to make other debuggers crash or
3485 refuse to read the program, and may cause assemblers other than the GNU
3486 assembler (GAS) to fail with an error.
3487
3488 @item -gdwarf-2
3489 @opindex gdwarf-2
3490 Produce debugging information in DWARF version 2 format (if that is
3491 supported).  This is the format used by DBX on IRIX 6.  With this
3492 option, GCC uses features of DWARF version 3 when they are useful;
3493 version 3 is upward compatible with version 2, but may still cause
3494 problems for older debuggers.
3495
3496 @item -gvms
3497 @opindex gvms
3498 Produce debugging information in VMS debug format (if that is
3499 supported).  This is the format used by DEBUG on VMS systems.
3500
3501 @item -g@var{level}
3502 @itemx -ggdb@var{level}
3503 @itemx -gstabs@var{level}
3504 @itemx -gcoff@var{level}
3505 @itemx -gxcoff@var{level}
3506 @itemx -gvms@var{level}
3507 Request debugging information and also use @var{level} to specify how
3508 much information.  The default level is 2.
3509
3510 Level 1 produces minimal information, enough for making backtraces in
3511 parts of the program that you don't plan to debug.  This includes
3512 descriptions of functions and external variables, but no information
3513 about local variables and no line numbers.
3514
3515 Level 3 includes extra information, such as all the macro definitions
3516 present in the program.  Some debuggers support macro expansion when
3517 you use @option{-g3}.
3518
3519 @option{-gdwarf-2} does not accept a concatenated debug level, because
3520 GCC used to support an option @option{-gdwarf} that meant to generate
3521 debug information in version 1 of the DWARF format (which is very
3522 different from version 2), and it would have been too confusing.  That
3523 debug format is long obsolete, but the option cannot be changed now.
3524 Instead use an additional @option{-g@var{level}} option to change the
3525 debug level for DWARF2.
3526
3527 @item -feliminate-dwarf2-dups
3528 @opindex feliminate-dwarf2-dups
3529 Compress DWARF2 debugging information by eliminating duplicated
3530 information about each symbol.  This option only makes sense when
3531 generating DWARF2 debugging information with @option{-gdwarf-2}.
3532
3533 @cindex @command{prof}
3534 @item -p
3535 @opindex p
3536 Generate extra code to write profile information suitable for the
3537 analysis program @command{prof}.  You must use this option when compiling
3538 the source files you want data about, and you must also use it when
3539 linking.
3540
3541 @cindex @command{gprof}
3542 @item -pg
3543 @opindex pg
3544 Generate extra code to write profile information suitable for the
3545 analysis program @command{gprof}.  You must use this option when compiling
3546 the source files you want data about, and you must also use it when
3547 linking.
3548
3549 @item -Q
3550 @opindex Q
3551 Makes the compiler print out each function name as it is compiled, and
3552 print some statistics about each pass when it finishes.
3553
3554 @item -ftime-report
3555 @opindex ftime-report
3556 Makes the compiler print some statistics about the time consumed by each
3557 pass when it finishes.
3558
3559 @item -fmem-report
3560 @opindex fmem-report
3561 Makes the compiler print some statistics about permanent memory
3562 allocation when it finishes.
3563
3564 @item -fprofile-arcs
3565 @opindex fprofile-arcs
3566 Add code so that program flow @dfn{arcs} are instrumented.  During
3567 execution the program records how many times each branch and call is
3568 executed and how many times it is taken or returns.  When the compiled
3569 program exits it saves this data to a file called
3570 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3571 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3572 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3573 @var{auxname} is generated from the name of the output file, if
3574 explicitly specified and it is not the final executable, otherwise it is
3575 the basename of the source file.  In both cases any suffix is removed
3576 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3577 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3578 @xref{Cross-profiling}.
3579
3580 @cindex @command{gcov}
3581 @item --coverage
3582 @opindex coverage
3583
3584 This option is used to compile and link code instrumented for coverage
3585 analysis.  The option is a synonym for @option{-fprofile-arcs}
3586 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3587 linking).  See the documentation for those options for more details.
3588
3589 @itemize
3590
3591 @item
3592 Compile the source files with @option{-fprofile-arcs} plus optimization
3593 and code generation options.  For test coverage analysis, use the
3594 additional @option{-ftest-coverage} option.  You do not need to profile
3595 every source file in a program.
3596
3597 @item
3598 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3599 (the latter implies the former).
3600
3601 @item
3602 Run the program on a representative workload to generate the arc profile
3603 information.  This may be repeated any number of times.  You can run
3604 concurrent instances of your program, and provided that the file system
3605 supports locking, the data files will be correctly updated.  Also
3606 @code{fork} calls are detected and correctly handled (double counting
3607 will not happen).
3608
3609 @item
3610 For profile-directed optimizations, compile the source files again with
3611 the same optimization and code generation options plus
3612 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3613 Control Optimization}).
3614
3615 @item
3616 For test coverage analysis, use @command{gcov} to produce human readable
3617 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3618 @command{gcov} documentation for further information.
3619
3620 @end itemize
3621
3622 With @option{-fprofile-arcs}, for each function of your program GCC
3623 creates a program flow graph, then finds a spanning tree for the graph.
3624 Only arcs that are not on the spanning tree have to be instrumented: the
3625 compiler adds code to count the number of times that these arcs are
3626 executed.  When an arc is the only exit or only entrance to a block, the
3627 instrumentation code can be added to the block; otherwise, a new basic
3628 block must be created to hold the instrumentation code.
3629
3630 @need 2000
3631 @item -ftest-coverage
3632 @opindex ftest-coverage
3633 Produce a notes file that the @command{gcov} code-coverage utility
3634 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3635 show program coverage.  Each source file's note file is called
3636 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3637 above for a description of @var{auxname} and instructions on how to
3638 generate test coverage data.  Coverage data will match the source files
3639 more closely, if you do not optimize.
3640
3641 @item -d@var{letters}
3642 @item -fdump-rtl-@var{pass}
3643 @opindex d
3644 Says to make debugging dumps during compilation at times specified by
3645 @var{letters}.    This is used for debugging the RTL-based passes of the
3646 compiler.  The file names for most of the dumps are made by appending a
3647 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3648 from the name of the output file, if explicitly specified and it is not
3649 an executable, otherwise it is the basename of the source file.
3650
3651 Most debug dumps can be enabled either passing a letter to the @option{-d}
3652 option, or with a long @option{-fdump-rtl} switch; here are the possible
3653 letters for use in @var{letters} and @var{pass}, and their meanings:
3654
3655 @table @gcctabopt
3656 @item -dA
3657 @opindex dA
3658 Annotate the assembler output with miscellaneous debugging information.
3659
3660 @item -db
3661 @itemx -fdump-rtl-bp
3662 @opindex db
3663 @opindex fdump-rtl-bp
3664 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3665
3666 @item -dB
3667 @itemx -fdump-rtl-bbro
3668 @opindex dB
3669 @opindex fdump-rtl-bbro
3670 Dump after block reordering, to @file{@var{file}.30.bbro}.
3671
3672 @item -dc
3673 @itemx -fdump-rtl-combine
3674 @opindex dc
3675 @opindex fdump-rtl-combine
3676 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3677
3678 @item -dC
3679 @itemx -fdump-rtl-ce1
3680 @itemx -fdump-rtl-ce2
3681 @opindex dC
3682 @opindex fdump-rtl-ce1
3683 @opindex fdump-rtl-ce2
3684 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3685 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3686 and @option{-fdump-rtl-ce2} enable dumping after the second if
3687 conversion, to the file @file{@var{file}.18.ce2}.
3688
3689 @item -dd
3690 @itemx -fdump-rtl-btl
3691 @itemx -fdump-rtl-dbr
3692 @opindex dd
3693 @opindex fdump-rtl-btl
3694 @opindex fdump-rtl-dbr
3695 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3696 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3697 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3698 scheduling, to @file{@var{file}.36.dbr}.
3699
3700 @item -dD
3701 @opindex dD
3702 Dump all macro definitions, at the end of preprocessing, in addition to
3703 normal output.
3704
3705 @item -dE
3706 @itemx -fdump-rtl-ce3
3707 @opindex dE
3708 @opindex fdump-rtl-ce3
3709 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3710
3711 @item -df
3712 @itemx -fdump-rtl-cfg
3713 @itemx -fdump-rtl-life
3714 @opindex df
3715 @opindex fdump-rtl-cfg
3716 @opindex fdump-rtl-life
3717 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3718 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3719 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3720 to @file{@var{file}.16.life}.
3721
3722 @item -dg
3723 @itemx -fdump-rtl-greg
3724 @opindex dg
3725 @opindex fdump-rtl-greg
3726 Dump after global register allocation, to @file{@var{file}.23.greg}.
3727
3728 @item -dG
3729 @itemx -fdump-rtl-gcse
3730 @itemx -fdump-rtl-bypass
3731 @opindex dG
3732 @opindex fdump-rtl-gcse
3733 @opindex fdump-rtl-bypass
3734 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3735 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3736 enable dumping after jump bypassing and control flow optimizations, to
3737 @file{@var{file}.07.bypass}.
3738
3739 @item -dh
3740 @itemx -fdump-rtl-eh
3741 @opindex dh
3742 @opindex fdump-rtl-eh
3743 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3744
3745 @item -di
3746 @itemx -fdump-rtl-sibling
3747 @opindex di
3748 @opindex fdump-rtl-sibling
3749 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3750
3751 @item -dj
3752 @itemx -fdump-rtl-jump
3753 @opindex dj
3754 @opindex fdump-rtl-jump
3755 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3756
3757 @item -dk
3758 @itemx -fdump-rtl-stack
3759 @opindex dk
3760 @opindex fdump-rtl-stack
3761 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3762
3763 @item -dl
3764 @itemx -fdump-rtl-lreg
3765 @opindex dl
3766 @opindex fdump-rtl-lreg
3767 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3768
3769 @item -dL
3770 @itemx -fdump-rtl-loop
3771 @itemx -fdump-rtl-loop2
3772 @opindex dL
3773 @opindex fdump-rtl-loop
3774 @opindex fdump-rtl-loop2
3775 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3776 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3777 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3778 @file{@var{file}.13.loop2}.
3779
3780 @item -dm
3781 @itemx -fdump-rtl-sms
3782 @opindex dm
3783 @opindex fdump-rtl-sms
3784 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3785
3786 @item -dM
3787 @itemx -fdump-rtl-mach
3788 @opindex dM
3789 @opindex fdump-rtl-mach
3790 Dump after performing the machine dependent reorganization pass, to
3791 @file{@var{file}.35.mach}.
3792
3793 @item -dn
3794 @itemx -fdump-rtl-rnreg
3795 @opindex dn
3796 @opindex fdump-rtl-rnreg
3797 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3798
3799 @item -dN
3800 @itemx -fdump-rtl-regmove
3801 @opindex dN
3802 @opindex fdump-rtl-regmove
3803 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3804
3805 @item -do
3806 @itemx -fdump-rtl-postreload
3807 @opindex do
3808 @opindex fdump-rtl-postreload
3809 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3810
3811 @item -dr
3812 @itemx -fdump-rtl-expand
3813 @opindex dr
3814 @opindex fdump-rtl-expand
3815 Dump after RTL generation, to @file{@var{file}.00.expand}.
3816
3817 @item -dR
3818 @itemx -fdump-rtl-sched2
3819 @opindex dR
3820 @opindex fdump-rtl-sched2
3821 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3822
3823 @item -ds
3824 @itemx -fdump-rtl-cse
3825 @opindex ds
3826 @opindex fdump-rtl-cse
3827 Dump after CSE (including the jump optimization that sometimes follows
3828 CSE), to @file{@var{file}.04.cse}.
3829
3830 @item -dS
3831 @itemx -fdump-rtl-sched
3832 @opindex dS
3833 @opindex fdump-rtl-sched
3834 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3835
3836 @item -dt
3837 @itemx -fdump-rtl-cse2
3838 @opindex dt
3839 @opindex fdump-rtl-cse2
3840 Dump after the second CSE pass (including the jump optimization that
3841 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3842
3843 @item -dT
3844 @itemx -fdump-rtl-tracer
3845 @opindex dT
3846 @opindex fdump-rtl-tracer
3847 Dump after running tracer, to @file{@var{file}.12.tracer}.
3848
3849 @item -dV
3850 @itemx -fdump-rtl-vpt
3851 @itemx -fdump-rtl-vartrack
3852 @opindex dV
3853 @opindex fdump-rtl-vpt
3854 @opindex fdump-rtl-vartrack
3855 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3856 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3857 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3858 to @file{@var{file}.34.vartrack}.
3859
3860 @item -dw
3861 @itemx -fdump-rtl-flow2
3862 @opindex dw
3863 @opindex fdump-rtl-flow2
3864 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3865
3866 @item -dz
3867 @itemx -fdump-rtl-peephole2
3868 @opindex dz
3869 @opindex fdump-rtl-peephole2
3870 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3871
3872 @item -dZ
3873 @itemx -fdump-rtl-web
3874 @opindex dZ
3875 @opindex fdump-rtl-web
3876 Dump after live range splitting, to @file{@var{file}.14.web}.
3877
3878 @item -da
3879 @itemx -fdump-rtl-all
3880 @opindex da
3881 @opindex fdump-rtl-all
3882 Produce all the dumps listed above.
3883
3884 @item -dH
3885 @opindex dH
3886 Produce a core dump whenever an error occurs.
3887
3888 @item -dm
3889 @opindex dm
3890 Print statistics on memory usage, at the end of the run, to
3891 standard error.
3892
3893 @item -dp
3894 @opindex dp
3895 Annotate the assembler output with a comment indicating which
3896 pattern and alternative was used.  The length of each instruction is
3897 also printed.
3898
3899 @item -dP
3900 @opindex dP
3901 Dump the RTL in the assembler output as a comment before each instruction.
3902 Also turns on @option{-dp} annotation.
3903
3904 @item -dv
3905 @opindex dv
3906 For each of the other indicated dump files (either with @option{-d} or
3907 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3908 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3909
3910 @item -dx
3911 @opindex dx
3912 Just generate RTL for a function instead of compiling it.  Usually used
3913 with @samp{r} (@option{-fdump-rtl-expand}).
3914
3915 @item -dy
3916 @opindex dy
3917 Dump debugging information during parsing, to standard error.
3918 @end table
3919
3920 @item -fdump-unnumbered
3921 @opindex fdump-unnumbered
3922 When doing debugging dumps (see @option{-d} option above), suppress instruction
3923 numbers and line number note output.  This makes it more feasible to
3924 use diff on debugging dumps for compiler invocations with different
3925 options, in particular with and without @option{-g}.
3926
3927 @item -fdump-translation-unit @r{(C++ only)}
3928 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3929 @opindex fdump-translation-unit
3930 Dump a representation of the tree structure for the entire translation
3931 unit to a file.  The file name is made by appending @file{.tu} to the
3932 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3933 controls the details of the dump as described for the
3934 @option{-fdump-tree} options.
3935
3936 @item -fdump-class-hierarchy @r{(C++ only)}
3937 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3938 @opindex fdump-class-hierarchy
3939 Dump a representation of each class's hierarchy and virtual function
3940 table layout to a file.  The file name is made by appending @file{.class}
3941 to the source file name.  If the @samp{-@var{options}} form is used,
3942 @var{options} controls the details of the dump as described for the
3943 @option{-fdump-tree} options.
3944
3945 @item -fdump-ipa-@var{switch}
3946 @opindex fdump-ipa
3947 Control the dumping at various stages of inter-procedural analysis
3948 language tree to a file.  The file name is generated by appending a switch
3949 specific suffix to the source file name.  The following dumps are possible:
3950
3951 @table @samp
3952 @item all
3953 Enables all inter-procedural analysis dumps; currently the only produced
3954 dump is the @samp{cgraph} dump.
3955
3956 @item cgraph
3957 Dumps information about call-graph optimization, unused function removal,
3958 and inlining decisions.
3959 @end table
3960
3961 @item -fdump-tree-@var{switch}
3962 @itemx -fdump-tree-@var{switch}-@var{options}
3963 @opindex fdump-tree
3964 Control the dumping at various stages of processing the intermediate
3965 language tree to a file.  The file name is generated by appending a switch
3966 specific suffix to the source file name.  If the @samp{-@var{options}}
3967 form is used, @var{options} is a list of @samp{-} separated options that
3968 control the details of the dump.  Not all options are applicable to all
3969 dumps, those which are not meaningful will be ignored.  The following
3970 options are available
3971
3972 @table @samp
3973 @item address
3974 Print the address of each node.  Usually this is not meaningful as it
3975 changes according to the environment and source file.  Its primary use
3976 is for tying up a dump file with a debug environment.
3977 @item slim
3978 Inhibit dumping of members of a scope or body of a function merely
3979 because that scope has been reached.  Only dump such items when they
3980 are directly reachable by some other path.  When dumping pretty-printed
3981 trees, this option inhibits dumping the bodies of control structures.
3982 @item raw
3983 Print a raw representation of the tree.  By default, trees are
3984 pretty-printed into a C-like representation.
3985 @item details
3986 Enable more detailed dumps (not honored by every dump option).
3987 @item stats
3988 Enable dumping various statistics about the pass (not honored by every dump
3989 option).
3990 @item blocks
3991 Enable showing basic block boundaries (disabled in raw dumps).
3992 @item vops
3993 Enable showing virtual operands for every statement.
3994 @item lineno
3995 Enable showing line numbers for statements.
3996 @item uid
3997 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3998 @item all
3999 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4000 @end table
4001
4002 The following tree dumps are possible:
4003 @table @samp
4004
4005 @item original
4006 Dump before any tree based optimization, to @file{@var{file}.original}.
4007
4008 @item optimized
4009 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4010
4011 @item inlined
4012 Dump after function inlining, to @file{@var{file}.inlined}.
4013
4014 @item gimple
4015 @opindex fdump-tree-gimple
4016 Dump each function before and after the gimplification pass to a file.  The
4017 file name is made by appending @file{.gimple} to the source file name.
4018
4019 @item cfg
4020 @opindex fdump-tree-cfg
4021 Dump the control flow graph of each function to a file.  The file name is
4022 made by appending @file{.cfg} to the source file name.
4023
4024 @item vcg
4025 @opindex fdump-tree-vcg
4026 Dump the control flow graph of each function to a file in VCG format.  The
4027 file name is made by appending @file{.vcg} to the source file name.  Note
4028 that if the file contains more than one function, the generated file cannot
4029 be used directly by VCG@.  You will need to cut and paste each function's
4030 graph into its own separate file first.
4031
4032 @item ch
4033 @opindex fdump-tree-ch
4034 Dump each function after copying loop headers.  The file name is made by
4035 appending @file{.ch} to the source file name.
4036
4037 @item ssa
4038 @opindex fdump-tree-ssa
4039 Dump SSA related information to a file.  The file name is made by appending
4040 @file{.ssa} to the source file name.
4041
4042 @item salias
4043 @opindex fdump-tree-salias
4044 Dump structure aliasing variable information to a file.  This file name
4045 is made by appending @file{.salias} to the source file name.
4046
4047 @item alias
4048 @opindex fdump-tree-alias
4049 Dump aliasing information for each function.  The file name is made by
4050 appending @file{.alias} to the source file name.
4051
4052 @item ccp
4053 @opindex fdump-tree-ccp
4054 Dump each function after CCP@.  The file name is made by appending
4055 @file{.ccp} to the source file name.
4056
4057 @item storeccp
4058 @opindex fdump-tree-storeccp
4059 Dump each function after STORE-CCP.  The file name is made by appending
4060 @file{.storeccp} to the source file name.
4061
4062 @item pre
4063 @opindex fdump-tree-pre
4064 Dump trees after partial redundancy elimination.  The file name is made
4065 by appending @file{.pre} to the source file name.
4066
4067 @item fre
4068 @opindex fdump-tree-fre
4069 Dump trees after full redundancy elimination.  The file name is made
4070 by appending @file{.fre} to the source file name.
4071
4072 @item copyprop
4073 @opindex fdump-tree-copyprop
4074 Dump trees after copy propagation.  The file name is made
4075 by appending @file{.copyprop} to the source file name.
4076
4077 @item store_copyprop
4078 @opindex fdump-tree-store_copyprop
4079 Dump trees after store copy-propagation.  The file name is made
4080 by appending @file{.store_copyprop} to the source file name.
4081
4082 @item dce
4083 @opindex fdump-tree-dce
4084 Dump each function after dead code elimination.  The file name is made by
4085 appending @file{.dce} to the source file name.
4086
4087 @item mudflap
4088 @opindex fdump-tree-mudflap
4089 Dump each function after adding mudflap instrumentation.  The file name is
4090 made by appending @file{.mudflap} to the source file name.
4091
4092 @item sra
4093 @opindex fdump-tree-sra
4094 Dump each function after performing scalar replacement of aggregates.  The
4095 file name is made by appending @file{.sra} to the source file name.
4096
4097 @item sink
4098 @opindex fdump-tree-sink
4099 Dump each function after performing code sinking.  The file name is made
4100 by appending @file{.sink} to the source file name. 
4101
4102 @item dom
4103 @opindex fdump-tree-dom
4104 Dump each function after applying dominator tree optimizations.  The file
4105 name is made by appending @file{.dom} to the source file name.
4106
4107 @item dse
4108 @opindex fdump-tree-dse
4109 Dump each function after applying dead store elimination.  The file
4110 name is made by appending @file{.dse} to the source file name.
4111
4112 @item phiopt
4113 @opindex fdump-tree-phiopt
4114 Dump each function after optimizing PHI nodes into straightline code.  The file
4115 name is made by appending @file{.phiopt} to the source file name.
4116
4117 @item forwprop
4118 @opindex fdump-tree-forwprop
4119 Dump each function after forward propagating single use variables.  The file
4120 name is made by appending @file{.forwprop} to the source file name.
4121
4122 @item copyrename
4123 @opindex fdump-tree-copyrename
4124 Dump each function after applying the copy rename optimization.  The file
4125 name is made by appending @file{.copyrename} to the source file name.
4126
4127 @item nrv
4128 @opindex fdump-tree-nrv
4129 Dump each function after applying the named return value optimization on
4130 generic trees.  The file name is made by appending @file{.nrv} to the source
4131 file name.
4132
4133 @item vect
4134 @opindex fdump-tree-vect
4135 Dump each function after applying vectorization of loops.  The file name is
4136 made by appending @file{.vect} to the source file name.
4137
4138 @item vrp
4139 @opindex fdump-tree-vrp
4140 Dump each function after Value Range Propagation (VRP).  The file name
4141 is made by appending @file{.vrp} to the source file name.
4142
4143 @item all
4144 @opindex fdump-tree-all
4145 Enable all the available tree dumps with the flags provided in this option.
4146 @end table
4147
4148 @item -ftree-vectorizer-verbose=@var{n}
4149 @opindex ftree-vectorizer-verbose
4150 This option controls the amount of debugging output the vectorizer prints.
4151 This information is written to standard error, unless @option{-fdump-tree-all}
4152 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4153 usual dump listing file, @file{.vect}.
4154
4155 @item -frandom-seed=@var{string}
4156 @opindex frandom-string
4157 This option provides a seed that GCC uses when it would otherwise use
4158 random numbers.  It is used to generate certain symbol names
4159 that have to be different in every compiled file.  It is also used to
4160 place unique stamps in coverage data files and the object files that
4161 produce them.  You can use the @option{-frandom-seed} option to produce
4162 reproducibly identical object files.
4163
4164 The @var{string} should be different for every file you compile.
4165
4166 @item -fsched-verbose=@var{n}
4167 @opindex fsched-verbose
4168 On targets that use instruction scheduling, this option controls the
4169 amount of debugging output the scheduler prints.  This information is
4170 written to standard error, unless @option{-dS} or @option{-dR} is
4171 specified, in which case it is output to the usual dump
4172 listing file, @file{.sched} or @file{.sched2} respectively.  However
4173 for @var{n} greater than nine, the output is always printed to standard
4174 error.
4175
4176 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4177 same information as @option{-dRS}.  For @var{n} greater than one, it
4178 also output basic block probabilities, detailed ready list information
4179 and unit/insn info.  For @var{n} greater than two, it includes RTL
4180 at abort point, control-flow and regions info.  And for @var{n} over
4181 four, @option{-fsched-verbose} also includes dependence info.
4182
4183 @item -save-temps
4184 @opindex save-temps
4185 Store the usual ``temporary'' intermediate files permanently; place them
4186 in the current directory and name them based on the source file.  Thus,
4187 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4188 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4189 preprocessed @file{foo.i} output file even though the compiler now
4190 normally uses an integrated preprocessor.
4191
4192 When used in combination with the @option{-x} command line option,
4193 @option{-save-temps} is sensible enough to avoid over writing an
4194 input source file with the same extension as an intermediate file.
4195 The corresponding intermediate file may be obtained by renaming the
4196 source file before using @option{-save-temps}.
4197
4198 @item -time
4199 @opindex time
4200 Report the CPU time taken by each subprocess in the compilation
4201 sequence.  For C source files, this is the compiler proper and assembler
4202 (plus the linker if linking is done).  The output looks like this:
4203
4204 @smallexample
4205 # cc1 0.12 0.01
4206 # as 0.00 0.01
4207 @end smallexample
4208
4209 The first number on each line is the ``user time'', that is time spent
4210 executing the program itself.  The second number is ``system time'',
4211 time spent executing operating system routines on behalf of the program.
4212 Both numbers are in seconds.
4213
4214 @item -fvar-tracking
4215 @opindex fvar-tracking
4216 Run variable tracking pass.  It computes where variables are stored at each
4217 position in code.  Better debugging information is then generated
4218 (if the debugging information format supports this information).
4219
4220 It is enabled by default when compiling with optimization (@option{-Os},
4221 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4222 the debug info format supports it.
4223
4224 @item -print-file-name=@var{library}
4225 @opindex print-file-name
4226 Print the full absolute name of the library file @var{library} that
4227 would be used when linking---and don't do anything else.  With this
4228 option, GCC does not compile or link anything; it just prints the
4229 file name.
4230
4231 @item -print-multi-directory
4232 @opindex print-multi-directory
4233 Print the directory name corresponding to the multilib selected by any
4234 other switches present in the command line.  This directory is supposed
4235 to exist in @env{GCC_EXEC_PREFIX}.
4236
4237 @item -print-multi-lib
4238 @opindex print-multi-lib
4239 Print the mapping from multilib directory names to compiler switches
4240 that enable them.  The directory name is separated from the switches by
4241 @samp{;}, and each switch starts with an @samp{@@} instead of the
4242 @samp{-}, without spaces between multiple switches.  This is supposed to
4243 ease shell-processing.
4244
4245 @item -print-prog-name=@var{program}
4246 @opindex print-prog-name
4247 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4248
4249 @item -print-libgcc-file-name
4250 @opindex print-libgcc-file-name
4251 Same as @option{-print-file-name=libgcc.a}.
4252
4253 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4254 but you do want to link with @file{libgcc.a}.  You can do
4255
4256 @smallexample
4257 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4258 @end smallexample
4259
4260 @item -print-search-dirs
4261 @opindex print-search-dirs
4262 Print the name of the configured installation directory and a list of
4263 program and library directories @command{gcc} will search---and don't do anything else.
4264
4265 This is useful when @command{gcc} prints the error message
4266 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4267 To resolve this you either need to put @file{cpp0} and the other compiler
4268 components where @command{gcc} expects to find them, or you can set the environment
4269 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4270 Don't forget the trailing @samp{/}.
4271 @xref{Environment Variables}.
4272
4273 @item -dumpmachine
4274 @opindex dumpmachine
4275 Print the compiler's target machine (for example,
4276 @samp{i686-pc-linux-gnu})---and don't do anything else.
4277
4278 @item -dumpversion
4279 @opindex dumpversion
4280 Print the compiler version (for example, @samp{3.0})---and don't do
4281 anything else.
4282
4283 @item -dumpspecs
4284 @opindex dumpspecs
4285 Print the compiler's built-in specs---and don't do anything else.  (This
4286 is used when GCC itself is being built.)  @xref{Spec Files}.
4287
4288 @item -feliminate-unused-debug-types
4289 @opindex feliminate-unused-debug-types
4290 Normally, when producing DWARF2 output, GCC will emit debugging
4291 information for all types declared in a compilation
4292 unit, regardless of whether or not they are actually used
4293 in that compilation unit.  Sometimes this is useful, such as
4294 if, in the debugger, you want to cast a value to a type that is
4295 not actually used in your program (but is declared).  More often,
4296 however, this results in a significant amount of wasted space.
4297 With this option, GCC will avoid producing debug symbol output
4298 for types that are nowhere used in the source file being compiled.
4299 @end table
4300
4301 @node Optimize Options
4302 @section Options That Control Optimization
4303 @cindex optimize options
4304 @cindex options, optimization
4305
4306 These options control various sorts of optimizations.
4307
4308 Without any optimization option, the compiler's goal is to reduce the
4309 cost of compilation and to make debugging produce the expected
4310 results.  Statements are independent: if you stop the program with a
4311 breakpoint between statements, you can then assign a new value to any
4312 variable or change the program counter to any other statement in the
4313 function and get exactly the results you would expect from the source
4314 code.
4315
4316 Turning on optimization flags makes the compiler attempt to improve
4317 the performance and/or code size at the expense of compilation time
4318 and possibly the ability to debug the program.
4319
4320 The compiler performs optimization based on the knowledge it has of
4321 the program.  Optimization levels @option{-O} and above, in
4322 particular, enable @emph{unit-at-a-time} mode, which allows the
4323 compiler to consider information gained from later functions in
4324 the file when compiling a function.  Compiling multiple files at
4325 once to a single output file in @emph{unit-at-a-time} mode allows
4326 the compiler to use information gained from all of the files when
4327 compiling each of them.
4328
4329 Not all optimizations are controlled directly by a flag.  Only
4330 optimizations that have a flag are listed.
4331
4332 @table @gcctabopt
4333 @item -O
4334 @itemx -O1
4335 @opindex O
4336 @opindex O1
4337 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4338 more memory for a large function.
4339
4340 With @option{-O}, the compiler tries to reduce code size and execution
4341 time, without performing any optimizations that take a great deal of
4342 compilation time.
4343
4344 @option{-O} turns on the following optimization flags:
4345 @gccoptlist{-fdefer-pop @gol
4346 -fdelayed-branch @gol
4347 -fguess-branch-probability @gol
4348 -fcprop-registers @gol
4349 -floop-optimize @gol
4350 -fif-conversion @gol
4351 -fif-conversion2 @gol
4352 -ftree-ccp @gol
4353 -ftree-dce @gol
4354 -ftree-dominator-opts @gol
4355 -ftree-dse @gol
4356 -ftree-ter @gol
4357 -ftree-lrs @gol
4358 -ftree-sra @gol
4359 -ftree-copyrename @gol
4360 -ftree-fre @gol
4361 -ftree-ch @gol
4362 -funit-at-a-time @gol
4363 -fmerge-constants}
4364
4365 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4366 where doing so does not interfere with debugging.
4367
4368 @option{-O} doesn't turn on @option{-ftree-sra} for the Ada compiler.
4369 This option must be explicitly specified on the command line to be
4370 enabled for the Ada compiler.
4371
4372 @item -O2
4373 @opindex O2
4374 Optimize even more.  GCC performs nearly all supported optimizations
4375 that do not involve a space-speed tradeoff.  The compiler does not
4376 perform loop unrolling or function inlining when you specify @option{-O2}.
4377 As compared to @option{-O}, this option increases both compilation time
4378 and the performance of the generated code.
4379
4380 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4381 also turns on the following optimization flags:
4382 @gccoptlist{-fthread-jumps @gol
4383 -fcrossjumping @gol
4384 -foptimize-sibling-calls @gol
4385 -fcse-follow-jumps  -fcse-skip-blocks @gol
4386 -fgcse  -fgcse-lm  @gol
4387 -fexpensive-optimizations @gol
4388 -fstrength-reduce @gol
4389 -frerun-cse-after-loop  -frerun-loop-opt @gol
4390 -fcaller-saves @gol
4391 -fpeephole2 @gol
4392 -fschedule-insns  -fschedule-insns2 @gol
4393 -fsched-interblock  -fsched-spec @gol
4394 -fregmove @gol
4395 -fstrict-aliasing @gol
4396 -fdelete-null-pointer-checks @gol
4397 -freorder-blocks  -freorder-functions @gol
4398 -falign-functions  -falign-jumps @gol
4399 -falign-loops  -falign-labels @gol
4400 -ftree-vrp @gol
4401 -ftree-pre}
4402
4403 Please note the warning under @option{-fgcse} about
4404 invoking @option{-O2} on programs that use computed gotos.
4405
4406 @item -O3
4407 @opindex O3
4408 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4409 @option{-O2} and also turns on the @option{-finline-functions},
4410 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4411
4412 @item -O0
4413 @opindex O0
4414 Do not optimize.  This is the default.
4415
4416 @item -Os
4417 @opindex Os
4418 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4419 do not typically increase code size.  It also performs further
4420 optimizations designed to reduce code size.
4421
4422 @option{-Os} disables the following optimization flags:
4423 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4424 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4425 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4426
4427 If you use multiple @option{-O} options, with or without level numbers,
4428 the last such option is the one that is effective.
4429 @end table
4430
4431 Options of the form @option{-f@var{flag}} specify machine-independent
4432 flags.  Most flags have both positive and negative forms; the negative
4433 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4434 below, only one of the forms is listed---the one you typically will
4435 use.  You can figure out the other form by either removing @samp{no-}
4436 or adding it.
4437
4438 The following options control specific optimizations.  They are either
4439 activated by @option{-O} options or are related to ones that are.  You
4440 can use the following flags in the rare cases when ``fine-tuning'' of
4441 optimizations to be performed is desired.
4442
4443 @table @gcctabopt
4444 @item -fno-default-inline
4445 @opindex fno-default-inline
4446 Do not make member functions inline by default merely because they are
4447 defined inside the class scope (C++ only).  Otherwise, when you specify
4448 @w{@option{-O}}, member functions defined inside class scope are compiled
4449 inline by default; i.e., you don't need to add @samp{inline} in front of
4450 the member function name.
4451
4452 @item -fno-defer-pop
4453 @opindex fno-defer-pop
4454 Always pop the arguments to each function call as soon as that function
4455 returns.  For machines which must pop arguments after a function call,
4456 the compiler normally lets arguments accumulate on the stack for several
4457 function calls and pops them all at once.
4458
4459 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4460
4461 @item -fforce-mem
4462 @opindex fforce-mem
4463 Force memory operands to be copied into registers before doing
4464 arithmetic on them.  This produces better code by making all memory
4465 references potential common subexpressions.  When they are not common
4466 subexpressions, instruction combination should eliminate the separate
4467 register-load. This option is now a nop and will be removed in 4.2.
4468
4469 @item -fforce-addr
4470 @opindex fforce-addr
4471 Force memory address constants to be copied into registers before
4472 doing arithmetic on them.
4473
4474 @item -fomit-frame-pointer
4475 @opindex fomit-frame-pointer
4476 Don't keep the frame pointer in a register for functions that
4477 don't need one.  This avoids the instructions to save, set up and
4478 restore frame pointers; it also makes an extra register available
4479 in many functions.  @strong{It also makes debugging impossible on
4480 some machines.}
4481
4482 On some machines, such as the VAX, this flag has no effect, because
4483 the standard calling sequence automatically handles the frame pointer
4484 and nothing is saved by pretending it doesn't exist.  The
4485 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4486 whether a target machine supports this flag.  @xref{Registers,,Register
4487 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4488
4489 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4490
4491 @item -foptimize-sibling-calls
4492 @opindex foptimize-sibling-calls
4493 Optimize sibling and tail recursive calls.
4494
4495 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4496
4497 @item -fno-inline
4498 @opindex fno-inline
4499 Don't pay attention to the @code{inline} keyword.  Normally this option
4500 is used to keep the compiler from expanding any functions inline.
4501 Note that if you are not optimizing, no functions can be expanded inline.
4502
4503 @item -finline-functions
4504 @opindex finline-functions
4505 Integrate all simple functions into their callers.  The compiler
4506 heuristically decides which functions are simple enough to be worth
4507 integrating in this way.
4508
4509 If all calls to a given function are integrated, and the function is
4510 declared @code{static}, then the function is normally not output as
4511 assembler code in its own right.
4512
4513 Enabled at level @option{-O3}.
4514
4515 @item -finline-functions-called-once
4516 @opindex finline-functions-called-once
4517 Consider all @code{static} functions called once for inlining into their
4518 caller even if they are not marked @code{inline}.  If a call to a given
4519 function is integrated, then the function is not output as assembler code
4520 in its own right.
4521
4522 Enabled if @option{-funit-at-a-time} is enabled.
4523
4524 @item -fearly-inlining
4525 @opindex fearly-inlining
4526 Inline functions marked by @code{always_inline} and functions whose body seems
4527 smaller than the function call overhead early before doing
4528 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4529 makes profiling significantly cheaper and usually inlining faster on programs
4530 having large chains of nested wrapper functions.
4531
4532 Enabled by default.
4533
4534 @item -finline-limit=@var{n}
4535 @opindex finline-limit
4536 By default, GCC limits the size of functions that can be inlined.  This flag
4537 allows the control of this limit for functions that are explicitly marked as
4538 inline (i.e., marked with the inline keyword or defined within the class
4539 definition in c++).  @var{n} is the size of functions that can be inlined in
4540 number of pseudo instructions (not counting parameter handling).  The default
4541 value of @var{n} is 600.
4542 Increasing this value can result in more inlined code at
4543 the cost of compilation time and memory consumption.  Decreasing usually makes
4544 the compilation faster and less code will be inlined (which presumably
4545 means slower programs).  This option is particularly useful for programs that
4546 use inlining heavily such as those based on recursive templates with C++.
4547
4548 Inlining is actually controlled by a number of parameters, which may be
4549 specified individually by using @option{--param @var{name}=@var{value}}.
4550 The @option{-finline-limit=@var{n}} option sets some of these parameters
4551 as follows:
4552
4553 @table @gcctabopt
4554 @item max-inline-insns-single
4555  is set to @var{n}/2.
4556 @item max-inline-insns-auto
4557  is set to @var{n}/2.
4558 @item min-inline-insns
4559  is set to 130 or @var{n}/4, whichever is smaller.
4560 @item max-inline-insns-rtl
4561  is set to @var{n}.
4562 @end table
4563
4564 See below for a documentation of the individual
4565 parameters controlling inlining.
4566
4567 @emph{Note:} pseudo instruction represents, in this particular context, an
4568 abstract measurement of function's size.  In no way does it represent a count
4569 of assembly instructions and as such its exact meaning might change from one
4570 release to an another.
4571
4572 @item -fkeep-inline-functions
4573 @opindex fkeep-inline-functions
4574 In C, emit @code{static} functions that are declared @code{inline}
4575 into the object file, even if the function has been inlined into all
4576 of its callers.  This switch does not affect functions using the
4577 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4578 inline functions into the object file.
4579
4580 @item -fkeep-static-consts
4581 @opindex fkeep-static-consts
4582 Emit variables declared @code{static const} when optimization isn't turned
4583 on, even if the variables aren't referenced.
4584
4585 GCC enables this option by default.  If you want to force the compiler to
4586 check if the variable was referenced, regardless of whether or not
4587 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4588
4589 @item -fmerge-constants
4590 Attempt to merge identical constants (string constants and floating point
4591 constants) across compilation units.
4592
4593 This option is the default for optimized compilation if the assembler and
4594 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4595 behavior.
4596
4597 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4598
4599 @item -fmerge-all-constants
4600 Attempt to merge identical constants and identical variables.
4601
4602 This option implies @option{-fmerge-constants}.  In addition to
4603 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4604 arrays or initialized constant variables with integral or floating point
4605 types.  Languages like C or C++ require each non-automatic variable to
4606 have distinct location, so using this option will result in non-conforming
4607 behavior.
4608
4609 @item -fmodulo-sched
4610 @opindex fmodulo-sched
4611 Perform swing modulo scheduling immediately before the first scheduling
4612 pass.  This pass looks at innermost loops and reorders their
4613 instructions by overlapping different iterations.
4614
4615 @item -fno-branch-count-reg
4616 @opindex fno-branch-count-reg
4617 Do not use ``decrement and branch'' instructions on a count register,
4618 but instead generate a sequence of instructions that decrement a
4619 register, compare it against zero, then branch based upon the result.
4620 This option is only meaningful on architectures that support such
4621 instructions, which include x86, PowerPC, IA-64 and S/390.
4622
4623 The default is @option{-fbranch-count-reg}, enabled when
4624 @option{-fstrength-reduce} is enabled.
4625
4626 @item -fno-function-cse
4627 @opindex fno-function-cse
4628 Do not put function addresses in registers; make each instruction that
4629 calls a constant function contain the function's address explicitly.
4630
4631 This option results in less efficient code, but some strange hacks
4632 that alter the assembler output may be confused by the optimizations
4633 performed when this option is not used.
4634
4635 The default is @option{-ffunction-cse}
4636
4637 @item -fno-zero-initialized-in-bss
4638 @opindex fno-zero-initialized-in-bss
4639 If the target supports a BSS section, GCC by default puts variables that
4640 are initialized to zero into BSS@.  This can save space in the resulting
4641 code.
4642
4643 This option turns off this behavior because some programs explicitly
4644 rely on variables going to the data section.  E.g., so that the
4645 resulting executable can find the beginning of that section and/or make
4646 assumptions based on that.
4647
4648 The default is @option{-fzero-initialized-in-bss}.
4649
4650 @item -fbounds-check
4651 @opindex fbounds-check
4652 For front-ends that support it, generate additional code to check that
4653 indices used to access arrays are within the declared range.  This is
4654 currently only supported by the Java and Fortran front-ends, where
4655 this option defaults to true and false respectively.
4656
4657 @item -fmudflap -fmudflapth -fmudflapir
4658 @opindex fmudflap
4659 @opindex fmudflapth
4660 @opindex fmudflapir
4661 @cindex bounds checking
4662 @cindex mudflap
4663 For front-ends that support it (C and C++), instrument all risky
4664 pointer/array dereferencing operations, some standard library
4665 string/heap functions, and some other associated constructs with
4666 range/validity tests.  Modules so instrumented should be immune to
4667 buffer overflows, invalid heap use, and some other classes of C/C++
4668 programming errors.  The instrumentation relies on a separate runtime
4669 library (@file{libmudflap}), which will be linked into a program if
4670 @option{-fmudflap} is given at link time.  Run-time behavior of the
4671 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4672 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4673 for its options.
4674
4675 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4676 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4677 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4678 instrumentation should ignore pointer reads.  This produces less
4679 instrumentation (and therefore faster execution) and still provides
4680 some protection against outright memory corrupting writes, but allows
4681 erroneously read data to propagate within a program.
4682
4683 @item -fstrength-reduce
4684 @opindex fstrength-reduce
4685 Perform the optimizations of loop strength reduction and
4686 elimination of iteration variables.
4687
4688 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4689
4690 @item -fthread-jumps
4691 @opindex fthread-jumps
4692 Perform optimizations where we check to see if a jump branches to a
4693 location where another comparison subsumed by the first is found.  If
4694 so, the first branch is redirected to either the destination of the
4695 second branch or a point immediately following it, depending on whether
4696 the condition is known to be true or false.
4697
4698 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4699
4700 @item -fcse-follow-jumps
4701 @opindex fcse-follow-jumps
4702 In common subexpression elimination, scan through jump instructions
4703 when the target of the jump is not reached by any other path.  For
4704 example, when CSE encounters an @code{if} statement with an
4705 @code{else} clause, CSE will follow the jump when the condition
4706 tested is false.
4707
4708 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4709
4710 @item -fcse-skip-blocks
4711 @opindex fcse-skip-blocks
4712 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4713 follow jumps which conditionally skip over blocks.  When CSE
4714 encounters a simple @code{if} statement with no else clause,
4715 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4716 body of the @code{if}.
4717
4718 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4719
4720 @item -frerun-cse-after-loop
4721 @opindex frerun-cse-after-loop
4722 Re-run common subexpression elimination after loop optimizations has been
4723 performed.
4724
4725 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4726
4727 @item -frerun-loop-opt
4728 @opindex frerun-loop-opt
4729 Run the loop optimizer twice.
4730
4731 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4732
4733 @item -fgcse
4734 @opindex fgcse
4735 Perform a global common subexpression elimination pass.
4736 This pass also performs global constant and copy propagation.
4737
4738 @emph{Note:} When compiling a program using computed gotos, a GCC
4739 extension, you may get better runtime performance if you disable
4740 the global common subexpression elimination pass by adding
4741 @option{-fno-gcse} to the command line.
4742
4743 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4744
4745 @item -fgcse-lm
4746 @opindex fgcse-lm
4747 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4748 attempt to move loads which are only killed by stores into themselves.  This
4749 allows a loop containing a load/store sequence to be changed to a load outside
4750 the loop, and a copy/store within the loop.
4751
4752 Enabled by default when gcse is enabled.
4753
4754 @item -fgcse-sm
4755 @opindex fgcse-sm
4756 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4757 global common subexpression elimination.  This pass will attempt to move
4758 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4759 loops containing a load/store sequence can be changed to a load before
4760 the loop and a store after the loop.
4761
4762 Not enabled at any optimization level.
4763
4764 @item -fgcse-las
4765 @opindex fgcse-las
4766 When @option{-fgcse-las} is enabled, the global common subexpression
4767 elimination pass eliminates redundant loads that come after stores to the
4768 same memory location (both partial and full redundancies).
4769
4770 Not enabled at any optimization level.
4771
4772 @item -fgcse-after-reload
4773 @opindex fgcse-after-reload
4774 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4775 pass is performed after reload.  The purpose of this pass is to cleanup
4776 redundant spilling.
4777
4778 @item -floop-optimize
4779 @opindex floop-optimize
4780 Perform loop optimizations: move constant expressions out of loops, simplify
4781 exit test conditions and optionally do strength-reduction as well.
4782
4783 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4784
4785 @item -floop-optimize2
4786 @opindex floop-optimize2
4787 Perform loop optimizations using the new loop optimizer.  The optimizations
4788 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4789 by separate flags.
4790
4791 @item -funsafe-loop-optimizations
4792 @opindex funsafe-loop-optimizations
4793 If given, the loop optimizer will assume that loop indices do not
4794 overflow, and that the loops with nontrivial exit condition are not
4795 infinite.  This enables a wider range of loop optimizations even if
4796 the loop optimizer itself cannot prove that these assumptions are valid.
4797 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4798 if it finds this kind of loop.
4799
4800 @item -fcrossjumping
4801 @opindex crossjumping
4802 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4803 resulting code may or may not perform better than without cross-jumping.
4804
4805 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4806
4807 @item -fif-conversion
4808 @opindex if-conversion
4809 Attempt to transform conditional jumps into branch-less equivalents.  This
4810 include use of conditional moves, min, max, set flags and abs instructions, and
4811 some tricks doable by standard arithmetics.  The use of conditional execution
4812 on chips where it is available is controlled by @code{if-conversion2}.
4813
4814 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4815
4816 @item -fif-conversion2
4817 @opindex if-conversion2
4818 Use conditional execution (where available) to transform conditional jumps into
4819 branch-less equivalents.
4820
4821 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4822
4823 @item -fdelete-null-pointer-checks
4824 @opindex fdelete-null-pointer-checks
4825 Use global dataflow analysis to identify and eliminate useless checks
4826 for null pointers.  The compiler assumes that dereferencing a null
4827 pointer would have halted the program.  If a pointer is checked after
4828 it has already been dereferenced, it cannot be null.
4829
4830 In some environments, this assumption is not true, and programs can
4831 safely dereference null pointers.  Use
4832 @option{-fno-delete-null-pointer-checks} to disable this optimization
4833 for programs which depend on that behavior.
4834
4835 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4836
4837 @item -fexpensive-optimizations
4838 @opindex fexpensive-optimizations
4839 Perform a number of minor optimizations that are relatively expensive.
4840
4841 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4842
4843 @item -foptimize-register-move
4844 @itemx -fregmove
4845 @opindex foptimize-register-move
4846 @opindex fregmove
4847 Attempt to reassign register numbers in move instructions and as
4848 operands of other simple instructions in order to maximize the amount of
4849 register tying.  This is especially helpful on machines with two-operand
4850 instructions.
4851
4852 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4853 optimization.
4854
4855 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4856
4857 @item -fdelayed-branch
4858 @opindex fdelayed-branch
4859 If supported for the target machine, attempt to reorder instructions
4860 to exploit instruction slots available after delayed branch
4861 instructions.
4862
4863 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4864
4865 @item -fschedule-insns
4866 @opindex fschedule-insns
4867 If supported for the target machine, attempt to reorder instructions to
4868 eliminate execution stalls due to required data being unavailable.  This
4869 helps machines that have slow floating point or memory load instructions
4870 by allowing other instructions to be issued until the result of the load
4871 or floating point instruction is required.
4872
4873 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4874
4875 @item -fschedule-insns2
4876 @opindex fschedule-insns2
4877 Similar to @option{-fschedule-insns}, but requests an additional pass of
4878 instruction scheduling after register allocation has been done.  This is
4879 especially useful on machines with a relatively small number of
4880 registers and where memory load instructions take more than one cycle.
4881
4882 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4883
4884 @item -fno-sched-interblock
4885 @opindex fno-sched-interblock
4886 Don't schedule instructions across basic blocks.  This is normally
4887 enabled by default when scheduling before register allocation, i.e.@:
4888 with @option{-fschedule-insns} or at @option{-O2} or higher.
4889
4890 @item -fno-sched-spec
4891 @opindex fno-sched-spec
4892 Don't allow speculative motion of non-load instructions.  This is normally
4893 enabled by default when scheduling before register allocation, i.e.@:
4894 with @option{-fschedule-insns} or at @option{-O2} or higher.
4895
4896 @item -fsched-spec-load
4897 @opindex fsched-spec-load
4898 Allow speculative motion of some load instructions.  This only makes
4899 sense when scheduling before register allocation, i.e.@: with
4900 @option{-fschedule-insns} or at @option{-O2} or higher.
4901
4902 @item -fsched-spec-load-dangerous
4903 @opindex fsched-spec-load-dangerous
4904 Allow speculative motion of more load instructions.  This only makes
4905 sense when scheduling before register allocation, i.e.@: with
4906 @option{-fschedule-insns} or at @option{-O2} or higher.
4907
4908 @item -fsched-stalled-insns=@var{n}
4909 @opindex fsched-stalled-insns
4910 Define how many insns (if any) can be moved prematurely from the queue
4911 of stalled insns into the ready list, during the second scheduling pass.
4912
4913 @item -fsched-stalled-insns-dep=@var{n}
4914 @opindex fsched-stalled-insns-dep
4915 Define how many insn groups (cycles) will be examined for a dependency
4916 on a stalled insn that is candidate for premature removal from the queue
4917 of stalled insns.  Has an effect only during the second scheduling pass,
4918 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4919
4920 @item -fsched2-use-superblocks
4921 @opindex fsched2-use-superblocks
4922 When scheduling after register allocation, do use superblock scheduling
4923 algorithm.  Superblock scheduling allows motion across basic block boundaries
4924 resulting on faster schedules.  This option is experimental, as not all machine
4925 descriptions used by GCC model the CPU closely enough to avoid unreliable
4926 results from the algorithm.
4927
4928 This only makes sense when scheduling after register allocation, i.e.@: with
4929 @option{-fschedule-insns2} or at @option{-O2} or higher.
4930
4931 @item -fsched2-use-traces
4932 @opindex fsched2-use-traces
4933 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4934 allocation and additionally perform code duplication in order to increase the
4935 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4936 trace formation.
4937
4938 This mode should produce faster but significantly longer programs.  Also
4939 without @option{-fbranch-probabilities} the traces constructed may not
4940 match the reality and hurt the performance.  This only makes
4941 sense when scheduling after register allocation, i.e.@: with
4942 @option{-fschedule-insns2} or at @option{-O2} or higher.
4943
4944 @item -freschedule-modulo-scheduled-loops
4945 @opindex fscheduling-in-modulo-scheduled-loops
4946 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4947 we may want to prevent the later scheduling passes from changing its schedule, we use this
4948 option to control that.
4949
4950 @item -fcaller-saves
4951 @opindex fcaller-saves
4952 Enable values to be allocated in registers that will be clobbered by
4953 function calls, by emitting extra instructions to save and restore the
4954 registers around such calls.  Such allocation is done only when it
4955 seems to result in better code than would otherwise be produced.
4956
4957 This option is always enabled by default on certain machines, usually
4958 those which have no call-preserved registers to use instead.
4959
4960 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4961
4962 @item -ftree-pre
4963 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4964 enabled by default at @option{-O2} and @option{-O3}.
4965
4966 @item -ftree-fre
4967 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4968 between FRE and PRE is that FRE only considers expressions
4969 that are computed on all paths leading to the redundant computation.
4970 This analysis faster than PRE, though it exposes fewer redundancies.
4971 This flag is enabled by default at @option{-O} and higher.
4972
4973 @item -ftree-copy-prop
4974 Perform copy propagation on trees.  This pass eliminates unnecessary
4975 copy operations.  This flag is enabled by default at @option{-O} and
4976 higher.
4977
4978 @item -ftree-store-copy-prop
4979 Perform copy propagation of memory loads and stores.  This pass
4980 eliminates unnecessary copy operations in memory references
4981 (structures, global variables, arrays, etc).  This flag is enabled by
4982 default at @option{-O2} and higher.
4983
4984 @item -ftree-salias
4985 Perform structural alias analysis on trees.  This flag
4986 is enabled by default at @option{-O} and higher.
4987
4988 @item -ftree-sink
4989 Perform forward store motion  on trees.  This flag is
4990 enabled by default at @option{-O} and higher.
4991
4992 @item -ftree-ccp
4993 Perform sparse conditional constant propagation (CCP) on trees.  This
4994 pass only operates on local scalar variables and is enabled by default
4995 at @option{-O} and higher.
4996
4997 @item -ftree-store-ccp
4998 Perform sparse conditional constant propagation (CCP) on trees.  This
4999 pass operates on both local scalar variables and memory stores and
5000 loads (global variables, structures, arrays, etc).  This flag is
5001 enabled by default at @option{-O2} and higher.
5002
5003 @item -ftree-dce
5004 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5005 default at @option{-O} and higher.
5006
5007 @item -ftree-dominator-opts
5008 Perform a variety of simple scalar cleanups (constant/copy
5009 propagation, redundancy elimination, range propagation and expression
5010 simplification) based on a dominator tree traversal.  This also
5011 performs jump threading (to reduce jumps to jumps). This flag is
5012 enabled by default at @option{-O} and higher.
5013
5014 @item -ftree-ch
5015 Perform loop header copying on trees.  This is beneficial since it increases
5016 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5017 is enabled by default at @option{-O} and higher.  It is not enabled
5018 for @option{-Os}, since it usually increases code size.
5019
5020 @item -ftree-loop-optimize
5021 Perform loop optimizations on trees.  This flag is enabled by default
5022 at @option{-O} and higher.
5023
5024 @item -ftree-loop-linear
5025 Perform linear loop transformations on tree.  This flag can improve cache
5026 performance and allow further loop optimizations to take place.
5027
5028 @item -ftree-loop-im
5029 Perform loop invariant motion on trees.  This pass moves only invariants that
5030 would be hard to handle at RTL level (function calls, operations that expand to
5031 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5032 operands of conditions that are invariant out of the loop, so that we can use
5033 just trivial invariantness analysis in loop unswitching.  The pass also includes
5034 store motion.
5035
5036 @item -ftree-loop-ivcanon
5037 Create a canonical counter for number of iterations in the loop for that
5038 determining number of iterations requires complicated analysis.  Later
5039 optimizations then may determine the number easily.  Useful especially
5040 in connection with unrolling.
5041
5042 @item -fivopts
5043 Perform induction variable optimizations (strength reduction, induction
5044 variable merging and induction variable elimination) on trees.
5045
5046 @item -ftree-sra
5047 Perform scalar replacement of aggregates.  This pass replaces structure
5048 references with scalars to prevent committing structures to memory too
5049 early.  This flag is enabled by default at @option{-O} and higher.
5050
5051 @item -ftree-copyrename
5052 Perform copy renaming on trees.  This pass attempts to rename compiler
5053 temporaries to other variables at copy locations, usually resulting in
5054 variable names which more closely resemble the original variables.  This flag
5055 is enabled by default at @option{-O} and higher.
5056
5057 @item -ftree-ter
5058 Perform temporary expression replacement during the SSA->normal phase.  Single
5059 use/single def temporaries are replaced at their use location with their
5060 defining expression.  This results in non-GIMPLE code, but gives the expanders
5061 much more complex trees to work on resulting in better RTL generation.  This is
5062 enabled by default at @option{-O} and higher.
5063
5064 @item -ftree-lrs
5065 Perform live range splitting during the SSA->normal phase.  Distinct live
5066 ranges of a variable are split into unique variables, allowing for better
5067 optimization later.  This is enabled by default at @option{-O} and higher.
5068
5069 @item -ftree-vectorize
5070 Perform loop vectorization on trees.
5071
5072 @item -ftree-vect-loop-version
5073 @opindex ftree-vect-loop-version
5074 Perform loop versioning when doing loop vectorization on trees.  When a loop
5075 appears to be vectorizable except that data alignment or data dependence cannot
5076 be determined at compile time then vectorized and non-vectorized versions of
5077 the loop are generated along with runtime checks for alignment or dependence
5078 to control which version is executed.  This option is enabled by default
5079 except at level @option{-Os} where it is disabled.
5080
5081 @item -ftree-vrp
5082 Perform Value Range Propagation on trees.  This is similar to the
5083 constant propagation pass, but instead of values, ranges of values are
5084 propagated.  This allows the optimizers to remove unnecessary range
5085 checks like array bound checks and null pointer checks.  This is
5086 enabled by default at @option{-O2} and higher.  Null pointer check
5087 elimination is only done if @option{-fdelete-null-pointer-checks} is
5088 enabled.
5089
5090 @item -ftracer
5091 @opindex ftracer
5092 Perform tail duplication to enlarge superblock size.  This transformation
5093 simplifies the control flow of the function allowing other optimizations to do
5094 better job.
5095
5096 @item -funroll-loops
5097 @opindex funroll-loops
5098 Unroll loops whose number of iterations can be determined at compile
5099 time or upon entry to the loop.  @option{-funroll-loops} implies both
5100 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5101 option makes code larger, and may or may not make it run faster.
5102
5103 @item -funroll-all-loops
5104 @opindex funroll-all-loops
5105 Unroll all loops, even if their number of iterations is uncertain when
5106 the loop is entered.  This usually makes programs run more slowly.
5107 @option{-funroll-all-loops} implies the same options as
5108 @option{-funroll-loops},
5109
5110 @item -fsplit-ivs-in-unroller
5111 @opindex -fsplit-ivs-in-unroller
5112 Enables expressing of values of induction variables in later iterations
5113 of the unrolled loop using the value in the first iteration.  This breaks
5114 long dependency chains, thus improving efficiency of the scheduling passes.
5115
5116 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5117 same effect.  However in cases the loop body is more complicated than
5118 a single basic block, this is not reliable.  It also does not work at all
5119 on some of the architectures due to restrictions in the CSE pass.
5120
5121 This optimization is enabled by default.
5122
5123 @item -fvariable-expansion-in-unroller
5124 @opindex -fvariable-expansion-in-unroller
5125 With this option, the compiler will create multiple copies of some
5126 local variables when unrolling a loop which can result in superior code.
5127
5128 @item -fprefetch-loop-arrays
5129 @opindex fprefetch-loop-arrays
5130 If supported by the target machine, generate instructions to prefetch
5131 memory to improve the performance of loops that access large arrays.
5132
5133 These options may generate better or worse code; results are highly
5134 dependent on the structure of loops within the source code.
5135
5136 @item -fno-peephole
5137 @itemx -fno-peephole2
5138 @opindex fno-peephole
5139 @opindex fno-peephole2
5140 Disable any machine-specific peephole optimizations.  The difference
5141 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5142 are implemented in the compiler; some targets use one, some use the
5143 other, a few use both.
5144
5145 @option{-fpeephole} is enabled by default.
5146 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5147
5148 @item -fno-guess-branch-probability
5149 @opindex fno-guess-branch-probability
5150 Do not guess branch probabilities using heuristics.
5151
5152 GCC will use heuristics to guess branch probabilities if they are
5153 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5154 heuristics are based on the control flow graph.  If some branch probabilities
5155 are specified by @samp{__builtin_expect}, then the heuristics will be
5156 used to guess branch probabilities for the rest of the control flow graph,
5157 taking the @samp{__builtin_expect} info into account.  The interactions
5158 between the heuristics and @samp{__builtin_expect} can be complex, and in
5159 some cases, it may be useful to disable the heuristics so that the effects
5160 of @samp{__builtin_expect} are easier to understand.
5161
5162 The default is @option{-fguess-branch-probability} at levels
5163 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5164
5165 @item -freorder-blocks
5166 @opindex freorder-blocks
5167 Reorder basic blocks in the compiled function in order to reduce number of
5168 taken branches and improve code locality.
5169
5170 Enabled at levels @option{-O2}, @option{-O3}.
5171
5172 @item -freorder-blocks-and-partition
5173 @opindex freorder-blocks-and-partition
5174 In addition to reordering basic blocks in the compiled function, in order
5175 to reduce number of taken branches, partitions hot and cold basic blocks
5176 into separate sections of the assembly and .o files, to improve
5177 paging and cache locality performance.
5178
5179 This optimization is automatically turned off in the presence of
5180 exception handling, for linkonce sections, for functions with a user-defined
5181 section attribute and on any architecture that does not support named
5182 sections.
5183
5184 @item -freorder-functions
5185 @opindex freorder-functions
5186 Reorder functions in the object file in order to
5187 improve code locality.  This is implemented by using special
5188 subsections @code{.text.hot} for most frequently executed functions and
5189 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5190 the linker so object file format must support named sections and linker must
5191 place them in a reasonable way.
5192
5193 Also profile feedback must be available in to make this option effective.  See
5194 @option{-fprofile-arcs} for details.
5195
5196 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5197
5198 @item -fstrict-aliasing
5199 @opindex fstrict-aliasing
5200 Allows the compiler to assume the strictest aliasing rules applicable to
5201 the language being compiled.  For C (and C++), this activates
5202 optimizations based on the type of expressions.  In particular, an
5203 object of one type is assumed never to reside at the same address as an
5204 object of a different type, unless the types are almost the same.  For
5205 example, an @code{unsigned int} can alias an @code{int}, but not a
5206 @code{void*} or a @code{double}.  A character type may alias any other
5207 type.
5208
5209 Pay special attention to code like this:
5210 @smallexample
5211 union a_union @{
5212   int i;
5213   double d;
5214 @};
5215
5216 int f() @{
5217   a_union t;
5218   t.d = 3.0;
5219   return t.i;
5220 @}
5221 @end smallexample
5222 The practice of reading from a different union member than the one most
5223 recently written to (called ``type-punning'') is common.  Even with
5224 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5225 is accessed through the union type.  So, the code above will work as
5226 expected.  However, this code might not:
5227 @smallexample
5228 int f() @{
5229   a_union t;
5230   int* ip;
5231   t.d = 3.0;
5232   ip = &t.i;
5233   return *ip;
5234 @}
5235 @end smallexample
5236
5237 Every language that wishes to perform language-specific alias analysis
5238 should define a function that computes, given an @code{tree}
5239 node, an alias set for the node.  Nodes in different alias sets are not
5240 allowed to alias.  For an example, see the C front-end function
5241 @code{c_get_alias_set}.
5242
5243 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5244
5245 @item -falign-functions
5246 @itemx -falign-functions=@var{n}
5247 @opindex falign-functions
5248 Align the start of functions to the next power-of-two greater than
5249 @var{n}, skipping up to @var{n} bytes.  For instance,
5250 @option{-falign-functions=32} aligns functions to the next 32-byte
5251 boundary, but @option{-falign-functions=24} would align to the next
5252 32-byte boundary only if this can be done by skipping 23 bytes or less.
5253
5254 @option{-fno-align-functions} and @option{-falign-functions=1} are
5255 equivalent and mean that functions will not be aligned.
5256
5257 Some assemblers only support this flag when @var{n} is a power of two;
5258 in that case, it is rounded up.
5259
5260 If @var{n} is not specified or is zero, use a machine-dependent default.
5261
5262 Enabled at levels @option{-O2}, @option{-O3}.
5263
5264 @item -falign-labels
5265 @itemx -falign-labels=@var{n}
5266 @opindex falign-labels
5267 Align all branch targets to a power-of-two boundary, skipping up to
5268 @var{n} bytes like @option{-falign-functions}.  This option can easily
5269 make code slower, because it must insert dummy operations for when the
5270 branch target is reached in the usual flow of the code.
5271
5272 @option{-fno-align-labels} and @option{-falign-labels=1} are
5273 equivalent and mean that labels will not be aligned.
5274
5275 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5276 are greater than this value, then their values are used instead.
5277
5278 If @var{n} is not specified or is zero, use a machine-dependent default
5279 which is very likely to be @samp{1}, meaning no alignment.
5280
5281 Enabled at levels @option{-O2}, @option{-O3}.
5282
5283 @item -falign-loops
5284 @itemx -falign-loops=@var{n}
5285 @opindex falign-loops
5286 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5287 like @option{-falign-functions}.  The hope is that the loop will be
5288 executed many times, which will make up for any execution of the dummy
5289 operations.
5290
5291 @option{-fno-align-loops} and @option{-falign-loops=1} are
5292 equivalent and mean that loops will not be aligned.
5293
5294 If @var{n} is not specified or is zero, use a machine-dependent default.
5295
5296 Enabled at levels @option{-O2}, @option{-O3}.
5297
5298 @item -falign-jumps
5299 @itemx -falign-jumps=@var{n}
5300 @opindex falign-jumps
5301 Align branch targets to a power-of-two boundary, for branch targets
5302 where the targets can only be reached by jumping, skipping up to @var{n}
5303 bytes like @option{-falign-functions}.  In this case, no dummy operations
5304 need be executed.
5305
5306 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5307 equivalent and mean that loops will not be aligned.
5308
5309 If @var{n} is not specified or is zero, use a machine-dependent default.
5310
5311 Enabled at levels @option{-O2}, @option{-O3}.
5312
5313 @item -funit-at-a-time
5314 @opindex funit-at-a-time
5315 Parse the whole compilation unit before starting to produce code.
5316 This allows some extra optimizations to take place but consumes
5317 more memory (in general).  There are some compatibility issues
5318 with @emph{unit-at-at-time} mode:
5319 @itemize @bullet
5320 @item
5321 enabling @emph{unit-at-a-time} mode may change the order
5322 in which functions, variables, and top-level @code{asm} statements
5323 are emitted, and will likely break code relying on some particular
5324 ordering.  The majority of such top-level @code{asm} statements,
5325 though, can be replaced by @code{section} attributes.
5326
5327 @item
5328 @emph{unit-at-a-time} mode removes unreferenced static variables
5329 and functions.  This may result in undefined references
5330 when an @code{asm} statement refers directly to variables or functions
5331 that are otherwise unused.  In that case either the variable/function
5332 shall be listed as an operand of the @code{asm} statement operand or,
5333 in the case of top-level @code{asm} statements the attribute @code{used}
5334 shall be used on the declaration.
5335
5336 @item
5337 Static functions now can use non-standard passing conventions that
5338 may break @code{asm} statements calling functions directly.  Again,
5339 attribute @code{used} will prevent this behavior.
5340 @end itemize
5341
5342 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5343 but this scheme may not be supported by future releases of GCC@.
5344
5345 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5346
5347 @item -fweb
5348 @opindex fweb
5349 Constructs webs as commonly used for register allocation purposes and assign
5350 each web individual pseudo register.  This allows the register allocation pass
5351 to operate on pseudos directly, but also strengthens several other optimization
5352 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5353 however, make debugging impossible, since variables will no longer stay in a
5354 ``home register''.
5355
5356 Enabled by default with @option{-funroll-loops}.
5357
5358 @item -fwhole-program
5359 @opindex fwhole-program
5360 Assume that the current compilation unit represents whole program being
5361 compiled.  All public functions and variables with the exception of @code{main}
5362 and those merged by attribute @code{externally_visible} become static functions
5363 and in a affect gets more aggressively optimized by interprocedural optimizers.
5364 While this option is equivalent to proper use of @code{static} keyword for
5365 programs consisting of single file, in combination with option
5366 @option{--combine} this flag can be used to compile most of smaller scale C
5367 programs since the functions and variables become local for the whole combined
5368 compilation unit, not for the single source file itself.
5369
5370
5371 @item -fno-cprop-registers
5372 @opindex fno-cprop-registers
5373 After register allocation and post-register allocation instruction splitting,
5374 we perform a copy-propagation pass to try to reduce scheduling dependencies
5375 and occasionally eliminate the copy.
5376
5377 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5378
5379 @item -fprofile-generate
5380 @opindex fprofile-generate
5381
5382 Enable options usually used for instrumenting application to produce
5383 profile useful for later recompilation with profile feedback based
5384 optimization.  You must use @option{-fprofile-generate} both when
5385 compiling and when linking your program.
5386
5387 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5388
5389 @item -fprofile-use
5390 @opindex fprofile-use
5391 Enable profile feedback directed optimizations, and optimizations
5392 generally profitable only with profile feedback available.
5393
5394 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5395 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5396 @code{-fno-loop-optimize}.
5397
5398 @end table
5399
5400 The following options control compiler behavior regarding floating
5401 point arithmetic.  These options trade off between speed and
5402 correctness.  All must be specifically enabled.
5403
5404 @table @gcctabopt
5405 @item -ffloat-store
5406 @opindex ffloat-store
5407 Do not store floating point variables in registers, and inhibit other
5408 options that might change whether a floating point value is taken from a
5409 register or memory.
5410
5411 @cindex floating point precision
5412 This option prevents undesirable excess precision on machines such as
5413 the 68000 where the floating registers (of the 68881) keep more
5414 precision than a @code{double} is supposed to have.  Similarly for the
5415 x86 architecture.  For most programs, the excess precision does only
5416 good, but a few programs rely on the precise definition of IEEE floating
5417 point.  Use @option{-ffloat-store} for such programs, after modifying
5418 them to store all pertinent intermediate computations into variables.
5419
5420 @item -ffast-math
5421 @opindex ffast-math
5422 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5423 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5424 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5425 and @option{fcx-limited-range}.
5426
5427 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5428
5429 This option should never be turned on by any @option{-O} option since
5430 it can result in incorrect output for programs which depend on
5431 an exact implementation of IEEE or ISO rules/specifications for
5432 math functions.
5433
5434 @item -fno-math-errno
5435 @opindex fno-math-errno
5436 Do not set ERRNO after calling math functions that are executed
5437 with a single instruction, e.g., sqrt.  A program that relies on
5438 IEEE exceptions for math error handling may want to use this flag
5439 for speed while maintaining IEEE arithmetic compatibility.
5440
5441 This option should never be turned on by any @option{-O} option since
5442 it can result in incorrect output for programs which depend on
5443 an exact implementation of IEEE or ISO rules/specifications for
5444 math functions.
5445
5446 The default is @option{-fmath-errno}.
5447
5448 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5449 no reason for the compiler to consider the possibility that it might,
5450 and @option{-fno-math-errno} is the default.
5451
5452 @item -funsafe-math-optimizations
5453 @opindex funsafe-math-optimizations
5454 Allow optimizations for floating-point arithmetic that (a) assume
5455 that arguments and results are valid and (b) may violate IEEE or
5456 ANSI standards.  When used at link-time, it may include libraries
5457 or startup files that change the default FPU control word or other
5458 similar optimizations.
5459
5460 This option should never be turned on by any @option{-O} option since
5461 it can result in incorrect output for programs which depend on
5462 an exact implementation of IEEE or ISO rules/specifications for
5463 math functions.
5464
5465 The default is @option{-fno-unsafe-math-optimizations}.
5466
5467 @item -ffinite-math-only
5468 @opindex ffinite-math-only
5469 Allow optimizations for floating-point arithmetic that assume
5470 that arguments and results are not NaNs or +-Infs.
5471
5472 This option should never be turned on by any @option{-O} option since
5473 it can result in incorrect output for programs which depend on
5474 an exact implementation of IEEE or ISO rules/specifications.
5475
5476 The default is @option{-fno-finite-math-only}.
5477
5478 @item -fno-trapping-math
5479 @opindex fno-trapping-math
5480 Compile code assuming that floating-point operations cannot generate
5481 user-visible traps.  These traps include division by zero, overflow,
5482 underflow, inexact result and invalid operation.  This option implies
5483 @option{-fno-signaling-nans}.  Setting this option may allow faster
5484 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5485
5486 This option should never be turned on by any @option{-O} option since
5487 it can result in incorrect output for programs which depend on
5488 an exact implementation of IEEE or ISO rules/specifications for
5489 math functions.
5490
5491 The default is @option{-ftrapping-math}.
5492
5493 @item -frounding-math
5494 @opindex frounding-math
5495 Disable transformations and optimizations that assume default floating
5496 point rounding behavior.  This is round-to-zero for all floating point
5497 to integer conversions, and round-to-nearest for all other arithmetic
5498 truncations.  This option should be specified for programs that change
5499 the FP rounding mode dynamically, or that may be executed with a
5500 non-default rounding mode.  This option disables constant folding of
5501 floating point expressions at compile-time (which may be affected by
5502 rounding mode) and arithmetic transformations that are unsafe in the
5503 presence of sign-dependent rounding modes.
5504
5505 The default is @option{-fno-rounding-math}.
5506
5507 This option is experimental and does not currently guarantee to
5508 disable all GCC optimizations that are affected by rounding mode.
5509 Future versions of GCC may provide finer control of this setting
5510 using C99's @code{FENV_ACCESS} pragma.  This command line option
5511 will be used to specify the default state for @code{FENV_ACCESS}.
5512
5513 @item -fsignaling-nans
5514 @opindex fsignaling-nans
5515 Compile code assuming that IEEE signaling NaNs may generate user-visible
5516 traps during floating-point operations.  Setting this option disables
5517 optimizations that may change the number of exceptions visible with
5518 signaling NaNs.  This option implies @option{-ftrapping-math}.
5519
5520 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5521 be defined.
5522
5523 The default is @option{-fno-signaling-nans}.
5524
5525 This option is experimental and does not currently guarantee to
5526 disable all GCC optimizations that affect signaling NaN behavior.
5527
5528 @item -fsingle-precision-constant
5529 @opindex fsingle-precision-constant
5530 Treat floating point constant as single precision constant instead of
5531 implicitly converting it to double precision constant.
5532
5533 @item -fcx-limited-range
5534 @itemx -fno-cx-limited-range
5535 @opindex fcx-limited-range
5536 @opindex fno-cx-limited-range
5537 When enabled, this option states that a range reduction step is not
5538 needed when performing complex division.  The default is
5539 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5540
5541 This option controls the default setting of the ISO C99 
5542 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5543 all languages.
5544
5545 @end table
5546
5547 The following options control optimizations that may improve
5548 performance, but are not enabled by any @option{-O} options.  This
5549 section includes experimental options that may produce broken code.
5550
5551 @table @gcctabopt
5552 @item -fbranch-probabilities
5553 @opindex fbranch-probabilities
5554 After running a program compiled with @option{-fprofile-arcs}
5555 (@pxref{Debugging Options,, Options for Debugging Your Program or
5556 @command{gcc}}), you can compile it a second time using
5557 @option{-fbranch-probabilities}, to improve optimizations based on
5558 the number of times each branch was taken.  When the program
5559 compiled with @option{-fprofile-arcs} exits it saves arc execution
5560 counts to a file called @file{@var{sourcename}.gcda} for each source
5561 file  The information in this data file is very dependent on the
5562 structure of the generated code, so you must use the same source code
5563 and the same optimization options for both compilations.
5564
5565 With @option{-fbranch-probabilities}, GCC puts a
5566 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5567 These can be used to improve optimization.  Currently, they are only
5568 used in one place: in @file{reorg.c}, instead of guessing which path a
5569 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5570 exactly determine which path is taken more often.
5571
5572 @item -fprofile-values
5573 @opindex fprofile-values
5574 If combined with @option{-fprofile-arcs}, it adds code so that some
5575 data about values of expressions in the program is gathered.
5576
5577 With @option{-fbranch-probabilities}, it reads back the data gathered
5578 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5579 notes to instructions for their later usage in optimizations.
5580
5581 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5582
5583 @item -fvpt
5584 @opindex fvpt
5585 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5586 a code to gather information about values of expressions.
5587
5588 With @option{-fbranch-probabilities}, it reads back the data gathered
5589 and actually performs the optimizations based on them.
5590 Currently the optimizations include specialization of division operation
5591 using the knowledge about the value of the denominator.
5592
5593 @item -frename-registers
5594 @opindex frename-registers
5595 Attempt to avoid false dependencies in scheduled code by making use
5596 of registers left over after register allocation.  This optimization
5597 will most benefit processors with lots of registers.  Depending on the
5598 debug information format adopted by the target, however, it can
5599 make debugging impossible, since variables will no longer stay in
5600 a ``home register''.
5601
5602 Enabled by default with @option{-funroll-loops}.
5603
5604 @item -ftracer
5605 @opindex ftracer
5606 Perform tail duplication to enlarge superblock size.  This transformation
5607 simplifies the control flow of the function allowing other optimizations to do
5608 better job.
5609
5610 Enabled with @option{-fprofile-use}.
5611
5612 @item -funroll-loops
5613 @opindex funroll-loops
5614 Unroll loops whose number of iterations can be determined at compile time or
5615 upon entry to the loop.  @option{-funroll-loops} implies
5616 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5617 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5618 small constant number of iterations).  This option makes code larger, and may
5619 or may not make it run faster.
5620
5621 Enabled with @option{-fprofile-use}.
5622
5623 @item -funroll-all-loops
5624 @opindex funroll-all-loops
5625 Unroll all loops, even if their number of iterations is uncertain when
5626 the loop is entered.  This usually makes programs run more slowly.
5627 @option{-funroll-all-loops} implies the same options as
5628 @option{-funroll-loops}.
5629
5630 @item -fpeel-loops
5631 @opindex fpeel-loops
5632 Peels the loops for that there is enough information that they do not
5633 roll much (from profile feedback).  It also turns on complete loop peeling
5634 (i.e.@: complete removal of loops with small constant number of iterations).
5635
5636 Enabled with @option{-fprofile-use}.
5637
5638 @item -fmove-loop-invariants
5639 @opindex fmove-loop-invariants
5640 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5641 at level @option{-O1}
5642
5643 @item -funswitch-loops
5644 @opindex funswitch-loops
5645 Move branches with loop invariant conditions out of the loop, with duplicates
5646 of the loop on both branches (modified according to result of the condition).
5647
5648 @item -fprefetch-loop-arrays
5649 @opindex fprefetch-loop-arrays
5650 If supported by the target machine, generate instructions to prefetch
5651 memory to improve the performance of loops that access large arrays.
5652
5653 Disabled at level @option{-Os}.
5654
5655 @item -ffunction-sections
5656 @itemx -fdata-sections
5657 @opindex ffunction-sections
5658 @opindex fdata-sections
5659 Place each function or data item into its own section in the output
5660 file if the target supports arbitrary sections.  The name of the
5661 function or the name of the data item determines the section's name
5662 in the output file.
5663
5664 Use these options on systems where the linker can perform optimizations
5665 to improve locality of reference in the instruction space.  Most systems
5666 using the ELF object format and SPARC processors running Solaris 2 have
5667 linkers with such optimizations.  AIX may have these optimizations in
5668 the future.
5669
5670 Only use these options when there are significant benefits from doing
5671 so.  When you specify these options, the assembler and linker will
5672 create larger object and executable files and will also be slower.
5673 You will not be able to use @code{gprof} on all systems if you
5674 specify this option and you may have problems with debugging if
5675 you specify both this option and @option{-g}.
5676
5677 @item -fbranch-target-load-optimize
5678 @opindex fbranch-target-load-optimize
5679 Perform branch target register load optimization before prologue / epilogue
5680 threading.
5681 The use of target registers can typically be exposed only during reload,
5682 thus hoisting loads out of loops and doing inter-block scheduling needs
5683 a separate optimization pass.
5684
5685 @item -fbranch-target-load-optimize2
5686 @opindex fbranch-target-load-optimize2
5687 Perform branch target register load optimization after prologue / epilogue
5688 threading.
5689
5690 @item -fbtr-bb-exclusive
5691 @opindex fbtr-bb-exclusive
5692 When performing branch target register load optimization, don't reuse
5693 branch target registers in within any basic block.
5694
5695 @item -fstack-protector
5696 Emit extra code to check for buffer overflows, such as stack smashing
5697 attacks.  This is done by adding a guard variable to functions with
5698 vulnerable objects.  This includes functions that call alloca, and
5699 functions with buffers larger than 8 bytes.  The guards are initialized
5700 when a function is entered and then checked when the function exits.
5701 If a guard check fails, an error message is printed and the program exits.
5702
5703 @item -fstack-protector-all
5704 Like @option{-fstack-protector} except that all functions are protected.
5705
5706 @item --param @var{name}=@var{value}
5707 @opindex param
5708 In some places, GCC uses various constants to control the amount of
5709 optimization that is done.  For example, GCC will not inline functions
5710 that contain more that a certain number of instructions.  You can
5711 control some of these constants on the command-line using the
5712 @option{--param} option.
5713
5714 The names of specific parameters, and the meaning of the values, are
5715 tied to the internals of the compiler, and are subject to change
5716 without notice in future releases.
5717
5718 In each case, the @var{value} is an integer.  The allowable choices for
5719 @var{name} are given in the following table:
5720
5721 @table @gcctabopt
5722 @item salias-max-implicit-fields
5723 The maximum number of fields in a variable without direct
5724 structure accesses for which structure aliasing will consider trying 
5725 to track each field.  The default is 5
5726
5727 @item sra-max-structure-size
5728 The maximum structure size, in bytes, at which the scalar replacement
5729 of aggregates (SRA) optimization will perform block copies.  The
5730 default value, 0, implies that GCC will select the most appropriate
5731 size itself.
5732
5733 @item sra-field-structure-ratio
5734 The threshold ratio (as a percentage) between instantiated fields and
5735 the complete structure size.  We say that if the ratio of the number
5736 of bytes in instantiated fields to the number of bytes in the complete
5737 structure exceeds this parameter, then block copies are not used.  The
5738 default is 75.
5739
5740 @item max-crossjump-edges
5741 The maximum number of incoming edges to consider for crossjumping.
5742 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5743 the number of edges incoming to each block.  Increasing values mean
5744 more aggressive optimization, making the compile time increase with
5745 probably small improvement in executable size.
5746
5747 @item min-crossjump-insns
5748 The minimum number of instructions which must be matched at the end
5749 of two blocks before crossjumping will be performed on them.  This
5750 value is ignored in the case where all instructions in the block being
5751 crossjumped from are matched.  The default value is 5.
5752
5753 @item max-grow-copy-bb-insns
5754 The maximum code size expansion factor when copying basic blocks
5755 instead of jumping.  The expansion is relative to a jump instruction.
5756 The default value is 8.
5757
5758 @item max-goto-duplication-insns
5759 The maximum number of instructions to duplicate to a block that jumps
5760 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5761 passes, GCC factors computed gotos early in the compilation process,
5762 and unfactors them as late as possible.  Only computed jumps at the
5763 end of a basic blocks with no more than max-goto-duplication-insns are
5764 unfactored.  The default value is 8.
5765
5766 @item max-delay-slot-insn-search
5767 The maximum number of instructions to consider when looking for an
5768 instruction to fill a delay slot.  If more than this arbitrary number of
5769 instructions is searched, the time savings from filling the delay slot
5770 will be minimal so stop searching.  Increasing values mean more
5771 aggressive optimization, making the compile time increase with probably
5772 small improvement in executable run time.
5773
5774 @item max-delay-slot-live-search
5775 When trying to fill delay slots, the maximum number of instructions to
5776 consider when searching for a block with valid live register
5777 information.  Increasing this arbitrarily chosen value means more
5778 aggressive optimization, increasing the compile time.  This parameter
5779 should be removed when the delay slot code is rewritten to maintain the
5780 control-flow graph.
5781
5782 @item max-gcse-memory
5783 The approximate maximum amount of memory that will be allocated in
5784 order to perform the global common subexpression elimination
5785 optimization.  If more memory than specified is required, the
5786 optimization will not be done.
5787
5788 @item max-gcse-passes
5789 The maximum number of passes of GCSE to run.  The default is 1.
5790
5791 @item max-pending-list-length
5792 The maximum number of pending dependencies scheduling will allow
5793 before flushing the current state and starting over.  Large functions
5794 with few branches or calls can create excessively large lists which
5795 needlessly consume memory and resources.
5796
5797 @item max-inline-insns-single
5798 Several parameters control the tree inliner used in gcc.
5799 This number sets the maximum number of instructions (counted in GCC's
5800 internal representation) in a single function that the tree inliner
5801 will consider for inlining.  This only affects functions declared
5802 inline and methods implemented in a class declaration (C++).
5803 The default value is 450.
5804
5805 @item max-inline-insns-auto
5806 When you use @option{-finline-functions} (included in @option{-O3}),
5807 a lot of functions that would otherwise not be considered for inlining
5808 by the compiler will be investigated.  To those functions, a different
5809 (more restrictive) limit compared to functions declared inline can
5810 be applied.
5811 The default value is 90.
5812
5813 @item large-function-insns
5814 The limit specifying really large functions.  For functions larger than this
5815 limit after inlining inlining is constrained by
5816 @option{--param large-function-growth}.  This parameter is useful primarily
5817 to avoid extreme compilation time caused by non-linear algorithms used by the
5818 backend.
5819 This parameter is ignored when @option{-funit-at-a-time} is not used.
5820 The default value is 2700.
5821
5822 @item large-function-growth
5823 Specifies maximal growth of large function caused by inlining in percents.
5824 This parameter is ignored when @option{-funit-at-a-time} is not used.
5825 The default value is 100 which limits large function growth to 2.0 times
5826 the original size.
5827
5828 @item large-unit-insns
5829 The limit specifying large translation unit.  Growth caused by inlining of
5830 units larger than this limit is limited by @option{--param inline-unit-growth}.
5831 For small units this might be too tight (consider unit consisting of function A
5832 that is inline and B that just calls A three time.  If B is small relative to
5833 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5834 large units consisting of small inlininable functions however the overall unit
5835 growth limit is needed to avoid exponential explosion of code size.  Thus for
5836 smaller units, the size is increased to @option{--param large-unit-insns}
5837 before aplying @option{--param inline-unit-growth}.  The default is 10000
5838
5839 @item inline-unit-growth
5840 Specifies maximal overall growth of the compilation unit caused by inlining.
5841 This parameter is ignored when @option{-funit-at-a-time} is not used.
5842 The default value is 50 which limits unit growth to 1.5 times the original
5843 size.
5844
5845 @item max-inline-insns-recursive
5846 @itemx max-inline-insns-recursive-auto
5847 Specifies maximum number of instructions out-of-line copy of self recursive inline
5848 function can grow into by performing recursive inlining.
5849
5850 For functions declared inline @option{--param max-inline-insns-recursive} is
5851 taken into account.  For function not declared inline, recursive inlining
5852 happens only when @option{-finline-functions} (included in @option{-O3}) is
5853 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5854 default value is 450.
5855
5856 @item max-inline-recursive-depth
5857 @itemx max-inline-recursive-depth-auto
5858 Specifies maximum recursion depth used by the recursive inlining.
5859
5860 For functions declared inline @option{--param max-inline-recursive-depth} is
5861 taken into account.  For function not declared inline, recursive inlining
5862 happens only when @option{-finline-functions} (included in @option{-O3}) is
5863 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5864 default value is 450.
5865
5866 @item min-inline-recursive-probability
5867 Recursive inlining is profitable only for function having deep recursion
5868 in average and can hurt for function having little recursion depth by
5869 increasing the prologue size or complexity of function body to other
5870 optimizers.
5871
5872 When profile feedback is available (see @option{-fprofile-generate}) the actual
5873 recursion depth can be guessed from probability that function will recurse via
5874 given call expression.  This parameter limits inlining only to call expression
5875 whose probability exceeds given threshold (in percents).  The default value is
5876 10.
5877
5878 @item inline-call-cost
5879 Specify cost of call instruction relative to simple arithmetics operations
5880 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5881 functions and at the same time increases size of leaf function that is believed to
5882 reduce function size by being inlined.  In effect it increases amount of
5883 inlining for code having large abstraction penalty (many functions that just
5884 pass the arguments to other functions) and decrease inlining for code with low
5885 abstraction penalty.  The default value is 16.
5886
5887 @item max-unrolled-insns
5888 The maximum number of instructions that a loop should have if that loop
5889 is unrolled, and if the loop is unrolled, it determines how many times
5890 the loop code is unrolled.
5891
5892 @item max-average-unrolled-insns
5893 The maximum number of instructions biased by probabilities of their execution
5894 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5895 it determines how many times the loop code is unrolled.
5896
5897 @item max-unroll-times
5898 The maximum number of unrollings of a single loop.
5899
5900 @item max-peeled-insns
5901 The maximum number of instructions that a loop should have if that loop
5902 is peeled, and if the loop is peeled, it determines how many times
5903 the loop code is peeled.
5904
5905 @item max-peel-times
5906 The maximum number of peelings of a single loop.
5907
5908 @item max-completely-peeled-insns
5909 The maximum number of insns of a completely peeled loop.
5910
5911 @item max-completely-peel-times
5912 The maximum number of iterations of a loop to be suitable for complete peeling.
5913
5914 @item max-unswitch-insns
5915 The maximum number of insns of an unswitched loop.
5916
5917 @item max-unswitch-level
5918 The maximum number of branches unswitched in a single loop.
5919
5920 @item lim-expensive
5921 The minimum cost of an expensive expression in the loop invariant motion.
5922
5923 @item iv-consider-all-candidates-bound
5924 Bound on number of candidates for induction variables below that
5925 all candidates are considered for each use in induction variable
5926 optimizations.  Only the most relevant candidates are considered
5927 if there are more candidates, to avoid quadratic time complexity.
5928
5929 @item iv-max-considered-uses
5930 The induction variable optimizations give up on loops that contain more
5931 induction variable uses.
5932
5933 @item iv-always-prune-cand-set-bound
5934 If number of candidates in the set is smaller than this value,
5935 we always try to remove unnecessary ivs from the set during its
5936 optimization when a new iv is added to the set.
5937
5938 @item scev-max-expr-size
5939 Bound on size of expressions used in the scalar evolutions analyzer.
5940 Large expressions slow the analyzer.
5941
5942 @item vect-max-version-checks
5943 The maximum number of runtime checks that can be performed when doing
5944 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5945 for more information.
5946
5947 @item max-iterations-to-track
5948
5949 The maximum number of iterations of a loop the brute force algorithm
5950 for analysis of # of iterations of the loop tries to evaluate.
5951
5952 @item hot-bb-count-fraction
5953 Select fraction of the maximal count of repetitions of basic block in program
5954 given basic block needs to have to be considered hot.
5955
5956 @item hot-bb-frequency-fraction
5957 Select fraction of the maximal frequency of executions of basic block in
5958 function given basic block needs to have to be considered hot
5959
5960 @item max-predicted-iterations
5961 The maximum number of loop iterations we predict statically.  This is useful
5962 in cases where function contain single loop with known bound and other loop
5963 with unknown.  We predict the known number of iterations correctly, while
5964 the unknown number of iterations average to roughly 10.  This means that the
5965 loop without bounds would appear artificially cold relative to the other one.
5966
5967 @item tracer-dynamic-coverage
5968 @itemx tracer-dynamic-coverage-feedback
5969
5970 This value is used to limit superblock formation once the given percentage of
5971 executed instructions is covered.  This limits unnecessary code size
5972 expansion.
5973
5974 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5975 feedback is available.  The real profiles (as opposed to statically estimated
5976 ones) are much less balanced allowing the threshold to be larger value.
5977
5978 @item tracer-max-code-growth
5979 Stop tail duplication once code growth has reached given percentage.  This is
5980 rather hokey argument, as most of the duplicates will be eliminated later in
5981 cross jumping, so it may be set to much higher values than is the desired code
5982 growth.
5983
5984 @item tracer-min-branch-ratio
5985
5986 Stop reverse growth when the reverse probability of best edge is less than this
5987 threshold (in percent).
5988
5989 @item tracer-min-branch-ratio
5990 @itemx tracer-min-branch-ratio-feedback
5991
5992 Stop forward growth if the best edge do have probability lower than this
5993 threshold.
5994
5995 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5996 compilation for profile feedback and one for compilation without.  The value
5997 for compilation with profile feedback needs to be more conservative (higher) in
5998 order to make tracer effective.
5999
6000 @item max-cse-path-length
6001
6002 Maximum number of basic blocks on path that cse considers.  The default is 10.
6003
6004 @item max-cse-insns
6005 The maximum instructions CSE process before flushing. The default is 1000.
6006
6007 @item global-var-threshold
6008
6009 Counts the number of function calls (@var{n}) and the number of
6010 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6011 single artificial variable will be created to represent all the
6012 call-clobbered variables at function call sites.  This artificial
6013 variable will then be made to alias every call-clobbered variable.
6014 (done as @code{int * size_t} on the host machine; beware overflow).
6015
6016 @item max-aliased-vops
6017
6018 Maximum number of virtual operands allowed to represent aliases
6019 before triggering the alias grouping heuristic.  Alias grouping
6020 reduces compile times and memory consumption needed for aliasing at
6021 the expense of precision loss in alias information.
6022
6023 @item ggc-min-expand
6024
6025 GCC uses a garbage collector to manage its own memory allocation.  This
6026 parameter specifies the minimum percentage by which the garbage
6027 collector's heap should be allowed to expand between collections.
6028 Tuning this may improve compilation speed; it has no effect on code
6029 generation.
6030
6031 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6032 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6033 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6034 GCC is not able to calculate RAM on a particular platform, the lower
6035 bound of 30% is used.  Setting this parameter and
6036 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6037 every opportunity.  This is extremely slow, but can be useful for
6038 debugging.
6039
6040 @item ggc-min-heapsize
6041
6042 Minimum size of the garbage collector's heap before it begins bothering
6043 to collect garbage.  The first collection occurs after the heap expands
6044 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6045 tuning this may improve compilation speed, and has no effect on code
6046 generation.
6047
6048 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6049 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6050 with a lower bound of 4096 (four megabytes) and an upper bound of
6051 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6052 particular platform, the lower bound is used.  Setting this parameter
6053 very large effectively disables garbage collection.  Setting this
6054 parameter and @option{ggc-min-expand} to zero causes a full collection
6055 to occur at every opportunity.
6056
6057 @item max-reload-search-insns
6058 The maximum number of instruction reload should look backward for equivalent
6059 register.  Increasing values mean more aggressive optimization, making the
6060 compile time increase with probably slightly better performance.  The default
6061 value is 100.
6062
6063 @item max-cselib-memory-location
6064 The maximum number of memory locations cselib should take into account.
6065 Increasing values mean more aggressive optimization, making the compile time
6066 increase with probably slightly better performance.  The default value is 500.
6067
6068 @item max-flow-memory-location
6069 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6070 The default value is 100.
6071
6072 @item reorder-blocks-duplicate
6073 @itemx reorder-blocks-duplicate-feedback
6074
6075 Used by basic block reordering pass to decide whether to use unconditional
6076 branch or duplicate the code on its destination.  Code is duplicated when its
6077 estimated size is smaller than this value multiplied by the estimated size of
6078 unconditional jump in the hot spots of the program.
6079
6080 The @option{reorder-block-duplicate-feedback} is used only when profile
6081 feedback is available and may be set to higher values than
6082 @option{reorder-block-duplicate} since information about the hot spots is more
6083 accurate.
6084
6085 @item max-sched-region-blocks
6086 The maximum number of blocks in a region to be considered for
6087 interblock scheduling.  The default value is 10.
6088
6089 @item max-sched-region-insns
6090 The maximum number of insns in a region to be considered for
6091 interblock scheduling.  The default value is 100.
6092
6093 @item min-sched-prob
6094 The minimum probability of reaching a source block for interblock
6095 speculative scheduling.  The default value is 40.
6096
6097 @item max-last-value-rtl
6098
6099 The maximum size measured as number of RTLs that can be recorded in an expression
6100 in combiner for a pseudo register as last known value of that register.  The default
6101 is 10000.
6102
6103 @item integer-share-limit
6104 Small integer constants can use a shared data structure, reducing the
6105 compiler's memory usage and increasing its speed.  This sets the maximum
6106 value of a shared integer constant's.  The default value is 256.
6107
6108 @item min-virtual-mappings
6109 Specifies the minimum number of virtual mappings in the incremental
6110 SSA updater that should be registered to trigger the virtual mappings
6111 heuristic defined by virtual-mappings-ratio.  The default value is
6112 100.
6113
6114 @item virtual-mappings-ratio
6115 If the number of virtual mappings is virtual-mappings-ratio bigger
6116 than the number of virtual symbols to be updated, then the incremental
6117 SSA updater switches to a full update for those symbols.  The default
6118 ratio is 3.
6119
6120 @item ssp-buffer-size
6121 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6122 protection when @option{-fstack-protection} is used.
6123
6124 @item max-jump-thread-duplication-stmts
6125 Maximum number of statements allowed in a block that needs to be
6126 duplicated when threading jumps.
6127
6128 @item max-fields-for-field-sensitive
6129 Maximum number of fields in a structure we will treat in
6130 a field sensitive manner during pointer analysis.
6131
6132 @end table
6133 @end table
6134
6135 @node Preprocessor Options
6136 @section Options Controlling the Preprocessor
6137 @cindex preprocessor options
6138 @cindex options, preprocessor
6139
6140 These options control the C preprocessor, which is run on each C source
6141 file before actual compilation.
6142
6143 If you use the @option{-E} option, nothing is done except preprocessing.
6144 Some of these options make sense only together with @option{-E} because
6145 they cause the preprocessor output to be unsuitable for actual
6146 compilation.
6147
6148 @table @gcctabopt
6149 @opindex Wp
6150 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6151 and pass @var{option} directly through to the preprocessor.  If
6152 @var{option} contains commas, it is split into multiple options at the
6153 commas.  However, many options are modified, translated or interpreted
6154 by the compiler driver before being passed to the preprocessor, and
6155 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6156 interface is undocumented and subject to change, so whenever possible
6157 you should avoid using @option{-Wp} and let the driver handle the
6158 options instead.
6159
6160 @item -Xpreprocessor @var{option}
6161 @opindex preprocessor
6162 Pass @var{option} as an option to the preprocessor.  You can use this to
6163 supply system-specific preprocessor options which GCC does not know how to
6164 recognize.
6165
6166 If you want to pass an option that takes an argument, you must use
6167 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6168 @end table
6169
6170 @include cppopts.texi
6171
6172 @node Assembler Options
6173 @section Passing Options to the Assembler
6174
6175 @c prevent bad page break with this line
6176 You can pass options to the assembler.
6177
6178 @table @gcctabopt
6179 @item -Wa,@var{option}
6180 @opindex Wa
6181 Pass @var{option} as an option to the assembler.  If @var{option}
6182 contains commas, it is split into multiple options at the commas.
6183
6184 @item -Xassembler @var{option}
6185 @opindex Xassembler
6186 Pass @var{option} as an option to the assembler.  You can use this to
6187 supply system-specific assembler options which GCC does not know how to
6188 recognize.
6189
6190 If you want to pass an option that takes an argument, you must use
6191 @option{-Xassembler} twice, once for the option and once for the argument.
6192
6193 @end table
6194
6195 @node Link Options
6196 @section Options for Linking
6197 @cindex link options
6198 @cindex options, linking
6199
6200 These options come into play when the compiler links object files into
6201 an executable output file.  They are meaningless if the compiler is
6202 not doing a link step.
6203
6204 @table @gcctabopt
6205 @cindex file names
6206 @item @var{object-file-name}
6207 A file name that does not end in a special recognized suffix is
6208 considered to name an object file or library.  (Object files are
6209 distinguished from libraries by the linker according to the file
6210 contents.)  If linking is done, these object files are used as input
6211 to the linker.
6212
6213 @item -c
6214 @itemx -S
6215 @itemx -E
6216 @opindex c
6217 @opindex S
6218 @opindex E
6219 If any of these options is used, then the linker is not run, and
6220 object file names should not be used as arguments.  @xref{Overall
6221 Options}.
6222
6223 @cindex Libraries
6224 @item -l@var{library}
6225 @itemx -l @var{library}
6226 @opindex l
6227 Search the library named @var{library} when linking.  (The second
6228 alternative with the library as a separate argument is only for
6229 POSIX compliance and is not recommended.)
6230
6231 It makes a difference where in the command you write this option; the
6232 linker searches and processes libraries and object files in the order they
6233 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6234 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6235 to functions in @samp{z}, those functions may not be loaded.
6236
6237 The linker searches a standard list of directories for the library,
6238 which is actually a file named @file{lib@var{library}.a}.  The linker
6239 then uses this file as if it had been specified precisely by name.
6240
6241 The directories searched include several standard system directories
6242 plus any that you specify with @option{-L}.
6243
6244 Normally the files found this way are library files---archive files
6245 whose members are object files.  The linker handles an archive file by
6246 scanning through it for members which define symbols that have so far
6247 been referenced but not defined.  But if the file that is found is an
6248 ordinary object file, it is linked in the usual fashion.  The only
6249 difference between using an @option{-l} option and specifying a file name
6250 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6251 and searches several directories.
6252
6253 @item -lobjc
6254 @opindex lobjc
6255 You need this special case of the @option{-l} option in order to
6256 link an Objective-C or Objective-C++ program.
6257
6258 @item -nostartfiles
6259 @opindex nostartfiles
6260 Do not use the standard system startup files when linking.
6261 The standard system libraries are used normally, unless @option{-nostdlib}
6262 or @option{-nodefaultlibs} is used.
6263
6264 @item -nodefaultlibs
6265 @opindex nodefaultlibs
6266 Do not use the standard system libraries when linking.
6267 Only the libraries you specify will be passed to the linker.
6268 The standard startup files are used normally, unless @option{-nostartfiles}
6269 is used.  The compiler may generate calls to @code{memcmp},
6270 @code{memset}, @code{memcpy} and @code{memmove}.
6271 These entries are usually resolved by entries in
6272 libc.  These entry points should be supplied through some other
6273 mechanism when this option is specified.
6274
6275 @item -nostdlib
6276 @opindex nostdlib
6277 Do not use the standard system startup files or libraries when linking.
6278 No startup files and only the libraries you specify will be passed to
6279 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6280 @code{memcpy} and @code{memmove}.
6281 These entries are usually resolved by entries in
6282 libc.  These entry points should be supplied through some other
6283 mechanism when this option is specified.
6284
6285 @cindex @option{-lgcc}, use with @option{-nostdlib}
6286 @cindex @option{-nostdlib} and unresolved references
6287 @cindex unresolved references and @option{-nostdlib}
6288 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6289 @cindex @option{-nodefaultlibs} and unresolved references
6290 @cindex unresolved references and @option{-nodefaultlibs}
6291 One of the standard libraries bypassed by @option{-nostdlib} and
6292 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6293 that GCC uses to overcome shortcomings of particular machines, or special
6294 needs for some languages.
6295 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6296 Collection (GCC) Internals},
6297 for more discussion of @file{libgcc.a}.)
6298 In most cases, you need @file{libgcc.a} even when you want to avoid
6299 other standard libraries.  In other words, when you specify @option{-nostdlib}
6300 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6301 This ensures that you have no unresolved references to internal GCC
6302 library subroutines.  (For example, @samp{__main}, used to ensure C++
6303 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6304 GNU Compiler Collection (GCC) Internals}.)
6305
6306 @item -pie
6307 @opindex pie
6308 Produce a position independent executable on targets which support it.
6309 For predictable results, you must also specify the same set of options
6310 that were used to generate code (@option{-fpie}, @option{-fPIE},
6311 or model suboptions) when you specify this option.
6312
6313 @item -rdynamic
6314 @opindex rdynamic
6315 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6316 that support it. This instructs the linker to add all symbols, not
6317 only used ones, to the dynamic symbol table. This option is needed
6318 for some uses of @code{dlopen} or to allow obtaining backtraces
6319 from within a program.
6320
6321 @item -s
6322 @opindex s
6323 Remove all symbol table and relocation information from the executable.
6324
6325 @item -static
6326 @opindex static
6327 On systems that support dynamic linking, this prevents linking with the shared
6328 libraries.  On other systems, this option has no effect.
6329
6330 @item -shared
6331 @opindex shared
6332 Produce a shared object which can then be linked with other objects to
6333 form an executable.  Not all systems support this option.  For predictable
6334 results, you must also specify the same set of options that were used to
6335 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6336 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6337 needs to build supplementary stub code for constructors to work.  On
6338 multi-libbed systems, @samp{gcc -shared} must select the correct support
6339 libraries to link against.  Failing to supply the correct flags may lead
6340 to subtle defects.  Supplying them in cases where they are not necessary
6341 is innocuous.}
6342
6343 @item -shared-libgcc
6344 @itemx -static-libgcc
6345 @opindex shared-libgcc
6346 @opindex static-libgcc
6347 On systems that provide @file{libgcc} as a shared library, these options
6348 force the use of either the shared or static version respectively.
6349 If no shared version of @file{libgcc} was built when the compiler was
6350 configured, these options have no effect.
6351
6352 There are several situations in which an application should use the
6353 shared @file{libgcc} instead of the static version.  The most common
6354 of these is when the application wishes to throw and catch exceptions
6355 across different shared libraries.  In that case, each of the libraries
6356 as well as the application itself should use the shared @file{libgcc}.
6357
6358 Therefore, the G++ and GCJ drivers automatically add
6359 @option{-shared-libgcc} whenever you build a shared library or a main
6360 executable, because C++ and Java programs typically use exceptions, so
6361 this is the right thing to do.
6362
6363 If, instead, you use the GCC driver to create shared libraries, you may
6364 find that they will not always be linked with the shared @file{libgcc}.
6365 If GCC finds, at its configuration time, that you have a non-GNU linker
6366 or a GNU linker that does not support option @option{--eh-frame-hdr},
6367 it will link the shared version of @file{libgcc} into shared libraries
6368 by default.  Otherwise, it will take advantage of the linker and optimize
6369 away the linking with the shared version of @file{libgcc}, linking with
6370 the static version of libgcc by default.  This allows exceptions to
6371 propagate through such shared libraries, without incurring relocation
6372 costs at library load time.
6373
6374 However, if a library or main executable is supposed to throw or catch
6375 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6376 for the languages used in the program, or using the option
6377 @option{-shared-libgcc}, such that it is linked with the shared
6378 @file{libgcc}.
6379
6380 @item -symbolic
6381 @opindex symbolic
6382 Bind references to global symbols when building a shared object.  Warn
6383 about any unresolved references (unless overridden by the link editor
6384 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6385 this option.
6386
6387 @item -Xlinker @var{option}
6388 @opindex Xlinker
6389 Pass @var{option} as an option to the linker.  You can use this to
6390 supply system-specific linker options which GCC does not know how to
6391 recognize.
6392
6393 If you want to pass an option that takes an argument, you must use
6394 @option{-Xlinker} twice, once for the option and once for the argument.
6395 For example, to pass @option{-assert definitions}, you must write
6396 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6397 @option{-Xlinker "-assert definitions"}, because this passes the entire
6398 string as a single argument, which is not what the linker expects.
6399
6400 @item -Wl,@var{option}
6401 @opindex Wl
6402 Pass @var{option} as an option to the linker.  If @var{option} contains
6403 commas, it is split into multiple options at the commas.
6404
6405 @item -u @var{symbol}
6406 @opindex u
6407 Pretend the symbol @var{symbol} is undefined, to force linking of
6408 library modules to define it.  You can use @option{-u} multiple times with
6409 different symbols to force loading of additional library modules.
6410 @end table
6411
6412 @node Directory Options
6413 @section Options for Directory Search
6414 @cindex directory options
6415 @cindex options, directory search
6416 @cindex search path
6417
6418 These options specify directories to search for header files, for
6419 libraries and for parts of the compiler:
6420
6421 @table @gcctabopt
6422 @item -I@var{dir}
6423 @opindex I
6424 Add the directory @var{dir} to the head of the list of directories to be
6425 searched for header files.  This can be used to override a system header
6426 file, substituting your own version, since these directories are
6427 searched before the system header file directories.  However, you should
6428 not use this option to add directories that contain vendor-supplied
6429 system header files (use @option{-isystem} for that).  If you use more than
6430 one @option{-I} option, the directories are scanned in left-to-right
6431 order; the standard system directories come after.
6432
6433 If a standard system include directory, or a directory specified with
6434 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6435 option will be ignored.  The directory will still be searched but as a
6436 system directory at its normal position in the system include chain.
6437 This is to ensure that GCC's procedure to fix buggy system headers and
6438 the ordering for the include_next directive are not inadvertently changed.
6439 If you really need to change the search order for system directories,
6440 use the @option{-nostdinc} and/or @option{-isystem} options.
6441
6442 @item -iquote@var{dir}
6443 @opindex iquote
6444 Add the directory @var{dir} to the head of the list of directories to
6445 be searched for header files only for the case of @samp{#include
6446 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6447 otherwise just like @option{-I}.
6448
6449 @item -L@var{dir}
6450 @opindex L
6451 Add directory @var{dir} to the list of directories to be searched
6452 for @option{-l}.
6453
6454 @item -B@var{prefix}
6455 @opindex B
6456 This option specifies where to find the executables, libraries,
6457 include files, and data files of the compiler itself.
6458
6459 The compiler driver program runs one or more of the subprograms
6460 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6461 @var{prefix} as a prefix for each program it tries to run, both with and
6462 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6463
6464 For each subprogram to be run, the compiler driver first tries the
6465 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6466 was not specified, the driver tries two standard prefixes, which are
6467 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6468 those results in a file name that is found, the unmodified program
6469 name is searched for using the directories specified in your
6470 @env{PATH} environment variable.
6471
6472 The compiler will check to see if the path provided by the @option{-B}
6473 refers to a directory, and if necessary it will add a directory
6474 separator character at the end of the path.
6475
6476 @option{-B} prefixes that effectively specify directory names also apply
6477 to libraries in the linker, because the compiler translates these
6478 options into @option{-L} options for the linker.  They also apply to
6479 includes files in the preprocessor, because the compiler translates these
6480 options into @option{-isystem} options for the preprocessor.  In this case,
6481 the compiler appends @samp{include} to the prefix.
6482
6483 The run-time support file @file{libgcc.a} can also be searched for using
6484 the @option{-B} prefix, if needed.  If it is not found there, the two
6485 standard prefixes above are tried, and that is all.  The file is left
6486 out of the link if it is not found by those means.
6487
6488 Another way to specify a prefix much like the @option{-B} prefix is to use
6489 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6490 Variables}.
6491
6492 As a special kludge, if the path provided by @option{-B} is
6493 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6494 9, then it will be replaced by @file{[dir/]include}.  This is to help
6495 with boot-strapping the compiler.
6496
6497 @item -specs=@var{file}
6498 @opindex specs
6499 Process @var{file} after the compiler reads in the standard @file{specs}
6500 file, in order to override the defaults that the @file{gcc} driver
6501 program uses when determining what switches to pass to @file{cc1},
6502 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6503 @option{-specs=@var{file}} can be specified on the command line, and they
6504 are processed in order, from left to right.
6505
6506 @item --sysroot=@var{dir}
6507 @opindex sysroot
6508 Use @var{dir} as the logical root directory for headers and libraries.
6509 For example, if the compiler would normally search for headers in
6510 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6511 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6512
6513 If you use both this option and the @option{-isysroot} option, then
6514 the @option{--sysroot} option will apply to libraries, but the
6515 @option{-isysroot} option will apply to header files.
6516
6517 The GNU linker (beginning with version 2.16) has the necessary support
6518 for this option.  If your linker does not support this option, the
6519 header file aspect of @option{--sysroot} will still work, but the
6520 library aspect will not.
6521
6522 @item -I-
6523 @opindex I-
6524 This option has been deprecated.  Please use @option{-iquote} instead for
6525 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6526 Any directories you specify with @option{-I} options before the @option{-I-}
6527 option are searched only for the case of @samp{#include "@var{file}"};
6528 they are not searched for @samp{#include <@var{file}>}.
6529
6530 If additional directories are specified with @option{-I} options after
6531 the @option{-I-}, these directories are searched for all @samp{#include}
6532 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6533 this way.)
6534
6535 In addition, the @option{-I-} option inhibits the use of the current
6536 directory (where the current input file came from) as the first search
6537 directory for @samp{#include "@var{file}"}.  There is no way to
6538 override this effect of @option{-I-}.  With @option{-I.} you can specify
6539 searching the directory which was current when the compiler was
6540 invoked.  That is not exactly the same as what the preprocessor does
6541 by default, but it is often satisfactory.
6542
6543 @option{-I-} does not inhibit the use of the standard system directories
6544 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6545 independent.
6546 @end table
6547
6548 @c man end
6549
6550 @node Spec Files
6551 @section Specifying subprocesses and the switches to pass to them
6552 @cindex Spec Files
6553
6554 @command{gcc} is a driver program.  It performs its job by invoking a
6555 sequence of other programs to do the work of compiling, assembling and
6556 linking.  GCC interprets its command-line parameters and uses these to
6557 deduce which programs it should invoke, and which command-line options
6558 it ought to place on their command lines.  This behavior is controlled
6559 by @dfn{spec strings}.  In most cases there is one spec string for each
6560 program that GCC can invoke, but a few programs have multiple spec
6561 strings to control their behavior.  The spec strings built into GCC can
6562 be overridden by using the @option{-specs=} command-line switch to specify
6563 a spec file.
6564
6565 @dfn{Spec files} are plaintext files that are used to construct spec
6566 strings.  They consist of a sequence of directives separated by blank
6567 lines.  The type of directive is determined by the first non-whitespace
6568 character on the line and it can be one of the following:
6569
6570 @table @code
6571 @item %@var{command}
6572 Issues a @var{command} to the spec file processor.  The commands that can
6573 appear here are:
6574
6575 @table @code
6576 @item %include <@var{file}>
6577 @cindex %include
6578 Search for @var{file} and insert its text at the current point in the
6579 specs file.
6580
6581 @item %include_noerr <@var{file}>
6582 @cindex %include_noerr
6583 Just like @samp{%include}, but do not generate an error message if the include
6584 file cannot be found.
6585
6586 @item %rename @var{old_name} @var{new_name}
6587 @cindex %rename
6588 Rename the spec string @var{old_name} to @var{new_name}.
6589
6590 @end table
6591
6592 @item *[@var{spec_name}]:
6593 This tells the compiler to create, override or delete the named spec
6594 string.  All lines after this directive up to the next directive or
6595 blank line are considered to be the text for the spec string.  If this
6596 results in an empty string then the spec will be deleted.  (Or, if the
6597 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6598 does not currently exist a new spec will be created.  If the spec does
6599 exist then its contents will be overridden by the text of this
6600 directive, unless the first character of that text is the @samp{+}
6601 character, in which case the text will be appended to the spec.
6602
6603 @item [@var{suffix}]:
6604 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6605 and up to the next directive or blank line are considered to make up the
6606 spec string for the indicated suffix.  When the compiler encounters an
6607 input file with the named suffix, it will processes the spec string in
6608 order to work out how to compile that file.  For example:
6609
6610 @smallexample
6611 .ZZ:
6612 z-compile -input %i
6613 @end smallexample
6614
6615 This says that any input file whose name ends in @samp{.ZZ} should be
6616 passed to the program @samp{z-compile}, which should be invoked with the
6617 command-line switch @option{-input} and with the result of performing the
6618 @samp{%i} substitution.  (See below.)
6619
6620 As an alternative to providing a spec string, the text that follows a
6621 suffix directive can be one of the following:
6622
6623 @table @code
6624 @item @@@var{language}
6625 This says that the suffix is an alias for a known @var{language}.  This is
6626 similar to using the @option{-x} command-line switch to GCC to specify a
6627 language explicitly.  For example:
6628
6629 @smallexample
6630 .ZZ:
6631 @@c++
6632 @end smallexample
6633
6634 Says that .ZZ files are, in fact, C++ source files.
6635
6636 @item #@var{name}
6637 This causes an error messages saying:
6638
6639 @smallexample
6640 @var{name} compiler not installed on this system.
6641 @end smallexample
6642 @end table
6643
6644 GCC already has an extensive list of suffixes built into it.
6645 This directive will add an entry to the end of the list of suffixes, but
6646 since the list is searched from the end backwards, it is effectively
6647 possible to override earlier entries using this technique.
6648
6649 @end table
6650
6651 GCC has the following spec strings built into it.  Spec files can
6652 override these strings or create their own.  Note that individual
6653 targets can also add their own spec strings to this list.
6654
6655 @smallexample
6656 asm          Options to pass to the assembler
6657 asm_final    Options to pass to the assembler post-processor
6658 cpp          Options to pass to the C preprocessor
6659 cc1          Options to pass to the C compiler
6660 cc1plus      Options to pass to the C++ compiler
6661 endfile      Object files to include at the end of the link
6662 link         Options to pass to the linker
6663 lib          Libraries to include on the command line to the linker
6664 libgcc       Decides which GCC support library to pass to the linker
6665 linker       Sets the name of the linker
6666 predefines   Defines to be passed to the C preprocessor
6667 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6668              by default
6669 startfile    Object files to include at the start of the link
6670 @end smallexample
6671
6672 Here is a small example of a spec file:
6673
6674 @smallexample
6675 %rename lib                 old_lib
6676
6677 *lib:
6678 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6679 @end smallexample
6680
6681 This example renames the spec called @samp{lib} to @samp{old_lib} and
6682 then overrides the previous definition of @samp{lib} with a new one.
6683 The new definition adds in some extra command-line options before
6684 including the text of the old definition.
6685
6686 @dfn{Spec strings} are a list of command-line options to be passed to their
6687 corresponding program.  In addition, the spec strings can contain
6688 @samp{%}-prefixed sequences to substitute variable text or to
6689 conditionally insert text into the command line.  Using these constructs
6690 it is possible to generate quite complex command lines.
6691
6692 Here is a table of all defined @samp{%}-sequences for spec
6693 strings.  Note that spaces are not generated automatically around the
6694 results of expanding these sequences.  Therefore you can concatenate them
6695 together or combine them with constant text in a single argument.
6696
6697 @table @code
6698 @item %%
6699 Substitute one @samp{%} into the program name or argument.
6700
6701 @item %i
6702 Substitute the name of the input file being processed.
6703
6704 @item %b
6705 Substitute the basename of the input file being processed.
6706 This is the substring up to (and not including) the last period
6707 and not including the directory.
6708
6709 @item %B
6710 This is the same as @samp{%b}, but include the file suffix (text after
6711 the last period).
6712
6713 @item %d
6714 Marks the argument containing or following the @samp{%d} as a
6715 temporary file name, so that that file will be deleted if GCC exits
6716 successfully.  Unlike @samp{%g}, this contributes no text to the
6717 argument.
6718
6719 @item %g@var{suffix}
6720 Substitute a file name that has suffix @var{suffix} and is chosen
6721 once per compilation, and mark the argument in the same way as
6722 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6723 name is now chosen in a way that is hard to predict even when previously
6724 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6725 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6726 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6727 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6728 was simply substituted with a file name chosen once per compilation,
6729 without regard to any appended suffix (which was therefore treated
6730 just like ordinary text), making such attacks more likely to succeed.
6731
6732 @item %u@var{suffix}
6733 Like @samp{%g}, but generates a new temporary file name even if
6734 @samp{%u@var{suffix}} was already seen.
6735
6736 @item %U@var{suffix}
6737 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6738 new one if there is no such last file name.  In the absence of any
6739 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6740 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6741 would involve the generation of two distinct file names, one
6742 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6743 simply substituted with a file name chosen for the previous @samp{%u},
6744 without regard to any appended suffix.
6745
6746 @item %j@var{suffix}
6747 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6748 writable, and if save-temps is off; otherwise, substitute the name
6749 of a temporary file, just like @samp{%u}.  This temporary file is not
6750 meant for communication between processes, but rather as a junk
6751 disposal mechanism.
6752
6753 @item %|@var{suffix}
6754 @itemx %m@var{suffix}
6755 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6756 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6757 all.  These are the two most common ways to instruct a program that it
6758 should read from standard input or write to standard output.  If you
6759 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6760 construct: see for example @file{f/lang-specs.h}.
6761
6762 @item %.@var{SUFFIX}
6763 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6764 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6765 terminated by the next space or %.
6766
6767 @item %w
6768 Marks the argument containing or following the @samp{%w} as the
6769 designated output file of this compilation.  This puts the argument
6770 into the sequence of arguments that @samp{%o} will substitute later.
6771
6772 @item %o
6773 Substitutes the names of all the output files, with spaces
6774 automatically placed around them.  You should write spaces
6775 around the @samp{%o} as well or the results are undefined.
6776 @samp{%o} is for use in the specs for running the linker.
6777 Input files whose names have no recognized suffix are not compiled
6778 at all, but they are included among the output files, so they will
6779 be linked.
6780
6781 @item %O
6782 Substitutes the suffix for object files.  Note that this is
6783 handled specially when it immediately follows @samp{%g, %u, or %U},
6784 because of the need for those to form complete file names.  The
6785 handling is such that @samp{%O} is treated exactly as if it had already
6786 been substituted, except that @samp{%g, %u, and %U} do not currently
6787 support additional @var{suffix} characters following @samp{%O} as they would
6788 following, for example, @samp{.o}.
6789
6790 @item %p
6791 Substitutes the standard macro predefinitions for the
6792 current target machine.  Use this when running @code{cpp}.
6793
6794 @item %P
6795 Like @samp{%p}, but puts @samp{__} before and after the name of each
6796 predefined macro, except for macros that start with @samp{__} or with
6797 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6798 C@.
6799
6800 @item %I
6801 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6802 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6803 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6804 as necessary.
6805
6806 @item %s
6807 Current argument is the name of a library or startup file of some sort.
6808 Search for that file in a standard list of directories and substitute
6809 the full name found.
6810
6811 @item %e@var{str}
6812 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6813 Use this when inconsistent options are detected.
6814
6815 @item %(@var{name})
6816 Substitute the contents of spec string @var{name} at this point.
6817
6818 @item %[@var{name}]
6819 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6820
6821 @item %x@{@var{option}@}
6822 Accumulate an option for @samp{%X}.
6823
6824 @item %X
6825 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6826 spec string.
6827
6828 @item %Y
6829 Output the accumulated assembler options specified by @option{-Wa}.
6830
6831 @item %Z
6832 Output the accumulated preprocessor options specified by @option{-Wp}.
6833
6834 @item %a
6835 Process the @code{asm} spec.  This is used to compute the
6836 switches to be passed to the assembler.
6837
6838 @item %A
6839 Process the @code{asm_final} spec.  This is a spec string for
6840 passing switches to an assembler post-processor, if such a program is
6841 needed.
6842
6843 @item %l
6844 Process the @code{link} spec.  This is the spec for computing the
6845 command line passed to the linker.  Typically it will make use of the
6846 @samp{%L %G %S %D and %E} sequences.
6847
6848 @item %D
6849 Dump out a @option{-L} option for each directory that GCC believes might
6850 contain startup files.  If the target supports multilibs then the
6851 current multilib directory will be prepended to each of these paths.
6852
6853 @item %L
6854 Process the @code{lib} spec.  This is a spec string for deciding which
6855 libraries should be included on the command line to the linker.
6856
6857 @item %G
6858 Process the @code{libgcc} spec.  This is a spec string for deciding
6859 which GCC support library should be included on the command line to the linker.
6860
6861 @item %S
6862 Process the @code{startfile} spec.  This is a spec for deciding which
6863 object files should be the first ones passed to the linker.  Typically
6864 this might be a file named @file{crt0.o}.
6865
6866 @item %E
6867 Process the @code{endfile} spec.  This is a spec string that specifies
6868 the last object files that will be passed to the linker.
6869
6870 @item %C
6871 Process the @code{cpp} spec.  This is used to construct the arguments
6872 to be passed to the C preprocessor.
6873
6874 @item %1
6875 Process the @code{cc1} spec.  This is used to construct the options to be
6876 passed to the actual C compiler (@samp{cc1}).
6877
6878 @item %2
6879 Process the @code{cc1plus} spec.  This is used to construct the options to be
6880 passed to the actual C++ compiler (@samp{cc1plus}).
6881
6882 @item %*
6883 Substitute the variable part of a matched option.  See below.
6884 Note that each comma in the substituted string is replaced by
6885 a single space.
6886
6887 @item %<@code{S}
6888 Remove all occurrences of @code{-S} from the command line.  Note---this
6889 command is position dependent.  @samp{%} commands in the spec string
6890 before this one will see @code{-S}, @samp{%} commands in the spec string
6891 after this one will not.
6892
6893 @item %:@var{function}(@var{args})
6894 Call the named function @var{function}, passing it @var{args}.
6895 @var{args} is first processed as a nested spec string, then split
6896 into an argument vector in the usual fashion.  The function returns
6897 a string which is processed as if it had appeared literally as part
6898 of the current spec.
6899
6900 The following built-in spec functions are provided:
6901
6902 @table @code
6903 @item @code{if-exists}
6904 The @code{if-exists} spec function takes one argument, an absolute
6905 pathname to a file.  If the file exists, @code{if-exists} returns the
6906 pathname.  Here is a small example of its usage:
6907
6908 @smallexample
6909 *startfile:
6910 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6911 @end smallexample
6912
6913 @item @code{if-exists-else}
6914 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6915 spec function, except that it takes two arguments.  The first argument is
6916 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6917 returns the pathname.  If it does not exist, it returns the second argument.
6918 This way, @code{if-exists-else} can be used to select one file or another,
6919 based on the existence of the first.  Here is a small example of its usage:
6920
6921 @smallexample
6922 *startfile:
6923 crt0%O%s %:if-exists(crti%O%s) \
6924 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6925 @end smallexample
6926
6927 @item @code{replace-outfile}
6928 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6929 first argument in the outfiles array and replaces it with the second argument.  Here
6930 is a small example of its usage:
6931
6932 @smallexample
6933 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6934 @end smallexample
6935
6936 @end table
6937
6938 @item %@{@code{S}@}
6939 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6940 If that switch was not specified, this substitutes nothing.  Note that
6941 the leading dash is omitted when specifying this option, and it is
6942 automatically inserted if the substitution is performed.  Thus the spec
6943 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6944 and would output the command line option @option{-foo}.
6945
6946 @item %W@{@code{S}@}
6947 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6948 deleted on failure.
6949
6950 @item %@{@code{S}*@}
6951 Substitutes all the switches specified to GCC whose names start
6952 with @code{-S}, but which also take an argument.  This is used for
6953 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6954 GCC considers @option{-o foo} as being
6955 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6956 text, including the space.  Thus two arguments would be generated.
6957
6958 @item %@{@code{S}*&@code{T}*@}
6959 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6960 (the order of @code{S} and @code{T} in the spec is not significant).
6961 There can be any number of ampersand-separated variables; for each the
6962 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6963
6964 @item %@{@code{S}:@code{X}@}
6965 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6966
6967 @item %@{!@code{S}:@code{X}@}
6968 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6969
6970 @item %@{@code{S}*:@code{X}@}
6971 Substitutes @code{X} if one or more switches whose names start with
6972 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6973 once, no matter how many such switches appeared.  However, if @code{%*}
6974 appears somewhere in @code{X}, then @code{X} will be substituted once
6975 for each matching switch, with the @code{%*} replaced by the part of
6976 that switch that matched the @code{*}.
6977
6978 @item %@{.@code{S}:@code{X}@}
6979 Substitutes @code{X}, if processing a file with suffix @code{S}.
6980
6981 @item %@{!.@code{S}:@code{X}@}
6982 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6983
6984 @item %@{@code{S}|@code{P}:@code{X}@}
6985 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6986 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6987 although they have a stronger binding than the @samp{|}.  If @code{%*}
6988 appears in @code{X}, all of the alternatives must be starred, and only
6989 the first matching alternative is substituted.
6990
6991 For example, a spec string like this:
6992
6993 @smallexample
6994 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6995 @end smallexample
6996
6997 will output the following command-line options from the following input
6998 command-line options:
6999
7000 @smallexample
7001 fred.c        -foo -baz
7002 jim.d         -bar -boggle
7003 -d fred.c     -foo -baz -boggle
7004 -d jim.d      -bar -baz -boggle
7005 @end smallexample
7006
7007 @item %@{S:X; T:Y; :D@}
7008
7009 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7010 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7011 be as many clauses as you need.  This may be combined with @code{.},
7012 @code{!}, @code{|}, and @code{*} as needed.
7013
7014
7015 @end table
7016
7017 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7018 construct may contain other nested @samp{%} constructs or spaces, or
7019 even newlines.  They are processed as usual, as described above.
7020 Trailing white space in @code{X} is ignored.  White space may also
7021 appear anywhere on the left side of the colon in these constructs,
7022 except between @code{.} or @code{*} and the corresponding word.
7023
7024 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7025 handled specifically in these constructs.  If another value of
7026 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7027 @option{-W} switch is found later in the command line, the earlier
7028 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7029 just one letter, which passes all matching options.
7030
7031 The character @samp{|} at the beginning of the predicate text is used to
7032 indicate that a command should be piped to the following command, but
7033 only if @option{-pipe} is specified.
7034
7035 It is built into GCC which switches take arguments and which do not.
7036 (You might think it would be useful to generalize this to allow each
7037 compiler's spec to say which switches take arguments.  But this cannot
7038 be done in a consistent fashion.  GCC cannot even decide which input
7039 files have been specified without knowing which switches take arguments,
7040 and it must know which input files to compile in order to tell which
7041 compilers to run).
7042
7043 GCC also knows implicitly that arguments starting in @option{-l} are to be
7044 treated as compiler output files, and passed to the linker in their
7045 proper position among the other output files.
7046
7047 @c man begin OPTIONS
7048
7049 @node Target Options
7050 @section Specifying Target Machine and Compiler Version
7051 @cindex target options
7052 @cindex cross compiling
7053 @cindex specifying machine version
7054 @cindex specifying compiler version and target machine
7055 @cindex compiler version, specifying
7056 @cindex target machine, specifying
7057
7058 The usual way to run GCC is to run the executable called @file{gcc}, or
7059 @file{<machine>-gcc} when cross-compiling, or
7060 @file{<machine>-gcc-<version>} to run a version other than the one that
7061 was installed last.  Sometimes this is inconvenient, so GCC provides
7062 options that will switch to another cross-compiler or version.
7063
7064 @table @gcctabopt
7065 @item -b @var{machine}
7066 @opindex b
7067 The argument @var{machine} specifies the target machine for compilation.
7068
7069 The value to use for @var{machine} is the same as was specified as the
7070 machine type when configuring GCC as a cross-compiler.  For
7071 example, if a cross-compiler was configured with @samp{configure
7072 arm-elf}, meaning to compile for an arm processor with elf binaries,
7073 then you would specify @option{-b arm-elf} to run that cross compiler.
7074 Because there are other options beginning with @option{-b}, the
7075 configuration must contain a hyphen. 
7076
7077 @item -V @var{version}
7078 @opindex V
7079 The argument @var{version} specifies which version of GCC to run.
7080 This is useful when multiple versions are installed.  For example,
7081 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7082 @end table
7083
7084 The @option{-V} and @option{-b} options work by running the
7085 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7086 use them if you can just run that directly.
7087
7088 @node Submodel Options
7089 @section Hardware Models and Configurations
7090 @cindex submodel options
7091 @cindex specifying hardware config
7092 @cindex hardware models and configurations, specifying
7093 @cindex machine dependent options
7094
7095 Earlier we discussed the standard option @option{-b} which chooses among
7096 different installed compilers for completely different target
7097 machines, such as VAX vs.@: 68000 vs.@: 80386.
7098
7099 In addition, each of these target machine types can have its own
7100 special options, starting with @samp{-m}, to choose among various
7101 hardware models or configurations---for example, 68010 vs 68020,
7102 floating coprocessor or none.  A single installed version of the
7103 compiler can compile for any model or configuration, according to the
7104 options specified.
7105
7106 Some configurations of the compiler also support additional special
7107 options, usually for compatibility with other compilers on the same
7108 platform.
7109
7110 @c This list is ordered alphanumerically by subsection name.
7111 @c It should be the same order and spelling as these options are listed
7112 @c in Machine Dependent Options
7113
7114 @menu
7115 * ARC Options::
7116 * ARM Options::
7117 * AVR Options::
7118 * Blackfin Options::
7119 * CRIS Options::
7120 * CRX Options::
7121 * Darwin Options::
7122 * DEC Alpha Options::
7123 * DEC Alpha/VMS Options::
7124 * FRV Options::
7125 * H8/300 Options::
7126 * HPPA Options::
7127 * i386 and x86-64 Options::
7128 * IA-64 Options::
7129 * M32C Options::
7130 * M32R/D Options::
7131 * M680x0 Options::
7132 * M68hc1x Options::
7133 * MCore Options::
7134 * MIPS Options::
7135 * MMIX Options::
7136 * MN10300 Options::
7137 * MT Options::
7138 * PDP-11 Options::
7139 * PowerPC Options::
7140 * RS/6000 and PowerPC Options::
7141 * S/390 and zSeries Options::
7142 * SH Options::
7143 * SPARC Options::
7144 * System V Options::
7145 * TMS320C3x/C4x Options::
7146 * V850 Options::
7147 * VAX Options::
7148 * x86-64 Options::
7149 * Xstormy16 Options::
7150 * Xtensa Options::
7151 * zSeries Options::
7152 @end menu
7153
7154 @node ARC Options
7155 @subsection ARC Options
7156 @cindex ARC Options
7157
7158 These options are defined for ARC implementations:
7159
7160 @table @gcctabopt
7161 @item -EL
7162 @opindex EL
7163 Compile code for little endian mode.  This is the default.
7164
7165 @item -EB
7166 @opindex EB
7167 Compile code for big endian mode.
7168
7169 @item -mmangle-cpu
7170 @opindex mmangle-cpu
7171 Prepend the name of the cpu to all public symbol names.
7172 In multiple-processor systems, there are many ARC variants with different
7173 instruction and register set characteristics.  This flag prevents code
7174 compiled for one cpu to be linked with code compiled for another.
7175 No facility exists for handling variants that are ``almost identical''.
7176 This is an all or nothing option.
7177
7178 @item -mcpu=@var{cpu}
7179 @opindex mcpu
7180 Compile code for ARC variant @var{cpu}.
7181 Which variants are supported depend on the configuration.
7182 All variants support @option{-mcpu=base}, this is the default.
7183
7184 @item -mtext=@var{text-section}
7185 @itemx -mdata=@var{data-section}
7186 @itemx -mrodata=@var{readonly-data-section}
7187 @opindex mtext
7188 @opindex mdata
7189 @opindex mrodata
7190 Put functions, data, and readonly data in @var{text-section},
7191 @var{data-section}, and @var{readonly-data-section} respectively
7192 by default.  This can be overridden with the @code{section} attribute.
7193 @xref{Variable Attributes}.
7194
7195 @end table
7196
7197 @node ARM Options
7198 @subsection ARM Options
7199 @cindex ARM options
7200
7201 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7202 architectures:
7203
7204 @table @gcctabopt
7205 @item -mabi=@var{name}
7206 @opindex mabi
7207 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7208 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7209
7210 @item -mapcs-frame
7211 @opindex mapcs-frame
7212 Generate a stack frame that is compliant with the ARM Procedure Call
7213 Standard for all functions, even if this is not strictly necessary for
7214 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7215 with this option will cause the stack frames not to be generated for
7216 leaf functions.  The default is @option{-mno-apcs-frame}.
7217
7218 @item -mapcs
7219 @opindex mapcs
7220 This is a synonym for @option{-mapcs-frame}.
7221
7222 @ignore
7223 @c not currently implemented
7224 @item -mapcs-stack-check
7225 @opindex mapcs-stack-check
7226 Generate code to check the amount of stack space available upon entry to
7227 every function (that actually uses some stack space).  If there is
7228 insufficient space available then either the function
7229 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7230 called, depending upon the amount of stack space required.  The run time
7231 system is required to provide these functions.  The default is
7232 @option{-mno-apcs-stack-check}, since this produces smaller code.
7233
7234 @c not currently implemented
7235 @item -mapcs-float
7236 @opindex mapcs-float
7237 Pass floating point arguments using the float point registers.  This is
7238 one of the variants of the APCS@.  This option is recommended if the
7239 target hardware has a floating point unit or if a lot of floating point
7240 arithmetic is going to be performed by the code.  The default is
7241 @option{-mno-apcs-float}, since integer only code is slightly increased in
7242 size if @option{-mapcs-float} is used.
7243
7244 @c not currently implemented
7245 @item -mapcs-reentrant
7246 @opindex mapcs-reentrant
7247 Generate reentrant, position independent code.  The default is
7248 @option{-mno-apcs-reentrant}.
7249 @end ignore
7250
7251 @item -mthumb-interwork
7252 @opindex mthumb-interwork
7253 Generate code which supports calling between the ARM and Thumb
7254 instruction sets.  Without this option the two instruction sets cannot
7255 be reliably used inside one program.  The default is
7256 @option{-mno-thumb-interwork}, since slightly larger code is generated
7257 when @option{-mthumb-interwork} is specified.
7258
7259 @item -mno-sched-prolog
7260 @opindex mno-sched-prolog
7261 Prevent the reordering of instructions in the function prolog, or the
7262 merging of those instruction with the instructions in the function's
7263 body.  This means that all functions will start with a recognizable set
7264 of instructions (or in fact one of a choice from a small set of
7265 different function prologues), and this information can be used to
7266 locate the start if functions inside an executable piece of code.  The
7267 default is @option{-msched-prolog}.
7268
7269 @item -mhard-float
7270 @opindex mhard-float
7271 Generate output containing floating point instructions.  This is the
7272 default.
7273
7274 @item -msoft-float
7275 @opindex msoft-float
7276 Generate output containing library calls for floating point.
7277 @strong{Warning:} the requisite libraries are not available for all ARM
7278 targets.  Normally the facilities of the machine's usual C compiler are
7279 used, but this cannot be done directly in cross-compilation.  You must make
7280 your own arrangements to provide suitable library functions for
7281 cross-compilation.
7282
7283 @option{-msoft-float} changes the calling convention in the output file;
7284 therefore, it is only useful if you compile @emph{all} of a program with
7285 this option.  In particular, you need to compile @file{libgcc.a}, the
7286 library that comes with GCC, with @option{-msoft-float} in order for
7287 this to work.
7288
7289 @item -mfloat-abi=@var{name}
7290 @opindex mfloat-abi
7291 Specifies which ABI to use for floating point values.  Permissible values
7292 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7293
7294 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7295 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7296 of floating point instructions, but still uses the soft-float calling
7297 conventions.
7298
7299 @item -mlittle-endian
7300 @opindex mlittle-endian
7301 Generate code for a processor running in little-endian mode.  This is
7302 the default for all standard configurations.
7303
7304 @item -mbig-endian
7305 @opindex mbig-endian
7306 Generate code for a processor running in big-endian mode; the default is
7307 to compile code for a little-endian processor.
7308
7309 @item -mwords-little-endian
7310 @opindex mwords-little-endian
7311 This option only applies when generating code for big-endian processors.
7312 Generate code for a little-endian word order but a big-endian byte
7313 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7314 option should only be used if you require compatibility with code for
7315 big-endian ARM processors generated by versions of the compiler prior to
7316 2.8.
7317
7318 @item -mcpu=@var{name}
7319 @opindex mcpu
7320 This specifies the name of the target ARM processor.  GCC uses this name
7321 to determine what kind of instructions it can emit when generating
7322 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7323 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7324 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7325 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7326 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7327 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7328 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7329 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7330 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7331 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7332 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7333 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7334 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7335 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7336 @samp{ep9312}.
7337
7338 @itemx -mtune=@var{name}
7339 @opindex mtune
7340 This option is very similar to the @option{-mcpu=} option, except that
7341 instead of specifying the actual target processor type, and hence
7342 restricting which instructions can be used, it specifies that GCC should
7343 tune the performance of the code as if the target were of the type
7344 specified in this option, but still choosing the instructions that it
7345 will generate based on the cpu specified by a @option{-mcpu=} option.
7346 For some ARM implementations better performance can be obtained by using
7347 this option.
7348
7349 @item -march=@var{name}
7350 @opindex march
7351 This specifies the name of the target ARM architecture.  GCC uses this
7352 name to determine what kind of instructions it can emit when generating
7353 assembly code.  This option can be used in conjunction with or instead
7354 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7355 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7356 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7357 @samp{iwmmxt}, @samp{ep9312}.
7358
7359 @item -mfpu=@var{name}
7360 @itemx -mfpe=@var{number}
7361 @itemx -mfp=@var{number}
7362 @opindex mfpu
7363 @opindex mfpe
7364 @opindex mfp
7365 This specifies what floating point hardware (or hardware emulation) is
7366 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7367 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7368 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7369 with older versions of GCC@.
7370
7371 If @option{-msoft-float} is specified this specifies the format of
7372 floating point values.
7373
7374 @item -mstructure-size-boundary=@var{n}
7375 @opindex mstructure-size-boundary
7376 The size of all structures and unions will be rounded up to a multiple
7377 of the number of bits set by this option.  Permissible values are 8, 32
7378 and 64.  The default value varies for different toolchains.  For the COFF
7379 targeted toolchain the default value is 8.  A value of 64 is only allowed
7380 if the underlying ABI supports it.
7381
7382 Specifying the larger number can produce faster, more efficient code, but
7383 can also increase the size of the program.  Different values are potentially
7384 incompatible.  Code compiled with one value cannot necessarily expect to
7385 work with code or libraries compiled with another value, if they exchange
7386 information using structures or unions.
7387
7388 @item -mabort-on-noreturn
7389 @opindex mabort-on-noreturn
7390 Generate a call to the function @code{abort} at the end of a
7391 @code{noreturn} function.  It will be executed if the function tries to
7392 return.
7393
7394 @item -mlong-calls
7395 @itemx -mno-long-calls
7396 @opindex mlong-calls
7397 @opindex mno-long-calls
7398 Tells the compiler to perform function calls by first loading the
7399 address of the function into a register and then performing a subroutine
7400 call on this register.  This switch is needed if the target function
7401 will lie outside of the 64 megabyte addressing range of the offset based
7402 version of subroutine call instruction.
7403
7404 Even if this switch is enabled, not all function calls will be turned
7405 into long calls.  The heuristic is that static functions, functions
7406 which have the @samp{short-call} attribute, functions that are inside
7407 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7408 definitions have already been compiled within the current compilation
7409 unit, will not be turned into long calls.  The exception to this rule is
7410 that weak function definitions, functions with the @samp{long-call}
7411 attribute or the @samp{section} attribute, and functions that are within
7412 the scope of a @samp{#pragma long_calls} directive, will always be
7413 turned into long calls.
7414
7415 This feature is not enabled by default.  Specifying
7416 @option{-mno-long-calls} will restore the default behavior, as will
7417 placing the function calls within the scope of a @samp{#pragma
7418 long_calls_off} directive.  Note these switches have no effect on how
7419 the compiler generates code to handle function calls via function
7420 pointers.
7421
7422 @item -mnop-fun-dllimport
7423 @opindex mnop-fun-dllimport
7424 Disable support for the @code{dllimport} attribute.
7425
7426 @item -msingle-pic-base
7427 @opindex msingle-pic-base
7428 Treat the register used for PIC addressing as read-only, rather than
7429 loading it in the prologue for each function.  The run-time system is
7430 responsible for initializing this register with an appropriate value
7431 before execution begins.
7432
7433 @item -mpic-register=@var{reg}
7434 @opindex mpic-register
7435 Specify the register to be used for PIC addressing.  The default is R10
7436 unless stack-checking is enabled, when R9 is used.
7437
7438 @item -mcirrus-fix-invalid-insns
7439 @opindex mcirrus-fix-invalid-insns
7440 @opindex mno-cirrus-fix-invalid-insns
7441 Insert NOPs into the instruction stream to in order to work around
7442 problems with invalid Maverick instruction combinations.  This option
7443 is only valid if the @option{-mcpu=ep9312} option has been used to
7444 enable generation of instructions for the Cirrus Maverick floating
7445 point co-processor.  This option is not enabled by default, since the
7446 problem is only present in older Maverick implementations.  The default
7447 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7448 switch.
7449
7450 @item -mpoke-function-name
7451 @opindex mpoke-function-name
7452 Write the name of each function into the text section, directly
7453 preceding the function prologue.  The generated code is similar to this:
7454
7455 @smallexample
7456      t0
7457          .ascii "arm_poke_function_name", 0
7458          .align
7459      t1
7460          .word 0xff000000 + (t1 - t0)
7461      arm_poke_function_name
7462          mov     ip, sp
7463          stmfd   sp!, @{fp, ip, lr, pc@}
7464          sub     fp, ip, #4
7465 @end smallexample
7466
7467 When performing a stack backtrace, code can inspect the value of
7468 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7469 location @code{pc - 12} and the top 8 bits are set, then we know that
7470 there is a function name embedded immediately preceding this location
7471 and has length @code{((pc[-3]) & 0xff000000)}.
7472
7473 @item -mthumb
7474 @opindex mthumb
7475 Generate code for the 16-bit Thumb instruction set.  The default is to
7476 use the 32-bit ARM instruction set.
7477
7478 @item -mtpcs-frame
7479 @opindex mtpcs-frame
7480 Generate a stack frame that is compliant with the Thumb Procedure Call
7481 Standard for all non-leaf functions.  (A leaf function is one that does
7482 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7483
7484 @item -mtpcs-leaf-frame
7485 @opindex mtpcs-leaf-frame
7486 Generate a stack frame that is compliant with the Thumb Procedure Call
7487 Standard for all leaf functions.  (A leaf function is one that does
7488 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7489
7490 @item -mcallee-super-interworking
7491 @opindex mcallee-super-interworking
7492 Gives all externally visible functions in the file being compiled an ARM
7493 instruction set header which switches to Thumb mode before executing the
7494 rest of the function.  This allows these functions to be called from
7495 non-interworking code.
7496
7497 @item -mcaller-super-interworking
7498 @opindex mcaller-super-interworking
7499 Allows calls via function pointers (including virtual functions) to
7500 execute correctly regardless of whether the target code has been
7501 compiled for interworking or not.  There is a small overhead in the cost
7502 of executing a function pointer if this option is enabled.
7503
7504 @item -mtp=@var{name}
7505 @opindex mtp
7506 Specify the access model for the thread local storage pointer.  The valid
7507 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7508 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7509 (supported in the arm6k architecture), and @option{auto}, which uses the
7510 best available method for the selected processor.  The default setting is
7511 @option{auto}.
7512
7513 @end table
7514
7515 @node AVR Options
7516 @subsection AVR Options
7517 @cindex AVR Options
7518
7519 These options are defined for AVR implementations:
7520
7521 @table @gcctabopt
7522 @item -mmcu=@var{mcu}
7523 @opindex mmcu
7524 Specify ATMEL AVR instruction set or MCU type.
7525
7526 Instruction set avr1 is for the minimal AVR core, not supported by the C
7527 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7528 attiny11, attiny12, attiny15, attiny28).
7529
7530 Instruction set avr2 (default) is for the classic AVR core with up to
7531 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7532 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7533 at90c8534, at90s8535).
7534
7535 Instruction set avr3 is for the classic AVR core with up to 128K program
7536 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7537
7538 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7539 memory space (MCU types: atmega8, atmega83, atmega85).
7540
7541 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7542 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7543 atmega64, atmega128, at43usb355, at94k).
7544
7545 @item -msize
7546 @opindex msize
7547 Output instruction sizes to the asm file.
7548
7549 @item -minit-stack=@var{N}
7550 @opindex minit-stack
7551 Specify the initial stack address, which may be a symbol or numeric value,
7552 @samp{__stack} is the default.
7553
7554 @item -mno-interrupts
7555 @opindex mno-interrupts
7556 Generated code is not compatible with hardware interrupts.
7557 Code size will be smaller.
7558
7559 @item -mcall-prologues
7560 @opindex mcall-prologues
7561 Functions prologues/epilogues expanded as call to appropriate
7562 subroutines.  Code size will be smaller.
7563
7564 @item -mno-tablejump
7565 @opindex mno-tablejump
7566 Do not generate tablejump insns which sometimes increase code size.
7567
7568 @item -mtiny-stack
7569 @opindex mtiny-stack
7570 Change only the low 8 bits of the stack pointer.
7571
7572 @item -mint8
7573 @opindex mint8
7574 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7575 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7576 and long long will be 4 bytes.  Please note that this option does not
7577 comply to the C standards, but it will provide you with smaller code
7578 size.
7579 @end table
7580
7581 @node Blackfin Options
7582 @subsection Blackfin Options
7583 @cindex Blackfin Options
7584
7585 @table @gcctabopt
7586 @item -momit-leaf-frame-pointer
7587 @opindex momit-leaf-frame-pointer
7588 Don't keep the frame pointer in a register for leaf functions.  This
7589 avoids the instructions to save, set up and restore frame pointers and
7590 makes an extra register available in leaf functions.  The option
7591 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7592 which might make debugging harder.
7593
7594 @item -mspecld-anomaly
7595 @opindex mspecld-anomaly
7596 When enabled, the compiler will ensure that the generated code does not
7597 contain speculative loads after jump instructions.  This option is enabled
7598 by default.
7599
7600 @item -mno-specld-anomaly
7601 @opindex mno-specld-anomaly
7602 Don't generate extra code to prevent speculative loads from occurring.
7603
7604 @item -mcsync-anomaly
7605 @opindex mcsync-anomaly
7606 When enabled, the compiler will ensure that the generated code does not
7607 contain CSYNC or SSYNC instructions too soon after conditional branches.
7608 This option is enabled by default.
7609
7610 @item -mno-csync-anomaly
7611 @opindex mno-csync-anomaly
7612 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7613 occurring too soon after a conditional branch.
7614
7615 @item -mlow-64k
7616 @opindex mlow-64k
7617 When enabled, the compiler is free to take advantage of the knowledge that
7618 the entire program fits into the low 64k of memory.
7619
7620 @item -mno-low-64k
7621 @opindex mno-low-64k
7622 Assume that the program is arbitrarily large.  This is the default.
7623
7624 @item -mid-shared-library
7625 @opindex mid-shared-library
7626 Generate code that supports shared libraries via the library ID method.
7627 This allows for execute in place and shared libraries in an environment
7628 without virtual memory management.  This option implies @option{-fPIC}.
7629
7630 @item -mno-id-shared-library
7631 @opindex mno-id-shared-library
7632 Generate code that doesn't assume ID based shared libraries are being used.
7633 This is the default.
7634
7635 @item -mshared-library-id=n
7636 @opindex mshared-library-id
7637 Specified the identification number of the ID based shared library being
7638 compiled.  Specifying a value of 0 will generate more compact code, specifying
7639 other values will force the allocation of that number to the current
7640 library but is no more space or time efficient than omitting this option.
7641
7642 @item -mlong-calls
7643 @itemx -mno-long-calls
7644 @opindex mlong-calls
7645 @opindex mno-long-calls
7646 Tells the compiler to perform function calls by first loading the
7647 address of the function into a register and then performing a subroutine
7648 call on this register.  This switch is needed if the target function
7649 will lie outside of the 24 bit addressing range of the offset based
7650 version of subroutine call instruction.
7651
7652 This feature is not enabled by default.  Specifying
7653 @option{-mno-long-calls} will restore the default behavior.  Note these
7654 switches have no effect on how the compiler generates code to handle
7655 function calls via function pointers.
7656 @end table
7657
7658 @node CRIS Options
7659 @subsection CRIS Options
7660 @cindex CRIS Options
7661
7662 These options are defined specifically for the CRIS ports.
7663
7664 @table @gcctabopt
7665 @item -march=@var{architecture-type}
7666 @itemx -mcpu=@var{architecture-type}
7667 @opindex march
7668 @opindex mcpu
7669 Generate code for the specified architecture.  The choices for
7670 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7671 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7672 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7673 @samp{v10}.
7674
7675 @item -mtune=@var{architecture-type}
7676 @opindex mtune
7677 Tune to @var{architecture-type} everything applicable about the generated
7678 code, except for the ABI and the set of available instructions.  The
7679 choices for @var{architecture-type} are the same as for
7680 @option{-march=@var{architecture-type}}.
7681
7682 @item -mmax-stack-frame=@var{n}
7683 @opindex mmax-stack-frame
7684 Warn when the stack frame of a function exceeds @var{n} bytes.
7685
7686 @item -melinux-stacksize=@var{n}
7687 @opindex melinux-stacksize
7688 Only available with the @samp{cris-axis-aout} target.  Arranges for
7689 indications in the program to the kernel loader that the stack of the
7690 program should be set to @var{n} bytes.
7691
7692 @item -metrax4
7693 @itemx -metrax100
7694 @opindex metrax4
7695 @opindex metrax100
7696 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7697 @option{-march=v3} and @option{-march=v8} respectively.
7698
7699 @item -mmul-bug-workaround
7700 @itemx -mno-mul-bug-workaround
7701 @opindex mmul-bug-workaround
7702 @opindex mno-mul-bug-workaround
7703 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7704 models where it applies.  This option is active by default.
7705
7706 @item -mpdebug
7707 @opindex mpdebug
7708 Enable CRIS-specific verbose debug-related information in the assembly
7709 code.  This option also has the effect to turn off the @samp{#NO_APP}
7710 formatted-code indicator to the assembler at the beginning of the
7711 assembly file.
7712
7713 @item -mcc-init
7714 @opindex mcc-init
7715 Do not use condition-code results from previous instruction; always emit
7716 compare and test instructions before use of condition codes.
7717
7718 @item -mno-side-effects
7719 @opindex mno-side-effects
7720 Do not emit instructions with side-effects in addressing modes other than
7721 post-increment.
7722
7723 @item -mstack-align
7724 @itemx -mno-stack-align
7725 @itemx -mdata-align
7726 @itemx -mno-data-align
7727 @itemx -mconst-align
7728 @itemx -mno-const-align
7729 @opindex mstack-align
7730 @opindex mno-stack-align
7731 @opindex mdata-align
7732 @opindex mno-data-align
7733 @opindex mconst-align
7734 @opindex mno-const-align
7735 These options (no-options) arranges (eliminate arrangements) for the
7736 stack-frame, individual data and constants to be aligned for the maximum
7737 single data access size for the chosen CPU model.  The default is to
7738 arrange for 32-bit alignment.  ABI details such as structure layout are
7739 not affected by these options.
7740
7741 @item -m32-bit
7742 @itemx -m16-bit
7743 @itemx -m8-bit
7744 @opindex m32-bit
7745 @opindex m16-bit
7746 @opindex m8-bit
7747 Similar to the stack- data- and const-align options above, these options
7748 arrange for stack-frame, writable data and constants to all be 32-bit,
7749 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7750
7751 @item -mno-prologue-epilogue
7752 @itemx -mprologue-epilogue
7753 @opindex mno-prologue-epilogue
7754 @opindex mprologue-epilogue
7755 With @option{-mno-prologue-epilogue}, the normal function prologue and
7756 epilogue that sets up the stack-frame are omitted and no return
7757 instructions or return sequences are generated in the code.  Use this
7758 option only together with visual inspection of the compiled code: no
7759 warnings or errors are generated when call-saved registers must be saved,
7760 or storage for local variable needs to be allocated.
7761
7762 @item -mno-gotplt
7763 @itemx -mgotplt
7764 @opindex mno-gotplt
7765 @opindex mgotplt
7766 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7767 instruction sequences that load addresses for functions from the PLT part
7768 of the GOT rather than (traditional on other architectures) calls to the
7769 PLT@.  The default is @option{-mgotplt}.
7770
7771 @item -maout
7772 @opindex maout
7773 Legacy no-op option only recognized with the cris-axis-aout target.
7774
7775 @item -melf
7776 @opindex melf
7777 Legacy no-op option only recognized with the cris-axis-elf and
7778 cris-axis-linux-gnu targets.
7779
7780 @item -melinux
7781 @opindex melinux
7782 Only recognized with the cris-axis-aout target, where it selects a
7783 GNU/linux-like multilib, include files and instruction set for
7784 @option{-march=v8}.
7785
7786 @item -mlinux
7787 @opindex mlinux
7788 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7789
7790 @item -sim
7791 @opindex sim
7792 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7793 to link with input-output functions from a simulator library.  Code,
7794 initialized data and zero-initialized data are allocated consecutively.
7795
7796 @item -sim2
7797 @opindex sim2
7798 Like @option{-sim}, but pass linker options to locate initialized data at
7799 0x40000000 and zero-initialized data at 0x80000000.
7800 @end table
7801
7802 @node CRX Options
7803 @subsection CRX Options
7804 @cindex CRX Options
7805
7806 These options are defined specifically for the CRX ports.
7807
7808 @table @gcctabopt
7809
7810 @item -mmac
7811 @opindex mmac
7812 Enable the use of multiply-accumulate instructions. Disabled by default.
7813
7814 @item -mpush-args
7815 @opindex mpush-args
7816 Push instructions will be used to pass outgoing arguments when functions
7817 are called. Enabled by default.
7818 @end table
7819
7820 @node Darwin Options
7821 @subsection Darwin Options
7822 @cindex Darwin options
7823
7824 These options are defined for all architectures running the Darwin operating
7825 system.
7826
7827 FSF GCC on Darwin does not create ``fat'' object files; it will create
7828 an object file for the single architecture that it was built to
7829 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7830 @option{-arch} options are used; it does so by running the compiler or
7831 linker multiple times and joining the results together with
7832 @file{lipo}.
7833
7834 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7835 @samp{i686}) is determined by the flags that specify the ISA
7836 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7837 @option{-force_cpusubtype_ALL} option can be used to override this.
7838
7839 The Darwin tools vary in their behavior when presented with an ISA
7840 mismatch.  The assembler, @file{as}, will only permit instructions to
7841 be used that are valid for the subtype of the file it is generating,
7842 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7843 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7844 and print an error if asked to create a shared library with a less
7845 restrictive subtype than its input files (for instance, trying to put
7846 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7847 for executables, @file{ld}, will quietly give the executable the most
7848 restrictive subtype of any of its input files.
7849
7850 @table @gcctabopt
7851 @item -F@var{dir}
7852 @opindex F
7853 Add the framework directory @var{dir} to the head of the list of
7854 directories to be searched for header files.  These directories are
7855 interleaved with those specified by @option{-I} options and are
7856 scanned in a left-to-right order.
7857
7858 A framework directory is a directory with frameworks in it.  A
7859 framework is a directory with a @samp{"Headers"} and/or
7860 @samp{"PrivateHeaders"} directory contained directly in it that ends
7861 in @samp{".framework"}.  The name of a framework is the name of this
7862 directory excluding the @samp{".framework"}.  Headers associated with
7863 the framework are found in one of those two directories, with
7864 @samp{"Headers"} being searched first.  A subframework is a framework
7865 directory that is in a framework's @samp{"Frameworks"} directory.
7866 Includes of subframework headers can only appear in a header of a
7867 framework that contains the subframework, or in a sibling subframework
7868 header.  Two subframeworks are siblings if they occur in the same
7869 framework.  A subframework should not have the same name as a
7870 framework, a warning will be issued if this is violated.  Currently a
7871 subframework cannot have subframeworks, in the future, the mechanism
7872 may be extended to support this.  The standard frameworks can be found
7873 in @samp{"/System/Library/Frameworks"} and
7874 @samp{"/Library/Frameworks"}.  An example include looks like
7875 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7876 the name of the framework and header.h is found in the
7877 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7878
7879 @item -gused
7880 @opindex -gused
7881 Emit debugging information for symbols that are used.  For STABS
7882 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7883 This is by default ON@.
7884
7885 @item -gfull
7886 @opindex -gfull
7887 Emit debugging information for all symbols and types.
7888
7889 @item -mmacosx-version-min=@var{version}
7890 The earliest version of MacOS X that this executable will run on
7891 is @var{version}.  Typical values of @var{version} include @code{10.1},
7892 @code{10.2}, and @code{10.3.9}.
7893
7894 The default for this option is to make choices that seem to be most
7895 useful.  
7896
7897 @item -mone-byte-bool
7898 @opindex -mone-byte-bool
7899 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7900 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7901 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7902 option has no effect on x86.
7903
7904 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7905 to generate code that is not binary compatible with code generated
7906 without that switch.  Using this switch may require recompiling all
7907 other modules in a program, including system libraries.  Use this
7908 switch to conform to a non-default data model.
7909
7910 @item -mfix-and-continue
7911 @itemx -ffix-and-continue
7912 @itemx -findirect-data
7913 @opindex mfix-and-continue
7914 @opindex ffix-and-continue
7915 @opindex findirect-data
7916 Generate code suitable for fast turn around development.  Needed to
7917 enable gdb to dynamically load @code{.o} files into already running
7918 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7919 are provided for backwards compatibility.
7920
7921 @item -all_load
7922 @opindex all_load
7923 Loads all members of static archive libraries.
7924 See man ld(1) for more information.
7925
7926 @item -arch_errors_fatal
7927 @opindex arch_errors_fatal
7928 Cause the errors having to do with files that have the wrong architecture
7929 to be fatal.
7930
7931 @item -bind_at_load
7932 @opindex bind_at_load
7933 Causes the output file to be marked such that the dynamic linker will
7934 bind all undefined references when the file is loaded or launched.
7935
7936 @item -bundle
7937 @opindex bundle
7938 Produce a Mach-o bundle format file.
7939 See man ld(1) for more information.
7940
7941 @item -bundle_loader @var{executable}
7942 @opindex bundle_loader
7943 This option specifies the @var{executable} that will be loading the build
7944 output file being linked.  See man ld(1) for more information.
7945
7946 @item -dynamiclib
7947 @opindex -dynamiclib
7948 When passed this option, GCC will produce a dynamic library instead of
7949 an executable when linking, using the Darwin @file{libtool} command.
7950
7951 @item -force_cpusubtype_ALL
7952 @opindex -force_cpusubtype_ALL
7953 This causes GCC's output file to have the @var{ALL} subtype, instead of
7954 one controlled by the @option{-mcpu} or @option{-march} option.
7955
7956 @item -allowable_client  @var{client_name}
7957 @itemx -client_name
7958 @itemx -compatibility_version
7959 @itemx -current_version
7960 @itemx -dead_strip
7961 @itemx -dependency-file
7962 @itemx -dylib_file
7963 @itemx -dylinker_install_name
7964 @itemx -dynamic
7965 @itemx -exported_symbols_list
7966 @itemx -filelist
7967 @itemx -flat_namespace
7968 @itemx -force_flat_namespace
7969 @itemx -headerpad_max_install_names
7970 @itemx -image_base
7971 @itemx -init
7972 @itemx -install_name
7973 @itemx -keep_private_externs
7974 @itemx -multi_module
7975 @itemx -multiply_defined
7976 @itemx -multiply_defined_unused
7977 @itemx -noall_load
7978 @itemx -no_dead_strip_inits_and_terms
7979 @itemx -nofixprebinding
7980 @itemx -nomultidefs
7981 @itemx -noprebind
7982 @itemx -noseglinkedit
7983 @itemx -pagezero_size
7984 @itemx -prebind
7985 @itemx -prebind_all_twolevel_modules
7986 @itemx -private_bundle
7987 @itemx -read_only_relocs
7988 @itemx -sectalign
7989 @itemx -sectobjectsymbols
7990 @itemx -whyload
7991 @itemx -seg1addr
7992 @itemx -sectcreate
7993 @itemx -sectobjectsymbols
7994 @itemx -sectorder
7995 @itemx -segaddr
7996 @itemx -segs_read_only_addr
7997 @itemx -segs_read_write_addr
7998 @itemx -seg_addr_table
7999 @itemx -seg_addr_table_filename
8000 @itemx -seglinkedit
8001 @itemx -segprot
8002 @itemx -segs_read_only_addr
8003 @itemx -segs_read_write_addr
8004 @itemx -single_module
8005 @itemx -static
8006 @itemx -sub_library
8007 @itemx -sub_umbrella
8008 @itemx -twolevel_namespace
8009 @itemx -umbrella
8010 @itemx -undefined
8011 @itemx -unexported_symbols_list
8012 @itemx -weak_reference_mismatches
8013 @itemx -whatsloaded
8014
8015 @opindex allowable_client
8016 @opindex client_name
8017 @opindex compatibility_version
8018 @opindex current_version
8019 @opindex dead_strip
8020 @opindex dependency-file
8021 @opindex dylib_file
8022 @opindex dylinker_install_name
8023 @opindex dynamic
8024 @opindex exported_symbols_list
8025 @opindex filelist
8026 @opindex flat_namespace
8027 @opindex force_flat_namespace
8028 @opindex headerpad_max_install_names
8029 @opindex image_base
8030 @opindex init
8031 @opindex install_name
8032 @opindex keep_private_externs
8033 @opindex multi_module
8034 @opindex multiply_defined
8035 @opindex multiply_defined_unused
8036 @opindex noall_load
8037 @opindex no_dead_strip_inits_and_terms
8038 @opindex nofixprebinding
8039 @opindex nomultidefs
8040 @opindex noprebind
8041 @opindex noseglinkedit
8042 @opindex pagezero_size
8043 @opindex prebind
8044 @opindex prebind_all_twolevel_modules
8045 @opindex private_bundle
8046 @opindex read_only_relocs
8047 @opindex sectalign
8048 @opindex sectobjectsymbols
8049 @opindex whyload
8050 @opindex seg1addr
8051 @opindex sectcreate
8052 @opindex sectobjectsymbols
8053 @opindex sectorder
8054 @opindex segaddr
8055 @opindex segs_read_only_addr
8056 @opindex segs_read_write_addr
8057 @opindex seg_addr_table
8058 @opindex seg_addr_table_filename
8059 @opindex seglinkedit
8060 @opindex segprot
8061 @opindex segs_read_only_addr
8062 @opindex segs_read_write_addr
8063 @opindex single_module
8064 @opindex static
8065 @opindex sub_library
8066 @opindex sub_umbrella
8067 @opindex twolevel_namespace
8068 @opindex umbrella
8069 @opindex undefined
8070 @opindex unexported_symbols_list
8071 @opindex weak_reference_mismatches
8072 @opindex whatsloaded
8073
8074 These options are passed to the Darwin linker.  The Darwin linker man page
8075 describes them in detail.
8076 @end table
8077
8078 @node DEC Alpha Options
8079 @subsection DEC Alpha Options
8080
8081 These @samp{-m} options are defined for the DEC Alpha implementations:
8082
8083 @table @gcctabopt
8084 @item -mno-soft-float
8085 @itemx -msoft-float
8086 @opindex mno-soft-float
8087 @opindex msoft-float
8088 Use (do not use) the hardware floating-point instructions for
8089 floating-point operations.  When @option{-msoft-float} is specified,
8090 functions in @file{libgcc.a} will be used to perform floating-point
8091 operations.  Unless they are replaced by routines that emulate the
8092 floating-point operations, or compiled in such a way as to call such
8093 emulations routines, these routines will issue floating-point
8094 operations.   If you are compiling for an Alpha without floating-point
8095 operations, you must ensure that the library is built so as not to call
8096 them.
8097
8098 Note that Alpha implementations without floating-point operations are
8099 required to have floating-point registers.
8100
8101 @item -mfp-reg
8102 @itemx -mno-fp-regs
8103 @opindex mfp-reg
8104 @opindex mno-fp-regs
8105 Generate code that uses (does not use) the floating-point register set.
8106 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8107 register set is not used, floating point operands are passed in integer
8108 registers as if they were integers and floating-point results are passed
8109 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8110 so any function with a floating-point argument or return value called by code
8111 compiled with @option{-mno-fp-regs} must also be compiled with that
8112 option.
8113
8114 A typical use of this option is building a kernel that does not use,
8115 and hence need not save and restore, any floating-point registers.
8116
8117 @item -mieee
8118 @opindex mieee
8119 The Alpha architecture implements floating-point hardware optimized for
8120 maximum performance.  It is mostly compliant with the IEEE floating
8121 point standard.  However, for full compliance, software assistance is
8122 required.  This option generates code fully IEEE compliant code
8123 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8124 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8125 defined during compilation.  The resulting code is less efficient but is
8126 able to correctly support denormalized numbers and exceptional IEEE
8127 values such as not-a-number and plus/minus infinity.  Other Alpha
8128 compilers call this option @option{-ieee_with_no_inexact}.
8129
8130 @item -mieee-with-inexact
8131 @opindex mieee-with-inexact
8132 This is like @option{-mieee} except the generated code also maintains
8133 the IEEE @var{inexact-flag}.  Turning on this option causes the
8134 generated code to implement fully-compliant IEEE math.  In addition to
8135 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8136 macro.  On some Alpha implementations the resulting code may execute
8137 significantly slower than the code generated by default.  Since there is
8138 very little code that depends on the @var{inexact-flag}, you should
8139 normally not specify this option.  Other Alpha compilers call this
8140 option @option{-ieee_with_inexact}.
8141
8142 @item -mfp-trap-mode=@var{trap-mode}
8143 @opindex mfp-trap-mode
8144 This option controls what floating-point related traps are enabled.
8145 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8146 The trap mode can be set to one of four values:
8147
8148 @table @samp
8149 @item n
8150 This is the default (normal) setting.  The only traps that are enabled
8151 are the ones that cannot be disabled in software (e.g., division by zero
8152 trap).
8153
8154 @item u
8155 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8156 as well.
8157
8158 @item su
8159 Like @samp{su}, but the instructions are marked to be safe for software
8160 completion (see Alpha architecture manual for details).
8161
8162 @item sui
8163 Like @samp{su}, but inexact traps are enabled as well.
8164 @end table
8165
8166 @item -mfp-rounding-mode=@var{rounding-mode}
8167 @opindex mfp-rounding-mode
8168 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8169 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8170 of:
8171
8172 @table @samp
8173 @item n
8174 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8175 the nearest machine number or towards the even machine number in case
8176 of a tie.
8177
8178 @item m
8179 Round towards minus infinity.
8180
8181 @item c
8182 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8183
8184 @item d
8185 Dynamic rounding mode.  A field in the floating point control register
8186 (@var{fpcr}, see Alpha architecture reference manual) controls the
8187 rounding mode in effect.  The C library initializes this register for
8188 rounding towards plus infinity.  Thus, unless your program modifies the
8189 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8190 @end table
8191
8192 @item -mtrap-precision=@var{trap-precision}
8193 @opindex mtrap-precision
8194 In the Alpha architecture, floating point traps are imprecise.  This
8195 means without software assistance it is impossible to recover from a
8196 floating trap and program execution normally needs to be terminated.
8197 GCC can generate code that can assist operating system trap handlers
8198 in determining the exact location that caused a floating point trap.
8199 Depending on the requirements of an application, different levels of
8200 precisions can be selected:
8201
8202 @table @samp
8203 @item p
8204 Program precision.  This option is the default and means a trap handler
8205 can only identify which program caused a floating point exception.
8206
8207 @item f
8208 Function precision.  The trap handler can determine the function that
8209 caused a floating point exception.
8210
8211 @item i
8212 Instruction precision.  The trap handler can determine the exact
8213 instruction that caused a floating point exception.
8214 @end table
8215
8216 Other Alpha compilers provide the equivalent options called
8217 @option{-scope_safe} and @option{-resumption_safe}.
8218
8219 @item -mieee-conformant
8220 @opindex mieee-conformant
8221 This option marks the generated code as IEEE conformant.  You must not
8222 use this option unless you also specify @option{-mtrap-precision=i} and either
8223 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8224 is to emit the line @samp{.eflag 48} in the function prologue of the
8225 generated assembly file.  Under DEC Unix, this has the effect that
8226 IEEE-conformant math library routines will be linked in.
8227
8228 @item -mbuild-constants
8229 @opindex mbuild-constants
8230 Normally GCC examines a 32- or 64-bit integer constant to
8231 see if it can construct it from smaller constants in two or three
8232 instructions.  If it cannot, it will output the constant as a literal and
8233 generate code to load it from the data segment at runtime.
8234
8235 Use this option to require GCC to construct @emph{all} integer constants
8236 using code, even if it takes more instructions (the maximum is six).
8237
8238 You would typically use this option to build a shared library dynamic
8239 loader.  Itself a shared library, it must relocate itself in memory
8240 before it can find the variables and constants in its own data segment.
8241
8242 @item -malpha-as
8243 @itemx -mgas
8244 @opindex malpha-as
8245 @opindex mgas
8246 Select whether to generate code to be assembled by the vendor-supplied
8247 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8248
8249 @item -mbwx
8250 @itemx -mno-bwx
8251 @itemx -mcix
8252 @itemx -mno-cix
8253 @itemx -mfix
8254 @itemx -mno-fix
8255 @itemx -mmax
8256 @itemx -mno-max
8257 @opindex mbwx
8258 @opindex mno-bwx
8259 @opindex mcix
8260 @opindex mno-cix
8261 @opindex mfix
8262 @opindex mno-fix
8263 @opindex mmax
8264 @opindex mno-max
8265 Indicate whether GCC should generate code to use the optional BWX,
8266 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8267 sets supported by the CPU type specified via @option{-mcpu=} option or that
8268 of the CPU on which GCC was built if none was specified.
8269
8270 @item -mfloat-vax
8271 @itemx -mfloat-ieee
8272 @opindex mfloat-vax
8273 @opindex mfloat-ieee
8274 Generate code that uses (does not use) VAX F and G floating point
8275 arithmetic instead of IEEE single and double precision.
8276
8277 @item -mexplicit-relocs
8278 @itemx -mno-explicit-relocs
8279 @opindex mexplicit-relocs
8280 @opindex mno-explicit-relocs
8281 Older Alpha assemblers provided no way to generate symbol relocations
8282 except via assembler macros.  Use of these macros does not allow
8283 optimal instruction scheduling.  GNU binutils as of version 2.12
8284 supports a new syntax that allows the compiler to explicitly mark
8285 which relocations should apply to which instructions.  This option
8286 is mostly useful for debugging, as GCC detects the capabilities of
8287 the assembler when it is built and sets the default accordingly.
8288
8289 @item -msmall-data
8290 @itemx -mlarge-data
8291 @opindex msmall-data
8292 @opindex mlarge-data
8293 When @option{-mexplicit-relocs} is in effect, static data is
8294 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8295 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8296 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8297 16-bit relocations off of the @code{$gp} register.  This limits the
8298 size of the small data area to 64KB, but allows the variables to be
8299 directly accessed via a single instruction.
8300
8301 The default is @option{-mlarge-data}.  With this option the data area
8302 is limited to just below 2GB@.  Programs that require more than 2GB of
8303 data must use @code{malloc} or @code{mmap} to allocate the data in the
8304 heap instead of in the program's data segment.
8305
8306 When generating code for shared libraries, @option{-fpic} implies
8307 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8308
8309 @item -msmall-text
8310 @itemx -mlarge-text
8311 @opindex msmall-text
8312 @opindex mlarge-text
8313 When @option{-msmall-text} is used, the compiler assumes that the
8314 code of the entire program (or shared library) fits in 4MB, and is
8315 thus reachable with a branch instruction.  When @option{-msmall-data}
8316 is used, the compiler can assume that all local symbols share the
8317 same @code{$gp} value, and thus reduce the number of instructions
8318 required for a function call from 4 to 1.
8319
8320 The default is @option{-mlarge-text}.
8321
8322 @item -mcpu=@var{cpu_type}
8323 @opindex mcpu
8324 Set the instruction set and instruction scheduling parameters for
8325 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8326 style name or the corresponding chip number.  GCC supports scheduling
8327 parameters for the EV4, EV5 and EV6 family of processors and will
8328 choose the default values for the instruction set from the processor
8329 you specify.  If you do not specify a processor type, GCC will default
8330 to the processor on which the compiler was built.
8331
8332 Supported values for @var{cpu_type} are
8333
8334 @table @samp
8335 @item ev4
8336 @itemx ev45
8337 @itemx 21064
8338 Schedules as an EV4 and has no instruction set extensions.
8339
8340 @item ev5
8341 @itemx 21164
8342 Schedules as an EV5 and has no instruction set extensions.
8343
8344 @item ev56
8345 @itemx 21164a
8346 Schedules as an EV5 and supports the BWX extension.
8347
8348 @item pca56
8349 @itemx 21164pc
8350 @itemx 21164PC
8351 Schedules as an EV5 and supports the BWX and MAX extensions.
8352
8353 @item ev6
8354 @itemx 21264
8355 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8356
8357 @item ev67
8358 @itemx 21264a
8359 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8360 @end table
8361
8362 @item -mtune=@var{cpu_type}
8363 @opindex mtune
8364 Set only the instruction scheduling parameters for machine type
8365 @var{cpu_type}.  The instruction set is not changed.
8366
8367 @item -mmemory-latency=@var{time}
8368 @opindex mmemory-latency
8369 Sets the latency the scheduler should assume for typical memory
8370 references as seen by the application.  This number is highly
8371 dependent on the memory access patterns used by the application
8372 and the size of the external cache on the machine.
8373
8374 Valid options for @var{time} are
8375
8376 @table @samp
8377 @item @var{number}
8378 A decimal number representing clock cycles.
8379
8380 @item L1
8381 @itemx L2
8382 @itemx L3
8383 @itemx main
8384 The compiler contains estimates of the number of clock cycles for
8385 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8386 (also called Dcache, Scache, and Bcache), as well as to main memory.
8387 Note that L3 is only valid for EV5.
8388
8389 @end table
8390 @end table
8391
8392 @node DEC Alpha/VMS Options
8393 @subsection DEC Alpha/VMS Options
8394
8395 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8396
8397 @table @gcctabopt
8398 @item -mvms-return-codes
8399 @opindex mvms-return-codes
8400 Return VMS condition codes from main.  The default is to return POSIX
8401 style condition (e.g.@ error) codes.
8402 @end table
8403
8404 @node FRV Options
8405 @subsection FRV Options
8406 @cindex FRV Options
8407
8408 @table @gcctabopt
8409 @item -mgpr-32
8410 @opindex mgpr-32
8411
8412 Only use the first 32 general purpose registers.
8413
8414 @item -mgpr-64
8415 @opindex mgpr-64
8416
8417 Use all 64 general purpose registers.
8418
8419 @item -mfpr-32
8420 @opindex mfpr-32
8421
8422 Use only the first 32 floating point registers.
8423
8424 @item -mfpr-64
8425 @opindex mfpr-64
8426
8427 Use all 64 floating point registers
8428
8429 @item -mhard-float
8430 @opindex mhard-float
8431
8432 Use hardware instructions for floating point operations.
8433
8434 @item -msoft-float
8435 @opindex msoft-float
8436
8437 Use library routines for floating point operations.
8438
8439 @item -malloc-cc
8440 @opindex malloc-cc
8441
8442 Dynamically allocate condition code registers.
8443
8444 @item -mfixed-cc
8445 @opindex mfixed-cc
8446
8447 Do not try to dynamically allocate condition code registers, only
8448 use @code{icc0} and @code{fcc0}.
8449
8450 @item -mdword
8451 @opindex mdword
8452
8453 Change ABI to use double word insns.
8454
8455 @item -mno-dword
8456 @opindex mno-dword
8457
8458 Do not use double word instructions.
8459
8460 @item -mdouble
8461 @opindex mdouble
8462
8463 Use floating point double instructions.
8464
8465 @item -mno-double
8466 @opindex mno-double
8467
8468 Do not use floating point double instructions.
8469
8470 @item -mmedia
8471 @opindex mmedia
8472
8473 Use media instructions.
8474
8475 @item -mno-media
8476 @opindex mno-media
8477
8478 Do not use media instructions.
8479
8480 @item -mmuladd
8481 @opindex mmuladd
8482
8483 Use multiply and add/subtract instructions.
8484
8485 @item -mno-muladd
8486 @opindex mno-muladd
8487
8488 Do not use multiply and add/subtract instructions.
8489
8490 @item -mfdpic
8491 @opindex mfdpic
8492
8493 Select the FDPIC ABI, that uses function descriptors to represent
8494 pointers to functions.  Without any PIC/PIE-related options, it
8495 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8496 assumes GOT entries and small data are within a 12-bit range from the
8497 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8498 are computed with 32 bits.
8499
8500 @item -minline-plt
8501 @opindex minline-plt
8502
8503 Enable inlining of PLT entries in function calls to functions that are
8504 not known to bind locally.  It has no effect without @option{-mfdpic}.
8505 It's enabled by default if optimizing for speed and compiling for
8506 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8507 optimization option such as @option{-O3} or above is present in the
8508 command line.
8509
8510 @item -mTLS
8511 @opindex TLS
8512
8513 Assume a large TLS segment when generating thread-local code.
8514
8515 @item -mtls
8516 @opindex tls
8517
8518 Do not assume a large TLS segment when generating thread-local code.
8519
8520 @item -mgprel-ro
8521 @opindex mgprel-ro
8522
8523 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8524 that is known to be in read-only sections.  It's enabled by default,
8525 except for @option{-fpic} or @option{-fpie}: even though it may help
8526 make the global offset table smaller, it trades 1 instruction for 4.
8527 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8528 one of which may be shared by multiple symbols, and it avoids the need
8529 for a GOT entry for the referenced symbol, so it's more likely to be a
8530 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8531
8532 @item -multilib-library-pic
8533 @opindex multilib-library-pic
8534
8535 Link with the (library, not FD) pic libraries.  It's implied by
8536 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8537 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8538 it explicitly.
8539
8540 @item -mlinked-fp
8541 @opindex mlinked-fp
8542
8543 Follow the EABI requirement of always creating a frame pointer whenever
8544 a stack frame is allocated.  This option is enabled by default and can
8545 be disabled with @option{-mno-linked-fp}.
8546
8547 @item -mlong-calls
8548 @opindex mlong-calls
8549
8550 Use indirect addressing to call functions outside the current
8551 compilation unit.  This allows the functions to be placed anywhere
8552 within the 32-bit address space.
8553
8554 @item -malign-labels
8555 @opindex malign-labels
8556
8557 Try to align labels to an 8-byte boundary by inserting nops into the
8558 previous packet.  This option only has an effect when VLIW packing
8559 is enabled.  It doesn't create new packets; it merely adds nops to
8560 existing ones.
8561
8562 @item -mlibrary-pic
8563 @opindex mlibrary-pic
8564
8565 Generate position-independent EABI code.
8566
8567 @item -macc-4
8568 @opindex macc-4
8569
8570 Use only the first four media accumulator registers.
8571
8572 @item -macc-8
8573 @opindex macc-8
8574
8575 Use all eight media accumulator registers.
8576
8577 @item -mpack
8578 @opindex mpack
8579
8580 Pack VLIW instructions.
8581
8582 @item -mno-pack
8583 @opindex mno-pack
8584
8585 Do not pack VLIW instructions.
8586
8587 @item -mno-eflags
8588 @opindex mno-eflags
8589
8590 Do not mark ABI switches in e_flags.
8591
8592 @item -mcond-move
8593 @opindex mcond-move
8594
8595 Enable the use of conditional-move instructions (default).
8596
8597 This switch is mainly for debugging the compiler and will likely be removed
8598 in a future version.
8599
8600 @item -mno-cond-move
8601 @opindex mno-cond-move
8602
8603 Disable the use of conditional-move instructions.
8604
8605 This switch is mainly for debugging the compiler and will likely be removed
8606 in a future version.
8607
8608 @item -mscc
8609 @opindex mscc
8610
8611 Enable the use of conditional set instructions (default).
8612
8613 This switch is mainly for debugging the compiler and will likely be removed
8614 in a future version.
8615
8616 @item -mno-scc
8617 @opindex mno-scc
8618
8619 Disable the use of conditional set instructions.
8620
8621 This switch is mainly for debugging the compiler and will likely be removed
8622 in a future version.
8623
8624 @item -mcond-exec
8625 @opindex mcond-exec
8626
8627 Enable the use of conditional execution (default).
8628
8629 This switch is mainly for debugging the compiler and will likely be removed
8630 in a future version.
8631
8632 @item -mno-cond-exec
8633 @opindex mno-cond-exec
8634
8635 Disable the use of conditional execution.
8636
8637 This switch is mainly for debugging the compiler and will likely be removed
8638 in a future version.
8639
8640 @item -mvliw-branch
8641 @opindex mvliw-branch
8642
8643 Run a pass to pack branches into VLIW instructions (default).
8644
8645 This switch is mainly for debugging the compiler and will likely be removed
8646 in a future version.
8647
8648 @item -mno-vliw-branch
8649 @opindex mno-vliw-branch
8650
8651 Do not run a pass to pack branches into VLIW instructions.
8652
8653 This switch is mainly for debugging the compiler and will likely be removed
8654 in a future version.
8655
8656 @item -mmulti-cond-exec
8657 @opindex mmulti-cond-exec
8658
8659 Enable optimization of @code{&&} and @code{||} in conditional execution
8660 (default).
8661
8662 This switch is mainly for debugging the compiler and will likely be removed
8663 in a future version.
8664
8665 @item -mno-multi-cond-exec
8666 @opindex mno-multi-cond-exec
8667
8668 Disable optimization of @code{&&} and @code{||} in conditional execution.
8669
8670 This switch is mainly for debugging the compiler and will likely be removed
8671 in a future version.
8672
8673 @item -mnested-cond-exec
8674 @opindex mnested-cond-exec
8675
8676 Enable nested conditional execution optimizations (default).
8677
8678 This switch is mainly for debugging the compiler and will likely be removed
8679 in a future version.
8680
8681 @item -mno-nested-cond-exec
8682 @opindex mno-nested-cond-exec
8683
8684 Disable nested conditional execution optimizations.
8685
8686 This switch is mainly for debugging the compiler and will likely be removed
8687 in a future version.
8688
8689 @item -moptimize-membar
8690 @opindex moptimize-membar
8691
8692 This switch removes redundant @code{membar} instructions from the
8693 compiler generated code.  It is enabled by default.
8694
8695 @item -mno-optimize-membar
8696 @opindex mno-optimize-membar
8697
8698 This switch disables the automatic removal of redundant @code{membar}
8699 instructions from the generated code.
8700
8701 @item -mtomcat-stats
8702 @opindex mtomcat-stats
8703
8704 Cause gas to print out tomcat statistics.
8705
8706 @item -mcpu=@var{cpu}
8707 @opindex mcpu
8708
8709 Select the processor type for which to generate code.  Possible values are
8710 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8711 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8712
8713 @end table
8714
8715 @node H8/300 Options
8716 @subsection H8/300 Options
8717
8718 These @samp{-m} options are defined for the H8/300 implementations:
8719
8720 @table @gcctabopt
8721 @item -mrelax
8722 @opindex mrelax
8723 Shorten some address references at link time, when possible; uses the
8724 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8725 ld, Using ld}, for a fuller description.
8726
8727 @item -mh
8728 @opindex mh
8729 Generate code for the H8/300H@.
8730
8731 @item -ms
8732 @opindex ms
8733 Generate code for the H8S@.
8734
8735 @item -mn
8736 @opindex mn
8737 Generate code for the H8S and H8/300H in the normal mode.  This switch
8738 must be used either with @option{-mh} or @option{-ms}.
8739
8740 @item -ms2600
8741 @opindex ms2600
8742 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8743
8744 @item -mint32
8745 @opindex mint32
8746 Make @code{int} data 32 bits by default.
8747
8748 @item -malign-300
8749 @opindex malign-300
8750 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8751 The default for the H8/300H and H8S is to align longs and floats on 4
8752 byte boundaries.
8753 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8754 This option has no effect on the H8/300.
8755 @end table
8756
8757 @node HPPA Options
8758 @subsection HPPA Options
8759 @cindex HPPA Options
8760
8761 These @samp{-m} options are defined for the HPPA family of computers:
8762
8763 @table @gcctabopt
8764 @item -march=@var{architecture-type}
8765 @opindex march
8766 Generate code for the specified architecture.  The choices for
8767 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8768 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8769 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8770 architecture option for your machine.  Code compiled for lower numbered
8771 architectures will run on higher numbered architectures, but not the
8772 other way around.
8773
8774 @item -mpa-risc-1-0
8775 @itemx -mpa-risc-1-1
8776 @itemx -mpa-risc-2-0
8777 @opindex mpa-risc-1-0
8778 @opindex mpa-risc-1-1
8779 @opindex mpa-risc-2-0
8780 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8781
8782 @item -mbig-switch
8783 @opindex mbig-switch
8784 Generate code suitable for big switch tables.  Use this option only if
8785 the assembler/linker complain about out of range branches within a switch
8786 table.
8787
8788 @item -mjump-in-delay
8789 @opindex mjump-in-delay
8790 Fill delay slots of function calls with unconditional jump instructions
8791 by modifying the return pointer for the function call to be the target
8792 of the conditional jump.
8793
8794 @item -mdisable-fpregs
8795 @opindex mdisable-fpregs
8796 Prevent floating point registers from being used in any manner.  This is
8797 necessary for compiling kernels which perform lazy context switching of
8798 floating point registers.  If you use this option and attempt to perform
8799 floating point operations, the compiler will abort.
8800
8801 @item -mdisable-indexing
8802 @opindex mdisable-indexing
8803 Prevent the compiler from using indexing address modes.  This avoids some
8804 rather obscure problems when compiling MIG generated code under MACH@.
8805
8806 @item -mno-space-regs
8807 @opindex mno-space-regs
8808 Generate code that assumes the target has no space registers.  This allows
8809 GCC to generate faster indirect calls and use unscaled index address modes.
8810
8811 Such code is suitable for level 0 PA systems and kernels.
8812
8813 @item -mfast-indirect-calls
8814 @opindex mfast-indirect-calls
8815 Generate code that assumes calls never cross space boundaries.  This
8816 allows GCC to emit code which performs faster indirect calls.
8817
8818 This option will not work in the presence of shared libraries or nested
8819 functions.
8820
8821 @item -mfixed-range=@var{register-range}
8822 @opindex mfixed-range
8823 Generate code treating the given register range as fixed registers.
8824 A fixed register is one that the register allocator can not use.  This is
8825 useful when compiling kernel code.  A register range is specified as
8826 two registers separated by a dash.  Multiple register ranges can be
8827 specified separated by a comma.
8828
8829 @item -mlong-load-store
8830 @opindex mlong-load-store
8831 Generate 3-instruction load and store sequences as sometimes required by
8832 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8833 the HP compilers.
8834
8835 @item -mportable-runtime
8836 @opindex mportable-runtime
8837 Use the portable calling conventions proposed by HP for ELF systems.
8838
8839 @item -mgas
8840 @opindex mgas
8841 Enable the use of assembler directives only GAS understands.
8842
8843 @item -mschedule=@var{cpu-type}
8844 @opindex mschedule
8845 Schedule code according to the constraints for the machine type
8846 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8847 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8848 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8849 proper scheduling option for your machine.  The default scheduling is
8850 @samp{8000}.
8851
8852 @item -mlinker-opt
8853 @opindex mlinker-opt
8854 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8855 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8856 linkers in which they give bogus error messages when linking some programs.
8857
8858 @item -msoft-float
8859 @opindex msoft-float
8860 Generate output containing library calls for floating point.
8861 @strong{Warning:} the requisite libraries are not available for all HPPA
8862 targets.  Normally the facilities of the machine's usual C compiler are
8863 used, but this cannot be done directly in cross-compilation.  You must make
8864 your own arrangements to provide suitable library functions for
8865 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8866 does provide software floating point support.
8867
8868 @option{-msoft-float} changes the calling convention in the output file;
8869 therefore, it is only useful if you compile @emph{all} of a program with
8870 this option.  In particular, you need to compile @file{libgcc.a}, the
8871 library that comes with GCC, with @option{-msoft-float} in order for
8872 this to work.
8873
8874 @item -msio
8875 @opindex msio
8876 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8877 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8878 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8879 options are available under HP-UX and HI-UX@.
8880
8881 @item -mgnu-ld
8882 @opindex gnu-ld
8883 Use GNU ld specific options.  This passes @option{-shared} to ld when
8884 building a shared library.  It is the default when GCC is configured,
8885 explicitly or implicitly, with the GNU linker.  This option does not
8886 have any affect on which ld is called, it only changes what parameters
8887 are passed to that ld.  The ld that is called is determined by the
8888 @option{--with-ld} configure option, GCC's program search path, and
8889 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8890 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8891 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8892
8893 @item -mhp-ld
8894 @opindex hp-ld
8895 Use HP ld specific options.  This passes @option{-b} to ld when building
8896 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8897 links.  It is the default when GCC is configured, explicitly or
8898 implicitly, with the HP linker.  This option does not have any affect on
8899 which ld is called, it only changes what parameters are passed to that
8900 ld.  The ld that is called is determined by the @option{--with-ld}
8901 configure option, GCC's program search path, and finally by the user's
8902 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8903 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8904 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8905
8906 @item -mlong-calls
8907 @opindex mno-long-calls
8908 Generate code that uses long call sequences.  This ensures that a call
8909 is always able to reach linker generated stubs.  The default is to generate
8910 long calls only when the distance from the call site to the beginning
8911 of the function or translation unit, as the case may be, exceeds a
8912 predefined limit set by the branch type being used.  The limits for
8913 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8914 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8915 240,000 bytes.
8916
8917 Distances are measured from the beginning of functions when using the
8918 @option{-ffunction-sections} option, or when using the @option{-mgas}
8919 and @option{-mno-portable-runtime} options together under HP-UX with
8920 the SOM linker.
8921
8922 It is normally not desirable to use this option as it will degrade
8923 performance.  However, it may be useful in large applications,
8924 particularly when partial linking is used to build the application.
8925
8926 The types of long calls used depends on the capabilities of the
8927 assembler and linker, and the type of code being generated.  The
8928 impact on systems that support long absolute calls, and long pic
8929 symbol-difference or pc-relative calls should be relatively small.
8930 However, an indirect call is used on 32-bit ELF systems in pic code
8931 and it is quite long.
8932
8933 @item -munix=@var{unix-std}
8934 @opindex march
8935 Generate compiler predefines and select a startfile for the specified
8936 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8937 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8938 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8939 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8940 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8941 and later.
8942
8943 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8944 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8945 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8946 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8947 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8948 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8949
8950 It is @emph{important} to note that this option changes the interfaces
8951 for various library routines.  It also affects the operational behavior
8952 of the C library.  Thus, @emph{extreme} care is needed in using this
8953 option.
8954
8955 Library code that is intended to operate with more than one UNIX
8956 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8957 as appropriate.  Most GNU software doesn't provide this capability.
8958
8959 @item -nolibdld
8960 @opindex nolibdld
8961 Suppress the generation of link options to search libdld.sl when the
8962 @option{-static} option is specified on HP-UX 10 and later.
8963
8964 @item -static
8965 @opindex static
8966 The HP-UX implementation of setlocale in libc has a dependency on
8967 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8968 when the @option{-static} option is specified, special link options
8969 are needed to resolve this dependency.
8970
8971 On HP-UX 10 and later, the GCC driver adds the necessary options to
8972 link with libdld.sl when the @option{-static} option is specified.
8973 This causes the resulting binary to be dynamic.  On the 64-bit port,
8974 the linkers generate dynamic binaries by default in any case.  The
8975 @option{-nolibdld} option can be used to prevent the GCC driver from
8976 adding these link options.
8977
8978 @item -threads
8979 @opindex threads
8980 Add support for multithreading with the @dfn{dce thread} library
8981 under HP-UX@.  This option sets flags for both the preprocessor and
8982 linker.
8983 @end table
8984
8985 @node i386 and x86-64 Options
8986 @subsection Intel 386 and AMD x86-64 Options
8987 @cindex i386 Options
8988 @cindex x86-64 Options
8989 @cindex Intel 386 Options
8990 @cindex AMD x86-64 Options
8991
8992 These @samp{-m} options are defined for the i386 and x86-64 family of
8993 computers:
8994
8995 @table @gcctabopt
8996 @item -mtune=@var{cpu-type}
8997 @opindex mtune
8998 Tune to @var{cpu-type} everything applicable about the generated code, except
8999 for the ABI and the set of available instructions.  The choices for
9000 @var{cpu-type} are:
9001 @table @emph
9002 @item i386
9003 Original Intel's i386 CPU@.
9004 @item i486
9005 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9006 @item i586, pentium
9007 Intel Pentium CPU with no MMX support.
9008 @item pentium-mmx
9009 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9010 @item i686, pentiumpro
9011 Intel PentiumPro CPU@.
9012 @item pentium2
9013 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9014 @item pentium3, pentium3m
9015 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9016 support.
9017 @item pentium-m
9018 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9019 support.  Used by Centrino notebooks.
9020 @item pentium4, pentium4m
9021 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9022 @item prescott
9023 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9024 set support.
9025 @item nocona
9026 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9027 SSE2 and SSE3 instruction set support.
9028 @item k6
9029 AMD K6 CPU with MMX instruction set support.
9030 @item k6-2, k6-3
9031 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9032 @item athlon, athlon-tbird
9033 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9034 support.
9035 @item athlon-4, athlon-xp, athlon-mp
9036 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9037 instruction set support.
9038 @item k8, opteron, athlon64, athlon-fx
9039 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9040 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9041 @item winchip-c6
9042 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9043 set support.
9044 @item winchip2
9045 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9046 instruction set support.
9047 @item c3
9048 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9049 implemented for this chip.)
9050 @item c3-2
9051 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9052 implemented for this chip.)
9053 @end table
9054
9055 While picking a specific @var{cpu-type} will schedule things appropriately
9056 for that particular chip, the compiler will not generate any code that
9057 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9058 being used.
9059
9060 @item -march=@var{cpu-type}
9061 @opindex march
9062 Generate instructions for the machine type @var{cpu-type}.  The choices
9063 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9064 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9065
9066 @item -mcpu=@var{cpu-type}
9067 @opindex mcpu
9068 A deprecated synonym for @option{-mtune}.
9069
9070 @item -m386
9071 @itemx -m486
9072 @itemx -mpentium
9073 @itemx -mpentiumpro
9074 @opindex m386
9075 @opindex m486
9076 @opindex mpentium
9077 @opindex mpentiumpro
9078 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9079 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9080 These synonyms are deprecated.
9081
9082 @item -mfpmath=@var{unit}
9083 @opindex march
9084 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9085 for @var{unit} are:
9086
9087 @table @samp
9088 @item 387
9089 Use the standard 387 floating point coprocessor present majority of chips and
9090 emulated otherwise.  Code compiled with this option will run almost everywhere.
9091 The temporary results are computed in 80bit precision instead of precision
9092 specified by the type resulting in slightly different results compared to most
9093 of other chips.  See @option{-ffloat-store} for more detailed description.
9094
9095 This is the default choice for i386 compiler.
9096
9097 @item sse
9098 Use scalar floating point instructions present in the SSE instruction set.
9099 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9100 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9101 instruction set supports only single precision arithmetics, thus the double and
9102 extended precision arithmetics is still done using 387.  Later version, present
9103 only in Pentium4 and the future AMD x86-64 chips supports double precision
9104 arithmetics too.
9105
9106 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9107 or @option{-msse2} switches to enable SSE extensions and make this option
9108 effective.  For the x86-64 compiler, these extensions are enabled by default.
9109
9110 The resulting code should be considerably faster in the majority of cases and avoid
9111 the numerical instability problems of 387 code, but may break some existing
9112 code that expects temporaries to be 80bit.
9113
9114 This is the default choice for the x86-64 compiler.
9115
9116 @item sse,387
9117 Attempt to utilize both instruction sets at once.  This effectively double the
9118 amount of available registers and on chips with separate execution units for
9119 387 and SSE the execution resources too.  Use this option with care, as it is
9120 still experimental, because the GCC register allocator does not model separate
9121 functional units well resulting in instable performance.
9122 @end table
9123
9124 @item -masm=@var{dialect}
9125 @opindex masm=@var{dialect}
9126 Output asm instructions using selected @var{dialect}.  Supported
9127 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9128 not support @samp{intel}.
9129
9130 @item -mieee-fp
9131 @itemx -mno-ieee-fp
9132 @opindex mieee-fp
9133 @opindex mno-ieee-fp
9134 Control whether or not the compiler uses IEEE floating point
9135 comparisons.  These handle correctly the case where the result of a
9136 comparison is unordered.
9137
9138 @item -msoft-float
9139 @opindex msoft-float
9140 Generate output containing library calls for floating point.
9141 @strong{Warning:} the requisite libraries are not part of GCC@.
9142 Normally the facilities of the machine's usual C compiler are used, but
9143 this can't be done directly in cross-compilation.  You must make your
9144 own arrangements to provide suitable library functions for
9145 cross-compilation.
9146
9147 On machines where a function returns floating point results in the 80387
9148 register stack, some floating point opcodes may be emitted even if
9149 @option{-msoft-float} is used.
9150
9151 @item -mno-fp-ret-in-387
9152 @opindex mno-fp-ret-in-387
9153 Do not use the FPU registers for return values of functions.
9154
9155 The usual calling convention has functions return values of types
9156 @code{float} and @code{double} in an FPU register, even if there
9157 is no FPU@.  The idea is that the operating system should emulate
9158 an FPU@.
9159
9160 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9161 in ordinary CPU registers instead.
9162
9163 @item -mno-fancy-math-387
9164 @opindex mno-fancy-math-387
9165 Some 387 emulators do not support the @code{sin}, @code{cos} and
9166 @code{sqrt} instructions for the 387.  Specify this option to avoid
9167 generating those instructions.  This option is the default on FreeBSD,
9168 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9169 indicates that the target cpu will always have an FPU and so the
9170 instruction will not need emulation.  As of revision 2.6.1, these
9171 instructions are not generated unless you also use the
9172 @option{-funsafe-math-optimizations} switch.
9173
9174 @item -malign-double
9175 @itemx -mno-align-double
9176 @opindex malign-double
9177 @opindex mno-align-double
9178 Control whether GCC aligns @code{double}, @code{long double}, and
9179 @code{long long} variables on a two word boundary or a one word
9180 boundary.  Aligning @code{double} variables on a two word boundary will
9181 produce code that runs somewhat faster on a @samp{Pentium} at the
9182 expense of more memory.
9183
9184 On x86-64, @option{-malign-double} is enabled by default.
9185
9186 @strong{Warning:} if you use the @option{-malign-double} switch,
9187 structures containing the above types will be aligned differently than
9188 the published application binary interface specifications for the 386
9189 and will not be binary compatible with structures in code compiled
9190 without that switch.
9191
9192 @item -m96bit-long-double
9193 @itemx -m128bit-long-double
9194 @opindex m96bit-long-double
9195 @opindex m128bit-long-double
9196 These switches control the size of @code{long double} type.  The i386
9197 application binary interface specifies the size to be 96 bits,
9198 so @option{-m96bit-long-double} is the default in 32 bit mode.
9199
9200 Modern architectures (Pentium and newer) would prefer @code{long double}
9201 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9202 conforming to the ABI, this would not be possible.  So specifying a
9203 @option{-m128bit-long-double} will align @code{long double}
9204 to a 16 byte boundary by padding the @code{long double} with an additional
9205 32 bit zero.
9206
9207 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9208 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9209
9210 Notice that neither of these options enable any extra precision over the x87
9211 standard of 80 bits for a @code{long double}.
9212
9213 @strong{Warning:} if you override the default value for your target ABI, the
9214 structures and arrays containing @code{long double} variables will change
9215 their size as well as function calling convention for function taking
9216 @code{long double} will be modified.  Hence they will not be binary
9217 compatible with arrays or structures in code compiled without that switch.
9218
9219 @item -mmlarge-data-threshold=@var{number}
9220 @opindex mlarge-data-threshold=@var{number}
9221 When @option{-mcmodel=medium} is specified, the data greater than
9222 @var{threshold} are placed in large data section.  This value must be the
9223 same across all object linked into the binary and defaults to 65535.
9224
9225 @item -msvr3-shlib
9226 @itemx -mno-svr3-shlib
9227 @opindex msvr3-shlib
9228 @opindex mno-svr3-shlib
9229 Control whether GCC places uninitialized local variables into the
9230 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9231 into @code{bss}.  These options are meaningful only on System V Release 3.
9232
9233 @item -mrtd
9234 @opindex mrtd
9235 Use a different function-calling convention, in which functions that
9236 take a fixed number of arguments return with the @code{ret} @var{num}
9237 instruction, which pops their arguments while returning.  This saves one
9238 instruction in the caller since there is no need to pop the arguments
9239 there.
9240
9241 You can specify that an individual function is called with this calling
9242 sequence with the function attribute @samp{stdcall}.  You can also
9243 override the @option{-mrtd} option by using the function attribute
9244 @samp{cdecl}.  @xref{Function Attributes}.
9245
9246 @strong{Warning:} this calling convention is incompatible with the one
9247 normally used on Unix, so you cannot use it if you need to call
9248 libraries compiled with the Unix compiler.
9249
9250 Also, you must provide function prototypes for all functions that
9251 take variable numbers of arguments (including @code{printf});
9252 otherwise incorrect code will be generated for calls to those
9253 functions.
9254
9255 In addition, seriously incorrect code will result if you call a
9256 function with too many arguments.  (Normally, extra arguments are
9257 harmlessly ignored.)
9258
9259 @item -mregparm=@var{num}
9260 @opindex mregparm
9261 Control how many registers are used to pass integer arguments.  By
9262 default, no registers are used to pass arguments, and at most 3
9263 registers can be used.  You can control this behavior for a specific
9264 function by using the function attribute @samp{regparm}.
9265 @xref{Function Attributes}.
9266
9267 @strong{Warning:} if you use this switch, and
9268 @var{num} is nonzero, then you must build all modules with the same
9269 value, including any libraries.  This includes the system libraries and
9270 startup modules.
9271
9272 @item -msseregparm
9273 @opindex msseregparm
9274 Use SSE register passing conventions for float and double arguments
9275 and return values.  You can control this behavior for a specific
9276 function by using the function attribute @samp{sseregparm}.
9277 @xref{Function Attributes}.
9278
9279 @strong{Warning:} if you use this switch then you must build all
9280 modules with the same value, including any libraries.  This includes
9281 the system libraries and startup modules.
9282
9283 @item -mpreferred-stack-boundary=@var{num}
9284 @opindex mpreferred-stack-boundary
9285 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9286 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9287 the default is 4 (16 bytes or 128 bits).
9288
9289 On Pentium and PentiumPro, @code{double} and @code{long double} values
9290 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9291 suffer significant run time performance penalties.  On Pentium III, the
9292 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9293 properly if it is not 16 byte aligned.
9294
9295 To ensure proper alignment of this values on the stack, the stack boundary
9296 must be as aligned as that required by any value stored on the stack.
9297 Further, every function must be generated such that it keeps the stack
9298 aligned.  Thus calling a function compiled with a higher preferred
9299 stack boundary from a function compiled with a lower preferred stack
9300 boundary will most likely misalign the stack.  It is recommended that
9301 libraries that use callbacks always use the default setting.
9302
9303 This extra alignment does consume extra stack space, and generally
9304 increases code size.  Code that is sensitive to stack space usage, such
9305 as embedded systems and operating system kernels, may want to reduce the
9306 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9307
9308 @item -mmmx
9309 @itemx -mno-mmx
9310 @item -msse
9311 @itemx -mno-sse
9312 @item -msse2
9313 @itemx -mno-sse2
9314 @item -msse3
9315 @itemx -mno-sse3
9316 @item -m3dnow
9317 @itemx -mno-3dnow
9318 @opindex mmmx
9319 @opindex mno-mmx
9320 @opindex msse
9321 @opindex mno-sse
9322 @opindex m3dnow
9323 @opindex mno-3dnow
9324 These switches enable or disable the use of instructions in the MMX,
9325 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9326 also available as built-in functions: see @ref{X86 Built-in Functions},
9327 for details of the functions enabled and disabled by these switches.
9328
9329 To have SSE/SSE2 instructions generated automatically from floating-point
9330 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9331
9332 These options will enable GCC to use these extended instructions in
9333 generated code, even without @option{-mfpmath=sse}.  Applications which
9334 perform runtime CPU detection must compile separate files for each
9335 supported architecture, using the appropriate flags.  In particular,
9336 the file containing the CPU detection code should be compiled without
9337 these options.
9338
9339 @item -mpush-args
9340 @itemx -mno-push-args
9341 @opindex mpush-args
9342 @opindex mno-push-args
9343 Use PUSH operations to store outgoing parameters.  This method is shorter
9344 and usually equally fast as method using SUB/MOV operations and is enabled
9345 by default.  In some cases disabling it may improve performance because of
9346 improved scheduling and reduced dependencies.
9347
9348 @item -maccumulate-outgoing-args
9349 @opindex maccumulate-outgoing-args
9350 If enabled, the maximum amount of space required for outgoing arguments will be
9351 computed in the function prologue.  This is faster on most modern CPUs
9352 because of reduced dependencies, improved scheduling and reduced stack usage
9353 when preferred stack boundary is not equal to 2.  The drawback is a notable
9354 increase in code size.  This switch implies @option{-mno-push-args}.
9355
9356 @item -mthreads
9357 @opindex mthreads
9358 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9359 on thread-safe exception handling must compile and link all code with the
9360 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9361 @option{-D_MT}; when linking, it links in a special thread helper library
9362 @option{-lmingwthrd} which cleans up per thread exception handling data.
9363
9364 @item -mno-align-stringops
9365 @opindex mno-align-stringops
9366 Do not align destination of inlined string operations.  This switch reduces
9367 code size and improves performance in case the destination is already aligned,
9368 but GCC doesn't know about it.
9369
9370 @item -minline-all-stringops
9371 @opindex minline-all-stringops
9372 By default GCC inlines string operations only when destination is known to be
9373 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9374 size, but may improve performance of code that depends on fast memcpy, strlen
9375 and memset for short lengths.
9376
9377 @item -momit-leaf-frame-pointer
9378 @opindex momit-leaf-frame-pointer
9379 Don't keep the frame pointer in a register for leaf functions.  This
9380 avoids the instructions to save, set up and restore frame pointers and
9381 makes an extra register available in leaf functions.  The option
9382 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9383 which might make debugging harder.
9384
9385 @item -mtls-direct-seg-refs
9386 @itemx -mno-tls-direct-seg-refs
9387 @opindex mtls-direct-seg-refs
9388 Controls whether TLS variables may be accessed with offsets from the
9389 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9390 or whether the thread base pointer must be added.  Whether or not this
9391 is legal depends on the operating system, and whether it maps the
9392 segment to cover the entire TLS area.
9393
9394 For systems that use GNU libc, the default is on.
9395 @end table
9396
9397 These @samp{-m} switches are supported in addition to the above
9398 on AMD x86-64 processors in 64-bit environments.
9399
9400 @table @gcctabopt
9401 @item -m32
9402 @itemx -m64
9403 @opindex m32
9404 @opindex m64
9405 Generate code for a 32-bit or 64-bit environment.
9406 The 32-bit environment sets int, long and pointer to 32 bits and
9407 generates code that runs on any i386 system.
9408 The 64-bit environment sets int to 32 bits and long and pointer
9409 to 64 bits and generates code for AMD's x86-64 architecture.
9410
9411 @item -mno-red-zone
9412 @opindex no-red-zone
9413 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9414 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9415 stack pointer that will not be modified by signal or interrupt handlers
9416 and therefore can be used for temporary data without adjusting the stack
9417 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9418
9419 @item -mcmodel=small
9420 @opindex mcmodel=small
9421 Generate code for the small code model: the program and its symbols must
9422 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9423 Programs can be statically or dynamically linked.  This is the default
9424 code model.
9425
9426 @item -mcmodel=kernel
9427 @opindex mcmodel=kernel
9428 Generate code for the kernel code model.  The kernel runs in the
9429 negative 2 GB of the address space.
9430 This model has to be used for Linux kernel code.
9431
9432 @item -mcmodel=medium
9433 @opindex mcmodel=medium
9434 Generate code for the medium model: The program is linked in the lower 2
9435 GB of the address space but symbols can be located anywhere in the
9436 address space.  Programs can be statically or dynamically linked, but
9437 building of shared libraries are not supported with the medium model.
9438
9439 @item -mcmodel=large
9440 @opindex mcmodel=large
9441 Generate code for the large model: This model makes no assumptions
9442 about addresses and sizes of sections.  Currently GCC does not implement
9443 this model.
9444 @end table
9445
9446 @node IA-64 Options
9447 @subsection IA-64 Options
9448 @cindex IA-64 Options
9449
9450 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9451
9452 @table @gcctabopt
9453 @item -mbig-endian
9454 @opindex mbig-endian
9455 Generate code for a big endian target.  This is the default for HP-UX@.
9456
9457 @item -mlittle-endian
9458 @opindex mlittle-endian
9459 Generate code for a little endian target.  This is the default for AIX5
9460 and GNU/Linux.
9461
9462 @item -mgnu-as
9463 @itemx -mno-gnu-as
9464 @opindex mgnu-as
9465 @opindex mno-gnu-as
9466 Generate (or don't) code for the GNU assembler.  This is the default.
9467 @c Also, this is the default if the configure option @option{--with-gnu-as}
9468 @c is used.
9469
9470 @item -mgnu-ld
9471 @itemx -mno-gnu-ld
9472 @opindex mgnu-ld
9473 @opindex mno-gnu-ld
9474 Generate (or don't) code for the GNU linker.  This is the default.
9475 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9476 @c is used.
9477
9478 @item -mno-pic
9479 @opindex mno-pic
9480 Generate code that does not use a global pointer register.  The result
9481 is not position independent code, and violates the IA-64 ABI@.
9482
9483 @item -mvolatile-asm-stop
9484 @itemx -mno-volatile-asm-stop
9485 @opindex mvolatile-asm-stop
9486 @opindex mno-volatile-asm-stop
9487 Generate (or don't) a stop bit immediately before and after volatile asm
9488 statements.
9489
9490 @item -mregister-names
9491 @itemx -mno-register-names
9492 @opindex mregister-names
9493 @opindex mno-register-names
9494 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9495 the stacked registers.  This may make assembler output more readable.
9496
9497 @item -mno-sdata
9498 @itemx -msdata
9499 @opindex mno-sdata
9500 @opindex msdata
9501 Disable (or enable) optimizations that use the small data section.  This may
9502 be useful for working around optimizer bugs.
9503
9504 @item -mconstant-gp
9505 @opindex mconstant-gp
9506 Generate code that uses a single constant global pointer value.  This is
9507 useful when compiling kernel code.
9508
9509 @item -mauto-pic
9510 @opindex mauto-pic
9511 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9512 This is useful when compiling firmware code.
9513
9514 @item -minline-float-divide-min-latency
9515 @opindex minline-float-divide-min-latency
9516 Generate code for inline divides of floating point values
9517 using the minimum latency algorithm.
9518
9519 @item -minline-float-divide-max-throughput
9520 @opindex minline-float-divide-max-throughput
9521 Generate code for inline divides of floating point values
9522 using the maximum throughput algorithm.
9523
9524 @item -minline-int-divide-min-latency
9525 @opindex minline-int-divide-min-latency
9526 Generate code for inline divides of integer values
9527 using the minimum latency algorithm.
9528
9529 @item -minline-int-divide-max-throughput
9530 @opindex minline-int-divide-max-throughput
9531 Generate code for inline divides of integer values
9532 using the maximum throughput algorithm.
9533
9534 @item -minline-sqrt-min-latency
9535 @opindex minline-sqrt-min-latency
9536 Generate code for inline square roots
9537 using the minimum latency algorithm.
9538
9539 @item -minline-sqrt-max-throughput
9540 @opindex minline-sqrt-max-throughput
9541 Generate code for inline square roots
9542 using the maximum throughput algorithm.
9543
9544 @item -mno-dwarf2-asm
9545 @itemx -mdwarf2-asm
9546 @opindex mno-dwarf2-asm
9547 @opindex mdwarf2-asm
9548 Don't (or do) generate assembler code for the DWARF2 line number debugging
9549 info.  This may be useful when not using the GNU assembler.
9550
9551 @item -mearly-stop-bits
9552 @itemx -mno-early-stop-bits
9553 @opindex mearly-stop-bits
9554 @opindex mno-early-stop-bits
9555 Allow stop bits to be placed earlier than immediately preceding the
9556 instruction that triggered the stop bit.  This can improve instruction
9557 scheduling, but does not always do so.
9558
9559 @item -mfixed-range=@var{register-range}
9560 @opindex mfixed-range
9561 Generate code treating the given register range as fixed registers.
9562 A fixed register is one that the register allocator can not use.  This is
9563 useful when compiling kernel code.  A register range is specified as
9564 two registers separated by a dash.  Multiple register ranges can be
9565 specified separated by a comma.
9566
9567 @item -mtls-size=@var{tls-size}
9568 @opindex mtls-size
9569 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9570 64.
9571
9572 @item -mtune=@var{cpu-type}
9573 @opindex mtune
9574 Tune the instruction scheduling for a particular CPU, Valid values are
9575 itanium, itanium1, merced, itanium2, and mckinley.
9576
9577 @item -mt
9578 @itemx -pthread
9579 @opindex mt
9580 @opindex pthread
9581 Add support for multithreading using the POSIX threads library.  This
9582 option sets flags for both the preprocessor and linker.  It does
9583 not affect the thread safety of object code produced by the compiler or
9584 that of libraries supplied with it.  These are HP-UX specific flags.
9585
9586 @item -milp32
9587 @itemx -mlp64
9588 @opindex milp32
9589 @opindex mlp64
9590 Generate code for a 32-bit or 64-bit environment.
9591 The 32-bit environment sets int, long and pointer to 32 bits.
9592 The 64-bit environment sets int to 32 bits and long and pointer
9593 to 64 bits.  These are HP-UX specific flags.
9594
9595 @end table
9596
9597 @node M32C Options
9598 @subsection M32C Options
9599 @cindex M32C options
9600
9601 @table @gcctabopt
9602 @item -mcpu=@var{name}
9603 @opindex mcpu=
9604 Select the CPU for which code is generated.  @var{name} may be one of
9605 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9606 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9607 the M32C/80 series.
9608
9609 @item -msim
9610 @opindex msim
9611 Specifies that the program will be run on the simulator.  This causes
9612 an alternate runtime library to be linked in which supports, for
9613 example, file I/O.  You must not use this option when generating
9614 programs that will run on real hardware; you must provide your own
9615 runtime library for whatever I/O functions are needed.
9616
9617 @item -memregs=@var{number}
9618 @opindex memregs=
9619 Specifies the number of memory-based pseudo-registers GCC will use
9620 during code generation.  These pseudo-registers will be used like real
9621 registers, so there is a tradeoff between GCC's ability to fit the
9622 code into available registers, and the performance penalty of using
9623 memory instead of registers.  Note that all modules in a program must
9624 be compiled with the same value for this option.  Because of that, you
9625 must not use this option with the default runtime libraries gcc
9626 builds.
9627
9628 @end table
9629
9630 @node M32R/D Options
9631 @subsection M32R/D Options
9632 @cindex M32R/D options
9633
9634 These @option{-m} options are defined for Renesas M32R/D architectures:
9635
9636 @table @gcctabopt
9637 @item -m32r2
9638 @opindex m32r2
9639 Generate code for the M32R/2@.
9640
9641 @item -m32rx
9642 @opindex m32rx
9643 Generate code for the M32R/X@.
9644
9645 @item -m32r
9646 @opindex m32r
9647 Generate code for the M32R@.  This is the default.
9648
9649 @item -mmodel=small
9650 @opindex mmodel=small
9651 Assume all objects live in the lower 16MB of memory (so that their addresses
9652 can be loaded with the @code{ld24} instruction), and assume all subroutines
9653 are reachable with the @code{bl} instruction.
9654 This is the default.
9655
9656 The addressability of a particular object can be set with the
9657 @code{model} attribute.
9658
9659 @item -mmodel=medium
9660 @opindex mmodel=medium
9661 Assume objects may be anywhere in the 32-bit address space (the compiler
9662 will generate @code{seth/add3} instructions to load their addresses), and
9663 assume all subroutines are reachable with the @code{bl} instruction.
9664
9665 @item -mmodel=large
9666 @opindex mmodel=large
9667 Assume objects may be anywhere in the 32-bit address space (the compiler
9668 will generate @code{seth/add3} instructions to load their addresses), and
9669 assume subroutines may not be reachable with the @code{bl} instruction
9670 (the compiler will generate the much slower @code{seth/add3/jl}
9671 instruction sequence).
9672
9673 @item -msdata=none
9674 @opindex msdata=none
9675 Disable use of the small data area.  Variables will be put into
9676 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9677 @code{section} attribute has been specified).
9678 This is the default.
9679
9680 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9681 Objects may be explicitly put in the small data area with the
9682 @code{section} attribute using one of these sections.
9683
9684 @item -msdata=sdata
9685 @opindex msdata=sdata
9686 Put small global and static data in the small data area, but do not
9687 generate special code to reference them.
9688
9689 @item -msdata=use
9690 @opindex msdata=use
9691 Put small global and static data in the small data area, and generate
9692 special instructions to reference them.
9693
9694 @item -G @var{num}
9695 @opindex G
9696 @cindex smaller data references
9697 Put global and static objects less than or equal to @var{num} bytes
9698 into the small data or bss sections instead of the normal data or bss
9699 sections.  The default value of @var{num} is 8.
9700 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9701 for this option to have any effect.
9702
9703 All modules should be compiled with the same @option{-G @var{num}} value.
9704 Compiling with different values of @var{num} may or may not work; if it
9705 doesn't the linker will give an error message---incorrect code will not be
9706 generated.
9707
9708 @item -mdebug
9709 @opindex mdebug
9710 Makes the M32R specific code in the compiler display some statistics
9711 that might help in debugging programs.
9712
9713 @item -malign-loops
9714 @opindex malign-loops
9715 Align all loops to a 32-byte boundary.
9716
9717 @item -mno-align-loops
9718 @opindex mno-align-loops
9719 Do not enforce a 32-byte alignment for loops.  This is the default.
9720
9721 @item -missue-rate=@var{number}
9722 @opindex missue-rate=@var{number}
9723 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9724 or 2.
9725
9726 @item -mbranch-cost=@var{number}
9727 @opindex mbranch-cost=@var{number}
9728 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9729 preferred over conditional code, if it is 2, then the opposite will
9730 apply.
9731
9732 @item -mflush-trap=@var{number}
9733 @opindex mflush-trap=@var{number}
9734 Specifies the trap number to use to flush the cache.  The default is
9735 12.  Valid numbers are between 0 and 15 inclusive.
9736
9737 @item -mno-flush-trap
9738 @opindex mno-flush-trap
9739 Specifies that the cache cannot be flushed by using a trap.
9740
9741 @item -mflush-func=@var{name}
9742 @opindex mflush-func=@var{name}
9743 Specifies the name of the operating system function to call to flush
9744 the cache.  The default is @emph{_flush_cache}, but a function call
9745 will only be used if a trap is not available.
9746
9747 @item -mno-flush-func
9748 @opindex mno-flush-func
9749 Indicates that there is no OS function for flushing the cache.
9750
9751 @end table
9752
9753 @node M680x0 Options
9754 @subsection M680x0 Options
9755 @cindex M680x0 options
9756
9757 These are the @samp{-m} options defined for the 68000 series.  The default
9758 values for these options depends on which style of 68000 was selected when
9759 the compiler was configured; the defaults for the most common choices are
9760 given below.
9761
9762 @table @gcctabopt
9763 @item -m68000
9764 @itemx -mc68000
9765 @opindex m68000
9766 @opindex mc68000
9767 Generate output for a 68000.  This is the default
9768 when the compiler is configured for 68000-based systems.
9769
9770 Use this option for microcontrollers with a 68000 or EC000 core,
9771 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9772
9773 @item -m68020
9774 @itemx -mc68020
9775 @opindex m68020
9776 @opindex mc68020
9777 Generate output for a 68020.  This is the default
9778 when the compiler is configured for 68020-based systems.
9779
9780 @item -m68881
9781 @opindex m68881
9782 Generate output containing 68881 instructions for floating point.
9783 This is the default for most 68020 systems unless @option{--nfp} was
9784 specified when the compiler was configured.
9785
9786 @item -m68030
9787 @opindex m68030
9788 Generate output for a 68030.  This is the default when the compiler is
9789 configured for 68030-based systems.
9790
9791 @item -m68040
9792 @opindex m68040
9793 Generate output for a 68040.  This is the default when the compiler is
9794 configured for 68040-based systems.
9795
9796 This option inhibits the use of 68881/68882 instructions that have to be
9797 emulated by software on the 68040.  Use this option if your 68040 does not
9798 have code to emulate those instructions.
9799
9800 @item -m68060
9801 @opindex m68060
9802 Generate output for a 68060.  This is the default when the compiler is
9803 configured for 68060-based systems.
9804
9805 This option inhibits the use of 68020 and 68881/68882 instructions that
9806 have to be emulated by software on the 68060.  Use this option if your 68060
9807 does not have code to emulate those instructions.
9808
9809 @item -mcpu32
9810 @opindex mcpu32
9811 Generate output for a CPU32.  This is the default
9812 when the compiler is configured for CPU32-based systems.
9813
9814 Use this option for microcontrollers with a
9815 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9816 68336, 68340, 68341, 68349 and 68360.
9817
9818 @item -m5200
9819 @opindex m5200
9820 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9821 when the compiler is configured for 520X-based systems.
9822
9823 Use this option for microcontroller with a 5200 core, including
9824 the MCF5202, MCF5203, MCF5204 and MCF5202.
9825
9826
9827 @item -m68020-40
9828 @opindex m68020-40
9829 Generate output for a 68040, without using any of the new instructions.
9830 This results in code which can run relatively efficiently on either a
9831 68020/68881 or a 68030 or a 68040.  The generated code does use the
9832 68881 instructions that are emulated on the 68040.
9833
9834 @item -m68020-60
9835 @opindex m68020-60
9836 Generate output for a 68060, without using any of the new instructions.
9837 This results in code which can run relatively efficiently on either a
9838 68020/68881 or a 68030 or a 68040.  The generated code does use the
9839 68881 instructions that are emulated on the 68060.
9840
9841 @item -msoft-float
9842 @opindex msoft-float
9843 Generate output containing library calls for floating point.
9844 @strong{Warning:} the requisite libraries are not available for all m68k
9845 targets.  Normally the facilities of the machine's usual C compiler are
9846 used, but this can't be done directly in cross-compilation.  You must
9847 make your own arrangements to provide suitable library functions for
9848 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9849 @samp{m68k-*-coff} do provide software floating point support.
9850
9851 @item -mshort
9852 @opindex mshort
9853 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9854 Additionally, parameters passed on the stack are also aligned to a
9855 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9856
9857 @item -mnobitfield
9858 @opindex mnobitfield
9859 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9860 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9861
9862 @item -mbitfield
9863 @opindex mbitfield
9864 Do use the bit-field instructions.  The @option{-m68020} option implies
9865 @option{-mbitfield}.  This is the default if you use a configuration
9866 designed for a 68020.
9867
9868 @item -mrtd
9869 @opindex mrtd
9870 Use a different function-calling convention, in which functions
9871 that take a fixed number of arguments return with the @code{rtd}
9872 instruction, which pops their arguments while returning.  This
9873 saves one instruction in the caller since there is no need to pop
9874 the arguments there.
9875
9876 This calling convention is incompatible with the one normally
9877 used on Unix, so you cannot use it if you need to call libraries
9878 compiled with the Unix compiler.
9879
9880 Also, you must provide function prototypes for all functions that
9881 take variable numbers of arguments (including @code{printf});
9882 otherwise incorrect code will be generated for calls to those
9883 functions.
9884
9885 In addition, seriously incorrect code will result if you call a
9886 function with too many arguments.  (Normally, extra arguments are
9887 harmlessly ignored.)
9888
9889 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9890 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9891
9892 @item -malign-int
9893 @itemx -mno-align-int
9894 @opindex malign-int
9895 @opindex mno-align-int
9896 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9897 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9898 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9899 Aligning variables on 32-bit boundaries produces code that runs somewhat
9900 faster on processors with 32-bit busses at the expense of more memory.
9901
9902 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9903 align structures containing the above types  differently than
9904 most published application binary interface specifications for the m68k.
9905
9906 @item -mpcrel
9907 @opindex mpcrel
9908 Use the pc-relative addressing mode of the 68000 directly, instead of
9909 using a global offset table.  At present, this option implies @option{-fpic},
9910 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9911 not presently supported with @option{-mpcrel}, though this could be supported for
9912 68020 and higher processors.
9913
9914 @item -mno-strict-align
9915 @itemx -mstrict-align
9916 @opindex mno-strict-align
9917 @opindex mstrict-align
9918 Do not (do) assume that unaligned memory references will be handled by
9919 the system.
9920
9921 @item -msep-data
9922 Generate code that allows the data segment to be located in a different
9923 area of memory from the text segment.  This allows for execute in place in
9924 an environment without virtual memory management.  This option implies
9925 @option{-fPIC}.
9926
9927 @item -mno-sep-data
9928 Generate code that assumes that the data segment follows the text segment.
9929 This is the default.
9930
9931 @item -mid-shared-library
9932 Generate code that supports shared libraries via the library ID method.
9933 This allows for execute in place and shared libraries in an environment
9934 without virtual memory management.  This option implies @option{-fPIC}.
9935
9936 @item -mno-id-shared-library
9937 Generate code that doesn't assume ID based shared libraries are being used.
9938 This is the default.
9939
9940 @item -mshared-library-id=n
9941 Specified the identification number of the ID based shared library being
9942 compiled.  Specifying a value of 0 will generate more compact code, specifying
9943 other values will force the allocation of that number to the current
9944 library but is no more space or time efficient than omitting this option.
9945
9946 @end table
9947
9948 @node M68hc1x Options
9949 @subsection M68hc1x Options
9950 @cindex M68hc1x options
9951
9952 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9953 microcontrollers.  The default values for these options depends on
9954 which style of microcontroller was selected when the compiler was configured;
9955 the defaults for the most common choices are given below.
9956
9957 @table @gcctabopt
9958 @item -m6811
9959 @itemx -m68hc11
9960 @opindex m6811
9961 @opindex m68hc11
9962 Generate output for a 68HC11.  This is the default
9963 when the compiler is configured for 68HC11-based systems.
9964
9965 @item -m6812
9966 @itemx -m68hc12
9967 @opindex m6812
9968 @opindex m68hc12
9969 Generate output for a 68HC12.  This is the default
9970 when the compiler is configured for 68HC12-based systems.
9971
9972 @item -m68S12
9973 @itemx -m68hcs12
9974 @opindex m68S12
9975 @opindex m68hcs12
9976 Generate output for a 68HCS12.
9977
9978 @item -mauto-incdec
9979 @opindex mauto-incdec
9980 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9981 addressing modes.
9982
9983 @item -minmax
9984 @itemx -nominmax
9985 @opindex minmax
9986 @opindex mnominmax
9987 Enable the use of 68HC12 min and max instructions.
9988
9989 @item -mlong-calls
9990 @itemx -mno-long-calls
9991 @opindex mlong-calls
9992 @opindex mno-long-calls
9993 Treat all calls as being far away (near).  If calls are assumed to be
9994 far away, the compiler will use the @code{call} instruction to
9995 call a function and the @code{rtc} instruction for returning.
9996
9997 @item -mshort
9998 @opindex mshort
9999 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10000
10001 @item -msoft-reg-count=@var{count}
10002 @opindex msoft-reg-count
10003 Specify the number of pseudo-soft registers which are used for the
10004 code generation.  The maximum number is 32.  Using more pseudo-soft
10005 register may or may not result in better code depending on the program.
10006 The default is 4 for 68HC11 and 2 for 68HC12.
10007
10008 @end table
10009
10010 @node MCore Options
10011 @subsection MCore Options
10012 @cindex MCore options
10013
10014 These are the @samp{-m} options defined for the Motorola M*Core
10015 processors.
10016
10017 @table @gcctabopt
10018
10019 @item -mhardlit
10020 @itemx -mno-hardlit
10021 @opindex mhardlit
10022 @opindex mno-hardlit
10023 Inline constants into the code stream if it can be done in two
10024 instructions or less.
10025
10026 @item -mdiv
10027 @itemx -mno-div
10028 @opindex mdiv
10029 @opindex mno-div
10030 Use the divide instruction.  (Enabled by default).
10031
10032 @item -mrelax-immediate
10033 @itemx -mno-relax-immediate
10034 @opindex mrelax-immediate
10035 @opindex mno-relax-immediate
10036 Allow arbitrary sized immediates in bit operations.
10037
10038 @item -mwide-bitfields
10039 @itemx -mno-wide-bitfields
10040 @opindex mwide-bitfields
10041 @opindex mno-wide-bitfields
10042 Always treat bit-fields as int-sized.
10043
10044 @item -m4byte-functions
10045 @itemx -mno-4byte-functions
10046 @opindex m4byte-functions
10047 @opindex mno-4byte-functions
10048 Force all functions to be aligned to a four byte boundary.
10049
10050 @item -mcallgraph-data
10051 @itemx -mno-callgraph-data
10052 @opindex mcallgraph-data
10053 @opindex mno-callgraph-data
10054 Emit callgraph information.
10055
10056 @item -mslow-bytes
10057 @itemx -mno-slow-bytes
10058 @opindex mslow-bytes
10059 @opindex mno-slow-bytes
10060 Prefer word access when reading byte quantities.
10061
10062 @item -mlittle-endian
10063 @itemx -mbig-endian
10064 @opindex mlittle-endian
10065 @opindex mbig-endian
10066 Generate code for a little endian target.
10067
10068 @item -m210
10069 @itemx -m340
10070 @opindex m210
10071 @opindex m340
10072 Generate code for the 210 processor.
10073 @end table
10074
10075 @node MIPS Options
10076 @subsection MIPS Options
10077 @cindex MIPS options
10078
10079 @table @gcctabopt
10080
10081 @item -EB
10082 @opindex EB
10083 Generate big-endian code.
10084
10085 @item -EL
10086 @opindex EL
10087 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10088 configurations.
10089
10090 @item -march=@var{arch}
10091 @opindex march
10092 Generate code that will run on @var{arch}, which can be the name of a
10093 generic MIPS ISA, or the name of a particular processor.
10094 The ISA names are:
10095 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10096 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10097 The processor names are:
10098 @samp{4kc}, @samp{4km}, @samp{4kp},
10099 @samp{5kc}, @samp{5kf},
10100 @samp{20kc},
10101 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10102 @samp{m4k},
10103 @samp{orion},
10104 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10105 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10106 @samp{rm7000}, @samp{rm9000},
10107 @samp{sb1},
10108 @samp{sr71000},
10109 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10110 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10111 The special value @samp{from-abi} selects the
10112 most compatible architecture for the selected ABI (that is,
10113 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10114
10115 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10116 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10117 @samp{vr} may be written @samp{r}.
10118
10119 GCC defines two macros based on the value of this option.  The first
10120 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10121 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10122 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10123 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10124 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10125
10126 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10127 above.  In other words, it will have the full prefix and will not
10128 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10129 the macro names the resolved architecture (either @samp{"mips1"} or
10130 @samp{"mips3"}).  It names the default architecture when no
10131 @option{-march} option is given.
10132
10133 @item -mtune=@var{arch}
10134 @opindex mtune
10135 Optimize for @var{arch}.  Among other things, this option controls
10136 the way instructions are scheduled, and the perceived cost of arithmetic
10137 operations.  The list of @var{arch} values is the same as for
10138 @option{-march}.
10139
10140 When this option is not used, GCC will optimize for the processor
10141 specified by @option{-march}.  By using @option{-march} and
10142 @option{-mtune} together, it is possible to generate code that will
10143 run on a family of processors, but optimize the code for one
10144 particular member of that family.
10145
10146 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10147 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10148 @samp{-march} ones described above.
10149
10150 @item -mips1
10151 @opindex mips1
10152 Equivalent to @samp{-march=mips1}.
10153
10154 @item -mips2
10155 @opindex mips2
10156 Equivalent to @samp{-march=mips2}.
10157
10158 @item -mips3
10159 @opindex mips3
10160 Equivalent to @samp{-march=mips3}.
10161
10162 @item -mips4
10163 @opindex mips4
10164 Equivalent to @samp{-march=mips4}.
10165
10166 @item -mips32
10167 @opindex mips32
10168 Equivalent to @samp{-march=mips32}.
10169
10170 @item -mips32r2
10171 @opindex mips32r2
10172 Equivalent to @samp{-march=mips32r2}.
10173
10174 @item -mips64
10175 @opindex mips64
10176 Equivalent to @samp{-march=mips64}.
10177
10178 @item -mips16
10179 @itemx -mno-mips16
10180 @opindex mips16
10181 @opindex mno-mips16
10182 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10183 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10184
10185 @item -mabi=32
10186 @itemx -mabi=o64
10187 @itemx -mabi=n32
10188 @itemx -mabi=64
10189 @itemx -mabi=eabi
10190 @opindex mabi=32
10191 @opindex mabi=o64
10192 @opindex mabi=n32
10193 @opindex mabi=64
10194 @opindex mabi=eabi
10195 Generate code for the given ABI@.
10196
10197 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10198 generates 64-bit code when you select a 64-bit architecture, but you
10199 can use @option{-mgp32} to get 32-bit code instead.
10200
10201 For information about the O64 ABI, see
10202 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10203
10204 @item -mabicalls
10205 @itemx -mno-abicalls
10206 @opindex mabicalls
10207 @opindex mno-abicalls
10208 Generate (do not generate) SVR4-style position-independent code.
10209 @option{-mabicalls} is the default for SVR4-based systems.
10210
10211 @item -mxgot
10212 @itemx -mno-xgot
10213 @opindex mxgot
10214 @opindex mno-xgot
10215 Lift (do not lift) the usual restrictions on the size of the global
10216 offset table.
10217
10218 GCC normally uses a single instruction to load values from the GOT@.
10219 While this is relatively efficient, it will only work if the GOT
10220 is smaller than about 64k.  Anything larger will cause the linker
10221 to report an error such as:
10222
10223 @cindex relocation truncated to fit (MIPS)
10224 @smallexample
10225 relocation truncated to fit: R_MIPS_GOT16 foobar
10226 @end smallexample
10227
10228 If this happens, you should recompile your code with @option{-mxgot}.
10229 It should then work with very large GOTs, although it will also be
10230 less efficient, since it will take three instructions to fetch the
10231 value of a global symbol.
10232
10233 Note that some linkers can create multiple GOTs.  If you have such a
10234 linker, you should only need to use @option{-mxgot} when a single object
10235 file accesses more than 64k's worth of GOT entries.  Very few do.
10236
10237 These options have no effect unless GCC is generating position
10238 independent code.
10239
10240 @item -mgp32
10241 @opindex mgp32
10242 Assume that general-purpose registers are 32 bits wide.
10243
10244 @item -mgp64
10245 @opindex mgp64
10246 Assume that general-purpose registers are 64 bits wide.
10247
10248 @item -mfp32
10249 @opindex mfp32
10250 Assume that floating-point registers are 32 bits wide.
10251
10252 @item -mfp64
10253 @opindex mfp64
10254 Assume that floating-point registers are 64 bits wide.
10255
10256 @item -mhard-float
10257 @opindex mhard-float
10258 Use floating-point coprocessor instructions.
10259
10260 @item -msoft-float
10261 @opindex msoft-float
10262 Do not use floating-point coprocessor instructions.  Implement
10263 floating-point calculations using library calls instead.
10264
10265 @item -msingle-float
10266 @opindex msingle-float
10267 Assume that the floating-point coprocessor only supports single-precision
10268 operations.
10269
10270 @itemx -mdouble-float
10271 @opindex mdouble-float
10272 Assume that the floating-point coprocessor supports double-precision
10273 operations.  This is the default.
10274
10275 @itemx -mdsp
10276 @itemx -mno-dsp
10277 @opindex mdsp
10278 @opindex mno-dsp
10279 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10280
10281 @itemx -mpaired-single
10282 @itemx -mno-paired-single
10283 @opindex mpaired-single
10284 @opindex mno-paired-single
10285 Use (do not use) paired-single floating-point instructions.
10286 @xref{MIPS Paired-Single Support}.  This option can only be used
10287 when generating 64-bit code and requires hardware floating-point
10288 support to be enabled.
10289
10290 @itemx -mips3d
10291 @itemx -mno-mips3d
10292 @opindex mips3d
10293 @opindex mno-mips3d
10294 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10295 The option @option{-mips3d} implies @option{-mpaired-single}.
10296
10297 @item -mlong64
10298 @opindex mlong64
10299 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10300 an explanation of the default and the way that the pointer size is
10301 determined.
10302
10303 @item -mlong32
10304 @opindex mlong32
10305 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10306
10307 The default size of @code{int}s, @code{long}s and pointers depends on
10308 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10309 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10310 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10311 or the same size as integer registers, whichever is smaller.
10312
10313 @item -msym32
10314 @itemx -mno-sym32
10315 @opindex msym32
10316 @opindex mno-sym32
10317 Assume (do not assume) that all symbols have 32-bit values, regardless
10318 of the selected ABI@.  This option is useful in combination with
10319 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10320 to generate shorter and faster references to symbolic addresses.
10321
10322 @item -G @var{num}
10323 @opindex G
10324 @cindex smaller data references (MIPS)
10325 @cindex gp-relative references (MIPS)
10326 Put global and static items less than or equal to @var{num} bytes into
10327 the small data or bss section instead of the normal data or bss section.
10328 This allows the data to be accessed using a single instruction.
10329
10330 All modules should be compiled with the same @option{-G @var{num}}
10331 value.
10332
10333 @item -membedded-data
10334 @itemx -mno-embedded-data
10335 @opindex membedded-data
10336 @opindex mno-embedded-data
10337 Allocate variables to the read-only data section first if possible, then
10338 next in the small data section if possible, otherwise in data.  This gives
10339 slightly slower code than the default, but reduces the amount of RAM required
10340 when executing, and thus may be preferred for some embedded systems.
10341
10342 @item -muninit-const-in-rodata
10343 @itemx -mno-uninit-const-in-rodata
10344 @opindex muninit-const-in-rodata
10345 @opindex mno-uninit-const-in-rodata
10346 Put uninitialized @code{const} variables in the read-only data section.
10347 This option is only meaningful in conjunction with @option{-membedded-data}.
10348
10349 @item -msplit-addresses
10350 @itemx -mno-split-addresses
10351 @opindex msplit-addresses
10352 @opindex mno-split-addresses
10353 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10354 relocation operators.  This option has been superseded by
10355 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10356
10357 @item -mexplicit-relocs
10358 @itemx -mno-explicit-relocs
10359 @opindex mexplicit-relocs
10360 @opindex mno-explicit-relocs
10361 Use (do not use) assembler relocation operators when dealing with symbolic
10362 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10363 is to use assembler macros instead.
10364
10365 @option{-mexplicit-relocs} is the default if GCC was configured
10366 to use an assembler that supports relocation operators.
10367
10368 @item -mcheck-zero-division
10369 @itemx -mno-check-zero-division
10370 @opindex mcheck-zero-division
10371 @opindex mno-check-zero-division
10372 Trap (do not trap) on integer division by zero.  The default is
10373 @option{-mcheck-zero-division}.
10374
10375 @item -mdivide-traps
10376 @itemx -mdivide-breaks
10377 @opindex mdivide-traps
10378 @opindex mdivide-breaks
10379 MIPS systems check for division by zero by generating either a
10380 conditional trap or a break instruction.  Using traps results in
10381 smaller code, but is only supported on MIPS II and later.  Also, some
10382 versions of the Linux kernel have a bug that prevents trap from
10383 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10384 allow conditional traps on architectures that support them and
10385 @option{-mdivide-breaks} to force the use of breaks.
10386
10387 The default is usually @option{-mdivide-traps}, but this can be
10388 overridden at configure time using @option{--with-divide=breaks}.
10389 Divide-by-zero checks can be completely disabled using
10390 @option{-mno-check-zero-division}.
10391
10392 @item -mmemcpy
10393 @itemx -mno-memcpy
10394 @opindex mmemcpy
10395 @opindex mno-memcpy
10396 Force (do not force) the use of @code{memcpy()} for non-trivial block
10397 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10398 most constant-sized copies.
10399
10400 @item -mlong-calls
10401 @itemx -mno-long-calls
10402 @opindex mlong-calls
10403 @opindex mno-long-calls
10404 Disable (do not disable) use of the @code{jal} instruction.  Calling
10405 functions using @code{jal} is more efficient but requires the caller
10406 and callee to be in the same 256 megabyte segment.
10407
10408 This option has no effect on abicalls code.  The default is
10409 @option{-mno-long-calls}.
10410
10411 @item -mmad
10412 @itemx -mno-mad
10413 @opindex mmad
10414 @opindex mno-mad
10415 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10416 instructions, as provided by the R4650 ISA@.
10417
10418 @item -mfused-madd
10419 @itemx -mno-fused-madd
10420 @opindex mfused-madd
10421 @opindex mno-fused-madd
10422 Enable (disable) use of the floating point multiply-accumulate
10423 instructions, when they are available.  The default is
10424 @option{-mfused-madd}.
10425
10426 When multiply-accumulate instructions are used, the intermediate
10427 product is calculated to infinite precision and is not subject to
10428 the FCSR Flush to Zero bit.  This may be undesirable in some
10429 circumstances.
10430
10431 @item -nocpp
10432 @opindex nocpp
10433 Tell the MIPS assembler to not run its preprocessor over user
10434 assembler files (with a @samp{.s} suffix) when assembling them.
10435
10436 @item -mfix-r4000
10437 @itemx -mno-fix-r4000
10438 @opindex mfix-r4000
10439 @opindex mno-fix-r4000
10440 Work around certain R4000 CPU errata:
10441 @itemize @minus
10442 @item
10443 A double-word or a variable shift may give an incorrect result if executed
10444 immediately after starting an integer division.
10445 @item
10446 A double-word or a variable shift may give an incorrect result if executed
10447 while an integer multiplication is in progress.
10448 @item
10449 An integer division may give an incorrect result if started in a delay slot
10450 of a taken branch or a jump.
10451 @end itemize
10452
10453 @item -mfix-r4400
10454 @itemx -mno-fix-r4400
10455 @opindex mfix-r4400
10456 @opindex mno-fix-r4400
10457 Work around certain R4400 CPU errata:
10458 @itemize @minus
10459 @item
10460 A double-word or a variable shift may give an incorrect result if executed
10461 immediately after starting an integer division.
10462 @end itemize
10463
10464 @item -mfix-vr4120
10465 @itemx -mno-fix-vr4120
10466 @opindex mfix-vr4120
10467 Work around certain VR4120 errata:
10468 @itemize @minus
10469 @item
10470 @code{dmultu} does not always produce the correct result.
10471 @item
10472 @code{div} and @code{ddiv} do not always produce the correct result if one
10473 of the operands is negative.
10474 @end itemize
10475 The workarounds for the division errata rely on special functions in
10476 @file{libgcc.a}.  At present, these functions are only provided by
10477 the @code{mips64vr*-elf} configurations.
10478
10479 Other VR4120 errata require a nop to be inserted between certain pairs of
10480 instructions.  These errata are handled by the assembler, not by GCC itself.
10481
10482 @item -mfix-vr4130
10483 @opindex mfix-vr4130
10484 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10485 workarounds are implemented by the assembler rather than by GCC,
10486 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10487 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10488 instructions are available instead.
10489
10490 @item -mfix-sb1
10491 @itemx -mno-fix-sb1
10492 @opindex mfix-sb1
10493 Work around certain SB-1 CPU core errata.
10494 (This flag currently works around the SB-1 revision 2
10495 ``F1'' and ``F2'' floating point errata.)
10496
10497 @item -mflush-func=@var{func}
10498 @itemx -mno-flush-func
10499 @opindex mflush-func
10500 Specifies the function to call to flush the I and D caches, or to not
10501 call any such function.  If called, the function must take the same
10502 arguments as the common @code{_flush_func()}, that is, the address of the
10503 memory range for which the cache is being flushed, the size of the
10504 memory range, and the number 3 (to flush both caches).  The default
10505 depends on the target GCC was configured for, but commonly is either
10506 @samp{_flush_func} or @samp{__cpu_flush}.
10507
10508 @item -mbranch-likely
10509 @itemx -mno-branch-likely
10510 @opindex mbranch-likely
10511 @opindex mno-branch-likely
10512 Enable or disable use of Branch Likely instructions, regardless of the
10513 default for the selected architecture.  By default, Branch Likely
10514 instructions may be generated if they are supported by the selected
10515 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10516 and processors which implement those architectures; for those, Branch
10517 Likely instructions will not be generated by default because the MIPS32
10518 and MIPS64 architectures specifically deprecate their use.
10519
10520 @item -mfp-exceptions
10521 @itemx -mno-fp-exceptions
10522 @opindex mfp-exceptions
10523 Specifies whether FP exceptions are enabled.  This affects how we schedule
10524 FP instructions for some processors.  The default is that FP exceptions are
10525 enabled.
10526
10527 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10528 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10529 FP pipe.
10530
10531 @item -mvr4130-align
10532 @itemx -mno-vr4130-align
10533 @opindex mvr4130-align
10534 The VR4130 pipeline is two-way superscalar, but can only issue two
10535 instructions together if the first one is 8-byte aligned.  When this
10536 option is enabled, GCC will align pairs of instructions that it
10537 thinks should execute in parallel.
10538
10539 This option only has an effect when optimizing for the VR4130.
10540 It normally makes code faster, but at the expense of making it bigger.
10541 It is enabled by default at optimization level @option{-O3}.
10542 @end table
10543
10544 @node MMIX Options
10545 @subsection MMIX Options
10546 @cindex MMIX Options
10547
10548 These options are defined for the MMIX:
10549
10550 @table @gcctabopt
10551 @item -mlibfuncs
10552 @itemx -mno-libfuncs
10553 @opindex mlibfuncs
10554 @opindex mno-libfuncs
10555 Specify that intrinsic library functions are being compiled, passing all
10556 values in registers, no matter the size.
10557
10558 @item -mepsilon
10559 @itemx -mno-epsilon
10560 @opindex mepsilon
10561 @opindex mno-epsilon
10562 Generate floating-point comparison instructions that compare with respect
10563 to the @code{rE} epsilon register.
10564
10565 @item -mabi=mmixware
10566 @itemx -mabi=gnu
10567 @opindex mabi-mmixware
10568 @opindex mabi=gnu
10569 Generate code that passes function parameters and return values that (in
10570 the called function) are seen as registers @code{$0} and up, as opposed to
10571 the GNU ABI which uses global registers @code{$231} and up.
10572
10573 @item -mzero-extend
10574 @itemx -mno-zero-extend
10575 @opindex mzero-extend
10576 @opindex mno-zero-extend
10577 When reading data from memory in sizes shorter than 64 bits, use (do not
10578 use) zero-extending load instructions by default, rather than
10579 sign-extending ones.
10580
10581 @item -mknuthdiv
10582 @itemx -mno-knuthdiv
10583 @opindex mknuthdiv
10584 @opindex mno-knuthdiv
10585 Make the result of a division yielding a remainder have the same sign as
10586 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10587 remainder follows the sign of the dividend.  Both methods are
10588 arithmetically valid, the latter being almost exclusively used.
10589
10590 @item -mtoplevel-symbols
10591 @itemx -mno-toplevel-symbols
10592 @opindex mtoplevel-symbols
10593 @opindex mno-toplevel-symbols
10594 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10595 code can be used with the @code{PREFIX} assembly directive.
10596
10597 @item -melf
10598 @opindex melf
10599 Generate an executable in the ELF format, rather than the default
10600 @samp{mmo} format used by the @command{mmix} simulator.
10601
10602 @item -mbranch-predict
10603 @itemx -mno-branch-predict
10604 @opindex mbranch-predict
10605 @opindex mno-branch-predict
10606 Use (do not use) the probable-branch instructions, when static branch
10607 prediction indicates a probable branch.
10608
10609 @item -mbase-addresses
10610 @itemx -mno-base-addresses
10611 @opindex mbase-addresses
10612 @opindex mno-base-addresses
10613 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10614 base address automatically generates a request (handled by the assembler
10615 and the linker) for a constant to be set up in a global register.  The
10616 register is used for one or more base address requests within the range 0
10617 to 255 from the value held in the register.  The generally leads to short
10618 and fast code, but the number of different data items that can be
10619 addressed is limited.  This means that a program that uses lots of static
10620 data may require @option{-mno-base-addresses}.
10621
10622 @item -msingle-exit
10623 @itemx -mno-single-exit
10624 @opindex msingle-exit
10625 @opindex mno-single-exit
10626 Force (do not force) generated code to have a single exit point in each
10627 function.
10628 @end table
10629
10630 @node MN10300 Options
10631 @subsection MN10300 Options
10632 @cindex MN10300 options
10633
10634 These @option{-m} options are defined for Matsushita MN10300 architectures:
10635
10636 @table @gcctabopt
10637 @item -mmult-bug
10638 @opindex mmult-bug
10639 Generate code to avoid bugs in the multiply instructions for the MN10300
10640 processors.  This is the default.
10641
10642 @item -mno-mult-bug
10643 @opindex mno-mult-bug
10644 Do not generate code to avoid bugs in the multiply instructions for the
10645 MN10300 processors.
10646
10647 @item -mam33
10648 @opindex mam33
10649 Generate code which uses features specific to the AM33 processor.
10650
10651 @item -mno-am33
10652 @opindex mno-am33
10653 Do not generate code which uses features specific to the AM33 processor.  This
10654 is the default.
10655
10656 @item -mreturn-pointer-on-d0
10657 @opindex mreturn-pointer-on-d0
10658 When generating a function which returns a pointer, return the pointer
10659 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10660 only in a0, and attempts to call such functions without a prototype
10661 would result in errors.  Note that this option is on by default; use
10662 @option{-mno-return-pointer-on-d0} to disable it.
10663
10664 @item -mno-crt0
10665 @opindex mno-crt0
10666 Do not link in the C run-time initialization object file.
10667
10668 @item -mrelax
10669 @opindex mrelax
10670 Indicate to the linker that it should perform a relaxation optimization pass
10671 to shorten branches, calls and absolute memory addresses.  This option only
10672 has an effect when used on the command line for the final link step.
10673
10674 This option makes symbolic debugging impossible.
10675 @end table
10676
10677 @node MT Options
10678 @subsection MT Options
10679 @cindex MT options
10680
10681 These @option{-m} options are defined for Morpho MT architectures:
10682
10683 @table @gcctabopt
10684
10685 @item -march=@var{cpu-type}
10686 @opindex march
10687 Generate code that will run on @var{cpu-type}, which is the name of a system
10688 representing a certain processor type.  Possible values for
10689 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10690 @samp{ms1-16-003} and @samp{ms2}.
10691
10692 When this option is not used, the default is @option{-march=ms1-16-002}.
10693
10694 @item -mbacc
10695 @opindex mbacc
10696 Use byte loads and stores when generating code.
10697
10698 @item -mno-bacc
10699 @opindex mno-bacc
10700 Do not use byte loads and stores when generating code.
10701
10702 @item -msim
10703 @opindex msim
10704 Use simulator runtime
10705
10706 @item -mno-crt0
10707 @opindex mno-crt0
10708 Do not link in the C run-time initialization object file
10709 @file{crti.o}.  Other run-time initialization and termination files
10710 such as @file{startup.o} and @file{exit.o} are still included on the
10711 linker command line.
10712
10713 @end table
10714
10715 @node PDP-11 Options
10716 @subsection PDP-11 Options
10717 @cindex PDP-11 Options
10718
10719 These options are defined for the PDP-11:
10720
10721 @table @gcctabopt
10722 @item -mfpu
10723 @opindex mfpu
10724 Use hardware FPP floating point.  This is the default.  (FIS floating
10725 point on the PDP-11/40 is not supported.)
10726
10727 @item -msoft-float
10728 @opindex msoft-float
10729 Do not use hardware floating point.
10730
10731 @item -mac0
10732 @opindex mac0
10733 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10734
10735 @item -mno-ac0
10736 @opindex mno-ac0
10737 Return floating-point results in memory.  This is the default.
10738
10739 @item -m40
10740 @opindex m40
10741 Generate code for a PDP-11/40.
10742
10743 @item -m45
10744 @opindex m45
10745 Generate code for a PDP-11/45.  This is the default.
10746
10747 @item -m10
10748 @opindex m10
10749 Generate code for a PDP-11/10.
10750
10751 @item -mbcopy-builtin
10752 @opindex bcopy-builtin
10753 Use inline @code{movmemhi} patterns for copying memory.  This is the
10754 default.
10755
10756 @item -mbcopy
10757 @opindex mbcopy
10758 Do not use inline @code{movmemhi} patterns for copying memory.
10759
10760 @item -mint16
10761 @itemx -mno-int32
10762 @opindex mint16
10763 @opindex mno-int32
10764 Use 16-bit @code{int}.  This is the default.
10765
10766 @item -mint32
10767 @itemx -mno-int16
10768 @opindex mint32
10769 @opindex mno-int16
10770 Use 32-bit @code{int}.
10771
10772 @item -mfloat64
10773 @itemx -mno-float32
10774 @opindex mfloat64
10775 @opindex mno-float32
10776 Use 64-bit @code{float}.  This is the default.
10777
10778 @item -mfloat32
10779 @itemx -mno-float64
10780 @opindex mfloat32
10781 @opindex mno-float64
10782 Use 32-bit @code{float}.
10783
10784 @item -mabshi
10785 @opindex mabshi
10786 Use @code{abshi2} pattern.  This is the default.
10787
10788 @item -mno-abshi
10789 @opindex mno-abshi
10790 Do not use @code{abshi2} pattern.
10791
10792 @item -mbranch-expensive
10793 @opindex mbranch-expensive
10794 Pretend that branches are expensive.  This is for experimenting with
10795 code generation only.
10796
10797 @item -mbranch-cheap
10798 @opindex mbranch-cheap
10799 Do not pretend that branches are expensive.  This is the default.
10800
10801 @item -msplit
10802 @opindex msplit
10803 Generate code for a system with split I&D@.
10804
10805 @item -mno-split
10806 @opindex mno-split
10807 Generate code for a system without split I&D@.  This is the default.
10808
10809 @item -munix-asm
10810 @opindex munix-asm
10811 Use Unix assembler syntax.  This is the default when configured for
10812 @samp{pdp11-*-bsd}.
10813
10814 @item -mdec-asm
10815 @opindex mdec-asm
10816 Use DEC assembler syntax.  This is the default when configured for any
10817 PDP-11 target other than @samp{pdp11-*-bsd}.
10818 @end table
10819
10820 @node PowerPC Options
10821 @subsection PowerPC Options
10822 @cindex PowerPC options
10823
10824 These are listed under @xref{RS/6000 and PowerPC Options}.
10825
10826 @node RS/6000 and PowerPC Options
10827 @subsection IBM RS/6000 and PowerPC Options
10828 @cindex RS/6000 and PowerPC Options
10829 @cindex IBM RS/6000 and PowerPC Options
10830
10831 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10832 @table @gcctabopt
10833 @item -mpower
10834 @itemx -mno-power
10835 @itemx -mpower2
10836 @itemx -mno-power2
10837 @itemx -mpowerpc
10838 @itemx -mno-powerpc
10839 @itemx -mpowerpc-gpopt
10840 @itemx -mno-powerpc-gpopt
10841 @itemx -mpowerpc-gfxopt
10842 @itemx -mno-powerpc-gfxopt
10843 @itemx -mpowerpc64
10844 @itemx -mno-powerpc64
10845 @itemx -mmfcrf
10846 @itemx -mno-mfcrf
10847 @itemx -mpopcntb
10848 @itemx -mno-popcntb
10849 @itemx -mfprnd
10850 @itemx -mno-fprnd
10851 @opindex mpower
10852 @opindex mno-power
10853 @opindex mpower2
10854 @opindex mno-power2
10855 @opindex mpowerpc
10856 @opindex mno-powerpc
10857 @opindex mpowerpc-gpopt
10858 @opindex mno-powerpc-gpopt
10859 @opindex mpowerpc-gfxopt
10860 @opindex mno-powerpc-gfxopt
10861 @opindex mpowerpc64
10862 @opindex mno-powerpc64
10863 @opindex mmfcrf
10864 @opindex mno-mfcrf
10865 @opindex mpopcntb
10866 @opindex mno-popcntb
10867 @opindex mfprnd
10868 @opindex mno-fprnd
10869 GCC supports two related instruction set architectures for the
10870 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10871 instructions supported by the @samp{rios} chip set used in the original
10872 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10873 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10874 the IBM 4xx, 6xx, and follow-on microprocessors.
10875
10876 Neither architecture is a subset of the other.  However there is a
10877 large common subset of instructions supported by both.  An MQ
10878 register is included in processors supporting the POWER architecture.
10879
10880 You use these options to specify which instructions are available on the
10881 processor you are using.  The default value of these options is
10882 determined when configuring GCC@.  Specifying the
10883 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10884 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10885 rather than the options listed above.
10886
10887 The @option{-mpower} option allows GCC to generate instructions that
10888 are found only in the POWER architecture and to use the MQ register.
10889 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10890 to generate instructions that are present in the POWER2 architecture but
10891 not the original POWER architecture.
10892
10893 The @option{-mpowerpc} option allows GCC to generate instructions that
10894 are found only in the 32-bit subset of the PowerPC architecture.
10895 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10896 GCC to use the optional PowerPC architecture instructions in the
10897 General Purpose group, including floating-point square root.  Specifying
10898 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10899 use the optional PowerPC architecture instructions in the Graphics
10900 group, including floating-point select.
10901
10902 The @option{-mmfcrf} option allows GCC to generate the move from
10903 condition register field instruction implemented on the POWER4
10904 processor and other processors that support the PowerPC V2.01
10905 architecture.
10906 The @option{-mpopcntb} option allows GCC to generate the popcount and
10907 double precision FP reciprocal estimate instruction implemented on the
10908 POWER5 processor and other processors that support the PowerPC V2.02
10909 architecture.
10910 The @option{-mfprnd} option allows GCC to generate the FP round to
10911 integer instructions implemented on the POWER5+ processor and other
10912 processors that support the PowerPC V2.03 architecture.
10913
10914 The @option{-mpowerpc64} option allows GCC to generate the additional
10915 64-bit instructions that are found in the full PowerPC64 architecture
10916 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10917 @option{-mno-powerpc64}.
10918
10919 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10920 will use only the instructions in the common subset of both
10921 architectures plus some special AIX common-mode calls, and will not use
10922 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10923 permits GCC to use any instruction from either architecture and to
10924 allow use of the MQ register; specify this for the Motorola MPC601.
10925
10926 @item -mnew-mnemonics
10927 @itemx -mold-mnemonics
10928 @opindex mnew-mnemonics
10929 @opindex mold-mnemonics
10930 Select which mnemonics to use in the generated assembler code.  With
10931 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10932 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10933 assembler mnemonics defined for the POWER architecture.  Instructions
10934 defined in only one architecture have only one mnemonic; GCC uses that
10935 mnemonic irrespective of which of these options is specified.
10936
10937 GCC defaults to the mnemonics appropriate for the architecture in
10938 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10939 value of these option.  Unless you are building a cross-compiler, you
10940 should normally not specify either @option{-mnew-mnemonics} or
10941 @option{-mold-mnemonics}, but should instead accept the default.
10942
10943 @item -mcpu=@var{cpu_type}
10944 @opindex mcpu
10945 Set architecture type, register usage, choice of mnemonics, and
10946 instruction scheduling parameters for machine type @var{cpu_type}.
10947 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10948 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10949 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10950 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10951 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10952 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
10953 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10954 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
10955 @samp{common}, @samp{powerpc}, @samp{powerpc64},
10956 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10957
10958 @option{-mcpu=common} selects a completely generic processor.  Code
10959 generated under this option will run on any POWER or PowerPC processor.
10960 GCC will use only the instructions in the common subset of both
10961 architectures, and will not use the MQ register.  GCC assumes a generic
10962 processor model for scheduling purposes.
10963
10964 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10965 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10966 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10967 types, with an appropriate, generic processor model assumed for
10968 scheduling purposes.
10969
10970 The other options specify a specific processor.  Code generated under
10971 those options will run best on that processor, and may not run at all on
10972 others.
10973
10974 The @option{-mcpu} options automatically enable or disable the
10975 following options: @option{-maltivec}, @option{-mfprnd},
10976 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
10977 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
10978 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
10979 @option{-mpowerpc-gfxopt}, @option{-mstring}.  The particular options
10980 set for any particular CPU will vary between compiler versions,
10981 depending on what setting seems to produce optimal code for that CPU;
10982 it doesn't necessarily reflect the actual hardware's capabilities.  If
10983 you wish to set an individual option to a particular value, you may
10984 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
10985 -mno-altivec}.
10986
10987 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10988 not enabled or disabled by the @option{-mcpu} option at present because
10989 AIX does not have full support for these options.  You may still
10990 enable or disable them individually if you're sure it'll work in your
10991 environment.
10992
10993 @item -mtune=@var{cpu_type}
10994 @opindex mtune
10995 Set the instruction scheduling parameters for machine type
10996 @var{cpu_type}, but do not set the architecture type, register usage, or
10997 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10998 values for @var{cpu_type} are used for @option{-mtune} as for
10999 @option{-mcpu}.  If both are specified, the code generated will use the
11000 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11001 scheduling parameters set by @option{-mtune}.
11002
11003 @item -mswdiv
11004 @itemx -mno-swdiv
11005 @opindex mswdiv
11006 @opindex mno-swdiv
11007 Generate code to compute division as reciprocal estimate and iterative
11008 refinement, creating opportunities for increased throughput.  This
11009 feature requires: optional PowerPC Graphics instruction set for single
11010 precision and FRE instruction for double precision, assuming divides
11011 cannot generate user-visible traps, and the domain values not include
11012 Infinities, denormals or zero denominator.
11013
11014 @item -maltivec
11015 @itemx -mno-altivec
11016 @opindex maltivec
11017 @opindex mno-altivec
11018 Generate code that uses (does not use) AltiVec instructions, and also
11019 enable the use of built-in functions that allow more direct access to
11020 the AltiVec instruction set.  You may also need to set
11021 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11022 enhancements.
11023
11024 @item -mvrsave
11025 @item -mno-vrsave
11026 @opindex mvrsave
11027 @opindex mno-vrsave
11028 Generate VRSAVE instructions when generating AltiVec code.
11029
11030 @item -msecure-plt
11031 @opindex msecure-plt
11032 Generate code that allows ld and ld.so to build executables and shared
11033 libraries with non-exec .plt and .got sections.  This is a PowerPC
11034 32-bit SYSV ABI option.
11035
11036 @item -mbss-plt
11037 @opindex mbss-plt
11038 Generate code that uses a BSS .plt section that ld.so fills in, and
11039 requires .plt and .got sections that are both writable and executable.
11040 This is a PowerPC 32-bit SYSV ABI option.
11041
11042 @item -misel
11043 @itemx -mno-isel
11044 @opindex misel
11045 @opindex mno-isel
11046 This switch enables or disables the generation of ISEL instructions.
11047
11048 @item -misel=@var{yes/no}
11049 This switch has been deprecated.  Use @option{-misel} and
11050 @option{-mno-isel} instead.
11051
11052 @item -mspe
11053 @itemx -mno-isel
11054 @opindex mspe
11055 @opindex mno-spe
11056 This switch enables or disables the generation of SPE simd
11057 instructions.
11058
11059 @item -mspe=@var{yes/no}
11060 This option has been deprecated.  Use @option{-mspe} and
11061 @option{-mno-spe} instead.
11062
11063 @item -mfloat-gprs=@var{yes/single/double/no}
11064 @itemx -mfloat-gprs
11065 @opindex mfloat-gprs
11066 This switch enables or disables the generation of floating point
11067 operations on the general purpose registers for architectures that
11068 support it.
11069
11070 The argument @var{yes} or @var{single} enables the use of
11071 single-precision floating point operations.
11072
11073 The argument @var{double} enables the use of single and
11074 double-precision floating point operations.
11075
11076 The argument @var{no} disables floating point operations on the
11077 general purpose registers.
11078
11079 This option is currently only available on the MPC854x.
11080
11081 @item -m32
11082 @itemx -m64
11083 @opindex m32
11084 @opindex m64
11085 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11086 targets (including GNU/Linux).  The 32-bit environment sets int, long
11087 and pointer to 32 bits and generates code that runs on any PowerPC
11088 variant.  The 64-bit environment sets int to 32 bits and long and
11089 pointer to 64 bits, and generates code for PowerPC64, as for
11090 @option{-mpowerpc64}.
11091
11092 @item -mfull-toc
11093 @itemx -mno-fp-in-toc
11094 @itemx -mno-sum-in-toc
11095 @itemx -mminimal-toc
11096 @opindex mfull-toc
11097 @opindex mno-fp-in-toc
11098 @opindex mno-sum-in-toc
11099 @opindex mminimal-toc
11100 Modify generation of the TOC (Table Of Contents), which is created for
11101 every executable file.  The @option{-mfull-toc} option is selected by
11102 default.  In that case, GCC will allocate at least one TOC entry for
11103 each unique non-automatic variable reference in your program.  GCC
11104 will also place floating-point constants in the TOC@.  However, only
11105 16,384 entries are available in the TOC@.
11106
11107 If you receive a linker error message that saying you have overflowed
11108 the available TOC space, you can reduce the amount of TOC space used
11109 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11110 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11111 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11112 generate code to calculate the sum of an address and a constant at
11113 run-time instead of putting that sum into the TOC@.  You may specify one
11114 or both of these options.  Each causes GCC to produce very slightly
11115 slower and larger code at the expense of conserving TOC space.
11116
11117 If you still run out of space in the TOC even when you specify both of
11118 these options, specify @option{-mminimal-toc} instead.  This option causes
11119 GCC to make only one TOC entry for every file.  When you specify this
11120 option, GCC will produce code that is slower and larger but which
11121 uses extremely little TOC space.  You may wish to use this option
11122 only on files that contain less frequently executed code.
11123
11124 @item -maix64
11125 @itemx -maix32
11126 @opindex maix64
11127 @opindex maix32
11128 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11129 @code{long} type, and the infrastructure needed to support them.
11130 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11131 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11132 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11133
11134 @item -mxl-compat
11135 @itemx -mno-xl-compat
11136 @opindex mxl-compat
11137 @opindex mno-xl-compat
11138 Produce code that conforms more closely to IBM XL compiler semantics
11139 when using AIX-compatible ABI.  Pass floating-point arguments to
11140 prototyped functions beyond the register save area (RSA) on the stack
11141 in addition to argument FPRs.  Do not assume that most significant
11142 double in 128-bit long double value is properly rounded when comparing
11143 values and converting to double.  Use XL symbol names for long double
11144 support routines.
11145
11146 The AIX calling convention was extended but not initially documented to
11147 handle an obscure K&R C case of calling a function that takes the
11148 address of its arguments with fewer arguments than declared.  IBM XL
11149 compilers access floating point arguments which do not fit in the
11150 RSA from the stack when a subroutine is compiled without
11151 optimization.  Because always storing floating-point arguments on the
11152 stack is inefficient and rarely needed, this option is not enabled by
11153 default and only is necessary when calling subroutines compiled by IBM
11154 XL compilers without optimization.
11155
11156 @item -mpe
11157 @opindex mpe
11158 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11159 application written to use message passing with special startup code to
11160 enable the application to run.  The system must have PE installed in the
11161 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11162 must be overridden with the @option{-specs=} option to specify the
11163 appropriate directory location.  The Parallel Environment does not
11164 support threads, so the @option{-mpe} option and the @option{-pthread}
11165 option are incompatible.
11166
11167 @item -malign-natural
11168 @itemx -malign-power
11169 @opindex malign-natural
11170 @opindex malign-power
11171 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11172 @option{-malign-natural} overrides the ABI-defined alignment of larger
11173 types, such as floating-point doubles, on their natural size-based boundary.
11174 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11175 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11176
11177 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11178 is not supported.
11179
11180 @item -msoft-float
11181 @itemx -mhard-float
11182 @opindex msoft-float
11183 @opindex mhard-float
11184 Generate code that does not use (uses) the floating-point register set.
11185 Software floating point emulation is provided if you use the
11186 @option{-msoft-float} option, and pass the option to GCC when linking.
11187
11188 @item -mmultiple
11189 @itemx -mno-multiple
11190 @opindex mmultiple
11191 @opindex mno-multiple
11192 Generate code that uses (does not use) the load multiple word
11193 instructions and the store multiple word instructions.  These
11194 instructions are generated by default on POWER systems, and not
11195 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11196 endian PowerPC systems, since those instructions do not work when the
11197 processor is in little endian mode.  The exceptions are PPC740 and
11198 PPC750 which permit the instructions usage in little endian mode.
11199
11200 @item -mstring
11201 @itemx -mno-string
11202 @opindex mstring
11203 @opindex mno-string
11204 Generate code that uses (does not use) the load string instructions
11205 and the store string word instructions to save multiple registers and
11206 do small block moves.  These instructions are generated by default on
11207 POWER systems, and not generated on PowerPC systems.  Do not use
11208 @option{-mstring} on little endian PowerPC systems, since those
11209 instructions do not work when the processor is in little endian mode.
11210 The exceptions are PPC740 and PPC750 which permit the instructions
11211 usage in little endian mode.
11212
11213 @item -mupdate
11214 @itemx -mno-update
11215 @opindex mupdate
11216 @opindex mno-update
11217 Generate code that uses (does not use) the load or store instructions
11218 that update the base register to the address of the calculated memory
11219 location.  These instructions are generated by default.  If you use
11220 @option{-mno-update}, there is a small window between the time that the
11221 stack pointer is updated and the address of the previous frame is
11222 stored, which means code that walks the stack frame across interrupts or
11223 signals may get corrupted data.
11224
11225 @item -mfused-madd
11226 @itemx -mno-fused-madd
11227 @opindex mfused-madd
11228 @opindex mno-fused-madd
11229 Generate code that uses (does not use) the floating point multiply and
11230 accumulate instructions.  These instructions are generated by default if
11231 hardware floating is used.
11232
11233 @item -mno-bit-align
11234 @itemx -mbit-align
11235 @opindex mno-bit-align
11236 @opindex mbit-align
11237 On System V.4 and embedded PowerPC systems do not (do) force structures
11238 and unions that contain bit-fields to be aligned to the base type of the
11239 bit-field.
11240
11241 For example, by default a structure containing nothing but 8
11242 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11243 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11244 the structure would be aligned to a 1 byte boundary and be one byte in
11245 size.
11246
11247 @item -mno-strict-align
11248 @itemx -mstrict-align
11249 @opindex mno-strict-align
11250 @opindex mstrict-align
11251 On System V.4 and embedded PowerPC systems do not (do) assume that
11252 unaligned memory references will be handled by the system.
11253
11254 @item -mrelocatable
11255 @itemx -mno-relocatable
11256 @opindex mrelocatable
11257 @opindex mno-relocatable
11258 On embedded PowerPC systems generate code that allows (does not allow)
11259 the program to be relocated to a different address at runtime.  If you
11260 use @option{-mrelocatable} on any module, all objects linked together must
11261 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11262
11263 @item -mrelocatable-lib
11264 @itemx -mno-relocatable-lib
11265 @opindex mrelocatable-lib
11266 @opindex mno-relocatable-lib
11267 On embedded PowerPC systems generate code that allows (does not allow)
11268 the program to be relocated to a different address at runtime.  Modules
11269 compiled with @option{-mrelocatable-lib} can be linked with either modules
11270 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11271 with modules compiled with the @option{-mrelocatable} options.
11272
11273 @item -mno-toc
11274 @itemx -mtoc
11275 @opindex mno-toc
11276 @opindex mtoc
11277 On System V.4 and embedded PowerPC systems do not (do) assume that
11278 register 2 contains a pointer to a global area pointing to the addresses
11279 used in the program.
11280
11281 @item -mlittle
11282 @itemx -mlittle-endian
11283 @opindex mlittle
11284 @opindex mlittle-endian
11285 On System V.4 and embedded PowerPC systems compile code for the
11286 processor in little endian mode.  The @option{-mlittle-endian} option is
11287 the same as @option{-mlittle}.
11288
11289 @item -mbig
11290 @itemx -mbig-endian
11291 @opindex mbig
11292 @opindex mbig-endian
11293 On System V.4 and embedded PowerPC systems compile code for the
11294 processor in big endian mode.  The @option{-mbig-endian} option is
11295 the same as @option{-mbig}.
11296
11297 @item -mdynamic-no-pic
11298 @opindex mdynamic-no-pic
11299 On Darwin and Mac OS X systems, compile code so that it is not
11300 relocatable, but that its external references are relocatable.  The
11301 resulting code is suitable for applications, but not shared
11302 libraries.
11303
11304 @item -mprioritize-restricted-insns=@var{priority}
11305 @opindex mprioritize-restricted-insns
11306 This option controls the priority that is assigned to
11307 dispatch-slot restricted instructions during the second scheduling
11308 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11309 @var{no/highest/second-highest} priority to dispatch slot restricted
11310 instructions.
11311
11312 @item -msched-costly-dep=@var{dependence_type}
11313 @opindex msched-costly-dep
11314 This option controls which dependences are considered costly
11315 by the target during instruction scheduling.  The argument
11316 @var{dependence_type} takes one of the following values:
11317 @var{no}: no dependence is costly,
11318 @var{all}: all dependences are costly,
11319 @var{true_store_to_load}: a true dependence from store to load is costly,
11320 @var{store_to_load}: any dependence from store to load is costly,
11321 @var{number}: any dependence which latency >= @var{number} is costly.
11322
11323 @item -minsert-sched-nops=@var{scheme}
11324 @opindex minsert-sched-nops
11325 This option controls which nop insertion scheme will be used during
11326 the second scheduling pass.  The argument @var{scheme} takes one of the
11327 following values:
11328 @var{no}: Don't insert nops.
11329 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11330 according to the scheduler's grouping.
11331 @var{regroup_exact}: Insert nops to force costly dependent insns into
11332 separate groups.  Insert exactly as many nops as needed to force an insn
11333 to a new group, according to the estimated processor grouping.
11334 @var{number}: Insert nops to force costly dependent insns into
11335 separate groups.  Insert @var{number} nops to force an insn to a new group.
11336
11337 @item -mcall-sysv
11338 @opindex mcall-sysv
11339 On System V.4 and embedded PowerPC systems compile code using calling
11340 conventions that adheres to the March 1995 draft of the System V
11341 Application Binary Interface, PowerPC processor supplement.  This is the
11342 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11343
11344 @item -mcall-sysv-eabi
11345 @opindex mcall-sysv-eabi
11346 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11347
11348 @item -mcall-sysv-noeabi
11349 @opindex mcall-sysv-noeabi
11350 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11351
11352 @item -mcall-solaris
11353 @opindex mcall-solaris
11354 On System V.4 and embedded PowerPC systems compile code for the Solaris
11355 operating system.
11356
11357 @item -mcall-linux
11358 @opindex mcall-linux
11359 On System V.4 and embedded PowerPC systems compile code for the
11360 Linux-based GNU system.
11361
11362 @item -mcall-gnu
11363 @opindex mcall-gnu
11364 On System V.4 and embedded PowerPC systems compile code for the
11365 Hurd-based GNU system.
11366
11367 @item -mcall-netbsd
11368 @opindex mcall-netbsd
11369 On System V.4 and embedded PowerPC systems compile code for the
11370 NetBSD operating system.
11371
11372 @item -maix-struct-return
11373 @opindex maix-struct-return
11374 Return all structures in memory (as specified by the AIX ABI)@.
11375
11376 @item -msvr4-struct-return
11377 @opindex msvr4-struct-return
11378 Return structures smaller than 8 bytes in registers (as specified by the
11379 SVR4 ABI)@.
11380
11381 @item -mabi=@var{abi-type}
11382 @opindex mabi
11383 Extend the current ABI with a particular extension, or remove such extension.
11384 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11385 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11386
11387 @item -mabi=spe
11388 @opindex mabi=spe
11389 Extend the current ABI with SPE ABI extensions.  This does not change
11390 the default ABI, instead it adds the SPE ABI extensions to the current
11391 ABI@.
11392
11393 @item -mabi=no-spe
11394 @opindex mabi=no-spe
11395 Disable Booke SPE ABI extensions for the current ABI@.
11396
11397 @item -mabi=ibmlongdouble
11398 @opindex mabi=ibmlongdouble
11399 Change the current ABI to use IBM extended precision long double.
11400 This is a PowerPC 32-bit SYSV ABI option.
11401
11402 @item -mabi=ieeelongdouble
11403 @opindex mabi=ieeelongdouble
11404 Change the current ABI to use IEEE extended precision long double.
11405 This is a PowerPC 32-bit Linux ABI option.
11406
11407 @item -mprototype
11408 @itemx -mno-prototype
11409 @opindex mprototype
11410 @opindex mno-prototype
11411 On System V.4 and embedded PowerPC systems assume that all calls to
11412 variable argument functions are properly prototyped.  Otherwise, the
11413 compiler must insert an instruction before every non prototyped call to
11414 set or clear bit 6 of the condition code register (@var{CR}) to
11415 indicate whether floating point values were passed in the floating point
11416 registers in case the function takes a variable arguments.  With
11417 @option{-mprototype}, only calls to prototyped variable argument functions
11418 will set or clear the bit.
11419
11420 @item -msim
11421 @opindex msim
11422 On embedded PowerPC systems, assume that the startup module is called
11423 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11424 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11425 configurations.
11426
11427 @item -mmvme
11428 @opindex mmvme
11429 On embedded PowerPC systems, assume that the startup module is called
11430 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11431 @file{libc.a}.
11432
11433 @item -mads
11434 @opindex mads
11435 On embedded PowerPC systems, assume that the startup module is called
11436 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11437 @file{libc.a}.
11438
11439 @item -myellowknife
11440 @opindex myellowknife
11441 On embedded PowerPC systems, assume that the startup module is called
11442 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11443 @file{libc.a}.
11444
11445 @item -mvxworks
11446 @opindex mvxworks
11447 On System V.4 and embedded PowerPC systems, specify that you are
11448 compiling for a VxWorks system.
11449
11450 @item -mwindiss
11451 @opindex mwindiss
11452 Specify that you are compiling for the WindISS simulation environment.
11453
11454 @item -memb
11455 @opindex memb
11456 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11457 header to indicate that @samp{eabi} extended relocations are used.
11458
11459 @item -meabi
11460 @itemx -mno-eabi
11461 @opindex meabi
11462 @opindex mno-eabi
11463 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11464 Embedded Applications Binary Interface (eabi) which is a set of
11465 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11466 means that the stack is aligned to an 8 byte boundary, a function
11467 @code{__eabi} is called to from @code{main} to set up the eabi
11468 environment, and the @option{-msdata} option can use both @code{r2} and
11469 @code{r13} to point to two separate small data areas.  Selecting
11470 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11471 do not call an initialization function from @code{main}, and the
11472 @option{-msdata} option will only use @code{r13} to point to a single
11473 small data area.  The @option{-meabi} option is on by default if you
11474 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11475
11476 @item -msdata=eabi
11477 @opindex msdata=eabi
11478 On System V.4 and embedded PowerPC systems, put small initialized
11479 @code{const} global and static data in the @samp{.sdata2} section, which
11480 is pointed to by register @code{r2}.  Put small initialized
11481 non-@code{const} global and static data in the @samp{.sdata} section,
11482 which is pointed to by register @code{r13}.  Put small uninitialized
11483 global and static data in the @samp{.sbss} section, which is adjacent to
11484 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11485 incompatible with the @option{-mrelocatable} option.  The
11486 @option{-msdata=eabi} option also sets the @option{-memb} option.
11487
11488 @item -msdata=sysv
11489 @opindex msdata=sysv
11490 On System V.4 and embedded PowerPC systems, put small global and static
11491 data in the @samp{.sdata} section, which is pointed to by register
11492 @code{r13}.  Put small uninitialized global and static data in the
11493 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11494 The @option{-msdata=sysv} option is incompatible with the
11495 @option{-mrelocatable} option.
11496
11497 @item -msdata=default
11498 @itemx -msdata
11499 @opindex msdata=default
11500 @opindex msdata
11501 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11502 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11503 same as @option{-msdata=sysv}.
11504
11505 @item -msdata-data
11506 @opindex msdata-data
11507 On System V.4 and embedded PowerPC systems, put small global and static
11508 data in the @samp{.sdata} section.  Put small uninitialized global and
11509 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11510 to address small data however.  This is the default behavior unless
11511 other @option{-msdata} options are used.
11512
11513 @item -msdata=none
11514 @itemx -mno-sdata
11515 @opindex msdata=none
11516 @opindex mno-sdata
11517 On embedded PowerPC systems, put all initialized global and static data
11518 in the @samp{.data} section, and all uninitialized data in the
11519 @samp{.bss} section.
11520
11521 @item -G @var{num}
11522 @opindex G
11523 @cindex smaller data references (PowerPC)
11524 @cindex .sdata/.sdata2 references (PowerPC)
11525 On embedded PowerPC systems, put global and static items less than or
11526 equal to @var{num} bytes into the small data or bss sections instead of
11527 the normal data or bss section.  By default, @var{num} is 8.  The
11528 @option{-G @var{num}} switch is also passed to the linker.
11529 All modules should be compiled with the same @option{-G @var{num}} value.
11530
11531 @item -mregnames
11532 @itemx -mno-regnames
11533 @opindex mregnames
11534 @opindex mno-regnames
11535 On System V.4 and embedded PowerPC systems do (do not) emit register
11536 names in the assembly language output using symbolic forms.
11537
11538 @item -mlongcall
11539 @itemx -mno-longcall
11540 @opindex mlongcall
11541 @opindex mno-longcall
11542 Default to making all function calls indirectly, using a register, so
11543 that functions which reside further than 32 megabytes (33,554,432
11544 bytes) from the current location can be called.  This setting can be
11545 overridden by the @code{shortcall} function attribute, or by
11546 @code{#pragma longcall(0)}.
11547
11548 Some linkers are capable of detecting out-of-range calls and generating
11549 glue code on the fly.  On these systems, long calls are unnecessary and
11550 generate slower code.  As of this writing, the AIX linker can do this,
11551 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11552 to the GNU linker for 32-bit PowerPC systems as well.
11553
11554 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11555 callee, L42'', plus a ``branch island'' (glue code).  The two target
11556 addresses represent the callee and the ``branch island''.  The
11557 Darwin/PPC linker will prefer the first address and generate a ``bl
11558 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11559 otherwise, the linker will generate ``bl L42'' to call the ``branch
11560 island''.  The ``branch island'' is appended to the body of the
11561 calling function; it computes the full 32-bit address of the callee
11562 and jumps to it.
11563
11564 On Mach-O (Darwin) systems, this option directs the compiler emit to
11565 the glue for every direct call, and the Darwin linker decides whether
11566 to use or discard it.
11567
11568 In the future, we may cause GCC to ignore all longcall specifications
11569 when the linker is known to generate glue.
11570
11571 @item -pthread
11572 @opindex pthread
11573 Adds support for multithreading with the @dfn{pthreads} library.
11574 This option sets flags for both the preprocessor and linker.
11575
11576 @end table
11577
11578 @node S/390 and zSeries Options
11579 @subsection S/390 and zSeries Options
11580 @cindex S/390 and zSeries Options
11581
11582 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11583
11584 @table @gcctabopt
11585 @item -mhard-float
11586 @itemx -msoft-float
11587 @opindex mhard-float
11588 @opindex msoft-float
11589 Use (do not use) the hardware floating-point instructions and registers
11590 for floating-point operations.  When @option{-msoft-float} is specified,
11591 functions in @file{libgcc.a} will be used to perform floating-point
11592 operations.  When @option{-mhard-float} is specified, the compiler
11593 generates IEEE floating-point instructions.  This is the default.
11594
11595 @item -mlong-double-64
11596 @itemx -mlong-double-128
11597 @opindex mlong-double-64
11598 @opindex mlong-double-128
11599 These switches control the size of @code{long double} type. A size
11600 of 64bit makes the @code{long double} type equivalent to the @code{double}
11601 type. This is the default.
11602
11603 @item -mbackchain
11604 @itemx -mno-backchain
11605 @opindex mbackchain
11606 @opindex mno-backchain
11607 Store (do not store) the address of the caller's frame as backchain pointer
11608 into the callee's stack frame.
11609 A backchain may be needed to allow debugging using tools that do not understand
11610 DWARF-2 call frame information.
11611 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11612 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11613 the backchain is placed into the topmost word of the 96/160 byte register
11614 save area.
11615
11616 In general, code compiled with @option{-mbackchain} is call-compatible with
11617 code compiled with @option{-mmo-backchain}; however, use of the backchain
11618 for debugging purposes usually requires that the whole binary is built with
11619 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11620 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11621 to build a linux kernel use @option{-msoft-float}.
11622
11623 The default is to not maintain the backchain.
11624
11625 @item -mpacked-stack
11626 @item -mno-packed-stack
11627 @opindex mpacked-stack
11628 @opindex mno-packed-stack
11629 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11630 specified, the compiler uses the all fields of the 96/160 byte register save
11631 area only for their default purpose; unused fields still take up stack space.
11632 When @option{-mpacked-stack} is specified, register save slots are densely
11633 packed at the top of the register save area; unused space is reused for other
11634 purposes, allowing for more efficient use of the available stack space.
11635 However, when @option{-mbackchain} is also in effect, the topmost word of
11636 the save area is always used to store the backchain, and the return address
11637 register is always saved two words below the backchain.
11638
11639 As long as the stack frame backchain is not used, code generated with
11640 @option{-mpacked-stack} is call-compatible with code generated with
11641 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11642 S/390 or zSeries generated code that uses the stack frame backchain at run
11643 time, not just for debugging purposes.  Such code is not call-compatible
11644 with code compiled with @option{-mpacked-stack}.  Also, note that the
11645 combination of @option{-mbackchain},
11646 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11647 to build a linux kernel use @option{-msoft-float}.
11648
11649 The default is to not use the packed stack layout.
11650
11651 @item -msmall-exec
11652 @itemx -mno-small-exec
11653 @opindex msmall-exec
11654 @opindex mno-small-exec
11655 Generate (or do not generate) code using the @code{bras} instruction
11656 to do subroutine calls.
11657 This only works reliably if the total executable size does not
11658 exceed 64k.  The default is to use the @code{basr} instruction instead,
11659 which does not have this limitation.
11660
11661 @item -m64
11662 @itemx -m31
11663 @opindex m64
11664 @opindex m31
11665 When @option{-m31} is specified, generate code compliant to the
11666 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11667 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11668 particular to generate 64-bit instructions.  For the @samp{s390}
11669 targets, the default is @option{-m31}, while the @samp{s390x}
11670 targets default to @option{-m64}.
11671
11672 @item -mzarch
11673 @itemx -mesa
11674 @opindex mzarch
11675 @opindex mesa
11676 When @option{-mzarch} is specified, generate code using the
11677 instructions available on z/Architecture.
11678 When @option{-mesa} is specified, generate code using the
11679 instructions available on ESA/390.  Note that @option{-mesa} is
11680 not possible with @option{-m64}.
11681 When generating code compliant to the GNU/Linux for S/390 ABI,
11682 the default is @option{-mesa}.  When generating code compliant
11683 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11684
11685 @item -mmvcle
11686 @itemx -mno-mvcle
11687 @opindex mmvcle
11688 @opindex mno-mvcle
11689 Generate (or do not generate) code using the @code{mvcle} instruction
11690 to perform block moves.  When @option{-mno-mvcle} is specified,
11691 use a @code{mvc} loop instead.  This is the default unless optimizing for
11692 size.
11693
11694 @item -mdebug
11695 @itemx -mno-debug
11696 @opindex mdebug
11697 @opindex mno-debug
11698 Print (or do not print) additional debug information when compiling.
11699 The default is to not print debug information.
11700
11701 @item -march=@var{cpu-type}
11702 @opindex march
11703 Generate code that will run on @var{cpu-type}, which is the name of a system
11704 representing a certain processor type.  Possible values for
11705 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11706 When generating code using the instructions available on z/Architecture,
11707 the default is @option{-march=z900}.  Otherwise, the default is
11708 @option{-march=g5}.
11709
11710 @item -mtune=@var{cpu-type}
11711 @opindex mtune
11712 Tune to @var{cpu-type} everything applicable about the generated code,
11713 except for the ABI and the set of available instructions.
11714 The list of @var{cpu-type} values is the same as for @option{-march}.
11715 The default is the value used for @option{-march}.
11716
11717 @item -mtpf-trace
11718 @itemx -mno-tpf-trace
11719 @opindex mtpf-trace
11720 @opindex mno-tpf-trace
11721 Generate code that adds (does not add) in TPF OS specific branches to trace
11722 routines in the operating system.  This option is off by default, even
11723 when compiling for the TPF OS@.
11724
11725 @item -mfused-madd
11726 @itemx -mno-fused-madd
11727 @opindex mfused-madd
11728 @opindex mno-fused-madd
11729 Generate code that uses (does not use) the floating point multiply and
11730 accumulate instructions.  These instructions are generated by default if
11731 hardware floating point is used.
11732
11733 @item -mwarn-framesize=@var{framesize}
11734 @opindex mwarn-framesize
11735 Emit a warning if the current function exceeds the given frame size.  Because
11736 this is a compile time check it doesn't need to be a real problem when the program
11737 runs.  It is intended to identify functions which most probably cause
11738 a stack overflow.  It is useful to be used in an environment with limited stack
11739 size e.g.@: the linux kernel.
11740
11741 @item -mwarn-dynamicstack
11742 @opindex mwarn-dynamicstack
11743 Emit a warning if the function calls alloca or uses dynamically
11744 sized arrays.  This is generally a bad idea with a limited stack size.
11745
11746 @item -mstack-guard=@var{stack-guard}
11747 @item -mstack-size=@var{stack-size}
11748 @opindex mstack-guard
11749 @opindex mstack-size
11750 These arguments always have to be used in conjunction.  If they are present the s390
11751 back end emits additional instructions in the function prologue which trigger a trap
11752 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11753 (remember that the stack on s390 grows downward).  These options are intended to
11754 be used to help debugging stack overflow problems.  The additionally emitted code
11755 causes only little overhead and hence can also be used in production like systems
11756 without greater performance degradation.  The given values have to be exact
11757 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11758 exceeding 64k.
11759 In order to be efficient the extra code makes the assumption that the stack starts
11760 at an address aligned to the value given by @var{stack-size}.
11761 @end table
11762
11763 @node SH Options
11764 @subsection SH Options
11765
11766 These @samp{-m} options are defined for the SH implementations:
11767
11768 @table @gcctabopt
11769 @item -m1
11770 @opindex m1
11771 Generate code for the SH1.
11772
11773 @item -m2
11774 @opindex m2
11775 Generate code for the SH2.
11776
11777 @item -m2e
11778 Generate code for the SH2e.
11779
11780 @item -m3
11781 @opindex m3
11782 Generate code for the SH3.
11783
11784 @item -m3e
11785 @opindex m3e
11786 Generate code for the SH3e.
11787
11788 @item -m4-nofpu
11789 @opindex m4-nofpu
11790 Generate code for the SH4 without a floating-point unit.
11791
11792 @item -m4-single-only
11793 @opindex m4-single-only
11794 Generate code for the SH4 with a floating-point unit that only
11795 supports single-precision arithmetic.
11796
11797 @item -m4-single
11798 @opindex m4-single
11799 Generate code for the SH4 assuming the floating-point unit is in
11800 single-precision mode by default.
11801
11802 @item -m4
11803 @opindex m4
11804 Generate code for the SH4.
11805
11806 @item -m4a-nofpu
11807 @opindex m4a-nofpu
11808 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11809 floating-point unit is not used.
11810
11811 @item -m4a-single-only
11812 @opindex m4a-single-only
11813 Generate code for the SH4a, in such a way that no double-precision
11814 floating point operations are used.
11815
11816 @item -m4a-single
11817 @opindex m4a-single
11818 Generate code for the SH4a assuming the floating-point unit is in
11819 single-precision mode by default.
11820
11821 @item -m4a
11822 @opindex m4a
11823 Generate code for the SH4a.
11824
11825 @item -m4al
11826 @opindex m4al
11827 Same as @option{-m4a-nofpu}, except that it implicitly passes
11828 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11829 instructions at the moment.
11830
11831 @item -mb
11832 @opindex mb
11833 Compile code for the processor in big endian mode.
11834
11835 @item -ml
11836 @opindex ml
11837 Compile code for the processor in little endian mode.
11838
11839 @item -mdalign
11840 @opindex mdalign
11841 Align doubles at 64-bit boundaries.  Note that this changes the calling
11842 conventions, and thus some functions from the standard C library will
11843 not work unless you recompile it first with @option{-mdalign}.
11844
11845 @item -mrelax
11846 @opindex mrelax
11847 Shorten some address references at link time, when possible; uses the
11848 linker option @option{-relax}.
11849
11850 @item -mbigtable
11851 @opindex mbigtable
11852 Use 32-bit offsets in @code{switch} tables.  The default is to use
11853 16-bit offsets.
11854
11855 @item -mfmovd
11856 @opindex mfmovd
11857 Enable the use of the instruction @code{fmovd}.
11858
11859 @item -mhitachi
11860 @opindex mhitachi
11861 Comply with the calling conventions defined by Renesas.
11862
11863 @item -mrenesas
11864 @opindex mhitachi
11865 Comply with the calling conventions defined by Renesas.
11866
11867 @item -mno-renesas
11868 @opindex mhitachi
11869 Comply with the calling conventions defined for GCC before the Renesas
11870 conventions were available.  This option is the default for all
11871 targets of the SH toolchain except for @samp{sh-symbianelf}.
11872
11873 @item -mnomacsave
11874 @opindex mnomacsave
11875 Mark the @code{MAC} register as call-clobbered, even if
11876 @option{-mhitachi} is given.
11877
11878 @item -mieee
11879 @opindex mieee
11880 Increase IEEE-compliance of floating-point code.
11881 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11882 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11883 comparisons of NANs / infinities incurs extra overhead in every
11884 floating point comparison, therefore the default is set to
11885 @option{-ffinite-math-only}.
11886
11887 @item -misize
11888 @opindex misize
11889 Dump instruction size and location in the assembly code.
11890
11891 @item -mpadstruct
11892 @opindex mpadstruct
11893 This option is deprecated.  It pads structures to multiple of 4 bytes,
11894 which is incompatible with the SH ABI@.
11895
11896 @item -mspace
11897 @opindex mspace
11898 Optimize for space instead of speed.  Implied by @option{-Os}.
11899
11900 @item -mprefergot
11901 @opindex mprefergot
11902 When generating position-independent code, emit function calls using
11903 the Global Offset Table instead of the Procedure Linkage Table.
11904
11905 @item -musermode
11906 @opindex musermode
11907 Generate a library function call to invalidate instruction cache
11908 entries, after fixing up a trampoline.  This library function call
11909 doesn't assume it can write to the whole memory address space.  This
11910 is the default when the target is @code{sh-*-linux*}.
11911
11912 @item -multcost=@var{number}
11913 @opindex multcost=@var{number}
11914 Set the cost to assume for a multiply insn.
11915
11916 @item -mdiv=@var{strategy}
11917 @opindex mdiv=@var{strategy}
11918 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11919 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11920 inv:call2, inv:fp .
11921 "fp" performs the operation in floating point.  This has a very high latency,
11922 but needs only a few instructions, so it might be a good choice if
11923 your code has enough easily exploitable ILP to allow the compiler to
11924 schedule the floating point instructions together with other instructions.
11925 Division by zero causes a floating point exception.
11926 "inv" uses integer operations to calculate the inverse of the divisor,
11927 and then multiplies the dividend with the inverse.  This strategy allows
11928 cse and hoisting of the inverse calculation.  Division by zero calculates
11929 an unspecified result, but does not trap.
11930 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11931 have been found, or if the entire operation has been hoisted to the same
11932 place, the last stages of the inverse calculation are intertwined with the
11933 final multiply to reduce the overall latency, at the expense of using a few
11934 more instructions, and thus offering fewer scheduling opportunities with
11935 other code.
11936 "call" calls a library function that usually implements the inv:minlat
11937 strategy.
11938 This gives high code density for m5-*media-nofpu compilations.
11939 "call2" uses a different entry point of the same library function, where it
11940 assumes that a pointer to a lookup table has already been set up, which
11941 exposes the pointer load to cse / code hoisting optimizations.
11942 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11943 code generation, but if the code stays unoptimized, revert to the "call",
11944 "call2", or "fp" strategies, respectively.  Note that the
11945 potentially-trapping side effect of division by zero is carried by a
11946 separate instruction, so it is possible that all the integer instructions
11947 are hoisted out, but the marker for the side effect stays where it is.
11948 A recombination to fp operations or a call is not possible in that case.
11949 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11950 that the inverse calculation was nor separated from the multiply, they speed
11951 up division where the dividend fits into 20 bits (plus sign where applicable),
11952 by inserting a test to skip a number of operations in this case; this test
11953 slows down the case of larger dividends.  inv20u assumes the case of a such
11954 a small dividend to be unlikely, and inv20l assumes it to be likely.
11955
11956 @item -mdivsi3_libfunc=@var{name}
11957 @opindex mdivsi3_libfunc=@var{name}
11958 Set the name of the library function used for 32 bit signed division to
11959 @var{name}.  This only affect the name used in the call and inv:call
11960 division strategies, and the compiler will still expect the same
11961 sets of input/output/clobbered registers as if this option was not present.
11962
11963 @item -madjust-unroll
11964 @opindex madjust-unroll
11965 Throttle unrolling to avoid thrashing target registers.
11966 This option only has an effect if the gcc code base supports the
11967 TARGET_ADJUST_UNROLL_MAX target hook.
11968
11969 @item -mindexed-addressing
11970 @opindex mindexed-addressing
11971 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11972 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11973 semantics for the indexed addressing mode.  The architecture allows the
11974 implementation of processors with 64 bit MMU, which the OS could use to
11975 get 32 bit addressing, but since no current hardware implementation supports
11976 this or any other way to make the indexed addressing mode safe to use in
11977 the 32 bit ABI, the default is -mno-indexed-addressing.
11978
11979 @item -mgettrcost=@var{number}
11980 @opindex mgettrcost=@var{number}
11981 Set the cost assumed for the gettr instruction to @var{number}.
11982 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11983
11984 @item -mpt-fixed
11985 @opindex mpt-fixed
11986 Assume pt* instructions won't trap.  This will generally generate better
11987 scheduled code, but is unsafe on current hardware.  The current architecture
11988 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11989 This has the unintentional effect of making it unsafe to schedule ptabs /
11990 ptrel before a branch, or hoist it out of a loop.  For example,
11991 __do_global_ctors, a part of libgcc that runs constructors at program
11992 startup, calls functions in a list which is delimited by -1.  With the
11993 -mpt-fixed option, the ptabs will be done before testing against -1.
11994 That means that all the constructors will be run a bit quicker, but when
11995 the loop comes to the end of the list, the program crashes because ptabs
11996 loads -1 into a target register.  Since this option is unsafe for any
11997 hardware implementing the current architecture specification, the default
11998 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11999 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12000 this deters register allocation using target registers for storing
12001 ordinary integers.
12002
12003 @item -minvalid-symbols
12004 @opindex minvalid-symbols
12005 Assume symbols might be invalid.  Ordinary function symbols generated by
12006 the compiler will always be valid to load with movi/shori/ptabs or
12007 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12008 to generate symbols that will cause ptabs / ptrel to trap.
12009 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12010 It will then prevent cross-basic-block cse, hoisting and most scheduling
12011 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12012 @end table
12013
12014 @node SPARC Options
12015 @subsection SPARC Options
12016 @cindex SPARC options
12017
12018 These @samp{-m} options are supported on the SPARC:
12019
12020 @table @gcctabopt
12021 @item -mno-app-regs
12022 @itemx -mapp-regs
12023 @opindex mno-app-regs
12024 @opindex mapp-regs
12025 Specify @option{-mapp-regs} to generate output using the global registers
12026 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12027 is the default.
12028
12029 To be fully SVR4 ABI compliant at the cost of some performance loss,
12030 specify @option{-mno-app-regs}.  You should compile libraries and system
12031 software with this option.
12032
12033 @item -mfpu
12034 @itemx -mhard-float
12035 @opindex mfpu
12036 @opindex mhard-float
12037 Generate output containing floating point instructions.  This is the
12038 default.
12039
12040 @item -mno-fpu
12041 @itemx -msoft-float
12042 @opindex mno-fpu
12043 @opindex msoft-float
12044 Generate output containing library calls for floating point.
12045 @strong{Warning:} the requisite libraries are not available for all SPARC
12046 targets.  Normally the facilities of the machine's usual C compiler are
12047 used, but this cannot be done directly in cross-compilation.  You must make
12048 your own arrangements to provide suitable library functions for
12049 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12050 @samp{sparclite-*-*} do provide software floating point support.
12051
12052 @option{-msoft-float} changes the calling convention in the output file;
12053 therefore, it is only useful if you compile @emph{all} of a program with
12054 this option.  In particular, you need to compile @file{libgcc.a}, the
12055 library that comes with GCC, with @option{-msoft-float} in order for
12056 this to work.
12057
12058 @item -mhard-quad-float
12059 @opindex mhard-quad-float
12060 Generate output containing quad-word (long double) floating point
12061 instructions.
12062
12063 @item -msoft-quad-float
12064 @opindex msoft-quad-float
12065 Generate output containing library calls for quad-word (long double)
12066 floating point instructions.  The functions called are those specified
12067 in the SPARC ABI@.  This is the default.
12068
12069 As of this writing, there are no SPARC implementations that have hardware
12070 support for the quad-word floating point instructions.  They all invoke
12071 a trap handler for one of these instructions, and then the trap handler
12072 emulates the effect of the instruction.  Because of the trap handler overhead,
12073 this is much slower than calling the ABI library routines.  Thus the
12074 @option{-msoft-quad-float} option is the default.
12075
12076 @item -mno-unaligned-doubles
12077 @itemx -munaligned-doubles
12078 @opindex mno-unaligned-doubles
12079 @opindex munaligned-doubles
12080 Assume that doubles have 8 byte alignment.  This is the default.
12081
12082 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12083 alignment only if they are contained in another type, or if they have an
12084 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12085 Specifying this option avoids some rare compatibility problems with code
12086 generated by other compilers.  It is not the default because it results
12087 in a performance loss, especially for floating point code.
12088
12089 @item -mno-faster-structs
12090 @itemx -mfaster-structs
12091 @opindex mno-faster-structs
12092 @opindex mfaster-structs
12093 With @option{-mfaster-structs}, the compiler assumes that structures
12094 should have 8 byte alignment.  This enables the use of pairs of
12095 @code{ldd} and @code{std} instructions for copies in structure
12096 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12097 However, the use of this changed alignment directly violates the SPARC
12098 ABI@.  Thus, it's intended only for use on targets where the developer
12099 acknowledges that their resulting code will not be directly in line with
12100 the rules of the ABI@.
12101
12102 @item -mimpure-text
12103 @opindex mimpure-text
12104 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12105 the compiler to not pass @option{-z text} to the linker when linking a
12106 shared object.  Using this option, you can link position-dependent
12107 code into a shared object.
12108
12109 @option{-mimpure-text} suppresses the ``relocations remain against
12110 allocatable but non-writable sections'' linker error message.
12111 However, the necessary relocations will trigger copy-on-write, and the
12112 shared object is not actually shared across processes.  Instead of
12113 using @option{-mimpure-text}, you should compile all source code with
12114 @option{-fpic} or @option{-fPIC}.
12115
12116 This option is only available on SunOS and Solaris.
12117
12118 @item -mcpu=@var{cpu_type}
12119 @opindex mcpu
12120 Set the instruction set, register set, and instruction scheduling parameters
12121 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12122 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12123 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12124 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12125 @samp{ultrasparc3}.
12126
12127 Default instruction scheduling parameters are used for values that select
12128 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12129 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12130
12131 Here is a list of each supported architecture and their supported
12132 implementations.
12133
12134 @smallexample
12135     v7:             cypress
12136     v8:             supersparc, hypersparc
12137     sparclite:      f930, f934, sparclite86x
12138     sparclet:       tsc701
12139     v9:             ultrasparc, ultrasparc3
12140 @end smallexample
12141
12142 By default (unless configured otherwise), GCC generates code for the V7
12143 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12144 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12145 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12146 SPARCStation 1, 2, IPX etc.
12147
12148 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12149 architecture.  The only difference from V7 code is that the compiler emits
12150 the integer multiply and integer divide instructions which exist in SPARC-V8
12151 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12152 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12153 2000 series.
12154
12155 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12156 the SPARC architecture.  This adds the integer multiply, integer divide step
12157 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12158 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12159 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12160 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12161 MB86934 chip, which is the more recent SPARClite with FPU@.
12162
12163 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12164 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12165 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12166 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12167 optimizes it for the TEMIC SPARClet chip.
12168
12169 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12170 architecture.  This adds 64-bit integer and floating-point move instructions,
12171 3 additional floating-point condition code registers and conditional move
12172 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12173 optimizes it for the Sun UltraSPARC I/II chips.  With
12174 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12175 Sun UltraSPARC III chip.
12176
12177 @item -mtune=@var{cpu_type}
12178 @opindex mtune
12179 Set the instruction scheduling parameters for machine type
12180 @var{cpu_type}, but do not set the instruction set or register set that the
12181 option @option{-mcpu=@var{cpu_type}} would.
12182
12183 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12184 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12185 that select a particular cpu implementation.  Those are @samp{cypress},
12186 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12187 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12188 @samp{ultrasparc3}.
12189
12190 @item -mv8plus
12191 @itemx -mno-v8plus
12192 @opindex mv8plus
12193 @opindex mno-v8plus
12194 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12195 difference from the V8 ABI is that the global and out registers are
12196 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12197 mode for all SPARC-V9 processors.
12198
12199 @item -mvis
12200 @itemx -mno-vis
12201 @opindex mvis
12202 @opindex mno-vis
12203 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12204 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12205 @end table
12206
12207 These @samp{-m} options are supported in addition to the above
12208 on SPARC-V9 processors in 64-bit environments:
12209
12210 @table @gcctabopt
12211 @item -mlittle-endian
12212 @opindex mlittle-endian
12213 Generate code for a processor running in little-endian mode.  It is only
12214 available for a few configurations and most notably not on Solaris and Linux.
12215
12216 @item -m32
12217 @itemx -m64
12218 @opindex m32
12219 @opindex m64
12220 Generate code for a 32-bit or 64-bit environment.
12221 The 32-bit environment sets int, long and pointer to 32 bits.
12222 The 64-bit environment sets int to 32 bits and long and pointer
12223 to 64 bits.
12224
12225 @item -mcmodel=medlow
12226 @opindex mcmodel=medlow
12227 Generate code for the Medium/Low code model: 64-bit addresses, programs
12228 must be linked in the low 32 bits of memory.  Programs can be statically
12229 or dynamically linked.
12230
12231 @item -mcmodel=medmid
12232 @opindex mcmodel=medmid
12233 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12234 must be linked in the low 44 bits of memory, the text and data segments must
12235 be less than 2GB in size and the data segment must be located within 2GB of
12236 the text segment.
12237
12238 @item -mcmodel=medany
12239 @opindex mcmodel=medany
12240 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12241 may be linked anywhere in memory, the text and data segments must be less
12242 than 2GB in size and the data segment must be located within 2GB of the
12243 text segment.
12244
12245 @item -mcmodel=embmedany
12246 @opindex mcmodel=embmedany
12247 Generate code for the Medium/Anywhere code model for embedded systems:
12248 64-bit addresses, the text and data segments must be less than 2GB in
12249 size, both starting anywhere in memory (determined at link time).  The
12250 global register %g4 points to the base of the data segment.  Programs
12251 are statically linked and PIC is not supported.
12252
12253 @item -mstack-bias
12254 @itemx -mno-stack-bias
12255 @opindex mstack-bias
12256 @opindex mno-stack-bias
12257 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12258 frame pointer if present, are offset by @minus{}2047 which must be added back
12259 when making stack frame references.  This is the default in 64-bit mode.
12260 Otherwise, assume no such offset is present.
12261 @end table
12262
12263 These switches are supported in addition to the above on Solaris:
12264
12265 @table @gcctabopt
12266 @item -threads
12267 @opindex threads
12268 Add support for multithreading using the Solaris threads library.  This
12269 option sets flags for both the preprocessor and linker.  This option does
12270 not affect the thread safety of object code produced by the compiler or
12271 that of libraries supplied with it.
12272
12273 @item -pthreads
12274 @opindex pthreads
12275 Add support for multithreading using the POSIX threads library.  This
12276 option sets flags for both the preprocessor and linker.  This option does
12277 not affect the thread safety of object code produced  by the compiler or
12278 that of libraries supplied with it.
12279
12280 @item -pthread
12281 @opindex pthread
12282 This is a synonym for @option{-pthreads}.
12283 @end table
12284
12285 @node System V Options
12286 @subsection Options for System V
12287
12288 These additional options are available on System V Release 4 for
12289 compatibility with other compilers on those systems:
12290
12291 @table @gcctabopt
12292 @item -G
12293 @opindex G
12294 Create a shared object.
12295 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12296
12297 @item -Qy
12298 @opindex Qy
12299 Identify the versions of each tool used by the compiler, in a
12300 @code{.ident} assembler directive in the output.
12301
12302 @item -Qn
12303 @opindex Qn
12304 Refrain from adding @code{.ident} directives to the output file (this is
12305 the default).
12306
12307 @item -YP,@var{dirs}
12308 @opindex YP
12309 Search the directories @var{dirs}, and no others, for libraries
12310 specified with @option{-l}.
12311
12312 @item -Ym,@var{dir}
12313 @opindex Ym
12314 Look in the directory @var{dir} to find the M4 preprocessor.
12315 The assembler uses this option.
12316 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12317 @c the generic assembler that comes with Solaris takes just -Ym.
12318 @end table
12319
12320 @node TMS320C3x/C4x Options
12321 @subsection TMS320C3x/C4x Options
12322 @cindex TMS320C3x/C4x Options
12323
12324 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12325
12326 @table @gcctabopt
12327
12328 @item -mcpu=@var{cpu_type}
12329 @opindex mcpu
12330 Set the instruction set, register set, and instruction scheduling
12331 parameters for machine type @var{cpu_type}.  Supported values for
12332 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12333 @samp{c44}.  The default is @samp{c40} to generate code for the
12334 TMS320C40.
12335
12336 @item -mbig-memory
12337 @itemx -mbig
12338 @itemx -msmall-memory
12339 @itemx -msmall
12340 @opindex mbig-memory
12341 @opindex mbig
12342 @opindex msmall-memory
12343 @opindex msmall
12344 Generates code for the big or small memory model.  The small memory
12345 model assumed that all data fits into one 64K word page.  At run-time
12346 the data page (DP) register must be set to point to the 64K page
12347 containing the .bss and .data program sections.  The big memory model is
12348 the default and requires reloading of the DP register for every direct
12349 memory access.
12350
12351 @item -mbk
12352 @itemx -mno-bk
12353 @opindex mbk
12354 @opindex mno-bk
12355 Allow (disallow) allocation of general integer operands into the block
12356 count register BK@.
12357
12358 @item -mdb
12359 @itemx -mno-db
12360 @opindex mdb
12361 @opindex mno-db
12362 Enable (disable) generation of code using decrement and branch,
12363 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12364 on the safe side, this is disabled for the C3x, since the maximum
12365 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12366 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12367 that it can utilize the decrement and branch instruction, but will give
12368 up if there is more than one memory reference in the loop.  Thus a loop
12369 where the loop counter is decremented can generate slightly more
12370 efficient code, in cases where the RPTB instruction cannot be utilized.
12371
12372 @item -mdp-isr-reload
12373 @itemx -mparanoid
12374 @opindex mdp-isr-reload
12375 @opindex mparanoid
12376 Force the DP register to be saved on entry to an interrupt service
12377 routine (ISR), reloaded to point to the data section, and restored on
12378 exit from the ISR@.  This should not be required unless someone has
12379 violated the small memory model by modifying the DP register, say within
12380 an object library.
12381
12382 @item -mmpyi
12383 @itemx -mno-mpyi
12384 @opindex mmpyi
12385 @opindex mno-mpyi
12386 For the C3x use the 24-bit MPYI instruction for integer multiplies
12387 instead of a library call to guarantee 32-bit results.  Note that if one
12388 of the operands is a constant, then the multiplication will be performed
12389 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12390 then squaring operations are performed inline instead of a library call.
12391
12392 @item -mfast-fix
12393 @itemx -mno-fast-fix
12394 @opindex mfast-fix
12395 @opindex mno-fast-fix
12396 The C3x/C4x FIX instruction to convert a floating point value to an
12397 integer value chooses the nearest integer less than or equal to the
12398 floating point value rather than to the nearest integer.  Thus if the
12399 floating point number is negative, the result will be incorrectly
12400 truncated an additional code is necessary to detect and correct this
12401 case.  This option can be used to disable generation of the additional
12402 code required to correct the result.
12403
12404 @item -mrptb
12405 @itemx -mno-rptb
12406 @opindex mrptb
12407 @opindex mno-rptb
12408 Enable (disable) generation of repeat block sequences using the RPTB
12409 instruction for zero overhead looping.  The RPTB construct is only used
12410 for innermost loops that do not call functions or jump across the loop
12411 boundaries.  There is no advantage having nested RPTB loops due to the
12412 overhead required to save and restore the RC, RS, and RE registers.
12413 This is enabled by default with @option{-O2}.
12414
12415 @item -mrpts=@var{count}
12416 @itemx -mno-rpts
12417 @opindex mrpts
12418 @opindex mno-rpts
12419 Enable (disable) the use of the single instruction repeat instruction
12420 RPTS@.  If a repeat block contains a single instruction, and the loop
12421 count can be guaranteed to be less than the value @var{count}, GCC will
12422 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12423 then a RPTS will be emitted even if the loop count cannot be determined
12424 at compile time.  Note that the repeated instruction following RPTS does
12425 not have to be reloaded from memory each iteration, thus freeing up the
12426 CPU buses for operands.  However, since interrupts are blocked by this
12427 instruction, it is disabled by default.
12428
12429 @item -mloop-unsigned
12430 @itemx -mno-loop-unsigned
12431 @opindex mloop-unsigned
12432 @opindex mno-loop-unsigned
12433 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12434 is @math{2^{31} + 1} since these instructions test if the iteration count is
12435 negative to terminate the loop.  If the iteration count is unsigned
12436 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12437 exceeded.  This switch allows an unsigned iteration count.
12438
12439 @item -mti
12440 @opindex mti
12441 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12442 with.  This also enforces compatibility with the API employed by the TI
12443 C3x C compiler.  For example, long doubles are passed as structures
12444 rather than in floating point registers.
12445
12446 @item -mregparm
12447 @itemx -mmemparm
12448 @opindex mregparm
12449 @opindex mmemparm
12450 Generate code that uses registers (stack) for passing arguments to functions.
12451 By default, arguments are passed in registers where possible rather
12452 than by pushing arguments on to the stack.
12453
12454 @item -mparallel-insns
12455 @itemx -mno-parallel-insns
12456 @opindex mparallel-insns
12457 @opindex mno-parallel-insns
12458 Allow the generation of parallel instructions.  This is enabled by
12459 default with @option{-O2}.
12460
12461 @item -mparallel-mpy
12462 @itemx -mno-parallel-mpy
12463 @opindex mparallel-mpy
12464 @opindex mno-parallel-mpy
12465 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12466 provided @option{-mparallel-insns} is also specified.  These instructions have
12467 tight register constraints which can pessimize the code generation
12468 of large functions.
12469
12470 @end table
12471
12472 @node V850 Options
12473 @subsection V850 Options
12474 @cindex V850 Options
12475
12476 These @samp{-m} options are defined for V850 implementations:
12477
12478 @table @gcctabopt
12479 @item -mlong-calls
12480 @itemx -mno-long-calls
12481 @opindex mlong-calls
12482 @opindex mno-long-calls
12483 Treat all calls as being far away (near).  If calls are assumed to be
12484 far away, the compiler will always load the functions address up into a
12485 register, and call indirect through the pointer.
12486
12487 @item -mno-ep
12488 @itemx -mep
12489 @opindex mno-ep
12490 @opindex mep
12491 Do not optimize (do optimize) basic blocks that use the same index
12492 pointer 4 or more times to copy pointer into the @code{ep} register, and
12493 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12494 option is on by default if you optimize.
12495
12496 @item -mno-prolog-function
12497 @itemx -mprolog-function
12498 @opindex mno-prolog-function
12499 @opindex mprolog-function
12500 Do not use (do use) external functions to save and restore registers
12501 at the prologue and epilogue of a function.  The external functions
12502 are slower, but use less code space if more than one function saves
12503 the same number of registers.  The @option{-mprolog-function} option
12504 is on by default if you optimize.
12505
12506 @item -mspace
12507 @opindex mspace
12508 Try to make the code as small as possible.  At present, this just turns
12509 on the @option{-mep} and @option{-mprolog-function} options.
12510
12511 @item -mtda=@var{n}
12512 @opindex mtda
12513 Put static or global variables whose size is @var{n} bytes or less into
12514 the tiny data area that register @code{ep} points to.  The tiny data
12515 area can hold up to 256 bytes in total (128 bytes for byte references).
12516
12517 @item -msda=@var{n}
12518 @opindex msda
12519 Put static or global variables whose size is @var{n} bytes or less into
12520 the small data area that register @code{gp} points to.  The small data
12521 area can hold up to 64 kilobytes.
12522
12523 @item -mzda=@var{n}
12524 @opindex mzda
12525 Put static or global variables whose size is @var{n} bytes or less into
12526 the first 32 kilobytes of memory.
12527
12528 @item -mv850
12529 @opindex mv850
12530 Specify that the target processor is the V850.
12531
12532 @item -mbig-switch
12533 @opindex mbig-switch
12534 Generate code suitable for big switch tables.  Use this option only if
12535 the assembler/linker complain about out of range branches within a switch
12536 table.
12537
12538 @item -mapp-regs
12539 @opindex mapp-regs
12540 This option will cause r2 and r5 to be used in the code generated by
12541 the compiler.  This setting is the default.
12542
12543 @item -mno-app-regs
12544 @opindex mno-app-regs
12545 This option will cause r2 and r5 to be treated as fixed registers.
12546
12547 @item -mv850e1
12548 @opindex mv850e1
12549 Specify that the target processor is the V850E1.  The preprocessor
12550 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12551 this option is used.
12552
12553 @item -mv850e
12554 @opindex mv850e
12555 Specify that the target processor is the V850E@.  The preprocessor
12556 constant @samp{__v850e__} will be defined if this option is used.
12557
12558 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12559 are defined then a default target processor will be chosen and the
12560 relevant @samp{__v850*__} preprocessor constant will be defined.
12561
12562 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12563 defined, regardless of which processor variant is the target.
12564
12565 @item -mdisable-callt
12566 @opindex mdisable-callt
12567 This option will suppress generation of the CALLT instruction for the
12568 v850e and v850e1 flavors of the v850 architecture.  The default is
12569 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12570
12571 @end table
12572
12573 @node VAX Options
12574 @subsection VAX Options
12575 @cindex VAX options
12576
12577 These @samp{-m} options are defined for the VAX:
12578
12579 @table @gcctabopt
12580 @item -munix
12581 @opindex munix
12582 Do not output certain jump instructions (@code{aobleq} and so on)
12583 that the Unix assembler for the VAX cannot handle across long
12584 ranges.
12585
12586 @item -mgnu
12587 @opindex mgnu
12588 Do output those jump instructions, on the assumption that you
12589 will assemble with the GNU assembler.
12590
12591 @item -mg
12592 @opindex mg
12593 Output code for g-format floating point numbers instead of d-format.
12594 @end table
12595
12596 @node x86-64 Options
12597 @subsection x86-64 Options
12598 @cindex x86-64 options
12599
12600 These are listed under @xref{i386 and x86-64 Options}.
12601
12602 @node Xstormy16 Options
12603 @subsection Xstormy16 Options
12604 @cindex Xstormy16 Options
12605
12606 These options are defined for Xstormy16:
12607
12608 @table @gcctabopt
12609 @item -msim
12610 @opindex msim
12611 Choose startup files and linker script suitable for the simulator.
12612 @end table
12613
12614 @node Xtensa Options
12615 @subsection Xtensa Options
12616 @cindex Xtensa Options
12617
12618 These options are supported for Xtensa targets:
12619
12620 @table @gcctabopt
12621 @item -mconst16
12622 @itemx -mno-const16
12623 @opindex mconst16
12624 @opindex mno-const16
12625 Enable or disable use of @code{CONST16} instructions for loading
12626 constant values.  The @code{CONST16} instruction is currently not a
12627 standard option from Tensilica.  When enabled, @code{CONST16}
12628 instructions are always used in place of the standard @code{L32R}
12629 instructions.  The use of @code{CONST16} is enabled by default only if
12630 the @code{L32R} instruction is not available.
12631
12632 @item -mfused-madd
12633 @itemx -mno-fused-madd
12634 @opindex mfused-madd
12635 @opindex mno-fused-madd
12636 Enable or disable use of fused multiply/add and multiply/subtract
12637 instructions in the floating-point option.  This has no effect if the
12638 floating-point option is not also enabled.  Disabling fused multiply/add
12639 and multiply/subtract instructions forces the compiler to use separate
12640 instructions for the multiply and add/subtract operations.  This may be
12641 desirable in some cases where strict IEEE 754-compliant results are
12642 required: the fused multiply add/subtract instructions do not round the
12643 intermediate result, thereby producing results with @emph{more} bits of
12644 precision than specified by the IEEE standard.  Disabling fused multiply
12645 add/subtract instructions also ensures that the program output is not
12646 sensitive to the compiler's ability to combine multiply and add/subtract
12647 operations.
12648
12649 @item -mtext-section-literals
12650 @itemx -mno-text-section-literals
12651 @opindex mtext-section-literals
12652 @opindex mno-text-section-literals
12653 Control the treatment of literal pools.  The default is
12654 @option{-mno-text-section-literals}, which places literals in a separate
12655 section in the output file.  This allows the literal pool to be placed
12656 in a data RAM/ROM, and it also allows the linker to combine literal
12657 pools from separate object files to remove redundant literals and
12658 improve code size.  With @option{-mtext-section-literals}, the literals
12659 are interspersed in the text section in order to keep them as close as
12660 possible to their references.  This may be necessary for large assembly
12661 files.
12662
12663 @item -mtarget-align
12664 @itemx -mno-target-align
12665 @opindex mtarget-align
12666 @opindex mno-target-align
12667 When this option is enabled, GCC instructs the assembler to
12668 automatically align instructions to reduce branch penalties at the
12669 expense of some code density.  The assembler attempts to widen density
12670 instructions to align branch targets and the instructions following call
12671 instructions.  If there are not enough preceding safe density
12672 instructions to align a target, no widening will be performed.  The
12673 default is @option{-mtarget-align}.  These options do not affect the
12674 treatment of auto-aligned instructions like @code{LOOP}, which the
12675 assembler will always align, either by widening density instructions or
12676 by inserting no-op instructions.
12677
12678 @item -mlongcalls
12679 @itemx -mno-longcalls
12680 @opindex mlongcalls
12681 @opindex mno-longcalls
12682 When this option is enabled, GCC instructs the assembler to translate
12683 direct calls to indirect calls unless it can determine that the target
12684 of a direct call is in the range allowed by the call instruction.  This
12685 translation typically occurs for calls to functions in other source
12686 files.  Specifically, the assembler translates a direct @code{CALL}
12687 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12688 The default is @option{-mno-longcalls}.  This option should be used in
12689 programs where the call target can potentially be out of range.  This
12690 option is implemented in the assembler, not the compiler, so the
12691 assembly code generated by GCC will still show direct call
12692 instructions---look at the disassembled object code to see the actual
12693 instructions.  Note that the assembler will use an indirect call for
12694 every cross-file call, not just those that really will be out of range.
12695 @end table
12696
12697 @node zSeries Options
12698 @subsection zSeries Options
12699 @cindex zSeries options
12700
12701 These are listed under @xref{S/390 and zSeries Options}.
12702
12703 @node Code Gen Options
12704 @section Options for Code Generation Conventions
12705 @cindex code generation conventions
12706 @cindex options, code generation
12707 @cindex run-time options
12708
12709 These machine-independent options control the interface conventions
12710 used in code generation.
12711
12712 Most of them have both positive and negative forms; the negative form
12713 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12714 one of the forms is listed---the one which is not the default.  You
12715 can figure out the other form by either removing @samp{no-} or adding
12716 it.
12717
12718 @table @gcctabopt
12719 @item -fbounds-check
12720 @opindex fbounds-check
12721 For front-ends that support it, generate additional code to check that
12722 indices used to access arrays are within the declared range.  This is
12723 currently only supported by the Java and Fortran front-ends, where
12724 this option defaults to true and false respectively.
12725
12726 @item -ftrapv
12727 @opindex ftrapv
12728 This option generates traps for signed overflow on addition, subtraction,
12729 multiplication operations.
12730
12731 @item -fwrapv
12732 @opindex fwrapv
12733 This option instructs the compiler to assume that signed arithmetic
12734 overflow of addition, subtraction and multiplication wraps around
12735 using twos-complement representation.  This flag enables some optimizations
12736 and disables others.  This option is enabled by default for the Java
12737 front-end, as required by the Java language specification.
12738
12739 @item -fexceptions
12740 @opindex fexceptions
12741 Enable exception handling.  Generates extra code needed to propagate
12742 exceptions.  For some targets, this implies GCC will generate frame
12743 unwind information for all functions, which can produce significant data
12744 size overhead, although it does not affect execution.  If you do not
12745 specify this option, GCC will enable it by default for languages like
12746 C++ which normally require exception handling, and disable it for
12747 languages like C that do not normally require it.  However, you may need
12748 to enable this option when compiling C code that needs to interoperate
12749 properly with exception handlers written in C++.  You may also wish to
12750 disable this option if you are compiling older C++ programs that don't
12751 use exception handling.
12752
12753 @item -fnon-call-exceptions
12754 @opindex fnon-call-exceptions
12755 Generate code that allows trapping instructions to throw exceptions.
12756 Note that this requires platform-specific runtime support that does
12757 not exist everywhere.  Moreover, it only allows @emph{trapping}
12758 instructions to throw exceptions, i.e.@: memory references or floating
12759 point instructions.  It does not allow exceptions to be thrown from
12760 arbitrary signal handlers such as @code{SIGALRM}.
12761
12762 @item -funwind-tables
12763 @opindex funwind-tables
12764 Similar to @option{-fexceptions}, except that it will just generate any needed
12765 static data, but will not affect the generated code in any other way.
12766 You will normally not enable this option; instead, a language processor
12767 that needs this handling would enable it on your behalf.
12768
12769 @item -fasynchronous-unwind-tables
12770 @opindex fasynchronous-unwind-tables
12771 Generate unwind table in dwarf2 format, if supported by target machine.  The
12772 table is exact at each instruction boundary, so it can be used for stack
12773 unwinding from asynchronous events (such as debugger or garbage collector).
12774
12775 @item -fpcc-struct-return
12776 @opindex fpcc-struct-return
12777 Return ``short'' @code{struct} and @code{union} values in memory like
12778 longer ones, rather than in registers.  This convention is less
12779 efficient, but it has the advantage of allowing intercallability between
12780 GCC-compiled files and files compiled with other compilers, particularly
12781 the Portable C Compiler (pcc).
12782
12783 The precise convention for returning structures in memory depends
12784 on the target configuration macros.
12785
12786 Short structures and unions are those whose size and alignment match
12787 that of some integer type.
12788
12789 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12790 switch is not binary compatible with code compiled with the
12791 @option{-freg-struct-return} switch.
12792 Use it to conform to a non-default application binary interface.
12793
12794 @item -freg-struct-return
12795 @opindex freg-struct-return
12796 Return @code{struct} and @code{union} values in registers when possible.
12797 This is more efficient for small structures than
12798 @option{-fpcc-struct-return}.
12799
12800 If you specify neither @option{-fpcc-struct-return} nor
12801 @option{-freg-struct-return}, GCC defaults to whichever convention is
12802 standard for the target.  If there is no standard convention, GCC
12803 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12804 the principal compiler.  In those cases, we can choose the standard, and
12805 we chose the more efficient register return alternative.
12806
12807 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12808 switch is not binary compatible with code compiled with the
12809 @option{-fpcc-struct-return} switch.
12810 Use it to conform to a non-default application binary interface.
12811
12812 @item -fshort-enums
12813 @opindex fshort-enums
12814 Allocate to an @code{enum} type only as many bytes as it needs for the
12815 declared range of possible values.  Specifically, the @code{enum} type
12816 will be equivalent to the smallest integer type which has enough room.
12817
12818 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12819 code that is not binary compatible with code generated without that switch.
12820 Use it to conform to a non-default application binary interface.
12821
12822 @item -fshort-double
12823 @opindex fshort-double
12824 Use the same size for @code{double} as for @code{float}.
12825
12826 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12827 code that is not binary compatible with code generated without that switch.
12828 Use it to conform to a non-default application binary interface.
12829
12830 @item -fshort-wchar
12831 @opindex fshort-wchar
12832 Override the underlying type for @samp{wchar_t} to be @samp{short
12833 unsigned int} instead of the default for the target.  This option is
12834 useful for building programs to run under WINE@.
12835
12836 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12837 code that is not binary compatible with code generated without that switch.
12838 Use it to conform to a non-default application binary interface.
12839
12840 @item -fshared-data
12841 @opindex fshared-data
12842 Requests that the data and non-@code{const} variables of this
12843 compilation be shared data rather than private data.  The distinction
12844 makes sense only on certain operating systems, where shared data is
12845 shared between processes running the same program, while private data
12846 exists in one copy per process.
12847
12848 @item -fno-common
12849 @opindex fno-common
12850 In C, allocate even uninitialized global variables in the data section of the
12851 object file, rather than generating them as common blocks.  This has the
12852 effect that if the same variable is declared (without @code{extern}) in
12853 two different compilations, you will get an error when you link them.
12854 The only reason this might be useful is if you wish to verify that the
12855 program will work on other systems which always work this way.
12856
12857 @item -fno-ident
12858 @opindex fno-ident
12859 Ignore the @samp{#ident} directive.
12860
12861 @item -finhibit-size-directive
12862 @opindex finhibit-size-directive
12863 Don't output a @code{.size} assembler directive, or anything else that
12864 would cause trouble if the function is split in the middle, and the
12865 two halves are placed at locations far apart in memory.  This option is
12866 used when compiling @file{crtstuff.c}; you should not need to use it
12867 for anything else.
12868
12869 @item -fverbose-asm
12870 @opindex fverbose-asm
12871 Put extra commentary information in the generated assembly code to
12872 make it more readable.  This option is generally only of use to those
12873 who actually need to read the generated assembly code (perhaps while
12874 debugging the compiler itself).
12875
12876 @option{-fno-verbose-asm}, the default, causes the
12877 extra information to be omitted and is useful when comparing two assembler
12878 files.
12879
12880 @item -fpic
12881 @opindex fpic
12882 @cindex global offset table
12883 @cindex PIC
12884 Generate position-independent code (PIC) suitable for use in a shared
12885 library, if supported for the target machine.  Such code accesses all
12886 constant addresses through a global offset table (GOT)@.  The dynamic
12887 loader resolves the GOT entries when the program starts (the dynamic
12888 loader is not part of GCC; it is part of the operating system).  If
12889 the GOT size for the linked executable exceeds a machine-specific
12890 maximum size, you get an error message from the linker indicating that
12891 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12892 instead.  (These maximums are 8k on the SPARC and 32k
12893 on the m68k and RS/6000.  The 386 has no such limit.)
12894
12895 Position-independent code requires special support, and therefore works
12896 only on certain machines.  For the 386, GCC supports PIC for System V
12897 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12898 position-independent.
12899
12900 @item -fPIC
12901 @opindex fPIC
12902 If supported for the target machine, emit position-independent code,
12903 suitable for dynamic linking and avoiding any limit on the size of the
12904 global offset table.  This option makes a difference on the m68k,
12905 PowerPC and SPARC@.
12906
12907 Position-independent code requires special support, and therefore works
12908 only on certain machines.
12909
12910 @item -fpie
12911 @itemx -fPIE
12912 @opindex fpie
12913 @opindex fPIE
12914 These options are similar to @option{-fpic} and @option{-fPIC}, but
12915 generated position independent code can be only linked into executables.
12916 Usually these options are used when @option{-pie} GCC option will be
12917 used during linking.
12918
12919 @item -fno-jump-tables
12920 @opindex fno-jump-tables
12921 Do not use jump tables for switch statements even where it would be
12922 more efficient than other code generation strategies.  This option is
12923 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12924 building code which forms part of a dynamic linker and cannot
12925 reference the address of a jump table.  On some targets, jump tables
12926 do not require a GOT and this option is not needed.
12927
12928 @item -ffixed-@var{reg}
12929 @opindex ffixed
12930 Treat the register named @var{reg} as a fixed register; generated code
12931 should never refer to it (except perhaps as a stack pointer, frame
12932 pointer or in some other fixed role).
12933
12934 @var{reg} must be the name of a register.  The register names accepted
12935 are machine-specific and are defined in the @code{REGISTER_NAMES}
12936 macro in the machine description macro file.
12937
12938 This flag does not have a negative form, because it specifies a
12939 three-way choice.
12940
12941 @item -fcall-used-@var{reg}
12942 @opindex fcall-used
12943 Treat the register named @var{reg} as an allocable register that is
12944 clobbered by function calls.  It may be allocated for temporaries or
12945 variables that do not live across a call.  Functions compiled this way
12946 will not save and restore the register @var{reg}.
12947
12948 It is an error to used this flag with the frame pointer or stack pointer.
12949 Use of this flag for other registers that have fixed pervasive roles in
12950 the machine's execution model will produce disastrous results.
12951
12952 This flag does not have a negative form, because it specifies a
12953 three-way choice.
12954
12955 @item -fcall-saved-@var{reg}
12956 @opindex fcall-saved
12957 Treat the register named @var{reg} as an allocable register saved by
12958 functions.  It may be allocated even for temporaries or variables that
12959 live across a call.  Functions compiled this way will save and restore
12960 the register @var{reg} if they use it.
12961
12962 It is an error to used this flag with the frame pointer or stack pointer.
12963 Use of this flag for other registers that have fixed pervasive roles in
12964 the machine's execution model will produce disastrous results.
12965
12966 A different sort of disaster will result from the use of this flag for
12967 a register in which function values may be returned.
12968
12969 This flag does not have a negative form, because it specifies a
12970 three-way choice.
12971
12972 @item -fpack-struct[=@var{n}]
12973 @opindex fpack-struct
12974 Without a value specified, pack all structure members together without
12975 holes.  When a value is specified (which must be a small power of two), pack
12976 structure members according to this value, representing the maximum
12977 alignment (that is, objects with default alignment requirements larger than
12978 this will be output potentially unaligned at the next fitting location.
12979
12980 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12981 code that is not binary compatible with code generated without that switch.
12982 Additionally, it makes the code suboptimal.
12983 Use it to conform to a non-default application binary interface.
12984
12985 @item -finstrument-functions
12986 @opindex finstrument-functions
12987 Generate instrumentation calls for entry and exit to functions.  Just
12988 after function entry and just before function exit, the following
12989 profiling functions will be called with the address of the current
12990 function and its call site.  (On some platforms,
12991 @code{__builtin_return_address} does not work beyond the current
12992 function, so the call site information may not be available to the
12993 profiling functions otherwise.)
12994
12995 @smallexample
12996 void __cyg_profile_func_enter (void *this_fn,
12997                                void *call_site);
12998 void __cyg_profile_func_exit  (void *this_fn,
12999                                void *call_site);
13000 @end smallexample
13001
13002 The first argument is the address of the start of the current function,
13003 which may be looked up exactly in the symbol table.
13004
13005 This instrumentation is also done for functions expanded inline in other
13006 functions.  The profiling calls will indicate where, conceptually, the
13007 inline function is entered and exited.  This means that addressable
13008 versions of such functions must be available.  If all your uses of a
13009 function are expanded inline, this may mean an additional expansion of
13010 code size.  If you use @samp{extern inline} in your C code, an
13011 addressable version of such functions must be provided.  (This is
13012 normally the case anyways, but if you get lucky and the optimizer always
13013 expands the functions inline, you might have gotten away without
13014 providing static copies.)
13015
13016 A function may be given the attribute @code{no_instrument_function}, in
13017 which case this instrumentation will not be done.  This can be used, for
13018 example, for the profiling functions listed above, high-priority
13019 interrupt routines, and any functions from which the profiling functions
13020 cannot safely be called (perhaps signal handlers, if the profiling
13021 routines generate output or allocate memory).
13022
13023 @item -fstack-check
13024 @opindex fstack-check
13025 Generate code to verify that you do not go beyond the boundary of the
13026 stack.  You should specify this flag if you are running in an
13027 environment with multiple threads, but only rarely need to specify it in
13028 a single-threaded environment since stack overflow is automatically
13029 detected on nearly all systems if there is only one stack.
13030
13031 Note that this switch does not actually cause checking to be done; the
13032 operating system must do that.  The switch causes generation of code
13033 to ensure that the operating system sees the stack being extended.
13034
13035 @item -fstack-limit-register=@var{reg}
13036 @itemx -fstack-limit-symbol=@var{sym}
13037 @itemx -fno-stack-limit
13038 @opindex fstack-limit-register
13039 @opindex fstack-limit-symbol
13040 @opindex fno-stack-limit
13041 Generate code to ensure that the stack does not grow beyond a certain value,
13042 either the value of a register or the address of a symbol.  If the stack
13043 would grow beyond the value, a signal is raised.  For most targets,
13044 the signal is raised before the stack overruns the boundary, so
13045 it is possible to catch the signal without taking special precautions.
13046
13047 For instance, if the stack starts at absolute address @samp{0x80000000}
13048 and grows downwards, you can use the flags
13049 @option{-fstack-limit-symbol=__stack_limit} and
13050 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13051 of 128KB@.  Note that this may only work with the GNU linker.
13052
13053 @cindex aliasing of parameters
13054 @cindex parameters, aliased
13055 @item -fargument-alias
13056 @itemx -fargument-noalias
13057 @itemx -fargument-noalias-global
13058 @opindex fargument-alias
13059 @opindex fargument-noalias
13060 @opindex fargument-noalias-global
13061 Specify the possible relationships among parameters and between
13062 parameters and global data.
13063
13064 @option{-fargument-alias} specifies that arguments (parameters) may
13065 alias each other and may alias global storage.@*
13066 @option{-fargument-noalias} specifies that arguments do not alias
13067 each other, but may alias global storage.@*
13068 @option{-fargument-noalias-global} specifies that arguments do not
13069 alias each other and do not alias global storage.
13070
13071 Each language will automatically use whatever option is required by
13072 the language standard.  You should not need to use these options yourself.
13073
13074 @item -fleading-underscore
13075 @opindex fleading-underscore
13076 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13077 change the way C symbols are represented in the object file.  One use
13078 is to help link with legacy assembly code.
13079
13080 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13081 generate code that is not binary compatible with code generated without that
13082 switch.  Use it to conform to a non-default application binary interface.
13083 Not all targets provide complete support for this switch.
13084
13085 @item -ftls-model=@var{model}
13086 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13087 The @var{model} argument should be one of @code{global-dynamic},
13088 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13089
13090 The default without @option{-fpic} is @code{initial-exec}; with
13091 @option{-fpic} the default is @code{global-dynamic}.
13092
13093 @item -fvisibility=@var{default|internal|hidden|protected}
13094 @opindex fvisibility
13095 Set the default ELF image symbol visibility to the specified option---all
13096 symbols will be marked with this unless overridden within the code.
13097 Using this feature can very substantially improve linking and
13098 load times of shared object libraries, produce more optimized
13099 code, provide near-perfect API export and prevent symbol clashes.
13100 It is @strong{strongly} recommended that you use this in any shared objects
13101 you distribute.
13102
13103 Despite the nomenclature, @code{default} always means public ie;
13104 available to be linked against from outside the shared object.
13105 @code{protected} and @code{internal} are pretty useless in real-world
13106 usage so the only other commonly used option will be @code{hidden}.
13107 The default if @option{-fvisibility} isn't specified is
13108 @code{default}, i.e., make every
13109 symbol public---this causes the same behavior as previous versions of
13110 GCC@.
13111
13112 A good explanation of the benefits offered by ensuring ELF
13113 symbols have the correct visibility is given by ``How To Write
13114 Shared Libraries'' by Ulrich Drepper (which can be found at
13115 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13116 solution made possible by this option to marking things hidden when
13117 the default is public is to make the default hidden and mark things
13118 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13119 and @code{__attribute__ ((visibility("default")))} instead of
13120 @code{__declspec(dllexport)} you get almost identical semantics with
13121 identical syntax.  This is a great boon to those working with
13122 cross-platform projects.
13123
13124 For those adding visibility support to existing code, you may find
13125 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13126 the declarations you wish to set visibility for with (for example)
13127 @samp{#pragma GCC visibility push(hidden)} and
13128 @samp{#pragma GCC visibility pop}.
13129 Bear in mind that symbol visibility should be viewed @strong{as
13130 part of the API interface contract} and thus all new code should
13131 always specify visibility when it is not the default ie; declarations
13132 only for use within the local DSO should @strong{always} be marked explicitly
13133 as hidden as so to avoid PLT indirection overheads---making this
13134 abundantly clear also aids readability and self-documentation of the code.
13135 Note that due to ISO C++ specification requirements, operator new and
13136 operator delete must always be of default visibility.
13137
13138 An overview of these techniques, their benefits and how to use them
13139 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13140
13141 @end table
13142
13143 @c man end
13144
13145 @node Environment Variables
13146 @section Environment Variables Affecting GCC
13147 @cindex environment variables
13148
13149 @c man begin ENVIRONMENT
13150 This section describes several environment variables that affect how GCC
13151 operates.  Some of them work by specifying directories or prefixes to use
13152 when searching for various kinds of files.  Some are used to specify other
13153 aspects of the compilation environment.
13154
13155 Note that you can also specify places to search using options such as
13156 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13157 take precedence over places specified using environment variables, which
13158 in turn take precedence over those specified by the configuration of GCC@.
13159 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13160 GNU Compiler Collection (GCC) Internals}.
13161
13162 @table @env
13163 @item LANG
13164 @itemx LC_CTYPE
13165 @c @itemx LC_COLLATE
13166 @itemx LC_MESSAGES
13167 @c @itemx LC_MONETARY
13168 @c @itemx LC_NUMERIC
13169 @c @itemx LC_TIME
13170 @itemx LC_ALL
13171 @findex LANG
13172 @findex LC_CTYPE
13173 @c @findex LC_COLLATE
13174 @findex LC_MESSAGES
13175 @c @findex LC_MONETARY
13176 @c @findex LC_NUMERIC
13177 @c @findex LC_TIME
13178 @findex LC_ALL
13179 @cindex locale
13180 These environment variables control the way that GCC uses
13181 localization information that allow GCC to work with different
13182 national conventions.  GCC inspects the locale categories
13183 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13184 so.  These locale categories can be set to any value supported by your
13185 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13186 Kingdom encoded in UTF-8.
13187
13188 The @env{LC_CTYPE} environment variable specifies character
13189 classification.  GCC uses it to determine the character boundaries in
13190 a string; this is needed for some multibyte encodings that contain quote
13191 and escape characters that would otherwise be interpreted as a string
13192 end or escape.
13193
13194 The @env{LC_MESSAGES} environment variable specifies the language to
13195 use in diagnostic messages.
13196
13197 If the @env{LC_ALL} environment variable is set, it overrides the value
13198 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13199 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13200 environment variable.  If none of these variables are set, GCC
13201 defaults to traditional C English behavior.
13202
13203 @item TMPDIR
13204 @findex TMPDIR
13205 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13206 files.  GCC uses temporary files to hold the output of one stage of
13207 compilation which is to be used as input to the next stage: for example,
13208 the output of the preprocessor, which is the input to the compiler
13209 proper.
13210
13211 @item GCC_EXEC_PREFIX
13212 @findex GCC_EXEC_PREFIX
13213 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13214 names of the subprograms executed by the compiler.  No slash is added
13215 when this prefix is combined with the name of a subprogram, but you can
13216 specify a prefix that ends with a slash if you wish.
13217
13218 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13219 an appropriate prefix to use based on the pathname it was invoked with.
13220
13221 If GCC cannot find the subprogram using the specified prefix, it
13222 tries looking in the usual places for the subprogram.
13223
13224 The default value of @env{GCC_EXEC_PREFIX} is
13225 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13226 of @code{prefix} when you ran the @file{configure} script.
13227
13228 Other prefixes specified with @option{-B} take precedence over this prefix.
13229
13230 This prefix is also used for finding files such as @file{crt0.o} that are
13231 used for linking.
13232
13233 In addition, the prefix is used in an unusual way in finding the
13234 directories to search for header files.  For each of the standard
13235 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13236 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13237 replacing that beginning with the specified prefix to produce an
13238 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13239 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13240 These alternate directories are searched first; the standard directories
13241 come next.
13242
13243 @item COMPILER_PATH
13244 @findex COMPILER_PATH
13245 The value of @env{COMPILER_PATH} is a colon-separated list of
13246 directories, much like @env{PATH}.  GCC tries the directories thus
13247 specified when searching for subprograms, if it can't find the
13248 subprograms using @env{GCC_EXEC_PREFIX}.
13249
13250 @item LIBRARY_PATH
13251 @findex LIBRARY_PATH
13252 The value of @env{LIBRARY_PATH} is a colon-separated list of
13253 directories, much like @env{PATH}.  When configured as a native compiler,
13254 GCC tries the directories thus specified when searching for special
13255 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13256 using GCC also uses these directories when searching for ordinary
13257 libraries for the @option{-l} option (but directories specified with
13258 @option{-L} come first).
13259
13260 @item LANG
13261 @findex LANG
13262 @cindex locale definition
13263 This variable is used to pass locale information to the compiler.  One way in
13264 which this information is used is to determine the character set to be used
13265 when character literals, string literals and comments are parsed in C and C++.
13266 When the compiler is configured to allow multibyte characters,
13267 the following values for @env{LANG} are recognized:
13268
13269 @table @samp
13270 @item C-JIS
13271 Recognize JIS characters.
13272 @item C-SJIS
13273 Recognize SJIS characters.
13274 @item C-EUCJP
13275 Recognize EUCJP characters.
13276 @end table
13277
13278 If @env{LANG} is not defined, or if it has some other value, then the
13279 compiler will use mblen and mbtowc as defined by the default locale to
13280 recognize and translate multibyte characters.
13281 @end table
13282
13283 @noindent
13284 Some additional environments variables affect the behavior of the
13285 preprocessor.
13286
13287 @include cppenv.texi
13288
13289 @c man end
13290
13291 @node Precompiled Headers
13292 @section Using Precompiled Headers
13293 @cindex precompiled headers
13294 @cindex speed of compilation
13295
13296 Often large projects have many header files that are included in every
13297 source file.  The time the compiler takes to process these header files
13298 over and over again can account for nearly all of the time required to
13299 build the project.  To make builds faster, GCC allows users to
13300 `precompile' a header file; then, if builds can use the precompiled
13301 header file they will be much faster.
13302
13303 To create a precompiled header file, simply compile it as you would any
13304 other file, if necessary using the @option{-x} option to make the driver
13305 treat it as a C or C++ header file.  You will probably want to use a
13306 tool like @command{make} to keep the precompiled header up-to-date when
13307 the headers it contains change.
13308
13309 A precompiled header file will be searched for when @code{#include} is
13310 seen in the compilation.  As it searches for the included file
13311 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13312 compiler looks for a precompiled header in each directory just before it
13313 looks for the include file in that directory.  The name searched for is
13314 the name specified in the @code{#include} with @samp{.gch} appended.  If
13315 the precompiled header file can't be used, it is ignored.
13316
13317 For instance, if you have @code{#include "all.h"}, and you have
13318 @file{all.h.gch} in the same directory as @file{all.h}, then the
13319 precompiled header file will be used if possible, and the original
13320 header will be used otherwise.
13321
13322 Alternatively, you might decide to put the precompiled header file in a
13323 directory and use @option{-I} to ensure that directory is searched
13324 before (or instead of) the directory containing the original header.
13325 Then, if you want to check that the precompiled header file is always
13326 used, you can put a file of the same name as the original header in this
13327 directory containing an @code{#error} command.
13328
13329 This also works with @option{-include}.  So yet another way to use
13330 precompiled headers, good for projects not designed with precompiled
13331 header files in mind, is to simply take most of the header files used by
13332 a project, include them from another header file, precompile that header
13333 file, and @option{-include} the precompiled header.  If the header files
13334 have guards against multiple inclusion, they will be skipped because
13335 they've already been included (in the precompiled header).
13336
13337 If you need to precompile the same header file for different
13338 languages, targets, or compiler options, you can instead make a
13339 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13340 header in the directory, perhaps using @option{-o}.  It doesn't matter
13341 what you call the files in the directory, every precompiled header in
13342 the directory will be considered.  The first precompiled header
13343 encountered in the directory that is valid for this compilation will
13344 be used; they're searched in no particular order.
13345
13346 There are many other possibilities, limited only by your imagination,
13347 good sense, and the constraints of your build system.
13348
13349 A precompiled header file can be used only when these conditions apply:
13350
13351 @itemize
13352 @item
13353 Only one precompiled header can be used in a particular compilation.
13354
13355 @item
13356 A precompiled header can't be used once the first C token is seen.  You
13357 can have preprocessor directives before a precompiled header; you can
13358 even include a precompiled header from inside another header, so long as
13359 there are no C tokens before the @code{#include}.
13360
13361 @item
13362 The precompiled header file must be produced for the same language as
13363 the current compilation.  You can't use a C precompiled header for a C++
13364 compilation.
13365
13366 @item
13367 The precompiled header file must have been produced by the same compiler
13368 binary as the current compilation is using.
13369
13370 @item
13371 Any macros defined before the precompiled header is included must
13372 either be defined in the same way as when the precompiled header was
13373 generated, or must not affect the precompiled header, which usually
13374 means that they don't appear in the precompiled header at all.
13375
13376 The @option{-D} option is one way to define a macro before a
13377 precompiled header is included; using a @code{#define} can also do it.
13378 There are also some options that define macros implicitly, like
13379 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13380 defined this way.
13381
13382 @item If debugging information is output when using the precompiled
13383 header, using @option{-g} or similar, the same kind of debugging information
13384 must have been output when building the precompiled header.  However,
13385 a precompiled header built using @option{-g} can be used in a compilation
13386 when no debugging information is being output.
13387
13388 @item The same @option{-m} options must generally be used when building
13389 and using the precompiled header.  @xref{Submodel Options},
13390 for any cases where this rule is relaxed.
13391
13392 @item Each of the following options must be the same when building and using
13393 the precompiled header:
13394
13395 @gccoptlist{-fexceptions -funit-at-a-time}
13396
13397 @item
13398 Some other command-line options starting with @option{-f},
13399 @option{-p}, or @option{-O} must be defined in the same way as when
13400 the precompiled header was generated.  At present, it's not clear
13401 which options are safe to change and which are not; the safest choice
13402 is to use exactly the same options when generating and using the
13403 precompiled header.  The following are known to be safe:
13404
13405 @gccoptlist{-fmessage-length= -fpreprocessed
13406 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13407 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13408 -pedantic-errors}
13409
13410 @end itemize
13411
13412 For all of these except the last, the compiler will automatically
13413 ignore the precompiled header if the conditions aren't met.  If you
13414 find an option combination that doesn't work and doesn't cause the
13415 precompiled header to be ignored, please consider filing a bug report,
13416 see @ref{Bugs}.
13417
13418 If you do use differing options when generating and using the
13419 precompiled header, the actual behavior will be a mixture of the
13420 behavior for the options.  For instance, if you use @option{-g} to
13421 generate the precompiled header but not when using it, you may or may
13422 not get debugging information for routines in the precompiled header.
13423
13424 @node Running Protoize
13425 @section Running Protoize
13426
13427 The program @code{protoize} is an optional part of GCC@.  You can use
13428 it to add prototypes to a program, thus converting the program to ISO
13429 C in one respect.  The companion program @code{unprotoize} does the
13430 reverse: it removes argument types from any prototypes that are found.
13431
13432 When you run these programs, you must specify a set of source files as
13433 command line arguments.  The conversion programs start out by compiling
13434 these files to see what functions they define.  The information gathered
13435 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13436
13437 After scanning comes actual conversion.  The specified files are all
13438 eligible to be converted; any files they include (whether sources or
13439 just headers) are eligible as well.
13440
13441 But not all the eligible files are converted.  By default,
13442 @code{protoize} and @code{unprotoize} convert only source and header
13443 files in the current directory.  You can specify additional directories
13444 whose files should be converted with the @option{-d @var{directory}}
13445 option.  You can also specify particular files to exclude with the
13446 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13447 directory name matches one of the specified directory names, and its
13448 name within the directory has not been excluded.
13449
13450 Basic conversion with @code{protoize} consists of rewriting most
13451 function definitions and function declarations to specify the types of
13452 the arguments.  The only ones not rewritten are those for varargs
13453 functions.
13454
13455 @code{protoize} optionally inserts prototype declarations at the
13456 beginning of the source file, to make them available for any calls that
13457 precede the function's definition.  Or it can insert prototype
13458 declarations with block scope in the blocks where undeclared functions
13459 are called.
13460
13461 Basic conversion with @code{unprotoize} consists of rewriting most
13462 function declarations to remove any argument types, and rewriting
13463 function definitions to the old-style pre-ISO form.
13464
13465 Both conversion programs print a warning for any function declaration or
13466 definition that they can't convert.  You can suppress these warnings
13467 with @option{-q}.
13468
13469 The output from @code{protoize} or @code{unprotoize} replaces the
13470 original source file.  The original file is renamed to a name ending
13471 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13472 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13473 for DOS) file already exists, then the source file is simply discarded.
13474
13475 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13476 scan the program and collect information about the functions it uses.
13477 So neither of these programs will work until GCC is installed.
13478
13479 Here is a table of the options you can use with @code{protoize} and
13480 @code{unprotoize}.  Each option works with both programs unless
13481 otherwise stated.
13482
13483 @table @code
13484 @item -B @var{directory}
13485 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13486 usual directory (normally @file{/usr/local/lib}).  This file contains
13487 prototype information about standard system functions.  This option
13488 applies only to @code{protoize}.
13489
13490 @item -c @var{compilation-options}
13491 Use @var{compilation-options} as the options when running @command{gcc} to
13492 produce the @samp{.X} files.  The special option @option{-aux-info} is
13493 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13494
13495 Note that the compilation options must be given as a single argument to
13496 @code{protoize} or @code{unprotoize}.  If you want to specify several
13497 @command{gcc} options, you must quote the entire set of compilation options
13498 to make them a single word in the shell.
13499
13500 There are certain @command{gcc} arguments that you cannot use, because they
13501 would produce the wrong kind of output.  These include @option{-g},
13502 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13503 the @var{compilation-options}, they are ignored.
13504
13505 @item -C
13506 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13507 systems) instead of @samp{.c}.  This is convenient if you are converting
13508 a C program to C++.  This option applies only to @code{protoize}.
13509
13510 @item -g
13511 Add explicit global declarations.  This means inserting explicit
13512 declarations at the beginning of each source file for each function
13513 that is called in the file and was not declared.  These declarations
13514 precede the first function definition that contains a call to an
13515 undeclared function.  This option applies only to @code{protoize}.
13516
13517 @item -i @var{string}
13518 Indent old-style parameter declarations with the string @var{string}.
13519 This option applies only to @code{protoize}.
13520
13521 @code{unprotoize} converts prototyped function definitions to old-style
13522 function definitions, where the arguments are declared between the
13523 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13524 uses five spaces as the indentation.  If you want to indent with just
13525 one space instead, use @option{-i " "}.
13526
13527 @item -k
13528 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13529 is finished.
13530
13531 @item -l
13532 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13533 a prototype declaration for each function in each block which calls the
13534 function without any declaration.  This option applies only to
13535 @code{protoize}.
13536
13537 @item -n
13538 Make no real changes.  This mode just prints information about the conversions
13539 that would have been done without @option{-n}.
13540
13541 @item -N
13542 Make no @samp{.save} files.  The original files are simply deleted.
13543 Use this option with caution.
13544
13545 @item -p @var{program}
13546 Use the program @var{program} as the compiler.  Normally, the name
13547 @file{gcc} is used.
13548
13549 @item -q
13550 Work quietly.  Most warnings are suppressed.
13551
13552 @item -v
13553 Print the version number, just like @option{-v} for @command{gcc}.
13554 @end table
13555
13556 If you need special compiler options to compile one of your program's
13557 source files, then you should generate that file's @samp{.X} file
13558 specially, by running @command{gcc} on that source file with the
13559 appropriate options and the option @option{-aux-info}.  Then run
13560 @code{protoize} on the entire set of files.  @code{protoize} will use
13561 the existing @samp{.X} file because it is newer than the source file.
13562 For example:
13563
13564 @smallexample
13565 gcc -Dfoo=bar file1.c -aux-info file1.X
13566 protoize *.c
13567 @end smallexample
13568
13569 @noindent
13570 You need to include the special files along with the rest in the
13571 @code{protoize} command, even though their @samp{.X} files already
13572 exist, because otherwise they won't get converted.
13573
13574 @xref{Protoize Caveats}, for more information on how to use
13575 @code{protoize} successfully.