OSDN Git Service

616caef0309ac197958000e4056d84ecfb619ca6
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 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 -Wno-pointer-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{MS1 Options}
617 @gccoptlist{-mno-crt0 -mmul -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  -mbackchain  -mno-backchain @gol
670 -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}
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 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 Fortran source code which must be preprocessed (with the traditional
863 preprocessor).
864
865 @item @var{file}.r
866 Fortran source code which must be preprocessed with a RATFOR
867 preprocessor (not included with GCC)@.
868
869 @item @var{file}.f90
870 @itemx @var{file}.f95
871 Fortran 90/95 source code which should not be preprocessed.
872
873 @item @var{file}.F90
874 @itemx @var{file}.F95
875 Fortran 90/95 source code which must be preprocessed (with the
876 traditional preprocessor).
877
878 @c FIXME: Descriptions of Java file types.
879 @c @var{file}.java
880 @c @var{file}.class
881 @c @var{file}.zip
882 @c @var{file}.jar
883
884 @item @var{file}.ads
885 Ada source code file which contains a library unit declaration (a
886 declaration of a package, subprogram, or generic, or a generic
887 instantiation), or a library unit renaming declaration (a package,
888 generic, or subprogram renaming declaration).  Such files are also
889 called @dfn{specs}.
890
891 @itemx @var{file}.adb
892 Ada source code file containing a library unit body (a subprogram or
893 package body).  Such files are also called @dfn{bodies}.
894
895 @c GCC also knows about some suffixes for languages not yet included:
896 @c Pascal:
897 @c @var{file}.p
898 @c @var{file}.pas
899
900 @item @var{file}.s
901 Assembler code.
902
903 @item @var{file}.S
904 Assembler code which must be preprocessed.
905
906 @item @var{other}
907 An object file to be fed straight into linking.
908 Any file name with no recognized suffix is treated this way.
909 @end table
910
911 @opindex x
912 You can specify the input language explicitly with the @option{-x} option:
913
914 @table @gcctabopt
915 @item -x @var{language}
916 Specify explicitly the @var{language} for the following input files
917 (rather than letting the compiler choose a default based on the file
918 name suffix).  This option applies to all following input files until
919 the next @option{-x} option.  Possible values for @var{language} are:
920 @smallexample
921 c  c-header  c-cpp-output
922 c++  c++-header  c++-cpp-output
923 objective-c  objective-c-header  objective-c-cpp-output
924 objective-c++ objective-c++-header objective-c++-cpp-output
925 assembler  assembler-with-cpp
926 ada
927 f77  f77-cpp-input  ratfor
928 f95  f95-cpp-input
929 java
930 treelang
931 @end smallexample
932
933 @item -x none
934 Turn off any specification of a language, so that subsequent files are
935 handled according to their file name suffixes (as they are if @option{-x}
936 has not been used at all).
937
938 @item -pass-exit-codes
939 @opindex pass-exit-codes
940 Normally the @command{gcc} program will exit with the code of 1 if any
941 phase of the compiler returns a non-success return code.  If you specify
942 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
943 numerically highest error produced by any phase that returned an error
944 indication.
945 @end table
946
947 If you only want some of the stages of compilation, you can use
948 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
949 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
950 @command{gcc} is to stop.  Note that some combinations (for example,
951 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
952
953 @table @gcctabopt
954 @item -c
955 @opindex c
956 Compile or assemble the source files, but do not link.  The linking
957 stage simply is not done.  The ultimate output is in the form of an
958 object file for each source file.
959
960 By default, the object file name for a source file is made by replacing
961 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
962
963 Unrecognized input files, not requiring compilation or assembly, are
964 ignored.
965
966 @item -S
967 @opindex S
968 Stop after the stage of compilation proper; do not assemble.  The output
969 is in the form of an assembler code file for each non-assembler input
970 file specified.
971
972 By default, the assembler file name for a source file is made by
973 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
974
975 Input files that don't require compilation are ignored.
976
977 @item -E
978 @opindex E
979 Stop after the preprocessing stage; do not run the compiler proper.  The
980 output is in the form of preprocessed source code, which is sent to the
981 standard output.
982
983 Input files which don't require preprocessing are ignored.
984
985 @cindex output file option
986 @item -o @var{file}
987 @opindex o
988 Place output in file @var{file}.  This applies regardless to whatever
989 sort of output is being produced, whether it be an executable file,
990 an object file, an assembler file or preprocessed C code.
991
992 If @option{-o} is not specified, the default is to put an executable
993 file in @file{a.out}, the object file for
994 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
995 assembler file in @file{@var{source}.s}, a precompiled header file in
996 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
997 standard output.
998
999 @item -v
1000 @opindex v
1001 Print (on standard error output) the commands executed to run the stages
1002 of compilation.  Also print the version number of the compiler driver
1003 program and of the preprocessor and the compiler proper.
1004
1005 @item -###
1006 @opindex ###
1007 Like @option{-v} except the commands are not executed and all command
1008 arguments are quoted.  This is useful for shell scripts to capture the
1009 driver-generated command lines.
1010
1011 @item -pipe
1012 @opindex pipe
1013 Use pipes rather than temporary files for communication between the
1014 various stages of compilation.  This fails to work on some systems where
1015 the assembler is unable to read from a pipe; but the GNU assembler has
1016 no trouble.
1017
1018 @item -combine
1019 @opindex combine
1020 If you are compiling multiple source files, this option tells the driver
1021 to pass all the source files to the compiler at once (for those
1022 languages for which the compiler can handle this).  This will allow
1023 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1024 language for which this is supported is C@.  If you pass source files for
1025 multiple languages to the driver, using this option, the driver will invoke
1026 the compiler(s) that support IMA once each, passing each compiler all the
1027 source files appropriate for it.  For those languages that do not support
1028 IMA this option will be ignored, and the compiler will be invoked once for
1029 each source file in that language.  If you use this option in conjunction
1030 with @option{-save-temps}, the compiler will generate multiple
1031 pre-processed files
1032 (one for each source file), but only one (combined) @file{.o} or
1033 @file{.s} file.
1034
1035 @item --help
1036 @opindex help
1037 Print (on the standard output) a description of the command line options
1038 understood by @command{gcc}.  If the @option{-v} option is also specified
1039 then @option{--help} will also be passed on to the various processes
1040 invoked by @command{gcc}, so that they can display the command line options
1041 they accept.  If the @option{-Wextra} option is also specified then command
1042 line options which have no documentation associated with them will also
1043 be displayed.
1044
1045 @item --target-help
1046 @opindex target-help
1047 Print (on the standard output) a description of target specific command
1048 line options for each tool.
1049
1050 @item --version
1051 @opindex version
1052 Display the version number and copyrights of the invoked GCC@.
1053 @end table
1054
1055 @node Invoking G++
1056 @section Compiling C++ Programs
1057
1058 @cindex suffixes for C++ source
1059 @cindex C++ source file suffixes
1060 C++ source files conventionally use one of the suffixes @samp{.C},
1061 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1062 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1063 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1064 files with these names and compiles them as C++ programs even if you
1065 call the compiler the same way as for compiling C programs (usually
1066 with the name @command{gcc}).
1067
1068 @findex g++
1069 @findex c++
1070 However, C++ programs often require class libraries as well as a
1071 compiler that understands the C++ language---and under some
1072 circumstances, you might want to compile programs or header files from
1073 standard input, or otherwise without a suffix that flags them as C++
1074 programs.  You might also like to precompile a C header file with a
1075 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1076 program that calls GCC with the default language set to C++, and
1077 automatically specifies linking against the C++ library.  On many
1078 systems, @command{g++} is also installed with the name @command{c++}.
1079
1080 @cindex invoking @command{g++}
1081 When you compile C++ programs, you may specify many of the same
1082 command-line options that you use for compiling programs in any
1083 language; or command-line options meaningful for C and related
1084 languages; or options that are meaningful only for C++ programs.
1085 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1086 explanations of options for languages related to C@.
1087 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1088 explanations of options that are meaningful only for C++ programs.
1089
1090 @node C Dialect Options
1091 @section Options Controlling C Dialect
1092 @cindex dialect options
1093 @cindex language dialect options
1094 @cindex options, dialect
1095
1096 The following options control the dialect of C (or languages derived
1097 from C, such as C++, Objective-C and Objective-C++) that the compiler
1098 accepts:
1099
1100 @table @gcctabopt
1101 @cindex ANSI support
1102 @cindex ISO support
1103 @item -ansi
1104 @opindex ansi
1105 In C mode, support all ISO C90 programs.  In C++ mode,
1106 remove GNU extensions that conflict with ISO C++.
1107
1108 This turns off certain features of GCC that are incompatible with ISO
1109 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1110 such as the @code{asm} and @code{typeof} keywords, and
1111 predefined macros such as @code{unix} and @code{vax} that identify the
1112 type of system you are using.  It also enables the undesirable and
1113 rarely used ISO trigraph feature.  For the C compiler,
1114 it disables recognition of C++ style @samp{//} comments as well as
1115 the @code{inline} keyword.
1116
1117 The alternate keywords @code{__asm__}, @code{__extension__},
1118 @code{__inline__} and @code{__typeof__} continue to work despite
1119 @option{-ansi}.  You would not want to use them in an ISO C program, of
1120 course, but it is useful to put them in header files that might be included
1121 in compilations done with @option{-ansi}.  Alternate predefined macros
1122 such as @code{__unix__} and @code{__vax__} are also available, with or
1123 without @option{-ansi}.
1124
1125 The @option{-ansi} option does not cause non-ISO programs to be
1126 rejected gratuitously.  For that, @option{-pedantic} is required in
1127 addition to @option{-ansi}.  @xref{Warning Options}.
1128
1129 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1130 option is used.  Some header files may notice this macro and refrain
1131 from declaring certain functions or defining certain macros that the
1132 ISO standard doesn't call for; this is to avoid interfering with any
1133 programs that might use these names for other things.
1134
1135 Functions which would normally be built in but do not have semantics
1136 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1137 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1138 built-in functions provided by GCC}, for details of the functions
1139 affected.
1140
1141 @item -std=
1142 @opindex std
1143 Determine the language standard.  This option is currently only
1144 supported when compiling C or C++.  A value for this option must be
1145 provided; possible values are
1146
1147 @table @samp
1148 @item c89
1149 @itemx iso9899:1990
1150 ISO C90 (same as @option{-ansi}).
1151
1152 @item iso9899:199409
1153 ISO C90 as modified in amendment 1.
1154
1155 @item c99
1156 @itemx c9x
1157 @itemx iso9899:1999
1158 @itemx iso9899:199x
1159 ISO C99.  Note that this standard is not yet fully supported; see
1160 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1161 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1162
1163 @item gnu89
1164 Default, ISO C90 plus GNU extensions (including some C99 features).
1165
1166 @item gnu99
1167 @itemx gnu9x
1168 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1169 this will become the default.  The name @samp{gnu9x} is deprecated.
1170
1171 @item c++98
1172 The 1998 ISO C++ standard plus amendments.
1173
1174 @item gnu++98
1175 The same as @option{-std=c++98} plus GNU extensions.  This is the
1176 default for C++ code.
1177 @end table
1178
1179 Even when this option is not specified, you can still use some of the
1180 features of newer standards in so far as they do not conflict with
1181 previous C standards.  For example, you may use @code{__restrict__} even
1182 when @option{-std=c99} is not specified.
1183
1184 The @option{-std} options specifying some version of ISO C have the same
1185 effects as @option{-ansi}, except that features that were not in ISO C90
1186 but are in the specified version (for example, @samp{//} comments and
1187 the @code{inline} keyword in ISO C99) are not disabled.
1188
1189 @xref{Standards,,Language Standards Supported by GCC}, for details of
1190 these standard versions.
1191
1192 @item -aux-info @var{filename}
1193 @opindex aux-info
1194 Output to the given filename prototyped declarations for all functions
1195 declared and/or defined in a translation unit, including those in header
1196 files.  This option is silently ignored in any language other than C@.
1197
1198 Besides declarations, the file indicates, in comments, the origin of
1199 each declaration (source file and line), whether the declaration was
1200 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1201 @samp{O} for old, respectively, in the first character after the line
1202 number and the colon), and whether it came from a declaration or a
1203 definition (@samp{C} or @samp{F}, respectively, in the following
1204 character).  In the case of function definitions, a K&R-style list of
1205 arguments followed by their declarations is also provided, inside
1206 comments, after the declaration.
1207
1208 @item -fno-asm
1209 @opindex fno-asm
1210 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1211 keyword, so that code can use these words as identifiers.  You can use
1212 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1213 instead.  @option{-ansi} implies @option{-fno-asm}.
1214
1215 In C++, this switch only affects the @code{typeof} keyword, since
1216 @code{asm} and @code{inline} are standard keywords.  You may want to
1217 use the @option{-fno-gnu-keywords} flag instead, which has the same
1218 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1219 switch only affects the @code{asm} and @code{typeof} keywords, since
1220 @code{inline} is a standard keyword in ISO C99.
1221
1222 @item -fno-builtin
1223 @itemx -fno-builtin-@var{function}
1224 @opindex fno-builtin
1225 @cindex built-in functions
1226 Don't recognize built-in functions that do not begin with
1227 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1228 functions provided by GCC}, for details of the functions affected,
1229 including those which are not built-in functions when @option{-ansi} or
1230 @option{-std} options for strict ISO C conformance are used because they
1231 do not have an ISO standard meaning.
1232
1233 GCC normally generates special code to handle certain built-in functions
1234 more efficiently; for instance, calls to @code{alloca} may become single
1235 instructions that adjust the stack directly, and calls to @code{memcpy}
1236 may become inline copy loops.  The resulting code is often both smaller
1237 and faster, but since the function calls no longer appear as such, you
1238 cannot set a breakpoint on those calls, nor can you change the behavior
1239 of the functions by linking with a different library.  In addition,
1240 when a function is recognized as a built-in function, GCC may use
1241 information about that function to warn about problems with calls to
1242 that function, or to generate more efficient code, even if the
1243 resulting code still contains calls to that function.  For example,
1244 warnings are given with @option{-Wformat} for bad calls to
1245 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1246 known not to modify global memory.
1247
1248 With the @option{-fno-builtin-@var{function}} option
1249 only the built-in function @var{function} is
1250 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1251 function is named this is not built-in in this version of GCC, this
1252 option is ignored.  There is no corresponding
1253 @option{-fbuiltin-@var{function}} option; if you wish to enable
1254 built-in functions selectively when using @option{-fno-builtin} or
1255 @option{-ffreestanding}, you may define macros such as:
1256
1257 @smallexample
1258 #define abs(n)          __builtin_abs ((n))
1259 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1260 @end smallexample
1261
1262 @item -fhosted
1263 @opindex fhosted
1264 @cindex hosted environment
1265
1266 Assert that compilation takes place in a hosted environment.  This implies
1267 @option{-fbuiltin}.  A hosted environment is one in which the
1268 entire standard library is available, and in which @code{main} has a return
1269 type of @code{int}.  Examples are nearly everything except a kernel.
1270 This is equivalent to @option{-fno-freestanding}.
1271
1272 @item -ffreestanding
1273 @opindex ffreestanding
1274 @cindex hosted environment
1275
1276 Assert that compilation takes place in a freestanding environment.  This
1277 implies @option{-fno-builtin}.  A freestanding environment
1278 is one in which the standard library may not exist, and program startup may
1279 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1280 This is equivalent to @option{-fno-hosted}.
1281
1282 @xref{Standards,,Language Standards Supported by GCC}, for details of
1283 freestanding and hosted environments.
1284
1285 @item -fms-extensions
1286 @opindex fms-extensions
1287 Accept some non-standard constructs used in Microsoft header files.
1288
1289 Some cases of unnamed fields in structures and unions are only
1290 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1291 fields within structs/unions}, for details.
1292
1293 @item -trigraphs
1294 @opindex trigraphs
1295 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1296 options for strict ISO C conformance) implies @option{-trigraphs}.
1297
1298 @item -no-integrated-cpp
1299 @opindex no-integrated-cpp
1300 Performs a compilation in two passes: preprocessing and compiling.  This
1301 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1302 @option{-B} option.  The user supplied compilation step can then add in
1303 an additional preprocessing step after normal preprocessing but before
1304 compiling.  The default is to use the integrated cpp (internal cpp)
1305
1306 The semantics of this option will change if "cc1", "cc1plus", and
1307 "cc1obj" are merged.
1308
1309 @cindex traditional C language
1310 @cindex C language, traditional
1311 @item -traditional
1312 @itemx -traditional-cpp
1313 @opindex traditional-cpp
1314 @opindex traditional
1315 Formerly, these options caused GCC to attempt to emulate a pre-standard
1316 C compiler.  They are now only supported with the @option{-E} switch.
1317 The preprocessor continues to support a pre-standard mode.  See the GNU
1318 CPP manual for details.
1319
1320 @item -fcond-mismatch
1321 @opindex fcond-mismatch
1322 Allow conditional expressions with mismatched types in the second and
1323 third arguments.  The value of such an expression is void.  This option
1324 is not supported for C++.
1325
1326 @item -funsigned-char
1327 @opindex funsigned-char
1328 Let the type @code{char} be unsigned, like @code{unsigned char}.
1329
1330 Each kind of machine has a default for what @code{char} should
1331 be.  It is either like @code{unsigned char} by default or like
1332 @code{signed char} by default.
1333
1334 Ideally, a portable program should always use @code{signed char} or
1335 @code{unsigned char} when it depends on the signedness of an object.
1336 But many programs have been written to use plain @code{char} and
1337 expect it to be signed, or expect it to be unsigned, depending on the
1338 machines they were written for.  This option, and its inverse, let you
1339 make such a program work with the opposite default.
1340
1341 The type @code{char} is always a distinct type from each of
1342 @code{signed char} or @code{unsigned char}, even though its behavior
1343 is always just like one of those two.
1344
1345 @item -fsigned-char
1346 @opindex fsigned-char
1347 Let the type @code{char} be signed, like @code{signed char}.
1348
1349 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1350 the negative form of @option{-funsigned-char}.  Likewise, the option
1351 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1352
1353 @item -fsigned-bitfields
1354 @itemx -funsigned-bitfields
1355 @itemx -fno-signed-bitfields
1356 @itemx -fno-unsigned-bitfields
1357 @opindex fsigned-bitfields
1358 @opindex funsigned-bitfields
1359 @opindex fno-signed-bitfields
1360 @opindex fno-unsigned-bitfields
1361 These options control whether a bit-field is signed or unsigned, when the
1362 declaration does not use either @code{signed} or @code{unsigned}.  By
1363 default, such a bit-field is signed, because this is consistent: the
1364 basic integer types such as @code{int} are signed types.
1365 @end table
1366
1367 @node C++ Dialect Options
1368 @section Options Controlling C++ Dialect
1369
1370 @cindex compiler options, C++
1371 @cindex C++ options, command line
1372 @cindex options, C++
1373 This section describes the command-line options that are only meaningful
1374 for C++ programs; but you can also use most of the GNU compiler options
1375 regardless of what language your program is in.  For example, you
1376 might compile a file @code{firstClass.C} like this:
1377
1378 @smallexample
1379 g++ -g -frepo -O -c firstClass.C
1380 @end smallexample
1381
1382 @noindent
1383 In this example, only @option{-frepo} is an option meant
1384 only for C++ programs; you can use the other options with any
1385 language supported by GCC@.
1386
1387 Here is a list of options that are @emph{only} for compiling C++ programs:
1388
1389 @table @gcctabopt
1390
1391 @item -fabi-version=@var{n}
1392 @opindex fabi-version
1393 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1394 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1395 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1396 the version that conforms most closely to the C++ ABI specification.
1397 Therefore, the ABI obtained using version 0 will change as ABI bugs
1398 are fixed.
1399
1400 The default is version 2.
1401
1402 @item -fno-access-control
1403 @opindex fno-access-control
1404 Turn off all access checking.  This switch is mainly useful for working
1405 around bugs in the access control code.
1406
1407 @item -fcheck-new
1408 @opindex fcheck-new
1409 Check that the pointer returned by @code{operator new} is non-null
1410 before attempting to modify the storage allocated.  This check is
1411 normally unnecessary because the C++ standard specifies that
1412 @code{operator new} will only return @code{0} if it is declared
1413 @samp{throw()}, in which case the compiler will always check the
1414 return value even without this option.  In all other cases, when
1415 @code{operator new} has a non-empty exception specification, memory
1416 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1417 @samp{new (nothrow)}.
1418
1419 @item -fconserve-space
1420 @opindex fconserve-space
1421 Put uninitialized or runtime-initialized global variables into the
1422 common segment, as C does.  This saves space in the executable at the
1423 cost of not diagnosing duplicate definitions.  If you compile with this
1424 flag and your program mysteriously crashes after @code{main()} has
1425 completed, you may have an object that is being destroyed twice because
1426 two definitions were merged.
1427
1428 This option is no longer useful on most targets, now that support has
1429 been added for putting variables into BSS without making them common.
1430
1431 @item -ffriend-injection
1432 @opindex ffriend-injection
1433 Inject friend functions into the enclosing namespace, so that they are
1434 visible outside the scope of the class in which they are declared.
1435 Friend functions were documented to work this way in the old Annotated
1436 C++ Reference Manual, and versions of G++ before 4.1 always worked
1437 that way.  However, in ISO C++ a friend function which is not declared
1438 in an enclosing scope can only be found using argument dependent
1439 lookup.  This option causes friends to be injected as they were in
1440 earlier releases.
1441
1442 This option is for compatibility, and may be removed in a future
1443 release of G++.
1444
1445 @item -fno-const-strings
1446 @opindex fno-const-strings
1447 Give string constants type @code{char *} instead of type @code{const
1448 char *}.  By default, G++ uses type @code{const char *} as required by
1449 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1450 actually modify the value of a string constant.
1451
1452 This option might be removed in a future release of G++.  For maximum
1453 portability, you should structure your code so that it works with
1454 string constants that have type @code{const char *}.
1455
1456 @item -fno-elide-constructors
1457 @opindex fno-elide-constructors
1458 The C++ standard allows an implementation to omit creating a temporary
1459 which is only used to initialize another object of the same type.
1460 Specifying this option disables that optimization, and forces G++ to
1461 call the copy constructor in all cases.
1462
1463 @item -fno-enforce-eh-specs
1464 @opindex fno-enforce-eh-specs
1465 Don't generate code to check for violation of exception specifications
1466 at runtime.  This option violates the C++ standard, but may be useful
1467 for reducing code size in production builds, much like defining
1468 @samp{NDEBUG}.  This does not give user code permission to throw
1469 exceptions in violation of the exception specifications; the compiler
1470 will still optimize based on the specifications, so throwing an
1471 unexpected exception will result in undefined behavior.
1472
1473 @item -ffor-scope
1474 @itemx -fno-for-scope
1475 @opindex ffor-scope
1476 @opindex fno-for-scope
1477 If @option{-ffor-scope} is specified, the scope of variables declared in
1478 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1479 as specified by the C++ standard.
1480 If @option{-fno-for-scope} is specified, the scope of variables declared in
1481 a @i{for-init-statement} extends to the end of the enclosing scope,
1482 as was the case in old versions of G++, and other (traditional)
1483 implementations of C++.
1484
1485 The default if neither flag is given to follow the standard,
1486 but to allow and give a warning for old-style code that would
1487 otherwise be invalid, or have different behavior.
1488
1489 @item -fno-gnu-keywords
1490 @opindex fno-gnu-keywords
1491 Do not recognize @code{typeof} as a keyword, so that code can use this
1492 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1493 @option{-ansi} implies @option{-fno-gnu-keywords}.
1494
1495 @item -fno-implicit-templates
1496 @opindex fno-implicit-templates
1497 Never emit code for non-inline templates which are instantiated
1498 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1499 @xref{Template Instantiation}, for more information.
1500
1501 @item -fno-implicit-inline-templates
1502 @opindex fno-implicit-inline-templates
1503 Don't emit code for implicit instantiations of inline templates, either.
1504 The default is to handle inlines differently so that compiles with and
1505 without optimization will need the same set of explicit instantiations.
1506
1507 @item -fno-implement-inlines
1508 @opindex fno-implement-inlines
1509 To save space, do not emit out-of-line copies of inline functions
1510 controlled by @samp{#pragma implementation}.  This will cause linker
1511 errors if these functions are not inlined everywhere they are called.
1512
1513 @item -fms-extensions
1514 @opindex fms-extensions
1515 Disable pedantic warnings about constructs used in MFC, such as implicit
1516 int and getting a pointer to member function via non-standard syntax.
1517
1518 @item -fno-nonansi-builtins
1519 @opindex fno-nonansi-builtins
1520 Disable built-in declarations of functions that are not mandated by
1521 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1522 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1523
1524 @item -fno-operator-names
1525 @opindex fno-operator-names
1526 Do not treat the operator name keywords @code{and}, @code{bitand},
1527 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1528 synonyms as keywords.
1529
1530 @item -fno-optional-diags
1531 @opindex fno-optional-diags
1532 Disable diagnostics that the standard says a compiler does not need to
1533 issue.  Currently, the only such diagnostic issued by G++ is the one for
1534 a name having multiple meanings within a class.
1535
1536 @item -fpermissive
1537 @opindex fpermissive
1538 Downgrade some diagnostics about nonconformant code from errors to
1539 warnings.  Thus, using @option{-fpermissive} will allow some
1540 nonconforming code to compile.
1541
1542 @item -frepo
1543 @opindex frepo
1544 Enable automatic template instantiation at link time.  This option also
1545 implies @option{-fno-implicit-templates}.  @xref{Template
1546 Instantiation}, for more information.
1547
1548 @item -fno-rtti
1549 @opindex fno-rtti
1550 Disable generation of information about every class with virtual
1551 functions for use by the C++ runtime type identification features
1552 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1553 of the language, you can save some space by using this flag.  Note that
1554 exception handling uses the same information, but it will generate it as
1555 needed.
1556
1557 @item -fstats
1558 @opindex fstats
1559 Emit statistics about front-end processing at the end of the compilation.
1560 This information is generally only useful to the G++ development team.
1561
1562 @item -ftemplate-depth-@var{n}
1563 @opindex ftemplate-depth
1564 Set the maximum instantiation depth for template classes to @var{n}.
1565 A limit on the template instantiation depth is needed to detect
1566 endless recursions during template class instantiation.  ANSI/ISO C++
1567 conforming programs must not rely on a maximum depth greater than 17.
1568
1569 @item -fno-threadsafe-statics
1570 @opindex fno-threadsafe-statics
1571 Do not emit the extra code to use the routines specified in the C++
1572 ABI for thread-safe initialization of local statics.  You can use this
1573 option to reduce code size slightly in code that doesn't need to be
1574 thread-safe.
1575
1576 @item -fuse-cxa-atexit
1577 @opindex fuse-cxa-atexit
1578 Register destructors for objects with static storage duration with the
1579 @code{__cxa_atexit} function rather than the @code{atexit} function.
1580 This option is required for fully standards-compliant handling of static
1581 destructors, but will only work if your C library supports
1582 @code{__cxa_atexit}.
1583
1584 @item -fvisibility-inlines-hidden
1585 @opindex fvisibility-inlines-hidden
1586 Causes all inlined methods to be marked with
1587 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1588 appear in the export table of a DSO and do not require a PLT indirection
1589 when used within the DSO@.  Enabling this option can have a dramatic effect
1590 on load and link times of a DSO as it massively reduces the size of the
1591 dynamic export table when the library makes heavy use of templates.  While
1592 it can cause bloating through duplication of code within each DSO where
1593 it is used, often the wastage is less than the considerable space occupied
1594 by a long symbol name in the export table which is typical when using
1595 templates and namespaces.  For even more savings, combine with the
1596 @option{-fvisibility=hidden} switch.
1597
1598 @item -fno-weak
1599 @opindex fno-weak
1600 Do not use weak symbol support, even if it is provided by the linker.
1601 By default, G++ will use weak symbols if they are available.  This
1602 option exists only for testing, and should not be used by end-users;
1603 it will result in inferior code and has no benefits.  This option may
1604 be removed in a future release of G++.
1605
1606 @item -nostdinc++
1607 @opindex nostdinc++
1608 Do not search for header files in the standard directories specific to
1609 C++, but do still search the other standard directories.  (This option
1610 is used when building the C++ library.)
1611 @end table
1612
1613 In addition, these optimization, warning, and code generation options
1614 have meanings only for C++ programs:
1615
1616 @table @gcctabopt
1617 @item -fno-default-inline
1618 @opindex fno-default-inline
1619 Do not assume @samp{inline} for functions defined inside a class scope.
1620 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1621 functions will have linkage like inline functions; they just won't be
1622 inlined by default.
1623
1624 @item -Wabi @r{(C++ only)}
1625 @opindex Wabi
1626 Warn when G++ generates code that is probably not compatible with the
1627 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1628 all such cases, there are probably some cases that are not warned about,
1629 even though G++ is generating incompatible code.  There may also be
1630 cases where warnings are emitted even though the code that is generated
1631 will be compatible.
1632
1633 You should rewrite your code to avoid these warnings if you are
1634 concerned about the fact that code generated by G++ may not be binary
1635 compatible with code generated by other compilers.
1636
1637 The known incompatibilities at this point include:
1638
1639 @itemize @bullet
1640
1641 @item
1642 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1643 pack data into the same byte as a base class.  For example:
1644
1645 @smallexample
1646 struct A @{ virtual void f(); int f1 : 1; @};
1647 struct B : public A @{ int f2 : 1; @};
1648 @end smallexample
1649
1650 @noindent
1651 In this case, G++ will place @code{B::f2} into the same byte
1652 as@code{A::f1}; other compilers will not.  You can avoid this problem
1653 by explicitly padding @code{A} so that its size is a multiple of the
1654 byte size on your platform; that will cause G++ and other compilers to
1655 layout @code{B} identically.
1656
1657 @item
1658 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1659 tail padding when laying out virtual bases.  For example:
1660
1661 @smallexample
1662 struct A @{ virtual void f(); char c1; @};
1663 struct B @{ B(); char c2; @};
1664 struct C : public A, public virtual B @{@};
1665 @end smallexample
1666
1667 @noindent
1668 In this case, G++ will not place @code{B} into the tail-padding for
1669 @code{A}; other compilers will.  You can avoid this problem by
1670 explicitly padding @code{A} so that its size is a multiple of its
1671 alignment (ignoring virtual base classes); that will cause G++ and other
1672 compilers to layout @code{C} identically.
1673
1674 @item
1675 Incorrect handling of bit-fields with declared widths greater than that
1676 of their underlying types, when the bit-fields appear in a union.  For
1677 example:
1678
1679 @smallexample
1680 union U @{ int i : 4096; @};
1681 @end smallexample
1682
1683 @noindent
1684 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1685 union too small by the number of bits in an @code{int}.
1686
1687 @item
1688 Empty classes can be placed at incorrect offsets.  For example:
1689
1690 @smallexample
1691 struct A @{@};
1692
1693 struct B @{
1694   A a;
1695   virtual void f ();
1696 @};
1697
1698 struct C : public B, public A @{@};
1699 @end smallexample
1700
1701 @noindent
1702 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1703 it should be placed at offset zero.  G++ mistakenly believes that the
1704 @code{A} data member of @code{B} is already at offset zero.
1705
1706 @item
1707 Names of template functions whose types involve @code{typename} or
1708 template template parameters can be mangled incorrectly.
1709
1710 @smallexample
1711 template <typename Q>
1712 void f(typename Q::X) @{@}
1713
1714 template <template <typename> class Q>
1715 void f(typename Q<int>::X) @{@}
1716 @end smallexample
1717
1718 @noindent
1719 Instantiations of these templates may be mangled incorrectly.
1720
1721 @end itemize
1722
1723 @item -Wctor-dtor-privacy @r{(C++ only)}
1724 @opindex Wctor-dtor-privacy
1725 Warn when a class seems unusable because all the constructors or
1726 destructors in that class are private, and it has neither friends nor
1727 public static member functions.
1728
1729 @item -Wnon-virtual-dtor @r{(C++ only)}
1730 @opindex Wnon-virtual-dtor
1731 Warn when a class appears to be polymorphic, thereby requiring a virtual
1732 destructor, yet it declares a non-virtual one.
1733 This warning is enabled by @option{-Wall}.
1734
1735 @item -Wreorder @r{(C++ only)}
1736 @opindex Wreorder
1737 @cindex reordering, warning
1738 @cindex warning for reordering of member initializers
1739 Warn when the order of member initializers given in the code does not
1740 match the order in which they must be executed.  For instance:
1741
1742 @smallexample
1743 struct A @{
1744   int i;
1745   int j;
1746   A(): j (0), i (1) @{ @}
1747 @};
1748 @end smallexample
1749
1750 The compiler will rearrange the member initializers for @samp{i}
1751 and @samp{j} to match the declaration order of the members, emitting
1752 a warning to that effect.  This warning is enabled by @option{-Wall}.
1753 @end table
1754
1755 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1756
1757 @table @gcctabopt
1758 @item -Weffc++ @r{(C++ only)}
1759 @opindex Weffc++
1760 Warn about violations of the following style guidelines from Scott Meyers'
1761 @cite{Effective C++} book:
1762
1763 @itemize @bullet
1764 @item
1765 Item 11:  Define a copy constructor and an assignment operator for classes
1766 with dynamically allocated memory.
1767
1768 @item
1769 Item 12:  Prefer initialization to assignment in constructors.
1770
1771 @item
1772 Item 14:  Make destructors virtual in base classes.
1773
1774 @item
1775 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1776
1777 @item
1778 Item 23:  Don't try to return a reference when you must return an object.
1779
1780 @end itemize
1781
1782 Also warn about violations of the following style guidelines from
1783 Scott Meyers' @cite{More Effective C++} book:
1784
1785 @itemize @bullet
1786 @item
1787 Item 6:  Distinguish between prefix and postfix forms of increment and
1788 decrement operators.
1789
1790 @item
1791 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1792
1793 @end itemize
1794
1795 When selecting this option, be aware that the standard library
1796 headers do not obey all of these guidelines; use @samp{grep -v}
1797 to filter out those warnings.
1798
1799 @item -Wno-deprecated @r{(C++ only)}
1800 @opindex Wno-deprecated
1801 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1802
1803 @item -Wstrict-null-sentinel @r{(C++ only)}
1804 @opindex Wstrict-null-sentinel
1805 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1806 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1807 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1808 it is guaranteed to of the same size as a pointer.  But this use is
1809 not portable across different compilers.
1810
1811 @item -Wno-non-template-friend @r{(C++ only)}
1812 @opindex Wno-non-template-friend
1813 Disable warnings when non-templatized friend functions are declared
1814 within a template.  Since the advent of explicit template specification
1815 support in G++, if the name of the friend is an unqualified-id (i.e.,
1816 @samp{friend foo(int)}), the C++ language specification demands that the
1817 friend declare or define an ordinary, nontemplate function.  (Section
1818 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1819 could be interpreted as a particular specialization of a templatized
1820 function.  Because this non-conforming behavior is no longer the default
1821 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1822 check existing code for potential trouble spots and is on by default.
1823 This new compiler behavior can be turned off with
1824 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1825 but disables the helpful warning.
1826
1827 @item -Wold-style-cast @r{(C++ only)}
1828 @opindex Wold-style-cast
1829 Warn if an old-style (C-style) cast to a non-void type is used within
1830 a C++ program.  The new-style casts (@samp{dynamic_cast},
1831 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1832 less vulnerable to unintended effects and much easier to search for.
1833
1834 @item -Woverloaded-virtual @r{(C++ only)}
1835 @opindex Woverloaded-virtual
1836 @cindex overloaded virtual fn, warning
1837 @cindex warning for overloaded virtual fn
1838 Warn when a function declaration hides virtual functions from a
1839 base class.  For example, in:
1840
1841 @smallexample
1842 struct A @{
1843   virtual void f();
1844 @};
1845
1846 struct B: public A @{
1847   void f(int);
1848 @};
1849 @end smallexample
1850
1851 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1852 like:
1853
1854 @smallexample
1855 B* b;
1856 b->f();
1857 @end smallexample
1858
1859 will fail to compile.
1860
1861 @item -Wno-pmf-conversions @r{(C++ only)}
1862 @opindex Wno-pmf-conversions
1863 Disable the diagnostic for converting a bound pointer to member function
1864 to a plain pointer.
1865
1866 @item -Wsign-promo @r{(C++ only)}
1867 @opindex Wsign-promo
1868 Warn when overload resolution chooses a promotion from unsigned or
1869 enumerated type to a signed type, over a conversion to an unsigned type of
1870 the same size.  Previous versions of G++ would try to preserve
1871 unsignedness, but the standard mandates the current behavior.
1872
1873 @smallexample
1874 struct A @{
1875   operator int ();
1876   A& operator = (int);
1877 @};
1878
1879 main ()
1880 @{
1881   A a,b;
1882   a = b;
1883 @}
1884 @end smallexample
1885
1886 In this example, G++ will synthesize a default @samp{A& operator =
1887 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1888 @end table
1889
1890 @node Objective-C and Objective-C++ Dialect Options
1891 @section Options Controlling Objective-C and Objective-C++ Dialects
1892
1893 @cindex compiler options, Objective-C and Objective-C++
1894 @cindex Objective-C and Objective-C++ options, command line
1895 @cindex options, Objective-C and Objective-C++
1896 (NOTE: This manual does not describe the Objective-C and Objective-C++
1897 languages themselves.  See @xref{Standards,,Language Standards
1898 Supported by GCC}, for references.)
1899
1900 This section describes the command-line options that are only meaningful
1901 for Objective-C and Objective-C++ programs, but you can also use most of
1902 the language-independent GNU compiler options.
1903 For example, you might compile a file @code{some_class.m} like this:
1904
1905 @smallexample
1906 gcc -g -fgnu-runtime -O -c some_class.m
1907 @end smallexample
1908
1909 @noindent
1910 In this example, @option{-fgnu-runtime} is an option meant only for
1911 Objective-C and Objective-C++ programs; you can use the other options with
1912 any language supported by GCC@.
1913
1914 Note that since Objective-C is an extension of the C language, Objective-C
1915 compilations may also use options specific to the C front-end (e.g.,
1916 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1917 C++-specific options (e.g., @option{-Wabi}).
1918
1919 Here is a list of options that are @emph{only} for compiling Objective-C
1920 and Objective-C++ programs:
1921
1922 @table @gcctabopt
1923 @item -fconstant-string-class=@var{class-name}
1924 @opindex fconstant-string-class
1925 Use @var{class-name} as the name of the class to instantiate for each
1926 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1927 class name is @code{NXConstantString} if the GNU runtime is being used, and
1928 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1929 @option{-fconstant-cfstrings} option, if also present, will override the
1930 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1931 to be laid out as constant CoreFoundation strings.
1932
1933 @item -fgnu-runtime
1934 @opindex fgnu-runtime
1935 Generate object code compatible with the standard GNU Objective-C
1936 runtime.  This is the default for most types of systems.
1937
1938 @item -fnext-runtime
1939 @opindex fnext-runtime
1940 Generate output compatible with the NeXT runtime.  This is the default
1941 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1942 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1943 used.
1944
1945 @item -fno-nil-receivers
1946 @opindex fno-nil-receivers
1947 Assume that all Objective-C message dispatches (e.g.,
1948 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1949 is not @code{nil}.  This allows for more efficient entry points in the runtime
1950 to be used.  Currently, this option is only available in conjunction with
1951 the NeXT runtime on Mac OS X 10.3 and later.
1952
1953 @item -fobjc-call-cxx-cdtors
1954 @opindex fobjc-call-cxx-cdtors
1955 For each Objective-C class, check if any of its instance variables is a
1956 C++ object with a non-trivial default constructor.  If so, synthesize a
1957 special @code{- (id) .cxx_construct} instance method that will run
1958 non-trivial default constructors on any such instance variables, in order,
1959 and then return @code{self}.  Similarly, check if any instance variable
1960 is a C++ object with a non-trivial destructor, and if so, synthesize a
1961 special @code{- (void) .cxx_destruct} method that will run
1962 all such default destructors, in reverse order.
1963
1964 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1965 thusly generated will only operate on instance variables declared in the
1966 current Objective-C class, and not those inherited from superclasses.  It
1967 is the responsibility of the Objective-C runtime to invoke all such methods
1968 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1969 will be invoked by the runtime immediately after a new object
1970 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1971 be invoked immediately before the runtime deallocates an object instance.
1972
1973 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1974 support for invoking the @code{- (id) .cxx_construct} and
1975 @code{- (void) .cxx_destruct} methods.
1976
1977 @item -fobjc-direct-dispatch
1978 @opindex fobjc-direct-dispatch
1979 Allow fast jumps to the message dispatcher.  On Darwin this is
1980 accomplished via the comm page.
1981
1982 @item -fobjc-exceptions
1983 @opindex fobjc-exceptions
1984 Enable syntactic support for structured exception handling in Objective-C,
1985 similar to what is offered by C++ and Java.  Currently, this option is only
1986 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1987
1988 @smallexample
1989   @@try @{
1990     @dots{}
1991        @@throw expr;
1992     @dots{}
1993   @}
1994   @@catch (AnObjCClass *exc) @{
1995     @dots{}
1996       @@throw expr;
1997     @dots{}
1998       @@throw;
1999     @dots{}
2000   @}
2001   @@catch (AnotherClass *exc) @{
2002     @dots{}
2003   @}
2004   @@catch (id allOthers) @{
2005     @dots{}
2006   @}
2007   @@finally @{
2008     @dots{}
2009       @@throw expr;
2010     @dots{}
2011   @}
2012 @end smallexample
2013
2014 The @code{@@throw} statement may appear anywhere in an Objective-C or
2015 Objective-C++ program; when used inside of a @code{@@catch} block, the
2016 @code{@@throw} may appear without an argument (as shown above), in which case
2017 the object caught by the @code{@@catch} will be rethrown.
2018
2019 Note that only (pointers to) Objective-C objects may be thrown and
2020 caught using this scheme.  When an object is thrown, it will be caught
2021 by the nearest @code{@@catch} clause capable of handling objects of that type,
2022 analogously to how @code{catch} blocks work in C++ and Java.  A
2023 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2024 any and all Objective-C exceptions not caught by previous @code{@@catch}
2025 clauses (if any).
2026
2027 The @code{@@finally} clause, if present, will be executed upon exit from the
2028 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2029 regardless of whether any exceptions are thrown, caught or rethrown
2030 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2031 of the @code{finally} clause in Java.
2032
2033 There are several caveats to using the new exception mechanism:
2034
2035 @itemize @bullet
2036 @item
2037 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2038 idioms provided by the @code{NSException} class, the new
2039 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2040 systems, due to additional functionality needed in the (NeXT) Objective-C
2041 runtime.
2042
2043 @item
2044 As mentioned above, the new exceptions do not support handling
2045 types other than Objective-C objects.   Furthermore, when used from
2046 Objective-C++, the Objective-C exception model does not interoperate with C++
2047 exceptions at this time.  This means you cannot @code{@@throw} an exception
2048 from Objective-C and @code{catch} it in C++, or vice versa
2049 (i.e., @code{throw @dots{} @@catch}).
2050 @end itemize
2051
2052 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2053 blocks for thread-safe execution:
2054
2055 @smallexample
2056   @@synchronized (ObjCClass *guard) @{
2057     @dots{}
2058   @}
2059 @end smallexample
2060
2061 Upon entering the @code{@@synchronized} block, a thread of execution shall
2062 first check whether a lock has been placed on the corresponding @code{guard}
2063 object by another thread.  If it has, the current thread shall wait until
2064 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2065 the current thread will place its own lock on it, execute the code contained in
2066 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2067 making @code{guard} available to other threads).
2068
2069 Unlike Java, Objective-C does not allow for entire methods to be marked
2070 @code{@@synchronized}.  Note that throwing exceptions out of
2071 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2072 to be unlocked properly.
2073
2074 @item -fobjc-gc
2075 @opindex fobjc-gc
2076 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2077
2078 @item -freplace-objc-classes
2079 @opindex freplace-objc-classes
2080 Emit a special marker instructing @command{ld(1)} not to statically link in
2081 the resulting object file, and allow @command{dyld(1)} to load it in at
2082 run time instead.  This is used in conjunction with the Fix-and-Continue
2083 debugging mode, where the object file in question may be recompiled and
2084 dynamically reloaded in the course of program execution, without the need
2085 to restart the program itself.  Currently, Fix-and-Continue functionality
2086 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2087 and later.
2088
2089 @item -fzero-link
2090 @opindex fzero-link
2091 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2092 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2093 compile time) with static class references that get initialized at load time,
2094 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2095 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2096 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2097 for individual class implementations to be modified during program execution.
2098
2099 @item -gen-decls
2100 @opindex gen-decls
2101 Dump interface declarations for all classes seen in the source file to a
2102 file named @file{@var{sourcename}.decl}.
2103
2104 @item -Wassign-intercept
2105 @opindex Wassign-intercept
2106 Warn whenever an Objective-C assignment is being intercepted by the
2107 garbage collector.
2108
2109 @item -Wno-protocol
2110 @opindex Wno-protocol
2111 If a class is declared to implement a protocol, a warning is issued for
2112 every method in the protocol that is not implemented by the class.  The
2113 default behavior is to issue a warning for every method not explicitly
2114 implemented in the class, even if a method implementation is inherited
2115 from the superclass.  If you use the @option{-Wno-protocol} option, then
2116 methods inherited from the superclass are considered to be implemented,
2117 and no warning is issued for them.
2118
2119 @item -Wselector
2120 @opindex Wselector
2121 Warn if multiple methods of different types for the same selector are
2122 found during compilation.  The check is performed on the list of methods
2123 in the final stage of compilation.  Additionally, a check is performed
2124 for each selector appearing in a @code{@@selector(@dots{})}
2125 expression, and a corresponding method for that selector has been found
2126 during compilation.  Because these checks scan the method table only at
2127 the end of compilation, these warnings are not produced if the final
2128 stage of compilation is not reached, for example because an error is
2129 found during compilation, or because the @option{-fsyntax-only} option is
2130 being used.
2131
2132 @item -Wstrict-selector-match
2133 @opindex Wstrict-selector-match
2134 Warn if multiple methods with differing argument and/or return types are
2135 found for a given selector when attempting to send a message using this
2136 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2137 is off (which is the default behavior), the compiler will omit such warnings
2138 if any differences found are confined to types which share the same size
2139 and alignment.
2140
2141 @item -Wundeclared-selector
2142 @opindex Wundeclared-selector
2143 Warn if a @code{@@selector(@dots{})} expression referring to an
2144 undeclared selector is found.  A selector is considered undeclared if no
2145 method with that name has been declared before the
2146 @code{@@selector(@dots{})} expression, either explicitly in an
2147 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2148 an @code{@@implementation} section.  This option always performs its
2149 checks as soon as a @code{@@selector(@dots{})} expression is found,
2150 while @option{-Wselector} only performs its checks in the final stage of
2151 compilation.  This also enforces the coding style convention
2152 that methods and selectors must be declared before being used.
2153
2154 @item -print-objc-runtime-info
2155 @opindex print-objc-runtime-info
2156 Generate C header describing the largest structure that is passed by
2157 value, if any.
2158
2159 @end table
2160
2161 @node Language Independent Options
2162 @section Options to Control Diagnostic Messages Formatting
2163 @cindex options to control diagnostics formatting
2164 @cindex diagnostic messages
2165 @cindex message formatting
2166
2167 Traditionally, diagnostic messages have been formatted irrespective of
2168 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2169 below can be used to control the diagnostic messages formatting
2170 algorithm, e.g.@: how many characters per line, how often source location
2171 information should be reported.  Right now, only the C++ front end can
2172 honor these options.  However it is expected, in the near future, that
2173 the remaining front ends would be able to digest them correctly.
2174
2175 @table @gcctabopt
2176 @item -fmessage-length=@var{n}
2177 @opindex fmessage-length
2178 Try to format error messages so that they fit on lines of about @var{n}
2179 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2180 the front ends supported by GCC@.  If @var{n} is zero, then no
2181 line-wrapping will be done; each error message will appear on a single
2182 line.
2183
2184 @opindex fdiagnostics-show-location
2185 @item -fdiagnostics-show-location=once
2186 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2187 reporter to emit @emph{once} source location information; that is, in
2188 case the message is too long to fit on a single physical line and has to
2189 be wrapped, the source location won't be emitted (as prefix) again,
2190 over and over, in subsequent continuation lines.  This is the default
2191 behavior.
2192
2193 @item -fdiagnostics-show-location=every-line
2194 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2195 messages reporter to emit the same source location information (as
2196 prefix) for physical lines that result from the process of breaking
2197 a message which is too long to fit on a single line.
2198
2199 @item -fdiagnostics-show-options
2200 @opindex fdiagnostics-show-options
2201 This option instructs the diagnostic machinery to add text to each
2202 diagnostic emitted, which indicates which command line option directly
2203 controls that diagnostic, when such an option is known to the
2204 diagnostic machinery.
2205
2206 @end table
2207
2208 @node Warning Options
2209 @section Options to Request or Suppress Warnings
2210 @cindex options to control warnings
2211 @cindex warning messages
2212 @cindex messages, warning
2213 @cindex suppressing warnings
2214
2215 Warnings are diagnostic messages that report constructions which
2216 are not inherently erroneous but which are risky or suggest there
2217 may have been an error.
2218
2219 You can request many specific warnings with options beginning @samp{-W},
2220 for example @option{-Wimplicit} to request warnings on implicit
2221 declarations.  Each of these specific warning options also has a
2222 negative form beginning @samp{-Wno-} to turn off warnings;
2223 for example, @option{-Wno-implicit}.  This manual lists only one of the
2224 two forms, whichever is not the default.
2225
2226 The following options control the amount and kinds of warnings produced
2227 by GCC; for further, language-specific options also refer to
2228 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2229 Options}.
2230
2231 @table @gcctabopt
2232 @cindex syntax checking
2233 @item -fsyntax-only
2234 @opindex fsyntax-only
2235 Check the code for syntax errors, but don't do anything beyond that.
2236
2237 @item -pedantic
2238 @opindex pedantic
2239 Issue all the warnings demanded by strict ISO C and ISO C++;
2240 reject all programs that use forbidden extensions, and some other
2241 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2242 version of the ISO C standard specified by any @option{-std} option used.
2243
2244 Valid ISO C and ISO C++ programs should compile properly with or without
2245 this option (though a rare few will require @option{-ansi} or a
2246 @option{-std} option specifying the required version of ISO C)@.  However,
2247 without this option, certain GNU extensions and traditional C and C++
2248 features are supported as well.  With this option, they are rejected.
2249
2250 @option{-pedantic} does not cause warning messages for use of the
2251 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2252 warnings are also disabled in the expression that follows
2253 @code{__extension__}.  However, only system header files should use
2254 these escape routes; application programs should avoid them.
2255 @xref{Alternate Keywords}.
2256
2257 Some users try to use @option{-pedantic} to check programs for strict ISO
2258 C conformance.  They soon find that it does not do quite what they want:
2259 it finds some non-ISO practices, but not all---only those for which
2260 ISO C @emph{requires} a diagnostic, and some others for which
2261 diagnostics have been added.
2262
2263 A feature to report any failure to conform to ISO C might be useful in
2264 some instances, but would require considerable additional work and would
2265 be quite different from @option{-pedantic}.  We don't have plans to
2266 support such a feature in the near future.
2267
2268 Where the standard specified with @option{-std} represents a GNU
2269 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2270 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2271 extended dialect is based.  Warnings from @option{-pedantic} are given
2272 where they are required by the base standard.  (It would not make sense
2273 for such warnings to be given only for features not in the specified GNU
2274 C dialect, since by definition the GNU dialects of C include all
2275 features the compiler supports with the given option, and there would be
2276 nothing to warn about.)
2277
2278 @item -pedantic-errors
2279 @opindex pedantic-errors
2280 Like @option{-pedantic}, except that errors are produced rather than
2281 warnings.
2282
2283 @item -w
2284 @opindex w
2285 Inhibit all warning messages.
2286
2287 @item -Wno-import
2288 @opindex Wno-import
2289 Inhibit warning messages about the use of @samp{#import}.
2290
2291 @item -Wchar-subscripts
2292 @opindex Wchar-subscripts
2293 Warn if an array subscript has type @code{char}.  This is a common cause
2294 of error, as programmers often forget that this type is signed on some
2295 machines.
2296 This warning is enabled by @option{-Wall}.
2297
2298 @item -Wcomment
2299 @opindex Wcomment
2300 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2301 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2302 This warning is enabled by @option{-Wall}.
2303
2304 @item -Wfatal-errors
2305 @opindex Wfatal-errors
2306 This option causes the compiler to abort compilation on the first error
2307 occurred rather than trying to keep going and printing further error
2308 messages.
2309
2310 @item -Wformat
2311 @opindex Wformat
2312 @opindex ffreestanding
2313 @opindex fno-builtin
2314 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2315 the arguments supplied have types appropriate to the format string
2316 specified, and that the conversions specified in the format string make
2317 sense.  This includes standard functions, and others specified by format
2318 attributes (@pxref{Function Attributes}), in the @code{printf},
2319 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2320 not in the C standard) families (or other target-specific families).
2321 Which functions are checked without format attributes having been
2322 specified depends on the standard version selected, and such checks of
2323 functions without the attribute specified are disabled by
2324 @option{-ffreestanding} or @option{-fno-builtin}.
2325
2326 The formats are checked against the format features supported by GNU
2327 libc version 2.2.  These include all ISO C90 and C99 features, as well
2328 as features from the Single Unix Specification and some BSD and GNU
2329 extensions.  Other library implementations may not support all these
2330 features; GCC does not support warning about features that go beyond a
2331 particular library's limitations.  However, if @option{-pedantic} is used
2332 with @option{-Wformat}, warnings will be given about format features not
2333 in the selected standard version (but not for @code{strfmon} formats,
2334 since those are not in any version of the C standard).  @xref{C Dialect
2335 Options,,Options Controlling C Dialect}.
2336
2337 Since @option{-Wformat} also checks for null format arguments for
2338 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2339
2340 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2341 aspects of format checking, the options @option{-Wformat-y2k},
2342 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2343 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2344 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2345
2346 @item -Wformat-y2k
2347 @opindex Wformat-y2k
2348 If @option{-Wformat} is specified, also warn about @code{strftime}
2349 formats which may yield only a two-digit year.
2350
2351 @item -Wno-format-extra-args
2352 @opindex Wno-format-extra-args
2353 If @option{-Wformat} is specified, do not warn about excess arguments to a
2354 @code{printf} or @code{scanf} format function.  The C standard specifies
2355 that such arguments are ignored.
2356
2357 Where the unused arguments lie between used arguments that are
2358 specified with @samp{$} operand number specifications, normally
2359 warnings are still given, since the implementation could not know what
2360 type to pass to @code{va_arg} to skip the unused arguments.  However,
2361 in the case of @code{scanf} formats, this option will suppress the
2362 warning if the unused arguments are all pointers, since the Single
2363 Unix Specification says that such unused arguments are allowed.
2364
2365 @item -Wno-format-zero-length
2366 @opindex Wno-format-zero-length
2367 If @option{-Wformat} is specified, do not warn about zero-length formats.
2368 The C standard specifies that zero-length formats are allowed.
2369
2370 @item -Wformat-nonliteral
2371 @opindex Wformat-nonliteral
2372 If @option{-Wformat} is specified, also warn if the format string is not a
2373 string literal and so cannot be checked, unless the format function
2374 takes its format arguments as a @code{va_list}.
2375
2376 @item -Wformat-security
2377 @opindex Wformat-security
2378 If @option{-Wformat} is specified, also warn about uses of format
2379 functions that represent possible security problems.  At present, this
2380 warns about calls to @code{printf} and @code{scanf} functions where the
2381 format string is not a string literal and there are no format arguments,
2382 as in @code{printf (foo);}.  This may be a security hole if the format
2383 string came from untrusted input and contains @samp{%n}.  (This is
2384 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2385 in future warnings may be added to @option{-Wformat-security} that are not
2386 included in @option{-Wformat-nonliteral}.)
2387
2388 @item -Wformat=2
2389 @opindex Wformat=2
2390 Enable @option{-Wformat} plus format checks not included in
2391 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2392 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2393
2394 @item -Wnonnull
2395 @opindex Wnonnull
2396 Warn about passing a null pointer for arguments marked as
2397 requiring a non-null value by the @code{nonnull} function attribute.
2398
2399 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2400 can be disabled with the @option{-Wno-nonnull} option.
2401
2402 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2403 @opindex Winit-self
2404 Warn about uninitialized variables which are initialized with themselves.
2405 Note this option can only be used with the @option{-Wuninitialized} option,
2406 which in turn only works with @option{-O1} and above.
2407
2408 For example, GCC will warn about @code{i} being uninitialized in the
2409 following snippet only when @option{-Winit-self} has been specified:
2410 @smallexample
2411 @group
2412 int f()
2413 @{
2414   int i = i;
2415   return i;
2416 @}
2417 @end group
2418 @end smallexample
2419
2420 @item -Wimplicit-int
2421 @opindex Wimplicit-int
2422 Warn when a declaration does not specify a type.
2423 This warning is enabled by @option{-Wall}.
2424
2425 @item -Wimplicit-function-declaration
2426 @itemx -Werror-implicit-function-declaration
2427 @opindex Wimplicit-function-declaration
2428 @opindex Werror-implicit-function-declaration
2429 Give a warning (or error) whenever a function is used before being
2430 declared.  The form @option{-Wno-error-implicit-function-declaration}
2431 is not supported.
2432 This warning is enabled by @option{-Wall} (as a warning, not an error).
2433
2434 @item -Wimplicit
2435 @opindex Wimplicit
2436 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2437 This warning is enabled by @option{-Wall}.
2438
2439 @item -Wmain
2440 @opindex Wmain
2441 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2442 function with external linkage, returning int, taking either zero
2443 arguments, two, or three arguments of appropriate types.
2444 This warning is enabled by @option{-Wall}.
2445
2446 @item -Wmissing-braces
2447 @opindex Wmissing-braces
2448 Warn if an aggregate or union initializer is not fully bracketed.  In
2449 the following example, the initializer for @samp{a} is not fully
2450 bracketed, but that for @samp{b} is fully bracketed.
2451
2452 @smallexample
2453 int a[2][2] = @{ 0, 1, 2, 3 @};
2454 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2455 @end smallexample
2456
2457 This warning is enabled by @option{-Wall}.
2458
2459 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2460 @opindex Wmissing-include-dirs
2461 Warn if a user-supplied include directory does not exist.
2462
2463 @item -Wparentheses
2464 @opindex Wparentheses
2465 Warn if parentheses are omitted in certain contexts, such
2466 as when there is an assignment in a context where a truth value
2467 is expected, or when operators are nested whose precedence people
2468 often get confused about.  Only the warning for an assignment used as
2469 a truth value is supported when compiling C++; the other warnings are
2470 only supported when compiling C@.
2471
2472 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2473 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2474 interpretation from that of ordinary mathematical notation.
2475
2476 Also warn about constructions where there may be confusion to which
2477 @code{if} statement an @code{else} branch belongs.  Here is an example of
2478 such a case:
2479
2480 @smallexample
2481 @group
2482 @{
2483   if (a)
2484     if (b)
2485       foo ();
2486   else
2487     bar ();
2488 @}
2489 @end group
2490 @end smallexample
2491
2492 In C, every @code{else} branch belongs to the innermost possible @code{if}
2493 statement, which in this example is @code{if (b)}.  This is often not
2494 what the programmer expected, as illustrated in the above example by
2495 indentation the programmer chose.  When there is the potential for this
2496 confusion, GCC will issue a warning when this flag is specified.
2497 To eliminate the warning, add explicit braces around the innermost
2498 @code{if} statement so there is no way the @code{else} could belong to
2499 the enclosing @code{if}.  The resulting code would look like this:
2500
2501 @smallexample
2502 @group
2503 @{
2504   if (a)
2505     @{
2506       if (b)
2507         foo ();
2508       else
2509         bar ();
2510     @}
2511 @}
2512 @end group
2513 @end smallexample
2514
2515 This warning is enabled by @option{-Wall}.
2516
2517 @item -Wsequence-point
2518 @opindex Wsequence-point
2519 Warn about code that may have undefined semantics because of violations
2520 of sequence point rules in the C standard.
2521
2522 The C standard defines the order in which expressions in a C program are
2523 evaluated in terms of @dfn{sequence points}, which represent a partial
2524 ordering between the execution of parts of the program: those executed
2525 before the sequence point, and those executed after it.  These occur
2526 after the evaluation of a full expression (one which is not part of a
2527 larger expression), after the evaluation of the first operand of a
2528 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2529 function is called (but after the evaluation of its arguments and the
2530 expression denoting the called function), and in certain other places.
2531 Other than as expressed by the sequence point rules, the order of
2532 evaluation of subexpressions of an expression is not specified.  All
2533 these rules describe only a partial order rather than a total order,
2534 since, for example, if two functions are called within one expression
2535 with no sequence point between them, the order in which the functions
2536 are called is not specified.  However, the standards committee have
2537 ruled that function calls do not overlap.
2538
2539 It is not specified when between sequence points modifications to the
2540 values of objects take effect.  Programs whose behavior depends on this
2541 have undefined behavior; the C standard specifies that ``Between the
2542 previous and next sequence point an object shall have its stored value
2543 modified at most once by the evaluation of an expression.  Furthermore,
2544 the prior value shall be read only to determine the value to be
2545 stored.''.  If a program breaks these rules, the results on any
2546 particular implementation are entirely unpredictable.
2547
2548 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2549 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2550 diagnosed by this option, and it may give an occasional false positive
2551 result, but in general it has been found fairly effective at detecting
2552 this sort of problem in programs.
2553
2554 The present implementation of this option only works for C programs.  A
2555 future implementation may also work for C++ programs.
2556
2557 The C standard is worded confusingly, therefore there is some debate
2558 over the precise meaning of the sequence point rules in subtle cases.
2559 Links to discussions of the problem, including proposed formal
2560 definitions, may be found on the GCC readings page, at
2561 @w{@uref{http://gcc.gnu.org/readings.html}}.
2562
2563 This warning is enabled by @option{-Wall}.
2564
2565 @item -Wreturn-type
2566 @opindex Wreturn-type
2567 Warn whenever a function is defined with a return-type that defaults to
2568 @code{int}.  Also warn about any @code{return} statement with no
2569 return-value in a function whose return-type is not @code{void}.
2570
2571 For C, also warn if the return type of a function has a type qualifier
2572 such as @code{const}.  Such a type qualifier has no effect, since the
2573 value returned by a function is not an lvalue.  ISO C prohibits
2574 qualified @code{void} return types on function definitions, so such
2575 return types always receive a warning even without this option.
2576
2577 For C++, a function without return type always produces a diagnostic
2578 message, even when @option{-Wno-return-type} is specified.  The only
2579 exceptions are @samp{main} and functions defined in system headers.
2580
2581 This warning is enabled by @option{-Wall}.
2582
2583 @item -Wswitch
2584 @opindex Wswitch
2585 Warn whenever a @code{switch} statement has an index of enumerated type
2586 and lacks a @code{case} for one or more of the named codes of that
2587 enumeration.  (The presence of a @code{default} label prevents this
2588 warning.)  @code{case} labels outside the enumeration range also
2589 provoke warnings when this option is used.
2590 This warning is enabled by @option{-Wall}.
2591
2592 @item -Wswitch-default
2593 @opindex Wswitch-switch
2594 Warn whenever a @code{switch} statement does not have a @code{default}
2595 case.
2596
2597 @item -Wswitch-enum
2598 @opindex Wswitch-enum
2599 Warn whenever a @code{switch} statement has an index of enumerated type
2600 and lacks a @code{case} for one or more of the named codes of that
2601 enumeration.  @code{case} labels outside the enumeration range also
2602 provoke warnings when this option is used.
2603
2604 @item -Wtrigraphs
2605 @opindex Wtrigraphs
2606 Warn if any trigraphs are encountered that might change the meaning of
2607 the program (trigraphs within comments are not warned about).
2608 This warning is enabled by @option{-Wall}.
2609
2610 @item -Wunused-function
2611 @opindex Wunused-function
2612 Warn whenever a static function is declared but not defined or a
2613 non-inline static function is unused.
2614 This warning is enabled by @option{-Wall}.
2615
2616 @item -Wunused-label
2617 @opindex Wunused-label
2618 Warn whenever a label is declared but not used.
2619 This warning is enabled by @option{-Wall}.
2620
2621 To suppress this warning use the @samp{unused} attribute
2622 (@pxref{Variable Attributes}).
2623
2624 @item -Wunused-parameter
2625 @opindex Wunused-parameter
2626 Warn whenever a function parameter is unused aside from its declaration.
2627
2628 To suppress this warning use the @samp{unused} attribute
2629 (@pxref{Variable Attributes}).
2630
2631 @item -Wunused-variable
2632 @opindex Wunused-variable
2633 Warn whenever a local variable or non-constant static variable is unused
2634 aside from its declaration
2635 This warning is enabled by @option{-Wall}.
2636
2637 To suppress this warning use the @samp{unused} attribute
2638 (@pxref{Variable Attributes}).
2639
2640 @item -Wunused-value
2641 @opindex Wunused-value
2642 Warn whenever a statement computes a result that is explicitly not used.
2643 This warning is enabled by @option{-Wall}.
2644
2645 To suppress this warning cast the expression to @samp{void}.
2646
2647 @item -Wunused
2648 @opindex Wunused
2649 All the above @option{-Wunused} options combined.
2650
2651 In order to get a warning about an unused function parameter, you must
2652 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2653 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2654
2655 @item -Wuninitialized
2656 @opindex Wuninitialized
2657 Warn if an automatic variable is used without first being initialized or
2658 if a variable may be clobbered by a @code{setjmp} call.
2659
2660 These warnings are possible only in optimizing compilation,
2661 because they require data flow information that is computed only
2662 when optimizing.  If you don't specify @option{-O}, you simply won't
2663 get these warnings.
2664
2665 If you want to warn about code which uses the uninitialized value of the
2666 variable in its own initializer, use the @option{-Winit-self} option.
2667
2668 These warnings occur for individual uninitialized or clobbered
2669 elements of structure, union or array variables as well as for
2670 variables which are uninitialized or clobbered as a whole.  They do
2671 not occur for variables or elements declared @code{volatile}.  Because
2672 these warnings depend on optimization, the exact variables or elements
2673 for which there are warnings will depend on the precise optimization
2674 options and version of GCC used.
2675
2676 Note that there may be no warning about a variable that is used only
2677 to compute a value that itself is never used, because such
2678 computations may be deleted by data flow analysis before the warnings
2679 are printed.
2680
2681 These warnings are made optional because GCC is not smart
2682 enough to see all the reasons why the code might be correct
2683 despite appearing to have an error.  Here is one example of how
2684 this can happen:
2685
2686 @smallexample
2687 @group
2688 @{
2689   int x;
2690   switch (y)
2691     @{
2692     case 1: x = 1;
2693       break;
2694     case 2: x = 4;
2695       break;
2696     case 3: x = 5;
2697     @}
2698   foo (x);
2699 @}
2700 @end group
2701 @end smallexample
2702
2703 @noindent
2704 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2705 always initialized, but GCC doesn't know this.  Here is
2706 another common case:
2707
2708 @smallexample
2709 @{
2710   int save_y;
2711   if (change_y) save_y = y, y = new_y;
2712   @dots{}
2713   if (change_y) y = save_y;
2714 @}
2715 @end smallexample
2716
2717 @noindent
2718 This has no bug because @code{save_y} is used only if it is set.
2719
2720 @cindex @code{longjmp} warnings
2721 This option also warns when a non-volatile automatic variable might be
2722 changed by a call to @code{longjmp}.  These warnings as well are possible
2723 only in optimizing compilation.
2724
2725 The compiler sees only the calls to @code{setjmp}.  It cannot know
2726 where @code{longjmp} will be called; in fact, a signal handler could
2727 call it at any point in the code.  As a result, you may get a warning
2728 even when there is in fact no problem because @code{longjmp} cannot
2729 in fact be called at the place which would cause a problem.
2730
2731 Some spurious warnings can be avoided if you declare all the functions
2732 you use that never return as @code{noreturn}.  @xref{Function
2733 Attributes}.
2734
2735 This warning is enabled by @option{-Wall}.
2736
2737 @item -Wunknown-pragmas
2738 @opindex Wunknown-pragmas
2739 @cindex warning for unknown pragmas
2740 @cindex unknown pragmas, warning
2741 @cindex pragmas, warning of unknown
2742 Warn when a #pragma directive is encountered which is not understood by
2743 GCC@.  If this command line option is used, warnings will even be issued
2744 for unknown pragmas in system header files.  This is not the case if
2745 the warnings were only enabled by the @option{-Wall} command line option.
2746
2747 @item -Wno-pragmas
2748 @opindex Wno-pragmas
2749 @opindex Wpragmas
2750 Do not warn about misuses of pragmas, such as incorrect parameters,
2751 invalid syntax, or conflicts between pragmas.  See also
2752 @samp{-Wunknown-pragmas}.
2753
2754 @item -Wstrict-aliasing
2755 @opindex Wstrict-aliasing
2756 This option is only active when @option{-fstrict-aliasing} is active.
2757 It warns about code which might break the strict aliasing rules that the
2758 compiler is using for optimization.  The warning does not catch all
2759 cases, but does attempt to catch the more common pitfalls.  It is
2760 included in @option{-Wall}.
2761
2762 @item -Wstrict-aliasing=2
2763 @opindex Wstrict-aliasing=2
2764 This option is only active when @option{-fstrict-aliasing} is active.
2765 It warns about code which might break the strict aliasing rules that the
2766 compiler is using for optimization.  This warning catches more cases than
2767 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2768 cases that are safe.
2769
2770 @item -Wall
2771 @opindex Wall
2772 All of the above @samp{-W} options combined.  This enables all the
2773 warnings about constructions that some users consider questionable, and
2774 that are easy to avoid (or modify to prevent the warning), even in
2775 conjunction with macros.  This also enables some language-specific
2776 warnings described in @ref{C++ Dialect Options} and
2777 @ref{Objective-C and Objective-C++ Dialect Options}.
2778 @end table
2779
2780 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2781 Some of them warn about constructions that users generally do not
2782 consider questionable, but which occasionally you might wish to check
2783 for; others warn about constructions that are necessary or hard to avoid
2784 in some cases, and there is no simple way to modify the code to suppress
2785 the warning.
2786
2787 @table @gcctabopt
2788 @item -Wextra
2789 @opindex W
2790 @opindex Wextra
2791 (This option used to be called @option{-W}.  The older name is still
2792 supported, but the newer name is more descriptive.)  Print extra warning
2793 messages for these events:
2794
2795 @itemize @bullet
2796 @item
2797 A function can return either with or without a value.  (Falling
2798 off the end of the function body is considered returning without
2799 a value.)  For example, this function would evoke such a
2800 warning:
2801
2802 @smallexample
2803 @group
2804 foo (a)
2805 @{
2806   if (a > 0)
2807     return a;
2808 @}
2809 @end group
2810 @end smallexample
2811
2812 @item
2813 An expression-statement or the left-hand side of a comma expression
2814 contains no side effects.
2815 To suppress the warning, cast the unused expression to void.
2816 For example, an expression such as @samp{x[i,j]} will cause a warning,
2817 but @samp{x[(void)i,j]} will not.
2818
2819 @item
2820 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2821
2822 @item
2823 Storage-class specifiers like @code{static} are not the first things in
2824 a declaration.  According to the C Standard, this usage is obsolescent.
2825
2826 @item
2827 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2828 arguments.
2829
2830 @item
2831 A comparison between signed and unsigned values could produce an
2832 incorrect result when the signed value is converted to unsigned.
2833 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2834
2835 @item
2836 An aggregate has an initializer which does not initialize all members.
2837 This warning can be independently controlled by
2838 @option{-Wmissing-field-initializers}.
2839
2840 @item
2841 A function parameter is declared without a type specifier in K&R-style
2842 functions:
2843
2844 @smallexample
2845 void foo(bar) @{ @}
2846 @end smallexample
2847
2848 @item
2849 An empty body occurs in an @samp{if} or @samp{else} statement.
2850
2851 @item
2852 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2853 @samp{>}, or @samp{>=}.
2854
2855 @item
2856 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2857
2858 @item
2859 Any of several floating-point events that often indicate errors, such as
2860 overflow, underflow, loss of precision, etc.
2861
2862 @item @r{(C++ only)}
2863 An enumerator and a non-enumerator both appear in a conditional expression.
2864
2865 @item @r{(C++ only)}
2866 A non-static reference or non-static @samp{const} member appears in a
2867 class without constructors.
2868
2869 @item @r{(C++ only)}
2870 Ambiguous virtual bases.
2871
2872 @item @r{(C++ only)}
2873 Subscripting an array which has been declared @samp{register}.
2874
2875 @item @r{(C++ only)}
2876 Taking the address of a variable which has been declared @samp{register}.
2877
2878 @item @r{(C++ only)}
2879 A base class is not initialized in a derived class' copy constructor.
2880 @end itemize
2881
2882 @item -Wno-div-by-zero
2883 @opindex Wno-div-by-zero
2884 @opindex Wdiv-by-zero
2885 Do not warn about compile-time integer division by zero.  Floating point
2886 division by zero is not warned about, as it can be a legitimate way of
2887 obtaining infinities and NaNs.
2888
2889 @item -Wsystem-headers
2890 @opindex Wsystem-headers
2891 @cindex warnings from system headers
2892 @cindex system headers, warnings from
2893 Print warning messages for constructs found in system header files.
2894 Warnings from system headers are normally suppressed, on the assumption
2895 that they usually do not indicate real problems and would only make the
2896 compiler output harder to read.  Using this command line option tells
2897 GCC to emit warnings from system headers as if they occurred in user
2898 code.  However, note that using @option{-Wall} in conjunction with this
2899 option will @emph{not} warn about unknown pragmas in system
2900 headers---for that, @option{-Wunknown-pragmas} must also be used.
2901
2902 @item -Wfloat-equal
2903 @opindex Wfloat-equal
2904 Warn if floating point values are used in equality comparisons.
2905
2906 The idea behind this is that sometimes it is convenient (for the
2907 programmer) to consider floating-point values as approximations to
2908 infinitely precise real numbers.  If you are doing this, then you need
2909 to compute (by analyzing the code, or in some other way) the maximum or
2910 likely maximum error that the computation introduces, and allow for it
2911 when performing comparisons (and when producing output, but that's a
2912 different problem).  In particular, instead of testing for equality, you
2913 would check to see whether the two values have ranges that overlap; and
2914 this is done with the relational operators, so equality comparisons are
2915 probably mistaken.
2916
2917 @item -Wtraditional @r{(C only)}
2918 @opindex Wtraditional
2919 Warn about certain constructs that behave differently in traditional and
2920 ISO C@.  Also warn about ISO C constructs that have no traditional C
2921 equivalent, and/or problematic constructs which should be avoided.
2922
2923 @itemize @bullet
2924 @item
2925 Macro parameters that appear within string literals in the macro body.
2926 In traditional C macro replacement takes place within string literals,
2927 but does not in ISO C@.
2928
2929 @item
2930 In traditional C, some preprocessor directives did not exist.
2931 Traditional preprocessors would only consider a line to be a directive
2932 if the @samp{#} appeared in column 1 on the line.  Therefore
2933 @option{-Wtraditional} warns about directives that traditional C
2934 understands but would ignore because the @samp{#} does not appear as the
2935 first character on the line.  It also suggests you hide directives like
2936 @samp{#pragma} not understood by traditional C by indenting them.  Some
2937 traditional implementations would not recognize @samp{#elif}, so it
2938 suggests avoiding it altogether.
2939
2940 @item
2941 A function-like macro that appears without arguments.
2942
2943 @item
2944 The unary plus operator.
2945
2946 @item
2947 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2948 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2949 constants.)  Note, these suffixes appear in macros defined in the system
2950 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2951 Use of these macros in user code might normally lead to spurious
2952 warnings, however GCC's integrated preprocessor has enough context to
2953 avoid warning in these cases.
2954
2955 @item
2956 A function declared external in one block and then used after the end of
2957 the block.
2958
2959 @item
2960 A @code{switch} statement has an operand of type @code{long}.
2961
2962 @item
2963 A non-@code{static} function declaration follows a @code{static} one.
2964 This construct is not accepted by some traditional C compilers.
2965
2966 @item
2967 The ISO type of an integer constant has a different width or
2968 signedness from its traditional type.  This warning is only issued if
2969 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2970 typically represent bit patterns, are not warned about.
2971
2972 @item
2973 Usage of ISO string concatenation is detected.
2974
2975 @item
2976 Initialization of automatic aggregates.
2977
2978 @item
2979 Identifier conflicts with labels.  Traditional C lacks a separate
2980 namespace for labels.
2981
2982 @item
2983 Initialization of unions.  If the initializer is zero, the warning is
2984 omitted.  This is done under the assumption that the zero initializer in
2985 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2986 initializer warnings and relies on default initialization to zero in the
2987 traditional C case.
2988
2989 @item
2990 Conversions by prototypes between fixed/floating point values and vice
2991 versa.  The absence of these prototypes when compiling with traditional
2992 C would cause serious problems.  This is a subset of the possible
2993 conversion warnings, for the full set use @option{-Wconversion}.
2994
2995 @item
2996 Use of ISO C style function definitions.  This warning intentionally is
2997 @emph{not} issued for prototype declarations or variadic functions
2998 because these ISO C features will appear in your code when using
2999 libiberty's traditional C compatibility macros, @code{PARAMS} and
3000 @code{VPARAMS}.  This warning is also bypassed for nested functions
3001 because that feature is already a GCC extension and thus not relevant to
3002 traditional C compatibility.
3003 @end itemize
3004
3005 @item -Wdeclaration-after-statement @r{(C only)}
3006 @opindex Wdeclaration-after-statement
3007 Warn when a declaration is found after a statement in a block.  This
3008 construct, known from C++, was introduced with ISO C99 and is by default
3009 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3010 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3011
3012 @item -Wundef
3013 @opindex Wundef
3014 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3015
3016 @item -Wno-endif-labels
3017 @opindex Wno-endif-labels
3018 @opindex Wendif-labels
3019 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3020
3021 @item -Wshadow
3022 @opindex Wshadow
3023 Warn whenever a local variable shadows another local variable, parameter or
3024 global variable or whenever a built-in function is shadowed.
3025
3026 @item -Wlarger-than-@var{len}
3027 @opindex Wlarger-than
3028 Warn whenever an object of larger than @var{len} bytes is defined.
3029
3030 @item -Wunsafe-loop-optimizations
3031 @opindex Wunsafe-loop-optimizations
3032 Warn if the loop cannot be optimized because the compiler could not
3033 assume anything on the bounds of the loop indices.  With
3034 @option{-funsafe-loop-optimizations} warn if the compiler made
3035 such assumptions.
3036
3037 @item -Wpointer-arith
3038 @opindex Wpointer-arith
3039 Warn about anything that depends on the ``size of'' a function type or
3040 of @code{void}.  GNU C assigns these types a size of 1, for
3041 convenience in calculations with @code{void *} pointers and pointers
3042 to functions.
3043
3044 @item -Wbad-function-cast @r{(C only)}
3045 @opindex Wbad-function-cast
3046 Warn whenever a function call is cast to a non-matching type.
3047 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3048
3049 @item -Wc++-compat
3050 Warn about ISO C constructs that are outside of the common subset of
3051 ISO C and ISO C++, e.g.@: request for implicit conversion from
3052 @code{void *} to a pointer to non-@code{void} type.
3053
3054 @item -Wcast-qual
3055 @opindex Wcast-qual
3056 Warn whenever a pointer is cast so as to remove a type qualifier from
3057 the target type.  For example, warn if a @code{const char *} is cast
3058 to an ordinary @code{char *}.
3059
3060 @item -Wcast-align
3061 @opindex Wcast-align
3062 Warn whenever a pointer is cast such that the required alignment of the
3063 target is increased.  For example, warn if a @code{char *} is cast to
3064 an @code{int *} on machines where integers can only be accessed at
3065 two- or four-byte boundaries.
3066
3067 @item -Wwrite-strings
3068 @opindex Wwrite-strings
3069 When compiling C, give string constants the type @code{const
3070 char[@var{length}]} so that
3071 copying the address of one into a non-@code{const} @code{char *}
3072 pointer will get a warning; when compiling C++, warn about the
3073 deprecated conversion from string constants to @code{char *}.
3074 These warnings will help you find at
3075 compile time code that can try to write into a string constant, but
3076 only if you have been very careful about using @code{const} in
3077 declarations and prototypes.  Otherwise, it will just be a nuisance;
3078 this is why we did not make @option{-Wall} request these warnings.
3079
3080 @item -Wconversion
3081 @opindex Wconversion
3082 Warn if a prototype causes a type conversion that is different from what
3083 would happen to the same argument in the absence of a prototype.  This
3084 includes conversions of fixed point to floating and vice versa, and
3085 conversions changing the width or signedness of a fixed point argument
3086 except when the same as the default promotion.
3087
3088 Also, warn if a negative integer constant expression is implicitly
3089 converted to an unsigned type.  For example, warn about the assignment
3090 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3091 casts like @code{(unsigned) -1}.
3092
3093 @item -Wsign-compare
3094 @opindex Wsign-compare
3095 @cindex warning for comparison of signed and unsigned values
3096 @cindex comparison of signed and unsigned values, warning
3097 @cindex signed and unsigned values, comparison warning
3098 Warn when a comparison between signed and unsigned values could produce
3099 an incorrect result when the signed value is converted to unsigned.
3100 This warning is also enabled by @option{-Wextra}; to get the other warnings
3101 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3102
3103 @item -Waggregate-return
3104 @opindex Waggregate-return
3105 Warn if any functions that return structures or unions are defined or
3106 called.  (In languages where you can return an array, this also elicits
3107 a warning.)
3108
3109 @item -Wno-attributes
3110 @opindex Wno-attributes
3111 @opindex Wattributes
3112 Do not warn if an unexpected @code{__attribute__} is used, such as
3113 unrecognized attributes, function attributes applied to variables,
3114 etc.  This will not stop errors for incorrect use of supported
3115 attributes.
3116
3117 @item -Wstrict-prototypes @r{(C only)}
3118 @opindex Wstrict-prototypes
3119 Warn if a function is declared or defined without specifying the
3120 argument types.  (An old-style function definition is permitted without
3121 a warning if preceded by a declaration which specifies the argument
3122 types.)
3123
3124 @item -Wold-style-definition @r{(C only)}
3125 @opindex Wold-style-definition
3126 Warn if an old-style function definition is used.  A warning is given
3127 even if there is a previous prototype.
3128
3129 @item -Wmissing-prototypes @r{(C only)}
3130 @opindex Wmissing-prototypes
3131 Warn if a global function is defined without a previous prototype
3132 declaration.  This warning is issued even if the definition itself
3133 provides a prototype.  The aim is to detect global functions that fail
3134 to be declared in header files.
3135
3136 @item -Wmissing-declarations @r{(C only)}
3137 @opindex Wmissing-declarations
3138 Warn if a global function is defined without a previous declaration.
3139 Do so even if the definition itself provides a prototype.
3140 Use this option to detect global functions that are not declared in
3141 header files.
3142
3143 @item -Wmissing-field-initializers
3144 @opindex Wmissing-field-initializers
3145 @opindex W
3146 @opindex Wextra
3147 Warn if a structure's initializer has some fields missing.  For
3148 example, the following code would cause such a warning, because
3149 @code{x.h} is implicitly zero:
3150
3151 @smallexample
3152 struct s @{ int f, g, h; @};
3153 struct s x = @{ 3, 4 @};
3154 @end smallexample
3155
3156 This option does not warn about designated initializers, so the following
3157 modification would not trigger a warning:
3158
3159 @smallexample
3160 struct s @{ int f, g, h; @};
3161 struct s x = @{ .f = 3, .g = 4 @};
3162 @end smallexample
3163
3164 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3165 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3166
3167 @item -Wmissing-noreturn
3168 @opindex Wmissing-noreturn
3169 Warn about functions which might be candidates for attribute @code{noreturn}.
3170 Note these are only possible candidates, not absolute ones.  Care should
3171 be taken to manually verify functions actually do not ever return before
3172 adding the @code{noreturn} attribute, otherwise subtle code generation
3173 bugs could be introduced.  You will not get a warning for @code{main} in
3174 hosted C environments.
3175
3176 @item -Wmissing-format-attribute
3177 @opindex Wmissing-format-attribute
3178 @opindex Wformat
3179 Warn about function pointers which might be candidates for @code{format}
3180 attributes.  Note these are only possible candidates, not absolute ones.
3181 GCC will guess that function pointers with @code{format} attributes that
3182 are used in assignment, initialization, parameter passing or return
3183 statements should have a corresponding @code{format} attribute in the
3184 resulting type.  I.e.@: the left-hand side of the assignment or
3185 initialization, the type of the parameter variable, or the return type
3186 of the containing function respectively should also have a @code{format}
3187 attribute to avoid the warning.
3188
3189 GCC will also warn about function definitions which might be
3190 candidates for @code{format} attributes.  Again, these are only
3191 possible candidates.  GCC will guess that @code{format} attributes
3192 might be appropriate for any function that calls a function like
3193 @code{vprintf} or @code{vscanf}, but this might not always be the
3194 case, and some functions for which @code{format} attributes are
3195 appropriate may not be detected.
3196
3197 @item -Wno-multichar
3198 @opindex Wno-multichar
3199 @opindex Wmultichar
3200 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3201 Usually they indicate a typo in the user's code, as they have
3202 implementation-defined values, and should not be used in portable code.
3203
3204 @item -Wnormalized=<none|id|nfc|nfkc>
3205 @opindex Wnormalized
3206 @cindex NFC
3207 @cindex NFKC
3208 @cindex character set, input normalization
3209 In ISO C and ISO C++, two identifiers are different if they are
3210 different sequences of characters.  However, sometimes when characters
3211 outside the basic ASCII character set are used, you can have two
3212 different character sequences that look the same.  To avoid confusion,
3213 the ISO 10646 standard sets out some @dfn{normalization rules} which
3214 when applied ensure that two sequences that look the same are turned into
3215 the same sequence.  GCC can warn you if you are using identifiers which
3216 have not been normalized; this option controls that warning.
3217
3218 There are four levels of warning that GCC supports.  The default is
3219 @option{-Wnormalized=nfc}, which warns about any identifier which is
3220 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3221 recommended form for most uses.
3222
3223 Unfortunately, there are some characters which ISO C and ISO C++ allow
3224 in identifiers that when turned into NFC aren't allowable as
3225 identifiers.  That is, there's no way to use these symbols in portable
3226 ISO C or C++ and have all your identifiers in NFC.
3227 @option{-Wnormalized=id} suppresses the warning for these characters.
3228 It is hoped that future versions of the standards involved will correct
3229 this, which is why this option is not the default.
3230
3231 You can switch the warning off for all characters by writing
3232 @option{-Wnormalized=none}.  You would only want to do this if you
3233 were using some other normalization scheme (like ``D''), because
3234 otherwise you can easily create bugs that are literally impossible to see.
3235
3236 Some characters in ISO 10646 have distinct meanings but look identical
3237 in some fonts or display methodologies, especially once formatting has
3238 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3239 LETTER N'', will display just like a regular @code{n} which has been
3240 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3241 normalisation scheme to convert all these into a standard form as
3242 well, and GCC will warn if your code is not in NFKC if you use
3243 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3244 about every identifier that contains the letter O because it might be
3245 confused with the digit 0, and so is not the default, but may be
3246 useful as a local coding convention if the programming environment is
3247 unable to be fixed to display these characters distinctly.
3248
3249 @item -Wno-deprecated-declarations
3250 @opindex Wno-deprecated-declarations
3251 Do not warn about uses of functions, variables, and types marked as
3252 deprecated by using the @code{deprecated} attribute.
3253 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3254 @pxref{Type Attributes}.)
3255
3256 @item -Wpacked
3257 @opindex Wpacked
3258 Warn if a structure is given the packed attribute, but the packed
3259 attribute has no effect on the layout or size of the structure.
3260 Such structures may be mis-aligned for little benefit.  For
3261 instance, in this code, the variable @code{f.x} in @code{struct bar}
3262 will be misaligned even though @code{struct bar} does not itself
3263 have the packed attribute:
3264
3265 @smallexample
3266 @group
3267 struct foo @{
3268   int x;
3269   char a, b, c, d;
3270 @} __attribute__((packed));
3271 struct bar @{
3272   char z;
3273   struct foo f;
3274 @};
3275 @end group
3276 @end smallexample
3277
3278 @item -Wpadded
3279 @opindex Wpadded
3280 Warn if padding is included in a structure, either to align an element
3281 of the structure or to align the whole structure.  Sometimes when this
3282 happens it is possible to rearrange the fields of the structure to
3283 reduce the padding and so make the structure smaller.
3284
3285 @item -Wredundant-decls
3286 @opindex Wredundant-decls
3287 Warn if anything is declared more than once in the same scope, even in
3288 cases where multiple declaration is valid and changes nothing.
3289
3290 @item -Wnested-externs @r{(C only)}
3291 @opindex Wnested-externs
3292 Warn if an @code{extern} declaration is encountered within a function.
3293
3294 @item -Wunreachable-code
3295 @opindex Wunreachable-code
3296 Warn if the compiler detects that code will never be executed.
3297
3298 This option is intended to warn when the compiler detects that at
3299 least a whole line of source code will never be executed, because
3300 some condition is never satisfied or because it is after a
3301 procedure that never returns.
3302
3303 It is possible for this option to produce a warning even though there
3304 are circumstances under which part of the affected line can be executed,
3305 so care should be taken when removing apparently-unreachable code.
3306
3307 For instance, when a function is inlined, a warning may mean that the
3308 line is unreachable in only one inlined copy of the function.
3309
3310 This option is not made part of @option{-Wall} because in a debugging
3311 version of a program there is often substantial code which checks
3312 correct functioning of the program and is, hopefully, unreachable
3313 because the program does work.  Another common use of unreachable
3314 code is to provide behavior which is selectable at compile-time.
3315
3316 @item -Winline
3317 @opindex Winline
3318 Warn if a function can not be inlined and it was declared as inline.
3319 Even with this option, the compiler will not warn about failures to
3320 inline functions declared in system headers.
3321
3322 The compiler uses a variety of heuristics to determine whether or not
3323 to inline a function.  For example, the compiler takes into account
3324 the size of the function being inlined and the amount of inlining
3325 that has already been done in the current function.  Therefore,
3326 seemingly insignificant changes in the source program can cause the
3327 warnings produced by @option{-Winline} to appear or disappear.
3328
3329 @item -Wno-invalid-offsetof @r{(C++ only)}
3330 @opindex Wno-invalid-offsetof
3331 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3332 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3333 to a non-POD type is undefined.  In existing C++ implementations,
3334 however, @samp{offsetof} typically gives meaningful results even when
3335 applied to certain kinds of non-POD types. (Such as a simple
3336 @samp{struct} that fails to be a POD type only by virtue of having a
3337 constructor.)  This flag is for users who are aware that they are
3338 writing nonportable code and who have deliberately chosen to ignore the
3339 warning about it.
3340
3341 The restrictions on @samp{offsetof} may be relaxed in a future version
3342 of the C++ standard.
3343
3344 @item -Wno-int-to-pointer-cast @r{(C only)}
3345 @opindex Wno-int-to-pointer-cast
3346 Suppress warnings from casts to pointer type of an integer of a
3347 different size.
3348
3349 @item -Wno-pointer-to-int-cast @r{(C only)}
3350 @opindex Wno-pointer-to-int-cast
3351 Suppress warnings from casts from a pointer to an integer type of a
3352 different size.
3353
3354 @item -Winvalid-pch
3355 @opindex Winvalid-pch
3356 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3357 the search path but can't be used.
3358
3359 @item -Wlong-long
3360 @opindex Wlong-long
3361 @opindex Wno-long-long
3362 Warn if @samp{long long} type is used.  This is default.  To inhibit
3363 the warning messages, use @option{-Wno-long-long}.  Flags
3364 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3365 only when @option{-pedantic} flag is used.
3366
3367 @item -Wvariadic-macros
3368 @opindex Wvariadic-macros
3369 @opindex Wno-variadic-macros
3370 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3371 alternate syntax when in pedantic ISO C99 mode.  This is default.
3372 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3373
3374 @item -Wvolatile-register-var
3375 @opindex Wvolatile-register-var
3376 @opindex Wno-volatile-register-var
3377 Warn if a register variable is declared volatile.  The volatile
3378 modifier does not inhibit all optimizations that may eliminate reads
3379 and/or writes to register variables.
3380
3381 @item -Wdisabled-optimization
3382 @opindex Wdisabled-optimization
3383 Warn if a requested optimization pass is disabled.  This warning does
3384 not generally indicate that there is anything wrong with your code; it
3385 merely indicates that GCC's optimizers were unable to handle the code
3386 effectively.  Often, the problem is that your code is too big or too
3387 complex; GCC will refuse to optimize programs when the optimization
3388 itself is likely to take inordinate amounts of time.
3389
3390 @item -Wno-pointer-sign
3391 @opindex Wno-pointer-sign
3392 Don't warn for pointer argument passing or assignment with different signedness.
3393 Only useful in the negative form since this warning is enabled by default.
3394 This option is only supported for C and Objective-C@.
3395
3396 @item -Werror
3397 @opindex Werror
3398 Make all warnings into errors.
3399
3400 @item -Wstack-protector
3401 This option is only active when @option{-fstack-protector} is active.  It
3402 warns about functions that will not be protected against stack smashing.
3403
3404 @end table
3405
3406 @node Debugging Options
3407 @section Options for Debugging Your Program or GCC
3408 @cindex options, debugging
3409 @cindex debugging information options
3410
3411 GCC has various special options that are used for debugging
3412 either your program or GCC:
3413
3414 @table @gcctabopt
3415 @item -g
3416 @opindex g
3417 Produce debugging information in the operating system's native format
3418 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3419 information.
3420
3421 On most systems that use stabs format, @option{-g} enables use of extra
3422 debugging information that only GDB can use; this extra information
3423 makes debugging work better in GDB but will probably make other debuggers
3424 crash or
3425 refuse to read the program.  If you want to control for certain whether
3426 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3427 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3428
3429 GCC allows you to use @option{-g} with
3430 @option{-O}.  The shortcuts taken by optimized code may occasionally
3431 produce surprising results: some variables you declared may not exist
3432 at all; flow of control may briefly move where you did not expect it;
3433 some statements may not be executed because they compute constant
3434 results or their values were already at hand; some statements may
3435 execute in different places because they were moved out of loops.
3436
3437 Nevertheless it proves possible to debug optimized output.  This makes
3438 it reasonable to use the optimizer for programs that might have bugs.
3439
3440 The following options are useful when GCC is generated with the
3441 capability for more than one debugging format.
3442
3443 @item -ggdb
3444 @opindex ggdb
3445 Produce debugging information for use by GDB@.  This means to use the
3446 most expressive format available (DWARF 2, stabs, or the native format
3447 if neither of those are supported), including GDB extensions if at all
3448 possible.
3449
3450 @item -gstabs
3451 @opindex gstabs
3452 Produce debugging information in stabs format (if that is supported),
3453 without GDB extensions.  This is the format used by DBX on most BSD
3454 systems.  On MIPS, Alpha and System V Release 4 systems this option
3455 produces stabs debugging output which is not understood by DBX or SDB@.
3456 On System V Release 4 systems this option requires the GNU assembler.
3457
3458 @item -feliminate-unused-debug-symbols
3459 @opindex feliminate-unused-debug-symbols
3460 Produce debugging information in stabs format (if that is supported),
3461 for only symbols that are actually used.
3462
3463 @item -gstabs+
3464 @opindex gstabs+
3465 Produce debugging information in stabs format (if that is supported),
3466 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3467 use of these extensions is likely to make other debuggers crash or
3468 refuse to read the program.
3469
3470 @item -gcoff
3471 @opindex gcoff
3472 Produce debugging information in COFF format (if that is supported).
3473 This is the format used by SDB on most System V systems prior to
3474 System V Release 4.
3475
3476 @item -gxcoff
3477 @opindex gxcoff
3478 Produce debugging information in XCOFF format (if that is supported).
3479 This is the format used by the DBX debugger on IBM RS/6000 systems.
3480
3481 @item -gxcoff+
3482 @opindex gxcoff+
3483 Produce debugging information in XCOFF format (if that is supported),
3484 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3485 use of these extensions is likely to make other debuggers crash or
3486 refuse to read the program, and may cause assemblers other than the GNU
3487 assembler (GAS) to fail with an error.
3488
3489 @item -gdwarf-2
3490 @opindex gdwarf-2
3491 Produce debugging information in DWARF version 2 format (if that is
3492 supported).  This is the format used by DBX on IRIX 6.  With this
3493 option, GCC uses features of DWARF version 3 when they are useful;
3494 version 3 is upward compatible with version 2, but may still cause
3495 problems for older debuggers.
3496
3497 @item -gvms
3498 @opindex gvms
3499 Produce debugging information in VMS debug format (if that is
3500 supported).  This is the format used by DEBUG on VMS systems.
3501
3502 @item -g@var{level}
3503 @itemx -ggdb@var{level}
3504 @itemx -gstabs@var{level}
3505 @itemx -gcoff@var{level}
3506 @itemx -gxcoff@var{level}
3507 @itemx -gvms@var{level}
3508 Request debugging information and also use @var{level} to specify how
3509 much information.  The default level is 2.
3510
3511 Level 1 produces minimal information, enough for making backtraces in
3512 parts of the program that you don't plan to debug.  This includes
3513 descriptions of functions and external variables, but no information
3514 about local variables and no line numbers.
3515
3516 Level 3 includes extra information, such as all the macro definitions
3517 present in the program.  Some debuggers support macro expansion when
3518 you use @option{-g3}.
3519
3520 @option{-gdwarf-2} does not accept a concatenated debug level, because
3521 GCC used to support an option @option{-gdwarf} that meant to generate
3522 debug information in version 1 of the DWARF format (which is very
3523 different from version 2), and it would have been too confusing.  That
3524 debug format is long obsolete, but the option cannot be changed now.
3525 Instead use an additional @option{-g@var{level}} option to change the
3526 debug level for DWARF2.
3527
3528 @item -feliminate-dwarf2-dups
3529 @opindex feliminate-dwarf2-dups
3530 Compress DWARF2 debugging information by eliminating duplicated
3531 information about each symbol.  This option only makes sense when
3532 generating DWARF2 debugging information with @option{-gdwarf-2}.
3533
3534 @cindex @command{prof}
3535 @item -p
3536 @opindex p
3537 Generate extra code to write profile information suitable for the
3538 analysis program @command{prof}.  You must use this option when compiling
3539 the source files you want data about, and you must also use it when
3540 linking.
3541
3542 @cindex @command{gprof}
3543 @item -pg
3544 @opindex pg
3545 Generate extra code to write profile information suitable for the
3546 analysis program @command{gprof}.  You must use this option when compiling
3547 the source files you want data about, and you must also use it when
3548 linking.
3549
3550 @item -Q
3551 @opindex Q
3552 Makes the compiler print out each function name as it is compiled, and
3553 print some statistics about each pass when it finishes.
3554
3555 @item -ftime-report
3556 @opindex ftime-report
3557 Makes the compiler print some statistics about the time consumed by each
3558 pass when it finishes.
3559
3560 @item -fmem-report
3561 @opindex fmem-report
3562 Makes the compiler print some statistics about permanent memory
3563 allocation when it finishes.
3564
3565 @item -fprofile-arcs
3566 @opindex fprofile-arcs
3567 Add code so that program flow @dfn{arcs} are instrumented.  During
3568 execution the program records how many times each branch and call is
3569 executed and how many times it is taken or returns.  When the compiled
3570 program exits it saves this data to a file called
3571 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3572 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3573 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3574 @var{auxname} is generated from the name of the output file, if
3575 explicitly specified and it is not the final executable, otherwise it is
3576 the basename of the source file.  In both cases any suffix is removed
3577 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3578 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3579 @xref{Cross-profiling}.
3580
3581 @cindex @command{gcov}
3582 @item --coverage
3583 @opindex coverage
3584
3585 This option is used to compile and link code instrumented for coverage
3586 analysis.  The option is a synonym for @option{-fprofile-arcs}
3587 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3588 linking).  See the documentation for those options for more details.
3589
3590 @itemize
3591
3592 @item
3593 Compile the source files with @option{-fprofile-arcs} plus optimization
3594 and code generation options.  For test coverage analysis, use the
3595 additional @option{-ftest-coverage} option.  You do not need to profile
3596 every source file in a program.
3597
3598 @item
3599 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3600 (the latter implies the former).
3601
3602 @item
3603 Run the program on a representative workload to generate the arc profile
3604 information.  This may be repeated any number of times.  You can run
3605 concurrent instances of your program, and provided that the file system
3606 supports locking, the data files will be correctly updated.  Also
3607 @code{fork} calls are detected and correctly handled (double counting
3608 will not happen).
3609
3610 @item
3611 For profile-directed optimizations, compile the source files again with
3612 the same optimization and code generation options plus
3613 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3614 Control Optimization}).
3615
3616 @item
3617 For test coverage analysis, use @command{gcov} to produce human readable
3618 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3619 @command{gcov} documentation for further information.
3620
3621 @end itemize
3622
3623 With @option{-fprofile-arcs}, for each function of your program GCC
3624 creates a program flow graph, then finds a spanning tree for the graph.
3625 Only arcs that are not on the spanning tree have to be instrumented: the
3626 compiler adds code to count the number of times that these arcs are
3627 executed.  When an arc is the only exit or only entrance to a block, the
3628 instrumentation code can be added to the block; otherwise, a new basic
3629 block must be created to hold the instrumentation code.
3630
3631 @need 2000
3632 @item -ftest-coverage
3633 @opindex ftest-coverage
3634 Produce a notes file that the @command{gcov} code-coverage utility
3635 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3636 show program coverage.  Each source file's note file is called
3637 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3638 above for a description of @var{auxname} and instructions on how to
3639 generate test coverage data.  Coverage data will match the source files
3640 more closely, if you do not optimize.
3641
3642 @item -d@var{letters}
3643 @item -fdump-rtl-@var{pass}
3644 @opindex d
3645 Says to make debugging dumps during compilation at times specified by
3646 @var{letters}.    This is used for debugging the RTL-based passes of the
3647 compiler.  The file names for most of the dumps are made by appending a
3648 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3649 from the name of the output file, if explicitly specified and it is not
3650 an executable, otherwise it is the basename of the source file.
3651
3652 Most debug dumps can be enabled either passing a letter to the @option{-d}
3653 option, or with a long @option{-fdump-rtl} switch; here are the possible
3654 letters for use in @var{letters} and @var{pass}, and their meanings:
3655
3656 @table @gcctabopt
3657 @item -dA
3658 @opindex dA
3659 Annotate the assembler output with miscellaneous debugging information.
3660
3661 @item -db
3662 @itemx -fdump-rtl-bp
3663 @opindex db
3664 @opindex fdump-rtl-bp
3665 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3666
3667 @item -dB
3668 @itemx -fdump-rtl-bbro
3669 @opindex dB
3670 @opindex fdump-rtl-bbro
3671 Dump after block reordering, to @file{@var{file}.30.bbro}.
3672
3673 @item -dc
3674 @itemx -fdump-rtl-combine
3675 @opindex dc
3676 @opindex fdump-rtl-combine
3677 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3678
3679 @item -dC
3680 @itemx -fdump-rtl-ce1
3681 @itemx -fdump-rtl-ce2
3682 @opindex dC
3683 @opindex fdump-rtl-ce1
3684 @opindex fdump-rtl-ce2
3685 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3686 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3687 and @option{-fdump-rtl-ce2} enable dumping after the second if
3688 conversion, to the file @file{@var{file}.18.ce2}.
3689
3690 @item -dd
3691 @itemx -fdump-rtl-btl
3692 @itemx -fdump-rtl-dbr
3693 @opindex dd
3694 @opindex fdump-rtl-btl
3695 @opindex fdump-rtl-dbr
3696 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3697 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3698 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3699 scheduling, to @file{@var{file}.36.dbr}.
3700
3701 @item -dD
3702 @opindex dD
3703 Dump all macro definitions, at the end of preprocessing, in addition to
3704 normal output.
3705
3706 @item -dE
3707 @itemx -fdump-rtl-ce3
3708 @opindex dE
3709 @opindex fdump-rtl-ce3
3710 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3711
3712 @item -df
3713 @itemx -fdump-rtl-cfg
3714 @itemx -fdump-rtl-life
3715 @opindex df
3716 @opindex fdump-rtl-cfg
3717 @opindex fdump-rtl-life
3718 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3719 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3720 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3721 to @file{@var{file}.16.life}.
3722
3723 @item -dg
3724 @itemx -fdump-rtl-greg
3725 @opindex dg
3726 @opindex fdump-rtl-greg
3727 Dump after global register allocation, to @file{@var{file}.23.greg}.
3728
3729 @item -dG
3730 @itemx -fdump-rtl-gcse
3731 @itemx -fdump-rtl-bypass
3732 @opindex dG
3733 @opindex fdump-rtl-gcse
3734 @opindex fdump-rtl-bypass
3735 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3736 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3737 enable dumping after jump bypassing and control flow optimizations, to
3738 @file{@var{file}.07.bypass}.
3739
3740 @item -dh
3741 @itemx -fdump-rtl-eh
3742 @opindex dh
3743 @opindex fdump-rtl-eh
3744 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3745
3746 @item -di
3747 @itemx -fdump-rtl-sibling
3748 @opindex di
3749 @opindex fdump-rtl-sibling
3750 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3751
3752 @item -dj
3753 @itemx -fdump-rtl-jump
3754 @opindex dj
3755 @opindex fdump-rtl-jump
3756 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3757
3758 @item -dk
3759 @itemx -fdump-rtl-stack
3760 @opindex dk
3761 @opindex fdump-rtl-stack
3762 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3763
3764 @item -dl
3765 @itemx -fdump-rtl-lreg
3766 @opindex dl
3767 @opindex fdump-rtl-lreg
3768 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3769
3770 @item -dL
3771 @itemx -fdump-rtl-loop
3772 @itemx -fdump-rtl-loop2
3773 @opindex dL
3774 @opindex fdump-rtl-loop
3775 @opindex fdump-rtl-loop2
3776 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3777 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3778 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3779 @file{@var{file}.13.loop2}.
3780
3781 @item -dm
3782 @itemx -fdump-rtl-sms
3783 @opindex dm
3784 @opindex fdump-rtl-sms
3785 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3786
3787 @item -dM
3788 @itemx -fdump-rtl-mach
3789 @opindex dM
3790 @opindex fdump-rtl-mach
3791 Dump after performing the machine dependent reorganization pass, to
3792 @file{@var{file}.35.mach}.
3793
3794 @item -dn
3795 @itemx -fdump-rtl-rnreg
3796 @opindex dn
3797 @opindex fdump-rtl-rnreg
3798 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3799
3800 @item -dN
3801 @itemx -fdump-rtl-regmove
3802 @opindex dN
3803 @opindex fdump-rtl-regmove
3804 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3805
3806 @item -do
3807 @itemx -fdump-rtl-postreload
3808 @opindex do
3809 @opindex fdump-rtl-postreload
3810 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3811
3812 @item -dr
3813 @itemx -fdump-rtl-expand
3814 @opindex dr
3815 @opindex fdump-rtl-expand
3816 Dump after RTL generation, to @file{@var{file}.00.expand}.
3817
3818 @item -dR
3819 @itemx -fdump-rtl-sched2
3820 @opindex dR
3821 @opindex fdump-rtl-sched2
3822 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3823
3824 @item -ds
3825 @itemx -fdump-rtl-cse
3826 @opindex ds
3827 @opindex fdump-rtl-cse
3828 Dump after CSE (including the jump optimization that sometimes follows
3829 CSE), to @file{@var{file}.04.cse}.
3830
3831 @item -dS
3832 @itemx -fdump-rtl-sched
3833 @opindex dS
3834 @opindex fdump-rtl-sched
3835 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3836
3837 @item -dt
3838 @itemx -fdump-rtl-cse2
3839 @opindex dt
3840 @opindex fdump-rtl-cse2
3841 Dump after the second CSE pass (including the jump optimization that
3842 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3843
3844 @item -dT
3845 @itemx -fdump-rtl-tracer
3846 @opindex dT
3847 @opindex fdump-rtl-tracer
3848 Dump after running tracer, to @file{@var{file}.12.tracer}.
3849
3850 @item -dV
3851 @itemx -fdump-rtl-vpt
3852 @itemx -fdump-rtl-vartrack
3853 @opindex dV
3854 @opindex fdump-rtl-vpt
3855 @opindex fdump-rtl-vartrack
3856 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3857 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3858 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3859 to @file{@var{file}.34.vartrack}.
3860
3861 @item -dw
3862 @itemx -fdump-rtl-flow2
3863 @opindex dw
3864 @opindex fdump-rtl-flow2
3865 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3866
3867 @item -dz
3868 @itemx -fdump-rtl-peephole2
3869 @opindex dz
3870 @opindex fdump-rtl-peephole2
3871 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3872
3873 @item -dZ
3874 @itemx -fdump-rtl-web
3875 @opindex dZ
3876 @opindex fdump-rtl-web
3877 Dump after live range splitting, to @file{@var{file}.14.web}.
3878
3879 @item -da
3880 @itemx -fdump-rtl-all
3881 @opindex da
3882 @opindex fdump-rtl-all
3883 Produce all the dumps listed above.
3884
3885 @item -dH
3886 @opindex dH
3887 Produce a core dump whenever an error occurs.
3888
3889 @item -dm
3890 @opindex dm
3891 Print statistics on memory usage, at the end of the run, to
3892 standard error.
3893
3894 @item -dp
3895 @opindex dp
3896 Annotate the assembler output with a comment indicating which
3897 pattern and alternative was used.  The length of each instruction is
3898 also printed.
3899
3900 @item -dP
3901 @opindex dP
3902 Dump the RTL in the assembler output as a comment before each instruction.
3903 Also turns on @option{-dp} annotation.
3904
3905 @item -dv
3906 @opindex dv
3907 For each of the other indicated dump files (either with @option{-d} or
3908 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3909 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3910
3911 @item -dx
3912 @opindex dx
3913 Just generate RTL for a function instead of compiling it.  Usually used
3914 with @samp{r} (@option{-fdump-rtl-expand}).
3915
3916 @item -dy
3917 @opindex dy
3918 Dump debugging information during parsing, to standard error.
3919 @end table
3920
3921 @item -fdump-unnumbered
3922 @opindex fdump-unnumbered
3923 When doing debugging dumps (see @option{-d} option above), suppress instruction
3924 numbers and line number note output.  This makes it more feasible to
3925 use diff on debugging dumps for compiler invocations with different
3926 options, in particular with and without @option{-g}.
3927
3928 @item -fdump-translation-unit @r{(C++ only)}
3929 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3930 @opindex fdump-translation-unit
3931 Dump a representation of the tree structure for the entire translation
3932 unit to a file.  The file name is made by appending @file{.tu} to the
3933 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3934 controls the details of the dump as described for the
3935 @option{-fdump-tree} options.
3936
3937 @item -fdump-class-hierarchy @r{(C++ only)}
3938 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3939 @opindex fdump-class-hierarchy
3940 Dump a representation of each class's hierarchy and virtual function
3941 table layout to a file.  The file name is made by appending @file{.class}
3942 to the source file name.  If the @samp{-@var{options}} form is used,
3943 @var{options} controls the details of the dump as described for the
3944 @option{-fdump-tree} options.
3945
3946 @item -fdump-ipa-@var{switch}
3947 @opindex fdump-ipa
3948 Control the dumping at various stages of inter-procedural analysis
3949 language tree to a file.  The file name is generated by appending a switch
3950 specific suffix to the source file name.  The following dumps are possible:
3951
3952 @table @samp
3953 @item all
3954 Enables all inter-procedural analysis dumps; currently the only produced
3955 dump is the @samp{cgraph} dump.
3956
3957 @item cgraph
3958 Dumps information about call-graph optimization, unused function removal,
3959 and inlining decisions.
3960 @end table
3961
3962 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3963 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3964 @opindex fdump-tree
3965 Control the dumping at various stages of processing the intermediate
3966 language tree to a file.  The file name is generated by appending a switch
3967 specific suffix to the source file name.  If the @samp{-@var{options}}
3968 form is used, @var{options} is a list of @samp{-} separated options that
3969 control the details of the dump.  Not all options are applicable to all
3970 dumps, those which are not meaningful will be ignored.  The following
3971 options are available
3972
3973 @table @samp
3974 @item address
3975 Print the address of each node.  Usually this is not meaningful as it
3976 changes according to the environment and source file.  Its primary use
3977 is for tying up a dump file with a debug environment.
3978 @item slim
3979 Inhibit dumping of members of a scope or body of a function merely
3980 because that scope has been reached.  Only dump such items when they
3981 are directly reachable by some other path.  When dumping pretty-printed
3982 trees, this option inhibits dumping the bodies of control structures.
3983 @item raw
3984 Print a raw representation of the tree.  By default, trees are
3985 pretty-printed into a C-like representation.
3986 @item details
3987 Enable more detailed dumps (not honored by every dump option).
3988 @item stats
3989 Enable dumping various statistics about the pass (not honored by every dump
3990 option).
3991 @item blocks
3992 Enable showing basic block boundaries (disabled in raw dumps).
3993 @item vops
3994 Enable showing virtual operands for every statement.
3995 @item lineno
3996 Enable showing line numbers for statements.
3997 @item uid
3998 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3999 @item all
4000 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4001 @end table
4002
4003 The following tree dumps are possible:
4004 @table @samp
4005
4006 @item original
4007 Dump before any tree based optimization, to @file{@var{file}.original}.
4008
4009 @item optimized
4010 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4011
4012 @item inlined
4013 Dump after function inlining, to @file{@var{file}.inlined}.
4014
4015 @item gimple
4016 @opindex fdump-tree-gimple
4017 Dump each function before and after the gimplification pass to a file.  The
4018 file name is made by appending @file{.gimple} to the source file name.
4019
4020 @item cfg
4021 @opindex fdump-tree-cfg
4022 Dump the control flow graph of each function to a file.  The file name is
4023 made by appending @file{.cfg} to the source file name.
4024
4025 @item vcg
4026 @opindex fdump-tree-vcg
4027 Dump the control flow graph of each function to a file in VCG format.  The
4028 file name is made by appending @file{.vcg} to the source file name.  Note
4029 that if the file contains more than one function, the generated file cannot
4030 be used directly by VCG@.  You will need to cut and paste each function's
4031 graph into its own separate file first.
4032
4033 @item ch
4034 @opindex fdump-tree-ch
4035 Dump each function after copying loop headers.  The file name is made by
4036 appending @file{.ch} to the source file name.
4037
4038 @item ssa
4039 @opindex fdump-tree-ssa
4040 Dump SSA related information to a file.  The file name is made by appending
4041 @file{.ssa} to the source file name.
4042
4043 @item salias
4044 @opindex fdump-tree-salias
4045 Dump structure aliasing variable information to a file.  This file name
4046 is made by appending @file{.salias} to the source file name.
4047
4048 @item alias
4049 @opindex fdump-tree-alias
4050 Dump aliasing information for each function.  The file name is made by
4051 appending @file{.alias} to the source file name.
4052
4053 @item ccp
4054 @opindex fdump-tree-ccp
4055 Dump each function after CCP@.  The file name is made by appending
4056 @file{.ccp} to the source file name.
4057
4058 @item storeccp
4059 @opindex fdump-tree-storeccp
4060 Dump each function after STORE-CCP.  The file name is made by appending
4061 @file{.storeccp} to the source file name.
4062
4063 @item pre
4064 @opindex fdump-tree-pre
4065 Dump trees after partial redundancy elimination.  The file name is made
4066 by appending @file{.pre} to the source file name.
4067
4068 @item fre
4069 @opindex fdump-tree-fre
4070 Dump trees after full redundancy elimination.  The file name is made
4071 by appending @file{.fre} to the source file name.
4072
4073 @item copyprop
4074 @opindex fdump-tree-copyprop
4075 Dump trees after copy propagation.  The file name is made
4076 by appending @file{.copyprop} to the source file name.
4077
4078 @item store_copyprop
4079 @opindex fdump-tree-store_copyprop
4080 Dump trees after store copy-propagation.  The file name is made
4081 by appending @file{.store_copyprop} to the source file name.
4082
4083 @item dce
4084 @opindex fdump-tree-dce
4085 Dump each function after dead code elimination.  The file name is made by
4086 appending @file{.dce} to the source file name.
4087
4088 @item mudflap
4089 @opindex fdump-tree-mudflap
4090 Dump each function after adding mudflap instrumentation.  The file name is
4091 made by appending @file{.mudflap} to the source file name.
4092
4093 @item sra
4094 @opindex fdump-tree-sra
4095 Dump each function after performing scalar replacement of aggregates.  The
4096 file name is made by appending @file{.sra} to the source file name.
4097
4098 @item sink
4099 @opindex fdump-tree-sink
4100 Dump each function after performing code sinking.  The file name is made
4101 by appending @file{.sink} to the source file name. 
4102
4103 @item dom
4104 @opindex fdump-tree-dom
4105 Dump each function after applying dominator tree optimizations.  The file
4106 name is made by appending @file{.dom} to the source file name.
4107
4108 @item dse
4109 @opindex fdump-tree-dse
4110 Dump each function after applying dead store elimination.  The file
4111 name is made by appending @file{.dse} to the source file name.
4112
4113 @item phiopt
4114 @opindex fdump-tree-phiopt
4115 Dump each function after optimizing PHI nodes into straightline code.  The file
4116 name is made by appending @file{.phiopt} to the source file name.
4117
4118 @item forwprop
4119 @opindex fdump-tree-forwprop
4120 Dump each function after forward propagating single use variables.  The file
4121 name is made by appending @file{.forwprop} to the source file name.
4122
4123 @item copyrename
4124 @opindex fdump-tree-copyrename
4125 Dump each function after applying the copy rename optimization.  The file
4126 name is made by appending @file{.copyrename} to the source file name.
4127
4128 @item nrv
4129 @opindex fdump-tree-nrv
4130 Dump each function after applying the named return value optimization on
4131 generic trees.  The file name is made by appending @file{.nrv} to the source
4132 file name.
4133
4134 @item vect
4135 @opindex fdump-tree-vect
4136 Dump each function after applying vectorization of loops.  The file name is
4137 made by appending @file{.vect} to the source file name.
4138
4139 @item vrp
4140 @opindex fdump-tree-vrp
4141 Dump each function after Value Range Propagation (VRP).  The file name
4142 is made by appending @file{.vrp} to the source file name.
4143
4144 @item all
4145 @opindex fdump-tree-all
4146 Enable all the available tree dumps with the flags provided in this option.
4147 @end table
4148
4149 @item -ftree-vectorizer-verbose=@var{n}
4150 @opindex ftree-vectorizer-verbose
4151 This option controls the amount of debugging output the vectorizer prints.
4152 This information is written to standard error, unless @option{-fdump-tree-all}
4153 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4154 usual dump listing file, @file{.vect}.
4155
4156 @item -frandom-seed=@var{string}
4157 @opindex frandom-string
4158 This option provides a seed that GCC uses when it would otherwise use
4159 random numbers.  It is used to generate certain symbol names
4160 that have to be different in every compiled file.  It is also used to
4161 place unique stamps in coverage data files and the object files that
4162 produce them.  You can use the @option{-frandom-seed} option to produce
4163 reproducibly identical object files.
4164
4165 The @var{string} should be different for every file you compile.
4166
4167 @item -fsched-verbose=@var{n}
4168 @opindex fsched-verbose
4169 On targets that use instruction scheduling, this option controls the
4170 amount of debugging output the scheduler prints.  This information is
4171 written to standard error, unless @option{-dS} or @option{-dR} is
4172 specified, in which case it is output to the usual dump
4173 listing file, @file{.sched} or @file{.sched2} respectively.  However
4174 for @var{n} greater than nine, the output is always printed to standard
4175 error.
4176
4177 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4178 same information as @option{-dRS}.  For @var{n} greater than one, it
4179 also output basic block probabilities, detailed ready list information
4180 and unit/insn info.  For @var{n} greater than two, it includes RTL
4181 at abort point, control-flow and regions info.  And for @var{n} over
4182 four, @option{-fsched-verbose} also includes dependence info.
4183
4184 @item -save-temps
4185 @opindex save-temps
4186 Store the usual ``temporary'' intermediate files permanently; place them
4187 in the current directory and name them based on the source file.  Thus,
4188 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4189 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4190 preprocessed @file{foo.i} output file even though the compiler now
4191 normally uses an integrated preprocessor.
4192
4193 When used in combination with the @option{-x} command line option,
4194 @option{-save-temps} is sensible enough to avoid over writing an
4195 input source file with the same extension as an intermediate file.
4196 The corresponding intermediate file may be obtained by renaming the
4197 source file before using @option{-save-temps}.
4198
4199 @item -time
4200 @opindex time
4201 Report the CPU time taken by each subprocess in the compilation
4202 sequence.  For C source files, this is the compiler proper and assembler
4203 (plus the linker if linking is done).  The output looks like this:
4204
4205 @smallexample
4206 # cc1 0.12 0.01
4207 # as 0.00 0.01
4208 @end smallexample
4209
4210 The first number on each line is the ``user time'', that is time spent
4211 executing the program itself.  The second number is ``system time'',
4212 time spent executing operating system routines on behalf of the program.
4213 Both numbers are in seconds.
4214
4215 @item -fvar-tracking
4216 @opindex fvar-tracking
4217 Run variable tracking pass.  It computes where variables are stored at each
4218 position in code.  Better debugging information is then generated
4219 (if the debugging information format supports this information).
4220
4221 It is enabled by default when compiling with optimization (@option{-Os},
4222 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4223 the debug info format supports it.
4224
4225 @item -print-file-name=@var{library}
4226 @opindex print-file-name
4227 Print the full absolute name of the library file @var{library} that
4228 would be used when linking---and don't do anything else.  With this
4229 option, GCC does not compile or link anything; it just prints the
4230 file name.
4231
4232 @item -print-multi-directory
4233 @opindex print-multi-directory
4234 Print the directory name corresponding to the multilib selected by any
4235 other switches present in the command line.  This directory is supposed
4236 to exist in @env{GCC_EXEC_PREFIX}.
4237
4238 @item -print-multi-lib
4239 @opindex print-multi-lib
4240 Print the mapping from multilib directory names to compiler switches
4241 that enable them.  The directory name is separated from the switches by
4242 @samp{;}, and each switch starts with an @samp{@@} instead of the
4243 @samp{-}, without spaces between multiple switches.  This is supposed to
4244 ease shell-processing.
4245
4246 @item -print-prog-name=@var{program}
4247 @opindex print-prog-name
4248 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4249
4250 @item -print-libgcc-file-name
4251 @opindex print-libgcc-file-name
4252 Same as @option{-print-file-name=libgcc.a}.
4253
4254 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4255 but you do want to link with @file{libgcc.a}.  You can do
4256
4257 @smallexample
4258 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4259 @end smallexample
4260
4261 @item -print-search-dirs
4262 @opindex print-search-dirs
4263 Print the name of the configured installation directory and a list of
4264 program and library directories @command{gcc} will search---and don't do anything else.
4265
4266 This is useful when @command{gcc} prints the error message
4267 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4268 To resolve this you either need to put @file{cpp0} and the other compiler
4269 components where @command{gcc} expects to find them, or you can set the environment
4270 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4271 Don't forget the trailing @samp{/}.
4272 @xref{Environment Variables}.
4273
4274 @item -dumpmachine
4275 @opindex dumpmachine
4276 Print the compiler's target machine (for example,
4277 @samp{i686-pc-linux-gnu})---and don't do anything else.
4278
4279 @item -dumpversion
4280 @opindex dumpversion
4281 Print the compiler version (for example, @samp{3.0})---and don't do
4282 anything else.
4283
4284 @item -dumpspecs
4285 @opindex dumpspecs
4286 Print the compiler's built-in specs---and don't do anything else.  (This
4287 is used when GCC itself is being built.)  @xref{Spec Files}.
4288
4289 @item -feliminate-unused-debug-types
4290 @opindex feliminate-unused-debug-types
4291 Normally, when producing DWARF2 output, GCC will emit debugging
4292 information for all types declared in a compilation
4293 unit, regardless of whether or not they are actually used
4294 in that compilation unit.  Sometimes this is useful, such as
4295 if, in the debugger, you want to cast a value to a type that is
4296 not actually used in your program (but is declared).  More often,
4297 however, this results in a significant amount of wasted space.
4298 With this option, GCC will avoid producing debug symbol output
4299 for types that are nowhere used in the source file being compiled.
4300 @end table
4301
4302 @node Optimize Options
4303 @section Options That Control Optimization
4304 @cindex optimize options
4305 @cindex options, optimization
4306
4307 These options control various sorts of optimizations.
4308
4309 Without any optimization option, the compiler's goal is to reduce the
4310 cost of compilation and to make debugging produce the expected
4311 results.  Statements are independent: if you stop the program with a
4312 breakpoint between statements, you can then assign a new value to any
4313 variable or change the program counter to any other statement in the
4314 function and get exactly the results you would expect from the source
4315 code.
4316
4317 Turning on optimization flags makes the compiler attempt to improve
4318 the performance and/or code size at the expense of compilation time
4319 and possibly the ability to debug the program.
4320
4321 The compiler performs optimization based on the knowledge it has of
4322 the program.  Optimization levels @option{-O2} and above, in
4323 particular, enable @emph{unit-at-a-time} mode, which allows the
4324 compiler to consider information gained from later functions in
4325 the file when compiling a function.  Compiling multiple files at
4326 once to a single output file in @emph{unit-at-a-time} mode allows
4327 the compiler to use information gained from all of the files when
4328 compiling each of them.
4329
4330 Not all optimizations are controlled directly by a flag.  Only
4331 optimizations that have a flag are listed.
4332
4333 @table @gcctabopt
4334 @item -O
4335 @itemx -O1
4336 @opindex O
4337 @opindex O1
4338 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4339 more memory for a large function.
4340
4341 With @option{-O}, the compiler tries to reduce code size and execution
4342 time, without performing any optimizations that take a great deal of
4343 compilation time.
4344
4345 @option{-O} turns on the following optimization flags:
4346 @gccoptlist{-fdefer-pop @gol
4347 -fdelayed-branch @gol
4348 -fguess-branch-probability @gol
4349 -fcprop-registers @gol
4350 -floop-optimize @gol
4351 -fif-conversion @gol
4352 -fif-conversion2 @gol
4353 -ftree-ccp @gol
4354 -ftree-dce @gol
4355 -ftree-dominator-opts @gol
4356 -ftree-dse @gol
4357 -ftree-ter @gol
4358 -ftree-lrs @gol
4359 -ftree-sra @gol
4360 -ftree-copyrename @gol
4361 -ftree-fre @gol
4362 -ftree-ch @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 @item -O2
4369 @opindex O2
4370 Optimize even more.  GCC performs nearly all supported optimizations
4371 that do not involve a space-speed tradeoff.  The compiler does not
4372 perform loop unrolling or function inlining when you specify @option{-O2}.
4373 As compared to @option{-O}, this option increases both compilation time
4374 and the performance of the generated code.
4375
4376 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4377 also turns on the following optimization flags:
4378 @gccoptlist{-fthread-jumps @gol
4379 -fcrossjumping @gol
4380 -foptimize-sibling-calls @gol
4381 -fcse-follow-jumps  -fcse-skip-blocks @gol
4382 -fgcse  -fgcse-lm  @gol
4383 -fexpensive-optimizations @gol
4384 -fstrength-reduce @gol
4385 -frerun-cse-after-loop  -frerun-loop-opt @gol
4386 -fcaller-saves @gol
4387 -fpeephole2 @gol
4388 -fschedule-insns  -fschedule-insns2 @gol
4389 -fsched-interblock  -fsched-spec @gol
4390 -fregmove @gol
4391 -fstrict-aliasing @gol
4392 -fdelete-null-pointer-checks @gol
4393 -freorder-blocks  -freorder-functions @gol
4394 -funit-at-a-time @gol
4395 -falign-functions  -falign-jumps @gol
4396 -falign-loops  -falign-labels @gol
4397 -ftree-vrp @gol
4398 -ftree-pre}
4399
4400 Please note the warning under @option{-fgcse} about
4401 invoking @option{-O2} on programs that use computed gotos.
4402
4403 @item -O3
4404 @opindex O3
4405 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4406 @option{-O2} and also turns on the @option{-finline-functions},
4407 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4408
4409 @item -O0
4410 @opindex O0
4411 Do not optimize.  This is the default.
4412
4413 @item -Os
4414 @opindex Os
4415 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4416 do not typically increase code size.  It also performs further
4417 optimizations designed to reduce code size.
4418
4419 @option{-Os} disables the following optimization flags:
4420 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4421 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4422 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4423
4424 If you use multiple @option{-O} options, with or without level numbers,
4425 the last such option is the one that is effective.
4426 @end table
4427
4428 Options of the form @option{-f@var{flag}} specify machine-independent
4429 flags.  Most flags have both positive and negative forms; the negative
4430 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4431 below, only one of the forms is listed---the one you typically will
4432 use.  You can figure out the other form by either removing @samp{no-}
4433 or adding it.
4434
4435 The following options control specific optimizations.  They are either
4436 activated by @option{-O} options or are related to ones that are.  You
4437 can use the following flags in the rare cases when ``fine-tuning'' of
4438 optimizations to be performed is desired.
4439
4440 @table @gcctabopt
4441 @item -fno-default-inline
4442 @opindex fno-default-inline
4443 Do not make member functions inline by default merely because they are
4444 defined inside the class scope (C++ only).  Otherwise, when you specify
4445 @w{@option{-O}}, member functions defined inside class scope are compiled
4446 inline by default; i.e., you don't need to add @samp{inline} in front of
4447 the member function name.
4448
4449 @item -fno-defer-pop
4450 @opindex fno-defer-pop
4451 Always pop the arguments to each function call as soon as that function
4452 returns.  For machines which must pop arguments after a function call,
4453 the compiler normally lets arguments accumulate on the stack for several
4454 function calls and pops them all at once.
4455
4456 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4457
4458 @item -fforce-mem
4459 @opindex fforce-mem
4460 Force memory operands to be copied into registers before doing
4461 arithmetic on them.  This produces better code by making all memory
4462 references potential common subexpressions.  When they are not common
4463 subexpressions, instruction combination should eliminate the separate
4464 register-load. This option is now a nop and will be removed in 4.2.
4465
4466 @item -fforce-addr
4467 @opindex fforce-addr
4468 Force memory address constants to be copied into registers before
4469 doing arithmetic on them.
4470
4471 @item -fomit-frame-pointer
4472 @opindex fomit-frame-pointer
4473 Don't keep the frame pointer in a register for functions that
4474 don't need one.  This avoids the instructions to save, set up and
4475 restore frame pointers; it also makes an extra register available
4476 in many functions.  @strong{It also makes debugging impossible on
4477 some machines.}
4478
4479 On some machines, such as the VAX, this flag has no effect, because
4480 the standard calling sequence automatically handles the frame pointer
4481 and nothing is saved by pretending it doesn't exist.  The
4482 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4483 whether a target machine supports this flag.  @xref{Registers,,Register
4484 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4485
4486 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4487
4488 @item -foptimize-sibling-calls
4489 @opindex foptimize-sibling-calls
4490 Optimize sibling and tail recursive calls.
4491
4492 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4493
4494 @item -fno-inline
4495 @opindex fno-inline
4496 Don't pay attention to the @code{inline} keyword.  Normally this option
4497 is used to keep the compiler from expanding any functions inline.
4498 Note that if you are not optimizing, no functions can be expanded inline.
4499
4500 @item -finline-functions
4501 @opindex finline-functions
4502 Integrate all simple functions into their callers.  The compiler
4503 heuristically decides which functions are simple enough to be worth
4504 integrating in this way.
4505
4506 If all calls to a given function are integrated, and the function is
4507 declared @code{static}, then the function is normally not output as
4508 assembler code in its own right.
4509
4510 Enabled at level @option{-O3}.
4511
4512 @item -finline-functions-called-once
4513 @opindex finline-functions-called-once
4514 Consider all @code{static} functions called once for inlining into their
4515 caller even if they are not marked @code{inline}.  If a call to a given
4516 function is integrated, then the function is not output as assembler code
4517 in its own right.
4518
4519 Enabled if @option{-funit-at-a-time} is enabled.
4520
4521 @item -fearly-inlining
4522 @opindex fearly-inlining
4523 Inline functions marked by @code{always_inline} and functions whose body seems
4524 smaller than the function call overhead early before doing
4525 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4526 makes profiling significantly cheaper and usually inlining faster on programs
4527 having large chains of nested wrapper functions.
4528
4529 Enabled by default.
4530
4531 @item -finline-limit=@var{n}
4532 @opindex finline-limit
4533 By default, GCC limits the size of functions that can be inlined.  This flag
4534 allows the control of this limit for functions that are explicitly marked as
4535 inline (i.e., marked with the inline keyword or defined within the class
4536 definition in c++).  @var{n} is the size of functions that can be inlined in
4537 number of pseudo instructions (not counting parameter handling).  The default
4538 value of @var{n} is 600.
4539 Increasing this value can result in more inlined code at
4540 the cost of compilation time and memory consumption.  Decreasing usually makes
4541 the compilation faster and less code will be inlined (which presumably
4542 means slower programs).  This option is particularly useful for programs that
4543 use inlining heavily such as those based on recursive templates with C++.
4544
4545 Inlining is actually controlled by a number of parameters, which may be
4546 specified individually by using @option{--param @var{name}=@var{value}}.
4547 The @option{-finline-limit=@var{n}} option sets some of these parameters
4548 as follows:
4549
4550 @table @gcctabopt
4551  @item max-inline-insns-single
4552   is set to @var{n}/2.
4553  @item max-inline-insns-auto
4554   is set to @var{n}/2.
4555  @item min-inline-insns
4556   is set to 130 or @var{n}/4, whichever is smaller.
4557  @item max-inline-insns-rtl
4558   is set to @var{n}.
4559 @end table
4560
4561 See below for a documentation of the individual
4562 parameters controlling inlining.
4563
4564 @emph{Note:} pseudo instruction represents, in this particular context, an
4565 abstract measurement of function's size.  In no way does it represent a count
4566 of assembly instructions and as such its exact meaning might change from one
4567 release to an another.
4568
4569 @item -fkeep-inline-functions
4570 @opindex fkeep-inline-functions
4571 In C, emit @code{static} functions that are declared @code{inline}
4572 into the object file, even if the function has been inlined into all
4573 of its callers.  This switch does not affect functions using the
4574 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4575 inline functions into the object file.
4576
4577 @item -fkeep-static-consts
4578 @opindex fkeep-static-consts
4579 Emit variables declared @code{static const} when optimization isn't turned
4580 on, even if the variables aren't referenced.
4581
4582 GCC enables this option by default.  If you want to force the compiler to
4583 check if the variable was referenced, regardless of whether or not
4584 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4585
4586 @item -fmerge-constants
4587 Attempt to merge identical constants (string constants and floating point
4588 constants) across compilation units.
4589
4590 This option is the default for optimized compilation if the assembler and
4591 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4592 behavior.
4593
4594 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4595
4596 @item -fmerge-all-constants
4597 Attempt to merge identical constants and identical variables.
4598
4599 This option implies @option{-fmerge-constants}.  In addition to
4600 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4601 arrays or initialized constant variables with integral or floating point
4602 types.  Languages like C or C++ require each non-automatic variable to
4603 have distinct location, so using this option will result in non-conforming
4604 behavior.
4605
4606 @item -fmodulo-sched
4607 @opindex fmodulo-sched
4608 Perform swing modulo scheduling immediately before the first scheduling
4609 pass.  This pass looks at innermost loops and reorders their
4610 instructions by overlapping different iterations.
4611
4612 @item -fno-branch-count-reg
4613 @opindex fno-branch-count-reg
4614 Do not use ``decrement and branch'' instructions on a count register,
4615 but instead generate a sequence of instructions that decrement a
4616 register, compare it against zero, then branch based upon the result.
4617 This option is only meaningful on architectures that support such
4618 instructions, which include x86, PowerPC, IA-64 and S/390.
4619
4620 The default is @option{-fbranch-count-reg}, enabled when
4621 @option{-fstrength-reduce} is enabled.
4622
4623 @item -fno-function-cse
4624 @opindex fno-function-cse
4625 Do not put function addresses in registers; make each instruction that
4626 calls a constant function contain the function's address explicitly.
4627
4628 This option results in less efficient code, but some strange hacks
4629 that alter the assembler output may be confused by the optimizations
4630 performed when this option is not used.
4631
4632 The default is @option{-ffunction-cse}
4633
4634 @item -fno-zero-initialized-in-bss
4635 @opindex fno-zero-initialized-in-bss
4636 If the target supports a BSS section, GCC by default puts variables that
4637 are initialized to zero into BSS@.  This can save space in the resulting
4638 code.
4639
4640 This option turns off this behavior because some programs explicitly
4641 rely on variables going to the data section.  E.g., so that the
4642 resulting executable can find the beginning of that section and/or make
4643 assumptions based on that.
4644
4645 The default is @option{-fzero-initialized-in-bss}.
4646
4647 @item -fbounds-check
4648 @opindex fbounds-check
4649 For front-ends that support it, generate additional code to check that
4650 indices used to access arrays are within the declared range.  This is
4651 currently only supported by the Java and Fortran front-ends, where
4652 this option defaults to true and false respectively.
4653
4654 @item -fmudflap -fmudflapth -fmudflapir
4655 @opindex fmudflap
4656 @opindex fmudflapth
4657 @opindex fmudflapir
4658 @cindex bounds checking
4659 @cindex mudflap
4660 For front-ends that support it (C and C++), instrument all risky
4661 pointer/array dereferencing operations, some standard library
4662 string/heap functions, and some other associated constructs with
4663 range/validity tests.  Modules so instrumented should be immune to
4664 buffer overflows, invalid heap use, and some other classes of C/C++
4665 programming errors.  The instrumentation relies on a separate runtime
4666 library (@file{libmudflap}), which will be linked into a program if
4667 @option{-fmudflap} is given at link time.  Run-time behavior of the
4668 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4669 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4670 for its options.
4671
4672 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4673 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4674 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4675 instrumentation should ignore pointer reads.  This produces less
4676 instrumentation (and therefore faster execution) and still provides
4677 some protection against outright memory corrupting writes, but allows
4678 erroneously read data to propagate within a program.
4679
4680 @item -fstrength-reduce
4681 @opindex fstrength-reduce
4682 Perform the optimizations of loop strength reduction and
4683 elimination of iteration variables.
4684
4685 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4686
4687 @item -fthread-jumps
4688 @opindex fthread-jumps
4689 Perform optimizations where we check to see if a jump branches to a
4690 location where another comparison subsumed by the first is found.  If
4691 so, the first branch is redirected to either the destination of the
4692 second branch or a point immediately following it, depending on whether
4693 the condition is known to be true or false.
4694
4695 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4696
4697 @item -fcse-follow-jumps
4698 @opindex fcse-follow-jumps
4699 In common subexpression elimination, scan through jump instructions
4700 when the target of the jump is not reached by any other path.  For
4701 example, when CSE encounters an @code{if} statement with an
4702 @code{else} clause, CSE will follow the jump when the condition
4703 tested is false.
4704
4705 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4706
4707 @item -fcse-skip-blocks
4708 @opindex fcse-skip-blocks
4709 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4710 follow jumps which conditionally skip over blocks.  When CSE
4711 encounters a simple @code{if} statement with no else clause,
4712 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4713 body of the @code{if}.
4714
4715 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4716
4717 @item -frerun-cse-after-loop
4718 @opindex frerun-cse-after-loop
4719 Re-run common subexpression elimination after loop optimizations has been
4720 performed.
4721
4722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4723
4724 @item -frerun-loop-opt
4725 @opindex frerun-loop-opt
4726 Run the loop optimizer twice.
4727
4728 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4729
4730 @item -fgcse
4731 @opindex fgcse
4732 Perform a global common subexpression elimination pass.
4733 This pass also performs global constant and copy propagation.
4734
4735 @emph{Note:} When compiling a program using computed gotos, a GCC
4736 extension, you may get better runtime performance if you disable
4737 the global common subexpression elimination pass by adding
4738 @option{-fno-gcse} to the command line.
4739
4740 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4741
4742 @item -fgcse-lm
4743 @opindex fgcse-lm
4744 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4745 attempt to move loads which are only killed by stores into themselves.  This
4746 allows a loop containing a load/store sequence to be changed to a load outside
4747 the loop, and a copy/store within the loop.
4748
4749 Enabled by default when gcse is enabled.
4750
4751 @item -fgcse-sm
4752 @opindex fgcse-sm
4753 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4754 global common subexpression elimination.  This pass will attempt to move
4755 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4756 loops containing a load/store sequence can be changed to a load before
4757 the loop and a store after the loop.
4758
4759 Not enabled at any optimization level.
4760
4761 @item -fgcse-las
4762 @opindex fgcse-las
4763 When @option{-fgcse-las} is enabled, the global common subexpression
4764 elimination pass eliminates redundant loads that come after stores to the
4765 same memory location (both partial and full redundancies).
4766
4767 Not enabled at any optimization level.
4768
4769 @item -fgcse-after-reload
4770 @opindex fgcse-after-reload
4771 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4772 pass is performed after reload.  The purpose of this pass is to cleanup
4773 redundant spilling.
4774
4775 @item -floop-optimize
4776 @opindex floop-optimize
4777 Perform loop optimizations: move constant expressions out of loops, simplify
4778 exit test conditions and optionally do strength-reduction as well.
4779
4780 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4781
4782 @item -floop-optimize2
4783 @opindex floop-optimize2
4784 Perform loop optimizations using the new loop optimizer.  The optimizations
4785 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4786 by separate flags.
4787
4788 @item -funsafe-loop-optimizations
4789 @opindex funsafe-loop-optimizations
4790 If given, the loop optimizer will assume that loop indices do not
4791 overflow, and that the loops with nontrivial exit condition are not
4792 infinite.  This enables a wider range of loop optimizations even if
4793 the loop optimizer itself cannot prove that these assumptions are valid.
4794 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4795 if it finds this kind of loop.
4796
4797 @item -fcrossjumping
4798 @opindex crossjumping
4799 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4800 resulting code may or may not perform better than without cross-jumping.
4801
4802 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4803
4804 @item -fif-conversion
4805 @opindex if-conversion
4806 Attempt to transform conditional jumps into branch-less equivalents.  This
4807 include use of conditional moves, min, max, set flags and abs instructions, and
4808 some tricks doable by standard arithmetics.  The use of conditional execution
4809 on chips where it is available is controlled by @code{if-conversion2}.
4810
4811 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4812
4813 @item -fif-conversion2
4814 @opindex if-conversion2
4815 Use conditional execution (where available) to transform conditional jumps into
4816 branch-less equivalents.
4817
4818 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4819
4820 @item -fdelete-null-pointer-checks
4821 @opindex fdelete-null-pointer-checks
4822 Use global dataflow analysis to identify and eliminate useless checks
4823 for null pointers.  The compiler assumes that dereferencing a null
4824 pointer would have halted the program.  If a pointer is checked after
4825 it has already been dereferenced, it cannot be null.
4826
4827 In some environments, this assumption is not true, and programs can
4828 safely dereference null pointers.  Use
4829 @option{-fno-delete-null-pointer-checks} to disable this optimization
4830 for programs which depend on that behavior.
4831
4832 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4833
4834 @item -fexpensive-optimizations
4835 @opindex fexpensive-optimizations
4836 Perform a number of minor optimizations that are relatively expensive.
4837
4838 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4839
4840 @item -foptimize-register-move
4841 @itemx -fregmove
4842 @opindex foptimize-register-move
4843 @opindex fregmove
4844 Attempt to reassign register numbers in move instructions and as
4845 operands of other simple instructions in order to maximize the amount of
4846 register tying.  This is especially helpful on machines with two-operand
4847 instructions.
4848
4849 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4850 optimization.
4851
4852 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4853
4854 @item -fdelayed-branch
4855 @opindex fdelayed-branch
4856 If supported for the target machine, attempt to reorder instructions
4857 to exploit instruction slots available after delayed branch
4858 instructions.
4859
4860 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4861
4862 @item -fschedule-insns
4863 @opindex fschedule-insns
4864 If supported for the target machine, attempt to reorder instructions to
4865 eliminate execution stalls due to required data being unavailable.  This
4866 helps machines that have slow floating point or memory load instructions
4867 by allowing other instructions to be issued until the result of the load
4868 or floating point instruction is required.
4869
4870 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4871
4872 @item -fschedule-insns2
4873 @opindex fschedule-insns2
4874 Similar to @option{-fschedule-insns}, but requests an additional pass of
4875 instruction scheduling after register allocation has been done.  This is
4876 especially useful on machines with a relatively small number of
4877 registers and where memory load instructions take more than one cycle.
4878
4879 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4880
4881 @item -fno-sched-interblock
4882 @opindex fno-sched-interblock
4883 Don't schedule instructions across basic blocks.  This is normally
4884 enabled by default when scheduling before register allocation, i.e.@:
4885 with @option{-fschedule-insns} or at @option{-O2} or higher.
4886
4887 @item -fno-sched-spec
4888 @opindex fno-sched-spec
4889 Don't allow speculative motion of non-load instructions.  This is normally
4890 enabled by default when scheduling before register allocation, i.e.@:
4891 with @option{-fschedule-insns} or at @option{-O2} or higher.
4892
4893 @item -fsched-spec-load
4894 @opindex fsched-spec-load
4895 Allow speculative motion of some load instructions.  This only makes
4896 sense when scheduling before register allocation, i.e.@: with
4897 @option{-fschedule-insns} or at @option{-O2} or higher.
4898
4899 @item -fsched-spec-load-dangerous
4900 @opindex fsched-spec-load-dangerous
4901 Allow speculative motion of more load instructions.  This only makes
4902 sense when scheduling before register allocation, i.e.@: with
4903 @option{-fschedule-insns} or at @option{-O2} or higher.
4904
4905 @item -fsched-stalled-insns=@var{n}
4906 @opindex fsched-stalled-insns
4907 Define how many insns (if any) can be moved prematurely from the queue
4908 of stalled insns into the ready list, during the second scheduling pass.
4909
4910 @item -fsched-stalled-insns-dep=@var{n}
4911 @opindex fsched-stalled-insns-dep
4912 Define how many insn groups (cycles) will be examined for a dependency
4913 on a stalled insn that is candidate for premature removal from the queue
4914 of stalled insns.  Has an effect only during the second scheduling pass,
4915 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4916
4917 @item -fsched2-use-superblocks
4918 @opindex fsched2-use-superblocks
4919 When scheduling after register allocation, do use superblock scheduling
4920 algorithm.  Superblock scheduling allows motion across basic block boundaries
4921 resulting on faster schedules.  This option is experimental, as not all machine
4922 descriptions used by GCC model the CPU closely enough to avoid unreliable
4923 results from the algorithm.
4924
4925 This only makes sense when scheduling after register allocation, i.e.@: with
4926 @option{-fschedule-insns2} or at @option{-O2} or higher.
4927
4928 @item -fsched2-use-traces
4929 @opindex fsched2-use-traces
4930 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4931 allocation and additionally perform code duplication in order to increase the
4932 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4933 trace formation.
4934
4935 This mode should produce faster but significantly longer programs.  Also
4936 without @option{-fbranch-probabilities} the traces constructed may not
4937 match the reality and hurt the performance.  This only makes
4938 sense when scheduling after register allocation, i.e.@: with
4939 @option{-fschedule-insns2} or at @option{-O2} or higher.
4940
4941 @item -freschedule-modulo-scheduled-loops
4942 @opindex fscheduling-in-modulo-scheduled-loops
4943 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4944 we may want to prevent the later scheduling passes from changing its schedule, we use this
4945 option to control that.
4946
4947 @item -fcaller-saves
4948 @opindex fcaller-saves
4949 Enable values to be allocated in registers that will be clobbered by
4950 function calls, by emitting extra instructions to save and restore the
4951 registers around such calls.  Such allocation is done only when it
4952 seems to result in better code than would otherwise be produced.
4953
4954 This option is always enabled by default on certain machines, usually
4955 those which have no call-preserved registers to use instead.
4956
4957 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4958
4959 @item -ftree-pre
4960 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4961 enabled by default at @option{-O2} and @option{-O3}.
4962
4963 @item -ftree-fre
4964 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4965 between FRE and PRE is that FRE only considers expressions
4966 that are computed on all paths leading to the redundant computation.
4967 This analysis faster than PRE, though it exposes fewer redundancies.
4968 This flag is enabled by default at @option{-O} and higher.
4969
4970 @item -ftree-copy-prop
4971 Perform copy propagation on trees.  This pass eliminates unnecessary
4972 copy operations.  This flag is enabled by default at @option{-O} and
4973 higher.
4974
4975 @item -ftree-store-copy-prop
4976 Perform copy propagation of memory loads and stores.  This pass
4977 eliminates unnecessary copy operations in memory references
4978 (structures, global variables, arrays, etc).  This flag is enabled by
4979 default at @option{-O2} and higher.
4980
4981 @item -ftree-salias
4982 Perform structural alias analysis on trees.  This flag
4983 is enabled by default at @option{-O} and higher.
4984
4985 @item -ftree-sink
4986 Perform forward store motion  on trees.  This flag is
4987 enabled by default at @option{-O} and higher.
4988
4989 @item -ftree-ccp
4990 Perform sparse conditional constant propagation (CCP) on trees.  This
4991 pass only operates on local scalar variables and is enabled by default
4992 at @option{-O} and higher.
4993
4994 @item -ftree-store-ccp
4995 Perform sparse conditional constant propagation (CCP) on trees.  This
4996 pass operates on both local scalar variables and memory stores and
4997 loads (global variables, structures, arrays, etc).  This flag is
4998 enabled by default at @option{-O2} and higher.
4999
5000 @item -ftree-dce
5001 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5002 default at @option{-O} and higher.
5003
5004 @item -ftree-dominator-opts
5005 Perform a variety of simple scalar cleanups (constant/copy
5006 propagation, redundancy elimination, range propagation and expression
5007 simplification) based on a dominator tree traversal.  This also
5008 performs jump threading (to reduce jumps to jumps). This flag is
5009 enabled by default at @option{-O} and higher.
5010
5011 @item -ftree-ch
5012 Perform loop header copying on trees.  This is beneficial since it increases
5013 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5014 is enabled by default at @option{-O} and higher.  It is not enabled
5015 for @option{-Os}, since it usually increases code size.
5016
5017 @item -ftree-loop-optimize
5018 Perform loop optimizations on trees.  This flag is enabled by default
5019 at @option{-O} and higher.
5020
5021 @item -ftree-loop-linear
5022 Perform linear loop transformations on tree.  This flag can improve cache
5023 performance and allow further loop optimizations to take place.
5024
5025 @item -ftree-loop-im
5026 Perform loop invariant motion on trees.  This pass moves only invariants that
5027 would be hard to handle at RTL level (function calls, operations that expand to
5028 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5029 operands of conditions that are invariant out of the loop, so that we can use
5030 just trivial invariantness analysis in loop unswitching.  The pass also includes
5031 store motion.
5032
5033 @item -ftree-loop-ivcanon
5034 Create a canonical counter for number of iterations in the loop for that
5035 determining number of iterations requires complicated analysis.  Later
5036 optimizations then may determine the number easily.  Useful especially
5037 in connection with unrolling.
5038
5039 @item -fivopts
5040 Perform induction variable optimizations (strength reduction, induction
5041 variable merging and induction variable elimination) on trees.
5042
5043 @item -ftree-sra
5044 Perform scalar replacement of aggregates.  This pass replaces structure
5045 references with scalars to prevent committing structures to memory too
5046 early.  This flag is enabled by default at @option{-O} and higher.
5047
5048 @item -ftree-copyrename
5049 Perform copy renaming on trees.  This pass attempts to rename compiler
5050 temporaries to other variables at copy locations, usually resulting in
5051 variable names which more closely resemble the original variables.  This flag
5052 is enabled by default at @option{-O} and higher.
5053
5054 @item -ftree-ter
5055 Perform temporary expression replacement during the SSA->normal phase.  Single
5056 use/single def temporaries are replaced at their use location with their
5057 defining expression.  This results in non-GIMPLE code, but gives the expanders
5058 much more complex trees to work on resulting in better RTL generation.  This is
5059 enabled by default at @option{-O} and higher.
5060
5061 @item -ftree-lrs
5062 Perform live range splitting during the SSA->normal phase.  Distinct live
5063 ranges of a variable are split into unique variables, allowing for better
5064 optimization later.  This is enabled by default at @option{-O} and higher.
5065
5066 @item -ftree-vectorize
5067 Perform loop vectorization on trees.
5068
5069 @item -ftree-vect-loop-version
5070 @opindex ftree-vect-loop-version
5071 Perform loop versioning when doing loop vectorization on trees.  When a loop
5072 appears to be vectorizable except that data alignment or data dependence cannot
5073 be determined at compile time then vectorized and non-vectorized versions of
5074 the loop are generated along with runtime checks for alignment or dependence
5075 to control which version is executed.  This option is enabled by default
5076 except at level @option{-Os} where it is disabled.
5077
5078 @item -ftree-vrp
5079 Perform Value Range Propagation on trees.  This is similar to the
5080 constant propagation pass, but instead of values, ranges of values are
5081 propagated.  This allows the optimizers to remove unnecessary range
5082 checks like array bound checks and null pointer checks.  This is
5083 enabled by default at @option{-O2} and higher.  Null pointer check
5084 elimination is only done if @option{-fdelete-null-pointer-checks} is
5085 enabled.
5086
5087 @item -ftracer
5088 @opindex ftracer
5089 Perform tail duplication to enlarge superblock size.  This transformation
5090 simplifies the control flow of the function allowing other optimizations to do
5091 better job.
5092
5093 @item -funroll-loops
5094 @opindex funroll-loops
5095 Unroll loops whose number of iterations can be determined at compile
5096 time or upon entry to the loop.  @option{-funroll-loops} implies both
5097 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5098 option makes code larger, and may or may not make it run faster.
5099
5100 @item -funroll-all-loops
5101 @opindex funroll-all-loops
5102 Unroll all loops, even if their number of iterations is uncertain when
5103 the loop is entered.  This usually makes programs run more slowly.
5104 @option{-funroll-all-loops} implies the same options as
5105 @option{-funroll-loops},
5106
5107 @item -fsplit-ivs-in-unroller
5108 @opindex -fsplit-ivs-in-unroller
5109 Enables expressing of values of induction variables in later iterations
5110 of the unrolled loop using the value in the first iteration.  This breaks
5111 long dependency chains, thus improving efficiency of the scheduling passes.
5112
5113 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5114 same effect.  However in cases the loop body is more complicated than
5115 a single basic block, this is not reliable.  It also does not work at all
5116 on some of the architectures due to restrictions in the CSE pass.
5117
5118 This optimization is enabled by default.
5119
5120 @item -fvariable-expansion-in-unroller
5121 @opindex -fvariable-expansion-in-unroller
5122 With this option, the compiler will create multiple copies of some
5123 local variables when unrolling a loop which can result in superior code.
5124
5125 @item -fprefetch-loop-arrays
5126 @opindex fprefetch-loop-arrays
5127 If supported by the target machine, generate instructions to prefetch
5128 memory to improve the performance of loops that access large arrays.
5129
5130 These options may generate better or worse code; results are highly
5131 dependent on the structure of loops within the source code.
5132
5133 @item -fno-peephole
5134 @itemx -fno-peephole2
5135 @opindex fno-peephole
5136 @opindex fno-peephole2
5137 Disable any machine-specific peephole optimizations.  The difference
5138 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5139 are implemented in the compiler; some targets use one, some use the
5140 other, a few use both.
5141
5142 @option{-fpeephole} is enabled by default.
5143 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5144
5145 @item -fno-guess-branch-probability
5146 @opindex fno-guess-branch-probability
5147 Do not guess branch probabilities using heuristics.
5148
5149 GCC will use heuristics to guess branch probabilities if they are
5150 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5151 heuristics are based on the control flow graph.  If some branch probabilities
5152 are specified by @samp{__builtin_expect}, then the heuristics will be
5153 used to guess branch probabilities for the rest of the control flow graph,
5154 taking the @samp{__builtin_expect} info into account.  The interactions
5155 between the heuristics and @samp{__builtin_expect} can be complex, and in
5156 some cases, it may be useful to disable the heuristics so that the effects
5157 of @samp{__builtin_expect} are easier to understand.
5158
5159 The default is @option{-fguess-branch-probability} at levels
5160 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5161
5162 @item -freorder-blocks
5163 @opindex freorder-blocks
5164 Reorder basic blocks in the compiled function in order to reduce number of
5165 taken branches and improve code locality.
5166
5167 Enabled at levels @option{-O2}, @option{-O3}.
5168
5169 @item -freorder-blocks-and-partition
5170 @opindex freorder-blocks-and-partition
5171 In addition to reordering basic blocks in the compiled function, in order
5172 to reduce number of taken branches, partitions hot and cold basic blocks
5173 into separate sections of the assembly and .o files, to improve
5174 paging and cache locality performance.
5175
5176 This optimization is automatically turned off in the presence of
5177 exception handling, for linkonce sections, for functions with a user-defined
5178 section attribute and on any architecture that does not support named
5179 sections.
5180
5181 @item -freorder-functions
5182 @opindex freorder-functions
5183 Reorder functions in the object file in order to
5184 improve code locality.  This is implemented by using special
5185 subsections @code{.text.hot} for most frequently executed functions and
5186 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5187 the linker so object file format must support named sections and linker must
5188 place them in a reasonable way.
5189
5190 Also profile feedback must be available in to make this option effective.  See
5191 @option{-fprofile-arcs} for details.
5192
5193 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5194
5195 @item -fstrict-aliasing
5196 @opindex fstrict-aliasing
5197 Allows the compiler to assume the strictest aliasing rules applicable to
5198 the language being compiled.  For C (and C++), this activates
5199 optimizations based on the type of expressions.  In particular, an
5200 object of one type is assumed never to reside at the same address as an
5201 object of a different type, unless the types are almost the same.  For
5202 example, an @code{unsigned int} can alias an @code{int}, but not a
5203 @code{void*} or a @code{double}.  A character type may alias any other
5204 type.
5205
5206 Pay special attention to code like this:
5207 @smallexample
5208 union a_union @{
5209   int i;
5210   double d;
5211 @};
5212
5213 int f() @{
5214   a_union t;
5215   t.d = 3.0;
5216   return t.i;
5217 @}
5218 @end smallexample
5219 The practice of reading from a different union member than the one most
5220 recently written to (called ``type-punning'') is common.  Even with
5221 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5222 is accessed through the union type.  So, the code above will work as
5223 expected.  However, this code might not:
5224 @smallexample
5225 int f() @{
5226   a_union t;
5227   int* ip;
5228   t.d = 3.0;
5229   ip = &t.i;
5230   return *ip;
5231 @}
5232 @end smallexample
5233
5234 Every language that wishes to perform language-specific alias analysis
5235 should define a function that computes, given an @code{tree}
5236 node, an alias set for the node.  Nodes in different alias sets are not
5237 allowed to alias.  For an example, see the C front-end function
5238 @code{c_get_alias_set}.
5239
5240 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5241
5242 @item -falign-functions
5243 @itemx -falign-functions=@var{n}
5244 @opindex falign-functions
5245 Align the start of functions to the next power-of-two greater than
5246 @var{n}, skipping up to @var{n} bytes.  For instance,
5247 @option{-falign-functions=32} aligns functions to the next 32-byte
5248 boundary, but @option{-falign-functions=24} would align to the next
5249 32-byte boundary only if this can be done by skipping 23 bytes or less.
5250
5251 @option{-fno-align-functions} and @option{-falign-functions=1} are
5252 equivalent and mean that functions will not be aligned.
5253
5254 Some assemblers only support this flag when @var{n} is a power of two;
5255 in that case, it is rounded up.
5256
5257 If @var{n} is not specified or is zero, use a machine-dependent default.
5258
5259 Enabled at levels @option{-O2}, @option{-O3}.
5260
5261 @item -falign-labels
5262 @itemx -falign-labels=@var{n}
5263 @opindex falign-labels
5264 Align all branch targets to a power-of-two boundary, skipping up to
5265 @var{n} bytes like @option{-falign-functions}.  This option can easily
5266 make code slower, because it must insert dummy operations for when the
5267 branch target is reached in the usual flow of the code.
5268
5269 @option{-fno-align-labels} and @option{-falign-labels=1} are
5270 equivalent and mean that labels will not be aligned.
5271
5272 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5273 are greater than this value, then their values are used instead.
5274
5275 If @var{n} is not specified or is zero, use a machine-dependent default
5276 which is very likely to be @samp{1}, meaning no alignment.
5277
5278 Enabled at levels @option{-O2}, @option{-O3}.
5279
5280 @item -falign-loops
5281 @itemx -falign-loops=@var{n}
5282 @opindex falign-loops
5283 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5284 like @option{-falign-functions}.  The hope is that the loop will be
5285 executed many times, which will make up for any execution of the dummy
5286 operations.
5287
5288 @option{-fno-align-loops} and @option{-falign-loops=1} are
5289 equivalent and mean that loops will not be aligned.
5290
5291 If @var{n} is not specified or is zero, use a machine-dependent default.
5292
5293 Enabled at levels @option{-O2}, @option{-O3}.
5294
5295 @item -falign-jumps
5296 @itemx -falign-jumps=@var{n}
5297 @opindex falign-jumps
5298 Align branch targets to a power-of-two boundary, for branch targets
5299 where the targets can only be reached by jumping, skipping up to @var{n}
5300 bytes like @option{-falign-functions}.  In this case, no dummy operations
5301 need be executed.
5302
5303 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5304 equivalent and mean that loops will not be aligned.
5305
5306 If @var{n} is not specified or is zero, use a machine-dependent default.
5307
5308 Enabled at levels @option{-O2}, @option{-O3}.
5309
5310 @item -funit-at-a-time
5311 @opindex funit-at-a-time
5312 Parse the whole compilation unit before starting to produce code.
5313 This allows some extra optimizations to take place but consumes
5314 more memory (in general).  There are some compatibility issues
5315 with @emph{unit-at-at-time} mode:
5316 @itemize @bullet
5317 @item
5318 enabling @emph{unit-at-a-time} mode may change the order
5319 in which functions, variables, and top-level @code{asm} statements
5320 are emitted, and will likely break code relying on some particular
5321 ordering.  The majority of such top-level @code{asm} statements,
5322 though, can be replaced by @code{section} attributes.
5323
5324 @item
5325 @emph{unit-at-a-time} mode removes unreferenced static variables
5326 and functions.  This may result in undefined references
5327 when an @code{asm} statement refers directly to variables or functions
5328 that are otherwise unused.  In that case either the variable/function
5329 shall be listed as an operand of the @code{asm} statement operand or,
5330 in the case of top-level @code{asm} statements the attribute @code{used}
5331 shall be used on the declaration.
5332
5333 @item
5334 Static functions now can use non-standard passing conventions that
5335 may break @code{asm} statements calling functions directly.  Again,
5336 attribute @code{used} will prevent this behavior.
5337 @end itemize
5338
5339 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5340 but this scheme may not be supported by future releases of GCC@.
5341
5342 Enabled at levels @option{-O2}, @option{-O3}.
5343
5344 @item -fweb
5345 @opindex fweb
5346 Constructs webs as commonly used for register allocation purposes and assign
5347 each web individual pseudo register.  This allows the register allocation pass
5348 to operate on pseudos directly, but also strengthens several other optimization
5349 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5350 however, make debugging impossible, since variables will no longer stay in a
5351 ``home register''.
5352
5353 Enabled by default with @option{-funroll-loops}.
5354
5355 @item -fwhole-program
5356 @opindex fwhole-program
5357 Assume that the current compilation unit represents whole program being
5358 compiled.  All public functions and variables with the exception of @code{main}
5359 and those merged by attribute @code{externally_visible} become static functions
5360 and in a affect gets more aggressively optimized by interprocedural optimizers.
5361 While this option is equivalent to proper use of @code{static} keyword for
5362 programs consisting of single file, in combination with option
5363 @option{--combine} this flag can be used to compile most of smaller scale C
5364 programs since the functions and variables become local for the whole combined
5365 compilation unit, not for the single source file itself.
5366
5367
5368 @item -fno-cprop-registers
5369 @opindex fno-cprop-registers
5370 After register allocation and post-register allocation instruction splitting,
5371 we perform a copy-propagation pass to try to reduce scheduling dependencies
5372 and occasionally eliminate the copy.
5373
5374 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5375
5376 @item -fprofile-generate
5377 @opindex fprofile-generate
5378
5379 Enable options usually used for instrumenting application to produce
5380 profile useful for later recompilation with profile feedback based
5381 optimization.  You must use @option{-fprofile-generate} both when
5382 compiling and when linking your program.
5383
5384 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5385
5386 @item -fprofile-use
5387 @opindex fprofile-use
5388 Enable profile feedback directed optimizations, and optimizations
5389 generally profitable only with profile feedback available.
5390
5391 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5392 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5393 @code{-fno-loop-optimize}.
5394
5395 @end table
5396
5397 The following options control compiler behavior regarding floating
5398 point arithmetic.  These options trade off between speed and
5399 correctness.  All must be specifically enabled.
5400
5401 @table @gcctabopt
5402 @item -ffloat-store
5403 @opindex ffloat-store
5404 Do not store floating point variables in registers, and inhibit other
5405 options that might change whether a floating point value is taken from a
5406 register or memory.
5407
5408 @cindex floating point precision
5409 This option prevents undesirable excess precision on machines such as
5410 the 68000 where the floating registers (of the 68881) keep more
5411 precision than a @code{double} is supposed to have.  Similarly for the
5412 x86 architecture.  For most programs, the excess precision does only
5413 good, but a few programs rely on the precise definition of IEEE floating
5414 point.  Use @option{-ffloat-store} for such programs, after modifying
5415 them to store all pertinent intermediate computations into variables.
5416
5417 @item -ffast-math
5418 @opindex ffast-math
5419 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5420 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5421 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5422 and @option{fcx-limited-range}.
5423
5424 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5425
5426 This option should never be turned on by any @option{-O} option since
5427 it can result in incorrect output for programs which depend on
5428 an exact implementation of IEEE or ISO rules/specifications for
5429 math functions.
5430
5431 @item -fno-math-errno
5432 @opindex fno-math-errno
5433 Do not set ERRNO after calling math functions that are executed
5434 with a single instruction, e.g., sqrt.  A program that relies on
5435 IEEE exceptions for math error handling may want to use this flag
5436 for speed while maintaining IEEE arithmetic compatibility.
5437
5438 This option should never be turned on by any @option{-O} option since
5439 it can result in incorrect output for programs which depend on
5440 an exact implementation of IEEE or ISO rules/specifications for
5441 math functions.
5442
5443 The default is @option{-fmath-errno}.
5444
5445 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5446 no reason for the compiler to consider the possibility that it might,
5447 and @option{-fno-math-errno} is the default.
5448
5449 @item -funsafe-math-optimizations
5450 @opindex funsafe-math-optimizations
5451 Allow optimizations for floating-point arithmetic that (a) assume
5452 that arguments and results are valid and (b) may violate IEEE or
5453 ANSI standards.  When used at link-time, it may include libraries
5454 or startup files that change the default FPU control word or other
5455 similar optimizations.
5456
5457 This option should never be turned on by any @option{-O} option since
5458 it can result in incorrect output for programs which depend on
5459 an exact implementation of IEEE or ISO rules/specifications for
5460 math functions.
5461
5462 The default is @option{-fno-unsafe-math-optimizations}.
5463
5464 @item -ffinite-math-only
5465 @opindex ffinite-math-only
5466 Allow optimizations for floating-point arithmetic that assume
5467 that arguments and results are not NaNs or +-Infs.
5468
5469 This option should never be turned on by any @option{-O} option since
5470 it can result in incorrect output for programs which depend on
5471 an exact implementation of IEEE or ISO rules/specifications.
5472
5473 The default is @option{-fno-finite-math-only}.
5474
5475 @item -fno-trapping-math
5476 @opindex fno-trapping-math
5477 Compile code assuming that floating-point operations cannot generate
5478 user-visible traps.  These traps include division by zero, overflow,
5479 underflow, inexact result and invalid operation.  This option implies
5480 @option{-fno-signaling-nans}.  Setting this option may allow faster
5481 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5482
5483 This option should never be turned on by any @option{-O} option since
5484 it can result in incorrect output for programs which depend on
5485 an exact implementation of IEEE or ISO rules/specifications for
5486 math functions.
5487
5488 The default is @option{-ftrapping-math}.
5489
5490 @item -frounding-math
5491 @opindex frounding-math
5492 Disable transformations and optimizations that assume default floating
5493 point rounding behavior.  This is round-to-zero for all floating point
5494 to integer conversions, and round-to-nearest for all other arithmetic
5495 truncations.  This option should be specified for programs that change
5496 the FP rounding mode dynamically, or that may be executed with a
5497 non-default rounding mode.  This option disables constant folding of
5498 floating point expressions at compile-time (which may be affected by
5499 rounding mode) and arithmetic transformations that are unsafe in the
5500 presence of sign-dependent rounding modes.
5501
5502 The default is @option{-fno-rounding-math}.
5503
5504 This option is experimental and does not currently guarantee to
5505 disable all GCC optimizations that are affected by rounding mode.
5506 Future versions of GCC may provide finer control of this setting
5507 using C99's @code{FENV_ACCESS} pragma.  This command line option
5508 will be used to specify the default state for @code{FENV_ACCESS}.
5509
5510 @item -fsignaling-nans
5511 @opindex fsignaling-nans
5512 Compile code assuming that IEEE signaling NaNs may generate user-visible
5513 traps during floating-point operations.  Setting this option disables
5514 optimizations that may change the number of exceptions visible with
5515 signaling NaNs.  This option implies @option{-ftrapping-math}.
5516
5517 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5518 be defined.
5519
5520 The default is @option{-fno-signaling-nans}.
5521
5522 This option is experimental and does not currently guarantee to
5523 disable all GCC optimizations that affect signaling NaN behavior.
5524
5525 @item -fsingle-precision-constant
5526 @opindex fsingle-precision-constant
5527 Treat floating point constant as single precision constant instead of
5528 implicitly converting it to double precision constant.
5529
5530 @item -fcx-limited-range
5531 @itemx -fno-cx-limited-range
5532 @opindex fcx-limited-range
5533 @opindex fno-cx-limited-range
5534 When enabled, this option states that a range reduction step is not
5535 needed when performing complex division.  The default is
5536 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5537
5538 This option controls the default setting of the ISO C99 
5539 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5540 all languages.
5541
5542 @end table
5543
5544 The following options control optimizations that may improve
5545 performance, but are not enabled by any @option{-O} options.  This
5546 section includes experimental options that may produce broken code.
5547
5548 @table @gcctabopt
5549 @item -fbranch-probabilities
5550 @opindex fbranch-probabilities
5551 After running a program compiled with @option{-fprofile-arcs}
5552 (@pxref{Debugging Options,, Options for Debugging Your Program or
5553 @command{gcc}}), you can compile it a second time using
5554 @option{-fbranch-probabilities}, to improve optimizations based on
5555 the number of times each branch was taken.  When the program
5556 compiled with @option{-fprofile-arcs} exits it saves arc execution
5557 counts to a file called @file{@var{sourcename}.gcda} for each source
5558 file  The information in this data file is very dependent on the
5559 structure of the generated code, so you must use the same source code
5560 and the same optimization options for both compilations.
5561
5562 With @option{-fbranch-probabilities}, GCC puts a
5563 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5564 These can be used to improve optimization.  Currently, they are only
5565 used in one place: in @file{reorg.c}, instead of guessing which path a
5566 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5567 exactly determine which path is taken more often.
5568
5569 @item -fprofile-values
5570 @opindex fprofile-values
5571 If combined with @option{-fprofile-arcs}, it adds code so that some
5572 data about values of expressions in the program is gathered.
5573
5574 With @option{-fbranch-probabilities}, it reads back the data gathered
5575 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5576 notes to instructions for their later usage in optimizations.
5577
5578 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5579
5580 @item -fvpt
5581 @opindex fvpt
5582 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5583 a code to gather information about values of expressions.
5584
5585 With @option{-fbranch-probabilities}, it reads back the data gathered
5586 and actually performs the optimizations based on them.
5587 Currently the optimizations include specialization of division operation
5588 using the knowledge about the value of the denominator.
5589
5590 @item -frename-registers
5591 @opindex frename-registers
5592 Attempt to avoid false dependencies in scheduled code by making use
5593 of registers left over after register allocation.  This optimization
5594 will most benefit processors with lots of registers.  Depending on the
5595 debug information format adopted by the target, however, it can
5596 make debugging impossible, since variables will no longer stay in
5597 a ``home register''.
5598
5599 Enabled by default with @option{-funroll-loops}.
5600
5601 @item -ftracer
5602 @opindex ftracer
5603 Perform tail duplication to enlarge superblock size.  This transformation
5604 simplifies the control flow of the function allowing other optimizations to do
5605 better job.
5606
5607 Enabled with @option{-fprofile-use}.
5608
5609 @item -funroll-loops
5610 @opindex funroll-loops
5611 Unroll loops whose number of iterations can be determined at compile time or
5612 upon entry to the loop.  @option{-funroll-loops} implies
5613 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5614 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5615 small constant number of iterations).  This option makes code larger, and may
5616 or may not make it run faster.
5617
5618 Enabled with @option{-fprofile-use}.
5619
5620 @item -funroll-all-loops
5621 @opindex funroll-all-loops
5622 Unroll all loops, even if their number of iterations is uncertain when
5623 the loop is entered.  This usually makes programs run more slowly.
5624 @option{-funroll-all-loops} implies the same options as
5625 @option{-funroll-loops}.
5626
5627 @item -fpeel-loops
5628 @opindex fpeel-loops
5629 Peels the loops for that there is enough information that they do not
5630 roll much (from profile feedback).  It also turns on complete loop peeling
5631 (i.e.@: complete removal of loops with small constant number of iterations).
5632
5633 Enabled with @option{-fprofile-use}.
5634
5635 @item -fmove-loop-invariants
5636 @opindex fmove-loop-invariants
5637 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5638 at level @option{-O1}
5639
5640 @item -funswitch-loops
5641 @opindex funswitch-loops
5642 Move branches with loop invariant conditions out of the loop, with duplicates
5643 of the loop on both branches (modified according to result of the condition).
5644
5645 @item -fprefetch-loop-arrays
5646 @opindex fprefetch-loop-arrays
5647 If supported by the target machine, generate instructions to prefetch
5648 memory to improve the performance of loops that access large arrays.
5649
5650 Disabled at level @option{-Os}.
5651
5652 @item -ffunction-sections
5653 @itemx -fdata-sections
5654 @opindex ffunction-sections
5655 @opindex fdata-sections
5656 Place each function or data item into its own section in the output
5657 file if the target supports arbitrary sections.  The name of the
5658 function or the name of the data item determines the section's name
5659 in the output file.
5660
5661 Use these options on systems where the linker can perform optimizations
5662 to improve locality of reference in the instruction space.  Most systems
5663 using the ELF object format and SPARC processors running Solaris 2 have
5664 linkers with such optimizations.  AIX may have these optimizations in
5665 the future.
5666
5667 Only use these options when there are significant benefits from doing
5668 so.  When you specify these options, the assembler and linker will
5669 create larger object and executable files and will also be slower.
5670 You will not be able to use @code{gprof} on all systems if you
5671 specify this option and you may have problems with debugging if
5672 you specify both this option and @option{-g}.
5673
5674 @item -fbranch-target-load-optimize
5675 @opindex fbranch-target-load-optimize
5676 Perform branch target register load optimization before prologue / epilogue
5677 threading.
5678 The use of target registers can typically be exposed only during reload,
5679 thus hoisting loads out of loops and doing inter-block scheduling needs
5680 a separate optimization pass.
5681
5682 @item -fbranch-target-load-optimize2
5683 @opindex fbranch-target-load-optimize2
5684 Perform branch target register load optimization after prologue / epilogue
5685 threading.
5686
5687 @item -fbtr-bb-exclusive
5688 @opindex fbtr-bb-exclusive
5689 When performing branch target register load optimization, don't reuse
5690 branch target registers in within any basic block.
5691
5692 @item -fstack-protector
5693 Emit extra code to check for buffer overflows, such as stack smashing
5694 attacks.  This is done by adding a guard variable to functions with
5695 vulnerable objects.  This includes functions that call alloca, and
5696 functions with buffers larger than 8 bytes.  The guards are initialized
5697 when a function is entered and then checked when the function exits.
5698 If a guard check fails, an error message is printed and the program exits.
5699
5700 @item -fstack-protector-all
5701 Like @option{-fstack-protector} except that all functions are protected.
5702
5703 @item --param @var{name}=@var{value}
5704 @opindex param
5705 In some places, GCC uses various constants to control the amount of
5706 optimization that is done.  For example, GCC will not inline functions
5707 that contain more that a certain number of instructions.  You can
5708 control some of these constants on the command-line using the
5709 @option{--param} option.
5710
5711 The names of specific parameters, and the meaning of the values, are
5712 tied to the internals of the compiler, and are subject to change
5713 without notice in future releases.
5714
5715 In each case, the @var{value} is an integer.  The allowable choices for
5716 @var{name} are given in the following table:
5717
5718 @table @gcctabopt
5719 @item salias-max-implicit-fields
5720 The maximum number of fields in a variable without direct
5721 structure accesses for which structure aliasing will consider trying 
5722 to track each field.  The default is 5
5723
5724 @item sra-max-structure-size
5725 The maximum structure size, in bytes, at which the scalar replacement
5726 of aggregates (SRA) optimization will perform block copies.  The
5727 default value, 0, implies that GCC will select the most appropriate
5728 size itself.
5729
5730 @item sra-field-structure-ratio
5731 The threshold ratio (as a percentage) between instantiated fields and
5732 the complete structure size.  We say that if the ratio of the number
5733 of bytes in instantiated fields to the number of bytes in the complete
5734 structure exceeds this parameter, then block copies are not used.  The
5735 default is 75.
5736
5737 @item max-crossjump-edges
5738 The maximum number of incoming edges to consider for crossjumping.
5739 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5740 the number of edges incoming to each block.  Increasing values mean
5741 more aggressive optimization, making the compile time increase with
5742 probably small improvement in executable size.
5743
5744 @item min-crossjump-insns
5745 The minimum number of instructions which must be matched at the end
5746 of two blocks before crossjumping will be performed on them.  This
5747 value is ignored in the case where all instructions in the block being
5748 crossjumped from are matched.  The default value is 5.
5749
5750 @item max-grow-copy-bb-insns
5751 The maximum code size expansion factor when copying basic blocks
5752 instead of jumping.  The expansion is relative to a jump instruction.
5753 The default value is 8.
5754
5755 @item max-goto-duplication-insns
5756 The maximum number of instructions to duplicate to a block that jumps
5757 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5758 passes, GCC factors computed gotos early in the compilation process,
5759 and unfactors them as late as possible.  Only computed jumps at the
5760 end of a basic blocks with no more than max-goto-duplication-insns are
5761 unfactored.  The default value is 8.
5762
5763 @item max-delay-slot-insn-search
5764 The maximum number of instructions to consider when looking for an
5765 instruction to fill a delay slot.  If more than this arbitrary number of
5766 instructions is searched, the time savings from filling the delay slot
5767 will be minimal so stop searching.  Increasing values mean more
5768 aggressive optimization, making the compile time increase with probably
5769 small improvement in executable run time.
5770
5771 @item max-delay-slot-live-search
5772 When trying to fill delay slots, the maximum number of instructions to
5773 consider when searching for a block with valid live register
5774 information.  Increasing this arbitrarily chosen value means more
5775 aggressive optimization, increasing the compile time.  This parameter
5776 should be removed when the delay slot code is rewritten to maintain the
5777 control-flow graph.
5778
5779 @item max-gcse-memory
5780 The approximate maximum amount of memory that will be allocated in
5781 order to perform the global common subexpression elimination
5782 optimization.  If more memory than specified is required, the
5783 optimization will not be done.
5784
5785 @item max-gcse-passes
5786 The maximum number of passes of GCSE to run.  The default is 1.
5787
5788 @item max-pending-list-length
5789 The maximum number of pending dependencies scheduling will allow
5790 before flushing the current state and starting over.  Large functions
5791 with few branches or calls can create excessively large lists which
5792 needlessly consume memory and resources.
5793
5794 @item max-inline-insns-single
5795 Several parameters control the tree inliner used in gcc.
5796 This number sets the maximum number of instructions (counted in GCC's
5797 internal representation) in a single function that the tree inliner
5798 will consider for inlining.  This only affects functions declared
5799 inline and methods implemented in a class declaration (C++).
5800 The default value is 450.
5801
5802 @item max-inline-insns-auto
5803 When you use @option{-finline-functions} (included in @option{-O3}),
5804 a lot of functions that would otherwise not be considered for inlining
5805 by the compiler will be investigated.  To those functions, a different
5806 (more restrictive) limit compared to functions declared inline can
5807 be applied.
5808 The default value is 90.
5809
5810 @item large-function-insns
5811 The limit specifying really large functions.  For functions larger than this
5812 limit after inlining inlining is constrained by
5813 @option{--param large-function-growth}.  This parameter is useful primarily
5814 to avoid extreme compilation time caused by non-linear algorithms used by the
5815 backend.
5816 This parameter is ignored when @option{-funit-at-a-time} is not used.
5817 The default value is 2700.
5818
5819 @item large-function-growth
5820 Specifies maximal growth of large function caused by inlining in percents.
5821 This parameter is ignored when @option{-funit-at-a-time} is not used.
5822 The default value is 100 which limits large function growth to 2.0 times
5823 the original size.
5824
5825 @item large-unit-insns
5826 The limit specifying large translation unit.  Growth caused by inlining of
5827 units larger than this limit is limited by @option{--param inline-unit-growth}.
5828 For small units this might be too tight (consider unit consisting of function A
5829 that is inline and B that just calls A three time.  If B is small relative to
5830 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5831 large units consisting of small inlininable functions however the overall unit
5832 growth limit is needed to avoid exponential explosion of code size.  Thus for
5833 smaller units, the size is increased to @option{--param large-unit-insns}
5834 before aplying @option{--param inline-unit-growth}.  The default is 10000
5835
5836 @item inline-unit-growth
5837 Specifies maximal overall growth of the compilation unit caused by inlining.
5838 This parameter is ignored when @option{-funit-at-a-time} is not used.
5839 The default value is 50 which limits unit growth to 1.5 times the original
5840 size.
5841
5842 @item max-inline-insns-recursive
5843 @itemx max-inline-insns-recursive-auto
5844 Specifies maximum number of instructions out-of-line copy of self recursive inline
5845 function can grow into by performing recursive inlining.
5846
5847 For functions declared inline @option{--param max-inline-insns-recursive} is
5848 taken into acount.  For function not declared inline, recursive inlining
5849 happens only when @option{-finline-functions} (included in @option{-O3}) is
5850 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5851 default value is 450.
5852
5853 @item max-inline-recursive-depth
5854 @itemx max-inline-recursive-depth-auto
5855 Specifies maximum recursion depth used by the recursive inlining.
5856
5857 For functions declared inline @option{--param max-inline-recursive-depth} is
5858 taken into acount.  For function not declared inline, recursive inlining
5859 happens only when @option{-finline-functions} (included in @option{-O3}) is
5860 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5861 default value is 450.
5862
5863 @item min-inline-recursive-probability
5864 Recursive inlining is profitable only for function having deep recursion
5865 in average and can hurt for function having little recursion depth by
5866 increasing the prologue size or complexity of function body to other
5867 optimizers.
5868
5869 When profile feedback is available (see @option{-fprofile-generate}) the actual
5870 recursion depth can be guessed from probability that function will recurse via
5871 given call expression.  This parameter limits inlining only to call expression
5872 whose probability exceeds given threshold (in percents).  The default value is
5873 10.
5874
5875 @item inline-call-cost
5876 Specify cost of call instruction relative to simple arithmetics operations
5877 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5878 functions and at the same time increases size of leaf function that is believed to
5879 reduce function size by being inlined.  In effect it increases amount of
5880 inlining for code having large abstraction penalty (many functions that just
5881 pass the arguments to other functions) and decrease inlining for code with low
5882 abstraction penalty.  The default value is 16.
5883
5884 @item max-unrolled-insns
5885 The maximum number of instructions that a loop should have if that loop
5886 is unrolled, and if the loop is unrolled, it determines how many times
5887 the loop code is unrolled.
5888
5889 @item max-average-unrolled-insns
5890 The maximum number of instructions biased by probabilities of their execution
5891 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5892 it determines how many times the loop code is unrolled.
5893
5894 @item max-unroll-times
5895 The maximum number of unrollings of a single loop.
5896
5897 @item max-peeled-insns
5898 The maximum number of instructions that a loop should have if that loop
5899 is peeled, and if the loop is peeled, it determines how many times
5900 the loop code is peeled.
5901
5902 @item max-peel-times
5903 The maximum number of peelings of a single loop.
5904
5905 @item max-completely-peeled-insns
5906 The maximum number of insns of a completely peeled loop.
5907
5908 @item max-completely-peel-times
5909 The maximum number of iterations of a loop to be suitable for complete peeling.
5910
5911 @item max-unswitch-insns
5912 The maximum number of insns of an unswitched loop.
5913
5914 @item max-unswitch-level
5915 The maximum number of branches unswitched in a single loop.
5916
5917 @item lim-expensive
5918 The minimum cost of an expensive expression in the loop invariant motion.
5919
5920 @item iv-consider-all-candidates-bound
5921 Bound on number of candidates for induction variables below that
5922 all candidates are considered for each use in induction variable
5923 optimizations.  Only the most relevant candidates are considered
5924 if there are more candidates, to avoid quadratic time complexity.
5925
5926 @item iv-max-considered-uses
5927 The induction variable optimizations give up on loops that contain more
5928 induction variable uses.
5929
5930 @item iv-always-prune-cand-set-bound
5931 If number of candidates in the set is smaller than this value,
5932 we always try to remove unnecessary ivs from the set during its
5933 optimization when a new iv is added to the set.
5934
5935 @item scev-max-expr-size
5936 Bound on size of expressions used in the scalar evolutions analyzer.
5937 Large expressions slow the analyzer.
5938
5939 @item vect-max-version-checks
5940 The maximum number of runtime checks that can be performed when doing
5941 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5942 for more information.
5943
5944 @item max-iterations-to-track
5945
5946 The maximum number of iterations of a loop the brute force algorithm
5947 for analysis of # of iterations of the loop tries to evaluate.
5948
5949 @item hot-bb-count-fraction
5950 Select fraction of the maximal count of repetitions of basic block in program
5951 given basic block needs to have to be considered hot.
5952
5953 @item hot-bb-frequency-fraction
5954 Select fraction of the maximal frequency of executions of basic block in
5955 function given basic block needs to have to be considered hot
5956
5957 @item max-predicted-iterations
5958 The maximum number of loop iterations we predict statically.  This is useful
5959 in cases where function contain single loop with known bound and other loop
5960 with unknown.  We predict the known number of iterations correctly, while
5961 the unknown number of iterations average to roughly 10.  This means that the
5962 loop without bounds would appear artificially cold relative to the other one.
5963
5964 @item tracer-dynamic-coverage
5965 @itemx tracer-dynamic-coverage-feedback
5966
5967 This value is used to limit superblock formation once the given percentage of
5968 executed instructions is covered.  This limits unnecessary code size
5969 expansion.
5970
5971 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5972 feedback is available.  The real profiles (as opposed to statically estimated
5973 ones) are much less balanced allowing the threshold to be larger value.
5974
5975 @item tracer-max-code-growth
5976 Stop tail duplication once code growth has reached given percentage.  This is
5977 rather hokey argument, as most of the duplicates will be eliminated later in
5978 cross jumping, so it may be set to much higher values than is the desired code
5979 growth.
5980
5981 @item tracer-min-branch-ratio
5982
5983 Stop reverse growth when the reverse probability of best edge is less than this
5984 threshold (in percent).
5985
5986 @item tracer-min-branch-ratio
5987 @itemx tracer-min-branch-ratio-feedback
5988
5989 Stop forward growth if the best edge do have probability lower than this
5990 threshold.
5991
5992 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5993 compilation for profile feedback and one for compilation without.  The value
5994 for compilation with profile feedback needs to be more conservative (higher) in
5995 order to make tracer effective.
5996
5997 @item max-cse-path-length
5998
5999 Maximum number of basic blocks on path that cse considers.  The default is 10.
6000
6001 @item max-cse-insns
6002 The maximum instructions CSE process before flushing. The default is 1000.
6003
6004 @item global-var-threshold
6005
6006 Counts the number of function calls (@var{n}) and the number of
6007 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6008 single artificial variable will be created to represent all the
6009 call-clobbered variables at function call sites.  This artificial
6010 variable will then be made to alias every call-clobbered variable.
6011 (done as @code{int * size_t} on the host machine; beware overflow).
6012
6013 @item max-aliased-vops
6014
6015 Maximum number of virtual operands allowed to represent aliases
6016 before triggering the alias grouping heuristic.  Alias grouping
6017 reduces compile times and memory consumption needed for aliasing at
6018 the expense of precision loss in alias information.
6019
6020 @item ggc-min-expand
6021
6022 GCC uses a garbage collector to manage its own memory allocation.  This
6023 parameter specifies the minimum percentage by which the garbage
6024 collector's heap should be allowed to expand between collections.
6025 Tuning this may improve compilation speed; it has no effect on code
6026 generation.
6027
6028 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6029 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6030 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6031 GCC is not able to calculate RAM on a particular platform, the lower
6032 bound of 30% is used.  Setting this parameter and
6033 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6034 every opportunity.  This is extremely slow, but can be useful for
6035 debugging.
6036
6037 @item ggc-min-heapsize
6038
6039 Minimum size of the garbage collector's heap before it begins bothering
6040 to collect garbage.  The first collection occurs after the heap expands
6041 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6042 tuning this may improve compilation speed, and has no effect on code
6043 generation.
6044
6045 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6046 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6047 with a lower bound of 4096 (four megabytes) and an upper bound of
6048 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6049 particular platform, the lower bound is used.  Setting this parameter
6050 very large effectively disables garbage collection.  Setting this
6051 parameter and @option{ggc-min-expand} to zero causes a full collection
6052 to occur at every opportunity.
6053
6054 @item max-reload-search-insns
6055 The maximum number of instruction reload should look backward for equivalent
6056 register.  Increasing values mean more aggressive optimization, making the
6057 compile time increase with probably slightly better performance.  The default
6058 value is 100.
6059
6060 @item max-cselib-memory-location
6061 The maximum number of memory locations cselib should take into acount.
6062 Increasing values mean more aggressive optimization, making the compile time
6063 increase with probably slightly better performance.  The default value is 500.
6064
6065 @item max-flow-memory-location
6066 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6067 The default value is 100.
6068
6069 @item reorder-blocks-duplicate
6070 @itemx reorder-blocks-duplicate-feedback
6071
6072 Used by basic block reordering pass to decide whether to use unconditional
6073 branch or duplicate the code on its destination.  Code is duplicated when its
6074 estimated size is smaller than this value multiplied by the estimated size of
6075 unconditional jump in the hot spots of the program.
6076
6077 The @option{reorder-block-duplicate-feedback} is used only when profile
6078 feedback is available and may be set to higher values than
6079 @option{reorder-block-duplicate} since information about the hot spots is more
6080 accurate.
6081
6082 @item max-sched-region-blocks
6083 The maximum number of blocks in a region to be considered for
6084 interblock scheduling.  The default value is 10.
6085
6086 @item max-sched-region-insns
6087 The maximum number of insns in a region to be considered for
6088 interblock scheduling.  The default value is 100.
6089
6090 @item min-sched-prob
6091 The minimum probability of reaching a source block for interblock
6092 speculative scheduling.  The default value is 40.
6093
6094 @item max-last-value-rtl
6095
6096 The maximum size measured as number of RTLs that can be recorded in an expression
6097 in combiner for a pseudo register as last known value of that register.  The default
6098 is 10000.
6099
6100 @item integer-share-limit
6101 Small integer constants can use a shared data structure, reducing the
6102 compiler's memory usage and increasing its speed.  This sets the maximum
6103 value of a shared integer constant's.  The default value is 256.
6104
6105 @item min-virtual-mappings
6106 Specifies the minimum number of virtual mappings in the incremental
6107 SSA updater that should be registered to trigger the virtual mappings
6108 heuristic defined by virtual-mappings-ratio.  The default value is
6109 100.
6110
6111 @item virtual-mappings-ratio
6112 If the number of virtual mappings is virtual-mappings-ratio bigger
6113 than the number of virtual symbols to be updated, then the incremental
6114 SSA updater switches to a full update for those symbols.  The default
6115 ratio is 3.
6116
6117 @item ssp-buffer-size
6118 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6119 protection when @option{-fstack-protection} is used.
6120
6121 @item max-jump-thread-duplication-stmts
6122 Maximum number of statements allowed in a block that needs to be
6123 duplicated when threading jumps.
6124 @end table
6125 @end table
6126
6127 @node Preprocessor Options
6128 @section Options Controlling the Preprocessor
6129 @cindex preprocessor options
6130 @cindex options, preprocessor
6131
6132 These options control the C preprocessor, which is run on each C source
6133 file before actual compilation.
6134
6135 If you use the @option{-E} option, nothing is done except preprocessing.
6136 Some of these options make sense only together with @option{-E} because
6137 they cause the preprocessor output to be unsuitable for actual
6138 compilation.
6139
6140 @table @gcctabopt
6141 @opindex Wp
6142 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6143 and pass @var{option} directly through to the preprocessor.  If
6144 @var{option} contains commas, it is split into multiple options at the
6145 commas.  However, many options are modified, translated or interpreted
6146 by the compiler driver before being passed to the preprocessor, and
6147 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6148 interface is undocumented and subject to change, so whenever possible
6149 you should avoid using @option{-Wp} and let the driver handle the
6150 options instead.
6151
6152 @item -Xpreprocessor @var{option}
6153 @opindex preprocessor
6154 Pass @var{option} as an option to the preprocessor.  You can use this to
6155 supply system-specific preprocessor options which GCC does not know how to
6156 recognize.
6157
6158 If you want to pass an option that takes an argument, you must use
6159 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6160 @end table
6161
6162 @include cppopts.texi
6163
6164 @node Assembler Options
6165 @section Passing Options to the Assembler
6166
6167 @c prevent bad page break with this line
6168 You can pass options to the assembler.
6169
6170 @table @gcctabopt
6171 @item -Wa,@var{option}
6172 @opindex Wa
6173 Pass @var{option} as an option to the assembler.  If @var{option}
6174 contains commas, it is split into multiple options at the commas.
6175
6176 @item -Xassembler @var{option}
6177 @opindex Xassembler
6178 Pass @var{option} as an option to the assembler.  You can use this to
6179 supply system-specific assembler options which GCC does not know how to
6180 recognize.
6181
6182 If you want to pass an option that takes an argument, you must use
6183 @option{-Xassembler} twice, once for the option and once for the argument.
6184
6185 @end table
6186
6187 @node Link Options
6188 @section Options for Linking
6189 @cindex link options
6190 @cindex options, linking
6191
6192 These options come into play when the compiler links object files into
6193 an executable output file.  They are meaningless if the compiler is
6194 not doing a link step.
6195
6196 @table @gcctabopt
6197 @cindex file names
6198 @item @var{object-file-name}
6199 A file name that does not end in a special recognized suffix is
6200 considered to name an object file or library.  (Object files are
6201 distinguished from libraries by the linker according to the file
6202 contents.)  If linking is done, these object files are used as input
6203 to the linker.
6204
6205 @item -c
6206 @itemx -S
6207 @itemx -E
6208 @opindex c
6209 @opindex S
6210 @opindex E
6211 If any of these options is used, then the linker is not run, and
6212 object file names should not be used as arguments.  @xref{Overall
6213 Options}.
6214
6215 @cindex Libraries
6216 @item -l@var{library}
6217 @itemx -l @var{library}
6218 @opindex l
6219 Search the library named @var{library} when linking.  (The second
6220 alternative with the library as a separate argument is only for
6221 POSIX compliance and is not recommended.)
6222
6223 It makes a difference where in the command you write this option; the
6224 linker searches and processes libraries and object files in the order they
6225 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6226 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6227 to functions in @samp{z}, those functions may not be loaded.
6228
6229 The linker searches a standard list of directories for the library,
6230 which is actually a file named @file{lib@var{library}.a}.  The linker
6231 then uses this file as if it had been specified precisely by name.
6232
6233 The directories searched include several standard system directories
6234 plus any that you specify with @option{-L}.
6235
6236 Normally the files found this way are library files---archive files
6237 whose members are object files.  The linker handles an archive file by
6238 scanning through it for members which define symbols that have so far
6239 been referenced but not defined.  But if the file that is found is an
6240 ordinary object file, it is linked in the usual fashion.  The only
6241 difference between using an @option{-l} option and specifying a file name
6242 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6243 and searches several directories.
6244
6245 @item -lobjc
6246 @opindex lobjc
6247 You need this special case of the @option{-l} option in order to
6248 link an Objective-C or Objective-C++ program.
6249
6250 @item -nostartfiles
6251 @opindex nostartfiles
6252 Do not use the standard system startup files when linking.
6253 The standard system libraries are used normally, unless @option{-nostdlib}
6254 or @option{-nodefaultlibs} is used.
6255
6256 @item -nodefaultlibs
6257 @opindex nodefaultlibs
6258 Do not use the standard system libraries when linking.
6259 Only the libraries you specify will be passed to the linker.
6260 The standard startup files are used normally, unless @option{-nostartfiles}
6261 is used.  The compiler may generate calls to @code{memcmp},
6262 @code{memset}, @code{memcpy} and @code{memmove}.
6263 These entries are usually resolved by entries in
6264 libc.  These entry points should be supplied through some other
6265 mechanism when this option is specified.
6266
6267 @item -nostdlib
6268 @opindex nostdlib
6269 Do not use the standard system startup files or libraries when linking.
6270 No startup files and only the libraries you specify will be passed to
6271 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6272 @code{memcpy} and @code{memmove}.
6273 These entries are usually resolved by entries in
6274 libc.  These entry points should be supplied through some other
6275 mechanism when this option is specified.
6276
6277 @cindex @option{-lgcc}, use with @option{-nostdlib}
6278 @cindex @option{-nostdlib} and unresolved references
6279 @cindex unresolved references and @option{-nostdlib}
6280 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6281 @cindex @option{-nodefaultlibs} and unresolved references
6282 @cindex unresolved references and @option{-nodefaultlibs}
6283 One of the standard libraries bypassed by @option{-nostdlib} and
6284 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6285 that GCC uses to overcome shortcomings of particular machines, or special
6286 needs for some languages.
6287 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6288 Collection (GCC) Internals},
6289 for more discussion of @file{libgcc.a}.)
6290 In most cases, you need @file{libgcc.a} even when you want to avoid
6291 other standard libraries.  In other words, when you specify @option{-nostdlib}
6292 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6293 This ensures that you have no unresolved references to internal GCC
6294 library subroutines.  (For example, @samp{__main}, used to ensure C++
6295 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6296 GNU Compiler Collection (GCC) Internals}.)
6297
6298 @item -pie
6299 @opindex pie
6300 Produce a position independent executable on targets which support it.
6301 For predictable results, you must also specify the same set of options
6302 that were used to generate code (@option{-fpie}, @option{-fPIE},
6303 or model suboptions) when you specify this option.
6304
6305 @item -rdynamic
6306 @opindex rdynamic
6307 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6308 that support it. This instructs the linker to add all symbols, not
6309 only used ones, to the dynamic symbol table. This option is needed
6310 for some uses of @code{dlopen} or to allow obtaining backtraces
6311 from within a program.
6312
6313 @item -s
6314 @opindex s
6315 Remove all symbol table and relocation information from the executable.
6316
6317 @item -static
6318 @opindex static
6319 On systems that support dynamic linking, this prevents linking with the shared
6320 libraries.  On other systems, this option has no effect.
6321
6322 @item -shared
6323 @opindex shared
6324 Produce a shared object which can then be linked with other objects to
6325 form an executable.  Not all systems support this option.  For predictable
6326 results, you must also specify the same set of options that were used to
6327 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6328 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6329 needs to build supplementary stub code for constructors to work.  On
6330 multi-libbed systems, @samp{gcc -shared} must select the correct support
6331 libraries to link against.  Failing to supply the correct flags may lead
6332 to subtle defects.  Supplying them in cases where they are not necessary
6333 is innocuous.}
6334
6335 @item -shared-libgcc
6336 @itemx -static-libgcc
6337 @opindex shared-libgcc
6338 @opindex static-libgcc
6339 On systems that provide @file{libgcc} as a shared library, these options
6340 force the use of either the shared or static version respectively.
6341 If no shared version of @file{libgcc} was built when the compiler was
6342 configured, these options have no effect.
6343
6344 There are several situations in which an application should use the
6345 shared @file{libgcc} instead of the static version.  The most common
6346 of these is when the application wishes to throw and catch exceptions
6347 across different shared libraries.  In that case, each of the libraries
6348 as well as the application itself should use the shared @file{libgcc}.
6349
6350 Therefore, the G++ and GCJ drivers automatically add
6351 @option{-shared-libgcc} whenever you build a shared library or a main
6352 executable, because C++ and Java programs typically use exceptions, so
6353 this is the right thing to do.
6354
6355 If, instead, you use the GCC driver to create shared libraries, you may
6356 find that they will not always be linked with the shared @file{libgcc}.
6357 If GCC finds, at its configuration time, that you have a non-GNU linker
6358 or a GNU linker that does not support option @option{--eh-frame-hdr},
6359 it will link the shared version of @file{libgcc} into shared libraries
6360 by default.  Otherwise, it will take advantage of the linker and optimize
6361 away the linking with the shared version of @file{libgcc}, linking with
6362 the static version of libgcc by default.  This allows exceptions to
6363 propagate through such shared libraries, without incurring relocation
6364 costs at library load time.
6365
6366 However, if a library or main executable is supposed to throw or catch
6367 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6368 for the languages used in the program, or using the option
6369 @option{-shared-libgcc}, such that it is linked with the shared
6370 @file{libgcc}.
6371
6372 @item -symbolic
6373 @opindex symbolic
6374 Bind references to global symbols when building a shared object.  Warn
6375 about any unresolved references (unless overridden by the link editor
6376 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6377 this option.
6378
6379 @item -Xlinker @var{option}
6380 @opindex Xlinker
6381 Pass @var{option} as an option to the linker.  You can use this to
6382 supply system-specific linker options which GCC does not know how to
6383 recognize.
6384
6385 If you want to pass an option that takes an argument, you must use
6386 @option{-Xlinker} twice, once for the option and once for the argument.
6387 For example, to pass @option{-assert definitions}, you must write
6388 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6389 @option{-Xlinker "-assert definitions"}, because this passes the entire
6390 string as a single argument, which is not what the linker expects.
6391
6392 @item -Wl,@var{option}
6393 @opindex Wl
6394 Pass @var{option} as an option to the linker.  If @var{option} contains
6395 commas, it is split into multiple options at the commas.
6396
6397 @item -u @var{symbol}
6398 @opindex u
6399 Pretend the symbol @var{symbol} is undefined, to force linking of
6400 library modules to define it.  You can use @option{-u} multiple times with
6401 different symbols to force loading of additional library modules.
6402 @end table
6403
6404 @node Directory Options
6405 @section Options for Directory Search
6406 @cindex directory options
6407 @cindex options, directory search
6408 @cindex search path
6409
6410 These options specify directories to search for header files, for
6411 libraries and for parts of the compiler:
6412
6413 @table @gcctabopt
6414 @item -I@var{dir}
6415 @opindex I
6416 Add the directory @var{dir} to the head of the list of directories to be
6417 searched for header files.  This can be used to override a system header
6418 file, substituting your own version, since these directories are
6419 searched before the system header file directories.  However, you should
6420 not use this option to add directories that contain vendor-supplied
6421 system header files (use @option{-isystem} for that).  If you use more than
6422 one @option{-I} option, the directories are scanned in left-to-right
6423 order; the standard system directories come after.
6424
6425 If a standard system include directory, or a directory specified with
6426 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6427 option will be ignored.  The directory will still be searched but as a
6428 system directory at its normal position in the system include chain.
6429 This is to ensure that GCC's procedure to fix buggy system headers and
6430 the ordering for the include_next directive are not inadvertently changed.
6431 If you really need to change the search order for system directories,
6432 use the @option{-nostdinc} and/or @option{-isystem} options.
6433
6434 @item -iquote@var{dir}
6435 @opindex iquote
6436 Add the directory @var{dir} to the head of the list of directories to
6437 be searched for header files only for the case of @samp{#include
6438 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6439 otherwise just like @option{-I}.
6440
6441 @item -L@var{dir}
6442 @opindex L
6443 Add directory @var{dir} to the list of directories to be searched
6444 for @option{-l}.
6445
6446 @item -B@var{prefix}
6447 @opindex B
6448 This option specifies where to find the executables, libraries,
6449 include files, and data files of the compiler itself.
6450
6451 The compiler driver program runs one or more of the subprograms
6452 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6453 @var{prefix} as a prefix for each program it tries to run, both with and
6454 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6455
6456 For each subprogram to be run, the compiler driver first tries the
6457 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6458 was not specified, the driver tries two standard prefixes, which are
6459 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6460 those results in a file name that is found, the unmodified program
6461 name is searched for using the directories specified in your
6462 @env{PATH} environment variable.
6463
6464 The compiler will check to see if the path provided by the @option{-B}
6465 refers to a directory, and if necessary it will add a directory
6466 separator character at the end of the path.
6467
6468 @option{-B} prefixes that effectively specify directory names also apply
6469 to libraries in the linker, because the compiler translates these
6470 options into @option{-L} options for the linker.  They also apply to
6471 includes files in the preprocessor, because the compiler translates these
6472 options into @option{-isystem} options for the preprocessor.  In this case,
6473 the compiler appends @samp{include} to the prefix.
6474
6475 The run-time support file @file{libgcc.a} can also be searched for using
6476 the @option{-B} prefix, if needed.  If it is not found there, the two
6477 standard prefixes above are tried, and that is all.  The file is left
6478 out of the link if it is not found by those means.
6479
6480 Another way to specify a prefix much like the @option{-B} prefix is to use
6481 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6482 Variables}.
6483
6484 As a special kludge, if the path provided by @option{-B} is
6485 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6486 9, then it will be replaced by @file{[dir/]include}.  This is to help
6487 with boot-strapping the compiler.
6488
6489 @item -specs=@var{file}
6490 @opindex specs
6491 Process @var{file} after the compiler reads in the standard @file{specs}
6492 file, in order to override the defaults that the @file{gcc} driver
6493 program uses when determining what switches to pass to @file{cc1},
6494 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6495 @option{-specs=@var{file}} can be specified on the command line, and they
6496 are processed in order, from left to right.
6497
6498 @item --sysroot=@var{dir}
6499 @opindex sysroot
6500 Use @var{dir} as the logical root directory for headers and libraries.
6501 For example, if the compiler would normally search for headers in
6502 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6503 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6504
6505 If you use both this option and the @option{-isysroot} option, then
6506 the @option{--sysroot} option will apply to libraries, but the
6507 @option{-isysroot} option will apply to header files.
6508
6509 The GNU linker (beginning with version 2.16) has the necessary support
6510 for this option.  If your linker does not support this option, the
6511 header file aspect of @option{--sysroot} will still work, but the
6512 library aspect will not.
6513
6514 @item -I-
6515 @opindex I-
6516 This option has been deprecated.  Please use @option{-iquote} instead for
6517 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6518 Any directories you specify with @option{-I} options before the @option{-I-}
6519 option are searched only for the case of @samp{#include "@var{file}"};
6520 they are not searched for @samp{#include <@var{file}>}.
6521
6522 If additional directories are specified with @option{-I} options after
6523 the @option{-I-}, these directories are searched for all @samp{#include}
6524 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6525 this way.)
6526
6527 In addition, the @option{-I-} option inhibits the use of the current
6528 directory (where the current input file came from) as the first search
6529 directory for @samp{#include "@var{file}"}.  There is no way to
6530 override this effect of @option{-I-}.  With @option{-I.} you can specify
6531 searching the directory which was current when the compiler was
6532 invoked.  That is not exactly the same as what the preprocessor does
6533 by default, but it is often satisfactory.
6534
6535 @option{-I-} does not inhibit the use of the standard system directories
6536 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6537 independent.
6538 @end table
6539
6540 @c man end
6541
6542 @node Spec Files
6543 @section Specifying subprocesses and the switches to pass to them
6544 @cindex Spec Files
6545
6546 @command{gcc} is a driver program.  It performs its job by invoking a
6547 sequence of other programs to do the work of compiling, assembling and
6548 linking.  GCC interprets its command-line parameters and uses these to
6549 deduce which programs it should invoke, and which command-line options
6550 it ought to place on their command lines.  This behavior is controlled
6551 by @dfn{spec strings}.  In most cases there is one spec string for each
6552 program that GCC can invoke, but a few programs have multiple spec
6553 strings to control their behavior.  The spec strings built into GCC can
6554 be overridden by using the @option{-specs=} command-line switch to specify
6555 a spec file.
6556
6557 @dfn{Spec files} are plaintext files that are used to construct spec
6558 strings.  They consist of a sequence of directives separated by blank
6559 lines.  The type of directive is determined by the first non-whitespace
6560 character on the line and it can be one of the following:
6561
6562 @table @code
6563 @item %@var{command}
6564 Issues a @var{command} to the spec file processor.  The commands that can
6565 appear here are:
6566
6567 @table @code
6568 @item %include <@var{file}>
6569 @cindex %include
6570 Search for @var{file} and insert its text at the current point in the
6571 specs file.
6572
6573 @item %include_noerr <@var{file}>
6574 @cindex %include_noerr
6575 Just like @samp{%include}, but do not generate an error message if the include
6576 file cannot be found.
6577
6578 @item %rename @var{old_name} @var{new_name}
6579 @cindex %rename
6580 Rename the spec string @var{old_name} to @var{new_name}.
6581
6582 @end table
6583
6584 @item *[@var{spec_name}]:
6585 This tells the compiler to create, override or delete the named spec
6586 string.  All lines after this directive up to the next directive or
6587 blank line are considered to be the text for the spec string.  If this
6588 results in an empty string then the spec will be deleted.  (Or, if the
6589 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6590 does not currently exist a new spec will be created.  If the spec does
6591 exist then its contents will be overridden by the text of this
6592 directive, unless the first character of that text is the @samp{+}
6593 character, in which case the text will be appended to the spec.
6594
6595 @item [@var{suffix}]:
6596 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6597 and up to the next directive or blank line are considered to make up the
6598 spec string for the indicated suffix.  When the compiler encounters an
6599 input file with the named suffix, it will processes the spec string in
6600 order to work out how to compile that file.  For example:
6601
6602 @smallexample
6603 .ZZ:
6604 z-compile -input %i
6605 @end smallexample
6606
6607 This says that any input file whose name ends in @samp{.ZZ} should be
6608 passed to the program @samp{z-compile}, which should be invoked with the
6609 command-line switch @option{-input} and with the result of performing the
6610 @samp{%i} substitution.  (See below.)
6611
6612 As an alternative to providing a spec string, the text that follows a
6613 suffix directive can be one of the following:
6614
6615 @table @code
6616 @item @@@var{language}
6617 This says that the suffix is an alias for a known @var{language}.  This is
6618 similar to using the @option{-x} command-line switch to GCC to specify a
6619 language explicitly.  For example:
6620
6621 @smallexample
6622 .ZZ:
6623 @@c++
6624 @end smallexample
6625
6626 Says that .ZZ files are, in fact, C++ source files.
6627
6628 @item #@var{name}
6629 This causes an error messages saying:
6630
6631 @smallexample
6632 @var{name} compiler not installed on this system.
6633 @end smallexample
6634 @end table
6635
6636 GCC already has an extensive list of suffixes built into it.
6637 This directive will add an entry to the end of the list of suffixes, but
6638 since the list is searched from the end backwards, it is effectively
6639 possible to override earlier entries using this technique.
6640
6641 @end table
6642
6643 GCC has the following spec strings built into it.  Spec files can
6644 override these strings or create their own.  Note that individual
6645 targets can also add their own spec strings to this list.
6646
6647 @smallexample
6648 asm          Options to pass to the assembler
6649 asm_final    Options to pass to the assembler post-processor
6650 cpp          Options to pass to the C preprocessor
6651 cc1          Options to pass to the C compiler
6652 cc1plus      Options to pass to the C++ compiler
6653 endfile      Object files to include at the end of the link
6654 link         Options to pass to the linker
6655 lib          Libraries to include on the command line to the linker
6656 libgcc       Decides which GCC support library to pass to the linker
6657 linker       Sets the name of the linker
6658 predefines   Defines to be passed to the C preprocessor
6659 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6660              by default
6661 startfile    Object files to include at the start of the link
6662 @end smallexample
6663
6664 Here is a small example of a spec file:
6665
6666 @smallexample
6667 %rename lib                 old_lib
6668
6669 *lib:
6670 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6671 @end smallexample
6672
6673 This example renames the spec called @samp{lib} to @samp{old_lib} and
6674 then overrides the previous definition of @samp{lib} with a new one.
6675 The new definition adds in some extra command-line options before
6676 including the text of the old definition.
6677
6678 @dfn{Spec strings} are a list of command-line options to be passed to their
6679 corresponding program.  In addition, the spec strings can contain
6680 @samp{%}-prefixed sequences to substitute variable text or to
6681 conditionally insert text into the command line.  Using these constructs
6682 it is possible to generate quite complex command lines.
6683
6684 Here is a table of all defined @samp{%}-sequences for spec
6685 strings.  Note that spaces are not generated automatically around the
6686 results of expanding these sequences.  Therefore you can concatenate them
6687 together or combine them with constant text in a single argument.
6688
6689 @table @code
6690 @item %%
6691 Substitute one @samp{%} into the program name or argument.
6692
6693 @item %i
6694 Substitute the name of the input file being processed.
6695
6696 @item %b
6697 Substitute the basename of the input file being processed.
6698 This is the substring up to (and not including) the last period
6699 and not including the directory.
6700
6701 @item %B
6702 This is the same as @samp{%b}, but include the file suffix (text after
6703 the last period).
6704
6705 @item %d
6706 Marks the argument containing or following the @samp{%d} as a
6707 temporary file name, so that that file will be deleted if GCC exits
6708 successfully.  Unlike @samp{%g}, this contributes no text to the
6709 argument.
6710
6711 @item %g@var{suffix}
6712 Substitute a file name that has suffix @var{suffix} and is chosen
6713 once per compilation, and mark the argument in the same way as
6714 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6715 name is now chosen in a way that is hard to predict even when previously
6716 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6717 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6718 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6719 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6720 was simply substituted with a file name chosen once per compilation,
6721 without regard to any appended suffix (which was therefore treated
6722 just like ordinary text), making such attacks more likely to succeed.
6723
6724 @item %u@var{suffix}
6725 Like @samp{%g}, but generates a new temporary file name even if
6726 @samp{%u@var{suffix}} was already seen.
6727
6728 @item %U@var{suffix}
6729 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6730 new one if there is no such last file name.  In the absence of any
6731 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6732 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6733 would involve the generation of two distinct file names, one
6734 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6735 simply substituted with a file name chosen for the previous @samp{%u},
6736 without regard to any appended suffix.
6737
6738 @item %j@var{suffix}
6739 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6740 writable, and if save-temps is off; otherwise, substitute the name
6741 of a temporary file, just like @samp{%u}.  This temporary file is not
6742 meant for communication between processes, but rather as a junk
6743 disposal mechanism.
6744
6745 @item %|@var{suffix}
6746 @itemx %m@var{suffix}
6747 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6748 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6749 all.  These are the two most common ways to instruct a program that it
6750 should read from standard input or write to standard output.  If you
6751 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6752 construct: see for example @file{f/lang-specs.h}.
6753
6754 @item %.@var{SUFFIX}
6755 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6756 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6757 terminated by the next space or %.
6758
6759 @item %w
6760 Marks the argument containing or following the @samp{%w} as the
6761 designated output file of this compilation.  This puts the argument
6762 into the sequence of arguments that @samp{%o} will substitute later.
6763
6764 @item %o
6765 Substitutes the names of all the output files, with spaces
6766 automatically placed around them.  You should write spaces
6767 around the @samp{%o} as well or the results are undefined.
6768 @samp{%o} is for use in the specs for running the linker.
6769 Input files whose names have no recognized suffix are not compiled
6770 at all, but they are included among the output files, so they will
6771 be linked.
6772
6773 @item %O
6774 Substitutes the suffix for object files.  Note that this is
6775 handled specially when it immediately follows @samp{%g, %u, or %U},
6776 because of the need for those to form complete file names.  The
6777 handling is such that @samp{%O} is treated exactly as if it had already
6778 been substituted, except that @samp{%g, %u, and %U} do not currently
6779 support additional @var{suffix} characters following @samp{%O} as they would
6780 following, for example, @samp{.o}.
6781
6782 @item %p
6783 Substitutes the standard macro predefinitions for the
6784 current target machine.  Use this when running @code{cpp}.
6785
6786 @item %P
6787 Like @samp{%p}, but puts @samp{__} before and after the name of each
6788 predefined macro, except for macros that start with @samp{__} or with
6789 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6790 C@.
6791
6792 @item %I
6793 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6794 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6795 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6796 as necessary.
6797
6798 @item %s
6799 Current argument is the name of a library or startup file of some sort.
6800 Search for that file in a standard list of directories and substitute
6801 the full name found.
6802
6803 @item %e@var{str}
6804 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6805 Use this when inconsistent options are detected.
6806
6807 @item %(@var{name})
6808 Substitute the contents of spec string @var{name} at this point.
6809
6810 @item %[@var{name}]
6811 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6812
6813 @item %x@{@var{option}@}
6814 Accumulate an option for @samp{%X}.
6815
6816 @item %X
6817 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6818 spec string.
6819
6820 @item %Y
6821 Output the accumulated assembler options specified by @option{-Wa}.
6822
6823 @item %Z
6824 Output the accumulated preprocessor options specified by @option{-Wp}.
6825
6826 @item %a
6827 Process the @code{asm} spec.  This is used to compute the
6828 switches to be passed to the assembler.
6829
6830 @item %A
6831 Process the @code{asm_final} spec.  This is a spec string for
6832 passing switches to an assembler post-processor, if such a program is
6833 needed.
6834
6835 @item %l
6836 Process the @code{link} spec.  This is the spec for computing the
6837 command line passed to the linker.  Typically it will make use of the
6838 @samp{%L %G %S %D and %E} sequences.
6839
6840 @item %D
6841 Dump out a @option{-L} option for each directory that GCC believes might
6842 contain startup files.  If the target supports multilibs then the
6843 current multilib directory will be prepended to each of these paths.
6844
6845 @item %L
6846 Process the @code{lib} spec.  This is a spec string for deciding which
6847 libraries should be included on the command line to the linker.
6848
6849 @item %G
6850 Process the @code{libgcc} spec.  This is a spec string for deciding
6851 which GCC support library should be included on the command line to the linker.
6852
6853 @item %S
6854 Process the @code{startfile} spec.  This is a spec for deciding which
6855 object files should be the first ones passed to the linker.  Typically
6856 this might be a file named @file{crt0.o}.
6857
6858 @item %E
6859 Process the @code{endfile} spec.  This is a spec string that specifies
6860 the last object files that will be passed to the linker.
6861
6862 @item %C
6863 Process the @code{cpp} spec.  This is used to construct the arguments
6864 to be passed to the C preprocessor.
6865
6866 @item %1
6867 Process the @code{cc1} spec.  This is used to construct the options to be
6868 passed to the actual C compiler (@samp{cc1}).
6869
6870 @item %2
6871 Process the @code{cc1plus} spec.  This is used to construct the options to be
6872 passed to the actual C++ compiler (@samp{cc1plus}).
6873
6874 @item %*
6875 Substitute the variable part of a matched option.  See below.
6876 Note that each comma in the substituted string is replaced by
6877 a single space.
6878
6879 @item %<@code{S}
6880 Remove all occurrences of @code{-S} from the command line.  Note---this
6881 command is position dependent.  @samp{%} commands in the spec string
6882 before this one will see @code{-S}, @samp{%} commands in the spec string
6883 after this one will not.
6884
6885 @item %:@var{function}(@var{args})
6886 Call the named function @var{function}, passing it @var{args}.
6887 @var{args} is first processed as a nested spec string, then split
6888 into an argument vector in the usual fashion.  The function returns
6889 a string which is processed as if it had appeared literally as part
6890 of the current spec.
6891
6892 The following built-in spec functions are provided:
6893
6894 @table @code
6895 @item @code{if-exists}
6896 The @code{if-exists} spec function takes one argument, an absolute
6897 pathname to a file.  If the file exists, @code{if-exists} returns the
6898 pathname.  Here is a small example of its usage:
6899
6900 @smallexample
6901 *startfile:
6902 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6903 @end smallexample
6904
6905 @item @code{if-exists-else}
6906 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6907 spec function, except that it takes two arguments.  The first argument is
6908 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6909 returns the pathname.  If it does not exist, it returns the second argument.
6910 This way, @code{if-exists-else} can be used to select one file or another,
6911 based on the existence of the first.  Here is a small example of its usage:
6912
6913 @smallexample
6914 *startfile:
6915 crt0%O%s %:if-exists(crti%O%s) \
6916 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6917 @end smallexample
6918
6919 @item @code{replace-outfile}
6920 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6921 first argument in the outfiles array and replaces it with the second argument.  Here
6922 is a small example of its usage:
6923
6924 @smallexample
6925 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6926 @end smallexample
6927
6928 @end table
6929
6930 @item %@{@code{S}@}
6931 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6932 If that switch was not specified, this substitutes nothing.  Note that
6933 the leading dash is omitted when specifying this option, and it is
6934 automatically inserted if the substitution is performed.  Thus the spec
6935 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6936 and would output the command line option @option{-foo}.
6937
6938 @item %W@{@code{S}@}
6939 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6940 deleted on failure.
6941
6942 @item %@{@code{S}*@}
6943 Substitutes all the switches specified to GCC whose names start
6944 with @code{-S}, but which also take an argument.  This is used for
6945 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6946 GCC considers @option{-o foo} as being
6947 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6948 text, including the space.  Thus two arguments would be generated.
6949
6950 @item %@{@code{S}*&@code{T}*@}
6951 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6952 (the order of @code{S} and @code{T} in the spec is not significant).
6953 There can be any number of ampersand-separated variables; for each the
6954 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6955
6956 @item %@{@code{S}:@code{X}@}
6957 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6958
6959 @item %@{!@code{S}:@code{X}@}
6960 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6961
6962 @item %@{@code{S}*:@code{X}@}
6963 Substitutes @code{X} if one or more switches whose names start with
6964 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6965 once, no matter how many such switches appeared.  However, if @code{%*}
6966 appears somewhere in @code{X}, then @code{X} will be substituted once
6967 for each matching switch, with the @code{%*} replaced by the part of
6968 that switch that matched the @code{*}.
6969
6970 @item %@{.@code{S}:@code{X}@}
6971 Substitutes @code{X}, if processing a file with suffix @code{S}.
6972
6973 @item %@{!.@code{S}:@code{X}@}
6974 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6975
6976 @item %@{@code{S}|@code{P}:@code{X}@}
6977 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6978 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6979 although they have a stronger binding than the @samp{|}.  If @code{%*}
6980 appears in @code{X}, all of the alternatives must be starred, and only
6981 the first matching alternative is substituted.
6982
6983 For example, a spec string like this:
6984
6985 @smallexample
6986 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6987 @end smallexample
6988
6989 will output the following command-line options from the following input
6990 command-line options:
6991
6992 @smallexample
6993 fred.c        -foo -baz
6994 jim.d         -bar -boggle
6995 -d fred.c     -foo -baz -boggle
6996 -d jim.d      -bar -baz -boggle
6997 @end smallexample
6998
6999 @item %@{S:X; T:Y; :D@}
7000
7001 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7002 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7003 be as many clauses as you need.  This may be combined with @code{.},
7004 @code{!}, @code{|}, and @code{*} as needed.
7005
7006
7007 @end table
7008
7009 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7010 construct may contain other nested @samp{%} constructs or spaces, or
7011 even newlines.  They are processed as usual, as described above.
7012 Trailing white space in @code{X} is ignored.  White space may also
7013 appear anywhere on the left side of the colon in these constructs,
7014 except between @code{.} or @code{*} and the corresponding word.
7015
7016 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7017 handled specifically in these constructs.  If another value of
7018 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7019 @option{-W} switch is found later in the command line, the earlier
7020 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7021 just one letter, which passes all matching options.
7022
7023 The character @samp{|} at the beginning of the predicate text is used to
7024 indicate that a command should be piped to the following command, but
7025 only if @option{-pipe} is specified.
7026
7027 It is built into GCC which switches take arguments and which do not.
7028 (You might think it would be useful to generalize this to allow each
7029 compiler's spec to say which switches take arguments.  But this cannot
7030 be done in a consistent fashion.  GCC cannot even decide which input
7031 files have been specified without knowing which switches take arguments,
7032 and it must know which input files to compile in order to tell which
7033 compilers to run).
7034
7035 GCC also knows implicitly that arguments starting in @option{-l} are to be
7036 treated as compiler output files, and passed to the linker in their
7037 proper position among the other output files.
7038
7039 @c man begin OPTIONS
7040
7041 @node Target Options
7042 @section Specifying Target Machine and Compiler Version
7043 @cindex target options
7044 @cindex cross compiling
7045 @cindex specifying machine version
7046 @cindex specifying compiler version and target machine
7047 @cindex compiler version, specifying
7048 @cindex target machine, specifying
7049
7050 The usual way to run GCC is to run the executable called @file{gcc}, or
7051 @file{<machine>-gcc} when cross-compiling, or
7052 @file{<machine>-gcc-<version>} to run a version other than the one that
7053 was installed last.  Sometimes this is inconvenient, so GCC provides
7054 options that will switch to another cross-compiler or version.
7055
7056 @table @gcctabopt
7057 @item -b @var{machine}
7058 @opindex b
7059 The argument @var{machine} specifies the target machine for compilation.
7060
7061 The value to use for @var{machine} is the same as was specified as the
7062 machine type when configuring GCC as a cross-compiler.  For
7063 example, if a cross-compiler was configured with @samp{configure
7064 arm-elf}, meaning to compile for an arm processor with elf binaries,
7065 then you would specify @option{-b arm-elf} to run that cross compiler.
7066 Because there are other options beginning with @option{-b}, the
7067 configuration must contain a hyphen. 
7068
7069 @item -V @var{version}
7070 @opindex V
7071 The argument @var{version} specifies which version of GCC to run.
7072 This is useful when multiple versions are installed.  For example,
7073 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7074 @end table
7075
7076 The @option{-V} and @option{-b} options work by running the
7077 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7078 use them if you can just run that directly.
7079
7080 @node Submodel Options
7081 @section Hardware Models and Configurations
7082 @cindex submodel options
7083 @cindex specifying hardware config
7084 @cindex hardware models and configurations, specifying
7085 @cindex machine dependent options
7086
7087 Earlier we discussed the standard option @option{-b} which chooses among
7088 different installed compilers for completely different target
7089 machines, such as VAX vs.@: 68000 vs.@: 80386.
7090
7091 In addition, each of these target machine types can have its own
7092 special options, starting with @samp{-m}, to choose among various
7093 hardware models or configurations---for example, 68010 vs 68020,
7094 floating coprocessor or none.  A single installed version of the
7095 compiler can compile for any model or configuration, according to the
7096 options specified.
7097
7098 Some configurations of the compiler also support additional special
7099 options, usually for compatibility with other compilers on the same
7100 platform.
7101
7102 @c This list is ordered alphanumerically by subsection name.
7103 @c It should be the same order and spelling as these options are listed
7104 @c in Machine Dependent Options
7105
7106 @menu
7107 * ARC Options::
7108 * ARM Options::
7109 * AVR Options::
7110 * Blackfin Options::
7111 * CRIS Options::
7112 * CRX Options::
7113 * Darwin Options::
7114 * DEC Alpha Options::
7115 * DEC Alpha/VMS Options::
7116 * FRV Options::
7117 * H8/300 Options::
7118 * HPPA Options::
7119 * i386 and x86-64 Options::
7120 * IA-64 Options::
7121 * M32C Options::
7122 * M32R/D Options::
7123 * M680x0 Options::
7124 * M68hc1x Options::
7125 * MCore Options::
7126 * MIPS Options::
7127 * MMIX Options::
7128 * MN10300 Options::
7129 * MS1 Options::
7130 * PDP-11 Options::
7131 * PowerPC Options::
7132 * RS/6000 and PowerPC Options::
7133 * S/390 and zSeries Options::
7134 * SH Options::
7135 * SPARC Options::
7136 * System V Options::
7137 * TMS320C3x/C4x Options::
7138 * V850 Options::
7139 * VAX Options::
7140 * x86-64 Options::
7141 * Xstormy16 Options::
7142 * Xtensa Options::
7143 * zSeries Options::
7144 @end menu
7145
7146 @node ARC Options
7147 @subsection ARC Options
7148 @cindex ARC Options
7149
7150 These options are defined for ARC implementations:
7151
7152 @table @gcctabopt
7153 @item -EL
7154 @opindex EL
7155 Compile code for little endian mode.  This is the default.
7156
7157 @item -EB
7158 @opindex EB
7159 Compile code for big endian mode.
7160
7161 @item -mmangle-cpu
7162 @opindex mmangle-cpu
7163 Prepend the name of the cpu to all public symbol names.
7164 In multiple-processor systems, there are many ARC variants with different
7165 instruction and register set characteristics.  This flag prevents code
7166 compiled for one cpu to be linked with code compiled for another.
7167 No facility exists for handling variants that are ``almost identical''.
7168 This is an all or nothing option.
7169
7170 @item -mcpu=@var{cpu}
7171 @opindex mcpu
7172 Compile code for ARC variant @var{cpu}.
7173 Which variants are supported depend on the configuration.
7174 All variants support @option{-mcpu=base}, this is the default.
7175
7176 @item -mtext=@var{text-section}
7177 @itemx -mdata=@var{data-section}
7178 @itemx -mrodata=@var{readonly-data-section}
7179 @opindex mtext
7180 @opindex mdata
7181 @opindex mrodata
7182 Put functions, data, and readonly data in @var{text-section},
7183 @var{data-section}, and @var{readonly-data-section} respectively
7184 by default.  This can be overridden with the @code{section} attribute.
7185 @xref{Variable Attributes}.
7186
7187 @end table
7188
7189 @node ARM Options
7190 @subsection ARM Options
7191 @cindex ARM options
7192
7193 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7194 architectures:
7195
7196 @table @gcctabopt
7197 @item -mabi=@var{name}
7198 @opindex mabi
7199 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7200 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7201
7202 @item -mapcs-frame
7203 @opindex mapcs-frame
7204 Generate a stack frame that is compliant with the ARM Procedure Call
7205 Standard for all functions, even if this is not strictly necessary for
7206 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7207 with this option will cause the stack frames not to be generated for
7208 leaf functions.  The default is @option{-mno-apcs-frame}.
7209
7210 @item -mapcs
7211 @opindex mapcs
7212 This is a synonym for @option{-mapcs-frame}.
7213
7214 @ignore
7215 @c not currently implemented
7216 @item -mapcs-stack-check
7217 @opindex mapcs-stack-check
7218 Generate code to check the amount of stack space available upon entry to
7219 every function (that actually uses some stack space).  If there is
7220 insufficient space available then either the function
7221 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7222 called, depending upon the amount of stack space required.  The run time
7223 system is required to provide these functions.  The default is
7224 @option{-mno-apcs-stack-check}, since this produces smaller code.
7225
7226 @c not currently implemented
7227 @item -mapcs-float
7228 @opindex mapcs-float
7229 Pass floating point arguments using the float point registers.  This is
7230 one of the variants of the APCS@.  This option is recommended if the
7231 target hardware has a floating point unit or if a lot of floating point
7232 arithmetic is going to be performed by the code.  The default is
7233 @option{-mno-apcs-float}, since integer only code is slightly increased in
7234 size if @option{-mapcs-float} is used.
7235
7236 @c not currently implemented
7237 @item -mapcs-reentrant
7238 @opindex mapcs-reentrant
7239 Generate reentrant, position independent code.  The default is
7240 @option{-mno-apcs-reentrant}.
7241 @end ignore
7242
7243 @item -mthumb-interwork
7244 @opindex mthumb-interwork
7245 Generate code which supports calling between the ARM and Thumb
7246 instruction sets.  Without this option the two instruction sets cannot
7247 be reliably used inside one program.  The default is
7248 @option{-mno-thumb-interwork}, since slightly larger code is generated
7249 when @option{-mthumb-interwork} is specified.
7250
7251 @item -mno-sched-prolog
7252 @opindex mno-sched-prolog
7253 Prevent the reordering of instructions in the function prolog, or the
7254 merging of those instruction with the instructions in the function's
7255 body.  This means that all functions will start with a recognizable set
7256 of instructions (or in fact one of a choice from a small set of
7257 different function prologues), and this information can be used to
7258 locate the start if functions inside an executable piece of code.  The
7259 default is @option{-msched-prolog}.
7260
7261 @item -mhard-float
7262 @opindex mhard-float
7263 Generate output containing floating point instructions.  This is the
7264 default.
7265
7266 @item -msoft-float
7267 @opindex msoft-float
7268 Generate output containing library calls for floating point.
7269 @strong{Warning:} the requisite libraries are not available for all ARM
7270 targets.  Normally the facilities of the machine's usual C compiler are
7271 used, but this cannot be done directly in cross-compilation.  You must make
7272 your own arrangements to provide suitable library functions for
7273 cross-compilation.
7274
7275 @option{-msoft-float} changes the calling convention in the output file;
7276 therefore, it is only useful if you compile @emph{all} of a program with
7277 this option.  In particular, you need to compile @file{libgcc.a}, the
7278 library that comes with GCC, with @option{-msoft-float} in order for
7279 this to work.
7280
7281 @item -mfloat-abi=@var{name}
7282 @opindex mfloat-abi
7283 Specifies which ABI to use for floating point values.  Permissible values
7284 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7285
7286 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7287 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7288 of floating point instructions, but still uses the soft-float calling
7289 conventions.
7290
7291 @item -mlittle-endian
7292 @opindex mlittle-endian
7293 Generate code for a processor running in little-endian mode.  This is
7294 the default for all standard configurations.
7295
7296 @item -mbig-endian
7297 @opindex mbig-endian
7298 Generate code for a processor running in big-endian mode; the default is
7299 to compile code for a little-endian processor.
7300
7301 @item -mwords-little-endian
7302 @opindex mwords-little-endian
7303 This option only applies when generating code for big-endian processors.
7304 Generate code for a little-endian word order but a big-endian byte
7305 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7306 option should only be used if you require compatibility with code for
7307 big-endian ARM processors generated by versions of the compiler prior to
7308 2.8.
7309
7310 @item -mcpu=@var{name}
7311 @opindex mcpu
7312 This specifies the name of the target ARM processor.  GCC uses this name
7313 to determine what kind of instructions it can emit when generating
7314 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7315 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7316 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7317 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7318 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7319 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7320 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7321 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7322 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7323 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7324 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7325 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7326 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7327 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7328 @samp{ep9312}.
7329
7330 @itemx -mtune=@var{name}
7331 @opindex mtune
7332 This option is very similar to the @option{-mcpu=} option, except that
7333 instead of specifying the actual target processor type, and hence
7334 restricting which instructions can be used, it specifies that GCC should
7335 tune the performance of the code as if the target were of the type
7336 specified in this option, but still choosing the instructions that it
7337 will generate based on the cpu specified by a @option{-mcpu=} option.
7338 For some ARM implementations better performance can be obtained by using
7339 this option.
7340
7341 @item -march=@var{name}
7342 @opindex march
7343 This specifies the name of the target ARM architecture.  GCC uses this
7344 name to determine what kind of instructions it can emit when generating
7345 assembly code.  This option can be used in conjunction with or instead
7346 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7347 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7348 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7349 @samp{iwmmxt}, @samp{ep9312}.
7350
7351 @item -mfpu=@var{name}
7352 @itemx -mfpe=@var{number}
7353 @itemx -mfp=@var{number}
7354 @opindex mfpu
7355 @opindex mfpe
7356 @opindex mfp
7357 This specifies what floating point hardware (or hardware emulation) is
7358 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7359 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7360 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7361 with older versions of GCC@.
7362
7363 If @option{-msoft-float} is specified this specifies the format of
7364 floating point values.
7365
7366 @item -mstructure-size-boundary=@var{n}
7367 @opindex mstructure-size-boundary
7368 The size of all structures and unions will be rounded up to a multiple
7369 of the number of bits set by this option.  Permissible values are 8, 32
7370 and 64.  The default value varies for different toolchains.  For the COFF
7371 targeted toolchain the default value is 8.  A value of 64 is only allowed
7372 if the underlying ABI supports it.
7373
7374 Specifying the larger number can produce faster, more efficient code, but
7375 can also increase the size of the program.  Different values are potentially
7376 incompatible.  Code compiled with one value cannot necessarily expect to
7377 work with code or libraries compiled with another value, if they exchange
7378 information using structures or unions.
7379
7380 @item -mabort-on-noreturn
7381 @opindex mabort-on-noreturn
7382 Generate a call to the function @code{abort} at the end of a
7383 @code{noreturn} function.  It will be executed if the function tries to
7384 return.
7385
7386 @item -mlong-calls
7387 @itemx -mno-long-calls
7388 @opindex mlong-calls
7389 @opindex mno-long-calls
7390 Tells the compiler to perform function calls by first loading the
7391 address of the function into a register and then performing a subroutine
7392 call on this register.  This switch is needed if the target function
7393 will lie outside of the 64 megabyte addressing range of the offset based
7394 version of subroutine call instruction.
7395
7396 Even if this switch is enabled, not all function calls will be turned
7397 into long calls.  The heuristic is that static functions, functions
7398 which have the @samp{short-call} attribute, functions that are inside
7399 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7400 definitions have already been compiled within the current compilation
7401 unit, will not be turned into long calls.  The exception to this rule is
7402 that weak function definitions, functions with the @samp{long-call}
7403 attribute or the @samp{section} attribute, and functions that are within
7404 the scope of a @samp{#pragma long_calls} directive, will always be
7405 turned into long calls.
7406
7407 This feature is not enabled by default.  Specifying
7408 @option{-mno-long-calls} will restore the default behavior, as will
7409 placing the function calls within the scope of a @samp{#pragma
7410 long_calls_off} directive.  Note these switches have no effect on how
7411 the compiler generates code to handle function calls via function
7412 pointers.
7413
7414 @item -mnop-fun-dllimport
7415 @opindex mnop-fun-dllimport
7416 Disable support for the @code{dllimport} attribute.
7417
7418 @item -msingle-pic-base
7419 @opindex msingle-pic-base
7420 Treat the register used for PIC addressing as read-only, rather than
7421 loading it in the prologue for each function.  The run-time system is
7422 responsible for initializing this register with an appropriate value
7423 before execution begins.
7424
7425 @item -mpic-register=@var{reg}
7426 @opindex mpic-register
7427 Specify the register to be used for PIC addressing.  The default is R10
7428 unless stack-checking is enabled, when R9 is used.
7429
7430 @item -mcirrus-fix-invalid-insns
7431 @opindex mcirrus-fix-invalid-insns
7432 @opindex mno-cirrus-fix-invalid-insns
7433 Insert NOPs into the instruction stream to in order to work around
7434 problems with invalid Maverick instruction combinations.  This option
7435 is only valid if the @option{-mcpu=ep9312} option has been used to
7436 enable generation of instructions for the Cirrus Maverick floating
7437 point co-processor.  This option is not enabled by default, since the
7438 problem is only present in older Maverick implementations.  The default
7439 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7440 switch.
7441
7442 @item -mpoke-function-name
7443 @opindex mpoke-function-name
7444 Write the name of each function into the text section, directly
7445 preceding the function prologue.  The generated code is similar to this:
7446
7447 @smallexample
7448      t0
7449          .ascii "arm_poke_function_name", 0
7450          .align
7451      t1
7452          .word 0xff000000 + (t1 - t0)
7453      arm_poke_function_name
7454          mov     ip, sp
7455          stmfd   sp!, @{fp, ip, lr, pc@}
7456          sub     fp, ip, #4
7457 @end smallexample
7458
7459 When performing a stack backtrace, code can inspect the value of
7460 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7461 location @code{pc - 12} and the top 8 bits are set, then we know that
7462 there is a function name embedded immediately preceding this location
7463 and has length @code{((pc[-3]) & 0xff000000)}.
7464
7465 @item -mthumb
7466 @opindex mthumb
7467 Generate code for the 16-bit Thumb instruction set.  The default is to
7468 use the 32-bit ARM instruction set.
7469
7470 @item -mtpcs-frame
7471 @opindex mtpcs-frame
7472 Generate a stack frame that is compliant with the Thumb Procedure Call
7473 Standard for all non-leaf functions.  (A leaf function is one that does
7474 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7475
7476 @item -mtpcs-leaf-frame
7477 @opindex mtpcs-leaf-frame
7478 Generate a stack frame that is compliant with the Thumb Procedure Call
7479 Standard for all leaf functions.  (A leaf function is one that does
7480 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7481
7482 @item -mcallee-super-interworking
7483 @opindex mcallee-super-interworking
7484 Gives all externally visible functions in the file being compiled an ARM
7485 instruction set header which switches to Thumb mode before executing the
7486 rest of the function.  This allows these functions to be called from
7487 non-interworking code.
7488
7489 @item -mcaller-super-interworking
7490 @opindex mcaller-super-interworking
7491 Allows calls via function pointers (including virtual functions) to
7492 execute correctly regardless of whether the target code has been
7493 compiled for interworking or not.  There is a small overhead in the cost
7494 of executing a function pointer if this option is enabled.
7495
7496 @item -mtp=@var{name}
7497 @opindex mtp
7498 Specify the access model for the thread local storage pointer.  The valid
7499 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7500 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7501 (supported in the arm6k architecture), and @option{auto}, which uses the
7502 best available method for the selected processor.  The default setting is
7503 @option{auto}.
7504
7505 @end table
7506
7507 @node AVR Options
7508 @subsection AVR Options
7509 @cindex AVR Options
7510
7511 These options are defined for AVR implementations:
7512
7513 @table @gcctabopt
7514 @item -mmcu=@var{mcu}
7515 @opindex mmcu
7516 Specify ATMEL AVR instruction set or MCU type.
7517
7518 Instruction set avr1 is for the minimal AVR core, not supported by the C
7519 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7520 attiny11, attiny12, attiny15, attiny28).
7521
7522 Instruction set avr2 (default) is for the classic AVR core with up to
7523 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7524 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7525 at90c8534, at90s8535).
7526
7527 Instruction set avr3 is for the classic AVR core with up to 128K program
7528 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7529
7530 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7531 memory space (MCU types: atmega8, atmega83, atmega85).
7532
7533 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7534 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7535 atmega64, atmega128, at43usb355, at94k).
7536
7537 @item -msize
7538 @opindex msize
7539 Output instruction sizes to the asm file.
7540
7541 @item -minit-stack=@var{N}
7542 @opindex minit-stack
7543 Specify the initial stack address, which may be a symbol or numeric value,
7544 @samp{__stack} is the default.
7545
7546 @item -mno-interrupts
7547 @opindex mno-interrupts
7548 Generated code is not compatible with hardware interrupts.
7549 Code size will be smaller.
7550
7551 @item -mcall-prologues
7552 @opindex mcall-prologues
7553 Functions prologues/epilogues expanded as call to appropriate
7554 subroutines.  Code size will be smaller.
7555
7556 @item -mno-tablejump
7557 @opindex mno-tablejump
7558 Do not generate tablejump insns which sometimes increase code size.
7559
7560 @item -mtiny-stack
7561 @opindex mtiny-stack
7562 Change only the low 8 bits of the stack pointer.
7563
7564 @item -mint8
7565 @opindex mint8
7566 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7567 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7568 and long long will be 4 bytes.  Please note that this option does not
7569 comply to the C standards, but it will provide you with smaller code
7570 size.
7571 @end table
7572
7573 @node Blackfin Options
7574 @subsection Blackfin Options
7575 @cindex Blackfin Options
7576
7577 @table @gcctabopt
7578 @item -momit-leaf-frame-pointer
7579 @opindex momit-leaf-frame-pointer
7580 Don't keep the frame pointer in a register for leaf functions.  This
7581 avoids the instructions to save, set up and restore frame pointers and
7582 makes an extra register available in leaf functions.  The option
7583 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7584 which might make debugging harder.
7585
7586 @item -mspecld-anomaly
7587 @opindex mspecld-anomaly
7588 When enabled, the compiler will ensure that the generated code does not
7589 contain speculative loads after jump instructions.  This option is enabled
7590 by default.
7591
7592 @item -mno-specld-anomaly
7593 @opindex mno-specld-anomaly
7594 Don't generate extra code to prevent speculative loads from occurring.
7595
7596 @item -mcsync-anomaly
7597 @opindex mcsync-anomaly
7598 When enabled, the compiler will ensure that the generated code does not
7599 contain CSYNC or SSYNC instructions too soon after conditional branches.
7600 This option is enabled by default.
7601
7602 @item -mno-csync-anomaly
7603 @opindex mno-csync-anomaly
7604 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7605 occurring too soon after a conditional branch.
7606
7607 @item -mlow-64k
7608 @opindex mlow-64k
7609 When enabled, the compiler is free to take advantage of the knowledge that
7610 the entire program fits into the low 64k of memory.
7611
7612 @item -mno-low-64k
7613 @opindex mno-low-64k
7614 Assume that the program is arbitrarily large.  This is the default.
7615
7616 @item -mid-shared-library
7617 @opindex mid-shared-library
7618 Generate code that supports shared libraries via the library ID method.
7619 This allows for execute in place and shared libraries in an environment
7620 without virtual memory management.  This option implies @option{-fPIC}.
7621
7622 @item -mno-id-shared-library
7623 @opindex mno-id-shared-library
7624 Generate code that doesn't assume ID based shared libraries are being used.
7625 This is the default.
7626
7627 @item -mshared-library-id=n
7628 @opindex mshared-library-id
7629 Specified the identification number of the ID based shared library being
7630 compiled.  Specifying a value of 0 will generate more compact code, specifying
7631 other values will force the allocation of that number to the current
7632 library but is no more space or time efficient than omitting this option.
7633
7634 @item -mlong-calls
7635 @itemx -mno-long-calls
7636 @opindex mlong-calls
7637 @opindex mno-long-calls
7638 Tells the compiler to perform function calls by first loading the
7639 address of the function into a register and then performing a subroutine
7640 call on this register.  This switch is needed if the target function
7641 will lie outside of the 24 bit addressing range of the offset based
7642 version of subroutine call instruction.
7643
7644 This feature is not enabled by default.  Specifying
7645 @option{-mno-long-calls} will restore the default behavior.  Note these
7646 switches have no effect on how the compiler generates code to handle
7647 function calls via function pointers.
7648 @end table
7649
7650 @node CRIS Options
7651 @subsection CRIS Options
7652 @cindex CRIS Options
7653
7654 These options are defined specifically for the CRIS ports.
7655
7656 @table @gcctabopt
7657 @item -march=@var{architecture-type}
7658 @itemx -mcpu=@var{architecture-type}
7659 @opindex march
7660 @opindex mcpu
7661 Generate code for the specified architecture.  The choices for
7662 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7663 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7664 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7665 @samp{v10}.
7666
7667 @item -mtune=@var{architecture-type}
7668 @opindex mtune
7669 Tune to @var{architecture-type} everything applicable about the generated
7670 code, except for the ABI and the set of available instructions.  The
7671 choices for @var{architecture-type} are the same as for
7672 @option{-march=@var{architecture-type}}.
7673
7674 @item -mmax-stack-frame=@var{n}
7675 @opindex mmax-stack-frame
7676 Warn when the stack frame of a function exceeds @var{n} bytes.
7677
7678 @item -melinux-stacksize=@var{n}
7679 @opindex melinux-stacksize
7680 Only available with the @samp{cris-axis-aout} target.  Arranges for
7681 indications in the program to the kernel loader that the stack of the
7682 program should be set to @var{n} bytes.
7683
7684 @item -metrax4
7685 @itemx -metrax100
7686 @opindex metrax4
7687 @opindex metrax100
7688 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7689 @option{-march=v3} and @option{-march=v8} respectively.
7690
7691 @item -mmul-bug-workaround
7692 @itemx -mno-mul-bug-workaround
7693 @opindex mmul-bug-workaround
7694 @opindex mno-mul-bug-workaround
7695 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7696 models where it applies.  This option is active by default.
7697
7698 @item -mpdebug
7699 @opindex mpdebug
7700 Enable CRIS-specific verbose debug-related information in the assembly
7701 code.  This option also has the effect to turn off the @samp{#NO_APP}
7702 formatted-code indicator to the assembler at the beginning of the
7703 assembly file.
7704
7705 @item -mcc-init
7706 @opindex mcc-init
7707 Do not use condition-code results from previous instruction; always emit
7708 compare and test instructions before use of condition codes.
7709
7710 @item -mno-side-effects
7711 @opindex mno-side-effects
7712 Do not emit instructions with side-effects in addressing modes other than
7713 post-increment.
7714
7715 @item -mstack-align
7716 @itemx -mno-stack-align
7717 @itemx -mdata-align
7718 @itemx -mno-data-align
7719 @itemx -mconst-align
7720 @itemx -mno-const-align
7721 @opindex mstack-align
7722 @opindex mno-stack-align
7723 @opindex mdata-align
7724 @opindex mno-data-align
7725 @opindex mconst-align
7726 @opindex mno-const-align
7727 These options (no-options) arranges (eliminate arrangements) for the
7728 stack-frame, individual data and constants to be aligned for the maximum
7729 single data access size for the chosen CPU model.  The default is to
7730 arrange for 32-bit alignment.  ABI details such as structure layout are
7731 not affected by these options.
7732
7733 @item -m32-bit
7734 @itemx -m16-bit
7735 @itemx -m8-bit
7736 @opindex m32-bit
7737 @opindex m16-bit
7738 @opindex m8-bit
7739 Similar to the stack- data- and const-align options above, these options
7740 arrange for stack-frame, writable data and constants to all be 32-bit,
7741 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7742
7743 @item -mno-prologue-epilogue
7744 @itemx -mprologue-epilogue
7745 @opindex mno-prologue-epilogue
7746 @opindex mprologue-epilogue
7747 With @option{-mno-prologue-epilogue}, the normal function prologue and
7748 epilogue that sets up the stack-frame are omitted and no return
7749 instructions or return sequences are generated in the code.  Use this
7750 option only together with visual inspection of the compiled code: no
7751 warnings or errors are generated when call-saved registers must be saved,
7752 or storage for local variable needs to be allocated.
7753
7754 @item -mno-gotplt
7755 @itemx -mgotplt
7756 @opindex mno-gotplt
7757 @opindex mgotplt
7758 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7759 instruction sequences that load addresses for functions from the PLT part
7760 of the GOT rather than (traditional on other architectures) calls to the
7761 PLT@.  The default is @option{-mgotplt}.
7762
7763 @item -maout
7764 @opindex maout
7765 Legacy no-op option only recognized with the cris-axis-aout target.
7766
7767 @item -melf
7768 @opindex melf
7769 Legacy no-op option only recognized with the cris-axis-elf and
7770 cris-axis-linux-gnu targets.
7771
7772 @item -melinux
7773 @opindex melinux
7774 Only recognized with the cris-axis-aout target, where it selects a
7775 GNU/linux-like multilib, include files and instruction set for
7776 @option{-march=v8}.
7777
7778 @item -mlinux
7779 @opindex mlinux
7780 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7781
7782 @item -sim
7783 @opindex sim
7784 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7785 to link with input-output functions from a simulator library.  Code,
7786 initialized data and zero-initialized data are allocated consecutively.
7787
7788 @item -sim2
7789 @opindex sim2
7790 Like @option{-sim}, but pass linker options to locate initialized data at
7791 0x40000000 and zero-initialized data at 0x80000000.
7792 @end table
7793
7794 @node CRX Options
7795 @subsection CRX Options
7796 @cindex CRX Options
7797
7798 These options are defined specifically for the CRX ports.
7799
7800 @table @gcctabopt
7801
7802 @item -mmac
7803 @opindex mmac
7804 Enable the use of multiply-accumulate instructions. Disabled by default.
7805
7806 @item -mpush-args
7807 @opindex mpush-args
7808 Push instructions will be used to pass outgoing arguments when functions
7809 are called. Enabled by default.
7810 @end table
7811
7812 @node Darwin Options
7813 @subsection Darwin Options
7814 @cindex Darwin options
7815
7816 These options are defined for all architectures running the Darwin operating
7817 system.
7818
7819 FSF GCC on Darwin does not create ``fat'' object files; it will create
7820 an object file for the single architecture that it was built to
7821 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7822 @option{-arch} options are used; it does so by running the compiler or
7823 linker multiple times and joining the results together with
7824 @file{lipo}.
7825
7826 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7827 @samp{i686}) is determined by the flags that specify the ISA
7828 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7829 @option{-force_cpusubtype_ALL} option can be used to override this.
7830
7831 The Darwin tools vary in their behavior when presented with an ISA
7832 mismatch.  The assembler, @file{as}, will only permit instructions to
7833 be used that are valid for the subtype of the file it is generating,
7834 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7835 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7836 and print an error if asked to create a shared library with a less
7837 restrictive subtype than its input files (for instance, trying to put
7838 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7839 for executables, @file{ld}, will quietly give the executable the most
7840 restrictive subtype of any of its input files.
7841
7842 @table @gcctabopt
7843 @item -F@var{dir}
7844 @opindex F
7845 Add the framework directory @var{dir} to the head of the list of
7846 directories to be searched for header files.  These directories are
7847 interleaved with those specified by @option{-I} options and are
7848 scanned in a left-to-right order.
7849
7850 A framework directory is a directory with frameworks in it.  A
7851 framework is a directory with a @samp{"Headers"} and/or
7852 @samp{"PrivateHeaders"} directory contained directly in it that ends
7853 in @samp{".framework"}.  The name of a framework is the name of this
7854 directory excluding the @samp{".framework"}.  Headers associated with
7855 the framework are found in one of those two directories, with
7856 @samp{"Headers"} being searched first.  A subframework is a framework
7857 directory that is in a framework's @samp{"Frameworks"} directory.
7858 Includes of subframework headers can only appear in a header of a
7859 framework that contains the subframework, or in a sibling subframework
7860 header.  Two subframeworks are siblings if they occur in the same
7861 framework.  A subframework should not have the same name as a
7862 framework, a warning will be issued if this is violated.  Currently a
7863 subframework cannot have subframeworks, in the future, the mechanism
7864 may be extended to support this.  The standard frameworks can be found
7865 in @samp{"/System/Library/Frameworks"} and
7866 @samp{"/Library/Frameworks"}.  An example include looks like
7867 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7868 the name of the framework and header.h is found in the
7869 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7870
7871 @item -gused
7872 @opindex -gused
7873 Emit debugging information for symbols that are used.  For STABS
7874 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7875 This is by default ON@.
7876
7877 @item -gfull
7878 @opindex -gfull
7879 Emit debugging information for all symbols and types.
7880
7881 @item -mmacosx-version-min=@var{version}
7882 The earliest version of MacOS X that this executable will run on
7883 is @var{version}.  Typical values of @var{version} include @code{10.1},
7884 @code{10.2}, and @code{10.3.9}.
7885
7886 The default for this option is to make choices that seem to be most
7887 useful.  
7888
7889 @item -mone-byte-bool
7890 @opindex -mone-byte-bool
7891 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7892 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7893 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7894 option has no effect on x86.
7895
7896 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7897 to generate code that is not binary compatible with code generated
7898 without that switch.  Using this switch may require recompiling all
7899 other modules in a program, including system libraries.  Use this
7900 switch to conform to a non-default data model.
7901
7902 @item -mfix-and-continue
7903 @itemx -ffix-and-continue
7904 @itemx -findirect-data
7905 @opindex mfix-and-continue
7906 @opindex ffix-and-continue
7907 @opindex findirect-data
7908 Generate code suitable for fast turn around development.  Needed to
7909 enable gdb to dynamically load @code{.o} files into already running
7910 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7911 are provided for backwards compatibility.
7912
7913 @item -all_load
7914 @opindex all_load
7915 Loads all members of static archive libraries.
7916 See man ld(1) for more information.
7917
7918 @item -arch_errors_fatal
7919 @opindex arch_errors_fatal
7920 Cause the errors having to do with files that have the wrong architecture
7921 to be fatal.
7922
7923 @item -bind_at_load
7924 @opindex bind_at_load
7925 Causes the output file to be marked such that the dynamic linker will
7926 bind all undefined references when the file is loaded or launched.
7927
7928 @item -bundle
7929 @opindex bundle
7930 Produce a Mach-o bundle format file.
7931 See man ld(1) for more information.
7932
7933 @item -bundle_loader @var{executable}
7934 @opindex bundle_loader
7935 This option specifies the @var{executable} that will be loading the build
7936 output file being linked.  See man ld(1) for more information.
7937
7938 @item -dynamiclib
7939 @opindex -dynamiclib
7940 When passed this option, GCC will produce a dynamic library instead of
7941 an executable when linking, using the Darwin @file{libtool} command.
7942
7943 @item -force_cpusubtype_ALL
7944 @opindex -force_cpusubtype_ALL
7945 This causes GCC's output file to have the @var{ALL} subtype, instead of
7946 one controlled by the @option{-mcpu} or @option{-march} option.
7947
7948 @item -allowable_client  @var{client_name}
7949 @itemx -client_name
7950 @itemx -compatibility_version
7951 @itemx -current_version
7952 @itemx -dead_strip
7953 @itemx -dependency-file
7954 @itemx -dylib_file
7955 @itemx -dylinker_install_name
7956 @itemx -dynamic
7957 @itemx -exported_symbols_list
7958 @itemx -filelist
7959 @itemx -flat_namespace
7960 @itemx -force_flat_namespace
7961 @itemx -headerpad_max_install_names
7962 @itemx -image_base
7963 @itemx -init
7964 @itemx -install_name
7965 @itemx -keep_private_externs
7966 @itemx -multi_module
7967 @itemx -multiply_defined
7968 @itemx -multiply_defined_unused
7969 @itemx -noall_load
7970 @itemx -no_dead_strip_inits_and_terms
7971 @itemx -nofixprebinding
7972 @itemx -nomultidefs
7973 @itemx -noprebind
7974 @itemx -noseglinkedit
7975 @itemx -pagezero_size
7976 @itemx -prebind
7977 @itemx -prebind_all_twolevel_modules
7978 @itemx -private_bundle
7979 @itemx -read_only_relocs
7980 @itemx -sectalign
7981 @itemx -sectobjectsymbols
7982 @itemx -whyload
7983 @itemx -seg1addr
7984 @itemx -sectcreate
7985 @itemx -sectobjectsymbols
7986 @itemx -sectorder
7987 @itemx -segaddr
7988 @itemx -segs_read_only_addr
7989 @itemx -segs_read_write_addr
7990 @itemx -seg_addr_table
7991 @itemx -seg_addr_table_filename
7992 @itemx -seglinkedit
7993 @itemx -segprot
7994 @itemx -segs_read_only_addr
7995 @itemx -segs_read_write_addr
7996 @itemx -single_module
7997 @itemx -static
7998 @itemx -sub_library
7999 @itemx -sub_umbrella
8000 @itemx -twolevel_namespace
8001 @itemx -umbrella
8002 @itemx -undefined
8003 @itemx -unexported_symbols_list
8004 @itemx -weak_reference_mismatches
8005 @itemx -whatsloaded
8006
8007 @opindex allowable_client
8008 @opindex client_name
8009 @opindex compatibility_version
8010 @opindex current_version
8011 @opindex dead_strip
8012 @opindex dependency-file
8013 @opindex dylib_file
8014 @opindex dylinker_install_name
8015 @opindex dynamic
8016 @opindex exported_symbols_list
8017 @opindex filelist
8018 @opindex flat_namespace
8019 @opindex force_flat_namespace
8020 @opindex headerpad_max_install_names
8021 @opindex image_base
8022 @opindex init
8023 @opindex install_name
8024 @opindex keep_private_externs
8025 @opindex multi_module
8026 @opindex multiply_defined
8027 @opindex multiply_defined_unused
8028 @opindex noall_load
8029 @opindex no_dead_strip_inits_and_terms
8030 @opindex nofixprebinding
8031 @opindex nomultidefs
8032 @opindex noprebind
8033 @opindex noseglinkedit
8034 @opindex pagezero_size
8035 @opindex prebind
8036 @opindex prebind_all_twolevel_modules
8037 @opindex private_bundle
8038 @opindex read_only_relocs
8039 @opindex sectalign
8040 @opindex sectobjectsymbols
8041 @opindex whyload
8042 @opindex seg1addr
8043 @opindex sectcreate
8044 @opindex sectobjectsymbols
8045 @opindex sectorder
8046 @opindex segaddr
8047 @opindex segs_read_only_addr
8048 @opindex segs_read_write_addr
8049 @opindex seg_addr_table
8050 @opindex seg_addr_table_filename
8051 @opindex seglinkedit
8052 @opindex segprot
8053 @opindex segs_read_only_addr
8054 @opindex segs_read_write_addr
8055 @opindex single_module
8056 @opindex static
8057 @opindex sub_library
8058 @opindex sub_umbrella
8059 @opindex twolevel_namespace
8060 @opindex umbrella
8061 @opindex undefined
8062 @opindex unexported_symbols_list
8063 @opindex weak_reference_mismatches
8064 @opindex whatsloaded
8065
8066 These options are passed to the Darwin linker.  The Darwin linker man page
8067 describes them in detail.
8068 @end table
8069
8070 @node DEC Alpha Options
8071 @subsection DEC Alpha Options
8072
8073 These @samp{-m} options are defined for the DEC Alpha implementations:
8074
8075 @table @gcctabopt
8076 @item -mno-soft-float
8077 @itemx -msoft-float
8078 @opindex mno-soft-float
8079 @opindex msoft-float
8080 Use (do not use) the hardware floating-point instructions for
8081 floating-point operations.  When @option{-msoft-float} is specified,
8082 functions in @file{libgcc.a} will be used to perform floating-point
8083 operations.  Unless they are replaced by routines that emulate the
8084 floating-point operations, or compiled in such a way as to call such
8085 emulations routines, these routines will issue floating-point
8086 operations.   If you are compiling for an Alpha without floating-point
8087 operations, you must ensure that the library is built so as not to call
8088 them.
8089
8090 Note that Alpha implementations without floating-point operations are
8091 required to have floating-point registers.
8092
8093 @item -mfp-reg
8094 @itemx -mno-fp-regs
8095 @opindex mfp-reg
8096 @opindex mno-fp-regs
8097 Generate code that uses (does not use) the floating-point register set.
8098 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8099 register set is not used, floating point operands are passed in integer
8100 registers as if they were integers and floating-point results are passed
8101 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8102 so any function with a floating-point argument or return value called by code
8103 compiled with @option{-mno-fp-regs} must also be compiled with that
8104 option.
8105
8106 A typical use of this option is building a kernel that does not use,
8107 and hence need not save and restore, any floating-point registers.
8108
8109 @item -mieee
8110 @opindex mieee
8111 The Alpha architecture implements floating-point hardware optimized for
8112 maximum performance.  It is mostly compliant with the IEEE floating
8113 point standard.  However, for full compliance, software assistance is
8114 required.  This option generates code fully IEEE compliant code
8115 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8116 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8117 defined during compilation.  The resulting code is less efficient but is
8118 able to correctly support denormalized numbers and exceptional IEEE
8119 values such as not-a-number and plus/minus infinity.  Other Alpha
8120 compilers call this option @option{-ieee_with_no_inexact}.
8121
8122 @item -mieee-with-inexact
8123 @opindex mieee-with-inexact
8124 This is like @option{-mieee} except the generated code also maintains
8125 the IEEE @var{inexact-flag}.  Turning on this option causes the
8126 generated code to implement fully-compliant IEEE math.  In addition to
8127 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8128 macro.  On some Alpha implementations the resulting code may execute
8129 significantly slower than the code generated by default.  Since there is
8130 very little code that depends on the @var{inexact-flag}, you should
8131 normally not specify this option.  Other Alpha compilers call this
8132 option @option{-ieee_with_inexact}.
8133
8134 @item -mfp-trap-mode=@var{trap-mode}
8135 @opindex mfp-trap-mode
8136 This option controls what floating-point related traps are enabled.
8137 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8138 The trap mode can be set to one of four values:
8139
8140 @table @samp
8141 @item n
8142 This is the default (normal) setting.  The only traps that are enabled
8143 are the ones that cannot be disabled in software (e.g., division by zero
8144 trap).
8145
8146 @item u
8147 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8148 as well.
8149
8150 @item su
8151 Like @samp{su}, but the instructions are marked to be safe for software
8152 completion (see Alpha architecture manual for details).
8153
8154 @item sui
8155 Like @samp{su}, but inexact traps are enabled as well.
8156 @end table
8157
8158 @item -mfp-rounding-mode=@var{rounding-mode}
8159 @opindex mfp-rounding-mode
8160 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8161 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8162 of:
8163
8164 @table @samp
8165 @item n
8166 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8167 the nearest machine number or towards the even machine number in case
8168 of a tie.
8169
8170 @item m
8171 Round towards minus infinity.
8172
8173 @item c
8174 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8175
8176 @item d
8177 Dynamic rounding mode.  A field in the floating point control register
8178 (@var{fpcr}, see Alpha architecture reference manual) controls the
8179 rounding mode in effect.  The C library initializes this register for
8180 rounding towards plus infinity.  Thus, unless your program modifies the
8181 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8182 @end table
8183
8184 @item -mtrap-precision=@var{trap-precision}
8185 @opindex mtrap-precision
8186 In the Alpha architecture, floating point traps are imprecise.  This
8187 means without software assistance it is impossible to recover from a
8188 floating trap and program execution normally needs to be terminated.
8189 GCC can generate code that can assist operating system trap handlers
8190 in determining the exact location that caused a floating point trap.
8191 Depending on the requirements of an application, different levels of
8192 precisions can be selected:
8193
8194 @table @samp
8195 @item p
8196 Program precision.  This option is the default and means a trap handler
8197 can only identify which program caused a floating point exception.
8198
8199 @item f
8200 Function precision.  The trap handler can determine the function that
8201 caused a floating point exception.
8202
8203 @item i
8204 Instruction precision.  The trap handler can determine the exact
8205 instruction that caused a floating point exception.
8206 @end table
8207
8208 Other Alpha compilers provide the equivalent options called
8209 @option{-scope_safe} and @option{-resumption_safe}.
8210
8211 @item -mieee-conformant
8212 @opindex mieee-conformant
8213 This option marks the generated code as IEEE conformant.  You must not
8214 use this option unless you also specify @option{-mtrap-precision=i} and either
8215 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8216 is to emit the line @samp{.eflag 48} in the function prologue of the
8217 generated assembly file.  Under DEC Unix, this has the effect that
8218 IEEE-conformant math library routines will be linked in.
8219
8220 @item -mbuild-constants
8221 @opindex mbuild-constants
8222 Normally GCC examines a 32- or 64-bit integer constant to
8223 see if it can construct it from smaller constants in two or three
8224 instructions.  If it cannot, it will output the constant as a literal and
8225 generate code to load it from the data segment at runtime.
8226
8227 Use this option to require GCC to construct @emph{all} integer constants
8228 using code, even if it takes more instructions (the maximum is six).
8229
8230 You would typically use this option to build a shared library dynamic
8231 loader.  Itself a shared library, it must relocate itself in memory
8232 before it can find the variables and constants in its own data segment.
8233
8234 @item -malpha-as
8235 @itemx -mgas
8236 @opindex malpha-as
8237 @opindex mgas
8238 Select whether to generate code to be assembled by the vendor-supplied
8239 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8240
8241 @item -mbwx
8242 @itemx -mno-bwx
8243 @itemx -mcix
8244 @itemx -mno-cix
8245 @itemx -mfix
8246 @itemx -mno-fix
8247 @itemx -mmax
8248 @itemx -mno-max
8249 @opindex mbwx
8250 @opindex mno-bwx
8251 @opindex mcix
8252 @opindex mno-cix
8253 @opindex mfix
8254 @opindex mno-fix
8255 @opindex mmax
8256 @opindex mno-max
8257 Indicate whether GCC should generate code to use the optional BWX,
8258 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8259 sets supported by the CPU type specified via @option{-mcpu=} option or that
8260 of the CPU on which GCC was built if none was specified.
8261
8262 @item -mfloat-vax
8263 @itemx -mfloat-ieee
8264 @opindex mfloat-vax
8265 @opindex mfloat-ieee
8266 Generate code that uses (does not use) VAX F and G floating point
8267 arithmetic instead of IEEE single and double precision.
8268
8269 @item -mexplicit-relocs
8270 @itemx -mno-explicit-relocs
8271 @opindex mexplicit-relocs
8272 @opindex mno-explicit-relocs
8273 Older Alpha assemblers provided no way to generate symbol relocations
8274 except via assembler macros.  Use of these macros does not allow
8275 optimal instruction scheduling.  GNU binutils as of version 2.12
8276 supports a new syntax that allows the compiler to explicitly mark
8277 which relocations should apply to which instructions.  This option
8278 is mostly useful for debugging, as GCC detects the capabilities of
8279 the assembler when it is built and sets the default accordingly.
8280
8281 @item -msmall-data
8282 @itemx -mlarge-data
8283 @opindex msmall-data
8284 @opindex mlarge-data
8285 When @option{-mexplicit-relocs} is in effect, static data is
8286 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8287 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8288 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8289 16-bit relocations off of the @code{$gp} register.  This limits the
8290 size of the small data area to 64KB, but allows the variables to be
8291 directly accessed via a single instruction.
8292
8293 The default is @option{-mlarge-data}.  With this option the data area
8294 is limited to just below 2GB@.  Programs that require more than 2GB of
8295 data must use @code{malloc} or @code{mmap} to allocate the data in the
8296 heap instead of in the program's data segment.
8297
8298 When generating code for shared libraries, @option{-fpic} implies
8299 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8300
8301 @item -msmall-text
8302 @itemx -mlarge-text
8303 @opindex msmall-text
8304 @opindex mlarge-text
8305 When @option{-msmall-text} is used, the compiler assumes that the
8306 code of the entire program (or shared library) fits in 4MB, and is
8307 thus reachable with a branch instruction.  When @option{-msmall-data}
8308 is used, the compiler can assume that all local symbols share the
8309 same @code{$gp} value, and thus reduce the number of instructions
8310 required for a function call from 4 to 1.
8311
8312 The default is @option{-mlarge-text}.
8313
8314 @item -mcpu=@var{cpu_type}
8315 @opindex mcpu
8316 Set the instruction set and instruction scheduling parameters for
8317 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8318 style name or the corresponding chip number.  GCC supports scheduling
8319 parameters for the EV4, EV5 and EV6 family of processors and will
8320 choose the default values for the instruction set from the processor
8321 you specify.  If you do not specify a processor type, GCC will default
8322 to the processor on which the compiler was built.
8323
8324 Supported values for @var{cpu_type} are
8325
8326 @table @samp
8327 @item ev4
8328 @itemx ev45
8329 @itemx 21064
8330 Schedules as an EV4 and has no instruction set extensions.
8331
8332 @item ev5
8333 @itemx 21164
8334 Schedules as an EV5 and has no instruction set extensions.
8335
8336 @item ev56
8337 @itemx 21164a
8338 Schedules as an EV5 and supports the BWX extension.
8339
8340 @item pca56
8341 @itemx 21164pc
8342 @itemx 21164PC
8343 Schedules as an EV5 and supports the BWX and MAX extensions.
8344
8345 @item ev6
8346 @itemx 21264
8347 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8348
8349 @item ev67
8350 @itemx 21264a
8351 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8352 @end table
8353
8354 @item -mtune=@var{cpu_type}
8355 @opindex mtune
8356 Set only the instruction scheduling parameters for machine type
8357 @var{cpu_type}.  The instruction set is not changed.
8358
8359 @item -mmemory-latency=@var{time}
8360 @opindex mmemory-latency
8361 Sets the latency the scheduler should assume for typical memory
8362 references as seen by the application.  This number is highly
8363 dependent on the memory access patterns used by the application
8364 and the size of the external cache on the machine.
8365
8366 Valid options for @var{time} are
8367
8368 @table @samp
8369 @item @var{number}
8370 A decimal number representing clock cycles.
8371
8372 @item L1
8373 @itemx L2
8374 @itemx L3
8375 @itemx main
8376 The compiler contains estimates of the number of clock cycles for
8377 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8378 (also called Dcache, Scache, and Bcache), as well as to main memory.
8379 Note that L3 is only valid for EV5.
8380
8381 @end table
8382 @end table
8383
8384 @node DEC Alpha/VMS Options
8385 @subsection DEC Alpha/VMS Options
8386
8387 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8388
8389 @table @gcctabopt
8390 @item -mvms-return-codes
8391 @opindex mvms-return-codes
8392 Return VMS condition codes from main.  The default is to return POSIX
8393 style condition (e.g.@ error) codes.
8394 @end table
8395
8396 @node FRV Options
8397 @subsection FRV Options
8398 @cindex FRV Options
8399
8400 @table @gcctabopt
8401 @item -mgpr-32
8402 @opindex mgpr-32
8403
8404 Only use the first 32 general purpose registers.
8405
8406 @item -mgpr-64
8407 @opindex mgpr-64
8408
8409 Use all 64 general purpose registers.
8410
8411 @item -mfpr-32
8412 @opindex mfpr-32
8413
8414 Use only the first 32 floating point registers.
8415
8416 @item -mfpr-64
8417 @opindex mfpr-64
8418
8419 Use all 64 floating point registers
8420
8421 @item -mhard-float
8422 @opindex mhard-float
8423
8424 Use hardware instructions for floating point operations.
8425
8426 @item -msoft-float
8427 @opindex msoft-float
8428
8429 Use library routines for floating point operations.
8430
8431 @item -malloc-cc
8432 @opindex malloc-cc
8433
8434 Dynamically allocate condition code registers.
8435
8436 @item -mfixed-cc
8437 @opindex mfixed-cc
8438
8439 Do not try to dynamically allocate condition code registers, only
8440 use @code{icc0} and @code{fcc0}.
8441
8442 @item -mdword
8443 @opindex mdword
8444
8445 Change ABI to use double word insns.
8446
8447 @item -mno-dword
8448 @opindex mno-dword
8449
8450 Do not use double word instructions.
8451
8452 @item -mdouble
8453 @opindex mdouble
8454
8455 Use floating point double instructions.
8456
8457 @item -mno-double
8458 @opindex mno-double
8459
8460 Do not use floating point double instructions.
8461
8462 @item -mmedia
8463 @opindex mmedia
8464
8465 Use media instructions.
8466
8467 @item -mno-media
8468 @opindex mno-media
8469
8470 Do not use media instructions.
8471
8472 @item -mmuladd
8473 @opindex mmuladd
8474
8475 Use multiply and add/subtract instructions.
8476
8477 @item -mno-muladd
8478 @opindex mno-muladd
8479
8480 Do not use multiply and add/subtract instructions.
8481
8482 @item -mfdpic
8483 @opindex mfdpic
8484
8485 Select the FDPIC ABI, that uses function descriptors to represent
8486 pointers to functions.  Without any PIC/PIE-related options, it
8487 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8488 assumes GOT entries and small data are within a 12-bit range from the
8489 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8490 are computed with 32 bits.
8491
8492 @item -minline-plt
8493 @opindex minline-plt
8494
8495 Enable inlining of PLT entries in function calls to functions that are
8496 not known to bind locally.  It has no effect without @option{-mfdpic}.
8497 It's enabled by default if optimizing for speed and compiling for
8498 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8499 optimization option such as @option{-O3} or above is present in the
8500 command line.
8501
8502 @item -mTLS
8503 @opindex TLS
8504
8505 Assume a large TLS segment when generating thread-local code.
8506
8507 @item -mtls
8508 @opindex tls
8509
8510 Do not assume a large TLS segment when generating thread-local code.
8511
8512 @item -mgprel-ro
8513 @opindex mgprel-ro
8514
8515 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8516 that is known to be in read-only sections.  It's enabled by default,
8517 except for @option{-fpic} or @option{-fpie}: even though it may help
8518 make the global offset table smaller, it trades 1 instruction for 4.
8519 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8520 one of which may be shared by multiple symbols, and it avoids the need
8521 for a GOT entry for the referenced symbol, so it's more likely to be a
8522 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8523
8524 @item -multilib-library-pic
8525 @opindex multilib-library-pic
8526
8527 Link with the (library, not FD) pic libraries.  It's implied by
8528 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8529 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8530 it explicitly.
8531
8532 @item -mlinked-fp
8533 @opindex mlinked-fp
8534
8535 Follow the EABI requirement of always creating a frame pointer whenever
8536 a stack frame is allocated.  This option is enabled by default and can
8537 be disabled with @option{-mno-linked-fp}.
8538
8539 @item -mlong-calls
8540 @opindex mlong-calls
8541
8542 Use indirect addressing to call functions outside the current
8543 compilation unit.  This allows the functions to be placed anywhere
8544 within the 32-bit address space.
8545
8546 @item -malign-labels
8547 @opindex malign-labels
8548
8549 Try to align labels to an 8-byte boundary by inserting nops into the
8550 previous packet.  This option only has an effect when VLIW packing
8551 is enabled.  It doesn't create new packets; it merely adds nops to
8552 existing ones.
8553
8554 @item -mlibrary-pic
8555 @opindex mlibrary-pic
8556
8557 Generate position-independent EABI code.
8558
8559 @item -macc-4
8560 @opindex macc-4
8561
8562 Use only the first four media accumulator registers.
8563
8564 @item -macc-8
8565 @opindex macc-8
8566
8567 Use all eight media accumulator registers.
8568
8569 @item -mpack
8570 @opindex mpack
8571
8572 Pack VLIW instructions.
8573
8574 @item -mno-pack
8575 @opindex mno-pack
8576
8577 Do not pack VLIW instructions.
8578
8579 @item -mno-eflags
8580 @opindex mno-eflags
8581
8582 Do not mark ABI switches in e_flags.
8583
8584 @item -mcond-move
8585 @opindex mcond-move
8586
8587 Enable the use of conditional-move instructions (default).
8588
8589 This switch is mainly for debugging the compiler and will likely be removed
8590 in a future version.
8591
8592 @item -mno-cond-move
8593 @opindex mno-cond-move
8594
8595 Disable the use of conditional-move instructions.
8596
8597 This switch is mainly for debugging the compiler and will likely be removed
8598 in a future version.
8599
8600 @item -mscc
8601 @opindex mscc
8602
8603 Enable the use of conditional set instructions (default).
8604
8605 This switch is mainly for debugging the compiler and will likely be removed
8606 in a future version.
8607
8608 @item -mno-scc
8609 @opindex mno-scc
8610
8611 Disable the use of conditional set instructions.
8612
8613 This switch is mainly for debugging the compiler and will likely be removed
8614 in a future version.
8615
8616 @item -mcond-exec
8617 @opindex mcond-exec
8618
8619 Enable the use of conditional execution (default).
8620
8621 This switch is mainly for debugging the compiler and will likely be removed
8622 in a future version.
8623
8624 @item -mno-cond-exec
8625 @opindex mno-cond-exec
8626
8627 Disable the use of conditional execution.
8628
8629 This switch is mainly for debugging the compiler and will likely be removed
8630 in a future version.
8631
8632 @item -mvliw-branch
8633 @opindex mvliw-branch
8634
8635 Run a pass to pack branches into VLIW instructions (default).
8636
8637 This switch is mainly for debugging the compiler and will likely be removed
8638 in a future version.
8639
8640 @item -mno-vliw-branch
8641 @opindex mno-vliw-branch
8642
8643 Do not run a pass to pack branches into VLIW instructions.
8644
8645 This switch is mainly for debugging the compiler and will likely be removed
8646 in a future version.
8647
8648 @item -mmulti-cond-exec
8649 @opindex mmulti-cond-exec
8650
8651 Enable optimization of @code{&&} and @code{||} in conditional execution
8652 (default).
8653
8654 This switch is mainly for debugging the compiler and will likely be removed
8655 in a future version.
8656
8657 @item -mno-multi-cond-exec
8658 @opindex mno-multi-cond-exec
8659
8660 Disable optimization of @code{&&} and @code{||} in conditional execution.
8661
8662 This switch is mainly for debugging the compiler and will likely be removed
8663 in a future version.
8664
8665 @item -mnested-cond-exec
8666 @opindex mnested-cond-exec
8667
8668 Enable nested conditional execution optimizations (default).
8669
8670 This switch is mainly for debugging the compiler and will likely be removed
8671 in a future version.
8672
8673 @item -mno-nested-cond-exec
8674 @opindex mno-nested-cond-exec
8675
8676 Disable nested conditional execution optimizations.
8677
8678 This switch is mainly for debugging the compiler and will likely be removed
8679 in a future version.
8680
8681 @item -moptimize-membar
8682 @opindex moptimize-membar
8683
8684 This switch removes redundant @code{membar} instructions from the
8685 compiler generated code.  It is enabled by default.
8686
8687 @item -mno-optimize-membar
8688 @opindex mno-optimize-membar
8689
8690 This switch disables the automatic removal of redundant @code{membar}
8691 instructions from the generated code.
8692
8693 @item -mtomcat-stats
8694 @opindex mtomcat-stats
8695
8696 Cause gas to print out tomcat statistics.
8697
8698 @item -mcpu=@var{cpu}
8699 @opindex mcpu
8700
8701 Select the processor type for which to generate code.  Possible values are
8702 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8703 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8704
8705 @end table
8706
8707 @node H8/300 Options
8708 @subsection H8/300 Options
8709
8710 These @samp{-m} options are defined for the H8/300 implementations:
8711
8712 @table @gcctabopt
8713 @item -mrelax
8714 @opindex mrelax
8715 Shorten some address references at link time, when possible; uses the
8716 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8717 ld, Using ld}, for a fuller description.
8718
8719 @item -mh
8720 @opindex mh
8721 Generate code for the H8/300H@.
8722
8723 @item -ms
8724 @opindex ms
8725 Generate code for the H8S@.
8726
8727 @item -mn
8728 @opindex mn
8729 Generate code for the H8S and H8/300H in the normal mode.  This switch
8730 must be used either with @option{-mh} or @option{-ms}.
8731
8732 @item -ms2600
8733 @opindex ms2600
8734 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8735
8736 @item -mint32
8737 @opindex mint32
8738 Make @code{int} data 32 bits by default.
8739
8740 @item -malign-300
8741 @opindex malign-300
8742 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8743 The default for the H8/300H and H8S is to align longs and floats on 4
8744 byte boundaries.
8745 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8746 This option has no effect on the H8/300.
8747 @end table
8748
8749 @node HPPA Options
8750 @subsection HPPA Options
8751 @cindex HPPA Options
8752
8753 These @samp{-m} options are defined for the HPPA family of computers:
8754
8755 @table @gcctabopt
8756 @item -march=@var{architecture-type}
8757 @opindex march
8758 Generate code for the specified architecture.  The choices for
8759 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8760 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8761 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8762 architecture option for your machine.  Code compiled for lower numbered
8763 architectures will run on higher numbered architectures, but not the
8764 other way around.
8765
8766 @item -mpa-risc-1-0
8767 @itemx -mpa-risc-1-1
8768 @itemx -mpa-risc-2-0
8769 @opindex mpa-risc-1-0
8770 @opindex mpa-risc-1-1
8771 @opindex mpa-risc-2-0
8772 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8773
8774 @item -mbig-switch
8775 @opindex mbig-switch
8776 Generate code suitable for big switch tables.  Use this option only if
8777 the assembler/linker complain about out of range branches within a switch
8778 table.
8779
8780 @item -mjump-in-delay
8781 @opindex mjump-in-delay
8782 Fill delay slots of function calls with unconditional jump instructions
8783 by modifying the return pointer for the function call to be the target
8784 of the conditional jump.
8785
8786 @item -mdisable-fpregs
8787 @opindex mdisable-fpregs
8788 Prevent floating point registers from being used in any manner.  This is
8789 necessary for compiling kernels which perform lazy context switching of
8790 floating point registers.  If you use this option and attempt to perform
8791 floating point operations, the compiler will abort.
8792
8793 @item -mdisable-indexing
8794 @opindex mdisable-indexing
8795 Prevent the compiler from using indexing address modes.  This avoids some
8796 rather obscure problems when compiling MIG generated code under MACH@.
8797
8798 @item -mno-space-regs
8799 @opindex mno-space-regs
8800 Generate code that assumes the target has no space registers.  This allows
8801 GCC to generate faster indirect calls and use unscaled index address modes.
8802
8803 Such code is suitable for level 0 PA systems and kernels.
8804
8805 @item -mfast-indirect-calls
8806 @opindex mfast-indirect-calls
8807 Generate code that assumes calls never cross space boundaries.  This
8808 allows GCC to emit code which performs faster indirect calls.
8809
8810 This option will not work in the presence of shared libraries or nested
8811 functions.
8812
8813 @item -mfixed-range=@var{register-range}
8814 @opindex mfixed-range
8815 Generate code treating the given register range as fixed registers.
8816 A fixed register is one that the register allocator can not use.  This is
8817 useful when compiling kernel code.  A register range is specified as
8818 two registers separated by a dash.  Multiple register ranges can be
8819 specified separated by a comma.
8820
8821 @item -mlong-load-store
8822 @opindex mlong-load-store
8823 Generate 3-instruction load and store sequences as sometimes required by
8824 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8825 the HP compilers.
8826
8827 @item -mportable-runtime
8828 @opindex mportable-runtime
8829 Use the portable calling conventions proposed by HP for ELF systems.
8830
8831 @item -mgas
8832 @opindex mgas
8833 Enable the use of assembler directives only GAS understands.
8834
8835 @item -mschedule=@var{cpu-type}
8836 @opindex mschedule
8837 Schedule code according to the constraints for the machine type
8838 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8839 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8840 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8841 proper scheduling option for your machine.  The default scheduling is
8842 @samp{8000}.
8843
8844 @item -mlinker-opt
8845 @opindex mlinker-opt
8846 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8847 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8848 linkers in which they give bogus error messages when linking some programs.
8849
8850 @item -msoft-float
8851 @opindex msoft-float
8852 Generate output containing library calls for floating point.
8853 @strong{Warning:} the requisite libraries are not available for all HPPA
8854 targets.  Normally the facilities of the machine's usual C compiler are
8855 used, but this cannot be done directly in cross-compilation.  You must make
8856 your own arrangements to provide suitable library functions for
8857 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8858 does provide software floating point support.
8859
8860 @option{-msoft-float} changes the calling convention in the output file;
8861 therefore, it is only useful if you compile @emph{all} of a program with
8862 this option.  In particular, you need to compile @file{libgcc.a}, the
8863 library that comes with GCC, with @option{-msoft-float} in order for
8864 this to work.
8865
8866 @item -msio
8867 @opindex msio
8868 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8869 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8870 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8871 options are available under HP-UX and HI-UX@.
8872
8873 @item -mgnu-ld
8874 @opindex gnu-ld
8875 Use GNU ld specific options.  This passes @option{-shared} to ld when
8876 building a shared library.  It is the default when GCC is configured,
8877 explicitly or implicitly, with the GNU linker.  This option does not
8878 have any affect on which ld is called, it only changes what parameters
8879 are passed to that ld.  The ld that is called is determined by the
8880 @option{--with-ld} configure option, GCC's program search path, and
8881 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8882 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8883 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8884
8885 @item -mhp-ld
8886 @opindex hp-ld
8887 Use HP ld specific options.  This passes @option{-b} to ld when building
8888 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8889 links.  It is the default when GCC is configured, explicitly or
8890 implicitly, with the HP linker.  This option does not have any affect on
8891 which ld is called, it only changes what parameters are passed to that
8892 ld.  The ld that is called is determined by the @option{--with-ld}
8893 configure option, GCC's program search path, and finally by the user's
8894 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8895 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8896 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8897
8898 @item -mlong-calls
8899 @opindex mno-long-calls
8900 Generate code that uses long call sequences.  This ensures that a call
8901 is always able to reach linker generated stubs.  The default is to generate
8902 long calls only when the distance from the call site to the beginning
8903 of the function or translation unit, as the case may be, exceeds a
8904 predefined limit set by the branch type being used.  The limits for
8905 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8906 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8907 240,000 bytes.
8908
8909 Distances are measured from the beginning of functions when using the
8910 @option{-ffunction-sections} option, or when using the @option{-mgas}
8911 and @option{-mno-portable-runtime} options together under HP-UX with
8912 the SOM linker.
8913
8914 It is normally not desirable to use this option as it will degrade
8915 performance.  However, it may be useful in large applications,
8916 particularly when partial linking is used to build the application.
8917
8918 The types of long calls used depends on the capabilities of the
8919 assembler and linker, and the type of code being generated.  The
8920 impact on systems that support long absolute calls, and long pic
8921 symbol-difference or pc-relative calls should be relatively small.
8922 However, an indirect call is used on 32-bit ELF systems in pic code
8923 and it is quite long.
8924
8925 @item -munix=@var{unix-std}
8926 @opindex march
8927 Generate compiler predefines and select a startfile for the specified
8928 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8929 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8930 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8931 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8932 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8933 and later.
8934
8935 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8936 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8937 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8938 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8939 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8940 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8941
8942 It is @emph{important} to note that this option changes the interfaces
8943 for various library routines.  It also affects the operational behavior
8944 of the C library.  Thus, @emph{extreme} care is needed in using this
8945 option.
8946
8947 Library code that is intended to operate with more than one UNIX
8948 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8949 as appropriate.  Most GNU software doesn't provide this capability.
8950
8951 @item -nolibdld
8952 @opindex nolibdld
8953 Suppress the generation of link options to search libdld.sl when the
8954 @option{-static} option is specified on HP-UX 10 and later.
8955
8956 @item -static
8957 @opindex static
8958 The HP-UX implementation of setlocale in libc has a dependency on
8959 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8960 when the @option{-static} option is specified, special link options
8961 are needed to resolve this dependency.
8962
8963 On HP-UX 10 and later, the GCC driver adds the necessary options to
8964 link with libdld.sl when the @option{-static} option is specified.
8965 This causes the resulting binary to be dynamic.  On the 64-bit port,
8966 the linkers generate dynamic binaries by default in any case.  The
8967 @option{-nolibdld} option can be used to prevent the GCC driver from
8968 adding these link options.
8969
8970 @item -threads
8971 @opindex threads
8972 Add support for multithreading with the @dfn{dce thread} library
8973 under HP-UX@.  This option sets flags for both the preprocessor and
8974 linker.
8975 @end table
8976
8977 @node i386 and x86-64 Options
8978 @subsection Intel 386 and AMD x86-64 Options
8979 @cindex i386 Options
8980 @cindex x86-64 Options
8981 @cindex Intel 386 Options
8982 @cindex AMD x86-64 Options
8983
8984 These @samp{-m} options are defined for the i386 and x86-64 family of
8985 computers:
8986
8987 @table @gcctabopt
8988 @item -mtune=@var{cpu-type}
8989 @opindex mtune
8990 Tune to @var{cpu-type} everything applicable about the generated code, except
8991 for the ABI and the set of available instructions.  The choices for
8992 @var{cpu-type} are:
8993 @table @emph
8994 @item i386
8995 Original Intel's i386 CPU@.
8996 @item i486
8997 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8998 @item i586, pentium
8999 Intel Pentium CPU with no MMX support.
9000 @item pentium-mmx
9001 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9002 @item i686, pentiumpro
9003 Intel PentiumPro CPU@.
9004 @item pentium2
9005 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9006 @item pentium3, pentium3m
9007 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9008 support.
9009 @item pentium-m
9010 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9011 support.  Used by Centrino notebooks.
9012 @item pentium4, pentium4m
9013 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9014 @item prescott
9015 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9016 set support.
9017 @item nocona
9018 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9019 SSE2 and SSE3 instruction set support.
9020 @item k6
9021 AMD K6 CPU with MMX instruction set support.
9022 @item k6-2, k6-3
9023 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9024 @item athlon, athlon-tbird
9025 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9026 support.
9027 @item athlon-4, athlon-xp, athlon-mp
9028 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9029 instruction set support.
9030 @item k8, opteron, athlon64, athlon-fx
9031 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9032 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9033 @item winchip-c6
9034 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9035 set support.
9036 @item winchip2
9037 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9038 instruction set support.
9039 @item c3
9040 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9041 implemented for this chip.)
9042 @item c3-2
9043 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9044 implemented for this chip.)
9045 @end table
9046
9047 While picking a specific @var{cpu-type} will schedule things appropriately
9048 for that particular chip, the compiler will not generate any code that
9049 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9050 being used.
9051
9052 @item -march=@var{cpu-type}
9053 @opindex march
9054 Generate instructions for the machine type @var{cpu-type}.  The choices
9055 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9056 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9057
9058 @item -mcpu=@var{cpu-type}
9059 @opindex mcpu
9060 A deprecated synonym for @option{-mtune}.
9061
9062 @item -m386
9063 @itemx -m486
9064 @itemx -mpentium
9065 @itemx -mpentiumpro
9066 @opindex m386
9067 @opindex m486
9068 @opindex mpentium
9069 @opindex mpentiumpro
9070 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9071 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9072 These synonyms are deprecated.
9073
9074 @item -mfpmath=@var{unit}
9075 @opindex march
9076 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9077 for @var{unit} are:
9078
9079 @table @samp
9080 @item 387
9081 Use the standard 387 floating point coprocessor present majority of chips and
9082 emulated otherwise.  Code compiled with this option will run almost everywhere.
9083 The temporary results are computed in 80bit precision instead of precision
9084 specified by the type resulting in slightly different results compared to most
9085 of other chips.  See @option{-ffloat-store} for more detailed description.
9086
9087 This is the default choice for i386 compiler.
9088
9089 @item sse
9090 Use scalar floating point instructions present in the SSE instruction set.
9091 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9092 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9093 instruction set supports only single precision arithmetics, thus the double and
9094 extended precision arithmetics is still done using 387.  Later version, present
9095 only in Pentium4 and the future AMD x86-64 chips supports double precision
9096 arithmetics too.
9097
9098 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9099 or @option{-msse2} switches to enable SSE extensions and make this option
9100 effective.  For the x86-64 compiler, these extensions are enabled by default.
9101
9102 The resulting code should be considerably faster in the majority of cases and avoid
9103 the numerical instability problems of 387 code, but may break some existing
9104 code that expects temporaries to be 80bit.
9105
9106 This is the default choice for the x86-64 compiler.
9107
9108 @item sse,387
9109 Attempt to utilize both instruction sets at once.  This effectively double the
9110 amount of available registers and on chips with separate execution units for
9111 387 and SSE the execution resources too.  Use this option with care, as it is
9112 still experimental, because the GCC register allocator does not model separate
9113 functional units well resulting in instable performance.
9114 @end table
9115
9116 @item -masm=@var{dialect}
9117 @opindex masm=@var{dialect}
9118 Output asm instructions using selected @var{dialect}.  Supported
9119 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9120 not support @samp{intel}.
9121
9122 @item -mieee-fp
9123 @itemx -mno-ieee-fp
9124 @opindex mieee-fp
9125 @opindex mno-ieee-fp
9126 Control whether or not the compiler uses IEEE floating point
9127 comparisons.  These handle correctly the case where the result of a
9128 comparison is unordered.
9129
9130 @item -msoft-float
9131 @opindex msoft-float
9132 Generate output containing library calls for floating point.
9133 @strong{Warning:} the requisite libraries are not part of GCC@.
9134 Normally the facilities of the machine's usual C compiler are used, but
9135 this can't be done directly in cross-compilation.  You must make your
9136 own arrangements to provide suitable library functions for
9137 cross-compilation.
9138
9139 On machines where a function returns floating point results in the 80387
9140 register stack, some floating point opcodes may be emitted even if
9141 @option{-msoft-float} is used.
9142
9143 @item -mno-fp-ret-in-387
9144 @opindex mno-fp-ret-in-387
9145 Do not use the FPU registers for return values of functions.
9146
9147 The usual calling convention has functions return values of types
9148 @code{float} and @code{double} in an FPU register, even if there
9149 is no FPU@.  The idea is that the operating system should emulate
9150 an FPU@.
9151
9152 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9153 in ordinary CPU registers instead.
9154
9155 @item -mno-fancy-math-387
9156 @opindex mno-fancy-math-387
9157 Some 387 emulators do not support the @code{sin}, @code{cos} and
9158 @code{sqrt} instructions for the 387.  Specify this option to avoid
9159 generating those instructions.  This option is the default on FreeBSD,
9160 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9161 indicates that the target cpu will always have an FPU and so the
9162 instruction will not need emulation.  As of revision 2.6.1, these
9163 instructions are not generated unless you also use the
9164 @option{-funsafe-math-optimizations} switch.
9165
9166 @item -malign-double
9167 @itemx -mno-align-double
9168 @opindex malign-double
9169 @opindex mno-align-double
9170 Control whether GCC aligns @code{double}, @code{long double}, and
9171 @code{long long} variables on a two word boundary or a one word
9172 boundary.  Aligning @code{double} variables on a two word boundary will
9173 produce code that runs somewhat faster on a @samp{Pentium} at the
9174 expense of more memory.
9175
9176 @strong{Warning:} if you use the @option{-malign-double} switch,
9177 structures containing the above types will be aligned differently than
9178 the published application binary interface specifications for the 386
9179 and will not be binary compatible with structures in code compiled
9180 without that switch.
9181
9182 @item -m96bit-long-double
9183 @itemx -m128bit-long-double
9184 @opindex m96bit-long-double
9185 @opindex m128bit-long-double
9186 These switches control the size of @code{long double} type.  The i386
9187 application binary interface specifies the size to be 96 bits,
9188 so @option{-m96bit-long-double} is the default in 32 bit mode.
9189
9190 Modern architectures (Pentium and newer) would prefer @code{long double}
9191 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9192 conforming to the ABI, this would not be possible.  So specifying a
9193 @option{-m128bit-long-double} will align @code{long double}
9194 to a 16 byte boundary by padding the @code{long double} with an additional
9195 32 bit zero.
9196
9197 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9198 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9199
9200 Notice that neither of these options enable any extra precision over the x87
9201 standard of 80 bits for a @code{long double}.
9202
9203 @strong{Warning:} if you override the default value for your target ABI, the
9204 structures and arrays containing @code{long double} variables will change
9205 their size as well as function calling convention for function taking
9206 @code{long double} will be modified.  Hence they will not be binary
9207 compatible with arrays or structures in code compiled without that switch.
9208
9209 @item -mmlarge-data-threshold=@var{number}
9210 @opindex mlarge-data-threshold=@var{number}
9211 When @option{-mcmodel=medium} is specified, the data greater than
9212 @var{threshold} are placed in large data section.  This value must be the
9213 same across all object linked into the binary and defaults to 65535.
9214
9215 @item -msvr3-shlib
9216 @itemx -mno-svr3-shlib
9217 @opindex msvr3-shlib
9218 @opindex mno-svr3-shlib
9219 Control whether GCC places uninitialized local variables into the
9220 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9221 into @code{bss}.  These options are meaningful only on System V Release 3.
9222
9223 @item -mrtd
9224 @opindex mrtd
9225 Use a different function-calling convention, in which functions that
9226 take a fixed number of arguments return with the @code{ret} @var{num}
9227 instruction, which pops their arguments while returning.  This saves one
9228 instruction in the caller since there is no need to pop the arguments
9229 there.
9230
9231 You can specify that an individual function is called with this calling
9232 sequence with the function attribute @samp{stdcall}.  You can also
9233 override the @option{-mrtd} option by using the function attribute
9234 @samp{cdecl}.  @xref{Function Attributes}.
9235
9236 @strong{Warning:} this calling convention is incompatible with the one
9237 normally used on Unix, so you cannot use it if you need to call
9238 libraries compiled with the Unix compiler.
9239
9240 Also, you must provide function prototypes for all functions that
9241 take variable numbers of arguments (including @code{printf});
9242 otherwise incorrect code will be generated for calls to those
9243 functions.
9244
9245 In addition, seriously incorrect code will result if you call a
9246 function with too many arguments.  (Normally, extra arguments are
9247 harmlessly ignored.)
9248
9249 @item -mregparm=@var{num}
9250 @opindex mregparm
9251 Control how many registers are used to pass integer arguments.  By
9252 default, no registers are used to pass arguments, and at most 3
9253 registers can be used.  You can control this behavior for a specific
9254 function by using the function attribute @samp{regparm}.
9255 @xref{Function Attributes}.
9256
9257 @strong{Warning:} if you use this switch, and
9258 @var{num} is nonzero, then you must build all modules with the same
9259 value, including any libraries.  This includes the system libraries and
9260 startup modules.
9261
9262 @item -msseregparm
9263 @opindex msseregparm
9264 Use SSE register passing conventions for float and double arguments
9265 and return values.  You can control this behavior for a specific
9266 function by using the function attribute @samp{sseregparm}.
9267 @xref{Function Attributes}.
9268
9269 @strong{Warning:} if you use this switch then you must build all
9270 modules with the same value, including any libraries.  This includes
9271 the system libraries and startup modules.
9272
9273 @item -mpreferred-stack-boundary=@var{num}
9274 @opindex mpreferred-stack-boundary
9275 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9276 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9277 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9278 size (@option{-Os}), in which case the default is the minimum correct
9279 alignment (4 bytes for x86, and 8 bytes for x86-64).
9280
9281 On Pentium and PentiumPro, @code{double} and @code{long double} values
9282 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9283 suffer significant run time performance penalties.  On Pentium III, the
9284 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9285 penalties if it is not 16 byte aligned.
9286
9287 To ensure proper alignment of this values on the stack, the stack boundary
9288 must be as aligned as that required by any value stored on the stack.
9289 Further, every function must be generated such that it keeps the stack
9290 aligned.  Thus calling a function compiled with a higher preferred
9291 stack boundary from a function compiled with a lower preferred stack
9292 boundary will most likely misalign the stack.  It is recommended that
9293 libraries that use callbacks always use the default setting.
9294
9295 This extra alignment does consume extra stack space, and generally
9296 increases code size.  Code that is sensitive to stack space usage, such
9297 as embedded systems and operating system kernels, may want to reduce the
9298 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9299
9300 @item -mmmx
9301 @itemx -mno-mmx
9302 @item -msse
9303 @itemx -mno-sse
9304 @item -msse2
9305 @itemx -mno-sse2
9306 @item -msse3
9307 @itemx -mno-sse3
9308 @item -m3dnow
9309 @itemx -mno-3dnow
9310 @opindex mmmx
9311 @opindex mno-mmx
9312 @opindex msse
9313 @opindex mno-sse
9314 @opindex m3dnow
9315 @opindex mno-3dnow
9316 These switches enable or disable the use of instructions in the MMX,
9317 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9318 also available as built-in functions: see @ref{X86 Built-in Functions},
9319 for details of the functions enabled and disabled by these switches.
9320
9321 To have SSE/SSE2 instructions generated automatically from floating-point
9322 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9323
9324 These options will enable GCC to use these extended instructions in
9325 generated code, even without @option{-mfpmath=sse}.  Applications which
9326 perform runtime CPU detection must compile separate files for each
9327 supported architecture, using the appropriate flags.  In particular,
9328 the file containing the CPU detection code should be compiled without
9329 these options.
9330
9331 @item -mpush-args
9332 @itemx -mno-push-args
9333 @opindex mpush-args
9334 @opindex mno-push-args
9335 Use PUSH operations to store outgoing parameters.  This method is shorter
9336 and usually equally fast as method using SUB/MOV operations and is enabled
9337 by default.  In some cases disabling it may improve performance because of
9338 improved scheduling and reduced dependencies.
9339
9340 @item -maccumulate-outgoing-args
9341 @opindex maccumulate-outgoing-args
9342 If enabled, the maximum amount of space required for outgoing arguments will be
9343 computed in the function prologue.  This is faster on most modern CPUs
9344 because of reduced dependencies, improved scheduling and reduced stack usage
9345 when preferred stack boundary is not equal to 2.  The drawback is a notable
9346 increase in code size.  This switch implies @option{-mno-push-args}.
9347
9348 @item -mthreads
9349 @opindex mthreads
9350 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9351 on thread-safe exception handling must compile and link all code with the
9352 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9353 @option{-D_MT}; when linking, it links in a special thread helper library
9354 @option{-lmingwthrd} which cleans up per thread exception handling data.
9355
9356 @item -mno-align-stringops
9357 @opindex mno-align-stringops
9358 Do not align destination of inlined string operations.  This switch reduces
9359 code size and improves performance in case the destination is already aligned,
9360 but GCC doesn't know about it.
9361
9362 @item -minline-all-stringops
9363 @opindex minline-all-stringops
9364 By default GCC inlines string operations only when destination is known to be
9365 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9366 size, but may improve performance of code that depends on fast memcpy, strlen
9367 and memset for short lengths.
9368
9369 @item -momit-leaf-frame-pointer
9370 @opindex momit-leaf-frame-pointer
9371 Don't keep the frame pointer in a register for leaf functions.  This
9372 avoids the instructions to save, set up and restore frame pointers and
9373 makes an extra register available in leaf functions.  The option
9374 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9375 which might make debugging harder.
9376
9377 @item -mtls-direct-seg-refs
9378 @itemx -mno-tls-direct-seg-refs
9379 @opindex mtls-direct-seg-refs
9380 Controls whether TLS variables may be accessed with offsets from the
9381 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9382 or whether the thread base pointer must be added.  Whether or not this
9383 is legal depends on the operating system, and whether it maps the
9384 segment to cover the entire TLS area.
9385
9386 For systems that use GNU libc, the default is on.
9387 @end table
9388
9389 These @samp{-m} switches are supported in addition to the above
9390 on AMD x86-64 processors in 64-bit environments.
9391
9392 @table @gcctabopt
9393 @item -m32
9394 @itemx -m64
9395 @opindex m32
9396 @opindex m64
9397 Generate code for a 32-bit or 64-bit environment.
9398 The 32-bit environment sets int, long and pointer to 32 bits and
9399 generates code that runs on any i386 system.
9400 The 64-bit environment sets int to 32 bits and long and pointer
9401 to 64 bits and generates code for AMD's x86-64 architecture.
9402
9403 @item -mno-red-zone
9404 @opindex no-red-zone
9405 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9406 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9407 stack pointer that will not be modified by signal or interrupt handlers
9408 and therefore can be used for temporary data without adjusting the stack
9409 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9410
9411 @item -mcmodel=small
9412 @opindex mcmodel=small
9413 Generate code for the small code model: the program and its symbols must
9414 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9415 Programs can be statically or dynamically linked.  This is the default
9416 code model.
9417
9418 @item -mcmodel=kernel
9419 @opindex mcmodel=kernel
9420 Generate code for the kernel code model.  The kernel runs in the
9421 negative 2 GB of the address space.
9422 This model has to be used for Linux kernel code.
9423
9424 @item -mcmodel=medium
9425 @opindex mcmodel=medium
9426 Generate code for the medium model: The program is linked in the lower 2
9427 GB of the address space but symbols can be located anywhere in the
9428 address space.  Programs can be statically or dynamically linked, but
9429 building of shared libraries are not supported with the medium model.
9430
9431 @item -mcmodel=large
9432 @opindex mcmodel=large
9433 Generate code for the large model: This model makes no assumptions
9434 about addresses and sizes of sections.  Currently GCC does not implement
9435 this model.
9436 @end table
9437
9438 @node IA-64 Options
9439 @subsection IA-64 Options
9440 @cindex IA-64 Options
9441
9442 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9443
9444 @table @gcctabopt
9445 @item -mbig-endian
9446 @opindex mbig-endian
9447 Generate code for a big endian target.  This is the default for HP-UX@.
9448
9449 @item -mlittle-endian
9450 @opindex mlittle-endian
9451 Generate code for a little endian target.  This is the default for AIX5
9452 and GNU/Linux.
9453
9454 @item -mgnu-as
9455 @itemx -mno-gnu-as
9456 @opindex mgnu-as
9457 @opindex mno-gnu-as
9458 Generate (or don't) code for the GNU assembler.  This is the default.
9459 @c Also, this is the default if the configure option @option{--with-gnu-as}
9460 @c is used.
9461
9462 @item -mgnu-ld
9463 @itemx -mno-gnu-ld
9464 @opindex mgnu-ld
9465 @opindex mno-gnu-ld
9466 Generate (or don't) code for the GNU linker.  This is the default.
9467 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9468 @c is used.
9469
9470 @item -mno-pic
9471 @opindex mno-pic
9472 Generate code that does not use a global pointer register.  The result
9473 is not position independent code, and violates the IA-64 ABI@.
9474
9475 @item -mvolatile-asm-stop
9476 @itemx -mno-volatile-asm-stop
9477 @opindex mvolatile-asm-stop
9478 @opindex mno-volatile-asm-stop
9479 Generate (or don't) a stop bit immediately before and after volatile asm
9480 statements.
9481
9482 @item -mregister-names
9483 @itemx -mno-register-names
9484 @opindex mregister-names
9485 @opindex mno-register-names
9486 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9487 the stacked registers.  This may make assembler output more readable.
9488
9489 @item -mno-sdata
9490 @itemx -msdata
9491 @opindex mno-sdata
9492 @opindex msdata
9493 Disable (or enable) optimizations that use the small data section.  This may
9494 be useful for working around optimizer bugs.
9495
9496 @item -mconstant-gp
9497 @opindex mconstant-gp
9498 Generate code that uses a single constant global pointer value.  This is
9499 useful when compiling kernel code.
9500
9501 @item -mauto-pic
9502 @opindex mauto-pic
9503 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9504 This is useful when compiling firmware code.
9505
9506 @item -minline-float-divide-min-latency
9507 @opindex minline-float-divide-min-latency
9508 Generate code for inline divides of floating point values
9509 using the minimum latency algorithm.
9510
9511 @item -minline-float-divide-max-throughput
9512 @opindex minline-float-divide-max-throughput
9513 Generate code for inline divides of floating point values
9514 using the maximum throughput algorithm.
9515
9516 @item -minline-int-divide-min-latency
9517 @opindex minline-int-divide-min-latency
9518 Generate code for inline divides of integer values
9519 using the minimum latency algorithm.
9520
9521 @item -minline-int-divide-max-throughput
9522 @opindex minline-int-divide-max-throughput
9523 Generate code for inline divides of integer values
9524 using the maximum throughput algorithm.
9525
9526 @item -minline-sqrt-min-latency
9527 @opindex minline-sqrt-min-latency
9528 Generate code for inline square roots
9529 using the minimum latency algorithm.
9530
9531 @item -minline-sqrt-max-throughput
9532 @opindex minline-sqrt-max-throughput
9533 Generate code for inline square roots
9534 using the maximum throughput algorithm.
9535
9536 @item -mno-dwarf2-asm
9537 @itemx -mdwarf2-asm
9538 @opindex mno-dwarf2-asm
9539 @opindex mdwarf2-asm
9540 Don't (or do) generate assembler code for the DWARF2 line number debugging
9541 info.  This may be useful when not using the GNU assembler.
9542
9543 @item -mearly-stop-bits
9544 @itemx -mno-early-stop-bits
9545 @opindex mearly-stop-bits
9546 @opindex mno-early-stop-bits
9547 Allow stop bits to be placed earlier than immediately preceding the
9548 instruction that triggered the stop bit.  This can improve instruction
9549 scheduling, but does not always do so.
9550
9551 @item -mfixed-range=@var{register-range}
9552 @opindex mfixed-range
9553 Generate code treating the given register range as fixed registers.
9554 A fixed register is one that the register allocator can not use.  This is
9555 useful when compiling kernel code.  A register range is specified as
9556 two registers separated by a dash.  Multiple register ranges can be
9557 specified separated by a comma.
9558
9559 @item -mtls-size=@var{tls-size}
9560 @opindex mtls-size
9561 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9562 64.
9563
9564 @item -mtune=@var{cpu-type}
9565 @opindex mtune
9566 Tune the instruction scheduling for a particular CPU, Valid values are
9567 itanium, itanium1, merced, itanium2, and mckinley.
9568
9569 @item -mt
9570 @itemx -pthread
9571 @opindex mt
9572 @opindex pthread
9573 Add support for multithreading using the POSIX threads library.  This
9574 option sets flags for both the preprocessor and linker.  It does
9575 not affect the thread safety of object code produced by the compiler or
9576 that of libraries supplied with it.  These are HP-UX specific flags.
9577
9578 @item -milp32
9579 @itemx -mlp64
9580 @opindex milp32
9581 @opindex mlp64
9582 Generate code for a 32-bit or 64-bit environment.
9583 The 32-bit environment sets int, long and pointer to 32 bits.
9584 The 64-bit environment sets int to 32 bits and long and pointer
9585 to 64 bits.  These are HP-UX specific flags.
9586
9587 @end table
9588
9589 @node M32C Options
9590 @subsection M32C Options
9591 @cindex M32C options
9592
9593 @table @gcctabopt
9594 @item -mcpu=@var{name}
9595 @opindex mcpu=
9596 Select the CPU for which code is generated.  @var{name} may be one of
9597 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9598 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9599 the M32C/80 series.
9600
9601 @item -msim
9602 @opindex msim
9603 Specifies that the program will be run on the simulator.  This causes
9604 an alternate runtime library to be linked in which supports, for
9605 example, file I/O.  You must not use this option when generating
9606 programs that will run on real hardware; you must provide your own
9607 runtime library for whatever I/O functions are needed.
9608
9609 @item -memregs=@var{number}
9610 @opindex memregs=
9611 Specifies the number of memory-based pseudo-registers GCC will use
9612 during code generation.  These pseudo-registers will be used like real
9613 registers, so there is a tradeoff between GCC's ability to fit the
9614 code into available registers, and the performance penalty of using
9615 memory instead of registers.  Note that all modules in a program must
9616 be compiled with the same value for this option.  Because of that, you
9617 must not use this option with the default runtime libraries gcc
9618 builds.
9619
9620 @end table
9621
9622 @node M32R/D Options
9623 @subsection M32R/D Options
9624 @cindex M32R/D options
9625
9626 These @option{-m} options are defined for Renesas M32R/D architectures:
9627
9628 @table @gcctabopt
9629 @item -m32r2
9630 @opindex m32r2
9631 Generate code for the M32R/2@.
9632
9633 @item -m32rx
9634 @opindex m32rx
9635 Generate code for the M32R/X@.
9636
9637 @item -m32r
9638 @opindex m32r
9639 Generate code for the M32R@.  This is the default.
9640
9641 @item -mmodel=small
9642 @opindex mmodel=small
9643 Assume all objects live in the lower 16MB of memory (so that their addresses
9644 can be loaded with the @code{ld24} instruction), and assume all subroutines
9645 are reachable with the @code{bl} instruction.
9646 This is the default.
9647
9648 The addressability of a particular object can be set with the
9649 @code{model} attribute.
9650
9651 @item -mmodel=medium
9652 @opindex mmodel=medium
9653 Assume objects may be anywhere in the 32-bit address space (the compiler
9654 will generate @code{seth/add3} instructions to load their addresses), and
9655 assume all subroutines are reachable with the @code{bl} instruction.
9656
9657 @item -mmodel=large
9658 @opindex mmodel=large
9659 Assume objects may be anywhere in the 32-bit address space (the compiler
9660 will generate @code{seth/add3} instructions to load their addresses), and
9661 assume subroutines may not be reachable with the @code{bl} instruction
9662 (the compiler will generate the much slower @code{seth/add3/jl}
9663 instruction sequence).
9664
9665 @item -msdata=none
9666 @opindex msdata=none
9667 Disable use of the small data area.  Variables will be put into
9668 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9669 @code{section} attribute has been specified).
9670 This is the default.
9671
9672 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9673 Objects may be explicitly put in the small data area with the
9674 @code{section} attribute using one of these sections.
9675
9676 @item -msdata=sdata
9677 @opindex msdata=sdata
9678 Put small global and static data in the small data area, but do not
9679 generate special code to reference them.
9680
9681 @item -msdata=use
9682 @opindex msdata=use
9683 Put small global and static data in the small data area, and generate
9684 special instructions to reference them.
9685
9686 @item -G @var{num}
9687 @opindex G
9688 @cindex smaller data references
9689 Put global and static objects less than or equal to @var{num} bytes
9690 into the small data or bss sections instead of the normal data or bss
9691 sections.  The default value of @var{num} is 8.
9692 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9693 for this option to have any effect.
9694
9695 All modules should be compiled with the same @option{-G @var{num}} value.
9696 Compiling with different values of @var{num} may or may not work; if it
9697 doesn't the linker will give an error message---incorrect code will not be
9698 generated.
9699
9700 @item -mdebug
9701 @opindex mdebug
9702 Makes the M32R specific code in the compiler display some statistics
9703 that might help in debugging programs.
9704
9705 @item -malign-loops
9706 @opindex malign-loops
9707 Align all loops to a 32-byte boundary.
9708
9709 @item -mno-align-loops
9710 @opindex mno-align-loops
9711 Do not enforce a 32-byte alignment for loops.  This is the default.
9712
9713 @item -missue-rate=@var{number}
9714 @opindex missue-rate=@var{number}
9715 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9716 or 2.
9717
9718 @item -mbranch-cost=@var{number}
9719 @opindex mbranch-cost=@var{number}
9720 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9721 preferred over conditional code, if it is 2, then the opposite will
9722 apply.
9723
9724 @item -mflush-trap=@var{number}
9725 @opindex mflush-trap=@var{number}
9726 Specifies the trap number to use to flush the cache.  The default is
9727 12.  Valid numbers are between 0 and 15 inclusive.
9728
9729 @item -mno-flush-trap
9730 @opindex mno-flush-trap
9731 Specifies that the cache cannot be flushed by using a trap.
9732
9733 @item -mflush-func=@var{name}
9734 @opindex mflush-func=@var{name}
9735 Specifies the name of the operating system function to call to flush
9736 the cache.  The default is @emph{_flush_cache}, but a function call
9737 will only be used if a trap is not available.
9738
9739 @item -mno-flush-func
9740 @opindex mno-flush-func
9741 Indicates that there is no OS function for flushing the cache.
9742
9743 @end table
9744
9745 @node M680x0 Options
9746 @subsection M680x0 Options
9747 @cindex M680x0 options
9748
9749 These are the @samp{-m} options defined for the 68000 series.  The default
9750 values for these options depends on which style of 68000 was selected when
9751 the compiler was configured; the defaults for the most common choices are
9752 given below.
9753
9754 @table @gcctabopt
9755 @item -m68000
9756 @itemx -mc68000
9757 @opindex m68000
9758 @opindex mc68000
9759 Generate output for a 68000.  This is the default
9760 when the compiler is configured for 68000-based systems.
9761
9762 Use this option for microcontrollers with a 68000 or EC000 core,
9763 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9764
9765 @item -m68020
9766 @itemx -mc68020
9767 @opindex m68020
9768 @opindex mc68020
9769 Generate output for a 68020.  This is the default
9770 when the compiler is configured for 68020-based systems.
9771
9772 @item -m68881
9773 @opindex m68881
9774 Generate output containing 68881 instructions for floating point.
9775 This is the default for most 68020 systems unless @option{--nfp} was
9776 specified when the compiler was configured.
9777
9778 @item -m68030
9779 @opindex m68030
9780 Generate output for a 68030.  This is the default when the compiler is
9781 configured for 68030-based systems.
9782
9783 @item -m68040
9784 @opindex m68040
9785 Generate output for a 68040.  This is the default when the compiler is
9786 configured for 68040-based systems.
9787
9788 This option inhibits the use of 68881/68882 instructions that have to be
9789 emulated by software on the 68040.  Use this option if your 68040 does not
9790 have code to emulate those instructions.
9791
9792 @item -m68060
9793 @opindex m68060
9794 Generate output for a 68060.  This is the default when the compiler is
9795 configured for 68060-based systems.
9796
9797 This option inhibits the use of 68020 and 68881/68882 instructions that
9798 have to be emulated by software on the 68060.  Use this option if your 68060
9799 does not have code to emulate those instructions.
9800
9801 @item -mcpu32
9802 @opindex mcpu32
9803 Generate output for a CPU32.  This is the default
9804 when the compiler is configured for CPU32-based systems.
9805
9806 Use this option for microcontrollers with a
9807 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9808 68336, 68340, 68341, 68349 and 68360.
9809
9810 @item -m5200
9811 @opindex m5200
9812 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9813 when the compiler is configured for 520X-based systems.
9814
9815 Use this option for microcontroller with a 5200 core, including
9816 the MCF5202, MCF5203, MCF5204 and MCF5202.
9817
9818
9819 @item -m68020-40
9820 @opindex m68020-40
9821 Generate output for a 68040, without using any of the new instructions.
9822 This results in code which can run relatively efficiently on either a
9823 68020/68881 or a 68030 or a 68040.  The generated code does use the
9824 68881 instructions that are emulated on the 68040.
9825
9826 @item -m68020-60
9827 @opindex m68020-60
9828 Generate output for a 68060, without using any of the new instructions.
9829 This results in code which can run relatively efficiently on either a
9830 68020/68881 or a 68030 or a 68040.  The generated code does use the
9831 68881 instructions that are emulated on the 68060.
9832
9833 @item -msoft-float
9834 @opindex msoft-float
9835 Generate output containing library calls for floating point.
9836 @strong{Warning:} the requisite libraries are not available for all m68k
9837 targets.  Normally the facilities of the machine's usual C compiler are
9838 used, but this can't be done directly in cross-compilation.  You must
9839 make your own arrangements to provide suitable library functions for
9840 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9841 @samp{m68k-*-coff} do provide software floating point support.
9842
9843 @item -mshort
9844 @opindex mshort
9845 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9846 Additionally, parameters passed on the stack are also aligned to a
9847 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9848
9849 @item -mnobitfield
9850 @opindex mnobitfield
9851 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9852 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9853
9854 @item -mbitfield
9855 @opindex mbitfield
9856 Do use the bit-field instructions.  The @option{-m68020} option implies
9857 @option{-mbitfield}.  This is the default if you use a configuration
9858 designed for a 68020.
9859
9860 @item -mrtd
9861 @opindex mrtd
9862 Use a different function-calling convention, in which functions
9863 that take a fixed number of arguments return with the @code{rtd}
9864 instruction, which pops their arguments while returning.  This
9865 saves one instruction in the caller since there is no need to pop
9866 the arguments there.
9867
9868 This calling convention is incompatible with the one normally
9869 used on Unix, so you cannot use it if you need to call libraries
9870 compiled with the Unix compiler.
9871
9872 Also, you must provide function prototypes for all functions that
9873 take variable numbers of arguments (including @code{printf});
9874 otherwise incorrect code will be generated for calls to those
9875 functions.
9876
9877 In addition, seriously incorrect code will result if you call a
9878 function with too many arguments.  (Normally, extra arguments are
9879 harmlessly ignored.)
9880
9881 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9882 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9883
9884 @item -malign-int
9885 @itemx -mno-align-int
9886 @opindex malign-int
9887 @opindex mno-align-int
9888 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9889 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9890 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9891 Aligning variables on 32-bit boundaries produces code that runs somewhat
9892 faster on processors with 32-bit busses at the expense of more memory.
9893
9894 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9895 align structures containing the above types  differently than
9896 most published application binary interface specifications for the m68k.
9897
9898 @item -mpcrel
9899 @opindex mpcrel
9900 Use the pc-relative addressing mode of the 68000 directly, instead of
9901 using a global offset table.  At present, this option implies @option{-fpic},
9902 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9903 not presently supported with @option{-mpcrel}, though this could be supported for
9904 68020 and higher processors.
9905
9906 @item -mno-strict-align
9907 @itemx -mstrict-align
9908 @opindex mno-strict-align
9909 @opindex mstrict-align
9910 Do not (do) assume that unaligned memory references will be handled by
9911 the system.
9912
9913 @item -msep-data
9914 Generate code that allows the data segment to be located in a different
9915 area of memory from the text segment.  This allows for execute in place in
9916 an environment without virtual memory management.  This option implies
9917 @option{-fPIC}.
9918
9919 @item -mno-sep-data
9920 Generate code that assumes that the data segment follows the text segment.
9921 This is the default.
9922
9923 @item -mid-shared-library
9924 Generate code that supports shared libraries via the library ID method.
9925 This allows for execute in place and shared libraries in an environment
9926 without virtual memory management.  This option implies @option{-fPIC}.
9927
9928 @item -mno-id-shared-library
9929 Generate code that doesn't assume ID based shared libraries are being used.
9930 This is the default.
9931
9932 @item -mshared-library-id=n
9933 Specified the identification number of the ID based shared library being
9934 compiled.  Specifying a value of 0 will generate more compact code, specifying
9935 other values will force the allocation of that number to the current
9936 library but is no more space or time efficient than omitting this option.
9937
9938 @end table
9939
9940 @node M68hc1x Options
9941 @subsection M68hc1x Options
9942 @cindex M68hc1x options
9943
9944 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9945 microcontrollers.  The default values for these options depends on
9946 which style of microcontroller was selected when the compiler was configured;
9947 the defaults for the most common choices are given below.
9948
9949 @table @gcctabopt
9950 @item -m6811
9951 @itemx -m68hc11
9952 @opindex m6811
9953 @opindex m68hc11
9954 Generate output for a 68HC11.  This is the default
9955 when the compiler is configured for 68HC11-based systems.
9956
9957 @item -m6812
9958 @itemx -m68hc12
9959 @opindex m6812
9960 @opindex m68hc12
9961 Generate output for a 68HC12.  This is the default
9962 when the compiler is configured for 68HC12-based systems.
9963
9964 @item -m68S12
9965 @itemx -m68hcs12
9966 @opindex m68S12
9967 @opindex m68hcs12
9968 Generate output for a 68HCS12.
9969
9970 @item -mauto-incdec
9971 @opindex mauto-incdec
9972 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9973 addressing modes.
9974
9975 @item -minmax
9976 @itemx -nominmax
9977 @opindex minmax
9978 @opindex mnominmax
9979 Enable the use of 68HC12 min and max instructions.
9980
9981 @item -mlong-calls
9982 @itemx -mno-long-calls
9983 @opindex mlong-calls
9984 @opindex mno-long-calls
9985 Treat all calls as being far away (near).  If calls are assumed to be
9986 far away, the compiler will use the @code{call} instruction to
9987 call a function and the @code{rtc} instruction for returning.
9988
9989 @item -mshort
9990 @opindex mshort
9991 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9992
9993 @item -msoft-reg-count=@var{count}
9994 @opindex msoft-reg-count
9995 Specify the number of pseudo-soft registers which are used for the
9996 code generation.  The maximum number is 32.  Using more pseudo-soft
9997 register may or may not result in better code depending on the program.
9998 The default is 4 for 68HC11 and 2 for 68HC12.
9999
10000 @end table
10001
10002 @node MCore Options
10003 @subsection MCore Options
10004 @cindex MCore options
10005
10006 These are the @samp{-m} options defined for the Motorola M*Core
10007 processors.
10008
10009 @table @gcctabopt
10010
10011 @item -mhardlit
10012 @itemx -mno-hardlit
10013 @opindex mhardlit
10014 @opindex mno-hardlit
10015 Inline constants into the code stream if it can be done in two
10016 instructions or less.
10017
10018 @item -mdiv
10019 @itemx -mno-div
10020 @opindex mdiv
10021 @opindex mno-div
10022 Use the divide instruction.  (Enabled by default).
10023
10024 @item -mrelax-immediate
10025 @itemx -mno-relax-immediate
10026 @opindex mrelax-immediate
10027 @opindex mno-relax-immediate
10028 Allow arbitrary sized immediates in bit operations.
10029
10030 @item -mwide-bitfields
10031 @itemx -mno-wide-bitfields
10032 @opindex mwide-bitfields
10033 @opindex mno-wide-bitfields
10034 Always treat bit-fields as int-sized.
10035
10036 @item -m4byte-functions
10037 @itemx -mno-4byte-functions
10038 @opindex m4byte-functions
10039 @opindex mno-4byte-functions
10040 Force all functions to be aligned to a four byte boundary.
10041
10042 @item -mcallgraph-data
10043 @itemx -mno-callgraph-data
10044 @opindex mcallgraph-data
10045 @opindex mno-callgraph-data
10046 Emit callgraph information.
10047
10048 @item -mslow-bytes
10049 @itemx -mno-slow-bytes
10050 @opindex mslow-bytes
10051 @opindex mno-slow-bytes
10052 Prefer word access when reading byte quantities.
10053
10054 @item -mlittle-endian
10055 @itemx -mbig-endian
10056 @opindex mlittle-endian
10057 @opindex mbig-endian
10058 Generate code for a little endian target.
10059
10060 @item -m210
10061 @itemx -m340
10062 @opindex m210
10063 @opindex m340
10064 Generate code for the 210 processor.
10065 @end table
10066
10067 @node MIPS Options
10068 @subsection MIPS Options
10069 @cindex MIPS options
10070
10071 @table @gcctabopt
10072
10073 @item -EB
10074 @opindex EB
10075 Generate big-endian code.
10076
10077 @item -EL
10078 @opindex EL
10079 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10080 configurations.
10081
10082 @item -march=@var{arch}
10083 @opindex march
10084 Generate code that will run on @var{arch}, which can be the name of a
10085 generic MIPS ISA, or the name of a particular processor.
10086 The ISA names are:
10087 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10088 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10089 The processor names are:
10090 @samp{4kc}, @samp{4km}, @samp{4kp},
10091 @samp{5kc}, @samp{5kf},
10092 @samp{20kc},
10093 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10094 @samp{m4k},
10095 @samp{orion},
10096 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10097 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10098 @samp{rm7000}, @samp{rm9000},
10099 @samp{sb1},
10100 @samp{sr71000},
10101 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10102 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10103 The special value @samp{from-abi} selects the
10104 most compatible architecture for the selected ABI (that is,
10105 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10106
10107 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10108 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10109 @samp{vr} may be written @samp{r}.
10110
10111 GCC defines two macros based on the value of this option.  The first
10112 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10113 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10114 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10115 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10116 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10117
10118 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10119 above.  In other words, it will have the full prefix and will not
10120 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10121 the macro names the resolved architecture (either @samp{"mips1"} or
10122 @samp{"mips3"}).  It names the default architecture when no
10123 @option{-march} option is given.
10124
10125 @item -mtune=@var{arch}
10126 @opindex mtune
10127 Optimize for @var{arch}.  Among other things, this option controls
10128 the way instructions are scheduled, and the perceived cost of arithmetic
10129 operations.  The list of @var{arch} values is the same as for
10130 @option{-march}.
10131
10132 When this option is not used, GCC will optimize for the processor
10133 specified by @option{-march}.  By using @option{-march} and
10134 @option{-mtune} together, it is possible to generate code that will
10135 run on a family of processors, but optimize the code for one
10136 particular member of that family.
10137
10138 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10139 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10140 @samp{-march} ones described above.
10141
10142 @item -mips1
10143 @opindex mips1
10144 Equivalent to @samp{-march=mips1}.
10145
10146 @item -mips2
10147 @opindex mips2
10148 Equivalent to @samp{-march=mips2}.
10149
10150 @item -mips3
10151 @opindex mips3
10152 Equivalent to @samp{-march=mips3}.
10153
10154 @item -mips4
10155 @opindex mips4
10156 Equivalent to @samp{-march=mips4}.
10157
10158 @item -mips32
10159 @opindex mips32
10160 Equivalent to @samp{-march=mips32}.
10161
10162 @item -mips32r2
10163 @opindex mips32r2
10164 Equivalent to @samp{-march=mips32r2}.
10165
10166 @item -mips64
10167 @opindex mips64
10168 Equivalent to @samp{-march=mips64}.
10169
10170 @item -mips16
10171 @itemx -mno-mips16
10172 @opindex mips16
10173 @opindex mno-mips16
10174 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10175 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10176
10177 @item -mabi=32
10178 @itemx -mabi=o64
10179 @itemx -mabi=n32
10180 @itemx -mabi=64
10181 @itemx -mabi=eabi
10182 @opindex mabi=32
10183 @opindex mabi=o64
10184 @opindex mabi=n32
10185 @opindex mabi=64
10186 @opindex mabi=eabi
10187 Generate code for the given ABI@.
10188
10189 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10190 generates 64-bit code when you select a 64-bit architecture, but you
10191 can use @option{-mgp32} to get 32-bit code instead.
10192
10193 For information about the O64 ABI, see
10194 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10195
10196 @item -mabicalls
10197 @itemx -mno-abicalls
10198 @opindex mabicalls
10199 @opindex mno-abicalls
10200 Generate (do not generate) SVR4-style position-independent code.
10201 @option{-mabicalls} is the default for SVR4-based systems.
10202
10203 @item -mxgot
10204 @itemx -mno-xgot
10205 @opindex mxgot
10206 @opindex mno-xgot
10207 Lift (do not lift) the usual restrictions on the size of the global
10208 offset table.
10209
10210 GCC normally uses a single instruction to load values from the GOT@.
10211 While this is relatively efficient, it will only work if the GOT
10212 is smaller than about 64k.  Anything larger will cause the linker
10213 to report an error such as:
10214
10215 @cindex relocation truncated to fit (MIPS)
10216 @smallexample
10217 relocation truncated to fit: R_MIPS_GOT16 foobar
10218 @end smallexample
10219
10220 If this happens, you should recompile your code with @option{-mxgot}.
10221 It should then work with very large GOTs, although it will also be
10222 less efficient, since it will take three instructions to fetch the
10223 value of a global symbol.
10224
10225 Note that some linkers can create multiple GOTs.  If you have such a
10226 linker, you should only need to use @option{-mxgot} when a single object
10227 file accesses more than 64k's worth of GOT entries.  Very few do.
10228
10229 These options have no effect unless GCC is generating position
10230 independent code.
10231
10232 @item -mgp32
10233 @opindex mgp32
10234 Assume that general-purpose registers are 32 bits wide.
10235
10236 @item -mgp64
10237 @opindex mgp64
10238 Assume that general-purpose registers are 64 bits wide.
10239
10240 @item -mfp32
10241 @opindex mfp32
10242 Assume that floating-point registers are 32 bits wide.
10243
10244 @item -mfp64
10245 @opindex mfp64
10246 Assume that floating-point registers are 64 bits wide.
10247
10248 @item -mhard-float
10249 @opindex mhard-float
10250 Use floating-point coprocessor instructions.
10251
10252 @item -msoft-float
10253 @opindex msoft-float
10254 Do not use floating-point coprocessor instructions.  Implement
10255 floating-point calculations using library calls instead.
10256
10257 @item -msingle-float
10258 @opindex msingle-float
10259 Assume that the floating-point coprocessor only supports single-precision
10260 operations.
10261
10262 @itemx -mdouble-float
10263 @opindex mdouble-float
10264 Assume that the floating-point coprocessor supports double-precision
10265 operations.  This is the default.
10266
10267 @itemx -mdsp
10268 @itemx -mno-dsp
10269 @opindex mdsp
10270 @opindex mno-dsp
10271 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10272
10273 @itemx -mpaired-single
10274 @itemx -mno-paired-single
10275 @opindex mpaired-single
10276 @opindex mno-paired-single
10277 Use (do not use) paired-single floating-point instructions.
10278 @xref{MIPS Paired-Single Support}.  This option can only be used
10279 when generating 64-bit code and requires hardware floating-point
10280 support to be enabled.
10281
10282 @itemx -mips3d
10283 @itemx -mno-mips3d
10284 @opindex mips3d
10285 @opindex mno-mips3d
10286 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10287 The option @option{-mips3d} implies @option{-mpaired-single}.
10288
10289 @item -mlong64
10290 @opindex mlong64
10291 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10292 an explanation of the default and the way that the pointer size is
10293 determined.
10294
10295 @item -mlong32
10296 @opindex mlong32
10297 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10298
10299 The default size of @code{int}s, @code{long}s and pointers depends on
10300 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10301 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10302 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10303 or the same size as integer registers, whichever is smaller.
10304
10305 @item -msym32
10306 @itemx -mno-sym32
10307 @opindex msym32
10308 @opindex mno-sym32
10309 Assume (do not assume) that all symbols have 32-bit values, regardless
10310 of the selected ABI@.  This option is useful in combination with
10311 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10312 to generate shorter and faster references to symbolic addresses.
10313
10314 @item -G @var{num}
10315 @opindex G
10316 @cindex smaller data references (MIPS)
10317 @cindex gp-relative references (MIPS)
10318 Put global and static items less than or equal to @var{num} bytes into
10319 the small data or bss section instead of the normal data or bss section.
10320 This allows the data to be accessed using a single instruction.
10321
10322 All modules should be compiled with the same @option{-G @var{num}}
10323 value.
10324
10325 @item -membedded-data
10326 @itemx -mno-embedded-data
10327 @opindex membedded-data
10328 @opindex mno-embedded-data
10329 Allocate variables to the read-only data section first if possible, then
10330 next in the small data section if possible, otherwise in data.  This gives
10331 slightly slower code than the default, but reduces the amount of RAM required
10332 when executing, and thus may be preferred for some embedded systems.
10333
10334 @item -muninit-const-in-rodata
10335 @itemx -mno-uninit-const-in-rodata
10336 @opindex muninit-const-in-rodata
10337 @opindex mno-uninit-const-in-rodata
10338 Put uninitialized @code{const} variables in the read-only data section.
10339 This option is only meaningful in conjunction with @option{-membedded-data}.
10340
10341 @item -msplit-addresses
10342 @itemx -mno-split-addresses
10343 @opindex msplit-addresses
10344 @opindex mno-split-addresses
10345 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10346 relocation operators.  This option has been superseded by
10347 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10348
10349 @item -mexplicit-relocs
10350 @itemx -mno-explicit-relocs
10351 @opindex mexplicit-relocs
10352 @opindex mno-explicit-relocs
10353 Use (do not use) assembler relocation operators when dealing with symbolic
10354 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10355 is to use assembler macros instead.
10356
10357 @option{-mexplicit-relocs} is the default if GCC was configured
10358 to use an assembler that supports relocation operators.
10359
10360 @item -mcheck-zero-division
10361 @itemx -mno-check-zero-division
10362 @opindex mcheck-zero-division
10363 @opindex mno-check-zero-division
10364 Trap (do not trap) on integer division by zero.  The default is
10365 @option{-mcheck-zero-division}.
10366
10367 @item -mdivide-traps
10368 @itemx -mdivide-breaks
10369 @opindex mdivide-traps
10370 @opindex mdivide-breaks
10371 MIPS systems check for division by zero by generating either a
10372 conditional trap or a break instruction.  Using traps results in
10373 smaller code, but is only supported on MIPS II and later.  Also, some
10374 versions of the Linux kernel have a bug that prevents trap from
10375 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10376 allow conditional traps on architectures that support them and
10377 @option{-mdivide-breaks} to force the use of breaks.
10378
10379 The default is usually @option{-mdivide-traps}, but this can be
10380 overridden at configure time using @option{--with-divide=breaks}.
10381 Divide-by-zero checks can be completely disabled using
10382 @option{-mno-check-zero-division}.
10383
10384 @item -mmemcpy
10385 @itemx -mno-memcpy
10386 @opindex mmemcpy
10387 @opindex mno-memcpy
10388 Force (do not force) the use of @code{memcpy()} for non-trivial block
10389 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10390 most constant-sized copies.
10391
10392 @item -mlong-calls
10393 @itemx -mno-long-calls
10394 @opindex mlong-calls
10395 @opindex mno-long-calls
10396 Disable (do not disable) use of the @code{jal} instruction.  Calling
10397 functions using @code{jal} is more efficient but requires the caller
10398 and callee to be in the same 256 megabyte segment.
10399
10400 This option has no effect on abicalls code.  The default is
10401 @option{-mno-long-calls}.
10402
10403 @item -mmad
10404 @itemx -mno-mad
10405 @opindex mmad
10406 @opindex mno-mad
10407 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10408 instructions, as provided by the R4650 ISA@.
10409
10410 @item -mfused-madd
10411 @itemx -mno-fused-madd
10412 @opindex mfused-madd
10413 @opindex mno-fused-madd
10414 Enable (disable) use of the floating point multiply-accumulate
10415 instructions, when they are available.  The default is
10416 @option{-mfused-madd}.
10417
10418 When multiply-accumulate instructions are used, the intermediate
10419 product is calculated to infinite precision and is not subject to
10420 the FCSR Flush to Zero bit.  This may be undesirable in some
10421 circumstances.
10422
10423 @item -nocpp
10424 @opindex nocpp
10425 Tell the MIPS assembler to not run its preprocessor over user
10426 assembler files (with a @samp{.s} suffix) when assembling them.
10427
10428 @item -mfix-r4000
10429 @itemx -mno-fix-r4000
10430 @opindex mfix-r4000
10431 @opindex mno-fix-r4000
10432 Work around certain R4000 CPU errata:
10433 @itemize @minus
10434 @item
10435 A double-word or a variable shift may give an incorrect result if executed
10436 immediately after starting an integer division.
10437 @item
10438 A double-word or a variable shift may give an incorrect result if executed
10439 while an integer multiplication is in progress.
10440 @item
10441 An integer division may give an incorrect result if started in a delay slot
10442 of a taken branch or a jump.
10443 @end itemize
10444
10445 @item -mfix-r4400
10446 @itemx -mno-fix-r4400
10447 @opindex mfix-r4400
10448 @opindex mno-fix-r4400
10449 Work around certain R4400 CPU errata:
10450 @itemize @minus
10451 @item
10452 A double-word or a variable shift may give an incorrect result if executed
10453 immediately after starting an integer division.
10454 @end itemize
10455
10456 @item -mfix-vr4120
10457 @itemx -mno-fix-vr4120
10458 @opindex mfix-vr4120
10459 Work around certain VR4120 errata:
10460 @itemize @minus
10461 @item
10462 @code{dmultu} does not always produce the correct result.
10463 @item
10464 @code{div} and @code{ddiv} do not always produce the correct result if one
10465 of the operands is negative.
10466 @end itemize
10467 The workarounds for the division errata rely on special functions in
10468 @file{libgcc.a}.  At present, these functions are only provided by
10469 the @code{mips64vr*-elf} configurations.
10470
10471 Other VR4120 errata require a nop to be inserted between certain pairs of
10472 instructions.  These errata are handled by the assembler, not by GCC itself.
10473
10474 @item -mfix-vr4130
10475 @opindex mfix-vr4130
10476 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10477 workarounds are implemented by the assembler rather than by GCC,
10478 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10479 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10480 instructions are available instead.
10481
10482 @item -mfix-sb1
10483 @itemx -mno-fix-sb1
10484 @opindex mfix-sb1
10485 Work around certain SB-1 CPU core errata.
10486 (This flag currently works around the SB-1 revision 2
10487 ``F1'' and ``F2'' floating point errata.)
10488
10489 @item -mflush-func=@var{func}
10490 @itemx -mno-flush-func
10491 @opindex mflush-func
10492 Specifies the function to call to flush the I and D caches, or to not
10493 call any such function.  If called, the function must take the same
10494 arguments as the common @code{_flush_func()}, that is, the address of the
10495 memory range for which the cache is being flushed, the size of the
10496 memory range, and the number 3 (to flush both caches).  The default
10497 depends on the target GCC was configured for, but commonly is either
10498 @samp{_flush_func} or @samp{__cpu_flush}.
10499
10500 @item -mbranch-likely
10501 @itemx -mno-branch-likely
10502 @opindex mbranch-likely
10503 @opindex mno-branch-likely
10504 Enable or disable use of Branch Likely instructions, regardless of the
10505 default for the selected architecture.  By default, Branch Likely
10506 instructions may be generated if they are supported by the selected
10507 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10508 and processors which implement those architectures; for those, Branch
10509 Likely instructions will not be generated by default because the MIPS32
10510 and MIPS64 architectures specifically deprecate their use.
10511
10512 @item -mfp-exceptions
10513 @itemx -mno-fp-exceptions
10514 @opindex mfp-exceptions
10515 Specifies whether FP exceptions are enabled.  This affects how we schedule
10516 FP instructions for some processors.  The default is that FP exceptions are
10517 enabled.
10518
10519 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10520 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10521 FP pipe.
10522
10523 @item -mvr4130-align
10524 @itemx -mno-vr4130-align
10525 @opindex mvr4130-align
10526 The VR4130 pipeline is two-way superscalar, but can only issue two
10527 instructions together if the first one is 8-byte aligned.  When this
10528 option is enabled, GCC will align pairs of instructions that it
10529 thinks should execute in parallel.
10530
10531 This option only has an effect when optimizing for the VR4130.
10532 It normally makes code faster, but at the expense of making it bigger.
10533 It is enabled by default at optimization level @option{-O3}.
10534 @end table
10535
10536 @node MMIX Options
10537 @subsection MMIX Options
10538 @cindex MMIX Options
10539
10540 These options are defined for the MMIX:
10541
10542 @table @gcctabopt
10543 @item -mlibfuncs
10544 @itemx -mno-libfuncs
10545 @opindex mlibfuncs
10546 @opindex mno-libfuncs
10547 Specify that intrinsic library functions are being compiled, passing all
10548 values in registers, no matter the size.
10549
10550 @item -mepsilon
10551 @itemx -mno-epsilon
10552 @opindex mepsilon
10553 @opindex mno-epsilon
10554 Generate floating-point comparison instructions that compare with respect
10555 to the @code{rE} epsilon register.
10556
10557 @item -mabi=mmixware
10558 @itemx -mabi=gnu
10559 @opindex mabi-mmixware
10560 @opindex mabi=gnu
10561 Generate code that passes function parameters and return values that (in
10562 the called function) are seen as registers @code{$0} and up, as opposed to
10563 the GNU ABI which uses global registers @code{$231} and up.
10564
10565 @item -mzero-extend
10566 @itemx -mno-zero-extend
10567 @opindex mzero-extend
10568 @opindex mno-zero-extend
10569 When reading data from memory in sizes shorter than 64 bits, use (do not
10570 use) zero-extending load instructions by default, rather than
10571 sign-extending ones.
10572
10573 @item -mknuthdiv
10574 @itemx -mno-knuthdiv
10575 @opindex mknuthdiv
10576 @opindex mno-knuthdiv
10577 Make the result of a division yielding a remainder have the same sign as
10578 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10579 remainder follows the sign of the dividend.  Both methods are
10580 arithmetically valid, the latter being almost exclusively used.
10581
10582 @item -mtoplevel-symbols
10583 @itemx -mno-toplevel-symbols
10584 @opindex mtoplevel-symbols
10585 @opindex mno-toplevel-symbols
10586 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10587 code can be used with the @code{PREFIX} assembly directive.
10588
10589 @item -melf
10590 @opindex melf
10591 Generate an executable in the ELF format, rather than the default
10592 @samp{mmo} format used by the @command{mmix} simulator.
10593
10594 @item -mbranch-predict
10595 @itemx -mno-branch-predict
10596 @opindex mbranch-predict
10597 @opindex mno-branch-predict
10598 Use (do not use) the probable-branch instructions, when static branch
10599 prediction indicates a probable branch.
10600
10601 @item -mbase-addresses
10602 @itemx -mno-base-addresses
10603 @opindex mbase-addresses
10604 @opindex mno-base-addresses
10605 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10606 base address automatically generates a request (handled by the assembler
10607 and the linker) for a constant to be set up in a global register.  The
10608 register is used for one or more base address requests within the range 0
10609 to 255 from the value held in the register.  The generally leads to short
10610 and fast code, but the number of different data items that can be
10611 addressed is limited.  This means that a program that uses lots of static
10612 data may require @option{-mno-base-addresses}.
10613
10614 @item -msingle-exit
10615 @itemx -mno-single-exit
10616 @opindex msingle-exit
10617 @opindex mno-single-exit
10618 Force (do not force) generated code to have a single exit point in each
10619 function.
10620 @end table
10621
10622 @node MN10300 Options
10623 @subsection MN10300 Options
10624 @cindex MN10300 options
10625
10626 These @option{-m} options are defined for Matsushita MN10300 architectures:
10627
10628 @table @gcctabopt
10629 @item -mmult-bug
10630 @opindex mmult-bug
10631 Generate code to avoid bugs in the multiply instructions for the MN10300
10632 processors.  This is the default.
10633
10634 @item -mno-mult-bug
10635 @opindex mno-mult-bug
10636 Do not generate code to avoid bugs in the multiply instructions for the
10637 MN10300 processors.
10638
10639 @item -mam33
10640 @opindex mam33
10641 Generate code which uses features specific to the AM33 processor.
10642
10643 @item -mno-am33
10644 @opindex mno-am33
10645 Do not generate code which uses features specific to the AM33 processor.  This
10646 is the default.
10647
10648 @item -mreturn-pointer-on-d0
10649 @opindex mreturn-pointer-on-d0
10650 When generating a function which returns a pointer, return the pointer
10651 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10652 only in a0, and attempts to call such functions without a prototype
10653 would result in errors.  Note that this option is on by default; use
10654 @option{-mno-return-pointer-on-d0} to disable it.
10655
10656 @item -mno-crt0
10657 @opindex mno-crt0
10658 Do not link in the C run-time initialization object file.
10659
10660 @item -mrelax
10661 @opindex mrelax
10662 Indicate to the linker that it should perform a relaxation optimization pass
10663 to shorten branches, calls and absolute memory addresses.  This option only
10664 has an effect when used on the command line for the final link step.
10665
10666 This option makes symbolic debugging impossible.
10667 @end table
10668
10669 @node MS1 Options
10670 @subsection MS1 Options
10671 @cindex MS1 options
10672
10673 These @option{-m} options are defined for Morpho MS1 architectures:
10674
10675 @table @gcctabopt
10676
10677 @item -march=@var{cpu-type}
10678 @opindex march
10679 Generate code that will run on @var{cpu-type}, which is the name of a system
10680 representing a certain processor type.  Possible values for
10681 @var{cpu-type} are @samp{MS1-64-001}, @samp{MS1-16-002}, and
10682 @samp{MS1-16-003}.
10683
10684 When this option is not used, the default is @option{-march=MS1-16-003}.
10685
10686 @item -mmul
10687 @opindex mmul
10688 Generate multiply instructions.
10689
10690 @item -mno-mul
10691 @opindex mno-mul
10692 Do not generate multiply instructions.
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+},
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 -mabi=spe
11031 @opindex mabi=spe
11032 Extend the current ABI with SPE ABI extensions.  This does not change
11033 the default ABI, instead it adds the SPE ABI extensions to the current
11034 ABI@.
11035
11036 @item -mabi=no-spe
11037 @opindex mabi=no-spe
11038 Disable Booke SPE ABI extensions for the current ABI@.
11039
11040 @item -msecure-plt
11041 @opindex msecure-plt
11042 Generate code that allows ld and ld.so to build executables and shared
11043 libraries with non-exec .plt and .got sections.  This is a PowerPC
11044 32-bit SYSV ABI option.
11045
11046 @item -mbss-plt
11047 @opindex mbss-plt
11048 Generate code that uses a BSS .plt section that ld.so fills in, and
11049 requires .plt and .got sections that are both writable and executable.
11050 This is a PowerPC 32-bit SYSV ABI option.
11051
11052 @item -misel
11053 @itemx -mno-isel
11054 @opindex misel
11055 @opindex mno-isel
11056 This switch enables or disables the generation of ISEL instructions.
11057
11058 @item -misel=@var{yes/no}
11059 This switch has been deprecated.  Use @option{-misel} and
11060 @option{-mno-isel} instead.
11061
11062 @item -mspe
11063 @itemx -mno-isel
11064 @opindex mspe
11065 @opindex mno-spe
11066 This switch enables or disables the generation of SPE simd
11067 instructions.
11068
11069 @item -mspe=@var{yes/no}
11070 This option has been deprecated.  Use @option{-mspe} and
11071 @option{-mno-spe} instead.
11072
11073 @item -mfloat-gprs=@var{yes/single/double/no}
11074 @itemx -mfloat-gprs
11075 @opindex mfloat-gprs
11076 This switch enables or disables the generation of floating point
11077 operations on the general purpose registers for architectures that
11078 support it.
11079
11080 The argument @var{yes} or @var{single} enables the use of
11081 single-precision floating point operations.
11082
11083 The argument @var{double} enables the use of single and
11084 double-precision floating point operations.
11085
11086 The argument @var{no} disables floating point operations on the
11087 general purpose registers.
11088
11089 This option is currently only available on the MPC854x.
11090
11091 @item -m32
11092 @itemx -m64
11093 @opindex m32
11094 @opindex m64
11095 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11096 targets (including GNU/Linux).  The 32-bit environment sets int, long
11097 and pointer to 32 bits and generates code that runs on any PowerPC
11098 variant.  The 64-bit environment sets int to 32 bits and long and
11099 pointer to 64 bits, and generates code for PowerPC64, as for
11100 @option{-mpowerpc64}.
11101
11102 @item -mfull-toc
11103 @itemx -mno-fp-in-toc
11104 @itemx -mno-sum-in-toc
11105 @itemx -mminimal-toc
11106 @opindex mfull-toc
11107 @opindex mno-fp-in-toc
11108 @opindex mno-sum-in-toc
11109 @opindex mminimal-toc
11110 Modify generation of the TOC (Table Of Contents), which is created for
11111 every executable file.  The @option{-mfull-toc} option is selected by
11112 default.  In that case, GCC will allocate at least one TOC entry for
11113 each unique non-automatic variable reference in your program.  GCC
11114 will also place floating-point constants in the TOC@.  However, only
11115 16,384 entries are available in the TOC@.
11116
11117 If you receive a linker error message that saying you have overflowed
11118 the available TOC space, you can reduce the amount of TOC space used
11119 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11120 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11121 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11122 generate code to calculate the sum of an address and a constant at
11123 run-time instead of putting that sum into the TOC@.  You may specify one
11124 or both of these options.  Each causes GCC to produce very slightly
11125 slower and larger code at the expense of conserving TOC space.
11126
11127 If you still run out of space in the TOC even when you specify both of
11128 these options, specify @option{-mminimal-toc} instead.  This option causes
11129 GCC to make only one TOC entry for every file.  When you specify this
11130 option, GCC will produce code that is slower and larger but which
11131 uses extremely little TOC space.  You may wish to use this option
11132 only on files that contain less frequently executed code.
11133
11134 @item -maix64
11135 @itemx -maix32
11136 @opindex maix64
11137 @opindex maix32
11138 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11139 @code{long} type, and the infrastructure needed to support them.
11140 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11141 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11142 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11143
11144 @item -mxl-compat
11145 @itemx -mno-xl-compat
11146 @opindex mxl-compat
11147 @opindex mno-xl-compat
11148 Produce code that conforms more closely to IBM XLC semantics when using
11149 AIX-compatible ABI.  Pass floating-point arguments to prototyped
11150 functions beyond the register save area (RSA) on the stack in addition
11151 to argument FPRs.  Do not assume that most significant double in 128
11152 bit long double value is properly rounded when comparing values.
11153
11154 The AIX calling convention was extended but not initially documented to
11155 handle an obscure K&R C case of calling a function that takes the
11156 address of its arguments with fewer arguments than declared.  AIX XL
11157 compilers access floating point arguments which do not fit in the
11158 RSA from the stack when a subroutine is compiled without
11159 optimization.  Because always storing floating-point arguments on the
11160 stack is inefficient and rarely needed, this option is not enabled by
11161 default and only is necessary when calling subroutines compiled by AIX
11162 XL compilers without optimization.
11163
11164 @item -mpe
11165 @opindex mpe
11166 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11167 application written to use message passing with special startup code to
11168 enable the application to run.  The system must have PE installed in the
11169 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11170 must be overridden with the @option{-specs=} option to specify the
11171 appropriate directory location.  The Parallel Environment does not
11172 support threads, so the @option{-mpe} option and the @option{-pthread}
11173 option are incompatible.
11174
11175 @item -malign-natural
11176 @itemx -malign-power
11177 @opindex malign-natural
11178 @opindex malign-power
11179 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11180 @option{-malign-natural} overrides the ABI-defined alignment of larger
11181 types, such as floating-point doubles, on their natural size-based boundary.
11182 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11183 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11184
11185 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11186 is not supported.
11187
11188 @item -msoft-float
11189 @itemx -mhard-float
11190 @opindex msoft-float
11191 @opindex mhard-float
11192 Generate code that does not use (uses) the floating-point register set.
11193 Software floating point emulation is provided if you use the
11194 @option{-msoft-float} option, and pass the option to GCC when linking.
11195
11196 @item -mmultiple
11197 @itemx -mno-multiple
11198 @opindex mmultiple
11199 @opindex mno-multiple
11200 Generate code that uses (does not use) the load multiple word
11201 instructions and the store multiple word instructions.  These
11202 instructions are generated by default on POWER systems, and not
11203 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11204 endian PowerPC systems, since those instructions do not work when the
11205 processor is in little endian mode.  The exceptions are PPC740 and
11206 PPC750 which permit the instructions usage in little endian mode.
11207
11208 @item -mstring
11209 @itemx -mno-string
11210 @opindex mstring
11211 @opindex mno-string
11212 Generate code that uses (does not use) the load string instructions
11213 and the store string word instructions to save multiple registers and
11214 do small block moves.  These instructions are generated by default on
11215 POWER systems, and not generated on PowerPC systems.  Do not use
11216 @option{-mstring} on little endian PowerPC systems, since those
11217 instructions do not work when the processor is in little endian mode.
11218 The exceptions are PPC740 and PPC750 which permit the instructions
11219 usage in little endian mode.
11220
11221 @item -mupdate
11222 @itemx -mno-update
11223 @opindex mupdate
11224 @opindex mno-update
11225 Generate code that uses (does not use) the load or store instructions
11226 that update the base register to the address of the calculated memory
11227 location.  These instructions are generated by default.  If you use
11228 @option{-mno-update}, there is a small window between the time that the
11229 stack pointer is updated and the address of the previous frame is
11230 stored, which means code that walks the stack frame across interrupts or
11231 signals may get corrupted data.
11232
11233 @item -mfused-madd
11234 @itemx -mno-fused-madd
11235 @opindex mfused-madd
11236 @opindex mno-fused-madd
11237 Generate code that uses (does not use) the floating point multiply and
11238 accumulate instructions.  These instructions are generated by default if
11239 hardware floating is used.
11240
11241 @item -mno-bit-align
11242 @itemx -mbit-align
11243 @opindex mno-bit-align
11244 @opindex mbit-align
11245 On System V.4 and embedded PowerPC systems do not (do) force structures
11246 and unions that contain bit-fields to be aligned to the base type of the
11247 bit-field.
11248
11249 For example, by default a structure containing nothing but 8
11250 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11251 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11252 the structure would be aligned to a 1 byte boundary and be one byte in
11253 size.
11254
11255 @item -mno-strict-align
11256 @itemx -mstrict-align
11257 @opindex mno-strict-align
11258 @opindex mstrict-align
11259 On System V.4 and embedded PowerPC systems do not (do) assume that
11260 unaligned memory references will be handled by the system.
11261
11262 @item -mrelocatable
11263 @itemx -mno-relocatable
11264 @opindex mrelocatable
11265 @opindex mno-relocatable
11266 On embedded PowerPC systems generate code that allows (does not allow)
11267 the program to be relocated to a different address at runtime.  If you
11268 use @option{-mrelocatable} on any module, all objects linked together must
11269 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11270
11271 @item -mrelocatable-lib
11272 @itemx -mno-relocatable-lib
11273 @opindex mrelocatable-lib
11274 @opindex mno-relocatable-lib
11275 On embedded PowerPC systems generate code that allows (does not allow)
11276 the program to be relocated to a different address at runtime.  Modules
11277 compiled with @option{-mrelocatable-lib} can be linked with either modules
11278 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11279 with modules compiled with the @option{-mrelocatable} options.
11280
11281 @item -mno-toc
11282 @itemx -mtoc
11283 @opindex mno-toc
11284 @opindex mtoc
11285 On System V.4 and embedded PowerPC systems do not (do) assume that
11286 register 2 contains a pointer to a global area pointing to the addresses
11287 used in the program.
11288
11289 @item -mlittle
11290 @itemx -mlittle-endian
11291 @opindex mlittle
11292 @opindex mlittle-endian
11293 On System V.4 and embedded PowerPC systems compile code for the
11294 processor in little endian mode.  The @option{-mlittle-endian} option is
11295 the same as @option{-mlittle}.
11296
11297 @item -mbig
11298 @itemx -mbig-endian
11299 @opindex mbig
11300 @opindex mbig-endian
11301 On System V.4 and embedded PowerPC systems compile code for the
11302 processor in big endian mode.  The @option{-mbig-endian} option is
11303 the same as @option{-mbig}.
11304
11305 @item -mdynamic-no-pic
11306 @opindex mdynamic-no-pic
11307 On Darwin and Mac OS X systems, compile code so that it is not
11308 relocatable, but that its external references are relocatable.  The
11309 resulting code is suitable for applications, but not shared
11310 libraries.
11311
11312 @item -mprioritize-restricted-insns=@var{priority}
11313 @opindex mprioritize-restricted-insns
11314 This option controls the priority that is assigned to
11315 dispatch-slot restricted instructions during the second scheduling
11316 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11317 @var{no/highest/second-highest} priority to dispatch slot restricted
11318 instructions.
11319
11320 @item -msched-costly-dep=@var{dependence_type}
11321 @opindex msched-costly-dep
11322 This option controls which dependences are considered costly
11323 by the target during instruction scheduling.  The argument
11324 @var{dependence_type} takes one of the following values:
11325 @var{no}: no dependence is costly,
11326 @var{all}: all dependences are costly,
11327 @var{true_store_to_load}: a true dependence from store to load is costly,
11328 @var{store_to_load}: any dependence from store to load is costly,
11329 @var{number}: any dependence which latency >= @var{number} is costly.
11330
11331 @item -minsert-sched-nops=@var{scheme}
11332 @opindex minsert-sched-nops
11333 This option controls which nop insertion scheme will be used during
11334 the second scheduling pass.  The argument @var{scheme} takes one of the
11335 following values:
11336 @var{no}: Don't insert nops.
11337 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11338 according to the scheduler's grouping.
11339 @var{regroup_exact}: Insert nops to force costly dependent insns into
11340 separate groups.  Insert exactly as many nops as needed to force an insn
11341 to a new group, according to the estimated processor grouping.
11342 @var{number}: Insert nops to force costly dependent insns into
11343 separate groups.  Insert @var{number} nops to force an insn to a new group.
11344
11345 @item -mcall-sysv
11346 @opindex mcall-sysv
11347 On System V.4 and embedded PowerPC systems compile code using calling
11348 conventions that adheres to the March 1995 draft of the System V
11349 Application Binary Interface, PowerPC processor supplement.  This is the
11350 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11351
11352 @item -mcall-sysv-eabi
11353 @opindex mcall-sysv-eabi
11354 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11355
11356 @item -mcall-sysv-noeabi
11357 @opindex mcall-sysv-noeabi
11358 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11359
11360 @item -mcall-solaris
11361 @opindex mcall-solaris
11362 On System V.4 and embedded PowerPC systems compile code for the Solaris
11363 operating system.
11364
11365 @item -mcall-linux
11366 @opindex mcall-linux
11367 On System V.4 and embedded PowerPC systems compile code for the
11368 Linux-based GNU system.
11369
11370 @item -mcall-gnu
11371 @opindex mcall-gnu
11372 On System V.4 and embedded PowerPC systems compile code for the
11373 Hurd-based GNU system.
11374
11375 @item -mcall-netbsd
11376 @opindex mcall-netbsd
11377 On System V.4 and embedded PowerPC systems compile code for the
11378 NetBSD operating system.
11379
11380 @item -maix-struct-return
11381 @opindex maix-struct-return
11382 Return all structures in memory (as specified by the AIX ABI)@.
11383
11384 @item -msvr4-struct-return
11385 @opindex msvr4-struct-return
11386 Return structures smaller than 8 bytes in registers (as specified by the
11387 SVR4 ABI)@.
11388
11389 @item -mabi=@var{abi-type}
11390 @opindex mabi
11391 Extend the current ABI with a particular extension, or remove such extension.
11392 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11393 @var{no-spe}@.
11394
11395 @item -mprototype
11396 @itemx -mno-prototype
11397 @opindex mprototype
11398 @opindex mno-prototype
11399 On System V.4 and embedded PowerPC systems assume that all calls to
11400 variable argument functions are properly prototyped.  Otherwise, the
11401 compiler must insert an instruction before every non prototyped call to
11402 set or clear bit 6 of the condition code register (@var{CR}) to
11403 indicate whether floating point values were passed in the floating point
11404 registers in case the function takes a variable arguments.  With
11405 @option{-mprototype}, only calls to prototyped variable argument functions
11406 will set or clear the bit.
11407
11408 @item -msim
11409 @opindex msim
11410 On embedded PowerPC systems, assume that the startup module is called
11411 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11412 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11413 configurations.
11414
11415 @item -mmvme
11416 @opindex mmvme
11417 On embedded PowerPC systems, assume that the startup module is called
11418 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11419 @file{libc.a}.
11420
11421 @item -mads
11422 @opindex mads
11423 On embedded PowerPC systems, assume that the startup module is called
11424 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11425 @file{libc.a}.
11426
11427 @item -myellowknife
11428 @opindex myellowknife
11429 On embedded PowerPC systems, assume that the startup module is called
11430 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11431 @file{libc.a}.
11432
11433 @item -mvxworks
11434 @opindex mvxworks
11435 On System V.4 and embedded PowerPC systems, specify that you are
11436 compiling for a VxWorks system.
11437
11438 @item -mwindiss
11439 @opindex mwindiss
11440 Specify that you are compiling for the WindISS simulation environment.
11441
11442 @item -memb
11443 @opindex memb
11444 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11445 header to indicate that @samp{eabi} extended relocations are used.
11446
11447 @item -meabi
11448 @itemx -mno-eabi
11449 @opindex meabi
11450 @opindex mno-eabi
11451 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11452 Embedded Applications Binary Interface (eabi) which is a set of
11453 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11454 means that the stack is aligned to an 8 byte boundary, a function
11455 @code{__eabi} is called to from @code{main} to set up the eabi
11456 environment, and the @option{-msdata} option can use both @code{r2} and
11457 @code{r13} to point to two separate small data areas.  Selecting
11458 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11459 do not call an initialization function from @code{main}, and the
11460 @option{-msdata} option will only use @code{r13} to point to a single
11461 small data area.  The @option{-meabi} option is on by default if you
11462 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11463
11464 @item -msdata=eabi
11465 @opindex msdata=eabi
11466 On System V.4 and embedded PowerPC systems, put small initialized
11467 @code{const} global and static data in the @samp{.sdata2} section, which
11468 is pointed to by register @code{r2}.  Put small initialized
11469 non-@code{const} global and static data in the @samp{.sdata} section,
11470 which is pointed to by register @code{r13}.  Put small uninitialized
11471 global and static data in the @samp{.sbss} section, which is adjacent to
11472 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11473 incompatible with the @option{-mrelocatable} option.  The
11474 @option{-msdata=eabi} option also sets the @option{-memb} option.
11475
11476 @item -msdata=sysv
11477 @opindex msdata=sysv
11478 On System V.4 and embedded PowerPC systems, put small global and static
11479 data in the @samp{.sdata} section, which is pointed to by register
11480 @code{r13}.  Put small uninitialized global and static data in the
11481 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11482 The @option{-msdata=sysv} option is incompatible with the
11483 @option{-mrelocatable} option.
11484
11485 @item -msdata=default
11486 @itemx -msdata
11487 @opindex msdata=default
11488 @opindex msdata
11489 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11490 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11491 same as @option{-msdata=sysv}.
11492
11493 @item -msdata-data
11494 @opindex msdata-data
11495 On System V.4 and embedded PowerPC systems, put small global and static
11496 data in the @samp{.sdata} section.  Put small uninitialized global and
11497 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11498 to address small data however.  This is the default behavior unless
11499 other @option{-msdata} options are used.
11500
11501 @item -msdata=none
11502 @itemx -mno-sdata
11503 @opindex msdata=none
11504 @opindex mno-sdata
11505 On embedded PowerPC systems, put all initialized global and static data
11506 in the @samp{.data} section, and all uninitialized data in the
11507 @samp{.bss} section.
11508
11509 @item -G @var{num}
11510 @opindex G
11511 @cindex smaller data references (PowerPC)
11512 @cindex .sdata/.sdata2 references (PowerPC)
11513 On embedded PowerPC systems, put global and static items less than or
11514 equal to @var{num} bytes into the small data or bss sections instead of
11515 the normal data or bss section.  By default, @var{num} is 8.  The
11516 @option{-G @var{num}} switch is also passed to the linker.
11517 All modules should be compiled with the same @option{-G @var{num}} value.
11518
11519 @item -mregnames
11520 @itemx -mno-regnames
11521 @opindex mregnames
11522 @opindex mno-regnames
11523 On System V.4 and embedded PowerPC systems do (do not) emit register
11524 names in the assembly language output using symbolic forms.
11525
11526 @item -mlongcall
11527 @itemx -mno-longcall
11528 @opindex mlongcall
11529 @opindex mno-longcall
11530 Default to making all function calls indirectly, using a register, so
11531 that functions which reside further than 32 megabytes (33,554,432
11532 bytes) from the current location can be called.  This setting can be
11533 overridden by the @code{shortcall} function attribute, or by
11534 @code{#pragma longcall(0)}.
11535
11536 Some linkers are capable of detecting out-of-range calls and generating
11537 glue code on the fly.  On these systems, long calls are unnecessary and
11538 generate slower code.  As of this writing, the AIX linker can do this,
11539 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11540 to the GNU linker for 32-bit PowerPC systems as well.
11541
11542 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11543 callee, L42'', plus a ``branch island'' (glue code).  The two target
11544 addresses represent the callee and the ``branch island''.  The
11545 Darwin/PPC linker will prefer the first address and generate a ``bl
11546 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11547 otherwise, the linker will generate ``bl L42'' to call the ``branch
11548 island''.  The ``branch island'' is appended to the body of the
11549 calling function; it computes the full 32-bit address of the callee
11550 and jumps to it.
11551
11552 On Mach-O (Darwin) systems, this option directs the compiler emit to
11553 the glue for every direct call, and the Darwin linker decides whether
11554 to use or discard it.
11555
11556 In the future, we may cause GCC to ignore all longcall specifications
11557 when the linker is known to generate glue.
11558
11559 @item -pthread
11560 @opindex pthread
11561 Adds support for multithreading with the @dfn{pthreads} library.
11562 This option sets flags for both the preprocessor and linker.
11563
11564 @end table
11565
11566 @node S/390 and zSeries Options
11567 @subsection S/390 and zSeries Options
11568 @cindex S/390 and zSeries Options
11569
11570 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11571
11572 @table @gcctabopt
11573 @item -mhard-float
11574 @itemx -msoft-float
11575 @opindex mhard-float
11576 @opindex msoft-float
11577 Use (do not use) the hardware floating-point instructions and registers
11578 for floating-point operations.  When @option{-msoft-float} is specified,
11579 functions in @file{libgcc.a} will be used to perform floating-point
11580 operations.  When @option{-mhard-float} is specified, the compiler
11581 generates IEEE floating-point instructions.  This is the default.
11582
11583 @item -mbackchain
11584 @itemx -mno-backchain
11585 @opindex mbackchain
11586 @opindex mno-backchain
11587 Store (do not store) the address of the caller's frame as backchain pointer
11588 into the callee's stack frame.
11589 A backchain may be needed to allow debugging using tools that do not understand
11590 DWARF-2 call frame information.
11591 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11592 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11593 the backchain is placed into the topmost word of the 96/160 byte register
11594 save area.
11595
11596 In general, code compiled with @option{-mbackchain} is call-compatible with
11597 code compiled with @option{-mmo-backchain}; however, use of the backchain
11598 for debugging purposes usually requires that the whole binary is built with
11599 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11600 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11601 to build a linux kernel use @option{-msoft-float}.
11602
11603 The default is to not maintain the backchain.
11604
11605 @item -mpacked-stack
11606 @item -mno-packed-stack
11607 @opindex mpacked-stack
11608 @opindex mno-packed-stack
11609 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11610 specified, the compiler uses the all fields of the 96/160 byte register save
11611 area only for their default purpose; unused fields still take up stack space.
11612 When @option{-mpacked-stack} is specified, register save slots are densely
11613 packed at the top of the register save area; unused space is reused for other
11614 purposes, allowing for more efficient use of the available stack space.
11615 However, when @option{-mbackchain} is also in effect, the topmost word of
11616 the save area is always used to store the backchain, and the return address
11617 register is always saved two words below the backchain.
11618
11619 As long as the stack frame backchain is not used, code generated with
11620 @option{-mpacked-stack} is call-compatible with code generated with
11621 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11622 S/390 or zSeries generated code that uses the stack frame backchain at run
11623 time, not just for debugging purposes.  Such code is not call-compatible
11624 with code compiled with @option{-mpacked-stack}.  Also, note that the
11625 combination of @option{-mbackchain},
11626 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11627 to build a linux kernel use @option{-msoft-float}.
11628
11629 The default is to not use the packed stack layout.
11630
11631 @item -msmall-exec
11632 @itemx -mno-small-exec
11633 @opindex msmall-exec
11634 @opindex mno-small-exec
11635 Generate (or do not generate) code using the @code{bras} instruction
11636 to do subroutine calls.
11637 This only works reliably if the total executable size does not
11638 exceed 64k.  The default is to use the @code{basr} instruction instead,
11639 which does not have this limitation.
11640
11641 @item -m64
11642 @itemx -m31
11643 @opindex m64
11644 @opindex m31
11645 When @option{-m31} is specified, generate code compliant to the
11646 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11647 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11648 particular to generate 64-bit instructions.  For the @samp{s390}
11649 targets, the default is @option{-m31}, while the @samp{s390x}
11650 targets default to @option{-m64}.
11651
11652 @item -mzarch
11653 @itemx -mesa
11654 @opindex mzarch
11655 @opindex mesa
11656 When @option{-mzarch} is specified, generate code using the
11657 instructions available on z/Architecture.
11658 When @option{-mesa} is specified, generate code using the
11659 instructions available on ESA/390.  Note that @option{-mesa} is
11660 not possible with @option{-m64}.
11661 When generating code compliant to the GNU/Linux for S/390 ABI,
11662 the default is @option{-mesa}.  When generating code compliant
11663 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11664
11665 @item -mmvcle
11666 @itemx -mno-mvcle
11667 @opindex mmvcle
11668 @opindex mno-mvcle
11669 Generate (or do not generate) code using the @code{mvcle} instruction
11670 to perform block moves.  When @option{-mno-mvcle} is specified,
11671 use a @code{mvc} loop instead.  This is the default unless optimizing for
11672 size.
11673
11674 @item -mdebug
11675 @itemx -mno-debug
11676 @opindex mdebug
11677 @opindex mno-debug
11678 Print (or do not print) additional debug information when compiling.
11679 The default is to not print debug information.
11680
11681 @item -march=@var{cpu-type}
11682 @opindex march
11683 Generate code that will run on @var{cpu-type}, which is the name of a system
11684 representing a certain processor type.  Possible values for
11685 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11686 When generating code using the instructions available on z/Architecture,
11687 the default is @option{-march=z900}.  Otherwise, the default is
11688 @option{-march=g5}.
11689
11690 @item -mtune=@var{cpu-type}
11691 @opindex mtune
11692 Tune to @var{cpu-type} everything applicable about the generated code,
11693 except for the ABI and the set of available instructions.
11694 The list of @var{cpu-type} values is the same as for @option{-march}.
11695 The default is the value used for @option{-march}.
11696
11697 @item -mtpf-trace
11698 @itemx -mno-tpf-trace
11699 @opindex mtpf-trace
11700 @opindex mno-tpf-trace
11701 Generate code that adds (does not add) in TPF OS specific branches to trace
11702 routines in the operating system.  This option is off by default, even
11703 when compiling for the TPF OS@.
11704
11705 @item -mfused-madd
11706 @itemx -mno-fused-madd
11707 @opindex mfused-madd
11708 @opindex mno-fused-madd
11709 Generate code that uses (does not use) the floating point multiply and
11710 accumulate instructions.  These instructions are generated by default if
11711 hardware floating point is used.
11712
11713 @item -mwarn-framesize=@var{framesize}
11714 @opindex mwarn-framesize
11715 Emit a warning if the current function exceeds the given frame size.  Because
11716 this is a compile time check it doesn't need to be a real problem when the program
11717 runs.  It is intended to identify functions which most probably cause
11718 a stack overflow.  It is useful to be used in an environment with limited stack
11719 size e.g.@: the linux kernel.
11720
11721 @item -mwarn-dynamicstack
11722 @opindex mwarn-dynamicstack
11723 Emit a warning if the function calls alloca or uses dynamically
11724 sized arrays.  This is generally a bad idea with a limited stack size.
11725
11726 @item -mstack-guard=@var{stack-guard}
11727 @item -mstack-size=@var{stack-size}
11728 @opindex mstack-guard
11729 @opindex mstack-size
11730 These arguments always have to be used in conjunction.  If they are present the s390
11731 back end emits additional instructions in the function prologue which trigger a trap
11732 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11733 (remember that the stack on s390 grows downward).  These options are intended to
11734 be used to help debugging stack overflow problems.  The additionally emitted code
11735 causes only little overhead and hence can also be used in production like systems
11736 without greater performance degradation.  The given values have to be exact
11737 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11738 exceeding 64k.
11739 In order to be efficient the extra code makes the assumption that the stack starts
11740 at an address aligned to the value given by @var{stack-size}.
11741 @end table
11742
11743 @node SH Options
11744 @subsection SH Options
11745
11746 These @samp{-m} options are defined for the SH implementations:
11747
11748 @table @gcctabopt
11749 @item -m1
11750 @opindex m1
11751 Generate code for the SH1.
11752
11753 @item -m2
11754 @opindex m2
11755 Generate code for the SH2.
11756
11757 @item -m2e
11758 Generate code for the SH2e.
11759
11760 @item -m3
11761 @opindex m3
11762 Generate code for the SH3.
11763
11764 @item -m3e
11765 @opindex m3e
11766 Generate code for the SH3e.
11767
11768 @item -m4-nofpu
11769 @opindex m4-nofpu
11770 Generate code for the SH4 without a floating-point unit.
11771
11772 @item -m4-single-only
11773 @opindex m4-single-only
11774 Generate code for the SH4 with a floating-point unit that only
11775 supports single-precision arithmetic.
11776
11777 @item -m4-single
11778 @opindex m4-single
11779 Generate code for the SH4 assuming the floating-point unit is in
11780 single-precision mode by default.
11781
11782 @item -m4
11783 @opindex m4
11784 Generate code for the SH4.
11785
11786 @item -m4a-nofpu
11787 @opindex m4a-nofpu
11788 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11789 floating-point unit is not used.
11790
11791 @item -m4a-single-only
11792 @opindex m4a-single-only
11793 Generate code for the SH4a, in such a way that no double-precision
11794 floating point operations are used.
11795
11796 @item -m4a-single
11797 @opindex m4a-single
11798 Generate code for the SH4a assuming the floating-point unit is in
11799 single-precision mode by default.
11800
11801 @item -m4a
11802 @opindex m4a
11803 Generate code for the SH4a.
11804
11805 @item -m4al
11806 @opindex m4al
11807 Same as @option{-m4a-nofpu}, except that it implicitly passes
11808 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11809 instructions at the moment.
11810
11811 @item -mb
11812 @opindex mb
11813 Compile code for the processor in big endian mode.
11814
11815 @item -ml
11816 @opindex ml
11817 Compile code for the processor in little endian mode.
11818
11819 @item -mdalign
11820 @opindex mdalign
11821 Align doubles at 64-bit boundaries.  Note that this changes the calling
11822 conventions, and thus some functions from the standard C library will
11823 not work unless you recompile it first with @option{-mdalign}.
11824
11825 @item -mrelax
11826 @opindex mrelax
11827 Shorten some address references at link time, when possible; uses the
11828 linker option @option{-relax}.
11829
11830 @item -mbigtable
11831 @opindex mbigtable
11832 Use 32-bit offsets in @code{switch} tables.  The default is to use
11833 16-bit offsets.
11834
11835 @item -mfmovd
11836 @opindex mfmovd
11837 Enable the use of the instruction @code{fmovd}.
11838
11839 @item -mhitachi
11840 @opindex mhitachi
11841 Comply with the calling conventions defined by Renesas.
11842
11843 @item -mrenesas
11844 @opindex mhitachi
11845 Comply with the calling conventions defined by Renesas.
11846
11847 @item -mno-renesas
11848 @opindex mhitachi
11849 Comply with the calling conventions defined for GCC before the Renesas
11850 conventions were available.  This option is the default for all
11851 targets of the SH toolchain except for @samp{sh-symbianelf}.
11852
11853 @item -mnomacsave
11854 @opindex mnomacsave
11855 Mark the @code{MAC} register as call-clobbered, even if
11856 @option{-mhitachi} is given.
11857
11858 @item -mieee
11859 @opindex mieee
11860 Increase IEEE-compliance of floating-point code.
11861 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11862 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11863 comparisons of NANs / infinities incurs extra overhead in every
11864 floating point comparison, therefore the default is set to
11865 @option{-ffinite-math-only}.
11866
11867 @item -misize
11868 @opindex misize
11869 Dump instruction size and location in the assembly code.
11870
11871 @item -mpadstruct
11872 @opindex mpadstruct
11873 This option is deprecated.  It pads structures to multiple of 4 bytes,
11874 which is incompatible with the SH ABI@.
11875
11876 @item -mspace
11877 @opindex mspace
11878 Optimize for space instead of speed.  Implied by @option{-Os}.
11879
11880 @item -mprefergot
11881 @opindex mprefergot
11882 When generating position-independent code, emit function calls using
11883 the Global Offset Table instead of the Procedure Linkage Table.
11884
11885 @item -musermode
11886 @opindex musermode
11887 Generate a library function call to invalidate instruction cache
11888 entries, after fixing up a trampoline.  This library function call
11889 doesn't assume it can write to the whole memory address space.  This
11890 is the default when the target is @code{sh-*-linux*}.
11891
11892 @item -multcost=@var{number}
11893 @opindex multcost=@var{number}
11894 Set the cost to assume for a multiply insn.
11895
11896 @item -mdiv=@var{strategy}
11897 @opindex mdiv=@var{strategy}
11898 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11899 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11900 inv:call2, inv:fp .
11901 "fp" performs the operation in floating point.  This has a very high latency,
11902 but needs only a few instructions, so it might be a good choice if
11903 your code has enough easily exploitable ILP to allow the compiler to
11904 schedule the floating point instructions together with other instructions.
11905 Division by zero causes a floating point exception.
11906 "inv" uses integer operations to calculate the inverse of the divisor,
11907 and then multiplies the dividend with the inverse.  This strategy allows
11908 cse and hoisting of the inverse calculation.  Division by zero calculates
11909 an unspecified result, but does not trap.
11910 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11911 have been found, or if the entire operation has been hoisted to the same
11912 place, the last stages of the inverse calculation are intertwined with the
11913 final multiply to reduce the overall latency, at the expense of using a few
11914 more instructions, and thus offering fewer scheduling opportunities with
11915 other code.
11916 "call" calls a library function that usually implements the inv:minlat
11917 strategy.
11918 This gives high code density for m5-*media-nofpu compilations.
11919 "call2" uses a different entry point of the same library function, where it
11920 assumes that a pointer to a lookup table has already been set up, which
11921 exposes the pointer load to cse / code hoisting optimizations.
11922 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11923 code generation, but if the code stays unoptimized, revert to the "call",
11924 "call2", or "fp" strategies, respectively.  Note that the
11925 potentially-trapping side effect of division by zero is carried by a
11926 separate instruction, so it is possible that all the integer instructions
11927 are hoisted out, but the marker for the side effect stays where it is.
11928 A recombination to fp operations or a call is not possible in that case.
11929 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11930 that the inverse calculation was nor separated from the multiply, they speed
11931 up division where the dividend fits into 20 bits (plus sign where applicable),
11932 by inserting a test to skip a number of operations in this case; this test
11933 slows down the case of larger dividends.  inv20u assumes the case of a such
11934 a small dividend to be unlikely, and inv20l assumes it to be likely.
11935
11936 @item -mdivsi3_libfunc=@var{name}
11937 @opindex mdivsi3_libfunc=@var{name}
11938 Set the name of the library function used for 32 bit signed division to
11939 @var{name}.  This only affect the name used in the call and inv:call
11940 division strategies, and the compiler will still expect the same
11941 sets of input/output/clobbered registers as if this option was not present.
11942
11943 @item -madjust-unroll
11944 @opindex madjust-unroll
11945 Throttle unrolling to avoid thrashing target registers.
11946 This option only has an effect if the gcc code base supports the
11947 TARGET_ADJUST_UNROLL_MAX target hook.
11948
11949 @item -mindexed-addressing
11950 @opindex mindexed-addressing
11951 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11952 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11953 semantics for the indexed addressing mode.  The architecture allows the
11954 implementation of processors with 64 bit MMU, which the OS could use to
11955 get 32 bit addressing, but since no current hardware implementation supports
11956 this or any other way to make the indexed addressing mode safe to use in
11957 the 32 bit ABI, the default is -mno-indexed-addressing.
11958
11959 @item -mgettrcost=@var{number}
11960 @opindex mgettrcost=@var{number}
11961 Set the cost assumed for the gettr instruction to @var{number}.
11962 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11963
11964 @item -mpt-fixed
11965 @opindex mpt-fixed
11966 Assume pt* instructions won't trap.  This will generally generate better
11967 scheduled code, but is unsafe on current hardware.  The current architecture
11968 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11969 This has the unintentional effect of making it unsafe to schedule ptabs /
11970 ptrel before a branch, or hoist it out of a loop.  For example,
11971 __do_global_ctors, a part of libgcc that runs constructors at program
11972 startup, calls functions in a list which is delimited by -1.  With the
11973 -mpt-fixed option, the ptabs will be done before testing against -1.
11974 That means that all the constructors will be run a bit quicker, but when
11975 the loop comes to the end of the list, the program crashes because ptabs
11976 loads -1 into a target register.  Since this option is unsafe for any
11977 hardware implementing the current architecture specification, the default
11978 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11979 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11980 this deters register allocation using target registers for storing
11981 ordinary integers.
11982
11983 @item -minvalid-symbols
11984 @opindex minvalid-symbols
11985 Assume symbols might be invalid.  Ordinary function symbols generated by
11986 the compiler will always be valid to load with movi/shori/ptabs or
11987 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11988 to generate symbols that will cause ptabs / ptrel to trap.
11989 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11990 It will then prevent cross-basic-block cse, hoisting and most scheduling
11991 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11992 @end table
11993
11994 @node SPARC Options
11995 @subsection SPARC Options
11996 @cindex SPARC options
11997
11998 These @samp{-m} options are supported on the SPARC:
11999
12000 @table @gcctabopt
12001 @item -mno-app-regs
12002 @itemx -mapp-regs
12003 @opindex mno-app-regs
12004 @opindex mapp-regs
12005 Specify @option{-mapp-regs} to generate output using the global registers
12006 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12007 is the default.
12008
12009 To be fully SVR4 ABI compliant at the cost of some performance loss,
12010 specify @option{-mno-app-regs}.  You should compile libraries and system
12011 software with this option.
12012
12013 @item -mfpu
12014 @itemx -mhard-float
12015 @opindex mfpu
12016 @opindex mhard-float
12017 Generate output containing floating point instructions.  This is the
12018 default.
12019
12020 @item -mno-fpu
12021 @itemx -msoft-float
12022 @opindex mno-fpu
12023 @opindex msoft-float
12024 Generate output containing library calls for floating point.
12025 @strong{Warning:} the requisite libraries are not available for all SPARC
12026 targets.  Normally the facilities of the machine's usual C compiler are
12027 used, but this cannot be done directly in cross-compilation.  You must make
12028 your own arrangements to provide suitable library functions for
12029 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12030 @samp{sparclite-*-*} do provide software floating point support.
12031
12032 @option{-msoft-float} changes the calling convention in the output file;
12033 therefore, it is only useful if you compile @emph{all} of a program with
12034 this option.  In particular, you need to compile @file{libgcc.a}, the
12035 library that comes with GCC, with @option{-msoft-float} in order for
12036 this to work.
12037
12038 @item -mhard-quad-float
12039 @opindex mhard-quad-float
12040 Generate output containing quad-word (long double) floating point
12041 instructions.
12042
12043 @item -msoft-quad-float
12044 @opindex msoft-quad-float
12045 Generate output containing library calls for quad-word (long double)
12046 floating point instructions.  The functions called are those specified
12047 in the SPARC ABI@.  This is the default.
12048
12049 As of this writing, there are no SPARC implementations that have hardware
12050 support for the quad-word floating point instructions.  They all invoke
12051 a trap handler for one of these instructions, and then the trap handler
12052 emulates the effect of the instruction.  Because of the trap handler overhead,
12053 this is much slower than calling the ABI library routines.  Thus the
12054 @option{-msoft-quad-float} option is the default.
12055
12056 @item -mno-unaligned-doubles
12057 @itemx -munaligned-doubles
12058 @opindex mno-unaligned-doubles
12059 @opindex munaligned-doubles
12060 Assume that doubles have 8 byte alignment.  This is the default.
12061
12062 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12063 alignment only if they are contained in another type, or if they have an
12064 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12065 Specifying this option avoids some rare compatibility problems with code
12066 generated by other compilers.  It is not the default because it results
12067 in a performance loss, especially for floating point code.
12068
12069 @item -mno-faster-structs
12070 @itemx -mfaster-structs
12071 @opindex mno-faster-structs
12072 @opindex mfaster-structs
12073 With @option{-mfaster-structs}, the compiler assumes that structures
12074 should have 8 byte alignment.  This enables the use of pairs of
12075 @code{ldd} and @code{std} instructions for copies in structure
12076 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12077 However, the use of this changed alignment directly violates the SPARC
12078 ABI@.  Thus, it's intended only for use on targets where the developer
12079 acknowledges that their resulting code will not be directly in line with
12080 the rules of the ABI@.
12081
12082 @item -mimpure-text
12083 @opindex mimpure-text
12084 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12085 the compiler to not pass @option{-z text} to the linker when linking a
12086 shared object.  Using this option, you can link position-dependent
12087 code into a shared object.
12088
12089 @option{-mimpure-text} suppresses the ``relocations remain against
12090 allocatable but non-writable sections'' linker error message.
12091 However, the necessary relocations will trigger copy-on-write, and the
12092 shared object is not actually shared across processes.  Instead of
12093 using @option{-mimpure-text}, you should compile all source code with
12094 @option{-fpic} or @option{-fPIC}.
12095
12096 This option is only available on SunOS and Solaris.
12097
12098 @item -mcpu=@var{cpu_type}
12099 @opindex mcpu
12100 Set the instruction set, register set, and instruction scheduling parameters
12101 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12102 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12103 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12104 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12105 @samp{ultrasparc3}.
12106
12107 Default instruction scheduling parameters are used for values that select
12108 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12109 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12110
12111 Here is a list of each supported architecture and their supported
12112 implementations.
12113
12114 @smallexample
12115     v7:             cypress
12116     v8:             supersparc, hypersparc
12117     sparclite:      f930, f934, sparclite86x
12118     sparclet:       tsc701
12119     v9:             ultrasparc, ultrasparc3
12120 @end smallexample
12121
12122 By default (unless configured otherwise), GCC generates code for the V7
12123 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12124 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12125 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12126 SPARCStation 1, 2, IPX etc.
12127
12128 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12129 architecture.  The only difference from V7 code is that the compiler emits
12130 the integer multiply and integer divide instructions which exist in SPARC-V8
12131 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12132 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12133 2000 series.
12134
12135 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12136 the SPARC architecture.  This adds the integer multiply, integer divide step
12137 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12138 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12139 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12140 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12141 MB86934 chip, which is the more recent SPARClite with FPU@.
12142
12143 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12144 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12145 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12146 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12147 optimizes it for the TEMIC SPARClet chip.
12148
12149 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12150 architecture.  This adds 64-bit integer and floating-point move instructions,
12151 3 additional floating-point condition code registers and conditional move
12152 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12153 optimizes it for the Sun UltraSPARC I/II chips.  With
12154 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12155 Sun UltraSPARC III chip.
12156
12157 @item -mtune=@var{cpu_type}
12158 @opindex mtune
12159 Set the instruction scheduling parameters for machine type
12160 @var{cpu_type}, but do not set the instruction set or register set that the
12161 option @option{-mcpu=@var{cpu_type}} would.
12162
12163 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12164 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12165 that select a particular cpu implementation.  Those are @samp{cypress},
12166 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12167 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12168 @samp{ultrasparc3}.
12169
12170 @item -mv8plus
12171 @itemx -mno-v8plus
12172 @opindex mv8plus
12173 @opindex mno-v8plus
12174 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12175 difference from the V8 ABI is that the global and out registers are
12176 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12177 mode for all SPARC-V9 processors.
12178
12179 @item -mvis
12180 @itemx -mno-vis
12181 @opindex mvis
12182 @opindex mno-vis
12183 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12184 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12185 @end table
12186
12187 These @samp{-m} options are supported in addition to the above
12188 on SPARC-V9 processors in 64-bit environments:
12189
12190 @table @gcctabopt
12191 @item -mlittle-endian
12192 @opindex mlittle-endian
12193 Generate code for a processor running in little-endian mode.  It is only
12194 available for a few configurations and most notably not on Solaris and Linux.
12195
12196 @item -m32
12197 @itemx -m64
12198 @opindex m32
12199 @opindex m64
12200 Generate code for a 32-bit or 64-bit environment.
12201 The 32-bit environment sets int, long and pointer to 32 bits.
12202 The 64-bit environment sets int to 32 bits and long and pointer
12203 to 64 bits.
12204
12205 @item -mcmodel=medlow
12206 @opindex mcmodel=medlow
12207 Generate code for the Medium/Low code model: 64-bit addresses, programs
12208 must be linked in the low 32 bits of memory.  Programs can be statically
12209 or dynamically linked.
12210
12211 @item -mcmodel=medmid
12212 @opindex mcmodel=medmid
12213 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12214 must be linked in the low 44 bits of memory, the text and data segments must
12215 be less than 2GB in size and the data segment must be located within 2GB of
12216 the text segment.
12217
12218 @item -mcmodel=medany
12219 @opindex mcmodel=medany
12220 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12221 may be linked anywhere in memory, the text and data segments must be less
12222 than 2GB in size and the data segment must be located within 2GB of the
12223 text segment.
12224
12225 @item -mcmodel=embmedany
12226 @opindex mcmodel=embmedany
12227 Generate code for the Medium/Anywhere code model for embedded systems:
12228 64-bit addresses, the text and data segments must be less than 2GB in
12229 size, both starting anywhere in memory (determined at link time).  The
12230 global register %g4 points to the base of the data segment.  Programs
12231 are statically linked and PIC is not supported.
12232
12233 @item -mstack-bias
12234 @itemx -mno-stack-bias
12235 @opindex mstack-bias
12236 @opindex mno-stack-bias
12237 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12238 frame pointer if present, are offset by @minus{}2047 which must be added back
12239 when making stack frame references.  This is the default in 64-bit mode.
12240 Otherwise, assume no such offset is present.
12241 @end table
12242
12243 These switches are supported in addition to the above on Solaris:
12244
12245 @table @gcctabopt
12246 @item -threads
12247 @opindex threads
12248 Add support for multithreading using the Solaris threads library.  This
12249 option sets flags for both the preprocessor and linker.  This option does
12250 not affect the thread safety of object code produced by the compiler or
12251 that of libraries supplied with it.
12252
12253 @item -pthreads
12254 @opindex pthreads
12255 Add support for multithreading using the POSIX threads library.  This
12256 option sets flags for both the preprocessor and linker.  This option does
12257 not affect the thread safety of object code produced  by the compiler or
12258 that of libraries supplied with it.
12259 @end table
12260
12261 @node System V Options
12262 @subsection Options for System V
12263
12264 These additional options are available on System V Release 4 for
12265 compatibility with other compilers on those systems:
12266
12267 @table @gcctabopt
12268 @item -G
12269 @opindex G
12270 Create a shared object.
12271 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12272
12273 @item -Qy
12274 @opindex Qy
12275 Identify the versions of each tool used by the compiler, in a
12276 @code{.ident} assembler directive in the output.
12277
12278 @item -Qn
12279 @opindex Qn
12280 Refrain from adding @code{.ident} directives to the output file (this is
12281 the default).
12282
12283 @item -YP,@var{dirs}
12284 @opindex YP
12285 Search the directories @var{dirs}, and no others, for libraries
12286 specified with @option{-l}.
12287
12288 @item -Ym,@var{dir}
12289 @opindex Ym
12290 Look in the directory @var{dir} to find the M4 preprocessor.
12291 The assembler uses this option.
12292 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12293 @c the generic assembler that comes with Solaris takes just -Ym.
12294 @end table
12295
12296 @node TMS320C3x/C4x Options
12297 @subsection TMS320C3x/C4x Options
12298 @cindex TMS320C3x/C4x Options
12299
12300 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12301
12302 @table @gcctabopt
12303
12304 @item -mcpu=@var{cpu_type}
12305 @opindex mcpu
12306 Set the instruction set, register set, and instruction scheduling
12307 parameters for machine type @var{cpu_type}.  Supported values for
12308 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12309 @samp{c44}.  The default is @samp{c40} to generate code for the
12310 TMS320C40.
12311
12312 @item -mbig-memory
12313 @itemx -mbig
12314 @itemx -msmall-memory
12315 @itemx -msmall
12316 @opindex mbig-memory
12317 @opindex mbig
12318 @opindex msmall-memory
12319 @opindex msmall
12320 Generates code for the big or small memory model.  The small memory
12321 model assumed that all data fits into one 64K word page.  At run-time
12322 the data page (DP) register must be set to point to the 64K page
12323 containing the .bss and .data program sections.  The big memory model is
12324 the default and requires reloading of the DP register for every direct
12325 memory access.
12326
12327 @item -mbk
12328 @itemx -mno-bk
12329 @opindex mbk
12330 @opindex mno-bk
12331 Allow (disallow) allocation of general integer operands into the block
12332 count register BK@.
12333
12334 @item -mdb
12335 @itemx -mno-db
12336 @opindex mdb
12337 @opindex mno-db
12338 Enable (disable) generation of code using decrement and branch,
12339 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12340 on the safe side, this is disabled for the C3x, since the maximum
12341 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12342 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12343 that it can utilize the decrement and branch instruction, but will give
12344 up if there is more than one memory reference in the loop.  Thus a loop
12345 where the loop counter is decremented can generate slightly more
12346 efficient code, in cases where the RPTB instruction cannot be utilized.
12347
12348 @item -mdp-isr-reload
12349 @itemx -mparanoid
12350 @opindex mdp-isr-reload
12351 @opindex mparanoid
12352 Force the DP register to be saved on entry to an interrupt service
12353 routine (ISR), reloaded to point to the data section, and restored on
12354 exit from the ISR@.  This should not be required unless someone has
12355 violated the small memory model by modifying the DP register, say within
12356 an object library.
12357
12358 @item -mmpyi
12359 @itemx -mno-mpyi
12360 @opindex mmpyi
12361 @opindex mno-mpyi
12362 For the C3x use the 24-bit MPYI instruction for integer multiplies
12363 instead of a library call to guarantee 32-bit results.  Note that if one
12364 of the operands is a constant, then the multiplication will be performed
12365 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12366 then squaring operations are performed inline instead of a library call.
12367
12368 @item -mfast-fix
12369 @itemx -mno-fast-fix
12370 @opindex mfast-fix
12371 @opindex mno-fast-fix
12372 The C3x/C4x FIX instruction to convert a floating point value to an
12373 integer value chooses the nearest integer less than or equal to the
12374 floating point value rather than to the nearest integer.  Thus if the
12375 floating point number is negative, the result will be incorrectly
12376 truncated an additional code is necessary to detect and correct this
12377 case.  This option can be used to disable generation of the additional
12378 code required to correct the result.
12379
12380 @item -mrptb
12381 @itemx -mno-rptb
12382 @opindex mrptb
12383 @opindex mno-rptb
12384 Enable (disable) generation of repeat block sequences using the RPTB
12385 instruction for zero overhead looping.  The RPTB construct is only used
12386 for innermost loops that do not call functions or jump across the loop
12387 boundaries.  There is no advantage having nested RPTB loops due to the
12388 overhead required to save and restore the RC, RS, and RE registers.
12389 This is enabled by default with @option{-O2}.
12390
12391 @item -mrpts=@var{count}
12392 @itemx -mno-rpts
12393 @opindex mrpts
12394 @opindex mno-rpts
12395 Enable (disable) the use of the single instruction repeat instruction
12396 RPTS@.  If a repeat block contains a single instruction, and the loop
12397 count can be guaranteed to be less than the value @var{count}, GCC will
12398 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12399 then a RPTS will be emitted even if the loop count cannot be determined
12400 at compile time.  Note that the repeated instruction following RPTS does
12401 not have to be reloaded from memory each iteration, thus freeing up the
12402 CPU buses for operands.  However, since interrupts are blocked by this
12403 instruction, it is disabled by default.
12404
12405 @item -mloop-unsigned
12406 @itemx -mno-loop-unsigned
12407 @opindex mloop-unsigned
12408 @opindex mno-loop-unsigned
12409 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12410 is @math{2^{31} + 1} since these instructions test if the iteration count is
12411 negative to terminate the loop.  If the iteration count is unsigned
12412 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12413 exceeded.  This switch allows an unsigned iteration count.
12414
12415 @item -mti
12416 @opindex mti
12417 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12418 with.  This also enforces compatibility with the API employed by the TI
12419 C3x C compiler.  For example, long doubles are passed as structures
12420 rather than in floating point registers.
12421
12422 @item -mregparm
12423 @itemx -mmemparm
12424 @opindex mregparm
12425 @opindex mmemparm
12426 Generate code that uses registers (stack) for passing arguments to functions.
12427 By default, arguments are passed in registers where possible rather
12428 than by pushing arguments on to the stack.
12429
12430 @item -mparallel-insns
12431 @itemx -mno-parallel-insns
12432 @opindex mparallel-insns
12433 @opindex mno-parallel-insns
12434 Allow the generation of parallel instructions.  This is enabled by
12435 default with @option{-O2}.
12436
12437 @item -mparallel-mpy
12438 @itemx -mno-parallel-mpy
12439 @opindex mparallel-mpy
12440 @opindex mno-parallel-mpy
12441 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12442 provided @option{-mparallel-insns} is also specified.  These instructions have
12443 tight register constraints which can pessimize the code generation
12444 of large functions.
12445
12446 @end table
12447
12448 @node V850 Options
12449 @subsection V850 Options
12450 @cindex V850 Options
12451
12452 These @samp{-m} options are defined for V850 implementations:
12453
12454 @table @gcctabopt
12455 @item -mlong-calls
12456 @itemx -mno-long-calls
12457 @opindex mlong-calls
12458 @opindex mno-long-calls
12459 Treat all calls as being far away (near).  If calls are assumed to be
12460 far away, the compiler will always load the functions address up into a
12461 register, and call indirect through the pointer.
12462
12463 @item -mno-ep
12464 @itemx -mep
12465 @opindex mno-ep
12466 @opindex mep
12467 Do not optimize (do optimize) basic blocks that use the same index
12468 pointer 4 or more times to copy pointer into the @code{ep} register, and
12469 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12470 option is on by default if you optimize.
12471
12472 @item -mno-prolog-function
12473 @itemx -mprolog-function
12474 @opindex mno-prolog-function
12475 @opindex mprolog-function
12476 Do not use (do use) external functions to save and restore registers
12477 at the prologue and epilogue of a function.  The external functions
12478 are slower, but use less code space if more than one function saves
12479 the same number of registers.  The @option{-mprolog-function} option
12480 is on by default if you optimize.
12481
12482 @item -mspace
12483 @opindex mspace
12484 Try to make the code as small as possible.  At present, this just turns
12485 on the @option{-mep} and @option{-mprolog-function} options.
12486
12487 @item -mtda=@var{n}
12488 @opindex mtda
12489 Put static or global variables whose size is @var{n} bytes or less into
12490 the tiny data area that register @code{ep} points to.  The tiny data
12491 area can hold up to 256 bytes in total (128 bytes for byte references).
12492
12493 @item -msda=@var{n}
12494 @opindex msda
12495 Put static or global variables whose size is @var{n} bytes or less into
12496 the small data area that register @code{gp} points to.  The small data
12497 area can hold up to 64 kilobytes.
12498
12499 @item -mzda=@var{n}
12500 @opindex mzda
12501 Put static or global variables whose size is @var{n} bytes or less into
12502 the first 32 kilobytes of memory.
12503
12504 @item -mv850
12505 @opindex mv850
12506 Specify that the target processor is the V850.
12507
12508 @item -mbig-switch
12509 @opindex mbig-switch
12510 Generate code suitable for big switch tables.  Use this option only if
12511 the assembler/linker complain about out of range branches within a switch
12512 table.
12513
12514 @item -mapp-regs
12515 @opindex mapp-regs
12516 This option will cause r2 and r5 to be used in the code generated by
12517 the compiler.  This setting is the default.
12518
12519 @item -mno-app-regs
12520 @opindex mno-app-regs
12521 This option will cause r2 and r5 to be treated as fixed registers.
12522
12523 @item -mv850e1
12524 @opindex mv850e1
12525 Specify that the target processor is the V850E1.  The preprocessor
12526 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12527 this option is used.
12528
12529 @item -mv850e
12530 @opindex mv850e
12531 Specify that the target processor is the V850E@.  The preprocessor
12532 constant @samp{__v850e__} will be defined if this option is used.
12533
12534 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12535 are defined then a default target processor will be chosen and the
12536 relevant @samp{__v850*__} preprocessor constant will be defined.
12537
12538 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12539 defined, regardless of which processor variant is the target.
12540
12541 @item -mdisable-callt
12542 @opindex mdisable-callt
12543 This option will suppress generation of the CALLT instruction for the
12544 v850e and v850e1 flavors of the v850 architecture.  The default is
12545 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12546
12547 @end table
12548
12549 @node VAX Options
12550 @subsection VAX Options
12551 @cindex VAX options
12552
12553 These @samp{-m} options are defined for the VAX:
12554
12555 @table @gcctabopt
12556 @item -munix
12557 @opindex munix
12558 Do not output certain jump instructions (@code{aobleq} and so on)
12559 that the Unix assembler for the VAX cannot handle across long
12560 ranges.
12561
12562 @item -mgnu
12563 @opindex mgnu
12564 Do output those jump instructions, on the assumption that you
12565 will assemble with the GNU assembler.
12566
12567 @item -mg
12568 @opindex mg
12569 Output code for g-format floating point numbers instead of d-format.
12570 @end table
12571
12572 @node x86-64 Options
12573 @subsection x86-64 Options
12574 @cindex x86-64 options
12575
12576 These are listed under @xref{i386 and x86-64 Options}.
12577
12578 @node Xstormy16 Options
12579 @subsection Xstormy16 Options
12580 @cindex Xstormy16 Options
12581
12582 These options are defined for Xstormy16:
12583
12584 @table @gcctabopt
12585 @item -msim
12586 @opindex msim
12587 Choose startup files and linker script suitable for the simulator.
12588 @end table
12589
12590 @node Xtensa Options
12591 @subsection Xtensa Options
12592 @cindex Xtensa Options
12593
12594 These options are supported for Xtensa targets:
12595
12596 @table @gcctabopt
12597 @item -mconst16
12598 @itemx -mno-const16
12599 @opindex mconst16
12600 @opindex mno-const16
12601 Enable or disable use of @code{CONST16} instructions for loading
12602 constant values.  The @code{CONST16} instruction is currently not a
12603 standard option from Tensilica.  When enabled, @code{CONST16}
12604 instructions are always used in place of the standard @code{L32R}
12605 instructions.  The use of @code{CONST16} is enabled by default only if
12606 the @code{L32R} instruction is not available.
12607
12608 @item -mfused-madd
12609 @itemx -mno-fused-madd
12610 @opindex mfused-madd
12611 @opindex mno-fused-madd
12612 Enable or disable use of fused multiply/add and multiply/subtract
12613 instructions in the floating-point option.  This has no effect if the
12614 floating-point option is not also enabled.  Disabling fused multiply/add
12615 and multiply/subtract instructions forces the compiler to use separate
12616 instructions for the multiply and add/subtract operations.  This may be
12617 desirable in some cases where strict IEEE 754-compliant results are
12618 required: the fused multiply add/subtract instructions do not round the
12619 intermediate result, thereby producing results with @emph{more} bits of
12620 precision than specified by the IEEE standard.  Disabling fused multiply
12621 add/subtract instructions also ensures that the program output is not
12622 sensitive to the compiler's ability to combine multiply and add/subtract
12623 operations.
12624
12625 @item -mtext-section-literals
12626 @itemx -mno-text-section-literals
12627 @opindex mtext-section-literals
12628 @opindex mno-text-section-literals
12629 Control the treatment of literal pools.  The default is
12630 @option{-mno-text-section-literals}, which places literals in a separate
12631 section in the output file.  This allows the literal pool to be placed
12632 in a data RAM/ROM, and it also allows the linker to combine literal
12633 pools from separate object files to remove redundant literals and
12634 improve code size.  With @option{-mtext-section-literals}, the literals
12635 are interspersed in the text section in order to keep them as close as
12636 possible to their references.  This may be necessary for large assembly
12637 files.
12638
12639 @item -mtarget-align
12640 @itemx -mno-target-align
12641 @opindex mtarget-align
12642 @opindex mno-target-align
12643 When this option is enabled, GCC instructs the assembler to
12644 automatically align instructions to reduce branch penalties at the
12645 expense of some code density.  The assembler attempts to widen density
12646 instructions to align branch targets and the instructions following call
12647 instructions.  If there are not enough preceding safe density
12648 instructions to align a target, no widening will be performed.  The
12649 default is @option{-mtarget-align}.  These options do not affect the
12650 treatment of auto-aligned instructions like @code{LOOP}, which the
12651 assembler will always align, either by widening density instructions or
12652 by inserting no-op instructions.
12653
12654 @item -mlongcalls
12655 @itemx -mno-longcalls
12656 @opindex mlongcalls
12657 @opindex mno-longcalls
12658 When this option is enabled, GCC instructs the assembler to translate
12659 direct calls to indirect calls unless it can determine that the target
12660 of a direct call is in the range allowed by the call instruction.  This
12661 translation typically occurs for calls to functions in other source
12662 files.  Specifically, the assembler translates a direct @code{CALL}
12663 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12664 The default is @option{-mno-longcalls}.  This option should be used in
12665 programs where the call target can potentially be out of range.  This
12666 option is implemented in the assembler, not the compiler, so the
12667 assembly code generated by GCC will still show direct call
12668 instructions---look at the disassembled object code to see the actual
12669 instructions.  Note that the assembler will use an indirect call for
12670 every cross-file call, not just those that really will be out of range.
12671 @end table
12672
12673 @node zSeries Options
12674 @subsection zSeries Options
12675 @cindex zSeries options
12676
12677 These are listed under @xref{S/390 and zSeries Options}.
12678
12679 @node Code Gen Options
12680 @section Options for Code Generation Conventions
12681 @cindex code generation conventions
12682 @cindex options, code generation
12683 @cindex run-time options
12684
12685 These machine-independent options control the interface conventions
12686 used in code generation.
12687
12688 Most of them have both positive and negative forms; the negative form
12689 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12690 one of the forms is listed---the one which is not the default.  You
12691 can figure out the other form by either removing @samp{no-} or adding
12692 it.
12693
12694 @table @gcctabopt
12695 @item -fbounds-check
12696 @opindex fbounds-check
12697 For front-ends that support it, generate additional code to check that
12698 indices used to access arrays are within the declared range.  This is
12699 currently only supported by the Java and Fortran 77 front-ends, where
12700 this option defaults to true and false respectively.
12701
12702 @item -ftrapv
12703 @opindex ftrapv
12704 This option generates traps for signed overflow on addition, subtraction,
12705 multiplication operations.
12706
12707 @item -fwrapv
12708 @opindex fwrapv
12709 This option instructs the compiler to assume that signed arithmetic
12710 overflow of addition, subtraction and multiplication wraps around
12711 using twos-complement representation.  This flag enables some optimizations
12712 and disables others.  This option is enabled by default for the Java
12713 front-end, as required by the Java language specification.
12714
12715 @item -fexceptions
12716 @opindex fexceptions
12717 Enable exception handling.  Generates extra code needed to propagate
12718 exceptions.  For some targets, this implies GCC will generate frame
12719 unwind information for all functions, which can produce significant data
12720 size overhead, although it does not affect execution.  If you do not
12721 specify this option, GCC will enable it by default for languages like
12722 C++ which normally require exception handling, and disable it for
12723 languages like C that do not normally require it.  However, you may need
12724 to enable this option when compiling C code that needs to interoperate
12725 properly with exception handlers written in C++.  You may also wish to
12726 disable this option if you are compiling older C++ programs that don't
12727 use exception handling.
12728
12729 @item -fnon-call-exceptions
12730 @opindex fnon-call-exceptions
12731 Generate code that allows trapping instructions to throw exceptions.
12732 Note that this requires platform-specific runtime support that does
12733 not exist everywhere.  Moreover, it only allows @emph{trapping}
12734 instructions to throw exceptions, i.e.@: memory references or floating
12735 point instructions.  It does not allow exceptions to be thrown from
12736 arbitrary signal handlers such as @code{SIGALRM}.
12737
12738 @item -funwind-tables
12739 @opindex funwind-tables
12740 Similar to @option{-fexceptions}, except that it will just generate any needed
12741 static data, but will not affect the generated code in any other way.
12742 You will normally not enable this option; instead, a language processor
12743 that needs this handling would enable it on your behalf.
12744
12745 @item -fasynchronous-unwind-tables
12746 @opindex fasynchronous-unwind-tables
12747 Generate unwind table in dwarf2 format, if supported by target machine.  The
12748 table is exact at each instruction boundary, so it can be used for stack
12749 unwinding from asynchronous events (such as debugger or garbage collector).
12750
12751 @item -fpcc-struct-return
12752 @opindex fpcc-struct-return
12753 Return ``short'' @code{struct} and @code{union} values in memory like
12754 longer ones, rather than in registers.  This convention is less
12755 efficient, but it has the advantage of allowing intercallability between
12756 GCC-compiled files and files compiled with other compilers, particularly
12757 the Portable C Compiler (pcc).
12758
12759 The precise convention for returning structures in memory depends
12760 on the target configuration macros.
12761
12762 Short structures and unions are those whose size and alignment match
12763 that of some integer type.
12764
12765 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12766 switch is not binary compatible with code compiled with the
12767 @option{-freg-struct-return} switch.
12768 Use it to conform to a non-default application binary interface.
12769
12770 @item -freg-struct-return
12771 @opindex freg-struct-return
12772 Return @code{struct} and @code{union} values in registers when possible.
12773 This is more efficient for small structures than
12774 @option{-fpcc-struct-return}.
12775
12776 If you specify neither @option{-fpcc-struct-return} nor
12777 @option{-freg-struct-return}, GCC defaults to whichever convention is
12778 standard for the target.  If there is no standard convention, GCC
12779 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12780 the principal compiler.  In those cases, we can choose the standard, and
12781 we chose the more efficient register return alternative.
12782
12783 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12784 switch is not binary compatible with code compiled with the
12785 @option{-fpcc-struct-return} switch.
12786 Use it to conform to a non-default application binary interface.
12787
12788 @item -fshort-enums
12789 @opindex fshort-enums
12790 Allocate to an @code{enum} type only as many bytes as it needs for the
12791 declared range of possible values.  Specifically, the @code{enum} type
12792 will be equivalent to the smallest integer type which has enough room.
12793
12794 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12795 code that is not binary compatible with code generated without that switch.
12796 Use it to conform to a non-default application binary interface.
12797
12798 @item -fshort-double
12799 @opindex fshort-double
12800 Use the same size for @code{double} as for @code{float}.
12801
12802 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12803 code that is not binary compatible with code generated without that switch.
12804 Use it to conform to a non-default application binary interface.
12805
12806 @item -fshort-wchar
12807 @opindex fshort-wchar
12808 Override the underlying type for @samp{wchar_t} to be @samp{short
12809 unsigned int} instead of the default for the target.  This option is
12810 useful for building programs to run under WINE@.
12811
12812 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12813 code that is not binary compatible with code generated without that switch.
12814 Use it to conform to a non-default application binary interface.
12815
12816 @item -fshared-data
12817 @opindex fshared-data
12818 Requests that the data and non-@code{const} variables of this
12819 compilation be shared data rather than private data.  The distinction
12820 makes sense only on certain operating systems, where shared data is
12821 shared between processes running the same program, while private data
12822 exists in one copy per process.
12823
12824 @item -fno-common
12825 @opindex fno-common
12826 In C, allocate even uninitialized global variables in the data section of the
12827 object file, rather than generating them as common blocks.  This has the
12828 effect that if the same variable is declared (without @code{extern}) in
12829 two different compilations, you will get an error when you link them.
12830 The only reason this might be useful is if you wish to verify that the
12831 program will work on other systems which always work this way.
12832
12833 @item -fno-ident
12834 @opindex fno-ident
12835 Ignore the @samp{#ident} directive.
12836
12837 @item -finhibit-size-directive
12838 @opindex finhibit-size-directive
12839 Don't output a @code{.size} assembler directive, or anything else that
12840 would cause trouble if the function is split in the middle, and the
12841 two halves are placed at locations far apart in memory.  This option is
12842 used when compiling @file{crtstuff.c}; you should not need to use it
12843 for anything else.
12844
12845 @item -fverbose-asm
12846 @opindex fverbose-asm
12847 Put extra commentary information in the generated assembly code to
12848 make it more readable.  This option is generally only of use to those
12849 who actually need to read the generated assembly code (perhaps while
12850 debugging the compiler itself).
12851
12852 @option{-fno-verbose-asm}, the default, causes the
12853 extra information to be omitted and is useful when comparing two assembler
12854 files.
12855
12856 @item -fpic
12857 @opindex fpic
12858 @cindex global offset table
12859 @cindex PIC
12860 Generate position-independent code (PIC) suitable for use in a shared
12861 library, if supported for the target machine.  Such code accesses all
12862 constant addresses through a global offset table (GOT)@.  The dynamic
12863 loader resolves the GOT entries when the program starts (the dynamic
12864 loader is not part of GCC; it is part of the operating system).  If
12865 the GOT size for the linked executable exceeds a machine-specific
12866 maximum size, you get an error message from the linker indicating that
12867 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12868 instead.  (These maximums are 8k on the SPARC and 32k
12869 on the m68k and RS/6000.  The 386 has no such limit.)
12870
12871 Position-independent code requires special support, and therefore works
12872 only on certain machines.  For the 386, GCC supports PIC for System V
12873 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12874 position-independent.
12875
12876 @item -fPIC
12877 @opindex fPIC
12878 If supported for the target machine, emit position-independent code,
12879 suitable for dynamic linking and avoiding any limit on the size of the
12880 global offset table.  This option makes a difference on the m68k,
12881 PowerPC and SPARC@.
12882
12883 Position-independent code requires special support, and therefore works
12884 only on certain machines.
12885
12886 @item -fpie
12887 @itemx -fPIE
12888 @opindex fpie
12889 @opindex fPIE
12890 These options are similar to @option{-fpic} and @option{-fPIC}, but
12891 generated position independent code can be only linked into executables.
12892 Usually these options are used when @option{-pie} GCC option will be
12893 used during linking.
12894
12895 @item -fno-jump-tables
12896 @opindex fno-jump-tables
12897 Do not use jump tables for switch statements even where it would be
12898 more efficient than other code generation strategies.  This option is
12899 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12900 building code which forms part of a dynamic linker and cannot
12901 reference the address of a jump table.  On some targets, jump tables
12902 do not require a GOT and this option is not needed.
12903
12904 @item -ffixed-@var{reg}
12905 @opindex ffixed
12906 Treat the register named @var{reg} as a fixed register; generated code
12907 should never refer to it (except perhaps as a stack pointer, frame
12908 pointer or in some other fixed role).
12909
12910 @var{reg} must be the name of a register.  The register names accepted
12911 are machine-specific and are defined in the @code{REGISTER_NAMES}
12912 macro in the machine description macro file.
12913
12914 This flag does not have a negative form, because it specifies a
12915 three-way choice.
12916
12917 @item -fcall-used-@var{reg}
12918 @opindex fcall-used
12919 Treat the register named @var{reg} as an allocable register that is
12920 clobbered by function calls.  It may be allocated for temporaries or
12921 variables that do not live across a call.  Functions compiled this way
12922 will not save and restore the register @var{reg}.
12923
12924 It is an error to used this flag with the frame pointer or stack pointer.
12925 Use of this flag for other registers that have fixed pervasive roles in
12926 the machine's execution model will produce disastrous results.
12927
12928 This flag does not have a negative form, because it specifies a
12929 three-way choice.
12930
12931 @item -fcall-saved-@var{reg}
12932 @opindex fcall-saved
12933 Treat the register named @var{reg} as an allocable register saved by
12934 functions.  It may be allocated even for temporaries or variables that
12935 live across a call.  Functions compiled this way will save and restore
12936 the register @var{reg} if they use it.
12937
12938 It is an error to used this flag with the frame pointer or stack pointer.
12939 Use of this flag for other registers that have fixed pervasive roles in
12940 the machine's execution model will produce disastrous results.
12941
12942 A different sort of disaster will result from the use of this flag for
12943 a register in which function values may be returned.
12944
12945 This flag does not have a negative form, because it specifies a
12946 three-way choice.
12947
12948 @item -fpack-struct[=@var{n}]
12949 @opindex fpack-struct
12950 Without a value specified, pack all structure members together without
12951 holes.  When a value is specified (which must be a small power of two), pack
12952 structure members according to this value, representing the maximum
12953 alignment (that is, objects with default alignment requirements larger than
12954 this will be output potentially unaligned at the next fitting location.
12955
12956 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12957 code that is not binary compatible with code generated without that switch.
12958 Additionally, it makes the code suboptimal.
12959 Use it to conform to a non-default application binary interface.
12960
12961 @item -finstrument-functions
12962 @opindex finstrument-functions
12963 Generate instrumentation calls for entry and exit to functions.  Just
12964 after function entry and just before function exit, the following
12965 profiling functions will be called with the address of the current
12966 function and its call site.  (On some platforms,
12967 @code{__builtin_return_address} does not work beyond the current
12968 function, so the call site information may not be available to the
12969 profiling functions otherwise.)
12970
12971 @smallexample
12972 void __cyg_profile_func_enter (void *this_fn,
12973                                void *call_site);
12974 void __cyg_profile_func_exit  (void *this_fn,
12975                                void *call_site);
12976 @end smallexample
12977
12978 The first argument is the address of the start of the current function,
12979 which may be looked up exactly in the symbol table.
12980
12981 This instrumentation is also done for functions expanded inline in other
12982 functions.  The profiling calls will indicate where, conceptually, the
12983 inline function is entered and exited.  This means that addressable
12984 versions of such functions must be available.  If all your uses of a
12985 function are expanded inline, this may mean an additional expansion of
12986 code size.  If you use @samp{extern inline} in your C code, an
12987 addressable version of such functions must be provided.  (This is
12988 normally the case anyways, but if you get lucky and the optimizer always
12989 expands the functions inline, you might have gotten away without
12990 providing static copies.)
12991
12992 A function may be given the attribute @code{no_instrument_function}, in
12993 which case this instrumentation will not be done.  This can be used, for
12994 example, for the profiling functions listed above, high-priority
12995 interrupt routines, and any functions from which the profiling functions
12996 cannot safely be called (perhaps signal handlers, if the profiling
12997 routines generate output or allocate memory).
12998
12999 @item -fstack-check
13000 @opindex fstack-check
13001 Generate code to verify that you do not go beyond the boundary of the
13002 stack.  You should specify this flag if you are running in an
13003 environment with multiple threads, but only rarely need to specify it in
13004 a single-threaded environment since stack overflow is automatically
13005 detected on nearly all systems if there is only one stack.
13006
13007 Note that this switch does not actually cause checking to be done; the
13008 operating system must do that.  The switch causes generation of code
13009 to ensure that the operating system sees the stack being extended.
13010
13011 @item -fstack-limit-register=@var{reg}
13012 @itemx -fstack-limit-symbol=@var{sym}
13013 @itemx -fno-stack-limit
13014 @opindex fstack-limit-register
13015 @opindex fstack-limit-symbol
13016 @opindex fno-stack-limit
13017 Generate code to ensure that the stack does not grow beyond a certain value,
13018 either the value of a register or the address of a symbol.  If the stack
13019 would grow beyond the value, a signal is raised.  For most targets,
13020 the signal is raised before the stack overruns the boundary, so
13021 it is possible to catch the signal without taking special precautions.
13022
13023 For instance, if the stack starts at absolute address @samp{0x80000000}
13024 and grows downwards, you can use the flags
13025 @option{-fstack-limit-symbol=__stack_limit} and
13026 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13027 of 128KB@.  Note that this may only work with the GNU linker.
13028
13029 @cindex aliasing of parameters
13030 @cindex parameters, aliased
13031 @item -fargument-alias
13032 @itemx -fargument-noalias
13033 @itemx -fargument-noalias-global
13034 @opindex fargument-alias
13035 @opindex fargument-noalias
13036 @opindex fargument-noalias-global
13037 Specify the possible relationships among parameters and between
13038 parameters and global data.
13039
13040 @option{-fargument-alias} specifies that arguments (parameters) may
13041 alias each other and may alias global storage.@*
13042 @option{-fargument-noalias} specifies that arguments do not alias
13043 each other, but may alias global storage.@*
13044 @option{-fargument-noalias-global} specifies that arguments do not
13045 alias each other and do not alias global storage.
13046
13047 Each language will automatically use whatever option is required by
13048 the language standard.  You should not need to use these options yourself.
13049
13050 @item -fleading-underscore
13051 @opindex fleading-underscore
13052 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13053 change the way C symbols are represented in the object file.  One use
13054 is to help link with legacy assembly code.
13055
13056 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13057 generate code that is not binary compatible with code generated without that
13058 switch.  Use it to conform to a non-default application binary interface.
13059 Not all targets provide complete support for this switch.
13060
13061 @item -ftls-model=@var{model}
13062 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13063 The @var{model} argument should be one of @code{global-dynamic},
13064 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13065
13066 The default without @option{-fpic} is @code{initial-exec}; with
13067 @option{-fpic} the default is @code{global-dynamic}.
13068
13069 @item -fvisibility=@var{default|internal|hidden|protected}
13070 @opindex fvisibility
13071 Set the default ELF image symbol visibility to the specified option---all
13072 symbols will be marked with this unless overridden within the code.
13073 Using this feature can very substantially improve linking and
13074 load times of shared object libraries, produce more optimized
13075 code, provide near-perfect API export and prevent symbol clashes.
13076 It is @strong{strongly} recommended that you use this in any shared objects
13077 you distribute.
13078
13079 Despite the nomenclature, @code{default} always means public ie;
13080 available to be linked against from outside the shared object.
13081 @code{protected} and @code{internal} are pretty useless in real-world
13082 usage so the only other commonly used option will be @code{hidden}.
13083 The default if @option{-fvisibility} isn't specified is
13084 @code{default}, i.e., make every
13085 symbol public---this causes the same behavior as previous versions of
13086 GCC@.
13087
13088 A good explanation of the benefits offered by ensuring ELF
13089 symbols have the correct visibility is given by ``How To Write
13090 Shared Libraries'' by Ulrich Drepper (which can be found at
13091 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13092 solution made possible by this option to marking things hidden when
13093 the default is public is to make the default hidden and mark things
13094 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13095 and @code{__attribute__ ((visibility("default")))} instead of
13096 @code{__declspec(dllexport)} you get almost identical semantics with
13097 identical syntax.  This is a great boon to those working with
13098 cross-platform projects.
13099
13100 For those adding visibility support to existing code, you may find
13101 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13102 the declarations you wish to set visibility for with (for example)
13103 @samp{#pragma GCC visibility push(hidden)} and
13104 @samp{#pragma GCC visibility pop}.
13105 Bear in mind that symbol visibility should be viewed @strong{as
13106 part of the API interface contract} and thus all new code should
13107 always specify visibility when it is not the default ie; declarations
13108 only for use within the local DSO should @strong{always} be marked explicitly
13109 as hidden as so to avoid PLT indirection overheads---making this
13110 abundantly clear also aids readability and self-documentation of the code.
13111 Note that due to ISO C++ specification requirements, operator new and
13112 operator delete must always be of default visibility.
13113
13114 An overview of these techniques, their benefits and how to use them
13115 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13116
13117 @end table
13118
13119 @c man end
13120
13121 @node Environment Variables
13122 @section Environment Variables Affecting GCC
13123 @cindex environment variables
13124
13125 @c man begin ENVIRONMENT
13126 This section describes several environment variables that affect how GCC
13127 operates.  Some of them work by specifying directories or prefixes to use
13128 when searching for various kinds of files.  Some are used to specify other
13129 aspects of the compilation environment.
13130
13131 Note that you can also specify places to search using options such as
13132 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13133 take precedence over places specified using environment variables, which
13134 in turn take precedence over those specified by the configuration of GCC@.
13135 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13136 GNU Compiler Collection (GCC) Internals}.
13137
13138 @table @env
13139 @item LANG
13140 @itemx LC_CTYPE
13141 @c @itemx LC_COLLATE
13142 @itemx LC_MESSAGES
13143 @c @itemx LC_MONETARY
13144 @c @itemx LC_NUMERIC
13145 @c @itemx LC_TIME
13146 @itemx LC_ALL
13147 @findex LANG
13148 @findex LC_CTYPE
13149 @c @findex LC_COLLATE
13150 @findex LC_MESSAGES
13151 @c @findex LC_MONETARY
13152 @c @findex LC_NUMERIC
13153 @c @findex LC_TIME
13154 @findex LC_ALL
13155 @cindex locale
13156 These environment variables control the way that GCC uses
13157 localization information that allow GCC to work with different
13158 national conventions.  GCC inspects the locale categories
13159 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13160 so.  These locale categories can be set to any value supported by your
13161 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13162 Kingdom encoded in UTF-8.
13163
13164 The @env{LC_CTYPE} environment variable specifies character
13165 classification.  GCC uses it to determine the character boundaries in
13166 a string; this is needed for some multibyte encodings that contain quote
13167 and escape characters that would otherwise be interpreted as a string
13168 end or escape.
13169
13170 The @env{LC_MESSAGES} environment variable specifies the language to
13171 use in diagnostic messages.
13172
13173 If the @env{LC_ALL} environment variable is set, it overrides the value
13174 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13175 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13176 environment variable.  If none of these variables are set, GCC
13177 defaults to traditional C English behavior.
13178
13179 @item TMPDIR
13180 @findex TMPDIR
13181 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13182 files.  GCC uses temporary files to hold the output of one stage of
13183 compilation which is to be used as input to the next stage: for example,
13184 the output of the preprocessor, which is the input to the compiler
13185 proper.
13186
13187 @item GCC_EXEC_PREFIX
13188 @findex GCC_EXEC_PREFIX
13189 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13190 names of the subprograms executed by the compiler.  No slash is added
13191 when this prefix is combined with the name of a subprogram, but you can
13192 specify a prefix that ends with a slash if you wish.
13193
13194 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13195 an appropriate prefix to use based on the pathname it was invoked with.
13196
13197 If GCC cannot find the subprogram using the specified prefix, it
13198 tries looking in the usual places for the subprogram.
13199
13200 The default value of @env{GCC_EXEC_PREFIX} is
13201 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13202 of @code{prefix} when you ran the @file{configure} script.
13203
13204 Other prefixes specified with @option{-B} take precedence over this prefix.
13205
13206 This prefix is also used for finding files such as @file{crt0.o} that are
13207 used for linking.
13208
13209 In addition, the prefix is used in an unusual way in finding the
13210 directories to search for header files.  For each of the standard
13211 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13212 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13213 replacing that beginning with the specified prefix to produce an
13214 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13215 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13216 These alternate directories are searched first; the standard directories
13217 come next.
13218
13219 @item COMPILER_PATH
13220 @findex COMPILER_PATH
13221 The value of @env{COMPILER_PATH} is a colon-separated list of
13222 directories, much like @env{PATH}.  GCC tries the directories thus
13223 specified when searching for subprograms, if it can't find the
13224 subprograms using @env{GCC_EXEC_PREFIX}.
13225
13226 @item LIBRARY_PATH
13227 @findex LIBRARY_PATH
13228 The value of @env{LIBRARY_PATH} is a colon-separated list of
13229 directories, much like @env{PATH}.  When configured as a native compiler,
13230 GCC tries the directories thus specified when searching for special
13231 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13232 using GCC also uses these directories when searching for ordinary
13233 libraries for the @option{-l} option (but directories specified with
13234 @option{-L} come first).
13235
13236 @item LANG
13237 @findex LANG
13238 @cindex locale definition
13239 This variable is used to pass locale information to the compiler.  One way in
13240 which this information is used is to determine the character set to be used
13241 when character literals, string literals and comments are parsed in C and C++.
13242 When the compiler is configured to allow multibyte characters,
13243 the following values for @env{LANG} are recognized:
13244
13245 @table @samp
13246 @item C-JIS
13247 Recognize JIS characters.
13248 @item C-SJIS
13249 Recognize SJIS characters.
13250 @item C-EUCJP
13251 Recognize EUCJP characters.
13252 @end table
13253
13254 If @env{LANG} is not defined, or if it has some other value, then the
13255 compiler will use mblen and mbtowc as defined by the default locale to
13256 recognize and translate multibyte characters.
13257 @end table
13258
13259 @noindent
13260 Some additional environments variables affect the behavior of the
13261 preprocessor.
13262
13263 @include cppenv.texi
13264
13265 @c man end
13266
13267 @node Precompiled Headers
13268 @section Using Precompiled Headers
13269 @cindex precompiled headers
13270 @cindex speed of compilation
13271
13272 Often large projects have many header files that are included in every
13273 source file.  The time the compiler takes to process these header files
13274 over and over again can account for nearly all of the time required to
13275 build the project.  To make builds faster, GCC allows users to
13276 `precompile' a header file; then, if builds can use the precompiled
13277 header file they will be much faster.
13278
13279 To create a precompiled header file, simply compile it as you would any
13280 other file, if necessary using the @option{-x} option to make the driver
13281 treat it as a C or C++ header file.  You will probably want to use a
13282 tool like @command{make} to keep the precompiled header up-to-date when
13283 the headers it contains change.
13284
13285 A precompiled header file will be searched for when @code{#include} is
13286 seen in the compilation.  As it searches for the included file
13287 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13288 compiler looks for a precompiled header in each directory just before it
13289 looks for the include file in that directory.  The name searched for is
13290 the name specified in the @code{#include} with @samp{.gch} appended.  If
13291 the precompiled header file can't be used, it is ignored.
13292
13293 For instance, if you have @code{#include "all.h"}, and you have
13294 @file{all.h.gch} in the same directory as @file{all.h}, then the
13295 precompiled header file will be used if possible, and the original
13296 header will be used otherwise.
13297
13298 Alternatively, you might decide to put the precompiled header file in a
13299 directory and use @option{-I} to ensure that directory is searched
13300 before (or instead of) the directory containing the original header.
13301 Then, if you want to check that the precompiled header file is always
13302 used, you can put a file of the same name as the original header in this
13303 directory containing an @code{#error} command.
13304
13305 This also works with @option{-include}.  So yet another way to use
13306 precompiled headers, good for projects not designed with precompiled
13307 header files in mind, is to simply take most of the header files used by
13308 a project, include them from another header file, precompile that header
13309 file, and @option{-include} the precompiled header.  If the header files
13310 have guards against multiple inclusion, they will be skipped because
13311 they've already been included (in the precompiled header).
13312
13313 If you need to precompile the same header file for different
13314 languages, targets, or compiler options, you can instead make a
13315 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13316 header in the directory, perhaps using @option{-o}.  It doesn't matter
13317 what you call the files in the directory, every precompiled header in
13318 the directory will be considered.  The first precompiled header
13319 encountered in the directory that is valid for this compilation will
13320 be used; they're searched in no particular order.
13321
13322 There are many other possibilities, limited only by your imagination,
13323 good sense, and the constraints of your build system.
13324
13325 A precompiled header file can be used only when these conditions apply:
13326
13327 @itemize
13328 @item
13329 Only one precompiled header can be used in a particular compilation.
13330
13331 @item
13332 A precompiled header can't be used once the first C token is seen.  You
13333 can have preprocessor directives before a precompiled header; you can
13334 even include a precompiled header from inside another header, so long as
13335 there are no C tokens before the @code{#include}.
13336
13337 @item
13338 The precompiled header file must be produced for the same language as
13339 the current compilation.  You can't use a C precompiled header for a C++
13340 compilation.
13341
13342 @item
13343 The precompiled header file must have been produced by the same compiler
13344 binary as the current compilation is using.
13345
13346 @item
13347 Any macros defined before the precompiled header is included must
13348 either be defined in the same way as when the precompiled header was
13349 generated, or must not affect the precompiled header, which usually
13350 means that they don't appear in the precompiled header at all.
13351
13352 The @option{-D} option is one way to define a macro before a
13353 precompiled header is included; using a @code{#define} can also do it.
13354 There are also some options that define macros implicitly, like
13355 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13356 defined this way.
13357
13358 @item If debugging information is output when using the precompiled
13359 header, using @option{-g} or similar, the same kind of debugging information
13360 must have been output when building the precompiled header.  However,
13361 a precompiled header built using @option{-g} can be used in a compilation
13362 when no debugging information is being output.
13363
13364 @item The same @option{-m} options must generally be used when building
13365 and using the precompiled header.  @xref{Submodel Options},
13366 for any cases where this rule is relaxed.
13367
13368 @item Each of the following options must be the same when building and using
13369 the precompiled header:
13370
13371 @gccoptlist{-fexceptions -funit-at-a-time}
13372
13373 @item
13374 Some other command-line options starting with @option{-f},
13375 @option{-p}, or @option{-O} must be defined in the same way as when
13376 the precompiled header was generated.  At present, it's not clear
13377 which options are safe to change and which are not; the safest choice
13378 is to use exactly the same options when generating and using the
13379 precompiled header.  The following are known to be safe:
13380
13381 @gccoptlist{-fmessage-length= -fpreprocessed
13382 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13383 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13384 -pedantic-errors}
13385
13386 @end itemize
13387
13388 For all of these except the last, the compiler will automatically
13389 ignore the precompiled header if the conditions aren't met.  If you
13390 find an option combination that doesn't work and doesn't cause the
13391 precompiled header to be ignored, please consider filing a bug report,
13392 see @ref{Bugs}.
13393
13394 If you do use differing options when generating and using the
13395 precompiled header, the actual behavior will be a mixture of the
13396 behavior for the options.  For instance, if you use @option{-g} to
13397 generate the precompiled header but not when using it, you may or may
13398 not get debugging information for routines in the precompiled header.
13399
13400 @node Running Protoize
13401 @section Running Protoize
13402
13403 The program @code{protoize} is an optional part of GCC@.  You can use
13404 it to add prototypes to a program, thus converting the program to ISO
13405 C in one respect.  The companion program @code{unprotoize} does the
13406 reverse: it removes argument types from any prototypes that are found.
13407
13408 When you run these programs, you must specify a set of source files as
13409 command line arguments.  The conversion programs start out by compiling
13410 these files to see what functions they define.  The information gathered
13411 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13412
13413 After scanning comes actual conversion.  The specified files are all
13414 eligible to be converted; any files they include (whether sources or
13415 just headers) are eligible as well.
13416
13417 But not all the eligible files are converted.  By default,
13418 @code{protoize} and @code{unprotoize} convert only source and header
13419 files in the current directory.  You can specify additional directories
13420 whose files should be converted with the @option{-d @var{directory}}
13421 option.  You can also specify particular files to exclude with the
13422 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13423 directory name matches one of the specified directory names, and its
13424 name within the directory has not been excluded.
13425
13426 Basic conversion with @code{protoize} consists of rewriting most
13427 function definitions and function declarations to specify the types of
13428 the arguments.  The only ones not rewritten are those for varargs
13429 functions.
13430
13431 @code{protoize} optionally inserts prototype declarations at the
13432 beginning of the source file, to make them available for any calls that
13433 precede the function's definition.  Or it can insert prototype
13434 declarations with block scope in the blocks where undeclared functions
13435 are called.
13436
13437 Basic conversion with @code{unprotoize} consists of rewriting most
13438 function declarations to remove any argument types, and rewriting
13439 function definitions to the old-style pre-ISO form.
13440
13441 Both conversion programs print a warning for any function declaration or
13442 definition that they can't convert.  You can suppress these warnings
13443 with @option{-q}.
13444
13445 The output from @code{protoize} or @code{unprotoize} replaces the
13446 original source file.  The original file is renamed to a name ending
13447 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13448 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13449 for DOS) file already exists, then the source file is simply discarded.
13450
13451 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13452 scan the program and collect information about the functions it uses.
13453 So neither of these programs will work until GCC is installed.
13454
13455 Here is a table of the options you can use with @code{protoize} and
13456 @code{unprotoize}.  Each option works with both programs unless
13457 otherwise stated.
13458
13459 @table @code
13460 @item -B @var{directory}
13461 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13462 usual directory (normally @file{/usr/local/lib}).  This file contains
13463 prototype information about standard system functions.  This option
13464 applies only to @code{protoize}.
13465
13466 @item -c @var{compilation-options}
13467 Use @var{compilation-options} as the options when running @command{gcc} to
13468 produce the @samp{.X} files.  The special option @option{-aux-info} is
13469 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13470
13471 Note that the compilation options must be given as a single argument to
13472 @code{protoize} or @code{unprotoize}.  If you want to specify several
13473 @command{gcc} options, you must quote the entire set of compilation options
13474 to make them a single word in the shell.
13475
13476 There are certain @command{gcc} arguments that you cannot use, because they
13477 would produce the wrong kind of output.  These include @option{-g},
13478 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13479 the @var{compilation-options}, they are ignored.
13480
13481 @item -C
13482 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13483 systems) instead of @samp{.c}.  This is convenient if you are converting
13484 a C program to C++.  This option applies only to @code{protoize}.
13485
13486 @item -g
13487 Add explicit global declarations.  This means inserting explicit
13488 declarations at the beginning of each source file for each function
13489 that is called in the file and was not declared.  These declarations
13490 precede the first function definition that contains a call to an
13491 undeclared function.  This option applies only to @code{protoize}.
13492
13493 @item -i @var{string}
13494 Indent old-style parameter declarations with the string @var{string}.
13495 This option applies only to @code{protoize}.
13496
13497 @code{unprotoize} converts prototyped function definitions to old-style
13498 function definitions, where the arguments are declared between the
13499 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13500 uses five spaces as the indentation.  If you want to indent with just
13501 one space instead, use @option{-i " "}.
13502
13503 @item -k
13504 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13505 is finished.
13506
13507 @item -l
13508 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13509 a prototype declaration for each function in each block which calls the
13510 function without any declaration.  This option applies only to
13511 @code{protoize}.
13512
13513 @item -n
13514 Make no real changes.  This mode just prints information about the conversions
13515 that would have been done without @option{-n}.
13516
13517 @item -N
13518 Make no @samp{.save} files.  The original files are simply deleted.
13519 Use this option with caution.
13520
13521 @item -p @var{program}
13522 Use the program @var{program} as the compiler.  Normally, the name
13523 @file{gcc} is used.
13524
13525 @item -q
13526 Work quietly.  Most warnings are suppressed.
13527
13528 @item -v
13529 Print the version number, just like @option{-v} for @command{gcc}.
13530 @end table
13531
13532 If you need special compiler options to compile one of your program's
13533 source files, then you should generate that file's @samp{.X} file
13534 specially, by running @command{gcc} on that source file with the
13535 appropriate options and the option @option{-aux-info}.  Then run
13536 @code{protoize} on the entire set of files.  @code{protoize} will use
13537 the existing @samp{.X} file because it is newer than the source file.
13538 For example:
13539
13540 @smallexample
13541 gcc -Dfoo=bar file1.c -aux-info file1.X
13542 protoize *.c
13543 @end smallexample
13544
13545 @noindent
13546 You need to include the special files along with the rest in the
13547 @code{protoize} command, even though their @samp{.X} files already
13548 exist, because otherwise they won't get converted.
13549
13550 @xref{Protoize Caveats}, for more information on how to use
13551 @code{protoize} successfully.