OSDN Git Service

* tree-ssa-loop-ivcanon.c: New file.
[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 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 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}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
147
148 @c man begin OPTIONS
149
150 @node Option Summary
151 @section Option Summary
152
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
155
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
206
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
240
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement}
246
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-all @gol
253 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
254 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
255 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
257 -fdump-tree-ch @gol
258 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-nrv -fdump-tree-vect @gol
267 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
269 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
270 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
271 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
272 -ftest-coverage  -ftime-report -fvar-tracking @gol
273 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
274 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
275 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
276 -print-multi-directory  -print-multi-lib @gol
277 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
278 -save-temps  -time}
279
280 @item Optimization Options
281 @xref{Optimize Options,,Options that Control Optimization}.
282 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
283 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
284 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
285 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
286 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
287 -fcaller-saves  -fcprop-registers @gol
288 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
289 -fdelayed-branch  -fdelete-null-pointer-checks @gol
290 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
291 -fforce-addr  -fforce-mem  -ffunction-sections @gol
292 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
293 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
294 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
295 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
296 -fmodulo-sched -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
297 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
298 -fno-function-cse  -fno-guess-branch-probability @gol
299 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
300 -funsafe-math-optimizations  -ffinite-math-only @gol
301 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
302 -fomit-frame-pointer  -foptimize-register-move @gol
303 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
304 -fprofile-generate -fprofile-use @gol
305 -freduce-all-givs  -fregmove  -frename-registers @gol
306 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
307 -frerun-cse-after-loop  -frerun-loop-opt @gol
308 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
309 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
310 -fsched-spec-load-dangerous  @gol
311 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
312 -fsched2-use-superblocks @gol
313 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
314 -fsignaling-nans -fsingle-precision-constant  @gol
315 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
316 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
317 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
318 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
319 -ftree-lim -fivcanon @gol
320 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
321 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
322 --param @var{name}=@var{value}
323 -O  -O0  -O1  -O2  -O3  -Os}
324
325 @item Preprocessor Options
326 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
327 @gccoptlist{-A@var{question}=@var{answer} @gol
328 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
329 -C  -dD  -dI  -dM  -dN @gol
330 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
331 -idirafter @var{dir} @gol
332 -include @var{file}  -imacros @var{file} @gol
333 -iprefix @var{file}  -iwithprefix @var{dir} @gol
334 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
335 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
336 -P  -fworking-directory  -remap @gol
337 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
338 -Xpreprocessor @var{option}}
339
340 @item Assembler Option
341 @xref{Assembler Options,,Passing Options to the Assembler}.
342 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
343
344 @item Linker Options
345 @xref{Link Options,,Options for Linking}.
346 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
347 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
348 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
349 -Wl,@var{option}  -Xlinker @var{option} @gol
350 -u @var{symbol}}
351
352 @item Directory Options
353 @xref{Directory Options,,Options for Directory Search}.
354 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
355
356 @item Target Options
357 @c I wrote this xref this way to avoid overfull hbox. -- rms
358 @xref{Target Options}.
359 @gccoptlist{-V @var{version}  -b @var{machine}}
360
361 @item Machine Dependent Options
362 @xref{Submodel Options,,Hardware Models and Configurations}.
363 @c This list is ordered alphanumerically by subsection name.
364 @c Try and put the significant identifier (CPU or system) first,
365 @c so users have a clue at guessing where the ones they want will be.
366
367 @emph{ARC Options}
368 @gccoptlist{-EB  -EL @gol
369 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
370 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
371
372 @emph{ARM Options}
373 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
374 -mabi=@var{name} @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
381 -mthumb-interwork  -mno-thumb-interwork @gol
382 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
383 -mstructure-size-boundary=@var{n} @gol
384 -mabort-on-noreturn @gol
385 -mlong-calls  -mno-long-calls @gol
386 -msingle-pic-base  -mno-single-pic-base @gol
387 -mpic-register=@var{reg} @gol
388 -mnop-fun-dllimport @gol
389 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
390 -mpoke-function-name @gol
391 -mthumb  -marm @gol
392 -mtpcs-frame  -mtpcs-leaf-frame @gol
393 -mcaller-super-interworking  -mcallee-super-interworking}
394
395 @emph{AVR Options}
396 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
397 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
398
399 @emph{CRIS Options}
400 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
401 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
402 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
403 -mstack-align  -mdata-align  -mconst-align @gol
404 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
405 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
406 -mmul-bug-workaround  -mno-mul-bug-workaround}
407
408 @emph{Darwin Options}
409 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
410 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
411 -client_name  -compatibility_version  -current_version @gol
412 -dead_strip @gol
413 -dependency-file  -dylib_file  -dylinker_install_name @gol
414 -dynamic  -dynamiclib  -exported_symbols_list @gol
415 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
416 -force_flat_namespace  -headerpad_max_install_names @gol
417 -image_base  -init  -install_name  -keep_private_externs @gol
418 -multi_module  -multiply_defined  -multiply_defined_unused @gol
419 -noall_load   -no_dead_strip_inits_and_terms @gol
420 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
421 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
422 -private_bundle  -read_only_relocs  -sectalign @gol
423 -sectobjectsymbols  -whyload  -seg1addr @gol
424 -sectcreate  -sectobjectsymbols  -sectorder @gol
425 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
426 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
427 -single_module  -static  -sub_library  -sub_umbrella @gol
428 -twolevel_namespace  -umbrella  -undefined @gol
429 -unexported_symbols_list  -weak_reference_mismatches @gol
430 -whatsloaded -F -gused -gfull -mone-byte-bool}
431
432 @emph{DEC Alpha Options}
433 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
434 -mieee  -mieee-with-inexact  -mieee-conformant @gol
435 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
436 -mtrap-precision=@var{mode}  -mbuild-constants @gol
437 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
438 -mbwx  -mmax  -mfix  -mcix @gol
439 -mfloat-vax  -mfloat-ieee @gol
440 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
441 -msmall-text  -mlarge-text @gol
442 -mmemory-latency=@var{time}}
443
444 @emph{DEC Alpha/VMS Options}
445 @gccoptlist{-mvms-return-codes}
446
447 @emph{FRV Options}
448 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
449 -mhard-float  -msoft-float @gol
450 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
451 -mdouble  -mno-double @gol
452 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
453 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic -mlinked-fp @gol
454 -mlibrary-pic  -macc-4 -macc-8 @gol
455 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
456 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
457 -mvliw-branch  -mno-vliw-branch @gol
458 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
459 -mno-nested-cond-exec  -mtomcat-stats @gol
460 -mcpu=@var{cpu}}
461
462 @emph{H8/300 Options}
463 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
464
465 @emph{HPPA Options}
466 @gccoptlist{-march=@var{architecture-type} @gol
467 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
468 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
469 -mfixed-range=@var{register-range} @gol
470 -mjump-in-delay -mlinker-opt -mlong-calls @gol
471 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
472 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
473 -mno-jump-in-delay  -mno-long-load-store @gol
474 -mno-portable-runtime  -mno-soft-float @gol
475 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
476 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
477 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
478 -nolibdld  -static  -threads}
479
480 @emph{i386 and x86-64 Options}
481 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
482 -mfpmath=@var{unit} @gol
483 -masm=@var{dialect}  -mno-fancy-math-387 @gol
484 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
485 -mno-wide-multiply  -mrtd  -malign-double @gol
486 -mpreferred-stack-boundary=@var{num} @gol
487 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
488 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
489 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
490 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
491 -mno-red-zone -mno-tls-direct-seg-refs @gol
492 -mcmodel=@var{code-model} @gol
493 -m32  -m64}
494
495 @emph{IA-64 Options}
496 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
497 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
498 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
499 -minline-float-divide-max-throughput @gol
500 -minline-int-divide-min-latency @gol
501 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
502 -mfixed-range=@var{register-range}}
503
504 @emph{M32R/D Options}
505 @gccoptlist{-m32r2 -m32rx -m32r @gol
506 -mdebug @gol
507 -malign-loops -mno-align-loops @gol
508 -missue-rate=@var{number} @gol
509 -mbranch-cost=@var{number} @gol
510 -mmodel=@var{code-size-model-type} @gol
511 -msdata=@var{sdata-type} @gol
512 -mno-flush-func -mflush-func=@var{name} @gol
513 -mno-flush-trap -mflush-trap=@var{number} @gol
514 -G @var{num}}
515
516 @emph{M680x0 Options}
517 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
518 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
519 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
520 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
521 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
522
523 @emph{M68hc1x Options}
524 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
525 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
526 -msoft-reg-count=@var{count}}
527
528 @emph{MCore Options}
529 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
530 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
531 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
532 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
533 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
534
535 @emph{MIPS Options}
536 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
537 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
538 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
539 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
540 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
541 -mint64  -mlong64  -mlong32 @gol
542 -G@var{num}  -membedded-data  -mno-embedded-data @gol
543 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
544 -msplit-addresses  -mno-split-addresses  @gol
545 -mexplicit-relocs  -mno-explicit-relocs  @gol
546 -mcheck-zero-division  -mno-check-zero-division @gol
547 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
548 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
549 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
550 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
551 -mflush-func=@var{func}  -mno-flush-func @gol
552 -mbranch-likely  -mno-branch-likely @gol
553 -mfp-exceptions -mno-fp-exceptions @gol
554 -mvr4130-align -mno-vr4130-align}
555
556 @emph{MMIX Options}
557 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
558 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
559 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
560 -mno-base-addresses  -msingle-exit  -mno-single-exit}
561
562 @emph{MN10300 Options}
563 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
564 -mam33  -mno-am33 @gol
565 -mam33-2  -mno-am33-2 @gol
566 -mno-crt0  -mrelax}
567
568 @emph{NS32K Options}
569 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
570 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
571 -mregparam  -mnoregparam  -msb  -mnosb @gol
572 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
573
574 @emph{PDP-11 Options}
575 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
576 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
577 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
578 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
579 -mbranch-expensive  -mbranch-cheap @gol
580 -msplit  -mno-split  -munix-asm  -mdec-asm}
581
582 @emph{PowerPC Options}
583 See RS/6000 and PowerPC Options.
584
585 @emph{RS/6000 and PowerPC Options}
586 @gccoptlist{-mcpu=@var{cpu-type} @gol
587 -mtune=@var{cpu-type} @gol
588 -mpower  -mno-power  -mpower2  -mno-power2 @gol
589 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
590 -maltivec  -mno-altivec @gol
591 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
592 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
593 -mnew-mnemonics  -mold-mnemonics @gol
594 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
595 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
596 -malign-power  -malign-natural @gol
597 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
598 -mstring  -mno-string  -mupdate  -mno-update @gol
599 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
600 -mstrict-align  -mno-strict-align  -mrelocatable @gol
601 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
602 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
603 -mdynamic-no-pic @gol
604 -mprioritize-restricted-insns=@var{priority} @gol
605 -msched-costly-dep=@var{dependence_type} @gol
606 -minsert-sched-nops=@var{scheme} @gol
607 -mcall-sysv  -mcall-netbsd @gol
608 -maix-struct-return  -msvr4-struct-return @gol
609 -mabi=altivec  -mabi=no-altivec @gol
610 -mabi=spe  -mabi=no-spe @gol
611 -misel=yes  -misel=no @gol
612 -mspe=yes  -mspe=no @gol
613 -mfloat-gprs=yes  -mfloat-gprs=no @gol
614 -mprototype  -mno-prototype @gol
615 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
616 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
617
618 @emph{S/390 and zSeries Options}
619 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
620 -mhard-float  -msoft-float  -mbackchain  -mno-backchain -mkernel-backchain @gol
621 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
622 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
623 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
624 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
625
626 @emph{SH Options}
627 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
628 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
629 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
630 -m5-64media  -m5-64media-nofpu @gol
631 -m5-32media  -m5-32media-nofpu @gol
632 -m5-compact  -m5-compact-nofpu @gol
633 -mb  -ml  -mdalign  -mrelax @gol
634 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
635 -mieee  -misize  -mpadstruct  -mspace @gol
636 -mprefergot  -musermode}
637
638 @emph{SPARC Options}
639 @gccoptlist{-mcpu=@var{cpu-type} @gol
640 -mtune=@var{cpu-type} @gol
641 -mcmodel=@var{code-model} @gol
642 -m32  -m64  -mapp-regs  -mno-app-regs @gol
643 -mfaster-structs  -mno-faster-structs @gol
644 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
645 -mhard-quad-float  -msoft-quad-float @gol
646 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
647 -mstack-bias  -mno-stack-bias @gol
648 -munaligned-doubles  -mno-unaligned-doubles @gol
649 -mv8plus  -mno-v8plus  -mvis  -mno-vis
650 -threads -pthreads}
651
652 @emph{System V Options}
653 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
654
655 @emph{TMS320C3x/C4x Options}
656 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
657 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
658 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
659 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
660
661 @emph{V850 Options}
662 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
663 -mprolog-function  -mno-prolog-function  -mspace @gol
664 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
665 -mapp-regs  -mno-app-regs @gol
666 -mdisable-callt  -mno-disable-callt @gol
667 -mv850e1 @gol
668 -mv850e @gol
669 -mv850  -mbig-switch}
670
671 @emph{VAX Options}
672 @gccoptlist{-mg  -mgnu  -munix}
673
674 @emph{x86-64 Options}
675 See i386 and x86-64 Options.
676
677 @emph{Xstormy16 Options}
678 @gccoptlist{-msim}
679
680 @emph{Xtensa Options}
681 @gccoptlist{-mconst16 -mno-const16 @gol
682 -mfused-madd  -mno-fused-madd @gol
683 -mtext-section-literals  -mno-text-section-literals @gol
684 -mtarget-align  -mno-target-align @gol
685 -mlongcalls  -mno-longcalls}
686
687 @emph{zSeries Options}
688 See S/390 and zSeries Options.
689
690 @item Code Generation Options
691 @xref{Code Gen Options,,Options for Code Generation Conventions}.
692 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
693 -ffixed-@var{reg}  -fexceptions @gol
694 -fnon-call-exceptions  -funwind-tables @gol
695 -fasynchronous-unwind-tables @gol
696 -finhibit-size-directive  -finstrument-functions @gol
697 -fno-common  -fno-ident @gol
698 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
699 -freg-struct-return  -fshared-data  -fshort-enums @gol
700 -fshort-double  -fshort-wchar @gol
701 -fverbose-asm  -fpack-struct  -fstack-check @gol
702 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
703 -fargument-alias  -fargument-noalias @gol
704 -fargument-noalias-global  -fleading-underscore @gol
705 -ftls-model=@var{model} @gol
706 -ftrapv  -fwrapv  -fbounds-check @gol
707 -fvisibility}
708 @end table
709
710 @menu
711 * Overall Options::     Controlling the kind of output:
712                         an executable, object files, assembler files,
713                         or preprocessed source.
714 * C Dialect Options::   Controlling the variant of C language compiled.
715 * C++ Dialect Options:: Variations on C++.
716 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
717                         and Objective-C++.
718 * Language Independent Options:: Controlling how diagnostics should be
719                         formatted.
720 * Warning Options::     How picky should the compiler be?
721 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
722 * Optimize Options::    How much optimization?
723 * Preprocessor Options:: Controlling header files and macro definitions.
724                          Also, getting dependency information for Make.
725 * Assembler Options::   Passing options to the assembler.
726 * Link Options::        Specifying libraries and so on.
727 * Directory Options::   Where to find header files and libraries.
728                         Where to find the compiler executable files.
729 * Spec Files::          How to pass switches to sub-processes.
730 * Target Options::      Running a cross-compiler, or an old version of GCC.
731 @end menu
732
733 @node Overall Options
734 @section Options Controlling the Kind of Output
735
736 Compilation can involve up to four stages: preprocessing, compilation
737 proper, assembly and linking, always in that order.  GCC is capable of
738 preprocessing and compiling several files either into several
739 assembler input files, or into one assembler input file; then each
740 assembler input file produces an object file, and linking combines all
741 the object files (those newly compiled, and those specified as input)
742 into an executable file.
743
744 @cindex file name suffix
745 For any given input file, the file name suffix determines what kind of
746 compilation is done:
747
748 @table @gcctabopt
749 @item @var{file}.c
750 C source code which must be preprocessed.
751
752 @item @var{file}.i
753 C source code which should not be preprocessed.
754
755 @item @var{file}.ii
756 C++ source code which should not be preprocessed.
757
758 @item @var{file}.m
759 Objective-C source code.  Note that you must link with the @file{libobjc}
760 library to make an Objective-C program work.
761
762 @item @var{file}.mi
763 Objective-C source code which should not be preprocessed.
764
765 @item @var{file}.mm
766 @itemx @var{file}.M
767 Objective-C++ source code.  Note that you must link with the @file{libobjc}
768 library to make an Objective-C++ program work.  Note that @samp{.M} refers
769 to a literal capital M@.
770
771 @item @var{file}.mii
772 Objective-C++ source code which should not be preprocessed.
773
774 @item @var{file}.h
775 C, C++, Objective-C or Objective-C++ header file to be turned into a
776 precompiled header.
777
778 @item @var{file}.cc
779 @itemx @var{file}.cp
780 @itemx @var{file}.cxx
781 @itemx @var{file}.cpp
782 @itemx @var{file}.CPP
783 @itemx @var{file}.c++
784 @itemx @var{file}.C
785 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
786 the last two letters must both be literally @samp{x}.  Likewise,
787 @samp{.C} refers to a literal capital C@.
788
789 @item @var{file}.hh
790 @itemx @var{file}.H
791 C++ header file to be turned into a precompiled header.
792
793 @item @var{file}.f
794 @itemx @var{file}.for
795 @itemx @var{file}.FOR
796 Fortran source code which should not be preprocessed.
797
798 @item @var{file}.F
799 @itemx @var{file}.fpp
800 @itemx @var{file}.FPP
801 Fortran source code which must be preprocessed (with the traditional
802 preprocessor).
803
804 @item @var{file}.r
805 Fortran source code which must be preprocessed with a RATFOR
806 preprocessor (not included with GCC)@.
807
808 @item @var{file}.f90
809 @itemx @var{file}.f95
810 Fortran 90/95 source code which should not be preprocessed.
811
812 @c FIXME: Descriptions of Java file types.
813 @c @var{file}.java
814 @c @var{file}.class
815 @c @var{file}.zip
816 @c @var{file}.jar
817
818 @item @var{file}.ads
819 Ada source code file which contains a library unit declaration (a
820 declaration of a package, subprogram, or generic, or a generic
821 instantiation), or a library unit renaming declaration (a package,
822 generic, or subprogram renaming declaration).  Such files are also
823 called @dfn{specs}.
824
825 @itemx @var{file}.adb
826 Ada source code file containing a library unit body (a subprogram or
827 package body).  Such files are also called @dfn{bodies}.
828
829 @c GCC also knows about some suffixes for languages not yet included:
830 @c Pascal:
831 @c @var{file}.p
832 @c @var{file}.pas
833
834 @item @var{file}.s
835 Assembler code.
836
837 @item @var{file}.S
838 Assembler code which must be preprocessed.
839
840 @item @var{other}
841 An object file to be fed straight into linking.
842 Any file name with no recognized suffix is treated this way.
843 @end table
844
845 @opindex x
846 You can specify the input language explicitly with the @option{-x} option:
847
848 @table @gcctabopt
849 @item -x @var{language}
850 Specify explicitly the @var{language} for the following input files
851 (rather than letting the compiler choose a default based on the file
852 name suffix).  This option applies to all following input files until
853 the next @option{-x} option.  Possible values for @var{language} are:
854 @smallexample
855 c  c-header  c-cpp-output
856 c++  c++-header  c++-cpp-output
857 objective-c  objective-c-header  objective-c-cpp-output
858 objective-c++ objective-c++-header objective-c++-cpp-output
859 assembler  assembler-with-cpp
860 ada
861 f77  f77-cpp-input  ratfor
862 f95
863 java
864 treelang
865 @end smallexample
866
867 @item -x none
868 Turn off any specification of a language, so that subsequent files are
869 handled according to their file name suffixes (as they are if @option{-x}
870 has not been used at all).
871
872 @item -pass-exit-codes
873 @opindex pass-exit-codes
874 Normally the @command{gcc} program will exit with the code of 1 if any
875 phase of the compiler returns a non-success return code.  If you specify
876 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
877 numerically highest error produced by any phase that returned an error
878 indication.
879 @end table
880
881 If you only want some of the stages of compilation, you can use
882 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
883 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
884 @command{gcc} is to stop.  Note that some combinations (for example,
885 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
886
887 @table @gcctabopt
888 @item -c
889 @opindex c
890 Compile or assemble the source files, but do not link.  The linking
891 stage simply is not done.  The ultimate output is in the form of an
892 object file for each source file.
893
894 By default, the object file name for a source file is made by replacing
895 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
896
897 Unrecognized input files, not requiring compilation or assembly, are
898 ignored.
899
900 @item -S
901 @opindex S
902 Stop after the stage of compilation proper; do not assemble.  The output
903 is in the form of an assembler code file for each non-assembler input
904 file specified.
905
906 By default, the assembler file name for a source file is made by
907 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
908
909 Input files that don't require compilation are ignored.
910
911 @item -E
912 @opindex E
913 Stop after the preprocessing stage; do not run the compiler proper.  The
914 output is in the form of preprocessed source code, which is sent to the
915 standard output.
916
917 Input files which don't require preprocessing are ignored.
918
919 @cindex output file option
920 @item -o @var{file}
921 @opindex o
922 Place output in file @var{file}.  This applies regardless to whatever
923 sort of output is being produced, whether it be an executable file,
924 an object file, an assembler file or preprocessed C code.
925
926 If @option{-o} is not specified, the default is to put an executable
927 file in @file{a.out}, the object file for
928 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
929 assembler file in @file{@var{source}.s}, a precompiled header file in
930 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
931 standard output.
932
933 @item -v
934 @opindex v
935 Print (on standard error output) the commands executed to run the stages
936 of compilation.  Also print the version number of the compiler driver
937 program and of the preprocessor and the compiler proper.
938
939 @item -###
940 @opindex ###
941 Like @option{-v} except the commands are not executed and all command
942 arguments are quoted.  This is useful for shell scripts to capture the
943 driver-generated command lines.
944
945 @item -pipe
946 @opindex pipe
947 Use pipes rather than temporary files for communication between the
948 various stages of compilation.  This fails to work on some systems where
949 the assembler is unable to read from a pipe; but the GNU assembler has
950 no trouble.
951
952 @item -combine
953 @opindex combine
954 If you are compiling multiple source files, this option tells the driver
955 to pass all the source files to the compiler at once (for those
956 languages for which the compiler can handle this).  This will allow
957 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
958 language for which this is supported is C.  If you pass source files for
959 multiple languages to the driver, using this option, the driver will invoke
960 the compiler(s) that support IMA once each, passing each compiler all the
961 source files appropriate for it.  For those languages that do not support
962 IMA this option will be ignored, and the compiler will be invoked once for
963 each source file in that language.  If you use this option in conjunction
964 with -save-temps, the compiler will generate multiple pre-processed files
965 (one for each source file), but only one (combined) .o or .s file.
966
967 @item --help
968 @opindex help
969 Print (on the standard output) a description of the command line options
970 understood by @command{gcc}.  If the @option{-v} option is also specified
971 then @option{--help} will also be passed on to the various processes
972 invoked by @command{gcc}, so that they can display the command line options
973 they accept.  If the @option{-Wextra} option is also specified then command
974 line options which have no documentation associated with them will also
975 be displayed.
976
977 @item --target-help
978 @opindex target-help
979 Print (on the standard output) a description of target specific command
980 line options for each tool.
981
982 @item --version
983 @opindex version
984 Display the version number and copyrights of the invoked GCC.
985 @end table
986
987 @node Invoking G++
988 @section Compiling C++ Programs
989
990 @cindex suffixes for C++ source
991 @cindex C++ source file suffixes
992 C++ source files conventionally use one of the suffixes @samp{.C},
993 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
994 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
995 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
996 files with these names and compiles them as C++ programs even if you
997 call the compiler the same way as for compiling C programs (usually
998 with the name @command{gcc}).
999
1000 @findex g++
1001 @findex c++
1002 However, C++ programs often require class libraries as well as a
1003 compiler that understands the C++ language---and under some
1004 circumstances, you might want to compile programs or header files from
1005 standard input, or otherwise without a suffix that flags them as C++
1006 programs.  You might also like to precompile a C header file with a
1007 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1008 program that calls GCC with the default language set to C++, and
1009 automatically specifies linking against the C++ library.  On many
1010 systems, @command{g++} is also installed with the name @command{c++}.
1011
1012 @cindex invoking @command{g++}
1013 When you compile C++ programs, you may specify many of the same
1014 command-line options that you use for compiling programs in any
1015 language; or command-line options meaningful for C and related
1016 languages; or options that are meaningful only for C++ programs.
1017 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1018 explanations of options for languages related to C@.
1019 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1020 explanations of options that are meaningful only for C++ programs.
1021
1022 @node C Dialect Options
1023 @section Options Controlling C Dialect
1024 @cindex dialect options
1025 @cindex language dialect options
1026 @cindex options, dialect
1027
1028 The following options control the dialect of C (or languages derived
1029 from C, such as C++, Objective-C and Objective-C++) that the compiler
1030 accepts:
1031
1032 @table @gcctabopt
1033 @cindex ANSI support
1034 @cindex ISO support
1035 @item -ansi
1036 @opindex ansi
1037 In C mode, support all ISO C90 programs.  In C++ mode,
1038 remove GNU extensions that conflict with ISO C++.
1039
1040 This turns off certain features of GCC that are incompatible with ISO
1041 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1042 such as the @code{asm} and @code{typeof} keywords, and
1043 predefined macros such as @code{unix} and @code{vax} that identify the
1044 type of system you are using.  It also enables the undesirable and
1045 rarely used ISO trigraph feature.  For the C compiler,
1046 it disables recognition of C++ style @samp{//} comments as well as
1047 the @code{inline} keyword.
1048
1049 The alternate keywords @code{__asm__}, @code{__extension__},
1050 @code{__inline__} and @code{__typeof__} continue to work despite
1051 @option{-ansi}.  You would not want to use them in an ISO C program, of
1052 course, but it is useful to put them in header files that might be included
1053 in compilations done with @option{-ansi}.  Alternate predefined macros
1054 such as @code{__unix__} and @code{__vax__} are also available, with or
1055 without @option{-ansi}.
1056
1057 The @option{-ansi} option does not cause non-ISO programs to be
1058 rejected gratuitously.  For that, @option{-pedantic} is required in
1059 addition to @option{-ansi}.  @xref{Warning Options}.
1060
1061 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1062 option is used.  Some header files may notice this macro and refrain
1063 from declaring certain functions or defining certain macros that the
1064 ISO standard doesn't call for; this is to avoid interfering with any
1065 programs that might use these names for other things.
1066
1067 Functions which would normally be built in but do not have semantics
1068 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1069 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1070 built-in functions provided by GCC}, for details of the functions
1071 affected.
1072
1073 @item -std=
1074 @opindex std
1075 Determine the language standard.  This option is currently only
1076 supported when compiling C or C++.  A value for this option must be
1077 provided; possible values are
1078
1079 @table @samp
1080 @item c89
1081 @itemx iso9899:1990
1082 ISO C90 (same as @option{-ansi}).
1083
1084 @item iso9899:199409
1085 ISO C90 as modified in amendment 1.
1086
1087 @item c99
1088 @itemx c9x
1089 @itemx iso9899:1999
1090 @itemx iso9899:199x
1091 ISO C99.  Note that this standard is not yet fully supported; see
1092 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1093 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1094
1095 @item gnu89
1096 Default, ISO C90 plus GNU extensions (including some C99 features).
1097
1098 @item gnu99
1099 @itemx gnu9x
1100 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1101 this will become the default.  The name @samp{gnu9x} is deprecated.
1102
1103 @item c++98
1104 The 1998 ISO C++ standard plus amendments.
1105
1106 @item gnu++98
1107 The same as @option{-std=c++98} plus GNU extensions.  This is the
1108 default for C++ code.
1109 @end table
1110
1111 Even when this option is not specified, you can still use some of the
1112 features of newer standards in so far as they do not conflict with
1113 previous C standards.  For example, you may use @code{__restrict__} even
1114 when @option{-std=c99} is not specified.
1115
1116 The @option{-std} options specifying some version of ISO C have the same
1117 effects as @option{-ansi}, except that features that were not in ISO C90
1118 but are in the specified version (for example, @samp{//} comments and
1119 the @code{inline} keyword in ISO C99) are not disabled.
1120
1121 @xref{Standards,,Language Standards Supported by GCC}, for details of
1122 these standard versions.
1123
1124 @item -aux-info @var{filename}
1125 @opindex aux-info
1126 Output to the given filename prototyped declarations for all functions
1127 declared and/or defined in a translation unit, including those in header
1128 files.  This option is silently ignored in any language other than C@.
1129
1130 Besides declarations, the file indicates, in comments, the origin of
1131 each declaration (source file and line), whether the declaration was
1132 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1133 @samp{O} for old, respectively, in the first character after the line
1134 number and the colon), and whether it came from a declaration or a
1135 definition (@samp{C} or @samp{F}, respectively, in the following
1136 character).  In the case of function definitions, a K&R-style list of
1137 arguments followed by their declarations is also provided, inside
1138 comments, after the declaration.
1139
1140 @item -fno-asm
1141 @opindex fno-asm
1142 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1143 keyword, so that code can use these words as identifiers.  You can use
1144 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1145 instead.  @option{-ansi} implies @option{-fno-asm}.
1146
1147 In C++, this switch only affects the @code{typeof} keyword, since
1148 @code{asm} and @code{inline} are standard keywords.  You may want to
1149 use the @option{-fno-gnu-keywords} flag instead, which has the same
1150 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1151 switch only affects the @code{asm} and @code{typeof} keywords, since
1152 @code{inline} is a standard keyword in ISO C99.
1153
1154 @item -fno-builtin
1155 @itemx -fno-builtin-@var{function}
1156 @opindex fno-builtin
1157 @cindex built-in functions
1158 Don't recognize built-in functions that do not begin with
1159 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1160 functions provided by GCC}, for details of the functions affected,
1161 including those which are not built-in functions when @option{-ansi} or
1162 @option{-std} options for strict ISO C conformance are used because they
1163 do not have an ISO standard meaning.
1164
1165 GCC normally generates special code to handle certain built-in functions
1166 more efficiently; for instance, calls to @code{alloca} may become single
1167 instructions that adjust the stack directly, and calls to @code{memcpy}
1168 may become inline copy loops.  The resulting code is often both smaller
1169 and faster, but since the function calls no longer appear as such, you
1170 cannot set a breakpoint on those calls, nor can you change the behavior
1171 of the functions by linking with a different library.
1172
1173 With the @option{-fno-builtin-@var{function}} option
1174 only the built-in function @var{function} is
1175 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1176 function is named this is not built-in in this version of GCC, this
1177 option is ignored.  There is no corresponding
1178 @option{-fbuiltin-@var{function}} option; if you wish to enable
1179 built-in functions selectively when using @option{-fno-builtin} or
1180 @option{-ffreestanding}, you may define macros such as:
1181
1182 @smallexample
1183 #define abs(n)          __builtin_abs ((n))
1184 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1185 @end smallexample
1186
1187 @item -fhosted
1188 @opindex fhosted
1189 @cindex hosted environment
1190
1191 Assert that compilation takes place in a hosted environment.  This implies
1192 @option{-fbuiltin}.  A hosted environment is one in which the
1193 entire standard library is available, and in which @code{main} has a return
1194 type of @code{int}.  Examples are nearly everything except a kernel.
1195 This is equivalent to @option{-fno-freestanding}.
1196
1197 @item -ffreestanding
1198 @opindex ffreestanding
1199 @cindex hosted environment
1200
1201 Assert that compilation takes place in a freestanding environment.  This
1202 implies @option{-fno-builtin}.  A freestanding environment
1203 is one in which the standard library may not exist, and program startup may
1204 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1205 This is equivalent to @option{-fno-hosted}.
1206
1207 @xref{Standards,,Language Standards Supported by GCC}, for details of
1208 freestanding and hosted environments.
1209
1210 @item -fms-extensions
1211 @opindex fms-extensions
1212 Accept some non-standard constructs used in Microsoft header files.
1213
1214 @item -trigraphs
1215 @opindex trigraphs
1216 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1217 options for strict ISO C conformance) implies @option{-trigraphs}.
1218
1219 @item -no-integrated-cpp
1220 @opindex no-integrated-cpp
1221 Performs a compilation in two passes: preprocessing and compiling.  This
1222 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1223 @option{-B} option. The user supplied compilation step can then add in
1224 an additional preprocessing step after normal preprocessing but before
1225 compiling. The default is to use the integrated cpp (internal cpp)
1226
1227 The semantics of this option will change if "cc1", "cc1plus", and
1228 "cc1obj" are merged.
1229
1230 @cindex traditional C language
1231 @cindex C language, traditional
1232 @item -traditional
1233 @itemx -traditional-cpp
1234 @opindex traditional-cpp
1235 @opindex traditional
1236 Formerly, these options caused GCC to attempt to emulate a pre-standard
1237 C compiler.  They are now only supported with the @option{-E} switch.
1238 The preprocessor continues to support a pre-standard mode.  See the GNU
1239 CPP manual for details.
1240
1241 @item -fcond-mismatch
1242 @opindex fcond-mismatch
1243 Allow conditional expressions with mismatched types in the second and
1244 third arguments.  The value of such an expression is void.  This option
1245 is not supported for C++.
1246
1247 @item -funsigned-char
1248 @opindex funsigned-char
1249 Let the type @code{char} be unsigned, like @code{unsigned char}.
1250
1251 Each kind of machine has a default for what @code{char} should
1252 be.  It is either like @code{unsigned char} by default or like
1253 @code{signed char} by default.
1254
1255 Ideally, a portable program should always use @code{signed char} or
1256 @code{unsigned char} when it depends on the signedness of an object.
1257 But many programs have been written to use plain @code{char} and
1258 expect it to be signed, or expect it to be unsigned, depending on the
1259 machines they were written for.  This option, and its inverse, let you
1260 make such a program work with the opposite default.
1261
1262 The type @code{char} is always a distinct type from each of
1263 @code{signed char} or @code{unsigned char}, even though its behavior
1264 is always just like one of those two.
1265
1266 @item -fsigned-char
1267 @opindex fsigned-char
1268 Let the type @code{char} be signed, like @code{signed char}.
1269
1270 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1271 the negative form of @option{-funsigned-char}.  Likewise, the option
1272 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1273
1274 @item -fsigned-bitfields
1275 @itemx -funsigned-bitfields
1276 @itemx -fno-signed-bitfields
1277 @itemx -fno-unsigned-bitfields
1278 @opindex fsigned-bitfields
1279 @opindex funsigned-bitfields
1280 @opindex fno-signed-bitfields
1281 @opindex fno-unsigned-bitfields
1282 These options control whether a bit-field is signed or unsigned, when the
1283 declaration does not use either @code{signed} or @code{unsigned}.  By
1284 default, such a bit-field is signed, because this is consistent: the
1285 basic integer types such as @code{int} are signed types.
1286 @end table
1287
1288 @node C++ Dialect Options
1289 @section Options Controlling C++ Dialect
1290
1291 @cindex compiler options, C++
1292 @cindex C++ options, command line
1293 @cindex options, C++
1294 This section describes the command-line options that are only meaningful
1295 for C++ programs; but you can also use most of the GNU compiler options
1296 regardless of what language your program is in.  For example, you
1297 might compile a file @code{firstClass.C} like this:
1298
1299 @smallexample
1300 g++ -g -frepo -O -c firstClass.C
1301 @end smallexample
1302
1303 @noindent
1304 In this example, only @option{-frepo} is an option meant
1305 only for C++ programs; you can use the other options with any
1306 language supported by GCC@.
1307
1308 Here is a list of options that are @emph{only} for compiling C++ programs:
1309
1310 @table @gcctabopt
1311
1312 @item -fabi-version=@var{n}
1313 @opindex fabi-version
1314 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1315 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1316 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1317 the version that conforms most closely to the C++ ABI specification.
1318 Therefore, the ABI obtained using version 0 will change as ABI bugs
1319 are fixed.
1320
1321 The default is version 2.
1322
1323 @item -fno-access-control
1324 @opindex fno-access-control
1325 Turn off all access checking.  This switch is mainly useful for working
1326 around bugs in the access control code.
1327
1328 @item -fcheck-new
1329 @opindex fcheck-new
1330 Check that the pointer returned by @code{operator new} is non-null
1331 before attempting to modify the storage allocated.  This check is
1332 normally unnecessary because the C++ standard specifies that
1333 @code{operator new} will only return @code{0} if it is declared
1334 @samp{throw()}, in which case the compiler will always check the
1335 return value even without this option.  In all other cases, when
1336 @code{operator new} has a non-empty exception specification, memory
1337 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1338 @samp{new (nothrow)}.
1339
1340 @item -fconserve-space
1341 @opindex fconserve-space
1342 Put uninitialized or runtime-initialized global variables into the
1343 common segment, as C does.  This saves space in the executable at the
1344 cost of not diagnosing duplicate definitions.  If you compile with this
1345 flag and your program mysteriously crashes after @code{main()} has
1346 completed, you may have an object that is being destroyed twice because
1347 two definitions were merged.
1348
1349 This option is no longer useful on most targets, now that support has
1350 been added for putting variables into BSS without making them common.
1351
1352 @item -fno-const-strings
1353 @opindex fno-const-strings
1354 Give string constants type @code{char *} instead of type @code{const
1355 char *}.  By default, G++ uses type @code{const char *} as required by
1356 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1357 actually modify the value of a string constant.
1358
1359 This option might be removed in a future release of G++.  For maximum
1360 portability, you should structure your code so that it works with
1361 string constants that have type @code{const char *}.
1362
1363 @item -fno-elide-constructors
1364 @opindex fno-elide-constructors
1365 The C++ standard allows an implementation to omit creating a temporary
1366 which is only used to initialize another object of the same type.
1367 Specifying this option disables that optimization, and forces G++ to
1368 call the copy constructor in all cases.
1369
1370 @item -fno-enforce-eh-specs
1371 @opindex fno-enforce-eh-specs
1372 Don't check for violation of exception specifications at runtime.  This
1373 option violates the C++ standard, but may be useful for reducing code
1374 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1375 will still optimize based on the exception specifications.
1376
1377 @item -ffor-scope
1378 @itemx -fno-for-scope
1379 @opindex ffor-scope
1380 @opindex fno-for-scope
1381 If @option{-ffor-scope} is specified, the scope of variables declared in
1382 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1383 as specified by the C++ standard.
1384 If @option{-fno-for-scope} is specified, the scope of variables declared in
1385 a @i{for-init-statement} extends to the end of the enclosing scope,
1386 as was the case in old versions of G++, and other (traditional)
1387 implementations of C++.
1388
1389 The default if neither flag is given to follow the standard,
1390 but to allow and give a warning for old-style code that would
1391 otherwise be invalid, or have different behavior.
1392
1393 @item -fno-gnu-keywords
1394 @opindex fno-gnu-keywords
1395 Do not recognize @code{typeof} as a keyword, so that code can use this
1396 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1397 @option{-ansi} implies @option{-fno-gnu-keywords}.
1398
1399 @item -fno-implicit-templates
1400 @opindex fno-implicit-templates
1401 Never emit code for non-inline templates which are instantiated
1402 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1403 @xref{Template Instantiation}, for more information.
1404
1405 @item -fno-implicit-inline-templates
1406 @opindex fno-implicit-inline-templates
1407 Don't emit code for implicit instantiations of inline templates, either.
1408 The default is to handle inlines differently so that compiles with and
1409 without optimization will need the same set of explicit instantiations.
1410
1411 @item -fno-implement-inlines
1412 @opindex fno-implement-inlines
1413 To save space, do not emit out-of-line copies of inline functions
1414 controlled by @samp{#pragma implementation}.  This will cause linker
1415 errors if these functions are not inlined everywhere they are called.
1416
1417 @item -fms-extensions
1418 @opindex fms-extensions
1419 Disable pedantic warnings about constructs used in MFC, such as implicit
1420 int and getting a pointer to member function via non-standard syntax.
1421
1422 @item -fno-nonansi-builtins
1423 @opindex fno-nonansi-builtins
1424 Disable built-in declarations of functions that are not mandated by
1425 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1426 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1427
1428 @item -fno-operator-names
1429 @opindex fno-operator-names
1430 Do not treat the operator name keywords @code{and}, @code{bitand},
1431 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1432 synonyms as keywords.
1433
1434 @item -fno-optional-diags
1435 @opindex fno-optional-diags
1436 Disable diagnostics that the standard says a compiler does not need to
1437 issue.  Currently, the only such diagnostic issued by G++ is the one for
1438 a name having multiple meanings within a class.
1439
1440 @item -fpermissive
1441 @opindex fpermissive
1442 Downgrade some diagnostics about nonconformant code from errors to
1443 warnings.  Thus, using @option{-fpermissive} will allow some
1444 nonconforming code to compile.
1445
1446 @item -frepo
1447 @opindex frepo
1448 Enable automatic template instantiation at link time.  This option also
1449 implies @option{-fno-implicit-templates}.  @xref{Template
1450 Instantiation}, for more information.
1451
1452 @item -fno-rtti
1453 @opindex fno-rtti
1454 Disable generation of information about every class with virtual
1455 functions for use by the C++ runtime type identification features
1456 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1457 of the language, you can save some space by using this flag.  Note that
1458 exception handling uses the same information, but it will generate it as
1459 needed.
1460
1461 @item -fstats
1462 @opindex fstats
1463 Emit statistics about front-end processing at the end of the compilation.
1464 This information is generally only useful to the G++ development team.
1465
1466 @item -ftemplate-depth-@var{n}
1467 @opindex ftemplate-depth
1468 Set the maximum instantiation depth for template classes to @var{n}.
1469 A limit on the template instantiation depth is needed to detect
1470 endless recursions during template class instantiation.  ANSI/ISO C++
1471 conforming programs must not rely on a maximum depth greater than 17.
1472
1473 @item -fuse-cxa-atexit
1474 @opindex fuse-cxa-atexit
1475 Register destructors for objects with static storage duration with the
1476 @code{__cxa_atexit} function rather than the @code{atexit} function.
1477 This option is required for fully standards-compliant handling of static
1478 destructors, but will only work if your C library supports
1479 @code{__cxa_atexit}.
1480
1481 @item -fvisibility-inlines-hidden
1482 @opindex fvisibility-inlines-hidden
1483 Causes all inlined methods to be marked with
1484 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1485 appear in the export table of a DSO and do not require a PLT indirection
1486 when used within the DSO. Enabling this option can have a dramatic effect
1487 on load and link times of a DSO as it massively reduces the size of the
1488 dynamic export table when the library makes heavy use of templates. While
1489 it can cause bloating through duplication of code within each DSO where
1490 it is used, often the wastage is less than the considerable space occupied
1491 by a long symbol name in the export table which is typical when using
1492 templates and namespaces. For even more savings, combine with the
1493 @code{-fvisibility=hidden} switch.
1494
1495 @item -fno-weak
1496 @opindex fno-weak
1497 Do not use weak symbol support, even if it is provided by the linker.
1498 By default, G++ will use weak symbols if they are available.  This
1499 option exists only for testing, and should not be used by end-users;
1500 it will result in inferior code and has no benefits.  This option may
1501 be removed in a future release of G++.
1502
1503 @item -nostdinc++
1504 @opindex nostdinc++
1505 Do not search for header files in the standard directories specific to
1506 C++, but do still search the other standard directories.  (This option
1507 is used when building the C++ library.)
1508 @end table
1509
1510 In addition, these optimization, warning, and code generation options
1511 have meanings only for C++ programs:
1512
1513 @table @gcctabopt
1514 @item -fno-default-inline
1515 @opindex fno-default-inline
1516 Do not assume @samp{inline} for functions defined inside a class scope.
1517 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1518 functions will have linkage like inline functions; they just won't be
1519 inlined by default.
1520
1521 @item -Wabi @r{(C++ only)}
1522 @opindex Wabi
1523 Warn when G++ generates code that is probably not compatible with the
1524 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1525 all such cases, there are probably some cases that are not warned about,
1526 even though G++ is generating incompatible code.  There may also be
1527 cases where warnings are emitted even though the code that is generated
1528 will be compatible.
1529
1530 You should rewrite your code to avoid these warnings if you are
1531 concerned about the fact that code generated by G++ may not be binary
1532 compatible with code generated by other compilers.
1533
1534 The known incompatibilities at this point include:
1535
1536 @itemize @bullet
1537
1538 @item
1539 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1540 pack data into the same byte as a base class.  For example:
1541
1542 @smallexample
1543 struct A @{ virtual void f(); int f1 : 1; @};
1544 struct B : public A @{ int f2 : 1; @};
1545 @end smallexample
1546
1547 @noindent
1548 In this case, G++ will place @code{B::f2} into the same byte
1549 as@code{A::f1}; other compilers will not.  You can avoid this problem
1550 by explicitly padding @code{A} so that its size is a multiple of the
1551 byte size on your platform; that will cause G++ and other compilers to
1552 layout @code{B} identically.
1553
1554 @item
1555 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1556 tail padding when laying out virtual bases.  For example:
1557
1558 @smallexample
1559 struct A @{ virtual void f(); char c1; @};
1560 struct B @{ B(); char c2; @};
1561 struct C : public A, public virtual B @{@};
1562 @end smallexample
1563
1564 @noindent
1565 In this case, G++ will not place @code{B} into the tail-padding for
1566 @code{A}; other compilers will.  You can avoid this problem by
1567 explicitly padding @code{A} so that its size is a multiple of its
1568 alignment (ignoring virtual base classes); that will cause G++ and other
1569 compilers to layout @code{C} identically.
1570
1571 @item
1572 Incorrect handling of bit-fields with declared widths greater than that
1573 of their underlying types, when the bit-fields appear in a union.  For
1574 example:
1575
1576 @smallexample
1577 union U @{ int i : 4096; @};
1578 @end smallexample
1579
1580 @noindent
1581 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1582 union too small by the number of bits in an @code{int}.
1583
1584 @item
1585 Empty classes can be placed at incorrect offsets.  For example:
1586
1587 @smallexample
1588 struct A @{@};
1589
1590 struct B @{
1591   A a;
1592   virtual void f ();
1593 @};
1594
1595 struct C : public B, public A @{@};
1596 @end smallexample
1597
1598 @noindent
1599 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1600 it should be placed at offset zero.  G++ mistakenly believes that the
1601 @code{A} data member of @code{B} is already at offset zero.
1602
1603 @item
1604 Names of template functions whose types involve @code{typename} or
1605 template template parameters can be mangled incorrectly.
1606
1607 @smallexample
1608 template <typename Q>
1609 void f(typename Q::X) @{@}
1610
1611 template <template <typename> class Q>
1612 void f(typename Q<int>::X) @{@}
1613 @end smallexample
1614
1615 @noindent
1616 Instantiations of these templates may be mangled incorrectly.
1617
1618 @end itemize
1619
1620 @item -Wctor-dtor-privacy @r{(C++ only)}
1621 @opindex Wctor-dtor-privacy
1622 Warn when a class seems unusable because all the constructors or
1623 destructors in that class are private, and it has neither friends nor
1624 public static member functions.
1625
1626 @item -Wnon-virtual-dtor @r{(C++ only)}
1627 @opindex Wnon-virtual-dtor
1628 Warn when a class appears to be polymorphic, thereby requiring a virtual
1629 destructor, yet it declares a non-virtual one.
1630 This warning is enabled by @option{-Wall}.
1631
1632 @item -Wreorder @r{(C++ only)}
1633 @opindex Wreorder
1634 @cindex reordering, warning
1635 @cindex warning for reordering of member initializers
1636 Warn when the order of member initializers given in the code does not
1637 match the order in which they must be executed.  For instance:
1638
1639 @smallexample
1640 struct A @{
1641   int i;
1642   int j;
1643   A(): j (0), i (1) @{ @}
1644 @};
1645 @end smallexample
1646
1647 The compiler will rearrange the member initializers for @samp{i}
1648 and @samp{j} to match the declaration order of the members, emitting
1649 a warning to that effect.  This warning is enabled by @option{-Wall}.
1650 @end table
1651
1652 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1653
1654 @table @gcctabopt
1655 @item -Weffc++ @r{(C++ only)}
1656 @opindex Weffc++
1657 Warn about violations of the following style guidelines from Scott Meyers'
1658 @cite{Effective C++} book:
1659
1660 @itemize @bullet
1661 @item
1662 Item 11:  Define a copy constructor and an assignment operator for classes
1663 with dynamically allocated memory.
1664
1665 @item
1666 Item 12:  Prefer initialization to assignment in constructors.
1667
1668 @item
1669 Item 14:  Make destructors virtual in base classes.
1670
1671 @item
1672 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1673
1674 @item
1675 Item 23:  Don't try to return a reference when you must return an object.
1676
1677 @end itemize
1678
1679 Also warn about violations of the following style guidelines from
1680 Scott Meyers' @cite{More Effective C++} book:
1681
1682 @itemize @bullet
1683 @item
1684 Item 6:  Distinguish between prefix and postfix forms of increment and
1685 decrement operators.
1686
1687 @item
1688 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1689
1690 @end itemize
1691
1692 When selecting this option, be aware that the standard library
1693 headers do not obey all of these guidelines; use @samp{grep -v}
1694 to filter out those warnings.
1695
1696 @item -Wno-deprecated @r{(C++ only)}
1697 @opindex Wno-deprecated
1698 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1699
1700 @item -Wno-non-template-friend @r{(C++ only)}
1701 @opindex Wno-non-template-friend
1702 Disable warnings when non-templatized friend functions are declared
1703 within a template.  Since the advent of explicit template specification
1704 support in G++, if the name of the friend is an unqualified-id (i.e.,
1705 @samp{friend foo(int)}), the C++ language specification demands that the
1706 friend declare or define an ordinary, nontemplate function.  (Section
1707 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1708 could be interpreted as a particular specialization of a templatized
1709 function.  Because this non-conforming behavior is no longer the default
1710 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1711 check existing code for potential trouble spots and is on by default.
1712 This new compiler behavior can be turned off with
1713 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1714 but disables the helpful warning.
1715
1716 @item -Wold-style-cast @r{(C++ only)}
1717 @opindex Wold-style-cast
1718 Warn if an old-style (C-style) cast to a non-void type is used within
1719 a C++ program.  The new-style casts (@samp{static_cast},
1720 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1721 unintended effects and much easier to search for.
1722
1723 @item -Woverloaded-virtual @r{(C++ only)}
1724 @opindex Woverloaded-virtual
1725 @cindex overloaded virtual fn, warning
1726 @cindex warning for overloaded virtual fn
1727 Warn when a function declaration hides virtual functions from a
1728 base class.  For example, in:
1729
1730 @smallexample
1731 struct A @{
1732   virtual void f();
1733 @};
1734
1735 struct B: public A @{
1736   void f(int);
1737 @};
1738 @end smallexample
1739
1740 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1741 like:
1742
1743 @smallexample
1744 B* b;
1745 b->f();
1746 @end smallexample
1747
1748 will fail to compile.
1749
1750 @item -Wno-pmf-conversions @r{(C++ only)}
1751 @opindex Wno-pmf-conversions
1752 Disable the diagnostic for converting a bound pointer to member function
1753 to a plain pointer.
1754
1755 @item -Wsign-promo @r{(C++ only)}
1756 @opindex Wsign-promo
1757 Warn when overload resolution chooses a promotion from unsigned or
1758 enumerated type to a signed type, over a conversion to an unsigned type of
1759 the same size.  Previous versions of G++ would try to preserve
1760 unsignedness, but the standard mandates the current behavior.
1761
1762 @item -Wsynth @r{(C++ only)}
1763 @opindex Wsynth
1764 @cindex warning for synthesized methods
1765 @cindex synthesized methods, warning
1766 Warn when G++'s synthesis behavior does not match that of cfront.  For
1767 instance:
1768
1769 @smallexample
1770 struct A @{
1771   operator int ();
1772   A& operator = (int);
1773 @};
1774
1775 main ()
1776 @{
1777   A a,b;
1778   a = b;
1779 @}
1780 @end smallexample
1781
1782 In this example, G++ will synthesize a default @samp{A& operator =
1783 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1784 @end table
1785
1786 @node Objective-C and Objective-C++ Dialect Options
1787 @section Options Controlling Objective-C and Objective-C++ Dialects
1788
1789 @cindex compiler options, Objective-C and Objective-C++
1790 @cindex Objective-C and Objective-C++ options, command line
1791 @cindex options, Objective-C and Objective-C++
1792 (NOTE: This manual does not describe the Objective-C and Objective-C++
1793 languages themselves.  See @xref{Standards,,Language Standards
1794 Supported by GCC}, for references.)
1795
1796 This section describes the command-line options that are only meaningful
1797 for Objective-C and Objective-C++ programs, but you can also use most of
1798 the language-independent GNU compiler options.
1799 For example, you might compile a file @code{some_class.m} like this:
1800
1801 @smallexample
1802 gcc -g -fgnu-runtime -O -c some_class.m
1803 @end smallexample
1804
1805 @noindent
1806 In this example, @option{-fgnu-runtime} is an option meant only for
1807 Objective-C and Objective-C++ programs; you can use the other options with
1808 any language supported by GCC@.
1809
1810 Note that since Objective-C is an extension of the C language, Objective-C
1811 compilations may also use options specific to the C front-end (e.g., 
1812 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1813 C++-specific options (e.g., @option{-Wabi}).
1814
1815 Here is a list of options that are @emph{only} for compiling Objective-C
1816 and Objective-C++ programs:
1817
1818 @table @gcctabopt
1819 @item -fconstant-string-class=@var{class-name}
1820 @opindex fconstant-string-class
1821 Use @var{class-name} as the name of the class to instantiate for each
1822 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1823 class name is @code{NXConstantString} if the GNU runtime is being used, and
1824 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1825 @option{-fconstant-cfstrings} option, if also present, will override the
1826 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1827 to be laid out as constant CoreFoundation strings.
1828
1829 @item -fgnu-runtime
1830 @opindex fgnu-runtime
1831 Generate object code compatible with the standard GNU Objective-C
1832 runtime.  This is the default for most types of systems.
1833
1834 @item -fnext-runtime
1835 @opindex fnext-runtime
1836 Generate output compatible with the NeXT runtime.  This is the default
1837 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1838 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1839 used.
1840
1841 @item -fno-nil-receivers
1842 @opindex fno-nil-receivers
1843 Assume that all Objective-C message dispatches (e.g.,
1844 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1845 is not @code{nil}.  This allows for more efficient entry points in the runtime
1846 to be used.  Currently, this option is only available in conjunction with
1847 the NeXT runtime on Mac OS X 10.3 and later.
1848
1849 @item -fobjc-exceptions
1850 @opindex fobjc-exceptions
1851 Enable syntactic support for structured exception handling in Objective-C,
1852 similar to what is offered by C++ and Java.  Currently, this option is only
1853 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1854
1855 @smallexample
1856   @@try @{
1857     @dots{}
1858        @@throw expr;
1859     @dots{}
1860   @}
1861   @@catch (AnObjCClass *exc) @{
1862     @dots{}
1863       @@throw expr;
1864     @dots{}
1865       @@throw;
1866     @dots{}
1867   @}
1868   @@catch (AnotherClass *exc) @{
1869     @dots{}
1870   @}
1871   @@catch (id allOthers) @{
1872     @dots{}
1873   @}
1874   @@finally @{
1875     @dots{}
1876       @@throw expr;
1877     @dots{}
1878   @}
1879 @end smallexample
1880
1881 The @code{@@throw} statement may appear anywhere in an Objective-C or
1882 Objective-C++ program; when used inside of a @code{@@catch} block, the
1883 @code{@@throw} may appear without an argument (as shown above), in which case
1884 the object caught by the @code{@@catch} will be rethrown.
1885
1886 Note that only (pointers to) Objective-C objects may be thrown and
1887 caught using this scheme.  When an object is thrown, it will be caught
1888 by the nearest @code{@@catch} clause capable of handling objects of that type,
1889 analogously to how @code{catch} blocks work in C++ and Java.  A
1890 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1891 any and all Objective-C exceptions not caught by previous @code{@@catch}
1892 clauses (if any).
1893
1894 The @code{@@finally} clause, if present, will be executed upon exit from the
1895 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1896 regardless of whether any exceptions are thrown, caught or rethrown
1897 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1898 of the @code{finally} clause in Java.
1899
1900 There are several caveats to using the new exception mechanism:
1901
1902 @itemize @bullet
1903 @item
1904 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1905 idioms provided by the @code{NSException} class, the new
1906 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1907 systems, due to additional functionality needed in the (NeXT) Objective-C
1908 runtime.
1909
1910 @item
1911 As mentioned above, the new exceptions do not support handling
1912 types other than Objective-C objects.   Furthermore, when used from
1913 Objective-C++, the Objective-C exception model does not interoperate with C++
1914 exceptions at this time.  This means you cannot @code{@@throw} an exception
1915 from Objective-C and @code{catch} it in C++, or vice versa
1916 (i.e., @code{throw @dots{} @@catch}).
1917 @end itemize
1918
1919 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1920 blocks for thread-safe execution:
1921
1922 @smallexample
1923   @@synchronized (ObjCClass *guard) @{
1924     @dots{}
1925   @}
1926 @end smallexample
1927
1928 Upon entering the @code{@@synchronized} block, a thread of execution shall
1929 first check whether a lock has been placed on the corresponding @code{guard}
1930 object by another thread.  If it has, the current thread shall wait until
1931 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1932 the current thread will place its own lock on it, execute the code contained in
1933 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1934 making @code{guard} available to other threads).
1935
1936 Unlike Java, Objective-C does not allow for entire methods to be marked
1937 @code{@@synchronized}.  Note that throwing exceptions out of
1938 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1939 to be unlocked properly.
1940
1941 @item -freplace-objc-classes
1942 @opindex freplace-objc-classes
1943 Emit a special marker instructing @command{ld(1)} not to statically link in
1944 the resulting object file, and allow @command{dyld(1)} to load it in at
1945 run time instead.  This is used in conjunction with the Fix-and-Continue
1946 debugging mode, where the object file in question may be recompiled and
1947 dynamically reloaded in the course of program execution, without the need
1948 to restart the program itself.  Currently, Fix-and-Continue functionality
1949 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1950 and later.
1951
1952 @item -fzero-link
1953 @opindex fzero-link
1954 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1955 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1956 compile time) with static class references that get initialized at load time,
1957 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1958 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1959 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1960 for individual class implementations to be modified during program execution.
1961
1962 @item -gen-decls
1963 @opindex gen-decls
1964 Dump interface declarations for all classes seen in the source file to a
1965 file named @file{@var{sourcename}.decl}.
1966
1967 @item -Wno-protocol
1968 @opindex Wno-protocol
1969 If a class is declared to implement a protocol, a warning is issued for
1970 every method in the protocol that is not implemented by the class.  The
1971 default behavior is to issue a warning for every method not explicitly
1972 implemented in the class, even if a method implementation is inherited
1973 from the superclass.  If you use the @code{-Wno-protocol} option, then
1974 methods inherited from the superclass are considered to be implemented,
1975 and no warning is issued for them.
1976
1977 @item -Wselector
1978 @opindex Wselector
1979 Warn if multiple methods of different types for the same selector are
1980 found during compilation.  The check is performed on the list of methods
1981 in the final stage of compilation.  Additionally, a check is performed
1982 for each selector appearing in a @code{@@selector(@dots{})}
1983 expression, and a corresponding method for that selector has been found
1984 during compilation.  Because these checks scan the method table only at
1985 the end of compilation, these warnings are not produced if the final
1986 stage of compilation is not reached, for example because an error is
1987 found during compilation, or because the @code{-fsyntax-only} option is
1988 being used.
1989
1990 @item -Wundeclared-selector
1991 @opindex Wundeclared-selector
1992 Warn if a @code{@@selector(@dots{})} expression referring to an
1993 undeclared selector is found.  A selector is considered undeclared if no
1994 method with that name has been declared before the
1995 @code{@@selector(@dots{})} expression, either explicitly in an
1996 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1997 an @code{@@implementation} section.  This option always performs its
1998 checks as soon as a @code{@@selector(@dots{})} expression is found,
1999 while @code{-Wselector} only performs its checks in the final stage of
2000 compilation.  This also enforces the coding style convention
2001 that methods and selectors must be declared before being used.
2002
2003 @item -print-objc-runtime-info
2004 @opindex print-objc-runtime-info
2005 Generate C header describing the largest structure that is passed by
2006 value, if any.
2007
2008 @end table
2009
2010 @node Language Independent Options
2011 @section Options to Control Diagnostic Messages Formatting
2012 @cindex options to control diagnostics formatting
2013 @cindex diagnostic messages
2014 @cindex message formatting
2015
2016 Traditionally, diagnostic messages have been formatted irrespective of
2017 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2018 below can be used to control the diagnostic messages formatting
2019 algorithm, e.g.@: how many characters per line, how often source location
2020 information should be reported.  Right now, only the C++ front end can
2021 honor these options.  However it is expected, in the near future, that
2022 the remaining front ends would be able to digest them correctly.
2023
2024 @table @gcctabopt
2025 @item -fmessage-length=@var{n}
2026 @opindex fmessage-length
2027 Try to format error messages so that they fit on lines of about @var{n}
2028 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2029 the front ends supported by GCC@.  If @var{n} is zero, then no
2030 line-wrapping will be done; each error message will appear on a single
2031 line.
2032
2033 @opindex fdiagnostics-show-location
2034 @item -fdiagnostics-show-location=once
2035 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2036 reporter to emit @emph{once} source location information; that is, in
2037 case the message is too long to fit on a single physical line and has to
2038 be wrapped, the source location won't be emitted (as prefix) again,
2039 over and over, in subsequent continuation lines.  This is the default
2040 behavior.
2041
2042 @item -fdiagnostics-show-location=every-line
2043 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2044 messages reporter to emit the same source location information (as
2045 prefix) for physical lines that result from the process of breaking
2046 a message which is too long to fit on a single line.
2047
2048 @end table
2049
2050 @node Warning Options
2051 @section Options to Request or Suppress Warnings
2052 @cindex options to control warnings
2053 @cindex warning messages
2054 @cindex messages, warning
2055 @cindex suppressing warnings
2056
2057 Warnings are diagnostic messages that report constructions which
2058 are not inherently erroneous but which are risky or suggest there
2059 may have been an error.
2060
2061 You can request many specific warnings with options beginning @samp{-W},
2062 for example @option{-Wimplicit} to request warnings on implicit
2063 declarations.  Each of these specific warning options also has a
2064 negative form beginning @samp{-Wno-} to turn off warnings;
2065 for example, @option{-Wno-implicit}.  This manual lists only one of the
2066 two forms, whichever is not the default.
2067
2068 The following options control the amount and kinds of warnings produced
2069 by GCC; for further, language-specific options also refer to
2070 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2071 Options}.
2072
2073 @table @gcctabopt
2074 @cindex syntax checking
2075 @item -fsyntax-only
2076 @opindex fsyntax-only
2077 Check the code for syntax errors, but don't do anything beyond that.
2078
2079 @item -pedantic
2080 @opindex pedantic
2081 Issue all the warnings demanded by strict ISO C and ISO C++;
2082 reject all programs that use forbidden extensions, and some other
2083 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2084 version of the ISO C standard specified by any @option{-std} option used.
2085
2086 Valid ISO C and ISO C++ programs should compile properly with or without
2087 this option (though a rare few will require @option{-ansi} or a
2088 @option{-std} option specifying the required version of ISO C)@.  However,
2089 without this option, certain GNU extensions and traditional C and C++
2090 features are supported as well.  With this option, they are rejected.
2091
2092 @option{-pedantic} does not cause warning messages for use of the
2093 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2094 warnings are also disabled in the expression that follows
2095 @code{__extension__}.  However, only system header files should use
2096 these escape routes; application programs should avoid them.
2097 @xref{Alternate Keywords}.
2098
2099 Some users try to use @option{-pedantic} to check programs for strict ISO
2100 C conformance.  They soon find that it does not do quite what they want:
2101 it finds some non-ISO practices, but not all---only those for which
2102 ISO C @emph{requires} a diagnostic, and some others for which
2103 diagnostics have been added.
2104
2105 A feature to report any failure to conform to ISO C might be useful in
2106 some instances, but would require considerable additional work and would
2107 be quite different from @option{-pedantic}.  We don't have plans to
2108 support such a feature in the near future.
2109
2110 Where the standard specified with @option{-std} represents a GNU
2111 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2112 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2113 extended dialect is based.  Warnings from @option{-pedantic} are given
2114 where they are required by the base standard.  (It would not make sense
2115 for such warnings to be given only for features not in the specified GNU
2116 C dialect, since by definition the GNU dialects of C include all
2117 features the compiler supports with the given option, and there would be
2118 nothing to warn about.)
2119
2120 @item -pedantic-errors
2121 @opindex pedantic-errors
2122 Like @option{-pedantic}, except that errors are produced rather than
2123 warnings.
2124
2125 @item -w
2126 @opindex w
2127 Inhibit all warning messages.
2128
2129 @item -Wno-import
2130 @opindex Wno-import
2131 Inhibit warning messages about the use of @samp{#import}.
2132
2133 @item -Wchar-subscripts
2134 @opindex Wchar-subscripts
2135 Warn if an array subscript has type @code{char}.  This is a common cause
2136 of error, as programmers often forget that this type is signed on some
2137 machines.
2138
2139 @item -Wcomment
2140 @opindex Wcomment
2141 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2142 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2143
2144 @item -Wfatal-errors
2145 @opindex Wfatal-errors
2146 This option causes the compiler to abort compilation on the first error
2147 occurred rather than trying to keep going and printing further error
2148 messages.
2149
2150 @item -Wformat
2151 @opindex Wformat
2152 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2153 the arguments supplied have types appropriate to the format string
2154 specified, and that the conversions specified in the format string make
2155 sense.  This includes standard functions, and others specified by format
2156 attributes (@pxref{Function Attributes}), in the @code{printf},
2157 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2158 not in the C standard) families (or other target-specific families).
2159
2160 The formats are checked against the format features supported by GNU
2161 libc version 2.2.  These include all ISO C90 and C99 features, as well
2162 as features from the Single Unix Specification and some BSD and GNU
2163 extensions.  Other library implementations may not support all these
2164 features; GCC does not support warning about features that go beyond a
2165 particular library's limitations.  However, if @option{-pedantic} is used
2166 with @option{-Wformat}, warnings will be given about format features not
2167 in the selected standard version (but not for @code{strfmon} formats,
2168 since those are not in any version of the C standard).  @xref{C Dialect
2169 Options,,Options Controlling C Dialect}.
2170
2171 Since @option{-Wformat} also checks for null format arguments for
2172 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2173
2174 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2175 aspects of format checking, the options @option{-Wformat-y2k},
2176 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2177 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2178 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2179
2180 @item -Wformat-y2k
2181 @opindex Wformat-y2k
2182 If @option{-Wformat} is specified, also warn about @code{strftime}
2183 formats which may yield only a two-digit year.
2184
2185 @item -Wno-format-extra-args
2186 @opindex Wno-format-extra-args
2187 If @option{-Wformat} is specified, do not warn about excess arguments to a
2188 @code{printf} or @code{scanf} format function.  The C standard specifies
2189 that such arguments are ignored.
2190
2191 Where the unused arguments lie between used arguments that are
2192 specified with @samp{$} operand number specifications, normally
2193 warnings are still given, since the implementation could not know what
2194 type to pass to @code{va_arg} to skip the unused arguments.  However,
2195 in the case of @code{scanf} formats, this option will suppress the
2196 warning if the unused arguments are all pointers, since the Single
2197 Unix Specification says that such unused arguments are allowed.
2198
2199 @item -Wno-format-zero-length
2200 @opindex Wno-format-zero-length
2201 If @option{-Wformat} is specified, do not warn about zero-length formats.
2202 The C standard specifies that zero-length formats are allowed.
2203
2204 @item -Wformat-nonliteral
2205 @opindex Wformat-nonliteral
2206 If @option{-Wformat} is specified, also warn if the format string is not a
2207 string literal and so cannot be checked, unless the format function
2208 takes its format arguments as a @code{va_list}.
2209
2210 @item -Wformat-security
2211 @opindex Wformat-security
2212 If @option{-Wformat} is specified, also warn about uses of format
2213 functions that represent possible security problems.  At present, this
2214 warns about calls to @code{printf} and @code{scanf} functions where the
2215 format string is not a string literal and there are no format arguments,
2216 as in @code{printf (foo);}.  This may be a security hole if the format
2217 string came from untrusted input and contains @samp{%n}.  (This is
2218 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2219 in future warnings may be added to @option{-Wformat-security} that are not
2220 included in @option{-Wformat-nonliteral}.)
2221
2222 @item -Wformat=2
2223 @opindex Wformat=2
2224 Enable @option{-Wformat} plus format checks not included in
2225 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2226 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2227
2228 @item -Wnonnull
2229 @opindex Wnonnull
2230 Warn about passing a null pointer for arguments marked as
2231 requiring a non-null value by the @code{nonnull} function attribute.
2232
2233 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2234 can be disabled with the @option{-Wno-nonnull} option.
2235
2236 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2237 @opindex Winit-self
2238 Warn about uninitialized variables which are initialized with themselves.
2239 Note this option can only be used with the @option{-Wuninitialized} option,
2240 which in turn only works with @option{-O1} and above.
2241
2242 For example, GCC will warn about @code{i} being uninitialized in the
2243 following snippet only when @option{-Winit-self} has been specified:
2244 @smallexample
2245 @group
2246 int f()
2247 @{
2248   int i = i;
2249   return i;
2250 @}
2251 @end group
2252 @end smallexample
2253
2254 @item -Wimplicit-int
2255 @opindex Wimplicit-int
2256 Warn when a declaration does not specify a type.
2257
2258 @item -Wimplicit-function-declaration
2259 @itemx -Werror-implicit-function-declaration
2260 @opindex Wimplicit-function-declaration
2261 @opindex Werror-implicit-function-declaration
2262 Give a warning (or error) whenever a function is used before being
2263 declared.
2264
2265 @item -Wimplicit
2266 @opindex Wimplicit
2267 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2268
2269 @item -Wmain
2270 @opindex Wmain
2271 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2272 function with external linkage, returning int, taking either zero
2273 arguments, two, or three arguments of appropriate types.
2274
2275 @item -Wmissing-braces
2276 @opindex Wmissing-braces
2277 Warn if an aggregate or union initializer is not fully bracketed.  In
2278 the following example, the initializer for @samp{a} is not fully
2279 bracketed, but that for @samp{b} is fully bracketed.
2280
2281 @smallexample
2282 int a[2][2] = @{ 0, 1, 2, 3 @};
2283 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2284 @end smallexample
2285
2286 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2287 @opindex Wmissing-include-dirs
2288 Warn if a user-supplied include directory does not exist.
2289
2290 @item -Wparentheses
2291 @opindex Wparentheses
2292 Warn if parentheses are omitted in certain contexts, such
2293 as when there is an assignment in a context where a truth value
2294 is expected, or when operators are nested whose precedence people
2295 often get confused about.  Only the warning for an assignment used as
2296 a truth value is supported when compiling C++; the other warnings are
2297 only supported when compiling C@.
2298
2299 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2300 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2301 interpretation from that of ordinary mathematical notation.
2302
2303 Also warn about constructions where there may be confusion to which
2304 @code{if} statement an @code{else} branch belongs.  Here is an example of
2305 such a case:
2306
2307 @smallexample
2308 @group
2309 @{
2310   if (a)
2311     if (b)
2312       foo ();
2313   else
2314     bar ();
2315 @}
2316 @end group
2317 @end smallexample
2318
2319 In C, every @code{else} branch belongs to the innermost possible @code{if}
2320 statement, which in this example is @code{if (b)}.  This is often not
2321 what the programmer expected, as illustrated in the above example by
2322 indentation the programmer chose.  When there is the potential for this
2323 confusion, GCC will issue a warning when this flag is specified.
2324 To eliminate the warning, add explicit braces around the innermost
2325 @code{if} statement so there is no way the @code{else} could belong to
2326 the enclosing @code{if}.  The resulting code would look like this:
2327
2328 @smallexample
2329 @group
2330 @{
2331   if (a)
2332     @{
2333       if (b)
2334         foo ();
2335       else
2336         bar ();
2337     @}
2338 @}
2339 @end group
2340 @end smallexample
2341
2342 @item -Wsequence-point
2343 @opindex Wsequence-point
2344 Warn about code that may have undefined semantics because of violations
2345 of sequence point rules in the C standard.
2346
2347 The C standard defines the order in which expressions in a C program are
2348 evaluated in terms of @dfn{sequence points}, which represent a partial
2349 ordering between the execution of parts of the program: those executed
2350 before the sequence point, and those executed after it.  These occur
2351 after the evaluation of a full expression (one which is not part of a
2352 larger expression), after the evaluation of the first operand of a
2353 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2354 function is called (but after the evaluation of its arguments and the
2355 expression denoting the called function), and in certain other places.
2356 Other than as expressed by the sequence point rules, the order of
2357 evaluation of subexpressions of an expression is not specified.  All
2358 these rules describe only a partial order rather than a total order,
2359 since, for example, if two functions are called within one expression
2360 with no sequence point between them, the order in which the functions
2361 are called is not specified.  However, the standards committee have
2362 ruled that function calls do not overlap.
2363
2364 It is not specified when between sequence points modifications to the
2365 values of objects take effect.  Programs whose behavior depends on this
2366 have undefined behavior; the C standard specifies that ``Between the
2367 previous and next sequence point an object shall have its stored value
2368 modified at most once by the evaluation of an expression.  Furthermore,
2369 the prior value shall be read only to determine the value to be
2370 stored.''.  If a program breaks these rules, the results on any
2371 particular implementation are entirely unpredictable.
2372
2373 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2374 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2375 diagnosed by this option, and it may give an occasional false positive
2376 result, but in general it has been found fairly effective at detecting
2377 this sort of problem in programs.
2378
2379 The present implementation of this option only works for C programs.  A
2380 future implementation may also work for C++ programs.
2381
2382 The C standard is worded confusingly, therefore there is some debate
2383 over the precise meaning of the sequence point rules in subtle cases.
2384 Links to discussions of the problem, including proposed formal
2385 definitions, may be found on the GCC readings page, at
2386 @w{@uref{http://gcc.gnu.org/readings.html}}.
2387
2388 @item -Wreturn-type
2389 @opindex Wreturn-type
2390 Warn whenever a function is defined with a return-type that defaults to
2391 @code{int}.  Also warn about any @code{return} statement with no
2392 return-value in a function whose return-type is not @code{void}.
2393
2394 For C, also warn if the return type of a function has a type qualifier
2395 such as @code{const}.  Such a type qualifier has no effect, since the
2396 value returned by a function is not an lvalue.  ISO C prohibits
2397 qualified @code{void} return types on function definitions, so such
2398 return types always receive a warning even without this option.
2399
2400 For C++, a function without return type always produces a diagnostic
2401 message, even when @option{-Wno-return-type} is specified.  The only
2402 exceptions are @samp{main} and functions defined in system headers.
2403
2404 @item -Wswitch
2405 @opindex Wswitch
2406 Warn whenever a @code{switch} statement has an index of enumerated type
2407 and lacks a @code{case} for one or more of the named codes of that
2408 enumeration.  (The presence of a @code{default} label prevents this
2409 warning.)  @code{case} labels outside the enumeration range also
2410 provoke warnings when this option is used.
2411
2412 @item -Wswitch-default
2413 @opindex Wswitch-switch
2414 Warn whenever a @code{switch} statement does not have a @code{default}
2415 case.
2416
2417 @item -Wswitch-enum
2418 @opindex Wswitch-enum
2419 Warn whenever a @code{switch} statement has an index of enumerated type
2420 and lacks a @code{case} for one or more of the named codes of that
2421 enumeration.  @code{case} labels outside the enumeration range also
2422 provoke warnings when this option is used.
2423
2424 @item -Wtrigraphs
2425 @opindex Wtrigraphs
2426 Warn if any trigraphs are encountered that might change the meaning of
2427 the program (trigraphs within comments are not warned about).
2428
2429 @item -Wunused-function
2430 @opindex Wunused-function
2431 Warn whenever a static function is declared but not defined or a
2432 non\-inline static function is unused.
2433
2434 @item -Wunused-label
2435 @opindex Wunused-label
2436 Warn whenever a label is declared but not used.
2437
2438 To suppress this warning use the @samp{unused} attribute
2439 (@pxref{Variable Attributes}).
2440
2441 @item -Wunused-parameter
2442 @opindex Wunused-parameter
2443 Warn whenever a function parameter is unused aside from its declaration.
2444
2445 To suppress this warning use the @samp{unused} attribute
2446 (@pxref{Variable Attributes}).
2447
2448 @item -Wunused-variable
2449 @opindex Wunused-variable
2450 Warn whenever a local variable or non-constant static variable is unused
2451 aside from its declaration
2452
2453 To suppress this warning use the @samp{unused} attribute
2454 (@pxref{Variable Attributes}).
2455
2456 @item -Wunused-value
2457 @opindex Wunused-value
2458 Warn whenever a statement computes a result that is explicitly not used.
2459
2460 To suppress this warning cast the expression to @samp{void}.
2461
2462 @item -Wunused
2463 @opindex Wunused
2464 All the above @option{-Wunused} options combined.
2465
2466 In order to get a warning about an unused function parameter, you must
2467 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2468 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2469
2470 @item -Wuninitialized
2471 @opindex Wuninitialized
2472 Warn if an automatic variable is used without first being initialized or
2473 if a variable may be clobbered by a @code{setjmp} call.
2474
2475 These warnings are possible only in optimizing compilation,
2476 because they require data flow information that is computed only
2477 when optimizing.  If you don't specify @option{-O}, you simply won't
2478 get these warnings.
2479
2480 If you want to warn about code which uses the uninitialized value of the
2481 variable in its own initializer, use the @option{-Winit-self} option.
2482
2483 These warnings occur only for variables that are candidates for
2484 register allocation.  Therefore, they do not occur for a variable that
2485 is declared @code{volatile}, or whose address is taken, or whose size
2486 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2487 structures, unions or arrays, even when they are in registers.
2488
2489 Note that there may be no warning about a variable that is used only
2490 to compute a value that itself is never used, because such
2491 computations may be deleted by data flow analysis before the warnings
2492 are printed.
2493
2494 These warnings are made optional because GCC is not smart
2495 enough to see all the reasons why the code might be correct
2496 despite appearing to have an error.  Here is one example of how
2497 this can happen:
2498
2499 @smallexample
2500 @group
2501 @{
2502   int x;
2503   switch (y)
2504     @{
2505     case 1: x = 1;
2506       break;
2507     case 2: x = 4;
2508       break;
2509     case 3: x = 5;
2510     @}
2511   foo (x);
2512 @}
2513 @end group
2514 @end smallexample
2515
2516 @noindent
2517 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2518 always initialized, but GCC doesn't know this.  Here is
2519 another common case:
2520
2521 @smallexample
2522 @{
2523   int save_y;
2524   if (change_y) save_y = y, y = new_y;
2525   @dots{}
2526   if (change_y) y = save_y;
2527 @}
2528 @end smallexample
2529
2530 @noindent
2531 This has no bug because @code{save_y} is used only if it is set.
2532
2533 @cindex @code{longjmp} warnings
2534 This option also warns when a non-volatile automatic variable might be
2535 changed by a call to @code{longjmp}.  These warnings as well are possible
2536 only in optimizing compilation.
2537
2538 The compiler sees only the calls to @code{setjmp}.  It cannot know
2539 where @code{longjmp} will be called; in fact, a signal handler could
2540 call it at any point in the code.  As a result, you may get a warning
2541 even when there is in fact no problem because @code{longjmp} cannot
2542 in fact be called at the place which would cause a problem.
2543
2544 Some spurious warnings can be avoided if you declare all the functions
2545 you use that never return as @code{noreturn}.  @xref{Function
2546 Attributes}.
2547
2548 @item -Wunknown-pragmas
2549 @opindex Wunknown-pragmas
2550 @cindex warning for unknown pragmas
2551 @cindex unknown pragmas, warning
2552 @cindex pragmas, warning of unknown
2553 Warn when a #pragma directive is encountered which is not understood by
2554 GCC@.  If this command line option is used, warnings will even be issued
2555 for unknown pragmas in system header files.  This is not the case if
2556 the warnings were only enabled by the @option{-Wall} command line option.
2557
2558 @item -Wstrict-aliasing
2559 @opindex Wstrict-aliasing
2560 This option is only active when @option{-fstrict-aliasing} is active.
2561 It warns about code which might break the strict aliasing rules that the
2562 compiler is using for optimization. The warning does not catch all
2563 cases, but does attempt to catch the more common pitfalls. It is
2564 included in @option{-Wall}.
2565
2566 @item -Wstrict-aliasing=2
2567 @opindex Wstrict-aliasing=2
2568 This option is only active when @option{-fstrict-aliasing} is active.
2569 It warns about all code which might break the strict aliasing rules that the
2570 compiler is using for optimization.  This warning catches all cases, but
2571 it will also give a warning for some ambiguous cases that are safe.
2572
2573 @item -Wall
2574 @opindex Wall
2575 All of the above @samp{-W} options combined.  This enables all the
2576 warnings about constructions that some users consider questionable, and
2577 that are easy to avoid (or modify to prevent the warning), even in
2578 conjunction with macros.  This also enables some language-specific
2579 warnings described in @ref{C++ Dialect Options} and
2580 @ref{Objective-C and Objective-C++ Dialect Options}.
2581 @end table
2582
2583 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2584 Some of them warn about constructions that users generally do not
2585 consider questionable, but which occasionally you might wish to check
2586 for; others warn about constructions that are necessary or hard to avoid
2587 in some cases, and there is no simple way to modify the code to suppress
2588 the warning.
2589
2590 @table @gcctabopt
2591 @item -Wextra
2592 @opindex W
2593 @opindex Wextra
2594 (This option used to be called @option{-W}.  The older name is still
2595 supported, but the newer name is more descriptive.)  Print extra warning
2596 messages for these events:
2597
2598 @itemize @bullet
2599 @item
2600 A function can return either with or without a value.  (Falling
2601 off the end of the function body is considered returning without
2602 a value.)  For example, this function would evoke such a
2603 warning:
2604
2605 @smallexample
2606 @group
2607 foo (a)
2608 @{
2609   if (a > 0)
2610     return a;
2611 @}
2612 @end group
2613 @end smallexample
2614
2615 @item
2616 An expression-statement or the left-hand side of a comma expression
2617 contains no side effects.
2618 To suppress the warning, cast the unused expression to void.
2619 For example, an expression such as @samp{x[i,j]} will cause a warning,
2620 but @samp{x[(void)i,j]} will not.
2621
2622 @item
2623 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2624
2625 @item
2626 Storage-class specifiers like @code{static} are not the first things in
2627 a declaration.  According to the C Standard, this usage is obsolescent.
2628
2629 @item
2630 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2631 arguments.
2632
2633 @item
2634 A comparison between signed and unsigned values could produce an
2635 incorrect result when the signed value is converted to unsigned.
2636 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2637
2638 @item
2639 An aggregate has an initializer which does not initialize all members.
2640 This warning can be independently controlled by
2641 @option{-Wmissing-field-initializers}.
2642
2643 @item
2644 A function parameter is declared without a type specifier in K&R-style
2645 functions:
2646
2647 @smallexample
2648 void foo(bar) @{ @}
2649 @end smallexample
2650
2651 @item
2652 An empty body occurs in an @samp{if} or @samp{else} statement.
2653
2654 @item
2655 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2656 @samp{>}, or @samp{>=}.
2657
2658 @item
2659 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2660
2661 @item
2662 Any of several floating-point events that often indicate errors, such as
2663 overflow, underflow, loss of precision, etc.
2664
2665 @item @r{(C++ only)}
2666 An enumerator and a non-enumerator both appear in a conditional expression.
2667
2668 @item @r{(C++ only)}
2669 A non-static reference or non-static @samp{const} member appears in a
2670 class without constructors.
2671
2672 @item @r{(C++ only)}
2673 Ambiguous virtual bases.
2674
2675 @item @r{(C++ only)}
2676 Subscripting an array which has been declared @samp{register}.
2677
2678 @item @r{(C++ only)}
2679 Taking the address of a variable which has been declared @samp{register}.
2680
2681 @item @r{(C++ only)}
2682 A base class is not initialized in a derived class' copy constructor.
2683 @end itemize
2684
2685 @item -Wno-div-by-zero
2686 @opindex Wno-div-by-zero
2687 @opindex Wdiv-by-zero
2688 Do not warn about compile-time integer division by zero.  Floating point
2689 division by zero is not warned about, as it can be a legitimate way of
2690 obtaining infinities and NaNs.
2691
2692 @item -Wsystem-headers
2693 @opindex Wsystem-headers
2694 @cindex warnings from system headers
2695 @cindex system headers, warnings from
2696 Print warning messages for constructs found in system header files.
2697 Warnings from system headers are normally suppressed, on the assumption
2698 that they usually do not indicate real problems and would only make the
2699 compiler output harder to read.  Using this command line option tells
2700 GCC to emit warnings from system headers as if they occurred in user
2701 code.  However, note that using @option{-Wall} in conjunction with this
2702 option will @emph{not} warn about unknown pragmas in system
2703 headers---for that, @option{-Wunknown-pragmas} must also be used.
2704
2705 @item -Wfloat-equal
2706 @opindex Wfloat-equal
2707 Warn if floating point values are used in equality comparisons.
2708
2709 The idea behind this is that sometimes it is convenient (for the
2710 programmer) to consider floating-point values as approximations to
2711 infinitely precise real numbers.  If you are doing this, then you need
2712 to compute (by analyzing the code, or in some other way) the maximum or
2713 likely maximum error that the computation introduces, and allow for it
2714 when performing comparisons (and when producing output, but that's a
2715 different problem).  In particular, instead of testing for equality, you
2716 would check to see whether the two values have ranges that overlap; and
2717 this is done with the relational operators, so equality comparisons are
2718 probably mistaken.
2719
2720 @item -Wtraditional @r{(C only)}
2721 @opindex Wtraditional
2722 Warn about certain constructs that behave differently in traditional and
2723 ISO C@.  Also warn about ISO C constructs that have no traditional C
2724 equivalent, and/or problematic constructs which should be avoided.
2725
2726 @itemize @bullet
2727 @item
2728 Macro parameters that appear within string literals in the macro body.
2729 In traditional C macro replacement takes place within string literals,
2730 but does not in ISO C@.
2731
2732 @item
2733 In traditional C, some preprocessor directives did not exist.
2734 Traditional preprocessors would only consider a line to be a directive
2735 if the @samp{#} appeared in column 1 on the line.  Therefore
2736 @option{-Wtraditional} warns about directives that traditional C
2737 understands but would ignore because the @samp{#} does not appear as the
2738 first character on the line.  It also suggests you hide directives like
2739 @samp{#pragma} not understood by traditional C by indenting them.  Some
2740 traditional implementations would not recognize @samp{#elif}, so it
2741 suggests avoiding it altogether.
2742
2743 @item
2744 A function-like macro that appears without arguments.
2745
2746 @item
2747 The unary plus operator.
2748
2749 @item
2750 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2751 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2752 constants.)  Note, these suffixes appear in macros defined in the system
2753 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2754 Use of these macros in user code might normally lead to spurious
2755 warnings, however GCC's integrated preprocessor has enough context to
2756 avoid warning in these cases.
2757
2758 @item
2759 A function declared external in one block and then used after the end of
2760 the block.
2761
2762 @item
2763 A @code{switch} statement has an operand of type @code{long}.
2764
2765 @item
2766 A non-@code{static} function declaration follows a @code{static} one.
2767 This construct is not accepted by some traditional C compilers.
2768
2769 @item
2770 The ISO type of an integer constant has a different width or
2771 signedness from its traditional type.  This warning is only issued if
2772 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2773 typically represent bit patterns, are not warned about.
2774
2775 @item
2776 Usage of ISO string concatenation is detected.
2777
2778 @item
2779 Initialization of automatic aggregates.
2780
2781 @item
2782 Identifier conflicts with labels.  Traditional C lacks a separate
2783 namespace for labels.
2784
2785 @item
2786 Initialization of unions.  If the initializer is zero, the warning is
2787 omitted.  This is done under the assumption that the zero initializer in
2788 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2789 initializer warnings and relies on default initialization to zero in the
2790 traditional C case.
2791
2792 @item
2793 Conversions by prototypes between fixed/floating point values and vice
2794 versa.  The absence of these prototypes when compiling with traditional
2795 C would cause serious problems.  This is a subset of the possible
2796 conversion warnings, for the full set use @option{-Wconversion}.
2797
2798 @item
2799 Use of ISO C style function definitions.  This warning intentionally is
2800 @emph{not} issued for prototype declarations or variadic functions
2801 because these ISO C features will appear in your code when using
2802 libiberty's traditional C compatibility macros, @code{PARAMS} and
2803 @code{VPARAMS}.  This warning is also bypassed for nested functions
2804 because that feature is already a GCC extension and thus not relevant to
2805 traditional C compatibility.
2806 @end itemize
2807
2808 @item -Wdeclaration-after-statement @r{(C only)}
2809 @opindex Wdeclaration-after-statement
2810 Warn when a declaration is found after a statement in a block.  This
2811 construct, known from C++, was introduced with ISO C99 and is by default
2812 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2813 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2814
2815 @item -Wundef
2816 @opindex Wundef
2817 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2818
2819 @item -Wendif-labels
2820 @opindex Wendif-labels
2821 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2822
2823 @item -Wshadow
2824 @opindex Wshadow
2825 Warn whenever a local variable shadows another local variable, parameter or
2826 global variable or whenever a built-in function is shadowed.
2827
2828 @item -Wlarger-than-@var{len}
2829 @opindex Wlarger-than
2830 Warn whenever an object of larger than @var{len} bytes is defined.
2831
2832 @item -Wpointer-arith
2833 @opindex Wpointer-arith
2834 Warn about anything that depends on the ``size of'' a function type or
2835 of @code{void}.  GNU C assigns these types a size of 1, for
2836 convenience in calculations with @code{void *} pointers and pointers
2837 to functions.
2838
2839 @item -Wbad-function-cast @r{(C only)}
2840 @opindex Wbad-function-cast
2841 Warn whenever a function call is cast to a non-matching type.
2842 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2843
2844 @item -Wcast-qual
2845 @opindex Wcast-qual
2846 Warn whenever a pointer is cast so as to remove a type qualifier from
2847 the target type.  For example, warn if a @code{const char *} is cast
2848 to an ordinary @code{char *}.
2849
2850 @item -Wcast-align
2851 @opindex Wcast-align
2852 Warn whenever a pointer is cast such that the required alignment of the
2853 target is increased.  For example, warn if a @code{char *} is cast to
2854 an @code{int *} on machines where integers can only be accessed at
2855 two- or four-byte boundaries.
2856
2857 @item -Wwrite-strings
2858 @opindex Wwrite-strings
2859 When compiling C, give string constants the type @code{const
2860 char[@var{length}]} so that
2861 copying the address of one into a non-@code{const} @code{char *}
2862 pointer will get a warning; when compiling C++, warn about the
2863 deprecated conversion from string constants to @code{char *}.
2864 These warnings will help you find at
2865 compile time code that can try to write into a string constant, but
2866 only if you have been very careful about using @code{const} in
2867 declarations and prototypes.  Otherwise, it will just be a nuisance;
2868 this is why we did not make @option{-Wall} request these warnings.
2869
2870 @item -Wconversion
2871 @opindex Wconversion
2872 Warn if a prototype causes a type conversion that is different from what
2873 would happen to the same argument in the absence of a prototype.  This
2874 includes conversions of fixed point to floating and vice versa, and
2875 conversions changing the width or signedness of a fixed point argument
2876 except when the same as the default promotion.
2877
2878 Also, warn if a negative integer constant expression is implicitly
2879 converted to an unsigned type.  For example, warn about the assignment
2880 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2881 casts like @code{(unsigned) -1}.
2882
2883 @item -Wsign-compare
2884 @opindex Wsign-compare
2885 @cindex warning for comparison of signed and unsigned values
2886 @cindex comparison of signed and unsigned values, warning
2887 @cindex signed and unsigned values, comparison warning
2888 Warn when a comparison between signed and unsigned values could produce
2889 an incorrect result when the signed value is converted to unsigned.
2890 This warning is also enabled by @option{-Wextra}; to get the other warnings
2891 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2892
2893 @item -Waggregate-return
2894 @opindex Waggregate-return
2895 Warn if any functions that return structures or unions are defined or
2896 called.  (In languages where you can return an array, this also elicits
2897 a warning.)
2898
2899 @item -Wstrict-prototypes @r{(C only)}
2900 @opindex Wstrict-prototypes
2901 Warn if a function is declared or defined without specifying the
2902 argument types.  (An old-style function definition is permitted without
2903 a warning if preceded by a declaration which specifies the argument
2904 types.)
2905
2906 @item -Wold-style-definition @r{(C only)}
2907 @opindex Wold-style-definition
2908 Warn if an old-style function definition is used.  A warning is given
2909 even if there is a previous prototype.
2910
2911 @item -Wmissing-prototypes @r{(C only)}
2912 @opindex Wmissing-prototypes
2913 Warn if a global function is defined without a previous prototype
2914 declaration.  This warning is issued even if the definition itself
2915 provides a prototype.  The aim is to detect global functions that fail
2916 to be declared in header files.
2917
2918 @item -Wmissing-declarations @r{(C only)}
2919 @opindex Wmissing-declarations
2920 Warn if a global function is defined without a previous declaration.
2921 Do so even if the definition itself provides a prototype.
2922 Use this option to detect global functions that are not declared in
2923 header files.
2924
2925 @item -Wmissing-field-initializers
2926 @opindex Wmissing-field-initializers
2927 @opindex W
2928 @opindex Wextra
2929 Warn if a structure's initializer has some fields missing.  For
2930 example, the following code would cause such a warning, because
2931 @code{x.h} is implicitly zero:
2932
2933 @smallexample
2934 struct s @{ int f, g, h; @};
2935 struct s x = @{ 3, 4 @};
2936 @end smallexample
2937
2938 This option does not warn about designated initializers, so the following
2939 modification would not trigger a warning:
2940
2941 @smallexample
2942 struct s @{ int f, g, h; @};
2943 struct s x = @{ .f = 3, .g = 4 @};
2944 @end smallexample
2945
2946 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2947 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2948
2949 @item -Wmissing-noreturn
2950 @opindex Wmissing-noreturn
2951 Warn about functions which might be candidates for attribute @code{noreturn}.
2952 Note these are only possible candidates, not absolute ones.  Care should
2953 be taken to manually verify functions actually do not ever return before
2954 adding the @code{noreturn} attribute, otherwise subtle code generation
2955 bugs could be introduced.  You will not get a warning for @code{main} in
2956 hosted C environments.
2957
2958 @item -Wmissing-format-attribute
2959 @opindex Wmissing-format-attribute
2960 @opindex Wformat
2961 If @option{-Wformat} is enabled, also warn about functions which might be
2962 candidates for @code{format} attributes.  Note these are only possible
2963 candidates, not absolute ones.  GCC will guess that @code{format}
2964 attributes might be appropriate for any function that calls a function
2965 like @code{vprintf} or @code{vscanf}, but this might not always be the
2966 case, and some functions for which @code{format} attributes are
2967 appropriate may not be detected.  This option has no effect unless
2968 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2969
2970 @item -Wno-multichar
2971 @opindex Wno-multichar
2972 @opindex Wmultichar
2973 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2974 Usually they indicate a typo in the user's code, as they have
2975 implementation-defined values, and should not be used in portable code.
2976
2977 @item -Wno-deprecated-declarations
2978 @opindex Wno-deprecated-declarations
2979 Do not warn about uses of functions, variables, and types marked as
2980 deprecated by using the @code{deprecated} attribute.
2981 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2982 @pxref{Type Attributes}.)
2983
2984 @item -Wpacked
2985 @opindex Wpacked
2986 Warn if a structure is given the packed attribute, but the packed
2987 attribute has no effect on the layout or size of the structure.
2988 Such structures may be mis-aligned for little benefit.  For
2989 instance, in this code, the variable @code{f.x} in @code{struct bar}
2990 will be misaligned even though @code{struct bar} does not itself
2991 have the packed attribute:
2992
2993 @smallexample
2994 @group
2995 struct foo @{
2996   int x;
2997   char a, b, c, d;
2998 @} __attribute__((packed));
2999 struct bar @{
3000   char z;
3001   struct foo f;
3002 @};
3003 @end group
3004 @end smallexample
3005
3006 @item -Wpadded
3007 @opindex Wpadded
3008 Warn if padding is included in a structure, either to align an element
3009 of the structure or to align the whole structure.  Sometimes when this
3010 happens it is possible to rearrange the fields of the structure to
3011 reduce the padding and so make the structure smaller.
3012
3013 @item -Wredundant-decls
3014 @opindex Wredundant-decls
3015 Warn if anything is declared more than once in the same scope, even in
3016 cases where multiple declaration is valid and changes nothing.
3017
3018 @item -Wnested-externs @r{(C only)}
3019 @opindex Wnested-externs
3020 Warn if an @code{extern} declaration is encountered within a function.
3021
3022 @item -Wunreachable-code
3023 @opindex Wunreachable-code
3024 Warn if the compiler detects that code will never be executed.
3025
3026 This option is intended to warn when the compiler detects that at
3027 least a whole line of source code will never be executed, because
3028 some condition is never satisfied or because it is after a
3029 procedure that never returns.
3030
3031 It is possible for this option to produce a warning even though there
3032 are circumstances under which part of the affected line can be executed,
3033 so care should be taken when removing apparently-unreachable code.
3034
3035 For instance, when a function is inlined, a warning may mean that the
3036 line is unreachable in only one inlined copy of the function.
3037
3038 This option is not made part of @option{-Wall} because in a debugging
3039 version of a program there is often substantial code which checks
3040 correct functioning of the program and is, hopefully, unreachable
3041 because the program does work.  Another common use of unreachable
3042 code is to provide behavior which is selectable at compile-time.
3043
3044 @item -Winline
3045 @opindex Winline
3046 Warn if a function can not be inlined and it was declared as inline.
3047 Even with this option, the compiler will not warn about failures to
3048 inline functions declared in system headers.
3049
3050 The compiler uses a variety of heuristics to determine whether or not
3051 to inline a function.  For example, the compiler takes into account
3052 the size of the function being inlined and the the amount of inlining
3053 that has already been done in the current function.  Therefore,
3054 seemingly insignificant changes in the source program can cause the
3055 warnings produced by @option{-Winline} to appear or disappear.
3056
3057 @item -Wno-invalid-offsetof @r{(C++ only)}
3058 @opindex Wno-invalid-offsetof
3059 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3060 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3061 to a non-POD type is undefined.  In existing C++ implementations,
3062 however, @samp{offsetof} typically gives meaningful results even when
3063 applied to certain kinds of non-POD types. (Such as a simple
3064 @samp{struct} that fails to be a POD type only by virtue of having a
3065 constructor.)  This flag is for users who are aware that they are
3066 writing nonportable code and who have deliberately chosen to ignore the
3067 warning about it.
3068
3069 The restrictions on @samp{offsetof} may be relaxed in a future version
3070 of the C++ standard.
3071
3072 @item -Winvalid-pch
3073 @opindex Winvalid-pch
3074 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3075 the search path but can't be used.
3076
3077 @item -Wlong-long
3078 @opindex Wlong-long
3079 @opindex Wno-long-long
3080 Warn if @samp{long long} type is used.  This is default.  To inhibit
3081 the warning messages, use @option{-Wno-long-long}.  Flags
3082 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3083 only when @option{-pedantic} flag is used.
3084
3085 @item -Wvariadic-macros
3086 @opindex Wvariadic-macros
3087 @opindex Wno-variadic-macros
3088 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3089 alternate syntax when in pedantic ISO C99 mode.  This is default.
3090 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3091
3092 @item -Wdisabled-optimization
3093 @opindex Wdisabled-optimization
3094 Warn if a requested optimization pass is disabled.  This warning does
3095 not generally indicate that there is anything wrong with your code; it
3096 merely indicates that GCC's optimizers were unable to handle the code
3097 effectively.  Often, the problem is that your code is too big or too
3098 complex; GCC will refuse to optimize programs when the optimization
3099 itself is likely to take inordinate amounts of time.
3100
3101 @item -Werror
3102 @opindex Werror
3103 Make all warnings into errors.
3104 @end table
3105
3106 @node Debugging Options
3107 @section Options for Debugging Your Program or GCC
3108 @cindex options, debugging
3109 @cindex debugging information options
3110
3111 GCC has various special options that are used for debugging
3112 either your program or GCC:
3113
3114 @table @gcctabopt
3115 @item -g
3116 @opindex g
3117 Produce debugging information in the operating system's native format
3118 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3119 information.
3120
3121 On most systems that use stabs format, @option{-g} enables use of extra
3122 debugging information that only GDB can use; this extra information
3123 makes debugging work better in GDB but will probably make other debuggers
3124 crash or
3125 refuse to read the program.  If you want to control for certain whether
3126 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3127 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3128
3129 Unlike most other C compilers, GCC allows you to use @option{-g} with
3130 @option{-O}.  The shortcuts taken by optimized code may occasionally
3131 produce surprising results: some variables you declared may not exist
3132 at all; flow of control may briefly move where you did not expect it;
3133 some statements may not be executed because they compute constant
3134 results or their values were already at hand; some statements may
3135 execute in different places because they were moved out of loops.
3136
3137 Nevertheless it proves possible to debug optimized output.  This makes
3138 it reasonable to use the optimizer for programs that might have bugs.
3139
3140 The following options are useful when GCC is generated with the
3141 capability for more than one debugging format.
3142
3143 @item -ggdb
3144 @opindex ggdb
3145 Produce debugging information for use by GDB@.  This means to use the
3146 most expressive format available (DWARF 2, stabs, or the native format
3147 if neither of those are supported), including GDB extensions if at all
3148 possible.
3149
3150 @item -gstabs
3151 @opindex gstabs
3152 Produce debugging information in stabs format (if that is supported),
3153 without GDB extensions.  This is the format used by DBX on most BSD
3154 systems.  On MIPS, Alpha and System V Release 4 systems this option
3155 produces stabs debugging output which is not understood by DBX or SDB@.
3156 On System V Release 4 systems this option requires the GNU assembler.
3157
3158 @item -feliminate-unused-debug-symbols
3159 @opindex feliminate-unused-debug-symbols
3160 Produce debugging information in stabs format (if that is supported),
3161 for only symbols that are actually used.
3162
3163 @item -gstabs+
3164 @opindex gstabs+
3165 Produce debugging information in stabs format (if that is supported),
3166 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3167 use of these extensions is likely to make other debuggers crash or
3168 refuse to read the program.
3169
3170 @item -gcoff
3171 @opindex gcoff
3172 Produce debugging information in COFF format (if that is supported).
3173 This is the format used by SDB on most System V systems prior to
3174 System V Release 4.
3175
3176 @item -gxcoff
3177 @opindex gxcoff
3178 Produce debugging information in XCOFF format (if that is supported).
3179 This is the format used by the DBX debugger on IBM RS/6000 systems.
3180
3181 @item -gxcoff+
3182 @opindex gxcoff+
3183 Produce debugging information in XCOFF format (if that is supported),
3184 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3185 use of these extensions is likely to make other debuggers crash or
3186 refuse to read the program, and may cause assemblers other than the GNU
3187 assembler (GAS) to fail with an error.
3188
3189 @item -gdwarf-2
3190 @opindex gdwarf-2
3191 Produce debugging information in DWARF version 2 format (if that is
3192 supported).  This is the format used by DBX on IRIX 6.
3193
3194 @item -gvms
3195 @opindex gvms
3196 Produce debugging information in VMS debug format (if that is
3197 supported).  This is the format used by DEBUG on VMS systems.
3198
3199 @item -g@var{level}
3200 @itemx -ggdb@var{level}
3201 @itemx -gstabs@var{level}
3202 @itemx -gcoff@var{level}
3203 @itemx -gxcoff@var{level}
3204 @itemx -gvms@var{level}
3205 Request debugging information and also use @var{level} to specify how
3206 much information.  The default level is 2.
3207
3208 Level 1 produces minimal information, enough for making backtraces in
3209 parts of the program that you don't plan to debug.  This includes
3210 descriptions of functions and external variables, but no information
3211 about local variables and no line numbers.
3212
3213 Level 3 includes extra information, such as all the macro definitions
3214 present in the program.  Some debuggers support macro expansion when
3215 you use @option{-g3}.
3216
3217 Note that in order to avoid confusion between DWARF1 debug level 2,
3218 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3219 level.  Instead use an additional @option{-g@var{level}} option to
3220 change the debug level for DWARF2.
3221
3222 @item -feliminate-dwarf2-dups
3223 @opindex feliminate-dwarf2-dups
3224 Compress DWARF2 debugging information by eliminating duplicated
3225 information about each symbol.  This option only makes sense when
3226 generating DWARF2 debugging information with @option{-gdwarf-2}.
3227
3228 @cindex @command{prof}
3229 @item -p
3230 @opindex p
3231 Generate extra code to write profile information suitable for the
3232 analysis program @command{prof}.  You must use this option when compiling
3233 the source files you want data about, and you must also use it when
3234 linking.
3235
3236 @cindex @command{gprof}
3237 @item -pg
3238 @opindex pg
3239 Generate extra code to write profile information suitable for the
3240 analysis program @command{gprof}.  You must use this option when compiling
3241 the source files you want data about, and you must also use it when
3242 linking.
3243
3244 @item -Q
3245 @opindex Q
3246 Makes the compiler print out each function name as it is compiled, and
3247 print some statistics about each pass when it finishes.
3248
3249 @item -ftime-report
3250 @opindex ftime-report
3251 Makes the compiler print some statistics about the time consumed by each
3252 pass when it finishes.
3253
3254 @item -fmem-report
3255 @opindex fmem-report
3256 Makes the compiler print some statistics about permanent memory
3257 allocation when it finishes.
3258
3259 @item -fprofile-arcs
3260 @opindex fprofile-arcs
3261 Add code so that program flow @dfn{arcs} are instrumented.  During
3262 execution the program records how many times each branch and call is
3263 executed and how many times it is taken or returns.  When the compiled
3264 program exits it saves this data to a file called
3265 @file{@var{auxname}.gcda} for each source file. The data may be used for
3266 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3267 test coverage analysis (@option{-ftest-coverage}). Each object file's
3268 @var{auxname} is generated from the name of the output file, if
3269 explicitly specified and it is not the final executable, otherwise it is
3270 the basename of the source file. In both cases any suffix is removed
3271 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3272 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3273
3274 @itemize
3275
3276 @item
3277 Compile the source files with @option{-fprofile-arcs} plus optimization
3278 and code generation options. For test coverage analysis, use the
3279 additional @option{-ftest-coverage} option. You do not need to profile
3280 every source file in a program.
3281
3282 @item
3283 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3284 (the latter implies the former).
3285
3286 @item
3287 Run the program on a representative workload to generate the arc profile
3288 information. This may be repeated any number of times. You can run
3289 concurrent instances of your program, and provided that the file system
3290 supports locking, the data files will be correctly updated. Also
3291 @code{fork} calls are detected and correctly handled (double counting
3292 will not happen).
3293
3294 @item
3295 For profile-directed optimizations, compile the source files again with
3296 the same optimization and code generation options plus
3297 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3298 Control Optimization}).
3299
3300 @item
3301 For test coverage analysis, use @command{gcov} to produce human readable
3302 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3303 @command{gcov} documentation for further information.
3304
3305 @end itemize
3306
3307 With @option{-fprofile-arcs}, for each function of your program GCC
3308 creates a program flow graph, then finds a spanning tree for the graph.
3309 Only arcs that are not on the spanning tree have to be instrumented: the
3310 compiler adds code to count the number of times that these arcs are
3311 executed.  When an arc is the only exit or only entrance to a block, the
3312 instrumentation code can be added to the block; otherwise, a new basic
3313 block must be created to hold the instrumentation code.
3314
3315 @item -ftree-based-profiling
3316 @opindex ftree-based-profiling
3317 This option is used in addition to @option{-fprofile-arcs} or
3318 @option{-fbranch-probabilities} to control whether those optimizations
3319 are performed on a tree-based or rtl-based internal representation.
3320 If you use this option when compiling with @option{-fprofile-arcs},
3321 you must also use it when compiling later with @option{-fbranch-probabilities}.
3322 Currently the tree-based optimization is in an early stage of
3323 development, and this option is recommended only for those people
3324 working on improving it.
3325
3326 @need 2000
3327 @item -ftest-coverage
3328 @opindex ftest-coverage
3329 Produce a notes file that the @command{gcov} code-coverage utility
3330 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3331 show program coverage. Each source file's note file is called
3332 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3333 above for a description of @var{auxname} and instructions on how to
3334 generate test coverage data. Coverage data will match the source files
3335 more closely, if you do not optimize.
3336
3337 @item -d@var{letters}
3338 @opindex d
3339 Says to make debugging dumps during compilation at times specified by
3340 @var{letters}.  This is used for debugging the compiler.  The file names
3341 for most of the dumps are made by appending a pass number and a word to
3342 the @var{dumpname}. @var{dumpname} is generated from the name of the
3343 output file, if explicitly specified and it is not an executable,
3344 otherwise it is the basename of the source file. In both cases any
3345 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3346 Here are the possible letters for use in @var{letters}, and their
3347 meanings:
3348
3349 @table @samp
3350 @item A
3351 @opindex dA
3352 Annotate the assembler output with miscellaneous debugging information.
3353 @item b
3354 @opindex db
3355 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3356 @item B
3357 @opindex dB
3358 Dump after block reordering, to @file{@var{file}.32.bbro}.
3359 @item c
3360 @opindex dc
3361 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3362 @item C
3363 @opindex dC
3364 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3365 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3366 @item d
3367 @opindex dd
3368 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3369 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3370 @item D
3371 @opindex dD
3372 Dump all macro definitions, at the end of preprocessing, in addition to
3373 normal output.
3374 @item E
3375 @opindex dE
3376 Dump after the third if conversion, to @file{@var{file}.31.ce3}.
3377 @item f
3378 @opindex df
3379 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3380 Also dump after life analysis, to @file{@var{file}.19.life}.
3381 @item g
3382 @opindex dg
3383 Dump after global register allocation, to @file{@var{file}.26.greg}.
3384 @item G
3385 @opindex dG
3386 Dump after GCSE, to @file{@var{file}.08.gcse}.
3387 Also dump after jump bypassing and control flow optimizations, to
3388 @file{@var{file}.10.bypass}.
3389 @item h
3390 @opindex dh
3391 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3392 @item i
3393 @opindex di
3394 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3395 @item j
3396 @opindex dj
3397 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3398 @item k
3399 @opindex dk
3400 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3401 @item l
3402 @opindex dl
3403 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3404 @item L
3405 @opindex dL
3406 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3407 @file{@var{file}.16.loop2}.
3408 @item m
3409 @opindex dm
3410 Dump after modulo scheduling, to @file{@var{file}.23.sms}.
3411 @item M
3412 @opindex dM
3413 Dump after performing the machine dependent reorganization pass, to
3414 @file{@var{file}.36.mach}.
3415 @item n
3416 @opindex dn
3417 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3418 @item N
3419 @opindex dN
3420 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3421 @item o
3422 @opindex do
3423 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3424 @item r
3425 @opindex dr
3426 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3427 @item R
3428 @opindex dR
3429 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3430 @item s
3431 @opindex ds
3432 Dump after CSE (including the jump optimization that sometimes follows
3433 CSE), to @file{@var{file}.06.cse}.
3434 @item S
3435 @opindex dS
3436 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3437 @item t
3438 @opindex dt
3439 Dump after the second CSE pass (including the jump optimization that
3440 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3441 @item T
3442 @opindex dT
3443 Dump after running tracer, to @file{@var{file}.15.tracer}.
3444 @item u
3445 @opindex du
3446 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3447 @item U
3448 @opindex dU
3449 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3450 @item V
3451 @opindex dV
3452 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3453 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3454 @item w
3455 @opindex dw
3456 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3457 @item z
3458 @opindex dz
3459 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3460 @item Z
3461 @opindex dZ
3462 Dump after constructing the web, to @file{@var{file}.17.web}.
3463 @item a
3464 @opindex da
3465 Produce all the dumps listed above.
3466 @item H
3467 @opindex dH
3468 Produce a core dump whenever an error occurs.
3469 @item m
3470 @opindex dm
3471 Print statistics on memory usage, at the end of the run, to
3472 standard error.
3473 @item p
3474 @opindex dp
3475 Annotate the assembler output with a comment indicating which
3476 pattern and alternative was used.  The length of each instruction is
3477 also printed.
3478 @item P
3479 @opindex dP
3480 Dump the RTL in the assembler output as a comment before each instruction.
3481 Also turns on @option{-dp} annotation.
3482 @item v
3483 @opindex dv
3484 For each of the other indicated dump files (except for
3485 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3486 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3487 @item x
3488 @opindex dx
3489 Just generate RTL for a function instead of compiling it.  Usually used
3490 with @samp{r}.
3491 @item y
3492 @opindex dy
3493 Dump debugging information during parsing, to standard error.
3494 @end table
3495
3496 @item -fdump-unnumbered
3497 @opindex fdump-unnumbered
3498 When doing debugging dumps (see @option{-d} option above), suppress instruction
3499 numbers and line number note output.  This makes it more feasible to
3500 use diff on debugging dumps for compiler invocations with different
3501 options, in particular with and without @option{-g}.
3502
3503 @item -fdump-translation-unit @r{(C and C++ only)}
3504 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3505 @opindex fdump-translation-unit
3506 Dump a representation of the tree structure for the entire translation
3507 unit to a file.  The file name is made by appending @file{.tu} to the
3508 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3509 controls the details of the dump as described for the
3510 @option{-fdump-tree} options.
3511
3512 @item -fdump-class-hierarchy @r{(C++ only)}
3513 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3514 @opindex fdump-class-hierarchy
3515 Dump a representation of each class's hierarchy and virtual function
3516 table layout to a file.  The file name is made by appending @file{.class}
3517 to the source file name.  If the @samp{-@var{options}} form is used,
3518 @var{options} controls the details of the dump as described for the
3519 @option{-fdump-tree} options.
3520
3521 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3522 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3523 @opindex fdump-tree
3524 Control the dumping at various stages of processing the intermediate
3525 language tree to a file.  The file name is generated by appending a switch
3526 specific suffix to the source file name.  If the @samp{-@var{options}}
3527 form is used, @var{options} is a list of @samp{-} separated options that
3528 control the details of the dump. Not all options are applicable to all
3529 dumps, those which are not meaningful will be ignored. The following
3530 options are available
3531
3532 @table @samp
3533 @item address
3534 Print the address of each node.  Usually this is not meaningful as it
3535 changes according to the environment and source file. Its primary use
3536 is for tying up a dump file with a debug environment.
3537 @item slim
3538 Inhibit dumping of members of a scope or body of a function merely
3539 because that scope has been reached.  Only dump such items when they
3540 are directly reachable by some other path.  When dumping pretty-printed
3541 trees, this option inhibits dumping the bodies of control structures.
3542 @item raw
3543 Print a raw representation of the tree.  By default, trees are
3544 pretty-printed into a C-like representation.
3545 @item details
3546 Enable more detailed dumps (not honored by every dump option).
3547 @item stats
3548 Enable dumping various statistics about the pass (not honored by every dump
3549 option).
3550 @item blocks
3551 Enable showing basic block boundaries (disabled in raw dumps).
3552 @item vops
3553 Enable showing virtual operands for every statement.
3554 @item lineno
3555 Enable showing line numbers for statements.
3556 @item uid
3557 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3558 @item all
3559 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3560 @end table
3561
3562 The following tree dumps are possible:
3563 @table @samp
3564
3565 @item original
3566 Dump before any tree based optimization, to @file{@var{file}.original}.
3567
3568 @item optimized
3569 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3570
3571 @item inlined
3572 Dump after function inlining, to @file{@var{file}.inlined}.
3573
3574 @item gimple
3575 @opindex fdump-tree-gimple
3576 Dump each function before and after the gimplification pass to a file.  The
3577 file name is made by appending @file{.gimple} to the source file name.
3578
3579 @item cfg
3580 @opindex fdump-tree-cfg
3581 Dump the control flow graph of each function to a file.  The file name is
3582 made by appending @file{.cfg} to the source file name.
3583
3584 @item vcg
3585 @opindex fdump-tree-vcg
3586 Dump the control flow graph of each function to a file in VCG format.  The
3587 file name is made by appending @file{.vcg} to the source file name.  Note
3588 that if the file contains more than one function, the generated file cannot
3589 be used directly by VCG.  You will need to cut and paste each function's
3590 graph into its own separate file first.
3591
3592 @item ch
3593 @opindex fdump-tree-ch
3594 Dump each function after copying loop headers.  The file name is made by
3595 appending @file{.ch} to the source file name.
3596
3597 @item ssa
3598 @opindex fdump-tree-ssa
3599 Dump SSA related information to a file.  The file name is made by appending
3600 @file{.ssa} to the source file name.
3601
3602 @item alias
3603 @opindex fdump-tree-alias
3604 Dump aliasing information for each function.  The file name is made by
3605 appending @file{.alias} to the source file name.
3606
3607 @item ccp
3608 @opindex fdump-tree-ccp
3609 Dump each function after CCP.  The file name is made by appending
3610 @file{.ccp} to the source file name.
3611
3612 @item pre
3613 @opindex fdump-tree-pre
3614 Dump trees after partial redundancy elimination.  The file name is made
3615 by appending @file{.pre} to the source file name.
3616
3617 @item fre
3618 @opindex fdump-tree-fre
3619 Dump trees after full redundancy elimination.  The file name is made
3620 by appending @file{.fre} to the source file name.
3621
3622 @item dce
3623 @opindex fdump-tree-dce
3624 Dump each function after dead code elimination.  The file name is made by
3625 appending @file{.dce} to the source file name.
3626
3627 @item mudflap
3628 @opindex fdump-tree-mudflap
3629 Dump each function after adding mudflap instrumentation.  The file name is
3630 made by appending @file{.mudflap} to the source file name.
3631
3632 @item sra
3633 @opindex fdump-tree-sra
3634 Dump each function after performing scalar replacement of aggregates.  The
3635 file name is made by appending @file{.sra} to the source file name.
3636
3637 @item dom
3638 @opindex fdump-tree-dom
3639 Dump each function after applying dominator tree optimizations.  The file
3640 name is made by appending @file{.dom} to the source file name.
3641
3642 @item dse
3643 @opindex fdump-tree-dse
3644 Dump each function after applying dead store elimination.  The file
3645 name is made by appending @file{.dse} to the source file name.
3646
3647 @item phiopt
3648 @opindex fdump-tree-phiopt
3649 Dump each function after optimizing PHI nodes into straightline code.  The file
3650 name is made by appending @file{.phiopt} to the source file name.
3651
3652 @item forwprop
3653 @opindex fdump-tree-forwprop
3654 Dump each function after forward propagating single use variables.  The file
3655 name is made by appending @file{.forwprop} to the source file name.
3656
3657 @item copyrename
3658 @opindex fdump-tree-copyrename
3659 Dump each function after applying the copy rename optimization.  The file
3660 name is made by appending @file{.copyrename} to the source file name.
3661
3662 @item nrv
3663 @opindex fdump-tree-nrv
3664 Dump each function after applying the named return value optimization on
3665 generic trees.  The file name is made by appending @file{.nrv} to the source
3666 file name.
3667
3668 @item vect
3669 @opindex fdump-tree-vect
3670 Dump each function after applying vectorization of loops.  The file name is 
3671 made by appending @file{.vect} to the source file name.
3672
3673 @item all
3674 @opindex fdump-tree-all
3675 Enable all the available tree dumps with the flags provided in this option.
3676 @end table
3677
3678 @item -frandom-seed=@var{string}
3679 @opindex frandom-string
3680 This option provides a seed that GCC uses when it would otherwise use
3681 random numbers.  It is used to generate certain symbol names
3682 that have to be different in every compiled file. It is also used to
3683 place unique stamps in coverage data files and the object files that
3684 produce them. You can use the @option{-frandom-seed} option to produce
3685 reproducibly identical object files.
3686
3687 The @var{string} should be different for every file you compile.
3688
3689 @item -fsched-verbose=@var{n}
3690 @opindex fsched-verbose
3691 On targets that use instruction scheduling, this option controls the
3692 amount of debugging output the scheduler prints.  This information is
3693 written to standard error, unless @option{-dS} or @option{-dR} is
3694 specified, in which case it is output to the usual dump
3695 listing file, @file{.sched} or @file{.sched2} respectively.  However
3696 for @var{n} greater than nine, the output is always printed to standard
3697 error.
3698
3699 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3700 same information as @option{-dRS}.  For @var{n} greater than one, it
3701 also output basic block probabilities, detailed ready list information
3702 and unit/insn info.  For @var{n} greater than two, it includes RTL
3703 at abort point, control-flow and regions info.  And for @var{n} over
3704 four, @option{-fsched-verbose} also includes dependence info.
3705
3706 @item -save-temps
3707 @opindex save-temps
3708 Store the usual ``temporary'' intermediate files permanently; place them
3709 in the current directory and name them based on the source file.  Thus,
3710 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3711 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3712 preprocessed @file{foo.i} output file even though the compiler now
3713 normally uses an integrated preprocessor.
3714
3715 @item -time
3716 @opindex time
3717 Report the CPU time taken by each subprocess in the compilation
3718 sequence.  For C source files, this is the compiler proper and assembler
3719 (plus the linker if linking is done).  The output looks like this:
3720
3721 @smallexample
3722 # cc1 0.12 0.01
3723 # as 0.00 0.01
3724 @end smallexample
3725
3726 The first number on each line is the ``user time,'' that is time spent
3727 executing the program itself.  The second number is ``system time,''
3728 time spent executing operating system routines on behalf of the program.
3729 Both numbers are in seconds.
3730
3731 @item -fvar-tracking
3732 @opindex fvar-tracking
3733 Run variable tracking pass. It computes where variables are stored at each
3734 position in code. Better debugging information is then generated
3735 (if the debugging information format supports this information).
3736
3737 It is enabled by default when compiling with optimization (@option{-Os},
3738 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3739 the debug info format supports it.
3740
3741 @item -print-file-name=@var{library}
3742 @opindex print-file-name
3743 Print the full absolute name of the library file @var{library} that
3744 would be used when linking---and don't do anything else.  With this
3745 option, GCC does not compile or link anything; it just prints the
3746 file name.
3747
3748 @item -print-multi-directory
3749 @opindex print-multi-directory
3750 Print the directory name corresponding to the multilib selected by any
3751 other switches present in the command line.  This directory is supposed
3752 to exist in @env{GCC_EXEC_PREFIX}.
3753
3754 @item -print-multi-lib
3755 @opindex print-multi-lib
3756 Print the mapping from multilib directory names to compiler switches
3757 that enable them.  The directory name is separated from the switches by
3758 @samp{;}, and each switch starts with an @samp{@@} instead of the
3759 @samp{-}, without spaces between multiple switches.  This is supposed to
3760 ease shell-processing.
3761
3762 @item -print-prog-name=@var{program}
3763 @opindex print-prog-name
3764 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3765
3766 @item -print-libgcc-file-name
3767 @opindex print-libgcc-file-name
3768 Same as @option{-print-file-name=libgcc.a}.
3769
3770 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3771 but you do want to link with @file{libgcc.a}.  You can do
3772
3773 @smallexample
3774 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3775 @end smallexample
3776
3777 @item -print-search-dirs
3778 @opindex print-search-dirs
3779 Print the name of the configured installation directory and a list of
3780 program and library directories @command{gcc} will search---and don't do anything else.
3781
3782 This is useful when @command{gcc} prints the error message
3783 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3784 To resolve this you either need to put @file{cpp0} and the other compiler
3785 components where @command{gcc} expects to find them, or you can set the environment
3786 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3787 Don't forget the trailing '/'.
3788 @xref{Environment Variables}.
3789
3790 @item -dumpmachine
3791 @opindex dumpmachine
3792 Print the compiler's target machine (for example,
3793 @samp{i686-pc-linux-gnu})---and don't do anything else.
3794
3795 @item -dumpversion
3796 @opindex dumpversion
3797 Print the compiler version (for example, @samp{3.0})---and don't do
3798 anything else.
3799
3800 @item -dumpspecs
3801 @opindex dumpspecs
3802 Print the compiler's built-in specs---and don't do anything else.  (This
3803 is used when GCC itself is being built.)  @xref{Spec Files}.
3804
3805 @item -feliminate-unused-debug-types
3806 @opindex feliminate-unused-debug-types
3807 Normally, when producing DWARF2 output, GCC will emit debugging
3808 information for all types declared in a compilation
3809 unit, regardless of whether or not they are actually used
3810 in that compilation unit.  Sometimes this is useful, such as
3811 if, in the debugger, you want to cast a value to a type that is
3812 not actually used in your program (but is declared).  More often,
3813 however, this results in a significant amount of wasted space.
3814 With this option, GCC will avoid producing debug symbol output
3815 for types that are nowhere used in the source file being compiled.
3816 @end table
3817
3818 @node Optimize Options
3819 @section Options That Control Optimization
3820 @cindex optimize options
3821 @cindex options, optimization
3822
3823 These options control various sorts of optimizations.
3824
3825 Without any optimization option, the compiler's goal is to reduce the
3826 cost of compilation and to make debugging produce the expected
3827 results.  Statements are independent: if you stop the program with a
3828 breakpoint between statements, you can then assign a new value to any
3829 variable or change the program counter to any other statement in the
3830 function and get exactly the results you would expect from the source
3831 code.
3832
3833 Turning on optimization flags makes the compiler attempt to improve
3834 the performance and/or code size at the expense of compilation time
3835 and possibly the ability to debug the program.
3836
3837 The compiler performs optimization based on the knowledge it has of
3838 the program.  Optimization levels @option{-O2} and above, in
3839 particular, enable @emph{unit-at-a-time} mode, which allows the
3840 compiler to consider information gained from later functions in
3841 the file when compiling a function.  Compiling multiple files at
3842 once to a single output file in @emph{unit-at-a-time} mode allows
3843 the compiler to use information gained from all of the files when
3844 compiling each of them.
3845
3846 Not all optimizations are controlled directly by a flag.  Only
3847 optimizations that have a flag are listed.
3848
3849 @table @gcctabopt
3850 @item -O
3851 @itemx -O1
3852 @opindex O
3853 @opindex O1
3854 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3855 more memory for a large function.
3856
3857 With @option{-O}, the compiler tries to reduce code size and execution
3858 time, without performing any optimizations that take a great deal of
3859 compilation time.
3860
3861 @option{-O} turns on the following optimization flags:
3862 @gccoptlist{-fdefer-pop @gol
3863 -fmerge-constants @gol
3864 -fthread-jumps @gol
3865 -floop-optimize @gol
3866 -fif-conversion @gol
3867 -fif-conversion2 @gol
3868 -fdelayed-branch @gol
3869 -fguess-branch-probability @gol
3870 -fcprop-registers}
3871
3872 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3873 where doing so does not interfere with debugging.
3874
3875 @item -O2
3876 @opindex O2
3877 Optimize even more.  GCC performs nearly all supported optimizations
3878 that do not involve a space-speed tradeoff.  The compiler does not
3879 perform loop unrolling or function inlining when you specify @option{-O2}.
3880 As compared to @option{-O}, this option increases both compilation time
3881 and the performance of the generated code.
3882
3883 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3884 also turns on the following optimization flags:
3885 @gccoptlist{-fforce-mem @gol
3886 -foptimize-sibling-calls @gol
3887 -fstrength-reduce @gol
3888 -fcse-follow-jumps  -fcse-skip-blocks @gol
3889 -frerun-cse-after-loop  -frerun-loop-opt @gol
3890 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3891 -fdelete-null-pointer-checks @gol
3892 -fexpensive-optimizations @gol
3893 -fregmove @gol
3894 -fschedule-insns  -fschedule-insns2 @gol
3895 -fsched-interblock  -fsched-spec @gol
3896 -fcaller-saves @gol
3897 -fpeephole2 @gol
3898 -freorder-blocks  -freorder-functions @gol
3899 -fstrict-aliasing @gol
3900 -funit-at-a-time @gol
3901 -falign-functions  -falign-jumps @gol
3902 -falign-loops  -falign-labels @gol
3903 -fcrossjumping}
3904
3905 Please note the warning under @option{-fgcse} about
3906 invoking @option{-O2} on programs that use computed gotos.
3907
3908 @item -O3
3909 @opindex O3
3910 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3911 @option{-O2} and also turns on the @option{-finline-functions},
3912 @option{-fweb} and @option{-fgcse-after-reload} options.
3913
3914 @item -O0
3915 @opindex O0
3916 Do not optimize.  This is the default.
3917
3918 @item -Os
3919 @opindex Os
3920 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3921 do not typically increase code size.  It also performs further
3922 optimizations designed to reduce code size.
3923
3924 @option{-Os} disables the following optimization flags:
3925 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3926 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
3927
3928 If you use multiple @option{-O} options, with or without level numbers,
3929 the last such option is the one that is effective.
3930 @end table
3931
3932 Options of the form @option{-f@var{flag}} specify machine-independent
3933 flags.  Most flags have both positive and negative forms; the negative
3934 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3935 below, only one of the forms is listed---the one you typically will
3936 use.  You can figure out the other form by either removing @samp{no-}
3937 or adding it.
3938
3939 The following options control specific optimizations.  They are either
3940 activated by @option{-O} options or are related to ones that are.  You
3941 can use the following flags in the rare cases when ``fine-tuning'' of
3942 optimizations to be performed is desired.
3943
3944 @table @gcctabopt
3945 @item -fno-default-inline
3946 @opindex fno-default-inline
3947 Do not make member functions inline by default merely because they are
3948 defined inside the class scope (C++ only).  Otherwise, when you specify
3949 @w{@option{-O}}, member functions defined inside class scope are compiled
3950 inline by default; i.e., you don't need to add @samp{inline} in front of
3951 the member function name.
3952
3953 @item -fno-defer-pop
3954 @opindex fno-defer-pop
3955 Always pop the arguments to each function call as soon as that function
3956 returns.  For machines which must pop arguments after a function call,
3957 the compiler normally lets arguments accumulate on the stack for several
3958 function calls and pops them all at once.
3959
3960 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3961
3962 @item -fforce-mem
3963 @opindex fforce-mem
3964 Force memory operands to be copied into registers before doing
3965 arithmetic on them.  This produces better code by making all memory
3966 references potential common subexpressions.  When they are not common
3967 subexpressions, instruction combination should eliminate the separate
3968 register-load.
3969
3970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3971
3972 @item -fforce-addr
3973 @opindex fforce-addr
3974 Force memory address constants to be copied into registers before
3975 doing arithmetic on them.  This may produce better code just as
3976 @option{-fforce-mem} may.
3977
3978 @item -fomit-frame-pointer
3979 @opindex fomit-frame-pointer
3980 Don't keep the frame pointer in a register for functions that
3981 don't need one.  This avoids the instructions to save, set up and
3982 restore frame pointers; it also makes an extra register available
3983 in many functions.  @strong{It also makes debugging impossible on
3984 some machines.}
3985
3986 On some machines, such as the VAX, this flag has no effect, because
3987 the standard calling sequence automatically handles the frame pointer
3988 and nothing is saved by pretending it doesn't exist.  The
3989 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3990 whether a target machine supports this flag.  @xref{Registers,,Register
3991 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3992
3993 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3994
3995 @item -foptimize-sibling-calls
3996 @opindex foptimize-sibling-calls
3997 Optimize sibling and tail recursive calls.
3998
3999 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4000
4001 @item -fno-inline
4002 @opindex fno-inline
4003 Don't pay attention to the @code{inline} keyword.  Normally this option
4004 is used to keep the compiler from expanding any functions inline.
4005 Note that if you are not optimizing, no functions can be expanded inline.
4006
4007 @item -finline-functions
4008 @opindex finline-functions
4009 Integrate all simple functions into their callers.  The compiler
4010 heuristically decides which functions are simple enough to be worth
4011 integrating in this way.
4012
4013 If all calls to a given function are integrated, and the function is
4014 declared @code{static}, then the function is normally not output as
4015 assembler code in its own right.
4016
4017 Enabled at level @option{-O3}.
4018
4019 @item -finline-limit=@var{n}
4020 @opindex finline-limit
4021 By default, GCC limits the size of functions that can be inlined.  This flag
4022 allows the control of this limit for functions that are explicitly marked as
4023 inline (i.e., marked with the inline keyword or defined within the class
4024 definition in c++).  @var{n} is the size of functions that can be inlined in
4025 number of pseudo instructions (not counting parameter handling).  The default
4026 value of @var{n} is 600.
4027 Increasing this value can result in more inlined code at
4028 the cost of compilation time and memory consumption.  Decreasing usually makes
4029 the compilation faster and less code will be inlined (which presumably
4030 means slower programs).  This option is particularly useful for programs that
4031 use inlining heavily such as those based on recursive templates with C++.
4032
4033 Inlining is actually controlled by a number of parameters, which may be
4034 specified individually by using @option{--param @var{name}=@var{value}}.
4035 The @option{-finline-limit=@var{n}} option sets some of these parameters
4036 as follows:
4037
4038 @table @gcctabopt
4039  @item max-inline-insns-single
4040   is set to @var{n}/2.
4041  @item max-inline-insns-auto
4042   is set to @var{n}/2.
4043  @item min-inline-insns
4044   is set to 130 or @var{n}/4, whichever is smaller.
4045  @item max-inline-insns-rtl
4046   is set to @var{n}.
4047 @end table
4048
4049 See below for a documentation of the individual
4050 parameters controlling inlining.
4051
4052 @emph{Note:} pseudo instruction represents, in this particular context, an
4053 abstract measurement of function's size.  In no way, it represents a count
4054 of assembly instructions and as such its exact meaning might change from one
4055 release to an another.
4056
4057 @item -fkeep-inline-functions
4058 @opindex fkeep-inline-functions
4059 In C, emit @code{static} functions that are declared @code{inline}
4060 into the object file, even if the function has been inlined into all
4061 of its callers.  This switch does not affect functions using the
4062 @code{extern inline} extension in GNU C.  In C++, emit any and all
4063 inline functions into the object file.
4064
4065 @item -fkeep-static-consts
4066 @opindex fkeep-static-consts
4067 Emit variables declared @code{static const} when optimization isn't turned
4068 on, even if the variables aren't referenced.
4069
4070 GCC enables this option by default.  If you want to force the compiler to
4071 check if the variable was referenced, regardless of whether or not
4072 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4073
4074 @item -fmerge-constants
4075 Attempt to merge identical constants (string constants and floating point
4076 constants) across compilation units.
4077
4078 This option is the default for optimized compilation if the assembler and
4079 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4080 behavior.
4081
4082 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4083
4084 @item -fmerge-all-constants
4085 Attempt to merge identical constants and identical variables.
4086
4087 This option implies @option{-fmerge-constants}.  In addition to
4088 @option{-fmerge-constants} this considers e.g. even constant initialized
4089 arrays or initialized constant variables with integral or floating point
4090 types.  Languages like C or C++ require each non-automatic variable to
4091 have distinct location, so using this option will result in non-conforming
4092 behavior.
4093
4094 @item -fmodulo-sched
4095 @opindex fmodulo-sched
4096 Perform swing modulo scheduling immediately before the first scheduling
4097 pass.  This pass looks at innermost loops and reorders their
4098 instructions by overlapping different iterations.
4099
4100 @item -fnew-ra
4101 @opindex fnew-ra
4102 Use a graph coloring register allocator.  Currently this option is meant
4103 only for testing.  Users should not specify this option, since it is not
4104 yet ready for production use.
4105
4106 @item -fno-branch-count-reg
4107 @opindex fno-branch-count-reg
4108 Do not use ``decrement and branch'' instructions on a count register,
4109 but instead generate a sequence of instructions that decrement a
4110 register, compare it against zero, then branch based upon the result.
4111 This option is only meaningful on architectures that support such
4112 instructions, which include x86, PowerPC, IA-64 and S/390.
4113
4114 The default is @option{-fbranch-count-reg}, enabled when
4115 @option{-fstrength-reduce} is enabled.
4116
4117 @item -fno-function-cse
4118 @opindex fno-function-cse
4119 Do not put function addresses in registers; make each instruction that
4120 calls a constant function contain the function's address explicitly.
4121
4122 This option results in less efficient code, but some strange hacks
4123 that alter the assembler output may be confused by the optimizations
4124 performed when this option is not used.
4125
4126 The default is @option{-ffunction-cse}
4127
4128 @item -fno-zero-initialized-in-bss
4129 @opindex fno-zero-initialized-in-bss
4130 If the target supports a BSS section, GCC by default puts variables that
4131 are initialized to zero into BSS@.  This can save space in the resulting
4132 code.
4133
4134 This option turns off this behavior because some programs explicitly
4135 rely on variables going to the data section.  E.g., so that the
4136 resulting executable can find the beginning of that section and/or make
4137 assumptions based on that.
4138
4139 The default is @option{-fzero-initialized-in-bss}.
4140
4141 @item -fbounds-check
4142 @opindex fbounds-check
4143 For front-ends that support it, generate additional code to check that
4144 indices used to access arrays are within the declared range.  This is
4145 currently only supported by the Java and Fortran front-ends, where
4146 this option defaults to true and false respectively.
4147
4148 @item -fmudflap -fmudflapth -fmudflapir
4149 @opindex fmudflap
4150 @opindex fmudflapth
4151 @opindex fmudflapir
4152 @cindex bounds checking
4153 @cindex mudflap
4154 For front-ends that support it (C and C++), instrument all risky
4155 pointer/array dereferencing operations, some standard library
4156 string/heap functions, and some other associated constructs with
4157 range/validity tests.  Modules so instrumented should be immune to
4158 buffer overflows, invalid heap use, and some other classes of C/C++
4159 programming errors.  The instrumentation relies on a separate runtime
4160 library (@file{libmudflap}), which will be linked into a program if
4161 @option{-fmudflap} is given at link time.  Run-time behavior of the
4162 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4163 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4164 for its options.
4165
4166 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4167 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4168 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4169 instrumentation should ignore pointer reads.  This produces less
4170 instrumentation (and therefore faster execution) and still provides
4171 some protection against outright memory corrupting writes, but allows
4172 erroneously read data to propagate within a program.
4173
4174 @item -fstrength-reduce
4175 @opindex fstrength-reduce
4176 Perform the optimizations of loop strength reduction and
4177 elimination of iteration variables.
4178
4179 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4180
4181 @item -fthread-jumps
4182 @opindex fthread-jumps
4183 Perform optimizations where we check to see if a jump branches to a
4184 location where another comparison subsumed by the first is found.  If
4185 so, the first branch is redirected to either the destination of the
4186 second branch or a point immediately following it, depending on whether
4187 the condition is known to be true or false.
4188
4189 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4190
4191 @item -fcse-follow-jumps
4192 @opindex fcse-follow-jumps
4193 In common subexpression elimination, scan through jump instructions
4194 when the target of the jump is not reached by any other path.  For
4195 example, when CSE encounters an @code{if} statement with an
4196 @code{else} clause, CSE will follow the jump when the condition
4197 tested is false.
4198
4199 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4200
4201 @item -fcse-skip-blocks
4202 @opindex fcse-skip-blocks
4203 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4204 follow jumps which conditionally skip over blocks.  When CSE
4205 encounters a simple @code{if} statement with no else clause,
4206 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4207 body of the @code{if}.
4208
4209 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4210
4211 @item -frerun-cse-after-loop
4212 @opindex frerun-cse-after-loop
4213 Re-run common subexpression elimination after loop optimizations has been
4214 performed.
4215
4216 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4217
4218 @item -frerun-loop-opt
4219 @opindex frerun-loop-opt
4220 Run the loop optimizer twice.
4221
4222 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4223
4224 @item -fgcse
4225 @opindex fgcse
4226 Perform a global common subexpression elimination pass.
4227 This pass also performs global constant and copy propagation.
4228
4229 @emph{Note:} When compiling a program using computed gotos, a GCC
4230 extension, you may get better runtime performance if you disable
4231 the global common subexpression elimination pass by adding
4232 @option{-fno-gcse} to the command line.
4233
4234 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4235
4236 @item -fgcse-lm
4237 @opindex fgcse-lm
4238 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4239 attempt to move loads which are only killed by stores into themselves.  This
4240 allows a loop containing a load/store sequence to be changed to a load outside
4241 the loop, and a copy/store within the loop.
4242
4243 Enabled by default when gcse is enabled.
4244
4245 @item -fgcse-sm
4246 @opindex fgcse-sm
4247 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4248 global common subexpression elimination.  This pass will attempt to move
4249 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4250 loops containing a load/store sequence can be changed to a load before
4251 the loop and a store after the loop.
4252
4253 Enabled by default when gcse is enabled.
4254
4255 @item -fgcse-las
4256 @opindex fgcse-las
4257 When @option{-fgcse-las} is enabled, the global common subexpression
4258 elimination pass eliminates redundant loads that come after stores to the
4259 same memory location (both partial and full redundancies).
4260
4261 Enabled by default when gcse is enabled.
4262
4263 @item -fgcse-after-reload
4264 @opindex fgcse-after-reload
4265 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4266 pass is performed after reload. The purpose of this pass is to cleanup
4267 redundant spilling.
4268
4269 @item -floop-optimize
4270 @opindex floop-optimize
4271 Perform loop optimizations: move constant expressions out of loops, simplify
4272 exit test conditions and optionally do strength-reduction and loop unrolling as
4273 well.
4274
4275 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4276
4277 @item -floop-optimize2
4278 @opindex floop-optimize2
4279 Perform loop optimizations using the new loop optimizer.  The optimizations
4280 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4281 by separate flags.
4282
4283 @item -fcrossjumping
4284 @opindex crossjumping
4285 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4286 resulting code may or may not perform better than without cross-jumping.
4287
4288 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4289
4290 @item -fif-conversion
4291 @opindex if-conversion
4292 Attempt to transform conditional jumps into branch-less equivalents.  This
4293 include use of conditional moves, min, max, set flags and abs instructions, and
4294 some tricks doable by standard arithmetics.  The use of conditional execution
4295 on chips where it is available is controlled by @code{if-conversion2}.
4296
4297 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4298
4299 @item -fif-conversion2
4300 @opindex if-conversion2
4301 Use conditional execution (where available) to transform conditional jumps into
4302 branch-less equivalents.
4303
4304 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4305
4306 @item -fdelete-null-pointer-checks
4307 @opindex fdelete-null-pointer-checks
4308 Use global dataflow analysis to identify and eliminate useless checks
4309 for null pointers.  The compiler assumes that dereferencing a null
4310 pointer would have halted the program.  If a pointer is checked after
4311 it has already been dereferenced, it cannot be null.
4312
4313 In some environments, this assumption is not true, and programs can
4314 safely dereference null pointers.  Use
4315 @option{-fno-delete-null-pointer-checks} to disable this optimization
4316 for programs which depend on that behavior.
4317
4318 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4319
4320 @item -fexpensive-optimizations
4321 @opindex fexpensive-optimizations
4322 Perform a number of minor optimizations that are relatively expensive.
4323
4324 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4325
4326 @item -foptimize-register-move
4327 @itemx -fregmove
4328 @opindex foptimize-register-move
4329 @opindex fregmove
4330 Attempt to reassign register numbers in move instructions and as
4331 operands of other simple instructions in order to maximize the amount of
4332 register tying.  This is especially helpful on machines with two-operand
4333 instructions.
4334
4335 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4336 optimization.
4337
4338 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4339
4340 @item -fdelayed-branch
4341 @opindex fdelayed-branch
4342 If supported for the target machine, attempt to reorder instructions
4343 to exploit instruction slots available after delayed branch
4344 instructions.
4345
4346 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4347
4348 @item -fschedule-insns
4349 @opindex fschedule-insns
4350 If supported for the target machine, attempt to reorder instructions to
4351 eliminate execution stalls due to required data being unavailable.  This
4352 helps machines that have slow floating point or memory load instructions
4353 by allowing other instructions to be issued until the result of the load
4354 or floating point instruction is required.
4355
4356 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4357
4358 @item -fschedule-insns2
4359 @opindex fschedule-insns2
4360 Similar to @option{-fschedule-insns}, but requests an additional pass of
4361 instruction scheduling after register allocation has been done.  This is
4362 especially useful on machines with a relatively small number of
4363 registers and where memory load instructions take more than one cycle.
4364
4365 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4366
4367 @item -fno-sched-interblock
4368 @opindex fno-sched-interblock
4369 Don't schedule instructions across basic blocks.  This is normally
4370 enabled by default when scheduling before register allocation, i.e.@:
4371 with @option{-fschedule-insns} or at @option{-O2} or higher.
4372
4373 @item -fno-sched-spec
4374 @opindex fno-sched-spec
4375 Don't allow speculative motion of non-load instructions.  This is normally
4376 enabled by default when scheduling before register allocation, i.e.@:
4377 with @option{-fschedule-insns} or at @option{-O2} or higher.
4378
4379 @item -fsched-spec-load
4380 @opindex fsched-spec-load
4381 Allow speculative motion of some load instructions.  This only makes
4382 sense when scheduling before register allocation, i.e.@: with
4383 @option{-fschedule-insns} or at @option{-O2} or higher.
4384
4385 @item -fsched-spec-load-dangerous
4386 @opindex fsched-spec-load-dangerous
4387 Allow speculative motion of more load instructions.  This only makes
4388 sense when scheduling before register allocation, i.e.@: with
4389 @option{-fschedule-insns} or at @option{-O2} or higher.
4390
4391 @item -fsched-stalled-insns=@var{n}
4392 @opindex fsched-stalled-insns
4393 Define how many insns (if any) can be moved prematurely from the queue
4394 of stalled insns into the ready list, during the second scheduling pass.
4395
4396 @item -fsched-stalled-insns-dep=@var{n}
4397 @opindex fsched-stalled-insns-dep
4398 Define how many insn groups (cycles) will be examined for a dependency
4399 on a stalled insn that is candidate for premature removal from the queue
4400 of stalled insns.  Has an effect only during the second scheduling pass,
4401 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4402
4403 @item -fsched2-use-superblocks
4404 @opindex fsched2-use-superblocks
4405 When scheduling after register allocation, do use superblock scheduling
4406 algorithm.  Superblock scheduling allows motion across basic block boundaries
4407 resulting on faster schedules.  This option is experimental, as not all machine
4408 descriptions used by GCC model the CPU closely enough to avoid unreliable
4409 results from the algorithm.
4410
4411 This only makes sense when scheduling after register allocation, i.e.@: with
4412 @option{-fschedule-insns2} or at @option{-O2} or higher.
4413
4414 @item -fsched2-use-traces
4415 @opindex fsched2-use-traces
4416 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4417 allocation and additionally perform code duplication in order to increase the
4418 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4419 trace formation.
4420
4421 This mode should produce faster but significantly longer programs.  Also
4422 without @code{-fbranch-probabilities} the traces constructed may not match the
4423 reality and hurt the performance.  This only makes
4424 sense when scheduling after register allocation, i.e.@: with
4425 @option{-fschedule-insns2} or at @option{-O2} or higher.
4426
4427 @item -freschedule-modulo-scheduled-loops
4428 @opindex fscheduling-in-modulo-scheduled-loops
4429 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4430 we may want to prevent the later scheduling passes from changing its schedule, we use this
4431 option to control that.
4432
4433 @item -fcaller-saves
4434 @opindex fcaller-saves
4435 Enable values to be allocated in registers that will be clobbered by
4436 function calls, by emitting extra instructions to save and restore the
4437 registers around such calls.  Such allocation is done only when it
4438 seems to result in better code than would otherwise be produced.
4439
4440 This option is always enabled by default on certain machines, usually
4441 those which have no call-preserved registers to use instead.
4442
4443 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4444
4445 @item -ftree-pre
4446 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4447 enabled by default at -O and higher.
4448
4449 @item -ftree-fre
4450 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4451 between FRE and PRE is that FRE only considers expressions
4452 that are computed on all paths leading to the redundant computation.
4453 This analysis faster than PRE, though it exposes fewer redundancies.
4454 This flag is enabled by default at -O and higher.
4455
4456 @item -ftree-ccp
4457 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4458 is enabled by default at -O and higher.
4459
4460 @item -ftree-dce
4461 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4462 default at -O and higher.
4463
4464 @item -ftree-dominator-opts
4465 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4466 default at -O and higher.
4467
4468 @item -ftree-ch
4469 Perform loop header copying on trees.  This is beneficial since it increases
4470 effectivity of code motion optimizations.  It also saves one jump.  This flag
4471 is enabled by default at -O and higher.  It is not enabled for -Os, since it
4472 usually increases code size.
4473
4474 @item -ftree-loop-optimize
4475 Perform loop optimizations on trees.  This flag is enabled by default at -O
4476 and higher.
4477
4478 @item -ftree-lim
4479 Perform loop invariant motion on trees.  This pass moves only invartiants that
4480 would be hard to handle on rtl level (function calls, operations that expand to
4481 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4482 operands of conditions that are invariant out of the loop, so that we can use
4483 just trivial invariantness analysis in loop unswitching.  The pass also includes
4484 store motion.
4485
4486 @item -fivcanon
4487 Create a canonical counter for number of iterations in the loop for that
4488 determining number of iterations requires complicated analysis.  Later
4489 optimizations then may determine the number easily.  Useful especially
4490 in connection with unrolling.
4491
4492 @item -ftree-sra
4493 Perform scalar replacement of aggregates.  This pass replaces structure
4494 references with scalars to prevent committing structures to memory too
4495 early.  This flag is enabled by default at -O and higher.
4496
4497 @item -ftree-copyrename
4498 Perform copy renaming on trees.  This pass attempts to rename compiler
4499 temporaries to other variables at copy locations, usually resulting in
4500 variable names which more closely resemble the original variables.  This flag
4501 is enabled by default at -O and higher.
4502
4503 @item -ftree-ter
4504 Perform temporary expression replacement during the SSA->normal phase.  Single
4505 use/single def temporaries are replaced at their use location with their
4506 defining expression.  This results in non-GIMPLE code, but gives the expanders
4507 much more complex trees to work on resulting in better RTL generation.  This is
4508 enabled by default at -O and higher.
4509
4510 @item -ftree-lrs
4511 Perform live range splitting during the SSA->normal phase.  Distinct live
4512 ranges of a variable are split into unique variables, allowing for better
4513 optimization later.  This is enabled by default at -O and higher.
4514
4515 @item -ftree-vectorize
4516 Perform loop vectorization on trees.
4517
4518 @item -ftracer
4519 @opindex ftracer
4520 Perform tail duplication to enlarge superblock size. This transformation
4521 simplifies the control flow of the function allowing other optimizations to do
4522 better job.
4523
4524 @item -funroll-loops
4525 @opindex funroll-loops
4526 Unroll loops whose number of iterations can be determined at compile
4527 time or upon entry to the loop.  @option{-funroll-loops} implies both
4528 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4529 option makes code larger, and may or may not make it run faster.
4530
4531 @item -funroll-all-loops
4532 @opindex funroll-all-loops
4533 Unroll all loops, even if their number of iterations is uncertain when
4534 the loop is entered.  This usually makes programs run more slowly.
4535 @option{-funroll-all-loops} implies the same options as
4536 @option{-funroll-loops},
4537
4538 @item -fprefetch-loop-arrays
4539 @opindex fprefetch-loop-arrays
4540 If supported by the target machine, generate instructions to prefetch
4541 memory to improve the performance of loops that access large arrays.
4542
4543 @item -fmove-all-movables
4544 @opindex fmove-all-movables
4545 Forces all invariant computations in loops to be moved
4546 outside the loop.
4547
4548 @item -freduce-all-givs
4549 @opindex freduce-all-givs
4550 Forces all general-induction variables in loops to be
4551 strength-reduced.
4552
4553 @emph{Note:} When compiling programs written in Fortran,
4554 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4555 by default when you use the optimizer.
4556
4557 These options may generate better or worse code; results are highly
4558 dependent on the structure of loops within the source code.
4559
4560 These two options are intended to be removed someday, once
4561 they have helped determine the efficacy of various
4562 approaches to improving loop optimizations.
4563
4564 Please contact @w{@email{gcc@@gcc.gnu.org}}, and describe how use of
4565 these options affects the performance of your production code.
4566 Examples of code that runs @emph{slower} when these options are
4567 @emph{enabled} are very valuable.
4568
4569 @item -fno-peephole
4570 @itemx -fno-peephole2
4571 @opindex fno-peephole
4572 @opindex fno-peephole2
4573 Disable any machine-specific peephole optimizations.  The difference
4574 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4575 are implemented in the compiler; some targets use one, some use the
4576 other, a few use both.
4577
4578 @option{-fpeephole} is enabled by default.
4579 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4580
4581 @item -fno-guess-branch-probability
4582 @opindex fno-guess-branch-probability
4583 Do not guess branch probabilities using a randomized model.
4584
4585 Sometimes GCC will opt to use a randomized model to guess branch
4586 probabilities, when none are available from either profiling feedback
4587 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4588 different runs of the compiler on the same program may produce different
4589 object code.
4590
4591 In a hard real-time system, people don't want different runs of the
4592 compiler to produce code that has different behavior; minimizing
4593 non-determinism is of paramount import.  This switch allows users to
4594 reduce non-determinism, possibly at the expense of inferior
4595 optimization.
4596
4597 The default is @option{-fguess-branch-probability} at levels
4598 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4599
4600 @item -freorder-blocks
4601 @opindex freorder-blocks
4602 Reorder basic blocks in the compiled function in order to reduce number of
4603 taken branches and improve code locality.
4604
4605 Enabled at levels @option{-O2}, @option{-O3}.
4606
4607 @item -freorder-blocks-and-partition
4608 @opindex freorder-blocks-and-partition
4609 In addition to reordering basic blocks in the compiled function, in order
4610 to reduce number of taken branches, partitions hot and cold basic blocks
4611 into separate sections of the assembly and .o files, to improve
4612 paging and cache locality performance.
4613
4614 @item -freorder-functions
4615 @opindex freorder-functions
4616 Reorder basic blocks in the compiled function in order to reduce number of
4617 taken branches and improve code locality. This is implemented by using special
4618 subsections @code{.text.hot} for most frequently executed functions and
4619 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4620 the linker so object file format must support named sections and linker must
4621 place them in a reasonable way.
4622
4623 Also profile feedback must be available in to make this option effective.  See
4624 @option{-fprofile-arcs} for details.
4625
4626 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4627
4628 @item -fstrict-aliasing
4629 @opindex fstrict-aliasing
4630 Allows the compiler to assume the strictest aliasing rules applicable to
4631 the language being compiled.  For C (and C++), this activates
4632 optimizations based on the type of expressions.  In particular, an
4633 object of one type is assumed never to reside at the same address as an
4634 object of a different type, unless the types are almost the same.  For
4635 example, an @code{unsigned int} can alias an @code{int}, but not a
4636 @code{void*} or a @code{double}.  A character type may alias any other
4637 type.
4638
4639 Pay special attention to code like this:
4640 @smallexample
4641 union a_union @{
4642   int i;
4643   double d;
4644 @};
4645
4646 int f() @{
4647   a_union t;
4648   t.d = 3.0;
4649   return t.i;
4650 @}
4651 @end smallexample
4652 The practice of reading from a different union member than the one most
4653 recently written to (called ``type-punning'') is common.  Even with
4654 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4655 is accessed through the union type.  So, the code above will work as
4656 expected.  However, this code might not:
4657 @smallexample
4658 int f() @{
4659   a_union t;
4660   int* ip;
4661   t.d = 3.0;
4662   ip = &t.i;
4663   return *ip;
4664 @}
4665 @end smallexample
4666
4667 Every language that wishes to perform language-specific alias analysis
4668 should define a function that computes, given an @code{tree}
4669 node, an alias set for the node.  Nodes in different alias sets are not
4670 allowed to alias.  For an example, see the C front-end function
4671 @code{c_get_alias_set}.
4672
4673 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4674
4675 @item -falign-functions
4676 @itemx -falign-functions=@var{n}
4677 @opindex falign-functions
4678 Align the start of functions to the next power-of-two greater than
4679 @var{n}, skipping up to @var{n} bytes.  For instance,
4680 @option{-falign-functions=32} aligns functions to the next 32-byte
4681 boundary, but @option{-falign-functions=24} would align to the next
4682 32-byte boundary only if this can be done by skipping 23 bytes or less.
4683
4684 @option{-fno-align-functions} and @option{-falign-functions=1} are
4685 equivalent and mean that functions will not be aligned.
4686
4687 Some assemblers only support this flag when @var{n} is a power of two;
4688 in that case, it is rounded up.
4689
4690 If @var{n} is not specified or is zero, use a machine-dependent default.
4691
4692 Enabled at levels @option{-O2}, @option{-O3}.
4693
4694 @item -falign-labels
4695 @itemx -falign-labels=@var{n}
4696 @opindex falign-labels
4697 Align all branch targets to a power-of-two boundary, skipping up to
4698 @var{n} bytes like @option{-falign-functions}.  This option can easily
4699 make code slower, because it must insert dummy operations for when the
4700 branch target is reached in the usual flow of the code.
4701
4702 @option{-fno-align-labels} and @option{-falign-labels=1} are
4703 equivalent and mean that labels will not be aligned.
4704
4705 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4706 are greater than this value, then their values are used instead.
4707
4708 If @var{n} is not specified or is zero, use a machine-dependent default
4709 which is very likely to be @samp{1}, meaning no alignment.
4710
4711 Enabled at levels @option{-O2}, @option{-O3}.
4712
4713 @item -falign-loops
4714 @itemx -falign-loops=@var{n}
4715 @opindex falign-loops
4716 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4717 like @option{-falign-functions}.  The hope is that the loop will be
4718 executed many times, which will make up for any execution of the dummy
4719 operations.
4720
4721 @option{-fno-align-loops} and @option{-falign-loops=1} are
4722 equivalent and mean that loops will not be aligned.
4723
4724 If @var{n} is not specified or is zero, use a machine-dependent default.
4725
4726 Enabled at levels @option{-O2}, @option{-O3}.
4727
4728 @item -falign-jumps
4729 @itemx -falign-jumps=@var{n}
4730 @opindex falign-jumps
4731 Align branch targets to a power-of-two boundary, for branch targets
4732 where the targets can only be reached by jumping, skipping up to @var{n}
4733 bytes like @option{-falign-functions}.  In this case, no dummy operations
4734 need be executed.
4735
4736 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4737 equivalent and mean that loops will not be aligned.
4738
4739 If @var{n} is not specified or is zero, use a machine-dependent default.
4740
4741 Enabled at levels @option{-O2}, @option{-O3}.
4742
4743 @item -funit-at-a-time
4744 @opindex funit-at-a-time
4745 Parse the whole compilation unit before starting to produce code.
4746 This allows some extra optimizations to take place but consumes
4747 more memory (in general).  There are some compatibility issues
4748 with @emph{unit-at-at-time} mode:
4749 @itemize @bullet
4750 @item
4751 enabling @emph{unit-at-a-time} mode may change the order
4752 in which functions, variables, and top-level @code{asm} statements
4753 are emitted, and will likely break code relying on some particular
4754 ordering.  The majority of such top-level @code{asm} statements,
4755 though, can be replaced by @code{section} attributes.
4756
4757 @item
4758 @emph{unit-at-a-time} mode removes unreferenced static variables
4759 and functions are removed.  This may result in undefined references
4760 when an @code{asm} statement refers directly to variables or functions
4761 that are otherwise unused.  In that case either the variable/function
4762 shall be listed as an operand of the @code{asm} statement operand or,
4763 in the case of top-level @code{asm} statements the attribute @code{used}
4764 shall be used on the declaration.
4765
4766 @item
4767 Static functions now can use non-standard passing conventions that
4768 may break @code{asm} statements calling functions directly. Again,
4769 attribute @code{used} will prevent this behavior.
4770 @end itemize
4771
4772 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4773 but this scheme may not be supported by future releases of GCC.
4774
4775 Enabled at levels @option{-O2}, @option{-O3}.
4776
4777 @item -fweb
4778 @opindex fweb
4779 Constructs webs as commonly used for register allocation purposes and assign
4780 each web individual pseudo register.  This allows the register allocation pass
4781 to operate on pseudos directly, but also strengthens several other optimization
4782 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4783 however, make debugging impossible, since variables will no longer stay in a
4784 ``home register''.
4785
4786 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4787 on targets where the default format for debugging information supports
4788 variable tracking.
4789
4790 @item -fno-cprop-registers
4791 @opindex fno-cprop-registers
4792 After register allocation and post-register allocation instruction splitting,
4793 we perform a copy-propagation pass to try to reduce scheduling dependencies
4794 and occasionally eliminate the copy.
4795
4796 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4797
4798 @item -fprofile-generate
4799 @opindex fprofile-generate
4800
4801 Enable options usually used for instrumenting application to produce
4802 profile useful for later recompilation with profile feedback based
4803 optimization.  You must use @code{-fprofile-generate} both when
4804 compiling and when linking your program.
4805
4806 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4807
4808 @item -fprofile-use
4809 @opindex fprofile-use
4810 Enable profile feedback directed optimizations, and optimizations
4811 generally profitable only with profile feedback available.
4812
4813 The following options are enabled: @code{-fbranch-probabilities},
4814 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4815
4816 @end table
4817
4818 The following options control compiler behavior regarding floating
4819 point arithmetic.  These options trade off between speed and
4820 correctness.  All must be specifically enabled.
4821
4822 @table @gcctabopt
4823 @item -ffloat-store
4824 @opindex ffloat-store
4825 Do not store floating point variables in registers, and inhibit other
4826 options that might change whether a floating point value is taken from a
4827 register or memory.
4828
4829 @cindex floating point precision
4830 This option prevents undesirable excess precision on machines such as
4831 the 68000 where the floating registers (of the 68881) keep more
4832 precision than a @code{double} is supposed to have.  Similarly for the
4833 x86 architecture.  For most programs, the excess precision does only
4834 good, but a few programs rely on the precise definition of IEEE floating
4835 point.  Use @option{-ffloat-store} for such programs, after modifying
4836 them to store all pertinent intermediate computations into variables.
4837
4838 @item -ffast-math
4839 @opindex ffast-math
4840 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4841 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4842 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4843
4844 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4845
4846 This option should never be turned on by any @option{-O} option since
4847 it can result in incorrect output for programs which depend on
4848 an exact implementation of IEEE or ISO rules/specifications for
4849 math functions.
4850
4851 @item -fno-math-errno
4852 @opindex fno-math-errno
4853 Do not set ERRNO after calling math functions that are executed
4854 with a single instruction, e.g., sqrt.  A program that relies on
4855 IEEE exceptions for math error handling may want to use this flag
4856 for speed while maintaining IEEE arithmetic compatibility.
4857
4858 This option should never be turned on by any @option{-O} option since
4859 it can result in incorrect output for programs which depend on
4860 an exact implementation of IEEE or ISO rules/specifications for
4861 math functions.
4862
4863 The default is @option{-fmath-errno}.
4864
4865 @item -funsafe-math-optimizations
4866 @opindex funsafe-math-optimizations
4867 Allow optimizations for floating-point arithmetic that (a) assume
4868 that arguments and results are valid and (b) may violate IEEE or
4869 ANSI standards.  When used at link-time, it may include libraries
4870 or startup files that change the default FPU control word or other
4871 similar optimizations.
4872
4873 This option should never be turned on by any @option{-O} option since
4874 it can result in incorrect output for programs which depend on
4875 an exact implementation of IEEE or ISO rules/specifications for
4876 math functions.
4877
4878 The default is @option{-fno-unsafe-math-optimizations}.
4879
4880 @item -ffinite-math-only
4881 @opindex ffinite-math-only
4882 Allow optimizations for floating-point arithmetic that assume
4883 that arguments and results are not NaNs or +-Infs.
4884
4885 This option should never be turned on by any @option{-O} option since
4886 it can result in incorrect output for programs which depend on
4887 an exact implementation of IEEE or ISO rules/specifications.
4888
4889 The default is @option{-fno-finite-math-only}.
4890
4891 @item -fno-trapping-math
4892 @opindex fno-trapping-math
4893 Compile code assuming that floating-point operations cannot generate
4894 user-visible traps.  These traps include division by zero, overflow,
4895 underflow, inexact result and invalid operation.  This option implies
4896 @option{-fno-signaling-nans}.  Setting this option may allow faster
4897 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4898
4899 This option should never be turned on by any @option{-O} option since
4900 it can result in incorrect output for programs which depend on
4901 an exact implementation of IEEE or ISO rules/specifications for
4902 math functions.
4903
4904 The default is @option{-ftrapping-math}.
4905
4906 @item -frounding-math
4907 @opindex frounding-math
4908 Disable transformations and optimizations that assume default floating
4909 point rounding behavior.  This is round-to-zero for all floating point
4910 to integer conversions, and round-to-nearest for all other arithmetic
4911 truncations.  This option should be specified for programs that change
4912 the FP rounding mode dynamically, or that may be executed with a
4913 non-default rounding mode.  This option disables constant folding of
4914 floating point expressions at compile-time (which may be affected by
4915 rounding mode) and arithmetic transformations that are unsafe in the
4916 presence of sign-dependent rounding modes.
4917
4918 The default is @option{-fno-rounding-math}.
4919
4920 This option is experimental and does not currently guarantee to
4921 disable all GCC optimizations that are affected by rounding mode.
4922 Future versions of GCC may provide finer control of this setting
4923 using C99's @code{FENV_ACCESS} pragma.  This command line option
4924 will be used to specify the default state for @code{FENV_ACCESS}.
4925
4926 @item -fsignaling-nans
4927 @opindex fsignaling-nans
4928 Compile code assuming that IEEE signaling NaNs may generate user-visible
4929 traps during floating-point operations.  Setting this option disables
4930 optimizations that may change the number of exceptions visible with
4931 signaling NaNs.  This option implies @option{-ftrapping-math}.
4932
4933 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4934 be defined.
4935
4936 The default is @option{-fno-signaling-nans}.
4937
4938 This option is experimental and does not currently guarantee to
4939 disable all GCC optimizations that affect signaling NaN behavior.
4940
4941 @item -fsingle-precision-constant
4942 @opindex fsingle-precision-constant
4943 Treat floating point constant as single precision constant instead of
4944 implicitly converting it to double precision constant.
4945
4946
4947 @end table
4948
4949 The following options control optimizations that may improve
4950 performance, but are not enabled by any @option{-O} options.  This
4951 section includes experimental options that may produce broken code.
4952
4953 @table @gcctabopt
4954 @item -fbranch-probabilities
4955 @opindex fbranch-probabilities
4956 After running a program compiled with @option{-fprofile-arcs}
4957 (@pxref{Debugging Options,, Options for Debugging Your Program or
4958 @command{gcc}}), you can compile it a second time using
4959 @option{-fbranch-probabilities}, to improve optimizations based on
4960 the number of times each branch was taken.  When the program
4961 compiled with @option{-fprofile-arcs} exits it saves arc execution
4962 counts to a file called @file{@var{sourcename}.gcda} for each source
4963 file  The information in this data file is very dependent on the
4964 structure of the generated code, so you must use the same source code
4965 and the same optimization options for both compilations.
4966
4967 With @option{-fbranch-probabilities}, GCC puts a
4968 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4969 These can be used to improve optimization.  Currently, they are only
4970 used in one place: in @file{reorg.c}, instead of guessing which path a
4971 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4972 exactly determine which path is taken more often.
4973
4974 @item -fprofile-values
4975 @opindex fprofile-values
4976 If combined with @option{-fprofile-arcs}, it adds code so that some
4977 data about values of expressions in the program is gathered.
4978
4979 With @option{-fbranch-probabilities}, it reads back the data gathered
4980 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4981 notes to instructions for their later usage in optimizations.
4982
4983 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
4984
4985 @item -fvpt
4986 @opindex fvpt
4987 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4988 a code to gather information about values of expressions.
4989
4990 With @option{-fbranch-probabilities}, it reads back the data gathered
4991 and actually performs the optimizations based on them.
4992 Currently the optimizations include specialization of division operation
4993 using the knowledge about the value of the denominator.
4994
4995 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
4996
4997 @item -frename-registers
4998 @opindex frename-registers
4999 Attempt to avoid false dependencies in scheduled code by making use
5000 of registers left over after register allocation.  This optimization
5001 will most benefit processors with lots of registers.  Depending on the
5002 debug information format adopted by the target, however, it can
5003 make debugging impossible, since variables will no longer stay in
5004 a ``home register''.
5005
5006 Not enabled by default at any level because it has known bugs.
5007
5008 @item -fnew-ra
5009 @opindex fnew-ra
5010 Use a graph coloring register allocator.  Currently this option is meant
5011 for testing, so we are interested to hear about miscompilations with
5012 @option{-fnew-ra}.
5013
5014 @item -ftracer
5015 @opindex ftracer
5016 Perform tail duplication to enlarge superblock size. This transformation
5017 simplifies the control flow of the function allowing other optimizations to do
5018 better job.
5019
5020 Enabled with @option{-fprofile-use}.
5021
5022 @item -funroll-loops
5023 @opindex funroll-loops
5024 Unroll loops whose number of iterations can be determined at compile time or
5025 upon entry to the loop.  @option{-funroll-loops} implies
5026 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5027 (i.e. complete removal of loops with small constant number of iterations).
5028 This option makes code larger, and may or may not make it run faster.
5029
5030 Enabled with @option{-fprofile-use}.
5031
5032 @item -funroll-all-loops
5033 @opindex funroll-all-loops
5034 Unroll all loops, even if their number of iterations is uncertain when
5035 the loop is entered.  This usually makes programs run more slowly.
5036 @option{-funroll-all-loops} implies the same options as
5037 @option{-funroll-loops}.
5038
5039 @item -fpeel-loops
5040 @opindex fpeel-loops
5041 Peels the loops for that there is enough information that they do not
5042 roll much (from profile feedback).  It also turns on complete loop peeling
5043 (i.e. complete removal of loops with small constant number of iterations).
5044
5045 Enabled with @option{-fprofile-use}.
5046
5047 @item -fmove-loop-invariants
5048 @opindex fmove-loop-invariants
5049 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5050 at level @option{-O1}
5051
5052 @item -funswitch-loops
5053 @opindex funswitch-loops
5054 Move branches with loop invariant conditions out of the loop, with duplicates
5055 of the loop on both branches (modified according to result of the condition).
5056
5057 @item -fold-unroll-loops
5058 @opindex fold-unroll-loops
5059 Unroll loops whose number of iterations can be determined at compile
5060 time or upon entry to the loop, using the old loop unroller whose loop
5061 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
5062 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5063 option makes code larger, and may or may not make it run faster.
5064
5065 @item -fold-unroll-all-loops
5066 @opindex fold-unroll-all-loops
5067 Unroll all loops, even if their number of iterations is uncertain when
5068 the loop is entered. This is done using the old loop unroller whose loop
5069 recognition is based on notes from frontend.  This usually makes programs run more slowly.
5070 @option{-fold-unroll-all-loops} implies the same options as
5071 @option{-fold-unroll-loops}.
5072
5073 @item -fprefetch-loop-arrays
5074 @opindex fprefetch-loop-arrays
5075 If supported by the target machine, generate instructions to prefetch
5076 memory to improve the performance of loops that access large arrays.
5077
5078 Disabled at level @option{-Os}.
5079
5080 @item -ffunction-sections
5081 @itemx -fdata-sections
5082 @opindex ffunction-sections
5083 @opindex fdata-sections
5084 Place each function or data item into its own section in the output
5085 file if the target supports arbitrary sections.  The name of the
5086 function or the name of the data item determines the section's name
5087 in the output file.
5088
5089 Use these options on systems where the linker can perform optimizations
5090 to improve locality of reference in the instruction space.  Most systems
5091 using the ELF object format and SPARC processors running Solaris 2 have
5092 linkers with such optimizations.  AIX may have these optimizations in
5093 the future.
5094
5095 Only use these options when there are significant benefits from doing
5096 so.  When you specify these options, the assembler and linker will
5097 create larger object and executable files and will also be slower.
5098 You will not be able to use @code{gprof} on all systems if you
5099 specify this option and you may have problems with debugging if
5100 you specify both this option and @option{-g}.
5101
5102 @item -fbranch-target-load-optimize
5103 @opindex fbranch-target-load-optimize
5104 Perform branch target register load optimization before prologue / epilogue
5105 threading.
5106 The use of target registers can typically be exposed only during reload,
5107 thus hoisting loads out of loops and doing inter-block scheduling needs
5108 a separate optimization pass.
5109
5110 @item -fbranch-target-load-optimize2
5111 @opindex fbranch-target-load-optimize2
5112 Perform branch target register load optimization after prologue / epilogue
5113 threading.
5114
5115 @item -fbtr-bb-exclusive
5116 @opindex fbtr-bb-exclusive
5117 When performing branch target register load optimization, don't reuse
5118 branch target registers in within any basic block.
5119
5120 @item --param @var{name}=@var{value}
5121 @opindex param
5122 In some places, GCC uses various constants to control the amount of
5123 optimization that is done.  For example, GCC will not inline functions
5124 that contain more that a certain number of instructions.  You can
5125 control some of these constants on the command-line using the
5126 @option{--param} option.
5127
5128 The names of specific parameters, and the meaning of the values, are
5129 tied to the internals of the compiler, and are subject to change
5130 without notice in future releases.
5131
5132 In each case, the @var{value} is an integer.  The allowable choices for
5133 @var{name} are given in the following table:
5134
5135 @table @gcctabopt
5136 @item max-crossjump-edges
5137 The maximum number of incoming edges to consider for crossjumping.
5138 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5139 the number of edges incoming to each block.  Increasing values mean
5140 more aggressive optimization, making the compile time increase with
5141 probably small improvement in executable size.
5142
5143 @item min-crossjump-insns
5144 The minimum number of instructions which must be matched at the end
5145 of two blocks before crossjumping will be performed on them.  This
5146 value is ignored in the case where all instructions in the block being
5147 crossjumped from are matched.  The default value is 5.
5148
5149 @item max-delay-slot-insn-search
5150 The maximum number of instructions to consider when looking for an
5151 instruction to fill a delay slot.  If more than this arbitrary number of
5152 instructions is searched, the time savings from filling the delay slot
5153 will be minimal so stop searching.  Increasing values mean more
5154 aggressive optimization, making the compile time increase with probably
5155 small improvement in executable run time.
5156
5157 @item max-delay-slot-live-search
5158 When trying to fill delay slots, the maximum number of instructions to
5159 consider when searching for a block with valid live register
5160 information.  Increasing this arbitrarily chosen value means more
5161 aggressive optimization, increasing the compile time.  This parameter
5162 should be removed when the delay slot code is rewritten to maintain the
5163 control-flow graph.
5164
5165 @item max-gcse-memory
5166 The approximate maximum amount of memory that will be allocated in
5167 order to perform the global common subexpression elimination
5168 optimization.  If more memory than specified is required, the
5169 optimization will not be done.
5170
5171 @item max-gcse-passes
5172 The maximum number of passes of GCSE to run.  The default is 1.
5173
5174 @item max-pending-list-length
5175 The maximum number of pending dependencies scheduling will allow
5176 before flushing the current state and starting over.  Large functions
5177 with few branches or calls can create excessively large lists which
5178 needlessly consume memory and resources.
5179
5180 @item max-inline-insns-single
5181 Several parameters control the tree inliner used in gcc.
5182 This number sets the maximum number of instructions (counted in GCC's
5183 internal representation) in a single function that the tree inliner
5184 will consider for inlining.  This only affects functions declared
5185 inline and methods implemented in a class declaration (C++).
5186 The default value is 500.
5187
5188 @item max-inline-insns-auto
5189 When you use @option{-finline-functions} (included in @option{-O3}),
5190 a lot of functions that would otherwise not be considered for inlining
5191 by the compiler will be investigated.  To those functions, a different
5192 (more restrictive) limit compared to functions declared inline can
5193 be applied.
5194 The default value is 120.
5195
5196 @item large-function-insns
5197 The limit specifying really large functions.  For functions greater than this
5198 limit inlining is constrained by @option{--param large-function-growth}.
5199 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5200 algorithms used by the backend.
5201 This parameter is ignored when @option{-funit-at-a-time} is not used.
5202 The default value is 3000.
5203
5204 @item large-function-growth
5205 Specifies maximal growth of large function caused by inlining in percents.
5206 This parameter is ignored when @option{-funit-at-a-time} is not used.
5207 The default value is 200.
5208
5209 @item inline-unit-growth
5210 Specifies maximal overall growth of the compilation unit caused by inlining.
5211 This parameter is ignored when @option{-funit-at-a-time} is not used.
5212 The default value is 150.
5213
5214 @item max-inline-insns-recursive
5215 @itemx max-inline-insns-recursive-auto
5216 Specifies maximum number of instructions out-of-line copy of self recursive inline
5217 function can grow into by performing recursive inlining.
5218
5219 For functions declared inline @option{--param max-inline-insns-recursive} is
5220 taken into acount.  For function not declared inline, recursive inlining
5221 happens only when @option{-finline-functions} (included in @option{-O3}) is
5222 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5223 default value is 500.
5224
5225 @item max-inline-recursive-depth
5226 @itemx max-inline-recursive-depth-auto
5227 Specifies maximum recursion depth used by the recursive inlining.
5228
5229 For functions declared inline @option{--param max-inline-recursive-depth} is
5230 taken into acount.  For function not declared inline, recursive inlining
5231 happens only when @option{-finline-functions} (included in @option{-O3}) is
5232 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5233 default value is 500.
5234
5235 @item max-inline-insns-rtl
5236 For languages that use the RTL inliner (this happens at a later stage
5237 than tree inlining), you can set the maximum allowable size (counted
5238 in RTL instructions) for the RTL inliner with this parameter.
5239 The default value is 600.
5240
5241 @item max-unrolled-insns
5242 The maximum number of instructions that a loop should have if that loop
5243 is unrolled, and if the loop is unrolled, it determines how many times
5244 the loop code is unrolled.
5245
5246 @item max-average-unrolled-insns
5247 The maximum number of instructions biased by probabilities of their execution
5248 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5249 it determines how many times the loop code is unrolled.
5250
5251 @item max-unroll-times
5252 The maximum number of unrollings of a single loop.
5253
5254 @item max-peeled-insns
5255 The maximum number of instructions that a loop should have if that loop
5256 is peeled, and if the loop is peeled, it determines how many times
5257 the loop code is peeled.
5258
5259 @item max-peel-times
5260 The maximum number of peelings of a single loop.
5261
5262 @item max-completely-peeled-insns
5263 The maximum number of insns of a completely peeled loop.
5264
5265 @item max-completely-peel-times
5266 The maximum number of iterations of a loop to be suitable for complete peeling.
5267
5268 @item max-unswitch-insns
5269 The maximum number of insns of an unswitched loop.
5270
5271 @item max-unswitch-level
5272 The maximum number of branches unswitched in a single loop.
5273
5274 @item lim-expensive
5275 The minimum cost of an expensive expression in the loop invariant motion.
5276
5277 @item max-iterations-to-track
5278
5279 The maximum number of iterations of a loop the brute force algorithm
5280 for analysis of # of iterations of the loop tries to evaluate.
5281
5282 @item hot-bb-count-fraction
5283 Select fraction of the maximal count of repetitions of basic block in program
5284 given basic block needs to have to be considered hot.
5285
5286 @item hot-bb-frequency-fraction
5287 Select fraction of the maximal frequency of executions of basic block in
5288 function given basic block needs to have to be considered hot
5289
5290 @item tracer-dynamic-coverage
5291 @itemx tracer-dynamic-coverage-feedback
5292
5293 This value is used to limit superblock formation once the given percentage of
5294 executed instructions is covered.  This limits unnecessary code size
5295 expansion.
5296
5297 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5298 feedback is available.  The real profiles (as opposed to statically estimated
5299 ones) are much less balanced allowing the threshold to be larger value.
5300
5301 @item tracer-max-code-growth
5302 Stop tail duplication once code growth has reached given percentage.  This is
5303 rather hokey argument, as most of the duplicates will be eliminated later in
5304 cross jumping, so it may be set to much higher values than is the desired code
5305 growth.
5306
5307 @item tracer-min-branch-ratio
5308
5309 Stop reverse growth when the reverse probability of best edge is less than this
5310 threshold (in percent).
5311
5312 @item tracer-min-branch-ratio
5313 @itemx tracer-min-branch-ratio-feedback
5314
5315 Stop forward growth if the best edge do have probability lower than this
5316 threshold.
5317
5318 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5319 compilation for profile feedback and one for compilation without.  The value
5320 for compilation with profile feedback needs to be more conservative (higher) in
5321 order to make tracer effective.
5322
5323 @item max-cse-path-length
5324
5325 Maximum number of basic blocks on path that cse considers.  The default is 10.
5326
5327 @item global-var-threshold
5328
5329 Counts the number of function calls (N) and the number of
5330 call-clobbered variables (V).  If NxV is larger than this limit, a
5331 single artificial variable will be created to represent all the
5332 call-clobbered variables at function call sites.  This artificial
5333 variable will then be made to alias every call-clobbered variable.
5334 (done as int * size_t on the host machine; beware overflow).
5335
5336 @item max-aliased-vops
5337
5338 Maxiumum number of virtual operands allowed to represent aliases
5339 before triggering the alias grouping heuristic.  Alias grouping
5340 reduces compile times and memory consumption needed for aliasing at
5341 the expense of precision loss in alias information.
5342
5343 @item ggc-min-expand
5344
5345 GCC uses a garbage collector to manage its own memory allocation.  This
5346 parameter specifies the minimum percentage by which the garbage
5347 collector's heap should be allowed to expand between collections.
5348 Tuning this may improve compilation speed; it has no effect on code
5349 generation.
5350
5351 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5352 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5353 the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS.  If
5354 GCC is not able to calculate RAM on a particular platform, the lower
5355 bound of 30% is used.  Setting this parameter and
5356 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5357 every opportunity.  This is extremely slow, but can be useful for
5358 debugging.
5359
5360 @item ggc-min-heapsize
5361
5362 Minimum size of the garbage collector's heap before it begins bothering
5363 to collect garbage.  The first collection occurs after the heap expands
5364 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5365 tuning this may improve compilation speed, and has no effect on code
5366 generation.
5367
5368 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5369 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5370 with a lower bound of 4096 (four megabytes) and an upper bound of
5371 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5372 particular platform, the lower bound is used.  Setting this parameter
5373 very large effectively disables garbage collection.  Setting this
5374 parameter and @option{ggc-min-expand} to zero causes a full collection
5375 to occur at every opportunity.
5376
5377 @item max-reload-search-insns
5378 The maximum number of instruction reload should look backward for equivalent
5379 register.  Increasing values mean more aggressive optimization, making the
5380 compile time increase with probably slightly better performance.  The default
5381 value is 100.
5382
5383 @item max-cselib-memory-location
5384 The maximum number of memory locations cselib should take into acount.
5385 Increasing values mean more aggressive optimization, making the compile time
5386 increase with probably slightly better performance.  The default value is 500.
5387
5388 @item reorder-blocks-duplicate
5389 @itemx reorder-blocks-duplicate-feedback
5390
5391 Used by basic block reordering pass to decide whether to use unconditional
5392 branch or duplicate the code on its destination.  Code is duplicated when its
5393 estimated size is smaller than this value multiplied by the estimated size of
5394 unconditional jump in the hot spots of the program.
5395
5396 The @option{reorder-block-duplicate-feedback} is used only when profile
5397 feedback is available and may be set to higher values than
5398 @option{reorder-block-duplicate} since information about the hot spots is more
5399 accurate.
5400
5401 @item max-sched-region-blocks
5402 The maximum number of blocks in a region to be considered for
5403 interblock scheduling.  The default value is 10.
5404
5405 @item max-sched-region-insns
5406 The maximum number of insns in a region to be considered for
5407 interblock scheduling.  The default value is 100.
5408
5409 @item integer-share-limit
5410 Small integer constants can use a shared data structure, reducing the
5411 compiler's memory usage and increasing its speed.  This sets the maximum
5412 value of a shared integer constant's.  The default value is 256.
5413
5414 @end table
5415 @end table
5416
5417 @node Preprocessor Options
5418 @section Options Controlling the Preprocessor
5419 @cindex preprocessor options
5420 @cindex options, preprocessor
5421
5422 These options control the C preprocessor, which is run on each C source
5423 file before actual compilation.
5424
5425 If you use the @option{-E} option, nothing is done except preprocessing.
5426 Some of these options make sense only together with @option{-E} because
5427 they cause the preprocessor output to be unsuitable for actual
5428 compilation.
5429
5430 @table @gcctabopt
5431 @opindex Wp
5432 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5433 and pass @var{option} directly through to the preprocessor.  If
5434 @var{option} contains commas, it is split into multiple options at the
5435 commas.  However, many options are modified, translated or interpreted
5436 by the compiler driver before being passed to the preprocessor, and
5437 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5438 interface is undocumented and subject to change, so whenever possible
5439 you should avoid using @option{-Wp} and let the driver handle the
5440 options instead.
5441
5442 @item -Xpreprocessor @var{option}
5443 @opindex preprocessor
5444 Pass @var{option} as an option to the preprocessor.  You can use this to
5445 supply system-specific preprocessor options which GCC does not know how to
5446 recognize.
5447
5448 If you want to pass an option that takes an argument, you must use
5449 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5450 @end table
5451
5452 @include cppopts.texi
5453
5454 @node Assembler Options
5455 @section Passing Options to the Assembler
5456
5457 @c prevent bad page break with this line
5458 You can pass options to the assembler.
5459
5460 @table @gcctabopt
5461 @item -Wa,@var{option}
5462 @opindex Wa
5463 Pass @var{option} as an option to the assembler.  If @var{option}
5464 contains commas, it is split into multiple options at the commas.
5465
5466 @item -Xassembler @var{option}
5467 @opindex Xassembler
5468 Pass @var{option} as an option to the assembler.  You can use this to
5469 supply system-specific assembler options which GCC does not know how to
5470 recognize.
5471
5472 If you want to pass an option that takes an argument, you must use
5473 @option{-Xassembler} twice, once for the option and once for the argument.
5474
5475 @end table
5476
5477 @node Link Options
5478 @section Options for Linking
5479 @cindex link options
5480 @cindex options, linking
5481
5482 These options come into play when the compiler links object files into
5483 an executable output file.  They are meaningless if the compiler is
5484 not doing a link step.
5485
5486 @table @gcctabopt
5487 @cindex file names
5488 @item @var{object-file-name}
5489 A file name that does not end in a special recognized suffix is
5490 considered to name an object file or library.  (Object files are
5491 distinguished from libraries by the linker according to the file
5492 contents.)  If linking is done, these object files are used as input
5493 to the linker.
5494
5495 @item -c
5496 @itemx -S
5497 @itemx -E
5498 @opindex c
5499 @opindex S
5500 @opindex E
5501 If any of these options is used, then the linker is not run, and
5502 object file names should not be used as arguments.  @xref{Overall
5503 Options}.
5504
5505 @cindex Libraries
5506 @item -l@var{library}
5507 @itemx -l @var{library}
5508 @opindex l
5509 Search the library named @var{library} when linking.  (The second
5510 alternative with the library as a separate argument is only for
5511 POSIX compliance and is not recommended.)
5512
5513 It makes a difference where in the command you write this option; the
5514 linker searches and processes libraries and object files in the order they
5515 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5516 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5517 to functions in @samp{z}, those functions may not be loaded.
5518
5519 The linker searches a standard list of directories for the library,
5520 which is actually a file named @file{lib@var{library}.a}.  The linker
5521 then uses this file as if it had been specified precisely by name.
5522
5523 The directories searched include several standard system directories
5524 plus any that you specify with @option{-L}.
5525
5526 Normally the files found this way are library files---archive files
5527 whose members are object files.  The linker handles an archive file by
5528 scanning through it for members which define symbols that have so far
5529 been referenced but not defined.  But if the file that is found is an
5530 ordinary object file, it is linked in the usual fashion.  The only
5531 difference between using an @option{-l} option and specifying a file name
5532 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5533 and searches several directories.
5534
5535 @item -lobjc
5536 @opindex lobjc
5537 You need this special case of the @option{-l} option in order to
5538 link an Objective-C or Objective-C++ program.
5539
5540 @item -nostartfiles
5541 @opindex nostartfiles
5542 Do not use the standard system startup files when linking.
5543 The standard system libraries are used normally, unless @option{-nostdlib}
5544 or @option{-nodefaultlibs} is used.
5545
5546 @item -nodefaultlibs
5547 @opindex nodefaultlibs
5548 Do not use the standard system libraries when linking.
5549 Only the libraries you specify will be passed to the linker.
5550 The standard startup files are used normally, unless @option{-nostartfiles}
5551 is used.  The compiler may generate calls to @code{memcmp},
5552 @code{memset}, @code{memcpy} and @code{memmove}.
5553 These entries are usually resolved by entries in
5554 libc.  These entry points should be supplied through some other
5555 mechanism when this option is specified.
5556
5557 @item -nostdlib
5558 @opindex nostdlib
5559 Do not use the standard system startup files or libraries when linking.
5560 No startup files and only the libraries you specify will be passed to
5561 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5562 @code{memcpy} and @code{memmove}.
5563 These entries are usually resolved by entries in
5564 libc.  These entry points should be supplied through some other
5565 mechanism when this option is specified.
5566
5567 @cindex @option{-lgcc}, use with @option{-nostdlib}
5568 @cindex @option{-nostdlib} and unresolved references
5569 @cindex unresolved references and @option{-nostdlib}
5570 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5571 @cindex @option{-nodefaultlibs} and unresolved references
5572 @cindex unresolved references and @option{-nodefaultlibs}
5573 One of the standard libraries bypassed by @option{-nostdlib} and
5574 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5575 that GCC uses to overcome shortcomings of particular machines, or special
5576 needs for some languages.
5577 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5578 Collection (GCC) Internals},
5579 for more discussion of @file{libgcc.a}.)
5580 In most cases, you need @file{libgcc.a} even when you want to avoid
5581 other standard libraries.  In other words, when you specify @option{-nostdlib}
5582 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5583 This ensures that you have no unresolved references to internal GCC
5584 library subroutines.  (For example, @samp{__main}, used to ensure C++
5585 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5586 GNU Compiler Collection (GCC) Internals}.)
5587
5588 @item -pie
5589 @opindex pie
5590 Produce a position independent executable on targets which support it.
5591 For predictable results, you must also specify the same set of options
5592 that were used to generate code (@option{-fpie}, @option{-fPIE},
5593 or model suboptions) when you specify this option.
5594
5595 @item -s
5596 @opindex s
5597 Remove all symbol table and relocation information from the executable.
5598
5599 @item -static
5600 @opindex static
5601 On systems that support dynamic linking, this prevents linking with the shared
5602 libraries.  On other systems, this option has no effect.
5603
5604 @item -shared
5605 @opindex shared
5606 Produce a shared object which can then be linked with other objects to
5607 form an executable.  Not all systems support this option.  For predictable
5608 results, you must also specify the same set of options that were used to
5609 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5610 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5611 needs to build supplementary stub code for constructors to work.  On
5612 multi-libbed systems, @samp{gcc -shared} must select the correct support
5613 libraries to link against.  Failing to supply the correct flags may lead
5614 to subtle defects.  Supplying them in cases where they are not necessary
5615 is innocuous.}
5616
5617 @item -shared-libgcc
5618 @itemx -static-libgcc
5619 @opindex shared-libgcc
5620 @opindex static-libgcc
5621 On systems that provide @file{libgcc} as a shared library, these options
5622 force the use of either the shared or static version respectively.
5623 If no shared version of @file{libgcc} was built when the compiler was
5624 configured, these options have no effect.
5625
5626 There are several situations in which an application should use the
5627 shared @file{libgcc} instead of the static version.  The most common
5628 of these is when the application wishes to throw and catch exceptions
5629 across different shared libraries.  In that case, each of the libraries
5630 as well as the application itself should use the shared @file{libgcc}.
5631
5632 Therefore, the G++ and GCJ drivers automatically add
5633 @option{-shared-libgcc} whenever you build a shared library or a main
5634 executable, because C++ and Java programs typically use exceptions, so
5635 this is the right thing to do.
5636
5637 If, instead, you use the GCC driver to create shared libraries, you may
5638 find that they will not always be linked with the shared @file{libgcc}.
5639 If GCC finds, at its configuration time, that you have a non-GNU linker
5640 or a GNU linker that does not support option @option{--eh-frame-hdr},
5641 it will link the shared version of @file{libgcc} into shared libraries
5642 by default.  Otherwise, it will take advantage of the linker and optimize
5643 away the linking with the shared version of @file{libgcc}, linking with
5644 the static version of libgcc by default.  This allows exceptions to
5645 propagate through such shared libraries, without incurring relocation
5646 costs at library load time.
5647
5648 However, if a library or main executable is supposed to throw or catch
5649 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5650 for the languages used in the program, or using the option
5651 @option{-shared-libgcc}, such that it is linked with the shared
5652 @file{libgcc}.
5653
5654 @item -symbolic
5655 @opindex symbolic
5656 Bind references to global symbols when building a shared object.  Warn
5657 about any unresolved references (unless overridden by the link editor
5658 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5659 this option.
5660
5661 @item -Xlinker @var{option}
5662 @opindex Xlinker
5663 Pass @var{option} as an option to the linker.  You can use this to
5664 supply system-specific linker options which GCC does not know how to
5665 recognize.
5666
5667 If you want to pass an option that takes an argument, you must use
5668 @option{-Xlinker} twice, once for the option and once for the argument.
5669 For example, to pass @option{-assert definitions}, you must write
5670 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5671 @option{-Xlinker "-assert definitions"}, because this passes the entire
5672 string as a single argument, which is not what the linker expects.
5673
5674 @item -Wl,@var{option}
5675 @opindex Wl
5676 Pass @var{option} as an option to the linker.  If @var{option} contains
5677 commas, it is split into multiple options at the commas.
5678
5679 @item -u @var{symbol}
5680 @opindex u
5681 Pretend the symbol @var{symbol} is undefined, to force linking of
5682 library modules to define it.  You can use @option{-u} multiple times with
5683 different symbols to force loading of additional library modules.
5684 @end table
5685
5686 @node Directory Options
5687 @section Options for Directory Search
5688 @cindex directory options
5689 @cindex options, directory search
5690 @cindex search path
5691
5692 These options specify directories to search for header files, for
5693 libraries and for parts of the compiler:
5694
5695 @table @gcctabopt
5696 @item -I@var{dir}
5697 @opindex I
5698 Add the directory @var{dir} to the head of the list of directories to be
5699 searched for header files.  This can be used to override a system header
5700 file, substituting your own version, since these directories are
5701 searched before the system header file directories.  However, you should
5702 not use this option to add directories that contain vendor-supplied
5703 system header files (use @option{-isystem} for that).  If you use more than
5704 one @option{-I} option, the directories are scanned in left-to-right
5705 order; the standard system directories come after.
5706
5707 If a standard system include directory, or a directory specified with
5708 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5709 option will be ignored.  The directory will still be searched but as a
5710 system directory at its normal position in the system include chain.
5711 This is to ensure that GCC's procedure to fix buggy system headers and
5712 the ordering for the include_next directive are not inadvertently changed.
5713 If you really need to change the search order for system directories,
5714 use the @option{-nostdinc} and/or @option{-isystem} options.
5715
5716 @item -iquote@var{dir}
5717 @opindex iquote
5718 Add the directory @var{dir} to the head of the list of directories to
5719 be searched for header files only for the case of @samp{#include
5720 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5721 otherwise just like @option{-I}.
5722
5723 @item -L@var{dir}
5724 @opindex L
5725 Add directory @var{dir} to the list of directories to be searched
5726 for @option{-l}.
5727
5728 @item -B@var{prefix}
5729 @opindex B
5730 This option specifies where to find the executables, libraries,
5731 include files, and data files of the compiler itself.
5732
5733 The compiler driver program runs one or more of the subprograms
5734 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5735 @var{prefix} as a prefix for each program it tries to run, both with and
5736 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5737
5738 For each subprogram to be run, the compiler driver first tries the
5739 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5740 was not specified, the driver tries two standard prefixes, which are
5741 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5742 those results in a file name that is found, the unmodified program
5743 name is searched for using the directories specified in your
5744 @env{PATH} environment variable.
5745
5746 The compiler will check to see if the path provided by the @option{-B}
5747 refers to a directory, and if necessary it will add a directory
5748 separator character at the end of the path.
5749
5750 @option{-B} prefixes that effectively specify directory names also apply
5751 to libraries in the linker, because the compiler translates these
5752 options into @option{-L} options for the linker.  They also apply to
5753 includes files in the preprocessor, because the compiler translates these
5754 options into @option{-isystem} options for the preprocessor.  In this case,
5755 the compiler appends @samp{include} to the prefix.
5756
5757 The run-time support file @file{libgcc.a} can also be searched for using
5758 the @option{-B} prefix, if needed.  If it is not found there, the two
5759 standard prefixes above are tried, and that is all.  The file is left
5760 out of the link if it is not found by those means.
5761
5762 Another way to specify a prefix much like the @option{-B} prefix is to use
5763 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5764 Variables}.
5765
5766 As a special kludge, if the path provided by @option{-B} is
5767 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5768 9, then it will be replaced by @file{[dir/]include}.  This is to help
5769 with boot-strapping the compiler.
5770
5771 @item -specs=@var{file}
5772 @opindex specs
5773 Process @var{file} after the compiler reads in the standard @file{specs}
5774 file, in order to override the defaults that the @file{gcc} driver
5775 program uses when determining what switches to pass to @file{cc1},
5776 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5777 @option{-specs=@var{file}} can be specified on the command line, and they
5778 are processed in order, from left to right.
5779
5780 @item -I-
5781 @opindex I-
5782 This option has been deprecated.  Please use @option{-iquote} instead for
5783 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5784 Any directories you specify with @option{-I} options before the @option{-I-}
5785 option are searched only for the case of @samp{#include "@var{file}"};
5786 they are not searched for @samp{#include <@var{file}>}.
5787
5788 If additional directories are specified with @option{-I} options after
5789 the @option{-I-}, these directories are searched for all @samp{#include}
5790 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5791 this way.)
5792
5793 In addition, the @option{-I-} option inhibits the use of the current
5794 directory (where the current input file came from) as the first search
5795 directory for @samp{#include "@var{file}"}.  There is no way to
5796 override this effect of @option{-I-}.  With @option{-I.} you can specify
5797 searching the directory which was current when the compiler was
5798 invoked.  That is not exactly the same as what the preprocessor does
5799 by default, but it is often satisfactory.
5800
5801 @option{-I-} does not inhibit the use of the standard system directories
5802 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5803 independent.
5804 @end table
5805
5806 @c man end
5807
5808 @node Spec Files
5809 @section Specifying subprocesses and the switches to pass to them
5810 @cindex Spec Files
5811
5812 @command{gcc} is a driver program.  It performs its job by invoking a
5813 sequence of other programs to do the work of compiling, assembling and
5814 linking.  GCC interprets its command-line parameters and uses these to
5815 deduce which programs it should invoke, and which command-line options
5816 it ought to place on their command lines.  This behavior is controlled
5817 by @dfn{spec strings}.  In most cases there is one spec string for each
5818 program that GCC can invoke, but a few programs have multiple spec
5819 strings to control their behavior.  The spec strings built into GCC can
5820 be overridden by using the @option{-specs=} command-line switch to specify
5821 a spec file.
5822
5823 @dfn{Spec files} are plaintext files that are used to construct spec
5824 strings.  They consist of a sequence of directives separated by blank
5825 lines.  The type of directive is determined by the first non-whitespace
5826 character on the line and it can be one of the following:
5827
5828 @table @code
5829 @item %@var{command}
5830 Issues a @var{command} to the spec file processor.  The commands that can
5831 appear here are:
5832
5833 @table @code
5834 @item %include <@var{file}>
5835 @cindex %include
5836 Search for @var{file} and insert its text at the current point in the
5837 specs file.
5838
5839 @item %include_noerr <@var{file}>
5840 @cindex %include_noerr
5841 Just like @samp{%include}, but do not generate an error message if the include
5842 file cannot be found.
5843
5844 @item %rename @var{old_name} @var{new_name}
5845 @cindex %rename
5846 Rename the spec string @var{old_name} to @var{new_name}.
5847
5848 @end table
5849
5850 @item *[@var{spec_name}]:
5851 This tells the compiler to create, override or delete the named spec
5852 string.  All lines after this directive up to the next directive or
5853 blank line are considered to be the text for the spec string.  If this
5854 results in an empty string then the spec will be deleted.  (Or, if the
5855 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5856 does not currently exist a new spec will be created.  If the spec does
5857 exist then its contents will be overridden by the text of this
5858 directive, unless the first character of that text is the @samp{+}
5859 character, in which case the text will be appended to the spec.
5860
5861 @item [@var{suffix}]:
5862 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5863 and up to the next directive or blank line are considered to make up the
5864 spec string for the indicated suffix.  When the compiler encounters an
5865 input file with the named suffix, it will processes the spec string in
5866 order to work out how to compile that file.  For example:
5867
5868 @smallexample
5869 .ZZ:
5870 z-compile -input %i
5871 @end smallexample
5872
5873 This says that any input file whose name ends in @samp{.ZZ} should be
5874 passed to the program @samp{z-compile}, which should be invoked with the
5875 command-line switch @option{-input} and with the result of performing the
5876 @samp{%i} substitution.  (See below.)
5877
5878 As an alternative to providing a spec string, the text that follows a
5879 suffix directive can be one of the following:
5880
5881 @table @code
5882 @item @@@var{language}
5883 This says that the suffix is an alias for a known @var{language}.  This is
5884 similar to using the @option{-x} command-line switch to GCC to specify a
5885 language explicitly.  For example:
5886
5887 @smallexample
5888 .ZZ:
5889 @@c++
5890 @end smallexample
5891
5892 Says that .ZZ files are, in fact, C++ source files.
5893
5894 @item #@var{name}
5895 This causes an error messages saying:
5896
5897 @smallexample
5898 @var{name} compiler not installed on this system.
5899 @end smallexample
5900 @end table
5901
5902 GCC already has an extensive list of suffixes built into it.
5903 This directive will add an entry to the end of the list of suffixes, but
5904 since the list is searched from the end backwards, it is effectively
5905 possible to override earlier entries using this technique.
5906
5907 @end table
5908
5909 GCC has the following spec strings built into it.  Spec files can
5910 override these strings or create their own.  Note that individual
5911 targets can also add their own spec strings to this list.
5912
5913 @smallexample
5914 asm          Options to pass to the assembler
5915 asm_final    Options to pass to the assembler post-processor
5916 cpp          Options to pass to the C preprocessor
5917 cc1          Options to pass to the C compiler
5918 cc1plus      Options to pass to the C++ compiler
5919 endfile      Object files to include at the end of the link
5920 link         Options to pass to the linker
5921 lib          Libraries to include on the command line to the linker
5922 libgcc       Decides which GCC support library to pass to the linker
5923 linker       Sets the name of the linker
5924 predefines   Defines to be passed to the C preprocessor
5925 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5926              by default
5927 startfile    Object files to include at the start of the link
5928 @end smallexample
5929
5930 Here is a small example of a spec file:
5931
5932 @smallexample
5933 %rename lib                 old_lib
5934
5935 *lib:
5936 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5937 @end smallexample
5938
5939 This example renames the spec called @samp{lib} to @samp{old_lib} and
5940 then overrides the previous definition of @samp{lib} with a new one.
5941 The new definition adds in some extra command-line options before
5942 including the text of the old definition.
5943
5944 @dfn{Spec strings} are a list of command-line options to be passed to their
5945 corresponding program.  In addition, the spec strings can contain
5946 @samp{%}-prefixed sequences to substitute variable text or to
5947 conditionally insert text into the command line.  Using these constructs
5948 it is possible to generate quite complex command lines.
5949
5950 Here is a table of all defined @samp{%}-sequences for spec
5951 strings.  Note that spaces are not generated automatically around the
5952 results of expanding these sequences.  Therefore you can concatenate them
5953 together or combine them with constant text in a single argument.
5954
5955 @table @code
5956 @item %%
5957 Substitute one @samp{%} into the program name or argument.
5958
5959 @item %i
5960 Substitute the name of the input file being processed.
5961
5962 @item %b
5963 Substitute the basename of the input file being processed.
5964 This is the substring up to (and not including) the last period
5965 and not including the directory.
5966
5967 @item %B
5968 This is the same as @samp{%b}, but include the file suffix (text after
5969 the last period).
5970
5971 @item %d
5972 Marks the argument containing or following the @samp{%d} as a
5973 temporary file name, so that that file will be deleted if GCC exits
5974 successfully.  Unlike @samp{%g}, this contributes no text to the
5975 argument.
5976
5977 @item %g@var{suffix}
5978 Substitute a file name that has suffix @var{suffix} and is chosen
5979 once per compilation, and mark the argument in the same way as
5980 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5981 name is now chosen in a way that is hard to predict even when previously
5982 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5983 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5984 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5985 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5986 was simply substituted with a file name chosen once per compilation,
5987 without regard to any appended suffix (which was therefore treated
5988 just like ordinary text), making such attacks more likely to succeed.
5989
5990 @item %u@var{suffix}
5991 Like @samp{%g}, but generates a new temporary file name even if
5992 @samp{%u@var{suffix}} was already seen.
5993
5994 @item %U@var{suffix}
5995 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5996 new one if there is no such last file name.  In the absence of any
5997 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5998 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5999 would involve the generation of two distinct file names, one
6000 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6001 simply substituted with a file name chosen for the previous @samp{%u},
6002 without regard to any appended suffix.
6003
6004 @item %j@var{suffix}
6005 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6006 writable, and if save-temps is off; otherwise, substitute the name
6007 of a temporary file, just like @samp{%u}.  This temporary file is not
6008 meant for communication between processes, but rather as a junk
6009 disposal mechanism.
6010
6011 @item %|@var{suffix}
6012 @itemx %m@var{suffix}
6013 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6014 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6015 all.  These are the two most common ways to instruct a program that it
6016 should read from standard input or write to standard output.  If you
6017 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6018 construct: see for example @file{f/lang-specs.h}.
6019
6020 @item %.@var{SUFFIX}
6021 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6022 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6023 terminated by the next space or %.
6024
6025 @item %w
6026 Marks the argument containing or following the @samp{%w} as the
6027 designated output file of this compilation.  This puts the argument
6028 into the sequence of arguments that @samp{%o} will substitute later.
6029
6030 @item %o
6031 Substitutes the names of all the output files, with spaces
6032 automatically placed around them.  You should write spaces
6033 around the @samp{%o} as well or the results are undefined.
6034 @samp{%o} is for use in the specs for running the linker.
6035 Input files whose names have no recognized suffix are not compiled
6036 at all, but they are included among the output files, so they will
6037 be linked.
6038
6039 @item %O
6040 Substitutes the suffix for object files.  Note that this is
6041 handled specially when it immediately follows @samp{%g, %u, or %U},
6042 because of the need for those to form complete file names.  The
6043 handling is such that @samp{%O} is treated exactly as if it had already
6044 been substituted, except that @samp{%g, %u, and %U} do not currently
6045 support additional @var{suffix} characters following @samp{%O} as they would
6046 following, for example, @samp{.o}.
6047
6048 @item %p
6049 Substitutes the standard macro predefinitions for the
6050 current target machine.  Use this when running @code{cpp}.
6051
6052 @item %P
6053 Like @samp{%p}, but puts @samp{__} before and after the name of each
6054 predefined macro, except for macros that start with @samp{__} or with
6055 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6056 C@.
6057
6058 @item %I
6059 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6060 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6061 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6062 as necessary.
6063
6064 @item %s
6065 Current argument is the name of a library or startup file of some sort.
6066 Search for that file in a standard list of directories and substitute
6067 the full name found.
6068
6069 @item %e@var{str}
6070 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6071 Use this when inconsistent options are detected.
6072
6073 @item %(@var{name})
6074 Substitute the contents of spec string @var{name} at this point.
6075
6076 @item %[@var{name}]
6077 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6078
6079 @item %x@{@var{option}@}
6080 Accumulate an option for @samp{%X}.
6081
6082 @item %X
6083 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6084 spec string.
6085
6086 @item %Y
6087 Output the accumulated assembler options specified by @option{-Wa}.
6088
6089 @item %Z
6090 Output the accumulated preprocessor options specified by @option{-Wp}.
6091
6092 @item %a
6093 Process the @code{asm} spec.  This is used to compute the
6094 switches to be passed to the assembler.
6095
6096 @item %A
6097 Process the @code{asm_final} spec.  This is a spec string for
6098 passing switches to an assembler post-processor, if such a program is
6099 needed.
6100
6101 @item %l
6102 Process the @code{link} spec.  This is the spec for computing the
6103 command line passed to the linker.  Typically it will make use of the
6104 @samp{%L %G %S %D and %E} sequences.
6105
6106 @item %D
6107 Dump out a @option{-L} option for each directory that GCC believes might
6108 contain startup files.  If the target supports multilibs then the
6109 current multilib directory will be prepended to each of these paths.
6110
6111 @item %M
6112 Output the multilib directory with directory separators replaced with
6113 @samp{_}.  If multilib directories are not set, or the multilib directory is
6114 @file{.} then this option emits nothing.
6115
6116 @item %L
6117 Process the @code{lib} spec.  This is a spec string for deciding which
6118 libraries should be included on the command line to the linker.
6119
6120 @item %G
6121 Process the @code{libgcc} spec.  This is a spec string for deciding
6122 which GCC support library should be included on the command line to the linker.
6123
6124 @item %S
6125 Process the @code{startfile} spec.  This is a spec for deciding which
6126 object files should be the first ones passed to the linker.  Typically
6127 this might be a file named @file{crt0.o}.
6128
6129 @item %E
6130 Process the @code{endfile} spec.  This is a spec string that specifies
6131 the last object files that will be passed to the linker.
6132
6133 @item %C
6134 Process the @code{cpp} spec.  This is used to construct the arguments
6135 to be passed to the C preprocessor.
6136
6137 @item %1
6138 Process the @code{cc1} spec.  This is used to construct the options to be
6139 passed to the actual C compiler (@samp{cc1}).
6140
6141 @item %2
6142 Process the @code{cc1plus} spec.  This is used to construct the options to be
6143 passed to the actual C++ compiler (@samp{cc1plus}).
6144
6145 @item %*
6146 Substitute the variable part of a matched option.  See below.
6147 Note that each comma in the substituted string is replaced by
6148 a single space.
6149
6150 @item %<@code{S}
6151 Remove all occurrences of @code{-S} from the command line.  Note---this
6152 command is position dependent.  @samp{%} commands in the spec string
6153 before this one will see @code{-S}, @samp{%} commands in the spec string
6154 after this one will not.
6155
6156 @item %:@var{function}(@var{args})
6157 Call the named function @var{function}, passing it @var{args}.
6158 @var{args} is first processed as a nested spec string, then split
6159 into an argument vector in the usual fashion.  The function returns
6160 a string which is processed as if it had appeared literally as part
6161 of the current spec.
6162
6163 The following built-in spec functions are provided:
6164
6165 @table @code
6166 @item @code{if-exists}
6167 The @code{if-exists} spec function takes one argument, an absolute
6168 pathname to a file.  If the file exists, @code{if-exists} returns the
6169 pathname.  Here is a small example of its usage:
6170
6171 @smallexample
6172 *startfile:
6173 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6174 @end smallexample
6175
6176 @item @code{if-exists-else}
6177 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6178 spec function, except that it takes two arguments.  The first argument is
6179 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6180 returns the pathname.  If it does not exist, it returns the second argument.
6181 This way, @code{if-exists-else} can be used to select one file or another,
6182 based on the existence of the first.  Here is a small example of its usage:
6183
6184 @smallexample
6185 *startfile:
6186 crt0%O%s %:if-exists(crti%O%s) \
6187 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6188 @end smallexample
6189 @end table
6190
6191 @item %@{@code{S}@}
6192 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6193 If that switch was not specified, this substitutes nothing.  Note that
6194 the leading dash is omitted when specifying this option, and it is
6195 automatically inserted if the substitution is performed.  Thus the spec
6196 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6197 and would output the command line option @option{-foo}.
6198
6199 @item %W@{@code{S}@}
6200 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6201 deleted on failure.
6202
6203 @item %@{@code{S}*@}
6204 Substitutes all the switches specified to GCC whose names start
6205 with @code{-S}, but which also take an argument.  This is used for
6206 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6207 GCC considers @option{-o foo} as being
6208 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6209 text, including the space.  Thus two arguments would be generated.
6210
6211 @item %@{@code{S}*&@code{T}*@}
6212 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6213 (the order of @code{S} and @code{T} in the spec is not significant).
6214 There can be any number of ampersand-separated variables; for each the
6215 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6216
6217 @item %@{@code{S}:@code{X}@}
6218 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6219
6220 @item %@{!@code{S}:@code{X}@}
6221 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6222
6223 @item %@{@code{S}*:@code{X}@}
6224 Substitutes @code{X} if one or more switches whose names start with
6225 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6226 once, no matter how many such switches appeared.  However, if @code{%*}
6227 appears somewhere in @code{X}, then @code{X} will be substituted once
6228 for each matching switch, with the @code{%*} replaced by the part of
6229 that switch that matched the @code{*}.
6230
6231 @item %@{.@code{S}:@code{X}@}
6232 Substitutes @code{X}, if processing a file with suffix @code{S}.
6233
6234 @item %@{!.@code{S}:@code{X}@}
6235 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6236
6237 @item %@{@code{S}|@code{P}:@code{X}@}
6238 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6239 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6240 although they have a stronger binding than the @samp{|}.  If @code{%*}
6241 appears in @code{X}, all of the alternatives must be starred, and only
6242 the first matching alternative is substituted.
6243
6244 For example, a spec string like this:
6245
6246 @smallexample
6247 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6248 @end smallexample
6249
6250 will output the following command-line options from the following input
6251 command-line options:
6252
6253 @smallexample
6254 fred.c        -foo -baz
6255 jim.d         -bar -boggle
6256 -d fred.c     -foo -baz -boggle
6257 -d jim.d      -bar -baz -boggle
6258 @end smallexample
6259
6260 @item %@{S:X; T:Y; :D@}
6261
6262 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6263 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6264 be as many clauses as you need.  This may be combined with @code{.},
6265 @code{!}, @code{|}, and @code{*} as needed.
6266
6267
6268 @end table
6269
6270 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6271 construct may contain other nested @samp{%} constructs or spaces, or
6272 even newlines.  They are processed as usual, as described above.
6273 Trailing white space in @code{X} is ignored.  White space may also
6274 appear anywhere on the left side of the colon in these constructs,
6275 except between @code{.} or @code{*} and the corresponding word.
6276
6277 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6278 handled specifically in these constructs.  If another value of
6279 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6280 @option{-W} switch is found later in the command line, the earlier
6281 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6282 just one letter, which passes all matching options.
6283
6284 The character @samp{|} at the beginning of the predicate text is used to
6285 indicate that a command should be piped to the following command, but
6286 only if @option{-pipe} is specified.
6287
6288 It is built into GCC which switches take arguments and which do not.
6289 (You might think it would be useful to generalize this to allow each
6290 compiler's spec to say which switches take arguments.  But this cannot
6291 be done in a consistent fashion.  GCC cannot even decide which input
6292 files have been specified without knowing which switches take arguments,
6293 and it must know which input files to compile in order to tell which
6294 compilers to run).
6295
6296 GCC also knows implicitly that arguments starting in @option{-l} are to be
6297 treated as compiler output files, and passed to the linker in their
6298 proper position among the other output files.
6299
6300 @c man begin OPTIONS
6301
6302 @node Target Options
6303 @section Specifying Target Machine and Compiler Version
6304 @cindex target options
6305 @cindex cross compiling
6306 @cindex specifying machine version
6307 @cindex specifying compiler version and target machine
6308 @cindex compiler version, specifying
6309 @cindex target machine, specifying
6310
6311 The usual way to run GCC is to run the executable called @file{gcc}, or
6312 @file{<machine>-gcc} when cross-compiling, or
6313 @file{<machine>-gcc-<version>} to run a version other than the one that
6314 was installed last.  Sometimes this is inconvenient, so GCC provides
6315 options that will switch to another cross-compiler or version.
6316
6317 @table @gcctabopt
6318 @item -b @var{machine}
6319 @opindex b
6320 The argument @var{machine} specifies the target machine for compilation.
6321
6322 The value to use for @var{machine} is the same as was specified as the
6323 machine type when configuring GCC as a cross-compiler.  For
6324 example, if a cross-compiler was configured with @samp{configure
6325 i386v}, meaning to compile for an 80386 running System V, then you
6326 would specify @option{-b i386v} to run that cross compiler.
6327
6328 @item -V @var{version}
6329 @opindex V
6330 The argument @var{version} specifies which version of GCC to run.
6331 This is useful when multiple versions are installed.  For example,
6332 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6333 @end table
6334
6335 The @option{-V} and @option{-b} options work by running the
6336 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6337 use them if you can just run that directly.
6338
6339 @node Submodel Options
6340 @section Hardware Models and Configurations
6341 @cindex submodel options
6342 @cindex specifying hardware config
6343 @cindex hardware models and configurations, specifying
6344 @cindex machine dependent options
6345
6346 Earlier we discussed the standard option @option{-b} which chooses among
6347 different installed compilers for completely different target
6348 machines, such as VAX vs.@: 68000 vs.@: 80386.
6349
6350 In addition, each of these target machine types can have its own
6351 special options, starting with @samp{-m}, to choose among various
6352 hardware models or configurations---for example, 68010 vs 68020,
6353 floating coprocessor or none.  A single installed version of the
6354 compiler can compile for any model or configuration, according to the
6355 options specified.
6356
6357 Some configurations of the compiler also support additional special
6358 options, usually for compatibility with other compilers on the same
6359 platform.
6360
6361 These options are defined by the macro @code{TARGET_SWITCHES} in the
6362 machine description.  The default for the options is also defined by
6363 that macro, which enables you to change the defaults.
6364
6365 @c This list is ordered alphanumerically by subsection name.
6366 @c It should be the same order and spelling as these options are listed
6367 @c in Machine Dependent Options
6368
6369 @menu
6370 * ARC Options::
6371 * ARM Options::
6372 * AVR Options::
6373 * CRIS Options::
6374 * Darwin Options::
6375 * DEC Alpha Options::
6376 * DEC Alpha/VMS Options::
6377 * FRV Options::
6378 * H8/300 Options::
6379 * HPPA Options::
6380 * i386 and x86-64 Options::
6381 * IA-64 Options::
6382 * M32R/D Options::
6383 * M680x0 Options::
6384 * M68hc1x Options::
6385 * MCore Options::
6386 * MIPS Options::
6387 * MMIX Options::
6388 * MN10300 Options::
6389 * NS32K Options::
6390 * PDP-11 Options::
6391 * PowerPC Options::
6392 * RS/6000 and PowerPC Options::
6393 * S/390 and zSeries Options::
6394 * SH Options::
6395 * SPARC Options::
6396 * System V Options::
6397 * TMS320C3x/C4x Options::
6398 * V850 Options::
6399 * VAX Options::
6400 * x86-64 Options::
6401 * Xstormy16 Options::
6402 * Xtensa Options::
6403 * zSeries Options::
6404 @end menu
6405
6406 @node ARC Options
6407 @subsection ARC Options
6408 @cindex ARC Options
6409
6410 These options are defined for ARC implementations:
6411
6412 @table @gcctabopt
6413 @item -EL
6414 @opindex EL
6415 Compile code for little endian mode.  This is the default.
6416
6417 @item -EB
6418 @opindex EB
6419 Compile code for big endian mode.
6420
6421 @item -mmangle-cpu
6422 @opindex mmangle-cpu
6423 Prepend the name of the cpu to all public symbol names.
6424 In multiple-processor systems, there are many ARC variants with different
6425 instruction and register set characteristics.  This flag prevents code
6426 compiled for one cpu to be linked with code compiled for another.
6427 No facility exists for handling variants that are ``almost identical''.
6428 This is an all or nothing option.
6429
6430 @item -mcpu=@var{cpu}
6431 @opindex mcpu
6432 Compile code for ARC variant @var{cpu}.
6433 Which variants are supported depend on the configuration.
6434 All variants support @option{-mcpu=base}, this is the default.
6435
6436 @item -mtext=@var{text-section}
6437 @itemx -mdata=@var{data-section}
6438 @itemx -mrodata=@var{readonly-data-section}
6439 @opindex mtext
6440 @opindex mdata
6441 @opindex mrodata
6442 Put functions, data, and readonly data in @var{text-section},
6443 @var{data-section}, and @var{readonly-data-section} respectively
6444 by default.  This can be overridden with the @code{section} attribute.
6445 @xref{Variable Attributes}.
6446
6447 @end table
6448
6449 @node ARM Options
6450 @subsection ARM Options
6451 @cindex ARM options
6452
6453 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6454 architectures:
6455
6456 @table @gcctabopt
6457 @item -mabi=@var{name}
6458 @opindex mabi
6459 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6460 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6461
6462 @item -mapcs-frame
6463 @opindex mapcs-frame
6464 Generate a stack frame that is compliant with the ARM Procedure Call
6465 Standard for all functions, even if this is not strictly necessary for
6466 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6467 with this option will cause the stack frames not to be generated for
6468 leaf functions.  The default is @option{-mno-apcs-frame}.
6469
6470 @item -mapcs
6471 @opindex mapcs
6472 This is a synonym for @option{-mapcs-frame}.
6473
6474 @ignore
6475 @c not currently implemented
6476 @item -mapcs-stack-check
6477 @opindex mapcs-stack-check
6478 Generate code to check the amount of stack space available upon entry to
6479 every function (that actually uses some stack space).  If there is
6480 insufficient space available then either the function
6481 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6482 called, depending upon the amount of stack space required.  The run time
6483 system is required to provide these functions.  The default is
6484 @option{-mno-apcs-stack-check}, since this produces smaller code.
6485
6486 @c not currently implemented
6487 @item -mapcs-float
6488 @opindex mapcs-float
6489 Pass floating point arguments using the float point registers.  This is
6490 one of the variants of the APCS@.  This option is recommended if the
6491 target hardware has a floating point unit or if a lot of floating point
6492 arithmetic is going to be performed by the code.  The default is
6493 @option{-mno-apcs-float}, since integer only code is slightly increased in
6494 size if @option{-mapcs-float} is used.
6495
6496 @c not currently implemented
6497 @item -mapcs-reentrant
6498 @opindex mapcs-reentrant
6499 Generate reentrant, position independent code.  The default is
6500 @option{-mno-apcs-reentrant}.
6501 @end ignore
6502
6503 @item -mthumb-interwork
6504 @opindex mthumb-interwork
6505 Generate code which supports calling between the ARM and Thumb
6506 instruction sets.  Without this option the two instruction sets cannot
6507 be reliably used inside one program.  The default is
6508 @option{-mno-thumb-interwork}, since slightly larger code is generated
6509 when @option{-mthumb-interwork} is specified.
6510
6511 @item -mno-sched-prolog
6512 @opindex mno-sched-prolog
6513 Prevent the reordering of instructions in the function prolog, or the
6514 merging of those instruction with the instructions in the function's
6515 body.  This means that all functions will start with a recognizable set
6516 of instructions (or in fact one of a choice from a small set of
6517 different function prologues), and this information can be used to
6518 locate the start if functions inside an executable piece of code.  The
6519 default is @option{-msched-prolog}.
6520
6521 @item -mhard-float
6522 @opindex mhard-float
6523 Generate output containing floating point instructions.  This is the
6524 default.
6525
6526 @item -msoft-float
6527 @opindex msoft-float
6528 Generate output containing library calls for floating point.
6529 @strong{Warning:} the requisite libraries are not available for all ARM
6530 targets.  Normally the facilities of the machine's usual C compiler are
6531 used, but this cannot be done directly in cross-compilation.  You must make
6532 your own arrangements to provide suitable library functions for
6533 cross-compilation.
6534
6535 @option{-msoft-float} changes the calling convention in the output file;
6536 therefore, it is only useful if you compile @emph{all} of a program with
6537 this option.  In particular, you need to compile @file{libgcc.a}, the
6538 library that comes with GCC, with @option{-msoft-float} in order for
6539 this to work.
6540
6541 @item -mfloat-abi=@var{name}
6542 @opindex mfloat-abi
6543 Specifies which ABI to use for floating point values.  Permissible values
6544 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6545
6546 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6547 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6548 of floating point instructions, but still uses the soft-float calling
6549 conventions.
6550
6551 @item -mlittle-endian
6552 @opindex mlittle-endian
6553 Generate code for a processor running in little-endian mode.  This is
6554 the default for all standard configurations.
6555
6556 @item -mbig-endian
6557 @opindex mbig-endian
6558 Generate code for a processor running in big-endian mode; the default is
6559 to compile code for a little-endian processor.
6560
6561 @item -mwords-little-endian
6562 @opindex mwords-little-endian
6563 This option only applies when generating code for big-endian processors.
6564 Generate code for a little-endian word order but a big-endian byte
6565 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6566 option should only be used if you require compatibility with code for
6567 big-endian ARM processors generated by versions of the compiler prior to
6568 2.8.
6569
6570 @item -mcpu=@var{name}
6571 @opindex mcpu
6572 This specifies the name of the target ARM processor.  GCC uses this name
6573 to determine what kind of instructions it can emit when generating
6574 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6575 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6576 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6577 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6578 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6579 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6580 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6581 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6582 @samp{arm920t}, @samp{arm922t}, @samp{arm946es}, @samp{arm966es},
6583 @samp{arm968es}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6584 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6585 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6586 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6587 @samp{ep9312}.
6588
6589 @itemx -mtune=@var{name}
6590 @opindex mtune
6591 This option is very similar to the @option{-mcpu=} option, except that
6592 instead of specifying the actual target processor type, and hence
6593 restricting which instructions can be used, it specifies that GCC should
6594 tune the performance of the code as if the target were of the type
6595 specified in this option, but still choosing the instructions that it
6596 will generate based on the cpu specified by a @option{-mcpu=} option.
6597 For some ARM implementations better performance can be obtained by using
6598 this option.
6599
6600 @item -march=@var{name}
6601 @opindex march
6602 This specifies the name of the target ARM architecture.  GCC uses this
6603 name to determine what kind of instructions it can emit when generating
6604 assembly code.  This option can be used in conjunction with or instead
6605 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6606 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6607 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6608 @samp{iwmmxt}, @samp{ep9312}.
6609
6610 @item -mfpu=@var{name}
6611 @itemx -mfpe=@var{number}
6612 @itemx -mfp=@var{number}
6613 @opindex mfpu
6614 @opindex mfpe
6615 @opindex mfp
6616 This specifies what floating point hardware (or hardware emulation) is
6617 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6618 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6619 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6620 with older versions of GCC@.
6621
6622 If @option{-msoft-float} is specified this specifies the format of
6623 floating point values.
6624
6625 @item -mstructure-size-boundary=@var{n}
6626 @opindex mstructure-size-boundary
6627 The size of all structures and unions will be rounded up to a multiple
6628 of the number of bits set by this option.  Permissible values are 8, 32
6629 and 64.  The default value varies for different toolchains.  For the COFF
6630 targeted toolchain the default value is 8.  A value of 64 is only allowed
6631 if the underlying ABI supports it.
6632
6633 Specifying the larger number can produce faster, more efficient code, but
6634 can also increase the size of the program.  Different values are potentially
6635 incompatible.  Code compiled with one value cannot necessarily expect to
6636 work with code or libraries compiled with another value, if they exchange
6637 information using structures or unions.
6638
6639 @item -mabort-on-noreturn
6640 @opindex mabort-on-noreturn
6641 Generate a call to the function @code{abort} at the end of a
6642 @code{noreturn} function.  It will be executed if the function tries to
6643 return.
6644
6645 @item -mlong-calls
6646 @itemx -mno-long-calls
6647 @opindex mlong-calls
6648 @opindex mno-long-calls
6649 Tells the compiler to perform function calls by first loading the
6650 address of the function into a register and then performing a subroutine
6651 call on this register.  This switch is needed if the target function
6652 will lie outside of the 64 megabyte addressing range of the offset based
6653 version of subroutine call instruction.
6654
6655 Even if this switch is enabled, not all function calls will be turned
6656 into long calls.  The heuristic is that static functions, functions
6657 which have the @samp{short-call} attribute, functions that are inside
6658 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6659 definitions have already been compiled within the current compilation
6660 unit, will not be turned into long calls.  The exception to this rule is
6661 that weak function definitions, functions with the @samp{long-call}
6662 attribute or the @samp{section} attribute, and functions that are within
6663 the scope of a @samp{#pragma long_calls} directive, will always be
6664 turned into long calls.
6665
6666 This feature is not enabled by default.  Specifying
6667 @option{-mno-long-calls} will restore the default behavior, as will
6668 placing the function calls within the scope of a @samp{#pragma
6669 long_calls_off} directive.  Note these switches have no effect on how
6670 the compiler generates code to handle function calls via function
6671 pointers.
6672
6673 @item -mnop-fun-dllimport
6674 @opindex mnop-fun-dllimport
6675 Disable support for the @code{dllimport} attribute.
6676
6677 @item -msingle-pic-base
6678 @opindex msingle-pic-base
6679 Treat the register used for PIC addressing as read-only, rather than
6680 loading it in the prologue for each function.  The run-time system is
6681 responsible for initializing this register with an appropriate value
6682 before execution begins.
6683
6684 @item -mpic-register=@var{reg}
6685 @opindex mpic-register
6686 Specify the register to be used for PIC addressing.  The default is R10
6687 unless stack-checking is enabled, when R9 is used.
6688
6689 @item -mcirrus-fix-invalid-insns
6690 @opindex mcirrus-fix-invalid-insns
6691 @opindex mno-cirrus-fix-invalid-insns
6692 Insert NOPs into the instruction stream to in order to work around
6693 problems with invalid Maverick instruction combinations.  This option
6694 is only valid if the @option{-mcpu=ep9312} option has been used to
6695 enable generation of instructions for the Cirrus Maverick floating
6696 point co-processor.  This option is not enabled by default, since the
6697 problem is only present in older Maverick implementations.  The default
6698 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6699 switch.
6700
6701 @item -mpoke-function-name
6702 @opindex mpoke-function-name
6703 Write the name of each function into the text section, directly
6704 preceding the function prologue.  The generated code is similar to this:
6705
6706 @smallexample
6707      t0
6708          .ascii "arm_poke_function_name", 0
6709          .align
6710      t1
6711          .word 0xff000000 + (t1 - t0)
6712      arm_poke_function_name
6713          mov     ip, sp
6714          stmfd   sp!, @{fp, ip, lr, pc@}
6715          sub     fp, ip, #4
6716 @end smallexample
6717
6718 When performing a stack backtrace, code can inspect the value of
6719 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6720 location @code{pc - 12} and the top 8 bits are set, then we know that
6721 there is a function name embedded immediately preceding this location
6722 and has length @code{((pc[-3]) & 0xff000000)}.
6723
6724 @item -mthumb
6725 @opindex mthumb
6726 Generate code for the 16-bit Thumb instruction set.  The default is to
6727 use the 32-bit ARM instruction set.
6728
6729 @item -mtpcs-frame
6730 @opindex mtpcs-frame
6731 Generate a stack frame that is compliant with the Thumb Procedure Call
6732 Standard for all non-leaf functions.  (A leaf function is one that does
6733 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6734
6735 @item -mtpcs-leaf-frame
6736 @opindex mtpcs-leaf-frame
6737 Generate a stack frame that is compliant with the Thumb Procedure Call
6738 Standard for all leaf functions.  (A leaf function is one that does
6739 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6740
6741 @item -mcallee-super-interworking
6742 @opindex mcallee-super-interworking
6743 Gives all externally visible functions in the file being compiled an ARM
6744 instruction set header which switches to Thumb mode before executing the
6745 rest of the function.  This allows these functions to be called from
6746 non-interworking code.
6747
6748 @item -mcaller-super-interworking
6749 @opindex mcaller-super-interworking
6750 Allows calls via function pointers (including virtual functions) to
6751 execute correctly regardless of whether the target code has been
6752 compiled for interworking or not.  There is a small overhead in the cost
6753 of executing a function pointer if this option is enabled.
6754
6755 @end table
6756
6757 @node AVR Options
6758 @subsection AVR Options
6759 @cindex AVR Options
6760
6761 These options are defined for AVR implementations:
6762
6763 @table @gcctabopt
6764 @item -mmcu=@var{mcu}
6765 @opindex mmcu
6766 Specify ATMEL AVR instruction set or MCU type.
6767
6768 Instruction set avr1 is for the minimal AVR core, not supported by the C
6769 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6770 attiny11, attiny12, attiny15, attiny28).
6771
6772 Instruction set avr2 (default) is for the classic AVR core with up to
6773 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6774 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6775 at90c8534, at90s8535).
6776
6777 Instruction set avr3 is for the classic AVR core with up to 128K program
6778 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6779
6780 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6781 memory space (MCU types: atmega8, atmega83, atmega85).
6782
6783 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6784 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6785 atmega64, atmega128, at43usb355, at94k).
6786
6787 @item -msize
6788 @opindex msize
6789 Output instruction sizes to the asm file.
6790
6791 @item -minit-stack=@var{N}
6792 @opindex minit-stack
6793 Specify the initial stack address, which may be a symbol or numeric value,
6794 @samp{__stack} is the default.
6795
6796 @item -mno-interrupts
6797 @opindex mno-interrupts
6798 Generated code is not compatible with hardware interrupts.
6799 Code size will be smaller.
6800
6801 @item -mcall-prologues
6802 @opindex mcall-prologues
6803 Functions prologues/epilogues expanded as call to appropriate
6804 subroutines.  Code size will be smaller.
6805
6806 @item -mno-tablejump
6807 @opindex mno-tablejump
6808 Do not generate tablejump insns which sometimes increase code size.
6809
6810 @item -mtiny-stack
6811 @opindex mtiny-stack
6812 Change only the low 8 bits of the stack pointer.
6813
6814 @item -mint8
6815 @opindex mint8
6816 Assume int to be 8 bit integer. This affects the sizes of all types: A
6817 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
6818 and long long will be 4 bytes. Please note that this option does not
6819 comply to the C standards, but it will provide you with smaller code
6820 size.
6821 @end table
6822
6823 @node CRIS Options
6824 @subsection CRIS Options
6825 @cindex CRIS Options
6826
6827 These options are defined specifically for the CRIS ports.
6828
6829 @table @gcctabopt
6830 @item -march=@var{architecture-type}
6831 @itemx -mcpu=@var{architecture-type}
6832 @opindex march
6833 @opindex mcpu
6834 Generate code for the specified architecture.  The choices for
6835 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
6836 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
6837 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
6838 @samp{v10}.
6839
6840 @item -mtune=@var{architecture-type}
6841 @opindex mtune
6842 Tune to @var{architecture-type} everything applicable about the generated
6843 code, except for the ABI and the set of available instructions.  The
6844 choices for @var{architecture-type} are the same as for
6845 @option{-march=@var{architecture-type}}.
6846
6847 @item -mmax-stack-frame=@var{n}
6848 @opindex mmax-stack-frame
6849 Warn when the stack frame of a function exceeds @var{n} bytes.
6850
6851 @item -melinux-stacksize=@var{n}
6852 @opindex melinux-stacksize
6853 Only available with the @samp{cris-axis-aout} target.  Arranges for
6854 indications in the program to the kernel loader that the stack of the
6855 program should be set to @var{n} bytes.
6856
6857 @item -metrax4
6858 @itemx -metrax100
6859 @opindex metrax4
6860 @opindex metrax100
6861 The options @option{-metrax4} and @option{-metrax100} are synonyms for
6862 @option{-march=v3} and @option{-march=v8} respectively.
6863
6864 @item -mmul-bug-workaround
6865 @itemx -mno-mul-bug-workaround
6866 @opindex mmul-bug-workaround
6867 @opindex mno-mul-bug-workaround
6868 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
6869 models where it applies.  This option is active by default.
6870
6871 @item -mpdebug
6872 @opindex mpdebug
6873 Enable CRIS-specific verbose debug-related information in the assembly
6874 code.  This option also has the effect to turn off the @samp{#NO_APP}
6875 formatted-code indicator to the assembler at the beginning of the
6876 assembly file.
6877
6878 @item -mcc-init
6879 @opindex mcc-init
6880 Do not use condition-code results from previous instruction; always emit
6881 compare and test instructions before use of condition codes.
6882
6883 @item -mno-side-effects
6884 @opindex mno-side-effects
6885 Do not emit instructions with side-effects in addressing modes other than
6886 post-increment.
6887
6888 @item -mstack-align
6889 @itemx -mno-stack-align
6890 @itemx -mdata-align
6891 @itemx -mno-data-align
6892 @itemx -mconst-align
6893 @itemx -mno-const-align
6894 @opindex mstack-align
6895 @opindex mno-stack-align
6896 @opindex mdata-align
6897 @opindex mno-data-align
6898 @opindex mconst-align
6899 @opindex mno-const-align
6900 These options (no-options) arranges (eliminate arrangements) for the
6901 stack-frame, individual data and constants to be aligned for the maximum
6902 single data access size for the chosen CPU model.  The default is to
6903 arrange for 32-bit alignment.  ABI details such as structure layout are
6904 not affected by these options.
6905
6906 @item -m32-bit
6907 @itemx -m16-bit
6908 @itemx -m8-bit
6909 @opindex m32-bit
6910 @opindex m16-bit
6911 @opindex m8-bit
6912 Similar to the stack- data- and const-align options above, these options
6913 arrange for stack-frame, writable data and constants to all be 32-bit,
6914 16-bit or 8-bit aligned.  The default is 32-bit alignment.
6915
6916 @item -mno-prologue-epilogue
6917 @itemx -mprologue-epilogue
6918 @opindex mno-prologue-epilogue
6919 @opindex mprologue-epilogue
6920 With @option{-mno-prologue-epilogue}, the normal function prologue and
6921 epilogue that sets up the stack-frame are omitted and no return
6922 instructions or return sequences are generated in the code.  Use this
6923 option only together with visual inspection of the compiled code: no
6924 warnings or errors are generated when call-saved registers must be saved,
6925 or storage for local variable needs to be allocated.
6926
6927 @item -mno-gotplt
6928 @itemx -mgotplt
6929 @opindex mno-gotplt
6930 @opindex mgotplt
6931 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
6932 instruction sequences that load addresses for functions from the PLT part
6933 of the GOT rather than (traditional on other architectures) calls to the
6934 PLT.  The default is @option{-mgotplt}.
6935
6936 @item -maout
6937 @opindex maout
6938 Legacy no-op option only recognized with the cris-axis-aout target.
6939
6940 @item -melf
6941 @opindex melf
6942 Legacy no-op option only recognized with the cris-axis-elf and
6943 cris-axis-linux-gnu targets.
6944
6945 @item -melinux
6946 @opindex melinux
6947 Only recognized with the cris-axis-aout target, where it selects a
6948 GNU/linux-like multilib, include files and instruction set for
6949 @option{-march=v8}.
6950
6951 @item -mlinux
6952 @opindex mlinux
6953 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
6954
6955 @item -sim
6956 @opindex sim
6957 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
6958 to link with input-output functions from a simulator library.  Code,
6959 initialized data and zero-initialized data are allocated consecutively.
6960
6961 @item -sim2
6962 @opindex sim2
6963 Like @option{-sim}, but pass linker options to locate initialized data at
6964 0x40000000 and zero-initialized data at 0x80000000.
6965 @end table
6966
6967 @node Darwin Options
6968 @subsection Darwin Options
6969 @cindex Darwin options
6970
6971 These options are defined for all architectures running the Darwin operating
6972 system.  They are useful for compatibility with other Mac OS compilers.
6973
6974 @table @gcctabopt
6975 @item -F@var{dir}
6976 @opindex F
6977 Add the framework directory @var{dir} to the head of the list of
6978 directories to be searched for header files.  These directories are
6979 interleaved with those specified by @option{-I} options and are
6980 scanned in a left-to-right order.
6981
6982 A framework directory is a directory with frameworks in it.  A
6983 framework is a directory with a @samp{"Headers"} and/or
6984 @samp{"PrivateHeaders"} directory contained directly in it that ends
6985 in @samp{".framework"}.  The name of a framework is the name of this
6986 directory excluding the @samp{".framework"}.  Headers associated with
6987 the framework are found in one of those two directories, with
6988 @samp{"Headers"} being searched first.  A subframework is a framework
6989 directory that is in a framework's @samp{"Frameworks"} directory.
6990 Includes of subframework headers can only appear in a header of a
6991 framework that contains the subframework, or in a sibling subframework
6992 header.  Two subframeworks are siblings if they occur in the same
6993 framework.  A subframework should not have the same name as a
6994 framework, a warning will be issued if this is violated.  Currently a
6995 subframework cannot have subframeworks, in the future, the mechanism
6996 may be extended to support this.  The standard frameworks can be found
6997 in @samp{"/System/Library/Frameworks"} and
6998 @samp{"/Library/Frameworks"}.  An example include looks like
6999 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7000 the name of the framework and header.h is found in the
7001 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7002
7003 @item -gused
7004 @opindex -gused
7005 Emit debugging information for symbols that are used. For STABS
7006 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7007 This is by default ON.
7008
7009 @item -gfull
7010 @opindex -gfull
7011 Emit debugging information for all symbols and types.
7012
7013 @item -mone-byte-bool
7014 @opindex -mone-byte-bool
7015 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7016 By default @samp{sizeof(bool)} is @samp{4} when compiling for 
7017 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7018 option has no effect on x86.
7019
7020 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7021 to generate code that is not binary compatible with code generated
7022 without that switch.  Using this switch may require recompiling all
7023 other modules in a program, including system libraries.  Use this 
7024 switch to conform to a non-default data model.
7025
7026 @item -mfix-and-continue
7027 @itemx -ffix-and-continue
7028 @itemx -findirect-data
7029 @opindex mfix-and-continue
7030 @opindex ffix-and-continue
7031 @opindex findirect-data
7032 Generate code suitable for fast turn around development.  Needed to
7033 enable gdb to dynamically load @code{.o} files into already running
7034 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7035 are provided for backwards compatibility.
7036
7037 @item -all_load
7038 @opindex all_load
7039 Loads all members of static archive libraries.
7040 See man ld(1) for more information.
7041
7042 @item -arch_errors_fatal
7043 @opindex arch_errors_fatal
7044 Cause the errors having to do with files that have the wrong architecture
7045 to be fatal.
7046
7047 @item -bind_at_load
7048 @opindex bind_at_load
7049 Causes the output file to be marked such that the dynamic linker will
7050 bind all undefined references when the file is loaded or launched.
7051
7052 @item -bundle
7053 @opindex bundle
7054 Produce a Mach-o bundle format file.
7055 See man ld(1) for more information.
7056
7057 @item -bundle_loader @var{executable}
7058 @opindex bundle_loader
7059 This specifies the @var{executable} that will be loading the build
7060 output file being linked. See man ld(1) for more information.
7061
7062 @item -allowable_client  @var{client_name}
7063 @itemx -arch_only
7064
7065 @itemx -client_name
7066 @itemx -compatibility_version
7067 @itemx -current_version
7068 @itemx -dead_strip
7069 @itemx -dependency-file
7070 @itemx -dylib_file
7071 @itemx -dylinker_install_name
7072 @itemx -dynamic
7073 @itemx -dynamiclib
7074 @itemx -exported_symbols_list
7075 @itemx -filelist
7076 @itemx -flat_namespace
7077 @itemx -force_cpusubtype_ALL
7078 @itemx -force_flat_namespace
7079 @itemx -headerpad_max_install_names
7080 @itemx -image_base
7081 @itemx -init
7082 @itemx -install_name
7083 @itemx -keep_private_externs
7084 @itemx -multi_module
7085 @itemx -multiply_defined
7086 @itemx -multiply_defined_unused
7087 @itemx -noall_load
7088 @itemx -no_dead_strip_inits_and_terms
7089 @itemx -nofixprebinding
7090 @itemx -nomultidefs
7091 @itemx -noprebind
7092 @itemx -noseglinkedit
7093 @itemx -pagezero_size
7094 @itemx -prebind
7095 @itemx -prebind_all_twolevel_modules
7096 @itemx -private_bundle
7097 @itemx -read_only_relocs
7098 @itemx -sectalign
7099 @itemx -sectobjectsymbols
7100 @itemx -whyload
7101 @itemx -seg1addr
7102 @itemx -sectcreate
7103 @itemx -sectobjectsymbols
7104 @itemx -sectorder
7105 @itemx -seg_addr_table
7106 @itemx -seg_addr_table_filename
7107 @itemx -seglinkedit
7108 @itemx -segprot
7109 @itemx -segs_read_only_addr
7110 @itemx -segs_read_write_addr
7111 @itemx -single_module
7112 @itemx -static
7113 @itemx -sub_library
7114 @itemx -sub_umbrella
7115 @itemx -twolevel_namespace
7116 @itemx -umbrella
7117 @itemx -undefined
7118 @itemx -unexported_symbols_list
7119 @itemx -weak_reference_mismatches
7120 @itemx -whatsloaded
7121
7122 @opindex allowable_client
7123 @opindex arch_only
7124 @opindex client_name
7125 @opindex compatibility_version
7126 @opindex current_version
7127 @opindex dead_strip
7128 @opindex dependency-file
7129 @opindex dylib_file
7130 @opindex dylinker_install_name
7131 @opindex dynamic
7132 @opindex dynamiclib
7133 @opindex exported_symbols_list
7134 @opindex filelist
7135 @opindex flat_namespace
7136 @opindex force_cpusubtype_ALL
7137 @opindex force_flat_namespace
7138 @opindex headerpad_max_install_names
7139 @opindex image_base
7140 @opindex init
7141 @opindex install_name
7142 @opindex keep_private_externs
7143 @opindex multi_module
7144 @opindex multiply_defined
7145 @opindex multiply_defined_unused
7146 @opindex noall_load
7147 @opindex no_dead_strip_inits_and_terms
7148 @opindex nofixprebinding
7149 @opindex nomultidefs
7150 @opindex noprebind
7151 @opindex noseglinkedit
7152 @opindex pagezero_size
7153 @opindex prebind
7154 @opindex prebind_all_twolevel_modules
7155 @opindex private_bundle
7156 @opindex read_only_relocs
7157 @opindex sectalign
7158 @opindex sectobjectsymbols
7159 @opindex whyload
7160 @opindex seg1addr
7161 @opindex sectcreate
7162 @opindex sectobjectsymbols
7163 @opindex sectorder
7164 @opindex seg_addr_table
7165 @opindex seg_addr_table_filename
7166 @opindex seglinkedit
7167 @opindex segprot
7168 @opindex segs_read_only_addr
7169 @opindex segs_read_write_addr
7170 @opindex single_module
7171 @opindex static
7172 @opindex sub_library
7173 @opindex sub_umbrella
7174 @opindex twolevel_namespace
7175 @opindex umbrella
7176 @opindex undefined
7177 @opindex unexported_symbols_list
7178 @opindex weak_reference_mismatches
7179 @opindex whatsloaded
7180
7181 These options are available for Darwin linker. Darwin linker man page
7182 describes them in detail.
7183 @end table
7184
7185 @node DEC Alpha Options
7186 @subsection DEC Alpha Options
7187
7188 These @samp{-m} options are defined for the DEC Alpha implementations:
7189
7190 @table @gcctabopt
7191 @item -mno-soft-float
7192 @itemx -msoft-float
7193 @opindex mno-soft-float
7194 @opindex msoft-float
7195 Use (do not use) the hardware floating-point instructions for
7196 floating-point operations.  When @option{-msoft-float} is specified,
7197 functions in @file{libgcc.a} will be used to perform floating-point
7198 operations.  Unless they are replaced by routines that emulate the
7199 floating-point operations, or compiled in such a way as to call such
7200 emulations routines, these routines will issue floating-point
7201 operations.   If you are compiling for an Alpha without floating-point
7202 operations, you must ensure that the library is built so as not to call
7203 them.
7204
7205 Note that Alpha implementations without floating-point operations are
7206 required to have floating-point registers.
7207
7208 @item -mfp-reg
7209 @itemx -mno-fp-regs
7210 @opindex mfp-reg
7211 @opindex mno-fp-regs
7212 Generate code that uses (does not use) the floating-point register set.
7213 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7214 register set is not used, floating point operands are passed in integer
7215 registers as if they were integers and floating-point results are passed
7216 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7217 so any function with a floating-point argument or return value called by code
7218 compiled with @option{-mno-fp-regs} must also be compiled with that
7219 option.
7220
7221 A typical use of this option is building a kernel that does not use,
7222 and hence need not save and restore, any floating-point registers.
7223
7224 @item -mieee
7225 @opindex mieee
7226 The Alpha architecture implements floating-point hardware optimized for
7227 maximum performance.  It is mostly compliant with the IEEE floating
7228 point standard.  However, for full compliance, software assistance is
7229 required.  This option generates code fully IEEE compliant code
7230 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7231 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7232 defined during compilation.  The resulting code is less efficient but is
7233 able to correctly support denormalized numbers and exceptional IEEE
7234 values such as not-a-number and plus/minus infinity.  Other Alpha
7235 compilers call this option @option{-ieee_with_no_inexact}.
7236
7237 @item -mieee-with-inexact
7238 @opindex mieee-with-inexact
7239 This is like @option{-mieee} except the generated code also maintains
7240 the IEEE @var{inexact-flag}.  Turning on this option causes the
7241 generated code to implement fully-compliant IEEE math.  In addition to
7242 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7243 macro.  On some Alpha implementations the resulting code may execute
7244 significantly slower than the code generated by default.  Since there is
7245 very little code that depends on the @var{inexact-flag}, you should
7246 normally not specify this option.  Other Alpha compilers call this
7247 option @option{-ieee_with_inexact}.
7248
7249 @item -mfp-trap-mode=@var{trap-mode}
7250 @opindex mfp-trap-mode
7251 This option controls what floating-point related traps are enabled.
7252 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7253 The trap mode can be set to one of four values:
7254
7255 @table @samp
7256 @item n
7257 This is the default (normal) setting.  The only traps that are enabled
7258 are the ones that cannot be disabled in software (e.g., division by zero
7259 trap).
7260
7261 @item u
7262 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7263 as well.
7264
7265 @item su
7266 Like @samp{su}, but the instructions are marked to be safe for software
7267 completion (see Alpha architecture manual for details).
7268
7269 @item sui
7270 Like @samp{su}, but inexact traps are enabled as well.
7271 @end table
7272
7273 @item -mfp-rounding-mode=@var{rounding-mode}
7274 @opindex mfp-rounding-mode
7275 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7276 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7277 of:
7278
7279 @table @samp
7280 @item n
7281 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7282 the nearest machine number or towards the even machine number in case
7283 of a tie.
7284
7285 @item m
7286 Round towards minus infinity.
7287
7288 @item c
7289 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7290
7291 @item d
7292 Dynamic rounding mode.  A field in the floating point control register
7293 (@var{fpcr}, see Alpha architecture reference manual) controls the
7294 rounding mode in effect.  The C library initializes this register for
7295 rounding towards plus infinity.  Thus, unless your program modifies the
7296 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7297 @end table
7298
7299 @item -mtrap-precision=@var{trap-precision}
7300 @opindex mtrap-precision
7301 In the Alpha architecture, floating point traps are imprecise.  This
7302 means without software assistance it is impossible to recover from a
7303 floating trap and program execution normally needs to be terminated.
7304 GCC can generate code that can assist operating system trap handlers
7305 in determining the exact location that caused a floating point trap.
7306 Depending on the requirements of an application, different levels of
7307 precisions can be selected:
7308
7309 @table @samp
7310 @item p
7311 Program precision.  This option is the default and means a trap handler
7312 can only identify which program caused a floating point exception.
7313
7314 @item f
7315 Function precision.  The trap handler can determine the function that
7316 caused a floating point exception.
7317
7318 @item i
7319 Instruction precision.  The trap handler can determine the exact
7320 instruction that caused a floating point exception.
7321 @end table
7322
7323 Other Alpha compilers provide the equivalent options called
7324 @option{-scope_safe} and @option{-resumption_safe}.
7325
7326 @item -mieee-conformant
7327 @opindex mieee-conformant
7328 This option marks the generated code as IEEE conformant.  You must not
7329 use this option unless you also specify @option{-mtrap-precision=i} and either
7330 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7331 is to emit the line @samp{.eflag 48} in the function prologue of the
7332 generated assembly file.  Under DEC Unix, this has the effect that
7333 IEEE-conformant math library routines will be linked in.
7334
7335 @item -mbuild-constants
7336 @opindex mbuild-constants
7337 Normally GCC examines a 32- or 64-bit integer constant to
7338 see if it can construct it from smaller constants in two or three
7339 instructions.  If it cannot, it will output the constant as a literal and
7340 generate code to load it from the data segment at runtime.
7341
7342 Use this option to require GCC to construct @emph{all} integer constants
7343 using code, even if it takes more instructions (the maximum is six).
7344
7345 You would typically use this option to build a shared library dynamic
7346 loader.  Itself a shared library, it must relocate itself in memory
7347 before it can find the variables and constants in its own data segment.
7348
7349 @item -malpha-as
7350 @itemx -mgas
7351 @opindex malpha-as
7352 @opindex mgas
7353 Select whether to generate code to be assembled by the vendor-supplied
7354 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7355
7356 @item -mbwx
7357 @itemx -mno-bwx
7358 @itemx -mcix
7359 @itemx -mno-cix
7360 @itemx -mfix
7361 @itemx -mno-fix
7362 @itemx -mmax
7363 @itemx -mno-max
7364 @opindex mbwx
7365 @opindex mno-bwx
7366 @opindex mcix
7367 @opindex mno-cix
7368 @opindex mfix
7369 @opindex mno-fix
7370 @opindex mmax
7371 @opindex mno-max
7372 Indicate whether GCC should generate code to use the optional BWX,
7373 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7374 sets supported by the CPU type specified via @option{-mcpu=} option or that
7375 of the CPU on which GCC was built if none was specified.
7376
7377 @item -mfloat-vax
7378 @itemx -mfloat-ieee
7379 @opindex mfloat-vax
7380 @opindex mfloat-ieee
7381 Generate code that uses (does not use) VAX F and G floating point
7382 arithmetic instead of IEEE single and double precision.
7383
7384 @item -mexplicit-relocs
7385 @itemx -mno-explicit-relocs
7386 @opindex mexplicit-relocs
7387 @opindex mno-explicit-relocs
7388 Older Alpha assemblers provided no way to generate symbol relocations
7389 except via assembler macros.  Use of these macros does not allow
7390 optimal instruction scheduling.  GNU binutils as of version 2.12
7391 supports a new syntax that allows the compiler to explicitly mark
7392 which relocations should apply to which instructions.  This option
7393 is mostly useful for debugging, as GCC detects the capabilities of
7394 the assembler when it is built and sets the default accordingly.
7395
7396 @item -msmall-data
7397 @itemx -mlarge-data
7398 @opindex msmall-data
7399 @opindex mlarge-data
7400 When @option{-mexplicit-relocs} is in effect, static data is
7401 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7402 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7403 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7404 16-bit relocations off of the @code{$gp} register.  This limits the
7405 size of the small data area to 64KB, but allows the variables to be
7406 directly accessed via a single instruction.
7407
7408 The default is @option{-mlarge-data}.  With this option the data area
7409 is limited to just below 2GB.  Programs that require more than 2GB of
7410 data must use @code{malloc} or @code{mmap} to allocate the data in the
7411 heap instead of in the program's data segment.
7412
7413 When generating code for shared libraries, @option{-fpic} implies
7414 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7415
7416 @item -msmall-text
7417 @itemx -mlarge-text
7418 @opindex msmall-text
7419 @opindex mlarge-text
7420 When @option{-msmall-text} is used, the compiler assumes that the
7421 code of the entire program (or shared library) fits in 4MB, and is
7422 thus reachable with a branch instruction.  When @option{-msmall-data}
7423 is used, the compiler can assume that all local symbols share the
7424 same @code{$gp} value, and thus reduce the number of instructions
7425 required for a function call from 4 to 1.
7426
7427 The default is @option{-mlarge-text}.
7428
7429 @item -mcpu=@var{cpu_type}
7430 @opindex mcpu
7431 Set the instruction set and instruction scheduling parameters for
7432 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7433 style name or the corresponding chip number.  GCC supports scheduling
7434 parameters for the EV4, EV5 and EV6 family of processors and will
7435 choose the default values for the instruction set from the processor
7436 you specify.  If you do not specify a processor type, GCC will default
7437 to the processor on which the compiler was built.
7438
7439 Supported values for @var{cpu_type} are
7440
7441 @table @samp
7442 @item ev4
7443 @itemx ev45
7444 @itemx 21064
7445 Schedules as an EV4 and has no instruction set extensions.
7446
7447 @item ev5
7448 @itemx 21164
7449 Schedules as an EV5 and has no instruction set extensions.
7450
7451 @item ev56
7452 @itemx 21164a
7453 Schedules as an EV5 and supports the BWX extension.
7454
7455 @item pca56
7456 @itemx 21164pc
7457 @itemx 21164PC
7458 Schedules as an EV5 and supports the BWX and MAX extensions.
7459
7460 @item ev6
7461 @itemx 21264
7462 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7463
7464 @item ev67
7465 @itemx 21264a
7466 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7467 @end table
7468
7469 @item -mtune=@var{cpu_type}
7470 @opindex mtune
7471 Set only the instruction scheduling parameters for machine type
7472 @var{cpu_type}.  The instruction set is not changed.
7473
7474 @item -mmemory-latency=@var{time}
7475 @opindex mmemory-latency
7476 Sets the latency the scheduler should assume for typical memory
7477 references as seen by the application.  This number is highly
7478 dependent on the memory access patterns used by the application
7479 and the size of the external cache on the machine.
7480
7481 Valid options for @var{time} are
7482
7483 @table @samp
7484 @item @var{number}
7485 A decimal number representing clock cycles.
7486
7487 @item L1
7488 @itemx L2
7489 @itemx L3
7490 @itemx main
7491 The compiler contains estimates of the number of clock cycles for
7492 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7493 (also called Dcache, Scache, and Bcache), as well as to main memory.
7494 Note that L3 is only valid for EV5.
7495
7496 @end table
7497 @end table
7498
7499 @node DEC Alpha/VMS Options
7500 @subsection DEC Alpha/VMS Options
7501
7502 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7503
7504 @table @gcctabopt
7505 @item -mvms-return-codes
7506 @opindex mvms-return-codes
7507 Return VMS condition codes from main.  The default is to return POSIX
7508 style condition (e.g.@ error) codes.
7509 @end table
7510
7511 @node FRV Options
7512 @subsection FRV Options
7513 @cindex FRV Options
7514
7515 @table @gcctabopt
7516 @item -mgpr-32
7517 @opindex mgpr-32
7518
7519 Only use the first 32 general purpose registers.
7520
7521 @item -mgpr-64
7522 @opindex mgpr-64
7523
7524 Use all 64 general purpose registers.
7525
7526 @item -mfpr-32
7527 @opindex mfpr-32
7528
7529 Use only the first 32 floating point registers.
7530
7531 @item -mfpr-64
7532 @opindex mfpr-64
7533
7534 Use all 64 floating point registers
7535
7536 @item -mhard-float
7537 @opindex mhard-float
7538
7539 Use hardware instructions for floating point operations.
7540
7541 @item -msoft-float
7542 @opindex msoft-float
7543
7544 Use library routines for floating point operations.
7545
7546 @item -malloc-cc
7547 @opindex malloc-cc
7548
7549 Dynamically allocate condition code registers.
7550
7551 @item -mfixed-cc
7552 @opindex mfixed-cc
7553
7554 Do not try to dynamically allocate condition code registers, only
7555 use @code{icc0} and @code{fcc0}.
7556
7557 @item -mdword
7558 @opindex mdword
7559
7560 Change ABI to use double word insns.
7561
7562 @item -mno-dword
7563 @opindex mno-dword
7564
7565 Do not use double word instructions.
7566
7567 @item -mdouble
7568 @opindex mdouble
7569
7570 Use floating point double instructions.
7571
7572 @item -mno-double
7573 @opindex mno-double
7574
7575 Do not use floating point double instructions.
7576
7577 @item -mmedia
7578 @opindex mmedia
7579
7580 Use media instructions.
7581
7582 @item -mno-media
7583 @opindex mno-media
7584
7585 Do not use media instructions.
7586
7587 @item -mmuladd
7588 @opindex mmuladd
7589
7590 Use multiply and add/subtract instructions.
7591
7592 @item -mno-muladd
7593 @opindex mno-muladd
7594
7595 Do not use multiply and add/subtract instructions.
7596
7597 @item -mlibrary-pic
7598 @opindex mlibrary-pic
7599
7600 Generate position-independent EABI code.
7601
7602 @item -macc-4
7603 @opindex macc-4
7604
7605 Use only the first four media accumulator registers.
7606
7607 @item -macc-8
7608 @opindex macc-8
7609
7610 Use all eight media accumulator registers.
7611
7612 @item -mpack
7613 @opindex mpack
7614
7615 Pack VLIW instructions.
7616
7617 @item -mno-pack
7618 @opindex mno-pack
7619
7620 Do not pack VLIW instructions.
7621
7622 @item -mno-eflags
7623 @opindex mno-eflags
7624
7625 Do not mark ABI switches in e_flags.
7626
7627 @item -mcond-move
7628 @opindex mcond-move
7629
7630 Enable the use of conditional-move instructions (default).
7631
7632 This switch is mainly for debugging the compiler and will likely be removed
7633 in a future version.
7634
7635 @item -mno-cond-move
7636 @opindex mno-cond-move
7637
7638 Disable the use of conditional-move instructions.
7639
7640 This switch is mainly for debugging the compiler and will likely be removed
7641 in a future version.
7642
7643 @item -mscc
7644 @opindex mscc
7645
7646 Enable the use of conditional set instructions (default).
7647
7648 This switch is mainly for debugging the compiler and will likely be removed
7649 in a future version.
7650
7651 @item -mno-scc
7652 @opindex mno-scc
7653
7654 Disable the use of conditional set instructions.
7655
7656 This switch is mainly for debugging the compiler and will likely be removed
7657 in a future version.
7658
7659 @item -mcond-exec
7660 @opindex mcond-exec
7661
7662 Enable the use of conditional execution (default).
7663
7664 This switch is mainly for debugging the compiler and will likely be removed
7665 in a future version.
7666
7667 @item -mno-cond-exec
7668 @opindex mno-cond-exec
7669
7670 Disable the use of conditional execution.
7671
7672 This switch is mainly for debugging the compiler and will likely be removed
7673 in a future version.
7674
7675 @item -mvliw-branch
7676 @opindex mvliw-branch
7677
7678 Run a pass to pack branches into VLIW instructions (default).
7679
7680 This switch is mainly for debugging the compiler and will likely be removed
7681 in a future version.
7682
7683 @item -mno-vliw-branch
7684 @opindex mno-vliw-branch
7685
7686 Do not run a pass to pack branches into VLIW instructions.
7687
7688 This switch is mainly for debugging the compiler and will likely be removed
7689 in a future version.
7690
7691 @item -mmulti-cond-exec
7692 @opindex mmulti-cond-exec
7693
7694 Enable optimization of @code{&&} and @code{||} in conditional execution
7695 (default).
7696
7697 This switch is mainly for debugging the compiler and will likely be removed
7698 in a future version.
7699
7700 @item -mno-multi-cond-exec
7701 @opindex mno-multi-cond-exec
7702
7703 Disable optimization of @code{&&} and @code{||} in conditional execution.
7704
7705 This switch is mainly for debugging the compiler and will likely be removed
7706 in a future version.
7707
7708 @item -mnested-cond-exec
7709 @opindex mnested-cond-exec
7710
7711 Enable nested conditional execution optimizations (default).
7712
7713 This switch is mainly for debugging the compiler and will likely be removed
7714 in a future version.
7715
7716 @item -mno-nested-cond-exec
7717 @opindex mno-nested-cond-exec
7718
7719 Disable nested conditional execution optimizations.
7720
7721 This switch is mainly for debugging the compiler and will likely be removed
7722 in a future version.
7723
7724 @item -mtomcat-stats
7725 @opindex mtomcat-stats
7726
7727 Cause gas to print out tomcat statistics.
7728
7729 @item -mcpu=@var{cpu}
7730 @opindex mcpu
7731
7732 Select the processor type for which to generate code.  Possible values are
7733 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
7734 @samp{frv}.
7735
7736 @end table
7737
7738 @node H8/300 Options
7739 @subsection H8/300 Options
7740
7741 These @samp{-m} options are defined for the H8/300 implementations:
7742
7743 @table @gcctabopt
7744 @item -mrelax
7745 @opindex mrelax
7746 Shorten some address references at link time, when possible; uses the
7747 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7748 ld, Using ld}, for a fuller description.
7749
7750 @item -mh
7751 @opindex mh
7752 Generate code for the H8/300H@.
7753
7754 @item -ms
7755 @opindex ms
7756 Generate code for the H8S@.
7757
7758 @item -mn
7759 @opindex mn
7760 Generate code for the H8S and H8/300H in the normal mode.  This switch
7761 must be used either with -mh or -ms.
7762
7763 @item -ms2600
7764 @opindex ms2600
7765 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
7766
7767 @item -mint32
7768 @opindex mint32
7769 Make @code{int} data 32 bits by default.
7770
7771 @item -malign-300
7772 @opindex malign-300
7773 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
7774 The default for the H8/300H and H8S is to align longs and floats on 4
7775 byte boundaries.
7776 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
7777 This option has no effect on the H8/300.
7778 @end table
7779
7780 @node HPPA Options
7781 @subsection HPPA Options
7782 @cindex HPPA Options
7783
7784 These @samp{-m} options are defined for the HPPA family of computers:
7785
7786 @table @gcctabopt
7787 @item -march=@var{architecture-type}
7788 @opindex march
7789 Generate code for the specified architecture.  The choices for
7790 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7791 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7792 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7793 architecture option for your machine.  Code compiled for lower numbered
7794 architectures will run on higher numbered architectures, but not the
7795 other way around.
7796
7797 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
7798 next release of binutils (current is 2.9.1) will probably contain PA 2.0
7799 support.
7800
7801 @item -mpa-risc-1-0
7802 @itemx -mpa-risc-1-1
7803 @itemx -mpa-risc-2-0
7804 @opindex mpa-risc-1-0
7805 @opindex mpa-risc-1-1
7806 @opindex mpa-risc-2-0
7807 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7808
7809 @item -mbig-switch
7810 @opindex mbig-switch
7811 Generate code suitable for big switch tables.  Use this option only if
7812 the assembler/linker complain about out of range branches within a switch
7813 table.
7814
7815 @item -mjump-in-delay
7816 @opindex mjump-in-delay
7817 Fill delay slots of function calls with unconditional jump instructions
7818 by modifying the return pointer for the function call to be the target
7819 of the conditional jump.
7820
7821 @item -mdisable-fpregs
7822 @opindex mdisable-fpregs
7823 Prevent floating point registers from being used in any manner.  This is
7824 necessary for compiling kernels which perform lazy context switching of
7825 floating point registers.  If you use this option and attempt to perform
7826 floating point operations, the compiler will abort.
7827
7828 @item -mdisable-indexing
7829 @opindex mdisable-indexing
7830 Prevent the compiler from using indexing address modes.  This avoids some
7831 rather obscure problems when compiling MIG generated code under MACH@.
7832
7833 @item -mno-space-regs
7834 @opindex mno-space-regs
7835 Generate code that assumes the target has no space registers.  This allows
7836 GCC to generate faster indirect calls and use unscaled index address modes.
7837
7838 Such code is suitable for level 0 PA systems and kernels.
7839
7840 @item -mfast-indirect-calls
7841 @opindex mfast-indirect-calls
7842 Generate code that assumes calls never cross space boundaries.  This
7843 allows GCC to emit code which performs faster indirect calls.
7844
7845 This option will not work in the presence of shared libraries or nested
7846 functions.
7847
7848 @item -mfixed-range=@var{register-range}
7849 @opindex mfixed-range
7850 Generate code treating the given register range as fixed registers.
7851 A fixed register is one that the register allocator can not use.  This is
7852 useful when compiling kernel code.  A register range is specified as
7853 two registers separated by a dash.  Multiple register ranges can be
7854 specified separated by a comma.
7855
7856 @item -mlong-load-store
7857 @opindex mlong-load-store
7858 Generate 3-instruction load and store sequences as sometimes required by
7859 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7860 the HP compilers.
7861
7862 @item -mportable-runtime
7863 @opindex mportable-runtime
7864 Use the portable calling conventions proposed by HP for ELF systems.
7865
7866 @item -mgas
7867 @opindex mgas
7868 Enable the use of assembler directives only GAS understands.
7869
7870 @item -mschedule=@var{cpu-type}
7871 @opindex mschedule
7872 Schedule code according to the constraints for the machine type
7873 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7874 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
7875 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7876 proper scheduling option for your machine.  The default scheduling is
7877 @samp{8000}.
7878
7879 @item -mlinker-opt
7880 @opindex mlinker-opt
7881 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
7882 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
7883 linkers in which they give bogus error messages when linking some programs.
7884
7885 @item -msoft-float
7886 @opindex msoft-float
7887 Generate output containing library calls for floating point.
7888 @strong{Warning:} the requisite libraries are not available for all HPPA
7889 targets.  Normally the facilities of the machine's usual C compiler are
7890 used, but this cannot be done directly in cross-compilation.  You must make
7891 your own arrangements to provide suitable library functions for
7892 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7893 does provide software floating point support.
7894
7895 @option{-msoft-float} changes the calling convention in the output file;
7896 therefore, it is only useful if you compile @emph{all} of a program with
7897 this option.  In particular, you need to compile @file{libgcc.a}, the
7898 library that comes with GCC, with @option{-msoft-float} in order for
7899 this to work.
7900
7901 @item -msio
7902 @opindex msio
7903 Generate the predefine, @code{_SIO}, for server IO.  The default is
7904 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
7905 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
7906 options are available under HP-UX and HI-UX.
7907
7908 @item -mgnu-ld
7909 @opindex gnu-ld
7910 Use GNU ld specific options.  This passes @option{-shared} to ld when
7911 building a shared library.  It is the default when GCC is configured,
7912 explicitly or implicitly, with the GNU linker.  This option does not
7913 have any affect on which ld is called, it only changes what parameters
7914 are passed to that ld.  The ld that is called is determined by the
7915 @option{--with-ld} configure option, GCC's program search path, and
7916 finally by the user's @env{PATH}.  The linker used by GCC can be printed
7917 using @samp{which `gcc -print-prog-name=ld`}.
7918
7919 @item -mhp-ld
7920 @opindex hp-ld
7921 Use HP ld specific options.  This passes @option{-b} to ld when building
7922 a shared library and passes @option{+Accept TypeMismatch} to ld on all
7923 links.  It is the default when GCC is configured, explicitly or
7924 implicitly, with the HP linker.  This option does not have any affect on
7925 which ld is called, it only changes what parameters are passed to that
7926 ld.  The ld that is called is determined by the @option{--with-ld}
7927 configure option, GCC's program search path, and finally by the user's
7928 @env{PATH}.  The linker used by GCC can be printed using @samp{which
7929 `gcc -print-prog-name=ld`}.
7930
7931 @item -mfdpic
7932 @opindex mfdpic
7933
7934 Select the FDPIC ABI, that uses function descriptors to represent
7935 pointers to functions.  Without any PIC/PIE-related options, it
7936 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7937 assumes GOT entries and small data are within a 12-bit range from the
7938 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7939 are computed with 32 bits.
7940
7941 @item -minline-plt
7942 @opindex minline-plt
7943
7944 Enable inlining of PLT entries in function calls to functions that are
7945 not known to bind locally.  It has no effect without @option{-mfdpic}.
7946 It's enabled by default if optimizing for speed and compiling for
7947 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7948 optimization option such as @option{-O3} or above is present in the
7949 command line.
7950
7951 @item -mgprel-ro
7952 @opindex mgprel-ro
7953
7954 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7955 that is known to be in read-only sections.  It's enabled by default,
7956 except for @option{-fpic} or @option{-fpie}: even though it may help
7957 make the global offset table smaller, it trades 1 instruction for 4.
7958 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7959 one of which may be shared by multiple symbols, and it avoids the need
7960 for a GOT entry for the referenced symbol, so it's more likely to be a
7961 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7962
7963 @item -multilib-library-pic
7964 @opindex multilib-library-pic
7965
7966 Link with the (library, not FD) pic libraries.  It's implied by
7967 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7968 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7969 it explicitly.
7970
7971 @item -mlinked-fp
7972 @opindex mlinked-fp
7973
7974 Follow the EABI requirement of always creating a frame pointer whenever
7975 a stack frame is allocated.  This option is enabled by default and can
7976 be disabled with @option{-mno-linked-fp}.
7977
7978 @item -mlong-calls
7979 @opindex mno-long-calls
7980 Generate code that uses long call sequences.  This ensures that a call
7981 is always able to reach linker generated stubs.  The default is to generate
7982 long calls only when the distance from the call site to the beginning
7983 of the function or translation unit, as the case may be, exceeds a
7984 predefined limit set by the branch type being used.  The limits for
7985 normal calls are 7,600,000 and 240,000 bytes, respectively for the
7986 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
7987 240,000 bytes.
7988
7989 Distances are measured from the beginning of functions when using the
7990 @option{-ffunction-sections} option, or when using the @option{-mgas}
7991 and @option{-mno-portable-runtime} options together under HP-UX with
7992 the SOM linker.
7993
7994 It is normally not desirable to use this option as it will degrade
7995 performance.  However, it may be useful in large applications,
7996 particularly when partial linking is used to build the application.
7997
7998 The types of long calls used depends on the capabilities of the
7999 assembler and linker, and the type of code being generated.  The
8000 impact on systems that support long absolute calls, and long pic
8001 symbol-difference or pc-relative calls should be relatively small.
8002 However, an indirect call is used on 32-bit ELF systems in pic code
8003 and it is quite long.
8004
8005 @item -nolibdld
8006 @opindex nolibdld
8007 Suppress the generation of link options to search libdld.sl when the
8008 @option{-static} option is specified on HP-UX 10 and later.
8009
8010 @item -static
8011 @opindex static
8012 The HP-UX implementation of setlocale in libc has a dependency on
8013 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8014 when the @option{-static} option is specified, special link options
8015 are needed to resolve this dependency.
8016
8017 On HP-UX 10 and later, the GCC driver adds the necessary options to
8018 link with libdld.sl when the @option{-static} option is specified.
8019 This causes the resulting binary to be dynamic.  On the 64-bit port,
8020 the linkers generate dynamic binaries by default in any case.  The
8021 @option{-nolibdld} option can be used to prevent the GCC driver from
8022 adding these link options.
8023
8024 @item -threads
8025 @opindex threads
8026 Add support for multithreading with the @dfn{dce thread} library
8027 under HP-UX.  This option sets flags for both the preprocessor and
8028 linker.
8029 @end table
8030
8031 @node i386 and x86-64 Options
8032 @subsection Intel 386 and AMD x86-64 Options
8033 @cindex i386 Options
8034 @cindex x86-64 Options
8035 @cindex Intel 386 Options
8036 @cindex AMD x86-64 Options
8037
8038 These @samp{-m} options are defined for the i386 and x86-64 family of
8039 computers:
8040
8041 @table @gcctabopt
8042 @item -mtune=@var{cpu-type}
8043 @opindex mtune
8044 Tune to @var{cpu-type} everything applicable about the generated code, except
8045 for the ABI and the set of available instructions.  The choices for
8046 @var{cpu-type} are:
8047 @table @emph
8048 @item i386
8049 Original Intel's i386 CPU.
8050 @item i486
8051 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8052 @item i586, pentium
8053 Intel Pentium CPU with no MMX support.
8054 @item pentium-mmx
8055 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8056 @item i686, pentiumpro
8057 Intel PentiumPro CPU.
8058 @item pentium2
8059 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8060 @item pentium3, pentium3m
8061 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8062 support.
8063 @item pentium-m
8064 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8065 support.  Used by Centrino notebooks.
8066 @item pentium4, pentium4m
8067 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8068 @item prescott
8069 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8070 set support.
8071 @item nocona
8072 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8073 SSE2 and SSE3 instruction set support.
8074 @item k6
8075 AMD K6 CPU with MMX instruction set support.
8076 @item k6-2, k6-3
8077 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8078 @item athlon, athlon-tbird
8079 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8080 support.
8081 @item athlon-4, athlon-xp, athlon-mp
8082 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8083 instruction set support.
8084 @item k8, opteron, athlon64, athlon-fx
8085 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8086 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8087 @item winchip-c6
8088 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8089 set support.
8090 @item winchip2
8091 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8092 instruction set support.
8093 @item c3
8094 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8095 implemented for this chip.)
8096 @item c3-2
8097 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8098 implemented for this chip.)
8099 @end table
8100
8101 While picking a specific @var{cpu-type} will schedule things appropriately
8102 for that particular chip, the compiler will not generate any code that
8103 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8104 being used.
8105
8106 @item -march=@var{cpu-type}
8107 @opindex march
8108 Generate instructions for the machine type @var{cpu-type}.  The choices
8109 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8110 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8111
8112 @item -mcpu=@var{cpu-type}
8113 @opindex mcpu
8114 A deprecated synonym for @option{-mtune}.
8115
8116 @item -m386
8117 @itemx -m486
8118 @itemx -mpentium
8119 @itemx -mpentiumpro
8120 @opindex m386
8121 @opindex m486
8122 @opindex mpentium
8123 @opindex mpentiumpro
8124 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8125 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8126 These synonyms are deprecated.
8127
8128 @item -mfpmath=@var{unit}
8129 @opindex march
8130 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8131 for @var{unit} are:
8132
8133 @table @samp
8134 @item 387
8135 Use the standard 387 floating point coprocessor present majority of chips and
8136 emulated otherwise.  Code compiled with this option will run almost everywhere.
8137 The temporary results are computed in 80bit precision instead of precision
8138 specified by the type resulting in slightly different results compared to most
8139 of other chips. See @option{-ffloat-store} for more detailed description.
8140
8141 This is the default choice for i386 compiler.
8142
8143 @item sse
8144 Use scalar floating point instructions present in the SSE instruction set.
8145 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8146 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8147 instruction set supports only single precision arithmetics, thus the double and
8148 extended precision arithmetics is still done using 387.  Later version, present
8149 only in Pentium4 and the future AMD x86-64 chips supports double precision
8150 arithmetics too.
8151
8152 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8153 @option{-msse2} switches to enable SSE extensions and make this option
8154 effective.  For x86-64 compiler, these extensions are enabled by default.
8155
8156 The resulting code should be considerably faster in the majority of cases and avoid
8157 the numerical instability problems of 387 code, but may break some existing
8158 code that expects temporaries to be 80bit.
8159
8160 This is the default choice for the x86-64 compiler.
8161
8162 @item sse,387
8163 Attempt to utilize both instruction sets at once.  This effectively double the
8164 amount of available registers and on chips with separate execution units for
8165 387 and SSE the execution resources too.  Use this option with care, as it is
8166 still experimental, because the GCC register allocator does not model separate
8167 functional units well resulting in instable performance.
8168 @end table
8169
8170 @item -masm=@var{dialect}
8171 @opindex masm=@var{dialect}
8172 Output asm instructions using selected @var{dialect}. Supported choices are
8173 @samp{intel} or @samp{att} (the default one).
8174
8175 @item -mieee-fp
8176 @itemx -mno-ieee-fp
8177 @opindex mieee-fp
8178 @opindex mno-ieee-fp
8179 Control whether or not the compiler uses IEEE floating point
8180 comparisons.  These handle correctly the case where the result of a
8181 comparison is unordered.
8182
8183 @item -msoft-float
8184 @opindex msoft-float
8185 Generate output containing library calls for floating point.
8186 @strong{Warning:} the requisite libraries are not part of GCC@.
8187 Normally the facilities of the machine's usual C compiler are used, but
8188 this can't be done directly in cross-compilation.  You must make your
8189 own arrangements to provide suitable library functions for
8190 cross-compilation.
8191
8192 On machines where a function returns floating point results in the 80387
8193 register stack, some floating point opcodes may be emitted even if
8194 @option{-msoft-float} is used.
8195
8196 @item -mno-fp-ret-in-387
8197 @opindex mno-fp-ret-in-387
8198 Do not use the FPU registers for return values of functions.
8199
8200 The usual calling convention has functions return values of types
8201 @code{float} and @code{double} in an FPU register, even if there
8202 is no FPU@.  The idea is that the operating system should emulate
8203 an FPU@.
8204
8205 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8206 in ordinary CPU registers instead.
8207
8208 @item -mno-fancy-math-387
8209 @opindex mno-fancy-math-387
8210 Some 387 emulators do not support the @code{sin}, @code{cos} and
8211 @code{sqrt} instructions for the 387.  Specify this option to avoid
8212 generating those instructions.  This option is the default on FreeBSD,
8213 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8214 indicates that the target cpu will always have an FPU and so the
8215 instruction will not need emulation.  As of revision 2.6.1, these
8216 instructions are not generated unless you also use the
8217 @option{-funsafe-math-optimizations} switch.
8218
8219 @item -malign-double
8220 @itemx -mno-align-double
8221 @opindex malign-double
8222 @opindex mno-align-double
8223 Control whether GCC aligns @code{double}, @code{long double}, and
8224 @code{long long} variables on a two word boundary or a one word
8225 boundary.  Aligning @code{double} variables on a two word boundary will
8226 produce code that runs somewhat faster on a @samp{Pentium} at the
8227 expense of more memory.
8228
8229 @strong{Warning:} if you use the @option{-malign-double} switch,
8230 structures containing the above types will be aligned differently than
8231 the published application binary interface specifications for the 386
8232 and will not be binary compatible with structures in code compiled
8233 without that switch.
8234
8235 @item -m96bit-long-double
8236 @itemx -m128bit-long-double
8237 @opindex m96bit-long-double
8238 @opindex m128bit-long-double
8239 These switches control the size of @code{long double} type. The i386
8240 application binary interface specifies the size to be 96 bits,
8241 so @option{-m96bit-long-double} is the default in 32 bit mode.
8242
8243 Modern architectures (Pentium and newer) would prefer @code{long double}
8244 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8245 conforming to the ABI, this would not be possible.  So specifying a
8246 @option{-m128bit-long-double} will align @code{long double}
8247 to a 16 byte boundary by padding the @code{long double} with an additional
8248 32 bit zero.
8249
8250 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8251 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8252
8253 Notice that neither of these options enable any extra precision over the x87
8254 standard of 80 bits for a @code{long double}.
8255
8256 @strong{Warning:} if you override the default value for your target ABI, the
8257 structures and arrays containing @code{long double} variables will change
8258 their size as well as function calling convention for function taking
8259 @code{long double} will be modified.  Hence they will not be binary
8260 compatible with arrays or structures in code compiled without that switch.
8261
8262
8263 @item -msvr3-shlib
8264 @itemx -mno-svr3-shlib
8265 @opindex msvr3-shlib
8266 @opindex mno-svr3-shlib
8267 Control whether GCC places uninitialized local variables into the
8268 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8269 into @code{bss}.  These options are meaningful only on System V Release 3.
8270
8271 @item -mrtd
8272 @opindex mrtd
8273 Use a different function-calling convention, in which functions that
8274 take a fixed number of arguments return with the @code{ret} @var{num}
8275 instruction, which pops their arguments while returning.  This saves one
8276 instruction in the caller since there is no need to pop the arguments
8277 there.
8278
8279 You can specify that an individual function is called with this calling
8280 sequence with the function attribute @samp{stdcall}.  You can also
8281 override the @option{-mrtd} option by using the function attribute
8282 @samp{cdecl}.  @xref{Function Attributes}.
8283
8284 @strong{Warning:} this calling convention is incompatible with the one
8285 normally used on Unix, so you cannot use it if you need to call
8286 libraries compiled with the Unix compiler.
8287
8288 Also, you must provide function prototypes for all functions that
8289 take variable numbers of arguments (including @code{printf});
8290 otherwise incorrect code will be generated for calls to those
8291 functions.
8292
8293 In addition, seriously incorrect code will result if you call a
8294 function with too many arguments.  (Normally, extra arguments are
8295 harmlessly ignored.)
8296
8297 @item -mregparm=@var{num}
8298 @opindex mregparm
8299 Control how many registers are used to pass integer arguments.  By
8300 default, no registers are used to pass arguments, and at most 3
8301 registers can be used.  You can control this behavior for a specific
8302 function by using the function attribute @samp{regparm}.
8303 @xref{Function Attributes}.
8304
8305 @strong{Warning:} if you use this switch, and
8306 @var{num} is nonzero, then you must build all modules with the same
8307 value, including any libraries.  This includes the system libraries and
8308 startup modules.
8309
8310 @item -mpreferred-stack-boundary=@var{num}
8311 @opindex mpreferred-stack-boundary
8312 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8313 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8314 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8315 size (@option{-Os}), in which case the default is the minimum correct
8316 alignment (4 bytes for x86, and 8 bytes for x86-64).
8317
8318 On Pentium and PentiumPro, @code{double} and @code{long double} values
8319 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8320 suffer significant run time performance penalties.  On Pentium III, the
8321 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8322 penalties if it is not 16 byte aligned.
8323
8324 To ensure proper alignment of this values on the stack, the stack boundary
8325 must be as aligned as that required by any value stored on the stack.
8326 Further, every function must be generated such that it keeps the stack
8327 aligned.  Thus calling a function compiled with a higher preferred
8328 stack boundary from a function compiled with a lower preferred stack
8329 boundary will most likely misalign the stack.  It is recommended that
8330 libraries that use callbacks always use the default setting.
8331
8332 This extra alignment does consume extra stack space, and generally
8333 increases code size.  Code that is sensitive to stack space usage, such
8334 as embedded systems and operating system kernels, may want to reduce the
8335 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8336
8337 @item -mmmx
8338 @itemx -mno-mmx
8339 @item -msse
8340 @itemx -mno-sse
8341 @item -msse2
8342 @itemx -mno-sse2
8343 @item -msse3
8344 @itemx -mno-sse3
8345 @item -m3dnow
8346 @itemx -mno-3dnow
8347 @opindex mmmx
8348 @opindex mno-mmx
8349 @opindex msse
8350 @opindex mno-sse
8351 @opindex m3dnow
8352 @opindex mno-3dnow
8353 These switches enable or disable the use of built-in functions that allow
8354 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8355 instruction set.
8356
8357 @xref{X86 Built-in Functions}, for details of the functions enabled
8358 and disabled by these switches.
8359
8360 To have SSE/SSE2 instructions generated automatically from floating-point
8361 code, see @option{-mfpmath=sse}.
8362
8363 @item -mpush-args
8364 @itemx -mno-push-args
8365 @opindex mpush-args
8366 @opindex mno-push-args
8367 Use PUSH operations to store outgoing parameters.  This method is shorter
8368 and usually equally fast as method using SUB/MOV operations and is enabled
8369 by default.  In some cases disabling it may improve performance because of
8370 improved scheduling and reduced dependencies.
8371
8372 @item -maccumulate-outgoing-args
8373 @opindex maccumulate-outgoing-args
8374 If enabled, the maximum amount of space required for outgoing arguments will be
8375 computed in the function prologue.  This is faster on most modern CPUs
8376 because of reduced dependencies, improved scheduling and reduced stack usage
8377 when preferred stack boundary is not equal to 2.  The drawback is a notable
8378 increase in code size.  This switch implies @option{-mno-push-args}.
8379
8380 @item -mthreads
8381 @opindex mthreads
8382 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8383 on thread-safe exception handling must compile and link all code with the
8384 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8385 @option{-D_MT}; when linking, it links in a special thread helper library
8386 @option{-lmingwthrd} which cleans up per thread exception handling data.
8387
8388 @item -mno-align-stringops
8389 @opindex mno-align-stringops
8390 Do not align destination of inlined string operations.  This switch reduces
8391 code size and improves performance in case the destination is already aligned,
8392 but GCC doesn't know about it.
8393
8394 @item -minline-all-stringops
8395 @opindex minline-all-stringops
8396 By default GCC inlines string operations only when destination is known to be
8397 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8398 size, but may improve performance of code that depends on fast memcpy, strlen
8399 and memset for short lengths.
8400
8401 @item -momit-leaf-frame-pointer
8402 @opindex momit-leaf-frame-pointer
8403 Don't keep the frame pointer in a register for leaf functions.  This
8404 avoids the instructions to save, set up and restore frame pointers and
8405 makes an extra register available in leaf functions.  The option
8406 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8407 which might make debugging harder.
8408
8409 @item -mtls-direct-seg-refs
8410 @itemx -mno-tls-direct-seg-refs
8411 @opindex mtls-direct-seg-refs
8412 Controls whether TLS variables may be accessed with offsets from the
8413 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8414 or whether the thread base pointer must be added.  Whether or not this
8415 is legal depends on the operating system, and whether it maps the
8416 segment to cover the entire TLS area.
8417
8418 For systems that use GNU libc, the default is on.
8419 @end table
8420
8421 These @samp{-m} switches are supported in addition to the above
8422 on AMD x86-64 processors in 64-bit environments.
8423
8424 @table @gcctabopt
8425 @item -m32
8426 @itemx -m64
8427 @opindex m32
8428 @opindex m64
8429 Generate code for a 32-bit or 64-bit environment.
8430 The 32-bit environment sets int, long and pointer to 32 bits and
8431 generates code that runs on any i386 system.
8432 The 64-bit environment sets int to 32 bits and long and pointer
8433 to 64 bits and generates code for AMD's x86-64 architecture.
8434
8435 @item -mno-red-zone
8436 @opindex no-red-zone
8437 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8438 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8439 stack pointer that will not be modified by signal or interrupt handlers
8440 and therefore can be used for temporary data without adjusting the stack
8441 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8442
8443 @item -mcmodel=small
8444 @opindex mcmodel=small
8445 Generate code for the small code model: the program and its symbols must
8446 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8447 Programs can be statically or dynamically linked.  This is the default
8448 code model.
8449
8450 @item -mcmodel=kernel
8451 @opindex mcmodel=kernel
8452 Generate code for the kernel code model.  The kernel runs in the
8453 negative 2 GB of the address space.
8454 This model has to be used for Linux kernel code.
8455
8456 @item -mcmodel=medium
8457 @opindex mcmodel=medium
8458 Generate code for the medium model: The program is linked in the lower 2
8459 GB of the address space but symbols can be located anywhere in the
8460 address space.  Programs can be statically or dynamically linked, but
8461 building of shared libraries are not supported with the medium model.
8462
8463 @item -mcmodel=large
8464 @opindex mcmodel=large
8465 Generate code for the large model: This model makes no assumptions
8466 about addresses and sizes of sections.  Currently GCC does not implement
8467 this model.
8468 @end table
8469
8470 @node IA-64 Options
8471 @subsection IA-64 Options
8472 @cindex IA-64 Options
8473
8474 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8475
8476 @table @gcctabopt
8477 @item -mbig-endian
8478 @opindex mbig-endian
8479 Generate code for a big endian target.  This is the default for HP-UX@.
8480
8481 @item -mlittle-endian
8482 @opindex mlittle-endian
8483 Generate code for a little endian target.  This is the default for AIX5
8484 and GNU/Linux.
8485
8486 @item -mgnu-as
8487 @itemx -mno-gnu-as
8488 @opindex mgnu-as
8489 @opindex mno-gnu-as
8490 Generate (or don't) code for the GNU assembler.  This is the default.
8491 @c Also, this is the default if the configure option @option{--with-gnu-as}
8492 @c is used.
8493
8494 @item -mgnu-ld
8495 @itemx -mno-gnu-ld
8496 @opindex mgnu-ld
8497 @opindex mno-gnu-ld
8498 Generate (or don't) code for the GNU linker.  This is the default.
8499 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8500 @c is used.
8501
8502 @item -mno-pic
8503 @opindex mno-pic
8504 Generate code that does not use a global pointer register.  The result
8505 is not position independent code, and violates the IA-64 ABI@.
8506
8507 @item -mvolatile-asm-stop
8508 @itemx -mno-volatile-asm-stop
8509 @opindex mvolatile-asm-stop
8510 @opindex mno-volatile-asm-stop
8511 Generate (or don't) a stop bit immediately before and after volatile asm
8512 statements.
8513
8514 @item -mb-step
8515 @opindex mb-step
8516 Generate code that works around Itanium B step errata.
8517
8518 @item -mregister-names
8519 @itemx -mno-register-names
8520 @opindex mregister-names
8521 @opindex mno-register-names
8522 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8523 the stacked registers.  This may make assembler output more readable.
8524
8525 @item -mno-sdata
8526 @itemx -msdata
8527 @opindex mno-sdata
8528 @opindex msdata
8529 Disable (or enable) optimizations that use the small data section.  This may
8530 be useful for working around optimizer bugs.
8531
8532 @item -mconstant-gp
8533 @opindex mconstant-gp
8534 Generate code that uses a single constant global pointer value.  This is
8535 useful when compiling kernel code.
8536
8537 @item -mauto-pic
8538 @opindex mauto-pic
8539 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8540 This is useful when compiling firmware code.
8541
8542 @item -minline-float-divide-min-latency
8543 @opindex minline-float-divide-min-latency
8544 Generate code for inline divides of floating point values
8545 using the minimum latency algorithm.
8546
8547 @item -minline-float-divide-max-throughput
8548 @opindex minline-float-divide-max-throughput
8549 Generate code for inline divides of floating point values
8550 using the maximum throughput algorithm.
8551
8552 @item -minline-int-divide-min-latency
8553 @opindex minline-int-divide-min-latency
8554 Generate code for inline divides of integer values
8555 using the minimum latency algorithm.
8556
8557 @item -minline-int-divide-max-throughput
8558 @opindex minline-int-divide-max-throughput
8559 Generate code for inline divides of integer values
8560 using the maximum throughput algorithm.
8561
8562 @item -mno-dwarf2-asm
8563 @itemx -mdwarf2-asm
8564 @opindex mno-dwarf2-asm
8565 @opindex mdwarf2-asm
8566 Don't (or do) generate assembler code for the DWARF2 line number debugging
8567 info.  This may be useful when not using the GNU assembler.
8568
8569 @item -mfixed-range=@var{register-range}
8570 @opindex mfixed-range
8571 Generate code treating the given register range as fixed registers.
8572 A fixed register is one that the register allocator can not use.  This is
8573 useful when compiling kernel code.  A register range is specified as
8574 two registers separated by a dash.  Multiple register ranges can be
8575 specified separated by a comma.
8576
8577 @item -mearly-stop-bits
8578 @itemx -mno-early-stop-bits
8579 @opindex mearly-stop-bits
8580 @opindex mno-early-stop-bits
8581 Allow stop bits to be placed earlier than immediately preceding the
8582 instruction that triggered the stop bit.  This can improve instruction
8583 scheduling, but does not always do so.
8584 @end table
8585
8586 @node M32R/D Options
8587 @subsection M32R/D Options
8588 @cindex M32R/D options
8589
8590 These @option{-m} options are defined for Renesas M32R/D architectures:
8591
8592 @table @gcctabopt
8593 @item -m32r2
8594 @opindex m32r2
8595 Generate code for the M32R/2@.
8596
8597 @item -m32rx
8598 @opindex m32rx
8599 Generate code for the M32R/X@.
8600
8601 @item -m32r
8602 @opindex m32r
8603 Generate code for the M32R@.  This is the default.
8604
8605 @item -mmodel=small
8606 @opindex mmodel=small
8607 Assume all objects live in the lower 16MB of memory (so that their addresses
8608 can be loaded with the @code{ld24} instruction), and assume all subroutines
8609 are reachable with the @code{bl} instruction.
8610 This is the default.
8611
8612 The addressability of a particular object can be set with the
8613 @code{model} attribute.
8614
8615 @item -mmodel=medium
8616 @opindex mmodel=medium
8617 Assume objects may be anywhere in the 32-bit address space (the compiler
8618 will generate @code{seth/add3} instructions to load their addresses), and
8619 assume all subroutines are reachable with the @code{bl} instruction.
8620
8621 @item -mmodel=large
8622 @opindex mmodel=large
8623 Assume objects may be anywhere in the 32-bit address space (the compiler
8624 will generate @code{seth/add3} instructions to load their addresses), and
8625 assume subroutines may not be reachable with the @code{bl} instruction
8626 (the compiler will generate the much slower @code{seth/add3/jl}
8627 instruction sequence).
8628
8629 @item -msdata=none
8630 @opindex msdata=none
8631 Disable use of the small data area.  Variables will be put into
8632 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8633 @code{section} attribute has been specified).
8634 This is the default.
8635
8636 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8637 Objects may be explicitly put in the small data area with the
8638 @code{section} attribute using one of these sections.
8639
8640 @item -msdata=sdata
8641 @opindex msdata=sdata
8642 Put small global and static data in the small data area, but do not
8643 generate special code to reference them.
8644
8645 @item -msdata=use
8646 @opindex msdata=use
8647 Put small global and static data in the small data area, and generate
8648 special instructions to reference them.
8649
8650 @item -G @var{num}
8651 @opindex G
8652 @cindex smaller data references
8653 Put global and static objects less than or equal to @var{num} bytes
8654 into the small data or bss sections instead of the normal data or bss
8655 sections.  The default value of @var{num} is 8.
8656 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8657 for this option to have any effect.
8658
8659 All modules should be compiled with the same @option{-G @var{num}} value.
8660 Compiling with different values of @var{num} may or may not work; if it
8661 doesn't the linker will give an error message---incorrect code will not be
8662 generated.
8663
8664 @item -mdebug
8665 @opindex mdebug
8666 Makes the M32R specific code in the compiler display some statistics
8667 that might help in debugging programs.
8668
8669 @item -malign-loops
8670 @opindex malign-loops
8671 Align all loops to a 32-byte boundary.
8672
8673 @item -mno-align-loops
8674 @opindex mno-align-loops
8675 Do not enforce a 32-byte alignment for loops.  This is the default.
8676
8677 @item -missue-rate=@var{number}
8678 @opindex missue-rate=@var{number}
8679 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8680 or 2.
8681
8682 @item -mbranch-cost=@var{number}
8683 @opindex mbranch-cost=@var{number}
8684 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8685 preferred over conditional code, if it is 2, then the opposite will
8686 apply.
8687
8688 @item -mflush-trap=@var{number}
8689 @opindex mflush-trap=@var{number}
8690 Specifies the trap number to use to flush the cache.  The default is
8691 12.  Valid numbers are between 0 and 15 inclusive.
8692
8693 @item -mno-flush-trap
8694 @opindex mno-flush-trap
8695 Specifies that the cache cannot be flushed by using a trap.
8696
8697 @item -mflush-func=@var{name}
8698 @opindex mflush-func=@var{name}
8699 Specifies the name of the operating system function to call to flush
8700 the cache.  The default is @emph{_flush_cache}, but a function call
8701 will only be used if a trap is not available.
8702
8703 @item -mno-flush-func
8704 @opindex mno-flush-func
8705 Indicates that there is no OS function for flushing the cache.
8706
8707 @end table
8708
8709 @node M680x0 Options
8710 @subsection M680x0 Options
8711 @cindex M680x0 options
8712
8713 These are the @samp{-m} options defined for the 68000 series.  The default
8714 values for these options depends on which style of 68000 was selected when
8715 the compiler was configured; the defaults for the most common choices are
8716 given below.
8717
8718 @table @gcctabopt
8719 @item -m68000
8720 @itemx -mc68000
8721 @opindex m68000
8722 @opindex mc68000
8723 Generate output for a 68000.  This is the default
8724 when the compiler is configured for 68000-based systems.
8725
8726 Use this option for microcontrollers with a 68000 or EC000 core,
8727 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8728
8729 @item -m68020
8730 @itemx -mc68020
8731 @opindex m68020
8732 @opindex mc68020
8733 Generate output for a 68020.  This is the default
8734 when the compiler is configured for 68020-based systems.
8735
8736 @item -m68881
8737 @opindex m68881
8738 Generate output containing 68881 instructions for floating point.
8739 This is the default for most 68020 systems unless @option{--nfp} was
8740 specified when the compiler was configured.
8741
8742 @item -m68030
8743 @opindex m68030
8744 Generate output for a 68030.  This is the default when the compiler is
8745 configured for 68030-based systems.
8746
8747 @item -m68040
8748 @opindex m68040
8749 Generate output for a 68040.  This is the default when the compiler is
8750 configured for 68040-based systems.
8751
8752 This option inhibits the use of 68881/68882 instructions that have to be
8753 emulated by software on the 68040.  Use this option if your 68040 does not
8754 have code to emulate those instructions.
8755
8756 @item -m68060
8757 @opindex m68060
8758 Generate output for a 68060.  This is the default when the compiler is
8759 configured for 68060-based systems.
8760
8761 This option inhibits the use of 68020 and 68881/68882 instructions that
8762 have to be emulated by software on the 68060.  Use this option if your 68060
8763 does not have code to emulate those instructions.
8764
8765 @item -mcpu32
8766 @opindex mcpu32
8767 Generate output for a CPU32.  This is the default
8768 when the compiler is configured for CPU32-based systems.
8769
8770 Use this option for microcontrollers with a
8771 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
8772 68336, 68340, 68341, 68349 and 68360.
8773
8774 @item -m5200
8775 @opindex m5200
8776 Generate output for a 520X ``coldfire'' family cpu.  This is the default
8777 when the compiler is configured for 520X-based systems.
8778
8779 Use this option for microcontroller with a 5200 core, including
8780 the MCF5202, MCF5203, MCF5204 and MCF5202.
8781
8782
8783 @item -m68020-40
8784 @opindex m68020-40
8785 Generate output for a 68040, without using any of the new instructions.
8786 This results in code which can run relatively efficiently on either a
8787 68020/68881 or a 68030 or a 68040.  The generated code does use the
8788 68881 instructions that are emulated on the 68040.
8789
8790 @item -m68020-60
8791 @opindex m68020-60
8792 Generate output for a 68060, without using any of the new instructions.
8793 This results in code which can run relatively efficiently on either a
8794 68020/68881 or a 68030 or a 68040.  The generated code does use the
8795 68881 instructions that are emulated on the 68060.
8796
8797 @item -msoft-float
8798 @opindex msoft-float
8799 Generate output containing library calls for floating point.
8800 @strong{Warning:} the requisite libraries are not available for all m68k
8801 targets.  Normally the facilities of the machine's usual C compiler are
8802 used, but this can't be done directly in cross-compilation.  You must
8803 make your own arrangements to provide suitable library functions for
8804 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
8805 @samp{m68k-*-coff} do provide software floating point support.
8806
8807 @item -mshort
8808 @opindex mshort
8809 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8810 Additionally, parameters passed on the stack are also aligned to a
8811 16-bit boundary even on targets whose API mandates promotion to 32-bit.
8812
8813 @item -mnobitfield
8814 @opindex mnobitfield
8815 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
8816 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
8817
8818 @item -mbitfield
8819 @opindex mbitfield
8820 Do use the bit-field instructions.  The @option{-m68020} option implies
8821 @option{-mbitfield}.  This is the default if you use a configuration
8822 designed for a 68020.
8823
8824 @item -mrtd
8825 @opindex mrtd
8826 Use a different function-calling convention, in which functions
8827 that take a fixed number of arguments return with the @code{rtd}
8828 instruction, which pops their arguments while returning.  This
8829 saves one instruction in the caller since there is no need to pop
8830 the arguments there.
8831
8832 This calling convention is incompatible with the one normally
8833 used on Unix, so you cannot use it if you need to call libraries
8834 compiled with the Unix compiler.
8835
8836 Also, you must provide function prototypes for all functions that
8837 take variable numbers of arguments (including @code{printf});
8838 otherwise incorrect code will be generated for calls to those
8839 functions.
8840
8841 In addition, seriously incorrect code will result if you call a
8842 function with too many arguments.  (Normally, extra arguments are
8843 harmlessly ignored.)
8844
8845 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
8846 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
8847
8848 @item -malign-int
8849 @itemx -mno-align-int
8850 @opindex malign-int
8851 @opindex mno-align-int
8852 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
8853 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
8854 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
8855 Aligning variables on 32-bit boundaries produces code that runs somewhat
8856 faster on processors with 32-bit busses at the expense of more memory.
8857
8858 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
8859 align structures containing the above types  differently than
8860 most published application binary interface specifications for the m68k.
8861
8862 @item -mpcrel
8863 @opindex mpcrel
8864 Use the pc-relative addressing mode of the 68000 directly, instead of
8865 using a global offset table.  At present, this option implies @option{-fpic},
8866 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
8867 not presently supported with @option{-mpcrel}, though this could be supported for
8868 68020 and higher processors.
8869
8870 @item -mno-strict-align
8871 @itemx -mstrict-align
8872 @opindex mno-strict-align
8873 @opindex mstrict-align
8874 Do not (do) assume that unaligned memory references will be handled by
8875 the system.
8876
8877 @item -msep-data
8878 Generate code that allows the data segment to be located in a different
8879 area of memory from the text segment.  This allows for execute in place in
8880 an environment without virtual memory management.  This option implies -fPIC.
8881
8882 @item -mno-sep-data
8883 Generate code that assumes that the data segment follows the text segment.
8884 This is the default.
8885
8886 @item -mid-shared-library
8887 Generate code that supports shared libraries via the library ID method.
8888 This allows for execute in place and shared libraries in an environment
8889 without virtual memory management.  This option implies -fPIC.
8890
8891 @item -mno-id-shared-library
8892 Generate code that doesn't assume ID based shared libraries are being used.
8893 This is the default.
8894
8895 @item -mshared-library-id=n
8896 Specified the identification number of the ID based shared library being
8897 compiled.  Specifying a value of 0 will generate more compact code, specifying
8898 other values will force the allocation of that number to the current
8899 library but is no more space or time efficient than omitting this option.
8900
8901 @end table
8902
8903 @node M68hc1x Options
8904 @subsection M68hc1x Options
8905 @cindex M68hc1x options
8906
8907 These are the @samp{-m} options defined for the 68hc11 and 68hc12
8908 microcontrollers.  The default values for these options depends on
8909 which style of microcontroller was selected when the compiler was configured;
8910 the defaults for the most common choices are given below.
8911
8912 @table @gcctabopt
8913 @item -m6811
8914 @itemx -m68hc11
8915 @opindex m6811
8916 @opindex m68hc11
8917 Generate output for a 68HC11.  This is the default
8918 when the compiler is configured for 68HC11-based systems.
8919
8920 @item -m6812
8921 @itemx -m68hc12
8922 @opindex m6812
8923 @opindex m68hc12
8924 Generate output for a 68HC12.  This is the default
8925 when the compiler is configured for 68HC12-based systems.
8926
8927 @item -m68S12
8928 @itemx -m68hcs12
8929 @opindex m68S12
8930 @opindex m68hcs12
8931 Generate output for a 68HCS12.
8932
8933 @item -mauto-incdec
8934 @opindex mauto-incdec
8935 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
8936 addressing modes.
8937
8938 @item -minmax
8939 @itemx -nominmax
8940 @opindex minmax
8941 @opindex mnominmax
8942 Enable the use of 68HC12 min and max instructions.
8943
8944 @item -mlong-calls
8945 @itemx -mno-long-calls
8946 @opindex mlong-calls
8947 @opindex mno-long-calls
8948 Treat all calls as being far away (near).  If calls are assumed to be
8949 far away, the compiler will use the @code{call} instruction to
8950 call a function and the @code{rtc} instruction for returning.
8951
8952 @item -mshort
8953 @opindex mshort
8954 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8955
8956 @item -msoft-reg-count=@var{count}
8957 @opindex msoft-reg-count
8958 Specify the number of pseudo-soft registers which are used for the
8959 code generation.  The maximum number is 32.  Using more pseudo-soft
8960 register may or may not result in better code depending on the program.
8961 The default is 4 for 68HC11 and 2 for 68HC12.
8962
8963 @end table
8964
8965 @node MCore Options
8966 @subsection MCore Options
8967 @cindex MCore options
8968
8969 These are the @samp{-m} options defined for the Motorola M*Core
8970 processors.
8971
8972 @table @gcctabopt
8973
8974 @item -mhardlit
8975 @itemx -mno-hardlit
8976 @opindex mhardlit
8977 @opindex mno-hardlit
8978 Inline constants into the code stream if it can be done in two
8979 instructions or less.
8980
8981 @item -mdiv
8982 @itemx -mno-div
8983 @opindex mdiv
8984 @opindex mno-div
8985 Use the divide instruction.  (Enabled by default).
8986
8987 @item -mrelax-immediate
8988 @itemx -mno-relax-immediate
8989 @opindex mrelax-immediate
8990 @opindex mno-relax-immediate
8991 Allow arbitrary sized immediates in bit operations.
8992
8993 @item -mwide-bitfields
8994 @itemx -mno-wide-bitfields
8995 @opindex mwide-bitfields
8996 @opindex mno-wide-bitfields
8997 Always treat bit-fields as int-sized.
8998
8999 @item -m4byte-functions
9000 @itemx -mno-4byte-functions
9001 @opindex m4byte-functions
9002 @opindex mno-4byte-functions
9003 Force all functions to be aligned to a four byte boundary.
9004
9005 @item -mcallgraph-data
9006 @itemx -mno-callgraph-data
9007 @opindex mcallgraph-data
9008 @opindex mno-callgraph-data
9009 Emit callgraph information.
9010
9011 @item -mslow-bytes
9012 @itemx -mno-slow-bytes
9013 @opindex mslow-bytes
9014 @opindex mno-slow-bytes
9015 Prefer word access when reading byte quantities.
9016
9017 @item -mlittle-endian
9018 @itemx -mbig-endian
9019 @opindex mlittle-endian
9020 @opindex mbig-endian
9021 Generate code for a little endian target.
9022
9023 @item -m210
9024 @itemx -m340
9025 @opindex m210
9026 @opindex m340
9027 Generate code for the 210 processor.
9028 @end table
9029
9030 @node MIPS Options
9031 @subsection MIPS Options
9032 @cindex MIPS options
9033
9034 @table @gcctabopt
9035
9036 @item -EB
9037 @opindex EB
9038 Generate big-endian code.
9039
9040 @item -EL
9041 @opindex EL
9042 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9043 configurations.
9044
9045 @item -march=@var{arch}
9046 @opindex march
9047 Generate code that will run on @var{arch}, which can be the name of a
9048 generic MIPS ISA, or the name of a particular processor.
9049 The ISA names are:
9050 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9051 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9052 The processor names are:
9053 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9054 @samp{m4k},
9055 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9056 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9057 @samp{rm9000},
9058 @samp{orion},
9059 @samp{sb1},
9060 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9061 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9062 The special value @samp{from-abi} selects the
9063 most compatible architecture for the selected ABI (that is,
9064 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9065
9066 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9067 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9068 @samp{vr} may be written @samp{r}.
9069
9070 GCC defines two macros based on the value of this option.  The first
9071 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9072 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9073 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9074 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9075 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9076
9077 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9078 above.  In other words, it will have the full prefix and will not
9079 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9080 the macro names the resolved architecture (either @samp{"mips1"} or
9081 @samp{"mips3"}).  It names the default architecture when no
9082 @option{-march} option is given.
9083
9084 @item -mtune=@var{arch}
9085 @opindex mtune
9086 Optimize for @var{arch}.  Among other things, this option controls
9087 the way instructions are scheduled, and the perceived cost of arithmetic
9088 operations.  The list of @var{arch} values is the same as for
9089 @option{-march}.
9090
9091 When this option is not used, GCC will optimize for the processor
9092 specified by @option{-march}.  By using @option{-march} and
9093 @option{-mtune} together, it is possible to generate code that will
9094 run on a family of processors, but optimize the code for one
9095 particular member of that family.
9096
9097 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9098 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9099 @samp{-march} ones described above.
9100
9101 @item -mips1
9102 @opindex mips1
9103 Equivalent to @samp{-march=mips1}.
9104
9105 @item -mips2
9106 @opindex mips2
9107 Equivalent to @samp{-march=mips2}.
9108
9109 @item -mips3
9110 @opindex mips3
9111 Equivalent to @samp{-march=mips3}.
9112
9113 @item -mips4
9114 @opindex mips4
9115 Equivalent to @samp{-march=mips4}.
9116
9117 @item -mips32
9118 @opindex mips32
9119 Equivalent to @samp{-march=mips32}.
9120
9121 @item -mips32r2
9122 @opindex mips32r2
9123 Equivalent to @samp{-march=mips32r2}.
9124
9125 @item -mips64
9126 @opindex mips64
9127 Equivalent to @samp{-march=mips64}.
9128
9129 @item -mips16
9130 @itemx -mno-mips16
9131 @opindex mips16
9132 @opindex mno-mips16
9133 Use (do not use) the MIPS16 ISA.
9134
9135 @item -mabi=32
9136 @itemx -mabi=o64
9137 @itemx -mabi=n32
9138 @itemx -mabi=64
9139 @itemx -mabi=eabi
9140 @opindex mabi=32
9141 @opindex mabi=o64
9142 @opindex mabi=n32
9143 @opindex mabi=64
9144 @opindex mabi=eabi
9145 Generate code for the given ABI@.
9146
9147 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9148 generates 64-bit code when you select a 64-bit architecture, but you
9149 can use @option{-mgp32} to get 32-bit code instead.
9150
9151 For information about the O64 ABI, see
9152 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9153
9154 @item -mabicalls
9155 @itemx -mno-abicalls
9156 @opindex mabicalls
9157 @opindex mno-abicalls
9158 Generate (do not generate) SVR4-style position-independent code.
9159 @option{-mabicalls} is the default for SVR4-based systems.
9160
9161 @item -mxgot
9162 @itemx -mno-xgot
9163 @opindex mxgot
9164 @opindex mno-xgot
9165 Lift (do not lift) the usual restrictions on the size of the global
9166 offset table.
9167
9168 GCC normally uses a single instruction to load values from the GOT.
9169 While this is relatively efficient, it will only work if the GOT
9170 is smaller than about 64k.  Anything larger will cause the linker
9171 to report an error such as:
9172
9173 @cindex relocation truncated to fit (MIPS)
9174 @smallexample
9175 relocation truncated to fit: R_MIPS_GOT16 foobar
9176 @end smallexample
9177
9178 If this happens, you should recompile your code with @option{-mxgot}.
9179 It should then work with very large GOTs, although it will also be
9180 less efficient, since it will take three instructions to fetch the
9181 value of a global symbol.
9182
9183 Note that some linkers can create multiple GOTs.  If you have such a
9184 linker, you should only need to use @option{-mxgot} when a single object
9185 file accesses more than 64k's worth of GOT entries.  Very few do.
9186
9187 These options have no effect unless GCC is generating position
9188 independent code.
9189
9190 @item -mgp32
9191 @opindex mgp32
9192 Assume that general-purpose registers are 32 bits wide.
9193
9194 @item -mgp64
9195 @opindex mgp64
9196 Assume that general-purpose registers are 64 bits wide.
9197
9198 @item -mfp32
9199 @opindex mfp32
9200 Assume that floating-point registers are 32 bits wide.
9201
9202 @item -mfp64
9203 @opindex mfp64
9204 Assume that floating-point registers are 64 bits wide.
9205
9206 @item -mhard-float
9207 @opindex mhard-float
9208 Use floating-point coprocessor instructions.
9209
9210 @item -msoft-float
9211 @opindex msoft-float
9212 Do not use floating-point coprocessor instructions.  Implement
9213 floating-point calculations using library calls instead.
9214
9215 @item -msingle-float
9216 @opindex msingle-float
9217 Assume that the floating-point coprocessor only supports single-precision
9218 operations.
9219
9220 @itemx -mdouble-float
9221 @opindex mdouble-float
9222 Assume that the floating-point coprocessor supports double-precision
9223 operations.  This is the default.
9224
9225 @item -mint64
9226 @opindex mint64
9227 Force @code{int} and @code{long} types to be 64 bits wide.  See
9228 @option{-mlong32} for an explanation of the default and the way
9229 that the pointer size is determined.
9230
9231 @item -mlong64
9232 @opindex mlong64
9233 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9234 an explanation of the default and the way that the pointer size is
9235 determined.
9236
9237 @item -mlong32
9238 @opindex mlong32
9239 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9240
9241 The default size of @code{int}s, @code{long}s and pointers depends on
9242 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9243 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9244 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9245 or the same size as integer registers, whichever is smaller.
9246
9247 @item -G @var{num}
9248 @opindex G
9249 @cindex smaller data references (MIPS)
9250 @cindex gp-relative references (MIPS)
9251 Put global and static items less than or equal to @var{num} bytes into
9252 the small data or bss section instead of the normal data or bss section.
9253 This allows the data to be accessed using a single instruction.
9254
9255 All modules should be compiled with the same @option{-G @var{num}}
9256 value.
9257
9258 @item -membedded-data
9259 @itemx -mno-embedded-data
9260 @opindex membedded-data
9261 @opindex mno-embedded-data
9262 Allocate variables to the read-only data section first if possible, then
9263 next in the small data section if possible, otherwise in data.  This gives
9264 slightly slower code than the default, but reduces the amount of RAM required
9265 when executing, and thus may be preferred for some embedded systems.
9266
9267 @item -muninit-const-in-rodata
9268 @itemx -mno-uninit-const-in-rodata
9269 @opindex muninit-const-in-rodata
9270 @opindex mno-uninit-const-in-rodata
9271 Put uninitialized @code{const} variables in the read-only data section.
9272 This option is only meaningful in conjunction with @option{-membedded-data}.
9273
9274 @item -msplit-addresses
9275 @itemx -mno-split-addresses
9276 @opindex msplit-addresses
9277 @opindex mno-split-addresses
9278 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9279 relocation operators.  This option has been superceded by
9280 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9281
9282 @item -mexplicit-relocs
9283 @itemx -mno-explicit-relocs
9284 @opindex mexplicit-relocs
9285 @opindex mno-explicit-relocs
9286 Use (do not use) assembler relocation operators when dealing with symbolic
9287 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9288 is to use assembler macros instead.
9289
9290 @option{-mexplicit-relocs} is the default if GCC was configured
9291 to use an assembler that supports relocation operators.
9292
9293 @item -mcheck-zero-division
9294 @itemx -mno-check-zero-division
9295 @opindex mcheck-zero-division
9296 @opindex mno-check-zero-division
9297 Trap (do not trap) on integer division by zero.  The default is
9298 @option{-mcheck-zero-division}.
9299
9300 @item -mmemcpy
9301 @itemx -mno-memcpy
9302 @opindex mmemcpy
9303 @opindex mno-memcpy
9304 Force (do not force) the use of @code{memcpy()} for non-trivial block
9305 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9306 most constant-sized copies.
9307
9308 @item -mlong-calls
9309 @itemx -mno-long-calls
9310 @opindex mlong-calls
9311 @opindex mno-long-calls
9312 Disable (do not disable) use of the @code{jal} instruction.  Calling
9313 functions using @code{jal} is more efficient but requires the caller
9314 and callee to be in the same 256 megabyte segment.
9315
9316 This option has no effect on abicalls code.  The default is
9317 @option{-mno-long-calls}.
9318
9319 @item -mmad
9320 @itemx -mno-mad
9321 @opindex mmad
9322 @opindex mno-mad
9323 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9324 instructions, as provided by the R4650 ISA.
9325
9326 @item -mfused-madd
9327 @itemx -mno-fused-madd
9328 @opindex mfused-madd
9329 @opindex mno-fused-madd
9330 Enable (disable) use of the floating point multiply-accumulate
9331 instructions, when they are available.  The default is
9332 @option{-mfused-madd}.
9333
9334 When multiply-accumulate instructions are used, the intermediate
9335 product is calculated to infinite precision and is not subject to
9336 the FCSR Flush to Zero bit.  This may be undesirable in some
9337 circumstances.
9338
9339 @item -nocpp
9340 @opindex nocpp
9341 Tell the MIPS assembler to not run its preprocessor over user
9342 assembler files (with a @samp{.s} suffix) when assembling them.
9343
9344 @item -mfix-r4000
9345 @itemx -mno-fix-r4000
9346 @opindex mfix-r4000
9347 @opindex mno-fix-r4000
9348 Work around certain R4000 CPU errata:
9349 @itemize @minus
9350 @item
9351 A double-word or a variable shift may give an incorrect result if executed
9352 immediately after starting an integer division.
9353 @item
9354 A double-word or a variable shift may give an incorrect result if executed
9355 while an integer multiplication is in progress.
9356 @item
9357 An integer division may give an incorrect result if started in a delay slot
9358 of a taken branch or a jump.
9359 @end itemize
9360
9361 @item -mfix-r4400
9362 @itemx -mno-fix-r4400
9363 @opindex mfix-r4400
9364 @opindex mno-fix-r4400
9365 Work around certain R4400 CPU errata:
9366 @itemize @minus
9367 @item
9368 A double-word or a variable shift may give an incorrect result if executed
9369 immediately after starting an integer division.
9370 @end itemize
9371
9372 @item -mfix-vr4120
9373 @itemx -mno-fix-vr4120
9374 @opindex mfix-vr4120
9375 Work around certain VR4120 errata:
9376 @itemize @minus
9377 @item
9378 @code{dmultu} does not always produce the correct result.
9379 @item
9380 @code{div} and @code{ddiv} do not always produce the correct result if one
9381 of the operands is negative.
9382 @end itemize
9383 The workarounds for the division errata rely on special functions in
9384 @file{libgcc.a}.  At present, these functions are only provided by
9385 the @code{mips64vr*-elf} configurations.
9386
9387 Other VR4120 errata require a nop to be inserted between certain pairs of
9388 instructions.  These errata are handled by the assembler, not by GCC itself.
9389
9390 @item -mfix-sb1
9391 @itemx -mno-fix-sb1
9392 @opindex mfix-sb1
9393 Work around certain SB-1 CPU core errata.
9394 (This flag currently works around the SB-1 revision 2
9395 ``F1'' and ``F2'' floating point errata.)
9396
9397 @item -mflush-func=@var{func}
9398 @itemx -mno-flush-func
9399 @opindex mflush-func
9400 Specifies the function to call to flush the I and D caches, or to not
9401 call any such function.  If called, the function must take the same
9402 arguments as the common @code{_flush_func()}, that is, the address of the
9403 memory range for which the cache is being flushed, the size of the
9404 memory range, and the number 3 (to flush both caches).  The default
9405 depends on the target GCC was configured for, but commonly is either
9406 @samp{_flush_func} or @samp{__cpu_flush}.
9407
9408 @item -mbranch-likely
9409 @itemx -mno-branch-likely
9410 @opindex mbranch-likely
9411 @opindex mno-branch-likely
9412 Enable or disable use of Branch Likely instructions, regardless of the
9413 default for the selected architecture.  By default, Branch Likely
9414 instructions may be generated if they are supported by the selected
9415 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9416 and processors which implement those architectures; for those, Branch
9417 Likely instructions will not be generated by default because the MIPS32
9418 and MIPS64 architectures specifically deprecate their use.
9419
9420 @item -mfp-exceptions
9421 @itemx -mno-fp-exceptions
9422 @opindex mfp-exceptions
9423 Specifies whether FP exceptions are enabled.  This affects how we schedule
9424 FP instructions for some processors.  The default is that FP exceptions are
9425 enabled.
9426
9427 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9428 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9429 FP pipe.
9430
9431 @item -mvr4130-align
9432 @itemx -mno-vr4130-align
9433 @opindex mvr4130-align
9434 The VR4130 pipeline is two-way superscalar, but can only issue two
9435 instructions together if the first one is 8-byte aligned.  When this
9436 option is enabled, GCC will align pairs of instructions that it
9437 thinks should execute in parallel.
9438
9439 This option only has an effect when optimizing for the VR4130.
9440 It normally makes code faster, but at the expense of making it bigger.
9441 It is enabled by default at optimization level @option{-O3}.
9442 @end table
9443
9444 @node MMIX Options
9445 @subsection MMIX Options
9446 @cindex MMIX Options
9447
9448 These options are defined for the MMIX:
9449
9450 @table @gcctabopt
9451 @item -mlibfuncs
9452 @itemx -mno-libfuncs
9453 @opindex mlibfuncs
9454 @opindex mno-libfuncs
9455 Specify that intrinsic library functions are being compiled, passing all
9456 values in registers, no matter the size.
9457
9458 @item -mepsilon
9459 @itemx -mno-epsilon
9460 @opindex mepsilon
9461 @opindex mno-epsilon
9462 Generate floating-point comparison instructions that compare with respect
9463 to the @code{rE} epsilon register.
9464
9465 @item -mabi=mmixware
9466 @itemx -mabi=gnu
9467 @opindex mabi-mmixware
9468 @opindex mabi=gnu
9469 Generate code that passes function parameters and return values that (in
9470 the called function) are seen as registers @code{$0} and up, as opposed to
9471 the GNU ABI which uses global registers @code{$231} and up.
9472
9473 @item -mzero-extend
9474 @itemx -mno-zero-extend
9475 @opindex mzero-extend
9476 @opindex mno-zero-extend
9477 When reading data from memory in sizes shorter than 64 bits, use (do not
9478 use) zero-extending load instructions by default, rather than
9479 sign-extending ones.
9480
9481 @item -mknuthdiv
9482 @itemx -mno-knuthdiv
9483 @opindex mknuthdiv
9484 @opindex mno-knuthdiv
9485 Make the result of a division yielding a remainder have the same sign as
9486 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9487 remainder follows the sign of the dividend.  Both methods are
9488 arithmetically valid, the latter being almost exclusively used.
9489
9490 @item -mtoplevel-symbols
9491 @itemx -mno-toplevel-symbols
9492 @opindex mtoplevel-symbols
9493 @opindex mno-toplevel-symbols
9494 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9495 code can be used with the @code{PREFIX} assembly directive.
9496
9497 @item -melf
9498 @opindex melf
9499 Generate an executable in the ELF format, rather than the default
9500 @samp{mmo} format used by the @command{mmix} simulator.
9501
9502 @item -mbranch-predict
9503 @itemx -mno-branch-predict
9504 @opindex mbranch-predict
9505 @opindex mno-branch-predict
9506 Use (do not use) the probable-branch instructions, when static branch
9507 prediction indicates a probable branch.
9508
9509 @item -mbase-addresses
9510 @itemx -mno-base-addresses
9511 @opindex mbase-addresses
9512 @opindex mno-base-addresses
9513 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9514 base address automatically generates a request (handled by the assembler
9515 and the linker) for a constant to be set up in a global register.  The
9516 register is used for one or more base address requests within the range 0
9517 to 255 from the value held in the register.  The generally leads to short
9518 and fast code, but the number of different data items that can be
9519 addressed is limited.  This means that a program that uses lots of static
9520 data may require @option{-mno-base-addresses}.
9521
9522 @item -msingle-exit
9523 @itemx -mno-single-exit
9524 @opindex msingle-exit
9525 @opindex mno-single-exit
9526 Force (do not force) generated code to have a single exit point in each
9527 function.
9528 @end table
9529
9530 @node MN10300 Options
9531 @subsection MN10300 Options
9532 @cindex MN10300 options
9533
9534 These @option{-m} options are defined for Matsushita MN10300 architectures:
9535
9536 @table @gcctabopt
9537 @item -mmult-bug
9538 @opindex mmult-bug
9539 Generate code to avoid bugs in the multiply instructions for the MN10300
9540 processors.  This is the default.
9541
9542 @item -mno-mult-bug
9543 @opindex mno-mult-bug
9544 Do not generate code to avoid bugs in the multiply instructions for the
9545 MN10300 processors.
9546
9547 @item -mam33
9548 @opindex mam33
9549 Generate code which uses features specific to the AM33 processor.
9550
9551 @item -mno-am33
9552 @opindex mno-am33
9553 Do not generate code which uses features specific to the AM33 processor.  This
9554 is the default.
9555
9556 @item -mno-crt0
9557 @opindex mno-crt0
9558 Do not link in the C run-time initialization object file.
9559
9560 @item -mrelax
9561 @opindex mrelax
9562 Indicate to the linker that it should perform a relaxation optimization pass
9563 to shorten branches, calls and absolute memory addresses.  This option only
9564 has an effect when used on the command line for the final link step.
9565
9566 This option makes symbolic debugging impossible.
9567 @end table
9568
9569 @node NS32K Options
9570 @subsection NS32K Options
9571 @cindex NS32K options
9572
9573 These are the @samp{-m} options defined for the 32000 series.  The default
9574 values for these options depends on which style of 32000 was selected when
9575 the compiler was configured; the defaults for the most common choices are
9576 given below.
9577
9578 @table @gcctabopt
9579 @item -m32032
9580 @itemx -m32032
9581 @opindex m32032
9582 @opindex m32032
9583 Generate output for a 32032.  This is the default
9584 when the compiler is configured for 32032 and 32016 based systems.
9585
9586 @item -m32332
9587 @itemx -m32332
9588 @opindex m32332
9589 @opindex m32332
9590 Generate output for a 32332.  This is the default
9591 when the compiler is configured for 32332-based systems.
9592
9593 @item -m32532
9594 @itemx -m32532
9595 @opindex m32532
9596 @opindex m32532
9597 Generate output for a 32532.  This is the default
9598 when the compiler is configured for 32532-based systems.
9599
9600 @item -m32081
9601 @opindex m32081
9602 Generate output containing 32081 instructions for floating point.
9603 This is the default for all systems.
9604
9605 @item -m32381
9606 @opindex m32381
9607 Generate output containing 32381 instructions for floating point.  This
9608 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9609 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9610
9611 @item -mmulti-add
9612 @opindex mmulti-add
9613 Try and generate multiply-add floating point instructions @code{polyF}
9614 and @code{dotF}.  This option is only available if the @option{-m32381}
9615 option is in effect.  Using these instructions requires changes to
9616 register allocation which generally has a negative impact on
9617 performance.  This option should only be enabled when compiling code
9618 particularly likely to make heavy use of multiply-add instructions.
9619
9620 @item -mnomulti-add
9621 @opindex mnomulti-add
9622 Do not try and generate multiply-add floating point instructions
9623 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9624
9625 @item -msoft-float
9626 @opindex msoft-float
9627 Generate output containing library calls for floating point.
9628 @strong{Warning:} the requisite libraries may not be available.
9629
9630 @item -mieee-compare
9631 @itemx -mno-ieee-compare
9632 @opindex mieee-compare
9633 @opindex mno-ieee-compare
9634 Control whether or not the compiler uses IEEE floating point
9635 comparisons.  These handle correctly the case where the result of a
9636 comparison is unordered.
9637 @strong{Warning:} the requisite kernel support may not be available.
9638
9639 @item -mnobitfield
9640 @opindex mnobitfield
9641 Do not use the bit-field instructions.  On some machines it is faster to
9642 use shifting and masking operations.  This is the default for the pc532.
9643
9644 @item -mbitfield
9645 @opindex mbitfield
9646 Do use the bit-field instructions.  This is the default for all platforms
9647 except the pc532.
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 pop their
9653 arguments on return with the @code{ret} instruction.
9654
9655 This calling convention is incompatible with the one normally
9656 used on Unix, so you cannot use it if you need to call libraries
9657 compiled with the Unix compiler.
9658
9659 Also, you must provide function prototypes for all functions that
9660 take variable numbers of arguments (including @code{printf});
9661 otherwise incorrect code will be generated for calls to those
9662 functions.
9663
9664 In addition, seriously incorrect code will result if you call a
9665 function with too many arguments.  (Normally, extra arguments are
9666 harmlessly ignored.)
9667
9668 This option takes its name from the 680x0 @code{rtd} instruction.
9669
9670
9671 @item -mregparam
9672 @opindex mregparam
9673 Use a different function-calling convention where the first two arguments
9674 are passed in registers.
9675
9676 This calling convention is incompatible with the one normally
9677 used on Unix, so you cannot use it if you need to call libraries
9678 compiled with the Unix compiler.
9679
9680 @item -mnoregparam
9681 @opindex mnoregparam
9682 Do not pass any arguments in registers.  This is the default for all
9683 targets.
9684
9685 @item -msb
9686 @opindex msb
9687 It is OK to use the sb as an index register which is always loaded with
9688 zero.  This is the default for the pc532-netbsd target.
9689
9690 @item -mnosb
9691 @opindex mnosb
9692 The sb register is not available for use or has not been initialized to
9693 zero by the run time system.  This is the default for all targets except
9694 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9695 @option{-fpic} is set.
9696
9697 @item -mhimem
9698 @opindex mhimem
9699 Many ns32000 series addressing modes use displacements of up to 512MB@.
9700 If an address is above 512MB then displacements from zero can not be used.
9701 This option causes code to be generated which can be loaded above 512MB@.
9702 This may be useful for operating systems or ROM code.
9703
9704 @item -mnohimem
9705 @opindex mnohimem
9706 Assume code will be loaded in the first 512MB of virtual address space.
9707 This is the default for all platforms.
9708
9709 @end table
9710
9711 @node PDP-11 Options
9712 @subsection PDP-11 Options
9713 @cindex PDP-11 Options
9714
9715 These options are defined for the PDP-11:
9716
9717 @table @gcctabopt
9718 @item -mfpu
9719 @opindex mfpu
9720 Use hardware FPP floating point.  This is the default.  (FIS floating
9721 point on the PDP-11/40 is not supported.)
9722
9723 @item -msoft-float
9724 @opindex msoft-float
9725 Do not use hardware floating point.
9726
9727 @item -mac0
9728 @opindex mac0
9729 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9730
9731 @item -mno-ac0
9732 @opindex mno-ac0
9733 Return floating-point results in memory.  This is the default.
9734
9735 @item -m40
9736 @opindex m40
9737 Generate code for a PDP-11/40.
9738
9739 @item -m45
9740 @opindex m45
9741 Generate code for a PDP-11/45.  This is the default.
9742
9743 @item -m10
9744 @opindex m10
9745 Generate code for a PDP-11/10.
9746
9747 @item -mbcopy-builtin
9748 @opindex bcopy-builtin
9749 Use inline @code{movmemhi} patterns for copying memory.  This is the
9750 default.
9751
9752 @item -mbcopy
9753 @opindex mbcopy
9754 Do not use inline @code{movmemhi} patterns for copying memory.
9755
9756 @item -mint16
9757 @itemx -mno-int32
9758 @opindex mint16
9759 @opindex mno-int32
9760 Use 16-bit @code{int}.  This is the default.
9761
9762 @item -mint32
9763 @itemx -mno-int16
9764 @opindex mint32
9765 @opindex mno-int16
9766 Use 32-bit @code{int}.
9767
9768 @item -mfloat64
9769 @itemx -mno-float32
9770 @opindex mfloat64
9771 @opindex mno-float32
9772 Use 64-bit @code{float}.  This is the default.
9773
9774 @item -mfloat32
9775 @itemx -mno-float64
9776 @opindex mfloat32
9777 @opindex mno-float64
9778 Use 32-bit @code{float}.
9779
9780 @item -mabshi
9781 @opindex mabshi
9782 Use @code{abshi2} pattern.  This is the default.
9783
9784 @item -mno-abshi
9785 @opindex mno-abshi
9786 Do not use @code{abshi2} pattern.
9787
9788 @item -mbranch-expensive
9789 @opindex mbranch-expensive
9790 Pretend that branches are expensive.  This is for experimenting with
9791 code generation only.
9792
9793 @item -mbranch-cheap
9794 @opindex mbranch-cheap
9795 Do not pretend that branches are expensive.  This is the default.
9796
9797 @item -msplit
9798 @opindex msplit
9799 Generate code for a system with split I&D.
9800
9801 @item -mno-split
9802 @opindex mno-split
9803 Generate code for a system without split I&D.  This is the default.
9804
9805 @item -munix-asm
9806 @opindex munix-asm
9807 Use Unix assembler syntax.  This is the default when configured for
9808 @samp{pdp11-*-bsd}.
9809
9810 @item -mdec-asm
9811 @opindex mdec-asm
9812 Use DEC assembler syntax.  This is the default when configured for any
9813 PDP-11 target other than @samp{pdp11-*-bsd}.
9814 @end table
9815
9816 @node PowerPC Options
9817 @subsection PowerPC Options
9818 @cindex PowerPC options
9819
9820 These are listed under @xref{RS/6000 and PowerPC Options}.
9821
9822 @node RS/6000 and PowerPC Options
9823 @subsection IBM RS/6000 and PowerPC Options
9824 @cindex RS/6000 and PowerPC Options
9825 @cindex IBM RS/6000 and PowerPC Options
9826
9827 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
9828 @table @gcctabopt
9829 @item -mpower
9830 @itemx -mno-power
9831 @itemx -mpower2
9832 @itemx -mno-power2
9833 @itemx -mpowerpc
9834 @itemx -mno-powerpc
9835 @itemx -mpowerpc-gpopt
9836 @itemx -mno-powerpc-gpopt
9837 @itemx -mpowerpc-gfxopt
9838 @itemx -mno-powerpc-gfxopt
9839 @itemx -mpowerpc64
9840 @itemx -mno-powerpc64
9841 @opindex mpower
9842 @opindex mno-power
9843 @opindex mpower2
9844 @opindex mno-power2
9845 @opindex mpowerpc
9846 @opindex mno-powerpc
9847 @opindex mpowerpc-gpopt
9848 @opindex mno-powerpc-gpopt
9849 @opindex mpowerpc-gfxopt
9850 @opindex mno-powerpc-gfxopt
9851 @opindex mpowerpc64
9852 @opindex mno-powerpc64
9853 GCC supports two related instruction set architectures for the
9854 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
9855 instructions supported by the @samp{rios} chip set used in the original
9856 RS/6000 systems and the @dfn{PowerPC} instruction set is the
9857 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
9858 the IBM 4xx microprocessors.
9859
9860 Neither architecture is a subset of the other.  However there is a
9861 large common subset of instructions supported by both.  An MQ
9862 register is included in processors supporting the POWER architecture.
9863
9864 You use these options to specify which instructions are available on the
9865 processor you are using.  The default value of these options is
9866 determined when configuring GCC@.  Specifying the
9867 @option{-mcpu=@var{cpu_type}} overrides the specification of these
9868 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
9869 rather than the options listed above.
9870
9871 The @option{-mpower} option allows GCC to generate instructions that
9872 are found only in the POWER architecture and to use the MQ register.
9873 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
9874 to generate instructions that are present in the POWER2 architecture but
9875 not the original POWER architecture.
9876
9877 The @option{-mpowerpc} option allows GCC to generate instructions that
9878 are found only in the 32-bit subset of the PowerPC architecture.
9879 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
9880 GCC to use the optional PowerPC architecture instructions in the
9881 General Purpose group, including floating-point square root.  Specifying
9882 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
9883 use the optional PowerPC architecture instructions in the Graphics
9884 group, including floating-point select.
9885
9886 The @option{-mpowerpc64} option allows GCC to generate the additional
9887 64-bit instructions that are found in the full PowerPC64 architecture
9888 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
9889 @option{-mno-powerpc64}.
9890
9891 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
9892 will use only the instructions in the common subset of both
9893 architectures plus some special AIX common-mode calls, and will not use
9894 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
9895 permits GCC to use any instruction from either architecture and to
9896 allow use of the MQ register; specify this for the Motorola MPC601.
9897
9898 @item -mnew-mnemonics
9899 @itemx -mold-mnemonics
9900 @opindex mnew-mnemonics
9901 @opindex mold-mnemonics
9902 Select which mnemonics to use in the generated assembler code.  With
9903 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
9904 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
9905 assembler mnemonics defined for the POWER architecture.  Instructions
9906 defined in only one architecture have only one mnemonic; GCC uses that
9907 mnemonic irrespective of which of these options is specified.
9908
9909 GCC defaults to the mnemonics appropriate for the architecture in
9910 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
9911 value of these option.  Unless you are building a cross-compiler, you
9912 should normally not specify either @option{-mnew-mnemonics} or
9913 @option{-mold-mnemonics}, but should instead accept the default.
9914
9915 @item -mcpu=@var{cpu_type}
9916 @opindex mcpu
9917 Set architecture type, register usage, choice of mnemonics, and
9918 instruction scheduling parameters for machine type @var{cpu_type}.
9919 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
9920 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
9921 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
9922 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
9923 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9924 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
9925 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9926 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
9927 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
9928
9929 @option{-mcpu=common} selects a completely generic processor.  Code
9930 generated under this option will run on any POWER or PowerPC processor.
9931 GCC will use only the instructions in the common subset of both
9932 architectures, and will not use the MQ register.  GCC assumes a generic
9933 processor model for scheduling purposes.
9934
9935 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
9936 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
9937 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
9938 types, with an appropriate, generic processor model assumed for
9939 scheduling purposes.
9940
9941 The other options specify a specific processor.  Code generated under
9942 those options will run best on that processor, and may not run at all on
9943 others.
9944
9945 The @option{-mcpu} options automatically enable or disable the
9946 following options: @option{-maltivec}, @option{-mhard-float},
9947 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
9948 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
9949 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
9950 @option{-mstring}.  The particular options set for any particular CPU
9951 will vary between compiler versions, depending on what setting seems
9952 to produce optimal code for that CPU; it doesn't necessarily reflect
9953 the actual hardware's capabilities.  If you wish to set an individual
9954 option to a particular value, you may specify it after the
9955 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
9956
9957 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
9958 not enabled or disabled by the @option{-mcpu} option at present, since
9959 AIX does not have full support for these options.  You may still
9960 enable or disable them individually if you're sure it'll work in your
9961 environment.
9962
9963 @item -mtune=@var{cpu_type}
9964 @opindex mtune
9965 Set the instruction scheduling parameters for machine type
9966 @var{cpu_type}, but do not set the architecture type, register usage, or
9967 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
9968 values for @var{cpu_type} are used for @option{-mtune} as for
9969 @option{-mcpu}.  If both are specified, the code generated will use the
9970 architecture, registers, and mnemonics set by @option{-mcpu}, but the
9971 scheduling parameters set by @option{-mtune}.
9972
9973 @item -maltivec
9974 @itemx -mno-altivec
9975 @opindex maltivec
9976 @opindex mno-altivec
9977 These switches enable or disable the use of built-in functions that
9978 allow access to the AltiVec instruction set.  You may also need to set
9979 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
9980 enhancements.
9981
9982 @item -mabi=spe
9983 @opindex mabi=spe
9984 Extend the current ABI with SPE ABI extensions.  This does not change
9985 the default ABI, instead it adds the SPE ABI extensions to the current
9986 ABI@.
9987
9988 @item -mabi=no-spe
9989 @opindex mabi=no-spe
9990 Disable Booke SPE ABI extensions for the current ABI.
9991
9992 @item -misel=@var{yes/no}
9993 @itemx -misel
9994 @opindex misel
9995 This switch enables or disables the generation of ISEL instructions.
9996
9997 @item -mspe=@var{yes/no}
9998 @itemx -mspe
9999 @opindex mspe
10000 This switch enables or disables the generation of SPE simd
10001 instructions.
10002
10003 @item -mfloat-gprs=@var{yes/no}
10004 @itemx -mfloat-gprs
10005 @opindex mfloat-gprs
10006 This switch enables or disables the generation of floating point
10007 operations on the general purpose registers for architectures that
10008 support it.  This option is currently only available on the MPC8540.
10009
10010 @item -m32
10011 @itemx -m64
10012 @opindex m32
10013 @opindex m64
10014 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10015 targets (including GNU/Linux).  The 32-bit environment sets int, long
10016 and pointer to 32 bits and generates code that runs on any PowerPC
10017 variant.  The 64-bit environment sets int to 32 bits and long and
10018 pointer to 64 bits, and generates code for PowerPC64, as for
10019 @option{-mpowerpc64}.
10020
10021 @item -mfull-toc
10022 @itemx -mno-fp-in-toc
10023 @itemx -mno-sum-in-toc
10024 @itemx -mminimal-toc
10025 @opindex mfull-toc
10026 @opindex mno-fp-in-toc
10027 @opindex mno-sum-in-toc
10028 @opindex mminimal-toc
10029 Modify generation of the TOC (Table Of Contents), which is created for
10030 every executable file.  The @option{-mfull-toc} option is selected by
10031 default.  In that case, GCC will allocate at least one TOC entry for
10032 each unique non-automatic variable reference in your program.  GCC
10033 will also place floating-point constants in the TOC@.  However, only
10034 16,384 entries are available in the TOC@.
10035
10036 If you receive a linker error message that saying you have overflowed
10037 the available TOC space, you can reduce the amount of TOC space used
10038 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10039 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10040 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10041 generate code to calculate the sum of an address and a constant at
10042 run-time instead of putting that sum into the TOC@.  You may specify one
10043 or both of these options.  Each causes GCC to produce very slightly
10044 slower and larger code at the expense of conserving TOC space.
10045
10046 If you still run out of space in the TOC even when you specify both of
10047 these options, specify @option{-mminimal-toc} instead.  This option causes
10048 GCC to make only one TOC entry for every file.  When you specify this
10049 option, GCC will produce code that is slower and larger but which
10050 uses extremely little TOC space.  You may wish to use this option
10051 only on files that contain less frequently executed code.
10052
10053 @item -maix64
10054 @itemx -maix32
10055 @opindex maix64
10056 @opindex maix32
10057 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10058 @code{long} type, and the infrastructure needed to support them.
10059 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10060 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10061 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10062
10063 @item -mxl-call
10064 @itemx -mno-xl-call
10065 @opindex mxl-call
10066 @opindex mno-xl-call
10067 On AIX, pass floating-point arguments to prototyped functions beyond the
10068 register save area (RSA) on the stack in addition to argument FPRs.  The
10069 AIX calling convention was extended but not initially documented to
10070 handle an obscure K&R C case of calling a function that takes the
10071 address of its arguments with fewer arguments than declared.  AIX XL
10072 compilers access floating point arguments which do not fit in the
10073 RSA from the stack when a subroutine is compiled without
10074 optimization.  Because always storing floating-point arguments on the
10075 stack is inefficient and rarely needed, this option is not enabled by
10076 default and only is necessary when calling subroutines compiled by AIX
10077 XL compilers without optimization.
10078
10079 @item -mpe
10080 @opindex mpe
10081 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10082 application written to use message passing with special startup code to
10083 enable the application to run.  The system must have PE installed in the
10084 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10085 must be overridden with the @option{-specs=} option to specify the
10086 appropriate directory location.  The Parallel Environment does not
10087 support threads, so the @option{-mpe} option and the @option{-pthread}
10088 option are incompatible.
10089
10090 @item -malign-natural
10091 @itemx -malign-power
10092 @opindex malign-natural
10093 @opindex malign-power
10094 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10095 @option{-malign-natural} overrides the ABI-defined alignment of larger
10096 types, such as floating-point doubles, on their natural size-based boundary.
10097 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10098 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
10099
10100 @item -msoft-float
10101 @itemx -mhard-float
10102 @opindex msoft-float
10103 @opindex mhard-float
10104 Generate code that does not use (uses) the floating-point register set.
10105 Software floating point emulation is provided if you use the
10106 @option{-msoft-float} option, and pass the option to GCC when linking.
10107
10108 @item -mmultiple
10109 @itemx -mno-multiple
10110 @opindex mmultiple
10111 @opindex mno-multiple
10112 Generate code that uses (does not use) the load multiple word
10113 instructions and the store multiple word instructions.  These
10114 instructions are generated by default on POWER systems, and not
10115 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10116 endian PowerPC systems, since those instructions do not work when the
10117 processor is in little endian mode.  The exceptions are PPC740 and
10118 PPC750 which permit the instructions usage in little endian mode.
10119
10120 @item -mstring
10121 @itemx -mno-string
10122 @opindex mstring
10123 @opindex mno-string
10124 Generate code that uses (does not use) the load string instructions
10125 and the store string word instructions to save multiple registers and
10126 do small block moves.  These instructions are generated by default on
10127 POWER systems, and not generated on PowerPC systems.  Do not use
10128 @option{-mstring} on little endian PowerPC systems, since those
10129 instructions do not work when the processor is in little endian mode.
10130 The exceptions are PPC740 and PPC750 which permit the instructions
10131 usage in little endian mode.
10132
10133 @item -mupdate
10134 @itemx -mno-update
10135 @opindex mupdate
10136 @opindex mno-update
10137 Generate code that uses (does not use) the load or store instructions
10138 that update the base register to the address of the calculated memory
10139 location.  These instructions are generated by default.  If you use
10140 @option{-mno-update}, there is a small window between the time that the
10141 stack pointer is updated and the address of the previous frame is
10142 stored, which means code that walks the stack frame across interrupts or
10143 signals may get corrupted data.
10144
10145 @item -mfused-madd
10146 @itemx -mno-fused-madd
10147 @opindex mfused-madd
10148 @opindex mno-fused-madd
10149 Generate code that uses (does not use) the floating point multiply and
10150 accumulate instructions.  These instructions are generated by default if
10151 hardware floating is used.
10152
10153 @item -mno-bit-align
10154 @itemx -mbit-align
10155 @opindex mno-bit-align
10156 @opindex mbit-align
10157 On System V.4 and embedded PowerPC systems do not (do) force structures
10158 and unions that contain bit-fields to be aligned to the base type of the
10159 bit-field.
10160
10161 For example, by default a structure containing nothing but 8
10162 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10163 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10164 the structure would be aligned to a 1 byte boundary and be one byte in
10165 size.
10166
10167 @item -mno-strict-align
10168 @itemx -mstrict-align
10169 @opindex mno-strict-align
10170 @opindex mstrict-align
10171 On System V.4 and embedded PowerPC systems do not (do) assume that
10172 unaligned memory references will be handled by the system.
10173
10174 @item -mrelocatable
10175 @itemx -mno-relocatable
10176 @opindex mrelocatable
10177 @opindex mno-relocatable
10178 On embedded PowerPC systems generate code that allows (does not allow)
10179 the program to be relocated to a different address at runtime.  If you
10180 use @option{-mrelocatable} on any module, all objects linked together must
10181 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10182
10183 @item -mrelocatable-lib
10184 @itemx -mno-relocatable-lib
10185 @opindex mrelocatable-lib
10186 @opindex mno-relocatable-lib
10187 On embedded PowerPC systems generate code that allows (does not allow)
10188 the program to be relocated to a different address at runtime.  Modules
10189 compiled with @option{-mrelocatable-lib} can be linked with either modules
10190 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10191 with modules compiled with the @option{-mrelocatable} options.
10192
10193 @item -mno-toc
10194 @itemx -mtoc
10195 @opindex mno-toc
10196 @opindex mtoc
10197 On System V.4 and embedded PowerPC systems do not (do) assume that
10198 register 2 contains a pointer to a global area pointing to the addresses
10199 used in the program.
10200
10201 @item -mlittle
10202 @itemx -mlittle-endian
10203 @opindex mlittle
10204 @opindex mlittle-endian
10205 On System V.4 and embedded PowerPC systems compile code for the
10206 processor in little endian mode.  The @option{-mlittle-endian} option is
10207 the same as @option{-mlittle}.
10208
10209 @item -mbig
10210 @itemx -mbig-endian
10211 @opindex mbig
10212 @opindex mbig-endian
10213 On System V.4 and embedded PowerPC systems compile code for the
10214 processor in big endian mode.  The @option{-mbig-endian} option is
10215 the same as @option{-mbig}.
10216
10217 @item -mdynamic-no-pic
10218 @opindex mdynamic-no-pic
10219 On Darwin and Mac OS X systems, compile code so that it is not
10220 relocatable, but that its external references are relocatable.  The
10221 resulting code is suitable for applications, but not shared
10222 libraries.
10223
10224 @item -mprioritize-restricted-insns=@var{priority}
10225 @opindex mprioritize-restricted-insns
10226 This option controls the priority that is assigned to
10227 dispatch-slot restricted instructions during the second scheduling
10228 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10229 @var{no/highest/second-highest} priority to dispatch slot restricted
10230 instructions.
10231
10232 @item -msched-costly-dep=@var{dependence_type}
10233 @opindex msched-costly-dep
10234 This option controls which dependences are considered costly
10235 by the target during instruction scheduling.  The argument
10236 @var{dependence_type} takes one of the following values:
10237 @var{no}: no dependence is costly,
10238 @var{all}: all dependences are costly,
10239 @var{true_store_to_load}: a true dependence from store to load is costly,
10240 @var{store_to_load}: any dependence from store to load is costly,
10241 @var{number}: any dependence which latency >= @var{number} is costly.
10242
10243 @item -minsert-sched-nops=@var{scheme}
10244 @opindex minsert-sched-nops
10245 This option controls which nop insertion scheme will be used during
10246 the second scheduling pass. The argument @var{scheme} takes one of the
10247 following values:
10248 @var{no}: Don't insert nops.
10249 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10250 according to the scheduler's grouping.
10251 @var{regroup_exact}: Insert nops to force costly dependent insns into
10252 separate groups.  Insert exactly as many nops as needed to force an insn
10253 to a new group, according to the estimated processor grouping.
10254 @var{number}: Insert nops to force costly dependent insns into
10255 separate groups.  Insert @var{number} nops to force an insn to a new group.
10256
10257 @item -mcall-sysv
10258 @opindex mcall-sysv
10259 On System V.4 and embedded PowerPC systems compile code using calling
10260 conventions that adheres to the March 1995 draft of the System V
10261 Application Binary Interface, PowerPC processor supplement.  This is the
10262 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10263
10264 @item -mcall-sysv-eabi
10265 @opindex mcall-sysv-eabi
10266 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10267
10268 @item -mcall-sysv-noeabi
10269 @opindex mcall-sysv-noeabi
10270 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10271
10272 @item -mcall-solaris
10273 @opindex mcall-solaris
10274 On System V.4 and embedded PowerPC systems compile code for the Solaris
10275 operating system.
10276
10277 @item -mcall-linux
10278 @opindex mcall-linux
10279 On System V.4 and embedded PowerPC systems compile code for the
10280 Linux-based GNU system.
10281
10282 @item -mcall-gnu
10283 @opindex mcall-gnu
10284 On System V.4 and embedded PowerPC systems compile code for the
10285 Hurd-based GNU system.
10286
10287 @item -mcall-netbsd
10288 @opindex mcall-netbsd
10289 On System V.4 and embedded PowerPC systems compile code for the
10290 NetBSD operating system.
10291
10292 @item -maix-struct-return
10293 @opindex maix-struct-return
10294 Return all structures in memory (as specified by the AIX ABI)@.
10295
10296 @item -msvr4-struct-return
10297 @opindex msvr4-struct-return
10298 Return structures smaller than 8 bytes in registers (as specified by the
10299 SVR4 ABI)@.
10300
10301 @item -mabi=altivec
10302 @opindex mabi=altivec
10303 Extend the current ABI with AltiVec ABI extensions.  This does not
10304 change the default ABI, instead it adds the AltiVec ABI extensions to
10305 the current ABI@.
10306
10307 @item -mabi=no-altivec
10308 @opindex mabi=no-altivec
10309 Disable AltiVec ABI extensions for the current ABI.
10310
10311 @item -mprototype
10312 @itemx -mno-prototype
10313 @opindex mprototype
10314 @opindex mno-prototype
10315 On System V.4 and embedded PowerPC systems assume that all calls to
10316 variable argument functions are properly prototyped.  Otherwise, the
10317 compiler must insert an instruction before every non prototyped call to
10318 set or clear bit 6 of the condition code register (@var{CR}) to
10319 indicate whether floating point values were passed in the floating point
10320 registers in case the function takes a variable arguments.  With
10321 @option{-mprototype}, only calls to prototyped variable argument functions
10322 will set or clear the bit.
10323
10324 @item -msim
10325 @opindex msim
10326 On embedded PowerPC systems, assume that the startup module is called
10327 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10328 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10329 configurations.
10330
10331 @item -mmvme
10332 @opindex mmvme
10333 On embedded PowerPC systems, assume that the startup module is called
10334 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10335 @file{libc.a}.
10336
10337 @item -mads
10338 @opindex mads
10339 On embedded PowerPC systems, assume that the startup module is called
10340 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10341 @file{libc.a}.
10342
10343 @item -myellowknife
10344 @opindex myellowknife
10345 On embedded PowerPC systems, assume that the startup module is called
10346 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10347 @file{libc.a}.
10348
10349 @item -mvxworks
10350 @opindex mvxworks
10351 On System V.4 and embedded PowerPC systems, specify that you are
10352 compiling for a VxWorks system.
10353
10354 @item -mwindiss
10355 @opindex mwindiss
10356 Specify that you are compiling for the WindISS simulation environment.
10357
10358 @item -memb
10359 @opindex memb
10360 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10361 header to indicate that @samp{eabi} extended relocations are used.
10362
10363 @item -meabi
10364 @itemx -mno-eabi
10365 @opindex meabi
10366 @opindex mno-eabi
10367 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10368 Embedded Applications Binary Interface (eabi) which is a set of
10369 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10370 means that the stack is aligned to an 8 byte boundary, a function
10371 @code{__eabi} is called to from @code{main} to set up the eabi
10372 environment, and the @option{-msdata} option can use both @code{r2} and
10373 @code{r13} to point to two separate small data areas.  Selecting
10374 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10375 do not call an initialization function from @code{main}, and the
10376 @option{-msdata} option will only use @code{r13} to point to a single
10377 small data area.  The @option{-meabi} option is on by default if you
10378 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10379
10380 @item -msdata=eabi
10381 @opindex msdata=eabi
10382 On System V.4 and embedded PowerPC systems, put small initialized
10383 @code{const} global and static data in the @samp{.sdata2} section, which
10384 is pointed to by register @code{r2}.  Put small initialized
10385 non-@code{const} global and static data in the @samp{.sdata} section,
10386 which is pointed to by register @code{r13}.  Put small uninitialized
10387 global and static data in the @samp{.sbss} section, which is adjacent to
10388 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10389 incompatible with the @option{-mrelocatable} option.  The
10390 @option{-msdata=eabi} option also sets the @option{-memb} option.
10391
10392 @item -msdata=sysv
10393 @opindex msdata=sysv
10394 On System V.4 and embedded PowerPC systems, put small global and static
10395 data in the @samp{.sdata} section, which is pointed to by register
10396 @code{r13}.  Put small uninitialized global and static data in the
10397 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10398 The @option{-msdata=sysv} option is incompatible with the
10399 @option{-mrelocatable} option.
10400
10401 @item -msdata=default
10402 @itemx -msdata
10403 @opindex msdata=default
10404 @opindex msdata
10405 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10406 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10407 same as @option{-msdata=sysv}.
10408
10409 @item -msdata-data
10410 @opindex msdata-data
10411 On System V.4 and embedded PowerPC systems, put small global and static
10412 data in the @samp{.sdata} section.  Put small uninitialized global and
10413 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10414 to address small data however.  This is the default behavior unless
10415 other @option{-msdata} options are used.
10416
10417 @item -msdata=none
10418 @itemx -mno-sdata
10419 @opindex msdata=none
10420 @opindex mno-sdata
10421 On embedded PowerPC systems, put all initialized global and static data
10422 in the @samp{.data} section, and all uninitialized data in the
10423 @samp{.bss} section.
10424
10425 @item -G @var{num}
10426 @opindex G
10427 @cindex smaller data references (PowerPC)
10428 @cindex .sdata/.sdata2 references (PowerPC)
10429 On embedded PowerPC systems, put global and static items less than or
10430 equal to @var{num} bytes into the small data or bss sections instead of
10431 the normal data or bss section.  By default, @var{num} is 8.  The
10432 @option{-G @var{num}} switch is also passed to the linker.
10433 All modules should be compiled with the same @option{-G @var{num}} value.
10434
10435 @item -mregnames
10436 @itemx -mno-regnames
10437 @opindex mregnames
10438 @opindex mno-regnames
10439 On System V.4 and embedded PowerPC systems do (do not) emit register
10440 names in the assembly language output using symbolic forms.
10441
10442 @item -mlongcall
10443 @itemx -mno-longcall
10444 @opindex mlongcall
10445 @opindex mno-longcall
10446 Default to making all function calls indirectly, using a register, so
10447 that functions which reside further than 32 megabytes (33,554,432
10448 bytes) from the current location can be called.  This setting can be
10449 overridden by the @code{shortcall} function attribute, or by
10450 @code{#pragma longcall(0)}.
10451
10452 Some linkers are capable of detecting out-of-range calls and generating
10453 glue code on the fly.  On these systems, long calls are unnecessary and
10454 generate slower code.  As of this writing, the AIX linker can do this,
10455 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10456 to the GNU linker for 32-bit PowerPC systems as well.
10457
10458 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10459 callee, L42'', plus a ``branch island'' (glue code).  The two target
10460 addresses represent the callee and the ``branch island.'' The
10461 Darwin/PPC linker will prefer the first address and generate a ``bl
10462 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10463 otherwise, the linker will generate ``bl L42'' to call the ``branch
10464 island.''  The ``branch island'' is appended to the body of the
10465 calling function; it computes the full 32-bit address of the callee
10466 and jumps to it.
10467
10468 On Mach-O (Darwin) systems, this option directs the compiler emit to
10469 the glue for every direct call, and the Darwin linker decides whether
10470 to use or discard it.
10471
10472 In the future, we may cause GCC to ignore all longcall specifications
10473 when the linker is known to generate glue.
10474
10475 @item -pthread
10476 @opindex pthread
10477 Adds support for multithreading with the @dfn{pthreads} library.
10478 This option sets flags for both the preprocessor and linker.
10479
10480 @end table
10481
10482 @node S/390 and zSeries Options
10483 @subsection S/390 and zSeries Options
10484 @cindex S/390 and zSeries Options
10485
10486 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10487
10488 @table @gcctabopt
10489 @item -mhard-float
10490 @itemx -msoft-float
10491 @opindex mhard-float
10492 @opindex msoft-float
10493 Use (do not use) the hardware floating-point instructions and registers
10494 for floating-point operations.  When @option{-msoft-float} is specified,
10495 functions in @file{libgcc.a} will be used to perform floating-point
10496 operations.  When @option{-mhard-float} is specified, the compiler
10497 generates IEEE floating-point instructions.  This is the default.
10498
10499 @item -mbackchain
10500 @itemx -mno-backchain
10501 @itemx -mkernel-backchain
10502 @opindex mbackchain
10503 @opindex mno-backchain
10504 @opindex mkernel-backchain
10505 In order to provide a backchain the address of the caller's frame
10506 is stored within the callee's stack frame.
10507 A backchain may be needed to allow debugging using tools that do not understand
10508 DWARF-2 call frame information.
10509 For @option{-mno-backchain} no backchain is maintained at all which is the 
10510 default. 
10511 If one of the other options is present the backchain pointer is placed either 
10512 on top of the stack frame  (@option{-mkernel-backchain}) or on
10513 the bottom (@option{-mbackchain}).
10514 Beside the different backchain location @option{-mkernel-backchain}
10515 also changes stack frame layout breaking the ABI. This option
10516 is intended to be used for code which internally needs a backchain but has
10517 to get by with a limited stack size e.g. the linux kernel. 
10518 Internal unwinding code not using DWARF-2 info has to be able to locate the
10519 return address of a function. That will be eased be the fact that
10520 the return address of a function is placed two words below the backchain 
10521 pointer.
10522
10523 @item -msmall-exec
10524 @itemx -mno-small-exec
10525 @opindex msmall-exec
10526 @opindex mno-small-exec
10527 Generate (or do not generate) code using the @code{bras} instruction
10528 to do subroutine calls.
10529 This only works reliably if the total executable size does not
10530 exceed 64k.  The default is to use the @code{basr} instruction instead,
10531 which does not have this limitation.
10532
10533 @item -m64
10534 @itemx -m31
10535 @opindex m64
10536 @opindex m31
10537 When @option{-m31} is specified, generate code compliant to the
10538 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10539 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10540 particular to generate 64-bit instructions.  For the @samp{s390}
10541 targets, the default is @option{-m31}, while the @samp{s390x}
10542 targets default to @option{-m64}.
10543
10544 @item -mzarch
10545 @itemx -mesa
10546 @opindex mzarch
10547 @opindex mesa
10548 When @option{-mzarch} is specified, generate code using the
10549 instructions available on z/Architecture.
10550 When @option{-mesa} is specified, generate code using the
10551 instructions available on ESA/390. Note that @option{-mesa} is
10552 not possible with @option{-m64}.
10553 When generating code compliant to the GNU/Linux for S/390 ABI,
10554 the default is @option{-mesa}.  When generating code compliant
10555 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10556
10557 @item -mmvcle
10558 @itemx -mno-mvcle
10559 @opindex mmvcle
10560 @opindex mno-mvcle
10561 Generate (or do not generate) code using the @code{mvcle} instruction
10562 to perform block moves.  When @option{-mno-mvcle} is specified,
10563 use a @code{mvc} loop instead.  This is the default.
10564
10565 @item -mdebug
10566 @itemx -mno-debug
10567 @opindex mdebug
10568 @opindex mno-debug
10569 Print (or do not print) additional debug information when compiling.
10570 The default is to not print debug information.
10571
10572 @item -march=@var{cpu-type}
10573 @opindex march
10574 Generate code that will run on @var{cpu-type}, which is the name of a system
10575 representing a certain processor type. Possible values for
10576 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10577 When generating code using the instructions available on z/Architecture,
10578 the default is @option{-march=z900}.  Otherwise, the default is
10579 @option{-march=g5}.
10580
10581 @item -mtune=@var{cpu-type}
10582 @opindex mtune
10583 Tune to @var{cpu-type} everything applicable about the generated code,
10584 except for the ABI and the set of available instructions.
10585 The list of @var{cpu-type} values is the same as for @option{-march}.
10586 The default is the value used for @option{-march}.
10587
10588 @item -mtpf-trace
10589 @itemx -mno-tpf-trace
10590 @opindex mtpf-trace
10591 @opindex mno-tpf-trace
10592 Generate code that adds (does not add) in TPF OS specific branches to trace
10593 routines in the operating system.  This option is off by default, even
10594 when compiling for the TPF OS.
10595
10596 @item -mfused-madd
10597 @itemx -mno-fused-madd
10598 @opindex mfused-madd
10599 @opindex mno-fused-madd
10600 Generate code that uses (does not use) the floating point multiply and
10601 accumulate instructions.  These instructions are generated by default if
10602 hardware floating point is used.
10603
10604 @item -mwarn-framesize=@var{framesize}
10605 @opindex mwarn-framesize
10606 Emit a warning if the current function exceeds the given frame size.  Because
10607 this is a compile time check it doesn't need to be a real problem when the program
10608 runs.  It is intended to identify functions which most probably cause 
10609 a stack overflow.  It is useful to be used in an environment with limited stack 
10610 size e.g. the linux kernel.
10611
10612 @item -mwarn-dynamicstack
10613 @opindex mwarn-dynamicstack
10614 Emit a warning if the function calls alloca or uses dynamically
10615 sized arrays.  This is generally a bad idea with a limited stack size.
10616
10617 @item -mstack-guard=@var{stack-guard}
10618 @item -mstack-size=@var{stack-size}
10619 @opindex mstack-guard
10620 @opindex mstack-size
10621 These arguments always have to be used in conjunction.  If they are present the s390
10622 back end emits additional instructions in the function prologue which trigger a trap
10623 if the stack size is @var{stack-guard} bytes above the @var{stack-size} 
10624 (remember that the stack on s390 grows downward).  These options are intended to 
10625 be used to help debugging stack overflow problems.  The additionally emitted code 
10626 cause only little overhead and hence can also be used in production like systems 
10627 without greater performance degradation.  The given values have to be exact 
10628 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
10629 In order to be efficient the extra code makes the assumption that the stack starts
10630 at an address aligned to the value given by @var{stack-size}.
10631 @end table
10632
10633 @node SH Options
10634 @subsection SH Options
10635
10636 These @samp{-m} options are defined for the SH implementations:
10637
10638 @table @gcctabopt
10639 @item -m1
10640 @opindex m1
10641 Generate code for the SH1.
10642
10643 @item -m2
10644 @opindex m2
10645 Generate code for the SH2.
10646
10647 @item -m2e
10648 Generate code for the SH2e.
10649
10650 @item -m3
10651 @opindex m3
10652 Generate code for the SH3.
10653
10654 @item -m3e
10655 @opindex m3e
10656 Generate code for the SH3e.
10657
10658 @item -m4-nofpu
10659 @opindex m4-nofpu
10660 Generate code for the SH4 without a floating-point unit.
10661
10662 @item -m4-single-only
10663 @opindex m4-single-only
10664 Generate code for the SH4 with a floating-point unit that only
10665 supports single-precision arithmetic.
10666
10667 @item -m4-single
10668 @opindex m4-single
10669 Generate code for the SH4 assuming the floating-point unit is in
10670 single-precision mode by default.
10671
10672 @item -m4
10673 @opindex m4
10674 Generate code for the SH4.
10675
10676 @item -m4a-nofpu
10677 @opindex m4a-nofpu
10678 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
10679 floating-point unit is not used.
10680
10681 @item -m4a-single-only
10682 @opindex m4a-single-only
10683 Generate code for the SH4a, in such a way that no double-precision
10684 floating point operations are used.
10685
10686 @item -m4a-single
10687 @opindex m4a-single
10688 Generate code for the SH4a assuming the floating-point unit is in
10689 single-precision mode by default.
10690
10691 @item -m4a
10692 @opindex m4a
10693 Generate code for the SH4a.
10694
10695 @item -m4al
10696 @opindex m4al
10697 Same as @option{-m4a-nofpu}, except that it implicitly passes
10698 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
10699 instructions at the moment.
10700
10701 @item -mb
10702 @opindex mb
10703 Compile code for the processor in big endian mode.
10704
10705 @item -ml
10706 @opindex ml
10707 Compile code for the processor in little endian mode.
10708
10709 @item -mdalign
10710 @opindex mdalign
10711 Align doubles at 64-bit boundaries.  Note that this changes the calling
10712 conventions, and thus some functions from the standard C library will
10713 not work unless you recompile it first with @option{-mdalign}.
10714
10715 @item -mrelax
10716 @opindex mrelax
10717 Shorten some address references at link time, when possible; uses the
10718 linker option @option{-relax}.
10719
10720 @item -mbigtable
10721 @opindex mbigtable
10722 Use 32-bit offsets in @code{switch} tables.  The default is to use
10723 16-bit offsets.
10724
10725 @item -mfmovd
10726 @opindex mfmovd
10727 Enable the use of the instruction @code{fmovd}.
10728
10729 @item -mhitachi
10730 @opindex mhitachi
10731 Comply with the calling conventions defined by Renesas.
10732
10733 @item -mrenesas
10734 @opindex mhitachi
10735 Comply with the calling conventions defined by Renesas.
10736
10737 @item -mno-renesas
10738 @opindex mhitachi
10739 Comply with the calling conventions defined for GCC before the Renesas
10740 conventions were available.  This option is the default for all
10741 targets of the SH toolchain except for @samp{sh-symbianelf}.
10742
10743 @item -mnomacsave
10744 @opindex mnomacsave
10745 Mark the @code{MAC} register as call-clobbered, even if
10746 @option{-mhitachi} is given.
10747
10748 @item -mieee
10749 @opindex mieee
10750 Increase IEEE-compliance of floating-point code.
10751
10752 @item -misize
10753 @opindex misize
10754 Dump instruction size and location in the assembly code.
10755
10756 @item -mpadstruct
10757 @opindex mpadstruct
10758 This option is deprecated.  It pads structures to multiple of 4 bytes,
10759 which is incompatible with the SH ABI@.
10760
10761 @item -mspace
10762 @opindex mspace
10763 Optimize for space instead of speed.  Implied by @option{-Os}.
10764
10765 @item -mprefergot
10766 @opindex mprefergot
10767 When generating position-independent code, emit function calls using
10768 the Global Offset Table instead of the Procedure Linkage Table.
10769
10770 @item -musermode
10771 @opindex musermode
10772 Generate a library function call to invalidate instruction cache
10773 entries, after fixing up a trampoline.  This library function call
10774 doesn't assume it can write to the whole memory address space.  This
10775 is the default when the target is @code{sh-*-linux*}.
10776 @end table
10777
10778 @node SPARC Options
10779 @subsection SPARC Options
10780 @cindex SPARC options
10781
10782 These @samp{-m} options are supported on the SPARC:
10783
10784 @table @gcctabopt
10785 @item -mno-app-regs
10786 @itemx -mapp-regs
10787 @opindex mno-app-regs
10788 @opindex mapp-regs
10789 Specify @option{-mapp-regs} to generate output using the global registers
10790 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
10791 is the default.
10792
10793 To be fully SVR4 ABI compliant at the cost of some performance loss,
10794 specify @option{-mno-app-regs}.  You should compile libraries and system
10795 software with this option.
10796
10797 @item -mfpu
10798 @itemx -mhard-float
10799 @opindex mfpu
10800 @opindex mhard-float
10801 Generate output containing floating point instructions.  This is the
10802 default.
10803
10804 @item -mno-fpu
10805 @itemx -msoft-float
10806 @opindex mno-fpu
10807 @opindex msoft-float
10808 Generate output containing library calls for floating point.
10809 @strong{Warning:} the requisite libraries are not available for all SPARC
10810 targets.  Normally the facilities of the machine's usual C compiler are
10811 used, but this cannot be done directly in cross-compilation.  You must make
10812 your own arrangements to provide suitable library functions for
10813 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
10814 @samp{sparclite-*-*} do provide software floating point support.
10815
10816 @option{-msoft-float} changes the calling convention in the output file;
10817 therefore, it is only useful if you compile @emph{all} of a program with
10818 this option.  In particular, you need to compile @file{libgcc.a}, the
10819 library that comes with GCC, with @option{-msoft-float} in order for
10820 this to work.
10821
10822 @item -mhard-quad-float
10823 @opindex mhard-quad-float
10824 Generate output containing quad-word (long double) floating point
10825 instructions.
10826
10827 @item -msoft-quad-float
10828 @opindex msoft-quad-float
10829 Generate output containing library calls for quad-word (long double)
10830 floating point instructions.  The functions called are those specified
10831 in the SPARC ABI@.  This is the default.
10832
10833 As of this writing, there are no SPARC implementations that have hardware
10834 support for the quad-word floating point instructions.  They all invoke
10835 a trap handler for one of these instructions, and then the trap handler
10836 emulates the effect of the instruction.  Because of the trap handler overhead,
10837 this is much slower than calling the ABI library routines.  Thus the
10838 @option{-msoft-quad-float} option is the default.
10839
10840 @item -mno-unaligned-doubles
10841 @itemx -munaligned-doubles
10842 @opindex mno-unaligned-doubles
10843 @opindex munaligned-doubles
10844 Assume that doubles have 8 byte alignment.  This is the default.
10845
10846 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
10847 alignment only if they are contained in another type, or if they have an
10848 absolute address.  Otherwise, it assumes they have 4 byte alignment.
10849 Specifying this option avoids some rare compatibility problems with code
10850 generated by other compilers.  It is not the default because it results
10851 in a performance loss, especially for floating point code.
10852
10853 @item -mno-faster-structs
10854 @itemx -mfaster-structs
10855 @opindex mno-faster-structs
10856 @opindex mfaster-structs
10857 With @option{-mfaster-structs}, the compiler assumes that structures
10858 should have 8 byte alignment.  This enables the use of pairs of
10859 @code{ldd} and @code{std} instructions for copies in structure
10860 assignment, in place of twice as many @code{ld} and @code{st} pairs.
10861 However, the use of this changed alignment directly violates the SPARC
10862 ABI@.  Thus, it's intended only for use on targets where the developer
10863 acknowledges that their resulting code will not be directly in line with
10864 the rules of the ABI@.
10865
10866 @item -mimpure-text
10867 @opindex mimpure-text
10868 @option{-mimpure-text}, used in addition to @option{-shared}, tells
10869 the compiler to not pass @option{-z text} to the linker when linking a
10870 shared object.  Using this option, you can link position-dependent
10871 code into a shared object.
10872
10873 @option{-mimpure-text} suppresses the ``relocations remain against
10874 allocatable but non-writable sections'' linker error message.
10875 However, the necessary relocations will trigger copy-on-write, and the
10876 shared object is not actually shared across processes.  Instead of
10877 using @option{-mimpure-text}, you should compile all source code with
10878 @option{-fpic} or @option{-fPIC}.
10879
10880 This option is only available on SunOS and Solaris.
10881
10882 @item -mcpu=@var{cpu_type}
10883 @opindex mcpu
10884 Set the instruction set, register set, and instruction scheduling parameters
10885 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
10886 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
10887 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
10888 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
10889 @samp{ultrasparc3}.
10890
10891 Default instruction scheduling parameters are used for values that select
10892 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
10893 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
10894
10895 Here is a list of each supported architecture and their supported
10896 implementations.
10897
10898 @smallexample
10899     v7:             cypress
10900     v8:             supersparc, hypersparc
10901     sparclite:      f930, f934, sparclite86x
10902     sparclet:       tsc701
10903     v9:             ultrasparc, ultrasparc3
10904 @end smallexample
10905
10906 By default (unless configured otherwise), GCC generates code for the V7
10907 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
10908 additionally optimizes it for the Cypress CY7C602 chip, as used in the
10909 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
10910 SPARCStation 1, 2, IPX etc.
10911
10912 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
10913 architecture.  The only difference from V7 code is that the compiler emits
10914 the integer multiply and integer divide instructions which exist in SPARC-V8
10915 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
10916 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
10917 2000 series.
10918
10919 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
10920 the SPARC architecture.  This adds the integer multiply, integer divide step
10921 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
10922 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
10923 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
10924 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
10925 MB86934 chip, which is the more recent SPARClite with FPU.
10926
10927 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
10928 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
10929 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
10930 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
10931 optimizes it for the TEMIC SPARClet chip.
10932
10933 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
10934 architecture.  This adds 64-bit integer and floating-point move instructions,
10935 3 additional floating-point condition code registers and conditional move
10936 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
10937 optimizes it for the Sun UltraSPARC I/II chips.  With
10938 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
10939 Sun UltraSPARC III chip.
10940
10941 @item -mtune=@var{cpu_type}
10942 @opindex mtune
10943 Set the instruction scheduling parameters for machine type
10944 @var{cpu_type}, but do not set the instruction set or register set that the
10945 option @option{-mcpu=@var{cpu_type}} would.
10946
10947 The same values for @option{-mcpu=@var{cpu_type}} can be used for
10948 @option{-mtune=@var{cpu_type}}, but the only useful values are those
10949 that select a particular cpu implementation.  Those are @samp{cypress},
10950 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
10951 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
10952 @samp{ultrasparc3}.
10953
10954 @item -mv8plus
10955 @itemx -mno-v8plus
10956 @opindex mv8plus
10957 @opindex mno-v8plus
10958 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
10959 difference from the V8 ABI is that the global and out registers are
10960 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
10961 mode for all SPARC-V9 processors.
10962
10963 @item -mvis
10964 @itemx -mno-vis
10965 @opindex mvis
10966 @opindex mno-vis
10967 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
10968 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
10969 @end table
10970
10971 These @samp{-m} options are supported in addition to the above
10972 on SPARC-V9 processors in 64-bit environments:
10973
10974 @table @gcctabopt
10975 @item -mlittle-endian
10976 @opindex mlittle-endian
10977 Generate code for a processor running in little-endian mode. It is only
10978 available for a few configurations and most notably not on Solaris.
10979
10980 @item -m32
10981 @itemx -m64
10982 @opindex m32
10983 @opindex m64
10984 Generate code for a 32-bit or 64-bit environment.
10985 The 32-bit environment sets int, long and pointer to 32 bits.
10986 The 64-bit environment sets int to 32 bits and long and pointer
10987 to 64 bits.
10988
10989 @item -mcmodel=medlow
10990 @opindex mcmodel=medlow
10991 Generate code for the Medium/Low code model: 64-bit addresses, programs
10992 must be linked in the low 32 bits of memory.  Programs can be statically
10993 or dynamically linked.
10994
10995 @item -mcmodel=medmid
10996 @opindex mcmodel=medmid
10997 Generate code for the Medium/Middle code model: 64-bit addresses, programs
10998 must be linked in the low 44 bits of memory, the text and data segments must
10999 be less than 2GB in size and the data segment must be located within 2GB of
11000 the text segment.
11001
11002 @item -mcmodel=medany
11003 @opindex mcmodel=medany
11004 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11005 may be linked anywhere in memory, the text and data segments must be less
11006 than 2GB in size and the data segment must be located within 2GB of the
11007 text segment.
11008
11009 @item -mcmodel=embmedany
11010 @opindex mcmodel=embmedany
11011 Generate code for the Medium/Anywhere code model for embedded systems:
11012 64-bit addresses, the text and data segments must be less than 2GB in
11013 size, both starting anywhere in memory (determined at link time).  The
11014 global register %g4 points to the base of the data segment.  Programs
11015 are statically linked and PIC is not supported.
11016
11017 @item -mstack-bias
11018 @itemx -mno-stack-bias
11019 @opindex mstack-bias
11020 @opindex mno-stack-bias
11021 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11022 frame pointer if present, are offset by @minus{}2047 which must be added back
11023 when making stack frame references.  This is the default in 64-bit mode.
11024 Otherwise, assume no such offset is present.
11025 @end table
11026
11027 These switches are supported in addition to the above on Solaris:
11028
11029 @table @gcctabopt
11030 @item -threads
11031 @opindex threads
11032 Add support for multithreading using the Solaris threads library.  This
11033 option sets flags for both the preprocessor and linker.  This option does
11034 not affect the thread safety of object code produced by the compiler or
11035 that of libraries supplied with it.
11036
11037 @item -pthreads
11038 @opindex pthreads
11039 Add support for multithreading using the POSIX threads library.  This
11040 option sets flags for both the preprocessor and linker.  This option does
11041 not affect the thread safety of object code produced  by the compiler or
11042 that of libraries supplied with it.
11043 @end table
11044
11045 @node System V Options
11046 @subsection Options for System V
11047
11048 These additional options are available on System V Release 4 for
11049 compatibility with other compilers on those systems:
11050
11051 @table @gcctabopt
11052 @item -G
11053 @opindex G
11054 Create a shared object.
11055 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11056
11057 @item -Qy
11058 @opindex Qy
11059 Identify the versions of each tool used by the compiler, in a
11060 @code{.ident} assembler directive in the output.
11061
11062 @item -Qn
11063 @opindex Qn
11064 Refrain from adding @code{.ident} directives to the output file (this is
11065 the default).
11066
11067 @item -YP,@var{dirs}
11068 @opindex YP
11069 Search the directories @var{dirs}, and no others, for libraries
11070 specified with @option{-l}.
11071
11072 @item -Ym,@var{dir}
11073 @opindex Ym
11074 Look in the directory @var{dir} to find the M4 preprocessor.
11075 The assembler uses this option.
11076 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11077 @c the generic assembler that comes with Solaris takes just -Ym.
11078 @end table
11079
11080 @node TMS320C3x/C4x Options
11081 @subsection TMS320C3x/C4x Options
11082 @cindex TMS320C3x/C4x Options
11083
11084 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11085
11086 @table @gcctabopt
11087
11088 @item -mcpu=@var{cpu_type}
11089 @opindex mcpu
11090 Set the instruction set, register set, and instruction scheduling
11091 parameters for machine type @var{cpu_type}.  Supported values for
11092 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11093 @samp{c44}.  The default is @samp{c40} to generate code for the
11094 TMS320C40.
11095
11096 @item -mbig-memory
11097 @itemx -mbig
11098 @itemx -msmall-memory
11099 @itemx -msmall
11100 @opindex mbig-memory
11101 @opindex mbig
11102 @opindex msmall-memory
11103 @opindex msmall
11104 Generates code for the big or small memory model.  The small memory
11105 model assumed that all data fits into one 64K word page.  At run-time
11106 the data page (DP) register must be set to point to the 64K page
11107 containing the .bss and .data program sections.  The big memory model is
11108 the default and requires reloading of the DP register for every direct
11109 memory access.
11110
11111 @item -mbk
11112 @itemx -mno-bk
11113 @opindex mbk
11114 @opindex mno-bk
11115 Allow (disallow) allocation of general integer operands into the block
11116 count register BK@.
11117
11118 @item -mdb
11119 @itemx -mno-db
11120 @opindex mdb
11121 @opindex mno-db
11122 Enable (disable) generation of code using decrement and branch,
11123 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11124 on the safe side, this is disabled for the C3x, since the maximum
11125 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11126 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11127 that it can utilize the decrement and branch instruction, but will give
11128 up if there is more than one memory reference in the loop.  Thus a loop
11129 where the loop counter is decremented can generate slightly more
11130 efficient code, in cases where the RPTB instruction cannot be utilized.
11131
11132 @item -mdp-isr-reload
11133 @itemx -mparanoid
11134 @opindex mdp-isr-reload
11135 @opindex mparanoid
11136 Force the DP register to be saved on entry to an interrupt service
11137 routine (ISR), reloaded to point to the data section, and restored on
11138 exit from the ISR@.  This should not be required unless someone has
11139 violated the small memory model by modifying the DP register, say within
11140 an object library.
11141
11142 @item -mmpyi
11143 @itemx -mno-mpyi
11144 @opindex mmpyi
11145 @opindex mno-mpyi
11146 For the C3x use the 24-bit MPYI instruction for integer multiplies
11147 instead of a library call to guarantee 32-bit results.  Note that if one
11148 of the operands is a constant, then the multiplication will be performed
11149 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11150 then squaring operations are performed inline instead of a library call.
11151
11152 @item -mfast-fix
11153 @itemx -mno-fast-fix
11154 @opindex mfast-fix
11155 @opindex mno-fast-fix
11156 The C3x/C4x FIX instruction to convert a floating point value to an
11157 integer value chooses the nearest integer less than or equal to the
11158 floating point value rather than to the nearest integer.  Thus if the
11159 floating point number is negative, the result will be incorrectly
11160 truncated an additional code is necessary to detect and correct this
11161 case.  This option can be used to disable generation of the additional
11162 code required to correct the result.
11163
11164 @item -mrptb
11165 @itemx -mno-rptb
11166 @opindex mrptb
11167 @opindex mno-rptb
11168 Enable (disable) generation of repeat block sequences using the RPTB
11169 instruction for zero overhead looping.  The RPTB construct is only used
11170 for innermost loops that do not call functions or jump across the loop
11171 boundaries.  There is no advantage having nested RPTB loops due to the
11172 overhead required to save and restore the RC, RS, and RE registers.
11173 This is enabled by default with @option{-O2}.
11174
11175 @item -mrpts=@var{count}
11176 @itemx -mno-rpts
11177 @opindex mrpts
11178 @opindex mno-rpts
11179 Enable (disable) the use of the single instruction repeat instruction
11180 RPTS@.  If a repeat block contains a single instruction, and the loop
11181 count can be guaranteed to be less than the value @var{count}, GCC will
11182 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11183 then a RPTS will be emitted even if the loop count cannot be determined
11184 at compile time.  Note that the repeated instruction following RPTS does
11185 not have to be reloaded from memory each iteration, thus freeing up the
11186 CPU buses for operands.  However, since interrupts are blocked by this
11187 instruction, it is disabled by default.
11188
11189 @item -mloop-unsigned
11190 @itemx -mno-loop-unsigned
11191 @opindex mloop-unsigned
11192 @opindex mno-loop-unsigned
11193 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11194 is @math{2^{31} + 1} since these instructions test if the iteration count is
11195 negative to terminate the loop.  If the iteration count is unsigned
11196 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11197 exceeded.  This switch allows an unsigned iteration count.
11198
11199 @item -mti
11200 @opindex mti
11201 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11202 with.  This also enforces compatibility with the API employed by the TI
11203 C3x C compiler.  For example, long doubles are passed as structures
11204 rather than in floating point registers.
11205
11206 @item -mregparm
11207 @itemx -mmemparm
11208 @opindex mregparm
11209 @opindex mmemparm
11210 Generate code that uses registers (stack) for passing arguments to functions.
11211 By default, arguments are passed in registers where possible rather
11212 than by pushing arguments on to the stack.
11213
11214 @item -mparallel-insns
11215 @itemx -mno-parallel-insns
11216 @opindex mparallel-insns
11217 @opindex mno-parallel-insns
11218 Allow the generation of parallel instructions.  This is enabled by
11219 default with @option{-O2}.
11220
11221 @item -mparallel-mpy
11222 @itemx -mno-parallel-mpy
11223 @opindex mparallel-mpy
11224 @opindex mno-parallel-mpy
11225 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11226 provided @option{-mparallel-insns} is also specified.  These instructions have
11227 tight register constraints which can pessimize the code generation
11228 of large functions.
11229
11230 @end table
11231
11232 @node V850 Options
11233 @subsection V850 Options
11234 @cindex V850 Options
11235
11236 These @samp{-m} options are defined for V850 implementations:
11237
11238 @table @gcctabopt
11239 @item -mlong-calls
11240 @itemx -mno-long-calls
11241 @opindex mlong-calls
11242 @opindex mno-long-calls
11243 Treat all calls as being far away (near).  If calls are assumed to be
11244 far away, the compiler will always load the functions address up into a
11245 register, and call indirect through the pointer.
11246
11247 @item -mno-ep
11248 @itemx -mep
11249 @opindex mno-ep
11250 @opindex mep
11251 Do not optimize (do optimize) basic blocks that use the same index
11252 pointer 4 or more times to copy pointer into the @code{ep} register, and
11253 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11254 option is on by default if you optimize.
11255
11256 @item -mno-prolog-function
11257 @itemx -mprolog-function
11258 @opindex mno-prolog-function
11259 @opindex mprolog-function
11260 Do not use (do use) external functions to save and restore registers
11261 at the prologue and epilogue of a function.  The external functions
11262 are slower, but use less code space if more than one function saves
11263 the same number of registers.  The @option{-mprolog-function} option
11264 is on by default if you optimize.
11265
11266 @item -mspace
11267 @opindex mspace
11268 Try to make the code as small as possible.  At present, this just turns
11269 on the @option{-mep} and @option{-mprolog-function} options.
11270
11271 @item -mtda=@var{n}
11272 @opindex mtda
11273 Put static or global variables whose size is @var{n} bytes or less into
11274 the tiny data area that register @code{ep} points to.  The tiny data
11275 area can hold up to 256 bytes in total (128 bytes for byte references).
11276
11277 @item -msda=@var{n}
11278 @opindex msda
11279 Put static or global variables whose size is @var{n} bytes or less into
11280 the small data area that register @code{gp} points to.  The small data
11281 area can hold up to 64 kilobytes.
11282
11283 @item -mzda=@var{n}
11284 @opindex mzda
11285 Put static or global variables whose size is @var{n} bytes or less into
11286 the first 32 kilobytes of memory.
11287
11288 @item -mv850
11289 @opindex mv850
11290 Specify that the target processor is the V850.
11291
11292 @item -mbig-switch
11293 @opindex mbig-switch
11294 Generate code suitable for big switch tables.  Use this option only if
11295 the assembler/linker complain about out of range branches within a switch
11296 table.
11297
11298 @item -mapp-regs
11299 @opindex mapp-regs
11300 This option will cause r2 and r5 to be used in the code generated by
11301 the compiler.  This setting is the default.
11302
11303 @item -mno-app-regs
11304 @opindex mno-app-regs
11305 This option will cause r2 and r5 to be treated as fixed registers.
11306
11307 @item -mv850e1
11308 @opindex mv850e1
11309 Specify that the target processor is the V850E1.  The preprocessor
11310 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11311 this option is used.
11312
11313 @item -mv850e
11314 @opindex mv850e
11315 Specify that the target processor is the V850E.  The preprocessor
11316 constant @samp{__v850e__} will be defined if this option is used.
11317
11318 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11319 are defined then a default target processor will be chosen and the
11320 relevant @samp{__v850*__} preprocessor constant will be defined.
11321
11322 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11323 defined, regardless of which processor variant is the target.
11324
11325 @item -mdisable-callt
11326 @opindex mdisable-callt
11327 This option will suppress generation of the CALLT instruction for the
11328 v850e and v850e1 flavors of the v850 architecture.  The default is
11329 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11330
11331 @end table
11332
11333 @node VAX Options
11334 @subsection VAX Options
11335 @cindex VAX options
11336
11337 These @samp{-m} options are defined for the VAX:
11338
11339 @table @gcctabopt
11340 @item -munix
11341 @opindex munix
11342 Do not output certain jump instructions (@code{aobleq} and so on)
11343 that the Unix assembler for the VAX cannot handle across long
11344 ranges.
11345
11346 @item -mgnu
11347 @opindex mgnu
11348 Do output those jump instructions, on the assumption that you
11349 will assemble with the GNU assembler.
11350
11351 @item -mg
11352 @opindex mg
11353 Output code for g-format floating point numbers instead of d-format.
11354 @end table
11355
11356 @node x86-64 Options
11357 @subsection x86-64 Options
11358 @cindex x86-64 options
11359
11360 These are listed under @xref{i386 and x86-64 Options}.
11361
11362 @node Xstormy16 Options
11363 @subsection Xstormy16 Options
11364 @cindex Xstormy16 Options
11365
11366 These options are defined for Xstormy16:
11367
11368 @table @gcctabopt
11369 @item -msim
11370 @opindex msim
11371 Choose startup files and linker script suitable for the simulator.
11372 @end table
11373
11374 @node Xtensa Options
11375 @subsection Xtensa Options
11376 @cindex Xtensa Options
11377
11378 These options are supported for Xtensa targets:
11379
11380 @table @gcctabopt
11381 @item -mconst16
11382 @itemx -mno-const16
11383 @opindex mconst16
11384 @opindex mno-const16
11385 Enable or disable use of @code{CONST16} instructions for loading
11386 constant values.  The @code{CONST16} instruction is currently not a
11387 standard option from Tensilica.  When enabled, @code{CONST16}
11388 instructions are always used in place of the standard @code{L32R}
11389 instructions.  The use of @code{CONST16} is enabled by default only if
11390 the @code{L32R} instruction is not available.
11391
11392 @item -mfused-madd
11393 @itemx -mno-fused-madd
11394 @opindex mfused-madd
11395 @opindex mno-fused-madd
11396 Enable or disable use of fused multiply/add and multiply/subtract
11397 instructions in the floating-point option.  This has no effect if the
11398 floating-point option is not also enabled.  Disabling fused multiply/add
11399 and multiply/subtract instructions forces the compiler to use separate
11400 instructions for the multiply and add/subtract operations.  This may be
11401 desirable in some cases where strict IEEE 754-compliant results are
11402 required: the fused multiply add/subtract instructions do not round the
11403 intermediate result, thereby producing results with @emph{more} bits of
11404 precision than specified by the IEEE standard.  Disabling fused multiply
11405 add/subtract instructions also ensures that the program output is not
11406 sensitive to the compiler's ability to combine multiply and add/subtract
11407 operations.
11408
11409 @item -mtext-section-literals
11410 @itemx -mno-text-section-literals
11411 @opindex mtext-section-literals
11412 @opindex mno-text-section-literals
11413 Control the treatment of literal pools.  The default is
11414 @option{-mno-text-section-literals}, which places literals in a separate
11415 section in the output file.  This allows the literal pool to be placed
11416 in a data RAM/ROM, and it also allows the linker to combine literal
11417 pools from separate object files to remove redundant literals and
11418 improve code size.  With @option{-mtext-section-literals}, the literals
11419 are interspersed in the text section in order to keep them as close as
11420 possible to their references.  This may be necessary for large assembly
11421 files.
11422
11423 @item -mtarget-align
11424 @itemx -mno-target-align
11425 @opindex mtarget-align
11426 @opindex mno-target-align
11427 When this option is enabled, GCC instructs the assembler to
11428 automatically align instructions to reduce branch penalties at the
11429 expense of some code density.  The assembler attempts to widen density
11430 instructions to align branch targets and the instructions following call
11431 instructions.  If there are not enough preceding safe density
11432 instructions to align a target, no widening will be performed.  The
11433 default is @option{-mtarget-align}.  These options do not affect the
11434 treatment of auto-aligned instructions like @code{LOOP}, which the
11435 assembler will always align, either by widening density instructions or
11436 by inserting no-op instructions.
11437
11438 @item -mlongcalls
11439 @itemx -mno-longcalls
11440 @opindex mlongcalls
11441 @opindex mno-longcalls
11442 When this option is enabled, GCC instructs the assembler to translate
11443 direct calls to indirect calls unless it can determine that the target
11444 of a direct call is in the range allowed by the call instruction.  This
11445 translation typically occurs for calls to functions in other source
11446 files.  Specifically, the assembler translates a direct @code{CALL}
11447 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11448 The default is @option{-mno-longcalls}.  This option should be used in
11449 programs where the call target can potentially be out of range.  This
11450 option is implemented in the assembler, not the compiler, so the
11451 assembly code generated by GCC will still show direct call
11452 instructions---look at the disassembled object code to see the actual
11453 instructions.  Note that the assembler will use an indirect call for
11454 every cross-file call, not just those that really will be out of range.
11455 @end table
11456
11457 @node zSeries Options
11458 @subsection zSeries Options
11459 @cindex zSeries options
11460
11461 These are listed under @xref{S/390 and zSeries Options}.
11462
11463 @node Code Gen Options
11464 @section Options for Code Generation Conventions
11465 @cindex code generation conventions
11466 @cindex options, code generation
11467 @cindex run-time options
11468
11469 These machine-independent options control the interface conventions
11470 used in code generation.
11471
11472 Most of them have both positive and negative forms; the negative form
11473 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11474 one of the forms is listed---the one which is not the default.  You
11475 can figure out the other form by either removing @samp{no-} or adding
11476 it.
11477
11478 @table @gcctabopt
11479 @item -fbounds-check
11480 @opindex fbounds-check
11481 For front-ends that support it, generate additional code to check that
11482 indices used to access arrays are within the declared range.  This is
11483 currently only supported by the Java and Fortran 77 front-ends, where
11484 this option defaults to true and false respectively.
11485
11486 @item -ftrapv
11487 @opindex ftrapv
11488 This option generates traps for signed overflow on addition, subtraction,
11489 multiplication operations.
11490
11491 @item -fwrapv
11492 @opindex fwrapv
11493 This option instructs the compiler to assume that signed arithmetic
11494 overflow of addition, subtraction and multiplication wraps around
11495 using twos-complement representation.  This flag enables some optimizations
11496 and disables other.  This option is enabled by default for the Java
11497 front-end, as required by the Java language specification.
11498
11499 @item -fexceptions
11500 @opindex fexceptions
11501 Enable exception handling.  Generates extra code needed to propagate
11502 exceptions.  For some targets, this implies GCC will generate frame
11503 unwind information for all functions, which can produce significant data
11504 size overhead, although it does not affect execution.  If you do not
11505 specify this option, GCC will enable it by default for languages like
11506 C++ which normally require exception handling, and disable it for
11507 languages like C that do not normally require it.  However, you may need
11508 to enable this option when compiling C code that needs to interoperate
11509 properly with exception handlers written in C++.  You may also wish to
11510 disable this option if you are compiling older C++ programs that don't
11511 use exception handling.
11512
11513 @item -fnon-call-exceptions
11514 @opindex fnon-call-exceptions
11515 Generate code that allows trapping instructions to throw exceptions.
11516 Note that this requires platform-specific runtime support that does
11517 not exist everywhere.  Moreover, it only allows @emph{trapping}
11518 instructions to throw exceptions, i.e.@: memory references or floating
11519 point instructions.  It does not allow exceptions to be thrown from
11520 arbitrary signal handlers such as @code{SIGALRM}.
11521
11522 @item -funwind-tables
11523 @opindex funwind-tables
11524 Similar to @option{-fexceptions}, except that it will just generate any needed
11525 static data, but will not affect the generated code in any other way.
11526 You will normally not enable this option; instead, a language processor
11527 that needs this handling would enable it on your behalf.
11528
11529 @item -fasynchronous-unwind-tables
11530 @opindex fasynchronous-unwind-tables
11531 Generate unwind table in dwarf2 format, if supported by target machine.  The
11532 table is exact at each instruction boundary, so it can be used for stack
11533 unwinding from asynchronous events (such as debugger or garbage collector).
11534
11535 @item -fpcc-struct-return
11536 @opindex fpcc-struct-return
11537 Return ``short'' @code{struct} and @code{union} values in memory like
11538 longer ones, rather than in registers.  This convention is less
11539 efficient, but it has the advantage of allowing intercallability between
11540 GCC-compiled files and files compiled with other compilers, particularly
11541 the Portable C Compiler (pcc).
11542
11543 The precise convention for returning structures in memory depends
11544 on the target configuration macros.
11545
11546 Short structures and unions are those whose size and alignment match
11547 that of some integer type.
11548
11549 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11550 switch is not binary compatible with code compiled with the
11551 @option{-freg-struct-return} switch.
11552 Use it to conform to a non-default application binary interface.
11553
11554 @item -freg-struct-return
11555 @opindex freg-struct-return
11556 Return @code{struct} and @code{union} values in registers when possible.
11557 This is more efficient for small structures than
11558 @option{-fpcc-struct-return}.
11559
11560 If you specify neither @option{-fpcc-struct-return} nor
11561 @option{-freg-struct-return}, GCC defaults to whichever convention is
11562 standard for the target.  If there is no standard convention, GCC
11563 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11564 the principal compiler.  In those cases, we can choose the standard, and
11565 we chose the more efficient register return alternative.
11566
11567 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11568 switch is not binary compatible with code compiled with the
11569 @option{-fpcc-struct-return} switch.
11570 Use it to conform to a non-default application binary interface.
11571
11572 @item -fshort-enums
11573 @opindex fshort-enums
11574 Allocate to an @code{enum} type only as many bytes as it needs for the
11575 declared range of possible values.  Specifically, the @code{enum} type
11576 will be equivalent to the smallest integer type which has enough room.
11577
11578 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11579 code that is not binary compatible with code generated without that switch.
11580 Use it to conform to a non-default application binary interface.
11581
11582 @item -fshort-double
11583 @opindex fshort-double
11584 Use the same size for @code{double} as for @code{float}.
11585
11586 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11587 code that is not binary compatible with code generated without that switch.
11588 Use it to conform to a non-default application binary interface.
11589
11590 @item -fshort-wchar
11591 @opindex fshort-wchar
11592 Override the underlying type for @samp{wchar_t} to be @samp{short
11593 unsigned int} instead of the default for the target.  This option is
11594 useful for building programs to run under WINE@.
11595
11596 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11597 code that is not binary compatible with code generated without that switch.
11598 Use it to conform to a non-default application binary interface.
11599
11600 @item -fshared-data
11601 @opindex fshared-data
11602 Requests that the data and non-@code{const} variables of this
11603 compilation be shared data rather than private data.  The distinction
11604 makes sense only on certain operating systems, where shared data is
11605 shared between processes running the same program, while private data
11606 exists in one copy per process.
11607
11608 @item -fno-common
11609 @opindex fno-common
11610 In C, allocate even uninitialized global variables in the data section of the
11611 object file, rather than generating them as common blocks.  This has the
11612 effect that if the same variable is declared (without @code{extern}) in
11613 two different compilations, you will get an error when you link them.
11614 The only reason this might be useful is if you wish to verify that the
11615 program will work on other systems which always work this way.
11616
11617 @item -fno-ident
11618 @opindex fno-ident
11619 Ignore the @samp{#ident} directive.
11620
11621 @item -finhibit-size-directive
11622 @opindex finhibit-size-directive
11623 Don't output a @code{.size} assembler directive, or anything else that
11624 would cause trouble if the function is split in the middle, and the
11625 two halves are placed at locations far apart in memory.  This option is
11626 used when compiling @file{crtstuff.c}; you should not need to use it
11627 for anything else.
11628
11629 @item -fverbose-asm
11630 @opindex fverbose-asm
11631 Put extra commentary information in the generated assembly code to
11632 make it more readable.  This option is generally only of use to those
11633 who actually need to read the generated assembly code (perhaps while
11634 debugging the compiler itself).
11635
11636 @option{-fno-verbose-asm}, the default, causes the
11637 extra information to be omitted and is useful when comparing two assembler
11638 files.
11639
11640 @item -fpic
11641 @opindex fpic
11642 @cindex global offset table
11643 @cindex PIC
11644 Generate position-independent code (PIC) suitable for use in a shared
11645 library, if supported for the target machine.  Such code accesses all
11646 constant addresses through a global offset table (GOT)@.  The dynamic
11647 loader resolves the GOT entries when the program starts (the dynamic
11648 loader is not part of GCC; it is part of the operating system).  If
11649 the GOT size for the linked executable exceeds a machine-specific
11650 maximum size, you get an error message from the linker indicating that
11651 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11652 instead.  (These maximums are 8k on the SPARC and 32k
11653 on the m68k and RS/6000.  The 386 has no such limit.)
11654
11655 Position-independent code requires special support, and therefore works
11656 only on certain machines.  For the 386, GCC supports PIC for System V
11657 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11658 position-independent.
11659
11660 @item -fPIC
11661 @opindex fPIC
11662 If supported for the target machine, emit position-independent code,
11663 suitable for dynamic linking and avoiding any limit on the size of the
11664 global offset table.  This option makes a difference on the m68k
11665 and the SPARC.
11666
11667 Position-independent code requires special support, and therefore works
11668 only on certain machines.
11669
11670 @item -fpie
11671 @itemx -fPIE
11672 @opindex fpie
11673 @opindex fPIE
11674 These options are similar to @option{-fpic} and @option{-fPIC}, but
11675 generated position independent code can be only linked into executables.
11676 Usually these options are used when @option{-pie} GCC option will be
11677 used during linking.
11678
11679 @item -ffixed-@var{reg}
11680 @opindex ffixed
11681 Treat the register named @var{reg} as a fixed register; generated code
11682 should never refer to it (except perhaps as a stack pointer, frame
11683 pointer or in some other fixed role).
11684
11685 @var{reg} must be the name of a register.  The register names accepted
11686 are machine-specific and are defined in the @code{REGISTER_NAMES}
11687 macro in the machine description macro file.
11688
11689 This flag does not have a negative form, because it specifies a
11690 three-way choice.
11691
11692 @item -fcall-used-@var{reg}
11693 @opindex fcall-used
11694 Treat the register named @var{reg} as an allocable register that is
11695 clobbered by function calls.  It may be allocated for temporaries or
11696 variables that do not live across a call.  Functions compiled this way
11697 will not save and restore the register @var{reg}.
11698
11699 It is an error to used this flag with the frame pointer or stack pointer.
11700 Use of this flag for other registers that have fixed pervasive roles in
11701 the machine's execution model will produce disastrous results.
11702
11703 This flag does not have a negative form, because it specifies a
11704 three-way choice.
11705
11706 @item -fcall-saved-@var{reg}
11707 @opindex fcall-saved
11708 Treat the register named @var{reg} as an allocable register saved by
11709 functions.  It may be allocated even for temporaries or variables that
11710 live across a call.  Functions compiled this way will save and restore
11711 the register @var{reg} if they use it.
11712
11713 It is an error to used this flag with the frame pointer or stack pointer.
11714 Use of this flag for other registers that have fixed pervasive roles in
11715 the machine's execution model will produce disastrous results.
11716
11717 A different sort of disaster will result from the use of this flag for
11718 a register in which function values may be returned.
11719
11720 This flag does not have a negative form, because it specifies a
11721 three-way choice.
11722
11723 @item -fpack-struct
11724 @opindex fpack-struct
11725 Pack all structure members together without holes.
11726
11727 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11728 code that is not binary compatible with code generated without that switch.
11729 Additionally, it makes the code suboptimal.
11730 Use it to conform to a non-default application binary interface.
11731
11732 @item -finstrument-functions
11733 @opindex finstrument-functions
11734 Generate instrumentation calls for entry and exit to functions.  Just
11735 after function entry and just before function exit, the following
11736 profiling functions will be called with the address of the current
11737 function and its call site.  (On some platforms,
11738 @code{__builtin_return_address} does not work beyond the current
11739 function, so the call site information may not be available to the
11740 profiling functions otherwise.)
11741
11742 @smallexample
11743 void __cyg_profile_func_enter (void *this_fn,
11744                                void *call_site);
11745 void __cyg_profile_func_exit  (void *this_fn,
11746                                void *call_site);
11747 @end smallexample
11748
11749 The first argument is the address of the start of the current function,
11750 which may be looked up exactly in the symbol table.
11751
11752 This instrumentation is also done for functions expanded inline in other
11753 functions.  The profiling calls will indicate where, conceptually, the
11754 inline function is entered and exited.  This means that addressable
11755 versions of such functions must be available.  If all your uses of a
11756 function are expanded inline, this may mean an additional expansion of
11757 code size.  If you use @samp{extern inline} in your C code, an
11758 addressable version of such functions must be provided.  (This is
11759 normally the case anyways, but if you get lucky and the optimizer always
11760 expands the functions inline, you might have gotten away without
11761 providing static copies.)
11762
11763 A function may be given the attribute @code{no_instrument_function}, in
11764 which case this instrumentation will not be done.  This can be used, for
11765 example, for the profiling functions listed above, high-priority
11766 interrupt routines, and any functions from which the profiling functions
11767 cannot safely be called (perhaps signal handlers, if the profiling
11768 routines generate output or allocate memory).
11769
11770 @item -fstack-check
11771 @opindex fstack-check
11772 Generate code to verify that you do not go beyond the boundary of the
11773 stack.  You should specify this flag if you are running in an
11774 environment with multiple threads, but only rarely need to specify it in
11775 a single-threaded environment since stack overflow is automatically
11776 detected on nearly all systems if there is only one stack.
11777
11778 Note that this switch does not actually cause checking to be done; the
11779 operating system must do that.  The switch causes generation of code
11780 to ensure that the operating system sees the stack being extended.
11781
11782 @item -fstack-limit-register=@var{reg}
11783 @itemx -fstack-limit-symbol=@var{sym}
11784 @itemx -fno-stack-limit
11785 @opindex fstack-limit-register
11786 @opindex fstack-limit-symbol
11787 @opindex fno-stack-limit
11788 Generate code to ensure that the stack does not grow beyond a certain value,
11789 either the value of a register or the address of a symbol.  If the stack
11790 would grow beyond the value, a signal is raised.  For most targets,
11791 the signal is raised before the stack overruns the boundary, so
11792 it is possible to catch the signal without taking special precautions.
11793
11794 For instance, if the stack starts at absolute address @samp{0x80000000}
11795 and grows downwards, you can use the flags
11796 @option{-fstack-limit-symbol=__stack_limit} and
11797 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11798 of 128KB@.  Note that this may only work with the GNU linker.
11799
11800 @cindex aliasing of parameters
11801 @cindex parameters, aliased
11802 @item -fargument-alias
11803 @itemx -fargument-noalias
11804 @itemx -fargument-noalias-global
11805 @opindex fargument-alias
11806 @opindex fargument-noalias
11807 @opindex fargument-noalias-global
11808 Specify the possible relationships among parameters and between
11809 parameters and global data.
11810
11811 @option{-fargument-alias} specifies that arguments (parameters) may
11812 alias each other and may alias global storage.@*
11813 @option{-fargument-noalias} specifies that arguments do not alias
11814 each other, but may alias global storage.@*
11815 @option{-fargument-noalias-global} specifies that arguments do not
11816 alias each other and do not alias global storage.
11817
11818 Each language will automatically use whatever option is required by
11819 the language standard.  You should not need to use these options yourself.
11820
11821 @item -fleading-underscore
11822 @opindex fleading-underscore
11823 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11824 change the way C symbols are represented in the object file.  One use
11825 is to help link with legacy assembly code.
11826
11827 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11828 generate code that is not binary compatible with code generated without that
11829 switch.  Use it to conform to a non-default application binary interface.
11830 Not all targets provide complete support for this switch.
11831
11832 @item -ftls-model=@var{model}
11833 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11834 The @var{model} argument should be one of @code{global-dynamic},
11835 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11836
11837 The default without @option{-fpic} is @code{initial-exec}; with
11838 @option{-fpic} the default is @code{global-dynamic}.
11839
11840 @item -fvisibility=@var{default|internal|hidden|protected}
11841 @opindex fvisibility
11842 Set the default ELF image symbol visibility to the specified option - all
11843 symbols will be marked with this unless overrided within the code.
11844 Using this feature can very substantially improve linking and
11845 load times of shared object libraries, produce more optimised
11846 code, provide near-perfect API export and prevent symbol clashes.
11847 It is @strong{strongly} recommended that you use this in any shared objects
11848 you distribute.
11849      
11850 Despite the nomenclature, @code{default} always means public ie;
11851 available to be linked against from outside the shared object.
11852 @code{protected} and @code{internal} are pretty useless in real-world
11853 usage so the only other commonly used option will be @code{hidden}.
11854 The default if -fvisibility isn't specified is @code{default} ie; make every
11855 symbol public - this causes the same behaviour as previous versions of
11856 GCC.
11857      
11858 A good explanation of the benefits offered by ensuring ELF
11859 symbols have the correct visibility is given by ``How To Write
11860 Shared Libraries'' by Ulrich Drepper (which can be found at
11861 @w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
11862 solution made possible by this option to marking things hidden when
11863 the default is public is to make the default hidden and mark things
11864 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
11865 and @code{__attribute__ ((visibility("default")))} instead of
11866 @code{__declspec(dllexport)} you get almost identical semantics with
11867 identical syntax. This is a great boon to those working with
11868 cross-platform projects.
11869
11870 For those adding visibility support to existing code, you may find
11871 @samp{#pragma GCC visibility} of use. This works by you enclosing
11872 the declarations you wish to set visibility for with (for example)
11873 @samp{#pragma GCC visibility push(hidden)} and
11874 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
11875 times. Bear in mind that symbol visibility should be viewed @strong{as
11876 part of the API interface contract} and thus all new code should
11877 always specify visibility when it is not the default ie; declarations
11878 only for use within the local DSO should @strong{always} be marked explicitly
11879 as hidden as so to avoid PLT indirection overheads - making this
11880 abundantly clear also aids readability and self-documentation of the code.
11881 Note that due to ISO C++ specification requirements, operator new and
11882 operator delete must always be of default visibility.
11883
11884 An overview of these techniques, their benefits and how to use them
11885 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
11886
11887 @end table
11888
11889 @c man end
11890
11891 @node Environment Variables
11892 @section Environment Variables Affecting GCC
11893 @cindex environment variables
11894
11895 @c man begin ENVIRONMENT
11896 This section describes several environment variables that affect how GCC
11897 operates.  Some of them work by specifying directories or prefixes to use
11898 when searching for various kinds of files.  Some are used to specify other
11899 aspects of the compilation environment.
11900
11901 Note that you can also specify places to search using options such as
11902 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11903 take precedence over places specified using environment variables, which
11904 in turn take precedence over those specified by the configuration of GCC@.
11905 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11906 GNU Compiler Collection (GCC) Internals}.
11907
11908 @table @env
11909 @item LANG
11910 @itemx LC_CTYPE
11911 @c @itemx LC_COLLATE
11912 @itemx LC_MESSAGES
11913 @c @itemx LC_MONETARY
11914 @c @itemx LC_NUMERIC
11915 @c @itemx LC_TIME
11916 @itemx LC_ALL
11917 @findex LANG
11918 @findex LC_CTYPE
11919 @c @findex LC_COLLATE
11920 @findex LC_MESSAGES
11921 @c @findex LC_MONETARY
11922 @c @findex LC_NUMERIC
11923 @c @findex LC_TIME
11924 @findex LC_ALL
11925 @cindex locale
11926 These environment variables control the way that GCC uses
11927 localization information that allow GCC to work with different
11928 national conventions.  GCC inspects the locale categories
11929 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11930 so.  These locale categories can be set to any value supported by your
11931 installation.  A typical value is @samp{en_UK} for English in the United
11932 Kingdom.
11933
11934 The @env{LC_CTYPE} environment variable specifies character
11935 classification.  GCC uses it to determine the character boundaries in
11936 a string; this is needed for some multibyte encodings that contain quote
11937 and escape characters that would otherwise be interpreted as a string
11938 end or escape.
11939
11940 The @env{LC_MESSAGES} environment variable specifies the language to
11941 use in diagnostic messages.
11942
11943 If the @env{LC_ALL} environment variable is set, it overrides the value
11944 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11945 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11946 environment variable.  If none of these variables are set, GCC
11947 defaults to traditional C English behavior.
11948
11949 @item TMPDIR
11950 @findex TMPDIR
11951 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11952 files.  GCC uses temporary files to hold the output of one stage of
11953 compilation which is to be used as input to the next stage: for example,
11954 the output of the preprocessor, which is the input to the compiler
11955 proper.
11956
11957 @item GCC_EXEC_PREFIX
11958 @findex GCC_EXEC_PREFIX
11959 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11960 names of the subprograms executed by the compiler.  No slash is added
11961 when this prefix is combined with the name of a subprogram, but you can
11962 specify a prefix that ends with a slash if you wish.
11963
11964 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11965 an appropriate prefix to use based on the pathname it was invoked with.
11966
11967 If GCC cannot find the subprogram using the specified prefix, it
11968 tries looking in the usual places for the subprogram.
11969
11970 The default value of @env{GCC_EXEC_PREFIX} is
11971 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11972 of @code{prefix} when you ran the @file{configure} script.
11973
11974 Other prefixes specified with @option{-B} take precedence over this prefix.
11975
11976 This prefix is also used for finding files such as @file{crt0.o} that are
11977 used for linking.
11978
11979 In addition, the prefix is used in an unusual way in finding the
11980 directories to search for header files.  For each of the standard
11981 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11982 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11983 replacing that beginning with the specified prefix to produce an
11984 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11985 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11986 These alternate directories are searched first; the standard directories
11987 come next.
11988
11989 @item COMPILER_PATH
11990 @findex COMPILER_PATH
11991 The value of @env{COMPILER_PATH} is a colon-separated list of
11992 directories, much like @env{PATH}.  GCC tries the directories thus
11993 specified when searching for subprograms, if it can't find the
11994 subprograms using @env{GCC_EXEC_PREFIX}.
11995
11996 @item LIBRARY_PATH
11997 @findex LIBRARY_PATH
11998 The value of @env{LIBRARY_PATH} is a colon-separated list of
11999 directories, much like @env{PATH}.  When configured as a native compiler,
12000 GCC tries the directories thus specified when searching for special
12001 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12002 using GCC also uses these directories when searching for ordinary
12003 libraries for the @option{-l} option (but directories specified with
12004 @option{-L} come first).
12005
12006 @item LANG
12007 @findex LANG
12008 @cindex locale definition
12009 This variable is used to pass locale information to the compiler.  One way in
12010 which this information is used is to determine the character set to be used
12011 when character literals, string literals and comments are parsed in C and C++.
12012 When the compiler is configured to allow multibyte characters,
12013 the following values for @env{LANG} are recognized:
12014
12015 @table @samp
12016 @item C-JIS
12017 Recognize JIS characters.
12018 @item C-SJIS
12019 Recognize SJIS characters.
12020 @item C-EUCJP
12021 Recognize EUCJP characters.
12022 @end table
12023
12024 If @env{LANG} is not defined, or if it has some other value, then the
12025 compiler will use mblen and mbtowc as defined by the default locale to
12026 recognize and translate multibyte characters.
12027 @end table
12028
12029 @noindent
12030 Some additional environments variables affect the behavior of the
12031 preprocessor.
12032
12033 @include cppenv.texi
12034
12035 @c man end
12036
12037 @node Precompiled Headers
12038 @section Using Precompiled Headers
12039 @cindex precompiled headers
12040 @cindex speed of compilation
12041
12042 Often large projects have many header files that are included in every
12043 source file.  The time the compiler takes to process these header files
12044 over and over again can account for nearly all of the time required to
12045 build the project.  To make builds faster, GCC allows users to
12046 `precompile' a header file; then, if builds can use the precompiled
12047 header file they will be much faster.
12048
12049 @strong{Caution:} There are a few known situations where GCC will
12050 crash when trying to use a precompiled header.  If you have trouble
12051 with a precompiled header, you should remove the precompiled header
12052 and compile without it.  In addition, please use GCC's on-line
12053 defect-tracking system to report any problems you encounter with
12054 precompiled headers.  @xref{Bugs}.
12055
12056 To create a precompiled header file, simply compile it as you would any
12057 other file, if necessary using the @option{-x} option to make the driver
12058 treat it as a C or C++ header file.  You will probably want to use a
12059 tool like @command{make} to keep the precompiled header up-to-date when
12060 the headers it contains change.
12061
12062 A precompiled header file will be searched for when @code{#include} is
12063 seen in the compilation.  As it searches for the included file
12064 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12065 compiler looks for a precompiled header in each directory just before it
12066 looks for the include file in that directory.  The name searched for is
12067 the name specified in the @code{#include} with @samp{.gch} appended.  If
12068 the precompiled header file can't be used, it is ignored.
12069
12070 For instance, if you have @code{#include "all.h"}, and you have
12071 @file{all.h.gch} in the same directory as @file{all.h}, then the
12072 precompiled header file will be used if possible, and the original
12073 header will be used otherwise.
12074
12075 Alternatively, you might decide to put the precompiled header file in a
12076 directory and use @option{-I} to ensure that directory is searched
12077 before (or instead of) the directory containing the original header.
12078 Then, if you want to check that the precompiled header file is always
12079 used, you can put a file of the same name as the original header in this
12080 directory containing an @code{#error} command.
12081
12082 This also works with @option{-include}.  So yet another way to use
12083 precompiled headers, good for projects not designed with precompiled
12084 header files in mind, is to simply take most of the header files used by
12085 a project, include them from another header file, precompile that header
12086 file, and @option{-include} the precompiled header.  If the header files
12087 have guards against multiple inclusion, they will be skipped because
12088 they've already been included (in the precompiled header).
12089
12090 If you need to precompile the same header file for different
12091 languages, targets, or compiler options, you can instead make a
12092 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12093 header in the directory, perhaps using @option{-o}.  It doesn't matter
12094 what you call the files in the directory, every precompiled header in
12095 the directory will be considered.  The first precompiled header
12096 encountered in the directory that is valid for this compilation will
12097 be used; they're searched in no particular order.
12098
12099 There are many other possibilities, limited only by your imagination,
12100 good sense, and the constraints of your build system.
12101
12102 A precompiled header file can be used only when these conditions apply:
12103
12104 @itemize
12105 @item
12106 Only one precompiled header can be used in a particular compilation.
12107
12108 @item
12109 A precompiled header can't be used once the first C token is seen.  You
12110 can have preprocessor directives before a precompiled header; you can
12111 even include a precompiled header from inside another header, so long as
12112 there are no C tokens before the @code{#include}.
12113
12114 @item
12115 The precompiled header file must be produced for the same language as
12116 the current compilation.  You can't use a C precompiled header for a C++
12117 compilation.
12118
12119 @item
12120 The precompiled header file must be produced by the same compiler
12121 version and configuration as the current compilation is using.
12122 The easiest way to guarantee this is to use the same compiler binary
12123 for creating and using precompiled headers.
12124
12125 @item
12126 Any macros defined before the precompiled header is included must
12127 either be defined in the same way as when the precompiled header was
12128 generated, or must not affect the precompiled header, which usually
12129 means that the they don't appear in the precompiled header at all.
12130
12131 The @option{-D} option is one way to define a macro before a
12132 precompiled header is included; using a @code{#define} can also do it.
12133 There are also some options that define macros implicitly, like
12134 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12135 defined this way.
12136
12137 @item If debugging information is output when using the precompiled
12138 header, using @option{-g} or similar, the same kind of debugging information
12139 must have been output when building the precompiled header.  However,
12140 a precompiled header built using @option{-g} can be used in a compilation
12141 when no debugging information is being output.
12142
12143 @item The same @option{-m} options must generally be used when building
12144 and using the precompiled header.  @xref{Submodel Options},
12145 for any cases where this rule is relaxed.
12146
12147 @item Each of the following options must be the same when building and using
12148 the precompiled header:
12149
12150 @gccoptlist{-fexceptions -funit-at-a-time}
12151
12152 @item
12153 Some other command-line options starting with @option{-f},
12154 @option{-p}, or @option{-O} must be defined in the same way as when
12155 the precompiled header was generated.  At present, it's not clear
12156 which options are safe to change and which are not; the safest choice
12157 is to use exactly the same options when generating and using the
12158 precompiled header.  The following are known to be safe:
12159
12160 @gccoptlist{-fpreprocessed -pedantic-errors}
12161
12162 @end itemize
12163
12164 For all of these except the last, the compiler will automatically
12165 ignore the precompiled header if the conditions aren't met.  If you
12166 find an option combination that doesn't work and doesn't cause the
12167 precompiled header to be ignored, please consider filing a bug report,
12168 see @ref{Bugs}.
12169
12170 If you do use differing options when generating and using the
12171 precompiled header, the actual behaviour will be a mixture of the
12172 behaviour for the options.  For instance, if you use @option{-g} to
12173 generate the precompiled header but not when using it, you may or may
12174 not get debugging information for routines in the precompiled header.
12175
12176 @node Running Protoize
12177 @section Running Protoize
12178
12179 The program @code{protoize} is an optional part of GCC@.  You can use
12180 it to add prototypes to a program, thus converting the program to ISO
12181 C in one respect.  The companion program @code{unprotoize} does the
12182 reverse: it removes argument types from any prototypes that are found.
12183
12184 When you run these programs, you must specify a set of source files as
12185 command line arguments.  The conversion programs start out by compiling
12186 these files to see what functions they define.  The information gathered
12187 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12188
12189 After scanning comes actual conversion.  The specified files are all
12190 eligible to be converted; any files they include (whether sources or
12191 just headers) are eligible as well.
12192
12193 But not all the eligible files are converted.  By default,
12194 @code{protoize} and @code{unprotoize} convert only source and header
12195 files in the current directory.  You can specify additional directories
12196 whose files should be converted with the @option{-d @var{directory}}
12197 option.  You can also specify particular files to exclude with the
12198 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12199 directory name matches one of the specified directory names, and its
12200 name within the directory has not been excluded.
12201
12202 Basic conversion with @code{protoize} consists of rewriting most
12203 function definitions and function declarations to specify the types of
12204 the arguments.  The only ones not rewritten are those for varargs
12205 functions.
12206
12207 @code{protoize} optionally inserts prototype declarations at the
12208 beginning of the source file, to make them available for any calls that
12209 precede the function's definition.  Or it can insert prototype
12210 declarations with block scope in the blocks where undeclared functions
12211 are called.
12212
12213 Basic conversion with @code{unprotoize} consists of rewriting most
12214 function declarations to remove any argument types, and rewriting
12215 function definitions to the old-style pre-ISO form.
12216
12217 Both conversion programs print a warning for any function declaration or
12218 definition that they can't convert.  You can suppress these warnings
12219 with @option{-q}.
12220
12221 The output from @code{protoize} or @code{unprotoize} replaces the
12222 original source file.  The original file is renamed to a name ending
12223 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12224 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12225 for DOS) file already exists, then the source file is simply discarded.
12226
12227 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12228 scan the program and collect information about the functions it uses.
12229 So neither of these programs will work until GCC is installed.
12230
12231 Here is a table of the options you can use with @code{protoize} and
12232 @code{unprotoize}.  Each option works with both programs unless
12233 otherwise stated.
12234
12235 @table @code
12236 @item -B @var{directory}
12237 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12238 usual directory (normally @file{/usr/local/lib}).  This file contains
12239 prototype information about standard system functions.  This option
12240 applies only to @code{protoize}.
12241
12242 @item -c @var{compilation-options}
12243 Use @var{compilation-options} as the options when running @command{gcc} to
12244 produce the @samp{.X} files.  The special option @option{-aux-info} is
12245 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12246
12247 Note that the compilation options must be given as a single argument to
12248 @code{protoize} or @code{unprotoize}.  If you want to specify several
12249 @command{gcc} options, you must quote the entire set of compilation options
12250 to make them a single word in the shell.
12251
12252 There are certain @command{gcc} arguments that you cannot use, because they
12253 would produce the wrong kind of output.  These include @option{-g},
12254 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12255 the @var{compilation-options}, they are ignored.
12256
12257 @item -C
12258 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12259 systems) instead of @samp{.c}.  This is convenient if you are converting
12260 a C program to C++.  This option applies only to @code{protoize}.
12261
12262 @item -g
12263 Add explicit global declarations.  This means inserting explicit
12264 declarations at the beginning of each source file for each function
12265 that is called in the file and was not declared.  These declarations
12266 precede the first function definition that contains a call to an
12267 undeclared function.  This option applies only to @code{protoize}.
12268
12269 @item -i @var{string}
12270 Indent old-style parameter declarations with the string @var{string}.
12271 This option applies only to @code{protoize}.
12272
12273 @code{unprotoize} converts prototyped function definitions to old-style
12274 function definitions, where the arguments are declared between the
12275 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12276 uses five spaces as the indentation.  If you want to indent with just
12277 one space instead, use @option{-i " "}.
12278
12279 @item -k
12280 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12281 is finished.
12282
12283 @item -l
12284 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12285 a prototype declaration for each function in each block which calls the
12286 function without any declaration.  This option applies only to
12287 @code{protoize}.
12288
12289 @item -n
12290 Make no real changes.  This mode just prints information about the conversions
12291 that would have been done without @option{-n}.
12292
12293 @item -N
12294 Make no @samp{.save} files.  The original files are simply deleted.
12295 Use this option with caution.
12296
12297 @item -p @var{program}
12298 Use the program @var{program} as the compiler.  Normally, the name
12299 @file{gcc} is used.
12300
12301 @item -q
12302 Work quietly.  Most warnings are suppressed.
12303
12304 @item -v
12305 Print the version number, just like @option{-v} for @command{gcc}.
12306 @end table
12307
12308 If you need special compiler options to compile one of your program's
12309 source files, then you should generate that file's @samp{.X} file
12310 specially, by running @command{gcc} on that source file with the
12311 appropriate options and the option @option{-aux-info}.  Then run
12312 @code{protoize} on the entire set of files.  @code{protoize} will use
12313 the existing @samp{.X} file because it is newer than the source file.
12314 For example:
12315
12316 @smallexample
12317 gcc -Dfoo=bar file1.c -aux-info file1.X
12318 protoize *.c
12319 @end smallexample
12320
12321 @noindent
12322 You need to include the special files along with the rest in the
12323 @code{protoize} command, even though their @samp{.X} files already
12324 exist, because otherwise they won't get converted.
12325
12326 @xref{Protoize Caveats}, for more information on how to use
12327 @code{protoize} successfully.