OSDN Git Service

2005-05-06 Denis Vlasenko <vda@port.imtp.ilyichevsk.odessa.ua>
[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, @option{-fforce-mem},
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-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
205
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
210 -fdiagnostics-show-options
211
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-int-to-pointer-cast @gol
226 -Wno-invalid-offsetof  -Winvalid-pch @gol
227 -Wlarger-than-@var{len}  -Wlong-long @gol
228 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
229 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
230 -Wmissing-noreturn @gol
231 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
232 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
233 -Wredundant-decls @gol
234 -Wreturn-type  -Wsequence-point  -Wshadow @gol
235 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
236 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
237 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
238 -Wunknown-pragmas  -Wunreachable-code @gol
239 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
240 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
241 -Wvariadic-macros}
242
243 @item C-only Warning Options
244 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
245 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
246 -Wstrict-prototypes  -Wtraditional @gol
247 -Wdeclaration-after-statement -Wno-pointer-sign}
248
249 @item Debugging Options
250 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
251 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
252 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
253 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
254 -fdump-ipa-all -fdump-ipa-cgraph @gol
255 -fdump-tree-all @gol
256 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
257 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
258 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
260 -fdump-tree-ch @gol
261 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-nrv -fdump-tree-vect @gol
270 -fdump-tree-sink @gol
271 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-salias @gol
273 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
274 -ftree-vectorizer-verbose=@var{n} @gol
275 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
276 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
277 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
278 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
279 -ftest-coverage  -ftime-report -fvar-tracking @gol
280 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
281 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
282 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
283 -print-multi-directory  -print-multi-lib @gol
284 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
285 -save-temps  -time}
286
287 @item Optimization Options
288 @xref{Optimize Options,,Options that Control Optimization}.
289 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
290 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
291 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
292 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
293 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
294 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
295 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
296 -fdelayed-branch  -fdelete-null-pointer-checks @gol
297 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
298 -fforce-addr  -fforce-mem  -ffunction-sections @gol
299 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
300 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
301 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
302 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
303 -fmodulo-sched -fno-branch-count-reg @gol
304 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
305 -fno-function-cse  -fno-guess-branch-probability @gol
306 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
307 -funsafe-math-optimizations  -ffinite-math-only @gol
308 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
309 -fomit-frame-pointer  -foptimize-register-move @gol
310 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
311 -fprofile-generate -fprofile-use @gol
312 -fregmove  -frename-registers @gol
313 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
314 -frerun-cse-after-loop  -frerun-loop-opt @gol
315 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
316 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
317 -fsched-spec-load-dangerous  @gol
318 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
319 -fsched2-use-superblocks @gol
320 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
321 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
322 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
323 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
324 -fsplit-ivs-in-unroller -funswitch-loops @gol
325 -fvariable-expansion-in-unroller @gol
326 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
327 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
328 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
329 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
330 -ftree-salias -fweb @gol
331 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop @gol
332 --param @var{name}=@var{value}
333 -O  -O0  -O1  -O2  -O3  -Os}
334
335 @item Preprocessor Options
336 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
337 @gccoptlist{-A@var{question}=@var{answer} @gol
338 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
339 -C  -dD  -dI  -dM  -dN @gol
340 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
341 -idirafter @var{dir} @gol
342 -include @var{file}  -imacros @var{file} @gol
343 -iprefix @var{file}  -iwithprefix @var{dir} @gol
344 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
345 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
346 -P  -fworking-directory  -remap @gol
347 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
348 -Xpreprocessor @var{option}}
349
350 @item Assembler Option
351 @xref{Assembler Options,,Passing Options to the Assembler}.
352 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
353
354 @item Linker Options
355 @xref{Link Options,,Options for Linking}.
356 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
357 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
358 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
359 -Wl,@var{option}  -Xlinker @var{option} @gol
360 -u @var{symbol}}
361
362 @item Directory Options
363 @xref{Directory Options,,Options for Directory Search}.
364 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
365
366 @item Target Options
367 @c I wrote this xref this way to avoid overfull hbox. -- rms
368 @xref{Target Options}.
369 @gccoptlist{-V @var{version}  -b @var{machine}}
370
371 @item Machine Dependent Options
372 @xref{Submodel Options,,Hardware Models and Configurations}.
373 @c This list is ordered alphanumerically by subsection name.
374 @c Try and put the significant identifier (CPU or system) first,
375 @c so users have a clue at guessing where the ones they want will be.
376
377 @emph{ARC Options}
378 @gccoptlist{-EB  -EL @gol
379 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
380 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
381
382 @emph{ARM Options}
383 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
384 -mabi=@var{name} @gol
385 -mapcs-stack-check  -mno-apcs-stack-check @gol
386 -mapcs-float  -mno-apcs-float @gol
387 -mapcs-reentrant  -mno-apcs-reentrant @gol
388 -msched-prolog  -mno-sched-prolog @gol
389 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
390 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
391 -mthumb-interwork  -mno-thumb-interwork @gol
392 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
393 -mstructure-size-boundary=@var{n} @gol
394 -mabort-on-noreturn @gol
395 -mlong-calls  -mno-long-calls @gol
396 -msingle-pic-base  -mno-single-pic-base @gol
397 -mpic-register=@var{reg} @gol
398 -mnop-fun-dllimport @gol
399 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
400 -mpoke-function-name @gol
401 -mthumb  -marm @gol
402 -mtpcs-frame  -mtpcs-leaf-frame @gol
403 -mcaller-super-interworking  -mcallee-super-interworking}
404
405 @emph{AVR Options}
406 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
407 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
408
409 @emph{Blackfin Options}
410 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
411 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
412 -mno-id-shared-library -mshared-library-id=@var{n} @gol}
413
414 @emph{CRIS Options}
415 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
416 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
417 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
418 -mstack-align  -mdata-align  -mconst-align @gol
419 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
420 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
421 -mmul-bug-workaround  -mno-mul-bug-workaround}
422
423 @emph{Darwin Options}
424 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
425 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
426 -client_name  -compatibility_version  -current_version @gol
427 -dead_strip @gol
428 -dependency-file  -dylib_file  -dylinker_install_name @gol
429 -dynamic  -dynamiclib  -exported_symbols_list @gol
430 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
431 -force_flat_namespace  -headerpad_max_install_names @gol
432 -image_base  -init  -install_name  -keep_private_externs @gol
433 -multi_module  -multiply_defined  -multiply_defined_unused @gol
434 -noall_load   -no_dead_strip_inits_and_terms @gol
435 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
436 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
437 -private_bundle  -read_only_relocs  -sectalign @gol
438 -sectobjectsymbols  -whyload  -seg1addr @gol
439 -sectcreate  -sectobjectsymbols  -sectorder @gol
440 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
441 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
442 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
443 -single_module  -static  -sub_library  -sub_umbrella @gol
444 -twolevel_namespace  -umbrella  -undefined @gol
445 -unexported_symbols_list  -weak_reference_mismatches @gol
446 -whatsloaded -F -gused -gfull -mone-byte-bool}
447
448 @emph{DEC Alpha Options}
449 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
450 -mieee  -mieee-with-inexact  -mieee-conformant @gol
451 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
452 -mtrap-precision=@var{mode}  -mbuild-constants @gol
453 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
454 -mbwx  -mmax  -mfix  -mcix @gol
455 -mfloat-vax  -mfloat-ieee @gol
456 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
457 -msmall-text  -mlarge-text @gol
458 -mmemory-latency=@var{time}}
459
460 @emph{DEC Alpha/VMS Options}
461 @gccoptlist{-mvms-return-codes}
462
463 @emph{FRV Options}
464 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
465 -mhard-float  -msoft-float @gol
466 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
467 -mdouble  -mno-double @gol
468 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
469 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
470 -mlinked-fp  -mlong-calls  -malign-labels @gol
471 -mlibrary-pic  -macc-4  -macc-8 @gol
472 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
473 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
474 -mvliw-branch  -mno-vliw-branch @gol
475 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
476 -mno-nested-cond-exec  -mtomcat-stats @gol
477 -mTLS -mtls @gol
478 -mcpu=@var{cpu}}
479
480 @emph{H8/300 Options}
481 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
482
483 @emph{HPPA Options}
484 @gccoptlist{-march=@var{architecture-type} @gol
485 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
486 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
487 -mfixed-range=@var{register-range} @gol
488 -mjump-in-delay -mlinker-opt -mlong-calls @gol
489 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
490 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
491 -mno-jump-in-delay  -mno-long-load-store @gol
492 -mno-portable-runtime  -mno-soft-float @gol
493 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
494 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
495 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
496 -munix=@var{unix-std}  -nolibdld  -static  -threads}
497
498 @emph{i386 and x86-64 Options}
499 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
500 -mfpmath=@var{unit} @gol
501 -masm=@var{dialect}  -mno-fancy-math-387 @gol
502 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
503 -mno-wide-multiply  -mrtd  -malign-double @gol
504 -mpreferred-stack-boundary=@var{num} @gol
505 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
506 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
507 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
508 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
509 -mno-red-zone -mno-tls-direct-seg-refs @gol
510 -mcmodel=@var{code-model} @gol
511 -m32  -m64}
512
513 @emph{IA-64 Options}
514 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
515 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
516 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
517 -minline-float-divide-max-throughput @gol
518 -minline-int-divide-min-latency @gol
519 -minline-int-divide-max-throughput  @gol
520 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
521 -mno-dwarf2-asm -mearly-stop-bits @gol
522 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
523 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
524
525 @emph{M32R/D Options}
526 @gccoptlist{-m32r2 -m32rx -m32r @gol
527 -mdebug @gol
528 -malign-loops -mno-align-loops @gol
529 -missue-rate=@var{number} @gol
530 -mbranch-cost=@var{number} @gol
531 -mmodel=@var{code-size-model-type} @gol
532 -msdata=@var{sdata-type} @gol
533 -mno-flush-func -mflush-func=@var{name} @gol
534 -mno-flush-trap -mflush-trap=@var{number} @gol
535 -G @var{num}}
536
537 @emph{M680x0 Options}
538 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
539 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
540 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
541 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
542 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
543
544 @emph{M68hc1x Options}
545 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
546 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
547 -msoft-reg-count=@var{count}}
548
549 @emph{MCore Options}
550 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
551 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
552 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
553 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
554 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
555
556 @emph{MIPS Options}
557 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
558 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
559 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
560 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
561 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
562 -mpaired-single  -mips3d @gol
563 -mint64  -mlong64  -mlong32  -msym32  -mno-sym32 @gol
564 -G@var{num}  -membedded-data  -mno-embedded-data @gol
565 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
566 -msplit-addresses  -mno-split-addresses  @gol
567 -mexplicit-relocs  -mno-explicit-relocs  @gol
568 -mcheck-zero-division  -mno-check-zero-division @gol
569 -mdivide-traps  -mdivide-breaks @gol
570 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
571 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
572 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
573 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
574 -mfix-sb1  -mno-fix-sb1 @gol
575 -mflush-func=@var{func}  -mno-flush-func @gol
576 -mbranch-likely  -mno-branch-likely @gol
577 -mfp-exceptions -mno-fp-exceptions @gol
578 -mvr4130-align -mno-vr4130-align}
579
580 @emph{MMIX Options}
581 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
582 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
583 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
584 -mno-base-addresses  -msingle-exit  -mno-single-exit}
585
586 @emph{MN10300 Options}
587 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
588 -mam33  -mno-am33 @gol
589 -mam33-2  -mno-am33-2 @gol
590 -mno-crt0  -mrelax}
591
592 @emph{NS32K Options}
593 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
594 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
595 -mregparam  -mnoregparam  -msb  -mnosb @gol
596 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
597
598 @emph{PDP-11 Options}
599 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
600 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
601 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
602 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
603 -mbranch-expensive  -mbranch-cheap @gol
604 -msplit  -mno-split  -munix-asm  -mdec-asm}
605
606 @emph{PowerPC Options}
607 See RS/6000 and PowerPC Options.
608
609 @emph{RS/6000 and PowerPC Options}
610 @gccoptlist{-mcpu=@var{cpu-type} @gol
611 -mtune=@var{cpu-type} @gol
612 -mpower  -mno-power  -mpower2  -mno-power2 @gol
613 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
614 -maltivec  -mno-altivec @gol
615 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
616 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
617 -mnew-mnemonics  -mold-mnemonics @gol
618 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
619 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
620 -malign-power  -malign-natural @gol
621 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
622 -mstring  -mno-string  -mupdate  -mno-update @gol
623 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
624 -mstrict-align  -mno-strict-align  -mrelocatable @gol
625 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
626 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
627 -mdynamic-no-pic @gol
628 -mprioritize-restricted-insns=@var{priority} @gol
629 -msched-costly-dep=@var{dependence_type} @gol
630 -minsert-sched-nops=@var{scheme} @gol
631 -mcall-sysv  -mcall-netbsd @gol
632 -maix-struct-return  -msvr4-struct-return @gol
633 -mabi=@var{abi-type} @gol
634 -misel -mno-isel @gol
635 -misel=yes  -misel=no @gol
636 -mspe -mno-spe @gol
637 -mspe=yes  -mspe=no @gol
638 -mvrsave -mno-vrsave @gol
639 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
640 -mprototype  -mno-prototype @gol
641 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
642 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
643
644 @emph{S/390 and zSeries Options}
645 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
646 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
647 -mpacked-stack  -mno-packed-stack @gol
648 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
649 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
650 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
651 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
652
653 @emph{SH Options}
654 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
655 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
656 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
657 -m5-64media  -m5-64media-nofpu @gol
658 -m5-32media  -m5-32media-nofpu @gol
659 -m5-compact  -m5-compact-nofpu @gol
660 -mb  -ml  -mdalign  -mrelax @gol
661 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
662 -mieee  -misize  -mpadstruct  -mspace @gol
663 -mprefergot  -musermode}
664
665 @emph{SPARC Options}
666 @gccoptlist{-mcpu=@var{cpu-type} @gol
667 -mtune=@var{cpu-type} @gol
668 -mcmodel=@var{code-model} @gol
669 -m32  -m64  -mapp-regs  -mno-app-regs @gol
670 -mfaster-structs  -mno-faster-structs @gol
671 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
672 -mhard-quad-float  -msoft-quad-float @gol
673 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
674 -mstack-bias  -mno-stack-bias @gol
675 -munaligned-doubles  -mno-unaligned-doubles @gol
676 -mv8plus  -mno-v8plus  -mvis  -mno-vis
677 -threads -pthreads}
678
679 @emph{System V Options}
680 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
681
682 @emph{TMS320C3x/C4x Options}
683 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
684 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
685 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
686 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
687
688 @emph{V850 Options}
689 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
690 -mprolog-function  -mno-prolog-function  -mspace @gol
691 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
692 -mapp-regs  -mno-app-regs @gol
693 -mdisable-callt  -mno-disable-callt @gol
694 -mv850e1 @gol
695 -mv850e @gol
696 -mv850  -mbig-switch}
697
698 @emph{VAX Options}
699 @gccoptlist{-mg  -mgnu  -munix}
700
701 @emph{x86-64 Options}
702 See i386 and x86-64 Options.
703
704 @emph{Xstormy16 Options}
705 @gccoptlist{-msim}
706
707 @emph{Xtensa Options}
708 @gccoptlist{-mconst16 -mno-const16 @gol
709 -mfused-madd  -mno-fused-madd @gol
710 -mtext-section-literals  -mno-text-section-literals @gol
711 -mtarget-align  -mno-target-align @gol
712 -mlongcalls  -mno-longcalls}
713
714 @emph{zSeries Options}
715 See S/390 and zSeries Options.
716
717 @item Code Generation Options
718 @xref{Code Gen Options,,Options for Code Generation Conventions}.
719 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
720 -ffixed-@var{reg}  -fexceptions @gol
721 -fnon-call-exceptions  -funwind-tables @gol
722 -fasynchronous-unwind-tables @gol
723 -finhibit-size-directive  -finstrument-functions @gol
724 -fno-common  -fno-ident @gol
725 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
726 -freg-struct-return  -fshared-data  -fshort-enums @gol
727 -fshort-double  -fshort-wchar @gol
728 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
729 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
730 -fargument-alias  -fargument-noalias @gol
731 -fargument-noalias-global  -fleading-underscore @gol
732 -ftls-model=@var{model} @gol
733 -ftrapv  -fwrapv  -fbounds-check @gol
734 -fvisibility}
735 @end table
736
737 @menu
738 * Overall Options::     Controlling the kind of output:
739                         an executable, object files, assembler files,
740                         or preprocessed source.
741 * C Dialect Options::   Controlling the variant of C language compiled.
742 * C++ Dialect Options:: Variations on C++.
743 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
744                         and Objective-C++.
745 * Language Independent Options:: Controlling how diagnostics should be
746                         formatted.
747 * Warning Options::     How picky should the compiler be?
748 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
749 * Optimize Options::    How much optimization?
750 * Preprocessor Options:: Controlling header files and macro definitions.
751                          Also, getting dependency information for Make.
752 * Assembler Options::   Passing options to the assembler.
753 * Link Options::        Specifying libraries and so on.
754 * Directory Options::   Where to find header files and libraries.
755                         Where to find the compiler executable files.
756 * Spec Files::          How to pass switches to sub-processes.
757 * Target Options::      Running a cross-compiler, or an old version of GCC.
758 @end menu
759
760 @node Overall Options
761 @section Options Controlling the Kind of Output
762
763 Compilation can involve up to four stages: preprocessing, compilation
764 proper, assembly and linking, always in that order.  GCC is capable of
765 preprocessing and compiling several files either into several
766 assembler input files, or into one assembler input file; then each
767 assembler input file produces an object file, and linking combines all
768 the object files (those newly compiled, and those specified as input)
769 into an executable file.
770
771 @cindex file name suffix
772 For any given input file, the file name suffix determines what kind of
773 compilation is done:
774
775 @table @gcctabopt
776 @item @var{file}.c
777 C source code which must be preprocessed.
778
779 @item @var{file}.i
780 C source code which should not be preprocessed.
781
782 @item @var{file}.ii
783 C++ source code which should not be preprocessed.
784
785 @item @var{file}.m
786 Objective-C source code.  Note that you must link with the @file{libobjc}
787 library to make an Objective-C program work.
788
789 @item @var{file}.mi
790 Objective-C source code which should not be preprocessed.
791
792 @item @var{file}.mm
793 @itemx @var{file}.M
794 Objective-C++ source code.  Note that you must link with the @file{libobjc}
795 library to make an Objective-C++ program work.  Note that @samp{.M} refers
796 to a literal capital M@.
797
798 @item @var{file}.mii
799 Objective-C++ source code which should not be preprocessed.
800
801 @item @var{file}.h
802 C, C++, Objective-C or Objective-C++ header file to be turned into a
803 precompiled header.
804
805 @item @var{file}.cc
806 @itemx @var{file}.cp
807 @itemx @var{file}.cxx
808 @itemx @var{file}.cpp
809 @itemx @var{file}.CPP
810 @itemx @var{file}.c++
811 @itemx @var{file}.C
812 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
813 the last two letters must both be literally @samp{x}.  Likewise,
814 @samp{.C} refers to a literal capital C@.
815
816 @item @var{file}.hh
817 @itemx @var{file}.H
818 C++ header file to be turned into a precompiled header.
819
820 @item @var{file}.f
821 @itemx @var{file}.for
822 @itemx @var{file}.FOR
823 Fortran source code which should not be preprocessed.
824
825 @item @var{file}.F
826 @itemx @var{file}.fpp
827 @itemx @var{file}.FPP
828 Fortran source code which must be preprocessed (with the traditional
829 preprocessor).
830
831 @item @var{file}.r
832 Fortran source code which must be preprocessed with a RATFOR
833 preprocessor (not included with GCC)@.
834
835 @item @var{file}.f90
836 @itemx @var{file}.f95
837 Fortran 90/95 source code which should not be preprocessed.
838
839 @c FIXME: Descriptions of Java file types.
840 @c @var{file}.java
841 @c @var{file}.class
842 @c @var{file}.zip
843 @c @var{file}.jar
844
845 @item @var{file}.ads
846 Ada source code file which contains a library unit declaration (a
847 declaration of a package, subprogram, or generic, or a generic
848 instantiation), or a library unit renaming declaration (a package,
849 generic, or subprogram renaming declaration).  Such files are also
850 called @dfn{specs}.
851
852 @itemx @var{file}.adb
853 Ada source code file containing a library unit body (a subprogram or
854 package body).  Such files are also called @dfn{bodies}.
855
856 @c GCC also knows about some suffixes for languages not yet included:
857 @c Pascal:
858 @c @var{file}.p
859 @c @var{file}.pas
860
861 @item @var{file}.s
862 Assembler code.
863
864 @item @var{file}.S
865 Assembler code which must be preprocessed.
866
867 @item @var{other}
868 An object file to be fed straight into linking.
869 Any file name with no recognized suffix is treated this way.
870 @end table
871
872 @opindex x
873 You can specify the input language explicitly with the @option{-x} option:
874
875 @table @gcctabopt
876 @item -x @var{language}
877 Specify explicitly the @var{language} for the following input files
878 (rather than letting the compiler choose a default based on the file
879 name suffix).  This option applies to all following input files until
880 the next @option{-x} option.  Possible values for @var{language} are:
881 @smallexample
882 c  c-header  c-cpp-output
883 c++  c++-header  c++-cpp-output
884 objective-c  objective-c-header  objective-c-cpp-output
885 objective-c++ objective-c++-header objective-c++-cpp-output
886 assembler  assembler-with-cpp
887 ada
888 f77  f77-cpp-input  ratfor
889 f95
890 java
891 treelang
892 @end smallexample
893
894 @item -x none
895 Turn off any specification of a language, so that subsequent files are
896 handled according to their file name suffixes (as they are if @option{-x}
897 has not been used at all).
898
899 @item -pass-exit-codes
900 @opindex pass-exit-codes
901 Normally the @command{gcc} program will exit with the code of 1 if any
902 phase of the compiler returns a non-success return code.  If you specify
903 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
904 numerically highest error produced by any phase that returned an error
905 indication.
906 @end table
907
908 If you only want some of the stages of compilation, you can use
909 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
910 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
911 @command{gcc} is to stop.  Note that some combinations (for example,
912 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
913
914 @table @gcctabopt
915 @item -c
916 @opindex c
917 Compile or assemble the source files, but do not link.  The linking
918 stage simply is not done.  The ultimate output is in the form of an
919 object file for each source file.
920
921 By default, the object file name for a source file is made by replacing
922 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
923
924 Unrecognized input files, not requiring compilation or assembly, are
925 ignored.
926
927 @item -S
928 @opindex S
929 Stop after the stage of compilation proper; do not assemble.  The output
930 is in the form of an assembler code file for each non-assembler input
931 file specified.
932
933 By default, the assembler file name for a source file is made by
934 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
935
936 Input files that don't require compilation are ignored.
937
938 @item -E
939 @opindex E
940 Stop after the preprocessing stage; do not run the compiler proper.  The
941 output is in the form of preprocessed source code, which is sent to the
942 standard output.
943
944 Input files which don't require preprocessing are ignored.
945
946 @cindex output file option
947 @item -o @var{file}
948 @opindex o
949 Place output in file @var{file}.  This applies regardless to whatever
950 sort of output is being produced, whether it be an executable file,
951 an object file, an assembler file or preprocessed C code.
952
953 If @option{-o} is not specified, the default is to put an executable
954 file in @file{a.out}, the object file for
955 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
956 assembler file in @file{@var{source}.s}, a precompiled header file in
957 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
958 standard output.
959
960 @item -v
961 @opindex v
962 Print (on standard error output) the commands executed to run the stages
963 of compilation.  Also print the version number of the compiler driver
964 program and of the preprocessor and the compiler proper.
965
966 @item -###
967 @opindex ###
968 Like @option{-v} except the commands are not executed and all command
969 arguments are quoted.  This is useful for shell scripts to capture the
970 driver-generated command lines.
971
972 @item -pipe
973 @opindex pipe
974 Use pipes rather than temporary files for communication between the
975 various stages of compilation.  This fails to work on some systems where
976 the assembler is unable to read from a pipe; but the GNU assembler has
977 no trouble.
978
979 @item -combine
980 @opindex combine
981 If you are compiling multiple source files, this option tells the driver
982 to pass all the source files to the compiler at once (for those
983 languages for which the compiler can handle this).  This will allow
984 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
985 language for which this is supported is C@.  If you pass source files for
986 multiple languages to the driver, using this option, the driver will invoke
987 the compiler(s) that support IMA once each, passing each compiler all the
988 source files appropriate for it.  For those languages that do not support
989 IMA this option will be ignored, and the compiler will be invoked once for
990 each source file in that language.  If you use this option in conjunction
991 with @option{-save-temps}, the compiler will generate multiple
992 pre-processed files
993 (one for each source file), but only one (combined) @file{.o} or
994 @file{.s} file.
995
996 @item --help
997 @opindex help
998 Print (on the standard output) a description of the command line options
999 understood by @command{gcc}.  If the @option{-v} option is also specified
1000 then @option{--help} will also be passed on to the various processes
1001 invoked by @command{gcc}, so that they can display the command line options
1002 they accept.  If the @option{-Wextra} option is also specified then command
1003 line options which have no documentation associated with them will also
1004 be displayed.
1005
1006 @item --target-help
1007 @opindex target-help
1008 Print (on the standard output) a description of target specific command
1009 line options for each tool.
1010
1011 @item --version
1012 @opindex version
1013 Display the version number and copyrights of the invoked GCC@.
1014 @end table
1015
1016 @node Invoking G++
1017 @section Compiling C++ Programs
1018
1019 @cindex suffixes for C++ source
1020 @cindex C++ source file suffixes
1021 C++ source files conventionally use one of the suffixes @samp{.C},
1022 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1023 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1024 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1025 files with these names and compiles them as C++ programs even if you
1026 call the compiler the same way as for compiling C programs (usually
1027 with the name @command{gcc}).
1028
1029 @findex g++
1030 @findex c++
1031 However, C++ programs often require class libraries as well as a
1032 compiler that understands the C++ language---and under some
1033 circumstances, you might want to compile programs or header files from
1034 standard input, or otherwise without a suffix that flags them as C++
1035 programs.  You might also like to precompile a C header file with a
1036 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1037 program that calls GCC with the default language set to C++, and
1038 automatically specifies linking against the C++ library.  On many
1039 systems, @command{g++} is also installed with the name @command{c++}.
1040
1041 @cindex invoking @command{g++}
1042 When you compile C++ programs, you may specify many of the same
1043 command-line options that you use for compiling programs in any
1044 language; or command-line options meaningful for C and related
1045 languages; or options that are meaningful only for C++ programs.
1046 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1047 explanations of options for languages related to C@.
1048 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1049 explanations of options that are meaningful only for C++ programs.
1050
1051 @node C Dialect Options
1052 @section Options Controlling C Dialect
1053 @cindex dialect options
1054 @cindex language dialect options
1055 @cindex options, dialect
1056
1057 The following options control the dialect of C (or languages derived
1058 from C, such as C++, Objective-C and Objective-C++) that the compiler
1059 accepts:
1060
1061 @table @gcctabopt
1062 @cindex ANSI support
1063 @cindex ISO support
1064 @item -ansi
1065 @opindex ansi
1066 In C mode, support all ISO C90 programs.  In C++ mode,
1067 remove GNU extensions that conflict with ISO C++.
1068
1069 This turns off certain features of GCC that are incompatible with ISO
1070 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1071 such as the @code{asm} and @code{typeof} keywords, and
1072 predefined macros such as @code{unix} and @code{vax} that identify the
1073 type of system you are using.  It also enables the undesirable and
1074 rarely used ISO trigraph feature.  For the C compiler,
1075 it disables recognition of C++ style @samp{//} comments as well as
1076 the @code{inline} keyword.
1077
1078 The alternate keywords @code{__asm__}, @code{__extension__},
1079 @code{__inline__} and @code{__typeof__} continue to work despite
1080 @option{-ansi}.  You would not want to use them in an ISO C program, of
1081 course, but it is useful to put them in header files that might be included
1082 in compilations done with @option{-ansi}.  Alternate predefined macros
1083 such as @code{__unix__} and @code{__vax__} are also available, with or
1084 without @option{-ansi}.
1085
1086 The @option{-ansi} option does not cause non-ISO programs to be
1087 rejected gratuitously.  For that, @option{-pedantic} is required in
1088 addition to @option{-ansi}.  @xref{Warning Options}.
1089
1090 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1091 option is used.  Some header files may notice this macro and refrain
1092 from declaring certain functions or defining certain macros that the
1093 ISO standard doesn't call for; this is to avoid interfering with any
1094 programs that might use these names for other things.
1095
1096 Functions which would normally be built in but do not have semantics
1097 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1098 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1099 built-in functions provided by GCC}, for details of the functions
1100 affected.
1101
1102 @item -std=
1103 @opindex std
1104 Determine the language standard.  This option is currently only
1105 supported when compiling C or C++.  A value for this option must be
1106 provided; possible values are
1107
1108 @table @samp
1109 @item c89
1110 @itemx iso9899:1990
1111 ISO C90 (same as @option{-ansi}).
1112
1113 @item iso9899:199409
1114 ISO C90 as modified in amendment 1.
1115
1116 @item c99
1117 @itemx c9x
1118 @itemx iso9899:1999
1119 @itemx iso9899:199x
1120 ISO C99.  Note that this standard is not yet fully supported; see
1121 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1122 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1123
1124 @item gnu89
1125 Default, ISO C90 plus GNU extensions (including some C99 features).
1126
1127 @item gnu99
1128 @itemx gnu9x
1129 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1130 this will become the default.  The name @samp{gnu9x} is deprecated.
1131
1132 @item c++98
1133 The 1998 ISO C++ standard plus amendments.
1134
1135 @item gnu++98
1136 The same as @option{-std=c++98} plus GNU extensions.  This is the
1137 default for C++ code.
1138 @end table
1139
1140 Even when this option is not specified, you can still use some of the
1141 features of newer standards in so far as they do not conflict with
1142 previous C standards.  For example, you may use @code{__restrict__} even
1143 when @option{-std=c99} is not specified.
1144
1145 The @option{-std} options specifying some version of ISO C have the same
1146 effects as @option{-ansi}, except that features that were not in ISO C90
1147 but are in the specified version (for example, @samp{//} comments and
1148 the @code{inline} keyword in ISO C99) are not disabled.
1149
1150 @xref{Standards,,Language Standards Supported by GCC}, for details of
1151 these standard versions.
1152
1153 @item -aux-info @var{filename}
1154 @opindex aux-info
1155 Output to the given filename prototyped declarations for all functions
1156 declared and/or defined in a translation unit, including those in header
1157 files.  This option is silently ignored in any language other than C@.
1158
1159 Besides declarations, the file indicates, in comments, the origin of
1160 each declaration (source file and line), whether the declaration was
1161 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1162 @samp{O} for old, respectively, in the first character after the line
1163 number and the colon), and whether it came from a declaration or a
1164 definition (@samp{C} or @samp{F}, respectively, in the following
1165 character).  In the case of function definitions, a K&R-style list of
1166 arguments followed by their declarations is also provided, inside
1167 comments, after the declaration.
1168
1169 @item -fno-asm
1170 @opindex fno-asm
1171 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1172 keyword, so that code can use these words as identifiers.  You can use
1173 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1174 instead.  @option{-ansi} implies @option{-fno-asm}.
1175
1176 In C++, this switch only affects the @code{typeof} keyword, since
1177 @code{asm} and @code{inline} are standard keywords.  You may want to
1178 use the @option{-fno-gnu-keywords} flag instead, which has the same
1179 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1180 switch only affects the @code{asm} and @code{typeof} keywords, since
1181 @code{inline} is a standard keyword in ISO C99.
1182
1183 @item -fno-builtin
1184 @itemx -fno-builtin-@var{function}
1185 @opindex fno-builtin
1186 @cindex built-in functions
1187 Don't recognize built-in functions that do not begin with
1188 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1189 functions provided by GCC}, for details of the functions affected,
1190 including those which are not built-in functions when @option{-ansi} or
1191 @option{-std} options for strict ISO C conformance are used because they
1192 do not have an ISO standard meaning.
1193
1194 GCC normally generates special code to handle certain built-in functions
1195 more efficiently; for instance, calls to @code{alloca} may become single
1196 instructions that adjust the stack directly, and calls to @code{memcpy}
1197 may become inline copy loops.  The resulting code is often both smaller
1198 and faster, but since the function calls no longer appear as such, you
1199 cannot set a breakpoint on those calls, nor can you change the behavior
1200 of the functions by linking with a different library.  In addition,
1201 when a function is recognized as a built-in function, GCC may use
1202 information about that function to warn about problems with calls to
1203 that function, or to generate more efficient code, even if the
1204 resulting code still contains calls to that function.  For example,
1205 warnings are given with @option{-Wformat} for bad calls to
1206 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1207 known not to modify global memory.
1208
1209 With the @option{-fno-builtin-@var{function}} option
1210 only the built-in function @var{function} is
1211 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1212 function is named this is not built-in in this version of GCC, this
1213 option is ignored.  There is no corresponding
1214 @option{-fbuiltin-@var{function}} option; if you wish to enable
1215 built-in functions selectively when using @option{-fno-builtin} or
1216 @option{-ffreestanding}, you may define macros such as:
1217
1218 @smallexample
1219 #define abs(n)          __builtin_abs ((n))
1220 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1221 @end smallexample
1222
1223 @item -fhosted
1224 @opindex fhosted
1225 @cindex hosted environment
1226
1227 Assert that compilation takes place in a hosted environment.  This implies
1228 @option{-fbuiltin}.  A hosted environment is one in which the
1229 entire standard library is available, and in which @code{main} has a return
1230 type of @code{int}.  Examples are nearly everything except a kernel.
1231 This is equivalent to @option{-fno-freestanding}.
1232
1233 @item -ffreestanding
1234 @opindex ffreestanding
1235 @cindex hosted environment
1236
1237 Assert that compilation takes place in a freestanding environment.  This
1238 implies @option{-fno-builtin}.  A freestanding environment
1239 is one in which the standard library may not exist, and program startup may
1240 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1241 This is equivalent to @option{-fno-hosted}.
1242
1243 @xref{Standards,,Language Standards Supported by GCC}, for details of
1244 freestanding and hosted environments.
1245
1246 @item -fms-extensions
1247 @opindex fms-extensions
1248 Accept some non-standard constructs used in Microsoft header files.
1249
1250 Some cases of unnamed fields in structures and unions are only
1251 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1252 fields within structs/unions}, for details.
1253
1254 @item -trigraphs
1255 @opindex trigraphs
1256 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1257 options for strict ISO C conformance) implies @option{-trigraphs}.
1258
1259 @item -no-integrated-cpp
1260 @opindex no-integrated-cpp
1261 Performs a compilation in two passes: preprocessing and compiling.  This
1262 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1263 @option{-B} option.  The user supplied compilation step can then add in
1264 an additional preprocessing step after normal preprocessing but before
1265 compiling.  The default is to use the integrated cpp (internal cpp)
1266
1267 The semantics of this option will change if "cc1", "cc1plus", and
1268 "cc1obj" are merged.
1269
1270 @cindex traditional C language
1271 @cindex C language, traditional
1272 @item -traditional
1273 @itemx -traditional-cpp
1274 @opindex traditional-cpp
1275 @opindex traditional
1276 Formerly, these options caused GCC to attempt to emulate a pre-standard
1277 C compiler.  They are now only supported with the @option{-E} switch.
1278 The preprocessor continues to support a pre-standard mode.  See the GNU
1279 CPP manual for details.
1280
1281 @item -fcond-mismatch
1282 @opindex fcond-mismatch
1283 Allow conditional expressions with mismatched types in the second and
1284 third arguments.  The value of such an expression is void.  This option
1285 is not supported for C++.
1286
1287 @item -funsigned-char
1288 @opindex funsigned-char
1289 Let the type @code{char} be unsigned, like @code{unsigned char}.
1290
1291 Each kind of machine has a default for what @code{char} should
1292 be.  It is either like @code{unsigned char} by default or like
1293 @code{signed char} by default.
1294
1295 Ideally, a portable program should always use @code{signed char} or
1296 @code{unsigned char} when it depends on the signedness of an object.
1297 But many programs have been written to use plain @code{char} and
1298 expect it to be signed, or expect it to be unsigned, depending on the
1299 machines they were written for.  This option, and its inverse, let you
1300 make such a program work with the opposite default.
1301
1302 The type @code{char} is always a distinct type from each of
1303 @code{signed char} or @code{unsigned char}, even though its behavior
1304 is always just like one of those two.
1305
1306 @item -fsigned-char
1307 @opindex fsigned-char
1308 Let the type @code{char} be signed, like @code{signed char}.
1309
1310 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1311 the negative form of @option{-funsigned-char}.  Likewise, the option
1312 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1313
1314 @item -fsigned-bitfields
1315 @itemx -funsigned-bitfields
1316 @itemx -fno-signed-bitfields
1317 @itemx -fno-unsigned-bitfields
1318 @opindex fsigned-bitfields
1319 @opindex funsigned-bitfields
1320 @opindex fno-signed-bitfields
1321 @opindex fno-unsigned-bitfields
1322 These options control whether a bit-field is signed or unsigned, when the
1323 declaration does not use either @code{signed} or @code{unsigned}.  By
1324 default, such a bit-field is signed, because this is consistent: the
1325 basic integer types such as @code{int} are signed types.
1326 @end table
1327
1328 @node C++ Dialect Options
1329 @section Options Controlling C++ Dialect
1330
1331 @cindex compiler options, C++
1332 @cindex C++ options, command line
1333 @cindex options, C++
1334 This section describes the command-line options that are only meaningful
1335 for C++ programs; but you can also use most of the GNU compiler options
1336 regardless of what language your program is in.  For example, you
1337 might compile a file @code{firstClass.C} like this:
1338
1339 @smallexample
1340 g++ -g -frepo -O -c firstClass.C
1341 @end smallexample
1342
1343 @noindent
1344 In this example, only @option{-frepo} is an option meant
1345 only for C++ programs; you can use the other options with any
1346 language supported by GCC@.
1347
1348 Here is a list of options that are @emph{only} for compiling C++ programs:
1349
1350 @table @gcctabopt
1351
1352 @item -fabi-version=@var{n}
1353 @opindex fabi-version
1354 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1355 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1356 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1357 the version that conforms most closely to the C++ ABI specification.
1358 Therefore, the ABI obtained using version 0 will change as ABI bugs
1359 are fixed.
1360
1361 The default is version 2.
1362
1363 @item -fno-access-control
1364 @opindex fno-access-control
1365 Turn off all access checking.  This switch is mainly useful for working
1366 around bugs in the access control code.
1367
1368 @item -fcheck-new
1369 @opindex fcheck-new
1370 Check that the pointer returned by @code{operator new} is non-null
1371 before attempting to modify the storage allocated.  This check is
1372 normally unnecessary because the C++ standard specifies that
1373 @code{operator new} will only return @code{0} if it is declared
1374 @samp{throw()}, in which case the compiler will always check the
1375 return value even without this option.  In all other cases, when
1376 @code{operator new} has a non-empty exception specification, memory
1377 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1378 @samp{new (nothrow)}.
1379
1380 @item -fconserve-space
1381 @opindex fconserve-space
1382 Put uninitialized or runtime-initialized global variables into the
1383 common segment, as C does.  This saves space in the executable at the
1384 cost of not diagnosing duplicate definitions.  If you compile with this
1385 flag and your program mysteriously crashes after @code{main()} has
1386 completed, you may have an object that is being destroyed twice because
1387 two definitions were merged.
1388
1389 This option is no longer useful on most targets, now that support has
1390 been added for putting variables into BSS without making them common.
1391
1392 @item -fno-const-strings
1393 @opindex fno-const-strings
1394 Give string constants type @code{char *} instead of type @code{const
1395 char *}.  By default, G++ uses type @code{const char *} as required by
1396 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1397 actually modify the value of a string constant.
1398
1399 This option might be removed in a future release of G++.  For maximum
1400 portability, you should structure your code so that it works with
1401 string constants that have type @code{const char *}.
1402
1403 @item -fno-elide-constructors
1404 @opindex fno-elide-constructors
1405 The C++ standard allows an implementation to omit creating a temporary
1406 which is only used to initialize another object of the same type.
1407 Specifying this option disables that optimization, and forces G++ to
1408 call the copy constructor in all cases.
1409
1410 @item -fno-enforce-eh-specs
1411 @opindex fno-enforce-eh-specs
1412 Don't check for violation of exception specifications at runtime.  This
1413 option violates the C++ standard, but may be useful for reducing code
1414 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1415 will still optimize based on the exception specifications.
1416
1417 @item -ffor-scope
1418 @itemx -fno-for-scope
1419 @opindex ffor-scope
1420 @opindex fno-for-scope
1421 If @option{-ffor-scope} is specified, the scope of variables declared in
1422 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1423 as specified by the C++ standard.
1424 If @option{-fno-for-scope} is specified, the scope of variables declared in
1425 a @i{for-init-statement} extends to the end of the enclosing scope,
1426 as was the case in old versions of G++, and other (traditional)
1427 implementations of C++.
1428
1429 The default if neither flag is given to follow the standard,
1430 but to allow and give a warning for old-style code that would
1431 otherwise be invalid, or have different behavior.
1432
1433 @item -fno-gnu-keywords
1434 @opindex fno-gnu-keywords
1435 Do not recognize @code{typeof} as a keyword, so that code can use this
1436 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1437 @option{-ansi} implies @option{-fno-gnu-keywords}.
1438
1439 @item -fno-implicit-templates
1440 @opindex fno-implicit-templates
1441 Never emit code for non-inline templates which are instantiated
1442 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1443 @xref{Template Instantiation}, for more information.
1444
1445 @item -fno-implicit-inline-templates
1446 @opindex fno-implicit-inline-templates
1447 Don't emit code for implicit instantiations of inline templates, either.
1448 The default is to handle inlines differently so that compiles with and
1449 without optimization will need the same set of explicit instantiations.
1450
1451 @item -fno-implement-inlines
1452 @opindex fno-implement-inlines
1453 To save space, do not emit out-of-line copies of inline functions
1454 controlled by @samp{#pragma implementation}.  This will cause linker
1455 errors if these functions are not inlined everywhere they are called.
1456
1457 @item -fms-extensions
1458 @opindex fms-extensions
1459 Disable pedantic warnings about constructs used in MFC, such as implicit
1460 int and getting a pointer to member function via non-standard syntax.
1461
1462 @item -fno-nonansi-builtins
1463 @opindex fno-nonansi-builtins
1464 Disable built-in declarations of functions that are not mandated by
1465 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1466 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1467
1468 @item -fno-operator-names
1469 @opindex fno-operator-names
1470 Do not treat the operator name keywords @code{and}, @code{bitand},
1471 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1472 synonyms as keywords.
1473
1474 @item -fno-optional-diags
1475 @opindex fno-optional-diags
1476 Disable diagnostics that the standard says a compiler does not need to
1477 issue.  Currently, the only such diagnostic issued by G++ is the one for
1478 a name having multiple meanings within a class.
1479
1480 @item -fpermissive
1481 @opindex fpermissive
1482 Downgrade some diagnostics about nonconformant code from errors to
1483 warnings.  Thus, using @option{-fpermissive} will allow some
1484 nonconforming code to compile.
1485
1486 @item -frepo
1487 @opindex frepo
1488 Enable automatic template instantiation at link time.  This option also
1489 implies @option{-fno-implicit-templates}.  @xref{Template
1490 Instantiation}, for more information.
1491
1492 @item -fno-rtti
1493 @opindex fno-rtti
1494 Disable generation of information about every class with virtual
1495 functions for use by the C++ runtime type identification features
1496 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1497 of the language, you can save some space by using this flag.  Note that
1498 exception handling uses the same information, but it will generate it as
1499 needed.
1500
1501 @item -fstats
1502 @opindex fstats
1503 Emit statistics about front-end processing at the end of the compilation.
1504 This information is generally only useful to the G++ development team.
1505
1506 @item -ftemplate-depth-@var{n}
1507 @opindex ftemplate-depth
1508 Set the maximum instantiation depth for template classes to @var{n}.
1509 A limit on the template instantiation depth is needed to detect
1510 endless recursions during template class instantiation.  ANSI/ISO C++
1511 conforming programs must not rely on a maximum depth greater than 17.
1512
1513 @item -fno-threadsafe-statics
1514 @opindex fno-threadsafe-statics
1515 Do not emit the extra code to use the routines specified in the C++
1516 ABI for thread-safe initialization of local statics.  You can use this
1517 option to reduce code size slightly in code that doesn't need to be
1518 thread-safe.
1519
1520 @item -fuse-cxa-atexit
1521 @opindex fuse-cxa-atexit
1522 Register destructors for objects with static storage duration with the
1523 @code{__cxa_atexit} function rather than the @code{atexit} function.
1524 This option is required for fully standards-compliant handling of static
1525 destructors, but will only work if your C library supports
1526 @code{__cxa_atexit}.
1527
1528 @item -fvisibility-inlines-hidden
1529 @opindex fvisibility-inlines-hidden
1530 Causes all inlined methods to be marked with
1531 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1532 appear in the export table of a DSO and do not require a PLT indirection
1533 when used within the DSO@.  Enabling this option can have a dramatic effect
1534 on load and link times of a DSO as it massively reduces the size of the
1535 dynamic export table when the library makes heavy use of templates.  While
1536 it can cause bloating through duplication of code within each DSO where
1537 it is used, often the wastage is less than the considerable space occupied
1538 by a long symbol name in the export table which is typical when using
1539 templates and namespaces.  For even more savings, combine with the
1540 @option{-fvisibility=hidden} switch.
1541
1542 @item -fno-weak
1543 @opindex fno-weak
1544 Do not use weak symbol support, even if it is provided by the linker.
1545 By default, G++ will use weak symbols if they are available.  This
1546 option exists only for testing, and should not be used by end-users;
1547 it will result in inferior code and has no benefits.  This option may
1548 be removed in a future release of G++.
1549
1550 @item -nostdinc++
1551 @opindex nostdinc++
1552 Do not search for header files in the standard directories specific to
1553 C++, but do still search the other standard directories.  (This option
1554 is used when building the C++ library.)
1555 @end table
1556
1557 In addition, these optimization, warning, and code generation options
1558 have meanings only for C++ programs:
1559
1560 @table @gcctabopt
1561 @item -fno-default-inline
1562 @opindex fno-default-inline
1563 Do not assume @samp{inline} for functions defined inside a class scope.
1564 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1565 functions will have linkage like inline functions; they just won't be
1566 inlined by default.
1567
1568 @item -Wabi @r{(C++ only)}
1569 @opindex Wabi
1570 Warn when G++ generates code that is probably not compatible with the
1571 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1572 all such cases, there are probably some cases that are not warned about,
1573 even though G++ is generating incompatible code.  There may also be
1574 cases where warnings are emitted even though the code that is generated
1575 will be compatible.
1576
1577 You should rewrite your code to avoid these warnings if you are
1578 concerned about the fact that code generated by G++ may not be binary
1579 compatible with code generated by other compilers.
1580
1581 The known incompatibilities at this point include:
1582
1583 @itemize @bullet
1584
1585 @item
1586 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1587 pack data into the same byte as a base class.  For example:
1588
1589 @smallexample
1590 struct A @{ virtual void f(); int f1 : 1; @};
1591 struct B : public A @{ int f2 : 1; @};
1592 @end smallexample
1593
1594 @noindent
1595 In this case, G++ will place @code{B::f2} into the same byte
1596 as@code{A::f1}; other compilers will not.  You can avoid this problem
1597 by explicitly padding @code{A} so that its size is a multiple of the
1598 byte size on your platform; that will cause G++ and other compilers to
1599 layout @code{B} identically.
1600
1601 @item
1602 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1603 tail padding when laying out virtual bases.  For example:
1604
1605 @smallexample
1606 struct A @{ virtual void f(); char c1; @};
1607 struct B @{ B(); char c2; @};
1608 struct C : public A, public virtual B @{@};
1609 @end smallexample
1610
1611 @noindent
1612 In this case, G++ will not place @code{B} into the tail-padding for
1613 @code{A}; other compilers will.  You can avoid this problem by
1614 explicitly padding @code{A} so that its size is a multiple of its
1615 alignment (ignoring virtual base classes); that will cause G++ and other
1616 compilers to layout @code{C} identically.
1617
1618 @item
1619 Incorrect handling of bit-fields with declared widths greater than that
1620 of their underlying types, when the bit-fields appear in a union.  For
1621 example:
1622
1623 @smallexample
1624 union U @{ int i : 4096; @};
1625 @end smallexample
1626
1627 @noindent
1628 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1629 union too small by the number of bits in an @code{int}.
1630
1631 @item
1632 Empty classes can be placed at incorrect offsets.  For example:
1633
1634 @smallexample
1635 struct A @{@};
1636
1637 struct B @{
1638   A a;
1639   virtual void f ();
1640 @};
1641
1642 struct C : public B, public A @{@};
1643 @end smallexample
1644
1645 @noindent
1646 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1647 it should be placed at offset zero.  G++ mistakenly believes that the
1648 @code{A} data member of @code{B} is already at offset zero.
1649
1650 @item
1651 Names of template functions whose types involve @code{typename} or
1652 template template parameters can be mangled incorrectly.
1653
1654 @smallexample
1655 template <typename Q>
1656 void f(typename Q::X) @{@}
1657
1658 template <template <typename> class Q>
1659 void f(typename Q<int>::X) @{@}
1660 @end smallexample
1661
1662 @noindent
1663 Instantiations of these templates may be mangled incorrectly.
1664
1665 @end itemize
1666
1667 @item -Wctor-dtor-privacy @r{(C++ only)}
1668 @opindex Wctor-dtor-privacy
1669 Warn when a class seems unusable because all the constructors or
1670 destructors in that class are private, and it has neither friends nor
1671 public static member functions.
1672
1673 @item -Wnon-virtual-dtor @r{(C++ only)}
1674 @opindex Wnon-virtual-dtor
1675 Warn when a class appears to be polymorphic, thereby requiring a virtual
1676 destructor, yet it declares a non-virtual one.
1677 This warning is enabled by @option{-Wall}.
1678
1679 @item -Wreorder @r{(C++ only)}
1680 @opindex Wreorder
1681 @cindex reordering, warning
1682 @cindex warning for reordering of member initializers
1683 Warn when the order of member initializers given in the code does not
1684 match the order in which they must be executed.  For instance:
1685
1686 @smallexample
1687 struct A @{
1688   int i;
1689   int j;
1690   A(): j (0), i (1) @{ @}
1691 @};
1692 @end smallexample
1693
1694 The compiler will rearrange the member initializers for @samp{i}
1695 and @samp{j} to match the declaration order of the members, emitting
1696 a warning to that effect.  This warning is enabled by @option{-Wall}.
1697 @end table
1698
1699 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1700
1701 @table @gcctabopt
1702 @item -Weffc++ @r{(C++ only)}
1703 @opindex Weffc++
1704 Warn about violations of the following style guidelines from Scott Meyers'
1705 @cite{Effective C++} book:
1706
1707 @itemize @bullet
1708 @item
1709 Item 11:  Define a copy constructor and an assignment operator for classes
1710 with dynamically allocated memory.
1711
1712 @item
1713 Item 12:  Prefer initialization to assignment in constructors.
1714
1715 @item
1716 Item 14:  Make destructors virtual in base classes.
1717
1718 @item
1719 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1720
1721 @item
1722 Item 23:  Don't try to return a reference when you must return an object.
1723
1724 @end itemize
1725
1726 Also warn about violations of the following style guidelines from
1727 Scott Meyers' @cite{More Effective C++} book:
1728
1729 @itemize @bullet
1730 @item
1731 Item 6:  Distinguish between prefix and postfix forms of increment and
1732 decrement operators.
1733
1734 @item
1735 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1736
1737 @end itemize
1738
1739 When selecting this option, be aware that the standard library
1740 headers do not obey all of these guidelines; use @samp{grep -v}
1741 to filter out those warnings.
1742
1743 @item -Wno-deprecated @r{(C++ only)}
1744 @opindex Wno-deprecated
1745 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1746
1747 @item -Wstrict-null-sentinel @r{(C++ only)}
1748 @opindex Wstrict-null-sentinel
1749 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1750 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1751 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1752 it is guaranteed to of the same size as a pointer.  But this use is
1753 not portable across different compilers.
1754
1755 @item -Wno-non-template-friend @r{(C++ only)}
1756 @opindex Wno-non-template-friend
1757 Disable warnings when non-templatized friend functions are declared
1758 within a template.  Since the advent of explicit template specification
1759 support in G++, if the name of the friend is an unqualified-id (i.e.,
1760 @samp{friend foo(int)}), the C++ language specification demands that the
1761 friend declare or define an ordinary, nontemplate function.  (Section
1762 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1763 could be interpreted as a particular specialization of a templatized
1764 function.  Because this non-conforming behavior is no longer the default
1765 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1766 check existing code for potential trouble spots and is on by default.
1767 This new compiler behavior can be turned off with
1768 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1769 but disables the helpful warning.
1770
1771 @item -Wold-style-cast @r{(C++ only)}
1772 @opindex Wold-style-cast
1773 Warn if an old-style (C-style) cast to a non-void type is used within
1774 a C++ program.  The new-style casts (@samp{static_cast},
1775 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1776 unintended effects and much easier to search for.
1777
1778 @item -Woverloaded-virtual @r{(C++ only)}
1779 @opindex Woverloaded-virtual
1780 @cindex overloaded virtual fn, warning
1781 @cindex warning for overloaded virtual fn
1782 Warn when a function declaration hides virtual functions from a
1783 base class.  For example, in:
1784
1785 @smallexample
1786 struct A @{
1787   virtual void f();
1788 @};
1789
1790 struct B: public A @{
1791   void f(int);
1792 @};
1793 @end smallexample
1794
1795 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1796 like:
1797
1798 @smallexample
1799 B* b;
1800 b->f();
1801 @end smallexample
1802
1803 will fail to compile.
1804
1805 @item -Wno-pmf-conversions @r{(C++ only)}
1806 @opindex Wno-pmf-conversions
1807 Disable the diagnostic for converting a bound pointer to member function
1808 to a plain pointer.
1809
1810 @item -Wsign-promo @r{(C++ only)}
1811 @opindex Wsign-promo
1812 Warn when overload resolution chooses a promotion from unsigned or
1813 enumerated type to a signed type, over a conversion to an unsigned type of
1814 the same size.  Previous versions of G++ would try to preserve
1815 unsignedness, but the standard mandates the current behavior.
1816
1817 @smallexample
1818 struct A @{
1819   operator int ();
1820   A& operator = (int);
1821 @};
1822
1823 main ()
1824 @{
1825   A a,b;
1826   a = b;
1827 @}
1828 @end smallexample
1829
1830 In this example, G++ will synthesize a default @samp{A& operator =
1831 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1832 @end table
1833
1834 @node Objective-C and Objective-C++ Dialect Options
1835 @section Options Controlling Objective-C and Objective-C++ Dialects
1836
1837 @cindex compiler options, Objective-C and Objective-C++
1838 @cindex Objective-C and Objective-C++ options, command line
1839 @cindex options, Objective-C and Objective-C++
1840 (NOTE: This manual does not describe the Objective-C and Objective-C++
1841 languages themselves.  See @xref{Standards,,Language Standards
1842 Supported by GCC}, for references.)
1843
1844 This section describes the command-line options that are only meaningful
1845 for Objective-C and Objective-C++ programs, but you can also use most of
1846 the language-independent GNU compiler options.
1847 For example, you might compile a file @code{some_class.m} like this:
1848
1849 @smallexample
1850 gcc -g -fgnu-runtime -O -c some_class.m
1851 @end smallexample
1852
1853 @noindent
1854 In this example, @option{-fgnu-runtime} is an option meant only for
1855 Objective-C and Objective-C++ programs; you can use the other options with
1856 any language supported by GCC@.
1857
1858 Note that since Objective-C is an extension of the C language, Objective-C
1859 compilations may also use options specific to the C front-end (e.g.,
1860 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1861 C++-specific options (e.g., @option{-Wabi}).
1862
1863 Here is a list of options that are @emph{only} for compiling Objective-C
1864 and Objective-C++ programs:
1865
1866 @table @gcctabopt
1867 @item -fconstant-string-class=@var{class-name}
1868 @opindex fconstant-string-class
1869 Use @var{class-name} as the name of the class to instantiate for each
1870 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1871 class name is @code{NXConstantString} if the GNU runtime is being used, and
1872 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1873 @option{-fconstant-cfstrings} option, if also present, will override the
1874 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1875 to be laid out as constant CoreFoundation strings.
1876
1877 @item -fgnu-runtime
1878 @opindex fgnu-runtime
1879 Generate object code compatible with the standard GNU Objective-C
1880 runtime.  This is the default for most types of systems.
1881
1882 @item -fnext-runtime
1883 @opindex fnext-runtime
1884 Generate output compatible with the NeXT runtime.  This is the default
1885 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1886 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1887 used.
1888
1889 @item -fno-nil-receivers
1890 @opindex fno-nil-receivers
1891 Assume that all Objective-C message dispatches (e.g.,
1892 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1893 is not @code{nil}.  This allows for more efficient entry points in the runtime
1894 to be used.  Currently, this option is only available in conjunction with
1895 the NeXT runtime on Mac OS X 10.3 and later.
1896
1897 @item -fobjc-exceptions
1898 @opindex fobjc-exceptions
1899 Enable syntactic support for structured exception handling in Objective-C,
1900 similar to what is offered by C++ and Java.  Currently, this option is only
1901 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1902
1903 @smallexample
1904   @@try @{
1905     @dots{}
1906        @@throw expr;
1907     @dots{}
1908   @}
1909   @@catch (AnObjCClass *exc) @{
1910     @dots{}
1911       @@throw expr;
1912     @dots{}
1913       @@throw;
1914     @dots{}
1915   @}
1916   @@catch (AnotherClass *exc) @{
1917     @dots{}
1918   @}
1919   @@catch (id allOthers) @{
1920     @dots{}
1921   @}
1922   @@finally @{
1923     @dots{}
1924       @@throw expr;
1925     @dots{}
1926   @}
1927 @end smallexample
1928
1929 The @code{@@throw} statement may appear anywhere in an Objective-C or
1930 Objective-C++ program; when used inside of a @code{@@catch} block, the
1931 @code{@@throw} may appear without an argument (as shown above), in which case
1932 the object caught by the @code{@@catch} will be rethrown.
1933
1934 Note that only (pointers to) Objective-C objects may be thrown and
1935 caught using this scheme.  When an object is thrown, it will be caught
1936 by the nearest @code{@@catch} clause capable of handling objects of that type,
1937 analogously to how @code{catch} blocks work in C++ and Java.  A
1938 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1939 any and all Objective-C exceptions not caught by previous @code{@@catch}
1940 clauses (if any).
1941
1942 The @code{@@finally} clause, if present, will be executed upon exit from the
1943 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1944 regardless of whether any exceptions are thrown, caught or rethrown
1945 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1946 of the @code{finally} clause in Java.
1947
1948 There are several caveats to using the new exception mechanism:
1949
1950 @itemize @bullet
1951 @item
1952 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1953 idioms provided by the @code{NSException} class, the new
1954 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1955 systems, due to additional functionality needed in the (NeXT) Objective-C
1956 runtime.
1957
1958 @item
1959 As mentioned above, the new exceptions do not support handling
1960 types other than Objective-C objects.   Furthermore, when used from
1961 Objective-C++, the Objective-C exception model does not interoperate with C++
1962 exceptions at this time.  This means you cannot @code{@@throw} an exception
1963 from Objective-C and @code{catch} it in C++, or vice versa
1964 (i.e., @code{throw @dots{} @@catch}).
1965 @end itemize
1966
1967 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1968 blocks for thread-safe execution:
1969
1970 @smallexample
1971   @@synchronized (ObjCClass *guard) @{
1972     @dots{}
1973   @}
1974 @end smallexample
1975
1976 Upon entering the @code{@@synchronized} block, a thread of execution shall
1977 first check whether a lock has been placed on the corresponding @code{guard}
1978 object by another thread.  If it has, the current thread shall wait until
1979 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1980 the current thread will place its own lock on it, execute the code contained in
1981 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1982 making @code{guard} available to other threads).
1983
1984 Unlike Java, Objective-C does not allow for entire methods to be marked
1985 @code{@@synchronized}.  Note that throwing exceptions out of
1986 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1987 to be unlocked properly.
1988
1989 @item -freplace-objc-classes
1990 @opindex freplace-objc-classes
1991 Emit a special marker instructing @command{ld(1)} not to statically link in
1992 the resulting object file, and allow @command{dyld(1)} to load it in at
1993 run time instead.  This is used in conjunction with the Fix-and-Continue
1994 debugging mode, where the object file in question may be recompiled and
1995 dynamically reloaded in the course of program execution, without the need
1996 to restart the program itself.  Currently, Fix-and-Continue functionality
1997 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1998 and later.
1999
2000 @item -fzero-link
2001 @opindex fzero-link
2002 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2003 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2004 compile time) with static class references that get initialized at load time,
2005 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2006 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2007 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2008 for individual class implementations to be modified during program execution.
2009
2010 @item -gen-decls
2011 @opindex gen-decls
2012 Dump interface declarations for all classes seen in the source file to a
2013 file named @file{@var{sourcename}.decl}.
2014
2015 @item -Wno-protocol
2016 @opindex Wno-protocol
2017 If a class is declared to implement a protocol, a warning is issued for
2018 every method in the protocol that is not implemented by the class.  The
2019 default behavior is to issue a warning for every method not explicitly
2020 implemented in the class, even if a method implementation is inherited
2021 from the superclass.  If you use the @option{-Wno-protocol} option, then
2022 methods inherited from the superclass are considered to be implemented,
2023 and no warning is issued for them.
2024
2025 @item -Wselector
2026 @opindex Wselector
2027 Warn if multiple methods of different types for the same selector are
2028 found during compilation.  The check is performed on the list of methods
2029 in the final stage of compilation.  Additionally, a check is performed
2030 for each selector appearing in a @code{@@selector(@dots{})}
2031 expression, and a corresponding method for that selector has been found
2032 during compilation.  Because these checks scan the method table only at
2033 the end of compilation, these warnings are not produced if the final
2034 stage of compilation is not reached, for example because an error is
2035 found during compilation, or because the @option{-fsyntax-only} option is
2036 being used.
2037
2038 @item -Wundeclared-selector
2039 @opindex Wundeclared-selector
2040 Warn if a @code{@@selector(@dots{})} expression referring to an
2041 undeclared selector is found.  A selector is considered undeclared if no
2042 method with that name has been declared before the
2043 @code{@@selector(@dots{})} expression, either explicitly in an
2044 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2045 an @code{@@implementation} section.  This option always performs its
2046 checks as soon as a @code{@@selector(@dots{})} expression is found,
2047 while @option{-Wselector} only performs its checks in the final stage of
2048 compilation.  This also enforces the coding style convention
2049 that methods and selectors must be declared before being used.
2050
2051 @item -print-objc-runtime-info
2052 @opindex print-objc-runtime-info
2053 Generate C header describing the largest structure that is passed by
2054 value, if any.
2055
2056 @end table
2057
2058 @node Language Independent Options
2059 @section Options to Control Diagnostic Messages Formatting
2060 @cindex options to control diagnostics formatting
2061 @cindex diagnostic messages
2062 @cindex message formatting
2063
2064 Traditionally, diagnostic messages have been formatted irrespective of
2065 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2066 below can be used to control the diagnostic messages formatting
2067 algorithm, e.g.@: how many characters per line, how often source location
2068 information should be reported.  Right now, only the C++ front end can
2069 honor these options.  However it is expected, in the near future, that
2070 the remaining front ends would be able to digest them correctly.
2071
2072 @table @gcctabopt
2073 @item -fmessage-length=@var{n}
2074 @opindex fmessage-length
2075 Try to format error messages so that they fit on lines of about @var{n}
2076 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2077 the front ends supported by GCC@.  If @var{n} is zero, then no
2078 line-wrapping will be done; each error message will appear on a single
2079 line.
2080
2081 @opindex fdiagnostics-show-location
2082 @item -fdiagnostics-show-location=once
2083 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2084 reporter to emit @emph{once} source location information; that is, in
2085 case the message is too long to fit on a single physical line and has to
2086 be wrapped, the source location won't be emitted (as prefix) again,
2087 over and over, in subsequent continuation lines.  This is the default
2088 behavior.
2089
2090 @item -fdiagnostics-show-location=every-line
2091 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2092 messages reporter to emit the same source location information (as
2093 prefix) for physical lines that result from the process of breaking
2094 a message which is too long to fit on a single line.
2095
2096 @item -fdiagnostics-show-options
2097 @opindex fdiagnostics-show-options
2098 This option instructs the diagnostic machinery to add text to each
2099 diagnostic emitted, which indicates which command line option directly
2100 controls that diagnostic, when such an option is known to the
2101 diagnostic machinery.
2102
2103 @end table
2104
2105 @node Warning Options
2106 @section Options to Request or Suppress Warnings
2107 @cindex options to control warnings
2108 @cindex warning messages
2109 @cindex messages, warning
2110 @cindex suppressing warnings
2111
2112 Warnings are diagnostic messages that report constructions which
2113 are not inherently erroneous but which are risky or suggest there
2114 may have been an error.
2115
2116 You can request many specific warnings with options beginning @samp{-W},
2117 for example @option{-Wimplicit} to request warnings on implicit
2118 declarations.  Each of these specific warning options also has a
2119 negative form beginning @samp{-Wno-} to turn off warnings;
2120 for example, @option{-Wno-implicit}.  This manual lists only one of the
2121 two forms, whichever is not the default.
2122
2123 The following options control the amount and kinds of warnings produced
2124 by GCC; for further, language-specific options also refer to
2125 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2126 Options}.
2127
2128 @table @gcctabopt
2129 @cindex syntax checking
2130 @item -fsyntax-only
2131 @opindex fsyntax-only
2132 Check the code for syntax errors, but don't do anything beyond that.
2133
2134 @item -pedantic
2135 @opindex pedantic
2136 Issue all the warnings demanded by strict ISO C and ISO C++;
2137 reject all programs that use forbidden extensions, and some other
2138 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2139 version of the ISO C standard specified by any @option{-std} option used.
2140
2141 Valid ISO C and ISO C++ programs should compile properly with or without
2142 this option (though a rare few will require @option{-ansi} or a
2143 @option{-std} option specifying the required version of ISO C)@.  However,
2144 without this option, certain GNU extensions and traditional C and C++
2145 features are supported as well.  With this option, they are rejected.
2146
2147 @option{-pedantic} does not cause warning messages for use of the
2148 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2149 warnings are also disabled in the expression that follows
2150 @code{__extension__}.  However, only system header files should use
2151 these escape routes; application programs should avoid them.
2152 @xref{Alternate Keywords}.
2153
2154 Some users try to use @option{-pedantic} to check programs for strict ISO
2155 C conformance.  They soon find that it does not do quite what they want:
2156 it finds some non-ISO practices, but not all---only those for which
2157 ISO C @emph{requires} a diagnostic, and some others for which
2158 diagnostics have been added.
2159
2160 A feature to report any failure to conform to ISO C might be useful in
2161 some instances, but would require considerable additional work and would
2162 be quite different from @option{-pedantic}.  We don't have plans to
2163 support such a feature in the near future.
2164
2165 Where the standard specified with @option{-std} represents a GNU
2166 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2167 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2168 extended dialect is based.  Warnings from @option{-pedantic} are given
2169 where they are required by the base standard.  (It would not make sense
2170 for such warnings to be given only for features not in the specified GNU
2171 C dialect, since by definition the GNU dialects of C include all
2172 features the compiler supports with the given option, and there would be
2173 nothing to warn about.)
2174
2175 @item -pedantic-errors
2176 @opindex pedantic-errors
2177 Like @option{-pedantic}, except that errors are produced rather than
2178 warnings.
2179
2180 @item -w
2181 @opindex w
2182 Inhibit all warning messages.
2183
2184 @item -Wno-import
2185 @opindex Wno-import
2186 Inhibit warning messages about the use of @samp{#import}.
2187
2188 @item -Wchar-subscripts
2189 @opindex Wchar-subscripts
2190 Warn if an array subscript has type @code{char}.  This is a common cause
2191 of error, as programmers often forget that this type is signed on some
2192 machines.
2193 This warning is enabled by @option{-Wall}.
2194
2195 @item -Wcomment
2196 @opindex Wcomment
2197 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2198 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2199 This warning is enabled by @option{-Wall}.
2200
2201 @item -Wfatal-errors
2202 @opindex Wfatal-errors
2203 This option causes the compiler to abort compilation on the first error
2204 occurred rather than trying to keep going and printing further error
2205 messages.
2206
2207 @item -Wformat
2208 @opindex Wformat
2209 @opindex ffreestanding
2210 @opindex fno-builtin
2211 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2212 the arguments supplied have types appropriate to the format string
2213 specified, and that the conversions specified in the format string make
2214 sense.  This includes standard functions, and others specified by format
2215 attributes (@pxref{Function Attributes}), in the @code{printf},
2216 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2217 not in the C standard) families (or other target-specific families).
2218 Which functions are checked without format attributes having been
2219 specified depends on the standard version selected, and such checks of
2220 functions without the attribute specified are disabled by
2221 @option{-ffreestanding} or @option{-fno-builtin}.
2222
2223 The formats are checked against the format features supported by GNU
2224 libc version 2.2.  These include all ISO C90 and C99 features, as well
2225 as features from the Single Unix Specification and some BSD and GNU
2226 extensions.  Other library implementations may not support all these
2227 features; GCC does not support warning about features that go beyond a
2228 particular library's limitations.  However, if @option{-pedantic} is used
2229 with @option{-Wformat}, warnings will be given about format features not
2230 in the selected standard version (but not for @code{strfmon} formats,
2231 since those are not in any version of the C standard).  @xref{C Dialect
2232 Options,,Options Controlling C Dialect}.
2233
2234 Since @option{-Wformat} also checks for null format arguments for
2235 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2236
2237 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2238 aspects of format checking, the options @option{-Wformat-y2k},
2239 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2240 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2241 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2242
2243 @item -Wformat-y2k
2244 @opindex Wformat-y2k
2245 If @option{-Wformat} is specified, also warn about @code{strftime}
2246 formats which may yield only a two-digit year.
2247
2248 @item -Wno-format-extra-args
2249 @opindex Wno-format-extra-args
2250 If @option{-Wformat} is specified, do not warn about excess arguments to a
2251 @code{printf} or @code{scanf} format function.  The C standard specifies
2252 that such arguments are ignored.
2253
2254 Where the unused arguments lie between used arguments that are
2255 specified with @samp{$} operand number specifications, normally
2256 warnings are still given, since the implementation could not know what
2257 type to pass to @code{va_arg} to skip the unused arguments.  However,
2258 in the case of @code{scanf} formats, this option will suppress the
2259 warning if the unused arguments are all pointers, since the Single
2260 Unix Specification says that such unused arguments are allowed.
2261
2262 @item -Wno-format-zero-length
2263 @opindex Wno-format-zero-length
2264 If @option{-Wformat} is specified, do not warn about zero-length formats.
2265 The C standard specifies that zero-length formats are allowed.
2266
2267 @item -Wformat-nonliteral
2268 @opindex Wformat-nonliteral
2269 If @option{-Wformat} is specified, also warn if the format string is not a
2270 string literal and so cannot be checked, unless the format function
2271 takes its format arguments as a @code{va_list}.
2272
2273 @item -Wformat-security
2274 @opindex Wformat-security
2275 If @option{-Wformat} is specified, also warn about uses of format
2276 functions that represent possible security problems.  At present, this
2277 warns about calls to @code{printf} and @code{scanf} functions where the
2278 format string is not a string literal and there are no format arguments,
2279 as in @code{printf (foo);}.  This may be a security hole if the format
2280 string came from untrusted input and contains @samp{%n}.  (This is
2281 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2282 in future warnings may be added to @option{-Wformat-security} that are not
2283 included in @option{-Wformat-nonliteral}.)
2284
2285 @item -Wformat=2
2286 @opindex Wformat=2
2287 Enable @option{-Wformat} plus format checks not included in
2288 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2289 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2290
2291 @item -Wnonnull
2292 @opindex Wnonnull
2293 Warn about passing a null pointer for arguments marked as
2294 requiring a non-null value by the @code{nonnull} function attribute.
2295
2296 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2297 can be disabled with the @option{-Wno-nonnull} option.
2298
2299 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2300 @opindex Winit-self
2301 Warn about uninitialized variables which are initialized with themselves.
2302 Note this option can only be used with the @option{-Wuninitialized} option,
2303 which in turn only works with @option{-O1} and above.
2304
2305 For example, GCC will warn about @code{i} being uninitialized in the
2306 following snippet only when @option{-Winit-self} has been specified:
2307 @smallexample
2308 @group
2309 int f()
2310 @{
2311   int i = i;
2312   return i;
2313 @}
2314 @end group
2315 @end smallexample
2316
2317 @item -Wimplicit-int
2318 @opindex Wimplicit-int
2319 Warn when a declaration does not specify a type.
2320 This warning is enabled by @option{-Wall}.
2321
2322 @item -Wimplicit-function-declaration
2323 @itemx -Werror-implicit-function-declaration
2324 @opindex Wimplicit-function-declaration
2325 @opindex Werror-implicit-function-declaration
2326 Give a warning (or error) whenever a function is used before being
2327 declared.  The form @option{-Wno-error-implicit-function-declaration}
2328 is not supported.
2329 This warning is enabled by @option{-Wall} (as a warning, not an error).
2330
2331 @item -Wimplicit
2332 @opindex Wimplicit
2333 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2334 This warning is enabled by @option{-Wall}.
2335
2336 @item -Wmain
2337 @opindex Wmain
2338 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2339 function with external linkage, returning int, taking either zero
2340 arguments, two, or three arguments of appropriate types.
2341 This warning is enabled by @option{-Wall}.
2342
2343 @item -Wmissing-braces
2344 @opindex Wmissing-braces
2345 Warn if an aggregate or union initializer is not fully bracketed.  In
2346 the following example, the initializer for @samp{a} is not fully
2347 bracketed, but that for @samp{b} is fully bracketed.
2348
2349 @smallexample
2350 int a[2][2] = @{ 0, 1, 2, 3 @};
2351 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2352 @end smallexample
2353
2354 This warning is enabled by @option{-Wall}.
2355
2356 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2357 @opindex Wmissing-include-dirs
2358 Warn if a user-supplied include directory does not exist.
2359
2360 @item -Wparentheses
2361 @opindex Wparentheses
2362 Warn if parentheses are omitted in certain contexts, such
2363 as when there is an assignment in a context where a truth value
2364 is expected, or when operators are nested whose precedence people
2365 often get confused about.  Only the warning for an assignment used as
2366 a truth value is supported when compiling C++; the other warnings are
2367 only supported when compiling C@.
2368
2369 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2370 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2371 interpretation from that of ordinary mathematical notation.
2372
2373 Also warn about constructions where there may be confusion to which
2374 @code{if} statement an @code{else} branch belongs.  Here is an example of
2375 such a case:
2376
2377 @smallexample
2378 @group
2379 @{
2380   if (a)
2381     if (b)
2382       foo ();
2383   else
2384     bar ();
2385 @}
2386 @end group
2387 @end smallexample
2388
2389 In C, every @code{else} branch belongs to the innermost possible @code{if}
2390 statement, which in this example is @code{if (b)}.  This is often not
2391 what the programmer expected, as illustrated in the above example by
2392 indentation the programmer chose.  When there is the potential for this
2393 confusion, GCC will issue a warning when this flag is specified.
2394 To eliminate the warning, add explicit braces around the innermost
2395 @code{if} statement so there is no way the @code{else} could belong to
2396 the enclosing @code{if}.  The resulting code would look like this:
2397
2398 @smallexample
2399 @group
2400 @{
2401   if (a)
2402     @{
2403       if (b)
2404         foo ();
2405       else
2406         bar ();
2407     @}
2408 @}
2409 @end group
2410 @end smallexample
2411
2412 This warning is enabled by @option{-Wall}.
2413
2414 @item -Wsequence-point
2415 @opindex Wsequence-point
2416 Warn about code that may have undefined semantics because of violations
2417 of sequence point rules in the C standard.
2418
2419 The C standard defines the order in which expressions in a C program are
2420 evaluated in terms of @dfn{sequence points}, which represent a partial
2421 ordering between the execution of parts of the program: those executed
2422 before the sequence point, and those executed after it.  These occur
2423 after the evaluation of a full expression (one which is not part of a
2424 larger expression), after the evaluation of the first operand of a
2425 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2426 function is called (but after the evaluation of its arguments and the
2427 expression denoting the called function), and in certain other places.
2428 Other than as expressed by the sequence point rules, the order of
2429 evaluation of subexpressions of an expression is not specified.  All
2430 these rules describe only a partial order rather than a total order,
2431 since, for example, if two functions are called within one expression
2432 with no sequence point between them, the order in which the functions
2433 are called is not specified.  However, the standards committee have
2434 ruled that function calls do not overlap.
2435
2436 It is not specified when between sequence points modifications to the
2437 values of objects take effect.  Programs whose behavior depends on this
2438 have undefined behavior; the C standard specifies that ``Between the
2439 previous and next sequence point an object shall have its stored value
2440 modified at most once by the evaluation of an expression.  Furthermore,
2441 the prior value shall be read only to determine the value to be
2442 stored.''.  If a program breaks these rules, the results on any
2443 particular implementation are entirely unpredictable.
2444
2445 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2446 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2447 diagnosed by this option, and it may give an occasional false positive
2448 result, but in general it has been found fairly effective at detecting
2449 this sort of problem in programs.
2450
2451 The present implementation of this option only works for C programs.  A
2452 future implementation may also work for C++ programs.
2453
2454 The C standard is worded confusingly, therefore there is some debate
2455 over the precise meaning of the sequence point rules in subtle cases.
2456 Links to discussions of the problem, including proposed formal
2457 definitions, may be found on the GCC readings page, at
2458 @w{@uref{http://gcc.gnu.org/readings.html}}.
2459
2460 This warning is enabled by @option{-Wall}.
2461
2462 @item -Wreturn-type
2463 @opindex Wreturn-type
2464 Warn whenever a function is defined with a return-type that defaults to
2465 @code{int}.  Also warn about any @code{return} statement with no
2466 return-value in a function whose return-type is not @code{void}.
2467
2468 For C, also warn if the return type of a function has a type qualifier
2469 such as @code{const}.  Such a type qualifier has no effect, since the
2470 value returned by a function is not an lvalue.  ISO C prohibits
2471 qualified @code{void} return types on function definitions, so such
2472 return types always receive a warning even without this option.
2473
2474 For C++, a function without return type always produces a diagnostic
2475 message, even when @option{-Wno-return-type} is specified.  The only
2476 exceptions are @samp{main} and functions defined in system headers.
2477
2478 This warning is enabled by @option{-Wall}.
2479
2480 @item -Wswitch
2481 @opindex Wswitch
2482 Warn whenever a @code{switch} statement has an index of enumerated type
2483 and lacks a @code{case} for one or more of the named codes of that
2484 enumeration.  (The presence of a @code{default} label prevents this
2485 warning.)  @code{case} labels outside the enumeration range also
2486 provoke warnings when this option is used.
2487 This warning is enabled by @option{-Wall}.
2488
2489 @item -Wswitch-default
2490 @opindex Wswitch-switch
2491 Warn whenever a @code{switch} statement does not have a @code{default}
2492 case.
2493
2494 @item -Wswitch-enum
2495 @opindex Wswitch-enum
2496 Warn whenever a @code{switch} statement has an index of enumerated type
2497 and lacks a @code{case} for one or more of the named codes of that
2498 enumeration.  @code{case} labels outside the enumeration range also
2499 provoke warnings when this option is used.
2500
2501 @item -Wtrigraphs
2502 @opindex Wtrigraphs
2503 Warn if any trigraphs are encountered that might change the meaning of
2504 the program (trigraphs within comments are not warned about).
2505 This warning is enabled by @option{-Wall}.
2506
2507 @item -Wunused-function
2508 @opindex Wunused-function
2509 Warn whenever a static function is declared but not defined or a
2510 non\-inline static function is unused.
2511 This warning is enabled by @option{-Wall}.
2512
2513 @item -Wunused-label
2514 @opindex Wunused-label
2515 Warn whenever a label is declared but not used.
2516 This warning is enabled by @option{-Wall}.
2517
2518 To suppress this warning use the @samp{unused} attribute
2519 (@pxref{Variable Attributes}).
2520
2521 @item -Wunused-parameter
2522 @opindex Wunused-parameter
2523 Warn whenever a function parameter is unused aside from its declaration.
2524
2525 To suppress this warning use the @samp{unused} attribute
2526 (@pxref{Variable Attributes}).
2527
2528 @item -Wunused-variable
2529 @opindex Wunused-variable
2530 Warn whenever a local variable or non-constant static variable is unused
2531 aside from its declaration
2532 This warning is enabled by @option{-Wall}.
2533
2534 To suppress this warning use the @samp{unused} attribute
2535 (@pxref{Variable Attributes}).
2536
2537 @item -Wunused-value
2538 @opindex Wunused-value
2539 Warn whenever a statement computes a result that is explicitly not used.
2540 This warning is enabled by @option{-Wall}.
2541
2542 To suppress this warning cast the expression to @samp{void}.
2543
2544 @item -Wunused
2545 @opindex Wunused
2546 All the above @option{-Wunused} options combined.
2547
2548 In order to get a warning about an unused function parameter, you must
2549 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2550 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2551
2552 @item -Wuninitialized
2553 @opindex Wuninitialized
2554 Warn if an automatic variable is used without first being initialized or
2555 if a variable may be clobbered by a @code{setjmp} call.
2556
2557 These warnings are possible only in optimizing compilation,
2558 because they require data flow information that is computed only
2559 when optimizing.  If you don't specify @option{-O}, you simply won't
2560 get these warnings.
2561
2562 If you want to warn about code which uses the uninitialized value of the
2563 variable in its own initializer, use the @option{-Winit-self} option.
2564
2565 These warnings occur only for variables that are candidates for
2566 register allocation.  Therefore, they do not occur for a variable that
2567 is declared @code{volatile}, or whose address is taken, or whose size
2568 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2569 structures, unions or arrays, even when they are in registers.
2570
2571 Note that there may be no warning about a variable that is used only
2572 to compute a value that itself is never used, because such
2573 computations may be deleted by data flow analysis before the warnings
2574 are printed.
2575
2576 These warnings are made optional because GCC is not smart
2577 enough to see all the reasons why the code might be correct
2578 despite appearing to have an error.  Here is one example of how
2579 this can happen:
2580
2581 @smallexample
2582 @group
2583 @{
2584   int x;
2585   switch (y)
2586     @{
2587     case 1: x = 1;
2588       break;
2589     case 2: x = 4;
2590       break;
2591     case 3: x = 5;
2592     @}
2593   foo (x);
2594 @}
2595 @end group
2596 @end smallexample
2597
2598 @noindent
2599 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2600 always initialized, but GCC doesn't know this.  Here is
2601 another common case:
2602
2603 @smallexample
2604 @{
2605   int save_y;
2606   if (change_y) save_y = y, y = new_y;
2607   @dots{}
2608   if (change_y) y = save_y;
2609 @}
2610 @end smallexample
2611
2612 @noindent
2613 This has no bug because @code{save_y} is used only if it is set.
2614
2615 @cindex @code{longjmp} warnings
2616 This option also warns when a non-volatile automatic variable might be
2617 changed by a call to @code{longjmp}.  These warnings as well are possible
2618 only in optimizing compilation.
2619
2620 The compiler sees only the calls to @code{setjmp}.  It cannot know
2621 where @code{longjmp} will be called; in fact, a signal handler could
2622 call it at any point in the code.  As a result, you may get a warning
2623 even when there is in fact no problem because @code{longjmp} cannot
2624 in fact be called at the place which would cause a problem.
2625
2626 Some spurious warnings can be avoided if you declare all the functions
2627 you use that never return as @code{noreturn}.  @xref{Function
2628 Attributes}.
2629
2630 This warning is enabled by @option{-Wall}.
2631
2632 @item -Wunknown-pragmas
2633 @opindex Wunknown-pragmas
2634 @cindex warning for unknown pragmas
2635 @cindex unknown pragmas, warning
2636 @cindex pragmas, warning of unknown
2637 Warn when a #pragma directive is encountered which is not understood by
2638 GCC@.  If this command line option is used, warnings will even be issued
2639 for unknown pragmas in system header files.  This is not the case if
2640 the warnings were only enabled by the @option{-Wall} command line option.
2641
2642 @item -Wstrict-aliasing
2643 @opindex Wstrict-aliasing
2644 This option is only active when @option{-fstrict-aliasing} is active.
2645 It warns about code which might break the strict aliasing rules that the
2646 compiler is using for optimization.  The warning does not catch all
2647 cases, but does attempt to catch the more common pitfalls.  It is
2648 included in @option{-Wall}.
2649
2650 @item -Wstrict-aliasing=2
2651 @opindex Wstrict-aliasing=2
2652 This option is only active when @option{-fstrict-aliasing} is active.
2653 It warns about all code which might break the strict aliasing rules that the
2654 compiler is using for optimization.  This warning catches all cases, but
2655 it will also give a warning for some ambiguous cases that are safe.
2656
2657 @item -Wall
2658 @opindex Wall
2659 All of the above @samp{-W} options combined.  This enables all the
2660 warnings about constructions that some users consider questionable, and
2661 that are easy to avoid (or modify to prevent the warning), even in
2662 conjunction with macros.  This also enables some language-specific
2663 warnings described in @ref{C++ Dialect Options} and
2664 @ref{Objective-C and Objective-C++ Dialect Options}.
2665 @end table
2666
2667 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2668 Some of them warn about constructions that users generally do not
2669 consider questionable, but which occasionally you might wish to check
2670 for; others warn about constructions that are necessary or hard to avoid
2671 in some cases, and there is no simple way to modify the code to suppress
2672 the warning.
2673
2674 @table @gcctabopt
2675 @item -Wextra
2676 @opindex W
2677 @opindex Wextra
2678 (This option used to be called @option{-W}.  The older name is still
2679 supported, but the newer name is more descriptive.)  Print extra warning
2680 messages for these events:
2681
2682 @itemize @bullet
2683 @item
2684 A function can return either with or without a value.  (Falling
2685 off the end of the function body is considered returning without
2686 a value.)  For example, this function would evoke such a
2687 warning:
2688
2689 @smallexample
2690 @group
2691 foo (a)
2692 @{
2693   if (a > 0)
2694     return a;
2695 @}
2696 @end group
2697 @end smallexample
2698
2699 @item
2700 An expression-statement or the left-hand side of a comma expression
2701 contains no side effects.
2702 To suppress the warning, cast the unused expression to void.
2703 For example, an expression such as @samp{x[i,j]} will cause a warning,
2704 but @samp{x[(void)i,j]} will not.
2705
2706 @item
2707 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2708
2709 @item
2710 Storage-class specifiers like @code{static} are not the first things in
2711 a declaration.  According to the C Standard, this usage is obsolescent.
2712
2713 @item
2714 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2715 arguments.
2716
2717 @item
2718 A comparison between signed and unsigned values could produce an
2719 incorrect result when the signed value is converted to unsigned.
2720 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2721
2722 @item
2723 An aggregate has an initializer which does not initialize all members.
2724 This warning can be independently controlled by
2725 @option{-Wmissing-field-initializers}.
2726
2727 @item
2728 A function parameter is declared without a type specifier in K&R-style
2729 functions:
2730
2731 @smallexample
2732 void foo(bar) @{ @}
2733 @end smallexample
2734
2735 @item
2736 An empty body occurs in an @samp{if} or @samp{else} statement.
2737
2738 @item
2739 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2740 @samp{>}, or @samp{>=}.
2741
2742 @item
2743 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2744
2745 @item
2746 Any of several floating-point events that often indicate errors, such as
2747 overflow, underflow, loss of precision, etc.
2748
2749 @item @r{(C++ only)}
2750 An enumerator and a non-enumerator both appear in a conditional expression.
2751
2752 @item @r{(C++ only)}
2753 A non-static reference or non-static @samp{const} member appears in a
2754 class without constructors.
2755
2756 @item @r{(C++ only)}
2757 Ambiguous virtual bases.
2758
2759 @item @r{(C++ only)}
2760 Subscripting an array which has been declared @samp{register}.
2761
2762 @item @r{(C++ only)}
2763 Taking the address of a variable which has been declared @samp{register}.
2764
2765 @item @r{(C++ only)}
2766 A base class is not initialized in a derived class' copy constructor.
2767 @end itemize
2768
2769 @item -Wno-div-by-zero
2770 @opindex Wno-div-by-zero
2771 @opindex Wdiv-by-zero
2772 Do not warn about compile-time integer division by zero.  Floating point
2773 division by zero is not warned about, as it can be a legitimate way of
2774 obtaining infinities and NaNs.
2775
2776 @item -Wsystem-headers
2777 @opindex Wsystem-headers
2778 @cindex warnings from system headers
2779 @cindex system headers, warnings from
2780 Print warning messages for constructs found in system header files.
2781 Warnings from system headers are normally suppressed, on the assumption
2782 that they usually do not indicate real problems and would only make the
2783 compiler output harder to read.  Using this command line option tells
2784 GCC to emit warnings from system headers as if they occurred in user
2785 code.  However, note that using @option{-Wall} in conjunction with this
2786 option will @emph{not} warn about unknown pragmas in system
2787 headers---for that, @option{-Wunknown-pragmas} must also be used.
2788
2789 @item -Wfloat-equal
2790 @opindex Wfloat-equal
2791 Warn if floating point values are used in equality comparisons.
2792
2793 The idea behind this is that sometimes it is convenient (for the
2794 programmer) to consider floating-point values as approximations to
2795 infinitely precise real numbers.  If you are doing this, then you need
2796 to compute (by analyzing the code, or in some other way) the maximum or
2797 likely maximum error that the computation introduces, and allow for it
2798 when performing comparisons (and when producing output, but that's a
2799 different problem).  In particular, instead of testing for equality, you
2800 would check to see whether the two values have ranges that overlap; and
2801 this is done with the relational operators, so equality comparisons are
2802 probably mistaken.
2803
2804 @item -Wtraditional @r{(C only)}
2805 @opindex Wtraditional
2806 Warn about certain constructs that behave differently in traditional and
2807 ISO C@.  Also warn about ISO C constructs that have no traditional C
2808 equivalent, and/or problematic constructs which should be avoided.
2809
2810 @itemize @bullet
2811 @item
2812 Macro parameters that appear within string literals in the macro body.
2813 In traditional C macro replacement takes place within string literals,
2814 but does not in ISO C@.
2815
2816 @item
2817 In traditional C, some preprocessor directives did not exist.
2818 Traditional preprocessors would only consider a line to be a directive
2819 if the @samp{#} appeared in column 1 on the line.  Therefore
2820 @option{-Wtraditional} warns about directives that traditional C
2821 understands but would ignore because the @samp{#} does not appear as the
2822 first character on the line.  It also suggests you hide directives like
2823 @samp{#pragma} not understood by traditional C by indenting them.  Some
2824 traditional implementations would not recognize @samp{#elif}, so it
2825 suggests avoiding it altogether.
2826
2827 @item
2828 A function-like macro that appears without arguments.
2829
2830 @item
2831 The unary plus operator.
2832
2833 @item
2834 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2835 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2836 constants.)  Note, these suffixes appear in macros defined in the system
2837 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2838 Use of these macros in user code might normally lead to spurious
2839 warnings, however GCC's integrated preprocessor has enough context to
2840 avoid warning in these cases.
2841
2842 @item
2843 A function declared external in one block and then used after the end of
2844 the block.
2845
2846 @item
2847 A @code{switch} statement has an operand of type @code{long}.
2848
2849 @item
2850 A non-@code{static} function declaration follows a @code{static} one.
2851 This construct is not accepted by some traditional C compilers.
2852
2853 @item
2854 The ISO type of an integer constant has a different width or
2855 signedness from its traditional type.  This warning is only issued if
2856 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2857 typically represent bit patterns, are not warned about.
2858
2859 @item
2860 Usage of ISO string concatenation is detected.
2861
2862 @item
2863 Initialization of automatic aggregates.
2864
2865 @item
2866 Identifier conflicts with labels.  Traditional C lacks a separate
2867 namespace for labels.
2868
2869 @item
2870 Initialization of unions.  If the initializer is zero, the warning is
2871 omitted.  This is done under the assumption that the zero initializer in
2872 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2873 initializer warnings and relies on default initialization to zero in the
2874 traditional C case.
2875
2876 @item
2877 Conversions by prototypes between fixed/floating point values and vice
2878 versa.  The absence of these prototypes when compiling with traditional
2879 C would cause serious problems.  This is a subset of the possible
2880 conversion warnings, for the full set use @option{-Wconversion}.
2881
2882 @item
2883 Use of ISO C style function definitions.  This warning intentionally is
2884 @emph{not} issued for prototype declarations or variadic functions
2885 because these ISO C features will appear in your code when using
2886 libiberty's traditional C compatibility macros, @code{PARAMS} and
2887 @code{VPARAMS}.  This warning is also bypassed for nested functions
2888 because that feature is already a GCC extension and thus not relevant to
2889 traditional C compatibility.
2890 @end itemize
2891
2892 @item -Wdeclaration-after-statement @r{(C only)}
2893 @opindex Wdeclaration-after-statement
2894 Warn when a declaration is found after a statement in a block.  This
2895 construct, known from C++, was introduced with ISO C99 and is by default
2896 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2897 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2898
2899 @item -Wundef
2900 @opindex Wundef
2901 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2902
2903 @item -Wno-endif-labels
2904 @opindex Wno-endif-labels
2905 @opindex Wendif-labels
2906 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2907
2908 @item -Wshadow
2909 @opindex Wshadow
2910 Warn whenever a local variable shadows another local variable, parameter or
2911 global variable or whenever a built-in function is shadowed.
2912
2913 @item -Wlarger-than-@var{len}
2914 @opindex Wlarger-than
2915 Warn whenever an object of larger than @var{len} bytes is defined.
2916
2917 @item -Wpointer-arith
2918 @opindex Wpointer-arith
2919 Warn about anything that depends on the ``size of'' a function type or
2920 of @code{void}.  GNU C assigns these types a size of 1, for
2921 convenience in calculations with @code{void *} pointers and pointers
2922 to functions.
2923
2924 @item -Wbad-function-cast @r{(C only)}
2925 @opindex Wbad-function-cast
2926 Warn whenever a function call is cast to a non-matching type.
2927 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2928
2929 @item -Wcast-qual
2930 @opindex Wcast-qual
2931 Warn whenever a pointer is cast so as to remove a type qualifier from
2932 the target type.  For example, warn if a @code{const char *} is cast
2933 to an ordinary @code{char *}.
2934
2935 @item -Wcast-align
2936 @opindex Wcast-align
2937 Warn whenever a pointer is cast such that the required alignment of the
2938 target is increased.  For example, warn if a @code{char *} is cast to
2939 an @code{int *} on machines where integers can only be accessed at
2940 two- or four-byte boundaries.
2941
2942 @item -Wwrite-strings
2943 @opindex Wwrite-strings
2944 When compiling C, give string constants the type @code{const
2945 char[@var{length}]} so that
2946 copying the address of one into a non-@code{const} @code{char *}
2947 pointer will get a warning; when compiling C++, warn about the
2948 deprecated conversion from string constants to @code{char *}.
2949 These warnings will help you find at
2950 compile time code that can try to write into a string constant, but
2951 only if you have been very careful about using @code{const} in
2952 declarations and prototypes.  Otherwise, it will just be a nuisance;
2953 this is why we did not make @option{-Wall} request these warnings.
2954
2955 @item -Wconversion
2956 @opindex Wconversion
2957 Warn if a prototype causes a type conversion that is different from what
2958 would happen to the same argument in the absence of a prototype.  This
2959 includes conversions of fixed point to floating and vice versa, and
2960 conversions changing the width or signedness of a fixed point argument
2961 except when the same as the default promotion.
2962
2963 Also, warn if a negative integer constant expression is implicitly
2964 converted to an unsigned type.  For example, warn about the assignment
2965 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2966 casts like @code{(unsigned) -1}.
2967
2968 @item -Wsign-compare
2969 @opindex Wsign-compare
2970 @cindex warning for comparison of signed and unsigned values
2971 @cindex comparison of signed and unsigned values, warning
2972 @cindex signed and unsigned values, comparison warning
2973 Warn when a comparison between signed and unsigned values could produce
2974 an incorrect result when the signed value is converted to unsigned.
2975 This warning is also enabled by @option{-Wextra}; to get the other warnings
2976 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2977
2978 @item -Waggregate-return
2979 @opindex Waggregate-return
2980 Warn if any functions that return structures or unions are defined or
2981 called.  (In languages where you can return an array, this also elicits
2982 a warning.)
2983
2984 @item -Wstrict-prototypes @r{(C only)}
2985 @opindex Wstrict-prototypes
2986 Warn if a function is declared or defined without specifying the
2987 argument types.  (An old-style function definition is permitted without
2988 a warning if preceded by a declaration which specifies the argument
2989 types.)
2990
2991 @item -Wold-style-definition @r{(C only)}
2992 @opindex Wold-style-definition
2993 Warn if an old-style function definition is used.  A warning is given
2994 even if there is a previous prototype.
2995
2996 @item -Wmissing-prototypes @r{(C only)}
2997 @opindex Wmissing-prototypes
2998 Warn if a global function is defined without a previous prototype
2999 declaration.  This warning is issued even if the definition itself
3000 provides a prototype.  The aim is to detect global functions that fail
3001 to be declared in header files.
3002
3003 @item -Wmissing-declarations @r{(C only)}
3004 @opindex Wmissing-declarations
3005 Warn if a global function is defined without a previous declaration.
3006 Do so even if the definition itself provides a prototype.
3007 Use this option to detect global functions that are not declared in
3008 header files.
3009
3010 @item -Wmissing-field-initializers
3011 @opindex Wmissing-field-initializers
3012 @opindex W
3013 @opindex Wextra
3014 Warn if a structure's initializer has some fields missing.  For
3015 example, the following code would cause such a warning, because
3016 @code{x.h} is implicitly zero:
3017
3018 @smallexample
3019 struct s @{ int f, g, h; @};
3020 struct s x = @{ 3, 4 @};
3021 @end smallexample
3022
3023 This option does not warn about designated initializers, so the following
3024 modification would not trigger a warning:
3025
3026 @smallexample
3027 struct s @{ int f, g, h; @};
3028 struct s x = @{ .f = 3, .g = 4 @};
3029 @end smallexample
3030
3031 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3032 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3033
3034 @item -Wmissing-noreturn
3035 @opindex Wmissing-noreturn
3036 Warn about functions which might be candidates for attribute @code{noreturn}.
3037 Note these are only possible candidates, not absolute ones.  Care should
3038 be taken to manually verify functions actually do not ever return before
3039 adding the @code{noreturn} attribute, otherwise subtle code generation
3040 bugs could be introduced.  You will not get a warning for @code{main} in
3041 hosted C environments.
3042
3043 @item -Wmissing-format-attribute
3044 @opindex Wmissing-format-attribute
3045 @opindex Wformat
3046 If @option{-Wformat} is enabled, also warn about functions which might be
3047 candidates for @code{format} attributes.  Note these are only possible
3048 candidates, not absolute ones.  GCC will guess that @code{format}
3049 attributes might be appropriate for any function that calls a function
3050 like @code{vprintf} or @code{vscanf}, but this might not always be the
3051 case, and some functions for which @code{format} attributes are
3052 appropriate may not be detected.  This option has no effect unless
3053 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3054
3055 @item -Wno-multichar
3056 @opindex Wno-multichar
3057 @opindex Wmultichar
3058 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3059 Usually they indicate a typo in the user's code, as they have
3060 implementation-defined values, and should not be used in portable code.
3061
3062 @item -Wnormalized=<none|id|nfc|nfkc>
3063 @opindex Wnormalized
3064 @cindex NFC
3065 @cindex NFKC
3066 @cindex character set, input normalization
3067 In ISO C and ISO C++, two identifiers are different if they are
3068 different sequences of characters.  However, sometimes when characters
3069 outside the basic ASCII character set are used, you can have two
3070 different character sequences that look the same.  To avoid confusion,
3071 the ISO 10646 standard sets out some @dfn{normalization rules} which
3072 when applied ensure that two sequences that look the same are turned into
3073 the same sequence.  GCC can warn you if you are using identifiers which
3074 have not been normalized; this option controls that warning.
3075
3076 There are four levels of warning that GCC supports.  The default is
3077 @option{-Wnormalized=nfc}, which warns about any identifier which is
3078 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3079 recommended form for most uses.
3080
3081 Unfortunately, there are some characters which ISO C and ISO C++ allow
3082 in identifiers that when turned into NFC aren't allowable as
3083 identifiers.  That is, there's no way to use these symbols in portable
3084 ISO C or C++ and have all your identifiers in NFC.
3085 @option{-Wnormalized=id} suppresses the warning for these characters.
3086 It is hoped that future versions of the standards involved will correct
3087 this, which is why this option is not the default.
3088
3089 You can switch the warning off for all characters by writing
3090 @option{-Wnormalized=none}.  You would only want to do this if you
3091 were using some other normalization scheme (like ``D''), because
3092 otherwise you can easily create bugs that are literally impossible to see.
3093
3094 Some characters in ISO 10646 have distinct meanings but look identical
3095 in some fonts or display methodologies, especially once formatting has
3096 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3097 LETTER N'', will display just like a regular @code{n} which has been
3098 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3099 normalisation scheme to convert all these into a standard form as
3100 well, and GCC will warn if your code is not in NFKC if you use
3101 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3102 about every identifier that contains the letter O because it might be
3103 confused with the digit 0, and so is not the default, but may be
3104 useful as a local coding convention if the programming environment is
3105 unable to be fixed to display these characters distinctly.
3106
3107 @item -Wno-deprecated-declarations
3108 @opindex Wno-deprecated-declarations
3109 Do not warn about uses of functions, variables, and types marked as
3110 deprecated by using the @code{deprecated} attribute.
3111 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3112 @pxref{Type Attributes}.)
3113
3114 @item -Wpacked
3115 @opindex Wpacked
3116 Warn if a structure is given the packed attribute, but the packed
3117 attribute has no effect on the layout or size of the structure.
3118 Such structures may be mis-aligned for little benefit.  For
3119 instance, in this code, the variable @code{f.x} in @code{struct bar}
3120 will be misaligned even though @code{struct bar} does not itself
3121 have the packed attribute:
3122
3123 @smallexample
3124 @group
3125 struct foo @{
3126   int x;
3127   char a, b, c, d;
3128 @} __attribute__((packed));
3129 struct bar @{
3130   char z;
3131   struct foo f;
3132 @};
3133 @end group
3134 @end smallexample
3135
3136 @item -Wpadded
3137 @opindex Wpadded
3138 Warn if padding is included in a structure, either to align an element
3139 of the structure or to align the whole structure.  Sometimes when this
3140 happens it is possible to rearrange the fields of the structure to
3141 reduce the padding and so make the structure smaller.
3142
3143 @item -Wredundant-decls
3144 @opindex Wredundant-decls
3145 Warn if anything is declared more than once in the same scope, even in
3146 cases where multiple declaration is valid and changes nothing.
3147
3148 @item -Wnested-externs @r{(C only)}
3149 @opindex Wnested-externs
3150 Warn if an @code{extern} declaration is encountered within a function.
3151
3152 @item -Wunreachable-code
3153 @opindex Wunreachable-code
3154 Warn if the compiler detects that code will never be executed.
3155
3156 This option is intended to warn when the compiler detects that at
3157 least a whole line of source code will never be executed, because
3158 some condition is never satisfied or because it is after a
3159 procedure that never returns.
3160
3161 It is possible for this option to produce a warning even though there
3162 are circumstances under which part of the affected line can be executed,
3163 so care should be taken when removing apparently-unreachable code.
3164
3165 For instance, when a function is inlined, a warning may mean that the
3166 line is unreachable in only one inlined copy of the function.
3167
3168 This option is not made part of @option{-Wall} because in a debugging
3169 version of a program there is often substantial code which checks
3170 correct functioning of the program and is, hopefully, unreachable
3171 because the program does work.  Another common use of unreachable
3172 code is to provide behavior which is selectable at compile-time.
3173
3174 @item -Winline
3175 @opindex Winline
3176 Warn if a function can not be inlined and it was declared as inline.
3177 Even with this option, the compiler will not warn about failures to
3178 inline functions declared in system headers.
3179
3180 The compiler uses a variety of heuristics to determine whether or not
3181 to inline a function.  For example, the compiler takes into account
3182 the size of the function being inlined and the amount of inlining
3183 that has already been done in the current function.  Therefore,
3184 seemingly insignificant changes in the source program can cause the
3185 warnings produced by @option{-Winline} to appear or disappear.
3186
3187 @item -Wno-invalid-offsetof @r{(C++ only)}
3188 @opindex Wno-invalid-offsetof
3189 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3190 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3191 to a non-POD type is undefined.  In existing C++ implementations,
3192 however, @samp{offsetof} typically gives meaningful results even when
3193 applied to certain kinds of non-POD types. (Such as a simple
3194 @samp{struct} that fails to be a POD type only by virtue of having a
3195 constructor.)  This flag is for users who are aware that they are
3196 writing nonportable code and who have deliberately chosen to ignore the
3197 warning about it.
3198
3199 The restrictions on @samp{offsetof} may be relaxed in a future version
3200 of the C++ standard.
3201
3202 @item -Wno-int-to-pointer-cast @r{(C only)}
3203 @opindex Wno-int-to-pointer-cast
3204 Suppress warnings from casts to pointer type of an integer of a
3205 different size.
3206
3207 @item -Wno-pointer-to-int-cast @r{(C only)}
3208 @opindex Wno-pointer-to-int-cast
3209 Suppress warnings from casts from a pointer to an integer type of a
3210 different size.
3211
3212 @item -Winvalid-pch
3213 @opindex Winvalid-pch
3214 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3215 the search path but can't be used.
3216
3217 @item -Wlong-long
3218 @opindex Wlong-long
3219 @opindex Wno-long-long
3220 Warn if @samp{long long} type is used.  This is default.  To inhibit
3221 the warning messages, use @option{-Wno-long-long}.  Flags
3222 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3223 only when @option{-pedantic} flag is used.
3224
3225 @item -Wvariadic-macros
3226 @opindex Wvariadic-macros
3227 @opindex Wno-variadic-macros
3228 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3229 alternate syntax when in pedantic ISO C99 mode.  This is default.
3230 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3231
3232 @item -Wdisabled-optimization
3233 @opindex Wdisabled-optimization
3234 Warn if a requested optimization pass is disabled.  This warning does
3235 not generally indicate that there is anything wrong with your code; it
3236 merely indicates that GCC's optimizers were unable to handle the code
3237 effectively.  Often, the problem is that your code is too big or too
3238 complex; GCC will refuse to optimize programs when the optimization
3239 itself is likely to take inordinate amounts of time.
3240
3241 @item -Wno-pointer-sign
3242 @opindex Wno-pointer-sign
3243 Don't warn for pointer argument passing or assignment with different signedness.
3244 Only useful in the negative form since this warning is enabled by default.
3245 This option is only supported for C and Objective-C@.
3246
3247 @item -Werror
3248 @opindex Werror
3249 Make all warnings into errors.
3250 @end table
3251
3252 @node Debugging Options
3253 @section Options for Debugging Your Program or GCC
3254 @cindex options, debugging
3255 @cindex debugging information options
3256
3257 GCC has various special options that are used for debugging
3258 either your program or GCC:
3259
3260 @table @gcctabopt
3261 @item -g
3262 @opindex g
3263 Produce debugging information in the operating system's native format
3264 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3265 information.
3266
3267 On most systems that use stabs format, @option{-g} enables use of extra
3268 debugging information that only GDB can use; this extra information
3269 makes debugging work better in GDB but will probably make other debuggers
3270 crash or
3271 refuse to read the program.  If you want to control for certain whether
3272 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3273 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3274
3275 GCC allows you to use @option{-g} with
3276 @option{-O}.  The shortcuts taken by optimized code may occasionally
3277 produce surprising results: some variables you declared may not exist
3278 at all; flow of control may briefly move where you did not expect it;
3279 some statements may not be executed because they compute constant
3280 results or their values were already at hand; some statements may
3281 execute in different places because they were moved out of loops.
3282
3283 Nevertheless it proves possible to debug optimized output.  This makes
3284 it reasonable to use the optimizer for programs that might have bugs.
3285
3286 The following options are useful when GCC is generated with the
3287 capability for more than one debugging format.
3288
3289 @item -ggdb
3290 @opindex ggdb
3291 Produce debugging information for use by GDB@.  This means to use the
3292 most expressive format available (DWARF 2, stabs, or the native format
3293 if neither of those are supported), including GDB extensions if at all
3294 possible.
3295
3296 @item -gstabs
3297 @opindex gstabs
3298 Produce debugging information in stabs format (if that is supported),
3299 without GDB extensions.  This is the format used by DBX on most BSD
3300 systems.  On MIPS, Alpha and System V Release 4 systems this option
3301 produces stabs debugging output which is not understood by DBX or SDB@.
3302 On System V Release 4 systems this option requires the GNU assembler.
3303
3304 @item -feliminate-unused-debug-symbols
3305 @opindex feliminate-unused-debug-symbols
3306 Produce debugging information in stabs format (if that is supported),
3307 for only symbols that are actually used.
3308
3309 @item -gstabs+
3310 @opindex gstabs+
3311 Produce debugging information in stabs format (if that is supported),
3312 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3313 use of these extensions is likely to make other debuggers crash or
3314 refuse to read the program.
3315
3316 @item -gcoff
3317 @opindex gcoff
3318 Produce debugging information in COFF format (if that is supported).
3319 This is the format used by SDB on most System V systems prior to
3320 System V Release 4.
3321
3322 @item -gxcoff
3323 @opindex gxcoff
3324 Produce debugging information in XCOFF format (if that is supported).
3325 This is the format used by the DBX debugger on IBM RS/6000 systems.
3326
3327 @item -gxcoff+
3328 @opindex gxcoff+
3329 Produce debugging information in XCOFF format (if that is supported),
3330 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3331 use of these extensions is likely to make other debuggers crash or
3332 refuse to read the program, and may cause assemblers other than the GNU
3333 assembler (GAS) to fail with an error.
3334
3335 @item -gdwarf-2
3336 @opindex gdwarf-2
3337 Produce debugging information in DWARF version 2 format (if that is
3338 supported).  This is the format used by DBX on IRIX 6.  With this
3339 option, GCC uses features of DWARF version 3 when they are useful;
3340 version 3 is upward compatible with version 2, but may still cause
3341 problems for older debuggers.
3342
3343 @item -gvms
3344 @opindex gvms
3345 Produce debugging information in VMS debug format (if that is
3346 supported).  This is the format used by DEBUG on VMS systems.
3347
3348 @item -g@var{level}
3349 @itemx -ggdb@var{level}
3350 @itemx -gstabs@var{level}
3351 @itemx -gcoff@var{level}
3352 @itemx -gxcoff@var{level}
3353 @itemx -gvms@var{level}
3354 Request debugging information and also use @var{level} to specify how
3355 much information.  The default level is 2.
3356
3357 Level 1 produces minimal information, enough for making backtraces in
3358 parts of the program that you don't plan to debug.  This includes
3359 descriptions of functions and external variables, but no information
3360 about local variables and no line numbers.
3361
3362 Level 3 includes extra information, such as all the macro definitions
3363 present in the program.  Some debuggers support macro expansion when
3364 you use @option{-g3}.
3365
3366 @option{-gdwarf-2} does not accept a concatenated debug level, because
3367 GCC used to support an option @option{-gdwarf} that meant to generate
3368 debug information in version 1 of the DWARF format (which is very
3369 different from version 2), and it would have been too confusing.  That
3370 debug format is long obsolete, but the option cannot be changed now.
3371 Instead use an additional @option{-g@var{level}} option to change the
3372 debug level for DWARF2.
3373
3374 @item -feliminate-dwarf2-dups
3375 @opindex feliminate-dwarf2-dups
3376 Compress DWARF2 debugging information by eliminating duplicated
3377 information about each symbol.  This option only makes sense when
3378 generating DWARF2 debugging information with @option{-gdwarf-2}.
3379
3380 @cindex @command{prof}
3381 @item -p
3382 @opindex p
3383 Generate extra code to write profile information suitable for the
3384 analysis program @command{prof}.  You must use this option when compiling
3385 the source files you want data about, and you must also use it when
3386 linking.
3387
3388 @cindex @command{gprof}
3389 @item -pg
3390 @opindex pg
3391 Generate extra code to write profile information suitable for the
3392 analysis program @command{gprof}.  You must use this option when compiling
3393 the source files you want data about, and you must also use it when
3394 linking.
3395
3396 @item -Q
3397 @opindex Q
3398 Makes the compiler print out each function name as it is compiled, and
3399 print some statistics about each pass when it finishes.
3400
3401 @item -ftime-report
3402 @opindex ftime-report
3403 Makes the compiler print some statistics about the time consumed by each
3404 pass when it finishes.
3405
3406 @item -fmem-report
3407 @opindex fmem-report
3408 Makes the compiler print some statistics about permanent memory
3409 allocation when it finishes.
3410
3411 @item -fprofile-arcs
3412 @opindex fprofile-arcs
3413 Add code so that program flow @dfn{arcs} are instrumented.  During
3414 execution the program records how many times each branch and call is
3415 executed and how many times it is taken or returns.  When the compiled
3416 program exits it saves this data to a file called
3417 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3418 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3419 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3420 @var{auxname} is generated from the name of the output file, if
3421 explicitly specified and it is not the final executable, otherwise it is
3422 the basename of the source file.  In both cases any suffix is removed
3423 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3424 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3425
3426 @cindex @command{gcov}
3427 @item --coverage
3428 @opindex coverage
3429
3430 This option is used to compile and link code instrumented for coverage
3431 analysis.  The option is a synonym for @option{-fprofile-arcs}
3432 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3433 linking).  See the documentation for those options for more details.
3434
3435 @itemize
3436
3437 @item
3438 Compile the source files with @option{-fprofile-arcs} plus optimization
3439 and code generation options.  For test coverage analysis, use the
3440 additional @option{-ftest-coverage} option.  You do not need to profile
3441 every source file in a program.
3442
3443 @item
3444 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3445 (the latter implies the former).
3446
3447 @item
3448 Run the program on a representative workload to generate the arc profile
3449 information.  This may be repeated any number of times.  You can run
3450 concurrent instances of your program, and provided that the file system
3451 supports locking, the data files will be correctly updated.  Also
3452 @code{fork} calls are detected and correctly handled (double counting
3453 will not happen).
3454
3455 @item
3456 For profile-directed optimizations, compile the source files again with
3457 the same optimization and code generation options plus
3458 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3459 Control Optimization}).
3460
3461 @item
3462 For test coverage analysis, use @command{gcov} to produce human readable
3463 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3464 @command{gcov} documentation for further information.
3465
3466 @end itemize
3467
3468 With @option{-fprofile-arcs}, for each function of your program GCC
3469 creates a program flow graph, then finds a spanning tree for the graph.
3470 Only arcs that are not on the spanning tree have to be instrumented: the
3471 compiler adds code to count the number of times that these arcs are
3472 executed.  When an arc is the only exit or only entrance to a block, the
3473 instrumentation code can be added to the block; otherwise, a new basic
3474 block must be created to hold the instrumentation code.
3475
3476 @item -ftree-based-profiling
3477 @opindex ftree-based-profiling
3478 This option is used in addition to @option{-fprofile-arcs} or
3479 @option{-fbranch-probabilities} to control whether those optimizations
3480 are performed on a tree-based or rtl-based internal representation.
3481 If you use this option when compiling with @option{-fprofile-arcs},
3482 you must also use it when compiling later with @option{-fbranch-probabilities}.
3483 Currently the tree-based optimization is in an early stage of
3484 development, and this option is recommended only for those people
3485 working on improving it.
3486
3487 @need 2000
3488 @item -ftest-coverage
3489 @opindex ftest-coverage
3490 Produce a notes file that the @command{gcov} code-coverage utility
3491 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3492 show program coverage.  Each source file's note file is called
3493 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3494 above for a description of @var{auxname} and instructions on how to
3495 generate test coverage data.  Coverage data will match the source files
3496 more closely, if you do not optimize.
3497
3498 @item -d@var{letters}
3499 @item -fdump-rtl-@var{pass}
3500 @opindex d
3501 Says to make debugging dumps during compilation at times specified by
3502 @var{letters}.    This is used for debugging the RTL-based passes of the
3503 compiler.  The file names for most of the dumps are made by appending a
3504 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3505 from the name of the output file, if explicitly specified and it is not
3506 an executable, otherwise it is the basename of the source file.
3507
3508 Most debug dumps can be enabled either passing a letter to the @option{-d}
3509 option, or with a long @option{-fdump-rtl} switch; here are the possible
3510 letters for use in @var{letters} and @var{pass}, and their meanings:
3511
3512 @table @gcctabopt
3513 @item -dA
3514 @opindex dA
3515 Annotate the assembler output with miscellaneous debugging information.
3516
3517 @item -db
3518 @itemx -fdump-rtl-bp
3519 @opindex db
3520 @opindex fdump-rtl-bp
3521 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3522
3523 @item -dB
3524 @itemx -fdump-rtl-bbro
3525 @opindex dB
3526 @opindex fdump-rtl-bbro
3527 Dump after block reordering, to @file{@var{file}.30.bbro}.
3528
3529 @item -dc
3530 @itemx -fdump-rtl-combine
3531 @opindex dc
3532 @opindex fdump-rtl-combine
3533 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3534
3535 @item -dC
3536 @itemx -fdump-rtl-ce1
3537 @itemx -fdump-rtl-ce2
3538 @opindex dC
3539 @opindex fdump-rtl-ce1
3540 @opindex fdump-rtl-ce2
3541 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3542 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3543 and @option{-fdump-rtl-ce2} enable dumping after the second if
3544 conversion, to the file @file{@var{file}.18.ce2}.
3545
3546 @item -dd
3547 @itemx -fdump-rtl-btl
3548 @itemx -fdump-rtl-dbr
3549 @opindex dd
3550 @opindex fdump-rtl-btl
3551 @opindex fdump-rtl-dbr
3552 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3553 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3554 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3555 scheduling, to @file{@var{file}.36.dbr}.
3556
3557 @item -dD
3558 @opindex dD
3559 Dump all macro definitions, at the end of preprocessing, in addition to
3560 normal output.
3561
3562 @item -dE
3563 @itemx -fdump-rtl-ce3
3564 @opindex dE
3565 @opindex fdump-rtl-ce3
3566 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3567
3568 @item -df
3569 @itemx -fdump-rtl-cfg
3570 @itemx -fdump-rtl-life
3571 @opindex df
3572 @opindex fdump-rtl-cfg
3573 @opindex fdump-rtl-life
3574 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3575 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3576 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3577 to @file{@var{file}.16.life}.
3578
3579 @item -dg
3580 @itemx -fdump-rtl-greg
3581 @opindex dg
3582 @opindex fdump-rtl-greg
3583 Dump after global register allocation, to @file{@var{file}.23.greg}.
3584
3585 @item -dG
3586 @itemx -fdump-rtl-gcse
3587 @itemx -fdump-rtl-bypass
3588 @opindex dG
3589 @opindex fdump-rtl-gcse
3590 @opindex fdump-rtl-bypass
3591 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3592 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3593 enable dumping after jump bypassing and control flow optimizations, to
3594 @file{@var{file}.07.bypass}.
3595
3596 @item -dh
3597 @itemx -fdump-rtl-eh
3598 @opindex dh
3599 @opindex fdump-rtl-eh
3600 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3601
3602 @item -di
3603 @itemx -fdump-rtl-sibling
3604 @opindex di
3605 @opindex fdump-rtl-sibling
3606 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3607
3608 @item -dj
3609 @itemx -fdump-rtl-jump
3610 @opindex dj
3611 @opindex fdump-rtl-jump
3612 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3613
3614 @item -dk
3615 @itemx -fdump-rtl-stack
3616 @opindex dk
3617 @opindex fdump-rtl-stack
3618 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3619
3620 @item -dl
3621 @itemx -fdump-rtl-lreg
3622 @opindex dl
3623 @opindex fdump-rtl-lreg
3624 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3625
3626 @item -dL
3627 @itemx -fdump-rtl-loop
3628 @itemx -fdump-rtl-loop2
3629 @opindex dL
3630 @opindex fdump-rtl-loop
3631 @opindex fdump-rtl-loop2
3632 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3633 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3634 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3635 @file{@var{file}.13.loop2}.
3636
3637 @item -dm
3638 @itemx -fdump-rtl-sms
3639 @opindex dm
3640 @opindex fdump-rtl-sms
3641 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3642
3643 @item -dM
3644 @itemx -fdump-rtl-mach
3645 @opindex dM
3646 @opindex fdump-rtl-mach
3647 Dump after performing the machine dependent reorganization pass, to
3648 @file{@var{file}.35.mach}.
3649
3650 @item -dn
3651 @itemx -fdump-rtl-rnreg
3652 @opindex dn
3653 @opindex fdump-rtl-rnreg
3654 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3655
3656 @item -dN
3657 @itemx -fdump-rtl-regmove
3658 @opindex dN
3659 @opindex fdump-rtl-regmove
3660 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3661
3662 @item -do
3663 @itemx -fdump-rtl-postreload
3664 @opindex do
3665 @opindex fdump-rtl-postreload
3666 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3667
3668 @item -dr
3669 @itemx -fdump-rtl-expand
3670 @opindex dr
3671 @opindex fdump-rtl-expand
3672 Dump after RTL generation, to @file{@var{file}.00.expand}.
3673
3674 @item -dR
3675 @itemx -fdump-rtl-sched2
3676 @opindex dR
3677 @opindex fdump-rtl-sched2
3678 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3679
3680 @item -ds
3681 @itemx -fdump-rtl-cse
3682 @opindex ds
3683 @opindex fdump-rtl-cse
3684 Dump after CSE (including the jump optimization that sometimes follows
3685 CSE), to @file{@var{file}.04.cse}.
3686
3687 @item -dS
3688 @itemx -fdump-rtl-sched
3689 @opindex dS
3690 @opindex fdump-rtl-sched
3691 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3692
3693 @item -dt
3694 @itemx -fdump-rtl-cse2
3695 @opindex dt
3696 @opindex fdump-rtl-cse2
3697 Dump after the second CSE pass (including the jump optimization that
3698 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3699
3700 @item -dT
3701 @itemx -fdump-rtl-tracer
3702 @opindex dT
3703 @opindex fdump-rtl-tracer
3704 Dump after running tracer, to @file{@var{file}.12.tracer}.
3705
3706 @item -dV
3707 @itemx -fdump-rtl-vpt
3708 @itemx -fdump-rtl-vartrack
3709 @opindex dV
3710 @opindex fdump-rtl-vpt
3711 @opindex fdump-rtl-vartrack
3712 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3713 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3714 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3715 to @file{@var{file}.34.vartrack}.
3716
3717 @item -dw
3718 @itemx -fdump-rtl-flow2
3719 @opindex dw
3720 @opindex fdump-rtl-flow2
3721 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3722
3723 @item -dz
3724 @itemx -fdump-rtl-peephole2
3725 @opindex dz
3726 @opindex fdump-rtl-peephole2
3727 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3728
3729 @item -dZ
3730 @itemx -fdump-rtl-web
3731 @opindex dZ
3732 @opindex fdump-rtl-web
3733 Dump after live range splitting, to @file{@var{file}.14.web}.
3734
3735 @item -da
3736 @itemx -fdump-rtl-all
3737 @opindex da
3738 @opindex fdump-rtl-all
3739 Produce all the dumps listed above.
3740
3741 @item -dH
3742 @opindex dH
3743 Produce a core dump whenever an error occurs.
3744
3745 @item -dm
3746 @opindex dm
3747 Print statistics on memory usage, at the end of the run, to
3748 standard error.
3749
3750 @item -dp
3751 @opindex dp
3752 Annotate the assembler output with a comment indicating which
3753 pattern and alternative was used.  The length of each instruction is
3754 also printed.
3755
3756 @item -dP
3757 @opindex dP
3758 Dump the RTL in the assembler output as a comment before each instruction.
3759 Also turns on @option{-dp} annotation.
3760
3761 @item -dv
3762 @opindex dv
3763 For each of the other indicated dump files (either with @option{-d} or
3764 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3765 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3766
3767 @item -dx
3768 @opindex dx
3769 Just generate RTL for a function instead of compiling it.  Usually used
3770 with @samp{r} (@option{-fdump-rtl-expand}).
3771
3772 @item -dy
3773 @opindex dy
3774 Dump debugging information during parsing, to standard error.
3775 @end table
3776
3777 @item -fdump-unnumbered
3778 @opindex fdump-unnumbered
3779 When doing debugging dumps (see @option{-d} option above), suppress instruction
3780 numbers and line number note output.  This makes it more feasible to
3781 use diff on debugging dumps for compiler invocations with different
3782 options, in particular with and without @option{-g}.
3783
3784 @item -fdump-translation-unit @r{(C and C++ only)}
3785 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3786 @opindex fdump-translation-unit
3787 Dump a representation of the tree structure for the entire translation
3788 unit to a file.  The file name is made by appending @file{.tu} to the
3789 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3790 controls the details of the dump as described for the
3791 @option{-fdump-tree} options.
3792
3793 @item -fdump-class-hierarchy @r{(C++ only)}
3794 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3795 @opindex fdump-class-hierarchy
3796 Dump a representation of each class's hierarchy and virtual function
3797 table layout to a file.  The file name is made by appending @file{.class}
3798 to the source file name.  If the @samp{-@var{options}} form is used,
3799 @var{options} controls the details of the dump as described for the
3800 @option{-fdump-tree} options.
3801
3802 @item -fdump-ipa-@var{switch}
3803 @opindex fdump-ipa
3804 Control the dumping at various stages of inter-procedural analysis
3805 language tree to a file.  The file name is generated by appending a switch
3806 specific suffix to the source file name.  The following dumps are possible:
3807
3808 @table @samp
3809 @item all
3810 Enables all inter-procedural analysis dumps; currently the only produced
3811 dump is the @samp{cgraph} dump.
3812
3813 @item cgraph
3814 Dumps information about call-graph optimization, unused function removal,
3815 and inlining decisions.
3816 @end table
3817
3818 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3819 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3820 @opindex fdump-tree
3821 Control the dumping at various stages of processing the intermediate
3822 language tree to a file.  The file name is generated by appending a switch
3823 specific suffix to the source file name.  If the @samp{-@var{options}}
3824 form is used, @var{options} is a list of @samp{-} separated options that
3825 control the details of the dump.  Not all options are applicable to all
3826 dumps, those which are not meaningful will be ignored.  The following
3827 options are available
3828
3829 @table @samp
3830 @item address
3831 Print the address of each node.  Usually this is not meaningful as it
3832 changes according to the environment and source file.  Its primary use
3833 is for tying up a dump file with a debug environment.
3834 @item slim
3835 Inhibit dumping of members of a scope or body of a function merely
3836 because that scope has been reached.  Only dump such items when they
3837 are directly reachable by some other path.  When dumping pretty-printed
3838 trees, this option inhibits dumping the bodies of control structures.
3839 @item raw
3840 Print a raw representation of the tree.  By default, trees are
3841 pretty-printed into a C-like representation.
3842 @item details
3843 Enable more detailed dumps (not honored by every dump option).
3844 @item stats
3845 Enable dumping various statistics about the pass (not honored by every dump
3846 option).
3847 @item blocks
3848 Enable showing basic block boundaries (disabled in raw dumps).
3849 @item vops
3850 Enable showing virtual operands for every statement.
3851 @item lineno
3852 Enable showing line numbers for statements.
3853 @item uid
3854 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3855 @item all
3856 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3857 @end table
3858
3859 The following tree dumps are possible:
3860 @table @samp
3861
3862 @item original
3863 Dump before any tree based optimization, to @file{@var{file}.original}.
3864
3865 @item optimized
3866 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3867
3868 @item inlined
3869 Dump after function inlining, to @file{@var{file}.inlined}.
3870
3871 @item gimple
3872 @opindex fdump-tree-gimple
3873 Dump each function before and after the gimplification pass to a file.  The
3874 file name is made by appending @file{.gimple} to the source file name.
3875
3876 @item cfg
3877 @opindex fdump-tree-cfg
3878 Dump the control flow graph of each function to a file.  The file name is
3879 made by appending @file{.cfg} to the source file name.
3880
3881 @item vcg
3882 @opindex fdump-tree-vcg
3883 Dump the control flow graph of each function to a file in VCG format.  The
3884 file name is made by appending @file{.vcg} to the source file name.  Note
3885 that if the file contains more than one function, the generated file cannot
3886 be used directly by VCG@.  You will need to cut and paste each function's
3887 graph into its own separate file first.
3888
3889 @item ch
3890 @opindex fdump-tree-ch
3891 Dump each function after copying loop headers.  The file name is made by
3892 appending @file{.ch} to the source file name.
3893
3894 @item ssa
3895 @opindex fdump-tree-ssa
3896 Dump SSA related information to a file.  The file name is made by appending
3897 @file{.ssa} to the source file name.
3898
3899 @item salias
3900 @opindex fdump-tree-salias
3901 Dump structure aliasing variable information to a file.  This file name
3902 is made by appending @file{.salias} to the source file name.
3903
3904 @item alias
3905 @opindex fdump-tree-alias
3906 Dump aliasing information for each function.  The file name is made by
3907 appending @file{.alias} to the source file name.
3908
3909 @item ccp
3910 @opindex fdump-tree-ccp
3911 Dump each function after CCP@.  The file name is made by appending
3912 @file{.ccp} to the source file name.
3913
3914 @item storeccp
3915 @opindex fdump-tree-storeccp
3916 Dump each function after STORE-CCP.  The file name is made by appending
3917 @file{.storeccp} to the source file name.
3918
3919 @item pre
3920 @opindex fdump-tree-pre
3921 Dump trees after partial redundancy elimination.  The file name is made
3922 by appending @file{.pre} to the source file name.
3923
3924 @item fre
3925 @opindex fdump-tree-fre
3926 Dump trees after full redundancy elimination.  The file name is made
3927 by appending @file{.fre} to the source file name.
3928
3929 @item copyprop
3930 @opindex fdump-tree-copyprop
3931 Dump trees after copy propagation.  The file name is made
3932 by appending @file{.copyprop} to the source file name.
3933
3934 @item store_copyprop
3935 @opindex fdump-tree-store_copyprop
3936 Dump trees after store copy-propagation.  The file name is made
3937 by appending @file{.store_copyprop} to the source file name.
3938
3939 @item dce
3940 @opindex fdump-tree-dce
3941 Dump each function after dead code elimination.  The file name is made by
3942 appending @file{.dce} to the source file name.
3943
3944 @item mudflap
3945 @opindex fdump-tree-mudflap
3946 Dump each function after adding mudflap instrumentation.  The file name is
3947 made by appending @file{.mudflap} to the source file name.
3948
3949 @item sra
3950 @opindex fdump-tree-sra
3951 Dump each function after performing scalar replacement of aggregates.  The
3952 file name is made by appending @file{.sra} to the source file name.
3953
3954 @item sink
3955 @opindex fdump-tree-sink
3956 Dump each function after performing code sinking.  The file name is made
3957 by appending @file{.sink} to the source file name. 
3958
3959 @item dom
3960 @opindex fdump-tree-dom
3961 Dump each function after applying dominator tree optimizations.  The file
3962 name is made by appending @file{.dom} to the source file name.
3963
3964 @item dse
3965 @opindex fdump-tree-dse
3966 Dump each function after applying dead store elimination.  The file
3967 name is made by appending @file{.dse} to the source file name.
3968
3969 @item phiopt
3970 @opindex fdump-tree-phiopt
3971 Dump each function after optimizing PHI nodes into straightline code.  The file
3972 name is made by appending @file{.phiopt} to the source file name.
3973
3974 @item forwprop
3975 @opindex fdump-tree-forwprop
3976 Dump each function after forward propagating single use variables.  The file
3977 name is made by appending @file{.forwprop} to the source file name.
3978
3979 @item copyrename
3980 @opindex fdump-tree-copyrename
3981 Dump each function after applying the copy rename optimization.  The file
3982 name is made by appending @file{.copyrename} to the source file name.
3983
3984 @item nrv
3985 @opindex fdump-tree-nrv
3986 Dump each function after applying the named return value optimization on
3987 generic trees.  The file name is made by appending @file{.nrv} to the source
3988 file name.
3989
3990 @item vect
3991 @opindex fdump-tree-vect
3992 Dump each function after applying vectorization of loops.  The file name is
3993 made by appending @file{.vect} to the source file name.
3994
3995 @item all
3996 @opindex fdump-tree-all
3997 Enable all the available tree dumps with the flags provided in this option.
3998 @end table
3999
4000 @item -ftree-vectorizer-verbose=@var{n}
4001 @opindex ftree-vectorizer-verbose
4002 This option controls the amount of debugging output the vectorizer prints.
4003 This information is written to standard error, unless @option{-fdump-tree-all}
4004 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4005 usual dump listing file, @file{.vect}.
4006
4007 @item -frandom-seed=@var{string}
4008 @opindex frandom-string
4009 This option provides a seed that GCC uses when it would otherwise use
4010 random numbers.  It is used to generate certain symbol names
4011 that have to be different in every compiled file.  It is also used to
4012 place unique stamps in coverage data files and the object files that
4013 produce them.  You can use the @option{-frandom-seed} option to produce
4014 reproducibly identical object files.
4015
4016 The @var{string} should be different for every file you compile.
4017
4018 @item -fsched-verbose=@var{n}
4019 @opindex fsched-verbose
4020 On targets that use instruction scheduling, this option controls the
4021 amount of debugging output the scheduler prints.  This information is
4022 written to standard error, unless @option{-dS} or @option{-dR} is
4023 specified, in which case it is output to the usual dump
4024 listing file, @file{.sched} or @file{.sched2} respectively.  However
4025 for @var{n} greater than nine, the output is always printed to standard
4026 error.
4027
4028 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4029 same information as @option{-dRS}.  For @var{n} greater than one, it
4030 also output basic block probabilities, detailed ready list information
4031 and unit/insn info.  For @var{n} greater than two, it includes RTL
4032 at abort point, control-flow and regions info.  And for @var{n} over
4033 four, @option{-fsched-verbose} also includes dependence info.
4034
4035 @item -save-temps
4036 @opindex save-temps
4037 Store the usual ``temporary'' intermediate files permanently; place them
4038 in the current directory and name them based on the source file.  Thus,
4039 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4040 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4041 preprocessed @file{foo.i} output file even though the compiler now
4042 normally uses an integrated preprocessor.
4043
4044 When used in combination with the @option{-x} command line option,
4045 @option{-save-temps} is sensible enough to avoid over writing an
4046 input source file with the same extension as an intermediate file.
4047 The corresponding intermediate file may be obtained by renaming the
4048 source file before using @option{-save-temps}.
4049
4050 @item -time
4051 @opindex time
4052 Report the CPU time taken by each subprocess in the compilation
4053 sequence.  For C source files, this is the compiler proper and assembler
4054 (plus the linker if linking is done).  The output looks like this:
4055
4056 @smallexample
4057 # cc1 0.12 0.01
4058 # as 0.00 0.01
4059 @end smallexample
4060
4061 The first number on each line is the ``user time'', that is time spent
4062 executing the program itself.  The second number is ``system time'',
4063 time spent executing operating system routines on behalf of the program.
4064 Both numbers are in seconds.
4065
4066 @item -fvar-tracking
4067 @opindex fvar-tracking
4068 Run variable tracking pass.  It computes where variables are stored at each
4069 position in code.  Better debugging information is then generated
4070 (if the debugging information format supports this information).
4071
4072 It is enabled by default when compiling with optimization (@option{-Os},
4073 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4074 the debug info format supports it.
4075
4076 @item -print-file-name=@var{library}
4077 @opindex print-file-name
4078 Print the full absolute name of the library file @var{library} that
4079 would be used when linking---and don't do anything else.  With this
4080 option, GCC does not compile or link anything; it just prints the
4081 file name.
4082
4083 @item -print-multi-directory
4084 @opindex print-multi-directory
4085 Print the directory name corresponding to the multilib selected by any
4086 other switches present in the command line.  This directory is supposed
4087 to exist in @env{GCC_EXEC_PREFIX}.
4088
4089 @item -print-multi-lib
4090 @opindex print-multi-lib
4091 Print the mapping from multilib directory names to compiler switches
4092 that enable them.  The directory name is separated from the switches by
4093 @samp{;}, and each switch starts with an @samp{@@} instead of the
4094 @samp{-}, without spaces between multiple switches.  This is supposed to
4095 ease shell-processing.
4096
4097 @item -print-prog-name=@var{program}
4098 @opindex print-prog-name
4099 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4100
4101 @item -print-libgcc-file-name
4102 @opindex print-libgcc-file-name
4103 Same as @option{-print-file-name=libgcc.a}.
4104
4105 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4106 but you do want to link with @file{libgcc.a}.  You can do
4107
4108 @smallexample
4109 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4110 @end smallexample
4111
4112 @item -print-search-dirs
4113 @opindex print-search-dirs
4114 Print the name of the configured installation directory and a list of
4115 program and library directories @command{gcc} will search---and don't do anything else.
4116
4117 This is useful when @command{gcc} prints the error message
4118 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4119 To resolve this you either need to put @file{cpp0} and the other compiler
4120 components where @command{gcc} expects to find them, or you can set the environment
4121 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4122 Don't forget the trailing @samp{/}.
4123 @xref{Environment Variables}.
4124
4125 @item -dumpmachine
4126 @opindex dumpmachine
4127 Print the compiler's target machine (for example,
4128 @samp{i686-pc-linux-gnu})---and don't do anything else.
4129
4130 @item -dumpversion
4131 @opindex dumpversion
4132 Print the compiler version (for example, @samp{3.0})---and don't do
4133 anything else.
4134
4135 @item -dumpspecs
4136 @opindex dumpspecs
4137 Print the compiler's built-in specs---and don't do anything else.  (This
4138 is used when GCC itself is being built.)  @xref{Spec Files}.
4139
4140 @item -feliminate-unused-debug-types
4141 @opindex feliminate-unused-debug-types
4142 Normally, when producing DWARF2 output, GCC will emit debugging
4143 information for all types declared in a compilation
4144 unit, regardless of whether or not they are actually used
4145 in that compilation unit.  Sometimes this is useful, such as
4146 if, in the debugger, you want to cast a value to a type that is
4147 not actually used in your program (but is declared).  More often,
4148 however, this results in a significant amount of wasted space.
4149 With this option, GCC will avoid producing debug symbol output
4150 for types that are nowhere used in the source file being compiled.
4151 @end table
4152
4153 @node Optimize Options
4154 @section Options That Control Optimization
4155 @cindex optimize options
4156 @cindex options, optimization
4157
4158 These options control various sorts of optimizations.
4159
4160 Without any optimization option, the compiler's goal is to reduce the
4161 cost of compilation and to make debugging produce the expected
4162 results.  Statements are independent: if you stop the program with a
4163 breakpoint between statements, you can then assign a new value to any
4164 variable or change the program counter to any other statement in the
4165 function and get exactly the results you would expect from the source
4166 code.
4167
4168 Turning on optimization flags makes the compiler attempt to improve
4169 the performance and/or code size at the expense of compilation time
4170 and possibly the ability to debug the program.
4171
4172 The compiler performs optimization based on the knowledge it has of
4173 the program.  Optimization levels @option{-O2} and above, in
4174 particular, enable @emph{unit-at-a-time} mode, which allows the
4175 compiler to consider information gained from later functions in
4176 the file when compiling a function.  Compiling multiple files at
4177 once to a single output file in @emph{unit-at-a-time} mode allows
4178 the compiler to use information gained from all of the files when
4179 compiling each of them.
4180
4181 Not all optimizations are controlled directly by a flag.  Only
4182 optimizations that have a flag are listed.
4183
4184 @table @gcctabopt
4185 @item -O
4186 @itemx -O1
4187 @opindex O
4188 @opindex O1
4189 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4190 more memory for a large function.
4191
4192 With @option{-O}, the compiler tries to reduce code size and execution
4193 time, without performing any optimizations that take a great deal of
4194 compilation time.
4195
4196 @option{-O} turns on the following optimization flags:
4197 @gccoptlist{-fdefer-pop @gol
4198 -fdelayed-branch @gol
4199 -fguess-branch-probability @gol
4200 -fcprop-registers @gol
4201 -floop-optimize @gol
4202 -fif-conversion @gol
4203 -fif-conversion2 @gol
4204 -ftree-ccp @gol
4205 -ftree-dce @gol
4206 -ftree-dominator-opts @gol
4207 -ftree-dse @gol
4208 -ftree-ter @gol
4209 -ftree-lrs @gol
4210 -ftree-sra @gol
4211 -ftree-copyrename @gol
4212 -ftree-fre @gol
4213 -ftree-ch @gol
4214 -fmerge-constants}
4215
4216 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4217 where doing so does not interfere with debugging.
4218
4219 @item -O2
4220 @opindex O2
4221 Optimize even more.  GCC performs nearly all supported optimizations
4222 that do not involve a space-speed tradeoff.  The compiler does not
4223 perform loop unrolling or function inlining when you specify @option{-O2}.
4224 As compared to @option{-O}, this option increases both compilation time
4225 and the performance of the generated code.
4226
4227 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4228 also turns on the following optimization flags:
4229 @gccoptlist{-fthread-jumps @gol
4230 -fcrossjumping @gol
4231 -foptimize-sibling-calls @gol
4232 -fcse-follow-jumps  -fcse-skip-blocks @gol
4233 -fgcse  -fgcse-lm  @gol
4234 -fexpensive-optimizations @gol
4235 -fstrength-reduce @gol
4236 -frerun-cse-after-loop  -frerun-loop-opt @gol
4237 -fcaller-saves @gol
4238 -fforce-mem @gol
4239 -fpeephole2 @gol
4240 -fschedule-insns  -fschedule-insns2 @gol
4241 -fsched-interblock  -fsched-spec @gol
4242 -fregmove @gol
4243 -fstrict-aliasing @gol
4244 -fdelete-null-pointer-checks @gol
4245 -freorder-blocks  -freorder-functions @gol
4246 -funit-at-a-time @gol
4247 -falign-functions  -falign-jumps @gol
4248 -falign-loops  -falign-labels @gol
4249 -ftree-pre}
4250
4251 Please note the warning under @option{-fgcse} about
4252 invoking @option{-O2} on programs that use computed gotos.
4253
4254 @item -O3
4255 @opindex O3
4256 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4257 @option{-O2} and also turns on the @option{-finline-functions},
4258 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4259
4260 @item -O0
4261 @opindex O0
4262 Do not optimize.  This is the default.
4263
4264 @item -Os
4265 @opindex Os
4266 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4267 do not typically increase code size.  It also performs further
4268 optimizations designed to reduce code size.
4269
4270 @option{-Os} disables the following optimization flags:
4271 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4272 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4273
4274 If you use multiple @option{-O} options, with or without level numbers,
4275 the last such option is the one that is effective.
4276 @end table
4277
4278 Options of the form @option{-f@var{flag}} specify machine-independent
4279 flags.  Most flags have both positive and negative forms; the negative
4280 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4281 below, only one of the forms is listed---the one you typically will
4282 use.  You can figure out the other form by either removing @samp{no-}
4283 or adding it.
4284
4285 The following options control specific optimizations.  They are either
4286 activated by @option{-O} options or are related to ones that are.  You
4287 can use the following flags in the rare cases when ``fine-tuning'' of
4288 optimizations to be performed is desired.
4289
4290 @table @gcctabopt
4291 @item -fno-default-inline
4292 @opindex fno-default-inline
4293 Do not make member functions inline by default merely because they are
4294 defined inside the class scope (C++ only).  Otherwise, when you specify
4295 @w{@option{-O}}, member functions defined inside class scope are compiled
4296 inline by default; i.e., you don't need to add @samp{inline} in front of
4297 the member function name.
4298
4299 @item -fno-defer-pop
4300 @opindex fno-defer-pop
4301 Always pop the arguments to each function call as soon as that function
4302 returns.  For machines which must pop arguments after a function call,
4303 the compiler normally lets arguments accumulate on the stack for several
4304 function calls and pops them all at once.
4305
4306 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4307
4308 @item -fforce-mem
4309 @opindex fforce-mem
4310 Force memory operands to be copied into registers before doing
4311 arithmetic on them.  This produces better code by making all memory
4312 references potential common subexpressions.  When they are not common
4313 subexpressions, instruction combination should eliminate the separate
4314 register-load.
4315
4316 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4317
4318 @item -fforce-addr
4319 @opindex fforce-addr
4320 Force memory address constants to be copied into registers before
4321 doing arithmetic on them.  This may produce better code just as
4322 @option{-fforce-mem} may.
4323
4324 @item -fomit-frame-pointer
4325 @opindex fomit-frame-pointer
4326 Don't keep the frame pointer in a register for functions that
4327 don't need one.  This avoids the instructions to save, set up and
4328 restore frame pointers; it also makes an extra register available
4329 in many functions.  @strong{It also makes debugging impossible on
4330 some machines.}
4331
4332 On some machines, such as the VAX, this flag has no effect, because
4333 the standard calling sequence automatically handles the frame pointer
4334 and nothing is saved by pretending it doesn't exist.  The
4335 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4336 whether a target machine supports this flag.  @xref{Registers,,Register
4337 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4338
4339 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4340
4341 @item -foptimize-sibling-calls
4342 @opindex foptimize-sibling-calls
4343 Optimize sibling and tail recursive calls.
4344
4345 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4346
4347 @item -fno-inline
4348 @opindex fno-inline
4349 Don't pay attention to the @code{inline} keyword.  Normally this option
4350 is used to keep the compiler from expanding any functions inline.
4351 Note that if you are not optimizing, no functions can be expanded inline.
4352
4353 @item -finline-functions
4354 @opindex finline-functions
4355 Integrate all simple functions into their callers.  The compiler
4356 heuristically decides which functions are simple enough to be worth
4357 integrating in this way.
4358
4359 If all calls to a given function are integrated, and the function is
4360 declared @code{static}, then the function is normally not output as
4361 assembler code in its own right.
4362
4363 Enabled at level @option{-O3}.
4364
4365 @item -finline-limit=@var{n}
4366 @opindex finline-limit
4367 By default, GCC limits the size of functions that can be inlined.  This flag
4368 allows the control of this limit for functions that are explicitly marked as
4369 inline (i.e., marked with the inline keyword or defined within the class
4370 definition in c++).  @var{n} is the size of functions that can be inlined in
4371 number of pseudo instructions (not counting parameter handling).  The default
4372 value of @var{n} is 600.
4373 Increasing this value can result in more inlined code at
4374 the cost of compilation time and memory consumption.  Decreasing usually makes
4375 the compilation faster and less code will be inlined (which presumably
4376 means slower programs).  This option is particularly useful for programs that
4377 use inlining heavily such as those based on recursive templates with C++.
4378
4379 Inlining is actually controlled by a number of parameters, which may be
4380 specified individually by using @option{--param @var{name}=@var{value}}.
4381 The @option{-finline-limit=@var{n}} option sets some of these parameters
4382 as follows:
4383
4384 @table @gcctabopt
4385  @item max-inline-insns-single
4386   is set to @var{n}/2.
4387  @item max-inline-insns-auto
4388   is set to @var{n}/2.
4389  @item min-inline-insns
4390   is set to 130 or @var{n}/4, whichever is smaller.
4391  @item max-inline-insns-rtl
4392   is set to @var{n}.
4393 @end table
4394
4395 See below for a documentation of the individual
4396 parameters controlling inlining.
4397
4398 @emph{Note:} pseudo instruction represents, in this particular context, an
4399 abstract measurement of function's size.  In no way, it represents a count
4400 of assembly instructions and as such its exact meaning might change from one
4401 release to an another.
4402
4403 @item -fkeep-inline-functions
4404 @opindex fkeep-inline-functions
4405 In C, emit @code{static} functions that are declared @code{inline}
4406 into the object file, even if the function has been inlined into all
4407 of its callers.  This switch does not affect functions using the
4408 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4409 inline functions into the object file.
4410
4411 @item -fkeep-static-consts
4412 @opindex fkeep-static-consts
4413 Emit variables declared @code{static const} when optimization isn't turned
4414 on, even if the variables aren't referenced.
4415
4416 GCC enables this option by default.  If you want to force the compiler to
4417 check if the variable was referenced, regardless of whether or not
4418 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4419
4420 @item -fmerge-constants
4421 Attempt to merge identical constants (string constants and floating point
4422 constants) across compilation units.
4423
4424 This option is the default for optimized compilation if the assembler and
4425 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4426 behavior.
4427
4428 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4429
4430 @item -fmerge-all-constants
4431 Attempt to merge identical constants and identical variables.
4432
4433 This option implies @option{-fmerge-constants}.  In addition to
4434 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4435 arrays or initialized constant variables with integral or floating point
4436 types.  Languages like C or C++ require each non-automatic variable to
4437 have distinct location, so using this option will result in non-conforming
4438 behavior.
4439
4440 @item -fmodulo-sched
4441 @opindex fmodulo-sched
4442 Perform swing modulo scheduling immediately before the first scheduling
4443 pass.  This pass looks at innermost loops and reorders their
4444 instructions by overlapping different iterations.
4445
4446 @item -fno-branch-count-reg
4447 @opindex fno-branch-count-reg
4448 Do not use ``decrement and branch'' instructions on a count register,
4449 but instead generate a sequence of instructions that decrement a
4450 register, compare it against zero, then branch based upon the result.
4451 This option is only meaningful on architectures that support such
4452 instructions, which include x86, PowerPC, IA-64 and S/390.
4453
4454 The default is @option{-fbranch-count-reg}, enabled when
4455 @option{-fstrength-reduce} is enabled.
4456
4457 @item -fno-function-cse
4458 @opindex fno-function-cse
4459 Do not put function addresses in registers; make each instruction that
4460 calls a constant function contain the function's address explicitly.
4461
4462 This option results in less efficient code, but some strange hacks
4463 that alter the assembler output may be confused by the optimizations
4464 performed when this option is not used.
4465
4466 The default is @option{-ffunction-cse}
4467
4468 @item -fno-zero-initialized-in-bss
4469 @opindex fno-zero-initialized-in-bss
4470 If the target supports a BSS section, GCC by default puts variables that
4471 are initialized to zero into BSS@.  This can save space in the resulting
4472 code.
4473
4474 This option turns off this behavior because some programs explicitly
4475 rely on variables going to the data section.  E.g., so that the
4476 resulting executable can find the beginning of that section and/or make
4477 assumptions based on that.
4478
4479 The default is @option{-fzero-initialized-in-bss}.
4480
4481 @item -fbounds-check
4482 @opindex fbounds-check
4483 For front-ends that support it, generate additional code to check that
4484 indices used to access arrays are within the declared range.  This is
4485 currently only supported by the Java and Fortran front-ends, where
4486 this option defaults to true and false respectively.
4487
4488 @item -fmudflap -fmudflapth -fmudflapir
4489 @opindex fmudflap
4490 @opindex fmudflapth
4491 @opindex fmudflapir
4492 @cindex bounds checking
4493 @cindex mudflap
4494 For front-ends that support it (C and C++), instrument all risky
4495 pointer/array dereferencing operations, some standard library
4496 string/heap functions, and some other associated constructs with
4497 range/validity tests.  Modules so instrumented should be immune to
4498 buffer overflows, invalid heap use, and some other classes of C/C++
4499 programming errors.  The instrumentation relies on a separate runtime
4500 library (@file{libmudflap}), which will be linked into a program if
4501 @option{-fmudflap} is given at link time.  Run-time behavior of the
4502 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4503 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4504 for its options.
4505
4506 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4507 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4508 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4509 instrumentation should ignore pointer reads.  This produces less
4510 instrumentation (and therefore faster execution) and still provides
4511 some protection against outright memory corrupting writes, but allows
4512 erroneously read data to propagate within a program.
4513
4514 @item -fstrength-reduce
4515 @opindex fstrength-reduce
4516 Perform the optimizations of loop strength reduction and
4517 elimination of iteration variables.
4518
4519 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4520
4521 @item -fthread-jumps
4522 @opindex fthread-jumps
4523 Perform optimizations where we check to see if a jump branches to a
4524 location where another comparison subsumed by the first is found.  If
4525 so, the first branch is redirected to either the destination of the
4526 second branch or a point immediately following it, depending on whether
4527 the condition is known to be true or false.
4528
4529 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4530
4531 @item -fcse-follow-jumps
4532 @opindex fcse-follow-jumps
4533 In common subexpression elimination, scan through jump instructions
4534 when the target of the jump is not reached by any other path.  For
4535 example, when CSE encounters an @code{if} statement with an
4536 @code{else} clause, CSE will follow the jump when the condition
4537 tested is false.
4538
4539 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4540
4541 @item -fcse-skip-blocks
4542 @opindex fcse-skip-blocks
4543 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4544 follow jumps which conditionally skip over blocks.  When CSE
4545 encounters a simple @code{if} statement with no else clause,
4546 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4547 body of the @code{if}.
4548
4549 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4550
4551 @item -frerun-cse-after-loop
4552 @opindex frerun-cse-after-loop
4553 Re-run common subexpression elimination after loop optimizations has been
4554 performed.
4555
4556 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4557
4558 @item -frerun-loop-opt
4559 @opindex frerun-loop-opt
4560 Run the loop optimizer twice.
4561
4562 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4563
4564 @item -fgcse
4565 @opindex fgcse
4566 Perform a global common subexpression elimination pass.
4567 This pass also performs global constant and copy propagation.
4568
4569 @emph{Note:} When compiling a program using computed gotos, a GCC
4570 extension, you may get better runtime performance if you disable
4571 the global common subexpression elimination pass by adding
4572 @option{-fno-gcse} to the command line.
4573
4574 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4575
4576 @item -fgcse-lm
4577 @opindex fgcse-lm
4578 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4579 attempt to move loads which are only killed by stores into themselves.  This
4580 allows a loop containing a load/store sequence to be changed to a load outside
4581 the loop, and a copy/store within the loop.
4582
4583 Enabled by default when gcse is enabled.
4584
4585 @item -fgcse-sm
4586 @opindex fgcse-sm
4587 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4588 global common subexpression elimination.  This pass will attempt to move
4589 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4590 loops containing a load/store sequence can be changed to a load before
4591 the loop and a store after the loop.
4592
4593 Not enabled at any optimization level.
4594
4595 @item -fgcse-las
4596 @opindex fgcse-las
4597 When @option{-fgcse-las} is enabled, the global common subexpression
4598 elimination pass eliminates redundant loads that come after stores to the
4599 same memory location (both partial and full redundancies).
4600
4601 Not enabled at any optimization level.
4602
4603 @item -fgcse-after-reload
4604 @opindex fgcse-after-reload
4605 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4606 pass is performed after reload.  The purpose of this pass is to cleanup
4607 redundant spilling.
4608
4609 @item -floop-optimize
4610 @opindex floop-optimize
4611 Perform loop optimizations: move constant expressions out of loops, simplify
4612 exit test conditions and optionally do strength-reduction as well.
4613
4614 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4615
4616 @item -floop-optimize2
4617 @opindex floop-optimize2
4618 Perform loop optimizations using the new loop optimizer.  The optimizations
4619 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4620 by separate flags.
4621
4622 @item -fcrossjumping
4623 @opindex crossjumping
4624 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4625 resulting code may or may not perform better than without cross-jumping.
4626
4627 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4628
4629 @item -fif-conversion
4630 @opindex if-conversion
4631 Attempt to transform conditional jumps into branch-less equivalents.  This
4632 include use of conditional moves, min, max, set flags and abs instructions, and
4633 some tricks doable by standard arithmetics.  The use of conditional execution
4634 on chips where it is available is controlled by @code{if-conversion2}.
4635
4636 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4637
4638 @item -fif-conversion2
4639 @opindex if-conversion2
4640 Use conditional execution (where available) to transform conditional jumps into
4641 branch-less equivalents.
4642
4643 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4644
4645 @item -fdelete-null-pointer-checks
4646 @opindex fdelete-null-pointer-checks
4647 Use global dataflow analysis to identify and eliminate useless checks
4648 for null pointers.  The compiler assumes that dereferencing a null
4649 pointer would have halted the program.  If a pointer is checked after
4650 it has already been dereferenced, it cannot be null.
4651
4652 In some environments, this assumption is not true, and programs can
4653 safely dereference null pointers.  Use
4654 @option{-fno-delete-null-pointer-checks} to disable this optimization
4655 for programs which depend on that behavior.
4656
4657 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4658
4659 @item -fexpensive-optimizations
4660 @opindex fexpensive-optimizations
4661 Perform a number of minor optimizations that are relatively expensive.
4662
4663 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4664
4665 @item -foptimize-register-move
4666 @itemx -fregmove
4667 @opindex foptimize-register-move
4668 @opindex fregmove
4669 Attempt to reassign register numbers in move instructions and as
4670 operands of other simple instructions in order to maximize the amount of
4671 register tying.  This is especially helpful on machines with two-operand
4672 instructions.
4673
4674 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4675 optimization.
4676
4677 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4678
4679 @item -fdelayed-branch
4680 @opindex fdelayed-branch
4681 If supported for the target machine, attempt to reorder instructions
4682 to exploit instruction slots available after delayed branch
4683 instructions.
4684
4685 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4686
4687 @item -fschedule-insns
4688 @opindex fschedule-insns
4689 If supported for the target machine, attempt to reorder instructions to
4690 eliminate execution stalls due to required data being unavailable.  This
4691 helps machines that have slow floating point or memory load instructions
4692 by allowing other instructions to be issued until the result of the load
4693 or floating point instruction is required.
4694
4695 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4696
4697 @item -fschedule-insns2
4698 @opindex fschedule-insns2
4699 Similar to @option{-fschedule-insns}, but requests an additional pass of
4700 instruction scheduling after register allocation has been done.  This is
4701 especially useful on machines with a relatively small number of
4702 registers and where memory load instructions take more than one cycle.
4703
4704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4705
4706 @item -fno-sched-interblock
4707 @opindex fno-sched-interblock
4708 Don't schedule instructions across basic blocks.  This is normally
4709 enabled by default when scheduling before register allocation, i.e.@:
4710 with @option{-fschedule-insns} or at @option{-O2} or higher.
4711
4712 @item -fno-sched-spec
4713 @opindex fno-sched-spec
4714 Don't allow speculative motion of non-load instructions.  This is normally
4715 enabled by default when scheduling before register allocation, i.e.@:
4716 with @option{-fschedule-insns} or at @option{-O2} or higher.
4717
4718 @item -fsched-spec-load
4719 @opindex fsched-spec-load
4720 Allow speculative motion of some load instructions.  This only makes
4721 sense when scheduling before register allocation, i.e.@: with
4722 @option{-fschedule-insns} or at @option{-O2} or higher.
4723
4724 @item -fsched-spec-load-dangerous
4725 @opindex fsched-spec-load-dangerous
4726 Allow speculative motion of more load instructions.  This only makes
4727 sense when scheduling before register allocation, i.e.@: with
4728 @option{-fschedule-insns} or at @option{-O2} or higher.
4729
4730 @item -fsched-stalled-insns=@var{n}
4731 @opindex fsched-stalled-insns
4732 Define how many insns (if any) can be moved prematurely from the queue
4733 of stalled insns into the ready list, during the second scheduling pass.
4734
4735 @item -fsched-stalled-insns-dep=@var{n}
4736 @opindex fsched-stalled-insns-dep
4737 Define how many insn groups (cycles) will be examined for a dependency
4738 on a stalled insn that is candidate for premature removal from the queue
4739 of stalled insns.  Has an effect only during the second scheduling pass,
4740 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4741
4742 @item -fsched2-use-superblocks
4743 @opindex fsched2-use-superblocks
4744 When scheduling after register allocation, do use superblock scheduling
4745 algorithm.  Superblock scheduling allows motion across basic block boundaries
4746 resulting on faster schedules.  This option is experimental, as not all machine
4747 descriptions used by GCC model the CPU closely enough to avoid unreliable
4748 results from the algorithm.
4749
4750 This only makes sense when scheduling after register allocation, i.e.@: with
4751 @option{-fschedule-insns2} or at @option{-O2} or higher.
4752
4753 @item -fsched2-use-traces
4754 @opindex fsched2-use-traces
4755 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4756 allocation and additionally perform code duplication in order to increase the
4757 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4758 trace formation.
4759
4760 This mode should produce faster but significantly longer programs.  Also
4761 without @option{-fbranch-probabilities} the traces constructed may not
4762 match the reality and hurt the performance.  This only makes
4763 sense when scheduling after register allocation, i.e.@: with
4764 @option{-fschedule-insns2} or at @option{-O2} or higher.
4765
4766 @item -freschedule-modulo-scheduled-loops
4767 @opindex fscheduling-in-modulo-scheduled-loops
4768 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4769 we may want to prevent the later scheduling passes from changing its schedule, we use this
4770 option to control that.
4771
4772 @item -fcaller-saves
4773 @opindex fcaller-saves
4774 Enable values to be allocated in registers that will be clobbered by
4775 function calls, by emitting extra instructions to save and restore the
4776 registers around such calls.  Such allocation is done only when it
4777 seems to result in better code than would otherwise be produced.
4778
4779 This option is always enabled by default on certain machines, usually
4780 those which have no call-preserved registers to use instead.
4781
4782 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4783
4784 @item -ftree-pre
4785 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4786 enabled by default at @option{-O2} and @option{-O3}.
4787
4788 @item -ftree-fre
4789 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4790 between FRE and PRE is that FRE only considers expressions
4791 that are computed on all paths leading to the redundant computation.
4792 This analysis faster than PRE, though it exposes fewer redundancies.
4793 This flag is enabled by default at @option{-O} and higher.
4794
4795 @item -ftree-copy-prop
4796 Perform copy propagation on trees.  This pass eliminates unnecessary
4797 copy operations.  This flag is enabled by default at @option{-O} and
4798 higher.
4799
4800 @item -ftree-store-copy-prop
4801 Perform copy propagation of memory loads and stores.  This pass
4802 eliminates unnecessary copy operations in memory references
4803 (structures, global variables, arrays, etc).  This flag is enabled by
4804 default at @option{-O2} and higher.
4805
4806 @item -ftree-salias
4807 Perform structural alias analysis on trees.  This flag
4808 is enabled by default at @option{-O} and higher.
4809
4810 @item -ftree-sink
4811 Perform forward store motion  on trees.  This flag is
4812 enabled by default at @option{-O} and higher.
4813
4814 @item -ftree-ccp
4815 Perform sparse conditional constant propagation (CCP) on trees.  This
4816 pass only operates on local scalar variables and is enabled by default
4817 at @option{-O} and higher.
4818
4819 @item -ftree-store-ccp
4820 Perform sparse conditional constant propagation (CCP) on trees.  This
4821 pass operates on both local scalar variables and memory stores and
4822 loads (global variables, structures, arrays, etc).  This flag is
4823 enabled by default at @option{-O2} and higher.
4824
4825 @item -ftree-dce
4826 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4827 default at @option{-O} and higher.
4828
4829 @item -ftree-dominator-opts
4830 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4831 default at @option{-O} and higher.
4832
4833 @item -ftree-ch
4834 Perform loop header copying on trees.  This is beneficial since it increases
4835 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4836 is enabled by default at @option{-O} and higher.  It is not enabled
4837 for @option{-Os}, since it usually increases code size.
4838
4839 @item -ftree-loop-optimize
4840 Perform loop optimizations on trees.  This flag is enabled by default
4841 at @option{-O} and higher.
4842
4843 @item -ftree-loop-linear
4844 Perform linear loop transformations on tree.  This flag can improve cache
4845 performance and allow further loop optimizations to take place.
4846
4847 @item -ftree-loop-im
4848 Perform loop invariant motion on trees.  This pass moves only invariants that
4849 would be hard to handle at RTL level (function calls, operations that expand to
4850 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4851 operands of conditions that are invariant out of the loop, so that we can use
4852 just trivial invariantness analysis in loop unswitching.  The pass also includes
4853 store motion.
4854
4855 @item -ftree-loop-ivcanon
4856 Create a canonical counter for number of iterations in the loop for that
4857 determining number of iterations requires complicated analysis.  Later
4858 optimizations then may determine the number easily.  Useful especially
4859 in connection with unrolling.
4860
4861 @item -fivopts
4862 Perform induction variable optimizations (strength reduction, induction
4863 variable merging and induction variable elimination) on trees.
4864
4865 @item -ftree-sra
4866 Perform scalar replacement of aggregates.  This pass replaces structure
4867 references with scalars to prevent committing structures to memory too
4868 early.  This flag is enabled by default at @option{-O} and higher.
4869
4870 @item -ftree-copyrename
4871 Perform copy renaming on trees.  This pass attempts to rename compiler
4872 temporaries to other variables at copy locations, usually resulting in
4873 variable names which more closely resemble the original variables.  This flag
4874 is enabled by default at @option{-O} and higher.
4875
4876 @item -ftree-ter
4877 Perform temporary expression replacement during the SSA->normal phase.  Single
4878 use/single def temporaries are replaced at their use location with their
4879 defining expression.  This results in non-GIMPLE code, but gives the expanders
4880 much more complex trees to work on resulting in better RTL generation.  This is
4881 enabled by default at @option{-O} and higher.
4882
4883 @item -ftree-lrs
4884 Perform live range splitting during the SSA->normal phase.  Distinct live
4885 ranges of a variable are split into unique variables, allowing for better
4886 optimization later.  This is enabled by default at @option{-O} and higher.
4887
4888 @item -ftree-vectorize
4889 Perform loop vectorization on trees.
4890
4891 @item -ftracer
4892 @opindex ftracer
4893 Perform tail duplication to enlarge superblock size.  This transformation
4894 simplifies the control flow of the function allowing other optimizations to do
4895 better job.
4896
4897 @item -funroll-loops
4898 @opindex funroll-loops
4899 Unroll loops whose number of iterations can be determined at compile
4900 time or upon entry to the loop.  @option{-funroll-loops} implies both
4901 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4902 option makes code larger, and may or may not make it run faster.
4903
4904 @item -funroll-all-loops
4905 @opindex funroll-all-loops
4906 Unroll all loops, even if their number of iterations is uncertain when
4907 the loop is entered.  This usually makes programs run more slowly.
4908 @option{-funroll-all-loops} implies the same options as
4909 @option{-funroll-loops},
4910
4911 @item -fsplit-ivs-in-unroller
4912 @opindex -fsplit-ivs-in-unroller
4913 Enables expressing of values of induction variables in later iterations
4914 of the unrolled loop using the value in the first iteration.  This breaks
4915 long dependency chains, thus improving efficiency of the scheduling passes
4916 (for best results, @option{-fweb} should be used as well).
4917
4918 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4919 same effect.  However in cases the loop body is more complicated than
4920 a single basic block, this is not reliable.  It also does not work at all
4921 on some of the architectures due to restrictions in the CSE pass.
4922
4923 This optimization is enabled by default.
4924
4925 @item -fvariable-expansion-in-unroller
4926 @opindex -fvariable-expansion-in-unroller
4927 With this option, the compiler will create multiple copies of some
4928 local variables when unrolling a loop which can result in superior code.
4929
4930 @item -fprefetch-loop-arrays
4931 @opindex fprefetch-loop-arrays
4932 If supported by the target machine, generate instructions to prefetch
4933 memory to improve the performance of loops that access large arrays.
4934
4935 These options may generate better or worse code; results are highly
4936 dependent on the structure of loops within the source code.
4937
4938 @item -fno-peephole
4939 @itemx -fno-peephole2
4940 @opindex fno-peephole
4941 @opindex fno-peephole2
4942 Disable any machine-specific peephole optimizations.  The difference
4943 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4944 are implemented in the compiler; some targets use one, some use the
4945 other, a few use both.
4946
4947 @option{-fpeephole} is enabled by default.
4948 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4949
4950 @item -fno-guess-branch-probability
4951 @opindex fno-guess-branch-probability
4952 Do not guess branch probabilities using heuristics.
4953
4954 GCC will use heuristics to guess branch probabilities if they are
4955 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4956 heuristics are based on the control flow graph.  If some branch probabilities
4957 are specified by @samp{__builtin_expect}, then the heuristics will be
4958 used to guess branch probabilities for the rest of the control flow graph,
4959 taking the @samp{__builtin_expect} info into account.  The interactions
4960 between the heuristics and @samp{__builtin_expect} can be complex, and in
4961 some cases, it may be useful to disable the heuristics so that the effects
4962 of @samp{__builtin_expect} are easier to understand.
4963
4964 The default is @option{-fguess-branch-probability} at levels
4965 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4966
4967 @item -freorder-blocks
4968 @opindex freorder-blocks
4969 Reorder basic blocks in the compiled function in order to reduce number of
4970 taken branches and improve code locality.
4971
4972 Enabled at levels @option{-O2}, @option{-O3}.
4973
4974 @item -freorder-blocks-and-partition
4975 @opindex freorder-blocks-and-partition
4976 In addition to reordering basic blocks in the compiled function, in order
4977 to reduce number of taken branches, partitions hot and cold basic blocks
4978 into separate sections of the assembly and .o files, to improve
4979 paging and cache locality performance.
4980
4981 This optimization is automatically turned off in the presence of
4982 exception handling, for linkonce sections, for functions with a user-defined
4983 section attribute and on any architecture that does not support named
4984 sections.
4985
4986 @item -freorder-functions
4987 @opindex freorder-functions
4988 Reorder functions in the object file in order to
4989 improve code locality.  This is implemented by using special
4990 subsections @code{.text.hot} for most frequently executed functions and
4991 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4992 the linker so object file format must support named sections and linker must
4993 place them in a reasonable way.
4994
4995 Also profile feedback must be available in to make this option effective.  See
4996 @option{-fprofile-arcs} for details.
4997
4998 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4999
5000 @item -fstrict-aliasing
5001 @opindex fstrict-aliasing
5002 Allows the compiler to assume the strictest aliasing rules applicable to
5003 the language being compiled.  For C (and C++), this activates
5004 optimizations based on the type of expressions.  In particular, an
5005 object of one type is assumed never to reside at the same address as an
5006 object of a different type, unless the types are almost the same.  For
5007 example, an @code{unsigned int} can alias an @code{int}, but not a
5008 @code{void*} or a @code{double}.  A character type may alias any other
5009 type.
5010
5011 Pay special attention to code like this:
5012 @smallexample
5013 union a_union @{
5014   int i;
5015   double d;
5016 @};
5017
5018 int f() @{
5019   a_union t;
5020   t.d = 3.0;
5021   return t.i;
5022 @}
5023 @end smallexample
5024 The practice of reading from a different union member than the one most
5025 recently written to (called ``type-punning'') is common.  Even with
5026 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5027 is accessed through the union type.  So, the code above will work as
5028 expected.  However, this code might not:
5029 @smallexample
5030 int f() @{
5031   a_union t;
5032   int* ip;
5033   t.d = 3.0;
5034   ip = &t.i;
5035   return *ip;
5036 @}
5037 @end smallexample
5038
5039 Every language that wishes to perform language-specific alias analysis
5040 should define a function that computes, given an @code{tree}
5041 node, an alias set for the node.  Nodes in different alias sets are not
5042 allowed to alias.  For an example, see the C front-end function
5043 @code{c_get_alias_set}.
5044
5045 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5046
5047 @item -falign-functions
5048 @itemx -falign-functions=@var{n}
5049 @opindex falign-functions
5050 Align the start of functions to the next power-of-two greater than
5051 @var{n}, skipping up to @var{n} bytes.  For instance,
5052 @option{-falign-functions=32} aligns functions to the next 32-byte
5053 boundary, but @option{-falign-functions=24} would align to the next
5054 32-byte boundary only if this can be done by skipping 23 bytes or less.
5055
5056 @option{-fno-align-functions} and @option{-falign-functions=1} are
5057 equivalent and mean that functions will not be aligned.
5058
5059 Some assemblers only support this flag when @var{n} is a power of two;
5060 in that case, it is rounded up.
5061
5062 If @var{n} is not specified or is zero, use a machine-dependent default.
5063
5064 Enabled at levels @option{-O2}, @option{-O3}.
5065
5066 @item -falign-labels
5067 @itemx -falign-labels=@var{n}
5068 @opindex falign-labels
5069 Align all branch targets to a power-of-two boundary, skipping up to
5070 @var{n} bytes like @option{-falign-functions}.  This option can easily
5071 make code slower, because it must insert dummy operations for when the
5072 branch target is reached in the usual flow of the code.
5073
5074 @option{-fno-align-labels} and @option{-falign-labels=1} are
5075 equivalent and mean that labels will not be aligned.
5076
5077 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5078 are greater than this value, then their values are used instead.
5079
5080 If @var{n} is not specified or is zero, use a machine-dependent default
5081 which is very likely to be @samp{1}, meaning no alignment.
5082
5083 Enabled at levels @option{-O2}, @option{-O3}.
5084
5085 @item -falign-loops
5086 @itemx -falign-loops=@var{n}
5087 @opindex falign-loops
5088 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5089 like @option{-falign-functions}.  The hope is that the loop will be
5090 executed many times, which will make up for any execution of the dummy
5091 operations.
5092
5093 @option{-fno-align-loops} and @option{-falign-loops=1} are
5094 equivalent and mean that loops will not be aligned.
5095
5096 If @var{n} is not specified or is zero, use a machine-dependent default.
5097
5098 Enabled at levels @option{-O2}, @option{-O3}.
5099
5100 @item -falign-jumps
5101 @itemx -falign-jumps=@var{n}
5102 @opindex falign-jumps
5103 Align branch targets to a power-of-two boundary, for branch targets
5104 where the targets can only be reached by jumping, skipping up to @var{n}
5105 bytes like @option{-falign-functions}.  In this case, no dummy operations
5106 need be executed.
5107
5108 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5109 equivalent and mean that loops will not be aligned.
5110
5111 If @var{n} is not specified or is zero, use a machine-dependent default.
5112
5113 Enabled at levels @option{-O2}, @option{-O3}.
5114
5115 @item -funit-at-a-time
5116 @opindex funit-at-a-time
5117 Parse the whole compilation unit before starting to produce code.
5118 This allows some extra optimizations to take place but consumes
5119 more memory (in general).  There are some compatibility issues
5120 with @emph{unit-at-at-time} mode:
5121 @itemize @bullet
5122 @item
5123 enabling @emph{unit-at-a-time} mode may change the order
5124 in which functions, variables, and top-level @code{asm} statements
5125 are emitted, and will likely break code relying on some particular
5126 ordering.  The majority of such top-level @code{asm} statements,
5127 though, can be replaced by @code{section} attributes.
5128
5129 @item
5130 @emph{unit-at-a-time} mode removes unreferenced static variables
5131 and functions are removed.  This may result in undefined references
5132 when an @code{asm} statement refers directly to variables or functions
5133 that are otherwise unused.  In that case either the variable/function
5134 shall be listed as an operand of the @code{asm} statement operand or,
5135 in the case of top-level @code{asm} statements the attribute @code{used}
5136 shall be used on the declaration.
5137
5138 @item
5139 Static functions now can use non-standard passing conventions that
5140 may break @code{asm} statements calling functions directly.  Again,
5141 attribute @code{used} will prevent this behavior.
5142 @end itemize
5143
5144 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5145 but this scheme may not be supported by future releases of GCC@.
5146
5147 Enabled at levels @option{-O2}, @option{-O3}.
5148
5149 @item -fweb
5150 @opindex fweb
5151 Constructs webs as commonly used for register allocation purposes and assign
5152 each web individual pseudo register.  This allows the register allocation pass
5153 to operate on pseudos directly, but also strengthens several other optimization
5154 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5155 however, make debugging impossible, since variables will no longer stay in a
5156 ``home register''.
5157
5158 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5159 on targets where the default format for debugging information supports
5160 variable tracking.
5161
5162 @item -fno-cprop-registers
5163 @opindex fno-cprop-registers
5164 After register allocation and post-register allocation instruction splitting,
5165 we perform a copy-propagation pass to try to reduce scheduling dependencies
5166 and occasionally eliminate the copy.
5167
5168 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5169
5170 @item -fprofile-generate
5171 @opindex fprofile-generate
5172
5173 Enable options usually used for instrumenting application to produce
5174 profile useful for later recompilation with profile feedback based
5175 optimization.  You must use @option{-fprofile-generate} both when
5176 compiling and when linking your program.
5177
5178 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5179
5180 @item -fprofile-use
5181 @opindex fprofile-use
5182 Enable profile feedback directed optimizations, and optimizations
5183 generally profitable only with profile feedback available.
5184
5185 The following options are enabled: @code{-fbranch-probabilities},
5186 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5187
5188 @end table
5189
5190 The following options control compiler behavior regarding floating
5191 point arithmetic.  These options trade off between speed and
5192 correctness.  All must be specifically enabled.
5193
5194 @table @gcctabopt
5195 @item -ffloat-store
5196 @opindex ffloat-store
5197 Do not store floating point variables in registers, and inhibit other
5198 options that might change whether a floating point value is taken from a
5199 register or memory.
5200
5201 @cindex floating point precision
5202 This option prevents undesirable excess precision on machines such as
5203 the 68000 where the floating registers (of the 68881) keep more
5204 precision than a @code{double} is supposed to have.  Similarly for the
5205 x86 architecture.  For most programs, the excess precision does only
5206 good, but a few programs rely on the precise definition of IEEE floating
5207 point.  Use @option{-ffloat-store} for such programs, after modifying
5208 them to store all pertinent intermediate computations into variables.
5209
5210 @item -ffast-math
5211 @opindex ffast-math
5212 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5213 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5214 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5215 and @option{fcx-limited-range}.
5216
5217 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5218
5219 This option should never be turned on by any @option{-O} option since
5220 it can result in incorrect output for programs which depend on
5221 an exact implementation of IEEE or ISO rules/specifications for
5222 math functions.
5223
5224 @item -fno-math-errno
5225 @opindex fno-math-errno
5226 Do not set ERRNO after calling math functions that are executed
5227 with a single instruction, e.g., sqrt.  A program that relies on
5228 IEEE exceptions for math error handling may want to use this flag
5229 for speed while maintaining IEEE arithmetic compatibility.
5230
5231 This option should never be turned on by any @option{-O} option since
5232 it can result in incorrect output for programs which depend on
5233 an exact implementation of IEEE or ISO rules/specifications for
5234 math functions.
5235
5236 The default is @option{-fmath-errno}.
5237
5238 @item -funsafe-math-optimizations
5239 @opindex funsafe-math-optimizations
5240 Allow optimizations for floating-point arithmetic that (a) assume
5241 that arguments and results are valid and (b) may violate IEEE or
5242 ANSI standards.  When used at link-time, it may include libraries
5243 or startup files that change the default FPU control word or other
5244 similar optimizations.
5245
5246 This option should never be turned on by any @option{-O} option since
5247 it can result in incorrect output for programs which depend on
5248 an exact implementation of IEEE or ISO rules/specifications for
5249 math functions.
5250
5251 The default is @option{-fno-unsafe-math-optimizations}.
5252
5253 @item -ffinite-math-only
5254 @opindex ffinite-math-only
5255 Allow optimizations for floating-point arithmetic that assume
5256 that arguments and results are not NaNs or +-Infs.
5257
5258 This option should never be turned on by any @option{-O} option since
5259 it can result in incorrect output for programs which depend on
5260 an exact implementation of IEEE or ISO rules/specifications.
5261
5262 The default is @option{-fno-finite-math-only}.
5263
5264 @item -fno-trapping-math
5265 @opindex fno-trapping-math
5266 Compile code assuming that floating-point operations cannot generate
5267 user-visible traps.  These traps include division by zero, overflow,
5268 underflow, inexact result and invalid operation.  This option implies
5269 @option{-fno-signaling-nans}.  Setting this option may allow faster
5270 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5271
5272 This option should never be turned on by any @option{-O} option since
5273 it can result in incorrect output for programs which depend on
5274 an exact implementation of IEEE or ISO rules/specifications for
5275 math functions.
5276
5277 The default is @option{-ftrapping-math}.
5278
5279 @item -frounding-math
5280 @opindex frounding-math
5281 Disable transformations and optimizations that assume default floating
5282 point rounding behavior.  This is round-to-zero for all floating point
5283 to integer conversions, and round-to-nearest for all other arithmetic
5284 truncations.  This option should be specified for programs that change
5285 the FP rounding mode dynamically, or that may be executed with a
5286 non-default rounding mode.  This option disables constant folding of
5287 floating point expressions at compile-time (which may be affected by
5288 rounding mode) and arithmetic transformations that are unsafe in the
5289 presence of sign-dependent rounding modes.
5290
5291 The default is @option{-fno-rounding-math}.
5292
5293 This option is experimental and does not currently guarantee to
5294 disable all GCC optimizations that are affected by rounding mode.
5295 Future versions of GCC may provide finer control of this setting
5296 using C99's @code{FENV_ACCESS} pragma.  This command line option
5297 will be used to specify the default state for @code{FENV_ACCESS}.
5298
5299 @item -fsignaling-nans
5300 @opindex fsignaling-nans
5301 Compile code assuming that IEEE signaling NaNs may generate user-visible
5302 traps during floating-point operations.  Setting this option disables
5303 optimizations that may change the number of exceptions visible with
5304 signaling NaNs.  This option implies @option{-ftrapping-math}.
5305
5306 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5307 be defined.
5308
5309 The default is @option{-fno-signaling-nans}.
5310
5311 This option is experimental and does not currently guarantee to
5312 disable all GCC optimizations that affect signaling NaN behavior.
5313
5314 @item -fsingle-precision-constant
5315 @opindex fsingle-precision-constant
5316 Treat floating point constant as single precision constant instead of
5317 implicitly converting it to double precision constant.
5318
5319 @item -fcx-limited-range
5320 @itemx -fno-cx-limited-range
5321 @opindex fcx-limited-range
5322 @opindex fno-cx-limited-range
5323 When enabled, this option states that a range reduction step is not
5324 needed when performing complex division.  The default is
5325 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5326
5327 This option controls the default setting of the ISO C99 
5328 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5329 all languages.
5330
5331 @end table
5332
5333 The following options control optimizations that may improve
5334 performance, but are not enabled by any @option{-O} options.  This
5335 section includes experimental options that may produce broken code.
5336
5337 @table @gcctabopt
5338 @item -fbranch-probabilities
5339 @opindex fbranch-probabilities
5340 After running a program compiled with @option{-fprofile-arcs}
5341 (@pxref{Debugging Options,, Options for Debugging Your Program or
5342 @command{gcc}}), you can compile it a second time using
5343 @option{-fbranch-probabilities}, to improve optimizations based on
5344 the number of times each branch was taken.  When the program
5345 compiled with @option{-fprofile-arcs} exits it saves arc execution
5346 counts to a file called @file{@var{sourcename}.gcda} for each source
5347 file  The information in this data file is very dependent on the
5348 structure of the generated code, so you must use the same source code
5349 and the same optimization options for both compilations.
5350
5351 With @option{-fbranch-probabilities}, GCC puts a
5352 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5353 These can be used to improve optimization.  Currently, they are only
5354 used in one place: in @file{reorg.c}, instead of guessing which path a
5355 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5356 exactly determine which path is taken more often.
5357
5358 @item -fprofile-values
5359 @opindex fprofile-values
5360 If combined with @option{-fprofile-arcs}, it adds code so that some
5361 data about values of expressions in the program is gathered.
5362
5363 With @option{-fbranch-probabilities}, it reads back the data gathered
5364 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5365 notes to instructions for their later usage in optimizations.
5366
5367 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5368
5369 @item -fvpt
5370 @opindex fvpt
5371 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5372 a code to gather information about values of expressions.
5373
5374 With @option{-fbranch-probabilities}, it reads back the data gathered
5375 and actually performs the optimizations based on them.
5376 Currently the optimizations include specialization of division operation
5377 using the knowledge about the value of the denominator.
5378
5379 @item -fspeculative-prefetching
5380 @opindex fspeculative-prefetching
5381 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5382 a code to gather information about addresses of memory references in the
5383 program.
5384
5385 With @option{-fbranch-probabilities}, it reads back the data gathered
5386 and issues prefetch instructions according to them.  In addition to the opportunities
5387 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5388 memory access patterns---for example accesses to the data stored in linked
5389 list whose elements are usually allocated sequentially.
5390
5391 In order to prevent issuing double prefetches, usage of
5392 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5393
5394 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5395
5396 @item -frename-registers
5397 @opindex frename-registers
5398 Attempt to avoid false dependencies in scheduled code by making use
5399 of registers left over after register allocation.  This optimization
5400 will most benefit processors with lots of registers.  Depending on the
5401 debug information format adopted by the target, however, it can
5402 make debugging impossible, since variables will no longer stay in
5403 a ``home register''.
5404
5405 Not enabled by default at any level because it has known bugs.
5406
5407 @item -ftracer
5408 @opindex ftracer
5409 Perform tail duplication to enlarge superblock size.  This transformation
5410 simplifies the control flow of the function allowing other optimizations to do
5411 better job.
5412
5413 Enabled with @option{-fprofile-use}.
5414
5415 @item -funroll-loops
5416 @opindex funroll-loops
5417 Unroll loops whose number of iterations can be determined at compile time or
5418 upon entry to the loop.  @option{-funroll-loops} implies
5419 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5420 (i.e.@: complete removal of loops with small constant number of iterations).
5421 This option makes code larger, and may or may not make it run faster.
5422
5423 Enabled with @option{-fprofile-use}.
5424
5425 @item -funroll-all-loops
5426 @opindex funroll-all-loops
5427 Unroll all loops, even if their number of iterations is uncertain when
5428 the loop is entered.  This usually makes programs run more slowly.
5429 @option{-funroll-all-loops} implies the same options as
5430 @option{-funroll-loops}.
5431
5432 @item -fpeel-loops
5433 @opindex fpeel-loops
5434 Peels the loops for that there is enough information that they do not
5435 roll much (from profile feedback).  It also turns on complete loop peeling
5436 (i.e.@: complete removal of loops with small constant number of iterations).
5437
5438 Enabled with @option{-fprofile-use}.
5439
5440 @item -fmove-loop-invariants
5441 @opindex fmove-loop-invariants
5442 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5443 at level @option{-O1}
5444
5445 @item -funswitch-loops
5446 @opindex funswitch-loops
5447 Move branches with loop invariant conditions out of the loop, with duplicates
5448 of the loop on both branches (modified according to result of the condition).
5449
5450 @item -fprefetch-loop-arrays
5451 @opindex fprefetch-loop-arrays
5452 If supported by the target machine, generate instructions to prefetch
5453 memory to improve the performance of loops that access large arrays.
5454
5455 Disabled at level @option{-Os}.
5456
5457 @item -ffunction-sections
5458 @itemx -fdata-sections
5459 @opindex ffunction-sections
5460 @opindex fdata-sections
5461 Place each function or data item into its own section in the output
5462 file if the target supports arbitrary sections.  The name of the
5463 function or the name of the data item determines the section's name
5464 in the output file.
5465
5466 Use these options on systems where the linker can perform optimizations
5467 to improve locality of reference in the instruction space.  Most systems
5468 using the ELF object format and SPARC processors running Solaris 2 have
5469 linkers with such optimizations.  AIX may have these optimizations in
5470 the future.
5471
5472 Only use these options when there are significant benefits from doing
5473 so.  When you specify these options, the assembler and linker will
5474 create larger object and executable files and will also be slower.
5475 You will not be able to use @code{gprof} on all systems if you
5476 specify this option and you may have problems with debugging if
5477 you specify both this option and @option{-g}.
5478
5479 @item -fbranch-target-load-optimize
5480 @opindex fbranch-target-load-optimize
5481 Perform branch target register load optimization before prologue / epilogue
5482 threading.
5483 The use of target registers can typically be exposed only during reload,
5484 thus hoisting loads out of loops and doing inter-block scheduling needs
5485 a separate optimization pass.
5486
5487 @item -fbranch-target-load-optimize2
5488 @opindex fbranch-target-load-optimize2
5489 Perform branch target register load optimization after prologue / epilogue
5490 threading.
5491
5492 @item -fbtr-bb-exclusive
5493 @opindex fbtr-bb-exclusive
5494 When performing branch target register load optimization, don't reuse
5495 branch target registers in within any basic block.
5496
5497 @item --param @var{name}=@var{value}
5498 @opindex param
5499 In some places, GCC uses various constants to control the amount of
5500 optimization that is done.  For example, GCC will not inline functions
5501 that contain more that a certain number of instructions.  You can
5502 control some of these constants on the command-line using the
5503 @option{--param} option.
5504
5505 The names of specific parameters, and the meaning of the values, are
5506 tied to the internals of the compiler, and are subject to change
5507 without notice in future releases.
5508
5509 In each case, the @var{value} is an integer.  The allowable choices for
5510 @var{name} are given in the following table:
5511
5512 @table @gcctabopt
5513 @item salias-max-implicit-fields
5514 The maximum number of fields in a variable without direct
5515 structure accesses for which structure aliasing will consider trying 
5516 to track each field.  The default is 5
5517
5518 @item sra-max-structure-size
5519 The maximum structure size, in bytes, at which the scalar replacement
5520 of aggregates (SRA) optimization will perform block copies.  The
5521 default value, 0, implies that GCC will select the most appropriate
5522 size itself.
5523
5524 @item sra-field-structure-ratio
5525 The threshold ratio (as a percentage) between instantiated fields and
5526 the complete structure size.  We say that if the ratio of the number
5527 of bytes in instantiated fields to the number of bytes in the complete
5528 structure exceeds this parameter, then block copies are not used.  The
5529 default is 75.
5530
5531 @item max-crossjump-edges
5532 The maximum number of incoming edges to consider for crossjumping.
5533 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5534 the number of edges incoming to each block.  Increasing values mean
5535 more aggressive optimization, making the compile time increase with
5536 probably small improvement in executable size.
5537
5538 @item min-crossjump-insns
5539 The minimum number of instructions which must be matched at the end
5540 of two blocks before crossjumping will be performed on them.  This
5541 value is ignored in the case where all instructions in the block being
5542 crossjumped from are matched.  The default value is 5.
5543
5544 @item max-goto-duplication-insns
5545 The maximum number of instructions to duplicate to a block that jumps
5546 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5547 passes, GCC factors computed gotos early in the compilation process,
5548 and unfactors them as late as possible.  Only computed jumps at the
5549 end of a basic blocks with no more than max-goto-duplication-insns are
5550 unfactored.  The default value is 8.
5551
5552 @item max-delay-slot-insn-search
5553 The maximum number of instructions to consider when looking for an
5554 instruction to fill a delay slot.  If more than this arbitrary number of
5555 instructions is searched, the time savings from filling the delay slot
5556 will be minimal so stop searching.  Increasing values mean more
5557 aggressive optimization, making the compile time increase with probably
5558 small improvement in executable run time.
5559
5560 @item max-delay-slot-live-search
5561 When trying to fill delay slots, the maximum number of instructions to
5562 consider when searching for a block with valid live register
5563 information.  Increasing this arbitrarily chosen value means more
5564 aggressive optimization, increasing the compile time.  This parameter
5565 should be removed when the delay slot code is rewritten to maintain the
5566 control-flow graph.
5567
5568 @item max-gcse-memory
5569 The approximate maximum amount of memory that will be allocated in
5570 order to perform the global common subexpression elimination
5571 optimization.  If more memory than specified is required, the
5572 optimization will not be done.
5573
5574 @item max-gcse-passes
5575 The maximum number of passes of GCSE to run.  The default is 1.
5576
5577 @item max-pending-list-length
5578 The maximum number of pending dependencies scheduling will allow
5579 before flushing the current state and starting over.  Large functions
5580 with few branches or calls can create excessively large lists which
5581 needlessly consume memory and resources.
5582
5583 @item max-inline-insns-single
5584 Several parameters control the tree inliner used in gcc.
5585 This number sets the maximum number of instructions (counted in GCC's
5586 internal representation) in a single function that the tree inliner
5587 will consider for inlining.  This only affects functions declared
5588 inline and methods implemented in a class declaration (C++).
5589 The default value is 450.
5590
5591 @item max-inline-insns-auto
5592 When you use @option{-finline-functions} (included in @option{-O3}),
5593 a lot of functions that would otherwise not be considered for inlining
5594 by the compiler will be investigated.  To those functions, a different
5595 (more restrictive) limit compared to functions declared inline can
5596 be applied.
5597 The default value is 90.
5598
5599 @item large-function-insns
5600 The limit specifying really large functions.  For functions larger than this
5601 limit after inlining inlining is constrained by
5602 @option{--param large-function-growth}.  This parameter is useful primarily
5603 to avoid extreme compilation time caused by non-linear algorithms used by the
5604 backend.
5605 This parameter is ignored when @option{-funit-at-a-time} is not used.
5606 The default value is 2700.
5607
5608 @item large-function-growth
5609 Specifies maximal growth of large function caused by inlining in percents.
5610 This parameter is ignored when @option{-funit-at-a-time} is not used.
5611 The default value is 100 which limits large function growth to 2.0 times
5612 the original size.
5613
5614 @item inline-unit-growth
5615 Specifies maximal overall growth of the compilation unit caused by inlining.
5616 This parameter is ignored when @option{-funit-at-a-time} is not used.
5617 The default value is 50 which limits unit growth to 1.5 times the original
5618 size.
5619
5620 @item max-inline-insns-recursive
5621 @itemx max-inline-insns-recursive-auto
5622 Specifies maximum number of instructions out-of-line copy of self recursive inline
5623 function can grow into by performing recursive inlining.
5624
5625 For functions declared inline @option{--param max-inline-insns-recursive} is
5626 taken into acount.  For function not declared inline, recursive inlining
5627 happens only when @option{-finline-functions} (included in @option{-O3}) is
5628 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5629 default value is 450.
5630
5631 @item max-inline-recursive-depth
5632 @itemx max-inline-recursive-depth-auto
5633 Specifies maximum recursion depth used by the recursive inlining.
5634
5635 For functions declared inline @option{--param max-inline-recursive-depth} is
5636 taken into acount.  For function not declared inline, recursive inlining
5637 happens only when @option{-finline-functions} (included in @option{-O3}) is
5638 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5639 default value is 450.
5640
5641 @item inline-call-cost
5642 Specify cost of call instruction relative to simple arithmetics operations
5643 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5644 functions and at the same time increases size of leaf function that is believed to
5645 reduce function size by being inlined.  In effect it increases amount of
5646 inlining for code having large abstraction penalty (many functions that just
5647 pass the arguments to other functions) and decrease inlining for code with low
5648 abstraction penalty.  The default value is 16.
5649
5650 @item max-unrolled-insns
5651 The maximum number of instructions that a loop should have if that loop
5652 is unrolled, and if the loop is unrolled, it determines how many times
5653 the loop code is unrolled.
5654
5655 @item max-average-unrolled-insns
5656 The maximum number of instructions biased by probabilities of their execution
5657 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5658 it determines how many times the loop code is unrolled.
5659
5660 @item max-unroll-times
5661 The maximum number of unrollings of a single loop.
5662
5663 @item max-peeled-insns
5664 The maximum number of instructions that a loop should have if that loop
5665 is peeled, and if the loop is peeled, it determines how many times
5666 the loop code is peeled.
5667
5668 @item max-peel-times
5669 The maximum number of peelings of a single loop.
5670
5671 @item max-completely-peeled-insns
5672 The maximum number of insns of a completely peeled loop.
5673
5674 @item max-completely-peel-times
5675 The maximum number of iterations of a loop to be suitable for complete peeling.
5676
5677 @item max-unswitch-insns
5678 The maximum number of insns of an unswitched loop.
5679
5680 @item max-unswitch-level
5681 The maximum number of branches unswitched in a single loop.
5682
5683 @item lim-expensive
5684 The minimum cost of an expensive expression in the loop invariant motion.
5685
5686 @item iv-consider-all-candidates-bound
5687 Bound on number of candidates for induction variables below that
5688 all candidates are considered for each use in induction variable
5689 optimizations.  Only the most relevant candidates are considered
5690 if there are more candidates, to avoid quadratic time complexity.
5691
5692 @item iv-max-considered-uses
5693 The induction variable optimizations give up on loops that contain more
5694 induction variable uses.
5695
5696 @item iv-always-prune-cand-set-bound
5697 If number of candidates in the set is smaller than this value,
5698 we always try to remove unnecessary ivs from the set during its
5699 optimization when a new iv is added to the set.
5700
5701 @item scev-max-expr-size
5702 Bound on size of expressions used in the scalar evolutions analyzer.
5703 Large expressions slow the analyzer.
5704
5705 @item max-iterations-to-track
5706
5707 The maximum number of iterations of a loop the brute force algorithm
5708 for analysis of # of iterations of the loop tries to evaluate.
5709
5710 @item hot-bb-count-fraction
5711 Select fraction of the maximal count of repetitions of basic block in program
5712 given basic block needs to have to be considered hot.
5713
5714 @item hot-bb-frequency-fraction
5715 Select fraction of the maximal frequency of executions of basic block in
5716 function given basic block needs to have to be considered hot
5717
5718 @item tracer-dynamic-coverage
5719 @itemx tracer-dynamic-coverage-feedback
5720
5721 This value is used to limit superblock formation once the given percentage of
5722 executed instructions is covered.  This limits unnecessary code size
5723 expansion.
5724
5725 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5726 feedback is available.  The real profiles (as opposed to statically estimated
5727 ones) are much less balanced allowing the threshold to be larger value.
5728
5729 @item tracer-max-code-growth
5730 Stop tail duplication once code growth has reached given percentage.  This is
5731 rather hokey argument, as most of the duplicates will be eliminated later in
5732 cross jumping, so it may be set to much higher values than is the desired code
5733 growth.
5734
5735 @item tracer-min-branch-ratio
5736
5737 Stop reverse growth when the reverse probability of best edge is less than this
5738 threshold (in percent).
5739
5740 @item tracer-min-branch-ratio
5741 @itemx tracer-min-branch-ratio-feedback
5742
5743 Stop forward growth if the best edge do have probability lower than this
5744 threshold.
5745
5746 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5747 compilation for profile feedback and one for compilation without.  The value
5748 for compilation with profile feedback needs to be more conservative (higher) in
5749 order to make tracer effective.
5750
5751 @item max-cse-path-length
5752
5753 Maximum number of basic blocks on path that cse considers.  The default is 10.
5754
5755 @item global-var-threshold
5756
5757 Counts the number of function calls (@var{n}) and the number of
5758 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5759 single artificial variable will be created to represent all the
5760 call-clobbered variables at function call sites.  This artificial
5761 variable will then be made to alias every call-clobbered variable.
5762 (done as @code{int * size_t} on the host machine; beware overflow).
5763
5764 @item max-aliased-vops
5765
5766 Maximum number of virtual operands allowed to represent aliases
5767 before triggering the alias grouping heuristic.  Alias grouping
5768 reduces compile times and memory consumption needed for aliasing at
5769 the expense of precision loss in alias information.
5770
5771 @item ggc-min-expand
5772
5773 GCC uses a garbage collector to manage its own memory allocation.  This
5774 parameter specifies the minimum percentage by which the garbage
5775 collector's heap should be allowed to expand between collections.
5776 Tuning this may improve compilation speed; it has no effect on code
5777 generation.
5778
5779 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5780 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5781 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5782 GCC is not able to calculate RAM on a particular platform, the lower
5783 bound of 30% is used.  Setting this parameter and
5784 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5785 every opportunity.  This is extremely slow, but can be useful for
5786 debugging.
5787
5788 @item ggc-min-heapsize
5789
5790 Minimum size of the garbage collector's heap before it begins bothering
5791 to collect garbage.  The first collection occurs after the heap expands
5792 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5793 tuning this may improve compilation speed, and has no effect on code
5794 generation.
5795
5796 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5797 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5798 with a lower bound of 4096 (four megabytes) and an upper bound of
5799 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5800 particular platform, the lower bound is used.  Setting this parameter
5801 very large effectively disables garbage collection.  Setting this
5802 parameter and @option{ggc-min-expand} to zero causes a full collection
5803 to occur at every opportunity.
5804
5805 @item max-reload-search-insns
5806 The maximum number of instruction reload should look backward for equivalent
5807 register.  Increasing values mean more aggressive optimization, making the
5808 compile time increase with probably slightly better performance.  The default
5809 value is 100.
5810
5811 @item max-cselib-memory-location
5812 The maximum number of memory locations cselib should take into acount.
5813 Increasing values mean more aggressive optimization, making the compile time
5814 increase with probably slightly better performance.  The default value is 500.
5815
5816 @item reorder-blocks-duplicate
5817 @itemx reorder-blocks-duplicate-feedback
5818
5819 Used by basic block reordering pass to decide whether to use unconditional
5820 branch or duplicate the code on its destination.  Code is duplicated when its
5821 estimated size is smaller than this value multiplied by the estimated size of
5822 unconditional jump in the hot spots of the program.
5823
5824 The @option{reorder-block-duplicate-feedback} is used only when profile
5825 feedback is available and may be set to higher values than
5826 @option{reorder-block-duplicate} since information about the hot spots is more
5827 accurate.
5828
5829 @item max-sched-region-blocks
5830 The maximum number of blocks in a region to be considered for
5831 interblock scheduling.  The default value is 10.
5832
5833 @item max-sched-region-insns
5834 The maximum number of insns in a region to be considered for
5835 interblock scheduling.  The default value is 100.
5836
5837 @item max-last-value-rtl
5838
5839 The maximum size measured as number of RTLs that can be recorded in an expression
5840 in combiner for a pseudo register as last known value of that register.  The default
5841 is 10000.
5842
5843 @item integer-share-limit
5844 Small integer constants can use a shared data structure, reducing the
5845 compiler's memory usage and increasing its speed.  This sets the maximum
5846 value of a shared integer constant's.  The default value is 256.
5847
5848 @item min-virtual-mappings
5849 Specifies the minimum number of virtual mappings in the incremental
5850 SSA updater that should be registered to trigger the virtual mappings
5851 heuristic defined by virtual-mappings-ratio.  The default value is
5852 100.
5853
5854 @item virtual-mappings-ratio
5855 If the number of virtual mappings is virtual-mappings-ratio bigger
5856 than the number of virtual symbols to be updated, then the incremental
5857 SSA updater switches to a full update for those symbols.  The default
5858 ratio is 3.
5859
5860 @end table
5861 @end table
5862
5863 @node Preprocessor Options
5864 @section Options Controlling the Preprocessor
5865 @cindex preprocessor options
5866 @cindex options, preprocessor
5867
5868 These options control the C preprocessor, which is run on each C source
5869 file before actual compilation.
5870
5871 If you use the @option{-E} option, nothing is done except preprocessing.
5872 Some of these options make sense only together with @option{-E} because
5873 they cause the preprocessor output to be unsuitable for actual
5874 compilation.
5875
5876 @table @gcctabopt
5877 @opindex Wp
5878 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5879 and pass @var{option} directly through to the preprocessor.  If
5880 @var{option} contains commas, it is split into multiple options at the
5881 commas.  However, many options are modified, translated or interpreted
5882 by the compiler driver before being passed to the preprocessor, and
5883 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5884 interface is undocumented and subject to change, so whenever possible
5885 you should avoid using @option{-Wp} and let the driver handle the
5886 options instead.
5887
5888 @item -Xpreprocessor @var{option}
5889 @opindex preprocessor
5890 Pass @var{option} as an option to the preprocessor.  You can use this to
5891 supply system-specific preprocessor options which GCC does not know how to
5892 recognize.
5893
5894 If you want to pass an option that takes an argument, you must use
5895 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5896 @end table
5897
5898 @include cppopts.texi
5899
5900 @node Assembler Options
5901 @section Passing Options to the Assembler
5902
5903 @c prevent bad page break with this line
5904 You can pass options to the assembler.
5905
5906 @table @gcctabopt
5907 @item -Wa,@var{option}
5908 @opindex Wa
5909 Pass @var{option} as an option to the assembler.  If @var{option}
5910 contains commas, it is split into multiple options at the commas.
5911
5912 @item -Xassembler @var{option}
5913 @opindex Xassembler
5914 Pass @var{option} as an option to the assembler.  You can use this to
5915 supply system-specific assembler options which GCC does not know how to
5916 recognize.
5917
5918 If you want to pass an option that takes an argument, you must use
5919 @option{-Xassembler} twice, once for the option and once for the argument.
5920
5921 @end table
5922
5923 @node Link Options
5924 @section Options for Linking
5925 @cindex link options
5926 @cindex options, linking
5927
5928 These options come into play when the compiler links object files into
5929 an executable output file.  They are meaningless if the compiler is
5930 not doing a link step.
5931
5932 @table @gcctabopt
5933 @cindex file names
5934 @item @var{object-file-name}
5935 A file name that does not end in a special recognized suffix is
5936 considered to name an object file or library.  (Object files are
5937 distinguished from libraries by the linker according to the file
5938 contents.)  If linking is done, these object files are used as input
5939 to the linker.
5940
5941 @item -c
5942 @itemx -S
5943 @itemx -E
5944 @opindex c
5945 @opindex S
5946 @opindex E
5947 If any of these options is used, then the linker is not run, and
5948 object file names should not be used as arguments.  @xref{Overall
5949 Options}.
5950
5951 @cindex Libraries
5952 @item -l@var{library}
5953 @itemx -l @var{library}
5954 @opindex l
5955 Search the library named @var{library} when linking.  (The second
5956 alternative with the library as a separate argument is only for
5957 POSIX compliance and is not recommended.)
5958
5959 It makes a difference where in the command you write this option; the
5960 linker searches and processes libraries and object files in the order they
5961 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5962 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5963 to functions in @samp{z}, those functions may not be loaded.
5964
5965 The linker searches a standard list of directories for the library,
5966 which is actually a file named @file{lib@var{library}.a}.  The linker
5967 then uses this file as if it had been specified precisely by name.
5968
5969 The directories searched include several standard system directories
5970 plus any that you specify with @option{-L}.
5971
5972 Normally the files found this way are library files---archive files
5973 whose members are object files.  The linker handles an archive file by
5974 scanning through it for members which define symbols that have so far
5975 been referenced but not defined.  But if the file that is found is an
5976 ordinary object file, it is linked in the usual fashion.  The only
5977 difference between using an @option{-l} option and specifying a file name
5978 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5979 and searches several directories.
5980
5981 @item -lobjc
5982 @opindex lobjc
5983 You need this special case of the @option{-l} option in order to
5984 link an Objective-C or Objective-C++ program.
5985
5986 @item -nostartfiles
5987 @opindex nostartfiles
5988 Do not use the standard system startup files when linking.
5989 The standard system libraries are used normally, unless @option{-nostdlib}
5990 or @option{-nodefaultlibs} is used.
5991
5992 @item -nodefaultlibs
5993 @opindex nodefaultlibs
5994 Do not use the standard system libraries when linking.
5995 Only the libraries you specify will be passed to the linker.
5996 The standard startup files are used normally, unless @option{-nostartfiles}
5997 is used.  The compiler may generate calls to @code{memcmp},
5998 @code{memset}, @code{memcpy} and @code{memmove}.
5999 These entries are usually resolved by entries in
6000 libc.  These entry points should be supplied through some other
6001 mechanism when this option is specified.
6002
6003 @item -nostdlib
6004 @opindex nostdlib
6005 Do not use the standard system startup files or libraries when linking.
6006 No startup files and only the libraries you specify will be passed to
6007 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6008 @code{memcpy} and @code{memmove}.
6009 These entries are usually resolved by entries in
6010 libc.  These entry points should be supplied through some other
6011 mechanism when this option is specified.
6012
6013 @cindex @option{-lgcc}, use with @option{-nostdlib}
6014 @cindex @option{-nostdlib} and unresolved references
6015 @cindex unresolved references and @option{-nostdlib}
6016 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6017 @cindex @option{-nodefaultlibs} and unresolved references
6018 @cindex unresolved references and @option{-nodefaultlibs}
6019 One of the standard libraries bypassed by @option{-nostdlib} and
6020 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6021 that GCC uses to overcome shortcomings of particular machines, or special
6022 needs for some languages.
6023 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6024 Collection (GCC) Internals},
6025 for more discussion of @file{libgcc.a}.)
6026 In most cases, you need @file{libgcc.a} even when you want to avoid
6027 other standard libraries.  In other words, when you specify @option{-nostdlib}
6028 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6029 This ensures that you have no unresolved references to internal GCC
6030 library subroutines.  (For example, @samp{__main}, used to ensure C++
6031 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6032 GNU Compiler Collection (GCC) Internals}.)
6033
6034 @item -pie
6035 @opindex pie
6036 Produce a position independent executable on targets which support it.
6037 For predictable results, you must also specify the same set of options
6038 that were used to generate code (@option{-fpie}, @option{-fPIE},
6039 or model suboptions) when you specify this option.
6040
6041 @item -s
6042 @opindex s
6043 Remove all symbol table and relocation information from the executable.
6044
6045 @item -static
6046 @opindex static
6047 On systems that support dynamic linking, this prevents linking with the shared
6048 libraries.  On other systems, this option has no effect.
6049
6050 @item -shared
6051 @opindex shared
6052 Produce a shared object which can then be linked with other objects to
6053 form an executable.  Not all systems support this option.  For predictable
6054 results, you must also specify the same set of options that were used to
6055 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6056 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6057 needs to build supplementary stub code for constructors to work.  On
6058 multi-libbed systems, @samp{gcc -shared} must select the correct support
6059 libraries to link against.  Failing to supply the correct flags may lead
6060 to subtle defects.  Supplying them in cases where they are not necessary
6061 is innocuous.}
6062
6063 @item -shared-libgcc
6064 @itemx -static-libgcc
6065 @opindex shared-libgcc
6066 @opindex static-libgcc
6067 On systems that provide @file{libgcc} as a shared library, these options
6068 force the use of either the shared or static version respectively.
6069 If no shared version of @file{libgcc} was built when the compiler was
6070 configured, these options have no effect.
6071
6072 There are several situations in which an application should use the
6073 shared @file{libgcc} instead of the static version.  The most common
6074 of these is when the application wishes to throw and catch exceptions
6075 across different shared libraries.  In that case, each of the libraries
6076 as well as the application itself should use the shared @file{libgcc}.
6077
6078 Therefore, the G++ and GCJ drivers automatically add
6079 @option{-shared-libgcc} whenever you build a shared library or a main
6080 executable, because C++ and Java programs typically use exceptions, so
6081 this is the right thing to do.
6082
6083 If, instead, you use the GCC driver to create shared libraries, you may
6084 find that they will not always be linked with the shared @file{libgcc}.
6085 If GCC finds, at its configuration time, that you have a non-GNU linker
6086 or a GNU linker that does not support option @option{--eh-frame-hdr},
6087 it will link the shared version of @file{libgcc} into shared libraries
6088 by default.  Otherwise, it will take advantage of the linker and optimize
6089 away the linking with the shared version of @file{libgcc}, linking with
6090 the static version of libgcc by default.  This allows exceptions to
6091 propagate through such shared libraries, without incurring relocation
6092 costs at library load time.
6093
6094 However, if a library or main executable is supposed to throw or catch
6095 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6096 for the languages used in the program, or using the option
6097 @option{-shared-libgcc}, such that it is linked with the shared
6098 @file{libgcc}.
6099
6100 @item -symbolic
6101 @opindex symbolic
6102 Bind references to global symbols when building a shared object.  Warn
6103 about any unresolved references (unless overridden by the link editor
6104 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6105 this option.
6106
6107 @item -Xlinker @var{option}
6108 @opindex Xlinker
6109 Pass @var{option} as an option to the linker.  You can use this to
6110 supply system-specific linker options which GCC does not know how to
6111 recognize.
6112
6113 If you want to pass an option that takes an argument, you must use
6114 @option{-Xlinker} twice, once for the option and once for the argument.
6115 For example, to pass @option{-assert definitions}, you must write
6116 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6117 @option{-Xlinker "-assert definitions"}, because this passes the entire
6118 string as a single argument, which is not what the linker expects.
6119
6120 @item -Wl,@var{option}
6121 @opindex Wl
6122 Pass @var{option} as an option to the linker.  If @var{option} contains
6123 commas, it is split into multiple options at the commas.
6124
6125 @item -u @var{symbol}
6126 @opindex u
6127 Pretend the symbol @var{symbol} is undefined, to force linking of
6128 library modules to define it.  You can use @option{-u} multiple times with
6129 different symbols to force loading of additional library modules.
6130 @end table
6131
6132 @node Directory Options
6133 @section Options for Directory Search
6134 @cindex directory options
6135 @cindex options, directory search
6136 @cindex search path
6137
6138 These options specify directories to search for header files, for
6139 libraries and for parts of the compiler:
6140
6141 @table @gcctabopt
6142 @item -I@var{dir}
6143 @opindex I
6144 Add the directory @var{dir} to the head of the list of directories to be
6145 searched for header files.  This can be used to override a system header
6146 file, substituting your own version, since these directories are
6147 searched before the system header file directories.  However, you should
6148 not use this option to add directories that contain vendor-supplied
6149 system header files (use @option{-isystem} for that).  If you use more than
6150 one @option{-I} option, the directories are scanned in left-to-right
6151 order; the standard system directories come after.
6152
6153 If a standard system include directory, or a directory specified with
6154 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6155 option will be ignored.  The directory will still be searched but as a
6156 system directory at its normal position in the system include chain.
6157 This is to ensure that GCC's procedure to fix buggy system headers and
6158 the ordering for the include_next directive are not inadvertently changed.
6159 If you really need to change the search order for system directories,
6160 use the @option{-nostdinc} and/or @option{-isystem} options.
6161
6162 @item -iquote@var{dir}
6163 @opindex iquote
6164 Add the directory @var{dir} to the head of the list of directories to
6165 be searched for header files only for the case of @samp{#include
6166 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6167 otherwise just like @option{-I}.
6168
6169 @item -L@var{dir}
6170 @opindex L
6171 Add directory @var{dir} to the list of directories to be searched
6172 for @option{-l}.
6173
6174 @item -B@var{prefix}
6175 @opindex B
6176 This option specifies where to find the executables, libraries,
6177 include files, and data files of the compiler itself.
6178
6179 The compiler driver program runs one or more of the subprograms
6180 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6181 @var{prefix} as a prefix for each program it tries to run, both with and
6182 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6183
6184 For each subprogram to be run, the compiler driver first tries the
6185 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6186 was not specified, the driver tries two standard prefixes, which are
6187 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6188 those results in a file name that is found, the unmodified program
6189 name is searched for using the directories specified in your
6190 @env{PATH} environment variable.
6191
6192 The compiler will check to see if the path provided by the @option{-B}
6193 refers to a directory, and if necessary it will add a directory
6194 separator character at the end of the path.
6195
6196 @option{-B} prefixes that effectively specify directory names also apply
6197 to libraries in the linker, because the compiler translates these
6198 options into @option{-L} options for the linker.  They also apply to
6199 includes files in the preprocessor, because the compiler translates these
6200 options into @option{-isystem} options for the preprocessor.  In this case,
6201 the compiler appends @samp{include} to the prefix.
6202
6203 The run-time support file @file{libgcc.a} can also be searched for using
6204 the @option{-B} prefix, if needed.  If it is not found there, the two
6205 standard prefixes above are tried, and that is all.  The file is left
6206 out of the link if it is not found by those means.
6207
6208 Another way to specify a prefix much like the @option{-B} prefix is to use
6209 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6210 Variables}.
6211
6212 As a special kludge, if the path provided by @option{-B} is
6213 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6214 9, then it will be replaced by @file{[dir/]include}.  This is to help
6215 with boot-strapping the compiler.
6216
6217 @item -specs=@var{file}
6218 @opindex specs
6219 Process @var{file} after the compiler reads in the standard @file{specs}
6220 file, in order to override the defaults that the @file{gcc} driver
6221 program uses when determining what switches to pass to @file{cc1},
6222 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6223 @option{-specs=@var{file}} can be specified on the command line, and they
6224 are processed in order, from left to right.
6225
6226 @item -I-
6227 @opindex I-
6228 This option has been deprecated.  Please use @option{-iquote} instead for
6229 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6230 Any directories you specify with @option{-I} options before the @option{-I-}
6231 option are searched only for the case of @samp{#include "@var{file}"};
6232 they are not searched for @samp{#include <@var{file}>}.
6233
6234 If additional directories are specified with @option{-I} options after
6235 the @option{-I-}, these directories are searched for all @samp{#include}
6236 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6237 this way.)
6238
6239 In addition, the @option{-I-} option inhibits the use of the current
6240 directory (where the current input file came from) as the first search
6241 directory for @samp{#include "@var{file}"}.  There is no way to
6242 override this effect of @option{-I-}.  With @option{-I.} you can specify
6243 searching the directory which was current when the compiler was
6244 invoked.  That is not exactly the same as what the preprocessor does
6245 by default, but it is often satisfactory.
6246
6247 @option{-I-} does not inhibit the use of the standard system directories
6248 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6249 independent.
6250 @end table
6251
6252 @c man end
6253
6254 @node Spec Files
6255 @section Specifying subprocesses and the switches to pass to them
6256 @cindex Spec Files
6257
6258 @command{gcc} is a driver program.  It performs its job by invoking a
6259 sequence of other programs to do the work of compiling, assembling and
6260 linking.  GCC interprets its command-line parameters and uses these to
6261 deduce which programs it should invoke, and which command-line options
6262 it ought to place on their command lines.  This behavior is controlled
6263 by @dfn{spec strings}.  In most cases there is one spec string for each
6264 program that GCC can invoke, but a few programs have multiple spec
6265 strings to control their behavior.  The spec strings built into GCC can
6266 be overridden by using the @option{-specs=} command-line switch to specify
6267 a spec file.
6268
6269 @dfn{Spec files} are plaintext files that are used to construct spec
6270 strings.  They consist of a sequence of directives separated by blank
6271 lines.  The type of directive is determined by the first non-whitespace
6272 character on the line and it can be one of the following:
6273
6274 @table @code
6275 @item %@var{command}
6276 Issues a @var{command} to the spec file processor.  The commands that can
6277 appear here are:
6278
6279 @table @code
6280 @item %include <@var{file}>
6281 @cindex %include
6282 Search for @var{file} and insert its text at the current point in the
6283 specs file.
6284
6285 @item %include_noerr <@var{file}>
6286 @cindex %include_noerr
6287 Just like @samp{%include}, but do not generate an error message if the include
6288 file cannot be found.
6289
6290 @item %rename @var{old_name} @var{new_name}
6291 @cindex %rename
6292 Rename the spec string @var{old_name} to @var{new_name}.
6293
6294 @end table
6295
6296 @item *[@var{spec_name}]:
6297 This tells the compiler to create, override or delete the named spec
6298 string.  All lines after this directive up to the next directive or
6299 blank line are considered to be the text for the spec string.  If this
6300 results in an empty string then the spec will be deleted.  (Or, if the
6301 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6302 does not currently exist a new spec will be created.  If the spec does
6303 exist then its contents will be overridden by the text of this
6304 directive, unless the first character of that text is the @samp{+}
6305 character, in which case the text will be appended to the spec.
6306
6307 @item [@var{suffix}]:
6308 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6309 and up to the next directive or blank line are considered to make up the
6310 spec string for the indicated suffix.  When the compiler encounters an
6311 input file with the named suffix, it will processes the spec string in
6312 order to work out how to compile that file.  For example:
6313
6314 @smallexample
6315 .ZZ:
6316 z-compile -input %i
6317 @end smallexample
6318
6319 This says that any input file whose name ends in @samp{.ZZ} should be
6320 passed to the program @samp{z-compile}, which should be invoked with the
6321 command-line switch @option{-input} and with the result of performing the
6322 @samp{%i} substitution.  (See below.)
6323
6324 As an alternative to providing a spec string, the text that follows a
6325 suffix directive can be one of the following:
6326
6327 @table @code
6328 @item @@@var{language}
6329 This says that the suffix is an alias for a known @var{language}.  This is
6330 similar to using the @option{-x} command-line switch to GCC to specify a
6331 language explicitly.  For example:
6332
6333 @smallexample
6334 .ZZ:
6335 @@c++
6336 @end smallexample
6337
6338 Says that .ZZ files are, in fact, C++ source files.
6339
6340 @item #@var{name}
6341 This causes an error messages saying:
6342
6343 @smallexample
6344 @var{name} compiler not installed on this system.
6345 @end smallexample
6346 @end table
6347
6348 GCC already has an extensive list of suffixes built into it.
6349 This directive will add an entry to the end of the list of suffixes, but
6350 since the list is searched from the end backwards, it is effectively
6351 possible to override earlier entries using this technique.
6352
6353 @end table
6354
6355 GCC has the following spec strings built into it.  Spec files can
6356 override these strings or create their own.  Note that individual
6357 targets can also add their own spec strings to this list.
6358
6359 @smallexample
6360 asm          Options to pass to the assembler
6361 asm_final    Options to pass to the assembler post-processor
6362 cpp          Options to pass to the C preprocessor
6363 cc1          Options to pass to the C compiler
6364 cc1plus      Options to pass to the C++ compiler
6365 endfile      Object files to include at the end of the link
6366 link         Options to pass to the linker
6367 lib          Libraries to include on the command line to the linker
6368 libgcc       Decides which GCC support library to pass to the linker
6369 linker       Sets the name of the linker
6370 predefines   Defines to be passed to the C preprocessor
6371 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6372              by default
6373 startfile    Object files to include at the start of the link
6374 @end smallexample
6375
6376 Here is a small example of a spec file:
6377
6378 @smallexample
6379 %rename lib                 old_lib
6380
6381 *lib:
6382 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6383 @end smallexample
6384
6385 This example renames the spec called @samp{lib} to @samp{old_lib} and
6386 then overrides the previous definition of @samp{lib} with a new one.
6387 The new definition adds in some extra command-line options before
6388 including the text of the old definition.
6389
6390 @dfn{Spec strings} are a list of command-line options to be passed to their
6391 corresponding program.  In addition, the spec strings can contain
6392 @samp{%}-prefixed sequences to substitute variable text or to
6393 conditionally insert text into the command line.  Using these constructs
6394 it is possible to generate quite complex command lines.
6395
6396 Here is a table of all defined @samp{%}-sequences for spec
6397 strings.  Note that spaces are not generated automatically around the
6398 results of expanding these sequences.  Therefore you can concatenate them
6399 together or combine them with constant text in a single argument.
6400
6401 @table @code
6402 @item %%
6403 Substitute one @samp{%} into the program name or argument.
6404
6405 @item %i
6406 Substitute the name of the input file being processed.
6407
6408 @item %b
6409 Substitute the basename of the input file being processed.
6410 This is the substring up to (and not including) the last period
6411 and not including the directory.
6412
6413 @item %B
6414 This is the same as @samp{%b}, but include the file suffix (text after
6415 the last period).
6416
6417 @item %d
6418 Marks the argument containing or following the @samp{%d} as a
6419 temporary file name, so that that file will be deleted if GCC exits
6420 successfully.  Unlike @samp{%g}, this contributes no text to the
6421 argument.
6422
6423 @item %g@var{suffix}
6424 Substitute a file name that has suffix @var{suffix} and is chosen
6425 once per compilation, and mark the argument in the same way as
6426 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6427 name is now chosen in a way that is hard to predict even when previously
6428 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6429 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6430 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6431 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6432 was simply substituted with a file name chosen once per compilation,
6433 without regard to any appended suffix (which was therefore treated
6434 just like ordinary text), making such attacks more likely to succeed.
6435
6436 @item %u@var{suffix}
6437 Like @samp{%g}, but generates a new temporary file name even if
6438 @samp{%u@var{suffix}} was already seen.
6439
6440 @item %U@var{suffix}
6441 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6442 new one if there is no such last file name.  In the absence of any
6443 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6444 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6445 would involve the generation of two distinct file names, one
6446 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6447 simply substituted with a file name chosen for the previous @samp{%u},
6448 without regard to any appended suffix.
6449
6450 @item %j@var{suffix}
6451 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6452 writable, and if save-temps is off; otherwise, substitute the name
6453 of a temporary file, just like @samp{%u}.  This temporary file is not
6454 meant for communication between processes, but rather as a junk
6455 disposal mechanism.
6456
6457 @item %|@var{suffix}
6458 @itemx %m@var{suffix}
6459 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6460 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6461 all.  These are the two most common ways to instruct a program that it
6462 should read from standard input or write to standard output.  If you
6463 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6464 construct: see for example @file{f/lang-specs.h}.
6465
6466 @item %.@var{SUFFIX}
6467 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6468 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6469 terminated by the next space or %.
6470
6471 @item %w
6472 Marks the argument containing or following the @samp{%w} as the
6473 designated output file of this compilation.  This puts the argument
6474 into the sequence of arguments that @samp{%o} will substitute later.
6475
6476 @item %o
6477 Substitutes the names of all the output files, with spaces
6478 automatically placed around them.  You should write spaces
6479 around the @samp{%o} as well or the results are undefined.
6480 @samp{%o} is for use in the specs for running the linker.
6481 Input files whose names have no recognized suffix are not compiled
6482 at all, but they are included among the output files, so they will
6483 be linked.
6484
6485 @item %O
6486 Substitutes the suffix for object files.  Note that this is
6487 handled specially when it immediately follows @samp{%g, %u, or %U},
6488 because of the need for those to form complete file names.  The
6489 handling is such that @samp{%O} is treated exactly as if it had already
6490 been substituted, except that @samp{%g, %u, and %U} do not currently
6491 support additional @var{suffix} characters following @samp{%O} as they would
6492 following, for example, @samp{.o}.
6493
6494 @item %p
6495 Substitutes the standard macro predefinitions for the
6496 current target machine.  Use this when running @code{cpp}.
6497
6498 @item %P
6499 Like @samp{%p}, but puts @samp{__} before and after the name of each
6500 predefined macro, except for macros that start with @samp{__} or with
6501 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6502 C@.
6503
6504 @item %I
6505 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6506 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6507 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6508 as necessary.
6509
6510 @item %s
6511 Current argument is the name of a library or startup file of some sort.
6512 Search for that file in a standard list of directories and substitute
6513 the full name found.
6514
6515 @item %e@var{str}
6516 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6517 Use this when inconsistent options are detected.
6518
6519 @item %(@var{name})
6520 Substitute the contents of spec string @var{name} at this point.
6521
6522 @item %[@var{name}]
6523 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6524
6525 @item %x@{@var{option}@}
6526 Accumulate an option for @samp{%X}.
6527
6528 @item %X
6529 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6530 spec string.
6531
6532 @item %Y
6533 Output the accumulated assembler options specified by @option{-Wa}.
6534
6535 @item %Z
6536 Output the accumulated preprocessor options specified by @option{-Wp}.
6537
6538 @item %a
6539 Process the @code{asm} spec.  This is used to compute the
6540 switches to be passed to the assembler.
6541
6542 @item %A
6543 Process the @code{asm_final} spec.  This is a spec string for
6544 passing switches to an assembler post-processor, if such a program is
6545 needed.
6546
6547 @item %l
6548 Process the @code{link} spec.  This is the spec for computing the
6549 command line passed to the linker.  Typically it will make use of the
6550 @samp{%L %G %S %D and %E} sequences.
6551
6552 @item %D
6553 Dump out a @option{-L} option for each directory that GCC believes might
6554 contain startup files.  If the target supports multilibs then the
6555 current multilib directory will be prepended to each of these paths.
6556
6557 @item %L
6558 Process the @code{lib} spec.  This is a spec string for deciding which
6559 libraries should be included on the command line to the linker.
6560
6561 @item %G
6562 Process the @code{libgcc} spec.  This is a spec string for deciding
6563 which GCC support library should be included on the command line to the linker.
6564
6565 @item %S
6566 Process the @code{startfile} spec.  This is a spec for deciding which
6567 object files should be the first ones passed to the linker.  Typically
6568 this might be a file named @file{crt0.o}.
6569
6570 @item %E
6571 Process the @code{endfile} spec.  This is a spec string that specifies
6572 the last object files that will be passed to the linker.
6573
6574 @item %C
6575 Process the @code{cpp} spec.  This is used to construct the arguments
6576 to be passed to the C preprocessor.
6577
6578 @item %1
6579 Process the @code{cc1} spec.  This is used to construct the options to be
6580 passed to the actual C compiler (@samp{cc1}).
6581
6582 @item %2
6583 Process the @code{cc1plus} spec.  This is used to construct the options to be
6584 passed to the actual C++ compiler (@samp{cc1plus}).
6585
6586 @item %*
6587 Substitute the variable part of a matched option.  See below.
6588 Note that each comma in the substituted string is replaced by
6589 a single space.
6590
6591 @item %<@code{S}
6592 Remove all occurrences of @code{-S} from the command line.  Note---this
6593 command is position dependent.  @samp{%} commands in the spec string
6594 before this one will see @code{-S}, @samp{%} commands in the spec string
6595 after this one will not.
6596
6597 @item %:@var{function}(@var{args})
6598 Call the named function @var{function}, passing it @var{args}.
6599 @var{args} is first processed as a nested spec string, then split
6600 into an argument vector in the usual fashion.  The function returns
6601 a string which is processed as if it had appeared literally as part
6602 of the current spec.
6603
6604 The following built-in spec functions are provided:
6605
6606 @table @code
6607 @item @code{if-exists}
6608 The @code{if-exists} spec function takes one argument, an absolute
6609 pathname to a file.  If the file exists, @code{if-exists} returns the
6610 pathname.  Here is a small example of its usage:
6611
6612 @smallexample
6613 *startfile:
6614 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6615 @end smallexample
6616
6617 @item @code{if-exists-else}
6618 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6619 spec function, except that it takes two arguments.  The first argument is
6620 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6621 returns the pathname.  If it does not exist, it returns the second argument.
6622 This way, @code{if-exists-else} can be used to select one file or another,
6623 based on the existence of the first.  Here is a small example of its usage:
6624
6625 @smallexample
6626 *startfile:
6627 crt0%O%s %:if-exists(crti%O%s) \
6628 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6629 @end smallexample
6630
6631 @item @code{replace-outfile}
6632 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6633 first argument in the outfiles array and replaces it with the second argument.  Here
6634 is a small example of its usage:
6635
6636 @smallexample
6637 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6638 @end smallexample
6639
6640 @end table
6641
6642 @item %@{@code{S}@}
6643 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6644 If that switch was not specified, this substitutes nothing.  Note that
6645 the leading dash is omitted when specifying this option, and it is
6646 automatically inserted if the substitution is performed.  Thus the spec
6647 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6648 and would output the command line option @option{-foo}.
6649
6650 @item %W@{@code{S}@}
6651 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6652 deleted on failure.
6653
6654 @item %@{@code{S}*@}
6655 Substitutes all the switches specified to GCC whose names start
6656 with @code{-S}, but which also take an argument.  This is used for
6657 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6658 GCC considers @option{-o foo} as being
6659 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6660 text, including the space.  Thus two arguments would be generated.
6661
6662 @item %@{@code{S}*&@code{T}*@}
6663 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6664 (the order of @code{S} and @code{T} in the spec is not significant).
6665 There can be any number of ampersand-separated variables; for each the
6666 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6667
6668 @item %@{@code{S}:@code{X}@}
6669 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6670
6671 @item %@{!@code{S}:@code{X}@}
6672 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6673
6674 @item %@{@code{S}*:@code{X}@}
6675 Substitutes @code{X} if one or more switches whose names start with
6676 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6677 once, no matter how many such switches appeared.  However, if @code{%*}
6678 appears somewhere in @code{X}, then @code{X} will be substituted once
6679 for each matching switch, with the @code{%*} replaced by the part of
6680 that switch that matched the @code{*}.
6681
6682 @item %@{.@code{S}:@code{X}@}
6683 Substitutes @code{X}, if processing a file with suffix @code{S}.
6684
6685 @item %@{!.@code{S}:@code{X}@}
6686 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6687
6688 @item %@{@code{S}|@code{P}:@code{X}@}
6689 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6690 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6691 although they have a stronger binding than the @samp{|}.  If @code{%*}
6692 appears in @code{X}, all of the alternatives must be starred, and only
6693 the first matching alternative is substituted.
6694
6695 For example, a spec string like this:
6696
6697 @smallexample
6698 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6699 @end smallexample
6700
6701 will output the following command-line options from the following input
6702 command-line options:
6703
6704 @smallexample
6705 fred.c        -foo -baz
6706 jim.d         -bar -boggle
6707 -d fred.c     -foo -baz -boggle
6708 -d jim.d      -bar -baz -boggle
6709 @end smallexample
6710
6711 @item %@{S:X; T:Y; :D@}
6712
6713 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6714 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6715 be as many clauses as you need.  This may be combined with @code{.},
6716 @code{!}, @code{|}, and @code{*} as needed.
6717
6718
6719 @end table
6720
6721 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6722 construct may contain other nested @samp{%} constructs or spaces, or
6723 even newlines.  They are processed as usual, as described above.
6724 Trailing white space in @code{X} is ignored.  White space may also
6725 appear anywhere on the left side of the colon in these constructs,
6726 except between @code{.} or @code{*} and the corresponding word.
6727
6728 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6729 handled specifically in these constructs.  If another value of
6730 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6731 @option{-W} switch is found later in the command line, the earlier
6732 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6733 just one letter, which passes all matching options.
6734
6735 The character @samp{|} at the beginning of the predicate text is used to
6736 indicate that a command should be piped to the following command, but
6737 only if @option{-pipe} is specified.
6738
6739 It is built into GCC which switches take arguments and which do not.
6740 (You might think it would be useful to generalize this to allow each
6741 compiler's spec to say which switches take arguments.  But this cannot
6742 be done in a consistent fashion.  GCC cannot even decide which input
6743 files have been specified without knowing which switches take arguments,
6744 and it must know which input files to compile in order to tell which
6745 compilers to run).
6746
6747 GCC also knows implicitly that arguments starting in @option{-l} are to be
6748 treated as compiler output files, and passed to the linker in their
6749 proper position among the other output files.
6750
6751 @c man begin OPTIONS
6752
6753 @node Target Options
6754 @section Specifying Target Machine and Compiler Version
6755 @cindex target options
6756 @cindex cross compiling
6757 @cindex specifying machine version
6758 @cindex specifying compiler version and target machine
6759 @cindex compiler version, specifying
6760 @cindex target machine, specifying
6761
6762 The usual way to run GCC is to run the executable called @file{gcc}, or
6763 @file{<machine>-gcc} when cross-compiling, or
6764 @file{<machine>-gcc-<version>} to run a version other than the one that
6765 was installed last.  Sometimes this is inconvenient, so GCC provides
6766 options that will switch to another cross-compiler or version.
6767
6768 @table @gcctabopt
6769 @item -b @var{machine}
6770 @opindex b
6771 The argument @var{machine} specifies the target machine for compilation.
6772
6773 The value to use for @var{machine} is the same as was specified as the
6774 machine type when configuring GCC as a cross-compiler.  For
6775 example, if a cross-compiler was configured with @samp{configure
6776 i386v}, meaning to compile for an 80386 running System V, then you
6777 would specify @option{-b i386v} to run that cross compiler.
6778
6779 @item -V @var{version}
6780 @opindex V
6781 The argument @var{version} specifies which version of GCC to run.
6782 This is useful when multiple versions are installed.  For example,
6783 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6784 @end table
6785
6786 The @option{-V} and @option{-b} options work by running the
6787 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6788 use them if you can just run that directly.
6789
6790 @node Submodel Options
6791 @section Hardware Models and Configurations
6792 @cindex submodel options
6793 @cindex specifying hardware config
6794 @cindex hardware models and configurations, specifying
6795 @cindex machine dependent options
6796
6797 Earlier we discussed the standard option @option{-b} which chooses among
6798 different installed compilers for completely different target
6799 machines, such as VAX vs.@: 68000 vs.@: 80386.
6800
6801 In addition, each of these target machine types can have its own
6802 special options, starting with @samp{-m}, to choose among various
6803 hardware models or configurations---for example, 68010 vs 68020,
6804 floating coprocessor or none.  A single installed version of the
6805 compiler can compile for any model or configuration, according to the
6806 options specified.
6807
6808 Some configurations of the compiler also support additional special
6809 options, usually for compatibility with other compilers on the same
6810 platform.
6811
6812 These options are defined by the macro @code{TARGET_SWITCHES} in the
6813 machine description.  The default for the options is also defined by
6814 that macro, which enables you to change the defaults.
6815
6816 @c This list is ordered alphanumerically by subsection name.
6817 @c It should be the same order and spelling as these options are listed
6818 @c in Machine Dependent Options
6819
6820 @menu
6821 * ARC Options::
6822 * ARM Options::
6823 * AVR Options::
6824 * Blackfin Options::
6825 * CRIS Options::
6826 * Darwin Options::
6827 * DEC Alpha Options::
6828 * DEC Alpha/VMS Options::
6829 * FRV Options::
6830 * H8/300 Options::
6831 * HPPA Options::
6832 * i386 and x86-64 Options::
6833 * IA-64 Options::
6834 * M32R/D Options::
6835 * M680x0 Options::
6836 * M68hc1x Options::
6837 * MCore Options::
6838 * MIPS Options::
6839 * MMIX Options::
6840 * MN10300 Options::
6841 * NS32K Options::
6842 * PDP-11 Options::
6843 * PowerPC Options::
6844 * RS/6000 and PowerPC Options::
6845 * S/390 and zSeries Options::
6846 * SH Options::
6847 * SPARC Options::
6848 * System V Options::
6849 * TMS320C3x/C4x Options::
6850 * V850 Options::
6851 * VAX Options::
6852 * x86-64 Options::
6853 * Xstormy16 Options::
6854 * Xtensa Options::
6855 * zSeries Options::
6856 @end menu
6857
6858 @node ARC Options
6859 @subsection ARC Options
6860 @cindex ARC Options
6861
6862 These options are defined for ARC implementations:
6863
6864 @table @gcctabopt
6865 @item -EL
6866 @opindex EL
6867 Compile code for little endian mode.  This is the default.
6868
6869 @item -EB
6870 @opindex EB
6871 Compile code for big endian mode.
6872
6873 @item -mmangle-cpu
6874 @opindex mmangle-cpu
6875 Prepend the name of the cpu to all public symbol names.
6876 In multiple-processor systems, there are many ARC variants with different
6877 instruction and register set characteristics.  This flag prevents code
6878 compiled for one cpu to be linked with code compiled for another.
6879 No facility exists for handling variants that are ``almost identical''.
6880 This is an all or nothing option.
6881
6882 @item -mcpu=@var{cpu}
6883 @opindex mcpu
6884 Compile code for ARC variant @var{cpu}.
6885 Which variants are supported depend on the configuration.
6886 All variants support @option{-mcpu=base}, this is the default.
6887
6888 @item -mtext=@var{text-section}
6889 @itemx -mdata=@var{data-section}
6890 @itemx -mrodata=@var{readonly-data-section}
6891 @opindex mtext
6892 @opindex mdata
6893 @opindex mrodata
6894 Put functions, data, and readonly data in @var{text-section},
6895 @var{data-section}, and @var{readonly-data-section} respectively
6896 by default.  This can be overridden with the @code{section} attribute.
6897 @xref{Variable Attributes}.
6898
6899 @end table
6900
6901 @node ARM Options
6902 @subsection ARM Options
6903 @cindex ARM options
6904
6905 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6906 architectures:
6907
6908 @table @gcctabopt
6909 @item -mabi=@var{name}
6910 @opindex mabi
6911 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6912 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6913
6914 @item -mapcs-frame
6915 @opindex mapcs-frame
6916 Generate a stack frame that is compliant with the ARM Procedure Call
6917 Standard for all functions, even if this is not strictly necessary for
6918 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6919 with this option will cause the stack frames not to be generated for
6920 leaf functions.  The default is @option{-mno-apcs-frame}.
6921
6922 @item -mapcs
6923 @opindex mapcs
6924 This is a synonym for @option{-mapcs-frame}.
6925
6926 @ignore
6927 @c not currently implemented
6928 @item -mapcs-stack-check
6929 @opindex mapcs-stack-check
6930 Generate code to check the amount of stack space available upon entry to
6931 every function (that actually uses some stack space).  If there is
6932 insufficient space available then either the function
6933 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6934 called, depending upon the amount of stack space required.  The run time
6935 system is required to provide these functions.  The default is
6936 @option{-mno-apcs-stack-check}, since this produces smaller code.
6937
6938 @c not currently implemented
6939 @item -mapcs-float
6940 @opindex mapcs-float
6941 Pass floating point arguments using the float point registers.  This is
6942 one of the variants of the APCS@.  This option is recommended if the
6943 target hardware has a floating point unit or if a lot of floating point
6944 arithmetic is going to be performed by the code.  The default is
6945 @option{-mno-apcs-float}, since integer only code is slightly increased in
6946 size if @option{-mapcs-float} is used.
6947
6948 @c not currently implemented
6949 @item -mapcs-reentrant
6950 @opindex mapcs-reentrant
6951 Generate reentrant, position independent code.  The default is
6952 @option{-mno-apcs-reentrant}.
6953 @end ignore
6954
6955 @item -mthumb-interwork
6956 @opindex mthumb-interwork
6957 Generate code which supports calling between the ARM and Thumb
6958 instruction sets.  Without this option the two instruction sets cannot
6959 be reliably used inside one program.  The default is
6960 @option{-mno-thumb-interwork}, since slightly larger code is generated
6961 when @option{-mthumb-interwork} is specified.
6962
6963 @item -mno-sched-prolog
6964 @opindex mno-sched-prolog
6965 Prevent the reordering of instructions in the function prolog, or the
6966 merging of those instruction with the instructions in the function's
6967 body.  This means that all functions will start with a recognizable set
6968 of instructions (or in fact one of a choice from a small set of
6969 different function prologues), and this information can be used to
6970 locate the start if functions inside an executable piece of code.  The
6971 default is @option{-msched-prolog}.
6972
6973 @item -mhard-float
6974 @opindex mhard-float
6975 Generate output containing floating point instructions.  This is the
6976 default.
6977
6978 @item -msoft-float
6979 @opindex msoft-float
6980 Generate output containing library calls for floating point.
6981 @strong{Warning:} the requisite libraries are not available for all ARM
6982 targets.  Normally the facilities of the machine's usual C compiler are
6983 used, but this cannot be done directly in cross-compilation.  You must make
6984 your own arrangements to provide suitable library functions for
6985 cross-compilation.
6986
6987 @option{-msoft-float} changes the calling convention in the output file;
6988 therefore, it is only useful if you compile @emph{all} of a program with
6989 this option.  In particular, you need to compile @file{libgcc.a}, the
6990 library that comes with GCC, with @option{-msoft-float} in order for
6991 this to work.
6992
6993 @item -mfloat-abi=@var{name}
6994 @opindex mfloat-abi
6995 Specifies which ABI to use for floating point values.  Permissible values
6996 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6997
6998 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6999 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7000 of floating point instructions, but still uses the soft-float calling
7001 conventions.
7002
7003 @item -mlittle-endian
7004 @opindex mlittle-endian
7005 Generate code for a processor running in little-endian mode.  This is
7006 the default for all standard configurations.
7007
7008 @item -mbig-endian
7009 @opindex mbig-endian
7010 Generate code for a processor running in big-endian mode; the default is
7011 to compile code for a little-endian processor.
7012
7013 @item -mwords-little-endian
7014 @opindex mwords-little-endian
7015 This option only applies when generating code for big-endian processors.
7016 Generate code for a little-endian word order but a big-endian byte
7017 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7018 option should only be used if you require compatibility with code for
7019 big-endian ARM processors generated by versions of the compiler prior to
7020 2.8.
7021
7022 @item -mcpu=@var{name}
7023 @opindex mcpu
7024 This specifies the name of the target ARM processor.  GCC uses this name
7025 to determine what kind of instructions it can emit when generating
7026 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7027 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7028 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7029 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7030 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7031 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7032 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7033 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7034 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7035 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7036 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7037 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7038 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7039 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7040 @samp{ep9312}.
7041
7042 @itemx -mtune=@var{name}
7043 @opindex mtune
7044 This option is very similar to the @option{-mcpu=} option, except that
7045 instead of specifying the actual target processor type, and hence
7046 restricting which instructions can be used, it specifies that GCC should
7047 tune the performance of the code as if the target were of the type
7048 specified in this option, but still choosing the instructions that it
7049 will generate based on the cpu specified by a @option{-mcpu=} option.
7050 For some ARM implementations better performance can be obtained by using
7051 this option.
7052
7053 @item -march=@var{name}
7054 @opindex march
7055 This specifies the name of the target ARM architecture.  GCC uses this
7056 name to determine what kind of instructions it can emit when generating
7057 assembly code.  This option can be used in conjunction with or instead
7058 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7059 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7060 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7061 @samp{iwmmxt}, @samp{ep9312}.
7062
7063 @item -mfpu=@var{name}
7064 @itemx -mfpe=@var{number}
7065 @itemx -mfp=@var{number}
7066 @opindex mfpu
7067 @opindex mfpe
7068 @opindex mfp
7069 This specifies what floating point hardware (or hardware emulation) is
7070 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7071 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7072 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7073 with older versions of GCC@.
7074
7075 If @option{-msoft-float} is specified this specifies the format of
7076 floating point values.
7077
7078 @item -mstructure-size-boundary=@var{n}
7079 @opindex mstructure-size-boundary
7080 The size of all structures and unions will be rounded up to a multiple
7081 of the number of bits set by this option.  Permissible values are 8, 32
7082 and 64.  The default value varies for different toolchains.  For the COFF
7083 targeted toolchain the default value is 8.  A value of 64 is only allowed
7084 if the underlying ABI supports it.
7085
7086 Specifying the larger number can produce faster, more efficient code, but
7087 can also increase the size of the program.  Different values are potentially
7088 incompatible.  Code compiled with one value cannot necessarily expect to
7089 work with code or libraries compiled with another value, if they exchange
7090 information using structures or unions.
7091
7092 @item -mabort-on-noreturn
7093 @opindex mabort-on-noreturn
7094 Generate a call to the function @code{abort} at the end of a
7095 @code{noreturn} function.  It will be executed if the function tries to
7096 return.
7097
7098 @item -mlong-calls
7099 @itemx -mno-long-calls
7100 @opindex mlong-calls
7101 @opindex mno-long-calls
7102 Tells the compiler to perform function calls by first loading the
7103 address of the function into a register and then performing a subroutine
7104 call on this register.  This switch is needed if the target function
7105 will lie outside of the 64 megabyte addressing range of the offset based
7106 version of subroutine call instruction.
7107
7108 Even if this switch is enabled, not all function calls will be turned
7109 into long calls.  The heuristic is that static functions, functions
7110 which have the @samp{short-call} attribute, functions that are inside
7111 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7112 definitions have already been compiled within the current compilation
7113 unit, will not be turned into long calls.  The exception to this rule is
7114 that weak function definitions, functions with the @samp{long-call}
7115 attribute or the @samp{section} attribute, and functions that are within
7116 the scope of a @samp{#pragma long_calls} directive, will always be
7117 turned into long calls.
7118
7119 This feature is not enabled by default.  Specifying
7120 @option{-mno-long-calls} will restore the default behavior, as will
7121 placing the function calls within the scope of a @samp{#pragma
7122 long_calls_off} directive.  Note these switches have no effect on how
7123 the compiler generates code to handle function calls via function
7124 pointers.
7125
7126 @item -mnop-fun-dllimport
7127 @opindex mnop-fun-dllimport
7128 Disable support for the @code{dllimport} attribute.
7129
7130 @item -msingle-pic-base
7131 @opindex msingle-pic-base
7132 Treat the register used for PIC addressing as read-only, rather than
7133 loading it in the prologue for each function.  The run-time system is
7134 responsible for initializing this register with an appropriate value
7135 before execution begins.
7136
7137 @item -mpic-register=@var{reg}
7138 @opindex mpic-register
7139 Specify the register to be used for PIC addressing.  The default is R10
7140 unless stack-checking is enabled, when R9 is used.
7141
7142 @item -mcirrus-fix-invalid-insns
7143 @opindex mcirrus-fix-invalid-insns
7144 @opindex mno-cirrus-fix-invalid-insns
7145 Insert NOPs into the instruction stream to in order to work around
7146 problems with invalid Maverick instruction combinations.  This option
7147 is only valid if the @option{-mcpu=ep9312} option has been used to
7148 enable generation of instructions for the Cirrus Maverick floating
7149 point co-processor.  This option is not enabled by default, since the
7150 problem is only present in older Maverick implementations.  The default
7151 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7152 switch.
7153
7154 @item -mpoke-function-name
7155 @opindex mpoke-function-name
7156 Write the name of each function into the text section, directly
7157 preceding the function prologue.  The generated code is similar to this:
7158
7159 @smallexample
7160      t0
7161          .ascii "arm_poke_function_name", 0
7162          .align
7163      t1
7164          .word 0xff000000 + (t1 - t0)
7165      arm_poke_function_name
7166          mov     ip, sp
7167          stmfd   sp!, @{fp, ip, lr, pc@}
7168          sub     fp, ip, #4
7169 @end smallexample
7170
7171 When performing a stack backtrace, code can inspect the value of
7172 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7173 location @code{pc - 12} and the top 8 bits are set, then we know that
7174 there is a function name embedded immediately preceding this location
7175 and has length @code{((pc[-3]) & 0xff000000)}.
7176
7177 @item -mthumb
7178 @opindex mthumb
7179 Generate code for the 16-bit Thumb instruction set.  The default is to
7180 use the 32-bit ARM instruction set.
7181
7182 @item -mtpcs-frame
7183 @opindex mtpcs-frame
7184 Generate a stack frame that is compliant with the Thumb Procedure Call
7185 Standard for all non-leaf functions.  (A leaf function is one that does
7186 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7187
7188 @item -mtpcs-leaf-frame
7189 @opindex mtpcs-leaf-frame
7190 Generate a stack frame that is compliant with the Thumb Procedure Call
7191 Standard for all leaf functions.  (A leaf function is one that does
7192 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7193
7194 @item -mcallee-super-interworking
7195 @opindex mcallee-super-interworking
7196 Gives all externally visible functions in the file being compiled an ARM
7197 instruction set header which switches to Thumb mode before executing the
7198 rest of the function.  This allows these functions to be called from
7199 non-interworking code.
7200
7201 @item -mcaller-super-interworking
7202 @opindex mcaller-super-interworking
7203 Allows calls via function pointers (including virtual functions) to
7204 execute correctly regardless of whether the target code has been
7205 compiled for interworking or not.  There is a small overhead in the cost
7206 of executing a function pointer if this option is enabled.
7207
7208 @end table
7209
7210 @node AVR Options
7211 @subsection AVR Options
7212 @cindex AVR Options
7213
7214 These options are defined for AVR implementations:
7215
7216 @table @gcctabopt
7217 @item -mmcu=@var{mcu}
7218 @opindex mmcu
7219 Specify ATMEL AVR instruction set or MCU type.
7220
7221 Instruction set avr1 is for the minimal AVR core, not supported by the C
7222 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7223 attiny11, attiny12, attiny15, attiny28).
7224
7225 Instruction set avr2 (default) is for the classic AVR core with up to
7226 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7227 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7228 at90c8534, at90s8535).
7229
7230 Instruction set avr3 is for the classic AVR core with up to 128K program
7231 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7232
7233 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7234 memory space (MCU types: atmega8, atmega83, atmega85).
7235
7236 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7237 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7238 atmega64, atmega128, at43usb355, at94k).
7239
7240 @item -msize
7241 @opindex msize
7242 Output instruction sizes to the asm file.
7243
7244 @item -minit-stack=@var{N}
7245 @opindex minit-stack
7246 Specify the initial stack address, which may be a symbol or numeric value,
7247 @samp{__stack} is the default.
7248
7249 @item -mno-interrupts
7250 @opindex mno-interrupts
7251 Generated code is not compatible with hardware interrupts.
7252 Code size will be smaller.
7253
7254 @item -mcall-prologues
7255 @opindex mcall-prologues
7256 Functions prologues/epilogues expanded as call to appropriate
7257 subroutines.  Code size will be smaller.
7258
7259 @item -mno-tablejump
7260 @opindex mno-tablejump
7261 Do not generate tablejump insns which sometimes increase code size.
7262
7263 @item -mtiny-stack
7264 @opindex mtiny-stack
7265 Change only the low 8 bits of the stack pointer.
7266
7267 @item -mint8
7268 @opindex mint8
7269 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7270 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7271 and long long will be 4 bytes.  Please note that this option does not
7272 comply to the C standards, but it will provide you with smaller code
7273 size.
7274 @end table
7275
7276 @node Blackfin Options
7277 @subsection Blackfin Options
7278 @cindex Blackfin Options
7279
7280 @table @gcctabopt
7281 @item -momit-leaf-frame-pointer
7282 @opindex momit-leaf-frame-pointer
7283 Don't keep the frame pointer in a register for leaf functions.  This
7284 avoids the instructions to save, set up and restore frame pointers and
7285 makes an extra register available in leaf functions.  The option
7286 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7287 which might make debugging harder.
7288
7289 @item -mcsync
7290 @opindex mcsync
7291 When enabled, the compiler will ensure that the generated code does not
7292 contain speculative loads after jump instructions.  This option is enabled
7293 by default.
7294
7295 @item -mno-csync
7296 @opindex mno-csync
7297 Don't generate extra code to prevent speculative loads from occurring.
7298
7299 @item -mlow-64k
7300 @opindex mlow-64k
7301 When enabled, the compiler is free to take advantage of the knowledge that
7302 the entire program fits into the low 64k of memory.
7303
7304 @item -mno-low-64k
7305 @opindex mno-low-64k
7306 Assume that the program is arbitrarily large.  This is the default.
7307
7308 @item -mid-shared-library
7309 @opindex mid-shared-library
7310 Generate code that supports shared libraries via the library ID method.
7311 This allows for execute in place and shared libraries in an environment
7312 without virtual memory management.  This option implies @option{-fPIC}.
7313
7314 @item -mno-id-shared-library
7315 @opindex mno-id-shared-library
7316 Generate code that doesn't assume ID based shared libraries are being used.
7317 This is the default.
7318
7319 @item -mshared-library-id=n
7320 @opindex mshared-library-id
7321 Specified the identification number of the ID based shared library being
7322 compiled.  Specifying a value of 0 will generate more compact code, specifying
7323 other values will force the allocation of that number to the current
7324 library but is no more space or time efficient than omitting this option.
7325 @end table
7326
7327 @node CRIS Options
7328 @subsection CRIS Options
7329 @cindex CRIS Options
7330
7331 These options are defined specifically for the CRIS ports.
7332
7333 @table @gcctabopt
7334 @item -march=@var{architecture-type}
7335 @itemx -mcpu=@var{architecture-type}
7336 @opindex march
7337 @opindex mcpu
7338 Generate code for the specified architecture.  The choices for
7339 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7340 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7341 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7342 @samp{v10}.
7343
7344 @item -mtune=@var{architecture-type}
7345 @opindex mtune
7346 Tune to @var{architecture-type} everything applicable about the generated
7347 code, except for the ABI and the set of available instructions.  The
7348 choices for @var{architecture-type} are the same as for
7349 @option{-march=@var{architecture-type}}.
7350
7351 @item -mmax-stack-frame=@var{n}
7352 @opindex mmax-stack-frame
7353 Warn when the stack frame of a function exceeds @var{n} bytes.
7354
7355 @item -melinux-stacksize=@var{n}
7356 @opindex melinux-stacksize
7357 Only available with the @samp{cris-axis-aout} target.  Arranges for
7358 indications in the program to the kernel loader that the stack of the
7359 program should be set to @var{n} bytes.
7360
7361 @item -metrax4
7362 @itemx -metrax100
7363 @opindex metrax4
7364 @opindex metrax100
7365 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7366 @option{-march=v3} and @option{-march=v8} respectively.
7367
7368 @item -mmul-bug-workaround
7369 @itemx -mno-mul-bug-workaround
7370 @opindex mmul-bug-workaround
7371 @opindex mno-mul-bug-workaround
7372 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7373 models where it applies.  This option is active by default.
7374
7375 @item -mpdebug
7376 @opindex mpdebug
7377 Enable CRIS-specific verbose debug-related information in the assembly
7378 code.  This option also has the effect to turn off the @samp{#NO_APP}
7379 formatted-code indicator to the assembler at the beginning of the
7380 assembly file.
7381
7382 @item -mcc-init
7383 @opindex mcc-init
7384 Do not use condition-code results from previous instruction; always emit
7385 compare and test instructions before use of condition codes.
7386
7387 @item -mno-side-effects
7388 @opindex mno-side-effects
7389 Do not emit instructions with side-effects in addressing modes other than
7390 post-increment.
7391
7392 @item -mstack-align
7393 @itemx -mno-stack-align
7394 @itemx -mdata-align
7395 @itemx -mno-data-align
7396 @itemx -mconst-align
7397 @itemx -mno-const-align
7398 @opindex mstack-align
7399 @opindex mno-stack-align
7400 @opindex mdata-align
7401 @opindex mno-data-align
7402 @opindex mconst-align
7403 @opindex mno-const-align
7404 These options (no-options) arranges (eliminate arrangements) for the
7405 stack-frame, individual data and constants to be aligned for the maximum
7406 single data access size for the chosen CPU model.  The default is to
7407 arrange for 32-bit alignment.  ABI details such as structure layout are
7408 not affected by these options.
7409
7410 @item -m32-bit
7411 @itemx -m16-bit
7412 @itemx -m8-bit
7413 @opindex m32-bit
7414 @opindex m16-bit
7415 @opindex m8-bit
7416 Similar to the stack- data- and const-align options above, these options
7417 arrange for stack-frame, writable data and constants to all be 32-bit,
7418 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7419
7420 @item -mno-prologue-epilogue
7421 @itemx -mprologue-epilogue
7422 @opindex mno-prologue-epilogue
7423 @opindex mprologue-epilogue
7424 With @option{-mno-prologue-epilogue}, the normal function prologue and
7425 epilogue that sets up the stack-frame are omitted and no return
7426 instructions or return sequences are generated in the code.  Use this
7427 option only together with visual inspection of the compiled code: no
7428 warnings or errors are generated when call-saved registers must be saved,
7429 or storage for local variable needs to be allocated.
7430
7431 @item -mno-gotplt
7432 @itemx -mgotplt
7433 @opindex mno-gotplt
7434 @opindex mgotplt
7435 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7436 instruction sequences that load addresses for functions from the PLT part
7437 of the GOT rather than (traditional on other architectures) calls to the
7438 PLT@.  The default is @option{-mgotplt}.
7439
7440 @item -maout
7441 @opindex maout
7442 Legacy no-op option only recognized with the cris-axis-aout target.
7443
7444 @item -melf
7445 @opindex melf
7446 Legacy no-op option only recognized with the cris-axis-elf and
7447 cris-axis-linux-gnu targets.
7448
7449 @item -melinux
7450 @opindex melinux
7451 Only recognized with the cris-axis-aout target, where it selects a
7452 GNU/linux-like multilib, include files and instruction set for
7453 @option{-march=v8}.
7454
7455 @item -mlinux
7456 @opindex mlinux
7457 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7458
7459 @item -sim
7460 @opindex sim
7461 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7462 to link with input-output functions from a simulator library.  Code,
7463 initialized data and zero-initialized data are allocated consecutively.
7464
7465 @item -sim2
7466 @opindex sim2
7467 Like @option{-sim}, but pass linker options to locate initialized data at
7468 0x40000000 and zero-initialized data at 0x80000000.
7469 @end table
7470
7471 @node Darwin Options
7472 @subsection Darwin Options
7473 @cindex Darwin options
7474
7475 These options are defined for all architectures running the Darwin operating
7476 system.
7477
7478 FSF GCC on Darwin does not create ``fat'' object files; it will create
7479 an object file for the single architecture that it was built to
7480 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7481 @option{-arch} options are used; it does so by running the compiler or
7482 linker multiple times and joining the results together with
7483 @file{lipo}.
7484
7485 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7486 @samp{i686}) is determined by the flags that specify the ISA
7487 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7488 @option{-force_cpusubtype_ALL} option can be used to override this.
7489
7490 The Darwin tools vary in their behavior when presented with an ISA
7491 mismatch.  The assembler, @file{as}, will only permit instructions to
7492 be used that are valid for the subtype of the file it is generating,
7493 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7494 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7495 and print an error if asked to create a shared library with a less
7496 restrictive subtype than its input files (for instance, trying to put
7497 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7498 for executables, @file{ld}, will quietly give the executable the most
7499 restrictive subtype of any of its input files.
7500
7501 @table @gcctabopt
7502 @item -F@var{dir}
7503 @opindex F
7504 Add the framework directory @var{dir} to the head of the list of
7505 directories to be searched for header files.  These directories are
7506 interleaved with those specified by @option{-I} options and are
7507 scanned in a left-to-right order.
7508
7509 A framework directory is a directory with frameworks in it.  A
7510 framework is a directory with a @samp{"Headers"} and/or
7511 @samp{"PrivateHeaders"} directory contained directly in it that ends
7512 in @samp{".framework"}.  The name of a framework is the name of this
7513 directory excluding the @samp{".framework"}.  Headers associated with
7514 the framework are found in one of those two directories, with
7515 @samp{"Headers"} being searched first.  A subframework is a framework
7516 directory that is in a framework's @samp{"Frameworks"} directory.
7517 Includes of subframework headers can only appear in a header of a
7518 framework that contains the subframework, or in a sibling subframework
7519 header.  Two subframeworks are siblings if they occur in the same
7520 framework.  A subframework should not have the same name as a
7521 framework, a warning will be issued if this is violated.  Currently a
7522 subframework cannot have subframeworks, in the future, the mechanism
7523 may be extended to support this.  The standard frameworks can be found
7524 in @samp{"/System/Library/Frameworks"} and
7525 @samp{"/Library/Frameworks"}.  An example include looks like
7526 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7527 the name of the framework and header.h is found in the
7528 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7529
7530 @item -gused
7531 @opindex -gused
7532 Emit debugging information for symbols that are used.  For STABS
7533 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7534 This is by default ON@.
7535
7536 @item -gfull
7537 @opindex -gfull
7538 Emit debugging information for all symbols and types.
7539
7540 @item -mone-byte-bool
7541 @opindex -mone-byte-bool
7542 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7543 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7544 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7545 option has no effect on x86.
7546
7547 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7548 to generate code that is not binary compatible with code generated
7549 without that switch.  Using this switch may require recompiling all
7550 other modules in a program, including system libraries.  Use this
7551 switch to conform to a non-default data model.
7552
7553 @item -mfix-and-continue
7554 @itemx -ffix-and-continue
7555 @itemx -findirect-data
7556 @opindex mfix-and-continue
7557 @opindex ffix-and-continue
7558 @opindex findirect-data
7559 Generate code suitable for fast turn around development.  Needed to
7560 enable gdb to dynamically load @code{.o} files into already running
7561 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7562 are provided for backwards compatibility.
7563
7564 @item -all_load
7565 @opindex all_load
7566 Loads all members of static archive libraries.
7567 See man ld(1) for more information.
7568
7569 @item -arch_errors_fatal
7570 @opindex arch_errors_fatal
7571 Cause the errors having to do with files that have the wrong architecture
7572 to be fatal.
7573
7574 @item -bind_at_load
7575 @opindex bind_at_load
7576 Causes the output file to be marked such that the dynamic linker will
7577 bind all undefined references when the file is loaded or launched.
7578
7579 @item -bundle
7580 @opindex bundle
7581 Produce a Mach-o bundle format file.
7582 See man ld(1) for more information.
7583
7584 @item -bundle_loader @var{executable}
7585 @opindex bundle_loader
7586 This option specifies the @var{executable} that will be loading the build
7587 output file being linked.  See man ld(1) for more information.
7588
7589 @item -dynamiclib
7590 @opindex -dynamiclib
7591 When passed this option, GCC will produce a dynamic library instead of
7592 an executable when linking, using the Darwin @file{libtool} command.
7593
7594 @item -force_cpusubtype_ALL
7595 @opindex -force_cpusubtype_ALL
7596 This causes GCC's output file to have the @var{ALL} subtype, instead of
7597 one controlled by the @option{-mcpu} or @option{-march} option.
7598
7599 @item -allowable_client  @var{client_name}
7600 @itemx -client_name
7601 @itemx -compatibility_version
7602 @itemx -current_version
7603 @itemx -dead_strip
7604 @itemx -dependency-file
7605 @itemx -dylib_file
7606 @itemx -dylinker_install_name
7607 @itemx -dynamic
7608 @itemx -exported_symbols_list
7609 @itemx -filelist
7610 @itemx -flat_namespace
7611 @itemx -force_flat_namespace
7612 @itemx -headerpad_max_install_names
7613 @itemx -image_base
7614 @itemx -init
7615 @itemx -install_name
7616 @itemx -keep_private_externs
7617 @itemx -multi_module
7618 @itemx -multiply_defined
7619 @itemx -multiply_defined_unused
7620 @itemx -noall_load
7621 @itemx -no_dead_strip_inits_and_terms
7622 @itemx -nofixprebinding
7623 @itemx -nomultidefs
7624 @itemx -noprebind
7625 @itemx -noseglinkedit
7626 @itemx -pagezero_size
7627 @itemx -prebind
7628 @itemx -prebind_all_twolevel_modules
7629 @itemx -private_bundle
7630 @itemx -read_only_relocs
7631 @itemx -sectalign
7632 @itemx -sectobjectsymbols
7633 @itemx -whyload
7634 @itemx -seg1addr
7635 @itemx -sectcreate
7636 @itemx -sectobjectsymbols
7637 @itemx -sectorder
7638 @itemx -segaddr
7639 @itemx -segs_read_only_addr
7640 @itemx -segs_read_write_addr
7641 @itemx -seg_addr_table
7642 @itemx -seg_addr_table_filename
7643 @itemx -seglinkedit
7644 @itemx -segprot
7645 @itemx -segs_read_only_addr
7646 @itemx -segs_read_write_addr
7647 @itemx -single_module
7648 @itemx -static
7649 @itemx -sub_library
7650 @itemx -sub_umbrella
7651 @itemx -twolevel_namespace
7652 @itemx -umbrella
7653 @itemx -undefined
7654 @itemx -unexported_symbols_list
7655 @itemx -weak_reference_mismatches
7656 @itemx -whatsloaded
7657
7658 @opindex allowable_client
7659 @opindex client_name
7660 @opindex compatibility_version
7661 @opindex current_version
7662 @opindex dead_strip
7663 @opindex dependency-file
7664 @opindex dylib_file
7665 @opindex dylinker_install_name
7666 @opindex dynamic
7667 @opindex exported_symbols_list
7668 @opindex filelist
7669 @opindex flat_namespace
7670 @opindex force_flat_namespace
7671 @opindex headerpad_max_install_names
7672 @opindex image_base
7673 @opindex init
7674 @opindex install_name
7675 @opindex keep_private_externs
7676 @opindex multi_module
7677 @opindex multiply_defined
7678 @opindex multiply_defined_unused
7679 @opindex noall_load
7680 @opindex no_dead_strip_inits_and_terms
7681 @opindex nofixprebinding
7682 @opindex nomultidefs
7683 @opindex noprebind
7684 @opindex noseglinkedit
7685 @opindex pagezero_size
7686 @opindex prebind
7687 @opindex prebind_all_twolevel_modules
7688 @opindex private_bundle
7689 @opindex read_only_relocs
7690 @opindex sectalign
7691 @opindex sectobjectsymbols
7692 @opindex whyload
7693 @opindex seg1addr
7694 @opindex sectcreate
7695 @opindex sectobjectsymbols
7696 @opindex sectorder
7697 @opindex segaddr
7698 @opindex segs_read_only_addr
7699 @opindex segs_read_write_addr
7700 @opindex seg_addr_table
7701 @opindex seg_addr_table_filename
7702 @opindex seglinkedit
7703 @opindex segprot
7704 @opindex segs_read_only_addr
7705 @opindex segs_read_write_addr
7706 @opindex single_module
7707 @opindex static
7708 @opindex sub_library
7709 @opindex sub_umbrella
7710 @opindex twolevel_namespace
7711 @opindex umbrella
7712 @opindex undefined
7713 @opindex unexported_symbols_list
7714 @opindex weak_reference_mismatches
7715 @opindex whatsloaded
7716
7717 These options are passed to the Darwin linker.  The Darwin linker man page
7718 describes them in detail.
7719 @end table
7720
7721 @node DEC Alpha Options
7722 @subsection DEC Alpha Options
7723
7724 These @samp{-m} options are defined for the DEC Alpha implementations:
7725
7726 @table @gcctabopt
7727 @item -mno-soft-float
7728 @itemx -msoft-float
7729 @opindex mno-soft-float
7730 @opindex msoft-float
7731 Use (do not use) the hardware floating-point instructions for
7732 floating-point operations.  When @option{-msoft-float} is specified,
7733 functions in @file{libgcc.a} will be used to perform floating-point
7734 operations.  Unless they are replaced by routines that emulate the
7735 floating-point operations, or compiled in such a way as to call such
7736 emulations routines, these routines will issue floating-point
7737 operations.   If you are compiling for an Alpha without floating-point
7738 operations, you must ensure that the library is built so as not to call
7739 them.
7740
7741 Note that Alpha implementations without floating-point operations are
7742 required to have floating-point registers.
7743
7744 @item -mfp-reg
7745 @itemx -mno-fp-regs
7746 @opindex mfp-reg
7747 @opindex mno-fp-regs
7748 Generate code that uses (does not use) the floating-point register set.
7749 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7750 register set is not used, floating point operands are passed in integer
7751 registers as if they were integers and floating-point results are passed
7752 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7753 so any function with a floating-point argument or return value called by code
7754 compiled with @option{-mno-fp-regs} must also be compiled with that
7755 option.
7756
7757 A typical use of this option is building a kernel that does not use,
7758 and hence need not save and restore, any floating-point registers.
7759
7760 @item -mieee
7761 @opindex mieee
7762 The Alpha architecture implements floating-point hardware optimized for
7763 maximum performance.  It is mostly compliant with the IEEE floating
7764 point standard.  However, for full compliance, software assistance is
7765 required.  This option generates code fully IEEE compliant code
7766 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7767 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7768 defined during compilation.  The resulting code is less efficient but is
7769 able to correctly support denormalized numbers and exceptional IEEE
7770 values such as not-a-number and plus/minus infinity.  Other Alpha
7771 compilers call this option @option{-ieee_with_no_inexact}.
7772
7773 @item -mieee-with-inexact
7774 @opindex mieee-with-inexact
7775 This is like @option{-mieee} except the generated code also maintains
7776 the IEEE @var{inexact-flag}.  Turning on this option causes the
7777 generated code to implement fully-compliant IEEE math.  In addition to
7778 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7779 macro.  On some Alpha implementations the resulting code may execute
7780 significantly slower than the code generated by default.  Since there is
7781 very little code that depends on the @var{inexact-flag}, you should
7782 normally not specify this option.  Other Alpha compilers call this
7783 option @option{-ieee_with_inexact}.
7784
7785 @item -mfp-trap-mode=@var{trap-mode}
7786 @opindex mfp-trap-mode
7787 This option controls what floating-point related traps are enabled.
7788 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7789 The trap mode can be set to one of four values:
7790
7791 @table @samp
7792 @item n
7793 This is the default (normal) setting.  The only traps that are enabled
7794 are the ones that cannot be disabled in software (e.g., division by zero
7795 trap).
7796
7797 @item u
7798 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7799 as well.
7800
7801 @item su
7802 Like @samp{su}, but the instructions are marked to be safe for software
7803 completion (see Alpha architecture manual for details).
7804
7805 @item sui
7806 Like @samp{su}, but inexact traps are enabled as well.
7807 @end table
7808
7809 @item -mfp-rounding-mode=@var{rounding-mode}
7810 @opindex mfp-rounding-mode
7811 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7812 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7813 of:
7814
7815 @table @samp
7816 @item n
7817 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7818 the nearest machine number or towards the even machine number in case
7819 of a tie.
7820
7821 @item m
7822 Round towards minus infinity.
7823
7824 @item c
7825 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7826
7827 @item d
7828 Dynamic rounding mode.  A field in the floating point control register
7829 (@var{fpcr}, see Alpha architecture reference manual) controls the
7830 rounding mode in effect.  The C library initializes this register for
7831 rounding towards plus infinity.  Thus, unless your program modifies the
7832 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7833 @end table
7834
7835 @item -mtrap-precision=@var{trap-precision}
7836 @opindex mtrap-precision
7837 In the Alpha architecture, floating point traps are imprecise.  This
7838 means without software assistance it is impossible to recover from a
7839 floating trap and program execution normally needs to be terminated.
7840 GCC can generate code that can assist operating system trap handlers
7841 in determining the exact location that caused a floating point trap.
7842 Depending on the requirements of an application, different levels of
7843 precisions can be selected:
7844
7845 @table @samp
7846 @item p
7847 Program precision.  This option is the default and means a trap handler
7848 can only identify which program caused a floating point exception.
7849
7850 @item f
7851 Function precision.  The trap handler can determine the function that
7852 caused a floating point exception.
7853
7854 @item i
7855 Instruction precision.  The trap handler can determine the exact
7856 instruction that caused a floating point exception.
7857 @end table
7858
7859 Other Alpha compilers provide the equivalent options called
7860 @option{-scope_safe} and @option{-resumption_safe}.
7861
7862 @item -mieee-conformant
7863 @opindex mieee-conformant
7864 This option marks the generated code as IEEE conformant.  You must not
7865 use this option unless you also specify @option{-mtrap-precision=i} and either
7866 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7867 is to emit the line @samp{.eflag 48} in the function prologue of the
7868 generated assembly file.  Under DEC Unix, this has the effect that
7869 IEEE-conformant math library routines will be linked in.
7870
7871 @item -mbuild-constants
7872 @opindex mbuild-constants
7873 Normally GCC examines a 32- or 64-bit integer constant to
7874 see if it can construct it from smaller constants in two or three
7875 instructions.  If it cannot, it will output the constant as a literal and
7876 generate code to load it from the data segment at runtime.
7877
7878 Use this option to require GCC to construct @emph{all} integer constants
7879 using code, even if it takes more instructions (the maximum is six).
7880
7881 You would typically use this option to build a shared library dynamic
7882 loader.  Itself a shared library, it must relocate itself in memory
7883 before it can find the variables and constants in its own data segment.
7884
7885 @item -malpha-as
7886 @itemx -mgas
7887 @opindex malpha-as
7888 @opindex mgas
7889 Select whether to generate code to be assembled by the vendor-supplied
7890 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7891
7892 @item -mbwx
7893 @itemx -mno-bwx
7894 @itemx -mcix
7895 @itemx -mno-cix
7896 @itemx -mfix
7897 @itemx -mno-fix
7898 @itemx -mmax
7899 @itemx -mno-max
7900 @opindex mbwx
7901 @opindex mno-bwx
7902 @opindex mcix
7903 @opindex mno-cix
7904 @opindex mfix
7905 @opindex mno-fix
7906 @opindex mmax
7907 @opindex mno-max
7908 Indicate whether GCC should generate code to use the optional BWX,
7909 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7910 sets supported by the CPU type specified via @option{-mcpu=} option or that
7911 of the CPU on which GCC was built if none was specified.
7912
7913 @item -mfloat-vax
7914 @itemx -mfloat-ieee
7915 @opindex mfloat-vax
7916 @opindex mfloat-ieee
7917 Generate code that uses (does not use) VAX F and G floating point
7918 arithmetic instead of IEEE single and double precision.
7919
7920 @item -mexplicit-relocs
7921 @itemx -mno-explicit-relocs
7922 @opindex mexplicit-relocs
7923 @opindex mno-explicit-relocs
7924 Older Alpha assemblers provided no way to generate symbol relocations
7925 except via assembler macros.  Use of these macros does not allow
7926 optimal instruction scheduling.  GNU binutils as of version 2.12
7927 supports a new syntax that allows the compiler to explicitly mark
7928 which relocations should apply to which instructions.  This option
7929 is mostly useful for debugging, as GCC detects the capabilities of
7930 the assembler when it is built and sets the default accordingly.
7931
7932 @item -msmall-data
7933 @itemx -mlarge-data
7934 @opindex msmall-data
7935 @opindex mlarge-data
7936 When @option{-mexplicit-relocs} is in effect, static data is
7937 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7938 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7939 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7940 16-bit relocations off of the @code{$gp} register.  This limits the
7941 size of the small data area to 64KB, but allows the variables to be
7942 directly accessed via a single instruction.
7943
7944 The default is @option{-mlarge-data}.  With this option the data area
7945 is limited to just below 2GB@.  Programs that require more than 2GB of
7946 data must use @code{malloc} or @code{mmap} to allocate the data in the
7947 heap instead of in the program's data segment.
7948
7949 When generating code for shared libraries, @option{-fpic} implies
7950 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7951
7952 @item -msmall-text
7953 @itemx -mlarge-text
7954 @opindex msmall-text
7955 @opindex mlarge-text
7956 When @option{-msmall-text} is used, the compiler assumes that the
7957 code of the entire program (or shared library) fits in 4MB, and is
7958 thus reachable with a branch instruction.  When @option{-msmall-data}
7959 is used, the compiler can assume that all local symbols share the
7960 same @code{$gp} value, and thus reduce the number of instructions
7961 required for a function call from 4 to 1.
7962
7963 The default is @option{-mlarge-text}.
7964
7965 @item -mcpu=@var{cpu_type}
7966 @opindex mcpu
7967 Set the instruction set and instruction scheduling parameters for
7968 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7969 style name or the corresponding chip number.  GCC supports scheduling
7970 parameters for the EV4, EV5 and EV6 family of processors and will
7971 choose the default values for the instruction set from the processor
7972 you specify.  If you do not specify a processor type, GCC will default
7973 to the processor on which the compiler was built.
7974
7975 Supported values for @var{cpu_type} are
7976
7977 @table @samp
7978 @item ev4
7979 @itemx ev45
7980 @itemx 21064
7981 Schedules as an EV4 and has no instruction set extensions.
7982
7983 @item ev5
7984 @itemx 21164
7985 Schedules as an EV5 and has no instruction set extensions.
7986
7987 @item ev56
7988 @itemx 21164a
7989 Schedules as an EV5 and supports the BWX extension.
7990
7991 @item pca56
7992 @itemx 21164pc
7993 @itemx 21164PC
7994 Schedules as an EV5 and supports the BWX and MAX extensions.
7995
7996 @item ev6
7997 @itemx 21264
7998 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7999
8000 @item ev67
8001 @itemx 21264a
8002 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8003 @end table
8004
8005 @item -mtune=@var{cpu_type}
8006 @opindex mtune
8007 Set only the instruction scheduling parameters for machine type
8008 @var{cpu_type}.  The instruction set is not changed.
8009
8010 @item -mmemory-latency=@var{time}
8011 @opindex mmemory-latency
8012 Sets the latency the scheduler should assume for typical memory
8013 references as seen by the application.  This number is highly
8014 dependent on the memory access patterns used by the application
8015 and the size of the external cache on the machine.
8016
8017 Valid options for @var{time} are
8018
8019 @table @samp
8020 @item @var{number}
8021 A decimal number representing clock cycles.
8022
8023 @item L1
8024 @itemx L2
8025 @itemx L3
8026 @itemx main
8027 The compiler contains estimates of the number of clock cycles for
8028 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8029 (also called Dcache, Scache, and Bcache), as well as to main memory.
8030 Note that L3 is only valid for EV5.
8031
8032 @end table
8033 @end table
8034
8035 @node DEC Alpha/VMS Options
8036 @subsection DEC Alpha/VMS Options
8037
8038 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8039
8040 @table @gcctabopt
8041 @item -mvms-return-codes
8042 @opindex mvms-return-codes
8043 Return VMS condition codes from main.  The default is to return POSIX
8044 style condition (e.g.@ error) codes.
8045 @end table
8046
8047 @node FRV Options
8048 @subsection FRV Options
8049 @cindex FRV Options
8050
8051 @table @gcctabopt
8052 @item -mgpr-32
8053 @opindex mgpr-32
8054
8055 Only use the first 32 general purpose registers.
8056
8057 @item -mgpr-64
8058 @opindex mgpr-64
8059
8060 Use all 64 general purpose registers.
8061
8062 @item -mfpr-32
8063 @opindex mfpr-32
8064
8065 Use only the first 32 floating point registers.
8066
8067 @item -mfpr-64
8068 @opindex mfpr-64
8069
8070 Use all 64 floating point registers
8071
8072 @item -mhard-float
8073 @opindex mhard-float
8074
8075 Use hardware instructions for floating point operations.
8076
8077 @item -msoft-float
8078 @opindex msoft-float
8079
8080 Use library routines for floating point operations.
8081
8082 @item -malloc-cc
8083 @opindex malloc-cc
8084
8085 Dynamically allocate condition code registers.
8086
8087 @item -mfixed-cc
8088 @opindex mfixed-cc
8089
8090 Do not try to dynamically allocate condition code registers, only
8091 use @code{icc0} and @code{fcc0}.
8092
8093 @item -mdword
8094 @opindex mdword
8095
8096 Change ABI to use double word insns.
8097
8098 @item -mno-dword
8099 @opindex mno-dword
8100
8101 Do not use double word instructions.
8102
8103 @item -mdouble
8104 @opindex mdouble
8105
8106 Use floating point double instructions.
8107
8108 @item -mno-double
8109 @opindex mno-double
8110
8111 Do not use floating point double instructions.
8112
8113 @item -mmedia
8114 @opindex mmedia
8115
8116 Use media instructions.
8117
8118 @item -mno-media
8119 @opindex mno-media
8120
8121 Do not use media instructions.
8122
8123 @item -mmuladd
8124 @opindex mmuladd
8125
8126 Use multiply and add/subtract instructions.
8127
8128 @item -mno-muladd
8129 @opindex mno-muladd
8130
8131 Do not use multiply and add/subtract instructions.
8132
8133 @item -mfdpic
8134 @opindex mfdpic
8135
8136 Select the FDPIC ABI, that uses function descriptors to represent
8137 pointers to functions.  Without any PIC/PIE-related options, it
8138 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8139 assumes GOT entries and small data are within a 12-bit range from the
8140 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8141 are computed with 32 bits.
8142
8143 @item -minline-plt
8144 @opindex minline-plt
8145
8146 Enable inlining of PLT entries in function calls to functions that are
8147 not known to bind locally.  It has no effect without @option{-mfdpic}.
8148 It's enabled by default if optimizing for speed and compiling for
8149 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8150 optimization option such as @option{-O3} or above is present in the
8151 command line.
8152
8153 @item -mTLS
8154 @opindex TLS
8155
8156 Assume a large TLS segment when generating thread-local code.
8157
8158 @item -mtls
8159 @opindex tls
8160
8161 Do not assume a large TLS segment when generating thread-local code.
8162
8163 @item -mgprel-ro
8164 @opindex mgprel-ro
8165
8166 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8167 that is known to be in read-only sections.  It's enabled by default,
8168 except for @option{-fpic} or @option{-fpie}: even though it may help
8169 make the global offset table smaller, it trades 1 instruction for 4.
8170 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8171 one of which may be shared by multiple symbols, and it avoids the need
8172 for a GOT entry for the referenced symbol, so it's more likely to be a
8173 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8174
8175 @item -multilib-library-pic
8176 @opindex multilib-library-pic
8177
8178 Link with the (library, not FD) pic libraries.  It's implied by
8179 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8180 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8181 it explicitly.
8182
8183 @item -mlinked-fp
8184 @opindex mlinked-fp
8185
8186 Follow the EABI requirement of always creating a frame pointer whenever
8187 a stack frame is allocated.  This option is enabled by default and can
8188 be disabled with @option{-mno-linked-fp}.
8189
8190 @item -mlong-calls
8191 @opindex mlong-calls
8192
8193 Use indirect addressing to call functions outside the current
8194 compilation unit.  This allows the functions to be placed anywhere
8195 within the 32-bit address space.
8196
8197 @item -malign-labels
8198 @opindex malign-labels
8199
8200 Try to align labels to an 8-byte boundary by inserting nops into the
8201 previous packet.  This option only has an effect when VLIW packing
8202 is enabled.  It doesn't create new packets; it merely adds nops to
8203 existing ones.
8204
8205 @item -mlibrary-pic
8206 @opindex mlibrary-pic
8207
8208 Generate position-independent EABI code.
8209
8210 @item -macc-4
8211 @opindex macc-4
8212
8213 Use only the first four media accumulator registers.
8214
8215 @item -macc-8
8216 @opindex macc-8
8217
8218 Use all eight media accumulator registers.
8219
8220 @item -mpack
8221 @opindex mpack
8222
8223 Pack VLIW instructions.
8224
8225 @item -mno-pack
8226 @opindex mno-pack
8227
8228 Do not pack VLIW instructions.
8229
8230 @item -mno-eflags
8231 @opindex mno-eflags
8232
8233 Do not mark ABI switches in e_flags.
8234
8235 @item -mcond-move
8236 @opindex mcond-move
8237
8238 Enable the use of conditional-move instructions (default).
8239
8240 This switch is mainly for debugging the compiler and will likely be removed
8241 in a future version.
8242
8243 @item -mno-cond-move
8244 @opindex mno-cond-move
8245
8246 Disable the use of conditional-move instructions.
8247
8248 This switch is mainly for debugging the compiler and will likely be removed
8249 in a future version.
8250
8251 @item -mscc
8252 @opindex mscc
8253
8254 Enable the use of conditional set instructions (default).
8255
8256 This switch is mainly for debugging the compiler and will likely be removed
8257 in a future version.
8258
8259 @item -mno-scc
8260 @opindex mno-scc
8261
8262 Disable the use of conditional set instructions.
8263
8264 This switch is mainly for debugging the compiler and will likely be removed
8265 in a future version.
8266
8267 @item -mcond-exec
8268 @opindex mcond-exec
8269
8270 Enable the use of conditional execution (default).
8271
8272 This switch is mainly for debugging the compiler and will likely be removed
8273 in a future version.
8274
8275 @item -mno-cond-exec
8276 @opindex mno-cond-exec
8277
8278 Disable the use of conditional execution.
8279
8280 This switch is mainly for debugging the compiler and will likely be removed
8281 in a future version.
8282
8283 @item -mvliw-branch
8284 @opindex mvliw-branch
8285
8286 Run a pass to pack branches into VLIW instructions (default).
8287
8288 This switch is mainly for debugging the compiler and will likely be removed
8289 in a future version.
8290
8291 @item -mno-vliw-branch
8292 @opindex mno-vliw-branch
8293
8294 Do not run a pass to pack branches into VLIW instructions.
8295
8296 This switch is mainly for debugging the compiler and will likely be removed
8297 in a future version.
8298
8299 @item -mmulti-cond-exec
8300 @opindex mmulti-cond-exec
8301
8302 Enable optimization of @code{&&} and @code{||} in conditional execution
8303 (default).
8304
8305 This switch is mainly for debugging the compiler and will likely be removed
8306 in a future version.
8307
8308 @item -mno-multi-cond-exec
8309 @opindex mno-multi-cond-exec
8310
8311 Disable optimization of @code{&&} and @code{||} in conditional execution.
8312
8313 This switch is mainly for debugging the compiler and will likely be removed
8314 in a future version.
8315
8316 @item -mnested-cond-exec
8317 @opindex mnested-cond-exec
8318
8319 Enable nested conditional execution optimizations (default).
8320
8321 This switch is mainly for debugging the compiler and will likely be removed
8322 in a future version.
8323
8324 @item -mno-nested-cond-exec
8325 @opindex mno-nested-cond-exec
8326
8327 Disable nested conditional execution optimizations.
8328
8329 This switch is mainly for debugging the compiler and will likely be removed
8330 in a future version.
8331
8332 @item -mtomcat-stats
8333 @opindex mtomcat-stats
8334
8335 Cause gas to print out tomcat statistics.
8336
8337 @item -mcpu=@var{cpu}
8338 @opindex mcpu
8339
8340 Select the processor type for which to generate code.  Possible values are
8341 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8342 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8343
8344 @end table
8345
8346 @node H8/300 Options
8347 @subsection H8/300 Options
8348
8349 These @samp{-m} options are defined for the H8/300 implementations:
8350
8351 @table @gcctabopt
8352 @item -mrelax
8353 @opindex mrelax
8354 Shorten some address references at link time, when possible; uses the
8355 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8356 ld, Using ld}, for a fuller description.
8357
8358 @item -mh
8359 @opindex mh
8360 Generate code for the H8/300H@.
8361
8362 @item -ms
8363 @opindex ms
8364 Generate code for the H8S@.
8365
8366 @item -mn
8367 @opindex mn
8368 Generate code for the H8S and H8/300H in the normal mode.  This switch
8369 must be used either with @option{-mh} or @option{-ms}.
8370
8371 @item -ms2600
8372 @opindex ms2600
8373 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8374
8375 @item -mint32
8376 @opindex mint32
8377 Make @code{int} data 32 bits by default.
8378
8379 @item -malign-300
8380 @opindex malign-300
8381 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8382 The default for the H8/300H and H8S is to align longs and floats on 4
8383 byte boundaries.
8384 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8385 This option has no effect on the H8/300.
8386 @end table
8387
8388 @node HPPA Options
8389 @subsection HPPA Options
8390 @cindex HPPA Options
8391
8392 These @samp{-m} options are defined for the HPPA family of computers:
8393
8394 @table @gcctabopt
8395 @item -march=@var{architecture-type}
8396 @opindex march
8397 Generate code for the specified architecture.  The choices for
8398 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8399 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8400 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8401 architecture option for your machine.  Code compiled for lower numbered
8402 architectures will run on higher numbered architectures, but not the
8403 other way around.
8404
8405 @item -mpa-risc-1-0
8406 @itemx -mpa-risc-1-1
8407 @itemx -mpa-risc-2-0
8408 @opindex mpa-risc-1-0
8409 @opindex mpa-risc-1-1
8410 @opindex mpa-risc-2-0
8411 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8412
8413 @item -mbig-switch
8414 @opindex mbig-switch
8415 Generate code suitable for big switch tables.  Use this option only if
8416 the assembler/linker complain about out of range branches within a switch
8417 table.
8418
8419 @item -mjump-in-delay
8420 @opindex mjump-in-delay
8421 Fill delay slots of function calls with unconditional jump instructions
8422 by modifying the return pointer for the function call to be the target
8423 of the conditional jump.
8424
8425 @item -mdisable-fpregs
8426 @opindex mdisable-fpregs
8427 Prevent floating point registers from being used in any manner.  This is
8428 necessary for compiling kernels which perform lazy context switching of
8429 floating point registers.  If you use this option and attempt to perform
8430 floating point operations, the compiler will abort.
8431
8432 @item -mdisable-indexing
8433 @opindex mdisable-indexing
8434 Prevent the compiler from using indexing address modes.  This avoids some
8435 rather obscure problems when compiling MIG generated code under MACH@.
8436
8437 @item -mno-space-regs
8438 @opindex mno-space-regs
8439 Generate code that assumes the target has no space registers.  This allows
8440 GCC to generate faster indirect calls and use unscaled index address modes.
8441
8442 Such code is suitable for level 0 PA systems and kernels.
8443
8444 @item -mfast-indirect-calls
8445 @opindex mfast-indirect-calls
8446 Generate code that assumes calls never cross space boundaries.  This
8447 allows GCC to emit code which performs faster indirect calls.
8448
8449 This option will not work in the presence of shared libraries or nested
8450 functions.
8451
8452 @item -mfixed-range=@var{register-range}
8453 @opindex mfixed-range
8454 Generate code treating the given register range as fixed registers.
8455 A fixed register is one that the register allocator can not use.  This is
8456 useful when compiling kernel code.  A register range is specified as
8457 two registers separated by a dash.  Multiple register ranges can be
8458 specified separated by a comma.
8459
8460 @item -mlong-load-store
8461 @opindex mlong-load-store
8462 Generate 3-instruction load and store sequences as sometimes required by
8463 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8464 the HP compilers.
8465
8466 @item -mportable-runtime
8467 @opindex mportable-runtime
8468 Use the portable calling conventions proposed by HP for ELF systems.
8469
8470 @item -mgas
8471 @opindex mgas
8472 Enable the use of assembler directives only GAS understands.
8473
8474 @item -mschedule=@var{cpu-type}
8475 @opindex mschedule
8476 Schedule code according to the constraints for the machine type
8477 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8478 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8479 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8480 proper scheduling option for your machine.  The default scheduling is
8481 @samp{8000}.
8482
8483 @item -mlinker-opt
8484 @opindex mlinker-opt
8485 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8486 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8487 linkers in which they give bogus error messages when linking some programs.
8488
8489 @item -msoft-float
8490 @opindex msoft-float
8491 Generate output containing library calls for floating point.
8492 @strong{Warning:} the requisite libraries are not available for all HPPA
8493 targets.  Normally the facilities of the machine's usual C compiler are
8494 used, but this cannot be done directly in cross-compilation.  You must make
8495 your own arrangements to provide suitable library functions for
8496 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8497 does provide software floating point support.
8498
8499 @option{-msoft-float} changes the calling convention in the output file;
8500 therefore, it is only useful if you compile @emph{all} of a program with
8501 this option.  In particular, you need to compile @file{libgcc.a}, the
8502 library that comes with GCC, with @option{-msoft-float} in order for
8503 this to work.
8504
8505 @item -msio
8506 @opindex msio
8507 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8508 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8509 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8510 options are available under HP-UX and HI-UX@.
8511
8512 @item -mgnu-ld
8513 @opindex gnu-ld
8514 Use GNU ld specific options.  This passes @option{-shared} to ld when
8515 building a shared library.  It is the default when GCC is configured,
8516 explicitly or implicitly, with the GNU linker.  This option does not
8517 have any affect on which ld is called, it only changes what parameters
8518 are passed to that ld.  The ld that is called is determined by the
8519 @option{--with-ld} configure option, GCC's program search path, and
8520 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8521 using @samp{which `gcc -print-prog-name=ld`}.
8522
8523 @item -mhp-ld
8524 @opindex hp-ld
8525 Use HP ld specific options.  This passes @option{-b} to ld when building
8526 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8527 links.  It is the default when GCC is configured, explicitly or
8528 implicitly, with the HP linker.  This option does not have any affect on
8529 which ld is called, it only changes what parameters are passed to that
8530 ld.  The ld that is called is determined by the @option{--with-ld}
8531 configure option, GCC's program search path, and finally by the user's
8532 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8533 `gcc -print-prog-name=ld`}.
8534
8535 @item -mlong-calls
8536 @opindex mno-long-calls
8537 Generate code that uses long call sequences.  This ensures that a call
8538 is always able to reach linker generated stubs.  The default is to generate
8539 long calls only when the distance from the call site to the beginning
8540 of the function or translation unit, as the case may be, exceeds a
8541 predefined limit set by the branch type being used.  The limits for
8542 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8543 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8544 240,000 bytes.
8545
8546 Distances are measured from the beginning of functions when using the
8547 @option{-ffunction-sections} option, or when using the @option{-mgas}
8548 and @option{-mno-portable-runtime} options together under HP-UX with
8549 the SOM linker.
8550
8551 It is normally not desirable to use this option as it will degrade
8552 performance.  However, it may be useful in large applications,
8553 particularly when partial linking is used to build the application.
8554
8555 The types of long calls used depends on the capabilities of the
8556 assembler and linker, and the type of code being generated.  The
8557 impact on systems that support long absolute calls, and long pic
8558 symbol-difference or pc-relative calls should be relatively small.
8559 However, an indirect call is used on 32-bit ELF systems in pic code
8560 and it is quite long.
8561
8562 @item -munix=@var{unix-std}
8563 @opindex march
8564 Generate compiler predefines and select a startfile for the specified
8565 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8566 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8567 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8568 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8569 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8570 and later.
8571
8572 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8573 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8574 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8575 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8576 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8577 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8578
8579 It is @emph{important} to note that this option changes the interfaces
8580 for various library routines.  It also affects the operational behavior
8581 of the C library.  Thus, @emph{extreme} care is needed in using this
8582 option.
8583
8584 Library code that is intended to operate with more than one UNIX
8585 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8586 as appropriate.  Most GNU software doesn't provide this capability.
8587
8588 @item -nolibdld
8589 @opindex nolibdld
8590 Suppress the generation of link options to search libdld.sl when the
8591 @option{-static} option is specified on HP-UX 10 and later.
8592
8593 @item -static
8594 @opindex static
8595 The HP-UX implementation of setlocale in libc has a dependency on
8596 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8597 when the @option{-static} option is specified, special link options
8598 are needed to resolve this dependency.
8599
8600 On HP-UX 10 and later, the GCC driver adds the necessary options to
8601 link with libdld.sl when the @option{-static} option is specified.
8602 This causes the resulting binary to be dynamic.  On the 64-bit port,
8603 the linkers generate dynamic binaries by default in any case.  The
8604 @option{-nolibdld} option can be used to prevent the GCC driver from
8605 adding these link options.
8606
8607 @item -threads
8608 @opindex threads
8609 Add support for multithreading with the @dfn{dce thread} library
8610 under HP-UX@.  This option sets flags for both the preprocessor and
8611 linker.
8612 @end table
8613
8614 @node i386 and x86-64 Options
8615 @subsection Intel 386 and AMD x86-64 Options
8616 @cindex i386 Options
8617 @cindex x86-64 Options
8618 @cindex Intel 386 Options
8619 @cindex AMD x86-64 Options
8620
8621 These @samp{-m} options are defined for the i386 and x86-64 family of
8622 computers:
8623
8624 @table @gcctabopt
8625 @item -mtune=@var{cpu-type}
8626 @opindex mtune
8627 Tune to @var{cpu-type} everything applicable about the generated code, except
8628 for the ABI and the set of available instructions.  The choices for
8629 @var{cpu-type} are:
8630 @table @emph
8631 @item i386
8632 Original Intel's i386 CPU@.
8633 @item i486
8634 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8635 @item i586, pentium
8636 Intel Pentium CPU with no MMX support.
8637 @item pentium-mmx
8638 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8639 @item i686, pentiumpro
8640 Intel PentiumPro CPU@.
8641 @item pentium2
8642 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8643 @item pentium3, pentium3m
8644 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8645 support.
8646 @item pentium-m
8647 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8648 support.  Used by Centrino notebooks.
8649 @item pentium4, pentium4m
8650 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8651 @item prescott
8652 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8653 set support.
8654 @item nocona
8655 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8656 SSE2 and SSE3 instruction set support.
8657 @item k6
8658 AMD K6 CPU with MMX instruction set support.
8659 @item k6-2, k6-3
8660 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8661 @item athlon, athlon-tbird
8662 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8663 support.
8664 @item athlon-4, athlon-xp, athlon-mp
8665 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8666 instruction set support.
8667 @item k8, opteron, athlon64, athlon-fx
8668 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8669 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8670 @item winchip-c6
8671 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8672 set support.
8673 @item winchip2
8674 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8675 instruction set support.
8676 @item c3
8677 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8678 implemented for this chip.)
8679 @item c3-2
8680 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8681 implemented for this chip.)
8682 @end table
8683
8684 While picking a specific @var{cpu-type} will schedule things appropriately
8685 for that particular chip, the compiler will not generate any code that
8686 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8687 being used.
8688
8689 @item -march=@var{cpu-type}
8690 @opindex march
8691 Generate instructions for the machine type @var{cpu-type}.  The choices
8692 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8693 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8694
8695 @item -mcpu=@var{cpu-type}
8696 @opindex mcpu
8697 A deprecated synonym for @option{-mtune}.
8698
8699 @item -m386
8700 @itemx -m486
8701 @itemx -mpentium
8702 @itemx -mpentiumpro
8703 @opindex m386
8704 @opindex m486
8705 @opindex mpentium
8706 @opindex mpentiumpro
8707 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8708 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8709 These synonyms are deprecated.
8710
8711 @item -mfpmath=@var{unit}
8712 @opindex march
8713 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8714 for @var{unit} are:
8715
8716 @table @samp
8717 @item 387
8718 Use the standard 387 floating point coprocessor present majority of chips and
8719 emulated otherwise.  Code compiled with this option will run almost everywhere.
8720 The temporary results are computed in 80bit precision instead of precision
8721 specified by the type resulting in slightly different results compared to most
8722 of other chips.  See @option{-ffloat-store} for more detailed description.
8723
8724 This is the default choice for i386 compiler.
8725
8726 @item sse
8727 Use scalar floating point instructions present in the SSE instruction set.
8728 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8729 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8730 instruction set supports only single precision arithmetics, thus the double and
8731 extended precision arithmetics is still done using 387.  Later version, present
8732 only in Pentium4 and the future AMD x86-64 chips supports double precision
8733 arithmetics too.
8734
8735 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8736 or @option{-msse2} switches to enable SSE extensions and make this option
8737 effective.  For the x86-64 compiler, these extensions are enabled by default.
8738
8739 The resulting code should be considerably faster in the majority of cases and avoid
8740 the numerical instability problems of 387 code, but may break some existing
8741 code that expects temporaries to be 80bit.
8742
8743 This is the default choice for the x86-64 compiler.
8744
8745 @item sse,387
8746 Attempt to utilize both instruction sets at once.  This effectively double the
8747 amount of available registers and on chips with separate execution units for
8748 387 and SSE the execution resources too.  Use this option with care, as it is
8749 still experimental, because the GCC register allocator does not model separate
8750 functional units well resulting in instable performance.
8751 @end table
8752
8753 @item -masm=@var{dialect}
8754 @opindex masm=@var{dialect}
8755 Output asm instructions using selected @var{dialect}.  Supported choices are
8756 @samp{intel} or @samp{att} (the default one).
8757
8758 @item -mieee-fp
8759 @itemx -mno-ieee-fp
8760 @opindex mieee-fp
8761 @opindex mno-ieee-fp
8762 Control whether or not the compiler uses IEEE floating point
8763 comparisons.  These handle correctly the case where the result of a
8764 comparison is unordered.
8765
8766 @item -msoft-float
8767 @opindex msoft-float
8768 Generate output containing library calls for floating point.
8769 @strong{Warning:} the requisite libraries are not part of GCC@.
8770 Normally the facilities of the machine's usual C compiler are used, but
8771 this can't be done directly in cross-compilation.  You must make your
8772 own arrangements to provide suitable library functions for
8773 cross-compilation.
8774
8775 On machines where a function returns floating point results in the 80387
8776 register stack, some floating point opcodes may be emitted even if
8777 @option{-msoft-float} is used.
8778
8779 @item -mno-fp-ret-in-387
8780 @opindex mno-fp-ret-in-387
8781 Do not use the FPU registers for return values of functions.
8782
8783 The usual calling convention has functions return values of types
8784 @code{float} and @code{double} in an FPU register, even if there
8785 is no FPU@.  The idea is that the operating system should emulate
8786 an FPU@.
8787
8788 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8789 in ordinary CPU registers instead.
8790
8791 @item -mno-fancy-math-387
8792 @opindex mno-fancy-math-387
8793 Some 387 emulators do not support the @code{sin}, @code{cos} and
8794 @code{sqrt} instructions for the 387.  Specify this option to avoid
8795 generating those instructions.  This option is the default on FreeBSD,
8796 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8797 indicates that the target cpu will always have an FPU and so the
8798 instruction will not need emulation.  As of revision 2.6.1, these
8799 instructions are not generated unless you also use the
8800 @option{-funsafe-math-optimizations} switch.
8801
8802 @item -malign-double
8803 @itemx -mno-align-double
8804 @opindex malign-double
8805 @opindex mno-align-double
8806 Control whether GCC aligns @code{double}, @code{long double}, and
8807 @code{long long} variables on a two word boundary or a one word
8808 boundary.  Aligning @code{double} variables on a two word boundary will
8809 produce code that runs somewhat faster on a @samp{Pentium} at the
8810 expense of more memory.
8811
8812 @strong{Warning:} if you use the @option{-malign-double} switch,
8813 structures containing the above types will be aligned differently than
8814 the published application binary interface specifications for the 386
8815 and will not be binary compatible with structures in code compiled
8816 without that switch.
8817
8818 @item -m96bit-long-double
8819 @itemx -m128bit-long-double
8820 @opindex m96bit-long-double
8821 @opindex m128bit-long-double
8822 These switches control the size of @code{long double} type.  The i386
8823 application binary interface specifies the size to be 96 bits,
8824 so @option{-m96bit-long-double} is the default in 32 bit mode.
8825
8826 Modern architectures (Pentium and newer) would prefer @code{long double}
8827 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8828 conforming to the ABI, this would not be possible.  So specifying a
8829 @option{-m128bit-long-double} will align @code{long double}
8830 to a 16 byte boundary by padding the @code{long double} with an additional
8831 32 bit zero.
8832
8833 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8834 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8835
8836 Notice that neither of these options enable any extra precision over the x87
8837 standard of 80 bits for a @code{long double}.
8838
8839 @strong{Warning:} if you override the default value for your target ABI, the
8840 structures and arrays containing @code{long double} variables will change
8841 their size as well as function calling convention for function taking
8842 @code{long double} will be modified.  Hence they will not be binary
8843 compatible with arrays or structures in code compiled without that switch.
8844
8845
8846 @item -msvr3-shlib
8847 @itemx -mno-svr3-shlib
8848 @opindex msvr3-shlib
8849 @opindex mno-svr3-shlib
8850 Control whether GCC places uninitialized local variables into the
8851 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8852 into @code{bss}.  These options are meaningful only on System V Release 3.
8853
8854 @item -mrtd
8855 @opindex mrtd
8856 Use a different function-calling convention, in which functions that
8857 take a fixed number of arguments return with the @code{ret} @var{num}
8858 instruction, which pops their arguments while returning.  This saves one
8859 instruction in the caller since there is no need to pop the arguments
8860 there.
8861
8862 You can specify that an individual function is called with this calling
8863 sequence with the function attribute @samp{stdcall}.  You can also
8864 override the @option{-mrtd} option by using the function attribute
8865 @samp{cdecl}.  @xref{Function Attributes}.
8866
8867 @strong{Warning:} this calling convention is incompatible with the one
8868 normally used on Unix, so you cannot use it if you need to call
8869 libraries compiled with the Unix compiler.
8870
8871 Also, you must provide function prototypes for all functions that
8872 take variable numbers of arguments (including @code{printf});
8873 otherwise incorrect code will be generated for calls to those
8874 functions.
8875
8876 In addition, seriously incorrect code will result if you call a
8877 function with too many arguments.  (Normally, extra arguments are
8878 harmlessly ignored.)
8879
8880 @item -mregparm=@var{num}
8881 @opindex mregparm
8882 Control how many registers are used to pass integer arguments.  By
8883 default, no registers are used to pass arguments, and at most 3
8884 registers can be used.  You can control this behavior for a specific
8885 function by using the function attribute @samp{regparm}.
8886 @xref{Function Attributes}.
8887
8888 @strong{Warning:} if you use this switch, and
8889 @var{num} is nonzero, then you must build all modules with the same
8890 value, including any libraries.  This includes the system libraries and
8891 startup modules.
8892
8893 @item -mpreferred-stack-boundary=@var{num}
8894 @opindex mpreferred-stack-boundary
8895 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8896 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8897 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8898 size (@option{-Os}), in which case the default is the minimum correct
8899 alignment (4 bytes for x86, and 8 bytes for x86-64).
8900
8901 On Pentium and PentiumPro, @code{double} and @code{long double} values
8902 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8903 suffer significant run time performance penalties.  On Pentium III, the
8904 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8905 penalties if it is not 16 byte aligned.
8906
8907 To ensure proper alignment of this values on the stack, the stack boundary
8908 must be as aligned as that required by any value stored on the stack.
8909 Further, every function must be generated such that it keeps the stack
8910 aligned.  Thus calling a function compiled with a higher preferred
8911 stack boundary from a function compiled with a lower preferred stack
8912 boundary will most likely misalign the stack.  It is recommended that
8913 libraries that use callbacks always use the default setting.
8914
8915 This extra alignment does consume extra stack space, and generally
8916 increases code size.  Code that is sensitive to stack space usage, such
8917 as embedded systems and operating system kernels, may want to reduce the
8918 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8919
8920 @item -mmmx
8921 @itemx -mno-mmx
8922 @item -msse
8923 @itemx -mno-sse
8924 @item -msse2
8925 @itemx -mno-sse2
8926 @item -msse3
8927 @itemx -mno-sse3
8928 @item -m3dnow
8929 @itemx -mno-3dnow
8930 @opindex mmmx
8931 @opindex mno-mmx
8932 @opindex msse
8933 @opindex mno-sse
8934 @opindex m3dnow
8935 @opindex mno-3dnow
8936 These switches enable or disable the use of built-in functions that allow
8937 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8938 instruction set.
8939
8940 @xref{X86 Built-in Functions}, for details of the functions enabled
8941 and disabled by these switches.
8942
8943 To have SSE/SSE2 instructions generated automatically from floating-point
8944 code, see @option{-mfpmath=sse}.
8945
8946 @item -mpush-args
8947 @itemx -mno-push-args
8948 @opindex mpush-args
8949 @opindex mno-push-args
8950 Use PUSH operations to store outgoing parameters.  This method is shorter
8951 and usually equally fast as method using SUB/MOV operations and is enabled
8952 by default.  In some cases disabling it may improve performance because of
8953 improved scheduling and reduced dependencies.
8954
8955 @item -maccumulate-outgoing-args
8956 @opindex maccumulate-outgoing-args
8957 If enabled, the maximum amount of space required for outgoing arguments will be
8958 computed in the function prologue.  This is faster on most modern CPUs
8959 because of reduced dependencies, improved scheduling and reduced stack usage
8960 when preferred stack boundary is not equal to 2.  The drawback is a notable
8961 increase in code size.  This switch implies @option{-mno-push-args}.
8962
8963 @item -mthreads
8964 @opindex mthreads
8965 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8966 on thread-safe exception handling must compile and link all code with the
8967 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8968 @option{-D_MT}; when linking, it links in a special thread helper library
8969 @option{-lmingwthrd} which cleans up per thread exception handling data.
8970
8971 @item -mno-align-stringops
8972 @opindex mno-align-stringops
8973 Do not align destination of inlined string operations.  This switch reduces
8974 code size and improves performance in case the destination is already aligned,
8975 but GCC doesn't know about it.
8976
8977 @item -minline-all-stringops
8978 @opindex minline-all-stringops
8979 By default GCC inlines string operations only when destination is known to be
8980 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8981 size, but may improve performance of code that depends on fast memcpy, strlen
8982 and memset for short lengths.
8983
8984 @item -momit-leaf-frame-pointer
8985 @opindex momit-leaf-frame-pointer
8986 Don't keep the frame pointer in a register for leaf functions.  This
8987 avoids the instructions to save, set up and restore frame pointers and
8988 makes an extra register available in leaf functions.  The option
8989 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8990 which might make debugging harder.
8991
8992 @item -mtls-direct-seg-refs
8993 @itemx -mno-tls-direct-seg-refs
8994 @opindex mtls-direct-seg-refs
8995 Controls whether TLS variables may be accessed with offsets from the
8996 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8997 or whether the thread base pointer must be added.  Whether or not this
8998 is legal depends on the operating system, and whether it maps the
8999 segment to cover the entire TLS area.
9000
9001 For systems that use GNU libc, the default is on.
9002 @end table
9003
9004 These @samp{-m} switches are supported in addition to the above
9005 on AMD x86-64 processors in 64-bit environments.
9006
9007 @table @gcctabopt
9008 @item -m32
9009 @itemx -m64
9010 @opindex m32
9011 @opindex m64
9012 Generate code for a 32-bit or 64-bit environment.
9013 The 32-bit environment sets int, long and pointer to 32 bits and
9014 generates code that runs on any i386 system.
9015 The 64-bit environment sets int to 32 bits and long and pointer
9016 to 64 bits and generates code for AMD's x86-64 architecture.
9017
9018 @item -mno-red-zone
9019 @opindex no-red-zone
9020 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9021 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9022 stack pointer that will not be modified by signal or interrupt handlers
9023 and therefore can be used for temporary data without adjusting the stack
9024 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9025
9026 @item -mcmodel=small
9027 @opindex mcmodel=small
9028 Generate code for the small code model: the program and its symbols must
9029 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9030 Programs can be statically or dynamically linked.  This is the default
9031 code model.
9032
9033 @item -mcmodel=kernel
9034 @opindex mcmodel=kernel
9035 Generate code for the kernel code model.  The kernel runs in the
9036 negative 2 GB of the address space.
9037 This model has to be used for Linux kernel code.
9038
9039 @item -mcmodel=medium
9040 @opindex mcmodel=medium
9041 Generate code for the medium model: The program is linked in the lower 2
9042 GB of the address space but symbols can be located anywhere in the
9043 address space.  Programs can be statically or dynamically linked, but
9044 building of shared libraries are not supported with the medium model.
9045
9046 @item -mcmodel=large
9047 @opindex mcmodel=large
9048 Generate code for the large model: This model makes no assumptions
9049 about addresses and sizes of sections.  Currently GCC does not implement
9050 this model.
9051 @end table
9052
9053 @node IA-64 Options
9054 @subsection IA-64 Options
9055 @cindex IA-64 Options
9056
9057 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9058
9059 @table @gcctabopt
9060 @item -mbig-endian
9061 @opindex mbig-endian
9062 Generate code for a big endian target.  This is the default for HP-UX@.
9063
9064 @item -mlittle-endian
9065 @opindex mlittle-endian
9066 Generate code for a little endian target.  This is the default for AIX5
9067 and GNU/Linux.
9068
9069 @item -mgnu-as
9070 @itemx -mno-gnu-as
9071 @opindex mgnu-as
9072 @opindex mno-gnu-as
9073 Generate (or don't) code for the GNU assembler.  This is the default.
9074 @c Also, this is the default if the configure option @option{--with-gnu-as}
9075 @c is used.
9076
9077 @item -mgnu-ld
9078 @itemx -mno-gnu-ld
9079 @opindex mgnu-ld
9080 @opindex mno-gnu-ld
9081 Generate (or don't) code for the GNU linker.  This is the default.
9082 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9083 @c is used.
9084
9085 @item -mno-pic
9086 @opindex mno-pic
9087 Generate code that does not use a global pointer register.  The result
9088 is not position independent code, and violates the IA-64 ABI@.
9089
9090 @item -mvolatile-asm-stop
9091 @itemx -mno-volatile-asm-stop
9092 @opindex mvolatile-asm-stop
9093 @opindex mno-volatile-asm-stop
9094 Generate (or don't) a stop bit immediately before and after volatile asm
9095 statements.
9096
9097 @item -mregister-names
9098 @itemx -mno-register-names
9099 @opindex mregister-names
9100 @opindex mno-register-names
9101 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9102 the stacked registers.  This may make assembler output more readable.
9103
9104 @item -mno-sdata
9105 @itemx -msdata
9106 @opindex mno-sdata
9107 @opindex msdata
9108 Disable (or enable) optimizations that use the small data section.  This may
9109 be useful for working around optimizer bugs.
9110
9111 @item -mconstant-gp
9112 @opindex mconstant-gp
9113 Generate code that uses a single constant global pointer value.  This is
9114 useful when compiling kernel code.
9115
9116 @item -mauto-pic
9117 @opindex mauto-pic
9118 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9119 This is useful when compiling firmware code.
9120
9121 @item -minline-float-divide-min-latency
9122 @opindex minline-float-divide-min-latency
9123 Generate code for inline divides of floating point values
9124 using the minimum latency algorithm.
9125
9126 @item -minline-float-divide-max-throughput
9127 @opindex minline-float-divide-max-throughput
9128 Generate code for inline divides of floating point values
9129 using the maximum throughput algorithm.
9130
9131 @item -minline-int-divide-min-latency
9132 @opindex minline-int-divide-min-latency
9133 Generate code for inline divides of integer values
9134 using the minimum latency algorithm.
9135
9136 @item -minline-int-divide-max-throughput
9137 @opindex minline-int-divide-max-throughput
9138 Generate code for inline divides of integer values
9139 using the maximum throughput algorithm.
9140
9141 @item -minline-sqrt-min-latency
9142 @opindex minline-sqrt-min-latency
9143 Generate code for inline square roots
9144 using the minimum latency algorithm.
9145
9146 @item -minline-sqrt-max-throughput
9147 @opindex minline-sqrt-max-throughput
9148 Generate code for inline square roots
9149 using the maximum throughput algorithm.
9150
9151 @item -mno-dwarf2-asm
9152 @itemx -mdwarf2-asm
9153 @opindex mno-dwarf2-asm
9154 @opindex mdwarf2-asm
9155 Don't (or do) generate assembler code for the DWARF2 line number debugging
9156 info.  This may be useful when not using the GNU assembler.
9157
9158 @item -mearly-stop-bits
9159 @itemx -mno-early-stop-bits
9160 @opindex mearly-stop-bits
9161 @opindex mno-early-stop-bits
9162 Allow stop bits to be placed earlier than immediately preceding the
9163 instruction that triggered the stop bit.  This can improve instruction
9164 scheduling, but does not always do so.
9165
9166 @item -mfixed-range=@var{register-range}
9167 @opindex mfixed-range
9168 Generate code treating the given register range as fixed registers.
9169 A fixed register is one that the register allocator can not use.  This is
9170 useful when compiling kernel code.  A register range is specified as
9171 two registers separated by a dash.  Multiple register ranges can be
9172 specified separated by a comma.
9173
9174 @item -mtls-size=@var{tls-size}
9175 @opindex mtls-size
9176 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9177 64.
9178
9179 @item -mtune-arch=@var{cpu-type}
9180 @opindex mtune-arch
9181 Tune the instruction scheduling for a particular CPU, Valid values are
9182 itanium, itanium1, merced, itanium2, and mckinley.
9183
9184 @item -mt
9185 @itemx -pthread
9186 @opindex mt
9187 @opindex pthread
9188 Add support for multithreading using the POSIX threads library.  This
9189 option sets flags for both the preprocessor and linker.  It does
9190 not affect the thread safety of object code produced by the compiler or
9191 that of libraries supplied with it.  These are HP-UX specific flags.
9192
9193 @item -milp32
9194 @itemx -mlp64
9195 @opindex milp32
9196 @opindex mlp64
9197 Generate code for a 32-bit or 64-bit environment.
9198 The 32-bit environment sets int, long and pointer to 32 bits.
9199 The 64-bit environment sets int to 32 bits and long and pointer
9200 to 64 bits.  These are HP-UX specific flags.
9201
9202 @end table
9203
9204 @node M32R/D Options
9205 @subsection M32R/D Options
9206 @cindex M32R/D options
9207
9208 These @option{-m} options are defined for Renesas M32R/D architectures:
9209
9210 @table @gcctabopt
9211 @item -m32r2
9212 @opindex m32r2
9213 Generate code for the M32R/2@.
9214
9215 @item -m32rx
9216 @opindex m32rx
9217 Generate code for the M32R/X@.
9218
9219 @item -m32r
9220 @opindex m32r
9221 Generate code for the M32R@.  This is the default.
9222
9223 @item -mmodel=small
9224 @opindex mmodel=small
9225 Assume all objects live in the lower 16MB of memory (so that their addresses
9226 can be loaded with the @code{ld24} instruction), and assume all subroutines
9227 are reachable with the @code{bl} instruction.
9228 This is the default.
9229
9230 The addressability of a particular object can be set with the
9231 @code{model} attribute.
9232
9233 @item -mmodel=medium
9234 @opindex mmodel=medium
9235 Assume objects may be anywhere in the 32-bit address space (the compiler
9236 will generate @code{seth/add3} instructions to load their addresses), and
9237 assume all subroutines are reachable with the @code{bl} instruction.
9238
9239 @item -mmodel=large
9240 @opindex mmodel=large
9241 Assume objects may be anywhere in the 32-bit address space (the compiler
9242 will generate @code{seth/add3} instructions to load their addresses), and
9243 assume subroutines may not be reachable with the @code{bl} instruction
9244 (the compiler will generate the much slower @code{seth/add3/jl}
9245 instruction sequence).
9246
9247 @item -msdata=none
9248 @opindex msdata=none
9249 Disable use of the small data area.  Variables will be put into
9250 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9251 @code{section} attribute has been specified).
9252 This is the default.
9253
9254 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9255 Objects may be explicitly put in the small data area with the
9256 @code{section} attribute using one of these sections.
9257
9258 @item -msdata=sdata
9259 @opindex msdata=sdata
9260 Put small global and static data in the small data area, but do not
9261 generate special code to reference them.
9262
9263 @item -msdata=use
9264 @opindex msdata=use
9265 Put small global and static data in the small data area, and generate
9266 special instructions to reference them.
9267
9268 @item -G @var{num}
9269 @opindex G
9270 @cindex smaller data references
9271 Put global and static objects less than or equal to @var{num} bytes
9272 into the small data or bss sections instead of the normal data or bss
9273 sections.  The default value of @var{num} is 8.
9274 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9275 for this option to have any effect.
9276
9277 All modules should be compiled with the same @option{-G @var{num}} value.
9278 Compiling with different values of @var{num} may or may not work; if it
9279 doesn't the linker will give an error message---incorrect code will not be
9280 generated.
9281
9282 @item -mdebug
9283 @opindex mdebug
9284 Makes the M32R specific code in the compiler display some statistics
9285 that might help in debugging programs.
9286
9287 @item -malign-loops
9288 @opindex malign-loops
9289 Align all loops to a 32-byte boundary.
9290
9291 @item -mno-align-loops
9292 @opindex mno-align-loops
9293 Do not enforce a 32-byte alignment for loops.  This is the default.
9294
9295 @item -missue-rate=@var{number}
9296 @opindex missue-rate=@var{number}
9297 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9298 or 2.
9299
9300 @item -mbranch-cost=@var{number}
9301 @opindex mbranch-cost=@var{number}
9302 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9303 preferred over conditional code, if it is 2, then the opposite will
9304 apply.
9305
9306 @item -mflush-trap=@var{number}
9307 @opindex mflush-trap=@var{number}
9308 Specifies the trap number to use to flush the cache.  The default is
9309 12.  Valid numbers are between 0 and 15 inclusive.
9310
9311 @item -mno-flush-trap
9312 @opindex mno-flush-trap
9313 Specifies that the cache cannot be flushed by using a trap.
9314
9315 @item -mflush-func=@var{name}
9316 @opindex mflush-func=@var{name}
9317 Specifies the name of the operating system function to call to flush
9318 the cache.  The default is @emph{_flush_cache}, but a function call
9319 will only be used if a trap is not available.
9320
9321 @item -mno-flush-func
9322 @opindex mno-flush-func
9323 Indicates that there is no OS function for flushing the cache.
9324
9325 @end table
9326
9327 @node M680x0 Options
9328 @subsection M680x0 Options
9329 @cindex M680x0 options
9330
9331 These are the @samp{-m} options defined for the 68000 series.  The default
9332 values for these options depends on which style of 68000 was selected when
9333 the compiler was configured; the defaults for the most common choices are
9334 given below.
9335
9336 @table @gcctabopt
9337 @item -m68000
9338 @itemx -mc68000
9339 @opindex m68000
9340 @opindex mc68000
9341 Generate output for a 68000.  This is the default
9342 when the compiler is configured for 68000-based systems.
9343
9344 Use this option for microcontrollers with a 68000 or EC000 core,
9345 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9346
9347 @item -m68020
9348 @itemx -mc68020
9349 @opindex m68020
9350 @opindex mc68020
9351 Generate output for a 68020.  This is the default
9352 when the compiler is configured for 68020-based systems.
9353
9354 @item -m68881
9355 @opindex m68881
9356 Generate output containing 68881 instructions for floating point.
9357 This is the default for most 68020 systems unless @option{--nfp} was
9358 specified when the compiler was configured.
9359
9360 @item -m68030
9361 @opindex m68030
9362 Generate output for a 68030.  This is the default when the compiler is
9363 configured for 68030-based systems.
9364
9365 @item -m68040
9366 @opindex m68040
9367 Generate output for a 68040.  This is the default when the compiler is
9368 configured for 68040-based systems.
9369
9370 This option inhibits the use of 68881/68882 instructions that have to be
9371 emulated by software on the 68040.  Use this option if your 68040 does not
9372 have code to emulate those instructions.
9373
9374 @item -m68060
9375 @opindex m68060
9376 Generate output for a 68060.  This is the default when the compiler is
9377 configured for 68060-based systems.
9378
9379 This option inhibits the use of 68020 and 68881/68882 instructions that
9380 have to be emulated by software on the 68060.  Use this option if your 68060
9381 does not have code to emulate those instructions.
9382
9383 @item -mcpu32
9384 @opindex mcpu32
9385 Generate output for a CPU32.  This is the default
9386 when the compiler is configured for CPU32-based systems.
9387
9388 Use this option for microcontrollers with a
9389 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9390 68336, 68340, 68341, 68349 and 68360.
9391
9392 @item -m5200
9393 @opindex m5200
9394 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9395 when the compiler is configured for 520X-based systems.
9396
9397 Use this option for microcontroller with a 5200 core, including
9398 the MCF5202, MCF5203, MCF5204 and MCF5202.
9399
9400
9401 @item -m68020-40
9402 @opindex m68020-40
9403 Generate output for a 68040, without using any of the new instructions.
9404 This results in code which can run relatively efficiently on either a
9405 68020/68881 or a 68030 or a 68040.  The generated code does use the
9406 68881 instructions that are emulated on the 68040.
9407
9408 @item -m68020-60
9409 @opindex m68020-60
9410 Generate output for a 68060, without using any of the new instructions.
9411 This results in code which can run relatively efficiently on either a
9412 68020/68881 or a 68030 or a 68040.  The generated code does use the
9413 68881 instructions that are emulated on the 68060.
9414
9415 @item -msoft-float
9416 @opindex msoft-float
9417 Generate output containing library calls for floating point.
9418 @strong{Warning:} the requisite libraries are not available for all m68k
9419 targets.  Normally the facilities of the machine's usual C compiler are
9420 used, but this can't be done directly in cross-compilation.  You must
9421 make your own arrangements to provide suitable library functions for
9422 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9423 @samp{m68k-*-coff} do provide software floating point support.
9424
9425 @item -mshort
9426 @opindex mshort
9427 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9428 Additionally, parameters passed on the stack are also aligned to a
9429 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9430
9431 @item -mnobitfield
9432 @opindex mnobitfield
9433 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9434 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9435
9436 @item -mbitfield
9437 @opindex mbitfield
9438 Do use the bit-field instructions.  The @option{-m68020} option implies
9439 @option{-mbitfield}.  This is the default if you use a configuration
9440 designed for a 68020.
9441
9442 @item -mrtd
9443 @opindex mrtd
9444 Use a different function-calling convention, in which functions
9445 that take a fixed number of arguments return with the @code{rtd}
9446 instruction, which pops their arguments while returning.  This
9447 saves one instruction in the caller since there is no need to pop
9448 the arguments there.
9449
9450 This calling convention is incompatible with the one normally
9451 used on Unix, so you cannot use it if you need to call libraries
9452 compiled with the Unix compiler.
9453
9454 Also, you must provide function prototypes for all functions that
9455 take variable numbers of arguments (including @code{printf});
9456 otherwise incorrect code will be generated for calls to those
9457 functions.
9458
9459 In addition, seriously incorrect code will result if you call a
9460 function with too many arguments.  (Normally, extra arguments are
9461 harmlessly ignored.)
9462
9463 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9464 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9465
9466 @item -malign-int
9467 @itemx -mno-align-int
9468 @opindex malign-int
9469 @opindex mno-align-int
9470 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9471 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9472 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9473 Aligning variables on 32-bit boundaries produces code that runs somewhat
9474 faster on processors with 32-bit busses at the expense of more memory.
9475
9476 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9477 align structures containing the above types  differently than
9478 most published application binary interface specifications for the m68k.
9479
9480 @item -mpcrel
9481 @opindex mpcrel
9482 Use the pc-relative addressing mode of the 68000 directly, instead of
9483 using a global offset table.  At present, this option implies @option{-fpic},
9484 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9485 not presently supported with @option{-mpcrel}, though this could be supported for
9486 68020 and higher processors.
9487
9488 @item -mno-strict-align
9489 @itemx -mstrict-align
9490 @opindex mno-strict-align
9491 @opindex mstrict-align
9492 Do not (do) assume that unaligned memory references will be handled by
9493 the system.
9494
9495 @item -msep-data
9496 Generate code that allows the data segment to be located in a different
9497 area of memory from the text segment.  This allows for execute in place in
9498 an environment without virtual memory management.  This option implies
9499 @option{-fPIC}.
9500
9501 @item -mno-sep-data
9502 Generate code that assumes that the data segment follows the text segment.
9503 This is the default.
9504
9505 @item -mid-shared-library
9506 Generate code that supports shared libraries via the library ID method.
9507 This allows for execute in place and shared libraries in an environment
9508 without virtual memory management.  This option implies @option{-fPIC}.
9509
9510 @item -mno-id-shared-library
9511 Generate code that doesn't assume ID based shared libraries are being used.
9512 This is the default.
9513
9514 @item -mshared-library-id=n
9515 Specified the identification number of the ID based shared library being
9516 compiled.  Specifying a value of 0 will generate more compact code, specifying
9517 other values will force the allocation of that number to the current
9518 library but is no more space or time efficient than omitting this option.
9519
9520 @end table
9521
9522 @node M68hc1x Options
9523 @subsection M68hc1x Options
9524 @cindex M68hc1x options
9525
9526 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9527 microcontrollers.  The default values for these options depends on
9528 which style of microcontroller was selected when the compiler was configured;
9529 the defaults for the most common choices are given below.
9530
9531 @table @gcctabopt
9532 @item -m6811
9533 @itemx -m68hc11
9534 @opindex m6811
9535 @opindex m68hc11
9536 Generate output for a 68HC11.  This is the default
9537 when the compiler is configured for 68HC11-based systems.
9538
9539 @item -m6812
9540 @itemx -m68hc12
9541 @opindex m6812
9542 @opindex m68hc12
9543 Generate output for a 68HC12.  This is the default
9544 when the compiler is configured for 68HC12-based systems.
9545
9546 @item -m68S12
9547 @itemx -m68hcs12
9548 @opindex m68S12
9549 @opindex m68hcs12
9550 Generate output for a 68HCS12.
9551
9552 @item -mauto-incdec
9553 @opindex mauto-incdec
9554 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9555 addressing modes.
9556
9557 @item -minmax
9558 @itemx -nominmax
9559 @opindex minmax
9560 @opindex mnominmax
9561 Enable the use of 68HC12 min and max instructions.
9562
9563 @item -mlong-calls
9564 @itemx -mno-long-calls
9565 @opindex mlong-calls
9566 @opindex mno-long-calls
9567 Treat all calls as being far away (near).  If calls are assumed to be
9568 far away, the compiler will use the @code{call} instruction to
9569 call a function and the @code{rtc} instruction for returning.
9570
9571 @item -mshort
9572 @opindex mshort
9573 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9574
9575 @item -msoft-reg-count=@var{count}
9576 @opindex msoft-reg-count
9577 Specify the number of pseudo-soft registers which are used for the
9578 code generation.  The maximum number is 32.  Using more pseudo-soft
9579 register may or may not result in better code depending on the program.
9580 The default is 4 for 68HC11 and 2 for 68HC12.
9581
9582 @end table
9583
9584 @node MCore Options
9585 @subsection MCore Options
9586 @cindex MCore options
9587
9588 These are the @samp{-m} options defined for the Motorola M*Core
9589 processors.
9590
9591 @table @gcctabopt
9592
9593 @item -mhardlit
9594 @itemx -mno-hardlit
9595 @opindex mhardlit
9596 @opindex mno-hardlit
9597 Inline constants into the code stream if it can be done in two
9598 instructions or less.
9599
9600 @item -mdiv
9601 @itemx -mno-div
9602 @opindex mdiv
9603 @opindex mno-div
9604 Use the divide instruction.  (Enabled by default).
9605
9606 @item -mrelax-immediate
9607 @itemx -mno-relax-immediate
9608 @opindex mrelax-immediate
9609 @opindex mno-relax-immediate
9610 Allow arbitrary sized immediates in bit operations.
9611
9612 @item -mwide-bitfields
9613 @itemx -mno-wide-bitfields
9614 @opindex mwide-bitfields
9615 @opindex mno-wide-bitfields
9616 Always treat bit-fields as int-sized.
9617
9618 @item -m4byte-functions
9619 @itemx -mno-4byte-functions
9620 @opindex m4byte-functions
9621 @opindex mno-4byte-functions
9622 Force all functions to be aligned to a four byte boundary.
9623
9624 @item -mcallgraph-data
9625 @itemx -mno-callgraph-data
9626 @opindex mcallgraph-data
9627 @opindex mno-callgraph-data
9628 Emit callgraph information.
9629
9630 @item -mslow-bytes
9631 @itemx -mno-slow-bytes
9632 @opindex mslow-bytes
9633 @opindex mno-slow-bytes
9634 Prefer word access when reading byte quantities.
9635
9636 @item -mlittle-endian
9637 @itemx -mbig-endian
9638 @opindex mlittle-endian
9639 @opindex mbig-endian
9640 Generate code for a little endian target.
9641
9642 @item -m210
9643 @itemx -m340
9644 @opindex m210
9645 @opindex m340
9646 Generate code for the 210 processor.
9647 @end table
9648
9649 @node MIPS Options
9650 @subsection MIPS Options
9651 @cindex MIPS options
9652
9653 @table @gcctabopt
9654
9655 @item -EB
9656 @opindex EB
9657 Generate big-endian code.
9658
9659 @item -EL
9660 @opindex EL
9661 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9662 configurations.
9663
9664 @item -march=@var{arch}
9665 @opindex march
9666 Generate code that will run on @var{arch}, which can be the name of a
9667 generic MIPS ISA, or the name of a particular processor.
9668 The ISA names are:
9669 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9670 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9671 The processor names are:
9672 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9673 @samp{m4k},
9674 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9675 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9676 @samp{rm9000},
9677 @samp{orion},
9678 @samp{sb1},
9679 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9680 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9681 The special value @samp{from-abi} selects the
9682 most compatible architecture for the selected ABI (that is,
9683 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9684
9685 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9686 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9687 @samp{vr} may be written @samp{r}.
9688
9689 GCC defines two macros based on the value of this option.  The first
9690 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9691 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9692 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9693 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9694 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9695
9696 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9697 above.  In other words, it will have the full prefix and will not
9698 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9699 the macro names the resolved architecture (either @samp{"mips1"} or
9700 @samp{"mips3"}).  It names the default architecture when no
9701 @option{-march} option is given.
9702
9703 @item -mtune=@var{arch}
9704 @opindex mtune
9705 Optimize for @var{arch}.  Among other things, this option controls
9706 the way instructions are scheduled, and the perceived cost of arithmetic
9707 operations.  The list of @var{arch} values is the same as for
9708 @option{-march}.
9709
9710 When this option is not used, GCC will optimize for the processor
9711 specified by @option{-march}.  By using @option{-march} and
9712 @option{-mtune} together, it is possible to generate code that will
9713 run on a family of processors, but optimize the code for one
9714 particular member of that family.
9715
9716 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9717 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9718 @samp{-march} ones described above.
9719
9720 @item -mips1
9721 @opindex mips1
9722 Equivalent to @samp{-march=mips1}.
9723
9724 @item -mips2
9725 @opindex mips2
9726 Equivalent to @samp{-march=mips2}.
9727
9728 @item -mips3
9729 @opindex mips3
9730 Equivalent to @samp{-march=mips3}.
9731
9732 @item -mips4
9733 @opindex mips4
9734 Equivalent to @samp{-march=mips4}.
9735
9736 @item -mips32
9737 @opindex mips32
9738 Equivalent to @samp{-march=mips32}.
9739
9740 @item -mips32r2
9741 @opindex mips32r2
9742 Equivalent to @samp{-march=mips32r2}.
9743
9744 @item -mips64
9745 @opindex mips64
9746 Equivalent to @samp{-march=mips64}.
9747
9748 @item -mips16
9749 @itemx -mno-mips16
9750 @opindex mips16
9751 @opindex mno-mips16
9752 Use (do not use) the MIPS16 ISA@.
9753
9754 @item -mabi=32
9755 @itemx -mabi=o64
9756 @itemx -mabi=n32
9757 @itemx -mabi=64
9758 @itemx -mabi=eabi
9759 @opindex mabi=32
9760 @opindex mabi=o64
9761 @opindex mabi=n32
9762 @opindex mabi=64
9763 @opindex mabi=eabi
9764 Generate code for the given ABI@.
9765
9766 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9767 generates 64-bit code when you select a 64-bit architecture, but you
9768 can use @option{-mgp32} to get 32-bit code instead.
9769
9770 For information about the O64 ABI, see
9771 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9772
9773 @item -mabicalls
9774 @itemx -mno-abicalls
9775 @opindex mabicalls
9776 @opindex mno-abicalls
9777 Generate (do not generate) SVR4-style position-independent code.
9778 @option{-mabicalls} is the default for SVR4-based systems.
9779
9780 @item -mxgot
9781 @itemx -mno-xgot
9782 @opindex mxgot
9783 @opindex mno-xgot
9784 Lift (do not lift) the usual restrictions on the size of the global
9785 offset table.
9786
9787 GCC normally uses a single instruction to load values from the GOT@.
9788 While this is relatively efficient, it will only work if the GOT
9789 is smaller than about 64k.  Anything larger will cause the linker
9790 to report an error such as:
9791
9792 @cindex relocation truncated to fit (MIPS)
9793 @smallexample
9794 relocation truncated to fit: R_MIPS_GOT16 foobar
9795 @end smallexample
9796
9797 If this happens, you should recompile your code with @option{-mxgot}.
9798 It should then work with very large GOTs, although it will also be
9799 less efficient, since it will take three instructions to fetch the
9800 value of a global symbol.
9801
9802 Note that some linkers can create multiple GOTs.  If you have such a
9803 linker, you should only need to use @option{-mxgot} when a single object
9804 file accesses more than 64k's worth of GOT entries.  Very few do.
9805
9806 These options have no effect unless GCC is generating position
9807 independent code.
9808
9809 @item -mgp32
9810 @opindex mgp32
9811 Assume that general-purpose registers are 32 bits wide.
9812
9813 @item -mgp64
9814 @opindex mgp64
9815 Assume that general-purpose registers are 64 bits wide.
9816
9817 @item -mfp32
9818 @opindex mfp32
9819 Assume that floating-point registers are 32 bits wide.
9820
9821 @item -mfp64
9822 @opindex mfp64
9823 Assume that floating-point registers are 64 bits wide.
9824
9825 @item -mhard-float
9826 @opindex mhard-float
9827 Use floating-point coprocessor instructions.
9828
9829 @item -msoft-float
9830 @opindex msoft-float
9831 Do not use floating-point coprocessor instructions.  Implement
9832 floating-point calculations using library calls instead.
9833
9834 @item -msingle-float
9835 @opindex msingle-float
9836 Assume that the floating-point coprocessor only supports single-precision
9837 operations.
9838
9839 @itemx -mdouble-float
9840 @opindex mdouble-float
9841 Assume that the floating-point coprocessor supports double-precision
9842 operations.  This is the default.
9843
9844 @itemx -mpaired-single
9845 @itemx -mno-paired-single
9846 @opindex mpaired-single
9847 @opindex mno-paired-single
9848 Use (do not use) paired-single floating-point instructions.
9849 @xref{MIPS Paired-Single Support}.  This option can only be used
9850 when generating 64-bit code and requires hardware floating-point
9851 support to be enabled.
9852
9853 @itemx -mips3d
9854 @itemx -mno-mips3d
9855 @opindex mips3d
9856 @opindex mno-mips3d
9857 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9858 The option @option{-mips3d} implies @option{-mpaired-single}.
9859
9860 @item -mint64
9861 @opindex mint64
9862 Force @code{int} and @code{long} types to be 64 bits wide.  See
9863 @option{-mlong32} for an explanation of the default and the way
9864 that the pointer size is determined.
9865
9866 This option has been deprecated and will be removed in a future release.
9867
9868 @item -mlong64
9869 @opindex mlong64
9870 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9871 an explanation of the default and the way that the pointer size is
9872 determined.
9873
9874 @item -mlong32
9875 @opindex mlong32
9876 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9877
9878 The default size of @code{int}s, @code{long}s and pointers depends on
9879 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9880 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9881 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9882 or the same size as integer registers, whichever is smaller.
9883
9884 @item -msym32
9885 @itemx -mno-sym32
9886 @opindex msym32
9887 @opindex mno-sym32
9888 Assume (do not assume) that all symbols have 32-bit values, regardless
9889 of the selected ABI@.  This option is useful in combination with
9890 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9891 to generate shorter and faster references to symbolic addresses.
9892
9893 @item -G @var{num}
9894 @opindex G
9895 @cindex smaller data references (MIPS)
9896 @cindex gp-relative references (MIPS)
9897 Put global and static items less than or equal to @var{num} bytes into
9898 the small data or bss section instead of the normal data or bss section.
9899 This allows the data to be accessed using a single instruction.
9900
9901 All modules should be compiled with the same @option{-G @var{num}}
9902 value.
9903
9904 @item -membedded-data
9905 @itemx -mno-embedded-data
9906 @opindex membedded-data
9907 @opindex mno-embedded-data
9908 Allocate variables to the read-only data section first if possible, then
9909 next in the small data section if possible, otherwise in data.  This gives
9910 slightly slower code than the default, but reduces the amount of RAM required
9911 when executing, and thus may be preferred for some embedded systems.
9912
9913 @item -muninit-const-in-rodata
9914 @itemx -mno-uninit-const-in-rodata
9915 @opindex muninit-const-in-rodata
9916 @opindex mno-uninit-const-in-rodata
9917 Put uninitialized @code{const} variables in the read-only data section.
9918 This option is only meaningful in conjunction with @option{-membedded-data}.
9919
9920 @item -msplit-addresses
9921 @itemx -mno-split-addresses
9922 @opindex msplit-addresses
9923 @opindex mno-split-addresses
9924 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9925 relocation operators.  This option has been superseded by
9926 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9927
9928 @item -mexplicit-relocs
9929 @itemx -mno-explicit-relocs
9930 @opindex mexplicit-relocs
9931 @opindex mno-explicit-relocs
9932 Use (do not use) assembler relocation operators when dealing with symbolic
9933 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9934 is to use assembler macros instead.
9935
9936 @option{-mexplicit-relocs} is the default if GCC was configured
9937 to use an assembler that supports relocation operators.
9938
9939 @item -mcheck-zero-division
9940 @itemx -mno-check-zero-division
9941 @opindex mcheck-zero-division
9942 @opindex mno-check-zero-division
9943 Trap (do not trap) on integer division by zero.  The default is
9944 @option{-mcheck-zero-division}.
9945
9946 @item -mdivide-traps
9947 @itemx -mdivide-breaks
9948 @opindex mdivide-traps
9949 @opindex mdivide-breaks
9950 MIPS systems check for division by zero by generating either a
9951 conditional trap or a break instruction.  Using traps results in
9952 smaller code, but is only supported on MIPS II and later.  Also, some
9953 versions of the Linux kernel have a bug that prevents trap from
9954 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9955 allow conditional traps on architectures that support them and
9956 @option{-mdivide-breaks} to force the use of breaks.
9957
9958 The default is usually @option{-mdivide-traps}, but this can be
9959 overridden at configure time using @option{--with-divide=breaks}.
9960 Divide-by-zero checks can be completely disabled using
9961 @option{-mno-check-zero-division}.
9962
9963 @item -mmemcpy
9964 @itemx -mno-memcpy
9965 @opindex mmemcpy
9966 @opindex mno-memcpy
9967 Force (do not force) the use of @code{memcpy()} for non-trivial block
9968 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9969 most constant-sized copies.
9970
9971 @item -mlong-calls
9972 @itemx -mno-long-calls
9973 @opindex mlong-calls
9974 @opindex mno-long-calls
9975 Disable (do not disable) use of the @code{jal} instruction.  Calling
9976 functions using @code{jal} is more efficient but requires the caller
9977 and callee to be in the same 256 megabyte segment.
9978
9979 This option has no effect on abicalls code.  The default is
9980 @option{-mno-long-calls}.
9981
9982 @item -mmad
9983 @itemx -mno-mad
9984 @opindex mmad
9985 @opindex mno-mad
9986 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9987 instructions, as provided by the R4650 ISA@.
9988
9989 @item -mfused-madd
9990 @itemx -mno-fused-madd
9991 @opindex mfused-madd
9992 @opindex mno-fused-madd
9993 Enable (disable) use of the floating point multiply-accumulate
9994 instructions, when they are available.  The default is
9995 @option{-mfused-madd}.
9996
9997 When multiply-accumulate instructions are used, the intermediate
9998 product is calculated to infinite precision and is not subject to
9999 the FCSR Flush to Zero bit.  This may be undesirable in some
10000 circumstances.
10001
10002 @item -nocpp
10003 @opindex nocpp
10004 Tell the MIPS assembler to not run its preprocessor over user
10005 assembler files (with a @samp{.s} suffix) when assembling them.
10006
10007 @item -mfix-r4000
10008 @itemx -mno-fix-r4000
10009 @opindex mfix-r4000
10010 @opindex mno-fix-r4000
10011 Work around certain R4000 CPU errata:
10012 @itemize @minus
10013 @item
10014 A double-word or a variable shift may give an incorrect result if executed
10015 immediately after starting an integer division.
10016 @item
10017 A double-word or a variable shift may give an incorrect result if executed
10018 while an integer multiplication is in progress.
10019 @item
10020 An integer division may give an incorrect result if started in a delay slot
10021 of a taken branch or a jump.
10022 @end itemize
10023
10024 @item -mfix-r4400
10025 @itemx -mno-fix-r4400
10026 @opindex mfix-r4400
10027 @opindex mno-fix-r4400
10028 Work around certain R4400 CPU errata:
10029 @itemize @minus
10030 @item
10031 A double-word or a variable shift may give an incorrect result if executed
10032 immediately after starting an integer division.
10033 @end itemize
10034
10035 @item -mfix-vr4120
10036 @itemx -mno-fix-vr4120
10037 @opindex mfix-vr4120
10038 Work around certain VR4120 errata:
10039 @itemize @minus
10040 @item
10041 @code{dmultu} does not always produce the correct result.
10042 @item
10043 @code{div} and @code{ddiv} do not always produce the correct result if one
10044 of the operands is negative.
10045 @end itemize
10046 The workarounds for the division errata rely on special functions in
10047 @file{libgcc.a}.  At present, these functions are only provided by
10048 the @code{mips64vr*-elf} configurations.
10049
10050 Other VR4120 errata require a nop to be inserted between certain pairs of
10051 instructions.  These errata are handled by the assembler, not by GCC itself.
10052
10053 @item -mfix-vr4130
10054 @opindex mfix-vr4130
10055 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10056 workarounds are implemented by the assembler rather than by GCC,
10057 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10058 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10059 instructions are available instead.
10060
10061 @item -mfix-sb1
10062 @itemx -mno-fix-sb1
10063 @opindex mfix-sb1
10064 Work around certain SB-1 CPU core errata.
10065 (This flag currently works around the SB-1 revision 2
10066 ``F1'' and ``F2'' floating point errata.)
10067
10068 @item -mflush-func=@var{func}
10069 @itemx -mno-flush-func
10070 @opindex mflush-func
10071 Specifies the function to call to flush the I and D caches, or to not
10072 call any such function.  If called, the function must take the same
10073 arguments as the common @code{_flush_func()}, that is, the address of the
10074 memory range for which the cache is being flushed, the size of the
10075 memory range, and the number 3 (to flush both caches).  The default
10076 depends on the target GCC was configured for, but commonly is either
10077 @samp{_flush_func} or @samp{__cpu_flush}.
10078
10079 @item -mbranch-likely
10080 @itemx -mno-branch-likely
10081 @opindex mbranch-likely
10082 @opindex mno-branch-likely
10083 Enable or disable use of Branch Likely instructions, regardless of the
10084 default for the selected architecture.  By default, Branch Likely
10085 instructions may be generated if they are supported by the selected
10086 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10087 and processors which implement those architectures; for those, Branch
10088 Likely instructions will not be generated by default because the MIPS32
10089 and MIPS64 architectures specifically deprecate their use.
10090
10091 @item -mfp-exceptions
10092 @itemx -mno-fp-exceptions
10093 @opindex mfp-exceptions
10094 Specifies whether FP exceptions are enabled.  This affects how we schedule
10095 FP instructions for some processors.  The default is that FP exceptions are
10096 enabled.
10097
10098 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10099 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10100 FP pipe.
10101
10102 @item -mvr4130-align
10103 @itemx -mno-vr4130-align
10104 @opindex mvr4130-align
10105 The VR4130 pipeline is two-way superscalar, but can only issue two
10106 instructions together if the first one is 8-byte aligned.  When this
10107 option is enabled, GCC will align pairs of instructions that it
10108 thinks should execute in parallel.
10109
10110 This option only has an effect when optimizing for the VR4130.
10111 It normally makes code faster, but at the expense of making it bigger.
10112 It is enabled by default at optimization level @option{-O3}.
10113 @end table
10114
10115 @node MMIX Options
10116 @subsection MMIX Options
10117 @cindex MMIX Options
10118
10119 These options are defined for the MMIX:
10120
10121 @table @gcctabopt
10122 @item -mlibfuncs
10123 @itemx -mno-libfuncs
10124 @opindex mlibfuncs
10125 @opindex mno-libfuncs
10126 Specify that intrinsic library functions are being compiled, passing all
10127 values in registers, no matter the size.
10128
10129 @item -mepsilon
10130 @itemx -mno-epsilon
10131 @opindex mepsilon
10132 @opindex mno-epsilon
10133 Generate floating-point comparison instructions that compare with respect
10134 to the @code{rE} epsilon register.
10135
10136 @item -mabi=mmixware
10137 @itemx -mabi=gnu
10138 @opindex mabi-mmixware
10139 @opindex mabi=gnu
10140 Generate code that passes function parameters and return values that (in
10141 the called function) are seen as registers @code{$0} and up, as opposed to
10142 the GNU ABI which uses global registers @code{$231} and up.
10143
10144 @item -mzero-extend
10145 @itemx -mno-zero-extend
10146 @opindex mzero-extend
10147 @opindex mno-zero-extend
10148 When reading data from memory in sizes shorter than 64 bits, use (do not
10149 use) zero-extending load instructions by default, rather than
10150 sign-extending ones.
10151
10152 @item -mknuthdiv
10153 @itemx -mno-knuthdiv
10154 @opindex mknuthdiv
10155 @opindex mno-knuthdiv
10156 Make the result of a division yielding a remainder have the same sign as
10157 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10158 remainder follows the sign of the dividend.  Both methods are
10159 arithmetically valid, the latter being almost exclusively used.
10160
10161 @item -mtoplevel-symbols
10162 @itemx -mno-toplevel-symbols
10163 @opindex mtoplevel-symbols
10164 @opindex mno-toplevel-symbols
10165 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10166 code can be used with the @code{PREFIX} assembly directive.
10167
10168 @item -melf
10169 @opindex melf
10170 Generate an executable in the ELF format, rather than the default
10171 @samp{mmo} format used by the @command{mmix} simulator.
10172
10173 @item -mbranch-predict
10174 @itemx -mno-branch-predict
10175 @opindex mbranch-predict
10176 @opindex mno-branch-predict
10177 Use (do not use) the probable-branch instructions, when static branch
10178 prediction indicates a probable branch.
10179
10180 @item -mbase-addresses
10181 @itemx -mno-base-addresses
10182 @opindex mbase-addresses
10183 @opindex mno-base-addresses
10184 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10185 base address automatically generates a request (handled by the assembler
10186 and the linker) for a constant to be set up in a global register.  The
10187 register is used for one or more base address requests within the range 0
10188 to 255 from the value held in the register.  The generally leads to short
10189 and fast code, but the number of different data items that can be
10190 addressed is limited.  This means that a program that uses lots of static
10191 data may require @option{-mno-base-addresses}.
10192
10193 @item -msingle-exit
10194 @itemx -mno-single-exit
10195 @opindex msingle-exit
10196 @opindex mno-single-exit
10197 Force (do not force) generated code to have a single exit point in each
10198 function.
10199 @end table
10200
10201 @node MN10300 Options
10202 @subsection MN10300 Options
10203 @cindex MN10300 options
10204
10205 These @option{-m} options are defined for Matsushita MN10300 architectures:
10206
10207 @table @gcctabopt
10208 @item -mmult-bug
10209 @opindex mmult-bug
10210 Generate code to avoid bugs in the multiply instructions for the MN10300
10211 processors.  This is the default.
10212
10213 @item -mno-mult-bug
10214 @opindex mno-mult-bug
10215 Do not generate code to avoid bugs in the multiply instructions for the
10216 MN10300 processors.
10217
10218 @item -mam33
10219 @opindex mam33
10220 Generate code which uses features specific to the AM33 processor.
10221
10222 @item -mno-am33
10223 @opindex mno-am33
10224 Do not generate code which uses features specific to the AM33 processor.  This
10225 is the default.
10226
10227 @item -mno-crt0
10228 @opindex mno-crt0
10229 Do not link in the C run-time initialization object file.
10230
10231 @item -mrelax
10232 @opindex mrelax
10233 Indicate to the linker that it should perform a relaxation optimization pass
10234 to shorten branches, calls and absolute memory addresses.  This option only
10235 has an effect when used on the command line for the final link step.
10236
10237 This option makes symbolic debugging impossible.
10238 @end table
10239
10240 @node NS32K Options
10241 @subsection NS32K Options
10242 @cindex NS32K options
10243
10244 These are the @samp{-m} options defined for the 32000 series.  The default
10245 values for these options depends on which style of 32000 was selected when
10246 the compiler was configured; the defaults for the most common choices are
10247 given below.
10248
10249 @table @gcctabopt
10250 @item -m32032
10251 @itemx -m32032
10252 @opindex m32032
10253 @opindex m32032
10254 Generate output for a 32032.  This is the default
10255 when the compiler is configured for 32032 and 32016 based systems.
10256
10257 @item -m32332
10258 @itemx -m32332
10259 @opindex m32332
10260 @opindex m32332
10261 Generate output for a 32332.  This is the default
10262 when the compiler is configured for 32332-based systems.
10263
10264 @item -m32532
10265 @itemx -m32532
10266 @opindex m32532
10267 @opindex m32532
10268 Generate output for a 32532.  This is the default
10269 when the compiler is configured for 32532-based systems.
10270
10271 @item -m32081
10272 @opindex m32081
10273 Generate output containing 32081 instructions for floating point.
10274 This is the default for all systems.
10275
10276 @item -m32381
10277 @opindex m32381
10278 Generate output containing 32381 instructions for floating point.  This
10279 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10280 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10281
10282 @item -mmulti-add
10283 @opindex mmulti-add
10284 Try and generate multiply-add floating point instructions @code{polyF}
10285 and @code{dotF}.  This option is only available if the @option{-m32381}
10286 option is in effect.  Using these instructions requires changes to
10287 register allocation which generally has a negative impact on
10288 performance.  This option should only be enabled when compiling code
10289 particularly likely to make heavy use of multiply-add instructions.
10290
10291 @item -mnomulti-add
10292 @opindex mnomulti-add
10293 Do not try and generate multiply-add floating point instructions
10294 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10295
10296 @item -msoft-float
10297 @opindex msoft-float
10298 Generate output containing library calls for floating point.
10299 @strong{Warning:} the requisite libraries may not be available.
10300
10301 @item -mieee-compare
10302 @itemx -mno-ieee-compare
10303 @opindex mieee-compare
10304 @opindex mno-ieee-compare
10305 Control whether or not the compiler uses IEEE floating point
10306 comparisons.  These handle correctly the case where the result of a
10307 comparison is unordered.
10308 @strong{Warning:} the requisite kernel support may not be available.
10309
10310 @item -mnobitfield
10311 @opindex mnobitfield
10312 Do not use the bit-field instructions.  On some machines it is faster to
10313 use shifting and masking operations.  This is the default for the pc532.
10314
10315 @item -mbitfield
10316 @opindex mbitfield
10317 Do use the bit-field instructions.  This is the default for all platforms
10318 except the pc532.
10319
10320 @item -mrtd
10321 @opindex mrtd
10322 Use a different function-calling convention, in which functions
10323 that take a fixed number of arguments return pop their
10324 arguments on return with the @code{ret} instruction.
10325
10326 This calling convention is incompatible with the one normally
10327 used on Unix, so you cannot use it if you need to call libraries
10328 compiled with the Unix compiler.
10329
10330 Also, you must provide function prototypes for all functions that
10331 take variable numbers of arguments (including @code{printf});
10332 otherwise incorrect code will be generated for calls to those
10333 functions.
10334
10335 In addition, seriously incorrect code will result if you call a
10336 function with too many arguments.  (Normally, extra arguments are
10337 harmlessly ignored.)
10338
10339 This option takes its name from the 680x0 @code{rtd} instruction.
10340
10341
10342 @item -mregparam
10343 @opindex mregparam
10344 Use a different function-calling convention where the first two arguments
10345 are passed in registers.
10346
10347 This calling convention is incompatible with the one normally
10348 used on Unix, so you cannot use it if you need to call libraries
10349 compiled with the Unix compiler.
10350
10351 @item -mnoregparam
10352 @opindex mnoregparam
10353 Do not pass any arguments in registers.  This is the default for all
10354 targets.
10355
10356 @item -msb
10357 @opindex msb
10358 It is OK to use the sb as an index register which is always loaded with
10359 zero.  This is the default for the pc532-netbsd target.
10360
10361 @item -mnosb
10362 @opindex mnosb
10363 The sb register is not available for use or has not been initialized to
10364 zero by the run time system.  This is the default for all targets except
10365 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10366 @option{-fpic} is set.
10367
10368 @item -mhimem
10369 @opindex mhimem
10370 Many ns32000 series addressing modes use displacements of up to 512MB@.
10371 If an address is above 512MB then displacements from zero can not be used.
10372 This option causes code to be generated which can be loaded above 512MB@.
10373 This may be useful for operating systems or ROM code.
10374
10375 @item -mnohimem
10376 @opindex mnohimem
10377 Assume code will be loaded in the first 512MB of virtual address space.
10378 This is the default for all platforms.
10379
10380 @end table
10381
10382 @node PDP-11 Options
10383 @subsection PDP-11 Options
10384 @cindex PDP-11 Options
10385
10386 These options are defined for the PDP-11:
10387
10388 @table @gcctabopt
10389 @item -mfpu
10390 @opindex mfpu
10391 Use hardware FPP floating point.  This is the default.  (FIS floating
10392 point on the PDP-11/40 is not supported.)
10393
10394 @item -msoft-float
10395 @opindex msoft-float
10396 Do not use hardware floating point.
10397
10398 @item -mac0
10399 @opindex mac0
10400 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10401
10402 @item -mno-ac0
10403 @opindex mno-ac0
10404 Return floating-point results in memory.  This is the default.
10405
10406 @item -m40
10407 @opindex m40
10408 Generate code for a PDP-11/40.
10409
10410 @item -m45
10411 @opindex m45
10412 Generate code for a PDP-11/45.  This is the default.
10413
10414 @item -m10
10415 @opindex m10
10416 Generate code for a PDP-11/10.
10417
10418 @item -mbcopy-builtin
10419 @opindex bcopy-builtin
10420 Use inline @code{movmemhi} patterns for copying memory.  This is the
10421 default.
10422
10423 @item -mbcopy
10424 @opindex mbcopy
10425 Do not use inline @code{movmemhi} patterns for copying memory.
10426
10427 @item -mint16
10428 @itemx -mno-int32
10429 @opindex mint16
10430 @opindex mno-int32
10431 Use 16-bit @code{int}.  This is the default.
10432
10433 @item -mint32
10434 @itemx -mno-int16
10435 @opindex mint32
10436 @opindex mno-int16
10437 Use 32-bit @code{int}.
10438
10439 @item -mfloat64
10440 @itemx -mno-float32
10441 @opindex mfloat64
10442 @opindex mno-float32
10443 Use 64-bit @code{float}.  This is the default.
10444
10445 @item -mfloat32
10446 @itemx -mno-float64
10447 @opindex mfloat32
10448 @opindex mno-float64
10449 Use 32-bit @code{float}.
10450
10451 @item -mabshi
10452 @opindex mabshi
10453 Use @code{abshi2} pattern.  This is the default.
10454
10455 @item -mno-abshi
10456 @opindex mno-abshi
10457 Do not use @code{abshi2} pattern.
10458
10459 @item -mbranch-expensive
10460 @opindex mbranch-expensive
10461 Pretend that branches are expensive.  This is for experimenting with
10462 code generation only.
10463
10464 @item -mbranch-cheap
10465 @opindex mbranch-cheap
10466 Do not pretend that branches are expensive.  This is the default.
10467
10468 @item -msplit
10469 @opindex msplit
10470 Generate code for a system with split I&D@.
10471
10472 @item -mno-split
10473 @opindex mno-split
10474 Generate code for a system without split I&D@.  This is the default.
10475
10476 @item -munix-asm
10477 @opindex munix-asm
10478 Use Unix assembler syntax.  This is the default when configured for
10479 @samp{pdp11-*-bsd}.
10480
10481 @item -mdec-asm
10482 @opindex mdec-asm
10483 Use DEC assembler syntax.  This is the default when configured for any
10484 PDP-11 target other than @samp{pdp11-*-bsd}.
10485 @end table
10486
10487 @node PowerPC Options
10488 @subsection PowerPC Options
10489 @cindex PowerPC options
10490
10491 These are listed under @xref{RS/6000 and PowerPC Options}.
10492
10493 @node RS/6000 and PowerPC Options
10494 @subsection IBM RS/6000 and PowerPC Options
10495 @cindex RS/6000 and PowerPC Options
10496 @cindex IBM RS/6000 and PowerPC Options
10497
10498 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10499 @table @gcctabopt
10500 @item -mpower
10501 @itemx -mno-power
10502 @itemx -mpower2
10503 @itemx -mno-power2
10504 @itemx -mpowerpc
10505 @itemx -mno-powerpc
10506 @itemx -mpowerpc-gpopt
10507 @itemx -mno-powerpc-gpopt
10508 @itemx -mpowerpc-gfxopt
10509 @itemx -mno-powerpc-gfxopt
10510 @itemx -mpowerpc64
10511 @itemx -mno-powerpc64
10512 @opindex mpower
10513 @opindex mno-power
10514 @opindex mpower2
10515 @opindex mno-power2
10516 @opindex mpowerpc
10517 @opindex mno-powerpc
10518 @opindex mpowerpc-gpopt
10519 @opindex mno-powerpc-gpopt
10520 @opindex mpowerpc-gfxopt
10521 @opindex mno-powerpc-gfxopt
10522 @opindex mpowerpc64
10523 @opindex mno-powerpc64
10524 GCC supports two related instruction set architectures for the
10525 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10526 instructions supported by the @samp{rios} chip set used in the original
10527 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10528 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10529 the IBM 4xx microprocessors.
10530
10531 Neither architecture is a subset of the other.  However there is a
10532 large common subset of instructions supported by both.  An MQ
10533 register is included in processors supporting the POWER architecture.
10534
10535 You use these options to specify which instructions are available on the
10536 processor you are using.  The default value of these options is
10537 determined when configuring GCC@.  Specifying the
10538 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10539 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10540 rather than the options listed above.
10541
10542 The @option{-mpower} option allows GCC to generate instructions that
10543 are found only in the POWER architecture and to use the MQ register.
10544 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10545 to generate instructions that are present in the POWER2 architecture but
10546 not the original POWER architecture.
10547
10548 The @option{-mpowerpc} option allows GCC to generate instructions that
10549 are found only in the 32-bit subset of the PowerPC architecture.
10550 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10551 GCC to use the optional PowerPC architecture instructions in the
10552 General Purpose group, including floating-point square root.  Specifying
10553 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10554 use the optional PowerPC architecture instructions in the Graphics
10555 group, including floating-point select.
10556
10557 The @option{-mpowerpc64} option allows GCC to generate the additional
10558 64-bit instructions that are found in the full PowerPC64 architecture
10559 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10560 @option{-mno-powerpc64}.
10561
10562 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10563 will use only the instructions in the common subset of both
10564 architectures plus some special AIX common-mode calls, and will not use
10565 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10566 permits GCC to use any instruction from either architecture and to
10567 allow use of the MQ register; specify this for the Motorola MPC601.
10568
10569 @item -mnew-mnemonics
10570 @itemx -mold-mnemonics
10571 @opindex mnew-mnemonics
10572 @opindex mold-mnemonics
10573 Select which mnemonics to use in the generated assembler code.  With
10574 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10575 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10576 assembler mnemonics defined for the POWER architecture.  Instructions
10577 defined in only one architecture have only one mnemonic; GCC uses that
10578 mnemonic irrespective of which of these options is specified.
10579
10580 GCC defaults to the mnemonics appropriate for the architecture in
10581 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10582 value of these option.  Unless you are building a cross-compiler, you
10583 should normally not specify either @option{-mnew-mnemonics} or
10584 @option{-mold-mnemonics}, but should instead accept the default.
10585
10586 @item -mcpu=@var{cpu_type}
10587 @opindex mcpu
10588 Set architecture type, register usage, choice of mnemonics, and
10589 instruction scheduling parameters for machine type @var{cpu_type}.
10590 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10591 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10592 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10593 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10594 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10595 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10596 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10597 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10598 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10599
10600 @option{-mcpu=common} selects a completely generic processor.  Code
10601 generated under this option will run on any POWER or PowerPC processor.
10602 GCC will use only the instructions in the common subset of both
10603 architectures, and will not use the MQ register.  GCC assumes a generic
10604 processor model for scheduling purposes.
10605
10606 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10607 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10608 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10609 types, with an appropriate, generic processor model assumed for
10610 scheduling purposes.
10611
10612 The other options specify a specific processor.  Code generated under
10613 those options will run best on that processor, and may not run at all on
10614 others.
10615
10616 The @option{-mcpu} options automatically enable or disable the
10617 following options: @option{-maltivec}, @option{-mhard-float},
10618 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10619 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10620 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10621 @option{-mstring}.  The particular options set for any particular CPU
10622 will vary between compiler versions, depending on what setting seems
10623 to produce optimal code for that CPU; it doesn't necessarily reflect
10624 the actual hardware's capabilities.  If you wish to set an individual
10625 option to a particular value, you may specify it after the
10626 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10627
10628 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10629 not enabled or disabled by the @option{-mcpu} option at present, since
10630 AIX does not have full support for these options.  You may still
10631 enable or disable them individually if you're sure it'll work in your
10632 environment.
10633
10634 @item -mtune=@var{cpu_type}
10635 @opindex mtune
10636 Set the instruction scheduling parameters for machine type
10637 @var{cpu_type}, but do not set the architecture type, register usage, or
10638 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10639 values for @var{cpu_type} are used for @option{-mtune} as for
10640 @option{-mcpu}.  If both are specified, the code generated will use the
10641 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10642 scheduling parameters set by @option{-mtune}.
10643
10644 @item -maltivec
10645 @itemx -mno-altivec
10646 @opindex maltivec
10647 @opindex mno-altivec
10648 Generate code that uses (does not use) AltiVec instructions, and also
10649 enable the use of built-in functions that allow more direct access to
10650 the AltiVec instruction set.  You may also need to set
10651 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10652 enhancements.
10653
10654 @item -mvrsave
10655 @item -mno-vrsave
10656 @opindex mvrsave
10657 @opindex mno-vrsave
10658 Generate VRSAVE instructions when generating AltiVec code.
10659
10660 @item -mabi=spe
10661 @opindex mabi=spe
10662 Extend the current ABI with SPE ABI extensions.  This does not change
10663 the default ABI, instead it adds the SPE ABI extensions to the current
10664 ABI@.
10665
10666 @item -mabi=no-spe
10667 @opindex mabi=no-spe
10668 Disable Booke SPE ABI extensions for the current ABI@.
10669
10670 @item -misel
10671 @itemx -mno-isel
10672 @opindex misel
10673 @opindex mno-isel
10674 This switch enables or disables the generation of ISEL instructions.
10675
10676 @item -misel=@var{yes/no}
10677 This switch has been deprecated.  Use @option{-misel} and
10678 @option{-mno-isel} instead.
10679
10680 @item -mspe
10681 @itemx -mno-isel
10682 @opindex mspe
10683 @opindex mno-spe
10684 This switch enables or disables the generation of SPE simd
10685 instructions.
10686
10687 @item -mspe=@var{yes/no}
10688 This option has been deprecated.  Use @option{-mspe} and
10689 @option{-mno-spe} instead.
10690
10691 @item -mfloat-gprs=@var{yes/single/double/no}
10692 @itemx -mfloat-gprs
10693 @opindex mfloat-gprs
10694 This switch enables or disables the generation of floating point
10695 operations on the general purpose registers for architectures that
10696 support it.
10697
10698 The argument @var{yes} or @var{single} enables the use of
10699 single-precision floating point operations.
10700
10701 The argument @var{double} enables the use of single and
10702 double-precision floating point operations.
10703
10704 The argument @var{no} disables floating point operations on the
10705 general purpose registers.
10706
10707 This option is currently only available on the MPC854x.
10708
10709 @item -m32
10710 @itemx -m64
10711 @opindex m32
10712 @opindex m64
10713 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10714 targets (including GNU/Linux).  The 32-bit environment sets int, long
10715 and pointer to 32 bits and generates code that runs on any PowerPC
10716 variant.  The 64-bit environment sets int to 32 bits and long and
10717 pointer to 64 bits, and generates code for PowerPC64, as for
10718 @option{-mpowerpc64}.
10719
10720 @item -mfull-toc
10721 @itemx -mno-fp-in-toc
10722 @itemx -mno-sum-in-toc
10723 @itemx -mminimal-toc
10724 @opindex mfull-toc
10725 @opindex mno-fp-in-toc
10726 @opindex mno-sum-in-toc
10727 @opindex mminimal-toc
10728 Modify generation of the TOC (Table Of Contents), which is created for
10729 every executable file.  The @option{-mfull-toc} option is selected by
10730 default.  In that case, GCC will allocate at least one TOC entry for
10731 each unique non-automatic variable reference in your program.  GCC
10732 will also place floating-point constants in the TOC@.  However, only
10733 16,384 entries are available in the TOC@.
10734
10735 If you receive a linker error message that saying you have overflowed
10736 the available TOC space, you can reduce the amount of TOC space used
10737 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10738 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10739 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10740 generate code to calculate the sum of an address and a constant at
10741 run-time instead of putting that sum into the TOC@.  You may specify one
10742 or both of these options.  Each causes GCC to produce very slightly
10743 slower and larger code at the expense of conserving TOC space.
10744
10745 If you still run out of space in the TOC even when you specify both of
10746 these options, specify @option{-mminimal-toc} instead.  This option causes
10747 GCC to make only one TOC entry for every file.  When you specify this
10748 option, GCC will produce code that is slower and larger but which
10749 uses extremely little TOC space.  You may wish to use this option
10750 only on files that contain less frequently executed code.
10751
10752 @item -maix64
10753 @itemx -maix32
10754 @opindex maix64
10755 @opindex maix32
10756 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10757 @code{long} type, and the infrastructure needed to support them.
10758 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10759 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10760 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10761
10762 @item -mxl-compat
10763 @itemx -mno-xl-compat
10764 @opindex mxl-compat
10765 @opindex mno-xl-compat
10766 Produce code that conforms more closely to IBM XLC semantics when using
10767 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10768 functions beyond the register save area (RSA) on the stack in addition
10769 to argument FPRs.  Do not assume that most significant double in 128
10770 bit long double value is properly rounded when comparing values.
10771
10772 The AIX calling convention was extended but not initially documented to
10773 handle an obscure K&R C case of calling a function that takes the
10774 address of its arguments with fewer arguments than declared.  AIX XL
10775 compilers access floating point arguments which do not fit in the
10776 RSA from the stack when a subroutine is compiled without
10777 optimization.  Because always storing floating-point arguments on the
10778 stack is inefficient and rarely needed, this option is not enabled by
10779 default and only is necessary when calling subroutines compiled by AIX
10780 XL compilers without optimization.
10781
10782 @item -mpe
10783 @opindex mpe
10784 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10785 application written to use message passing with special startup code to
10786 enable the application to run.  The system must have PE installed in the
10787 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10788 must be overridden with the @option{-specs=} option to specify the
10789 appropriate directory location.  The Parallel Environment does not
10790 support threads, so the @option{-mpe} option and the @option{-pthread}
10791 option are incompatible.
10792
10793 @item -malign-natural
10794 @itemx -malign-power
10795 @opindex malign-natural
10796 @opindex malign-power
10797 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10798 @option{-malign-natural} overrides the ABI-defined alignment of larger
10799 types, such as floating-point doubles, on their natural size-based boundary.
10800 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10801 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10802
10803 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10804 is not supported.
10805
10806 @item -msoft-float
10807 @itemx -mhard-float
10808 @opindex msoft-float
10809 @opindex mhard-float
10810 Generate code that does not use (uses) the floating-point register set.
10811 Software floating point emulation is provided if you use the
10812 @option{-msoft-float} option, and pass the option to GCC when linking.
10813
10814 @item -mmultiple
10815 @itemx -mno-multiple
10816 @opindex mmultiple
10817 @opindex mno-multiple
10818 Generate code that uses (does not use) the load multiple word
10819 instructions and the store multiple word instructions.  These
10820 instructions are generated by default on POWER systems, and not
10821 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10822 endian PowerPC systems, since those instructions do not work when the
10823 processor is in little endian mode.  The exceptions are PPC740 and
10824 PPC750 which permit the instructions usage in little endian mode.
10825
10826 @item -mstring
10827 @itemx -mno-string
10828 @opindex mstring
10829 @opindex mno-string
10830 Generate code that uses (does not use) the load string instructions
10831 and the store string word instructions to save multiple registers and
10832 do small block moves.  These instructions are generated by default on
10833 POWER systems, and not generated on PowerPC systems.  Do not use
10834 @option{-mstring} on little endian PowerPC systems, since those
10835 instructions do not work when the processor is in little endian mode.
10836 The exceptions are PPC740 and PPC750 which permit the instructions
10837 usage in little endian mode.
10838
10839 @item -mupdate
10840 @itemx -mno-update
10841 @opindex mupdate
10842 @opindex mno-update
10843 Generate code that uses (does not use) the load or store instructions
10844 that update the base register to the address of the calculated memory
10845 location.  These instructions are generated by default.  If you use
10846 @option{-mno-update}, there is a small window between the time that the
10847 stack pointer is updated and the address of the previous frame is
10848 stored, which means code that walks the stack frame across interrupts or
10849 signals may get corrupted data.
10850
10851 @item -mfused-madd
10852 @itemx -mno-fused-madd
10853 @opindex mfused-madd
10854 @opindex mno-fused-madd
10855 Generate code that uses (does not use) the floating point multiply and
10856 accumulate instructions.  These instructions are generated by default if
10857 hardware floating is used.
10858
10859 @item -mno-bit-align
10860 @itemx -mbit-align
10861 @opindex mno-bit-align
10862 @opindex mbit-align
10863 On System V.4 and embedded PowerPC systems do not (do) force structures
10864 and unions that contain bit-fields to be aligned to the base type of the
10865 bit-field.
10866
10867 For example, by default a structure containing nothing but 8
10868 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10869 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10870 the structure would be aligned to a 1 byte boundary and be one byte in
10871 size.
10872
10873 @item -mno-strict-align
10874 @itemx -mstrict-align
10875 @opindex mno-strict-align
10876 @opindex mstrict-align
10877 On System V.4 and embedded PowerPC systems do not (do) assume that
10878 unaligned memory references will be handled by the system.
10879
10880 @item -mrelocatable
10881 @itemx -mno-relocatable
10882 @opindex mrelocatable
10883 @opindex mno-relocatable
10884 On embedded PowerPC systems generate code that allows (does not allow)
10885 the program to be relocated to a different address at runtime.  If you
10886 use @option{-mrelocatable} on any module, all objects linked together must
10887 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10888
10889 @item -mrelocatable-lib
10890 @itemx -mno-relocatable-lib
10891 @opindex mrelocatable-lib
10892 @opindex mno-relocatable-lib
10893 On embedded PowerPC systems generate code that allows (does not allow)
10894 the program to be relocated to a different address at runtime.  Modules
10895 compiled with @option{-mrelocatable-lib} can be linked with either modules
10896 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10897 with modules compiled with the @option{-mrelocatable} options.
10898
10899 @item -mno-toc
10900 @itemx -mtoc
10901 @opindex mno-toc
10902 @opindex mtoc
10903 On System V.4 and embedded PowerPC systems do not (do) assume that
10904 register 2 contains a pointer to a global area pointing to the addresses
10905 used in the program.
10906
10907 @item -mlittle
10908 @itemx -mlittle-endian
10909 @opindex mlittle
10910 @opindex mlittle-endian
10911 On System V.4 and embedded PowerPC systems compile code for the
10912 processor in little endian mode.  The @option{-mlittle-endian} option is
10913 the same as @option{-mlittle}.
10914
10915 @item -mbig
10916 @itemx -mbig-endian
10917 @opindex mbig
10918 @opindex mbig-endian
10919 On System V.4 and embedded PowerPC systems compile code for the
10920 processor in big endian mode.  The @option{-mbig-endian} option is
10921 the same as @option{-mbig}.
10922
10923 @item -mdynamic-no-pic
10924 @opindex mdynamic-no-pic
10925 On Darwin and Mac OS X systems, compile code so that it is not
10926 relocatable, but that its external references are relocatable.  The
10927 resulting code is suitable for applications, but not shared
10928 libraries.
10929
10930 @item -mprioritize-restricted-insns=@var{priority}
10931 @opindex mprioritize-restricted-insns
10932 This option controls the priority that is assigned to
10933 dispatch-slot restricted instructions during the second scheduling
10934 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10935 @var{no/highest/second-highest} priority to dispatch slot restricted
10936 instructions.
10937
10938 @item -msched-costly-dep=@var{dependence_type}
10939 @opindex msched-costly-dep
10940 This option controls which dependences are considered costly
10941 by the target during instruction scheduling.  The argument
10942 @var{dependence_type} takes one of the following values:
10943 @var{no}: no dependence is costly,
10944 @var{all}: all dependences are costly,
10945 @var{true_store_to_load}: a true dependence from store to load is costly,
10946 @var{store_to_load}: any dependence from store to load is costly,
10947 @var{number}: any dependence which latency >= @var{number} is costly.
10948
10949 @item -minsert-sched-nops=@var{scheme}
10950 @opindex minsert-sched-nops
10951 This option controls which nop insertion scheme will be used during
10952 the second scheduling pass.  The argument @var{scheme} takes one of the
10953 following values:
10954 @var{no}: Don't insert nops.
10955 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10956 according to the scheduler's grouping.
10957 @var{regroup_exact}: Insert nops to force costly dependent insns into
10958 separate groups.  Insert exactly as many nops as needed to force an insn
10959 to a new group, according to the estimated processor grouping.
10960 @var{number}: Insert nops to force costly dependent insns into
10961 separate groups.  Insert @var{number} nops to force an insn to a new group.
10962
10963 @item -mcall-sysv
10964 @opindex mcall-sysv
10965 On System V.4 and embedded PowerPC systems compile code using calling
10966 conventions that adheres to the March 1995 draft of the System V
10967 Application Binary Interface, PowerPC processor supplement.  This is the
10968 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10969
10970 @item -mcall-sysv-eabi
10971 @opindex mcall-sysv-eabi
10972 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10973
10974 @item -mcall-sysv-noeabi
10975 @opindex mcall-sysv-noeabi
10976 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10977
10978 @item -mcall-solaris
10979 @opindex mcall-solaris
10980 On System V.4 and embedded PowerPC systems compile code for the Solaris
10981 operating system.
10982
10983 @item -mcall-linux
10984 @opindex mcall-linux
10985 On System V.4 and embedded PowerPC systems compile code for the
10986 Linux-based GNU system.
10987
10988 @item -mcall-gnu
10989 @opindex mcall-gnu
10990 On System V.4 and embedded PowerPC systems compile code for the
10991 Hurd-based GNU system.
10992
10993 @item -mcall-netbsd
10994 @opindex mcall-netbsd
10995 On System V.4 and embedded PowerPC systems compile code for the
10996 NetBSD operating system.
10997
10998 @item -maix-struct-return
10999 @opindex maix-struct-return
11000 Return all structures in memory (as specified by the AIX ABI)@.
11001
11002 @item -msvr4-struct-return
11003 @opindex msvr4-struct-return
11004 Return structures smaller than 8 bytes in registers (as specified by the
11005 SVR4 ABI)@.
11006
11007 @item -mabi=@var{abi-type}
11008 @opindex mabi
11009 Extend the current ABI with a particular extension, or remove such extension.
11010 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11011 @var{no-spe}@.
11012
11013 @item -mprototype
11014 @itemx -mno-prototype
11015 @opindex mprototype
11016 @opindex mno-prototype
11017 On System V.4 and embedded PowerPC systems assume that all calls to
11018 variable argument functions are properly prototyped.  Otherwise, the
11019 compiler must insert an instruction before every non prototyped call to
11020 set or clear bit 6 of the condition code register (@var{CR}) to
11021 indicate whether floating point values were passed in the floating point
11022 registers in case the function takes a variable arguments.  With
11023 @option{-mprototype}, only calls to prototyped variable argument functions
11024 will set or clear the bit.
11025
11026 @item -msim
11027 @opindex msim
11028 On embedded PowerPC systems, assume that the startup module is called
11029 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11030 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11031 configurations.
11032
11033 @item -mmvme
11034 @opindex mmvme
11035 On embedded PowerPC systems, assume that the startup module is called
11036 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11037 @file{libc.a}.
11038
11039 @item -mads
11040 @opindex mads
11041 On embedded PowerPC systems, assume that the startup module is called
11042 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11043 @file{libc.a}.
11044
11045 @item -myellowknife
11046 @opindex myellowknife
11047 On embedded PowerPC systems, assume that the startup module is called
11048 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11049 @file{libc.a}.
11050
11051 @item -mvxworks
11052 @opindex mvxworks
11053 On System V.4 and embedded PowerPC systems, specify that you are
11054 compiling for a VxWorks system.
11055
11056 @item -mwindiss
11057 @opindex mwindiss
11058 Specify that you are compiling for the WindISS simulation environment.
11059
11060 @item -memb
11061 @opindex memb
11062 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11063 header to indicate that @samp{eabi} extended relocations are used.
11064
11065 @item -meabi
11066 @itemx -mno-eabi
11067 @opindex meabi
11068 @opindex mno-eabi
11069 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11070 Embedded Applications Binary Interface (eabi) which is a set of
11071 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11072 means that the stack is aligned to an 8 byte boundary, a function
11073 @code{__eabi} is called to from @code{main} to set up the eabi
11074 environment, and the @option{-msdata} option can use both @code{r2} and
11075 @code{r13} to point to two separate small data areas.  Selecting
11076 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11077 do not call an initialization function from @code{main}, and the
11078 @option{-msdata} option will only use @code{r13} to point to a single
11079 small data area.  The @option{-meabi} option is on by default if you
11080 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11081
11082 @item -msdata=eabi
11083 @opindex msdata=eabi
11084 On System V.4 and embedded PowerPC systems, put small initialized
11085 @code{const} global and static data in the @samp{.sdata2} section, which
11086 is pointed to by register @code{r2}.  Put small initialized
11087 non-@code{const} global and static data in the @samp{.sdata} section,
11088 which is pointed to by register @code{r13}.  Put small uninitialized
11089 global and static data in the @samp{.sbss} section, which is adjacent to
11090 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11091 incompatible with the @option{-mrelocatable} option.  The
11092 @option{-msdata=eabi} option also sets the @option{-memb} option.
11093
11094 @item -msdata=sysv
11095 @opindex msdata=sysv
11096 On System V.4 and embedded PowerPC systems, put small global and static
11097 data in the @samp{.sdata} section, which is pointed to by register
11098 @code{r13}.  Put small uninitialized global and static data in the
11099 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11100 The @option{-msdata=sysv} option is incompatible with the
11101 @option{-mrelocatable} option.
11102
11103 @item -msdata=default
11104 @itemx -msdata
11105 @opindex msdata=default
11106 @opindex msdata
11107 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11108 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11109 same as @option{-msdata=sysv}.
11110
11111 @item -msdata-data
11112 @opindex msdata-data
11113 On System V.4 and embedded PowerPC systems, put small global and static
11114 data in the @samp{.sdata} section.  Put small uninitialized global and
11115 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11116 to address small data however.  This is the default behavior unless
11117 other @option{-msdata} options are used.
11118
11119 @item -msdata=none
11120 @itemx -mno-sdata
11121 @opindex msdata=none
11122 @opindex mno-sdata
11123 On embedded PowerPC systems, put all initialized global and static data
11124 in the @samp{.data} section, and all uninitialized data in the
11125 @samp{.bss} section.
11126
11127 @item -G @var{num}
11128 @opindex G
11129 @cindex smaller data references (PowerPC)
11130 @cindex .sdata/.sdata2 references (PowerPC)
11131 On embedded PowerPC systems, put global and static items less than or
11132 equal to @var{num} bytes into the small data or bss sections instead of
11133 the normal data or bss section.  By default, @var{num} is 8.  The
11134 @option{-G @var{num}} switch is also passed to the linker.
11135 All modules should be compiled with the same @option{-G @var{num}} value.
11136
11137 @item -mregnames
11138 @itemx -mno-regnames
11139 @opindex mregnames
11140 @opindex mno-regnames
11141 On System V.4 and embedded PowerPC systems do (do not) emit register
11142 names in the assembly language output using symbolic forms.
11143
11144 @item -mlongcall
11145 @itemx -mno-longcall
11146 @opindex mlongcall
11147 @opindex mno-longcall
11148 Default to making all function calls indirectly, using a register, so
11149 that functions which reside further than 32 megabytes (33,554,432
11150 bytes) from the current location can be called.  This setting can be
11151 overridden by the @code{shortcall} function attribute, or by
11152 @code{#pragma longcall(0)}.
11153
11154 Some linkers are capable of detecting out-of-range calls and generating
11155 glue code on the fly.  On these systems, long calls are unnecessary and
11156 generate slower code.  As of this writing, the AIX linker can do this,
11157 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11158 to the GNU linker for 32-bit PowerPC systems as well.
11159
11160 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11161 callee, L42'', plus a ``branch island'' (glue code).  The two target
11162 addresses represent the callee and the ``branch island''.  The
11163 Darwin/PPC linker will prefer the first address and generate a ``bl
11164 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11165 otherwise, the linker will generate ``bl L42'' to call the ``branch
11166 island''.  The ``branch island'' is appended to the body of the
11167 calling function; it computes the full 32-bit address of the callee
11168 and jumps to it.
11169
11170 On Mach-O (Darwin) systems, this option directs the compiler emit to
11171 the glue for every direct call, and the Darwin linker decides whether
11172 to use or discard it.
11173
11174 In the future, we may cause GCC to ignore all longcall specifications
11175 when the linker is known to generate glue.
11176
11177 @item -pthread
11178 @opindex pthread
11179 Adds support for multithreading with the @dfn{pthreads} library.
11180 This option sets flags for both the preprocessor and linker.
11181
11182 @end table
11183
11184 @node S/390 and zSeries Options
11185 @subsection S/390 and zSeries Options
11186 @cindex S/390 and zSeries Options
11187
11188 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11189
11190 @table @gcctabopt
11191 @item -mhard-float
11192 @itemx -msoft-float
11193 @opindex mhard-float
11194 @opindex msoft-float
11195 Use (do not use) the hardware floating-point instructions and registers
11196 for floating-point operations.  When @option{-msoft-float} is specified,
11197 functions in @file{libgcc.a} will be used to perform floating-point
11198 operations.  When @option{-mhard-float} is specified, the compiler
11199 generates IEEE floating-point instructions.  This is the default.
11200
11201 @item -mbackchain
11202 @itemx -mno-backchain
11203 @opindex mbackchain
11204 @opindex mno-backchain
11205 Store (do not store) the address of the caller's frame as backchain pointer
11206 into the callee's stack frame.
11207 A backchain may be needed to allow debugging using tools that do not understand
11208 DWARF-2 call frame information.
11209 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11210 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11211 the backchain is placed into the topmost word of the 96/160 byte register
11212 save area.
11213
11214 In general, code compiled with @option{-mbackchain} is call-compatible with
11215 code compiled with @option{-mmo-backchain}; however, use of the backchain
11216 for debugging purposes usually requires that the whole binary is built with
11217 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11218 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11219 to build a linux kernel use @option{-msoft-float}.
11220
11221 The default is to not maintain the backchain.
11222
11223 @item -mpacked-stack
11224 @item -mno-packed-stack
11225 @opindex mpacked-stack
11226 @opindex mno-packed-stack
11227 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11228 specified, the compiler uses the all fields of the 96/160 byte register save
11229 area only for their default purpose; unused fields still take up stack space.
11230 When @option{-mpacked-stack} is specified, register save slots are densely
11231 packed at the top of the register save area; unused space is reused for other
11232 purposes, allowing for more efficient use of the available stack space.
11233 However, when @option{-mbackchain} is also in effect, the topmost word of
11234 the save area is always used to store the backchain, and the return address
11235 register is always saved two words below the backchain.
11236
11237 As long as the stack frame backchain is not used, code generated with
11238 @option{-mpacked-stack} is call-compatible with code generated with
11239 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11240 S/390 or zSeries generated code that uses the stack frame backchain at run
11241 time, not just for debugging purposes.  Such code is not call-compatible
11242 with code compiled with @option{-mpacked-stack}.  Also, note that the
11243 combination of @option{-mbackchain},
11244 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11245 to build a linux kernel use @option{-msoft-float}.
11246
11247 The default is to not use the packed stack layout.
11248
11249 @item -msmall-exec
11250 @itemx -mno-small-exec
11251 @opindex msmall-exec
11252 @opindex mno-small-exec
11253 Generate (or do not generate) code using the @code{bras} instruction
11254 to do subroutine calls.
11255 This only works reliably if the total executable size does not
11256 exceed 64k.  The default is to use the @code{basr} instruction instead,
11257 which does not have this limitation.
11258
11259 @item -m64
11260 @itemx -m31
11261 @opindex m64
11262 @opindex m31
11263 When @option{-m31} is specified, generate code compliant to the
11264 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11265 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11266 particular to generate 64-bit instructions.  For the @samp{s390}
11267 targets, the default is @option{-m31}, while the @samp{s390x}
11268 targets default to @option{-m64}.
11269
11270 @item -mzarch
11271 @itemx -mesa
11272 @opindex mzarch
11273 @opindex mesa
11274 When @option{-mzarch} is specified, generate code using the
11275 instructions available on z/Architecture.
11276 When @option{-mesa} is specified, generate code using the
11277 instructions available on ESA/390.  Note that @option{-mesa} is
11278 not possible with @option{-m64}.
11279 When generating code compliant to the GNU/Linux for S/390 ABI,
11280 the default is @option{-mesa}.  When generating code compliant
11281 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11282
11283 @item -mmvcle
11284 @itemx -mno-mvcle
11285 @opindex mmvcle
11286 @opindex mno-mvcle
11287 Generate (or do not generate) code using the @code{mvcle} instruction
11288 to perform block moves.  When @option{-mno-mvcle} is specified,
11289 use a @code{mvc} loop instead.  This is the default.
11290
11291 @item -mdebug
11292 @itemx -mno-debug
11293 @opindex mdebug
11294 @opindex mno-debug
11295 Print (or do not print) additional debug information when compiling.
11296 The default is to not print debug information.
11297
11298 @item -march=@var{cpu-type}
11299 @opindex march
11300 Generate code that will run on @var{cpu-type}, which is the name of a system
11301 representing a certain processor type.  Possible values for
11302 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11303 When generating code using the instructions available on z/Architecture,
11304 the default is @option{-march=z900}.  Otherwise, the default is
11305 @option{-march=g5}.
11306
11307 @item -mtune=@var{cpu-type}
11308 @opindex mtune
11309 Tune to @var{cpu-type} everything applicable about the generated code,
11310 except for the ABI and the set of available instructions.
11311 The list of @var{cpu-type} values is the same as for @option{-march}.
11312 The default is the value used for @option{-march}.
11313
11314 @item -mtpf-trace
11315 @itemx -mno-tpf-trace
11316 @opindex mtpf-trace
11317 @opindex mno-tpf-trace
11318 Generate code that adds (does not add) in TPF OS specific branches to trace
11319 routines in the operating system.  This option is off by default, even
11320 when compiling for the TPF OS@.
11321
11322 @item -mfused-madd
11323 @itemx -mno-fused-madd
11324 @opindex mfused-madd
11325 @opindex mno-fused-madd
11326 Generate code that uses (does not use) the floating point multiply and
11327 accumulate instructions.  These instructions are generated by default if
11328 hardware floating point is used.
11329
11330 @item -mwarn-framesize=@var{framesize}
11331 @opindex mwarn-framesize
11332 Emit a warning if the current function exceeds the given frame size.  Because
11333 this is a compile time check it doesn't need to be a real problem when the program
11334 runs.  It is intended to identify functions which most probably cause
11335 a stack overflow.  It is useful to be used in an environment with limited stack
11336 size e.g.@: the linux kernel.
11337
11338 @item -mwarn-dynamicstack
11339 @opindex mwarn-dynamicstack
11340 Emit a warning if the function calls alloca or uses dynamically
11341 sized arrays.  This is generally a bad idea with a limited stack size.
11342
11343 @item -mstack-guard=@var{stack-guard}
11344 @item -mstack-size=@var{stack-size}
11345 @opindex mstack-guard
11346 @opindex mstack-size
11347 These arguments always have to be used in conjunction.  If they are present the s390
11348 back end emits additional instructions in the function prologue which trigger a trap
11349 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11350 (remember that the stack on s390 grows downward).  These options are intended to
11351 be used to help debugging stack overflow problems.  The additionally emitted code
11352 cause only little overhead and hence can also be used in production like systems
11353 without greater performance degradation.  The given values have to be exact
11354 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11355 In order to be efficient the extra code makes the assumption that the stack starts
11356 at an address aligned to the value given by @var{stack-size}.
11357 @end table
11358
11359 @node SH Options
11360 @subsection SH Options
11361
11362 These @samp{-m} options are defined for the SH implementations:
11363
11364 @table @gcctabopt
11365 @item -m1
11366 @opindex m1
11367 Generate code for the SH1.
11368
11369 @item -m2
11370 @opindex m2
11371 Generate code for the SH2.
11372
11373 @item -m2e
11374 Generate code for the SH2e.
11375
11376 @item -m3
11377 @opindex m3
11378 Generate code for the SH3.
11379
11380 @item -m3e
11381 @opindex m3e
11382 Generate code for the SH3e.
11383
11384 @item -m4-nofpu
11385 @opindex m4-nofpu
11386 Generate code for the SH4 without a floating-point unit.
11387
11388 @item -m4-single-only
11389 @opindex m4-single-only
11390 Generate code for the SH4 with a floating-point unit that only
11391 supports single-precision arithmetic.
11392
11393 @item -m4-single
11394 @opindex m4-single
11395 Generate code for the SH4 assuming the floating-point unit is in
11396 single-precision mode by default.
11397
11398 @item -m4
11399 @opindex m4
11400 Generate code for the SH4.
11401
11402 @item -m4a-nofpu
11403 @opindex m4a-nofpu
11404 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11405 floating-point unit is not used.
11406
11407 @item -m4a-single-only
11408 @opindex m4a-single-only
11409 Generate code for the SH4a, in such a way that no double-precision
11410 floating point operations are used.
11411
11412 @item -m4a-single
11413 @opindex m4a-single
11414 Generate code for the SH4a assuming the floating-point unit is in
11415 single-precision mode by default.
11416
11417 @item -m4a
11418 @opindex m4a
11419 Generate code for the SH4a.
11420
11421 @item -m4al
11422 @opindex m4al
11423 Same as @option{-m4a-nofpu}, except that it implicitly passes
11424 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11425 instructions at the moment.
11426
11427 @item -mb
11428 @opindex mb
11429 Compile code for the processor in big endian mode.
11430
11431 @item -ml
11432 @opindex ml
11433 Compile code for the processor in little endian mode.
11434
11435 @item -mdalign
11436 @opindex mdalign
11437 Align doubles at 64-bit boundaries.  Note that this changes the calling
11438 conventions, and thus some functions from the standard C library will
11439 not work unless you recompile it first with @option{-mdalign}.
11440
11441 @item -mrelax
11442 @opindex mrelax
11443 Shorten some address references at link time, when possible; uses the
11444 linker option @option{-relax}.
11445
11446 @item -mbigtable
11447 @opindex mbigtable
11448 Use 32-bit offsets in @code{switch} tables.  The default is to use
11449 16-bit offsets.
11450
11451 @item -mfmovd
11452 @opindex mfmovd
11453 Enable the use of the instruction @code{fmovd}.
11454
11455 @item -mhitachi
11456 @opindex mhitachi
11457 Comply with the calling conventions defined by Renesas.
11458
11459 @item -mrenesas
11460 @opindex mhitachi
11461 Comply with the calling conventions defined by Renesas.
11462
11463 @item -mno-renesas
11464 @opindex mhitachi
11465 Comply with the calling conventions defined for GCC before the Renesas
11466 conventions were available.  This option is the default for all
11467 targets of the SH toolchain except for @samp{sh-symbianelf}.
11468
11469 @item -mnomacsave
11470 @opindex mnomacsave
11471 Mark the @code{MAC} register as call-clobbered, even if
11472 @option{-mhitachi} is given.
11473
11474 @item -mieee
11475 @opindex mieee
11476 Increase IEEE-compliance of floating-point code.
11477
11478 @item -misize
11479 @opindex misize
11480 Dump instruction size and location in the assembly code.
11481
11482 @item -mpadstruct
11483 @opindex mpadstruct
11484 This option is deprecated.  It pads structures to multiple of 4 bytes,
11485 which is incompatible with the SH ABI@.
11486
11487 @item -mspace
11488 @opindex mspace
11489 Optimize for space instead of speed.  Implied by @option{-Os}.
11490
11491 @item -mprefergot
11492 @opindex mprefergot
11493 When generating position-independent code, emit function calls using
11494 the Global Offset Table instead of the Procedure Linkage Table.
11495
11496 @item -musermode
11497 @opindex musermode
11498 Generate a library function call to invalidate instruction cache
11499 entries, after fixing up a trampoline.  This library function call
11500 doesn't assume it can write to the whole memory address space.  This
11501 is the default when the target is @code{sh-*-linux*}.
11502 @end table
11503
11504 @node SPARC Options
11505 @subsection SPARC Options
11506 @cindex SPARC options
11507
11508 These @samp{-m} options are supported on the SPARC:
11509
11510 @table @gcctabopt
11511 @item -mno-app-regs
11512 @itemx -mapp-regs
11513 @opindex mno-app-regs
11514 @opindex mapp-regs
11515 Specify @option{-mapp-regs} to generate output using the global registers
11516 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11517 is the default, except on Solaris.
11518
11519 To be fully SVR4 ABI compliant at the cost of some performance loss,
11520 specify @option{-mno-app-regs}.  You should compile libraries and system
11521 software with this option.
11522
11523 @item -mfpu
11524 @itemx -mhard-float
11525 @opindex mfpu
11526 @opindex mhard-float
11527 Generate output containing floating point instructions.  This is the
11528 default.
11529
11530 @item -mno-fpu
11531 @itemx -msoft-float
11532 @opindex mno-fpu
11533 @opindex msoft-float
11534 Generate output containing library calls for floating point.
11535 @strong{Warning:} the requisite libraries are not available for all SPARC
11536 targets.  Normally the facilities of the machine's usual C compiler are
11537 used, but this cannot be done directly in cross-compilation.  You must make
11538 your own arrangements to provide suitable library functions for
11539 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11540 @samp{sparclite-*-*} do provide software floating point support.
11541
11542 @option{-msoft-float} changes the calling convention in the output file;
11543 therefore, it is only useful if you compile @emph{all} of a program with
11544 this option.  In particular, you need to compile @file{libgcc.a}, the
11545 library that comes with GCC, with @option{-msoft-float} in order for
11546 this to work.
11547
11548 @item -mhard-quad-float
11549 @opindex mhard-quad-float
11550 Generate output containing quad-word (long double) floating point
11551 instructions.
11552
11553 @item -msoft-quad-float
11554 @opindex msoft-quad-float
11555 Generate output containing library calls for quad-word (long double)
11556 floating point instructions.  The functions called are those specified
11557 in the SPARC ABI@.  This is the default.
11558
11559 As of this writing, there are no SPARC implementations that have hardware
11560 support for the quad-word floating point instructions.  They all invoke
11561 a trap handler for one of these instructions, and then the trap handler
11562 emulates the effect of the instruction.  Because of the trap handler overhead,
11563 this is much slower than calling the ABI library routines.  Thus the
11564 @option{-msoft-quad-float} option is the default.
11565
11566 @item -mno-unaligned-doubles
11567 @itemx -munaligned-doubles
11568 @opindex mno-unaligned-doubles
11569 @opindex munaligned-doubles
11570 Assume that doubles have 8 byte alignment.  This is the default.
11571
11572 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11573 alignment only if they are contained in another type, or if they have an
11574 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11575 Specifying this option avoids some rare compatibility problems with code
11576 generated by other compilers.  It is not the default because it results
11577 in a performance loss, especially for floating point code.
11578
11579 @item -mno-faster-structs
11580 @itemx -mfaster-structs
11581 @opindex mno-faster-structs
11582 @opindex mfaster-structs
11583 With @option{-mfaster-structs}, the compiler assumes that structures
11584 should have 8 byte alignment.  This enables the use of pairs of
11585 @code{ldd} and @code{std} instructions for copies in structure
11586 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11587 However, the use of this changed alignment directly violates the SPARC
11588 ABI@.  Thus, it's intended only for use on targets where the developer
11589 acknowledges that their resulting code will not be directly in line with
11590 the rules of the ABI@.
11591
11592 @item -mimpure-text
11593 @opindex mimpure-text
11594 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11595 the compiler to not pass @option{-z text} to the linker when linking a
11596 shared object.  Using this option, you can link position-dependent
11597 code into a shared object.
11598
11599 @option{-mimpure-text} suppresses the ``relocations remain against
11600 allocatable but non-writable sections'' linker error message.
11601 However, the necessary relocations will trigger copy-on-write, and the
11602 shared object is not actually shared across processes.  Instead of
11603 using @option{-mimpure-text}, you should compile all source code with
11604 @option{-fpic} or @option{-fPIC}.
11605
11606 This option is only available on SunOS and Solaris.
11607
11608 @item -mcpu=@var{cpu_type}
11609 @opindex mcpu
11610 Set the instruction set, register set, and instruction scheduling parameters
11611 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11612 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11613 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11614 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11615 @samp{ultrasparc3}.
11616
11617 Default instruction scheduling parameters are used for values that select
11618 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11619 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11620
11621 Here is a list of each supported architecture and their supported
11622 implementations.
11623
11624 @smallexample
11625     v7:             cypress
11626     v8:             supersparc, hypersparc
11627     sparclite:      f930, f934, sparclite86x
11628     sparclet:       tsc701
11629     v9:             ultrasparc, ultrasparc3
11630 @end smallexample
11631
11632 By default (unless configured otherwise), GCC generates code for the V7
11633 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11634 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11635 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11636 SPARCStation 1, 2, IPX etc.
11637
11638 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11639 architecture.  The only difference from V7 code is that the compiler emits
11640 the integer multiply and integer divide instructions which exist in SPARC-V8
11641 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11642 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11643 2000 series.
11644
11645 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11646 the SPARC architecture.  This adds the integer multiply, integer divide step
11647 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11648 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11649 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11650 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11651 MB86934 chip, which is the more recent SPARClite with FPU@.
11652
11653 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11654 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11655 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11656 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11657 optimizes it for the TEMIC SPARClet chip.
11658
11659 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11660 architecture.  This adds 64-bit integer and floating-point move instructions,
11661 3 additional floating-point condition code registers and conditional move
11662 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11663 optimizes it for the Sun UltraSPARC I/II chips.  With
11664 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11665 Sun UltraSPARC III chip.
11666
11667 @item -mtune=@var{cpu_type}
11668 @opindex mtune
11669 Set the instruction scheduling parameters for machine type
11670 @var{cpu_type}, but do not set the instruction set or register set that the
11671 option @option{-mcpu=@var{cpu_type}} would.
11672
11673 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11674 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11675 that select a particular cpu implementation.  Those are @samp{cypress},
11676 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11677 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11678 @samp{ultrasparc3}.
11679
11680 @item -mv8plus
11681 @itemx -mno-v8plus
11682 @opindex mv8plus
11683 @opindex mno-v8plus
11684 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11685 difference from the V8 ABI is that the global and out registers are
11686 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11687 mode for all SPARC-V9 processors.
11688
11689 @item -mvis
11690 @itemx -mno-vis
11691 @opindex mvis
11692 @opindex mno-vis
11693 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11694 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11695 @end table
11696
11697 These @samp{-m} options are supported in addition to the above
11698 on SPARC-V9 processors in 64-bit environments:
11699
11700 @table @gcctabopt
11701 @item -mlittle-endian
11702 @opindex mlittle-endian
11703 Generate code for a processor running in little-endian mode.  It is only
11704 available for a few configurations and most notably not on Solaris and Linux.
11705
11706 @item -m32
11707 @itemx -m64
11708 @opindex m32
11709 @opindex m64
11710 Generate code for a 32-bit or 64-bit environment.
11711 The 32-bit environment sets int, long and pointer to 32 bits.
11712 The 64-bit environment sets int to 32 bits and long and pointer
11713 to 64 bits.
11714
11715 @item -mcmodel=medlow
11716 @opindex mcmodel=medlow
11717 Generate code for the Medium/Low code model: 64-bit addresses, programs
11718 must be linked in the low 32 bits of memory.  Programs can be statically
11719 or dynamically linked.
11720
11721 @item -mcmodel=medmid
11722 @opindex mcmodel=medmid
11723 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11724 must be linked in the low 44 bits of memory, the text and data segments must
11725 be less than 2GB in size and the data segment must be located within 2GB of
11726 the text segment.
11727
11728 @item -mcmodel=medany
11729 @opindex mcmodel=medany
11730 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11731 may be linked anywhere in memory, the text and data segments must be less
11732 than 2GB in size and the data segment must be located within 2GB of the
11733 text segment.
11734
11735 @item -mcmodel=embmedany
11736 @opindex mcmodel=embmedany
11737 Generate code for the Medium/Anywhere code model for embedded systems:
11738 64-bit addresses, the text and data segments must be less than 2GB in
11739 size, both starting anywhere in memory (determined at link time).  The
11740 global register %g4 points to the base of the data segment.  Programs
11741 are statically linked and PIC is not supported.
11742
11743 @item -mstack-bias
11744 @itemx -mno-stack-bias
11745 @opindex mstack-bias
11746 @opindex mno-stack-bias
11747 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11748 frame pointer if present, are offset by @minus{}2047 which must be added back
11749 when making stack frame references.  This is the default in 64-bit mode.
11750 Otherwise, assume no such offset is present.
11751 @end table
11752
11753 These switches are supported in addition to the above on Solaris:
11754
11755 @table @gcctabopt
11756 @item -threads
11757 @opindex threads
11758 Add support for multithreading using the Solaris threads library.  This
11759 option sets flags for both the preprocessor and linker.  This option does
11760 not affect the thread safety of object code produced by the compiler or
11761 that of libraries supplied with it.
11762
11763 @item -pthreads
11764 @opindex pthreads
11765 Add support for multithreading using the POSIX threads library.  This
11766 option sets flags for both the preprocessor and linker.  This option does
11767 not affect the thread safety of object code produced  by the compiler or
11768 that of libraries supplied with it.
11769 @end table
11770
11771 @node System V Options
11772 @subsection Options for System V
11773
11774 These additional options are available on System V Release 4 for
11775 compatibility with other compilers on those systems:
11776
11777 @table @gcctabopt
11778 @item -G
11779 @opindex G
11780 Create a shared object.
11781 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11782
11783 @item -Qy
11784 @opindex Qy
11785 Identify the versions of each tool used by the compiler, in a
11786 @code{.ident} assembler directive in the output.
11787
11788 @item -Qn
11789 @opindex Qn
11790 Refrain from adding @code{.ident} directives to the output file (this is
11791 the default).
11792
11793 @item -YP,@var{dirs}
11794 @opindex YP
11795 Search the directories @var{dirs}, and no others, for libraries
11796 specified with @option{-l}.
11797
11798 @item -Ym,@var{dir}
11799 @opindex Ym
11800 Look in the directory @var{dir} to find the M4 preprocessor.
11801 The assembler uses this option.
11802 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11803 @c the generic assembler that comes with Solaris takes just -Ym.
11804 @end table
11805
11806 @node TMS320C3x/C4x Options
11807 @subsection TMS320C3x/C4x Options
11808 @cindex TMS320C3x/C4x Options
11809
11810 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11811
11812 @table @gcctabopt
11813
11814 @item -mcpu=@var{cpu_type}
11815 @opindex mcpu
11816 Set the instruction set, register set, and instruction scheduling
11817 parameters for machine type @var{cpu_type}.  Supported values for
11818 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11819 @samp{c44}.  The default is @samp{c40} to generate code for the
11820 TMS320C40.
11821
11822 @item -mbig-memory
11823 @itemx -mbig
11824 @itemx -msmall-memory
11825 @itemx -msmall
11826 @opindex mbig-memory
11827 @opindex mbig
11828 @opindex msmall-memory
11829 @opindex msmall
11830 Generates code for the big or small memory model.  The small memory
11831 model assumed that all data fits into one 64K word page.  At run-time
11832 the data page (DP) register must be set to point to the 64K page
11833 containing the .bss and .data program sections.  The big memory model is
11834 the default and requires reloading of the DP register for every direct
11835 memory access.
11836
11837 @item -mbk
11838 @itemx -mno-bk
11839 @opindex mbk
11840 @opindex mno-bk
11841 Allow (disallow) allocation of general integer operands into the block
11842 count register BK@.
11843
11844 @item -mdb
11845 @itemx -mno-db
11846 @opindex mdb
11847 @opindex mno-db
11848 Enable (disable) generation of code using decrement and branch,
11849 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11850 on the safe side, this is disabled for the C3x, since the maximum
11851 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11852 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11853 that it can utilize the decrement and branch instruction, but will give
11854 up if there is more than one memory reference in the loop.  Thus a loop
11855 where the loop counter is decremented can generate slightly more
11856 efficient code, in cases where the RPTB instruction cannot be utilized.
11857
11858 @item -mdp-isr-reload
11859 @itemx -mparanoid
11860 @opindex mdp-isr-reload
11861 @opindex mparanoid
11862 Force the DP register to be saved on entry to an interrupt service
11863 routine (ISR), reloaded to point to the data section, and restored on
11864 exit from the ISR@.  This should not be required unless someone has
11865 violated the small memory model by modifying the DP register, say within
11866 an object library.
11867
11868 @item -mmpyi
11869 @itemx -mno-mpyi
11870 @opindex mmpyi
11871 @opindex mno-mpyi
11872 For the C3x use the 24-bit MPYI instruction for integer multiplies
11873 instead of a library call to guarantee 32-bit results.  Note that if one
11874 of the operands is a constant, then the multiplication will be performed
11875 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11876 then squaring operations are performed inline instead of a library call.
11877
11878 @item -mfast-fix
11879 @itemx -mno-fast-fix
11880 @opindex mfast-fix
11881 @opindex mno-fast-fix
11882 The C3x/C4x FIX instruction to convert a floating point value to an
11883 integer value chooses the nearest integer less than or equal to the
11884 floating point value rather than to the nearest integer.  Thus if the
11885 floating point number is negative, the result will be incorrectly
11886 truncated an additional code is necessary to detect and correct this
11887 case.  This option can be used to disable generation of the additional
11888 code required to correct the result.
11889
11890 @item -mrptb
11891 @itemx -mno-rptb
11892 @opindex mrptb
11893 @opindex mno-rptb
11894 Enable (disable) generation of repeat block sequences using the RPTB
11895 instruction for zero overhead looping.  The RPTB construct is only used
11896 for innermost loops that do not call functions or jump across the loop
11897 boundaries.  There is no advantage having nested RPTB loops due to the
11898 overhead required to save and restore the RC, RS, and RE registers.
11899 This is enabled by default with @option{-O2}.
11900
11901 @item -mrpts=@var{count}
11902 @itemx -mno-rpts
11903 @opindex mrpts
11904 @opindex mno-rpts
11905 Enable (disable) the use of the single instruction repeat instruction
11906 RPTS@.  If a repeat block contains a single instruction, and the loop
11907 count can be guaranteed to be less than the value @var{count}, GCC will
11908 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11909 then a RPTS will be emitted even if the loop count cannot be determined
11910 at compile time.  Note that the repeated instruction following RPTS does
11911 not have to be reloaded from memory each iteration, thus freeing up the
11912 CPU buses for operands.  However, since interrupts are blocked by this
11913 instruction, it is disabled by default.
11914
11915 @item -mloop-unsigned
11916 @itemx -mno-loop-unsigned
11917 @opindex mloop-unsigned
11918 @opindex mno-loop-unsigned
11919 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11920 is @math{2^{31} + 1} since these instructions test if the iteration count is
11921 negative to terminate the loop.  If the iteration count is unsigned
11922 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11923 exceeded.  This switch allows an unsigned iteration count.
11924
11925 @item -mti
11926 @opindex mti
11927 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11928 with.  This also enforces compatibility with the API employed by the TI
11929 C3x C compiler.  For example, long doubles are passed as structures
11930 rather than in floating point registers.
11931
11932 @item -mregparm
11933 @itemx -mmemparm
11934 @opindex mregparm
11935 @opindex mmemparm
11936 Generate code that uses registers (stack) for passing arguments to functions.
11937 By default, arguments are passed in registers where possible rather
11938 than by pushing arguments on to the stack.
11939
11940 @item -mparallel-insns
11941 @itemx -mno-parallel-insns
11942 @opindex mparallel-insns
11943 @opindex mno-parallel-insns
11944 Allow the generation of parallel instructions.  This is enabled by
11945 default with @option{-O2}.
11946
11947 @item -mparallel-mpy
11948 @itemx -mno-parallel-mpy
11949 @opindex mparallel-mpy
11950 @opindex mno-parallel-mpy
11951 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11952 provided @option{-mparallel-insns} is also specified.  These instructions have
11953 tight register constraints which can pessimize the code generation
11954 of large functions.
11955
11956 @end table
11957
11958 @node V850 Options
11959 @subsection V850 Options
11960 @cindex V850 Options
11961
11962 These @samp{-m} options are defined for V850 implementations:
11963
11964 @table @gcctabopt
11965 @item -mlong-calls
11966 @itemx -mno-long-calls
11967 @opindex mlong-calls
11968 @opindex mno-long-calls
11969 Treat all calls as being far away (near).  If calls are assumed to be
11970 far away, the compiler will always load the functions address up into a
11971 register, and call indirect through the pointer.
11972
11973 @item -mno-ep
11974 @itemx -mep
11975 @opindex mno-ep
11976 @opindex mep
11977 Do not optimize (do optimize) basic blocks that use the same index
11978 pointer 4 or more times to copy pointer into the @code{ep} register, and
11979 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11980 option is on by default if you optimize.
11981
11982 @item -mno-prolog-function
11983 @itemx -mprolog-function
11984 @opindex mno-prolog-function
11985 @opindex mprolog-function
11986 Do not use (do use) external functions to save and restore registers
11987 at the prologue and epilogue of a function.  The external functions
11988 are slower, but use less code space if more than one function saves
11989 the same number of registers.  The @option{-mprolog-function} option
11990 is on by default if you optimize.
11991
11992 @item -mspace
11993 @opindex mspace
11994 Try to make the code as small as possible.  At present, this just turns
11995 on the @option{-mep} and @option{-mprolog-function} options.
11996
11997 @item -mtda=@var{n}
11998 @opindex mtda
11999 Put static or global variables whose size is @var{n} bytes or less into
12000 the tiny data area that register @code{ep} points to.  The tiny data
12001 area can hold up to 256 bytes in total (128 bytes for byte references).
12002
12003 @item -msda=@var{n}
12004 @opindex msda
12005 Put static or global variables whose size is @var{n} bytes or less into
12006 the small data area that register @code{gp} points to.  The small data
12007 area can hold up to 64 kilobytes.
12008
12009 @item -mzda=@var{n}
12010 @opindex mzda
12011 Put static or global variables whose size is @var{n} bytes or less into
12012 the first 32 kilobytes of memory.
12013
12014 @item -mv850
12015 @opindex mv850
12016 Specify that the target processor is the V850.
12017
12018 @item -mbig-switch
12019 @opindex mbig-switch
12020 Generate code suitable for big switch tables.  Use this option only if
12021 the assembler/linker complain about out of range branches within a switch
12022 table.
12023
12024 @item -mapp-regs
12025 @opindex mapp-regs
12026 This option will cause r2 and r5 to be used in the code generated by
12027 the compiler.  This setting is the default.
12028
12029 @item -mno-app-regs
12030 @opindex mno-app-regs
12031 This option will cause r2 and r5 to be treated as fixed registers.
12032
12033 @item -mv850e1
12034 @opindex mv850e1
12035 Specify that the target processor is the V850E1.  The preprocessor
12036 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12037 this option is used.
12038
12039 @item -mv850e
12040 @opindex mv850e
12041 Specify that the target processor is the V850E@.  The preprocessor
12042 constant @samp{__v850e__} will be defined if this option is used.
12043
12044 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12045 are defined then a default target processor will be chosen and the
12046 relevant @samp{__v850*__} preprocessor constant will be defined.
12047
12048 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12049 defined, regardless of which processor variant is the target.
12050
12051 @item -mdisable-callt
12052 @opindex mdisable-callt
12053 This option will suppress generation of the CALLT instruction for the
12054 v850e and v850e1 flavors of the v850 architecture.  The default is
12055 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12056
12057 @end table
12058
12059 @node VAX Options
12060 @subsection VAX Options
12061 @cindex VAX options
12062
12063 These @samp{-m} options are defined for the VAX:
12064
12065 @table @gcctabopt
12066 @item -munix
12067 @opindex munix
12068 Do not output certain jump instructions (@code{aobleq} and so on)
12069 that the Unix assembler for the VAX cannot handle across long
12070 ranges.
12071
12072 @item -mgnu
12073 @opindex mgnu
12074 Do output those jump instructions, on the assumption that you
12075 will assemble with the GNU assembler.
12076
12077 @item -mg
12078 @opindex mg
12079 Output code for g-format floating point numbers instead of d-format.
12080 @end table
12081
12082 @node x86-64 Options
12083 @subsection x86-64 Options
12084 @cindex x86-64 options
12085
12086 These are listed under @xref{i386 and x86-64 Options}.
12087
12088 @node Xstormy16 Options
12089 @subsection Xstormy16 Options
12090 @cindex Xstormy16 Options
12091
12092 These options are defined for Xstormy16:
12093
12094 @table @gcctabopt
12095 @item -msim
12096 @opindex msim
12097 Choose startup files and linker script suitable for the simulator.
12098 @end table
12099
12100 @node Xtensa Options
12101 @subsection Xtensa Options
12102 @cindex Xtensa Options
12103
12104 These options are supported for Xtensa targets:
12105
12106 @table @gcctabopt
12107 @item -mconst16
12108 @itemx -mno-const16
12109 @opindex mconst16
12110 @opindex mno-const16
12111 Enable or disable use of @code{CONST16} instructions for loading
12112 constant values.  The @code{CONST16} instruction is currently not a
12113 standard option from Tensilica.  When enabled, @code{CONST16}
12114 instructions are always used in place of the standard @code{L32R}
12115 instructions.  The use of @code{CONST16} is enabled by default only if
12116 the @code{L32R} instruction is not available.
12117
12118 @item -mfused-madd
12119 @itemx -mno-fused-madd
12120 @opindex mfused-madd
12121 @opindex mno-fused-madd
12122 Enable or disable use of fused multiply/add and multiply/subtract
12123 instructions in the floating-point option.  This has no effect if the
12124 floating-point option is not also enabled.  Disabling fused multiply/add
12125 and multiply/subtract instructions forces the compiler to use separate
12126 instructions for the multiply and add/subtract operations.  This may be
12127 desirable in some cases where strict IEEE 754-compliant results are
12128 required: the fused multiply add/subtract instructions do not round the
12129 intermediate result, thereby producing results with @emph{more} bits of
12130 precision than specified by the IEEE standard.  Disabling fused multiply
12131 add/subtract instructions also ensures that the program output is not
12132 sensitive to the compiler's ability to combine multiply and add/subtract
12133 operations.
12134
12135 @item -mtext-section-literals
12136 @itemx -mno-text-section-literals
12137 @opindex mtext-section-literals
12138 @opindex mno-text-section-literals
12139 Control the treatment of literal pools.  The default is
12140 @option{-mno-text-section-literals}, which places literals in a separate
12141 section in the output file.  This allows the literal pool to be placed
12142 in a data RAM/ROM, and it also allows the linker to combine literal
12143 pools from separate object files to remove redundant literals and
12144 improve code size.  With @option{-mtext-section-literals}, the literals
12145 are interspersed in the text section in order to keep them as close as
12146 possible to their references.  This may be necessary for large assembly
12147 files.
12148
12149 @item -mtarget-align
12150 @itemx -mno-target-align
12151 @opindex mtarget-align
12152 @opindex mno-target-align
12153 When this option is enabled, GCC instructs the assembler to
12154 automatically align instructions to reduce branch penalties at the
12155 expense of some code density.  The assembler attempts to widen density
12156 instructions to align branch targets and the instructions following call
12157 instructions.  If there are not enough preceding safe density
12158 instructions to align a target, no widening will be performed.  The
12159 default is @option{-mtarget-align}.  These options do not affect the
12160 treatment of auto-aligned instructions like @code{LOOP}, which the
12161 assembler will always align, either by widening density instructions or
12162 by inserting no-op instructions.
12163
12164 @item -mlongcalls
12165 @itemx -mno-longcalls
12166 @opindex mlongcalls
12167 @opindex mno-longcalls
12168 When this option is enabled, GCC instructs the assembler to translate
12169 direct calls to indirect calls unless it can determine that the target
12170 of a direct call is in the range allowed by the call instruction.  This
12171 translation typically occurs for calls to functions in other source
12172 files.  Specifically, the assembler translates a direct @code{CALL}
12173 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12174 The default is @option{-mno-longcalls}.  This option should be used in
12175 programs where the call target can potentially be out of range.  This
12176 option is implemented in the assembler, not the compiler, so the
12177 assembly code generated by GCC will still show direct call
12178 instructions---look at the disassembled object code to see the actual
12179 instructions.  Note that the assembler will use an indirect call for
12180 every cross-file call, not just those that really will be out of range.
12181 @end table
12182
12183 @node zSeries Options
12184 @subsection zSeries Options
12185 @cindex zSeries options
12186
12187 These are listed under @xref{S/390 and zSeries Options}.
12188
12189 @node Code Gen Options
12190 @section Options for Code Generation Conventions
12191 @cindex code generation conventions
12192 @cindex options, code generation
12193 @cindex run-time options
12194
12195 These machine-independent options control the interface conventions
12196 used in code generation.
12197
12198 Most of them have both positive and negative forms; the negative form
12199 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12200 one of the forms is listed---the one which is not the default.  You
12201 can figure out the other form by either removing @samp{no-} or adding
12202 it.
12203
12204 @table @gcctabopt
12205 @item -fbounds-check
12206 @opindex fbounds-check
12207 For front-ends that support it, generate additional code to check that
12208 indices used to access arrays are within the declared range.  This is
12209 currently only supported by the Java and Fortran 77 front-ends, where
12210 this option defaults to true and false respectively.
12211
12212 @item -ftrapv
12213 @opindex ftrapv
12214 This option generates traps for signed overflow on addition, subtraction,
12215 multiplication operations.
12216
12217 @item -fwrapv
12218 @opindex fwrapv
12219 This option instructs the compiler to assume that signed arithmetic
12220 overflow of addition, subtraction and multiplication wraps around
12221 using twos-complement representation.  This flag enables some optimizations
12222 and disables other.  This option is enabled by default for the Java
12223 front-end, as required by the Java language specification.
12224
12225 @item -fexceptions
12226 @opindex fexceptions
12227 Enable exception handling.  Generates extra code needed to propagate
12228 exceptions.  For some targets, this implies GCC will generate frame
12229 unwind information for all functions, which can produce significant data
12230 size overhead, although it does not affect execution.  If you do not
12231 specify this option, GCC will enable it by default for languages like
12232 C++ which normally require exception handling, and disable it for
12233 languages like C that do not normally require it.  However, you may need
12234 to enable this option when compiling C code that needs to interoperate
12235 properly with exception handlers written in C++.  You may also wish to
12236 disable this option if you are compiling older C++ programs that don't
12237 use exception handling.
12238
12239 @item -fnon-call-exceptions
12240 @opindex fnon-call-exceptions
12241 Generate code that allows trapping instructions to throw exceptions.
12242 Note that this requires platform-specific runtime support that does
12243 not exist everywhere.  Moreover, it only allows @emph{trapping}
12244 instructions to throw exceptions, i.e.@: memory references or floating
12245 point instructions.  It does not allow exceptions to be thrown from
12246 arbitrary signal handlers such as @code{SIGALRM}.
12247
12248 @item -funwind-tables
12249 @opindex funwind-tables
12250 Similar to @option{-fexceptions}, except that it will just generate any needed
12251 static data, but will not affect the generated code in any other way.
12252 You will normally not enable this option; instead, a language processor
12253 that needs this handling would enable it on your behalf.
12254
12255 @item -fasynchronous-unwind-tables
12256 @opindex fasynchronous-unwind-tables
12257 Generate unwind table in dwarf2 format, if supported by target machine.  The
12258 table is exact at each instruction boundary, so it can be used for stack
12259 unwinding from asynchronous events (such as debugger or garbage collector).
12260
12261 @item -fpcc-struct-return
12262 @opindex fpcc-struct-return
12263 Return ``short'' @code{struct} and @code{union} values in memory like
12264 longer ones, rather than in registers.  This convention is less
12265 efficient, but it has the advantage of allowing intercallability between
12266 GCC-compiled files and files compiled with other compilers, particularly
12267 the Portable C Compiler (pcc).
12268
12269 The precise convention for returning structures in memory depends
12270 on the target configuration macros.
12271
12272 Short structures and unions are those whose size and alignment match
12273 that of some integer type.
12274
12275 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12276 switch is not binary compatible with code compiled with the
12277 @option{-freg-struct-return} switch.
12278 Use it to conform to a non-default application binary interface.
12279
12280 @item -freg-struct-return
12281 @opindex freg-struct-return
12282 Return @code{struct} and @code{union} values in registers when possible.
12283 This is more efficient for small structures than
12284 @option{-fpcc-struct-return}.
12285
12286 If you specify neither @option{-fpcc-struct-return} nor
12287 @option{-freg-struct-return}, GCC defaults to whichever convention is
12288 standard for the target.  If there is no standard convention, GCC
12289 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12290 the principal compiler.  In those cases, we can choose the standard, and
12291 we chose the more efficient register return alternative.
12292
12293 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12294 switch is not binary compatible with code compiled with the
12295 @option{-fpcc-struct-return} switch.
12296 Use it to conform to a non-default application binary interface.
12297
12298 @item -fshort-enums
12299 @opindex fshort-enums
12300 Allocate to an @code{enum} type only as many bytes as it needs for the
12301 declared range of possible values.  Specifically, the @code{enum} type
12302 will be equivalent to the smallest integer type which has enough room.
12303
12304 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12305 code that is not binary compatible with code generated without that switch.
12306 Use it to conform to a non-default application binary interface.
12307
12308 @item -fshort-double
12309 @opindex fshort-double
12310 Use the same size for @code{double} as for @code{float}.
12311
12312 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12313 code that is not binary compatible with code generated without that switch.
12314 Use it to conform to a non-default application binary interface.
12315
12316 @item -fshort-wchar
12317 @opindex fshort-wchar
12318 Override the underlying type for @samp{wchar_t} to be @samp{short
12319 unsigned int} instead of the default for the target.  This option is
12320 useful for building programs to run under WINE@.
12321
12322 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12323 code that is not binary compatible with code generated without that switch.
12324 Use it to conform to a non-default application binary interface.
12325
12326 @item -fshared-data
12327 @opindex fshared-data
12328 Requests that the data and non-@code{const} variables of this
12329 compilation be shared data rather than private data.  The distinction
12330 makes sense only on certain operating systems, where shared data is
12331 shared between processes running the same program, while private data
12332 exists in one copy per process.
12333
12334 @item -fno-common
12335 @opindex fno-common
12336 In C, allocate even uninitialized global variables in the data section of the
12337 object file, rather than generating them as common blocks.  This has the
12338 effect that if the same variable is declared (without @code{extern}) in
12339 two different compilations, you will get an error when you link them.
12340 The only reason this might be useful is if you wish to verify that the
12341 program will work on other systems which always work this way.
12342
12343 @item -fno-ident
12344 @opindex fno-ident
12345 Ignore the @samp{#ident} directive.
12346
12347 @item -finhibit-size-directive
12348 @opindex finhibit-size-directive
12349 Don't output a @code{.size} assembler directive, or anything else that
12350 would cause trouble if the function is split in the middle, and the
12351 two halves are placed at locations far apart in memory.  This option is
12352 used when compiling @file{crtstuff.c}; you should not need to use it
12353 for anything else.
12354
12355 @item -fverbose-asm
12356 @opindex fverbose-asm
12357 Put extra commentary information in the generated assembly code to
12358 make it more readable.  This option is generally only of use to those
12359 who actually need to read the generated assembly code (perhaps while
12360 debugging the compiler itself).
12361
12362 @option{-fno-verbose-asm}, the default, causes the
12363 extra information to be omitted and is useful when comparing two assembler
12364 files.
12365
12366 @item -fpic
12367 @opindex fpic
12368 @cindex global offset table
12369 @cindex PIC
12370 Generate position-independent code (PIC) suitable for use in a shared
12371 library, if supported for the target machine.  Such code accesses all
12372 constant addresses through a global offset table (GOT)@.  The dynamic
12373 loader resolves the GOT entries when the program starts (the dynamic
12374 loader is not part of GCC; it is part of the operating system).  If
12375 the GOT size for the linked executable exceeds a machine-specific
12376 maximum size, you get an error message from the linker indicating that
12377 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12378 instead.  (These maximums are 8k on the SPARC and 32k
12379 on the m68k and RS/6000.  The 386 has no such limit.)
12380
12381 Position-independent code requires special support, and therefore works
12382 only on certain machines.  For the 386, GCC supports PIC for System V
12383 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12384 position-independent.
12385
12386 @item -fPIC
12387 @opindex fPIC
12388 If supported for the target machine, emit position-independent code,
12389 suitable for dynamic linking and avoiding any limit on the size of the
12390 global offset table.  This option makes a difference on the m68k,
12391 PowerPC and SPARC@.
12392
12393 Position-independent code requires special support, and therefore works
12394 only on certain machines.
12395
12396 @item -fpie
12397 @itemx -fPIE
12398 @opindex fpie
12399 @opindex fPIE
12400 These options are similar to @option{-fpic} and @option{-fPIC}, but
12401 generated position independent code can be only linked into executables.
12402 Usually these options are used when @option{-pie} GCC option will be
12403 used during linking.
12404
12405 @item -ffixed-@var{reg}
12406 @opindex ffixed
12407 Treat the register named @var{reg} as a fixed register; generated code
12408 should never refer to it (except perhaps as a stack pointer, frame
12409 pointer or in some other fixed role).
12410
12411 @var{reg} must be the name of a register.  The register names accepted
12412 are machine-specific and are defined in the @code{REGISTER_NAMES}
12413 macro in the machine description macro file.
12414
12415 This flag does not have a negative form, because it specifies a
12416 three-way choice.
12417
12418 @item -fcall-used-@var{reg}
12419 @opindex fcall-used
12420 Treat the register named @var{reg} as an allocable register that is
12421 clobbered by function calls.  It may be allocated for temporaries or
12422 variables that do not live across a call.  Functions compiled this way
12423 will not save and restore the register @var{reg}.
12424
12425 It is an error to used this flag with the frame pointer or stack pointer.
12426 Use of this flag for other registers that have fixed pervasive roles in
12427 the machine's execution model will produce disastrous results.
12428
12429 This flag does not have a negative form, because it specifies a
12430 three-way choice.
12431
12432 @item -fcall-saved-@var{reg}
12433 @opindex fcall-saved
12434 Treat the register named @var{reg} as an allocable register saved by
12435 functions.  It may be allocated even for temporaries or variables that
12436 live across a call.  Functions compiled this way will save and restore
12437 the register @var{reg} if they use it.
12438
12439 It is an error to used this flag with the frame pointer or stack pointer.
12440 Use of this flag for other registers that have fixed pervasive roles in
12441 the machine's execution model will produce disastrous results.
12442
12443 A different sort of disaster will result from the use of this flag for
12444 a register in which function values may be returned.
12445
12446 This flag does not have a negative form, because it specifies a
12447 three-way choice.
12448
12449 @item -fpack-struct[=@var{n}]
12450 @opindex fpack-struct
12451 Without a value specified, pack all structure members together without
12452 holes.  When a value is specified (which must be a small power of two), pack
12453 structure members according to this value, representing the maximum
12454 alignment (that is, objects with default alignment requirements larger than
12455 this will be output potentially unaligned at the next fitting location.
12456
12457 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12458 code that is not binary compatible with code generated without that switch.
12459 Additionally, it makes the code suboptimal.
12460 Use it to conform to a non-default application binary interface.
12461
12462 @item -finstrument-functions
12463 @opindex finstrument-functions
12464 Generate instrumentation calls for entry and exit to functions.  Just
12465 after function entry and just before function exit, the following
12466 profiling functions will be called with the address of the current
12467 function and its call site.  (On some platforms,
12468 @code{__builtin_return_address} does not work beyond the current
12469 function, so the call site information may not be available to the
12470 profiling functions otherwise.)
12471
12472 @smallexample
12473 void __cyg_profile_func_enter (void *this_fn,
12474                                void *call_site);
12475 void __cyg_profile_func_exit  (void *this_fn,
12476                                void *call_site);
12477 @end smallexample
12478
12479 The first argument is the address of the start of the current function,
12480 which may be looked up exactly in the symbol table.
12481
12482 This instrumentation is also done for functions expanded inline in other
12483 functions.  The profiling calls will indicate where, conceptually, the
12484 inline function is entered and exited.  This means that addressable
12485 versions of such functions must be available.  If all your uses of a
12486 function are expanded inline, this may mean an additional expansion of
12487 code size.  If you use @samp{extern inline} in your C code, an
12488 addressable version of such functions must be provided.  (This is
12489 normally the case anyways, but if you get lucky and the optimizer always
12490 expands the functions inline, you might have gotten away without
12491 providing static copies.)
12492
12493 A function may be given the attribute @code{no_instrument_function}, in
12494 which case this instrumentation will not be done.  This can be used, for
12495 example, for the profiling functions listed above, high-priority
12496 interrupt routines, and any functions from which the profiling functions
12497 cannot safely be called (perhaps signal handlers, if the profiling
12498 routines generate output or allocate memory).
12499
12500 @item -fstack-check
12501 @opindex fstack-check
12502 Generate code to verify that you do not go beyond the boundary of the
12503 stack.  You should specify this flag if you are running in an
12504 environment with multiple threads, but only rarely need to specify it in
12505 a single-threaded environment since stack overflow is automatically
12506 detected on nearly all systems if there is only one stack.
12507
12508 Note that this switch does not actually cause checking to be done; the
12509 operating system must do that.  The switch causes generation of code
12510 to ensure that the operating system sees the stack being extended.
12511
12512 @item -fstack-limit-register=@var{reg}
12513 @itemx -fstack-limit-symbol=@var{sym}
12514 @itemx -fno-stack-limit
12515 @opindex fstack-limit-register
12516 @opindex fstack-limit-symbol
12517 @opindex fno-stack-limit
12518 Generate code to ensure that the stack does not grow beyond a certain value,
12519 either the value of a register or the address of a symbol.  If the stack
12520 would grow beyond the value, a signal is raised.  For most targets,
12521 the signal is raised before the stack overruns the boundary, so
12522 it is possible to catch the signal without taking special precautions.
12523
12524 For instance, if the stack starts at absolute address @samp{0x80000000}
12525 and grows downwards, you can use the flags
12526 @option{-fstack-limit-symbol=__stack_limit} and
12527 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12528 of 128KB@.  Note that this may only work with the GNU linker.
12529
12530 @cindex aliasing of parameters
12531 @cindex parameters, aliased
12532 @item -fargument-alias
12533 @itemx -fargument-noalias
12534 @itemx -fargument-noalias-global
12535 @opindex fargument-alias
12536 @opindex fargument-noalias
12537 @opindex fargument-noalias-global
12538 Specify the possible relationships among parameters and between
12539 parameters and global data.
12540
12541 @option{-fargument-alias} specifies that arguments (parameters) may
12542 alias each other and may alias global storage.@*
12543 @option{-fargument-noalias} specifies that arguments do not alias
12544 each other, but may alias global storage.@*
12545 @option{-fargument-noalias-global} specifies that arguments do not
12546 alias each other and do not alias global storage.
12547
12548 Each language will automatically use whatever option is required by
12549 the language standard.  You should not need to use these options yourself.
12550
12551 @item -fleading-underscore
12552 @opindex fleading-underscore
12553 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12554 change the way C symbols are represented in the object file.  One use
12555 is to help link with legacy assembly code.
12556
12557 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12558 generate code that is not binary compatible with code generated without that
12559 switch.  Use it to conform to a non-default application binary interface.
12560 Not all targets provide complete support for this switch.
12561
12562 @item -ftls-model=@var{model}
12563 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12564 The @var{model} argument should be one of @code{global-dynamic},
12565 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12566
12567 The default without @option{-fpic} is @code{initial-exec}; with
12568 @option{-fpic} the default is @code{global-dynamic}.
12569
12570 @item -fvisibility=@var{default|internal|hidden|protected}
12571 @opindex fvisibility
12572 Set the default ELF image symbol visibility to the specified option---all
12573 symbols will be marked with this unless overridden within the code.
12574 Using this feature can very substantially improve linking and
12575 load times of shared object libraries, produce more optimized
12576 code, provide near-perfect API export and prevent symbol clashes.
12577 It is @strong{strongly} recommended that you use this in any shared objects
12578 you distribute.
12579
12580 Despite the nomenclature, @code{default} always means public ie;
12581 available to be linked against from outside the shared object.
12582 @code{protected} and @code{internal} are pretty useless in real-world
12583 usage so the only other commonly used option will be @code{hidden}.
12584 The default if @option{-fvisibility} isn't specified is
12585 @code{default}, i.e., make every
12586 symbol public---this causes the same behavior as previous versions of
12587 GCC@.
12588
12589 A good explanation of the benefits offered by ensuring ELF
12590 symbols have the correct visibility is given by ``How To Write
12591 Shared Libraries'' by Ulrich Drepper (which can be found at
12592 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12593 solution made possible by this option to marking things hidden when
12594 the default is public is to make the default hidden and mark things
12595 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12596 and @code{__attribute__ ((visibility("default")))} instead of
12597 @code{__declspec(dllexport)} you get almost identical semantics with
12598 identical syntax.  This is a great boon to those working with
12599 cross-platform projects.
12600
12601 For those adding visibility support to existing code, you may find
12602 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12603 the declarations you wish to set visibility for with (for example)
12604 @samp{#pragma GCC visibility push(hidden)} and
12605 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12606 times.  Bear in mind that symbol visibility should be viewed @strong{as
12607 part of the API interface contract} and thus all new code should
12608 always specify visibility when it is not the default ie; declarations
12609 only for use within the local DSO should @strong{always} be marked explicitly
12610 as hidden as so to avoid PLT indirection overheads---making this
12611 abundantly clear also aids readability and self-documentation of the code.
12612 Note that due to ISO C++ specification requirements, operator new and
12613 operator delete must always be of default visibility.
12614
12615 An overview of these techniques, their benefits and how to use them
12616 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12617
12618 @end table
12619
12620 @c man end
12621
12622 @node Environment Variables
12623 @section Environment Variables Affecting GCC
12624 @cindex environment variables
12625
12626 @c man begin ENVIRONMENT
12627 This section describes several environment variables that affect how GCC
12628 operates.  Some of them work by specifying directories or prefixes to use
12629 when searching for various kinds of files.  Some are used to specify other
12630 aspects of the compilation environment.
12631
12632 Note that you can also specify places to search using options such as
12633 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12634 take precedence over places specified using environment variables, which
12635 in turn take precedence over those specified by the configuration of GCC@.
12636 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12637 GNU Compiler Collection (GCC) Internals}.
12638
12639 @table @env
12640 @item LANG
12641 @itemx LC_CTYPE
12642 @c @itemx LC_COLLATE
12643 @itemx LC_MESSAGES
12644 @c @itemx LC_MONETARY
12645 @c @itemx LC_NUMERIC
12646 @c @itemx LC_TIME
12647 @itemx LC_ALL
12648 @findex LANG
12649 @findex LC_CTYPE
12650 @c @findex LC_COLLATE
12651 @findex LC_MESSAGES
12652 @c @findex LC_MONETARY
12653 @c @findex LC_NUMERIC
12654 @c @findex LC_TIME
12655 @findex LC_ALL
12656 @cindex locale
12657 These environment variables control the way that GCC uses
12658 localization information that allow GCC to work with different
12659 national conventions.  GCC inspects the locale categories
12660 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12661 so.  These locale categories can be set to any value supported by your
12662 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12663 Kingdom encoded in UTF-8.
12664
12665 The @env{LC_CTYPE} environment variable specifies character
12666 classification.  GCC uses it to determine the character boundaries in
12667 a string; this is needed for some multibyte encodings that contain quote
12668 and escape characters that would otherwise be interpreted as a string
12669 end or escape.
12670
12671 The @env{LC_MESSAGES} environment variable specifies the language to
12672 use in diagnostic messages.
12673
12674 If the @env{LC_ALL} environment variable is set, it overrides the value
12675 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12676 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12677 environment variable.  If none of these variables are set, GCC
12678 defaults to traditional C English behavior.
12679
12680 @item TMPDIR
12681 @findex TMPDIR
12682 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12683 files.  GCC uses temporary files to hold the output of one stage of
12684 compilation which is to be used as input to the next stage: for example,
12685 the output of the preprocessor, which is the input to the compiler
12686 proper.
12687
12688 @item GCC_EXEC_PREFIX
12689 @findex GCC_EXEC_PREFIX
12690 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12691 names of the subprograms executed by the compiler.  No slash is added
12692 when this prefix is combined with the name of a subprogram, but you can
12693 specify a prefix that ends with a slash if you wish.
12694
12695 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12696 an appropriate prefix to use based on the pathname it was invoked with.
12697
12698 If GCC cannot find the subprogram using the specified prefix, it
12699 tries looking in the usual places for the subprogram.
12700
12701 The default value of @env{GCC_EXEC_PREFIX} is
12702 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12703 of @code{prefix} when you ran the @file{configure} script.
12704
12705 Other prefixes specified with @option{-B} take precedence over this prefix.
12706
12707 This prefix is also used for finding files such as @file{crt0.o} that are
12708 used for linking.
12709
12710 In addition, the prefix is used in an unusual way in finding the
12711 directories to search for header files.  For each of the standard
12712 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12713 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12714 replacing that beginning with the specified prefix to produce an
12715 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12716 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12717 These alternate directories are searched first; the standard directories
12718 come next.
12719
12720 @item COMPILER_PATH
12721 @findex COMPILER_PATH
12722 The value of @env{COMPILER_PATH} is a colon-separated list of
12723 directories, much like @env{PATH}.  GCC tries the directories thus
12724 specified when searching for subprograms, if it can't find the
12725 subprograms using @env{GCC_EXEC_PREFIX}.
12726
12727 @item LIBRARY_PATH
12728 @findex LIBRARY_PATH
12729 The value of @env{LIBRARY_PATH} is a colon-separated list of
12730 directories, much like @env{PATH}.  When configured as a native compiler,
12731 GCC tries the directories thus specified when searching for special
12732 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12733 using GCC also uses these directories when searching for ordinary
12734 libraries for the @option{-l} option (but directories specified with
12735 @option{-L} come first).
12736
12737 @item LANG
12738 @findex LANG
12739 @cindex locale definition
12740 This variable is used to pass locale information to the compiler.  One way in
12741 which this information is used is to determine the character set to be used
12742 when character literals, string literals and comments are parsed in C and C++.
12743 When the compiler is configured to allow multibyte characters,
12744 the following values for @env{LANG} are recognized:
12745
12746 @table @samp
12747 @item C-JIS
12748 Recognize JIS characters.
12749 @item C-SJIS
12750 Recognize SJIS characters.
12751 @item C-EUCJP
12752 Recognize EUCJP characters.
12753 @end table
12754
12755 If @env{LANG} is not defined, or if it has some other value, then the
12756 compiler will use mblen and mbtowc as defined by the default locale to
12757 recognize and translate multibyte characters.
12758 @end table
12759
12760 @noindent
12761 Some additional environments variables affect the behavior of the
12762 preprocessor.
12763
12764 @include cppenv.texi
12765
12766 @c man end
12767
12768 @node Precompiled Headers
12769 @section Using Precompiled Headers
12770 @cindex precompiled headers
12771 @cindex speed of compilation
12772
12773 Often large projects have many header files that are included in every
12774 source file.  The time the compiler takes to process these header files
12775 over and over again can account for nearly all of the time required to
12776 build the project.  To make builds faster, GCC allows users to
12777 `precompile' a header file; then, if builds can use the precompiled
12778 header file they will be much faster.
12779
12780 @strong{Caution:} There are a few known situations where GCC will
12781 crash when trying to use a precompiled header.  If you have trouble
12782 with a precompiled header, you should remove the precompiled header
12783 and compile without it.  In addition, please use GCC's on-line
12784 defect-tracking system to report any problems you encounter with
12785 precompiled headers.  @xref{Bugs}.
12786
12787 To create a precompiled header file, simply compile it as you would any
12788 other file, if necessary using the @option{-x} option to make the driver
12789 treat it as a C or C++ header file.  You will probably want to use a
12790 tool like @command{make} to keep the precompiled header up-to-date when
12791 the headers it contains change.
12792
12793 A precompiled header file will be searched for when @code{#include} is
12794 seen in the compilation.  As it searches for the included file
12795 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12796 compiler looks for a precompiled header in each directory just before it
12797 looks for the include file in that directory.  The name searched for is
12798 the name specified in the @code{#include} with @samp{.gch} appended.  If
12799 the precompiled header file can't be used, it is ignored.
12800
12801 For instance, if you have @code{#include "all.h"}, and you have
12802 @file{all.h.gch} in the same directory as @file{all.h}, then the
12803 precompiled header file will be used if possible, and the original
12804 header will be used otherwise.
12805
12806 Alternatively, you might decide to put the precompiled header file in a
12807 directory and use @option{-I} to ensure that directory is searched
12808 before (or instead of) the directory containing the original header.
12809 Then, if you want to check that the precompiled header file is always
12810 used, you can put a file of the same name as the original header in this
12811 directory containing an @code{#error} command.
12812
12813 This also works with @option{-include}.  So yet another way to use
12814 precompiled headers, good for projects not designed with precompiled
12815 header files in mind, is to simply take most of the header files used by
12816 a project, include them from another header file, precompile that header
12817 file, and @option{-include} the precompiled header.  If the header files
12818 have guards against multiple inclusion, they will be skipped because
12819 they've already been included (in the precompiled header).
12820
12821 If you need to precompile the same header file for different
12822 languages, targets, or compiler options, you can instead make a
12823 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12824 header in the directory, perhaps using @option{-o}.  It doesn't matter
12825 what you call the files in the directory, every precompiled header in
12826 the directory will be considered.  The first precompiled header
12827 encountered in the directory that is valid for this compilation will
12828 be used; they're searched in no particular order.
12829
12830 There are many other possibilities, limited only by your imagination,
12831 good sense, and the constraints of your build system.
12832
12833 A precompiled header file can be used only when these conditions apply:
12834
12835 @itemize
12836 @item
12837 Only one precompiled header can be used in a particular compilation.
12838
12839 @item
12840 A precompiled header can't be used once the first C token is seen.  You
12841 can have preprocessor directives before a precompiled header; you can
12842 even include a precompiled header from inside another header, so long as
12843 there are no C tokens before the @code{#include}.
12844
12845 @item
12846 The precompiled header file must be produced for the same language as
12847 the current compilation.  You can't use a C precompiled header for a C++
12848 compilation.
12849
12850 @item
12851 The precompiled header file must be produced by the same compiler
12852 version and configuration as the current compilation is using.
12853 The easiest way to guarantee this is to use the same compiler binary
12854 for creating and using precompiled headers.
12855
12856 @item
12857 Any macros defined before the precompiled header is included must
12858 either be defined in the same way as when the precompiled header was
12859 generated, or must not affect the precompiled header, which usually
12860 means that they don't appear in the precompiled header at all.
12861
12862 The @option{-D} option is one way to define a macro before a
12863 precompiled header is included; using a @code{#define} can also do it.
12864 There are also some options that define macros implicitly, like
12865 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12866 defined this way.
12867
12868 @item If debugging information is output when using the precompiled
12869 header, using @option{-g} or similar, the same kind of debugging information
12870 must have been output when building the precompiled header.  However,
12871 a precompiled header built using @option{-g} can be used in a compilation
12872 when no debugging information is being output.
12873
12874 @item The same @option{-m} options must generally be used when building
12875 and using the precompiled header.  @xref{Submodel Options},
12876 for any cases where this rule is relaxed.
12877
12878 @item Each of the following options must be the same when building and using
12879 the precompiled header:
12880
12881 @gccoptlist{-fexceptions -funit-at-a-time}
12882
12883 @item
12884 Some other command-line options starting with @option{-f},
12885 @option{-p}, or @option{-O} must be defined in the same way as when
12886 the precompiled header was generated.  At present, it's not clear
12887 which options are safe to change and which are not; the safest choice
12888 is to use exactly the same options when generating and using the
12889 precompiled header.  The following are known to be safe:
12890
12891 @gccoptlist{-fpreprocessed -pedantic-errors}
12892
12893 @end itemize
12894
12895 For all of these except the last, the compiler will automatically
12896 ignore the precompiled header if the conditions aren't met.  If you
12897 find an option combination that doesn't work and doesn't cause the
12898 precompiled header to be ignored, please consider filing a bug report,
12899 see @ref{Bugs}.
12900
12901 If you do use differing options when generating and using the
12902 precompiled header, the actual behavior will be a mixture of the
12903 behavior for the options.  For instance, if you use @option{-g} to
12904 generate the precompiled header but not when using it, you may or may
12905 not get debugging information for routines in the precompiled header.
12906
12907 @node Running Protoize
12908 @section Running Protoize
12909
12910 The program @code{protoize} is an optional part of GCC@.  You can use
12911 it to add prototypes to a program, thus converting the program to ISO
12912 C in one respect.  The companion program @code{unprotoize} does the
12913 reverse: it removes argument types from any prototypes that are found.
12914
12915 When you run these programs, you must specify a set of source files as
12916 command line arguments.  The conversion programs start out by compiling
12917 these files to see what functions they define.  The information gathered
12918 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12919
12920 After scanning comes actual conversion.  The specified files are all
12921 eligible to be converted; any files they include (whether sources or
12922 just headers) are eligible as well.
12923
12924 But not all the eligible files are converted.  By default,
12925 @code{protoize} and @code{unprotoize} convert only source and header
12926 files in the current directory.  You can specify additional directories
12927 whose files should be converted with the @option{-d @var{directory}}
12928 option.  You can also specify particular files to exclude with the
12929 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12930 directory name matches one of the specified directory names, and its
12931 name within the directory has not been excluded.
12932
12933 Basic conversion with @code{protoize} consists of rewriting most
12934 function definitions and function declarations to specify the types of
12935 the arguments.  The only ones not rewritten are those for varargs
12936 functions.
12937
12938 @code{protoize} optionally inserts prototype declarations at the
12939 beginning of the source file, to make them available for any calls that
12940 precede the function's definition.  Or it can insert prototype
12941 declarations with block scope in the blocks where undeclared functions
12942 are called.
12943
12944 Basic conversion with @code{unprotoize} consists of rewriting most
12945 function declarations to remove any argument types, and rewriting
12946 function definitions to the old-style pre-ISO form.
12947
12948 Both conversion programs print a warning for any function declaration or
12949 definition that they can't convert.  You can suppress these warnings
12950 with @option{-q}.
12951
12952 The output from @code{protoize} or @code{unprotoize} replaces the
12953 original source file.  The original file is renamed to a name ending
12954 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12955 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12956 for DOS) file already exists, then the source file is simply discarded.
12957
12958 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12959 scan the program and collect information about the functions it uses.
12960 So neither of these programs will work until GCC is installed.
12961
12962 Here is a table of the options you can use with @code{protoize} and
12963 @code{unprotoize}.  Each option works with both programs unless
12964 otherwise stated.
12965
12966 @table @code
12967 @item -B @var{directory}
12968 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12969 usual directory (normally @file{/usr/local/lib}).  This file contains
12970 prototype information about standard system functions.  This option
12971 applies only to @code{protoize}.
12972
12973 @item -c @var{compilation-options}
12974 Use @var{compilation-options} as the options when running @command{gcc} to
12975 produce the @samp{.X} files.  The special option @option{-aux-info} is
12976 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12977
12978 Note that the compilation options must be given as a single argument to
12979 @code{protoize} or @code{unprotoize}.  If you want to specify several
12980 @command{gcc} options, you must quote the entire set of compilation options
12981 to make them a single word in the shell.
12982
12983 There are certain @command{gcc} arguments that you cannot use, because they
12984 would produce the wrong kind of output.  These include @option{-g},
12985 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12986 the @var{compilation-options}, they are ignored.
12987
12988 @item -C
12989 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12990 systems) instead of @samp{.c}.  This is convenient if you are converting
12991 a C program to C++.  This option applies only to @code{protoize}.
12992
12993 @item -g
12994 Add explicit global declarations.  This means inserting explicit
12995 declarations at the beginning of each source file for each function
12996 that is called in the file and was not declared.  These declarations
12997 precede the first function definition that contains a call to an
12998 undeclared function.  This option applies only to @code{protoize}.
12999
13000 @item -i @var{string}
13001 Indent old-style parameter declarations with the string @var{string}.
13002 This option applies only to @code{protoize}.
13003
13004 @code{unprotoize} converts prototyped function definitions to old-style
13005 function definitions, where the arguments are declared between the
13006 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13007 uses five spaces as the indentation.  If you want to indent with just
13008 one space instead, use @option{-i " "}.
13009
13010 @item -k
13011 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13012 is finished.
13013
13014 @item -l
13015 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13016 a prototype declaration for each function in each block which calls the
13017 function without any declaration.  This option applies only to
13018 @code{protoize}.
13019
13020 @item -n
13021 Make no real changes.  This mode just prints information about the conversions
13022 that would have been done without @option{-n}.
13023
13024 @item -N
13025 Make no @samp{.save} files.  The original files are simply deleted.
13026 Use this option with caution.
13027
13028 @item -p @var{program}
13029 Use the program @var{program} as the compiler.  Normally, the name
13030 @file{gcc} is used.
13031
13032 @item -q
13033 Work quietly.  Most warnings are suppressed.
13034
13035 @item -v
13036 Print the version number, just like @option{-v} for @command{gcc}.
13037 @end table
13038
13039 If you need special compiler options to compile one of your program's
13040 source files, then you should generate that file's @samp{.X} file
13041 specially, by running @command{gcc} on that source file with the
13042 appropriate options and the option @option{-aux-info}.  Then run
13043 @code{protoize} on the entire set of files.  @code{protoize} will use
13044 the existing @samp{.X} file because it is newer than the source file.
13045 For example:
13046
13047 @smallexample
13048 gcc -Dfoo=bar file1.c -aux-info file1.X
13049 protoize *.c
13050 @end smallexample
13051
13052 @noindent
13053 You need to include the special files along with the rest in the
13054 @code{protoize} command, even though their @samp{.X} files already
13055 exist, because otherwise they won't get converted.
13056
13057 @xref{Protoize Caveats}, for more information on how to use
13058 @code{protoize} successfully.