OSDN Git Service

a5491b0679ef2430b26066dade94590797389e47
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
243 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
244 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
245 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
246 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
247 -Wvariadic-macros}
248
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
251 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
252 -Wstrict-prototypes  -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
254
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
258 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
281 -ftree-vectorizer-verbose=@var{n} @gol
282 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
283 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
284 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
285 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
286 -ftest-coverage  -ftime-report -fvar-tracking @gol
287 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
288 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
289 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
290 -print-multi-directory  -print-multi-lib @gol
291 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
292 -save-temps  -time}
293
294 @item Optimization Options
295 @xref{Optimize Options,,Options that Control Optimization}.
296 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
297 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
298 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
299 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
300 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
301 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
302 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
303 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
304 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
305 -fforce-addr  -ffunction-sections @gol
306 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
307 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
308 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
309 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
310 -fmodulo-sched -fno-branch-count-reg @gol
311 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
312 -fno-function-cse  -fno-guess-branch-probability @gol
313 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
314 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
315 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
316 -fomit-frame-pointer  -foptimize-register-move @gol
317 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
318 -fprofile-generate -fprofile-use @gol
319 -fregmove  -frename-registers @gol
320 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
321 -frerun-cse-after-loop  -frerun-loop-opt @gol
322 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
323 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
324 -fsched-spec-load-dangerous  @gol
325 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
326 -fsched2-use-superblocks @gol
327 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
328 -fsignaling-nans -fsingle-precision-constant  @gol
329 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
330 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
331 -fsplit-ivs-in-unroller -funswitch-loops @gol
332 -fvariable-expansion-in-unroller @gol
333 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
334 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
335 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
336 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
337 -ftree-salias -fweb @gol
338 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
339 --param @var{name}=@var{value}
340 -O  -O0  -O1  -O2  -O3  -Os}
341
342 @item Preprocessor Options
343 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
344 @gccoptlist{-A@var{question}=@var{answer} @gol
345 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
346 -C  -dD  -dI  -dM  -dN @gol
347 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
348 -idirafter @var{dir} @gol
349 -include @var{file}  -imacros @var{file} @gol
350 -iprefix @var{file}  -iwithprefix @var{dir} @gol
351 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
352 -isysroot @var{dir} @gol
353 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
354 -P  -fworking-directory  -remap @gol
355 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
356 -Xpreprocessor @var{option}}
357
358 @item Assembler Option
359 @xref{Assembler Options,,Passing Options to the Assembler}.
360 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
361
362 @item Linker Options
363 @xref{Link Options,,Options for Linking}.
364 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
365 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
366 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
367 -Wl,@var{option}  -Xlinker @var{option} @gol
368 -u @var{symbol}}
369
370 @item Directory Options
371 @xref{Directory Options,,Options for Directory Search}.
372 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
373 -specs=@var{file}  -I- --sysroot=@var{dir}}
374
375 @item Target Options
376 @c I wrote this xref this way to avoid overfull hbox. -- rms
377 @xref{Target Options}.
378 @gccoptlist{-V @var{version}  -b @var{machine}}
379
380 @item Machine Dependent Options
381 @xref{Submodel Options,,Hardware Models and Configurations}.
382 @c This list is ordered alphanumerically by subsection name.
383 @c Try and put the significant identifier (CPU or system) first,
384 @c so users have a clue at guessing where the ones they want will be.
385
386 @emph{ARC Options}
387 @gccoptlist{-EB  -EL @gol
388 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
389 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
390
391 @emph{ARM Options}
392 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
393 -mabi=@var{name} @gol
394 -mapcs-stack-check  -mno-apcs-stack-check @gol
395 -mapcs-float  -mno-apcs-float @gol
396 -mapcs-reentrant  -mno-apcs-reentrant @gol
397 -msched-prolog  -mno-sched-prolog @gol
398 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
399 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
400 -mthumb-interwork  -mno-thumb-interwork @gol
401 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
402 -mstructure-size-boundary=@var{n} @gol
403 -mabort-on-noreturn @gol
404 -mlong-calls  -mno-long-calls @gol
405 -msingle-pic-base  -mno-single-pic-base @gol
406 -mpic-register=@var{reg} @gol
407 -mnop-fun-dllimport @gol
408 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
409 -mpoke-function-name @gol
410 -mthumb  -marm @gol
411 -mtpcs-frame  -mtpcs-leaf-frame @gol
412 -mcaller-super-interworking  -mcallee-super-interworking}
413
414 @emph{AVR Options}
415 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
416 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
417
418 @emph{Blackfin Options}
419 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
420 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
421 -mlow-64k -mno-low64k -mid-shared-library @gol
422 -mno-id-shared-library -mshared-library-id=@var{n} @gol
423 -mlong-calls  -mno-long-calls}
424
425 @emph{CRIS Options}
426 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
427 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
428 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
429 -mstack-align  -mdata-align  -mconst-align @gol
430 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
431 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
432 -mmul-bug-workaround  -mno-mul-bug-workaround}
433
434 @emph{CRX Options}
435 @gccoptlist{-mmac -mpush-args}
436
437 @emph{Darwin Options}
438 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
439 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
440 -client_name  -compatibility_version  -current_version @gol
441 -dead_strip @gol
442 -dependency-file  -dylib_file  -dylinker_install_name @gol
443 -dynamic  -dynamiclib  -exported_symbols_list @gol
444 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
445 -force_flat_namespace  -headerpad_max_install_names @gol
446 -image_base  -init  -install_name  -keep_private_externs @gol
447 -multi_module  -multiply_defined  -multiply_defined_unused @gol
448 -noall_load   -no_dead_strip_inits_and_terms @gol
449 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
450 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
451 -private_bundle  -read_only_relocs  -sectalign @gol
452 -sectobjectsymbols  -whyload  -seg1addr @gol
453 -sectcreate  -sectobjectsymbols  -sectorder @gol
454 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
455 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
456 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
457 -single_module  -static  -sub_library  -sub_umbrella @gol
458 -twolevel_namespace  -umbrella  -undefined @gol
459 -unexported_symbols_list  -weak_reference_mismatches @gol
460 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
461 -mone-byte-bool}
462
463 @emph{DEC Alpha Options}
464 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
465 -mieee  -mieee-with-inexact  -mieee-conformant @gol
466 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
467 -mtrap-precision=@var{mode}  -mbuild-constants @gol
468 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
469 -mbwx  -mmax  -mfix  -mcix @gol
470 -mfloat-vax  -mfloat-ieee @gol
471 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
472 -msmall-text  -mlarge-text @gol
473 -mmemory-latency=@var{time}}
474
475 @emph{DEC Alpha/VMS Options}
476 @gccoptlist{-mvms-return-codes}
477
478 @emph{FRV Options}
479 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
480 -mhard-float  -msoft-float @gol
481 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
482 -mdouble  -mno-double @gol
483 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
484 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
485 -mlinked-fp  -mlong-calls  -malign-labels @gol
486 -mlibrary-pic  -macc-4  -macc-8 @gol
487 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
488 -moptimize-membar -mno-optimize-membar @gol
489 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
490 -mvliw-branch  -mno-vliw-branch @gol
491 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
492 -mno-nested-cond-exec  -mtomcat-stats @gol
493 -mTLS -mtls @gol
494 -mcpu=@var{cpu}}
495
496 @emph{H8/300 Options}
497 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
498
499 @emph{HPPA Options}
500 @gccoptlist{-march=@var{architecture-type} @gol
501 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
502 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
503 -mfixed-range=@var{register-range} @gol
504 -mjump-in-delay -mlinker-opt -mlong-calls @gol
505 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
506 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
507 -mno-jump-in-delay  -mno-long-load-store @gol
508 -mno-portable-runtime  -mno-soft-float @gol
509 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
510 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
511 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
512 -munix=@var{unix-std}  -nolibdld  -static  -threads}
513
514 @emph{i386 and x86-64 Options}
515 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
516 -mfpmath=@var{unit} @gol
517 -masm=@var{dialect}  -mno-fancy-math-387 @gol
518 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
519 -mno-wide-multiply  -mrtd  -malign-double @gol
520 -mpreferred-stack-boundary=@var{num} @gol
521 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
522 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
523 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
524 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
525 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
526 -mcmodel=@var{code-model} @gol
527 -m32  -m64 -mlarge-data-threshold=@var{num}}
528
529 @emph{IA-64 Options}
530 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
531 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
532 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
533 -minline-float-divide-max-throughput @gol
534 -minline-int-divide-min-latency @gol
535 -minline-int-divide-max-throughput  @gol
536 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
537 -mno-dwarf2-asm -mearly-stop-bits @gol
538 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
539 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
540
541 @emph{M32R/D Options}
542 @gccoptlist{-m32r2 -m32rx -m32r @gol
543 -mdebug @gol
544 -malign-loops -mno-align-loops @gol
545 -missue-rate=@var{number} @gol
546 -mbranch-cost=@var{number} @gol
547 -mmodel=@var{code-size-model-type} @gol
548 -msdata=@var{sdata-type} @gol
549 -mno-flush-func -mflush-func=@var{name} @gol
550 -mno-flush-trap -mflush-trap=@var{number} @gol
551 -G @var{num}}
552
553 @emph{M32C Options}
554 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
555
556 @emph{M680x0 Options}
557 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
558 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
559 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
560 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
561 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
562
563 @emph{M68hc1x Options}
564 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
565 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
566 -msoft-reg-count=@var{count}}
567
568 @emph{MCore Options}
569 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
570 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
571 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
572 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
573 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
574
575 @emph{MIPS Options}
576 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
577 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
578 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
579 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
580 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
581 -mdsp  -mpaired-single  -mips3d @gol
582 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
583 -G@var{num}  -membedded-data  -mno-embedded-data @gol
584 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
585 -msplit-addresses  -mno-split-addresses  @gol
586 -mexplicit-relocs  -mno-explicit-relocs  @gol
587 -mcheck-zero-division  -mno-check-zero-division @gol
588 -mdivide-traps  -mdivide-breaks @gol
589 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
590 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
591 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
592 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
593 -mfix-sb1  -mno-fix-sb1 @gol
594 -mflush-func=@var{func}  -mno-flush-func @gol
595 -mbranch-likely  -mno-branch-likely @gol
596 -mfp-exceptions -mno-fp-exceptions @gol
597 -mvr4130-align -mno-vr4130-align}
598
599 @emph{MMIX Options}
600 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
601 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
602 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
603 -mno-base-addresses  -msingle-exit  -mno-single-exit}
604
605 @emph{MN10300 Options}
606 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
607 -mam33  -mno-am33 @gol
608 -mam33-2  -mno-am33-2 @gol
609 -mno-crt0  -mrelax}
610
611 @emph{PDP-11 Options}
612 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
613 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
614 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
615 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
616 -mbranch-expensive  -mbranch-cheap @gol
617 -msplit  -mno-split  -munix-asm  -mdec-asm}
618
619 @emph{PowerPC Options}
620 See RS/6000 and PowerPC Options.
621
622 @emph{RS/6000 and PowerPC Options}
623 @gccoptlist{-mcpu=@var{cpu-type} @gol
624 -mtune=@var{cpu-type} @gol
625 -mpower  -mno-power  -mpower2  -mno-power2 @gol
626 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
627 -maltivec  -mno-altivec @gol
628 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
629 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
630 -mnew-mnemonics  -mold-mnemonics @gol
631 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
632 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
633 -malign-power  -malign-natural @gol
634 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
635 -mstring  -mno-string  -mupdate  -mno-update @gol
636 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
637 -mstrict-align  -mno-strict-align  -mrelocatable @gol
638 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
639 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
640 -mdynamic-no-pic  -maltivec  -mswdiv @gol
641 -mprioritize-restricted-insns=@var{priority} @gol
642 -msched-costly-dep=@var{dependence_type} @gol
643 -minsert-sched-nops=@var{scheme} @gol
644 -mcall-sysv  -mcall-netbsd @gol
645 -maix-struct-return  -msvr4-struct-return @gol
646 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
647 -misel -mno-isel @gol
648 -misel=yes  -misel=no @gol
649 -mspe -mno-spe @gol
650 -mspe=yes  -mspe=no @gol
651 -mvrsave -mno-vrsave @gol
652 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
653 -mprototype  -mno-prototype @gol
654 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
655 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
656
657 @emph{S/390 and zSeries Options}
658 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
659 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
660 -mpacked-stack  -mno-packed-stack @gol
661 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
662 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
663 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
664 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
665
666 @emph{SH Options}
667 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
668 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
669 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
670 -m5-64media  -m5-64media-nofpu @gol
671 -m5-32media  -m5-32media-nofpu @gol
672 -m5-compact  -m5-compact-nofpu @gol
673 -mb  -ml  -mdalign  -mrelax @gol
674 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
675 -mieee  -misize  -mpadstruct  -mspace @gol
676 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
677 -mdivsi3_libfunc=@var{name}  @gol
678 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
679  -minvalid-symbols}
680
681 @emph{SPARC Options}
682 @gccoptlist{-mcpu=@var{cpu-type} @gol
683 -mtune=@var{cpu-type} @gol
684 -mcmodel=@var{code-model} @gol
685 -m32  -m64  -mapp-regs  -mno-app-regs @gol
686 -mfaster-structs  -mno-faster-structs @gol
687 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
688 -mhard-quad-float  -msoft-quad-float @gol
689 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
690 -mstack-bias  -mno-stack-bias @gol
691 -munaligned-doubles  -mno-unaligned-doubles @gol
692 -mv8plus  -mno-v8plus  -mvis  -mno-vis
693 -threads -pthreads}
694
695 @emph{System V Options}
696 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
697
698 @emph{TMS320C3x/C4x Options}
699 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
700 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
701 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
702 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
703
704 @emph{V850 Options}
705 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
706 -mprolog-function  -mno-prolog-function  -mspace @gol
707 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
708 -mapp-regs  -mno-app-regs @gol
709 -mdisable-callt  -mno-disable-callt @gol
710 -mv850e1 @gol
711 -mv850e @gol
712 -mv850  -mbig-switch}
713
714 @emph{VAX Options}
715 @gccoptlist{-mg  -mgnu  -munix}
716
717 @emph{x86-64 Options}
718 See i386 and x86-64 Options.
719
720 @emph{Xstormy16 Options}
721 @gccoptlist{-msim}
722
723 @emph{Xtensa Options}
724 @gccoptlist{-mconst16 -mno-const16 @gol
725 -mfused-madd  -mno-fused-madd @gol
726 -mtext-section-literals  -mno-text-section-literals @gol
727 -mtarget-align  -mno-target-align @gol
728 -mlongcalls  -mno-longcalls}
729
730 @emph{zSeries Options}
731 See S/390 and zSeries Options.
732
733 @item Code Generation Options
734 @xref{Code Gen Options,,Options for Code Generation Conventions}.
735 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
736 -ffixed-@var{reg}  -fexceptions @gol
737 -fnon-call-exceptions  -funwind-tables @gol
738 -fasynchronous-unwind-tables @gol
739 -finhibit-size-directive  -finstrument-functions @gol
740 -fno-common  -fno-ident @gol
741 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
742 -fno-jump-tables @gol
743 -freg-struct-return  -fshared-data  -fshort-enums @gol
744 -fshort-double  -fshort-wchar @gol
745 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
746 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
747 -fargument-alias  -fargument-noalias @gol
748 -fargument-noalias-global  -fleading-underscore @gol
749 -ftls-model=@var{model} @gol
750 -ftrapv  -fwrapv  -fbounds-check @gol
751 -fvisibility}
752 @end table
753
754 @menu
755 * Overall Options::     Controlling the kind of output:
756                         an executable, object files, assembler files,
757                         or preprocessed source.
758 * C Dialect Options::   Controlling the variant of C language compiled.
759 * C++ Dialect Options:: Variations on C++.
760 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
761                         and Objective-C++.
762 * Language Independent Options:: Controlling how diagnostics should be
763                         formatted.
764 * Warning Options::     How picky should the compiler be?
765 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
766 * Optimize Options::    How much optimization?
767 * Preprocessor Options:: Controlling header files and macro definitions.
768                          Also, getting dependency information for Make.
769 * Assembler Options::   Passing options to the assembler.
770 * Link Options::        Specifying libraries and so on.
771 * Directory Options::   Where to find header files and libraries.
772                         Where to find the compiler executable files.
773 * Spec Files::          How to pass switches to sub-processes.
774 * Target Options::      Running a cross-compiler, or an old version of GCC.
775 @end menu
776
777 @node Overall Options
778 @section Options Controlling the Kind of Output
779
780 Compilation can involve up to four stages: preprocessing, compilation
781 proper, assembly and linking, always in that order.  GCC is capable of
782 preprocessing and compiling several files either into several
783 assembler input files, or into one assembler input file; then each
784 assembler input file produces an object file, and linking combines all
785 the object files (those newly compiled, and those specified as input)
786 into an executable file.
787
788 @cindex file name suffix
789 For any given input file, the file name suffix determines what kind of
790 compilation is done:
791
792 @table @gcctabopt
793 @item @var{file}.c
794 C source code which must be preprocessed.
795
796 @item @var{file}.i
797 C source code which should not be preprocessed.
798
799 @item @var{file}.ii
800 C++ source code which should not be preprocessed.
801
802 @item @var{file}.m
803 Objective-C source code.  Note that you must link with the @file{libobjc}
804 library to make an Objective-C program work.
805
806 @item @var{file}.mi
807 Objective-C source code which should not be preprocessed.
808
809 @item @var{file}.mm
810 @itemx @var{file}.M
811 Objective-C++ source code.  Note that you must link with the @file{libobjc}
812 library to make an Objective-C++ program work.  Note that @samp{.M} refers
813 to a literal capital M@.
814
815 @item @var{file}.mii
816 Objective-C++ source code which should not be preprocessed.
817
818 @item @var{file}.h
819 C, C++, Objective-C or Objective-C++ header file to be turned into a
820 precompiled header.
821
822 @item @var{file}.cc
823 @itemx @var{file}.cp
824 @itemx @var{file}.cxx
825 @itemx @var{file}.cpp
826 @itemx @var{file}.CPP
827 @itemx @var{file}.c++
828 @itemx @var{file}.C
829 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
830 the last two letters must both be literally @samp{x}.  Likewise,
831 @samp{.C} refers to a literal capital C@.
832
833 @item @var{file}.mm
834 @itemx @var{file}.M
835 Objective-C++ source code which must be preprocessed.
836
837 @item @var{file}.mii
838 Objective-C++ source code which should not be preprocessed.
839
840 @item @var{file}.hh
841 @itemx @var{file}.H
842 C++ header file to be turned into a precompiled header.
843
844 @item @var{file}.f
845 @itemx @var{file}.for
846 @itemx @var{file}.FOR
847 Fortran source code which should not be preprocessed.
848
849 @item @var{file}.F
850 @itemx @var{file}.fpp
851 @itemx @var{file}.FPP
852 Fortran source code which must be preprocessed (with the traditional
853 preprocessor).
854
855 @item @var{file}.r
856 Fortran source code which must be preprocessed with a RATFOR
857 preprocessor (not included with GCC)@.
858
859 @item @var{file}.f90
860 @itemx @var{file}.f95
861 Fortran 90/95 source code which should not be preprocessed.
862
863 @item @var{file}.F90
864 @itemx @var{file}.F95
865 Fortran 90/95 source code which must be preprocessed (with the
866 traditional preprocessor).
867
868 @c FIXME: Descriptions of Java file types.
869 @c @var{file}.java
870 @c @var{file}.class
871 @c @var{file}.zip
872 @c @var{file}.jar
873
874 @item @var{file}.ads
875 Ada source code file which contains a library unit declaration (a
876 declaration of a package, subprogram, or generic, or a generic
877 instantiation), or a library unit renaming declaration (a package,
878 generic, or subprogram renaming declaration).  Such files are also
879 called @dfn{specs}.
880
881 @itemx @var{file}.adb
882 Ada source code file containing a library unit body (a subprogram or
883 package body).  Such files are also called @dfn{bodies}.
884
885 @c GCC also knows about some suffixes for languages not yet included:
886 @c Pascal:
887 @c @var{file}.p
888 @c @var{file}.pas
889
890 @item @var{file}.s
891 Assembler code.
892
893 @item @var{file}.S
894 Assembler code which must be preprocessed.
895
896 @item @var{other}
897 An object file to be fed straight into linking.
898 Any file name with no recognized suffix is treated this way.
899 @end table
900
901 @opindex x
902 You can specify the input language explicitly with the @option{-x} option:
903
904 @table @gcctabopt
905 @item -x @var{language}
906 Specify explicitly the @var{language} for the following input files
907 (rather than letting the compiler choose a default based on the file
908 name suffix).  This option applies to all following input files until
909 the next @option{-x} option.  Possible values for @var{language} are:
910 @smallexample
911 c  c-header  c-cpp-output
912 c++  c++-header  c++-cpp-output
913 objective-c  objective-c-header  objective-c-cpp-output
914 objective-c++ objective-c++-header objective-c++-cpp-output
915 assembler  assembler-with-cpp
916 ada
917 f77  f77-cpp-input  ratfor
918 f95
919 java
920 treelang
921 @end smallexample
922
923 @item -x none
924 Turn off any specification of a language, so that subsequent files are
925 handled according to their file name suffixes (as they are if @option{-x}
926 has not been used at all).
927
928 @item -pass-exit-codes
929 @opindex pass-exit-codes
930 Normally the @command{gcc} program will exit with the code of 1 if any
931 phase of the compiler returns a non-success return code.  If you specify
932 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
933 numerically highest error produced by any phase that returned an error
934 indication.
935 @end table
936
937 If you only want some of the stages of compilation, you can use
938 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
939 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
940 @command{gcc} is to stop.  Note that some combinations (for example,
941 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
942
943 @table @gcctabopt
944 @item -c
945 @opindex c
946 Compile or assemble the source files, but do not link.  The linking
947 stage simply is not done.  The ultimate output is in the form of an
948 object file for each source file.
949
950 By default, the object file name for a source file is made by replacing
951 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
952
953 Unrecognized input files, not requiring compilation or assembly, are
954 ignored.
955
956 @item -S
957 @opindex S
958 Stop after the stage of compilation proper; do not assemble.  The output
959 is in the form of an assembler code file for each non-assembler input
960 file specified.
961
962 By default, the assembler file name for a source file is made by
963 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
964
965 Input files that don't require compilation are ignored.
966
967 @item -E
968 @opindex E
969 Stop after the preprocessing stage; do not run the compiler proper.  The
970 output is in the form of preprocessed source code, which is sent to the
971 standard output.
972
973 Input files which don't require preprocessing are ignored.
974
975 @cindex output file option
976 @item -o @var{file}
977 @opindex o
978 Place output in file @var{file}.  This applies regardless to whatever
979 sort of output is being produced, whether it be an executable file,
980 an object file, an assembler file or preprocessed C code.
981
982 If @option{-o} is not specified, the default is to put an executable
983 file in @file{a.out}, the object file for
984 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
985 assembler file in @file{@var{source}.s}, a precompiled header file in
986 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
987 standard output.
988
989 @item -v
990 @opindex v
991 Print (on standard error output) the commands executed to run the stages
992 of compilation.  Also print the version number of the compiler driver
993 program and of the preprocessor and the compiler proper.
994
995 @item -###
996 @opindex ###
997 Like @option{-v} except the commands are not executed and all command
998 arguments are quoted.  This is useful for shell scripts to capture the
999 driver-generated command lines.
1000
1001 @item -pipe
1002 @opindex pipe
1003 Use pipes rather than temporary files for communication between the
1004 various stages of compilation.  This fails to work on some systems where
1005 the assembler is unable to read from a pipe; but the GNU assembler has
1006 no trouble.
1007
1008 @item -combine
1009 @opindex combine
1010 If you are compiling multiple source files, this option tells the driver
1011 to pass all the source files to the compiler at once (for those
1012 languages for which the compiler can handle this).  This will allow
1013 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1014 language for which this is supported is C@.  If you pass source files for
1015 multiple languages to the driver, using this option, the driver will invoke
1016 the compiler(s) that support IMA once each, passing each compiler all the
1017 source files appropriate for it.  For those languages that do not support
1018 IMA this option will be ignored, and the compiler will be invoked once for
1019 each source file in that language.  If you use this option in conjunction
1020 with @option{-save-temps}, the compiler will generate multiple
1021 pre-processed files
1022 (one for each source file), but only one (combined) @file{.o} or
1023 @file{.s} file.
1024
1025 @item --help
1026 @opindex help
1027 Print (on the standard output) a description of the command line options
1028 understood by @command{gcc}.  If the @option{-v} option is also specified
1029 then @option{--help} will also be passed on to the various processes
1030 invoked by @command{gcc}, so that they can display the command line options
1031 they accept.  If the @option{-Wextra} option is also specified then command
1032 line options which have no documentation associated with them will also
1033 be displayed.
1034
1035 @item --target-help
1036 @opindex target-help
1037 Print (on the standard output) a description of target specific command
1038 line options for each tool.
1039
1040 @item --version
1041 @opindex version
1042 Display the version number and copyrights of the invoked GCC@.
1043 @end table
1044
1045 @node Invoking G++
1046 @section Compiling C++ Programs
1047
1048 @cindex suffixes for C++ source
1049 @cindex C++ source file suffixes
1050 C++ source files conventionally use one of the suffixes @samp{.C},
1051 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1052 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1053 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1054 files with these names and compiles them as C++ programs even if you
1055 call the compiler the same way as for compiling C programs (usually
1056 with the name @command{gcc}).
1057
1058 @findex g++
1059 @findex c++
1060 However, C++ programs often require class libraries as well as a
1061 compiler that understands the C++ language---and under some
1062 circumstances, you might want to compile programs or header files from
1063 standard input, or otherwise without a suffix that flags them as C++
1064 programs.  You might also like to precompile a C header file with a
1065 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1066 program that calls GCC with the default language set to C++, and
1067 automatically specifies linking against the C++ library.  On many
1068 systems, @command{g++} is also installed with the name @command{c++}.
1069
1070 @cindex invoking @command{g++}
1071 When you compile C++ programs, you may specify many of the same
1072 command-line options that you use for compiling programs in any
1073 language; or command-line options meaningful for C and related
1074 languages; or options that are meaningful only for C++ programs.
1075 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1076 explanations of options for languages related to C@.
1077 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1078 explanations of options that are meaningful only for C++ programs.
1079
1080 @node C Dialect Options
1081 @section Options Controlling C Dialect
1082 @cindex dialect options
1083 @cindex language dialect options
1084 @cindex options, dialect
1085
1086 The following options control the dialect of C (or languages derived
1087 from C, such as C++, Objective-C and Objective-C++) that the compiler
1088 accepts:
1089
1090 @table @gcctabopt
1091 @cindex ANSI support
1092 @cindex ISO support
1093 @item -ansi
1094 @opindex ansi
1095 In C mode, support all ISO C90 programs.  In C++ mode,
1096 remove GNU extensions that conflict with ISO C++.
1097
1098 This turns off certain features of GCC that are incompatible with ISO
1099 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1100 such as the @code{asm} and @code{typeof} keywords, and
1101 predefined macros such as @code{unix} and @code{vax} that identify the
1102 type of system you are using.  It also enables the undesirable and
1103 rarely used ISO trigraph feature.  For the C compiler,
1104 it disables recognition of C++ style @samp{//} comments as well as
1105 the @code{inline} keyword.
1106
1107 The alternate keywords @code{__asm__}, @code{__extension__},
1108 @code{__inline__} and @code{__typeof__} continue to work despite
1109 @option{-ansi}.  You would not want to use them in an ISO C program, of
1110 course, but it is useful to put them in header files that might be included
1111 in compilations done with @option{-ansi}.  Alternate predefined macros
1112 such as @code{__unix__} and @code{__vax__} are also available, with or
1113 without @option{-ansi}.
1114
1115 The @option{-ansi} option does not cause non-ISO programs to be
1116 rejected gratuitously.  For that, @option{-pedantic} is required in
1117 addition to @option{-ansi}.  @xref{Warning Options}.
1118
1119 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1120 option is used.  Some header files may notice this macro and refrain
1121 from declaring certain functions or defining certain macros that the
1122 ISO standard doesn't call for; this is to avoid interfering with any
1123 programs that might use these names for other things.
1124
1125 Functions which would normally be built in but do not have semantics
1126 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1127 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1128 built-in functions provided by GCC}, for details of the functions
1129 affected.
1130
1131 @item -std=
1132 @opindex std
1133 Determine the language standard.  This option is currently only
1134 supported when compiling C or C++.  A value for this option must be
1135 provided; possible values are
1136
1137 @table @samp
1138 @item c89
1139 @itemx iso9899:1990
1140 ISO C90 (same as @option{-ansi}).
1141
1142 @item iso9899:199409
1143 ISO C90 as modified in amendment 1.
1144
1145 @item c99
1146 @itemx c9x
1147 @itemx iso9899:1999
1148 @itemx iso9899:199x
1149 ISO C99.  Note that this standard is not yet fully supported; see
1150 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1151 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1152
1153 @item gnu89
1154 Default, ISO C90 plus GNU extensions (including some C99 features).
1155
1156 @item gnu99
1157 @itemx gnu9x
1158 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1159 this will become the default.  The name @samp{gnu9x} is deprecated.
1160
1161 @item c++98
1162 The 1998 ISO C++ standard plus amendments.
1163
1164 @item gnu++98
1165 The same as @option{-std=c++98} plus GNU extensions.  This is the
1166 default for C++ code.
1167 @end table
1168
1169 Even when this option is not specified, you can still use some of the
1170 features of newer standards in so far as they do not conflict with
1171 previous C standards.  For example, you may use @code{__restrict__} even
1172 when @option{-std=c99} is not specified.
1173
1174 The @option{-std} options specifying some version of ISO C have the same
1175 effects as @option{-ansi}, except that features that were not in ISO C90
1176 but are in the specified version (for example, @samp{//} comments and
1177 the @code{inline} keyword in ISO C99) are not disabled.
1178
1179 @xref{Standards,,Language Standards Supported by GCC}, for details of
1180 these standard versions.
1181
1182 @item -aux-info @var{filename}
1183 @opindex aux-info
1184 Output to the given filename prototyped declarations for all functions
1185 declared and/or defined in a translation unit, including those in header
1186 files.  This option is silently ignored in any language other than C@.
1187
1188 Besides declarations, the file indicates, in comments, the origin of
1189 each declaration (source file and line), whether the declaration was
1190 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1191 @samp{O} for old, respectively, in the first character after the line
1192 number and the colon), and whether it came from a declaration or a
1193 definition (@samp{C} or @samp{F}, respectively, in the following
1194 character).  In the case of function definitions, a K&R-style list of
1195 arguments followed by their declarations is also provided, inside
1196 comments, after the declaration.
1197
1198 @item -fno-asm
1199 @opindex fno-asm
1200 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1201 keyword, so that code can use these words as identifiers.  You can use
1202 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1203 instead.  @option{-ansi} implies @option{-fno-asm}.
1204
1205 In C++, this switch only affects the @code{typeof} keyword, since
1206 @code{asm} and @code{inline} are standard keywords.  You may want to
1207 use the @option{-fno-gnu-keywords} flag instead, which has the same
1208 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1209 switch only affects the @code{asm} and @code{typeof} keywords, since
1210 @code{inline} is a standard keyword in ISO C99.
1211
1212 @item -fno-builtin
1213 @itemx -fno-builtin-@var{function}
1214 @opindex fno-builtin
1215 @cindex built-in functions
1216 Don't recognize built-in functions that do not begin with
1217 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1218 functions provided by GCC}, for details of the functions affected,
1219 including those which are not built-in functions when @option{-ansi} or
1220 @option{-std} options for strict ISO C conformance are used because they
1221 do not have an ISO standard meaning.
1222
1223 GCC normally generates special code to handle certain built-in functions
1224 more efficiently; for instance, calls to @code{alloca} may become single
1225 instructions that adjust the stack directly, and calls to @code{memcpy}
1226 may become inline copy loops.  The resulting code is often both smaller
1227 and faster, but since the function calls no longer appear as such, you
1228 cannot set a breakpoint on those calls, nor can you change the behavior
1229 of the functions by linking with a different library.  In addition,
1230 when a function is recognized as a built-in function, GCC may use
1231 information about that function to warn about problems with calls to
1232 that function, or to generate more efficient code, even if the
1233 resulting code still contains calls to that function.  For example,
1234 warnings are given with @option{-Wformat} for bad calls to
1235 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1236 known not to modify global memory.
1237
1238 With the @option{-fno-builtin-@var{function}} option
1239 only the built-in function @var{function} is
1240 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1241 function is named this is not built-in in this version of GCC, this
1242 option is ignored.  There is no corresponding
1243 @option{-fbuiltin-@var{function}} option; if you wish to enable
1244 built-in functions selectively when using @option{-fno-builtin} or
1245 @option{-ffreestanding}, you may define macros such as:
1246
1247 @smallexample
1248 #define abs(n)          __builtin_abs ((n))
1249 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1250 @end smallexample
1251
1252 @item -fhosted
1253 @opindex fhosted
1254 @cindex hosted environment
1255
1256 Assert that compilation takes place in a hosted environment.  This implies
1257 @option{-fbuiltin}.  A hosted environment is one in which the
1258 entire standard library is available, and in which @code{main} has a return
1259 type of @code{int}.  Examples are nearly everything except a kernel.
1260 This is equivalent to @option{-fno-freestanding}.
1261
1262 @item -ffreestanding
1263 @opindex ffreestanding
1264 @cindex hosted environment
1265
1266 Assert that compilation takes place in a freestanding environment.  This
1267 implies @option{-fno-builtin}.  A freestanding environment
1268 is one in which the standard library may not exist, and program startup may
1269 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1270 This is equivalent to @option{-fno-hosted}.
1271
1272 @xref{Standards,,Language Standards Supported by GCC}, for details of
1273 freestanding and hosted environments.
1274
1275 @item -fms-extensions
1276 @opindex fms-extensions
1277 Accept some non-standard constructs used in Microsoft header files.
1278
1279 Some cases of unnamed fields in structures and unions are only
1280 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1281 fields within structs/unions}, for details.
1282
1283 @item -trigraphs
1284 @opindex trigraphs
1285 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1286 options for strict ISO C conformance) implies @option{-trigraphs}.
1287
1288 @item -no-integrated-cpp
1289 @opindex no-integrated-cpp
1290 Performs a compilation in two passes: preprocessing and compiling.  This
1291 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1292 @option{-B} option.  The user supplied compilation step can then add in
1293 an additional preprocessing step after normal preprocessing but before
1294 compiling.  The default is to use the integrated cpp (internal cpp)
1295
1296 The semantics of this option will change if "cc1", "cc1plus", and
1297 "cc1obj" are merged.
1298
1299 @cindex traditional C language
1300 @cindex C language, traditional
1301 @item -traditional
1302 @itemx -traditional-cpp
1303 @opindex traditional-cpp
1304 @opindex traditional
1305 Formerly, these options caused GCC to attempt to emulate a pre-standard
1306 C compiler.  They are now only supported with the @option{-E} switch.
1307 The preprocessor continues to support a pre-standard mode.  See the GNU
1308 CPP manual for details.
1309
1310 @item -fcond-mismatch
1311 @opindex fcond-mismatch
1312 Allow conditional expressions with mismatched types in the second and
1313 third arguments.  The value of such an expression is void.  This option
1314 is not supported for C++.
1315
1316 @item -funsigned-char
1317 @opindex funsigned-char
1318 Let the type @code{char} be unsigned, like @code{unsigned char}.
1319
1320 Each kind of machine has a default for what @code{char} should
1321 be.  It is either like @code{unsigned char} by default or like
1322 @code{signed char} by default.
1323
1324 Ideally, a portable program should always use @code{signed char} or
1325 @code{unsigned char} when it depends on the signedness of an object.
1326 But many programs have been written to use plain @code{char} and
1327 expect it to be signed, or expect it to be unsigned, depending on the
1328 machines they were written for.  This option, and its inverse, let you
1329 make such a program work with the opposite default.
1330
1331 The type @code{char} is always a distinct type from each of
1332 @code{signed char} or @code{unsigned char}, even though its behavior
1333 is always just like one of those two.
1334
1335 @item -fsigned-char
1336 @opindex fsigned-char
1337 Let the type @code{char} be signed, like @code{signed char}.
1338
1339 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1340 the negative form of @option{-funsigned-char}.  Likewise, the option
1341 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1342
1343 @item -fsigned-bitfields
1344 @itemx -funsigned-bitfields
1345 @itemx -fno-signed-bitfields
1346 @itemx -fno-unsigned-bitfields
1347 @opindex fsigned-bitfields
1348 @opindex funsigned-bitfields
1349 @opindex fno-signed-bitfields
1350 @opindex fno-unsigned-bitfields
1351 These options control whether a bit-field is signed or unsigned, when the
1352 declaration does not use either @code{signed} or @code{unsigned}.  By
1353 default, such a bit-field is signed, because this is consistent: the
1354 basic integer types such as @code{int} are signed types.
1355 @end table
1356
1357 @node C++ Dialect Options
1358 @section Options Controlling C++ Dialect
1359
1360 @cindex compiler options, C++
1361 @cindex C++ options, command line
1362 @cindex options, C++
1363 This section describes the command-line options that are only meaningful
1364 for C++ programs; but you can also use most of the GNU compiler options
1365 regardless of what language your program is in.  For example, you
1366 might compile a file @code{firstClass.C} like this:
1367
1368 @smallexample
1369 g++ -g -frepo -O -c firstClass.C
1370 @end smallexample
1371
1372 @noindent
1373 In this example, only @option{-frepo} is an option meant
1374 only for C++ programs; you can use the other options with any
1375 language supported by GCC@.
1376
1377 Here is a list of options that are @emph{only} for compiling C++ programs:
1378
1379 @table @gcctabopt
1380
1381 @item -fabi-version=@var{n}
1382 @opindex fabi-version
1383 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1384 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1385 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1386 the version that conforms most closely to the C++ ABI specification.
1387 Therefore, the ABI obtained using version 0 will change as ABI bugs
1388 are fixed.
1389
1390 The default is version 2.
1391
1392 @item -fno-access-control
1393 @opindex fno-access-control
1394 Turn off all access checking.  This switch is mainly useful for working
1395 around bugs in the access control code.
1396
1397 @item -fcheck-new
1398 @opindex fcheck-new
1399 Check that the pointer returned by @code{operator new} is non-null
1400 before attempting to modify the storage allocated.  This check is
1401 normally unnecessary because the C++ standard specifies that
1402 @code{operator new} will only return @code{0} if it is declared
1403 @samp{throw()}, in which case the compiler will always check the
1404 return value even without this option.  In all other cases, when
1405 @code{operator new} has a non-empty exception specification, memory
1406 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1407 @samp{new (nothrow)}.
1408
1409 @item -fconserve-space
1410 @opindex fconserve-space
1411 Put uninitialized or runtime-initialized global variables into the
1412 common segment, as C does.  This saves space in the executable at the
1413 cost of not diagnosing duplicate definitions.  If you compile with this
1414 flag and your program mysteriously crashes after @code{main()} has
1415 completed, you may have an object that is being destroyed twice because
1416 two definitions were merged.
1417
1418 This option is no longer useful on most targets, now that support has
1419 been added for putting variables into BSS without making them common.
1420
1421 @item -fno-const-strings
1422 @opindex fno-const-strings
1423 Give string constants type @code{char *} instead of type @code{const
1424 char *}.  By default, G++ uses type @code{const char *} as required by
1425 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1426 actually modify the value of a string constant.
1427
1428 This option might be removed in a future release of G++.  For maximum
1429 portability, you should structure your code so that it works with
1430 string constants that have type @code{const char *}.
1431
1432 @item -fno-elide-constructors
1433 @opindex fno-elide-constructors
1434 The C++ standard allows an implementation to omit creating a temporary
1435 which is only used to initialize another object of the same type.
1436 Specifying this option disables that optimization, and forces G++ to
1437 call the copy constructor in all cases.
1438
1439 @item -fno-enforce-eh-specs
1440 @opindex fno-enforce-eh-specs
1441 Don't check for violation of exception specifications at runtime.  This
1442 option violates the C++ standard, but may be useful for reducing code
1443 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1444 will still optimize based on the exception specifications.
1445
1446 @item -ffor-scope
1447 @itemx -fno-for-scope
1448 @opindex ffor-scope
1449 @opindex fno-for-scope
1450 If @option{-ffor-scope} is specified, the scope of variables declared in
1451 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1452 as specified by the C++ standard.
1453 If @option{-fno-for-scope} is specified, the scope of variables declared in
1454 a @i{for-init-statement} extends to the end of the enclosing scope,
1455 as was the case in old versions of G++, and other (traditional)
1456 implementations of C++.
1457
1458 The default if neither flag is given to follow the standard,
1459 but to allow and give a warning for old-style code that would
1460 otherwise be invalid, or have different behavior.
1461
1462 @item -fno-gnu-keywords
1463 @opindex fno-gnu-keywords
1464 Do not recognize @code{typeof} as a keyword, so that code can use this
1465 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1466 @option{-ansi} implies @option{-fno-gnu-keywords}.
1467
1468 @item -fno-implicit-templates
1469 @opindex fno-implicit-templates
1470 Never emit code for non-inline templates which are instantiated
1471 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1472 @xref{Template Instantiation}, for more information.
1473
1474 @item -fno-implicit-inline-templates
1475 @opindex fno-implicit-inline-templates
1476 Don't emit code for implicit instantiations of inline templates, either.
1477 The default is to handle inlines differently so that compiles with and
1478 without optimization will need the same set of explicit instantiations.
1479
1480 @item -fno-implement-inlines
1481 @opindex fno-implement-inlines
1482 To save space, do not emit out-of-line copies of inline functions
1483 controlled by @samp{#pragma implementation}.  This will cause linker
1484 errors if these functions are not inlined everywhere they are called.
1485
1486 @item -fms-extensions
1487 @opindex fms-extensions
1488 Disable pedantic warnings about constructs used in MFC, such as implicit
1489 int and getting a pointer to member function via non-standard syntax.
1490
1491 @item -fno-nonansi-builtins
1492 @opindex fno-nonansi-builtins
1493 Disable built-in declarations of functions that are not mandated by
1494 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1495 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1496
1497 @item -fno-operator-names
1498 @opindex fno-operator-names
1499 Do not treat the operator name keywords @code{and}, @code{bitand},
1500 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1501 synonyms as keywords.
1502
1503 @item -fno-optional-diags
1504 @opindex fno-optional-diags
1505 Disable diagnostics that the standard says a compiler does not need to
1506 issue.  Currently, the only such diagnostic issued by G++ is the one for
1507 a name having multiple meanings within a class.
1508
1509 @item -fpermissive
1510 @opindex fpermissive
1511 Downgrade some diagnostics about nonconformant code from errors to
1512 warnings.  Thus, using @option{-fpermissive} will allow some
1513 nonconforming code to compile.
1514
1515 @item -frepo
1516 @opindex frepo
1517 Enable automatic template instantiation at link time.  This option also
1518 implies @option{-fno-implicit-templates}.  @xref{Template
1519 Instantiation}, for more information.
1520
1521 @item -fno-rtti
1522 @opindex fno-rtti
1523 Disable generation of information about every class with virtual
1524 functions for use by the C++ runtime type identification features
1525 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1526 of the language, you can save some space by using this flag.  Note that
1527 exception handling uses the same information, but it will generate it as
1528 needed.
1529
1530 @item -fstats
1531 @opindex fstats
1532 Emit statistics about front-end processing at the end of the compilation.
1533 This information is generally only useful to the G++ development team.
1534
1535 @item -ftemplate-depth-@var{n}
1536 @opindex ftemplate-depth
1537 Set the maximum instantiation depth for template classes to @var{n}.
1538 A limit on the template instantiation depth is needed to detect
1539 endless recursions during template class instantiation.  ANSI/ISO C++
1540 conforming programs must not rely on a maximum depth greater than 17.
1541
1542 @item -fno-threadsafe-statics
1543 @opindex fno-threadsafe-statics
1544 Do not emit the extra code to use the routines specified in the C++
1545 ABI for thread-safe initialization of local statics.  You can use this
1546 option to reduce code size slightly in code that doesn't need to be
1547 thread-safe.
1548
1549 @item -fuse-cxa-atexit
1550 @opindex fuse-cxa-atexit
1551 Register destructors for objects with static storage duration with the
1552 @code{__cxa_atexit} function rather than the @code{atexit} function.
1553 This option is required for fully standards-compliant handling of static
1554 destructors, but will only work if your C library supports
1555 @code{__cxa_atexit}.
1556
1557 @item -fvisibility-inlines-hidden
1558 @opindex fvisibility-inlines-hidden
1559 Causes all inlined methods to be marked with
1560 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1561 appear in the export table of a DSO and do not require a PLT indirection
1562 when used within the DSO@.  Enabling this option can have a dramatic effect
1563 on load and link times of a DSO as it massively reduces the size of the
1564 dynamic export table when the library makes heavy use of templates.  While
1565 it can cause bloating through duplication of code within each DSO where
1566 it is used, often the wastage is less than the considerable space occupied
1567 by a long symbol name in the export table which is typical when using
1568 templates and namespaces.  For even more savings, combine with the
1569 @option{-fvisibility=hidden} switch.
1570
1571 @item -fno-weak
1572 @opindex fno-weak
1573 Do not use weak symbol support, even if it is provided by the linker.
1574 By default, G++ will use weak symbols if they are available.  This
1575 option exists only for testing, and should not be used by end-users;
1576 it will result in inferior code and has no benefits.  This option may
1577 be removed in a future release of G++.
1578
1579 @item -nostdinc++
1580 @opindex nostdinc++
1581 Do not search for header files in the standard directories specific to
1582 C++, but do still search the other standard directories.  (This option
1583 is used when building the C++ library.)
1584 @end table
1585
1586 In addition, these optimization, warning, and code generation options
1587 have meanings only for C++ programs:
1588
1589 @table @gcctabopt
1590 @item -fno-default-inline
1591 @opindex fno-default-inline
1592 Do not assume @samp{inline} for functions defined inside a class scope.
1593 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1594 functions will have linkage like inline functions; they just won't be
1595 inlined by default.
1596
1597 @item -Wabi @r{(C++ only)}
1598 @opindex Wabi
1599 Warn when G++ generates code that is probably not compatible with the
1600 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1601 all such cases, there are probably some cases that are not warned about,
1602 even though G++ is generating incompatible code.  There may also be
1603 cases where warnings are emitted even though the code that is generated
1604 will be compatible.
1605
1606 You should rewrite your code to avoid these warnings if you are
1607 concerned about the fact that code generated by G++ may not be binary
1608 compatible with code generated by other compilers.
1609
1610 The known incompatibilities at this point include:
1611
1612 @itemize @bullet
1613
1614 @item
1615 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1616 pack data into the same byte as a base class.  For example:
1617
1618 @smallexample
1619 struct A @{ virtual void f(); int f1 : 1; @};
1620 struct B : public A @{ int f2 : 1; @};
1621 @end smallexample
1622
1623 @noindent
1624 In this case, G++ will place @code{B::f2} into the same byte
1625 as@code{A::f1}; other compilers will not.  You can avoid this problem
1626 by explicitly padding @code{A} so that its size is a multiple of the
1627 byte size on your platform; that will cause G++ and other compilers to
1628 layout @code{B} identically.
1629
1630 @item
1631 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1632 tail padding when laying out virtual bases.  For example:
1633
1634 @smallexample
1635 struct A @{ virtual void f(); char c1; @};
1636 struct B @{ B(); char c2; @};
1637 struct C : public A, public virtual B @{@};
1638 @end smallexample
1639
1640 @noindent
1641 In this case, G++ will not place @code{B} into the tail-padding for
1642 @code{A}; other compilers will.  You can avoid this problem by
1643 explicitly padding @code{A} so that its size is a multiple of its
1644 alignment (ignoring virtual base classes); that will cause G++ and other
1645 compilers to layout @code{C} identically.
1646
1647 @item
1648 Incorrect handling of bit-fields with declared widths greater than that
1649 of their underlying types, when the bit-fields appear in a union.  For
1650 example:
1651
1652 @smallexample
1653 union U @{ int i : 4096; @};
1654 @end smallexample
1655
1656 @noindent
1657 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1658 union too small by the number of bits in an @code{int}.
1659
1660 @item
1661 Empty classes can be placed at incorrect offsets.  For example:
1662
1663 @smallexample
1664 struct A @{@};
1665
1666 struct B @{
1667   A a;
1668   virtual void f ();
1669 @};
1670
1671 struct C : public B, public A @{@};
1672 @end smallexample
1673
1674 @noindent
1675 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1676 it should be placed at offset zero.  G++ mistakenly believes that the
1677 @code{A} data member of @code{B} is already at offset zero.
1678
1679 @item
1680 Names of template functions whose types involve @code{typename} or
1681 template template parameters can be mangled incorrectly.
1682
1683 @smallexample
1684 template <typename Q>
1685 void f(typename Q::X) @{@}
1686
1687 template <template <typename> class Q>
1688 void f(typename Q<int>::X) @{@}
1689 @end smallexample
1690
1691 @noindent
1692 Instantiations of these templates may be mangled incorrectly.
1693
1694 @end itemize
1695
1696 @item -Wctor-dtor-privacy @r{(C++ only)}
1697 @opindex Wctor-dtor-privacy
1698 Warn when a class seems unusable because all the constructors or
1699 destructors in that class are private, and it has neither friends nor
1700 public static member functions.
1701
1702 @item -Wnon-virtual-dtor @r{(C++ only)}
1703 @opindex Wnon-virtual-dtor
1704 Warn when a class appears to be polymorphic, thereby requiring a virtual
1705 destructor, yet it declares a non-virtual one.
1706 This warning is enabled by @option{-Wall}.
1707
1708 @item -Wreorder @r{(C++ only)}
1709 @opindex Wreorder
1710 @cindex reordering, warning
1711 @cindex warning for reordering of member initializers
1712 Warn when the order of member initializers given in the code does not
1713 match the order in which they must be executed.  For instance:
1714
1715 @smallexample
1716 struct A @{
1717   int i;
1718   int j;
1719   A(): j (0), i (1) @{ @}
1720 @};
1721 @end smallexample
1722
1723 The compiler will rearrange the member initializers for @samp{i}
1724 and @samp{j} to match the declaration order of the members, emitting
1725 a warning to that effect.  This warning is enabled by @option{-Wall}.
1726 @end table
1727
1728 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1729
1730 @table @gcctabopt
1731 @item -Weffc++ @r{(C++ only)}
1732 @opindex Weffc++
1733 Warn about violations of the following style guidelines from Scott Meyers'
1734 @cite{Effective C++} book:
1735
1736 @itemize @bullet
1737 @item
1738 Item 11:  Define a copy constructor and an assignment operator for classes
1739 with dynamically allocated memory.
1740
1741 @item
1742 Item 12:  Prefer initialization to assignment in constructors.
1743
1744 @item
1745 Item 14:  Make destructors virtual in base classes.
1746
1747 @item
1748 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1749
1750 @item
1751 Item 23:  Don't try to return a reference when you must return an object.
1752
1753 @end itemize
1754
1755 Also warn about violations of the following style guidelines from
1756 Scott Meyers' @cite{More Effective C++} book:
1757
1758 @itemize @bullet
1759 @item
1760 Item 6:  Distinguish between prefix and postfix forms of increment and
1761 decrement operators.
1762
1763 @item
1764 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1765
1766 @end itemize
1767
1768 When selecting this option, be aware that the standard library
1769 headers do not obey all of these guidelines; use @samp{grep -v}
1770 to filter out those warnings.
1771
1772 @item -Wno-deprecated @r{(C++ only)}
1773 @opindex Wno-deprecated
1774 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1775
1776 @item -Wstrict-null-sentinel @r{(C++ only)}
1777 @opindex Wstrict-null-sentinel
1778 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1779 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1780 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1781 it is guaranteed to of the same size as a pointer.  But this use is
1782 not portable across different compilers.
1783
1784 @item -Wno-non-template-friend @r{(C++ only)}
1785 @opindex Wno-non-template-friend
1786 Disable warnings when non-templatized friend functions are declared
1787 within a template.  Since the advent of explicit template specification
1788 support in G++, if the name of the friend is an unqualified-id (i.e.,
1789 @samp{friend foo(int)}), the C++ language specification demands that the
1790 friend declare or define an ordinary, nontemplate function.  (Section
1791 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1792 could be interpreted as a particular specialization of a templatized
1793 function.  Because this non-conforming behavior is no longer the default
1794 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1795 check existing code for potential trouble spots and is on by default.
1796 This new compiler behavior can be turned off with
1797 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1798 but disables the helpful warning.
1799
1800 @item -Wold-style-cast @r{(C++ only)}
1801 @opindex Wold-style-cast
1802 Warn if an old-style (C-style) cast to a non-void type is used within
1803 a C++ program.  The new-style casts (@samp{dynamic_cast},
1804 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1805 less vulnerable to unintended effects and much easier to search for.
1806
1807 @item -Woverloaded-virtual @r{(C++ only)}
1808 @opindex Woverloaded-virtual
1809 @cindex overloaded virtual fn, warning
1810 @cindex warning for overloaded virtual fn
1811 Warn when a function declaration hides virtual functions from a
1812 base class.  For example, in:
1813
1814 @smallexample
1815 struct A @{
1816   virtual void f();
1817 @};
1818
1819 struct B: public A @{
1820   void f(int);
1821 @};
1822 @end smallexample
1823
1824 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1825 like:
1826
1827 @smallexample
1828 B* b;
1829 b->f();
1830 @end smallexample
1831
1832 will fail to compile.
1833
1834 @item -Wno-pmf-conversions @r{(C++ only)}
1835 @opindex Wno-pmf-conversions
1836 Disable the diagnostic for converting a bound pointer to member function
1837 to a plain pointer.
1838
1839 @item -Wsign-promo @r{(C++ only)}
1840 @opindex Wsign-promo
1841 Warn when overload resolution chooses a promotion from unsigned or
1842 enumerated type to a signed type, over a conversion to an unsigned type of
1843 the same size.  Previous versions of G++ would try to preserve
1844 unsignedness, but the standard mandates the current behavior.
1845
1846 @smallexample
1847 struct A @{
1848   operator int ();
1849   A& operator = (int);
1850 @};
1851
1852 main ()
1853 @{
1854   A a,b;
1855   a = b;
1856 @}
1857 @end smallexample
1858
1859 In this example, G++ will synthesize a default @samp{A& operator =
1860 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1861 @end table
1862
1863 @node Objective-C and Objective-C++ Dialect Options
1864 @section Options Controlling Objective-C and Objective-C++ Dialects
1865
1866 @cindex compiler options, Objective-C and Objective-C++
1867 @cindex Objective-C and Objective-C++ options, command line
1868 @cindex options, Objective-C and Objective-C++
1869 (NOTE: This manual does not describe the Objective-C and Objective-C++
1870 languages themselves.  See @xref{Standards,,Language Standards
1871 Supported by GCC}, for references.)
1872
1873 This section describes the command-line options that are only meaningful
1874 for Objective-C and Objective-C++ programs, but you can also use most of
1875 the language-independent GNU compiler options.
1876 For example, you might compile a file @code{some_class.m} like this:
1877
1878 @smallexample
1879 gcc -g -fgnu-runtime -O -c some_class.m
1880 @end smallexample
1881
1882 @noindent
1883 In this example, @option{-fgnu-runtime} is an option meant only for
1884 Objective-C and Objective-C++ programs; you can use the other options with
1885 any language supported by GCC@.
1886
1887 Note that since Objective-C is an extension of the C language, Objective-C
1888 compilations may also use options specific to the C front-end (e.g.,
1889 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1890 C++-specific options (e.g., @option{-Wabi}).
1891
1892 Here is a list of options that are @emph{only} for compiling Objective-C
1893 and Objective-C++ programs:
1894
1895 @table @gcctabopt
1896 @item -fconstant-string-class=@var{class-name}
1897 @opindex fconstant-string-class
1898 Use @var{class-name} as the name of the class to instantiate for each
1899 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1900 class name is @code{NXConstantString} if the GNU runtime is being used, and
1901 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1902 @option{-fconstant-cfstrings} option, if also present, will override the
1903 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1904 to be laid out as constant CoreFoundation strings.
1905
1906 @item -fgnu-runtime
1907 @opindex fgnu-runtime
1908 Generate object code compatible with the standard GNU Objective-C
1909 runtime.  This is the default for most types of systems.
1910
1911 @item -fnext-runtime
1912 @opindex fnext-runtime
1913 Generate output compatible with the NeXT runtime.  This is the default
1914 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1915 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1916 used.
1917
1918 @item -fno-nil-receivers
1919 @opindex fno-nil-receivers
1920 Assume that all Objective-C message dispatches (e.g.,
1921 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1922 is not @code{nil}.  This allows for more efficient entry points in the runtime
1923 to be used.  Currently, this option is only available in conjunction with
1924 the NeXT runtime on Mac OS X 10.3 and later.
1925
1926 @item -fobjc-call-cxx-cdtors
1927 @opindex fobjc-call-cxx-cdtors
1928 For each Objective-C class, check if any of its instance variables is a
1929 C++ object with a non-trivial default constructor.  If so, synthesize a
1930 special @code{- (id) .cxx_construct} instance method that will run
1931 non-trivial default constructors on any such instance variables, in order,
1932 and then return @code{self}.  Similarly, check if any instance variable
1933 is a C++ object with a non-trivial destructor, and if so, synthesize a
1934 special @code{- (void) .cxx_destruct} method that will run
1935 all such default destructors, in reverse order.
1936
1937 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1938 thusly generated will only operate on instance variables declared in the
1939 current Objective-C class, and not those inherited from superclasses.  It
1940 is the responsibility of the Objective-C runtime to invoke all such methods
1941 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1942 will be invoked by the runtime immediately after a new object
1943 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1944 be invoked immediately before the runtime deallocates an object instance.
1945
1946 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1947 support for invoking the @code{- (id) .cxx_construct} and
1948 @code{- (void) .cxx_destruct} methods.
1949
1950 @item -fobjc-direct-dispatch
1951 @opindex fobjc-direct-dispatch
1952 Allow fast jumps to the message dispatcher.  On Darwin this is
1953 accomplished via the comm page.
1954
1955 @item -fobjc-exceptions
1956 @opindex fobjc-exceptions
1957 Enable syntactic support for structured exception handling in Objective-C,
1958 similar to what is offered by C++ and Java.  Currently, this option is only
1959 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1960
1961 @smallexample
1962   @@try @{
1963     @dots{}
1964        @@throw expr;
1965     @dots{}
1966   @}
1967   @@catch (AnObjCClass *exc) @{
1968     @dots{}
1969       @@throw expr;
1970     @dots{}
1971       @@throw;
1972     @dots{}
1973   @}
1974   @@catch (AnotherClass *exc) @{
1975     @dots{}
1976   @}
1977   @@catch (id allOthers) @{
1978     @dots{}
1979   @}
1980   @@finally @{
1981     @dots{}
1982       @@throw expr;
1983     @dots{}
1984   @}
1985 @end smallexample
1986
1987 The @code{@@throw} statement may appear anywhere in an Objective-C or
1988 Objective-C++ program; when used inside of a @code{@@catch} block, the
1989 @code{@@throw} may appear without an argument (as shown above), in which case
1990 the object caught by the @code{@@catch} will be rethrown.
1991
1992 Note that only (pointers to) Objective-C objects may be thrown and
1993 caught using this scheme.  When an object is thrown, it will be caught
1994 by the nearest @code{@@catch} clause capable of handling objects of that type,
1995 analogously to how @code{catch} blocks work in C++ and Java.  A
1996 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1997 any and all Objective-C exceptions not caught by previous @code{@@catch}
1998 clauses (if any).
1999
2000 The @code{@@finally} clause, if present, will be executed upon exit from the
2001 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2002 regardless of whether any exceptions are thrown, caught or rethrown
2003 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2004 of the @code{finally} clause in Java.
2005
2006 There are several caveats to using the new exception mechanism:
2007
2008 @itemize @bullet
2009 @item
2010 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2011 idioms provided by the @code{NSException} class, the new
2012 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2013 systems, due to additional functionality needed in the (NeXT) Objective-C
2014 runtime.
2015
2016 @item
2017 As mentioned above, the new exceptions do not support handling
2018 types other than Objective-C objects.   Furthermore, when used from
2019 Objective-C++, the Objective-C exception model does not interoperate with C++
2020 exceptions at this time.  This means you cannot @code{@@throw} an exception
2021 from Objective-C and @code{catch} it in C++, or vice versa
2022 (i.e., @code{throw @dots{} @@catch}).
2023 @end itemize
2024
2025 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2026 blocks for thread-safe execution:
2027
2028 @smallexample
2029   @@synchronized (ObjCClass *guard) @{
2030     @dots{}
2031   @}
2032 @end smallexample
2033
2034 Upon entering the @code{@@synchronized} block, a thread of execution shall
2035 first check whether a lock has been placed on the corresponding @code{guard}
2036 object by another thread.  If it has, the current thread shall wait until
2037 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2038 the current thread will place its own lock on it, execute the code contained in
2039 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2040 making @code{guard} available to other threads).
2041
2042 Unlike Java, Objective-C does not allow for entire methods to be marked
2043 @code{@@synchronized}.  Note that throwing exceptions out of
2044 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2045 to be unlocked properly.
2046
2047 @item -fobjc-gc
2048 @opindex fobjc-gc
2049 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2050
2051 @item -freplace-objc-classes
2052 @opindex freplace-objc-classes
2053 Emit a special marker instructing @command{ld(1)} not to statically link in
2054 the resulting object file, and allow @command{dyld(1)} to load it in at
2055 run time instead.  This is used in conjunction with the Fix-and-Continue
2056 debugging mode, where the object file in question may be recompiled and
2057 dynamically reloaded in the course of program execution, without the need
2058 to restart the program itself.  Currently, Fix-and-Continue functionality
2059 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2060 and later.
2061
2062 @item -fzero-link
2063 @opindex fzero-link
2064 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2065 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2066 compile time) with static class references that get initialized at load time,
2067 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2068 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2069 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2070 for individual class implementations to be modified during program execution.
2071
2072 @item -gen-decls
2073 @opindex gen-decls
2074 Dump interface declarations for all classes seen in the source file to a
2075 file named @file{@var{sourcename}.decl}.
2076
2077 @item -Wassign-intercept
2078 @opindex Wassign-intercept
2079 Warn whenever an Objective-C assignment is being intercepted by the
2080 garbage collector.
2081
2082 @item -Wno-protocol
2083 @opindex Wno-protocol
2084 If a class is declared to implement a protocol, a warning is issued for
2085 every method in the protocol that is not implemented by the class.  The
2086 default behavior is to issue a warning for every method not explicitly
2087 implemented in the class, even if a method implementation is inherited
2088 from the superclass.  If you use the @option{-Wno-protocol} option, then
2089 methods inherited from the superclass are considered to be implemented,
2090 and no warning is issued for them.
2091
2092 @item -Wselector
2093 @opindex Wselector
2094 Warn if multiple methods of different types for the same selector are
2095 found during compilation.  The check is performed on the list of methods
2096 in the final stage of compilation.  Additionally, a check is performed
2097 for each selector appearing in a @code{@@selector(@dots{})}
2098 expression, and a corresponding method for that selector has been found
2099 during compilation.  Because these checks scan the method table only at
2100 the end of compilation, these warnings are not produced if the final
2101 stage of compilation is not reached, for example because an error is
2102 found during compilation, or because the @option{-fsyntax-only} option is
2103 being used.
2104
2105 @item -Wstrict-selector-match
2106 @opindex Wstrict-selector-match
2107 Warn if multiple methods with differing argument and/or return types are
2108 found for a given selector when attempting to send a message using this
2109 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2110 is off (which is the default behavior), the compiler will omit such warnings
2111 if any differences found are confined to types which share the same size
2112 and alignment.
2113
2114 @item -Wundeclared-selector
2115 @opindex Wundeclared-selector
2116 Warn if a @code{@@selector(@dots{})} expression referring to an
2117 undeclared selector is found.  A selector is considered undeclared if no
2118 method with that name has been declared before the
2119 @code{@@selector(@dots{})} expression, either explicitly in an
2120 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2121 an @code{@@implementation} section.  This option always performs its
2122 checks as soon as a @code{@@selector(@dots{})} expression is found,
2123 while @option{-Wselector} only performs its checks in the final stage of
2124 compilation.  This also enforces the coding style convention
2125 that methods and selectors must be declared before being used.
2126
2127 @item -print-objc-runtime-info
2128 @opindex print-objc-runtime-info
2129 Generate C header describing the largest structure that is passed by
2130 value, if any.
2131
2132 @end table
2133
2134 @node Language Independent Options
2135 @section Options to Control Diagnostic Messages Formatting
2136 @cindex options to control diagnostics formatting
2137 @cindex diagnostic messages
2138 @cindex message formatting
2139
2140 Traditionally, diagnostic messages have been formatted irrespective of
2141 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2142 below can be used to control the diagnostic messages formatting
2143 algorithm, e.g.@: how many characters per line, how often source location
2144 information should be reported.  Right now, only the C++ front end can
2145 honor these options.  However it is expected, in the near future, that
2146 the remaining front ends would be able to digest them correctly.
2147
2148 @table @gcctabopt
2149 @item -fmessage-length=@var{n}
2150 @opindex fmessage-length
2151 Try to format error messages so that they fit on lines of about @var{n}
2152 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2153 the front ends supported by GCC@.  If @var{n} is zero, then no
2154 line-wrapping will be done; each error message will appear on a single
2155 line.
2156
2157 @opindex fdiagnostics-show-location
2158 @item -fdiagnostics-show-location=once
2159 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2160 reporter to emit @emph{once} source location information; that is, in
2161 case the message is too long to fit on a single physical line and has to
2162 be wrapped, the source location won't be emitted (as prefix) again,
2163 over and over, in subsequent continuation lines.  This is the default
2164 behavior.
2165
2166 @item -fdiagnostics-show-location=every-line
2167 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2168 messages reporter to emit the same source location information (as
2169 prefix) for physical lines that result from the process of breaking
2170 a message which is too long to fit on a single line.
2171
2172 @item -fdiagnostics-show-options
2173 @opindex fdiagnostics-show-options
2174 This option instructs the diagnostic machinery to add text to each
2175 diagnostic emitted, which indicates which command line option directly
2176 controls that diagnostic, when such an option is known to the
2177 diagnostic machinery.
2178
2179 @end table
2180
2181 @node Warning Options
2182 @section Options to Request or Suppress Warnings
2183 @cindex options to control warnings
2184 @cindex warning messages
2185 @cindex messages, warning
2186 @cindex suppressing warnings
2187
2188 Warnings are diagnostic messages that report constructions which
2189 are not inherently erroneous but which are risky or suggest there
2190 may have been an error.
2191
2192 You can request many specific warnings with options beginning @samp{-W},
2193 for example @option{-Wimplicit} to request warnings on implicit
2194 declarations.  Each of these specific warning options also has a
2195 negative form beginning @samp{-Wno-} to turn off warnings;
2196 for example, @option{-Wno-implicit}.  This manual lists only one of the
2197 two forms, whichever is not the default.
2198
2199 The following options control the amount and kinds of warnings produced
2200 by GCC; for further, language-specific options also refer to
2201 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2202 Options}.
2203
2204 @table @gcctabopt
2205 @cindex syntax checking
2206 @item -fsyntax-only
2207 @opindex fsyntax-only
2208 Check the code for syntax errors, but don't do anything beyond that.
2209
2210 @item -pedantic
2211 @opindex pedantic
2212 Issue all the warnings demanded by strict ISO C and ISO C++;
2213 reject all programs that use forbidden extensions, and some other
2214 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2215 version of the ISO C standard specified by any @option{-std} option used.
2216
2217 Valid ISO C and ISO C++ programs should compile properly with or without
2218 this option (though a rare few will require @option{-ansi} or a
2219 @option{-std} option specifying the required version of ISO C)@.  However,
2220 without this option, certain GNU extensions and traditional C and C++
2221 features are supported as well.  With this option, they are rejected.
2222
2223 @option{-pedantic} does not cause warning messages for use of the
2224 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2225 warnings are also disabled in the expression that follows
2226 @code{__extension__}.  However, only system header files should use
2227 these escape routes; application programs should avoid them.
2228 @xref{Alternate Keywords}.
2229
2230 Some users try to use @option{-pedantic} to check programs for strict ISO
2231 C conformance.  They soon find that it does not do quite what they want:
2232 it finds some non-ISO practices, but not all---only those for which
2233 ISO C @emph{requires} a diagnostic, and some others for which
2234 diagnostics have been added.
2235
2236 A feature to report any failure to conform to ISO C might be useful in
2237 some instances, but would require considerable additional work and would
2238 be quite different from @option{-pedantic}.  We don't have plans to
2239 support such a feature in the near future.
2240
2241 Where the standard specified with @option{-std} represents a GNU
2242 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2243 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2244 extended dialect is based.  Warnings from @option{-pedantic} are given
2245 where they are required by the base standard.  (It would not make sense
2246 for such warnings to be given only for features not in the specified GNU
2247 C dialect, since by definition the GNU dialects of C include all
2248 features the compiler supports with the given option, and there would be
2249 nothing to warn about.)
2250
2251 @item -pedantic-errors
2252 @opindex pedantic-errors
2253 Like @option{-pedantic}, except that errors are produced rather than
2254 warnings.
2255
2256 @item -w
2257 @opindex w
2258 Inhibit all warning messages.
2259
2260 @item -Wno-import
2261 @opindex Wno-import
2262 Inhibit warning messages about the use of @samp{#import}.
2263
2264 @item -Wchar-subscripts
2265 @opindex Wchar-subscripts
2266 Warn if an array subscript has type @code{char}.  This is a common cause
2267 of error, as programmers often forget that this type is signed on some
2268 machines.
2269 This warning is enabled by @option{-Wall}.
2270
2271 @item -Wcomment
2272 @opindex Wcomment
2273 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2274 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2275 This warning is enabled by @option{-Wall}.
2276
2277 @item -Wfatal-errors
2278 @opindex Wfatal-errors
2279 This option causes the compiler to abort compilation on the first error
2280 occurred rather than trying to keep going and printing further error
2281 messages.
2282
2283 @item -Wformat
2284 @opindex Wformat
2285 @opindex ffreestanding
2286 @opindex fno-builtin
2287 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2288 the arguments supplied have types appropriate to the format string
2289 specified, and that the conversions specified in the format string make
2290 sense.  This includes standard functions, and others specified by format
2291 attributes (@pxref{Function Attributes}), in the @code{printf},
2292 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2293 not in the C standard) families (or other target-specific families).
2294 Which functions are checked without format attributes having been
2295 specified depends on the standard version selected, and such checks of
2296 functions without the attribute specified are disabled by
2297 @option{-ffreestanding} or @option{-fno-builtin}.
2298
2299 The formats are checked against the format features supported by GNU
2300 libc version 2.2.  These include all ISO C90 and C99 features, as well
2301 as features from the Single Unix Specification and some BSD and GNU
2302 extensions.  Other library implementations may not support all these
2303 features; GCC does not support warning about features that go beyond a
2304 particular library's limitations.  However, if @option{-pedantic} is used
2305 with @option{-Wformat}, warnings will be given about format features not
2306 in the selected standard version (but not for @code{strfmon} formats,
2307 since those are not in any version of the C standard).  @xref{C Dialect
2308 Options,,Options Controlling C Dialect}.
2309
2310 Since @option{-Wformat} also checks for null format arguments for
2311 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2312
2313 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2314 aspects of format checking, the options @option{-Wformat-y2k},
2315 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2316 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2317 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2318
2319 @item -Wformat-y2k
2320 @opindex Wformat-y2k
2321 If @option{-Wformat} is specified, also warn about @code{strftime}
2322 formats which may yield only a two-digit year.
2323
2324 @item -Wno-format-extra-args
2325 @opindex Wno-format-extra-args
2326 If @option{-Wformat} is specified, do not warn about excess arguments to a
2327 @code{printf} or @code{scanf} format function.  The C standard specifies
2328 that such arguments are ignored.
2329
2330 Where the unused arguments lie between used arguments that are
2331 specified with @samp{$} operand number specifications, normally
2332 warnings are still given, since the implementation could not know what
2333 type to pass to @code{va_arg} to skip the unused arguments.  However,
2334 in the case of @code{scanf} formats, this option will suppress the
2335 warning if the unused arguments are all pointers, since the Single
2336 Unix Specification says that such unused arguments are allowed.
2337
2338 @item -Wno-format-zero-length
2339 @opindex Wno-format-zero-length
2340 If @option{-Wformat} is specified, do not warn about zero-length formats.
2341 The C standard specifies that zero-length formats are allowed.
2342
2343 @item -Wformat-nonliteral
2344 @opindex Wformat-nonliteral
2345 If @option{-Wformat} is specified, also warn if the format string is not a
2346 string literal and so cannot be checked, unless the format function
2347 takes its format arguments as a @code{va_list}.
2348
2349 @item -Wformat-security
2350 @opindex Wformat-security
2351 If @option{-Wformat} is specified, also warn about uses of format
2352 functions that represent possible security problems.  At present, this
2353 warns about calls to @code{printf} and @code{scanf} functions where the
2354 format string is not a string literal and there are no format arguments,
2355 as in @code{printf (foo);}.  This may be a security hole if the format
2356 string came from untrusted input and contains @samp{%n}.  (This is
2357 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2358 in future warnings may be added to @option{-Wformat-security} that are not
2359 included in @option{-Wformat-nonliteral}.)
2360
2361 @item -Wformat=2
2362 @opindex Wformat=2
2363 Enable @option{-Wformat} plus format checks not included in
2364 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2365 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2366
2367 @item -Wnonnull
2368 @opindex Wnonnull
2369 Warn about passing a null pointer for arguments marked as
2370 requiring a non-null value by the @code{nonnull} function attribute.
2371
2372 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2373 can be disabled with the @option{-Wno-nonnull} option.
2374
2375 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2376 @opindex Winit-self
2377 Warn about uninitialized variables which are initialized with themselves.
2378 Note this option can only be used with the @option{-Wuninitialized} option,
2379 which in turn only works with @option{-O1} and above.
2380
2381 For example, GCC will warn about @code{i} being uninitialized in the
2382 following snippet only when @option{-Winit-self} has been specified:
2383 @smallexample
2384 @group
2385 int f()
2386 @{
2387   int i = i;
2388   return i;
2389 @}
2390 @end group
2391 @end smallexample
2392
2393 @item -Wimplicit-int
2394 @opindex Wimplicit-int
2395 Warn when a declaration does not specify a type.
2396 This warning is enabled by @option{-Wall}.
2397
2398 @item -Wimplicit-function-declaration
2399 @itemx -Werror-implicit-function-declaration
2400 @opindex Wimplicit-function-declaration
2401 @opindex Werror-implicit-function-declaration
2402 Give a warning (or error) whenever a function is used before being
2403 declared.  The form @option{-Wno-error-implicit-function-declaration}
2404 is not supported.
2405 This warning is enabled by @option{-Wall} (as a warning, not an error).
2406
2407 @item -Wimplicit
2408 @opindex Wimplicit
2409 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2410 This warning is enabled by @option{-Wall}.
2411
2412 @item -Wmain
2413 @opindex Wmain
2414 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2415 function with external linkage, returning int, taking either zero
2416 arguments, two, or three arguments of appropriate types.
2417 This warning is enabled by @option{-Wall}.
2418
2419 @item -Wmissing-braces
2420 @opindex Wmissing-braces
2421 Warn if an aggregate or union initializer is not fully bracketed.  In
2422 the following example, the initializer for @samp{a} is not fully
2423 bracketed, but that for @samp{b} is fully bracketed.
2424
2425 @smallexample
2426 int a[2][2] = @{ 0, 1, 2, 3 @};
2427 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2428 @end smallexample
2429
2430 This warning is enabled by @option{-Wall}.
2431
2432 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2433 @opindex Wmissing-include-dirs
2434 Warn if a user-supplied include directory does not exist.
2435
2436 @item -Wparentheses
2437 @opindex Wparentheses
2438 Warn if parentheses are omitted in certain contexts, such
2439 as when there is an assignment in a context where a truth value
2440 is expected, or when operators are nested whose precedence people
2441 often get confused about.  Only the warning for an assignment used as
2442 a truth value is supported when compiling C++; the other warnings are
2443 only supported when compiling C@.
2444
2445 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2446 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2447 interpretation from that of ordinary mathematical notation.
2448
2449 Also warn about constructions where there may be confusion to which
2450 @code{if} statement an @code{else} branch belongs.  Here is an example of
2451 such a case:
2452
2453 @smallexample
2454 @group
2455 @{
2456   if (a)
2457     if (b)
2458       foo ();
2459   else
2460     bar ();
2461 @}
2462 @end group
2463 @end smallexample
2464
2465 In C, every @code{else} branch belongs to the innermost possible @code{if}
2466 statement, which in this example is @code{if (b)}.  This is often not
2467 what the programmer expected, as illustrated in the above example by
2468 indentation the programmer chose.  When there is the potential for this
2469 confusion, GCC will issue a warning when this flag is specified.
2470 To eliminate the warning, add explicit braces around the innermost
2471 @code{if} statement so there is no way the @code{else} could belong to
2472 the enclosing @code{if}.  The resulting code would look like this:
2473
2474 @smallexample
2475 @group
2476 @{
2477   if (a)
2478     @{
2479       if (b)
2480         foo ();
2481       else
2482         bar ();
2483     @}
2484 @}
2485 @end group
2486 @end smallexample
2487
2488 This warning is enabled by @option{-Wall}.
2489
2490 @item -Wsequence-point
2491 @opindex Wsequence-point
2492 Warn about code that may have undefined semantics because of violations
2493 of sequence point rules in the C standard.
2494
2495 The C standard defines the order in which expressions in a C program are
2496 evaluated in terms of @dfn{sequence points}, which represent a partial
2497 ordering between the execution of parts of the program: those executed
2498 before the sequence point, and those executed after it.  These occur
2499 after the evaluation of a full expression (one which is not part of a
2500 larger expression), after the evaluation of the first operand of a
2501 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2502 function is called (but after the evaluation of its arguments and the
2503 expression denoting the called function), and in certain other places.
2504 Other than as expressed by the sequence point rules, the order of
2505 evaluation of subexpressions of an expression is not specified.  All
2506 these rules describe only a partial order rather than a total order,
2507 since, for example, if two functions are called within one expression
2508 with no sequence point between them, the order in which the functions
2509 are called is not specified.  However, the standards committee have
2510 ruled that function calls do not overlap.
2511
2512 It is not specified when between sequence points modifications to the
2513 values of objects take effect.  Programs whose behavior depends on this
2514 have undefined behavior; the C standard specifies that ``Between the
2515 previous and next sequence point an object shall have its stored value
2516 modified at most once by the evaluation of an expression.  Furthermore,
2517 the prior value shall be read only to determine the value to be
2518 stored.''.  If a program breaks these rules, the results on any
2519 particular implementation are entirely unpredictable.
2520
2521 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2522 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2523 diagnosed by this option, and it may give an occasional false positive
2524 result, but in general it has been found fairly effective at detecting
2525 this sort of problem in programs.
2526
2527 The present implementation of this option only works for C programs.  A
2528 future implementation may also work for C++ programs.
2529
2530 The C standard is worded confusingly, therefore there is some debate
2531 over the precise meaning of the sequence point rules in subtle cases.
2532 Links to discussions of the problem, including proposed formal
2533 definitions, may be found on the GCC readings page, at
2534 @w{@uref{http://gcc.gnu.org/readings.html}}.
2535
2536 This warning is enabled by @option{-Wall}.
2537
2538 @item -Wreturn-type
2539 @opindex Wreturn-type
2540 Warn whenever a function is defined with a return-type that defaults to
2541 @code{int}.  Also warn about any @code{return} statement with no
2542 return-value in a function whose return-type is not @code{void}.
2543
2544 For C, also warn if the return type of a function has a type qualifier
2545 such as @code{const}.  Such a type qualifier has no effect, since the
2546 value returned by a function is not an lvalue.  ISO C prohibits
2547 qualified @code{void} return types on function definitions, so such
2548 return types always receive a warning even without this option.
2549
2550 For C++, a function without return type always produces a diagnostic
2551 message, even when @option{-Wno-return-type} is specified.  The only
2552 exceptions are @samp{main} and functions defined in system headers.
2553
2554 This warning is enabled by @option{-Wall}.
2555
2556 @item -Wswitch
2557 @opindex Wswitch
2558 Warn whenever a @code{switch} statement has an index of enumerated type
2559 and lacks a @code{case} for one or more of the named codes of that
2560 enumeration.  (The presence of a @code{default} label prevents this
2561 warning.)  @code{case} labels outside the enumeration range also
2562 provoke warnings when this option is used.
2563 This warning is enabled by @option{-Wall}.
2564
2565 @item -Wswitch-default
2566 @opindex Wswitch-switch
2567 Warn whenever a @code{switch} statement does not have a @code{default}
2568 case.
2569
2570 @item -Wswitch-enum
2571 @opindex Wswitch-enum
2572 Warn whenever a @code{switch} statement has an index of enumerated type
2573 and lacks a @code{case} for one or more of the named codes of that
2574 enumeration.  @code{case} labels outside the enumeration range also
2575 provoke warnings when this option is used.
2576
2577 @item -Wtrigraphs
2578 @opindex Wtrigraphs
2579 Warn if any trigraphs are encountered that might change the meaning of
2580 the program (trigraphs within comments are not warned about).
2581 This warning is enabled by @option{-Wall}.
2582
2583 @item -Wunused-function
2584 @opindex Wunused-function
2585 Warn whenever a static function is declared but not defined or a
2586 non\-inline static function is unused.
2587 This warning is enabled by @option{-Wall}.
2588
2589 @item -Wunused-label
2590 @opindex Wunused-label
2591 Warn whenever a label is declared but not used.
2592 This warning is enabled by @option{-Wall}.
2593
2594 To suppress this warning use the @samp{unused} attribute
2595 (@pxref{Variable Attributes}).
2596
2597 @item -Wunused-parameter
2598 @opindex Wunused-parameter
2599 Warn whenever a function parameter is unused aside from its declaration.
2600
2601 To suppress this warning use the @samp{unused} attribute
2602 (@pxref{Variable Attributes}).
2603
2604 @item -Wunused-variable
2605 @opindex Wunused-variable
2606 Warn whenever a local variable or non-constant static variable is unused
2607 aside from its declaration
2608 This warning is enabled by @option{-Wall}.
2609
2610 To suppress this warning use the @samp{unused} attribute
2611 (@pxref{Variable Attributes}).
2612
2613 @item -Wunused-value
2614 @opindex Wunused-value
2615 Warn whenever a statement computes a result that is explicitly not used.
2616 This warning is enabled by @option{-Wall}.
2617
2618 To suppress this warning cast the expression to @samp{void}.
2619
2620 @item -Wunused
2621 @opindex Wunused
2622 All the above @option{-Wunused} options combined.
2623
2624 In order to get a warning about an unused function parameter, you must
2625 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2626 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2627
2628 @item -Wuninitialized
2629 @opindex Wuninitialized
2630 Warn if an automatic variable is used without first being initialized or
2631 if a variable may be clobbered by a @code{setjmp} call.
2632
2633 These warnings are possible only in optimizing compilation,
2634 because they require data flow information that is computed only
2635 when optimizing.  If you don't specify @option{-O}, you simply won't
2636 get these warnings.
2637
2638 If you want to warn about code which uses the uninitialized value of the
2639 variable in its own initializer, use the @option{-Winit-self} option.
2640
2641 These warnings occur for individual uninitialized or clobbered
2642 elements of structure, union or array variables as well as for
2643 variables which are uninitialized or clobbered as a whole.  They do
2644 not occur for variables or elements declared @code{volatile}.  Because
2645 these warnings depend on optimization, the exact variables or elements
2646 for which there are warnings will depend on the precise optimization
2647 options and version of GCC used.
2648
2649 Note that there may be no warning about a variable that is used only
2650 to compute a value that itself is never used, because such
2651 computations may be deleted by data flow analysis before the warnings
2652 are printed.
2653
2654 These warnings are made optional because GCC is not smart
2655 enough to see all the reasons why the code might be correct
2656 despite appearing to have an error.  Here is one example of how
2657 this can happen:
2658
2659 @smallexample
2660 @group
2661 @{
2662   int x;
2663   switch (y)
2664     @{
2665     case 1: x = 1;
2666       break;
2667     case 2: x = 4;
2668       break;
2669     case 3: x = 5;
2670     @}
2671   foo (x);
2672 @}
2673 @end group
2674 @end smallexample
2675
2676 @noindent
2677 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2678 always initialized, but GCC doesn't know this.  Here is
2679 another common case:
2680
2681 @smallexample
2682 @{
2683   int save_y;
2684   if (change_y) save_y = y, y = new_y;
2685   @dots{}
2686   if (change_y) y = save_y;
2687 @}
2688 @end smallexample
2689
2690 @noindent
2691 This has no bug because @code{save_y} is used only if it is set.
2692
2693 @cindex @code{longjmp} warnings
2694 This option also warns when a non-volatile automatic variable might be
2695 changed by a call to @code{longjmp}.  These warnings as well are possible
2696 only in optimizing compilation.
2697
2698 The compiler sees only the calls to @code{setjmp}.  It cannot know
2699 where @code{longjmp} will be called; in fact, a signal handler could
2700 call it at any point in the code.  As a result, you may get a warning
2701 even when there is in fact no problem because @code{longjmp} cannot
2702 in fact be called at the place which would cause a problem.
2703
2704 Some spurious warnings can be avoided if you declare all the functions
2705 you use that never return as @code{noreturn}.  @xref{Function
2706 Attributes}.
2707
2708 This warning is enabled by @option{-Wall}.
2709
2710 @item -Wunknown-pragmas
2711 @opindex Wunknown-pragmas
2712 @cindex warning for unknown pragmas
2713 @cindex unknown pragmas, warning
2714 @cindex pragmas, warning of unknown
2715 Warn when a #pragma directive is encountered which is not understood by
2716 GCC@.  If this command line option is used, warnings will even be issued
2717 for unknown pragmas in system header files.  This is not the case if
2718 the warnings were only enabled by the @option{-Wall} command line option.
2719
2720 @item -Wno-pragmas
2721 @opindex Wno-pragmas
2722 @opindex Wpragmas
2723 Do not warn about misuses of pragmas, such as incorrect parameters,
2724 invalid syntax, or conflicts between pragmas.  See also
2725 @samp{-Wunknown-pragmas}.
2726
2727 @item -Wstrict-aliasing
2728 @opindex Wstrict-aliasing
2729 This option is only active when @option{-fstrict-aliasing} is active.
2730 It warns about code which might break the strict aliasing rules that the
2731 compiler is using for optimization.  The warning does not catch all
2732 cases, but does attempt to catch the more common pitfalls.  It is
2733 included in @option{-Wall}.
2734
2735 @item -Wstrict-aliasing=2
2736 @opindex Wstrict-aliasing=2
2737 This option is only active when @option{-fstrict-aliasing} is active.
2738 It warns about code which might break the strict aliasing rules that the
2739 compiler is using for optimization.  This warning catches more cases than
2740 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2741 cases that are safe.
2742
2743 @item -Wall
2744 @opindex Wall
2745 All of the above @samp{-W} options combined.  This enables all the
2746 warnings about constructions that some users consider questionable, and
2747 that are easy to avoid (or modify to prevent the warning), even in
2748 conjunction with macros.  This also enables some language-specific
2749 warnings described in @ref{C++ Dialect Options} and
2750 @ref{Objective-C and Objective-C++ Dialect Options}.
2751 @end table
2752
2753 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2754 Some of them warn about constructions that users generally do not
2755 consider questionable, but which occasionally you might wish to check
2756 for; others warn about constructions that are necessary or hard to avoid
2757 in some cases, and there is no simple way to modify the code to suppress
2758 the warning.
2759
2760 @table @gcctabopt
2761 @item -Wextra
2762 @opindex W
2763 @opindex Wextra
2764 (This option used to be called @option{-W}.  The older name is still
2765 supported, but the newer name is more descriptive.)  Print extra warning
2766 messages for these events:
2767
2768 @itemize @bullet
2769 @item
2770 A function can return either with or without a value.  (Falling
2771 off the end of the function body is considered returning without
2772 a value.)  For example, this function would evoke such a
2773 warning:
2774
2775 @smallexample
2776 @group
2777 foo (a)
2778 @{
2779   if (a > 0)
2780     return a;
2781 @}
2782 @end group
2783 @end smallexample
2784
2785 @item
2786 An expression-statement or the left-hand side of a comma expression
2787 contains no side effects.
2788 To suppress the warning, cast the unused expression to void.
2789 For example, an expression such as @samp{x[i,j]} will cause a warning,
2790 but @samp{x[(void)i,j]} will not.
2791
2792 @item
2793 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2794
2795 @item
2796 Storage-class specifiers like @code{static} are not the first things in
2797 a declaration.  According to the C Standard, this usage is obsolescent.
2798
2799 @item
2800 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2801 arguments.
2802
2803 @item
2804 A comparison between signed and unsigned values could produce an
2805 incorrect result when the signed value is converted to unsigned.
2806 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2807
2808 @item
2809 An aggregate has an initializer which does not initialize all members.
2810 This warning can be independently controlled by
2811 @option{-Wmissing-field-initializers}.
2812
2813 @item
2814 A function parameter is declared without a type specifier in K&R-style
2815 functions:
2816
2817 @smallexample
2818 void foo(bar) @{ @}
2819 @end smallexample
2820
2821 @item
2822 An empty body occurs in an @samp{if} or @samp{else} statement.
2823
2824 @item
2825 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2826 @samp{>}, or @samp{>=}.
2827
2828 @item
2829 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2830
2831 @item
2832 Any of several floating-point events that often indicate errors, such as
2833 overflow, underflow, loss of precision, etc.
2834
2835 @item @r{(C++ only)}
2836 An enumerator and a non-enumerator both appear in a conditional expression.
2837
2838 @item @r{(C++ only)}
2839 A non-static reference or non-static @samp{const} member appears in a
2840 class without constructors.
2841
2842 @item @r{(C++ only)}
2843 Ambiguous virtual bases.
2844
2845 @item @r{(C++ only)}
2846 Subscripting an array which has been declared @samp{register}.
2847
2848 @item @r{(C++ only)}
2849 Taking the address of a variable which has been declared @samp{register}.
2850
2851 @item @r{(C++ only)}
2852 A base class is not initialized in a derived class' copy constructor.
2853 @end itemize
2854
2855 @item -Wno-div-by-zero
2856 @opindex Wno-div-by-zero
2857 @opindex Wdiv-by-zero
2858 Do not warn about compile-time integer division by zero.  Floating point
2859 division by zero is not warned about, as it can be a legitimate way of
2860 obtaining infinities and NaNs.
2861
2862 @item -Wsystem-headers
2863 @opindex Wsystem-headers
2864 @cindex warnings from system headers
2865 @cindex system headers, warnings from
2866 Print warning messages for constructs found in system header files.
2867 Warnings from system headers are normally suppressed, on the assumption
2868 that they usually do not indicate real problems and would only make the
2869 compiler output harder to read.  Using this command line option tells
2870 GCC to emit warnings from system headers as if they occurred in user
2871 code.  However, note that using @option{-Wall} in conjunction with this
2872 option will @emph{not} warn about unknown pragmas in system
2873 headers---for that, @option{-Wunknown-pragmas} must also be used.
2874
2875 @item -Wfloat-equal
2876 @opindex Wfloat-equal
2877 Warn if floating point values are used in equality comparisons.
2878
2879 The idea behind this is that sometimes it is convenient (for the
2880 programmer) to consider floating-point values as approximations to
2881 infinitely precise real numbers.  If you are doing this, then you need
2882 to compute (by analyzing the code, or in some other way) the maximum or
2883 likely maximum error that the computation introduces, and allow for it
2884 when performing comparisons (and when producing output, but that's a
2885 different problem).  In particular, instead of testing for equality, you
2886 would check to see whether the two values have ranges that overlap; and
2887 this is done with the relational operators, so equality comparisons are
2888 probably mistaken.
2889
2890 @item -Wtraditional @r{(C only)}
2891 @opindex Wtraditional
2892 Warn about certain constructs that behave differently in traditional and
2893 ISO C@.  Also warn about ISO C constructs that have no traditional C
2894 equivalent, and/or problematic constructs which should be avoided.
2895
2896 @itemize @bullet
2897 @item
2898 Macro parameters that appear within string literals in the macro body.
2899 In traditional C macro replacement takes place within string literals,
2900 but does not in ISO C@.
2901
2902 @item
2903 In traditional C, some preprocessor directives did not exist.
2904 Traditional preprocessors would only consider a line to be a directive
2905 if the @samp{#} appeared in column 1 on the line.  Therefore
2906 @option{-Wtraditional} warns about directives that traditional C
2907 understands but would ignore because the @samp{#} does not appear as the
2908 first character on the line.  It also suggests you hide directives like
2909 @samp{#pragma} not understood by traditional C by indenting them.  Some
2910 traditional implementations would not recognize @samp{#elif}, so it
2911 suggests avoiding it altogether.
2912
2913 @item
2914 A function-like macro that appears without arguments.
2915
2916 @item
2917 The unary plus operator.
2918
2919 @item
2920 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2921 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2922 constants.)  Note, these suffixes appear in macros defined in the system
2923 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2924 Use of these macros in user code might normally lead to spurious
2925 warnings, however GCC's integrated preprocessor has enough context to
2926 avoid warning in these cases.
2927
2928 @item
2929 A function declared external in one block and then used after the end of
2930 the block.
2931
2932 @item
2933 A @code{switch} statement has an operand of type @code{long}.
2934
2935 @item
2936 A non-@code{static} function declaration follows a @code{static} one.
2937 This construct is not accepted by some traditional C compilers.
2938
2939 @item
2940 The ISO type of an integer constant has a different width or
2941 signedness from its traditional type.  This warning is only issued if
2942 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2943 typically represent bit patterns, are not warned about.
2944
2945 @item
2946 Usage of ISO string concatenation is detected.
2947
2948 @item
2949 Initialization of automatic aggregates.
2950
2951 @item
2952 Identifier conflicts with labels.  Traditional C lacks a separate
2953 namespace for labels.
2954
2955 @item
2956 Initialization of unions.  If the initializer is zero, the warning is
2957 omitted.  This is done under the assumption that the zero initializer in
2958 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2959 initializer warnings and relies on default initialization to zero in the
2960 traditional C case.
2961
2962 @item
2963 Conversions by prototypes between fixed/floating point values and vice
2964 versa.  The absence of these prototypes when compiling with traditional
2965 C would cause serious problems.  This is a subset of the possible
2966 conversion warnings, for the full set use @option{-Wconversion}.
2967
2968 @item
2969 Use of ISO C style function definitions.  This warning intentionally is
2970 @emph{not} issued for prototype declarations or variadic functions
2971 because these ISO C features will appear in your code when using
2972 libiberty's traditional C compatibility macros, @code{PARAMS} and
2973 @code{VPARAMS}.  This warning is also bypassed for nested functions
2974 because that feature is already a GCC extension and thus not relevant to
2975 traditional C compatibility.
2976 @end itemize
2977
2978 @item -Wdeclaration-after-statement @r{(C only)}
2979 @opindex Wdeclaration-after-statement
2980 Warn when a declaration is found after a statement in a block.  This
2981 construct, known from C++, was introduced with ISO C99 and is by default
2982 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2983 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2984
2985 @item -Wundef
2986 @opindex Wundef
2987 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2988
2989 @item -Wno-endif-labels
2990 @opindex Wno-endif-labels
2991 @opindex Wendif-labels
2992 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2993
2994 @item -Wshadow
2995 @opindex Wshadow
2996 Warn whenever a local variable shadows another local variable, parameter or
2997 global variable or whenever a built-in function is shadowed.
2998
2999 @item -Wlarger-than-@var{len}
3000 @opindex Wlarger-than
3001 Warn whenever an object of larger than @var{len} bytes is defined.
3002
3003 @item -Wunsafe-loop-optimizations
3004 @opindex Wunsafe-loop-optimizations
3005 Warn if the loop cannot be optimized because the compiler could not
3006 assume anything on the bounds of the loop indices.  With
3007 @option{-funsafe-loop-optimizations} warn if the compiler made
3008 such assumptions.
3009
3010 @item -Wpointer-arith
3011 @opindex Wpointer-arith
3012 Warn about anything that depends on the ``size of'' a function type or
3013 of @code{void}.  GNU C assigns these types a size of 1, for
3014 convenience in calculations with @code{void *} pointers and pointers
3015 to functions.
3016
3017 @item -Wbad-function-cast @r{(C only)}
3018 @opindex Wbad-function-cast
3019 Warn whenever a function call is cast to a non-matching type.
3020 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3021
3022 @item -Wc++-compat
3023 Warn about ISO C constructs that are outside of the common subset of
3024 ISO C and ISO C++, e.g.@: request for implicit conversion from
3025 @code{void *} to a pointer to non-@code{void} type.
3026
3027 @item -Wcast-qual
3028 @opindex Wcast-qual
3029 Warn whenever a pointer is cast so as to remove a type qualifier from
3030 the target type.  For example, warn if a @code{const char *} is cast
3031 to an ordinary @code{char *}.
3032
3033 @item -Wcast-align
3034 @opindex Wcast-align
3035 Warn whenever a pointer is cast such that the required alignment of the
3036 target is increased.  For example, warn if a @code{char *} is cast to
3037 an @code{int *} on machines where integers can only be accessed at
3038 two- or four-byte boundaries.
3039
3040 @item -Wwrite-strings
3041 @opindex Wwrite-strings
3042 When compiling C, give string constants the type @code{const
3043 char[@var{length}]} so that
3044 copying the address of one into a non-@code{const} @code{char *}
3045 pointer will get a warning; when compiling C++, warn about the
3046 deprecated conversion from string constants to @code{char *}.
3047 These warnings will help you find at
3048 compile time code that can try to write into a string constant, but
3049 only if you have been very careful about using @code{const} in
3050 declarations and prototypes.  Otherwise, it will just be a nuisance;
3051 this is why we did not make @option{-Wall} request these warnings.
3052
3053 @item -Wconversion
3054 @opindex Wconversion
3055 Warn if a prototype causes a type conversion that is different from what
3056 would happen to the same argument in the absence of a prototype.  This
3057 includes conversions of fixed point to floating and vice versa, and
3058 conversions changing the width or signedness of a fixed point argument
3059 except when the same as the default promotion.
3060
3061 Also, warn if a negative integer constant expression is implicitly
3062 converted to an unsigned type.  For example, warn about the assignment
3063 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3064 casts like @code{(unsigned) -1}.
3065
3066 @item -Wsign-compare
3067 @opindex Wsign-compare
3068 @cindex warning for comparison of signed and unsigned values
3069 @cindex comparison of signed and unsigned values, warning
3070 @cindex signed and unsigned values, comparison warning
3071 Warn when a comparison between signed and unsigned values could produce
3072 an incorrect result when the signed value is converted to unsigned.
3073 This warning is also enabled by @option{-Wextra}; to get the other warnings
3074 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3075
3076 @item -Waggregate-return
3077 @opindex Waggregate-return
3078 Warn if any functions that return structures or unions are defined or
3079 called.  (In languages where you can return an array, this also elicits
3080 a warning.)
3081
3082 @item -Wno-attributes
3083 @opindex Wno-attributes
3084 @opindex Wattributes
3085 Do not warn if an unexpected @code{__attribute__} is used, such as
3086 unrecognized attributes, function attributes applied to variables,
3087 etc.  This will not stop errors for incorrect use of supported
3088 attributes.
3089
3090 @item -Wstrict-prototypes @r{(C only)}
3091 @opindex Wstrict-prototypes
3092 Warn if a function is declared or defined without specifying the
3093 argument types.  (An old-style function definition is permitted without
3094 a warning if preceded by a declaration which specifies the argument
3095 types.)
3096
3097 @item -Wold-style-definition @r{(C only)}
3098 @opindex Wold-style-definition
3099 Warn if an old-style function definition is used.  A warning is given
3100 even if there is a previous prototype.
3101
3102 @item -Wmissing-prototypes @r{(C only)}
3103 @opindex Wmissing-prototypes
3104 Warn if a global function is defined without a previous prototype
3105 declaration.  This warning is issued even if the definition itself
3106 provides a prototype.  The aim is to detect global functions that fail
3107 to be declared in header files.
3108
3109 @item -Wmissing-declarations @r{(C only)}
3110 @opindex Wmissing-declarations
3111 Warn if a global function is defined without a previous declaration.
3112 Do so even if the definition itself provides a prototype.
3113 Use this option to detect global functions that are not declared in
3114 header files.
3115
3116 @item -Wmissing-field-initializers
3117 @opindex Wmissing-field-initializers
3118 @opindex W
3119 @opindex Wextra
3120 Warn if a structure's initializer has some fields missing.  For
3121 example, the following code would cause such a warning, because
3122 @code{x.h} is implicitly zero:
3123
3124 @smallexample
3125 struct s @{ int f, g, h; @};
3126 struct s x = @{ 3, 4 @};
3127 @end smallexample
3128
3129 This option does not warn about designated initializers, so the following
3130 modification would not trigger a warning:
3131
3132 @smallexample
3133 struct s @{ int f, g, h; @};
3134 struct s x = @{ .f = 3, .g = 4 @};
3135 @end smallexample
3136
3137 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3138 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3139
3140 @item -Wmissing-noreturn
3141 @opindex Wmissing-noreturn
3142 Warn about functions which might be candidates for attribute @code{noreturn}.
3143 Note these are only possible candidates, not absolute ones.  Care should
3144 be taken to manually verify functions actually do not ever return before
3145 adding the @code{noreturn} attribute, otherwise subtle code generation
3146 bugs could be introduced.  You will not get a warning for @code{main} in
3147 hosted C environments.
3148
3149 @item -Wmissing-format-attribute
3150 @opindex Wmissing-format-attribute
3151 @opindex Wformat
3152 Warn about function pointers which might be candidates for @code{format}
3153 attributes.  Note these are only possible candidates, not absolute ones.
3154 GCC will guess that function pointers with @code{format} attributes that
3155 are used in assignment, initialization, parameter passing or return
3156 statements should have a corresponding @code{format} attribute in the
3157 resulting type.  I.e.@: the left-hand side of the assignment or
3158 initialization, the type of the parameter variable, or the return type
3159 of the containing function respectively should also have a @code{format}
3160 attribute to avoid the warning.
3161
3162 GCC will also warn about function definitions which might be
3163 candidates for @code{format} attributes.  Again, these are only
3164 possible candidates.  GCC will guess that @code{format} attributes
3165 might be appropriate for any function that calls a function like
3166 @code{vprintf} or @code{vscanf}, but this might not always be the
3167 case, and some functions for which @code{format} attributes are
3168 appropriate may not be detected.
3169
3170 @item -Wno-multichar
3171 @opindex Wno-multichar
3172 @opindex Wmultichar
3173 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3174 Usually they indicate a typo in the user's code, as they have
3175 implementation-defined values, and should not be used in portable code.
3176
3177 @item -Wnormalized=<none|id|nfc|nfkc>
3178 @opindex Wnormalized
3179 @cindex NFC
3180 @cindex NFKC
3181 @cindex character set, input normalization
3182 In ISO C and ISO C++, two identifiers are different if they are
3183 different sequences of characters.  However, sometimes when characters
3184 outside the basic ASCII character set are used, you can have two
3185 different character sequences that look the same.  To avoid confusion,
3186 the ISO 10646 standard sets out some @dfn{normalization rules} which
3187 when applied ensure that two sequences that look the same are turned into
3188 the same sequence.  GCC can warn you if you are using identifiers which
3189 have not been normalized; this option controls that warning.
3190
3191 There are four levels of warning that GCC supports.  The default is
3192 @option{-Wnormalized=nfc}, which warns about any identifier which is
3193 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3194 recommended form for most uses.
3195
3196 Unfortunately, there are some characters which ISO C and ISO C++ allow
3197 in identifiers that when turned into NFC aren't allowable as
3198 identifiers.  That is, there's no way to use these symbols in portable
3199 ISO C or C++ and have all your identifiers in NFC.
3200 @option{-Wnormalized=id} suppresses the warning for these characters.
3201 It is hoped that future versions of the standards involved will correct
3202 this, which is why this option is not the default.
3203
3204 You can switch the warning off for all characters by writing
3205 @option{-Wnormalized=none}.  You would only want to do this if you
3206 were using some other normalization scheme (like ``D''), because
3207 otherwise you can easily create bugs that are literally impossible to see.
3208
3209 Some characters in ISO 10646 have distinct meanings but look identical
3210 in some fonts or display methodologies, especially once formatting has
3211 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3212 LETTER N'', will display just like a regular @code{n} which has been
3213 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3214 normalisation scheme to convert all these into a standard form as
3215 well, and GCC will warn if your code is not in NFKC if you use
3216 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3217 about every identifier that contains the letter O because it might be
3218 confused with the digit 0, and so is not the default, but may be
3219 useful as a local coding convention if the programming environment is
3220 unable to be fixed to display these characters distinctly.
3221
3222 @item -Wno-deprecated-declarations
3223 @opindex Wno-deprecated-declarations
3224 Do not warn about uses of functions, variables, and types marked as
3225 deprecated by using the @code{deprecated} attribute.
3226 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3227 @pxref{Type Attributes}.)
3228
3229 @item -Wpacked
3230 @opindex Wpacked
3231 Warn if a structure is given the packed attribute, but the packed
3232 attribute has no effect on the layout or size of the structure.
3233 Such structures may be mis-aligned for little benefit.  For
3234 instance, in this code, the variable @code{f.x} in @code{struct bar}
3235 will be misaligned even though @code{struct bar} does not itself
3236 have the packed attribute:
3237
3238 @smallexample
3239 @group
3240 struct foo @{
3241   int x;
3242   char a, b, c, d;
3243 @} __attribute__((packed));
3244 struct bar @{
3245   char z;
3246   struct foo f;
3247 @};
3248 @end group
3249 @end smallexample
3250
3251 @item -Wpadded
3252 @opindex Wpadded
3253 Warn if padding is included in a structure, either to align an element
3254 of the structure or to align the whole structure.  Sometimes when this
3255 happens it is possible to rearrange the fields of the structure to
3256 reduce the padding and so make the structure smaller.
3257
3258 @item -Wredundant-decls
3259 @opindex Wredundant-decls
3260 Warn if anything is declared more than once in the same scope, even in
3261 cases where multiple declaration is valid and changes nothing.
3262
3263 @item -Wnested-externs @r{(C only)}
3264 @opindex Wnested-externs
3265 Warn if an @code{extern} declaration is encountered within a function.
3266
3267 @item -Wunreachable-code
3268 @opindex Wunreachable-code
3269 Warn if the compiler detects that code will never be executed.
3270
3271 This option is intended to warn when the compiler detects that at
3272 least a whole line of source code will never be executed, because
3273 some condition is never satisfied or because it is after a
3274 procedure that never returns.
3275
3276 It is possible for this option to produce a warning even though there
3277 are circumstances under which part of the affected line can be executed,
3278 so care should be taken when removing apparently-unreachable code.
3279
3280 For instance, when a function is inlined, a warning may mean that the
3281 line is unreachable in only one inlined copy of the function.
3282
3283 This option is not made part of @option{-Wall} because in a debugging
3284 version of a program there is often substantial code which checks
3285 correct functioning of the program and is, hopefully, unreachable
3286 because the program does work.  Another common use of unreachable
3287 code is to provide behavior which is selectable at compile-time.
3288
3289 @item -Winline
3290 @opindex Winline
3291 Warn if a function can not be inlined and it was declared as inline.
3292 Even with this option, the compiler will not warn about failures to
3293 inline functions declared in system headers.
3294
3295 The compiler uses a variety of heuristics to determine whether or not
3296 to inline a function.  For example, the compiler takes into account
3297 the size of the function being inlined and the amount of inlining
3298 that has already been done in the current function.  Therefore,
3299 seemingly insignificant changes in the source program can cause the
3300 warnings produced by @option{-Winline} to appear or disappear.
3301
3302 @item -Wno-invalid-offsetof @r{(C++ only)}
3303 @opindex Wno-invalid-offsetof
3304 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3305 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3306 to a non-POD type is undefined.  In existing C++ implementations,
3307 however, @samp{offsetof} typically gives meaningful results even when
3308 applied to certain kinds of non-POD types. (Such as a simple
3309 @samp{struct} that fails to be a POD type only by virtue of having a
3310 constructor.)  This flag is for users who are aware that they are
3311 writing nonportable code and who have deliberately chosen to ignore the
3312 warning about it.
3313
3314 The restrictions on @samp{offsetof} may be relaxed in a future version
3315 of the C++ standard.
3316
3317 @item -Wno-int-to-pointer-cast @r{(C only)}
3318 @opindex Wno-int-to-pointer-cast
3319 Suppress warnings from casts to pointer type of an integer of a
3320 different size.
3321
3322 @item -Wno-pointer-to-int-cast @r{(C only)}
3323 @opindex Wno-pointer-to-int-cast
3324 Suppress warnings from casts from a pointer to an integer type of a
3325 different size.
3326
3327 @item -Winvalid-pch
3328 @opindex Winvalid-pch
3329 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3330 the search path but can't be used.
3331
3332 @item -Wlong-long
3333 @opindex Wlong-long
3334 @opindex Wno-long-long
3335 Warn if @samp{long long} type is used.  This is default.  To inhibit
3336 the warning messages, use @option{-Wno-long-long}.  Flags
3337 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3338 only when @option{-pedantic} flag is used.
3339
3340 @item -Wvariadic-macros
3341 @opindex Wvariadic-macros
3342 @opindex Wno-variadic-macros
3343 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3344 alternate syntax when in pedantic ISO C99 mode.  This is default.
3345 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3346
3347 @item -Wdisabled-optimization
3348 @opindex Wdisabled-optimization
3349 Warn if a requested optimization pass is disabled.  This warning does
3350 not generally indicate that there is anything wrong with your code; it
3351 merely indicates that GCC's optimizers were unable to handle the code
3352 effectively.  Often, the problem is that your code is too big or too
3353 complex; GCC will refuse to optimize programs when the optimization
3354 itself is likely to take inordinate amounts of time.
3355
3356 @item -Wno-pointer-sign
3357 @opindex Wno-pointer-sign
3358 Don't warn for pointer argument passing or assignment with different signedness.
3359 Only useful in the negative form since this warning is enabled by default.
3360 This option is only supported for C and Objective-C@.
3361
3362 @item -Werror
3363 @opindex Werror
3364 Make all warnings into errors.
3365 @end table
3366
3367 @node Debugging Options
3368 @section Options for Debugging Your Program or GCC
3369 @cindex options, debugging
3370 @cindex debugging information options
3371
3372 GCC has various special options that are used for debugging
3373 either your program or GCC:
3374
3375 @table @gcctabopt
3376 @item -g
3377 @opindex g
3378 Produce debugging information in the operating system's native format
3379 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3380 information.
3381
3382 On most systems that use stabs format, @option{-g} enables use of extra
3383 debugging information that only GDB can use; this extra information
3384 makes debugging work better in GDB but will probably make other debuggers
3385 crash or
3386 refuse to read the program.  If you want to control for certain whether
3387 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3388 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3389
3390 GCC allows you to use @option{-g} with
3391 @option{-O}.  The shortcuts taken by optimized code may occasionally
3392 produce surprising results: some variables you declared may not exist
3393 at all; flow of control may briefly move where you did not expect it;
3394 some statements may not be executed because they compute constant
3395 results or their values were already at hand; some statements may
3396 execute in different places because they were moved out of loops.
3397
3398 Nevertheless it proves possible to debug optimized output.  This makes
3399 it reasonable to use the optimizer for programs that might have bugs.
3400
3401 The following options are useful when GCC is generated with the
3402 capability for more than one debugging format.
3403
3404 @item -ggdb
3405 @opindex ggdb
3406 Produce debugging information for use by GDB@.  This means to use the
3407 most expressive format available (DWARF 2, stabs, or the native format
3408 if neither of those are supported), including GDB extensions if at all
3409 possible.
3410
3411 @item -gstabs
3412 @opindex gstabs
3413 Produce debugging information in stabs format (if that is supported),
3414 without GDB extensions.  This is the format used by DBX on most BSD
3415 systems.  On MIPS, Alpha and System V Release 4 systems this option
3416 produces stabs debugging output which is not understood by DBX or SDB@.
3417 On System V Release 4 systems this option requires the GNU assembler.
3418
3419 @item -feliminate-unused-debug-symbols
3420 @opindex feliminate-unused-debug-symbols
3421 Produce debugging information in stabs format (if that is supported),
3422 for only symbols that are actually used.
3423
3424 @item -gstabs+
3425 @opindex gstabs+
3426 Produce debugging information in stabs format (if that is supported),
3427 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3428 use of these extensions is likely to make other debuggers crash or
3429 refuse to read the program.
3430
3431 @item -gcoff
3432 @opindex gcoff
3433 Produce debugging information in COFF format (if that is supported).
3434 This is the format used by SDB on most System V systems prior to
3435 System V Release 4.
3436
3437 @item -gxcoff
3438 @opindex gxcoff
3439 Produce debugging information in XCOFF format (if that is supported).
3440 This is the format used by the DBX debugger on IBM RS/6000 systems.
3441
3442 @item -gxcoff+
3443 @opindex gxcoff+
3444 Produce debugging information in XCOFF format (if that is supported),
3445 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3446 use of these extensions is likely to make other debuggers crash or
3447 refuse to read the program, and may cause assemblers other than the GNU
3448 assembler (GAS) to fail with an error.
3449
3450 @item -gdwarf-2
3451 @opindex gdwarf-2
3452 Produce debugging information in DWARF version 2 format (if that is
3453 supported).  This is the format used by DBX on IRIX 6.  With this
3454 option, GCC uses features of DWARF version 3 when they are useful;
3455 version 3 is upward compatible with version 2, but may still cause
3456 problems for older debuggers.
3457
3458 @item -gvms
3459 @opindex gvms
3460 Produce debugging information in VMS debug format (if that is
3461 supported).  This is the format used by DEBUG on VMS systems.
3462
3463 @item -g@var{level}
3464 @itemx -ggdb@var{level}
3465 @itemx -gstabs@var{level}
3466 @itemx -gcoff@var{level}
3467 @itemx -gxcoff@var{level}
3468 @itemx -gvms@var{level}
3469 Request debugging information and also use @var{level} to specify how
3470 much information.  The default level is 2.
3471
3472 Level 1 produces minimal information, enough for making backtraces in
3473 parts of the program that you don't plan to debug.  This includes
3474 descriptions of functions and external variables, but no information
3475 about local variables and no line numbers.
3476
3477 Level 3 includes extra information, such as all the macro definitions
3478 present in the program.  Some debuggers support macro expansion when
3479 you use @option{-g3}.
3480
3481 @option{-gdwarf-2} does not accept a concatenated debug level, because
3482 GCC used to support an option @option{-gdwarf} that meant to generate
3483 debug information in version 1 of the DWARF format (which is very
3484 different from version 2), and it would have been too confusing.  That
3485 debug format is long obsolete, but the option cannot be changed now.
3486 Instead use an additional @option{-g@var{level}} option to change the
3487 debug level for DWARF2.
3488
3489 @item -feliminate-dwarf2-dups
3490 @opindex feliminate-dwarf2-dups
3491 Compress DWARF2 debugging information by eliminating duplicated
3492 information about each symbol.  This option only makes sense when
3493 generating DWARF2 debugging information with @option{-gdwarf-2}.
3494
3495 @cindex @command{prof}
3496 @item -p
3497 @opindex p
3498 Generate extra code to write profile information suitable for the
3499 analysis program @command{prof}.  You must use this option when compiling
3500 the source files you want data about, and you must also use it when
3501 linking.
3502
3503 @cindex @command{gprof}
3504 @item -pg
3505 @opindex pg
3506 Generate extra code to write profile information suitable for the
3507 analysis program @command{gprof}.  You must use this option when compiling
3508 the source files you want data about, and you must also use it when
3509 linking.
3510
3511 @item -Q
3512 @opindex Q
3513 Makes the compiler print out each function name as it is compiled, and
3514 print some statistics about each pass when it finishes.
3515
3516 @item -ftime-report
3517 @opindex ftime-report
3518 Makes the compiler print some statistics about the time consumed by each
3519 pass when it finishes.
3520
3521 @item -fmem-report
3522 @opindex fmem-report
3523 Makes the compiler print some statistics about permanent memory
3524 allocation when it finishes.
3525
3526 @item -fprofile-arcs
3527 @opindex fprofile-arcs
3528 Add code so that program flow @dfn{arcs} are instrumented.  During
3529 execution the program records how many times each branch and call is
3530 executed and how many times it is taken or returns.  When the compiled
3531 program exits it saves this data to a file called
3532 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3533 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3534 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3535 @var{auxname} is generated from the name of the output file, if
3536 explicitly specified and it is not the final executable, otherwise it is
3537 the basename of the source file.  In both cases any suffix is removed
3538 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3539 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3540 @xref{Cross-profiling}.
3541
3542 @cindex @command{gcov}
3543 @item --coverage
3544 @opindex coverage
3545
3546 This option is used to compile and link code instrumented for coverage
3547 analysis.  The option is a synonym for @option{-fprofile-arcs}
3548 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3549 linking).  See the documentation for those options for more details.
3550
3551 @itemize
3552
3553 @item
3554 Compile the source files with @option{-fprofile-arcs} plus optimization
3555 and code generation options.  For test coverage analysis, use the
3556 additional @option{-ftest-coverage} option.  You do not need to profile
3557 every source file in a program.
3558
3559 @item
3560 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3561 (the latter implies the former).
3562
3563 @item
3564 Run the program on a representative workload to generate the arc profile
3565 information.  This may be repeated any number of times.  You can run
3566 concurrent instances of your program, and provided that the file system
3567 supports locking, the data files will be correctly updated.  Also
3568 @code{fork} calls are detected and correctly handled (double counting
3569 will not happen).
3570
3571 @item
3572 For profile-directed optimizations, compile the source files again with
3573 the same optimization and code generation options plus
3574 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3575 Control Optimization}).
3576
3577 @item
3578 For test coverage analysis, use @command{gcov} to produce human readable
3579 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3580 @command{gcov} documentation for further information.
3581
3582 @end itemize
3583
3584 With @option{-fprofile-arcs}, for each function of your program GCC
3585 creates a program flow graph, then finds a spanning tree for the graph.
3586 Only arcs that are not on the spanning tree have to be instrumented: the
3587 compiler adds code to count the number of times that these arcs are
3588 executed.  When an arc is the only exit or only entrance to a block, the
3589 instrumentation code can be added to the block; otherwise, a new basic
3590 block must be created to hold the instrumentation code.
3591
3592 @need 2000
3593 @item -ftest-coverage
3594 @opindex ftest-coverage
3595 Produce a notes file that the @command{gcov} code-coverage utility
3596 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3597 show program coverage.  Each source file's note file is called
3598 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3599 above for a description of @var{auxname} and instructions on how to
3600 generate test coverage data.  Coverage data will match the source files
3601 more closely, if you do not optimize.
3602
3603 @item -d@var{letters}
3604 @item -fdump-rtl-@var{pass}
3605 @opindex d
3606 Says to make debugging dumps during compilation at times specified by
3607 @var{letters}.    This is used for debugging the RTL-based passes of the
3608 compiler.  The file names for most of the dumps are made by appending a
3609 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3610 from the name of the output file, if explicitly specified and it is not
3611 an executable, otherwise it is the basename of the source file.
3612
3613 Most debug dumps can be enabled either passing a letter to the @option{-d}
3614 option, or with a long @option{-fdump-rtl} switch; here are the possible
3615 letters for use in @var{letters} and @var{pass}, and their meanings:
3616
3617 @table @gcctabopt
3618 @item -dA
3619 @opindex dA
3620 Annotate the assembler output with miscellaneous debugging information.
3621
3622 @item -db
3623 @itemx -fdump-rtl-bp
3624 @opindex db
3625 @opindex fdump-rtl-bp
3626 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3627
3628 @item -dB
3629 @itemx -fdump-rtl-bbro
3630 @opindex dB
3631 @opindex fdump-rtl-bbro
3632 Dump after block reordering, to @file{@var{file}.30.bbro}.
3633
3634 @item -dc
3635 @itemx -fdump-rtl-combine
3636 @opindex dc
3637 @opindex fdump-rtl-combine
3638 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3639
3640 @item -dC
3641 @itemx -fdump-rtl-ce1
3642 @itemx -fdump-rtl-ce2
3643 @opindex dC
3644 @opindex fdump-rtl-ce1
3645 @opindex fdump-rtl-ce2
3646 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3647 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3648 and @option{-fdump-rtl-ce2} enable dumping after the second if
3649 conversion, to the file @file{@var{file}.18.ce2}.
3650
3651 @item -dd
3652 @itemx -fdump-rtl-btl
3653 @itemx -fdump-rtl-dbr
3654 @opindex dd
3655 @opindex fdump-rtl-btl
3656 @opindex fdump-rtl-dbr
3657 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3658 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3659 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3660 scheduling, to @file{@var{file}.36.dbr}.
3661
3662 @item -dD
3663 @opindex dD
3664 Dump all macro definitions, at the end of preprocessing, in addition to
3665 normal output.
3666
3667 @item -dE
3668 @itemx -fdump-rtl-ce3
3669 @opindex dE
3670 @opindex fdump-rtl-ce3
3671 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3672
3673 @item -df
3674 @itemx -fdump-rtl-cfg
3675 @itemx -fdump-rtl-life
3676 @opindex df
3677 @opindex fdump-rtl-cfg
3678 @opindex fdump-rtl-life
3679 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3680 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3681 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3682 to @file{@var{file}.16.life}.
3683
3684 @item -dg
3685 @itemx -fdump-rtl-greg
3686 @opindex dg
3687 @opindex fdump-rtl-greg
3688 Dump after global register allocation, to @file{@var{file}.23.greg}.
3689
3690 @item -dG
3691 @itemx -fdump-rtl-gcse
3692 @itemx -fdump-rtl-bypass
3693 @opindex dG
3694 @opindex fdump-rtl-gcse
3695 @opindex fdump-rtl-bypass
3696 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3697 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3698 enable dumping after jump bypassing and control flow optimizations, to
3699 @file{@var{file}.07.bypass}.
3700
3701 @item -dh
3702 @itemx -fdump-rtl-eh
3703 @opindex dh
3704 @opindex fdump-rtl-eh
3705 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3706
3707 @item -di
3708 @itemx -fdump-rtl-sibling
3709 @opindex di
3710 @opindex fdump-rtl-sibling
3711 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3712
3713 @item -dj
3714 @itemx -fdump-rtl-jump
3715 @opindex dj
3716 @opindex fdump-rtl-jump
3717 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3718
3719 @item -dk
3720 @itemx -fdump-rtl-stack
3721 @opindex dk
3722 @opindex fdump-rtl-stack
3723 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3724
3725 @item -dl
3726 @itemx -fdump-rtl-lreg
3727 @opindex dl
3728 @opindex fdump-rtl-lreg
3729 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3730
3731 @item -dL
3732 @itemx -fdump-rtl-loop
3733 @itemx -fdump-rtl-loop2
3734 @opindex dL
3735 @opindex fdump-rtl-loop
3736 @opindex fdump-rtl-loop2
3737 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3738 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3739 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3740 @file{@var{file}.13.loop2}.
3741
3742 @item -dm
3743 @itemx -fdump-rtl-sms
3744 @opindex dm
3745 @opindex fdump-rtl-sms
3746 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3747
3748 @item -dM
3749 @itemx -fdump-rtl-mach
3750 @opindex dM
3751 @opindex fdump-rtl-mach
3752 Dump after performing the machine dependent reorganization pass, to
3753 @file{@var{file}.35.mach}.
3754
3755 @item -dn
3756 @itemx -fdump-rtl-rnreg
3757 @opindex dn
3758 @opindex fdump-rtl-rnreg
3759 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3760
3761 @item -dN
3762 @itemx -fdump-rtl-regmove
3763 @opindex dN
3764 @opindex fdump-rtl-regmove
3765 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3766
3767 @item -do
3768 @itemx -fdump-rtl-postreload
3769 @opindex do
3770 @opindex fdump-rtl-postreload
3771 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3772
3773 @item -dr
3774 @itemx -fdump-rtl-expand
3775 @opindex dr
3776 @opindex fdump-rtl-expand
3777 Dump after RTL generation, to @file{@var{file}.00.expand}.
3778
3779 @item -dR
3780 @itemx -fdump-rtl-sched2
3781 @opindex dR
3782 @opindex fdump-rtl-sched2
3783 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3784
3785 @item -ds
3786 @itemx -fdump-rtl-cse
3787 @opindex ds
3788 @opindex fdump-rtl-cse
3789 Dump after CSE (including the jump optimization that sometimes follows
3790 CSE), to @file{@var{file}.04.cse}.
3791
3792 @item -dS
3793 @itemx -fdump-rtl-sched
3794 @opindex dS
3795 @opindex fdump-rtl-sched
3796 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3797
3798 @item -dt
3799 @itemx -fdump-rtl-cse2
3800 @opindex dt
3801 @opindex fdump-rtl-cse2
3802 Dump after the second CSE pass (including the jump optimization that
3803 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3804
3805 @item -dT
3806 @itemx -fdump-rtl-tracer
3807 @opindex dT
3808 @opindex fdump-rtl-tracer
3809 Dump after running tracer, to @file{@var{file}.12.tracer}.
3810
3811 @item -dV
3812 @itemx -fdump-rtl-vpt
3813 @itemx -fdump-rtl-vartrack
3814 @opindex dV
3815 @opindex fdump-rtl-vpt
3816 @opindex fdump-rtl-vartrack
3817 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3818 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3819 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3820 to @file{@var{file}.34.vartrack}.
3821
3822 @item -dw
3823 @itemx -fdump-rtl-flow2
3824 @opindex dw
3825 @opindex fdump-rtl-flow2
3826 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3827
3828 @item -dz
3829 @itemx -fdump-rtl-peephole2
3830 @opindex dz
3831 @opindex fdump-rtl-peephole2
3832 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3833
3834 @item -dZ
3835 @itemx -fdump-rtl-web
3836 @opindex dZ
3837 @opindex fdump-rtl-web
3838 Dump after live range splitting, to @file{@var{file}.14.web}.
3839
3840 @item -da
3841 @itemx -fdump-rtl-all
3842 @opindex da
3843 @opindex fdump-rtl-all
3844 Produce all the dumps listed above.
3845
3846 @item -dH
3847 @opindex dH
3848 Produce a core dump whenever an error occurs.
3849
3850 @item -dm
3851 @opindex dm
3852 Print statistics on memory usage, at the end of the run, to
3853 standard error.
3854
3855 @item -dp
3856 @opindex dp
3857 Annotate the assembler output with a comment indicating which
3858 pattern and alternative was used.  The length of each instruction is
3859 also printed.
3860
3861 @item -dP
3862 @opindex dP
3863 Dump the RTL in the assembler output as a comment before each instruction.
3864 Also turns on @option{-dp} annotation.
3865
3866 @item -dv
3867 @opindex dv
3868 For each of the other indicated dump files (either with @option{-d} or
3869 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3870 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3871
3872 @item -dx
3873 @opindex dx
3874 Just generate RTL for a function instead of compiling it.  Usually used
3875 with @samp{r} (@option{-fdump-rtl-expand}).
3876
3877 @item -dy
3878 @opindex dy
3879 Dump debugging information during parsing, to standard error.
3880 @end table
3881
3882 @item -fdump-unnumbered
3883 @opindex fdump-unnumbered
3884 When doing debugging dumps (see @option{-d} option above), suppress instruction
3885 numbers and line number note output.  This makes it more feasible to
3886 use diff on debugging dumps for compiler invocations with different
3887 options, in particular with and without @option{-g}.
3888
3889 @item -fdump-translation-unit @r{(C++ only)}
3890 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3891 @opindex fdump-translation-unit
3892 Dump a representation of the tree structure for the entire translation
3893 unit to a file.  The file name is made by appending @file{.tu} to the
3894 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3895 controls the details of the dump as described for the
3896 @option{-fdump-tree} options.
3897
3898 @item -fdump-class-hierarchy @r{(C++ only)}
3899 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3900 @opindex fdump-class-hierarchy
3901 Dump a representation of each class's hierarchy and virtual function
3902 table layout to a file.  The file name is made by appending @file{.class}
3903 to the source file name.  If the @samp{-@var{options}} form is used,
3904 @var{options} controls the details of the dump as described for the
3905 @option{-fdump-tree} options.
3906
3907 @item -fdump-ipa-@var{switch}
3908 @opindex fdump-ipa
3909 Control the dumping at various stages of inter-procedural analysis
3910 language tree to a file.  The file name is generated by appending a switch
3911 specific suffix to the source file name.  The following dumps are possible:
3912
3913 @table @samp
3914 @item all
3915 Enables all inter-procedural analysis dumps; currently the only produced
3916 dump is the @samp{cgraph} dump.
3917
3918 @item cgraph
3919 Dumps information about call-graph optimization, unused function removal,
3920 and inlining decisions.
3921 @end table
3922
3923 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3924 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3925 @opindex fdump-tree
3926 Control the dumping at various stages of processing the intermediate
3927 language tree to a file.  The file name is generated by appending a switch
3928 specific suffix to the source file name.  If the @samp{-@var{options}}
3929 form is used, @var{options} is a list of @samp{-} separated options that
3930 control the details of the dump.  Not all options are applicable to all
3931 dumps, those which are not meaningful will be ignored.  The following
3932 options are available
3933
3934 @table @samp
3935 @item address
3936 Print the address of each node.  Usually this is not meaningful as it
3937 changes according to the environment and source file.  Its primary use
3938 is for tying up a dump file with a debug environment.
3939 @item slim
3940 Inhibit dumping of members of a scope or body of a function merely
3941 because that scope has been reached.  Only dump such items when they
3942 are directly reachable by some other path.  When dumping pretty-printed
3943 trees, this option inhibits dumping the bodies of control structures.
3944 @item raw
3945 Print a raw representation of the tree.  By default, trees are
3946 pretty-printed into a C-like representation.
3947 @item details
3948 Enable more detailed dumps (not honored by every dump option).
3949 @item stats
3950 Enable dumping various statistics about the pass (not honored by every dump
3951 option).
3952 @item blocks
3953 Enable showing basic block boundaries (disabled in raw dumps).
3954 @item vops
3955 Enable showing virtual operands for every statement.
3956 @item lineno
3957 Enable showing line numbers for statements.
3958 @item uid
3959 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3960 @item all
3961 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3962 @end table
3963
3964 The following tree dumps are possible:
3965 @table @samp
3966
3967 @item original
3968 Dump before any tree based optimization, to @file{@var{file}.original}.
3969
3970 @item optimized
3971 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3972
3973 @item inlined
3974 Dump after function inlining, to @file{@var{file}.inlined}.
3975
3976 @item gimple
3977 @opindex fdump-tree-gimple
3978 Dump each function before and after the gimplification pass to a file.  The
3979 file name is made by appending @file{.gimple} to the source file name.
3980
3981 @item cfg
3982 @opindex fdump-tree-cfg
3983 Dump the control flow graph of each function to a file.  The file name is
3984 made by appending @file{.cfg} to the source file name.
3985
3986 @item vcg
3987 @opindex fdump-tree-vcg
3988 Dump the control flow graph of each function to a file in VCG format.  The
3989 file name is made by appending @file{.vcg} to the source file name.  Note
3990 that if the file contains more than one function, the generated file cannot
3991 be used directly by VCG@.  You will need to cut and paste each function's
3992 graph into its own separate file first.
3993
3994 @item ch
3995 @opindex fdump-tree-ch
3996 Dump each function after copying loop headers.  The file name is made by
3997 appending @file{.ch} to the source file name.
3998
3999 @item ssa
4000 @opindex fdump-tree-ssa
4001 Dump SSA related information to a file.  The file name is made by appending
4002 @file{.ssa} to the source file name.
4003
4004 @item salias
4005 @opindex fdump-tree-salias
4006 Dump structure aliasing variable information to a file.  This file name
4007 is made by appending @file{.salias} to the source file name.
4008
4009 @item alias
4010 @opindex fdump-tree-alias
4011 Dump aliasing information for each function.  The file name is made by
4012 appending @file{.alias} to the source file name.
4013
4014 @item ccp
4015 @opindex fdump-tree-ccp
4016 Dump each function after CCP@.  The file name is made by appending
4017 @file{.ccp} to the source file name.
4018
4019 @item storeccp
4020 @opindex fdump-tree-storeccp
4021 Dump each function after STORE-CCP.  The file name is made by appending
4022 @file{.storeccp} to the source file name.
4023
4024 @item pre
4025 @opindex fdump-tree-pre
4026 Dump trees after partial redundancy elimination.  The file name is made
4027 by appending @file{.pre} to the source file name.
4028
4029 @item fre
4030 @opindex fdump-tree-fre
4031 Dump trees after full redundancy elimination.  The file name is made
4032 by appending @file{.fre} to the source file name.
4033
4034 @item copyprop
4035 @opindex fdump-tree-copyprop
4036 Dump trees after copy propagation.  The file name is made
4037 by appending @file{.copyprop} to the source file name.
4038
4039 @item store_copyprop
4040 @opindex fdump-tree-store_copyprop
4041 Dump trees after store copy-propagation.  The file name is made
4042 by appending @file{.store_copyprop} to the source file name.
4043
4044 @item dce
4045 @opindex fdump-tree-dce
4046 Dump each function after dead code elimination.  The file name is made by
4047 appending @file{.dce} to the source file name.
4048
4049 @item mudflap
4050 @opindex fdump-tree-mudflap
4051 Dump each function after adding mudflap instrumentation.  The file name is
4052 made by appending @file{.mudflap} to the source file name.
4053
4054 @item sra
4055 @opindex fdump-tree-sra
4056 Dump each function after performing scalar replacement of aggregates.  The
4057 file name is made by appending @file{.sra} to the source file name.
4058
4059 @item sink
4060 @opindex fdump-tree-sink
4061 Dump each function after performing code sinking.  The file name is made
4062 by appending @file{.sink} to the source file name. 
4063
4064 @item dom
4065 @opindex fdump-tree-dom
4066 Dump each function after applying dominator tree optimizations.  The file
4067 name is made by appending @file{.dom} to the source file name.
4068
4069 @item dse
4070 @opindex fdump-tree-dse
4071 Dump each function after applying dead store elimination.  The file
4072 name is made by appending @file{.dse} to the source file name.
4073
4074 @item phiopt
4075 @opindex fdump-tree-phiopt
4076 Dump each function after optimizing PHI nodes into straightline code.  The file
4077 name is made by appending @file{.phiopt} to the source file name.
4078
4079 @item forwprop
4080 @opindex fdump-tree-forwprop
4081 Dump each function after forward propagating single use variables.  The file
4082 name is made by appending @file{.forwprop} to the source file name.
4083
4084 @item copyrename
4085 @opindex fdump-tree-copyrename
4086 Dump each function after applying the copy rename optimization.  The file
4087 name is made by appending @file{.copyrename} to the source file name.
4088
4089 @item nrv
4090 @opindex fdump-tree-nrv
4091 Dump each function after applying the named return value optimization on
4092 generic trees.  The file name is made by appending @file{.nrv} to the source
4093 file name.
4094
4095 @item vect
4096 @opindex fdump-tree-vect
4097 Dump each function after applying vectorization of loops.  The file name is
4098 made by appending @file{.vect} to the source file name.
4099
4100 @item vrp
4101 @opindex fdump-tree-vrp
4102 Dump each function after Value Range Propagation (VRP).  The file name
4103 is made by appending @file{.vrp} to the source file name.
4104
4105 @item all
4106 @opindex fdump-tree-all
4107 Enable all the available tree dumps with the flags provided in this option.
4108 @end table
4109
4110 @item -ftree-vectorizer-verbose=@var{n}
4111 @opindex ftree-vectorizer-verbose
4112 This option controls the amount of debugging output the vectorizer prints.
4113 This information is written to standard error, unless @option{-fdump-tree-all}
4114 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4115 usual dump listing file, @file{.vect}.
4116
4117 @item -frandom-seed=@var{string}
4118 @opindex frandom-string
4119 This option provides a seed that GCC uses when it would otherwise use
4120 random numbers.  It is used to generate certain symbol names
4121 that have to be different in every compiled file.  It is also used to
4122 place unique stamps in coverage data files and the object files that
4123 produce them.  You can use the @option{-frandom-seed} option to produce
4124 reproducibly identical object files.
4125
4126 The @var{string} should be different for every file you compile.
4127
4128 @item -fsched-verbose=@var{n}
4129 @opindex fsched-verbose
4130 On targets that use instruction scheduling, this option controls the
4131 amount of debugging output the scheduler prints.  This information is
4132 written to standard error, unless @option{-dS} or @option{-dR} is
4133 specified, in which case it is output to the usual dump
4134 listing file, @file{.sched} or @file{.sched2} respectively.  However
4135 for @var{n} greater than nine, the output is always printed to standard
4136 error.
4137
4138 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4139 same information as @option{-dRS}.  For @var{n} greater than one, it
4140 also output basic block probabilities, detailed ready list information
4141 and unit/insn info.  For @var{n} greater than two, it includes RTL
4142 at abort point, control-flow and regions info.  And for @var{n} over
4143 four, @option{-fsched-verbose} also includes dependence info.
4144
4145 @item -save-temps
4146 @opindex save-temps
4147 Store the usual ``temporary'' intermediate files permanently; place them
4148 in the current directory and name them based on the source file.  Thus,
4149 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4150 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4151 preprocessed @file{foo.i} output file even though the compiler now
4152 normally uses an integrated preprocessor.
4153
4154 When used in combination with the @option{-x} command line option,
4155 @option{-save-temps} is sensible enough to avoid over writing an
4156 input source file with the same extension as an intermediate file.
4157 The corresponding intermediate file may be obtained by renaming the
4158 source file before using @option{-save-temps}.
4159
4160 @item -time
4161 @opindex time
4162 Report the CPU time taken by each subprocess in the compilation
4163 sequence.  For C source files, this is the compiler proper and assembler
4164 (plus the linker if linking is done).  The output looks like this:
4165
4166 @smallexample
4167 # cc1 0.12 0.01
4168 # as 0.00 0.01
4169 @end smallexample
4170
4171 The first number on each line is the ``user time'', that is time spent
4172 executing the program itself.  The second number is ``system time'',
4173 time spent executing operating system routines on behalf of the program.
4174 Both numbers are in seconds.
4175
4176 @item -fvar-tracking
4177 @opindex fvar-tracking
4178 Run variable tracking pass.  It computes where variables are stored at each
4179 position in code.  Better debugging information is then generated
4180 (if the debugging information format supports this information).
4181
4182 It is enabled by default when compiling with optimization (@option{-Os},
4183 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4184 the debug info format supports it.
4185
4186 @item -print-file-name=@var{library}
4187 @opindex print-file-name
4188 Print the full absolute name of the library file @var{library} that
4189 would be used when linking---and don't do anything else.  With this
4190 option, GCC does not compile or link anything; it just prints the
4191 file name.
4192
4193 @item -print-multi-directory
4194 @opindex print-multi-directory
4195 Print the directory name corresponding to the multilib selected by any
4196 other switches present in the command line.  This directory is supposed
4197 to exist in @env{GCC_EXEC_PREFIX}.
4198
4199 @item -print-multi-lib
4200 @opindex print-multi-lib
4201 Print the mapping from multilib directory names to compiler switches
4202 that enable them.  The directory name is separated from the switches by
4203 @samp{;}, and each switch starts with an @samp{@@} instead of the
4204 @samp{-}, without spaces between multiple switches.  This is supposed to
4205 ease shell-processing.
4206
4207 @item -print-prog-name=@var{program}
4208 @opindex print-prog-name
4209 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4210
4211 @item -print-libgcc-file-name
4212 @opindex print-libgcc-file-name
4213 Same as @option{-print-file-name=libgcc.a}.
4214
4215 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4216 but you do want to link with @file{libgcc.a}.  You can do
4217
4218 @smallexample
4219 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4220 @end smallexample
4221
4222 @item -print-search-dirs
4223 @opindex print-search-dirs
4224 Print the name of the configured installation directory and a list of
4225 program and library directories @command{gcc} will search---and don't do anything else.
4226
4227 This is useful when @command{gcc} prints the error message
4228 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4229 To resolve this you either need to put @file{cpp0} and the other compiler
4230 components where @command{gcc} expects to find them, or you can set the environment
4231 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4232 Don't forget the trailing @samp{/}.
4233 @xref{Environment Variables}.
4234
4235 @item -dumpmachine
4236 @opindex dumpmachine
4237 Print the compiler's target machine (for example,
4238 @samp{i686-pc-linux-gnu})---and don't do anything else.
4239
4240 @item -dumpversion
4241 @opindex dumpversion
4242 Print the compiler version (for example, @samp{3.0})---and don't do
4243 anything else.
4244
4245 @item -dumpspecs
4246 @opindex dumpspecs
4247 Print the compiler's built-in specs---and don't do anything else.  (This
4248 is used when GCC itself is being built.)  @xref{Spec Files}.
4249
4250 @item -feliminate-unused-debug-types
4251 @opindex feliminate-unused-debug-types
4252 Normally, when producing DWARF2 output, GCC will emit debugging
4253 information for all types declared in a compilation
4254 unit, regardless of whether or not they are actually used
4255 in that compilation unit.  Sometimes this is useful, such as
4256 if, in the debugger, you want to cast a value to a type that is
4257 not actually used in your program (but is declared).  More often,
4258 however, this results in a significant amount of wasted space.
4259 With this option, GCC will avoid producing debug symbol output
4260 for types that are nowhere used in the source file being compiled.
4261 @end table
4262
4263 @node Optimize Options
4264 @section Options That Control Optimization
4265 @cindex optimize options
4266 @cindex options, optimization
4267
4268 These options control various sorts of optimizations.
4269
4270 Without any optimization option, the compiler's goal is to reduce the
4271 cost of compilation and to make debugging produce the expected
4272 results.  Statements are independent: if you stop the program with a
4273 breakpoint between statements, you can then assign a new value to any
4274 variable or change the program counter to any other statement in the
4275 function and get exactly the results you would expect from the source
4276 code.
4277
4278 Turning on optimization flags makes the compiler attempt to improve
4279 the performance and/or code size at the expense of compilation time
4280 and possibly the ability to debug the program.
4281
4282 The compiler performs optimization based on the knowledge it has of
4283 the program.  Optimization levels @option{-O2} and above, in
4284 particular, enable @emph{unit-at-a-time} mode, which allows the
4285 compiler to consider information gained from later functions in
4286 the file when compiling a function.  Compiling multiple files at
4287 once to a single output file in @emph{unit-at-a-time} mode allows
4288 the compiler to use information gained from all of the files when
4289 compiling each of them.
4290
4291 Not all optimizations are controlled directly by a flag.  Only
4292 optimizations that have a flag are listed.
4293
4294 @table @gcctabopt
4295 @item -O
4296 @itemx -O1
4297 @opindex O
4298 @opindex O1
4299 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4300 more memory for a large function.
4301
4302 With @option{-O}, the compiler tries to reduce code size and execution
4303 time, without performing any optimizations that take a great deal of
4304 compilation time.
4305
4306 @option{-O} turns on the following optimization flags:
4307 @gccoptlist{-fdefer-pop @gol
4308 -fdelayed-branch @gol
4309 -fguess-branch-probability @gol
4310 -fcprop-registers @gol
4311 -floop-optimize @gol
4312 -fif-conversion @gol
4313 -fif-conversion2 @gol
4314 -ftree-ccp @gol
4315 -ftree-dce @gol
4316 -ftree-dominator-opts @gol
4317 -ftree-dse @gol
4318 -ftree-ter @gol
4319 -ftree-lrs @gol
4320 -ftree-sra @gol
4321 -ftree-copyrename @gol
4322 -ftree-fre @gol
4323 -ftree-ch @gol
4324 -fmerge-constants}
4325
4326 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4327 where doing so does not interfere with debugging.
4328
4329 @item -O2
4330 @opindex O2
4331 Optimize even more.  GCC performs nearly all supported optimizations
4332 that do not involve a space-speed tradeoff.  The compiler does not
4333 perform loop unrolling or function inlining when you specify @option{-O2}.
4334 As compared to @option{-O}, this option increases both compilation time
4335 and the performance of the generated code.
4336
4337 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4338 also turns on the following optimization flags:
4339 @gccoptlist{-fthread-jumps @gol
4340 -fcrossjumping @gol
4341 -foptimize-sibling-calls @gol
4342 -fcse-follow-jumps  -fcse-skip-blocks @gol
4343 -fgcse  -fgcse-lm  @gol
4344 -fexpensive-optimizations @gol
4345 -fstrength-reduce @gol
4346 -frerun-cse-after-loop  -frerun-loop-opt @gol
4347 -fcaller-saves @gol
4348 -fpeephole2 @gol
4349 -fschedule-insns  -fschedule-insns2 @gol
4350 -fsched-interblock  -fsched-spec @gol
4351 -fregmove @gol
4352 -fstrict-aliasing @gol
4353 -fdelete-null-pointer-checks @gol
4354 -freorder-blocks  -freorder-functions @gol
4355 -funit-at-a-time @gol
4356 -falign-functions  -falign-jumps @gol
4357 -falign-loops  -falign-labels @gol
4358 -ftree-vrp @gol
4359 -ftree-pre}
4360
4361 Please note the warning under @option{-fgcse} about
4362 invoking @option{-O2} on programs that use computed gotos.
4363
4364 @item -O3
4365 @opindex O3
4366 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4367 @option{-O2} and also turns on the @option{-finline-functions},
4368 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4369
4370 @item -O0
4371 @opindex O0
4372 Do not optimize.  This is the default.
4373
4374 @item -Os
4375 @opindex Os
4376 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4377 do not typically increase code size.  It also performs further
4378 optimizations designed to reduce code size.
4379
4380 @option{-Os} disables the following optimization flags:
4381 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4382 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4383
4384 If you use multiple @option{-O} options, with or without level numbers,
4385 the last such option is the one that is effective.
4386 @end table
4387
4388 Options of the form @option{-f@var{flag}} specify machine-independent
4389 flags.  Most flags have both positive and negative forms; the negative
4390 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4391 below, only one of the forms is listed---the one you typically will
4392 use.  You can figure out the other form by either removing @samp{no-}
4393 or adding it.
4394
4395 The following options control specific optimizations.  They are either
4396 activated by @option{-O} options or are related to ones that are.  You
4397 can use the following flags in the rare cases when ``fine-tuning'' of
4398 optimizations to be performed is desired.
4399
4400 @table @gcctabopt
4401 @item -fno-default-inline
4402 @opindex fno-default-inline
4403 Do not make member functions inline by default merely because they are
4404 defined inside the class scope (C++ only).  Otherwise, when you specify
4405 @w{@option{-O}}, member functions defined inside class scope are compiled
4406 inline by default; i.e., you don't need to add @samp{inline} in front of
4407 the member function name.
4408
4409 @item -fno-defer-pop
4410 @opindex fno-defer-pop
4411 Always pop the arguments to each function call as soon as that function
4412 returns.  For machines which must pop arguments after a function call,
4413 the compiler normally lets arguments accumulate on the stack for several
4414 function calls and pops them all at once.
4415
4416 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4417
4418 @item -fforce-mem
4419 @opindex fforce-mem
4420 Force memory operands to be copied into registers before doing
4421 arithmetic on them.  This produces better code by making all memory
4422 references potential common subexpressions.  When they are not common
4423 subexpressions, instruction combination should eliminate the separate
4424 register-load. This option is now a nop and will be removed in 4.2.
4425
4426 @item -fforce-addr
4427 @opindex fforce-addr
4428 Force memory address constants to be copied into registers before
4429 doing arithmetic on them.
4430
4431 @item -fomit-frame-pointer
4432 @opindex fomit-frame-pointer
4433 Don't keep the frame pointer in a register for functions that
4434 don't need one.  This avoids the instructions to save, set up and
4435 restore frame pointers; it also makes an extra register available
4436 in many functions.  @strong{It also makes debugging impossible on
4437 some machines.}
4438
4439 On some machines, such as the VAX, this flag has no effect, because
4440 the standard calling sequence automatically handles the frame pointer
4441 and nothing is saved by pretending it doesn't exist.  The
4442 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4443 whether a target machine supports this flag.  @xref{Registers,,Register
4444 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4445
4446 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4447
4448 @item -foptimize-sibling-calls
4449 @opindex foptimize-sibling-calls
4450 Optimize sibling and tail recursive calls.
4451
4452 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4453
4454 @item -fno-inline
4455 @opindex fno-inline
4456 Don't pay attention to the @code{inline} keyword.  Normally this option
4457 is used to keep the compiler from expanding any functions inline.
4458 Note that if you are not optimizing, no functions can be expanded inline.
4459
4460 @item -finline-functions
4461 @opindex finline-functions
4462 Integrate all simple functions into their callers.  The compiler
4463 heuristically decides which functions are simple enough to be worth
4464 integrating in this way.
4465
4466 If all calls to a given function are integrated, and the function is
4467 declared @code{static}, then the function is normally not output as
4468 assembler code in its own right.
4469
4470 Enabled at level @option{-O3}.
4471
4472 @item -fearly-inlining
4473 @opindex fearly-inlining
4474 Inline functions marked by @code{always_inline} and functions whose body seems
4475 smaller than the function call overhead early before doing
4476 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4477 makes profiling significantly cheaper and usually inlining faster on programs
4478 having large chains of nested wrapper functions.
4479
4480 Enabled by default.
4481
4482 @item -finline-limit=@var{n}
4483 @opindex finline-limit
4484 By default, GCC limits the size of functions that can be inlined.  This flag
4485 allows the control of this limit for functions that are explicitly marked as
4486 inline (i.e., marked with the inline keyword or defined within the class
4487 definition in c++).  @var{n} is the size of functions that can be inlined in
4488 number of pseudo instructions (not counting parameter handling).  The default
4489 value of @var{n} is 600.
4490 Increasing this value can result in more inlined code at
4491 the cost of compilation time and memory consumption.  Decreasing usually makes
4492 the compilation faster and less code will be inlined (which presumably
4493 means slower programs).  This option is particularly useful for programs that
4494 use inlining heavily such as those based on recursive templates with C++.
4495
4496 Inlining is actually controlled by a number of parameters, which may be
4497 specified individually by using @option{--param @var{name}=@var{value}}.
4498 The @option{-finline-limit=@var{n}} option sets some of these parameters
4499 as follows:
4500
4501 @table @gcctabopt
4502  @item max-inline-insns-single
4503   is set to @var{n}/2.
4504  @item max-inline-insns-auto
4505   is set to @var{n}/2.
4506  @item min-inline-insns
4507   is set to 130 or @var{n}/4, whichever is smaller.
4508  @item max-inline-insns-rtl
4509   is set to @var{n}.
4510 @end table
4511
4512 See below for a documentation of the individual
4513 parameters controlling inlining.
4514
4515 @emph{Note:} pseudo instruction represents, in this particular context, an
4516 abstract measurement of function's size.  In no way does it represent a count
4517 of assembly instructions and as such its exact meaning might change from one
4518 release to an another.
4519
4520 @item -fkeep-inline-functions
4521 @opindex fkeep-inline-functions
4522 In C, emit @code{static} functions that are declared @code{inline}
4523 into the object file, even if the function has been inlined into all
4524 of its callers.  This switch does not affect functions using the
4525 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4526 inline functions into the object file.
4527
4528 @item -fkeep-static-consts
4529 @opindex fkeep-static-consts
4530 Emit variables declared @code{static const} when optimization isn't turned
4531 on, even if the variables aren't referenced.
4532
4533 GCC enables this option by default.  If you want to force the compiler to
4534 check if the variable was referenced, regardless of whether or not
4535 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4536
4537 @item -fmerge-constants
4538 Attempt to merge identical constants (string constants and floating point
4539 constants) across compilation units.
4540
4541 This option is the default for optimized compilation if the assembler and
4542 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4543 behavior.
4544
4545 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4546
4547 @item -fmerge-all-constants
4548 Attempt to merge identical constants and identical variables.
4549
4550 This option implies @option{-fmerge-constants}.  In addition to
4551 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4552 arrays or initialized constant variables with integral or floating point
4553 types.  Languages like C or C++ require each non-automatic variable to
4554 have distinct location, so using this option will result in non-conforming
4555 behavior.
4556
4557 @item -fmodulo-sched
4558 @opindex fmodulo-sched
4559 Perform swing modulo scheduling immediately before the first scheduling
4560 pass.  This pass looks at innermost loops and reorders their
4561 instructions by overlapping different iterations.
4562
4563 @item -fno-branch-count-reg
4564 @opindex fno-branch-count-reg
4565 Do not use ``decrement and branch'' instructions on a count register,
4566 but instead generate a sequence of instructions that decrement a
4567 register, compare it against zero, then branch based upon the result.
4568 This option is only meaningful on architectures that support such
4569 instructions, which include x86, PowerPC, IA-64 and S/390.
4570
4571 The default is @option{-fbranch-count-reg}, enabled when
4572 @option{-fstrength-reduce} is enabled.
4573
4574 @item -fno-function-cse
4575 @opindex fno-function-cse
4576 Do not put function addresses in registers; make each instruction that
4577 calls a constant function contain the function's address explicitly.
4578
4579 This option results in less efficient code, but some strange hacks
4580 that alter the assembler output may be confused by the optimizations
4581 performed when this option is not used.
4582
4583 The default is @option{-ffunction-cse}
4584
4585 @item -fno-zero-initialized-in-bss
4586 @opindex fno-zero-initialized-in-bss
4587 If the target supports a BSS section, GCC by default puts variables that
4588 are initialized to zero into BSS@.  This can save space in the resulting
4589 code.
4590
4591 This option turns off this behavior because some programs explicitly
4592 rely on variables going to the data section.  E.g., so that the
4593 resulting executable can find the beginning of that section and/or make
4594 assumptions based on that.
4595
4596 The default is @option{-fzero-initialized-in-bss}.
4597
4598 @item -fbounds-check
4599 @opindex fbounds-check
4600 For front-ends that support it, generate additional code to check that
4601 indices used to access arrays are within the declared range.  This is
4602 currently only supported by the Java and Fortran front-ends, where
4603 this option defaults to true and false respectively.
4604
4605 @item -fmudflap -fmudflapth -fmudflapir
4606 @opindex fmudflap
4607 @opindex fmudflapth
4608 @opindex fmudflapir
4609 @cindex bounds checking
4610 @cindex mudflap
4611 For front-ends that support it (C and C++), instrument all risky
4612 pointer/array dereferencing operations, some standard library
4613 string/heap functions, and some other associated constructs with
4614 range/validity tests.  Modules so instrumented should be immune to
4615 buffer overflows, invalid heap use, and some other classes of C/C++
4616 programming errors.  The instrumentation relies on a separate runtime
4617 library (@file{libmudflap}), which will be linked into a program if
4618 @option{-fmudflap} is given at link time.  Run-time behavior of the
4619 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4620 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4621 for its options.
4622
4623 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4624 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4625 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4626 instrumentation should ignore pointer reads.  This produces less
4627 instrumentation (and therefore faster execution) and still provides
4628 some protection against outright memory corrupting writes, but allows
4629 erroneously read data to propagate within a program.
4630
4631 @item -fstrength-reduce
4632 @opindex fstrength-reduce
4633 Perform the optimizations of loop strength reduction and
4634 elimination of iteration variables.
4635
4636 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4637
4638 @item -fthread-jumps
4639 @opindex fthread-jumps
4640 Perform optimizations where we check to see if a jump branches to a
4641 location where another comparison subsumed by the first is found.  If
4642 so, the first branch is redirected to either the destination of the
4643 second branch or a point immediately following it, depending on whether
4644 the condition is known to be true or false.
4645
4646 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4647
4648 @item -fcse-follow-jumps
4649 @opindex fcse-follow-jumps
4650 In common subexpression elimination, scan through jump instructions
4651 when the target of the jump is not reached by any other path.  For
4652 example, when CSE encounters an @code{if} statement with an
4653 @code{else} clause, CSE will follow the jump when the condition
4654 tested is false.
4655
4656 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4657
4658 @item -fcse-skip-blocks
4659 @opindex fcse-skip-blocks
4660 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4661 follow jumps which conditionally skip over blocks.  When CSE
4662 encounters a simple @code{if} statement with no else clause,
4663 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4664 body of the @code{if}.
4665
4666 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4667
4668 @item -frerun-cse-after-loop
4669 @opindex frerun-cse-after-loop
4670 Re-run common subexpression elimination after loop optimizations has been
4671 performed.
4672
4673 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4674
4675 @item -frerun-loop-opt
4676 @opindex frerun-loop-opt
4677 Run the loop optimizer twice.
4678
4679 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4680
4681 @item -fgcse
4682 @opindex fgcse
4683 Perform a global common subexpression elimination pass.
4684 This pass also performs global constant and copy propagation.
4685
4686 @emph{Note:} When compiling a program using computed gotos, a GCC
4687 extension, you may get better runtime performance if you disable
4688 the global common subexpression elimination pass by adding
4689 @option{-fno-gcse} to the command line.
4690
4691 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4692
4693 @item -fgcse-lm
4694 @opindex fgcse-lm
4695 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4696 attempt to move loads which are only killed by stores into themselves.  This
4697 allows a loop containing a load/store sequence to be changed to a load outside
4698 the loop, and a copy/store within the loop.
4699
4700 Enabled by default when gcse is enabled.
4701
4702 @item -fgcse-sm
4703 @opindex fgcse-sm
4704 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4705 global common subexpression elimination.  This pass will attempt to move
4706 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4707 loops containing a load/store sequence can be changed to a load before
4708 the loop and a store after the loop.
4709
4710 Not enabled at any optimization level.
4711
4712 @item -fgcse-las
4713 @opindex fgcse-las
4714 When @option{-fgcse-las} is enabled, the global common subexpression
4715 elimination pass eliminates redundant loads that come after stores to the
4716 same memory location (both partial and full redundancies).
4717
4718 Not enabled at any optimization level.
4719
4720 @item -fgcse-after-reload
4721 @opindex fgcse-after-reload
4722 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4723 pass is performed after reload.  The purpose of this pass is to cleanup
4724 redundant spilling.
4725
4726 @item -floop-optimize
4727 @opindex floop-optimize
4728 Perform loop optimizations: move constant expressions out of loops, simplify
4729 exit test conditions and optionally do strength-reduction as well.
4730
4731 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4732
4733 @item -floop-optimize2
4734 @opindex floop-optimize2
4735 Perform loop optimizations using the new loop optimizer.  The optimizations
4736 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4737 by separate flags.
4738
4739 @item -funsafe-loop-optimizations
4740 @opindex funsafe-loop-optimizations
4741 If given, the loop optimizer will assume that loop indices do not
4742 overflow, and that the loops with nontrivial exit condition are not
4743 infinite.  This enables a wider range of loop optimizations even if
4744 the loop optimizer itself cannot prove that these assumptions are valid.
4745 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4746 if it finds this kind of loop.
4747
4748 @item -fcrossjumping
4749 @opindex crossjumping
4750 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4751 resulting code may or may not perform better than without cross-jumping.
4752
4753 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4754
4755 @item -fif-conversion
4756 @opindex if-conversion
4757 Attempt to transform conditional jumps into branch-less equivalents.  This
4758 include use of conditional moves, min, max, set flags and abs instructions, and
4759 some tricks doable by standard arithmetics.  The use of conditional execution
4760 on chips where it is available is controlled by @code{if-conversion2}.
4761
4762 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4763
4764 @item -fif-conversion2
4765 @opindex if-conversion2
4766 Use conditional execution (where available) to transform conditional jumps into
4767 branch-less equivalents.
4768
4769 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4770
4771 @item -fdelete-null-pointer-checks
4772 @opindex fdelete-null-pointer-checks
4773 Use global dataflow analysis to identify and eliminate useless checks
4774 for null pointers.  The compiler assumes that dereferencing a null
4775 pointer would have halted the program.  If a pointer is checked after
4776 it has already been dereferenced, it cannot be null.
4777
4778 In some environments, this assumption is not true, and programs can
4779 safely dereference null pointers.  Use
4780 @option{-fno-delete-null-pointer-checks} to disable this optimization
4781 for programs which depend on that behavior.
4782
4783 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4784
4785 @item -fexpensive-optimizations
4786 @opindex fexpensive-optimizations
4787 Perform a number of minor optimizations that are relatively expensive.
4788
4789 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4790
4791 @item -foptimize-register-move
4792 @itemx -fregmove
4793 @opindex foptimize-register-move
4794 @opindex fregmove
4795 Attempt to reassign register numbers in move instructions and as
4796 operands of other simple instructions in order to maximize the amount of
4797 register tying.  This is especially helpful on machines with two-operand
4798 instructions.
4799
4800 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4801 optimization.
4802
4803 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4804
4805 @item -fdelayed-branch
4806 @opindex fdelayed-branch
4807 If supported for the target machine, attempt to reorder instructions
4808 to exploit instruction slots available after delayed branch
4809 instructions.
4810
4811 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4812
4813 @item -fschedule-insns
4814 @opindex fschedule-insns
4815 If supported for the target machine, attempt to reorder instructions to
4816 eliminate execution stalls due to required data being unavailable.  This
4817 helps machines that have slow floating point or memory load instructions
4818 by allowing other instructions to be issued until the result of the load
4819 or floating point instruction is required.
4820
4821 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4822
4823 @item -fschedule-insns2
4824 @opindex fschedule-insns2
4825 Similar to @option{-fschedule-insns}, but requests an additional pass of
4826 instruction scheduling after register allocation has been done.  This is
4827 especially useful on machines with a relatively small number of
4828 registers and where memory load instructions take more than one cycle.
4829
4830 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4831
4832 @item -fno-sched-interblock
4833 @opindex fno-sched-interblock
4834 Don't schedule instructions across basic blocks.  This is normally
4835 enabled by default when scheduling before register allocation, i.e.@:
4836 with @option{-fschedule-insns} or at @option{-O2} or higher.
4837
4838 @item -fno-sched-spec
4839 @opindex fno-sched-spec
4840 Don't allow speculative motion of non-load instructions.  This is normally
4841 enabled by default when scheduling before register allocation, i.e.@:
4842 with @option{-fschedule-insns} or at @option{-O2} or higher.
4843
4844 @item -fsched-spec-load
4845 @opindex fsched-spec-load
4846 Allow speculative motion of some load instructions.  This only makes
4847 sense when scheduling before register allocation, i.e.@: with
4848 @option{-fschedule-insns} or at @option{-O2} or higher.
4849
4850 @item -fsched-spec-load-dangerous
4851 @opindex fsched-spec-load-dangerous
4852 Allow speculative motion of more load instructions.  This only makes
4853 sense when scheduling before register allocation, i.e.@: with
4854 @option{-fschedule-insns} or at @option{-O2} or higher.
4855
4856 @item -fsched-stalled-insns=@var{n}
4857 @opindex fsched-stalled-insns
4858 Define how many insns (if any) can be moved prematurely from the queue
4859 of stalled insns into the ready list, during the second scheduling pass.
4860
4861 @item -fsched-stalled-insns-dep=@var{n}
4862 @opindex fsched-stalled-insns-dep
4863 Define how many insn groups (cycles) will be examined for a dependency
4864 on a stalled insn that is candidate for premature removal from the queue
4865 of stalled insns.  Has an effect only during the second scheduling pass,
4866 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4867
4868 @item -fsched2-use-superblocks
4869 @opindex fsched2-use-superblocks
4870 When scheduling after register allocation, do use superblock scheduling
4871 algorithm.  Superblock scheduling allows motion across basic block boundaries
4872 resulting on faster schedules.  This option is experimental, as not all machine
4873 descriptions used by GCC model the CPU closely enough to avoid unreliable
4874 results from the algorithm.
4875
4876 This only makes sense when scheduling after register allocation, i.e.@: with
4877 @option{-fschedule-insns2} or at @option{-O2} or higher.
4878
4879 @item -fsched2-use-traces
4880 @opindex fsched2-use-traces
4881 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4882 allocation and additionally perform code duplication in order to increase the
4883 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4884 trace formation.
4885
4886 This mode should produce faster but significantly longer programs.  Also
4887 without @option{-fbranch-probabilities} the traces constructed may not
4888 match the reality and hurt the performance.  This only makes
4889 sense when scheduling after register allocation, i.e.@: with
4890 @option{-fschedule-insns2} or at @option{-O2} or higher.
4891
4892 @item -freschedule-modulo-scheduled-loops
4893 @opindex fscheduling-in-modulo-scheduled-loops
4894 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4895 we may want to prevent the later scheduling passes from changing its schedule, we use this
4896 option to control that.
4897
4898 @item -fcaller-saves
4899 @opindex fcaller-saves
4900 Enable values to be allocated in registers that will be clobbered by
4901 function calls, by emitting extra instructions to save and restore the
4902 registers around such calls.  Such allocation is done only when it
4903 seems to result in better code than would otherwise be produced.
4904
4905 This option is always enabled by default on certain machines, usually
4906 those which have no call-preserved registers to use instead.
4907
4908 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4909
4910 @item -ftree-pre
4911 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4912 enabled by default at @option{-O2} and @option{-O3}.
4913
4914 @item -ftree-fre
4915 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4916 between FRE and PRE is that FRE only considers expressions
4917 that are computed on all paths leading to the redundant computation.
4918 This analysis faster than PRE, though it exposes fewer redundancies.
4919 This flag is enabled by default at @option{-O} and higher.
4920
4921 @item -ftree-copy-prop
4922 Perform copy propagation on trees.  This pass eliminates unnecessary
4923 copy operations.  This flag is enabled by default at @option{-O} and
4924 higher.
4925
4926 @item -ftree-store-copy-prop
4927 Perform copy propagation of memory loads and stores.  This pass
4928 eliminates unnecessary copy operations in memory references
4929 (structures, global variables, arrays, etc).  This flag is enabled by
4930 default at @option{-O2} and higher.
4931
4932 @item -ftree-salias
4933 Perform structural alias analysis on trees.  This flag
4934 is enabled by default at @option{-O} and higher.
4935
4936 @item -ftree-sink
4937 Perform forward store motion  on trees.  This flag is
4938 enabled by default at @option{-O} and higher.
4939
4940 @item -ftree-ccp
4941 Perform sparse conditional constant propagation (CCP) on trees.  This
4942 pass only operates on local scalar variables and is enabled by default
4943 at @option{-O} and higher.
4944
4945 @item -ftree-store-ccp
4946 Perform sparse conditional constant propagation (CCP) on trees.  This
4947 pass operates on both local scalar variables and memory stores and
4948 loads (global variables, structures, arrays, etc).  This flag is
4949 enabled by default at @option{-O2} and higher.
4950
4951 @item -ftree-dce
4952 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4953 default at @option{-O} and higher.
4954
4955 @item -ftree-dominator-opts
4956 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4957 default at @option{-O} and higher.
4958
4959 @item -ftree-ch
4960 Perform loop header copying on trees.  This is beneficial since it increases
4961 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4962 is enabled by default at @option{-O} and higher.  It is not enabled
4963 for @option{-Os}, since it usually increases code size.
4964
4965 @item -ftree-loop-optimize
4966 Perform loop optimizations on trees.  This flag is enabled by default
4967 at @option{-O} and higher.
4968
4969 @item -ftree-loop-linear
4970 Perform linear loop transformations on tree.  This flag can improve cache
4971 performance and allow further loop optimizations to take place.
4972
4973 @item -ftree-loop-im
4974 Perform loop invariant motion on trees.  This pass moves only invariants that
4975 would be hard to handle at RTL level (function calls, operations that expand to
4976 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4977 operands of conditions that are invariant out of the loop, so that we can use
4978 just trivial invariantness analysis in loop unswitching.  The pass also includes
4979 store motion.
4980
4981 @item -ftree-loop-ivcanon
4982 Create a canonical counter for number of iterations in the loop for that
4983 determining number of iterations requires complicated analysis.  Later
4984 optimizations then may determine the number easily.  Useful especially
4985 in connection with unrolling.
4986
4987 @item -fivopts
4988 Perform induction variable optimizations (strength reduction, induction
4989 variable merging and induction variable elimination) on trees.
4990
4991 @item -ftree-sra
4992 Perform scalar replacement of aggregates.  This pass replaces structure
4993 references with scalars to prevent committing structures to memory too
4994 early.  This flag is enabled by default at @option{-O} and higher.
4995
4996 @item -ftree-copyrename
4997 Perform copy renaming on trees.  This pass attempts to rename compiler
4998 temporaries to other variables at copy locations, usually resulting in
4999 variable names which more closely resemble the original variables.  This flag
5000 is enabled by default at @option{-O} and higher.
5001
5002 @item -ftree-ter
5003 Perform temporary expression replacement during the SSA->normal phase.  Single
5004 use/single def temporaries are replaced at their use location with their
5005 defining expression.  This results in non-GIMPLE code, but gives the expanders
5006 much more complex trees to work on resulting in better RTL generation.  This is
5007 enabled by default at @option{-O} and higher.
5008
5009 @item -ftree-lrs
5010 Perform live range splitting during the SSA->normal phase.  Distinct live
5011 ranges of a variable are split into unique variables, allowing for better
5012 optimization later.  This is enabled by default at @option{-O} and higher.
5013
5014 @item -ftree-vectorize
5015 Perform loop vectorization on trees.
5016
5017 @item -ftree-vrp
5018 Perform Value Range Propagation on trees.  This is similar to the
5019 constant propagation pass, but instead of values, ranges of values are
5020 propagated.  This allows the optimizers to remove unnecessary range
5021 checks like array bound checks and null pointer checks.  This is
5022 enabled by default at @option{-O2} and higher.  Null pointer check
5023 elimination is only done if @option{-fdelete-null-pointer-checks} is
5024 enabled.
5025
5026 @item -ftracer
5027 @opindex ftracer
5028 Perform tail duplication to enlarge superblock size.  This transformation
5029 simplifies the control flow of the function allowing other optimizations to do
5030 better job.
5031
5032 @item -funroll-loops
5033 @opindex funroll-loops
5034 Unroll loops whose number of iterations can be determined at compile
5035 time or upon entry to the loop.  @option{-funroll-loops} implies both
5036 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5037 option makes code larger, and may or may not make it run faster.
5038
5039 @item -funroll-all-loops
5040 @opindex funroll-all-loops
5041 Unroll all loops, even if their number of iterations is uncertain when
5042 the loop is entered.  This usually makes programs run more slowly.
5043 @option{-funroll-all-loops} implies the same options as
5044 @option{-funroll-loops},
5045
5046 @item -fsplit-ivs-in-unroller
5047 @opindex -fsplit-ivs-in-unroller
5048 Enables expressing of values of induction variables in later iterations
5049 of the unrolled loop using the value in the first iteration.  This breaks
5050 long dependency chains, thus improving efficiency of the scheduling passes.
5051
5052 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5053 same effect.  However in cases the loop body is more complicated than
5054 a single basic block, this is not reliable.  It also does not work at all
5055 on some of the architectures due to restrictions in the CSE pass.
5056
5057 This optimization is enabled by default.
5058
5059 @item -fvariable-expansion-in-unroller
5060 @opindex -fvariable-expansion-in-unroller
5061 With this option, the compiler will create multiple copies of some
5062 local variables when unrolling a loop which can result in superior code.
5063
5064 @item -fprefetch-loop-arrays
5065 @opindex fprefetch-loop-arrays
5066 If supported by the target machine, generate instructions to prefetch
5067 memory to improve the performance of loops that access large arrays.
5068
5069 These options may generate better or worse code; results are highly
5070 dependent on the structure of loops within the source code.
5071
5072 @item -fno-peephole
5073 @itemx -fno-peephole2
5074 @opindex fno-peephole
5075 @opindex fno-peephole2
5076 Disable any machine-specific peephole optimizations.  The difference
5077 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5078 are implemented in the compiler; some targets use one, some use the
5079 other, a few use both.
5080
5081 @option{-fpeephole} is enabled by default.
5082 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5083
5084 @item -fno-guess-branch-probability
5085 @opindex fno-guess-branch-probability
5086 Do not guess branch probabilities using heuristics.
5087
5088 GCC will use heuristics to guess branch probabilities if they are
5089 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5090 heuristics are based on the control flow graph.  If some branch probabilities
5091 are specified by @samp{__builtin_expect}, then the heuristics will be
5092 used to guess branch probabilities for the rest of the control flow graph,
5093 taking the @samp{__builtin_expect} info into account.  The interactions
5094 between the heuristics and @samp{__builtin_expect} can be complex, and in
5095 some cases, it may be useful to disable the heuristics so that the effects
5096 of @samp{__builtin_expect} are easier to understand.
5097
5098 The default is @option{-fguess-branch-probability} at levels
5099 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5100
5101 @item -freorder-blocks
5102 @opindex freorder-blocks
5103 Reorder basic blocks in the compiled function in order to reduce number of
5104 taken branches and improve code locality.
5105
5106 Enabled at levels @option{-O2}, @option{-O3}.
5107
5108 @item -freorder-blocks-and-partition
5109 @opindex freorder-blocks-and-partition
5110 In addition to reordering basic blocks in the compiled function, in order
5111 to reduce number of taken branches, partitions hot and cold basic blocks
5112 into separate sections of the assembly and .o files, to improve
5113 paging and cache locality performance.
5114
5115 This optimization is automatically turned off in the presence of
5116 exception handling, for linkonce sections, for functions with a user-defined
5117 section attribute and on any architecture that does not support named
5118 sections.
5119
5120 @item -freorder-functions
5121 @opindex freorder-functions
5122 Reorder functions in the object file in order to
5123 improve code locality.  This is implemented by using special
5124 subsections @code{.text.hot} for most frequently executed functions and
5125 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5126 the linker so object file format must support named sections and linker must
5127 place them in a reasonable way.
5128
5129 Also profile feedback must be available in to make this option effective.  See
5130 @option{-fprofile-arcs} for details.
5131
5132 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5133
5134 @item -fstrict-aliasing
5135 @opindex fstrict-aliasing
5136 Allows the compiler to assume the strictest aliasing rules applicable to
5137 the language being compiled.  For C (and C++), this activates
5138 optimizations based on the type of expressions.  In particular, an
5139 object of one type is assumed never to reside at the same address as an
5140 object of a different type, unless the types are almost the same.  For
5141 example, an @code{unsigned int} can alias an @code{int}, but not a
5142 @code{void*} or a @code{double}.  A character type may alias any other
5143 type.
5144
5145 Pay special attention to code like this:
5146 @smallexample
5147 union a_union @{
5148   int i;
5149   double d;
5150 @};
5151
5152 int f() @{
5153   a_union t;
5154   t.d = 3.0;
5155   return t.i;
5156 @}
5157 @end smallexample
5158 The practice of reading from a different union member than the one most
5159 recently written to (called ``type-punning'') is common.  Even with
5160 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5161 is accessed through the union type.  So, the code above will work as
5162 expected.  However, this code might not:
5163 @smallexample
5164 int f() @{
5165   a_union t;
5166   int* ip;
5167   t.d = 3.0;
5168   ip = &t.i;
5169   return *ip;
5170 @}
5171 @end smallexample
5172
5173 Every language that wishes to perform language-specific alias analysis
5174 should define a function that computes, given an @code{tree}
5175 node, an alias set for the node.  Nodes in different alias sets are not
5176 allowed to alias.  For an example, see the C front-end function
5177 @code{c_get_alias_set}.
5178
5179 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5180
5181 @item -falign-functions
5182 @itemx -falign-functions=@var{n}
5183 @opindex falign-functions
5184 Align the start of functions to the next power-of-two greater than
5185 @var{n}, skipping up to @var{n} bytes.  For instance,
5186 @option{-falign-functions=32} aligns functions to the next 32-byte
5187 boundary, but @option{-falign-functions=24} would align to the next
5188 32-byte boundary only if this can be done by skipping 23 bytes or less.
5189
5190 @option{-fno-align-functions} and @option{-falign-functions=1} are
5191 equivalent and mean that functions will not be aligned.
5192
5193 Some assemblers only support this flag when @var{n} is a power of two;
5194 in that case, it is rounded up.
5195
5196 If @var{n} is not specified or is zero, use a machine-dependent default.
5197
5198 Enabled at levels @option{-O2}, @option{-O3}.
5199
5200 @item -falign-labels
5201 @itemx -falign-labels=@var{n}
5202 @opindex falign-labels
5203 Align all branch targets to a power-of-two boundary, skipping up to
5204 @var{n} bytes like @option{-falign-functions}.  This option can easily
5205 make code slower, because it must insert dummy operations for when the
5206 branch target is reached in the usual flow of the code.
5207
5208 @option{-fno-align-labels} and @option{-falign-labels=1} are
5209 equivalent and mean that labels will not be aligned.
5210
5211 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5212 are greater than this value, then their values are used instead.
5213
5214 If @var{n} is not specified or is zero, use a machine-dependent default
5215 which is very likely to be @samp{1}, meaning no alignment.
5216
5217 Enabled at levels @option{-O2}, @option{-O3}.
5218
5219 @item -falign-loops
5220 @itemx -falign-loops=@var{n}
5221 @opindex falign-loops
5222 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5223 like @option{-falign-functions}.  The hope is that the loop will be
5224 executed many times, which will make up for any execution of the dummy
5225 operations.
5226
5227 @option{-fno-align-loops} and @option{-falign-loops=1} are
5228 equivalent and mean that loops will not be aligned.
5229
5230 If @var{n} is not specified or is zero, use a machine-dependent default.
5231
5232 Enabled at levels @option{-O2}, @option{-O3}.
5233
5234 @item -falign-jumps
5235 @itemx -falign-jumps=@var{n}
5236 @opindex falign-jumps
5237 Align branch targets to a power-of-two boundary, for branch targets
5238 where the targets can only be reached by jumping, skipping up to @var{n}
5239 bytes like @option{-falign-functions}.  In this case, no dummy operations
5240 need be executed.
5241
5242 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5243 equivalent and mean that loops will not be aligned.
5244
5245 If @var{n} is not specified or is zero, use a machine-dependent default.
5246
5247 Enabled at levels @option{-O2}, @option{-O3}.
5248
5249 @item -funit-at-a-time
5250 @opindex funit-at-a-time
5251 Parse the whole compilation unit before starting to produce code.
5252 This allows some extra optimizations to take place but consumes
5253 more memory (in general).  There are some compatibility issues
5254 with @emph{unit-at-at-time} mode:
5255 @itemize @bullet
5256 @item
5257 enabling @emph{unit-at-a-time} mode may change the order
5258 in which functions, variables, and top-level @code{asm} statements
5259 are emitted, and will likely break code relying on some particular
5260 ordering.  The majority of such top-level @code{asm} statements,
5261 though, can be replaced by @code{section} attributes.
5262
5263 @item
5264 @emph{unit-at-a-time} mode removes unreferenced static variables
5265 and functions.  This may result in undefined references
5266 when an @code{asm} statement refers directly to variables or functions
5267 that are otherwise unused.  In that case either the variable/function
5268 shall be listed as an operand of the @code{asm} statement operand or,
5269 in the case of top-level @code{asm} statements the attribute @code{used}
5270 shall be used on the declaration.
5271
5272 @item
5273 Static functions now can use non-standard passing conventions that
5274 may break @code{asm} statements calling functions directly.  Again,
5275 attribute @code{used} will prevent this behavior.
5276 @end itemize
5277
5278 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5279 but this scheme may not be supported by future releases of GCC@.
5280
5281 Enabled at levels @option{-O2}, @option{-O3}.
5282
5283 @item -fweb
5284 @opindex fweb
5285 Constructs webs as commonly used for register allocation purposes and assign
5286 each web individual pseudo register.  This allows the register allocation pass
5287 to operate on pseudos directly, but also strengthens several other optimization
5288 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5289 however, make debugging impossible, since variables will no longer stay in a
5290 ``home register''.
5291
5292 Enabled by default with @option{-funroll-loops}.
5293
5294 @item -fwhole-program
5295 @opindex fwhole-program
5296 Assume that the current compilation unit represents whole program being
5297 compiled.  All public functions and variables with the exception of @code{main}
5298 and those merged by attribute @code{externally_visible} become static functions
5299 and in a affect gets more aggressively optimized by interprocedural optimizers.
5300 While this option is equivalent to proper use of @code{static} keyword for
5301 programs consisting of single file, in combination with option
5302 @option{--combine} this flag can be used to compile most of smaller scale C
5303 programs since the functions and variables become local for the whole combined
5304 compilation unit, not for the single source file itself.
5305
5306
5307 @item -fno-cprop-registers
5308 @opindex fno-cprop-registers
5309 After register allocation and post-register allocation instruction splitting,
5310 we perform a copy-propagation pass to try to reduce scheduling dependencies
5311 and occasionally eliminate the copy.
5312
5313 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5314
5315 @item -fprofile-generate
5316 @opindex fprofile-generate
5317
5318 Enable options usually used for instrumenting application to produce
5319 profile useful for later recompilation with profile feedback based
5320 optimization.  You must use @option{-fprofile-generate} both when
5321 compiling and when linking your program.
5322
5323 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5324
5325 @item -fprofile-use
5326 @opindex fprofile-use
5327 Enable profile feedback directed optimizations, and optimizations
5328 generally profitable only with profile feedback available.
5329
5330 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5331 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5332 @code{-fno-loop-optimize}.
5333
5334 @end table
5335
5336 The following options control compiler behavior regarding floating
5337 point arithmetic.  These options trade off between speed and
5338 correctness.  All must be specifically enabled.
5339
5340 @table @gcctabopt
5341 @item -ffloat-store
5342 @opindex ffloat-store
5343 Do not store floating point variables in registers, and inhibit other
5344 options that might change whether a floating point value is taken from a
5345 register or memory.
5346
5347 @cindex floating point precision
5348 This option prevents undesirable excess precision on machines such as
5349 the 68000 where the floating registers (of the 68881) keep more
5350 precision than a @code{double} is supposed to have.  Similarly for the
5351 x86 architecture.  For most programs, the excess precision does only
5352 good, but a few programs rely on the precise definition of IEEE floating
5353 point.  Use @option{-ffloat-store} for such programs, after modifying
5354 them to store all pertinent intermediate computations into variables.
5355
5356 @item -ffast-math
5357 @opindex ffast-math
5358 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5359 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5360 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5361 and @option{fcx-limited-range}.
5362
5363 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5364
5365 This option should never be turned on by any @option{-O} option since
5366 it can result in incorrect output for programs which depend on
5367 an exact implementation of IEEE or ISO rules/specifications for
5368 math functions.
5369
5370 @item -fno-math-errno
5371 @opindex fno-math-errno
5372 Do not set ERRNO after calling math functions that are executed
5373 with a single instruction, e.g., sqrt.  A program that relies on
5374 IEEE exceptions for math error handling may want to use this flag
5375 for speed while maintaining IEEE arithmetic compatibility.
5376
5377 This option should never be turned on by any @option{-O} option since
5378 it can result in incorrect output for programs which depend on
5379 an exact implementation of IEEE or ISO rules/specifications for
5380 math functions.
5381
5382 The default is @option{-fmath-errno}.
5383
5384 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5385 no reason for the compiler to consider the possibility that it might,
5386 and @option{-fno-math-errno} is the default.
5387
5388 @item -funsafe-math-optimizations
5389 @opindex funsafe-math-optimizations
5390 Allow optimizations for floating-point arithmetic that (a) assume
5391 that arguments and results are valid and (b) may violate IEEE or
5392 ANSI standards.  When used at link-time, it may include libraries
5393 or startup files that change the default FPU control word or other
5394 similar optimizations.
5395
5396 This option should never be turned on by any @option{-O} option since
5397 it can result in incorrect output for programs which depend on
5398 an exact implementation of IEEE or ISO rules/specifications for
5399 math functions.
5400
5401 The default is @option{-fno-unsafe-math-optimizations}.
5402
5403 @item -ffinite-math-only
5404 @opindex ffinite-math-only
5405 Allow optimizations for floating-point arithmetic that assume
5406 that arguments and results are not NaNs or +-Infs.
5407
5408 This option should never be turned on by any @option{-O} option since
5409 it can result in incorrect output for programs which depend on
5410 an exact implementation of IEEE or ISO rules/specifications.
5411
5412 The default is @option{-fno-finite-math-only}.
5413
5414 @item -fno-trapping-math
5415 @opindex fno-trapping-math
5416 Compile code assuming that floating-point operations cannot generate
5417 user-visible traps.  These traps include division by zero, overflow,
5418 underflow, inexact result and invalid operation.  This option implies
5419 @option{-fno-signaling-nans}.  Setting this option may allow faster
5420 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5421
5422 This option should never be turned on by any @option{-O} option since
5423 it can result in incorrect output for programs which depend on
5424 an exact implementation of IEEE or ISO rules/specifications for
5425 math functions.
5426
5427 The default is @option{-ftrapping-math}.
5428
5429 @item -frounding-math
5430 @opindex frounding-math
5431 Disable transformations and optimizations that assume default floating
5432 point rounding behavior.  This is round-to-zero for all floating point
5433 to integer conversions, and round-to-nearest for all other arithmetic
5434 truncations.  This option should be specified for programs that change
5435 the FP rounding mode dynamically, or that may be executed with a
5436 non-default rounding mode.  This option disables constant folding of
5437 floating point expressions at compile-time (which may be affected by
5438 rounding mode) and arithmetic transformations that are unsafe in the
5439 presence of sign-dependent rounding modes.
5440
5441 The default is @option{-fno-rounding-math}.
5442
5443 This option is experimental and does not currently guarantee to
5444 disable all GCC optimizations that are affected by rounding mode.
5445 Future versions of GCC may provide finer control of this setting
5446 using C99's @code{FENV_ACCESS} pragma.  This command line option
5447 will be used to specify the default state for @code{FENV_ACCESS}.
5448
5449 @item -fsignaling-nans
5450 @opindex fsignaling-nans
5451 Compile code assuming that IEEE signaling NaNs may generate user-visible
5452 traps during floating-point operations.  Setting this option disables
5453 optimizations that may change the number of exceptions visible with
5454 signaling NaNs.  This option implies @option{-ftrapping-math}.
5455
5456 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5457 be defined.
5458
5459 The default is @option{-fno-signaling-nans}.
5460
5461 This option is experimental and does not currently guarantee to
5462 disable all GCC optimizations that affect signaling NaN behavior.
5463
5464 @item -fsingle-precision-constant
5465 @opindex fsingle-precision-constant
5466 Treat floating point constant as single precision constant instead of
5467 implicitly converting it to double precision constant.
5468
5469 @item -fcx-limited-range
5470 @itemx -fno-cx-limited-range
5471 @opindex fcx-limited-range
5472 @opindex fno-cx-limited-range
5473 When enabled, this option states that a range reduction step is not
5474 needed when performing complex division.  The default is
5475 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5476
5477 This option controls the default setting of the ISO C99 
5478 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5479 all languages.
5480
5481 @end table
5482
5483 The following options control optimizations that may improve
5484 performance, but are not enabled by any @option{-O} options.  This
5485 section includes experimental options that may produce broken code.
5486
5487 @table @gcctabopt
5488 @item -fbranch-probabilities
5489 @opindex fbranch-probabilities
5490 After running a program compiled with @option{-fprofile-arcs}
5491 (@pxref{Debugging Options,, Options for Debugging Your Program or
5492 @command{gcc}}), you can compile it a second time using
5493 @option{-fbranch-probabilities}, to improve optimizations based on
5494 the number of times each branch was taken.  When the program
5495 compiled with @option{-fprofile-arcs} exits it saves arc execution
5496 counts to a file called @file{@var{sourcename}.gcda} for each source
5497 file  The information in this data file is very dependent on the
5498 structure of the generated code, so you must use the same source code
5499 and the same optimization options for both compilations.
5500
5501 With @option{-fbranch-probabilities}, GCC puts a
5502 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5503 These can be used to improve optimization.  Currently, they are only
5504 used in one place: in @file{reorg.c}, instead of guessing which path a
5505 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5506 exactly determine which path is taken more often.
5507
5508 @item -fprofile-values
5509 @opindex fprofile-values
5510 If combined with @option{-fprofile-arcs}, it adds code so that some
5511 data about values of expressions in the program is gathered.
5512
5513 With @option{-fbranch-probabilities}, it reads back the data gathered
5514 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5515 notes to instructions for their later usage in optimizations.
5516
5517 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5518
5519 @item -fvpt
5520 @opindex fvpt
5521 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5522 a code to gather information about values of expressions.
5523
5524 With @option{-fbranch-probabilities}, it reads back the data gathered
5525 and actually performs the optimizations based on them.
5526 Currently the optimizations include specialization of division operation
5527 using the knowledge about the value of the denominator.
5528
5529 @item -frename-registers
5530 @opindex frename-registers
5531 Attempt to avoid false dependencies in scheduled code by making use
5532 of registers left over after register allocation.  This optimization
5533 will most benefit processors with lots of registers.  Depending on the
5534 debug information format adopted by the target, however, it can
5535 make debugging impossible, since variables will no longer stay in
5536 a ``home register''.
5537
5538 Enabled by default with @option{-funroll-loops}.
5539
5540 @item -ftracer
5541 @opindex ftracer
5542 Perform tail duplication to enlarge superblock size.  This transformation
5543 simplifies the control flow of the function allowing other optimizations to do
5544 better job.
5545
5546 Enabled with @option{-fprofile-use}.
5547
5548 @item -funroll-loops
5549 @opindex funroll-loops
5550 Unroll loops whose number of iterations can be determined at compile time or
5551 upon entry to the loop.  @option{-funroll-loops} implies
5552 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5553 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5554 small constant number of iterations).  This option makes code larger, and may
5555 or may not make it run faster.
5556
5557 Enabled with @option{-fprofile-use}.
5558
5559 @item -funroll-all-loops
5560 @opindex funroll-all-loops
5561 Unroll all loops, even if their number of iterations is uncertain when
5562 the loop is entered.  This usually makes programs run more slowly.
5563 @option{-funroll-all-loops} implies the same options as
5564 @option{-funroll-loops}.
5565
5566 @item -fpeel-loops
5567 @opindex fpeel-loops
5568 Peels the loops for that there is enough information that they do not
5569 roll much (from profile feedback).  It also turns on complete loop peeling
5570 (i.e.@: complete removal of loops with small constant number of iterations).
5571
5572 Enabled with @option{-fprofile-use}.
5573
5574 @item -fmove-loop-invariants
5575 @opindex fmove-loop-invariants
5576 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5577 at level @option{-O1}
5578
5579 @item -funswitch-loops
5580 @opindex funswitch-loops
5581 Move branches with loop invariant conditions out of the loop, with duplicates
5582 of the loop on both branches (modified according to result of the condition).
5583
5584 @item -fprefetch-loop-arrays
5585 @opindex fprefetch-loop-arrays
5586 If supported by the target machine, generate instructions to prefetch
5587 memory to improve the performance of loops that access large arrays.
5588
5589 Disabled at level @option{-Os}.
5590
5591 @item -ffunction-sections
5592 @itemx -fdata-sections
5593 @opindex ffunction-sections
5594 @opindex fdata-sections
5595 Place each function or data item into its own section in the output
5596 file if the target supports arbitrary sections.  The name of the
5597 function or the name of the data item determines the section's name
5598 in the output file.
5599
5600 Use these options on systems where the linker can perform optimizations
5601 to improve locality of reference in the instruction space.  Most systems
5602 using the ELF object format and SPARC processors running Solaris 2 have
5603 linkers with such optimizations.  AIX may have these optimizations in
5604 the future.
5605
5606 Only use these options when there are significant benefits from doing
5607 so.  When you specify these options, the assembler and linker will
5608 create larger object and executable files and will also be slower.
5609 You will not be able to use @code{gprof} on all systems if you
5610 specify this option and you may have problems with debugging if
5611 you specify both this option and @option{-g}.
5612
5613 @item -fbranch-target-load-optimize
5614 @opindex fbranch-target-load-optimize
5615 Perform branch target register load optimization before prologue / epilogue
5616 threading.
5617 The use of target registers can typically be exposed only during reload,
5618 thus hoisting loads out of loops and doing inter-block scheduling needs
5619 a separate optimization pass.
5620
5621 @item -fbranch-target-load-optimize2
5622 @opindex fbranch-target-load-optimize2
5623 Perform branch target register load optimization after prologue / epilogue
5624 threading.
5625
5626 @item -fbtr-bb-exclusive
5627 @opindex fbtr-bb-exclusive
5628 When performing branch target register load optimization, don't reuse
5629 branch target registers in within any basic block.
5630
5631 @item --param @var{name}=@var{value}
5632 @opindex param
5633 In some places, GCC uses various constants to control the amount of
5634 optimization that is done.  For example, GCC will not inline functions
5635 that contain more that a certain number of instructions.  You can
5636 control some of these constants on the command-line using the
5637 @option{--param} option.
5638
5639 The names of specific parameters, and the meaning of the values, are
5640 tied to the internals of the compiler, and are subject to change
5641 without notice in future releases.
5642
5643 In each case, the @var{value} is an integer.  The allowable choices for
5644 @var{name} are given in the following table:
5645
5646 @table @gcctabopt
5647 @item salias-max-implicit-fields
5648 The maximum number of fields in a variable without direct
5649 structure accesses for which structure aliasing will consider trying 
5650 to track each field.  The default is 5
5651
5652 @item sra-max-structure-size
5653 The maximum structure size, in bytes, at which the scalar replacement
5654 of aggregates (SRA) optimization will perform block copies.  The
5655 default value, 0, implies that GCC will select the most appropriate
5656 size itself.
5657
5658 @item sra-field-structure-ratio
5659 The threshold ratio (as a percentage) between instantiated fields and
5660 the complete structure size.  We say that if the ratio of the number
5661 of bytes in instantiated fields to the number of bytes in the complete
5662 structure exceeds this parameter, then block copies are not used.  The
5663 default is 75.
5664
5665 @item max-crossjump-edges
5666 The maximum number of incoming edges to consider for crossjumping.
5667 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5668 the number of edges incoming to each block.  Increasing values mean
5669 more aggressive optimization, making the compile time increase with
5670 probably small improvement in executable size.
5671
5672 @item min-crossjump-insns
5673 The minimum number of instructions which must be matched at the end
5674 of two blocks before crossjumping will be performed on them.  This
5675 value is ignored in the case where all instructions in the block being
5676 crossjumped from are matched.  The default value is 5.
5677
5678 @item max-goto-duplication-insns
5679 The maximum number of instructions to duplicate to a block that jumps
5680 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5681 passes, GCC factors computed gotos early in the compilation process,
5682 and unfactors them as late as possible.  Only computed jumps at the
5683 end of a basic blocks with no more than max-goto-duplication-insns are
5684 unfactored.  The default value is 8.
5685
5686 @item max-delay-slot-insn-search
5687 The maximum number of instructions to consider when looking for an
5688 instruction to fill a delay slot.  If more than this arbitrary number of
5689 instructions is searched, the time savings from filling the delay slot
5690 will be minimal so stop searching.  Increasing values mean more
5691 aggressive optimization, making the compile time increase with probably
5692 small improvement in executable run time.
5693
5694 @item max-delay-slot-live-search
5695 When trying to fill delay slots, the maximum number of instructions to
5696 consider when searching for a block with valid live register
5697 information.  Increasing this arbitrarily chosen value means more
5698 aggressive optimization, increasing the compile time.  This parameter
5699 should be removed when the delay slot code is rewritten to maintain the
5700 control-flow graph.
5701
5702 @item max-gcse-memory
5703 The approximate maximum amount of memory that will be allocated in
5704 order to perform the global common subexpression elimination
5705 optimization.  If more memory than specified is required, the
5706 optimization will not be done.
5707
5708 @item max-gcse-passes
5709 The maximum number of passes of GCSE to run.  The default is 1.
5710
5711 @item max-pending-list-length
5712 The maximum number of pending dependencies scheduling will allow
5713 before flushing the current state and starting over.  Large functions
5714 with few branches or calls can create excessively large lists which
5715 needlessly consume memory and resources.
5716
5717 @item max-inline-insns-single
5718 Several parameters control the tree inliner used in gcc.
5719 This number sets the maximum number of instructions (counted in GCC's
5720 internal representation) in a single function that the tree inliner
5721 will consider for inlining.  This only affects functions declared
5722 inline and methods implemented in a class declaration (C++).
5723 The default value is 450.
5724
5725 @item max-inline-insns-auto
5726 When you use @option{-finline-functions} (included in @option{-O3}),
5727 a lot of functions that would otherwise not be considered for inlining
5728 by the compiler will be investigated.  To those functions, a different
5729 (more restrictive) limit compared to functions declared inline can
5730 be applied.
5731 The default value is 90.
5732
5733 @item large-function-insns
5734 The limit specifying really large functions.  For functions larger than this
5735 limit after inlining inlining is constrained by
5736 @option{--param large-function-growth}.  This parameter is useful primarily
5737 to avoid extreme compilation time caused by non-linear algorithms used by the
5738 backend.
5739 This parameter is ignored when @option{-funit-at-a-time} is not used.
5740 The default value is 2700.
5741
5742 @item large-function-growth
5743 Specifies maximal growth of large function caused by inlining in percents.
5744 This parameter is ignored when @option{-funit-at-a-time} is not used.
5745 The default value is 100 which limits large function growth to 2.0 times
5746 the original size.
5747
5748 @item inline-unit-growth
5749 Specifies maximal overall growth of the compilation unit caused by inlining.
5750 This parameter is ignored when @option{-funit-at-a-time} is not used.
5751 The default value is 50 which limits unit growth to 1.5 times the original
5752 size.
5753
5754 @item max-inline-insns-recursive
5755 @itemx max-inline-insns-recursive-auto
5756 Specifies maximum number of instructions out-of-line copy of self recursive inline
5757 function can grow into by performing recursive inlining.
5758
5759 For functions declared inline @option{--param max-inline-insns-recursive} is
5760 taken into acount.  For function not declared inline, recursive inlining
5761 happens only when @option{-finline-functions} (included in @option{-O3}) is
5762 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5763 default value is 450.
5764
5765 @item max-inline-recursive-depth
5766 @itemx max-inline-recursive-depth-auto
5767 Specifies maximum recursion depth used by the recursive inlining.
5768
5769 For functions declared inline @option{--param max-inline-recursive-depth} is
5770 taken into acount.  For function not declared inline, recursive inlining
5771 happens only when @option{-finline-functions} (included in @option{-O3}) is
5772 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5773 default value is 450.
5774
5775 @item min-inline-recursive-probability
5776 Recursive inlining is profitable only for function having deep recursion
5777 in average and can hurt for function having little recursion depth by
5778 increasing the prologue size or complexity of function body to other
5779 optimizers.
5780
5781 When profile feedback is available (see @option{-fprofile-generate}) the actual
5782 recursion depth can be guessed from probability that function will recurse via
5783 given call expression.  This parameter limits inlining only to call expression
5784 whose probability exceeds given threshold (in percents).  The default value is
5785 10.
5786
5787 @item inline-call-cost
5788 Specify cost of call instruction relative to simple arithmetics operations
5789 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5790 functions and at the same time increases size of leaf function that is believed to
5791 reduce function size by being inlined.  In effect it increases amount of
5792 inlining for code having large abstraction penalty (many functions that just
5793 pass the arguments to other functions) and decrease inlining for code with low
5794 abstraction penalty.  The default value is 16.
5795
5796 @item max-unrolled-insns
5797 The maximum number of instructions that a loop should have if that loop
5798 is unrolled, and if the loop is unrolled, it determines how many times
5799 the loop code is unrolled.
5800
5801 @item max-average-unrolled-insns
5802 The maximum number of instructions biased by probabilities of their execution
5803 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5804 it determines how many times the loop code is unrolled.
5805
5806 @item max-unroll-times
5807 The maximum number of unrollings of a single loop.
5808
5809 @item max-peeled-insns
5810 The maximum number of instructions that a loop should have if that loop
5811 is peeled, and if the loop is peeled, it determines how many times
5812 the loop code is peeled.
5813
5814 @item max-peel-times
5815 The maximum number of peelings of a single loop.
5816
5817 @item max-completely-peeled-insns
5818 The maximum number of insns of a completely peeled loop.
5819
5820 @item max-completely-peel-times
5821 The maximum number of iterations of a loop to be suitable for complete peeling.
5822
5823 @item max-unswitch-insns
5824 The maximum number of insns of an unswitched loop.
5825
5826 @item max-unswitch-level
5827 The maximum number of branches unswitched in a single loop.
5828
5829 @item lim-expensive
5830 The minimum cost of an expensive expression in the loop invariant motion.
5831
5832 @item iv-consider-all-candidates-bound
5833 Bound on number of candidates for induction variables below that
5834 all candidates are considered for each use in induction variable
5835 optimizations.  Only the most relevant candidates are considered
5836 if there are more candidates, to avoid quadratic time complexity.
5837
5838 @item iv-max-considered-uses
5839 The induction variable optimizations give up on loops that contain more
5840 induction variable uses.
5841
5842 @item iv-always-prune-cand-set-bound
5843 If number of candidates in the set is smaller than this value,
5844 we always try to remove unnecessary ivs from the set during its
5845 optimization when a new iv is added to the set.
5846
5847 @item scev-max-expr-size
5848 Bound on size of expressions used in the scalar evolutions analyzer.
5849 Large expressions slow the analyzer.
5850
5851 @item max-iterations-to-track
5852
5853 The maximum number of iterations of a loop the brute force algorithm
5854 for analysis of # of iterations of the loop tries to evaluate.
5855
5856 @item hot-bb-count-fraction
5857 Select fraction of the maximal count of repetitions of basic block in program
5858 given basic block needs to have to be considered hot.
5859
5860 @item hot-bb-frequency-fraction
5861 Select fraction of the maximal frequency of executions of basic block in
5862 function given basic block needs to have to be considered hot
5863
5864 @item tracer-dynamic-coverage
5865 @itemx tracer-dynamic-coverage-feedback
5866
5867 This value is used to limit superblock formation once the given percentage of
5868 executed instructions is covered.  This limits unnecessary code size
5869 expansion.
5870
5871 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5872 feedback is available.  The real profiles (as opposed to statically estimated
5873 ones) are much less balanced allowing the threshold to be larger value.
5874
5875 @item tracer-max-code-growth
5876 Stop tail duplication once code growth has reached given percentage.  This is
5877 rather hokey argument, as most of the duplicates will be eliminated later in
5878 cross jumping, so it may be set to much higher values than is the desired code
5879 growth.
5880
5881 @item tracer-min-branch-ratio
5882
5883 Stop reverse growth when the reverse probability of best edge is less than this
5884 threshold (in percent).
5885
5886 @item tracer-min-branch-ratio
5887 @itemx tracer-min-branch-ratio-feedback
5888
5889 Stop forward growth if the best edge do have probability lower than this
5890 threshold.
5891
5892 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5893 compilation for profile feedback and one for compilation without.  The value
5894 for compilation with profile feedback needs to be more conservative (higher) in
5895 order to make tracer effective.
5896
5897 @item max-cse-path-length
5898
5899 Maximum number of basic blocks on path that cse considers.  The default is 10.
5900
5901 @item global-var-threshold
5902
5903 Counts the number of function calls (@var{n}) and the number of
5904 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5905 single artificial variable will be created to represent all the
5906 call-clobbered variables at function call sites.  This artificial
5907 variable will then be made to alias every call-clobbered variable.
5908 (done as @code{int * size_t} on the host machine; beware overflow).
5909
5910 @item max-aliased-vops
5911
5912 Maximum number of virtual operands allowed to represent aliases
5913 before triggering the alias grouping heuristic.  Alias grouping
5914 reduces compile times and memory consumption needed for aliasing at
5915 the expense of precision loss in alias information.
5916
5917 @item ggc-min-expand
5918
5919 GCC uses a garbage collector to manage its own memory allocation.  This
5920 parameter specifies the minimum percentage by which the garbage
5921 collector's heap should be allowed to expand between collections.
5922 Tuning this may improve compilation speed; it has no effect on code
5923 generation.
5924
5925 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5926 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5927 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5928 GCC is not able to calculate RAM on a particular platform, the lower
5929 bound of 30% is used.  Setting this parameter and
5930 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5931 every opportunity.  This is extremely slow, but can be useful for
5932 debugging.
5933
5934 @item ggc-min-heapsize
5935
5936 Minimum size of the garbage collector's heap before it begins bothering
5937 to collect garbage.  The first collection occurs after the heap expands
5938 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5939 tuning this may improve compilation speed, and has no effect on code
5940 generation.
5941
5942 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5943 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5944 with a lower bound of 4096 (four megabytes) and an upper bound of
5945 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5946 particular platform, the lower bound is used.  Setting this parameter
5947 very large effectively disables garbage collection.  Setting this
5948 parameter and @option{ggc-min-expand} to zero causes a full collection
5949 to occur at every opportunity.
5950
5951 @item max-reload-search-insns
5952 The maximum number of instruction reload should look backward for equivalent
5953 register.  Increasing values mean more aggressive optimization, making the
5954 compile time increase with probably slightly better performance.  The default
5955 value is 100.
5956
5957 @item max-cselib-memory-location
5958 The maximum number of memory locations cselib should take into acount.
5959 Increasing values mean more aggressive optimization, making the compile time
5960 increase with probably slightly better performance.  The default value is 500.
5961
5962 @item reorder-blocks-duplicate
5963 @itemx reorder-blocks-duplicate-feedback
5964
5965 Used by basic block reordering pass to decide whether to use unconditional
5966 branch or duplicate the code on its destination.  Code is duplicated when its
5967 estimated size is smaller than this value multiplied by the estimated size of
5968 unconditional jump in the hot spots of the program.
5969
5970 The @option{reorder-block-duplicate-feedback} is used only when profile
5971 feedback is available and may be set to higher values than
5972 @option{reorder-block-duplicate} since information about the hot spots is more
5973 accurate.
5974
5975 @item max-sched-region-blocks
5976 The maximum number of blocks in a region to be considered for
5977 interblock scheduling.  The default value is 10.
5978
5979 @item max-sched-region-insns
5980 The maximum number of insns in a region to be considered for
5981 interblock scheduling.  The default value is 100.
5982
5983 @item max-last-value-rtl
5984
5985 The maximum size measured as number of RTLs that can be recorded in an expression
5986 in combiner for a pseudo register as last known value of that register.  The default
5987 is 10000.
5988
5989 @item integer-share-limit
5990 Small integer constants can use a shared data structure, reducing the
5991 compiler's memory usage and increasing its speed.  This sets the maximum
5992 value of a shared integer constant's.  The default value is 256.
5993
5994 @item min-virtual-mappings
5995 Specifies the minimum number of virtual mappings in the incremental
5996 SSA updater that should be registered to trigger the virtual mappings
5997 heuristic defined by virtual-mappings-ratio.  The default value is
5998 100.
5999
6000 @item virtual-mappings-ratio
6001 If the number of virtual mappings is virtual-mappings-ratio bigger
6002 than the number of virtual symbols to be updated, then the incremental
6003 SSA updater switches to a full update for those symbols.  The default
6004 ratio is 3.
6005
6006 @end table
6007 @end table
6008
6009 @node Preprocessor Options
6010 @section Options Controlling the Preprocessor
6011 @cindex preprocessor options
6012 @cindex options, preprocessor
6013
6014 These options control the C preprocessor, which is run on each C source
6015 file before actual compilation.
6016
6017 If you use the @option{-E} option, nothing is done except preprocessing.
6018 Some of these options make sense only together with @option{-E} because
6019 they cause the preprocessor output to be unsuitable for actual
6020 compilation.
6021
6022 @table @gcctabopt
6023 @opindex Wp
6024 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6025 and pass @var{option} directly through to the preprocessor.  If
6026 @var{option} contains commas, it is split into multiple options at the
6027 commas.  However, many options are modified, translated or interpreted
6028 by the compiler driver before being passed to the preprocessor, and
6029 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6030 interface is undocumented and subject to change, so whenever possible
6031 you should avoid using @option{-Wp} and let the driver handle the
6032 options instead.
6033
6034 @item -Xpreprocessor @var{option}
6035 @opindex preprocessor
6036 Pass @var{option} as an option to the preprocessor.  You can use this to
6037 supply system-specific preprocessor options which GCC does not know how to
6038 recognize.
6039
6040 If you want to pass an option that takes an argument, you must use
6041 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6042 @end table
6043
6044 @include cppopts.texi
6045
6046 @node Assembler Options
6047 @section Passing Options to the Assembler
6048
6049 @c prevent bad page break with this line
6050 You can pass options to the assembler.
6051
6052 @table @gcctabopt
6053 @item -Wa,@var{option}
6054 @opindex Wa
6055 Pass @var{option} as an option to the assembler.  If @var{option}
6056 contains commas, it is split into multiple options at the commas.
6057
6058 @item -Xassembler @var{option}
6059 @opindex Xassembler
6060 Pass @var{option} as an option to the assembler.  You can use this to
6061 supply system-specific assembler options which GCC does not know how to
6062 recognize.
6063
6064 If you want to pass an option that takes an argument, you must use
6065 @option{-Xassembler} twice, once for the option and once for the argument.
6066
6067 @end table
6068
6069 @node Link Options
6070 @section Options for Linking
6071 @cindex link options
6072 @cindex options, linking
6073
6074 These options come into play when the compiler links object files into
6075 an executable output file.  They are meaningless if the compiler is
6076 not doing a link step.
6077
6078 @table @gcctabopt
6079 @cindex file names
6080 @item @var{object-file-name}
6081 A file name that does not end in a special recognized suffix is
6082 considered to name an object file or library.  (Object files are
6083 distinguished from libraries by the linker according to the file
6084 contents.)  If linking is done, these object files are used as input
6085 to the linker.
6086
6087 @item -c
6088 @itemx -S
6089 @itemx -E
6090 @opindex c
6091 @opindex S
6092 @opindex E
6093 If any of these options is used, then the linker is not run, and
6094 object file names should not be used as arguments.  @xref{Overall
6095 Options}.
6096
6097 @cindex Libraries
6098 @item -l@var{library}
6099 @itemx -l @var{library}
6100 @opindex l
6101 Search the library named @var{library} when linking.  (The second
6102 alternative with the library as a separate argument is only for
6103 POSIX compliance and is not recommended.)
6104
6105 It makes a difference where in the command you write this option; the
6106 linker searches and processes libraries and object files in the order they
6107 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6108 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6109 to functions in @samp{z}, those functions may not be loaded.
6110
6111 The linker searches a standard list of directories for the library,
6112 which is actually a file named @file{lib@var{library}.a}.  The linker
6113 then uses this file as if it had been specified precisely by name.
6114
6115 The directories searched include several standard system directories
6116 plus any that you specify with @option{-L}.
6117
6118 Normally the files found this way are library files---archive files
6119 whose members are object files.  The linker handles an archive file by
6120 scanning through it for members which define symbols that have so far
6121 been referenced but not defined.  But if the file that is found is an
6122 ordinary object file, it is linked in the usual fashion.  The only
6123 difference between using an @option{-l} option and specifying a file name
6124 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6125 and searches several directories.
6126
6127 @item -lobjc
6128 @opindex lobjc
6129 You need this special case of the @option{-l} option in order to
6130 link an Objective-C or Objective-C++ program.
6131
6132 @item -nostartfiles
6133 @opindex nostartfiles
6134 Do not use the standard system startup files when linking.
6135 The standard system libraries are used normally, unless @option{-nostdlib}
6136 or @option{-nodefaultlibs} is used.
6137
6138 @item -nodefaultlibs
6139 @opindex nodefaultlibs
6140 Do not use the standard system libraries when linking.
6141 Only the libraries you specify will be passed to the linker.
6142 The standard startup files are used normally, unless @option{-nostartfiles}
6143 is used.  The compiler may generate calls to @code{memcmp},
6144 @code{memset}, @code{memcpy} and @code{memmove}.
6145 These entries are usually resolved by entries in
6146 libc.  These entry points should be supplied through some other
6147 mechanism when this option is specified.
6148
6149 @item -nostdlib
6150 @opindex nostdlib
6151 Do not use the standard system startup files or libraries when linking.
6152 No startup files and only the libraries you specify will be passed to
6153 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6154 @code{memcpy} and @code{memmove}.
6155 These entries are usually resolved by entries in
6156 libc.  These entry points should be supplied through some other
6157 mechanism when this option is specified.
6158
6159 @cindex @option{-lgcc}, use with @option{-nostdlib}
6160 @cindex @option{-nostdlib} and unresolved references
6161 @cindex unresolved references and @option{-nostdlib}
6162 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6163 @cindex @option{-nodefaultlibs} and unresolved references
6164 @cindex unresolved references and @option{-nodefaultlibs}
6165 One of the standard libraries bypassed by @option{-nostdlib} and
6166 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6167 that GCC uses to overcome shortcomings of particular machines, or special
6168 needs for some languages.
6169 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6170 Collection (GCC) Internals},
6171 for more discussion of @file{libgcc.a}.)
6172 In most cases, you need @file{libgcc.a} even when you want to avoid
6173 other standard libraries.  In other words, when you specify @option{-nostdlib}
6174 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6175 This ensures that you have no unresolved references to internal GCC
6176 library subroutines.  (For example, @samp{__main}, used to ensure C++
6177 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6178 GNU Compiler Collection (GCC) Internals}.)
6179
6180 @item -pie
6181 @opindex pie
6182 Produce a position independent executable on targets which support it.
6183 For predictable results, you must also specify the same set of options
6184 that were used to generate code (@option{-fpie}, @option{-fPIE},
6185 or model suboptions) when you specify this option.
6186
6187 @item -rdynamic
6188 @opindex rdynamic
6189 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6190 that support it. This instructs the linker to add all symbols, not
6191 only used ones, to the dynamic symbol table. This option is needed
6192 for some uses of @code{dlopen} or to allow obtaining backtraces
6193 from within a program.
6194
6195 @item -s
6196 @opindex s
6197 Remove all symbol table and relocation information from the executable.
6198
6199 @item -static
6200 @opindex static
6201 On systems that support dynamic linking, this prevents linking with the shared
6202 libraries.  On other systems, this option has no effect.
6203
6204 @item -shared
6205 @opindex shared
6206 Produce a shared object which can then be linked with other objects to
6207 form an executable.  Not all systems support this option.  For predictable
6208 results, you must also specify the same set of options that were used to
6209 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6210 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6211 needs to build supplementary stub code for constructors to work.  On
6212 multi-libbed systems, @samp{gcc -shared} must select the correct support
6213 libraries to link against.  Failing to supply the correct flags may lead
6214 to subtle defects.  Supplying them in cases where they are not necessary
6215 is innocuous.}
6216
6217 @item -shared-libgcc
6218 @itemx -static-libgcc
6219 @opindex shared-libgcc
6220 @opindex static-libgcc
6221 On systems that provide @file{libgcc} as a shared library, these options
6222 force the use of either the shared or static version respectively.
6223 If no shared version of @file{libgcc} was built when the compiler was
6224 configured, these options have no effect.
6225
6226 There are several situations in which an application should use the
6227 shared @file{libgcc} instead of the static version.  The most common
6228 of these is when the application wishes to throw and catch exceptions
6229 across different shared libraries.  In that case, each of the libraries
6230 as well as the application itself should use the shared @file{libgcc}.
6231
6232 Therefore, the G++ and GCJ drivers automatically add
6233 @option{-shared-libgcc} whenever you build a shared library or a main
6234 executable, because C++ and Java programs typically use exceptions, so
6235 this is the right thing to do.
6236
6237 If, instead, you use the GCC driver to create shared libraries, you may
6238 find that they will not always be linked with the shared @file{libgcc}.
6239 If GCC finds, at its configuration time, that you have a non-GNU linker
6240 or a GNU linker that does not support option @option{--eh-frame-hdr},
6241 it will link the shared version of @file{libgcc} into shared libraries
6242 by default.  Otherwise, it will take advantage of the linker and optimize
6243 away the linking with the shared version of @file{libgcc}, linking with
6244 the static version of libgcc by default.  This allows exceptions to
6245 propagate through such shared libraries, without incurring relocation
6246 costs at library load time.
6247
6248 However, if a library or main executable is supposed to throw or catch
6249 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6250 for the languages used in the program, or using the option
6251 @option{-shared-libgcc}, such that it is linked with the shared
6252 @file{libgcc}.
6253
6254 @item -symbolic
6255 @opindex symbolic
6256 Bind references to global symbols when building a shared object.  Warn
6257 about any unresolved references (unless overridden by the link editor
6258 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6259 this option.
6260
6261 @item -Xlinker @var{option}
6262 @opindex Xlinker
6263 Pass @var{option} as an option to the linker.  You can use this to
6264 supply system-specific linker options which GCC does not know how to
6265 recognize.
6266
6267 If you want to pass an option that takes an argument, you must use
6268 @option{-Xlinker} twice, once for the option and once for the argument.
6269 For example, to pass @option{-assert definitions}, you must write
6270 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6271 @option{-Xlinker "-assert definitions"}, because this passes the entire
6272 string as a single argument, which is not what the linker expects.
6273
6274 @item -Wl,@var{option}
6275 @opindex Wl
6276 Pass @var{option} as an option to the linker.  If @var{option} contains
6277 commas, it is split into multiple options at the commas.
6278
6279 @item -u @var{symbol}
6280 @opindex u
6281 Pretend the symbol @var{symbol} is undefined, to force linking of
6282 library modules to define it.  You can use @option{-u} multiple times with
6283 different symbols to force loading of additional library modules.
6284 @end table
6285
6286 @node Directory Options
6287 @section Options for Directory Search
6288 @cindex directory options
6289 @cindex options, directory search
6290 @cindex search path
6291
6292 These options specify directories to search for header files, for
6293 libraries and for parts of the compiler:
6294
6295 @table @gcctabopt
6296 @item -I@var{dir}
6297 @opindex I
6298 Add the directory @var{dir} to the head of the list of directories to be
6299 searched for header files.  This can be used to override a system header
6300 file, substituting your own version, since these directories are
6301 searched before the system header file directories.  However, you should
6302 not use this option to add directories that contain vendor-supplied
6303 system header files (use @option{-isystem} for that).  If you use more than
6304 one @option{-I} option, the directories are scanned in left-to-right
6305 order; the standard system directories come after.
6306
6307 If a standard system include directory, or a directory specified with
6308 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6309 option will be ignored.  The directory will still be searched but as a
6310 system directory at its normal position in the system include chain.
6311 This is to ensure that GCC's procedure to fix buggy system headers and
6312 the ordering for the include_next directive are not inadvertently changed.
6313 If you really need to change the search order for system directories,
6314 use the @option{-nostdinc} and/or @option{-isystem} options.
6315
6316 @item -iquote@var{dir}
6317 @opindex iquote
6318 Add the directory @var{dir} to the head of the list of directories to
6319 be searched for header files only for the case of @samp{#include
6320 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6321 otherwise just like @option{-I}.
6322
6323 @item -L@var{dir}
6324 @opindex L
6325 Add directory @var{dir} to the list of directories to be searched
6326 for @option{-l}.
6327
6328 @item -B@var{prefix}
6329 @opindex B
6330 This option specifies where to find the executables, libraries,
6331 include files, and data files of the compiler itself.
6332
6333 The compiler driver program runs one or more of the subprograms
6334 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6335 @var{prefix} as a prefix for each program it tries to run, both with and
6336 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6337
6338 For each subprogram to be run, the compiler driver first tries the
6339 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6340 was not specified, the driver tries two standard prefixes, which are
6341 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6342 those results in a file name that is found, the unmodified program
6343 name is searched for using the directories specified in your
6344 @env{PATH} environment variable.
6345
6346 The compiler will check to see if the path provided by the @option{-B}
6347 refers to a directory, and if necessary it will add a directory
6348 separator character at the end of the path.
6349
6350 @option{-B} prefixes that effectively specify directory names also apply
6351 to libraries in the linker, because the compiler translates these
6352 options into @option{-L} options for the linker.  They also apply to
6353 includes files in the preprocessor, because the compiler translates these
6354 options into @option{-isystem} options for the preprocessor.  In this case,
6355 the compiler appends @samp{include} to the prefix.
6356
6357 The run-time support file @file{libgcc.a} can also be searched for using
6358 the @option{-B} prefix, if needed.  If it is not found there, the two
6359 standard prefixes above are tried, and that is all.  The file is left
6360 out of the link if it is not found by those means.
6361
6362 Another way to specify a prefix much like the @option{-B} prefix is to use
6363 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6364 Variables}.
6365
6366 As a special kludge, if the path provided by @option{-B} is
6367 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6368 9, then it will be replaced by @file{[dir/]include}.  This is to help
6369 with boot-strapping the compiler.
6370
6371 @item -specs=@var{file}
6372 @opindex specs
6373 Process @var{file} after the compiler reads in the standard @file{specs}
6374 file, in order to override the defaults that the @file{gcc} driver
6375 program uses when determining what switches to pass to @file{cc1},
6376 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6377 @option{-specs=@var{file}} can be specified on the command line, and they
6378 are processed in order, from left to right.
6379
6380 @item --sysroot=@var{dir}
6381 @opindex sysroot
6382 Use @var{dir} as the logical root directory for headers and libraries.
6383 For example, if the compiler would normally search for headers in
6384 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6385 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6386
6387 If you use both this option and the @option{-isysroot} option, then
6388 the @option{--sysroot} option will apply to libraries, but the
6389 @option{-isysroot} option will apply to header files.
6390
6391 The GNU linker (beginning with version 2.16) has the necessary support
6392 for this option.  If your linker does not support this option, the
6393 header file aspect of @option{--sysroot} will still work, but the
6394 library aspect will not.
6395
6396 @item -I-
6397 @opindex I-
6398 This option has been deprecated.  Please use @option{-iquote} instead for
6399 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6400 Any directories you specify with @option{-I} options before the @option{-I-}
6401 option are searched only for the case of @samp{#include "@var{file}"};
6402 they are not searched for @samp{#include <@var{file}>}.
6403
6404 If additional directories are specified with @option{-I} options after
6405 the @option{-I-}, these directories are searched for all @samp{#include}
6406 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6407 this way.)
6408
6409 In addition, the @option{-I-} option inhibits the use of the current
6410 directory (where the current input file came from) as the first search
6411 directory for @samp{#include "@var{file}"}.  There is no way to
6412 override this effect of @option{-I-}.  With @option{-I.} you can specify
6413 searching the directory which was current when the compiler was
6414 invoked.  That is not exactly the same as what the preprocessor does
6415 by default, but it is often satisfactory.
6416
6417 @option{-I-} does not inhibit the use of the standard system directories
6418 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6419 independent.
6420 @end table
6421
6422 @c man end
6423
6424 @node Spec Files
6425 @section Specifying subprocesses and the switches to pass to them
6426 @cindex Spec Files
6427
6428 @command{gcc} is a driver program.  It performs its job by invoking a
6429 sequence of other programs to do the work of compiling, assembling and
6430 linking.  GCC interprets its command-line parameters and uses these to
6431 deduce which programs it should invoke, and which command-line options
6432 it ought to place on their command lines.  This behavior is controlled
6433 by @dfn{spec strings}.  In most cases there is one spec string for each
6434 program that GCC can invoke, but a few programs have multiple spec
6435 strings to control their behavior.  The spec strings built into GCC can
6436 be overridden by using the @option{-specs=} command-line switch to specify
6437 a spec file.
6438
6439 @dfn{Spec files} are plaintext files that are used to construct spec
6440 strings.  They consist of a sequence of directives separated by blank
6441 lines.  The type of directive is determined by the first non-whitespace
6442 character on the line and it can be one of the following:
6443
6444 @table @code
6445 @item %@var{command}
6446 Issues a @var{command} to the spec file processor.  The commands that can
6447 appear here are:
6448
6449 @table @code
6450 @item %include <@var{file}>
6451 @cindex %include
6452 Search for @var{file} and insert its text at the current point in the
6453 specs file.
6454
6455 @item %include_noerr <@var{file}>
6456 @cindex %include_noerr
6457 Just like @samp{%include}, but do not generate an error message if the include
6458 file cannot be found.
6459
6460 @item %rename @var{old_name} @var{new_name}
6461 @cindex %rename
6462 Rename the spec string @var{old_name} to @var{new_name}.
6463
6464 @end table
6465
6466 @item *[@var{spec_name}]:
6467 This tells the compiler to create, override or delete the named spec
6468 string.  All lines after this directive up to the next directive or
6469 blank line are considered to be the text for the spec string.  If this
6470 results in an empty string then the spec will be deleted.  (Or, if the
6471 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6472 does not currently exist a new spec will be created.  If the spec does
6473 exist then its contents will be overridden by the text of this
6474 directive, unless the first character of that text is the @samp{+}
6475 character, in which case the text will be appended to the spec.
6476
6477 @item [@var{suffix}]:
6478 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6479 and up to the next directive or blank line are considered to make up the
6480 spec string for the indicated suffix.  When the compiler encounters an
6481 input file with the named suffix, it will processes the spec string in
6482 order to work out how to compile that file.  For example:
6483
6484 @smallexample
6485 .ZZ:
6486 z-compile -input %i
6487 @end smallexample
6488
6489 This says that any input file whose name ends in @samp{.ZZ} should be
6490 passed to the program @samp{z-compile}, which should be invoked with the
6491 command-line switch @option{-input} and with the result of performing the
6492 @samp{%i} substitution.  (See below.)
6493
6494 As an alternative to providing a spec string, the text that follows a
6495 suffix directive can be one of the following:
6496
6497 @table @code
6498 @item @@@var{language}
6499 This says that the suffix is an alias for a known @var{language}.  This is
6500 similar to using the @option{-x} command-line switch to GCC to specify a
6501 language explicitly.  For example:
6502
6503 @smallexample
6504 .ZZ:
6505 @@c++
6506 @end smallexample
6507
6508 Says that .ZZ files are, in fact, C++ source files.
6509
6510 @item #@var{name}
6511 This causes an error messages saying:
6512
6513 @smallexample
6514 @var{name} compiler not installed on this system.
6515 @end smallexample
6516 @end table
6517
6518 GCC already has an extensive list of suffixes built into it.
6519 This directive will add an entry to the end of the list of suffixes, but
6520 since the list is searched from the end backwards, it is effectively
6521 possible to override earlier entries using this technique.
6522
6523 @end table
6524
6525 GCC has the following spec strings built into it.  Spec files can
6526 override these strings or create their own.  Note that individual
6527 targets can also add their own spec strings to this list.
6528
6529 @smallexample
6530 asm          Options to pass to the assembler
6531 asm_final    Options to pass to the assembler post-processor
6532 cpp          Options to pass to the C preprocessor
6533 cc1          Options to pass to the C compiler
6534 cc1plus      Options to pass to the C++ compiler
6535 endfile      Object files to include at the end of the link
6536 link         Options to pass to the linker
6537 lib          Libraries to include on the command line to the linker
6538 libgcc       Decides which GCC support library to pass to the linker
6539 linker       Sets the name of the linker
6540 predefines   Defines to be passed to the C preprocessor
6541 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6542              by default
6543 startfile    Object files to include at the start of the link
6544 @end smallexample
6545
6546 Here is a small example of a spec file:
6547
6548 @smallexample
6549 %rename lib                 old_lib
6550
6551 *lib:
6552 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6553 @end smallexample
6554
6555 This example renames the spec called @samp{lib} to @samp{old_lib} and
6556 then overrides the previous definition of @samp{lib} with a new one.
6557 The new definition adds in some extra command-line options before
6558 including the text of the old definition.
6559
6560 @dfn{Spec strings} are a list of command-line options to be passed to their
6561 corresponding program.  In addition, the spec strings can contain
6562 @samp{%}-prefixed sequences to substitute variable text or to
6563 conditionally insert text into the command line.  Using these constructs
6564 it is possible to generate quite complex command lines.
6565
6566 Here is a table of all defined @samp{%}-sequences for spec
6567 strings.  Note that spaces are not generated automatically around the
6568 results of expanding these sequences.  Therefore you can concatenate them
6569 together or combine them with constant text in a single argument.
6570
6571 @table @code
6572 @item %%
6573 Substitute one @samp{%} into the program name or argument.
6574
6575 @item %i
6576 Substitute the name of the input file being processed.
6577
6578 @item %b
6579 Substitute the basename of the input file being processed.
6580 This is the substring up to (and not including) the last period
6581 and not including the directory.
6582
6583 @item %B
6584 This is the same as @samp{%b}, but include the file suffix (text after
6585 the last period).
6586
6587 @item %d
6588 Marks the argument containing or following the @samp{%d} as a
6589 temporary file name, so that that file will be deleted if GCC exits
6590 successfully.  Unlike @samp{%g}, this contributes no text to the
6591 argument.
6592
6593 @item %g@var{suffix}
6594 Substitute a file name that has suffix @var{suffix} and is chosen
6595 once per compilation, and mark the argument in the same way as
6596 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6597 name is now chosen in a way that is hard to predict even when previously
6598 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6599 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6600 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6601 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6602 was simply substituted with a file name chosen once per compilation,
6603 without regard to any appended suffix (which was therefore treated
6604 just like ordinary text), making such attacks more likely to succeed.
6605
6606 @item %u@var{suffix}
6607 Like @samp{%g}, but generates a new temporary file name even if
6608 @samp{%u@var{suffix}} was already seen.
6609
6610 @item %U@var{suffix}
6611 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6612 new one if there is no such last file name.  In the absence of any
6613 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6614 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6615 would involve the generation of two distinct file names, one
6616 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6617 simply substituted with a file name chosen for the previous @samp{%u},
6618 without regard to any appended suffix.
6619
6620 @item %j@var{suffix}
6621 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6622 writable, and if save-temps is off; otherwise, substitute the name
6623 of a temporary file, just like @samp{%u}.  This temporary file is not
6624 meant for communication between processes, but rather as a junk
6625 disposal mechanism.
6626
6627 @item %|@var{suffix}
6628 @itemx %m@var{suffix}
6629 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6630 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6631 all.  These are the two most common ways to instruct a program that it
6632 should read from standard input or write to standard output.  If you
6633 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6634 construct: see for example @file{f/lang-specs.h}.
6635
6636 @item %.@var{SUFFIX}
6637 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6638 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6639 terminated by the next space or %.
6640
6641 @item %w
6642 Marks the argument containing or following the @samp{%w} as the
6643 designated output file of this compilation.  This puts the argument
6644 into the sequence of arguments that @samp{%o} will substitute later.
6645
6646 @item %o
6647 Substitutes the names of all the output files, with spaces
6648 automatically placed around them.  You should write spaces
6649 around the @samp{%o} as well or the results are undefined.
6650 @samp{%o} is for use in the specs for running the linker.
6651 Input files whose names have no recognized suffix are not compiled
6652 at all, but they are included among the output files, so they will
6653 be linked.
6654
6655 @item %O
6656 Substitutes the suffix for object files.  Note that this is
6657 handled specially when it immediately follows @samp{%g, %u, or %U},
6658 because of the need for those to form complete file names.  The
6659 handling is such that @samp{%O} is treated exactly as if it had already
6660 been substituted, except that @samp{%g, %u, and %U} do not currently
6661 support additional @var{suffix} characters following @samp{%O} as they would
6662 following, for example, @samp{.o}.
6663
6664 @item %p
6665 Substitutes the standard macro predefinitions for the
6666 current target machine.  Use this when running @code{cpp}.
6667
6668 @item %P
6669 Like @samp{%p}, but puts @samp{__} before and after the name of each
6670 predefined macro, except for macros that start with @samp{__} or with
6671 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6672 C@.
6673
6674 @item %I
6675 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6676 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6677 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6678 as necessary.
6679
6680 @item %s
6681 Current argument is the name of a library or startup file of some sort.
6682 Search for that file in a standard list of directories and substitute
6683 the full name found.
6684
6685 @item %e@var{str}
6686 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6687 Use this when inconsistent options are detected.
6688
6689 @item %(@var{name})
6690 Substitute the contents of spec string @var{name} at this point.
6691
6692 @item %[@var{name}]
6693 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6694
6695 @item %x@{@var{option}@}
6696 Accumulate an option for @samp{%X}.
6697
6698 @item %X
6699 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6700 spec string.
6701
6702 @item %Y
6703 Output the accumulated assembler options specified by @option{-Wa}.
6704
6705 @item %Z
6706 Output the accumulated preprocessor options specified by @option{-Wp}.
6707
6708 @item %a
6709 Process the @code{asm} spec.  This is used to compute the
6710 switches to be passed to the assembler.
6711
6712 @item %A
6713 Process the @code{asm_final} spec.  This is a spec string for
6714 passing switches to an assembler post-processor, if such a program is
6715 needed.
6716
6717 @item %l
6718 Process the @code{link} spec.  This is the spec for computing the
6719 command line passed to the linker.  Typically it will make use of the
6720 @samp{%L %G %S %D and %E} sequences.
6721
6722 @item %D
6723 Dump out a @option{-L} option for each directory that GCC believes might
6724 contain startup files.  If the target supports multilibs then the
6725 current multilib directory will be prepended to each of these paths.
6726
6727 @item %L
6728 Process the @code{lib} spec.  This is a spec string for deciding which
6729 libraries should be included on the command line to the linker.
6730
6731 @item %G
6732 Process the @code{libgcc} spec.  This is a spec string for deciding
6733 which GCC support library should be included on the command line to the linker.
6734
6735 @item %S
6736 Process the @code{startfile} spec.  This is a spec for deciding which
6737 object files should be the first ones passed to the linker.  Typically
6738 this might be a file named @file{crt0.o}.
6739
6740 @item %E
6741 Process the @code{endfile} spec.  This is a spec string that specifies
6742 the last object files that will be passed to the linker.
6743
6744 @item %C
6745 Process the @code{cpp} spec.  This is used to construct the arguments
6746 to be passed to the C preprocessor.
6747
6748 @item %1
6749 Process the @code{cc1} spec.  This is used to construct the options to be
6750 passed to the actual C compiler (@samp{cc1}).
6751
6752 @item %2
6753 Process the @code{cc1plus} spec.  This is used to construct the options to be
6754 passed to the actual C++ compiler (@samp{cc1plus}).
6755
6756 @item %*
6757 Substitute the variable part of a matched option.  See below.
6758 Note that each comma in the substituted string is replaced by
6759 a single space.
6760
6761 @item %<@code{S}
6762 Remove all occurrences of @code{-S} from the command line.  Note---this
6763 command is position dependent.  @samp{%} commands in the spec string
6764 before this one will see @code{-S}, @samp{%} commands in the spec string
6765 after this one will not.
6766
6767 @item %:@var{function}(@var{args})
6768 Call the named function @var{function}, passing it @var{args}.
6769 @var{args} is first processed as a nested spec string, then split
6770 into an argument vector in the usual fashion.  The function returns
6771 a string which is processed as if it had appeared literally as part
6772 of the current spec.
6773
6774 The following built-in spec functions are provided:
6775
6776 @table @code
6777 @item @code{if-exists}
6778 The @code{if-exists} spec function takes one argument, an absolute
6779 pathname to a file.  If the file exists, @code{if-exists} returns the
6780 pathname.  Here is a small example of its usage:
6781
6782 @smallexample
6783 *startfile:
6784 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6785 @end smallexample
6786
6787 @item @code{if-exists-else}
6788 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6789 spec function, except that it takes two arguments.  The first argument is
6790 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6791 returns the pathname.  If it does not exist, it returns the second argument.
6792 This way, @code{if-exists-else} can be used to select one file or another,
6793 based on the existence of the first.  Here is a small example of its usage:
6794
6795 @smallexample
6796 *startfile:
6797 crt0%O%s %:if-exists(crti%O%s) \
6798 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6799 @end smallexample
6800
6801 @item @code{replace-outfile}
6802 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6803 first argument in the outfiles array and replaces it with the second argument.  Here
6804 is a small example of its usage:
6805
6806 @smallexample
6807 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6808 @end smallexample
6809
6810 @end table
6811
6812 @item %@{@code{S}@}
6813 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6814 If that switch was not specified, this substitutes nothing.  Note that
6815 the leading dash is omitted when specifying this option, and it is
6816 automatically inserted if the substitution is performed.  Thus the spec
6817 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6818 and would output the command line option @option{-foo}.
6819
6820 @item %W@{@code{S}@}
6821 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6822 deleted on failure.
6823
6824 @item %@{@code{S}*@}
6825 Substitutes all the switches specified to GCC whose names start
6826 with @code{-S}, but which also take an argument.  This is used for
6827 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6828 GCC considers @option{-o foo} as being
6829 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6830 text, including the space.  Thus two arguments would be generated.
6831
6832 @item %@{@code{S}*&@code{T}*@}
6833 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6834 (the order of @code{S} and @code{T} in the spec is not significant).
6835 There can be any number of ampersand-separated variables; for each the
6836 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6837
6838 @item %@{@code{S}:@code{X}@}
6839 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6840
6841 @item %@{!@code{S}:@code{X}@}
6842 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6843
6844 @item %@{@code{S}*:@code{X}@}
6845 Substitutes @code{X} if one or more switches whose names start with
6846 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6847 once, no matter how many such switches appeared.  However, if @code{%*}
6848 appears somewhere in @code{X}, then @code{X} will be substituted once
6849 for each matching switch, with the @code{%*} replaced by the part of
6850 that switch that matched the @code{*}.
6851
6852 @item %@{.@code{S}:@code{X}@}
6853 Substitutes @code{X}, if processing a file with suffix @code{S}.
6854
6855 @item %@{!.@code{S}:@code{X}@}
6856 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6857
6858 @item %@{@code{S}|@code{P}:@code{X}@}
6859 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6860 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6861 although they have a stronger binding than the @samp{|}.  If @code{%*}
6862 appears in @code{X}, all of the alternatives must be starred, and only
6863 the first matching alternative is substituted.
6864
6865 For example, a spec string like this:
6866
6867 @smallexample
6868 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6869 @end smallexample
6870
6871 will output the following command-line options from the following input
6872 command-line options:
6873
6874 @smallexample
6875 fred.c        -foo -baz
6876 jim.d         -bar -boggle
6877 -d fred.c     -foo -baz -boggle
6878 -d jim.d      -bar -baz -boggle
6879 @end smallexample
6880
6881 @item %@{S:X; T:Y; :D@}
6882
6883 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6884 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6885 be as many clauses as you need.  This may be combined with @code{.},
6886 @code{!}, @code{|}, and @code{*} as needed.
6887
6888
6889 @end table
6890
6891 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6892 construct may contain other nested @samp{%} constructs or spaces, or
6893 even newlines.  They are processed as usual, as described above.
6894 Trailing white space in @code{X} is ignored.  White space may also
6895 appear anywhere on the left side of the colon in these constructs,
6896 except between @code{.} or @code{*} and the corresponding word.
6897
6898 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6899 handled specifically in these constructs.  If another value of
6900 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6901 @option{-W} switch is found later in the command line, the earlier
6902 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6903 just one letter, which passes all matching options.
6904
6905 The character @samp{|} at the beginning of the predicate text is used to
6906 indicate that a command should be piped to the following command, but
6907 only if @option{-pipe} is specified.
6908
6909 It is built into GCC which switches take arguments and which do not.
6910 (You might think it would be useful to generalize this to allow each
6911 compiler's spec to say which switches take arguments.  But this cannot
6912 be done in a consistent fashion.  GCC cannot even decide which input
6913 files have been specified without knowing which switches take arguments,
6914 and it must know which input files to compile in order to tell which
6915 compilers to run).
6916
6917 GCC also knows implicitly that arguments starting in @option{-l} are to be
6918 treated as compiler output files, and passed to the linker in their
6919 proper position among the other output files.
6920
6921 @c man begin OPTIONS
6922
6923 @node Target Options
6924 @section Specifying Target Machine and Compiler Version
6925 @cindex target options
6926 @cindex cross compiling
6927 @cindex specifying machine version
6928 @cindex specifying compiler version and target machine
6929 @cindex compiler version, specifying
6930 @cindex target machine, specifying
6931
6932 The usual way to run GCC is to run the executable called @file{gcc}, or
6933 @file{<machine>-gcc} when cross-compiling, or
6934 @file{<machine>-gcc-<version>} to run a version other than the one that
6935 was installed last.  Sometimes this is inconvenient, so GCC provides
6936 options that will switch to another cross-compiler or version.
6937
6938 @table @gcctabopt
6939 @item -b @var{machine}
6940 @opindex b
6941 The argument @var{machine} specifies the target machine for compilation.
6942
6943 The value to use for @var{machine} is the same as was specified as the
6944 machine type when configuring GCC as a cross-compiler.  For
6945 example, if a cross-compiler was configured with @samp{configure
6946 arm-elf}, meaning to compile for an arm processor with elf binaries,
6947 then you would specify @option{-b arm-elf} to run that cross compiler.
6948 Because there are other options beginning with @option{-b}, the
6949 configuration must contain a hyphen. 
6950
6951 @item -V @var{version}
6952 @opindex V
6953 The argument @var{version} specifies which version of GCC to run.
6954 This is useful when multiple versions are installed.  For example,
6955 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
6956 @end table
6957
6958 The @option{-V} and @option{-b} options work by running the
6959 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6960 use them if you can just run that directly.
6961
6962 @node Submodel Options
6963 @section Hardware Models and Configurations
6964 @cindex submodel options
6965 @cindex specifying hardware config
6966 @cindex hardware models and configurations, specifying
6967 @cindex machine dependent options
6968
6969 Earlier we discussed the standard option @option{-b} which chooses among
6970 different installed compilers for completely different target
6971 machines, such as VAX vs.@: 68000 vs.@: 80386.
6972
6973 In addition, each of these target machine types can have its own
6974 special options, starting with @samp{-m}, to choose among various
6975 hardware models or configurations---for example, 68010 vs 68020,
6976 floating coprocessor or none.  A single installed version of the
6977 compiler can compile for any model or configuration, according to the
6978 options specified.
6979
6980 Some configurations of the compiler also support additional special
6981 options, usually for compatibility with other compilers on the same
6982 platform.
6983
6984 @c This list is ordered alphanumerically by subsection name.
6985 @c It should be the same order and spelling as these options are listed
6986 @c in Machine Dependent Options
6987
6988 @menu
6989 * ARC Options::
6990 * ARM Options::
6991 * AVR Options::
6992 * Blackfin Options::
6993 * CRIS Options::
6994 * CRX Options::
6995 * Darwin Options::
6996 * DEC Alpha Options::
6997 * DEC Alpha/VMS Options::
6998 * FRV Options::
6999 * H8/300 Options::
7000 * HPPA Options::
7001 * i386 and x86-64 Options::
7002 * IA-64 Options::
7003 * M32C Options::
7004 * M32R/D Options::
7005 * M680x0 Options::
7006 * M68hc1x Options::
7007 * MCore Options::
7008 * MIPS Options::
7009 * MMIX Options::
7010 * MN10300 Options::
7011 * PDP-11 Options::
7012 * PowerPC Options::
7013 * RS/6000 and PowerPC Options::
7014 * S/390 and zSeries Options::
7015 * SH Options::
7016 * SPARC Options::
7017 * System V Options::
7018 * TMS320C3x/C4x Options::
7019 * V850 Options::
7020 * VAX Options::
7021 * x86-64 Options::
7022 * Xstormy16 Options::
7023 * Xtensa Options::
7024 * zSeries Options::
7025 @end menu
7026
7027 @node ARC Options
7028 @subsection ARC Options
7029 @cindex ARC Options
7030
7031 These options are defined for ARC implementations:
7032
7033 @table @gcctabopt
7034 @item -EL
7035 @opindex EL
7036 Compile code for little endian mode.  This is the default.
7037
7038 @item -EB
7039 @opindex EB
7040 Compile code for big endian mode.
7041
7042 @item -mmangle-cpu
7043 @opindex mmangle-cpu
7044 Prepend the name of the cpu to all public symbol names.
7045 In multiple-processor systems, there are many ARC variants with different
7046 instruction and register set characteristics.  This flag prevents code
7047 compiled for one cpu to be linked with code compiled for another.
7048 No facility exists for handling variants that are ``almost identical''.
7049 This is an all or nothing option.
7050
7051 @item -mcpu=@var{cpu}
7052 @opindex mcpu
7053 Compile code for ARC variant @var{cpu}.
7054 Which variants are supported depend on the configuration.
7055 All variants support @option{-mcpu=base}, this is the default.
7056
7057 @item -mtext=@var{text-section}
7058 @itemx -mdata=@var{data-section}
7059 @itemx -mrodata=@var{readonly-data-section}
7060 @opindex mtext
7061 @opindex mdata
7062 @opindex mrodata
7063 Put functions, data, and readonly data in @var{text-section},
7064 @var{data-section}, and @var{readonly-data-section} respectively
7065 by default.  This can be overridden with the @code{section} attribute.
7066 @xref{Variable Attributes}.
7067
7068 @end table
7069
7070 @node ARM Options
7071 @subsection ARM Options
7072 @cindex ARM options
7073
7074 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7075 architectures:
7076
7077 @table @gcctabopt
7078 @item -mabi=@var{name}
7079 @opindex mabi
7080 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7081 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7082
7083 @item -mapcs-frame
7084 @opindex mapcs-frame
7085 Generate a stack frame that is compliant with the ARM Procedure Call
7086 Standard for all functions, even if this is not strictly necessary for
7087 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7088 with this option will cause the stack frames not to be generated for
7089 leaf functions.  The default is @option{-mno-apcs-frame}.
7090
7091 @item -mapcs
7092 @opindex mapcs
7093 This is a synonym for @option{-mapcs-frame}.
7094
7095 @ignore
7096 @c not currently implemented
7097 @item -mapcs-stack-check
7098 @opindex mapcs-stack-check
7099 Generate code to check the amount of stack space available upon entry to
7100 every function (that actually uses some stack space).  If there is
7101 insufficient space available then either the function
7102 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7103 called, depending upon the amount of stack space required.  The run time
7104 system is required to provide these functions.  The default is
7105 @option{-mno-apcs-stack-check}, since this produces smaller code.
7106
7107 @c not currently implemented
7108 @item -mapcs-float
7109 @opindex mapcs-float
7110 Pass floating point arguments using the float point registers.  This is
7111 one of the variants of the APCS@.  This option is recommended if the
7112 target hardware has a floating point unit or if a lot of floating point
7113 arithmetic is going to be performed by the code.  The default is
7114 @option{-mno-apcs-float}, since integer only code is slightly increased in
7115 size if @option{-mapcs-float} is used.
7116
7117 @c not currently implemented
7118 @item -mapcs-reentrant
7119 @opindex mapcs-reentrant
7120 Generate reentrant, position independent code.  The default is
7121 @option{-mno-apcs-reentrant}.
7122 @end ignore
7123
7124 @item -mthumb-interwork
7125 @opindex mthumb-interwork
7126 Generate code which supports calling between the ARM and Thumb
7127 instruction sets.  Without this option the two instruction sets cannot
7128 be reliably used inside one program.  The default is
7129 @option{-mno-thumb-interwork}, since slightly larger code is generated
7130 when @option{-mthumb-interwork} is specified.
7131
7132 @item -mno-sched-prolog
7133 @opindex mno-sched-prolog
7134 Prevent the reordering of instructions in the function prolog, or the
7135 merging of those instruction with the instructions in the function's
7136 body.  This means that all functions will start with a recognizable set
7137 of instructions (or in fact one of a choice from a small set of
7138 different function prologues), and this information can be used to
7139 locate the start if functions inside an executable piece of code.  The
7140 default is @option{-msched-prolog}.
7141
7142 @item -mhard-float
7143 @opindex mhard-float
7144 Generate output containing floating point instructions.  This is the
7145 default.
7146
7147 @item -msoft-float
7148 @opindex msoft-float
7149 Generate output containing library calls for floating point.
7150 @strong{Warning:} the requisite libraries are not available for all ARM
7151 targets.  Normally the facilities of the machine's usual C compiler are
7152 used, but this cannot be done directly in cross-compilation.  You must make
7153 your own arrangements to provide suitable library functions for
7154 cross-compilation.
7155
7156 @option{-msoft-float} changes the calling convention in the output file;
7157 therefore, it is only useful if you compile @emph{all} of a program with
7158 this option.  In particular, you need to compile @file{libgcc.a}, the
7159 library that comes with GCC, with @option{-msoft-float} in order for
7160 this to work.
7161
7162 @item -mfloat-abi=@var{name}
7163 @opindex mfloat-abi
7164 Specifies which ABI to use for floating point values.  Permissible values
7165 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7166
7167 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7168 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7169 of floating point instructions, but still uses the soft-float calling
7170 conventions.
7171
7172 @item -mlittle-endian
7173 @opindex mlittle-endian
7174 Generate code for a processor running in little-endian mode.  This is
7175 the default for all standard configurations.
7176
7177 @item -mbig-endian
7178 @opindex mbig-endian
7179 Generate code for a processor running in big-endian mode; the default is
7180 to compile code for a little-endian processor.
7181
7182 @item -mwords-little-endian
7183 @opindex mwords-little-endian
7184 This option only applies when generating code for big-endian processors.
7185 Generate code for a little-endian word order but a big-endian byte
7186 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7187 option should only be used if you require compatibility with code for
7188 big-endian ARM processors generated by versions of the compiler prior to
7189 2.8.
7190
7191 @item -mcpu=@var{name}
7192 @opindex mcpu
7193 This specifies the name of the target ARM processor.  GCC uses this name
7194 to determine what kind of instructions it can emit when generating
7195 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7196 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7197 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7198 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7199 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7200 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7201 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7202 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7203 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7204 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7205 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7206 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7207 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7208 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7209 @samp{ep9312}.
7210
7211 @itemx -mtune=@var{name}
7212 @opindex mtune
7213 This option is very similar to the @option{-mcpu=} option, except that
7214 instead of specifying the actual target processor type, and hence
7215 restricting which instructions can be used, it specifies that GCC should
7216 tune the performance of the code as if the target were of the type
7217 specified in this option, but still choosing the instructions that it
7218 will generate based on the cpu specified by a @option{-mcpu=} option.
7219 For some ARM implementations better performance can be obtained by using
7220 this option.
7221
7222 @item -march=@var{name}
7223 @opindex march
7224 This specifies the name of the target ARM architecture.  GCC uses this
7225 name to determine what kind of instructions it can emit when generating
7226 assembly code.  This option can be used in conjunction with or instead
7227 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7228 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7229 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7230 @samp{iwmmxt}, @samp{ep9312}.
7231
7232 @item -mfpu=@var{name}
7233 @itemx -mfpe=@var{number}
7234 @itemx -mfp=@var{number}
7235 @opindex mfpu
7236 @opindex mfpe
7237 @opindex mfp
7238 This specifies what floating point hardware (or hardware emulation) is
7239 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7240 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7241 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7242 with older versions of GCC@.
7243
7244 If @option{-msoft-float} is specified this specifies the format of
7245 floating point values.
7246
7247 @item -mstructure-size-boundary=@var{n}
7248 @opindex mstructure-size-boundary
7249 The size of all structures and unions will be rounded up to a multiple
7250 of the number of bits set by this option.  Permissible values are 8, 32
7251 and 64.  The default value varies for different toolchains.  For the COFF
7252 targeted toolchain the default value is 8.  A value of 64 is only allowed
7253 if the underlying ABI supports it.
7254
7255 Specifying the larger number can produce faster, more efficient code, but
7256 can also increase the size of the program.  Different values are potentially
7257 incompatible.  Code compiled with one value cannot necessarily expect to
7258 work with code or libraries compiled with another value, if they exchange
7259 information using structures or unions.
7260
7261 @item -mabort-on-noreturn
7262 @opindex mabort-on-noreturn
7263 Generate a call to the function @code{abort} at the end of a
7264 @code{noreturn} function.  It will be executed if the function tries to
7265 return.
7266
7267 @item -mlong-calls
7268 @itemx -mno-long-calls
7269 @opindex mlong-calls
7270 @opindex mno-long-calls
7271 Tells the compiler to perform function calls by first loading the
7272 address of the function into a register and then performing a subroutine
7273 call on this register.  This switch is needed if the target function
7274 will lie outside of the 64 megabyte addressing range of the offset based
7275 version of subroutine call instruction.
7276
7277 Even if this switch is enabled, not all function calls will be turned
7278 into long calls.  The heuristic is that static functions, functions
7279 which have the @samp{short-call} attribute, functions that are inside
7280 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7281 definitions have already been compiled within the current compilation
7282 unit, will not be turned into long calls.  The exception to this rule is
7283 that weak function definitions, functions with the @samp{long-call}
7284 attribute or the @samp{section} attribute, and functions that are within
7285 the scope of a @samp{#pragma long_calls} directive, will always be
7286 turned into long calls.
7287
7288 This feature is not enabled by default.  Specifying
7289 @option{-mno-long-calls} will restore the default behavior, as will
7290 placing the function calls within the scope of a @samp{#pragma
7291 long_calls_off} directive.  Note these switches have no effect on how
7292 the compiler generates code to handle function calls via function
7293 pointers.
7294
7295 @item -mnop-fun-dllimport
7296 @opindex mnop-fun-dllimport
7297 Disable support for the @code{dllimport} attribute.
7298
7299 @item -msingle-pic-base
7300 @opindex msingle-pic-base
7301 Treat the register used for PIC addressing as read-only, rather than
7302 loading it in the prologue for each function.  The run-time system is
7303 responsible for initializing this register with an appropriate value
7304 before execution begins.
7305
7306 @item -mpic-register=@var{reg}
7307 @opindex mpic-register
7308 Specify the register to be used for PIC addressing.  The default is R10
7309 unless stack-checking is enabled, when R9 is used.
7310
7311 @item -mcirrus-fix-invalid-insns
7312 @opindex mcirrus-fix-invalid-insns
7313 @opindex mno-cirrus-fix-invalid-insns
7314 Insert NOPs into the instruction stream to in order to work around
7315 problems with invalid Maverick instruction combinations.  This option
7316 is only valid if the @option{-mcpu=ep9312} option has been used to
7317 enable generation of instructions for the Cirrus Maverick floating
7318 point co-processor.  This option is not enabled by default, since the
7319 problem is only present in older Maverick implementations.  The default
7320 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7321 switch.
7322
7323 @item -mpoke-function-name
7324 @opindex mpoke-function-name
7325 Write the name of each function into the text section, directly
7326 preceding the function prologue.  The generated code is similar to this:
7327
7328 @smallexample
7329      t0
7330          .ascii "arm_poke_function_name", 0
7331          .align
7332      t1
7333          .word 0xff000000 + (t1 - t0)
7334      arm_poke_function_name
7335          mov     ip, sp
7336          stmfd   sp!, @{fp, ip, lr, pc@}
7337          sub     fp, ip, #4
7338 @end smallexample
7339
7340 When performing a stack backtrace, code can inspect the value of
7341 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7342 location @code{pc - 12} and the top 8 bits are set, then we know that
7343 there is a function name embedded immediately preceding this location
7344 and has length @code{((pc[-3]) & 0xff000000)}.
7345
7346 @item -mthumb
7347 @opindex mthumb
7348 Generate code for the 16-bit Thumb instruction set.  The default is to
7349 use the 32-bit ARM instruction set.
7350
7351 @item -mtpcs-frame
7352 @opindex mtpcs-frame
7353 Generate a stack frame that is compliant with the Thumb Procedure Call
7354 Standard for all non-leaf functions.  (A leaf function is one that does
7355 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7356
7357 @item -mtpcs-leaf-frame
7358 @opindex mtpcs-leaf-frame
7359 Generate a stack frame that is compliant with the Thumb Procedure Call
7360 Standard for all leaf functions.  (A leaf function is one that does
7361 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7362
7363 @item -mcallee-super-interworking
7364 @opindex mcallee-super-interworking
7365 Gives all externally visible functions in the file being compiled an ARM
7366 instruction set header which switches to Thumb mode before executing the
7367 rest of the function.  This allows these functions to be called from
7368 non-interworking code.
7369
7370 @item -mcaller-super-interworking
7371 @opindex mcaller-super-interworking
7372 Allows calls via function pointers (including virtual functions) to
7373 execute correctly regardless of whether the target code has been
7374 compiled for interworking or not.  There is a small overhead in the cost
7375 of executing a function pointer if this option is enabled.
7376
7377 @end table
7378
7379 @node AVR Options
7380 @subsection AVR Options
7381 @cindex AVR Options
7382
7383 These options are defined for AVR implementations:
7384
7385 @table @gcctabopt
7386 @item -mmcu=@var{mcu}
7387 @opindex mmcu
7388 Specify ATMEL AVR instruction set or MCU type.
7389
7390 Instruction set avr1 is for the minimal AVR core, not supported by the C
7391 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7392 attiny11, attiny12, attiny15, attiny28).
7393
7394 Instruction set avr2 (default) is for the classic AVR core with up to
7395 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7396 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7397 at90c8534, at90s8535).
7398
7399 Instruction set avr3 is for the classic AVR core with up to 128K program
7400 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7401
7402 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7403 memory space (MCU types: atmega8, atmega83, atmega85).
7404
7405 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7406 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7407 atmega64, atmega128, at43usb355, at94k).
7408
7409 @item -msize
7410 @opindex msize
7411 Output instruction sizes to the asm file.
7412
7413 @item -minit-stack=@var{N}
7414 @opindex minit-stack
7415 Specify the initial stack address, which may be a symbol or numeric value,
7416 @samp{__stack} is the default.
7417
7418 @item -mno-interrupts
7419 @opindex mno-interrupts
7420 Generated code is not compatible with hardware interrupts.
7421 Code size will be smaller.
7422
7423 @item -mcall-prologues
7424 @opindex mcall-prologues
7425 Functions prologues/epilogues expanded as call to appropriate
7426 subroutines.  Code size will be smaller.
7427
7428 @item -mno-tablejump
7429 @opindex mno-tablejump
7430 Do not generate tablejump insns which sometimes increase code size.
7431
7432 @item -mtiny-stack
7433 @opindex mtiny-stack
7434 Change only the low 8 bits of the stack pointer.
7435
7436 @item -mint8
7437 @opindex mint8
7438 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7439 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7440 and long long will be 4 bytes.  Please note that this option does not
7441 comply to the C standards, but it will provide you with smaller code
7442 size.
7443 @end table
7444
7445 @node Blackfin Options
7446 @subsection Blackfin Options
7447 @cindex Blackfin Options
7448
7449 @table @gcctabopt
7450 @item -momit-leaf-frame-pointer
7451 @opindex momit-leaf-frame-pointer
7452 Don't keep the frame pointer in a register for leaf functions.  This
7453 avoids the instructions to save, set up and restore frame pointers and
7454 makes an extra register available in leaf functions.  The option
7455 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7456 which might make debugging harder.
7457
7458 @item -mspecld-anomaly
7459 @opindex mspecld-anomaly
7460 When enabled, the compiler will ensure that the generated code does not
7461 contain speculative loads after jump instructions.  This option is enabled
7462 by default.
7463
7464 @item -mno-specld-anomaly
7465 @opindex mno-specld-anomaly
7466 Don't generate extra code to prevent speculative loads from occurring.
7467
7468 @item -mcsync-anomaly
7469 @opindex mcsync-anomaly
7470 When enabled, the compiler will ensure that the generated code does not
7471 contain CSYNC or SSYNC instructions too soon after conditional branches.
7472 This option is enabled by default.
7473
7474 @item -mno-csync-anomaly
7475 @opindex mno-csync-anomaly
7476 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7477 occurring too soon after a conditional branch.
7478
7479 @item -mlow-64k
7480 @opindex mlow-64k
7481 When enabled, the compiler is free to take advantage of the knowledge that
7482 the entire program fits into the low 64k of memory.
7483
7484 @item -mno-low-64k
7485 @opindex mno-low-64k
7486 Assume that the program is arbitrarily large.  This is the default.
7487
7488 @item -mid-shared-library
7489 @opindex mid-shared-library
7490 Generate code that supports shared libraries via the library ID method.
7491 This allows for execute in place and shared libraries in an environment
7492 without virtual memory management.  This option implies @option{-fPIC}.
7493
7494 @item -mno-id-shared-library
7495 @opindex mno-id-shared-library
7496 Generate code that doesn't assume ID based shared libraries are being used.
7497 This is the default.
7498
7499 @item -mshared-library-id=n
7500 @opindex mshared-library-id
7501 Specified the identification number of the ID based shared library being
7502 compiled.  Specifying a value of 0 will generate more compact code, specifying
7503 other values will force the allocation of that number to the current
7504 library but is no more space or time efficient than omitting this option.
7505
7506 @item -mlong-calls
7507 @itemx -mno-long-calls
7508 @opindex mlong-calls
7509 @opindex mno-long-calls
7510 Tells the compiler to perform function calls by first loading the
7511 address of the function into a register and then performing a subroutine
7512 call on this register.  This switch is needed if the target function
7513 will lie outside of the 24 bit addressing range of the offset based
7514 version of subroutine call instruction.
7515
7516 This feature is not enabled by default.  Specifying
7517 @option{-mno-long-calls} will restore the default behavior.  Note these
7518 switches have no effect on how the compiler generates code to handle
7519 function calls via function pointers.
7520 @end table
7521
7522 @node CRIS Options
7523 @subsection CRIS Options
7524 @cindex CRIS Options
7525
7526 These options are defined specifically for the CRIS ports.
7527
7528 @table @gcctabopt
7529 @item -march=@var{architecture-type}
7530 @itemx -mcpu=@var{architecture-type}
7531 @opindex march
7532 @opindex mcpu
7533 Generate code for the specified architecture.  The choices for
7534 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7535 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7536 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7537 @samp{v10}.
7538
7539 @item -mtune=@var{architecture-type}
7540 @opindex mtune
7541 Tune to @var{architecture-type} everything applicable about the generated
7542 code, except for the ABI and the set of available instructions.  The
7543 choices for @var{architecture-type} are the same as for
7544 @option{-march=@var{architecture-type}}.
7545
7546 @item -mmax-stack-frame=@var{n}
7547 @opindex mmax-stack-frame
7548 Warn when the stack frame of a function exceeds @var{n} bytes.
7549
7550 @item -melinux-stacksize=@var{n}
7551 @opindex melinux-stacksize
7552 Only available with the @samp{cris-axis-aout} target.  Arranges for
7553 indications in the program to the kernel loader that the stack of the
7554 program should be set to @var{n} bytes.
7555
7556 @item -metrax4
7557 @itemx -metrax100
7558 @opindex metrax4
7559 @opindex metrax100
7560 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7561 @option{-march=v3} and @option{-march=v8} respectively.
7562
7563 @item -mmul-bug-workaround
7564 @itemx -mno-mul-bug-workaround
7565 @opindex mmul-bug-workaround
7566 @opindex mno-mul-bug-workaround
7567 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7568 models where it applies.  This option is active by default.
7569
7570 @item -mpdebug
7571 @opindex mpdebug
7572 Enable CRIS-specific verbose debug-related information in the assembly
7573 code.  This option also has the effect to turn off the @samp{#NO_APP}
7574 formatted-code indicator to the assembler at the beginning of the
7575 assembly file.
7576
7577 @item -mcc-init
7578 @opindex mcc-init
7579 Do not use condition-code results from previous instruction; always emit
7580 compare and test instructions before use of condition codes.
7581
7582 @item -mno-side-effects
7583 @opindex mno-side-effects
7584 Do not emit instructions with side-effects in addressing modes other than
7585 post-increment.
7586
7587 @item -mstack-align
7588 @itemx -mno-stack-align
7589 @itemx -mdata-align
7590 @itemx -mno-data-align
7591 @itemx -mconst-align
7592 @itemx -mno-const-align
7593 @opindex mstack-align
7594 @opindex mno-stack-align
7595 @opindex mdata-align
7596 @opindex mno-data-align
7597 @opindex mconst-align
7598 @opindex mno-const-align
7599 These options (no-options) arranges (eliminate arrangements) for the
7600 stack-frame, individual data and constants to be aligned for the maximum
7601 single data access size for the chosen CPU model.  The default is to
7602 arrange for 32-bit alignment.  ABI details such as structure layout are
7603 not affected by these options.
7604
7605 @item -m32-bit
7606 @itemx -m16-bit
7607 @itemx -m8-bit
7608 @opindex m32-bit
7609 @opindex m16-bit
7610 @opindex m8-bit
7611 Similar to the stack- data- and const-align options above, these options
7612 arrange for stack-frame, writable data and constants to all be 32-bit,
7613 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7614
7615 @item -mno-prologue-epilogue
7616 @itemx -mprologue-epilogue
7617 @opindex mno-prologue-epilogue
7618 @opindex mprologue-epilogue
7619 With @option{-mno-prologue-epilogue}, the normal function prologue and
7620 epilogue that sets up the stack-frame are omitted and no return
7621 instructions or return sequences are generated in the code.  Use this
7622 option only together with visual inspection of the compiled code: no
7623 warnings or errors are generated when call-saved registers must be saved,
7624 or storage for local variable needs to be allocated.
7625
7626 @item -mno-gotplt
7627 @itemx -mgotplt
7628 @opindex mno-gotplt
7629 @opindex mgotplt
7630 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7631 instruction sequences that load addresses for functions from the PLT part
7632 of the GOT rather than (traditional on other architectures) calls to the
7633 PLT@.  The default is @option{-mgotplt}.
7634
7635 @item -maout
7636 @opindex maout
7637 Legacy no-op option only recognized with the cris-axis-aout target.
7638
7639 @item -melf
7640 @opindex melf
7641 Legacy no-op option only recognized with the cris-axis-elf and
7642 cris-axis-linux-gnu targets.
7643
7644 @item -melinux
7645 @opindex melinux
7646 Only recognized with the cris-axis-aout target, where it selects a
7647 GNU/linux-like multilib, include files and instruction set for
7648 @option{-march=v8}.
7649
7650 @item -mlinux
7651 @opindex mlinux
7652 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7653
7654 @item -sim
7655 @opindex sim
7656 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7657 to link with input-output functions from a simulator library.  Code,
7658 initialized data and zero-initialized data are allocated consecutively.
7659
7660 @item -sim2
7661 @opindex sim2
7662 Like @option{-sim}, but pass linker options to locate initialized data at
7663 0x40000000 and zero-initialized data at 0x80000000.
7664 @end table
7665
7666 @node CRX Options
7667 @subsection CRX Options
7668 @cindex CRX Options
7669
7670 These options are defined specifically for the CRX ports.
7671
7672 @table @gcctabopt
7673
7674 @item -mmac
7675 @opindex mmac
7676 Enable the use of multiply-accumulate instructions. Disabled by default.
7677
7678 @item -mpush-args
7679 @opindex mpush-args
7680 Push instructions will be used to pass outgoing arguments when functions
7681 are called. Enabled by default.
7682 @end table
7683
7684 @node Darwin Options
7685 @subsection Darwin Options
7686 @cindex Darwin options
7687
7688 These options are defined for all architectures running the Darwin operating
7689 system.
7690
7691 FSF GCC on Darwin does not create ``fat'' object files; it will create
7692 an object file for the single architecture that it was built to
7693 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7694 @option{-arch} options are used; it does so by running the compiler or
7695 linker multiple times and joining the results together with
7696 @file{lipo}.
7697
7698 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7699 @samp{i686}) is determined by the flags that specify the ISA
7700 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7701 @option{-force_cpusubtype_ALL} option can be used to override this.
7702
7703 The Darwin tools vary in their behavior when presented with an ISA
7704 mismatch.  The assembler, @file{as}, will only permit instructions to
7705 be used that are valid for the subtype of the file it is generating,
7706 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7707 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7708 and print an error if asked to create a shared library with a less
7709 restrictive subtype than its input files (for instance, trying to put
7710 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7711 for executables, @file{ld}, will quietly give the executable the most
7712 restrictive subtype of any of its input files.
7713
7714 @table @gcctabopt
7715 @item -F@var{dir}
7716 @opindex F
7717 Add the framework directory @var{dir} to the head of the list of
7718 directories to be searched for header files.  These directories are
7719 interleaved with those specified by @option{-I} options and are
7720 scanned in a left-to-right order.
7721
7722 A framework directory is a directory with frameworks in it.  A
7723 framework is a directory with a @samp{"Headers"} and/or
7724 @samp{"PrivateHeaders"} directory contained directly in it that ends
7725 in @samp{".framework"}.  The name of a framework is the name of this
7726 directory excluding the @samp{".framework"}.  Headers associated with
7727 the framework are found in one of those two directories, with
7728 @samp{"Headers"} being searched first.  A subframework is a framework
7729 directory that is in a framework's @samp{"Frameworks"} directory.
7730 Includes of subframework headers can only appear in a header of a
7731 framework that contains the subframework, or in a sibling subframework
7732 header.  Two subframeworks are siblings if they occur in the same
7733 framework.  A subframework should not have the same name as a
7734 framework, a warning will be issued if this is violated.  Currently a
7735 subframework cannot have subframeworks, in the future, the mechanism
7736 may be extended to support this.  The standard frameworks can be found
7737 in @samp{"/System/Library/Frameworks"} and
7738 @samp{"/Library/Frameworks"}.  An example include looks like
7739 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7740 the name of the framework and header.h is found in the
7741 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7742
7743 @item -gused
7744 @opindex -gused
7745 Emit debugging information for symbols that are used.  For STABS
7746 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7747 This is by default ON@.
7748
7749 @item -gfull
7750 @opindex -gfull
7751 Emit debugging information for all symbols and types.
7752
7753 @item -mmacosx-version-min=@var{version}
7754 The earliest version of MacOS X that this executable will run on
7755 is @var{version}.  Typical values of @var{version} include @code{10.1},
7756 @code{10.2}, and @code{10.3.9}.
7757
7758 The default for this option is to make choices that seem to be most
7759 useful.  
7760
7761 @item -mone-byte-bool
7762 @opindex -mone-byte-bool
7763 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7764 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7765 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7766 option has no effect on x86.
7767
7768 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7769 to generate code that is not binary compatible with code generated
7770 without that switch.  Using this switch may require recompiling all
7771 other modules in a program, including system libraries.  Use this
7772 switch to conform to a non-default data model.
7773
7774 @item -mfix-and-continue
7775 @itemx -ffix-and-continue
7776 @itemx -findirect-data
7777 @opindex mfix-and-continue
7778 @opindex ffix-and-continue
7779 @opindex findirect-data
7780 Generate code suitable for fast turn around development.  Needed to
7781 enable gdb to dynamically load @code{.o} files into already running
7782 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7783 are provided for backwards compatibility.
7784
7785 @item -all_load
7786 @opindex all_load
7787 Loads all members of static archive libraries.
7788 See man ld(1) for more information.
7789
7790 @item -arch_errors_fatal
7791 @opindex arch_errors_fatal
7792 Cause the errors having to do with files that have the wrong architecture
7793 to be fatal.
7794
7795 @item -bind_at_load
7796 @opindex bind_at_load
7797 Causes the output file to be marked such that the dynamic linker will
7798 bind all undefined references when the file is loaded or launched.
7799
7800 @item -bundle
7801 @opindex bundle
7802 Produce a Mach-o bundle format file.
7803 See man ld(1) for more information.
7804
7805 @item -bundle_loader @var{executable}
7806 @opindex bundle_loader
7807 This option specifies the @var{executable} that will be loading the build
7808 output file being linked.  See man ld(1) for more information.
7809
7810 @item -dynamiclib
7811 @opindex -dynamiclib
7812 When passed this option, GCC will produce a dynamic library instead of
7813 an executable when linking, using the Darwin @file{libtool} command.
7814
7815 @item -force_cpusubtype_ALL
7816 @opindex -force_cpusubtype_ALL
7817 This causes GCC's output file to have the @var{ALL} subtype, instead of
7818 one controlled by the @option{-mcpu} or @option{-march} option.
7819
7820 @item -allowable_client  @var{client_name}
7821 @itemx -client_name
7822 @itemx -compatibility_version
7823 @itemx -current_version
7824 @itemx -dead_strip
7825 @itemx -dependency-file
7826 @itemx -dylib_file
7827 @itemx -dylinker_install_name
7828 @itemx -dynamic
7829 @itemx -exported_symbols_list
7830 @itemx -filelist
7831 @itemx -flat_namespace
7832 @itemx -force_flat_namespace
7833 @itemx -headerpad_max_install_names
7834 @itemx -image_base
7835 @itemx -init
7836 @itemx -install_name
7837 @itemx -keep_private_externs
7838 @itemx -multi_module
7839 @itemx -multiply_defined
7840 @itemx -multiply_defined_unused
7841 @itemx -noall_load
7842 @itemx -no_dead_strip_inits_and_terms
7843 @itemx -nofixprebinding
7844 @itemx -nomultidefs
7845 @itemx -noprebind
7846 @itemx -noseglinkedit
7847 @itemx -pagezero_size
7848 @itemx -prebind
7849 @itemx -prebind_all_twolevel_modules
7850 @itemx -private_bundle
7851 @itemx -read_only_relocs
7852 @itemx -sectalign
7853 @itemx -sectobjectsymbols
7854 @itemx -whyload
7855 @itemx -seg1addr
7856 @itemx -sectcreate
7857 @itemx -sectobjectsymbols
7858 @itemx -sectorder
7859 @itemx -segaddr
7860 @itemx -segs_read_only_addr
7861 @itemx -segs_read_write_addr
7862 @itemx -seg_addr_table
7863 @itemx -seg_addr_table_filename
7864 @itemx -seglinkedit
7865 @itemx -segprot
7866 @itemx -segs_read_only_addr
7867 @itemx -segs_read_write_addr
7868 @itemx -single_module
7869 @itemx -static
7870 @itemx -sub_library
7871 @itemx -sub_umbrella
7872 @itemx -twolevel_namespace
7873 @itemx -umbrella
7874 @itemx -undefined
7875 @itemx -unexported_symbols_list
7876 @itemx -weak_reference_mismatches
7877 @itemx -whatsloaded
7878
7879 @opindex allowable_client
7880 @opindex client_name
7881 @opindex compatibility_version
7882 @opindex current_version
7883 @opindex dead_strip
7884 @opindex dependency-file
7885 @opindex dylib_file
7886 @opindex dylinker_install_name
7887 @opindex dynamic
7888 @opindex exported_symbols_list
7889 @opindex filelist
7890 @opindex flat_namespace
7891 @opindex force_flat_namespace
7892 @opindex headerpad_max_install_names
7893 @opindex image_base
7894 @opindex init
7895 @opindex install_name
7896 @opindex keep_private_externs
7897 @opindex multi_module
7898 @opindex multiply_defined
7899 @opindex multiply_defined_unused
7900 @opindex noall_load
7901 @opindex no_dead_strip_inits_and_terms
7902 @opindex nofixprebinding
7903 @opindex nomultidefs
7904 @opindex noprebind
7905 @opindex noseglinkedit
7906 @opindex pagezero_size
7907 @opindex prebind
7908 @opindex prebind_all_twolevel_modules
7909 @opindex private_bundle
7910 @opindex read_only_relocs
7911 @opindex sectalign
7912 @opindex sectobjectsymbols
7913 @opindex whyload
7914 @opindex seg1addr
7915 @opindex sectcreate
7916 @opindex sectobjectsymbols
7917 @opindex sectorder
7918 @opindex segaddr
7919 @opindex segs_read_only_addr
7920 @opindex segs_read_write_addr
7921 @opindex seg_addr_table
7922 @opindex seg_addr_table_filename
7923 @opindex seglinkedit
7924 @opindex segprot
7925 @opindex segs_read_only_addr
7926 @opindex segs_read_write_addr
7927 @opindex single_module
7928 @opindex static
7929 @opindex sub_library
7930 @opindex sub_umbrella
7931 @opindex twolevel_namespace
7932 @opindex umbrella
7933 @opindex undefined
7934 @opindex unexported_symbols_list
7935 @opindex weak_reference_mismatches
7936 @opindex whatsloaded
7937
7938 These options are passed to the Darwin linker.  The Darwin linker man page
7939 describes them in detail.
7940 @end table
7941
7942 @node DEC Alpha Options
7943 @subsection DEC Alpha Options
7944
7945 These @samp{-m} options are defined for the DEC Alpha implementations:
7946
7947 @table @gcctabopt
7948 @item -mno-soft-float
7949 @itemx -msoft-float
7950 @opindex mno-soft-float
7951 @opindex msoft-float
7952 Use (do not use) the hardware floating-point instructions for
7953 floating-point operations.  When @option{-msoft-float} is specified,
7954 functions in @file{libgcc.a} will be used to perform floating-point
7955 operations.  Unless they are replaced by routines that emulate the
7956 floating-point operations, or compiled in such a way as to call such
7957 emulations routines, these routines will issue floating-point
7958 operations.   If you are compiling for an Alpha without floating-point
7959 operations, you must ensure that the library is built so as not to call
7960 them.
7961
7962 Note that Alpha implementations without floating-point operations are
7963 required to have floating-point registers.
7964
7965 @item -mfp-reg
7966 @itemx -mno-fp-regs
7967 @opindex mfp-reg
7968 @opindex mno-fp-regs
7969 Generate code that uses (does not use) the floating-point register set.
7970 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7971 register set is not used, floating point operands are passed in integer
7972 registers as if they were integers and floating-point results are passed
7973 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7974 so any function with a floating-point argument or return value called by code
7975 compiled with @option{-mno-fp-regs} must also be compiled with that
7976 option.
7977
7978 A typical use of this option is building a kernel that does not use,
7979 and hence need not save and restore, any floating-point registers.
7980
7981 @item -mieee
7982 @opindex mieee
7983 The Alpha architecture implements floating-point hardware optimized for
7984 maximum performance.  It is mostly compliant with the IEEE floating
7985 point standard.  However, for full compliance, software assistance is
7986 required.  This option generates code fully IEEE compliant code
7987 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7988 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7989 defined during compilation.  The resulting code is less efficient but is
7990 able to correctly support denormalized numbers and exceptional IEEE
7991 values such as not-a-number and plus/minus infinity.  Other Alpha
7992 compilers call this option @option{-ieee_with_no_inexact}.
7993
7994 @item -mieee-with-inexact
7995 @opindex mieee-with-inexact
7996 This is like @option{-mieee} except the generated code also maintains
7997 the IEEE @var{inexact-flag}.  Turning on this option causes the
7998 generated code to implement fully-compliant IEEE math.  In addition to
7999 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8000 macro.  On some Alpha implementations the resulting code may execute
8001 significantly slower than the code generated by default.  Since there is
8002 very little code that depends on the @var{inexact-flag}, you should
8003 normally not specify this option.  Other Alpha compilers call this
8004 option @option{-ieee_with_inexact}.
8005
8006 @item -mfp-trap-mode=@var{trap-mode}
8007 @opindex mfp-trap-mode
8008 This option controls what floating-point related traps are enabled.
8009 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8010 The trap mode can be set to one of four values:
8011
8012 @table @samp
8013 @item n
8014 This is the default (normal) setting.  The only traps that are enabled
8015 are the ones that cannot be disabled in software (e.g., division by zero
8016 trap).
8017
8018 @item u
8019 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8020 as well.
8021
8022 @item su
8023 Like @samp{su}, but the instructions are marked to be safe for software
8024 completion (see Alpha architecture manual for details).
8025
8026 @item sui
8027 Like @samp{su}, but inexact traps are enabled as well.
8028 @end table
8029
8030 @item -mfp-rounding-mode=@var{rounding-mode}
8031 @opindex mfp-rounding-mode
8032 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8033 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8034 of:
8035
8036 @table @samp
8037 @item n
8038 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8039 the nearest machine number or towards the even machine number in case
8040 of a tie.
8041
8042 @item m
8043 Round towards minus infinity.
8044
8045 @item c
8046 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8047
8048 @item d
8049 Dynamic rounding mode.  A field in the floating point control register
8050 (@var{fpcr}, see Alpha architecture reference manual) controls the
8051 rounding mode in effect.  The C library initializes this register for
8052 rounding towards plus infinity.  Thus, unless your program modifies the
8053 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8054 @end table
8055
8056 @item -mtrap-precision=@var{trap-precision}
8057 @opindex mtrap-precision
8058 In the Alpha architecture, floating point traps are imprecise.  This
8059 means without software assistance it is impossible to recover from a
8060 floating trap and program execution normally needs to be terminated.
8061 GCC can generate code that can assist operating system trap handlers
8062 in determining the exact location that caused a floating point trap.
8063 Depending on the requirements of an application, different levels of
8064 precisions can be selected:
8065
8066 @table @samp
8067 @item p
8068 Program precision.  This option is the default and means a trap handler
8069 can only identify which program caused a floating point exception.
8070
8071 @item f
8072 Function precision.  The trap handler can determine the function that
8073 caused a floating point exception.
8074
8075 @item i
8076 Instruction precision.  The trap handler can determine the exact
8077 instruction that caused a floating point exception.
8078 @end table
8079
8080 Other Alpha compilers provide the equivalent options called
8081 @option{-scope_safe} and @option{-resumption_safe}.
8082
8083 @item -mieee-conformant
8084 @opindex mieee-conformant
8085 This option marks the generated code as IEEE conformant.  You must not
8086 use this option unless you also specify @option{-mtrap-precision=i} and either
8087 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8088 is to emit the line @samp{.eflag 48} in the function prologue of the
8089 generated assembly file.  Under DEC Unix, this has the effect that
8090 IEEE-conformant math library routines will be linked in.
8091
8092 @item -mbuild-constants
8093 @opindex mbuild-constants
8094 Normally GCC examines a 32- or 64-bit integer constant to
8095 see if it can construct it from smaller constants in two or three
8096 instructions.  If it cannot, it will output the constant as a literal and
8097 generate code to load it from the data segment at runtime.
8098
8099 Use this option to require GCC to construct @emph{all} integer constants
8100 using code, even if it takes more instructions (the maximum is six).
8101
8102 You would typically use this option to build a shared library dynamic
8103 loader.  Itself a shared library, it must relocate itself in memory
8104 before it can find the variables and constants in its own data segment.
8105
8106 @item -malpha-as
8107 @itemx -mgas
8108 @opindex malpha-as
8109 @opindex mgas
8110 Select whether to generate code to be assembled by the vendor-supplied
8111 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8112
8113 @item -mbwx
8114 @itemx -mno-bwx
8115 @itemx -mcix
8116 @itemx -mno-cix
8117 @itemx -mfix
8118 @itemx -mno-fix
8119 @itemx -mmax
8120 @itemx -mno-max
8121 @opindex mbwx
8122 @opindex mno-bwx
8123 @opindex mcix
8124 @opindex mno-cix
8125 @opindex mfix
8126 @opindex mno-fix
8127 @opindex mmax
8128 @opindex mno-max
8129 Indicate whether GCC should generate code to use the optional BWX,
8130 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8131 sets supported by the CPU type specified via @option{-mcpu=} option or that
8132 of the CPU on which GCC was built if none was specified.
8133
8134 @item -mfloat-vax
8135 @itemx -mfloat-ieee
8136 @opindex mfloat-vax
8137 @opindex mfloat-ieee
8138 Generate code that uses (does not use) VAX F and G floating point
8139 arithmetic instead of IEEE single and double precision.
8140
8141 @item -mexplicit-relocs
8142 @itemx -mno-explicit-relocs
8143 @opindex mexplicit-relocs
8144 @opindex mno-explicit-relocs
8145 Older Alpha assemblers provided no way to generate symbol relocations
8146 except via assembler macros.  Use of these macros does not allow
8147 optimal instruction scheduling.  GNU binutils as of version 2.12
8148 supports a new syntax that allows the compiler to explicitly mark
8149 which relocations should apply to which instructions.  This option
8150 is mostly useful for debugging, as GCC detects the capabilities of
8151 the assembler when it is built and sets the default accordingly.
8152
8153 @item -msmall-data
8154 @itemx -mlarge-data
8155 @opindex msmall-data
8156 @opindex mlarge-data
8157 When @option{-mexplicit-relocs} is in effect, static data is
8158 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8159 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8160 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8161 16-bit relocations off of the @code{$gp} register.  This limits the
8162 size of the small data area to 64KB, but allows the variables to be
8163 directly accessed via a single instruction.
8164
8165 The default is @option{-mlarge-data}.  With this option the data area
8166 is limited to just below 2GB@.  Programs that require more than 2GB of
8167 data must use @code{malloc} or @code{mmap} to allocate the data in the
8168 heap instead of in the program's data segment.
8169
8170 When generating code for shared libraries, @option{-fpic} implies
8171 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8172
8173 @item -msmall-text
8174 @itemx -mlarge-text
8175 @opindex msmall-text
8176 @opindex mlarge-text
8177 When @option{-msmall-text} is used, the compiler assumes that the
8178 code of the entire program (or shared library) fits in 4MB, and is
8179 thus reachable with a branch instruction.  When @option{-msmall-data}
8180 is used, the compiler can assume that all local symbols share the
8181 same @code{$gp} value, and thus reduce the number of instructions
8182 required for a function call from 4 to 1.
8183
8184 The default is @option{-mlarge-text}.
8185
8186 @item -mcpu=@var{cpu_type}
8187 @opindex mcpu
8188 Set the instruction set and instruction scheduling parameters for
8189 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8190 style name or the corresponding chip number.  GCC supports scheduling
8191 parameters for the EV4, EV5 and EV6 family of processors and will
8192 choose the default values for the instruction set from the processor
8193 you specify.  If you do not specify a processor type, GCC will default
8194 to the processor on which the compiler was built.
8195
8196 Supported values for @var{cpu_type} are
8197
8198 @table @samp
8199 @item ev4
8200 @itemx ev45
8201 @itemx 21064
8202 Schedules as an EV4 and has no instruction set extensions.
8203
8204 @item ev5
8205 @itemx 21164
8206 Schedules as an EV5 and has no instruction set extensions.
8207
8208 @item ev56
8209 @itemx 21164a
8210 Schedules as an EV5 and supports the BWX extension.
8211
8212 @item pca56
8213 @itemx 21164pc
8214 @itemx 21164PC
8215 Schedules as an EV5 and supports the BWX and MAX extensions.
8216
8217 @item ev6
8218 @itemx 21264
8219 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8220
8221 @item ev67
8222 @itemx 21264a
8223 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8224 @end table
8225
8226 @item -mtune=@var{cpu_type}
8227 @opindex mtune
8228 Set only the instruction scheduling parameters for machine type
8229 @var{cpu_type}.  The instruction set is not changed.
8230
8231 @item -mmemory-latency=@var{time}
8232 @opindex mmemory-latency
8233 Sets the latency the scheduler should assume for typical memory
8234 references as seen by the application.  This number is highly
8235 dependent on the memory access patterns used by the application
8236 and the size of the external cache on the machine.
8237
8238 Valid options for @var{time} are
8239
8240 @table @samp
8241 @item @var{number}
8242 A decimal number representing clock cycles.
8243
8244 @item L1
8245 @itemx L2
8246 @itemx L3
8247 @itemx main
8248 The compiler contains estimates of the number of clock cycles for
8249 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8250 (also called Dcache, Scache, and Bcache), as well as to main memory.
8251 Note that L3 is only valid for EV5.
8252
8253 @end table
8254 @end table
8255
8256 @node DEC Alpha/VMS Options
8257 @subsection DEC Alpha/VMS Options
8258
8259 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8260
8261 @table @gcctabopt
8262 @item -mvms-return-codes
8263 @opindex mvms-return-codes
8264 Return VMS condition codes from main.  The default is to return POSIX
8265 style condition (e.g.@ error) codes.
8266 @end table
8267
8268 @node FRV Options
8269 @subsection FRV Options
8270 @cindex FRV Options
8271
8272 @table @gcctabopt
8273 @item -mgpr-32
8274 @opindex mgpr-32
8275
8276 Only use the first 32 general purpose registers.
8277
8278 @item -mgpr-64
8279 @opindex mgpr-64
8280
8281 Use all 64 general purpose registers.
8282
8283 @item -mfpr-32
8284 @opindex mfpr-32
8285
8286 Use only the first 32 floating point registers.
8287
8288 @item -mfpr-64
8289 @opindex mfpr-64
8290
8291 Use all 64 floating point registers
8292
8293 @item -mhard-float
8294 @opindex mhard-float
8295
8296 Use hardware instructions for floating point operations.
8297
8298 @item -msoft-float
8299 @opindex msoft-float
8300
8301 Use library routines for floating point operations.
8302
8303 @item -malloc-cc
8304 @opindex malloc-cc
8305
8306 Dynamically allocate condition code registers.
8307
8308 @item -mfixed-cc
8309 @opindex mfixed-cc
8310
8311 Do not try to dynamically allocate condition code registers, only
8312 use @code{icc0} and @code{fcc0}.
8313
8314 @item -mdword
8315 @opindex mdword
8316
8317 Change ABI to use double word insns.
8318
8319 @item -mno-dword
8320 @opindex mno-dword
8321
8322 Do not use double word instructions.
8323
8324 @item -mdouble
8325 @opindex mdouble
8326
8327 Use floating point double instructions.
8328
8329 @item -mno-double
8330 @opindex mno-double
8331
8332 Do not use floating point double instructions.
8333
8334 @item -mmedia
8335 @opindex mmedia
8336
8337 Use media instructions.
8338
8339 @item -mno-media
8340 @opindex mno-media
8341
8342 Do not use media instructions.
8343
8344 @item -mmuladd
8345 @opindex mmuladd
8346
8347 Use multiply and add/subtract instructions.
8348
8349 @item -mno-muladd
8350 @opindex mno-muladd
8351
8352 Do not use multiply and add/subtract instructions.
8353
8354 @item -mfdpic
8355 @opindex mfdpic
8356
8357 Select the FDPIC ABI, that uses function descriptors to represent
8358 pointers to functions.  Without any PIC/PIE-related options, it
8359 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8360 assumes GOT entries and small data are within a 12-bit range from the
8361 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8362 are computed with 32 bits.
8363
8364 @item -minline-plt
8365 @opindex minline-plt
8366
8367 Enable inlining of PLT entries in function calls to functions that are
8368 not known to bind locally.  It has no effect without @option{-mfdpic}.
8369 It's enabled by default if optimizing for speed and compiling for
8370 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8371 optimization option such as @option{-O3} or above is present in the
8372 command line.
8373
8374 @item -mTLS
8375 @opindex TLS
8376
8377 Assume a large TLS segment when generating thread-local code.
8378
8379 @item -mtls
8380 @opindex tls
8381
8382 Do not assume a large TLS segment when generating thread-local code.
8383
8384 @item -mgprel-ro
8385 @opindex mgprel-ro
8386
8387 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8388 that is known to be in read-only sections.  It's enabled by default,
8389 except for @option{-fpic} or @option{-fpie}: even though it may help
8390 make the global offset table smaller, it trades 1 instruction for 4.
8391 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8392 one of which may be shared by multiple symbols, and it avoids the need
8393 for a GOT entry for the referenced symbol, so it's more likely to be a
8394 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8395
8396 @item -multilib-library-pic
8397 @opindex multilib-library-pic
8398
8399 Link with the (library, not FD) pic libraries.  It's implied by
8400 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8401 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8402 it explicitly.
8403
8404 @item -mlinked-fp
8405 @opindex mlinked-fp
8406
8407 Follow the EABI requirement of always creating a frame pointer whenever
8408 a stack frame is allocated.  This option is enabled by default and can
8409 be disabled with @option{-mno-linked-fp}.
8410
8411 @item -mlong-calls
8412 @opindex mlong-calls
8413
8414 Use indirect addressing to call functions outside the current
8415 compilation unit.  This allows the functions to be placed anywhere
8416 within the 32-bit address space.
8417
8418 @item -malign-labels
8419 @opindex malign-labels
8420
8421 Try to align labels to an 8-byte boundary by inserting nops into the
8422 previous packet.  This option only has an effect when VLIW packing
8423 is enabled.  It doesn't create new packets; it merely adds nops to
8424 existing ones.
8425
8426 @item -mlibrary-pic
8427 @opindex mlibrary-pic
8428
8429 Generate position-independent EABI code.
8430
8431 @item -macc-4
8432 @opindex macc-4
8433
8434 Use only the first four media accumulator registers.
8435
8436 @item -macc-8
8437 @opindex macc-8
8438
8439 Use all eight media accumulator registers.
8440
8441 @item -mpack
8442 @opindex mpack
8443
8444 Pack VLIW instructions.
8445
8446 @item -mno-pack
8447 @opindex mno-pack
8448
8449 Do not pack VLIW instructions.
8450
8451 @item -mno-eflags
8452 @opindex mno-eflags
8453
8454 Do not mark ABI switches in e_flags.
8455
8456 @item -mcond-move
8457 @opindex mcond-move
8458
8459 Enable the use of conditional-move instructions (default).
8460
8461 This switch is mainly for debugging the compiler and will likely be removed
8462 in a future version.
8463
8464 @item -mno-cond-move
8465 @opindex mno-cond-move
8466
8467 Disable the use of conditional-move instructions.
8468
8469 This switch is mainly for debugging the compiler and will likely be removed
8470 in a future version.
8471
8472 @item -mscc
8473 @opindex mscc
8474
8475 Enable the use of conditional set instructions (default).
8476
8477 This switch is mainly for debugging the compiler and will likely be removed
8478 in a future version.
8479
8480 @item -mno-scc
8481 @opindex mno-scc
8482
8483 Disable the use of conditional set instructions.
8484
8485 This switch is mainly for debugging the compiler and will likely be removed
8486 in a future version.
8487
8488 @item -mcond-exec
8489 @opindex mcond-exec
8490
8491 Enable the use of conditional execution (default).
8492
8493 This switch is mainly for debugging the compiler and will likely be removed
8494 in a future version.
8495
8496 @item -mno-cond-exec
8497 @opindex mno-cond-exec
8498
8499 Disable the use of conditional execution.
8500
8501 This switch is mainly for debugging the compiler and will likely be removed
8502 in a future version.
8503
8504 @item -mvliw-branch
8505 @opindex mvliw-branch
8506
8507 Run a pass to pack branches into VLIW instructions (default).
8508
8509 This switch is mainly for debugging the compiler and will likely be removed
8510 in a future version.
8511
8512 @item -mno-vliw-branch
8513 @opindex mno-vliw-branch
8514
8515 Do not run a pass to pack branches into VLIW instructions.
8516
8517 This switch is mainly for debugging the compiler and will likely be removed
8518 in a future version.
8519
8520 @item -mmulti-cond-exec
8521 @opindex mmulti-cond-exec
8522
8523 Enable optimization of @code{&&} and @code{||} in conditional execution
8524 (default).
8525
8526 This switch is mainly for debugging the compiler and will likely be removed
8527 in a future version.
8528
8529 @item -mno-multi-cond-exec
8530 @opindex mno-multi-cond-exec
8531
8532 Disable optimization of @code{&&} and @code{||} in conditional execution.
8533
8534 This switch is mainly for debugging the compiler and will likely be removed
8535 in a future version.
8536
8537 @item -mnested-cond-exec
8538 @opindex mnested-cond-exec
8539
8540 Enable nested conditional execution optimizations (default).
8541
8542 This switch is mainly for debugging the compiler and will likely be removed
8543 in a future version.
8544
8545 @item -mno-nested-cond-exec
8546 @opindex mno-nested-cond-exec
8547
8548 Disable nested conditional execution optimizations.
8549
8550 This switch is mainly for debugging the compiler and will likely be removed
8551 in a future version.
8552
8553 @item -moptimize-membar
8554 @opindex moptimize-membar
8555
8556 This switch removes redundant @code{membar} instructions from the
8557 compiler generated code.  It is enabled by default.
8558
8559 @item -mno-optimize-membar
8560 @opindex mno-optimize-membar
8561
8562 This switch disables the automatic removal of redundant @code{membar}
8563 instructions from the generated code.
8564
8565 @item -mtomcat-stats
8566 @opindex mtomcat-stats
8567
8568 Cause gas to print out tomcat statistics.
8569
8570 @item -mcpu=@var{cpu}
8571 @opindex mcpu
8572
8573 Select the processor type for which to generate code.  Possible values are
8574 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8575 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8576
8577 @end table
8578
8579 @node H8/300 Options
8580 @subsection H8/300 Options
8581
8582 These @samp{-m} options are defined for the H8/300 implementations:
8583
8584 @table @gcctabopt
8585 @item -mrelax
8586 @opindex mrelax
8587 Shorten some address references at link time, when possible; uses the
8588 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8589 ld, Using ld}, for a fuller description.
8590
8591 @item -mh
8592 @opindex mh
8593 Generate code for the H8/300H@.
8594
8595 @item -ms
8596 @opindex ms
8597 Generate code for the H8S@.
8598
8599 @item -mn
8600 @opindex mn
8601 Generate code for the H8S and H8/300H in the normal mode.  This switch
8602 must be used either with @option{-mh} or @option{-ms}.
8603
8604 @item -ms2600
8605 @opindex ms2600
8606 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8607
8608 @item -mint32
8609 @opindex mint32
8610 Make @code{int} data 32 bits by default.
8611
8612 @item -malign-300
8613 @opindex malign-300
8614 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8615 The default for the H8/300H and H8S is to align longs and floats on 4
8616 byte boundaries.
8617 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8618 This option has no effect on the H8/300.
8619 @end table
8620
8621 @node HPPA Options
8622 @subsection HPPA Options
8623 @cindex HPPA Options
8624
8625 These @samp{-m} options are defined for the HPPA family of computers:
8626
8627 @table @gcctabopt
8628 @item -march=@var{architecture-type}
8629 @opindex march
8630 Generate code for the specified architecture.  The choices for
8631 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8632 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8633 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8634 architecture option for your machine.  Code compiled for lower numbered
8635 architectures will run on higher numbered architectures, but not the
8636 other way around.
8637
8638 @item -mpa-risc-1-0
8639 @itemx -mpa-risc-1-1
8640 @itemx -mpa-risc-2-0
8641 @opindex mpa-risc-1-0
8642 @opindex mpa-risc-1-1
8643 @opindex mpa-risc-2-0
8644 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8645
8646 @item -mbig-switch
8647 @opindex mbig-switch
8648 Generate code suitable for big switch tables.  Use this option only if
8649 the assembler/linker complain about out of range branches within a switch
8650 table.
8651
8652 @item -mjump-in-delay
8653 @opindex mjump-in-delay
8654 Fill delay slots of function calls with unconditional jump instructions
8655 by modifying the return pointer for the function call to be the target
8656 of the conditional jump.
8657
8658 @item -mdisable-fpregs
8659 @opindex mdisable-fpregs
8660 Prevent floating point registers from being used in any manner.  This is
8661 necessary for compiling kernels which perform lazy context switching of
8662 floating point registers.  If you use this option and attempt to perform
8663 floating point operations, the compiler will abort.
8664
8665 @item -mdisable-indexing
8666 @opindex mdisable-indexing
8667 Prevent the compiler from using indexing address modes.  This avoids some
8668 rather obscure problems when compiling MIG generated code under MACH@.
8669
8670 @item -mno-space-regs
8671 @opindex mno-space-regs
8672 Generate code that assumes the target has no space registers.  This allows
8673 GCC to generate faster indirect calls and use unscaled index address modes.
8674
8675 Such code is suitable for level 0 PA systems and kernels.
8676
8677 @item -mfast-indirect-calls
8678 @opindex mfast-indirect-calls
8679 Generate code that assumes calls never cross space boundaries.  This
8680 allows GCC to emit code which performs faster indirect calls.
8681
8682 This option will not work in the presence of shared libraries or nested
8683 functions.
8684
8685 @item -mfixed-range=@var{register-range}
8686 @opindex mfixed-range
8687 Generate code treating the given register range as fixed registers.
8688 A fixed register is one that the register allocator can not use.  This is
8689 useful when compiling kernel code.  A register range is specified as
8690 two registers separated by a dash.  Multiple register ranges can be
8691 specified separated by a comma.
8692
8693 @item -mlong-load-store
8694 @opindex mlong-load-store
8695 Generate 3-instruction load and store sequences as sometimes required by
8696 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8697 the HP compilers.
8698
8699 @item -mportable-runtime
8700 @opindex mportable-runtime
8701 Use the portable calling conventions proposed by HP for ELF systems.
8702
8703 @item -mgas
8704 @opindex mgas
8705 Enable the use of assembler directives only GAS understands.
8706
8707 @item -mschedule=@var{cpu-type}
8708 @opindex mschedule
8709 Schedule code according to the constraints for the machine type
8710 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8711 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8712 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8713 proper scheduling option for your machine.  The default scheduling is
8714 @samp{8000}.
8715
8716 @item -mlinker-opt
8717 @opindex mlinker-opt
8718 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8719 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8720 linkers in which they give bogus error messages when linking some programs.
8721
8722 @item -msoft-float
8723 @opindex msoft-float
8724 Generate output containing library calls for floating point.
8725 @strong{Warning:} the requisite libraries are not available for all HPPA
8726 targets.  Normally the facilities of the machine's usual C compiler are
8727 used, but this cannot be done directly in cross-compilation.  You must make
8728 your own arrangements to provide suitable library functions for
8729 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8730 does provide software floating point support.
8731
8732 @option{-msoft-float} changes the calling convention in the output file;
8733 therefore, it is only useful if you compile @emph{all} of a program with
8734 this option.  In particular, you need to compile @file{libgcc.a}, the
8735 library that comes with GCC, with @option{-msoft-float} in order for
8736 this to work.
8737
8738 @item -msio
8739 @opindex msio
8740 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8741 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8742 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8743 options are available under HP-UX and HI-UX@.
8744
8745 @item -mgnu-ld
8746 @opindex gnu-ld
8747 Use GNU ld specific options.  This passes @option{-shared} to ld when
8748 building a shared library.  It is the default when GCC is configured,
8749 explicitly or implicitly, with the GNU linker.  This option does not
8750 have any affect on which ld is called, it only changes what parameters
8751 are passed to that ld.  The ld that is called is determined by the
8752 @option{--with-ld} configure option, GCC's program search path, and
8753 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8754 using @samp{which `gcc -print-prog-name=ld`}.
8755
8756 @item -mhp-ld
8757 @opindex hp-ld
8758 Use HP ld specific options.  This passes @option{-b} to ld when building
8759 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8760 links.  It is the default when GCC is configured, explicitly or
8761 implicitly, with the HP linker.  This option does not have any affect on
8762 which ld is called, it only changes what parameters are passed to that
8763 ld.  The ld that is called is determined by the @option{--with-ld}
8764 configure option, GCC's program search path, and finally by the user's
8765 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8766 `gcc -print-prog-name=ld`}.
8767
8768 @item -mlong-calls
8769 @opindex mno-long-calls
8770 Generate code that uses long call sequences.  This ensures that a call
8771 is always able to reach linker generated stubs.  The default is to generate
8772 long calls only when the distance from the call site to the beginning
8773 of the function or translation unit, as the case may be, exceeds a
8774 predefined limit set by the branch type being used.  The limits for
8775 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8776 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8777 240,000 bytes.
8778
8779 Distances are measured from the beginning of functions when using the
8780 @option{-ffunction-sections} option, or when using the @option{-mgas}
8781 and @option{-mno-portable-runtime} options together under HP-UX with
8782 the SOM linker.
8783
8784 It is normally not desirable to use this option as it will degrade
8785 performance.  However, it may be useful in large applications,
8786 particularly when partial linking is used to build the application.
8787
8788 The types of long calls used depends on the capabilities of the
8789 assembler and linker, and the type of code being generated.  The
8790 impact on systems that support long absolute calls, and long pic
8791 symbol-difference or pc-relative calls should be relatively small.
8792 However, an indirect call is used on 32-bit ELF systems in pic code
8793 and it is quite long.
8794
8795 @item -munix=@var{unix-std}
8796 @opindex march
8797 Generate compiler predefines and select a startfile for the specified
8798 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8799 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8800 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8801 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8802 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8803 and later.
8804
8805 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8806 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8807 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8808 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8809 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8810 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8811
8812 It is @emph{important} to note that this option changes the interfaces
8813 for various library routines.  It also affects the operational behavior
8814 of the C library.  Thus, @emph{extreme} care is needed in using this
8815 option.
8816
8817 Library code that is intended to operate with more than one UNIX
8818 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8819 as appropriate.  Most GNU software doesn't provide this capability.
8820
8821 @item -nolibdld
8822 @opindex nolibdld
8823 Suppress the generation of link options to search libdld.sl when the
8824 @option{-static} option is specified on HP-UX 10 and later.
8825
8826 @item -static
8827 @opindex static
8828 The HP-UX implementation of setlocale in libc has a dependency on
8829 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8830 when the @option{-static} option is specified, special link options
8831 are needed to resolve this dependency.
8832
8833 On HP-UX 10 and later, the GCC driver adds the necessary options to
8834 link with libdld.sl when the @option{-static} option is specified.
8835 This causes the resulting binary to be dynamic.  On the 64-bit port,
8836 the linkers generate dynamic binaries by default in any case.  The
8837 @option{-nolibdld} option can be used to prevent the GCC driver from
8838 adding these link options.
8839
8840 @item -threads
8841 @opindex threads
8842 Add support for multithreading with the @dfn{dce thread} library
8843 under HP-UX@.  This option sets flags for both the preprocessor and
8844 linker.
8845 @end table
8846
8847 @node i386 and x86-64 Options
8848 @subsection Intel 386 and AMD x86-64 Options
8849 @cindex i386 Options
8850 @cindex x86-64 Options
8851 @cindex Intel 386 Options
8852 @cindex AMD x86-64 Options
8853
8854 These @samp{-m} options are defined for the i386 and x86-64 family of
8855 computers:
8856
8857 @table @gcctabopt
8858 @item -mtune=@var{cpu-type}
8859 @opindex mtune
8860 Tune to @var{cpu-type} everything applicable about the generated code, except
8861 for the ABI and the set of available instructions.  The choices for
8862 @var{cpu-type} are:
8863 @table @emph
8864 @item i386
8865 Original Intel's i386 CPU@.
8866 @item i486
8867 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8868 @item i586, pentium
8869 Intel Pentium CPU with no MMX support.
8870 @item pentium-mmx
8871 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8872 @item i686, pentiumpro
8873 Intel PentiumPro CPU@.
8874 @item pentium2
8875 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8876 @item pentium3, pentium3m
8877 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8878 support.
8879 @item pentium-m
8880 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8881 support.  Used by Centrino notebooks.
8882 @item pentium4, pentium4m
8883 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8884 @item prescott
8885 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8886 set support.
8887 @item nocona
8888 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8889 SSE2 and SSE3 instruction set support.
8890 @item k6
8891 AMD K6 CPU with MMX instruction set support.
8892 @item k6-2, k6-3
8893 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8894 @item athlon, athlon-tbird
8895 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8896 support.
8897 @item athlon-4, athlon-xp, athlon-mp
8898 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8899 instruction set support.
8900 @item k8, opteron, athlon64, athlon-fx
8901 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8902 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8903 @item winchip-c6
8904 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8905 set support.
8906 @item winchip2
8907 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8908 instruction set support.
8909 @item c3
8910 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8911 implemented for this chip.)
8912 @item c3-2
8913 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8914 implemented for this chip.)
8915 @end table
8916
8917 While picking a specific @var{cpu-type} will schedule things appropriately
8918 for that particular chip, the compiler will not generate any code that
8919 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8920 being used.
8921
8922 @item -march=@var{cpu-type}
8923 @opindex march
8924 Generate instructions for the machine type @var{cpu-type}.  The choices
8925 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8926 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8927
8928 @item -mcpu=@var{cpu-type}
8929 @opindex mcpu
8930 A deprecated synonym for @option{-mtune}.
8931
8932 @item -m386
8933 @itemx -m486
8934 @itemx -mpentium
8935 @itemx -mpentiumpro
8936 @opindex m386
8937 @opindex m486
8938 @opindex mpentium
8939 @opindex mpentiumpro
8940 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8941 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8942 These synonyms are deprecated.
8943
8944 @item -mfpmath=@var{unit}
8945 @opindex march
8946 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8947 for @var{unit} are:
8948
8949 @table @samp
8950 @item 387
8951 Use the standard 387 floating point coprocessor present majority of chips and
8952 emulated otherwise.  Code compiled with this option will run almost everywhere.
8953 The temporary results are computed in 80bit precision instead of precision
8954 specified by the type resulting in slightly different results compared to most
8955 of other chips.  See @option{-ffloat-store} for more detailed description.
8956
8957 This is the default choice for i386 compiler.
8958
8959 @item sse
8960 Use scalar floating point instructions present in the SSE instruction set.
8961 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8962 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8963 instruction set supports only single precision arithmetics, thus the double and
8964 extended precision arithmetics is still done using 387.  Later version, present
8965 only in Pentium4 and the future AMD x86-64 chips supports double precision
8966 arithmetics too.
8967
8968 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8969 or @option{-msse2} switches to enable SSE extensions and make this option
8970 effective.  For the x86-64 compiler, these extensions are enabled by default.
8971
8972 The resulting code should be considerably faster in the majority of cases and avoid
8973 the numerical instability problems of 387 code, but may break some existing
8974 code that expects temporaries to be 80bit.
8975
8976 This is the default choice for the x86-64 compiler.
8977
8978 @item sse,387
8979 Attempt to utilize both instruction sets at once.  This effectively double the
8980 amount of available registers and on chips with separate execution units for
8981 387 and SSE the execution resources too.  Use this option with care, as it is
8982 still experimental, because the GCC register allocator does not model separate
8983 functional units well resulting in instable performance.
8984 @end table
8985
8986 @item -masm=@var{dialect}
8987 @opindex masm=@var{dialect}
8988 Output asm instructions using selected @var{dialect}.  Supported choices are
8989 @samp{intel} or @samp{att} (the default one).
8990
8991 @item -mieee-fp
8992 @itemx -mno-ieee-fp
8993 @opindex mieee-fp
8994 @opindex mno-ieee-fp
8995 Control whether or not the compiler uses IEEE floating point
8996 comparisons.  These handle correctly the case where the result of a
8997 comparison is unordered.
8998
8999 @item -msoft-float
9000 @opindex msoft-float
9001 Generate output containing library calls for floating point.
9002 @strong{Warning:} the requisite libraries are not part of GCC@.
9003 Normally the facilities of the machine's usual C compiler are used, but
9004 this can't be done directly in cross-compilation.  You must make your
9005 own arrangements to provide suitable library functions for
9006 cross-compilation.
9007
9008 On machines where a function returns floating point results in the 80387
9009 register stack, some floating point opcodes may be emitted even if
9010 @option{-msoft-float} is used.
9011
9012 @item -mno-fp-ret-in-387
9013 @opindex mno-fp-ret-in-387
9014 Do not use the FPU registers for return values of functions.
9015
9016 The usual calling convention has functions return values of types
9017 @code{float} and @code{double} in an FPU register, even if there
9018 is no FPU@.  The idea is that the operating system should emulate
9019 an FPU@.
9020
9021 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9022 in ordinary CPU registers instead.
9023
9024 @item -mno-fancy-math-387
9025 @opindex mno-fancy-math-387
9026 Some 387 emulators do not support the @code{sin}, @code{cos} and
9027 @code{sqrt} instructions for the 387.  Specify this option to avoid
9028 generating those instructions.  This option is the default on FreeBSD,
9029 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9030 indicates that the target cpu will always have an FPU and so the
9031 instruction will not need emulation.  As of revision 2.6.1, these
9032 instructions are not generated unless you also use the
9033 @option{-funsafe-math-optimizations} switch.
9034
9035 @item -malign-double
9036 @itemx -mno-align-double
9037 @opindex malign-double
9038 @opindex mno-align-double
9039 Control whether GCC aligns @code{double}, @code{long double}, and
9040 @code{long long} variables on a two word boundary or a one word
9041 boundary.  Aligning @code{double} variables on a two word boundary will
9042 produce code that runs somewhat faster on a @samp{Pentium} at the
9043 expense of more memory.
9044
9045 @strong{Warning:} if you use the @option{-malign-double} switch,
9046 structures containing the above types will be aligned differently than
9047 the published application binary interface specifications for the 386
9048 and will not be binary compatible with structures in code compiled
9049 without that switch.
9050
9051 @item -m96bit-long-double
9052 @itemx -m128bit-long-double
9053 @opindex m96bit-long-double
9054 @opindex m128bit-long-double
9055 These switches control the size of @code{long double} type.  The i386
9056 application binary interface specifies the size to be 96 bits,
9057 so @option{-m96bit-long-double} is the default in 32 bit mode.
9058
9059 Modern architectures (Pentium and newer) would prefer @code{long double}
9060 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9061 conforming to the ABI, this would not be possible.  So specifying a
9062 @option{-m128bit-long-double} will align @code{long double}
9063 to a 16 byte boundary by padding the @code{long double} with an additional
9064 32 bit zero.
9065
9066 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9067 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9068
9069 Notice that neither of these options enable any extra precision over the x87
9070 standard of 80 bits for a @code{long double}.
9071
9072 @strong{Warning:} if you override the default value for your target ABI, the
9073 structures and arrays containing @code{long double} variables will change
9074 their size as well as function calling convention for function taking
9075 @code{long double} will be modified.  Hence they will not be binary
9076 compatible with arrays or structures in code compiled without that switch.
9077
9078 @item -mmlarge-data-threshold=@var{number}
9079 @opindex mlarge-data-threshold=@var{number}
9080 When @option{-mcmodel=medium} is specified, the data greater than
9081 @var{threshold} are placed in large data section.  This value must be the
9082 same across all object linked into the binary and defaults to 65535.
9083
9084 @item -msvr3-shlib
9085 @itemx -mno-svr3-shlib
9086 @opindex msvr3-shlib
9087 @opindex mno-svr3-shlib
9088 Control whether GCC places uninitialized local variables into the
9089 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9090 into @code{bss}.  These options are meaningful only on System V Release 3.
9091
9092 @item -mrtd
9093 @opindex mrtd
9094 Use a different function-calling convention, in which functions that
9095 take a fixed number of arguments return with the @code{ret} @var{num}
9096 instruction, which pops their arguments while returning.  This saves one
9097 instruction in the caller since there is no need to pop the arguments
9098 there.
9099
9100 You can specify that an individual function is called with this calling
9101 sequence with the function attribute @samp{stdcall}.  You can also
9102 override the @option{-mrtd} option by using the function attribute
9103 @samp{cdecl}.  @xref{Function Attributes}.
9104
9105 @strong{Warning:} this calling convention is incompatible with the one
9106 normally used on Unix, so you cannot use it if you need to call
9107 libraries compiled with the Unix compiler.
9108
9109 Also, you must provide function prototypes for all functions that
9110 take variable numbers of arguments (including @code{printf});
9111 otherwise incorrect code will be generated for calls to those
9112 functions.
9113
9114 In addition, seriously incorrect code will result if you call a
9115 function with too many arguments.  (Normally, extra arguments are
9116 harmlessly ignored.)
9117
9118 @item -mregparm=@var{num}
9119 @opindex mregparm
9120 Control how many registers are used to pass integer arguments.  By
9121 default, no registers are used to pass arguments, and at most 3
9122 registers can be used.  You can control this behavior for a specific
9123 function by using the function attribute @samp{regparm}.
9124 @xref{Function Attributes}.
9125
9126 @strong{Warning:} if you use this switch, and
9127 @var{num} is nonzero, then you must build all modules with the same
9128 value, including any libraries.  This includes the system libraries and
9129 startup modules.
9130
9131 @item -msseregparm
9132 @opindex msseregparm
9133 Use SSE register passing conventions for float and double arguments
9134 and return values.  You can control this behavior for a specific
9135 function by using the function attribute @samp{sseregparm}.
9136 @xref{Function Attributes}.
9137
9138 @strong{Warning:} if you use this switch then you must build all
9139 modules with the same value, including any libraries.  This includes
9140 the system libraries and startup modules.
9141
9142 @item -mpreferred-stack-boundary=@var{num}
9143 @opindex mpreferred-stack-boundary
9144 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9145 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9146 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9147 size (@option{-Os}), in which case the default is the minimum correct
9148 alignment (4 bytes for x86, and 8 bytes for x86-64).
9149
9150 On Pentium and PentiumPro, @code{double} and @code{long double} values
9151 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9152 suffer significant run time performance penalties.  On Pentium III, the
9153 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9154 penalties if it is not 16 byte aligned.
9155
9156 To ensure proper alignment of this values on the stack, the stack boundary
9157 must be as aligned as that required by any value stored on the stack.
9158 Further, every function must be generated such that it keeps the stack
9159 aligned.  Thus calling a function compiled with a higher preferred
9160 stack boundary from a function compiled with a lower preferred stack
9161 boundary will most likely misalign the stack.  It is recommended that
9162 libraries that use callbacks always use the default setting.
9163
9164 This extra alignment does consume extra stack space, and generally
9165 increases code size.  Code that is sensitive to stack space usage, such
9166 as embedded systems and operating system kernels, may want to reduce the
9167 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9168
9169 @item -mmmx
9170 @itemx -mno-mmx
9171 @item -msse
9172 @itemx -mno-sse
9173 @item -msse2
9174 @itemx -mno-sse2
9175 @item -msse3
9176 @itemx -mno-sse3
9177 @item -m3dnow
9178 @itemx -mno-3dnow
9179 @opindex mmmx
9180 @opindex mno-mmx
9181 @opindex msse
9182 @opindex mno-sse
9183 @opindex m3dnow
9184 @opindex mno-3dnow
9185 These switches enable or disable the use of built-in functions that allow
9186 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9187 instruction set.
9188
9189 @xref{X86 Built-in Functions}, for details of the functions enabled
9190 and disabled by these switches.
9191
9192 To have SSE/SSE2 instructions generated automatically from floating-point
9193 code, see @option{-mfpmath=sse}.
9194
9195 @item -mpush-args
9196 @itemx -mno-push-args
9197 @opindex mpush-args
9198 @opindex mno-push-args
9199 Use PUSH operations to store outgoing parameters.  This method is shorter
9200 and usually equally fast as method using SUB/MOV operations and is enabled
9201 by default.  In some cases disabling it may improve performance because of
9202 improved scheduling and reduced dependencies.
9203
9204 @item -maccumulate-outgoing-args
9205 @opindex maccumulate-outgoing-args
9206 If enabled, the maximum amount of space required for outgoing arguments will be
9207 computed in the function prologue.  This is faster on most modern CPUs
9208 because of reduced dependencies, improved scheduling and reduced stack usage
9209 when preferred stack boundary is not equal to 2.  The drawback is a notable
9210 increase in code size.  This switch implies @option{-mno-push-args}.
9211
9212 @item -mthreads
9213 @opindex mthreads
9214 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9215 on thread-safe exception handling must compile and link all code with the
9216 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9217 @option{-D_MT}; when linking, it links in a special thread helper library
9218 @option{-lmingwthrd} which cleans up per thread exception handling data.
9219
9220 @item -mno-align-stringops
9221 @opindex mno-align-stringops
9222 Do not align destination of inlined string operations.  This switch reduces
9223 code size and improves performance in case the destination is already aligned,
9224 but GCC doesn't know about it.
9225
9226 @item -minline-all-stringops
9227 @opindex minline-all-stringops
9228 By default GCC inlines string operations only when destination is known to be
9229 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9230 size, but may improve performance of code that depends on fast memcpy, strlen
9231 and memset for short lengths.
9232
9233 @item -momit-leaf-frame-pointer
9234 @opindex momit-leaf-frame-pointer
9235 Don't keep the frame pointer in a register for leaf functions.  This
9236 avoids the instructions to save, set up and restore frame pointers and
9237 makes an extra register available in leaf functions.  The option
9238 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9239 which might make debugging harder.
9240
9241 @item -mtls-direct-seg-refs
9242 @itemx -mno-tls-direct-seg-refs
9243 @opindex mtls-direct-seg-refs
9244 Controls whether TLS variables may be accessed with offsets from the
9245 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9246 or whether the thread base pointer must be added.  Whether or not this
9247 is legal depends on the operating system, and whether it maps the
9248 segment to cover the entire TLS area.
9249
9250 For systems that use GNU libc, the default is on.
9251 @end table
9252
9253 These @samp{-m} switches are supported in addition to the above
9254 on AMD x86-64 processors in 64-bit environments.
9255
9256 @table @gcctabopt
9257 @item -m32
9258 @itemx -m64
9259 @opindex m32
9260 @opindex m64
9261 Generate code for a 32-bit or 64-bit environment.
9262 The 32-bit environment sets int, long and pointer to 32 bits and
9263 generates code that runs on any i386 system.
9264 The 64-bit environment sets int to 32 bits and long and pointer
9265 to 64 bits and generates code for AMD's x86-64 architecture.
9266
9267 @item -mno-red-zone
9268 @opindex no-red-zone
9269 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9270 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9271 stack pointer that will not be modified by signal or interrupt handlers
9272 and therefore can be used for temporary data without adjusting the stack
9273 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9274
9275 @item -mcmodel=small
9276 @opindex mcmodel=small
9277 Generate code for the small code model: the program and its symbols must
9278 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9279 Programs can be statically or dynamically linked.  This is the default
9280 code model.
9281
9282 @item -mcmodel=kernel
9283 @opindex mcmodel=kernel
9284 Generate code for the kernel code model.  The kernel runs in the
9285 negative 2 GB of the address space.
9286 This model has to be used for Linux kernel code.
9287
9288 @item -mcmodel=medium
9289 @opindex mcmodel=medium
9290 Generate code for the medium model: The program is linked in the lower 2
9291 GB of the address space but symbols can be located anywhere in the
9292 address space.  Programs can be statically or dynamically linked, but
9293 building of shared libraries are not supported with the medium model.
9294
9295 @item -mcmodel=large
9296 @opindex mcmodel=large
9297 Generate code for the large model: This model makes no assumptions
9298 about addresses and sizes of sections.  Currently GCC does not implement
9299 this model.
9300 @end table
9301
9302 @node IA-64 Options
9303 @subsection IA-64 Options
9304 @cindex IA-64 Options
9305
9306 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9307
9308 @table @gcctabopt
9309 @item -mbig-endian
9310 @opindex mbig-endian
9311 Generate code for a big endian target.  This is the default for HP-UX@.
9312
9313 @item -mlittle-endian
9314 @opindex mlittle-endian
9315 Generate code for a little endian target.  This is the default for AIX5
9316 and GNU/Linux.
9317
9318 @item -mgnu-as
9319 @itemx -mno-gnu-as
9320 @opindex mgnu-as
9321 @opindex mno-gnu-as
9322 Generate (or don't) code for the GNU assembler.  This is the default.
9323 @c Also, this is the default if the configure option @option{--with-gnu-as}
9324 @c is used.
9325
9326 @item -mgnu-ld
9327 @itemx -mno-gnu-ld
9328 @opindex mgnu-ld
9329 @opindex mno-gnu-ld
9330 Generate (or don't) code for the GNU linker.  This is the default.
9331 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9332 @c is used.
9333
9334 @item -mno-pic
9335 @opindex mno-pic
9336 Generate code that does not use a global pointer register.  The result
9337 is not position independent code, and violates the IA-64 ABI@.
9338
9339 @item -mvolatile-asm-stop
9340 @itemx -mno-volatile-asm-stop
9341 @opindex mvolatile-asm-stop
9342 @opindex mno-volatile-asm-stop
9343 Generate (or don't) a stop bit immediately before and after volatile asm
9344 statements.
9345
9346 @item -mregister-names
9347 @itemx -mno-register-names
9348 @opindex mregister-names
9349 @opindex mno-register-names
9350 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9351 the stacked registers.  This may make assembler output more readable.
9352
9353 @item -mno-sdata
9354 @itemx -msdata
9355 @opindex mno-sdata
9356 @opindex msdata
9357 Disable (or enable) optimizations that use the small data section.  This may
9358 be useful for working around optimizer bugs.
9359
9360 @item -mconstant-gp
9361 @opindex mconstant-gp
9362 Generate code that uses a single constant global pointer value.  This is
9363 useful when compiling kernel code.
9364
9365 @item -mauto-pic
9366 @opindex mauto-pic
9367 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9368 This is useful when compiling firmware code.
9369
9370 @item -minline-float-divide-min-latency
9371 @opindex minline-float-divide-min-latency
9372 Generate code for inline divides of floating point values
9373 using the minimum latency algorithm.
9374
9375 @item -minline-float-divide-max-throughput
9376 @opindex minline-float-divide-max-throughput
9377 Generate code for inline divides of floating point values
9378 using the maximum throughput algorithm.
9379
9380 @item -minline-int-divide-min-latency
9381 @opindex minline-int-divide-min-latency
9382 Generate code for inline divides of integer values
9383 using the minimum latency algorithm.
9384
9385 @item -minline-int-divide-max-throughput
9386 @opindex minline-int-divide-max-throughput
9387 Generate code for inline divides of integer values
9388 using the maximum throughput algorithm.
9389
9390 @item -minline-sqrt-min-latency
9391 @opindex minline-sqrt-min-latency
9392 Generate code for inline square roots
9393 using the minimum latency algorithm.
9394
9395 @item -minline-sqrt-max-throughput
9396 @opindex minline-sqrt-max-throughput
9397 Generate code for inline square roots
9398 using the maximum throughput algorithm.
9399
9400 @item -mno-dwarf2-asm
9401 @itemx -mdwarf2-asm
9402 @opindex mno-dwarf2-asm
9403 @opindex mdwarf2-asm
9404 Don't (or do) generate assembler code for the DWARF2 line number debugging
9405 info.  This may be useful when not using the GNU assembler.
9406
9407 @item -mearly-stop-bits
9408 @itemx -mno-early-stop-bits
9409 @opindex mearly-stop-bits
9410 @opindex mno-early-stop-bits
9411 Allow stop bits to be placed earlier than immediately preceding the
9412 instruction that triggered the stop bit.  This can improve instruction
9413 scheduling, but does not always do so.
9414
9415 @item -mfixed-range=@var{register-range}
9416 @opindex mfixed-range
9417 Generate code treating the given register range as fixed registers.
9418 A fixed register is one that the register allocator can not use.  This is
9419 useful when compiling kernel code.  A register range is specified as
9420 two registers separated by a dash.  Multiple register ranges can be
9421 specified separated by a comma.
9422
9423 @item -mtls-size=@var{tls-size}
9424 @opindex mtls-size
9425 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9426 64.
9427
9428 @item -mtune-arch=@var{cpu-type}
9429 @opindex mtune-arch
9430 Tune the instruction scheduling for a particular CPU, Valid values are
9431 itanium, itanium1, merced, itanium2, and mckinley.
9432
9433 @item -mt
9434 @itemx -pthread
9435 @opindex mt
9436 @opindex pthread
9437 Add support for multithreading using the POSIX threads library.  This
9438 option sets flags for both the preprocessor and linker.  It does
9439 not affect the thread safety of object code produced by the compiler or
9440 that of libraries supplied with it.  These are HP-UX specific flags.
9441
9442 @item -milp32
9443 @itemx -mlp64
9444 @opindex milp32
9445 @opindex mlp64
9446 Generate code for a 32-bit or 64-bit environment.
9447 The 32-bit environment sets int, long and pointer to 32 bits.
9448 The 64-bit environment sets int to 32 bits and long and pointer
9449 to 64 bits.  These are HP-UX specific flags.
9450
9451 @end table
9452
9453 @node M32C Options
9454 @subsection M32C Options
9455 @cindex M32C options
9456
9457 @table @gcctabopt
9458 @item -mcpu=@var{name}
9459 @opindex mcpu=
9460 Select the CPU for which code is generated.  @var{name} may be one of
9461 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9462 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9463 the M32C/80 series.
9464
9465 @item -msim
9466 @opindex msim
9467 Specifies that the program will be run on the simulator.  This causes
9468 an alternate runtime library to be linked in which supports, for
9469 example, file I/O.  You must not use this option when generating
9470 programs that will run on real hardware; you must provide your own
9471 runtime library for whatever I/O functions are needed.
9472
9473 @item -memregs=@var{number}
9474 @opindex memregs=
9475 Specifies the number of memory-based pseudo-registers GCC will use
9476 during code generation.  These pseudo-registers will be used like real
9477 registers, so there is a tradeoff between GCC's ability to fit the
9478 code into available registers, and the performance penalty of using
9479 memory instead of registers.  Note that all modules in a program must
9480 be compiled with the same value for this option.  Because of that, you
9481 must not use this option with the default runtime libraries gcc
9482 builds.
9483
9484 @end table
9485
9486 @node M32R/D Options
9487 @subsection M32R/D Options
9488 @cindex M32R/D options
9489
9490 These @option{-m} options are defined for Renesas M32R/D architectures:
9491
9492 @table @gcctabopt
9493 @item -m32r2
9494 @opindex m32r2
9495 Generate code for the M32R/2@.
9496
9497 @item -m32rx
9498 @opindex m32rx
9499 Generate code for the M32R/X@.
9500
9501 @item -m32r
9502 @opindex m32r
9503 Generate code for the M32R@.  This is the default.
9504
9505 @item -mmodel=small
9506 @opindex mmodel=small
9507 Assume all objects live in the lower 16MB of memory (so that their addresses
9508 can be loaded with the @code{ld24} instruction), and assume all subroutines
9509 are reachable with the @code{bl} instruction.
9510 This is the default.
9511
9512 The addressability of a particular object can be set with the
9513 @code{model} attribute.
9514
9515 @item -mmodel=medium
9516 @opindex mmodel=medium
9517 Assume objects may be anywhere in the 32-bit address space (the compiler
9518 will generate @code{seth/add3} instructions to load their addresses), and
9519 assume all subroutines are reachable with the @code{bl} instruction.
9520
9521 @item -mmodel=large
9522 @opindex mmodel=large
9523 Assume objects may be anywhere in the 32-bit address space (the compiler
9524 will generate @code{seth/add3} instructions to load their addresses), and
9525 assume subroutines may not be reachable with the @code{bl} instruction
9526 (the compiler will generate the much slower @code{seth/add3/jl}
9527 instruction sequence).
9528
9529 @item -msdata=none
9530 @opindex msdata=none
9531 Disable use of the small data area.  Variables will be put into
9532 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9533 @code{section} attribute has been specified).
9534 This is the default.
9535
9536 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9537 Objects may be explicitly put in the small data area with the
9538 @code{section} attribute using one of these sections.
9539
9540 @item -msdata=sdata
9541 @opindex msdata=sdata
9542 Put small global and static data in the small data area, but do not
9543 generate special code to reference them.
9544
9545 @item -msdata=use
9546 @opindex msdata=use
9547 Put small global and static data in the small data area, and generate
9548 special instructions to reference them.
9549
9550 @item -G @var{num}
9551 @opindex G
9552 @cindex smaller data references
9553 Put global and static objects less than or equal to @var{num} bytes
9554 into the small data or bss sections instead of the normal data or bss
9555 sections.  The default value of @var{num} is 8.
9556 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9557 for this option to have any effect.
9558
9559 All modules should be compiled with the same @option{-G @var{num}} value.
9560 Compiling with different values of @var{num} may or may not work; if it
9561 doesn't the linker will give an error message---incorrect code will not be
9562 generated.
9563
9564 @item -mdebug
9565 @opindex mdebug
9566 Makes the M32R specific code in the compiler display some statistics
9567 that might help in debugging programs.
9568
9569 @item -malign-loops
9570 @opindex malign-loops
9571 Align all loops to a 32-byte boundary.
9572
9573 @item -mno-align-loops
9574 @opindex mno-align-loops
9575 Do not enforce a 32-byte alignment for loops.  This is the default.
9576
9577 @item -missue-rate=@var{number}
9578 @opindex missue-rate=@var{number}
9579 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9580 or 2.
9581
9582 @item -mbranch-cost=@var{number}
9583 @opindex mbranch-cost=@var{number}
9584 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9585 preferred over conditional code, if it is 2, then the opposite will
9586 apply.
9587
9588 @item -mflush-trap=@var{number}
9589 @opindex mflush-trap=@var{number}
9590 Specifies the trap number to use to flush the cache.  The default is
9591 12.  Valid numbers are between 0 and 15 inclusive.
9592
9593 @item -mno-flush-trap
9594 @opindex mno-flush-trap
9595 Specifies that the cache cannot be flushed by using a trap.
9596
9597 @item -mflush-func=@var{name}
9598 @opindex mflush-func=@var{name}
9599 Specifies the name of the operating system function to call to flush
9600 the cache.  The default is @emph{_flush_cache}, but a function call
9601 will only be used if a trap is not available.
9602
9603 @item -mno-flush-func
9604 @opindex mno-flush-func
9605 Indicates that there is no OS function for flushing the cache.
9606
9607 @end table
9608
9609 @node M680x0 Options
9610 @subsection M680x0 Options
9611 @cindex M680x0 options
9612
9613 These are the @samp{-m} options defined for the 68000 series.  The default
9614 values for these options depends on which style of 68000 was selected when
9615 the compiler was configured; the defaults for the most common choices are
9616 given below.
9617
9618 @table @gcctabopt
9619 @item -m68000
9620 @itemx -mc68000
9621 @opindex m68000
9622 @opindex mc68000
9623 Generate output for a 68000.  This is the default
9624 when the compiler is configured for 68000-based systems.
9625
9626 Use this option for microcontrollers with a 68000 or EC000 core,
9627 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9628
9629 @item -m68020
9630 @itemx -mc68020
9631 @opindex m68020
9632 @opindex mc68020
9633 Generate output for a 68020.  This is the default
9634 when the compiler is configured for 68020-based systems.
9635
9636 @item -m68881
9637 @opindex m68881
9638 Generate output containing 68881 instructions for floating point.
9639 This is the default for most 68020 systems unless @option{--nfp} was
9640 specified when the compiler was configured.
9641
9642 @item -m68030
9643 @opindex m68030
9644 Generate output for a 68030.  This is the default when the compiler is
9645 configured for 68030-based systems.
9646
9647 @item -m68040
9648 @opindex m68040
9649 Generate output for a 68040.  This is the default when the compiler is
9650 configured for 68040-based systems.
9651
9652 This option inhibits the use of 68881/68882 instructions that have to be
9653 emulated by software on the 68040.  Use this option if your 68040 does not
9654 have code to emulate those instructions.
9655
9656 @item -m68060
9657 @opindex m68060
9658 Generate output for a 68060.  This is the default when the compiler is
9659 configured for 68060-based systems.
9660
9661 This option inhibits the use of 68020 and 68881/68882 instructions that
9662 have to be emulated by software on the 68060.  Use this option if your 68060
9663 does not have code to emulate those instructions.
9664
9665 @item -mcpu32
9666 @opindex mcpu32
9667 Generate output for a CPU32.  This is the default
9668 when the compiler is configured for CPU32-based systems.
9669
9670 Use this option for microcontrollers with a
9671 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9672 68336, 68340, 68341, 68349 and 68360.
9673
9674 @item -m5200
9675 @opindex m5200
9676 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9677 when the compiler is configured for 520X-based systems.
9678
9679 Use this option for microcontroller with a 5200 core, including
9680 the MCF5202, MCF5203, MCF5204 and MCF5202.
9681
9682
9683 @item -m68020-40
9684 @opindex m68020-40
9685 Generate output for a 68040, without using any of the new instructions.
9686 This results in code which can run relatively efficiently on either a
9687 68020/68881 or a 68030 or a 68040.  The generated code does use the
9688 68881 instructions that are emulated on the 68040.
9689
9690 @item -m68020-60
9691 @opindex m68020-60
9692 Generate output for a 68060, without using any of the new instructions.
9693 This results in code which can run relatively efficiently on either a
9694 68020/68881 or a 68030 or a 68040.  The generated code does use the
9695 68881 instructions that are emulated on the 68060.
9696
9697 @item -msoft-float
9698 @opindex msoft-float
9699 Generate output containing library calls for floating point.
9700 @strong{Warning:} the requisite libraries are not available for all m68k
9701 targets.  Normally the facilities of the machine's usual C compiler are
9702 used, but this can't be done directly in cross-compilation.  You must
9703 make your own arrangements to provide suitable library functions for
9704 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9705 @samp{m68k-*-coff} do provide software floating point support.
9706
9707 @item -mshort
9708 @opindex mshort
9709 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9710 Additionally, parameters passed on the stack are also aligned to a
9711 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9712
9713 @item -mnobitfield
9714 @opindex mnobitfield
9715 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9716 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9717
9718 @item -mbitfield
9719 @opindex mbitfield
9720 Do use the bit-field instructions.  The @option{-m68020} option implies
9721 @option{-mbitfield}.  This is the default if you use a configuration
9722 designed for a 68020.
9723
9724 @item -mrtd
9725 @opindex mrtd
9726 Use a different function-calling convention, in which functions
9727 that take a fixed number of arguments return with the @code{rtd}
9728 instruction, which pops their arguments while returning.  This
9729 saves one instruction in the caller since there is no need to pop
9730 the arguments there.
9731
9732 This calling convention is incompatible with the one normally
9733 used on Unix, so you cannot use it if you need to call libraries
9734 compiled with the Unix compiler.
9735
9736 Also, you must provide function prototypes for all functions that
9737 take variable numbers of arguments (including @code{printf});
9738 otherwise incorrect code will be generated for calls to those
9739 functions.
9740
9741 In addition, seriously incorrect code will result if you call a
9742 function with too many arguments.  (Normally, extra arguments are
9743 harmlessly ignored.)
9744
9745 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9746 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9747
9748 @item -malign-int
9749 @itemx -mno-align-int
9750 @opindex malign-int
9751 @opindex mno-align-int
9752 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9753 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9754 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9755 Aligning variables on 32-bit boundaries produces code that runs somewhat
9756 faster on processors with 32-bit busses at the expense of more memory.
9757
9758 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9759 align structures containing the above types  differently than
9760 most published application binary interface specifications for the m68k.
9761
9762 @item -mpcrel
9763 @opindex mpcrel
9764 Use the pc-relative addressing mode of the 68000 directly, instead of
9765 using a global offset table.  At present, this option implies @option{-fpic},
9766 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9767 not presently supported with @option{-mpcrel}, though this could be supported for
9768 68020 and higher processors.
9769
9770 @item -mno-strict-align
9771 @itemx -mstrict-align
9772 @opindex mno-strict-align
9773 @opindex mstrict-align
9774 Do not (do) assume that unaligned memory references will be handled by
9775 the system.
9776
9777 @item -msep-data
9778 Generate code that allows the data segment to be located in a different
9779 area of memory from the text segment.  This allows for execute in place in
9780 an environment without virtual memory management.  This option implies
9781 @option{-fPIC}.
9782
9783 @item -mno-sep-data
9784 Generate code that assumes that the data segment follows the text segment.
9785 This is the default.
9786
9787 @item -mid-shared-library
9788 Generate code that supports shared libraries via the library ID method.
9789 This allows for execute in place and shared libraries in an environment
9790 without virtual memory management.  This option implies @option{-fPIC}.
9791
9792 @item -mno-id-shared-library
9793 Generate code that doesn't assume ID based shared libraries are being used.
9794 This is the default.
9795
9796 @item -mshared-library-id=n
9797 Specified the identification number of the ID based shared library being
9798 compiled.  Specifying a value of 0 will generate more compact code, specifying
9799 other values will force the allocation of that number to the current
9800 library but is no more space or time efficient than omitting this option.
9801
9802 @end table
9803
9804 @node M68hc1x Options
9805 @subsection M68hc1x Options
9806 @cindex M68hc1x options
9807
9808 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9809 microcontrollers.  The default values for these options depends on
9810 which style of microcontroller was selected when the compiler was configured;
9811 the defaults for the most common choices are given below.
9812
9813 @table @gcctabopt
9814 @item -m6811
9815 @itemx -m68hc11
9816 @opindex m6811
9817 @opindex m68hc11
9818 Generate output for a 68HC11.  This is the default
9819 when the compiler is configured for 68HC11-based systems.
9820
9821 @item -m6812
9822 @itemx -m68hc12
9823 @opindex m6812
9824 @opindex m68hc12
9825 Generate output for a 68HC12.  This is the default
9826 when the compiler is configured for 68HC12-based systems.
9827
9828 @item -m68S12
9829 @itemx -m68hcs12
9830 @opindex m68S12
9831 @opindex m68hcs12
9832 Generate output for a 68HCS12.
9833
9834 @item -mauto-incdec
9835 @opindex mauto-incdec
9836 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9837 addressing modes.
9838
9839 @item -minmax
9840 @itemx -nominmax
9841 @opindex minmax
9842 @opindex mnominmax
9843 Enable the use of 68HC12 min and max instructions.
9844
9845 @item -mlong-calls
9846 @itemx -mno-long-calls
9847 @opindex mlong-calls
9848 @opindex mno-long-calls
9849 Treat all calls as being far away (near).  If calls are assumed to be
9850 far away, the compiler will use the @code{call} instruction to
9851 call a function and the @code{rtc} instruction for returning.
9852
9853 @item -mshort
9854 @opindex mshort
9855 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9856
9857 @item -msoft-reg-count=@var{count}
9858 @opindex msoft-reg-count
9859 Specify the number of pseudo-soft registers which are used for the
9860 code generation.  The maximum number is 32.  Using more pseudo-soft
9861 register may or may not result in better code depending on the program.
9862 The default is 4 for 68HC11 and 2 for 68HC12.
9863
9864 @end table
9865
9866 @node MCore Options
9867 @subsection MCore Options
9868 @cindex MCore options
9869
9870 These are the @samp{-m} options defined for the Motorola M*Core
9871 processors.
9872
9873 @table @gcctabopt
9874
9875 @item -mhardlit
9876 @itemx -mno-hardlit
9877 @opindex mhardlit
9878 @opindex mno-hardlit
9879 Inline constants into the code stream if it can be done in two
9880 instructions or less.
9881
9882 @item -mdiv
9883 @itemx -mno-div
9884 @opindex mdiv
9885 @opindex mno-div
9886 Use the divide instruction.  (Enabled by default).
9887
9888 @item -mrelax-immediate
9889 @itemx -mno-relax-immediate
9890 @opindex mrelax-immediate
9891 @opindex mno-relax-immediate
9892 Allow arbitrary sized immediates in bit operations.
9893
9894 @item -mwide-bitfields
9895 @itemx -mno-wide-bitfields
9896 @opindex mwide-bitfields
9897 @opindex mno-wide-bitfields
9898 Always treat bit-fields as int-sized.
9899
9900 @item -m4byte-functions
9901 @itemx -mno-4byte-functions
9902 @opindex m4byte-functions
9903 @opindex mno-4byte-functions
9904 Force all functions to be aligned to a four byte boundary.
9905
9906 @item -mcallgraph-data
9907 @itemx -mno-callgraph-data
9908 @opindex mcallgraph-data
9909 @opindex mno-callgraph-data
9910 Emit callgraph information.
9911
9912 @item -mslow-bytes
9913 @itemx -mno-slow-bytes
9914 @opindex mslow-bytes
9915 @opindex mno-slow-bytes
9916 Prefer word access when reading byte quantities.
9917
9918 @item -mlittle-endian
9919 @itemx -mbig-endian
9920 @opindex mlittle-endian
9921 @opindex mbig-endian
9922 Generate code for a little endian target.
9923
9924 @item -m210
9925 @itemx -m340
9926 @opindex m210
9927 @opindex m340
9928 Generate code for the 210 processor.
9929 @end table
9930
9931 @node MIPS Options
9932 @subsection MIPS Options
9933 @cindex MIPS options
9934
9935 @table @gcctabopt
9936
9937 @item -EB
9938 @opindex EB
9939 Generate big-endian code.
9940
9941 @item -EL
9942 @opindex EL
9943 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9944 configurations.
9945
9946 @item -march=@var{arch}
9947 @opindex march
9948 Generate code that will run on @var{arch}, which can be the name of a
9949 generic MIPS ISA, or the name of a particular processor.
9950 The ISA names are:
9951 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9952 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9953 The processor names are:
9954 @samp{4kc}, @samp{4km}, @samp{4kp},
9955 @samp{5kc}, @samp{5kf},
9956 @samp{20kc},
9957 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
9958 @samp{m4k},
9959 @samp{orion},
9960 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9961 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
9962 @samp{rm7000}, @samp{rm9000},
9963 @samp{sb1},
9964 @samp{sr71000},
9965 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9966 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9967 The special value @samp{from-abi} selects the
9968 most compatible architecture for the selected ABI (that is,
9969 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9970
9971 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9972 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9973 @samp{vr} may be written @samp{r}.
9974
9975 GCC defines two macros based on the value of this option.  The first
9976 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9977 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9978 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9979 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9980 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9981
9982 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9983 above.  In other words, it will have the full prefix and will not
9984 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9985 the macro names the resolved architecture (either @samp{"mips1"} or
9986 @samp{"mips3"}).  It names the default architecture when no
9987 @option{-march} option is given.
9988
9989 @item -mtune=@var{arch}
9990 @opindex mtune
9991 Optimize for @var{arch}.  Among other things, this option controls
9992 the way instructions are scheduled, and the perceived cost of arithmetic
9993 operations.  The list of @var{arch} values is the same as for
9994 @option{-march}.
9995
9996 When this option is not used, GCC will optimize for the processor
9997 specified by @option{-march}.  By using @option{-march} and
9998 @option{-mtune} together, it is possible to generate code that will
9999 run on a family of processors, but optimize the code for one
10000 particular member of that family.
10001
10002 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10003 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10004 @samp{-march} ones described above.
10005
10006 @item -mips1
10007 @opindex mips1
10008 Equivalent to @samp{-march=mips1}.
10009
10010 @item -mips2
10011 @opindex mips2
10012 Equivalent to @samp{-march=mips2}.
10013
10014 @item -mips3
10015 @opindex mips3
10016 Equivalent to @samp{-march=mips3}.
10017
10018 @item -mips4
10019 @opindex mips4
10020 Equivalent to @samp{-march=mips4}.
10021
10022 @item -mips32
10023 @opindex mips32
10024 Equivalent to @samp{-march=mips32}.
10025
10026 @item -mips32r2
10027 @opindex mips32r2
10028 Equivalent to @samp{-march=mips32r2}.
10029
10030 @item -mips64
10031 @opindex mips64
10032 Equivalent to @samp{-march=mips64}.
10033
10034 @item -mips16
10035 @itemx -mno-mips16
10036 @opindex mips16
10037 @opindex mno-mips16
10038 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10039 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10040
10041 @item -mabi=32
10042 @itemx -mabi=o64
10043 @itemx -mabi=n32
10044 @itemx -mabi=64
10045 @itemx -mabi=eabi
10046 @opindex mabi=32
10047 @opindex mabi=o64
10048 @opindex mabi=n32
10049 @opindex mabi=64
10050 @opindex mabi=eabi
10051 Generate code for the given ABI@.
10052
10053 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10054 generates 64-bit code when you select a 64-bit architecture, but you
10055 can use @option{-mgp32} to get 32-bit code instead.
10056
10057 For information about the O64 ABI, see
10058 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10059
10060 @item -mabicalls
10061 @itemx -mno-abicalls
10062 @opindex mabicalls
10063 @opindex mno-abicalls
10064 Generate (do not generate) SVR4-style position-independent code.
10065 @option{-mabicalls} is the default for SVR4-based systems.
10066
10067 @item -mxgot
10068 @itemx -mno-xgot
10069 @opindex mxgot
10070 @opindex mno-xgot
10071 Lift (do not lift) the usual restrictions on the size of the global
10072 offset table.
10073
10074 GCC normally uses a single instruction to load values from the GOT@.
10075 While this is relatively efficient, it will only work if the GOT
10076 is smaller than about 64k.  Anything larger will cause the linker
10077 to report an error such as:
10078
10079 @cindex relocation truncated to fit (MIPS)
10080 @smallexample
10081 relocation truncated to fit: R_MIPS_GOT16 foobar
10082 @end smallexample
10083
10084 If this happens, you should recompile your code with @option{-mxgot}.
10085 It should then work with very large GOTs, although it will also be
10086 less efficient, since it will take three instructions to fetch the
10087 value of a global symbol.
10088
10089 Note that some linkers can create multiple GOTs.  If you have such a
10090 linker, you should only need to use @option{-mxgot} when a single object
10091 file accesses more than 64k's worth of GOT entries.  Very few do.
10092
10093 These options have no effect unless GCC is generating position
10094 independent code.
10095
10096 @item -mgp32
10097 @opindex mgp32
10098 Assume that general-purpose registers are 32 bits wide.
10099
10100 @item -mgp64
10101 @opindex mgp64
10102 Assume that general-purpose registers are 64 bits wide.
10103
10104 @item -mfp32
10105 @opindex mfp32
10106 Assume that floating-point registers are 32 bits wide.
10107
10108 @item -mfp64
10109 @opindex mfp64
10110 Assume that floating-point registers are 64 bits wide.
10111
10112 @item -mhard-float
10113 @opindex mhard-float
10114 Use floating-point coprocessor instructions.
10115
10116 @item -msoft-float
10117 @opindex msoft-float
10118 Do not use floating-point coprocessor instructions.  Implement
10119 floating-point calculations using library calls instead.
10120
10121 @item -msingle-float
10122 @opindex msingle-float
10123 Assume that the floating-point coprocessor only supports single-precision
10124 operations.
10125
10126 @itemx -mdouble-float
10127 @opindex mdouble-float
10128 Assume that the floating-point coprocessor supports double-precision
10129 operations.  This is the default.
10130
10131 @itemx -mdsp
10132 @itemx -mno-dsp
10133 @opindex mdsp
10134 @opindex mno-dsp
10135 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10136
10137 @itemx -mpaired-single
10138 @itemx -mno-paired-single
10139 @opindex mpaired-single
10140 @opindex mno-paired-single
10141 Use (do not use) paired-single floating-point instructions.
10142 @xref{MIPS Paired-Single Support}.  This option can only be used
10143 when generating 64-bit code and requires hardware floating-point
10144 support to be enabled.
10145
10146 @itemx -mips3d
10147 @itemx -mno-mips3d
10148 @opindex mips3d
10149 @opindex mno-mips3d
10150 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10151 The option @option{-mips3d} implies @option{-mpaired-single}.
10152
10153 @item -mlong64
10154 @opindex mlong64
10155 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10156 an explanation of the default and the way that the pointer size is
10157 determined.
10158
10159 @item -mlong32
10160 @opindex mlong32
10161 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10162
10163 The default size of @code{int}s, @code{long}s and pointers depends on
10164 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10165 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10166 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10167 or the same size as integer registers, whichever is smaller.
10168
10169 @item -msym32
10170 @itemx -mno-sym32
10171 @opindex msym32
10172 @opindex mno-sym32
10173 Assume (do not assume) that all symbols have 32-bit values, regardless
10174 of the selected ABI@.  This option is useful in combination with
10175 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10176 to generate shorter and faster references to symbolic addresses.
10177
10178 @item -G @var{num}
10179 @opindex G
10180 @cindex smaller data references (MIPS)
10181 @cindex gp-relative references (MIPS)
10182 Put global and static items less than or equal to @var{num} bytes into
10183 the small data or bss section instead of the normal data or bss section.
10184 This allows the data to be accessed using a single instruction.
10185
10186 All modules should be compiled with the same @option{-G @var{num}}
10187 value.
10188
10189 @item -membedded-data
10190 @itemx -mno-embedded-data
10191 @opindex membedded-data
10192 @opindex mno-embedded-data
10193 Allocate variables to the read-only data section first if possible, then
10194 next in the small data section if possible, otherwise in data.  This gives
10195 slightly slower code than the default, but reduces the amount of RAM required
10196 when executing, and thus may be preferred for some embedded systems.
10197
10198 @item -muninit-const-in-rodata
10199 @itemx -mno-uninit-const-in-rodata
10200 @opindex muninit-const-in-rodata
10201 @opindex mno-uninit-const-in-rodata
10202 Put uninitialized @code{const} variables in the read-only data section.
10203 This option is only meaningful in conjunction with @option{-membedded-data}.
10204
10205 @item -msplit-addresses
10206 @itemx -mno-split-addresses
10207 @opindex msplit-addresses
10208 @opindex mno-split-addresses
10209 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10210 relocation operators.  This option has been superseded by
10211 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10212
10213 @item -mexplicit-relocs
10214 @itemx -mno-explicit-relocs
10215 @opindex mexplicit-relocs
10216 @opindex mno-explicit-relocs
10217 Use (do not use) assembler relocation operators when dealing with symbolic
10218 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10219 is to use assembler macros instead.
10220
10221 @option{-mexplicit-relocs} is the default if GCC was configured
10222 to use an assembler that supports relocation operators.
10223
10224 @item -mcheck-zero-division
10225 @itemx -mno-check-zero-division
10226 @opindex mcheck-zero-division
10227 @opindex mno-check-zero-division
10228 Trap (do not trap) on integer division by zero.  The default is
10229 @option{-mcheck-zero-division}.
10230
10231 @item -mdivide-traps
10232 @itemx -mdivide-breaks
10233 @opindex mdivide-traps
10234 @opindex mdivide-breaks
10235 MIPS systems check for division by zero by generating either a
10236 conditional trap or a break instruction.  Using traps results in
10237 smaller code, but is only supported on MIPS II and later.  Also, some
10238 versions of the Linux kernel have a bug that prevents trap from
10239 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10240 allow conditional traps on architectures that support them and
10241 @option{-mdivide-breaks} to force the use of breaks.
10242
10243 The default is usually @option{-mdivide-traps}, but this can be
10244 overridden at configure time using @option{--with-divide=breaks}.
10245 Divide-by-zero checks can be completely disabled using
10246 @option{-mno-check-zero-division}.
10247
10248 @item -mmemcpy
10249 @itemx -mno-memcpy
10250 @opindex mmemcpy
10251 @opindex mno-memcpy
10252 Force (do not force) the use of @code{memcpy()} for non-trivial block
10253 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10254 most constant-sized copies.
10255
10256 @item -mlong-calls
10257 @itemx -mno-long-calls
10258 @opindex mlong-calls
10259 @opindex mno-long-calls
10260 Disable (do not disable) use of the @code{jal} instruction.  Calling
10261 functions using @code{jal} is more efficient but requires the caller
10262 and callee to be in the same 256 megabyte segment.
10263
10264 This option has no effect on abicalls code.  The default is
10265 @option{-mno-long-calls}.
10266
10267 @item -mmad
10268 @itemx -mno-mad
10269 @opindex mmad
10270 @opindex mno-mad
10271 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10272 instructions, as provided by the R4650 ISA@.
10273
10274 @item -mfused-madd
10275 @itemx -mno-fused-madd
10276 @opindex mfused-madd
10277 @opindex mno-fused-madd
10278 Enable (disable) use of the floating point multiply-accumulate
10279 instructions, when they are available.  The default is
10280 @option{-mfused-madd}.
10281
10282 When multiply-accumulate instructions are used, the intermediate
10283 product is calculated to infinite precision and is not subject to
10284 the FCSR Flush to Zero bit.  This may be undesirable in some
10285 circumstances.
10286
10287 @item -nocpp
10288 @opindex nocpp
10289 Tell the MIPS assembler to not run its preprocessor over user
10290 assembler files (with a @samp{.s} suffix) when assembling them.
10291
10292 @item -mfix-r4000
10293 @itemx -mno-fix-r4000
10294 @opindex mfix-r4000
10295 @opindex mno-fix-r4000
10296 Work around certain R4000 CPU errata:
10297 @itemize @minus
10298 @item
10299 A double-word or a variable shift may give an incorrect result if executed
10300 immediately after starting an integer division.
10301 @item
10302 A double-word or a variable shift may give an incorrect result if executed
10303 while an integer multiplication is in progress.
10304 @item
10305 An integer division may give an incorrect result if started in a delay slot
10306 of a taken branch or a jump.
10307 @end itemize
10308
10309 @item -mfix-r4400
10310 @itemx -mno-fix-r4400
10311 @opindex mfix-r4400
10312 @opindex mno-fix-r4400
10313 Work around certain R4400 CPU errata:
10314 @itemize @minus
10315 @item
10316 A double-word or a variable shift may give an incorrect result if executed
10317 immediately after starting an integer division.
10318 @end itemize
10319
10320 @item -mfix-vr4120
10321 @itemx -mno-fix-vr4120
10322 @opindex mfix-vr4120
10323 Work around certain VR4120 errata:
10324 @itemize @minus
10325 @item
10326 @code{dmultu} does not always produce the correct result.
10327 @item
10328 @code{div} and @code{ddiv} do not always produce the correct result if one
10329 of the operands is negative.
10330 @end itemize
10331 The workarounds for the division errata rely on special functions in
10332 @file{libgcc.a}.  At present, these functions are only provided by
10333 the @code{mips64vr*-elf} configurations.
10334
10335 Other VR4120 errata require a nop to be inserted between certain pairs of
10336 instructions.  These errata are handled by the assembler, not by GCC itself.
10337
10338 @item -mfix-vr4130
10339 @opindex mfix-vr4130
10340 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10341 workarounds are implemented by the assembler rather than by GCC,
10342 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10343 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10344 instructions are available instead.
10345
10346 @item -mfix-sb1
10347 @itemx -mno-fix-sb1
10348 @opindex mfix-sb1
10349 Work around certain SB-1 CPU core errata.
10350 (This flag currently works around the SB-1 revision 2
10351 ``F1'' and ``F2'' floating point errata.)
10352
10353 @item -mflush-func=@var{func}
10354 @itemx -mno-flush-func
10355 @opindex mflush-func
10356 Specifies the function to call to flush the I and D caches, or to not
10357 call any such function.  If called, the function must take the same
10358 arguments as the common @code{_flush_func()}, that is, the address of the
10359 memory range for which the cache is being flushed, the size of the
10360 memory range, and the number 3 (to flush both caches).  The default
10361 depends on the target GCC was configured for, but commonly is either
10362 @samp{_flush_func} or @samp{__cpu_flush}.
10363
10364 @item -mbranch-likely
10365 @itemx -mno-branch-likely
10366 @opindex mbranch-likely
10367 @opindex mno-branch-likely
10368 Enable or disable use of Branch Likely instructions, regardless of the
10369 default for the selected architecture.  By default, Branch Likely
10370 instructions may be generated if they are supported by the selected
10371 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10372 and processors which implement those architectures; for those, Branch
10373 Likely instructions will not be generated by default because the MIPS32
10374 and MIPS64 architectures specifically deprecate their use.
10375
10376 @item -mfp-exceptions
10377 @itemx -mno-fp-exceptions
10378 @opindex mfp-exceptions
10379 Specifies whether FP exceptions are enabled.  This affects how we schedule
10380 FP instructions for some processors.  The default is that FP exceptions are
10381 enabled.
10382
10383 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10384 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10385 FP pipe.
10386
10387 @item -mvr4130-align
10388 @itemx -mno-vr4130-align
10389 @opindex mvr4130-align
10390 The VR4130 pipeline is two-way superscalar, but can only issue two
10391 instructions together if the first one is 8-byte aligned.  When this
10392 option is enabled, GCC will align pairs of instructions that it
10393 thinks should execute in parallel.
10394
10395 This option only has an effect when optimizing for the VR4130.
10396 It normally makes code faster, but at the expense of making it bigger.
10397 It is enabled by default at optimization level @option{-O3}.
10398 @end table
10399
10400 @node MMIX Options
10401 @subsection MMIX Options
10402 @cindex MMIX Options
10403
10404 These options are defined for the MMIX:
10405
10406 @table @gcctabopt
10407 @item -mlibfuncs
10408 @itemx -mno-libfuncs
10409 @opindex mlibfuncs
10410 @opindex mno-libfuncs
10411 Specify that intrinsic library functions are being compiled, passing all
10412 values in registers, no matter the size.
10413
10414 @item -mepsilon
10415 @itemx -mno-epsilon
10416 @opindex mepsilon
10417 @opindex mno-epsilon
10418 Generate floating-point comparison instructions that compare with respect
10419 to the @code{rE} epsilon register.
10420
10421 @item -mabi=mmixware
10422 @itemx -mabi=gnu
10423 @opindex mabi-mmixware
10424 @opindex mabi=gnu
10425 Generate code that passes function parameters and return values that (in
10426 the called function) are seen as registers @code{$0} and up, as opposed to
10427 the GNU ABI which uses global registers @code{$231} and up.
10428
10429 @item -mzero-extend
10430 @itemx -mno-zero-extend
10431 @opindex mzero-extend
10432 @opindex mno-zero-extend
10433 When reading data from memory in sizes shorter than 64 bits, use (do not
10434 use) zero-extending load instructions by default, rather than
10435 sign-extending ones.
10436
10437 @item -mknuthdiv
10438 @itemx -mno-knuthdiv
10439 @opindex mknuthdiv
10440 @opindex mno-knuthdiv
10441 Make the result of a division yielding a remainder have the same sign as
10442 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10443 remainder follows the sign of the dividend.  Both methods are
10444 arithmetically valid, the latter being almost exclusively used.
10445
10446 @item -mtoplevel-symbols
10447 @itemx -mno-toplevel-symbols
10448 @opindex mtoplevel-symbols
10449 @opindex mno-toplevel-symbols
10450 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10451 code can be used with the @code{PREFIX} assembly directive.
10452
10453 @item -melf
10454 @opindex melf
10455 Generate an executable in the ELF format, rather than the default
10456 @samp{mmo} format used by the @command{mmix} simulator.
10457
10458 @item -mbranch-predict
10459 @itemx -mno-branch-predict
10460 @opindex mbranch-predict
10461 @opindex mno-branch-predict
10462 Use (do not use) the probable-branch instructions, when static branch
10463 prediction indicates a probable branch.
10464
10465 @item -mbase-addresses
10466 @itemx -mno-base-addresses
10467 @opindex mbase-addresses
10468 @opindex mno-base-addresses
10469 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10470 base address automatically generates a request (handled by the assembler
10471 and the linker) for a constant to be set up in a global register.  The
10472 register is used for one or more base address requests within the range 0
10473 to 255 from the value held in the register.  The generally leads to short
10474 and fast code, but the number of different data items that can be
10475 addressed is limited.  This means that a program that uses lots of static
10476 data may require @option{-mno-base-addresses}.
10477
10478 @item -msingle-exit
10479 @itemx -mno-single-exit
10480 @opindex msingle-exit
10481 @opindex mno-single-exit
10482 Force (do not force) generated code to have a single exit point in each
10483 function.
10484 @end table
10485
10486 @node MN10300 Options
10487 @subsection MN10300 Options
10488 @cindex MN10300 options
10489
10490 These @option{-m} options are defined for Matsushita MN10300 architectures:
10491
10492 @table @gcctabopt
10493 @item -mmult-bug
10494 @opindex mmult-bug
10495 Generate code to avoid bugs in the multiply instructions for the MN10300
10496 processors.  This is the default.
10497
10498 @item -mno-mult-bug
10499 @opindex mno-mult-bug
10500 Do not generate code to avoid bugs in the multiply instructions for the
10501 MN10300 processors.
10502
10503 @item -mam33
10504 @opindex mam33
10505 Generate code which uses features specific to the AM33 processor.
10506
10507 @item -mno-am33
10508 @opindex mno-am33
10509 Do not generate code which uses features specific to the AM33 processor.  This
10510 is the default.
10511
10512 @item -mno-crt0
10513 @opindex mno-crt0
10514 Do not link in the C run-time initialization object file.
10515
10516 @item -mrelax
10517 @opindex mrelax
10518 Indicate to the linker that it should perform a relaxation optimization pass
10519 to shorten branches, calls and absolute memory addresses.  This option only
10520 has an effect when used on the command line for the final link step.
10521
10522 This option makes symbolic debugging impossible.
10523 @end table
10524
10525 @node PDP-11 Options
10526 @subsection PDP-11 Options
10527 @cindex PDP-11 Options
10528
10529 These options are defined for the PDP-11:
10530
10531 @table @gcctabopt
10532 @item -mfpu
10533 @opindex mfpu
10534 Use hardware FPP floating point.  This is the default.  (FIS floating
10535 point on the PDP-11/40 is not supported.)
10536
10537 @item -msoft-float
10538 @opindex msoft-float
10539 Do not use hardware floating point.
10540
10541 @item -mac0
10542 @opindex mac0
10543 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10544
10545 @item -mno-ac0
10546 @opindex mno-ac0
10547 Return floating-point results in memory.  This is the default.
10548
10549 @item -m40
10550 @opindex m40
10551 Generate code for a PDP-11/40.
10552
10553 @item -m45
10554 @opindex m45
10555 Generate code for a PDP-11/45.  This is the default.
10556
10557 @item -m10
10558 @opindex m10
10559 Generate code for a PDP-11/10.
10560
10561 @item -mbcopy-builtin
10562 @opindex bcopy-builtin
10563 Use inline @code{movmemhi} patterns for copying memory.  This is the
10564 default.
10565
10566 @item -mbcopy
10567 @opindex mbcopy
10568 Do not use inline @code{movmemhi} patterns for copying memory.
10569
10570 @item -mint16
10571 @itemx -mno-int32
10572 @opindex mint16
10573 @opindex mno-int32
10574 Use 16-bit @code{int}.  This is the default.
10575
10576 @item -mint32
10577 @itemx -mno-int16
10578 @opindex mint32
10579 @opindex mno-int16
10580 Use 32-bit @code{int}.
10581
10582 @item -mfloat64
10583 @itemx -mno-float32
10584 @opindex mfloat64
10585 @opindex mno-float32
10586 Use 64-bit @code{float}.  This is the default.
10587
10588 @item -mfloat32
10589 @itemx -mno-float64
10590 @opindex mfloat32
10591 @opindex mno-float64
10592 Use 32-bit @code{float}.
10593
10594 @item -mabshi
10595 @opindex mabshi
10596 Use @code{abshi2} pattern.  This is the default.
10597
10598 @item -mno-abshi
10599 @opindex mno-abshi
10600 Do not use @code{abshi2} pattern.
10601
10602 @item -mbranch-expensive
10603 @opindex mbranch-expensive
10604 Pretend that branches are expensive.  This is for experimenting with
10605 code generation only.
10606
10607 @item -mbranch-cheap
10608 @opindex mbranch-cheap
10609 Do not pretend that branches are expensive.  This is the default.
10610
10611 @item -msplit
10612 @opindex msplit
10613 Generate code for a system with split I&D@.
10614
10615 @item -mno-split
10616 @opindex mno-split
10617 Generate code for a system without split I&D@.  This is the default.
10618
10619 @item -munix-asm
10620 @opindex munix-asm
10621 Use Unix assembler syntax.  This is the default when configured for
10622 @samp{pdp11-*-bsd}.
10623
10624 @item -mdec-asm
10625 @opindex mdec-asm
10626 Use DEC assembler syntax.  This is the default when configured for any
10627 PDP-11 target other than @samp{pdp11-*-bsd}.
10628 @end table
10629
10630 @node PowerPC Options
10631 @subsection PowerPC Options
10632 @cindex PowerPC options
10633
10634 These are listed under @xref{RS/6000 and PowerPC Options}.
10635
10636 @node RS/6000 and PowerPC Options
10637 @subsection IBM RS/6000 and PowerPC Options
10638 @cindex RS/6000 and PowerPC Options
10639 @cindex IBM RS/6000 and PowerPC Options
10640
10641 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10642 @table @gcctabopt
10643 @item -mpower
10644 @itemx -mno-power
10645 @itemx -mpower2
10646 @itemx -mno-power2
10647 @itemx -mpowerpc
10648 @itemx -mno-powerpc
10649 @itemx -mpowerpc-gpopt
10650 @itemx -mno-powerpc-gpopt
10651 @itemx -mpowerpc-gfxopt
10652 @itemx -mno-powerpc-gfxopt
10653 @itemx -mpowerpc64
10654 @itemx -mno-powerpc64
10655 @opindex mpower
10656 @opindex mno-power
10657 @opindex mpower2
10658 @opindex mno-power2
10659 @opindex mpowerpc
10660 @opindex mno-powerpc
10661 @opindex mpowerpc-gpopt
10662 @opindex mno-powerpc-gpopt
10663 @opindex mpowerpc-gfxopt
10664 @opindex mno-powerpc-gfxopt
10665 @opindex mpowerpc64
10666 @opindex mno-powerpc64
10667 GCC supports two related instruction set architectures for the
10668 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10669 instructions supported by the @samp{rios} chip set used in the original
10670 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10671 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10672 the IBM 4xx microprocessors.
10673
10674 Neither architecture is a subset of the other.  However there is a
10675 large common subset of instructions supported by both.  An MQ
10676 register is included in processors supporting the POWER architecture.
10677
10678 You use these options to specify which instructions are available on the
10679 processor you are using.  The default value of these options is
10680 determined when configuring GCC@.  Specifying the
10681 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10682 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10683 rather than the options listed above.
10684
10685 The @option{-mpower} option allows GCC to generate instructions that
10686 are found only in the POWER architecture and to use the MQ register.
10687 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10688 to generate instructions that are present in the POWER2 architecture but
10689 not the original POWER architecture.
10690
10691 The @option{-mpowerpc} option allows GCC to generate instructions that
10692 are found only in the 32-bit subset of the PowerPC architecture.
10693 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10694 GCC to use the optional PowerPC architecture instructions in the
10695 General Purpose group, including floating-point square root.  Specifying
10696 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10697 use the optional PowerPC architecture instructions in the Graphics
10698 group, including floating-point select.
10699
10700 The @option{-mpowerpc64} option allows GCC to generate the additional
10701 64-bit instructions that are found in the full PowerPC64 architecture
10702 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10703 @option{-mno-powerpc64}.
10704
10705 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10706 will use only the instructions in the common subset of both
10707 architectures plus some special AIX common-mode calls, and will not use
10708 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10709 permits GCC to use any instruction from either architecture and to
10710 allow use of the MQ register; specify this for the Motorola MPC601.
10711
10712 @item -mnew-mnemonics
10713 @itemx -mold-mnemonics
10714 @opindex mnew-mnemonics
10715 @opindex mold-mnemonics
10716 Select which mnemonics to use in the generated assembler code.  With
10717 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10718 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10719 assembler mnemonics defined for the POWER architecture.  Instructions
10720 defined in only one architecture have only one mnemonic; GCC uses that
10721 mnemonic irrespective of which of these options is specified.
10722
10723 GCC defaults to the mnemonics appropriate for the architecture in
10724 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10725 value of these option.  Unless you are building a cross-compiler, you
10726 should normally not specify either @option{-mnew-mnemonics} or
10727 @option{-mold-mnemonics}, but should instead accept the default.
10728
10729 @item -mcpu=@var{cpu_type}
10730 @opindex mcpu
10731 Set architecture type, register usage, choice of mnemonics, and
10732 instruction scheduling parameters for machine type @var{cpu_type}.
10733 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10734 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10735 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10736 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10737 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10738 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10739 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10740 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10741 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10742
10743 @option{-mcpu=common} selects a completely generic processor.  Code
10744 generated under this option will run on any POWER or PowerPC processor.
10745 GCC will use only the instructions in the common subset of both
10746 architectures, and will not use the MQ register.  GCC assumes a generic
10747 processor model for scheduling purposes.
10748
10749 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10750 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10751 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10752 types, with an appropriate, generic processor model assumed for
10753 scheduling purposes.
10754
10755 The other options specify a specific processor.  Code generated under
10756 those options will run best on that processor, and may not run at all on
10757 others.
10758
10759 The @option{-mcpu} options automatically enable or disable the
10760 following options: @option{-maltivec}, @option{-mhard-float},
10761 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10762 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10763 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10764 @option{-mstring}.  The particular options set for any particular CPU
10765 will vary between compiler versions, depending on what setting seems
10766 to produce optimal code for that CPU; it doesn't necessarily reflect
10767 the actual hardware's capabilities.  If you wish to set an individual
10768 option to a particular value, you may specify it after the
10769 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10770
10771 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10772 not enabled or disabled by the @option{-mcpu} option at present, since
10773 AIX does not have full support for these options.  You may still
10774 enable or disable them individually if you're sure it'll work in your
10775 environment.
10776
10777 @item -mtune=@var{cpu_type}
10778 @opindex mtune
10779 Set the instruction scheduling parameters for machine type
10780 @var{cpu_type}, but do not set the architecture type, register usage, or
10781 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10782 values for @var{cpu_type} are used for @option{-mtune} as for
10783 @option{-mcpu}.  If both are specified, the code generated will use the
10784 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10785 scheduling parameters set by @option{-mtune}.
10786
10787 @item -mswdiv
10788 @itemx -mno-swdiv
10789 @opindex mswdiv
10790 @opindex mno-swdiv
10791 Generate code to compute division as reciprocal estimate and iterative
10792 refinement, creating opportunities for increased throughput.  This
10793 feature requires: optional PowerPC Graphics instruction set for single
10794 precision and FRE instruction for double precision, assuming divides
10795 cannot generate user-visible traps, and the domain values not include
10796 Infinities, denormals or zero denominator.
10797
10798 @item -maltivec
10799 @itemx -mno-altivec
10800 @opindex maltivec
10801 @opindex mno-altivec
10802 Generate code that uses (does not use) AltiVec instructions, and also
10803 enable the use of built-in functions that allow more direct access to
10804 the AltiVec instruction set.  You may also need to set
10805 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10806 enhancements.
10807
10808 @item -mvrsave
10809 @item -mno-vrsave
10810 @opindex mvrsave
10811 @opindex mno-vrsave
10812 Generate VRSAVE instructions when generating AltiVec code.
10813
10814 @item -mabi=spe
10815 @opindex mabi=spe
10816 Extend the current ABI with SPE ABI extensions.  This does not change
10817 the default ABI, instead it adds the SPE ABI extensions to the current
10818 ABI@.
10819
10820 @item -mabi=no-spe
10821 @opindex mabi=no-spe
10822 Disable Booke SPE ABI extensions for the current ABI@.
10823
10824 @item -msecure-plt
10825 @opindex msecure-plt
10826 Generate code that allows ld and ld.so to build executables and shared
10827 libraries with non-exec .plt and .got sections.  This is a PowerPC
10828 32-bit SYSV ABI option.
10829
10830 @item -mbss-plt
10831 @opindex mbss-plt
10832 Generate code that uses a BSS .plt section that ld.so fills in, and
10833 requires .plt and .got sections that are both writable and executable.
10834 This is a PowerPC 32-bit SYSV ABI option.
10835
10836 @item -misel
10837 @itemx -mno-isel
10838 @opindex misel
10839 @opindex mno-isel
10840 This switch enables or disables the generation of ISEL instructions.
10841
10842 @item -misel=@var{yes/no}
10843 This switch has been deprecated.  Use @option{-misel} and
10844 @option{-mno-isel} instead.
10845
10846 @item -mspe
10847 @itemx -mno-isel
10848 @opindex mspe
10849 @opindex mno-spe
10850 This switch enables or disables the generation of SPE simd
10851 instructions.
10852
10853 @item -mspe=@var{yes/no}
10854 This option has been deprecated.  Use @option{-mspe} and
10855 @option{-mno-spe} instead.
10856
10857 @item -mfloat-gprs=@var{yes/single/double/no}
10858 @itemx -mfloat-gprs
10859 @opindex mfloat-gprs
10860 This switch enables or disables the generation of floating point
10861 operations on the general purpose registers for architectures that
10862 support it.
10863
10864 The argument @var{yes} or @var{single} enables the use of
10865 single-precision floating point operations.
10866
10867 The argument @var{double} enables the use of single and
10868 double-precision floating point operations.
10869
10870 The argument @var{no} disables floating point operations on the
10871 general purpose registers.
10872
10873 This option is currently only available on the MPC854x.
10874
10875 @item -m32
10876 @itemx -m64
10877 @opindex m32
10878 @opindex m64
10879 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10880 targets (including GNU/Linux).  The 32-bit environment sets int, long
10881 and pointer to 32 bits and generates code that runs on any PowerPC
10882 variant.  The 64-bit environment sets int to 32 bits and long and
10883 pointer to 64 bits, and generates code for PowerPC64, as for
10884 @option{-mpowerpc64}.
10885
10886 @item -mfull-toc
10887 @itemx -mno-fp-in-toc
10888 @itemx -mno-sum-in-toc
10889 @itemx -mminimal-toc
10890 @opindex mfull-toc
10891 @opindex mno-fp-in-toc
10892 @opindex mno-sum-in-toc
10893 @opindex mminimal-toc
10894 Modify generation of the TOC (Table Of Contents), which is created for
10895 every executable file.  The @option{-mfull-toc} option is selected by
10896 default.  In that case, GCC will allocate at least one TOC entry for
10897 each unique non-automatic variable reference in your program.  GCC
10898 will also place floating-point constants in the TOC@.  However, only
10899 16,384 entries are available in the TOC@.
10900
10901 If you receive a linker error message that saying you have overflowed
10902 the available TOC space, you can reduce the amount of TOC space used
10903 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10904 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10905 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10906 generate code to calculate the sum of an address and a constant at
10907 run-time instead of putting that sum into the TOC@.  You may specify one
10908 or both of these options.  Each causes GCC to produce very slightly
10909 slower and larger code at the expense of conserving TOC space.
10910
10911 If you still run out of space in the TOC even when you specify both of
10912 these options, specify @option{-mminimal-toc} instead.  This option causes
10913 GCC to make only one TOC entry for every file.  When you specify this
10914 option, GCC will produce code that is slower and larger but which
10915 uses extremely little TOC space.  You may wish to use this option
10916 only on files that contain less frequently executed code.
10917
10918 @item -maix64
10919 @itemx -maix32
10920 @opindex maix64
10921 @opindex maix32
10922 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10923 @code{long} type, and the infrastructure needed to support them.
10924 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10925 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10926 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10927
10928 @item -mxl-compat
10929 @itemx -mno-xl-compat
10930 @opindex mxl-compat
10931 @opindex mno-xl-compat
10932 Produce code that conforms more closely to IBM XLC semantics when using
10933 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10934 functions beyond the register save area (RSA) on the stack in addition
10935 to argument FPRs.  Do not assume that most significant double in 128
10936 bit long double value is properly rounded when comparing values.
10937
10938 The AIX calling convention was extended but not initially documented to
10939 handle an obscure K&R C case of calling a function that takes the
10940 address of its arguments with fewer arguments than declared.  AIX XL
10941 compilers access floating point arguments which do not fit in the
10942 RSA from the stack when a subroutine is compiled without
10943 optimization.  Because always storing floating-point arguments on the
10944 stack is inefficient and rarely needed, this option is not enabled by
10945 default and only is necessary when calling subroutines compiled by AIX
10946 XL compilers without optimization.
10947
10948 @item -mpe
10949 @opindex mpe
10950 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10951 application written to use message passing with special startup code to
10952 enable the application to run.  The system must have PE installed in the
10953 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10954 must be overridden with the @option{-specs=} option to specify the
10955 appropriate directory location.  The Parallel Environment does not
10956 support threads, so the @option{-mpe} option and the @option{-pthread}
10957 option are incompatible.
10958
10959 @item -malign-natural
10960 @itemx -malign-power
10961 @opindex malign-natural
10962 @opindex malign-power
10963 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10964 @option{-malign-natural} overrides the ABI-defined alignment of larger
10965 types, such as floating-point doubles, on their natural size-based boundary.
10966 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10967 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10968
10969 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10970 is not supported.
10971
10972 @item -msoft-float
10973 @itemx -mhard-float
10974 @opindex msoft-float
10975 @opindex mhard-float
10976 Generate code that does not use (uses) the floating-point register set.
10977 Software floating point emulation is provided if you use the
10978 @option{-msoft-float} option, and pass the option to GCC when linking.
10979
10980 @item -mmultiple
10981 @itemx -mno-multiple
10982 @opindex mmultiple
10983 @opindex mno-multiple
10984 Generate code that uses (does not use) the load multiple word
10985 instructions and the store multiple word instructions.  These
10986 instructions are generated by default on POWER systems, and not
10987 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10988 endian PowerPC systems, since those instructions do not work when the
10989 processor is in little endian mode.  The exceptions are PPC740 and
10990 PPC750 which permit the instructions usage in little endian mode.
10991
10992 @item -mstring
10993 @itemx -mno-string
10994 @opindex mstring
10995 @opindex mno-string
10996 Generate code that uses (does not use) the load string instructions
10997 and the store string word instructions to save multiple registers and
10998 do small block moves.  These instructions are generated by default on
10999 POWER systems, and not generated on PowerPC systems.  Do not use
11000 @option{-mstring} on little endian PowerPC systems, since those
11001 instructions do not work when the processor is in little endian mode.
11002 The exceptions are PPC740 and PPC750 which permit the instructions
11003 usage in little endian mode.
11004
11005 @item -mupdate
11006 @itemx -mno-update
11007 @opindex mupdate
11008 @opindex mno-update
11009 Generate code that uses (does not use) the load or store instructions
11010 that update the base register to the address of the calculated memory
11011 location.  These instructions are generated by default.  If you use
11012 @option{-mno-update}, there is a small window between the time that the
11013 stack pointer is updated and the address of the previous frame is
11014 stored, which means code that walks the stack frame across interrupts or
11015 signals may get corrupted data.
11016
11017 @item -mfused-madd
11018 @itemx -mno-fused-madd
11019 @opindex mfused-madd
11020 @opindex mno-fused-madd
11021 Generate code that uses (does not use) the floating point multiply and
11022 accumulate instructions.  These instructions are generated by default if
11023 hardware floating is used.
11024
11025 @item -mno-bit-align
11026 @itemx -mbit-align
11027 @opindex mno-bit-align
11028 @opindex mbit-align
11029 On System V.4 and embedded PowerPC systems do not (do) force structures
11030 and unions that contain bit-fields to be aligned to the base type of the
11031 bit-field.
11032
11033 For example, by default a structure containing nothing but 8
11034 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11035 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11036 the structure would be aligned to a 1 byte boundary and be one byte in
11037 size.
11038
11039 @item -mno-strict-align
11040 @itemx -mstrict-align
11041 @opindex mno-strict-align
11042 @opindex mstrict-align
11043 On System V.4 and embedded PowerPC systems do not (do) assume that
11044 unaligned memory references will be handled by the system.
11045
11046 @item -mrelocatable
11047 @itemx -mno-relocatable
11048 @opindex mrelocatable
11049 @opindex mno-relocatable
11050 On embedded PowerPC systems generate code that allows (does not allow)
11051 the program to be relocated to a different address at runtime.  If you
11052 use @option{-mrelocatable} on any module, all objects linked together must
11053 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11054
11055 @item -mrelocatable-lib
11056 @itemx -mno-relocatable-lib
11057 @opindex mrelocatable-lib
11058 @opindex mno-relocatable-lib
11059 On embedded PowerPC systems generate code that allows (does not allow)
11060 the program to be relocated to a different address at runtime.  Modules
11061 compiled with @option{-mrelocatable-lib} can be linked with either modules
11062 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11063 with modules compiled with the @option{-mrelocatable} options.
11064
11065 @item -mno-toc
11066 @itemx -mtoc
11067 @opindex mno-toc
11068 @opindex mtoc
11069 On System V.4 and embedded PowerPC systems do not (do) assume that
11070 register 2 contains a pointer to a global area pointing to the addresses
11071 used in the program.
11072
11073 @item -mlittle
11074 @itemx -mlittle-endian
11075 @opindex mlittle
11076 @opindex mlittle-endian
11077 On System V.4 and embedded PowerPC systems compile code for the
11078 processor in little endian mode.  The @option{-mlittle-endian} option is
11079 the same as @option{-mlittle}.
11080
11081 @item -mbig
11082 @itemx -mbig-endian
11083 @opindex mbig
11084 @opindex mbig-endian
11085 On System V.4 and embedded PowerPC systems compile code for the
11086 processor in big endian mode.  The @option{-mbig-endian} option is
11087 the same as @option{-mbig}.
11088
11089 @item -mdynamic-no-pic
11090 @opindex mdynamic-no-pic
11091 On Darwin and Mac OS X systems, compile code so that it is not
11092 relocatable, but that its external references are relocatable.  The
11093 resulting code is suitable for applications, but not shared
11094 libraries.
11095
11096 @item -mprioritize-restricted-insns=@var{priority}
11097 @opindex mprioritize-restricted-insns
11098 This option controls the priority that is assigned to
11099 dispatch-slot restricted instructions during the second scheduling
11100 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11101 @var{no/highest/second-highest} priority to dispatch slot restricted
11102 instructions.
11103
11104 @item -msched-costly-dep=@var{dependence_type}
11105 @opindex msched-costly-dep
11106 This option controls which dependences are considered costly
11107 by the target during instruction scheduling.  The argument
11108 @var{dependence_type} takes one of the following values:
11109 @var{no}: no dependence is costly,
11110 @var{all}: all dependences are costly,
11111 @var{true_store_to_load}: a true dependence from store to load is costly,
11112 @var{store_to_load}: any dependence from store to load is costly,
11113 @var{number}: any dependence which latency >= @var{number} is costly.
11114
11115 @item -minsert-sched-nops=@var{scheme}
11116 @opindex minsert-sched-nops
11117 This option controls which nop insertion scheme will be used during
11118 the second scheduling pass.  The argument @var{scheme} takes one of the
11119 following values:
11120 @var{no}: Don't insert nops.
11121 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11122 according to the scheduler's grouping.
11123 @var{regroup_exact}: Insert nops to force costly dependent insns into
11124 separate groups.  Insert exactly as many nops as needed to force an insn
11125 to a new group, according to the estimated processor grouping.
11126 @var{number}: Insert nops to force costly dependent insns into
11127 separate groups.  Insert @var{number} nops to force an insn to a new group.
11128
11129 @item -mcall-sysv
11130 @opindex mcall-sysv
11131 On System V.4 and embedded PowerPC systems compile code using calling
11132 conventions that adheres to the March 1995 draft of the System V
11133 Application Binary Interface, PowerPC processor supplement.  This is the
11134 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11135
11136 @item -mcall-sysv-eabi
11137 @opindex mcall-sysv-eabi
11138 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11139
11140 @item -mcall-sysv-noeabi
11141 @opindex mcall-sysv-noeabi
11142 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11143
11144 @item -mcall-solaris
11145 @opindex mcall-solaris
11146 On System V.4 and embedded PowerPC systems compile code for the Solaris
11147 operating system.
11148
11149 @item -mcall-linux
11150 @opindex mcall-linux
11151 On System V.4 and embedded PowerPC systems compile code for the
11152 Linux-based GNU system.
11153
11154 @item -mcall-gnu
11155 @opindex mcall-gnu
11156 On System V.4 and embedded PowerPC systems compile code for the
11157 Hurd-based GNU system.
11158
11159 @item -mcall-netbsd
11160 @opindex mcall-netbsd
11161 On System V.4 and embedded PowerPC systems compile code for the
11162 NetBSD operating system.
11163
11164 @item -maix-struct-return
11165 @opindex maix-struct-return
11166 Return all structures in memory (as specified by the AIX ABI)@.
11167
11168 @item -msvr4-struct-return
11169 @opindex msvr4-struct-return
11170 Return structures smaller than 8 bytes in registers (as specified by the
11171 SVR4 ABI)@.
11172
11173 @item -mabi=@var{abi-type}
11174 @opindex mabi
11175 Extend the current ABI with a particular extension, or remove such extension.
11176 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11177 @var{no-spe}@.
11178
11179 @item -mprototype
11180 @itemx -mno-prototype
11181 @opindex mprototype
11182 @opindex mno-prototype
11183 On System V.4 and embedded PowerPC systems assume that all calls to
11184 variable argument functions are properly prototyped.  Otherwise, the
11185 compiler must insert an instruction before every non prototyped call to
11186 set or clear bit 6 of the condition code register (@var{CR}) to
11187 indicate whether floating point values were passed in the floating point
11188 registers in case the function takes a variable arguments.  With
11189 @option{-mprototype}, only calls to prototyped variable argument functions
11190 will set or clear the bit.
11191
11192 @item -msim
11193 @opindex msim
11194 On embedded PowerPC systems, assume that the startup module is called
11195 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11196 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11197 configurations.
11198
11199 @item -mmvme
11200 @opindex mmvme
11201 On embedded PowerPC systems, assume that the startup module is called
11202 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11203 @file{libc.a}.
11204
11205 @item -mads
11206 @opindex mads
11207 On embedded PowerPC systems, assume that the startup module is called
11208 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11209 @file{libc.a}.
11210
11211 @item -myellowknife
11212 @opindex myellowknife
11213 On embedded PowerPC systems, assume that the startup module is called
11214 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11215 @file{libc.a}.
11216
11217 @item -mvxworks
11218 @opindex mvxworks
11219 On System V.4 and embedded PowerPC systems, specify that you are
11220 compiling for a VxWorks system.
11221
11222 @item -mwindiss
11223 @opindex mwindiss
11224 Specify that you are compiling for the WindISS simulation environment.
11225
11226 @item -memb
11227 @opindex memb
11228 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11229 header to indicate that @samp{eabi} extended relocations are used.
11230
11231 @item -meabi
11232 @itemx -mno-eabi
11233 @opindex meabi
11234 @opindex mno-eabi
11235 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11236 Embedded Applications Binary Interface (eabi) which is a set of
11237 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11238 means that the stack is aligned to an 8 byte boundary, a function
11239 @code{__eabi} is called to from @code{main} to set up the eabi
11240 environment, and the @option{-msdata} option can use both @code{r2} and
11241 @code{r13} to point to two separate small data areas.  Selecting
11242 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11243 do not call an initialization function from @code{main}, and the
11244 @option{-msdata} option will only use @code{r13} to point to a single
11245 small data area.  The @option{-meabi} option is on by default if you
11246 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11247
11248 @item -msdata=eabi
11249 @opindex msdata=eabi
11250 On System V.4 and embedded PowerPC systems, put small initialized
11251 @code{const} global and static data in the @samp{.sdata2} section, which
11252 is pointed to by register @code{r2}.  Put small initialized
11253 non-@code{const} global and static data in the @samp{.sdata} section,
11254 which is pointed to by register @code{r13}.  Put small uninitialized
11255 global and static data in the @samp{.sbss} section, which is adjacent to
11256 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11257 incompatible with the @option{-mrelocatable} option.  The
11258 @option{-msdata=eabi} option also sets the @option{-memb} option.
11259
11260 @item -msdata=sysv
11261 @opindex msdata=sysv
11262 On System V.4 and embedded PowerPC systems, put small global and static
11263 data in the @samp{.sdata} section, which is pointed to by register
11264 @code{r13}.  Put small uninitialized global and static data in the
11265 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11266 The @option{-msdata=sysv} option is incompatible with the
11267 @option{-mrelocatable} option.
11268
11269 @item -msdata=default
11270 @itemx -msdata
11271 @opindex msdata=default
11272 @opindex msdata
11273 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11274 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11275 same as @option{-msdata=sysv}.
11276
11277 @item -msdata-data
11278 @opindex msdata-data
11279 On System V.4 and embedded PowerPC systems, put small global and static
11280 data in the @samp{.sdata} section.  Put small uninitialized global and
11281 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11282 to address small data however.  This is the default behavior unless
11283 other @option{-msdata} options are used.
11284
11285 @item -msdata=none
11286 @itemx -mno-sdata
11287 @opindex msdata=none
11288 @opindex mno-sdata
11289 On embedded PowerPC systems, put all initialized global and static data
11290 in the @samp{.data} section, and all uninitialized data in the
11291 @samp{.bss} section.
11292
11293 @item -G @var{num}
11294 @opindex G
11295 @cindex smaller data references (PowerPC)
11296 @cindex .sdata/.sdata2 references (PowerPC)
11297 On embedded PowerPC systems, put global and static items less than or
11298 equal to @var{num} bytes into the small data or bss sections instead of
11299 the normal data or bss section.  By default, @var{num} is 8.  The
11300 @option{-G @var{num}} switch is also passed to the linker.
11301 All modules should be compiled with the same @option{-G @var{num}} value.
11302
11303 @item -mregnames
11304 @itemx -mno-regnames
11305 @opindex mregnames
11306 @opindex mno-regnames
11307 On System V.4 and embedded PowerPC systems do (do not) emit register
11308 names in the assembly language output using symbolic forms.
11309
11310 @item -mlongcall
11311 @itemx -mno-longcall
11312 @opindex mlongcall
11313 @opindex mno-longcall
11314 Default to making all function calls indirectly, using a register, so
11315 that functions which reside further than 32 megabytes (33,554,432
11316 bytes) from the current location can be called.  This setting can be
11317 overridden by the @code{shortcall} function attribute, or by
11318 @code{#pragma longcall(0)}.
11319
11320 Some linkers are capable of detecting out-of-range calls and generating
11321 glue code on the fly.  On these systems, long calls are unnecessary and
11322 generate slower code.  As of this writing, the AIX linker can do this,
11323 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11324 to the GNU linker for 32-bit PowerPC systems as well.
11325
11326 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11327 callee, L42'', plus a ``branch island'' (glue code).  The two target
11328 addresses represent the callee and the ``branch island''.  The
11329 Darwin/PPC linker will prefer the first address and generate a ``bl
11330 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11331 otherwise, the linker will generate ``bl L42'' to call the ``branch
11332 island''.  The ``branch island'' is appended to the body of the
11333 calling function; it computes the full 32-bit address of the callee
11334 and jumps to it.
11335
11336 On Mach-O (Darwin) systems, this option directs the compiler emit to
11337 the glue for every direct call, and the Darwin linker decides whether
11338 to use or discard it.
11339
11340 In the future, we may cause GCC to ignore all longcall specifications
11341 when the linker is known to generate glue.
11342
11343 @item -pthread
11344 @opindex pthread
11345 Adds support for multithreading with the @dfn{pthreads} library.
11346 This option sets flags for both the preprocessor and linker.
11347
11348 @end table
11349
11350 @node S/390 and zSeries Options
11351 @subsection S/390 and zSeries Options
11352 @cindex S/390 and zSeries Options
11353
11354 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11355
11356 @table @gcctabopt
11357 @item -mhard-float
11358 @itemx -msoft-float
11359 @opindex mhard-float
11360 @opindex msoft-float
11361 Use (do not use) the hardware floating-point instructions and registers
11362 for floating-point operations.  When @option{-msoft-float} is specified,
11363 functions in @file{libgcc.a} will be used to perform floating-point
11364 operations.  When @option{-mhard-float} is specified, the compiler
11365 generates IEEE floating-point instructions.  This is the default.
11366
11367 @item -mbackchain
11368 @itemx -mno-backchain
11369 @opindex mbackchain
11370 @opindex mno-backchain
11371 Store (do not store) the address of the caller's frame as backchain pointer
11372 into the callee's stack frame.
11373 A backchain may be needed to allow debugging using tools that do not understand
11374 DWARF-2 call frame information.
11375 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11376 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11377 the backchain is placed into the topmost word of the 96/160 byte register
11378 save area.
11379
11380 In general, code compiled with @option{-mbackchain} is call-compatible with
11381 code compiled with @option{-mmo-backchain}; however, use of the backchain
11382 for debugging purposes usually requires that the whole binary is built with
11383 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11384 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11385 to build a linux kernel use @option{-msoft-float}.
11386
11387 The default is to not maintain the backchain.
11388
11389 @item -mpacked-stack
11390 @item -mno-packed-stack
11391 @opindex mpacked-stack
11392 @opindex mno-packed-stack
11393 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11394 specified, the compiler uses the all fields of the 96/160 byte register save
11395 area only for their default purpose; unused fields still take up stack space.
11396 When @option{-mpacked-stack} is specified, register save slots are densely
11397 packed at the top of the register save area; unused space is reused for other
11398 purposes, allowing for more efficient use of the available stack space.
11399 However, when @option{-mbackchain} is also in effect, the topmost word of
11400 the save area is always used to store the backchain, and the return address
11401 register is always saved two words below the backchain.
11402
11403 As long as the stack frame backchain is not used, code generated with
11404 @option{-mpacked-stack} is call-compatible with code generated with
11405 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11406 S/390 or zSeries generated code that uses the stack frame backchain at run
11407 time, not just for debugging purposes.  Such code is not call-compatible
11408 with code compiled with @option{-mpacked-stack}.  Also, note that the
11409 combination of @option{-mbackchain},
11410 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11411 to build a linux kernel use @option{-msoft-float}.
11412
11413 The default is to not use the packed stack layout.
11414
11415 @item -msmall-exec
11416 @itemx -mno-small-exec
11417 @opindex msmall-exec
11418 @opindex mno-small-exec
11419 Generate (or do not generate) code using the @code{bras} instruction
11420 to do subroutine calls.
11421 This only works reliably if the total executable size does not
11422 exceed 64k.  The default is to use the @code{basr} instruction instead,
11423 which does not have this limitation.
11424
11425 @item -m64
11426 @itemx -m31
11427 @opindex m64
11428 @opindex m31
11429 When @option{-m31} is specified, generate code compliant to the
11430 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11431 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11432 particular to generate 64-bit instructions.  For the @samp{s390}
11433 targets, the default is @option{-m31}, while the @samp{s390x}
11434 targets default to @option{-m64}.
11435
11436 @item -mzarch
11437 @itemx -mesa
11438 @opindex mzarch
11439 @opindex mesa
11440 When @option{-mzarch} is specified, generate code using the
11441 instructions available on z/Architecture.
11442 When @option{-mesa} is specified, generate code using the
11443 instructions available on ESA/390.  Note that @option{-mesa} is
11444 not possible with @option{-m64}.
11445 When generating code compliant to the GNU/Linux for S/390 ABI,
11446 the default is @option{-mesa}.  When generating code compliant
11447 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11448
11449 @item -mmvcle
11450 @itemx -mno-mvcle
11451 @opindex mmvcle
11452 @opindex mno-mvcle
11453 Generate (or do not generate) code using the @code{mvcle} instruction
11454 to perform block moves.  When @option{-mno-mvcle} is specified,
11455 use a @code{mvc} loop instead.  This is the default unless optimizing for
11456 size.
11457
11458 @item -mdebug
11459 @itemx -mno-debug
11460 @opindex mdebug
11461 @opindex mno-debug
11462 Print (or do not print) additional debug information when compiling.
11463 The default is to not print debug information.
11464
11465 @item -march=@var{cpu-type}
11466 @opindex march
11467 Generate code that will run on @var{cpu-type}, which is the name of a system
11468 representing a certain processor type.  Possible values for
11469 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11470 When generating code using the instructions available on z/Architecture,
11471 the default is @option{-march=z900}.  Otherwise, the default is
11472 @option{-march=g5}.
11473
11474 @item -mtune=@var{cpu-type}
11475 @opindex mtune
11476 Tune to @var{cpu-type} everything applicable about the generated code,
11477 except for the ABI and the set of available instructions.
11478 The list of @var{cpu-type} values is the same as for @option{-march}.
11479 The default is the value used for @option{-march}.
11480
11481 @item -mtpf-trace
11482 @itemx -mno-tpf-trace
11483 @opindex mtpf-trace
11484 @opindex mno-tpf-trace
11485 Generate code that adds (does not add) in TPF OS specific branches to trace
11486 routines in the operating system.  This option is off by default, even
11487 when compiling for the TPF OS@.
11488
11489 @item -mfused-madd
11490 @itemx -mno-fused-madd
11491 @opindex mfused-madd
11492 @opindex mno-fused-madd
11493 Generate code that uses (does not use) the floating point multiply and
11494 accumulate instructions.  These instructions are generated by default if
11495 hardware floating point is used.
11496
11497 @item -mwarn-framesize=@var{framesize}
11498 @opindex mwarn-framesize
11499 Emit a warning if the current function exceeds the given frame size.  Because
11500 this is a compile time check it doesn't need to be a real problem when the program
11501 runs.  It is intended to identify functions which most probably cause
11502 a stack overflow.  It is useful to be used in an environment with limited stack
11503 size e.g.@: the linux kernel.
11504
11505 @item -mwarn-dynamicstack
11506 @opindex mwarn-dynamicstack
11507 Emit a warning if the function calls alloca or uses dynamically
11508 sized arrays.  This is generally a bad idea with a limited stack size.
11509
11510 @item -mstack-guard=@var{stack-guard}
11511 @item -mstack-size=@var{stack-size}
11512 @opindex mstack-guard
11513 @opindex mstack-size
11514 These arguments always have to be used in conjunction.  If they are present the s390
11515 back end emits additional instructions in the function prologue which trigger a trap
11516 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11517 (remember that the stack on s390 grows downward).  These options are intended to
11518 be used to help debugging stack overflow problems.  The additionally emitted code
11519 cause only little overhead and hence can also be used in production like systems
11520 without greater performance degradation.  The given values have to be exact
11521 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11522 In order to be efficient the extra code makes the assumption that the stack starts
11523 at an address aligned to the value given by @var{stack-size}.
11524 @end table
11525
11526 @node SH Options
11527 @subsection SH Options
11528
11529 These @samp{-m} options are defined for the SH implementations:
11530
11531 @table @gcctabopt
11532 @item -m1
11533 @opindex m1
11534 Generate code for the SH1.
11535
11536 @item -m2
11537 @opindex m2
11538 Generate code for the SH2.
11539
11540 @item -m2e
11541 Generate code for the SH2e.
11542
11543 @item -m3
11544 @opindex m3
11545 Generate code for the SH3.
11546
11547 @item -m3e
11548 @opindex m3e
11549 Generate code for the SH3e.
11550
11551 @item -m4-nofpu
11552 @opindex m4-nofpu
11553 Generate code for the SH4 without a floating-point unit.
11554
11555 @item -m4-single-only
11556 @opindex m4-single-only
11557 Generate code for the SH4 with a floating-point unit that only
11558 supports single-precision arithmetic.
11559
11560 @item -m4-single
11561 @opindex m4-single
11562 Generate code for the SH4 assuming the floating-point unit is in
11563 single-precision mode by default.
11564
11565 @item -m4
11566 @opindex m4
11567 Generate code for the SH4.
11568
11569 @item -m4a-nofpu
11570 @opindex m4a-nofpu
11571 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11572 floating-point unit is not used.
11573
11574 @item -m4a-single-only
11575 @opindex m4a-single-only
11576 Generate code for the SH4a, in such a way that no double-precision
11577 floating point operations are used.
11578
11579 @item -m4a-single
11580 @opindex m4a-single
11581 Generate code for the SH4a assuming the floating-point unit is in
11582 single-precision mode by default.
11583
11584 @item -m4a
11585 @opindex m4a
11586 Generate code for the SH4a.
11587
11588 @item -m4al
11589 @opindex m4al
11590 Same as @option{-m4a-nofpu}, except that it implicitly passes
11591 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11592 instructions at the moment.
11593
11594 @item -mb
11595 @opindex mb
11596 Compile code for the processor in big endian mode.
11597
11598 @item -ml
11599 @opindex ml
11600 Compile code for the processor in little endian mode.
11601
11602 @item -mdalign
11603 @opindex mdalign
11604 Align doubles at 64-bit boundaries.  Note that this changes the calling
11605 conventions, and thus some functions from the standard C library will
11606 not work unless you recompile it first with @option{-mdalign}.
11607
11608 @item -mrelax
11609 @opindex mrelax
11610 Shorten some address references at link time, when possible; uses the
11611 linker option @option{-relax}.
11612
11613 @item -mbigtable
11614 @opindex mbigtable
11615 Use 32-bit offsets in @code{switch} tables.  The default is to use
11616 16-bit offsets.
11617
11618 @item -mfmovd
11619 @opindex mfmovd
11620 Enable the use of the instruction @code{fmovd}.
11621
11622 @item -mhitachi
11623 @opindex mhitachi
11624 Comply with the calling conventions defined by Renesas.
11625
11626 @item -mrenesas
11627 @opindex mhitachi
11628 Comply with the calling conventions defined by Renesas.
11629
11630 @item -mno-renesas
11631 @opindex mhitachi
11632 Comply with the calling conventions defined for GCC before the Renesas
11633 conventions were available.  This option is the default for all
11634 targets of the SH toolchain except for @samp{sh-symbianelf}.
11635
11636 @item -mnomacsave
11637 @opindex mnomacsave
11638 Mark the @code{MAC} register as call-clobbered, even if
11639 @option{-mhitachi} is given.
11640
11641 @item -mieee
11642 @opindex mieee
11643 Increase IEEE-compliance of floating-point code.
11644 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11645 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11646 comparisons of NANs / infinities incurs extra overhead in every
11647 floating point comparison, therefore the default is set to
11648 @option{-ffinite-math-only}.
11649
11650 @item -misize
11651 @opindex misize
11652 Dump instruction size and location in the assembly code.
11653
11654 @item -mpadstruct
11655 @opindex mpadstruct
11656 This option is deprecated.  It pads structures to multiple of 4 bytes,
11657 which is incompatible with the SH ABI@.
11658
11659 @item -mspace
11660 @opindex mspace
11661 Optimize for space instead of speed.  Implied by @option{-Os}.
11662
11663 @item -mprefergot
11664 @opindex mprefergot
11665 When generating position-independent code, emit function calls using
11666 the Global Offset Table instead of the Procedure Linkage Table.
11667
11668 @item -musermode
11669 @opindex musermode
11670 Generate a library function call to invalidate instruction cache
11671 entries, after fixing up a trampoline.  This library function call
11672 doesn't assume it can write to the whole memory address space.  This
11673 is the default when the target is @code{sh-*-linux*}.
11674
11675 @item -multcost=@var{number}
11676 @opindex multcost=@var{number}
11677 Set the cost to assume for a multiply insn.
11678
11679 @item -mdiv=@var{strategy}
11680 @opindex mdiv=@var{strategy}
11681 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11682 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11683 inv:call2, inv:fp .
11684 "fp" performs the operation in floating point.  This has a very high latency,
11685 but needs only a few instructions, so it might be a good choice if
11686 your code has enough easily exploitable ILP to allow the compiler to
11687 schedule the floating point instructions together with other instructions.
11688 Division by zero causes a floating point exception.
11689 "inv" uses integer operations to calculate the inverse of the divisor,
11690 and then multiplies the dividend with the inverse.  This strategy allows
11691 cse and hoisting of the inverse calculation.  Division by zero calculates
11692 an unspecified result, but does not trap.
11693 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11694 have been found, or if the entire operation has been hoisted to the same
11695 place, the last stages of the inverse calculation are intertwined with the
11696 final multiply to reduce the overall latency, at the expense of using a few
11697 more instructions, and thus offering fewer scheduling opportunities with
11698 other code.
11699 "call" calls a library function that usually implements the inv:minlat
11700 strategy.
11701 This gives high code density for m5-*media-nofpu compilations.
11702 "call2" uses a different entry point of the same library function, where it
11703 assumes that a pointer to a lookup table has already been set up, which
11704 exposes the pointer load to cse / code hoisting optimizations.
11705 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11706 code generation, but if the code stays unoptimized, revert to the "call",
11707 "call2", or "fp" strategies, respectively.  Note that the
11708 potentially-trapping side effect of division by zero is carried by a
11709 separate instruction, so it is possible that all the integer instructions
11710 are hoisted out, but the marker for the side effect stays where it is.
11711 A recombination to fp operations or a call is not possible in that case.
11712 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11713 that the inverse calculation was nor separated from the multiply, they speed
11714 up division where the dividend fits into 20 bits (plus sign where applicable),
11715 by inserting a test to skip a number of operations in this case; this test
11716 slows down the case of larger dividends.  inv20u assumes the case of a such
11717 a small dividend to be unlikely, and inv20l assumes it to be likely.
11718
11719 @item -mdivsi3_libfunc=@var{name}
11720 @opindex mdivsi3_libfunc=@var{name}
11721 Set the name of the library function used for 32 bit signed division to
11722 @var{name}.  This only affect the name used in the call and inv:call
11723 division strategies, and the compiler will still expect the same
11724 sets of input/output/clobbered registers as if this option was not present.
11725
11726 @item -madjust-unroll
11727 @opindex madjust-unroll
11728 Throttle unrolling to avoid thrashing target registers.
11729 This option only has an effect if the gcc code base supports the
11730 TARGET_ADJUST_UNROLL_MAX target hook.
11731
11732 @item -mindexed-addressing
11733 @opindex mindexed-addressing
11734 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11735 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11736 semantics for the indexed addressing mode.  The architecture allows the
11737 implementation of processors with 64 bit MMU, which the OS could use to
11738 get 32 bit addressing, but since no current hardware implementation supports
11739 this or any other way to make the indexed addressing mode safe to use in
11740 the 32 bit ABI, the default is -mno-indexed-addressing.
11741
11742 @item -mgettrcost=@var{number}
11743 @opindex mgettrcost=@var{number}
11744 Set the cost assumed for the gettr instruction to @var{number}.
11745 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11746
11747 @item -mpt-fixed
11748 @opindex mpt-fixed
11749 Assume pt* instructions won't trap.  This will generally generate better
11750 scheduled code, but is unsafe on current hardware.  The current architecture
11751 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11752 This has the unintentional effect of making it unsafe to schedule ptabs /
11753 ptrel before a branch, or hoist it out of a loop.  For example,
11754 __do_global_ctors, a part of libgcc that runs constructors at program
11755 startup, calls functions in a list which is delimited by -1.  With the
11756 -mpt-fixed option, the ptabs will be done before testing against -1.
11757 That means that all the constructors will be run a bit quicker, but when
11758 the loop comes to the end of the list, the program crashes because ptabs
11759 loads -1 into a target register.  Since this option is unsafe for any
11760 hardware implementing the current architecture specification, the default
11761 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11762 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11763 this deters register allocation using target registers for storing
11764 ordinary integers.
11765
11766 @item -minvalid-symbols
11767 @opindex minvalid-symbols
11768 Assume symbols might be invalid.  Ordinary function symbols generated by
11769 the compiler will always be valid to load with movi/shori/ptabs or
11770 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11771 to generate symbols that will cause ptabs / ptrel to trap.
11772 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11773 It will then prevent cross-basic-block cse, hoisting and most scheduling
11774 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11775 @end table
11776
11777 @node SPARC Options
11778 @subsection SPARC Options
11779 @cindex SPARC options
11780
11781 These @samp{-m} options are supported on the SPARC:
11782
11783 @table @gcctabopt
11784 @item -mno-app-regs
11785 @itemx -mapp-regs
11786 @opindex mno-app-regs
11787 @opindex mapp-regs
11788 Specify @option{-mapp-regs} to generate output using the global registers
11789 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11790 is the default.
11791
11792 To be fully SVR4 ABI compliant at the cost of some performance loss,
11793 specify @option{-mno-app-regs}.  You should compile libraries and system
11794 software with this option.
11795
11796 @item -mfpu
11797 @itemx -mhard-float
11798 @opindex mfpu
11799 @opindex mhard-float
11800 Generate output containing floating point instructions.  This is the
11801 default.
11802
11803 @item -mno-fpu
11804 @itemx -msoft-float
11805 @opindex mno-fpu
11806 @opindex msoft-float
11807 Generate output containing library calls for floating point.
11808 @strong{Warning:} the requisite libraries are not available for all SPARC
11809 targets.  Normally the facilities of the machine's usual C compiler are
11810 used, but this cannot be done directly in cross-compilation.  You must make
11811 your own arrangements to provide suitable library functions for
11812 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11813 @samp{sparclite-*-*} do provide software floating point support.
11814
11815 @option{-msoft-float} changes the calling convention in the output file;
11816 therefore, it is only useful if you compile @emph{all} of a program with
11817 this option.  In particular, you need to compile @file{libgcc.a}, the
11818 library that comes with GCC, with @option{-msoft-float} in order for
11819 this to work.
11820
11821 @item -mhard-quad-float
11822 @opindex mhard-quad-float
11823 Generate output containing quad-word (long double) floating point
11824 instructions.
11825
11826 @item -msoft-quad-float
11827 @opindex msoft-quad-float
11828 Generate output containing library calls for quad-word (long double)
11829 floating point instructions.  The functions called are those specified
11830 in the SPARC ABI@.  This is the default.
11831
11832 As of this writing, there are no SPARC implementations that have hardware
11833 support for the quad-word floating point instructions.  They all invoke
11834 a trap handler for one of these instructions, and then the trap handler
11835 emulates the effect of the instruction.  Because of the trap handler overhead,
11836 this is much slower than calling the ABI library routines.  Thus the
11837 @option{-msoft-quad-float} option is the default.
11838
11839 @item -mno-unaligned-doubles
11840 @itemx -munaligned-doubles
11841 @opindex mno-unaligned-doubles
11842 @opindex munaligned-doubles
11843 Assume that doubles have 8 byte alignment.  This is the default.
11844
11845 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11846 alignment only if they are contained in another type, or if they have an
11847 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11848 Specifying this option avoids some rare compatibility problems with code
11849 generated by other compilers.  It is not the default because it results
11850 in a performance loss, especially for floating point code.
11851
11852 @item -mno-faster-structs
11853 @itemx -mfaster-structs
11854 @opindex mno-faster-structs
11855 @opindex mfaster-structs
11856 With @option{-mfaster-structs}, the compiler assumes that structures
11857 should have 8 byte alignment.  This enables the use of pairs of
11858 @code{ldd} and @code{std} instructions for copies in structure
11859 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11860 However, the use of this changed alignment directly violates the SPARC
11861 ABI@.  Thus, it's intended only for use on targets where the developer
11862 acknowledges that their resulting code will not be directly in line with
11863 the rules of the ABI@.
11864
11865 @item -mimpure-text
11866 @opindex mimpure-text
11867 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11868 the compiler to not pass @option{-z text} to the linker when linking a
11869 shared object.  Using this option, you can link position-dependent
11870 code into a shared object.
11871
11872 @option{-mimpure-text} suppresses the ``relocations remain against
11873 allocatable but non-writable sections'' linker error message.
11874 However, the necessary relocations will trigger copy-on-write, and the
11875 shared object is not actually shared across processes.  Instead of
11876 using @option{-mimpure-text}, you should compile all source code with
11877 @option{-fpic} or @option{-fPIC}.
11878
11879 This option is only available on SunOS and Solaris.
11880
11881 @item -mcpu=@var{cpu_type}
11882 @opindex mcpu
11883 Set the instruction set, register set, and instruction scheduling parameters
11884 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11885 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11886 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11887 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11888 @samp{ultrasparc3}.
11889
11890 Default instruction scheduling parameters are used for values that select
11891 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11892 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11893
11894 Here is a list of each supported architecture and their supported
11895 implementations.
11896
11897 @smallexample
11898     v7:             cypress
11899     v8:             supersparc, hypersparc
11900     sparclite:      f930, f934, sparclite86x
11901     sparclet:       tsc701
11902     v9:             ultrasparc, ultrasparc3
11903 @end smallexample
11904
11905 By default (unless configured otherwise), GCC generates code for the V7
11906 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11907 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11908 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11909 SPARCStation 1, 2, IPX etc.
11910
11911 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11912 architecture.  The only difference from V7 code is that the compiler emits
11913 the integer multiply and integer divide instructions which exist in SPARC-V8
11914 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11915 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11916 2000 series.
11917
11918 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11919 the SPARC architecture.  This adds the integer multiply, integer divide step
11920 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11921 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11922 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11923 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11924 MB86934 chip, which is the more recent SPARClite with FPU@.
11925
11926 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11927 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11928 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11929 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11930 optimizes it for the TEMIC SPARClet chip.
11931
11932 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11933 architecture.  This adds 64-bit integer and floating-point move instructions,
11934 3 additional floating-point condition code registers and conditional move
11935 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11936 optimizes it for the Sun UltraSPARC I/II chips.  With
11937 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11938 Sun UltraSPARC III chip.
11939
11940 @item -mtune=@var{cpu_type}
11941 @opindex mtune
11942 Set the instruction scheduling parameters for machine type
11943 @var{cpu_type}, but do not set the instruction set or register set that the
11944 option @option{-mcpu=@var{cpu_type}} would.
11945
11946 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11947 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11948 that select a particular cpu implementation.  Those are @samp{cypress},
11949 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11950 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11951 @samp{ultrasparc3}.
11952
11953 @item -mv8plus
11954 @itemx -mno-v8plus
11955 @opindex mv8plus
11956 @opindex mno-v8plus
11957 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11958 difference from the V8 ABI is that the global and out registers are
11959 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11960 mode for all SPARC-V9 processors.
11961
11962 @item -mvis
11963 @itemx -mno-vis
11964 @opindex mvis
11965 @opindex mno-vis
11966 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11967 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11968 @end table
11969
11970 These @samp{-m} options are supported in addition to the above
11971 on SPARC-V9 processors in 64-bit environments:
11972
11973 @table @gcctabopt
11974 @item -mlittle-endian
11975 @opindex mlittle-endian
11976 Generate code for a processor running in little-endian mode.  It is only
11977 available for a few configurations and most notably not on Solaris and Linux.
11978
11979 @item -m32
11980 @itemx -m64
11981 @opindex m32
11982 @opindex m64
11983 Generate code for a 32-bit or 64-bit environment.
11984 The 32-bit environment sets int, long and pointer to 32 bits.
11985 The 64-bit environment sets int to 32 bits and long and pointer
11986 to 64 bits.
11987
11988 @item -mcmodel=medlow
11989 @opindex mcmodel=medlow
11990 Generate code for the Medium/Low code model: 64-bit addresses, programs
11991 must be linked in the low 32 bits of memory.  Programs can be statically
11992 or dynamically linked.
11993
11994 @item -mcmodel=medmid
11995 @opindex mcmodel=medmid
11996 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11997 must be linked in the low 44 bits of memory, the text and data segments must
11998 be less than 2GB in size and the data segment must be located within 2GB of
11999 the text segment.
12000
12001 @item -mcmodel=medany
12002 @opindex mcmodel=medany
12003 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12004 may be linked anywhere in memory, the text and data segments must be less
12005 than 2GB in size and the data segment must be located within 2GB of the
12006 text segment.
12007
12008 @item -mcmodel=embmedany
12009 @opindex mcmodel=embmedany
12010 Generate code for the Medium/Anywhere code model for embedded systems:
12011 64-bit addresses, the text and data segments must be less than 2GB in
12012 size, both starting anywhere in memory (determined at link time).  The
12013 global register %g4 points to the base of the data segment.  Programs
12014 are statically linked and PIC is not supported.
12015
12016 @item -mstack-bias
12017 @itemx -mno-stack-bias
12018 @opindex mstack-bias
12019 @opindex mno-stack-bias
12020 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12021 frame pointer if present, are offset by @minus{}2047 which must be added back
12022 when making stack frame references.  This is the default in 64-bit mode.
12023 Otherwise, assume no such offset is present.
12024 @end table
12025
12026 These switches are supported in addition to the above on Solaris:
12027
12028 @table @gcctabopt
12029 @item -threads
12030 @opindex threads
12031 Add support for multithreading using the Solaris threads library.  This
12032 option sets flags for both the preprocessor and linker.  This option does
12033 not affect the thread safety of object code produced by the compiler or
12034 that of libraries supplied with it.
12035
12036 @item -pthreads
12037 @opindex pthreads
12038 Add support for multithreading using the POSIX threads library.  This
12039 option sets flags for both the preprocessor and linker.  This option does
12040 not affect the thread safety of object code produced  by the compiler or
12041 that of libraries supplied with it.
12042 @end table
12043
12044 @node System V Options
12045 @subsection Options for System V
12046
12047 These additional options are available on System V Release 4 for
12048 compatibility with other compilers on those systems:
12049
12050 @table @gcctabopt
12051 @item -G
12052 @opindex G
12053 Create a shared object.
12054 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12055
12056 @item -Qy
12057 @opindex Qy
12058 Identify the versions of each tool used by the compiler, in a
12059 @code{.ident} assembler directive in the output.
12060
12061 @item -Qn
12062 @opindex Qn
12063 Refrain from adding @code{.ident} directives to the output file (this is
12064 the default).
12065
12066 @item -YP,@var{dirs}
12067 @opindex YP
12068 Search the directories @var{dirs}, and no others, for libraries
12069 specified with @option{-l}.
12070
12071 @item -Ym,@var{dir}
12072 @opindex Ym
12073 Look in the directory @var{dir} to find the M4 preprocessor.
12074 The assembler uses this option.
12075 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12076 @c the generic assembler that comes with Solaris takes just -Ym.
12077 @end table
12078
12079 @node TMS320C3x/C4x Options
12080 @subsection TMS320C3x/C4x Options
12081 @cindex TMS320C3x/C4x Options
12082
12083 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12084
12085 @table @gcctabopt
12086
12087 @item -mcpu=@var{cpu_type}
12088 @opindex mcpu
12089 Set the instruction set, register set, and instruction scheduling
12090 parameters for machine type @var{cpu_type}.  Supported values for
12091 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12092 @samp{c44}.  The default is @samp{c40} to generate code for the
12093 TMS320C40.
12094
12095 @item -mbig-memory
12096 @itemx -mbig
12097 @itemx -msmall-memory
12098 @itemx -msmall
12099 @opindex mbig-memory
12100 @opindex mbig
12101 @opindex msmall-memory
12102 @opindex msmall
12103 Generates code for the big or small memory model.  The small memory
12104 model assumed that all data fits into one 64K word page.  At run-time
12105 the data page (DP) register must be set to point to the 64K page
12106 containing the .bss and .data program sections.  The big memory model is
12107 the default and requires reloading of the DP register for every direct
12108 memory access.
12109
12110 @item -mbk
12111 @itemx -mno-bk
12112 @opindex mbk
12113 @opindex mno-bk
12114 Allow (disallow) allocation of general integer operands into the block
12115 count register BK@.
12116
12117 @item -mdb
12118 @itemx -mno-db
12119 @opindex mdb
12120 @opindex mno-db
12121 Enable (disable) generation of code using decrement and branch,
12122 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12123 on the safe side, this is disabled for the C3x, since the maximum
12124 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12125 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12126 that it can utilize the decrement and branch instruction, but will give
12127 up if there is more than one memory reference in the loop.  Thus a loop
12128 where the loop counter is decremented can generate slightly more
12129 efficient code, in cases where the RPTB instruction cannot be utilized.
12130
12131 @item -mdp-isr-reload
12132 @itemx -mparanoid
12133 @opindex mdp-isr-reload
12134 @opindex mparanoid
12135 Force the DP register to be saved on entry to an interrupt service
12136 routine (ISR), reloaded to point to the data section, and restored on
12137 exit from the ISR@.  This should not be required unless someone has
12138 violated the small memory model by modifying the DP register, say within
12139 an object library.
12140
12141 @item -mmpyi
12142 @itemx -mno-mpyi
12143 @opindex mmpyi
12144 @opindex mno-mpyi
12145 For the C3x use the 24-bit MPYI instruction for integer multiplies
12146 instead of a library call to guarantee 32-bit results.  Note that if one
12147 of the operands is a constant, then the multiplication will be performed
12148 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12149 then squaring operations are performed inline instead of a library call.
12150
12151 @item -mfast-fix
12152 @itemx -mno-fast-fix
12153 @opindex mfast-fix
12154 @opindex mno-fast-fix
12155 The C3x/C4x FIX instruction to convert a floating point value to an
12156 integer value chooses the nearest integer less than or equal to the
12157 floating point value rather than to the nearest integer.  Thus if the
12158 floating point number is negative, the result will be incorrectly
12159 truncated an additional code is necessary to detect and correct this
12160 case.  This option can be used to disable generation of the additional
12161 code required to correct the result.
12162
12163 @item -mrptb
12164 @itemx -mno-rptb
12165 @opindex mrptb
12166 @opindex mno-rptb
12167 Enable (disable) generation of repeat block sequences using the RPTB
12168 instruction for zero overhead looping.  The RPTB construct is only used
12169 for innermost loops that do not call functions or jump across the loop
12170 boundaries.  There is no advantage having nested RPTB loops due to the
12171 overhead required to save and restore the RC, RS, and RE registers.
12172 This is enabled by default with @option{-O2}.
12173
12174 @item -mrpts=@var{count}
12175 @itemx -mno-rpts
12176 @opindex mrpts
12177 @opindex mno-rpts
12178 Enable (disable) the use of the single instruction repeat instruction
12179 RPTS@.  If a repeat block contains a single instruction, and the loop
12180 count can be guaranteed to be less than the value @var{count}, GCC will
12181 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12182 then a RPTS will be emitted even if the loop count cannot be determined
12183 at compile time.  Note that the repeated instruction following RPTS does
12184 not have to be reloaded from memory each iteration, thus freeing up the
12185 CPU buses for operands.  However, since interrupts are blocked by this
12186 instruction, it is disabled by default.
12187
12188 @item -mloop-unsigned
12189 @itemx -mno-loop-unsigned
12190 @opindex mloop-unsigned
12191 @opindex mno-loop-unsigned
12192 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12193 is @math{2^{31} + 1} since these instructions test if the iteration count is
12194 negative to terminate the loop.  If the iteration count is unsigned
12195 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12196 exceeded.  This switch allows an unsigned iteration count.
12197
12198 @item -mti
12199 @opindex mti
12200 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12201 with.  This also enforces compatibility with the API employed by the TI
12202 C3x C compiler.  For example, long doubles are passed as structures
12203 rather than in floating point registers.
12204
12205 @item -mregparm
12206 @itemx -mmemparm
12207 @opindex mregparm
12208 @opindex mmemparm
12209 Generate code that uses registers (stack) for passing arguments to functions.
12210 By default, arguments are passed in registers where possible rather
12211 than by pushing arguments on to the stack.
12212
12213 @item -mparallel-insns
12214 @itemx -mno-parallel-insns
12215 @opindex mparallel-insns
12216 @opindex mno-parallel-insns
12217 Allow the generation of parallel instructions.  This is enabled by
12218 default with @option{-O2}.
12219
12220 @item -mparallel-mpy
12221 @itemx -mno-parallel-mpy
12222 @opindex mparallel-mpy
12223 @opindex mno-parallel-mpy
12224 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12225 provided @option{-mparallel-insns} is also specified.  These instructions have
12226 tight register constraints which can pessimize the code generation
12227 of large functions.
12228
12229 @end table
12230
12231 @node V850 Options
12232 @subsection V850 Options
12233 @cindex V850 Options
12234
12235 These @samp{-m} options are defined for V850 implementations:
12236
12237 @table @gcctabopt
12238 @item -mlong-calls
12239 @itemx -mno-long-calls
12240 @opindex mlong-calls
12241 @opindex mno-long-calls
12242 Treat all calls as being far away (near).  If calls are assumed to be
12243 far away, the compiler will always load the functions address up into a
12244 register, and call indirect through the pointer.
12245
12246 @item -mno-ep
12247 @itemx -mep
12248 @opindex mno-ep
12249 @opindex mep
12250 Do not optimize (do optimize) basic blocks that use the same index
12251 pointer 4 or more times to copy pointer into the @code{ep} register, and
12252 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12253 option is on by default if you optimize.
12254
12255 @item -mno-prolog-function
12256 @itemx -mprolog-function
12257 @opindex mno-prolog-function
12258 @opindex mprolog-function
12259 Do not use (do use) external functions to save and restore registers
12260 at the prologue and epilogue of a function.  The external functions
12261 are slower, but use less code space if more than one function saves
12262 the same number of registers.  The @option{-mprolog-function} option
12263 is on by default if you optimize.
12264
12265 @item -mspace
12266 @opindex mspace
12267 Try to make the code as small as possible.  At present, this just turns
12268 on the @option{-mep} and @option{-mprolog-function} options.
12269
12270 @item -mtda=@var{n}
12271 @opindex mtda
12272 Put static or global variables whose size is @var{n} bytes or less into
12273 the tiny data area that register @code{ep} points to.  The tiny data
12274 area can hold up to 256 bytes in total (128 bytes for byte references).
12275
12276 @item -msda=@var{n}
12277 @opindex msda
12278 Put static or global variables whose size is @var{n} bytes or less into
12279 the small data area that register @code{gp} points to.  The small data
12280 area can hold up to 64 kilobytes.
12281
12282 @item -mzda=@var{n}
12283 @opindex mzda
12284 Put static or global variables whose size is @var{n} bytes or less into
12285 the first 32 kilobytes of memory.
12286
12287 @item -mv850
12288 @opindex mv850
12289 Specify that the target processor is the V850.
12290
12291 @item -mbig-switch
12292 @opindex mbig-switch
12293 Generate code suitable for big switch tables.  Use this option only if
12294 the assembler/linker complain about out of range branches within a switch
12295 table.
12296
12297 @item -mapp-regs
12298 @opindex mapp-regs
12299 This option will cause r2 and r5 to be used in the code generated by
12300 the compiler.  This setting is the default.
12301
12302 @item -mno-app-regs
12303 @opindex mno-app-regs
12304 This option will cause r2 and r5 to be treated as fixed registers.
12305
12306 @item -mv850e1
12307 @opindex mv850e1
12308 Specify that the target processor is the V850E1.  The preprocessor
12309 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12310 this option is used.
12311
12312 @item -mv850e
12313 @opindex mv850e
12314 Specify that the target processor is the V850E@.  The preprocessor
12315 constant @samp{__v850e__} will be defined if this option is used.
12316
12317 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12318 are defined then a default target processor will be chosen and the
12319 relevant @samp{__v850*__} preprocessor constant will be defined.
12320
12321 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12322 defined, regardless of which processor variant is the target.
12323
12324 @item -mdisable-callt
12325 @opindex mdisable-callt
12326 This option will suppress generation of the CALLT instruction for the
12327 v850e and v850e1 flavors of the v850 architecture.  The default is
12328 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12329
12330 @end table
12331
12332 @node VAX Options
12333 @subsection VAX Options
12334 @cindex VAX options
12335
12336 These @samp{-m} options are defined for the VAX:
12337
12338 @table @gcctabopt
12339 @item -munix
12340 @opindex munix
12341 Do not output certain jump instructions (@code{aobleq} and so on)
12342 that the Unix assembler for the VAX cannot handle across long
12343 ranges.
12344
12345 @item -mgnu
12346 @opindex mgnu
12347 Do output those jump instructions, on the assumption that you
12348 will assemble with the GNU assembler.
12349
12350 @item -mg
12351 @opindex mg
12352 Output code for g-format floating point numbers instead of d-format.
12353 @end table
12354
12355 @node x86-64 Options
12356 @subsection x86-64 Options
12357 @cindex x86-64 options
12358
12359 These are listed under @xref{i386 and x86-64 Options}.
12360
12361 @node Xstormy16 Options
12362 @subsection Xstormy16 Options
12363 @cindex Xstormy16 Options
12364
12365 These options are defined for Xstormy16:
12366
12367 @table @gcctabopt
12368 @item -msim
12369 @opindex msim
12370 Choose startup files and linker script suitable for the simulator.
12371 @end table
12372
12373 @node Xtensa Options
12374 @subsection Xtensa Options
12375 @cindex Xtensa Options
12376
12377 These options are supported for Xtensa targets:
12378
12379 @table @gcctabopt
12380 @item -mconst16
12381 @itemx -mno-const16
12382 @opindex mconst16
12383 @opindex mno-const16
12384 Enable or disable use of @code{CONST16} instructions for loading
12385 constant values.  The @code{CONST16} instruction is currently not a
12386 standard option from Tensilica.  When enabled, @code{CONST16}
12387 instructions are always used in place of the standard @code{L32R}
12388 instructions.  The use of @code{CONST16} is enabled by default only if
12389 the @code{L32R} instruction is not available.
12390
12391 @item -mfused-madd
12392 @itemx -mno-fused-madd
12393 @opindex mfused-madd
12394 @opindex mno-fused-madd
12395 Enable or disable use of fused multiply/add and multiply/subtract
12396 instructions in the floating-point option.  This has no effect if the
12397 floating-point option is not also enabled.  Disabling fused multiply/add
12398 and multiply/subtract instructions forces the compiler to use separate
12399 instructions for the multiply and add/subtract operations.  This may be
12400 desirable in some cases where strict IEEE 754-compliant results are
12401 required: the fused multiply add/subtract instructions do not round the
12402 intermediate result, thereby producing results with @emph{more} bits of
12403 precision than specified by the IEEE standard.  Disabling fused multiply
12404 add/subtract instructions also ensures that the program output is not
12405 sensitive to the compiler's ability to combine multiply and add/subtract
12406 operations.
12407
12408 @item -mtext-section-literals
12409 @itemx -mno-text-section-literals
12410 @opindex mtext-section-literals
12411 @opindex mno-text-section-literals
12412 Control the treatment of literal pools.  The default is
12413 @option{-mno-text-section-literals}, which places literals in a separate
12414 section in the output file.  This allows the literal pool to be placed
12415 in a data RAM/ROM, and it also allows the linker to combine literal
12416 pools from separate object files to remove redundant literals and
12417 improve code size.  With @option{-mtext-section-literals}, the literals
12418 are interspersed in the text section in order to keep them as close as
12419 possible to their references.  This may be necessary for large assembly
12420 files.
12421
12422 @item -mtarget-align
12423 @itemx -mno-target-align
12424 @opindex mtarget-align
12425 @opindex mno-target-align
12426 When this option is enabled, GCC instructs the assembler to
12427 automatically align instructions to reduce branch penalties at the
12428 expense of some code density.  The assembler attempts to widen density
12429 instructions to align branch targets and the instructions following call
12430 instructions.  If there are not enough preceding safe density
12431 instructions to align a target, no widening will be performed.  The
12432 default is @option{-mtarget-align}.  These options do not affect the
12433 treatment of auto-aligned instructions like @code{LOOP}, which the
12434 assembler will always align, either by widening density instructions or
12435 by inserting no-op instructions.
12436
12437 @item -mlongcalls
12438 @itemx -mno-longcalls
12439 @opindex mlongcalls
12440 @opindex mno-longcalls
12441 When this option is enabled, GCC instructs the assembler to translate
12442 direct calls to indirect calls unless it can determine that the target
12443 of a direct call is in the range allowed by the call instruction.  This
12444 translation typically occurs for calls to functions in other source
12445 files.  Specifically, the assembler translates a direct @code{CALL}
12446 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12447 The default is @option{-mno-longcalls}.  This option should be used in
12448 programs where the call target can potentially be out of range.  This
12449 option is implemented in the assembler, not the compiler, so the
12450 assembly code generated by GCC will still show direct call
12451 instructions---look at the disassembled object code to see the actual
12452 instructions.  Note that the assembler will use an indirect call for
12453 every cross-file call, not just those that really will be out of range.
12454 @end table
12455
12456 @node zSeries Options
12457 @subsection zSeries Options
12458 @cindex zSeries options
12459
12460 These are listed under @xref{S/390 and zSeries Options}.
12461
12462 @node Code Gen Options
12463 @section Options for Code Generation Conventions
12464 @cindex code generation conventions
12465 @cindex options, code generation
12466 @cindex run-time options
12467
12468 These machine-independent options control the interface conventions
12469 used in code generation.
12470
12471 Most of them have both positive and negative forms; the negative form
12472 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12473 one of the forms is listed---the one which is not the default.  You
12474 can figure out the other form by either removing @samp{no-} or adding
12475 it.
12476
12477 @table @gcctabopt
12478 @item -fbounds-check
12479 @opindex fbounds-check
12480 For front-ends that support it, generate additional code to check that
12481 indices used to access arrays are within the declared range.  This is
12482 currently only supported by the Java and Fortran 77 front-ends, where
12483 this option defaults to true and false respectively.
12484
12485 @item -ftrapv
12486 @opindex ftrapv
12487 This option generates traps for signed overflow on addition, subtraction,
12488 multiplication operations.
12489
12490 @item -fwrapv
12491 @opindex fwrapv
12492 This option instructs the compiler to assume that signed arithmetic
12493 overflow of addition, subtraction and multiplication wraps around
12494 using twos-complement representation.  This flag enables some optimizations
12495 and disables other.  This option is enabled by default for the Java
12496 front-end, as required by the Java language specification.
12497
12498 @item -fexceptions
12499 @opindex fexceptions
12500 Enable exception handling.  Generates extra code needed to propagate
12501 exceptions.  For some targets, this implies GCC will generate frame
12502 unwind information for all functions, which can produce significant data
12503 size overhead, although it does not affect execution.  If you do not
12504 specify this option, GCC will enable it by default for languages like
12505 C++ which normally require exception handling, and disable it for
12506 languages like C that do not normally require it.  However, you may need
12507 to enable this option when compiling C code that needs to interoperate
12508 properly with exception handlers written in C++.  You may also wish to
12509 disable this option if you are compiling older C++ programs that don't
12510 use exception handling.
12511
12512 @item -fnon-call-exceptions
12513 @opindex fnon-call-exceptions
12514 Generate code that allows trapping instructions to throw exceptions.
12515 Note that this requires platform-specific runtime support that does
12516 not exist everywhere.  Moreover, it only allows @emph{trapping}
12517 instructions to throw exceptions, i.e.@: memory references or floating
12518 point instructions.  It does not allow exceptions to be thrown from
12519 arbitrary signal handlers such as @code{SIGALRM}.
12520
12521 @item -funwind-tables
12522 @opindex funwind-tables
12523 Similar to @option{-fexceptions}, except that it will just generate any needed
12524 static data, but will not affect the generated code in any other way.
12525 You will normally not enable this option; instead, a language processor
12526 that needs this handling would enable it on your behalf.
12527
12528 @item -fasynchronous-unwind-tables
12529 @opindex fasynchronous-unwind-tables
12530 Generate unwind table in dwarf2 format, if supported by target machine.  The
12531 table is exact at each instruction boundary, so it can be used for stack
12532 unwinding from asynchronous events (such as debugger or garbage collector).
12533
12534 @item -fpcc-struct-return
12535 @opindex fpcc-struct-return
12536 Return ``short'' @code{struct} and @code{union} values in memory like
12537 longer ones, rather than in registers.  This convention is less
12538 efficient, but it has the advantage of allowing intercallability between
12539 GCC-compiled files and files compiled with other compilers, particularly
12540 the Portable C Compiler (pcc).
12541
12542 The precise convention for returning structures in memory depends
12543 on the target configuration macros.
12544
12545 Short structures and unions are those whose size and alignment match
12546 that of some integer type.
12547
12548 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12549 switch is not binary compatible with code compiled with the
12550 @option{-freg-struct-return} switch.
12551 Use it to conform to a non-default application binary interface.
12552
12553 @item -freg-struct-return
12554 @opindex freg-struct-return
12555 Return @code{struct} and @code{union} values in registers when possible.
12556 This is more efficient for small structures than
12557 @option{-fpcc-struct-return}.
12558
12559 If you specify neither @option{-fpcc-struct-return} nor
12560 @option{-freg-struct-return}, GCC defaults to whichever convention is
12561 standard for the target.  If there is no standard convention, GCC
12562 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12563 the principal compiler.  In those cases, we can choose the standard, and
12564 we chose the more efficient register return alternative.
12565
12566 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12567 switch is not binary compatible with code compiled with the
12568 @option{-fpcc-struct-return} switch.
12569 Use it to conform to a non-default application binary interface.
12570
12571 @item -fshort-enums
12572 @opindex fshort-enums
12573 Allocate to an @code{enum} type only as many bytes as it needs for the
12574 declared range of possible values.  Specifically, the @code{enum} type
12575 will be equivalent to the smallest integer type which has enough room.
12576
12577 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12578 code that is not binary compatible with code generated without that switch.
12579 Use it to conform to a non-default application binary interface.
12580
12581 @item -fshort-double
12582 @opindex fshort-double
12583 Use the same size for @code{double} as for @code{float}.
12584
12585 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12586 code that is not binary compatible with code generated without that switch.
12587 Use it to conform to a non-default application binary interface.
12588
12589 @item -fshort-wchar
12590 @opindex fshort-wchar
12591 Override the underlying type for @samp{wchar_t} to be @samp{short
12592 unsigned int} instead of the default for the target.  This option is
12593 useful for building programs to run under WINE@.
12594
12595 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12596 code that is not binary compatible with code generated without that switch.
12597 Use it to conform to a non-default application binary interface.
12598
12599 @item -fshared-data
12600 @opindex fshared-data
12601 Requests that the data and non-@code{const} variables of this
12602 compilation be shared data rather than private data.  The distinction
12603 makes sense only on certain operating systems, where shared data is
12604 shared between processes running the same program, while private data
12605 exists in one copy per process.
12606
12607 @item -fno-common
12608 @opindex fno-common
12609 In C, allocate even uninitialized global variables in the data section of the
12610 object file, rather than generating them as common blocks.  This has the
12611 effect that if the same variable is declared (without @code{extern}) in
12612 two different compilations, you will get an error when you link them.
12613 The only reason this might be useful is if you wish to verify that the
12614 program will work on other systems which always work this way.
12615
12616 @item -fno-ident
12617 @opindex fno-ident
12618 Ignore the @samp{#ident} directive.
12619
12620 @item -finhibit-size-directive
12621 @opindex finhibit-size-directive
12622 Don't output a @code{.size} assembler directive, or anything else that
12623 would cause trouble if the function is split in the middle, and the
12624 two halves are placed at locations far apart in memory.  This option is
12625 used when compiling @file{crtstuff.c}; you should not need to use it
12626 for anything else.
12627
12628 @item -fverbose-asm
12629 @opindex fverbose-asm
12630 Put extra commentary information in the generated assembly code to
12631 make it more readable.  This option is generally only of use to those
12632 who actually need to read the generated assembly code (perhaps while
12633 debugging the compiler itself).
12634
12635 @option{-fno-verbose-asm}, the default, causes the
12636 extra information to be omitted and is useful when comparing two assembler
12637 files.
12638
12639 @item -fpic
12640 @opindex fpic
12641 @cindex global offset table
12642 @cindex PIC
12643 Generate position-independent code (PIC) suitable for use in a shared
12644 library, if supported for the target machine.  Such code accesses all
12645 constant addresses through a global offset table (GOT)@.  The dynamic
12646 loader resolves the GOT entries when the program starts (the dynamic
12647 loader is not part of GCC; it is part of the operating system).  If
12648 the GOT size for the linked executable exceeds a machine-specific
12649 maximum size, you get an error message from the linker indicating that
12650 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12651 instead.  (These maximums are 8k on the SPARC and 32k
12652 on the m68k and RS/6000.  The 386 has no such limit.)
12653
12654 Position-independent code requires special support, and therefore works
12655 only on certain machines.  For the 386, GCC supports PIC for System V
12656 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12657 position-independent.
12658
12659 @item -fPIC
12660 @opindex fPIC
12661 If supported for the target machine, emit position-independent code,
12662 suitable for dynamic linking and avoiding any limit on the size of the
12663 global offset table.  This option makes a difference on the m68k,
12664 PowerPC and SPARC@.
12665
12666 Position-independent code requires special support, and therefore works
12667 only on certain machines.
12668
12669 @item -fpie
12670 @itemx -fPIE
12671 @opindex fpie
12672 @opindex fPIE
12673 These options are similar to @option{-fpic} and @option{-fPIC}, but
12674 generated position independent code can be only linked into executables.
12675 Usually these options are used when @option{-pie} GCC option will be
12676 used during linking.
12677
12678 @item -fno-jump-tables
12679 @opindex fno-jump-tables
12680 Do not use jump tables for switch statements even where it would be
12681 more efficient than other code generation strategies.  This option is
12682 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12683 building code which forms part of a dynamic linker and cannot
12684 reference the address of a jump table.  On some targets, jump tables
12685 do not require a GOT and this option is not needed.
12686
12687 @item -ffixed-@var{reg}
12688 @opindex ffixed
12689 Treat the register named @var{reg} as a fixed register; generated code
12690 should never refer to it (except perhaps as a stack pointer, frame
12691 pointer or in some other fixed role).
12692
12693 @var{reg} must be the name of a register.  The register names accepted
12694 are machine-specific and are defined in the @code{REGISTER_NAMES}
12695 macro in the machine description macro file.
12696
12697 This flag does not have a negative form, because it specifies a
12698 three-way choice.
12699
12700 @item -fcall-used-@var{reg}
12701 @opindex fcall-used
12702 Treat the register named @var{reg} as an allocable register that is
12703 clobbered by function calls.  It may be allocated for temporaries or
12704 variables that do not live across a call.  Functions compiled this way
12705 will not save and restore the register @var{reg}.
12706
12707 It is an error to used this flag with the frame pointer or stack pointer.
12708 Use of this flag for other registers that have fixed pervasive roles in
12709 the machine's execution model will produce disastrous results.
12710
12711 This flag does not have a negative form, because it specifies a
12712 three-way choice.
12713
12714 @item -fcall-saved-@var{reg}
12715 @opindex fcall-saved
12716 Treat the register named @var{reg} as an allocable register saved by
12717 functions.  It may be allocated even for temporaries or variables that
12718 live across a call.  Functions compiled this way will save and restore
12719 the register @var{reg} if they use it.
12720
12721 It is an error to used this flag with the frame pointer or stack pointer.
12722 Use of this flag for other registers that have fixed pervasive roles in
12723 the machine's execution model will produce disastrous results.
12724
12725 A different sort of disaster will result from the use of this flag for
12726 a register in which function values may be returned.
12727
12728 This flag does not have a negative form, because it specifies a
12729 three-way choice.
12730
12731 @item -fpack-struct[=@var{n}]
12732 @opindex fpack-struct
12733 Without a value specified, pack all structure members together without
12734 holes.  When a value is specified (which must be a small power of two), pack
12735 structure members according to this value, representing the maximum
12736 alignment (that is, objects with default alignment requirements larger than
12737 this will be output potentially unaligned at the next fitting location.
12738
12739 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12740 code that is not binary compatible with code generated without that switch.
12741 Additionally, it makes the code suboptimal.
12742 Use it to conform to a non-default application binary interface.
12743
12744 @item -finstrument-functions
12745 @opindex finstrument-functions
12746 Generate instrumentation calls for entry and exit to functions.  Just
12747 after function entry and just before function exit, the following
12748 profiling functions will be called with the address of the current
12749 function and its call site.  (On some platforms,
12750 @code{__builtin_return_address} does not work beyond the current
12751 function, so the call site information may not be available to the
12752 profiling functions otherwise.)
12753
12754 @smallexample
12755 void __cyg_profile_func_enter (void *this_fn,
12756                                void *call_site);
12757 void __cyg_profile_func_exit  (void *this_fn,
12758                                void *call_site);
12759 @end smallexample
12760
12761 The first argument is the address of the start of the current function,
12762 which may be looked up exactly in the symbol table.
12763
12764 This instrumentation is also done for functions expanded inline in other
12765 functions.  The profiling calls will indicate where, conceptually, the
12766 inline function is entered and exited.  This means that addressable
12767 versions of such functions must be available.  If all your uses of a
12768 function are expanded inline, this may mean an additional expansion of
12769 code size.  If you use @samp{extern inline} in your C code, an
12770 addressable version of such functions must be provided.  (This is
12771 normally the case anyways, but if you get lucky and the optimizer always
12772 expands the functions inline, you might have gotten away without
12773 providing static copies.)
12774
12775 A function may be given the attribute @code{no_instrument_function}, in
12776 which case this instrumentation will not be done.  This can be used, for
12777 example, for the profiling functions listed above, high-priority
12778 interrupt routines, and any functions from which the profiling functions
12779 cannot safely be called (perhaps signal handlers, if the profiling
12780 routines generate output or allocate memory).
12781
12782 @item -fstack-check
12783 @opindex fstack-check
12784 Generate code to verify that you do not go beyond the boundary of the
12785 stack.  You should specify this flag if you are running in an
12786 environment with multiple threads, but only rarely need to specify it in
12787 a single-threaded environment since stack overflow is automatically
12788 detected on nearly all systems if there is only one stack.
12789
12790 Note that this switch does not actually cause checking to be done; the
12791 operating system must do that.  The switch causes generation of code
12792 to ensure that the operating system sees the stack being extended.
12793
12794 @item -fstack-limit-register=@var{reg}
12795 @itemx -fstack-limit-symbol=@var{sym}
12796 @itemx -fno-stack-limit
12797 @opindex fstack-limit-register
12798 @opindex fstack-limit-symbol
12799 @opindex fno-stack-limit
12800 Generate code to ensure that the stack does not grow beyond a certain value,
12801 either the value of a register or the address of a symbol.  If the stack
12802 would grow beyond the value, a signal is raised.  For most targets,
12803 the signal is raised before the stack overruns the boundary, so
12804 it is possible to catch the signal without taking special precautions.
12805
12806 For instance, if the stack starts at absolute address @samp{0x80000000}
12807 and grows downwards, you can use the flags
12808 @option{-fstack-limit-symbol=__stack_limit} and
12809 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12810 of 128KB@.  Note that this may only work with the GNU linker.
12811
12812 @cindex aliasing of parameters
12813 @cindex parameters, aliased
12814 @item -fargument-alias
12815 @itemx -fargument-noalias
12816 @itemx -fargument-noalias-global
12817 @opindex fargument-alias
12818 @opindex fargument-noalias
12819 @opindex fargument-noalias-global
12820 Specify the possible relationships among parameters and between
12821 parameters and global data.
12822
12823 @option{-fargument-alias} specifies that arguments (parameters) may
12824 alias each other and may alias global storage.@*
12825 @option{-fargument-noalias} specifies that arguments do not alias
12826 each other, but may alias global storage.@*
12827 @option{-fargument-noalias-global} specifies that arguments do not
12828 alias each other and do not alias global storage.
12829
12830 Each language will automatically use whatever option is required by
12831 the language standard.  You should not need to use these options yourself.
12832
12833 @item -fleading-underscore
12834 @opindex fleading-underscore
12835 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12836 change the way C symbols are represented in the object file.  One use
12837 is to help link with legacy assembly code.
12838
12839 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12840 generate code that is not binary compatible with code generated without that
12841 switch.  Use it to conform to a non-default application binary interface.
12842 Not all targets provide complete support for this switch.
12843
12844 @item -ftls-model=@var{model}
12845 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12846 The @var{model} argument should be one of @code{global-dynamic},
12847 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12848
12849 The default without @option{-fpic} is @code{initial-exec}; with
12850 @option{-fpic} the default is @code{global-dynamic}.
12851
12852 @item -fvisibility=@var{default|internal|hidden|protected}
12853 @opindex fvisibility
12854 Set the default ELF image symbol visibility to the specified option---all
12855 symbols will be marked with this unless overridden within the code.
12856 Using this feature can very substantially improve linking and
12857 load times of shared object libraries, produce more optimized
12858 code, provide near-perfect API export and prevent symbol clashes.
12859 It is @strong{strongly} recommended that you use this in any shared objects
12860 you distribute.
12861
12862 Despite the nomenclature, @code{default} always means public ie;
12863 available to be linked against from outside the shared object.
12864 @code{protected} and @code{internal} are pretty useless in real-world
12865 usage so the only other commonly used option will be @code{hidden}.
12866 The default if @option{-fvisibility} isn't specified is
12867 @code{default}, i.e., make every
12868 symbol public---this causes the same behavior as previous versions of
12869 GCC@.
12870
12871 A good explanation of the benefits offered by ensuring ELF
12872 symbols have the correct visibility is given by ``How To Write
12873 Shared Libraries'' by Ulrich Drepper (which can be found at
12874 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12875 solution made possible by this option to marking things hidden when
12876 the default is public is to make the default hidden and mark things
12877 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12878 and @code{__attribute__ ((visibility("default")))} instead of
12879 @code{__declspec(dllexport)} you get almost identical semantics with
12880 identical syntax.  This is a great boon to those working with
12881 cross-platform projects.
12882
12883 For those adding visibility support to existing code, you may find
12884 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12885 the declarations you wish to set visibility for with (for example)
12886 @samp{#pragma GCC visibility push(hidden)} and
12887 @samp{#pragma GCC visibility pop}.
12888 Bear in mind that symbol visibility should be viewed @strong{as
12889 part of the API interface contract} and thus all new code should
12890 always specify visibility when it is not the default ie; declarations
12891 only for use within the local DSO should @strong{always} be marked explicitly
12892 as hidden as so to avoid PLT indirection overheads---making this
12893 abundantly clear also aids readability and self-documentation of the code.
12894 Note that due to ISO C++ specification requirements, operator new and
12895 operator delete must always be of default visibility.
12896
12897 An overview of these techniques, their benefits and how to use them
12898 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12899
12900 @end table
12901
12902 @c man end
12903
12904 @node Environment Variables
12905 @section Environment Variables Affecting GCC
12906 @cindex environment variables
12907
12908 @c man begin ENVIRONMENT
12909 This section describes several environment variables that affect how GCC
12910 operates.  Some of them work by specifying directories or prefixes to use
12911 when searching for various kinds of files.  Some are used to specify other
12912 aspects of the compilation environment.
12913
12914 Note that you can also specify places to search using options such as
12915 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12916 take precedence over places specified using environment variables, which
12917 in turn take precedence over those specified by the configuration of GCC@.
12918 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12919 GNU Compiler Collection (GCC) Internals}.
12920
12921 @table @env
12922 @item LANG
12923 @itemx LC_CTYPE
12924 @c @itemx LC_COLLATE
12925 @itemx LC_MESSAGES
12926 @c @itemx LC_MONETARY
12927 @c @itemx LC_NUMERIC
12928 @c @itemx LC_TIME
12929 @itemx LC_ALL
12930 @findex LANG
12931 @findex LC_CTYPE
12932 @c @findex LC_COLLATE
12933 @findex LC_MESSAGES
12934 @c @findex LC_MONETARY
12935 @c @findex LC_NUMERIC
12936 @c @findex LC_TIME
12937 @findex LC_ALL
12938 @cindex locale
12939 These environment variables control the way that GCC uses
12940 localization information that allow GCC to work with different
12941 national conventions.  GCC inspects the locale categories
12942 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12943 so.  These locale categories can be set to any value supported by your
12944 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12945 Kingdom encoded in UTF-8.
12946
12947 The @env{LC_CTYPE} environment variable specifies character
12948 classification.  GCC uses it to determine the character boundaries in
12949 a string; this is needed for some multibyte encodings that contain quote
12950 and escape characters that would otherwise be interpreted as a string
12951 end or escape.
12952
12953 The @env{LC_MESSAGES} environment variable specifies the language to
12954 use in diagnostic messages.
12955
12956 If the @env{LC_ALL} environment variable is set, it overrides the value
12957 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12958 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12959 environment variable.  If none of these variables are set, GCC
12960 defaults to traditional C English behavior.
12961
12962 @item TMPDIR
12963 @findex TMPDIR
12964 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12965 files.  GCC uses temporary files to hold the output of one stage of
12966 compilation which is to be used as input to the next stage: for example,
12967 the output of the preprocessor, which is the input to the compiler
12968 proper.
12969
12970 @item GCC_EXEC_PREFIX
12971 @findex GCC_EXEC_PREFIX
12972 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12973 names of the subprograms executed by the compiler.  No slash is added
12974 when this prefix is combined with the name of a subprogram, but you can
12975 specify a prefix that ends with a slash if you wish.
12976
12977 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12978 an appropriate prefix to use based on the pathname it was invoked with.
12979
12980 If GCC cannot find the subprogram using the specified prefix, it
12981 tries looking in the usual places for the subprogram.
12982
12983 The default value of @env{GCC_EXEC_PREFIX} is
12984 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12985 of @code{prefix} when you ran the @file{configure} script.
12986
12987 Other prefixes specified with @option{-B} take precedence over this prefix.
12988
12989 This prefix is also used for finding files such as @file{crt0.o} that are
12990 used for linking.
12991
12992 In addition, the prefix is used in an unusual way in finding the
12993 directories to search for header files.  For each of the standard
12994 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12995 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12996 replacing that beginning with the specified prefix to produce an
12997 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12998 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12999 These alternate directories are searched first; the standard directories
13000 come next.
13001
13002 @item COMPILER_PATH
13003 @findex COMPILER_PATH
13004 The value of @env{COMPILER_PATH} is a colon-separated list of
13005 directories, much like @env{PATH}.  GCC tries the directories thus
13006 specified when searching for subprograms, if it can't find the
13007 subprograms using @env{GCC_EXEC_PREFIX}.
13008
13009 @item LIBRARY_PATH
13010 @findex LIBRARY_PATH
13011 The value of @env{LIBRARY_PATH} is a colon-separated list of
13012 directories, much like @env{PATH}.  When configured as a native compiler,
13013 GCC tries the directories thus specified when searching for special
13014 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13015 using GCC also uses these directories when searching for ordinary
13016 libraries for the @option{-l} option (but directories specified with
13017 @option{-L} come first).
13018
13019 @item LANG
13020 @findex LANG
13021 @cindex locale definition
13022 This variable is used to pass locale information to the compiler.  One way in
13023 which this information is used is to determine the character set to be used
13024 when character literals, string literals and comments are parsed in C and C++.
13025 When the compiler is configured to allow multibyte characters,
13026 the following values for @env{LANG} are recognized:
13027
13028 @table @samp
13029 @item C-JIS
13030 Recognize JIS characters.
13031 @item C-SJIS
13032 Recognize SJIS characters.
13033 @item C-EUCJP
13034 Recognize EUCJP characters.
13035 @end table
13036
13037 If @env{LANG} is not defined, or if it has some other value, then the
13038 compiler will use mblen and mbtowc as defined by the default locale to
13039 recognize and translate multibyte characters.
13040 @end table
13041
13042 @noindent
13043 Some additional environments variables affect the behavior of the
13044 preprocessor.
13045
13046 @include cppenv.texi
13047
13048 @c man end
13049
13050 @node Precompiled Headers
13051 @section Using Precompiled Headers
13052 @cindex precompiled headers
13053 @cindex speed of compilation
13054
13055 Often large projects have many header files that are included in every
13056 source file.  The time the compiler takes to process these header files
13057 over and over again can account for nearly all of the time required to
13058 build the project.  To make builds faster, GCC allows users to
13059 `precompile' a header file; then, if builds can use the precompiled
13060 header file they will be much faster.
13061
13062 To create a precompiled header file, simply compile it as you would any
13063 other file, if necessary using the @option{-x} option to make the driver
13064 treat it as a C or C++ header file.  You will probably want to use a
13065 tool like @command{make} to keep the precompiled header up-to-date when
13066 the headers it contains change.
13067
13068 A precompiled header file will be searched for when @code{#include} is
13069 seen in the compilation.  As it searches for the included file
13070 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13071 compiler looks for a precompiled header in each directory just before it
13072 looks for the include file in that directory.  The name searched for is
13073 the name specified in the @code{#include} with @samp{.gch} appended.  If
13074 the precompiled header file can't be used, it is ignored.
13075
13076 For instance, if you have @code{#include "all.h"}, and you have
13077 @file{all.h.gch} in the same directory as @file{all.h}, then the
13078 precompiled header file will be used if possible, and the original
13079 header will be used otherwise.
13080
13081 Alternatively, you might decide to put the precompiled header file in a
13082 directory and use @option{-I} to ensure that directory is searched
13083 before (or instead of) the directory containing the original header.
13084 Then, if you want to check that the precompiled header file is always
13085 used, you can put a file of the same name as the original header in this
13086 directory containing an @code{#error} command.
13087
13088 This also works with @option{-include}.  So yet another way to use
13089 precompiled headers, good for projects not designed with precompiled
13090 header files in mind, is to simply take most of the header files used by
13091 a project, include them from another header file, precompile that header
13092 file, and @option{-include} the precompiled header.  If the header files
13093 have guards against multiple inclusion, they will be skipped because
13094 they've already been included (in the precompiled header).
13095
13096 If you need to precompile the same header file for different
13097 languages, targets, or compiler options, you can instead make a
13098 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13099 header in the directory, perhaps using @option{-o}.  It doesn't matter
13100 what you call the files in the directory, every precompiled header in
13101 the directory will be considered.  The first precompiled header
13102 encountered in the directory that is valid for this compilation will
13103 be used; they're searched in no particular order.
13104
13105 There are many other possibilities, limited only by your imagination,
13106 good sense, and the constraints of your build system.
13107
13108 A precompiled header file can be used only when these conditions apply:
13109
13110 @itemize
13111 @item
13112 Only one precompiled header can be used in a particular compilation.
13113
13114 @item
13115 A precompiled header can't be used once the first C token is seen.  You
13116 can have preprocessor directives before a precompiled header; you can
13117 even include a precompiled header from inside another header, so long as
13118 there are no C tokens before the @code{#include}.
13119
13120 @item
13121 The precompiled header file must be produced for the same language as
13122 the current compilation.  You can't use a C precompiled header for a C++
13123 compilation.
13124
13125 @item
13126 The precompiled header file must have been produced by the same compiler
13127 binary as the current compilation is using.
13128
13129 @item
13130 Any macros defined before the precompiled header is included must
13131 either be defined in the same way as when the precompiled header was
13132 generated, or must not affect the precompiled header, which usually
13133 means that they don't appear in the precompiled header at all.
13134
13135 The @option{-D} option is one way to define a macro before a
13136 precompiled header is included; using a @code{#define} can also do it.
13137 There are also some options that define macros implicitly, like
13138 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13139 defined this way.
13140
13141 @item If debugging information is output when using the precompiled
13142 header, using @option{-g} or similar, the same kind of debugging information
13143 must have been output when building the precompiled header.  However,
13144 a precompiled header built using @option{-g} can be used in a compilation
13145 when no debugging information is being output.
13146
13147 @item The same @option{-m} options must generally be used when building
13148 and using the precompiled header.  @xref{Submodel Options},
13149 for any cases where this rule is relaxed.
13150
13151 @item Each of the following options must be the same when building and using
13152 the precompiled header:
13153
13154 @gccoptlist{-fexceptions -funit-at-a-time}
13155
13156 @item
13157 Some other command-line options starting with @option{-f},
13158 @option{-p}, or @option{-O} must be defined in the same way as when
13159 the precompiled header was generated.  At present, it's not clear
13160 which options are safe to change and which are not; the safest choice
13161 is to use exactly the same options when generating and using the
13162 precompiled header.  The following are known to be safe:
13163
13164 @gccoptlist{-fpreprocessed
13165 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13166 -fsched-verbose=<number> -fschedule-insns
13167 -pedantic-errors}
13168
13169 @end itemize
13170
13171 For all of these except the last, the compiler will automatically
13172 ignore the precompiled header if the conditions aren't met.  If you
13173 find an option combination that doesn't work and doesn't cause the
13174 precompiled header to be ignored, please consider filing a bug report,
13175 see @ref{Bugs}.
13176
13177 If you do use differing options when generating and using the
13178 precompiled header, the actual behavior will be a mixture of the
13179 behavior for the options.  For instance, if you use @option{-g} to
13180 generate the precompiled header but not when using it, you may or may
13181 not get debugging information for routines in the precompiled header.
13182
13183 @node Running Protoize
13184 @section Running Protoize
13185
13186 The program @code{protoize} is an optional part of GCC@.  You can use
13187 it to add prototypes to a program, thus converting the program to ISO
13188 C in one respect.  The companion program @code{unprotoize} does the
13189 reverse: it removes argument types from any prototypes that are found.
13190
13191 When you run these programs, you must specify a set of source files as
13192 command line arguments.  The conversion programs start out by compiling
13193 these files to see what functions they define.  The information gathered
13194 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13195
13196 After scanning comes actual conversion.  The specified files are all
13197 eligible to be converted; any files they include (whether sources or
13198 just headers) are eligible as well.
13199
13200 But not all the eligible files are converted.  By default,
13201 @code{protoize} and @code{unprotoize} convert only source and header
13202 files in the current directory.  You can specify additional directories
13203 whose files should be converted with the @option{-d @var{directory}}
13204 option.  You can also specify particular files to exclude with the
13205 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13206 directory name matches one of the specified directory names, and its
13207 name within the directory has not been excluded.
13208
13209 Basic conversion with @code{protoize} consists of rewriting most
13210 function definitions and function declarations to specify the types of
13211 the arguments.  The only ones not rewritten are those for varargs
13212 functions.
13213
13214 @code{protoize} optionally inserts prototype declarations at the
13215 beginning of the source file, to make them available for any calls that
13216 precede the function's definition.  Or it can insert prototype
13217 declarations with block scope in the blocks where undeclared functions
13218 are called.
13219
13220 Basic conversion with @code{unprotoize} consists of rewriting most
13221 function declarations to remove any argument types, and rewriting
13222 function definitions to the old-style pre-ISO form.
13223
13224 Both conversion programs print a warning for any function declaration or
13225 definition that they can't convert.  You can suppress these warnings
13226 with @option{-q}.
13227
13228 The output from @code{protoize} or @code{unprotoize} replaces the
13229 original source file.  The original file is renamed to a name ending
13230 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13231 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13232 for DOS) file already exists, then the source file is simply discarded.
13233
13234 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13235 scan the program and collect information about the functions it uses.
13236 So neither of these programs will work until GCC is installed.
13237
13238 Here is a table of the options you can use with @code{protoize} and
13239 @code{unprotoize}.  Each option works with both programs unless
13240 otherwise stated.
13241
13242 @table @code
13243 @item -B @var{directory}
13244 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13245 usual directory (normally @file{/usr/local/lib}).  This file contains
13246 prototype information about standard system functions.  This option
13247 applies only to @code{protoize}.
13248
13249 @item -c @var{compilation-options}
13250 Use @var{compilation-options} as the options when running @command{gcc} to
13251 produce the @samp{.X} files.  The special option @option{-aux-info} is
13252 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13253
13254 Note that the compilation options must be given as a single argument to
13255 @code{protoize} or @code{unprotoize}.  If you want to specify several
13256 @command{gcc} options, you must quote the entire set of compilation options
13257 to make them a single word in the shell.
13258
13259 There are certain @command{gcc} arguments that you cannot use, because they
13260 would produce the wrong kind of output.  These include @option{-g},
13261 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13262 the @var{compilation-options}, they are ignored.
13263
13264 @item -C
13265 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13266 systems) instead of @samp{.c}.  This is convenient if you are converting
13267 a C program to C++.  This option applies only to @code{protoize}.
13268
13269 @item -g
13270 Add explicit global declarations.  This means inserting explicit
13271 declarations at the beginning of each source file for each function
13272 that is called in the file and was not declared.  These declarations
13273 precede the first function definition that contains a call to an
13274 undeclared function.  This option applies only to @code{protoize}.
13275
13276 @item -i @var{string}
13277 Indent old-style parameter declarations with the string @var{string}.
13278 This option applies only to @code{protoize}.
13279
13280 @code{unprotoize} converts prototyped function definitions to old-style
13281 function definitions, where the arguments are declared between the
13282 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13283 uses five spaces as the indentation.  If you want to indent with just
13284 one space instead, use @option{-i " "}.
13285
13286 @item -k
13287 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13288 is finished.
13289
13290 @item -l
13291 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13292 a prototype declaration for each function in each block which calls the
13293 function without any declaration.  This option applies only to
13294 @code{protoize}.
13295
13296 @item -n
13297 Make no real changes.  This mode just prints information about the conversions
13298 that would have been done without @option{-n}.
13299
13300 @item -N
13301 Make no @samp{.save} files.  The original files are simply deleted.
13302 Use this option with caution.
13303
13304 @item -p @var{program}
13305 Use the program @var{program} as the compiler.  Normally, the name
13306 @file{gcc} is used.
13307
13308 @item -q
13309 Work quietly.  Most warnings are suppressed.
13310
13311 @item -v
13312 Print the version number, just like @option{-v} for @command{gcc}.
13313 @end table
13314
13315 If you need special compiler options to compile one of your program's
13316 source files, then you should generate that file's @samp{.X} file
13317 specially, by running @command{gcc} on that source file with the
13318 appropriate options and the option @option{-aux-info}.  Then run
13319 @code{protoize} on the entire set of files.  @code{protoize} will use
13320 the existing @samp{.X} file because it is newer than the source file.
13321 For example:
13322
13323 @smallexample
13324 gcc -Dfoo=bar file1.c -aux-info file1.X
13325 protoize *.c
13326 @end smallexample
13327
13328 @noindent
13329 You need to include the special files along with the rest in the
13330 @code{protoize} command, even though their @samp{.X} files already
13331 exist, because otherwise they won't get converted.
13332
13333 @xref{Protoize Caveats}, for more information on how to use
13334 @code{protoize} successfully.