OSDN Git Service

gcc/
[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, 2006, 2007
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
15
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with the
19 Invariant Sections being ``GNU General Public License'' and ``Funding
20 Free Software'', the Front-Cover texts being (a) (see below), and with
21 the Back-Cover Texts being (b) (see below).  A copy of the license is
22 included in the gfdl(7) man page.
23
24 (a) The FSF's Front-Cover Text is:
25
26      A GNU Manual
27
28 (b) The FSF's Back-Cover Text is:
29
30      You have freedom to copy and modify this GNU Manual, like GNU
31      software.  Copies published by the Free Software Foundation raise
32      funds for GNU development.
33 @c man end
34 @c Set file name and title for the man page.
35 @setfilename gcc
36 @settitle GNU project C and C++ compiler
37 @c man begin SYNOPSIS
38 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
39     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
40     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
41     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
42     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
43     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
44     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45
46 Only the most useful options are listed here; see below for the
47 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
48 @c man end
49 @c man begin SEEALSO
50 gpl(7), gfdl(7), fsf-funding(7),
51 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
52 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
53 @file{ld}, @file{binutils} and @file{gdb}.
54 @c man end
55 @c man begin BUGS
56 For instructions on reporting bugs, see
57 @w{@uref{http://gcc.gnu.org/bugs.html}}.
58 @c man end
59 @c man begin AUTHOR
60 See the Info entry for @command{gcc}, or
61 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
62 for contributors to GCC@.
63 @c man end
64 @end ignore
65
66 @node Invoking GCC
67 @chapter GCC Command Options
68 @cindex GCC command options
69 @cindex command options
70 @cindex options, GCC command
71
72 @c man begin DESCRIPTION
73 When you invoke GCC, it normally does preprocessing, compilation,
74 assembly and linking.  The ``overall options'' allow you to stop this
75 process at an intermediate stage.  For example, the @option{-c} option
76 says not to run the linker.  Then the output consists of object files
77 output by the assembler.
78
79 Other options are passed on to one stage of processing.  Some options
80 control the preprocessor and others the compiler itself.  Yet other
81 options control the assembler and linker; most of these are not
82 documented here, since you rarely need to use any of them.
83
84 @cindex C compilation options
85 Most of the command line options that you can use with GCC are useful
86 for C programs; when an option is only useful with another language
87 (usually C++), the explanation says so explicitly.  If the description
88 for a particular option does not mention a source language, you can use
89 that option with all supported languages.
90
91 @cindex C++ compilation options
92 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
93 options for compiling C++ programs.
94
95 @cindex grouping options
96 @cindex options, grouping
97 The @command{gcc} program accepts options and file names as operands.  Many
98 options have multi-letter names; therefore multiple single-letter options
99 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
100 -r}}.
101
102 @cindex order of options
103 @cindex options, order
104 You can mix options and other arguments.  For the most part, the order
105 you use doesn't matter.  Order does matter when you use several
106 options of the same kind; for example, if you specify @option{-L} more
107 than once, the directories are searched in the order specified.  Also,
108 the placement of the @option{-l} option is significant.
109
110 Many options have long names starting with @samp{-f} or with
111 @samp{-W}---for example,
112 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
113 these have both positive and negative forms; the negative form of
114 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
115 only one of these two forms, whichever one is not the default.
116
117 @c man end
118
119 @xref{Option Index}, for an index to GCC's options.
120
121 @menu
122 * Option Summary::      Brief list of all options, without explanations.
123 * Overall Options::     Controlling the kind of output:
124                         an executable, object files, assembler files,
125                         or preprocessed source.
126 * Invoking G++::        Compiling C++ programs.
127 * C Dialect Options::   Controlling the variant of C language compiled.
128 * C++ Dialect Options:: Variations on C++.
129 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
130                         and Objective-C++.
131 * Language Independent Options:: Controlling how diagnostics should be
132                         formatted.
133 * Warning Options::     How picky should the compiler be?
134 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
135 * Optimize Options::    How much optimization?
136 * Preprocessor Options:: Controlling header files and macro definitions.
137                          Also, getting dependency information for Make.
138 * Assembler Options::   Passing options to the assembler.
139 * Link Options::        Specifying libraries and so on.
140 * Directory Options::   Where to find header files and libraries.
141                         Where to find the compiler executable files.
142 * Spec Files::          How to pass switches to sub-processes.
143 * Target Options::      Running a cross-compiler, or an old version of GCC.
144 * Submodel Options::    Specifying minor hardware or convention variations,
145                         such as 68010 vs 68020.
146 * Code Gen Options::    Specifying conventions for function calls, data layout
147                         and register usage.
148 * Environment Variables:: Env vars that affect GCC.
149 * Precompiled Headers:: Compiling a header once, and using it many times.
150 * Running Protoize::    Automatically adding or removing function prototypes.
151 @end menu
152
153 @c man begin OPTIONS
154
155 @node Option Summary
156 @section Option Summary
157
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
160
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -pipe  -pass-exit-codes  @gol
165 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{]}  --target-help  @gol
166 --version @@@var{file}}
167
168 @item C Language Options
169 @xref{C Dialect Options,,Options Controlling C Dialect}.
170 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
171 -aux-info @var{filename} @gol
172 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
173 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
174 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
175 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
176 -fsigned-bitfields  -fsigned-char @gol
177 -funsigned-bitfields  -funsigned-char}
178
179 @item C++ Language Options
180 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
181 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
182 -fconserve-space  -ffriend-injection @gol
183 -fno-elide-constructors @gol
184 -fno-enforce-eh-specs @gol
185 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
186 -fno-implicit-templates @gol
187 -fno-implicit-inline-templates @gol
188 -fno-implement-inlines  -fms-extensions @gol
189 -fno-nonansi-builtins  -fno-operator-names @gol
190 -fno-optional-diags  -fpermissive @gol
191 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
193 -fno-default-inline  -fvisibility-inlines-hidden @gol
194 -fvisibility-ms-compat @gol
195 -Wabi  -Wctor-dtor-privacy @gol
196 -Wnon-virtual-dtor  -Wreorder @gol
197 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
198 -Wno-non-template-friend  -Wold-style-cast @gol
199 -Woverloaded-virtual  -Wno-pmf-conversions @gol
200 -Wsign-promo}
201
202 @item Objective-C and Objective-C++ Language Options
203 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
204 Objective-C and Objective-C++ Dialects}.
205 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
206 -fgnu-runtime  -fnext-runtime @gol
207 -fno-nil-receivers @gol
208 -fobjc-call-cxx-cdtors @gol
209 -fobjc-direct-dispatch @gol
210 -fobjc-exceptions @gol
211 -fobjc-gc @gol
212 -freplace-objc-classes @gol
213 -fzero-link @gol
214 -gen-decls @gol
215 -Wassign-intercept @gol
216 -Wno-protocol  -Wselector @gol
217 -Wstrict-selector-match @gol
218 -Wundeclared-selector}
219
220 @item Language Independent Options
221 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
222 @gccoptlist{-fmessage-length=@var{n}  @gol
223 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
224 -fdiagnostics-show-option}
225
226 @item Warning Options
227 @xref{Warning Options,,Options to Request or Suppress Warnings}.
228 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
229 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
230 -Wno-attributes -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
231 -Wchar-subscripts -Wclobbered  -Wcomment @gol
232 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated-declarations @gol
233 -Wdisabled-optimization  -Wno-div-by-zero  @gol
234 -Wempty-body  -Wno-endif-labels @gol
235 -Werror  -Werror=* @gol
236 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
237 -Wno-format-extra-args -Wformat-nonliteral @gol
238 -Wformat-security  -Wformat-y2k @gol
239 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
240 -Wimport  -Wno-import  -Winit-self  -Winline @gol
241 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
242 -Winvalid-pch -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations @gol
243 -Wlogical-op -Wlong-long @gol
244 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
245 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
246 -Wmissing-noreturn @gol
247 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
248 -Woverlength-strings  -Wpacked  -Wpadded @gol
249 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
250 -Wredundant-decls @gol
251 -Wreturn-type  -Wsequence-point  -Wshadow @gol
252 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
253 -Wstrict-aliasing -Wstrict-aliasing=n @gol
254 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
255 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
256 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
257 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
258 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
259 -Wunused-value  -Wunused-variable @gol
260 -Wvariadic-macros -Wvla @gol
261 -Wvolatile-register-var  -Wwrite-strings}
262
263 @item C-only Warning Options
264 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
265 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
266 -Wold-style-declaration  -Wold-style-definition @gol
267 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
268 -Wdeclaration-after-statement -Wpointer-sign}
269
270 @item Debugging Options
271 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
272 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
273 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
274 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
275 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
276 -fdump-ipa-all -fdump-ipa-cgraph @gol
277 -fdump-tree-all @gol
278 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
279 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
282 -fdump-tree-ch @gol
283 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-nrv -fdump-tree-vect @gol
292 -fdump-tree-sink @gol
293 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-salias @gol
295 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
297 -ftree-vectorizer-verbose=@var{n} @gol
298 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
299 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
300 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
301 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
302 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
303 -ftest-coverage  -ftime-report -fvar-tracking @gol
304 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
305 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
306 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
307 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
308 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
309 -print-multi-directory  -print-multi-lib @gol
310 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
311 -print-sysroot-headers-suffix @gol
312 -save-temps  -time}
313
314 @item Optimization Options
315 @xref{Optimize Options,,Options that Control Optimization}.
316 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
317 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
318 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
319 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
320 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
321 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
322 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
323 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
324 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
325 -fforce-addr  -fforward-propagate  -ffunction-sections @gol
326 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
327 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
328 -finline-functions  -finline-functions-called-once @gol
329 -finline-limit=@var{n}  -fkeep-inline-functions @gol
330 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
331 -fmodulo-sched -fno-branch-count-reg @gol
332 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
333 -fno-function-cse  -fno-guess-branch-probability @gol
334 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
335 -funsafe-math-optimizations  -funsafe-loop-optimizations @gol
336 -ffinite-math-only  -fno-signed-zeros @gol
337 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
338 -fomit-frame-pointer  -foptimize-register-move @gol
339 -foptimize-sibling-calls  -fpredictive-commoning -fprefetch-loop-arrays @gol
340 -fprofile-generate -fprofile-use @gol
341 -fregmove  -frename-registers @gol
342 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
343 -frerun-cse-after-loop @gol
344 -frounding-math -frtl-abstract-sequences @gol
345 -fschedule-insns  -fschedule-insns2 @gol
346 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
347 -fsched-spec-load-dangerous  @gol
348 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
349 -fsched2-use-superblocks @gol
350 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
351 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
352 -fno-split-wide-types -fstack-protector  -fstack-protector-all @gol
353 -fstrict-aliasing  -fstrict-overflow  -ftracer  -fthread-jumps @gol
354 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
355 -fsplit-ivs-in-unroller -funswitch-loops @gol
356 -fvariable-expansion-in-unroller @gol
357 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
358 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
359 -fcheck-data-deps @gol
360 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
361 -ftree-ch -ftree-sra -ftree-ter -ftree-fre -ftree-vectorize @gol
362 -ftree-vect-loop-version -fvect-cost-model -ftree-salias -fipa-pta -fweb @gol
363 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
364 --param @var{name}=@var{value}
365 -O  -O0  -O1  -O2  -O3  -Os}
366
367 @item Preprocessor Options
368 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
369 @gccoptlist{-A@var{question}=@var{answer} @gol
370 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
371 -C  -dD  -dI  -dM  -dN @gol
372 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
373 -idirafter @var{dir} @gol
374 -include @var{file}  -imacros @var{file} @gol
375 -iprefix @var{file}  -iwithprefix @var{dir} @gol
376 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
377 -imultilib @var{dir} -isysroot @var{dir} @gol
378 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
379 -P  -fworking-directory  -remap @gol
380 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
381 -Xpreprocessor @var{option}}
382
383 @item Assembler Option
384 @xref{Assembler Options,,Passing Options to the Assembler}.
385 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
386
387 @item Linker Options
388 @xref{Link Options,,Options for Linking}.
389 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
390 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
391 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
392 -Wl,@var{option}  -Xlinker @var{option} @gol
393 -u @var{symbol}}
394
395 @item Directory Options
396 @xref{Directory Options,,Options for Directory Search}.
397 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
398 -specs=@var{file}  -I- --sysroot=@var{dir}}
399
400 @item Target Options
401 @c I wrote this xref this way to avoid overfull hbox. -- rms
402 @xref{Target Options}.
403 @gccoptlist{-V @var{version}  -b @var{machine}}
404
405 @item Machine Dependent Options
406 @xref{Submodel Options,,Hardware Models and Configurations}.
407 @c This list is ordered alphanumerically by subsection name.
408 @c Try and put the significant identifier (CPU or system) first,
409 @c so users have a clue at guessing where the ones they want will be.
410
411 @emph{ARC Options}
412 @gccoptlist{-EB  -EL @gol
413 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
414 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
415
416 @emph{ARM Options}
417 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
418 -mabi=@var{name} @gol
419 -mapcs-stack-check  -mno-apcs-stack-check @gol
420 -mapcs-float  -mno-apcs-float @gol
421 -mapcs-reentrant  -mno-apcs-reentrant @gol
422 -msched-prolog  -mno-sched-prolog @gol
423 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
424 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
425 -mthumb-interwork  -mno-thumb-interwork @gol
426 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
427 -mstructure-size-boundary=@var{n} @gol
428 -mabort-on-noreturn @gol
429 -mlong-calls  -mno-long-calls @gol
430 -msingle-pic-base  -mno-single-pic-base @gol
431 -mpic-register=@var{reg} @gol
432 -mnop-fun-dllimport @gol
433 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
434 -mpoke-function-name @gol
435 -mthumb  -marm @gol
436 -mtpcs-frame  -mtpcs-leaf-frame @gol
437 -mcaller-super-interworking  -mcallee-super-interworking @gol
438 -mtp=@var{name}}
439
440 @emph{AVR Options}
441 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
442 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
443
444 @emph{Blackfin Options}
445 @gccoptlist{-mcpu=@var{cpu}  -msim  -momit-leaf-frame-pointer @gol
446 -mno-omit-leaf-frame-pointer  -mspecld-anomaly  -mno-specld-anomaly @gol
447 -mcsync-anomaly  -mno-csync-anomaly  -mlow-64k  -mno-low64k @gol
448 -mstack-check-l1  -mid-shared-library  -mno-id-shared-library @gol
449 -mshared-library-id=@var{n}  -mleaf-id-shared-library @gol
450 -mno-leaf-id-shared-library  -msep-data  -mno-sep-data  -mlong-calls @gol
451 -mno-long-calls}
452
453 @emph{CRIS Options}
454 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
455 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
456 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
457 -mstack-align  -mdata-align  -mconst-align @gol
458 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
459 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
460 -mmul-bug-workaround  -mno-mul-bug-workaround}
461
462 @emph{CRX Options}
463 @gccoptlist{-mmac -mpush-args}
464
465 @emph{Darwin Options}
466 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
467 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
468 -client_name  -compatibility_version  -current_version @gol
469 -dead_strip @gol
470 -dependency-file  -dylib_file  -dylinker_install_name @gol
471 -dynamic  -dynamiclib  -exported_symbols_list @gol
472 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
473 -force_flat_namespace  -headerpad_max_install_names @gol
474 -iframework @gol
475 -image_base  -init  -install_name  -keep_private_externs @gol
476 -multi_module  -multiply_defined  -multiply_defined_unused @gol
477 -noall_load   -no_dead_strip_inits_and_terms @gol
478 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
479 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
480 -private_bundle  -read_only_relocs  -sectalign @gol
481 -sectobjectsymbols  -whyload  -seg1addr @gol
482 -sectcreate  -sectobjectsymbols  -sectorder @gol
483 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
484 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
485 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
486 -single_module  -static  -sub_library  -sub_umbrella @gol
487 -twolevel_namespace  -umbrella  -undefined @gol
488 -unexported_symbols_list  -weak_reference_mismatches @gol
489 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
490 -mkernel -mone-byte-bool}
491
492 @emph{DEC Alpha Options}
493 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
494 -mieee  -mieee-with-inexact  -mieee-conformant @gol
495 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
496 -mtrap-precision=@var{mode}  -mbuild-constants @gol
497 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
498 -mbwx  -mmax  -mfix  -mcix @gol
499 -mfloat-vax  -mfloat-ieee @gol
500 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
501 -msmall-text  -mlarge-text @gol
502 -mmemory-latency=@var{time}}
503
504 @emph{DEC Alpha/VMS Options}
505 @gccoptlist{-mvms-return-codes}
506
507 @emph{FRV Options}
508 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
509 -mhard-float  -msoft-float @gol
510 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
511 -mdouble  -mno-double @gol
512 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
513 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
514 -mlinked-fp  -mlong-calls  -malign-labels @gol
515 -mlibrary-pic  -macc-4  -macc-8 @gol
516 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
517 -moptimize-membar -mno-optimize-membar @gol
518 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
519 -mvliw-branch  -mno-vliw-branch @gol
520 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
521 -mno-nested-cond-exec  -mtomcat-stats @gol
522 -mTLS -mtls @gol
523 -mcpu=@var{cpu}}
524
525 @emph{GNU/Linux Options}
526 @gccoptlist{-muclibc}
527
528 @emph{H8/300 Options}
529 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
530
531 @emph{HPPA Options}
532 @gccoptlist{-march=@var{architecture-type} @gol
533 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
534 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
535 -mfixed-range=@var{register-range} @gol
536 -mjump-in-delay -mlinker-opt -mlong-calls @gol
537 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
538 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
539 -mno-jump-in-delay  -mno-long-load-store @gol
540 -mno-portable-runtime  -mno-soft-float @gol
541 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
542 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
543 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
544 -munix=@var{unix-std}  -nolibdld  -static  -threads}
545
546 @emph{i386 and x86-64 Options}
547 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
548 -mfpmath=@var{unit} @gol
549 -masm=@var{dialect}  -mno-fancy-math-387 @gol
550 -mno-fp-ret-in-387  -msoft-float @gol
551 -mno-wide-multiply  -mrtd  -malign-double @gol
552 -mpreferred-stack-boundary=@var{num} -mcx16 -msahf -mrecip @gol
553 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
554 -msse4a -m3dnow -mpopcnt -mabm @gol
555 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
556 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
557 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
558 -mpc32 -mpc64 -mpc80 mstackrealign @gol
559 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
560 -mcmodel=@var{code-model} @gol
561 -m32  -m64 -mlarge-data-threshold=@var{num}}
562
563 @emph{IA-64 Options}
564 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
565 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
566 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
567 -minline-float-divide-max-throughput @gol
568 -minline-int-divide-min-latency @gol
569 -minline-int-divide-max-throughput  @gol
570 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
571 -mno-dwarf2-asm -mearly-stop-bits @gol
572 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
573 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
574 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
575 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
576 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
577 -mno-sched-prefer-non-data-spec-insns @gol
578 -mno-sched-prefer-non-control-spec-insns @gol
579 -mno-sched-count-spec-in-critical-path}
580
581 @emph{M32R/D Options}
582 @gccoptlist{-m32r2 -m32rx -m32r @gol
583 -mdebug @gol
584 -malign-loops -mno-align-loops @gol
585 -missue-rate=@var{number} @gol
586 -mbranch-cost=@var{number} @gol
587 -mmodel=@var{code-size-model-type} @gol
588 -msdata=@var{sdata-type} @gol
589 -mno-flush-func -mflush-func=@var{name} @gol
590 -mno-flush-trap -mflush-trap=@var{number} @gol
591 -G @var{num}}
592
593 @emph{M32C Options}
594 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
595
596 @emph{M680x0 Options}
597 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
598 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
599 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
600 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
601 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
602 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
603 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
604 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
605
606 @emph{M68hc1x Options}
607 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
608 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
609 -msoft-reg-count=@var{count}}
610
611 @emph{MCore Options}
612 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
613 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
614 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
615 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
616 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
617
618 @emph{MIPS Options}
619 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
620 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
621 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
622 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
623 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
624 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
625 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
626 -mips3d  -mno-mips3d  -mmt  -mno-mt @gol
627 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
628 -G@var{num}  -membedded-data  -mno-embedded-data @gol
629 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
630 -msplit-addresses  -mno-split-addresses @gol
631 -mexplicit-relocs  -mno-explicit-relocs @gol
632 -mcheck-zero-division  -mno-check-zero-division @gol
633 -mdivide-traps  -mdivide-breaks @gol
634 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
635 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
636 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
637 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
638 -mfix-sb1  -mno-fix-sb1 @gol
639 -mflush-func=@var{func}  -mno-flush-func @gol
640 -mbranch-likely  -mno-branch-likely @gol
641 -mfp-exceptions -mno-fp-exceptions @gol
642 -mvr4130-align -mno-vr4130-align}
643
644 @emph{MMIX Options}
645 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
646 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
647 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
648 -mno-base-addresses  -msingle-exit  -mno-single-exit}
649
650 @emph{MN10300 Options}
651 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
652 -mam33  -mno-am33 @gol
653 -mam33-2  -mno-am33-2 @gol
654 -mreturn-pointer-on-d0 @gol
655 -mno-crt0  -mrelax}
656
657 @emph{MT Options}
658 @gccoptlist{-mno-crt0 -mbacc -msim @gol
659 -march=@var{cpu-type} }
660
661 @emph{PDP-11 Options}
662 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
663 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
664 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
665 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
666 -mbranch-expensive  -mbranch-cheap @gol
667 -msplit  -mno-split  -munix-asm  -mdec-asm}
668
669 @emph{PowerPC Options}
670 See RS/6000 and PowerPC Options.
671
672 @emph{RS/6000 and PowerPC Options}
673 @gccoptlist{-mcpu=@var{cpu-type} @gol
674 -mtune=@var{cpu-type} @gol
675 -mpower  -mno-power  -mpower2  -mno-power2 @gol
676 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
677 -maltivec  -mno-altivec @gol
678 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
679 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
680 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
681 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mdfp -mno-dfp @gol
682 -mnew-mnemonics  -mold-mnemonics @gol
683 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
684 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
685 -malign-power  -malign-natural @gol
686 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
687 -mstring  -mno-string  -mupdate  -mno-update @gol
688 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
689 -mstrict-align  -mno-strict-align  -mrelocatable @gol
690 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
691 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
692 -mdynamic-no-pic  -maltivec  -mswdiv @gol
693 -mprioritize-restricted-insns=@var{priority} @gol
694 -msched-costly-dep=@var{dependence_type} @gol
695 -minsert-sched-nops=@var{scheme} @gol
696 -mcall-sysv  -mcall-netbsd @gol
697 -maix-struct-return  -msvr4-struct-return @gol
698 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
699 -misel -mno-isel @gol
700 -misel=yes  -misel=no @gol
701 -mspe -mno-spe @gol
702 -mspe=yes  -mspe=no @gol
703 -mvrsave -mno-vrsave @gol
704 -mmulhw -mno-mulhw @gol
705 -mdlmzb -mno-dlmzb @gol
706 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
707 -mprototype  -mno-prototype @gol
708 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
709 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
710
711 @emph{S/390 and zSeries Options}
712 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
713 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
714 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
715 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
716 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
717 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
718 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
719
720 @emph{Score Options}
721 @gccoptlist{-meb -mel @gol
722 -mnhwloop @gol
723 -muls @gol
724 -mmac @gol
725 -mscore5 -mscore5u -mscore7 -mscore7d}
726
727 @emph{SH Options}
728 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
729 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
730 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
731 -m5-64media  -m5-64media-nofpu @gol
732 -m5-32media  -m5-32media-nofpu @gol
733 -m5-compact  -m5-compact-nofpu @gol
734 -mb  -ml  -mdalign  -mrelax @gol
735 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
736 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
737 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
738 -mdivsi3_libfunc=@var{name}  @gol
739 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
740  -minvalid-symbols}
741
742 @emph{SPARC Options}
743 @gccoptlist{-mcpu=@var{cpu-type} @gol
744 -mtune=@var{cpu-type} @gol
745 -mcmodel=@var{code-model} @gol
746 -m32  -m64  -mapp-regs  -mno-app-regs @gol
747 -mfaster-structs  -mno-faster-structs @gol
748 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
749 -mhard-quad-float  -msoft-quad-float @gol
750 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
751 -mstack-bias  -mno-stack-bias @gol
752 -munaligned-doubles  -mno-unaligned-doubles @gol
753 -mv8plus  -mno-v8plus  -mvis  -mno-vis
754 -threads -pthreads -pthread}
755
756 @emph{SPU Options}
757 @gccoptlist{-mwarn-reloc -merror-reloc @gol
758 -msafe-dma -munsafe-dma @gol
759 -mbranch-hints @gol
760 -msmall-mem -mlarge-mem -mstdmain @gol
761 -mfixed-range=@var{register-range}}
762
763 @emph{System V Options}
764 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
765
766 @emph{TMS320C3x/C4x Options}
767 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
768 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
769 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
770 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
771
772 @emph{V850 Options}
773 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
774 -mprolog-function  -mno-prolog-function  -mspace @gol
775 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
776 -mapp-regs  -mno-app-regs @gol
777 -mdisable-callt  -mno-disable-callt @gol
778 -mv850e1 @gol
779 -mv850e @gol
780 -mv850  -mbig-switch}
781
782 @emph{VAX Options}
783 @gccoptlist{-mg  -mgnu  -munix}
784
785 @emph{VxWorks Options}
786 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
787 -Xbind-lazy  -Xbind-now}
788
789 @emph{x86-64 Options}
790 See i386 and x86-64 Options.
791
792 @emph{Xstormy16 Options}
793 @gccoptlist{-msim}
794
795 @emph{Xtensa Options}
796 @gccoptlist{-mconst16 -mno-const16 @gol
797 -mfused-madd  -mno-fused-madd @gol
798 -mtext-section-literals  -mno-text-section-literals @gol
799 -mtarget-align  -mno-target-align @gol
800 -mlongcalls  -mno-longcalls}
801
802 @emph{zSeries Options}
803 See S/390 and zSeries Options.
804
805 @item Code Generation Options
806 @xref{Code Gen Options,,Options for Code Generation Conventions}.
807 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
808 -ffixed-@var{reg}  -fexceptions @gol
809 -fnon-call-exceptions  -funwind-tables @gol
810 -fasynchronous-unwind-tables @gol
811 -finhibit-size-directive  -finstrument-functions @gol
812 -fno-common  -fno-ident @gol
813 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
814 -fno-jump-tables @gol
815 -frecord-gcc-switches @gol
816 -freg-struct-return  -fshort-enums @gol
817 -fshort-double  -fshort-wchar @gol
818 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
819 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
820 -fargument-alias  -fargument-noalias @gol
821 -fargument-noalias-global  -fargument-noalias-anything
822 -fleading-underscore  -ftls-model=@var{model} @gol
823 -ftrapv  -fwrapv  -fbounds-check @gol
824 -fvisibility}
825 @end table
826
827 @menu
828 * Overall Options::     Controlling the kind of output:
829                         an executable, object files, assembler files,
830                         or preprocessed source.
831 * C Dialect Options::   Controlling the variant of C language compiled.
832 * C++ Dialect Options:: Variations on C++.
833 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
834                         and Objective-C++.
835 * Language Independent Options:: Controlling how diagnostics should be
836                         formatted.
837 * Warning Options::     How picky should the compiler be?
838 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
839 * Optimize Options::    How much optimization?
840 * Preprocessor Options:: Controlling header files and macro definitions.
841                          Also, getting dependency information for Make.
842 * Assembler Options::   Passing options to the assembler.
843 * Link Options::        Specifying libraries and so on.
844 * Directory Options::   Where to find header files and libraries.
845                         Where to find the compiler executable files.
846 * Spec Files::          How to pass switches to sub-processes.
847 * Target Options::      Running a cross-compiler, or an old version of GCC.
848 @end menu
849
850 @node Overall Options
851 @section Options Controlling the Kind of Output
852
853 Compilation can involve up to four stages: preprocessing, compilation
854 proper, assembly and linking, always in that order.  GCC is capable of
855 preprocessing and compiling several files either into several
856 assembler input files, or into one assembler input file; then each
857 assembler input file produces an object file, and linking combines all
858 the object files (those newly compiled, and those specified as input)
859 into an executable file.
860
861 @cindex file name suffix
862 For any given input file, the file name suffix determines what kind of
863 compilation is done:
864
865 @table @gcctabopt
866 @item @var{file}.c
867 C source code which must be preprocessed.
868
869 @item @var{file}.i
870 C source code which should not be preprocessed.
871
872 @item @var{file}.ii
873 C++ source code which should not be preprocessed.
874
875 @item @var{file}.m
876 Objective-C source code.  Note that you must link with the @file{libobjc}
877 library to make an Objective-C program work.
878
879 @item @var{file}.mi
880 Objective-C source code which should not be preprocessed.
881
882 @item @var{file}.mm
883 @itemx @var{file}.M
884 Objective-C++ source code.  Note that you must link with the @file{libobjc}
885 library to make an Objective-C++ program work.  Note that @samp{.M} refers
886 to a literal capital M@.
887
888 @item @var{file}.mii
889 Objective-C++ source code which should not be preprocessed.
890
891 @item @var{file}.h
892 C, C++, Objective-C or Objective-C++ header file to be turned into a
893 precompiled header.
894
895 @item @var{file}.cc
896 @itemx @var{file}.cp
897 @itemx @var{file}.cxx
898 @itemx @var{file}.cpp
899 @itemx @var{file}.CPP
900 @itemx @var{file}.c++
901 @itemx @var{file}.C
902 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
903 the last two letters must both be literally @samp{x}.  Likewise,
904 @samp{.C} refers to a literal capital C@.
905
906 @item @var{file}.mm
907 @itemx @var{file}.M
908 Objective-C++ source code which must be preprocessed.
909
910 @item @var{file}.mii
911 Objective-C++ source code which should not be preprocessed.
912
913 @item @var{file}.hh
914 @itemx @var{file}.H
915 C++ header file to be turned into a precompiled header.
916
917 @item @var{file}.f
918 @itemx @var{file}.for
919 @itemx @var{file}.FOR
920 Fixed form Fortran source code which should not be preprocessed.
921
922 @item @var{file}.F
923 @itemx @var{file}.fpp
924 @itemx @var{file}.FPP
925 Fixed form Fortran source code which must be preprocessed (with the traditional
926 preprocessor).
927
928 @item @var{file}.f90
929 @itemx @var{file}.f95
930 Free form Fortran source code which should not be preprocessed.
931
932 @item @var{file}.F90
933 @itemx @var{file}.F95
934 Free form Fortran source code which must be preprocessed (with the
935 traditional preprocessor).
936
937 @c FIXME: Descriptions of Java file types.
938 @c @var{file}.java
939 @c @var{file}.class
940 @c @var{file}.zip
941 @c @var{file}.jar
942
943 @item @var{file}.ads
944 Ada source code file which contains a library unit declaration (a
945 declaration of a package, subprogram, or generic, or a generic
946 instantiation), or a library unit renaming declaration (a package,
947 generic, or subprogram renaming declaration).  Such files are also
948 called @dfn{specs}.
949
950 @itemx @var{file}.adb
951 Ada source code file containing a library unit body (a subprogram or
952 package body).  Such files are also called @dfn{bodies}.
953
954 @c GCC also knows about some suffixes for languages not yet included:
955 @c Pascal:
956 @c @var{file}.p
957 @c @var{file}.pas
958 @c Ratfor:
959 @c @var{file}.r
960
961 @item @var{file}.s
962 Assembler code.
963
964 @item @var{file}.S
965 Assembler code which must be preprocessed.
966
967 @item @var{other}
968 An object file to be fed straight into linking.
969 Any file name with no recognized suffix is treated this way.
970 @end table
971
972 @opindex x
973 You can specify the input language explicitly with the @option{-x} option:
974
975 @table @gcctabopt
976 @item -x @var{language}
977 Specify explicitly the @var{language} for the following input files
978 (rather than letting the compiler choose a default based on the file
979 name suffix).  This option applies to all following input files until
980 the next @option{-x} option.  Possible values for @var{language} are:
981 @smallexample
982 c  c-header  c-cpp-output
983 c++  c++-header  c++-cpp-output
984 objective-c  objective-c-header  objective-c-cpp-output
985 objective-c++ objective-c++-header objective-c++-cpp-output
986 assembler  assembler-with-cpp
987 ada
988 f95  f95-cpp-input
989 java
990 treelang
991 @end smallexample
992
993 @item -x none
994 Turn off any specification of a language, so that subsequent files are
995 handled according to their file name suffixes (as they are if @option{-x}
996 has not been used at all).
997
998 @item -pass-exit-codes
999 @opindex pass-exit-codes
1000 Normally the @command{gcc} program will exit with the code of 1 if any
1001 phase of the compiler returns a non-success return code.  If you specify
1002 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1003 numerically highest error produced by any phase that returned an error
1004 indication.  The C, C++, and Fortran frontends return 4, if an internal
1005 compiler error is encountered.
1006 @end table
1007
1008 If you only want some of the stages of compilation, you can use
1009 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1010 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1011 @command{gcc} is to stop.  Note that some combinations (for example,
1012 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1013
1014 @table @gcctabopt
1015 @item -c
1016 @opindex c
1017 Compile or assemble the source files, but do not link.  The linking
1018 stage simply is not done.  The ultimate output is in the form of an
1019 object file for each source file.
1020
1021 By default, the object file name for a source file is made by replacing
1022 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1023
1024 Unrecognized input files, not requiring compilation or assembly, are
1025 ignored.
1026
1027 @item -S
1028 @opindex S
1029 Stop after the stage of compilation proper; do not assemble.  The output
1030 is in the form of an assembler code file for each non-assembler input
1031 file specified.
1032
1033 By default, the assembler file name for a source file is made by
1034 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1035
1036 Input files that don't require compilation are ignored.
1037
1038 @item -E
1039 @opindex E
1040 Stop after the preprocessing stage; do not run the compiler proper.  The
1041 output is in the form of preprocessed source code, which is sent to the
1042 standard output.
1043
1044 Input files which don't require preprocessing are ignored.
1045
1046 @cindex output file option
1047 @item -o @var{file}
1048 @opindex o
1049 Place output in file @var{file}.  This applies regardless to whatever
1050 sort of output is being produced, whether it be an executable file,
1051 an object file, an assembler file or preprocessed C code.
1052
1053 If @option{-o} is not specified, the default is to put an executable
1054 file in @file{a.out}, the object file for
1055 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1056 assembler file in @file{@var{source}.s}, a precompiled header file in
1057 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1058 standard output.
1059
1060 @item -v
1061 @opindex v
1062 Print (on standard error output) the commands executed to run the stages
1063 of compilation.  Also print the version number of the compiler driver
1064 program and of the preprocessor and the compiler proper.
1065
1066 @item -###
1067 @opindex ###
1068 Like @option{-v} except the commands are not executed and all command
1069 arguments are quoted.  This is useful for shell scripts to capture the
1070 driver-generated command lines.
1071
1072 @item -pipe
1073 @opindex pipe
1074 Use pipes rather than temporary files for communication between the
1075 various stages of compilation.  This fails to work on some systems where
1076 the assembler is unable to read from a pipe; but the GNU assembler has
1077 no trouble.
1078
1079 @item -combine
1080 @opindex combine
1081 If you are compiling multiple source files, this option tells the driver
1082 to pass all the source files to the compiler at once (for those
1083 languages for which the compiler can handle this).  This will allow
1084 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1085 language for which this is supported is C@.  If you pass source files for
1086 multiple languages to the driver, using this option, the driver will invoke
1087 the compiler(s) that support IMA once each, passing each compiler all the
1088 source files appropriate for it.  For those languages that do not support
1089 IMA this option will be ignored, and the compiler will be invoked once for
1090 each source file in that language.  If you use this option in conjunction
1091 with @option{-save-temps}, the compiler will generate multiple
1092 pre-processed files
1093 (one for each source file), but only one (combined) @file{.o} or
1094 @file{.s} file.
1095
1096 @item --help
1097 @opindex help
1098 Print (on the standard output) a description of the command line options
1099 understood by @command{gcc}.  If the @option{-v} option is also specified
1100 then @option{--help} will also be passed on to the various processes
1101 invoked by @command{gcc}, so that they can display the command line options
1102 they accept.  If the @option{-Wextra} option has also been specified
1103 (prior to the @option{--help} option), then command line options which
1104 have no documentation associated with them will also be displayed.
1105
1106 @item --target-help
1107 @opindex target-help
1108 Print (on the standard output) a description of target-specific command
1109 line options for each tool.
1110
1111 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1112 Print (on the standard output) a description of the command line
1113 options understood by the compiler that fit into a specific class.
1114 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1115 @samp{params}, or @var{language}:
1116
1117 @table @asis
1118 @item @samp{optimizers}
1119 This will display all of the optimization options supported by the
1120 compiler.
1121
1122 @item @samp{warnings}
1123 This will display all of the options controlling warning messages
1124 produced by the compiler.
1125
1126 @item @samp{target}
1127 This will display target-specific options.  Unlike the
1128 @option{--target-help} option however, target-specific options of the
1129 linker and assembler will not be displayed.  This is because those
1130 tools do not currently support the extended @option{--help=} syntax.
1131
1132 @item @samp{params}
1133 This will display the values recognized by the @option{--param}
1134 option.
1135
1136 @item @var{language}
1137 This will display the options supported for @var{language}, where 
1138 @var{language} is the name of one of the languages supported in this 
1139 version of GCC.
1140
1141 @item @samp{common}
1142 This will display the options that are common to all languages.
1143 @end table
1144
1145 It is possible to further refine the output of the @option{--help=}
1146 option by adding a comma separated list of qualifiers after the
1147 class.  These can be any from the following list:
1148
1149 @table @asis
1150 @item @samp{undocumented}
1151 Display only those options which are undocumented.
1152
1153 @item @samp{joined}
1154 Display options which take an argument that appears after an equal
1155 sign in the same continuous piece of text, such as:
1156 @samp{--help=target}.
1157
1158 @item @samp{separate}
1159 Display options which take an argument that appears as a separate word
1160 following the original option, such as: @samp{-o output-file}.
1161 @end table
1162
1163 Thus for example to display all the undocumented target-specific
1164 switches supported by the compiler the following can be used:
1165
1166 @smallexample
1167 --help=target,undocumented
1168 @end smallexample
1169
1170 The sense of a qualifier can be inverted by prefixing it with the
1171 @var{^} character, so for example to display all binary warning
1172 options (i.e. ones that are either on or off and that do not take an
1173 argument), which have a description the following can be used:
1174
1175 @smallexample
1176 --help=warnings,^joined,^undocumented
1177 @end smallexample
1178
1179 A class can also be used as a qualifier, although this usually
1180 restricts the output by so much that there is nothing to display.  One
1181 case where it does work however is when one of the classes is
1182 @var{target}.  So for example to display all the target-specific
1183 optimization options the following can be used:
1184
1185 @smallexample
1186 --help=target,optimizers
1187 @end smallexample
1188
1189 The @option{--help=} option can be repeated on the command line.  Each
1190 successive use will display its requested class of options, skipping
1191 those that have already been displayed.
1192
1193 If the @option{-Q} option appears on the command line before the
1194 @option{--help=} option, then the descriptive text displayed by
1195 @option{--help=} is changed.  Instead of describing the displayed
1196 options, an indication is given as to whether the option is enabled,
1197 disabled or set to a specific value (assuming that the compiler
1198 knows this at the point where the @option{--help=} option is used).
1199
1200 Here is a truncated example from the ARM port of @command{gcc}:
1201
1202 @smallexample
1203   % gcc -Q -mabi=2 --help=target -c
1204   The following options are target specific:
1205   -mabi=                                2
1206   -mabort-on-noreturn                   [disabled]
1207   -mapcs                                [disabled]
1208 @end smallexample
1209
1210 The output is sensitive to the effects of previous command line
1211 options, so for example it is possible to find out which optimizations
1212 are enabled at @option{-O2} by using:
1213
1214 @smallexample
1215 -O2 --help=optimizers
1216 @end smallexample
1217
1218 Alternatively you can discover which binary optimizations are enabled
1219 by @option{-O3} by using:
1220
1221 @smallexample
1222 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1223 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1224 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1225 @end smallexample
1226
1227 @item --version
1228 @opindex version
1229 Display the version number and copyrights of the invoked GCC@.
1230
1231 @include @value{srcdir}/../libiberty/at-file.texi
1232 @end table
1233
1234 @node Invoking G++
1235 @section Compiling C++ Programs
1236
1237 @cindex suffixes for C++ source
1238 @cindex C++ source file suffixes
1239 C++ source files conventionally use one of the suffixes @samp{.C},
1240 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1241 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1242 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1243 files with these names and compiles them as C++ programs even if you
1244 call the compiler the same way as for compiling C programs (usually
1245 with the name @command{gcc}).
1246
1247 @findex g++
1248 @findex c++
1249 However, the use of @command{gcc} does not add the C++ library.
1250 @command{g++} is a program that calls GCC and treats @samp{.c},
1251 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1252 files unless @option{-x} is used, and automatically specifies linking
1253 against the C++ library.  This program is also useful when
1254 precompiling a C header file with a @samp{.h} extension for use in C++
1255 compilations.  On many systems, @command{g++} is also installed with
1256 the name @command{c++}.
1257
1258 @cindex invoking @command{g++}
1259 When you compile C++ programs, you may specify many of the same
1260 command-line options that you use for compiling programs in any
1261 language; or command-line options meaningful for C and related
1262 languages; or options that are meaningful only for C++ programs.
1263 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1264 explanations of options for languages related to C@.
1265 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1266 explanations of options that are meaningful only for C++ programs.
1267
1268 @node C Dialect Options
1269 @section Options Controlling C Dialect
1270 @cindex dialect options
1271 @cindex language dialect options
1272 @cindex options, dialect
1273
1274 The following options control the dialect of C (or languages derived
1275 from C, such as C++, Objective-C and Objective-C++) that the compiler
1276 accepts:
1277
1278 @table @gcctabopt
1279 @cindex ANSI support
1280 @cindex ISO support
1281 @item -ansi
1282 @opindex ansi
1283 In C mode, support all ISO C90 programs.  In C++ mode,
1284 remove GNU extensions that conflict with ISO C++.
1285
1286 This turns off certain features of GCC that are incompatible with ISO
1287 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1288 such as the @code{asm} and @code{typeof} keywords, and
1289 predefined macros such as @code{unix} and @code{vax} that identify the
1290 type of system you are using.  It also enables the undesirable and
1291 rarely used ISO trigraph feature.  For the C compiler,
1292 it disables recognition of C++ style @samp{//} comments as well as
1293 the @code{inline} keyword.
1294
1295 The alternate keywords @code{__asm__}, @code{__extension__},
1296 @code{__inline__} and @code{__typeof__} continue to work despite
1297 @option{-ansi}.  You would not want to use them in an ISO C program, of
1298 course, but it is useful to put them in header files that might be included
1299 in compilations done with @option{-ansi}.  Alternate predefined macros
1300 such as @code{__unix__} and @code{__vax__} are also available, with or
1301 without @option{-ansi}.
1302
1303 The @option{-ansi} option does not cause non-ISO programs to be
1304 rejected gratuitously.  For that, @option{-pedantic} is required in
1305 addition to @option{-ansi}.  @xref{Warning Options}.
1306
1307 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1308 option is used.  Some header files may notice this macro and refrain
1309 from declaring certain functions or defining certain macros that the
1310 ISO standard doesn't call for; this is to avoid interfering with any
1311 programs that might use these names for other things.
1312
1313 Functions which would normally be built in but do not have semantics
1314 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1315 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1316 built-in functions provided by GCC}, for details of the functions
1317 affected.
1318
1319 @item -std=
1320 @opindex std
1321 Determine the language standard.  This option is currently only
1322 supported when compiling C or C++.  A value for this option must be
1323 provided; possible values are
1324
1325 @table @samp
1326 @item c89
1327 @itemx iso9899:1990
1328 ISO C90 (same as @option{-ansi}).
1329
1330 @item iso9899:199409
1331 ISO C90 as modified in amendment 1.
1332
1333 @item c99
1334 @itemx c9x
1335 @itemx iso9899:1999
1336 @itemx iso9899:199x
1337 ISO C99.  Note that this standard is not yet fully supported; see
1338 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1339 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1340
1341 @item gnu89
1342 Default, ISO C90 plus GNU extensions (including some C99 features).
1343
1344 @item gnu99
1345 @itemx gnu9x
1346 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1347 this will become the default.  The name @samp{gnu9x} is deprecated.
1348
1349 @item c++98
1350 The 1998 ISO C++ standard plus amendments.
1351
1352 @item gnu++98
1353 The same as @option{-std=c++98} plus GNU extensions.  This is the
1354 default for C++ code.
1355
1356 @item c++0x
1357 The working draft of the upcoming ISO C++0x standard. This option
1358 enables experimental features that are likely to be included in
1359 C++0x. The working draft is constantly changing, and any feature that is
1360 enabled by this flag may be removed from future versions of GCC if it is
1361 not part of the C++0x standard.
1362
1363 @item gnu++0x
1364 The same as @option{-std=c++0x} plus GNU extensions. As with
1365 @option{-std=c++0x}, this option enables experimental features that may
1366 be removed in future versions of GCC.
1367 @end table
1368
1369 Even when this option is not specified, you can still use some of the
1370 features of newer standards in so far as they do not conflict with
1371 previous C standards.  For example, you may use @code{__restrict__} even
1372 when @option{-std=c99} is not specified.
1373
1374 The @option{-std} options specifying some version of ISO C have the same
1375 effects as @option{-ansi}, except that features that were not in ISO C90
1376 but are in the specified version (for example, @samp{//} comments and
1377 the @code{inline} keyword in ISO C99) are not disabled.
1378
1379 @xref{Standards,,Language Standards Supported by GCC}, for details of
1380 these standard versions.
1381
1382 @item -fgnu89-inline
1383 @opindex fgnu89-inline
1384 The option @option{-fgnu89-inline} tells GCC to use the traditional
1385 GNU semantics for @code{inline} functions when in C99 mode.
1386 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1387 is accepted and ignored by GCC versions 4.1.3 up to but not including
1388 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1389 C99 mode.  Using this option is roughly equivalent to adding the
1390 @code{gnu_inline} function attribute to all inline functions
1391 (@pxref{Function Attributes}).
1392
1393 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1394 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1395 specifies the default behavior).  This option was first supported in
1396 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1397
1398 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1399 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1400 in effect for @code{inline} functions.  @xref{Common Predefined
1401 Macros,,,cpp,The C Preprocessor}.
1402
1403 @item -aux-info @var{filename}
1404 @opindex aux-info
1405 Output to the given filename prototyped declarations for all functions
1406 declared and/or defined in a translation unit, including those in header
1407 files.  This option is silently ignored in any language other than C@.
1408
1409 Besides declarations, the file indicates, in comments, the origin of
1410 each declaration (source file and line), whether the declaration was
1411 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1412 @samp{O} for old, respectively, in the first character after the line
1413 number and the colon), and whether it came from a declaration or a
1414 definition (@samp{C} or @samp{F}, respectively, in the following
1415 character).  In the case of function definitions, a K&R-style list of
1416 arguments followed by their declarations is also provided, inside
1417 comments, after the declaration.
1418
1419 @item -fno-asm
1420 @opindex fno-asm
1421 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1422 keyword, so that code can use these words as identifiers.  You can use
1423 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1424 instead.  @option{-ansi} implies @option{-fno-asm}.
1425
1426 In C++, this switch only affects the @code{typeof} keyword, since
1427 @code{asm} and @code{inline} are standard keywords.  You may want to
1428 use the @option{-fno-gnu-keywords} flag instead, which has the same
1429 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1430 switch only affects the @code{asm} and @code{typeof} keywords, since
1431 @code{inline} is a standard keyword in ISO C99.
1432
1433 @item -fno-builtin
1434 @itemx -fno-builtin-@var{function}
1435 @opindex fno-builtin
1436 @cindex built-in functions
1437 Don't recognize built-in functions that do not begin with
1438 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1439 functions provided by GCC}, for details of the functions affected,
1440 including those which are not built-in functions when @option{-ansi} or
1441 @option{-std} options for strict ISO C conformance are used because they
1442 do not have an ISO standard meaning.
1443
1444 GCC normally generates special code to handle certain built-in functions
1445 more efficiently; for instance, calls to @code{alloca} may become single
1446 instructions that adjust the stack directly, and calls to @code{memcpy}
1447 may become inline copy loops.  The resulting code is often both smaller
1448 and faster, but since the function calls no longer appear as such, you
1449 cannot set a breakpoint on those calls, nor can you change the behavior
1450 of the functions by linking with a different library.  In addition,
1451 when a function is recognized as a built-in function, GCC may use
1452 information about that function to warn about problems with calls to
1453 that function, or to generate more efficient code, even if the
1454 resulting code still contains calls to that function.  For example,
1455 warnings are given with @option{-Wformat} for bad calls to
1456 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1457 known not to modify global memory.
1458
1459 With the @option{-fno-builtin-@var{function}} option
1460 only the built-in function @var{function} is
1461 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1462 function is named this is not built-in in this version of GCC, this
1463 option is ignored.  There is no corresponding
1464 @option{-fbuiltin-@var{function}} option; if you wish to enable
1465 built-in functions selectively when using @option{-fno-builtin} or
1466 @option{-ffreestanding}, you may define macros such as:
1467
1468 @smallexample
1469 #define abs(n)          __builtin_abs ((n))
1470 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1471 @end smallexample
1472
1473 @item -fhosted
1474 @opindex fhosted
1475 @cindex hosted environment
1476
1477 Assert that compilation takes place in a hosted environment.  This implies
1478 @option{-fbuiltin}.  A hosted environment is one in which the
1479 entire standard library is available, and in which @code{main} has a return
1480 type of @code{int}.  Examples are nearly everything except a kernel.
1481 This is equivalent to @option{-fno-freestanding}.
1482
1483 @item -ffreestanding
1484 @opindex ffreestanding
1485 @cindex hosted environment
1486
1487 Assert that compilation takes place in a freestanding environment.  This
1488 implies @option{-fno-builtin}.  A freestanding environment
1489 is one in which the standard library may not exist, and program startup may
1490 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1491 This is equivalent to @option{-fno-hosted}.
1492
1493 @xref{Standards,,Language Standards Supported by GCC}, for details of
1494 freestanding and hosted environments.
1495
1496 @item -fopenmp
1497 @opindex fopenmp
1498 @cindex openmp parallel
1499 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1500 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1501 compiler generates parallel code according to the OpenMP Application
1502 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1503
1504 @item -fms-extensions
1505 @opindex fms-extensions
1506 Accept some non-standard constructs used in Microsoft header files.
1507
1508 Some cases of unnamed fields in structures and unions are only
1509 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1510 fields within structs/unions}, for details.
1511
1512 @item -trigraphs
1513 @opindex trigraphs
1514 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1515 options for strict ISO C conformance) implies @option{-trigraphs}.
1516
1517 @item -no-integrated-cpp
1518 @opindex no-integrated-cpp
1519 Performs a compilation in two passes: preprocessing and compiling.  This
1520 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1521 @option{-B} option.  The user supplied compilation step can then add in
1522 an additional preprocessing step after normal preprocessing but before
1523 compiling.  The default is to use the integrated cpp (internal cpp)
1524
1525 The semantics of this option will change if "cc1", "cc1plus", and
1526 "cc1obj" are merged.
1527
1528 @cindex traditional C language
1529 @cindex C language, traditional
1530 @item -traditional
1531 @itemx -traditional-cpp
1532 @opindex traditional-cpp
1533 @opindex traditional
1534 Formerly, these options caused GCC to attempt to emulate a pre-standard
1535 C compiler.  They are now only supported with the @option{-E} switch.
1536 The preprocessor continues to support a pre-standard mode.  See the GNU
1537 CPP manual for details.
1538
1539 @item -fcond-mismatch
1540 @opindex fcond-mismatch
1541 Allow conditional expressions with mismatched types in the second and
1542 third arguments.  The value of such an expression is void.  This option
1543 is not supported for C++.
1544
1545 @item -flax-vector-conversions
1546 @opindex flax-vector-conversions
1547 Allow implicit conversions between vectors with differing numbers of
1548 elements and/or incompatible element types.  This option should not be
1549 used for new code.
1550
1551 @item -funsigned-char
1552 @opindex funsigned-char
1553 Let the type @code{char} be unsigned, like @code{unsigned char}.
1554
1555 Each kind of machine has a default for what @code{char} should
1556 be.  It is either like @code{unsigned char} by default or like
1557 @code{signed char} by default.
1558
1559 Ideally, a portable program should always use @code{signed char} or
1560 @code{unsigned char} when it depends on the signedness of an object.
1561 But many programs have been written to use plain @code{char} and
1562 expect it to be signed, or expect it to be unsigned, depending on the
1563 machines they were written for.  This option, and its inverse, let you
1564 make such a program work with the opposite default.
1565
1566 The type @code{char} is always a distinct type from each of
1567 @code{signed char} or @code{unsigned char}, even though its behavior
1568 is always just like one of those two.
1569
1570 @item -fsigned-char
1571 @opindex fsigned-char
1572 Let the type @code{char} be signed, like @code{signed char}.
1573
1574 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1575 the negative form of @option{-funsigned-char}.  Likewise, the option
1576 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1577
1578 @item -fsigned-bitfields
1579 @itemx -funsigned-bitfields
1580 @itemx -fno-signed-bitfields
1581 @itemx -fno-unsigned-bitfields
1582 @opindex fsigned-bitfields
1583 @opindex funsigned-bitfields
1584 @opindex fno-signed-bitfields
1585 @opindex fno-unsigned-bitfields
1586 These options control whether a bit-field is signed or unsigned, when the
1587 declaration does not use either @code{signed} or @code{unsigned}.  By
1588 default, such a bit-field is signed, because this is consistent: the
1589 basic integer types such as @code{int} are signed types.
1590 @end table
1591
1592 @node C++ Dialect Options
1593 @section Options Controlling C++ Dialect
1594
1595 @cindex compiler options, C++
1596 @cindex C++ options, command line
1597 @cindex options, C++
1598 This section describes the command-line options that are only meaningful
1599 for C++ programs; but you can also use most of the GNU compiler options
1600 regardless of what language your program is in.  For example, you
1601 might compile a file @code{firstClass.C} like this:
1602
1603 @smallexample
1604 g++ -g -frepo -O -c firstClass.C
1605 @end smallexample
1606
1607 @noindent
1608 In this example, only @option{-frepo} is an option meant
1609 only for C++ programs; you can use the other options with any
1610 language supported by GCC@.
1611
1612 Here is a list of options that are @emph{only} for compiling C++ programs:
1613
1614 @table @gcctabopt
1615
1616 @item -fabi-version=@var{n}
1617 @opindex fabi-version
1618 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1619 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1620 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1621 the version that conforms most closely to the C++ ABI specification.
1622 Therefore, the ABI obtained using version 0 will change as ABI bugs
1623 are fixed.
1624
1625 The default is version 2.
1626
1627 @item -fno-access-control
1628 @opindex fno-access-control
1629 Turn off all access checking.  This switch is mainly useful for working
1630 around bugs in the access control code.
1631
1632 @item -fcheck-new
1633 @opindex fcheck-new
1634 Check that the pointer returned by @code{operator new} is non-null
1635 before attempting to modify the storage allocated.  This check is
1636 normally unnecessary because the C++ standard specifies that
1637 @code{operator new} will only return @code{0} if it is declared
1638 @samp{throw()}, in which case the compiler will always check the
1639 return value even without this option.  In all other cases, when
1640 @code{operator new} has a non-empty exception specification, memory
1641 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1642 @samp{new (nothrow)}.
1643
1644 @item -fconserve-space
1645 @opindex fconserve-space
1646 Put uninitialized or runtime-initialized global variables into the
1647 common segment, as C does.  This saves space in the executable at the
1648 cost of not diagnosing duplicate definitions.  If you compile with this
1649 flag and your program mysteriously crashes after @code{main()} has
1650 completed, you may have an object that is being destroyed twice because
1651 two definitions were merged.
1652
1653 This option is no longer useful on most targets, now that support has
1654 been added for putting variables into BSS without making them common.
1655
1656 @item -ffriend-injection
1657 @opindex ffriend-injection
1658 Inject friend functions into the enclosing namespace, so that they are
1659 visible outside the scope of the class in which they are declared.
1660 Friend functions were documented to work this way in the old Annotated
1661 C++ Reference Manual, and versions of G++ before 4.1 always worked
1662 that way.  However, in ISO C++ a friend function which is not declared
1663 in an enclosing scope can only be found using argument dependent
1664 lookup.  This option causes friends to be injected as they were in
1665 earlier releases.
1666
1667 This option is for compatibility, and may be removed in a future
1668 release of G++.
1669
1670 @item -fno-elide-constructors
1671 @opindex fno-elide-constructors
1672 The C++ standard allows an implementation to omit creating a temporary
1673 which is only used to initialize another object of the same type.
1674 Specifying this option disables that optimization, and forces G++ to
1675 call the copy constructor in all cases.
1676
1677 @item -fno-enforce-eh-specs
1678 @opindex fno-enforce-eh-specs
1679 Don't generate code to check for violation of exception specifications
1680 at runtime.  This option violates the C++ standard, but may be useful
1681 for reducing code size in production builds, much like defining
1682 @samp{NDEBUG}.  This does not give user code permission to throw
1683 exceptions in violation of the exception specifications; the compiler
1684 will still optimize based on the specifications, so throwing an
1685 unexpected exception will result in undefined behavior.
1686
1687 @item -ffor-scope
1688 @itemx -fno-for-scope
1689 @opindex ffor-scope
1690 @opindex fno-for-scope
1691 If @option{-ffor-scope} is specified, the scope of variables declared in
1692 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1693 as specified by the C++ standard.
1694 If @option{-fno-for-scope} is specified, the scope of variables declared in
1695 a @i{for-init-statement} extends to the end of the enclosing scope,
1696 as was the case in old versions of G++, and other (traditional)
1697 implementations of C++.
1698
1699 The default if neither flag is given to follow the standard,
1700 but to allow and give a warning for old-style code that would
1701 otherwise be invalid, or have different behavior.
1702
1703 @item -fno-gnu-keywords
1704 @opindex fno-gnu-keywords
1705 Do not recognize @code{typeof} as a keyword, so that code can use this
1706 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1707 @option{-ansi} implies @option{-fno-gnu-keywords}.
1708
1709 @item -fno-implicit-templates
1710 @opindex fno-implicit-templates
1711 Never emit code for non-inline templates which are instantiated
1712 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1713 @xref{Template Instantiation}, for more information.
1714
1715 @item -fno-implicit-inline-templates
1716 @opindex fno-implicit-inline-templates
1717 Don't emit code for implicit instantiations of inline templates, either.
1718 The default is to handle inlines differently so that compiles with and
1719 without optimization will need the same set of explicit instantiations.
1720
1721 @item -fno-implement-inlines
1722 @opindex fno-implement-inlines
1723 To save space, do not emit out-of-line copies of inline functions
1724 controlled by @samp{#pragma implementation}.  This will cause linker
1725 errors if these functions are not inlined everywhere they are called.
1726
1727 @item -fms-extensions
1728 @opindex fms-extensions
1729 Disable pedantic warnings about constructs used in MFC, such as implicit
1730 int and getting a pointer to member function via non-standard syntax.
1731
1732 @item -fno-nonansi-builtins
1733 @opindex fno-nonansi-builtins
1734 Disable built-in declarations of functions that are not mandated by
1735 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1736 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1737
1738 @item -fno-operator-names
1739 @opindex fno-operator-names
1740 Do not treat the operator name keywords @code{and}, @code{bitand},
1741 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1742 synonyms as keywords.
1743
1744 @item -fno-optional-diags
1745 @opindex fno-optional-diags
1746 Disable diagnostics that the standard says a compiler does not need to
1747 issue.  Currently, the only such diagnostic issued by G++ is the one for
1748 a name having multiple meanings within a class.
1749
1750 @item -fpermissive
1751 @opindex fpermissive
1752 Downgrade some diagnostics about nonconformant code from errors to
1753 warnings.  Thus, using @option{-fpermissive} will allow some
1754 nonconforming code to compile.
1755
1756 @item -frepo
1757 @opindex frepo
1758 Enable automatic template instantiation at link time.  This option also
1759 implies @option{-fno-implicit-templates}.  @xref{Template
1760 Instantiation}, for more information.
1761
1762 @item -fno-rtti
1763 @opindex fno-rtti
1764 Disable generation of information about every class with virtual
1765 functions for use by the C++ runtime type identification features
1766 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1767 of the language, you can save some space by using this flag.  Note that
1768 exception handling uses the same information, but it will generate it as
1769 needed. The @samp{dynamic_cast} operator can still be used for casts that
1770 do not require runtime type information, i.e. casts to @code{void *} or to
1771 unambiguous base classes.
1772
1773 @item -fstats
1774 @opindex fstats
1775 Emit statistics about front-end processing at the end of the compilation.
1776 This information is generally only useful to the G++ development team.
1777
1778 @item -ftemplate-depth-@var{n}
1779 @opindex ftemplate-depth
1780 Set the maximum instantiation depth for template classes to @var{n}.
1781 A limit on the template instantiation depth is needed to detect
1782 endless recursions during template class instantiation.  ANSI/ISO C++
1783 conforming programs must not rely on a maximum depth greater than 17.
1784
1785 @item -fno-threadsafe-statics
1786 @opindex fno-threadsafe-statics
1787 Do not emit the extra code to use the routines specified in the C++
1788 ABI for thread-safe initialization of local statics.  You can use this
1789 option to reduce code size slightly in code that doesn't need to be
1790 thread-safe.
1791
1792 @item -fuse-cxa-atexit
1793 @opindex fuse-cxa-atexit
1794 Register destructors for objects with static storage duration with the
1795 @code{__cxa_atexit} function rather than the @code{atexit} function.
1796 This option is required for fully standards-compliant handling of static
1797 destructors, but will only work if your C library supports
1798 @code{__cxa_atexit}.
1799
1800 @item -fno-use-cxa-get-exception-ptr
1801 @opindex fno-use-cxa-get-exception-ptr
1802 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1803 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1804 if the runtime routine is not available.
1805
1806 @item -fvisibility-inlines-hidden
1807 @opindex fvisibility-inlines-hidden
1808 This switch declares that the user does not attempt to compare
1809 pointers to inline methods where the addresses of the two functions
1810 were taken in different shared objects.
1811
1812 The effect of this is that GCC may, effectively, mark inline methods with
1813 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1814 appear in the export table of a DSO and do not require a PLT indirection
1815 when used within the DSO@.  Enabling this option can have a dramatic effect
1816 on load and link times of a DSO as it massively reduces the size of the
1817 dynamic export table when the library makes heavy use of templates.
1818
1819 The behavior of this switch is not quite the same as marking the
1820 methods as hidden directly, because it does not affect static variables
1821 local to the function or cause the compiler to deduce that
1822 the function is defined in only one shared object.
1823
1824 You may mark a method as having a visibility explicitly to negate the
1825 effect of the switch for that method.  For example, if you do want to
1826 compare pointers to a particular inline method, you might mark it as
1827 having default visibility.  Marking the enclosing class with explicit
1828 visibility will have no effect.
1829
1830 Explicitly instantiated inline methods are unaffected by this option
1831 as their linkage might otherwise cross a shared library boundary.
1832 @xref{Template Instantiation}.
1833
1834 @item -fvisibility-ms-compat
1835 @opindex fvisibility-ms-compat
1836 This flag attempts to use visibility settings to make GCC's C++
1837 linkage model compatible with that of Microsoft Visual Studio.
1838
1839 The flag makes these changes to GCC's linkage model:
1840
1841 @enumerate
1842 @item
1843 It sets the default visibility to @code{hidden}, like
1844 @option{-fvisibility=hidden}.
1845
1846 @item
1847 Types, but not their members, are not hidden by default.
1848
1849 @item
1850 The One Definition Rule is relaxed for types without explicit
1851 visibility specifications which are defined in more than one different
1852 shared object: those declarations are permitted if they would have
1853 been permitted when this option was not used.
1854 @end enumerate
1855
1856 In new code it is better to use @option{-fvisibility=hidden} and
1857 export those classes which are intended to be externally visible.
1858 Unfortunately it is possible for code to rely, perhaps accidentally,
1859 on the Visual Studio behaviour.
1860
1861 Among the consequences of these changes are that static data members
1862 of the same type with the same name but defined in different shared
1863 objects will be different, so changing one will not change the other;
1864 and that pointers to function members defined in different shared
1865 objects may not compare equal.  When this flag is given, it is a
1866 violation of the ODR to define types with the same name differently.
1867
1868 @item -fno-weak
1869 @opindex fno-weak
1870 Do not use weak symbol support, even if it is provided by the linker.
1871 By default, G++ will use weak symbols if they are available.  This
1872 option exists only for testing, and should not be used by end-users;
1873 it will result in inferior code and has no benefits.  This option may
1874 be removed in a future release of G++.
1875
1876 @item -nostdinc++
1877 @opindex nostdinc++
1878 Do not search for header files in the standard directories specific to
1879 C++, but do still search the other standard directories.  (This option
1880 is used when building the C++ library.)
1881 @end table
1882
1883 In addition, these optimization, warning, and code generation options
1884 have meanings only for C++ programs:
1885
1886 @table @gcctabopt
1887 @item -fno-default-inline
1888 @opindex fno-default-inline
1889 Do not assume @samp{inline} for functions defined inside a class scope.
1890 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1891 functions will have linkage like inline functions; they just won't be
1892 inlined by default.
1893
1894 @item -Wabi @r{(C++ only)}
1895 @opindex Wabi
1896 Warn when G++ generates code that is probably not compatible with the
1897 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1898 all such cases, there are probably some cases that are not warned about,
1899 even though G++ is generating incompatible code.  There may also be
1900 cases where warnings are emitted even though the code that is generated
1901 will be compatible.
1902
1903 You should rewrite your code to avoid these warnings if you are
1904 concerned about the fact that code generated by G++ may not be binary
1905 compatible with code generated by other compilers.
1906
1907 The known incompatibilities at this point include:
1908
1909 @itemize @bullet
1910
1911 @item
1912 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1913 pack data into the same byte as a base class.  For example:
1914
1915 @smallexample
1916 struct A @{ virtual void f(); int f1 : 1; @};
1917 struct B : public A @{ int f2 : 1; @};
1918 @end smallexample
1919
1920 @noindent
1921 In this case, G++ will place @code{B::f2} into the same byte
1922 as@code{A::f1}; other compilers will not.  You can avoid this problem
1923 by explicitly padding @code{A} so that its size is a multiple of the
1924 byte size on your platform; that will cause G++ and other compilers to
1925 layout @code{B} identically.
1926
1927 @item
1928 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1929 tail padding when laying out virtual bases.  For example:
1930
1931 @smallexample
1932 struct A @{ virtual void f(); char c1; @};
1933 struct B @{ B(); char c2; @};
1934 struct C : public A, public virtual B @{@};
1935 @end smallexample
1936
1937 @noindent
1938 In this case, G++ will not place @code{B} into the tail-padding for
1939 @code{A}; other compilers will.  You can avoid this problem by
1940 explicitly padding @code{A} so that its size is a multiple of its
1941 alignment (ignoring virtual base classes); that will cause G++ and other
1942 compilers to layout @code{C} identically.
1943
1944 @item
1945 Incorrect handling of bit-fields with declared widths greater than that
1946 of their underlying types, when the bit-fields appear in a union.  For
1947 example:
1948
1949 @smallexample
1950 union U @{ int i : 4096; @};
1951 @end smallexample
1952
1953 @noindent
1954 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1955 union too small by the number of bits in an @code{int}.
1956
1957 @item
1958 Empty classes can be placed at incorrect offsets.  For example:
1959
1960 @smallexample
1961 struct A @{@};
1962
1963 struct B @{
1964   A a;
1965   virtual void f ();
1966 @};
1967
1968 struct C : public B, public A @{@};
1969 @end smallexample
1970
1971 @noindent
1972 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1973 it should be placed at offset zero.  G++ mistakenly believes that the
1974 @code{A} data member of @code{B} is already at offset zero.
1975
1976 @item
1977 Names of template functions whose types involve @code{typename} or
1978 template template parameters can be mangled incorrectly.
1979
1980 @smallexample
1981 template <typename Q>
1982 void f(typename Q::X) @{@}
1983
1984 template <template <typename> class Q>
1985 void f(typename Q<int>::X) @{@}
1986 @end smallexample
1987
1988 @noindent
1989 Instantiations of these templates may be mangled incorrectly.
1990
1991 @end itemize
1992
1993 @item -Wctor-dtor-privacy @r{(C++ only)}
1994 @opindex Wctor-dtor-privacy
1995 Warn when a class seems unusable because all the constructors or
1996 destructors in that class are private, and it has neither friends nor
1997 public static member functions.
1998
1999 @item -Wnon-virtual-dtor @r{(C++ only)}
2000 @opindex Wnon-virtual-dtor
2001 Warn when a class appears to be polymorphic, thereby requiring a virtual
2002 destructor, yet it declares a non-virtual one.  This warning is also
2003 enabled if -Weffc++ is specified.
2004
2005 @item -Wreorder @r{(C++ only)}
2006 @opindex Wreorder
2007 @cindex reordering, warning
2008 @cindex warning for reordering of member initializers
2009 Warn when the order of member initializers given in the code does not
2010 match the order in which they must be executed.  For instance:
2011
2012 @smallexample
2013 struct A @{
2014   int i;
2015   int j;
2016   A(): j (0), i (1) @{ @}
2017 @};
2018 @end smallexample
2019
2020 The compiler will rearrange the member initializers for @samp{i}
2021 and @samp{j} to match the declaration order of the members, emitting
2022 a warning to that effect.  This warning is enabled by @option{-Wall}.
2023 @end table
2024
2025 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2026
2027 @table @gcctabopt
2028 @item -Weffc++ @r{(C++ only)}
2029 @opindex Weffc++
2030 Warn about violations of the following style guidelines from Scott Meyers'
2031 @cite{Effective C++} book:
2032
2033 @itemize @bullet
2034 @item
2035 Item 11:  Define a copy constructor and an assignment operator for classes
2036 with dynamically allocated memory.
2037
2038 @item
2039 Item 12:  Prefer initialization to assignment in constructors.
2040
2041 @item
2042 Item 14:  Make destructors virtual in base classes.
2043
2044 @item
2045 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2046
2047 @item
2048 Item 23:  Don't try to return a reference when you must return an object.
2049
2050 @end itemize
2051
2052 Also warn about violations of the following style guidelines from
2053 Scott Meyers' @cite{More Effective C++} book:
2054
2055 @itemize @bullet
2056 @item
2057 Item 6:  Distinguish between prefix and postfix forms of increment and
2058 decrement operators.
2059
2060 @item
2061 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2062
2063 @end itemize
2064
2065 When selecting this option, be aware that the standard library
2066 headers do not obey all of these guidelines; use @samp{grep -v}
2067 to filter out those warnings.
2068
2069 @item -Wno-deprecated @r{(C++ only)}
2070 @opindex Wno-deprecated
2071 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
2072
2073 @item -Wstrict-null-sentinel @r{(C++ only)}
2074 @opindex Wstrict-null-sentinel
2075 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2076 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2077 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2078 it is guaranteed to of the same size as a pointer.  But this use is
2079 not portable across different compilers.
2080
2081 @item -Wno-non-template-friend @r{(C++ only)}
2082 @opindex Wno-non-template-friend
2083 Disable warnings when non-templatized friend functions are declared
2084 within a template.  Since the advent of explicit template specification
2085 support in G++, if the name of the friend is an unqualified-id (i.e.,
2086 @samp{friend foo(int)}), the C++ language specification demands that the
2087 friend declare or define an ordinary, nontemplate function.  (Section
2088 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2089 could be interpreted as a particular specialization of a templatized
2090 function.  Because this non-conforming behavior is no longer the default
2091 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2092 check existing code for potential trouble spots and is on by default.
2093 This new compiler behavior can be turned off with
2094 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2095 but disables the helpful warning.
2096
2097 @item -Wold-style-cast @r{(C++ only)}
2098 @opindex Wold-style-cast
2099 Warn if an old-style (C-style) cast to a non-void type is used within
2100 a C++ program.  The new-style casts (@samp{dynamic_cast},
2101 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2102 less vulnerable to unintended effects and much easier to search for.
2103
2104 @item -Woverloaded-virtual @r{(C++ only)}
2105 @opindex Woverloaded-virtual
2106 @cindex overloaded virtual fn, warning
2107 @cindex warning for overloaded virtual fn
2108 Warn when a function declaration hides virtual functions from a
2109 base class.  For example, in:
2110
2111 @smallexample
2112 struct A @{
2113   virtual void f();
2114 @};
2115
2116 struct B: public A @{
2117   void f(int);
2118 @};
2119 @end smallexample
2120
2121 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2122 like:
2123
2124 @smallexample
2125 B* b;
2126 b->f();
2127 @end smallexample
2128
2129 will fail to compile.
2130
2131 @item -Wno-pmf-conversions @r{(C++ only)}
2132 @opindex Wno-pmf-conversions
2133 Disable the diagnostic for converting a bound pointer to member function
2134 to a plain pointer.
2135
2136 @item -Wsign-promo @r{(C++ only)}
2137 @opindex Wsign-promo
2138 Warn when overload resolution chooses a promotion from unsigned or
2139 enumerated type to a signed type, over a conversion to an unsigned type of
2140 the same size.  Previous versions of G++ would try to preserve
2141 unsignedness, but the standard mandates the current behavior.
2142
2143 @smallexample
2144 struct A @{
2145   operator int ();
2146   A& operator = (int);
2147 @};
2148
2149 main ()
2150 @{
2151   A a,b;
2152   a = b;
2153 @}
2154 @end smallexample
2155
2156 In this example, G++ will synthesize a default @samp{A& operator =
2157 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2158 @end table
2159
2160 @node Objective-C and Objective-C++ Dialect Options
2161 @section Options Controlling Objective-C and Objective-C++ Dialects
2162
2163 @cindex compiler options, Objective-C and Objective-C++
2164 @cindex Objective-C and Objective-C++ options, command line
2165 @cindex options, Objective-C and Objective-C++
2166 (NOTE: This manual does not describe the Objective-C and Objective-C++
2167 languages themselves.  See @xref{Standards,,Language Standards
2168 Supported by GCC}, for references.)
2169
2170 This section describes the command-line options that are only meaningful
2171 for Objective-C and Objective-C++ programs, but you can also use most of
2172 the language-independent GNU compiler options.
2173 For example, you might compile a file @code{some_class.m} like this:
2174
2175 @smallexample
2176 gcc -g -fgnu-runtime -O -c some_class.m
2177 @end smallexample
2178
2179 @noindent
2180 In this example, @option{-fgnu-runtime} is an option meant only for
2181 Objective-C and Objective-C++ programs; you can use the other options with
2182 any language supported by GCC@.
2183
2184 Note that since Objective-C is an extension of the C language, Objective-C
2185 compilations may also use options specific to the C front-end (e.g.,
2186 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2187 C++-specific options (e.g., @option{-Wabi}).
2188
2189 Here is a list of options that are @emph{only} for compiling Objective-C
2190 and Objective-C++ programs:
2191
2192 @table @gcctabopt
2193 @item -fconstant-string-class=@var{class-name}
2194 @opindex fconstant-string-class
2195 Use @var{class-name} as the name of the class to instantiate for each
2196 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2197 class name is @code{NXConstantString} if the GNU runtime is being used, and
2198 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2199 @option{-fconstant-cfstrings} option, if also present, will override the
2200 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2201 to be laid out as constant CoreFoundation strings.
2202
2203 @item -fgnu-runtime
2204 @opindex fgnu-runtime
2205 Generate object code compatible with the standard GNU Objective-C
2206 runtime.  This is the default for most types of systems.
2207
2208 @item -fnext-runtime
2209 @opindex fnext-runtime
2210 Generate output compatible with the NeXT runtime.  This is the default
2211 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2212 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2213 used.
2214
2215 @item -fno-nil-receivers
2216 @opindex fno-nil-receivers
2217 Assume that all Objective-C message dispatches (e.g.,
2218 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2219 is not @code{nil}.  This allows for more efficient entry points in the runtime
2220 to be used.  Currently, this option is only available in conjunction with
2221 the NeXT runtime on Mac OS X 10.3 and later.
2222
2223 @item -fobjc-call-cxx-cdtors
2224 @opindex fobjc-call-cxx-cdtors
2225 For each Objective-C class, check if any of its instance variables is a
2226 C++ object with a non-trivial default constructor.  If so, synthesize a
2227 special @code{- (id) .cxx_construct} instance method that will run
2228 non-trivial default constructors on any such instance variables, in order,
2229 and then return @code{self}.  Similarly, check if any instance variable
2230 is a C++ object with a non-trivial destructor, and if so, synthesize a
2231 special @code{- (void) .cxx_destruct} method that will run
2232 all such default destructors, in reverse order.
2233
2234 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2235 thusly generated will only operate on instance variables declared in the
2236 current Objective-C class, and not those inherited from superclasses.  It
2237 is the responsibility of the Objective-C runtime to invoke all such methods
2238 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2239 will be invoked by the runtime immediately after a new object
2240 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2241 be invoked immediately before the runtime deallocates an object instance.
2242
2243 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2244 support for invoking the @code{- (id) .cxx_construct} and
2245 @code{- (void) .cxx_destruct} methods.
2246
2247 @item -fobjc-direct-dispatch
2248 @opindex fobjc-direct-dispatch
2249 Allow fast jumps to the message dispatcher.  On Darwin this is
2250 accomplished via the comm page.
2251
2252 @item -fobjc-exceptions
2253 @opindex fobjc-exceptions
2254 Enable syntactic support for structured exception handling in Objective-C,
2255 similar to what is offered by C++ and Java.  This option is
2256 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2257 earlier.
2258
2259 @smallexample
2260   @@try @{
2261     @dots{}
2262        @@throw expr;
2263     @dots{}
2264   @}
2265   @@catch (AnObjCClass *exc) @{
2266     @dots{}
2267       @@throw expr;
2268     @dots{}
2269       @@throw;
2270     @dots{}
2271   @}
2272   @@catch (AnotherClass *exc) @{
2273     @dots{}
2274   @}
2275   @@catch (id allOthers) @{
2276     @dots{}
2277   @}
2278   @@finally @{
2279     @dots{}
2280       @@throw expr;
2281     @dots{}
2282   @}
2283 @end smallexample
2284
2285 The @code{@@throw} statement may appear anywhere in an Objective-C or
2286 Objective-C++ program; when used inside of a @code{@@catch} block, the
2287 @code{@@throw} may appear without an argument (as shown above), in which case
2288 the object caught by the @code{@@catch} will be rethrown.
2289
2290 Note that only (pointers to) Objective-C objects may be thrown and
2291 caught using this scheme.  When an object is thrown, it will be caught
2292 by the nearest @code{@@catch} clause capable of handling objects of that type,
2293 analogously to how @code{catch} blocks work in C++ and Java.  A
2294 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2295 any and all Objective-C exceptions not caught by previous @code{@@catch}
2296 clauses (if any).
2297
2298 The @code{@@finally} clause, if present, will be executed upon exit from the
2299 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2300 regardless of whether any exceptions are thrown, caught or rethrown
2301 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2302 of the @code{finally} clause in Java.
2303
2304 There are several caveats to using the new exception mechanism:
2305
2306 @itemize @bullet
2307 @item
2308 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2309 idioms provided by the @code{NSException} class, the new
2310 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2311 systems, due to additional functionality needed in the (NeXT) Objective-C
2312 runtime.
2313
2314 @item
2315 As mentioned above, the new exceptions do not support handling
2316 types other than Objective-C objects.   Furthermore, when used from
2317 Objective-C++, the Objective-C exception model does not interoperate with C++
2318 exceptions at this time.  This means you cannot @code{@@throw} an exception
2319 from Objective-C and @code{catch} it in C++, or vice versa
2320 (i.e., @code{throw @dots{} @@catch}).
2321 @end itemize
2322
2323 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2324 blocks for thread-safe execution:
2325
2326 @smallexample
2327   @@synchronized (ObjCClass *guard) @{
2328     @dots{}
2329   @}
2330 @end smallexample
2331
2332 Upon entering the @code{@@synchronized} block, a thread of execution shall
2333 first check whether a lock has been placed on the corresponding @code{guard}
2334 object by another thread.  If it has, the current thread shall wait until
2335 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2336 the current thread will place its own lock on it, execute the code contained in
2337 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2338 making @code{guard} available to other threads).
2339
2340 Unlike Java, Objective-C does not allow for entire methods to be marked
2341 @code{@@synchronized}.  Note that throwing exceptions out of
2342 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2343 to be unlocked properly.
2344
2345 @item -fobjc-gc
2346 @opindex fobjc-gc
2347 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2348
2349 @item -freplace-objc-classes
2350 @opindex freplace-objc-classes
2351 Emit a special marker instructing @command{ld(1)} not to statically link in
2352 the resulting object file, and allow @command{dyld(1)} to load it in at
2353 run time instead.  This is used in conjunction with the Fix-and-Continue
2354 debugging mode, where the object file in question may be recompiled and
2355 dynamically reloaded in the course of program execution, without the need
2356 to restart the program itself.  Currently, Fix-and-Continue functionality
2357 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2358 and later.
2359
2360 @item -fzero-link
2361 @opindex fzero-link
2362 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2363 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2364 compile time) with static class references that get initialized at load time,
2365 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2366 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2367 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2368 for individual class implementations to be modified during program execution.
2369
2370 @item -gen-decls
2371 @opindex gen-decls
2372 Dump interface declarations for all classes seen in the source file to a
2373 file named @file{@var{sourcename}.decl}.
2374
2375 @item -Wassign-intercept
2376 @opindex Wassign-intercept
2377 Warn whenever an Objective-C assignment is being intercepted by the
2378 garbage collector.
2379
2380 @item -Wno-protocol
2381 @opindex Wno-protocol
2382 If a class is declared to implement a protocol, a warning is issued for
2383 every method in the protocol that is not implemented by the class.  The
2384 default behavior is to issue a warning for every method not explicitly
2385 implemented in the class, even if a method implementation is inherited
2386 from the superclass.  If you use the @option{-Wno-protocol} option, then
2387 methods inherited from the superclass are considered to be implemented,
2388 and no warning is issued for them.
2389
2390 @item -Wselector
2391 @opindex Wselector
2392 Warn if multiple methods of different types for the same selector are
2393 found during compilation.  The check is performed on the list of methods
2394 in the final stage of compilation.  Additionally, a check is performed
2395 for each selector appearing in a @code{@@selector(@dots{})}
2396 expression, and a corresponding method for that selector has been found
2397 during compilation.  Because these checks scan the method table only at
2398 the end of compilation, these warnings are not produced if the final
2399 stage of compilation is not reached, for example because an error is
2400 found during compilation, or because the @option{-fsyntax-only} option is
2401 being used.
2402
2403 @item -Wstrict-selector-match
2404 @opindex Wstrict-selector-match
2405 Warn if multiple methods with differing argument and/or return types are
2406 found for a given selector when attempting to send a message using this
2407 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2408 is off (which is the default behavior), the compiler will omit such warnings
2409 if any differences found are confined to types which share the same size
2410 and alignment.
2411
2412 @item -Wundeclared-selector
2413 @opindex Wundeclared-selector
2414 Warn if a @code{@@selector(@dots{})} expression referring to an
2415 undeclared selector is found.  A selector is considered undeclared if no
2416 method with that name has been declared before the
2417 @code{@@selector(@dots{})} expression, either explicitly in an
2418 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2419 an @code{@@implementation} section.  This option always performs its
2420 checks as soon as a @code{@@selector(@dots{})} expression is found,
2421 while @option{-Wselector} only performs its checks in the final stage of
2422 compilation.  This also enforces the coding style convention
2423 that methods and selectors must be declared before being used.
2424
2425 @item -print-objc-runtime-info
2426 @opindex print-objc-runtime-info
2427 Generate C header describing the largest structure that is passed by
2428 value, if any.
2429
2430 @end table
2431
2432 @node Language Independent Options
2433 @section Options to Control Diagnostic Messages Formatting
2434 @cindex options to control diagnostics formatting
2435 @cindex diagnostic messages
2436 @cindex message formatting
2437
2438 Traditionally, diagnostic messages have been formatted irrespective of
2439 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2440 below can be used to control the diagnostic messages formatting
2441 algorithm, e.g.@: how many characters per line, how often source location
2442 information should be reported.  Right now, only the C++ front end can
2443 honor these options.  However it is expected, in the near future, that
2444 the remaining front ends would be able to digest them correctly.
2445
2446 @table @gcctabopt
2447 @item -fmessage-length=@var{n}
2448 @opindex fmessage-length
2449 Try to format error messages so that they fit on lines of about @var{n}
2450 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2451 the front ends supported by GCC@.  If @var{n} is zero, then no
2452 line-wrapping will be done; each error message will appear on a single
2453 line.
2454
2455 @opindex fdiagnostics-show-location
2456 @item -fdiagnostics-show-location=once
2457 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2458 reporter to emit @emph{once} source location information; that is, in
2459 case the message is too long to fit on a single physical line and has to
2460 be wrapped, the source location won't be emitted (as prefix) again,
2461 over and over, in subsequent continuation lines.  This is the default
2462 behavior.
2463
2464 @item -fdiagnostics-show-location=every-line
2465 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2466 messages reporter to emit the same source location information (as
2467 prefix) for physical lines that result from the process of breaking
2468 a message which is too long to fit on a single line.
2469
2470 @item -fdiagnostics-show-option
2471 @opindex fdiagnostics-show-option
2472 This option instructs the diagnostic machinery to add text to each
2473 diagnostic emitted, which indicates which command line option directly
2474 controls that diagnostic, when such an option is known to the
2475 diagnostic machinery.
2476
2477 @item -Wcoverage-mismatch
2478 @opindex Wcoverage-mismatch
2479 Warn if feedback profiles do not match when using the
2480 @option{-fprofile-use} option.
2481 If a source file was changed between @option{-fprofile-gen} and
2482 @option{-fprofile-use}, the files with the profile feedback can fail
2483 to match the source file and GCC can not use the profile feedback
2484 information.  By default, GCC emits an error message in this case.
2485 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2486 error.  GCC does not use appropriate feedback profiles, so using this
2487 option can result in poorly optimized code.  This option is useful
2488 only in the case of very minor changes such as bug fixes to an
2489 existing code-base.
2490
2491 @end table
2492
2493 @node Warning Options
2494 @section Options to Request or Suppress Warnings
2495 @cindex options to control warnings
2496 @cindex warning messages
2497 @cindex messages, warning
2498 @cindex suppressing warnings
2499
2500 Warnings are diagnostic messages that report constructions which
2501 are not inherently erroneous but which are risky or suggest there
2502 may have been an error.
2503
2504 You can request many specific warnings with options beginning @samp{-W},
2505 for example @option{-Wimplicit} to request warnings on implicit
2506 declarations.  Each of these specific warning options also has a
2507 negative form beginning @samp{-Wno-} to turn off warnings;
2508 for example, @option{-Wno-implicit}.  This manual lists only one of the
2509 two forms, whichever is not the default.
2510
2511 The following options control the amount and kinds of warnings produced
2512 by GCC; for further, language-specific options also refer to
2513 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2514 Options}.
2515
2516 @table @gcctabopt
2517 @cindex syntax checking
2518 @item -fsyntax-only
2519 @opindex fsyntax-only
2520 Check the code for syntax errors, but don't do anything beyond that.
2521
2522 @item -pedantic
2523 @opindex pedantic
2524 Issue all the warnings demanded by strict ISO C and ISO C++;
2525 reject all programs that use forbidden extensions, and some other
2526 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2527 version of the ISO C standard specified by any @option{-std} option used.
2528
2529 Valid ISO C and ISO C++ programs should compile properly with or without
2530 this option (though a rare few will require @option{-ansi} or a
2531 @option{-std} option specifying the required version of ISO C)@.  However,
2532 without this option, certain GNU extensions and traditional C and C++
2533 features are supported as well.  With this option, they are rejected.
2534
2535 @option{-pedantic} does not cause warning messages for use of the
2536 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2537 warnings are also disabled in the expression that follows
2538 @code{__extension__}.  However, only system header files should use
2539 these escape routes; application programs should avoid them.
2540 @xref{Alternate Keywords}.
2541
2542 Some users try to use @option{-pedantic} to check programs for strict ISO
2543 C conformance.  They soon find that it does not do quite what they want:
2544 it finds some non-ISO practices, but not all---only those for which
2545 ISO C @emph{requires} a diagnostic, and some others for which
2546 diagnostics have been added.
2547
2548 A feature to report any failure to conform to ISO C might be useful in
2549 some instances, but would require considerable additional work and would
2550 be quite different from @option{-pedantic}.  We don't have plans to
2551 support such a feature in the near future.
2552
2553 Where the standard specified with @option{-std} represents a GNU
2554 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2555 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2556 extended dialect is based.  Warnings from @option{-pedantic} are given
2557 where they are required by the base standard.  (It would not make sense
2558 for such warnings to be given only for features not in the specified GNU
2559 C dialect, since by definition the GNU dialects of C include all
2560 features the compiler supports with the given option, and there would be
2561 nothing to warn about.)
2562
2563 @item -pedantic-errors
2564 @opindex pedantic-errors
2565 Like @option{-pedantic}, except that errors are produced rather than
2566 warnings.
2567
2568 @item -w
2569 @opindex w
2570 Inhibit all warning messages.
2571
2572 @item -Wno-import
2573 @opindex Wno-import
2574 Inhibit warning messages about the use of @samp{#import}.
2575
2576 @item -Wchar-subscripts
2577 @opindex Wchar-subscripts
2578 Warn if an array subscript has type @code{char}.  This is a common cause
2579 of error, as programmers often forget that this type is signed on some
2580 machines.
2581 This warning is enabled by @option{-Wall}.
2582
2583 @item -Wcomment
2584 @opindex Wcomment
2585 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2586 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2587 This warning is enabled by @option{-Wall}.
2588
2589 @item -Wfatal-errors
2590 @opindex Wfatal-errors
2591 This option causes the compiler to abort compilation on the first error
2592 occurred rather than trying to keep going and printing further error
2593 messages.
2594
2595 @item -Wformat
2596 @opindex Wformat
2597 @opindex ffreestanding
2598 @opindex fno-builtin
2599 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2600 the arguments supplied have types appropriate to the format string
2601 specified, and that the conversions specified in the format string make
2602 sense.  This includes standard functions, and others specified by format
2603 attributes (@pxref{Function Attributes}), in the @code{printf},
2604 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2605 not in the C standard) families (or other target-specific families).
2606 Which functions are checked without format attributes having been
2607 specified depends on the standard version selected, and such checks of
2608 functions without the attribute specified are disabled by
2609 @option{-ffreestanding} or @option{-fno-builtin}.
2610
2611 The formats are checked against the format features supported by GNU
2612 libc version 2.2.  These include all ISO C90 and C99 features, as well
2613 as features from the Single Unix Specification and some BSD and GNU
2614 extensions.  Other library implementations may not support all these
2615 features; GCC does not support warning about features that go beyond a
2616 particular library's limitations.  However, if @option{-pedantic} is used
2617 with @option{-Wformat}, warnings will be given about format features not
2618 in the selected standard version (but not for @code{strfmon} formats,
2619 since those are not in any version of the C standard).  @xref{C Dialect
2620 Options,,Options Controlling C Dialect}.
2621
2622 Since @option{-Wformat} also checks for null format arguments for
2623 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2624
2625 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2626 aspects of format checking, the options @option{-Wformat-y2k},
2627 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2628 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2629 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2630
2631 @item -Wformat-y2k
2632 @opindex Wformat-y2k
2633 If @option{-Wformat} is specified, also warn about @code{strftime}
2634 formats which may yield only a two-digit year.
2635
2636 @item -Wno-format-extra-args
2637 @opindex Wno-format-extra-args
2638 If @option{-Wformat} is specified, do not warn about excess arguments to a
2639 @code{printf} or @code{scanf} format function.  The C standard specifies
2640 that such arguments are ignored.
2641
2642 Where the unused arguments lie between used arguments that are
2643 specified with @samp{$} operand number specifications, normally
2644 warnings are still given, since the implementation could not know what
2645 type to pass to @code{va_arg} to skip the unused arguments.  However,
2646 in the case of @code{scanf} formats, this option will suppress the
2647 warning if the unused arguments are all pointers, since the Single
2648 Unix Specification says that such unused arguments are allowed.
2649
2650 @item -Wno-format-zero-length
2651 @opindex Wno-format-zero-length
2652 If @option{-Wformat} is specified, do not warn about zero-length formats.
2653 The C standard specifies that zero-length formats are allowed.
2654
2655 @item -Wformat-nonliteral
2656 @opindex Wformat-nonliteral
2657 If @option{-Wformat} is specified, also warn if the format string is not a
2658 string literal and so cannot be checked, unless the format function
2659 takes its format arguments as a @code{va_list}.
2660
2661 @item -Wformat-security
2662 @opindex Wformat-security
2663 If @option{-Wformat} is specified, also warn about uses of format
2664 functions that represent possible security problems.  At present, this
2665 warns about calls to @code{printf} and @code{scanf} functions where the
2666 format string is not a string literal and there are no format arguments,
2667 as in @code{printf (foo);}.  This may be a security hole if the format
2668 string came from untrusted input and contains @samp{%n}.  (This is
2669 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2670 in future warnings may be added to @option{-Wformat-security} that are not
2671 included in @option{-Wformat-nonliteral}.)
2672
2673 @item -Wformat=2
2674 @opindex Wformat=2
2675 Enable @option{-Wformat} plus format checks not included in
2676 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2677 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2678
2679 @item -Wnonnull
2680 @opindex Wnonnull
2681 Warn about passing a null pointer for arguments marked as
2682 requiring a non-null value by the @code{nonnull} function attribute.
2683
2684 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2685 can be disabled with the @option{-Wno-nonnull} option.
2686
2687 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2688 @opindex Winit-self
2689 Warn about uninitialized variables which are initialized with themselves.
2690 Note this option can only be used with the @option{-Wuninitialized} option,
2691 which in turn only works with @option{-O1} and above.
2692
2693 For example, GCC will warn about @code{i} being uninitialized in the
2694 following snippet only when @option{-Winit-self} has been specified:
2695 @smallexample
2696 @group
2697 int f()
2698 @{
2699   int i = i;
2700   return i;
2701 @}
2702 @end group
2703 @end smallexample
2704
2705 @item -Wimplicit-int
2706 @opindex Wimplicit-int
2707 Warn when a declaration does not specify a type.
2708 This warning is enabled by @option{-Wall}.
2709
2710 @item -Wimplicit-function-declaration
2711 @opindex Wimplicit-function-declaration
2712 @opindex Wno-implicit-function-declaration
2713 Give a warning whenever a function is used before being declared. In
2714 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2715 enabled by default and it is made into an error by
2716 @option{-pedantic-errors}. This warning is also enabled by
2717 @option{-Wall}.
2718
2719 @item -Wimplicit
2720 @opindex Wimplicit
2721 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2722 This warning is enabled by @option{-Wall}.
2723
2724 @item -Wmain
2725 @opindex Wmain
2726 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2727 function with external linkage, returning int, taking either zero
2728 arguments, two, or three arguments of appropriate types.
2729 This warning is enabled by @option{-Wall}.
2730
2731 @item -Wmissing-braces
2732 @opindex Wmissing-braces
2733 Warn if an aggregate or union initializer is not fully bracketed.  In
2734 the following example, the initializer for @samp{a} is not fully
2735 bracketed, but that for @samp{b} is fully bracketed.
2736
2737 @smallexample
2738 int a[2][2] = @{ 0, 1, 2, 3 @};
2739 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2740 @end smallexample
2741
2742 This warning is enabled by @option{-Wall}.
2743
2744 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2745 @opindex Wmissing-include-dirs
2746 Warn if a user-supplied include directory does not exist.
2747
2748 @item -Wparentheses
2749 @opindex Wparentheses
2750 Warn if parentheses are omitted in certain contexts, such
2751 as when there is an assignment in a context where a truth value
2752 is expected, or when operators are nested whose precedence people
2753 often get confused about.
2754
2755 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2756 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2757 interpretation from that of ordinary mathematical notation.
2758
2759 Also warn about constructions where there may be confusion to which
2760 @code{if} statement an @code{else} branch belongs.  Here is an example of
2761 such a case:
2762
2763 @smallexample
2764 @group
2765 @{
2766   if (a)
2767     if (b)
2768       foo ();
2769   else
2770     bar ();
2771 @}
2772 @end group
2773 @end smallexample
2774
2775 In C/C++, every @code{else} branch belongs to the innermost possible
2776 @code{if} statement, which in this example is @code{if (b)}.  This is
2777 often not what the programmer expected, as illustrated in the above
2778 example by indentation the programmer chose.  When there is the
2779 potential for this confusion, GCC will issue a warning when this flag
2780 is specified.  To eliminate the warning, add explicit braces around
2781 the innermost @code{if} statement so there is no way the @code{else}
2782 could belong to the enclosing @code{if}.  The resulting code would
2783 look like this:
2784
2785 @smallexample
2786 @group
2787 @{
2788   if (a)
2789     @{
2790       if (b)
2791         foo ();
2792       else
2793         bar ();
2794     @}
2795 @}
2796 @end group
2797 @end smallexample
2798
2799 This warning is enabled by @option{-Wall}.
2800
2801 @item -Wsequence-point
2802 @opindex Wsequence-point
2803 Warn about code that may have undefined semantics because of violations
2804 of sequence point rules in the C and C++ standards.
2805
2806 The C and C++ standards defines the order in which expressions in a C/C++
2807 program are evaluated in terms of @dfn{sequence points}, which represent
2808 a partial ordering between the execution of parts of the program: those
2809 executed before the sequence point, and those executed after it.  These
2810 occur after the evaluation of a full expression (one which is not part
2811 of a larger expression), after the evaluation of the first operand of a
2812 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2813 function is called (but after the evaluation of its arguments and the
2814 expression denoting the called function), and in certain other places.
2815 Other than as expressed by the sequence point rules, the order of
2816 evaluation of subexpressions of an expression is not specified.  All
2817 these rules describe only a partial order rather than a total order,
2818 since, for example, if two functions are called within one expression
2819 with no sequence point between them, the order in which the functions
2820 are called is not specified.  However, the standards committee have
2821 ruled that function calls do not overlap.
2822
2823 It is not specified when between sequence points modifications to the
2824 values of objects take effect.  Programs whose behavior depends on this
2825 have undefined behavior; the C and C++ standards specify that ``Between
2826 the previous and next sequence point an object shall have its stored
2827 value modified at most once by the evaluation of an expression.
2828 Furthermore, the prior value shall be read only to determine the value
2829 to be stored.''.  If a program breaks these rules, the results on any
2830 particular implementation are entirely unpredictable.
2831
2832 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2833 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2834 diagnosed by this option, and it may give an occasional false positive
2835 result, but in general it has been found fairly effective at detecting
2836 this sort of problem in programs.
2837
2838 The standard is worded confusingly, therefore there is some debate
2839 over the precise meaning of the sequence point rules in subtle cases.
2840 Links to discussions of the problem, including proposed formal
2841 definitions, may be found on the GCC readings page, at
2842 @w{@uref{http://gcc.gnu.org/readings.html}}.
2843
2844 This warning is enabled by @option{-Wall} for C and C++.
2845
2846 @item -Wreturn-type
2847 @opindex Wreturn-type
2848 @opindex Wno-return-type
2849 Warn whenever a function is defined with a return-type that defaults
2850 to @code{int}.  Also warn about any @code{return} statement with no
2851 return-value in a function whose return-type is not @code{void}
2852 (falling off the end of the function body is considered returning
2853 without a value), and about a @code{return} statement with a
2854 expression in a function whose return-type is @code{void}.
2855
2856 Also warn if the return type of a function has a type qualifier
2857 such as @code{const}.  For ISO C such a type qualifier has no effect,
2858 since the value returned by a function is not an lvalue.
2859 For C++, the warning is only emitted for scalar types or @code{void}.
2860 ISO C prohibits qualified @code{void} return types on function
2861 definitions, so such return types always receive a warning
2862 even without this option.
2863
2864 For C++, a function without return type always produces a diagnostic
2865 message, even when @option{-Wno-return-type} is specified.  The only
2866 exceptions are @samp{main} and functions defined in system headers.
2867
2868 This warning is enabled by @option{-Wall}.
2869
2870 @item -Wswitch
2871 @opindex Wswitch
2872 Warn whenever a @code{switch} statement has an index of enumerated type
2873 and lacks a @code{case} for one or more of the named codes of that
2874 enumeration.  (The presence of a @code{default} label prevents this
2875 warning.)  @code{case} labels outside the enumeration range also
2876 provoke warnings when this option is used.
2877 This warning is enabled by @option{-Wall}.
2878
2879 @item -Wswitch-default
2880 @opindex Wswitch-switch
2881 Warn whenever a @code{switch} statement does not have a @code{default}
2882 case.
2883
2884 @item -Wswitch-enum
2885 @opindex Wswitch-enum
2886 Warn whenever a @code{switch} statement has an index of enumerated type
2887 and lacks a @code{case} for one or more of the named codes of that
2888 enumeration.  @code{case} labels outside the enumeration range also
2889 provoke warnings when this option is used.
2890
2891 @item -Wtrigraphs
2892 @opindex Wtrigraphs
2893 Warn if any trigraphs are encountered that might change the meaning of
2894 the program (trigraphs within comments are not warned about).
2895 This warning is enabled by @option{-Wall}.
2896
2897 @item -Wunused-function
2898 @opindex Wunused-function
2899 Warn whenever a static function is declared but not defined or a
2900 non-inline static function is unused.
2901 This warning is enabled by @option{-Wall}.
2902
2903 @item -Wunused-label
2904 @opindex Wunused-label
2905 Warn whenever a label is declared but not used.
2906 This warning is enabled by @option{-Wall}.
2907
2908 To suppress this warning use the @samp{unused} attribute
2909 (@pxref{Variable Attributes}).
2910
2911 @item -Wunused-parameter
2912 @opindex Wunused-parameter
2913 Warn whenever a function parameter is unused aside from its declaration.
2914
2915 To suppress this warning use the @samp{unused} attribute
2916 (@pxref{Variable Attributes}).
2917
2918 @item -Wunused-variable
2919 @opindex Wunused-variable
2920 Warn whenever a local variable or non-constant static variable is unused
2921 aside from its declaration.
2922 This warning is enabled by @option{-Wall}.
2923
2924 To suppress this warning use the @samp{unused} attribute
2925 (@pxref{Variable Attributes}).
2926
2927 @item -Wunused-value
2928 @opindex Wunused-value
2929 Warn whenever a statement computes a result that is explicitly not
2930 used. To suppress this warning cast the unused expression to
2931 @samp{void}. This includes an expression-statement or the left-hand
2932 side of a comma expression that contains no side effects. For example,
2933 an expression such as @samp{x[i,j]} will cause a warning, while
2934 @samp{x[(void)i,j]} will not.
2935
2936 This warning is enabled by @option{-Wall}.
2937
2938 @item -Wunused
2939 @opindex Wunused
2940 All the above @option{-Wunused} options combined.
2941
2942 In order to get a warning about an unused function parameter, you must
2943 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2944 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2945
2946 @item -Wuninitialized
2947 @opindex Wuninitialized
2948 Warn if an automatic variable is used without first being initialized or
2949 if a variable may be clobbered by a @code{setjmp} call.
2950
2951 These warnings are possible only in optimizing compilation,
2952 because they require data flow information that is computed only
2953 when optimizing.  If you do not specify @option{-O}, you will not get
2954 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2955 requiring @option{-O}.
2956
2957 If you want to warn about code which uses the uninitialized value of the
2958 variable in its own initializer, use the @option{-Winit-self} option.
2959
2960 These warnings occur for individual uninitialized or clobbered
2961 elements of structure, union or array variables as well as for
2962 variables which are uninitialized or clobbered as a whole.  They do
2963 not occur for variables or elements declared @code{volatile}.  Because
2964 these warnings depend on optimization, the exact variables or elements
2965 for which there are warnings will depend on the precise optimization
2966 options and version of GCC used.
2967
2968 Note that there may be no warning about a variable that is used only
2969 to compute a value that itself is never used, because such
2970 computations may be deleted by data flow analysis before the warnings
2971 are printed.
2972
2973 These warnings are made optional because GCC is not smart
2974 enough to see all the reasons why the code might be correct
2975 despite appearing to have an error.  Here is one example of how
2976 this can happen:
2977
2978 @smallexample
2979 @group
2980 @{
2981   int x;
2982   switch (y)
2983     @{
2984     case 1: x = 1;
2985       break;
2986     case 2: x = 4;
2987       break;
2988     case 3: x = 5;
2989     @}
2990   foo (x);
2991 @}
2992 @end group
2993 @end smallexample
2994
2995 @noindent
2996 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2997 always initialized, but GCC doesn't know this.  Here is
2998 another common case:
2999
3000 @smallexample
3001 @{
3002   int save_y;
3003   if (change_y) save_y = y, y = new_y;
3004   @dots{}
3005   if (change_y) y = save_y;
3006 @}
3007 @end smallexample
3008
3009 @noindent
3010 This has no bug because @code{save_y} is used only if it is set.
3011
3012 @cindex @code{longjmp} warnings
3013 This option also warns when a non-volatile automatic variable might be
3014 changed by a call to @code{longjmp}.  These warnings as well are possible
3015 only in optimizing compilation.
3016
3017 The compiler sees only the calls to @code{setjmp}.  It cannot know
3018 where @code{longjmp} will be called; in fact, a signal handler could
3019 call it at any point in the code.  As a result, you may get a warning
3020 even when there is in fact no problem because @code{longjmp} cannot
3021 in fact be called at the place which would cause a problem.
3022
3023 Some spurious warnings can be avoided if you declare all the functions
3024 you use that never return as @code{noreturn}.  @xref{Function
3025 Attributes}.
3026
3027 This warning is enabled by @option{-Wall}.
3028
3029 @item -Wunknown-pragmas
3030 @opindex Wunknown-pragmas
3031 @cindex warning for unknown pragmas
3032 @cindex unknown pragmas, warning
3033 @cindex pragmas, warning of unknown
3034 Warn when a #pragma directive is encountered which is not understood by
3035 GCC@.  If this command line option is used, warnings will even be issued
3036 for unknown pragmas in system header files.  This is not the case if
3037 the warnings were only enabled by the @option{-Wall} command line option.
3038
3039 @item -Wno-pragmas
3040 @opindex Wno-pragmas
3041 @opindex Wpragmas
3042 Do not warn about misuses of pragmas, such as incorrect parameters,
3043 invalid syntax, or conflicts between pragmas.  See also
3044 @samp{-Wunknown-pragmas}.
3045
3046 @item -Wstrict-aliasing
3047 @opindex Wstrict-aliasing
3048 This option is only active when @option{-fstrict-aliasing} is active.
3049 It warns about code which might break the strict aliasing rules that the
3050 compiler is using for optimization.  The warning does not catch all
3051 cases, but does attempt to catch the more common pitfalls.  It is
3052 included in @option{-Wall}.
3053 It is equivalent to -Wstrict-aliasing=3
3054
3055 @item -Wstrict-aliasing=n
3056 @opindex Wstrict-aliasing=n
3057 This option is only active when @option{-fstrict-aliasing} is active.
3058 It warns about code which might break the strict aliasing rules that the
3059 compiler is using for optimization.
3060 Higher levels correspond to higher accuracy (fewer false positives).
3061 Higher levels also correspond to more effort, similar to the way -O works.
3062 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3063 with n=3.
3064
3065 Level 1: Most aggressive, quick, least accurate.
3066 Possibly useful when higher levels
3067 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3068 false negatives.  However, it has many false positives.
3069 Warns for all pointer conversions between possibly incompatible types, 
3070 even if never dereferenced.  Runs in the frontend only.
3071
3072 Level 2: Aggressive, quick, not too precise.
3073 May still have many false positives (not as many as level 1 though),
3074 and few false negatives (but possibly more than level 1).
3075 Unlike level 1, it only warns when an address is taken.  Warns about
3076 incomplete types.  Runs in the frontend only.
3077
3078 Level 3 (default for @option{-Wstrict-aliasing}): 
3079 Should have very few false positives and few false 
3080 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3081 Takes care of the common punn+dereference pattern in the frontend:
3082 @code{*(int*)&some_float}.
3083 If optimization is enabled, it also runs in the backend, where it deals 
3084 with multiple statement cases using flow-sensitive points-to information.
3085 Only warns when the converted pointer is dereferenced.
3086 Does not warn about incomplete types.
3087
3088 @item -Wstrict-overflow
3089 @item -Wstrict-overflow=@var{n}
3090 @opindex Wstrict-overflow
3091 This option is only active when @option{-fstrict-overflow} is active.
3092 It warns about cases where the compiler optimizes based on the
3093 assumption that signed overflow does not occur.  Note that it does not
3094 warn about all cases where the code might overflow: it only warns
3095 about cases where the compiler implements some optimization.  Thus
3096 this warning depends on the optimization level.
3097
3098 An optimization which assumes that signed overflow does not occur is
3099 perfectly safe if the values of the variables involved are such that
3100 overflow never does, in fact, occur.  Therefore this warning can
3101 easily give a false positive: a warning about code which is not
3102 actually a problem.  To help focus on important issues, several
3103 warning levels are defined.  No warnings are issued for the use of
3104 undefined signed overflow when estimating how many iterations a loop
3105 will require, in particular when determining whether a loop will be
3106 executed at all.
3107
3108 @table @option
3109 @item -Wstrict-overflow=1
3110 Warn about cases which are both questionable and easy to avoid.  For
3111 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3112 compiler will simplify this to @code{1}.  This level of
3113 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3114 are not, and must be explicitly requested.
3115
3116 @item -Wstrict-overflow=2
3117 Also warn about other cases where a comparison is simplified to a
3118 constant.  For example: @code{abs (x) >= 0}.  This can only be
3119 simplified when @option{-fstrict-overflow} is in effect, because
3120 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3121 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3122 @option{-Wstrict-overflow=2}.
3123
3124 @item -Wstrict-overflow=3
3125 Also warn about other cases where a comparison is simplified.  For
3126 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3127
3128 @item -Wstrict-overflow=4
3129 Also warn about other simplifications not covered by the above cases.
3130 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3131
3132 @item -Wstrict-overflow=5
3133 Also warn about cases where the compiler reduces the magnitude of a
3134 constant involved in a comparison.  For example: @code{x + 2 > y} will
3135 be simplified to @code{x + 1 >= y}.  This is reported only at the
3136 highest warning level because this simplification applies to many
3137 comparisons, so this warning level will give a very large number of
3138 false positives.
3139 @end table
3140
3141 @item -Warray-bounds
3142 @opindex Wno-array-bounds
3143 @opindex Warray-bounds
3144 This option is only active when @option{-ftree-vrp} is active
3145 (default for -O2 and above). It warns about subscripts to arrays
3146 that are always out of bounds. This warning is enabled by @option{-Wall}.
3147
3148 @item -Wall
3149 @opindex Wall
3150 All of the above @samp{-W} options combined.  This enables all the
3151 warnings about constructions that some users consider questionable, and
3152 that are easy to avoid (or modify to prevent the warning), even in
3153 conjunction with macros.  This also enables some language-specific
3154 warnings described in @ref{C++ Dialect Options} and
3155 @ref{Objective-C and Objective-C++ Dialect Options}.
3156 @end table
3157
3158 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
3159 Some of them warn about constructions that users generally do not
3160 consider questionable, but which occasionally you might wish to check
3161 for; others warn about constructions that are necessary or hard to avoid
3162 in some cases, and there is no simple way to modify the code to suppress
3163 the warning.
3164
3165 @table @gcctabopt
3166 @item -Wextra
3167 @opindex W
3168 @opindex Wextra
3169 (This option used to be called @option{-W}.  The older name is still
3170 supported, but the newer name is more descriptive.)  Print extra warning
3171 messages for these events:
3172
3173 @itemize @bullet
3174 @item
3175 Warn if a comparison is always true or always false due to the limited
3176 range of the data type, but do not warn for constant expressions.  For
3177 example, warn if an unsigned variable is compared against zero with
3178 @samp{<} or @samp{>=}.  This warning can be independently controlled
3179 by @option{-Wtype-limits}.
3180
3181 @item @r{(C only)}
3182 Storage-class specifiers like @code{static} are not the first things
3183 in a declaration.  According to the C Standard, this usage is
3184 obsolescent.  This warning can be independently controlled by
3185 @option{-Wold-style-declaration}.
3186
3187 @item
3188 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
3189 arguments.
3190
3191 @item
3192 A comparison between signed and unsigned values could produce an
3193 incorrect result when the signed value is converted to unsigned.
3194 (But don't warn if @option{-Wno-sign-compare} is also specified.)
3195
3196 @item
3197 An aggregate has an initializer which does not initialize all members.
3198 This warning can be independently controlled by
3199 @option{-Wmissing-field-initializers}.
3200
3201 @item
3202 An initialized field without side effects is overridden when using
3203 designated initializers (@pxref{Designated Inits, , Designated
3204 Initializers}).  This warning can be independently controlled by
3205 @option{-Woverride-init}.
3206
3207 @item @r{(C only)}
3208 A function parameter is declared without a type specifier in K&R-style
3209 functions.  This warning can be independently controlled by
3210 @option{-Wmissing-parameter-type}.
3211
3212 @item
3213 An empty body occurs in an @samp{if}, @samp{else} or
3214 @samp{do while} statement. This warning can be independently
3215 controlled by @option{-Wempty-body}.
3216
3217 @item @r{(C++ only)}
3218 An empty body occurs in a @samp{while} or @samp{for} statement with no
3219 whitespacing before the semicolon. This warning can be independently
3220 controlled by @option{-Wempty-body}.
3221
3222 @item
3223 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3224 @samp{>}, or @samp{>=}.
3225
3226 @item
3227 A variable might be changed by @samp{longjmp} or @samp{vfork}.
3228 This warning can be independently controlled by @option{-Wclobbered}.
3229
3230 @item @r{(C++ only)}
3231 An enumerator and a non-enumerator both appear in a conditional expression.
3232
3233 @item @r{(C++ only)}
3234 A non-static reference or non-static @samp{const} member appears in a
3235 class without constructors.
3236
3237 @item @r{(C++ only)}
3238 Ambiguous virtual bases.
3239
3240 @item @r{(C++ only)}
3241 Subscripting an array which has been declared @samp{register}.
3242
3243 @item @r{(C++ only)}
3244 Taking the address of a variable which has been declared @samp{register}.
3245
3246 @item @r{(C++ only)}
3247 A base class is not initialized in a derived class' copy constructor.
3248 @end itemize
3249
3250 @item -Wno-div-by-zero
3251 @opindex Wno-div-by-zero
3252 @opindex Wdiv-by-zero
3253 Do not warn about compile-time integer division by zero.  Floating point
3254 division by zero is not warned about, as it can be a legitimate way of
3255 obtaining infinities and NaNs.
3256
3257 @item -Wsystem-headers
3258 @opindex Wsystem-headers
3259 @cindex warnings from system headers
3260 @cindex system headers, warnings from
3261 Print warning messages for constructs found in system header files.
3262 Warnings from system headers are normally suppressed, on the assumption
3263 that they usually do not indicate real problems and would only make the
3264 compiler output harder to read.  Using this command line option tells
3265 GCC to emit warnings from system headers as if they occurred in user
3266 code.  However, note that using @option{-Wall} in conjunction with this
3267 option will @emph{not} warn about unknown pragmas in system
3268 headers---for that, @option{-Wunknown-pragmas} must also be used.
3269
3270 @item -Wfloat-equal
3271 @opindex Wfloat-equal
3272 Warn if floating point values are used in equality comparisons.
3273
3274 The idea behind this is that sometimes it is convenient (for the
3275 programmer) to consider floating-point values as approximations to
3276 infinitely precise real numbers.  If you are doing this, then you need
3277 to compute (by analyzing the code, or in some other way) the maximum or
3278 likely maximum error that the computation introduces, and allow for it
3279 when performing comparisons (and when producing output, but that's a
3280 different problem).  In particular, instead of testing for equality, you
3281 would check to see whether the two values have ranges that overlap; and
3282 this is done with the relational operators, so equality comparisons are
3283 probably mistaken.
3284
3285 @item -Wtraditional @r{(C only)}
3286 @opindex Wtraditional
3287 Warn about certain constructs that behave differently in traditional and
3288 ISO C@.  Also warn about ISO C constructs that have no traditional C
3289 equivalent, and/or problematic constructs which should be avoided.
3290
3291 @itemize @bullet
3292 @item
3293 Macro parameters that appear within string literals in the macro body.
3294 In traditional C macro replacement takes place within string literals,
3295 but does not in ISO C@.
3296
3297 @item
3298 In traditional C, some preprocessor directives did not exist.
3299 Traditional preprocessors would only consider a line to be a directive
3300 if the @samp{#} appeared in column 1 on the line.  Therefore
3301 @option{-Wtraditional} warns about directives that traditional C
3302 understands but would ignore because the @samp{#} does not appear as the
3303 first character on the line.  It also suggests you hide directives like
3304 @samp{#pragma} not understood by traditional C by indenting them.  Some
3305 traditional implementations would not recognize @samp{#elif}, so it
3306 suggests avoiding it altogether.
3307
3308 @item
3309 A function-like macro that appears without arguments.
3310
3311 @item
3312 The unary plus operator.
3313
3314 @item
3315 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3316 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3317 constants.)  Note, these suffixes appear in macros defined in the system
3318 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3319 Use of these macros in user code might normally lead to spurious
3320 warnings, however GCC's integrated preprocessor has enough context to
3321 avoid warning in these cases.
3322
3323 @item
3324 A function declared external in one block and then used after the end of
3325 the block.
3326
3327 @item
3328 A @code{switch} statement has an operand of type @code{long}.
3329
3330 @item
3331 A non-@code{static} function declaration follows a @code{static} one.
3332 This construct is not accepted by some traditional C compilers.
3333
3334 @item
3335 The ISO type of an integer constant has a different width or
3336 signedness from its traditional type.  This warning is only issued if
3337 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3338 typically represent bit patterns, are not warned about.
3339
3340 @item
3341 Usage of ISO string concatenation is detected.
3342
3343 @item
3344 Initialization of automatic aggregates.
3345
3346 @item
3347 Identifier conflicts with labels.  Traditional C lacks a separate
3348 namespace for labels.
3349
3350 @item
3351 Initialization of unions.  If the initializer is zero, the warning is
3352 omitted.  This is done under the assumption that the zero initializer in
3353 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3354 initializer warnings and relies on default initialization to zero in the
3355 traditional C case.
3356
3357 @item
3358 Conversions by prototypes between fixed/floating point values and vice
3359 versa.  The absence of these prototypes when compiling with traditional
3360 C would cause serious problems.  This is a subset of the possible
3361 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3362
3363 @item
3364 Use of ISO C style function definitions.  This warning intentionally is
3365 @emph{not} issued for prototype declarations or variadic functions
3366 because these ISO C features will appear in your code when using
3367 libiberty's traditional C compatibility macros, @code{PARAMS} and
3368 @code{VPARAMS}.  This warning is also bypassed for nested functions
3369 because that feature is already a GCC extension and thus not relevant to
3370 traditional C compatibility.
3371 @end itemize
3372
3373 @item -Wtraditional-conversion @r{(C only)}
3374 @opindex Wtraditional-conversion
3375 Warn if a prototype causes a type conversion that is different from what
3376 would happen to the same argument in the absence of a prototype.  This
3377 includes conversions of fixed point to floating and vice versa, and
3378 conversions changing the width or signedness of a fixed point argument
3379 except when the same as the default promotion.
3380
3381 @item -Wdeclaration-after-statement @r{(C only)}
3382 @opindex Wdeclaration-after-statement
3383 Warn when a declaration is found after a statement in a block.  This
3384 construct, known from C++, was introduced with ISO C99 and is by default
3385 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3386 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3387
3388 @item -Wundef
3389 @opindex Wundef
3390 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3391
3392 @item -Wno-endif-labels
3393 @opindex Wno-endif-labels
3394 @opindex Wendif-labels
3395 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3396
3397 @item -Wshadow
3398 @opindex Wshadow
3399 Warn whenever a local variable shadows another local variable, parameter or
3400 global variable or whenever a built-in function is shadowed.
3401
3402 @item -Wlarger-than-@var{len}
3403 @opindex Wlarger-than
3404 Warn whenever an object of larger than @var{len} bytes is defined.
3405
3406 @item -Wunsafe-loop-optimizations
3407 @opindex Wunsafe-loop-optimizations
3408 Warn if the loop cannot be optimized because the compiler could not
3409 assume anything on the bounds of the loop indices.  With
3410 @option{-funsafe-loop-optimizations} warn if the compiler made
3411 such assumptions.
3412
3413 @item -Wpointer-arith
3414 @opindex Wpointer-arith
3415 Warn about anything that depends on the ``size of'' a function type or
3416 of @code{void}.  GNU C assigns these types a size of 1, for
3417 convenience in calculations with @code{void *} pointers and pointers
3418 to functions.  In C++, warn also when an arithmetic operation involves
3419 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3420
3421 @item -Wtype-limits
3422 @opindex Wtype-limits
3423 @opindex Wno-type-limits
3424 Warn if a comparison is always true or always false due to the limited
3425 range of the data type, but do not warn for constant expressions.  For
3426 example, warn if an unsigned variable is compared against zero with
3427 @samp{<} or @samp{>=}.  This warning is also enabled by
3428 @option{-Wextra}.
3429
3430 @item -Wbad-function-cast @r{(C only)}
3431 @opindex Wbad-function-cast
3432 Warn whenever a function call is cast to a non-matching type.
3433 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3434
3435 @item -Wc++-compat
3436 Warn about ISO C constructs that are outside of the common subset of
3437 ISO C and ISO C++, e.g.@: request for implicit conversion from
3438 @code{void *} to a pointer to non-@code{void} type.
3439
3440 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3441 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3442 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3443 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3444
3445 @item -Wcast-qual
3446 @opindex Wcast-qual
3447 Warn whenever a pointer is cast so as to remove a type qualifier from
3448 the target type.  For example, warn if a @code{const char *} is cast
3449 to an ordinary @code{char *}.
3450
3451 @item -Wcast-align
3452 @opindex Wcast-align
3453 Warn whenever a pointer is cast such that the required alignment of the
3454 target is increased.  For example, warn if a @code{char *} is cast to
3455 an @code{int *} on machines where integers can only be accessed at
3456 two- or four-byte boundaries.
3457
3458 @item -Wwrite-strings
3459 @opindex Wwrite-strings
3460 When compiling C, give string constants the type @code{const
3461 char[@var{length}]} so that
3462 copying the address of one into a non-@code{const} @code{char *}
3463 pointer will get a warning; when compiling C++, warn about the
3464 deprecated conversion from string literals to @code{char *}.  This
3465 warning, by default, is enabled for C++ programs.
3466 These warnings will help you find at
3467 compile time code that can try to write into a string constant, but
3468 only if you have been very careful about using @code{const} in
3469 declarations and prototypes.  Otherwise, it will just be a nuisance;
3470 this is why we did not make @option{-Wall} request these warnings.
3471
3472 @item -Wclobbered
3473 @opindex Wclobbered
3474 Warn for variables that might be changed by @samp{longjmp} or
3475 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3476
3477 @item -Wconversion
3478 @opindex Wconversion
3479 @opindex Wno-conversion
3480 Warn for implicit conversions that may alter a value. This includes
3481 conversions between real and integer, like @code{abs (x)} when
3482 @code{x} is @code{double}; conversions between signed and unsigned,
3483 like @code{unsigned ui = -1}; and conversions to smaller types, like
3484 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3485 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3486 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3487 conversions between signed and unsigned integers can be disabled by
3488 using @option{-Wno-sign-conversion}.
3489
3490 For C++, also warn for conversions between @code{NULL} and non-pointer
3491 types; confusing overload resolution for user-defined conversions; and
3492 conversions that will never use a type conversion operator:
3493 conversions to @code{void}, the same type, a base class or a reference
3494 to them. Warnings about conversions between signed and unsigned
3495 integers are disabled by default in C++ unless
3496 @option{-Wsign-conversion} is explicitly enabled.
3497
3498 @item -Wempty-body
3499 @opindex Wempty-body
3500 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3501 while} statement.  Additionally, in C++, warn when an empty body occurs
3502 in a @samp{while} or @samp{for} statement with no whitespacing before
3503 the semicolon.  This warning is also enabled by @option{-Wextra}.
3504
3505 @item -Wsign-compare
3506 @opindex Wsign-compare
3507 @cindex warning for comparison of signed and unsigned values
3508 @cindex comparison of signed and unsigned values, warning
3509 @cindex signed and unsigned values, comparison warning
3510 Warn when a comparison between signed and unsigned values could produce
3511 an incorrect result when the signed value is converted to unsigned.
3512 This warning is also enabled by @option{-Wextra}; to get the other warnings
3513 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3514
3515 @item -Wsign-conversion
3516 @opindex Wsign-conversion
3517 @opindex Wno-sign-conversion
3518 Warn for implicit conversions that may change the sign of an integer
3519 value, like assigning a signed integer expression to an unsigned
3520 integer variable. An explicit cast silences the warning. In C, this
3521 option is enabled also by @option{-Wconversion}.
3522
3523 @item -Waddress
3524 @opindex Waddress
3525 @opindex Wno-address
3526 Warn about suspicious uses of memory addresses. These include using
3527 the address of a function in a conditional expression, such as
3528 @code{void func(void); if (func)}, and comparisons against the memory
3529 address of a string literal, such as @code{if (x == "abc")}.  Such
3530 uses typically indicate a programmer error: the address of a function
3531 always evaluates to true, so their use in a conditional usually
3532 indicate that the programmer forgot the parentheses in a function
3533 call; and comparisons against string literals result in unspecified
3534 behavior and are not portable in C, so they usually indicate that the
3535 programmer intended to use @code{strcmp}.  This warning is enabled by
3536 @option{-Wall}.
3537
3538 @item -Wlogical-op
3539 @opindex Wlogical-op
3540 @opindex Wno-logical-op
3541 Warn about suspicious uses of logical operators in expressions.
3542 This includes using logical operators in contexts where a
3543 bit-wise operator is likely to be expected.
3544
3545 @item -Waggregate-return
3546 @opindex Waggregate-return
3547 Warn if any functions that return structures or unions are defined or
3548 called.  (In languages where you can return an array, this also elicits
3549 a warning.)
3550
3551 @item -Wno-attributes
3552 @opindex Wno-attributes
3553 @opindex Wattributes
3554 Do not warn if an unexpected @code{__attribute__} is used, such as
3555 unrecognized attributes, function attributes applied to variables,
3556 etc.  This will not stop errors for incorrect use of supported
3557 attributes.
3558
3559 @item -Wstrict-prototypes @r{(C only)}
3560 @opindex Wstrict-prototypes
3561 Warn if a function is declared or defined without specifying the
3562 argument types.  (An old-style function definition is permitted without
3563 a warning if preceded by a declaration which specifies the argument
3564 types.)
3565
3566 @item -Wold-style-declaration @r{(C only)}
3567 @opindex Wold-style-declaration
3568 Warn for obsolescent usages, according to the C Standard, in a
3569 declaration. For example, warn if storage-class specifiers like
3570 @code{static} are not the first things in a declaration.  This warning
3571 is also enabled by @option{-Wextra}.
3572
3573 @item -Wold-style-definition @r{(C only)}
3574 @opindex Wold-style-definition
3575 Warn if an old-style function definition is used.  A warning is given
3576 even if there is a previous prototype.
3577
3578 @item -Wmissing-parameter-type @r{(C only)}
3579 @opindex Wmissing-parameter-type
3580 A function parameter is declared without a type specifier in K&R-style
3581 functions:
3582
3583 @smallexample
3584 void foo(bar) @{ @}
3585 @end smallexample
3586
3587 This warning is also enabled by @option{-Wextra}.
3588
3589 @item -Wmissing-prototypes @r{(C only)}
3590 @opindex Wmissing-prototypes
3591 Warn if a global function is defined without a previous prototype
3592 declaration.  This warning is issued even if the definition itself
3593 provides a prototype.  The aim is to detect global functions that fail
3594 to be declared in header files.
3595
3596 @item -Wmissing-declarations @r{(C and C++ only)}
3597 @opindex Wmissing-declarations
3598 Warn if a global function is defined without a previous declaration.
3599 Do so even if the definition itself provides a prototype.
3600 Use this option to detect global functions that are not declared in
3601 header files.  In C++, no warnings are issued for function templates,
3602 or for inline functions, or for functions in anonymous namespaces.
3603
3604 @item -Wmissing-field-initializers
3605 @opindex Wmissing-field-initializers
3606 @opindex W
3607 @opindex Wextra
3608 Warn if a structure's initializer has some fields missing.  For
3609 example, the following code would cause such a warning, because
3610 @code{x.h} is implicitly zero:
3611
3612 @smallexample
3613 struct s @{ int f, g, h; @};
3614 struct s x = @{ 3, 4 @};
3615 @end smallexample
3616
3617 This option does not warn about designated initializers, so the following
3618 modification would not trigger a warning:
3619
3620 @smallexample
3621 struct s @{ int f, g, h; @};
3622 struct s x = @{ .f = 3, .g = 4 @};
3623 @end smallexample
3624
3625 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3626 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3627
3628 @item -Wmissing-noreturn
3629 @opindex Wmissing-noreturn
3630 Warn about functions which might be candidates for attribute @code{noreturn}.
3631 Note these are only possible candidates, not absolute ones.  Care should
3632 be taken to manually verify functions actually do not ever return before
3633 adding the @code{noreturn} attribute, otherwise subtle code generation
3634 bugs could be introduced.  You will not get a warning for @code{main} in
3635 hosted C environments.
3636
3637 @item -Wmissing-format-attribute
3638 @opindex Wmissing-format-attribute
3639 @opindex Wformat
3640 Warn about function pointers which might be candidates for @code{format}
3641 attributes.  Note these are only possible candidates, not absolute ones.
3642 GCC will guess that function pointers with @code{format} attributes that
3643 are used in assignment, initialization, parameter passing or return
3644 statements should have a corresponding @code{format} attribute in the
3645 resulting type.  I.e.@: the left-hand side of the assignment or
3646 initialization, the type of the parameter variable, or the return type
3647 of the containing function respectively should also have a @code{format}
3648 attribute to avoid the warning.
3649
3650 GCC will also warn about function definitions which might be
3651 candidates for @code{format} attributes.  Again, these are only
3652 possible candidates.  GCC will guess that @code{format} attributes
3653 might be appropriate for any function that calls a function like
3654 @code{vprintf} or @code{vscanf}, but this might not always be the
3655 case, and some functions for which @code{format} attributes are
3656 appropriate may not be detected.
3657
3658 @item -Wno-multichar
3659 @opindex Wno-multichar
3660 @opindex Wmultichar
3661 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3662 Usually they indicate a typo in the user's code, as they have
3663 implementation-defined values, and should not be used in portable code.
3664
3665 @item -Wnormalized=<none|id|nfc|nfkc>
3666 @opindex Wnormalized
3667 @cindex NFC
3668 @cindex NFKC
3669 @cindex character set, input normalization
3670 In ISO C and ISO C++, two identifiers are different if they are
3671 different sequences of characters.  However, sometimes when characters
3672 outside the basic ASCII character set are used, you can have two
3673 different character sequences that look the same.  To avoid confusion,
3674 the ISO 10646 standard sets out some @dfn{normalization rules} which
3675 when applied ensure that two sequences that look the same are turned into
3676 the same sequence.  GCC can warn you if you are using identifiers which
3677 have not been normalized; this option controls that warning.
3678
3679 There are four levels of warning that GCC supports.  The default is
3680 @option{-Wnormalized=nfc}, which warns about any identifier which is
3681 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3682 recommended form for most uses.
3683
3684 Unfortunately, there are some characters which ISO C and ISO C++ allow
3685 in identifiers that when turned into NFC aren't allowable as
3686 identifiers.  That is, there's no way to use these symbols in portable
3687 ISO C or C++ and have all your identifiers in NFC.
3688 @option{-Wnormalized=id} suppresses the warning for these characters.
3689 It is hoped that future versions of the standards involved will correct
3690 this, which is why this option is not the default.
3691
3692 You can switch the warning off for all characters by writing
3693 @option{-Wnormalized=none}.  You would only want to do this if you
3694 were using some other normalization scheme (like ``D''), because
3695 otherwise you can easily create bugs that are literally impossible to see.
3696
3697 Some characters in ISO 10646 have distinct meanings but look identical
3698 in some fonts or display methodologies, especially once formatting has
3699 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3700 LETTER N'', will display just like a regular @code{n} which has been
3701 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3702 normalization scheme to convert all these into a standard form as
3703 well, and GCC will warn if your code is not in NFKC if you use
3704 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3705 about every identifier that contains the letter O because it might be
3706 confused with the digit 0, and so is not the default, but may be
3707 useful as a local coding convention if the programming environment is
3708 unable to be fixed to display these characters distinctly.
3709
3710 @item -Wno-deprecated-declarations
3711 @opindex Wno-deprecated-declarations
3712 Do not warn about uses of functions (@pxref{Function Attributes}),
3713 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3714 Attributes}) marked as deprecated by using the @code{deprecated}
3715 attribute.
3716
3717 @item -Wno-overflow
3718 @opindex Wno-overflow
3719 Do not warn about compile-time overflow in constant expressions.
3720
3721 @item -Woverride-init
3722 @opindex Woverride-init
3723 @opindex W
3724 @opindex Wextra
3725 Warn if an initialized field without side effects is overridden when
3726 using designated initializers (@pxref{Designated Inits, , Designated
3727 Initializers}).
3728
3729 This warning is included in @option{-Wextra}.  To get other
3730 @option{-Wextra} warnings without this one, use @samp{-Wextra
3731 -Wno-override-init}.
3732
3733 @item -Wpacked
3734 @opindex Wpacked
3735 Warn if a structure is given the packed attribute, but the packed
3736 attribute has no effect on the layout or size of the structure.
3737 Such structures may be mis-aligned for little benefit.  For
3738 instance, in this code, the variable @code{f.x} in @code{struct bar}
3739 will be misaligned even though @code{struct bar} does not itself
3740 have the packed attribute:
3741
3742 @smallexample
3743 @group
3744 struct foo @{
3745   int x;
3746   char a, b, c, d;
3747 @} __attribute__((packed));
3748 struct bar @{
3749   char z;
3750   struct foo f;
3751 @};
3752 @end group
3753 @end smallexample
3754
3755 @item -Wpadded
3756 @opindex Wpadded
3757 Warn if padding is included in a structure, either to align an element
3758 of the structure or to align the whole structure.  Sometimes when this
3759 happens it is possible to rearrange the fields of the structure to
3760 reduce the padding and so make the structure smaller.
3761
3762 @item -Wredundant-decls
3763 @opindex Wredundant-decls
3764 Warn if anything is declared more than once in the same scope, even in
3765 cases where multiple declaration is valid and changes nothing.
3766
3767 @item -Wnested-externs @r{(C only)}
3768 @opindex Wnested-externs
3769 Warn if an @code{extern} declaration is encountered within a function.
3770
3771 @item -Wunreachable-code
3772 @opindex Wunreachable-code
3773 Warn if the compiler detects that code will never be executed.
3774
3775 This option is intended to warn when the compiler detects that at
3776 least a whole line of source code will never be executed, because
3777 some condition is never satisfied or because it is after a
3778 procedure that never returns.
3779
3780 It is possible for this option to produce a warning even though there
3781 are circumstances under which part of the affected line can be executed,
3782 so care should be taken when removing apparently-unreachable code.
3783
3784 For instance, when a function is inlined, a warning may mean that the
3785 line is unreachable in only one inlined copy of the function.
3786
3787 This option is not made part of @option{-Wall} because in a debugging
3788 version of a program there is often substantial code which checks
3789 correct functioning of the program and is, hopefully, unreachable
3790 because the program does work.  Another common use of unreachable
3791 code is to provide behavior which is selectable at compile-time.
3792
3793 @item -Winline
3794 @opindex Winline
3795 Warn if a function can not be inlined and it was declared as inline.
3796 Even with this option, the compiler will not warn about failures to
3797 inline functions declared in system headers.
3798
3799 The compiler uses a variety of heuristics to determine whether or not
3800 to inline a function.  For example, the compiler takes into account
3801 the size of the function being inlined and the amount of inlining
3802 that has already been done in the current function.  Therefore,
3803 seemingly insignificant changes in the source program can cause the
3804 warnings produced by @option{-Winline} to appear or disappear.
3805
3806 @item -Wno-invalid-offsetof @r{(C++ only)}
3807 @opindex Wno-invalid-offsetof
3808 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3809 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3810 to a non-POD type is undefined.  In existing C++ implementations,
3811 however, @samp{offsetof} typically gives meaningful results even when
3812 applied to certain kinds of non-POD types. (Such as a simple
3813 @samp{struct} that fails to be a POD type only by virtue of having a
3814 constructor.)  This flag is for users who are aware that they are
3815 writing nonportable code and who have deliberately chosen to ignore the
3816 warning about it.
3817
3818 The restrictions on @samp{offsetof} may be relaxed in a future version
3819 of the C++ standard.
3820
3821 @item -Wno-int-to-pointer-cast @r{(C only)}
3822 @opindex Wno-int-to-pointer-cast
3823 Suppress warnings from casts to pointer type of an integer of a
3824 different size.
3825
3826 @item -Wno-pointer-to-int-cast @r{(C only)}
3827 @opindex Wno-pointer-to-int-cast
3828 Suppress warnings from casts from a pointer to an integer type of a
3829 different size.
3830
3831 @item -Winvalid-pch
3832 @opindex Winvalid-pch
3833 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3834 the search path but can't be used.
3835
3836 @item -Wlong-long
3837 @opindex Wlong-long
3838 @opindex Wno-long-long
3839 Warn if @samp{long long} type is used.  This is default.  To inhibit
3840 the warning messages, use @option{-Wno-long-long}.  Flags
3841 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3842 only when @option{-pedantic} flag is used.
3843
3844 @item -Wvariadic-macros
3845 @opindex Wvariadic-macros
3846 @opindex Wno-variadic-macros
3847 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3848 alternate syntax when in pedantic ISO C99 mode.  This is default.
3849 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3850
3851 @item -Wvla
3852 @opindex Wvla
3853 @opindex Wno-vla
3854 Warn if variable length array is used in the code.
3855 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
3856 the variable length array.
3857
3858 @item -Wvolatile-register-var
3859 @opindex Wvolatile-register-var
3860 @opindex Wno-volatile-register-var
3861 Warn if a register variable is declared volatile.  The volatile
3862 modifier does not inhibit all optimizations that may eliminate reads
3863 and/or writes to register variables.
3864
3865 @item -Wdisabled-optimization
3866 @opindex Wdisabled-optimization
3867 Warn if a requested optimization pass is disabled.  This warning does
3868 not generally indicate that there is anything wrong with your code; it
3869 merely indicates that GCC's optimizers were unable to handle the code
3870 effectively.  Often, the problem is that your code is too big or too
3871 complex; GCC will refuse to optimize programs when the optimization
3872 itself is likely to take inordinate amounts of time.
3873
3874 @item -Wpointer-sign
3875 @opindex Wpointer-sign
3876 @opindex Wno-pointer-sign
3877 Warn for pointer argument passing or assignment with different signedness.
3878 This option is only supported for C and Objective-C@.  It is implied by
3879 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3880 @option{-Wno-pointer-sign}.
3881
3882 @item -Werror
3883 @opindex Werror
3884 Make all warnings into errors.
3885
3886 @item -Werror=
3887 @opindex Werror=
3888 Make the specified warning into an errors.  The specifier for a
3889 warning is appended, for example @option{-Werror=switch} turns the
3890 warnings controlled by @option{-Wswitch} into errors.  This switch
3891 takes a negative form, to be used to negate @option{-Werror} for
3892 specific warnings, for example @option{-Wno-error=switch} makes
3893 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3894 is in effect.  You can use the @option{-fdiagnostics-show-option}
3895 option to have each controllable warning amended with the option which
3896 controls it, to determine what to use with this option.
3897
3898 Note that specifying @option{-Werror=}@var{foo} automatically implies
3899 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3900 imply anything.
3901
3902 @item -Wstack-protector
3903 @opindex Wstack-protector
3904 This option is only active when @option{-fstack-protector} is active.  It
3905 warns about functions that will not be protected against stack smashing.
3906
3907 @item -Woverlength-strings
3908 @opindex Woverlength-strings
3909 Warn about string constants which are longer than the ``minimum
3910 maximum'' length specified in the C standard.  Modern compilers
3911 generally allow string constants which are much longer than the
3912 standard's minimum limit, but very portable programs should avoid
3913 using longer strings.
3914
3915 The limit applies @emph{after} string constant concatenation, and does
3916 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3917 C99, it was raised to 4095.  C++98 does not specify a normative
3918 minimum maximum, so we do not diagnose overlength strings in C++@.
3919
3920 This option is implied by @option{-pedantic}, and can be disabled with
3921 @option{-Wno-overlength-strings}.
3922 @end table
3923
3924 @node Debugging Options
3925 @section Options for Debugging Your Program or GCC
3926 @cindex options, debugging
3927 @cindex debugging information options
3928
3929 GCC has various special options that are used for debugging
3930 either your program or GCC:
3931
3932 @table @gcctabopt
3933 @item -g
3934 @opindex g
3935 Produce debugging information in the operating system's native format
3936 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3937 information.
3938
3939 On most systems that use stabs format, @option{-g} enables use of extra
3940 debugging information that only GDB can use; this extra information
3941 makes debugging work better in GDB but will probably make other debuggers
3942 crash or
3943 refuse to read the program.  If you want to control for certain whether
3944 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3945 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3946
3947 GCC allows you to use @option{-g} with
3948 @option{-O}.  The shortcuts taken by optimized code may occasionally
3949 produce surprising results: some variables you declared may not exist
3950 at all; flow of control may briefly move where you did not expect it;
3951 some statements may not be executed because they compute constant
3952 results or their values were already at hand; some statements may
3953 execute in different places because they were moved out of loops.
3954
3955 Nevertheless it proves possible to debug optimized output.  This makes
3956 it reasonable to use the optimizer for programs that might have bugs.
3957
3958 The following options are useful when GCC is generated with the
3959 capability for more than one debugging format.
3960
3961 @item -ggdb
3962 @opindex ggdb
3963 Produce debugging information for use by GDB@.  This means to use the
3964 most expressive format available (DWARF 2, stabs, or the native format
3965 if neither of those are supported), including GDB extensions if at all
3966 possible.
3967
3968 @item -gstabs
3969 @opindex gstabs
3970 Produce debugging information in stabs format (if that is supported),
3971 without GDB extensions.  This is the format used by DBX on most BSD
3972 systems.  On MIPS, Alpha and System V Release 4 systems this option
3973 produces stabs debugging output which is not understood by DBX or SDB@.
3974 On System V Release 4 systems this option requires the GNU assembler.
3975
3976 @item -feliminate-unused-debug-symbols
3977 @opindex feliminate-unused-debug-symbols
3978 Produce debugging information in stabs format (if that is supported),
3979 for only symbols that are actually used.
3980
3981 @item -femit-class-debug-always
3982 Instead of emitting debugging information for a C++ class in only one
3983 object file, emit it in all object files using the class.  This option
3984 should be used only with debuggers that are unable to handle the way GCC
3985 normally emits debugging information for classes because using this
3986 option will increase the size of debugging information by as much as a
3987 factor of two.
3988
3989 @item -gstabs+
3990 @opindex gstabs+
3991 Produce debugging information in stabs format (if that is supported),
3992 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3993 use of these extensions is likely to make other debuggers crash or
3994 refuse to read the program.
3995
3996 @item -gcoff
3997 @opindex gcoff
3998 Produce debugging information in COFF format (if that is supported).
3999 This is the format used by SDB on most System V systems prior to
4000 System V Release 4.
4001
4002 @item -gxcoff
4003 @opindex gxcoff
4004 Produce debugging information in XCOFF format (if that is supported).
4005 This is the format used by the DBX debugger on IBM RS/6000 systems.
4006
4007 @item -gxcoff+
4008 @opindex gxcoff+
4009 Produce debugging information in XCOFF format (if that is supported),
4010 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4011 use of these extensions is likely to make other debuggers crash or
4012 refuse to read the program, and may cause assemblers other than the GNU
4013 assembler (GAS) to fail with an error.
4014
4015 @item -gdwarf-2
4016 @opindex gdwarf-2
4017 Produce debugging information in DWARF version 2 format (if that is
4018 supported).  This is the format used by DBX on IRIX 6.  With this
4019 option, GCC uses features of DWARF version 3 when they are useful;
4020 version 3 is upward compatible with version 2, but may still cause
4021 problems for older debuggers.
4022
4023 @item -gvms
4024 @opindex gvms
4025 Produce debugging information in VMS debug format (if that is
4026 supported).  This is the format used by DEBUG on VMS systems.
4027
4028 @item -g@var{level}
4029 @itemx -ggdb@var{level}
4030 @itemx -gstabs@var{level}
4031 @itemx -gcoff@var{level}
4032 @itemx -gxcoff@var{level}
4033 @itemx -gvms@var{level}
4034 Request debugging information and also use @var{level} to specify how
4035 much information.  The default level is 2.
4036
4037 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4038 @option{-g}.
4039
4040 Level 1 produces minimal information, enough for making backtraces in
4041 parts of the program that you don't plan to debug.  This includes
4042 descriptions of functions and external variables, but no information
4043 about local variables and no line numbers.
4044
4045 Level 3 includes extra information, such as all the macro definitions
4046 present in the program.  Some debuggers support macro expansion when
4047 you use @option{-g3}.
4048
4049 @option{-gdwarf-2} does not accept a concatenated debug level, because
4050 GCC used to support an option @option{-gdwarf} that meant to generate
4051 debug information in version 1 of the DWARF format (which is very
4052 different from version 2), and it would have been too confusing.  That
4053 debug format is long obsolete, but the option cannot be changed now.
4054 Instead use an additional @option{-g@var{level}} option to change the
4055 debug level for DWARF2.
4056
4057 @item -feliminate-dwarf2-dups
4058 @opindex feliminate-dwarf2-dups
4059 Compress DWARF2 debugging information by eliminating duplicated
4060 information about each symbol.  This option only makes sense when
4061 generating DWARF2 debugging information with @option{-gdwarf-2}.
4062
4063 @item -femit-struct-debug-baseonly
4064 Emit debug information for struct-like types
4065 only when the base name of the compilation source file
4066 matches the base name of file in which the struct was defined.
4067
4068 This option substantially reduces the size of debugging information,
4069 but at significant potential loss in type information to the debugger.
4070 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4071 See @option{-femit-struct-debug-detailed} for more detailed control.
4072
4073 This option works only with DWARF 2.
4074
4075 @item -femit-struct-debug-reduced
4076 Emit debug information for struct-like types
4077 only when the base name of the compilation source file
4078 matches the base name of file in which the type was defined,
4079 unless the struct is a template or defined in a system header.
4080
4081 This option significantly reduces the size of debugging information,
4082 with some potential loss in type information to the debugger.
4083 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4084 See @option{-femit-struct-debug-detailed} for more detailed control.
4085
4086 This option works only with DWARF 2.
4087
4088 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4089 Specify the struct-like types
4090 for which the compiler will generate debug information.
4091 The intent is to reduce duplicate struct debug information
4092 between different object files within the same program.
4093
4094 This option is a detailed version of
4095 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4096 which will serve for most needs.
4097
4098 A specification has the syntax
4099 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4100
4101 The optional first word limits the specification to
4102 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4103 A struct type is used directly when it is the type of a variable, member.
4104 Indirect uses arise through pointers to structs.
4105 That is, when use of an incomplete struct would be legal, the use is indirect.
4106 An example is
4107 @samp{struct one direct; struct two * indirect;}.
4108
4109 The optional second word limits the specification to
4110 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4111 Generic structs are a bit complicated to explain.
4112 For C++, these are non-explicit specializations of template classes,
4113 or non-template classes within the above.
4114 Other programming languages have generics,
4115 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4116
4117 The third word specifies the source files for those
4118 structs for which the compiler will emit debug information.
4119 The values @samp{none} and @samp{any} have the normal meaning.
4120 The value @samp{base} means that
4121 the base of name of the file in which the type declaration appears
4122 must match the base of the name of the main compilation file.
4123 In practice, this means that
4124 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4125 but types declared in other header will not.
4126 The value @samp{sys} means those types satisfying @samp{base}
4127 or declared in system or compiler headers.
4128
4129 You may need to experiment to determine the best settings for your application.
4130
4131 The default is @samp{-femit-struct-debug-detailed=all}.
4132
4133 This option works only with DWARF 2.
4134
4135 @cindex @command{prof}
4136 @item -p
4137 @opindex p
4138 Generate extra code to write profile information suitable for the
4139 analysis program @command{prof}.  You must use this option when compiling
4140 the source files you want data about, and you must also use it when
4141 linking.
4142
4143 @cindex @command{gprof}
4144 @item -pg
4145 @opindex pg
4146 Generate extra code to write profile information suitable for the
4147 analysis program @command{gprof}.  You must use this option when compiling
4148 the source files you want data about, and you must also use it when
4149 linking.
4150
4151 @item -Q
4152 @opindex Q
4153 Makes the compiler print out each function name as it is compiled, and
4154 print some statistics about each pass when it finishes.
4155
4156 @item -ftime-report
4157 @opindex ftime-report
4158 Makes the compiler print some statistics about the time consumed by each
4159 pass when it finishes.
4160
4161 @item -fmem-report
4162 @opindex fmem-report
4163 Makes the compiler print some statistics about permanent memory
4164 allocation when it finishes.
4165
4166 @item -fpre-ipa-mem-report
4167 @opindex fpre-ipa-mem-report
4168 @item -fpost-ipa-mem-report
4169 @opindex fpost-ipa-mem-report
4170 Makes the compiler print some statistics about permanent memory
4171 allocation before or after interprocedural optimization.
4172
4173 @item -fprofile-arcs
4174 @opindex fprofile-arcs
4175 Add code so that program flow @dfn{arcs} are instrumented.  During
4176 execution the program records how many times each branch and call is
4177 executed and how many times it is taken or returns.  When the compiled
4178 program exits it saves this data to a file called
4179 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4180 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4181 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4182 @var{auxname} is generated from the name of the output file, if
4183 explicitly specified and it is not the final executable, otherwise it is
4184 the basename of the source file.  In both cases any suffix is removed
4185 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4186 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4187 @xref{Cross-profiling}.
4188
4189 @cindex @command{gcov}
4190 @item --coverage
4191 @opindex coverage
4192
4193 This option is used to compile and link code instrumented for coverage
4194 analysis.  The option is a synonym for @option{-fprofile-arcs}
4195 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4196 linking).  See the documentation for those options for more details.
4197
4198 @itemize
4199
4200 @item
4201 Compile the source files with @option{-fprofile-arcs} plus optimization
4202 and code generation options.  For test coverage analysis, use the
4203 additional @option{-ftest-coverage} option.  You do not need to profile
4204 every source file in a program.
4205
4206 @item
4207 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4208 (the latter implies the former).
4209
4210 @item
4211 Run the program on a representative workload to generate the arc profile
4212 information.  This may be repeated any number of times.  You can run
4213 concurrent instances of your program, and provided that the file system
4214 supports locking, the data files will be correctly updated.  Also
4215 @code{fork} calls are detected and correctly handled (double counting
4216 will not happen).
4217
4218 @item
4219 For profile-directed optimizations, compile the source files again with
4220 the same optimization and code generation options plus
4221 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4222 Control Optimization}).
4223
4224 @item
4225 For test coverage analysis, use @command{gcov} to produce human readable
4226 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4227 @command{gcov} documentation for further information.
4228
4229 @end itemize
4230
4231 With @option{-fprofile-arcs}, for each function of your program GCC
4232 creates a program flow graph, then finds a spanning tree for the graph.
4233 Only arcs that are not on the spanning tree have to be instrumented: the
4234 compiler adds code to count the number of times that these arcs are
4235 executed.  When an arc is the only exit or only entrance to a block, the
4236 instrumentation code can be added to the block; otherwise, a new basic
4237 block must be created to hold the instrumentation code.
4238
4239 @need 2000
4240 @item -ftest-coverage
4241 @opindex ftest-coverage
4242 Produce a notes file that the @command{gcov} code-coverage utility
4243 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4244 show program coverage.  Each source file's note file is called
4245 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4246 above for a description of @var{auxname} and instructions on how to
4247 generate test coverage data.  Coverage data will match the source files
4248 more closely, if you do not optimize.
4249
4250 @item -fdbg-cnt-list
4251 @opindex fdbg-cnt-list
4252 Print the name and the counter upperbound for all debug counters.
4253
4254 @item -fdbg-cnt=@var{counter-value-list}
4255 @opindex fdbg-cnt
4256 Set the internal debug counter upperbound. @var{counter-value-list} 
4257 is a comma-separated list of @var{name}:@var{value} pairs
4258 which sets the upperbound of each debug counter @var{name} to @var{value}.
4259 All debug counters have the initial upperbound of @var{UINT_MAX},
4260 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4261 e.g. With -fdbg-cnt=dce:10,tail_call:0
4262 dbg_cnt(dce) will return true only for first 10 invocations
4263 and dbg_cnt(tail_call) will return false always.
4264
4265 @item -d@var{letters}
4266 @item -fdump-rtl-@var{pass}
4267 @opindex d
4268 Says to make debugging dumps during compilation at times specified by
4269 @var{letters}.    This is used for debugging the RTL-based passes of the
4270 compiler.  The file names for most of the dumps are made by appending a
4271 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4272 from the name of the output file, if explicitly specified and it is not
4273 an executable, otherwise it is the basename of the source file.
4274
4275 Most debug dumps can be enabled either passing a letter to the @option{-d}
4276 option, or with a long @option{-fdump-rtl} switch; here are the possible
4277 letters for use in @var{letters} and @var{pass}, and their meanings:
4278
4279 @table @gcctabopt
4280 @item -dA
4281 @opindex dA
4282 Annotate the assembler output with miscellaneous debugging information.
4283
4284 @item -dB
4285 @itemx -fdump-rtl-bbro
4286 @opindex dB
4287 @opindex fdump-rtl-bbro
4288 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4289
4290 @item -dc
4291 @itemx -fdump-rtl-combine
4292 @opindex dc
4293 @opindex fdump-rtl-combine
4294 Dump after the RTL instruction combination pass, to the file
4295 @file{@var{file}.129r.combine}.
4296
4297 @item -dC
4298 @itemx -fdump-rtl-ce1
4299 @itemx -fdump-rtl-ce2
4300 @opindex dC
4301 @opindex fdump-rtl-ce1
4302 @opindex fdump-rtl-ce2
4303 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
4304 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
4305 and @option{-fdump-rtl-ce2} enable dumping after the second if
4306 conversion, to the file @file{@var{file}.130r.ce2}.
4307
4308 @item -dd
4309 @itemx -fdump-rtl-btl
4310 @itemx -fdump-rtl-dbr
4311 @opindex dd
4312 @opindex fdump-rtl-btl
4313 @opindex fdump-rtl-dbr
4314 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
4315 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
4316 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
4317 scheduling, to @file{@var{file}.36.dbr}.
4318
4319 @item -dD
4320 @opindex dD
4321 Dump all macro definitions, at the end of preprocessing, in addition to
4322 normal output.
4323
4324 @item -dE
4325 @itemx -fdump-rtl-ce3
4326 @opindex dE
4327 @opindex fdump-rtl-ce3
4328 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4329
4330 @item -df
4331 @itemx -fdump-rtl-cfg
4332 @itemx -fdump-rtl-life
4333 @opindex df
4334 @opindex fdump-rtl-cfg
4335 @opindex fdump-rtl-life
4336 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
4337 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
4338 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4339 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4340
4341 @item -dg
4342 @itemx -fdump-rtl-greg
4343 @opindex dg
4344 @opindex fdump-rtl-greg
4345 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4346
4347 @item -dG
4348 @itemx -fdump-rtl-gcse
4349 @itemx -fdump-rtl-bypass
4350 @opindex dG
4351 @opindex fdump-rtl-gcse
4352 @opindex fdump-rtl-bypass
4353 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4354 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
4355 enable dumping after jump bypassing and control flow optimizations, to
4356 @file{@var{file}.115r.bypass}.
4357
4358 @item -dh
4359 @itemx -fdump-rtl-eh
4360 @opindex dh
4361 @opindex fdump-rtl-eh
4362 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4363
4364 @item -di
4365 @itemx -fdump-rtl-sibling
4366 @opindex di
4367 @opindex fdump-rtl-sibling
4368 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4369
4370 @item -dj
4371 @itemx -fdump-rtl-jump
4372 @opindex dj
4373 @opindex fdump-rtl-jump
4374 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4375
4376 @item -dk
4377 @itemx -fdump-rtl-stack
4378 @opindex dk
4379 @opindex fdump-rtl-stack
4380 Dump after conversion from GCC's "flat register file" registers to the
4381 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4382
4383 @item -dl
4384 @itemx -fdump-rtl-lreg
4385 @opindex dl
4386 @opindex fdump-rtl-lreg
4387 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4388
4389 @item -dL
4390 @itemx -fdump-rtl-loop2
4391 @opindex dL
4392 @opindex fdump-rtl-loop2
4393 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4394 loop optimization pass, to @file{@var{file}.119r.loop2},
4395 @file{@var{file}.120r.loop2_init},
4396 @file{@var{file}.121r.loop2_invariant}, and
4397 @file{@var{file}.125r.loop2_done}.
4398
4399 @item -dm
4400 @itemx -fdump-rtl-sms
4401 @opindex dm
4402 @opindex fdump-rtl-sms
4403 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4404
4405 @item -dM
4406 @itemx -fdump-rtl-mach
4407 @opindex dM
4408 @opindex fdump-rtl-mach
4409 Dump after performing the machine dependent reorganization pass, to
4410 @file{@var{file}.155r.mach}.
4411
4412 @item -dn
4413 @itemx -fdump-rtl-rnreg
4414 @opindex dn
4415 @opindex fdump-rtl-rnreg
4416 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4417
4418 @item -dN
4419 @itemx -fdump-rtl-regmove
4420 @opindex dN
4421 @opindex fdump-rtl-regmove
4422 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4423
4424 @item -do
4425 @itemx -fdump-rtl-postreload
4426 @opindex do
4427 @opindex fdump-rtl-postreload
4428 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4429
4430 @item -dr
4431 @itemx -fdump-rtl-expand
4432 @opindex dr
4433 @opindex fdump-rtl-expand
4434 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4435
4436 @item -dR
4437 @itemx -fdump-rtl-sched2
4438 @opindex dR
4439 @opindex fdump-rtl-sched2
4440 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4441
4442 @item -ds
4443 @itemx -fdump-rtl-cse
4444 @opindex ds
4445 @opindex fdump-rtl-cse
4446 Dump after CSE (including the jump optimization that sometimes follows
4447 CSE), to @file{@var{file}.113r.cse}.
4448
4449 @item -dS
4450 @itemx -fdump-rtl-sched1
4451 @opindex dS
4452 @opindex fdump-rtl-sched1
4453 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4454
4455 @item -dt
4456 @itemx -fdump-rtl-cse2
4457 @opindex dt
4458 @opindex fdump-rtl-cse2
4459 Dump after the second CSE pass (including the jump optimization that
4460 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4461
4462 @item -dT
4463 @itemx -fdump-rtl-tracer
4464 @opindex dT
4465 @opindex fdump-rtl-tracer
4466 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4467
4468 @item -dV
4469 @itemx -fdump-rtl-vpt
4470 @itemx -fdump-rtl-vartrack
4471 @opindex dV
4472 @opindex fdump-rtl-vpt
4473 @opindex fdump-rtl-vartrack
4474 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4475 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4476 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4477 to @file{@var{file}.154r.vartrack}.
4478
4479 @item -dw
4480 @itemx -fdump-rtl-flow2
4481 @opindex dw
4482 @opindex fdump-rtl-flow2
4483 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4484
4485 @item -dz
4486 @itemx -fdump-rtl-peephole2
4487 @opindex dz
4488 @opindex fdump-rtl-peephole2
4489 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4490
4491 @item -dZ
4492 @itemx -fdump-rtl-web
4493 @opindex dZ
4494 @opindex fdump-rtl-web
4495 Dump after live range splitting, to @file{@var{file}.126r.web}.
4496
4497 @item -da
4498 @itemx -fdump-rtl-all
4499 @opindex da
4500 @opindex fdump-rtl-all
4501 Produce all the dumps listed above.
4502
4503 @item -dH
4504 @opindex dH
4505 Produce a core dump whenever an error occurs.
4506
4507 @item -dm
4508 @opindex dm
4509 Print statistics on memory usage, at the end of the run, to
4510 standard error.
4511
4512 @item -dp
4513 @opindex dp
4514 Annotate the assembler output with a comment indicating which
4515 pattern and alternative was used.  The length of each instruction is
4516 also printed.
4517
4518 @item -dP
4519 @opindex dP
4520 Dump the RTL in the assembler output as a comment before each instruction.
4521 Also turns on @option{-dp} annotation.
4522
4523 @item -dv
4524 @opindex dv
4525 For each of the other indicated dump files (either with @option{-d} or
4526 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4527 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4528
4529 @item -dx
4530 @opindex dx
4531 Just generate RTL for a function instead of compiling it.  Usually used
4532 with @samp{r} (@option{-fdump-rtl-expand}).
4533
4534 @item -dy
4535 @opindex dy
4536 Dump debugging information during parsing, to standard error.
4537 @end table
4538
4539 @item -fdump-noaddr
4540 @opindex fdump-noaddr
4541 When doing debugging dumps (see @option{-d} option above), suppress
4542 address output.  This makes it more feasible to use diff on debugging
4543 dumps for compiler invocations with different compiler binaries and/or
4544 different text / bss / data / heap / stack / dso start locations.
4545
4546 @item -fdump-unnumbered
4547 @opindex fdump-unnumbered
4548 When doing debugging dumps (see @option{-d} option above), suppress instruction
4549 numbers and address output.  This makes it more feasible to
4550 use diff on debugging dumps for compiler invocations with different
4551 options, in particular with and without @option{-g}.
4552
4553 @item -fdump-translation-unit @r{(C++ only)}
4554 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4555 @opindex fdump-translation-unit
4556 Dump a representation of the tree structure for the entire translation
4557 unit to a file.  The file name is made by appending @file{.tu} to the
4558 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4559 controls the details of the dump as described for the
4560 @option{-fdump-tree} options.
4561
4562 @item -fdump-class-hierarchy @r{(C++ only)}
4563 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4564 @opindex fdump-class-hierarchy
4565 Dump a representation of each class's hierarchy and virtual function
4566 table layout to a file.  The file name is made by appending @file{.class}
4567 to the source file name.  If the @samp{-@var{options}} form is used,
4568 @var{options} controls the details of the dump as described for the
4569 @option{-fdump-tree} options.
4570
4571 @item -fdump-ipa-@var{switch}
4572 @opindex fdump-ipa
4573 Control the dumping at various stages of inter-procedural analysis
4574 language tree to a file.  The file name is generated by appending a switch
4575 specific suffix to the source file name.  The following dumps are possible:
4576
4577 @table @samp
4578 @item all
4579 Enables all inter-procedural analysis dumps; currently the only produced
4580 dump is the @samp{cgraph} dump.
4581
4582 @item cgraph
4583 Dumps information about call-graph optimization, unused function removal,
4584 and inlining decisions.
4585 @end table
4586
4587 @item -fdump-tree-@var{switch}
4588 @itemx -fdump-tree-@var{switch}-@var{options}
4589 @opindex fdump-tree
4590 Control the dumping at various stages of processing the intermediate
4591 language tree to a file.  The file name is generated by appending a switch
4592 specific suffix to the source file name.  If the @samp{-@var{options}}
4593 form is used, @var{options} is a list of @samp{-} separated options that
4594 control the details of the dump.  Not all options are applicable to all
4595 dumps, those which are not meaningful will be ignored.  The following
4596 options are available
4597
4598 @table @samp
4599 @item address
4600 Print the address of each node.  Usually this is not meaningful as it
4601 changes according to the environment and source file.  Its primary use
4602 is for tying up a dump file with a debug environment.
4603 @item slim
4604 Inhibit dumping of members of a scope or body of a function merely
4605 because that scope has been reached.  Only dump such items when they
4606 are directly reachable by some other path.  When dumping pretty-printed
4607 trees, this option inhibits dumping the bodies of control structures.
4608 @item raw
4609 Print a raw representation of the tree.  By default, trees are
4610 pretty-printed into a C-like representation.
4611 @item details
4612 Enable more detailed dumps (not honored by every dump option).
4613 @item stats
4614 Enable dumping various statistics about the pass (not honored by every dump
4615 option).
4616 @item blocks
4617 Enable showing basic block boundaries (disabled in raw dumps).
4618 @item vops
4619 Enable showing virtual operands for every statement.
4620 @item lineno
4621 Enable showing line numbers for statements.
4622 @item uid
4623 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4624 @item all
4625 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4626 @end table
4627
4628 The following tree dumps are possible:
4629 @table @samp
4630
4631 @item original
4632 Dump before any tree based optimization, to @file{@var{file}.original}.
4633
4634 @item optimized
4635 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4636
4637 @item inlined
4638 Dump after function inlining, to @file{@var{file}.inlined}.
4639
4640 @item gimple
4641 @opindex fdump-tree-gimple
4642 Dump each function before and after the gimplification pass to a file.  The
4643 file name is made by appending @file{.gimple} to the source file name.
4644
4645 @item cfg
4646 @opindex fdump-tree-cfg
4647 Dump the control flow graph of each function to a file.  The file name is
4648 made by appending @file{.cfg} to the source file name.
4649
4650 @item vcg
4651 @opindex fdump-tree-vcg
4652 Dump the control flow graph of each function to a file in VCG format.  The
4653 file name is made by appending @file{.vcg} to the source file name.  Note
4654 that if the file contains more than one function, the generated file cannot
4655 be used directly by VCG@.  You will need to cut and paste each function's
4656 graph into its own separate file first.
4657
4658 @item ch
4659 @opindex fdump-tree-ch
4660 Dump each function after copying loop headers.  The file name is made by
4661 appending @file{.ch} to the source file name.
4662
4663 @item ssa
4664 @opindex fdump-tree-ssa
4665 Dump SSA related information to a file.  The file name is made by appending
4666 @file{.ssa} to the source file name.
4667
4668 @item salias
4669 @opindex fdump-tree-salias
4670 Dump structure aliasing variable information to a file.  This file name
4671 is made by appending @file{.salias} to the source file name.
4672
4673 @item alias
4674 @opindex fdump-tree-alias
4675 Dump aliasing information for each function.  The file name is made by
4676 appending @file{.alias} to the source file name.
4677
4678 @item ccp
4679 @opindex fdump-tree-ccp
4680 Dump each function after CCP@.  The file name is made by appending
4681 @file{.ccp} to the source file name.
4682
4683 @item storeccp
4684 @opindex fdump-tree-storeccp
4685 Dump each function after STORE-CCP.  The file name is made by appending
4686 @file{.storeccp} to the source file name.
4687
4688 @item pre
4689 @opindex fdump-tree-pre
4690 Dump trees after partial redundancy elimination.  The file name is made
4691 by appending @file{.pre} to the source file name.
4692
4693 @item fre
4694 @opindex fdump-tree-fre
4695 Dump trees after full redundancy elimination.  The file name is made
4696 by appending @file{.fre} to the source file name.
4697
4698 @item copyprop
4699 @opindex fdump-tree-copyprop
4700 Dump trees after copy propagation.  The file name is made
4701 by appending @file{.copyprop} to the source file name.
4702
4703 @item store_copyprop
4704 @opindex fdump-tree-store_copyprop
4705 Dump trees after store copy-propagation.  The file name is made
4706 by appending @file{.store_copyprop} to the source file name.
4707
4708 @item dce
4709 @opindex fdump-tree-dce
4710 Dump each function after dead code elimination.  The file name is made by
4711 appending @file{.dce} to the source file name.
4712
4713 @item mudflap
4714 @opindex fdump-tree-mudflap
4715 Dump each function after adding mudflap instrumentation.  The file name is
4716 made by appending @file{.mudflap} to the source file name.
4717
4718 @item sra
4719 @opindex fdump-tree-sra
4720 Dump each function after performing scalar replacement of aggregates.  The
4721 file name is made by appending @file{.sra} to the source file name.
4722
4723 @item sink
4724 @opindex fdump-tree-sink
4725 Dump each function after performing code sinking.  The file name is made
4726 by appending @file{.sink} to the source file name.
4727
4728 @item dom
4729 @opindex fdump-tree-dom
4730 Dump each function after applying dominator tree optimizations.  The file
4731 name is made by appending @file{.dom} to the source file name.
4732
4733 @item dse
4734 @opindex fdump-tree-dse
4735 Dump each function after applying dead store elimination.  The file
4736 name is made by appending @file{.dse} to the source file name.
4737
4738 @item phiopt
4739 @opindex fdump-tree-phiopt
4740 Dump each function after optimizing PHI nodes into straightline code.  The file
4741 name is made by appending @file{.phiopt} to the source file name.
4742
4743 @item forwprop
4744 @opindex fdump-tree-forwprop
4745 Dump each function after forward propagating single use variables.  The file
4746 name is made by appending @file{.forwprop} to the source file name.
4747
4748 @item copyrename
4749 @opindex fdump-tree-copyrename
4750 Dump each function after applying the copy rename optimization.  The file
4751 name is made by appending @file{.copyrename} to the source file name.
4752
4753 @item nrv
4754 @opindex fdump-tree-nrv
4755 Dump each function after applying the named return value optimization on
4756 generic trees.  The file name is made by appending @file{.nrv} to the source
4757 file name.
4758
4759 @item vect
4760 @opindex fdump-tree-vect
4761 Dump each function after applying vectorization of loops.  The file name is
4762 made by appending @file{.vect} to the source file name.
4763
4764 @item vrp
4765 @opindex fdump-tree-vrp
4766 Dump each function after Value Range Propagation (VRP).  The file name
4767 is made by appending @file{.vrp} to the source file name.
4768
4769 @item all
4770 @opindex fdump-tree-all
4771 Enable all the available tree dumps with the flags provided in this option.
4772 @end table
4773
4774 @item -ftree-vectorizer-verbose=@var{n}
4775 @opindex ftree-vectorizer-verbose
4776 This option controls the amount of debugging output the vectorizer prints.
4777 This information is written to standard error, unless
4778 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4779 in which case it is output to the usual dump listing file, @file{.vect}.
4780 For @var{n}=0 no diagnostic information is reported.
4781 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4782 and the total number of loops that got vectorized.
4783 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4784 the first analysis phase (vect_analyze_loop_form) - i.e. countable,
4785 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4786 level that @option{-fdump-tree-vect-stats} uses.
4787 Higher verbosity levels mean either more information dumped for each
4788 reported loop, or same amount of information reported for more loops:
4789 If @var{n}=3, alignment related information is added to the reports.
4790 If @var{n}=4, data-references related information (e.g. memory dependences,
4791 memory access-patterns) is added to the reports.
4792 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4793 that did not pass the first analysis phase (i.e. may not be countable, or
4794 may have complicated control-flow).
4795 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4796 For @var{n}=7, all the information the vectorizer generates during its
4797 analysis and transformation is reported.  This is the same verbosity level
4798 that @option{-fdump-tree-vect-details} uses.
4799
4800 @item -frandom-seed=@var{string}
4801 @opindex frandom-string
4802 This option provides a seed that GCC uses when it would otherwise use
4803 random numbers.  It is used to generate certain symbol names
4804 that have to be different in every compiled file.  It is also used to
4805 place unique stamps in coverage data files and the object files that
4806 produce them.  You can use the @option{-frandom-seed} option to produce
4807 reproducibly identical object files.
4808
4809 The @var{string} should be different for every file you compile.
4810
4811 @item -fsched-verbose=@var{n}
4812 @opindex fsched-verbose
4813 On targets that use instruction scheduling, this option controls the
4814 amount of debugging output the scheduler prints.  This information is
4815 written to standard error, unless @option{-dS} or @option{-dR} is
4816 specified, in which case it is output to the usual dump
4817 listing file, @file{.sched} or @file{.sched2} respectively.  However
4818 for @var{n} greater than nine, the output is always printed to standard
4819 error.
4820
4821 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4822 same information as @option{-dRS}.  For @var{n} greater than one, it
4823 also output basic block probabilities, detailed ready list information
4824 and unit/insn info.  For @var{n} greater than two, it includes RTL
4825 at abort point, control-flow and regions info.  And for @var{n} over
4826 four, @option{-fsched-verbose} also includes dependence info.
4827
4828 @item -save-temps
4829 @opindex save-temps
4830 Store the usual ``temporary'' intermediate files permanently; place them
4831 in the current directory and name them based on the source file.  Thus,
4832 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4833 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4834 preprocessed @file{foo.i} output file even though the compiler now
4835 normally uses an integrated preprocessor.
4836
4837 When used in combination with the @option{-x} command line option,
4838 @option{-save-temps} is sensible enough to avoid over writing an
4839 input source file with the same extension as an intermediate file.
4840 The corresponding intermediate file may be obtained by renaming the
4841 source file before using @option{-save-temps}.
4842
4843 @item -time
4844 @opindex time
4845 Report the CPU time taken by each subprocess in the compilation
4846 sequence.  For C source files, this is the compiler proper and assembler
4847 (plus the linker if linking is done).  The output looks like this:
4848
4849 @smallexample
4850 # cc1 0.12 0.01
4851 # as 0.00 0.01
4852 @end smallexample
4853
4854 The first number on each line is the ``user time'', that is time spent
4855 executing the program itself.  The second number is ``system time'',
4856 time spent executing operating system routines on behalf of the program.
4857 Both numbers are in seconds.
4858
4859 @item -fvar-tracking
4860 @opindex fvar-tracking
4861 Run variable tracking pass.  It computes where variables are stored at each
4862 position in code.  Better debugging information is then generated
4863 (if the debugging information format supports this information).
4864
4865 It is enabled by default when compiling with optimization (@option{-Os},
4866 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4867 the debug info format supports it.
4868
4869 @item -print-file-name=@var{library}
4870 @opindex print-file-name
4871 Print the full absolute name of the library file @var{library} that
4872 would be used when linking---and don't do anything else.  With this
4873 option, GCC does not compile or link anything; it just prints the
4874 file name.
4875
4876 @item -print-multi-directory
4877 @opindex print-multi-directory
4878 Print the directory name corresponding to the multilib selected by any
4879 other switches present in the command line.  This directory is supposed
4880 to exist in @env{GCC_EXEC_PREFIX}.
4881
4882 @item -print-multi-lib
4883 @opindex print-multi-lib
4884 Print the mapping from multilib directory names to compiler switches
4885 that enable them.  The directory name is separated from the switches by
4886 @samp{;}, and each switch starts with an @samp{@@} instead of the
4887 @samp{-}, without spaces between multiple switches.  This is supposed to
4888 ease shell-processing.
4889
4890 @item -print-prog-name=@var{program}
4891 @opindex print-prog-name
4892 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4893
4894 @item -print-libgcc-file-name
4895 @opindex print-libgcc-file-name
4896 Same as @option{-print-file-name=libgcc.a}.
4897
4898 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4899 but you do want to link with @file{libgcc.a}.  You can do
4900
4901 @smallexample
4902 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4903 @end smallexample
4904
4905 @item -print-search-dirs
4906 @opindex print-search-dirs
4907 Print the name of the configured installation directory and a list of
4908 program and library directories @command{gcc} will search---and don't do anything else.
4909
4910 This is useful when @command{gcc} prints the error message
4911 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4912 To resolve this you either need to put @file{cpp0} and the other compiler
4913 components where @command{gcc} expects to find them, or you can set the environment
4914 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4915 Don't forget the trailing @samp{/}.
4916 @xref{Environment Variables}.
4917
4918 @item -print-sysroot-headers-suffix
4919 @opindex print-sysroot-headers-suffix
4920 Print the suffix added to the target sysroot when searching for
4921 headers, or give an error if the compiler is not configured with such
4922 a suffix---and don't do anything else.
4923
4924 @item -dumpmachine
4925 @opindex dumpmachine
4926 Print the compiler's target machine (for example,
4927 @samp{i686-pc-linux-gnu})---and don't do anything else.
4928
4929 @item -dumpversion
4930 @opindex dumpversion
4931 Print the compiler version (for example, @samp{3.0})---and don't do
4932 anything else.
4933
4934 @item -dumpspecs
4935 @opindex dumpspecs
4936 Print the compiler's built-in specs---and don't do anything else.  (This
4937 is used when GCC itself is being built.)  @xref{Spec Files}.
4938
4939 @item -feliminate-unused-debug-types
4940 @opindex feliminate-unused-debug-types
4941 Normally, when producing DWARF2 output, GCC will emit debugging
4942 information for all types declared in a compilation
4943 unit, regardless of whether or not they are actually used
4944 in that compilation unit.  Sometimes this is useful, such as
4945 if, in the debugger, you want to cast a value to a type that is
4946 not actually used in your program (but is declared).  More often,
4947 however, this results in a significant amount of wasted space.
4948 With this option, GCC will avoid producing debug symbol output
4949 for types that are nowhere used in the source file being compiled.
4950 @end table
4951
4952 @node Optimize Options
4953 @section Options That Control Optimization
4954 @cindex optimize options
4955 @cindex options, optimization
4956
4957 These options control various sorts of optimizations.
4958
4959 Without any optimization option, the compiler's goal is to reduce the
4960 cost of compilation and to make debugging produce the expected
4961 results.  Statements are independent: if you stop the program with a
4962 breakpoint between statements, you can then assign a new value to any
4963 variable or change the program counter to any other statement in the
4964 function and get exactly the results you would expect from the source
4965 code.
4966
4967 Turning on optimization flags makes the compiler attempt to improve
4968 the performance and/or code size at the expense of compilation time
4969 and possibly the ability to debug the program.
4970
4971 The compiler performs optimization based on the knowledge it has of
4972 the program.  Optimization levels @option{-O} and above, in
4973 particular, enable @emph{unit-at-a-time} mode, which allows the
4974 compiler to consider information gained from later functions in
4975 the file when compiling a function.  Compiling multiple files at
4976 once to a single output file in @emph{unit-at-a-time} mode allows
4977 the compiler to use information gained from all of the files when
4978 compiling each of them.
4979
4980 Not all optimizations are controlled directly by a flag.  Only
4981 optimizations that have a flag are listed.
4982
4983 @table @gcctabopt
4984 @item -O
4985 @itemx -O1
4986 @opindex O
4987 @opindex O1
4988 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4989 more memory for a large function.
4990
4991 With @option{-O}, the compiler tries to reduce code size and execution
4992 time, without performing any optimizations that take a great deal of
4993 compilation time.
4994
4995 @option{-O} turns on the following optimization flags:
4996 @gccoptlist{-fdefer-pop @gol
4997 -fdelayed-branch @gol
4998 -fguess-branch-probability @gol
4999 -fcprop-registers @gol
5000 -fif-conversion @gol
5001 -fif-conversion2 @gol
5002 -fsplit-wide-types @gol
5003 -ftree-ccp @gol
5004 -ftree-dce @gol
5005 -ftree-dominator-opts @gol
5006 -ftree-dse @gol
5007 -ftree-ter @gol
5008 -ftree-sra @gol
5009 -ftree-copyrename @gol
5010 -ftree-fre @gol
5011 -ftree-ch @gol
5012 -funit-at-a-time @gol
5013 -fmerge-constants}
5014
5015 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5016 where doing so does not interfere with debugging.
5017
5018 @item -O2
5019 @opindex O2
5020 Optimize even more.  GCC performs nearly all supported optimizations
5021 that do not involve a space-speed tradeoff.  The compiler does not
5022 perform loop unrolling or function inlining when you specify @option{-O2}.
5023 As compared to @option{-O}, this option increases both compilation time
5024 and the performance of the generated code.
5025
5026 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5027 also turns on the following optimization flags:
5028 @gccoptlist{-fthread-jumps @gol
5029 -fcrossjumping @gol
5030 -foptimize-sibling-calls @gol
5031 -fcse-follow-jumps  -fcse-skip-blocks @gol
5032 -fgcse  -fgcse-lm  @gol
5033 -fexpensive-optimizations @gol
5034 -frerun-cse-after-loop  @gol
5035 -fcaller-saves @gol
5036 -fpeephole2 @gol
5037 -fschedule-insns  -fschedule-insns2 @gol
5038 -fsched-interblock  -fsched-spec @gol
5039 -fregmove @gol
5040 -fstrict-aliasing -fstrict-overflow @gol
5041 -fdelete-null-pointer-checks @gol
5042 -freorder-blocks  -freorder-functions @gol
5043 -falign-functions  -falign-jumps @gol
5044 -falign-loops  -falign-labels @gol
5045 -ftree-vrp @gol
5046 -ftree-pre}
5047
5048 Please note the warning under @option{-fgcse} about
5049 invoking @option{-O2} on programs that use computed gotos.
5050
5051 @item -O3
5052 @opindex O3
5053 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5054 @option{-O2} and also turns on the @option{-finline-functions},
5055 @option{-funswitch-loops}, @option{-fpredictive-commoning} and
5056 @option{-fgcse-after-reload} options.
5057
5058 @item -O0
5059 @opindex O0
5060 Reduce compilation time and make debugging produce the expected
5061 results.  This is the default.
5062
5063 @item -Os
5064 @opindex Os
5065 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5066 do not typically increase code size.  It also performs further
5067 optimizations designed to reduce code size.
5068
5069 @option{-Os} disables the following optimization flags:
5070 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5071 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5072 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5073
5074 If you use multiple @option{-O} options, with or without level numbers,
5075 the last such option is the one that is effective.
5076 @end table
5077
5078 Options of the form @option{-f@var{flag}} specify machine-independent
5079 flags.  Most flags have both positive and negative forms; the negative
5080 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5081 below, only one of the forms is listed---the one you typically will
5082 use.  You can figure out the other form by either removing @samp{no-}
5083 or adding it.
5084
5085 The following options control specific optimizations.  They are either
5086 activated by @option{-O} options or are related to ones that are.  You
5087 can use the following flags in the rare cases when ``fine-tuning'' of
5088 optimizations to be performed is desired.
5089
5090 @table @gcctabopt
5091 @item -fno-default-inline
5092 @opindex fno-default-inline
5093 Do not make member functions inline by default merely because they are
5094 defined inside the class scope (C++ only).  Otherwise, when you specify
5095 @w{@option{-O}}, member functions defined inside class scope are compiled
5096 inline by default; i.e., you don't need to add @samp{inline} in front of
5097 the member function name.
5098
5099 @item -fno-defer-pop
5100 @opindex fno-defer-pop
5101 Always pop the arguments to each function call as soon as that function
5102 returns.  For machines which must pop arguments after a function call,
5103 the compiler normally lets arguments accumulate on the stack for several
5104 function calls and pops them all at once.
5105
5106 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5107
5108 @item -fforce-addr
5109 @opindex fforce-addr
5110 Force memory address constants to be copied into registers before
5111 doing arithmetic on them.
5112
5113 @item -fforward-propagate
5114 @opindex fforward-propagate
5115 Perform a forward propagation pass on RTL.  The pass tries to combine two
5116 instructions and checks if the result can be simplified.  If loop unrolling
5117 is active, two passes are performed and the second is scheduled after
5118 loop unrolling.
5119
5120 This option is enabled by default at optimization levels @option{-O2},
5121 @option{-O3}, @option{-Os}.
5122
5123 @item -fomit-frame-pointer
5124 @opindex fomit-frame-pointer
5125 Don't keep the frame pointer in a register for functions that
5126 don't need one.  This avoids the instructions to save, set up and
5127 restore frame pointers; it also makes an extra register available
5128 in many functions.  @strong{It also makes debugging impossible on
5129 some machines.}
5130
5131 On some machines, such as the VAX, this flag has no effect, because
5132 the standard calling sequence automatically handles the frame pointer
5133 and nothing is saved by pretending it doesn't exist.  The
5134 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5135 whether a target machine supports this flag.  @xref{Registers,,Register
5136 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5137
5138 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5139
5140 @item -foptimize-sibling-calls
5141 @opindex foptimize-sibling-calls
5142 Optimize sibling and tail recursive calls.
5143
5144 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5145
5146 @item -fno-inline
5147 @opindex fno-inline
5148 Don't pay attention to the @code{inline} keyword.  Normally this option
5149 is used to keep the compiler from expanding any functions inline.
5150 Note that if you are not optimizing, no functions can be expanded inline.
5151
5152 @item -finline-functions
5153 @opindex finline-functions
5154 Integrate all simple functions into their callers.  The compiler
5155 heuristically decides which functions are simple enough to be worth
5156 integrating in this way.
5157
5158 If all calls to a given function are integrated, and the function is
5159 declared @code{static}, then the function is normally not output as
5160 assembler code in its own right.
5161
5162 Enabled at level @option{-O3}.
5163
5164 @item -finline-functions-called-once
5165 @opindex finline-functions-called-once
5166 Consider all @code{static} functions called once for inlining into their
5167 caller even if they are not marked @code{inline}.  If a call to a given
5168 function is integrated, then the function is not output as assembler code
5169 in its own right.
5170
5171 Enabled if @option{-funit-at-a-time} is enabled.
5172
5173 @item -fearly-inlining
5174 @opindex fearly-inlining
5175 Inline functions marked by @code{always_inline} and functions whose body seems
5176 smaller than the function call overhead early before doing
5177 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5178 makes profiling significantly cheaper and usually inlining faster on programs
5179 having large chains of nested wrapper functions.
5180
5181 Enabled by default.
5182
5183 @item -finline-limit=@var{n}
5184 @opindex finline-limit
5185 By default, GCC limits the size of functions that can be inlined.  This flag
5186 allows the control of this limit for functions that are explicitly marked as
5187 inline (i.e., marked with the inline keyword or defined within the class
5188 definition in c++).  @var{n} is the size of functions that can be inlined in
5189 number of pseudo instructions (not counting parameter handling).  The default
5190 value of @var{n} is 600.
5191 Increasing this value can result in more inlined code at
5192 the cost of compilation time and memory consumption.  Decreasing usually makes
5193 the compilation faster and less code will be inlined (which presumably
5194 means slower programs).  This option is particularly useful for programs that
5195 use inlining heavily such as those based on recursive templates with C++.
5196
5197 Inlining is actually controlled by a number of parameters, which may be
5198 specified individually by using @option{--param @var{name}=@var{value}}.
5199 The @option{-finline-limit=@var{n}} option sets some of these parameters
5200 as follows:
5201
5202 @table @gcctabopt
5203 @item max-inline-insns-single
5204  is set to @var{n}/2.
5205 @item max-inline-insns-auto
5206  is set to @var{n}/2.
5207 @item min-inline-insns
5208  is set to 130 or @var{n}/4, whichever is smaller.
5209 @item max-inline-insns-rtl
5210  is set to @var{n}.
5211 @end table
5212
5213 See below for a documentation of the individual
5214 parameters controlling inlining.
5215
5216 @emph{Note:} pseudo instruction represents, in this particular context, an
5217 abstract measurement of function's size.  In no way does it represent a count
5218 of assembly instructions and as such its exact meaning might change from one
5219 release to an another.
5220
5221 @item -fkeep-inline-functions
5222 @opindex fkeep-inline-functions
5223 In C, emit @code{static} functions that are declared @code{inline}
5224 into the object file, even if the function has been inlined into all
5225 of its callers.  This switch does not affect functions using the
5226 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5227 inline functions into the object file.
5228
5229 @item -fkeep-static-consts
5230 @opindex fkeep-static-consts
5231 Emit variables declared @code{static const} when optimization isn't turned
5232 on, even if the variables aren't referenced.
5233
5234 GCC enables this option by default.  If you want to force the compiler to
5235 check if the variable was referenced, regardless of whether or not
5236 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5237
5238 @item -fmerge-constants
5239 Attempt to merge identical constants (string constants and floating point
5240 constants) across compilation units.
5241
5242 This option is the default for optimized compilation if the assembler and
5243 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5244 behavior.
5245
5246 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5247
5248 @item -fmerge-all-constants
5249 Attempt to merge identical constants and identical variables.
5250
5251 This option implies @option{-fmerge-constants}.  In addition to
5252 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5253 arrays or initialized constant variables with integral or floating point
5254 types.  Languages like C or C++ require each non-automatic variable to
5255 have distinct location, so using this option will result in non-conforming
5256 behavior.
5257
5258 @item -fmodulo-sched
5259 @opindex fmodulo-sched
5260 Perform swing modulo scheduling immediately before the first scheduling
5261 pass.  This pass looks at innermost loops and reorders their
5262 instructions by overlapping different iterations.
5263
5264 @item -fno-branch-count-reg
5265 @opindex fno-branch-count-reg
5266 Do not use ``decrement and branch'' instructions on a count register,
5267 but instead generate a sequence of instructions that decrement a
5268 register, compare it against zero, then branch based upon the result.
5269 This option is only meaningful on architectures that support such
5270 instructions, which include x86, PowerPC, IA-64 and S/390.
5271
5272 The default is @option{-fbranch-count-reg}.
5273
5274 @item -fno-function-cse
5275 @opindex fno-function-cse
5276 Do not put function addresses in registers; make each instruction that
5277 calls a constant function contain the function's address explicitly.
5278
5279 This option results in less efficient code, but some strange hacks
5280 that alter the assembler output may be confused by the optimizations
5281 performed when this option is not used.
5282
5283 The default is @option{-ffunction-cse}
5284
5285 @item -fno-zero-initialized-in-bss
5286 @opindex fno-zero-initialized-in-bss
5287 If the target supports a BSS section, GCC by default puts variables that
5288 are initialized to zero into BSS@.  This can save space in the resulting
5289 code.
5290
5291 This option turns off this behavior because some programs explicitly
5292 rely on variables going to the data section.  E.g., so that the
5293 resulting executable can find the beginning of that section and/or make
5294 assumptions based on that.
5295
5296 The default is @option{-fzero-initialized-in-bss}.
5297
5298 @item -fbounds-check
5299 @opindex fbounds-check
5300 For front-ends that support it, generate additional code to check that
5301 indices used to access arrays are within the declared range.  This is
5302 currently only supported by the Java and Fortran front-ends, where
5303 this option defaults to true and false respectively.
5304
5305 @item -fmudflap -fmudflapth -fmudflapir
5306 @opindex fmudflap
5307 @opindex fmudflapth
5308 @opindex fmudflapir
5309 @cindex bounds checking
5310 @cindex mudflap
5311 For front-ends that support it (C and C++), instrument all risky
5312 pointer/array dereferencing operations, some standard library
5313 string/heap functions, and some other associated constructs with
5314 range/validity tests.  Modules so instrumented should be immune to
5315 buffer overflows, invalid heap use, and some other classes of C/C++
5316 programming errors.  The instrumentation relies on a separate runtime
5317 library (@file{libmudflap}), which will be linked into a program if
5318 @option{-fmudflap} is given at link time.  Run-time behavior of the
5319 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5320 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5321 for its options.
5322
5323 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5324 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5325 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5326 instrumentation should ignore pointer reads.  This produces less
5327 instrumentation (and therefore faster execution) and still provides
5328 some protection against outright memory corrupting writes, but allows
5329 erroneously read data to propagate within a program.
5330
5331 @item -fthread-jumps
5332 @opindex fthread-jumps
5333 Perform optimizations where we check to see if a jump branches to a
5334 location where another comparison subsumed by the first is found.  If
5335 so, the first branch is redirected to either the destination of the
5336 second branch or a point immediately following it, depending on whether
5337 the condition is known to be true or false.
5338
5339 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5340
5341 @item -fsplit-wide-types
5342 @opindex fsplit-wide-types
5343 When using a type that occupies multiple registers, such as @code{long
5344 long} on a 32-bit system, split the registers apart and allocate them
5345 independently.  This normally generates better code for those types,
5346 but may make debugging more difficult.
5347
5348 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5349 @option{-Os}.
5350
5351 @item -fcse-follow-jumps
5352 @opindex fcse-follow-jumps
5353 In common subexpression elimination, scan through jump instructions
5354 when the target of the jump is not reached by any other path.  For
5355 example, when CSE encounters an @code{if} statement with an
5356 @code{else} clause, CSE will follow the jump when the condition
5357 tested is false.
5358
5359 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5360
5361 @item -fcse-skip-blocks
5362 @opindex fcse-skip-blocks
5363 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5364 follow jumps which conditionally skip over blocks.  When CSE
5365 encounters a simple @code{if} statement with no else clause,
5366 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5367 body of the @code{if}.
5368
5369 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5370
5371 @item -frerun-cse-after-loop
5372 @opindex frerun-cse-after-loop
5373 Re-run common subexpression elimination after loop optimizations has been
5374 performed.
5375
5376 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5377
5378 @item -fgcse
5379 @opindex fgcse
5380 Perform a global common subexpression elimination pass.
5381 This pass also performs global constant and copy propagation.
5382
5383 @emph{Note:} When compiling a program using computed gotos, a GCC
5384 extension, you may get better runtime performance if you disable
5385 the global common subexpression elimination pass by adding
5386 @option{-fno-gcse} to the command line.
5387
5388 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5389
5390 @item -fgcse-lm
5391 @opindex fgcse-lm
5392 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5393 attempt to move loads which are only killed by stores into themselves.  This
5394 allows a loop containing a load/store sequence to be changed to a load outside
5395 the loop, and a copy/store within the loop.
5396
5397 Enabled by default when gcse is enabled.
5398
5399 @item -fgcse-sm
5400 @opindex fgcse-sm
5401 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5402 global common subexpression elimination.  This pass will attempt to move
5403 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5404 loops containing a load/store sequence can be changed to a load before
5405 the loop and a store after the loop.
5406
5407 Not enabled at any optimization level.
5408
5409 @item -fgcse-las
5410 @opindex fgcse-las
5411 When @option{-fgcse-las} is enabled, the global common subexpression
5412 elimination pass eliminates redundant loads that come after stores to the
5413 same memory location (both partial and full redundancies).
5414
5415 Not enabled at any optimization level.
5416
5417 @item -fgcse-after-reload
5418 @opindex fgcse-after-reload
5419 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5420 pass is performed after reload.  The purpose of this pass is to cleanup
5421 redundant spilling.
5422
5423 @item -funsafe-loop-optimizations
5424 @opindex funsafe-loop-optimizations
5425 If given, the loop optimizer will assume that loop indices do not
5426 overflow, and that the loops with nontrivial exit condition are not
5427 infinite.  This enables a wider range of loop optimizations even if
5428 the loop optimizer itself cannot prove that these assumptions are valid.
5429 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5430 if it finds this kind of loop.
5431
5432 @item -fcrossjumping
5433 @opindex crossjumping
5434 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5435 resulting code may or may not perform better than without cross-jumping.
5436
5437 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5438
5439 @item -fif-conversion
5440 @opindex if-conversion
5441 Attempt to transform conditional jumps into branch-less equivalents.  This
5442 include use of conditional moves, min, max, set flags and abs instructions, and
5443 some tricks doable by standard arithmetics.  The use of conditional execution
5444 on chips where it is available is controlled by @code{if-conversion2}.
5445
5446 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5447
5448 @item -fif-conversion2
5449 @opindex if-conversion2
5450 Use conditional execution (where available) to transform conditional jumps into
5451 branch-less equivalents.
5452
5453 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5454
5455 @item -fdelete-null-pointer-checks
5456 @opindex fdelete-null-pointer-checks
5457 Use global dataflow analysis to identify and eliminate useless checks
5458 for null pointers.  The compiler assumes that dereferencing a null
5459 pointer would have halted the program.  If a pointer is checked after
5460 it has already been dereferenced, it cannot be null.
5461
5462 In some environments, this assumption is not true, and programs can
5463 safely dereference null pointers.  Use
5464 @option{-fno-delete-null-pointer-checks} to disable this optimization
5465 for programs which depend on that behavior.
5466
5467 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5468
5469 @item -fexpensive-optimizations
5470 @opindex fexpensive-optimizations
5471 Perform a number of minor optimizations that are relatively expensive.
5472
5473 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5474
5475 @item -foptimize-register-move
5476 @itemx -fregmove
5477 @opindex foptimize-register-move
5478 @opindex fregmove
5479 Attempt to reassign register numbers in move instructions and as
5480 operands of other simple instructions in order to maximize the amount of
5481 register tying.  This is especially helpful on machines with two-operand
5482 instructions.
5483
5484 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5485 optimization.
5486
5487 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5488
5489 @item -fdelayed-branch
5490 @opindex fdelayed-branch
5491 If supported for the target machine, attempt to reorder instructions
5492 to exploit instruction slots available after delayed branch
5493 instructions.
5494
5495 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5496
5497 @item -fschedule-insns
5498 @opindex fschedule-insns
5499 If supported for the target machine, attempt to reorder instructions to
5500 eliminate execution stalls due to required data being unavailable.  This
5501 helps machines that have slow floating point or memory load instructions
5502 by allowing other instructions to be issued until the result of the load
5503 or floating point instruction is required.
5504
5505 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5506
5507 @item -fschedule-insns2
5508 @opindex fschedule-insns2
5509 Similar to @option{-fschedule-insns}, but requests an additional pass of
5510 instruction scheduling after register allocation has been done.  This is
5511 especially useful on machines with a relatively small number of
5512 registers and where memory load instructions take more than one cycle.
5513
5514 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5515
5516 @item -fno-sched-interblock
5517 @opindex fno-sched-interblock
5518 Don't schedule instructions across basic blocks.  This is normally
5519 enabled by default when scheduling before register allocation, i.e.@:
5520 with @option{-fschedule-insns} or at @option{-O2} or higher.
5521
5522 @item -fno-sched-spec
5523 @opindex fno-sched-spec
5524 Don't allow speculative motion of non-load instructions.  This is normally
5525 enabled by default when scheduling before register allocation, i.e.@:
5526 with @option{-fschedule-insns} or at @option{-O2} or higher.
5527
5528 @item -fsched-spec-load
5529 @opindex fsched-spec-load
5530 Allow speculative motion of some load instructions.  This only makes
5531 sense when scheduling before register allocation, i.e.@: with
5532 @option{-fschedule-insns} or at @option{-O2} or higher.
5533
5534 @item -fsched-spec-load-dangerous
5535 @opindex fsched-spec-load-dangerous
5536 Allow speculative motion of more load instructions.  This only makes
5537 sense when scheduling before register allocation, i.e.@: with
5538 @option{-fschedule-insns} or at @option{-O2} or higher.
5539
5540 @item -fsched-stalled-insns=@var{n}
5541 @opindex fsched-stalled-insns
5542 Define how many insns (if any) can be moved prematurely from the queue
5543 of stalled insns into the ready list, during the second scheduling pass.
5544
5545 @item -fsched-stalled-insns-dep=@var{n}
5546 @opindex fsched-stalled-insns-dep
5547 Define how many insn groups (cycles) will be examined for a dependency
5548 on a stalled insn that is candidate for premature removal from the queue
5549 of stalled insns.  Has an effect only during the second scheduling pass,
5550 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5551
5552 @item -fsched2-use-superblocks
5553 @opindex fsched2-use-superblocks
5554 When scheduling after register allocation, do use superblock scheduling
5555 algorithm.  Superblock scheduling allows motion across basic block boundaries
5556 resulting on faster schedules.  This option is experimental, as not all machine
5557 descriptions used by GCC model the CPU closely enough to avoid unreliable
5558 results from the algorithm.
5559
5560 This only makes sense when scheduling after register allocation, i.e.@: with
5561 @option{-fschedule-insns2} or at @option{-O2} or higher.
5562
5563 @item -fsched2-use-traces
5564 @opindex fsched2-use-traces
5565 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5566 allocation and additionally perform code duplication in order to increase the
5567 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5568 trace formation.
5569
5570 This mode should produce faster but significantly longer programs.  Also
5571 without @option{-fbranch-probabilities} the traces constructed may not
5572 match the reality and hurt the performance.  This only makes
5573 sense when scheduling after register allocation, i.e.@: with
5574 @option{-fschedule-insns2} or at @option{-O2} or higher.
5575
5576 @item -fsee
5577 @opindex fsee
5578 Eliminates redundant extension instructions and move the non redundant
5579 ones to optimal placement using LCM.
5580
5581 @item -freschedule-modulo-scheduled-loops
5582 @opindex fscheduling-in-modulo-scheduled-loops
5583 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5584 we may want to prevent the later scheduling passes from changing its schedule, we use this
5585 option to control that.
5586
5587 @item -fcaller-saves
5588 @opindex fcaller-saves
5589 Enable values to be allocated in registers that will be clobbered by
5590 function calls, by emitting extra instructions to save and restore the
5591 registers around such calls.  Such allocation is done only when it
5592 seems to result in better code than would otherwise be produced.
5593
5594 This option is always enabled by default on certain machines, usually
5595 those which have no call-preserved registers to use instead.
5596
5597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5598
5599 @item -ftree-pre
5600 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5601 enabled by default at @option{-O2} and @option{-O3}.
5602
5603 @item -ftree-fre
5604 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5605 between FRE and PRE is that FRE only considers expressions
5606 that are computed on all paths leading to the redundant computation.
5607 This analysis is faster than PRE, though it exposes fewer redundancies.
5608 This flag is enabled by default at @option{-O} and higher.
5609
5610 @item -ftree-copy-prop
5611 Perform copy propagation on trees.  This pass eliminates unnecessary
5612 copy operations.  This flag is enabled by default at @option{-O} and
5613 higher.
5614
5615 @item -ftree-store-copy-prop
5616 Perform copy propagation of memory loads and stores.  This pass
5617 eliminates unnecessary copy operations in memory references
5618 (structures, global variables, arrays, etc).  This flag is enabled by
5619 default at @option{-O2} and higher.
5620
5621 @item -ftree-salias
5622 Perform structural alias analysis on trees.  This flag
5623 is enabled by default at @option{-O} and higher.
5624
5625 @item -fipa-pta
5626 Perform interprocedural pointer analysis.
5627
5628 @item -ftree-sink
5629 Perform forward store motion  on trees.  This flag is
5630 enabled by default at @option{-O} and higher.
5631
5632 @item -ftree-ccp
5633 Perform sparse conditional constant propagation (CCP) on trees.  This
5634 pass only operates on local scalar variables and is enabled by default
5635 at @option{-O} and higher.
5636
5637 @item -ftree-store-ccp
5638 Perform sparse conditional constant propagation (CCP) on trees.  This
5639 pass operates on both local scalar variables and memory stores and
5640 loads (global variables, structures, arrays, etc).  This flag is
5641 enabled by default at @option{-O2} and higher.
5642
5643 @item -ftree-dce
5644 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5645 default at @option{-O} and higher.
5646
5647 @item -ftree-dominator-opts
5648 Perform a variety of simple scalar cleanups (constant/copy
5649 propagation, redundancy elimination, range propagation and expression
5650 simplification) based on a dominator tree traversal.  This also
5651 performs jump threading (to reduce jumps to jumps). This flag is
5652 enabled by default at @option{-O} and higher.
5653
5654 @item -ftree-ch
5655 Perform loop header copying on trees.  This is beneficial since it increases
5656 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5657 is enabled by default at @option{-O} and higher.  It is not enabled
5658 for @option{-Os}, since it usually increases code size.
5659
5660 @item -ftree-loop-optimize
5661 Perform loop optimizations on trees.  This flag is enabled by default
5662 at @option{-O} and higher.
5663
5664 @item -ftree-loop-linear
5665 Perform linear loop transformations on tree.  This flag can improve cache
5666 performance and allow further loop optimizations to take place.
5667
5668 @item -fcheck-data-deps
5669 Compare the results of several data dependence analyzers.  This option
5670 is used for debugging the data dependence analyzers.
5671
5672 @item -ftree-loop-im
5673 Perform loop invariant motion on trees.  This pass moves only invariants that
5674 would be hard to handle at RTL level (function calls, operations that expand to
5675 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5676 operands of conditions that are invariant out of the loop, so that we can use
5677 just trivial invariantness analysis in loop unswitching.  The pass also includes
5678 store motion.
5679
5680 @item -ftree-loop-ivcanon
5681 Create a canonical counter for number of iterations in the loop for that
5682 determining number of iterations requires complicated analysis.  Later
5683 optimizations then may determine the number easily.  Useful especially
5684 in connection with unrolling.
5685
5686 @item -fivopts
5687 Perform induction variable optimizations (strength reduction, induction
5688 variable merging and induction variable elimination) on trees.
5689
5690 @item -ftree-sra
5691 Perform scalar replacement of aggregates.  This pass replaces structure
5692 references with scalars to prevent committing structures to memory too
5693 early.  This flag is enabled by default at @option{-O} and higher.
5694
5695 @item -ftree-copyrename
5696 Perform copy renaming on trees.  This pass attempts to rename compiler
5697 temporaries to other variables at copy locations, usually resulting in
5698 variable names which more closely resemble the original variables.  This flag
5699 is enabled by default at @option{-O} and higher.
5700
5701 @item -ftree-ter
5702 Perform temporary expression replacement during the SSA->normal phase.  Single
5703 use/single def temporaries are replaced at their use location with their
5704 defining expression.  This results in non-GIMPLE code, but gives the expanders
5705 much more complex trees to work on resulting in better RTL generation.  This is
5706 enabled by default at @option{-O} and higher.
5707
5708 @item -ftree-vectorize
5709 Perform loop vectorization on trees.
5710
5711 @item -ftree-vect-loop-version
5712 @opindex ftree-vect-loop-version
5713 Perform loop versioning when doing loop vectorization on trees.  When a loop
5714 appears to be vectorizable except that data alignment or data dependence cannot
5715 be determined at compile time then vectorized and non-vectorized versions of
5716 the loop are generated along with runtime checks for alignment or dependence
5717 to control which version is executed.  This option is enabled by default
5718 except at level @option{-Os} where it is disabled.
5719
5720 @item -fvect-cost-model
5721 Enable cost model for vectorization.
5722
5723 @item -ftree-vrp
5724 Perform Value Range Propagation on trees.  This is similar to the
5725 constant propagation pass, but instead of values, ranges of values are
5726 propagated.  This allows the optimizers to remove unnecessary range
5727 checks like array bound checks and null pointer checks.  This is
5728 enabled by default at @option{-O2} and higher.  Null pointer check
5729 elimination is only done if @option{-fdelete-null-pointer-checks} is
5730 enabled.
5731
5732 @item -ftracer
5733 @opindex ftracer
5734 Perform tail duplication to enlarge superblock size.  This transformation
5735 simplifies the control flow of the function allowing other optimizations to do
5736 better job.
5737
5738 @item -funroll-loops
5739 @opindex funroll-loops
5740 Unroll loops whose number of iterations can be determined at compile
5741 time or upon entry to the loop.  @option{-funroll-loops} implies
5742 @option{-frerun-cse-after-loop}.  This option makes code larger,
5743 and may or may not make it run faster.
5744
5745 @item -funroll-all-loops
5746 @opindex funroll-all-loops
5747 Unroll all loops, even if their number of iterations is uncertain when
5748 the loop is entered.  This usually makes programs run more slowly.
5749 @option{-funroll-all-loops} implies the same options as
5750 @option{-funroll-loops},
5751
5752 @item -fsplit-ivs-in-unroller
5753 @opindex fsplit-ivs-in-unroller
5754 Enables expressing of values of induction variables in later iterations
5755 of the unrolled loop using the value in the first iteration.  This breaks
5756 long dependency chains, thus improving efficiency of the scheduling passes.
5757
5758 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5759 same effect.  However in cases the loop body is more complicated than
5760 a single basic block, this is not reliable.  It also does not work at all
5761 on some of the architectures due to restrictions in the CSE pass.
5762
5763 This optimization is enabled by default.
5764
5765 @item -fvariable-expansion-in-unroller
5766 @opindex fvariable-expansion-in-unroller
5767 With this option, the compiler will create multiple copies of some
5768 local variables when unrolling a loop which can result in superior code.
5769
5770 @item -fpredictive-commoning
5771 @opindex fpredictive-commoning
5772 Perform predictive commoning optimization, i.e., reusing computations
5773 (especially memory loads and stores) performed in previous
5774 iterations of loops.
5775
5776 This option is enabled at level @option{-O3}.
5777
5778 @item -fprefetch-loop-arrays
5779 @opindex fprefetch-loop-arrays
5780 If supported by the target machine, generate instructions to prefetch
5781 memory to improve the performance of loops that access large arrays.
5782
5783 This option may generate better or worse code; results are highly
5784 dependent on the structure of loops within the source code.
5785
5786 Disabled at level @option{-Os}.
5787
5788 @item -fno-peephole
5789 @itemx -fno-peephole2
5790 @opindex fno-peephole
5791 @opindex fno-peephole2
5792 Disable any machine-specific peephole optimizations.  The difference
5793 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5794 are implemented in the compiler; some targets use one, some use the
5795 other, a few use both.
5796
5797 @option{-fpeephole} is enabled by default.
5798 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5799
5800 @item -fno-guess-branch-probability
5801 @opindex fno-guess-branch-probability
5802 Do not guess branch probabilities using heuristics.
5803
5804 GCC will use heuristics to guess branch probabilities if they are
5805 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5806 heuristics are based on the control flow graph.  If some branch probabilities
5807 are specified by @samp{__builtin_expect}, then the heuristics will be
5808 used to guess branch probabilities for the rest of the control flow graph,
5809 taking the @samp{__builtin_expect} info into account.  The interactions
5810 between the heuristics and @samp{__builtin_expect} can be complex, and in
5811 some cases, it may be useful to disable the heuristics so that the effects
5812 of @samp{__builtin_expect} are easier to understand.
5813
5814 The default is @option{-fguess-branch-probability} at levels
5815 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5816
5817 @item -freorder-blocks
5818 @opindex freorder-blocks
5819 Reorder basic blocks in the compiled function in order to reduce number of
5820 taken branches and improve code locality.
5821
5822 Enabled at levels @option{-O2}, @option{-O3}.
5823
5824 @item -freorder-blocks-and-partition
5825 @opindex freorder-blocks-and-partition
5826 In addition to reordering basic blocks in the compiled function, in order
5827 to reduce number of taken branches, partitions hot and cold basic blocks
5828 into separate sections of the assembly and .o files, to improve
5829 paging and cache locality performance.
5830
5831 This optimization is automatically turned off in the presence of
5832 exception handling, for linkonce sections, for functions with a user-defined
5833 section attribute and on any architecture that does not support named
5834 sections.
5835
5836 @item -freorder-functions
5837 @opindex freorder-functions
5838 Reorder functions in the object file in order to
5839 improve code locality.  This is implemented by using special
5840 subsections @code{.text.hot} for most frequently executed functions and
5841 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5842 the linker so object file format must support named sections and linker must
5843 place them in a reasonable way.
5844
5845 Also profile feedback must be available in to make this option effective.  See
5846 @option{-fprofile-arcs} for details.
5847
5848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5849
5850 @item -fstrict-aliasing
5851 @opindex fstrict-aliasing
5852 Allows the compiler to assume the strictest aliasing rules applicable to
5853 the language being compiled.  For C (and C++), this activates
5854 optimizations based on the type of expressions.  In particular, an
5855 object of one type is assumed never to reside at the same address as an
5856 object of a different type, unless the types are almost the same.  For
5857 example, an @code{unsigned int} can alias an @code{int}, but not a
5858 @code{void*} or a @code{double}.  A character type may alias any other
5859 type.
5860
5861 Pay special attention to code like this:
5862 @smallexample
5863 union a_union @{
5864   int i;
5865   double d;
5866 @};
5867
5868 int f() @{
5869   a_union t;
5870   t.d = 3.0;
5871   return t.i;
5872 @}
5873 @end smallexample
5874 The practice of reading from a different union member than the one most
5875 recently written to (called ``type-punning'') is common.  Even with
5876 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5877 is accessed through the union type.  So, the code above will work as
5878 expected.  However, this code might not:
5879 @smallexample
5880 int f() @{
5881   a_union t;
5882   int* ip;
5883   t.d = 3.0;
5884   ip = &t.i;
5885   return *ip;
5886 @}
5887 @end smallexample
5888
5889 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5890
5891 @item -fstrict-overflow
5892 @opindex fstrict-overflow
5893 Allow the compiler to assume strict signed overflow rules, depending
5894 on the language being compiled.  For C (and C++) this means that
5895 overflow when doing arithmetic with signed numbers is undefined, which
5896 means that the compiler may assume that it will not happen.  This
5897 permits various optimizations.  For example, the compiler will assume
5898 that an expression like @code{i + 10 > i} will always be true for
5899 signed @code{i}.  This assumption is only valid if signed overflow is
5900 undefined, as the expression is false if @code{i + 10} overflows when
5901 using twos complement arithmetic.  When this option is in effect any
5902 attempt to determine whether an operation on signed numbers will
5903 overflow must be written carefully to not actually involve overflow.
5904
5905 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
5906 that signed overflow is fully defined: it wraps.  When
5907 @option{-fwrapv} is used, there is no difference between
5908 @option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
5909 @option{-fwrapv} certain types of overflow are permitted.  For
5910 example, if the compiler gets an overflow when doing arithmetic on
5911 constants, the overflowed value can still be used with
5912 @option{-fwrapv}, but not otherwise.
5913
5914 The @option{-fstrict-overflow} option is enabled at levels
5915 @option{-O2}, @option{-O3}, @option{-Os}.
5916
5917 @item -falign-functions
5918 @itemx -falign-functions=@var{n}
5919 @opindex falign-functions
5920 Align the start of functions to the next power-of-two greater than
5921 @var{n}, skipping up to @var{n} bytes.  For instance,
5922 @option{-falign-functions=32} aligns functions to the next 32-byte
5923 boundary, but @option{-falign-functions=24} would align to the next
5924 32-byte boundary only if this can be done by skipping 23 bytes or less.
5925
5926 @option{-fno-align-functions} and @option{-falign-functions=1} are
5927 equivalent and mean that functions will not be aligned.
5928
5929 Some assemblers only support this flag when @var{n} is a power of two;
5930 in that case, it is rounded up.
5931
5932 If @var{n} is not specified or is zero, use a machine-dependent default.
5933
5934 Enabled at levels @option{-O2}, @option{-O3}.
5935
5936 @item -falign-labels
5937 @itemx -falign-labels=@var{n}
5938 @opindex falign-labels
5939 Align all branch targets to a power-of-two boundary, skipping up to
5940 @var{n} bytes like @option{-falign-functions}.  This option can easily
5941 make code slower, because it must insert dummy operations for when the
5942 branch target is reached in the usual flow of the code.
5943
5944 @option{-fno-align-labels} and @option{-falign-labels=1} are
5945 equivalent and mean that labels will not be aligned.
5946
5947 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5948 are greater than this value, then their values are used instead.
5949
5950 If @var{n} is not specified or is zero, use a machine-dependent default
5951 which is very likely to be @samp{1}, meaning no alignment.
5952
5953 Enabled at levels @option{-O2}, @option{-O3}.
5954
5955 @item -falign-loops
5956 @itemx -falign-loops=@var{n}
5957 @opindex falign-loops
5958 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5959 like @option{-falign-functions}.  The hope is that the loop will be
5960 executed many times, which will make up for any execution of the dummy
5961 operations.
5962
5963 @option{-fno-align-loops} and @option{-falign-loops=1} are
5964 equivalent and mean that loops will not be aligned.
5965
5966 If @var{n} is not specified or is zero, use a machine-dependent default.
5967
5968 Enabled at levels @option{-O2}, @option{-O3}.
5969
5970 @item -falign-jumps
5971 @itemx -falign-jumps=@var{n}
5972 @opindex falign-jumps
5973 Align branch targets to a power-of-two boundary, for branch targets
5974 where the targets can only be reached by jumping, skipping up to @var{n}
5975 bytes like @option{-falign-functions}.  In this case, no dummy operations
5976 need be executed.
5977
5978 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5979 equivalent and mean that loops will not be aligned.
5980
5981 If @var{n} is not specified or is zero, use a machine-dependent default.
5982
5983 Enabled at levels @option{-O2}, @option{-O3}.
5984
5985 @item -funit-at-a-time
5986 @opindex funit-at-a-time
5987 Parse the whole compilation unit before starting to produce code.
5988 This allows some extra optimizations to take place but consumes
5989 more memory (in general).  There are some compatibility issues
5990 with @emph{unit-at-a-time} mode:
5991 @itemize @bullet
5992 @item
5993 enabling @emph{unit-at-a-time} mode may change the order
5994 in which functions, variables, and top-level @code{asm} statements
5995 are emitted, and will likely break code relying on some particular
5996 ordering.  The majority of such top-level @code{asm} statements,
5997 though, can be replaced by @code{section} attributes.  The
5998 @option{fno-toplevel-reorder} option may be used to keep the ordering
5999 used in the input file, at the cost of some optimizations.
6000
6001 @item
6002 @emph{unit-at-a-time} mode removes unreferenced static variables
6003 and functions.  This may result in undefined references
6004 when an @code{asm} statement refers directly to variables or functions
6005 that are otherwise unused.  In that case either the variable/function
6006 shall be listed as an operand of the @code{asm} statement operand or,
6007 in the case of top-level @code{asm} statements the attribute @code{used}
6008 shall be used on the declaration.
6009
6010 @item
6011 Static functions now can use non-standard passing conventions that
6012 may break @code{asm} statements calling functions directly.  Again,
6013 attribute @code{used} will prevent this behavior.
6014 @end itemize
6015
6016 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6017 but this scheme may not be supported by future releases of GCC@.
6018
6019 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6020
6021 @item -fno-toplevel-reorder
6022 Do not reorder top-level functions, variables, and @code{asm}
6023 statements.  Output them in the same order that they appear in the
6024 input file.  When this option is used, unreferenced static variables
6025 will not be removed.  This option is intended to support existing code
6026 which relies on a particular ordering.  For new code, it is better to
6027 use attributes.
6028
6029 @item -fweb
6030 @opindex fweb
6031 Constructs webs as commonly used for register allocation purposes and assign
6032 each web individual pseudo register.  This allows the register allocation pass
6033 to operate on pseudos directly, but also strengthens several other optimization
6034 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6035 however, make debugging impossible, since variables will no longer stay in a
6036 ``home register''.
6037
6038 Enabled by default with @option{-funroll-loops}.
6039
6040 @item -fwhole-program
6041 @opindex fwhole-program
6042 Assume that the current compilation unit represents whole program being
6043 compiled.  All public functions and variables with the exception of @code{main}
6044 and those merged by attribute @code{externally_visible} become static functions
6045 and in a affect gets more aggressively optimized by interprocedural optimizers.
6046 While this option is equivalent to proper use of @code{static} keyword for
6047 programs consisting of single file, in combination with option
6048 @option{--combine} this flag can be used to compile most of smaller scale C
6049 programs since the functions and variables become local for the whole combined
6050 compilation unit, not for the single source file itself.
6051
6052
6053 @item -fno-cprop-registers
6054 @opindex fno-cprop-registers
6055 After register allocation and post-register allocation instruction splitting,
6056 we perform a copy-propagation pass to try to reduce scheduling dependencies
6057 and occasionally eliminate the copy.
6058
6059 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6060
6061 @item -fprofile-generate
6062 @opindex fprofile-generate
6063
6064 Enable options usually used for instrumenting application to produce
6065 profile useful for later recompilation with profile feedback based
6066 optimization.  You must use @option{-fprofile-generate} both when
6067 compiling and when linking your program.
6068
6069 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6070
6071 @item -fprofile-use
6072 @opindex fprofile-use
6073 Enable profile feedback directed optimizations, and optimizations
6074 generally profitable only with profile feedback available.
6075
6076 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6077 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6078
6079 By default, GCC emits an error message if the feedback profiles do not
6080 match the source code.  This error can be turned into a warning by using
6081 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6082 code.
6083 @end table
6084
6085 The following options control compiler behavior regarding floating
6086 point arithmetic.  These options trade off between speed and
6087 correctness.  All must be specifically enabled.
6088
6089 @table @gcctabopt
6090 @item -ffloat-store
6091 @opindex ffloat-store
6092 Do not store floating point variables in registers, and inhibit other
6093 options that might change whether a floating point value is taken from a
6094 register or memory.
6095
6096 @cindex floating point precision
6097 This option prevents undesirable excess precision on machines such as
6098 the 68000 where the floating registers (of the 68881) keep more
6099 precision than a @code{double} is supposed to have.  Similarly for the
6100 x86 architecture.  For most programs, the excess precision does only
6101 good, but a few programs rely on the precise definition of IEEE floating
6102 point.  Use @option{-ffloat-store} for such programs, after modifying
6103 them to store all pertinent intermediate computations into variables.
6104
6105 @item -ffast-math
6106 @opindex ffast-math
6107 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
6108 @option{-fno-trapping-math}, @option{-ffinite-math-only},
6109 @option{-fno-rounding-math}, @option{-fno-signaling-nans},
6110 @option{-fno-signed-zeros} and @option{fcx-limited-range}.
6111
6112 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6113
6114 This option is not turned on by any @option{-O} option since
6115 it can result in incorrect output for programs which depend on
6116 an exact implementation of IEEE or ISO rules/specifications for
6117 math functions. It may, however, yield faster code for programs
6118 that do not require the guarantees of these specifications.
6119
6120 @item -fno-math-errno
6121 @opindex fno-math-errno
6122 Do not set ERRNO after calling math functions that are executed
6123 with a single instruction, e.g., sqrt.  A program that relies on
6124 IEEE exceptions for math error handling may want to use this flag
6125 for speed while maintaining IEEE arithmetic compatibility.
6126
6127 This option is not turned on by any @option{-O} option since
6128 it can result in incorrect output for programs which depend on
6129 an exact implementation of IEEE or ISO rules/specifications for
6130 math functions. It may, however, yield faster code for programs
6131 that do not require the guarantees of these specifications.
6132
6133 The default is @option{-fmath-errno}.
6134
6135 On Darwin systems, the math library never sets @code{errno}.  There is
6136 therefore no reason for the compiler to consider the possibility that
6137 it might, and @option{-fno-math-errno} is the default.
6138
6139 @item -funsafe-math-optimizations
6140 @opindex funsafe-math-optimizations
6141 Allow optimizations for floating-point arithmetic that (a) assume
6142 that arguments and results are valid and (b) may violate IEEE or
6143 ANSI standards.  When used at link-time, it may include libraries
6144 or startup files that change the default FPU control word or other
6145 similar optimizations.
6146
6147 This option is not turned on by any @option{-O} option since
6148 it can result in incorrect output for programs which depend on
6149 an exact implementation of IEEE or ISO rules/specifications for
6150 math functions. It may, however, yield faster code for programs
6151 that do not require the guarantees of these specifications.
6152
6153 The default is @option{-fno-unsafe-math-optimizations}.
6154
6155 @item -ffinite-math-only
6156 @opindex ffinite-math-only
6157 Allow optimizations for floating-point arithmetic that assume
6158 that arguments and results are not NaNs or +-Infs.
6159
6160 This option is not turned on by any @option{-O} option since
6161 it can result in incorrect output for programs which depend on
6162 an exact implementation of IEEE or ISO rules/specifications for
6163 math functions. It may, however, yield faster code for programs
6164 that do not require the guarantees of these specifications.
6165
6166 The default is @option{-fno-finite-math-only}.
6167
6168 @item -fno-signed-zeros
6169 @opindex fno-signed-zeros
6170 Allow optimizations for floating point arithmetic that ignore the
6171 signedness of zero.  IEEE arithmetic specifies the behavior of
6172 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6173 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6174 This option implies that the sign of a zero result isn't significant.
6175
6176 The default is @option{-fsigned-zeros}.
6177
6178 @item -fno-trapping-math
6179 @opindex fno-trapping-math
6180 Compile code assuming that floating-point operations cannot generate
6181 user-visible traps.  These traps include division by zero, overflow,
6182 underflow, inexact result and invalid operation.  This option implies
6183 @option{-fno-signaling-nans}.  Setting this option may allow faster
6184 code if one relies on ``non-stop'' IEEE arithmetic, for example.
6185
6186 This option should never be turned on by any @option{-O} option since
6187 it can result in incorrect output for programs which depend on
6188 an exact implementation of IEEE or ISO rules/specifications for
6189 math functions.
6190
6191 The default is @option{-ftrapping-math}.
6192
6193 @item -frounding-math
6194 @opindex frounding-math
6195 Disable transformations and optimizations that assume default floating
6196 point rounding behavior.  This is round-to-zero for all floating point
6197 to integer conversions, and round-to-nearest for all other arithmetic
6198 truncations.  This option should be specified for programs that change
6199 the FP rounding mode dynamically, or that may be executed with a
6200 non-default rounding mode.  This option disables constant folding of
6201 floating point expressions at compile-time (which may be affected by
6202 rounding mode) and arithmetic transformations that are unsafe in the
6203 presence of sign-dependent rounding modes.
6204
6205 The default is @option{-fno-rounding-math}.
6206
6207 This option is experimental and does not currently guarantee to
6208 disable all GCC optimizations that are affected by rounding mode.
6209 Future versions of GCC may provide finer control of this setting
6210 using C99's @code{FENV_ACCESS} pragma.  This command line option
6211 will be used to specify the default state for @code{FENV_ACCESS}.
6212
6213 @item -frtl-abstract-sequences
6214 @opindex frtl-abstract-sequences
6215 It is a size optimization method. This option is to find identical
6216 sequences of code, which can be turned into pseudo-procedures  and
6217 then  replace  all  occurrences with  calls to  the  newly created
6218 subroutine. It is kind of an opposite of @option{-finline-functions}.
6219 This optimization runs at RTL level.
6220
6221 @item -fsignaling-nans
6222 @opindex fsignaling-nans
6223 Compile code assuming that IEEE signaling NaNs may generate user-visible
6224 traps during floating-point operations.  Setting this option disables
6225 optimizations that may change the number of exceptions visible with
6226 signaling NaNs.  This option implies @option{-ftrapping-math}.
6227
6228 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6229 be defined.
6230
6231 The default is @option{-fno-signaling-nans}.
6232
6233 This option is experimental and does not currently guarantee to
6234 disable all GCC optimizations that affect signaling NaN behavior.
6235
6236 @item -fsingle-precision-constant
6237 @opindex fsingle-precision-constant
6238 Treat floating point constant as single precision constant instead of
6239 implicitly converting it to double precision constant.
6240
6241 @item -fcx-limited-range
6242 @itemx -fno-cx-limited-range
6243 @opindex fcx-limited-range
6244 @opindex fno-cx-limited-range
6245 When enabled, this option states that a range reduction step is not
6246 needed when performing complex division.  The default is
6247 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
6248
6249 This option controls the default setting of the ISO C99
6250 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6251 all languages.
6252
6253 @end table
6254
6255 The following options control optimizations that may improve
6256 performance, but are not enabled by any @option{-O} options.  This
6257 section includes experimental options that may produce broken code.
6258
6259 @table @gcctabopt
6260 @item -fbranch-probabilities
6261 @opindex fbranch-probabilities
6262 After running a program compiled with @option{-fprofile-arcs}
6263 (@pxref{Debugging Options,, Options for Debugging Your Program or
6264 @command{gcc}}), you can compile it a second time using
6265 @option{-fbranch-probabilities}, to improve optimizations based on
6266 the number of times each branch was taken.  When the program
6267 compiled with @option{-fprofile-arcs} exits it saves arc execution
6268 counts to a file called @file{@var{sourcename}.gcda} for each source
6269 file.  The information in this data file is very dependent on the
6270 structure of the generated code, so you must use the same source code
6271 and the same optimization options for both compilations.
6272
6273 With @option{-fbranch-probabilities}, GCC puts a
6274 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6275 These can be used to improve optimization.  Currently, they are only
6276 used in one place: in @file{reorg.c}, instead of guessing which path a
6277 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6278 exactly determine which path is taken more often.
6279
6280 @item -fprofile-values
6281 @opindex fprofile-values
6282 If combined with @option{-fprofile-arcs}, it adds code so that some
6283 data about values of expressions in the program is gathered.
6284
6285 With @option{-fbranch-probabilities}, it reads back the data gathered
6286 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6287 notes to instructions for their later usage in optimizations.
6288
6289 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6290
6291 @item -fvpt
6292 @opindex fvpt
6293 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6294 a code to gather information about values of expressions.
6295
6296 With @option{-fbranch-probabilities}, it reads back the data gathered
6297 and actually performs the optimizations based on them.
6298 Currently the optimizations include specialization of division operation
6299 using the knowledge about the value of the denominator.
6300
6301 @item -frename-registers
6302 @opindex frename-registers
6303 Attempt to avoid false dependencies in scheduled code by making use
6304 of registers left over after register allocation.  This optimization
6305 will most benefit processors with lots of registers.  Depending on the
6306 debug information format adopted by the target, however, it can
6307 make debugging impossible, since variables will no longer stay in
6308 a ``home register''.
6309
6310 Enabled by default with @option{-funroll-loops}.
6311
6312 @item -ftracer
6313 @opindex ftracer
6314 Perform tail duplication to enlarge superblock size.  This transformation
6315 simplifies the control flow of the function allowing other optimizations to do
6316 better job.
6317
6318 Enabled with @option{-fprofile-use}.
6319
6320 @item -funroll-loops
6321 @opindex funroll-loops
6322 Unroll loops whose number of iterations can be determined at compile time or
6323 upon entry to the loop.  @option{-funroll-loops} implies
6324 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6325 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6326 small constant number of iterations).  This option makes code larger, and may
6327 or may not make it run faster.
6328
6329 Enabled with @option{-fprofile-use}.
6330
6331 @item -funroll-all-loops
6332 @opindex funroll-all-loops
6333 Unroll all loops, even if their number of iterations is uncertain when
6334 the loop is entered.  This usually makes programs run more slowly.
6335 @option{-funroll-all-loops} implies the same options as
6336 @option{-funroll-loops}.
6337
6338 @item -fpeel-loops
6339 @opindex fpeel-loops
6340 Peels the loops for that there is enough information that they do not
6341 roll much (from profile feedback).  It also turns on complete loop peeling
6342 (i.e.@: complete removal of loops with small constant number of iterations).
6343
6344 Enabled with @option{-fprofile-use}.
6345
6346 @item -fmove-loop-invariants
6347 @opindex fmove-loop-invariants
6348 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6349 at level @option{-O1}
6350
6351 @item -funswitch-loops
6352 @opindex funswitch-loops
6353 Move branches with loop invariant conditions out of the loop, with duplicates
6354 of the loop on both branches (modified according to result of the condition).
6355
6356 @item -ffunction-sections
6357 @itemx -fdata-sections
6358 @opindex ffunction-sections
6359 @opindex fdata-sections
6360 Place each function or data item into its own section in the output
6361 file if the target supports arbitrary sections.  The name of the
6362 function or the name of the data item determines the section's name
6363 in the output file.
6364
6365 Use these options on systems where the linker can perform optimizations
6366 to improve locality of reference in the instruction space.  Most systems
6367 using the ELF object format and SPARC processors running Solaris 2 have
6368 linkers with such optimizations.  AIX may have these optimizations in
6369 the future.
6370
6371 Only use these options when there are significant benefits from doing
6372 so.  When you specify these options, the assembler and linker will
6373 create larger object and executable files and will also be slower.
6374 You will not be able to use @code{gprof} on all systems if you
6375 specify this option and you may have problems with debugging if
6376 you specify both this option and @option{-g}.
6377
6378 @item -fbranch-target-load-optimize
6379 @opindex fbranch-target-load-optimize
6380 Perform branch target register load optimization before prologue / epilogue
6381 threading.
6382 The use of target registers can typically be exposed only during reload,
6383 thus hoisting loads out of loops and doing inter-block scheduling needs
6384 a separate optimization pass.
6385
6386 @item -fbranch-target-load-optimize2
6387 @opindex fbranch-target-load-optimize2
6388 Perform branch target register load optimization after prologue / epilogue
6389 threading.
6390
6391 @item -fbtr-bb-exclusive
6392 @opindex fbtr-bb-exclusive
6393 When performing branch target register load optimization, don't reuse
6394 branch target registers in within any basic block.
6395
6396 @item -fstack-protector
6397 Emit extra code to check for buffer overflows, such as stack smashing
6398 attacks.  This is done by adding a guard variable to functions with
6399 vulnerable objects.  This includes functions that call alloca, and
6400 functions with buffers larger than 8 bytes.  The guards are initialized
6401 when a function is entered and then checked when the function exits.
6402 If a guard check fails, an error message is printed and the program exits.
6403
6404 @item -fstack-protector-all
6405 Like @option{-fstack-protector} except that all functions are protected.
6406
6407 @item -fsection-anchors
6408 @opindex fsection-anchors
6409 Try to reduce the number of symbolic address calculations by using
6410 shared ``anchor'' symbols to address nearby objects.  This transformation
6411 can help to reduce the number of GOT entries and GOT accesses on some
6412 targets.
6413
6414 For example, the implementation of the following function @code{foo}:
6415
6416 @smallexample
6417 static int a, b, c;
6418 int foo (void) @{ return a + b + c; @}
6419 @end smallexample
6420
6421 would usually calculate the addresses of all three variables, but if you
6422 compile it with @option{-fsection-anchors}, it will access the variables
6423 from a common anchor point instead.  The effect is similar to the
6424 following pseudocode (which isn't valid C):
6425
6426 @smallexample
6427 int foo (void)
6428 @{
6429   register int *xr = &x;
6430   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6431 @}
6432 @end smallexample
6433
6434 Not all targets support this option.
6435
6436 @item --param @var{name}=@var{value}
6437 @opindex param
6438 In some places, GCC uses various constants to control the amount of
6439 optimization that is done.  For example, GCC will not inline functions
6440 that contain more that a certain number of instructions.  You can
6441 control some of these constants on the command-line using the
6442 @option{--param} option.
6443
6444 The names of specific parameters, and the meaning of the values, are
6445 tied to the internals of the compiler, and are subject to change
6446 without notice in future releases.
6447
6448 In each case, the @var{value} is an integer.  The allowable choices for
6449 @var{name} are given in the following table:
6450
6451 @table @gcctabopt
6452 @item salias-max-implicit-fields
6453 The maximum number of fields in a variable without direct
6454 structure accesses for which structure aliasing will consider trying
6455 to track each field.  The default is 5
6456
6457 @item salias-max-array-elements
6458 The maximum number of elements an array can have and its elements
6459 still be tracked individually by structure aliasing. The default is 4
6460
6461 @item sra-max-structure-size
6462 The maximum structure size, in bytes, at which the scalar replacement
6463 of aggregates (SRA) optimization will perform block copies.  The
6464 default value, 0, implies that GCC will select the most appropriate
6465 size itself.
6466
6467 @item sra-field-structure-ratio
6468 The threshold ratio (as a percentage) between instantiated fields and
6469 the complete structure size.  We say that if the ratio of the number
6470 of bytes in instantiated fields to the number of bytes in the complete
6471 structure exceeds this parameter, then block copies are not used.  The
6472 default is 75.
6473
6474 @item max-crossjump-edges
6475 The maximum number of incoming edges to consider for crossjumping.
6476 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6477 the number of edges incoming to each block.  Increasing values mean
6478 more aggressive optimization, making the compile time increase with
6479 probably small improvement in executable size.
6480
6481 @item min-crossjump-insns
6482 The minimum number of instructions which must be matched at the end
6483 of two blocks before crossjumping will be performed on them.  This
6484 value is ignored in the case where all instructions in the block being
6485 crossjumped from are matched.  The default value is 5.
6486
6487 @item max-grow-copy-bb-insns
6488 The maximum code size expansion factor when copying basic blocks
6489 instead of jumping.  The expansion is relative to a jump instruction.
6490 The default value is 8.
6491
6492 @item max-goto-duplication-insns
6493 The maximum number of instructions to duplicate to a block that jumps
6494 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6495 passes, GCC factors computed gotos early in the compilation process,
6496 and unfactors them as late as possible.  Only computed jumps at the
6497 end of a basic blocks with no more than max-goto-duplication-insns are
6498 unfactored.  The default value is 8.
6499
6500 @item max-delay-slot-insn-search
6501 The maximum number of instructions to consider when looking for an
6502 instruction to fill a delay slot.  If more than this arbitrary number of
6503 instructions is searched, the time savings from filling the delay slot
6504 will be minimal so stop searching.  Increasing values mean more
6505 aggressive optimization, making the compile time increase with probably
6506 small improvement in executable run time.
6507
6508 @item max-delay-slot-live-search
6509 When trying to fill delay slots, the maximum number of instructions to
6510 consider when searching for a block with valid live register
6511 information.  Increasing this arbitrarily chosen value means more
6512 aggressive optimization, increasing the compile time.  This parameter
6513 should be removed when the delay slot code is rewritten to maintain the
6514 control-flow graph.
6515
6516 @item max-gcse-memory
6517 The approximate maximum amount of memory that will be allocated in
6518 order to perform the global common subexpression elimination
6519 optimization.  If more memory than specified is required, the
6520 optimization will not be done.
6521
6522 @item max-gcse-passes
6523 The maximum number of passes of GCSE to run.  The default is 1.
6524
6525 @item max-pending-list-length
6526 The maximum number of pending dependencies scheduling will allow
6527 before flushing the current state and starting over.  Large functions
6528 with few branches or calls can create excessively large lists which
6529 needlessly consume memory and resources.
6530
6531 @item max-inline-insns-single
6532 Several parameters control the tree inliner used in gcc.
6533 This number sets the maximum number of instructions (counted in GCC's
6534 internal representation) in a single function that the tree inliner
6535 will consider for inlining.  This only affects functions declared
6536 inline and methods implemented in a class declaration (C++).
6537 The default value is 450.
6538
6539 @item max-inline-insns-auto
6540 When you use @option{-finline-functions} (included in @option{-O3}),
6541 a lot of functions that would otherwise not be considered for inlining
6542 by the compiler will be investigated.  To those functions, a different
6543 (more restrictive) limit compared to functions declared inline can
6544 be applied.
6545 The default value is 90.
6546
6547 @item large-function-insns
6548 The limit specifying really large functions.  For functions larger than this
6549 limit after inlining inlining is constrained by
6550 @option{--param large-function-growth}.  This parameter is useful primarily
6551 to avoid extreme compilation time caused by non-linear algorithms used by the
6552 backend.
6553 This parameter is ignored when @option{-funit-at-a-time} is not used.
6554 The default value is 2700.
6555
6556 @item large-function-growth
6557 Specifies maximal growth of large function caused by inlining in percents.
6558 This parameter is ignored when @option{-funit-at-a-time} is not used.
6559 The default value is 100 which limits large function growth to 2.0 times
6560 the original size.
6561
6562 @item large-unit-insns
6563 The limit specifying large translation unit.  Growth caused by inlining of
6564 units larger than this limit is limited by @option{--param inline-unit-growth}.
6565 For small units this might be too tight (consider unit consisting of function A
6566 that is inline and B that just calls A three time.  If B is small relative to
6567 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6568 large units consisting of small inlininable functions however the overall unit
6569 growth limit is needed to avoid exponential explosion of code size.  Thus for
6570 smaller units, the size is increased to @option{--param large-unit-insns}
6571 before applying @option{--param inline-unit-growth}.  The default is 10000
6572
6573 @item inline-unit-growth
6574 Specifies maximal overall growth of the compilation unit caused by inlining.
6575 This parameter is ignored when @option{-funit-at-a-time} is not used.
6576 The default value is 30 which limits unit growth to 1.3 times the original
6577 size.
6578
6579 @item large-stack-frame
6580 The limit specifying large stack frames.  While inlining the algorithm is trying
6581 to not grow past this limit too much.  Default value is 256 bytes.
6582
6583 @item large-stack-frame-growth
6584 Specifies maximal growth of large stack frames caused by inlining in percents.
6585 The default value is 1000 which limits large stack frame growth to 11 times
6586 the original size.
6587
6588 @item max-inline-insns-recursive
6589 @itemx max-inline-insns-recursive-auto
6590 Specifies maximum number of instructions out-of-line copy of self recursive inline
6591 function can grow into by performing recursive inlining.
6592
6593 For functions declared inline @option{--param max-inline-insns-recursive} is
6594 taken into account.  For function not declared inline, recursive inlining
6595 happens only when @option{-finline-functions} (included in @option{-O3}) is
6596 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6597 default value is 450.
6598
6599 @item max-inline-recursive-depth
6600 @itemx max-inline-recursive-depth-auto
6601 Specifies maximum recursion depth used by the recursive inlining.
6602
6603 For functions declared inline @option{--param max-inline-recursive-depth} is
6604 taken into account.  For function not declared inline, recursive inlining
6605 happens only when @option{-finline-functions} (included in @option{-O3}) is
6606 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6607 default value is 450.
6608
6609 @item min-inline-recursive-probability
6610 Recursive inlining is profitable only for function having deep recursion
6611 in average and can hurt for function having little recursion depth by
6612 increasing the prologue size or complexity of function body to other
6613 optimizers.
6614
6615 When profile feedback is available (see @option{-fprofile-generate}) the actual
6616 recursion depth can be guessed from probability that function will recurse via
6617 given call expression.  This parameter limits inlining only to call expression
6618 whose probability exceeds given threshold (in percents).  The default value is
6619 10.
6620
6621 @item inline-call-cost
6622 Specify cost of call instruction relative to simple arithmetics operations
6623 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6624 functions and at the same time increases size of leaf function that is believed to
6625 reduce function size by being inlined.  In effect it increases amount of
6626 inlining for code having large abstraction penalty (many functions that just
6627 pass the arguments to other functions) and decrease inlining for code with low
6628 abstraction penalty.  The default value is 16.
6629
6630 @item min-vect-loop-bound
6631 The minimum number of iterations under which a loop will not get vectorized
6632 when @option{-ftree-vectorize} is used.  The number of iterations after
6633 vectorization needs to be greater than the value specified by this option
6634 to allow vectorization.  The default value is 0.
6635
6636 @item max-unrolled-insns
6637 The maximum number of instructions that a loop should have if that loop
6638 is unrolled, and if the loop is unrolled, it determines how many times
6639 the loop code is unrolled.
6640
6641 @item max-average-unrolled-insns
6642 The maximum number of instructions biased by probabilities of their execution
6643 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6644 it determines how many times the loop code is unrolled.
6645
6646 @item max-unroll-times
6647 The maximum number of unrollings of a single loop.
6648
6649 @item max-peeled-insns
6650 The maximum number of instructions that a loop should have if that loop
6651 is peeled, and if the loop is peeled, it determines how many times
6652 the loop code is peeled.
6653
6654 @item max-peel-times
6655 The maximum number of peelings of a single loop.
6656
6657 @item max-completely-peeled-insns
6658 The maximum number of insns of a completely peeled loop.
6659
6660 @item max-completely-peel-times
6661 The maximum number of iterations of a loop to be suitable for complete peeling.
6662
6663 @item max-unswitch-insns
6664 The maximum number of insns of an unswitched loop.
6665
6666 @item max-unswitch-level
6667 The maximum number of branches unswitched in a single loop.
6668
6669 @item lim-expensive
6670 The minimum cost of an expensive expression in the loop invariant motion.
6671
6672 @item iv-consider-all-candidates-bound
6673 Bound on number of candidates for induction variables below that
6674 all candidates are considered for each use in induction variable
6675 optimizations.  Only the most relevant candidates are considered
6676 if there are more candidates, to avoid quadratic time complexity.
6677
6678 @item iv-max-considered-uses
6679 The induction variable optimizations give up on loops that contain more
6680 induction variable uses.
6681
6682 @item iv-always-prune-cand-set-bound
6683 If number of candidates in the set is smaller than this value,
6684 we always try to remove unnecessary ivs from the set during its
6685 optimization when a new iv is added to the set.
6686
6687 @item scev-max-expr-size
6688 Bound on size of expressions used in the scalar evolutions analyzer.
6689 Large expressions slow the analyzer.
6690
6691 @item omega-max-vars
6692 The maximum number of variables in an Omega constraint system.
6693 The default value is 128.
6694
6695 @item omega-max-geqs
6696 The maximum number of inequalities in an Omega constraint system.
6697 The default value is 256.
6698
6699 @item omega-max-eqs
6700 The maximum number of equalities in an Omega constraint system.
6701 The default value is 128.
6702
6703 @item omega-max-wild-cards
6704 The maximum number of wildcard variables that the Omega solver will
6705 be able to insert.  The default value is 18.
6706
6707 @item omega-hash-table-size
6708 The size of the hash table in the Omega solver.  The default value is
6709 550.
6710
6711 @item omega-max-keys
6712 The maximal number of keys used by the Omega solver.  The default
6713 value is 500.
6714
6715 @item omega-eliminate-redundant-constraints
6716 When set to 1, use expensive methods to eliminate all redundant
6717 constraints.  The default value is 0.
6718
6719 @item vect-max-version-checks
6720 The maximum number of runtime checks that can be performed when doing
6721 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6722 for more information.
6723
6724 @item max-iterations-to-track
6725
6726 The maximum number of iterations of a loop the brute force algorithm
6727 for analysis of # of iterations of the loop tries to evaluate.
6728
6729 @item hot-bb-count-fraction
6730 Select fraction of the maximal count of repetitions of basic block in program
6731 given basic block needs to have to be considered hot.
6732
6733 @item hot-bb-frequency-fraction
6734 Select fraction of the maximal frequency of executions of basic block in
6735 function given basic block needs to have to be considered hot
6736
6737 @item max-predicted-iterations
6738 The maximum number of loop iterations we predict statically.  This is useful
6739 in cases where function contain single loop with known bound and other loop
6740 with unknown.  We predict the known number of iterations correctly, while
6741 the unknown number of iterations average to roughly 10.  This means that the
6742 loop without bounds would appear artificially cold relative to the other one.
6743
6744 @item tracer-dynamic-coverage
6745 @itemx tracer-dynamic-coverage-feedback
6746
6747 This value is used to limit superblock formation once the given percentage of
6748 executed instructions is covered.  This limits unnecessary code size
6749 expansion.
6750
6751 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6752 feedback is available.  The real profiles (as opposed to statically estimated
6753 ones) are much less balanced allowing the threshold to be larger value.
6754
6755 @item tracer-max-code-growth
6756 Stop tail duplication once code growth has reached given percentage.  This is
6757 rather hokey argument, as most of the duplicates will be eliminated later in
6758 cross jumping, so it may be set to much higher values than is the desired code
6759 growth.
6760
6761 @item tracer-min-branch-ratio
6762
6763 Stop reverse growth when the reverse probability of best edge is less than this
6764 threshold (in percent).
6765
6766 @item tracer-min-branch-ratio
6767 @itemx tracer-min-branch-ratio-feedback
6768
6769 Stop forward growth if the best edge do have probability lower than this
6770 threshold.
6771
6772 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6773 compilation for profile feedback and one for compilation without.  The value
6774 for compilation with profile feedback needs to be more conservative (higher) in
6775 order to make tracer effective.
6776
6777 @item max-cse-path-length
6778
6779 Maximum number of basic blocks on path that cse considers.  The default is 10.
6780
6781 @item max-cse-insns
6782 The maximum instructions CSE process before flushing. The default is 1000.
6783
6784 @item max-aliased-vops
6785
6786 Maximum number of virtual operands per function allowed to represent
6787 aliases before triggering the alias partitioning heuristic.  Alias
6788 partitioning reduces compile times and memory consumption needed for
6789 aliasing at the expense of precision loss in alias information.  The
6790 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
6791 for -O3.
6792
6793 Notice that if a function contains more memory statements than the
6794 value of this parameter, it is not really possible to achieve this
6795 reduction.  In this case, the compiler will use the number of memory
6796 statements as the value for @option{max-aliased-vops}.
6797
6798 @item avg-aliased-vops
6799
6800 Average number of virtual operands per statement allowed to represent
6801 aliases before triggering the alias partitioning heuristic.  This
6802 works in conjunction with @option{max-aliased-vops}.  If a function
6803 contains more than @option{max-aliased-vops} virtual operators, then
6804 memory symbols will be grouped into memory partitions until either the
6805 total number of virtual operators is below @option{max-aliased-vops}
6806 or the average number of virtual operators per memory statement is
6807 below @option{avg-aliased-vops}.  The default value for this parameter
6808 is 1 for -O1 and -O2, and 3 for -O3.
6809
6810 @item ggc-min-expand
6811
6812 GCC uses a garbage collector to manage its own memory allocation.  This
6813 parameter specifies the minimum percentage by which the garbage
6814 collector's heap should be allowed to expand between collections.
6815 Tuning this may improve compilation speed; it has no effect on code
6816 generation.
6817
6818 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6819 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6820 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6821 GCC is not able to calculate RAM on a particular platform, the lower
6822 bound of 30% is used.  Setting this parameter and
6823 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6824 every opportunity.  This is extremely slow, but can be useful for
6825 debugging.
6826
6827 @item ggc-min-heapsize
6828
6829 Minimum size of the garbage collector's heap before it begins bothering
6830 to collect garbage.  The first collection occurs after the heap expands
6831 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6832 tuning this may improve compilation speed, and has no effect on code
6833 generation.
6834
6835 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6836 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6837 with a lower bound of 4096 (four megabytes) and an upper bound of
6838 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6839 particular platform, the lower bound is used.  Setting this parameter
6840 very large effectively disables garbage collection.  Setting this
6841 parameter and @option{ggc-min-expand} to zero causes a full collection
6842 to occur at every opportunity.
6843
6844 @item max-reload-search-insns
6845 The maximum number of instruction reload should look backward for equivalent
6846 register.  Increasing values mean more aggressive optimization, making the
6847 compile time increase with probably slightly better performance.  The default
6848 value is 100.
6849
6850 @item max-cselib-memory-locations
6851 The maximum number of memory locations cselib should take into account.
6852 Increasing values mean more aggressive optimization, making the compile time
6853 increase with probably slightly better performance.  The default value is 500.
6854
6855 @item max-flow-memory-locations
6856 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6857 The default value is 100.
6858
6859 @item reorder-blocks-duplicate
6860 @itemx reorder-blocks-duplicate-feedback
6861
6862 Used by basic block reordering pass to decide whether to use unconditional
6863 branch or duplicate the code on its destination.  Code is duplicated when its
6864 estimated size is smaller than this value multiplied by the estimated size of
6865 unconditional jump in the hot spots of the program.
6866
6867 The @option{reorder-block-duplicate-feedback} is used only when profile
6868 feedback is available and may be set to higher values than
6869 @option{reorder-block-duplicate} since information about the hot spots is more
6870 accurate.
6871
6872 @item max-sched-ready-insns
6873 The maximum number of instructions ready to be issued the scheduler should
6874 consider at any given time during the first scheduling pass.  Increasing
6875 values mean more thorough searches, making the compilation time increase
6876 with probably little benefit.  The default value is 100.
6877
6878 @item max-sched-region-blocks
6879 The maximum number of blocks in a region to be considered for
6880 interblock scheduling.  The default value is 10.
6881
6882 @item max-sched-region-insns
6883 The maximum number of insns in a region to be considered for
6884 interblock scheduling.  The default value is 100.
6885
6886 @item min-spec-prob
6887 The minimum probability (in percents) of reaching a source block
6888 for interblock speculative scheduling.  The default value is 40.
6889
6890 @item max-sched-extend-regions-iters
6891 The maximum number of iterations through CFG to extend regions.
6892 0 - disable region extension,
6893 N - do at most N iterations.
6894 The default value is 0.
6895
6896 @item max-sched-insn-conflict-delay
6897 The maximum conflict delay for an insn to be considered for speculative motion.
6898 The default value is 3.
6899
6900 @item sched-spec-prob-cutoff
6901 The minimal probability of speculation success (in percents), so that
6902 speculative insn will be scheduled.
6903 The default value is 40.
6904
6905 @item max-last-value-rtl
6906
6907 The maximum size measured as number of RTLs that can be recorded in an expression
6908 in combiner for a pseudo register as last known value of that register.  The default
6909 is 10000.
6910
6911 @item integer-share-limit
6912 Small integer constants can use a shared data structure, reducing the
6913 compiler's memory usage and increasing its speed.  This sets the maximum
6914 value of a shared integer constant's.  The default value is 256.
6915
6916 @item min-virtual-mappings
6917 Specifies the minimum number of virtual mappings in the incremental
6918 SSA updater that should be registered to trigger the virtual mappings
6919 heuristic defined by virtual-mappings-ratio.  The default value is
6920 100.
6921
6922 @item virtual-mappings-ratio
6923 If the number of virtual mappings is virtual-mappings-ratio bigger
6924 than the number of virtual symbols to be updated, then the incremental
6925 SSA updater switches to a full update for those symbols.  The default
6926 ratio is 3.
6927
6928 @item ssp-buffer-size
6929 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6930 protection when @option{-fstack-protection} is used.
6931
6932 @item max-jump-thread-duplication-stmts
6933 Maximum number of statements allowed in a block that needs to be
6934 duplicated when threading jumps.
6935
6936 @item max-fields-for-field-sensitive
6937 Maximum number of fields in a structure we will treat in
6938 a field sensitive manner during pointer analysis.
6939
6940 @item prefetch-latency
6941 Estimate on average number of instructions that are executed before
6942 prefetch finishes.  The distance we prefetch ahead is proportional
6943 to this constant.  Increasing this number may also lead to less
6944 streams being prefetched (see @option{simultaneous-prefetches}).
6945
6946 @item simultaneous-prefetches
6947 Maximum number of prefetches that can run at the same time.
6948
6949 @item l1-cache-line-size
6950 The size of cache line in L1 cache, in bytes.
6951
6952 @item l1-cache-size
6953 The number of cache lines in L1 cache.
6954
6955 @item verify-canonical-types
6956 Whether the compiler should verify the ``canonical'' types used for
6957 type equality comparisons within the C++ and Objective-C++ front
6958 ends. Set to 1 (the default when GCC is configured with
6959 --enable-checking) to enable verification, 0 to disable verification
6960 (the default when GCC is configured with --disable-checking).
6961
6962 @end table
6963 @end table
6964
6965 @node Preprocessor Options
6966 @section Options Controlling the Preprocessor
6967 @cindex preprocessor options
6968 @cindex options, preprocessor
6969
6970 These options control the C preprocessor, which is run on each C source
6971 file before actual compilation.
6972
6973 If you use the @option{-E} option, nothing is done except preprocessing.
6974 Some of these options make sense only together with @option{-E} because
6975 they cause the preprocessor output to be unsuitable for actual
6976 compilation.
6977
6978 @table @gcctabopt
6979 @opindex Wp
6980 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6981 and pass @var{option} directly through to the preprocessor.  If
6982 @var{option} contains commas, it is split into multiple options at the
6983 commas.  However, many options are modified, translated or interpreted
6984 by the compiler driver before being passed to the preprocessor, and
6985 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6986 interface is undocumented and subject to change, so whenever possible
6987 you should avoid using @option{-Wp} and let the driver handle the
6988 options instead.
6989
6990 @item -Xpreprocessor @var{option}
6991 @opindex preprocessor
6992 Pass @var{option} as an option to the preprocessor.  You can use this to
6993 supply system-specific preprocessor options which GCC does not know how to
6994 recognize.
6995
6996 If you want to pass an option that takes an argument, you must use
6997 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6998 @end table
6999
7000 @include cppopts.texi
7001
7002 @node Assembler Options
7003 @section Passing Options to the Assembler
7004
7005 @c prevent bad page break with this line
7006 You can pass options to the assembler.
7007
7008 @table @gcctabopt
7009 @item -Wa,@var{option}
7010 @opindex Wa
7011 Pass @var{option} as an option to the assembler.  If @var{option}
7012 contains commas, it is split into multiple options at the commas.
7013
7014 @item -Xassembler @var{option}
7015 @opindex Xassembler
7016 Pass @var{option} as an option to the assembler.  You can use this to
7017 supply system-specific assembler options which GCC does not know how to
7018 recognize.
7019
7020 If you want to pass an option that takes an argument, you must use
7021 @option{-Xassembler} twice, once for the option and once for the argument.
7022
7023 @end table
7024
7025 @node Link Options
7026 @section Options for Linking
7027 @cindex link options
7028 @cindex options, linking
7029
7030 These options come into play when the compiler links object files into
7031 an executable output file.  They are meaningless if the compiler is
7032 not doing a link step.
7033
7034 @table @gcctabopt
7035 @cindex file names
7036 @item @var{object-file-name}
7037 A file name that does not end in a special recognized suffix is
7038 considered to name an object file or library.  (Object files are
7039 distinguished from libraries by the linker according to the file
7040 contents.)  If linking is done, these object files are used as input
7041 to the linker.
7042
7043 @item -c
7044 @itemx -S
7045 @itemx -E
7046 @opindex c
7047 @opindex S
7048 @opindex E
7049 If any of these options is used, then the linker is not run, and
7050 object file names should not be used as arguments.  @xref{Overall
7051 Options}.
7052
7053 @cindex Libraries
7054 @item -l@var{library}
7055 @itemx -l @var{library}
7056 @opindex l
7057 Search the library named @var{library} when linking.  (The second
7058 alternative with the library as a separate argument is only for
7059 POSIX compliance and is not recommended.)
7060
7061 It makes a difference where in the command you write this option; the
7062 linker searches and processes libraries and object files in the order they
7063 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7064 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7065 to functions in @samp{z}, those functions may not be loaded.
7066
7067 The linker searches a standard list of directories for the library,
7068 which is actually a file named @file{lib@var{library}.a}.  The linker
7069 then uses this file as if it had been specified precisely by name.
7070
7071 The directories searched include several standard system directories
7072 plus any that you specify with @option{-L}.
7073
7074 Normally the files found this way are library files---archive files
7075 whose members are object files.  The linker handles an archive file by
7076 scanning through it for members which define symbols that have so far
7077 been referenced but not defined.  But if the file that is found is an
7078 ordinary object file, it is linked in the usual fashion.  The only
7079 difference between using an @option{-l} option and specifying a file name
7080 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7081 and searches several directories.
7082
7083 @item -lobjc
7084 @opindex lobjc
7085 You need this special case of the @option{-l} option in order to
7086 link an Objective-C or Objective-C++ program.
7087
7088 @item -nostartfiles
7089 @opindex nostartfiles
7090 Do not use the standard system startup files when linking.
7091 The standard system libraries are used normally, unless @option{-nostdlib}
7092 or @option{-nodefaultlibs} is used.
7093
7094 @item -nodefaultlibs
7095 @opindex nodefaultlibs
7096 Do not use the standard system libraries when linking.
7097 Only the libraries you specify will be passed to the linker.
7098 The standard startup files are used normally, unless @option{-nostartfiles}
7099 is used.  The compiler may generate calls to @code{memcmp},
7100 @code{memset}, @code{memcpy} and @code{memmove}.
7101 These entries are usually resolved by entries in
7102 libc.  These entry points should be supplied through some other
7103 mechanism when this option is specified.
7104
7105 @item -nostdlib
7106 @opindex nostdlib
7107 Do not use the standard system startup files or libraries when linking.
7108 No startup files and only the libraries you specify will be passed to
7109 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7110 @code{memcpy} and @code{memmove}.
7111 These entries are usually resolved by entries in
7112 libc.  These entry points should be supplied through some other
7113 mechanism when this option is specified.
7114
7115 @cindex @option{-lgcc}, use with @option{-nostdlib}
7116 @cindex @option{-nostdlib} and unresolved references
7117 @cindex unresolved references and @option{-nostdlib}
7118 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7119 @cindex @option{-nodefaultlibs} and unresolved references
7120 @cindex unresolved references and @option{-nodefaultlibs}
7121 One of the standard libraries bypassed by @option{-nostdlib} and
7122 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7123 that GCC uses to overcome shortcomings of particular machines, or special
7124 needs for some languages.
7125 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7126 Collection (GCC) Internals},
7127 for more discussion of @file{libgcc.a}.)
7128 In most cases, you need @file{libgcc.a} even when you want to avoid
7129 other standard libraries.  In other words, when you specify @option{-nostdlib}
7130 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7131 This ensures that you have no unresolved references to internal GCC
7132 library subroutines.  (For example, @samp{__main}, used to ensure C++
7133 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7134 GNU Compiler Collection (GCC) Internals}.)
7135
7136 @item -pie
7137 @opindex pie
7138 Produce a position independent executable on targets which support it.
7139 For predictable results, you must also specify the same set of options
7140 that were used to generate code (@option{-fpie}, @option{-fPIE},
7141 or model suboptions) when you specify this option.
7142
7143 @item -rdynamic
7144 @opindex rdynamic
7145 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7146 that support it. This instructs the linker to add all symbols, not
7147 only used ones, to the dynamic symbol table. This option is needed
7148 for some uses of @code{dlopen} or to allow obtaining backtraces
7149 from within a program.
7150
7151 @item -s
7152 @opindex s
7153 Remove all symbol table and relocation information from the executable.
7154
7155 @item -static
7156 @opindex static
7157 On systems that support dynamic linking, this prevents linking with the shared
7158 libraries.  On other systems, this option has no effect.
7159
7160 @item -shared
7161 @opindex shared
7162 Produce a shared object which can then be linked with other objects to
7163 form an executable.  Not all systems support this option.  For predictable
7164 results, you must also specify the same set of options that were used to
7165 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7166 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7167 needs to build supplementary stub code for constructors to work.  On
7168 multi-libbed systems, @samp{gcc -shared} must select the correct support
7169 libraries to link against.  Failing to supply the correct flags may lead
7170 to subtle defects.  Supplying them in cases where they are not necessary
7171 is innocuous.}
7172
7173 @item -shared-libgcc
7174 @itemx -static-libgcc
7175 @opindex shared-libgcc
7176 @opindex static-libgcc
7177 On systems that provide @file{libgcc} as a shared library, these options
7178 force the use of either the shared or static version respectively.
7179 If no shared version of @file{libgcc} was built when the compiler was
7180 configured, these options have no effect.
7181
7182 There are several situations in which an application should use the
7183 shared @file{libgcc} instead of the static version.  The most common
7184 of these is when the application wishes to throw and catch exceptions
7185 across different shared libraries.  In that case, each of the libraries
7186 as well as the application itself should use the shared @file{libgcc}.
7187
7188 Therefore, the G++ and GCJ drivers automatically add
7189 @option{-shared-libgcc} whenever you build a shared library or a main
7190 executable, because C++ and Java programs typically use exceptions, so
7191 this is the right thing to do.
7192
7193 If, instead, you use the GCC driver to create shared libraries, you may
7194 find that they will not always be linked with the shared @file{libgcc}.
7195 If GCC finds, at its configuration time, that you have a non-GNU linker
7196 or a GNU linker that does not support option @option{--eh-frame-hdr},
7197 it will link the shared version of @file{libgcc} into shared libraries
7198 by default.  Otherwise, it will take advantage of the linker and optimize
7199 away the linking with the shared version of @file{libgcc}, linking with
7200 the static version of libgcc by default.  This allows exceptions to
7201 propagate through such shared libraries, without incurring relocation
7202 costs at library load time.
7203
7204 However, if a library or main executable is supposed to throw or catch
7205 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7206 for the languages used in the program, or using the option
7207 @option{-shared-libgcc}, such that it is linked with the shared
7208 @file{libgcc}.
7209
7210 @item -symbolic
7211 @opindex symbolic
7212 Bind references to global symbols when building a shared object.  Warn
7213 about any unresolved references (unless overridden by the link editor
7214 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7215 this option.
7216
7217 @item -Xlinker @var{option}
7218 @opindex Xlinker
7219 Pass @var{option} as an option to the linker.  You can use this to
7220 supply system-specific linker options which GCC does not know how to
7221 recognize.
7222
7223 If you want to pass an option that takes an argument, you must use
7224 @option{-Xlinker} twice, once for the option and once for the argument.
7225 For example, to pass @option{-assert definitions}, you must write
7226 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7227 @option{-Xlinker "-assert definitions"}, because this passes the entire
7228 string as a single argument, which is not what the linker expects.
7229
7230 @item -Wl,@var{option}
7231 @opindex Wl
7232 Pass @var{option} as an option to the linker.  If @var{option} contains
7233 commas, it is split into multiple options at the commas.
7234
7235 @item -u @var{symbol}
7236 @opindex u
7237 Pretend the symbol @var{symbol} is undefined, to force linking of
7238 library modules to define it.  You can use @option{-u} multiple times with
7239 different symbols to force loading of additional library modules.
7240 @end table
7241
7242 @node Directory Options
7243 @section Options for Directory Search
7244 @cindex directory options
7245 @cindex options, directory search
7246 @cindex search path
7247
7248 These options specify directories to search for header files, for
7249 libraries and for parts of the compiler:
7250
7251 @table @gcctabopt
7252 @item -I@var{dir}
7253 @opindex I
7254 Add the directory @var{dir} to the head of the list of directories to be
7255 searched for header files.  This can be used to override a system header
7256 file, substituting your own version, since these directories are
7257 searched before the system header file directories.  However, you should
7258 not use this option to add directories that contain vendor-supplied
7259 system header files (use @option{-isystem} for that).  If you use more than
7260 one @option{-I} option, the directories are scanned in left-to-right
7261 order; the standard system directories come after.
7262
7263 If a standard system include directory, or a directory specified with
7264 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7265 option will be ignored.  The directory will still be searched but as a
7266 system directory at its normal position in the system include chain.
7267 This is to ensure that GCC's procedure to fix buggy system headers and
7268 the ordering for the include_next directive are not inadvertently changed.
7269 If you really need to change the search order for system directories,
7270 use the @option{-nostdinc} and/or @option{-isystem} options.
7271
7272 @item -iquote@var{dir}
7273 @opindex iquote
7274 Add the directory @var{dir} to the head of the list of directories to
7275 be searched for header files only for the case of @samp{#include
7276 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7277 otherwise just like @option{-I}.
7278
7279 @item -L@var{dir}
7280 @opindex L
7281 Add directory @var{dir} to the list of directories to be searched
7282 for @option{-l}.
7283
7284 @item -B@var{prefix}
7285 @opindex B
7286 This option specifies where to find the executables, libraries,
7287 include files, and data files of the compiler itself.
7288
7289 The compiler driver program runs one or more of the subprograms
7290 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7291 @var{prefix} as a prefix for each program it tries to run, both with and
7292 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7293
7294 For each subprogram to be run, the compiler driver first tries the
7295 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7296 was not specified, the driver tries two standard prefixes, which are
7297 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7298 those results in a file name that is found, the unmodified program
7299 name is searched for using the directories specified in your
7300 @env{PATH} environment variable.
7301
7302 The compiler will check to see if the path provided by the @option{-B}
7303 refers to a directory, and if necessary it will add a directory
7304 separator character at the end of the path.
7305
7306 @option{-B} prefixes that effectively specify directory names also apply
7307 to libraries in the linker, because the compiler translates these
7308 options into @option{-L} options for the linker.  They also apply to
7309 includes files in the preprocessor, because the compiler translates these
7310 options into @option{-isystem} options for the preprocessor.  In this case,
7311 the compiler appends @samp{include} to the prefix.
7312
7313 The run-time support file @file{libgcc.a} can also be searched for using
7314 the @option{-B} prefix, if needed.  If it is not found there, the two
7315 standard prefixes above are tried, and that is all.  The file is left
7316 out of the link if it is not found by those means.
7317
7318 Another way to specify a prefix much like the @option{-B} prefix is to use
7319 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7320 Variables}.
7321
7322 As a special kludge, if the path provided by @option{-B} is
7323 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7324 9, then it will be replaced by @file{[dir/]include}.  This is to help
7325 with boot-strapping the compiler.
7326
7327 @item -specs=@var{file}
7328 @opindex specs
7329 Process @var{file} after the compiler reads in the standard @file{specs}
7330 file, in order to override the defaults that the @file{gcc} driver
7331 program uses when determining what switches to pass to @file{cc1},
7332 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7333 @option{-specs=@var{file}} can be specified on the command line, and they
7334 are processed in order, from left to right.
7335
7336 @item --sysroot=@var{dir}
7337 @opindex sysroot
7338 Use @var{dir} as the logical root directory for headers and libraries.
7339 For example, if the compiler would normally search for headers in
7340 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7341 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7342
7343 If you use both this option and the @option{-isysroot} option, then
7344 the @option{--sysroot} option will apply to libraries, but the
7345 @option{-isysroot} option will apply to header files.
7346
7347 The GNU linker (beginning with version 2.16) has the necessary support
7348 for this option.  If your linker does not support this option, the
7349 header file aspect of @option{--sysroot} will still work, but the
7350 library aspect will not.
7351
7352 @item -I-
7353 @opindex I-
7354 This option has been deprecated.  Please use @option{-iquote} instead for
7355 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7356 Any directories you specify with @option{-I} options before the @option{-I-}
7357 option are searched only for the case of @samp{#include "@var{file}"};
7358 they are not searched for @samp{#include <@var{file}>}.
7359
7360 If additional directories are specified with @option{-I} options after
7361 the @option{-I-}, these directories are searched for all @samp{#include}
7362 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7363 this way.)
7364
7365 In addition, the @option{-I-} option inhibits the use of the current
7366 directory (where the current input file came from) as the first search
7367 directory for @samp{#include "@var{file}"}.  There is no way to
7368 override this effect of @option{-I-}.  With @option{-I.} you can specify
7369 searching the directory which was current when the compiler was
7370 invoked.  That is not exactly the same as what the preprocessor does
7371 by default, but it is often satisfactory.
7372
7373 @option{-I-} does not inhibit the use of the standard system directories
7374 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7375 independent.
7376 @end table
7377
7378 @c man end
7379
7380 @node Spec Files
7381 @section Specifying subprocesses and the switches to pass to them
7382 @cindex Spec Files
7383
7384 @command{gcc} is a driver program.  It performs its job by invoking a
7385 sequence of other programs to do the work of compiling, assembling and
7386 linking.  GCC interprets its command-line parameters and uses these to
7387 deduce which programs it should invoke, and which command-line options
7388 it ought to place on their command lines.  This behavior is controlled
7389 by @dfn{spec strings}.  In most cases there is one spec string for each
7390 program that GCC can invoke, but a few programs have multiple spec
7391 strings to control their behavior.  The spec strings built into GCC can
7392 be overridden by using the @option{-specs=} command-line switch to specify
7393 a spec file.
7394
7395 @dfn{Spec files} are plaintext files that are used to construct spec
7396 strings.  They consist of a sequence of directives separated by blank
7397 lines.  The type of directive is determined by the first non-whitespace
7398 character on the line and it can be one of the following:
7399
7400 @table @code
7401 @item %@var{command}
7402 Issues a @var{command} to the spec file processor.  The commands that can
7403 appear here are:
7404
7405 @table @code
7406 @item %include <@var{file}>
7407 @cindex %include
7408 Search for @var{file} and insert its text at the current point in the
7409 specs file.
7410
7411 @item %include_noerr <@var{file}>
7412 @cindex %include_noerr
7413 Just like @samp{%include}, but do not generate an error message if the include
7414 file cannot be found.
7415
7416 @item %rename @var{old_name} @var{new_name}
7417 @cindex %rename
7418 Rename the spec string @var{old_name} to @var{new_name}.
7419
7420 @end table
7421
7422 @item *[@var{spec_name}]:
7423 This tells the compiler to create, override or delete the named spec
7424 string.  All lines after this directive up to the next directive or
7425 blank line are considered to be the text for the spec string.  If this
7426 results in an empty string then the spec will be deleted.  (Or, if the
7427 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7428 does not currently exist a new spec will be created.  If the spec does
7429 exist then its contents will be overridden by the text of this
7430 directive, unless the first character of that text is the @samp{+}
7431 character, in which case the text will be appended to the spec.
7432
7433 @item [@var{suffix}]:
7434 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7435 and up to the next directive or blank line are considered to make up the
7436 spec string for the indicated suffix.  When the compiler encounters an
7437 input file with the named suffix, it will processes the spec string in
7438 order to work out how to compile that file.  For example:
7439
7440 @smallexample
7441 .ZZ:
7442 z-compile -input %i
7443 @end smallexample
7444
7445 This says that any input file whose name ends in @samp{.ZZ} should be
7446 passed to the program @samp{z-compile}, which should be invoked with the
7447 command-line switch @option{-input} and with the result of performing the
7448 @samp{%i} substitution.  (See below.)
7449
7450 As an alternative to providing a spec string, the text that follows a
7451 suffix directive can be one of the following:
7452
7453 @table @code
7454 @item @@@var{language}
7455 This says that the suffix is an alias for a known @var{language}.  This is
7456 similar to using the @option{-x} command-line switch to GCC to specify a
7457 language explicitly.  For example:
7458
7459 @smallexample
7460 .ZZ:
7461 @@c++
7462 @end smallexample
7463
7464 Says that .ZZ files are, in fact, C++ source files.
7465
7466 @item #@var{name}
7467 This causes an error messages saying:
7468
7469 @smallexample
7470 @var{name} compiler not installed on this system.
7471 @end smallexample
7472 @end table
7473
7474 GCC already has an extensive list of suffixes built into it.
7475 This directive will add an entry to the end of the list of suffixes, but
7476 since the list is searched from the end backwards, it is effectively
7477 possible to override earlier entries using this technique.
7478
7479 @end table
7480
7481 GCC has the following spec strings built into it.  Spec files can
7482 override these strings or create their own.  Note that individual
7483 targets can also add their own spec strings to this list.
7484
7485 @smallexample
7486 asm          Options to pass to the assembler
7487 asm_final    Options to pass to the assembler post-processor
7488 cpp          Options to pass to the C preprocessor
7489 cc1          Options to pass to the C compiler
7490 cc1plus      Options to pass to the C++ compiler
7491 endfile      Object files to include at the end of the link
7492 link         Options to pass to the linker
7493 lib          Libraries to include on the command line to the linker
7494 libgcc       Decides which GCC support library to pass to the linker
7495 linker       Sets the name of the linker
7496 predefines   Defines to be passed to the C preprocessor
7497 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7498              by default
7499 startfile    Object files to include at the start of the link
7500 @end smallexample
7501
7502 Here is a small example of a spec file:
7503
7504 @smallexample
7505 %rename lib                 old_lib
7506
7507 *lib:
7508 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7509 @end smallexample
7510
7511 This example renames the spec called @samp{lib} to @samp{old_lib} and
7512 then overrides the previous definition of @samp{lib} with a new one.
7513 The new definition adds in some extra command-line options before
7514 including the text of the old definition.
7515
7516 @dfn{Spec strings} are a list of command-line options to be passed to their
7517 corresponding program.  In addition, the spec strings can contain
7518 @samp{%}-prefixed sequences to substitute variable text or to
7519 conditionally insert text into the command line.  Using these constructs
7520 it is possible to generate quite complex command lines.
7521
7522 Here is a table of all defined @samp{%}-sequences for spec
7523 strings.  Note that spaces are not generated automatically around the
7524 results of expanding these sequences.  Therefore you can concatenate them
7525 together or combine them with constant text in a single argument.
7526
7527 @table @code
7528 @item %%
7529 Substitute one @samp{%} into the program name or argument.
7530
7531 @item %i
7532 Substitute the name of the input file being processed.
7533
7534 @item %b
7535 Substitute the basename of the input file being processed.
7536 This is the substring up to (and not including) the last period
7537 and not including the directory.
7538
7539 @item %B
7540 This is the same as @samp{%b}, but include the file suffix (text after
7541 the last period).
7542
7543 @item %d
7544 Marks the argument containing or following the @samp{%d} as a
7545 temporary file name, so that that file will be deleted if GCC exits
7546 successfully.  Unlike @samp{%g}, this contributes no text to the
7547 argument.
7548
7549 @item %g@var{suffix}
7550 Substitute a file name that has suffix @var{suffix} and is chosen
7551 once per compilation, and mark the argument in the same way as
7552 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7553 name is now chosen in a way that is hard to predict even when previously
7554 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7555 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7556 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7557 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7558 was simply substituted with a file name chosen once per compilation,
7559 without regard to any appended suffix (which was therefore treated
7560 just like ordinary text), making such attacks more likely to succeed.
7561
7562 @item %u@var{suffix}
7563 Like @samp{%g}, but generates a new temporary file name even if
7564 @samp{%u@var{suffix}} was already seen.
7565
7566 @item %U@var{suffix}
7567 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7568 new one if there is no such last file name.  In the absence of any
7569 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7570 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7571 would involve the generation of two distinct file names, one
7572 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7573 simply substituted with a file name chosen for the previous @samp{%u},
7574 without regard to any appended suffix.
7575
7576 @item %j@var{suffix}
7577 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7578 writable, and if save-temps is off; otherwise, substitute the name
7579 of a temporary file, just like @samp{%u}.  This temporary file is not
7580 meant for communication between processes, but rather as a junk
7581 disposal mechanism.
7582
7583 @item %|@var{suffix}
7584 @itemx %m@var{suffix}
7585 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7586 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7587 all.  These are the two most common ways to instruct a program that it
7588 should read from standard input or write to standard output.  If you
7589 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7590 construct: see for example @file{f/lang-specs.h}.
7591
7592 @item %.@var{SUFFIX}
7593 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7594 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7595 terminated by the next space or %.
7596
7597 @item %w
7598 Marks the argument containing or following the @samp{%w} as the
7599 designated output file of this compilation.  This puts the argument
7600 into the sequence of arguments that @samp{%o} will substitute later.
7601
7602 @item %o
7603 Substitutes the names of all the output files, with spaces
7604 automatically placed around them.  You should write spaces
7605 around the @samp{%o} as well or the results are undefined.
7606 @samp{%o} is for use in the specs for running the linker.
7607 Input files whose names have no recognized suffix are not compiled
7608 at all, but they are included among the output files, so they will
7609 be linked.
7610
7611 @item %O
7612 Substitutes the suffix for object files.  Note that this is
7613 handled specially when it immediately follows @samp{%g, %u, or %U},
7614 because of the need for those to form complete file names.  The
7615 handling is such that @samp{%O} is treated exactly as if it had already
7616 been substituted, except that @samp{%g, %u, and %U} do not currently
7617 support additional @var{suffix} characters following @samp{%O} as they would
7618 following, for example, @samp{.o}.
7619
7620 @item %p
7621 Substitutes the standard macro predefinitions for the
7622 current target machine.  Use this when running @code{cpp}.
7623
7624 @item %P
7625 Like @samp{%p}, but puts @samp{__} before and after the name of each
7626 predefined macro, except for macros that start with @samp{__} or with
7627 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7628 C@.
7629
7630 @item %I
7631 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7632 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7633 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7634 and @option{-imultilib} as necessary.
7635
7636 @item %s
7637 Current argument is the name of a library or startup file of some sort.
7638 Search for that file in a standard list of directories and substitute
7639 the full name found.
7640
7641 @item %e@var{str}
7642 Print @var{str} as an error message.  @var{str} is terminated by a newline.
7643 Use this when inconsistent options are detected.
7644
7645 @item %(@var{name})
7646 Substitute the contents of spec string @var{name} at this point.
7647
7648 @item %[@var{name}]
7649 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7650
7651 @item %x@{@var{option}@}
7652 Accumulate an option for @samp{%X}.
7653
7654 @item %X
7655 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7656 spec string.
7657
7658 @item %Y
7659 Output the accumulated assembler options specified by @option{-Wa}.
7660
7661 @item %Z
7662 Output the accumulated preprocessor options specified by @option{-Wp}.
7663
7664 @item %a
7665 Process the @code{asm} spec.  This is used to compute the
7666 switches to be passed to the assembler.
7667
7668 @item %A
7669 Process the @code{asm_final} spec.  This is a spec string for
7670 passing switches to an assembler post-processor, if such a program is
7671 needed.
7672
7673 @item %l
7674 Process the @code{link} spec.  This is the spec for computing the
7675 command line passed to the linker.  Typically it will make use of the
7676 @samp{%L %G %S %D and %E} sequences.
7677
7678 @item %D
7679 Dump out a @option{-L} option for each directory that GCC believes might
7680 contain startup files.  If the target supports multilibs then the
7681 current multilib directory will be prepended to each of these paths.
7682
7683 @item %L
7684 Process the @code{lib} spec.  This is a spec string for deciding which
7685 libraries should be included on the command line to the linker.
7686
7687 @item %G
7688 Process the @code{libgcc} spec.  This is a spec string for deciding
7689 which GCC support library should be included on the command line to the linker.
7690
7691 @item %S
7692 Process the @code{startfile} spec.  This is a spec for deciding which
7693 object files should be the first ones passed to the linker.  Typically
7694 this might be a file named @file{crt0.o}.
7695
7696 @item %E
7697 Process the @code{endfile} spec.  This is a spec string that specifies
7698 the last object files that will be passed to the linker.
7699
7700 @item %C
7701 Process the @code{cpp} spec.  This is used to construct the arguments
7702 to be passed to the C preprocessor.
7703
7704 @item %1
7705 Process the @code{cc1} spec.  This is used to construct the options to be
7706 passed to the actual C compiler (@samp{cc1}).
7707
7708 @item %2
7709 Process the @code{cc1plus} spec.  This is used to construct the options to be
7710 passed to the actual C++ compiler (@samp{cc1plus}).
7711
7712 @item %*
7713 Substitute the variable part of a matched option.  See below.
7714 Note that each comma in the substituted string is replaced by
7715 a single space.
7716
7717 @item %<@code{S}
7718 Remove all occurrences of @code{-S} from the command line.  Note---this
7719 command is position dependent.  @samp{%} commands in the spec string
7720 before this one will see @code{-S}, @samp{%} commands in the spec string
7721 after this one will not.
7722
7723 @item %:@var{function}(@var{args})
7724 Call the named function @var{function}, passing it @var{args}.
7725 @var{args} is first processed as a nested spec string, then split
7726 into an argument vector in the usual fashion.  The function returns
7727 a string which is processed as if it had appeared literally as part
7728 of the current spec.
7729
7730 The following built-in spec functions are provided:
7731
7732 @table @code
7733 @item @code{getenv}
7734 The @code{getenv} spec function takes two arguments: an environment
7735 variable name and a string.  If the environment variable is not
7736 defined, a fatal error is issued.  Otherwise, the return value is the
7737 value of the environment variable concatenated with the string.  For
7738 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
7739
7740 @smallexample
7741 %:getenv(TOPDIR /include)
7742 @end smallexample
7743
7744 expands to @file{/path/to/top/include}.
7745
7746 @item @code{if-exists}
7747 The @code{if-exists} spec function takes one argument, an absolute
7748 pathname to a file.  If the file exists, @code{if-exists} returns the
7749 pathname.  Here is a small example of its usage:
7750
7751 @smallexample
7752 *startfile:
7753 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7754 @end smallexample
7755
7756 @item @code{if-exists-else}
7757 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7758 spec function, except that it takes two arguments.  The first argument is
7759 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7760 returns the pathname.  If it does not exist, it returns the second argument.
7761 This way, @code{if-exists-else} can be used to select one file or another,
7762 based on the existence of the first.  Here is a small example of its usage:
7763
7764 @smallexample
7765 *startfile:
7766 crt0%O%s %:if-exists(crti%O%s) \
7767 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7768 @end smallexample
7769
7770 @item @code{replace-outfile}
7771 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7772 first argument in the outfiles array and replaces it with the second argument.  Here
7773 is a small example of its usage:
7774
7775 @smallexample
7776 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7777 @end smallexample
7778
7779 @item @code{print-asm-header}
7780 The @code{print-asm-header} function takes no arguments and simply
7781 prints a banner like:
7782
7783 @smallexample
7784 Assembler options
7785 =================
7786
7787 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
7788 @end smallexample
7789
7790 It is used to separate compiler options from assembler options
7791 in the @option{--target-help} output.
7792 @end table
7793
7794 @item %@{@code{S}@}
7795 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7796 If that switch was not specified, this substitutes nothing.  Note that
7797 the leading dash is omitted when specifying this option, and it is
7798 automatically inserted if the substitution is performed.  Thus the spec
7799 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7800 and would output the command line option @option{-foo}.
7801
7802 @item %W@{@code{S}@}
7803 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7804 deleted on failure.
7805
7806 @item %@{@code{S}*@}
7807 Substitutes all the switches specified to GCC whose names start
7808 with @code{-S}, but which also take an argument.  This is used for
7809 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7810 GCC considers @option{-o foo} as being
7811 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7812 text, including the space.  Thus two arguments would be generated.
7813
7814 @item %@{@code{S}*&@code{T}*@}
7815 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7816 (the order of @code{S} and @code{T} in the spec is not significant).
7817 There can be any number of ampersand-separated variables; for each the
7818 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7819
7820 @item %@{@code{S}:@code{X}@}
7821 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7822
7823 @item %@{!@code{S}:@code{X}@}
7824 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7825
7826 @item %@{@code{S}*:@code{X}@}
7827 Substitutes @code{X} if one or more switches whose names start with
7828 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7829 once, no matter how many such switches appeared.  However, if @code{%*}
7830 appears somewhere in @code{X}, then @code{X} will be substituted once
7831 for each matching switch, with the @code{%*} replaced by the part of
7832 that switch that matched the @code{*}.
7833
7834 @item %@{.@code{S}:@code{X}@}
7835 Substitutes @code{X}, if processing a file with suffix @code{S}.
7836
7837 @item %@{!.@code{S}:@code{X}@}
7838 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7839
7840 @item %@{,@code{S}:@code{X}@}
7841 Substitutes @code{X}, if processing a file for language @code{S}.
7842
7843 @item %@{!,@code{S}:@code{X}@}
7844 Substitutes @code{X}, if not processing a file for language @code{S}.
7845
7846 @item %@{@code{S}|@code{P}:@code{X}@}
7847 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
7848 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
7849 @code{*} sequences as well, although they have a stronger binding than
7850 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
7851 alternatives must be starred, and only the first matching alternative
7852 is substituted.
7853
7854 For example, a spec string like this:
7855
7856 @smallexample
7857 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7858 @end smallexample
7859
7860 will output the following command-line options from the following input
7861 command-line options:
7862
7863 @smallexample
7864 fred.c        -foo -baz
7865 jim.d         -bar -boggle
7866 -d fred.c     -foo -baz -boggle
7867 -d jim.d      -bar -baz -boggle
7868 @end smallexample
7869
7870 @item %@{S:X; T:Y; :D@}
7871
7872 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7873 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7874 be as many clauses as you need.  This may be combined with @code{.},
7875 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
7876
7877
7878 @end table
7879
7880 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7881 construct may contain other nested @samp{%} constructs or spaces, or
7882 even newlines.  They are processed as usual, as described above.
7883 Trailing white space in @code{X} is ignored.  White space may also
7884 appear anywhere on the left side of the colon in these constructs,
7885 except between @code{.} or @code{*} and the corresponding word.
7886
7887 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7888 handled specifically in these constructs.  If another value of
7889 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7890 @option{-W} switch is found later in the command line, the earlier
7891 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7892 just one letter, which passes all matching options.
7893
7894 The character @samp{|} at the beginning of the predicate text is used to
7895 indicate that a command should be piped to the following command, but
7896 only if @option{-pipe} is specified.
7897
7898 It is built into GCC which switches take arguments and which do not.
7899 (You might think it would be useful to generalize this to allow each
7900 compiler's spec to say which switches take arguments.  But this cannot
7901 be done in a consistent fashion.  GCC cannot even decide which input
7902 files have been specified without knowing which switches take arguments,
7903 and it must know which input files to compile in order to tell which
7904 compilers to run).
7905
7906 GCC also knows implicitly that arguments starting in @option{-l} are to be
7907 treated as compiler output files, and passed to the linker in their
7908 proper position among the other output files.
7909
7910 @c man begin OPTIONS
7911
7912 @node Target Options
7913 @section Specifying Target Machine and Compiler Version
7914 @cindex target options
7915 @cindex cross compiling
7916 @cindex specifying machine version
7917 @cindex specifying compiler version and target machine
7918 @cindex compiler version, specifying
7919 @cindex target machine, specifying
7920
7921 The usual way to run GCC is to run the executable called @file{gcc}, or
7922 @file{<machine>-gcc} when cross-compiling, or
7923 @file{<machine>-gcc-<version>} to run a version other than the one that
7924 was installed last.  Sometimes this is inconvenient, so GCC provides
7925 options that will switch to another cross-compiler or version.
7926
7927 @table @gcctabopt
7928 @item -b @var{machine}
7929 @opindex b
7930 The argument @var{machine} specifies the target machine for compilation.
7931
7932 The value to use for @var{machine} is the same as was specified as the
7933 machine type when configuring GCC as a cross-compiler.  For
7934 example, if a cross-compiler was configured with @samp{configure
7935 arm-elf}, meaning to compile for an arm processor with elf binaries,
7936 then you would specify @option{-b arm-elf} to run that cross compiler.
7937 Because there are other options beginning with @option{-b}, the
7938 configuration must contain a hyphen.
7939
7940 @item -V @var{version}
7941 @opindex V
7942 The argument @var{version} specifies which version of GCC to run.
7943 This is useful when multiple versions are installed.  For example,
7944 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7945 @end table
7946
7947 The @option{-V} and @option{-b} options work by running the
7948 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7949 use them if you can just run that directly.
7950
7951 @node Submodel Options
7952 @section Hardware Models and Configurations
7953 @cindex submodel options
7954 @cindex specifying hardware config
7955 @cindex hardware models and configurations, specifying
7956 @cindex machine dependent options
7957
7958 Earlier we discussed the standard option @option{-b} which chooses among
7959 different installed compilers for completely different target
7960 machines, such as VAX vs.@: 68000 vs.@: 80386.
7961
7962 In addition, each of these target machine types can have its own
7963 special options, starting with @samp{-m}, to choose among various
7964 hardware models or configurations---for example, 68010 vs 68020,
7965 floating coprocessor or none.  A single installed version of the
7966 compiler can compile for any model or configuration, according to the
7967 options specified.
7968
7969 Some configurations of the compiler also support additional special
7970 options, usually for compatibility with other compilers on the same
7971 platform.
7972
7973 @c This list is ordered alphanumerically by subsection name.
7974 @c It should be the same order and spelling as these options are listed
7975 @c in Machine Dependent Options
7976
7977 @menu
7978 * ARC Options::
7979 * ARM Options::
7980 * AVR Options::
7981 * Blackfin Options::
7982 * CRIS Options::
7983 * CRX Options::
7984 * Darwin Options::
7985 * DEC Alpha Options::
7986 * DEC Alpha/VMS Options::
7987 * FRV Options::
7988 * GNU/Linux Options::
7989 * H8/300 Options::
7990 * HPPA Options::
7991 * i386 and x86-64 Options::
7992 * IA-64 Options::
7993 * M32C Options::
7994 * M32R/D Options::
7995 * M680x0 Options::
7996 * M68hc1x Options::
7997 * MCore Options::
7998 * MIPS Options::
7999 * MMIX Options::
8000 * MN10300 Options::
8001 * MT Options::
8002 * PDP-11 Options::
8003 * PowerPC Options::
8004 * RS/6000 and PowerPC Options::
8005 * S/390 and zSeries Options::
8006 * Score Options::
8007 * SH Options::
8008 * SPARC Options::
8009 * SPU Options::
8010 * System V Options::
8011 * TMS320C3x/C4x Options::
8012 * V850 Options::
8013 * VAX Options::
8014 * VxWorks Options::
8015 * x86-64 Options::
8016 * Xstormy16 Options::
8017 * Xtensa Options::
8018 * zSeries Options::
8019 @end menu
8020
8021 @node ARC Options
8022 @subsection ARC Options
8023 @cindex ARC Options
8024
8025 These options are defined for ARC implementations:
8026
8027 @table @gcctabopt
8028 @item -EL
8029 @opindex EL
8030 Compile code for little endian mode.  This is the default.
8031
8032 @item -EB
8033 @opindex EB
8034 Compile code for big endian mode.
8035
8036 @item -mmangle-cpu
8037 @opindex mmangle-cpu
8038 Prepend the name of the cpu to all public symbol names.
8039 In multiple-processor systems, there are many ARC variants with different
8040 instruction and register set characteristics.  This flag prevents code
8041 compiled for one cpu to be linked with code compiled for another.
8042 No facility exists for handling variants that are ``almost identical''.
8043 This is an all or nothing option.
8044
8045 @item -mcpu=@var{cpu}
8046 @opindex mcpu
8047 Compile code for ARC variant @var{cpu}.
8048 Which variants are supported depend on the configuration.
8049 All variants support @option{-mcpu=base}, this is the default.
8050
8051 @item -mtext=@var{text-section}
8052 @itemx -mdata=@var{data-section}
8053 @itemx -mrodata=@var{readonly-data-section}
8054 @opindex mtext
8055 @opindex mdata
8056 @opindex mrodata
8057 Put functions, data, and readonly data in @var{text-section},
8058 @var{data-section}, and @var{readonly-data-section} respectively
8059 by default.  This can be overridden with the @code{section} attribute.
8060 @xref{Variable Attributes}.
8061
8062 @end table
8063
8064 @node ARM Options
8065 @subsection ARM Options
8066 @cindex ARM options
8067
8068 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8069 architectures:
8070
8071 @table @gcctabopt
8072 @item -mabi=@var{name}
8073 @opindex mabi
8074 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8075 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8076
8077 @item -mapcs-frame
8078 @opindex mapcs-frame
8079 Generate a stack frame that is compliant with the ARM Procedure Call
8080 Standard for all functions, even if this is not strictly necessary for
8081 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8082 with this option will cause the stack frames not to be generated for
8083 leaf functions.  The default is @option{-mno-apcs-frame}.
8084
8085 @item -mapcs
8086 @opindex mapcs
8087 This is a synonym for @option{-mapcs-frame}.
8088
8089 @ignore
8090 @c not currently implemented
8091 @item -mapcs-stack-check
8092 @opindex mapcs-stack-check
8093 Generate code to check the amount of stack space available upon entry to
8094 every function (that actually uses some stack space).  If there is
8095 insufficient space available then either the function
8096 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8097 called, depending upon the amount of stack space required.  The run time
8098 system is required to provide these functions.  The default is
8099 @option{-mno-apcs-stack-check}, since this produces smaller code.
8100
8101 @c not currently implemented
8102 @item -mapcs-float
8103 @opindex mapcs-float
8104 Pass floating point arguments using the float point registers.  This is
8105 one of the variants of the APCS@.  This option is recommended if the
8106 target hardware has a floating point unit or if a lot of floating point
8107 arithmetic is going to be performed by the code.  The default is
8108 @option{-mno-apcs-float}, since integer only code is slightly increased in
8109 size if @option{-mapcs-float} is used.
8110
8111 @c not currently implemented
8112 @item -mapcs-reentrant
8113 @opindex mapcs-reentrant
8114 Generate reentrant, position independent code.  The default is
8115 @option{-mno-apcs-reentrant}.
8116 @end ignore
8117
8118 @item -mthumb-interwork
8119 @opindex mthumb-interwork
8120 Generate code which supports calling between the ARM and Thumb
8121 instruction sets.  Without this option the two instruction sets cannot
8122 be reliably used inside one program.  The default is
8123 @option{-mno-thumb-interwork}, since slightly larger code is generated
8124 when @option{-mthumb-interwork} is specified.
8125
8126 @item -mno-sched-prolog
8127 @opindex mno-sched-prolog
8128 Prevent the reordering of instructions in the function prolog, or the
8129 merging of those instruction with the instructions in the function's
8130 body.  This means that all functions will start with a recognizable set
8131 of instructions (or in fact one of a choice from a small set of
8132 different function prologues), and this information can be used to
8133 locate the start if functions inside an executable piece of code.  The
8134 default is @option{-msched-prolog}.
8135
8136 @item -mhard-float
8137 @opindex mhard-float
8138 Generate output containing floating point instructions.  This is the
8139 default.
8140
8141 @item -msoft-float
8142 @opindex msoft-float
8143 Generate output containing library calls for floating point.
8144 @strong{Warning:} the requisite libraries are not available for all ARM
8145 targets.  Normally the facilities of the machine's usual C compiler are
8146 used, but this cannot be done directly in cross-compilation.  You must make
8147 your own arrangements to provide suitable library functions for
8148 cross-compilation.
8149
8150 @option{-msoft-float} changes the calling convention in the output file;
8151 therefore, it is only useful if you compile @emph{all} of a program with
8152 this option.  In particular, you need to compile @file{libgcc.a}, the
8153 library that comes with GCC, with @option{-msoft-float} in order for
8154 this to work.
8155
8156 @item -mfloat-abi=@var{name}
8157 @opindex mfloat-abi
8158 Specifies which ABI to use for floating point values.  Permissible values
8159 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8160
8161 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8162 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8163 of floating point instructions, but still uses the soft-float calling
8164 conventions.
8165
8166 @item -mlittle-endian
8167 @opindex mlittle-endian
8168 Generate code for a processor running in little-endian mode.  This is
8169 the default for all standard configurations.
8170
8171 @item -mbig-endian
8172 @opindex mbig-endian
8173 Generate code for a processor running in big-endian mode; the default is
8174 to compile code for a little-endian processor.
8175
8176 @item -mwords-little-endian
8177 @opindex mwords-little-endian
8178 This option only applies when generating code for big-endian processors.
8179 Generate code for a little-endian word order but a big-endian byte
8180 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8181 option should only be used if you require compatibility with code for
8182 big-endian ARM processors generated by versions of the compiler prior to
8183 2.8.
8184
8185 @item -mcpu=@var{name}
8186 @opindex mcpu
8187 This specifies the name of the target ARM processor.  GCC uses this name
8188 to determine what kind of instructions it can emit when generating
8189 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8190 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8191 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8192 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8193 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8194 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8195 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8196 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8197 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8198 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8199 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8200 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8201 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8202 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8203 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
8204 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8205
8206 @itemx -mtune=@var{name}
8207 @opindex mtune
8208 This option is very similar to the @option{-mcpu=} option, except that
8209 instead of specifying the actual target processor type, and hence
8210 restricting which instructions can be used, it specifies that GCC should
8211 tune the performance of the code as if the target were of the type
8212 specified in this option, but still choosing the instructions that it
8213 will generate based on the cpu specified by a @option{-mcpu=} option.
8214 For some ARM implementations better performance can be obtained by using
8215 this option.
8216
8217 @item -march=@var{name}
8218 @opindex march
8219 This specifies the name of the target ARM architecture.  GCC uses this
8220 name to determine what kind of instructions it can emit when generating
8221 assembly code.  This option can be used in conjunction with or instead
8222 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8223 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8224 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8225 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
8226 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
8227
8228 @item -mfpu=@var{name}
8229 @itemx -mfpe=@var{number}
8230 @itemx -mfp=@var{number}
8231 @opindex mfpu
8232 @opindex mfpe
8233 @opindex mfp
8234 This specifies what floating point hardware (or hardware emulation) is
8235 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8236 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8237 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8238 with older versions of GCC@.
8239
8240 If @option{-msoft-float} is specified this specifies the format of
8241 floating point values.
8242
8243 @item -mstructure-size-boundary=@var{n}
8244 @opindex mstructure-size-boundary
8245 The size of all structures and unions will be rounded up to a multiple
8246 of the number of bits set by this option.  Permissible values are 8, 32
8247 and 64.  The default value varies for different toolchains.  For the COFF
8248 targeted toolchain the default value is 8.  A value of 64 is only allowed
8249 if the underlying ABI supports it.
8250
8251 Specifying the larger number can produce faster, more efficient code, but
8252 can also increase the size of the program.  Different values are potentially
8253 incompatible.  Code compiled with one value cannot necessarily expect to
8254 work with code or libraries compiled with another value, if they exchange
8255 information using structures or unions.
8256
8257 @item -mabort-on-noreturn
8258 @opindex mabort-on-noreturn
8259 Generate a call to the function @code{abort} at the end of a
8260 @code{noreturn} function.  It will be executed if the function tries to
8261 return.
8262
8263 @item -mlong-calls
8264 @itemx -mno-long-calls
8265 @opindex mlong-calls
8266 @opindex mno-long-calls
8267 Tells the compiler to perform function calls by first loading the
8268 address of the function into a register and then performing a subroutine
8269 call on this register.  This switch is needed if the target function
8270 will lie outside of the 64 megabyte addressing range of the offset based
8271 version of subroutine call instruction.
8272
8273 Even if this switch is enabled, not all function calls will be turned
8274 into long calls.  The heuristic is that static functions, functions
8275 which have the @samp{short-call} attribute, functions that are inside
8276 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8277 definitions have already been compiled within the current compilation
8278 unit, will not be turned into long calls.  The exception to this rule is
8279 that weak function definitions, functions with the @samp{long-call}
8280 attribute or the @samp{section} attribute, and functions that are within
8281 the scope of a @samp{#pragma long_calls} directive, will always be
8282 turned into long calls.
8283
8284 This feature is not enabled by default.  Specifying
8285 @option{-mno-long-calls} will restore the default behavior, as will
8286 placing the function calls within the scope of a @samp{#pragma
8287 long_calls_off} directive.  Note these switches have no effect on how
8288 the compiler generates code to handle function calls via function
8289 pointers.
8290
8291 @item -mnop-fun-dllimport
8292 @opindex mnop-fun-dllimport
8293 Disable support for the @code{dllimport} attribute.
8294
8295 @item -msingle-pic-base
8296 @opindex msingle-pic-base
8297 Treat the register used for PIC addressing as read-only, rather than
8298 loading it in the prologue for each function.  The run-time system is
8299 responsible for initializing this register with an appropriate value
8300 before execution begins.
8301
8302 @item -mpic-register=@var{reg}
8303 @opindex mpic-register
8304 Specify the register to be used for PIC addressing.  The default is R10
8305 unless stack-checking is enabled, when R9 is used.
8306
8307 @item -mcirrus-fix-invalid-insns
8308 @opindex mcirrus-fix-invalid-insns
8309 @opindex mno-cirrus-fix-invalid-insns
8310 Insert NOPs into the instruction stream to in order to work around
8311 problems with invalid Maverick instruction combinations.  This option
8312 is only valid if the @option{-mcpu=ep9312} option has been used to
8313 enable generation of instructions for the Cirrus Maverick floating
8314 point co-processor.  This option is not enabled by default, since the
8315 problem is only present in older Maverick implementations.  The default
8316 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8317 switch.
8318
8319 @item -mpoke-function-name
8320 @opindex mpoke-function-name
8321 Write the name of each function into the text section, directly
8322 preceding the function prologue.  The generated code is similar to this:
8323
8324 @smallexample
8325      t0
8326          .ascii "arm_poke_function_name", 0
8327          .align
8328      t1
8329          .word 0xff000000 + (t1 - t0)
8330      arm_poke_function_name
8331          mov     ip, sp
8332          stmfd   sp!, @{fp, ip, lr, pc@}
8333          sub     fp, ip, #4
8334 @end smallexample
8335
8336 When performing a stack backtrace, code can inspect the value of
8337 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8338 location @code{pc - 12} and the top 8 bits are set, then we know that
8339 there is a function name embedded immediately preceding this location
8340 and has length @code{((pc[-3]) & 0xff000000)}.
8341
8342 @item -mthumb
8343 @opindex mthumb
8344 Generate code for the Thumb instruction set.  The default is to
8345 use the 32-bit ARM instruction set.
8346 This option automatically enables either 16-bit Thumb-1 or
8347 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8348 and @option{-march=@var{name}} options.
8349
8350 @item -mtpcs-frame
8351 @opindex mtpcs-frame
8352 Generate a stack frame that is compliant with the Thumb Procedure Call
8353 Standard for all non-leaf functions.  (A leaf function is one that does
8354 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8355
8356 @item -mtpcs-leaf-frame
8357 @opindex mtpcs-leaf-frame
8358 Generate a stack frame that is compliant with the Thumb Procedure Call
8359 Standard for all leaf functions.  (A leaf function is one that does
8360 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8361
8362 @item -mcallee-super-interworking
8363 @opindex mcallee-super-interworking
8364 Gives all externally visible functions in the file being compiled an ARM
8365 instruction set header which switches to Thumb mode before executing the
8366 rest of the function.  This allows these functions to be called from
8367 non-interworking code.
8368
8369 @item -mcaller-super-interworking
8370 @opindex mcaller-super-interworking
8371 Allows calls via function pointers (including virtual functions) to
8372 execute correctly regardless of whether the target code has been
8373 compiled for interworking or not.  There is a small overhead in the cost
8374 of executing a function pointer if this option is enabled.
8375
8376 @item -mtp=@var{name}
8377 @opindex mtp
8378 Specify the access model for the thread local storage pointer.  The valid
8379 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8380 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8381 (supported in the arm6k architecture), and @option{auto}, which uses the
8382 best available method for the selected processor.  The default setting is
8383 @option{auto}.
8384
8385 @end table
8386
8387 @node AVR Options
8388 @subsection AVR Options
8389 @cindex AVR Options
8390
8391 These options are defined for AVR implementations:
8392
8393 @table @gcctabopt
8394 @item -mmcu=@var{mcu}
8395 @opindex mmcu
8396 Specify ATMEL AVR instruction set or MCU type.
8397
8398 Instruction set avr1 is for the minimal AVR core, not supported by the C
8399 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8400 attiny11, attiny12, attiny15, attiny28).
8401
8402 Instruction set avr2 (default) is for the classic AVR core with up to
8403 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8404 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8405 at90c8534, at90s8535).
8406
8407 Instruction set avr3 is for the classic AVR core with up to 128K program
8408 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8409
8410 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8411 memory space (MCU types: atmega8, atmega83, atmega85).
8412
8413 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8414 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8415 atmega64, atmega128, at43usb355, at94k).
8416
8417 @item -msize
8418 @opindex msize
8419 Output instruction sizes to the asm file.
8420
8421 @item -minit-stack=@var{N}
8422 @opindex minit-stack
8423 Specify the initial stack address, which may be a symbol or numeric value,
8424 @samp{__stack} is the default.
8425
8426 @item -mno-interrupts
8427 @opindex mno-interrupts
8428 Generated code is not compatible with hardware interrupts.
8429 Code size will be smaller.
8430
8431 @item -mcall-prologues
8432 @opindex mcall-prologues
8433 Functions prologues/epilogues expanded as call to appropriate
8434 subroutines.  Code size will be smaller.
8435
8436 @item -mno-tablejump
8437 @opindex mno-tablejump
8438 Do not generate tablejump insns which sometimes increase code size.
8439
8440 @item -mtiny-stack
8441 @opindex mtiny-stack
8442 Change only the low 8 bits of the stack pointer.
8443
8444 @item -mint8
8445 @opindex mint8
8446 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8447 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8448 and long long will be 4 bytes.  Please note that this option does not
8449 comply to the C standards, but it will provide you with smaller code
8450 size.
8451 @end table
8452
8453 @node Blackfin Options
8454 @subsection Blackfin Options
8455 @cindex Blackfin Options
8456
8457 @table @gcctabopt
8458 @item -mcpu=@var{cpu}
8459 @opindex mcpu=
8460 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
8461 can be one of @samp{bf531}, @samp{bf532}, @samp{bf533},
8462 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf561}.
8463 Without this option, @samp{bf532} is used as the processor by default.
8464 The corresponding predefined processor macros for @var{cpu} is to
8465 be defined.  For the @samp{bfin-elf} toolchain, this causes the hardware
8466 BSP provided by libgloss to be linked in if @samp{-msim} is not given.
8467 Support for @samp{bf561} is incomplete; only the processor macro is defined.
8468
8469 @item -msim
8470 @opindex msim
8471 Specifies that the program will be run on the simulator.  This causes
8472 the simulator BSP provided by libgloss to be linked in.  This option
8473 has effect only for @samp{bfin-elf} toolchain.
8474
8475 @item -momit-leaf-frame-pointer
8476 @opindex momit-leaf-frame-pointer
8477 Don't keep the frame pointer in a register for leaf functions.  This
8478 avoids the instructions to save, set up and restore frame pointers and
8479 makes an extra register available in leaf functions.  The option
8480 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8481 which might make debugging harder.
8482
8483 @item -mspecld-anomaly
8484 @opindex mspecld-anomaly
8485 When enabled, the compiler will ensure that the generated code does not
8486 contain speculative loads after jump instructions.  This option is enabled
8487 by default.
8488
8489 @item -mno-specld-anomaly
8490 @opindex mno-specld-anomaly
8491 Don't generate extra code to prevent speculative loads from occurring.
8492
8493 @item -mcsync-anomaly
8494 @opindex mcsync-anomaly
8495 When enabled, the compiler will ensure that the generated code does not
8496 contain CSYNC or SSYNC instructions too soon after conditional branches.
8497 This option is enabled by default.
8498
8499 @item -mno-csync-anomaly
8500 @opindex mno-csync-anomaly
8501 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8502 occurring too soon after a conditional branch.
8503
8504 @item -mlow-64k
8505 @opindex mlow-64k
8506 When enabled, the compiler is free to take advantage of the knowledge that
8507 the entire program fits into the low 64k of memory.
8508
8509 @item -mno-low-64k
8510 @opindex mno-low-64k
8511 Assume that the program is arbitrarily large.  This is the default.
8512
8513 @item -mstack-check-l1
8514 @opindex mstack-check-l1
8515 Do stack checking using information placed into L1 scratchpad memory by the
8516 uClinux kernel.
8517
8518 @item -mid-shared-library
8519 @opindex mid-shared-library
8520 Generate code that supports shared libraries via the library ID method.
8521 This allows for execute in place and shared libraries in an environment
8522 without virtual memory management.  This option implies @option{-fPIC}.
8523
8524 @item -mno-id-shared-library
8525 @opindex mno-id-shared-library
8526 Generate code that doesn't assume ID based shared libraries are being used.
8527 This is the default.
8528
8529 @item -mleaf-id-shared-library
8530 @opindex mleaf-id-shared-library
8531 Generate code that supports shared libraries via the library ID method,
8532 but assumes that this library or executable won't link against any other
8533 ID shared libraries.  That allows the compiler to use faster code for jumps
8534 and calls.
8535
8536 @item -mno-leaf-id-shared-library
8537 @opindex mno-leaf-id-shared-library
8538 Do not assume that the code being compiled won't link against any ID shared
8539 libraries.  Slower code will be generated for jump and call insns.
8540
8541 @item -mshared-library-id=n
8542 @opindex mshared-library-id
8543 Specified the identification number of the ID based shared library being
8544 compiled.  Specifying a value of 0 will generate more compact code, specifying
8545 other values will force the allocation of that number to the current
8546 library but is no more space or time efficient than omitting this option.
8547
8548 @item -msep-data
8549 @opindex msep-data
8550 Generate code that allows the data segment to be located in a different
8551 area of memory from the text segment.  This allows for execute in place in
8552 an environment without virtual memory management by eliminating relocations
8553 against the text section.
8554
8555 @item -mno-sep-data
8556 @opindex mno-sep-data
8557 Generate code that assumes that the data segment follows the text segment.
8558 This is the default.
8559
8560 @item -mlong-calls
8561 @itemx -mno-long-calls
8562 @opindex mlong-calls
8563 @opindex mno-long-calls
8564 Tells the compiler to perform function calls by first loading the
8565 address of the function into a register and then performing a subroutine
8566 call on this register.  This switch is needed if the target function
8567 will lie outside of the 24 bit addressing range of the offset based
8568 version of subroutine call instruction.
8569
8570 This feature is not enabled by default.  Specifying
8571 @option{-mno-long-calls} will restore the default behavior.  Note these
8572 switches have no effect on how the compiler generates code to handle
8573 function calls via function pointers.
8574 @end table
8575
8576 @node CRIS Options
8577 @subsection CRIS Options
8578 @cindex CRIS Options
8579
8580 These options are defined specifically for the CRIS ports.
8581
8582 @table @gcctabopt
8583 @item -march=@var{architecture-type}
8584 @itemx -mcpu=@var{architecture-type}
8585 @opindex march
8586 @opindex mcpu
8587 Generate code for the specified architecture.  The choices for
8588 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8589 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
8590 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
8591 @samp{v10}.
8592
8593 @item -mtune=@var{architecture-type}
8594 @opindex mtune
8595 Tune to @var{architecture-type} everything applicable about the generated
8596 code, except for the ABI and the set of available instructions.  The
8597 choices for @var{architecture-type} are the same as for
8598 @option{-march=@var{architecture-type}}.
8599
8600 @item -mmax-stack-frame=@var{n}
8601 @opindex mmax-stack-frame
8602 Warn when the stack frame of a function exceeds @var{n} bytes.
8603
8604 @item -melinux-stacksize=@var{n}
8605 @opindex melinux-stacksize
8606 Only available with the @samp{cris-axis-aout} target.  Arranges for
8607 indications in the program to the kernel loader that the stack of the
8608 program should be set to @var{n} bytes.
8609
8610 @item -metrax4
8611 @itemx -metrax100
8612 @opindex metrax4
8613 @opindex metrax100
8614 The options @option{-metrax4} and @option{-metrax100} are synonyms for
8615 @option{-march=v3} and @option{-march=v8} respectively.
8616
8617 @item -mmul-bug-workaround
8618 @itemx -mno-mul-bug-workaround
8619 @opindex mmul-bug-workaround
8620 @opindex mno-mul-bug-workaround
8621 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
8622 models where it applies.  This option is active by default.
8623
8624 @item -mpdebug
8625 @opindex mpdebug
8626 Enable CRIS-specific verbose debug-related information in the assembly
8627 code.  This option also has the effect to turn off the @samp{#NO_APP}
8628 formatted-code indicator to the assembler at the beginning of the
8629 assembly file.
8630
8631 @item -mcc-init
8632 @opindex mcc-init
8633 Do not use condition-code results from previous instruction; always emit
8634 compare and test instructions before use of condition codes.
8635
8636 @item -mno-side-effects
8637 @opindex mno-side-effects
8638 Do not emit instructions with side-effects in addressing modes other than
8639 post-increment.
8640
8641 @item -mstack-align
8642 @itemx -mno-stack-align
8643 @itemx -mdata-align
8644 @itemx -mno-data-align
8645 @itemx -mconst-align
8646 @itemx -mno-const-align
8647 @opindex mstack-align
8648 @opindex mno-stack-align
8649 @opindex mdata-align
8650 @opindex mno-data-align
8651 @opindex mconst-align
8652 @opindex mno-const-align
8653 These options (no-options) arranges (eliminate arrangements) for the
8654 stack-frame, individual data and constants to be aligned for the maximum
8655 single data access size for the chosen CPU model.  The default is to
8656 arrange for 32-bit alignment.  ABI details such as structure layout are
8657 not affected by these options.
8658
8659 @item -m32-bit
8660 @itemx -m16-bit
8661 @itemx -m8-bit
8662 @opindex m32-bit
8663 @opindex m16-bit
8664 @opindex m8-bit
8665 Similar to the stack- data- and const-align options above, these options
8666 arrange for stack-frame, writable data and constants to all be 32-bit,
8667 16-bit or 8-bit aligned.  The default is 32-bit alignment.
8668
8669 @item -mno-prologue-epilogue
8670 @itemx -mprologue-epilogue
8671 @opindex mno-prologue-epilogue
8672 @opindex mprologue-epilogue
8673 With @option{-mno-prologue-epilogue}, the normal function prologue and
8674 epilogue that sets up the stack-frame are omitted and no return
8675 instructions or return sequences are generated in the code.  Use this
8676 option only together with visual inspection of the compiled code: no
8677 warnings or errors are generated when call-saved registers must be saved,
8678 or storage for local variable needs to be allocated.
8679
8680 @item -mno-gotplt
8681 @itemx -mgotplt
8682 @opindex mno-gotplt
8683 @opindex mgotplt
8684 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8685 instruction sequences that load addresses for functions from the PLT part
8686 of the GOT rather than (traditional on other architectures) calls to the
8687 PLT@.  The default is @option{-mgotplt}.
8688
8689 @item -maout
8690 @opindex maout
8691 Legacy no-op option only recognized with the cris-axis-aout target.
8692
8693 @item -melf
8694 @opindex melf
8695 Legacy no-op option only recognized with the cris-axis-elf and
8696 cris-axis-linux-gnu targets.
8697
8698 @item -melinux
8699 @opindex melinux
8700 Only recognized with the cris-axis-aout target, where it selects a
8701 GNU/linux-like multilib, include files and instruction set for
8702 @option{-march=v8}.
8703
8704 @item -mlinux
8705 @opindex mlinux
8706 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8707
8708 @item -sim
8709 @opindex sim
8710 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8711 to link with input-output functions from a simulator library.  Code,
8712 initialized data and zero-initialized data are allocated consecutively.
8713
8714 @item -sim2
8715 @opindex sim2
8716 Like @option{-sim}, but pass linker options to locate initialized data at
8717 0x40000000 and zero-initialized data at 0x80000000.
8718 @end table
8719
8720 @node CRX Options
8721 @subsection CRX Options
8722 @cindex CRX Options
8723
8724 These options are defined specifically for the CRX ports.
8725
8726 @table @gcctabopt
8727
8728 @item -mmac
8729 @opindex mmac
8730 Enable the use of multiply-accumulate instructions. Disabled by default.
8731
8732 @item -mpush-args
8733 @opindex mpush-args
8734 Push instructions will be used to pass outgoing arguments when functions
8735 are called. Enabled by default.
8736 @end table
8737
8738 @node Darwin Options
8739 @subsection Darwin Options
8740 @cindex Darwin options
8741
8742 These options are defined for all architectures running the Darwin operating
8743 system.
8744
8745 FSF GCC on Darwin does not create ``fat'' object files; it will create
8746 an object file for the single architecture that it was built to
8747 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8748 @option{-arch} options are used; it does so by running the compiler or
8749 linker multiple times and joining the results together with
8750 @file{lipo}.
8751
8752 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8753 @samp{i686}) is determined by the flags that specify the ISA
8754 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8755 @option{-force_cpusubtype_ALL} option can be used to override this.
8756
8757 The Darwin tools vary in their behavior when presented with an ISA
8758 mismatch.  The assembler, @file{as}, will only permit instructions to
8759 be used that are valid for the subtype of the file it is generating,
8760 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8761 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8762 and print an error if asked to create a shared library with a less
8763 restrictive subtype than its input files (for instance, trying to put
8764 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8765 for executables, @file{ld}, will quietly give the executable the most
8766 restrictive subtype of any of its input files.
8767
8768 @table @gcctabopt
8769 @item -F@var{dir}
8770 @opindex F
8771 Add the framework directory @var{dir} to the head of the list of
8772 directories to be searched for header files.  These directories are
8773 interleaved with those specified by @option{-I} options and are
8774 scanned in a left-to-right order.
8775
8776 A framework directory is a directory with frameworks in it.  A
8777 framework is a directory with a @samp{"Headers"} and/or
8778 @samp{"PrivateHeaders"} directory contained directly in it that ends
8779 in @samp{".framework"}.  The name of a framework is the name of this
8780 directory excluding the @samp{".framework"}.  Headers associated with
8781 the framework are found in one of those two directories, with
8782 @samp{"Headers"} being searched first.  A subframework is a framework
8783 directory that is in a framework's @samp{"Frameworks"} directory.
8784 Includes of subframework headers can only appear in a header of a
8785 framework that contains the subframework, or in a sibling subframework
8786 header.  Two subframeworks are siblings if they occur in the same
8787 framework.  A subframework should not have the same name as a
8788 framework, a warning will be issued if this is violated.  Currently a
8789 subframework cannot have subframeworks, in the future, the mechanism
8790 may be extended to support this.  The standard frameworks can be found
8791 in @samp{"/System/Library/Frameworks"} and
8792 @samp{"/Library/Frameworks"}.  An example include looks like
8793 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8794 the name of the framework and header.h is found in the
8795 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8796
8797 @item -iframework@var{dir}
8798 @opindex iframework
8799 Like @option{-F} except the directory is a treated as a system
8800 directory.  The main difference between this @option{-iframework} and
8801 @option{-F} is that with @option{-iframework} the compiler does not
8802 warn about constructs contained within header files found via
8803 @var{dir}.  This option is valid only for the C family of languages.
8804
8805 @item -gused
8806 @opindex gused
8807 Emit debugging information for symbols that are used.  For STABS
8808 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8809 This is by default ON@.
8810
8811 @item -gfull
8812 @opindex gfull
8813 Emit debugging information for all symbols and types.
8814
8815 @item -mmacosx-version-min=@var{version}
8816 The earliest version of MacOS X that this executable will run on
8817 is @var{version}.  Typical values of @var{version} include @code{10.1},
8818 @code{10.2}, and @code{10.3.9}.
8819
8820 If the compiler was built to use the system's headers by default,
8821 then the default for this option is the system version on which the
8822 compiler is running, otherwise the default is to make choices which
8823 are compatible with as many systems and code bases as possible.
8824
8825 @item -mkernel
8826 @opindex mkernel
8827 Enable kernel development mode.  The @option{-mkernel} option sets
8828 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8829 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8830 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8831 applicable.  This mode also sets @option{-mno-altivec},
8832 @option{-msoft-float}, @option{-fno-builtin} and
8833 @option{-mlong-branch} for PowerPC targets.
8834
8835 @item -mone-byte-bool
8836 @opindex mone-byte-bool
8837 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8838 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8839 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8840 option has no effect on x86.
8841
8842 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8843 to generate code that is not binary compatible with code generated
8844 without that switch.  Using this switch may require recompiling all
8845 other modules in a program, including system libraries.  Use this
8846 switch to conform to a non-default data model.
8847
8848 @item -mfix-and-continue
8849 @itemx -ffix-and-continue
8850 @itemx -findirect-data
8851 @opindex mfix-and-continue
8852 @opindex ffix-and-continue
8853 @opindex findirect-data
8854 Generate code suitable for fast turn around development.  Needed to
8855 enable gdb to dynamically load @code{.o} files into already running
8856 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8857 are provided for backwards compatibility.
8858
8859 @item -all_load
8860 @opindex all_load
8861 Loads all members of static archive libraries.
8862 See man ld(1) for more information.
8863
8864 @item -arch_errors_fatal
8865 @opindex arch_errors_fatal
8866 Cause the errors having to do with files that have the wrong architecture
8867 to be fatal.
8868
8869 @item -bind_at_load
8870 @opindex bind_at_load
8871 Causes the output file to be marked such that the dynamic linker will
8872 bind all undefined references when the file is loaded or launched.
8873
8874 @item -bundle
8875 @opindex bundle
8876 Produce a Mach-o bundle format file.
8877 See man ld(1) for more information.
8878
8879 @item -bundle_loader @var{executable}
8880 @opindex bundle_loader
8881 This option specifies the @var{executable} that will be loading the build
8882 output file being linked.  See man ld(1) for more information.
8883
8884 @item -dynamiclib
8885 @opindex dynamiclib
8886 When passed this option, GCC will produce a dynamic library instead of
8887 an executable when linking, using the Darwin @file{libtool} command.
8888
8889 @item -force_cpusubtype_ALL
8890 @opindex force_cpusubtype_ALL
8891 This causes GCC's output file to have the @var{ALL} subtype, instead of
8892 one controlled by the @option{-mcpu} or @option{-march} option.
8893
8894 @item -allowable_client  @var{client_name}
8895 @itemx -client_name
8896 @itemx -compatibility_version
8897 @itemx -current_version
8898 @itemx -dead_strip
8899 @itemx -dependency-file
8900 @itemx -dylib_file
8901 @itemx -dylinker_install_name
8902 @itemx -dynamic
8903 @itemx -exported_symbols_list
8904 @itemx -filelist
8905 @itemx -flat_namespace
8906 @itemx -force_flat_namespace
8907 @itemx -headerpad_max_install_names
8908 @itemx -image_base
8909 @itemx -init
8910 @itemx -install_name
8911 @itemx -keep_private_externs
8912 @itemx -multi_module
8913 @itemx -multiply_defined
8914 @itemx -multiply_defined_unused
8915 @itemx -noall_load
8916 @itemx -no_dead_strip_inits_and_terms
8917 @itemx -nofixprebinding
8918 @itemx -nomultidefs
8919 @itemx -noprebind
8920 @itemx -noseglinkedit
8921 @itemx -pagezero_size
8922 @itemx -prebind
8923 @itemx -prebind_all_twolevel_modules
8924 @itemx -private_bundle
8925 @itemx -read_only_relocs
8926 @itemx -sectalign
8927 @itemx -sectobjectsymbols
8928 @itemx -whyload
8929 @itemx -seg1addr
8930 @itemx -sectcreate
8931 @itemx -sectobjectsymbols
8932 @itemx -sectorder
8933 @itemx -segaddr
8934 @itemx -segs_read_only_addr
8935 @itemx -segs_read_write_addr
8936 @itemx -seg_addr_table
8937 @itemx -seg_addr_table_filename
8938 @itemx -seglinkedit
8939 @itemx -segprot
8940 @itemx -segs_read_only_addr
8941 @itemx -segs_read_write_addr
8942 @itemx -single_module
8943 @itemx -static
8944 @itemx -sub_library
8945 @itemx -sub_umbrella
8946 @itemx -twolevel_namespace
8947 @itemx -umbrella
8948 @itemx -undefined
8949 @itemx -unexported_symbols_list
8950 @itemx -weak_reference_mismatches
8951 @itemx -whatsloaded
8952
8953 @opindex allowable_client
8954 @opindex client_name
8955 @opindex compatibility_version
8956 @opindex current_version
8957 @opindex dead_strip
8958 @opindex dependency-file
8959 @opindex dylib_file
8960 @opindex dylinker_install_name
8961 @opindex dynamic
8962 @opindex exported_symbols_list
8963 @opindex filelist
8964 @opindex flat_namespace
8965 @opindex force_flat_namespace
8966 @opindex headerpad_max_install_names
8967 @opindex image_base
8968 @opindex init
8969 @opindex install_name
8970 @opindex keep_private_externs
8971 @opindex multi_module
8972 @opindex multiply_defined
8973 @opindex multiply_defined_unused
8974 @opindex noall_load
8975 @opindex no_dead_strip_inits_and_terms
8976 @opindex nofixprebinding
8977 @opindex nomultidefs
8978 @opindex noprebind
8979 @opindex noseglinkedit
8980 @opindex pagezero_size
8981 @opindex prebind
8982 @opindex prebind_all_twolevel_modules
8983 @opindex private_bundle
8984 @opindex read_only_relocs
8985 @opindex sectalign
8986 @opindex sectobjectsymbols
8987 @opindex whyload
8988 @opindex seg1addr
8989 @opindex sectcreate
8990 @opindex sectobjectsymbols
8991 @opindex sectorder
8992 @opindex segaddr
8993 @opindex segs_read_only_addr
8994 @opindex segs_read_write_addr
8995 @opindex seg_addr_table
8996 @opindex seg_addr_table_filename
8997 @opindex seglinkedit
8998 @opindex segprot
8999 @opindex segs_read_only_addr
9000 @opindex segs_read_write_addr
9001 @opindex single_module
9002 @opindex static
9003 @opindex sub_library
9004 @opindex sub_umbrella
9005 @opindex twolevel_namespace
9006 @opindex umbrella
9007 @opindex undefined
9008 @opindex unexported_symbols_list
9009 @opindex weak_reference_mismatches
9010 @opindex whatsloaded
9011
9012 These options are passed to the Darwin linker.  The Darwin linker man page
9013 describes them in detail.
9014 @end table
9015
9016 @node DEC Alpha Options
9017 @subsection DEC Alpha Options
9018
9019 These @samp{-m} options are defined for the DEC Alpha implementations:
9020
9021 @table @gcctabopt
9022 @item -mno-soft-float
9023 @itemx -msoft-float
9024 @opindex mno-soft-float
9025 @opindex msoft-float
9026 Use (do not use) the hardware floating-point instructions for
9027 floating-point operations.  When @option{-msoft-float} is specified,
9028 functions in @file{libgcc.a} will be used to perform floating-point
9029 operations.  Unless they are replaced by routines that emulate the
9030 floating-point operations, or compiled in such a way as to call such
9031 emulations routines, these routines will issue floating-point
9032 operations.   If you are compiling for an Alpha without floating-point
9033 operations, you must ensure that the library is built so as not to call
9034 them.
9035
9036 Note that Alpha implementations without floating-point operations are
9037 required to have floating-point registers.
9038
9039 @item -mfp-reg
9040 @itemx -mno-fp-regs
9041 @opindex mfp-reg
9042 @opindex mno-fp-regs
9043 Generate code that uses (does not use) the floating-point register set.
9044 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9045 register set is not used, floating point operands are passed in integer
9046 registers as if they were integers and floating-point results are passed
9047 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9048 so any function with a floating-point argument or return value called by code
9049 compiled with @option{-mno-fp-regs} must also be compiled with that
9050 option.
9051
9052 A typical use of this option is building a kernel that does not use,
9053 and hence need not save and restore, any floating-point registers.
9054
9055 @item -mieee
9056 @opindex mieee
9057 The Alpha architecture implements floating-point hardware optimized for
9058 maximum performance.  It is mostly compliant with the IEEE floating
9059 point standard.  However, for full compliance, software assistance is
9060 required.  This option generates code fully IEEE compliant code
9061 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9062 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9063 defined during compilation.  The resulting code is less efficient but is
9064 able to correctly support denormalized numbers and exceptional IEEE
9065 values such as not-a-number and plus/minus infinity.  Other Alpha
9066 compilers call this option @option{-ieee_with_no_inexact}.
9067
9068 @item -mieee-with-inexact
9069 @opindex mieee-with-inexact
9070 This is like @option{-mieee} except the generated code also maintains
9071 the IEEE @var{inexact-flag}.  Turning on this option causes the
9072 generated code to implement fully-compliant IEEE math.  In addition to
9073 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9074 macro.  On some Alpha implementations the resulting code may execute
9075 significantly slower than the code generated by default.  Since there is
9076 very little code that depends on the @var{inexact-flag}, you should
9077 normally not specify this option.  Other Alpha compilers call this
9078 option @option{-ieee_with_inexact}.
9079
9080 @item -mfp-trap-mode=@var{trap-mode}
9081 @opindex mfp-trap-mode
9082 This option controls what floating-point related traps are enabled.
9083 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9084 The trap mode can be set to one of four values:
9085
9086 @table @samp
9087 @item n
9088 This is the default (normal) setting.  The only traps that are enabled
9089 are the ones that cannot be disabled in software (e.g., division by zero
9090 trap).
9091
9092 @item u
9093 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9094 as well.
9095
9096 @item su
9097 Like @samp{u}, but the instructions are marked to be safe for software
9098 completion (see Alpha architecture manual for details).
9099
9100 @item sui
9101 Like @samp{su}, but inexact traps are enabled as well.
9102 @end table
9103
9104 @item -mfp-rounding-mode=@var{rounding-mode}
9105 @opindex mfp-rounding-mode
9106 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9107 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9108 of:
9109
9110 @table @samp
9111 @item n
9112 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9113 the nearest machine number or towards the even machine number in case
9114 of a tie.
9115
9116 @item m
9117 Round towards minus infinity.
9118
9119 @item c
9120 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9121
9122 @item d
9123 Dynamic rounding mode.  A field in the floating point control register
9124 (@var{fpcr}, see Alpha architecture reference manual) controls the
9125 rounding mode in effect.  The C library initializes this register for
9126 rounding towards plus infinity.  Thus, unless your program modifies the
9127 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9128 @end table
9129
9130 @item -mtrap-precision=@var{trap-precision}
9131 @opindex mtrap-precision
9132 In the Alpha architecture, floating point traps are imprecise.  This
9133 means without software assistance it is impossible to recover from a
9134 floating trap and program execution normally needs to be terminated.
9135 GCC can generate code that can assist operating system trap handlers
9136 in determining the exact location that caused a floating point trap.
9137 Depending on the requirements of an application, different levels of
9138 precisions can be selected:
9139
9140 @table @samp
9141 @item p
9142 Program precision.  This option is the default and means a trap handler
9143 can only identify which program caused a floating point exception.
9144
9145 @item f
9146 Function precision.  The trap handler can determine the function that
9147 caused a floating point exception.
9148
9149 @item i
9150 Instruction precision.  The trap handler can determine the exact
9151 instruction that caused a floating point exception.
9152 @end table
9153
9154 Other Alpha compilers provide the equivalent options called
9155 @option{-scope_safe} and @option{-resumption_safe}.
9156
9157 @item -mieee-conformant
9158 @opindex mieee-conformant
9159 This option marks the generated code as IEEE conformant.  You must not
9160 use this option unless you also specify @option{-mtrap-precision=i} and either
9161 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9162 is to emit the line @samp{.eflag 48} in the function prologue of the
9163 generated assembly file.  Under DEC Unix, this has the effect that
9164 IEEE-conformant math library routines will be linked in.
9165
9166 @item -mbuild-constants
9167 @opindex mbuild-constants
9168 Normally GCC examines a 32- or 64-bit integer constant to
9169 see if it can construct it from smaller constants in two or three
9170 instructions.  If it cannot, it will output the constant as a literal and
9171 generate code to load it from the data segment at runtime.
9172
9173 Use this option to require GCC to construct @emph{all} integer constants
9174 using code, even if it takes more instructions (the maximum is six).
9175
9176 You would typically use this option to build a shared library dynamic
9177 loader.  Itself a shared library, it must relocate itself in memory
9178 before it can find the variables and constants in its own data segment.
9179
9180 @item -malpha-as
9181 @itemx -mgas
9182 @opindex malpha-as
9183 @opindex mgas
9184 Select whether to generate code to be assembled by the vendor-supplied
9185 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9186
9187 @item -mbwx
9188 @itemx -mno-bwx
9189 @itemx -mcix
9190 @itemx -mno-cix
9191 @itemx -mfix
9192 @itemx -mno-fix
9193 @itemx -mmax
9194 @itemx -mno-max
9195 @opindex mbwx
9196 @opindex mno-bwx
9197 @opindex mcix
9198 @opindex mno-cix
9199 @opindex mfix
9200 @opindex mno-fix
9201 @opindex mmax
9202 @opindex mno-max
9203 Indicate whether GCC should generate code to use the optional BWX,
9204 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9205 sets supported by the CPU type specified via @option{-mcpu=} option or that
9206 of the CPU on which GCC was built if none was specified.
9207
9208 @item -mfloat-vax
9209 @itemx -mfloat-ieee
9210 @opindex mfloat-vax
9211 @opindex mfloat-ieee
9212 Generate code that uses (does not use) VAX F and G floating point
9213 arithmetic instead of IEEE single and double precision.
9214
9215 @item -mexplicit-relocs
9216 @itemx -mno-explicit-relocs
9217 @opindex mexplicit-relocs
9218 @opindex mno-explicit-relocs
9219 Older Alpha assemblers provided no way to generate symbol relocations
9220 except via assembler macros.  Use of these macros does not allow
9221 optimal instruction scheduling.  GNU binutils as of version 2.12
9222 supports a new syntax that allows the compiler to explicitly mark
9223 which relocations should apply to which instructions.  This option
9224 is mostly useful for debugging, as GCC detects the capabilities of
9225 the assembler when it is built and sets the default accordingly.
9226
9227 @item -msmall-data
9228 @itemx -mlarge-data
9229 @opindex msmall-data
9230 @opindex mlarge-data
9231 When @option{-mexplicit-relocs} is in effect, static data is
9232 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9233 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9234 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9235 16-bit relocations off of the @code{$gp} register.  This limits the
9236 size of the small data area to 64KB, but allows the variables to be
9237 directly accessed via a single instruction.
9238
9239 The default is @option{-mlarge-data}.  With this option the data area
9240 is limited to just below 2GB@.  Programs that require more than 2GB of
9241 data must use @code{malloc} or @code{mmap} to allocate the data in the
9242 heap instead of in the program's data segment.
9243
9244 When generating code for shared libraries, @option{-fpic} implies
9245 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9246
9247 @item -msmall-text
9248 @itemx -mlarge-text
9249 @opindex msmall-text
9250 @opindex mlarge-text
9251 When @option{-msmall-text} is used, the compiler assumes that the
9252 code of the entire program (or shared library) fits in 4MB, and is
9253 thus reachable with a branch instruction.  When @option{-msmall-data}
9254 is used, the compiler can assume that all local symbols share the
9255 same @code{$gp} value, and thus reduce the number of instructions
9256 required for a function call from 4 to 1.
9257
9258 The default is @option{-mlarge-text}.
9259
9260 @item -mcpu=@var{cpu_type}
9261 @opindex mcpu
9262 Set the instruction set and instruction scheduling parameters for
9263 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9264 style name or the corresponding chip number.  GCC supports scheduling
9265 parameters for the EV4, EV5 and EV6 family of processors and will
9266 choose the default values for the instruction set from the processor
9267 you specify.  If you do not specify a processor type, GCC will default
9268 to the processor on which the compiler was built.
9269
9270 Supported values for @var{cpu_type} are
9271
9272 @table @samp
9273 @item ev4
9274 @itemx ev45
9275 @itemx 21064
9276 Schedules as an EV4 and has no instruction set extensions.
9277
9278 @item ev5
9279 @itemx 21164
9280 Schedules as an EV5 and has no instruction set extensions.
9281
9282 @item ev56
9283 @itemx 21164a
9284 Schedules as an EV5 and supports the BWX extension.
9285
9286 @item pca56
9287 @itemx 21164pc
9288 @itemx 21164PC
9289 Schedules as an EV5 and supports the BWX and MAX extensions.
9290
9291 @item ev6
9292 @itemx 21264
9293 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9294
9295 @item ev67
9296 @itemx 21264a
9297 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9298 @end table
9299
9300 @item -mtune=@var{cpu_type}
9301 @opindex mtune
9302 Set only the instruction scheduling parameters for machine type
9303 @var{cpu_type}.  The instruction set is not changed.
9304
9305 @item -mmemory-latency=@var{time}
9306 @opindex mmemory-latency
9307 Sets the latency the scheduler should assume for typical memory
9308 references as seen by the application.  This number is highly
9309 dependent on the memory access patterns used by the application
9310 and the size of the external cache on the machine.
9311
9312 Valid options for @var{time} are
9313
9314 @table @samp
9315 @item @var{number}
9316 A decimal number representing clock cycles.
9317
9318 @item L1
9319 @itemx L2
9320 @itemx L3
9321 @itemx main
9322 The compiler contains estimates of the number of clock cycles for
9323 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9324 (also called Dcache, Scache, and Bcache), as well as to main memory.
9325 Note that L3 is only valid for EV5.
9326
9327 @end table
9328 @end table
9329
9330 @node DEC Alpha/VMS Options
9331 @subsection DEC Alpha/VMS Options
9332
9333 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9334
9335 @table @gcctabopt
9336 @item -mvms-return-codes
9337 @opindex mvms-return-codes
9338 Return VMS condition codes from main.  The default is to return POSIX
9339 style condition (e.g.@ error) codes.
9340 @end table
9341
9342 @node FRV Options
9343 @subsection FRV Options
9344 @cindex FRV Options
9345
9346 @table @gcctabopt
9347 @item -mgpr-32
9348 @opindex mgpr-32
9349
9350 Only use the first 32 general purpose registers.
9351
9352 @item -mgpr-64
9353 @opindex mgpr-64
9354
9355 Use all 64 general purpose registers.
9356
9357 @item -mfpr-32
9358 @opindex mfpr-32
9359
9360 Use only the first 32 floating point registers.
9361
9362 @item -mfpr-64
9363 @opindex mfpr-64
9364
9365 Use all 64 floating point registers
9366
9367 @item -mhard-float
9368 @opindex mhard-float
9369
9370 Use hardware instructions for floating point operations.
9371
9372 @item -msoft-float
9373 @opindex msoft-float
9374
9375 Use library routines for floating point operations.
9376
9377 @item -malloc-cc
9378 @opindex malloc-cc
9379
9380 Dynamically allocate condition code registers.
9381
9382 @item -mfixed-cc
9383 @opindex mfixed-cc
9384
9385 Do not try to dynamically allocate condition code registers, only
9386 use @code{icc0} and @code{fcc0}.
9387
9388 @item -mdword
9389 @opindex mdword
9390
9391 Change ABI to use double word insns.
9392
9393 @item -mno-dword
9394 @opindex mno-dword
9395
9396 Do not use double word instructions.
9397
9398 @item -mdouble
9399 @opindex mdouble
9400
9401 Use floating point double instructions.
9402
9403 @item -mno-double
9404 @opindex mno-double
9405
9406 Do not use floating point double instructions.
9407
9408 @item -mmedia
9409 @opindex mmedia
9410
9411 Use media instructions.
9412
9413 @item -mno-media
9414 @opindex mno-media
9415
9416 Do not use media instructions.
9417
9418 @item -mmuladd
9419 @opindex mmuladd
9420
9421 Use multiply and add/subtract instructions.
9422
9423 @item -mno-muladd
9424 @opindex mno-muladd
9425
9426 Do not use multiply and add/subtract instructions.
9427
9428 @item -mfdpic
9429 @opindex mfdpic
9430
9431 Select the FDPIC ABI, that uses function descriptors to represent
9432 pointers to functions.  Without any PIC/PIE-related options, it
9433 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9434 assumes GOT entries and small data are within a 12-bit range from the
9435 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9436 are computed with 32 bits.
9437
9438 @item -minline-plt
9439 @opindex minline-plt
9440
9441 Enable inlining of PLT entries in function calls to functions that are
9442 not known to bind locally.  It has no effect without @option{-mfdpic}.
9443 It's enabled by default if optimizing for speed and compiling for
9444 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9445 optimization option such as @option{-O3} or above is present in the
9446 command line.
9447
9448 @item -mTLS
9449 @opindex TLS
9450
9451 Assume a large TLS segment when generating thread-local code.
9452
9453 @item -mtls
9454 @opindex tls
9455
9456 Do not assume a large TLS segment when generating thread-local code.
9457
9458 @item -mgprel-ro
9459 @opindex mgprel-ro
9460
9461 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9462 that is known to be in read-only sections.  It's enabled by default,
9463 except for @option{-fpic} or @option{-fpie}: even though it may help
9464 make the global offset table smaller, it trades 1 instruction for 4.
9465 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9466 one of which may be shared by multiple symbols, and it avoids the need
9467 for a GOT entry for the referenced symbol, so it's more likely to be a
9468 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9469
9470 @item -multilib-library-pic
9471 @opindex multilib-library-pic
9472
9473 Link with the (library, not FD) pic libraries.  It's implied by
9474 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9475 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9476 it explicitly.
9477
9478 @item -mlinked-fp
9479 @opindex mlinked-fp
9480
9481 Follow the EABI requirement of always creating a frame pointer whenever
9482 a stack frame is allocated.  This option is enabled by default and can
9483 be disabled with @option{-mno-linked-fp}.
9484
9485 @item -mlong-calls
9486 @opindex mlong-calls
9487
9488 Use indirect addressing to call functions outside the current
9489 compilation unit.  This allows the functions to be placed anywhere
9490 within the 32-bit address space.
9491
9492 @item -malign-labels
9493 @opindex malign-labels
9494
9495 Try to align labels to an 8-byte boundary by inserting nops into the
9496 previous packet.  This option only has an effect when VLIW packing
9497 is enabled.  It doesn't create new packets; it merely adds nops to
9498 existing ones.
9499
9500 @item -mlibrary-pic
9501 @opindex mlibrary-pic
9502
9503 Generate position-independent EABI code.
9504
9505 @item -macc-4
9506 @opindex macc-4
9507
9508 Use only the first four media accumulator registers.
9509
9510 @item -macc-8
9511 @opindex macc-8
9512
9513 Use all eight media accumulator registers.
9514
9515 @item -mpack
9516 @opindex mpack
9517
9518 Pack VLIW instructions.
9519
9520 @item -mno-pack
9521 @opindex mno-pack
9522
9523 Do not pack VLIW instructions.
9524
9525 @item -mno-eflags
9526 @opindex mno-eflags
9527
9528 Do not mark ABI switches in e_flags.
9529
9530 @item -mcond-move
9531 @opindex mcond-move
9532
9533 Enable the use of conditional-move instructions (default).
9534
9535 This switch is mainly for debugging the compiler and will likely be removed
9536 in a future version.
9537
9538 @item -mno-cond-move
9539 @opindex mno-cond-move
9540
9541 Disable the use of conditional-move instructions.
9542
9543 This switch is mainly for debugging the compiler and will likely be removed
9544 in a future version.
9545
9546 @item -mscc
9547 @opindex mscc
9548
9549 Enable the use of conditional set instructions (default).
9550
9551 This switch is mainly for debugging the compiler and will likely be removed
9552 in a future version.
9553
9554 @item -mno-scc
9555 @opindex mno-scc
9556
9557 Disable the use of conditional set instructions.
9558
9559 This switch is mainly for debugging the compiler and will likely be removed
9560 in a future version.
9561
9562 @item -mcond-exec
9563 @opindex mcond-exec
9564
9565 Enable the use of conditional execution (default).
9566
9567 This switch is mainly for debugging the compiler and will likely be removed
9568 in a future version.
9569
9570 @item -mno-cond-exec
9571 @opindex mno-cond-exec
9572
9573 Disable the use of conditional execution.
9574
9575 This switch is mainly for debugging the compiler and will likely be removed
9576 in a future version.
9577
9578 @item -mvliw-branch
9579 @opindex mvliw-branch
9580
9581 Run a pass to pack branches into VLIW instructions (default).
9582
9583 This switch is mainly for debugging the compiler and will likely be removed
9584 in a future version.
9585
9586 @item -mno-vliw-branch
9587 @opindex mno-vliw-branch
9588
9589 Do not run a pass to pack branches into VLIW instructions.
9590
9591 This switch is mainly for debugging the compiler and will likely be removed
9592 in a future version.
9593
9594 @item -mmulti-cond-exec
9595 @opindex mmulti-cond-exec
9596
9597 Enable optimization of @code{&&} and @code{||} in conditional execution
9598 (default).
9599
9600 This switch is mainly for debugging the compiler and will likely be removed
9601 in a future version.
9602
9603 @item -mno-multi-cond-exec
9604 @opindex mno-multi-cond-exec
9605
9606 Disable optimization of @code{&&} and @code{||} in conditional execution.
9607
9608 This switch is mainly for debugging the compiler and will likely be removed
9609 in a future version.
9610
9611 @item -mnested-cond-exec
9612 @opindex mnested-cond-exec
9613
9614 Enable nested conditional execution optimizations (default).
9615
9616 This switch is mainly for debugging the compiler and will likely be removed
9617 in a future version.
9618
9619 @item -mno-nested-cond-exec
9620 @opindex mno-nested-cond-exec
9621
9622 Disable nested conditional execution optimizations.
9623
9624 This switch is mainly for debugging the compiler and will likely be removed
9625 in a future version.
9626
9627 @item -moptimize-membar
9628 @opindex moptimize-membar
9629
9630 This switch removes redundant @code{membar} instructions from the
9631 compiler generated code.  It is enabled by default.
9632
9633 @item -mno-optimize-membar
9634 @opindex mno-optimize-membar
9635
9636 This switch disables the automatic removal of redundant @code{membar}
9637 instructions from the generated code.
9638
9639 @item -mtomcat-stats
9640 @opindex mtomcat-stats
9641
9642 Cause gas to print out tomcat statistics.
9643
9644 @item -mcpu=@var{cpu}
9645 @opindex mcpu
9646
9647 Select the processor type for which to generate code.  Possible values are
9648 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9649 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9650
9651 @end table
9652
9653 @node GNU/Linux Options
9654 @subsection GNU/Linux Options
9655
9656 These @samp{-m} options are defined for GNU/Linux targets:
9657
9658 @table @gcctabopt
9659 @item -mglibc
9660 @opindex mglibc
9661 Use the GNU C library instead of uClibc.  This is the default except
9662 on @samp{*-*-linux-*uclibc*} targets.
9663
9664 @item -muclibc
9665 @opindex muclibc
9666 Use uClibc instead of the GNU C library.  This is the default on
9667 @samp{*-*-linux-*uclibc*} targets.
9668 @end table
9669
9670 @node H8/300 Options
9671 @subsection H8/300 Options
9672
9673 These @samp{-m} options are defined for the H8/300 implementations:
9674
9675 @table @gcctabopt
9676 @item -mrelax
9677 @opindex mrelax
9678 Shorten some address references at link time, when possible; uses the
9679 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9680 ld, Using ld}, for a fuller description.
9681
9682 @item -mh
9683 @opindex mh
9684 Generate code for the H8/300H@.
9685
9686 @item -ms
9687 @opindex ms
9688 Generate code for the H8S@.
9689
9690 @item -mn
9691 @opindex mn
9692 Generate code for the H8S and H8/300H in the normal mode.  This switch
9693 must be used either with @option{-mh} or @option{-ms}.
9694
9695 @item -ms2600
9696 @opindex ms2600
9697 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9698
9699 @item -mint32
9700 @opindex mint32
9701 Make @code{int} data 32 bits by default.
9702
9703 @item -malign-300
9704 @opindex malign-300
9705 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9706 The default for the H8/300H and H8S is to align longs and floats on 4
9707 byte boundaries.
9708 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9709 This option has no effect on the H8/300.
9710 @end table
9711
9712 @node HPPA Options
9713 @subsection HPPA Options
9714 @cindex HPPA Options
9715
9716 These @samp{-m} options are defined for the HPPA family of computers:
9717
9718 @table @gcctabopt
9719 @item -march=@var{architecture-type}
9720 @opindex march
9721 Generate code for the specified architecture.  The choices for
9722 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9723 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9724 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9725 architecture option for your machine.  Code compiled for lower numbered
9726 architectures will run on higher numbered architectures, but not the
9727 other way around.
9728
9729 @item -mpa-risc-1-0
9730 @itemx -mpa-risc-1-1
9731 @itemx -mpa-risc-2-0
9732 @opindex mpa-risc-1-0
9733 @opindex mpa-risc-1-1
9734 @opindex mpa-risc-2-0
9735 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9736
9737 @item -mbig-switch
9738 @opindex mbig-switch
9739 Generate code suitable for big switch tables.  Use this option only if
9740 the assembler/linker complain about out of range branches within a switch
9741 table.
9742
9743 @item -mjump-in-delay
9744 @opindex mjump-in-delay
9745 Fill delay slots of function calls with unconditional jump instructions
9746 by modifying the return pointer for the function call to be the target
9747 of the conditional jump.
9748
9749 @item -mdisable-fpregs
9750 @opindex mdisable-fpregs
9751 Prevent floating point registers from being used in any manner.  This is
9752 necessary for compiling kernels which perform lazy context switching of
9753 floating point registers.  If you use this option and attempt to perform
9754 floating point operations, the compiler will abort.
9755
9756 @item -mdisable-indexing
9757 @opindex mdisable-indexing
9758 Prevent the compiler from using indexing address modes.  This avoids some
9759 rather obscure problems when compiling MIG generated code under MACH@.
9760
9761 @item -mno-space-regs
9762 @opindex mno-space-regs
9763 Generate code that assumes the target has no space registers.  This allows
9764 GCC to generate faster indirect calls and use unscaled index address modes.
9765
9766 Such code is suitable for level 0 PA systems and kernels.
9767
9768 @item -mfast-indirect-calls
9769 @opindex mfast-indirect-calls
9770 Generate code that assumes calls never cross space boundaries.  This
9771 allows GCC to emit code which performs faster indirect calls.
9772
9773 This option will not work in the presence of shared libraries or nested
9774 functions.
9775
9776 @item -mfixed-range=@var{register-range}
9777 @opindex mfixed-range
9778 Generate code treating the given register range as fixed registers.
9779 A fixed register is one that the register allocator can not use.  This is
9780 useful when compiling kernel code.  A register range is specified as
9781 two registers separated by a dash.  Multiple register ranges can be
9782 specified separated by a comma.
9783
9784 @item -mlong-load-store
9785 @opindex mlong-load-store
9786 Generate 3-instruction load and store sequences as sometimes required by
9787 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9788 the HP compilers.
9789
9790 @item -mportable-runtime
9791 @opindex mportable-runtime
9792 Use the portable calling conventions proposed by HP for ELF systems.
9793
9794 @item -mgas
9795 @opindex mgas
9796 Enable the use of assembler directives only GAS understands.
9797
9798 @item -mschedule=@var{cpu-type}
9799 @opindex mschedule
9800 Schedule code according to the constraints for the machine type
9801 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9802 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9803 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9804 proper scheduling option for your machine.  The default scheduling is
9805 @samp{8000}.
9806
9807 @item -mlinker-opt
9808 @opindex mlinker-opt
9809 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9810 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9811 linkers in which they give bogus error messages when linking some programs.
9812
9813 @item -msoft-float
9814 @opindex msoft-float
9815 Generate output containing library calls for floating point.
9816 @strong{Warning:} the requisite libraries are not available for all HPPA
9817 targets.  Normally the facilities of the machine's usual C compiler are
9818 used, but this cannot be done directly in cross-compilation.  You must make
9819 your own arrangements to provide suitable library functions for
9820 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9821 does provide software floating point support.
9822
9823 @option{-msoft-float} changes the calling convention in the output file;
9824 therefore, it is only useful if you compile @emph{all} of a program with
9825 this option.  In particular, you need to compile @file{libgcc.a}, the
9826 library that comes with GCC, with @option{-msoft-float} in order for
9827 this to work.
9828
9829 @item -msio
9830 @opindex msio
9831 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9832 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9833 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9834 options are available under HP-UX and HI-UX@.
9835
9836 @item -mgnu-ld
9837 @opindex gnu-ld
9838 Use GNU ld specific options.  This passes @option{-shared} to ld when
9839 building a shared library.  It is the default when GCC is configured,
9840 explicitly or implicitly, with the GNU linker.  This option does not
9841 have any affect on which ld is called, it only changes what parameters
9842 are passed to that ld.  The ld that is called is determined by the
9843 @option{--with-ld} configure option, GCC's program search path, and
9844 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9845 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9846 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9847
9848 @item -mhp-ld
9849 @opindex hp-ld
9850 Use HP ld specific options.  This passes @option{-b} to ld when building
9851 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9852 links.  It is the default when GCC is configured, explicitly or
9853 implicitly, with the HP linker.  This option does not have any affect on
9854 which ld is called, it only changes what parameters are passed to that
9855 ld.  The ld that is called is determined by the @option{--with-ld}
9856 configure option, GCC's program search path, and finally by the user's
9857 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9858 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9859 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9860
9861 @item -mlong-calls
9862 @opindex mno-long-calls
9863 Generate code that uses long call sequences.  This ensures that a call
9864 is always able to reach linker generated stubs.  The default is to generate
9865 long calls only when the distance from the call site to the beginning
9866 of the function or translation unit, as the case may be, exceeds a
9867 predefined limit set by the branch type being used.  The limits for
9868 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9869 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9870 240,000 bytes.
9871
9872 Distances are measured from the beginning of functions when using the
9873 @option{-ffunction-sections} option, or when using the @option{-mgas}
9874 and @option{-mno-portable-runtime} options together under HP-UX with
9875 the SOM linker.
9876
9877 It is normally not desirable to use this option as it will degrade
9878 performance.  However, it may be useful in large applications,
9879 particularly when partial linking is used to build the application.
9880
9881 The types of long calls used depends on the capabilities of the
9882 assembler and linker, and the type of code being generated.  The
9883 impact on systems that support long absolute calls, and long pic
9884 symbol-difference or pc-relative calls should be relatively small.
9885 However, an indirect call is used on 32-bit ELF systems in pic code
9886 and it is quite long.
9887
9888 @item -munix=@var{unix-std}
9889 @opindex march
9890 Generate compiler predefines and select a startfile for the specified
9891 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9892 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9893 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9894 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9895 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9896 and later.
9897
9898 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9899 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9900 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9901 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9902 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9903 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9904
9905 It is @emph{important} to note that this option changes the interfaces
9906 for various library routines.  It also affects the operational behavior
9907 of the C library.  Thus, @emph{extreme} care is needed in using this
9908 option.
9909
9910 Library code that is intended to operate with more than one UNIX
9911 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9912 as appropriate.  Most GNU software doesn't provide this capability.
9913
9914 @item -nolibdld
9915 @opindex nolibdld
9916 Suppress the generation of link options to search libdld.sl when the
9917 @option{-static} option is specified on HP-UX 10 and later.
9918
9919 @item -static
9920 @opindex static
9921 The HP-UX implementation of setlocale in libc has a dependency on
9922 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9923 when the @option{-static} option is specified, special link options
9924 are needed to resolve this dependency.
9925
9926 On HP-UX 10 and later, the GCC driver adds the necessary options to
9927 link with libdld.sl when the @option{-static} option is specified.
9928 This causes the resulting binary to be dynamic.  On the 64-bit port,
9929 the linkers generate dynamic binaries by default in any case.  The
9930 @option{-nolibdld} option can be used to prevent the GCC driver from
9931 adding these link options.
9932
9933 @item -threads
9934 @opindex threads
9935 Add support for multithreading with the @dfn{dce thread} library
9936 under HP-UX@.  This option sets flags for both the preprocessor and
9937 linker.
9938 @end table
9939
9940 @node i386 and x86-64 Options
9941 @subsection Intel 386 and AMD x86-64 Options
9942 @cindex i386 Options
9943 @cindex x86-64 Options
9944 @cindex Intel 386 Options
9945 @cindex AMD x86-64 Options
9946
9947 These @samp{-m} options are defined for the i386 and x86-64 family of
9948 computers:
9949
9950 @table @gcctabopt
9951 @item -mtune=@var{cpu-type}
9952 @opindex mtune
9953 Tune to @var{cpu-type} everything applicable about the generated code, except
9954 for the ABI and the set of available instructions.  The choices for
9955 @var{cpu-type} are:
9956 @table @emph
9957 @item generic
9958 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9959 If you know the CPU on which your code will run, then you should use
9960 the corresponding @option{-mtune} option instead of
9961 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9962 of your application will have, then you should use this option.
9963
9964 As new processors are deployed in the marketplace, the behavior of this
9965 option will change.  Therefore, if you upgrade to a newer version of
9966 GCC, the code generated option will change to reflect the processors
9967 that were most common when that version of GCC was released.
9968
9969 There is no @option{-march=generic} option because @option{-march}
9970 indicates the instruction set the compiler can use, and there is no
9971 generic instruction set applicable to all processors.  In contrast,
9972 @option{-mtune} indicates the processor (or, in this case, collection of
9973 processors) for which the code is optimized.
9974 @item native
9975 This selects the CPU to tune for at compilation time by determining
9976 the processor type of the compiling machine.  Using @option{-mtune=native}
9977 will produce code optimized for the local machine under the constraints
9978 of the selected instruction set.  Using @option{-march=native} will
9979 enable all instruction subsets supported by the local machine (hence
9980 the result might not run on different machines).
9981 @item i386
9982 Original Intel's i386 CPU@.
9983 @item i486
9984 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9985 @item i586, pentium
9986 Intel Pentium CPU with no MMX support.
9987 @item pentium-mmx
9988 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9989 @item pentiumpro
9990 Intel PentiumPro CPU@.
9991 @item i686
9992 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9993 instruction set will be used, so the code will run on all i686 family chips.
9994 @item pentium2
9995 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9996 @item pentium3, pentium3m
9997 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9998 support.
9999 @item pentium-m
10000 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10001 support.  Used by Centrino notebooks.
10002 @item pentium4, pentium4m
10003 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10004 @item prescott
10005 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10006 set support.
10007 @item nocona
10008 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10009 SSE2 and SSE3 instruction set support.
10010 @item core2
10011 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10012 instruction set support.
10013 @item k6
10014 AMD K6 CPU with MMX instruction set support.
10015 @item k6-2, k6-3
10016 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
10017 @item athlon, athlon-tbird
10018 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
10019 support.
10020 @item athlon-4, athlon-xp, athlon-mp
10021 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
10022 instruction set support.
10023 @item k8, opteron, athlon64, athlon-fx
10024 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10025 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
10026 @item k8-sse3, opteron-sse3, athlon64-sse3
10027 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10028 @item amdfam10, barcelona
10029 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10030 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10031 instruction set extensions.)
10032 @item winchip-c6
10033 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10034 set support.
10035 @item winchip2
10036 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
10037 instruction set support.
10038 @item c3
10039 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
10040 implemented for this chip.)
10041 @item c3-2
10042 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10043 implemented for this chip.)
10044 @item geode
10045 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10046 @end table
10047
10048 While picking a specific @var{cpu-type} will schedule things appropriately
10049 for that particular chip, the compiler will not generate any code that
10050 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10051 being used.
10052
10053 @item -march=@var{cpu-type}
10054 @opindex march
10055 Generate instructions for the machine type @var{cpu-type}.  The choices
10056 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10057 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10058
10059 @item -mcpu=@var{cpu-type}
10060 @opindex mcpu
10061 A deprecated synonym for @option{-mtune}.
10062
10063 @item -mfpmath=@var{unit}
10064 @opindex march
10065 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10066 for @var{unit} are:
10067
10068 @table @samp
10069 @item 387
10070 Use the standard 387 floating point coprocessor present majority of chips and
10071 emulated otherwise.  Code compiled with this option will run almost everywhere.
10072 The temporary results are computed in 80bit precision instead of precision
10073 specified by the type resulting in slightly different results compared to most
10074 of other chips.  See @option{-ffloat-store} for more detailed description.
10075
10076 This is the default choice for i386 compiler.
10077
10078 @item sse
10079 Use scalar floating point instructions present in the SSE instruction set.
10080 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10081 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10082 instruction set supports only single precision arithmetics, thus the double and
10083 extended precision arithmetics is still done using 387.  Later version, present
10084 only in Pentium4 and the future AMD x86-64 chips supports double precision
10085 arithmetics too.
10086
10087 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10088 or @option{-msse2} switches to enable SSE extensions and make this option
10089 effective.  For the x86-64 compiler, these extensions are enabled by default.
10090
10091 The resulting code should be considerably faster in the majority of cases and avoid
10092 the numerical instability problems of 387 code, but may break some existing
10093 code that expects temporaries to be 80bit.
10094
10095 This is the default choice for the x86-64 compiler.
10096
10097 @item sse,387
10098 Attempt to utilize both instruction sets at once.  This effectively double the
10099 amount of available registers and on chips with separate execution units for
10100 387 and SSE the execution resources too.  Use this option with care, as it is
10101 still experimental, because the GCC register allocator does not model separate
10102 functional units well resulting in instable performance.
10103 @end table
10104
10105 @item -masm=@var{dialect}
10106 @opindex masm=@var{dialect}
10107 Output asm instructions using selected @var{dialect}.  Supported
10108 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10109 not support @samp{intel}.
10110
10111 @item -mieee-fp
10112 @itemx -mno-ieee-fp
10113 @opindex mieee-fp
10114 @opindex mno-ieee-fp
10115 Control whether or not the compiler uses IEEE floating point
10116 comparisons.  These handle correctly the case where the result of a
10117 comparison is unordered.
10118
10119 @item -msoft-float
10120 @opindex msoft-float
10121 Generate output containing library calls for floating point.
10122 @strong{Warning:} the requisite libraries are not part of GCC@.
10123 Normally the facilities of the machine's usual C compiler are used, but
10124 this can't be done directly in cross-compilation.  You must make your
10125 own arrangements to provide suitable library functions for
10126 cross-compilation.
10127
10128 On machines where a function returns floating point results in the 80387
10129 register stack, some floating point opcodes may be emitted even if
10130 @option{-msoft-float} is used.
10131
10132 @item -mno-fp-ret-in-387
10133 @opindex mno-fp-ret-in-387
10134 Do not use the FPU registers for return values of functions.
10135
10136 The usual calling convention has functions return values of types
10137 @code{float} and @code{double} in an FPU register, even if there
10138 is no FPU@.  The idea is that the operating system should emulate
10139 an FPU@.
10140
10141 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10142 in ordinary CPU registers instead.
10143
10144 @item -mno-fancy-math-387
10145 @opindex mno-fancy-math-387
10146 Some 387 emulators do not support the @code{sin}, @code{cos} and
10147 @code{sqrt} instructions for the 387.  Specify this option to avoid
10148 generating those instructions.  This option is the default on FreeBSD,
10149 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10150 indicates that the target cpu will always have an FPU and so the
10151 instruction will not need emulation.  As of revision 2.6.1, these
10152 instructions are not generated unless you also use the
10153 @option{-funsafe-math-optimizations} switch.
10154
10155 @item -malign-double
10156 @itemx -mno-align-double
10157 @opindex malign-double
10158 @opindex mno-align-double
10159 Control whether GCC aligns @code{double}, @code{long double}, and
10160 @code{long long} variables on a two word boundary or a one word
10161 boundary.  Aligning @code{double} variables on a two word boundary will
10162 produce code that runs somewhat faster on a @samp{Pentium} at the
10163 expense of more memory.
10164
10165 On x86-64, @option{-malign-double} is enabled by default.
10166
10167 @strong{Warning:} if you use the @option{-malign-double} switch,
10168 structures containing the above types will be aligned differently than
10169 the published application binary interface specifications for the 386
10170 and will not be binary compatible with structures in code compiled
10171 without that switch.
10172
10173 @item -m96bit-long-double
10174 @itemx -m128bit-long-double
10175 @opindex m96bit-long-double
10176 @opindex m128bit-long-double
10177 These switches control the size of @code{long double} type.  The i386
10178 application binary interface specifies the size to be 96 bits,
10179 so @option{-m96bit-long-double} is the default in 32 bit mode.
10180
10181 Modern architectures (Pentium and newer) would prefer @code{long double}
10182 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10183 conforming to the ABI, this would not be possible.  So specifying a
10184 @option{-m128bit-long-double} will align @code{long double}
10185 to a 16 byte boundary by padding the @code{long double} with an additional
10186 32 bit zero.
10187
10188 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10189 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10190
10191 Notice that neither of these options enable any extra precision over the x87
10192 standard of 80 bits for a @code{long double}.
10193
10194 @strong{Warning:} if you override the default value for your target ABI, the
10195 structures and arrays containing @code{long double} variables will change
10196 their size as well as function calling convention for function taking
10197 @code{long double} will be modified.  Hence they will not be binary
10198 compatible with arrays or structures in code compiled without that switch.
10199
10200 @item -mmlarge-data-threshold=@var{number}
10201 @opindex mlarge-data-threshold=@var{number}
10202 When @option{-mcmodel=medium} is specified, the data greater than
10203 @var{threshold} are placed in large data section.  This value must be the
10204 same across all object linked into the binary and defaults to 65535.
10205
10206 @item -mrtd
10207 @opindex mrtd
10208 Use a different function-calling convention, in which functions that
10209 take a fixed number of arguments return with the @code{ret} @var{num}
10210 instruction, which pops their arguments while returning.  This saves one
10211 instruction in the caller since there is no need to pop the arguments
10212 there.
10213
10214 You can specify that an individual function is called with this calling
10215 sequence with the function attribute @samp{stdcall}.  You can also
10216 override the @option{-mrtd} option by using the function attribute
10217 @samp{cdecl}.  @xref{Function Attributes}.
10218
10219 @strong{Warning:} this calling convention is incompatible with the one
10220 normally used on Unix, so you cannot use it if you need to call
10221 libraries compiled with the Unix compiler.
10222
10223 Also, you must provide function prototypes for all functions that
10224 take variable numbers of arguments (including @code{printf});
10225 otherwise incorrect code will be generated for calls to those
10226 functions.
10227
10228 In addition, seriously incorrect code will result if you call a
10229 function with too many arguments.  (Normally, extra arguments are
10230 harmlessly ignored.)
10231
10232 @item -mregparm=@var{num}
10233 @opindex mregparm
10234 Control how many registers are used to pass integer arguments.  By
10235 default, no registers are used to pass arguments, and at most 3
10236 registers can be used.  You can control this behavior for a specific
10237 function by using the function attribute @samp{regparm}.
10238 @xref{Function Attributes}.
10239
10240 @strong{Warning:} if you use this switch, and
10241 @var{num} is nonzero, then you must build all modules with the same
10242 value, including any libraries.  This includes the system libraries and
10243 startup modules.
10244
10245 @item -msseregparm
10246 @opindex msseregparm
10247 Use SSE register passing conventions for float and double arguments
10248 and return values.  You can control this behavior for a specific
10249 function by using the function attribute @samp{sseregparm}.
10250 @xref{Function Attributes}.
10251
10252 @strong{Warning:} if you use this switch then you must build all
10253 modules with the same value, including any libraries.  This includes
10254 the system libraries and startup modules.
10255
10256 @item -mpc32
10257 @itemx -mpc64
10258 @itemx -mpc80
10259 @opindex mpc32
10260 @opindex mpc64
10261 @opindex mpc80
10262
10263 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10264 is specified, the significands of results of floating-point operations are
10265 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10266 significands of results of floating-point operations to 53 bits (double
10267 precision) and @option{-mpc80} rounds the significands of results of
10268 floating-point operations to 64 bits (extended double precision), which is
10269 the default.  When this option is used, floating-point operations in higher
10270 precisions are not available to the programmer without setting the FPU
10271 control word explicitly.
10272
10273 Setting the rounding of floating-point operations to less than the default
10274 80 bits can speed some programs by 2% or more.  Note that some mathematical
10275 libraries assume that extended precision (80 bit) floating-point operations
10276 are enabled by default; routines in such libraries could suffer significant
10277 loss of accuracy, typically through so-called "catastrophic cancellation",
10278 when this option is used to set the precision to less than extended precision. 
10279
10280 @item -mstackrealign
10281 @opindex mstackrealign
10282 Realign the stack at entry.  On the Intel x86, the
10283 @option{-mstackrealign} option will generate an alternate prologue and
10284 epilogue that realigns the runtime stack.  This supports mixing legacy
10285 codes that keep a 4-byte aligned stack with modern codes that keep a
10286 16-byte stack for SSE compatibility.  The alternate prologue and
10287 epilogue are slower and bigger than the regular ones, and the
10288 alternate prologue requires an extra scratch register; this lowers the
10289 number of registers available if used in conjunction with the
10290 @code{regparm} attribute.  The @option{-mstackrealign} option is
10291 incompatible with the nested function prologue; this is considered a
10292 hard error.  See also the attribute @code{force_align_arg_pointer},
10293 applicable to individual functions.
10294
10295 @item -mpreferred-stack-boundary=@var{num}
10296 @opindex mpreferred-stack-boundary
10297 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10298 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10299 the default is 4 (16 bytes or 128 bits).
10300
10301 On Pentium and PentiumPro, @code{double} and @code{long double} values
10302 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10303 suffer significant run time performance penalties.  On Pentium III, the
10304 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10305 properly if it is not 16 byte aligned.
10306
10307 To ensure proper alignment of this values on the stack, the stack boundary
10308 must be as aligned as that required by any value stored on the stack.
10309 Further, every function must be generated such that it keeps the stack
10310 aligned.  Thus calling a function compiled with a higher preferred
10311 stack boundary from a function compiled with a lower preferred stack
10312 boundary will most likely misalign the stack.  It is recommended that
10313 libraries that use callbacks always use the default setting.
10314
10315 This extra alignment does consume extra stack space, and generally
10316 increases code size.  Code that is sensitive to stack space usage, such
10317 as embedded systems and operating system kernels, may want to reduce the
10318 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10319
10320 @item -mmmx
10321 @itemx -mno-mmx
10322 @item -msse
10323 @itemx -mno-sse
10324 @item -msse2
10325 @itemx -mno-sse2
10326 @item -msse3
10327 @itemx -mno-sse3
10328 @item -mssse3
10329 @itemx -mno-ssse3
10330 @item -msse4.1
10331 @itemx -mno-sse4.1
10332 @item -msse4.2
10333 @itemx -mno-sse4.2
10334 @item -msse4
10335 @itemx -mno-sse4
10336 @item -msse4a
10337 @item -mno-sse4a
10338 @item -m3dnow
10339 @itemx -mno-3dnow
10340 @item -mpopcnt
10341 @itemx -mno-popcnt
10342 @item -mabm
10343 @itemx -mno-abm
10344 @opindex mmmx
10345 @opindex mno-mmx
10346 @opindex msse
10347 @opindex mno-sse
10348 @opindex m3dnow
10349 @opindex mno-3dnow
10350 These switches enable or disable the use of instructions in the MMX,
10351 SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4A, ABM or 3DNow! extended
10352 instruction sets.
10353 These extensions are also available as built-in functions: see
10354 @ref{X86 Built-in Functions}, for details of the functions enabled and
10355 disabled by these switches.
10356
10357 To have SSE/SSE2 instructions generated automatically from floating-point
10358 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10359
10360 These options will enable GCC to use these extended instructions in
10361 generated code, even without @option{-mfpmath=sse}.  Applications which
10362 perform runtime CPU detection must compile separate files for each
10363 supported architecture, using the appropriate flags.  In particular,
10364 the file containing the CPU detection code should be compiled without
10365 these options.
10366
10367 @item -mcx16
10368 @opindex mcx16
10369 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10370 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10371 data types.  This is useful for high resolution counters that could be updated
10372 by multiple processors (or cores).  This instruction is generated as part of
10373 atomic built-in functions: see @ref{Atomic Builtins} for details.
10374
10375 @item -msahf
10376 @opindex msahf
10377 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10378 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10379 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10380 SAHF are load and store instructions, respectively, for certain status flags.
10381 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10382 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10383
10384 @item -mrecip
10385 @opindex mrecip
10386 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10387 vectorized variants RCPPS and RSQRTPS) instead of DIVSS and SQRTSS (and their
10388 vectorized variants).  These instructions will be generated only when
10389 @option{-funsafe-math-optimizatons} is enabled.
10390
10391 @item -mpush-args
10392 @itemx -mno-push-args
10393 @opindex mpush-args
10394 @opindex mno-push-args
10395 Use PUSH operations to store outgoing parameters.  This method is shorter
10396 and usually equally fast as method using SUB/MOV operations and is enabled
10397 by default.  In some cases disabling it may improve performance because of
10398 improved scheduling and reduced dependencies.
10399
10400 @item -maccumulate-outgoing-args
10401 @opindex maccumulate-outgoing-args
10402 If enabled, the maximum amount of space required for outgoing arguments will be
10403 computed in the function prologue.  This is faster on most modern CPUs
10404 because of reduced dependencies, improved scheduling and reduced stack usage
10405 when preferred stack boundary is not equal to 2.  The drawback is a notable
10406 increase in code size.  This switch implies @option{-mno-push-args}.
10407
10408 @item -mthreads
10409 @opindex mthreads
10410 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10411 on thread-safe exception handling must compile and link all code with the
10412 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10413 @option{-D_MT}; when linking, it links in a special thread helper library
10414 @option{-lmingwthrd} which cleans up per thread exception handling data.
10415
10416 @item -mno-align-stringops
10417 @opindex mno-align-stringops
10418 Do not align destination of inlined string operations.  This switch reduces
10419 code size and improves performance in case the destination is already aligned,
10420 but GCC doesn't know about it.
10421
10422 @item -minline-all-stringops
10423 @opindex minline-all-stringops
10424 By default GCC inlines string operations only when destination is known to be
10425 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10426 size, but may improve performance of code that depends on fast memcpy, strlen
10427 and memset for short lengths.
10428
10429 @item -minline-stringops-dynamically
10430 @opindex minline-stringops-dynamically
10431 For string operation of unknown size, inline runtime checks so for small
10432 blocks inline code is used, while for large blocks library call is used.
10433
10434 @item -mstringop-strategy=@var{alg}
10435 @opindex mstringop-strategy=@var{alg}
10436 Overwrite internal decision heuristic about particular algorithm to inline
10437 string operation with.  The allowed values are @code{rep_byte},
10438 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10439 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10440 expanding inline loop, @code{libcall} for always expanding library call.
10441
10442 @item -momit-leaf-frame-pointer
10443 @opindex momit-leaf-frame-pointer
10444 Don't keep the frame pointer in a register for leaf functions.  This
10445 avoids the instructions to save, set up and restore frame pointers and
10446 makes an extra register available in leaf functions.  The option
10447 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10448 which might make debugging harder.
10449
10450 @item -mtls-direct-seg-refs
10451 @itemx -mno-tls-direct-seg-refs
10452 @opindex mtls-direct-seg-refs
10453 Controls whether TLS variables may be accessed with offsets from the
10454 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10455 or whether the thread base pointer must be added.  Whether or not this
10456 is legal depends on the operating system, and whether it maps the
10457 segment to cover the entire TLS area.
10458
10459 For systems that use GNU libc, the default is on.
10460 @end table
10461
10462 These @samp{-m} switches are supported in addition to the above
10463 on AMD x86-64 processors in 64-bit environments.
10464
10465 @table @gcctabopt
10466 @item -m32
10467 @itemx -m64
10468 @opindex m32
10469 @opindex m64
10470 Generate code for a 32-bit or 64-bit environment.
10471 The 32-bit environment sets int, long and pointer to 32 bits and
10472 generates code that runs on any i386 system.
10473 The 64-bit environment sets int to 32 bits and long and pointer
10474 to 64 bits and generates code for AMD's x86-64 architecture. For
10475 darwin only the -m64 option turns off the @option{-fno-pic} and
10476 @option{-mdynamic-no-pic} options.
10477
10478 @item -mno-red-zone
10479 @opindex no-red-zone
10480 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10481 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10482 stack pointer that will not be modified by signal or interrupt handlers
10483 and therefore can be used for temporary data without adjusting the stack
10484 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10485
10486 @item -mcmodel=small
10487 @opindex mcmodel=small
10488 Generate code for the small code model: the program and its symbols must
10489 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10490 Programs can be statically or dynamically linked.  This is the default
10491 code model.
10492
10493 @item -mcmodel=kernel
10494 @opindex mcmodel=kernel
10495 Generate code for the kernel code model.  The kernel runs in the
10496 negative 2 GB of the address space.
10497 This model has to be used for Linux kernel code.
10498
10499 @item -mcmodel=medium
10500 @opindex mcmodel=medium
10501 Generate code for the medium model: The program is linked in the lower 2
10502 GB of the address space but symbols can be located anywhere in the
10503 address space.  Programs can be statically or dynamically linked, but
10504 building of shared libraries are not supported with the medium model.
10505
10506 @item -mcmodel=large
10507 @opindex mcmodel=large
10508 Generate code for the large model: This model makes no assumptions
10509 about addresses and sizes of sections.
10510 @end table
10511
10512 @node IA-64 Options
10513 @subsection IA-64 Options
10514 @cindex IA-64 Options
10515
10516 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10517
10518 @table @gcctabopt
10519 @item -mbig-endian
10520 @opindex mbig-endian
10521 Generate code for a big endian target.  This is the default for HP-UX@.
10522
10523 @item -mlittle-endian
10524 @opindex mlittle-endian
10525 Generate code for a little endian target.  This is the default for AIX5
10526 and GNU/Linux.
10527
10528 @item -mgnu-as
10529 @itemx -mno-gnu-as
10530 @opindex mgnu-as
10531 @opindex mno-gnu-as
10532 Generate (or don't) code for the GNU assembler.  This is the default.
10533 @c Also, this is the default if the configure option @option{--with-gnu-as}
10534 @c is used.
10535
10536 @item -mgnu-ld
10537 @itemx -mno-gnu-ld
10538 @opindex mgnu-ld
10539 @opindex mno-gnu-ld
10540 Generate (or don't) code for the GNU linker.  This is the default.
10541 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10542 @c is used.
10543
10544 @item -mno-pic
10545 @opindex mno-pic
10546 Generate code that does not use a global pointer register.  The result
10547 is not position independent code, and violates the IA-64 ABI@.
10548
10549 @item -mvolatile-asm-stop
10550 @itemx -mno-volatile-asm-stop
10551 @opindex mvolatile-asm-stop
10552 @opindex mno-volatile-asm-stop
10553 Generate (or don't) a stop bit immediately before and after volatile asm
10554 statements.
10555
10556 @item -mregister-names
10557 @itemx -mno-register-names
10558 @opindex mregister-names
10559 @opindex mno-register-names
10560 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10561 the stacked registers.  This may make assembler output more readable.
10562
10563 @item -mno-sdata
10564 @itemx -msdata
10565 @opindex mno-sdata
10566 @opindex msdata
10567 Disable (or enable) optimizations that use the small data section.  This may
10568 be useful for working around optimizer bugs.
10569
10570 @item -mconstant-gp
10571 @opindex mconstant-gp
10572 Generate code that uses a single constant global pointer value.  This is
10573 useful when compiling kernel code.
10574
10575 @item -mauto-pic
10576 @opindex mauto-pic
10577 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10578 This is useful when compiling firmware code.
10579
10580 @item -minline-float-divide-min-latency
10581 @opindex minline-float-divide-min-latency
10582 Generate code for inline divides of floating point values
10583 using the minimum latency algorithm.
10584
10585 @item -minline-float-divide-max-throughput
10586 @opindex minline-float-divide-max-throughput
10587 Generate code for inline divides of floating point values
10588 using the maximum throughput algorithm.
10589
10590 @item -minline-int-divide-min-latency
10591 @opindex minline-int-divide-min-latency
10592 Generate code for inline divides of integer values
10593 using the minimum latency algorithm.
10594
10595 @item -minline-int-divide-max-throughput
10596 @opindex minline-int-divide-max-throughput
10597 Generate code for inline divides of integer values
10598 using the maximum throughput algorithm.
10599
10600 @item -minline-sqrt-min-latency
10601 @opindex minline-sqrt-min-latency
10602 Generate code for inline square roots
10603 using the minimum latency algorithm.
10604
10605 @item -minline-sqrt-max-throughput
10606 @opindex minline-sqrt-max-throughput
10607 Generate code for inline square roots
10608 using the maximum throughput algorithm.
10609
10610 @item -mno-dwarf2-asm
10611 @itemx -mdwarf2-asm
10612 @opindex mno-dwarf2-asm
10613 @opindex mdwarf2-asm
10614 Don't (or do) generate assembler code for the DWARF2 line number debugging
10615 info.  This may be useful when not using the GNU assembler.
10616
10617 @item -mearly-stop-bits
10618 @itemx -mno-early-stop-bits
10619 @opindex mearly-stop-bits
10620 @opindex mno-early-stop-bits
10621 Allow stop bits to be placed earlier than immediately preceding the
10622 instruction that triggered the stop bit.  This can improve instruction
10623 scheduling, but does not always do so.
10624
10625 @item -mfixed-range=@var{register-range}
10626 @opindex mfixed-range
10627 Generate code treating the given register range as fixed registers.
10628 A fixed register is one that the register allocator can not use.  This is
10629 useful when compiling kernel code.  A register range is specified as
10630 two registers separated by a dash.  Multiple register ranges can be
10631 specified separated by a comma.
10632
10633 @item -mtls-size=@var{tls-size}
10634 @opindex mtls-size
10635 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
10636 64.
10637
10638 @item -mtune=@var{cpu-type}
10639 @opindex mtune
10640 Tune the instruction scheduling for a particular CPU, Valid values are
10641 itanium, itanium1, merced, itanium2, and mckinley.
10642
10643 @item -mt
10644 @itemx -pthread
10645 @opindex mt
10646 @opindex pthread
10647 Add support for multithreading using the POSIX threads library.  This
10648 option sets flags for both the preprocessor and linker.  It does
10649 not affect the thread safety of object code produced by the compiler or
10650 that of libraries supplied with it.  These are HP-UX specific flags.
10651
10652 @item -milp32
10653 @itemx -mlp64
10654 @opindex milp32
10655 @opindex mlp64
10656 Generate code for a 32-bit or 64-bit environment.
10657 The 32-bit environment sets int, long and pointer to 32 bits.
10658 The 64-bit environment sets int to 32 bits and long and pointer
10659 to 64 bits.  These are HP-UX specific flags.
10660
10661 @item -mno-sched-br-data-spec
10662 @itemx -msched-br-data-spec
10663 @opindex mno-sched-br-data-spec
10664 @opindex msched-br-data-spec
10665 (Dis/En)able data speculative scheduling before reload.
10666 This will result in generation of the ld.a instructions and
10667 the corresponding check instructions (ld.c / chk.a).
10668 The default is 'disable'.
10669
10670 @item -msched-ar-data-spec
10671 @itemx -mno-sched-ar-data-spec
10672 @opindex msched-ar-data-spec
10673 @opindex mno-sched-ar-data-spec
10674 (En/Dis)able data speculative scheduling after reload.
10675 This will result in generation of the ld.a instructions and
10676 the corresponding check instructions (ld.c / chk.a).
10677 The default is 'enable'.
10678
10679 @item -mno-sched-control-spec
10680 @itemx -msched-control-spec
10681 @opindex mno-sched-control-spec
10682 @opindex msched-control-spec
10683 (Dis/En)able control speculative scheduling.  This feature is
10684 available only during region scheduling (i.e. before reload).
10685 This will result in generation of the ld.s instructions and
10686 the corresponding check instructions chk.s .
10687 The default is 'disable'.
10688
10689 @item -msched-br-in-data-spec
10690 @itemx -mno-sched-br-in-data-spec
10691 @opindex msched-br-in-data-spec
10692 @opindex mno-sched-br-in-data-spec
10693 (En/Dis)able speculative scheduling of the instructions that
10694 are dependent on the data speculative loads before reload.
10695 This is effective only with @option{-msched-br-data-spec} enabled.
10696 The default is 'enable'.
10697
10698 @item -msched-ar-in-data-spec
10699 @itemx -mno-sched-ar-in-data-spec
10700 @opindex msched-ar-in-data-spec
10701 @opindex mno-sched-ar-in-data-spec
10702 (En/Dis)able speculative scheduling of the instructions that
10703 are dependent on the data speculative loads after reload.
10704 This is effective only with @option{-msched-ar-data-spec} enabled.
10705 The default is 'enable'.
10706
10707 @item -msched-in-control-spec
10708 @itemx -mno-sched-in-control-spec
10709 @opindex msched-in-control-spec
10710 @opindex mno-sched-in-control-spec
10711 (En/Dis)able speculative scheduling of the instructions that
10712 are dependent on the control speculative loads.
10713 This is effective only with @option{-msched-control-spec} enabled.
10714 The default is 'enable'.
10715
10716 @item -msched-ldc
10717 @itemx -mno-sched-ldc
10718 @opindex msched-ldc
10719 @opindex mno-sched-ldc
10720 (En/Dis)able use of simple data speculation checks ld.c .
10721 If disabled, only chk.a instructions will be emitted to check
10722 data speculative loads.
10723 The default is 'enable'.
10724
10725 @item -mno-sched-control-ldc
10726 @itemx -msched-control-ldc
10727 @opindex mno-sched-control-ldc
10728 @opindex msched-control-ldc
10729 (Dis/En)able use of ld.c instructions to check control speculative loads.
10730 If enabled, in case of control speculative load with no speculatively
10731 scheduled dependent instructions this load will be emitted as ld.sa and
10732 ld.c will be used to check it.
10733 The default is 'disable'.
10734
10735 @item -mno-sched-spec-verbose
10736 @itemx -msched-spec-verbose
10737 @opindex mno-sched-spec-verbose
10738 @opindex msched-spec-verbose
10739 (Dis/En)able printing of the information about speculative motions.
10740
10741 @item -mno-sched-prefer-non-data-spec-insns
10742 @itemx -msched-prefer-non-data-spec-insns
10743 @opindex mno-sched-prefer-non-data-spec-insns
10744 @opindex msched-prefer-non-data-spec-insns
10745 If enabled, data speculative instructions will be chosen for schedule
10746 only if there are no other choices at the moment.  This will make
10747 the use of the data speculation much more conservative.
10748 The default is 'disable'.
10749
10750 @item -mno-sched-prefer-non-control-spec-insns
10751 @itemx -msched-prefer-non-control-spec-insns
10752 @opindex mno-sched-prefer-non-control-spec-insns
10753 @opindex msched-prefer-non-control-spec-insns
10754 If enabled, control speculative instructions will be chosen for schedule
10755 only if there are no other choices at the moment.  This will make
10756 the use of the control speculation much more conservative.
10757 The default is 'disable'.
10758
10759 @item -mno-sched-count-spec-in-critical-path
10760 @itemx -msched-count-spec-in-critical-path
10761 @opindex mno-sched-count-spec-in-critical-path
10762 @opindex msched-count-spec-in-critical-path
10763 If enabled, speculative dependencies will be considered during
10764 computation of the instructions priorities.  This will make the use of the
10765 speculation a bit more conservative.
10766 The default is 'disable'.
10767
10768 @end table
10769
10770 @node M32C Options
10771 @subsection M32C Options
10772 @cindex M32C options
10773
10774 @table @gcctabopt
10775 @item -mcpu=@var{name}
10776 @opindex mcpu=
10777 Select the CPU for which code is generated.  @var{name} may be one of
10778 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10779 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10780 the M32C/80 series.
10781
10782 @item -msim
10783 @opindex msim
10784 Specifies that the program will be run on the simulator.  This causes
10785 an alternate runtime library to be linked in which supports, for
10786 example, file I/O.  You must not use this option when generating
10787 programs that will run on real hardware; you must provide your own
10788 runtime library for whatever I/O functions are needed.
10789
10790 @item -memregs=@var{number}
10791 @opindex memregs=
10792 Specifies the number of memory-based pseudo-registers GCC will use
10793 during code generation.  These pseudo-registers will be used like real
10794 registers, so there is a tradeoff between GCC's ability to fit the
10795 code into available registers, and the performance penalty of using
10796 memory instead of registers.  Note that all modules in a program must
10797 be compiled with the same value for this option.  Because of that, you
10798 must not use this option with the default runtime libraries gcc
10799 builds.
10800
10801 @end table
10802
10803 @node M32R/D Options
10804 @subsection M32R/D Options
10805 @cindex M32R/D options
10806
10807 These @option{-m} options are defined for Renesas M32R/D architectures:
10808
10809 @table @gcctabopt
10810 @item -m32r2
10811 @opindex m32r2
10812 Generate code for the M32R/2@.
10813
10814 @item -m32rx
10815 @opindex m32rx
10816 Generate code for the M32R/X@.
10817
10818 @item -m32r
10819 @opindex m32r
10820 Generate code for the M32R@.  This is the default.
10821
10822 @item -mmodel=small
10823 @opindex mmodel=small
10824 Assume all objects live in the lower 16MB of memory (so that their addresses
10825 can be loaded with the @code{ld24} instruction), and assume all subroutines
10826 are reachable with the @code{bl} instruction.
10827 This is the default.
10828
10829 The addressability of a particular object can be set with the
10830 @code{model} attribute.
10831
10832 @item -mmodel=medium
10833 @opindex mmodel=medium
10834 Assume objects may be anywhere in the 32-bit address space (the compiler
10835 will generate @code{seth/add3} instructions to load their addresses), and
10836 assume all subroutines are reachable with the @code{bl} instruction.
10837
10838 @item -mmodel=large
10839 @opindex mmodel=large
10840 Assume objects may be anywhere in the 32-bit address space (the compiler
10841 will generate @code{seth/add3} instructions to load their addresses), and
10842 assume subroutines may not be reachable with the @code{bl} instruction
10843 (the compiler will generate the much slower @code{seth/add3/jl}
10844 instruction sequence).
10845
10846 @item -msdata=none
10847 @opindex msdata=none
10848 Disable use of the small data area.  Variables will be put into
10849 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10850 @code{section} attribute has been specified).
10851 This is the default.
10852
10853 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10854 Objects may be explicitly put in the small data area with the
10855 @code{section} attribute using one of these sections.
10856
10857 @item -msdata=sdata
10858 @opindex msdata=sdata
10859 Put small global and static data in the small data area, but do not
10860 generate special code to reference them.
10861
10862 @item -msdata=use
10863 @opindex msdata=use
10864 Put small global and static data in the small data area, and generate
10865 special instructions to reference them.
10866
10867 @item -G @var{num}
10868 @opindex G
10869 @cindex smaller data references
10870 Put global and static objects less than or equal to @var{num} bytes
10871 into the small data or bss sections instead of the normal data or bss
10872 sections.  The default value of @var{num} is 8.
10873 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10874 for this option to have any effect.
10875
10876 All modules should be compiled with the same @option{-G @var{num}} value.
10877 Compiling with different values of @var{num} may or may not work; if it
10878 doesn't the linker will give an error message---incorrect code will not be
10879 generated.
10880
10881 @item -mdebug
10882 @opindex mdebug
10883 Makes the M32R specific code in the compiler display some statistics
10884 that might help in debugging programs.
10885
10886 @item -malign-loops
10887 @opindex malign-loops
10888 Align all loops to a 32-byte boundary.
10889
10890 @item -mno-align-loops
10891 @opindex mno-align-loops
10892 Do not enforce a 32-byte alignment for loops.  This is the default.
10893
10894 @item -missue-rate=@var{number}
10895 @opindex missue-rate=@var{number}
10896 Issue @var{number} instructions per cycle.  @var{number} can only be 1
10897 or 2.
10898
10899 @item -mbranch-cost=@var{number}
10900 @opindex mbranch-cost=@var{number}
10901 @var{number} can only be 1 or 2.  If it is 1 then branches will be
10902 preferred over conditional code, if it is 2, then the opposite will
10903 apply.
10904
10905 @item -mflush-trap=@var{number}
10906 @opindex mflush-trap=@var{number}
10907 Specifies the trap number to use to flush the cache.  The default is
10908 12.  Valid numbers are between 0 and 15 inclusive.
10909
10910 @item -mno-flush-trap
10911 @opindex mno-flush-trap
10912 Specifies that the cache cannot be flushed by using a trap.
10913
10914 @item -mflush-func=@var{name}
10915 @opindex mflush-func=@var{name}
10916 Specifies the name of the operating system function to call to flush
10917 the cache.  The default is @emph{_flush_cache}, but a function call
10918 will only be used if a trap is not available.
10919
10920 @item -mno-flush-func
10921 @opindex mno-flush-func
10922 Indicates that there is no OS function for flushing the cache.
10923
10924 @end table
10925
10926 @node M680x0 Options
10927 @subsection M680x0 Options
10928 @cindex M680x0 options
10929
10930 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
10931 The default settings depend on which architecture was selected when
10932 the compiler was configured; the defaults for the most common choices
10933 are given below.
10934
10935 @table @gcctabopt
10936 @item -march=@var{arch}
10937 @opindex march
10938 Generate code for a specific M680x0 or ColdFire instruction set
10939 architecture.  Permissible values of @var{arch} for M680x0
10940 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
10941 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
10942 architectures are selected according to Freescale's ISA classification
10943 and the permissible values are: @samp{isaa}, @samp{isaaplus},
10944 @samp{isab} and @samp{isac}.
10945
10946 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
10947 code for a ColdFire target.  The @var{arch} in this macro is one of the
10948 @option{-march} arguments given above.
10949
10950 When used together, @option{-march} and @option{-mtune} select code
10951 that runs on a family of similar processors but that is optimized
10952 for a particular microarchitecture.
10953
10954 @item -mcpu=@var{cpu}
10955 @opindex mcpu
10956 Generate code for a specific M680x0 or ColdFire processor.
10957 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
10958 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
10959 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
10960 below, which also classifies the CPUs into families:
10961
10962 @multitable @columnfractions 0.20 0.80
10963 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
10964 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
10965 @item @samp{5206e} @tab @samp{5206e}
10966 @item @samp{5208} @tab @samp{5207} @samp{5208}
10967 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
10968 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
10969 @item @samp{5216} @tab @samp{5214} @samp{5216}
10970 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
10971 @item @samp{5225} @tab @samp{5224} @samp{5225}
10972 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
10973 @item @samp{5249} @tab @samp{5249}
10974 @item @samp{5250} @tab @samp{5250}
10975 @item @samp{5271} @tab @samp{5270} @samp{5271}
10976 @item @samp{5272} @tab @samp{5272}
10977 @item @samp{5275} @tab @samp{5274} @samp{5275}
10978 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
10979 @item @samp{5307} @tab @samp{5307}
10980 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
10981 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
10982 @item @samp{5407} @tab @samp{5407}
10983 @item @samp{5475} @tab @samp{5470} @samp{5471} @samp{5472} @samp{5473} @samp{5474} @samp{5475} @samp{547x} @samp{5480} @samp{5481} @samp{5482} @samp{5483} @samp{5484} @samp{5485}
10984 @end multitable
10985
10986 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
10987 @var{arch} is compatible with @var{cpu}.  Other combinations of
10988 @option{-mcpu} and @option{-march} are rejected.
10989
10990 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
10991 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
10992 where the value of @var{family} is given by the table above.
10993
10994 @item -mtune=@var{tune}
10995 @opindex mtune
10996 Tune the code for a particular microarchitecture, within the
10997 constraints set by @option{-march} and @option{-mcpu}.
10998 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
10999 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11000 and @samp{cpu32}.  The ColdFire microarchitectures
11001 are: @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11002
11003 You can also use @option{-mtune=68020-40} for code that needs
11004 to run relatively well on 68020, 68030 and 68040 targets.
11005 @option{-mtune=68020-60} is similar but includes 68060 targets
11006 as well.  These two options select the same tuning decisions as
11007 @option{-m68020-40} and @option{-m68020-60} respectively.
11008
11009 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11010 when tuning for 680x0 architecture @var{arch}.  It also defines
11011 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11012 option is used.  If gcc is tuning for a range of architectures,
11013 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11014 it defines the macros for every architecture in the range.
11015
11016 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11017 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11018 of the arguments given above.
11019
11020 @item -m68000
11021 @itemx -mc68000
11022 @opindex m68000
11023 @opindex mc68000
11024 Generate output for a 68000.  This is the default
11025 when the compiler is configured for 68000-based systems.
11026 It is equivalent to @option{-march=68000}.
11027
11028 Use this option for microcontrollers with a 68000 or EC000 core,
11029 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11030
11031 @item -m68010
11032 @opindex m68010
11033 Generate output for a 68010.  This is the default
11034 when the compiler is configured for 68010-based systems.
11035 It is equivalent to @option{-march=68010}.
11036
11037 @item -m68020
11038 @itemx -mc68020
11039 @opindex m68020
11040 @opindex mc68020
11041 Generate output for a 68020.  This is the default
11042 when the compiler is configured for 68020-based systems.
11043 It is equivalent to @option{-march=68020}.
11044
11045 @item -m68030
11046 @opindex m68030
11047 Generate output for a 68030.  This is the default when the compiler is
11048 configured for 68030-based systems.  It is equivalent to
11049 @option{-march=68030}.
11050
11051 @item -m68040
11052 @opindex m68040
11053 Generate output for a 68040.  This is the default when the compiler is
11054 configured for 68040-based systems.  It is equivalent to
11055 @option{-march=68040}.
11056
11057 This option inhibits the use of 68881/68882 instructions that have to be
11058 emulated by software on the 68040.  Use this option if your 68040 does not
11059 have code to emulate those instructions.
11060
11061 @item -m68060
11062 @opindex m68060
11063 Generate output for a 68060.  This is the default when the compiler is
11064 configured for 68060-based systems.  It is equivalent to
11065 @option{-march=68060}.
11066
11067 This option inhibits the use of 68020 and 68881/68882 instructions that
11068 have to be emulated by software on the 68060.  Use this option if your 68060
11069 does not have code to emulate those instructions.
11070
11071 @item -mcpu32
11072 @opindex mcpu32
11073 Generate output for a CPU32.  This is the default
11074 when the compiler is configured for CPU32-based systems.
11075 It is equivalent to @option{-march=cpu32}.
11076
11077 Use this option for microcontrollers with a
11078 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11079 68336, 68340, 68341, 68349 and 68360.
11080
11081 @item -m5200
11082 @opindex m5200
11083 Generate output for a 520X ColdFire CPU.  This is the default
11084 when the compiler is configured for 520X-based systems.
11085 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11086 in favor of that option.
11087
11088 Use this option for microcontroller with a 5200 core, including
11089 the MCF5202, MCF5203, MCF5204 and MCF5206.
11090
11091 @item -m5206e
11092 @opindex m5206e
11093 Generate output for a 5206e ColdFire CPU.  The option is now
11094 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11095
11096 @item -m528x
11097 @opindex m528x
11098 Generate output for a member of the ColdFire 528X family.
11099 The option is now deprecated in favor of the equivalent
11100 @option{-mcpu=528x}.
11101
11102 @item -m5307
11103 @opindex m5307
11104 Generate output for a ColdFire 5307 CPU.  The option is now deprecated
11105 in favor of the equivalent @option{-mcpu=5307}.
11106
11107 @item -m5407
11108 @opindex m5407
11109 Generate output for a ColdFire 5407 CPU.  The option is now deprecated
11110 in favor of the equivalent @option{-mcpu=5407}.
11111
11112 @item -mcfv4e
11113 @opindex mcfv4e
11114 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11115 This includes use of hardware floating point instructions.
11116 The option is equivalent to @option{-mcpu=547x}, and is now
11117 deprecated in favor of that option.
11118
11119 @item -m68020-40
11120 @opindex m68020-40
11121 Generate output for a 68040, without using any of the new instructions.
11122 This results in code which can run relatively efficiently on either a
11123 68020/68881 or a 68030 or a 68040.  The generated code does use the
11124 68881 instructions that are emulated on the 68040.
11125
11126 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11127
11128 @item -m68020-60
11129 @opindex m68020-60
11130 Generate output for a 68060, without using any of the new instructions.
11131 This results in code which can run relatively efficiently on either a
11132 68020/68881 or a 68030 or a 68040.  The generated code does use the
11133 68881 instructions that are emulated on the 68060.
11134
11135 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11136
11137 @item -mhard-float
11138 @itemx -m68881
11139 @opindex mhard-float
11140 @opindex m68881
11141 Generate floating-point instructions.  This is the default for 68020
11142 and above, and for ColdFire devices that have an FPU.  It defines the
11143 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11144 on ColdFire targets.
11145
11146 @item -msoft-float
11147 @opindex msoft-float
11148 Do not generate floating-point instructions; use library calls instead.
11149 This is the default for 68000, 68010, and 68832 targets.  It is also
11150 the default for ColdFire devices that have no FPU.
11151
11152 @item -mdiv
11153 @itemx -mno-div
11154 @opindex mdiv
11155 @opindex mno-div
11156 Generate (do not generate) ColdFire hardware divide and remainder
11157 instructions.  If @option{-march} is used without @option{-mcpu},
11158 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11159 architectures.  Otherwise, the default is taken from the target CPU
11160 (either the default CPU, or the one specified by @option{-mcpu}).  For
11161 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11162 @option{-mcpu=5206e}.
11163
11164 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11165
11166 @item -mshort
11167 @opindex mshort
11168 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11169 Additionally, parameters passed on the stack are also aligned to a
11170 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11171
11172 @item -mno-short
11173 @opindex mno-short
11174 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11175
11176 @item -mnobitfield
11177 @itemx -mno-bitfield
11178 @opindex mnobitfield
11179 @opindex mno-bitfield
11180 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11181 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11182
11183 @item -mbitfield
11184 @opindex mbitfield
11185 Do use the bit-field instructions.  The @option{-m68020} option implies
11186 @option{-mbitfield}.  This is the default if you use a configuration
11187 designed for a 68020.
11188
11189 @item -mrtd
11190 @opindex mrtd
11191 Use a different function-calling convention, in which functions
11192 that take a fixed number of arguments return with the @code{rtd}
11193 instruction, which pops their arguments while returning.  This
11194 saves one instruction in the caller since there is no need to pop
11195 the arguments there.
11196
11197 This calling convention is incompatible with the one normally
11198 used on Unix, so you cannot use it if you need to call libraries
11199 compiled with the Unix compiler.
11200
11201 Also, you must provide function prototypes for all functions that
11202 take variable numbers of arguments (including @code{printf});
11203 otherwise incorrect code will be generated for calls to those
11204 functions.
11205
11206 In addition, seriously incorrect code will result if you call a
11207 function with too many arguments.  (Normally, extra arguments are
11208 harmlessly ignored.)
11209
11210 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11211 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11212
11213 @item -mno-rtd
11214 @opindex mno-rtd
11215 Do not use the calling conventions selected by @option{-mrtd}.
11216 This is the default.
11217
11218 @item -malign-int
11219 @itemx -mno-align-int
11220 @opindex malign-int
11221 @opindex mno-align-int
11222 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11223 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11224 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11225 Aligning variables on 32-bit boundaries produces code that runs somewhat
11226 faster on processors with 32-bit busses at the expense of more memory.
11227
11228 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11229 align structures containing the above types  differently than
11230 most published application binary interface specifications for the m68k.
11231
11232 @item -mpcrel
11233 @opindex mpcrel
11234 Use the pc-relative addressing mode of the 68000 directly, instead of
11235 using a global offset table.  At present, this option implies @option{-fpic},
11236 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11237 not presently supported with @option{-mpcrel}, though this could be supported for
11238 68020 and higher processors.
11239
11240 @item -mno-strict-align
11241 @itemx -mstrict-align
11242 @opindex mno-strict-align
11243 @opindex mstrict-align
11244 Do not (do) assume that unaligned memory references will be handled by
11245 the system.
11246
11247 @item -msep-data
11248 Generate code that allows the data segment to be located in a different
11249 area of memory from the text segment.  This allows for execute in place in
11250 an environment without virtual memory management.  This option implies
11251 @option{-fPIC}.
11252
11253 @item -mno-sep-data
11254 Generate code that assumes that the data segment follows the text segment.
11255 This is the default.
11256
11257 @item -mid-shared-library
11258 Generate code that supports shared libraries via the library ID method.
11259 This allows for execute in place and shared libraries in an environment
11260 without virtual memory management.  This option implies @option{-fPIC}.
11261
11262 @item -mno-id-shared-library
11263 Generate code that doesn't assume ID based shared libraries are being used.
11264 This is the default.
11265
11266 @item -mshared-library-id=n
11267 Specified the identification number of the ID based shared library being
11268 compiled.  Specifying a value of 0 will generate more compact code, specifying
11269 other values will force the allocation of that number to the current
11270 library but is no more space or time efficient than omitting this option.
11271
11272 @end table
11273
11274 @node M68hc1x Options
11275 @subsection M68hc1x Options
11276 @cindex M68hc1x options
11277
11278 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11279 microcontrollers.  The default values for these options depends on
11280 which style of microcontroller was selected when the compiler was configured;
11281 the defaults for the most common choices are given below.
11282
11283 @table @gcctabopt
11284 @item -m6811
11285 @itemx -m68hc11
11286 @opindex m6811
11287 @opindex m68hc11
11288 Generate output for a 68HC11.  This is the default
11289 when the compiler is configured for 68HC11-based systems.
11290
11291 @item -m6812
11292 @itemx -m68hc12
11293 @opindex m6812
11294 @opindex m68hc12
11295 Generate output for a 68HC12.  This is the default
11296 when the compiler is configured for 68HC12-based systems.
11297
11298 @item -m68S12
11299 @itemx -m68hcs12
11300 @opindex m68S12
11301 @opindex m68hcs12
11302 Generate output for a 68HCS12.
11303
11304 @item -mauto-incdec
11305 @opindex mauto-incdec
11306 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11307 addressing modes.
11308
11309 @item -minmax
11310 @itemx -nominmax
11311 @opindex minmax
11312 @opindex mnominmax
11313 Enable the use of 68HC12 min and max instructions.
11314
11315 @item -mlong-calls
11316 @itemx -mno-long-calls
11317 @opindex mlong-calls
11318 @opindex mno-long-calls
11319 Treat all calls as being far away (near).  If calls are assumed to be
11320 far away, the compiler will use the @code{call} instruction to
11321 call a function and the @code{rtc} instruction for returning.
11322
11323 @item -mshort
11324 @opindex mshort
11325 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11326
11327 @item -msoft-reg-count=@var{count}
11328 @opindex msoft-reg-count
11329 Specify the number of pseudo-soft registers which are used for the
11330 code generation.  The maximum number is 32.  Using more pseudo-soft
11331 register may or may not result in better code depending on the program.
11332 The default is 4 for 68HC11 and 2 for 68HC12.
11333
11334 @end table
11335
11336 @node MCore Options
11337 @subsection MCore Options
11338 @cindex MCore options
11339
11340 These are the @samp{-m} options defined for the Motorola M*Core
11341 processors.
11342
11343 @table @gcctabopt
11344
11345 @item -mhardlit
11346 @itemx -mno-hardlit
11347 @opindex mhardlit
11348 @opindex mno-hardlit
11349 Inline constants into the code stream if it can be done in two
11350 instructions or less.
11351
11352 @item -mdiv
11353 @itemx -mno-div
11354 @opindex mdiv
11355 @opindex mno-div
11356 Use the divide instruction.  (Enabled by default).
11357
11358 @item -mrelax-immediate
11359 @itemx -mno-relax-immediate
11360 @opindex mrelax-immediate
11361 @opindex mno-relax-immediate
11362 Allow arbitrary sized immediates in bit operations.
11363
11364 @item -mwide-bitfields
11365 @itemx -mno-wide-bitfields
11366 @opindex mwide-bitfields
11367 @opindex mno-wide-bitfields
11368 Always treat bit-fields as int-sized.
11369
11370 @item -m4byte-functions
11371 @itemx -mno-4byte-functions
11372 @opindex m4byte-functions
11373 @opindex mno-4byte-functions
11374 Force all functions to be aligned to a four byte boundary.
11375
11376 @item -mcallgraph-data
11377 @itemx -mno-callgraph-data
11378 @opindex mcallgraph-data
11379 @opindex mno-callgraph-data
11380 Emit callgraph information.
11381
11382 @item -mslow-bytes
11383 @itemx -mno-slow-bytes
11384 @opindex mslow-bytes
11385 @opindex mno-slow-bytes
11386 Prefer word access when reading byte quantities.
11387
11388 @item -mlittle-endian
11389 @itemx -mbig-endian
11390 @opindex mlittle-endian
11391 @opindex mbig-endian
11392 Generate code for a little endian target.
11393
11394 @item -m210
11395 @itemx -m340
11396 @opindex m210
11397 @opindex m340
11398 Generate code for the 210 processor.
11399 @end table
11400
11401 @node MIPS Options
11402 @subsection MIPS Options
11403 @cindex MIPS options
11404
11405 @table @gcctabopt
11406
11407 @item -EB
11408 @opindex EB
11409 Generate big-endian code.
11410
11411 @item -EL
11412 @opindex EL
11413 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11414 configurations.
11415
11416 @item -march=@var{arch}
11417 @opindex march
11418 Generate code that will run on @var{arch}, which can be the name of a
11419 generic MIPS ISA, or the name of a particular processor.
11420 The ISA names are:
11421 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11422 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11423 The processor names are:
11424 @samp{4kc}, @samp{4km}, @samp{4kp},
11425 @samp{4kec}, @samp{4kem}, @samp{4kep},
11426 @samp{5kc}, @samp{5kf},
11427 @samp{20kc},
11428 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11429 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11430 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11431 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1},
11432 @samp{m4k},
11433 @samp{orion},
11434 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11435 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11436 @samp{rm7000}, @samp{rm9000},
11437 @samp{sb1},
11438 @samp{sr71000},
11439 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11440 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11441 The special value @samp{from-abi} selects the
11442 most compatible architecture for the selected ABI (that is,
11443 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11444
11445 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11446 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11447 @samp{vr} may be written @samp{r}.
11448
11449 Names of the form @samp{@var{n}f2_1} refer to processors with
11450 FPUs clocked at half the rate of the core.  Names of the form
11451 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11452 rate as the core.  For compatibility reasons, @samp{@var{n}f} is
11453 accepted as a synonym for @samp{@var{n}f2_1} while @samp{@var{n}x} and
11454 @samp{@var{b}fx} are accepted as synonyms for @samp{@var{n}f1_1}.
11455
11456 GCC defines two macros based on the value of this option.  The first
11457 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11458 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11459 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11460 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11461 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11462
11463 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11464 above.  In other words, it will have the full prefix and will not
11465 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11466 the macro names the resolved architecture (either @samp{"mips1"} or
11467 @samp{"mips3"}).  It names the default architecture when no
11468 @option{-march} option is given.
11469
11470 @item -mtune=@var{arch}
11471 @opindex mtune
11472 Optimize for @var{arch}.  Among other things, this option controls
11473 the way instructions are scheduled, and the perceived cost of arithmetic
11474 operations.  The list of @var{arch} values is the same as for
11475 @option{-march}.
11476
11477 When this option is not used, GCC will optimize for the processor
11478 specified by @option{-march}.  By using @option{-march} and
11479 @option{-mtune} together, it is possible to generate code that will
11480 run on a family of processors, but optimize the code for one
11481 particular member of that family.
11482
11483 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11484 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11485 @samp{-march} ones described above.
11486
11487 @item -mips1
11488 @opindex mips1
11489 Equivalent to @samp{-march=mips1}.
11490
11491 @item -mips2
11492 @opindex mips2
11493 Equivalent to @samp{-march=mips2}.
11494
11495 @item -mips3
11496 @opindex mips3
11497 Equivalent to @samp{-march=mips3}.
11498
11499 @item -mips4
11500 @opindex mips4
11501 Equivalent to @samp{-march=mips4}.
11502
11503 @item -mips32
11504 @opindex mips32
11505 Equivalent to @samp{-march=mips32}.
11506
11507 @item -mips32r2
11508 @opindex mips32r2
11509 Equivalent to @samp{-march=mips32r2}.
11510
11511 @item -mips64
11512 @opindex mips64
11513 Equivalent to @samp{-march=mips64}.
11514
11515 @item -mips16
11516 @itemx -mno-mips16
11517 @opindex mips16
11518 @opindex mno-mips16
11519 Generate (do not generate) MIPS16 code.  If GCC is targetting a
11520 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
11521
11522 @item -mabi=32
11523 @itemx -mabi=o64
11524 @itemx -mabi=n32
11525 @itemx -mabi=64
11526 @itemx -mabi=eabi
11527 @opindex mabi=32
11528 @opindex mabi=o64
11529 @opindex mabi=n32
11530 @opindex mabi=64
11531 @opindex mabi=eabi
11532 Generate code for the given ABI@.
11533
11534 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
11535 generates 64-bit code when you select a 64-bit architecture, but you
11536 can use @option{-mgp32} to get 32-bit code instead.
11537
11538 For information about the O64 ABI, see
11539 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
11540
11541 GCC supports a variant of the o32 ABI in which floating-point registers
11542 are 64 rather than 32 bits wide.  You can select this combination with
11543 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
11544 and @samp{mfhc1} instructions and is therefore only supported for
11545 MIPS32R2 processors.
11546
11547 The register assignments for arguments and return values remain the
11548 same, but each scalar value is passed in a single 64-bit register
11549 rather than a pair of 32-bit registers.  For example, scalar
11550 floating-point values are returned in @samp{$f0} only, not a
11551 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
11552 remains the same, but all 64 bits are saved.
11553
11554 @item -mabicalls
11555 @itemx -mno-abicalls
11556 @opindex mabicalls
11557 @opindex mno-abicalls
11558 Generate (do not generate) code that is suitable for SVR4-style
11559 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
11560 systems.
11561
11562 @item -mshared
11563 @itemx -mno-shared
11564 Generate (do not generate) code that is fully position-independent,
11565 and that can therefore be linked into shared libraries.  This option
11566 only affects @option{-mabicalls}.
11567
11568 All @option{-mabicalls} code has traditionally been position-independent,
11569 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
11570 as an extension, the GNU toolchain allows executables to use absolute
11571 accesses for locally-binding symbols.  It can also use shorter GP
11572 initialization sequences and generate direct calls to locally-defined
11573 functions.  This mode is selected by @option{-mno-shared}.
11574
11575 @option{-mno-shared} depends on binutils 2.16 or higher and generates
11576 objects that can only be linked by the GNU linker.  However, the option
11577 does not affect the ABI of the final executable; it only affects the ABI
11578 of relocatable objects.  Using @option{-mno-shared} will generally make
11579 executables both smaller and quicker.
11580
11581 @option{-mshared} is the default.
11582
11583 @item -mxgot
11584 @itemx -mno-xgot
11585 @opindex mxgot
11586 @opindex mno-xgot
11587 Lift (do not lift) the usual restrictions on the size of the global
11588 offset table.
11589
11590 GCC normally uses a single instruction to load values from the GOT@.
11591 While this is relatively efficient, it will only work if the GOT
11592 is smaller than about 64k.  Anything larger will cause the linker
11593 to report an error such as:
11594
11595 @cindex relocation truncated to fit (MIPS)
11596 @smallexample
11597 relocation truncated to fit: R_MIPS_GOT16 foobar
11598 @end smallexample
11599
11600 If this happens, you should recompile your code with @option{-mxgot}.
11601 It should then work with very large GOTs, although it will also be
11602 less efficient, since it will take three instructions to fetch the
11603 value of a global symbol.
11604
11605 Note that some linkers can create multiple GOTs.  If you have such a
11606 linker, you should only need to use @option{-mxgot} when a single object
11607 file accesses more than 64k's worth of GOT entries.  Very few do.
11608
11609 These options have no effect unless GCC is generating position
11610 independent code.
11611
11612 @item -mgp32
11613 @opindex mgp32
11614 Assume that general-purpose registers are 32 bits wide.
11615
11616 @item -mgp64
11617 @opindex mgp64
11618 Assume that general-purpose registers are 64 bits wide.
11619
11620 @item -mfp32
11621 @opindex mfp32
11622 Assume that floating-point registers are 32 bits wide.
11623
11624 @item -mfp64
11625 @opindex mfp64
11626 Assume that floating-point registers are 64 bits wide.
11627
11628 @item -mhard-float
11629 @opindex mhard-float
11630 Use floating-point coprocessor instructions.
11631
11632 @item -msoft-float
11633 @opindex msoft-float
11634 Do not use floating-point coprocessor instructions.  Implement
11635 floating-point calculations using library calls instead.
11636
11637 @item -msingle-float
11638 @opindex msingle-float
11639 Assume that the floating-point coprocessor only supports single-precision
11640 operations.
11641
11642 @item -mdouble-float
11643 @opindex mdouble-float
11644 Assume that the floating-point coprocessor supports double-precision
11645 operations.  This is the default.
11646
11647 @item -mdsp
11648 @itemx -mno-dsp
11649 @opindex mdsp
11650 @opindex mno-dsp
11651 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
11652
11653 @item -mdspr2
11654 @itemx -mno-dspr2
11655 @opindex mdspr2
11656 @opindex mno-dspr2
11657 Use (do not use) the MIPS DSP ASE REV 2.  @xref{MIPS DSP Built-in Functions}.
11658 The option @option{-mdspr2} implies @option{-mdsp}.
11659
11660 @item -mpaired-single
11661 @itemx -mno-paired-single
11662 @opindex mpaired-single
11663 @opindex mno-paired-single
11664 Use (do not use) paired-single floating-point instructions.
11665 @xref{MIPS Paired-Single Support}.  This option can only be used
11666 when generating 64-bit code and requires hardware floating-point
11667 support to be enabled.
11668
11669 @item -mdmx
11670 @itemx -mno-mdmx
11671 @opindex mdmx
11672 @opindex mno-mdmx
11673 Use (do not use) MIPS Digital Media Extension instructions.
11674 This option can only be used when generating 64-bit code and requires
11675 hardware floating-point support to be enabled.
11676
11677 @item -mips3d
11678 @itemx -mno-mips3d
11679 @opindex mips3d
11680 @opindex mno-mips3d
11681 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
11682 The option @option{-mips3d} implies @option{-mpaired-single}.
11683
11684 @item -mmt
11685 @itemx -mno-mt
11686 @opindex mmt
11687 @opindex mno-mt
11688 Use (do not use) MT Multithreading instructions.
11689
11690 @item -mlong64
11691 @opindex mlong64
11692 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
11693 an explanation of the default and the way that the pointer size is
11694 determined.
11695
11696 @item -mlong32
11697 @opindex mlong32
11698 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
11699
11700 The default size of @code{int}s, @code{long}s and pointers depends on
11701 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
11702 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
11703 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
11704 or the same size as integer registers, whichever is smaller.
11705
11706 @item -msym32
11707 @itemx -mno-sym32
11708 @opindex msym32
11709 @opindex mno-sym32
11710 Assume (do not assume) that all symbols have 32-bit values, regardless
11711 of the selected ABI@.  This option is useful in combination with
11712 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
11713 to generate shorter and faster references to symbolic addresses.
11714
11715 @item -G @var{num}
11716 @opindex G
11717 @cindex smaller data references (MIPS)
11718 @cindex gp-relative references (MIPS)
11719 Put global and static items less than or equal to @var{num} bytes into
11720 the small data or bss section instead of the normal data or bss section.
11721 This allows the data to be accessed using a single instruction.
11722
11723 All modules should be compiled with the same @option{-G @var{num}}
11724 value.
11725
11726 @item -membedded-data
11727 @itemx -mno-embedded-data
11728 @opindex membedded-data
11729 @opindex mno-embedded-data
11730 Allocate variables to the read-only data section first if possible, then
11731 next in the small data section if possible, otherwise in data.  This gives
11732 slightly slower code than the default, but reduces the amount of RAM required
11733 when executing, and thus may be preferred for some embedded systems.
11734
11735 @item -muninit-const-in-rodata
11736 @itemx -mno-uninit-const-in-rodata
11737 @opindex muninit-const-in-rodata
11738 @opindex mno-uninit-const-in-rodata
11739 Put uninitialized @code{const} variables in the read-only data section.
11740 This option is only meaningful in conjunction with @option{-membedded-data}.
11741
11742 @item -msplit-addresses
11743 @itemx -mno-split-addresses
11744 @opindex msplit-addresses
11745 @opindex mno-split-addresses
11746 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
11747 relocation operators.  This option has been superseded by
11748 @option{-mexplicit-relocs} but is retained for backwards compatibility.
11749
11750 @item -mexplicit-relocs
11751 @itemx -mno-explicit-relocs
11752 @opindex mexplicit-relocs
11753 @opindex mno-explicit-relocs
11754 Use (do not use) assembler relocation operators when dealing with symbolic
11755 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
11756 is to use assembler macros instead.
11757
11758 @option{-mexplicit-relocs} is the default if GCC was configured
11759 to use an assembler that supports relocation operators.
11760
11761 @item -mcheck-zero-division
11762 @itemx -mno-check-zero-division
11763 @opindex mcheck-zero-division
11764 @opindex mno-check-zero-division
11765 Trap (do not trap) on integer division by zero.
11766
11767 The default is @option{-mcheck-zero-division}.
11768
11769 @item -mdivide-traps
11770 @itemx -mdivide-breaks
11771 @opindex mdivide-traps
11772 @opindex mdivide-breaks
11773 MIPS systems check for division by zero by generating either a
11774 conditional trap or a break instruction.  Using traps results in
11775 smaller code, but is only supported on MIPS II and later.  Also, some
11776 versions of the Linux kernel have a bug that prevents trap from
11777 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
11778 allow conditional traps on architectures that support them and
11779 @option{-mdivide-breaks} to force the use of breaks.
11780
11781 The default is usually @option{-mdivide-traps}, but this can be
11782 overridden at configure time using @option{--with-divide=breaks}.
11783 Divide-by-zero checks can be completely disabled using
11784 @option{-mno-check-zero-division}.
11785
11786 @item -mmemcpy
11787 @itemx -mno-memcpy
11788 @opindex mmemcpy
11789 @opindex mno-memcpy
11790 Force (do not force) the use of @code{memcpy()} for non-trivial block
11791 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
11792 most constant-sized copies.
11793
11794 @item -mlong-calls
11795 @itemx -mno-long-calls
11796 @opindex mlong-calls
11797 @opindex mno-long-calls
11798 Disable (do not disable) use of the @code{jal} instruction.  Calling
11799 functions using @code{jal} is more efficient but requires the caller
11800 and callee to be in the same 256 megabyte segment.
11801
11802 This option has no effect on abicalls code.  The default is
11803 @option{-mno-long-calls}.
11804
11805 @item -mmad
11806 @itemx -mno-mad
11807 @opindex mmad
11808 @opindex mno-mad
11809 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
11810 instructions, as provided by the R4650 ISA@.
11811
11812 @item -mfused-madd
11813 @itemx -mno-fused-madd
11814 @opindex mfused-madd
11815 @opindex mno-fused-madd
11816 Enable (disable) use of the floating point multiply-accumulate
11817 instructions, when they are available.  The default is
11818 @option{-mfused-madd}.
11819
11820 When multiply-accumulate instructions are used, the intermediate
11821 product is calculated to infinite precision and is not subject to
11822 the FCSR Flush to Zero bit.  This may be undesirable in some
11823 circumstances.
11824
11825 @item -nocpp
11826 @opindex nocpp
11827 Tell the MIPS assembler to not run its preprocessor over user
11828 assembler files (with a @samp{.s} suffix) when assembling them.
11829
11830 @item -mfix-r4000
11831 @itemx -mno-fix-r4000
11832 @opindex mfix-r4000
11833 @opindex mno-fix-r4000
11834 Work around certain R4000 CPU errata:
11835 @itemize @minus
11836 @item
11837 A double-word or a variable shift may give an incorrect result if executed
11838 immediately after starting an integer division.
11839 @item
11840 A double-word or a variable shift may give an incorrect result if executed
11841 while an integer multiplication is in progress.
11842 @item
11843 An integer division may give an incorrect result if started in a delay slot
11844 of a taken branch or a jump.
11845 @end itemize
11846
11847 @item -mfix-r4400
11848 @itemx -mno-fix-r4400
11849 @opindex mfix-r4400
11850 @opindex mno-fix-r4400
11851 Work around certain R4400 CPU errata:
11852 @itemize @minus
11853 @item
11854 A double-word or a variable shift may give an incorrect result if executed
11855 immediately after starting an integer division.
11856 @end itemize
11857
11858 @item -mfix-vr4120
11859 @itemx -mno-fix-vr4120
11860 @opindex mfix-vr4120
11861 Work around certain VR4120 errata:
11862 @itemize @minus
11863 @item
11864 @code{dmultu} does not always produce the correct result.
11865 @item
11866 @code{div} and @code{ddiv} do not always produce the correct result if one
11867 of the operands is negative.
11868 @end itemize
11869 The workarounds for the division errata rely on special functions in
11870 @file{libgcc.a}.  At present, these functions are only provided by
11871 the @code{mips64vr*-elf} configurations.
11872
11873 Other VR4120 errata require a nop to be inserted between certain pairs of
11874 instructions.  These errata are handled by the assembler, not by GCC itself.
11875
11876 @item -mfix-vr4130
11877 @opindex mfix-vr4130
11878 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
11879 workarounds are implemented by the assembler rather than by GCC,
11880 although GCC will avoid using @code{mflo} and @code{mfhi} if the
11881 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
11882 instructions are available instead.
11883
11884 @item -mfix-sb1
11885 @itemx -mno-fix-sb1
11886 @opindex mfix-sb1
11887 Work around certain SB-1 CPU core errata.
11888 (This flag currently works around the SB-1 revision 2
11889 ``F1'' and ``F2'' floating point errata.)
11890
11891 @item -mflush-func=@var{func}
11892 @itemx -mno-flush-func
11893 @opindex mflush-func
11894 Specifies the function to call to flush the I and D caches, or to not
11895 call any such function.  If called, the function must take the same
11896 arguments as the common @code{_flush_func()}, that is, the address of the
11897 memory range for which the cache is being flushed, the size of the
11898 memory range, and the number 3 (to flush both caches).  The default
11899 depends on the target GCC was configured for, but commonly is either
11900 @samp{_flush_func} or @samp{__cpu_flush}.
11901
11902 @item -mbranch-likely
11903 @itemx -mno-branch-likely
11904 @opindex mbranch-likely
11905 @opindex mno-branch-likely
11906 Enable or disable use of Branch Likely instructions, regardless of the
11907 default for the selected architecture.  By default, Branch Likely
11908 instructions may be generated if they are supported by the selected
11909 architecture.  An exception is for the MIPS32 and MIPS64 architectures
11910 and processors which implement those architectures; for those, Branch
11911 Likely instructions will not be generated by default because the MIPS32
11912 and MIPS64 architectures specifically deprecate their use.
11913
11914 @item -mfp-exceptions
11915 @itemx -mno-fp-exceptions
11916 @opindex mfp-exceptions
11917 Specifies whether FP exceptions are enabled.  This affects how we schedule
11918 FP instructions for some processors.  The default is that FP exceptions are
11919 enabled.
11920
11921 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
11922 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
11923 FP pipe.
11924
11925 @item -mvr4130-align
11926 @itemx -mno-vr4130-align
11927 @opindex mvr4130-align
11928 The VR4130 pipeline is two-way superscalar, but can only issue two
11929 instructions together if the first one is 8-byte aligned.  When this
11930 option is enabled, GCC will align pairs of instructions that it
11931 thinks should execute in parallel.
11932
11933 This option only has an effect when optimizing for the VR4130.
11934 It normally makes code faster, but at the expense of making it bigger.
11935 It is enabled by default at optimization level @option{-O3}.
11936 @end table
11937
11938 @node MMIX Options
11939 @subsection MMIX Options
11940 @cindex MMIX Options
11941
11942 These options are defined for the MMIX:
11943
11944 @table @gcctabopt
11945 @item -mlibfuncs
11946 @itemx -mno-libfuncs
11947 @opindex mlibfuncs
11948 @opindex mno-libfuncs
11949 Specify that intrinsic library functions are being compiled, passing all
11950 values in registers, no matter the size.
11951
11952 @item -mepsilon
11953 @itemx -mno-epsilon
11954 @opindex mepsilon
11955 @opindex mno-epsilon
11956 Generate floating-point comparison instructions that compare with respect
11957 to the @code{rE} epsilon register.
11958
11959 @item -mabi=mmixware
11960 @itemx -mabi=gnu
11961 @opindex mabi-mmixware
11962 @opindex mabi=gnu
11963 Generate code that passes function parameters and return values that (in
11964 the called function) are seen as registers @code{$0} and up, as opposed to
11965 the GNU ABI which uses global registers @code{$231} and up.
11966
11967 @item -mzero-extend
11968 @itemx -mno-zero-extend
11969 @opindex mzero-extend
11970 @opindex mno-zero-extend
11971 When reading data from memory in sizes shorter than 64 bits, use (do not
11972 use) zero-extending load instructions by default, rather than
11973 sign-extending ones.
11974
11975 @item -mknuthdiv
11976 @itemx -mno-knuthdiv
11977 @opindex mknuthdiv
11978 @opindex mno-knuthdiv
11979 Make the result of a division yielding a remainder have the same sign as
11980 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
11981 remainder follows the sign of the dividend.  Both methods are
11982 arithmetically valid, the latter being almost exclusively used.
11983
11984 @item -mtoplevel-symbols
11985 @itemx -mno-toplevel-symbols
11986 @opindex mtoplevel-symbols
11987 @opindex mno-toplevel-symbols
11988 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11989 code can be used with the @code{PREFIX} assembly directive.
11990
11991 @item -melf
11992 @opindex melf
11993 Generate an executable in the ELF format, rather than the default
11994 @samp{mmo} format used by the @command{mmix} simulator.
11995
11996 @item -mbranch-predict
11997 @itemx -mno-branch-predict
11998 @opindex mbranch-predict
11999 @opindex mno-branch-predict
12000 Use (do not use) the probable-branch instructions, when static branch
12001 prediction indicates a probable branch.
12002
12003 @item -mbase-addresses
12004 @itemx -mno-base-addresses
12005 @opindex mbase-addresses
12006 @opindex mno-base-addresses
12007 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12008 base address automatically generates a request (handled by the assembler
12009 and the linker) for a constant to be set up in a global register.  The
12010 register is used for one or more base address requests within the range 0
12011 to 255 from the value held in the register.  The generally leads to short
12012 and fast code, but the number of different data items that can be
12013 addressed is limited.  This means that a program that uses lots of static
12014 data may require @option{-mno-base-addresses}.
12015
12016 @item -msingle-exit
12017 @itemx -mno-single-exit
12018 @opindex msingle-exit
12019 @opindex mno-single-exit
12020 Force (do not force) generated code to have a single exit point in each
12021 function.
12022 @end table
12023
12024 @node MN10300 Options
12025 @subsection MN10300 Options
12026 @cindex MN10300 options
12027
12028 These @option{-m} options are defined for Matsushita MN10300 architectures:
12029
12030 @table @gcctabopt
12031 @item -mmult-bug
12032 @opindex mmult-bug
12033 Generate code to avoid bugs in the multiply instructions for the MN10300
12034 processors.  This is the default.
12035
12036 @item -mno-mult-bug
12037 @opindex mno-mult-bug
12038 Do not generate code to avoid bugs in the multiply instructions for the
12039 MN10300 processors.
12040
12041 @item -mam33
12042 @opindex mam33
12043 Generate code which uses features specific to the AM33 processor.
12044
12045 @item -mno-am33
12046 @opindex mno-am33
12047 Do not generate code which uses features specific to the AM33 processor.  This
12048 is the default.
12049
12050 @item -mreturn-pointer-on-d0
12051 @opindex mreturn-pointer-on-d0
12052 When generating a function which returns a pointer, return the pointer
12053 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12054 only in a0, and attempts to call such functions without a prototype
12055 would result in errors.  Note that this option is on by default; use
12056 @option{-mno-return-pointer-on-d0} to disable it.
12057
12058 @item -mno-crt0
12059 @opindex mno-crt0
12060 Do not link in the C run-time initialization object file.
12061
12062 @item -mrelax
12063 @opindex mrelax
12064 Indicate to the linker that it should perform a relaxation optimization pass
12065 to shorten branches, calls and absolute memory addresses.  This option only
12066 has an effect when used on the command line for the final link step.
12067
12068 This option makes symbolic debugging impossible.
12069 @end table
12070
12071 @node MT Options
12072 @subsection MT Options
12073 @cindex MT options
12074
12075 These @option{-m} options are defined for Morpho MT architectures:
12076
12077 @table @gcctabopt
12078
12079 @item -march=@var{cpu-type}
12080 @opindex march
12081 Generate code that will run on @var{cpu-type}, which is the name of a system
12082 representing a certain processor type.  Possible values for
12083 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12084 @samp{ms1-16-003} and @samp{ms2}.
12085
12086 When this option is not used, the default is @option{-march=ms1-16-002}.
12087
12088 @item -mbacc
12089 @opindex mbacc
12090 Use byte loads and stores when generating code.
12091
12092 @item -mno-bacc
12093 @opindex mno-bacc
12094 Do not use byte loads and stores when generating code.
12095
12096 @item -msim
12097 @opindex msim
12098 Use simulator runtime
12099
12100 @item -mno-crt0
12101 @opindex mno-crt0
12102 Do not link in the C run-time initialization object file
12103 @file{crti.o}.  Other run-time initialization and termination files
12104 such as @file{startup.o} and @file{exit.o} are still included on the
12105 linker command line.
12106
12107 @end table
12108
12109 @node PDP-11 Options
12110 @subsection PDP-11 Options
12111 @cindex PDP-11 Options
12112
12113 These options are defined for the PDP-11:
12114
12115 @table @gcctabopt
12116 @item -mfpu
12117 @opindex mfpu
12118 Use hardware FPP floating point.  This is the default.  (FIS floating
12119 point on the PDP-11/40 is not supported.)
12120
12121 @item -msoft-float
12122 @opindex msoft-float
12123 Do not use hardware floating point.
12124
12125 @item -mac0
12126 @opindex mac0
12127 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12128
12129 @item -mno-ac0
12130 @opindex mno-ac0
12131 Return floating-point results in memory.  This is the default.
12132
12133 @item -m40
12134 @opindex m40
12135 Generate code for a PDP-11/40.
12136
12137 @item -m45
12138 @opindex m45
12139 Generate code for a PDP-11/45.  This is the default.
12140
12141 @item -m10
12142 @opindex m10
12143 Generate code for a PDP-11/10.
12144
12145 @item -mbcopy-builtin
12146 @opindex bcopy-builtin
12147 Use inline @code{movmemhi} patterns for copying memory.  This is the
12148 default.
12149
12150 @item -mbcopy
12151 @opindex mbcopy
12152 Do not use inline @code{movmemhi} patterns for copying memory.
12153
12154 @item -mint16
12155 @itemx -mno-int32
12156 @opindex mint16
12157 @opindex mno-int32
12158 Use 16-bit @code{int}.  This is the default.
12159
12160 @item -mint32
12161 @itemx -mno-int16
12162 @opindex mint32
12163 @opindex mno-int16
12164 Use 32-bit @code{int}.
12165
12166 @item -mfloat64
12167 @itemx -mno-float32
12168 @opindex mfloat64
12169 @opindex mno-float32
12170 Use 64-bit @code{float}.  This is the default.
12171
12172 @item -mfloat32
12173 @itemx -mno-float64
12174 @opindex mfloat32
12175 @opindex mno-float64
12176 Use 32-bit @code{float}.
12177
12178 @item -mabshi
12179 @opindex mabshi
12180 Use @code{abshi2} pattern.  This is the default.
12181
12182 @item -mno-abshi
12183 @opindex mno-abshi
12184 Do not use @code{abshi2} pattern.
12185
12186 @item -mbranch-expensive
12187 @opindex mbranch-expensive
12188 Pretend that branches are expensive.  This is for experimenting with
12189 code generation only.
12190
12191 @item -mbranch-cheap
12192 @opindex mbranch-cheap
12193 Do not pretend that branches are expensive.  This is the default.
12194
12195 @item -msplit
12196 @opindex msplit
12197 Generate code for a system with split I&D@.
12198
12199 @item -mno-split
12200 @opindex mno-split
12201 Generate code for a system without split I&D@.  This is the default.
12202
12203 @item -munix-asm
12204 @opindex munix-asm
12205 Use Unix assembler syntax.  This is the default when configured for
12206 @samp{pdp11-*-bsd}.
12207
12208 @item -mdec-asm
12209 @opindex mdec-asm
12210 Use DEC assembler syntax.  This is the default when configured for any
12211 PDP-11 target other than @samp{pdp11-*-bsd}.
12212 @end table
12213
12214 @node PowerPC Options
12215 @subsection PowerPC Options
12216 @cindex PowerPC options
12217
12218 These are listed under @xref{RS/6000 and PowerPC Options}.
12219
12220 @node RS/6000 and PowerPC Options
12221 @subsection IBM RS/6000 and PowerPC Options
12222 @cindex RS/6000 and PowerPC Options
12223 @cindex IBM RS/6000 and PowerPC Options
12224
12225 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12226 @table @gcctabopt
12227 @item -mpower
12228 @itemx -mno-power
12229 @itemx -mpower2
12230 @itemx -mno-power2
12231 @itemx -mpowerpc
12232 @itemx -mno-powerpc
12233 @itemx -mpowerpc-gpopt
12234 @itemx -mno-powerpc-gpopt
12235 @itemx -mpowerpc-gfxopt
12236 @itemx -mno-powerpc-gfxopt
12237 @itemx -mpowerpc64
12238 @itemx -mno-powerpc64
12239 @itemx -mmfcrf
12240 @itemx -mno-mfcrf
12241 @itemx -mpopcntb
12242 @itemx -mno-popcntb
12243 @itemx -mfprnd
12244 @itemx -mno-fprnd
12245 @itemx -mcmpb
12246 @itemx -mno-cmpb
12247 @itemx -mmfpgpr
12248 @itemx -mno-mfpgpr
12249 @itemx -mdfp
12250 @itemx -mno-dfp
12251 @opindex mpower
12252 @opindex mno-power
12253 @opindex mpower2
12254 @opindex mno-power2
12255 @opindex mpowerpc
12256 @opindex mno-powerpc
12257 @opindex mpowerpc-gpopt
12258 @opindex mno-powerpc-gpopt
12259 @opindex mpowerpc-gfxopt
12260 @opindex mno-powerpc-gfxopt
12261 @opindex mpowerpc64
12262 @opindex mno-powerpc64
12263 @opindex mmfcrf
12264 @opindex mno-mfcrf
12265 @opindex mpopcntb
12266 @opindex mno-popcntb
12267 @opindex mfprnd
12268 @opindex mno-fprnd
12269 @opindex mcmpb
12270 @opindex mno-cmpb
12271 @opindex mmfpgpr
12272 @opindex mno-mfpgpr
12273 @opindex mdfp
12274 @opindex mno-dfp
12275 GCC supports two related instruction set architectures for the
12276 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12277 instructions supported by the @samp{rios} chip set used in the original
12278 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12279 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12280 the IBM 4xx, 6xx, and follow-on microprocessors.
12281
12282 Neither architecture is a subset of the other.  However there is a
12283 large common subset of instructions supported by both.  An MQ
12284 register is included in processors supporting the POWER architecture.
12285
12286 You use these options to specify which instructions are available on the
12287 processor you are using.  The default value of these options is
12288 determined when configuring GCC@.  Specifying the
12289 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12290 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12291 rather than the options listed above.
12292
12293 The @option{-mpower} option allows GCC to generate instructions that
12294 are found only in the POWER architecture and to use the MQ register.
12295 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12296 to generate instructions that are present in the POWER2 architecture but
12297 not the original POWER architecture.
12298
12299 The @option{-mpowerpc} option allows GCC to generate instructions that
12300 are found only in the 32-bit subset of the PowerPC architecture.
12301 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12302 GCC to use the optional PowerPC architecture instructions in the
12303 General Purpose group, including floating-point square root.  Specifying
12304 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12305 use the optional PowerPC architecture instructions in the Graphics
12306 group, including floating-point select.
12307
12308 The @option{-mmfcrf} option allows GCC to generate the move from
12309 condition register field instruction implemented on the POWER4
12310 processor and other processors that support the PowerPC V2.01
12311 architecture.
12312 The @option{-mpopcntb} option allows GCC to generate the popcount and
12313 double precision FP reciprocal estimate instruction implemented on the
12314 POWER5 processor and other processors that support the PowerPC V2.02
12315 architecture.
12316 The @option{-mfprnd} option allows GCC to generate the FP round to
12317 integer instructions implemented on the POWER5+ processor and other
12318 processors that support the PowerPC V2.03 architecture.
12319 The @option{-mcmpb} option allows GCC to generate the compare bytes
12320 instruction implemented on the POWER6 processor and other processors
12321 that support the PowerPC V2.05 architecture.
12322 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12323 general purpose register instructions implemented on the POWER6X
12324 processor and other processors that support the extended PowerPC V2.05
12325 architecture.
12326 The @option{-mdfp} option allows GCC to generate the decimal floating
12327 point instructions implemented on some POWER processors.
12328
12329 The @option{-mpowerpc64} option allows GCC to generate the additional
12330 64-bit instructions that are found in the full PowerPC64 architecture
12331 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12332 @option{-mno-powerpc64}.
12333
12334 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12335 will use only the instructions in the common subset of both
12336 architectures plus some special AIX common-mode calls, and will not use
12337 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12338 permits GCC to use any instruction from either architecture and to
12339 allow use of the MQ register; specify this for the Motorola MPC601.
12340
12341 @item -mnew-mnemonics
12342 @itemx -mold-mnemonics
12343 @opindex mnew-mnemonics
12344 @opindex mold-mnemonics
12345 Select which mnemonics to use in the generated assembler code.  With
12346 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12347 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12348 assembler mnemonics defined for the POWER architecture.  Instructions
12349 defined in only one architecture have only one mnemonic; GCC uses that
12350 mnemonic irrespective of which of these options is specified.
12351
12352 GCC defaults to the mnemonics appropriate for the architecture in
12353 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12354 value of these option.  Unless you are building a cross-compiler, you
12355 should normally not specify either @option{-mnew-mnemonics} or
12356 @option{-mold-mnemonics}, but should instead accept the default.
12357
12358 @item -mcpu=@var{cpu_type}
12359 @opindex mcpu
12360 Set architecture type, register usage, choice of mnemonics, and
12361 instruction scheduling parameters for machine type @var{cpu_type}.
12362 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12363 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
12364 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12365 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12366 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12367 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
12368 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
12369 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
12370 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
12371 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
12372
12373 @option{-mcpu=common} selects a completely generic processor.  Code
12374 generated under this option will run on any POWER or PowerPC processor.
12375 GCC will use only the instructions in the common subset of both
12376 architectures, and will not use the MQ register.  GCC assumes a generic
12377 processor model for scheduling purposes.
12378
12379 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
12380 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
12381 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
12382 types, with an appropriate, generic processor model assumed for
12383 scheduling purposes.
12384
12385 The other options specify a specific processor.  Code generated under
12386 those options will run best on that processor, and may not run at all on
12387 others.
12388
12389 The @option{-mcpu} options automatically enable or disable the
12390 following options:
12391
12392 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
12393 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
12394 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
12395
12396 The particular options set for any particular CPU will vary between
12397 compiler versions, depending on what setting seems to produce optimal
12398 code for that CPU; it doesn't necessarily reflect the actual hardware's
12399 capabilities.  If you wish to set an individual option to a particular
12400 value, you may specify it after the @option{-mcpu} option, like
12401 @samp{-mcpu=970 -mno-altivec}.
12402
12403 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
12404 not enabled or disabled by the @option{-mcpu} option at present because
12405 AIX does not have full support for these options.  You may still
12406 enable or disable them individually if you're sure it'll work in your
12407 environment.
12408
12409 @item -mtune=@var{cpu_type}
12410 @opindex mtune
12411 Set the instruction scheduling parameters for machine type
12412 @var{cpu_type}, but do not set the architecture type, register usage, or
12413 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
12414 values for @var{cpu_type} are used for @option{-mtune} as for
12415 @option{-mcpu}.  If both are specified, the code generated will use the
12416 architecture, registers, and mnemonics set by @option{-mcpu}, but the
12417 scheduling parameters set by @option{-mtune}.
12418
12419 @item -mswdiv
12420 @itemx -mno-swdiv
12421 @opindex mswdiv
12422 @opindex mno-swdiv
12423 Generate code to compute division as reciprocal estimate and iterative
12424 refinement, creating opportunities for increased throughput.  This
12425 feature requires: optional PowerPC Graphics instruction set for single
12426 precision and FRE instruction for double precision, assuming divides
12427 cannot generate user-visible traps, and the domain values not include
12428 Infinities, denormals or zero denominator.
12429
12430 @item -maltivec
12431 @itemx -mno-altivec
12432 @opindex maltivec
12433 @opindex mno-altivec
12434 Generate code that uses (does not use) AltiVec instructions, and also
12435 enable the use of built-in functions that allow more direct access to
12436 the AltiVec instruction set.  You may also need to set
12437 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
12438 enhancements.
12439
12440 @item -mvrsave
12441 @item -mno-vrsave
12442 @opindex mvrsave
12443 @opindex mno-vrsave
12444 Generate VRSAVE instructions when generating AltiVec code.
12445
12446 @item -msecure-plt
12447 @opindex msecure-plt
12448 Generate code that allows ld and ld.so to build executables and shared
12449 libraries with non-exec .plt and .got sections.  This is a PowerPC
12450 32-bit SYSV ABI option.
12451
12452 @item -mbss-plt
12453 @opindex mbss-plt
12454 Generate code that uses a BSS .plt section that ld.so fills in, and
12455 requires .plt and .got sections that are both writable and executable.
12456 This is a PowerPC 32-bit SYSV ABI option.
12457
12458 @item -misel
12459 @itemx -mno-isel
12460 @opindex misel
12461 @opindex mno-isel
12462 This switch enables or disables the generation of ISEL instructions.
12463
12464 @item -misel=@var{yes/no}
12465 This switch has been deprecated.  Use @option{-misel} and
12466 @option{-mno-isel} instead.
12467
12468 @item -mspe
12469 @itemx -mno-spe
12470 @opindex mspe
12471 @opindex mno-spe
12472 This switch enables or disables the generation of SPE simd
12473 instructions.
12474
12475 @item -mspe=@var{yes/no}
12476 This option has been deprecated.  Use @option{-mspe} and
12477 @option{-mno-spe} instead.
12478
12479 @item -mfloat-gprs=@var{yes/single/double/no}
12480 @itemx -mfloat-gprs
12481 @opindex mfloat-gprs
12482 This switch enables or disables the generation of floating point
12483 operations on the general purpose registers for architectures that
12484 support it.
12485
12486 The argument @var{yes} or @var{single} enables the use of
12487 single-precision floating point operations.
12488
12489 The argument @var{double} enables the use of single and
12490 double-precision floating point operations.
12491
12492 The argument @var{no} disables floating point operations on the
12493 general purpose registers.
12494
12495 This option is currently only available on the MPC854x.
12496
12497 @item -m32
12498 @itemx -m64
12499 @opindex m32
12500 @opindex m64
12501 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
12502 targets (including GNU/Linux).  The 32-bit environment sets int, long
12503 and pointer to 32 bits and generates code that runs on any PowerPC
12504 variant.  The 64-bit environment sets int to 32 bits and long and
12505 pointer to 64 bits, and generates code for PowerPC64, as for
12506 @option{-mpowerpc64}.
12507
12508 @item -mfull-toc
12509 @itemx -mno-fp-in-toc
12510 @itemx -mno-sum-in-toc
12511 @itemx -mminimal-toc
12512 @opindex mfull-toc
12513 @opindex mno-fp-in-toc
12514 @opindex mno-sum-in-toc
12515 @opindex mminimal-toc
12516 Modify generation of the TOC (Table Of Contents), which is created for
12517 every executable file.  The @option{-mfull-toc} option is selected by
12518 default.  In that case, GCC will allocate at least one TOC entry for
12519 each unique non-automatic variable reference in your program.  GCC
12520 will also place floating-point constants in the TOC@.  However, only
12521 16,384 entries are available in the TOC@.
12522
12523 If you receive a linker error message that saying you have overflowed
12524 the available TOC space, you can reduce the amount of TOC space used
12525 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
12526 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
12527 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
12528 generate code to calculate the sum of an address and a constant at
12529 run-time instead of putting that sum into the TOC@.  You may specify one
12530 or both of these options.  Each causes GCC to produce very slightly
12531 slower and larger code at the expense of conserving TOC space.
12532
12533 If you still run out of space in the TOC even when you specify both of
12534 these options, specify @option{-mminimal-toc} instead.  This option causes
12535 GCC to make only one TOC entry for every file.  When you specify this
12536 option, GCC will produce code that is slower and larger but which
12537 uses extremely little TOC space.  You may wish to use this option
12538 only on files that contain less frequently executed code.
12539
12540 @item -maix64
12541 @itemx -maix32
12542 @opindex maix64
12543 @opindex maix32
12544 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
12545 @code{long} type, and the infrastructure needed to support them.
12546 Specifying @option{-maix64} implies @option{-mpowerpc64} and
12547 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
12548 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
12549
12550 @item -mxl-compat
12551 @itemx -mno-xl-compat
12552 @opindex mxl-compat
12553 @opindex mno-xl-compat
12554 Produce code that conforms more closely to IBM XL compiler semantics
12555 when using AIX-compatible ABI.  Pass floating-point arguments to
12556 prototyped functions beyond the register save area (RSA) on the stack
12557 in addition to argument FPRs.  Do not assume that most significant
12558 double in 128-bit long double value is properly rounded when comparing
12559 values and converting to double.  Use XL symbol names for long double
12560 support routines.
12561
12562 The AIX calling convention was extended but not initially documented to
12563 handle an obscure K&R C case of calling a function that takes the
12564 address of its arguments with fewer arguments than declared.  IBM XL
12565 compilers access floating point arguments which do not fit in the
12566 RSA from the stack when a subroutine is compiled without
12567 optimization.  Because always storing floating-point arguments on the
12568 stack is inefficient and rarely needed, this option is not enabled by
12569 default and only is necessary when calling subroutines compiled by IBM
12570 XL compilers without optimization.
12571
12572 @item -mpe
12573 @opindex mpe
12574 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
12575 application written to use message passing with special startup code to
12576 enable the application to run.  The system must have PE installed in the
12577 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
12578 must be overridden with the @option{-specs=} option to specify the
12579 appropriate directory location.  The Parallel Environment does not
12580 support threads, so the @option{-mpe} option and the @option{-pthread}
12581 option are incompatible.
12582
12583 @item -malign-natural
12584 @itemx -malign-power
12585 @opindex malign-natural
12586 @opindex malign-power
12587 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
12588 @option{-malign-natural} overrides the ABI-defined alignment of larger
12589 types, such as floating-point doubles, on their natural size-based boundary.
12590 The option @option{-malign-power} instructs GCC to follow the ABI-specified
12591 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
12592
12593 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
12594 is not supported.
12595
12596 @item -msoft-float
12597 @itemx -mhard-float
12598 @opindex msoft-float
12599 @opindex mhard-float
12600 Generate code that does not use (uses) the floating-point register set.
12601 Software floating point emulation is provided if you use the
12602 @option{-msoft-float} option, and pass the option to GCC when linking.
12603
12604 @item -mmultiple
12605 @itemx -mno-multiple
12606 @opindex mmultiple
12607 @opindex mno-multiple
12608 Generate code that uses (does not use) the load multiple word
12609 instructions and the store multiple word instructions.  These
12610 instructions are generated by default on POWER systems, and not
12611 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
12612 endian PowerPC systems, since those instructions do not work when the
12613 processor is in little endian mode.  The exceptions are PPC740 and
12614 PPC750 which permit the instructions usage in little endian mode.
12615
12616 @item -mstring
12617 @itemx -mno-string
12618 @opindex mstring
12619 @opindex mno-string
12620 Generate code that uses (does not use) the load string instructions
12621 and the store string word instructions to save multiple registers and
12622 do small block moves.  These instructions are generated by default on
12623 POWER systems, and not generated on PowerPC systems.  Do not use
12624 @option{-mstring} on little endian PowerPC systems, since those
12625 instructions do not work when the processor is in little endian mode.
12626 The exceptions are PPC740 and PPC750 which permit the instructions
12627 usage in little endian mode.
12628
12629 @item -mupdate
12630 @itemx -mno-update
12631 @opindex mupdate
12632 @opindex mno-update
12633 Generate code that uses (does not use) the load or store instructions
12634 that update the base register to the address of the calculated memory
12635 location.  These instructions are generated by default.  If you use
12636 @option{-mno-update}, there is a small window between the time that the
12637 stack pointer is updated and the address of the previous frame is
12638 stored, which means code that walks the stack frame across interrupts or
12639 signals may get corrupted data.
12640
12641 @item -mfused-madd
12642 @itemx -mno-fused-madd
12643 @opindex mfused-madd
12644 @opindex mno-fused-madd
12645 Generate code that uses (does not use) the floating point multiply and
12646 accumulate instructions.  These instructions are generated by default if
12647 hardware floating is used.
12648
12649 @item -mmulhw
12650 @itemx -mno-mulhw
12651 @opindex mmulhw
12652 @opindex mno-mulhw
12653 Generate code that uses (does not use) the half-word multiply and
12654 multiply-accumulate instructions on the IBM 405 and 440 processors.
12655 These instructions are generated by default when targetting those
12656 processors.
12657
12658 @item -mdlmzb
12659 @itemx -mno-dlmzb
12660 @opindex mdlmzb
12661 @opindex mno-dlmzb
12662 Generate code that uses (does not use) the string-search @samp{dlmzb}
12663 instruction on the IBM 405 and 440 processors.  This instruction is
12664 generated by default when targetting those processors.
12665
12666 @item -mno-bit-align
12667 @itemx -mbit-align
12668 @opindex mno-bit-align
12669 @opindex mbit-align
12670 On System V.4 and embedded PowerPC systems do not (do) force structures
12671 and unions that contain bit-fields to be aligned to the base type of the
12672 bit-field.
12673
12674 For example, by default a structure containing nothing but 8
12675 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
12676 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
12677 the structure would be aligned to a 1 byte boundary and be one byte in
12678 size.
12679
12680 @item -mno-strict-align
12681 @itemx -mstrict-align
12682 @opindex mno-strict-align
12683 @opindex mstrict-align
12684 On System V.4 and embedded PowerPC systems do not (do) assume that
12685 unaligned memory references will be handled by the system.
12686
12687 @item -mrelocatable
12688 @itemx -mno-relocatable
12689 @opindex mrelocatable
12690 @opindex mno-relocatable
12691 On embedded PowerPC systems generate code that allows (does not allow)
12692 the program to be relocated to a different address at runtime.  If you
12693 use @option{-mrelocatable} on any module, all objects linked together must
12694 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
12695
12696 @item -mrelocatable-lib
12697 @itemx -mno-relocatable-lib
12698 @opindex mrelocatable-lib
12699 @opindex mno-relocatable-lib
12700 On embedded PowerPC systems generate code that allows (does not allow)
12701 the program to be relocated to a different address at runtime.  Modules
12702 compiled with @option{-mrelocatable-lib} can be linked with either modules
12703 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
12704 with modules compiled with the @option{-mrelocatable} options.
12705
12706 @item -mno-toc
12707 @itemx -mtoc
12708 @opindex mno-toc
12709 @opindex mtoc
12710 On System V.4 and embedded PowerPC systems do not (do) assume that
12711 register 2 contains a pointer to a global area pointing to the addresses
12712 used in the program.
12713
12714 @item -mlittle
12715 @itemx -mlittle-endian
12716 @opindex mlittle
12717 @opindex mlittle-endian
12718 On System V.4 and embedded PowerPC systems compile code for the
12719 processor in little endian mode.  The @option{-mlittle-endian} option is
12720 the same as @option{-mlittle}.
12721
12722 @item -mbig
12723 @itemx -mbig-endian
12724 @opindex mbig
12725 @opindex mbig-endian
12726 On System V.4 and embedded PowerPC systems compile code for the
12727 processor in big endian mode.  The @option{-mbig-endian} option is
12728 the same as @option{-mbig}.
12729
12730 @item -mdynamic-no-pic
12731 @opindex mdynamic-no-pic
12732 On Darwin and Mac OS X systems, compile code so that it is not
12733 relocatable, but that its external references are relocatable.  The
12734 resulting code is suitable for applications, but not shared
12735 libraries.
12736
12737 @item -mprioritize-restricted-insns=@var{priority}
12738 @opindex mprioritize-restricted-insns
12739 This option controls the priority that is assigned to
12740 dispatch-slot restricted instructions during the second scheduling
12741 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
12742 @var{no/highest/second-highest} priority to dispatch slot restricted
12743 instructions.
12744
12745 @item -msched-costly-dep=@var{dependence_type}
12746 @opindex msched-costly-dep
12747 This option controls which dependences are considered costly
12748 by the target during instruction scheduling.  The argument
12749 @var{dependence_type} takes one of the following values:
12750 @var{no}: no dependence is costly,
12751 @var{all}: all dependences are costly,
12752 @var{true_store_to_load}: a true dependence from store to load is costly,
12753 @var{store_to_load}: any dependence from store to load is costly,
12754 @var{number}: any dependence which latency >= @var{number} is costly.
12755
12756 @item -minsert-sched-nops=@var{scheme}
12757 @opindex minsert-sched-nops
12758 This option controls which nop insertion scheme will be used during
12759 the second scheduling pass.  The argument @var{scheme} takes one of the
12760 following values:
12761 @var{no}: Don't insert nops.
12762 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
12763 according to the scheduler's grouping.
12764 @var{regroup_exact}: Insert nops to force costly dependent insns into
12765 separate groups.  Insert exactly as many nops as needed to force an insn
12766 to a new group, according to the estimated processor grouping.
12767 @var{number}: Insert nops to force costly dependent insns into
12768 separate groups.  Insert @var{number} nops to force an insn to a new group.
12769
12770 @item -mcall-sysv
12771 @opindex mcall-sysv
12772 On System V.4 and embedded PowerPC systems compile code using calling
12773 conventions that adheres to the March 1995 draft of the System V
12774 Application Binary Interface, PowerPC processor supplement.  This is the
12775 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
12776
12777 @item -mcall-sysv-eabi
12778 @opindex mcall-sysv-eabi
12779 Specify both @option{-mcall-sysv} and @option{-meabi} options.
12780
12781 @item -mcall-sysv-noeabi
12782 @opindex mcall-sysv-noeabi
12783 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
12784
12785 @item -mcall-solaris
12786 @opindex mcall-solaris
12787 On System V.4 and embedded PowerPC systems compile code for the Solaris
12788 operating system.
12789
12790 @item -mcall-linux
12791 @opindex mcall-linux
12792 On System V.4 and embedded PowerPC systems compile code for the
12793 Linux-based GNU system.
12794
12795 @item -mcall-gnu
12796 @opindex mcall-gnu
12797 On System V.4 and embedded PowerPC systems compile code for the
12798 Hurd-based GNU system.
12799
12800 @item -mcall-netbsd
12801 @opindex mcall-netbsd
12802 On System V.4 and embedded PowerPC systems compile code for the
12803 NetBSD operating system.
12804
12805 @item -maix-struct-return
12806 @opindex maix-struct-return
12807 Return all structures in memory (as specified by the AIX ABI)@.
12808
12809 @item -msvr4-struct-return
12810 @opindex msvr4-struct-return
12811 Return structures smaller than 8 bytes in registers (as specified by the
12812 SVR4 ABI)@.
12813
12814 @item -mabi=@var{abi-type}
12815 @opindex mabi
12816 Extend the current ABI with a particular extension, or remove such extension.
12817 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
12818 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
12819
12820 @item -mabi=spe
12821 @opindex mabi=spe
12822 Extend the current ABI with SPE ABI extensions.  This does not change
12823 the default ABI, instead it adds the SPE ABI extensions to the current
12824 ABI@.
12825
12826 @item -mabi=no-spe
12827 @opindex mabi=no-spe
12828 Disable Booke SPE ABI extensions for the current ABI@.
12829
12830 @item -mabi=ibmlongdouble
12831 @opindex mabi=ibmlongdouble
12832 Change the current ABI to use IBM extended precision long double.
12833 This is a PowerPC 32-bit SYSV ABI option.
12834
12835 @item -mabi=ieeelongdouble
12836 @opindex mabi=ieeelongdouble
12837 Change the current ABI to use IEEE extended precision long double.
12838 This is a PowerPC 32-bit Linux ABI option.
12839
12840 @item -mprototype
12841 @itemx -mno-prototype
12842 @opindex mprototype
12843 @opindex mno-prototype
12844 On System V.4 and embedded PowerPC systems assume that all calls to
12845 variable argument functions are properly prototyped.  Otherwise, the
12846 compiler must insert an instruction before every non prototyped call to
12847 set or clear bit 6 of the condition code register (@var{CR}) to
12848 indicate whether floating point values were passed in the floating point
12849 registers in case the function takes a variable arguments.  With
12850 @option{-mprototype}, only calls to prototyped variable argument functions
12851 will set or clear the bit.
12852
12853 @item -msim
12854 @opindex msim
12855 On embedded PowerPC systems, assume that the startup module is called
12856 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
12857 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
12858 configurations.
12859
12860 @item -mmvme
12861 @opindex mmvme
12862 On embedded PowerPC systems, assume that the startup module is called
12863 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
12864 @file{libc.a}.
12865
12866 @item -mads
12867 @opindex mads
12868 On embedded PowerPC systems, assume that the startup module is called
12869 @file{crt0.o} and the standard C libraries are @file{libads.a} and
12870 @file{libc.a}.
12871
12872 @item -myellowknife
12873 @opindex myellowknife
12874 On embedded PowerPC systems, assume that the startup module is called
12875 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
12876 @file{libc.a}.
12877
12878 @item -mvxworks
12879 @opindex mvxworks
12880 On System V.4 and embedded PowerPC systems, specify that you are
12881 compiling for a VxWorks system.
12882
12883 @item -mwindiss
12884 @opindex mwindiss
12885 Specify that you are compiling for the WindISS simulation environment.
12886
12887 @item -memb
12888 @opindex memb
12889 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
12890 header to indicate that @samp{eabi} extended relocations are used.
12891
12892 @item -meabi
12893 @itemx -mno-eabi
12894 @opindex meabi
12895 @opindex mno-eabi
12896 On System V.4 and embedded PowerPC systems do (do not) adhere to the
12897 Embedded Applications Binary Interface (eabi) which is a set of
12898 modifications to the System V.4 specifications.  Selecting @option{-meabi}
12899 means that the stack is aligned to an 8 byte boundary, a function
12900 @code{__eabi} is called to from @code{main} to set up the eabi
12901 environment, and the @option{-msdata} option can use both @code{r2} and
12902 @code{r13} to point to two separate small data areas.  Selecting
12903 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
12904 do not call an initialization function from @code{main}, and the
12905 @option{-msdata} option will only use @code{r13} to point to a single
12906 small data area.  The @option{-meabi} option is on by default if you
12907 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
12908
12909 @item -msdata=eabi
12910 @opindex msdata=eabi
12911 On System V.4 and embedded PowerPC systems, put small initialized
12912 @code{const} global and static data in the @samp{.sdata2} section, which
12913 is pointed to by register @code{r2}.  Put small initialized
12914 non-@code{const} global and static data in the @samp{.sdata} section,
12915 which is pointed to by register @code{r13}.  Put small uninitialized
12916 global and static data in the @samp{.sbss} section, which is adjacent to
12917 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
12918 incompatible with the @option{-mrelocatable} option.  The
12919 @option{-msdata=eabi} option also sets the @option{-memb} option.
12920
12921 @item -msdata=sysv
12922 @opindex msdata=sysv
12923 On System V.4 and embedded PowerPC systems, put small global and static
12924 data in the @samp{.sdata} section, which is pointed to by register
12925 @code{r13}.  Put small uninitialized global and static data in the
12926 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12927 The @option{-msdata=sysv} option is incompatible with the
12928 @option{-mrelocatable} option.
12929
12930 @item -msdata=default
12931 @itemx -msdata
12932 @opindex msdata=default
12933 @opindex msdata
12934 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12935 compile code the same as @option{-msdata=eabi}, otherwise compile code the
12936 same as @option{-msdata=sysv}.
12937
12938 @item -msdata-data
12939 @opindex msdata-data
12940 On System V.4 and embedded PowerPC systems, put small global
12941 data in the @samp{.sdata} section.  Put small uninitialized global
12942 data in the @samp{.sbss} section.  Do not use register @code{r13}
12943 to address small data however.  This is the default behavior unless
12944 other @option{-msdata} options are used.
12945
12946 @item -msdata=none
12947 @itemx -mno-sdata
12948 @opindex msdata=none
12949 @opindex mno-sdata
12950 On embedded PowerPC systems, put all initialized global and static data
12951 in the @samp{.data} section, and all uninitialized data in the
12952 @samp{.bss} section.
12953
12954 @item -G @var{num}
12955 @opindex G
12956 @cindex smaller data references (PowerPC)
12957 @cindex .sdata/.sdata2 references (PowerPC)
12958 On embedded PowerPC systems, put global and static items less than or
12959 equal to @var{num} bytes into the small data or bss sections instead of
12960 the normal data or bss section.  By default, @var{num} is 8.  The
12961 @option{-G @var{num}} switch is also passed to the linker.
12962 All modules should be compiled with the same @option{-G @var{num}} value.
12963
12964 @item -mregnames
12965 @itemx -mno-regnames
12966 @opindex mregnames
12967 @opindex mno-regnames
12968 On System V.4 and embedded PowerPC systems do (do not) emit register
12969 names in the assembly language output using symbolic forms.
12970
12971 @item -mlongcall
12972 @itemx -mno-longcall
12973 @opindex mlongcall
12974 @opindex mno-longcall
12975 By default assume that all calls are far away so that a longer more
12976 expensive calling sequence is required.  This is required for calls
12977 further than 32 megabytes (33,554,432 bytes) from the current location.
12978 A short call will be generated if the compiler knows
12979 the call cannot be that far away.  This setting can be overridden by
12980 the @code{shortcall} function attribute, or by @code{#pragma
12981 longcall(0)}.
12982
12983 Some linkers are capable of detecting out-of-range calls and generating
12984 glue code on the fly.  On these systems, long calls are unnecessary and
12985 generate slower code.  As of this writing, the AIX linker can do this,
12986 as can the GNU linker for PowerPC/64.  It is planned to add this feature
12987 to the GNU linker for 32-bit PowerPC systems as well.
12988
12989 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12990 callee, L42'', plus a ``branch island'' (glue code).  The two target
12991 addresses represent the callee and the ``branch island''.  The
12992 Darwin/PPC linker will prefer the first address and generate a ``bl
12993 callee'' if the PPC ``bl'' instruction will reach the callee directly;
12994 otherwise, the linker will generate ``bl L42'' to call the ``branch
12995 island''.  The ``branch island'' is appended to the body of the
12996 calling function; it computes the full 32-bit address of the callee
12997 and jumps to it.
12998
12999 On Mach-O (Darwin) systems, this option directs the compiler emit to
13000 the glue for every direct call, and the Darwin linker decides whether
13001 to use or discard it.
13002
13003 In the future, we may cause GCC to ignore all longcall specifications
13004 when the linker is known to generate glue.
13005
13006 @item -pthread
13007 @opindex pthread
13008 Adds support for multithreading with the @dfn{pthreads} library.
13009 This option sets flags for both the preprocessor and linker.
13010
13011 @end table
13012
13013 @node S/390 and zSeries Options
13014 @subsection S/390 and zSeries Options
13015 @cindex S/390 and zSeries Options
13016
13017 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13018
13019 @table @gcctabopt
13020 @item -mhard-float
13021 @itemx -msoft-float
13022 @opindex mhard-float
13023 @opindex msoft-float
13024 Use (do not use) the hardware floating-point instructions and registers
13025 for floating-point operations.  When @option{-msoft-float} is specified,
13026 functions in @file{libgcc.a} will be used to perform floating-point
13027 operations.  When @option{-mhard-float} is specified, the compiler
13028 generates IEEE floating-point instructions.  This is the default.
13029
13030 @item -mlong-double-64
13031 @itemx -mlong-double-128
13032 @opindex mlong-double-64
13033 @opindex mlong-double-128
13034 These switches control the size of @code{long double} type. A size
13035 of 64bit makes the @code{long double} type equivalent to the @code{double}
13036 type. This is the default.
13037
13038 @item -mbackchain
13039 @itemx -mno-backchain
13040 @opindex mbackchain
13041 @opindex mno-backchain
13042 Store (do not store) the address of the caller's frame as backchain pointer
13043 into the callee's stack frame.
13044 A backchain may be needed to allow debugging using tools that do not understand
13045 DWARF-2 call frame information.
13046 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13047 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13048 the backchain is placed into the topmost word of the 96/160 byte register
13049 save area.
13050
13051 In general, code compiled with @option{-mbackchain} is call-compatible with
13052 code compiled with @option{-mmo-backchain}; however, use of the backchain
13053 for debugging purposes usually requires that the whole binary is built with
13054 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13055 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13056 to build a linux kernel use @option{-msoft-float}.
13057
13058 The default is to not maintain the backchain.
13059
13060 @item -mpacked-stack
13061 @item -mno-packed-stack
13062 @opindex mpacked-stack
13063 @opindex mno-packed-stack
13064 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13065 specified, the compiler uses the all fields of the 96/160 byte register save
13066 area only for their default purpose; unused fields still take up stack space.
13067 When @option{-mpacked-stack} is specified, register save slots are densely
13068 packed at the top of the register save area; unused space is reused for other
13069 purposes, allowing for more efficient use of the available stack space.
13070 However, when @option{-mbackchain} is also in effect, the topmost word of
13071 the save area is always used to store the backchain, and the return address
13072 register is always saved two words below the backchain.
13073
13074 As long as the stack frame backchain is not used, code generated with
13075 @option{-mpacked-stack} is call-compatible with code generated with
13076 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13077 S/390 or zSeries generated code that uses the stack frame backchain at run
13078 time, not just for debugging purposes.  Such code is not call-compatible
13079 with code compiled with @option{-mpacked-stack}.  Also, note that the
13080 combination of @option{-mbackchain},
13081 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13082 to build a linux kernel use @option{-msoft-float}.
13083
13084 The default is to not use the packed stack layout.
13085
13086 @item -msmall-exec
13087 @itemx -mno-small-exec
13088 @opindex msmall-exec
13089 @opindex mno-small-exec
13090 Generate (or do not generate) code using the @code{bras} instruction
13091 to do subroutine calls.
13092 This only works reliably if the total executable size does not
13093 exceed 64k.  The default is to use the @code{basr} instruction instead,
13094 which does not have this limitation.
13095
13096 @item -m64
13097 @itemx -m31
13098 @opindex m64
13099 @opindex m31
13100 When @option{-m31} is specified, generate code compliant to the
13101 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13102 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13103 particular to generate 64-bit instructions.  For the @samp{s390}
13104 targets, the default is @option{-m31}, while the @samp{s390x}
13105 targets default to @option{-m64}.
13106
13107 @item -mzarch
13108 @itemx -mesa
13109 @opindex mzarch
13110 @opindex mesa
13111 When @option{-mzarch} is specified, generate code using the
13112 instructions available on z/Architecture.
13113 When @option{-mesa} is specified, generate code using the
13114 instructions available on ESA/390.  Note that @option{-mesa} is
13115 not possible with @option{-m64}.
13116 When generating code compliant to the GNU/Linux for S/390 ABI,
13117 the default is @option{-mesa}.  When generating code compliant
13118 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13119
13120 @item -mmvcle
13121 @itemx -mno-mvcle
13122 @opindex mmvcle
13123 @opindex mno-mvcle
13124 Generate (or do not generate) code using the @code{mvcle} instruction
13125 to perform block moves.  When @option{-mno-mvcle} is specified,
13126 use a @code{mvc} loop instead.  This is the default unless optimizing for
13127 size.
13128
13129 @item -mdebug
13130 @itemx -mno-debug
13131 @opindex mdebug
13132 @opindex mno-debug
13133 Print (or do not print) additional debug information when compiling.
13134 The default is to not print debug information.
13135
13136 @item -march=@var{cpu-type}
13137 @opindex march
13138 Generate code that will run on @var{cpu-type}, which is the name of a system
13139 representing a certain processor type.  Possible values for
13140 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13141 When generating code using the instructions available on z/Architecture,
13142 the default is @option{-march=z900}.  Otherwise, the default is
13143 @option{-march=g5}.
13144
13145 @item -mtune=@var{cpu-type}
13146 @opindex mtune
13147 Tune to @var{cpu-type} everything applicable about the generated code,
13148 except for the ABI and the set of available instructions.
13149 The list of @var{cpu-type} values is the same as for @option{-march}.
13150 The default is the value used for @option{-march}.
13151
13152 @item -mtpf-trace
13153 @itemx -mno-tpf-trace
13154 @opindex mtpf-trace
13155 @opindex mno-tpf-trace
13156 Generate code that adds (does not add) in TPF OS specific branches to trace
13157 routines in the operating system.  This option is off by default, even
13158 when compiling for the TPF OS@.
13159
13160 @item -mfused-madd
13161 @itemx -mno-fused-madd
13162 @opindex mfused-madd
13163 @opindex mno-fused-madd
13164 Generate code that uses (does not use) the floating point multiply and
13165 accumulate instructions.  These instructions are generated by default if
13166 hardware floating point is used.
13167
13168 @item -mwarn-framesize=@var{framesize}
13169 @opindex mwarn-framesize
13170 Emit a warning if the current function exceeds the given frame size.  Because
13171 this is a compile time check it doesn't need to be a real problem when the program
13172 runs.  It is intended to identify functions which most probably cause
13173 a stack overflow.  It is useful to be used in an environment with limited stack
13174 size e.g.@: the linux kernel.
13175
13176 @item -mwarn-dynamicstack
13177 @opindex mwarn-dynamicstack
13178 Emit a warning if the function calls alloca or uses dynamically
13179 sized arrays.  This is generally a bad idea with a limited stack size.
13180
13181 @item -mstack-guard=@var{stack-guard}
13182 @item -mstack-size=@var{stack-size}
13183 @opindex mstack-guard
13184 @opindex mstack-size
13185 If these options are provided the s390 back end emits additional instructions in
13186 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13187 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13188 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13189 the frame size of the compiled function is chosen.
13190 These options are intended to be used to help debugging stack overflow problems.
13191 The additionally emitted code causes only little overhead and hence can also be
13192 used in production like systems without greater performance degradation.  The given
13193 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13194 @var{stack-guard} without exceeding 64k.
13195 In order to be efficient the extra code makes the assumption that the stack starts
13196 at an address aligned to the value given by @var{stack-size}.
13197 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13198 @end table
13199
13200 @node Score Options
13201 @subsection Score Options
13202 @cindex Score Options
13203
13204 These options are defined for Score implementations:
13205
13206 @table @gcctabopt
13207 @item -meb
13208 @opindex meb
13209 Compile code for big endian mode.  This is the default.
13210
13211 @item -mel
13212 @opindex mel
13213 Compile code for little endian mode. 
13214
13215 @item -mnhwloop
13216 @opindex mnhwloop
13217 Disable generate bcnz instruction.
13218
13219 @item -muls
13220 @opindex muls
13221 Enable generate unaligned load and store instruction.
13222
13223 @item -mmac
13224 @opindex mmac
13225 Enable the use of multiply-accumulate instructions. Disabled by default. 
13226
13227 @item -mscore5
13228 @opindex mscore5
13229 Specify the SCORE5 as the target architecture.
13230
13231 @item -mscore5u
13232 @opindex mscore5u
13233 Specify the SCORE5U of the target architecture.
13234
13235 @item -mscore7
13236 @opindex mscore7
13237 Specify the SCORE7 as the target architecture. This is the default.
13238
13239 @item -mscore7d
13240 @opindex mscore7d
13241 Specify the SCORE7D as the target architecture.
13242 @end table
13243
13244 @node SH Options
13245 @subsection SH Options
13246
13247 These @samp{-m} options are defined for the SH implementations:
13248
13249 @table @gcctabopt
13250 @item -m1
13251 @opindex m1
13252 Generate code for the SH1.
13253
13254 @item -m2
13255 @opindex m2
13256 Generate code for the SH2.
13257
13258 @item -m2e
13259 Generate code for the SH2e.
13260
13261 @item -m3
13262 @opindex m3
13263 Generate code for the SH3.
13264
13265 @item -m3e
13266 @opindex m3e
13267 Generate code for the SH3e.
13268
13269 @item -m4-nofpu
13270 @opindex m4-nofpu
13271 Generate code for the SH4 without a floating-point unit.
13272
13273 @item -m4-single-only
13274 @opindex m4-single-only
13275 Generate code for the SH4 with a floating-point unit that only
13276 supports single-precision arithmetic.
13277
13278 @item -m4-single
13279 @opindex m4-single
13280 Generate code for the SH4 assuming the floating-point unit is in
13281 single-precision mode by default.
13282
13283 @item -m4
13284 @opindex m4
13285 Generate code for the SH4.
13286
13287 @item -m4a-nofpu
13288 @opindex m4a-nofpu
13289 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13290 floating-point unit is not used.
13291
13292 @item -m4a-single-only
13293 @opindex m4a-single-only
13294 Generate code for the SH4a, in such a way that no double-precision
13295 floating point operations are used.
13296
13297 @item -m4a-single
13298 @opindex m4a-single
13299 Generate code for the SH4a assuming the floating-point unit is in
13300 single-precision mode by default.
13301
13302 @item -m4a
13303 @opindex m4a
13304 Generate code for the SH4a.
13305
13306 @item -m4al
13307 @opindex m4al
13308 Same as @option{-m4a-nofpu}, except that it implicitly passes
13309 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13310 instructions at the moment.
13311
13312 @item -mb
13313 @opindex mb
13314 Compile code for the processor in big endian mode.
13315
13316 @item -ml
13317 @opindex ml
13318 Compile code for the processor in little endian mode.
13319
13320 @item -mdalign
13321 @opindex mdalign
13322 Align doubles at 64-bit boundaries.  Note that this changes the calling
13323 conventions, and thus some functions from the standard C library will
13324 not work unless you recompile it first with @option{-mdalign}.
13325
13326 @item -mrelax
13327 @opindex mrelax
13328 Shorten some address references at link time, when possible; uses the
13329 linker option @option{-relax}.
13330
13331 @item -mbigtable
13332 @opindex mbigtable
13333 Use 32-bit offsets in @code{switch} tables.  The default is to use
13334 16-bit offsets.
13335
13336 @item -mfmovd
13337 @opindex mfmovd
13338 Enable the use of the instruction @code{fmovd}.
13339
13340 @item -mhitachi
13341 @opindex mhitachi
13342 Comply with the calling conventions defined by Renesas.
13343
13344 @item -mrenesas
13345 @opindex mhitachi
13346 Comply with the calling conventions defined by Renesas.
13347
13348 @item -mno-renesas
13349 @opindex mhitachi
13350 Comply with the calling conventions defined for GCC before the Renesas
13351 conventions were available.  This option is the default for all
13352 targets of the SH toolchain except for @samp{sh-symbianelf}.
13353
13354 @item -mnomacsave
13355 @opindex mnomacsave
13356 Mark the @code{MAC} register as call-clobbered, even if
13357 @option{-mhitachi} is given.
13358
13359 @item -mieee
13360 @opindex mieee
13361 Increase IEEE-compliance of floating-point code.
13362 At the moment, this is equivalent to @option{-fno-finite-math-only}.
13363 When generating 16 bit SH opcodes, getting IEEE-conforming results for
13364 comparisons of NANs / infinities incurs extra overhead in every
13365 floating point comparison, therefore the default is set to
13366 @option{-ffinite-math-only}.
13367
13368 @item -minline-ic_invalidate
13369 @opindex minline-ic_invalidate
13370 Inline code to invalidate instruction cache entries after setting up
13371 nested function trampolines.
13372 This option has no effect if -musermode is in effect and the selected
13373 code generation option (e.g. -m4) does not allow the use of the icbi
13374 instruction.
13375 If the selected code generation option does not allow the use of the icbi
13376 instruction, and -musermode is not in effect, the inlined code will
13377 manipulate the instruction cache address array directly with an associative
13378 write.  This not only requires privileged mode, but it will also
13379 fail if the cache line had been mapped via the TLB and has become unmapped.
13380
13381 @item -misize
13382 @opindex misize
13383 Dump instruction size and location in the assembly code.
13384
13385 @item -mpadstruct
13386 @opindex mpadstruct
13387 This option is deprecated.  It pads structures to multiple of 4 bytes,
13388 which is incompatible with the SH ABI@.
13389
13390 @item -mspace
13391 @opindex mspace
13392 Optimize for space instead of speed.  Implied by @option{-Os}.
13393
13394 @item -mprefergot
13395 @opindex mprefergot
13396 When generating position-independent code, emit function calls using
13397 the Global Offset Table instead of the Procedure Linkage Table.
13398
13399 @item -musermode
13400 @opindex musermode
13401 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
13402 if the inlined code would not work in user mode.
13403 This is the default when the target is @code{sh-*-linux*}.
13404
13405 @item -multcost=@var{number}
13406 @opindex multcost=@var{number}
13407 Set the cost to assume for a multiply insn.
13408
13409 @item -mdiv=@var{strategy}
13410 @opindex mdiv=@var{strategy}
13411 Set the division strategy to use for SHmedia code.  @var{strategy} must be
13412 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
13413 inv:call2, inv:fp .
13414 "fp" performs the operation in floating point.  This has a very high latency,
13415 but needs only a few instructions, so it might be a good choice if
13416 your code has enough easily exploitable ILP to allow the compiler to
13417 schedule the floating point instructions together with other instructions.
13418 Division by zero causes a floating point exception.
13419 "inv" uses integer operations to calculate the inverse of the divisor,
13420 and then multiplies the dividend with the inverse.  This strategy allows
13421 cse and hoisting of the inverse calculation.  Division by zero calculates
13422 an unspecified result, but does not trap.
13423 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
13424 have been found, or if the entire operation has been hoisted to the same
13425 place, the last stages of the inverse calculation are intertwined with the
13426 final multiply to reduce the overall latency, at the expense of using a few
13427 more instructions, and thus offering fewer scheduling opportunities with
13428 other code.
13429 "call" calls a library function that usually implements the inv:minlat
13430 strategy.
13431 This gives high code density for m5-*media-nofpu compilations.
13432 "call2" uses a different entry point of the same library function, where it
13433 assumes that a pointer to a lookup table has already been set up, which
13434 exposes the pointer load to cse / code hoisting optimizations.
13435 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
13436 code generation, but if the code stays unoptimized, revert to the "call",
13437 "call2", or "fp" strategies, respectively.  Note that the
13438 potentially-trapping side effect of division by zero is carried by a
13439 separate instruction, so it is possible that all the integer instructions
13440 are hoisted out, but the marker for the side effect stays where it is.
13441 A recombination to fp operations or a call is not possible in that case.
13442 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
13443 that the inverse calculation was nor separated from the multiply, they speed
13444 up division where the dividend fits into 20 bits (plus sign where applicable),
13445 by inserting a test to skip a number of operations in this case; this test
13446 slows down the case of larger dividends.  inv20u assumes the case of a such
13447 a small dividend to be unlikely, and inv20l assumes it to be likely.
13448
13449 @item -mdivsi3_libfunc=@var{name}
13450 @opindex mdivsi3_libfunc=@var{name}
13451 Set the name of the library function used for 32 bit signed division to
13452 @var{name}.  This only affect the name used in the call and inv:call
13453 division strategies, and the compiler will still expect the same
13454 sets of input/output/clobbered registers as if this option was not present.
13455
13456 @item -madjust-unroll
13457 @opindex madjust-unroll
13458 Throttle unrolling to avoid thrashing target registers.
13459 This option only has an effect if the gcc code base supports the
13460 TARGET_ADJUST_UNROLL_MAX target hook.
13461
13462 @item -mindexed-addressing
13463 @opindex mindexed-addressing
13464 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
13465 This is only safe if the hardware and/or OS implement 32 bit wrap-around
13466 semantics for the indexed addressing mode.  The architecture allows the
13467 implementation of processors with 64 bit MMU, which the OS could use to
13468 get 32 bit addressing, but since no current hardware implementation supports
13469 this or any other way to make the indexed addressing mode safe to use in
13470 the 32 bit ABI, the default is -mno-indexed-addressing.
13471
13472 @item -mgettrcost=@var{number}
13473 @opindex mgettrcost=@var{number}
13474 Set the cost assumed for the gettr instruction to @var{number}.
13475 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
13476
13477 @item -mpt-fixed
13478 @opindex mpt-fixed
13479 Assume pt* instructions won't trap.  This will generally generate better
13480 scheduled code, but is unsafe on current hardware.  The current architecture
13481 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
13482 This has the unintentional effect of making it unsafe to schedule ptabs /
13483 ptrel before a branch, or hoist it out of a loop.  For example,
13484 __do_global_ctors, a part of libgcc that runs constructors at program
13485 startup, calls functions in a list which is delimited by @minus{}1.  With the
13486 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
13487 That means that all the constructors will be run a bit quicker, but when
13488 the loop comes to the end of the list, the program crashes because ptabs
13489 loads @minus{}1 into a target register.  Since this option is unsafe for any
13490 hardware implementing the current architecture specification, the default
13491 is -mno-pt-fixed.  Unless the user specifies a specific cost with
13492 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
13493 this deters register allocation using target registers for storing
13494 ordinary integers.
13495
13496 @item -minvalid-symbols
13497 @opindex minvalid-symbols
13498 Assume symbols might be invalid.  Ordinary function symbols generated by
13499 the compiler will always be valid to load with movi/shori/ptabs or
13500 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
13501 to generate symbols that will cause ptabs / ptrel to trap.
13502 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
13503 It will then prevent cross-basic-block cse, hoisting and most scheduling
13504 of symbol loads.  The default is @option{-mno-invalid-symbols}.
13505 @end table
13506
13507 @node SPARC Options
13508 @subsection SPARC Options
13509 @cindex SPARC options
13510
13511 These @samp{-m} options are supported on the SPARC:
13512
13513 @table @gcctabopt
13514 @item -mno-app-regs
13515 @itemx -mapp-regs
13516 @opindex mno-app-regs
13517 @opindex mapp-regs
13518 Specify @option{-mapp-regs} to generate output using the global registers
13519 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
13520 is the default.
13521
13522 To be fully SVR4 ABI compliant at the cost of some performance loss,
13523 specify @option{-mno-app-regs}.  You should compile libraries and system
13524 software with this option.
13525
13526 @item -mfpu
13527 @itemx -mhard-float
13528 @opindex mfpu
13529 @opindex mhard-float
13530 Generate output containing floating point instructions.  This is the
13531 default.
13532
13533 @item -mno-fpu
13534 @itemx -msoft-float
13535 @opindex mno-fpu
13536 @opindex msoft-float
13537 Generate output containing library calls for floating point.
13538 @strong{Warning:} the requisite libraries are not available for all SPARC
13539 targets.  Normally the facilities of the machine's usual C compiler are
13540 used, but this cannot be done directly in cross-compilation.  You must make
13541 your own arrangements to provide suitable library functions for
13542 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
13543 @samp{sparclite-*-*} do provide software floating point support.
13544
13545 @option{-msoft-float} changes the calling convention in the output file;
13546 therefore, it is only useful if you compile @emph{all} of a program with
13547 this option.  In particular, you need to compile @file{libgcc.a}, the
13548 library that comes with GCC, with @option{-msoft-float} in order for
13549 this to work.
13550
13551 @item -mhard-quad-float
13552 @opindex mhard-quad-float
13553 Generate output containing quad-word (long double) floating point
13554 instructions.
13555
13556 @item -msoft-quad-float
13557 @opindex msoft-quad-float
13558 Generate output containing library calls for quad-word (long double)
13559 floating point instructions.  The functions called are those specified
13560 in the SPARC ABI@.  This is the default.
13561
13562 As of this writing, there are no SPARC implementations that have hardware
13563 support for the quad-word floating point instructions.  They all invoke
13564 a trap handler for one of these instructions, and then the trap handler
13565 emulates the effect of the instruction.  Because of the trap handler overhead,
13566 this is much slower than calling the ABI library routines.  Thus the
13567 @option{-msoft-quad-float} option is the default.
13568
13569 @item -mno-unaligned-doubles
13570 @itemx -munaligned-doubles
13571 @opindex mno-unaligned-doubles
13572 @opindex munaligned-doubles
13573 Assume that doubles have 8 byte alignment.  This is the default.
13574
13575 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
13576 alignment only if they are contained in another type, or if they have an
13577 absolute address.  Otherwise, it assumes they have 4 byte alignment.
13578 Specifying this option avoids some rare compatibility problems with code
13579 generated by other compilers.  It is not the default because it results
13580 in a performance loss, especially for floating point code.
13581
13582 @item -mno-faster-structs
13583 @itemx -mfaster-structs
13584 @opindex mno-faster-structs
13585 @opindex mfaster-structs
13586 With @option{-mfaster-structs}, the compiler assumes that structures
13587 should have 8 byte alignment.  This enables the use of pairs of
13588 @code{ldd} and @code{std} instructions for copies in structure
13589 assignment, in place of twice as many @code{ld} and @code{st} pairs.
13590 However, the use of this changed alignment directly violates the SPARC
13591 ABI@.  Thus, it's intended only for use on targets where the developer
13592 acknowledges that their resulting code will not be directly in line with
13593 the rules of the ABI@.
13594
13595 @item -mimpure-text
13596 @opindex mimpure-text
13597 @option{-mimpure-text}, used in addition to @option{-shared}, tells
13598 the compiler to not pass @option{-z text} to the linker when linking a
13599 shared object.  Using this option, you can link position-dependent
13600 code into a shared object.
13601
13602 @option{-mimpure-text} suppresses the ``relocations remain against
13603 allocatable but non-writable sections'' linker error message.
13604 However, the necessary relocations will trigger copy-on-write, and the
13605 shared object is not actually shared across processes.  Instead of
13606 using @option{-mimpure-text}, you should compile all source code with
13607 @option{-fpic} or @option{-fPIC}.
13608
13609 This option is only available on SunOS and Solaris.
13610
13611 @item -mcpu=@var{cpu_type}
13612 @opindex mcpu
13613 Set the instruction set, register set, and instruction scheduling parameters
13614 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
13615 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
13616 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
13617 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
13618 @samp{ultrasparc3}, and @samp{niagara}.
13619
13620 Default instruction scheduling parameters are used for values that select
13621 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
13622 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
13623
13624 Here is a list of each supported architecture and their supported
13625 implementations.
13626
13627 @smallexample
13628     v7:             cypress
13629     v8:             supersparc, hypersparc
13630     sparclite:      f930, f934, sparclite86x
13631     sparclet:       tsc701
13632     v9:             ultrasparc, ultrasparc3, niagara
13633 @end smallexample
13634
13635 By default (unless configured otherwise), GCC generates code for the V7
13636 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
13637 additionally optimizes it for the Cypress CY7C602 chip, as used in the
13638 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
13639 SPARCStation 1, 2, IPX etc.
13640
13641 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
13642 architecture.  The only difference from V7 code is that the compiler emits
13643 the integer multiply and integer divide instructions which exist in SPARC-V8
13644 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
13645 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
13646 2000 series.
13647
13648 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
13649 the SPARC architecture.  This adds the integer multiply, integer divide step
13650 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
13651 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
13652 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
13653 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
13654 MB86934 chip, which is the more recent SPARClite with FPU@.
13655
13656 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
13657 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
13658 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
13659 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
13660 optimizes it for the TEMIC SPARClet chip.
13661
13662 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
13663 architecture.  This adds 64-bit integer and floating-point move instructions,
13664 3 additional floating-point condition code registers and conditional move
13665 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
13666 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
13667 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
13668 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
13669 @option{-mcpu=niagara}, the compiler additionally optimizes it for
13670 Sun UltraSPARC T1 chips.
13671
13672 @item -mtune=@var{cpu_type}
13673 @opindex mtune
13674 Set the instruction scheduling parameters for machine type
13675 @var{cpu_type}, but do not set the instruction set or register set that the
13676 option @option{-mcpu=@var{cpu_type}} would.
13677
13678 The same values for @option{-mcpu=@var{cpu_type}} can be used for
13679 @option{-mtune=@var{cpu_type}}, but the only useful values are those
13680 that select a particular cpu implementation.  Those are @samp{cypress},
13681 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
13682 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
13683 @samp{ultrasparc3}, and @samp{niagara}.
13684
13685 @item -mv8plus
13686 @itemx -mno-v8plus
13687 @opindex mv8plus
13688 @opindex mno-v8plus
13689 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
13690 difference from the V8 ABI is that the global and out registers are
13691 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
13692 mode for all SPARC-V9 processors.
13693
13694 @item -mvis
13695 @itemx -mno-vis
13696 @opindex mvis
13697 @opindex mno-vis
13698 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
13699 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
13700 @end table
13701
13702 These @samp{-m} options are supported in addition to the above
13703 on SPARC-V9 processors in 64-bit environments:
13704
13705 @table @gcctabopt
13706 @item -mlittle-endian
13707 @opindex mlittle-endian
13708 Generate code for a processor running in little-endian mode.  It is only
13709 available for a few configurations and most notably not on Solaris and Linux.
13710
13711 @item -m32
13712 @itemx -m64
13713 @opindex m32
13714 @opindex m64
13715 Generate code for a 32-bit or 64-bit environment.
13716 The 32-bit environment sets int, long and pointer to 32 bits.
13717 The 64-bit environment sets int to 32 bits and long and pointer
13718 to 64 bits.
13719
13720 @item -mcmodel=medlow
13721 @opindex mcmodel=medlow
13722 Generate code for the Medium/Low code model: 64-bit addresses, programs
13723 must be linked in the low 32 bits of memory.  Programs can be statically
13724 or dynamically linked.
13725
13726 @item -mcmodel=medmid
13727 @opindex mcmodel=medmid
13728 Generate code for the Medium/Middle code model: 64-bit addresses, programs
13729 must be linked in the low 44 bits of memory, the text and data segments must
13730 be less than 2GB in size and the data segment must be located within 2GB of
13731 the text segment.
13732
13733 @item -mcmodel=medany
13734 @opindex mcmodel=medany
13735 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
13736 may be linked anywhere in memory, the text and data segments must be less
13737 than 2GB in size and the data segment must be located within 2GB of the
13738 text segment.
13739
13740 @item -mcmodel=embmedany
13741 @opindex mcmodel=embmedany
13742 Generate code for the Medium/Anywhere code model for embedded systems:
13743 64-bit addresses, the text and data segments must be less than 2GB in
13744 size, both starting anywhere in memory (determined at link time).  The
13745 global register %g4 points to the base of the data segment.  Programs
13746 are statically linked and PIC is not supported.
13747
13748 @item -mstack-bias
13749 @itemx -mno-stack-bias
13750 @opindex mstack-bias
13751 @opindex mno-stack-bias
13752 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
13753 frame pointer if present, are offset by @minus{}2047 which must be added back
13754 when making stack frame references.  This is the default in 64-bit mode.
13755 Otherwise, assume no such offset is present.
13756 @end table
13757
13758 These switches are supported in addition to the above on Solaris:
13759
13760 @table @gcctabopt
13761 @item -threads
13762 @opindex threads
13763 Add support for multithreading using the Solaris threads library.  This
13764 option sets flags for both the preprocessor and linker.  This option does
13765 not affect the thread safety of object code produced by the compiler or
13766 that of libraries supplied with it.
13767
13768 @item -pthreads
13769 @opindex pthreads
13770 Add support for multithreading using the POSIX threads library.  This
13771 option sets flags for both the preprocessor and linker.  This option does
13772 not affect the thread safety of object code produced  by the compiler or
13773 that of libraries supplied with it.
13774
13775 @item -pthread
13776 @opindex pthread
13777 This is a synonym for @option{-pthreads}.
13778 @end table
13779
13780 @node SPU Options
13781 @subsection SPU Options
13782 @cindex SPU options
13783
13784 These @samp{-m} options are supported on the SPU:
13785
13786 @table @gcctabopt
13787 @item -mwarn-reloc
13788 @itemx -merror-reloc
13789 @opindex mwarn-reloc
13790 @opindex merror-reloc
13791
13792 The loader for SPU does not handle dynamic relocations.  By default, GCC
13793 will give an error when it generates code that requires a dynamic
13794 relocation.  @option{-mno-error-reloc} disables the error,
13795 @option{-mwarn-reloc} will generate a warning instead.
13796
13797 @item -msafe-dma
13798 @itemx -munsafe-dma
13799 @opindex msafe-dma
13800 @opindex munsafe-dma
13801
13802 Instructions which initiate or test completion of DMA must not be
13803 reordered with respect to loads and stores of the memory which is being
13804 accessed.  Users typically address this problem using the volatile
13805 keyword, but that can lead to inefficient code in places where the
13806 memory is known to not change.  Rather than mark the memory as volatile
13807 we treat the DMA instructions as potentially effecting all memory.  With
13808 @option{-munsafe-dma} users must use the volatile keyword to protect
13809 memory accesses.
13810
13811 @item -mbranch-hints
13812 @opindex mbranch-hints
13813
13814 By default, GCC will generate a branch hint instruction to avoid
13815 pipeline stalls for always taken or probably taken branches.  A hint
13816 will not be generated closer than 8 instructions away from its branch.
13817 There is little reason to disable them, except for debugging purposes,
13818 or to make an object a little bit smaller.
13819
13820 @item -msmall-mem
13821 @itemx -mlarge-mem
13822 @opindex msmall-mem
13823 @opindex mlarge-mem
13824
13825 By default, GCC generates code assuming that addresses are never larger
13826 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
13827 a full 32 bit address.
13828
13829 @item -mstdmain
13830 @opindex mstdmain
13831
13832 By default, GCC links against startup code that assumes the SPU-style
13833 main function interface (which has an unconventional parameter list).
13834 With @option{-mstdmain}, GCC will link your program against startup
13835 code that assumes a C99-style interface to @code{main}, including a
13836 local copy of @code{argv} strings.
13837
13838 @item -mfixed-range=@var{register-range}
13839 @opindex mfixed-range
13840 Generate code treating the given register range as fixed registers.
13841 A fixed register is one that the register allocator can not use.  This is
13842 useful when compiling kernel code.  A register range is specified as
13843 two registers separated by a dash.  Multiple register ranges can be
13844 specified separated by a comma.
13845
13846 @end table
13847
13848 @node System V Options
13849 @subsection Options for System V
13850
13851 These additional options are available on System V Release 4 for
13852 compatibility with other compilers on those systems:
13853
13854 @table @gcctabopt
13855 @item -G
13856 @opindex G
13857 Create a shared object.
13858 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
13859
13860 @item -Qy
13861 @opindex Qy
13862 Identify the versions of each tool used by the compiler, in a
13863 @code{.ident} assembler directive in the output.
13864
13865 @item -Qn
13866 @opindex Qn
13867 Refrain from adding @code{.ident} directives to the output file (this is
13868 the default).
13869
13870 @item -YP,@var{dirs}
13871 @opindex YP
13872 Search the directories @var{dirs}, and no others, for libraries
13873 specified with @option{-l}.
13874
13875 @item -Ym,@var{dir}
13876 @opindex Ym
13877 Look in the directory @var{dir} to find the M4 preprocessor.
13878 The assembler uses this option.
13879 @c This is supposed to go with a -Yd for predefined M4 macro files, but
13880 @c the generic assembler that comes with Solaris takes just -Ym.
13881 @end table
13882
13883 @node TMS320C3x/C4x Options
13884 @subsection TMS320C3x/C4x Options
13885 @cindex TMS320C3x/C4x Options
13886
13887 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
13888
13889 @table @gcctabopt
13890
13891 @item -mcpu=@var{cpu_type}
13892 @opindex mcpu
13893 Set the instruction set, register set, and instruction scheduling
13894 parameters for machine type @var{cpu_type}.  Supported values for
13895 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
13896 @samp{c44}.  The default is @samp{c40} to generate code for the
13897 TMS320C40.
13898
13899 @item -mbig-memory
13900 @itemx -mbig
13901 @itemx -msmall-memory
13902 @itemx -msmall
13903 @opindex mbig-memory
13904 @opindex mbig
13905 @opindex msmall-memory
13906 @opindex msmall
13907 Generates code for the big or small memory model.  The small memory
13908 model assumed that all data fits into one 64K word page.  At run-time
13909 the data page (DP) register must be set to point to the 64K page
13910 containing the .bss and .data program sections.  The big memory model is
13911 the default and requires reloading of the DP register for every direct
13912 memory access.
13913
13914 @item -mbk
13915 @itemx -mno-bk
13916 @opindex mbk
13917 @opindex mno-bk
13918 Allow (disallow) allocation of general integer operands into the block
13919 count register BK@.
13920
13921 @item -mdb
13922 @itemx -mno-db
13923 @opindex mdb
13924 @opindex mno-db
13925 Enable (disable) generation of code using decrement and branch,
13926 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
13927 on the safe side, this is disabled for the C3x, since the maximum
13928 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
13929 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
13930 that it can utilize the decrement and branch instruction, but will give
13931 up if there is more than one memory reference in the loop.  Thus a loop
13932 where the loop counter is decremented can generate slightly more
13933 efficient code, in cases where the RPTB instruction cannot be utilized.
13934
13935 @item -mdp-isr-reload
13936 @itemx -mparanoid
13937 @opindex mdp-isr-reload
13938 @opindex mparanoid
13939 Force the DP register to be saved on entry to an interrupt service
13940 routine (ISR), reloaded to point to the data section, and restored on
13941 exit from the ISR@.  This should not be required unless someone has
13942 violated the small memory model by modifying the DP register, say within
13943 an object library.
13944
13945 @item -mmpyi
13946 @itemx -mno-mpyi
13947 @opindex mmpyi
13948 @opindex mno-mpyi
13949 For the C3x use the 24-bit MPYI instruction for integer multiplies
13950 instead of a library call to guarantee 32-bit results.  Note that if one
13951 of the operands is a constant, then the multiplication will be performed
13952 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
13953 then squaring operations are performed inline instead of a library call.
13954
13955 @item -mfast-fix
13956 @itemx -mno-fast-fix
13957 @opindex mfast-fix
13958 @opindex mno-fast-fix
13959 The C3x/C4x FIX instruction to convert a floating point value to an
13960 integer value chooses the nearest integer less than or equal to the
13961 floating point value rather than to the nearest integer.  Thus if the
13962 floating point number is negative, the result will be incorrectly
13963 truncated an additional code is necessary to detect and correct this
13964 case.  This option can be used to disable generation of the additional
13965 code required to correct the result.
13966
13967 @item -mrptb
13968 @itemx -mno-rptb
13969 @opindex mrptb
13970 @opindex mno-rptb
13971 Enable (disable) generation of repeat block sequences using the RPTB
13972 instruction for zero overhead looping.  The RPTB construct is only used
13973 for innermost loops that do not call functions or jump across the loop
13974 boundaries.  There is no advantage having nested RPTB loops due to the
13975 overhead required to save and restore the RC, RS, and RE registers.
13976 This is enabled by default with @option{-O2}.
13977
13978 @item -mrpts=@var{count}
13979 @itemx -mno-rpts
13980 @opindex mrpts
13981 @opindex mno-rpts
13982 Enable (disable) the use of the single instruction repeat instruction
13983 RPTS@.  If a repeat block contains a single instruction, and the loop
13984 count can be guaranteed to be less than the value @var{count}, GCC will
13985 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
13986 then a RPTS will be emitted even if the loop count cannot be determined
13987 at compile time.  Note that the repeated instruction following RPTS does
13988 not have to be reloaded from memory each iteration, thus freeing up the
13989 CPU buses for operands.  However, since interrupts are blocked by this
13990 instruction, it is disabled by default.
13991
13992 @item -mloop-unsigned
13993 @itemx -mno-loop-unsigned
13994 @opindex mloop-unsigned
13995 @opindex mno-loop-unsigned
13996 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
13997 is @math{2^{31} + 1} since these instructions test if the iteration count is
13998 negative to terminate the loop.  If the iteration count is unsigned
13999 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
14000 exceeded.  This switch allows an unsigned iteration count.
14001
14002 @item -mti
14003 @opindex mti
14004 Try to emit an assembler syntax that the TI assembler (asm30) is happy
14005 with.  This also enforces compatibility with the API employed by the TI
14006 C3x C compiler.  For example, long doubles are passed as structures
14007 rather than in floating point registers.
14008
14009 @item -mregparm
14010 @itemx -mmemparm
14011 @opindex mregparm
14012 @opindex mmemparm
14013 Generate code that uses registers (stack) for passing arguments to functions.
14014 By default, arguments are passed in registers where possible rather
14015 than by pushing arguments on to the stack.
14016
14017 @item -mparallel-insns
14018 @itemx -mno-parallel-insns
14019 @opindex mparallel-insns
14020 @opindex mno-parallel-insns
14021 Allow the generation of parallel instructions.  This is enabled by
14022 default with @option{-O2}.
14023
14024 @item -mparallel-mpy
14025 @itemx -mno-parallel-mpy
14026 @opindex mparallel-mpy
14027 @opindex mno-parallel-mpy
14028 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
14029 provided @option{-mparallel-insns} is also specified.  These instructions have
14030 tight register constraints which can pessimize the code generation
14031 of large functions.
14032
14033 @end table
14034
14035 @node V850 Options
14036 @subsection V850 Options
14037 @cindex V850 Options
14038
14039 These @samp{-m} options are defined for V850 implementations:
14040
14041 @table @gcctabopt
14042 @item -mlong-calls
14043 @itemx -mno-long-calls
14044 @opindex mlong-calls
14045 @opindex mno-long-calls
14046 Treat all calls as being far away (near).  If calls are assumed to be
14047 far away, the compiler will always load the functions address up into a
14048 register, and call indirect through the pointer.
14049
14050 @item -mno-ep
14051 @itemx -mep
14052 @opindex mno-ep
14053 @opindex mep
14054 Do not optimize (do optimize) basic blocks that use the same index
14055 pointer 4 or more times to copy pointer into the @code{ep} register, and
14056 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14057 option is on by default if you optimize.
14058
14059 @item -mno-prolog-function
14060 @itemx -mprolog-function
14061 @opindex mno-prolog-function
14062 @opindex mprolog-function
14063 Do not use (do use) external functions to save and restore registers
14064 at the prologue and epilogue of a function.  The external functions
14065 are slower, but use less code space if more than one function saves
14066 the same number of registers.  The @option{-mprolog-function} option
14067 is on by default if you optimize.
14068
14069 @item -mspace
14070 @opindex mspace
14071 Try to make the code as small as possible.  At present, this just turns
14072 on the @option{-mep} and @option{-mprolog-function} options.
14073
14074 @item -mtda=@var{n}
14075 @opindex mtda
14076 Put static or global variables whose size is @var{n} bytes or less into
14077 the tiny data area that register @code{ep} points to.  The tiny data
14078 area can hold up to 256 bytes in total (128 bytes for byte references).
14079
14080 @item -msda=@var{n}
14081 @opindex msda
14082 Put static or global variables whose size is @var{n} bytes or less into
14083 the small data area that register @code{gp} points to.  The small data
14084 area can hold up to 64 kilobytes.
14085
14086 @item -mzda=@var{n}
14087 @opindex mzda
14088 Put static or global variables whose size is @var{n} bytes or less into
14089 the first 32 kilobytes of memory.
14090
14091 @item -mv850
14092 @opindex mv850
14093 Specify that the target processor is the V850.
14094
14095 @item -mbig-switch
14096 @opindex mbig-switch
14097 Generate code suitable for big switch tables.  Use this option only if
14098 the assembler/linker complain about out of range branches within a switch
14099 table.
14100
14101 @item -mapp-regs
14102 @opindex mapp-regs
14103 This option will cause r2 and r5 to be used in the code generated by
14104 the compiler.  This setting is the default.
14105
14106 @item -mno-app-regs
14107 @opindex mno-app-regs
14108 This option will cause r2 and r5 to be treated as fixed registers.
14109
14110 @item -mv850e1
14111 @opindex mv850e1
14112 Specify that the target processor is the V850E1.  The preprocessor
14113 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14114 this option is used.
14115
14116 @item -mv850e
14117 @opindex mv850e
14118 Specify that the target processor is the V850E@.  The preprocessor
14119 constant @samp{__v850e__} will be defined if this option is used.
14120
14121 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14122 are defined then a default target processor will be chosen and the
14123 relevant @samp{__v850*__} preprocessor constant will be defined.
14124
14125 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14126 defined, regardless of which processor variant is the target.
14127
14128 @item -mdisable-callt
14129 @opindex mdisable-callt
14130 This option will suppress generation of the CALLT instruction for the
14131 v850e and v850e1 flavors of the v850 architecture.  The default is
14132 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14133
14134 @end table
14135
14136 @node VAX Options
14137 @subsection VAX Options
14138 @cindex VAX options
14139
14140 These @samp{-m} options are defined for the VAX:
14141
14142 @table @gcctabopt
14143 @item -munix
14144 @opindex munix
14145 Do not output certain jump instructions (@code{aobleq} and so on)
14146 that the Unix assembler for the VAX cannot handle across long
14147 ranges.
14148
14149 @item -mgnu
14150 @opindex mgnu
14151 Do output those jump instructions, on the assumption that you
14152 will assemble with the GNU assembler.
14153
14154 @item -mg
14155 @opindex mg
14156 Output code for g-format floating point numbers instead of d-format.
14157 @end table
14158
14159 @node VxWorks Options
14160 @subsection VxWorks Options
14161 @cindex VxWorks Options
14162
14163 The options in this section are defined for all VxWorks targets.
14164 Options specific to the target hardware are listed with the other
14165 options for that target.
14166
14167 @table @gcctabopt
14168 @item -mrtp
14169 @opindex mrtp
14170 GCC can generate code for both VxWorks kernels and real time processes
14171 (RTPs).  This option switches from the former to the latter.  It also
14172 defines the preprocessor macro @code{__RTP__}.
14173
14174 @item -non-static
14175 @opindex non-static
14176 Link an RTP executable against shared libraries rather than static
14177 libraries.  The options @option{-static} and @option{-shared} can
14178 also be used for RTPs (@pxref{Link Options}); @option{-static}
14179 is the default.
14180
14181 @item -Bstatic
14182 @itemx -Bdynamic
14183 @opindex Bstatic
14184 @opindex Bdynamic
14185 These options are passed down to the linker.  They are defined for
14186 compatibility with Diab.
14187
14188 @item -Xbind-lazy
14189 @opindex Xbind-lazy
14190 Enable lazy binding of function calls.  This option is equivalent to
14191 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14192
14193 @item -Xbind-now
14194 @opindex Xbind-now
14195 Disable lazy binding of function calls.  This option is the default and
14196 is defined for compatibility with Diab.
14197 @end table
14198
14199 @node x86-64 Options
14200 @subsection x86-64 Options
14201 @cindex x86-64 options
14202
14203 These are listed under @xref{i386 and x86-64 Options}.
14204
14205 @node Xstormy16 Options
14206 @subsection Xstormy16 Options
14207 @cindex Xstormy16 Options
14208
14209 These options are defined for Xstormy16:
14210
14211 @table @gcctabopt
14212 @item -msim
14213 @opindex msim
14214 Choose startup files and linker script suitable for the simulator.
14215 @end table
14216
14217 @node Xtensa Options
14218 @subsection Xtensa Options
14219 @cindex Xtensa Options
14220
14221 These options are supported for Xtensa targets:
14222
14223 @table @gcctabopt
14224 @item -mconst16
14225 @itemx -mno-const16
14226 @opindex mconst16
14227 @opindex mno-const16
14228 Enable or disable use of @code{CONST16} instructions for loading
14229 constant values.  The @code{CONST16} instruction is currently not a
14230 standard option from Tensilica.  When enabled, @code{CONST16}
14231 instructions are always used in place of the standard @code{L32R}
14232 instructions.  The use of @code{CONST16} is enabled by default only if
14233 the @code{L32R} instruction is not available.
14234
14235 @item -mfused-madd
14236 @itemx -mno-fused-madd
14237 @opindex mfused-madd
14238 @opindex mno-fused-madd
14239 Enable or disable use of fused multiply/add and multiply/subtract
14240 instructions in the floating-point option.  This has no effect if the
14241 floating-point option is not also enabled.  Disabling fused multiply/add
14242 and multiply/subtract instructions forces the compiler to use separate
14243 instructions for the multiply and add/subtract operations.  This may be
14244 desirable in some cases where strict IEEE 754-compliant results are
14245 required: the fused multiply add/subtract instructions do not round the
14246 intermediate result, thereby producing results with @emph{more} bits of
14247 precision than specified by the IEEE standard.  Disabling fused multiply
14248 add/subtract instructions also ensures that the program output is not
14249 sensitive to the compiler's ability to combine multiply and add/subtract
14250 operations.
14251
14252 @item -mtext-section-literals
14253 @itemx -mno-text-section-literals
14254 @opindex mtext-section-literals
14255 @opindex mno-text-section-literals
14256 Control the treatment of literal pools.  The default is
14257 @option{-mno-text-section-literals}, which places literals in a separate
14258 section in the output file.  This allows the literal pool to be placed
14259 in a data RAM/ROM, and it also allows the linker to combine literal
14260 pools from separate object files to remove redundant literals and
14261 improve code size.  With @option{-mtext-section-literals}, the literals
14262 are interspersed in the text section in order to keep them as close as
14263 possible to their references.  This may be necessary for large assembly
14264 files.
14265
14266 @item -mtarget-align
14267 @itemx -mno-target-align
14268 @opindex mtarget-align
14269 @opindex mno-target-align
14270 When this option is enabled, GCC instructs the assembler to
14271 automatically align instructions to reduce branch penalties at the
14272 expense of some code density.  The assembler attempts to widen density
14273 instructions to align branch targets and the instructions following call
14274 instructions.  If there are not enough preceding safe density
14275 instructions to align a target, no widening will be performed.  The
14276 default is @option{-mtarget-align}.  These options do not affect the
14277 treatment of auto-aligned instructions like @code{LOOP}, which the
14278 assembler will always align, either by widening density instructions or
14279 by inserting no-op instructions.
14280
14281 @item -mlongcalls
14282 @itemx -mno-longcalls
14283 @opindex mlongcalls
14284 @opindex mno-longcalls
14285 When this option is enabled, GCC instructs the assembler to translate
14286 direct calls to indirect calls unless it can determine that the target
14287 of a direct call is in the range allowed by the call instruction.  This
14288 translation typically occurs for calls to functions in other source
14289 files.  Specifically, the assembler translates a direct @code{CALL}
14290 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14291 The default is @option{-mno-longcalls}.  This option should be used in
14292 programs where the call target can potentially be out of range.  This
14293 option is implemented in the assembler, not the compiler, so the
14294 assembly code generated by GCC will still show direct call
14295 instructions---look at the disassembled object code to see the actual
14296 instructions.  Note that the assembler will use an indirect call for
14297 every cross-file call, not just those that really will be out of range.
14298 @end table
14299
14300 @node zSeries Options
14301 @subsection zSeries Options
14302 @cindex zSeries options
14303
14304 These are listed under @xref{S/390 and zSeries Options}.
14305
14306 @node Code Gen Options
14307 @section Options for Code Generation Conventions
14308 @cindex code generation conventions
14309 @cindex options, code generation
14310 @cindex run-time options
14311
14312 These machine-independent options control the interface conventions
14313 used in code generation.
14314
14315 Most of them have both positive and negative forms; the negative form
14316 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14317 one of the forms is listed---the one which is not the default.  You
14318 can figure out the other form by either removing @samp{no-} or adding
14319 it.
14320
14321 @table @gcctabopt
14322 @item -fbounds-check
14323 @opindex fbounds-check
14324 For front-ends that support it, generate additional code to check that
14325 indices used to access arrays are within the declared range.  This is
14326 currently only supported by the Java and Fortran front-ends, where
14327 this option defaults to true and false respectively.
14328
14329 @item -ftrapv
14330 @opindex ftrapv
14331 This option generates traps for signed overflow on addition, subtraction,
14332 multiplication operations.
14333
14334 @item -fwrapv
14335 @opindex fwrapv
14336 This option instructs the compiler to assume that signed arithmetic
14337 overflow of addition, subtraction and multiplication wraps around
14338 using twos-complement representation.  This flag enables some optimizations
14339 and disables others.  This option is enabled by default for the Java
14340 front-end, as required by the Java language specification.
14341
14342 @item -fexceptions
14343 @opindex fexceptions
14344 Enable exception handling.  Generates extra code needed to propagate
14345 exceptions.  For some targets, this implies GCC will generate frame
14346 unwind information for all functions, which can produce significant data
14347 size overhead, although it does not affect execution.  If you do not
14348 specify this option, GCC will enable it by default for languages like
14349 C++ which normally require exception handling, and disable it for
14350 languages like C that do not normally require it.  However, you may need
14351 to enable this option when compiling C code that needs to interoperate
14352 properly with exception handlers written in C++.  You may also wish to
14353 disable this option if you are compiling older C++ programs that don't
14354 use exception handling.
14355
14356 @item -fnon-call-exceptions
14357 @opindex fnon-call-exceptions
14358 Generate code that allows trapping instructions to throw exceptions.
14359 Note that this requires platform-specific runtime support that does
14360 not exist everywhere.  Moreover, it only allows @emph{trapping}
14361 instructions to throw exceptions, i.e.@: memory references or floating
14362 point instructions.  It does not allow exceptions to be thrown from
14363 arbitrary signal handlers such as @code{SIGALRM}.
14364
14365 @item -funwind-tables
14366 @opindex funwind-tables
14367 Similar to @option{-fexceptions}, except that it will just generate any needed
14368 static data, but will not affect the generated code in any other way.
14369 You will normally not enable this option; instead, a language processor
14370 that needs this handling would enable it on your behalf.
14371
14372 @item -fasynchronous-unwind-tables
14373 @opindex fasynchronous-unwind-tables
14374 Generate unwind table in dwarf2 format, if supported by target machine.  The
14375 table is exact at each instruction boundary, so it can be used for stack
14376 unwinding from asynchronous events (such as debugger or garbage collector).
14377
14378 @item -fpcc-struct-return
14379 @opindex fpcc-struct-return
14380 Return ``short'' @code{struct} and @code{union} values in memory like
14381 longer ones, rather than in registers.  This convention is less
14382 efficient, but it has the advantage of allowing intercallability between
14383 GCC-compiled files and files compiled with other compilers, particularly
14384 the Portable C Compiler (pcc).
14385
14386 The precise convention for returning structures in memory depends
14387 on the target configuration macros.
14388
14389 Short structures and unions are those whose size and alignment match
14390 that of some integer type.
14391
14392 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14393 switch is not binary compatible with code compiled with the
14394 @option{-freg-struct-return} switch.
14395 Use it to conform to a non-default application binary interface.
14396
14397 @item -freg-struct-return
14398 @opindex freg-struct-return
14399 Return @code{struct} and @code{union} values in registers when possible.
14400 This is more efficient for small structures than
14401 @option{-fpcc-struct-return}.
14402
14403 If you specify neither @option{-fpcc-struct-return} nor
14404 @option{-freg-struct-return}, GCC defaults to whichever convention is
14405 standard for the target.  If there is no standard convention, GCC
14406 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14407 the principal compiler.  In those cases, we can choose the standard, and
14408 we chose the more efficient register return alternative.
14409
14410 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14411 switch is not binary compatible with code compiled with the
14412 @option{-fpcc-struct-return} switch.
14413 Use it to conform to a non-default application binary interface.
14414
14415 @item -fshort-enums
14416 @opindex fshort-enums
14417 Allocate to an @code{enum} type only as many bytes as it needs for the
14418 declared range of possible values.  Specifically, the @code{enum} type
14419 will be equivalent to the smallest integer type which has enough room.
14420
14421 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14422 code that is not binary compatible with code generated without that switch.
14423 Use it to conform to a non-default application binary interface.
14424
14425 @item -fshort-double
14426 @opindex fshort-double
14427 Use the same size for @code{double} as for @code{float}.
14428
14429 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14430 code that is not binary compatible with code generated without that switch.
14431 Use it to conform to a non-default application binary interface.
14432
14433 @item -fshort-wchar
14434 @opindex fshort-wchar
14435 Override the underlying type for @samp{wchar_t} to be @samp{short
14436 unsigned int} instead of the default for the target.  This option is
14437 useful for building programs to run under WINE@.
14438
14439 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14440 code that is not binary compatible with code generated without that switch.
14441 Use it to conform to a non-default application binary interface.
14442
14443 @item -fno-common
14444 @opindex fno-common
14445 In C, allocate even uninitialized global variables in the data section of the
14446 object file, rather than generating them as common blocks.  This has the
14447 effect that if the same variable is declared (without @code{extern}) in
14448 two different compilations, you will get an error when you link them.
14449 The only reason this might be useful is if you wish to verify that the
14450 program will work on other systems which always work this way.
14451
14452 @item -fno-ident
14453 @opindex fno-ident
14454 Ignore the @samp{#ident} directive.
14455
14456 @item -finhibit-size-directive
14457 @opindex finhibit-size-directive
14458 Don't output a @code{.size} assembler directive, or anything else that
14459 would cause trouble if the function is split in the middle, and the
14460 two halves are placed at locations far apart in memory.  This option is
14461 used when compiling @file{crtstuff.c}; you should not need to use it
14462 for anything else.
14463
14464 @item -fverbose-asm
14465 @opindex fverbose-asm
14466 Put extra commentary information in the generated assembly code to
14467 make it more readable.  This option is generally only of use to those
14468 who actually need to read the generated assembly code (perhaps while
14469 debugging the compiler itself).
14470
14471 @option{-fno-verbose-asm}, the default, causes the
14472 extra information to be omitted and is useful when comparing two assembler
14473 files.
14474
14475 @item -frecord-gcc-switches
14476 @opindex frecord-gcc-switches
14477 This switch causes the command line that was used to invoke the
14478 compiler to be recorded into the object file that is being created.
14479 This switch is only implemented on some targets and the exact format
14480 of the recording is target and binary file format dependent, but it
14481 usually takes the form of a section containing ASCII text.  This
14482 switch is related to the @option{-fverbose-asm} switch, but that
14483 switch only records information in the assembler output file as
14484 comments, so it never reaches the object file.
14485
14486 @item -fpic
14487 @opindex fpic
14488 @cindex global offset table
14489 @cindex PIC
14490 Generate position-independent code (PIC) suitable for use in a shared
14491 library, if supported for the target machine.  Such code accesses all
14492 constant addresses through a global offset table (GOT)@.  The dynamic
14493 loader resolves the GOT entries when the program starts (the dynamic
14494 loader is not part of GCC; it is part of the operating system).  If
14495 the GOT size for the linked executable exceeds a machine-specific
14496 maximum size, you get an error message from the linker indicating that
14497 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14498 instead.  (These maximums are 8k on the SPARC and 32k
14499 on the m68k and RS/6000.  The 386 has no such limit.)
14500
14501 Position-independent code requires special support, and therefore works
14502 only on certain machines.  For the 386, GCC supports PIC for System V
14503 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
14504 position-independent.
14505
14506 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14507 are defined to 1.
14508
14509 @item -fPIC
14510 @opindex fPIC
14511 If supported for the target machine, emit position-independent code,
14512 suitable for dynamic linking and avoiding any limit on the size of the
14513 global offset table.  This option makes a difference on the m68k,
14514 PowerPC and SPARC@.
14515
14516 Position-independent code requires special support, and therefore works
14517 only on certain machines.
14518
14519 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14520 are defined to 2.
14521
14522 @item -fpie
14523 @itemx -fPIE
14524 @opindex fpie
14525 @opindex fPIE
14526 These options are similar to @option{-fpic} and @option{-fPIC}, but
14527 generated position independent code can be only linked into executables.
14528 Usually these options are used when @option{-pie} GCC option will be
14529 used during linking.
14530
14531 @option{-fpie} and @option{-fPIE} both define the macros
14532 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
14533 for @option{-fpie} and 2 for @option{-fPIE}.
14534
14535 @item -fno-jump-tables
14536 @opindex fno-jump-tables
14537 Do not use jump tables for switch statements even where it would be
14538 more efficient than other code generation strategies.  This option is
14539 of use in conjunction with @option{-fpic} or @option{-fPIC} for
14540 building code which forms part of a dynamic linker and cannot
14541 reference the address of a jump table.  On some targets, jump tables
14542 do not require a GOT and this option is not needed.
14543
14544 @item -ffixed-@var{reg}
14545 @opindex ffixed
14546 Treat the register named @var{reg} as a fixed register; generated code
14547 should never refer to it (except perhaps as a stack pointer, frame
14548 pointer or in some other fixed role).
14549
14550 @var{reg} must be the name of a register.  The register names accepted
14551 are machine-specific and are defined in the @code{REGISTER_NAMES}
14552 macro in the machine description macro file.
14553
14554 This flag does not have a negative form, because it specifies a
14555 three-way choice.
14556
14557 @item -fcall-used-@var{reg}
14558 @opindex fcall-used
14559 Treat the register named @var{reg} as an allocable register that is
14560 clobbered by function calls.  It may be allocated for temporaries or
14561 variables that do not live across a call.  Functions compiled this way
14562 will not save and restore the register @var{reg}.
14563
14564 It is an error to used this flag with the frame pointer or stack pointer.
14565 Use of this flag for other registers that have fixed pervasive roles in
14566 the machine's execution model will produce disastrous results.
14567
14568 This flag does not have a negative form, because it specifies a
14569 three-way choice.
14570
14571 @item -fcall-saved-@var{reg}
14572 @opindex fcall-saved
14573 Treat the register named @var{reg} as an allocable register saved by
14574 functions.  It may be allocated even for temporaries or variables that
14575 live across a call.  Functions compiled this way will save and restore
14576 the register @var{reg} if they use it.
14577
14578 It is an error to used this flag with the frame pointer or stack pointer.
14579 Use of this flag for other registers that have fixed pervasive roles in
14580 the machine's execution model will produce disastrous results.
14581
14582 A different sort of disaster will result from the use of this flag for
14583 a register in which function values may be returned.
14584
14585 This flag does not have a negative form, because it specifies a
14586 three-way choice.
14587
14588 @item -fpack-struct[=@var{n}]
14589 @opindex fpack-struct
14590 Without a value specified, pack all structure members together without
14591 holes.  When a value is specified (which must be a small power of two), pack
14592 structure members according to this value, representing the maximum
14593 alignment (that is, objects with default alignment requirements larger than
14594 this will be output potentially unaligned at the next fitting location.
14595
14596 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
14597 code that is not binary compatible with code generated without that switch.
14598 Additionally, it makes the code suboptimal.
14599 Use it to conform to a non-default application binary interface.
14600
14601 @item -finstrument-functions
14602 @opindex finstrument-functions
14603 Generate instrumentation calls for entry and exit to functions.  Just
14604 after function entry and just before function exit, the following
14605 profiling functions will be called with the address of the current
14606 function and its call site.  (On some platforms,
14607 @code{__builtin_return_address} does not work beyond the current
14608 function, so the call site information may not be available to the
14609 profiling functions otherwise.)
14610
14611 @smallexample
14612 void __cyg_profile_func_enter (void *this_fn,
14613                                void *call_site);
14614 void __cyg_profile_func_exit  (void *this_fn,
14615                                void *call_site);
14616 @end smallexample
14617
14618 The first argument is the address of the start of the current function,
14619 which may be looked up exactly in the symbol table.
14620
14621 This instrumentation is also done for functions expanded inline in other
14622 functions.  The profiling calls will indicate where, conceptually, the
14623 inline function is entered and exited.  This means that addressable
14624 versions of such functions must be available.  If all your uses of a
14625 function are expanded inline, this may mean an additional expansion of
14626 code size.  If you use @samp{extern inline} in your C code, an
14627 addressable version of such functions must be provided.  (This is
14628 normally the case anyways, but if you get lucky and the optimizer always
14629 expands the functions inline, you might have gotten away without
14630 providing static copies.)
14631
14632 A function may be given the attribute @code{no_instrument_function}, in
14633 which case this instrumentation will not be done.  This can be used, for
14634 example, for the profiling functions listed above, high-priority
14635 interrupt routines, and any functions from which the profiling functions
14636 cannot safely be called (perhaps signal handlers, if the profiling
14637 routines generate output or allocate memory).
14638
14639 @item -fstack-check
14640 @opindex fstack-check
14641 Generate code to verify that you do not go beyond the boundary of the
14642 stack.  You should specify this flag if you are running in an
14643 environment with multiple threads, but only rarely need to specify it in
14644 a single-threaded environment since stack overflow is automatically
14645 detected on nearly all systems if there is only one stack.
14646
14647 Note that this switch does not actually cause checking to be done; the
14648 operating system must do that.  The switch causes generation of code
14649 to ensure that the operating system sees the stack being extended.
14650
14651 @item -fstack-limit-register=@var{reg}
14652 @itemx -fstack-limit-symbol=@var{sym}
14653 @itemx -fno-stack-limit
14654 @opindex fstack-limit-register
14655 @opindex fstack-limit-symbol
14656 @opindex fno-stack-limit
14657 Generate code to ensure that the stack does not grow beyond a certain value,
14658 either the value of a register or the address of a symbol.  If the stack
14659 would grow beyond the value, a signal is raised.  For most targets,
14660 the signal is raised before the stack overruns the boundary, so
14661 it is possible to catch the signal without taking special precautions.
14662
14663 For instance, if the stack starts at absolute address @samp{0x80000000}
14664 and grows downwards, you can use the flags
14665 @option{-fstack-limit-symbol=__stack_limit} and
14666 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
14667 of 128KB@.  Note that this may only work with the GNU linker.
14668
14669 @cindex aliasing of parameters
14670 @cindex parameters, aliased
14671 @item -fargument-alias
14672 @itemx -fargument-noalias
14673 @itemx -fargument-noalias-global
14674 @itemx -fargument-noalias-anything
14675 @opindex fargument-alias
14676 @opindex fargument-noalias
14677 @opindex fargument-noalias-global
14678 @opindex fargument-noalias-anything
14679 Specify the possible relationships among parameters and between
14680 parameters and global data.
14681
14682 @option{-fargument-alias} specifies that arguments (parameters) may
14683 alias each other and may alias global storage.@*
14684 @option{-fargument-noalias} specifies that arguments do not alias
14685 each other, but may alias global storage.@*
14686 @option{-fargument-noalias-global} specifies that arguments do not
14687 alias each other and do not alias global storage.
14688 @option{-fargument-noalias-anything} specifies that arguments do not
14689 alias any other storage.
14690
14691 Each language will automatically use whatever option is required by
14692 the language standard.  You should not need to use these options yourself.
14693
14694 @item -fleading-underscore
14695 @opindex fleading-underscore
14696 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
14697 change the way C symbols are represented in the object file.  One use
14698 is to help link with legacy assembly code.
14699
14700 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
14701 generate code that is not binary compatible with code generated without that
14702 switch.  Use it to conform to a non-default application binary interface.
14703 Not all targets provide complete support for this switch.
14704
14705 @item -ftls-model=@var{model}
14706 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
14707 The @var{model} argument should be one of @code{global-dynamic},
14708 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
14709
14710 The default without @option{-fpic} is @code{initial-exec}; with
14711 @option{-fpic} the default is @code{global-dynamic}.
14712
14713 @item -fvisibility=@var{default|internal|hidden|protected}
14714 @opindex fvisibility
14715 Set the default ELF image symbol visibility to the specified option---all
14716 symbols will be marked with this unless overridden within the code.
14717 Using this feature can very substantially improve linking and
14718 load times of shared object libraries, produce more optimized
14719 code, provide near-perfect API export and prevent symbol clashes.
14720 It is @strong{strongly} recommended that you use this in any shared objects
14721 you distribute.
14722
14723 Despite the nomenclature, @code{default} always means public ie;
14724 available to be linked against from outside the shared object.
14725 @code{protected} and @code{internal} are pretty useless in real-world
14726 usage so the only other commonly used option will be @code{hidden}.
14727 The default if @option{-fvisibility} isn't specified is
14728 @code{default}, i.e., make every
14729 symbol public---this causes the same behavior as previous versions of
14730 GCC@.
14731
14732 A good explanation of the benefits offered by ensuring ELF
14733 symbols have the correct visibility is given by ``How To Write
14734 Shared Libraries'' by Ulrich Drepper (which can be found at
14735 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
14736 solution made possible by this option to marking things hidden when
14737 the default is public is to make the default hidden and mark things
14738 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
14739 and @code{__attribute__ ((visibility("default")))} instead of
14740 @code{__declspec(dllexport)} you get almost identical semantics with
14741 identical syntax.  This is a great boon to those working with
14742 cross-platform projects.
14743
14744 For those adding visibility support to existing code, you may find
14745 @samp{#pragma GCC visibility} of use.  This works by you enclosing
14746 the declarations you wish to set visibility for with (for example)
14747 @samp{#pragma GCC visibility push(hidden)} and
14748 @samp{#pragma GCC visibility pop}.
14749 Bear in mind that symbol visibility should be viewed @strong{as
14750 part of the API interface contract} and thus all new code should
14751 always specify visibility when it is not the default ie; declarations
14752 only for use within the local DSO should @strong{always} be marked explicitly
14753 as hidden as so to avoid PLT indirection overheads---making this
14754 abundantly clear also aids readability and self-documentation of the code.
14755 Note that due to ISO C++ specification requirements, operator new and
14756 operator delete must always be of default visibility.
14757
14758 Be aware that headers from outside your project, in particular system
14759 headers and headers from any other library you use, may not be
14760 expecting to be compiled with visibility other than the default.  You
14761 may need to explicitly say @samp{#pragma GCC visibility push(default)}
14762 before including any such headers.
14763
14764 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
14765 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
14766 no modifications.  However, this means that calls to @samp{extern}
14767 functions with no explicit visibility will use the PLT, so it is more
14768 effective to use @samp{__attribute ((visibility))} and/or
14769 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
14770 declarations should be treated as hidden.
14771
14772 Note that @samp{-fvisibility} does affect C++ vague linkage
14773 entities. This means that, for instance, an exception class that will
14774 be thrown between DSOs must be explicitly marked with default
14775 visibility so that the @samp{type_info} nodes will be unified between
14776 the DSOs.
14777
14778 An overview of these techniques, their benefits and how to use them
14779 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
14780
14781 @end table
14782
14783 @c man end
14784
14785 @node Environment Variables
14786 @section Environment Variables Affecting GCC
14787 @cindex environment variables
14788
14789 @c man begin ENVIRONMENT
14790 This section describes several environment variables that affect how GCC
14791 operates.  Some of them work by specifying directories or prefixes to use
14792 when searching for various kinds of files.  Some are used to specify other
14793 aspects of the compilation environment.
14794
14795 Note that you can also specify places to search using options such as
14796 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
14797 take precedence over places specified using environment variables, which
14798 in turn take precedence over those specified by the configuration of GCC@.
14799 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
14800 GNU Compiler Collection (GCC) Internals}.
14801
14802 @table @env
14803 @item LANG
14804 @itemx LC_CTYPE
14805 @c @itemx LC_COLLATE
14806 @itemx LC_MESSAGES
14807 @c @itemx LC_MONETARY
14808 @c @itemx LC_NUMERIC
14809 @c @itemx LC_TIME
14810 @itemx LC_ALL
14811 @findex LANG
14812 @findex LC_CTYPE
14813 @c @findex LC_COLLATE
14814 @findex LC_MESSAGES
14815 @c @findex LC_MONETARY
14816 @c @findex LC_NUMERIC
14817 @c @findex LC_TIME
14818 @findex LC_ALL
14819 @cindex locale
14820 These environment variables control the way that GCC uses
14821 localization information that allow GCC to work with different
14822 national conventions.  GCC inspects the locale categories
14823 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
14824 so.  These locale categories can be set to any value supported by your
14825 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
14826 Kingdom encoded in UTF-8.
14827
14828 The @env{LC_CTYPE} environment variable specifies character
14829 classification.  GCC uses it to determine the character boundaries in
14830 a string; this is needed for some multibyte encodings that contain quote
14831 and escape characters that would otherwise be interpreted as a string
14832 end or escape.
14833
14834 The @env{LC_MESSAGES} environment variable specifies the language to
14835 use in diagnostic messages.
14836
14837 If the @env{LC_ALL} environment variable is set, it overrides the value
14838 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
14839 and @env{LC_MESSAGES} default to the value of the @env{LANG}
14840 environment variable.  If none of these variables are set, GCC
14841 defaults to traditional C English behavior.
14842
14843 @item TMPDIR
14844 @findex TMPDIR
14845 If @env{TMPDIR} is set, it specifies the directory to use for temporary
14846 files.  GCC uses temporary files to hold the output of one stage of
14847 compilation which is to be used as input to the next stage: for example,
14848 the output of the preprocessor, which is the input to the compiler
14849 proper.
14850
14851 @item GCC_EXEC_PREFIX
14852 @findex GCC_EXEC_PREFIX
14853 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
14854 names of the subprograms executed by the compiler.  No slash is added
14855 when this prefix is combined with the name of a subprogram, but you can
14856 specify a prefix that ends with a slash if you wish.
14857
14858 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
14859 an appropriate prefix to use based on the pathname it was invoked with.
14860
14861 If GCC cannot find the subprogram using the specified prefix, it
14862 tries looking in the usual places for the subprogram.
14863
14864 The default value of @env{GCC_EXEC_PREFIX} is
14865 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
14866 the installed compiler. In many cases @var{prefix} is the value
14867 of @code{prefix} when you ran the @file{configure} script.
14868
14869 Other prefixes specified with @option{-B} take precedence over this prefix.
14870
14871 This prefix is also used for finding files such as @file{crt0.o} that are
14872 used for linking.
14873
14874 In addition, the prefix is used in an unusual way in finding the
14875 directories to search for header files.  For each of the standard
14876 directories whose name normally begins with @samp{/usr/local/lib/gcc}
14877 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
14878 replacing that beginning with the specified prefix to produce an
14879 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
14880 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
14881 These alternate directories are searched first; the standard directories
14882 come next. If a standard directory begins with the configured
14883 @var{prefix} then the value of @var{prefix} is replaced by
14884 @env{GCC_EXEC_PREFIX} when looking for header files.
14885
14886 @item COMPILER_PATH
14887 @findex COMPILER_PATH
14888 The value of @env{COMPILER_PATH} is a colon-separated list of
14889 directories, much like @env{PATH}.  GCC tries the directories thus
14890 specified when searching for subprograms, if it can't find the
14891 subprograms using @env{GCC_EXEC_PREFIX}.
14892
14893 @item LIBRARY_PATH
14894 @findex LIBRARY_PATH
14895 The value of @env{LIBRARY_PATH} is a colon-separated list of
14896 directories, much like @env{PATH}.  When configured as a native compiler,
14897 GCC tries the directories thus specified when searching for special
14898 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
14899 using GCC also uses these directories when searching for ordinary
14900 libraries for the @option{-l} option (but directories specified with
14901 @option{-L} come first).
14902
14903 @item LANG
14904 @findex LANG
14905 @cindex locale definition
14906 This variable is used to pass locale information to the compiler.  One way in
14907 which this information is used is to determine the character set to be used
14908 when character literals, string literals and comments are parsed in C and C++.
14909 When the compiler is configured to allow multibyte characters,
14910 the following values for @env{LANG} are recognized:
14911
14912 @table @samp
14913 @item C-JIS
14914 Recognize JIS characters.
14915 @item C-SJIS
14916 Recognize SJIS characters.
14917 @item C-EUCJP
14918 Recognize EUCJP characters.
14919 @end table
14920
14921 If @env{LANG} is not defined, or if it has some other value, then the
14922 compiler will use mblen and mbtowc as defined by the default locale to
14923 recognize and translate multibyte characters.
14924 @end table
14925
14926 @noindent
14927 Some additional environments variables affect the behavior of the
14928 preprocessor.
14929
14930 @include cppenv.texi
14931
14932 @c man end
14933
14934 @node Precompiled Headers
14935 @section Using Precompiled Headers
14936 @cindex precompiled headers
14937 @cindex speed of compilation
14938
14939 Often large projects have many header files that are included in every
14940 source file.  The time the compiler takes to process these header files
14941 over and over again can account for nearly all of the time required to
14942 build the project.  To make builds faster, GCC allows users to
14943 `precompile' a header file; then, if builds can use the precompiled
14944 header file they will be much faster.
14945
14946 To create a precompiled header file, simply compile it as you would any
14947 other file, if necessary using the @option{-x} option to make the driver
14948 treat it as a C or C++ header file.  You will probably want to use a
14949 tool like @command{make} to keep the precompiled header up-to-date when
14950 the headers it contains change.
14951
14952 A precompiled header file will be searched for when @code{#include} is
14953 seen in the compilation.  As it searches for the included file
14954 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
14955 compiler looks for a precompiled header in each directory just before it
14956 looks for the include file in that directory.  The name searched for is
14957 the name specified in the @code{#include} with @samp{.gch} appended.  If
14958 the precompiled header file can't be used, it is ignored.
14959
14960 For instance, if you have @code{#include "all.h"}, and you have
14961 @file{all.h.gch} in the same directory as @file{all.h}, then the
14962 precompiled header file will be used if possible, and the original
14963 header will be used otherwise.
14964
14965 Alternatively, you might decide to put the precompiled header file in a
14966 directory and use @option{-I} to ensure that directory is searched
14967 before (or instead of) the directory containing the original header.
14968 Then, if you want to check that the precompiled header file is always
14969 used, you can put a file of the same name as the original header in this
14970 directory containing an @code{#error} command.
14971
14972 This also works with @option{-include}.  So yet another way to use
14973 precompiled headers, good for projects not designed with precompiled
14974 header files in mind, is to simply take most of the header files used by
14975 a project, include them from another header file, precompile that header
14976 file, and @option{-include} the precompiled header.  If the header files
14977 have guards against multiple inclusion, they will be skipped because
14978 they've already been included (in the precompiled header).
14979
14980 If you need to precompile the same header file for different
14981 languages, targets, or compiler options, you can instead make a
14982 @emph{directory} named like @file{all.h.gch}, and put each precompiled
14983 header in the directory, perhaps using @option{-o}.  It doesn't matter
14984 what you call the files in the directory, every precompiled header in
14985 the directory will be considered.  The first precompiled header
14986 encountered in the directory that is valid for this compilation will
14987 be used; they're searched in no particular order.
14988
14989 There are many other possibilities, limited only by your imagination,
14990 good sense, and the constraints of your build system.
14991
14992 A precompiled header file can be used only when these conditions apply:
14993
14994 @itemize
14995 @item
14996 Only one precompiled header can be used in a particular compilation.
14997
14998 @item
14999 A precompiled header can't be used once the first C token is seen.  You
15000 can have preprocessor directives before a precompiled header; you can
15001 even include a precompiled header from inside another header, so long as
15002 there are no C tokens before the @code{#include}.
15003
15004 @item
15005 The precompiled header file must be produced for the same language as
15006 the current compilation.  You can't use a C precompiled header for a C++
15007 compilation.
15008
15009 @item
15010 The precompiled header file must have been produced by the same compiler
15011 binary as the current compilation is using.
15012
15013 @item
15014 Any macros defined before the precompiled header is included must
15015 either be defined in the same way as when the precompiled header was
15016 generated, or must not affect the precompiled header, which usually
15017 means that they don't appear in the precompiled header at all.
15018
15019 The @option{-D} option is one way to define a macro before a
15020 precompiled header is included; using a @code{#define} can also do it.
15021 There are also some options that define macros implicitly, like
15022 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15023 defined this way.
15024
15025 @item If debugging information is output when using the precompiled
15026 header, using @option{-g} or similar, the same kind of debugging information
15027 must have been output when building the precompiled header.  However,
15028 a precompiled header built using @option{-g} can be used in a compilation
15029 when no debugging information is being output.
15030
15031 @item The same @option{-m} options must generally be used when building
15032 and using the precompiled header.  @xref{Submodel Options},
15033 for any cases where this rule is relaxed.
15034
15035 @item Each of the following options must be the same when building and using
15036 the precompiled header:
15037
15038 @gccoptlist{-fexceptions -funit-at-a-time}
15039
15040 @item
15041 Some other command-line options starting with @option{-f},
15042 @option{-p}, or @option{-O} must be defined in the same way as when
15043 the precompiled header was generated.  At present, it's not clear
15044 which options are safe to change and which are not; the safest choice
15045 is to use exactly the same options when generating and using the
15046 precompiled header.  The following are known to be safe:
15047
15048 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15049 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15050 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15051 -pedantic-errors}
15052
15053 @end itemize
15054
15055 For all of these except the last, the compiler will automatically
15056 ignore the precompiled header if the conditions aren't met.  If you
15057 find an option combination that doesn't work and doesn't cause the
15058 precompiled header to be ignored, please consider filing a bug report,
15059 see @ref{Bugs}.
15060
15061 If you do use differing options when generating and using the
15062 precompiled header, the actual behavior will be a mixture of the
15063 behavior for the options.  For instance, if you use @option{-g} to
15064 generate the precompiled header but not when using it, you may or may
15065 not get debugging information for routines in the precompiled header.
15066
15067 @node Running Protoize
15068 @section Running Protoize
15069
15070 The program @code{protoize} is an optional part of GCC@.  You can use
15071 it to add prototypes to a program, thus converting the program to ISO
15072 C in one respect.  The companion program @code{unprotoize} does the
15073 reverse: it removes argument types from any prototypes that are found.
15074
15075 When you run these programs, you must specify a set of source files as
15076 command line arguments.  The conversion programs start out by compiling
15077 these files to see what functions they define.  The information gathered
15078 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15079
15080 After scanning comes actual conversion.  The specified files are all
15081 eligible to be converted; any files they include (whether sources or
15082 just headers) are eligible as well.
15083
15084 But not all the eligible files are converted.  By default,
15085 @code{protoize} and @code{unprotoize} convert only source and header
15086 files in the current directory.  You can specify additional directories
15087 whose files should be converted with the @option{-d @var{directory}}
15088 option.  You can also specify particular files to exclude with the
15089 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15090 directory name matches one of the specified directory names, and its
15091 name within the directory has not been excluded.
15092
15093 Basic conversion with @code{protoize} consists of rewriting most
15094 function definitions and function declarations to specify the types of
15095 the arguments.  The only ones not rewritten are those for varargs
15096 functions.
15097
15098 @code{protoize} optionally inserts prototype declarations at the
15099 beginning of the source file, to make them available for any calls that
15100 precede the function's definition.  Or it can insert prototype
15101 declarations with block scope in the blocks where undeclared functions
15102 are called.
15103
15104 Basic conversion with @code{unprotoize} consists of rewriting most
15105 function declarations to remove any argument types, and rewriting
15106 function definitions to the old-style pre-ISO form.
15107
15108 Both conversion programs print a warning for any function declaration or
15109 definition that they can't convert.  You can suppress these warnings
15110 with @option{-q}.
15111
15112 The output from @code{protoize} or @code{unprotoize} replaces the
15113 original source file.  The original file is renamed to a name ending
15114 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15115 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15116 for DOS) file already exists, then the source file is simply discarded.
15117
15118 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15119 scan the program and collect information about the functions it uses.
15120 So neither of these programs will work until GCC is installed.
15121
15122 Here is a table of the options you can use with @code{protoize} and
15123 @code{unprotoize}.  Each option works with both programs unless
15124 otherwise stated.
15125
15126 @table @code
15127 @item -B @var{directory}
15128 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15129 usual directory (normally @file{/usr/local/lib}).  This file contains
15130 prototype information about standard system functions.  This option
15131 applies only to @code{protoize}.
15132
15133 @item -c @var{compilation-options}
15134 Use @var{compilation-options} as the options when running @command{gcc} to
15135 produce the @samp{.X} files.  The special option @option{-aux-info} is
15136 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15137
15138 Note that the compilation options must be given as a single argument to
15139 @code{protoize} or @code{unprotoize}.  If you want to specify several
15140 @command{gcc} options, you must quote the entire set of compilation options
15141 to make them a single word in the shell.
15142
15143 There are certain @command{gcc} arguments that you cannot use, because they
15144 would produce the wrong kind of output.  These include @option{-g},
15145 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15146 the @var{compilation-options}, they are ignored.
15147
15148 @item -C
15149 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15150 systems) instead of @samp{.c}.  This is convenient if you are converting
15151 a C program to C++.  This option applies only to @code{protoize}.
15152
15153 @item -g
15154 Add explicit global declarations.  This means inserting explicit
15155 declarations at the beginning of each source file for each function
15156 that is called in the file and was not declared.  These declarations
15157 precede the first function definition that contains a call to an
15158 undeclared function.  This option applies only to @code{protoize}.
15159
15160 @item -i @var{string}
15161 Indent old-style parameter declarations with the string @var{string}.
15162 This option applies only to @code{protoize}.
15163
15164 @code{unprotoize} converts prototyped function definitions to old-style
15165 function definitions, where the arguments are declared between the
15166 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15167 uses five spaces as the indentation.  If you want to indent with just
15168 one space instead, use @option{-i " "}.
15169
15170 @item -k
15171 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15172 is finished.
15173
15174 @item -l
15175 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15176 a prototype declaration for each function in each block which calls the
15177 function without any declaration.  This option applies only to
15178 @code{protoize}.
15179
15180 @item -n
15181 Make no real changes.  This mode just prints information about the conversions
15182 that would have been done without @option{-n}.
15183
15184 @item -N
15185 Make no @samp{.save} files.  The original files are simply deleted.
15186 Use this option with caution.
15187
15188 @item -p @var{program}
15189 Use the program @var{program} as the compiler.  Normally, the name
15190 @file{gcc} is used.
15191
15192 @item -q
15193 Work quietly.  Most warnings are suppressed.
15194
15195 @item -v
15196 Print the version number, just like @option{-v} for @command{gcc}.
15197 @end table
15198
15199 If you need special compiler options to compile one of your program's
15200 source files, then you should generate that file's @samp{.X} file
15201 specially, by running @command{gcc} on that source file with the
15202 appropriate options and the option @option{-aux-info}.  Then run
15203 @code{protoize} on the entire set of files.  @code{protoize} will use
15204 the existing @samp{.X} file because it is newer than the source file.
15205 For example:
15206
15207 @smallexample
15208 gcc -Dfoo=bar file1.c -aux-info file1.X
15209 protoize *.c
15210 @end smallexample
15211
15212 @noindent
15213 You need to include the special files along with the rest in the
15214 @code{protoize} command, even though their @samp{.X} files already
15215 exist, because otherwise they won't get converted.
15216
15217 @xref{Protoize Caveats}, for more information on how to use
15218 @code{protoize} successfully.