OSDN Git Service

* config.gcc: Add m32c-elf support.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
243 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
244 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
245 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
246 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
247 -Wvariadic-macros}
248
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
251 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
252 -Wstrict-prototypes  -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
254
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
258 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
281 -ftree-vectorizer-verbose=@var{n} @gol
282 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
283 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
284 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
285 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
286 -ftest-coverage  -ftime-report -fvar-tracking @gol
287 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
288 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
289 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
290 -print-multi-directory  -print-multi-lib @gol
291 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
292 -save-temps  -time}
293
294 @item Optimization Options
295 @xref{Optimize Options,,Options that Control Optimization}.
296 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
297 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
298 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
299 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
300 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
301 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
302 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
303 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
304 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
305 -fforce-addr  -ffunction-sections @gol
306 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
307 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
308 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
309 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
310 -fmodulo-sched -fno-branch-count-reg @gol
311 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
312 -fno-function-cse  -fno-guess-branch-probability @gol
313 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
314 -funsafe-math-optimizations  -ffinite-math-only @gol
315 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
316 -fomit-frame-pointer  -foptimize-register-move @gol
317 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
318 -fprofile-generate -fprofile-use @gol
319 -fregmove  -frename-registers @gol
320 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
321 -frerun-cse-after-loop  -frerun-loop-opt @gol
322 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
323 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
324 -fsched-spec-load-dangerous  @gol
325 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
326 -fsched2-use-superblocks @gol
327 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
328 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
329 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
330 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
331 -fsplit-ivs-in-unroller -funswitch-loops @gol
332 -fvariable-expansion-in-unroller @gol
333 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
334 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
335 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
336 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
337 -ftree-salias -fweb @gol
338 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
339 --param @var{name}=@var{value}
340 -O  -O0  -O1  -O2  -O3  -Os}
341
342 @item Preprocessor Options
343 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
344 @gccoptlist{-A@var{question}=@var{answer} @gol
345 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
346 -C  -dD  -dI  -dM  -dN @gol
347 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
348 -idirafter @var{dir} @gol
349 -include @var{file}  -imacros @var{file} @gol
350 -iprefix @var{file}  -iwithprefix @var{dir} @gol
351 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
352 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
353 -P  -fworking-directory  -remap @gol
354 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
355 -Xpreprocessor @var{option}}
356
357 @item Assembler Option
358 @xref{Assembler Options,,Passing Options to the Assembler}.
359 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
360
361 @item Linker Options
362 @xref{Link Options,,Options for Linking}.
363 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
364 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
365 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
366 -Wl,@var{option}  -Xlinker @var{option} @gol
367 -u @var{symbol}}
368
369 @item Directory Options
370 @xref{Directory Options,,Options for Directory Search}.
371 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
372
373 @item Target Options
374 @c I wrote this xref this way to avoid overfull hbox. -- rms
375 @xref{Target Options}.
376 @gccoptlist{-V @var{version}  -b @var{machine}}
377
378 @item Machine Dependent Options
379 @xref{Submodel Options,,Hardware Models and Configurations}.
380 @c This list is ordered alphanumerically by subsection name.
381 @c Try and put the significant identifier (CPU or system) first,
382 @c so users have a clue at guessing where the ones they want will be.
383
384 @emph{ARC Options}
385 @gccoptlist{-EB  -EL @gol
386 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
387 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
388
389 @emph{ARM Options}
390 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
391 -mabi=@var{name} @gol
392 -mapcs-stack-check  -mno-apcs-stack-check @gol
393 -mapcs-float  -mno-apcs-float @gol
394 -mapcs-reentrant  -mno-apcs-reentrant @gol
395 -msched-prolog  -mno-sched-prolog @gol
396 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
397 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
398 -mthumb-interwork  -mno-thumb-interwork @gol
399 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
400 -mstructure-size-boundary=@var{n} @gol
401 -mabort-on-noreturn @gol
402 -mlong-calls  -mno-long-calls @gol
403 -msingle-pic-base  -mno-single-pic-base @gol
404 -mpic-register=@var{reg} @gol
405 -mnop-fun-dllimport @gol
406 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
407 -mpoke-function-name @gol
408 -mthumb  -marm @gol
409 -mtpcs-frame  -mtpcs-leaf-frame @gol
410 -mcaller-super-interworking  -mcallee-super-interworking}
411
412 @emph{AVR Options}
413 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
414 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
415
416 @emph{Blackfin Options}
417 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
418 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
419 -mlow-64k -mno-low64k -mid-shared-library @gol
420 -mno-id-shared-library -mshared-library-id=@var{n} @gol
421 -mlong-calls  -mno-long-calls}
422
423 @emph{CRIS Options}
424 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
425 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
426 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
427 -mstack-align  -mdata-align  -mconst-align @gol
428 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
429 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
430 -mmul-bug-workaround  -mno-mul-bug-workaround}
431
432 @emph{Darwin Options}
433 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
434 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
435 -client_name  -compatibility_version  -current_version @gol
436 -dead_strip @gol
437 -dependency-file  -dylib_file  -dylinker_install_name @gol
438 -dynamic  -dynamiclib  -exported_symbols_list @gol
439 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
440 -force_flat_namespace  -headerpad_max_install_names @gol
441 -image_base  -init  -install_name  -keep_private_externs @gol
442 -multi_module  -multiply_defined  -multiply_defined_unused @gol
443 -noall_load   -no_dead_strip_inits_and_terms @gol
444 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
445 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
446 -private_bundle  -read_only_relocs  -sectalign @gol
447 -sectobjectsymbols  -whyload  -seg1addr @gol
448 -sectcreate  -sectobjectsymbols  -sectorder @gol
449 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
450 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
451 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
452 -single_module  -static  -sub_library  -sub_umbrella @gol
453 -twolevel_namespace  -umbrella  -undefined @gol
454 -unexported_symbols_list  -weak_reference_mismatches @gol
455 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
456 -mone-byte-bool}
457
458 @emph{DEC Alpha Options}
459 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
460 -mieee  -mieee-with-inexact  -mieee-conformant @gol
461 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
462 -mtrap-precision=@var{mode}  -mbuild-constants @gol
463 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
464 -mbwx  -mmax  -mfix  -mcix @gol
465 -mfloat-vax  -mfloat-ieee @gol
466 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
467 -msmall-text  -mlarge-text @gol
468 -mmemory-latency=@var{time}}
469
470 @emph{DEC Alpha/VMS Options}
471 @gccoptlist{-mvms-return-codes}
472
473 @emph{FRV Options}
474 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
475 -mhard-float  -msoft-float @gol
476 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
477 -mdouble  -mno-double @gol
478 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
479 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
480 -mlinked-fp  -mlong-calls  -malign-labels @gol
481 -mlibrary-pic  -macc-4  -macc-8 @gol
482 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
483 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
484 -mvliw-branch  -mno-vliw-branch @gol
485 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
486 -mno-nested-cond-exec  -mtomcat-stats @gol
487 -mTLS -mtls @gol
488 -mcpu=@var{cpu}}
489
490 @emph{H8/300 Options}
491 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
492
493 @emph{HPPA Options}
494 @gccoptlist{-march=@var{architecture-type} @gol
495 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
496 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
497 -mfixed-range=@var{register-range} @gol
498 -mjump-in-delay -mlinker-opt -mlong-calls @gol
499 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
500 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
501 -mno-jump-in-delay  -mno-long-load-store @gol
502 -mno-portable-runtime  -mno-soft-float @gol
503 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
504 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
505 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
506 -munix=@var{unix-std}  -nolibdld  -static  -threads}
507
508 @emph{i386 and x86-64 Options}
509 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
510 -mfpmath=@var{unit} @gol
511 -masm=@var{dialect}  -mno-fancy-math-387 @gol
512 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
513 -mno-wide-multiply  -mrtd  -malign-double @gol
514 -mpreferred-stack-boundary=@var{num} @gol
515 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
516 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
517 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
518 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
519 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
520 -mcmodel=@var{code-model} @gol
521 -m32  -m64}
522
523 @emph{IA-64 Options}
524 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
525 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
526 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
527 -minline-float-divide-max-throughput @gol
528 -minline-int-divide-min-latency @gol
529 -minline-int-divide-max-throughput  @gol
530 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
531 -mno-dwarf2-asm -mearly-stop-bits @gol
532 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
533 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
534
535 @emph{M32R/D Options}
536 @gccoptlist{-m32r2 -m32rx -m32r @gol
537 -mdebug @gol
538 -malign-loops -mno-align-loops @gol
539 -missue-rate=@var{number} @gol
540 -mbranch-cost=@var{number} @gol
541 -mmodel=@var{code-size-model-type} @gol
542 -msdata=@var{sdata-type} @gol
543 -mno-flush-func -mflush-func=@var{name} @gol
544 -mno-flush-trap -mflush-trap=@var{number} @gol
545 -G @var{num}}
546
547 @emph{M32C Options}
548 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
549
550 @emph{M680x0 Options}
551 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
552 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
553 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
554 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
555 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
556
557 @emph{M68hc1x Options}
558 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
559 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
560 -msoft-reg-count=@var{count}}
561
562 @emph{MCore Options}
563 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
564 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
565 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
566 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
567 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
568
569 @emph{MIPS Options}
570 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
571 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
572 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
573 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
574 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
575 -mpaired-single  -mips3d @gol
576 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
577 -G@var{num}  -membedded-data  -mno-embedded-data @gol
578 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
579 -msplit-addresses  -mno-split-addresses  @gol
580 -mexplicit-relocs  -mno-explicit-relocs  @gol
581 -mcheck-zero-division  -mno-check-zero-division @gol
582 -mdivide-traps  -mdivide-breaks @gol
583 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
584 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
585 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
586 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
587 -mfix-sb1  -mno-fix-sb1 @gol
588 -mflush-func=@var{func}  -mno-flush-func @gol
589 -mbranch-likely  -mno-branch-likely @gol
590 -mfp-exceptions -mno-fp-exceptions @gol
591 -mvr4130-align -mno-vr4130-align}
592
593 @emph{MMIX Options}
594 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
595 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
596 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
597 -mno-base-addresses  -msingle-exit  -mno-single-exit}
598
599 @emph{MN10300 Options}
600 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
601 -mam33  -mno-am33 @gol
602 -mam33-2  -mno-am33-2 @gol
603 -mno-crt0  -mrelax}
604
605 @emph{PDP-11 Options}
606 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
607 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
608 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
609 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
610 -mbranch-expensive  -mbranch-cheap @gol
611 -msplit  -mno-split  -munix-asm  -mdec-asm}
612
613 @emph{PowerPC Options}
614 See RS/6000 and PowerPC Options.
615
616 @emph{RS/6000 and PowerPC Options}
617 @gccoptlist{-mcpu=@var{cpu-type} @gol
618 -mtune=@var{cpu-type} @gol
619 -mpower  -mno-power  -mpower2  -mno-power2 @gol
620 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
621 -maltivec  -mno-altivec @gol
622 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
623 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
624 -mnew-mnemonics  -mold-mnemonics @gol
625 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
626 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
627 -malign-power  -malign-natural @gol
628 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
629 -mstring  -mno-string  -mupdate  -mno-update @gol
630 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
631 -mstrict-align  -mno-strict-align  -mrelocatable @gol
632 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
633 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
634 -mdynamic-no-pic  -maltivec  -mswdiv @gol
635 -mprioritize-restricted-insns=@var{priority} @gol
636 -msched-costly-dep=@var{dependence_type} @gol
637 -minsert-sched-nops=@var{scheme} @gol
638 -mcall-sysv  -mcall-netbsd @gol
639 -maix-struct-return  -msvr4-struct-return @gol
640 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
641 -misel -mno-isel @gol
642 -misel=yes  -misel=no @gol
643 -mspe -mno-spe @gol
644 -mspe=yes  -mspe=no @gol
645 -mvrsave -mno-vrsave @gol
646 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
647 -mprototype  -mno-prototype @gol
648 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
649 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
650
651 @emph{S/390 and zSeries Options}
652 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
653 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
654 -mpacked-stack  -mno-packed-stack @gol
655 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
656 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
657 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
658 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
659
660 @emph{SH Options}
661 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
662 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
663 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
664 -m5-64media  -m5-64media-nofpu @gol
665 -m5-32media  -m5-32media-nofpu @gol
666 -m5-compact  -m5-compact-nofpu @gol
667 -mb  -ml  -mdalign  -mrelax @gol
668 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
669 -mieee  -misize  -mpadstruct  -mspace @gol
670 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
671 -mdivsi3_libfunc=@var{name}  @gol
672 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
673  -minvalid-symbols}
674
675 @emph{SPARC Options}
676 @gccoptlist{-mcpu=@var{cpu-type} @gol
677 -mtune=@var{cpu-type} @gol
678 -mcmodel=@var{code-model} @gol
679 -m32  -m64  -mapp-regs  -mno-app-regs @gol
680 -mfaster-structs  -mno-faster-structs @gol
681 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
682 -mhard-quad-float  -msoft-quad-float @gol
683 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
684 -mstack-bias  -mno-stack-bias @gol
685 -munaligned-doubles  -mno-unaligned-doubles @gol
686 -mv8plus  -mno-v8plus  -mvis  -mno-vis
687 -threads -pthreads}
688
689 @emph{System V Options}
690 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
691
692 @emph{TMS320C3x/C4x Options}
693 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
694 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
695 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
696 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
697
698 @emph{V850 Options}
699 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
700 -mprolog-function  -mno-prolog-function  -mspace @gol
701 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
702 -mapp-regs  -mno-app-regs @gol
703 -mdisable-callt  -mno-disable-callt @gol
704 -mv850e1 @gol
705 -mv850e @gol
706 -mv850  -mbig-switch}
707
708 @emph{VAX Options}
709 @gccoptlist{-mg  -mgnu  -munix}
710
711 @emph{x86-64 Options}
712 See i386 and x86-64 Options.
713
714 @emph{Xstormy16 Options}
715 @gccoptlist{-msim}
716
717 @emph{Xtensa Options}
718 @gccoptlist{-mconst16 -mno-const16 @gol
719 -mfused-madd  -mno-fused-madd @gol
720 -mtext-section-literals  -mno-text-section-literals @gol
721 -mtarget-align  -mno-target-align @gol
722 -mlongcalls  -mno-longcalls}
723
724 @emph{zSeries Options}
725 See S/390 and zSeries Options.
726
727 @item Code Generation Options
728 @xref{Code Gen Options,,Options for Code Generation Conventions}.
729 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
730 -ffixed-@var{reg}  -fexceptions @gol
731 -fnon-call-exceptions  -funwind-tables @gol
732 -fasynchronous-unwind-tables @gol
733 -finhibit-size-directive  -finstrument-functions @gol
734 -fno-common  -fno-ident @gol
735 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
736 -fno-jump-tables @gol
737 -freg-struct-return  -fshared-data  -fshort-enums @gol
738 -fshort-double  -fshort-wchar @gol
739 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
740 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
741 -fargument-alias  -fargument-noalias @gol
742 -fargument-noalias-global  -fleading-underscore @gol
743 -ftls-model=@var{model} @gol
744 -ftrapv  -fwrapv  -fbounds-check @gol
745 -fvisibility}
746 @end table
747
748 @menu
749 * Overall Options::     Controlling the kind of output:
750                         an executable, object files, assembler files,
751                         or preprocessed source.
752 * C Dialect Options::   Controlling the variant of C language compiled.
753 * C++ Dialect Options:: Variations on C++.
754 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
755                         and Objective-C++.
756 * Language Independent Options:: Controlling how diagnostics should be
757                         formatted.
758 * Warning Options::     How picky should the compiler be?
759 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
760 * Optimize Options::    How much optimization?
761 * Preprocessor Options:: Controlling header files and macro definitions.
762                          Also, getting dependency information for Make.
763 * Assembler Options::   Passing options to the assembler.
764 * Link Options::        Specifying libraries and so on.
765 * Directory Options::   Where to find header files and libraries.
766                         Where to find the compiler executable files.
767 * Spec Files::          How to pass switches to sub-processes.
768 * Target Options::      Running a cross-compiler, or an old version of GCC.
769 @end menu
770
771 @node Overall Options
772 @section Options Controlling the Kind of Output
773
774 Compilation can involve up to four stages: preprocessing, compilation
775 proper, assembly and linking, always in that order.  GCC is capable of
776 preprocessing and compiling several files either into several
777 assembler input files, or into one assembler input file; then each
778 assembler input file produces an object file, and linking combines all
779 the object files (those newly compiled, and those specified as input)
780 into an executable file.
781
782 @cindex file name suffix
783 For any given input file, the file name suffix determines what kind of
784 compilation is done:
785
786 @table @gcctabopt
787 @item @var{file}.c
788 C source code which must be preprocessed.
789
790 @item @var{file}.i
791 C source code which should not be preprocessed.
792
793 @item @var{file}.ii
794 C++ source code which should not be preprocessed.
795
796 @item @var{file}.m
797 Objective-C source code.  Note that you must link with the @file{libobjc}
798 library to make an Objective-C program work.
799
800 @item @var{file}.mi
801 Objective-C source code which should not be preprocessed.
802
803 @item @var{file}.mm
804 @itemx @var{file}.M
805 Objective-C++ source code.  Note that you must link with the @file{libobjc}
806 library to make an Objective-C++ program work.  Note that @samp{.M} refers
807 to a literal capital M@.
808
809 @item @var{file}.mii
810 Objective-C++ source code which should not be preprocessed.
811
812 @item @var{file}.h
813 C, C++, Objective-C or Objective-C++ header file to be turned into a
814 precompiled header.
815
816 @item @var{file}.cc
817 @itemx @var{file}.cp
818 @itemx @var{file}.cxx
819 @itemx @var{file}.cpp
820 @itemx @var{file}.CPP
821 @itemx @var{file}.c++
822 @itemx @var{file}.C
823 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
824 the last two letters must both be literally @samp{x}.  Likewise,
825 @samp{.C} refers to a literal capital C@.
826
827 @item @var{file}.mm
828 @itemx @var{file}.M
829 Objective-C++ source code which must be preprocessed.
830
831 @item @var{file}.mii
832 Objective-C++ source code which should not be preprocessed.
833
834 @item @var{file}.hh
835 @itemx @var{file}.H
836 C++ header file to be turned into a precompiled header.
837
838 @item @var{file}.f
839 @itemx @var{file}.for
840 @itemx @var{file}.FOR
841 Fortran source code which should not be preprocessed.
842
843 @item @var{file}.F
844 @itemx @var{file}.fpp
845 @itemx @var{file}.FPP
846 Fortran source code which must be preprocessed (with the traditional
847 preprocessor).
848
849 @item @var{file}.r
850 Fortran source code which must be preprocessed with a RATFOR
851 preprocessor (not included with GCC)@.
852
853 @item @var{file}.f90
854 @itemx @var{file}.f95
855 Fortran 90/95 source code which should not be preprocessed.
856
857 @c FIXME: Descriptions of Java file types.
858 @c @var{file}.java
859 @c @var{file}.class
860 @c @var{file}.zip
861 @c @var{file}.jar
862
863 @item @var{file}.ads
864 Ada source code file which contains a library unit declaration (a
865 declaration of a package, subprogram, or generic, or a generic
866 instantiation), or a library unit renaming declaration (a package,
867 generic, or subprogram renaming declaration).  Such files are also
868 called @dfn{specs}.
869
870 @itemx @var{file}.adb
871 Ada source code file containing a library unit body (a subprogram or
872 package body).  Such files are also called @dfn{bodies}.
873
874 @c GCC also knows about some suffixes for languages not yet included:
875 @c Pascal:
876 @c @var{file}.p
877 @c @var{file}.pas
878
879 @item @var{file}.s
880 Assembler code.
881
882 @item @var{file}.S
883 Assembler code which must be preprocessed.
884
885 @item @var{other}
886 An object file to be fed straight into linking.
887 Any file name with no recognized suffix is treated this way.
888 @end table
889
890 @opindex x
891 You can specify the input language explicitly with the @option{-x} option:
892
893 @table @gcctabopt
894 @item -x @var{language}
895 Specify explicitly the @var{language} for the following input files
896 (rather than letting the compiler choose a default based on the file
897 name suffix).  This option applies to all following input files until
898 the next @option{-x} option.  Possible values for @var{language} are:
899 @smallexample
900 c  c-header  c-cpp-output
901 c++  c++-header  c++-cpp-output
902 objective-c  objective-c-header  objective-c-cpp-output
903 objective-c++ objective-c++-header objective-c++-cpp-output
904 assembler  assembler-with-cpp
905 ada
906 f77  f77-cpp-input  ratfor
907 f95
908 java
909 treelang
910 @end smallexample
911
912 @item -x none
913 Turn off any specification of a language, so that subsequent files are
914 handled according to their file name suffixes (as they are if @option{-x}
915 has not been used at all).
916
917 @item -pass-exit-codes
918 @opindex pass-exit-codes
919 Normally the @command{gcc} program will exit with the code of 1 if any
920 phase of the compiler returns a non-success return code.  If you specify
921 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
922 numerically highest error produced by any phase that returned an error
923 indication.
924 @end table
925
926 If you only want some of the stages of compilation, you can use
927 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
928 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
929 @command{gcc} is to stop.  Note that some combinations (for example,
930 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
931
932 @table @gcctabopt
933 @item -c
934 @opindex c
935 Compile or assemble the source files, but do not link.  The linking
936 stage simply is not done.  The ultimate output is in the form of an
937 object file for each source file.
938
939 By default, the object file name for a source file is made by replacing
940 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
941
942 Unrecognized input files, not requiring compilation or assembly, are
943 ignored.
944
945 @item -S
946 @opindex S
947 Stop after the stage of compilation proper; do not assemble.  The output
948 is in the form of an assembler code file for each non-assembler input
949 file specified.
950
951 By default, the assembler file name for a source file is made by
952 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
953
954 Input files that don't require compilation are ignored.
955
956 @item -E
957 @opindex E
958 Stop after the preprocessing stage; do not run the compiler proper.  The
959 output is in the form of preprocessed source code, which is sent to the
960 standard output.
961
962 Input files which don't require preprocessing are ignored.
963
964 @cindex output file option
965 @item -o @var{file}
966 @opindex o
967 Place output in file @var{file}.  This applies regardless to whatever
968 sort of output is being produced, whether it be an executable file,
969 an object file, an assembler file or preprocessed C code.
970
971 If @option{-o} is not specified, the default is to put an executable
972 file in @file{a.out}, the object file for
973 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
974 assembler file in @file{@var{source}.s}, a precompiled header file in
975 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
976 standard output.
977
978 @item -v
979 @opindex v
980 Print (on standard error output) the commands executed to run the stages
981 of compilation.  Also print the version number of the compiler driver
982 program and of the preprocessor and the compiler proper.
983
984 @item -###
985 @opindex ###
986 Like @option{-v} except the commands are not executed and all command
987 arguments are quoted.  This is useful for shell scripts to capture the
988 driver-generated command lines.
989
990 @item -pipe
991 @opindex pipe
992 Use pipes rather than temporary files for communication between the
993 various stages of compilation.  This fails to work on some systems where
994 the assembler is unable to read from a pipe; but the GNU assembler has
995 no trouble.
996
997 @item -combine
998 @opindex combine
999 If you are compiling multiple source files, this option tells the driver
1000 to pass all the source files to the compiler at once (for those
1001 languages for which the compiler can handle this).  This will allow
1002 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1003 language for which this is supported is C@.  If you pass source files for
1004 multiple languages to the driver, using this option, the driver will invoke
1005 the compiler(s) that support IMA once each, passing each compiler all the
1006 source files appropriate for it.  For those languages that do not support
1007 IMA this option will be ignored, and the compiler will be invoked once for
1008 each source file in that language.  If you use this option in conjunction
1009 with @option{-save-temps}, the compiler will generate multiple
1010 pre-processed files
1011 (one for each source file), but only one (combined) @file{.o} or
1012 @file{.s} file.
1013
1014 @item --help
1015 @opindex help
1016 Print (on the standard output) a description of the command line options
1017 understood by @command{gcc}.  If the @option{-v} option is also specified
1018 then @option{--help} will also be passed on to the various processes
1019 invoked by @command{gcc}, so that they can display the command line options
1020 they accept.  If the @option{-Wextra} option is also specified then command
1021 line options which have no documentation associated with them will also
1022 be displayed.
1023
1024 @item --target-help
1025 @opindex target-help
1026 Print (on the standard output) a description of target specific command
1027 line options for each tool.
1028
1029 @item --version
1030 @opindex version
1031 Display the version number and copyrights of the invoked GCC@.
1032 @end table
1033
1034 @node Invoking G++
1035 @section Compiling C++ Programs
1036
1037 @cindex suffixes for C++ source
1038 @cindex C++ source file suffixes
1039 C++ source files conventionally use one of the suffixes @samp{.C},
1040 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1041 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1042 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1043 files with these names and compiles them as C++ programs even if you
1044 call the compiler the same way as for compiling C programs (usually
1045 with the name @command{gcc}).
1046
1047 @findex g++
1048 @findex c++
1049 However, C++ programs often require class libraries as well as a
1050 compiler that understands the C++ language---and under some
1051 circumstances, you might want to compile programs or header files from
1052 standard input, or otherwise without a suffix that flags them as C++
1053 programs.  You might also like to precompile a C header file with a
1054 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1055 program that calls GCC with the default language set to C++, and
1056 automatically specifies linking against the C++ library.  On many
1057 systems, @command{g++} is also installed with the name @command{c++}.
1058
1059 @cindex invoking @command{g++}
1060 When you compile C++ programs, you may specify many of the same
1061 command-line options that you use for compiling programs in any
1062 language; or command-line options meaningful for C and related
1063 languages; or options that are meaningful only for C++ programs.
1064 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1065 explanations of options for languages related to C@.
1066 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1067 explanations of options that are meaningful only for C++ programs.
1068
1069 @node C Dialect Options
1070 @section Options Controlling C Dialect
1071 @cindex dialect options
1072 @cindex language dialect options
1073 @cindex options, dialect
1074
1075 The following options control the dialect of C (or languages derived
1076 from C, such as C++, Objective-C and Objective-C++) that the compiler
1077 accepts:
1078
1079 @table @gcctabopt
1080 @cindex ANSI support
1081 @cindex ISO support
1082 @item -ansi
1083 @opindex ansi
1084 In C mode, support all ISO C90 programs.  In C++ mode,
1085 remove GNU extensions that conflict with ISO C++.
1086
1087 This turns off certain features of GCC that are incompatible with ISO
1088 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1089 such as the @code{asm} and @code{typeof} keywords, and
1090 predefined macros such as @code{unix} and @code{vax} that identify the
1091 type of system you are using.  It also enables the undesirable and
1092 rarely used ISO trigraph feature.  For the C compiler,
1093 it disables recognition of C++ style @samp{//} comments as well as
1094 the @code{inline} keyword.
1095
1096 The alternate keywords @code{__asm__}, @code{__extension__},
1097 @code{__inline__} and @code{__typeof__} continue to work despite
1098 @option{-ansi}.  You would not want to use them in an ISO C program, of
1099 course, but it is useful to put them in header files that might be included
1100 in compilations done with @option{-ansi}.  Alternate predefined macros
1101 such as @code{__unix__} and @code{__vax__} are also available, with or
1102 without @option{-ansi}.
1103
1104 The @option{-ansi} option does not cause non-ISO programs to be
1105 rejected gratuitously.  For that, @option{-pedantic} is required in
1106 addition to @option{-ansi}.  @xref{Warning Options}.
1107
1108 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1109 option is used.  Some header files may notice this macro and refrain
1110 from declaring certain functions or defining certain macros that the
1111 ISO standard doesn't call for; this is to avoid interfering with any
1112 programs that might use these names for other things.
1113
1114 Functions which would normally be built in but do not have semantics
1115 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1116 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1117 built-in functions provided by GCC}, for details of the functions
1118 affected.
1119
1120 @item -std=
1121 @opindex std
1122 Determine the language standard.  This option is currently only
1123 supported when compiling C or C++.  A value for this option must be
1124 provided; possible values are
1125
1126 @table @samp
1127 @item c89
1128 @itemx iso9899:1990
1129 ISO C90 (same as @option{-ansi}).
1130
1131 @item iso9899:199409
1132 ISO C90 as modified in amendment 1.
1133
1134 @item c99
1135 @itemx c9x
1136 @itemx iso9899:1999
1137 @itemx iso9899:199x
1138 ISO C99.  Note that this standard is not yet fully supported; see
1139 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1140 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1141
1142 @item gnu89
1143 Default, ISO C90 plus GNU extensions (including some C99 features).
1144
1145 @item gnu99
1146 @itemx gnu9x
1147 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1148 this will become the default.  The name @samp{gnu9x} is deprecated.
1149
1150 @item c++98
1151 The 1998 ISO C++ standard plus amendments.
1152
1153 @item gnu++98
1154 The same as @option{-std=c++98} plus GNU extensions.  This is the
1155 default for C++ code.
1156 @end table
1157
1158 Even when this option is not specified, you can still use some of the
1159 features of newer standards in so far as they do not conflict with
1160 previous C standards.  For example, you may use @code{__restrict__} even
1161 when @option{-std=c99} is not specified.
1162
1163 The @option{-std} options specifying some version of ISO C have the same
1164 effects as @option{-ansi}, except that features that were not in ISO C90
1165 but are in the specified version (for example, @samp{//} comments and
1166 the @code{inline} keyword in ISO C99) are not disabled.
1167
1168 @xref{Standards,,Language Standards Supported by GCC}, for details of
1169 these standard versions.
1170
1171 @item -aux-info @var{filename}
1172 @opindex aux-info
1173 Output to the given filename prototyped declarations for all functions
1174 declared and/or defined in a translation unit, including those in header
1175 files.  This option is silently ignored in any language other than C@.
1176
1177 Besides declarations, the file indicates, in comments, the origin of
1178 each declaration (source file and line), whether the declaration was
1179 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1180 @samp{O} for old, respectively, in the first character after the line
1181 number and the colon), and whether it came from a declaration or a
1182 definition (@samp{C} or @samp{F}, respectively, in the following
1183 character).  In the case of function definitions, a K&R-style list of
1184 arguments followed by their declarations is also provided, inside
1185 comments, after the declaration.
1186
1187 @item -fno-asm
1188 @opindex fno-asm
1189 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1190 keyword, so that code can use these words as identifiers.  You can use
1191 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1192 instead.  @option{-ansi} implies @option{-fno-asm}.
1193
1194 In C++, this switch only affects the @code{typeof} keyword, since
1195 @code{asm} and @code{inline} are standard keywords.  You may want to
1196 use the @option{-fno-gnu-keywords} flag instead, which has the same
1197 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1198 switch only affects the @code{asm} and @code{typeof} keywords, since
1199 @code{inline} is a standard keyword in ISO C99.
1200
1201 @item -fno-builtin
1202 @itemx -fno-builtin-@var{function}
1203 @opindex fno-builtin
1204 @cindex built-in functions
1205 Don't recognize built-in functions that do not begin with
1206 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1207 functions provided by GCC}, for details of the functions affected,
1208 including those which are not built-in functions when @option{-ansi} or
1209 @option{-std} options for strict ISO C conformance are used because they
1210 do not have an ISO standard meaning.
1211
1212 GCC normally generates special code to handle certain built-in functions
1213 more efficiently; for instance, calls to @code{alloca} may become single
1214 instructions that adjust the stack directly, and calls to @code{memcpy}
1215 may become inline copy loops.  The resulting code is often both smaller
1216 and faster, but since the function calls no longer appear as such, you
1217 cannot set a breakpoint on those calls, nor can you change the behavior
1218 of the functions by linking with a different library.  In addition,
1219 when a function is recognized as a built-in function, GCC may use
1220 information about that function to warn about problems with calls to
1221 that function, or to generate more efficient code, even if the
1222 resulting code still contains calls to that function.  For example,
1223 warnings are given with @option{-Wformat} for bad calls to
1224 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1225 known not to modify global memory.
1226
1227 With the @option{-fno-builtin-@var{function}} option
1228 only the built-in function @var{function} is
1229 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1230 function is named this is not built-in in this version of GCC, this
1231 option is ignored.  There is no corresponding
1232 @option{-fbuiltin-@var{function}} option; if you wish to enable
1233 built-in functions selectively when using @option{-fno-builtin} or
1234 @option{-ffreestanding}, you may define macros such as:
1235
1236 @smallexample
1237 #define abs(n)          __builtin_abs ((n))
1238 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1239 @end smallexample
1240
1241 @item -fhosted
1242 @opindex fhosted
1243 @cindex hosted environment
1244
1245 Assert that compilation takes place in a hosted environment.  This implies
1246 @option{-fbuiltin}.  A hosted environment is one in which the
1247 entire standard library is available, and in which @code{main} has a return
1248 type of @code{int}.  Examples are nearly everything except a kernel.
1249 This is equivalent to @option{-fno-freestanding}.
1250
1251 @item -ffreestanding
1252 @opindex ffreestanding
1253 @cindex hosted environment
1254
1255 Assert that compilation takes place in a freestanding environment.  This
1256 implies @option{-fno-builtin}.  A freestanding environment
1257 is one in which the standard library may not exist, and program startup may
1258 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1259 This is equivalent to @option{-fno-hosted}.
1260
1261 @xref{Standards,,Language Standards Supported by GCC}, for details of
1262 freestanding and hosted environments.
1263
1264 @item -fms-extensions
1265 @opindex fms-extensions
1266 Accept some non-standard constructs used in Microsoft header files.
1267
1268 Some cases of unnamed fields in structures and unions are only
1269 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1270 fields within structs/unions}, for details.
1271
1272 @item -trigraphs
1273 @opindex trigraphs
1274 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1275 options for strict ISO C conformance) implies @option{-trigraphs}.
1276
1277 @item -no-integrated-cpp
1278 @opindex no-integrated-cpp
1279 Performs a compilation in two passes: preprocessing and compiling.  This
1280 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1281 @option{-B} option.  The user supplied compilation step can then add in
1282 an additional preprocessing step after normal preprocessing but before
1283 compiling.  The default is to use the integrated cpp (internal cpp)
1284
1285 The semantics of this option will change if "cc1", "cc1plus", and
1286 "cc1obj" are merged.
1287
1288 @cindex traditional C language
1289 @cindex C language, traditional
1290 @item -traditional
1291 @itemx -traditional-cpp
1292 @opindex traditional-cpp
1293 @opindex traditional
1294 Formerly, these options caused GCC to attempt to emulate a pre-standard
1295 C compiler.  They are now only supported with the @option{-E} switch.
1296 The preprocessor continues to support a pre-standard mode.  See the GNU
1297 CPP manual for details.
1298
1299 @item -fcond-mismatch
1300 @opindex fcond-mismatch
1301 Allow conditional expressions with mismatched types in the second and
1302 third arguments.  The value of such an expression is void.  This option
1303 is not supported for C++.
1304
1305 @item -funsigned-char
1306 @opindex funsigned-char
1307 Let the type @code{char} be unsigned, like @code{unsigned char}.
1308
1309 Each kind of machine has a default for what @code{char} should
1310 be.  It is either like @code{unsigned char} by default or like
1311 @code{signed char} by default.
1312
1313 Ideally, a portable program should always use @code{signed char} or
1314 @code{unsigned char} when it depends on the signedness of an object.
1315 But many programs have been written to use plain @code{char} and
1316 expect it to be signed, or expect it to be unsigned, depending on the
1317 machines they were written for.  This option, and its inverse, let you
1318 make such a program work with the opposite default.
1319
1320 The type @code{char} is always a distinct type from each of
1321 @code{signed char} or @code{unsigned char}, even though its behavior
1322 is always just like one of those two.
1323
1324 @item -fsigned-char
1325 @opindex fsigned-char
1326 Let the type @code{char} be signed, like @code{signed char}.
1327
1328 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1329 the negative form of @option{-funsigned-char}.  Likewise, the option
1330 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1331
1332 @item -fsigned-bitfields
1333 @itemx -funsigned-bitfields
1334 @itemx -fno-signed-bitfields
1335 @itemx -fno-unsigned-bitfields
1336 @opindex fsigned-bitfields
1337 @opindex funsigned-bitfields
1338 @opindex fno-signed-bitfields
1339 @opindex fno-unsigned-bitfields
1340 These options control whether a bit-field is signed or unsigned, when the
1341 declaration does not use either @code{signed} or @code{unsigned}.  By
1342 default, such a bit-field is signed, because this is consistent: the
1343 basic integer types such as @code{int} are signed types.
1344 @end table
1345
1346 @node C++ Dialect Options
1347 @section Options Controlling C++ Dialect
1348
1349 @cindex compiler options, C++
1350 @cindex C++ options, command line
1351 @cindex options, C++
1352 This section describes the command-line options that are only meaningful
1353 for C++ programs; but you can also use most of the GNU compiler options
1354 regardless of what language your program is in.  For example, you
1355 might compile a file @code{firstClass.C} like this:
1356
1357 @smallexample
1358 g++ -g -frepo -O -c firstClass.C
1359 @end smallexample
1360
1361 @noindent
1362 In this example, only @option{-frepo} is an option meant
1363 only for C++ programs; you can use the other options with any
1364 language supported by GCC@.
1365
1366 Here is a list of options that are @emph{only} for compiling C++ programs:
1367
1368 @table @gcctabopt
1369
1370 @item -fabi-version=@var{n}
1371 @opindex fabi-version
1372 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1373 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1374 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1375 the version that conforms most closely to the C++ ABI specification.
1376 Therefore, the ABI obtained using version 0 will change as ABI bugs
1377 are fixed.
1378
1379 The default is version 2.
1380
1381 @item -fno-access-control
1382 @opindex fno-access-control
1383 Turn off all access checking.  This switch is mainly useful for working
1384 around bugs in the access control code.
1385
1386 @item -fcheck-new
1387 @opindex fcheck-new
1388 Check that the pointer returned by @code{operator new} is non-null
1389 before attempting to modify the storage allocated.  This check is
1390 normally unnecessary because the C++ standard specifies that
1391 @code{operator new} will only return @code{0} if it is declared
1392 @samp{throw()}, in which case the compiler will always check the
1393 return value even without this option.  In all other cases, when
1394 @code{operator new} has a non-empty exception specification, memory
1395 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1396 @samp{new (nothrow)}.
1397
1398 @item -fconserve-space
1399 @opindex fconserve-space
1400 Put uninitialized or runtime-initialized global variables into the
1401 common segment, as C does.  This saves space in the executable at the
1402 cost of not diagnosing duplicate definitions.  If you compile with this
1403 flag and your program mysteriously crashes after @code{main()} has
1404 completed, you may have an object that is being destroyed twice because
1405 two definitions were merged.
1406
1407 This option is no longer useful on most targets, now that support has
1408 been added for putting variables into BSS without making them common.
1409
1410 @item -fno-const-strings
1411 @opindex fno-const-strings
1412 Give string constants type @code{char *} instead of type @code{const
1413 char *}.  By default, G++ uses type @code{const char *} as required by
1414 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1415 actually modify the value of a string constant.
1416
1417 This option might be removed in a future release of G++.  For maximum
1418 portability, you should structure your code so that it works with
1419 string constants that have type @code{const char *}.
1420
1421 @item -fno-elide-constructors
1422 @opindex fno-elide-constructors
1423 The C++ standard allows an implementation to omit creating a temporary
1424 which is only used to initialize another object of the same type.
1425 Specifying this option disables that optimization, and forces G++ to
1426 call the copy constructor in all cases.
1427
1428 @item -fno-enforce-eh-specs
1429 @opindex fno-enforce-eh-specs
1430 Don't check for violation of exception specifications at runtime.  This
1431 option violates the C++ standard, but may be useful for reducing code
1432 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1433 will still optimize based on the exception specifications.
1434
1435 @item -ffor-scope
1436 @itemx -fno-for-scope
1437 @opindex ffor-scope
1438 @opindex fno-for-scope
1439 If @option{-ffor-scope} is specified, the scope of variables declared in
1440 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1441 as specified by the C++ standard.
1442 If @option{-fno-for-scope} is specified, the scope of variables declared in
1443 a @i{for-init-statement} extends to the end of the enclosing scope,
1444 as was the case in old versions of G++, and other (traditional)
1445 implementations of C++.
1446
1447 The default if neither flag is given to follow the standard,
1448 but to allow and give a warning for old-style code that would
1449 otherwise be invalid, or have different behavior.
1450
1451 @item -fno-gnu-keywords
1452 @opindex fno-gnu-keywords
1453 Do not recognize @code{typeof} as a keyword, so that code can use this
1454 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1455 @option{-ansi} implies @option{-fno-gnu-keywords}.
1456
1457 @item -fno-implicit-templates
1458 @opindex fno-implicit-templates
1459 Never emit code for non-inline templates which are instantiated
1460 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1461 @xref{Template Instantiation}, for more information.
1462
1463 @item -fno-implicit-inline-templates
1464 @opindex fno-implicit-inline-templates
1465 Don't emit code for implicit instantiations of inline templates, either.
1466 The default is to handle inlines differently so that compiles with and
1467 without optimization will need the same set of explicit instantiations.
1468
1469 @item -fno-implement-inlines
1470 @opindex fno-implement-inlines
1471 To save space, do not emit out-of-line copies of inline functions
1472 controlled by @samp{#pragma implementation}.  This will cause linker
1473 errors if these functions are not inlined everywhere they are called.
1474
1475 @item -fms-extensions
1476 @opindex fms-extensions
1477 Disable pedantic warnings about constructs used in MFC, such as implicit
1478 int and getting a pointer to member function via non-standard syntax.
1479
1480 @item -fno-nonansi-builtins
1481 @opindex fno-nonansi-builtins
1482 Disable built-in declarations of functions that are not mandated by
1483 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1484 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1485
1486 @item -fno-operator-names
1487 @opindex fno-operator-names
1488 Do not treat the operator name keywords @code{and}, @code{bitand},
1489 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1490 synonyms as keywords.
1491
1492 @item -fno-optional-diags
1493 @opindex fno-optional-diags
1494 Disable diagnostics that the standard says a compiler does not need to
1495 issue.  Currently, the only such diagnostic issued by G++ is the one for
1496 a name having multiple meanings within a class.
1497
1498 @item -fpermissive
1499 @opindex fpermissive
1500 Downgrade some diagnostics about nonconformant code from errors to
1501 warnings.  Thus, using @option{-fpermissive} will allow some
1502 nonconforming code to compile.
1503
1504 @item -frepo
1505 @opindex frepo
1506 Enable automatic template instantiation at link time.  This option also
1507 implies @option{-fno-implicit-templates}.  @xref{Template
1508 Instantiation}, for more information.
1509
1510 @item -fno-rtti
1511 @opindex fno-rtti
1512 Disable generation of information about every class with virtual
1513 functions for use by the C++ runtime type identification features
1514 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1515 of the language, you can save some space by using this flag.  Note that
1516 exception handling uses the same information, but it will generate it as
1517 needed.
1518
1519 @item -fstats
1520 @opindex fstats
1521 Emit statistics about front-end processing at the end of the compilation.
1522 This information is generally only useful to the G++ development team.
1523
1524 @item -ftemplate-depth-@var{n}
1525 @opindex ftemplate-depth
1526 Set the maximum instantiation depth for template classes to @var{n}.
1527 A limit on the template instantiation depth is needed to detect
1528 endless recursions during template class instantiation.  ANSI/ISO C++
1529 conforming programs must not rely on a maximum depth greater than 17.
1530
1531 @item -fno-threadsafe-statics
1532 @opindex fno-threadsafe-statics
1533 Do not emit the extra code to use the routines specified in the C++
1534 ABI for thread-safe initialization of local statics.  You can use this
1535 option to reduce code size slightly in code that doesn't need to be
1536 thread-safe.
1537
1538 @item -fuse-cxa-atexit
1539 @opindex fuse-cxa-atexit
1540 Register destructors for objects with static storage duration with the
1541 @code{__cxa_atexit} function rather than the @code{atexit} function.
1542 This option is required for fully standards-compliant handling of static
1543 destructors, but will only work if your C library supports
1544 @code{__cxa_atexit}.
1545
1546 @item -fvisibility-inlines-hidden
1547 @opindex fvisibility-inlines-hidden
1548 Causes all inlined methods to be marked with
1549 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1550 appear in the export table of a DSO and do not require a PLT indirection
1551 when used within the DSO@.  Enabling this option can have a dramatic effect
1552 on load and link times of a DSO as it massively reduces the size of the
1553 dynamic export table when the library makes heavy use of templates.  While
1554 it can cause bloating through duplication of code within each DSO where
1555 it is used, often the wastage is less than the considerable space occupied
1556 by a long symbol name in the export table which is typical when using
1557 templates and namespaces.  For even more savings, combine with the
1558 @option{-fvisibility=hidden} switch.
1559
1560 @item -fno-weak
1561 @opindex fno-weak
1562 Do not use weak symbol support, even if it is provided by the linker.
1563 By default, G++ will use weak symbols if they are available.  This
1564 option exists only for testing, and should not be used by end-users;
1565 it will result in inferior code and has no benefits.  This option may
1566 be removed in a future release of G++.
1567
1568 @item -nostdinc++
1569 @opindex nostdinc++
1570 Do not search for header files in the standard directories specific to
1571 C++, but do still search the other standard directories.  (This option
1572 is used when building the C++ library.)
1573 @end table
1574
1575 In addition, these optimization, warning, and code generation options
1576 have meanings only for C++ programs:
1577
1578 @table @gcctabopt
1579 @item -fno-default-inline
1580 @opindex fno-default-inline
1581 Do not assume @samp{inline} for functions defined inside a class scope.
1582 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1583 functions will have linkage like inline functions; they just won't be
1584 inlined by default.
1585
1586 @item -Wabi @r{(C++ only)}
1587 @opindex Wabi
1588 Warn when G++ generates code that is probably not compatible with the
1589 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1590 all such cases, there are probably some cases that are not warned about,
1591 even though G++ is generating incompatible code.  There may also be
1592 cases where warnings are emitted even though the code that is generated
1593 will be compatible.
1594
1595 You should rewrite your code to avoid these warnings if you are
1596 concerned about the fact that code generated by G++ may not be binary
1597 compatible with code generated by other compilers.
1598
1599 The known incompatibilities at this point include:
1600
1601 @itemize @bullet
1602
1603 @item
1604 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1605 pack data into the same byte as a base class.  For example:
1606
1607 @smallexample
1608 struct A @{ virtual void f(); int f1 : 1; @};
1609 struct B : public A @{ int f2 : 1; @};
1610 @end smallexample
1611
1612 @noindent
1613 In this case, G++ will place @code{B::f2} into the same byte
1614 as@code{A::f1}; other compilers will not.  You can avoid this problem
1615 by explicitly padding @code{A} so that its size is a multiple of the
1616 byte size on your platform; that will cause G++ and other compilers to
1617 layout @code{B} identically.
1618
1619 @item
1620 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1621 tail padding when laying out virtual bases.  For example:
1622
1623 @smallexample
1624 struct A @{ virtual void f(); char c1; @};
1625 struct B @{ B(); char c2; @};
1626 struct C : public A, public virtual B @{@};
1627 @end smallexample
1628
1629 @noindent
1630 In this case, G++ will not place @code{B} into the tail-padding for
1631 @code{A}; other compilers will.  You can avoid this problem by
1632 explicitly padding @code{A} so that its size is a multiple of its
1633 alignment (ignoring virtual base classes); that will cause G++ and other
1634 compilers to layout @code{C} identically.
1635
1636 @item
1637 Incorrect handling of bit-fields with declared widths greater than that
1638 of their underlying types, when the bit-fields appear in a union.  For
1639 example:
1640
1641 @smallexample
1642 union U @{ int i : 4096; @};
1643 @end smallexample
1644
1645 @noindent
1646 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1647 union too small by the number of bits in an @code{int}.
1648
1649 @item
1650 Empty classes can be placed at incorrect offsets.  For example:
1651
1652 @smallexample
1653 struct A @{@};
1654
1655 struct B @{
1656   A a;
1657   virtual void f ();
1658 @};
1659
1660 struct C : public B, public A @{@};
1661 @end smallexample
1662
1663 @noindent
1664 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1665 it should be placed at offset zero.  G++ mistakenly believes that the
1666 @code{A} data member of @code{B} is already at offset zero.
1667
1668 @item
1669 Names of template functions whose types involve @code{typename} or
1670 template template parameters can be mangled incorrectly.
1671
1672 @smallexample
1673 template <typename Q>
1674 void f(typename Q::X) @{@}
1675
1676 template <template <typename> class Q>
1677 void f(typename Q<int>::X) @{@}
1678 @end smallexample
1679
1680 @noindent
1681 Instantiations of these templates may be mangled incorrectly.
1682
1683 @end itemize
1684
1685 @item -Wctor-dtor-privacy @r{(C++ only)}
1686 @opindex Wctor-dtor-privacy
1687 Warn when a class seems unusable because all the constructors or
1688 destructors in that class are private, and it has neither friends nor
1689 public static member functions.
1690
1691 @item -Wnon-virtual-dtor @r{(C++ only)}
1692 @opindex Wnon-virtual-dtor
1693 Warn when a class appears to be polymorphic, thereby requiring a virtual
1694 destructor, yet it declares a non-virtual one.
1695 This warning is enabled by @option{-Wall}.
1696
1697 @item -Wreorder @r{(C++ only)}
1698 @opindex Wreorder
1699 @cindex reordering, warning
1700 @cindex warning for reordering of member initializers
1701 Warn when the order of member initializers given in the code does not
1702 match the order in which they must be executed.  For instance:
1703
1704 @smallexample
1705 struct A @{
1706   int i;
1707   int j;
1708   A(): j (0), i (1) @{ @}
1709 @};
1710 @end smallexample
1711
1712 The compiler will rearrange the member initializers for @samp{i}
1713 and @samp{j} to match the declaration order of the members, emitting
1714 a warning to that effect.  This warning is enabled by @option{-Wall}.
1715 @end table
1716
1717 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1718
1719 @table @gcctabopt
1720 @item -Weffc++ @r{(C++ only)}
1721 @opindex Weffc++
1722 Warn about violations of the following style guidelines from Scott Meyers'
1723 @cite{Effective C++} book:
1724
1725 @itemize @bullet
1726 @item
1727 Item 11:  Define a copy constructor and an assignment operator for classes
1728 with dynamically allocated memory.
1729
1730 @item
1731 Item 12:  Prefer initialization to assignment in constructors.
1732
1733 @item
1734 Item 14:  Make destructors virtual in base classes.
1735
1736 @item
1737 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1738
1739 @item
1740 Item 23:  Don't try to return a reference when you must return an object.
1741
1742 @end itemize
1743
1744 Also warn about violations of the following style guidelines from
1745 Scott Meyers' @cite{More Effective C++} book:
1746
1747 @itemize @bullet
1748 @item
1749 Item 6:  Distinguish between prefix and postfix forms of increment and
1750 decrement operators.
1751
1752 @item
1753 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1754
1755 @end itemize
1756
1757 When selecting this option, be aware that the standard library
1758 headers do not obey all of these guidelines; use @samp{grep -v}
1759 to filter out those warnings.
1760
1761 @item -Wno-deprecated @r{(C++ only)}
1762 @opindex Wno-deprecated
1763 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1764
1765 @item -Wstrict-null-sentinel @r{(C++ only)}
1766 @opindex Wstrict-null-sentinel
1767 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1768 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1769 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1770 it is guaranteed to of the same size as a pointer.  But this use is
1771 not portable across different compilers.
1772
1773 @item -Wno-non-template-friend @r{(C++ only)}
1774 @opindex Wno-non-template-friend
1775 Disable warnings when non-templatized friend functions are declared
1776 within a template.  Since the advent of explicit template specification
1777 support in G++, if the name of the friend is an unqualified-id (i.e.,
1778 @samp{friend foo(int)}), the C++ language specification demands that the
1779 friend declare or define an ordinary, nontemplate function.  (Section
1780 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1781 could be interpreted as a particular specialization of a templatized
1782 function.  Because this non-conforming behavior is no longer the default
1783 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1784 check existing code for potential trouble spots and is on by default.
1785 This new compiler behavior can be turned off with
1786 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1787 but disables the helpful warning.
1788
1789 @item -Wold-style-cast @r{(C++ only)}
1790 @opindex Wold-style-cast
1791 Warn if an old-style (C-style) cast to a non-void type is used within
1792 a C++ program.  The new-style casts (@samp{static_cast},
1793 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1794 unintended effects and much easier to search for.
1795
1796 @item -Woverloaded-virtual @r{(C++ only)}
1797 @opindex Woverloaded-virtual
1798 @cindex overloaded virtual fn, warning
1799 @cindex warning for overloaded virtual fn
1800 Warn when a function declaration hides virtual functions from a
1801 base class.  For example, in:
1802
1803 @smallexample
1804 struct A @{
1805   virtual void f();
1806 @};
1807
1808 struct B: public A @{
1809   void f(int);
1810 @};
1811 @end smallexample
1812
1813 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1814 like:
1815
1816 @smallexample
1817 B* b;
1818 b->f();
1819 @end smallexample
1820
1821 will fail to compile.
1822
1823 @item -Wno-pmf-conversions @r{(C++ only)}
1824 @opindex Wno-pmf-conversions
1825 Disable the diagnostic for converting a bound pointer to member function
1826 to a plain pointer.
1827
1828 @item -Wsign-promo @r{(C++ only)}
1829 @opindex Wsign-promo
1830 Warn when overload resolution chooses a promotion from unsigned or
1831 enumerated type to a signed type, over a conversion to an unsigned type of
1832 the same size.  Previous versions of G++ would try to preserve
1833 unsignedness, but the standard mandates the current behavior.
1834
1835 @smallexample
1836 struct A @{
1837   operator int ();
1838   A& operator = (int);
1839 @};
1840
1841 main ()
1842 @{
1843   A a,b;
1844   a = b;
1845 @}
1846 @end smallexample
1847
1848 In this example, G++ will synthesize a default @samp{A& operator =
1849 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1850 @end table
1851
1852 @node Objective-C and Objective-C++ Dialect Options
1853 @section Options Controlling Objective-C and Objective-C++ Dialects
1854
1855 @cindex compiler options, Objective-C and Objective-C++
1856 @cindex Objective-C and Objective-C++ options, command line
1857 @cindex options, Objective-C and Objective-C++
1858 (NOTE: This manual does not describe the Objective-C and Objective-C++
1859 languages themselves.  See @xref{Standards,,Language Standards
1860 Supported by GCC}, for references.)
1861
1862 This section describes the command-line options that are only meaningful
1863 for Objective-C and Objective-C++ programs, but you can also use most of
1864 the language-independent GNU compiler options.
1865 For example, you might compile a file @code{some_class.m} like this:
1866
1867 @smallexample
1868 gcc -g -fgnu-runtime -O -c some_class.m
1869 @end smallexample
1870
1871 @noindent
1872 In this example, @option{-fgnu-runtime} is an option meant only for
1873 Objective-C and Objective-C++ programs; you can use the other options with
1874 any language supported by GCC@.
1875
1876 Note that since Objective-C is an extension of the C language, Objective-C
1877 compilations may also use options specific to the C front-end (e.g.,
1878 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1879 C++-specific options (e.g., @option{-Wabi}).
1880
1881 Here is a list of options that are @emph{only} for compiling Objective-C
1882 and Objective-C++ programs:
1883
1884 @table @gcctabopt
1885 @item -fconstant-string-class=@var{class-name}
1886 @opindex fconstant-string-class
1887 Use @var{class-name} as the name of the class to instantiate for each
1888 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1889 class name is @code{NXConstantString} if the GNU runtime is being used, and
1890 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1891 @option{-fconstant-cfstrings} option, if also present, will override the
1892 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1893 to be laid out as constant CoreFoundation strings.
1894
1895 @item -fgnu-runtime
1896 @opindex fgnu-runtime
1897 Generate object code compatible with the standard GNU Objective-C
1898 runtime.  This is the default for most types of systems.
1899
1900 @item -fnext-runtime
1901 @opindex fnext-runtime
1902 Generate output compatible with the NeXT runtime.  This is the default
1903 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1904 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1905 used.
1906
1907 @item -fno-nil-receivers
1908 @opindex fno-nil-receivers
1909 Assume that all Objective-C message dispatches (e.g.,
1910 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1911 is not @code{nil}.  This allows for more efficient entry points in the runtime
1912 to be used.  Currently, this option is only available in conjunction with
1913 the NeXT runtime on Mac OS X 10.3 and later.
1914
1915 @item -fobjc-call-cxx-cdtors
1916 @opindex fobjc-call-cxx-cdtors
1917 For each Objective-C class, check if any of its instance variables is a
1918 C++ object with a non-trivial default constructor.  If so, synthesize a
1919 special @code{- (id) .cxx_construct} instance method that will run
1920 non-trivial default constructors on any such instance variables, in order,
1921 and then return @code{self}.  Similarly, check if any instance variable
1922 is a C++ object with a non-trivial destructor, and if so, synthesize a
1923 special @code{- (void) .cxx_destruct} method that will run
1924 all such default destructors, in reverse order.
1925
1926 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1927 thusly generated will only operate on instance variables declared in the
1928 current Objective-C class, and not those inherited from superclasses.  It
1929 is the responsibility of the Objective-C runtime to invoke all such methods
1930 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1931 will be invoked by the runtime immediately after a new object
1932 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1933 be invoked immediately before the runtime deallocates an object instance.
1934
1935 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1936 support for invoking the @code{- (id) .cxx_construct} and
1937 @code{- (void) .cxx_destruct} methods.
1938
1939 @item -fobjc-direct-dispatch
1940 @opindex fobjc-direct-dispatch
1941 Allow fast jumps to the message dispatcher.  On Darwin this is
1942 accomplished via the comm page.
1943
1944 @item -fobjc-exceptions
1945 @opindex fobjc-exceptions
1946 Enable syntactic support for structured exception handling in Objective-C,
1947 similar to what is offered by C++ and Java.  Currently, this option is only
1948 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1949
1950 @smallexample
1951   @@try @{
1952     @dots{}
1953        @@throw expr;
1954     @dots{}
1955   @}
1956   @@catch (AnObjCClass *exc) @{
1957     @dots{}
1958       @@throw expr;
1959     @dots{}
1960       @@throw;
1961     @dots{}
1962   @}
1963   @@catch (AnotherClass *exc) @{
1964     @dots{}
1965   @}
1966   @@catch (id allOthers) @{
1967     @dots{}
1968   @}
1969   @@finally @{
1970     @dots{}
1971       @@throw expr;
1972     @dots{}
1973   @}
1974 @end smallexample
1975
1976 The @code{@@throw} statement may appear anywhere in an Objective-C or
1977 Objective-C++ program; when used inside of a @code{@@catch} block, the
1978 @code{@@throw} may appear without an argument (as shown above), in which case
1979 the object caught by the @code{@@catch} will be rethrown.
1980
1981 Note that only (pointers to) Objective-C objects may be thrown and
1982 caught using this scheme.  When an object is thrown, it will be caught
1983 by the nearest @code{@@catch} clause capable of handling objects of that type,
1984 analogously to how @code{catch} blocks work in C++ and Java.  A
1985 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1986 any and all Objective-C exceptions not caught by previous @code{@@catch}
1987 clauses (if any).
1988
1989 The @code{@@finally} clause, if present, will be executed upon exit from the
1990 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1991 regardless of whether any exceptions are thrown, caught or rethrown
1992 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1993 of the @code{finally} clause in Java.
1994
1995 There are several caveats to using the new exception mechanism:
1996
1997 @itemize @bullet
1998 @item
1999 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2000 idioms provided by the @code{NSException} class, the new
2001 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2002 systems, due to additional functionality needed in the (NeXT) Objective-C
2003 runtime.
2004
2005 @item
2006 As mentioned above, the new exceptions do not support handling
2007 types other than Objective-C objects.   Furthermore, when used from
2008 Objective-C++, the Objective-C exception model does not interoperate with C++
2009 exceptions at this time.  This means you cannot @code{@@throw} an exception
2010 from Objective-C and @code{catch} it in C++, or vice versa
2011 (i.e., @code{throw @dots{} @@catch}).
2012 @end itemize
2013
2014 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2015 blocks for thread-safe execution:
2016
2017 @smallexample
2018   @@synchronized (ObjCClass *guard) @{
2019     @dots{}
2020   @}
2021 @end smallexample
2022
2023 Upon entering the @code{@@synchronized} block, a thread of execution shall
2024 first check whether a lock has been placed on the corresponding @code{guard}
2025 object by another thread.  If it has, the current thread shall wait until
2026 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2027 the current thread will place its own lock on it, execute the code contained in
2028 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2029 making @code{guard} available to other threads).
2030
2031 Unlike Java, Objective-C does not allow for entire methods to be marked
2032 @code{@@synchronized}.  Note that throwing exceptions out of
2033 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2034 to be unlocked properly.
2035
2036 @item -fobjc-gc
2037 @opindex fobjc-gc
2038 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2039
2040 @item -freplace-objc-classes
2041 @opindex freplace-objc-classes
2042 Emit a special marker instructing @command{ld(1)} not to statically link in
2043 the resulting object file, and allow @command{dyld(1)} to load it in at
2044 run time instead.  This is used in conjunction with the Fix-and-Continue
2045 debugging mode, where the object file in question may be recompiled and
2046 dynamically reloaded in the course of program execution, without the need
2047 to restart the program itself.  Currently, Fix-and-Continue functionality
2048 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2049 and later.
2050
2051 @item -fzero-link
2052 @opindex fzero-link
2053 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2054 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2055 compile time) with static class references that get initialized at load time,
2056 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2057 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2058 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2059 for individual class implementations to be modified during program execution.
2060
2061 @item -gen-decls
2062 @opindex gen-decls
2063 Dump interface declarations for all classes seen in the source file to a
2064 file named @file{@var{sourcename}.decl}.
2065
2066 @item -Wassign-intercept
2067 @opindex Wassign-intercept
2068 Warn whenever an Objective-C assignment is being intercepted by the
2069 garbage collector.
2070
2071 @item -Wno-protocol
2072 @opindex Wno-protocol
2073 If a class is declared to implement a protocol, a warning is issued for
2074 every method in the protocol that is not implemented by the class.  The
2075 default behavior is to issue a warning for every method not explicitly
2076 implemented in the class, even if a method implementation is inherited
2077 from the superclass.  If you use the @option{-Wno-protocol} option, then
2078 methods inherited from the superclass are considered to be implemented,
2079 and no warning is issued for them.
2080
2081 @item -Wselector
2082 @opindex Wselector
2083 Warn if multiple methods of different types for the same selector are
2084 found during compilation.  The check is performed on the list of methods
2085 in the final stage of compilation.  Additionally, a check is performed
2086 for each selector appearing in a @code{@@selector(@dots{})}
2087 expression, and a corresponding method for that selector has been found
2088 during compilation.  Because these checks scan the method table only at
2089 the end of compilation, these warnings are not produced if the final
2090 stage of compilation is not reached, for example because an error is
2091 found during compilation, or because the @option{-fsyntax-only} option is
2092 being used.
2093
2094 @item -Wstrict-selector-match
2095 @opindex Wstrict-selector-match
2096 Warn if multiple methods with differing argument and/or return types are
2097 found for a given selector when attempting to send a message using this
2098 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2099 is off (which is the default behavior), the compiler will omit such warnings
2100 if any differences found are confined to types which share the same size
2101 and alignment.
2102
2103 @item -Wundeclared-selector
2104 @opindex Wundeclared-selector
2105 Warn if a @code{@@selector(@dots{})} expression referring to an
2106 undeclared selector is found.  A selector is considered undeclared if no
2107 method with that name has been declared before the
2108 @code{@@selector(@dots{})} expression, either explicitly in an
2109 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2110 an @code{@@implementation} section.  This option always performs its
2111 checks as soon as a @code{@@selector(@dots{})} expression is found,
2112 while @option{-Wselector} only performs its checks in the final stage of
2113 compilation.  This also enforces the coding style convention
2114 that methods and selectors must be declared before being used.
2115
2116 @item -print-objc-runtime-info
2117 @opindex print-objc-runtime-info
2118 Generate C header describing the largest structure that is passed by
2119 value, if any.
2120
2121 @end table
2122
2123 @node Language Independent Options
2124 @section Options to Control Diagnostic Messages Formatting
2125 @cindex options to control diagnostics formatting
2126 @cindex diagnostic messages
2127 @cindex message formatting
2128
2129 Traditionally, diagnostic messages have been formatted irrespective of
2130 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2131 below can be used to control the diagnostic messages formatting
2132 algorithm, e.g.@: how many characters per line, how often source location
2133 information should be reported.  Right now, only the C++ front end can
2134 honor these options.  However it is expected, in the near future, that
2135 the remaining front ends would be able to digest them correctly.
2136
2137 @table @gcctabopt
2138 @item -fmessage-length=@var{n}
2139 @opindex fmessage-length
2140 Try to format error messages so that they fit on lines of about @var{n}
2141 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2142 the front ends supported by GCC@.  If @var{n} is zero, then no
2143 line-wrapping will be done; each error message will appear on a single
2144 line.
2145
2146 @opindex fdiagnostics-show-location
2147 @item -fdiagnostics-show-location=once
2148 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2149 reporter to emit @emph{once} source location information; that is, in
2150 case the message is too long to fit on a single physical line and has to
2151 be wrapped, the source location won't be emitted (as prefix) again,
2152 over and over, in subsequent continuation lines.  This is the default
2153 behavior.
2154
2155 @item -fdiagnostics-show-location=every-line
2156 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2157 messages reporter to emit the same source location information (as
2158 prefix) for physical lines that result from the process of breaking
2159 a message which is too long to fit on a single line.
2160
2161 @item -fdiagnostics-show-options
2162 @opindex fdiagnostics-show-options
2163 This option instructs the diagnostic machinery to add text to each
2164 diagnostic emitted, which indicates which command line option directly
2165 controls that diagnostic, when such an option is known to the
2166 diagnostic machinery.
2167
2168 @end table
2169
2170 @node Warning Options
2171 @section Options to Request or Suppress Warnings
2172 @cindex options to control warnings
2173 @cindex warning messages
2174 @cindex messages, warning
2175 @cindex suppressing warnings
2176
2177 Warnings are diagnostic messages that report constructions which
2178 are not inherently erroneous but which are risky or suggest there
2179 may have been an error.
2180
2181 You can request many specific warnings with options beginning @samp{-W},
2182 for example @option{-Wimplicit} to request warnings on implicit
2183 declarations.  Each of these specific warning options also has a
2184 negative form beginning @samp{-Wno-} to turn off warnings;
2185 for example, @option{-Wno-implicit}.  This manual lists only one of the
2186 two forms, whichever is not the default.
2187
2188 The following options control the amount and kinds of warnings produced
2189 by GCC; for further, language-specific options also refer to
2190 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2191 Options}.
2192
2193 @table @gcctabopt
2194 @cindex syntax checking
2195 @item -fsyntax-only
2196 @opindex fsyntax-only
2197 Check the code for syntax errors, but don't do anything beyond that.
2198
2199 @item -pedantic
2200 @opindex pedantic
2201 Issue all the warnings demanded by strict ISO C and ISO C++;
2202 reject all programs that use forbidden extensions, and some other
2203 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2204 version of the ISO C standard specified by any @option{-std} option used.
2205
2206 Valid ISO C and ISO C++ programs should compile properly with or without
2207 this option (though a rare few will require @option{-ansi} or a
2208 @option{-std} option specifying the required version of ISO C)@.  However,
2209 without this option, certain GNU extensions and traditional C and C++
2210 features are supported as well.  With this option, they are rejected.
2211
2212 @option{-pedantic} does not cause warning messages for use of the
2213 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2214 warnings are also disabled in the expression that follows
2215 @code{__extension__}.  However, only system header files should use
2216 these escape routes; application programs should avoid them.
2217 @xref{Alternate Keywords}.
2218
2219 Some users try to use @option{-pedantic} to check programs for strict ISO
2220 C conformance.  They soon find that it does not do quite what they want:
2221 it finds some non-ISO practices, but not all---only those for which
2222 ISO C @emph{requires} a diagnostic, and some others for which
2223 diagnostics have been added.
2224
2225 A feature to report any failure to conform to ISO C might be useful in
2226 some instances, but would require considerable additional work and would
2227 be quite different from @option{-pedantic}.  We don't have plans to
2228 support such a feature in the near future.
2229
2230 Where the standard specified with @option{-std} represents a GNU
2231 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2232 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2233 extended dialect is based.  Warnings from @option{-pedantic} are given
2234 where they are required by the base standard.  (It would not make sense
2235 for such warnings to be given only for features not in the specified GNU
2236 C dialect, since by definition the GNU dialects of C include all
2237 features the compiler supports with the given option, and there would be
2238 nothing to warn about.)
2239
2240 @item -pedantic-errors
2241 @opindex pedantic-errors
2242 Like @option{-pedantic}, except that errors are produced rather than
2243 warnings.
2244
2245 @item -w
2246 @opindex w
2247 Inhibit all warning messages.
2248
2249 @item -Wno-import
2250 @opindex Wno-import
2251 Inhibit warning messages about the use of @samp{#import}.
2252
2253 @item -Wchar-subscripts
2254 @opindex Wchar-subscripts
2255 Warn if an array subscript has type @code{char}.  This is a common cause
2256 of error, as programmers often forget that this type is signed on some
2257 machines.
2258 This warning is enabled by @option{-Wall}.
2259
2260 @item -Wcomment
2261 @opindex Wcomment
2262 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2263 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2264 This warning is enabled by @option{-Wall}.
2265
2266 @item -Wfatal-errors
2267 @opindex Wfatal-errors
2268 This option causes the compiler to abort compilation on the first error
2269 occurred rather than trying to keep going and printing further error
2270 messages.
2271
2272 @item -Wformat
2273 @opindex Wformat
2274 @opindex ffreestanding
2275 @opindex fno-builtin
2276 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2277 the arguments supplied have types appropriate to the format string
2278 specified, and that the conversions specified in the format string make
2279 sense.  This includes standard functions, and others specified by format
2280 attributes (@pxref{Function Attributes}), in the @code{printf},
2281 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2282 not in the C standard) families (or other target-specific families).
2283 Which functions are checked without format attributes having been
2284 specified depends on the standard version selected, and such checks of
2285 functions without the attribute specified are disabled by
2286 @option{-ffreestanding} or @option{-fno-builtin}.
2287
2288 The formats are checked against the format features supported by GNU
2289 libc version 2.2.  These include all ISO C90 and C99 features, as well
2290 as features from the Single Unix Specification and some BSD and GNU
2291 extensions.  Other library implementations may not support all these
2292 features; GCC does not support warning about features that go beyond a
2293 particular library's limitations.  However, if @option{-pedantic} is used
2294 with @option{-Wformat}, warnings will be given about format features not
2295 in the selected standard version (but not for @code{strfmon} formats,
2296 since those are not in any version of the C standard).  @xref{C Dialect
2297 Options,,Options Controlling C Dialect}.
2298
2299 Since @option{-Wformat} also checks for null format arguments for
2300 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2301
2302 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2303 aspects of format checking, the options @option{-Wformat-y2k},
2304 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2305 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2306 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2307
2308 @item -Wformat-y2k
2309 @opindex Wformat-y2k
2310 If @option{-Wformat} is specified, also warn about @code{strftime}
2311 formats which may yield only a two-digit year.
2312
2313 @item -Wno-format-extra-args
2314 @opindex Wno-format-extra-args
2315 If @option{-Wformat} is specified, do not warn about excess arguments to a
2316 @code{printf} or @code{scanf} format function.  The C standard specifies
2317 that such arguments are ignored.
2318
2319 Where the unused arguments lie between used arguments that are
2320 specified with @samp{$} operand number specifications, normally
2321 warnings are still given, since the implementation could not know what
2322 type to pass to @code{va_arg} to skip the unused arguments.  However,
2323 in the case of @code{scanf} formats, this option will suppress the
2324 warning if the unused arguments are all pointers, since the Single
2325 Unix Specification says that such unused arguments are allowed.
2326
2327 @item -Wno-format-zero-length
2328 @opindex Wno-format-zero-length
2329 If @option{-Wformat} is specified, do not warn about zero-length formats.
2330 The C standard specifies that zero-length formats are allowed.
2331
2332 @item -Wformat-nonliteral
2333 @opindex Wformat-nonliteral
2334 If @option{-Wformat} is specified, also warn if the format string is not a
2335 string literal and so cannot be checked, unless the format function
2336 takes its format arguments as a @code{va_list}.
2337
2338 @item -Wformat-security
2339 @opindex Wformat-security
2340 If @option{-Wformat} is specified, also warn about uses of format
2341 functions that represent possible security problems.  At present, this
2342 warns about calls to @code{printf} and @code{scanf} functions where the
2343 format string is not a string literal and there are no format arguments,
2344 as in @code{printf (foo);}.  This may be a security hole if the format
2345 string came from untrusted input and contains @samp{%n}.  (This is
2346 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2347 in future warnings may be added to @option{-Wformat-security} that are not
2348 included in @option{-Wformat-nonliteral}.)
2349
2350 @item -Wformat=2
2351 @opindex Wformat=2
2352 Enable @option{-Wformat} plus format checks not included in
2353 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2354 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2355
2356 @item -Wnonnull
2357 @opindex Wnonnull
2358 Warn about passing a null pointer for arguments marked as
2359 requiring a non-null value by the @code{nonnull} function attribute.
2360
2361 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2362 can be disabled with the @option{-Wno-nonnull} option.
2363
2364 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2365 @opindex Winit-self
2366 Warn about uninitialized variables which are initialized with themselves.
2367 Note this option can only be used with the @option{-Wuninitialized} option,
2368 which in turn only works with @option{-O1} and above.
2369
2370 For example, GCC will warn about @code{i} being uninitialized in the
2371 following snippet only when @option{-Winit-self} has been specified:
2372 @smallexample
2373 @group
2374 int f()
2375 @{
2376   int i = i;
2377   return i;
2378 @}
2379 @end group
2380 @end smallexample
2381
2382 @item -Wimplicit-int
2383 @opindex Wimplicit-int
2384 Warn when a declaration does not specify a type.
2385 This warning is enabled by @option{-Wall}.
2386
2387 @item -Wimplicit-function-declaration
2388 @itemx -Werror-implicit-function-declaration
2389 @opindex Wimplicit-function-declaration
2390 @opindex Werror-implicit-function-declaration
2391 Give a warning (or error) whenever a function is used before being
2392 declared.  The form @option{-Wno-error-implicit-function-declaration}
2393 is not supported.
2394 This warning is enabled by @option{-Wall} (as a warning, not an error).
2395
2396 @item -Wimplicit
2397 @opindex Wimplicit
2398 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2399 This warning is enabled by @option{-Wall}.
2400
2401 @item -Wmain
2402 @opindex Wmain
2403 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2404 function with external linkage, returning int, taking either zero
2405 arguments, two, or three arguments of appropriate types.
2406 This warning is enabled by @option{-Wall}.
2407
2408 @item -Wmissing-braces
2409 @opindex Wmissing-braces
2410 Warn if an aggregate or union initializer is not fully bracketed.  In
2411 the following example, the initializer for @samp{a} is not fully
2412 bracketed, but that for @samp{b} is fully bracketed.
2413
2414 @smallexample
2415 int a[2][2] = @{ 0, 1, 2, 3 @};
2416 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2417 @end smallexample
2418
2419 This warning is enabled by @option{-Wall}.
2420
2421 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2422 @opindex Wmissing-include-dirs
2423 Warn if a user-supplied include directory does not exist.
2424
2425 @item -Wparentheses
2426 @opindex Wparentheses
2427 Warn if parentheses are omitted in certain contexts, such
2428 as when there is an assignment in a context where a truth value
2429 is expected, or when operators are nested whose precedence people
2430 often get confused about.  Only the warning for an assignment used as
2431 a truth value is supported when compiling C++; the other warnings are
2432 only supported when compiling C@.
2433
2434 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2435 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2436 interpretation from that of ordinary mathematical notation.
2437
2438 Also warn about constructions where there may be confusion to which
2439 @code{if} statement an @code{else} branch belongs.  Here is an example of
2440 such a case:
2441
2442 @smallexample
2443 @group
2444 @{
2445   if (a)
2446     if (b)
2447       foo ();
2448   else
2449     bar ();
2450 @}
2451 @end group
2452 @end smallexample
2453
2454 In C, every @code{else} branch belongs to the innermost possible @code{if}
2455 statement, which in this example is @code{if (b)}.  This is often not
2456 what the programmer expected, as illustrated in the above example by
2457 indentation the programmer chose.  When there is the potential for this
2458 confusion, GCC will issue a warning when this flag is specified.
2459 To eliminate the warning, add explicit braces around the innermost
2460 @code{if} statement so there is no way the @code{else} could belong to
2461 the enclosing @code{if}.  The resulting code would look like this:
2462
2463 @smallexample
2464 @group
2465 @{
2466   if (a)
2467     @{
2468       if (b)
2469         foo ();
2470       else
2471         bar ();
2472     @}
2473 @}
2474 @end group
2475 @end smallexample
2476
2477 This warning is enabled by @option{-Wall}.
2478
2479 @item -Wsequence-point
2480 @opindex Wsequence-point
2481 Warn about code that may have undefined semantics because of violations
2482 of sequence point rules in the C standard.
2483
2484 The C standard defines the order in which expressions in a C program are
2485 evaluated in terms of @dfn{sequence points}, which represent a partial
2486 ordering between the execution of parts of the program: those executed
2487 before the sequence point, and those executed after it.  These occur
2488 after the evaluation of a full expression (one which is not part of a
2489 larger expression), after the evaluation of the first operand of a
2490 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2491 function is called (but after the evaluation of its arguments and the
2492 expression denoting the called function), and in certain other places.
2493 Other than as expressed by the sequence point rules, the order of
2494 evaluation of subexpressions of an expression is not specified.  All
2495 these rules describe only a partial order rather than a total order,
2496 since, for example, if two functions are called within one expression
2497 with no sequence point between them, the order in which the functions
2498 are called is not specified.  However, the standards committee have
2499 ruled that function calls do not overlap.
2500
2501 It is not specified when between sequence points modifications to the
2502 values of objects take effect.  Programs whose behavior depends on this
2503 have undefined behavior; the C standard specifies that ``Between the
2504 previous and next sequence point an object shall have its stored value
2505 modified at most once by the evaluation of an expression.  Furthermore,
2506 the prior value shall be read only to determine the value to be
2507 stored.''.  If a program breaks these rules, the results on any
2508 particular implementation are entirely unpredictable.
2509
2510 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2511 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2512 diagnosed by this option, and it may give an occasional false positive
2513 result, but in general it has been found fairly effective at detecting
2514 this sort of problem in programs.
2515
2516 The present implementation of this option only works for C programs.  A
2517 future implementation may also work for C++ programs.
2518
2519 The C standard is worded confusingly, therefore there is some debate
2520 over the precise meaning of the sequence point rules in subtle cases.
2521 Links to discussions of the problem, including proposed formal
2522 definitions, may be found on the GCC readings page, at
2523 @w{@uref{http://gcc.gnu.org/readings.html}}.
2524
2525 This warning is enabled by @option{-Wall}.
2526
2527 @item -Wreturn-type
2528 @opindex Wreturn-type
2529 Warn whenever a function is defined with a return-type that defaults to
2530 @code{int}.  Also warn about any @code{return} statement with no
2531 return-value in a function whose return-type is not @code{void}.
2532
2533 For C, also warn if the return type of a function has a type qualifier
2534 such as @code{const}.  Such a type qualifier has no effect, since the
2535 value returned by a function is not an lvalue.  ISO C prohibits
2536 qualified @code{void} return types on function definitions, so such
2537 return types always receive a warning even without this option.
2538
2539 For C++, a function without return type always produces a diagnostic
2540 message, even when @option{-Wno-return-type} is specified.  The only
2541 exceptions are @samp{main} and functions defined in system headers.
2542
2543 This warning is enabled by @option{-Wall}.
2544
2545 @item -Wswitch
2546 @opindex Wswitch
2547 Warn whenever a @code{switch} statement has an index of enumerated type
2548 and lacks a @code{case} for one or more of the named codes of that
2549 enumeration.  (The presence of a @code{default} label prevents this
2550 warning.)  @code{case} labels outside the enumeration range also
2551 provoke warnings when this option is used.
2552 This warning is enabled by @option{-Wall}.
2553
2554 @item -Wswitch-default
2555 @opindex Wswitch-switch
2556 Warn whenever a @code{switch} statement does not have a @code{default}
2557 case.
2558
2559 @item -Wswitch-enum
2560 @opindex Wswitch-enum
2561 Warn whenever a @code{switch} statement has an index of enumerated type
2562 and lacks a @code{case} for one or more of the named codes of that
2563 enumeration.  @code{case} labels outside the enumeration range also
2564 provoke warnings when this option is used.
2565
2566 @item -Wtrigraphs
2567 @opindex Wtrigraphs
2568 Warn if any trigraphs are encountered that might change the meaning of
2569 the program (trigraphs within comments are not warned about).
2570 This warning is enabled by @option{-Wall}.
2571
2572 @item -Wunused-function
2573 @opindex Wunused-function
2574 Warn whenever a static function is declared but not defined or a
2575 non\-inline static function is unused.
2576 This warning is enabled by @option{-Wall}.
2577
2578 @item -Wunused-label
2579 @opindex Wunused-label
2580 Warn whenever a label is declared but not used.
2581 This warning is enabled by @option{-Wall}.
2582
2583 To suppress this warning use the @samp{unused} attribute
2584 (@pxref{Variable Attributes}).
2585
2586 @item -Wunused-parameter
2587 @opindex Wunused-parameter
2588 Warn whenever a function parameter is unused aside from its declaration.
2589
2590 To suppress this warning use the @samp{unused} attribute
2591 (@pxref{Variable Attributes}).
2592
2593 @item -Wunused-variable
2594 @opindex Wunused-variable
2595 Warn whenever a local variable or non-constant static variable is unused
2596 aside from its declaration
2597 This warning is enabled by @option{-Wall}.
2598
2599 To suppress this warning use the @samp{unused} attribute
2600 (@pxref{Variable Attributes}).
2601
2602 @item -Wunused-value
2603 @opindex Wunused-value
2604 Warn whenever a statement computes a result that is explicitly not used.
2605 This warning is enabled by @option{-Wall}.
2606
2607 To suppress this warning cast the expression to @samp{void}.
2608
2609 @item -Wunused
2610 @opindex Wunused
2611 All the above @option{-Wunused} options combined.
2612
2613 In order to get a warning about an unused function parameter, you must
2614 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2615 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2616
2617 @item -Wuninitialized
2618 @opindex Wuninitialized
2619 Warn if an automatic variable is used without first being initialized or
2620 if a variable may be clobbered by a @code{setjmp} call.
2621
2622 These warnings are possible only in optimizing compilation,
2623 because they require data flow information that is computed only
2624 when optimizing.  If you don't specify @option{-O}, you simply won't
2625 get these warnings.
2626
2627 If you want to warn about code which uses the uninitialized value of the
2628 variable in its own initializer, use the @option{-Winit-self} option.
2629
2630 These warnings occur for individual uninitialized or clobbered
2631 elements of structure, union or array variables as well as for
2632 variables which are uninitialized or clobbered as a whole.  They do
2633 not occur for variables or elements declared @code{volatile}.  Because
2634 these warnings depend on optimization, the exact variables or elements
2635 for which there are warnings will depend on the precise optimization
2636 options and version of GCC used.
2637
2638 Note that there may be no warning about a variable that is used only
2639 to compute a value that itself is never used, because such
2640 computations may be deleted by data flow analysis before the warnings
2641 are printed.
2642
2643 These warnings are made optional because GCC is not smart
2644 enough to see all the reasons why the code might be correct
2645 despite appearing to have an error.  Here is one example of how
2646 this can happen:
2647
2648 @smallexample
2649 @group
2650 @{
2651   int x;
2652   switch (y)
2653     @{
2654     case 1: x = 1;
2655       break;
2656     case 2: x = 4;
2657       break;
2658     case 3: x = 5;
2659     @}
2660   foo (x);
2661 @}
2662 @end group
2663 @end smallexample
2664
2665 @noindent
2666 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2667 always initialized, but GCC doesn't know this.  Here is
2668 another common case:
2669
2670 @smallexample
2671 @{
2672   int save_y;
2673   if (change_y) save_y = y, y = new_y;
2674   @dots{}
2675   if (change_y) y = save_y;
2676 @}
2677 @end smallexample
2678
2679 @noindent
2680 This has no bug because @code{save_y} is used only if it is set.
2681
2682 @cindex @code{longjmp} warnings
2683 This option also warns when a non-volatile automatic variable might be
2684 changed by a call to @code{longjmp}.  These warnings as well are possible
2685 only in optimizing compilation.
2686
2687 The compiler sees only the calls to @code{setjmp}.  It cannot know
2688 where @code{longjmp} will be called; in fact, a signal handler could
2689 call it at any point in the code.  As a result, you may get a warning
2690 even when there is in fact no problem because @code{longjmp} cannot
2691 in fact be called at the place which would cause a problem.
2692
2693 Some spurious warnings can be avoided if you declare all the functions
2694 you use that never return as @code{noreturn}.  @xref{Function
2695 Attributes}.
2696
2697 This warning is enabled by @option{-Wall}.
2698
2699 @item -Wunknown-pragmas
2700 @opindex Wunknown-pragmas
2701 @cindex warning for unknown pragmas
2702 @cindex unknown pragmas, warning
2703 @cindex pragmas, warning of unknown
2704 Warn when a #pragma directive is encountered which is not understood by
2705 GCC@.  If this command line option is used, warnings will even be issued
2706 for unknown pragmas in system header files.  This is not the case if
2707 the warnings were only enabled by the @option{-Wall} command line option.
2708
2709 @item -Wno-pragmas
2710 @opindex Wno-pragmas
2711 @opindex Wpragmas
2712 Do not warn about misuses of pragmas, such as incorrect parameters,
2713 invalid syntax, or conflicts between pragmas.  See also
2714 @samp{-Wunknown-pragmas}.
2715
2716 @item -Wstrict-aliasing
2717 @opindex Wstrict-aliasing
2718 This option is only active when @option{-fstrict-aliasing} is active.
2719 It warns about code which might break the strict aliasing rules that the
2720 compiler is using for optimization.  The warning does not catch all
2721 cases, but does attempt to catch the more common pitfalls.  It is
2722 included in @option{-Wall}.
2723
2724 @item -Wstrict-aliasing=2
2725 @opindex Wstrict-aliasing=2
2726 This option is only active when @option{-fstrict-aliasing} is active.
2727 It warns about all code which might break the strict aliasing rules that the
2728 compiler is using for optimization.  This warning catches all cases, but
2729 it will also give a warning for some ambiguous cases that are safe.
2730
2731 @item -Wall
2732 @opindex Wall
2733 All of the above @samp{-W} options combined.  This enables all the
2734 warnings about constructions that some users consider questionable, and
2735 that are easy to avoid (or modify to prevent the warning), even in
2736 conjunction with macros.  This also enables some language-specific
2737 warnings described in @ref{C++ Dialect Options} and
2738 @ref{Objective-C and Objective-C++ Dialect Options}.
2739 @end table
2740
2741 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2742 Some of them warn about constructions that users generally do not
2743 consider questionable, but which occasionally you might wish to check
2744 for; others warn about constructions that are necessary or hard to avoid
2745 in some cases, and there is no simple way to modify the code to suppress
2746 the warning.
2747
2748 @table @gcctabopt
2749 @item -Wextra
2750 @opindex W
2751 @opindex Wextra
2752 (This option used to be called @option{-W}.  The older name is still
2753 supported, but the newer name is more descriptive.)  Print extra warning
2754 messages for these events:
2755
2756 @itemize @bullet
2757 @item
2758 A function can return either with or without a value.  (Falling
2759 off the end of the function body is considered returning without
2760 a value.)  For example, this function would evoke such a
2761 warning:
2762
2763 @smallexample
2764 @group
2765 foo (a)
2766 @{
2767   if (a > 0)
2768     return a;
2769 @}
2770 @end group
2771 @end smallexample
2772
2773 @item
2774 An expression-statement or the left-hand side of a comma expression
2775 contains no side effects.
2776 To suppress the warning, cast the unused expression to void.
2777 For example, an expression such as @samp{x[i,j]} will cause a warning,
2778 but @samp{x[(void)i,j]} will not.
2779
2780 @item
2781 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2782
2783 @item
2784 Storage-class specifiers like @code{static} are not the first things in
2785 a declaration.  According to the C Standard, this usage is obsolescent.
2786
2787 @item
2788 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2789 arguments.
2790
2791 @item
2792 A comparison between signed and unsigned values could produce an
2793 incorrect result when the signed value is converted to unsigned.
2794 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2795
2796 @item
2797 An aggregate has an initializer which does not initialize all members.
2798 This warning can be independently controlled by
2799 @option{-Wmissing-field-initializers}.
2800
2801 @item
2802 A function parameter is declared without a type specifier in K&R-style
2803 functions:
2804
2805 @smallexample
2806 void foo(bar) @{ @}
2807 @end smallexample
2808
2809 @item
2810 An empty body occurs in an @samp{if} or @samp{else} statement.
2811
2812 @item
2813 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2814 @samp{>}, or @samp{>=}.
2815
2816 @item
2817 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2818
2819 @item
2820 Any of several floating-point events that often indicate errors, such as
2821 overflow, underflow, loss of precision, etc.
2822
2823 @item @r{(C++ only)}
2824 An enumerator and a non-enumerator both appear in a conditional expression.
2825
2826 @item @r{(C++ only)}
2827 A non-static reference or non-static @samp{const} member appears in a
2828 class without constructors.
2829
2830 @item @r{(C++ only)}
2831 Ambiguous virtual bases.
2832
2833 @item @r{(C++ only)}
2834 Subscripting an array which has been declared @samp{register}.
2835
2836 @item @r{(C++ only)}
2837 Taking the address of a variable which has been declared @samp{register}.
2838
2839 @item @r{(C++ only)}
2840 A base class is not initialized in a derived class' copy constructor.
2841 @end itemize
2842
2843 @item -Wno-div-by-zero
2844 @opindex Wno-div-by-zero
2845 @opindex Wdiv-by-zero
2846 Do not warn about compile-time integer division by zero.  Floating point
2847 division by zero is not warned about, as it can be a legitimate way of
2848 obtaining infinities and NaNs.
2849
2850 @item -Wsystem-headers
2851 @opindex Wsystem-headers
2852 @cindex warnings from system headers
2853 @cindex system headers, warnings from
2854 Print warning messages for constructs found in system header files.
2855 Warnings from system headers are normally suppressed, on the assumption
2856 that they usually do not indicate real problems and would only make the
2857 compiler output harder to read.  Using this command line option tells
2858 GCC to emit warnings from system headers as if they occurred in user
2859 code.  However, note that using @option{-Wall} in conjunction with this
2860 option will @emph{not} warn about unknown pragmas in system
2861 headers---for that, @option{-Wunknown-pragmas} must also be used.
2862
2863 @item -Wfloat-equal
2864 @opindex Wfloat-equal
2865 Warn if floating point values are used in equality comparisons.
2866
2867 The idea behind this is that sometimes it is convenient (for the
2868 programmer) to consider floating-point values as approximations to
2869 infinitely precise real numbers.  If you are doing this, then you need
2870 to compute (by analyzing the code, or in some other way) the maximum or
2871 likely maximum error that the computation introduces, and allow for it
2872 when performing comparisons (and when producing output, but that's a
2873 different problem).  In particular, instead of testing for equality, you
2874 would check to see whether the two values have ranges that overlap; and
2875 this is done with the relational operators, so equality comparisons are
2876 probably mistaken.
2877
2878 @item -Wtraditional @r{(C only)}
2879 @opindex Wtraditional
2880 Warn about certain constructs that behave differently in traditional and
2881 ISO C@.  Also warn about ISO C constructs that have no traditional C
2882 equivalent, and/or problematic constructs which should be avoided.
2883
2884 @itemize @bullet
2885 @item
2886 Macro parameters that appear within string literals in the macro body.
2887 In traditional C macro replacement takes place within string literals,
2888 but does not in ISO C@.
2889
2890 @item
2891 In traditional C, some preprocessor directives did not exist.
2892 Traditional preprocessors would only consider a line to be a directive
2893 if the @samp{#} appeared in column 1 on the line.  Therefore
2894 @option{-Wtraditional} warns about directives that traditional C
2895 understands but would ignore because the @samp{#} does not appear as the
2896 first character on the line.  It also suggests you hide directives like
2897 @samp{#pragma} not understood by traditional C by indenting them.  Some
2898 traditional implementations would not recognize @samp{#elif}, so it
2899 suggests avoiding it altogether.
2900
2901 @item
2902 A function-like macro that appears without arguments.
2903
2904 @item
2905 The unary plus operator.
2906
2907 @item
2908 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2909 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2910 constants.)  Note, these suffixes appear in macros defined in the system
2911 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2912 Use of these macros in user code might normally lead to spurious
2913 warnings, however GCC's integrated preprocessor has enough context to
2914 avoid warning in these cases.
2915
2916 @item
2917 A function declared external in one block and then used after the end of
2918 the block.
2919
2920 @item
2921 A @code{switch} statement has an operand of type @code{long}.
2922
2923 @item
2924 A non-@code{static} function declaration follows a @code{static} one.
2925 This construct is not accepted by some traditional C compilers.
2926
2927 @item
2928 The ISO type of an integer constant has a different width or
2929 signedness from its traditional type.  This warning is only issued if
2930 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2931 typically represent bit patterns, are not warned about.
2932
2933 @item
2934 Usage of ISO string concatenation is detected.
2935
2936 @item
2937 Initialization of automatic aggregates.
2938
2939 @item
2940 Identifier conflicts with labels.  Traditional C lacks a separate
2941 namespace for labels.
2942
2943 @item
2944 Initialization of unions.  If the initializer is zero, the warning is
2945 omitted.  This is done under the assumption that the zero initializer in
2946 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2947 initializer warnings and relies on default initialization to zero in the
2948 traditional C case.
2949
2950 @item
2951 Conversions by prototypes between fixed/floating point values and vice
2952 versa.  The absence of these prototypes when compiling with traditional
2953 C would cause serious problems.  This is a subset of the possible
2954 conversion warnings, for the full set use @option{-Wconversion}.
2955
2956 @item
2957 Use of ISO C style function definitions.  This warning intentionally is
2958 @emph{not} issued for prototype declarations or variadic functions
2959 because these ISO C features will appear in your code when using
2960 libiberty's traditional C compatibility macros, @code{PARAMS} and
2961 @code{VPARAMS}.  This warning is also bypassed for nested functions
2962 because that feature is already a GCC extension and thus not relevant to
2963 traditional C compatibility.
2964 @end itemize
2965
2966 @item -Wdeclaration-after-statement @r{(C only)}
2967 @opindex Wdeclaration-after-statement
2968 Warn when a declaration is found after a statement in a block.  This
2969 construct, known from C++, was introduced with ISO C99 and is by default
2970 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2971 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2972
2973 @item -Wundef
2974 @opindex Wundef
2975 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2976
2977 @item -Wno-endif-labels
2978 @opindex Wno-endif-labels
2979 @opindex Wendif-labels
2980 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2981
2982 @item -Wshadow
2983 @opindex Wshadow
2984 Warn whenever a local variable shadows another local variable, parameter or
2985 global variable or whenever a built-in function is shadowed.
2986
2987 @item -Wlarger-than-@var{len}
2988 @opindex Wlarger-than
2989 Warn whenever an object of larger than @var{len} bytes is defined.
2990
2991 @item -Wpointer-arith
2992 @opindex Wpointer-arith
2993 Warn about anything that depends on the ``size of'' a function type or
2994 of @code{void}.  GNU C assigns these types a size of 1, for
2995 convenience in calculations with @code{void *} pointers and pointers
2996 to functions.
2997
2998 @item -Wbad-function-cast @r{(C only)}
2999 @opindex Wbad-function-cast
3000 Warn whenever a function call is cast to a non-matching type.
3001 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3002
3003 @item -Wc++-compat
3004 Warn about ISO C constructs that are outside of the common subset of
3005 ISO C and ISO C++, e.g.@: request for implicit conversion from
3006 @code{void *} to a pointer to non-@code{void} type.
3007
3008 @item -Wcast-qual
3009 @opindex Wcast-qual
3010 Warn whenever a pointer is cast so as to remove a type qualifier from
3011 the target type.  For example, warn if a @code{const char *} is cast
3012 to an ordinary @code{char *}.
3013
3014 @item -Wcast-align
3015 @opindex Wcast-align
3016 Warn whenever a pointer is cast such that the required alignment of the
3017 target is increased.  For example, warn if a @code{char *} is cast to
3018 an @code{int *} on machines where integers can only be accessed at
3019 two- or four-byte boundaries.
3020
3021 @item -Wwrite-strings
3022 @opindex Wwrite-strings
3023 When compiling C, give string constants the type @code{const
3024 char[@var{length}]} so that
3025 copying the address of one into a non-@code{const} @code{char *}
3026 pointer will get a warning; when compiling C++, warn about the
3027 deprecated conversion from string constants to @code{char *}.
3028 These warnings will help you find at
3029 compile time code that can try to write into a string constant, but
3030 only if you have been very careful about using @code{const} in
3031 declarations and prototypes.  Otherwise, it will just be a nuisance;
3032 this is why we did not make @option{-Wall} request these warnings.
3033
3034 @item -Wconversion
3035 @opindex Wconversion
3036 Warn if a prototype causes a type conversion that is different from what
3037 would happen to the same argument in the absence of a prototype.  This
3038 includes conversions of fixed point to floating and vice versa, and
3039 conversions changing the width or signedness of a fixed point argument
3040 except when the same as the default promotion.
3041
3042 Also, warn if a negative integer constant expression is implicitly
3043 converted to an unsigned type.  For example, warn about the assignment
3044 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3045 casts like @code{(unsigned) -1}.
3046
3047 @item -Wsign-compare
3048 @opindex Wsign-compare
3049 @cindex warning for comparison of signed and unsigned values
3050 @cindex comparison of signed and unsigned values, warning
3051 @cindex signed and unsigned values, comparison warning
3052 Warn when a comparison between signed and unsigned values could produce
3053 an incorrect result when the signed value is converted to unsigned.
3054 This warning is also enabled by @option{-Wextra}; to get the other warnings
3055 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3056
3057 @item -Waggregate-return
3058 @opindex Waggregate-return
3059 Warn if any functions that return structures or unions are defined or
3060 called.  (In languages where you can return an array, this also elicits
3061 a warning.)
3062
3063 @item -Wno-attributes
3064 @opindex Wno-attributes
3065 @opindex Wattributes
3066 Do not warn if an unexpected @code{__attribute__} is used, such as
3067 unrecognized attributes, function attributes applied to variables,
3068 etc.  This will not stop errors for incorrect use of supported
3069 attributes.
3070
3071 @item -Wstrict-prototypes @r{(C only)}
3072 @opindex Wstrict-prototypes
3073 Warn if a function is declared or defined without specifying the
3074 argument types.  (An old-style function definition is permitted without
3075 a warning if preceded by a declaration which specifies the argument
3076 types.)
3077
3078 @item -Wold-style-definition @r{(C only)}
3079 @opindex Wold-style-definition
3080 Warn if an old-style function definition is used.  A warning is given
3081 even if there is a previous prototype.
3082
3083 @item -Wmissing-prototypes @r{(C only)}
3084 @opindex Wmissing-prototypes
3085 Warn if a global function is defined without a previous prototype
3086 declaration.  This warning is issued even if the definition itself
3087 provides a prototype.  The aim is to detect global functions that fail
3088 to be declared in header files.
3089
3090 @item -Wmissing-declarations @r{(C only)}
3091 @opindex Wmissing-declarations
3092 Warn if a global function is defined without a previous declaration.
3093 Do so even if the definition itself provides a prototype.
3094 Use this option to detect global functions that are not declared in
3095 header files.
3096
3097 @item -Wmissing-field-initializers
3098 @opindex Wmissing-field-initializers
3099 @opindex W
3100 @opindex Wextra
3101 Warn if a structure's initializer has some fields missing.  For
3102 example, the following code would cause such a warning, because
3103 @code{x.h} is implicitly zero:
3104
3105 @smallexample
3106 struct s @{ int f, g, h; @};
3107 struct s x = @{ 3, 4 @};
3108 @end smallexample
3109
3110 This option does not warn about designated initializers, so the following
3111 modification would not trigger a warning:
3112
3113 @smallexample
3114 struct s @{ int f, g, h; @};
3115 struct s x = @{ .f = 3, .g = 4 @};
3116 @end smallexample
3117
3118 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3119 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3120
3121 @item -Wmissing-noreturn
3122 @opindex Wmissing-noreturn
3123 Warn about functions which might be candidates for attribute @code{noreturn}.
3124 Note these are only possible candidates, not absolute ones.  Care should
3125 be taken to manually verify functions actually do not ever return before
3126 adding the @code{noreturn} attribute, otherwise subtle code generation
3127 bugs could be introduced.  You will not get a warning for @code{main} in
3128 hosted C environments.
3129
3130 @item -Wmissing-format-attribute
3131 @opindex Wmissing-format-attribute
3132 @opindex Wformat
3133 Warn about function pointers which might be candidates for @code{format}
3134 attributes.  Note these are only possible candidates, not absolute ones.
3135 GCC will guess that function pointers with @code{format} attributes that
3136 are used in assignment, initialization, parameter passing or return
3137 statements should have a corresponding @code{format} attribute in the
3138 resulting type.  I.e.@: the left-hand side of the assignment or
3139 initialization, the type of the parameter variable, or the return type
3140 of the containing function respectively should also have a @code{format}
3141 attribute to avoid the warning.
3142
3143 GCC will also warn about function definitions which might be
3144 candidates for @code{format} attributes.  Again, these are only
3145 possible candidates.  GCC will guess that @code{format} attributes
3146 might be appropriate for any function that calls a function like
3147 @code{vprintf} or @code{vscanf}, but this might not always be the
3148 case, and some functions for which @code{format} attributes are
3149 appropriate may not be detected.
3150
3151 @item -Wno-multichar
3152 @opindex Wno-multichar
3153 @opindex Wmultichar
3154 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3155 Usually they indicate a typo in the user's code, as they have
3156 implementation-defined values, and should not be used in portable code.
3157
3158 @item -Wnormalized=<none|id|nfc|nfkc>
3159 @opindex Wnormalized
3160 @cindex NFC
3161 @cindex NFKC
3162 @cindex character set, input normalization
3163 In ISO C and ISO C++, two identifiers are different if they are
3164 different sequences of characters.  However, sometimes when characters
3165 outside the basic ASCII character set are used, you can have two
3166 different character sequences that look the same.  To avoid confusion,
3167 the ISO 10646 standard sets out some @dfn{normalization rules} which
3168 when applied ensure that two sequences that look the same are turned into
3169 the same sequence.  GCC can warn you if you are using identifiers which
3170 have not been normalized; this option controls that warning.
3171
3172 There are four levels of warning that GCC supports.  The default is
3173 @option{-Wnormalized=nfc}, which warns about any identifier which is
3174 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3175 recommended form for most uses.
3176
3177 Unfortunately, there are some characters which ISO C and ISO C++ allow
3178 in identifiers that when turned into NFC aren't allowable as
3179 identifiers.  That is, there's no way to use these symbols in portable
3180 ISO C or C++ and have all your identifiers in NFC.
3181 @option{-Wnormalized=id} suppresses the warning for these characters.
3182 It is hoped that future versions of the standards involved will correct
3183 this, which is why this option is not the default.
3184
3185 You can switch the warning off for all characters by writing
3186 @option{-Wnormalized=none}.  You would only want to do this if you
3187 were using some other normalization scheme (like ``D''), because
3188 otherwise you can easily create bugs that are literally impossible to see.
3189
3190 Some characters in ISO 10646 have distinct meanings but look identical
3191 in some fonts or display methodologies, especially once formatting has
3192 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3193 LETTER N'', will display just like a regular @code{n} which has been
3194 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3195 normalisation scheme to convert all these into a standard form as
3196 well, and GCC will warn if your code is not in NFKC if you use
3197 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3198 about every identifier that contains the letter O because it might be
3199 confused with the digit 0, and so is not the default, but may be
3200 useful as a local coding convention if the programming environment is
3201 unable to be fixed to display these characters distinctly.
3202
3203 @item -Wno-deprecated-declarations
3204 @opindex Wno-deprecated-declarations
3205 Do not warn about uses of functions, variables, and types marked as
3206 deprecated by using the @code{deprecated} attribute.
3207 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3208 @pxref{Type Attributes}.)
3209
3210 @item -Wpacked
3211 @opindex Wpacked
3212 Warn if a structure is given the packed attribute, but the packed
3213 attribute has no effect on the layout or size of the structure.
3214 Such structures may be mis-aligned for little benefit.  For
3215 instance, in this code, the variable @code{f.x} in @code{struct bar}
3216 will be misaligned even though @code{struct bar} does not itself
3217 have the packed attribute:
3218
3219 @smallexample
3220 @group
3221 struct foo @{
3222   int x;
3223   char a, b, c, d;
3224 @} __attribute__((packed));
3225 struct bar @{
3226   char z;
3227   struct foo f;
3228 @};
3229 @end group
3230 @end smallexample
3231
3232 @item -Wpadded
3233 @opindex Wpadded
3234 Warn if padding is included in a structure, either to align an element
3235 of the structure or to align the whole structure.  Sometimes when this
3236 happens it is possible to rearrange the fields of the structure to
3237 reduce the padding and so make the structure smaller.
3238
3239 @item -Wredundant-decls
3240 @opindex Wredundant-decls
3241 Warn if anything is declared more than once in the same scope, even in
3242 cases where multiple declaration is valid and changes nothing.
3243
3244 @item -Wnested-externs @r{(C only)}
3245 @opindex Wnested-externs
3246 Warn if an @code{extern} declaration is encountered within a function.
3247
3248 @item -Wunreachable-code
3249 @opindex Wunreachable-code
3250 Warn if the compiler detects that code will never be executed.
3251
3252 This option is intended to warn when the compiler detects that at
3253 least a whole line of source code will never be executed, because
3254 some condition is never satisfied or because it is after a
3255 procedure that never returns.
3256
3257 It is possible for this option to produce a warning even though there
3258 are circumstances under which part of the affected line can be executed,
3259 so care should be taken when removing apparently-unreachable code.
3260
3261 For instance, when a function is inlined, a warning may mean that the
3262 line is unreachable in only one inlined copy of the function.
3263
3264 This option is not made part of @option{-Wall} because in a debugging
3265 version of a program there is often substantial code which checks
3266 correct functioning of the program and is, hopefully, unreachable
3267 because the program does work.  Another common use of unreachable
3268 code is to provide behavior which is selectable at compile-time.
3269
3270 @item -Winline
3271 @opindex Winline
3272 Warn if a function can not be inlined and it was declared as inline.
3273 Even with this option, the compiler will not warn about failures to
3274 inline functions declared in system headers.
3275
3276 The compiler uses a variety of heuristics to determine whether or not
3277 to inline a function.  For example, the compiler takes into account
3278 the size of the function being inlined and the amount of inlining
3279 that has already been done in the current function.  Therefore,
3280 seemingly insignificant changes in the source program can cause the
3281 warnings produced by @option{-Winline} to appear or disappear.
3282
3283 @item -Wno-invalid-offsetof @r{(C++ only)}
3284 @opindex Wno-invalid-offsetof
3285 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3286 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3287 to a non-POD type is undefined.  In existing C++ implementations,
3288 however, @samp{offsetof} typically gives meaningful results even when
3289 applied to certain kinds of non-POD types. (Such as a simple
3290 @samp{struct} that fails to be a POD type only by virtue of having a
3291 constructor.)  This flag is for users who are aware that they are
3292 writing nonportable code and who have deliberately chosen to ignore the
3293 warning about it.
3294
3295 The restrictions on @samp{offsetof} may be relaxed in a future version
3296 of the C++ standard.
3297
3298 @item -Wno-int-to-pointer-cast @r{(C only)}
3299 @opindex Wno-int-to-pointer-cast
3300 Suppress warnings from casts to pointer type of an integer of a
3301 different size.
3302
3303 @item -Wno-pointer-to-int-cast @r{(C only)}
3304 @opindex Wno-pointer-to-int-cast
3305 Suppress warnings from casts from a pointer to an integer type of a
3306 different size.
3307
3308 @item -Winvalid-pch
3309 @opindex Winvalid-pch
3310 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3311 the search path but can't be used.
3312
3313 @item -Wlong-long
3314 @opindex Wlong-long
3315 @opindex Wno-long-long
3316 Warn if @samp{long long} type is used.  This is default.  To inhibit
3317 the warning messages, use @option{-Wno-long-long}.  Flags
3318 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3319 only when @option{-pedantic} flag is used.
3320
3321 @item -Wvariadic-macros
3322 @opindex Wvariadic-macros
3323 @opindex Wno-variadic-macros
3324 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3325 alternate syntax when in pedantic ISO C99 mode.  This is default.
3326 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3327
3328 @item -Wdisabled-optimization
3329 @opindex Wdisabled-optimization
3330 Warn if a requested optimization pass is disabled.  This warning does
3331 not generally indicate that there is anything wrong with your code; it
3332 merely indicates that GCC's optimizers were unable to handle the code
3333 effectively.  Often, the problem is that your code is too big or too
3334 complex; GCC will refuse to optimize programs when the optimization
3335 itself is likely to take inordinate amounts of time.
3336
3337 @item -Wno-pointer-sign
3338 @opindex Wno-pointer-sign
3339 Don't warn for pointer argument passing or assignment with different signedness.
3340 Only useful in the negative form since this warning is enabled by default.
3341 This option is only supported for C and Objective-C@.
3342
3343 @item -Werror
3344 @opindex Werror
3345 Make all warnings into errors.
3346 @end table
3347
3348 @node Debugging Options
3349 @section Options for Debugging Your Program or GCC
3350 @cindex options, debugging
3351 @cindex debugging information options
3352
3353 GCC has various special options that are used for debugging
3354 either your program or GCC:
3355
3356 @table @gcctabopt
3357 @item -g
3358 @opindex g
3359 Produce debugging information in the operating system's native format
3360 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3361 information.
3362
3363 On most systems that use stabs format, @option{-g} enables use of extra
3364 debugging information that only GDB can use; this extra information
3365 makes debugging work better in GDB but will probably make other debuggers
3366 crash or
3367 refuse to read the program.  If you want to control for certain whether
3368 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3369 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3370
3371 GCC allows you to use @option{-g} with
3372 @option{-O}.  The shortcuts taken by optimized code may occasionally
3373 produce surprising results: some variables you declared may not exist
3374 at all; flow of control may briefly move where you did not expect it;
3375 some statements may not be executed because they compute constant
3376 results or their values were already at hand; some statements may
3377 execute in different places because they were moved out of loops.
3378
3379 Nevertheless it proves possible to debug optimized output.  This makes
3380 it reasonable to use the optimizer for programs that might have bugs.
3381
3382 The following options are useful when GCC is generated with the
3383 capability for more than one debugging format.
3384
3385 @item -ggdb
3386 @opindex ggdb
3387 Produce debugging information for use by GDB@.  This means to use the
3388 most expressive format available (DWARF 2, stabs, or the native format
3389 if neither of those are supported), including GDB extensions if at all
3390 possible.
3391
3392 @item -gstabs
3393 @opindex gstabs
3394 Produce debugging information in stabs format (if that is supported),
3395 without GDB extensions.  This is the format used by DBX on most BSD
3396 systems.  On MIPS, Alpha and System V Release 4 systems this option
3397 produces stabs debugging output which is not understood by DBX or SDB@.
3398 On System V Release 4 systems this option requires the GNU assembler.
3399
3400 @item -feliminate-unused-debug-symbols
3401 @opindex feliminate-unused-debug-symbols
3402 Produce debugging information in stabs format (if that is supported),
3403 for only symbols that are actually used.
3404
3405 @item -gstabs+
3406 @opindex gstabs+
3407 Produce debugging information in stabs format (if that is supported),
3408 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3409 use of these extensions is likely to make other debuggers crash or
3410 refuse to read the program.
3411
3412 @item -gcoff
3413 @opindex gcoff
3414 Produce debugging information in COFF format (if that is supported).
3415 This is the format used by SDB on most System V systems prior to
3416 System V Release 4.
3417
3418 @item -gxcoff
3419 @opindex gxcoff
3420 Produce debugging information in XCOFF format (if that is supported).
3421 This is the format used by the DBX debugger on IBM RS/6000 systems.
3422
3423 @item -gxcoff+
3424 @opindex gxcoff+
3425 Produce debugging information in XCOFF format (if that is supported),
3426 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3427 use of these extensions is likely to make other debuggers crash or
3428 refuse to read the program, and may cause assemblers other than the GNU
3429 assembler (GAS) to fail with an error.
3430
3431 @item -gdwarf-2
3432 @opindex gdwarf-2
3433 Produce debugging information in DWARF version 2 format (if that is
3434 supported).  This is the format used by DBX on IRIX 6.  With this
3435 option, GCC uses features of DWARF version 3 when they are useful;
3436 version 3 is upward compatible with version 2, but may still cause
3437 problems for older debuggers.
3438
3439 @item -gvms
3440 @opindex gvms
3441 Produce debugging information in VMS debug format (if that is
3442 supported).  This is the format used by DEBUG on VMS systems.
3443
3444 @item -g@var{level}
3445 @itemx -ggdb@var{level}
3446 @itemx -gstabs@var{level}
3447 @itemx -gcoff@var{level}
3448 @itemx -gxcoff@var{level}
3449 @itemx -gvms@var{level}
3450 Request debugging information and also use @var{level} to specify how
3451 much information.  The default level is 2.
3452
3453 Level 1 produces minimal information, enough for making backtraces in
3454 parts of the program that you don't plan to debug.  This includes
3455 descriptions of functions and external variables, but no information
3456 about local variables and no line numbers.
3457
3458 Level 3 includes extra information, such as all the macro definitions
3459 present in the program.  Some debuggers support macro expansion when
3460 you use @option{-g3}.
3461
3462 @option{-gdwarf-2} does not accept a concatenated debug level, because
3463 GCC used to support an option @option{-gdwarf} that meant to generate
3464 debug information in version 1 of the DWARF format (which is very
3465 different from version 2), and it would have been too confusing.  That
3466 debug format is long obsolete, but the option cannot be changed now.
3467 Instead use an additional @option{-g@var{level}} option to change the
3468 debug level for DWARF2.
3469
3470 @item -feliminate-dwarf2-dups
3471 @opindex feliminate-dwarf2-dups
3472 Compress DWARF2 debugging information by eliminating duplicated
3473 information about each symbol.  This option only makes sense when
3474 generating DWARF2 debugging information with @option{-gdwarf-2}.
3475
3476 @cindex @command{prof}
3477 @item -p
3478 @opindex p
3479 Generate extra code to write profile information suitable for the
3480 analysis program @command{prof}.  You must use this option when compiling
3481 the source files you want data about, and you must also use it when
3482 linking.
3483
3484 @cindex @command{gprof}
3485 @item -pg
3486 @opindex pg
3487 Generate extra code to write profile information suitable for the
3488 analysis program @command{gprof}.  You must use this option when compiling
3489 the source files you want data about, and you must also use it when
3490 linking.
3491
3492 @item -Q
3493 @opindex Q
3494 Makes the compiler print out each function name as it is compiled, and
3495 print some statistics about each pass when it finishes.
3496
3497 @item -ftime-report
3498 @opindex ftime-report
3499 Makes the compiler print some statistics about the time consumed by each
3500 pass when it finishes.
3501
3502 @item -fmem-report
3503 @opindex fmem-report
3504 Makes the compiler print some statistics about permanent memory
3505 allocation when it finishes.
3506
3507 @item -fprofile-arcs
3508 @opindex fprofile-arcs
3509 Add code so that program flow @dfn{arcs} are instrumented.  During
3510 execution the program records how many times each branch and call is
3511 executed and how many times it is taken or returns.  When the compiled
3512 program exits it saves this data to a file called
3513 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3514 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3515 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3516 @var{auxname} is generated from the name of the output file, if
3517 explicitly specified and it is not the final executable, otherwise it is
3518 the basename of the source file.  In both cases any suffix is removed
3519 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3520 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3521 @xref{Cross-profiling}.
3522
3523 @cindex @command{gcov}
3524 @item --coverage
3525 @opindex coverage
3526
3527 This option is used to compile and link code instrumented for coverage
3528 analysis.  The option is a synonym for @option{-fprofile-arcs}
3529 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3530 linking).  See the documentation for those options for more details.
3531
3532 @itemize
3533
3534 @item
3535 Compile the source files with @option{-fprofile-arcs} plus optimization
3536 and code generation options.  For test coverage analysis, use the
3537 additional @option{-ftest-coverage} option.  You do not need to profile
3538 every source file in a program.
3539
3540 @item
3541 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3542 (the latter implies the former).
3543
3544 @item
3545 Run the program on a representative workload to generate the arc profile
3546 information.  This may be repeated any number of times.  You can run
3547 concurrent instances of your program, and provided that the file system
3548 supports locking, the data files will be correctly updated.  Also
3549 @code{fork} calls are detected and correctly handled (double counting
3550 will not happen).
3551
3552 @item
3553 For profile-directed optimizations, compile the source files again with
3554 the same optimization and code generation options plus
3555 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3556 Control Optimization}).
3557
3558 @item
3559 For test coverage analysis, use @command{gcov} to produce human readable
3560 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3561 @command{gcov} documentation for further information.
3562
3563 @end itemize
3564
3565 With @option{-fprofile-arcs}, for each function of your program GCC
3566 creates a program flow graph, then finds a spanning tree for the graph.
3567 Only arcs that are not on the spanning tree have to be instrumented: the
3568 compiler adds code to count the number of times that these arcs are
3569 executed.  When an arc is the only exit or only entrance to a block, the
3570 instrumentation code can be added to the block; otherwise, a new basic
3571 block must be created to hold the instrumentation code.
3572
3573 @item -ftree-based-profiling
3574 @opindex ftree-based-profiling
3575 This option is used in addition to @option{-fprofile-arcs} or
3576 @option{-fbranch-probabilities} to control whether those optimizations
3577 are performed on a tree-based or rtl-based internal representation.
3578 If you use this option when compiling with @option{-fprofile-arcs},
3579 you must also use it when compiling later with @option{-fbranch-probabilities}.
3580 Currently the tree-based optimization is in an early stage of
3581 development, and this option is recommended only for those people
3582 working on improving it.
3583
3584 @need 2000
3585 @item -ftest-coverage
3586 @opindex ftest-coverage
3587 Produce a notes file that the @command{gcov} code-coverage utility
3588 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3589 show program coverage.  Each source file's note file is called
3590 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3591 above for a description of @var{auxname} and instructions on how to
3592 generate test coverage data.  Coverage data will match the source files
3593 more closely, if you do not optimize.
3594
3595 @item -d@var{letters}
3596 @item -fdump-rtl-@var{pass}
3597 @opindex d
3598 Says to make debugging dumps during compilation at times specified by
3599 @var{letters}.    This is used for debugging the RTL-based passes of the
3600 compiler.  The file names for most of the dumps are made by appending a
3601 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3602 from the name of the output file, if explicitly specified and it is not
3603 an executable, otherwise it is the basename of the source file.
3604
3605 Most debug dumps can be enabled either passing a letter to the @option{-d}
3606 option, or with a long @option{-fdump-rtl} switch; here are the possible
3607 letters for use in @var{letters} and @var{pass}, and their meanings:
3608
3609 @table @gcctabopt
3610 @item -dA
3611 @opindex dA
3612 Annotate the assembler output with miscellaneous debugging information.
3613
3614 @item -db
3615 @itemx -fdump-rtl-bp
3616 @opindex db
3617 @opindex fdump-rtl-bp
3618 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3619
3620 @item -dB
3621 @itemx -fdump-rtl-bbro
3622 @opindex dB
3623 @opindex fdump-rtl-bbro
3624 Dump after block reordering, to @file{@var{file}.30.bbro}.
3625
3626 @item -dc
3627 @itemx -fdump-rtl-combine
3628 @opindex dc
3629 @opindex fdump-rtl-combine
3630 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3631
3632 @item -dC
3633 @itemx -fdump-rtl-ce1
3634 @itemx -fdump-rtl-ce2
3635 @opindex dC
3636 @opindex fdump-rtl-ce1
3637 @opindex fdump-rtl-ce2
3638 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3639 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3640 and @option{-fdump-rtl-ce2} enable dumping after the second if
3641 conversion, to the file @file{@var{file}.18.ce2}.
3642
3643 @item -dd
3644 @itemx -fdump-rtl-btl
3645 @itemx -fdump-rtl-dbr
3646 @opindex dd
3647 @opindex fdump-rtl-btl
3648 @opindex fdump-rtl-dbr
3649 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3650 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3651 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3652 scheduling, to @file{@var{file}.36.dbr}.
3653
3654 @item -dD
3655 @opindex dD
3656 Dump all macro definitions, at the end of preprocessing, in addition to
3657 normal output.
3658
3659 @item -dE
3660 @itemx -fdump-rtl-ce3
3661 @opindex dE
3662 @opindex fdump-rtl-ce3
3663 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3664
3665 @item -df
3666 @itemx -fdump-rtl-cfg
3667 @itemx -fdump-rtl-life
3668 @opindex df
3669 @opindex fdump-rtl-cfg
3670 @opindex fdump-rtl-life
3671 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3672 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3673 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3674 to @file{@var{file}.16.life}.
3675
3676 @item -dg
3677 @itemx -fdump-rtl-greg
3678 @opindex dg
3679 @opindex fdump-rtl-greg
3680 Dump after global register allocation, to @file{@var{file}.23.greg}.
3681
3682 @item -dG
3683 @itemx -fdump-rtl-gcse
3684 @itemx -fdump-rtl-bypass
3685 @opindex dG
3686 @opindex fdump-rtl-gcse
3687 @opindex fdump-rtl-bypass
3688 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3689 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3690 enable dumping after jump bypassing and control flow optimizations, to
3691 @file{@var{file}.07.bypass}.
3692
3693 @item -dh
3694 @itemx -fdump-rtl-eh
3695 @opindex dh
3696 @opindex fdump-rtl-eh
3697 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3698
3699 @item -di
3700 @itemx -fdump-rtl-sibling
3701 @opindex di
3702 @opindex fdump-rtl-sibling
3703 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3704
3705 @item -dj
3706 @itemx -fdump-rtl-jump
3707 @opindex dj
3708 @opindex fdump-rtl-jump
3709 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3710
3711 @item -dk
3712 @itemx -fdump-rtl-stack
3713 @opindex dk
3714 @opindex fdump-rtl-stack
3715 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3716
3717 @item -dl
3718 @itemx -fdump-rtl-lreg
3719 @opindex dl
3720 @opindex fdump-rtl-lreg
3721 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3722
3723 @item -dL
3724 @itemx -fdump-rtl-loop
3725 @itemx -fdump-rtl-loop2
3726 @opindex dL
3727 @opindex fdump-rtl-loop
3728 @opindex fdump-rtl-loop2
3729 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3730 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3731 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3732 @file{@var{file}.13.loop2}.
3733
3734 @item -dm
3735 @itemx -fdump-rtl-sms
3736 @opindex dm
3737 @opindex fdump-rtl-sms
3738 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3739
3740 @item -dM
3741 @itemx -fdump-rtl-mach
3742 @opindex dM
3743 @opindex fdump-rtl-mach
3744 Dump after performing the machine dependent reorganization pass, to
3745 @file{@var{file}.35.mach}.
3746
3747 @item -dn
3748 @itemx -fdump-rtl-rnreg
3749 @opindex dn
3750 @opindex fdump-rtl-rnreg
3751 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3752
3753 @item -dN
3754 @itemx -fdump-rtl-regmove
3755 @opindex dN
3756 @opindex fdump-rtl-regmove
3757 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3758
3759 @item -do
3760 @itemx -fdump-rtl-postreload
3761 @opindex do
3762 @opindex fdump-rtl-postreload
3763 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3764
3765 @item -dr
3766 @itemx -fdump-rtl-expand
3767 @opindex dr
3768 @opindex fdump-rtl-expand
3769 Dump after RTL generation, to @file{@var{file}.00.expand}.
3770
3771 @item -dR
3772 @itemx -fdump-rtl-sched2
3773 @opindex dR
3774 @opindex fdump-rtl-sched2
3775 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3776
3777 @item -ds
3778 @itemx -fdump-rtl-cse
3779 @opindex ds
3780 @opindex fdump-rtl-cse
3781 Dump after CSE (including the jump optimization that sometimes follows
3782 CSE), to @file{@var{file}.04.cse}.
3783
3784 @item -dS
3785 @itemx -fdump-rtl-sched
3786 @opindex dS
3787 @opindex fdump-rtl-sched
3788 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3789
3790 @item -dt
3791 @itemx -fdump-rtl-cse2
3792 @opindex dt
3793 @opindex fdump-rtl-cse2
3794 Dump after the second CSE pass (including the jump optimization that
3795 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3796
3797 @item -dT
3798 @itemx -fdump-rtl-tracer
3799 @opindex dT
3800 @opindex fdump-rtl-tracer
3801 Dump after running tracer, to @file{@var{file}.12.tracer}.
3802
3803 @item -dV
3804 @itemx -fdump-rtl-vpt
3805 @itemx -fdump-rtl-vartrack
3806 @opindex dV
3807 @opindex fdump-rtl-vpt
3808 @opindex fdump-rtl-vartrack
3809 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3810 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3811 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3812 to @file{@var{file}.34.vartrack}.
3813
3814 @item -dw
3815 @itemx -fdump-rtl-flow2
3816 @opindex dw
3817 @opindex fdump-rtl-flow2
3818 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3819
3820 @item -dz
3821 @itemx -fdump-rtl-peephole2
3822 @opindex dz
3823 @opindex fdump-rtl-peephole2
3824 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3825
3826 @item -dZ
3827 @itemx -fdump-rtl-web
3828 @opindex dZ
3829 @opindex fdump-rtl-web
3830 Dump after live range splitting, to @file{@var{file}.14.web}.
3831
3832 @item -da
3833 @itemx -fdump-rtl-all
3834 @opindex da
3835 @opindex fdump-rtl-all
3836 Produce all the dumps listed above.
3837
3838 @item -dH
3839 @opindex dH
3840 Produce a core dump whenever an error occurs.
3841
3842 @item -dm
3843 @opindex dm
3844 Print statistics on memory usage, at the end of the run, to
3845 standard error.
3846
3847 @item -dp
3848 @opindex dp
3849 Annotate the assembler output with a comment indicating which
3850 pattern and alternative was used.  The length of each instruction is
3851 also printed.
3852
3853 @item -dP
3854 @opindex dP
3855 Dump the RTL in the assembler output as a comment before each instruction.
3856 Also turns on @option{-dp} annotation.
3857
3858 @item -dv
3859 @opindex dv
3860 For each of the other indicated dump files (either with @option{-d} or
3861 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3862 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3863
3864 @item -dx
3865 @opindex dx
3866 Just generate RTL for a function instead of compiling it.  Usually used
3867 with @samp{r} (@option{-fdump-rtl-expand}).
3868
3869 @item -dy
3870 @opindex dy
3871 Dump debugging information during parsing, to standard error.
3872 @end table
3873
3874 @item -fdump-unnumbered
3875 @opindex fdump-unnumbered
3876 When doing debugging dumps (see @option{-d} option above), suppress instruction
3877 numbers and line number note output.  This makes it more feasible to
3878 use diff on debugging dumps for compiler invocations with different
3879 options, in particular with and without @option{-g}.
3880
3881 @item -fdump-translation-unit @r{(C++ only)}
3882 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3883 @opindex fdump-translation-unit
3884 Dump a representation of the tree structure for the entire translation
3885 unit to a file.  The file name is made by appending @file{.tu} to the
3886 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3887 controls the details of the dump as described for the
3888 @option{-fdump-tree} options.
3889
3890 @item -fdump-class-hierarchy @r{(C++ only)}
3891 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3892 @opindex fdump-class-hierarchy
3893 Dump a representation of each class's hierarchy and virtual function
3894 table layout to a file.  The file name is made by appending @file{.class}
3895 to the source file name.  If the @samp{-@var{options}} form is used,
3896 @var{options} controls the details of the dump as described for the
3897 @option{-fdump-tree} options.
3898
3899 @item -fdump-ipa-@var{switch}
3900 @opindex fdump-ipa
3901 Control the dumping at various stages of inter-procedural analysis
3902 language tree to a file.  The file name is generated by appending a switch
3903 specific suffix to the source file name.  The following dumps are possible:
3904
3905 @table @samp
3906 @item all
3907 Enables all inter-procedural analysis dumps; currently the only produced
3908 dump is the @samp{cgraph} dump.
3909
3910 @item cgraph
3911 Dumps information about call-graph optimization, unused function removal,
3912 and inlining decisions.
3913 @end table
3914
3915 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3916 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3917 @opindex fdump-tree
3918 Control the dumping at various stages of processing the intermediate
3919 language tree to a file.  The file name is generated by appending a switch
3920 specific suffix to the source file name.  If the @samp{-@var{options}}
3921 form is used, @var{options} is a list of @samp{-} separated options that
3922 control the details of the dump.  Not all options are applicable to all
3923 dumps, those which are not meaningful will be ignored.  The following
3924 options are available
3925
3926 @table @samp
3927 @item address
3928 Print the address of each node.  Usually this is not meaningful as it
3929 changes according to the environment and source file.  Its primary use
3930 is for tying up a dump file with a debug environment.
3931 @item slim
3932 Inhibit dumping of members of a scope or body of a function merely
3933 because that scope has been reached.  Only dump such items when they
3934 are directly reachable by some other path.  When dumping pretty-printed
3935 trees, this option inhibits dumping the bodies of control structures.
3936 @item raw
3937 Print a raw representation of the tree.  By default, trees are
3938 pretty-printed into a C-like representation.
3939 @item details
3940 Enable more detailed dumps (not honored by every dump option).
3941 @item stats
3942 Enable dumping various statistics about the pass (not honored by every dump
3943 option).
3944 @item blocks
3945 Enable showing basic block boundaries (disabled in raw dumps).
3946 @item vops
3947 Enable showing virtual operands for every statement.
3948 @item lineno
3949 Enable showing line numbers for statements.
3950 @item uid
3951 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3952 @item all
3953 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3954 @end table
3955
3956 The following tree dumps are possible:
3957 @table @samp
3958
3959 @item original
3960 Dump before any tree based optimization, to @file{@var{file}.original}.
3961
3962 @item optimized
3963 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3964
3965 @item inlined
3966 Dump after function inlining, to @file{@var{file}.inlined}.
3967
3968 @item gimple
3969 @opindex fdump-tree-gimple
3970 Dump each function before and after the gimplification pass to a file.  The
3971 file name is made by appending @file{.gimple} to the source file name.
3972
3973 @item cfg
3974 @opindex fdump-tree-cfg
3975 Dump the control flow graph of each function to a file.  The file name is
3976 made by appending @file{.cfg} to the source file name.
3977
3978 @item vcg
3979 @opindex fdump-tree-vcg
3980 Dump the control flow graph of each function to a file in VCG format.  The
3981 file name is made by appending @file{.vcg} to the source file name.  Note
3982 that if the file contains more than one function, the generated file cannot
3983 be used directly by VCG@.  You will need to cut and paste each function's
3984 graph into its own separate file first.
3985
3986 @item ch
3987 @opindex fdump-tree-ch
3988 Dump each function after copying loop headers.  The file name is made by
3989 appending @file{.ch} to the source file name.
3990
3991 @item ssa
3992 @opindex fdump-tree-ssa
3993 Dump SSA related information to a file.  The file name is made by appending
3994 @file{.ssa} to the source file name.
3995
3996 @item salias
3997 @opindex fdump-tree-salias
3998 Dump structure aliasing variable information to a file.  This file name
3999 is made by appending @file{.salias} to the source file name.
4000
4001 @item alias
4002 @opindex fdump-tree-alias
4003 Dump aliasing information for each function.  The file name is made by
4004 appending @file{.alias} to the source file name.
4005
4006 @item ccp
4007 @opindex fdump-tree-ccp
4008 Dump each function after CCP@.  The file name is made by appending
4009 @file{.ccp} to the source file name.
4010
4011 @item storeccp
4012 @opindex fdump-tree-storeccp
4013 Dump each function after STORE-CCP.  The file name is made by appending
4014 @file{.storeccp} to the source file name.
4015
4016 @item pre
4017 @opindex fdump-tree-pre
4018 Dump trees after partial redundancy elimination.  The file name is made
4019 by appending @file{.pre} to the source file name.
4020
4021 @item fre
4022 @opindex fdump-tree-fre
4023 Dump trees after full redundancy elimination.  The file name is made
4024 by appending @file{.fre} to the source file name.
4025
4026 @item copyprop
4027 @opindex fdump-tree-copyprop
4028 Dump trees after copy propagation.  The file name is made
4029 by appending @file{.copyprop} to the source file name.
4030
4031 @item store_copyprop
4032 @opindex fdump-tree-store_copyprop
4033 Dump trees after store copy-propagation.  The file name is made
4034 by appending @file{.store_copyprop} to the source file name.
4035
4036 @item dce
4037 @opindex fdump-tree-dce
4038 Dump each function after dead code elimination.  The file name is made by
4039 appending @file{.dce} to the source file name.
4040
4041 @item mudflap
4042 @opindex fdump-tree-mudflap
4043 Dump each function after adding mudflap instrumentation.  The file name is
4044 made by appending @file{.mudflap} to the source file name.
4045
4046 @item sra
4047 @opindex fdump-tree-sra
4048 Dump each function after performing scalar replacement of aggregates.  The
4049 file name is made by appending @file{.sra} to the source file name.
4050
4051 @item sink
4052 @opindex fdump-tree-sink
4053 Dump each function after performing code sinking.  The file name is made
4054 by appending @file{.sink} to the source file name. 
4055
4056 @item dom
4057 @opindex fdump-tree-dom
4058 Dump each function after applying dominator tree optimizations.  The file
4059 name is made by appending @file{.dom} to the source file name.
4060
4061 @item dse
4062 @opindex fdump-tree-dse
4063 Dump each function after applying dead store elimination.  The file
4064 name is made by appending @file{.dse} to the source file name.
4065
4066 @item phiopt
4067 @opindex fdump-tree-phiopt
4068 Dump each function after optimizing PHI nodes into straightline code.  The file
4069 name is made by appending @file{.phiopt} to the source file name.
4070
4071 @item forwprop
4072 @opindex fdump-tree-forwprop
4073 Dump each function after forward propagating single use variables.  The file
4074 name is made by appending @file{.forwprop} to the source file name.
4075
4076 @item copyrename
4077 @opindex fdump-tree-copyrename
4078 Dump each function after applying the copy rename optimization.  The file
4079 name is made by appending @file{.copyrename} to the source file name.
4080
4081 @item nrv
4082 @opindex fdump-tree-nrv
4083 Dump each function after applying the named return value optimization on
4084 generic trees.  The file name is made by appending @file{.nrv} to the source
4085 file name.
4086
4087 @item vect
4088 @opindex fdump-tree-vect
4089 Dump each function after applying vectorization of loops.  The file name is
4090 made by appending @file{.vect} to the source file name.
4091
4092 @item vrp
4093 @opindex fdump-tree-vrp
4094 Dump each function after Value Range Propagation (VRP).  The file name
4095 is made by appending @file{.vrp} to the source file name.
4096
4097 @item all
4098 @opindex fdump-tree-all
4099 Enable all the available tree dumps with the flags provided in this option.
4100 @end table
4101
4102 @item -ftree-vectorizer-verbose=@var{n}
4103 @opindex ftree-vectorizer-verbose
4104 This option controls the amount of debugging output the vectorizer prints.
4105 This information is written to standard error, unless @option{-fdump-tree-all}
4106 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4107 usual dump listing file, @file{.vect}.
4108
4109 @item -frandom-seed=@var{string}
4110 @opindex frandom-string
4111 This option provides a seed that GCC uses when it would otherwise use
4112 random numbers.  It is used to generate certain symbol names
4113 that have to be different in every compiled file.  It is also used to
4114 place unique stamps in coverage data files and the object files that
4115 produce them.  You can use the @option{-frandom-seed} option to produce
4116 reproducibly identical object files.
4117
4118 The @var{string} should be different for every file you compile.
4119
4120 @item -fsched-verbose=@var{n}
4121 @opindex fsched-verbose
4122 On targets that use instruction scheduling, this option controls the
4123 amount of debugging output the scheduler prints.  This information is
4124 written to standard error, unless @option{-dS} or @option{-dR} is
4125 specified, in which case it is output to the usual dump
4126 listing file, @file{.sched} or @file{.sched2} respectively.  However
4127 for @var{n} greater than nine, the output is always printed to standard
4128 error.
4129
4130 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4131 same information as @option{-dRS}.  For @var{n} greater than one, it
4132 also output basic block probabilities, detailed ready list information
4133 and unit/insn info.  For @var{n} greater than two, it includes RTL
4134 at abort point, control-flow and regions info.  And for @var{n} over
4135 four, @option{-fsched-verbose} also includes dependence info.
4136
4137 @item -save-temps
4138 @opindex save-temps
4139 Store the usual ``temporary'' intermediate files permanently; place them
4140 in the current directory and name them based on the source file.  Thus,
4141 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4142 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4143 preprocessed @file{foo.i} output file even though the compiler now
4144 normally uses an integrated preprocessor.
4145
4146 When used in combination with the @option{-x} command line option,
4147 @option{-save-temps} is sensible enough to avoid over writing an
4148 input source file with the same extension as an intermediate file.
4149 The corresponding intermediate file may be obtained by renaming the
4150 source file before using @option{-save-temps}.
4151
4152 @item -time
4153 @opindex time
4154 Report the CPU time taken by each subprocess in the compilation
4155 sequence.  For C source files, this is the compiler proper and assembler
4156 (plus the linker if linking is done).  The output looks like this:
4157
4158 @smallexample
4159 # cc1 0.12 0.01
4160 # as 0.00 0.01
4161 @end smallexample
4162
4163 The first number on each line is the ``user time'', that is time spent
4164 executing the program itself.  The second number is ``system time'',
4165 time spent executing operating system routines on behalf of the program.
4166 Both numbers are in seconds.
4167
4168 @item -fvar-tracking
4169 @opindex fvar-tracking
4170 Run variable tracking pass.  It computes where variables are stored at each
4171 position in code.  Better debugging information is then generated
4172 (if the debugging information format supports this information).
4173
4174 It is enabled by default when compiling with optimization (@option{-Os},
4175 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4176 the debug info format supports it.
4177
4178 @item -print-file-name=@var{library}
4179 @opindex print-file-name
4180 Print the full absolute name of the library file @var{library} that
4181 would be used when linking---and don't do anything else.  With this
4182 option, GCC does not compile or link anything; it just prints the
4183 file name.
4184
4185 @item -print-multi-directory
4186 @opindex print-multi-directory
4187 Print the directory name corresponding to the multilib selected by any
4188 other switches present in the command line.  This directory is supposed
4189 to exist in @env{GCC_EXEC_PREFIX}.
4190
4191 @item -print-multi-lib
4192 @opindex print-multi-lib
4193 Print the mapping from multilib directory names to compiler switches
4194 that enable them.  The directory name is separated from the switches by
4195 @samp{;}, and each switch starts with an @samp{@@} instead of the
4196 @samp{-}, without spaces between multiple switches.  This is supposed to
4197 ease shell-processing.
4198
4199 @item -print-prog-name=@var{program}
4200 @opindex print-prog-name
4201 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4202
4203 @item -print-libgcc-file-name
4204 @opindex print-libgcc-file-name
4205 Same as @option{-print-file-name=libgcc.a}.
4206
4207 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4208 but you do want to link with @file{libgcc.a}.  You can do
4209
4210 @smallexample
4211 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4212 @end smallexample
4213
4214 @item -print-search-dirs
4215 @opindex print-search-dirs
4216 Print the name of the configured installation directory and a list of
4217 program and library directories @command{gcc} will search---and don't do anything else.
4218
4219 This is useful when @command{gcc} prints the error message
4220 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4221 To resolve this you either need to put @file{cpp0} and the other compiler
4222 components where @command{gcc} expects to find them, or you can set the environment
4223 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4224 Don't forget the trailing @samp{/}.
4225 @xref{Environment Variables}.
4226
4227 @item -dumpmachine
4228 @opindex dumpmachine
4229 Print the compiler's target machine (for example,
4230 @samp{i686-pc-linux-gnu})---and don't do anything else.
4231
4232 @item -dumpversion
4233 @opindex dumpversion
4234 Print the compiler version (for example, @samp{3.0})---and don't do
4235 anything else.
4236
4237 @item -dumpspecs
4238 @opindex dumpspecs
4239 Print the compiler's built-in specs---and don't do anything else.  (This
4240 is used when GCC itself is being built.)  @xref{Spec Files}.
4241
4242 @item -feliminate-unused-debug-types
4243 @opindex feliminate-unused-debug-types
4244 Normally, when producing DWARF2 output, GCC will emit debugging
4245 information for all types declared in a compilation
4246 unit, regardless of whether or not they are actually used
4247 in that compilation unit.  Sometimes this is useful, such as
4248 if, in the debugger, you want to cast a value to a type that is
4249 not actually used in your program (but is declared).  More often,
4250 however, this results in a significant amount of wasted space.
4251 With this option, GCC will avoid producing debug symbol output
4252 for types that are nowhere used in the source file being compiled.
4253 @end table
4254
4255 @node Optimize Options
4256 @section Options That Control Optimization
4257 @cindex optimize options
4258 @cindex options, optimization
4259
4260 These options control various sorts of optimizations.
4261
4262 Without any optimization option, the compiler's goal is to reduce the
4263 cost of compilation and to make debugging produce the expected
4264 results.  Statements are independent: if you stop the program with a
4265 breakpoint between statements, you can then assign a new value to any
4266 variable or change the program counter to any other statement in the
4267 function and get exactly the results you would expect from the source
4268 code.
4269
4270 Turning on optimization flags makes the compiler attempt to improve
4271 the performance and/or code size at the expense of compilation time
4272 and possibly the ability to debug the program.
4273
4274 The compiler performs optimization based on the knowledge it has of
4275 the program.  Optimization levels @option{-O2} and above, in
4276 particular, enable @emph{unit-at-a-time} mode, which allows the
4277 compiler to consider information gained from later functions in
4278 the file when compiling a function.  Compiling multiple files at
4279 once to a single output file in @emph{unit-at-a-time} mode allows
4280 the compiler to use information gained from all of the files when
4281 compiling each of them.
4282
4283 Not all optimizations are controlled directly by a flag.  Only
4284 optimizations that have a flag are listed.
4285
4286 @table @gcctabopt
4287 @item -O
4288 @itemx -O1
4289 @opindex O
4290 @opindex O1
4291 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4292 more memory for a large function.
4293
4294 With @option{-O}, the compiler tries to reduce code size and execution
4295 time, without performing any optimizations that take a great deal of
4296 compilation time.
4297
4298 @option{-O} turns on the following optimization flags:
4299 @gccoptlist{-fdefer-pop @gol
4300 -fdelayed-branch @gol
4301 -fguess-branch-probability @gol
4302 -fcprop-registers @gol
4303 -floop-optimize @gol
4304 -fif-conversion @gol
4305 -fif-conversion2 @gol
4306 -ftree-ccp @gol
4307 -ftree-dce @gol
4308 -ftree-dominator-opts @gol
4309 -ftree-dse @gol
4310 -ftree-ter @gol
4311 -ftree-lrs @gol
4312 -ftree-sra @gol
4313 -ftree-copyrename @gol
4314 -ftree-fre @gol
4315 -ftree-ch @gol
4316 -fmerge-constants}
4317
4318 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4319 where doing so does not interfere with debugging.
4320
4321 @item -O2
4322 @opindex O2
4323 Optimize even more.  GCC performs nearly all supported optimizations
4324 that do not involve a space-speed tradeoff.  The compiler does not
4325 perform loop unrolling or function inlining when you specify @option{-O2}.
4326 As compared to @option{-O}, this option increases both compilation time
4327 and the performance of the generated code.
4328
4329 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4330 also turns on the following optimization flags:
4331 @gccoptlist{-fthread-jumps @gol
4332 -fcrossjumping @gol
4333 -foptimize-sibling-calls @gol
4334 -fcse-follow-jumps  -fcse-skip-blocks @gol
4335 -fgcse  -fgcse-lm  @gol
4336 -fexpensive-optimizations @gol
4337 -fstrength-reduce @gol
4338 -frerun-cse-after-loop  -frerun-loop-opt @gol
4339 -fcaller-saves @gol
4340 -fpeephole2 @gol
4341 -fschedule-insns  -fschedule-insns2 @gol
4342 -fsched-interblock  -fsched-spec @gol
4343 -fregmove @gol
4344 -fstrict-aliasing @gol
4345 -fdelete-null-pointer-checks @gol
4346 -freorder-blocks  -freorder-functions @gol
4347 -funit-at-a-time @gol
4348 -falign-functions  -falign-jumps @gol
4349 -falign-loops  -falign-labels @gol
4350 -ftree-vrp @gol
4351 -ftree-pre}
4352
4353 Please note the warning under @option{-fgcse} about
4354 invoking @option{-O2} on programs that use computed gotos.
4355
4356 @item -O3
4357 @opindex O3
4358 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4359 @option{-O2} and also turns on the @option{-finline-functions},
4360 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4361
4362 @item -O0
4363 @opindex O0
4364 Do not optimize.  This is the default.
4365
4366 @item -Os
4367 @opindex Os
4368 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4369 do not typically increase code size.  It also performs further
4370 optimizations designed to reduce code size.
4371
4372 @option{-Os} disables the following optimization flags:
4373 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4374 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4375
4376 If you use multiple @option{-O} options, with or without level numbers,
4377 the last such option is the one that is effective.
4378 @end table
4379
4380 Options of the form @option{-f@var{flag}} specify machine-independent
4381 flags.  Most flags have both positive and negative forms; the negative
4382 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4383 below, only one of the forms is listed---the one you typically will
4384 use.  You can figure out the other form by either removing @samp{no-}
4385 or adding it.
4386
4387 The following options control specific optimizations.  They are either
4388 activated by @option{-O} options or are related to ones that are.  You
4389 can use the following flags in the rare cases when ``fine-tuning'' of
4390 optimizations to be performed is desired.
4391
4392 @table @gcctabopt
4393 @item -fno-default-inline
4394 @opindex fno-default-inline
4395 Do not make member functions inline by default merely because they are
4396 defined inside the class scope (C++ only).  Otherwise, when you specify
4397 @w{@option{-O}}, member functions defined inside class scope are compiled
4398 inline by default; i.e., you don't need to add @samp{inline} in front of
4399 the member function name.
4400
4401 @item -fno-defer-pop
4402 @opindex fno-defer-pop
4403 Always pop the arguments to each function call as soon as that function
4404 returns.  For machines which must pop arguments after a function call,
4405 the compiler normally lets arguments accumulate on the stack for several
4406 function calls and pops them all at once.
4407
4408 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4409
4410 @item -fforce-mem
4411 @opindex fforce-mem
4412 Force memory operands to be copied into registers before doing
4413 arithmetic on them.  This produces better code by making all memory
4414 references potential common subexpressions.  When they are not common
4415 subexpressions, instruction combination should eliminate the separate
4416 register-load. This option is now a nop and will be removed in 4.2.
4417
4418 @item -fforce-addr
4419 @opindex fforce-addr
4420 Force memory address constants to be copied into registers before
4421 doing arithmetic on them.
4422
4423 @item -fomit-frame-pointer
4424 @opindex fomit-frame-pointer
4425 Don't keep the frame pointer in a register for functions that
4426 don't need one.  This avoids the instructions to save, set up and
4427 restore frame pointers; it also makes an extra register available
4428 in many functions.  @strong{It also makes debugging impossible on
4429 some machines.}
4430
4431 On some machines, such as the VAX, this flag has no effect, because
4432 the standard calling sequence automatically handles the frame pointer
4433 and nothing is saved by pretending it doesn't exist.  The
4434 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4435 whether a target machine supports this flag.  @xref{Registers,,Register
4436 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4437
4438 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4439
4440 @item -foptimize-sibling-calls
4441 @opindex foptimize-sibling-calls
4442 Optimize sibling and tail recursive calls.
4443
4444 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4445
4446 @item -fno-inline
4447 @opindex fno-inline
4448 Don't pay attention to the @code{inline} keyword.  Normally this option
4449 is used to keep the compiler from expanding any functions inline.
4450 Note that if you are not optimizing, no functions can be expanded inline.
4451
4452 @item -finline-functions
4453 @opindex finline-functions
4454 Integrate all simple functions into their callers.  The compiler
4455 heuristically decides which functions are simple enough to be worth
4456 integrating in this way.
4457
4458 If all calls to a given function are integrated, and the function is
4459 declared @code{static}, then the function is normally not output as
4460 assembler code in its own right.
4461
4462 Enabled at level @option{-O3}.
4463
4464 @item -fearly-inlining
4465 @opindex fearly-inlining
4466 Inline functions marked by @code{always_inline} and functions whose body seems
4467 smaller than the function call overhead early before doing
4468 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4469 makes profiling significantly cheaper and usually inlining faster on programs
4470 having large chains of nested wrapper functions.
4471
4472 Enabled by default.
4473
4474 @item -finline-limit=@var{n}
4475 @opindex finline-limit
4476 By default, GCC limits the size of functions that can be inlined.  This flag
4477 allows the control of this limit for functions that are explicitly marked as
4478 inline (i.e., marked with the inline keyword or defined within the class
4479 definition in c++).  @var{n} is the size of functions that can be inlined in
4480 number of pseudo instructions (not counting parameter handling).  The default
4481 value of @var{n} is 600.
4482 Increasing this value can result in more inlined code at
4483 the cost of compilation time and memory consumption.  Decreasing usually makes
4484 the compilation faster and less code will be inlined (which presumably
4485 means slower programs).  This option is particularly useful for programs that
4486 use inlining heavily such as those based on recursive templates with C++.
4487
4488 Inlining is actually controlled by a number of parameters, which may be
4489 specified individually by using @option{--param @var{name}=@var{value}}.
4490 The @option{-finline-limit=@var{n}} option sets some of these parameters
4491 as follows:
4492
4493 @table @gcctabopt
4494  @item max-inline-insns-single
4495   is set to @var{n}/2.
4496  @item max-inline-insns-auto
4497   is set to @var{n}/2.
4498  @item min-inline-insns
4499   is set to 130 or @var{n}/4, whichever is smaller.
4500  @item max-inline-insns-rtl
4501   is set to @var{n}.
4502 @end table
4503
4504 See below for a documentation of the individual
4505 parameters controlling inlining.
4506
4507 @emph{Note:} pseudo instruction represents, in this particular context, an
4508 abstract measurement of function's size.  In no way does it represent a count
4509 of assembly instructions and as such its exact meaning might change from one
4510 release to an another.
4511
4512 @item -fkeep-inline-functions
4513 @opindex fkeep-inline-functions
4514 In C, emit @code{static} functions that are declared @code{inline}
4515 into the object file, even if the function has been inlined into all
4516 of its callers.  This switch does not affect functions using the
4517 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4518 inline functions into the object file.
4519
4520 @item -fkeep-static-consts
4521 @opindex fkeep-static-consts
4522 Emit variables declared @code{static const} when optimization isn't turned
4523 on, even if the variables aren't referenced.
4524
4525 GCC enables this option by default.  If you want to force the compiler to
4526 check if the variable was referenced, regardless of whether or not
4527 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4528
4529 @item -fmerge-constants
4530 Attempt to merge identical constants (string constants and floating point
4531 constants) across compilation units.
4532
4533 This option is the default for optimized compilation if the assembler and
4534 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4535 behavior.
4536
4537 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4538
4539 @item -fmerge-all-constants
4540 Attempt to merge identical constants and identical variables.
4541
4542 This option implies @option{-fmerge-constants}.  In addition to
4543 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4544 arrays or initialized constant variables with integral or floating point
4545 types.  Languages like C or C++ require each non-automatic variable to
4546 have distinct location, so using this option will result in non-conforming
4547 behavior.
4548
4549 @item -fmodulo-sched
4550 @opindex fmodulo-sched
4551 Perform swing modulo scheduling immediately before the first scheduling
4552 pass.  This pass looks at innermost loops and reorders their
4553 instructions by overlapping different iterations.
4554
4555 @item -fno-branch-count-reg
4556 @opindex fno-branch-count-reg
4557 Do not use ``decrement and branch'' instructions on a count register,
4558 but instead generate a sequence of instructions that decrement a
4559 register, compare it against zero, then branch based upon the result.
4560 This option is only meaningful on architectures that support such
4561 instructions, which include x86, PowerPC, IA-64 and S/390.
4562
4563 The default is @option{-fbranch-count-reg}, enabled when
4564 @option{-fstrength-reduce} is enabled.
4565
4566 @item -fno-function-cse
4567 @opindex fno-function-cse
4568 Do not put function addresses in registers; make each instruction that
4569 calls a constant function contain the function's address explicitly.
4570
4571 This option results in less efficient code, but some strange hacks
4572 that alter the assembler output may be confused by the optimizations
4573 performed when this option is not used.
4574
4575 The default is @option{-ffunction-cse}
4576
4577 @item -fno-zero-initialized-in-bss
4578 @opindex fno-zero-initialized-in-bss
4579 If the target supports a BSS section, GCC by default puts variables that
4580 are initialized to zero into BSS@.  This can save space in the resulting
4581 code.
4582
4583 This option turns off this behavior because some programs explicitly
4584 rely on variables going to the data section.  E.g., so that the
4585 resulting executable can find the beginning of that section and/or make
4586 assumptions based on that.
4587
4588 The default is @option{-fzero-initialized-in-bss}.
4589
4590 @item -fbounds-check
4591 @opindex fbounds-check
4592 For front-ends that support it, generate additional code to check that
4593 indices used to access arrays are within the declared range.  This is
4594 currently only supported by the Java and Fortran front-ends, where
4595 this option defaults to true and false respectively.
4596
4597 @item -fmudflap -fmudflapth -fmudflapir
4598 @opindex fmudflap
4599 @opindex fmudflapth
4600 @opindex fmudflapir
4601 @cindex bounds checking
4602 @cindex mudflap
4603 For front-ends that support it (C and C++), instrument all risky
4604 pointer/array dereferencing operations, some standard library
4605 string/heap functions, and some other associated constructs with
4606 range/validity tests.  Modules so instrumented should be immune to
4607 buffer overflows, invalid heap use, and some other classes of C/C++
4608 programming errors.  The instrumentation relies on a separate runtime
4609 library (@file{libmudflap}), which will be linked into a program if
4610 @option{-fmudflap} is given at link time.  Run-time behavior of the
4611 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4612 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4613 for its options.
4614
4615 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4616 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4617 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4618 instrumentation should ignore pointer reads.  This produces less
4619 instrumentation (and therefore faster execution) and still provides
4620 some protection against outright memory corrupting writes, but allows
4621 erroneously read data to propagate within a program.
4622
4623 @item -fstrength-reduce
4624 @opindex fstrength-reduce
4625 Perform the optimizations of loop strength reduction and
4626 elimination of iteration variables.
4627
4628 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4629
4630 @item -fthread-jumps
4631 @opindex fthread-jumps
4632 Perform optimizations where we check to see if a jump branches to a
4633 location where another comparison subsumed by the first is found.  If
4634 so, the first branch is redirected to either the destination of the
4635 second branch or a point immediately following it, depending on whether
4636 the condition is known to be true or false.
4637
4638 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4639
4640 @item -fcse-follow-jumps
4641 @opindex fcse-follow-jumps
4642 In common subexpression elimination, scan through jump instructions
4643 when the target of the jump is not reached by any other path.  For
4644 example, when CSE encounters an @code{if} statement with an
4645 @code{else} clause, CSE will follow the jump when the condition
4646 tested is false.
4647
4648 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4649
4650 @item -fcse-skip-blocks
4651 @opindex fcse-skip-blocks
4652 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4653 follow jumps which conditionally skip over blocks.  When CSE
4654 encounters a simple @code{if} statement with no else clause,
4655 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4656 body of the @code{if}.
4657
4658 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4659
4660 @item -frerun-cse-after-loop
4661 @opindex frerun-cse-after-loop
4662 Re-run common subexpression elimination after loop optimizations has been
4663 performed.
4664
4665 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4666
4667 @item -frerun-loop-opt
4668 @opindex frerun-loop-opt
4669 Run the loop optimizer twice.
4670
4671 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4672
4673 @item -fgcse
4674 @opindex fgcse
4675 Perform a global common subexpression elimination pass.
4676 This pass also performs global constant and copy propagation.
4677
4678 @emph{Note:} When compiling a program using computed gotos, a GCC
4679 extension, you may get better runtime performance if you disable
4680 the global common subexpression elimination pass by adding
4681 @option{-fno-gcse} to the command line.
4682
4683 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4684
4685 @item -fgcse-lm
4686 @opindex fgcse-lm
4687 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4688 attempt to move loads which are only killed by stores into themselves.  This
4689 allows a loop containing a load/store sequence to be changed to a load outside
4690 the loop, and a copy/store within the loop.
4691
4692 Enabled by default when gcse is enabled.
4693
4694 @item -fgcse-sm
4695 @opindex fgcse-sm
4696 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4697 global common subexpression elimination.  This pass will attempt to move
4698 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4699 loops containing a load/store sequence can be changed to a load before
4700 the loop and a store after the loop.
4701
4702 Not enabled at any optimization level.
4703
4704 @item -fgcse-las
4705 @opindex fgcse-las
4706 When @option{-fgcse-las} is enabled, the global common subexpression
4707 elimination pass eliminates redundant loads that come after stores to the
4708 same memory location (both partial and full redundancies).
4709
4710 Not enabled at any optimization level.
4711
4712 @item -fgcse-after-reload
4713 @opindex fgcse-after-reload
4714 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4715 pass is performed after reload.  The purpose of this pass is to cleanup
4716 redundant spilling.
4717
4718 @item -floop-optimize
4719 @opindex floop-optimize
4720 Perform loop optimizations: move constant expressions out of loops, simplify
4721 exit test conditions and optionally do strength-reduction as well.
4722
4723 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4724
4725 @item -floop-optimize2
4726 @opindex floop-optimize2
4727 Perform loop optimizations using the new loop optimizer.  The optimizations
4728 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4729 by separate flags.
4730
4731 @item -fcrossjumping
4732 @opindex crossjumping
4733 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4734 resulting code may or may not perform better than without cross-jumping.
4735
4736 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4737
4738 @item -fif-conversion
4739 @opindex if-conversion
4740 Attempt to transform conditional jumps into branch-less equivalents.  This
4741 include use of conditional moves, min, max, set flags and abs instructions, and
4742 some tricks doable by standard arithmetics.  The use of conditional execution
4743 on chips where it is available is controlled by @code{if-conversion2}.
4744
4745 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4746
4747 @item -fif-conversion2
4748 @opindex if-conversion2
4749 Use conditional execution (where available) to transform conditional jumps into
4750 branch-less equivalents.
4751
4752 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4753
4754 @item -fdelete-null-pointer-checks
4755 @opindex fdelete-null-pointer-checks
4756 Use global dataflow analysis to identify and eliminate useless checks
4757 for null pointers.  The compiler assumes that dereferencing a null
4758 pointer would have halted the program.  If a pointer is checked after
4759 it has already been dereferenced, it cannot be null.
4760
4761 In some environments, this assumption is not true, and programs can
4762 safely dereference null pointers.  Use
4763 @option{-fno-delete-null-pointer-checks} to disable this optimization
4764 for programs which depend on that behavior.
4765
4766 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4767
4768 @item -fexpensive-optimizations
4769 @opindex fexpensive-optimizations
4770 Perform a number of minor optimizations that are relatively expensive.
4771
4772 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4773
4774 @item -foptimize-register-move
4775 @itemx -fregmove
4776 @opindex foptimize-register-move
4777 @opindex fregmove
4778 Attempt to reassign register numbers in move instructions and as
4779 operands of other simple instructions in order to maximize the amount of
4780 register tying.  This is especially helpful on machines with two-operand
4781 instructions.
4782
4783 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4784 optimization.
4785
4786 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4787
4788 @item -fdelayed-branch
4789 @opindex fdelayed-branch
4790 If supported for the target machine, attempt to reorder instructions
4791 to exploit instruction slots available after delayed branch
4792 instructions.
4793
4794 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4795
4796 @item -fschedule-insns
4797 @opindex fschedule-insns
4798 If supported for the target machine, attempt to reorder instructions to
4799 eliminate execution stalls due to required data being unavailable.  This
4800 helps machines that have slow floating point or memory load instructions
4801 by allowing other instructions to be issued until the result of the load
4802 or floating point instruction is required.
4803
4804 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4805
4806 @item -fschedule-insns2
4807 @opindex fschedule-insns2
4808 Similar to @option{-fschedule-insns}, but requests an additional pass of
4809 instruction scheduling after register allocation has been done.  This is
4810 especially useful on machines with a relatively small number of
4811 registers and where memory load instructions take more than one cycle.
4812
4813 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4814
4815 @item -fno-sched-interblock
4816 @opindex fno-sched-interblock
4817 Don't schedule instructions across basic blocks.  This is normally
4818 enabled by default when scheduling before register allocation, i.e.@:
4819 with @option{-fschedule-insns} or at @option{-O2} or higher.
4820
4821 @item -fno-sched-spec
4822 @opindex fno-sched-spec
4823 Don't allow speculative motion of non-load instructions.  This is normally
4824 enabled by default when scheduling before register allocation, i.e.@:
4825 with @option{-fschedule-insns} or at @option{-O2} or higher.
4826
4827 @item -fsched-spec-load
4828 @opindex fsched-spec-load
4829 Allow speculative motion of some load instructions.  This only makes
4830 sense when scheduling before register allocation, i.e.@: with
4831 @option{-fschedule-insns} or at @option{-O2} or higher.
4832
4833 @item -fsched-spec-load-dangerous
4834 @opindex fsched-spec-load-dangerous
4835 Allow speculative motion of more load instructions.  This only makes
4836 sense when scheduling before register allocation, i.e.@: with
4837 @option{-fschedule-insns} or at @option{-O2} or higher.
4838
4839 @item -fsched-stalled-insns=@var{n}
4840 @opindex fsched-stalled-insns
4841 Define how many insns (if any) can be moved prematurely from the queue
4842 of stalled insns into the ready list, during the second scheduling pass.
4843
4844 @item -fsched-stalled-insns-dep=@var{n}
4845 @opindex fsched-stalled-insns-dep
4846 Define how many insn groups (cycles) will be examined for a dependency
4847 on a stalled insn that is candidate for premature removal from the queue
4848 of stalled insns.  Has an effect only during the second scheduling pass,
4849 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4850
4851 @item -fsched2-use-superblocks
4852 @opindex fsched2-use-superblocks
4853 When scheduling after register allocation, do use superblock scheduling
4854 algorithm.  Superblock scheduling allows motion across basic block boundaries
4855 resulting on faster schedules.  This option is experimental, as not all machine
4856 descriptions used by GCC model the CPU closely enough to avoid unreliable
4857 results from the algorithm.
4858
4859 This only makes sense when scheduling after register allocation, i.e.@: with
4860 @option{-fschedule-insns2} or at @option{-O2} or higher.
4861
4862 @item -fsched2-use-traces
4863 @opindex fsched2-use-traces
4864 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4865 allocation and additionally perform code duplication in order to increase the
4866 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4867 trace formation.
4868
4869 This mode should produce faster but significantly longer programs.  Also
4870 without @option{-fbranch-probabilities} the traces constructed may not
4871 match the reality and hurt the performance.  This only makes
4872 sense when scheduling after register allocation, i.e.@: with
4873 @option{-fschedule-insns2} or at @option{-O2} or higher.
4874
4875 @item -freschedule-modulo-scheduled-loops
4876 @opindex fscheduling-in-modulo-scheduled-loops
4877 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4878 we may want to prevent the later scheduling passes from changing its schedule, we use this
4879 option to control that.
4880
4881 @item -fcaller-saves
4882 @opindex fcaller-saves
4883 Enable values to be allocated in registers that will be clobbered by
4884 function calls, by emitting extra instructions to save and restore the
4885 registers around such calls.  Such allocation is done only when it
4886 seems to result in better code than would otherwise be produced.
4887
4888 This option is always enabled by default on certain machines, usually
4889 those which have no call-preserved registers to use instead.
4890
4891 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4892
4893 @item -ftree-pre
4894 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4895 enabled by default at @option{-O2} and @option{-O3}.
4896
4897 @item -ftree-fre
4898 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4899 between FRE and PRE is that FRE only considers expressions
4900 that are computed on all paths leading to the redundant computation.
4901 This analysis faster than PRE, though it exposes fewer redundancies.
4902 This flag is enabled by default at @option{-O} and higher.
4903
4904 @item -ftree-copy-prop
4905 Perform copy propagation on trees.  This pass eliminates unnecessary
4906 copy operations.  This flag is enabled by default at @option{-O} and
4907 higher.
4908
4909 @item -ftree-store-copy-prop
4910 Perform copy propagation of memory loads and stores.  This pass
4911 eliminates unnecessary copy operations in memory references
4912 (structures, global variables, arrays, etc).  This flag is enabled by
4913 default at @option{-O2} and higher.
4914
4915 @item -ftree-salias
4916 Perform structural alias analysis on trees.  This flag
4917 is enabled by default at @option{-O} and higher.
4918
4919 @item -ftree-sink
4920 Perform forward store motion  on trees.  This flag is
4921 enabled by default at @option{-O} and higher.
4922
4923 @item -ftree-ccp
4924 Perform sparse conditional constant propagation (CCP) on trees.  This
4925 pass only operates on local scalar variables and is enabled by default
4926 at @option{-O} and higher.
4927
4928 @item -ftree-store-ccp
4929 Perform sparse conditional constant propagation (CCP) on trees.  This
4930 pass operates on both local scalar variables and memory stores and
4931 loads (global variables, structures, arrays, etc).  This flag is
4932 enabled by default at @option{-O2} and higher.
4933
4934 @item -ftree-dce
4935 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4936 default at @option{-O} and higher.
4937
4938 @item -ftree-dominator-opts
4939 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4940 default at @option{-O} and higher.
4941
4942 @item -ftree-ch
4943 Perform loop header copying on trees.  This is beneficial since it increases
4944 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4945 is enabled by default at @option{-O} and higher.  It is not enabled
4946 for @option{-Os}, since it usually increases code size.
4947
4948 @item -ftree-loop-optimize
4949 Perform loop optimizations on trees.  This flag is enabled by default
4950 at @option{-O} and higher.
4951
4952 @item -ftree-loop-linear
4953 Perform linear loop transformations on tree.  This flag can improve cache
4954 performance and allow further loop optimizations to take place.
4955
4956 @item -ftree-loop-im
4957 Perform loop invariant motion on trees.  This pass moves only invariants that
4958 would be hard to handle at RTL level (function calls, operations that expand to
4959 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4960 operands of conditions that are invariant out of the loop, so that we can use
4961 just trivial invariantness analysis in loop unswitching.  The pass also includes
4962 store motion.
4963
4964 @item -ftree-loop-ivcanon
4965 Create a canonical counter for number of iterations in the loop for that
4966 determining number of iterations requires complicated analysis.  Later
4967 optimizations then may determine the number easily.  Useful especially
4968 in connection with unrolling.
4969
4970 @item -fivopts
4971 Perform induction variable optimizations (strength reduction, induction
4972 variable merging and induction variable elimination) on trees.
4973
4974 @item -ftree-sra
4975 Perform scalar replacement of aggregates.  This pass replaces structure
4976 references with scalars to prevent committing structures to memory too
4977 early.  This flag is enabled by default at @option{-O} and higher.
4978
4979 @item -ftree-copyrename
4980 Perform copy renaming on trees.  This pass attempts to rename compiler
4981 temporaries to other variables at copy locations, usually resulting in
4982 variable names which more closely resemble the original variables.  This flag
4983 is enabled by default at @option{-O} and higher.
4984
4985 @item -ftree-ter
4986 Perform temporary expression replacement during the SSA->normal phase.  Single
4987 use/single def temporaries are replaced at their use location with their
4988 defining expression.  This results in non-GIMPLE code, but gives the expanders
4989 much more complex trees to work on resulting in better RTL generation.  This is
4990 enabled by default at @option{-O} and higher.
4991
4992 @item -ftree-lrs
4993 Perform live range splitting during the SSA->normal phase.  Distinct live
4994 ranges of a variable are split into unique variables, allowing for better
4995 optimization later.  This is enabled by default at @option{-O} and higher.
4996
4997 @item -ftree-vectorize
4998 Perform loop vectorization on trees.
4999
5000 @item -ftree-vrp
5001 Perform Value Range Propagation on trees.  This is similar to the
5002 constant propagation pass, but instead of values, ranges of values are
5003 propagated.  This allows the optimizers to remove unnecessary range
5004 checks like array bound checks and null pointer checks.  This is
5005 enabled by default at @option{-O2} and higher.  Null pointer check
5006 elimination is only done if @option{-fdelete-null-pointer-checks} is
5007 enabled.
5008
5009 @item -ftracer
5010 @opindex ftracer
5011 Perform tail duplication to enlarge superblock size.  This transformation
5012 simplifies the control flow of the function allowing other optimizations to do
5013 better job.
5014
5015 @item -funroll-loops
5016 @opindex funroll-loops
5017 Unroll loops whose number of iterations can be determined at compile
5018 time or upon entry to the loop.  @option{-funroll-loops} implies both
5019 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5020 option makes code larger, and may or may not make it run faster.
5021
5022 @item -funroll-all-loops
5023 @opindex funroll-all-loops
5024 Unroll all loops, even if their number of iterations is uncertain when
5025 the loop is entered.  This usually makes programs run more slowly.
5026 @option{-funroll-all-loops} implies the same options as
5027 @option{-funroll-loops},
5028
5029 @item -fsplit-ivs-in-unroller
5030 @opindex -fsplit-ivs-in-unroller
5031 Enables expressing of values of induction variables in later iterations
5032 of the unrolled loop using the value in the first iteration.  This breaks
5033 long dependency chains, thus improving efficiency of the scheduling passes.
5034
5035 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5036 same effect.  However in cases the loop body is more complicated than
5037 a single basic block, this is not reliable.  It also does not work at all
5038 on some of the architectures due to restrictions in the CSE pass.
5039
5040 This optimization is enabled by default.
5041
5042 @item -fvariable-expansion-in-unroller
5043 @opindex -fvariable-expansion-in-unroller
5044 With this option, the compiler will create multiple copies of some
5045 local variables when unrolling a loop which can result in superior code.
5046
5047 @item -fprefetch-loop-arrays
5048 @opindex fprefetch-loop-arrays
5049 If supported by the target machine, generate instructions to prefetch
5050 memory to improve the performance of loops that access large arrays.
5051
5052 These options may generate better or worse code; results are highly
5053 dependent on the structure of loops within the source code.
5054
5055 @item -fno-peephole
5056 @itemx -fno-peephole2
5057 @opindex fno-peephole
5058 @opindex fno-peephole2
5059 Disable any machine-specific peephole optimizations.  The difference
5060 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5061 are implemented in the compiler; some targets use one, some use the
5062 other, a few use both.
5063
5064 @option{-fpeephole} is enabled by default.
5065 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5066
5067 @item -fno-guess-branch-probability
5068 @opindex fno-guess-branch-probability
5069 Do not guess branch probabilities using heuristics.
5070
5071 GCC will use heuristics to guess branch probabilities if they are
5072 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5073 heuristics are based on the control flow graph.  If some branch probabilities
5074 are specified by @samp{__builtin_expect}, then the heuristics will be
5075 used to guess branch probabilities for the rest of the control flow graph,
5076 taking the @samp{__builtin_expect} info into account.  The interactions
5077 between the heuristics and @samp{__builtin_expect} can be complex, and in
5078 some cases, it may be useful to disable the heuristics so that the effects
5079 of @samp{__builtin_expect} are easier to understand.
5080
5081 The default is @option{-fguess-branch-probability} at levels
5082 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5083
5084 @item -freorder-blocks
5085 @opindex freorder-blocks
5086 Reorder basic blocks in the compiled function in order to reduce number of
5087 taken branches and improve code locality.
5088
5089 Enabled at levels @option{-O2}, @option{-O3}.
5090
5091 @item -freorder-blocks-and-partition
5092 @opindex freorder-blocks-and-partition
5093 In addition to reordering basic blocks in the compiled function, in order
5094 to reduce number of taken branches, partitions hot and cold basic blocks
5095 into separate sections of the assembly and .o files, to improve
5096 paging and cache locality performance.
5097
5098 This optimization is automatically turned off in the presence of
5099 exception handling, for linkonce sections, for functions with a user-defined
5100 section attribute and on any architecture that does not support named
5101 sections.
5102
5103 @item -freorder-functions
5104 @opindex freorder-functions
5105 Reorder functions in the object file in order to
5106 improve code locality.  This is implemented by using special
5107 subsections @code{.text.hot} for most frequently executed functions and
5108 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5109 the linker so object file format must support named sections and linker must
5110 place them in a reasonable way.
5111
5112 Also profile feedback must be available in to make this option effective.  See
5113 @option{-fprofile-arcs} for details.
5114
5115 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5116
5117 @item -fstrict-aliasing
5118 @opindex fstrict-aliasing
5119 Allows the compiler to assume the strictest aliasing rules applicable to
5120 the language being compiled.  For C (and C++), this activates
5121 optimizations based on the type of expressions.  In particular, an
5122 object of one type is assumed never to reside at the same address as an
5123 object of a different type, unless the types are almost the same.  For
5124 example, an @code{unsigned int} can alias an @code{int}, but not a
5125 @code{void*} or a @code{double}.  A character type may alias any other
5126 type.
5127
5128 Pay special attention to code like this:
5129 @smallexample
5130 union a_union @{
5131   int i;
5132   double d;
5133 @};
5134
5135 int f() @{
5136   a_union t;
5137   t.d = 3.0;
5138   return t.i;
5139 @}
5140 @end smallexample
5141 The practice of reading from a different union member than the one most
5142 recently written to (called ``type-punning'') is common.  Even with
5143 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5144 is accessed through the union type.  So, the code above will work as
5145 expected.  However, this code might not:
5146 @smallexample
5147 int f() @{
5148   a_union t;
5149   int* ip;
5150   t.d = 3.0;
5151   ip = &t.i;
5152   return *ip;
5153 @}
5154 @end smallexample
5155
5156 Every language that wishes to perform language-specific alias analysis
5157 should define a function that computes, given an @code{tree}
5158 node, an alias set for the node.  Nodes in different alias sets are not
5159 allowed to alias.  For an example, see the C front-end function
5160 @code{c_get_alias_set}.
5161
5162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5163
5164 @item -falign-functions
5165 @itemx -falign-functions=@var{n}
5166 @opindex falign-functions
5167 Align the start of functions to the next power-of-two greater than
5168 @var{n}, skipping up to @var{n} bytes.  For instance,
5169 @option{-falign-functions=32} aligns functions to the next 32-byte
5170 boundary, but @option{-falign-functions=24} would align to the next
5171 32-byte boundary only if this can be done by skipping 23 bytes or less.
5172
5173 @option{-fno-align-functions} and @option{-falign-functions=1} are
5174 equivalent and mean that functions will not be aligned.
5175
5176 Some assemblers only support this flag when @var{n} is a power of two;
5177 in that case, it is rounded up.
5178
5179 If @var{n} is not specified or is zero, use a machine-dependent default.
5180
5181 Enabled at levels @option{-O2}, @option{-O3}.
5182
5183 @item -falign-labels
5184 @itemx -falign-labels=@var{n}
5185 @opindex falign-labels
5186 Align all branch targets to a power-of-two boundary, skipping up to
5187 @var{n} bytes like @option{-falign-functions}.  This option can easily
5188 make code slower, because it must insert dummy operations for when the
5189 branch target is reached in the usual flow of the code.
5190
5191 @option{-fno-align-labels} and @option{-falign-labels=1} are
5192 equivalent and mean that labels will not be aligned.
5193
5194 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5195 are greater than this value, then their values are used instead.
5196
5197 If @var{n} is not specified or is zero, use a machine-dependent default
5198 which is very likely to be @samp{1}, meaning no alignment.
5199
5200 Enabled at levels @option{-O2}, @option{-O3}.
5201
5202 @item -falign-loops
5203 @itemx -falign-loops=@var{n}
5204 @opindex falign-loops
5205 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5206 like @option{-falign-functions}.  The hope is that the loop will be
5207 executed many times, which will make up for any execution of the dummy
5208 operations.
5209
5210 @option{-fno-align-loops} and @option{-falign-loops=1} are
5211 equivalent and mean that loops will not be aligned.
5212
5213 If @var{n} is not specified or is zero, use a machine-dependent default.
5214
5215 Enabled at levels @option{-O2}, @option{-O3}.
5216
5217 @item -falign-jumps
5218 @itemx -falign-jumps=@var{n}
5219 @opindex falign-jumps
5220 Align branch targets to a power-of-two boundary, for branch targets
5221 where the targets can only be reached by jumping, skipping up to @var{n}
5222 bytes like @option{-falign-functions}.  In this case, no dummy operations
5223 need be executed.
5224
5225 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5226 equivalent and mean that loops will not be aligned.
5227
5228 If @var{n} is not specified or is zero, use a machine-dependent default.
5229
5230 Enabled at levels @option{-O2}, @option{-O3}.
5231
5232 @item -funit-at-a-time
5233 @opindex funit-at-a-time
5234 Parse the whole compilation unit before starting to produce code.
5235 This allows some extra optimizations to take place but consumes
5236 more memory (in general).  There are some compatibility issues
5237 with @emph{unit-at-at-time} mode:
5238 @itemize @bullet
5239 @item
5240 enabling @emph{unit-at-a-time} mode may change the order
5241 in which functions, variables, and top-level @code{asm} statements
5242 are emitted, and will likely break code relying on some particular
5243 ordering.  The majority of such top-level @code{asm} statements,
5244 though, can be replaced by @code{section} attributes.
5245
5246 @item
5247 @emph{unit-at-a-time} mode removes unreferenced static variables
5248 and functions.  This may result in undefined references
5249 when an @code{asm} statement refers directly to variables or functions
5250 that are otherwise unused.  In that case either the variable/function
5251 shall be listed as an operand of the @code{asm} statement operand or,
5252 in the case of top-level @code{asm} statements the attribute @code{used}
5253 shall be used on the declaration.
5254
5255 @item
5256 Static functions now can use non-standard passing conventions that
5257 may break @code{asm} statements calling functions directly.  Again,
5258 attribute @code{used} will prevent this behavior.
5259 @end itemize
5260
5261 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5262 but this scheme may not be supported by future releases of GCC@.
5263
5264 Enabled at levels @option{-O2}, @option{-O3}.
5265
5266 @item -fweb
5267 @opindex fweb
5268 Constructs webs as commonly used for register allocation purposes and assign
5269 each web individual pseudo register.  This allows the register allocation pass
5270 to operate on pseudos directly, but also strengthens several other optimization
5271 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5272 however, make debugging impossible, since variables will no longer stay in a
5273 ``home register''.
5274
5275 Enabled by default with @option{-funroll-loops}.
5276
5277 @item -fwhole-program
5278 @opindex fwhole-program
5279 Assume that the current compilation unit represents whole program being
5280 compiled.  All public functions and variables with the exception of @code{main}
5281 and those merged by attribute @code{externally_visible} become static functions
5282 and in a affect gets more aggressively optimized by interprocedural optimizers.
5283 While this option is equivalent to proper use of @code{static} keyword for
5284 programs consisting of single file, in combination with option
5285 @option{--combine} this flag can be used to compile most of smaller scale C
5286 programs since the functions and variables become local for the whole combined
5287 compilation unit, not for the single source file itself.
5288
5289
5290 @item -fno-cprop-registers
5291 @opindex fno-cprop-registers
5292 After register allocation and post-register allocation instruction splitting,
5293 we perform a copy-propagation pass to try to reduce scheduling dependencies
5294 and occasionally eliminate the copy.
5295
5296 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5297
5298 @item -fprofile-generate
5299 @opindex fprofile-generate
5300
5301 Enable options usually used for instrumenting application to produce
5302 profile useful for later recompilation with profile feedback based
5303 optimization.  You must use @option{-fprofile-generate} both when
5304 compiling and when linking your program.
5305
5306 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5307
5308 @item -fprofile-use
5309 @opindex fprofile-use
5310 Enable profile feedback directed optimizations, and optimizations
5311 generally profitable only with profile feedback available.
5312
5313 The following options are enabled: @code{-fbranch-probabilities},
5314 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5315
5316 @end table
5317
5318 The following options control compiler behavior regarding floating
5319 point arithmetic.  These options trade off between speed and
5320 correctness.  All must be specifically enabled.
5321
5322 @table @gcctabopt
5323 @item -ffloat-store
5324 @opindex ffloat-store
5325 Do not store floating point variables in registers, and inhibit other
5326 options that might change whether a floating point value is taken from a
5327 register or memory.
5328
5329 @cindex floating point precision
5330 This option prevents undesirable excess precision on machines such as
5331 the 68000 where the floating registers (of the 68881) keep more
5332 precision than a @code{double} is supposed to have.  Similarly for the
5333 x86 architecture.  For most programs, the excess precision does only
5334 good, but a few programs rely on the precise definition of IEEE floating
5335 point.  Use @option{-ffloat-store} for such programs, after modifying
5336 them to store all pertinent intermediate computations into variables.
5337
5338 @item -ffast-math
5339 @opindex ffast-math
5340 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5341 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5342 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5343 and @option{fcx-limited-range}.
5344
5345 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5346
5347 This option should never be turned on by any @option{-O} option since
5348 it can result in incorrect output for programs which depend on
5349 an exact implementation of IEEE or ISO rules/specifications for
5350 math functions.
5351
5352 @item -fno-math-errno
5353 @opindex fno-math-errno
5354 Do not set ERRNO after calling math functions that are executed
5355 with a single instruction, e.g., sqrt.  A program that relies on
5356 IEEE exceptions for math error handling may want to use this flag
5357 for speed while maintaining IEEE arithmetic compatibility.
5358
5359 This option should never be turned on by any @option{-O} option since
5360 it can result in incorrect output for programs which depend on
5361 an exact implementation of IEEE or ISO rules/specifications for
5362 math functions.
5363
5364 The default is @option{-fmath-errno}.
5365
5366 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5367 no reason for the compiler to consider the possibility that it might,
5368 and @option{-fno-math-errno} is the default.
5369
5370 @item -funsafe-math-optimizations
5371 @opindex funsafe-math-optimizations
5372 Allow optimizations for floating-point arithmetic that (a) assume
5373 that arguments and results are valid and (b) may violate IEEE or
5374 ANSI standards.  When used at link-time, it may include libraries
5375 or startup files that change the default FPU control word or other
5376 similar optimizations.
5377
5378 This option should never be turned on by any @option{-O} option since
5379 it can result in incorrect output for programs which depend on
5380 an exact implementation of IEEE or ISO rules/specifications for
5381 math functions.
5382
5383 The default is @option{-fno-unsafe-math-optimizations}.
5384
5385 @item -ffinite-math-only
5386 @opindex ffinite-math-only
5387 Allow optimizations for floating-point arithmetic that assume
5388 that arguments and results are not NaNs or +-Infs.
5389
5390 This option should never be turned on by any @option{-O} option since
5391 it can result in incorrect output for programs which depend on
5392 an exact implementation of IEEE or ISO rules/specifications.
5393
5394 The default is @option{-fno-finite-math-only}.
5395
5396 @item -fno-trapping-math
5397 @opindex fno-trapping-math
5398 Compile code assuming that floating-point operations cannot generate
5399 user-visible traps.  These traps include division by zero, overflow,
5400 underflow, inexact result and invalid operation.  This option implies
5401 @option{-fno-signaling-nans}.  Setting this option may allow faster
5402 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5403
5404 This option should never be turned on by any @option{-O} option since
5405 it can result in incorrect output for programs which depend on
5406 an exact implementation of IEEE or ISO rules/specifications for
5407 math functions.
5408
5409 The default is @option{-ftrapping-math}.
5410
5411 @item -frounding-math
5412 @opindex frounding-math
5413 Disable transformations and optimizations that assume default floating
5414 point rounding behavior.  This is round-to-zero for all floating point
5415 to integer conversions, and round-to-nearest for all other arithmetic
5416 truncations.  This option should be specified for programs that change
5417 the FP rounding mode dynamically, or that may be executed with a
5418 non-default rounding mode.  This option disables constant folding of
5419 floating point expressions at compile-time (which may be affected by
5420 rounding mode) and arithmetic transformations that are unsafe in the
5421 presence of sign-dependent rounding modes.
5422
5423 The default is @option{-fno-rounding-math}.
5424
5425 This option is experimental and does not currently guarantee to
5426 disable all GCC optimizations that are affected by rounding mode.
5427 Future versions of GCC may provide finer control of this setting
5428 using C99's @code{FENV_ACCESS} pragma.  This command line option
5429 will be used to specify the default state for @code{FENV_ACCESS}.
5430
5431 @item -fsignaling-nans
5432 @opindex fsignaling-nans
5433 Compile code assuming that IEEE signaling NaNs may generate user-visible
5434 traps during floating-point operations.  Setting this option disables
5435 optimizations that may change the number of exceptions visible with
5436 signaling NaNs.  This option implies @option{-ftrapping-math}.
5437
5438 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5439 be defined.
5440
5441 The default is @option{-fno-signaling-nans}.
5442
5443 This option is experimental and does not currently guarantee to
5444 disable all GCC optimizations that affect signaling NaN behavior.
5445
5446 @item -fsingle-precision-constant
5447 @opindex fsingle-precision-constant
5448 Treat floating point constant as single precision constant instead of
5449 implicitly converting it to double precision constant.
5450
5451 @item -fcx-limited-range
5452 @itemx -fno-cx-limited-range
5453 @opindex fcx-limited-range
5454 @opindex fno-cx-limited-range
5455 When enabled, this option states that a range reduction step is not
5456 needed when performing complex division.  The default is
5457 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5458
5459 This option controls the default setting of the ISO C99 
5460 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5461 all languages.
5462
5463 @end table
5464
5465 The following options control optimizations that may improve
5466 performance, but are not enabled by any @option{-O} options.  This
5467 section includes experimental options that may produce broken code.
5468
5469 @table @gcctabopt
5470 @item -fbranch-probabilities
5471 @opindex fbranch-probabilities
5472 After running a program compiled with @option{-fprofile-arcs}
5473 (@pxref{Debugging Options,, Options for Debugging Your Program or
5474 @command{gcc}}), you can compile it a second time using
5475 @option{-fbranch-probabilities}, to improve optimizations based on
5476 the number of times each branch was taken.  When the program
5477 compiled with @option{-fprofile-arcs} exits it saves arc execution
5478 counts to a file called @file{@var{sourcename}.gcda} for each source
5479 file  The information in this data file is very dependent on the
5480 structure of the generated code, so you must use the same source code
5481 and the same optimization options for both compilations.
5482
5483 With @option{-fbranch-probabilities}, GCC puts a
5484 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5485 These can be used to improve optimization.  Currently, they are only
5486 used in one place: in @file{reorg.c}, instead of guessing which path a
5487 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5488 exactly determine which path is taken more often.
5489
5490 @item -fprofile-values
5491 @opindex fprofile-values
5492 If combined with @option{-fprofile-arcs}, it adds code so that some
5493 data about values of expressions in the program is gathered.
5494
5495 With @option{-fbranch-probabilities}, it reads back the data gathered
5496 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5497 notes to instructions for their later usage in optimizations.
5498
5499 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5500
5501 @item -fvpt
5502 @opindex fvpt
5503 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5504 a code to gather information about values of expressions.
5505
5506 With @option{-fbranch-probabilities}, it reads back the data gathered
5507 and actually performs the optimizations based on them.
5508 Currently the optimizations include specialization of division operation
5509 using the knowledge about the value of the denominator.
5510
5511 @item -fspeculative-prefetching
5512 @opindex fspeculative-prefetching
5513 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5514 a code to gather information about addresses of memory references in the
5515 program.
5516
5517 With @option{-fbranch-probabilities}, it reads back the data gathered
5518 and issues prefetch instructions according to them.  In addition to the opportunities
5519 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5520 memory access patterns---for example accesses to the data stored in linked
5521 list whose elements are usually allocated sequentially.
5522
5523 In order to prevent issuing double prefetches, usage of
5524 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5525
5526 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5527
5528 @item -frename-registers
5529 @opindex frename-registers
5530 Attempt to avoid false dependencies in scheduled code by making use
5531 of registers left over after register allocation.  This optimization
5532 will most benefit processors with lots of registers.  Depending on the
5533 debug information format adopted by the target, however, it can
5534 make debugging impossible, since variables will no longer stay in
5535 a ``home register''.
5536
5537 Enabled by default with @option{-funroll-loops}.
5538
5539 @item -ftracer
5540 @opindex ftracer
5541 Perform tail duplication to enlarge superblock size.  This transformation
5542 simplifies the control flow of the function allowing other optimizations to do
5543 better job.
5544
5545 Enabled with @option{-fprofile-use}.
5546
5547 @item -funroll-loops
5548 @opindex funroll-loops
5549 Unroll loops whose number of iterations can be determined at compile time or
5550 upon entry to the loop.  @option{-funroll-loops} implies
5551 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5552 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5553 small constant number of iterations).  This option makes code larger, and may
5554 or may not make it run faster.
5555
5556 Enabled with @option{-fprofile-use}.
5557
5558 @item -funroll-all-loops
5559 @opindex funroll-all-loops
5560 Unroll all loops, even if their number of iterations is uncertain when
5561 the loop is entered.  This usually makes programs run more slowly.
5562 @option{-funroll-all-loops} implies the same options as
5563 @option{-funroll-loops}.
5564
5565 @item -fpeel-loops
5566 @opindex fpeel-loops
5567 Peels the loops for that there is enough information that they do not
5568 roll much (from profile feedback).  It also turns on complete loop peeling
5569 (i.e.@: complete removal of loops with small constant number of iterations).
5570
5571 Enabled with @option{-fprofile-use}.
5572
5573 @item -fmove-loop-invariants
5574 @opindex fmove-loop-invariants
5575 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5576 at level @option{-O1}
5577
5578 @item -funswitch-loops
5579 @opindex funswitch-loops
5580 Move branches with loop invariant conditions out of the loop, with duplicates
5581 of the loop on both branches (modified according to result of the condition).
5582
5583 @item -fprefetch-loop-arrays
5584 @opindex fprefetch-loop-arrays
5585 If supported by the target machine, generate instructions to prefetch
5586 memory to improve the performance of loops that access large arrays.
5587
5588 Disabled at level @option{-Os}.
5589
5590 @item -ffunction-sections
5591 @itemx -fdata-sections
5592 @opindex ffunction-sections
5593 @opindex fdata-sections
5594 Place each function or data item into its own section in the output
5595 file if the target supports arbitrary sections.  The name of the
5596 function or the name of the data item determines the section's name
5597 in the output file.
5598
5599 Use these options on systems where the linker can perform optimizations
5600 to improve locality of reference in the instruction space.  Most systems
5601 using the ELF object format and SPARC processors running Solaris 2 have
5602 linkers with such optimizations.  AIX may have these optimizations in
5603 the future.
5604
5605 Only use these options when there are significant benefits from doing
5606 so.  When you specify these options, the assembler and linker will
5607 create larger object and executable files and will also be slower.
5608 You will not be able to use @code{gprof} on all systems if you
5609 specify this option and you may have problems with debugging if
5610 you specify both this option and @option{-g}.
5611
5612 @item -fbranch-target-load-optimize
5613 @opindex fbranch-target-load-optimize
5614 Perform branch target register load optimization before prologue / epilogue
5615 threading.
5616 The use of target registers can typically be exposed only during reload,
5617 thus hoisting loads out of loops and doing inter-block scheduling needs
5618 a separate optimization pass.
5619
5620 @item -fbranch-target-load-optimize2
5621 @opindex fbranch-target-load-optimize2
5622 Perform branch target register load optimization after prologue / epilogue
5623 threading.
5624
5625 @item -fbtr-bb-exclusive
5626 @opindex fbtr-bb-exclusive
5627 When performing branch target register load optimization, don't reuse
5628 branch target registers in within any basic block.
5629
5630 @item --param @var{name}=@var{value}
5631 @opindex param
5632 In some places, GCC uses various constants to control the amount of
5633 optimization that is done.  For example, GCC will not inline functions
5634 that contain more that a certain number of instructions.  You can
5635 control some of these constants on the command-line using the
5636 @option{--param} option.
5637
5638 The names of specific parameters, and the meaning of the values, are
5639 tied to the internals of the compiler, and are subject to change
5640 without notice in future releases.
5641
5642 In each case, the @var{value} is an integer.  The allowable choices for
5643 @var{name} are given in the following table:
5644
5645 @table @gcctabopt
5646 @item salias-max-implicit-fields
5647 The maximum number of fields in a variable without direct
5648 structure accesses for which structure aliasing will consider trying 
5649 to track each field.  The default is 5
5650
5651 @item sra-max-structure-size
5652 The maximum structure size, in bytes, at which the scalar replacement
5653 of aggregates (SRA) optimization will perform block copies.  The
5654 default value, 0, implies that GCC will select the most appropriate
5655 size itself.
5656
5657 @item sra-field-structure-ratio
5658 The threshold ratio (as a percentage) between instantiated fields and
5659 the complete structure size.  We say that if the ratio of the number
5660 of bytes in instantiated fields to the number of bytes in the complete
5661 structure exceeds this parameter, then block copies are not used.  The
5662 default is 75.
5663
5664 @item max-crossjump-edges
5665 The maximum number of incoming edges to consider for crossjumping.
5666 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5667 the number of edges incoming to each block.  Increasing values mean
5668 more aggressive optimization, making the compile time increase with
5669 probably small improvement in executable size.
5670
5671 @item min-crossjump-insns
5672 The minimum number of instructions which must be matched at the end
5673 of two blocks before crossjumping will be performed on them.  This
5674 value is ignored in the case where all instructions in the block being
5675 crossjumped from are matched.  The default value is 5.
5676
5677 @item max-goto-duplication-insns
5678 The maximum number of instructions to duplicate to a block that jumps
5679 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5680 passes, GCC factors computed gotos early in the compilation process,
5681 and unfactors them as late as possible.  Only computed jumps at the
5682 end of a basic blocks with no more than max-goto-duplication-insns are
5683 unfactored.  The default value is 8.
5684
5685 @item max-delay-slot-insn-search
5686 The maximum number of instructions to consider when looking for an
5687 instruction to fill a delay slot.  If more than this arbitrary number of
5688 instructions is searched, the time savings from filling the delay slot
5689 will be minimal so stop searching.  Increasing values mean more
5690 aggressive optimization, making the compile time increase with probably
5691 small improvement in executable run time.
5692
5693 @item max-delay-slot-live-search
5694 When trying to fill delay slots, the maximum number of instructions to
5695 consider when searching for a block with valid live register
5696 information.  Increasing this arbitrarily chosen value means more
5697 aggressive optimization, increasing the compile time.  This parameter
5698 should be removed when the delay slot code is rewritten to maintain the
5699 control-flow graph.
5700
5701 @item max-gcse-memory
5702 The approximate maximum amount of memory that will be allocated in
5703 order to perform the global common subexpression elimination
5704 optimization.  If more memory than specified is required, the
5705 optimization will not be done.
5706
5707 @item max-gcse-passes
5708 The maximum number of passes of GCSE to run.  The default is 1.
5709
5710 @item max-pending-list-length
5711 The maximum number of pending dependencies scheduling will allow
5712 before flushing the current state and starting over.  Large functions
5713 with few branches or calls can create excessively large lists which
5714 needlessly consume memory and resources.
5715
5716 @item max-inline-insns-single
5717 Several parameters control the tree inliner used in gcc.
5718 This number sets the maximum number of instructions (counted in GCC's
5719 internal representation) in a single function that the tree inliner
5720 will consider for inlining.  This only affects functions declared
5721 inline and methods implemented in a class declaration (C++).
5722 The default value is 450.
5723
5724 @item max-inline-insns-auto
5725 When you use @option{-finline-functions} (included in @option{-O3}),
5726 a lot of functions that would otherwise not be considered for inlining
5727 by the compiler will be investigated.  To those functions, a different
5728 (more restrictive) limit compared to functions declared inline can
5729 be applied.
5730 The default value is 90.
5731
5732 @item large-function-insns
5733 The limit specifying really large functions.  For functions larger than this
5734 limit after inlining inlining is constrained by
5735 @option{--param large-function-growth}.  This parameter is useful primarily
5736 to avoid extreme compilation time caused by non-linear algorithms used by the
5737 backend.
5738 This parameter is ignored when @option{-funit-at-a-time} is not used.
5739 The default value is 2700.
5740
5741 @item large-function-growth
5742 Specifies maximal growth of large function caused by inlining in percents.
5743 This parameter is ignored when @option{-funit-at-a-time} is not used.
5744 The default value is 100 which limits large function growth to 2.0 times
5745 the original size.
5746
5747 @item inline-unit-growth
5748 Specifies maximal overall growth of the compilation unit caused by inlining.
5749 This parameter is ignored when @option{-funit-at-a-time} is not used.
5750 The default value is 50 which limits unit growth to 1.5 times the original
5751 size.
5752
5753 @item max-inline-insns-recursive
5754 @itemx max-inline-insns-recursive-auto
5755 Specifies maximum number of instructions out-of-line copy of self recursive inline
5756 function can grow into by performing recursive inlining.
5757
5758 For functions declared inline @option{--param max-inline-insns-recursive} is
5759 taken into acount.  For function not declared inline, recursive inlining
5760 happens only when @option{-finline-functions} (included in @option{-O3}) is
5761 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5762 default value is 450.
5763
5764 @item max-inline-recursive-depth
5765 @itemx max-inline-recursive-depth-auto
5766 Specifies maximum recursion depth used by the recursive inlining.
5767
5768 For functions declared inline @option{--param max-inline-recursive-depth} is
5769 taken into acount.  For function not declared inline, recursive inlining
5770 happens only when @option{-finline-functions} (included in @option{-O3}) is
5771 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5772 default value is 450.
5773
5774 @item inline-call-cost
5775 Specify cost of call instruction relative to simple arithmetics operations
5776 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5777 functions and at the same time increases size of leaf function that is believed to
5778 reduce function size by being inlined.  In effect it increases amount of
5779 inlining for code having large abstraction penalty (many functions that just
5780 pass the arguments to other functions) and decrease inlining for code with low
5781 abstraction penalty.  The default value is 16.
5782
5783 @item max-unrolled-insns
5784 The maximum number of instructions that a loop should have if that loop
5785 is unrolled, and if the loop is unrolled, it determines how many times
5786 the loop code is unrolled.
5787
5788 @item max-average-unrolled-insns
5789 The maximum number of instructions biased by probabilities of their execution
5790 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5791 it determines how many times the loop code is unrolled.
5792
5793 @item max-unroll-times
5794 The maximum number of unrollings of a single loop.
5795
5796 @item max-peeled-insns
5797 The maximum number of instructions that a loop should have if that loop
5798 is peeled, and if the loop is peeled, it determines how many times
5799 the loop code is peeled.
5800
5801 @item max-peel-times
5802 The maximum number of peelings of a single loop.
5803
5804 @item max-completely-peeled-insns
5805 The maximum number of insns of a completely peeled loop.
5806
5807 @item max-completely-peel-times
5808 The maximum number of iterations of a loop to be suitable for complete peeling.
5809
5810 @item max-unswitch-insns
5811 The maximum number of insns of an unswitched loop.
5812
5813 @item max-unswitch-level
5814 The maximum number of branches unswitched in a single loop.
5815
5816 @item lim-expensive
5817 The minimum cost of an expensive expression in the loop invariant motion.
5818
5819 @item iv-consider-all-candidates-bound
5820 Bound on number of candidates for induction variables below that
5821 all candidates are considered for each use in induction variable
5822 optimizations.  Only the most relevant candidates are considered
5823 if there are more candidates, to avoid quadratic time complexity.
5824
5825 @item iv-max-considered-uses
5826 The induction variable optimizations give up on loops that contain more
5827 induction variable uses.
5828
5829 @item iv-always-prune-cand-set-bound
5830 If number of candidates in the set is smaller than this value,
5831 we always try to remove unnecessary ivs from the set during its
5832 optimization when a new iv is added to the set.
5833
5834 @item scev-max-expr-size
5835 Bound on size of expressions used in the scalar evolutions analyzer.
5836 Large expressions slow the analyzer.
5837
5838 @item max-iterations-to-track
5839
5840 The maximum number of iterations of a loop the brute force algorithm
5841 for analysis of # of iterations of the loop tries to evaluate.
5842
5843 @item hot-bb-count-fraction
5844 Select fraction of the maximal count of repetitions of basic block in program
5845 given basic block needs to have to be considered hot.
5846
5847 @item hot-bb-frequency-fraction
5848 Select fraction of the maximal frequency of executions of basic block in
5849 function given basic block needs to have to be considered hot
5850
5851 @item tracer-dynamic-coverage
5852 @itemx tracer-dynamic-coverage-feedback
5853
5854 This value is used to limit superblock formation once the given percentage of
5855 executed instructions is covered.  This limits unnecessary code size
5856 expansion.
5857
5858 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5859 feedback is available.  The real profiles (as opposed to statically estimated
5860 ones) are much less balanced allowing the threshold to be larger value.
5861
5862 @item tracer-max-code-growth
5863 Stop tail duplication once code growth has reached given percentage.  This is
5864 rather hokey argument, as most of the duplicates will be eliminated later in
5865 cross jumping, so it may be set to much higher values than is the desired code
5866 growth.
5867
5868 @item tracer-min-branch-ratio
5869
5870 Stop reverse growth when the reverse probability of best edge is less than this
5871 threshold (in percent).
5872
5873 @item tracer-min-branch-ratio
5874 @itemx tracer-min-branch-ratio-feedback
5875
5876 Stop forward growth if the best edge do have probability lower than this
5877 threshold.
5878
5879 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5880 compilation for profile feedback and one for compilation without.  The value
5881 for compilation with profile feedback needs to be more conservative (higher) in
5882 order to make tracer effective.
5883
5884 @item max-cse-path-length
5885
5886 Maximum number of basic blocks on path that cse considers.  The default is 10.
5887
5888 @item global-var-threshold
5889
5890 Counts the number of function calls (@var{n}) and the number of
5891 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5892 single artificial variable will be created to represent all the
5893 call-clobbered variables at function call sites.  This artificial
5894 variable will then be made to alias every call-clobbered variable.
5895 (done as @code{int * size_t} on the host machine; beware overflow).
5896
5897 @item max-aliased-vops
5898
5899 Maximum number of virtual operands allowed to represent aliases
5900 before triggering the alias grouping heuristic.  Alias grouping
5901 reduces compile times and memory consumption needed for aliasing at
5902 the expense of precision loss in alias information.
5903
5904 @item ggc-min-expand
5905
5906 GCC uses a garbage collector to manage its own memory allocation.  This
5907 parameter specifies the minimum percentage by which the garbage
5908 collector's heap should be allowed to expand between collections.
5909 Tuning this may improve compilation speed; it has no effect on code
5910 generation.
5911
5912 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5913 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5914 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5915 GCC is not able to calculate RAM on a particular platform, the lower
5916 bound of 30% is used.  Setting this parameter and
5917 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5918 every opportunity.  This is extremely slow, but can be useful for
5919 debugging.
5920
5921 @item ggc-min-heapsize
5922
5923 Minimum size of the garbage collector's heap before it begins bothering
5924 to collect garbage.  The first collection occurs after the heap expands
5925 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5926 tuning this may improve compilation speed, and has no effect on code
5927 generation.
5928
5929 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5930 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5931 with a lower bound of 4096 (four megabytes) and an upper bound of
5932 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5933 particular platform, the lower bound is used.  Setting this parameter
5934 very large effectively disables garbage collection.  Setting this
5935 parameter and @option{ggc-min-expand} to zero causes a full collection
5936 to occur at every opportunity.
5937
5938 @item max-reload-search-insns
5939 The maximum number of instruction reload should look backward for equivalent
5940 register.  Increasing values mean more aggressive optimization, making the
5941 compile time increase with probably slightly better performance.  The default
5942 value is 100.
5943
5944 @item max-cselib-memory-location
5945 The maximum number of memory locations cselib should take into acount.
5946 Increasing values mean more aggressive optimization, making the compile time
5947 increase with probably slightly better performance.  The default value is 500.
5948
5949 @item reorder-blocks-duplicate
5950 @itemx reorder-blocks-duplicate-feedback
5951
5952 Used by basic block reordering pass to decide whether to use unconditional
5953 branch or duplicate the code on its destination.  Code is duplicated when its
5954 estimated size is smaller than this value multiplied by the estimated size of
5955 unconditional jump in the hot spots of the program.
5956
5957 The @option{reorder-block-duplicate-feedback} is used only when profile
5958 feedback is available and may be set to higher values than
5959 @option{reorder-block-duplicate} since information about the hot spots is more
5960 accurate.
5961
5962 @item max-sched-region-blocks
5963 The maximum number of blocks in a region to be considered for
5964 interblock scheduling.  The default value is 10.
5965
5966 @item max-sched-region-insns
5967 The maximum number of insns in a region to be considered for
5968 interblock scheduling.  The default value is 100.
5969
5970 @item max-last-value-rtl
5971
5972 The maximum size measured as number of RTLs that can be recorded in an expression
5973 in combiner for a pseudo register as last known value of that register.  The default
5974 is 10000.
5975
5976 @item integer-share-limit
5977 Small integer constants can use a shared data structure, reducing the
5978 compiler's memory usage and increasing its speed.  This sets the maximum
5979 value of a shared integer constant's.  The default value is 256.
5980
5981 @item min-virtual-mappings
5982 Specifies the minimum number of virtual mappings in the incremental
5983 SSA updater that should be registered to trigger the virtual mappings
5984 heuristic defined by virtual-mappings-ratio.  The default value is
5985 100.
5986
5987 @item virtual-mappings-ratio
5988 If the number of virtual mappings is virtual-mappings-ratio bigger
5989 than the number of virtual symbols to be updated, then the incremental
5990 SSA updater switches to a full update for those symbols.  The default
5991 ratio is 3.
5992
5993 @end table
5994 @end table
5995
5996 @node Preprocessor Options
5997 @section Options Controlling the Preprocessor
5998 @cindex preprocessor options
5999 @cindex options, preprocessor
6000
6001 These options control the C preprocessor, which is run on each C source
6002 file before actual compilation.
6003
6004 If you use the @option{-E} option, nothing is done except preprocessing.
6005 Some of these options make sense only together with @option{-E} because
6006 they cause the preprocessor output to be unsuitable for actual
6007 compilation.
6008
6009 @table @gcctabopt
6010 @opindex Wp
6011 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6012 and pass @var{option} directly through to the preprocessor.  If
6013 @var{option} contains commas, it is split into multiple options at the
6014 commas.  However, many options are modified, translated or interpreted
6015 by the compiler driver before being passed to the preprocessor, and
6016 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6017 interface is undocumented and subject to change, so whenever possible
6018 you should avoid using @option{-Wp} and let the driver handle the
6019 options instead.
6020
6021 @item -Xpreprocessor @var{option}
6022 @opindex preprocessor
6023 Pass @var{option} as an option to the preprocessor.  You can use this to
6024 supply system-specific preprocessor options which GCC does not know how to
6025 recognize.
6026
6027 If you want to pass an option that takes an argument, you must use
6028 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6029 @end table
6030
6031 @include cppopts.texi
6032
6033 @node Assembler Options
6034 @section Passing Options to the Assembler
6035
6036 @c prevent bad page break with this line
6037 You can pass options to the assembler.
6038
6039 @table @gcctabopt
6040 @item -Wa,@var{option}
6041 @opindex Wa
6042 Pass @var{option} as an option to the assembler.  If @var{option}
6043 contains commas, it is split into multiple options at the commas.
6044
6045 @item -Xassembler @var{option}
6046 @opindex Xassembler
6047 Pass @var{option} as an option to the assembler.  You can use this to
6048 supply system-specific assembler options which GCC does not know how to
6049 recognize.
6050
6051 If you want to pass an option that takes an argument, you must use
6052 @option{-Xassembler} twice, once for the option and once for the argument.
6053
6054 @end table
6055
6056 @node Link Options
6057 @section Options for Linking
6058 @cindex link options
6059 @cindex options, linking
6060
6061 These options come into play when the compiler links object files into
6062 an executable output file.  They are meaningless if the compiler is
6063 not doing a link step.
6064
6065 @table @gcctabopt
6066 @cindex file names
6067 @item @var{object-file-name}
6068 A file name that does not end in a special recognized suffix is
6069 considered to name an object file or library.  (Object files are
6070 distinguished from libraries by the linker according to the file
6071 contents.)  If linking is done, these object files are used as input
6072 to the linker.
6073
6074 @item -c
6075 @itemx -S
6076 @itemx -E
6077 @opindex c
6078 @opindex S
6079 @opindex E
6080 If any of these options is used, then the linker is not run, and
6081 object file names should not be used as arguments.  @xref{Overall
6082 Options}.
6083
6084 @cindex Libraries
6085 @item -l@var{library}
6086 @itemx -l @var{library}
6087 @opindex l
6088 Search the library named @var{library} when linking.  (The second
6089 alternative with the library as a separate argument is only for
6090 POSIX compliance and is not recommended.)
6091
6092 It makes a difference where in the command you write this option; the
6093 linker searches and processes libraries and object files in the order they
6094 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6095 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6096 to functions in @samp{z}, those functions may not be loaded.
6097
6098 The linker searches a standard list of directories for the library,
6099 which is actually a file named @file{lib@var{library}.a}.  The linker
6100 then uses this file as if it had been specified precisely by name.
6101
6102 The directories searched include several standard system directories
6103 plus any that you specify with @option{-L}.
6104
6105 Normally the files found this way are library files---archive files
6106 whose members are object files.  The linker handles an archive file by
6107 scanning through it for members which define symbols that have so far
6108 been referenced but not defined.  But if the file that is found is an
6109 ordinary object file, it is linked in the usual fashion.  The only
6110 difference between using an @option{-l} option and specifying a file name
6111 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6112 and searches several directories.
6113
6114 @item -lobjc
6115 @opindex lobjc
6116 You need this special case of the @option{-l} option in order to
6117 link an Objective-C or Objective-C++ program.
6118
6119 @item -nostartfiles
6120 @opindex nostartfiles
6121 Do not use the standard system startup files when linking.
6122 The standard system libraries are used normally, unless @option{-nostdlib}
6123 or @option{-nodefaultlibs} is used.
6124
6125 @item -nodefaultlibs
6126 @opindex nodefaultlibs
6127 Do not use the standard system libraries when linking.
6128 Only the libraries you specify will be passed to the linker.
6129 The standard startup files are used normally, unless @option{-nostartfiles}
6130 is used.  The compiler may generate calls to @code{memcmp},
6131 @code{memset}, @code{memcpy} and @code{memmove}.
6132 These entries are usually resolved by entries in
6133 libc.  These entry points should be supplied through some other
6134 mechanism when this option is specified.
6135
6136 @item -nostdlib
6137 @opindex nostdlib
6138 Do not use the standard system startup files or libraries when linking.
6139 No startup files and only the libraries you specify will be passed to
6140 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6141 @code{memcpy} and @code{memmove}.
6142 These entries are usually resolved by entries in
6143 libc.  These entry points should be supplied through some other
6144 mechanism when this option is specified.
6145
6146 @cindex @option{-lgcc}, use with @option{-nostdlib}
6147 @cindex @option{-nostdlib} and unresolved references
6148 @cindex unresolved references and @option{-nostdlib}
6149 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6150 @cindex @option{-nodefaultlibs} and unresolved references
6151 @cindex unresolved references and @option{-nodefaultlibs}
6152 One of the standard libraries bypassed by @option{-nostdlib} and
6153 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6154 that GCC uses to overcome shortcomings of particular machines, or special
6155 needs for some languages.
6156 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6157 Collection (GCC) Internals},
6158 for more discussion of @file{libgcc.a}.)
6159 In most cases, you need @file{libgcc.a} even when you want to avoid
6160 other standard libraries.  In other words, when you specify @option{-nostdlib}
6161 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6162 This ensures that you have no unresolved references to internal GCC
6163 library subroutines.  (For example, @samp{__main}, used to ensure C++
6164 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6165 GNU Compiler Collection (GCC) Internals}.)
6166
6167 @item -pie
6168 @opindex pie
6169 Produce a position independent executable on targets which support it.
6170 For predictable results, you must also specify the same set of options
6171 that were used to generate code (@option{-fpie}, @option{-fPIE},
6172 or model suboptions) when you specify this option.
6173
6174 @item -s
6175 @opindex s
6176 Remove all symbol table and relocation information from the executable.
6177
6178 @item -static
6179 @opindex static
6180 On systems that support dynamic linking, this prevents linking with the shared
6181 libraries.  On other systems, this option has no effect.
6182
6183 @item -shared
6184 @opindex shared
6185 Produce a shared object which can then be linked with other objects to
6186 form an executable.  Not all systems support this option.  For predictable
6187 results, you must also specify the same set of options that were used to
6188 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6189 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6190 needs to build supplementary stub code for constructors to work.  On
6191 multi-libbed systems, @samp{gcc -shared} must select the correct support
6192 libraries to link against.  Failing to supply the correct flags may lead
6193 to subtle defects.  Supplying them in cases where they are not necessary
6194 is innocuous.}
6195
6196 @item -shared-libgcc
6197 @itemx -static-libgcc
6198 @opindex shared-libgcc
6199 @opindex static-libgcc
6200 On systems that provide @file{libgcc} as a shared library, these options
6201 force the use of either the shared or static version respectively.
6202 If no shared version of @file{libgcc} was built when the compiler was
6203 configured, these options have no effect.
6204
6205 There are several situations in which an application should use the
6206 shared @file{libgcc} instead of the static version.  The most common
6207 of these is when the application wishes to throw and catch exceptions
6208 across different shared libraries.  In that case, each of the libraries
6209 as well as the application itself should use the shared @file{libgcc}.
6210
6211 Therefore, the G++ and GCJ drivers automatically add
6212 @option{-shared-libgcc} whenever you build a shared library or a main
6213 executable, because C++ and Java programs typically use exceptions, so
6214 this is the right thing to do.
6215
6216 If, instead, you use the GCC driver to create shared libraries, you may
6217 find that they will not always be linked with the shared @file{libgcc}.
6218 If GCC finds, at its configuration time, that you have a non-GNU linker
6219 or a GNU linker that does not support option @option{--eh-frame-hdr},
6220 it will link the shared version of @file{libgcc} into shared libraries
6221 by default.  Otherwise, it will take advantage of the linker and optimize
6222 away the linking with the shared version of @file{libgcc}, linking with
6223 the static version of libgcc by default.  This allows exceptions to
6224 propagate through such shared libraries, without incurring relocation
6225 costs at library load time.
6226
6227 However, if a library or main executable is supposed to throw or catch
6228 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6229 for the languages used in the program, or using the option
6230 @option{-shared-libgcc}, such that it is linked with the shared
6231 @file{libgcc}.
6232
6233 @item -symbolic
6234 @opindex symbolic
6235 Bind references to global symbols when building a shared object.  Warn
6236 about any unresolved references (unless overridden by the link editor
6237 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6238 this option.
6239
6240 @item -Xlinker @var{option}
6241 @opindex Xlinker
6242 Pass @var{option} as an option to the linker.  You can use this to
6243 supply system-specific linker options which GCC does not know how to
6244 recognize.
6245
6246 If you want to pass an option that takes an argument, you must use
6247 @option{-Xlinker} twice, once for the option and once for the argument.
6248 For example, to pass @option{-assert definitions}, you must write
6249 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6250 @option{-Xlinker "-assert definitions"}, because this passes the entire
6251 string as a single argument, which is not what the linker expects.
6252
6253 @item -Wl,@var{option}
6254 @opindex Wl
6255 Pass @var{option} as an option to the linker.  If @var{option} contains
6256 commas, it is split into multiple options at the commas.
6257
6258 @item -u @var{symbol}
6259 @opindex u
6260 Pretend the symbol @var{symbol} is undefined, to force linking of
6261 library modules to define it.  You can use @option{-u} multiple times with
6262 different symbols to force loading of additional library modules.
6263 @end table
6264
6265 @node Directory Options
6266 @section Options for Directory Search
6267 @cindex directory options
6268 @cindex options, directory search
6269 @cindex search path
6270
6271 These options specify directories to search for header files, for
6272 libraries and for parts of the compiler:
6273
6274 @table @gcctabopt
6275 @item -I@var{dir}
6276 @opindex I
6277 Add the directory @var{dir} to the head of the list of directories to be
6278 searched for header files.  This can be used to override a system header
6279 file, substituting your own version, since these directories are
6280 searched before the system header file directories.  However, you should
6281 not use this option to add directories that contain vendor-supplied
6282 system header files (use @option{-isystem} for that).  If you use more than
6283 one @option{-I} option, the directories are scanned in left-to-right
6284 order; the standard system directories come after.
6285
6286 If a standard system include directory, or a directory specified with
6287 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6288 option will be ignored.  The directory will still be searched but as a
6289 system directory at its normal position in the system include chain.
6290 This is to ensure that GCC's procedure to fix buggy system headers and
6291 the ordering for the include_next directive are not inadvertently changed.
6292 If you really need to change the search order for system directories,
6293 use the @option{-nostdinc} and/or @option{-isystem} options.
6294
6295 @item -iquote@var{dir}
6296 @opindex iquote
6297 Add the directory @var{dir} to the head of the list of directories to
6298 be searched for header files only for the case of @samp{#include
6299 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6300 otherwise just like @option{-I}.
6301
6302 @item -L@var{dir}
6303 @opindex L
6304 Add directory @var{dir} to the list of directories to be searched
6305 for @option{-l}.
6306
6307 @item -B@var{prefix}
6308 @opindex B
6309 This option specifies where to find the executables, libraries,
6310 include files, and data files of the compiler itself.
6311
6312 The compiler driver program runs one or more of the subprograms
6313 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6314 @var{prefix} as a prefix for each program it tries to run, both with and
6315 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6316
6317 For each subprogram to be run, the compiler driver first tries the
6318 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6319 was not specified, the driver tries two standard prefixes, which are
6320 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6321 those results in a file name that is found, the unmodified program
6322 name is searched for using the directories specified in your
6323 @env{PATH} environment variable.
6324
6325 The compiler will check to see if the path provided by the @option{-B}
6326 refers to a directory, and if necessary it will add a directory
6327 separator character at the end of the path.
6328
6329 @option{-B} prefixes that effectively specify directory names also apply
6330 to libraries in the linker, because the compiler translates these
6331 options into @option{-L} options for the linker.  They also apply to
6332 includes files in the preprocessor, because the compiler translates these
6333 options into @option{-isystem} options for the preprocessor.  In this case,
6334 the compiler appends @samp{include} to the prefix.
6335
6336 The run-time support file @file{libgcc.a} can also be searched for using
6337 the @option{-B} prefix, if needed.  If it is not found there, the two
6338 standard prefixes above are tried, and that is all.  The file is left
6339 out of the link if it is not found by those means.
6340
6341 Another way to specify a prefix much like the @option{-B} prefix is to use
6342 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6343 Variables}.
6344
6345 As a special kludge, if the path provided by @option{-B} is
6346 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6347 9, then it will be replaced by @file{[dir/]include}.  This is to help
6348 with boot-strapping the compiler.
6349
6350 @item -specs=@var{file}
6351 @opindex specs
6352 Process @var{file} after the compiler reads in the standard @file{specs}
6353 file, in order to override the defaults that the @file{gcc} driver
6354 program uses when determining what switches to pass to @file{cc1},
6355 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6356 @option{-specs=@var{file}} can be specified on the command line, and they
6357 are processed in order, from left to right.
6358
6359 @item -I-
6360 @opindex I-
6361 This option has been deprecated.  Please use @option{-iquote} instead for
6362 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6363 Any directories you specify with @option{-I} options before the @option{-I-}
6364 option are searched only for the case of @samp{#include "@var{file}"};
6365 they are not searched for @samp{#include <@var{file}>}.
6366
6367 If additional directories are specified with @option{-I} options after
6368 the @option{-I-}, these directories are searched for all @samp{#include}
6369 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6370 this way.)
6371
6372 In addition, the @option{-I-} option inhibits the use of the current
6373 directory (where the current input file came from) as the first search
6374 directory for @samp{#include "@var{file}"}.  There is no way to
6375 override this effect of @option{-I-}.  With @option{-I.} you can specify
6376 searching the directory which was current when the compiler was
6377 invoked.  That is not exactly the same as what the preprocessor does
6378 by default, but it is often satisfactory.
6379
6380 @option{-I-} does not inhibit the use of the standard system directories
6381 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6382 independent.
6383 @end table
6384
6385 @c man end
6386
6387 @node Spec Files
6388 @section Specifying subprocesses and the switches to pass to them
6389 @cindex Spec Files
6390
6391 @command{gcc} is a driver program.  It performs its job by invoking a
6392 sequence of other programs to do the work of compiling, assembling and
6393 linking.  GCC interprets its command-line parameters and uses these to
6394 deduce which programs it should invoke, and which command-line options
6395 it ought to place on their command lines.  This behavior is controlled
6396 by @dfn{spec strings}.  In most cases there is one spec string for each
6397 program that GCC can invoke, but a few programs have multiple spec
6398 strings to control their behavior.  The spec strings built into GCC can
6399 be overridden by using the @option{-specs=} command-line switch to specify
6400 a spec file.
6401
6402 @dfn{Spec files} are plaintext files that are used to construct spec
6403 strings.  They consist of a sequence of directives separated by blank
6404 lines.  The type of directive is determined by the first non-whitespace
6405 character on the line and it can be one of the following:
6406
6407 @table @code
6408 @item %@var{command}
6409 Issues a @var{command} to the spec file processor.  The commands that can
6410 appear here are:
6411
6412 @table @code
6413 @item %include <@var{file}>
6414 @cindex %include
6415 Search for @var{file} and insert its text at the current point in the
6416 specs file.
6417
6418 @item %include_noerr <@var{file}>
6419 @cindex %include_noerr
6420 Just like @samp{%include}, but do not generate an error message if the include
6421 file cannot be found.
6422
6423 @item %rename @var{old_name} @var{new_name}
6424 @cindex %rename
6425 Rename the spec string @var{old_name} to @var{new_name}.
6426
6427 @end table
6428
6429 @item *[@var{spec_name}]:
6430 This tells the compiler to create, override or delete the named spec
6431 string.  All lines after this directive up to the next directive or
6432 blank line are considered to be the text for the spec string.  If this
6433 results in an empty string then the spec will be deleted.  (Or, if the
6434 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6435 does not currently exist a new spec will be created.  If the spec does
6436 exist then its contents will be overridden by the text of this
6437 directive, unless the first character of that text is the @samp{+}
6438 character, in which case the text will be appended to the spec.
6439
6440 @item [@var{suffix}]:
6441 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6442 and up to the next directive or blank line are considered to make up the
6443 spec string for the indicated suffix.  When the compiler encounters an
6444 input file with the named suffix, it will processes the spec string in
6445 order to work out how to compile that file.  For example:
6446
6447 @smallexample
6448 .ZZ:
6449 z-compile -input %i
6450 @end smallexample
6451
6452 This says that any input file whose name ends in @samp{.ZZ} should be
6453 passed to the program @samp{z-compile}, which should be invoked with the
6454 command-line switch @option{-input} and with the result of performing the
6455 @samp{%i} substitution.  (See below.)
6456
6457 As an alternative to providing a spec string, the text that follows a
6458 suffix directive can be one of the following:
6459
6460 @table @code
6461 @item @@@var{language}
6462 This says that the suffix is an alias for a known @var{language}.  This is
6463 similar to using the @option{-x} command-line switch to GCC to specify a
6464 language explicitly.  For example:
6465
6466 @smallexample
6467 .ZZ:
6468 @@c++
6469 @end smallexample
6470
6471 Says that .ZZ files are, in fact, C++ source files.
6472
6473 @item #@var{name}
6474 This causes an error messages saying:
6475
6476 @smallexample
6477 @var{name} compiler not installed on this system.
6478 @end smallexample
6479 @end table
6480
6481 GCC already has an extensive list of suffixes built into it.
6482 This directive will add an entry to the end of the list of suffixes, but
6483 since the list is searched from the end backwards, it is effectively
6484 possible to override earlier entries using this technique.
6485
6486 @end table
6487
6488 GCC has the following spec strings built into it.  Spec files can
6489 override these strings or create their own.  Note that individual
6490 targets can also add their own spec strings to this list.
6491
6492 @smallexample
6493 asm          Options to pass to the assembler
6494 asm_final    Options to pass to the assembler post-processor
6495 cpp          Options to pass to the C preprocessor
6496 cc1          Options to pass to the C compiler
6497 cc1plus      Options to pass to the C++ compiler
6498 endfile      Object files to include at the end of the link
6499 link         Options to pass to the linker
6500 lib          Libraries to include on the command line to the linker
6501 libgcc       Decides which GCC support library to pass to the linker
6502 linker       Sets the name of the linker
6503 predefines   Defines to be passed to the C preprocessor
6504 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6505              by default
6506 startfile    Object files to include at the start of the link
6507 @end smallexample
6508
6509 Here is a small example of a spec file:
6510
6511 @smallexample
6512 %rename lib                 old_lib
6513
6514 *lib:
6515 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6516 @end smallexample
6517
6518 This example renames the spec called @samp{lib} to @samp{old_lib} and
6519 then overrides the previous definition of @samp{lib} with a new one.
6520 The new definition adds in some extra command-line options before
6521 including the text of the old definition.
6522
6523 @dfn{Spec strings} are a list of command-line options to be passed to their
6524 corresponding program.  In addition, the spec strings can contain
6525 @samp{%}-prefixed sequences to substitute variable text or to
6526 conditionally insert text into the command line.  Using these constructs
6527 it is possible to generate quite complex command lines.
6528
6529 Here is a table of all defined @samp{%}-sequences for spec
6530 strings.  Note that spaces are not generated automatically around the
6531 results of expanding these sequences.  Therefore you can concatenate them
6532 together or combine them with constant text in a single argument.
6533
6534 @table @code
6535 @item %%
6536 Substitute one @samp{%} into the program name or argument.
6537
6538 @item %i
6539 Substitute the name of the input file being processed.
6540
6541 @item %b
6542 Substitute the basename of the input file being processed.
6543 This is the substring up to (and not including) the last period
6544 and not including the directory.
6545
6546 @item %B
6547 This is the same as @samp{%b}, but include the file suffix (text after
6548 the last period).
6549
6550 @item %d
6551 Marks the argument containing or following the @samp{%d} as a
6552 temporary file name, so that that file will be deleted if GCC exits
6553 successfully.  Unlike @samp{%g}, this contributes no text to the
6554 argument.
6555
6556 @item %g@var{suffix}
6557 Substitute a file name that has suffix @var{suffix} and is chosen
6558 once per compilation, and mark the argument in the same way as
6559 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6560 name is now chosen in a way that is hard to predict even when previously
6561 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6562 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6563 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6564 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6565 was simply substituted with a file name chosen once per compilation,
6566 without regard to any appended suffix (which was therefore treated
6567 just like ordinary text), making such attacks more likely to succeed.
6568
6569 @item %u@var{suffix}
6570 Like @samp{%g}, but generates a new temporary file name even if
6571 @samp{%u@var{suffix}} was already seen.
6572
6573 @item %U@var{suffix}
6574 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6575 new one if there is no such last file name.  In the absence of any
6576 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6577 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6578 would involve the generation of two distinct file names, one
6579 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6580 simply substituted with a file name chosen for the previous @samp{%u},
6581 without regard to any appended suffix.
6582
6583 @item %j@var{suffix}
6584 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6585 writable, and if save-temps is off; otherwise, substitute the name
6586 of a temporary file, just like @samp{%u}.  This temporary file is not
6587 meant for communication between processes, but rather as a junk
6588 disposal mechanism.
6589
6590 @item %|@var{suffix}
6591 @itemx %m@var{suffix}
6592 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6593 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6594 all.  These are the two most common ways to instruct a program that it
6595 should read from standard input or write to standard output.  If you
6596 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6597 construct: see for example @file{f/lang-specs.h}.
6598
6599 @item %.@var{SUFFIX}
6600 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6601 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6602 terminated by the next space or %.
6603
6604 @item %w
6605 Marks the argument containing or following the @samp{%w} as the
6606 designated output file of this compilation.  This puts the argument
6607 into the sequence of arguments that @samp{%o} will substitute later.
6608
6609 @item %o
6610 Substitutes the names of all the output files, with spaces
6611 automatically placed around them.  You should write spaces
6612 around the @samp{%o} as well or the results are undefined.
6613 @samp{%o} is for use in the specs for running the linker.
6614 Input files whose names have no recognized suffix are not compiled
6615 at all, but they are included among the output files, so they will
6616 be linked.
6617
6618 @item %O
6619 Substitutes the suffix for object files.  Note that this is
6620 handled specially when it immediately follows @samp{%g, %u, or %U},
6621 because of the need for those to form complete file names.  The
6622 handling is such that @samp{%O} is treated exactly as if it had already
6623 been substituted, except that @samp{%g, %u, and %U} do not currently
6624 support additional @var{suffix} characters following @samp{%O} as they would
6625 following, for example, @samp{.o}.
6626
6627 @item %p
6628 Substitutes the standard macro predefinitions for the
6629 current target machine.  Use this when running @code{cpp}.
6630
6631 @item %P
6632 Like @samp{%p}, but puts @samp{__} before and after the name of each
6633 predefined macro, except for macros that start with @samp{__} or with
6634 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6635 C@.
6636
6637 @item %I
6638 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6639 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6640 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6641 as necessary.
6642
6643 @item %s
6644 Current argument is the name of a library or startup file of some sort.
6645 Search for that file in a standard list of directories and substitute
6646 the full name found.
6647
6648 @item %e@var{str}
6649 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6650 Use this when inconsistent options are detected.
6651
6652 @item %(@var{name})
6653 Substitute the contents of spec string @var{name} at this point.
6654
6655 @item %[@var{name}]
6656 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6657
6658 @item %x@{@var{option}@}
6659 Accumulate an option for @samp{%X}.
6660
6661 @item %X
6662 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6663 spec string.
6664
6665 @item %Y
6666 Output the accumulated assembler options specified by @option{-Wa}.
6667
6668 @item %Z
6669 Output the accumulated preprocessor options specified by @option{-Wp}.
6670
6671 @item %a
6672 Process the @code{asm} spec.  This is used to compute the
6673 switches to be passed to the assembler.
6674
6675 @item %A
6676 Process the @code{asm_final} spec.  This is a spec string for
6677 passing switches to an assembler post-processor, if such a program is
6678 needed.
6679
6680 @item %l
6681 Process the @code{link} spec.  This is the spec for computing the
6682 command line passed to the linker.  Typically it will make use of the
6683 @samp{%L %G %S %D and %E} sequences.
6684
6685 @item %D
6686 Dump out a @option{-L} option for each directory that GCC believes might
6687 contain startup files.  If the target supports multilibs then the
6688 current multilib directory will be prepended to each of these paths.
6689
6690 @item %L
6691 Process the @code{lib} spec.  This is a spec string for deciding which
6692 libraries should be included on the command line to the linker.
6693
6694 @item %G
6695 Process the @code{libgcc} spec.  This is a spec string for deciding
6696 which GCC support library should be included on the command line to the linker.
6697
6698 @item %S
6699 Process the @code{startfile} spec.  This is a spec for deciding which
6700 object files should be the first ones passed to the linker.  Typically
6701 this might be a file named @file{crt0.o}.
6702
6703 @item %E
6704 Process the @code{endfile} spec.  This is a spec string that specifies
6705 the last object files that will be passed to the linker.
6706
6707 @item %C
6708 Process the @code{cpp} spec.  This is used to construct the arguments
6709 to be passed to the C preprocessor.
6710
6711 @item %1
6712 Process the @code{cc1} spec.  This is used to construct the options to be
6713 passed to the actual C compiler (@samp{cc1}).
6714
6715 @item %2
6716 Process the @code{cc1plus} spec.  This is used to construct the options to be
6717 passed to the actual C++ compiler (@samp{cc1plus}).
6718
6719 @item %*
6720 Substitute the variable part of a matched option.  See below.
6721 Note that each comma in the substituted string is replaced by
6722 a single space.
6723
6724 @item %<@code{S}
6725 Remove all occurrences of @code{-S} from the command line.  Note---this
6726 command is position dependent.  @samp{%} commands in the spec string
6727 before this one will see @code{-S}, @samp{%} commands in the spec string
6728 after this one will not.
6729
6730 @item %:@var{function}(@var{args})
6731 Call the named function @var{function}, passing it @var{args}.
6732 @var{args} is first processed as a nested spec string, then split
6733 into an argument vector in the usual fashion.  The function returns
6734 a string which is processed as if it had appeared literally as part
6735 of the current spec.
6736
6737 The following built-in spec functions are provided:
6738
6739 @table @code
6740 @item @code{if-exists}
6741 The @code{if-exists} spec function takes one argument, an absolute
6742 pathname to a file.  If the file exists, @code{if-exists} returns the
6743 pathname.  Here is a small example of its usage:
6744
6745 @smallexample
6746 *startfile:
6747 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6748 @end smallexample
6749
6750 @item @code{if-exists-else}
6751 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6752 spec function, except that it takes two arguments.  The first argument is
6753 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6754 returns the pathname.  If it does not exist, it returns the second argument.
6755 This way, @code{if-exists-else} can be used to select one file or another,
6756 based on the existence of the first.  Here is a small example of its usage:
6757
6758 @smallexample
6759 *startfile:
6760 crt0%O%s %:if-exists(crti%O%s) \
6761 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6762 @end smallexample
6763
6764 @item @code{replace-outfile}
6765 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6766 first argument in the outfiles array and replaces it with the second argument.  Here
6767 is a small example of its usage:
6768
6769 @smallexample
6770 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6771 @end smallexample
6772
6773 @end table
6774
6775 @item %@{@code{S}@}
6776 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6777 If that switch was not specified, this substitutes nothing.  Note that
6778 the leading dash is omitted when specifying this option, and it is
6779 automatically inserted if the substitution is performed.  Thus the spec
6780 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6781 and would output the command line option @option{-foo}.
6782
6783 @item %W@{@code{S}@}
6784 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6785 deleted on failure.
6786
6787 @item %@{@code{S}*@}
6788 Substitutes all the switches specified to GCC whose names start
6789 with @code{-S}, but which also take an argument.  This is used for
6790 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6791 GCC considers @option{-o foo} as being
6792 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6793 text, including the space.  Thus two arguments would be generated.
6794
6795 @item %@{@code{S}*&@code{T}*@}
6796 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6797 (the order of @code{S} and @code{T} in the spec is not significant).
6798 There can be any number of ampersand-separated variables; for each the
6799 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6800
6801 @item %@{@code{S}:@code{X}@}
6802 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6803
6804 @item %@{!@code{S}:@code{X}@}
6805 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6806
6807 @item %@{@code{S}*:@code{X}@}
6808 Substitutes @code{X} if one or more switches whose names start with
6809 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6810 once, no matter how many such switches appeared.  However, if @code{%*}
6811 appears somewhere in @code{X}, then @code{X} will be substituted once
6812 for each matching switch, with the @code{%*} replaced by the part of
6813 that switch that matched the @code{*}.
6814
6815 @item %@{.@code{S}:@code{X}@}
6816 Substitutes @code{X}, if processing a file with suffix @code{S}.
6817
6818 @item %@{!.@code{S}:@code{X}@}
6819 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6820
6821 @item %@{@code{S}|@code{P}:@code{X}@}
6822 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6823 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6824 although they have a stronger binding than the @samp{|}.  If @code{%*}
6825 appears in @code{X}, all of the alternatives must be starred, and only
6826 the first matching alternative is substituted.
6827
6828 For example, a spec string like this:
6829
6830 @smallexample
6831 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6832 @end smallexample
6833
6834 will output the following command-line options from the following input
6835 command-line options:
6836
6837 @smallexample
6838 fred.c        -foo -baz
6839 jim.d         -bar -boggle
6840 -d fred.c     -foo -baz -boggle
6841 -d jim.d      -bar -baz -boggle
6842 @end smallexample
6843
6844 @item %@{S:X; T:Y; :D@}
6845
6846 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6847 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6848 be as many clauses as you need.  This may be combined with @code{.},
6849 @code{!}, @code{|}, and @code{*} as needed.
6850
6851
6852 @end table
6853
6854 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6855 construct may contain other nested @samp{%} constructs or spaces, or
6856 even newlines.  They are processed as usual, as described above.
6857 Trailing white space in @code{X} is ignored.  White space may also
6858 appear anywhere on the left side of the colon in these constructs,
6859 except between @code{.} or @code{*} and the corresponding word.
6860
6861 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6862 handled specifically in these constructs.  If another value of
6863 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6864 @option{-W} switch is found later in the command line, the earlier
6865 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6866 just one letter, which passes all matching options.
6867
6868 The character @samp{|} at the beginning of the predicate text is used to
6869 indicate that a command should be piped to the following command, but
6870 only if @option{-pipe} is specified.
6871
6872 It is built into GCC which switches take arguments and which do not.
6873 (You might think it would be useful to generalize this to allow each
6874 compiler's spec to say which switches take arguments.  But this cannot
6875 be done in a consistent fashion.  GCC cannot even decide which input
6876 files have been specified without knowing which switches take arguments,
6877 and it must know which input files to compile in order to tell which
6878 compilers to run).
6879
6880 GCC also knows implicitly that arguments starting in @option{-l} are to be
6881 treated as compiler output files, and passed to the linker in their
6882 proper position among the other output files.
6883
6884 @c man begin OPTIONS
6885
6886 @node Target Options
6887 @section Specifying Target Machine and Compiler Version
6888 @cindex target options
6889 @cindex cross compiling
6890 @cindex specifying machine version
6891 @cindex specifying compiler version and target machine
6892 @cindex compiler version, specifying
6893 @cindex target machine, specifying
6894
6895 The usual way to run GCC is to run the executable called @file{gcc}, or
6896 @file{<machine>-gcc} when cross-compiling, or
6897 @file{<machine>-gcc-<version>} to run a version other than the one that
6898 was installed last.  Sometimes this is inconvenient, so GCC provides
6899 options that will switch to another cross-compiler or version.
6900
6901 @table @gcctabopt
6902 @item -b @var{machine}
6903 @opindex b
6904 The argument @var{machine} specifies the target machine for compilation.
6905
6906 The value to use for @var{machine} is the same as was specified as the
6907 machine type when configuring GCC as a cross-compiler.  For
6908 example, if a cross-compiler was configured with @samp{configure
6909 i386v}, meaning to compile for an 80386 running System V, then you
6910 would specify @option{-b i386v} to run that cross compiler.
6911
6912 @item -V @var{version}
6913 @opindex V
6914 The argument @var{version} specifies which version of GCC to run.
6915 This is useful when multiple versions are installed.  For example,
6916 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6917 @end table
6918
6919 The @option{-V} and @option{-b} options work by running the
6920 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6921 use them if you can just run that directly.
6922
6923 @node Submodel Options
6924 @section Hardware Models and Configurations
6925 @cindex submodel options
6926 @cindex specifying hardware config
6927 @cindex hardware models and configurations, specifying
6928 @cindex machine dependent options
6929
6930 Earlier we discussed the standard option @option{-b} which chooses among
6931 different installed compilers for completely different target
6932 machines, such as VAX vs.@: 68000 vs.@: 80386.
6933
6934 In addition, each of these target machine types can have its own
6935 special options, starting with @samp{-m}, to choose among various
6936 hardware models or configurations---for example, 68010 vs 68020,
6937 floating coprocessor or none.  A single installed version of the
6938 compiler can compile for any model or configuration, according to the
6939 options specified.
6940
6941 Some configurations of the compiler also support additional special
6942 options, usually for compatibility with other compilers on the same
6943 platform.
6944
6945 @c This list is ordered alphanumerically by subsection name.
6946 @c It should be the same order and spelling as these options are listed
6947 @c in Machine Dependent Options
6948
6949 @menu
6950 * ARC Options::
6951 * ARM Options::
6952 * AVR Options::
6953 * Blackfin Options::
6954 * CRIS Options::
6955 * Darwin Options::
6956 * DEC Alpha Options::
6957 * DEC Alpha/VMS Options::
6958 * FRV Options::
6959 * H8/300 Options::
6960 * HPPA Options::
6961 * i386 and x86-64 Options::
6962 * IA-64 Options::
6963 * M32C Options::
6964 * M32R/D Options::
6965 * M680x0 Options::
6966 * M68hc1x Options::
6967 * MCore Options::
6968 * MIPS Options::
6969 * MMIX Options::
6970 * MN10300 Options::
6971 * PDP-11 Options::
6972 * PowerPC Options::
6973 * RS/6000 and PowerPC Options::
6974 * S/390 and zSeries Options::
6975 * SH Options::
6976 * SPARC Options::
6977 * System V Options::
6978 * TMS320C3x/C4x Options::
6979 * V850 Options::
6980 * VAX Options::
6981 * x86-64 Options::
6982 * Xstormy16 Options::
6983 * Xtensa Options::
6984 * zSeries Options::
6985 @end menu
6986
6987 @node ARC Options
6988 @subsection ARC Options
6989 @cindex ARC Options
6990
6991 These options are defined for ARC implementations:
6992
6993 @table @gcctabopt
6994 @item -EL
6995 @opindex EL
6996 Compile code for little endian mode.  This is the default.
6997
6998 @item -EB
6999 @opindex EB
7000 Compile code for big endian mode.
7001
7002 @item -mmangle-cpu
7003 @opindex mmangle-cpu
7004 Prepend the name of the cpu to all public symbol names.
7005 In multiple-processor systems, there are many ARC variants with different
7006 instruction and register set characteristics.  This flag prevents code
7007 compiled for one cpu to be linked with code compiled for another.
7008 No facility exists for handling variants that are ``almost identical''.
7009 This is an all or nothing option.
7010
7011 @item -mcpu=@var{cpu}
7012 @opindex mcpu
7013 Compile code for ARC variant @var{cpu}.
7014 Which variants are supported depend on the configuration.
7015 All variants support @option{-mcpu=base}, this is the default.
7016
7017 @item -mtext=@var{text-section}
7018 @itemx -mdata=@var{data-section}
7019 @itemx -mrodata=@var{readonly-data-section}
7020 @opindex mtext
7021 @opindex mdata
7022 @opindex mrodata
7023 Put functions, data, and readonly data in @var{text-section},
7024 @var{data-section}, and @var{readonly-data-section} respectively
7025 by default.  This can be overridden with the @code{section} attribute.
7026 @xref{Variable Attributes}.
7027
7028 @end table
7029
7030 @node ARM Options
7031 @subsection ARM Options
7032 @cindex ARM options
7033
7034 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7035 architectures:
7036
7037 @table @gcctabopt
7038 @item -mabi=@var{name}
7039 @opindex mabi
7040 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7041 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7042
7043 @item -mapcs-frame
7044 @opindex mapcs-frame
7045 Generate a stack frame that is compliant with the ARM Procedure Call
7046 Standard for all functions, even if this is not strictly necessary for
7047 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7048 with this option will cause the stack frames not to be generated for
7049 leaf functions.  The default is @option{-mno-apcs-frame}.
7050
7051 @item -mapcs
7052 @opindex mapcs
7053 This is a synonym for @option{-mapcs-frame}.
7054
7055 @ignore
7056 @c not currently implemented
7057 @item -mapcs-stack-check
7058 @opindex mapcs-stack-check
7059 Generate code to check the amount of stack space available upon entry to
7060 every function (that actually uses some stack space).  If there is
7061 insufficient space available then either the function
7062 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7063 called, depending upon the amount of stack space required.  The run time
7064 system is required to provide these functions.  The default is
7065 @option{-mno-apcs-stack-check}, since this produces smaller code.
7066
7067 @c not currently implemented
7068 @item -mapcs-float
7069 @opindex mapcs-float
7070 Pass floating point arguments using the float point registers.  This is
7071 one of the variants of the APCS@.  This option is recommended if the
7072 target hardware has a floating point unit or if a lot of floating point
7073 arithmetic is going to be performed by the code.  The default is
7074 @option{-mno-apcs-float}, since integer only code is slightly increased in
7075 size if @option{-mapcs-float} is used.
7076
7077 @c not currently implemented
7078 @item -mapcs-reentrant
7079 @opindex mapcs-reentrant
7080 Generate reentrant, position independent code.  The default is
7081 @option{-mno-apcs-reentrant}.
7082 @end ignore
7083
7084 @item -mthumb-interwork
7085 @opindex mthumb-interwork
7086 Generate code which supports calling between the ARM and Thumb
7087 instruction sets.  Without this option the two instruction sets cannot
7088 be reliably used inside one program.  The default is
7089 @option{-mno-thumb-interwork}, since slightly larger code is generated
7090 when @option{-mthumb-interwork} is specified.
7091
7092 @item -mno-sched-prolog
7093 @opindex mno-sched-prolog
7094 Prevent the reordering of instructions in the function prolog, or the
7095 merging of those instruction with the instructions in the function's
7096 body.  This means that all functions will start with a recognizable set
7097 of instructions (or in fact one of a choice from a small set of
7098 different function prologues), and this information can be used to
7099 locate the start if functions inside an executable piece of code.  The
7100 default is @option{-msched-prolog}.
7101
7102 @item -mhard-float
7103 @opindex mhard-float
7104 Generate output containing floating point instructions.  This is the
7105 default.
7106
7107 @item -msoft-float
7108 @opindex msoft-float
7109 Generate output containing library calls for floating point.
7110 @strong{Warning:} the requisite libraries are not available for all ARM
7111 targets.  Normally the facilities of the machine's usual C compiler are
7112 used, but this cannot be done directly in cross-compilation.  You must make
7113 your own arrangements to provide suitable library functions for
7114 cross-compilation.
7115
7116 @option{-msoft-float} changes the calling convention in the output file;
7117 therefore, it is only useful if you compile @emph{all} of a program with
7118 this option.  In particular, you need to compile @file{libgcc.a}, the
7119 library that comes with GCC, with @option{-msoft-float} in order for
7120 this to work.
7121
7122 @item -mfloat-abi=@var{name}
7123 @opindex mfloat-abi
7124 Specifies which ABI to use for floating point values.  Permissible values
7125 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7126
7127 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7128 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7129 of floating point instructions, but still uses the soft-float calling
7130 conventions.
7131
7132 @item -mlittle-endian
7133 @opindex mlittle-endian
7134 Generate code for a processor running in little-endian mode.  This is
7135 the default for all standard configurations.
7136
7137 @item -mbig-endian
7138 @opindex mbig-endian
7139 Generate code for a processor running in big-endian mode; the default is
7140 to compile code for a little-endian processor.
7141
7142 @item -mwords-little-endian
7143 @opindex mwords-little-endian
7144 This option only applies when generating code for big-endian processors.
7145 Generate code for a little-endian word order but a big-endian byte
7146 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7147 option should only be used if you require compatibility with code for
7148 big-endian ARM processors generated by versions of the compiler prior to
7149 2.8.
7150
7151 @item -mcpu=@var{name}
7152 @opindex mcpu
7153 This specifies the name of the target ARM processor.  GCC uses this name
7154 to determine what kind of instructions it can emit when generating
7155 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7156 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7157 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7158 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7159 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7160 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7161 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7162 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7163 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7164 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7165 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7166 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7167 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7168 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7169 @samp{ep9312}.
7170
7171 @itemx -mtune=@var{name}
7172 @opindex mtune
7173 This option is very similar to the @option{-mcpu=} option, except that
7174 instead of specifying the actual target processor type, and hence
7175 restricting which instructions can be used, it specifies that GCC should
7176 tune the performance of the code as if the target were of the type
7177 specified in this option, but still choosing the instructions that it
7178 will generate based on the cpu specified by a @option{-mcpu=} option.
7179 For some ARM implementations better performance can be obtained by using
7180 this option.
7181
7182 @item -march=@var{name}
7183 @opindex march
7184 This specifies the name of the target ARM architecture.  GCC uses this
7185 name to determine what kind of instructions it can emit when generating
7186 assembly code.  This option can be used in conjunction with or instead
7187 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7188 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7189 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7190 @samp{iwmmxt}, @samp{ep9312}.
7191
7192 @item -mfpu=@var{name}
7193 @itemx -mfpe=@var{number}
7194 @itemx -mfp=@var{number}
7195 @opindex mfpu
7196 @opindex mfpe
7197 @opindex mfp
7198 This specifies what floating point hardware (or hardware emulation) is
7199 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7200 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7201 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7202 with older versions of GCC@.
7203
7204 If @option{-msoft-float} is specified this specifies the format of
7205 floating point values.
7206
7207 @item -mstructure-size-boundary=@var{n}
7208 @opindex mstructure-size-boundary
7209 The size of all structures and unions will be rounded up to a multiple
7210 of the number of bits set by this option.  Permissible values are 8, 32
7211 and 64.  The default value varies for different toolchains.  For the COFF
7212 targeted toolchain the default value is 8.  A value of 64 is only allowed
7213 if the underlying ABI supports it.
7214
7215 Specifying the larger number can produce faster, more efficient code, but
7216 can also increase the size of the program.  Different values are potentially
7217 incompatible.  Code compiled with one value cannot necessarily expect to
7218 work with code or libraries compiled with another value, if they exchange
7219 information using structures or unions.
7220
7221 @item -mabort-on-noreturn
7222 @opindex mabort-on-noreturn
7223 Generate a call to the function @code{abort} at the end of a
7224 @code{noreturn} function.  It will be executed if the function tries to
7225 return.
7226
7227 @item -mlong-calls
7228 @itemx -mno-long-calls
7229 @opindex mlong-calls
7230 @opindex mno-long-calls
7231 Tells the compiler to perform function calls by first loading the
7232 address of the function into a register and then performing a subroutine
7233 call on this register.  This switch is needed if the target function
7234 will lie outside of the 64 megabyte addressing range of the offset based
7235 version of subroutine call instruction.
7236
7237 Even if this switch is enabled, not all function calls will be turned
7238 into long calls.  The heuristic is that static functions, functions
7239 which have the @samp{short-call} attribute, functions that are inside
7240 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7241 definitions have already been compiled within the current compilation
7242 unit, will not be turned into long calls.  The exception to this rule is
7243 that weak function definitions, functions with the @samp{long-call}
7244 attribute or the @samp{section} attribute, and functions that are within
7245 the scope of a @samp{#pragma long_calls} directive, will always be
7246 turned into long calls.
7247
7248 This feature is not enabled by default.  Specifying
7249 @option{-mno-long-calls} will restore the default behavior, as will
7250 placing the function calls within the scope of a @samp{#pragma
7251 long_calls_off} directive.  Note these switches have no effect on how
7252 the compiler generates code to handle function calls via function
7253 pointers.
7254
7255 @item -mnop-fun-dllimport
7256 @opindex mnop-fun-dllimport
7257 Disable support for the @code{dllimport} attribute.
7258
7259 @item -msingle-pic-base
7260 @opindex msingle-pic-base
7261 Treat the register used for PIC addressing as read-only, rather than
7262 loading it in the prologue for each function.  The run-time system is
7263 responsible for initializing this register with an appropriate value
7264 before execution begins.
7265
7266 @item -mpic-register=@var{reg}
7267 @opindex mpic-register
7268 Specify the register to be used for PIC addressing.  The default is R10
7269 unless stack-checking is enabled, when R9 is used.
7270
7271 @item -mcirrus-fix-invalid-insns
7272 @opindex mcirrus-fix-invalid-insns
7273 @opindex mno-cirrus-fix-invalid-insns
7274 Insert NOPs into the instruction stream to in order to work around
7275 problems with invalid Maverick instruction combinations.  This option
7276 is only valid if the @option{-mcpu=ep9312} option has been used to
7277 enable generation of instructions for the Cirrus Maverick floating
7278 point co-processor.  This option is not enabled by default, since the
7279 problem is only present in older Maverick implementations.  The default
7280 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7281 switch.
7282
7283 @item -mpoke-function-name
7284 @opindex mpoke-function-name
7285 Write the name of each function into the text section, directly
7286 preceding the function prologue.  The generated code is similar to this:
7287
7288 @smallexample
7289      t0
7290          .ascii "arm_poke_function_name", 0
7291          .align
7292      t1
7293          .word 0xff000000 + (t1 - t0)
7294      arm_poke_function_name
7295          mov     ip, sp
7296          stmfd   sp!, @{fp, ip, lr, pc@}
7297          sub     fp, ip, #4
7298 @end smallexample
7299
7300 When performing a stack backtrace, code can inspect the value of
7301 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7302 location @code{pc - 12} and the top 8 bits are set, then we know that
7303 there is a function name embedded immediately preceding this location
7304 and has length @code{((pc[-3]) & 0xff000000)}.
7305
7306 @item -mthumb
7307 @opindex mthumb
7308 Generate code for the 16-bit Thumb instruction set.  The default is to
7309 use the 32-bit ARM instruction set.
7310
7311 @item -mtpcs-frame
7312 @opindex mtpcs-frame
7313 Generate a stack frame that is compliant with the Thumb Procedure Call
7314 Standard for all non-leaf functions.  (A leaf function is one that does
7315 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7316
7317 @item -mtpcs-leaf-frame
7318 @opindex mtpcs-leaf-frame
7319 Generate a stack frame that is compliant with the Thumb Procedure Call
7320 Standard for all leaf functions.  (A leaf function is one that does
7321 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7322
7323 @item -mcallee-super-interworking
7324 @opindex mcallee-super-interworking
7325 Gives all externally visible functions in the file being compiled an ARM
7326 instruction set header which switches to Thumb mode before executing the
7327 rest of the function.  This allows these functions to be called from
7328 non-interworking code.
7329
7330 @item -mcaller-super-interworking
7331 @opindex mcaller-super-interworking
7332 Allows calls via function pointers (including virtual functions) to
7333 execute correctly regardless of whether the target code has been
7334 compiled for interworking or not.  There is a small overhead in the cost
7335 of executing a function pointer if this option is enabled.
7336
7337 @end table
7338
7339 @node AVR Options
7340 @subsection AVR Options
7341 @cindex AVR Options
7342
7343 These options are defined for AVR implementations:
7344
7345 @table @gcctabopt
7346 @item -mmcu=@var{mcu}
7347 @opindex mmcu
7348 Specify ATMEL AVR instruction set or MCU type.
7349
7350 Instruction set avr1 is for the minimal AVR core, not supported by the C
7351 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7352 attiny11, attiny12, attiny15, attiny28).
7353
7354 Instruction set avr2 (default) is for the classic AVR core with up to
7355 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7356 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7357 at90c8534, at90s8535).
7358
7359 Instruction set avr3 is for the classic AVR core with up to 128K program
7360 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7361
7362 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7363 memory space (MCU types: atmega8, atmega83, atmega85).
7364
7365 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7366 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7367 atmega64, atmega128, at43usb355, at94k).
7368
7369 @item -msize
7370 @opindex msize
7371 Output instruction sizes to the asm file.
7372
7373 @item -minit-stack=@var{N}
7374 @opindex minit-stack
7375 Specify the initial stack address, which may be a symbol or numeric value,
7376 @samp{__stack} is the default.
7377
7378 @item -mno-interrupts
7379 @opindex mno-interrupts
7380 Generated code is not compatible with hardware interrupts.
7381 Code size will be smaller.
7382
7383 @item -mcall-prologues
7384 @opindex mcall-prologues
7385 Functions prologues/epilogues expanded as call to appropriate
7386 subroutines.  Code size will be smaller.
7387
7388 @item -mno-tablejump
7389 @opindex mno-tablejump
7390 Do not generate tablejump insns which sometimes increase code size.
7391
7392 @item -mtiny-stack
7393 @opindex mtiny-stack
7394 Change only the low 8 bits of the stack pointer.
7395
7396 @item -mint8
7397 @opindex mint8
7398 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7399 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7400 and long long will be 4 bytes.  Please note that this option does not
7401 comply to the C standards, but it will provide you with smaller code
7402 size.
7403 @end table
7404
7405 @node Blackfin Options
7406 @subsection Blackfin Options
7407 @cindex Blackfin Options
7408
7409 @table @gcctabopt
7410 @item -momit-leaf-frame-pointer
7411 @opindex momit-leaf-frame-pointer
7412 Don't keep the frame pointer in a register for leaf functions.  This
7413 avoids the instructions to save, set up and restore frame pointers and
7414 makes an extra register available in leaf functions.  The option
7415 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7416 which might make debugging harder.
7417
7418 @item -mspecld-anomaly
7419 @opindex mspecld-anomaly
7420 When enabled, the compiler will ensure that the generated code does not
7421 contain speculative loads after jump instructions.  This option is enabled
7422 by default.
7423
7424 @item -mno-specld-anomaly
7425 @opindex mno-specld-anomaly
7426 Don't generate extra code to prevent speculative loads from occurring.
7427
7428 @item -mcsync-anomaly
7429 @opindex mcsync-anomaly
7430 When enabled, the compiler will ensure that the generated code does not
7431 contain CSYNC or SSYNC instructions too soon after conditional branches.
7432 This option is enabled by default.
7433
7434 @item -mno-csync-anomaly
7435 @opindex mno-csync-anomaly
7436 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7437 occurring too soon after a conditional branch.
7438
7439 @item -mlow-64k
7440 @opindex mlow-64k
7441 When enabled, the compiler is free to take advantage of the knowledge that
7442 the entire program fits into the low 64k of memory.
7443
7444 @item -mno-low-64k
7445 @opindex mno-low-64k
7446 Assume that the program is arbitrarily large.  This is the default.
7447
7448 @item -mid-shared-library
7449 @opindex mid-shared-library
7450 Generate code that supports shared libraries via the library ID method.
7451 This allows for execute in place and shared libraries in an environment
7452 without virtual memory management.  This option implies @option{-fPIC}.
7453
7454 @item -mno-id-shared-library
7455 @opindex mno-id-shared-library
7456 Generate code that doesn't assume ID based shared libraries are being used.
7457 This is the default.
7458
7459 @item -mshared-library-id=n
7460 @opindex mshared-library-id
7461 Specified the identification number of the ID based shared library being
7462 compiled.  Specifying a value of 0 will generate more compact code, specifying
7463 other values will force the allocation of that number to the current
7464 library but is no more space or time efficient than omitting this option.
7465
7466 @item -mlong-calls
7467 @itemx -mno-long-calls
7468 @opindex mlong-calls
7469 @opindex mno-long-calls
7470 Tells the compiler to perform function calls by first loading the
7471 address of the function into a register and then performing a subroutine
7472 call on this register.  This switch is needed if the target function
7473 will lie outside of the 24 bit addressing range of the offset based
7474 version of subroutine call instruction.
7475
7476 This feature is not enabled by default.  Specifying
7477 @option{-mno-long-calls} will restore the default behavior.  Note these
7478 switches have no effect on how the compiler generates code to handle
7479 function calls via function pointers.
7480 @end table
7481
7482 @node CRIS Options
7483 @subsection CRIS Options
7484 @cindex CRIS Options
7485
7486 These options are defined specifically for the CRIS ports.
7487
7488 @table @gcctabopt
7489 @item -march=@var{architecture-type}
7490 @itemx -mcpu=@var{architecture-type}
7491 @opindex march
7492 @opindex mcpu
7493 Generate code for the specified architecture.  The choices for
7494 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7495 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7496 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7497 @samp{v10}.
7498
7499 @item -mtune=@var{architecture-type}
7500 @opindex mtune
7501 Tune to @var{architecture-type} everything applicable about the generated
7502 code, except for the ABI and the set of available instructions.  The
7503 choices for @var{architecture-type} are the same as for
7504 @option{-march=@var{architecture-type}}.
7505
7506 @item -mmax-stack-frame=@var{n}
7507 @opindex mmax-stack-frame
7508 Warn when the stack frame of a function exceeds @var{n} bytes.
7509
7510 @item -melinux-stacksize=@var{n}
7511 @opindex melinux-stacksize
7512 Only available with the @samp{cris-axis-aout} target.  Arranges for
7513 indications in the program to the kernel loader that the stack of the
7514 program should be set to @var{n} bytes.
7515
7516 @item -metrax4
7517 @itemx -metrax100
7518 @opindex metrax4
7519 @opindex metrax100
7520 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7521 @option{-march=v3} and @option{-march=v8} respectively.
7522
7523 @item -mmul-bug-workaround
7524 @itemx -mno-mul-bug-workaround
7525 @opindex mmul-bug-workaround
7526 @opindex mno-mul-bug-workaround
7527 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7528 models where it applies.  This option is active by default.
7529
7530 @item -mpdebug
7531 @opindex mpdebug
7532 Enable CRIS-specific verbose debug-related information in the assembly
7533 code.  This option also has the effect to turn off the @samp{#NO_APP}
7534 formatted-code indicator to the assembler at the beginning of the
7535 assembly file.
7536
7537 @item -mcc-init
7538 @opindex mcc-init
7539 Do not use condition-code results from previous instruction; always emit
7540 compare and test instructions before use of condition codes.
7541
7542 @item -mno-side-effects
7543 @opindex mno-side-effects
7544 Do not emit instructions with side-effects in addressing modes other than
7545 post-increment.
7546
7547 @item -mstack-align
7548 @itemx -mno-stack-align
7549 @itemx -mdata-align
7550 @itemx -mno-data-align
7551 @itemx -mconst-align
7552 @itemx -mno-const-align
7553 @opindex mstack-align
7554 @opindex mno-stack-align
7555 @opindex mdata-align
7556 @opindex mno-data-align
7557 @opindex mconst-align
7558 @opindex mno-const-align
7559 These options (no-options) arranges (eliminate arrangements) for the
7560 stack-frame, individual data and constants to be aligned for the maximum
7561 single data access size for the chosen CPU model.  The default is to
7562 arrange for 32-bit alignment.  ABI details such as structure layout are
7563 not affected by these options.
7564
7565 @item -m32-bit
7566 @itemx -m16-bit
7567 @itemx -m8-bit
7568 @opindex m32-bit
7569 @opindex m16-bit
7570 @opindex m8-bit
7571 Similar to the stack- data- and const-align options above, these options
7572 arrange for stack-frame, writable data and constants to all be 32-bit,
7573 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7574
7575 @item -mno-prologue-epilogue
7576 @itemx -mprologue-epilogue
7577 @opindex mno-prologue-epilogue
7578 @opindex mprologue-epilogue
7579 With @option{-mno-prologue-epilogue}, the normal function prologue and
7580 epilogue that sets up the stack-frame are omitted and no return
7581 instructions or return sequences are generated in the code.  Use this
7582 option only together with visual inspection of the compiled code: no
7583 warnings or errors are generated when call-saved registers must be saved,
7584 or storage for local variable needs to be allocated.
7585
7586 @item -mno-gotplt
7587 @itemx -mgotplt
7588 @opindex mno-gotplt
7589 @opindex mgotplt
7590 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7591 instruction sequences that load addresses for functions from the PLT part
7592 of the GOT rather than (traditional on other architectures) calls to the
7593 PLT@.  The default is @option{-mgotplt}.
7594
7595 @item -maout
7596 @opindex maout
7597 Legacy no-op option only recognized with the cris-axis-aout target.
7598
7599 @item -melf
7600 @opindex melf
7601 Legacy no-op option only recognized with the cris-axis-elf and
7602 cris-axis-linux-gnu targets.
7603
7604 @item -melinux
7605 @opindex melinux
7606 Only recognized with the cris-axis-aout target, where it selects a
7607 GNU/linux-like multilib, include files and instruction set for
7608 @option{-march=v8}.
7609
7610 @item -mlinux
7611 @opindex mlinux
7612 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7613
7614 @item -sim
7615 @opindex sim
7616 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7617 to link with input-output functions from a simulator library.  Code,
7618 initialized data and zero-initialized data are allocated consecutively.
7619
7620 @item -sim2
7621 @opindex sim2
7622 Like @option{-sim}, but pass linker options to locate initialized data at
7623 0x40000000 and zero-initialized data at 0x80000000.
7624 @end table
7625
7626 @node Darwin Options
7627 @subsection Darwin Options
7628 @cindex Darwin options
7629
7630 These options are defined for all architectures running the Darwin operating
7631 system.
7632
7633 FSF GCC on Darwin does not create ``fat'' object files; it will create
7634 an object file for the single architecture that it was built to
7635 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7636 @option{-arch} options are used; it does so by running the compiler or
7637 linker multiple times and joining the results together with
7638 @file{lipo}.
7639
7640 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7641 @samp{i686}) is determined by the flags that specify the ISA
7642 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7643 @option{-force_cpusubtype_ALL} option can be used to override this.
7644
7645 The Darwin tools vary in their behavior when presented with an ISA
7646 mismatch.  The assembler, @file{as}, will only permit instructions to
7647 be used that are valid for the subtype of the file it is generating,
7648 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7649 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7650 and print an error if asked to create a shared library with a less
7651 restrictive subtype than its input files (for instance, trying to put
7652 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7653 for executables, @file{ld}, will quietly give the executable the most
7654 restrictive subtype of any of its input files.
7655
7656 @table @gcctabopt
7657 @item -F@var{dir}
7658 @opindex F
7659 Add the framework directory @var{dir} to the head of the list of
7660 directories to be searched for header files.  These directories are
7661 interleaved with those specified by @option{-I} options and are
7662 scanned in a left-to-right order.
7663
7664 A framework directory is a directory with frameworks in it.  A
7665 framework is a directory with a @samp{"Headers"} and/or
7666 @samp{"PrivateHeaders"} directory contained directly in it that ends
7667 in @samp{".framework"}.  The name of a framework is the name of this
7668 directory excluding the @samp{".framework"}.  Headers associated with
7669 the framework are found in one of those two directories, with
7670 @samp{"Headers"} being searched first.  A subframework is a framework
7671 directory that is in a framework's @samp{"Frameworks"} directory.
7672 Includes of subframework headers can only appear in a header of a
7673 framework that contains the subframework, or in a sibling subframework
7674 header.  Two subframeworks are siblings if they occur in the same
7675 framework.  A subframework should not have the same name as a
7676 framework, a warning will be issued if this is violated.  Currently a
7677 subframework cannot have subframeworks, in the future, the mechanism
7678 may be extended to support this.  The standard frameworks can be found
7679 in @samp{"/System/Library/Frameworks"} and
7680 @samp{"/Library/Frameworks"}.  An example include looks like
7681 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7682 the name of the framework and header.h is found in the
7683 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7684
7685 @item -gused
7686 @opindex -gused
7687 Emit debugging information for symbols that are used.  For STABS
7688 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7689 This is by default ON@.
7690
7691 @item -gfull
7692 @opindex -gfull
7693 Emit debugging information for all symbols and types.
7694
7695 @item -mmacosx-version-min=@var{version}
7696 The earliest version of MacOS X that this executable will run on
7697 is @var{version}.  Typical values of @var{version} include @code{10.1},
7698 @code{10.2}, and @code{10.3.9}.
7699
7700 The default for this option is to make choices that seem to be most
7701 useful.  
7702
7703 @item -mone-byte-bool
7704 @opindex -mone-byte-bool
7705 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7706 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7707 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7708 option has no effect on x86.
7709
7710 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7711 to generate code that is not binary compatible with code generated
7712 without that switch.  Using this switch may require recompiling all
7713 other modules in a program, including system libraries.  Use this
7714 switch to conform to a non-default data model.
7715
7716 @item -mfix-and-continue
7717 @itemx -ffix-and-continue
7718 @itemx -findirect-data
7719 @opindex mfix-and-continue
7720 @opindex ffix-and-continue
7721 @opindex findirect-data
7722 Generate code suitable for fast turn around development.  Needed to
7723 enable gdb to dynamically load @code{.o} files into already running
7724 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7725 are provided for backwards compatibility.
7726
7727 @item -all_load
7728 @opindex all_load
7729 Loads all members of static archive libraries.
7730 See man ld(1) for more information.
7731
7732 @item -arch_errors_fatal
7733 @opindex arch_errors_fatal
7734 Cause the errors having to do with files that have the wrong architecture
7735 to be fatal.
7736
7737 @item -bind_at_load
7738 @opindex bind_at_load
7739 Causes the output file to be marked such that the dynamic linker will
7740 bind all undefined references when the file is loaded or launched.
7741
7742 @item -bundle
7743 @opindex bundle
7744 Produce a Mach-o bundle format file.
7745 See man ld(1) for more information.
7746
7747 @item -bundle_loader @var{executable}
7748 @opindex bundle_loader
7749 This option specifies the @var{executable} that will be loading the build
7750 output file being linked.  See man ld(1) for more information.
7751
7752 @item -dynamiclib
7753 @opindex -dynamiclib
7754 When passed this option, GCC will produce a dynamic library instead of
7755 an executable when linking, using the Darwin @file{libtool} command.
7756
7757 @item -force_cpusubtype_ALL
7758 @opindex -force_cpusubtype_ALL
7759 This causes GCC's output file to have the @var{ALL} subtype, instead of
7760 one controlled by the @option{-mcpu} or @option{-march} option.
7761
7762 @item -allowable_client  @var{client_name}
7763 @itemx -client_name
7764 @itemx -compatibility_version
7765 @itemx -current_version
7766 @itemx -dead_strip
7767 @itemx -dependency-file
7768 @itemx -dylib_file
7769 @itemx -dylinker_install_name
7770 @itemx -dynamic
7771 @itemx -exported_symbols_list
7772 @itemx -filelist
7773 @itemx -flat_namespace
7774 @itemx -force_flat_namespace
7775 @itemx -headerpad_max_install_names
7776 @itemx -image_base
7777 @itemx -init
7778 @itemx -install_name
7779 @itemx -keep_private_externs
7780 @itemx -multi_module
7781 @itemx -multiply_defined
7782 @itemx -multiply_defined_unused
7783 @itemx -noall_load
7784 @itemx -no_dead_strip_inits_and_terms
7785 @itemx -nofixprebinding
7786 @itemx -nomultidefs
7787 @itemx -noprebind
7788 @itemx -noseglinkedit
7789 @itemx -pagezero_size
7790 @itemx -prebind
7791 @itemx -prebind_all_twolevel_modules
7792 @itemx -private_bundle
7793 @itemx -read_only_relocs
7794 @itemx -sectalign
7795 @itemx -sectobjectsymbols
7796 @itemx -whyload
7797 @itemx -seg1addr
7798 @itemx -sectcreate
7799 @itemx -sectobjectsymbols
7800 @itemx -sectorder
7801 @itemx -segaddr
7802 @itemx -segs_read_only_addr
7803 @itemx -segs_read_write_addr
7804 @itemx -seg_addr_table
7805 @itemx -seg_addr_table_filename
7806 @itemx -seglinkedit
7807 @itemx -segprot
7808 @itemx -segs_read_only_addr
7809 @itemx -segs_read_write_addr
7810 @itemx -single_module
7811 @itemx -static
7812 @itemx -sub_library
7813 @itemx -sub_umbrella
7814 @itemx -twolevel_namespace
7815 @itemx -umbrella
7816 @itemx -undefined
7817 @itemx -unexported_symbols_list
7818 @itemx -weak_reference_mismatches
7819 @itemx -whatsloaded
7820
7821 @opindex allowable_client
7822 @opindex client_name
7823 @opindex compatibility_version
7824 @opindex current_version
7825 @opindex dead_strip
7826 @opindex dependency-file
7827 @opindex dylib_file
7828 @opindex dylinker_install_name
7829 @opindex dynamic
7830 @opindex exported_symbols_list
7831 @opindex filelist
7832 @opindex flat_namespace
7833 @opindex force_flat_namespace
7834 @opindex headerpad_max_install_names
7835 @opindex image_base
7836 @opindex init
7837 @opindex install_name
7838 @opindex keep_private_externs
7839 @opindex multi_module
7840 @opindex multiply_defined
7841 @opindex multiply_defined_unused
7842 @opindex noall_load
7843 @opindex no_dead_strip_inits_and_terms
7844 @opindex nofixprebinding
7845 @opindex nomultidefs
7846 @opindex noprebind
7847 @opindex noseglinkedit
7848 @opindex pagezero_size
7849 @opindex prebind
7850 @opindex prebind_all_twolevel_modules
7851 @opindex private_bundle
7852 @opindex read_only_relocs
7853 @opindex sectalign
7854 @opindex sectobjectsymbols
7855 @opindex whyload
7856 @opindex seg1addr
7857 @opindex sectcreate
7858 @opindex sectobjectsymbols
7859 @opindex sectorder
7860 @opindex segaddr
7861 @opindex segs_read_only_addr
7862 @opindex segs_read_write_addr
7863 @opindex seg_addr_table
7864 @opindex seg_addr_table_filename
7865 @opindex seglinkedit
7866 @opindex segprot
7867 @opindex segs_read_only_addr
7868 @opindex segs_read_write_addr
7869 @opindex single_module
7870 @opindex static
7871 @opindex sub_library
7872 @opindex sub_umbrella
7873 @opindex twolevel_namespace
7874 @opindex umbrella
7875 @opindex undefined
7876 @opindex unexported_symbols_list
7877 @opindex weak_reference_mismatches
7878 @opindex whatsloaded
7879
7880 These options are passed to the Darwin linker.  The Darwin linker man page
7881 describes them in detail.
7882 @end table
7883
7884 @node DEC Alpha Options
7885 @subsection DEC Alpha Options
7886
7887 These @samp{-m} options are defined for the DEC Alpha implementations:
7888
7889 @table @gcctabopt
7890 @item -mno-soft-float
7891 @itemx -msoft-float
7892 @opindex mno-soft-float
7893 @opindex msoft-float
7894 Use (do not use) the hardware floating-point instructions for
7895 floating-point operations.  When @option{-msoft-float} is specified,
7896 functions in @file{libgcc.a} will be used to perform floating-point
7897 operations.  Unless they are replaced by routines that emulate the
7898 floating-point operations, or compiled in such a way as to call such
7899 emulations routines, these routines will issue floating-point
7900 operations.   If you are compiling for an Alpha without floating-point
7901 operations, you must ensure that the library is built so as not to call
7902 them.
7903
7904 Note that Alpha implementations without floating-point operations are
7905 required to have floating-point registers.
7906
7907 @item -mfp-reg
7908 @itemx -mno-fp-regs
7909 @opindex mfp-reg
7910 @opindex mno-fp-regs
7911 Generate code that uses (does not use) the floating-point register set.
7912 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7913 register set is not used, floating point operands are passed in integer
7914 registers as if they were integers and floating-point results are passed
7915 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7916 so any function with a floating-point argument or return value called by code
7917 compiled with @option{-mno-fp-regs} must also be compiled with that
7918 option.
7919
7920 A typical use of this option is building a kernel that does not use,
7921 and hence need not save and restore, any floating-point registers.
7922
7923 @item -mieee
7924 @opindex mieee
7925 The Alpha architecture implements floating-point hardware optimized for
7926 maximum performance.  It is mostly compliant with the IEEE floating
7927 point standard.  However, for full compliance, software assistance is
7928 required.  This option generates code fully IEEE compliant code
7929 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7930 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7931 defined during compilation.  The resulting code is less efficient but is
7932 able to correctly support denormalized numbers and exceptional IEEE
7933 values such as not-a-number and plus/minus infinity.  Other Alpha
7934 compilers call this option @option{-ieee_with_no_inexact}.
7935
7936 @item -mieee-with-inexact
7937 @opindex mieee-with-inexact
7938 This is like @option{-mieee} except the generated code also maintains
7939 the IEEE @var{inexact-flag}.  Turning on this option causes the
7940 generated code to implement fully-compliant IEEE math.  In addition to
7941 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7942 macro.  On some Alpha implementations the resulting code may execute
7943 significantly slower than the code generated by default.  Since there is
7944 very little code that depends on the @var{inexact-flag}, you should
7945 normally not specify this option.  Other Alpha compilers call this
7946 option @option{-ieee_with_inexact}.
7947
7948 @item -mfp-trap-mode=@var{trap-mode}
7949 @opindex mfp-trap-mode
7950 This option controls what floating-point related traps are enabled.
7951 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7952 The trap mode can be set to one of four values:
7953
7954 @table @samp
7955 @item n
7956 This is the default (normal) setting.  The only traps that are enabled
7957 are the ones that cannot be disabled in software (e.g., division by zero
7958 trap).
7959
7960 @item u
7961 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7962 as well.
7963
7964 @item su
7965 Like @samp{su}, but the instructions are marked to be safe for software
7966 completion (see Alpha architecture manual for details).
7967
7968 @item sui
7969 Like @samp{su}, but inexact traps are enabled as well.
7970 @end table
7971
7972 @item -mfp-rounding-mode=@var{rounding-mode}
7973 @opindex mfp-rounding-mode
7974 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7975 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7976 of:
7977
7978 @table @samp
7979 @item n
7980 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7981 the nearest machine number or towards the even machine number in case
7982 of a tie.
7983
7984 @item m
7985 Round towards minus infinity.
7986
7987 @item c
7988 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7989
7990 @item d
7991 Dynamic rounding mode.  A field in the floating point control register
7992 (@var{fpcr}, see Alpha architecture reference manual) controls the
7993 rounding mode in effect.  The C library initializes this register for
7994 rounding towards plus infinity.  Thus, unless your program modifies the
7995 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7996 @end table
7997
7998 @item -mtrap-precision=@var{trap-precision}
7999 @opindex mtrap-precision
8000 In the Alpha architecture, floating point traps are imprecise.  This
8001 means without software assistance it is impossible to recover from a
8002 floating trap and program execution normally needs to be terminated.
8003 GCC can generate code that can assist operating system trap handlers
8004 in determining the exact location that caused a floating point trap.
8005 Depending on the requirements of an application, different levels of
8006 precisions can be selected:
8007
8008 @table @samp
8009 @item p
8010 Program precision.  This option is the default and means a trap handler
8011 can only identify which program caused a floating point exception.
8012
8013 @item f
8014 Function precision.  The trap handler can determine the function that
8015 caused a floating point exception.
8016
8017 @item i
8018 Instruction precision.  The trap handler can determine the exact
8019 instruction that caused a floating point exception.
8020 @end table
8021
8022 Other Alpha compilers provide the equivalent options called
8023 @option{-scope_safe} and @option{-resumption_safe}.
8024
8025 @item -mieee-conformant
8026 @opindex mieee-conformant
8027 This option marks the generated code as IEEE conformant.  You must not
8028 use this option unless you also specify @option{-mtrap-precision=i} and either
8029 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8030 is to emit the line @samp{.eflag 48} in the function prologue of the
8031 generated assembly file.  Under DEC Unix, this has the effect that
8032 IEEE-conformant math library routines will be linked in.
8033
8034 @item -mbuild-constants
8035 @opindex mbuild-constants
8036 Normally GCC examines a 32- or 64-bit integer constant to
8037 see if it can construct it from smaller constants in two or three
8038 instructions.  If it cannot, it will output the constant as a literal and
8039 generate code to load it from the data segment at runtime.
8040
8041 Use this option to require GCC to construct @emph{all} integer constants
8042 using code, even if it takes more instructions (the maximum is six).
8043
8044 You would typically use this option to build a shared library dynamic
8045 loader.  Itself a shared library, it must relocate itself in memory
8046 before it can find the variables and constants in its own data segment.
8047
8048 @item -malpha-as
8049 @itemx -mgas
8050 @opindex malpha-as
8051 @opindex mgas
8052 Select whether to generate code to be assembled by the vendor-supplied
8053 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8054
8055 @item -mbwx
8056 @itemx -mno-bwx
8057 @itemx -mcix
8058 @itemx -mno-cix
8059 @itemx -mfix
8060 @itemx -mno-fix
8061 @itemx -mmax
8062 @itemx -mno-max
8063 @opindex mbwx
8064 @opindex mno-bwx
8065 @opindex mcix
8066 @opindex mno-cix
8067 @opindex mfix
8068 @opindex mno-fix
8069 @opindex mmax
8070 @opindex mno-max
8071 Indicate whether GCC should generate code to use the optional BWX,
8072 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8073 sets supported by the CPU type specified via @option{-mcpu=} option or that
8074 of the CPU on which GCC was built if none was specified.
8075
8076 @item -mfloat-vax
8077 @itemx -mfloat-ieee
8078 @opindex mfloat-vax
8079 @opindex mfloat-ieee
8080 Generate code that uses (does not use) VAX F and G floating point
8081 arithmetic instead of IEEE single and double precision.
8082
8083 @item -mexplicit-relocs
8084 @itemx -mno-explicit-relocs
8085 @opindex mexplicit-relocs
8086 @opindex mno-explicit-relocs
8087 Older Alpha assemblers provided no way to generate symbol relocations
8088 except via assembler macros.  Use of these macros does not allow
8089 optimal instruction scheduling.  GNU binutils as of version 2.12
8090 supports a new syntax that allows the compiler to explicitly mark
8091 which relocations should apply to which instructions.  This option
8092 is mostly useful for debugging, as GCC detects the capabilities of
8093 the assembler when it is built and sets the default accordingly.
8094
8095 @item -msmall-data
8096 @itemx -mlarge-data
8097 @opindex msmall-data
8098 @opindex mlarge-data
8099 When @option{-mexplicit-relocs} is in effect, static data is
8100 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8101 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8102 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8103 16-bit relocations off of the @code{$gp} register.  This limits the
8104 size of the small data area to 64KB, but allows the variables to be
8105 directly accessed via a single instruction.
8106
8107 The default is @option{-mlarge-data}.  With this option the data area
8108 is limited to just below 2GB@.  Programs that require more than 2GB of
8109 data must use @code{malloc} or @code{mmap} to allocate the data in the
8110 heap instead of in the program's data segment.
8111
8112 When generating code for shared libraries, @option{-fpic} implies
8113 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8114
8115 @item -msmall-text
8116 @itemx -mlarge-text
8117 @opindex msmall-text
8118 @opindex mlarge-text
8119 When @option{-msmall-text} is used, the compiler assumes that the
8120 code of the entire program (or shared library) fits in 4MB, and is
8121 thus reachable with a branch instruction.  When @option{-msmall-data}
8122 is used, the compiler can assume that all local symbols share the
8123 same @code{$gp} value, and thus reduce the number of instructions
8124 required for a function call from 4 to 1.
8125
8126 The default is @option{-mlarge-text}.
8127
8128 @item -mcpu=@var{cpu_type}
8129 @opindex mcpu
8130 Set the instruction set and instruction scheduling parameters for
8131 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8132 style name or the corresponding chip number.  GCC supports scheduling
8133 parameters for the EV4, EV5 and EV6 family of processors and will
8134 choose the default values for the instruction set from the processor
8135 you specify.  If you do not specify a processor type, GCC will default
8136 to the processor on which the compiler was built.
8137
8138 Supported values for @var{cpu_type} are
8139
8140 @table @samp
8141 @item ev4
8142 @itemx ev45
8143 @itemx 21064
8144 Schedules as an EV4 and has no instruction set extensions.
8145
8146 @item ev5
8147 @itemx 21164
8148 Schedules as an EV5 and has no instruction set extensions.
8149
8150 @item ev56
8151 @itemx 21164a
8152 Schedules as an EV5 and supports the BWX extension.
8153
8154 @item pca56
8155 @itemx 21164pc
8156 @itemx 21164PC
8157 Schedules as an EV5 and supports the BWX and MAX extensions.
8158
8159 @item ev6
8160 @itemx 21264
8161 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8162
8163 @item ev67
8164 @itemx 21264a
8165 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8166 @end table
8167
8168 @item -mtune=@var{cpu_type}
8169 @opindex mtune
8170 Set only the instruction scheduling parameters for machine type
8171 @var{cpu_type}.  The instruction set is not changed.
8172
8173 @item -mmemory-latency=@var{time}
8174 @opindex mmemory-latency
8175 Sets the latency the scheduler should assume for typical memory
8176 references as seen by the application.  This number is highly
8177 dependent on the memory access patterns used by the application
8178 and the size of the external cache on the machine.
8179
8180 Valid options for @var{time} are
8181
8182 @table @samp
8183 @item @var{number}
8184 A decimal number representing clock cycles.
8185
8186 @item L1
8187 @itemx L2
8188 @itemx L3
8189 @itemx main
8190 The compiler contains estimates of the number of clock cycles for
8191 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8192 (also called Dcache, Scache, and Bcache), as well as to main memory.
8193 Note that L3 is only valid for EV5.
8194
8195 @end table
8196 @end table
8197
8198 @node DEC Alpha/VMS Options
8199 @subsection DEC Alpha/VMS Options
8200
8201 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8202
8203 @table @gcctabopt
8204 @item -mvms-return-codes
8205 @opindex mvms-return-codes
8206 Return VMS condition codes from main.  The default is to return POSIX
8207 style condition (e.g.@ error) codes.
8208 @end table
8209
8210 @node FRV Options
8211 @subsection FRV Options
8212 @cindex FRV Options
8213
8214 @table @gcctabopt
8215 @item -mgpr-32
8216 @opindex mgpr-32
8217
8218 Only use the first 32 general purpose registers.
8219
8220 @item -mgpr-64
8221 @opindex mgpr-64
8222
8223 Use all 64 general purpose registers.
8224
8225 @item -mfpr-32
8226 @opindex mfpr-32
8227
8228 Use only the first 32 floating point registers.
8229
8230 @item -mfpr-64
8231 @opindex mfpr-64
8232
8233 Use all 64 floating point registers
8234
8235 @item -mhard-float
8236 @opindex mhard-float
8237
8238 Use hardware instructions for floating point operations.
8239
8240 @item -msoft-float
8241 @opindex msoft-float
8242
8243 Use library routines for floating point operations.
8244
8245 @item -malloc-cc
8246 @opindex malloc-cc
8247
8248 Dynamically allocate condition code registers.
8249
8250 @item -mfixed-cc
8251 @opindex mfixed-cc
8252
8253 Do not try to dynamically allocate condition code registers, only
8254 use @code{icc0} and @code{fcc0}.
8255
8256 @item -mdword
8257 @opindex mdword
8258
8259 Change ABI to use double word insns.
8260
8261 @item -mno-dword
8262 @opindex mno-dword
8263
8264 Do not use double word instructions.
8265
8266 @item -mdouble
8267 @opindex mdouble
8268
8269 Use floating point double instructions.
8270
8271 @item -mno-double
8272 @opindex mno-double
8273
8274 Do not use floating point double instructions.
8275
8276 @item -mmedia
8277 @opindex mmedia
8278
8279 Use media instructions.
8280
8281 @item -mno-media
8282 @opindex mno-media
8283
8284 Do not use media instructions.
8285
8286 @item -mmuladd
8287 @opindex mmuladd
8288
8289 Use multiply and add/subtract instructions.
8290
8291 @item -mno-muladd
8292 @opindex mno-muladd
8293
8294 Do not use multiply and add/subtract instructions.
8295
8296 @item -mfdpic
8297 @opindex mfdpic
8298
8299 Select the FDPIC ABI, that uses function descriptors to represent
8300 pointers to functions.  Without any PIC/PIE-related options, it
8301 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8302 assumes GOT entries and small data are within a 12-bit range from the
8303 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8304 are computed with 32 bits.
8305
8306 @item -minline-plt
8307 @opindex minline-plt
8308
8309 Enable inlining of PLT entries in function calls to functions that are
8310 not known to bind locally.  It has no effect without @option{-mfdpic}.
8311 It's enabled by default if optimizing for speed and compiling for
8312 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8313 optimization option such as @option{-O3} or above is present in the
8314 command line.
8315
8316 @item -mTLS
8317 @opindex TLS
8318
8319 Assume a large TLS segment when generating thread-local code.
8320
8321 @item -mtls
8322 @opindex tls
8323
8324 Do not assume a large TLS segment when generating thread-local code.
8325
8326 @item -mgprel-ro
8327 @opindex mgprel-ro
8328
8329 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8330 that is known to be in read-only sections.  It's enabled by default,
8331 except for @option{-fpic} or @option{-fpie}: even though it may help
8332 make the global offset table smaller, it trades 1 instruction for 4.
8333 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8334 one of which may be shared by multiple symbols, and it avoids the need
8335 for a GOT entry for the referenced symbol, so it's more likely to be a
8336 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8337
8338 @item -multilib-library-pic
8339 @opindex multilib-library-pic
8340
8341 Link with the (library, not FD) pic libraries.  It's implied by
8342 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8343 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8344 it explicitly.
8345
8346 @item -mlinked-fp
8347 @opindex mlinked-fp
8348
8349 Follow the EABI requirement of always creating a frame pointer whenever
8350 a stack frame is allocated.  This option is enabled by default and can
8351 be disabled with @option{-mno-linked-fp}.
8352
8353 @item -mlong-calls
8354 @opindex mlong-calls
8355
8356 Use indirect addressing to call functions outside the current
8357 compilation unit.  This allows the functions to be placed anywhere
8358 within the 32-bit address space.
8359
8360 @item -malign-labels
8361 @opindex malign-labels
8362
8363 Try to align labels to an 8-byte boundary by inserting nops into the
8364 previous packet.  This option only has an effect when VLIW packing
8365 is enabled.  It doesn't create new packets; it merely adds nops to
8366 existing ones.
8367
8368 @item -mlibrary-pic
8369 @opindex mlibrary-pic
8370
8371 Generate position-independent EABI code.
8372
8373 @item -macc-4
8374 @opindex macc-4
8375
8376 Use only the first four media accumulator registers.
8377
8378 @item -macc-8
8379 @opindex macc-8
8380
8381 Use all eight media accumulator registers.
8382
8383 @item -mpack
8384 @opindex mpack
8385
8386 Pack VLIW instructions.
8387
8388 @item -mno-pack
8389 @opindex mno-pack
8390
8391 Do not pack VLIW instructions.
8392
8393 @item -mno-eflags
8394 @opindex mno-eflags
8395
8396 Do not mark ABI switches in e_flags.
8397
8398 @item -mcond-move
8399 @opindex mcond-move
8400
8401 Enable the use of conditional-move instructions (default).
8402
8403 This switch is mainly for debugging the compiler and will likely be removed
8404 in a future version.
8405
8406 @item -mno-cond-move
8407 @opindex mno-cond-move
8408
8409 Disable the use of conditional-move instructions.
8410
8411 This switch is mainly for debugging the compiler and will likely be removed
8412 in a future version.
8413
8414 @item -mscc
8415 @opindex mscc
8416
8417 Enable the use of conditional set instructions (default).
8418
8419 This switch is mainly for debugging the compiler and will likely be removed
8420 in a future version.
8421
8422 @item -mno-scc
8423 @opindex mno-scc
8424
8425 Disable the use of conditional set instructions.
8426
8427 This switch is mainly for debugging the compiler and will likely be removed
8428 in a future version.
8429
8430 @item -mcond-exec
8431 @opindex mcond-exec
8432
8433 Enable the use of conditional execution (default).
8434
8435 This switch is mainly for debugging the compiler and will likely be removed
8436 in a future version.
8437
8438 @item -mno-cond-exec
8439 @opindex mno-cond-exec
8440
8441 Disable the use of conditional execution.
8442
8443 This switch is mainly for debugging the compiler and will likely be removed
8444 in a future version.
8445
8446 @item -mvliw-branch
8447 @opindex mvliw-branch
8448
8449 Run a pass to pack branches into VLIW instructions (default).
8450
8451 This switch is mainly for debugging the compiler and will likely be removed
8452 in a future version.
8453
8454 @item -mno-vliw-branch
8455 @opindex mno-vliw-branch
8456
8457 Do not run a pass to pack branches into VLIW instructions.
8458
8459 This switch is mainly for debugging the compiler and will likely be removed
8460 in a future version.
8461
8462 @item -mmulti-cond-exec
8463 @opindex mmulti-cond-exec
8464
8465 Enable optimization of @code{&&} and @code{||} in conditional execution
8466 (default).
8467
8468 This switch is mainly for debugging the compiler and will likely be removed
8469 in a future version.
8470
8471 @item -mno-multi-cond-exec
8472 @opindex mno-multi-cond-exec
8473
8474 Disable optimization of @code{&&} and @code{||} in conditional execution.
8475
8476 This switch is mainly for debugging the compiler and will likely be removed
8477 in a future version.
8478
8479 @item -mnested-cond-exec
8480 @opindex mnested-cond-exec
8481
8482 Enable nested conditional execution optimizations (default).
8483
8484 This switch is mainly for debugging the compiler and will likely be removed
8485 in a future version.
8486
8487 @item -mno-nested-cond-exec
8488 @opindex mno-nested-cond-exec
8489
8490 Disable nested conditional execution optimizations.
8491
8492 This switch is mainly for debugging the compiler and will likely be removed
8493 in a future version.
8494
8495 @item -mtomcat-stats
8496 @opindex mtomcat-stats
8497
8498 Cause gas to print out tomcat statistics.
8499
8500 @item -mcpu=@var{cpu}
8501 @opindex mcpu
8502
8503 Select the processor type for which to generate code.  Possible values are
8504 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8505 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8506
8507 @end table
8508
8509 @node H8/300 Options
8510 @subsection H8/300 Options
8511
8512 These @samp{-m} options are defined for the H8/300 implementations:
8513
8514 @table @gcctabopt
8515 @item -mrelax
8516 @opindex mrelax
8517 Shorten some address references at link time, when possible; uses the
8518 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8519 ld, Using ld}, for a fuller description.
8520
8521 @item -mh
8522 @opindex mh
8523 Generate code for the H8/300H@.
8524
8525 @item -ms
8526 @opindex ms
8527 Generate code for the H8S@.
8528
8529 @item -mn
8530 @opindex mn
8531 Generate code for the H8S and H8/300H in the normal mode.  This switch
8532 must be used either with @option{-mh} or @option{-ms}.
8533
8534 @item -ms2600
8535 @opindex ms2600
8536 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8537
8538 @item -mint32
8539 @opindex mint32
8540 Make @code{int} data 32 bits by default.
8541
8542 @item -malign-300
8543 @opindex malign-300
8544 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8545 The default for the H8/300H and H8S is to align longs and floats on 4
8546 byte boundaries.
8547 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8548 This option has no effect on the H8/300.
8549 @end table
8550
8551 @node HPPA Options
8552 @subsection HPPA Options
8553 @cindex HPPA Options
8554
8555 These @samp{-m} options are defined for the HPPA family of computers:
8556
8557 @table @gcctabopt
8558 @item -march=@var{architecture-type}
8559 @opindex march
8560 Generate code for the specified architecture.  The choices for
8561 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8562 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8563 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8564 architecture option for your machine.  Code compiled for lower numbered
8565 architectures will run on higher numbered architectures, but not the
8566 other way around.
8567
8568 @item -mpa-risc-1-0
8569 @itemx -mpa-risc-1-1
8570 @itemx -mpa-risc-2-0
8571 @opindex mpa-risc-1-0
8572 @opindex mpa-risc-1-1
8573 @opindex mpa-risc-2-0
8574 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8575
8576 @item -mbig-switch
8577 @opindex mbig-switch
8578 Generate code suitable for big switch tables.  Use this option only if
8579 the assembler/linker complain about out of range branches within a switch
8580 table.
8581
8582 @item -mjump-in-delay
8583 @opindex mjump-in-delay
8584 Fill delay slots of function calls with unconditional jump instructions
8585 by modifying the return pointer for the function call to be the target
8586 of the conditional jump.
8587
8588 @item -mdisable-fpregs
8589 @opindex mdisable-fpregs
8590 Prevent floating point registers from being used in any manner.  This is
8591 necessary for compiling kernels which perform lazy context switching of
8592 floating point registers.  If you use this option and attempt to perform
8593 floating point operations, the compiler will abort.
8594
8595 @item -mdisable-indexing
8596 @opindex mdisable-indexing
8597 Prevent the compiler from using indexing address modes.  This avoids some
8598 rather obscure problems when compiling MIG generated code under MACH@.
8599
8600 @item -mno-space-regs
8601 @opindex mno-space-regs
8602 Generate code that assumes the target has no space registers.  This allows
8603 GCC to generate faster indirect calls and use unscaled index address modes.
8604
8605 Such code is suitable for level 0 PA systems and kernels.
8606
8607 @item -mfast-indirect-calls
8608 @opindex mfast-indirect-calls
8609 Generate code that assumes calls never cross space boundaries.  This
8610 allows GCC to emit code which performs faster indirect calls.
8611
8612 This option will not work in the presence of shared libraries or nested
8613 functions.
8614
8615 @item -mfixed-range=@var{register-range}
8616 @opindex mfixed-range
8617 Generate code treating the given register range as fixed registers.
8618 A fixed register is one that the register allocator can not use.  This is
8619 useful when compiling kernel code.  A register range is specified as
8620 two registers separated by a dash.  Multiple register ranges can be
8621 specified separated by a comma.
8622
8623 @item -mlong-load-store
8624 @opindex mlong-load-store
8625 Generate 3-instruction load and store sequences as sometimes required by
8626 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8627 the HP compilers.
8628
8629 @item -mportable-runtime
8630 @opindex mportable-runtime
8631 Use the portable calling conventions proposed by HP for ELF systems.
8632
8633 @item -mgas
8634 @opindex mgas
8635 Enable the use of assembler directives only GAS understands.
8636
8637 @item -mschedule=@var{cpu-type}
8638 @opindex mschedule
8639 Schedule code according to the constraints for the machine type
8640 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8641 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8642 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8643 proper scheduling option for your machine.  The default scheduling is
8644 @samp{8000}.
8645
8646 @item -mlinker-opt
8647 @opindex mlinker-opt
8648 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8649 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8650 linkers in which they give bogus error messages when linking some programs.
8651
8652 @item -msoft-float
8653 @opindex msoft-float
8654 Generate output containing library calls for floating point.
8655 @strong{Warning:} the requisite libraries are not available for all HPPA
8656 targets.  Normally the facilities of the machine's usual C compiler are
8657 used, but this cannot be done directly in cross-compilation.  You must make
8658 your own arrangements to provide suitable library functions for
8659 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8660 does provide software floating point support.
8661
8662 @option{-msoft-float} changes the calling convention in the output file;
8663 therefore, it is only useful if you compile @emph{all} of a program with
8664 this option.  In particular, you need to compile @file{libgcc.a}, the
8665 library that comes with GCC, with @option{-msoft-float} in order for
8666 this to work.
8667
8668 @item -msio
8669 @opindex msio
8670 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8671 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8672 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8673 options are available under HP-UX and HI-UX@.
8674
8675 @item -mgnu-ld
8676 @opindex gnu-ld
8677 Use GNU ld specific options.  This passes @option{-shared} to ld when
8678 building a shared library.  It is the default when GCC is configured,
8679 explicitly or implicitly, with the GNU linker.  This option does not
8680 have any affect on which ld is called, it only changes what parameters
8681 are passed to that ld.  The ld that is called is determined by the
8682 @option{--with-ld} configure option, GCC's program search path, and
8683 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8684 using @samp{which `gcc -print-prog-name=ld`}.
8685
8686 @item -mhp-ld
8687 @opindex hp-ld
8688 Use HP ld specific options.  This passes @option{-b} to ld when building
8689 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8690 links.  It is the default when GCC is configured, explicitly or
8691 implicitly, with the HP linker.  This option does not have any affect on
8692 which ld is called, it only changes what parameters are passed to that
8693 ld.  The ld that is called is determined by the @option{--with-ld}
8694 configure option, GCC's program search path, and finally by the user's
8695 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8696 `gcc -print-prog-name=ld`}.
8697
8698 @item -mlong-calls
8699 @opindex mno-long-calls
8700 Generate code that uses long call sequences.  This ensures that a call
8701 is always able to reach linker generated stubs.  The default is to generate
8702 long calls only when the distance from the call site to the beginning
8703 of the function or translation unit, as the case may be, exceeds a
8704 predefined limit set by the branch type being used.  The limits for
8705 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8706 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8707 240,000 bytes.
8708
8709 Distances are measured from the beginning of functions when using the
8710 @option{-ffunction-sections} option, or when using the @option{-mgas}
8711 and @option{-mno-portable-runtime} options together under HP-UX with
8712 the SOM linker.
8713
8714 It is normally not desirable to use this option as it will degrade
8715 performance.  However, it may be useful in large applications,
8716 particularly when partial linking is used to build the application.
8717
8718 The types of long calls used depends on the capabilities of the
8719 assembler and linker, and the type of code being generated.  The
8720 impact on systems that support long absolute calls, and long pic
8721 symbol-difference or pc-relative calls should be relatively small.
8722 However, an indirect call is used on 32-bit ELF systems in pic code
8723 and it is quite long.
8724
8725 @item -munix=@var{unix-std}
8726 @opindex march
8727 Generate compiler predefines and select a startfile for the specified
8728 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8729 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8730 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8731 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8732 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8733 and later.
8734
8735 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8736 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8737 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8738 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8739 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8740 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8741
8742 It is @emph{important} to note that this option changes the interfaces
8743 for various library routines.  It also affects the operational behavior
8744 of the C library.  Thus, @emph{extreme} care is needed in using this
8745 option.
8746
8747 Library code that is intended to operate with more than one UNIX
8748 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8749 as appropriate.  Most GNU software doesn't provide this capability.
8750
8751 @item -nolibdld
8752 @opindex nolibdld
8753 Suppress the generation of link options to search libdld.sl when the
8754 @option{-static} option is specified on HP-UX 10 and later.
8755
8756 @item -static
8757 @opindex static
8758 The HP-UX implementation of setlocale in libc has a dependency on
8759 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8760 when the @option{-static} option is specified, special link options
8761 are needed to resolve this dependency.
8762
8763 On HP-UX 10 and later, the GCC driver adds the necessary options to
8764 link with libdld.sl when the @option{-static} option is specified.
8765 This causes the resulting binary to be dynamic.  On the 64-bit port,
8766 the linkers generate dynamic binaries by default in any case.  The
8767 @option{-nolibdld} option can be used to prevent the GCC driver from
8768 adding these link options.
8769
8770 @item -threads
8771 @opindex threads
8772 Add support for multithreading with the @dfn{dce thread} library
8773 under HP-UX@.  This option sets flags for both the preprocessor and
8774 linker.
8775 @end table
8776
8777 @node i386 and x86-64 Options
8778 @subsection Intel 386 and AMD x86-64 Options
8779 @cindex i386 Options
8780 @cindex x86-64 Options
8781 @cindex Intel 386 Options
8782 @cindex AMD x86-64 Options
8783
8784 These @samp{-m} options are defined for the i386 and x86-64 family of
8785 computers:
8786
8787 @table @gcctabopt
8788 @item -mtune=@var{cpu-type}
8789 @opindex mtune
8790 Tune to @var{cpu-type} everything applicable about the generated code, except
8791 for the ABI and the set of available instructions.  The choices for
8792 @var{cpu-type} are:
8793 @table @emph
8794 @item i386
8795 Original Intel's i386 CPU@.
8796 @item i486
8797 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8798 @item i586, pentium
8799 Intel Pentium CPU with no MMX support.
8800 @item pentium-mmx
8801 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8802 @item i686, pentiumpro
8803 Intel PentiumPro CPU@.
8804 @item pentium2
8805 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8806 @item pentium3, pentium3m
8807 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8808 support.
8809 @item pentium-m
8810 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8811 support.  Used by Centrino notebooks.
8812 @item pentium4, pentium4m
8813 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8814 @item prescott
8815 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8816 set support.
8817 @item nocona
8818 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8819 SSE2 and SSE3 instruction set support.
8820 @item k6
8821 AMD K6 CPU with MMX instruction set support.
8822 @item k6-2, k6-3
8823 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8824 @item athlon, athlon-tbird
8825 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8826 support.
8827 @item athlon-4, athlon-xp, athlon-mp
8828 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8829 instruction set support.
8830 @item k8, opteron, athlon64, athlon-fx
8831 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8832 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8833 @item winchip-c6
8834 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8835 set support.
8836 @item winchip2
8837 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8838 instruction set support.
8839 @item c3
8840 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8841 implemented for this chip.)
8842 @item c3-2
8843 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8844 implemented for this chip.)
8845 @end table
8846
8847 While picking a specific @var{cpu-type} will schedule things appropriately
8848 for that particular chip, the compiler will not generate any code that
8849 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8850 being used.
8851
8852 @item -march=@var{cpu-type}
8853 @opindex march
8854 Generate instructions for the machine type @var{cpu-type}.  The choices
8855 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8856 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8857
8858 @item -mcpu=@var{cpu-type}
8859 @opindex mcpu
8860 A deprecated synonym for @option{-mtune}.
8861
8862 @item -m386
8863 @itemx -m486
8864 @itemx -mpentium
8865 @itemx -mpentiumpro
8866 @opindex m386
8867 @opindex m486
8868 @opindex mpentium
8869 @opindex mpentiumpro
8870 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8871 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8872 These synonyms are deprecated.
8873
8874 @item -mfpmath=@var{unit}
8875 @opindex march
8876 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8877 for @var{unit} are:
8878
8879 @table @samp
8880 @item 387
8881 Use the standard 387 floating point coprocessor present majority of chips and
8882 emulated otherwise.  Code compiled with this option will run almost everywhere.
8883 The temporary results are computed in 80bit precision instead of precision
8884 specified by the type resulting in slightly different results compared to most
8885 of other chips.  See @option{-ffloat-store} for more detailed description.
8886
8887 This is the default choice for i386 compiler.
8888
8889 @item sse
8890 Use scalar floating point instructions present in the SSE instruction set.
8891 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8892 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8893 instruction set supports only single precision arithmetics, thus the double and
8894 extended precision arithmetics is still done using 387.  Later version, present
8895 only in Pentium4 and the future AMD x86-64 chips supports double precision
8896 arithmetics too.
8897
8898 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8899 or @option{-msse2} switches to enable SSE extensions and make this option
8900 effective.  For the x86-64 compiler, these extensions are enabled by default.
8901
8902 The resulting code should be considerably faster in the majority of cases and avoid
8903 the numerical instability problems of 387 code, but may break some existing
8904 code that expects temporaries to be 80bit.
8905
8906 This is the default choice for the x86-64 compiler.
8907
8908 @item sse,387
8909 Attempt to utilize both instruction sets at once.  This effectively double the
8910 amount of available registers and on chips with separate execution units for
8911 387 and SSE the execution resources too.  Use this option with care, as it is
8912 still experimental, because the GCC register allocator does not model separate
8913 functional units well resulting in instable performance.
8914 @end table
8915
8916 @item -masm=@var{dialect}
8917 @opindex masm=@var{dialect}
8918 Output asm instructions using selected @var{dialect}.  Supported choices are
8919 @samp{intel} or @samp{att} (the default one).
8920
8921 @item -mieee-fp
8922 @itemx -mno-ieee-fp
8923 @opindex mieee-fp
8924 @opindex mno-ieee-fp
8925 Control whether or not the compiler uses IEEE floating point
8926 comparisons.  These handle correctly the case where the result of a
8927 comparison is unordered.
8928
8929 @item -msoft-float
8930 @opindex msoft-float
8931 Generate output containing library calls for floating point.
8932 @strong{Warning:} the requisite libraries are not part of GCC@.
8933 Normally the facilities of the machine's usual C compiler are used, but
8934 this can't be done directly in cross-compilation.  You must make your
8935 own arrangements to provide suitable library functions for
8936 cross-compilation.
8937
8938 On machines where a function returns floating point results in the 80387
8939 register stack, some floating point opcodes may be emitted even if
8940 @option{-msoft-float} is used.
8941
8942 @item -mno-fp-ret-in-387
8943 @opindex mno-fp-ret-in-387
8944 Do not use the FPU registers for return values of functions.
8945
8946 The usual calling convention has functions return values of types
8947 @code{float} and @code{double} in an FPU register, even if there
8948 is no FPU@.  The idea is that the operating system should emulate
8949 an FPU@.
8950
8951 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8952 in ordinary CPU registers instead.
8953
8954 @item -mno-fancy-math-387
8955 @opindex mno-fancy-math-387
8956 Some 387 emulators do not support the @code{sin}, @code{cos} and
8957 @code{sqrt} instructions for the 387.  Specify this option to avoid
8958 generating those instructions.  This option is the default on FreeBSD,
8959 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8960 indicates that the target cpu will always have an FPU and so the
8961 instruction will not need emulation.  As of revision 2.6.1, these
8962 instructions are not generated unless you also use the
8963 @option{-funsafe-math-optimizations} switch.
8964
8965 @item -malign-double
8966 @itemx -mno-align-double
8967 @opindex malign-double
8968 @opindex mno-align-double
8969 Control whether GCC aligns @code{double}, @code{long double}, and
8970 @code{long long} variables on a two word boundary or a one word
8971 boundary.  Aligning @code{double} variables on a two word boundary will
8972 produce code that runs somewhat faster on a @samp{Pentium} at the
8973 expense of more memory.
8974
8975 @strong{Warning:} if you use the @option{-malign-double} switch,
8976 structures containing the above types will be aligned differently than
8977 the published application binary interface specifications for the 386
8978 and will not be binary compatible with structures in code compiled
8979 without that switch.
8980
8981 @item -m96bit-long-double
8982 @itemx -m128bit-long-double
8983 @opindex m96bit-long-double
8984 @opindex m128bit-long-double
8985 These switches control the size of @code{long double} type.  The i386
8986 application binary interface specifies the size to be 96 bits,
8987 so @option{-m96bit-long-double} is the default in 32 bit mode.
8988
8989 Modern architectures (Pentium and newer) would prefer @code{long double}
8990 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8991 conforming to the ABI, this would not be possible.  So specifying a
8992 @option{-m128bit-long-double} will align @code{long double}
8993 to a 16 byte boundary by padding the @code{long double} with an additional
8994 32 bit zero.
8995
8996 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8997 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8998
8999 Notice that neither of these options enable any extra precision over the x87
9000 standard of 80 bits for a @code{long double}.
9001
9002 @strong{Warning:} if you override the default value for your target ABI, the
9003 structures and arrays containing @code{long double} variables will change
9004 their size as well as function calling convention for function taking
9005 @code{long double} will be modified.  Hence they will not be binary
9006 compatible with arrays or structures in code compiled without that switch.
9007
9008
9009 @item -msvr3-shlib
9010 @itemx -mno-svr3-shlib
9011 @opindex msvr3-shlib
9012 @opindex mno-svr3-shlib
9013 Control whether GCC places uninitialized local variables into the
9014 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9015 into @code{bss}.  These options are meaningful only on System V Release 3.
9016
9017 @item -mrtd
9018 @opindex mrtd
9019 Use a different function-calling convention, in which functions that
9020 take a fixed number of arguments return with the @code{ret} @var{num}
9021 instruction, which pops their arguments while returning.  This saves one
9022 instruction in the caller since there is no need to pop the arguments
9023 there.
9024
9025 You can specify that an individual function is called with this calling
9026 sequence with the function attribute @samp{stdcall}.  You can also
9027 override the @option{-mrtd} option by using the function attribute
9028 @samp{cdecl}.  @xref{Function Attributes}.
9029
9030 @strong{Warning:} this calling convention is incompatible with the one
9031 normally used on Unix, so you cannot use it if you need to call
9032 libraries compiled with the Unix compiler.
9033
9034 Also, you must provide function prototypes for all functions that
9035 take variable numbers of arguments (including @code{printf});
9036 otherwise incorrect code will be generated for calls to those
9037 functions.
9038
9039 In addition, seriously incorrect code will result if you call a
9040 function with too many arguments.  (Normally, extra arguments are
9041 harmlessly ignored.)
9042
9043 @item -mregparm=@var{num}
9044 @opindex mregparm
9045 Control how many registers are used to pass integer arguments.  By
9046 default, no registers are used to pass arguments, and at most 3
9047 registers can be used.  You can control this behavior for a specific
9048 function by using the function attribute @samp{regparm}.
9049 @xref{Function Attributes}.
9050
9051 @strong{Warning:} if you use this switch, and
9052 @var{num} is nonzero, then you must build all modules with the same
9053 value, including any libraries.  This includes the system libraries and
9054 startup modules.
9055
9056 @item -msseregparm
9057 @opindex msseregparm
9058 Use SSE register passing conventions for float and double arguments
9059 and return values.  You can control this behavior for a specific
9060 function by using the function attribute @samp{sseregparm}.
9061 @xref{Function Attributes}.
9062
9063 @strong{Warning:} if you use this switch then you must build all
9064 modules with the same value, including any libraries.  This includes
9065 the system libraries and startup modules.
9066
9067 @item -mpreferred-stack-boundary=@var{num}
9068 @opindex mpreferred-stack-boundary
9069 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9070 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9071 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9072 size (@option{-Os}), in which case the default is the minimum correct
9073 alignment (4 bytes for x86, and 8 bytes for x86-64).
9074
9075 On Pentium and PentiumPro, @code{double} and @code{long double} values
9076 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9077 suffer significant run time performance penalties.  On Pentium III, the
9078 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9079 penalties if it is not 16 byte aligned.
9080
9081 To ensure proper alignment of this values on the stack, the stack boundary
9082 must be as aligned as that required by any value stored on the stack.
9083 Further, every function must be generated such that it keeps the stack
9084 aligned.  Thus calling a function compiled with a higher preferred
9085 stack boundary from a function compiled with a lower preferred stack
9086 boundary will most likely misalign the stack.  It is recommended that
9087 libraries that use callbacks always use the default setting.
9088
9089 This extra alignment does consume extra stack space, and generally
9090 increases code size.  Code that is sensitive to stack space usage, such
9091 as embedded systems and operating system kernels, may want to reduce the
9092 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9093
9094 @item -mmmx
9095 @itemx -mno-mmx
9096 @item -msse
9097 @itemx -mno-sse
9098 @item -msse2
9099 @itemx -mno-sse2
9100 @item -msse3
9101 @itemx -mno-sse3
9102 @item -m3dnow
9103 @itemx -mno-3dnow
9104 @opindex mmmx
9105 @opindex mno-mmx
9106 @opindex msse
9107 @opindex mno-sse
9108 @opindex m3dnow
9109 @opindex mno-3dnow
9110 These switches enable or disable the use of built-in functions that allow
9111 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9112 instruction set.
9113
9114 @xref{X86 Built-in Functions}, for details of the functions enabled
9115 and disabled by these switches.
9116
9117 To have SSE/SSE2 instructions generated automatically from floating-point
9118 code, see @option{-mfpmath=sse}.
9119
9120 @item -mpush-args
9121 @itemx -mno-push-args
9122 @opindex mpush-args
9123 @opindex mno-push-args
9124 Use PUSH operations to store outgoing parameters.  This method is shorter
9125 and usually equally fast as method using SUB/MOV operations and is enabled
9126 by default.  In some cases disabling it may improve performance because of
9127 improved scheduling and reduced dependencies.
9128
9129 @item -maccumulate-outgoing-args
9130 @opindex maccumulate-outgoing-args
9131 If enabled, the maximum amount of space required for outgoing arguments will be
9132 computed in the function prologue.  This is faster on most modern CPUs
9133 because of reduced dependencies, improved scheduling and reduced stack usage
9134 when preferred stack boundary is not equal to 2.  The drawback is a notable
9135 increase in code size.  This switch implies @option{-mno-push-args}.
9136
9137 @item -mthreads
9138 @opindex mthreads
9139 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9140 on thread-safe exception handling must compile and link all code with the
9141 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9142 @option{-D_MT}; when linking, it links in a special thread helper library
9143 @option{-lmingwthrd} which cleans up per thread exception handling data.
9144
9145 @item -mno-align-stringops
9146 @opindex mno-align-stringops
9147 Do not align destination of inlined string operations.  This switch reduces
9148 code size and improves performance in case the destination is already aligned,
9149 but GCC doesn't know about it.
9150
9151 @item -minline-all-stringops
9152 @opindex minline-all-stringops
9153 By default GCC inlines string operations only when destination is known to be
9154 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9155 size, but may improve performance of code that depends on fast memcpy, strlen
9156 and memset for short lengths.
9157
9158 @item -momit-leaf-frame-pointer
9159 @opindex momit-leaf-frame-pointer
9160 Don't keep the frame pointer in a register for leaf functions.  This
9161 avoids the instructions to save, set up and restore frame pointers and
9162 makes an extra register available in leaf functions.  The option
9163 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9164 which might make debugging harder.
9165
9166 @item -mtls-direct-seg-refs
9167 @itemx -mno-tls-direct-seg-refs
9168 @opindex mtls-direct-seg-refs
9169 Controls whether TLS variables may be accessed with offsets from the
9170 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9171 or whether the thread base pointer must be added.  Whether or not this
9172 is legal depends on the operating system, and whether it maps the
9173 segment to cover the entire TLS area.
9174
9175 For systems that use GNU libc, the default is on.
9176 @end table
9177
9178 These @samp{-m} switches are supported in addition to the above
9179 on AMD x86-64 processors in 64-bit environments.
9180
9181 @table @gcctabopt
9182 @item -m32
9183 @itemx -m64
9184 @opindex m32
9185 @opindex m64
9186 Generate code for a 32-bit or 64-bit environment.
9187 The 32-bit environment sets int, long and pointer to 32 bits and
9188 generates code that runs on any i386 system.
9189 The 64-bit environment sets int to 32 bits and long and pointer
9190 to 64 bits and generates code for AMD's x86-64 architecture.
9191
9192 @item -mno-red-zone
9193 @opindex no-red-zone
9194 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9195 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9196 stack pointer that will not be modified by signal or interrupt handlers
9197 and therefore can be used for temporary data without adjusting the stack
9198 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9199
9200 @item -mcmodel=small
9201 @opindex mcmodel=small
9202 Generate code for the small code model: the program and its symbols must
9203 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9204 Programs can be statically or dynamically linked.  This is the default
9205 code model.
9206
9207 @item -mcmodel=kernel
9208 @opindex mcmodel=kernel
9209 Generate code for the kernel code model.  The kernel runs in the
9210 negative 2 GB of the address space.
9211 This model has to be used for Linux kernel code.
9212
9213 @item -mcmodel=medium
9214 @opindex mcmodel=medium
9215 Generate code for the medium model: The program is linked in the lower 2
9216 GB of the address space but symbols can be located anywhere in the
9217 address space.  Programs can be statically or dynamically linked, but
9218 building of shared libraries are not supported with the medium model.
9219
9220 @item -mcmodel=large
9221 @opindex mcmodel=large
9222 Generate code for the large model: This model makes no assumptions
9223 about addresses and sizes of sections.  Currently GCC does not implement
9224 this model.
9225 @end table
9226
9227 @node IA-64 Options
9228 @subsection IA-64 Options
9229 @cindex IA-64 Options
9230
9231 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9232
9233 @table @gcctabopt
9234 @item -mbig-endian
9235 @opindex mbig-endian
9236 Generate code for a big endian target.  This is the default for HP-UX@.
9237
9238 @item -mlittle-endian
9239 @opindex mlittle-endian
9240 Generate code for a little endian target.  This is the default for AIX5
9241 and GNU/Linux.
9242
9243 @item -mgnu-as
9244 @itemx -mno-gnu-as
9245 @opindex mgnu-as
9246 @opindex mno-gnu-as
9247 Generate (or don't) code for the GNU assembler.  This is the default.
9248 @c Also, this is the default if the configure option @option{--with-gnu-as}
9249 @c is used.
9250
9251 @item -mgnu-ld
9252 @itemx -mno-gnu-ld
9253 @opindex mgnu-ld
9254 @opindex mno-gnu-ld
9255 Generate (or don't) code for the GNU linker.  This is the default.
9256 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9257 @c is used.
9258
9259 @item -mno-pic
9260 @opindex mno-pic
9261 Generate code that does not use a global pointer register.  The result
9262 is not position independent code, and violates the IA-64 ABI@.
9263
9264 @item -mvolatile-asm-stop
9265 @itemx -mno-volatile-asm-stop
9266 @opindex mvolatile-asm-stop
9267 @opindex mno-volatile-asm-stop
9268 Generate (or don't) a stop bit immediately before and after volatile asm
9269 statements.
9270
9271 @item -mregister-names
9272 @itemx -mno-register-names
9273 @opindex mregister-names
9274 @opindex mno-register-names
9275 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9276 the stacked registers.  This may make assembler output more readable.
9277
9278 @item -mno-sdata
9279 @itemx -msdata
9280 @opindex mno-sdata
9281 @opindex msdata
9282 Disable (or enable) optimizations that use the small data section.  This may
9283 be useful for working around optimizer bugs.
9284
9285 @item -mconstant-gp
9286 @opindex mconstant-gp
9287 Generate code that uses a single constant global pointer value.  This is
9288 useful when compiling kernel code.
9289
9290 @item -mauto-pic
9291 @opindex mauto-pic
9292 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9293 This is useful when compiling firmware code.
9294
9295 @item -minline-float-divide-min-latency
9296 @opindex minline-float-divide-min-latency
9297 Generate code for inline divides of floating point values
9298 using the minimum latency algorithm.
9299
9300 @item -minline-float-divide-max-throughput
9301 @opindex minline-float-divide-max-throughput
9302 Generate code for inline divides of floating point values
9303 using the maximum throughput algorithm.
9304
9305 @item -minline-int-divide-min-latency
9306 @opindex minline-int-divide-min-latency
9307 Generate code for inline divides of integer values
9308 using the minimum latency algorithm.
9309
9310 @item -minline-int-divide-max-throughput
9311 @opindex minline-int-divide-max-throughput
9312 Generate code for inline divides of integer values
9313 using the maximum throughput algorithm.
9314
9315 @item -minline-sqrt-min-latency
9316 @opindex minline-sqrt-min-latency
9317 Generate code for inline square roots
9318 using the minimum latency algorithm.
9319
9320 @item -minline-sqrt-max-throughput
9321 @opindex minline-sqrt-max-throughput
9322 Generate code for inline square roots
9323 using the maximum throughput algorithm.
9324
9325 @item -mno-dwarf2-asm
9326 @itemx -mdwarf2-asm
9327 @opindex mno-dwarf2-asm
9328 @opindex mdwarf2-asm
9329 Don't (or do) generate assembler code for the DWARF2 line number debugging
9330 info.  This may be useful when not using the GNU assembler.
9331
9332 @item -mearly-stop-bits
9333 @itemx -mno-early-stop-bits
9334 @opindex mearly-stop-bits
9335 @opindex mno-early-stop-bits
9336 Allow stop bits to be placed earlier than immediately preceding the
9337 instruction that triggered the stop bit.  This can improve instruction
9338 scheduling, but does not always do so.
9339
9340 @item -mfixed-range=@var{register-range}
9341 @opindex mfixed-range
9342 Generate code treating the given register range as fixed registers.
9343 A fixed register is one that the register allocator can not use.  This is
9344 useful when compiling kernel code.  A register range is specified as
9345 two registers separated by a dash.  Multiple register ranges can be
9346 specified separated by a comma.
9347
9348 @item -mtls-size=@var{tls-size}
9349 @opindex mtls-size
9350 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9351 64.
9352
9353 @item -mtune-arch=@var{cpu-type}
9354 @opindex mtune-arch
9355 Tune the instruction scheduling for a particular CPU, Valid values are
9356 itanium, itanium1, merced, itanium2, and mckinley.
9357
9358 @item -mt
9359 @itemx -pthread
9360 @opindex mt
9361 @opindex pthread
9362 Add support for multithreading using the POSIX threads library.  This
9363 option sets flags for both the preprocessor and linker.  It does
9364 not affect the thread safety of object code produced by the compiler or
9365 that of libraries supplied with it.  These are HP-UX specific flags.
9366
9367 @item -milp32
9368 @itemx -mlp64
9369 @opindex milp32
9370 @opindex mlp64
9371 Generate code for a 32-bit or 64-bit environment.
9372 The 32-bit environment sets int, long and pointer to 32 bits.
9373 The 64-bit environment sets int to 32 bits and long and pointer
9374 to 64 bits.  These are HP-UX specific flags.
9375
9376 @end table
9377
9378 @node M32C Options
9379 @subsection M32C Options
9380 @cindex M32C options
9381
9382 @table @gcctabopt
9383 @item -mcpu=@var{name}
9384 @opindex mcpu=
9385 Select the CPU for which code is generated.  @var{name} may be one of
9386 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9387 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9388 the M32C/80 series.
9389
9390 @item -msim
9391 @opindex msim
9392 Specifies that the program will be run on the simulator.  This causes
9393 an alternate runtime library to be linked in which supports, for
9394 example, file I/O.  You must not use this option when generating
9395 programs that will run on real hardware; you must provide your own
9396 runtime library for whatever I/O functions are needed.
9397
9398 @item -memregs=@var{number}
9399 @opindex memregs=
9400 Specifies the number of memory-based pseudo-registers GCC will use
9401 during code generation.  These pseudo-registers will be used like real
9402 registers, so there is a tradeoff between GCC's ability to fit the
9403 code into available registers, and the performance penalty of using
9404 memory instead of registers.  Note that all modules in a program must
9405 be compiled with the same value for this option.  Because of that, you
9406 must not use this option with the default runtime libraries gcc
9407 builds.
9408
9409 @end table
9410
9411 @node M32R/D Options
9412 @subsection M32R/D Options
9413 @cindex M32R/D options
9414
9415 These @option{-m} options are defined for Renesas M32R/D architectures:
9416
9417 @table @gcctabopt
9418 @item -m32r2
9419 @opindex m32r2
9420 Generate code for the M32R/2@.
9421
9422 @item -m32rx
9423 @opindex m32rx
9424 Generate code for the M32R/X@.
9425
9426 @item -m32r
9427 @opindex m32r
9428 Generate code for the M32R@.  This is the default.
9429
9430 @item -mmodel=small
9431 @opindex mmodel=small
9432 Assume all objects live in the lower 16MB of memory (so that their addresses
9433 can be loaded with the @code{ld24} instruction), and assume all subroutines
9434 are reachable with the @code{bl} instruction.
9435 This is the default.
9436
9437 The addressability of a particular object can be set with the
9438 @code{model} attribute.
9439
9440 @item -mmodel=medium
9441 @opindex mmodel=medium
9442 Assume objects may be anywhere in the 32-bit address space (the compiler
9443 will generate @code{seth/add3} instructions to load their addresses), and
9444 assume all subroutines are reachable with the @code{bl} instruction.
9445
9446 @item -mmodel=large
9447 @opindex mmodel=large
9448 Assume objects may be anywhere in the 32-bit address space (the compiler
9449 will generate @code{seth/add3} instructions to load their addresses), and
9450 assume subroutines may not be reachable with the @code{bl} instruction
9451 (the compiler will generate the much slower @code{seth/add3/jl}
9452 instruction sequence).
9453
9454 @item -msdata=none
9455 @opindex msdata=none
9456 Disable use of the small data area.  Variables will be put into
9457 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9458 @code{section} attribute has been specified).
9459 This is the default.
9460
9461 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9462 Objects may be explicitly put in the small data area with the
9463 @code{section} attribute using one of these sections.
9464
9465 @item -msdata=sdata
9466 @opindex msdata=sdata
9467 Put small global and static data in the small data area, but do not
9468 generate special code to reference them.
9469
9470 @item -msdata=use
9471 @opindex msdata=use
9472 Put small global and static data in the small data area, and generate
9473 special instructions to reference them.
9474
9475 @item -G @var{num}
9476 @opindex G
9477 @cindex smaller data references
9478 Put global and static objects less than or equal to @var{num} bytes
9479 into the small data or bss sections instead of the normal data or bss
9480 sections.  The default value of @var{num} is 8.
9481 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9482 for this option to have any effect.
9483
9484 All modules should be compiled with the same @option{-G @var{num}} value.
9485 Compiling with different values of @var{num} may or may not work; if it
9486 doesn't the linker will give an error message---incorrect code will not be
9487 generated.
9488
9489 @item -mdebug
9490 @opindex mdebug
9491 Makes the M32R specific code in the compiler display some statistics
9492 that might help in debugging programs.
9493
9494 @item -malign-loops
9495 @opindex malign-loops
9496 Align all loops to a 32-byte boundary.
9497
9498 @item -mno-align-loops
9499 @opindex mno-align-loops
9500 Do not enforce a 32-byte alignment for loops.  This is the default.
9501
9502 @item -missue-rate=@var{number}
9503 @opindex missue-rate=@var{number}
9504 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9505 or 2.
9506
9507 @item -mbranch-cost=@var{number}
9508 @opindex mbranch-cost=@var{number}
9509 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9510 preferred over conditional code, if it is 2, then the opposite will
9511 apply.
9512
9513 @item -mflush-trap=@var{number}
9514 @opindex mflush-trap=@var{number}
9515 Specifies the trap number to use to flush the cache.  The default is
9516 12.  Valid numbers are between 0 and 15 inclusive.
9517
9518 @item -mno-flush-trap
9519 @opindex mno-flush-trap
9520 Specifies that the cache cannot be flushed by using a trap.
9521
9522 @item -mflush-func=@var{name}
9523 @opindex mflush-func=@var{name}
9524 Specifies the name of the operating system function to call to flush
9525 the cache.  The default is @emph{_flush_cache}, but a function call
9526 will only be used if a trap is not available.
9527
9528 @item -mno-flush-func
9529 @opindex mno-flush-func
9530 Indicates that there is no OS function for flushing the cache.
9531
9532 @end table
9533
9534 @node M680x0 Options
9535 @subsection M680x0 Options
9536 @cindex M680x0 options
9537
9538 These are the @samp{-m} options defined for the 68000 series.  The default
9539 values for these options depends on which style of 68000 was selected when
9540 the compiler was configured; the defaults for the most common choices are
9541 given below.
9542
9543 @table @gcctabopt
9544 @item -m68000
9545 @itemx -mc68000
9546 @opindex m68000
9547 @opindex mc68000
9548 Generate output for a 68000.  This is the default
9549 when the compiler is configured for 68000-based systems.
9550
9551 Use this option for microcontrollers with a 68000 or EC000 core,
9552 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9553
9554 @item -m68020
9555 @itemx -mc68020
9556 @opindex m68020
9557 @opindex mc68020
9558 Generate output for a 68020.  This is the default
9559 when the compiler is configured for 68020-based systems.
9560
9561 @item -m68881
9562 @opindex m68881
9563 Generate output containing 68881 instructions for floating point.
9564 This is the default for most 68020 systems unless @option{--nfp} was
9565 specified when the compiler was configured.
9566
9567 @item -m68030
9568 @opindex m68030
9569 Generate output for a 68030.  This is the default when the compiler is
9570 configured for 68030-based systems.
9571
9572 @item -m68040
9573 @opindex m68040
9574 Generate output for a 68040.  This is the default when the compiler is
9575 configured for 68040-based systems.
9576
9577 This option inhibits the use of 68881/68882 instructions that have to be
9578 emulated by software on the 68040.  Use this option if your 68040 does not
9579 have code to emulate those instructions.
9580
9581 @item -m68060
9582 @opindex m68060
9583 Generate output for a 68060.  This is the default when the compiler is
9584 configured for 68060-based systems.
9585
9586 This option inhibits the use of 68020 and 68881/68882 instructions that
9587 have to be emulated by software on the 68060.  Use this option if your 68060
9588 does not have code to emulate those instructions.
9589
9590 @item -mcpu32
9591 @opindex mcpu32
9592 Generate output for a CPU32.  This is the default
9593 when the compiler is configured for CPU32-based systems.
9594
9595 Use this option for microcontrollers with a
9596 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9597 68336, 68340, 68341, 68349 and 68360.
9598
9599 @item -m5200
9600 @opindex m5200
9601 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9602 when the compiler is configured for 520X-based systems.
9603
9604 Use this option for microcontroller with a 5200 core, including
9605 the MCF5202, MCF5203, MCF5204 and MCF5202.
9606
9607
9608 @item -m68020-40
9609 @opindex m68020-40
9610 Generate output for a 68040, without using any of the new instructions.
9611 This results in code which can run relatively efficiently on either a
9612 68020/68881 or a 68030 or a 68040.  The generated code does use the
9613 68881 instructions that are emulated on the 68040.
9614
9615 @item -m68020-60
9616 @opindex m68020-60
9617 Generate output for a 68060, without using any of the new instructions.
9618 This results in code which can run relatively efficiently on either a
9619 68020/68881 or a 68030 or a 68040.  The generated code does use the
9620 68881 instructions that are emulated on the 68060.
9621
9622 @item -msoft-float
9623 @opindex msoft-float
9624 Generate output containing library calls for floating point.
9625 @strong{Warning:} the requisite libraries are not available for all m68k
9626 targets.  Normally the facilities of the machine's usual C compiler are
9627 used, but this can't be done directly in cross-compilation.  You must
9628 make your own arrangements to provide suitable library functions for
9629 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9630 @samp{m68k-*-coff} do provide software floating point support.
9631
9632 @item -mshort
9633 @opindex mshort
9634 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9635 Additionally, parameters passed on the stack are also aligned to a
9636 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9637
9638 @item -mnobitfield
9639 @opindex mnobitfield
9640 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9641 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9642
9643 @item -mbitfield
9644 @opindex mbitfield
9645 Do use the bit-field instructions.  The @option{-m68020} option implies
9646 @option{-mbitfield}.  This is the default if you use a configuration
9647 designed for a 68020.
9648
9649 @item -mrtd
9650 @opindex mrtd
9651 Use a different function-calling convention, in which functions
9652 that take a fixed number of arguments return with the @code{rtd}
9653 instruction, which pops their arguments while returning.  This
9654 saves one instruction in the caller since there is no need to pop
9655 the arguments there.
9656
9657 This calling convention is incompatible with the one normally
9658 used on Unix, so you cannot use it if you need to call libraries
9659 compiled with the Unix compiler.
9660
9661 Also, you must provide function prototypes for all functions that
9662 take variable numbers of arguments (including @code{printf});
9663 otherwise incorrect code will be generated for calls to those
9664 functions.
9665
9666 In addition, seriously incorrect code will result if you call a
9667 function with too many arguments.  (Normally, extra arguments are
9668 harmlessly ignored.)
9669
9670 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9671 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9672
9673 @item -malign-int
9674 @itemx -mno-align-int
9675 @opindex malign-int
9676 @opindex mno-align-int
9677 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9678 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9679 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9680 Aligning variables on 32-bit boundaries produces code that runs somewhat
9681 faster on processors with 32-bit busses at the expense of more memory.
9682
9683 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9684 align structures containing the above types  differently than
9685 most published application binary interface specifications for the m68k.
9686
9687 @item -mpcrel
9688 @opindex mpcrel
9689 Use the pc-relative addressing mode of the 68000 directly, instead of
9690 using a global offset table.  At present, this option implies @option{-fpic},
9691 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9692 not presently supported with @option{-mpcrel}, though this could be supported for
9693 68020 and higher processors.
9694
9695 @item -mno-strict-align
9696 @itemx -mstrict-align
9697 @opindex mno-strict-align
9698 @opindex mstrict-align
9699 Do not (do) assume that unaligned memory references will be handled by
9700 the system.
9701
9702 @item -msep-data
9703 Generate code that allows the data segment to be located in a different
9704 area of memory from the text segment.  This allows for execute in place in
9705 an environment without virtual memory management.  This option implies
9706 @option{-fPIC}.
9707
9708 @item -mno-sep-data
9709 Generate code that assumes that the data segment follows the text segment.
9710 This is the default.
9711
9712 @item -mid-shared-library
9713 Generate code that supports shared libraries via the library ID method.
9714 This allows for execute in place and shared libraries in an environment
9715 without virtual memory management.  This option implies @option{-fPIC}.
9716
9717 @item -mno-id-shared-library
9718 Generate code that doesn't assume ID based shared libraries are being used.
9719 This is the default.
9720
9721 @item -mshared-library-id=n
9722 Specified the identification number of the ID based shared library being
9723 compiled.  Specifying a value of 0 will generate more compact code, specifying
9724 other values will force the allocation of that number to the current
9725 library but is no more space or time efficient than omitting this option.
9726
9727 @end table
9728
9729 @node M68hc1x Options
9730 @subsection M68hc1x Options
9731 @cindex M68hc1x options
9732
9733 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9734 microcontrollers.  The default values for these options depends on
9735 which style of microcontroller was selected when the compiler was configured;
9736 the defaults for the most common choices are given below.
9737
9738 @table @gcctabopt
9739 @item -m6811
9740 @itemx -m68hc11
9741 @opindex m6811
9742 @opindex m68hc11
9743 Generate output for a 68HC11.  This is the default
9744 when the compiler is configured for 68HC11-based systems.
9745
9746 @item -m6812
9747 @itemx -m68hc12
9748 @opindex m6812
9749 @opindex m68hc12
9750 Generate output for a 68HC12.  This is the default
9751 when the compiler is configured for 68HC12-based systems.
9752
9753 @item -m68S12
9754 @itemx -m68hcs12
9755 @opindex m68S12
9756 @opindex m68hcs12
9757 Generate output for a 68HCS12.
9758
9759 @item -mauto-incdec
9760 @opindex mauto-incdec
9761 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9762 addressing modes.
9763
9764 @item -minmax
9765 @itemx -nominmax
9766 @opindex minmax
9767 @opindex mnominmax
9768 Enable the use of 68HC12 min and max instructions.
9769
9770 @item -mlong-calls
9771 @itemx -mno-long-calls
9772 @opindex mlong-calls
9773 @opindex mno-long-calls
9774 Treat all calls as being far away (near).  If calls are assumed to be
9775 far away, the compiler will use the @code{call} instruction to
9776 call a function and the @code{rtc} instruction for returning.
9777
9778 @item -mshort
9779 @opindex mshort
9780 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9781
9782 @item -msoft-reg-count=@var{count}
9783 @opindex msoft-reg-count
9784 Specify the number of pseudo-soft registers which are used for the
9785 code generation.  The maximum number is 32.  Using more pseudo-soft
9786 register may or may not result in better code depending on the program.
9787 The default is 4 for 68HC11 and 2 for 68HC12.
9788
9789 @end table
9790
9791 @node MCore Options
9792 @subsection MCore Options
9793 @cindex MCore options
9794
9795 These are the @samp{-m} options defined for the Motorola M*Core
9796 processors.
9797
9798 @table @gcctabopt
9799
9800 @item -mhardlit
9801 @itemx -mno-hardlit
9802 @opindex mhardlit
9803 @opindex mno-hardlit
9804 Inline constants into the code stream if it can be done in two
9805 instructions or less.
9806
9807 @item -mdiv
9808 @itemx -mno-div
9809 @opindex mdiv
9810 @opindex mno-div
9811 Use the divide instruction.  (Enabled by default).
9812
9813 @item -mrelax-immediate
9814 @itemx -mno-relax-immediate
9815 @opindex mrelax-immediate
9816 @opindex mno-relax-immediate
9817 Allow arbitrary sized immediates in bit operations.
9818
9819 @item -mwide-bitfields
9820 @itemx -mno-wide-bitfields
9821 @opindex mwide-bitfields
9822 @opindex mno-wide-bitfields
9823 Always treat bit-fields as int-sized.
9824
9825 @item -m4byte-functions
9826 @itemx -mno-4byte-functions
9827 @opindex m4byte-functions
9828 @opindex mno-4byte-functions
9829 Force all functions to be aligned to a four byte boundary.
9830
9831 @item -mcallgraph-data
9832 @itemx -mno-callgraph-data
9833 @opindex mcallgraph-data
9834 @opindex mno-callgraph-data
9835 Emit callgraph information.
9836
9837 @item -mslow-bytes
9838 @itemx -mno-slow-bytes
9839 @opindex mslow-bytes
9840 @opindex mno-slow-bytes
9841 Prefer word access when reading byte quantities.
9842
9843 @item -mlittle-endian
9844 @itemx -mbig-endian
9845 @opindex mlittle-endian
9846 @opindex mbig-endian
9847 Generate code for a little endian target.
9848
9849 @item -m210
9850 @itemx -m340
9851 @opindex m210
9852 @opindex m340
9853 Generate code for the 210 processor.
9854 @end table
9855
9856 @node MIPS Options
9857 @subsection MIPS Options
9858 @cindex MIPS options
9859
9860 @table @gcctabopt
9861
9862 @item -EB
9863 @opindex EB
9864 Generate big-endian code.
9865
9866 @item -EL
9867 @opindex EL
9868 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9869 configurations.
9870
9871 @item -march=@var{arch}
9872 @opindex march
9873 Generate code that will run on @var{arch}, which can be the name of a
9874 generic MIPS ISA, or the name of a particular processor.
9875 The ISA names are:
9876 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9877 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9878 The processor names are:
9879 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9880 @samp{m4k},
9881 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9882 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9883 @samp{rm9000},
9884 @samp{orion},
9885 @samp{sb1},
9886 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9887 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9888 The special value @samp{from-abi} selects the
9889 most compatible architecture for the selected ABI (that is,
9890 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9891
9892 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9893 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9894 @samp{vr} may be written @samp{r}.
9895
9896 GCC defines two macros based on the value of this option.  The first
9897 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9898 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9899 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9900 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9901 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9902
9903 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9904 above.  In other words, it will have the full prefix and will not
9905 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9906 the macro names the resolved architecture (either @samp{"mips1"} or
9907 @samp{"mips3"}).  It names the default architecture when no
9908 @option{-march} option is given.
9909
9910 @item -mtune=@var{arch}
9911 @opindex mtune
9912 Optimize for @var{arch}.  Among other things, this option controls
9913 the way instructions are scheduled, and the perceived cost of arithmetic
9914 operations.  The list of @var{arch} values is the same as for
9915 @option{-march}.
9916
9917 When this option is not used, GCC will optimize for the processor
9918 specified by @option{-march}.  By using @option{-march} and
9919 @option{-mtune} together, it is possible to generate code that will
9920 run on a family of processors, but optimize the code for one
9921 particular member of that family.
9922
9923 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9924 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9925 @samp{-march} ones described above.
9926
9927 @item -mips1
9928 @opindex mips1
9929 Equivalent to @samp{-march=mips1}.
9930
9931 @item -mips2
9932 @opindex mips2
9933 Equivalent to @samp{-march=mips2}.
9934
9935 @item -mips3
9936 @opindex mips3
9937 Equivalent to @samp{-march=mips3}.
9938
9939 @item -mips4
9940 @opindex mips4
9941 Equivalent to @samp{-march=mips4}.
9942
9943 @item -mips32
9944 @opindex mips32
9945 Equivalent to @samp{-march=mips32}.
9946
9947 @item -mips32r2
9948 @opindex mips32r2
9949 Equivalent to @samp{-march=mips32r2}.
9950
9951 @item -mips64
9952 @opindex mips64
9953 Equivalent to @samp{-march=mips64}.
9954
9955 @item -mips16
9956 @itemx -mno-mips16
9957 @opindex mips16
9958 @opindex mno-mips16
9959 Generate (do not generate) MIPS16 code.  If GCC is targetting a
9960 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
9961
9962 @item -mabi=32
9963 @itemx -mabi=o64
9964 @itemx -mabi=n32
9965 @itemx -mabi=64
9966 @itemx -mabi=eabi
9967 @opindex mabi=32
9968 @opindex mabi=o64
9969 @opindex mabi=n32
9970 @opindex mabi=64
9971 @opindex mabi=eabi
9972 Generate code for the given ABI@.
9973
9974 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9975 generates 64-bit code when you select a 64-bit architecture, but you
9976 can use @option{-mgp32} to get 32-bit code instead.
9977
9978 For information about the O64 ABI, see
9979 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9980
9981 @item -mabicalls
9982 @itemx -mno-abicalls
9983 @opindex mabicalls
9984 @opindex mno-abicalls
9985 Generate (do not generate) SVR4-style position-independent code.
9986 @option{-mabicalls} is the default for SVR4-based systems.
9987
9988 @item -mxgot
9989 @itemx -mno-xgot
9990 @opindex mxgot
9991 @opindex mno-xgot
9992 Lift (do not lift) the usual restrictions on the size of the global
9993 offset table.
9994
9995 GCC normally uses a single instruction to load values from the GOT@.
9996 While this is relatively efficient, it will only work if the GOT
9997 is smaller than about 64k.  Anything larger will cause the linker
9998 to report an error such as:
9999
10000 @cindex relocation truncated to fit (MIPS)
10001 @smallexample
10002 relocation truncated to fit: R_MIPS_GOT16 foobar
10003 @end smallexample
10004
10005 If this happens, you should recompile your code with @option{-mxgot}.
10006 It should then work with very large GOTs, although it will also be
10007 less efficient, since it will take three instructions to fetch the
10008 value of a global symbol.
10009
10010 Note that some linkers can create multiple GOTs.  If you have such a
10011 linker, you should only need to use @option{-mxgot} when a single object
10012 file accesses more than 64k's worth of GOT entries.  Very few do.
10013
10014 These options have no effect unless GCC is generating position
10015 independent code.
10016
10017 @item -mgp32
10018 @opindex mgp32
10019 Assume that general-purpose registers are 32 bits wide.
10020
10021 @item -mgp64
10022 @opindex mgp64
10023 Assume that general-purpose registers are 64 bits wide.
10024
10025 @item -mfp32
10026 @opindex mfp32
10027 Assume that floating-point registers are 32 bits wide.
10028
10029 @item -mfp64
10030 @opindex mfp64
10031 Assume that floating-point registers are 64 bits wide.
10032
10033 @item -mhard-float
10034 @opindex mhard-float
10035 Use floating-point coprocessor instructions.
10036
10037 @item -msoft-float
10038 @opindex msoft-float
10039 Do not use floating-point coprocessor instructions.  Implement
10040 floating-point calculations using library calls instead.
10041
10042 @item -msingle-float
10043 @opindex msingle-float
10044 Assume that the floating-point coprocessor only supports single-precision
10045 operations.
10046
10047 @itemx -mdouble-float
10048 @opindex mdouble-float
10049 Assume that the floating-point coprocessor supports double-precision
10050 operations.  This is the default.
10051
10052 @itemx -mpaired-single
10053 @itemx -mno-paired-single
10054 @opindex mpaired-single
10055 @opindex mno-paired-single
10056 Use (do not use) paired-single floating-point instructions.
10057 @xref{MIPS Paired-Single Support}.  This option can only be used
10058 when generating 64-bit code and requires hardware floating-point
10059 support to be enabled.
10060
10061 @itemx -mips3d
10062 @itemx -mno-mips3d
10063 @opindex mips3d
10064 @opindex mno-mips3d
10065 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10066 The option @option{-mips3d} implies @option{-mpaired-single}.
10067
10068 @item -mlong64
10069 @opindex mlong64
10070 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10071 an explanation of the default and the way that the pointer size is
10072 determined.
10073
10074 @item -mlong32
10075 @opindex mlong32
10076 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10077
10078 The default size of @code{int}s, @code{long}s and pointers depends on
10079 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10080 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10081 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10082 or the same size as integer registers, whichever is smaller.
10083
10084 @item -msym32
10085 @itemx -mno-sym32
10086 @opindex msym32
10087 @opindex mno-sym32
10088 Assume (do not assume) that all symbols have 32-bit values, regardless
10089 of the selected ABI@.  This option is useful in combination with
10090 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10091 to generate shorter and faster references to symbolic addresses.
10092
10093 @item -G @var{num}
10094 @opindex G
10095 @cindex smaller data references (MIPS)
10096 @cindex gp-relative references (MIPS)
10097 Put global and static items less than or equal to @var{num} bytes into
10098 the small data or bss section instead of the normal data or bss section.
10099 This allows the data to be accessed using a single instruction.
10100
10101 All modules should be compiled with the same @option{-G @var{num}}
10102 value.
10103
10104 @item -membedded-data
10105 @itemx -mno-embedded-data
10106 @opindex membedded-data
10107 @opindex mno-embedded-data
10108 Allocate variables to the read-only data section first if possible, then
10109 next in the small data section if possible, otherwise in data.  This gives
10110 slightly slower code than the default, but reduces the amount of RAM required
10111 when executing, and thus may be preferred for some embedded systems.
10112
10113 @item -muninit-const-in-rodata
10114 @itemx -mno-uninit-const-in-rodata
10115 @opindex muninit-const-in-rodata
10116 @opindex mno-uninit-const-in-rodata
10117 Put uninitialized @code{const} variables in the read-only data section.
10118 This option is only meaningful in conjunction with @option{-membedded-data}.
10119
10120 @item -msplit-addresses
10121 @itemx -mno-split-addresses
10122 @opindex msplit-addresses
10123 @opindex mno-split-addresses
10124 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10125 relocation operators.  This option has been superseded by
10126 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10127
10128 @item -mexplicit-relocs
10129 @itemx -mno-explicit-relocs
10130 @opindex mexplicit-relocs
10131 @opindex mno-explicit-relocs
10132 Use (do not use) assembler relocation operators when dealing with symbolic
10133 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10134 is to use assembler macros instead.
10135
10136 @option{-mexplicit-relocs} is the default if GCC was configured
10137 to use an assembler that supports relocation operators.
10138
10139 @item -mcheck-zero-division
10140 @itemx -mno-check-zero-division
10141 @opindex mcheck-zero-division
10142 @opindex mno-check-zero-division
10143 Trap (do not trap) on integer division by zero.  The default is
10144 @option{-mcheck-zero-division}.
10145
10146 @item -mdivide-traps
10147 @itemx -mdivide-breaks
10148 @opindex mdivide-traps
10149 @opindex mdivide-breaks
10150 MIPS systems check for division by zero by generating either a
10151 conditional trap or a break instruction.  Using traps results in
10152 smaller code, but is only supported on MIPS II and later.  Also, some
10153 versions of the Linux kernel have a bug that prevents trap from
10154 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10155 allow conditional traps on architectures that support them and
10156 @option{-mdivide-breaks} to force the use of breaks.
10157
10158 The default is usually @option{-mdivide-traps}, but this can be
10159 overridden at configure time using @option{--with-divide=breaks}.
10160 Divide-by-zero checks can be completely disabled using
10161 @option{-mno-check-zero-division}.
10162
10163 @item -mmemcpy
10164 @itemx -mno-memcpy
10165 @opindex mmemcpy
10166 @opindex mno-memcpy
10167 Force (do not force) the use of @code{memcpy()} for non-trivial block
10168 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10169 most constant-sized copies.
10170
10171 @item -mlong-calls
10172 @itemx -mno-long-calls
10173 @opindex mlong-calls
10174 @opindex mno-long-calls
10175 Disable (do not disable) use of the @code{jal} instruction.  Calling
10176 functions using @code{jal} is more efficient but requires the caller
10177 and callee to be in the same 256 megabyte segment.
10178
10179 This option has no effect on abicalls code.  The default is
10180 @option{-mno-long-calls}.
10181
10182 @item -mmad
10183 @itemx -mno-mad
10184 @opindex mmad
10185 @opindex mno-mad
10186 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10187 instructions, as provided by the R4650 ISA@.
10188
10189 @item -mfused-madd
10190 @itemx -mno-fused-madd
10191 @opindex mfused-madd
10192 @opindex mno-fused-madd
10193 Enable (disable) use of the floating point multiply-accumulate
10194 instructions, when they are available.  The default is
10195 @option{-mfused-madd}.
10196
10197 When multiply-accumulate instructions are used, the intermediate
10198 product is calculated to infinite precision and is not subject to
10199 the FCSR Flush to Zero bit.  This may be undesirable in some
10200 circumstances.
10201
10202 @item -nocpp
10203 @opindex nocpp
10204 Tell the MIPS assembler to not run its preprocessor over user
10205 assembler files (with a @samp{.s} suffix) when assembling them.
10206
10207 @item -mfix-r4000
10208 @itemx -mno-fix-r4000
10209 @opindex mfix-r4000
10210 @opindex mno-fix-r4000
10211 Work around certain R4000 CPU errata:
10212 @itemize @minus
10213 @item
10214 A double-word or a variable shift may give an incorrect result if executed
10215 immediately after starting an integer division.
10216 @item
10217 A double-word or a variable shift may give an incorrect result if executed
10218 while an integer multiplication is in progress.
10219 @item
10220 An integer division may give an incorrect result if started in a delay slot
10221 of a taken branch or a jump.
10222 @end itemize
10223
10224 @item -mfix-r4400
10225 @itemx -mno-fix-r4400
10226 @opindex mfix-r4400
10227 @opindex mno-fix-r4400
10228 Work around certain R4400 CPU errata:
10229 @itemize @minus
10230 @item
10231 A double-word or a variable shift may give an incorrect result if executed
10232 immediately after starting an integer division.
10233 @end itemize
10234
10235 @item -mfix-vr4120
10236 @itemx -mno-fix-vr4120
10237 @opindex mfix-vr4120
10238 Work around certain VR4120 errata:
10239 @itemize @minus
10240 @item
10241 @code{dmultu} does not always produce the correct result.
10242 @item
10243 @code{div} and @code{ddiv} do not always produce the correct result if one
10244 of the operands is negative.
10245 @end itemize
10246 The workarounds for the division errata rely on special functions in
10247 @file{libgcc.a}.  At present, these functions are only provided by
10248 the @code{mips64vr*-elf} configurations.
10249
10250 Other VR4120 errata require a nop to be inserted between certain pairs of
10251 instructions.  These errata are handled by the assembler, not by GCC itself.
10252
10253 @item -mfix-vr4130
10254 @opindex mfix-vr4130
10255 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10256 workarounds are implemented by the assembler rather than by GCC,
10257 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10258 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10259 instructions are available instead.
10260
10261 @item -mfix-sb1
10262 @itemx -mno-fix-sb1
10263 @opindex mfix-sb1
10264 Work around certain SB-1 CPU core errata.
10265 (This flag currently works around the SB-1 revision 2
10266 ``F1'' and ``F2'' floating point errata.)
10267
10268 @item -mflush-func=@var{func}
10269 @itemx -mno-flush-func
10270 @opindex mflush-func
10271 Specifies the function to call to flush the I and D caches, or to not
10272 call any such function.  If called, the function must take the same
10273 arguments as the common @code{_flush_func()}, that is, the address of the
10274 memory range for which the cache is being flushed, the size of the
10275 memory range, and the number 3 (to flush both caches).  The default
10276 depends on the target GCC was configured for, but commonly is either
10277 @samp{_flush_func} or @samp{__cpu_flush}.
10278
10279 @item -mbranch-likely
10280 @itemx -mno-branch-likely
10281 @opindex mbranch-likely
10282 @opindex mno-branch-likely
10283 Enable or disable use of Branch Likely instructions, regardless of the
10284 default for the selected architecture.  By default, Branch Likely
10285 instructions may be generated if they are supported by the selected
10286 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10287 and processors which implement those architectures; for those, Branch
10288 Likely instructions will not be generated by default because the MIPS32
10289 and MIPS64 architectures specifically deprecate their use.
10290
10291 @item -mfp-exceptions
10292 @itemx -mno-fp-exceptions
10293 @opindex mfp-exceptions
10294 Specifies whether FP exceptions are enabled.  This affects how we schedule
10295 FP instructions for some processors.  The default is that FP exceptions are
10296 enabled.
10297
10298 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10299 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10300 FP pipe.
10301
10302 @item -mvr4130-align
10303 @itemx -mno-vr4130-align
10304 @opindex mvr4130-align
10305 The VR4130 pipeline is two-way superscalar, but can only issue two
10306 instructions together if the first one is 8-byte aligned.  When this
10307 option is enabled, GCC will align pairs of instructions that it
10308 thinks should execute in parallel.
10309
10310 This option only has an effect when optimizing for the VR4130.
10311 It normally makes code faster, but at the expense of making it bigger.
10312 It is enabled by default at optimization level @option{-O3}.
10313 @end table
10314
10315 @node MMIX Options
10316 @subsection MMIX Options
10317 @cindex MMIX Options
10318
10319 These options are defined for the MMIX:
10320
10321 @table @gcctabopt
10322 @item -mlibfuncs
10323 @itemx -mno-libfuncs
10324 @opindex mlibfuncs
10325 @opindex mno-libfuncs
10326 Specify that intrinsic library functions are being compiled, passing all
10327 values in registers, no matter the size.
10328
10329 @item -mepsilon
10330 @itemx -mno-epsilon
10331 @opindex mepsilon
10332 @opindex mno-epsilon
10333 Generate floating-point comparison instructions that compare with respect
10334 to the @code{rE} epsilon register.
10335
10336 @item -mabi=mmixware
10337 @itemx -mabi=gnu
10338 @opindex mabi-mmixware
10339 @opindex mabi=gnu
10340 Generate code that passes function parameters and return values that (in
10341 the called function) are seen as registers @code{$0} and up, as opposed to
10342 the GNU ABI which uses global registers @code{$231} and up.
10343
10344 @item -mzero-extend
10345 @itemx -mno-zero-extend
10346 @opindex mzero-extend
10347 @opindex mno-zero-extend
10348 When reading data from memory in sizes shorter than 64 bits, use (do not
10349 use) zero-extending load instructions by default, rather than
10350 sign-extending ones.
10351
10352 @item -mknuthdiv
10353 @itemx -mno-knuthdiv
10354 @opindex mknuthdiv
10355 @opindex mno-knuthdiv
10356 Make the result of a division yielding a remainder have the same sign as
10357 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10358 remainder follows the sign of the dividend.  Both methods are
10359 arithmetically valid, the latter being almost exclusively used.
10360
10361 @item -mtoplevel-symbols
10362 @itemx -mno-toplevel-symbols
10363 @opindex mtoplevel-symbols
10364 @opindex mno-toplevel-symbols
10365 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10366 code can be used with the @code{PREFIX} assembly directive.
10367
10368 @item -melf
10369 @opindex melf
10370 Generate an executable in the ELF format, rather than the default
10371 @samp{mmo} format used by the @command{mmix} simulator.
10372
10373 @item -mbranch-predict
10374 @itemx -mno-branch-predict
10375 @opindex mbranch-predict
10376 @opindex mno-branch-predict
10377 Use (do not use) the probable-branch instructions, when static branch
10378 prediction indicates a probable branch.
10379
10380 @item -mbase-addresses
10381 @itemx -mno-base-addresses
10382 @opindex mbase-addresses
10383 @opindex mno-base-addresses
10384 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10385 base address automatically generates a request (handled by the assembler
10386 and the linker) for a constant to be set up in a global register.  The
10387 register is used for one or more base address requests within the range 0
10388 to 255 from the value held in the register.  The generally leads to short
10389 and fast code, but the number of different data items that can be
10390 addressed is limited.  This means that a program that uses lots of static
10391 data may require @option{-mno-base-addresses}.
10392
10393 @item -msingle-exit
10394 @itemx -mno-single-exit
10395 @opindex msingle-exit
10396 @opindex mno-single-exit
10397 Force (do not force) generated code to have a single exit point in each
10398 function.
10399 @end table
10400
10401 @node MN10300 Options
10402 @subsection MN10300 Options
10403 @cindex MN10300 options
10404
10405 These @option{-m} options are defined for Matsushita MN10300 architectures:
10406
10407 @table @gcctabopt
10408 @item -mmult-bug
10409 @opindex mmult-bug
10410 Generate code to avoid bugs in the multiply instructions for the MN10300
10411 processors.  This is the default.
10412
10413 @item -mno-mult-bug
10414 @opindex mno-mult-bug
10415 Do not generate code to avoid bugs in the multiply instructions for the
10416 MN10300 processors.
10417
10418 @item -mam33
10419 @opindex mam33
10420 Generate code which uses features specific to the AM33 processor.
10421
10422 @item -mno-am33
10423 @opindex mno-am33
10424 Do not generate code which uses features specific to the AM33 processor.  This
10425 is the default.
10426
10427 @item -mno-crt0
10428 @opindex mno-crt0
10429 Do not link in the C run-time initialization object file.
10430
10431 @item -mrelax
10432 @opindex mrelax
10433 Indicate to the linker that it should perform a relaxation optimization pass
10434 to shorten branches, calls and absolute memory addresses.  This option only
10435 has an effect when used on the command line for the final link step.
10436
10437 This option makes symbolic debugging impossible.
10438 @end table
10439
10440 @node PDP-11 Options
10441 @subsection PDP-11 Options
10442 @cindex PDP-11 Options
10443
10444 These options are defined for the PDP-11:
10445
10446 @table @gcctabopt
10447 @item -mfpu
10448 @opindex mfpu
10449 Use hardware FPP floating point.  This is the default.  (FIS floating
10450 point on the PDP-11/40 is not supported.)
10451
10452 @item -msoft-float
10453 @opindex msoft-float
10454 Do not use hardware floating point.
10455
10456 @item -mac0
10457 @opindex mac0
10458 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10459
10460 @item -mno-ac0
10461 @opindex mno-ac0
10462 Return floating-point results in memory.  This is the default.
10463
10464 @item -m40
10465 @opindex m40
10466 Generate code for a PDP-11/40.
10467
10468 @item -m45
10469 @opindex m45
10470 Generate code for a PDP-11/45.  This is the default.
10471
10472 @item -m10
10473 @opindex m10
10474 Generate code for a PDP-11/10.
10475
10476 @item -mbcopy-builtin
10477 @opindex bcopy-builtin
10478 Use inline @code{movmemhi} patterns for copying memory.  This is the
10479 default.
10480
10481 @item -mbcopy
10482 @opindex mbcopy
10483 Do not use inline @code{movmemhi} patterns for copying memory.
10484
10485 @item -mint16
10486 @itemx -mno-int32
10487 @opindex mint16
10488 @opindex mno-int32
10489 Use 16-bit @code{int}.  This is the default.
10490
10491 @item -mint32
10492 @itemx -mno-int16
10493 @opindex mint32
10494 @opindex mno-int16
10495 Use 32-bit @code{int}.
10496
10497 @item -mfloat64
10498 @itemx -mno-float32
10499 @opindex mfloat64
10500 @opindex mno-float32
10501 Use 64-bit @code{float}.  This is the default.
10502
10503 @item -mfloat32
10504 @itemx -mno-float64
10505 @opindex mfloat32
10506 @opindex mno-float64
10507 Use 32-bit @code{float}.
10508
10509 @item -mabshi
10510 @opindex mabshi
10511 Use @code{abshi2} pattern.  This is the default.
10512
10513 @item -mno-abshi
10514 @opindex mno-abshi
10515 Do not use @code{abshi2} pattern.
10516
10517 @item -mbranch-expensive
10518 @opindex mbranch-expensive
10519 Pretend that branches are expensive.  This is for experimenting with
10520 code generation only.
10521
10522 @item -mbranch-cheap
10523 @opindex mbranch-cheap
10524 Do not pretend that branches are expensive.  This is the default.
10525
10526 @item -msplit
10527 @opindex msplit
10528 Generate code for a system with split I&D@.
10529
10530 @item -mno-split
10531 @opindex mno-split
10532 Generate code for a system without split I&D@.  This is the default.
10533
10534 @item -munix-asm
10535 @opindex munix-asm
10536 Use Unix assembler syntax.  This is the default when configured for
10537 @samp{pdp11-*-bsd}.
10538
10539 @item -mdec-asm
10540 @opindex mdec-asm
10541 Use DEC assembler syntax.  This is the default when configured for any
10542 PDP-11 target other than @samp{pdp11-*-bsd}.
10543 @end table
10544
10545 @node PowerPC Options
10546 @subsection PowerPC Options
10547 @cindex PowerPC options
10548
10549 These are listed under @xref{RS/6000 and PowerPC Options}.
10550
10551 @node RS/6000 and PowerPC Options
10552 @subsection IBM RS/6000 and PowerPC Options
10553 @cindex RS/6000 and PowerPC Options
10554 @cindex IBM RS/6000 and PowerPC Options
10555
10556 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10557 @table @gcctabopt
10558 @item -mpower
10559 @itemx -mno-power
10560 @itemx -mpower2
10561 @itemx -mno-power2
10562 @itemx -mpowerpc
10563 @itemx -mno-powerpc
10564 @itemx -mpowerpc-gpopt
10565 @itemx -mno-powerpc-gpopt
10566 @itemx -mpowerpc-gfxopt
10567 @itemx -mno-powerpc-gfxopt
10568 @itemx -mpowerpc64
10569 @itemx -mno-powerpc64
10570 @opindex mpower
10571 @opindex mno-power
10572 @opindex mpower2
10573 @opindex mno-power2
10574 @opindex mpowerpc
10575 @opindex mno-powerpc
10576 @opindex mpowerpc-gpopt
10577 @opindex mno-powerpc-gpopt
10578 @opindex mpowerpc-gfxopt
10579 @opindex mno-powerpc-gfxopt
10580 @opindex mpowerpc64
10581 @opindex mno-powerpc64
10582 GCC supports two related instruction set architectures for the
10583 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10584 instructions supported by the @samp{rios} chip set used in the original
10585 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10586 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10587 the IBM 4xx microprocessors.
10588
10589 Neither architecture is a subset of the other.  However there is a
10590 large common subset of instructions supported by both.  An MQ
10591 register is included in processors supporting the POWER architecture.
10592
10593 You use these options to specify which instructions are available on the
10594 processor you are using.  The default value of these options is
10595 determined when configuring GCC@.  Specifying the
10596 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10597 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10598 rather than the options listed above.
10599
10600 The @option{-mpower} option allows GCC to generate instructions that
10601 are found only in the POWER architecture and to use the MQ register.
10602 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10603 to generate instructions that are present in the POWER2 architecture but
10604 not the original POWER architecture.
10605
10606 The @option{-mpowerpc} option allows GCC to generate instructions that
10607 are found only in the 32-bit subset of the PowerPC architecture.
10608 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10609 GCC to use the optional PowerPC architecture instructions in the
10610 General Purpose group, including floating-point square root.  Specifying
10611 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10612 use the optional PowerPC architecture instructions in the Graphics
10613 group, including floating-point select.
10614
10615 The @option{-mpowerpc64} option allows GCC to generate the additional
10616 64-bit instructions that are found in the full PowerPC64 architecture
10617 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10618 @option{-mno-powerpc64}.
10619
10620 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10621 will use only the instructions in the common subset of both
10622 architectures plus some special AIX common-mode calls, and will not use
10623 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10624 permits GCC to use any instruction from either architecture and to
10625 allow use of the MQ register; specify this for the Motorola MPC601.
10626
10627 @item -mnew-mnemonics
10628 @itemx -mold-mnemonics
10629 @opindex mnew-mnemonics
10630 @opindex mold-mnemonics
10631 Select which mnemonics to use in the generated assembler code.  With
10632 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10633 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10634 assembler mnemonics defined for the POWER architecture.  Instructions
10635 defined in only one architecture have only one mnemonic; GCC uses that
10636 mnemonic irrespective of which of these options is specified.
10637
10638 GCC defaults to the mnemonics appropriate for the architecture in
10639 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10640 value of these option.  Unless you are building a cross-compiler, you
10641 should normally not specify either @option{-mnew-mnemonics} or
10642 @option{-mold-mnemonics}, but should instead accept the default.
10643
10644 @item -mcpu=@var{cpu_type}
10645 @opindex mcpu
10646 Set architecture type, register usage, choice of mnemonics, and
10647 instruction scheduling parameters for machine type @var{cpu_type}.
10648 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10649 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10650 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10651 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10652 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10653 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10654 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10655 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10656 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10657
10658 @option{-mcpu=common} selects a completely generic processor.  Code
10659 generated under this option will run on any POWER or PowerPC processor.
10660 GCC will use only the instructions in the common subset of both
10661 architectures, and will not use the MQ register.  GCC assumes a generic
10662 processor model for scheduling purposes.
10663
10664 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10665 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10666 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10667 types, with an appropriate, generic processor model assumed for
10668 scheduling purposes.
10669
10670 The other options specify a specific processor.  Code generated under
10671 those options will run best on that processor, and may not run at all on
10672 others.
10673
10674 The @option{-mcpu} options automatically enable or disable the
10675 following options: @option{-maltivec}, @option{-mhard-float},
10676 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10677 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10678 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10679 @option{-mstring}.  The particular options set for any particular CPU
10680 will vary between compiler versions, depending on what setting seems
10681 to produce optimal code for that CPU; it doesn't necessarily reflect
10682 the actual hardware's capabilities.  If you wish to set an individual
10683 option to a particular value, you may specify it after the
10684 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10685
10686 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10687 not enabled or disabled by the @option{-mcpu} option at present, since
10688 AIX does not have full support for these options.  You may still
10689 enable or disable them individually if you're sure it'll work in your
10690 environment.
10691
10692 @item -mtune=@var{cpu_type}
10693 @opindex mtune
10694 Set the instruction scheduling parameters for machine type
10695 @var{cpu_type}, but do not set the architecture type, register usage, or
10696 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10697 values for @var{cpu_type} are used for @option{-mtune} as for
10698 @option{-mcpu}.  If both are specified, the code generated will use the
10699 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10700 scheduling parameters set by @option{-mtune}.
10701
10702 @item -mswdiv
10703 @itemx -mno-swdiv
10704 @opindex mswdiv
10705 @opindex mno-swdiv
10706 Generate code to compute division as reciprocal estimate and iterative
10707 refinement, creating opportunities for increased throughput.  This
10708 feature requires: optional PowerPC Graphics instruction set for single
10709 precision and FRE instruction for double precision, assuming divides
10710 cannot generate user-visible traps, and the domain values not include
10711 Infinities, denormals or zero denominator.
10712
10713 @item -maltivec
10714 @itemx -mno-altivec
10715 @opindex maltivec
10716 @opindex mno-altivec
10717 Generate code that uses (does not use) AltiVec instructions, and also
10718 enable the use of built-in functions that allow more direct access to
10719 the AltiVec instruction set.  You may also need to set
10720 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10721 enhancements.
10722
10723 @item -mvrsave
10724 @item -mno-vrsave
10725 @opindex mvrsave
10726 @opindex mno-vrsave
10727 Generate VRSAVE instructions when generating AltiVec code.
10728
10729 @item -mabi=spe
10730 @opindex mabi=spe
10731 Extend the current ABI with SPE ABI extensions.  This does not change
10732 the default ABI, instead it adds the SPE ABI extensions to the current
10733 ABI@.
10734
10735 @item -mabi=no-spe
10736 @opindex mabi=no-spe
10737 Disable Booke SPE ABI extensions for the current ABI@.
10738
10739 @item -msecure-plt
10740 @opindex msecure-plt
10741 Generate code that allows ld and ld.so to build executables and shared
10742 libraries with non-exec .plt and .got sections.  This is a PowerPC
10743 32-bit SYSV ABI option.
10744
10745 @item -mbss-plt
10746 @opindex mbss-plt
10747 Generate code that uses a BSS .plt section that ld.so fills in, and
10748 requires .plt and .got sections that are both writable and executable.
10749 This is a PowerPC 32-bit SYSV ABI option.
10750
10751 @item -misel
10752 @itemx -mno-isel
10753 @opindex misel
10754 @opindex mno-isel
10755 This switch enables or disables the generation of ISEL instructions.
10756
10757 @item -misel=@var{yes/no}
10758 This switch has been deprecated.  Use @option{-misel} and
10759 @option{-mno-isel} instead.
10760
10761 @item -mspe
10762 @itemx -mno-isel
10763 @opindex mspe
10764 @opindex mno-spe
10765 This switch enables or disables the generation of SPE simd
10766 instructions.
10767
10768 @item -mspe=@var{yes/no}
10769 This option has been deprecated.  Use @option{-mspe} and
10770 @option{-mno-spe} instead.
10771
10772 @item -mfloat-gprs=@var{yes/single/double/no}
10773 @itemx -mfloat-gprs
10774 @opindex mfloat-gprs
10775 This switch enables or disables the generation of floating point
10776 operations on the general purpose registers for architectures that
10777 support it.
10778
10779 The argument @var{yes} or @var{single} enables the use of
10780 single-precision floating point operations.
10781
10782 The argument @var{double} enables the use of single and
10783 double-precision floating point operations.
10784
10785 The argument @var{no} disables floating point operations on the
10786 general purpose registers.
10787
10788 This option is currently only available on the MPC854x.
10789
10790 @item -m32
10791 @itemx -m64
10792 @opindex m32
10793 @opindex m64
10794 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10795 targets (including GNU/Linux).  The 32-bit environment sets int, long
10796 and pointer to 32 bits and generates code that runs on any PowerPC
10797 variant.  The 64-bit environment sets int to 32 bits and long and
10798 pointer to 64 bits, and generates code for PowerPC64, as for
10799 @option{-mpowerpc64}.
10800
10801 @item -mfull-toc
10802 @itemx -mno-fp-in-toc
10803 @itemx -mno-sum-in-toc
10804 @itemx -mminimal-toc
10805 @opindex mfull-toc
10806 @opindex mno-fp-in-toc
10807 @opindex mno-sum-in-toc
10808 @opindex mminimal-toc
10809 Modify generation of the TOC (Table Of Contents), which is created for
10810 every executable file.  The @option{-mfull-toc} option is selected by
10811 default.  In that case, GCC will allocate at least one TOC entry for
10812 each unique non-automatic variable reference in your program.  GCC
10813 will also place floating-point constants in the TOC@.  However, only
10814 16,384 entries are available in the TOC@.
10815
10816 If you receive a linker error message that saying you have overflowed
10817 the available TOC space, you can reduce the amount of TOC space used
10818 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10819 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10820 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10821 generate code to calculate the sum of an address and a constant at
10822 run-time instead of putting that sum into the TOC@.  You may specify one
10823 or both of these options.  Each causes GCC to produce very slightly
10824 slower and larger code at the expense of conserving TOC space.
10825
10826 If you still run out of space in the TOC even when you specify both of
10827 these options, specify @option{-mminimal-toc} instead.  This option causes
10828 GCC to make only one TOC entry for every file.  When you specify this
10829 option, GCC will produce code that is slower and larger but which
10830 uses extremely little TOC space.  You may wish to use this option
10831 only on files that contain less frequently executed code.
10832
10833 @item -maix64
10834 @itemx -maix32
10835 @opindex maix64
10836 @opindex maix32
10837 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10838 @code{long} type, and the infrastructure needed to support them.
10839 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10840 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10841 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10842
10843 @item -mxl-compat
10844 @itemx -mno-xl-compat
10845 @opindex mxl-compat
10846 @opindex mno-xl-compat
10847 Produce code that conforms more closely to IBM XLC semantics when using
10848 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10849 functions beyond the register save area (RSA) on the stack in addition
10850 to argument FPRs.  Do not assume that most significant double in 128
10851 bit long double value is properly rounded when comparing values.
10852
10853 The AIX calling convention was extended but not initially documented to
10854 handle an obscure K&R C case of calling a function that takes the
10855 address of its arguments with fewer arguments than declared.  AIX XL
10856 compilers access floating point arguments which do not fit in the
10857 RSA from the stack when a subroutine is compiled without
10858 optimization.  Because always storing floating-point arguments on the
10859 stack is inefficient and rarely needed, this option is not enabled by
10860 default and only is necessary when calling subroutines compiled by AIX
10861 XL compilers without optimization.
10862
10863 @item -mpe
10864 @opindex mpe
10865 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10866 application written to use message passing with special startup code to
10867 enable the application to run.  The system must have PE installed in the
10868 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10869 must be overridden with the @option{-specs=} option to specify the
10870 appropriate directory location.  The Parallel Environment does not
10871 support threads, so the @option{-mpe} option and the @option{-pthread}
10872 option are incompatible.
10873
10874 @item -malign-natural
10875 @itemx -malign-power
10876 @opindex malign-natural
10877 @opindex malign-power
10878 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10879 @option{-malign-natural} overrides the ABI-defined alignment of larger
10880 types, such as floating-point doubles, on their natural size-based boundary.
10881 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10882 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10883
10884 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10885 is not supported.
10886
10887 @item -msoft-float
10888 @itemx -mhard-float
10889 @opindex msoft-float
10890 @opindex mhard-float
10891 Generate code that does not use (uses) the floating-point register set.
10892 Software floating point emulation is provided if you use the
10893 @option{-msoft-float} option, and pass the option to GCC when linking.
10894
10895 @item -mmultiple
10896 @itemx -mno-multiple
10897 @opindex mmultiple
10898 @opindex mno-multiple
10899 Generate code that uses (does not use) the load multiple word
10900 instructions and the store multiple word instructions.  These
10901 instructions are generated by default on POWER systems, and not
10902 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10903 endian PowerPC systems, since those instructions do not work when the
10904 processor is in little endian mode.  The exceptions are PPC740 and
10905 PPC750 which permit the instructions usage in little endian mode.
10906
10907 @item -mstring
10908 @itemx -mno-string
10909 @opindex mstring
10910 @opindex mno-string
10911 Generate code that uses (does not use) the load string instructions
10912 and the store string word instructions to save multiple registers and
10913 do small block moves.  These instructions are generated by default on
10914 POWER systems, and not generated on PowerPC systems.  Do not use
10915 @option{-mstring} on little endian PowerPC systems, since those
10916 instructions do not work when the processor is in little endian mode.
10917 The exceptions are PPC740 and PPC750 which permit the instructions
10918 usage in little endian mode.
10919
10920 @item -mupdate
10921 @itemx -mno-update
10922 @opindex mupdate
10923 @opindex mno-update
10924 Generate code that uses (does not use) the load or store instructions
10925 that update the base register to the address of the calculated memory
10926 location.  These instructions are generated by default.  If you use
10927 @option{-mno-update}, there is a small window between the time that the
10928 stack pointer is updated and the address of the previous frame is
10929 stored, which means code that walks the stack frame across interrupts or
10930 signals may get corrupted data.
10931
10932 @item -mfused-madd
10933 @itemx -mno-fused-madd
10934 @opindex mfused-madd
10935 @opindex mno-fused-madd
10936 Generate code that uses (does not use) the floating point multiply and
10937 accumulate instructions.  These instructions are generated by default if
10938 hardware floating is used.
10939
10940 @item -mno-bit-align
10941 @itemx -mbit-align
10942 @opindex mno-bit-align
10943 @opindex mbit-align
10944 On System V.4 and embedded PowerPC systems do not (do) force structures
10945 and unions that contain bit-fields to be aligned to the base type of the
10946 bit-field.
10947
10948 For example, by default a structure containing nothing but 8
10949 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10950 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10951 the structure would be aligned to a 1 byte boundary and be one byte in
10952 size.
10953
10954 @item -mno-strict-align
10955 @itemx -mstrict-align
10956 @opindex mno-strict-align
10957 @opindex mstrict-align
10958 On System V.4 and embedded PowerPC systems do not (do) assume that
10959 unaligned memory references will be handled by the system.
10960
10961 @item -mrelocatable
10962 @itemx -mno-relocatable
10963 @opindex mrelocatable
10964 @opindex mno-relocatable
10965 On embedded PowerPC systems generate code that allows (does not allow)
10966 the program to be relocated to a different address at runtime.  If you
10967 use @option{-mrelocatable} on any module, all objects linked together must
10968 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10969
10970 @item -mrelocatable-lib
10971 @itemx -mno-relocatable-lib
10972 @opindex mrelocatable-lib
10973 @opindex mno-relocatable-lib
10974 On embedded PowerPC systems generate code that allows (does not allow)
10975 the program to be relocated to a different address at runtime.  Modules
10976 compiled with @option{-mrelocatable-lib} can be linked with either modules
10977 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10978 with modules compiled with the @option{-mrelocatable} options.
10979
10980 @item -mno-toc
10981 @itemx -mtoc
10982 @opindex mno-toc
10983 @opindex mtoc
10984 On System V.4 and embedded PowerPC systems do not (do) assume that
10985 register 2 contains a pointer to a global area pointing to the addresses
10986 used in the program.
10987
10988 @item -mlittle
10989 @itemx -mlittle-endian
10990 @opindex mlittle
10991 @opindex mlittle-endian
10992 On System V.4 and embedded PowerPC systems compile code for the
10993 processor in little endian mode.  The @option{-mlittle-endian} option is
10994 the same as @option{-mlittle}.
10995
10996 @item -mbig
10997 @itemx -mbig-endian
10998 @opindex mbig
10999 @opindex mbig-endian
11000 On System V.4 and embedded PowerPC systems compile code for the
11001 processor in big endian mode.  The @option{-mbig-endian} option is
11002 the same as @option{-mbig}.
11003
11004 @item -mdynamic-no-pic
11005 @opindex mdynamic-no-pic
11006 On Darwin and Mac OS X systems, compile code so that it is not
11007 relocatable, but that its external references are relocatable.  The
11008 resulting code is suitable for applications, but not shared
11009 libraries.
11010
11011 @item -mprioritize-restricted-insns=@var{priority}
11012 @opindex mprioritize-restricted-insns
11013 This option controls the priority that is assigned to
11014 dispatch-slot restricted instructions during the second scheduling
11015 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11016 @var{no/highest/second-highest} priority to dispatch slot restricted
11017 instructions.
11018
11019 @item -msched-costly-dep=@var{dependence_type}
11020 @opindex msched-costly-dep
11021 This option controls which dependences are considered costly
11022 by the target during instruction scheduling.  The argument
11023 @var{dependence_type} takes one of the following values:
11024 @var{no}: no dependence is costly,
11025 @var{all}: all dependences are costly,
11026 @var{true_store_to_load}: a true dependence from store to load is costly,
11027 @var{store_to_load}: any dependence from store to load is costly,
11028 @var{number}: any dependence which latency >= @var{number} is costly.
11029
11030 @item -minsert-sched-nops=@var{scheme}
11031 @opindex minsert-sched-nops
11032 This option controls which nop insertion scheme will be used during
11033 the second scheduling pass.  The argument @var{scheme} takes one of the
11034 following values:
11035 @var{no}: Don't insert nops.
11036 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11037 according to the scheduler's grouping.
11038 @var{regroup_exact}: Insert nops to force costly dependent insns into
11039 separate groups.  Insert exactly as many nops as needed to force an insn
11040 to a new group, according to the estimated processor grouping.
11041 @var{number}: Insert nops to force costly dependent insns into
11042 separate groups.  Insert @var{number} nops to force an insn to a new group.
11043
11044 @item -mcall-sysv
11045 @opindex mcall-sysv
11046 On System V.4 and embedded PowerPC systems compile code using calling
11047 conventions that adheres to the March 1995 draft of the System V
11048 Application Binary Interface, PowerPC processor supplement.  This is the
11049 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11050
11051 @item -mcall-sysv-eabi
11052 @opindex mcall-sysv-eabi
11053 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11054
11055 @item -mcall-sysv-noeabi
11056 @opindex mcall-sysv-noeabi
11057 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11058
11059 @item -mcall-solaris
11060 @opindex mcall-solaris
11061 On System V.4 and embedded PowerPC systems compile code for the Solaris
11062 operating system.
11063
11064 @item -mcall-linux
11065 @opindex mcall-linux
11066 On System V.4 and embedded PowerPC systems compile code for the
11067 Linux-based GNU system.
11068
11069 @item -mcall-gnu
11070 @opindex mcall-gnu
11071 On System V.4 and embedded PowerPC systems compile code for the
11072 Hurd-based GNU system.
11073
11074 @item -mcall-netbsd
11075 @opindex mcall-netbsd
11076 On System V.4 and embedded PowerPC systems compile code for the
11077 NetBSD operating system.
11078
11079 @item -maix-struct-return
11080 @opindex maix-struct-return
11081 Return all structures in memory (as specified by the AIX ABI)@.
11082
11083 @item -msvr4-struct-return
11084 @opindex msvr4-struct-return
11085 Return structures smaller than 8 bytes in registers (as specified by the
11086 SVR4 ABI)@.
11087
11088 @item -mabi=@var{abi-type}
11089 @opindex mabi
11090 Extend the current ABI with a particular extension, or remove such extension.
11091 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11092 @var{no-spe}@.
11093
11094 @item -mprototype
11095 @itemx -mno-prototype
11096 @opindex mprototype
11097 @opindex mno-prototype
11098 On System V.4 and embedded PowerPC systems assume that all calls to
11099 variable argument functions are properly prototyped.  Otherwise, the
11100 compiler must insert an instruction before every non prototyped call to
11101 set or clear bit 6 of the condition code register (@var{CR}) to
11102 indicate whether floating point values were passed in the floating point
11103 registers in case the function takes a variable arguments.  With
11104 @option{-mprototype}, only calls to prototyped variable argument functions
11105 will set or clear the bit.
11106
11107 @item -msim
11108 @opindex msim
11109 On embedded PowerPC systems, assume that the startup module is called
11110 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11111 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11112 configurations.
11113
11114 @item -mmvme
11115 @opindex mmvme
11116 On embedded PowerPC systems, assume that the startup module is called
11117 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11118 @file{libc.a}.
11119
11120 @item -mads
11121 @opindex mads
11122 On embedded PowerPC systems, assume that the startup module is called
11123 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11124 @file{libc.a}.
11125
11126 @item -myellowknife
11127 @opindex myellowknife
11128 On embedded PowerPC systems, assume that the startup module is called
11129 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11130 @file{libc.a}.
11131
11132 @item -mvxworks
11133 @opindex mvxworks
11134 On System V.4 and embedded PowerPC systems, specify that you are
11135 compiling for a VxWorks system.
11136
11137 @item -mwindiss
11138 @opindex mwindiss
11139 Specify that you are compiling for the WindISS simulation environment.
11140
11141 @item -memb
11142 @opindex memb
11143 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11144 header to indicate that @samp{eabi} extended relocations are used.
11145
11146 @item -meabi
11147 @itemx -mno-eabi
11148 @opindex meabi
11149 @opindex mno-eabi
11150 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11151 Embedded Applications Binary Interface (eabi) which is a set of
11152 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11153 means that the stack is aligned to an 8 byte boundary, a function
11154 @code{__eabi} is called to from @code{main} to set up the eabi
11155 environment, and the @option{-msdata} option can use both @code{r2} and
11156 @code{r13} to point to two separate small data areas.  Selecting
11157 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11158 do not call an initialization function from @code{main}, and the
11159 @option{-msdata} option will only use @code{r13} to point to a single
11160 small data area.  The @option{-meabi} option is on by default if you
11161 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11162
11163 @item -msdata=eabi
11164 @opindex msdata=eabi
11165 On System V.4 and embedded PowerPC systems, put small initialized
11166 @code{const} global and static data in the @samp{.sdata2} section, which
11167 is pointed to by register @code{r2}.  Put small initialized
11168 non-@code{const} global and static data in the @samp{.sdata} section,
11169 which is pointed to by register @code{r13}.  Put small uninitialized
11170 global and static data in the @samp{.sbss} section, which is adjacent to
11171 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11172 incompatible with the @option{-mrelocatable} option.  The
11173 @option{-msdata=eabi} option also sets the @option{-memb} option.
11174
11175 @item -msdata=sysv
11176 @opindex msdata=sysv
11177 On System V.4 and embedded PowerPC systems, put small global and static
11178 data in the @samp{.sdata} section, which is pointed to by register
11179 @code{r13}.  Put small uninitialized global and static data in the
11180 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11181 The @option{-msdata=sysv} option is incompatible with the
11182 @option{-mrelocatable} option.
11183
11184 @item -msdata=default
11185 @itemx -msdata
11186 @opindex msdata=default
11187 @opindex msdata
11188 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11189 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11190 same as @option{-msdata=sysv}.
11191
11192 @item -msdata-data
11193 @opindex msdata-data
11194 On System V.4 and embedded PowerPC systems, put small global and static
11195 data in the @samp{.sdata} section.  Put small uninitialized global and
11196 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11197 to address small data however.  This is the default behavior unless
11198 other @option{-msdata} options are used.
11199
11200 @item -msdata=none
11201 @itemx -mno-sdata
11202 @opindex msdata=none
11203 @opindex mno-sdata
11204 On embedded PowerPC systems, put all initialized global and static data
11205 in the @samp{.data} section, and all uninitialized data in the
11206 @samp{.bss} section.
11207
11208 @item -G @var{num}
11209 @opindex G
11210 @cindex smaller data references (PowerPC)
11211 @cindex .sdata/.sdata2 references (PowerPC)
11212 On embedded PowerPC systems, put global and static items less than or
11213 equal to @var{num} bytes into the small data or bss sections instead of
11214 the normal data or bss section.  By default, @var{num} is 8.  The
11215 @option{-G @var{num}} switch is also passed to the linker.
11216 All modules should be compiled with the same @option{-G @var{num}} value.
11217
11218 @item -mregnames
11219 @itemx -mno-regnames
11220 @opindex mregnames
11221 @opindex mno-regnames
11222 On System V.4 and embedded PowerPC systems do (do not) emit register
11223 names in the assembly language output using symbolic forms.
11224
11225 @item -mlongcall
11226 @itemx -mno-longcall
11227 @opindex mlongcall
11228 @opindex mno-longcall
11229 Default to making all function calls indirectly, using a register, so
11230 that functions which reside further than 32 megabytes (33,554,432
11231 bytes) from the current location can be called.  This setting can be
11232 overridden by the @code{shortcall} function attribute, or by
11233 @code{#pragma longcall(0)}.
11234
11235 Some linkers are capable of detecting out-of-range calls and generating
11236 glue code on the fly.  On these systems, long calls are unnecessary and
11237 generate slower code.  As of this writing, the AIX linker can do this,
11238 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11239 to the GNU linker for 32-bit PowerPC systems as well.
11240
11241 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11242 callee, L42'', plus a ``branch island'' (glue code).  The two target
11243 addresses represent the callee and the ``branch island''.  The
11244 Darwin/PPC linker will prefer the first address and generate a ``bl
11245 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11246 otherwise, the linker will generate ``bl L42'' to call the ``branch
11247 island''.  The ``branch island'' is appended to the body of the
11248 calling function; it computes the full 32-bit address of the callee
11249 and jumps to it.
11250
11251 On Mach-O (Darwin) systems, this option directs the compiler emit to
11252 the glue for every direct call, and the Darwin linker decides whether
11253 to use or discard it.
11254
11255 In the future, we may cause GCC to ignore all longcall specifications
11256 when the linker is known to generate glue.
11257
11258 @item -pthread
11259 @opindex pthread
11260 Adds support for multithreading with the @dfn{pthreads} library.
11261 This option sets flags for both the preprocessor and linker.
11262
11263 @end table
11264
11265 @node S/390 and zSeries Options
11266 @subsection S/390 and zSeries Options
11267 @cindex S/390 and zSeries Options
11268
11269 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11270
11271 @table @gcctabopt
11272 @item -mhard-float
11273 @itemx -msoft-float
11274 @opindex mhard-float
11275 @opindex msoft-float
11276 Use (do not use) the hardware floating-point instructions and registers
11277 for floating-point operations.  When @option{-msoft-float} is specified,
11278 functions in @file{libgcc.a} will be used to perform floating-point
11279 operations.  When @option{-mhard-float} is specified, the compiler
11280 generates IEEE floating-point instructions.  This is the default.
11281
11282 @item -mbackchain
11283 @itemx -mno-backchain
11284 @opindex mbackchain
11285 @opindex mno-backchain
11286 Store (do not store) the address of the caller's frame as backchain pointer
11287 into the callee's stack frame.
11288 A backchain may be needed to allow debugging using tools that do not understand
11289 DWARF-2 call frame information.
11290 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11291 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11292 the backchain is placed into the topmost word of the 96/160 byte register
11293 save area.
11294
11295 In general, code compiled with @option{-mbackchain} is call-compatible with
11296 code compiled with @option{-mmo-backchain}; however, use of the backchain
11297 for debugging purposes usually requires that the whole binary is built with
11298 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11299 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11300 to build a linux kernel use @option{-msoft-float}.
11301
11302 The default is to not maintain the backchain.
11303
11304 @item -mpacked-stack
11305 @item -mno-packed-stack
11306 @opindex mpacked-stack
11307 @opindex mno-packed-stack
11308 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11309 specified, the compiler uses the all fields of the 96/160 byte register save
11310 area only for their default purpose; unused fields still take up stack space.
11311 When @option{-mpacked-stack} is specified, register save slots are densely
11312 packed at the top of the register save area; unused space is reused for other
11313 purposes, allowing for more efficient use of the available stack space.
11314 However, when @option{-mbackchain} is also in effect, the topmost word of
11315 the save area is always used to store the backchain, and the return address
11316 register is always saved two words below the backchain.
11317
11318 As long as the stack frame backchain is not used, code generated with
11319 @option{-mpacked-stack} is call-compatible with code generated with
11320 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11321 S/390 or zSeries generated code that uses the stack frame backchain at run
11322 time, not just for debugging purposes.  Such code is not call-compatible
11323 with code compiled with @option{-mpacked-stack}.  Also, note that the
11324 combination of @option{-mbackchain},
11325 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11326 to build a linux kernel use @option{-msoft-float}.
11327
11328 The default is to not use the packed stack layout.
11329
11330 @item -msmall-exec
11331 @itemx -mno-small-exec
11332 @opindex msmall-exec
11333 @opindex mno-small-exec
11334 Generate (or do not generate) code using the @code{bras} instruction
11335 to do subroutine calls.
11336 This only works reliably if the total executable size does not
11337 exceed 64k.  The default is to use the @code{basr} instruction instead,
11338 which does not have this limitation.
11339
11340 @item -m64
11341 @itemx -m31
11342 @opindex m64
11343 @opindex m31
11344 When @option{-m31} is specified, generate code compliant to the
11345 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11346 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11347 particular to generate 64-bit instructions.  For the @samp{s390}
11348 targets, the default is @option{-m31}, while the @samp{s390x}
11349 targets default to @option{-m64}.
11350
11351 @item -mzarch
11352 @itemx -mesa
11353 @opindex mzarch
11354 @opindex mesa
11355 When @option{-mzarch} is specified, generate code using the
11356 instructions available on z/Architecture.
11357 When @option{-mesa} is specified, generate code using the
11358 instructions available on ESA/390.  Note that @option{-mesa} is
11359 not possible with @option{-m64}.
11360 When generating code compliant to the GNU/Linux for S/390 ABI,
11361 the default is @option{-mesa}.  When generating code compliant
11362 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11363
11364 @item -mmvcle
11365 @itemx -mno-mvcle
11366 @opindex mmvcle
11367 @opindex mno-mvcle
11368 Generate (or do not generate) code using the @code{mvcle} instruction
11369 to perform block moves.  When @option{-mno-mvcle} is specified,
11370 use a @code{mvc} loop instead.  This is the default unless optimizing for
11371 size.
11372
11373 @item -mdebug
11374 @itemx -mno-debug
11375 @opindex mdebug
11376 @opindex mno-debug
11377 Print (or do not print) additional debug information when compiling.
11378 The default is to not print debug information.
11379
11380 @item -march=@var{cpu-type}
11381 @opindex march
11382 Generate code that will run on @var{cpu-type}, which is the name of a system
11383 representing a certain processor type.  Possible values for
11384 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11385 When generating code using the instructions available on z/Architecture,
11386 the default is @option{-march=z900}.  Otherwise, the default is
11387 @option{-march=g5}.
11388
11389 @item -mtune=@var{cpu-type}
11390 @opindex mtune
11391 Tune to @var{cpu-type} everything applicable about the generated code,
11392 except for the ABI and the set of available instructions.
11393 The list of @var{cpu-type} values is the same as for @option{-march}.
11394 The default is the value used for @option{-march}.
11395
11396 @item -mtpf-trace
11397 @itemx -mno-tpf-trace
11398 @opindex mtpf-trace
11399 @opindex mno-tpf-trace
11400 Generate code that adds (does not add) in TPF OS specific branches to trace
11401 routines in the operating system.  This option is off by default, even
11402 when compiling for the TPF OS@.
11403
11404 @item -mfused-madd
11405 @itemx -mno-fused-madd
11406 @opindex mfused-madd
11407 @opindex mno-fused-madd
11408 Generate code that uses (does not use) the floating point multiply and
11409 accumulate instructions.  These instructions are generated by default if
11410 hardware floating point is used.
11411
11412 @item -mwarn-framesize=@var{framesize}
11413 @opindex mwarn-framesize
11414 Emit a warning if the current function exceeds the given frame size.  Because
11415 this is a compile time check it doesn't need to be a real problem when the program
11416 runs.  It is intended to identify functions which most probably cause
11417 a stack overflow.  It is useful to be used in an environment with limited stack
11418 size e.g.@: the linux kernel.
11419
11420 @item -mwarn-dynamicstack
11421 @opindex mwarn-dynamicstack
11422 Emit a warning if the function calls alloca or uses dynamically
11423 sized arrays.  This is generally a bad idea with a limited stack size.
11424
11425 @item -mstack-guard=@var{stack-guard}
11426 @item -mstack-size=@var{stack-size}
11427 @opindex mstack-guard
11428 @opindex mstack-size
11429 These arguments always have to be used in conjunction.  If they are present the s390
11430 back end emits additional instructions in the function prologue which trigger a trap
11431 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11432 (remember that the stack on s390 grows downward).  These options are intended to
11433 be used to help debugging stack overflow problems.  The additionally emitted code
11434 cause only little overhead and hence can also be used in production like systems
11435 without greater performance degradation.  The given values have to be exact
11436 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11437 In order to be efficient the extra code makes the assumption that the stack starts
11438 at an address aligned to the value given by @var{stack-size}.
11439 @end table
11440
11441 @node SH Options
11442 @subsection SH Options
11443
11444 These @samp{-m} options are defined for the SH implementations:
11445
11446 @table @gcctabopt
11447 @item -m1
11448 @opindex m1
11449 Generate code for the SH1.
11450
11451 @item -m2
11452 @opindex m2
11453 Generate code for the SH2.
11454
11455 @item -m2e
11456 Generate code for the SH2e.
11457
11458 @item -m3
11459 @opindex m3
11460 Generate code for the SH3.
11461
11462 @item -m3e
11463 @opindex m3e
11464 Generate code for the SH3e.
11465
11466 @item -m4-nofpu
11467 @opindex m4-nofpu
11468 Generate code for the SH4 without a floating-point unit.
11469
11470 @item -m4-single-only
11471 @opindex m4-single-only
11472 Generate code for the SH4 with a floating-point unit that only
11473 supports single-precision arithmetic.
11474
11475 @item -m4-single
11476 @opindex m4-single
11477 Generate code for the SH4 assuming the floating-point unit is in
11478 single-precision mode by default.
11479
11480 @item -m4
11481 @opindex m4
11482 Generate code for the SH4.
11483
11484 @item -m4a-nofpu
11485 @opindex m4a-nofpu
11486 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11487 floating-point unit is not used.
11488
11489 @item -m4a-single-only
11490 @opindex m4a-single-only
11491 Generate code for the SH4a, in such a way that no double-precision
11492 floating point operations are used.
11493
11494 @item -m4a-single
11495 @opindex m4a-single
11496 Generate code for the SH4a assuming the floating-point unit is in
11497 single-precision mode by default.
11498
11499 @item -m4a
11500 @opindex m4a
11501 Generate code for the SH4a.
11502
11503 @item -m4al
11504 @opindex m4al
11505 Same as @option{-m4a-nofpu}, except that it implicitly passes
11506 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11507 instructions at the moment.
11508
11509 @item -mb
11510 @opindex mb
11511 Compile code for the processor in big endian mode.
11512
11513 @item -ml
11514 @opindex ml
11515 Compile code for the processor in little endian mode.
11516
11517 @item -mdalign
11518 @opindex mdalign
11519 Align doubles at 64-bit boundaries.  Note that this changes the calling
11520 conventions, and thus some functions from the standard C library will
11521 not work unless you recompile it first with @option{-mdalign}.
11522
11523 @item -mrelax
11524 @opindex mrelax
11525 Shorten some address references at link time, when possible; uses the
11526 linker option @option{-relax}.
11527
11528 @item -mbigtable
11529 @opindex mbigtable
11530 Use 32-bit offsets in @code{switch} tables.  The default is to use
11531 16-bit offsets.
11532
11533 @item -mfmovd
11534 @opindex mfmovd
11535 Enable the use of the instruction @code{fmovd}.
11536
11537 @item -mhitachi
11538 @opindex mhitachi
11539 Comply with the calling conventions defined by Renesas.
11540
11541 @item -mrenesas
11542 @opindex mhitachi
11543 Comply with the calling conventions defined by Renesas.
11544
11545 @item -mno-renesas
11546 @opindex mhitachi
11547 Comply with the calling conventions defined for GCC before the Renesas
11548 conventions were available.  This option is the default for all
11549 targets of the SH toolchain except for @samp{sh-symbianelf}.
11550
11551 @item -mnomacsave
11552 @opindex mnomacsave
11553 Mark the @code{MAC} register as call-clobbered, even if
11554 @option{-mhitachi} is given.
11555
11556 @item -mieee
11557 @opindex mieee
11558 Increase IEEE-compliance of floating-point code.
11559 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11560 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11561 comparisons of NANs / infinities incurs extra overhead in every
11562 floating point comparison, therefore the default is set to
11563 @option{-ffinite-math-only}.
11564
11565 @item -misize
11566 @opindex misize
11567 Dump instruction size and location in the assembly code.
11568
11569 @item -mpadstruct
11570 @opindex mpadstruct
11571 This option is deprecated.  It pads structures to multiple of 4 bytes,
11572 which is incompatible with the SH ABI@.
11573
11574 @item -mspace
11575 @opindex mspace
11576 Optimize for space instead of speed.  Implied by @option{-Os}.
11577
11578 @item -mprefergot
11579 @opindex mprefergot
11580 When generating position-independent code, emit function calls using
11581 the Global Offset Table instead of the Procedure Linkage Table.
11582
11583 @item -musermode
11584 @opindex musermode
11585 Generate a library function call to invalidate instruction cache
11586 entries, after fixing up a trampoline.  This library function call
11587 doesn't assume it can write to the whole memory address space.  This
11588 is the default when the target is @code{sh-*-linux*}.
11589
11590 @item -multcost=@var{number}
11591 @opindex multcost=@var{number}
11592 Set the cost to assume for a multiply insn.
11593
11594 @item -mdiv=@var{strategy}
11595 @opindex mdiv=@var{strategy}
11596 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11597 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11598 inv:call2, inv:fp .
11599 "fp" performs the operation in floating point.  This has a very high latency,
11600 but needs only a few instructions, so it might be a good choice if
11601 your code has enough easily exploitable ILP to allow the compiler to
11602 schedule the floating point instructions together with other instructions.
11603 Division by zero causes a floating point exception.
11604 "inv" uses integer operations to calculate the inverse of the divisor,
11605 and then multiplies the dividend with the inverse.  This strategy allows
11606 cse and hoisting of the inverse calculation.  Division by zero calculates
11607 an unspecified result, but does not trap.
11608 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11609 have been found, or if the entire operation has been hoisted to the same
11610 place, the last stages of the inverse calculation are intertwined with the
11611 final multiply to reduce the overall latency, at the expense of using a few
11612 more instructions, and thus offering fewer scheduling opportunities with
11613 other code.
11614 "call" calls a library function that usually implements the inv:minlat
11615 strategy.
11616 This gives high code density for m5-*media-nofpu compilations.
11617 "call2" uses a different entry point of the same library function, where it
11618 assumes that a pointer to a lookup table has already been set up, which
11619 exposes the pointer load to cse / code hoisting optimizations.
11620 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11621 code generation, but if the code stays unoptimized, revert to the "call",
11622 "call2", or "fp" strategies, respectively.  Note that the
11623 potentially-trapping side effect of division by zero is carried by a
11624 separate instruction, so it is possible that all the integer instructions
11625 are hoisted out, but the marker for the side effect stays where it is.
11626 A recombination to fp operations or a call is not possible in that case.
11627 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11628 that the inverse calculation was nor separated from the multiply, they speed
11629 up division where the dividend fits into 20 bits (plus sign where applicable),
11630 by inserting a test to skip a number of operations in this case; this test
11631 slows down the case of larger dividends.  inv20u assumes the case of a such
11632 a small dividend to be unlikely, and inv20l assumes it to be likely.
11633
11634 @item -mdivsi3_libfunc=@var{name}
11635 @opindex mdivsi3_libfunc=@var{name}
11636 Set the name of the library function used for 32 bit signed division to
11637 @var{name}.  This only affect the name used in the call and inv:call
11638 division strategies, and the compiler will still expect the same
11639 sets of input/output/clobbered registers as if this option was not present.
11640
11641 @item -madjust-unroll
11642 @opindex madjust-unroll
11643 Throttle unrolling to avoid thrashing target registers.
11644 This option only has an effect if the gcc code base supports the
11645 TARGET_ADJUST_UNROLL_MAX target hook.
11646
11647 @item -mindexed-addressing
11648 @opindex mindexed-addressing
11649 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11650 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11651 semantics for the indexed addressing mode.  The architecture allows the
11652 implementation of processors with 64 bit MMU, which the OS could use to
11653 get 32 bit addressing, but since no current hardware implementation supports
11654 this or any other way to make the indexed addressing mode safe to use in
11655 the 32 bit ABI, the default is -mno-indexed-addressing.
11656
11657 @item -mgettrcost=@var{number}
11658 @opindex mgettrcost=@var{number}
11659 Set the cost assumed for the gettr instruction to @var{number}.
11660 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11661
11662 @item -mpt-fixed
11663 @opindex mpt-fixed
11664 Assume pt* instructions won't trap.  This will generally generate better
11665 scheduled code, but is unsafe on current hardware.  The current architecture
11666 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11667 This has the unintentional effect of making it unsafe to schedule ptabs /
11668 ptrel before a branch, or hoist it out of a loop.  For example,
11669 __do_global_ctors, a part of libgcc that runs constructors at program
11670 startup, calls functions in a list which is delimited by -1.  With the
11671 -mpt-fixed option, the ptabs will be done before testing against -1.
11672 That means that all the constructors will be run a bit quicker, but when
11673 the loop comes to the end of the list, the program crashes because ptabs
11674 loads -1 into a target register.  Since this option is unsafe for any
11675 hardware implementing the current architecture specification, the default
11676 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11677 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11678 this deters register allocation using target registers for storing
11679 ordinary integers.
11680
11681 @item -minvalid-symbols
11682 @opindex minvalid-symbols
11683 Assume symbols might be invalid.  Ordinary function symbols generated by
11684 the compiler will always be valid to load with movi/shori/ptabs or
11685 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11686 to generate symbols that will cause ptabs / ptrel to trap.
11687 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11688 It will then prevent cross-basic-block cse, hoisting and most scheduling
11689 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11690 @end table
11691
11692 @node SPARC Options
11693 @subsection SPARC Options
11694 @cindex SPARC options
11695
11696 These @samp{-m} options are supported on the SPARC:
11697
11698 @table @gcctabopt
11699 @item -mno-app-regs
11700 @itemx -mapp-regs
11701 @opindex mno-app-regs
11702 @opindex mapp-regs
11703 Specify @option{-mapp-regs} to generate output using the global registers
11704 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11705 is the default.
11706
11707 To be fully SVR4 ABI compliant at the cost of some performance loss,
11708 specify @option{-mno-app-regs}.  You should compile libraries and system
11709 software with this option.
11710
11711 @item -mfpu
11712 @itemx -mhard-float
11713 @opindex mfpu
11714 @opindex mhard-float
11715 Generate output containing floating point instructions.  This is the
11716 default.
11717
11718 @item -mno-fpu
11719 @itemx -msoft-float
11720 @opindex mno-fpu
11721 @opindex msoft-float
11722 Generate output containing library calls for floating point.
11723 @strong{Warning:} the requisite libraries are not available for all SPARC
11724 targets.  Normally the facilities of the machine's usual C compiler are
11725 used, but this cannot be done directly in cross-compilation.  You must make
11726 your own arrangements to provide suitable library functions for
11727 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11728 @samp{sparclite-*-*} do provide software floating point support.
11729
11730 @option{-msoft-float} changes the calling convention in the output file;
11731 therefore, it is only useful if you compile @emph{all} of a program with
11732 this option.  In particular, you need to compile @file{libgcc.a}, the
11733 library that comes with GCC, with @option{-msoft-float} in order for
11734 this to work.
11735
11736 @item -mhard-quad-float
11737 @opindex mhard-quad-float
11738 Generate output containing quad-word (long double) floating point
11739 instructions.
11740
11741 @item -msoft-quad-float
11742 @opindex msoft-quad-float
11743 Generate output containing library calls for quad-word (long double)
11744 floating point instructions.  The functions called are those specified
11745 in the SPARC ABI@.  This is the default.
11746
11747 As of this writing, there are no SPARC implementations that have hardware
11748 support for the quad-word floating point instructions.  They all invoke
11749 a trap handler for one of these instructions, and then the trap handler
11750 emulates the effect of the instruction.  Because of the trap handler overhead,
11751 this is much slower than calling the ABI library routines.  Thus the
11752 @option{-msoft-quad-float} option is the default.
11753
11754 @item -mno-unaligned-doubles
11755 @itemx -munaligned-doubles
11756 @opindex mno-unaligned-doubles
11757 @opindex munaligned-doubles
11758 Assume that doubles have 8 byte alignment.  This is the default.
11759
11760 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11761 alignment only if they are contained in another type, or if they have an
11762 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11763 Specifying this option avoids some rare compatibility problems with code
11764 generated by other compilers.  It is not the default because it results
11765 in a performance loss, especially for floating point code.
11766
11767 @item -mno-faster-structs
11768 @itemx -mfaster-structs
11769 @opindex mno-faster-structs
11770 @opindex mfaster-structs
11771 With @option{-mfaster-structs}, the compiler assumes that structures
11772 should have 8 byte alignment.  This enables the use of pairs of
11773 @code{ldd} and @code{std} instructions for copies in structure
11774 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11775 However, the use of this changed alignment directly violates the SPARC
11776 ABI@.  Thus, it's intended only for use on targets where the developer
11777 acknowledges that their resulting code will not be directly in line with
11778 the rules of the ABI@.
11779
11780 @item -mimpure-text
11781 @opindex mimpure-text
11782 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11783 the compiler to not pass @option{-z text} to the linker when linking a
11784 shared object.  Using this option, you can link position-dependent
11785 code into a shared object.
11786
11787 @option{-mimpure-text} suppresses the ``relocations remain against
11788 allocatable but non-writable sections'' linker error message.
11789 However, the necessary relocations will trigger copy-on-write, and the
11790 shared object is not actually shared across processes.  Instead of
11791 using @option{-mimpure-text}, you should compile all source code with
11792 @option{-fpic} or @option{-fPIC}.
11793
11794 This option is only available on SunOS and Solaris.
11795
11796 @item -mcpu=@var{cpu_type}
11797 @opindex mcpu
11798 Set the instruction set, register set, and instruction scheduling parameters
11799 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11800 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11801 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11802 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11803 @samp{ultrasparc3}.
11804
11805 Default instruction scheduling parameters are used for values that select
11806 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11807 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11808
11809 Here is a list of each supported architecture and their supported
11810 implementations.
11811
11812 @smallexample
11813     v7:             cypress
11814     v8:             supersparc, hypersparc
11815     sparclite:      f930, f934, sparclite86x
11816     sparclet:       tsc701
11817     v9:             ultrasparc, ultrasparc3
11818 @end smallexample
11819
11820 By default (unless configured otherwise), GCC generates code for the V7
11821 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11822 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11823 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11824 SPARCStation 1, 2, IPX etc.
11825
11826 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11827 architecture.  The only difference from V7 code is that the compiler emits
11828 the integer multiply and integer divide instructions which exist in SPARC-V8
11829 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11830 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11831 2000 series.
11832
11833 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11834 the SPARC architecture.  This adds the integer multiply, integer divide step
11835 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11836 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11837 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11838 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11839 MB86934 chip, which is the more recent SPARClite with FPU@.
11840
11841 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11842 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11843 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11844 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11845 optimizes it for the TEMIC SPARClet chip.
11846
11847 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11848 architecture.  This adds 64-bit integer and floating-point move instructions,
11849 3 additional floating-point condition code registers and conditional move
11850 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11851 optimizes it for the Sun UltraSPARC I/II chips.  With
11852 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11853 Sun UltraSPARC III chip.
11854
11855 @item -mtune=@var{cpu_type}
11856 @opindex mtune
11857 Set the instruction scheduling parameters for machine type
11858 @var{cpu_type}, but do not set the instruction set or register set that the
11859 option @option{-mcpu=@var{cpu_type}} would.
11860
11861 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11862 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11863 that select a particular cpu implementation.  Those are @samp{cypress},
11864 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11865 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11866 @samp{ultrasparc3}.
11867
11868 @item -mv8plus
11869 @itemx -mno-v8plus
11870 @opindex mv8plus
11871 @opindex mno-v8plus
11872 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11873 difference from the V8 ABI is that the global and out registers are
11874 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11875 mode for all SPARC-V9 processors.
11876
11877 @item -mvis
11878 @itemx -mno-vis
11879 @opindex mvis
11880 @opindex mno-vis
11881 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11882 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11883 @end table
11884
11885 These @samp{-m} options are supported in addition to the above
11886 on SPARC-V9 processors in 64-bit environments:
11887
11888 @table @gcctabopt
11889 @item -mlittle-endian
11890 @opindex mlittle-endian
11891 Generate code for a processor running in little-endian mode.  It is only
11892 available for a few configurations and most notably not on Solaris and Linux.
11893
11894 @item -m32
11895 @itemx -m64
11896 @opindex m32
11897 @opindex m64
11898 Generate code for a 32-bit or 64-bit environment.
11899 The 32-bit environment sets int, long and pointer to 32 bits.
11900 The 64-bit environment sets int to 32 bits and long and pointer
11901 to 64 bits.
11902
11903 @item -mcmodel=medlow
11904 @opindex mcmodel=medlow
11905 Generate code for the Medium/Low code model: 64-bit addresses, programs
11906 must be linked in the low 32 bits of memory.  Programs can be statically
11907 or dynamically linked.
11908
11909 @item -mcmodel=medmid
11910 @opindex mcmodel=medmid
11911 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11912 must be linked in the low 44 bits of memory, the text and data segments must
11913 be less than 2GB in size and the data segment must be located within 2GB of
11914 the text segment.
11915
11916 @item -mcmodel=medany
11917 @opindex mcmodel=medany
11918 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11919 may be linked anywhere in memory, the text and data segments must be less
11920 than 2GB in size and the data segment must be located within 2GB of the
11921 text segment.
11922
11923 @item -mcmodel=embmedany
11924 @opindex mcmodel=embmedany
11925 Generate code for the Medium/Anywhere code model for embedded systems:
11926 64-bit addresses, the text and data segments must be less than 2GB in
11927 size, both starting anywhere in memory (determined at link time).  The
11928 global register %g4 points to the base of the data segment.  Programs
11929 are statically linked and PIC is not supported.
11930
11931 @item -mstack-bias
11932 @itemx -mno-stack-bias
11933 @opindex mstack-bias
11934 @opindex mno-stack-bias
11935 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11936 frame pointer if present, are offset by @minus{}2047 which must be added back
11937 when making stack frame references.  This is the default in 64-bit mode.
11938 Otherwise, assume no such offset is present.
11939 @end table
11940
11941 These switches are supported in addition to the above on Solaris:
11942
11943 @table @gcctabopt
11944 @item -threads
11945 @opindex threads
11946 Add support for multithreading using the Solaris threads library.  This
11947 option sets flags for both the preprocessor and linker.  This option does
11948 not affect the thread safety of object code produced by the compiler or
11949 that of libraries supplied with it.
11950
11951 @item -pthreads
11952 @opindex pthreads
11953 Add support for multithreading using the POSIX threads library.  This
11954 option sets flags for both the preprocessor and linker.  This option does
11955 not affect the thread safety of object code produced  by the compiler or
11956 that of libraries supplied with it.
11957 @end table
11958
11959 @node System V Options
11960 @subsection Options for System V
11961
11962 These additional options are available on System V Release 4 for
11963 compatibility with other compilers on those systems:
11964
11965 @table @gcctabopt
11966 @item -G
11967 @opindex G
11968 Create a shared object.
11969 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11970
11971 @item -Qy
11972 @opindex Qy
11973 Identify the versions of each tool used by the compiler, in a
11974 @code{.ident} assembler directive in the output.
11975
11976 @item -Qn
11977 @opindex Qn
11978 Refrain from adding @code{.ident} directives to the output file (this is
11979 the default).
11980
11981 @item -YP,@var{dirs}
11982 @opindex YP
11983 Search the directories @var{dirs}, and no others, for libraries
11984 specified with @option{-l}.
11985
11986 @item -Ym,@var{dir}
11987 @opindex Ym
11988 Look in the directory @var{dir} to find the M4 preprocessor.
11989 The assembler uses this option.
11990 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11991 @c the generic assembler that comes with Solaris takes just -Ym.
11992 @end table
11993
11994 @node TMS320C3x/C4x Options
11995 @subsection TMS320C3x/C4x Options
11996 @cindex TMS320C3x/C4x Options
11997
11998 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11999
12000 @table @gcctabopt
12001
12002 @item -mcpu=@var{cpu_type}
12003 @opindex mcpu
12004 Set the instruction set, register set, and instruction scheduling
12005 parameters for machine type @var{cpu_type}.  Supported values for
12006 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12007 @samp{c44}.  The default is @samp{c40} to generate code for the
12008 TMS320C40.
12009
12010 @item -mbig-memory
12011 @itemx -mbig
12012 @itemx -msmall-memory
12013 @itemx -msmall
12014 @opindex mbig-memory
12015 @opindex mbig
12016 @opindex msmall-memory
12017 @opindex msmall
12018 Generates code for the big or small memory model.  The small memory
12019 model assumed that all data fits into one 64K word page.  At run-time
12020 the data page (DP) register must be set to point to the 64K page
12021 containing the .bss and .data program sections.  The big memory model is
12022 the default and requires reloading of the DP register for every direct
12023 memory access.
12024
12025 @item -mbk
12026 @itemx -mno-bk
12027 @opindex mbk
12028 @opindex mno-bk
12029 Allow (disallow) allocation of general integer operands into the block
12030 count register BK@.
12031
12032 @item -mdb
12033 @itemx -mno-db
12034 @opindex mdb
12035 @opindex mno-db
12036 Enable (disable) generation of code using decrement and branch,
12037 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12038 on the safe side, this is disabled for the C3x, since the maximum
12039 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12040 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12041 that it can utilize the decrement and branch instruction, but will give
12042 up if there is more than one memory reference in the loop.  Thus a loop
12043 where the loop counter is decremented can generate slightly more
12044 efficient code, in cases where the RPTB instruction cannot be utilized.
12045
12046 @item -mdp-isr-reload
12047 @itemx -mparanoid
12048 @opindex mdp-isr-reload
12049 @opindex mparanoid
12050 Force the DP register to be saved on entry to an interrupt service
12051 routine (ISR), reloaded to point to the data section, and restored on
12052 exit from the ISR@.  This should not be required unless someone has
12053 violated the small memory model by modifying the DP register, say within
12054 an object library.
12055
12056 @item -mmpyi
12057 @itemx -mno-mpyi
12058 @opindex mmpyi
12059 @opindex mno-mpyi
12060 For the C3x use the 24-bit MPYI instruction for integer multiplies
12061 instead of a library call to guarantee 32-bit results.  Note that if one
12062 of the operands is a constant, then the multiplication will be performed
12063 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12064 then squaring operations are performed inline instead of a library call.
12065
12066 @item -mfast-fix
12067 @itemx -mno-fast-fix
12068 @opindex mfast-fix
12069 @opindex mno-fast-fix
12070 The C3x/C4x FIX instruction to convert a floating point value to an
12071 integer value chooses the nearest integer less than or equal to the
12072 floating point value rather than to the nearest integer.  Thus if the
12073 floating point number is negative, the result will be incorrectly
12074 truncated an additional code is necessary to detect and correct this
12075 case.  This option can be used to disable generation of the additional
12076 code required to correct the result.
12077
12078 @item -mrptb
12079 @itemx -mno-rptb
12080 @opindex mrptb
12081 @opindex mno-rptb
12082 Enable (disable) generation of repeat block sequences using the RPTB
12083 instruction for zero overhead looping.  The RPTB construct is only used
12084 for innermost loops that do not call functions or jump across the loop
12085 boundaries.  There is no advantage having nested RPTB loops due to the
12086 overhead required to save and restore the RC, RS, and RE registers.
12087 This is enabled by default with @option{-O2}.
12088
12089 @item -mrpts=@var{count}
12090 @itemx -mno-rpts
12091 @opindex mrpts
12092 @opindex mno-rpts
12093 Enable (disable) the use of the single instruction repeat instruction
12094 RPTS@.  If a repeat block contains a single instruction, and the loop
12095 count can be guaranteed to be less than the value @var{count}, GCC will
12096 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12097 then a RPTS will be emitted even if the loop count cannot be determined
12098 at compile time.  Note that the repeated instruction following RPTS does
12099 not have to be reloaded from memory each iteration, thus freeing up the
12100 CPU buses for operands.  However, since interrupts are blocked by this
12101 instruction, it is disabled by default.
12102
12103 @item -mloop-unsigned
12104 @itemx -mno-loop-unsigned
12105 @opindex mloop-unsigned
12106 @opindex mno-loop-unsigned
12107 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12108 is @math{2^{31} + 1} since these instructions test if the iteration count is
12109 negative to terminate the loop.  If the iteration count is unsigned
12110 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12111 exceeded.  This switch allows an unsigned iteration count.
12112
12113 @item -mti
12114 @opindex mti
12115 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12116 with.  This also enforces compatibility with the API employed by the TI
12117 C3x C compiler.  For example, long doubles are passed as structures
12118 rather than in floating point registers.
12119
12120 @item -mregparm
12121 @itemx -mmemparm
12122 @opindex mregparm
12123 @opindex mmemparm
12124 Generate code that uses registers (stack) for passing arguments to functions.
12125 By default, arguments are passed in registers where possible rather
12126 than by pushing arguments on to the stack.
12127
12128 @item -mparallel-insns
12129 @itemx -mno-parallel-insns
12130 @opindex mparallel-insns
12131 @opindex mno-parallel-insns
12132 Allow the generation of parallel instructions.  This is enabled by
12133 default with @option{-O2}.
12134
12135 @item -mparallel-mpy
12136 @itemx -mno-parallel-mpy
12137 @opindex mparallel-mpy
12138 @opindex mno-parallel-mpy
12139 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12140 provided @option{-mparallel-insns} is also specified.  These instructions have
12141 tight register constraints which can pessimize the code generation
12142 of large functions.
12143
12144 @end table
12145
12146 @node V850 Options
12147 @subsection V850 Options
12148 @cindex V850 Options
12149
12150 These @samp{-m} options are defined for V850 implementations:
12151
12152 @table @gcctabopt
12153 @item -mlong-calls
12154 @itemx -mno-long-calls
12155 @opindex mlong-calls
12156 @opindex mno-long-calls
12157 Treat all calls as being far away (near).  If calls are assumed to be
12158 far away, the compiler will always load the functions address up into a
12159 register, and call indirect through the pointer.
12160
12161 @item -mno-ep
12162 @itemx -mep
12163 @opindex mno-ep
12164 @opindex mep
12165 Do not optimize (do optimize) basic blocks that use the same index
12166 pointer 4 or more times to copy pointer into the @code{ep} register, and
12167 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12168 option is on by default if you optimize.
12169
12170 @item -mno-prolog-function
12171 @itemx -mprolog-function
12172 @opindex mno-prolog-function
12173 @opindex mprolog-function
12174 Do not use (do use) external functions to save and restore registers
12175 at the prologue and epilogue of a function.  The external functions
12176 are slower, but use less code space if more than one function saves
12177 the same number of registers.  The @option{-mprolog-function} option
12178 is on by default if you optimize.
12179
12180 @item -mspace
12181 @opindex mspace
12182 Try to make the code as small as possible.  At present, this just turns
12183 on the @option{-mep} and @option{-mprolog-function} options.
12184
12185 @item -mtda=@var{n}
12186 @opindex mtda
12187 Put static or global variables whose size is @var{n} bytes or less into
12188 the tiny data area that register @code{ep} points to.  The tiny data
12189 area can hold up to 256 bytes in total (128 bytes for byte references).
12190
12191 @item -msda=@var{n}
12192 @opindex msda
12193 Put static or global variables whose size is @var{n} bytes or less into
12194 the small data area that register @code{gp} points to.  The small data
12195 area can hold up to 64 kilobytes.
12196
12197 @item -mzda=@var{n}
12198 @opindex mzda
12199 Put static or global variables whose size is @var{n} bytes or less into
12200 the first 32 kilobytes of memory.
12201
12202 @item -mv850
12203 @opindex mv850
12204 Specify that the target processor is the V850.
12205
12206 @item -mbig-switch
12207 @opindex mbig-switch
12208 Generate code suitable for big switch tables.  Use this option only if
12209 the assembler/linker complain about out of range branches within a switch
12210 table.
12211
12212 @item -mapp-regs
12213 @opindex mapp-regs
12214 This option will cause r2 and r5 to be used in the code generated by
12215 the compiler.  This setting is the default.
12216
12217 @item -mno-app-regs
12218 @opindex mno-app-regs
12219 This option will cause r2 and r5 to be treated as fixed registers.
12220
12221 @item -mv850e1
12222 @opindex mv850e1
12223 Specify that the target processor is the V850E1.  The preprocessor
12224 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12225 this option is used.
12226
12227 @item -mv850e
12228 @opindex mv850e
12229 Specify that the target processor is the V850E@.  The preprocessor
12230 constant @samp{__v850e__} will be defined if this option is used.
12231
12232 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12233 are defined then a default target processor will be chosen and the
12234 relevant @samp{__v850*__} preprocessor constant will be defined.
12235
12236 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12237 defined, regardless of which processor variant is the target.
12238
12239 @item -mdisable-callt
12240 @opindex mdisable-callt
12241 This option will suppress generation of the CALLT instruction for the
12242 v850e and v850e1 flavors of the v850 architecture.  The default is
12243 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12244
12245 @end table
12246
12247 @node VAX Options
12248 @subsection VAX Options
12249 @cindex VAX options
12250
12251 These @samp{-m} options are defined for the VAX:
12252
12253 @table @gcctabopt
12254 @item -munix
12255 @opindex munix
12256 Do not output certain jump instructions (@code{aobleq} and so on)
12257 that the Unix assembler for the VAX cannot handle across long
12258 ranges.
12259
12260 @item -mgnu
12261 @opindex mgnu
12262 Do output those jump instructions, on the assumption that you
12263 will assemble with the GNU assembler.
12264
12265 @item -mg
12266 @opindex mg
12267 Output code for g-format floating point numbers instead of d-format.
12268 @end table
12269
12270 @node x86-64 Options
12271 @subsection x86-64 Options
12272 @cindex x86-64 options
12273
12274 These are listed under @xref{i386 and x86-64 Options}.
12275
12276 @node Xstormy16 Options
12277 @subsection Xstormy16 Options
12278 @cindex Xstormy16 Options
12279
12280 These options are defined for Xstormy16:
12281
12282 @table @gcctabopt
12283 @item -msim
12284 @opindex msim
12285 Choose startup files and linker script suitable for the simulator.
12286 @end table
12287
12288 @node Xtensa Options
12289 @subsection Xtensa Options
12290 @cindex Xtensa Options
12291
12292 These options are supported for Xtensa targets:
12293
12294 @table @gcctabopt
12295 @item -mconst16
12296 @itemx -mno-const16
12297 @opindex mconst16
12298 @opindex mno-const16
12299 Enable or disable use of @code{CONST16} instructions for loading
12300 constant values.  The @code{CONST16} instruction is currently not a
12301 standard option from Tensilica.  When enabled, @code{CONST16}
12302 instructions are always used in place of the standard @code{L32R}
12303 instructions.  The use of @code{CONST16} is enabled by default only if
12304 the @code{L32R} instruction is not available.
12305
12306 @item -mfused-madd
12307 @itemx -mno-fused-madd
12308 @opindex mfused-madd
12309 @opindex mno-fused-madd
12310 Enable or disable use of fused multiply/add and multiply/subtract
12311 instructions in the floating-point option.  This has no effect if the
12312 floating-point option is not also enabled.  Disabling fused multiply/add
12313 and multiply/subtract instructions forces the compiler to use separate
12314 instructions for the multiply and add/subtract operations.  This may be
12315 desirable in some cases where strict IEEE 754-compliant results are
12316 required: the fused multiply add/subtract instructions do not round the
12317 intermediate result, thereby producing results with @emph{more} bits of
12318 precision than specified by the IEEE standard.  Disabling fused multiply
12319 add/subtract instructions also ensures that the program output is not
12320 sensitive to the compiler's ability to combine multiply and add/subtract
12321 operations.
12322
12323 @item -mtext-section-literals
12324 @itemx -mno-text-section-literals
12325 @opindex mtext-section-literals
12326 @opindex mno-text-section-literals
12327 Control the treatment of literal pools.  The default is
12328 @option{-mno-text-section-literals}, which places literals in a separate
12329 section in the output file.  This allows the literal pool to be placed
12330 in a data RAM/ROM, and it also allows the linker to combine literal
12331 pools from separate object files to remove redundant literals and
12332 improve code size.  With @option{-mtext-section-literals}, the literals
12333 are interspersed in the text section in order to keep them as close as
12334 possible to their references.  This may be necessary for large assembly
12335 files.
12336
12337 @item -mtarget-align
12338 @itemx -mno-target-align
12339 @opindex mtarget-align
12340 @opindex mno-target-align
12341 When this option is enabled, GCC instructs the assembler to
12342 automatically align instructions to reduce branch penalties at the
12343 expense of some code density.  The assembler attempts to widen density
12344 instructions to align branch targets and the instructions following call
12345 instructions.  If there are not enough preceding safe density
12346 instructions to align a target, no widening will be performed.  The
12347 default is @option{-mtarget-align}.  These options do not affect the
12348 treatment of auto-aligned instructions like @code{LOOP}, which the
12349 assembler will always align, either by widening density instructions or
12350 by inserting no-op instructions.
12351
12352 @item -mlongcalls
12353 @itemx -mno-longcalls
12354 @opindex mlongcalls
12355 @opindex mno-longcalls
12356 When this option is enabled, GCC instructs the assembler to translate
12357 direct calls to indirect calls unless it can determine that the target
12358 of a direct call is in the range allowed by the call instruction.  This
12359 translation typically occurs for calls to functions in other source
12360 files.  Specifically, the assembler translates a direct @code{CALL}
12361 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12362 The default is @option{-mno-longcalls}.  This option should be used in
12363 programs where the call target can potentially be out of range.  This
12364 option is implemented in the assembler, not the compiler, so the
12365 assembly code generated by GCC will still show direct call
12366 instructions---look at the disassembled object code to see the actual
12367 instructions.  Note that the assembler will use an indirect call for
12368 every cross-file call, not just those that really will be out of range.
12369 @end table
12370
12371 @node zSeries Options
12372 @subsection zSeries Options
12373 @cindex zSeries options
12374
12375 These are listed under @xref{S/390 and zSeries Options}.
12376
12377 @node Code Gen Options
12378 @section Options for Code Generation Conventions
12379 @cindex code generation conventions
12380 @cindex options, code generation
12381 @cindex run-time options
12382
12383 These machine-independent options control the interface conventions
12384 used in code generation.
12385
12386 Most of them have both positive and negative forms; the negative form
12387 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12388 one of the forms is listed---the one which is not the default.  You
12389 can figure out the other form by either removing @samp{no-} or adding
12390 it.
12391
12392 @table @gcctabopt
12393 @item -fbounds-check
12394 @opindex fbounds-check
12395 For front-ends that support it, generate additional code to check that
12396 indices used to access arrays are within the declared range.  This is
12397 currently only supported by the Java and Fortran 77 front-ends, where
12398 this option defaults to true and false respectively.
12399
12400 @item -ftrapv
12401 @opindex ftrapv
12402 This option generates traps for signed overflow on addition, subtraction,
12403 multiplication operations.
12404
12405 @item -fwrapv
12406 @opindex fwrapv
12407 This option instructs the compiler to assume that signed arithmetic
12408 overflow of addition, subtraction and multiplication wraps around
12409 using twos-complement representation.  This flag enables some optimizations
12410 and disables other.  This option is enabled by default for the Java
12411 front-end, as required by the Java language specification.
12412
12413 @item -fexceptions
12414 @opindex fexceptions
12415 Enable exception handling.  Generates extra code needed to propagate
12416 exceptions.  For some targets, this implies GCC will generate frame
12417 unwind information for all functions, which can produce significant data
12418 size overhead, although it does not affect execution.  If you do not
12419 specify this option, GCC will enable it by default for languages like
12420 C++ which normally require exception handling, and disable it for
12421 languages like C that do not normally require it.  However, you may need
12422 to enable this option when compiling C code that needs to interoperate
12423 properly with exception handlers written in C++.  You may also wish to
12424 disable this option if you are compiling older C++ programs that don't
12425 use exception handling.
12426
12427 @item -fnon-call-exceptions
12428 @opindex fnon-call-exceptions
12429 Generate code that allows trapping instructions to throw exceptions.
12430 Note that this requires platform-specific runtime support that does
12431 not exist everywhere.  Moreover, it only allows @emph{trapping}
12432 instructions to throw exceptions, i.e.@: memory references or floating
12433 point instructions.  It does not allow exceptions to be thrown from
12434 arbitrary signal handlers such as @code{SIGALRM}.
12435
12436 @item -funwind-tables
12437 @opindex funwind-tables
12438 Similar to @option{-fexceptions}, except that it will just generate any needed
12439 static data, but will not affect the generated code in any other way.
12440 You will normally not enable this option; instead, a language processor
12441 that needs this handling would enable it on your behalf.
12442
12443 @item -fasynchronous-unwind-tables
12444 @opindex fasynchronous-unwind-tables
12445 Generate unwind table in dwarf2 format, if supported by target machine.  The
12446 table is exact at each instruction boundary, so it can be used for stack
12447 unwinding from asynchronous events (such as debugger or garbage collector).
12448
12449 @item -fpcc-struct-return
12450 @opindex fpcc-struct-return
12451 Return ``short'' @code{struct} and @code{union} values in memory like
12452 longer ones, rather than in registers.  This convention is less
12453 efficient, but it has the advantage of allowing intercallability between
12454 GCC-compiled files and files compiled with other compilers, particularly
12455 the Portable C Compiler (pcc).
12456
12457 The precise convention for returning structures in memory depends
12458 on the target configuration macros.
12459
12460 Short structures and unions are those whose size and alignment match
12461 that of some integer type.
12462
12463 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12464 switch is not binary compatible with code compiled with the
12465 @option{-freg-struct-return} switch.
12466 Use it to conform to a non-default application binary interface.
12467
12468 @item -freg-struct-return
12469 @opindex freg-struct-return
12470 Return @code{struct} and @code{union} values in registers when possible.
12471 This is more efficient for small structures than
12472 @option{-fpcc-struct-return}.
12473
12474 If you specify neither @option{-fpcc-struct-return} nor
12475 @option{-freg-struct-return}, GCC defaults to whichever convention is
12476 standard for the target.  If there is no standard convention, GCC
12477 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12478 the principal compiler.  In those cases, we can choose the standard, and
12479 we chose the more efficient register return alternative.
12480
12481 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12482 switch is not binary compatible with code compiled with the
12483 @option{-fpcc-struct-return} switch.
12484 Use it to conform to a non-default application binary interface.
12485
12486 @item -fshort-enums
12487 @opindex fshort-enums
12488 Allocate to an @code{enum} type only as many bytes as it needs for the
12489 declared range of possible values.  Specifically, the @code{enum} type
12490 will be equivalent to the smallest integer type which has enough room.
12491
12492 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12493 code that is not binary compatible with code generated without that switch.
12494 Use it to conform to a non-default application binary interface.
12495
12496 @item -fshort-double
12497 @opindex fshort-double
12498 Use the same size for @code{double} as for @code{float}.
12499
12500 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12501 code that is not binary compatible with code generated without that switch.
12502 Use it to conform to a non-default application binary interface.
12503
12504 @item -fshort-wchar
12505 @opindex fshort-wchar
12506 Override the underlying type for @samp{wchar_t} to be @samp{short
12507 unsigned int} instead of the default for the target.  This option is
12508 useful for building programs to run under WINE@.
12509
12510 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12511 code that is not binary compatible with code generated without that switch.
12512 Use it to conform to a non-default application binary interface.
12513
12514 @item -fshared-data
12515 @opindex fshared-data
12516 Requests that the data and non-@code{const} variables of this
12517 compilation be shared data rather than private data.  The distinction
12518 makes sense only on certain operating systems, where shared data is
12519 shared between processes running the same program, while private data
12520 exists in one copy per process.
12521
12522 @item -fno-common
12523 @opindex fno-common
12524 In C, allocate even uninitialized global variables in the data section of the
12525 object file, rather than generating them as common blocks.  This has the
12526 effect that if the same variable is declared (without @code{extern}) in
12527 two different compilations, you will get an error when you link them.
12528 The only reason this might be useful is if you wish to verify that the
12529 program will work on other systems which always work this way.
12530
12531 @item -fno-ident
12532 @opindex fno-ident
12533 Ignore the @samp{#ident} directive.
12534
12535 @item -finhibit-size-directive
12536 @opindex finhibit-size-directive
12537 Don't output a @code{.size} assembler directive, or anything else that
12538 would cause trouble if the function is split in the middle, and the
12539 two halves are placed at locations far apart in memory.  This option is
12540 used when compiling @file{crtstuff.c}; you should not need to use it
12541 for anything else.
12542
12543 @item -fverbose-asm
12544 @opindex fverbose-asm
12545 Put extra commentary information in the generated assembly code to
12546 make it more readable.  This option is generally only of use to those
12547 who actually need to read the generated assembly code (perhaps while
12548 debugging the compiler itself).
12549
12550 @option{-fno-verbose-asm}, the default, causes the
12551 extra information to be omitted and is useful when comparing two assembler
12552 files.
12553
12554 @item -fpic
12555 @opindex fpic
12556 @cindex global offset table
12557 @cindex PIC
12558 Generate position-independent code (PIC) suitable for use in a shared
12559 library, if supported for the target machine.  Such code accesses all
12560 constant addresses through a global offset table (GOT)@.  The dynamic
12561 loader resolves the GOT entries when the program starts (the dynamic
12562 loader is not part of GCC; it is part of the operating system).  If
12563 the GOT size for the linked executable exceeds a machine-specific
12564 maximum size, you get an error message from the linker indicating that
12565 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12566 instead.  (These maximums are 8k on the SPARC and 32k
12567 on the m68k and RS/6000.  The 386 has no such limit.)
12568
12569 Position-independent code requires special support, and therefore works
12570 only on certain machines.  For the 386, GCC supports PIC for System V
12571 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12572 position-independent.
12573
12574 @item -fPIC
12575 @opindex fPIC
12576 If supported for the target machine, emit position-independent code,
12577 suitable for dynamic linking and avoiding any limit on the size of the
12578 global offset table.  This option makes a difference on the m68k,
12579 PowerPC and SPARC@.
12580
12581 Position-independent code requires special support, and therefore works
12582 only on certain machines.
12583
12584 @item -fpie
12585 @itemx -fPIE
12586 @opindex fpie
12587 @opindex fPIE
12588 These options are similar to @option{-fpic} and @option{-fPIC}, but
12589 generated position independent code can be only linked into executables.
12590 Usually these options are used when @option{-pie} GCC option will be
12591 used during linking.
12592
12593 @item -fno-jump-tables
12594 @opindex fno-jump-tables
12595 Do not use jump tables for switch statements even where it would be
12596 more efficient than other code generation strategies.  This option is
12597 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12598 building code which forms part of a dynamic linker and cannot
12599 reference the address of a jump table.  On some targets, jump tables
12600 do not require a GOT and this option is not needed.
12601
12602 @item -ffixed-@var{reg}
12603 @opindex ffixed
12604 Treat the register named @var{reg} as a fixed register; generated code
12605 should never refer to it (except perhaps as a stack pointer, frame
12606 pointer or in some other fixed role).
12607
12608 @var{reg} must be the name of a register.  The register names accepted
12609 are machine-specific and are defined in the @code{REGISTER_NAMES}
12610 macro in the machine description macro file.
12611
12612 This flag does not have a negative form, because it specifies a
12613 three-way choice.
12614
12615 @item -fcall-used-@var{reg}
12616 @opindex fcall-used
12617 Treat the register named @var{reg} as an allocable register that is
12618 clobbered by function calls.  It may be allocated for temporaries or
12619 variables that do not live across a call.  Functions compiled this way
12620 will not save and restore the register @var{reg}.
12621
12622 It is an error to used this flag with the frame pointer or stack pointer.
12623 Use of this flag for other registers that have fixed pervasive roles in
12624 the machine's execution model will produce disastrous results.
12625
12626 This flag does not have a negative form, because it specifies a
12627 three-way choice.
12628
12629 @item -fcall-saved-@var{reg}
12630 @opindex fcall-saved
12631 Treat the register named @var{reg} as an allocable register saved by
12632 functions.  It may be allocated even for temporaries or variables that
12633 live across a call.  Functions compiled this way will save and restore
12634 the register @var{reg} if they use it.
12635
12636 It is an error to used this flag with the frame pointer or stack pointer.
12637 Use of this flag for other registers that have fixed pervasive roles in
12638 the machine's execution model will produce disastrous results.
12639
12640 A different sort of disaster will result from the use of this flag for
12641 a register in which function values may be returned.
12642
12643 This flag does not have a negative form, because it specifies a
12644 three-way choice.
12645
12646 @item -fpack-struct[=@var{n}]
12647 @opindex fpack-struct
12648 Without a value specified, pack all structure members together without
12649 holes.  When a value is specified (which must be a small power of two), pack
12650 structure members according to this value, representing the maximum
12651 alignment (that is, objects with default alignment requirements larger than
12652 this will be output potentially unaligned at the next fitting location.
12653
12654 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12655 code that is not binary compatible with code generated without that switch.
12656 Additionally, it makes the code suboptimal.
12657 Use it to conform to a non-default application binary interface.
12658
12659 @item -finstrument-functions
12660 @opindex finstrument-functions
12661 Generate instrumentation calls for entry and exit to functions.  Just
12662 after function entry and just before function exit, the following
12663 profiling functions will be called with the address of the current
12664 function and its call site.  (On some platforms,
12665 @code{__builtin_return_address} does not work beyond the current
12666 function, so the call site information may not be available to the
12667 profiling functions otherwise.)
12668
12669 @smallexample
12670 void __cyg_profile_func_enter (void *this_fn,
12671                                void *call_site);
12672 void __cyg_profile_func_exit  (void *this_fn,
12673                                void *call_site);
12674 @end smallexample
12675
12676 The first argument is the address of the start of the current function,
12677 which may be looked up exactly in the symbol table.
12678
12679 This instrumentation is also done for functions expanded inline in other
12680 functions.  The profiling calls will indicate where, conceptually, the
12681 inline function is entered and exited.  This means that addressable
12682 versions of such functions must be available.  If all your uses of a
12683 function are expanded inline, this may mean an additional expansion of
12684 code size.  If you use @samp{extern inline} in your C code, an
12685 addressable version of such functions must be provided.  (This is
12686 normally the case anyways, but if you get lucky and the optimizer always
12687 expands the functions inline, you might have gotten away without
12688 providing static copies.)
12689
12690 A function may be given the attribute @code{no_instrument_function}, in
12691 which case this instrumentation will not be done.  This can be used, for
12692 example, for the profiling functions listed above, high-priority
12693 interrupt routines, and any functions from which the profiling functions
12694 cannot safely be called (perhaps signal handlers, if the profiling
12695 routines generate output or allocate memory).
12696
12697 @item -fstack-check
12698 @opindex fstack-check
12699 Generate code to verify that you do not go beyond the boundary of the
12700 stack.  You should specify this flag if you are running in an
12701 environment with multiple threads, but only rarely need to specify it in
12702 a single-threaded environment since stack overflow is automatically
12703 detected on nearly all systems if there is only one stack.
12704
12705 Note that this switch does not actually cause checking to be done; the
12706 operating system must do that.  The switch causes generation of code
12707 to ensure that the operating system sees the stack being extended.
12708
12709 @item -fstack-limit-register=@var{reg}
12710 @itemx -fstack-limit-symbol=@var{sym}
12711 @itemx -fno-stack-limit
12712 @opindex fstack-limit-register
12713 @opindex fstack-limit-symbol
12714 @opindex fno-stack-limit
12715 Generate code to ensure that the stack does not grow beyond a certain value,
12716 either the value of a register or the address of a symbol.  If the stack
12717 would grow beyond the value, a signal is raised.  For most targets,
12718 the signal is raised before the stack overruns the boundary, so
12719 it is possible to catch the signal without taking special precautions.
12720
12721 For instance, if the stack starts at absolute address @samp{0x80000000}
12722 and grows downwards, you can use the flags
12723 @option{-fstack-limit-symbol=__stack_limit} and
12724 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12725 of 128KB@.  Note that this may only work with the GNU linker.
12726
12727 @cindex aliasing of parameters
12728 @cindex parameters, aliased
12729 @item -fargument-alias
12730 @itemx -fargument-noalias
12731 @itemx -fargument-noalias-global
12732 @opindex fargument-alias
12733 @opindex fargument-noalias
12734 @opindex fargument-noalias-global
12735 Specify the possible relationships among parameters and between
12736 parameters and global data.
12737
12738 @option{-fargument-alias} specifies that arguments (parameters) may
12739 alias each other and may alias global storage.@*
12740 @option{-fargument-noalias} specifies that arguments do not alias
12741 each other, but may alias global storage.@*
12742 @option{-fargument-noalias-global} specifies that arguments do not
12743 alias each other and do not alias global storage.
12744
12745 Each language will automatically use whatever option is required by
12746 the language standard.  You should not need to use these options yourself.
12747
12748 @item -fleading-underscore
12749 @opindex fleading-underscore
12750 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12751 change the way C symbols are represented in the object file.  One use
12752 is to help link with legacy assembly code.
12753
12754 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12755 generate code that is not binary compatible with code generated without that
12756 switch.  Use it to conform to a non-default application binary interface.
12757 Not all targets provide complete support for this switch.
12758
12759 @item -ftls-model=@var{model}
12760 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12761 The @var{model} argument should be one of @code{global-dynamic},
12762 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12763
12764 The default without @option{-fpic} is @code{initial-exec}; with
12765 @option{-fpic} the default is @code{global-dynamic}.
12766
12767 @item -fvisibility=@var{default|internal|hidden|protected}
12768 @opindex fvisibility
12769 Set the default ELF image symbol visibility to the specified option---all
12770 symbols will be marked with this unless overridden within the code.
12771 Using this feature can very substantially improve linking and
12772 load times of shared object libraries, produce more optimized
12773 code, provide near-perfect API export and prevent symbol clashes.
12774 It is @strong{strongly} recommended that you use this in any shared objects
12775 you distribute.
12776
12777 Despite the nomenclature, @code{default} always means public ie;
12778 available to be linked against from outside the shared object.
12779 @code{protected} and @code{internal} are pretty useless in real-world
12780 usage so the only other commonly used option will be @code{hidden}.
12781 The default if @option{-fvisibility} isn't specified is
12782 @code{default}, i.e., make every
12783 symbol public---this causes the same behavior as previous versions of
12784 GCC@.
12785
12786 A good explanation of the benefits offered by ensuring ELF
12787 symbols have the correct visibility is given by ``How To Write
12788 Shared Libraries'' by Ulrich Drepper (which can be found at
12789 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12790 solution made possible by this option to marking things hidden when
12791 the default is public is to make the default hidden and mark things
12792 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12793 and @code{__attribute__ ((visibility("default")))} instead of
12794 @code{__declspec(dllexport)} you get almost identical semantics with
12795 identical syntax.  This is a great boon to those working with
12796 cross-platform projects.
12797
12798 For those adding visibility support to existing code, you may find
12799 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12800 the declarations you wish to set visibility for with (for example)
12801 @samp{#pragma GCC visibility push(hidden)} and
12802 @samp{#pragma GCC visibility pop}.
12803 Bear in mind that symbol visibility should be viewed @strong{as
12804 part of the API interface contract} and thus all new code should
12805 always specify visibility when it is not the default ie; declarations
12806 only for use within the local DSO should @strong{always} be marked explicitly
12807 as hidden as so to avoid PLT indirection overheads---making this
12808 abundantly clear also aids readability and self-documentation of the code.
12809 Note that due to ISO C++ specification requirements, operator new and
12810 operator delete must always be of default visibility.
12811
12812 An overview of these techniques, their benefits and how to use them
12813 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12814
12815 @end table
12816
12817 @c man end
12818
12819 @node Environment Variables
12820 @section Environment Variables Affecting GCC
12821 @cindex environment variables
12822
12823 @c man begin ENVIRONMENT
12824 This section describes several environment variables that affect how GCC
12825 operates.  Some of them work by specifying directories or prefixes to use
12826 when searching for various kinds of files.  Some are used to specify other
12827 aspects of the compilation environment.
12828
12829 Note that you can also specify places to search using options such as
12830 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12831 take precedence over places specified using environment variables, which
12832 in turn take precedence over those specified by the configuration of GCC@.
12833 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12834 GNU Compiler Collection (GCC) Internals}.
12835
12836 @table @env
12837 @item LANG
12838 @itemx LC_CTYPE
12839 @c @itemx LC_COLLATE
12840 @itemx LC_MESSAGES
12841 @c @itemx LC_MONETARY
12842 @c @itemx LC_NUMERIC
12843 @c @itemx LC_TIME
12844 @itemx LC_ALL
12845 @findex LANG
12846 @findex LC_CTYPE
12847 @c @findex LC_COLLATE
12848 @findex LC_MESSAGES
12849 @c @findex LC_MONETARY
12850 @c @findex LC_NUMERIC
12851 @c @findex LC_TIME
12852 @findex LC_ALL
12853 @cindex locale
12854 These environment variables control the way that GCC uses
12855 localization information that allow GCC to work with different
12856 national conventions.  GCC inspects the locale categories
12857 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12858 so.  These locale categories can be set to any value supported by your
12859 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12860 Kingdom encoded in UTF-8.
12861
12862 The @env{LC_CTYPE} environment variable specifies character
12863 classification.  GCC uses it to determine the character boundaries in
12864 a string; this is needed for some multibyte encodings that contain quote
12865 and escape characters that would otherwise be interpreted as a string
12866 end or escape.
12867
12868 The @env{LC_MESSAGES} environment variable specifies the language to
12869 use in diagnostic messages.
12870
12871 If the @env{LC_ALL} environment variable is set, it overrides the value
12872 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12873 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12874 environment variable.  If none of these variables are set, GCC
12875 defaults to traditional C English behavior.
12876
12877 @item TMPDIR
12878 @findex TMPDIR
12879 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12880 files.  GCC uses temporary files to hold the output of one stage of
12881 compilation which is to be used as input to the next stage: for example,
12882 the output of the preprocessor, which is the input to the compiler
12883 proper.
12884
12885 @item GCC_EXEC_PREFIX
12886 @findex GCC_EXEC_PREFIX
12887 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12888 names of the subprograms executed by the compiler.  No slash is added
12889 when this prefix is combined with the name of a subprogram, but you can
12890 specify a prefix that ends with a slash if you wish.
12891
12892 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12893 an appropriate prefix to use based on the pathname it was invoked with.
12894
12895 If GCC cannot find the subprogram using the specified prefix, it
12896 tries looking in the usual places for the subprogram.
12897
12898 The default value of @env{GCC_EXEC_PREFIX} is
12899 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12900 of @code{prefix} when you ran the @file{configure} script.
12901
12902 Other prefixes specified with @option{-B} take precedence over this prefix.
12903
12904 This prefix is also used for finding files such as @file{crt0.o} that are
12905 used for linking.
12906
12907 In addition, the prefix is used in an unusual way in finding the
12908 directories to search for header files.  For each of the standard
12909 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12910 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12911 replacing that beginning with the specified prefix to produce an
12912 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12913 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12914 These alternate directories are searched first; the standard directories
12915 come next.
12916
12917 @item COMPILER_PATH
12918 @findex COMPILER_PATH
12919 The value of @env{COMPILER_PATH} is a colon-separated list of
12920 directories, much like @env{PATH}.  GCC tries the directories thus
12921 specified when searching for subprograms, if it can't find the
12922 subprograms using @env{GCC_EXEC_PREFIX}.
12923
12924 @item LIBRARY_PATH
12925 @findex LIBRARY_PATH
12926 The value of @env{LIBRARY_PATH} is a colon-separated list of
12927 directories, much like @env{PATH}.  When configured as a native compiler,
12928 GCC tries the directories thus specified when searching for special
12929 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12930 using GCC also uses these directories when searching for ordinary
12931 libraries for the @option{-l} option (but directories specified with
12932 @option{-L} come first).
12933
12934 @item LANG
12935 @findex LANG
12936 @cindex locale definition
12937 This variable is used to pass locale information to the compiler.  One way in
12938 which this information is used is to determine the character set to be used
12939 when character literals, string literals and comments are parsed in C and C++.
12940 When the compiler is configured to allow multibyte characters,
12941 the following values for @env{LANG} are recognized:
12942
12943 @table @samp
12944 @item C-JIS
12945 Recognize JIS characters.
12946 @item C-SJIS
12947 Recognize SJIS characters.
12948 @item C-EUCJP
12949 Recognize EUCJP characters.
12950 @end table
12951
12952 If @env{LANG} is not defined, or if it has some other value, then the
12953 compiler will use mblen and mbtowc as defined by the default locale to
12954 recognize and translate multibyte characters.
12955 @end table
12956
12957 @noindent
12958 Some additional environments variables affect the behavior of the
12959 preprocessor.
12960
12961 @include cppenv.texi
12962
12963 @c man end
12964
12965 @node Precompiled Headers
12966 @section Using Precompiled Headers
12967 @cindex precompiled headers
12968 @cindex speed of compilation
12969
12970 Often large projects have many header files that are included in every
12971 source file.  The time the compiler takes to process these header files
12972 over and over again can account for nearly all of the time required to
12973 build the project.  To make builds faster, GCC allows users to
12974 `precompile' a header file; then, if builds can use the precompiled
12975 header file they will be much faster.
12976
12977 To create a precompiled header file, simply compile it as you would any
12978 other file, if necessary using the @option{-x} option to make the driver
12979 treat it as a C or C++ header file.  You will probably want to use a
12980 tool like @command{make} to keep the precompiled header up-to-date when
12981 the headers it contains change.
12982
12983 A precompiled header file will be searched for when @code{#include} is
12984 seen in the compilation.  As it searches for the included file
12985 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12986 compiler looks for a precompiled header in each directory just before it
12987 looks for the include file in that directory.  The name searched for is
12988 the name specified in the @code{#include} with @samp{.gch} appended.  If
12989 the precompiled header file can't be used, it is ignored.
12990
12991 For instance, if you have @code{#include "all.h"}, and you have
12992 @file{all.h.gch} in the same directory as @file{all.h}, then the
12993 precompiled header file will be used if possible, and the original
12994 header will be used otherwise.
12995
12996 Alternatively, you might decide to put the precompiled header file in a
12997 directory and use @option{-I} to ensure that directory is searched
12998 before (or instead of) the directory containing the original header.
12999 Then, if you want to check that the precompiled header file is always
13000 used, you can put a file of the same name as the original header in this
13001 directory containing an @code{#error} command.
13002
13003 This also works with @option{-include}.  So yet another way to use
13004 precompiled headers, good for projects not designed with precompiled
13005 header files in mind, is to simply take most of the header files used by
13006 a project, include them from another header file, precompile that header
13007 file, and @option{-include} the precompiled header.  If the header files
13008 have guards against multiple inclusion, they will be skipped because
13009 they've already been included (in the precompiled header).
13010
13011 If you need to precompile the same header file for different
13012 languages, targets, or compiler options, you can instead make a
13013 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13014 header in the directory, perhaps using @option{-o}.  It doesn't matter
13015 what you call the files in the directory, every precompiled header in
13016 the directory will be considered.  The first precompiled header
13017 encountered in the directory that is valid for this compilation will
13018 be used; they're searched in no particular order.
13019
13020 There are many other possibilities, limited only by your imagination,
13021 good sense, and the constraints of your build system.
13022
13023 A precompiled header file can be used only when these conditions apply:
13024
13025 @itemize
13026 @item
13027 Only one precompiled header can be used in a particular compilation.
13028
13029 @item
13030 A precompiled header can't be used once the first C token is seen.  You
13031 can have preprocessor directives before a precompiled header; you can
13032 even include a precompiled header from inside another header, so long as
13033 there are no C tokens before the @code{#include}.
13034
13035 @item
13036 The precompiled header file must be produced for the same language as
13037 the current compilation.  You can't use a C precompiled header for a C++
13038 compilation.
13039
13040 @item
13041 The precompiled header file must have been produced by the same compiler
13042 binary as the current compilation is using.
13043
13044 @item
13045 Any macros defined before the precompiled header is included must
13046 either be defined in the same way as when the precompiled header was
13047 generated, or must not affect the precompiled header, which usually
13048 means that they don't appear in the precompiled header at all.
13049
13050 The @option{-D} option is one way to define a macro before a
13051 precompiled header is included; using a @code{#define} can also do it.
13052 There are also some options that define macros implicitly, like
13053 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13054 defined this way.
13055
13056 @item If debugging information is output when using the precompiled
13057 header, using @option{-g} or similar, the same kind of debugging information
13058 must have been output when building the precompiled header.  However,
13059 a precompiled header built using @option{-g} can be used in a compilation
13060 when no debugging information is being output.
13061
13062 @item The same @option{-m} options must generally be used when building
13063 and using the precompiled header.  @xref{Submodel Options},
13064 for any cases where this rule is relaxed.
13065
13066 @item Each of the following options must be the same when building and using
13067 the precompiled header:
13068
13069 @gccoptlist{-fexceptions -funit-at-a-time}
13070
13071 @item
13072 Some other command-line options starting with @option{-f},
13073 @option{-p}, or @option{-O} must be defined in the same way as when
13074 the precompiled header was generated.  At present, it's not clear
13075 which options are safe to change and which are not; the safest choice
13076 is to use exactly the same options when generating and using the
13077 precompiled header.  The following are known to be safe:
13078
13079 @gccoptlist{-fpreprocessed
13080 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13081 -fsched-verbose=<number> -fschedule-insns
13082 -pedantic-errors}
13083
13084 @end itemize
13085
13086 For all of these except the last, the compiler will automatically
13087 ignore the precompiled header if the conditions aren't met.  If you
13088 find an option combination that doesn't work and doesn't cause the
13089 precompiled header to be ignored, please consider filing a bug report,
13090 see @ref{Bugs}.
13091
13092 If you do use differing options when generating and using the
13093 precompiled header, the actual behavior will be a mixture of the
13094 behavior for the options.  For instance, if you use @option{-g} to
13095 generate the precompiled header but not when using it, you may or may
13096 not get debugging information for routines in the precompiled header.
13097
13098 @node Running Protoize
13099 @section Running Protoize
13100
13101 The program @code{protoize} is an optional part of GCC@.  You can use
13102 it to add prototypes to a program, thus converting the program to ISO
13103 C in one respect.  The companion program @code{unprotoize} does the
13104 reverse: it removes argument types from any prototypes that are found.
13105
13106 When you run these programs, you must specify a set of source files as
13107 command line arguments.  The conversion programs start out by compiling
13108 these files to see what functions they define.  The information gathered
13109 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13110
13111 After scanning comes actual conversion.  The specified files are all
13112 eligible to be converted; any files they include (whether sources or
13113 just headers) are eligible as well.
13114
13115 But not all the eligible files are converted.  By default,
13116 @code{protoize} and @code{unprotoize} convert only source and header
13117 files in the current directory.  You can specify additional directories
13118 whose files should be converted with the @option{-d @var{directory}}
13119 option.  You can also specify particular files to exclude with the
13120 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13121 directory name matches one of the specified directory names, and its
13122 name within the directory has not been excluded.
13123
13124 Basic conversion with @code{protoize} consists of rewriting most
13125 function definitions and function declarations to specify the types of
13126 the arguments.  The only ones not rewritten are those for varargs
13127 functions.
13128
13129 @code{protoize} optionally inserts prototype declarations at the
13130 beginning of the source file, to make them available for any calls that
13131 precede the function's definition.  Or it can insert prototype
13132 declarations with block scope in the blocks where undeclared functions
13133 are called.
13134
13135 Basic conversion with @code{unprotoize} consists of rewriting most
13136 function declarations to remove any argument types, and rewriting
13137 function definitions to the old-style pre-ISO form.
13138
13139 Both conversion programs print a warning for any function declaration or
13140 definition that they can't convert.  You can suppress these warnings
13141 with @option{-q}.
13142
13143 The output from @code{protoize} or @code{unprotoize} replaces the
13144 original source file.  The original file is renamed to a name ending
13145 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13146 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13147 for DOS) file already exists, then the source file is simply discarded.
13148
13149 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13150 scan the program and collect information about the functions it uses.
13151 So neither of these programs will work until GCC is installed.
13152
13153 Here is a table of the options you can use with @code{protoize} and
13154 @code{unprotoize}.  Each option works with both programs unless
13155 otherwise stated.
13156
13157 @table @code
13158 @item -B @var{directory}
13159 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13160 usual directory (normally @file{/usr/local/lib}).  This file contains
13161 prototype information about standard system functions.  This option
13162 applies only to @code{protoize}.
13163
13164 @item -c @var{compilation-options}
13165 Use @var{compilation-options} as the options when running @command{gcc} to
13166 produce the @samp{.X} files.  The special option @option{-aux-info} is
13167 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13168
13169 Note that the compilation options must be given as a single argument to
13170 @code{protoize} or @code{unprotoize}.  If you want to specify several
13171 @command{gcc} options, you must quote the entire set of compilation options
13172 to make them a single word in the shell.
13173
13174 There are certain @command{gcc} arguments that you cannot use, because they
13175 would produce the wrong kind of output.  These include @option{-g},
13176 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13177 the @var{compilation-options}, they are ignored.
13178
13179 @item -C
13180 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13181 systems) instead of @samp{.c}.  This is convenient if you are converting
13182 a C program to C++.  This option applies only to @code{protoize}.
13183
13184 @item -g
13185 Add explicit global declarations.  This means inserting explicit
13186 declarations at the beginning of each source file for each function
13187 that is called in the file and was not declared.  These declarations
13188 precede the first function definition that contains a call to an
13189 undeclared function.  This option applies only to @code{protoize}.
13190
13191 @item -i @var{string}
13192 Indent old-style parameter declarations with the string @var{string}.
13193 This option applies only to @code{protoize}.
13194
13195 @code{unprotoize} converts prototyped function definitions to old-style
13196 function definitions, where the arguments are declared between the
13197 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13198 uses five spaces as the indentation.  If you want to indent with just
13199 one space instead, use @option{-i " "}.
13200
13201 @item -k
13202 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13203 is finished.
13204
13205 @item -l
13206 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13207 a prototype declaration for each function in each block which calls the
13208 function without any declaration.  This option applies only to
13209 @code{protoize}.
13210
13211 @item -n
13212 Make no real changes.  This mode just prints information about the conversions
13213 that would have been done without @option{-n}.
13214
13215 @item -N
13216 Make no @samp{.save} files.  The original files are simply deleted.
13217 Use this option with caution.
13218
13219 @item -p @var{program}
13220 Use the program @var{program} as the compiler.  Normally, the name
13221 @file{gcc} is used.
13222
13223 @item -q
13224 Work quietly.  Most warnings are suppressed.
13225
13226 @item -v
13227 Print the version number, just like @option{-v} for @command{gcc}.
13228 @end table
13229
13230 If you need special compiler options to compile one of your program's
13231 source files, then you should generate that file's @samp{.X} file
13232 specially, by running @command{gcc} on that source file with the
13233 appropriate options and the option @option{-aux-info}.  Then run
13234 @code{protoize} on the entire set of files.  @code{protoize} will use
13235 the existing @samp{.X} file because it is newer than the source file.
13236 For example:
13237
13238 @smallexample
13239 gcc -Dfoo=bar file1.c -aux-info file1.X
13240 protoize *.c
13241 @end smallexample
13242
13243 @noindent
13244 You need to include the special files along with the rest in the
13245 @code{protoize} command, even though their @samp{.X} files already
13246 exist, because otherwise they won't get converted.
13247
13248 @xref{Protoize Caveats}, for more information on how to use
13249 @code{protoize} successfully.