gcc/:
[official-gcc.git] / gcc / doc / invoke.texi
blobc7d1c5d187caa8e9d0d1b3aef9583d717e10974f
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with the
19 Invariant Sections being ``GNU General Public License'' and ``Funding
20 Free Software'', the Front-Cover texts being (a) (see below), and with
21 the Back-Cover Texts being (b) (see below).  A copy of the license is
22 included in the gfdl(7) man page.
24 (a) The FSF's Front-Cover Text is:
26      A GNU Manual
28 (b) The FSF's Back-Cover Text is:
30      You have freedom to copy and modify this GNU Manual, like GNU
31      software.  Copies published by the Free Software Foundation raise
32      funds for GNU development.
33 @c man end
34 @c Set file name and title for the man page.
35 @setfilename gcc
36 @settitle GNU project C and C++ compiler
37 @c man begin SYNOPSIS
38 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
39     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
40     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
41     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
42     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
43     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
44     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
46 Only the most useful options are listed here; see below for the
47 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
48 @c man end
49 @c man begin SEEALSO
50 gpl(7), gfdl(7), fsf-funding(7),
51 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
52 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
53 @file{ld}, @file{binutils} and @file{gdb}.
54 @c man end
55 @c man begin BUGS
56 For instructions on reporting bugs, see
57 @w{@uref{http://gcc.gnu.org/bugs.html}}.
58 @c man end
59 @c man begin AUTHOR
60 See the Info entry for @command{gcc}, or
61 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
62 for contributors to GCC@.
63 @c man end
64 @end ignore
66 @node Invoking GCC
67 @chapter GCC Command Options
68 @cindex GCC command options
69 @cindex command options
70 @cindex options, GCC command
72 @c man begin DESCRIPTION
73 When you invoke GCC, it normally does preprocessing, compilation,
74 assembly and linking.  The ``overall options'' allow you to stop this
75 process at an intermediate stage.  For example, the @option{-c} option
76 says not to run the linker.  Then the output consists of object files
77 output by the assembler.
79 Other options are passed on to one stage of processing.  Some options
80 control the preprocessor and others the compiler itself.  Yet other
81 options control the assembler and linker; most of these are not
82 documented here, since you rarely need to use any of them.
84 @cindex C compilation options
85 Most of the command line options that you can use with GCC are useful
86 for C programs; when an option is only useful with another language
87 (usually C++), the explanation says so explicitly.  If the description
88 for a particular option does not mention a source language, you can use
89 that option with all supported languages.
91 @cindex C++ compilation options
92 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
93 options for compiling C++ programs.
95 @cindex grouping options
96 @cindex options, grouping
97 The @command{gcc} program accepts options and file names as operands.  Many
98 options have multi-letter names; therefore multiple single-letter options
99 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
100 -r}}.
102 @cindex order of options
103 @cindex options, order
104 You can mix options and other arguments.  For the most part, the order
105 you use doesn't matter.  Order does matter when you use several options
106 of the same kind; for example, if you specify @option{-L} more than once,
107 the directories are searched in the order specified.
109 Many options have long names starting with @samp{-f} or with
110 @samp{-W}---for example, 
111 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
112 these have both positive and negative forms; the negative form of
113 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
114 only one of these two forms, whichever one is not the default.
116 @c man end
118 @xref{Option Index}, for an index to GCC's options.
120 @menu
121 * Option Summary::      Brief list of all options, without explanations.
122 * Overall Options::     Controlling the kind of output:
123                         an executable, object files, assembler files,
124                         or preprocessed source.
125 * Invoking G++::        Compiling C++ programs.
126 * C Dialect Options::   Controlling the variant of C language compiled.
127 * C++ Dialect Options:: Variations on C++.
128 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
129                         and Objective-C++.
130 * Language Independent Options:: Controlling how diagnostics should be
131                         formatted.
132 * Warning Options::     How picky should the compiler be?
133 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
134 * Optimize Options::    How much optimization?
135 * Preprocessor Options:: Controlling header files and macro definitions.
136                          Also, getting dependency information for Make.
137 * Assembler Options::   Passing options to the assembler.
138 * Link Options::        Specifying libraries and so on.
139 * Directory Options::   Where to find header files and libraries.
140                         Where to find the compiler executable files.
141 * Spec Files::          How to pass switches to sub-processes.
142 * Target Options::      Running a cross-compiler, or an old version of GCC.
143 * Submodel Options::    Specifying minor hardware or convention variations,
144                         such as 68010 vs 68020.
145 * Code Gen Options::    Specifying conventions for function calls, data layout
146                         and register usage.
147 * Environment Variables:: Env vars that affect GCC.
148 * Precompiled Headers:: Compiling a header once, and using it many times.
149 * Running Protoize::    Automatically adding or removing function prototypes.
150 @end menu
152 @c man begin OPTIONS
154 @node Option Summary
155 @section Option Summary
157 Here is a summary of all the options, grouped by type.  Explanations are
158 in the following sections.
160 @table @emph
161 @item Overall Options
162 @xref{Overall Options,,Options Controlling the Kind of Output}.
163 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
164 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
169 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
170 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
171 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
172 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
173 -fsigned-bitfields  -fsigned-char @gol
174 -funsigned-bitfields  -funsigned-char}
176 @item C++ Language Options
177 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
178 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
179 -fconserve-space  -ffriend-injection @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs @gol
182 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
183 -fno-implicit-templates @gol
184 -fno-implicit-inline-templates @gol
185 -fno-implement-inlines  -fms-extensions @gol
186 -fno-nonansi-builtins  -fno-operator-names @gol
187 -fno-optional-diags  -fpermissive @gol
188 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
189 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
190 -fno-default-inline  -fvisibility-inlines-hidden @gol
191 -Wabi  -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor  -Wreorder @gol
193 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
194 -Wno-non-template-friend  -Wold-style-cast @gol
195 -Woverloaded-virtual  -Wno-pmf-conversions @gol
196 -Wsign-promo}
198 @item Objective-C and Objective-C++ Language Options
199 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
200 Objective-C and Objective-C++ Dialects}.
201 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol  -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n}  @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
220 -fdiagnostics-show-option}
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Warray-bounds @gol
226 -Wno-attributes -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
227 -Wchar-subscripts -Wclobbered  -Wcomment @gol
228 -Wconversion -Wcoverage-mismatch -Wno-deprecated-declarations @gol
229 -Wdisabled-optimization  -Wno-div-by-zero  @gol
230 -Wempty-body  -Wno-endif-labels @gol
231 -Werror  -Werror-* -Werror-implicit-function-declaration @gol
232 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
233 -Wno-format-extra-args -Wformat-nonliteral @gol
234 -Wformat-security  -Wformat-y2k @gol
235 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
236 -Wimport  -Wno-import  -Winit-self  -Winline @gol
237 -Wno-int-to-pointer-cast @gol
238 -Wno-invalid-offsetof  -Winvalid-pch @gol
239 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
240 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
241 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
242 -Wmissing-noreturn @gol
243 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
244 -Woverlength-strings  -Wpacked  -Wpadded @gol
245 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
246 -Wredundant-decls @gol
247 -Wreturn-type  -Wsequence-point  -Wshadow @gol
248 -Wsign-compare  -Wstack-protector @gol
249 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
250 -Wstring-literal-comparison @gol
251 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
252 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
253 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
254 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
255 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
256 -Wvolatile-register-var  -Wwrite-strings}
258 @item C-only Warning Options
259 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
260 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
261 -Wold-style-declaration  -Wold-style-definition @gol
262 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
263 -Wdeclaration-after-statement -Wpointer-sign}
265 @item Debugging Options
266 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
267 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
268 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
269 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
270 -fdump-ipa-all -fdump-ipa-cgraph @gol
271 -fdump-tree-all @gol
272 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
273 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
276 -fdump-tree-ch @gol
277 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-nrv -fdump-tree-vect @gol
286 -fdump-tree-sink @gol
287 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-salias @gol
289 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
291 -ftree-vectorizer-verbose=@var{n} @gol
292 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
293 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
294 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
295 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
296 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
297 -ftest-coverage  -ftime-report -fvar-tracking @gol
298 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
299 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
300 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
301 -print-multi-directory  -print-multi-lib @gol
302 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
303 -save-temps  -time}
305 @item Optimization Options
306 @xref{Optimize Options,,Options that Control Optimization}.
307 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
308 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
309 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
310 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
311 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
312 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
313 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
314 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
315 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
316 -fforce-addr  -fforward-propagate  -ffunction-sections @gol
317 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
318 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
319 -finline-functions  -finline-functions-called-once @gol
320 -finline-limit=@var{n}  -fkeep-inline-functions @gol
321 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
322 -fmodulo-sched -fno-branch-count-reg @gol
323 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
324 -fno-function-cse  -fno-guess-branch-probability @gol
325 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
326 -funsafe-math-optimizations  -funsafe-loop-optimizations @gol
327 -ffinite-math-only  -fno-signed-zeros @gol
328 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
329 -fomit-frame-pointer  -foptimize-register-move @gol
330 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
331 -fprofile-generate -fprofile-use @gol
332 -fregmove  -frename-registers @gol
333 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
334 -frerun-cse-after-loop @gol
335 -frounding-math -frtl-abstract-sequences @gol
336 -fschedule-insns  -fschedule-insns2 @gol
337 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
338 -fsched-spec-load-dangerous  @gol
339 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
340 -fsched2-use-superblocks @gol
341 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
342 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
343 -fno-split-wide-types -fstack-protector  -fstack-protector-all @gol
344 -fstrict-aliasing  -fstrict-overflow  -ftracer  -fthread-jumps @gol
345 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
346 -fsplit-ivs-in-unroller -funswitch-loops @gol
347 -fvariable-expansion-in-unroller @gol
348 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
349 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
350 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
351 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
352 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
353 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
354 --param @var{name}=@var{value}
355 -O  -O0  -O1  -O2  -O3  -Os}
357 @item Preprocessor Options
358 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
359 @gccoptlist{-A@var{question}=@var{answer} @gol
360 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
361 -C  -dD  -dI  -dM  -dN @gol
362 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
363 -idirafter @var{dir} @gol
364 -include @var{file}  -imacros @var{file} @gol
365 -iprefix @var{file}  -iwithprefix @var{dir} @gol
366 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
367 -imultilib @var{dir} -isysroot @var{dir} @gol
368 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
369 -P  -fworking-directory  -remap @gol
370 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
371 -Xpreprocessor @var{option}}
373 @item Assembler Option
374 @xref{Assembler Options,,Passing Options to the Assembler}.
375 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
377 @item Linker Options
378 @xref{Link Options,,Options for Linking}.
379 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
380 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
381 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
382 -Wl,@var{option}  -Xlinker @var{option} @gol
383 -u @var{symbol}}
385 @item Directory Options
386 @xref{Directory Options,,Options for Directory Search}.
387 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
388 -specs=@var{file}  -I- --sysroot=@var{dir}}
390 @item Target Options
391 @c I wrote this xref this way to avoid overfull hbox. -- rms
392 @xref{Target Options}.
393 @gccoptlist{-V @var{version}  -b @var{machine}}
395 @item Machine Dependent Options
396 @xref{Submodel Options,,Hardware Models and Configurations}.
397 @c This list is ordered alphanumerically by subsection name.
398 @c Try and put the significant identifier (CPU or system) first,
399 @c so users have a clue at guessing where the ones they want will be.
401 @emph{ARC Options}
402 @gccoptlist{-EB  -EL @gol
403 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
404 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
406 @emph{ARM Options}
407 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
408 -mabi=@var{name} @gol
409 -mapcs-stack-check  -mno-apcs-stack-check @gol
410 -mapcs-float  -mno-apcs-float @gol
411 -mapcs-reentrant  -mno-apcs-reentrant @gol
412 -msched-prolog  -mno-sched-prolog @gol
413 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
414 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
415 -mthumb-interwork  -mno-thumb-interwork @gol
416 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
417 -mstructure-size-boundary=@var{n} @gol
418 -mabort-on-noreturn @gol
419 -mlong-calls  -mno-long-calls @gol
420 -msingle-pic-base  -mno-single-pic-base @gol
421 -mpic-register=@var{reg} @gol
422 -mnop-fun-dllimport @gol
423 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
424 -mpoke-function-name @gol
425 -mthumb  -marm @gol
426 -mtpcs-frame  -mtpcs-leaf-frame @gol
427 -mcaller-super-interworking  -mcallee-super-interworking @gol
428 -mtp=@var{name}}
430 @emph{AVR Options}
431 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
432 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
434 @emph{Blackfin Options}
435 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
436 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
437 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
438 -mno-id-shared-library -mshared-library-id=@var{n} @gol
439 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
440 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls}
442 @emph{CRIS Options}
443 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
444 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
445 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
446 -mstack-align  -mdata-align  -mconst-align @gol
447 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
448 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
449 -mmul-bug-workaround  -mno-mul-bug-workaround}
451 @emph{CRX Options}
452 @gccoptlist{-mmac -mpush-args}
454 @emph{Darwin Options}
455 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
456 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
457 -client_name  -compatibility_version  -current_version @gol
458 -dead_strip @gol
459 -dependency-file  -dylib_file  -dylinker_install_name @gol
460 -dynamic  -dynamiclib  -exported_symbols_list @gol
461 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
462 -force_flat_namespace  -headerpad_max_install_names @gol
463 -image_base  -init  -install_name  -keep_private_externs @gol
464 -multi_module  -multiply_defined  -multiply_defined_unused @gol
465 -noall_load   -no_dead_strip_inits_and_terms @gol
466 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
467 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
468 -private_bundle  -read_only_relocs  -sectalign @gol
469 -sectobjectsymbols  -whyload  -seg1addr @gol
470 -sectcreate  -sectobjectsymbols  -sectorder @gol
471 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
472 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
473 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
474 -single_module  -static  -sub_library  -sub_umbrella @gol
475 -twolevel_namespace  -umbrella  -undefined @gol
476 -unexported_symbols_list  -weak_reference_mismatches @gol
477 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
478 -mkernel -mone-byte-bool}
480 @emph{DEC Alpha Options}
481 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
482 -mieee  -mieee-with-inexact  -mieee-conformant @gol
483 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
484 -mtrap-precision=@var{mode}  -mbuild-constants @gol
485 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
486 -mbwx  -mmax  -mfix  -mcix @gol
487 -mfloat-vax  -mfloat-ieee @gol
488 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
489 -msmall-text  -mlarge-text @gol
490 -mmemory-latency=@var{time}}
492 @emph{DEC Alpha/VMS Options}
493 @gccoptlist{-mvms-return-codes}
495 @emph{FRV Options}
496 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
497 -mhard-float  -msoft-float @gol
498 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
499 -mdouble  -mno-double @gol
500 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
501 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
502 -mlinked-fp  -mlong-calls  -malign-labels @gol
503 -mlibrary-pic  -macc-4  -macc-8 @gol
504 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
505 -moptimize-membar -mno-optimize-membar @gol
506 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
507 -mvliw-branch  -mno-vliw-branch @gol
508 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
509 -mno-nested-cond-exec  -mtomcat-stats @gol
510 -mTLS -mtls @gol
511 -mcpu=@var{cpu}}
513 @emph{GNU/Linux Options}
514 @gccoptlist{-muclibc}
516 @emph{H8/300 Options}
517 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
519 @emph{HPPA Options}
520 @gccoptlist{-march=@var{architecture-type} @gol
521 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
522 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
523 -mfixed-range=@var{register-range} @gol
524 -mjump-in-delay -mlinker-opt -mlong-calls @gol
525 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
526 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
527 -mno-jump-in-delay  -mno-long-load-store @gol
528 -mno-portable-runtime  -mno-soft-float @gol
529 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
530 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
531 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
532 -munix=@var{unix-std}  -nolibdld  -static  -threads}
534 @emph{i386 and x86-64 Options}
535 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
536 -mfpmath=@var{unit} @gol
537 -masm=@var{dialect}  -mno-fancy-math-387 @gol
538 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
539 -mno-wide-multiply  -mrtd  -malign-double @gol
540 -mpreferred-stack-boundary=@var{num} @gol
541 -mmmx  -msse  -msse2 -msse3 -mssse3 -m3dnow @gol
542 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
543 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
544 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
545 -mstackrealign @gol
546 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
547 -mcmodel=@var{code-model} @gol
548 -m32  -m64 -mlarge-data-threshold=@var{num}}
550 @emph{IA-64 Options}
551 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
552 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
553 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
554 -minline-float-divide-max-throughput @gol
555 -minline-int-divide-min-latency @gol
556 -minline-int-divide-max-throughput  @gol
557 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
558 -mno-dwarf2-asm -mearly-stop-bits @gol
559 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
560 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
561 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
562 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
563 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
564 -mno-sched-prefer-non-data-spec-insns @gol
565 -mno-sched-prefer-non-control-spec-insns @gol
566 -mno-sched-count-spec-in-critical-path}
568 @emph{M32R/D Options}
569 @gccoptlist{-m32r2 -m32rx -m32r @gol
570 -mdebug @gol
571 -malign-loops -mno-align-loops @gol
572 -missue-rate=@var{number} @gol
573 -mbranch-cost=@var{number} @gol
574 -mmodel=@var{code-size-model-type} @gol
575 -msdata=@var{sdata-type} @gol
576 -mno-flush-func -mflush-func=@var{name} @gol
577 -mno-flush-trap -mflush-trap=@var{number} @gol
578 -G @var{num}}
580 @emph{M32C Options}
581 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
583 @emph{M680x0 Options}
584 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
585 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
586 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
587 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
588 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
589 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
590 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
591 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
593 @emph{M68hc1x Options}
594 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
595 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
596 -msoft-reg-count=@var{count}}
598 @emph{MCore Options}
599 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
600 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
601 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
602 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
603 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
605 @emph{MIPS Options}
606 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
607 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
608 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
609 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64  @gol
610 -mfp32  -mfp64  -mhard-float  -msoft-float  @gol
611 -msingle-float  -mdouble-float  -mdsp  -mpaired-single  -mips3d @gol
612 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
613 -G@var{num}  -membedded-data  -mno-embedded-data @gol
614 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
615 -msplit-addresses  -mno-split-addresses  @gol
616 -mexplicit-relocs  -mno-explicit-relocs  @gol
617 -mcheck-zero-division  -mno-check-zero-division @gol
618 -mdivide-traps  -mdivide-breaks @gol
619 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
620 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
621 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
622 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
623 -mfix-sb1  -mno-fix-sb1 @gol
624 -mflush-func=@var{func}  -mno-flush-func @gol
625 -mbranch-likely  -mno-branch-likely @gol
626 -mfp-exceptions -mno-fp-exceptions @gol
627 -mvr4130-align -mno-vr4130-align}
629 @emph{MMIX Options}
630 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
631 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
632 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
633 -mno-base-addresses  -msingle-exit  -mno-single-exit}
635 @emph{MN10300 Options}
636 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
637 -mam33  -mno-am33 @gol
638 -mam33-2  -mno-am33-2 @gol
639 -mreturn-pointer-on-d0 @gol
640 -mno-crt0  -mrelax}
642 @emph{MT Options}
643 @gccoptlist{-mno-crt0 -mbacc -msim @gol
644 -march=@var{cpu-type} }
646 @emph{PDP-11 Options}
647 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
648 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
649 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
650 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
651 -mbranch-expensive  -mbranch-cheap @gol
652 -msplit  -mno-split  -munix-asm  -mdec-asm}
654 @emph{PowerPC Options}
655 See RS/6000 and PowerPC Options.
657 @emph{RS/6000 and PowerPC Options}
658 @gccoptlist{-mcpu=@var{cpu-type} @gol
659 -mtune=@var{cpu-type} @gol
660 -mpower  -mno-power  -mpower2  -mno-power2 @gol
661 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
662 -maltivec  -mno-altivec @gol
663 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
664 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
665 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
666 -mmfpgpr -mno-mfpgpr @gol
667 -mnew-mnemonics  -mold-mnemonics @gol
668 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
669 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
670 -malign-power  -malign-natural @gol
671 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
672 -mstring  -mno-string  -mupdate  -mno-update @gol
673 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
674 -mstrict-align  -mno-strict-align  -mrelocatable @gol
675 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
676 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
677 -mdynamic-no-pic  -maltivec  -mswdiv @gol
678 -mprioritize-restricted-insns=@var{priority} @gol
679 -msched-costly-dep=@var{dependence_type} @gol
680 -minsert-sched-nops=@var{scheme} @gol
681 -mcall-sysv  -mcall-netbsd @gol
682 -maix-struct-return  -msvr4-struct-return @gol
683 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
684 -misel -mno-isel @gol
685 -misel=yes  -misel=no @gol
686 -mspe -mno-spe @gol
687 -mspe=yes  -mspe=no @gol
688 -mvrsave -mno-vrsave @gol
689 -mmulhw -mno-mulhw @gol
690 -mdlmzb -mno-dlmzb @gol
691 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
692 -mprototype  -mno-prototype @gol
693 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
694 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
696 @emph{S/390 and zSeries Options}
697 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
698 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
699 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
700 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
701 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
702 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
703 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
705 @emph{Score Options}
706 @gccoptlist{-mel -mel @gol
707 -mmac @gol
708 -mscore5u -mscore7}
710 @emph{SH Options}
711 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
712 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
713 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
714 -m5-64media  -m5-64media-nofpu @gol
715 -m5-32media  -m5-32media-nofpu @gol
716 -m5-compact  -m5-compact-nofpu @gol
717 -mb  -ml  -mdalign  -mrelax @gol
718 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
719 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
720 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
721 -mdivsi3_libfunc=@var{name}  @gol
722 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
723  -minvalid-symbols}
725 @emph{SPARC Options}
726 @gccoptlist{-mcpu=@var{cpu-type} @gol
727 -mtune=@var{cpu-type} @gol
728 -mcmodel=@var{code-model} @gol
729 -m32  -m64  -mapp-regs  -mno-app-regs @gol
730 -mfaster-structs  -mno-faster-structs @gol
731 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
732 -mhard-quad-float  -msoft-quad-float @gol
733 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
734 -mstack-bias  -mno-stack-bias @gol
735 -munaligned-doubles  -mno-unaligned-doubles @gol
736 -mv8plus  -mno-v8plus  -mvis  -mno-vis
737 -threads -pthreads -pthread}
739 @emph{SPU Options}
740 @gccoptlist{-mwarn-reloc -merror-reloc @gol
741 -msafe-dma -munsafe-dma @gol
742 -mbranch-hints @gol
743 -msmall-mem -mlarge-mem -mstdmain @gol
744 -mfixed-range=@var{register-range}}
746 @emph{System V Options}
747 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
749 @emph{TMS320C3x/C4x Options}
750 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
751 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
752 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
753 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
755 @emph{V850 Options}
756 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
757 -mprolog-function  -mno-prolog-function  -mspace @gol
758 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
759 -mapp-regs  -mno-app-regs @gol
760 -mdisable-callt  -mno-disable-callt @gol
761 -mv850e1 @gol
762 -mv850e @gol
763 -mv850  -mbig-switch}
765 @emph{VAX Options}
766 @gccoptlist{-mg  -mgnu  -munix}
768 @emph{x86-64 Options}
769 See i386 and x86-64 Options.
771 @emph{Xstormy16 Options}
772 @gccoptlist{-msim}
774 @emph{Xtensa Options}
775 @gccoptlist{-mconst16 -mno-const16 @gol
776 -mfused-madd  -mno-fused-madd @gol
777 -mtext-section-literals  -mno-text-section-literals @gol
778 -mtarget-align  -mno-target-align @gol
779 -mlongcalls  -mno-longcalls}
781 @emph{zSeries Options}
782 See S/390 and zSeries Options.
784 @item Code Generation Options
785 @xref{Code Gen Options,,Options for Code Generation Conventions}.
786 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
787 -ffixed-@var{reg}  -fexceptions @gol
788 -fnon-call-exceptions  -funwind-tables @gol
789 -fasynchronous-unwind-tables @gol
790 -finhibit-size-directive  -finstrument-functions @gol
791 -fno-common  -fno-ident @gol
792 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
793 -fno-jump-tables @gol
794 -frecord-gcc-switches @gol
795 -freg-struct-return  -fshort-enums @gol
796 -fshort-double  -fshort-wchar @gol
797 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
798 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
799 -fargument-alias  -fargument-noalias @gol
800 -fargument-noalias-global  -fargument-noalias-anything
801 -fleading-underscore  -ftls-model=@var{model} @gol
802 -ftrapv  -fwrapv  -fbounds-check @gol
803 -fvisibility}
804 @end table
806 @menu
807 * Overall Options::     Controlling the kind of output:
808                         an executable, object files, assembler files,
809                         or preprocessed source.
810 * C Dialect Options::   Controlling the variant of C language compiled.
811 * C++ Dialect Options:: Variations on C++.
812 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
813                         and Objective-C++.
814 * Language Independent Options:: Controlling how diagnostics should be
815                         formatted.
816 * Warning Options::     How picky should the compiler be?
817 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
818 * Optimize Options::    How much optimization?
819 * Preprocessor Options:: Controlling header files and macro definitions.
820                          Also, getting dependency information for Make.
821 * Assembler Options::   Passing options to the assembler.
822 * Link Options::        Specifying libraries and so on.
823 * Directory Options::   Where to find header files and libraries.
824                         Where to find the compiler executable files.
825 * Spec Files::          How to pass switches to sub-processes.
826 * Target Options::      Running a cross-compiler, or an old version of GCC.
827 @end menu
829 @node Overall Options
830 @section Options Controlling the Kind of Output
832 Compilation can involve up to four stages: preprocessing, compilation
833 proper, assembly and linking, always in that order.  GCC is capable of
834 preprocessing and compiling several files either into several
835 assembler input files, or into one assembler input file; then each
836 assembler input file produces an object file, and linking combines all
837 the object files (those newly compiled, and those specified as input)
838 into an executable file.
840 @cindex file name suffix
841 For any given input file, the file name suffix determines what kind of
842 compilation is done:
844 @table @gcctabopt
845 @item @var{file}.c
846 C source code which must be preprocessed.
848 @item @var{file}.i
849 C source code which should not be preprocessed.
851 @item @var{file}.ii
852 C++ source code which should not be preprocessed.
854 @item @var{file}.m
855 Objective-C source code.  Note that you must link with the @file{libobjc}
856 library to make an Objective-C program work.
858 @item @var{file}.mi
859 Objective-C source code which should not be preprocessed.
861 @item @var{file}.mm
862 @itemx @var{file}.M
863 Objective-C++ source code.  Note that you must link with the @file{libobjc}
864 library to make an Objective-C++ program work.  Note that @samp{.M} refers
865 to a literal capital M@.
867 @item @var{file}.mii
868 Objective-C++ source code which should not be preprocessed.
870 @item @var{file}.h
871 C, C++, Objective-C or Objective-C++ header file to be turned into a
872 precompiled header.
874 @item @var{file}.cc
875 @itemx @var{file}.cp
876 @itemx @var{file}.cxx
877 @itemx @var{file}.cpp
878 @itemx @var{file}.CPP
879 @itemx @var{file}.c++
880 @itemx @var{file}.C
881 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
882 the last two letters must both be literally @samp{x}.  Likewise,
883 @samp{.C} refers to a literal capital C@.
885 @item @var{file}.mm
886 @itemx @var{file}.M
887 Objective-C++ source code which must be preprocessed.
889 @item @var{file}.mii
890 Objective-C++ source code which should not be preprocessed.
892 @item @var{file}.hh
893 @itemx @var{file}.H
894 C++ header file to be turned into a precompiled header.
896 @item @var{file}.f
897 @itemx @var{file}.for
898 @itemx @var{file}.FOR
899 Fixed form Fortran source code which should not be preprocessed.
901 @item @var{file}.F
902 @itemx @var{file}.fpp
903 @itemx @var{file}.FPP
904 Fixed form Fortran source code which must be preprocessed (with the traditional
905 preprocessor).
907 @item @var{file}.f90
908 @itemx @var{file}.f95
909 Free form Fortran source code which should not be preprocessed.
911 @item @var{file}.F90
912 @itemx @var{file}.F95
913 Free form Fortran source code which must be preprocessed (with the
914 traditional preprocessor).
916 @c FIXME: Descriptions of Java file types.
917 @c @var{file}.java
918 @c @var{file}.class
919 @c @var{file}.zip
920 @c @var{file}.jar
922 @item @var{file}.ads
923 Ada source code file which contains a library unit declaration (a
924 declaration of a package, subprogram, or generic, or a generic
925 instantiation), or a library unit renaming declaration (a package,
926 generic, or subprogram renaming declaration).  Such files are also
927 called @dfn{specs}.
929 @itemx @var{file}.adb
930 Ada source code file containing a library unit body (a subprogram or
931 package body).  Such files are also called @dfn{bodies}.
933 @c GCC also knows about some suffixes for languages not yet included:
934 @c Pascal:
935 @c @var{file}.p
936 @c @var{file}.pas
937 @c Ratfor:
938 @c @var{file}.r
940 @item @var{file}.s
941 Assembler code.
943 @item @var{file}.S
944 Assembler code which must be preprocessed.
946 @item @var{other}
947 An object file to be fed straight into linking.
948 Any file name with no recognized suffix is treated this way.
949 @end table
951 @opindex x
952 You can specify the input language explicitly with the @option{-x} option:
954 @table @gcctabopt
955 @item -x @var{language}
956 Specify explicitly the @var{language} for the following input files
957 (rather than letting the compiler choose a default based on the file
958 name suffix).  This option applies to all following input files until
959 the next @option{-x} option.  Possible values for @var{language} are:
960 @smallexample
961 c  c-header  c-cpp-output
962 c++  c++-header  c++-cpp-output
963 objective-c  objective-c-header  objective-c-cpp-output
964 objective-c++ objective-c++-header objective-c++-cpp-output
965 assembler  assembler-with-cpp
967 f95  f95-cpp-input
968 java
969 treelang
970 @end smallexample
972 @item -x none
973 Turn off any specification of a language, so that subsequent files are
974 handled according to their file name suffixes (as they are if @option{-x}
975 has not been used at all).
977 @item -pass-exit-codes
978 @opindex pass-exit-codes
979 Normally the @command{gcc} program will exit with the code of 1 if any
980 phase of the compiler returns a non-success return code.  If you specify
981 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
982 numerically highest error produced by any phase that returned an error
983 indication.  The C, C++, and Fortran frontends return 4, if an internal
984 compiler error is encountered.
985 @end table
987 If you only want some of the stages of compilation, you can use
988 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
989 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
990 @command{gcc} is to stop.  Note that some combinations (for example,
991 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
993 @table @gcctabopt
994 @item -c
995 @opindex c
996 Compile or assemble the source files, but do not link.  The linking
997 stage simply is not done.  The ultimate output is in the form of an
998 object file for each source file.
1000 By default, the object file name for a source file is made by replacing
1001 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1003 Unrecognized input files, not requiring compilation or assembly, are
1004 ignored.
1006 @item -S
1007 @opindex S
1008 Stop after the stage of compilation proper; do not assemble.  The output
1009 is in the form of an assembler code file for each non-assembler input
1010 file specified.
1012 By default, the assembler file name for a source file is made by
1013 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1015 Input files that don't require compilation are ignored.
1017 @item -E
1018 @opindex E
1019 Stop after the preprocessing stage; do not run the compiler proper.  The
1020 output is in the form of preprocessed source code, which is sent to the
1021 standard output.
1023 Input files which don't require preprocessing are ignored.
1025 @cindex output file option
1026 @item -o @var{file}
1027 @opindex o
1028 Place output in file @var{file}.  This applies regardless to whatever
1029 sort of output is being produced, whether it be an executable file,
1030 an object file, an assembler file or preprocessed C code.
1032 If @option{-o} is not specified, the default is to put an executable
1033 file in @file{a.out}, the object file for
1034 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1035 assembler file in @file{@var{source}.s}, a precompiled header file in
1036 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1037 standard output.
1039 @item -v
1040 @opindex v
1041 Print (on standard error output) the commands executed to run the stages
1042 of compilation.  Also print the version number of the compiler driver
1043 program and of the preprocessor and the compiler proper.
1045 @item -###
1046 @opindex ###
1047 Like @option{-v} except the commands are not executed and all command
1048 arguments are quoted.  This is useful for shell scripts to capture the
1049 driver-generated command lines.
1051 @item -pipe
1052 @opindex pipe
1053 Use pipes rather than temporary files for communication between the
1054 various stages of compilation.  This fails to work on some systems where
1055 the assembler is unable to read from a pipe; but the GNU assembler has
1056 no trouble.
1058 @item -combine
1059 @opindex combine
1060 If you are compiling multiple source files, this option tells the driver
1061 to pass all the source files to the compiler at once (for those
1062 languages for which the compiler can handle this).  This will allow
1063 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1064 language for which this is supported is C@.  If you pass source files for
1065 multiple languages to the driver, using this option, the driver will invoke
1066 the compiler(s) that support IMA once each, passing each compiler all the
1067 source files appropriate for it.  For those languages that do not support
1068 IMA this option will be ignored, and the compiler will be invoked once for
1069 each source file in that language.  If you use this option in conjunction
1070 with @option{-save-temps}, the compiler will generate multiple
1071 pre-processed files
1072 (one for each source file), but only one (combined) @file{.o} or
1073 @file{.s} file.
1075 @item --help
1076 @opindex help
1077 Print (on the standard output) a description of the command line options
1078 understood by @command{gcc}.  If the @option{-v} option is also specified
1079 then @option{--help} will also be passed on to the various processes
1080 invoked by @command{gcc}, so that they can display the command line options
1081 they accept.  If the @option{-Wextra} option is also specified then command
1082 line options which have no documentation associated with them will also
1083 be displayed.
1085 @item --target-help
1086 @opindex target-help
1087 Print (on the standard output) a description of target specific command
1088 line options for each tool.
1090 @item --version
1091 @opindex version
1092 Display the version number and copyrights of the invoked GCC@.
1094 @include @value{srcdir}/../libiberty/at-file.texi
1095 @end table
1097 @node Invoking G++
1098 @section Compiling C++ Programs
1100 @cindex suffixes for C++ source
1101 @cindex C++ source file suffixes
1102 C++ source files conventionally use one of the suffixes @samp{.C},
1103 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1104 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1105 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1106 files with these names and compiles them as C++ programs even if you
1107 call the compiler the same way as for compiling C programs (usually
1108 with the name @command{gcc}).
1110 @findex g++
1111 @findex c++
1112 However, the use of @command{gcc} does not add the C++ library.
1113 @command{g++} is a program that calls GCC and treats @samp{.c},
1114 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1115 files unless @option{-x} is used, and automatically specifies linking
1116 against the C++ library.  This program is also useful when
1117 precompiling a C header file with a @samp{.h} extension for use in C++
1118 compilations.  On many systems, @command{g++} is also installed with
1119 the name @command{c++}.
1121 @cindex invoking @command{g++}
1122 When you compile C++ programs, you may specify many of the same
1123 command-line options that you use for compiling programs in any
1124 language; or command-line options meaningful for C and related
1125 languages; or options that are meaningful only for C++ programs.
1126 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1127 explanations of options for languages related to C@.
1128 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1129 explanations of options that are meaningful only for C++ programs.
1131 @node C Dialect Options
1132 @section Options Controlling C Dialect
1133 @cindex dialect options
1134 @cindex language dialect options
1135 @cindex options, dialect
1137 The following options control the dialect of C (or languages derived
1138 from C, such as C++, Objective-C and Objective-C++) that the compiler
1139 accepts:
1141 @table @gcctabopt
1142 @cindex ANSI support
1143 @cindex ISO support
1144 @item -ansi
1145 @opindex ansi
1146 In C mode, support all ISO C90 programs.  In C++ mode,
1147 remove GNU extensions that conflict with ISO C++.
1149 This turns off certain features of GCC that are incompatible with ISO
1150 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1151 such as the @code{asm} and @code{typeof} keywords, and
1152 predefined macros such as @code{unix} and @code{vax} that identify the
1153 type of system you are using.  It also enables the undesirable and
1154 rarely used ISO trigraph feature.  For the C compiler,
1155 it disables recognition of C++ style @samp{//} comments as well as
1156 the @code{inline} keyword.
1158 The alternate keywords @code{__asm__}, @code{__extension__},
1159 @code{__inline__} and @code{__typeof__} continue to work despite
1160 @option{-ansi}.  You would not want to use them in an ISO C program, of
1161 course, but it is useful to put them in header files that might be included
1162 in compilations done with @option{-ansi}.  Alternate predefined macros
1163 such as @code{__unix__} and @code{__vax__} are also available, with or
1164 without @option{-ansi}.
1166 The @option{-ansi} option does not cause non-ISO programs to be
1167 rejected gratuitously.  For that, @option{-pedantic} is required in
1168 addition to @option{-ansi}.  @xref{Warning Options}.
1170 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1171 option is used.  Some header files may notice this macro and refrain
1172 from declaring certain functions or defining certain macros that the
1173 ISO standard doesn't call for; this is to avoid interfering with any
1174 programs that might use these names for other things.
1176 Functions which would normally be built in but do not have semantics
1177 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1178 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1179 built-in functions provided by GCC}, for details of the functions
1180 affected.
1182 @item -std=
1183 @opindex std
1184 Determine the language standard.  This option is currently only
1185 supported when compiling C or C++.  A value for this option must be
1186 provided; possible values are
1188 @table @samp
1189 @item c89
1190 @itemx iso9899:1990
1191 ISO C90 (same as @option{-ansi}).
1193 @item iso9899:199409
1194 ISO C90 as modified in amendment 1.
1196 @item c99
1197 @itemx c9x
1198 @itemx iso9899:1999
1199 @itemx iso9899:199x
1200 ISO C99.  Note that this standard is not yet fully supported; see
1201 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1202 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1204 @item gnu89
1205 Default, ISO C90 plus GNU extensions (including some C99 features).
1207 @item gnu99
1208 @itemx gnu9x
1209 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1210 this will become the default.  The name @samp{gnu9x} is deprecated.
1212 @item c++98
1213 The 1998 ISO C++ standard plus amendments.
1215 @item gnu++98
1216 The same as @option{-std=c++98} plus GNU extensions.  This is the
1217 default for C++ code.
1219 @item c++0x
1220 The working draft of the upcoming ISO C++0x standard. This option
1221 enables experimental features that are likely to be included in
1222 C++0x. The working draft is constantly changing, and any feature that is
1223 enabled by this flag may be removed from future versions of GCC if it is
1224 not part of the C++0x standard.
1226 @item gnu++0x
1227 The same as @option{-std=c++0x} plus GNU extensions. As with
1228 @option{-std=c++0x}, this option enables experimental features that may
1229 be removed in future versions of GCC.
1230 @end table
1232 Even when this option is not specified, you can still use some of the
1233 features of newer standards in so far as they do not conflict with
1234 previous C standards.  For example, you may use @code{__restrict__} even
1235 when @option{-std=c99} is not specified.
1237 The @option{-std} options specifying some version of ISO C have the same
1238 effects as @option{-ansi}, except that features that were not in ISO C90
1239 but are in the specified version (for example, @samp{//} comments and
1240 the @code{inline} keyword in ISO C99) are not disabled.
1242 @xref{Standards,,Language Standards Supported by GCC}, for details of
1243 these standard versions.
1245 @item -aux-info @var{filename}
1246 @opindex aux-info
1247 Output to the given filename prototyped declarations for all functions
1248 declared and/or defined in a translation unit, including those in header
1249 files.  This option is silently ignored in any language other than C@.
1251 Besides declarations, the file indicates, in comments, the origin of
1252 each declaration (source file and line), whether the declaration was
1253 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1254 @samp{O} for old, respectively, in the first character after the line
1255 number and the colon), and whether it came from a declaration or a
1256 definition (@samp{C} or @samp{F}, respectively, in the following
1257 character).  In the case of function definitions, a K&R-style list of
1258 arguments followed by their declarations is also provided, inside
1259 comments, after the declaration.
1261 @item -fno-asm
1262 @opindex fno-asm
1263 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1264 keyword, so that code can use these words as identifiers.  You can use
1265 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1266 instead.  @option{-ansi} implies @option{-fno-asm}.
1268 In C++, this switch only affects the @code{typeof} keyword, since
1269 @code{asm} and @code{inline} are standard keywords.  You may want to
1270 use the @option{-fno-gnu-keywords} flag instead, which has the same
1271 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1272 switch only affects the @code{asm} and @code{typeof} keywords, since
1273 @code{inline} is a standard keyword in ISO C99.
1275 @item -fno-builtin
1276 @itemx -fno-builtin-@var{function}
1277 @opindex fno-builtin
1278 @cindex built-in functions
1279 Don't recognize built-in functions that do not begin with
1280 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1281 functions provided by GCC}, for details of the functions affected,
1282 including those which are not built-in functions when @option{-ansi} or
1283 @option{-std} options for strict ISO C conformance are used because they
1284 do not have an ISO standard meaning.
1286 GCC normally generates special code to handle certain built-in functions
1287 more efficiently; for instance, calls to @code{alloca} may become single
1288 instructions that adjust the stack directly, and calls to @code{memcpy}
1289 may become inline copy loops.  The resulting code is often both smaller
1290 and faster, but since the function calls no longer appear as such, you
1291 cannot set a breakpoint on those calls, nor can you change the behavior
1292 of the functions by linking with a different library.  In addition,
1293 when a function is recognized as a built-in function, GCC may use
1294 information about that function to warn about problems with calls to
1295 that function, or to generate more efficient code, even if the
1296 resulting code still contains calls to that function.  For example,
1297 warnings are given with @option{-Wformat} for bad calls to
1298 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1299 known not to modify global memory.
1301 With the @option{-fno-builtin-@var{function}} option
1302 only the built-in function @var{function} is
1303 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1304 function is named this is not built-in in this version of GCC, this
1305 option is ignored.  There is no corresponding
1306 @option{-fbuiltin-@var{function}} option; if you wish to enable
1307 built-in functions selectively when using @option{-fno-builtin} or
1308 @option{-ffreestanding}, you may define macros such as:
1310 @smallexample
1311 #define abs(n)          __builtin_abs ((n))
1312 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1313 @end smallexample
1315 @item -fhosted
1316 @opindex fhosted
1317 @cindex hosted environment
1319 Assert that compilation takes place in a hosted environment.  This implies
1320 @option{-fbuiltin}.  A hosted environment is one in which the
1321 entire standard library is available, and in which @code{main} has a return
1322 type of @code{int}.  Examples are nearly everything except a kernel.
1323 This is equivalent to @option{-fno-freestanding}.
1325 @item -ffreestanding
1326 @opindex ffreestanding
1327 @cindex hosted environment
1329 Assert that compilation takes place in a freestanding environment.  This
1330 implies @option{-fno-builtin}.  A freestanding environment
1331 is one in which the standard library may not exist, and program startup may
1332 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1333 This is equivalent to @option{-fno-hosted}.
1335 @xref{Standards,,Language Standards Supported by GCC}, for details of
1336 freestanding and hosted environments.
1338 @item -fopenmp
1339 @opindex fopenmp
1340 @cindex openmp parallel
1341 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1342 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1343 compiler generates parallel code according to the OpenMP Application
1344 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1346 @item -fms-extensions
1347 @opindex fms-extensions
1348 Accept some non-standard constructs used in Microsoft header files.
1350 Some cases of unnamed fields in structures and unions are only
1351 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1352 fields within structs/unions}, for details.
1354 @item -trigraphs
1355 @opindex trigraphs
1356 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1357 options for strict ISO C conformance) implies @option{-trigraphs}.
1359 @item -no-integrated-cpp
1360 @opindex no-integrated-cpp
1361 Performs a compilation in two passes: preprocessing and compiling.  This
1362 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1363 @option{-B} option.  The user supplied compilation step can then add in
1364 an additional preprocessing step after normal preprocessing but before
1365 compiling.  The default is to use the integrated cpp (internal cpp)
1367 The semantics of this option will change if "cc1", "cc1plus", and
1368 "cc1obj" are merged.
1370 @cindex traditional C language
1371 @cindex C language, traditional
1372 @item -traditional
1373 @itemx -traditional-cpp
1374 @opindex traditional-cpp
1375 @opindex traditional
1376 Formerly, these options caused GCC to attempt to emulate a pre-standard
1377 C compiler.  They are now only supported with the @option{-E} switch.
1378 The preprocessor continues to support a pre-standard mode.  See the GNU
1379 CPP manual for details.
1381 @item -fcond-mismatch
1382 @opindex fcond-mismatch
1383 Allow conditional expressions with mismatched types in the second and
1384 third arguments.  The value of such an expression is void.  This option
1385 is not supported for C++.
1387 @item -flax-vector-conversions
1388 @opindex flax-vector-conversions
1389 Allow implicit conversions between vectors with differing numbers of
1390 elements and/or incompatible element types.  This option should not be
1391 used for new code.
1393 @item -funsigned-char
1394 @opindex funsigned-char
1395 Let the type @code{char} be unsigned, like @code{unsigned char}.
1397 Each kind of machine has a default for what @code{char} should
1398 be.  It is either like @code{unsigned char} by default or like
1399 @code{signed char} by default.
1401 Ideally, a portable program should always use @code{signed char} or
1402 @code{unsigned char} when it depends on the signedness of an object.
1403 But many programs have been written to use plain @code{char} and
1404 expect it to be signed, or expect it to be unsigned, depending on the
1405 machines they were written for.  This option, and its inverse, let you
1406 make such a program work with the opposite default.
1408 The type @code{char} is always a distinct type from each of
1409 @code{signed char} or @code{unsigned char}, even though its behavior
1410 is always just like one of those two.
1412 @item -fsigned-char
1413 @opindex fsigned-char
1414 Let the type @code{char} be signed, like @code{signed char}.
1416 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1417 the negative form of @option{-funsigned-char}.  Likewise, the option
1418 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1420 @item -fsigned-bitfields
1421 @itemx -funsigned-bitfields
1422 @itemx -fno-signed-bitfields
1423 @itemx -fno-unsigned-bitfields
1424 @opindex fsigned-bitfields
1425 @opindex funsigned-bitfields
1426 @opindex fno-signed-bitfields
1427 @opindex fno-unsigned-bitfields
1428 These options control whether a bit-field is signed or unsigned, when the
1429 declaration does not use either @code{signed} or @code{unsigned}.  By
1430 default, such a bit-field is signed, because this is consistent: the
1431 basic integer types such as @code{int} are signed types.
1432 @end table
1434 @node C++ Dialect Options
1435 @section Options Controlling C++ Dialect
1437 @cindex compiler options, C++
1438 @cindex C++ options, command line
1439 @cindex options, C++
1440 This section describes the command-line options that are only meaningful
1441 for C++ programs; but you can also use most of the GNU compiler options
1442 regardless of what language your program is in.  For example, you
1443 might compile a file @code{firstClass.C} like this:
1445 @smallexample
1446 g++ -g -frepo -O -c firstClass.C
1447 @end smallexample
1449 @noindent
1450 In this example, only @option{-frepo} is an option meant
1451 only for C++ programs; you can use the other options with any
1452 language supported by GCC@.
1454 Here is a list of options that are @emph{only} for compiling C++ programs:
1456 @table @gcctabopt
1458 @item -fabi-version=@var{n}
1459 @opindex fabi-version
1460 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1461 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1462 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1463 the version that conforms most closely to the C++ ABI specification.
1464 Therefore, the ABI obtained using version 0 will change as ABI bugs
1465 are fixed.
1467 The default is version 2.
1469 @item -fno-access-control
1470 @opindex fno-access-control
1471 Turn off all access checking.  This switch is mainly useful for working
1472 around bugs in the access control code.
1474 @item -fcheck-new
1475 @opindex fcheck-new
1476 Check that the pointer returned by @code{operator new} is non-null
1477 before attempting to modify the storage allocated.  This check is
1478 normally unnecessary because the C++ standard specifies that
1479 @code{operator new} will only return @code{0} if it is declared
1480 @samp{throw()}, in which case the compiler will always check the
1481 return value even without this option.  In all other cases, when
1482 @code{operator new} has a non-empty exception specification, memory
1483 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1484 @samp{new (nothrow)}.
1486 @item -fconserve-space
1487 @opindex fconserve-space
1488 Put uninitialized or runtime-initialized global variables into the
1489 common segment, as C does.  This saves space in the executable at the
1490 cost of not diagnosing duplicate definitions.  If you compile with this
1491 flag and your program mysteriously crashes after @code{main()} has
1492 completed, you may have an object that is being destroyed twice because
1493 two definitions were merged.
1495 This option is no longer useful on most targets, now that support has
1496 been added for putting variables into BSS without making them common.
1498 @item -ffriend-injection
1499 @opindex ffriend-injection
1500 Inject friend functions into the enclosing namespace, so that they are
1501 visible outside the scope of the class in which they are declared.
1502 Friend functions were documented to work this way in the old Annotated
1503 C++ Reference Manual, and versions of G++ before 4.1 always worked
1504 that way.  However, in ISO C++ a friend function which is not declared
1505 in an enclosing scope can only be found using argument dependent
1506 lookup.  This option causes friends to be injected as they were in
1507 earlier releases.
1509 This option is for compatibility, and may be removed in a future
1510 release of G++.
1512 @item -fno-elide-constructors
1513 @opindex fno-elide-constructors
1514 The C++ standard allows an implementation to omit creating a temporary
1515 which is only used to initialize another object of the same type.
1516 Specifying this option disables that optimization, and forces G++ to
1517 call the copy constructor in all cases.
1519 @item -fno-enforce-eh-specs
1520 @opindex fno-enforce-eh-specs
1521 Don't generate code to check for violation of exception specifications
1522 at runtime.  This option violates the C++ standard, but may be useful
1523 for reducing code size in production builds, much like defining
1524 @samp{NDEBUG}.  This does not give user code permission to throw
1525 exceptions in violation of the exception specifications; the compiler
1526 will still optimize based on the specifications, so throwing an
1527 unexpected exception will result in undefined behavior.
1529 @item -ffor-scope
1530 @itemx -fno-for-scope
1531 @opindex ffor-scope
1532 @opindex fno-for-scope
1533 If @option{-ffor-scope} is specified, the scope of variables declared in
1534 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1535 as specified by the C++ standard.
1536 If @option{-fno-for-scope} is specified, the scope of variables declared in
1537 a @i{for-init-statement} extends to the end of the enclosing scope,
1538 as was the case in old versions of G++, and other (traditional)
1539 implementations of C++.
1541 The default if neither flag is given to follow the standard,
1542 but to allow and give a warning for old-style code that would
1543 otherwise be invalid, or have different behavior.
1545 @item -fno-gnu-keywords
1546 @opindex fno-gnu-keywords
1547 Do not recognize @code{typeof} as a keyword, so that code can use this
1548 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1549 @option{-ansi} implies @option{-fno-gnu-keywords}.
1551 @item -fno-implicit-templates
1552 @opindex fno-implicit-templates
1553 Never emit code for non-inline templates which are instantiated
1554 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1555 @xref{Template Instantiation}, for more information.
1557 @item -fno-implicit-inline-templates
1558 @opindex fno-implicit-inline-templates
1559 Don't emit code for implicit instantiations of inline templates, either.
1560 The default is to handle inlines differently so that compiles with and
1561 without optimization will need the same set of explicit instantiations.
1563 @item -fno-implement-inlines
1564 @opindex fno-implement-inlines
1565 To save space, do not emit out-of-line copies of inline functions
1566 controlled by @samp{#pragma implementation}.  This will cause linker
1567 errors if these functions are not inlined everywhere they are called.
1569 @item -fms-extensions
1570 @opindex fms-extensions
1571 Disable pedantic warnings about constructs used in MFC, such as implicit
1572 int and getting a pointer to member function via non-standard syntax.
1574 @item -fno-nonansi-builtins
1575 @opindex fno-nonansi-builtins
1576 Disable built-in declarations of functions that are not mandated by
1577 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1578 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1580 @item -fno-operator-names
1581 @opindex fno-operator-names
1582 Do not treat the operator name keywords @code{and}, @code{bitand},
1583 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1584 synonyms as keywords.
1586 @item -fno-optional-diags
1587 @opindex fno-optional-diags
1588 Disable diagnostics that the standard says a compiler does not need to
1589 issue.  Currently, the only such diagnostic issued by G++ is the one for
1590 a name having multiple meanings within a class.
1592 @item -fpermissive
1593 @opindex fpermissive
1594 Downgrade some diagnostics about nonconformant code from errors to
1595 warnings.  Thus, using @option{-fpermissive} will allow some
1596 nonconforming code to compile.
1598 @item -frepo
1599 @opindex frepo
1600 Enable automatic template instantiation at link time.  This option also
1601 implies @option{-fno-implicit-templates}.  @xref{Template
1602 Instantiation}, for more information.
1604 @item -fno-rtti
1605 @opindex fno-rtti
1606 Disable generation of information about every class with virtual
1607 functions for use by the C++ runtime type identification features
1608 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1609 of the language, you can save some space by using this flag.  Note that
1610 exception handling uses the same information, but it will generate it as
1611 needed. The @samp{dynamic_cast} operator can still be used for casts that
1612 do not require runtime type information, i.e. casts to @code{void *} or to
1613 unambiguous base classes.
1615 @item -fstats
1616 @opindex fstats
1617 Emit statistics about front-end processing at the end of the compilation.
1618 This information is generally only useful to the G++ development team.
1620 @item -ftemplate-depth-@var{n}
1621 @opindex ftemplate-depth
1622 Set the maximum instantiation depth for template classes to @var{n}.
1623 A limit on the template instantiation depth is needed to detect
1624 endless recursions during template class instantiation.  ANSI/ISO C++
1625 conforming programs must not rely on a maximum depth greater than 17.
1627 @item -fno-threadsafe-statics
1628 @opindex fno-threadsafe-statics
1629 Do not emit the extra code to use the routines specified in the C++
1630 ABI for thread-safe initialization of local statics.  You can use this
1631 option to reduce code size slightly in code that doesn't need to be
1632 thread-safe.
1634 @item -fuse-cxa-atexit
1635 @opindex fuse-cxa-atexit
1636 Register destructors for objects with static storage duration with the
1637 @code{__cxa_atexit} function rather than the @code{atexit} function.
1638 This option is required for fully standards-compliant handling of static
1639 destructors, but will only work if your C library supports
1640 @code{__cxa_atexit}.
1642 @item -fno-use-cxa-get-exception-ptr
1643 @opindex fno-use-cxa-get-exception-ptr
1644 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1645 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1646 if the runtime routine is not available.
1648 @item -fvisibility-inlines-hidden
1649 @opindex fvisibility-inlines-hidden
1650 This switch declares that the user does not attempt to compare
1651 pointers to inline methods where the addresses of the two functions
1652 were taken in different shared objects.
1654 The effect of this is that GCC may, effectively, mark inline methods with
1655 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1656 appear in the export table of a DSO and do not require a PLT indirection
1657 when used within the DSO@.  Enabling this option can have a dramatic effect
1658 on load and link times of a DSO as it massively reduces the size of the
1659 dynamic export table when the library makes heavy use of templates.
1661 The behaviour of this switch is not quite the same as marking the
1662 methods as hidden directly, because it does not affect static variables
1663 local to the function or cause the compiler to deduce that
1664 the function is defined in only one shared object.
1666 You may mark a method as having a visibility explicitly to negate the
1667 effect of the switch for that method.  For example, if you do want to
1668 compare pointers to a particular inline method, you might mark it as
1669 having default visibility.  Marking the enclosing class with explicit
1670 visibility will have no effect.
1672 Explicitly instantiated inline methods are unaffected by this option
1673 as their linkage might otherwise cross a shared library boundary.
1674 @xref{Template Instantiation}.
1676 @item -fno-weak
1677 @opindex fno-weak
1678 Do not use weak symbol support, even if it is provided by the linker.
1679 By default, G++ will use weak symbols if they are available.  This
1680 option exists only for testing, and should not be used by end-users;
1681 it will result in inferior code and has no benefits.  This option may
1682 be removed in a future release of G++.
1684 @item -nostdinc++
1685 @opindex nostdinc++
1686 Do not search for header files in the standard directories specific to
1687 C++, but do still search the other standard directories.  (This option
1688 is used when building the C++ library.)
1689 @end table
1691 In addition, these optimization, warning, and code generation options
1692 have meanings only for C++ programs:
1694 @table @gcctabopt
1695 @item -fno-default-inline
1696 @opindex fno-default-inline
1697 Do not assume @samp{inline} for functions defined inside a class scope.
1698 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1699 functions will have linkage like inline functions; they just won't be
1700 inlined by default.
1702 @item -Wabi @r{(C++ only)}
1703 @opindex Wabi
1704 Warn when G++ generates code that is probably not compatible with the
1705 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1706 all such cases, there are probably some cases that are not warned about,
1707 even though G++ is generating incompatible code.  There may also be
1708 cases where warnings are emitted even though the code that is generated
1709 will be compatible.
1711 You should rewrite your code to avoid these warnings if you are
1712 concerned about the fact that code generated by G++ may not be binary
1713 compatible with code generated by other compilers.
1715 The known incompatibilities at this point include:
1717 @itemize @bullet
1719 @item
1720 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1721 pack data into the same byte as a base class.  For example:
1723 @smallexample
1724 struct A @{ virtual void f(); int f1 : 1; @};
1725 struct B : public A @{ int f2 : 1; @};
1726 @end smallexample
1728 @noindent
1729 In this case, G++ will place @code{B::f2} into the same byte
1730 as@code{A::f1}; other compilers will not.  You can avoid this problem
1731 by explicitly padding @code{A} so that its size is a multiple of the
1732 byte size on your platform; that will cause G++ and other compilers to
1733 layout @code{B} identically.
1735 @item
1736 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1737 tail padding when laying out virtual bases.  For example:
1739 @smallexample
1740 struct A @{ virtual void f(); char c1; @};
1741 struct B @{ B(); char c2; @};
1742 struct C : public A, public virtual B @{@};
1743 @end smallexample
1745 @noindent
1746 In this case, G++ will not place @code{B} into the tail-padding for
1747 @code{A}; other compilers will.  You can avoid this problem by
1748 explicitly padding @code{A} so that its size is a multiple of its
1749 alignment (ignoring virtual base classes); that will cause G++ and other
1750 compilers to layout @code{C} identically.
1752 @item
1753 Incorrect handling of bit-fields with declared widths greater than that
1754 of their underlying types, when the bit-fields appear in a union.  For
1755 example:
1757 @smallexample
1758 union U @{ int i : 4096; @};
1759 @end smallexample
1761 @noindent
1762 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1763 union too small by the number of bits in an @code{int}.
1765 @item
1766 Empty classes can be placed at incorrect offsets.  For example:
1768 @smallexample
1769 struct A @{@};
1771 struct B @{
1772   A a;
1773   virtual void f ();
1776 struct C : public B, public A @{@};
1777 @end smallexample
1779 @noindent
1780 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1781 it should be placed at offset zero.  G++ mistakenly believes that the
1782 @code{A} data member of @code{B} is already at offset zero.
1784 @item
1785 Names of template functions whose types involve @code{typename} or
1786 template template parameters can be mangled incorrectly.
1788 @smallexample
1789 template <typename Q>
1790 void f(typename Q::X) @{@}
1792 template <template <typename> class Q>
1793 void f(typename Q<int>::X) @{@}
1794 @end smallexample
1796 @noindent
1797 Instantiations of these templates may be mangled incorrectly.
1799 @end itemize
1801 @item -Wctor-dtor-privacy @r{(C++ only)}
1802 @opindex Wctor-dtor-privacy
1803 Warn when a class seems unusable because all the constructors or
1804 destructors in that class are private, and it has neither friends nor
1805 public static member functions.
1807 @item -Wnon-virtual-dtor @r{(C++ only)}
1808 @opindex Wnon-virtual-dtor
1809 Warn when a class appears to be polymorphic, thereby requiring a virtual
1810 destructor, yet it declares a non-virtual one.  This warning is also
1811 enabled if -Weffc++ is specified.
1813 @item -Wreorder @r{(C++ only)}
1814 @opindex Wreorder
1815 @cindex reordering, warning
1816 @cindex warning for reordering of member initializers
1817 Warn when the order of member initializers given in the code does not
1818 match the order in which they must be executed.  For instance:
1820 @smallexample
1821 struct A @{
1822   int i;
1823   int j;
1824   A(): j (0), i (1) @{ @}
1826 @end smallexample
1828 The compiler will rearrange the member initializers for @samp{i}
1829 and @samp{j} to match the declaration order of the members, emitting
1830 a warning to that effect.  This warning is enabled by @option{-Wall}.
1831 @end table
1833 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1835 @table @gcctabopt
1836 @item -Weffc++ @r{(C++ only)}
1837 @opindex Weffc++
1838 Warn about violations of the following style guidelines from Scott Meyers'
1839 @cite{Effective C++} book:
1841 @itemize @bullet
1842 @item
1843 Item 11:  Define a copy constructor and an assignment operator for classes
1844 with dynamically allocated memory.
1846 @item
1847 Item 12:  Prefer initialization to assignment in constructors.
1849 @item
1850 Item 14:  Make destructors virtual in base classes.
1852 @item
1853 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1855 @item
1856 Item 23:  Don't try to return a reference when you must return an object.
1858 @end itemize
1860 Also warn about violations of the following style guidelines from
1861 Scott Meyers' @cite{More Effective C++} book:
1863 @itemize @bullet
1864 @item
1865 Item 6:  Distinguish between prefix and postfix forms of increment and
1866 decrement operators.
1868 @item
1869 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1871 @end itemize
1873 When selecting this option, be aware that the standard library
1874 headers do not obey all of these guidelines; use @samp{grep -v}
1875 to filter out those warnings.
1877 @item -Wno-deprecated @r{(C++ only)}
1878 @opindex Wno-deprecated
1879 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1881 @item -Wstrict-null-sentinel @r{(C++ only)}
1882 @opindex Wstrict-null-sentinel
1883 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1884 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1885 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1886 it is guaranteed to of the same size as a pointer.  But this use is
1887 not portable across different compilers.
1889 @item -Wno-non-template-friend @r{(C++ only)}
1890 @opindex Wno-non-template-friend
1891 Disable warnings when non-templatized friend functions are declared
1892 within a template.  Since the advent of explicit template specification
1893 support in G++, if the name of the friend is an unqualified-id (i.e.,
1894 @samp{friend foo(int)}), the C++ language specification demands that the
1895 friend declare or define an ordinary, nontemplate function.  (Section
1896 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1897 could be interpreted as a particular specialization of a templatized
1898 function.  Because this non-conforming behavior is no longer the default
1899 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1900 check existing code for potential trouble spots and is on by default.
1901 This new compiler behavior can be turned off with
1902 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1903 but disables the helpful warning.
1905 @item -Wold-style-cast @r{(C++ only)}
1906 @opindex Wold-style-cast
1907 Warn if an old-style (C-style) cast to a non-void type is used within
1908 a C++ program.  The new-style casts (@samp{dynamic_cast},
1909 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1910 less vulnerable to unintended effects and much easier to search for.
1912 @item -Woverloaded-virtual @r{(C++ only)}
1913 @opindex Woverloaded-virtual
1914 @cindex overloaded virtual fn, warning
1915 @cindex warning for overloaded virtual fn
1916 Warn when a function declaration hides virtual functions from a
1917 base class.  For example, in:
1919 @smallexample
1920 struct A @{
1921   virtual void f();
1924 struct B: public A @{
1925   void f(int);
1927 @end smallexample
1929 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1930 like:
1932 @smallexample
1933 B* b;
1934 b->f();
1935 @end smallexample
1937 will fail to compile.
1939 @item -Wno-pmf-conversions @r{(C++ only)}
1940 @opindex Wno-pmf-conversions
1941 Disable the diagnostic for converting a bound pointer to member function
1942 to a plain pointer.
1944 @item -Wsign-promo @r{(C++ only)}
1945 @opindex Wsign-promo
1946 Warn when overload resolution chooses a promotion from unsigned or
1947 enumerated type to a signed type, over a conversion to an unsigned type of
1948 the same size.  Previous versions of G++ would try to preserve
1949 unsignedness, but the standard mandates the current behavior.
1951 @smallexample
1952 struct A @{
1953   operator int ();
1954   A& operator = (int);
1957 main ()
1959   A a,b;
1960   a = b;
1962 @end smallexample
1964 In this example, G++ will synthesize a default @samp{A& operator =
1965 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1966 @end table
1968 @node Objective-C and Objective-C++ Dialect Options
1969 @section Options Controlling Objective-C and Objective-C++ Dialects
1971 @cindex compiler options, Objective-C and Objective-C++
1972 @cindex Objective-C and Objective-C++ options, command line
1973 @cindex options, Objective-C and Objective-C++
1974 (NOTE: This manual does not describe the Objective-C and Objective-C++
1975 languages themselves.  See @xref{Standards,,Language Standards
1976 Supported by GCC}, for references.)
1978 This section describes the command-line options that are only meaningful
1979 for Objective-C and Objective-C++ programs, but you can also use most of
1980 the language-independent GNU compiler options.
1981 For example, you might compile a file @code{some_class.m} like this:
1983 @smallexample
1984 gcc -g -fgnu-runtime -O -c some_class.m
1985 @end smallexample
1987 @noindent
1988 In this example, @option{-fgnu-runtime} is an option meant only for
1989 Objective-C and Objective-C++ programs; you can use the other options with
1990 any language supported by GCC@.
1992 Note that since Objective-C is an extension of the C language, Objective-C
1993 compilations may also use options specific to the C front-end (e.g.,
1994 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1995 C++-specific options (e.g., @option{-Wabi}).
1997 Here is a list of options that are @emph{only} for compiling Objective-C
1998 and Objective-C++ programs:
2000 @table @gcctabopt
2001 @item -fconstant-string-class=@var{class-name}
2002 @opindex fconstant-string-class
2003 Use @var{class-name} as the name of the class to instantiate for each
2004 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2005 class name is @code{NXConstantString} if the GNU runtime is being used, and
2006 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2007 @option{-fconstant-cfstrings} option, if also present, will override the
2008 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2009 to be laid out as constant CoreFoundation strings.
2011 @item -fgnu-runtime
2012 @opindex fgnu-runtime
2013 Generate object code compatible with the standard GNU Objective-C
2014 runtime.  This is the default for most types of systems.
2016 @item -fnext-runtime
2017 @opindex fnext-runtime
2018 Generate output compatible with the NeXT runtime.  This is the default
2019 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2020 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2021 used.
2023 @item -fno-nil-receivers
2024 @opindex fno-nil-receivers
2025 Assume that all Objective-C message dispatches (e.g.,
2026 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2027 is not @code{nil}.  This allows for more efficient entry points in the runtime
2028 to be used.  Currently, this option is only available in conjunction with
2029 the NeXT runtime on Mac OS X 10.3 and later.
2031 @item -fobjc-call-cxx-cdtors
2032 @opindex fobjc-call-cxx-cdtors
2033 For each Objective-C class, check if any of its instance variables is a
2034 C++ object with a non-trivial default constructor.  If so, synthesize a
2035 special @code{- (id) .cxx_construct} instance method that will run
2036 non-trivial default constructors on any such instance variables, in order,
2037 and then return @code{self}.  Similarly, check if any instance variable
2038 is a C++ object with a non-trivial destructor, and if so, synthesize a
2039 special @code{- (void) .cxx_destruct} method that will run
2040 all such default destructors, in reverse order.
2042 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2043 thusly generated will only operate on instance variables declared in the
2044 current Objective-C class, and not those inherited from superclasses.  It
2045 is the responsibility of the Objective-C runtime to invoke all such methods
2046 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2047 will be invoked by the runtime immediately after a new object
2048 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2049 be invoked immediately before the runtime deallocates an object instance.
2051 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2052 support for invoking the @code{- (id) .cxx_construct} and
2053 @code{- (void) .cxx_destruct} methods.
2055 @item -fobjc-direct-dispatch
2056 @opindex fobjc-direct-dispatch
2057 Allow fast jumps to the message dispatcher.  On Darwin this is
2058 accomplished via the comm page.
2060 @item -fobjc-exceptions
2061 @opindex fobjc-exceptions
2062 Enable syntactic support for structured exception handling in Objective-C,
2063 similar to what is offered by C++ and Java.  This option is
2064 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2065 earlier.
2067 @smallexample
2068   @@try @{
2069     @dots{}
2070        @@throw expr;
2071     @dots{}
2072   @}
2073   @@catch (AnObjCClass *exc) @{
2074     @dots{}
2075       @@throw expr;
2076     @dots{}
2077       @@throw;
2078     @dots{}
2079   @}
2080   @@catch (AnotherClass *exc) @{
2081     @dots{}
2082   @}
2083   @@catch (id allOthers) @{
2084     @dots{}
2085   @}
2086   @@finally @{
2087     @dots{}
2088       @@throw expr;
2089     @dots{}
2090   @}
2091 @end smallexample
2093 The @code{@@throw} statement may appear anywhere in an Objective-C or
2094 Objective-C++ program; when used inside of a @code{@@catch} block, the
2095 @code{@@throw} may appear without an argument (as shown above), in which case
2096 the object caught by the @code{@@catch} will be rethrown.
2098 Note that only (pointers to) Objective-C objects may be thrown and
2099 caught using this scheme.  When an object is thrown, it will be caught
2100 by the nearest @code{@@catch} clause capable of handling objects of that type,
2101 analogously to how @code{catch} blocks work in C++ and Java.  A
2102 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2103 any and all Objective-C exceptions not caught by previous @code{@@catch}
2104 clauses (if any).
2106 The @code{@@finally} clause, if present, will be executed upon exit from the
2107 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2108 regardless of whether any exceptions are thrown, caught or rethrown
2109 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2110 of the @code{finally} clause in Java.
2112 There are several caveats to using the new exception mechanism:
2114 @itemize @bullet
2115 @item
2116 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2117 idioms provided by the @code{NSException} class, the new
2118 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2119 systems, due to additional functionality needed in the (NeXT) Objective-C
2120 runtime.
2122 @item
2123 As mentioned above, the new exceptions do not support handling
2124 types other than Objective-C objects.   Furthermore, when used from
2125 Objective-C++, the Objective-C exception model does not interoperate with C++
2126 exceptions at this time.  This means you cannot @code{@@throw} an exception
2127 from Objective-C and @code{catch} it in C++, or vice versa
2128 (i.e., @code{throw @dots{} @@catch}).
2129 @end itemize
2131 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2132 blocks for thread-safe execution:
2134 @smallexample
2135   @@synchronized (ObjCClass *guard) @{
2136     @dots{}
2137   @}
2138 @end smallexample
2140 Upon entering the @code{@@synchronized} block, a thread of execution shall
2141 first check whether a lock has been placed on the corresponding @code{guard}
2142 object by another thread.  If it has, the current thread shall wait until
2143 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2144 the current thread will place its own lock on it, execute the code contained in
2145 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2146 making @code{guard} available to other threads).
2148 Unlike Java, Objective-C does not allow for entire methods to be marked
2149 @code{@@synchronized}.  Note that throwing exceptions out of
2150 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2151 to be unlocked properly.
2153 @item -fobjc-gc
2154 @opindex fobjc-gc
2155 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2157 @item -freplace-objc-classes
2158 @opindex freplace-objc-classes
2159 Emit a special marker instructing @command{ld(1)} not to statically link in
2160 the resulting object file, and allow @command{dyld(1)} to load it in at
2161 run time instead.  This is used in conjunction with the Fix-and-Continue
2162 debugging mode, where the object file in question may be recompiled and
2163 dynamically reloaded in the course of program execution, without the need
2164 to restart the program itself.  Currently, Fix-and-Continue functionality
2165 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2166 and later.
2168 @item -fzero-link
2169 @opindex fzero-link
2170 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2171 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2172 compile time) with static class references that get initialized at load time,
2173 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2174 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2175 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2176 for individual class implementations to be modified during program execution.
2178 @item -gen-decls
2179 @opindex gen-decls
2180 Dump interface declarations for all classes seen in the source file to a
2181 file named @file{@var{sourcename}.decl}.
2183 @item -Wassign-intercept
2184 @opindex Wassign-intercept
2185 Warn whenever an Objective-C assignment is being intercepted by the
2186 garbage collector.
2188 @item -Wno-protocol
2189 @opindex Wno-protocol
2190 If a class is declared to implement a protocol, a warning is issued for
2191 every method in the protocol that is not implemented by the class.  The
2192 default behavior is to issue a warning for every method not explicitly
2193 implemented in the class, even if a method implementation is inherited
2194 from the superclass.  If you use the @option{-Wno-protocol} option, then
2195 methods inherited from the superclass are considered to be implemented,
2196 and no warning is issued for them.
2198 @item -Wselector
2199 @opindex Wselector
2200 Warn if multiple methods of different types for the same selector are
2201 found during compilation.  The check is performed on the list of methods
2202 in the final stage of compilation.  Additionally, a check is performed
2203 for each selector appearing in a @code{@@selector(@dots{})}
2204 expression, and a corresponding method for that selector has been found
2205 during compilation.  Because these checks scan the method table only at
2206 the end of compilation, these warnings are not produced if the final
2207 stage of compilation is not reached, for example because an error is
2208 found during compilation, or because the @option{-fsyntax-only} option is
2209 being used.
2211 @item -Wstrict-selector-match
2212 @opindex Wstrict-selector-match
2213 Warn if multiple methods with differing argument and/or return types are
2214 found for a given selector when attempting to send a message using this
2215 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2216 is off (which is the default behavior), the compiler will omit such warnings
2217 if any differences found are confined to types which share the same size
2218 and alignment.
2220 @item -Wundeclared-selector
2221 @opindex Wundeclared-selector
2222 Warn if a @code{@@selector(@dots{})} expression referring to an
2223 undeclared selector is found.  A selector is considered undeclared if no
2224 method with that name has been declared before the
2225 @code{@@selector(@dots{})} expression, either explicitly in an
2226 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2227 an @code{@@implementation} section.  This option always performs its
2228 checks as soon as a @code{@@selector(@dots{})} expression is found,
2229 while @option{-Wselector} only performs its checks in the final stage of
2230 compilation.  This also enforces the coding style convention
2231 that methods and selectors must be declared before being used.
2233 @item -print-objc-runtime-info
2234 @opindex print-objc-runtime-info
2235 Generate C header describing the largest structure that is passed by
2236 value, if any.
2238 @end table
2240 @node Language Independent Options
2241 @section Options to Control Diagnostic Messages Formatting
2242 @cindex options to control diagnostics formatting
2243 @cindex diagnostic messages
2244 @cindex message formatting
2246 Traditionally, diagnostic messages have been formatted irrespective of
2247 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2248 below can be used to control the diagnostic messages formatting
2249 algorithm, e.g.@: how many characters per line, how often source location
2250 information should be reported.  Right now, only the C++ front end can
2251 honor these options.  However it is expected, in the near future, that
2252 the remaining front ends would be able to digest them correctly.
2254 @table @gcctabopt
2255 @item -fmessage-length=@var{n}
2256 @opindex fmessage-length
2257 Try to format error messages so that they fit on lines of about @var{n}
2258 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2259 the front ends supported by GCC@.  If @var{n} is zero, then no
2260 line-wrapping will be done; each error message will appear on a single
2261 line.
2263 @opindex fdiagnostics-show-location
2264 @item -fdiagnostics-show-location=once
2265 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2266 reporter to emit @emph{once} source location information; that is, in
2267 case the message is too long to fit on a single physical line and has to
2268 be wrapped, the source location won't be emitted (as prefix) again,
2269 over and over, in subsequent continuation lines.  This is the default
2270 behavior.
2272 @item -fdiagnostics-show-location=every-line
2273 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2274 messages reporter to emit the same source location information (as
2275 prefix) for physical lines that result from the process of breaking
2276 a message which is too long to fit on a single line.
2278 @item -fdiagnostics-show-option
2279 @opindex fdiagnostics-show-option
2280 This option instructs the diagnostic machinery to add text to each
2281 diagnostic emitted, which indicates which command line option directly
2282 controls that diagnostic, when such an option is known to the
2283 diagnostic machinery.
2285 @item -Wcoverage-mismatch
2286 @opindex Wcoverage-mismatch
2287 Warn if feedback profiles do not match when using the
2288 @option{-fprofile-use} option.
2289 If a source file was changed between @option{-fprofile-gen} and
2290 @option{-fprofile-use}, the files with the profile feedback can fail
2291 to match the source file and GCC can not use the profile feedback
2292 information.  By default, GCC emits an error message in this case.
2293 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2294 error.  GCC does not use appropriate feedback profiles, so using this
2295 option can result in poorly optimized code.  This option is useful
2296 only in the case of very minor changes such as bugfixes to an
2297 existing code-base.
2299 @end table
2301 @node Warning Options
2302 @section Options to Request or Suppress Warnings
2303 @cindex options to control warnings
2304 @cindex warning messages
2305 @cindex messages, warning
2306 @cindex suppressing warnings
2308 Warnings are diagnostic messages that report constructions which
2309 are not inherently erroneous but which are risky or suggest there
2310 may have been an error.
2312 You can request many specific warnings with options beginning @samp{-W},
2313 for example @option{-Wimplicit} to request warnings on implicit
2314 declarations.  Each of these specific warning options also has a
2315 negative form beginning @samp{-Wno-} to turn off warnings;
2316 for example, @option{-Wno-implicit}.  This manual lists only one of the
2317 two forms, whichever is not the default.
2319 The following options control the amount and kinds of warnings produced
2320 by GCC; for further, language-specific options also refer to
2321 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2322 Options}.
2324 @table @gcctabopt
2325 @cindex syntax checking
2326 @item -fsyntax-only
2327 @opindex fsyntax-only
2328 Check the code for syntax errors, but don't do anything beyond that.
2330 @item -pedantic
2331 @opindex pedantic
2332 Issue all the warnings demanded by strict ISO C and ISO C++;
2333 reject all programs that use forbidden extensions, and some other
2334 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2335 version of the ISO C standard specified by any @option{-std} option used.
2337 Valid ISO C and ISO C++ programs should compile properly with or without
2338 this option (though a rare few will require @option{-ansi} or a
2339 @option{-std} option specifying the required version of ISO C)@.  However,
2340 without this option, certain GNU extensions and traditional C and C++
2341 features are supported as well.  With this option, they are rejected.
2343 @option{-pedantic} does not cause warning messages for use of the
2344 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2345 warnings are also disabled in the expression that follows
2346 @code{__extension__}.  However, only system header files should use
2347 these escape routes; application programs should avoid them.
2348 @xref{Alternate Keywords}.
2350 Some users try to use @option{-pedantic} to check programs for strict ISO
2351 C conformance.  They soon find that it does not do quite what they want:
2352 it finds some non-ISO practices, but not all---only those for which
2353 ISO C @emph{requires} a diagnostic, and some others for which
2354 diagnostics have been added.
2356 A feature to report any failure to conform to ISO C might be useful in
2357 some instances, but would require considerable additional work and would
2358 be quite different from @option{-pedantic}.  We don't have plans to
2359 support such a feature in the near future.
2361 Where the standard specified with @option{-std} represents a GNU
2362 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2363 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2364 extended dialect is based.  Warnings from @option{-pedantic} are given
2365 where they are required by the base standard.  (It would not make sense
2366 for such warnings to be given only for features not in the specified GNU
2367 C dialect, since by definition the GNU dialects of C include all
2368 features the compiler supports with the given option, and there would be
2369 nothing to warn about.)
2371 @item -pedantic-errors
2372 @opindex pedantic-errors
2373 Like @option{-pedantic}, except that errors are produced rather than
2374 warnings.
2376 @item -w
2377 @opindex w
2378 Inhibit all warning messages.
2380 @item -Wno-import
2381 @opindex Wno-import
2382 Inhibit warning messages about the use of @samp{#import}.
2384 @item -Wchar-subscripts
2385 @opindex Wchar-subscripts
2386 Warn if an array subscript has type @code{char}.  This is a common cause
2387 of error, as programmers often forget that this type is signed on some
2388 machines.
2389 This warning is enabled by @option{-Wall}.
2391 @item -Wcomment
2392 @opindex Wcomment
2393 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2394 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2395 This warning is enabled by @option{-Wall}.
2397 @item -Wfatal-errors
2398 @opindex Wfatal-errors
2399 This option causes the compiler to abort compilation on the first error
2400 occurred rather than trying to keep going and printing further error
2401 messages.
2403 @item -Wformat
2404 @opindex Wformat
2405 @opindex ffreestanding
2406 @opindex fno-builtin
2407 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2408 the arguments supplied have types appropriate to the format string
2409 specified, and that the conversions specified in the format string make
2410 sense.  This includes standard functions, and others specified by format
2411 attributes (@pxref{Function Attributes}), in the @code{printf},
2412 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2413 not in the C standard) families (or other target-specific families).
2414 Which functions are checked without format attributes having been
2415 specified depends on the standard version selected, and such checks of
2416 functions without the attribute specified are disabled by
2417 @option{-ffreestanding} or @option{-fno-builtin}.
2419 The formats are checked against the format features supported by GNU
2420 libc version 2.2.  These include all ISO C90 and C99 features, as well
2421 as features from the Single Unix Specification and some BSD and GNU
2422 extensions.  Other library implementations may not support all these
2423 features; GCC does not support warning about features that go beyond a
2424 particular library's limitations.  However, if @option{-pedantic} is used
2425 with @option{-Wformat}, warnings will be given about format features not
2426 in the selected standard version (but not for @code{strfmon} formats,
2427 since those are not in any version of the C standard).  @xref{C Dialect
2428 Options,,Options Controlling C Dialect}.
2430 Since @option{-Wformat} also checks for null format arguments for
2431 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2433 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2434 aspects of format checking, the options @option{-Wformat-y2k},
2435 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2436 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2437 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2439 @item -Wformat-y2k
2440 @opindex Wformat-y2k
2441 If @option{-Wformat} is specified, also warn about @code{strftime}
2442 formats which may yield only a two-digit year.
2444 @item -Wno-format-extra-args
2445 @opindex Wno-format-extra-args
2446 If @option{-Wformat} is specified, do not warn about excess arguments to a
2447 @code{printf} or @code{scanf} format function.  The C standard specifies
2448 that such arguments are ignored.
2450 Where the unused arguments lie between used arguments that are
2451 specified with @samp{$} operand number specifications, normally
2452 warnings are still given, since the implementation could not know what
2453 type to pass to @code{va_arg} to skip the unused arguments.  However,
2454 in the case of @code{scanf} formats, this option will suppress the
2455 warning if the unused arguments are all pointers, since the Single
2456 Unix Specification says that such unused arguments are allowed.
2458 @item -Wno-format-zero-length
2459 @opindex Wno-format-zero-length
2460 If @option{-Wformat} is specified, do not warn about zero-length formats.
2461 The C standard specifies that zero-length formats are allowed.
2463 @item -Wformat-nonliteral
2464 @opindex Wformat-nonliteral
2465 If @option{-Wformat} is specified, also warn if the format string is not a
2466 string literal and so cannot be checked, unless the format function
2467 takes its format arguments as a @code{va_list}.
2469 @item -Wformat-security
2470 @opindex Wformat-security
2471 If @option{-Wformat} is specified, also warn about uses of format
2472 functions that represent possible security problems.  At present, this
2473 warns about calls to @code{printf} and @code{scanf} functions where the
2474 format string is not a string literal and there are no format arguments,
2475 as in @code{printf (foo);}.  This may be a security hole if the format
2476 string came from untrusted input and contains @samp{%n}.  (This is
2477 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2478 in future warnings may be added to @option{-Wformat-security} that are not
2479 included in @option{-Wformat-nonliteral}.)
2481 @item -Wformat=2
2482 @opindex Wformat=2
2483 Enable @option{-Wformat} plus format checks not included in
2484 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2485 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2487 @item -Wnonnull
2488 @opindex Wnonnull
2489 Warn about passing a null pointer for arguments marked as
2490 requiring a non-null value by the @code{nonnull} function attribute.
2492 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2493 can be disabled with the @option{-Wno-nonnull} option.
2495 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2496 @opindex Winit-self
2497 Warn about uninitialized variables which are initialized with themselves.
2498 Note this option can only be used with the @option{-Wuninitialized} option,
2499 which in turn only works with @option{-O1} and above.
2501 For example, GCC will warn about @code{i} being uninitialized in the
2502 following snippet only when @option{-Winit-self} has been specified:
2503 @smallexample
2504 @group
2505 int f()
2507   int i = i;
2508   return i;
2510 @end group
2511 @end smallexample
2513 @item -Wimplicit-int
2514 @opindex Wimplicit-int
2515 Warn when a declaration does not specify a type.
2516 This warning is enabled by @option{-Wall}.
2518 @item -Wimplicit-function-declaration
2519 @itemx -Werror-implicit-function-declaration
2520 @opindex Wimplicit-function-declaration
2521 @opindex Werror-implicit-function-declaration
2522 Give a warning (or error) whenever a function is used before being
2523 declared.  The form @option{-Wno-error-implicit-function-declaration}
2524 is not supported.
2525 This warning is enabled by @option{-Wall} (as a warning, not an error).
2527 @item -Wimplicit
2528 @opindex Wimplicit
2529 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2530 This warning is enabled by @option{-Wall}.
2532 @item -Wmain
2533 @opindex Wmain
2534 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2535 function with external linkage, returning int, taking either zero
2536 arguments, two, or three arguments of appropriate types.
2537 This warning is enabled by @option{-Wall}.
2539 @item -Wmissing-braces
2540 @opindex Wmissing-braces
2541 Warn if an aggregate or union initializer is not fully bracketed.  In
2542 the following example, the initializer for @samp{a} is not fully
2543 bracketed, but that for @samp{b} is fully bracketed.
2545 @smallexample
2546 int a[2][2] = @{ 0, 1, 2, 3 @};
2547 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2548 @end smallexample
2550 This warning is enabled by @option{-Wall}.
2552 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2553 @opindex Wmissing-include-dirs
2554 Warn if a user-supplied include directory does not exist.
2556 @item -Wparentheses
2557 @opindex Wparentheses
2558 Warn if parentheses are omitted in certain contexts, such
2559 as when there is an assignment in a context where a truth value
2560 is expected, or when operators are nested whose precedence people
2561 often get confused about.
2563 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2564 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2565 interpretation from that of ordinary mathematical notation.
2567 Also warn about constructions where there may be confusion to which
2568 @code{if} statement an @code{else} branch belongs.  Here is an example of
2569 such a case:
2571 @smallexample
2572 @group
2574   if (a)
2575     if (b)
2576       foo ();
2577   else
2578     bar ();
2580 @end group
2581 @end smallexample
2583 In C/C++, every @code{else} branch belongs to the innermost possible
2584 @code{if} statement, which in this example is @code{if (b)}.  This is
2585 often not what the programmer expected, as illustrated in the above
2586 example by indentation the programmer chose.  When there is the
2587 potential for this confusion, GCC will issue a warning when this flag
2588 is specified.  To eliminate the warning, add explicit braces around
2589 the innermost @code{if} statement so there is no way the @code{else}
2590 could belong to the enclosing @code{if}.  The resulting code would
2591 look like this:
2593 @smallexample
2594 @group
2596   if (a)
2597     @{
2598       if (b)
2599         foo ();
2600       else
2601         bar ();
2602     @}
2604 @end group
2605 @end smallexample
2607 This warning is enabled by @option{-Wall}.
2609 @item -Wsequence-point
2610 @opindex Wsequence-point
2611 Warn about code that may have undefined semantics because of violations
2612 of sequence point rules in the C and C++ standards.
2614 The C and C++ standards defines the order in which expressions in a C/C++
2615 program are evaluated in terms of @dfn{sequence points}, which represent
2616 a partial ordering between the execution of parts of the program: those
2617 executed before the sequence point, and those executed after it.  These
2618 occur after the evaluation of a full expression (one which is not part
2619 of a larger expression), after the evaluation of the first operand of a
2620 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2621 function is called (but after the evaluation of its arguments and the
2622 expression denoting the called function), and in certain other places.
2623 Other than as expressed by the sequence point rules, the order of
2624 evaluation of subexpressions of an expression is not specified.  All
2625 these rules describe only a partial order rather than a total order,
2626 since, for example, if two functions are called within one expression
2627 with no sequence point between them, the order in which the functions
2628 are called is not specified.  However, the standards committee have
2629 ruled that function calls do not overlap.
2631 It is not specified when between sequence points modifications to the
2632 values of objects take effect.  Programs whose behavior depends on this
2633 have undefined behavior; the C and C++ standards specify that ``Between
2634 the previous and next sequence point an object shall have its stored
2635 value modified at most once by the evaluation of an expression.  
2636 Furthermore, the prior value shall be read only to determine the value
2637 to be stored.''.  If a program breaks these rules, the results on any
2638 particular implementation are entirely unpredictable.
2640 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2641 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2642 diagnosed by this option, and it may give an occasional false positive
2643 result, but in general it has been found fairly effective at detecting
2644 this sort of problem in programs.
2646 The standard is worded confusingly, therefore there is some debate
2647 over the precise meaning of the sequence point rules in subtle cases.
2648 Links to discussions of the problem, including proposed formal
2649 definitions, may be found on the GCC readings page, at
2650 @w{@uref{http://gcc.gnu.org/readings.html}}.
2652 This warning is enabled by @option{-Wall} for C and C++.
2654 @item -Wreturn-type
2655 @opindex Wreturn-type
2656 Warn whenever a function is defined with a return-type that defaults to
2657 @code{int}.  Also warn about any @code{return} statement with no
2658 return-value in a function whose return-type is not @code{void}.
2660 Also warn if the return type of a function has a type qualifier
2661 such as @code{const}.  For ISO C such a type qualifier has no effect,
2662 since the value returned by a function is not an lvalue.
2663 For C++, the warning is only emitted for scalar types or @code{void}.
2664 ISO C prohibits qualified @code{void} return types on function
2665 definitions, so such return types always receive a warning
2666 even without this option.
2668 For C++, a function without return type always produces a diagnostic
2669 message, even when @option{-Wno-return-type} is specified.  The only
2670 exceptions are @samp{main} and functions defined in system headers.
2672 This warning is enabled by @option{-Wall}.
2674 @item -Wswitch
2675 @opindex Wswitch
2676 Warn whenever a @code{switch} statement has an index of enumerated type
2677 and lacks a @code{case} for one or more of the named codes of that
2678 enumeration.  (The presence of a @code{default} label prevents this
2679 warning.)  @code{case} labels outside the enumeration range also
2680 provoke warnings when this option is used.
2681 This warning is enabled by @option{-Wall}.
2683 @item -Wswitch-default
2684 @opindex Wswitch-switch
2685 Warn whenever a @code{switch} statement does not have a @code{default}
2686 case.
2688 @item -Wswitch-enum
2689 @opindex Wswitch-enum
2690 Warn whenever a @code{switch} statement has an index of enumerated type
2691 and lacks a @code{case} for one or more of the named codes of that
2692 enumeration.  @code{case} labels outside the enumeration range also
2693 provoke warnings when this option is used.
2695 @item -Wtrigraphs
2696 @opindex Wtrigraphs
2697 Warn if any trigraphs are encountered that might change the meaning of
2698 the program (trigraphs within comments are not warned about).
2699 This warning is enabled by @option{-Wall}.
2701 @item -Wunused-function
2702 @opindex Wunused-function
2703 Warn whenever a static function is declared but not defined or a
2704 non-inline static function is unused.
2705 This warning is enabled by @option{-Wall}.
2707 @item -Wunused-label
2708 @opindex Wunused-label
2709 Warn whenever a label is declared but not used.
2710 This warning is enabled by @option{-Wall}.
2712 To suppress this warning use the @samp{unused} attribute
2713 (@pxref{Variable Attributes}).
2715 @item -Wunused-parameter
2716 @opindex Wunused-parameter
2717 Warn whenever a function parameter is unused aside from its declaration.
2719 To suppress this warning use the @samp{unused} attribute
2720 (@pxref{Variable Attributes}).
2722 @item -Wunused-variable
2723 @opindex Wunused-variable
2724 Warn whenever a local variable or non-constant static variable is unused
2725 aside from its declaration.
2726 This warning is enabled by @option{-Wall}.
2728 To suppress this warning use the @samp{unused} attribute
2729 (@pxref{Variable Attributes}).
2731 @item -Wunused-value
2732 @opindex Wunused-value
2733 Warn whenever a statement computes a result that is explicitly not used.
2734 This warning is enabled by @option{-Wall}.
2736 To suppress this warning cast the expression to @samp{void}.
2738 @item -Wunused
2739 @opindex Wunused
2740 All the above @option{-Wunused} options combined.
2742 In order to get a warning about an unused function parameter, you must
2743 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2744 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2746 @item -Wuninitialized
2747 @opindex Wuninitialized
2748 Warn if an automatic variable is used without first being initialized or
2749 if a variable may be clobbered by a @code{setjmp} call.
2751 These warnings are possible only in optimizing compilation,
2752 because they require data flow information that is computed only
2753 when optimizing.  If you do not specify @option{-O}, you will not get 
2754 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2755 requiring @option{-O}.
2757 If you want to warn about code which uses the uninitialized value of the
2758 variable in its own initializer, use the @option{-Winit-self} option.
2760 These warnings occur for individual uninitialized or clobbered
2761 elements of structure, union or array variables as well as for
2762 variables which are uninitialized or clobbered as a whole.  They do
2763 not occur for variables or elements declared @code{volatile}.  Because
2764 these warnings depend on optimization, the exact variables or elements
2765 for which there are warnings will depend on the precise optimization
2766 options and version of GCC used.
2768 Note that there may be no warning about a variable that is used only
2769 to compute a value that itself is never used, because such
2770 computations may be deleted by data flow analysis before the warnings
2771 are printed.
2773 These warnings are made optional because GCC is not smart
2774 enough to see all the reasons why the code might be correct
2775 despite appearing to have an error.  Here is one example of how
2776 this can happen:
2778 @smallexample
2779 @group
2781   int x;
2782   switch (y)
2783     @{
2784     case 1: x = 1;
2785       break;
2786     case 2: x = 4;
2787       break;
2788     case 3: x = 5;
2789     @}
2790   foo (x);
2792 @end group
2793 @end smallexample
2795 @noindent
2796 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2797 always initialized, but GCC doesn't know this.  Here is
2798 another common case:
2800 @smallexample
2802   int save_y;
2803   if (change_y) save_y = y, y = new_y;
2804   @dots{}
2805   if (change_y) y = save_y;
2807 @end smallexample
2809 @noindent
2810 This has no bug because @code{save_y} is used only if it is set.
2812 @cindex @code{longjmp} warnings
2813 This option also warns when a non-volatile automatic variable might be
2814 changed by a call to @code{longjmp}.  These warnings as well are possible
2815 only in optimizing compilation.
2817 The compiler sees only the calls to @code{setjmp}.  It cannot know
2818 where @code{longjmp} will be called; in fact, a signal handler could
2819 call it at any point in the code.  As a result, you may get a warning
2820 even when there is in fact no problem because @code{longjmp} cannot
2821 in fact be called at the place which would cause a problem.
2823 Some spurious warnings can be avoided if you declare all the functions
2824 you use that never return as @code{noreturn}.  @xref{Function
2825 Attributes}.
2827 This warning is enabled by @option{-Wall}.
2829 @item -Wunknown-pragmas
2830 @opindex Wunknown-pragmas
2831 @cindex warning for unknown pragmas
2832 @cindex unknown pragmas, warning
2833 @cindex pragmas, warning of unknown
2834 Warn when a #pragma directive is encountered which is not understood by
2835 GCC@.  If this command line option is used, warnings will even be issued
2836 for unknown pragmas in system header files.  This is not the case if
2837 the warnings were only enabled by the @option{-Wall} command line option.
2839 @item -Wno-pragmas
2840 @opindex Wno-pragmas
2841 @opindex Wpragmas
2842 Do not warn about misuses of pragmas, such as incorrect parameters,
2843 invalid syntax, or conflicts between pragmas.  See also
2844 @samp{-Wunknown-pragmas}.
2846 @item -Wstrict-aliasing
2847 @opindex Wstrict-aliasing
2848 This option is only active when @option{-fstrict-aliasing} is active.
2849 It warns about code which might break the strict aliasing rules that the
2850 compiler is using for optimization.  The warning does not catch all
2851 cases, but does attempt to catch the more common pitfalls.  It is
2852 included in @option{-Wall}.
2854 @item -Wstrict-aliasing=2
2855 @opindex Wstrict-aliasing=2
2856 This option is only active when @option{-fstrict-aliasing} is active.
2857 It warns about code which might break the strict aliasing rules that the
2858 compiler is using for optimization.  This warning catches more cases than
2859 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2860 cases that are safe.
2862 @item -Warray-bounds
2863 @opindex Wno-array-bounds
2864 @opindex Warray-bounds
2865 This option is only active when @option{-ftree-vrp} is active
2866 (default for -O2 and above). It warns about subscripts to arrays
2867 that are always out of bounds. This warning is enabled by @option{-Wall}.
2869 @item -Wall
2870 @opindex Wall
2871 All of the above @samp{-W} options combined.  This enables all the
2872 warnings about constructions that some users consider questionable, and
2873 that are easy to avoid (or modify to prevent the warning), even in
2874 conjunction with macros.  This also enables some language-specific
2875 warnings described in @ref{C++ Dialect Options} and
2876 @ref{Objective-C and Objective-C++ Dialect Options}.
2877 @end table
2879 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2880 Some of them warn about constructions that users generally do not
2881 consider questionable, but which occasionally you might wish to check
2882 for; others warn about constructions that are necessary or hard to avoid
2883 in some cases, and there is no simple way to modify the code to suppress
2884 the warning.
2886 @table @gcctabopt
2887 @item -Wextra
2888 @opindex W
2889 @opindex Wextra
2890 (This option used to be called @option{-W}.  The older name is still
2891 supported, but the newer name is more descriptive.)  Print extra warning
2892 messages for these events:
2894 @itemize @bullet
2895 @item
2896 A function can return either with or without a value.  (Falling
2897 off the end of the function body is considered returning without
2898 a value.)  For example, this function would evoke such a
2899 warning:
2901 @smallexample
2902 @group
2903 foo (a)
2905   if (a > 0)
2906     return a;
2908 @end group
2909 @end smallexample
2911 @item
2912 An expression-statement or the left-hand side of a comma expression
2913 contains no side effects.
2914 To suppress the warning, cast the unused expression to void.
2915 For example, an expression such as @samp{x[i,j]} will cause a warning,
2916 but @samp{x[(void)i,j]} will not.
2918 @item
2919 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2921 @item @r{(C only)}
2922 Storage-class specifiers like @code{static} are not the first things
2923 in a declaration.  According to the C Standard, this usage is
2924 obsolescent.  This warning can be independently controlled by
2925 @option{-Wold-style-declaration}.
2927 @item
2928 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2929 arguments.
2931 @item
2932 A comparison between signed and unsigned values could produce an
2933 incorrect result when the signed value is converted to unsigned.
2934 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2936 @item
2937 An aggregate has an initializer which does not initialize all members.
2938 This warning can be independently controlled by
2939 @option{-Wmissing-field-initializers}.
2941 @item
2942 An initialized field without side effects is overridden when using
2943 designated initializers (@pxref{Designated Inits, , Designated
2944 Initializers}).  This warning can be independently controlled by
2945 @option{-Woverride-init}.
2947 @item @r{(C only)}
2948 A function parameter is declared without a type specifier in K&R-style
2949 functions.  This warning can be independently controlled by
2950 @option{-Wmissing-parameter-type}.
2952 @item
2953 An empty body occurs in an @samp{if} or @samp{else} statement. This
2954 warning can be independently controlled by @option{-Wempty-body}.
2956 @item
2957 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2958 @samp{>}, or @samp{>=}.
2960 @item
2961 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2962 This warning can be independently controlled by @option{-Wclobbered}.
2964 @item
2965 Any of several floating-point events that often indicate errors, such as
2966 overflow, underflow, loss of precision, etc.
2968 @item @r{(C++ only)}
2969 An enumerator and a non-enumerator both appear in a conditional expression.
2971 @item @r{(C++ only)}
2972 A non-static reference or non-static @samp{const} member appears in a
2973 class without constructors.
2975 @item @r{(C++ only)}
2976 Ambiguous virtual bases.
2978 @item @r{(C++ only)}
2979 Subscripting an array which has been declared @samp{register}.
2981 @item @r{(C++ only)}
2982 Taking the address of a variable which has been declared @samp{register}.
2984 @item @r{(C++ only)}
2985 A base class is not initialized in a derived class' copy constructor.
2986 @end itemize
2988 @item -Wno-div-by-zero
2989 @opindex Wno-div-by-zero
2990 @opindex Wdiv-by-zero
2991 Do not warn about compile-time integer division by zero.  Floating point
2992 division by zero is not warned about, as it can be a legitimate way of
2993 obtaining infinities and NaNs.
2995 @item -Wsystem-headers
2996 @opindex Wsystem-headers
2997 @cindex warnings from system headers
2998 @cindex system headers, warnings from
2999 Print warning messages for constructs found in system header files.
3000 Warnings from system headers are normally suppressed, on the assumption
3001 that they usually do not indicate real problems and would only make the
3002 compiler output harder to read.  Using this command line option tells
3003 GCC to emit warnings from system headers as if they occurred in user
3004 code.  However, note that using @option{-Wall} in conjunction with this
3005 option will @emph{not} warn about unknown pragmas in system
3006 headers---for that, @option{-Wunknown-pragmas} must also be used.
3008 @item -Wfloat-equal
3009 @opindex Wfloat-equal
3010 Warn if floating point values are used in equality comparisons.
3012 The idea behind this is that sometimes it is convenient (for the
3013 programmer) to consider floating-point values as approximations to
3014 infinitely precise real numbers.  If you are doing this, then you need
3015 to compute (by analyzing the code, or in some other way) the maximum or
3016 likely maximum error that the computation introduces, and allow for it
3017 when performing comparisons (and when producing output, but that's a
3018 different problem).  In particular, instead of testing for equality, you
3019 would check to see whether the two values have ranges that overlap; and
3020 this is done with the relational operators, so equality comparisons are
3021 probably mistaken.
3023 @item -Wtraditional @r{(C only)}
3024 @opindex Wtraditional
3025 Warn about certain constructs that behave differently in traditional and
3026 ISO C@.  Also warn about ISO C constructs that have no traditional C
3027 equivalent, and/or problematic constructs which should be avoided.
3029 @itemize @bullet
3030 @item
3031 Macro parameters that appear within string literals in the macro body.
3032 In traditional C macro replacement takes place within string literals,
3033 but does not in ISO C@.
3035 @item
3036 In traditional C, some preprocessor directives did not exist.
3037 Traditional preprocessors would only consider a line to be a directive
3038 if the @samp{#} appeared in column 1 on the line.  Therefore
3039 @option{-Wtraditional} warns about directives that traditional C
3040 understands but would ignore because the @samp{#} does not appear as the
3041 first character on the line.  It also suggests you hide directives like
3042 @samp{#pragma} not understood by traditional C by indenting them.  Some
3043 traditional implementations would not recognize @samp{#elif}, so it
3044 suggests avoiding it altogether.
3046 @item
3047 A function-like macro that appears without arguments.
3049 @item
3050 The unary plus operator.
3052 @item
3053 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3054 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3055 constants.)  Note, these suffixes appear in macros defined in the system
3056 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3057 Use of these macros in user code might normally lead to spurious
3058 warnings, however GCC's integrated preprocessor has enough context to
3059 avoid warning in these cases.
3061 @item
3062 A function declared external in one block and then used after the end of
3063 the block.
3065 @item
3066 A @code{switch} statement has an operand of type @code{long}.
3068 @item
3069 A non-@code{static} function declaration follows a @code{static} one.
3070 This construct is not accepted by some traditional C compilers.
3072 @item
3073 The ISO type of an integer constant has a different width or
3074 signedness from its traditional type.  This warning is only issued if
3075 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3076 typically represent bit patterns, are not warned about.
3078 @item
3079 Usage of ISO string concatenation is detected.
3081 @item
3082 Initialization of automatic aggregates.
3084 @item
3085 Identifier conflicts with labels.  Traditional C lacks a separate
3086 namespace for labels.
3088 @item
3089 Initialization of unions.  If the initializer is zero, the warning is
3090 omitted.  This is done under the assumption that the zero initializer in
3091 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3092 initializer warnings and relies on default initialization to zero in the
3093 traditional C case.
3095 @item
3096 Conversions by prototypes between fixed/floating point values and vice
3097 versa.  The absence of these prototypes when compiling with traditional
3098 C would cause serious problems.  This is a subset of the possible
3099 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3101 @item
3102 Use of ISO C style function definitions.  This warning intentionally is
3103 @emph{not} issued for prototype declarations or variadic functions
3104 because these ISO C features will appear in your code when using
3105 libiberty's traditional C compatibility macros, @code{PARAMS} and
3106 @code{VPARAMS}.  This warning is also bypassed for nested functions
3107 because that feature is already a GCC extension and thus not relevant to
3108 traditional C compatibility.
3109 @end itemize
3111 @item -Wtraditional-conversion @r{(C only)}
3112 @opindex Wtraditional-conversion
3113 Warn if a prototype causes a type conversion that is different from what
3114 would happen to the same argument in the absence of a prototype.  This
3115 includes conversions of fixed point to floating and vice versa, and
3116 conversions changing the width or signedness of a fixed point argument
3117 except when the same as the default promotion.
3119 @item -Wdeclaration-after-statement @r{(C only)}
3120 @opindex Wdeclaration-after-statement
3121 Warn when a declaration is found after a statement in a block.  This
3122 construct, known from C++, was introduced with ISO C99 and is by default
3123 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3124 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3126 @item -Wundef
3127 @opindex Wundef
3128 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3130 @item -Wno-endif-labels
3131 @opindex Wno-endif-labels
3132 @opindex Wendif-labels
3133 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3135 @item -Wshadow
3136 @opindex Wshadow
3137 Warn whenever a local variable shadows another local variable, parameter or
3138 global variable or whenever a built-in function is shadowed.
3140 @item -Wlarger-than-@var{len}
3141 @opindex Wlarger-than
3142 Warn whenever an object of larger than @var{len} bytes is defined.
3144 @item -Wunsafe-loop-optimizations
3145 @opindex Wunsafe-loop-optimizations
3146 Warn if the loop cannot be optimized because the compiler could not
3147 assume anything on the bounds of the loop indices.  With
3148 @option{-funsafe-loop-optimizations} warn if the compiler made
3149 such assumptions.
3151 @item -Wpointer-arith
3152 @opindex Wpointer-arith
3153 Warn about anything that depends on the ``size of'' a function type or
3154 of @code{void}.  GNU C assigns these types a size of 1, for
3155 convenience in calculations with @code{void *} pointers and pointers
3156 to functions.  In C++, warn also when an arithmetic operation involves
3157 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3159 @item -Wbad-function-cast @r{(C only)}
3160 @opindex Wbad-function-cast
3161 Warn whenever a function call is cast to a non-matching type.
3162 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3164 @item -Wc++-compat
3165 Warn about ISO C constructs that are outside of the common subset of
3166 ISO C and ISO C++, e.g.@: request for implicit conversion from
3167 @code{void *} to a pointer to non-@code{void} type.
3169 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3170 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3171 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords 
3172 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3174 @item -Wcast-qual
3175 @opindex Wcast-qual
3176 Warn whenever a pointer is cast so as to remove a type qualifier from
3177 the target type.  For example, warn if a @code{const char *} is cast
3178 to an ordinary @code{char *}.
3180 @item -Wcast-align
3181 @opindex Wcast-align
3182 Warn whenever a pointer is cast such that the required alignment of the
3183 target is increased.  For example, warn if a @code{char *} is cast to
3184 an @code{int *} on machines where integers can only be accessed at
3185 two- or four-byte boundaries.
3187 @item -Wwrite-strings
3188 @opindex Wwrite-strings
3189 When compiling C, give string constants the type @code{const
3190 char[@var{length}]} so that
3191 copying the address of one into a non-@code{const} @code{char *}
3192 pointer will get a warning; when compiling C++, warn about the
3193 deprecated conversion from string literals to @code{char *}.  This
3194 warning, by default, is enabled for C++ programs.
3195 These warnings will help you find at
3196 compile time code that can try to write into a string constant, but
3197 only if you have been very careful about using @code{const} in
3198 declarations and prototypes.  Otherwise, it will just be a nuisance;
3199 this is why we did not make @option{-Wall} request these warnings.
3201 @item -Wclobbered
3202 @opindex Wclobbered
3203 Warn for variables that might be changed by @samp{longjmp} or
3204 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3206 @item -Wconversion
3207 @opindex Wconversion
3208 Warn for implicit conversions that may alter a value. This includes
3209 conversions between real and integer, like @code{abs (x)} when
3210 @code{x} is @code{double}; conversions between signed and unsigned,
3211 like @code{unsigned ui = -1}; and conversions to smaller types, like
3212 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3213 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3214 changed by the conversion like in @code{abs (2.0)}.
3216 @item -Wempty-body
3217 @opindex Wempty-body
3218 An empty body occurs in an @samp{if} or @samp{else} statement. 
3219 This warning is also enabled by @option{-Wextra}.
3221 @item -Wsign-compare
3222 @opindex Wsign-compare
3223 @cindex warning for comparison of signed and unsigned values
3224 @cindex comparison of signed and unsigned values, warning
3225 @cindex signed and unsigned values, comparison warning
3226 Warn when a comparison between signed and unsigned values could produce
3227 an incorrect result when the signed value is converted to unsigned.
3228 This warning is also enabled by @option{-Wextra}; to get the other warnings
3229 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3231 @item -Waggregate-return
3232 @opindex Waggregate-return
3233 Warn if any functions that return structures or unions are defined or
3234 called.  (In languages where you can return an array, this also elicits
3235 a warning.)
3237 @item -Walways-true
3238 @opindex Walways-true
3239 Warn about comparisons which are always true such as testing if
3240 unsigned values are greater than or equal to zero.  This warning is
3241 enabled by @option{-Wall}.
3243 @item -Wno-attributes
3244 @opindex Wno-attributes
3245 @opindex Wattributes
3246 Do not warn if an unexpected @code{__attribute__} is used, such as
3247 unrecognized attributes, function attributes applied to variables,
3248 etc.  This will not stop errors for incorrect use of supported
3249 attributes.
3251 @item -Wstrict-prototypes @r{(C only)}
3252 @opindex Wstrict-prototypes
3253 Warn if a function is declared or defined without specifying the
3254 argument types.  (An old-style function definition is permitted without
3255 a warning if preceded by a declaration which specifies the argument
3256 types.)
3258 @item -Wold-style-declaration @r{(C only)}
3259 @opindex Wold-style-declaration
3260 Warn for obsolescent usages, according to the C Standard, in a
3261 declaration. For example, warn if storage-class specifiers like
3262 @code{static} are not the first things in a declaration.  This warning
3263 is also enabled by @option{-Wextra}.
3265 @item -Wold-style-definition @r{(C only)}
3266 @opindex Wold-style-definition
3267 Warn if an old-style function definition is used.  A warning is given
3268 even if there is a previous prototype.
3270 @item -Wmissing-parameter-type @r{(C only)}
3271 @opindex Wmissing-parameter-type
3272 A function parameter is declared without a type specifier in K&R-style
3273 functions:
3275 @smallexample
3276 void foo(bar) @{ @}
3277 @end smallexample
3279 This warning is also enabled by @option{-Wextra}.
3281 @item -Wmissing-prototypes @r{(C only)}
3282 @opindex Wmissing-prototypes
3283 Warn if a global function is defined without a previous prototype
3284 declaration.  This warning is issued even if the definition itself
3285 provides a prototype.  The aim is to detect global functions that fail
3286 to be declared in header files.
3288 @item -Wmissing-declarations @r{(C and C++ only)}
3289 @opindex Wmissing-declarations
3290 Warn if a global function is defined without a previous declaration.
3291 Do so even if the definition itself provides a prototype.
3292 Use this option to detect global functions that are not declared in
3293 header files.  In C++, no warnings are issued for function templates,
3294 or for inline functions, or for functions in anonymous namespaces.
3296 @item -Wmissing-field-initializers
3297 @opindex Wmissing-field-initializers
3298 @opindex W
3299 @opindex Wextra
3300 Warn if a structure's initializer has some fields missing.  For
3301 example, the following code would cause such a warning, because
3302 @code{x.h} is implicitly zero:
3304 @smallexample
3305 struct s @{ int f, g, h; @};
3306 struct s x = @{ 3, 4 @};
3307 @end smallexample
3309 This option does not warn about designated initializers, so the following
3310 modification would not trigger a warning:
3312 @smallexample
3313 struct s @{ int f, g, h; @};
3314 struct s x = @{ .f = 3, .g = 4 @};
3315 @end smallexample
3317 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3318 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3320 @item -Wmissing-noreturn
3321 @opindex Wmissing-noreturn
3322 Warn about functions which might be candidates for attribute @code{noreturn}.
3323 Note these are only possible candidates, not absolute ones.  Care should
3324 be taken to manually verify functions actually do not ever return before
3325 adding the @code{noreturn} attribute, otherwise subtle code generation
3326 bugs could be introduced.  You will not get a warning for @code{main} in
3327 hosted C environments.
3329 @item -Wmissing-format-attribute
3330 @opindex Wmissing-format-attribute
3331 @opindex Wformat
3332 Warn about function pointers which might be candidates for @code{format}
3333 attributes.  Note these are only possible candidates, not absolute ones.
3334 GCC will guess that function pointers with @code{format} attributes that
3335 are used in assignment, initialization, parameter passing or return
3336 statements should have a corresponding @code{format} attribute in the
3337 resulting type.  I.e.@: the left-hand side of the assignment or
3338 initialization, the type of the parameter variable, or the return type
3339 of the containing function respectively should also have a @code{format}
3340 attribute to avoid the warning.
3342 GCC will also warn about function definitions which might be
3343 candidates for @code{format} attributes.  Again, these are only
3344 possible candidates.  GCC will guess that @code{format} attributes
3345 might be appropriate for any function that calls a function like
3346 @code{vprintf} or @code{vscanf}, but this might not always be the
3347 case, and some functions for which @code{format} attributes are
3348 appropriate may not be detected.
3350 @item -Wno-multichar
3351 @opindex Wno-multichar
3352 @opindex Wmultichar
3353 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3354 Usually they indicate a typo in the user's code, as they have
3355 implementation-defined values, and should not be used in portable code.
3357 @item -Wnormalized=<none|id|nfc|nfkc>
3358 @opindex Wnormalized
3359 @cindex NFC
3360 @cindex NFKC
3361 @cindex character set, input normalization
3362 In ISO C and ISO C++, two identifiers are different if they are
3363 different sequences of characters.  However, sometimes when characters
3364 outside the basic ASCII character set are used, you can have two
3365 different character sequences that look the same.  To avoid confusion,
3366 the ISO 10646 standard sets out some @dfn{normalization rules} which
3367 when applied ensure that two sequences that look the same are turned into
3368 the same sequence.  GCC can warn you if you are using identifiers which
3369 have not been normalized; this option controls that warning.
3371 There are four levels of warning that GCC supports.  The default is
3372 @option{-Wnormalized=nfc}, which warns about any identifier which is
3373 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3374 recommended form for most uses.
3376 Unfortunately, there are some characters which ISO C and ISO C++ allow
3377 in identifiers that when turned into NFC aren't allowable as
3378 identifiers.  That is, there's no way to use these symbols in portable
3379 ISO C or C++ and have all your identifiers in NFC.
3380 @option{-Wnormalized=id} suppresses the warning for these characters.
3381 It is hoped that future versions of the standards involved will correct
3382 this, which is why this option is not the default.
3384 You can switch the warning off for all characters by writing
3385 @option{-Wnormalized=none}.  You would only want to do this if you
3386 were using some other normalization scheme (like ``D''), because
3387 otherwise you can easily create bugs that are literally impossible to see.
3389 Some characters in ISO 10646 have distinct meanings but look identical
3390 in some fonts or display methodologies, especially once formatting has
3391 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3392 LETTER N'', will display just like a regular @code{n} which has been
3393 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3394 normalization scheme to convert all these into a standard form as
3395 well, and GCC will warn if your code is not in NFKC if you use
3396 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3397 about every identifier that contains the letter O because it might be
3398 confused with the digit 0, and so is not the default, but may be
3399 useful as a local coding convention if the programming environment is
3400 unable to be fixed to display these characters distinctly.
3402 @item -Wno-deprecated-declarations
3403 @opindex Wno-deprecated-declarations
3404 Do not warn about uses of functions (@pxref{Function Attributes}),
3405 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3406 Attributes}) marked as deprecated by using the @code{deprecated}
3407 attribute.
3409 @item -Wno-overflow
3410 @opindex Wno-overflow
3411 Do not warn about compile-time overflow in constant expressions.
3413 @item -Woverride-init
3414 @opindex Woverride-init
3415 @opindex W
3416 @opindex Wextra
3417 Warn if an initialized field without side effects is overridden when
3418 using designated initializers (@pxref{Designated Inits, , Designated
3419 Initializers}).
3421 This warning is included in @option{-Wextra}.  To get other
3422 @option{-Wextra} warnings without this one, use @samp{-Wextra
3423 -Wno-override-init}.
3425 @item -Wpacked
3426 @opindex Wpacked
3427 Warn if a structure is given the packed attribute, but the packed
3428 attribute has no effect on the layout or size of the structure.
3429 Such structures may be mis-aligned for little benefit.  For
3430 instance, in this code, the variable @code{f.x} in @code{struct bar}
3431 will be misaligned even though @code{struct bar} does not itself
3432 have the packed attribute:
3434 @smallexample
3435 @group
3436 struct foo @{
3437   int x;
3438   char a, b, c, d;
3439 @} __attribute__((packed));
3440 struct bar @{
3441   char z;
3442   struct foo f;
3444 @end group
3445 @end smallexample
3447 @item -Wpadded
3448 @opindex Wpadded
3449 Warn if padding is included in a structure, either to align an element
3450 of the structure or to align the whole structure.  Sometimes when this
3451 happens it is possible to rearrange the fields of the structure to
3452 reduce the padding and so make the structure smaller.
3454 @item -Wredundant-decls
3455 @opindex Wredundant-decls
3456 Warn if anything is declared more than once in the same scope, even in
3457 cases where multiple declaration is valid and changes nothing.
3459 @item -Wnested-externs @r{(C only)}
3460 @opindex Wnested-externs
3461 Warn if an @code{extern} declaration is encountered within a function.
3463 @item -Wunreachable-code
3464 @opindex Wunreachable-code
3465 Warn if the compiler detects that code will never be executed.
3467 This option is intended to warn when the compiler detects that at
3468 least a whole line of source code will never be executed, because
3469 some condition is never satisfied or because it is after a
3470 procedure that never returns.
3472 It is possible for this option to produce a warning even though there
3473 are circumstances under which part of the affected line can be executed,
3474 so care should be taken when removing apparently-unreachable code.
3476 For instance, when a function is inlined, a warning may mean that the
3477 line is unreachable in only one inlined copy of the function.
3479 This option is not made part of @option{-Wall} because in a debugging
3480 version of a program there is often substantial code which checks
3481 correct functioning of the program and is, hopefully, unreachable
3482 because the program does work.  Another common use of unreachable
3483 code is to provide behavior which is selectable at compile-time.
3485 @item -Winline
3486 @opindex Winline
3487 Warn if a function can not be inlined and it was declared as inline.
3488 Even with this option, the compiler will not warn about failures to
3489 inline functions declared in system headers.
3491 The compiler uses a variety of heuristics to determine whether or not
3492 to inline a function.  For example, the compiler takes into account
3493 the size of the function being inlined and the amount of inlining
3494 that has already been done in the current function.  Therefore,
3495 seemingly insignificant changes in the source program can cause the
3496 warnings produced by @option{-Winline} to appear or disappear.
3498 @item -Wno-invalid-offsetof @r{(C++ only)}
3499 @opindex Wno-invalid-offsetof
3500 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3501 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3502 to a non-POD type is undefined.  In existing C++ implementations,
3503 however, @samp{offsetof} typically gives meaningful results even when
3504 applied to certain kinds of non-POD types. (Such as a simple
3505 @samp{struct} that fails to be a POD type only by virtue of having a
3506 constructor.)  This flag is for users who are aware that they are
3507 writing nonportable code and who have deliberately chosen to ignore the
3508 warning about it.
3510 The restrictions on @samp{offsetof} may be relaxed in a future version
3511 of the C++ standard.
3513 @item -Wno-int-to-pointer-cast @r{(C only)}
3514 @opindex Wno-int-to-pointer-cast
3515 Suppress warnings from casts to pointer type of an integer of a
3516 different size.
3518 @item -Wno-pointer-to-int-cast @r{(C only)}
3519 @opindex Wno-pointer-to-int-cast
3520 Suppress warnings from casts from a pointer to an integer type of a
3521 different size.
3523 @item -Winvalid-pch
3524 @opindex Winvalid-pch
3525 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3526 the search path but can't be used.
3528 @item -Wlong-long
3529 @opindex Wlong-long
3530 @opindex Wno-long-long
3531 Warn if @samp{long long} type is used.  This is default.  To inhibit
3532 the warning messages, use @option{-Wno-long-long}.  Flags
3533 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3534 only when @option{-pedantic} flag is used.
3536 @item -Wvariadic-macros
3537 @opindex Wvariadic-macros
3538 @opindex Wno-variadic-macros
3539 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3540 alternate syntax when in pedantic ISO C99 mode.  This is default.
3541 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3543 @item -Wvolatile-register-var
3544 @opindex Wvolatile-register-var
3545 @opindex Wno-volatile-register-var
3546 Warn if a register variable is declared volatile.  The volatile
3547 modifier does not inhibit all optimizations that may eliminate reads
3548 and/or writes to register variables.
3550 @item -Wdisabled-optimization
3551 @opindex Wdisabled-optimization
3552 Warn if a requested optimization pass is disabled.  This warning does
3553 not generally indicate that there is anything wrong with your code; it
3554 merely indicates that GCC's optimizers were unable to handle the code
3555 effectively.  Often, the problem is that your code is too big or too
3556 complex; GCC will refuse to optimize programs when the optimization
3557 itself is likely to take inordinate amounts of time.
3559 @item -Wpointer-sign
3560 @opindex Wpointer-sign
3561 @opindex Wno-pointer-sign
3562 Warn for pointer argument passing or assignment with different signedness.
3563 This option is only supported for C and Objective-C@.  It is implied by
3564 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3565 @option{-Wno-pointer-sign}.
3567 @item -Werror
3568 @opindex Werror
3569 Make all warnings into errors.
3571 @item -Werror=
3572 @opindex Werror=
3573 Make the specified warning into an errors.  The specifier for a
3574 warning is appended, for example @option{-Werror=switch} turns the
3575 warnings controlled by @option{-Wswitch} into errors.  This switch
3576 takes a negative form, to be used to negate @option{-Werror} for
3577 specific warnings, for example @option{-Wno-error=switch} makes
3578 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3579 is in effect.  You can use the @option{-fdiagnostics-show-option}
3580 option to have each controllable warning amended with the option which
3581 controls it, to determine what to use with this option.
3583 Note that specifying @option{-Werror=}@var{foo} automatically implies
3584 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3585 imply anything.
3587 @item -Wstack-protector
3588 @opindex Wstack-protector
3589 This option is only active when @option{-fstack-protector} is active.  It
3590 warns about functions that will not be protected against stack smashing.
3592 @item -Wstring-literal-comparison
3593 @opindex Wstring-literal-comparison
3594 Warn about suspicious comparisons to string literal constants.  In C,
3595 direct comparisons against the memory address of a string literal, such
3596 as @code{if (x == "abc")}, typically indicate a programmer error, and
3597 even when intentional, result in unspecified behavior and are not portable.
3598 Usually these warnings alert that the programmer intended to use
3599 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3601 @item -Woverlength-strings
3602 @opindex Woverlength-strings
3603 Warn about string constants which are longer than the ``minimum
3604 maximum'' length specified in the C standard.  Modern compilers
3605 generally allow string constants which are much longer than the
3606 standard's minimum limit, but very portable programs should avoid
3607 using longer strings.
3609 The limit applies @emph{after} string constant concatenation, and does
3610 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3611 C99, it was raised to 4095.  C++98 does not specify a normative
3612 minimum maximum, so we do not diagnose overlength strings in C++@.
3614 This option is implied by @option{-pedantic}, and can be disabled with
3615 @option{-Wno-overlength-strings}.
3616 @end table
3618 @node Debugging Options
3619 @section Options for Debugging Your Program or GCC
3620 @cindex options, debugging
3621 @cindex debugging information options
3623 GCC has various special options that are used for debugging
3624 either your program or GCC:
3626 @table @gcctabopt
3627 @item -g
3628 @opindex g
3629 Produce debugging information in the operating system's native format
3630 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3631 information.
3633 On most systems that use stabs format, @option{-g} enables use of extra
3634 debugging information that only GDB can use; this extra information
3635 makes debugging work better in GDB but will probably make other debuggers
3636 crash or
3637 refuse to read the program.  If you want to control for certain whether
3638 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3639 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3641 GCC allows you to use @option{-g} with
3642 @option{-O}.  The shortcuts taken by optimized code may occasionally
3643 produce surprising results: some variables you declared may not exist
3644 at all; flow of control may briefly move where you did not expect it;
3645 some statements may not be executed because they compute constant
3646 results or their values were already at hand; some statements may
3647 execute in different places because they were moved out of loops.
3649 Nevertheless it proves possible to debug optimized output.  This makes
3650 it reasonable to use the optimizer for programs that might have bugs.
3652 The following options are useful when GCC is generated with the
3653 capability for more than one debugging format.
3655 @item -ggdb
3656 @opindex ggdb
3657 Produce debugging information for use by GDB@.  This means to use the
3658 most expressive format available (DWARF 2, stabs, or the native format
3659 if neither of those are supported), including GDB extensions if at all
3660 possible.
3662 @item -gstabs
3663 @opindex gstabs
3664 Produce debugging information in stabs format (if that is supported),
3665 without GDB extensions.  This is the format used by DBX on most BSD
3666 systems.  On MIPS, Alpha and System V Release 4 systems this option
3667 produces stabs debugging output which is not understood by DBX or SDB@.
3668 On System V Release 4 systems this option requires the GNU assembler.
3670 @item -feliminate-unused-debug-symbols
3671 @opindex feliminate-unused-debug-symbols
3672 Produce debugging information in stabs format (if that is supported),
3673 for only symbols that are actually used.
3675 @item -femit-class-debug-always
3676 Instead of emitting debugging information for a C++ class in only one
3677 object file, emit it in all object files using the class.  This option
3678 should be used only with debuggers that are unable to handle the way GCC
3679 normally emits debugging information for classes because using this
3680 option will increase the size of debugging information by as much as a
3681 factor of two.
3683 @item -gstabs+
3684 @opindex gstabs+
3685 Produce debugging information in stabs format (if that is supported),
3686 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3687 use of these extensions is likely to make other debuggers crash or
3688 refuse to read the program.
3690 @item -gcoff
3691 @opindex gcoff
3692 Produce debugging information in COFF format (if that is supported).
3693 This is the format used by SDB on most System V systems prior to
3694 System V Release 4.
3696 @item -gxcoff
3697 @opindex gxcoff
3698 Produce debugging information in XCOFF format (if that is supported).
3699 This is the format used by the DBX debugger on IBM RS/6000 systems.
3701 @item -gxcoff+
3702 @opindex gxcoff+
3703 Produce debugging information in XCOFF format (if that is supported),
3704 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3705 use of these extensions is likely to make other debuggers crash or
3706 refuse to read the program, and may cause assemblers other than the GNU
3707 assembler (GAS) to fail with an error.
3709 @item -gdwarf-2
3710 @opindex gdwarf-2
3711 Produce debugging information in DWARF version 2 format (if that is
3712 supported).  This is the format used by DBX on IRIX 6.  With this
3713 option, GCC uses features of DWARF version 3 when they are useful;
3714 version 3 is upward compatible with version 2, but may still cause
3715 problems for older debuggers.
3717 @item -gvms
3718 @opindex gvms
3719 Produce debugging information in VMS debug format (if that is
3720 supported).  This is the format used by DEBUG on VMS systems.
3722 @item -g@var{level}
3723 @itemx -ggdb@var{level}
3724 @itemx -gstabs@var{level}
3725 @itemx -gcoff@var{level}
3726 @itemx -gxcoff@var{level}
3727 @itemx -gvms@var{level}
3728 Request debugging information and also use @var{level} to specify how
3729 much information.  The default level is 2.
3731 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
3732 @option{-g}.
3734 Level 1 produces minimal information, enough for making backtraces in
3735 parts of the program that you don't plan to debug.  This includes
3736 descriptions of functions and external variables, but no information
3737 about local variables and no line numbers.
3739 Level 3 includes extra information, such as all the macro definitions
3740 present in the program.  Some debuggers support macro expansion when
3741 you use @option{-g3}.
3743 @option{-gdwarf-2} does not accept a concatenated debug level, because
3744 GCC used to support an option @option{-gdwarf} that meant to generate
3745 debug information in version 1 of the DWARF format (which is very
3746 different from version 2), and it would have been too confusing.  That
3747 debug format is long obsolete, but the option cannot be changed now.
3748 Instead use an additional @option{-g@var{level}} option to change the
3749 debug level for DWARF2.
3751 @item -feliminate-dwarf2-dups
3752 @opindex feliminate-dwarf2-dups
3753 Compress DWARF2 debugging information by eliminating duplicated
3754 information about each symbol.  This option only makes sense when
3755 generating DWARF2 debugging information with @option{-gdwarf-2}.
3757 @cindex @command{prof}
3758 @item -p
3759 @opindex p
3760 Generate extra code to write profile information suitable for the
3761 analysis program @command{prof}.  You must use this option when compiling
3762 the source files you want data about, and you must also use it when
3763 linking.
3765 @cindex @command{gprof}
3766 @item -pg
3767 @opindex pg
3768 Generate extra code to write profile information suitable for the
3769 analysis program @command{gprof}.  You must use this option when compiling
3770 the source files you want data about, and you must also use it when
3771 linking.
3773 @item -Q
3774 @opindex Q
3775 Makes the compiler print out each function name as it is compiled, and
3776 print some statistics about each pass when it finishes.
3778 @item -ftime-report
3779 @opindex ftime-report
3780 Makes the compiler print some statistics about the time consumed by each
3781 pass when it finishes.
3783 @item -fmem-report
3784 @opindex fmem-report
3785 Makes the compiler print some statistics about permanent memory
3786 allocation when it finishes.
3788 @item -fpre-ipa-mem-report
3789 @opindex fpre-ipa-mem-report
3790 @item -fpost-ipa-mem-report
3791 @opindex fpost-ipa-mem-report
3792 Makes the compiler print some statistics about permanent memory
3793 allocation before or after interprocedural optimization.
3795 @item -fprofile-arcs
3796 @opindex fprofile-arcs
3797 Add code so that program flow @dfn{arcs} are instrumented.  During
3798 execution the program records how many times each branch and call is
3799 executed and how many times it is taken or returns.  When the compiled
3800 program exits it saves this data to a file called
3801 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3802 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3803 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3804 @var{auxname} is generated from the name of the output file, if
3805 explicitly specified and it is not the final executable, otherwise it is
3806 the basename of the source file.  In both cases any suffix is removed
3807 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3808 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3809 @xref{Cross-profiling}.
3811 @cindex @command{gcov}
3812 @item --coverage
3813 @opindex coverage
3815 This option is used to compile and link code instrumented for coverage
3816 analysis.  The option is a synonym for @option{-fprofile-arcs}
3817 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3818 linking).  See the documentation for those options for more details.
3820 @itemize
3822 @item
3823 Compile the source files with @option{-fprofile-arcs} plus optimization
3824 and code generation options.  For test coverage analysis, use the
3825 additional @option{-ftest-coverage} option.  You do not need to profile
3826 every source file in a program.
3828 @item
3829 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3830 (the latter implies the former).
3832 @item
3833 Run the program on a representative workload to generate the arc profile
3834 information.  This may be repeated any number of times.  You can run
3835 concurrent instances of your program, and provided that the file system
3836 supports locking, the data files will be correctly updated.  Also
3837 @code{fork} calls are detected and correctly handled (double counting
3838 will not happen).
3840 @item
3841 For profile-directed optimizations, compile the source files again with
3842 the same optimization and code generation options plus
3843 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3844 Control Optimization}).
3846 @item
3847 For test coverage analysis, use @command{gcov} to produce human readable
3848 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3849 @command{gcov} documentation for further information.
3851 @end itemize
3853 With @option{-fprofile-arcs}, for each function of your program GCC
3854 creates a program flow graph, then finds a spanning tree for the graph.
3855 Only arcs that are not on the spanning tree have to be instrumented: the
3856 compiler adds code to count the number of times that these arcs are
3857 executed.  When an arc is the only exit or only entrance to a block, the
3858 instrumentation code can be added to the block; otherwise, a new basic
3859 block must be created to hold the instrumentation code.
3861 @need 2000
3862 @item -ftest-coverage
3863 @opindex ftest-coverage
3864 Produce a notes file that the @command{gcov} code-coverage utility
3865 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3866 show program coverage.  Each source file's note file is called
3867 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3868 above for a description of @var{auxname} and instructions on how to
3869 generate test coverage data.  Coverage data will match the source files
3870 more closely, if you do not optimize.
3872 @item -d@var{letters}
3873 @item -fdump-rtl-@var{pass}
3874 @opindex d
3875 Says to make debugging dumps during compilation at times specified by
3876 @var{letters}.    This is used for debugging the RTL-based passes of the
3877 compiler.  The file names for most of the dumps are made by appending a
3878 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3879 from the name of the output file, if explicitly specified and it is not
3880 an executable, otherwise it is the basename of the source file.
3882 Most debug dumps can be enabled either passing a letter to the @option{-d}
3883 option, or with a long @option{-fdump-rtl} switch; here are the possible
3884 letters for use in @var{letters} and @var{pass}, and their meanings:
3886 @table @gcctabopt
3887 @item -dA
3888 @opindex dA
3889 Annotate the assembler output with miscellaneous debugging information.
3891 @item -dB
3892 @itemx -fdump-rtl-bbro
3893 @opindex dB
3894 @opindex fdump-rtl-bbro
3895 Dump after block reordering, to @file{@var{file}.148r.bbro}.
3897 @item -dc
3898 @itemx -fdump-rtl-combine
3899 @opindex dc
3900 @opindex fdump-rtl-combine
3901 Dump after the RTL instruction combination pass, to the file
3902 @file{@var{file}.129r.combine}.
3904 @item -dC
3905 @itemx -fdump-rtl-ce1
3906 @itemx -fdump-rtl-ce2
3907 @opindex dC
3908 @opindex fdump-rtl-ce1
3909 @opindex fdump-rtl-ce2
3910 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3911 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
3912 and @option{-fdump-rtl-ce2} enable dumping after the second if
3913 conversion, to the file @file{@var{file}.130r.ce2}.
3915 @item -dd
3916 @itemx -fdump-rtl-btl
3917 @itemx -fdump-rtl-dbr
3918 @opindex dd
3919 @opindex fdump-rtl-btl
3920 @opindex fdump-rtl-dbr
3921 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3922 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3923 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3924 scheduling, to @file{@var{file}.36.dbr}.
3926 @item -dD
3927 @opindex dD
3928 Dump all macro definitions, at the end of preprocessing, in addition to
3929 normal output.
3931 @item -dE
3932 @itemx -fdump-rtl-ce3
3933 @opindex dE
3934 @opindex fdump-rtl-ce3
3935 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3937 @item -df
3938 @itemx -fdump-rtl-cfg
3939 @itemx -fdump-rtl-life
3940 @opindex df
3941 @opindex fdump-rtl-cfg
3942 @opindex fdump-rtl-life
3943 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3944 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
3945 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3946 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3948 @item -dg
3949 @itemx -fdump-rtl-greg
3950 @opindex dg
3951 @opindex fdump-rtl-greg
3952 Dump after global register allocation, to @file{@var{file}.139r.greg}.
3954 @item -dG
3955 @itemx -fdump-rtl-gcse
3956 @itemx -fdump-rtl-bypass
3957 @opindex dG
3958 @opindex fdump-rtl-gcse
3959 @opindex fdump-rtl-bypass
3960 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3961 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3962 enable dumping after jump bypassing and control flow optimizations, to
3963 @file{@var{file}.115r.bypass}.
3965 @item -dh
3966 @itemx -fdump-rtl-eh
3967 @opindex dh
3968 @opindex fdump-rtl-eh
3969 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3971 @item -di
3972 @itemx -fdump-rtl-sibling
3973 @opindex di
3974 @opindex fdump-rtl-sibling
3975 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3977 @item -dj
3978 @itemx -fdump-rtl-jump
3979 @opindex dj
3980 @opindex fdump-rtl-jump
3981 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3983 @item -dk
3984 @itemx -fdump-rtl-stack
3985 @opindex dk
3986 @opindex fdump-rtl-stack
3987 Dump after conversion from GCC's "flat register file" registers to the
3988 x87's stack-like registers, to @file{@var{file}.152r.stack}.
3990 @item -dl
3991 @itemx -fdump-rtl-lreg
3992 @opindex dl
3993 @opindex fdump-rtl-lreg
3994 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3996 @item -dL
3997 @itemx -fdump-rtl-loop2
3998 @opindex dL
3999 @opindex fdump-rtl-loop2
4000 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4001 loop optimization pass, to @file{@var{file}.119r.loop2},
4002 @file{@var{file}.120r.loop2_init},
4003 @file{@var{file}.121r.loop2_invariant}, and
4004 @file{@var{file}.125r.loop2_done}.
4006 @item -dm
4007 @itemx -fdump-rtl-sms
4008 @opindex dm
4009 @opindex fdump-rtl-sms
4010 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4012 @item -dM
4013 @itemx -fdump-rtl-mach
4014 @opindex dM
4015 @opindex fdump-rtl-mach
4016 Dump after performing the machine dependent reorganization pass, to
4017 @file{@var{file}.155r.mach}.
4019 @item -dn
4020 @itemx -fdump-rtl-rnreg
4021 @opindex dn
4022 @opindex fdump-rtl-rnreg
4023 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4025 @item -dN
4026 @itemx -fdump-rtl-regmove
4027 @opindex dN
4028 @opindex fdump-rtl-regmove
4029 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4031 @item -do
4032 @itemx -fdump-rtl-postreload
4033 @opindex do
4034 @opindex fdump-rtl-postreload
4035 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4037 @item -dr
4038 @itemx -fdump-rtl-expand
4039 @opindex dr
4040 @opindex fdump-rtl-expand
4041 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4043 @item -dR
4044 @itemx -fdump-rtl-sched2
4045 @opindex dR
4046 @opindex fdump-rtl-sched2
4047 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4049 @item -ds
4050 @itemx -fdump-rtl-cse
4051 @opindex ds
4052 @opindex fdump-rtl-cse
4053 Dump after CSE (including the jump optimization that sometimes follows
4054 CSE), to @file{@var{file}.113r.cse}.
4056 @item -dS
4057 @itemx -fdump-rtl-sched1
4058 @opindex dS
4059 @opindex fdump-rtl-sched1
4060 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4062 @item -dt
4063 @itemx -fdump-rtl-cse2
4064 @opindex dt
4065 @opindex fdump-rtl-cse2
4066 Dump after the second CSE pass (including the jump optimization that
4067 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4069 @item -dT
4070 @itemx -fdump-rtl-tracer
4071 @opindex dT
4072 @opindex fdump-rtl-tracer
4073 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4075 @item -dV
4076 @itemx -fdump-rtl-vpt
4077 @itemx -fdump-rtl-vartrack
4078 @opindex dV
4079 @opindex fdump-rtl-vpt
4080 @opindex fdump-rtl-vartrack
4081 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4082 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4083 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4084 to @file{@var{file}.154r.vartrack}.
4086 @item -dw
4087 @itemx -fdump-rtl-flow2
4088 @opindex dw
4089 @opindex fdump-rtl-flow2
4090 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4092 @item -dz
4093 @itemx -fdump-rtl-peephole2
4094 @opindex dz
4095 @opindex fdump-rtl-peephole2
4096 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4098 @item -dZ
4099 @itemx -fdump-rtl-web
4100 @opindex dZ
4101 @opindex fdump-rtl-web
4102 Dump after live range splitting, to @file{@var{file}.126r.web}.
4104 @item -da
4105 @itemx -fdump-rtl-all
4106 @opindex da
4107 @opindex fdump-rtl-all
4108 Produce all the dumps listed above.
4110 @item -dH
4111 @opindex dH
4112 Produce a core dump whenever an error occurs.
4114 @item -dm
4115 @opindex dm
4116 Print statistics on memory usage, at the end of the run, to
4117 standard error.
4119 @item -dp
4120 @opindex dp
4121 Annotate the assembler output with a comment indicating which
4122 pattern and alternative was used.  The length of each instruction is
4123 also printed.
4125 @item -dP
4126 @opindex dP
4127 Dump the RTL in the assembler output as a comment before each instruction.
4128 Also turns on @option{-dp} annotation.
4130 @item -dv
4131 @opindex dv
4132 For each of the other indicated dump files (either with @option{-d} or
4133 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4134 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4136 @item -dx
4137 @opindex dx
4138 Just generate RTL for a function instead of compiling it.  Usually used
4139 with @samp{r} (@option{-fdump-rtl-expand}).
4141 @item -dy
4142 @opindex dy
4143 Dump debugging information during parsing, to standard error.
4144 @end table
4146 @item -fdump-noaddr
4147 @opindex fdump-noaddr
4148 When doing debugging dumps (see @option{-d} option above), suppress
4149 address output.  This makes it more feasible to use diff on debugging
4150 dumps for compiler invocations with different compiler binaries and/or
4151 different text / bss / data / heap / stack / dso start locations.
4153 @item -fdump-unnumbered
4154 @opindex fdump-unnumbered
4155 When doing debugging dumps (see @option{-d} option above), suppress instruction
4156 numbers, line number note and address output.  This makes it more feasible to
4157 use diff on debugging dumps for compiler invocations with different
4158 options, in particular with and without @option{-g}.
4160 @item -fdump-translation-unit @r{(C++ only)}
4161 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4162 @opindex fdump-translation-unit
4163 Dump a representation of the tree structure for the entire translation
4164 unit to a file.  The file name is made by appending @file{.tu} to the
4165 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4166 controls the details of the dump as described for the
4167 @option{-fdump-tree} options.
4169 @item -fdump-class-hierarchy @r{(C++ only)}
4170 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4171 @opindex fdump-class-hierarchy
4172 Dump a representation of each class's hierarchy and virtual function
4173 table layout to a file.  The file name is made by appending @file{.class}
4174 to the source file name.  If the @samp{-@var{options}} form is used,
4175 @var{options} controls the details of the dump as described for the
4176 @option{-fdump-tree} options.
4178 @item -fdump-ipa-@var{switch}
4179 @opindex fdump-ipa
4180 Control the dumping at various stages of inter-procedural analysis
4181 language tree to a file.  The file name is generated by appending a switch
4182 specific suffix to the source file name.  The following dumps are possible:
4184 @table @samp
4185 @item all
4186 Enables all inter-procedural analysis dumps; currently the only produced
4187 dump is the @samp{cgraph} dump.
4189 @item cgraph
4190 Dumps information about call-graph optimization, unused function removal,
4191 and inlining decisions.
4192 @end table
4194 @item -fdump-tree-@var{switch}
4195 @itemx -fdump-tree-@var{switch}-@var{options}
4196 @opindex fdump-tree
4197 Control the dumping at various stages of processing the intermediate
4198 language tree to a file.  The file name is generated by appending a switch
4199 specific suffix to the source file name.  If the @samp{-@var{options}}
4200 form is used, @var{options} is a list of @samp{-} separated options that
4201 control the details of the dump.  Not all options are applicable to all
4202 dumps, those which are not meaningful will be ignored.  The following
4203 options are available
4205 @table @samp
4206 @item address
4207 Print the address of each node.  Usually this is not meaningful as it
4208 changes according to the environment and source file.  Its primary use
4209 is for tying up a dump file with a debug environment.
4210 @item slim
4211 Inhibit dumping of members of a scope or body of a function merely
4212 because that scope has been reached.  Only dump such items when they
4213 are directly reachable by some other path.  When dumping pretty-printed
4214 trees, this option inhibits dumping the bodies of control structures.
4215 @item raw
4216 Print a raw representation of the tree.  By default, trees are
4217 pretty-printed into a C-like representation.
4218 @item details
4219 Enable more detailed dumps (not honored by every dump option).
4220 @item stats
4221 Enable dumping various statistics about the pass (not honored by every dump
4222 option).
4223 @item blocks
4224 Enable showing basic block boundaries (disabled in raw dumps).
4225 @item vops
4226 Enable showing virtual operands for every statement.
4227 @item lineno
4228 Enable showing line numbers for statements.
4229 @item uid
4230 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4231 @item all
4232 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4233 @end table
4235 The following tree dumps are possible:
4236 @table @samp
4238 @item original
4239 Dump before any tree based optimization, to @file{@var{file}.original}.
4241 @item optimized
4242 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4244 @item inlined
4245 Dump after function inlining, to @file{@var{file}.inlined}.
4247 @item gimple
4248 @opindex fdump-tree-gimple
4249 Dump each function before and after the gimplification pass to a file.  The
4250 file name is made by appending @file{.gimple} to the source file name.
4252 @item cfg
4253 @opindex fdump-tree-cfg
4254 Dump the control flow graph of each function to a file.  The file name is
4255 made by appending @file{.cfg} to the source file name.
4257 @item vcg
4258 @opindex fdump-tree-vcg
4259 Dump the control flow graph of each function to a file in VCG format.  The
4260 file name is made by appending @file{.vcg} to the source file name.  Note
4261 that if the file contains more than one function, the generated file cannot
4262 be used directly by VCG@.  You will need to cut and paste each function's
4263 graph into its own separate file first.
4265 @item ch
4266 @opindex fdump-tree-ch
4267 Dump each function after copying loop headers.  The file name is made by
4268 appending @file{.ch} to the source file name.
4270 @item ssa
4271 @opindex fdump-tree-ssa
4272 Dump SSA related information to a file.  The file name is made by appending
4273 @file{.ssa} to the source file name.
4275 @item salias
4276 @opindex fdump-tree-salias
4277 Dump structure aliasing variable information to a file.  This file name
4278 is made by appending @file{.salias} to the source file name.
4280 @item alias
4281 @opindex fdump-tree-alias
4282 Dump aliasing information for each function.  The file name is made by
4283 appending @file{.alias} to the source file name.
4285 @item ccp
4286 @opindex fdump-tree-ccp
4287 Dump each function after CCP@.  The file name is made by appending
4288 @file{.ccp} to the source file name.
4290 @item storeccp
4291 @opindex fdump-tree-storeccp
4292 Dump each function after STORE-CCP.  The file name is made by appending
4293 @file{.storeccp} to the source file name.
4295 @item pre
4296 @opindex fdump-tree-pre
4297 Dump trees after partial redundancy elimination.  The file name is made
4298 by appending @file{.pre} to the source file name.
4300 @item fre
4301 @opindex fdump-tree-fre
4302 Dump trees after full redundancy elimination.  The file name is made
4303 by appending @file{.fre} to the source file name.
4305 @item copyprop
4306 @opindex fdump-tree-copyprop
4307 Dump trees after copy propagation.  The file name is made
4308 by appending @file{.copyprop} to the source file name.
4310 @item store_copyprop
4311 @opindex fdump-tree-store_copyprop
4312 Dump trees after store copy-propagation.  The file name is made
4313 by appending @file{.store_copyprop} to the source file name.
4315 @item dce
4316 @opindex fdump-tree-dce
4317 Dump each function after dead code elimination.  The file name is made by
4318 appending @file{.dce} to the source file name.
4320 @item mudflap
4321 @opindex fdump-tree-mudflap
4322 Dump each function after adding mudflap instrumentation.  The file name is
4323 made by appending @file{.mudflap} to the source file name.
4325 @item sra
4326 @opindex fdump-tree-sra
4327 Dump each function after performing scalar replacement of aggregates.  The
4328 file name is made by appending @file{.sra} to the source file name.
4330 @item sink
4331 @opindex fdump-tree-sink
4332 Dump each function after performing code sinking.  The file name is made
4333 by appending @file{.sink} to the source file name. 
4335 @item dom
4336 @opindex fdump-tree-dom
4337 Dump each function after applying dominator tree optimizations.  The file
4338 name is made by appending @file{.dom} to the source file name.
4340 @item dse
4341 @opindex fdump-tree-dse
4342 Dump each function after applying dead store elimination.  The file
4343 name is made by appending @file{.dse} to the source file name.
4345 @item phiopt
4346 @opindex fdump-tree-phiopt
4347 Dump each function after optimizing PHI nodes into straightline code.  The file
4348 name is made by appending @file{.phiopt} to the source file name.
4350 @item forwprop
4351 @opindex fdump-tree-forwprop
4352 Dump each function after forward propagating single use variables.  The file
4353 name is made by appending @file{.forwprop} to the source file name.
4355 @item copyrename
4356 @opindex fdump-tree-copyrename
4357 Dump each function after applying the copy rename optimization.  The file
4358 name is made by appending @file{.copyrename} to the source file name.
4360 @item nrv
4361 @opindex fdump-tree-nrv
4362 Dump each function after applying the named return value optimization on
4363 generic trees.  The file name is made by appending @file{.nrv} to the source
4364 file name.
4366 @item vect
4367 @opindex fdump-tree-vect
4368 Dump each function after applying vectorization of loops.  The file name is
4369 made by appending @file{.vect} to the source file name.
4371 @item vrp
4372 @opindex fdump-tree-vrp
4373 Dump each function after Value Range Propagation (VRP).  The file name
4374 is made by appending @file{.vrp} to the source file name.
4376 @item all
4377 @opindex fdump-tree-all
4378 Enable all the available tree dumps with the flags provided in this option.
4379 @end table
4381 @item -ftree-vectorizer-verbose=@var{n}
4382 @opindex ftree-vectorizer-verbose
4383 This option controls the amount of debugging output the vectorizer prints.
4384 This information is written to standard error, unless 
4385 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified, 
4386 in which case it is output to the usual dump listing file, @file{.vect}.
4387 For @var{n}=0 no diagnostic information is reported.
4388 If @var{n}=1 the vectorizer reports each loop that got vectorized, 
4389 and the total number of loops that got vectorized.
4390 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed 
4391 the first analysis phase (vect_analyze_loop_form) - i.e. countable, 
4392 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity 
4393 level that @option{-fdump-tree-vect-stats} uses.
4394 Higher verbosity levels mean either more information dumped for each 
4395 reported loop, or same amount of information reported for more loops:
4396 If @var{n}=3, alignment related information is added to the reports.
4397 If @var{n}=4, data-references related information (e.g. memory dependences, 
4398 memory access-patterns) is added to the reports.
4399 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops 
4400 that did not pass the first analysis phase (i.e. may not be countable, or 
4401 may have complicated control-flow).
4402 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4403 For @var{n}=7, all the information the vectorizer generates during its 
4404 analysis and transformation is reported.  This is the same verbosity level
4405 that @option{-fdump-tree-vect-details} uses.
4407 @item -frandom-seed=@var{string}
4408 @opindex frandom-string
4409 This option provides a seed that GCC uses when it would otherwise use
4410 random numbers.  It is used to generate certain symbol names
4411 that have to be different in every compiled file.  It is also used to
4412 place unique stamps in coverage data files and the object files that
4413 produce them.  You can use the @option{-frandom-seed} option to produce
4414 reproducibly identical object files.
4416 The @var{string} should be different for every file you compile.
4418 @item -fsched-verbose=@var{n}
4419 @opindex fsched-verbose
4420 On targets that use instruction scheduling, this option controls the
4421 amount of debugging output the scheduler prints.  This information is
4422 written to standard error, unless @option{-dS} or @option{-dR} is
4423 specified, in which case it is output to the usual dump
4424 listing file, @file{.sched} or @file{.sched2} respectively.  However
4425 for @var{n} greater than nine, the output is always printed to standard
4426 error.
4428 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4429 same information as @option{-dRS}.  For @var{n} greater than one, it
4430 also output basic block probabilities, detailed ready list information
4431 and unit/insn info.  For @var{n} greater than two, it includes RTL
4432 at abort point, control-flow and regions info.  And for @var{n} over
4433 four, @option{-fsched-verbose} also includes dependence info.
4435 @item -save-temps
4436 @opindex save-temps
4437 Store the usual ``temporary'' intermediate files permanently; place them
4438 in the current directory and name them based on the source file.  Thus,
4439 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4440 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4441 preprocessed @file{foo.i} output file even though the compiler now
4442 normally uses an integrated preprocessor.
4444 When used in combination with the @option{-x} command line option,
4445 @option{-save-temps} is sensible enough to avoid over writing an
4446 input source file with the same extension as an intermediate file.
4447 The corresponding intermediate file may be obtained by renaming the
4448 source file before using @option{-save-temps}.
4450 @item -time
4451 @opindex time
4452 Report the CPU time taken by each subprocess in the compilation
4453 sequence.  For C source files, this is the compiler proper and assembler
4454 (plus the linker if linking is done).  The output looks like this:
4456 @smallexample
4457 # cc1 0.12 0.01
4458 # as 0.00 0.01
4459 @end smallexample
4461 The first number on each line is the ``user time'', that is time spent
4462 executing the program itself.  The second number is ``system time'',
4463 time spent executing operating system routines on behalf of the program.
4464 Both numbers are in seconds.
4466 @item -fvar-tracking
4467 @opindex fvar-tracking
4468 Run variable tracking pass.  It computes where variables are stored at each
4469 position in code.  Better debugging information is then generated
4470 (if the debugging information format supports this information).
4472 It is enabled by default when compiling with optimization (@option{-Os},
4473 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4474 the debug info format supports it.
4476 @item -print-file-name=@var{library}
4477 @opindex print-file-name
4478 Print the full absolute name of the library file @var{library} that
4479 would be used when linking---and don't do anything else.  With this
4480 option, GCC does not compile or link anything; it just prints the
4481 file name.
4483 @item -print-multi-directory
4484 @opindex print-multi-directory
4485 Print the directory name corresponding to the multilib selected by any
4486 other switches present in the command line.  This directory is supposed
4487 to exist in @env{GCC_EXEC_PREFIX}.
4489 @item -print-multi-lib
4490 @opindex print-multi-lib
4491 Print the mapping from multilib directory names to compiler switches
4492 that enable them.  The directory name is separated from the switches by
4493 @samp{;}, and each switch starts with an @samp{@@} instead of the
4494 @samp{-}, without spaces between multiple switches.  This is supposed to
4495 ease shell-processing.
4497 @item -print-prog-name=@var{program}
4498 @opindex print-prog-name
4499 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4501 @item -print-libgcc-file-name
4502 @opindex print-libgcc-file-name
4503 Same as @option{-print-file-name=libgcc.a}.
4505 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4506 but you do want to link with @file{libgcc.a}.  You can do
4508 @smallexample
4509 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4510 @end smallexample
4512 @item -print-search-dirs
4513 @opindex print-search-dirs
4514 Print the name of the configured installation directory and a list of
4515 program and library directories @command{gcc} will search---and don't do anything else.
4517 This is useful when @command{gcc} prints the error message
4518 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4519 To resolve this you either need to put @file{cpp0} and the other compiler
4520 components where @command{gcc} expects to find them, or you can set the environment
4521 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4522 Don't forget the trailing @samp{/}.
4523 @xref{Environment Variables}.
4525 @item -dumpmachine
4526 @opindex dumpmachine
4527 Print the compiler's target machine (for example,
4528 @samp{i686-pc-linux-gnu})---and don't do anything else.
4530 @item -dumpversion
4531 @opindex dumpversion
4532 Print the compiler version (for example, @samp{3.0})---and don't do
4533 anything else.
4535 @item -dumpspecs
4536 @opindex dumpspecs
4537 Print the compiler's built-in specs---and don't do anything else.  (This
4538 is used when GCC itself is being built.)  @xref{Spec Files}.
4540 @item -feliminate-unused-debug-types
4541 @opindex feliminate-unused-debug-types
4542 Normally, when producing DWARF2 output, GCC will emit debugging
4543 information for all types declared in a compilation
4544 unit, regardless of whether or not they are actually used
4545 in that compilation unit.  Sometimes this is useful, such as
4546 if, in the debugger, you want to cast a value to a type that is
4547 not actually used in your program (but is declared).  More often,
4548 however, this results in a significant amount of wasted space.
4549 With this option, GCC will avoid producing debug symbol output
4550 for types that are nowhere used in the source file being compiled.
4551 @end table
4553 @node Optimize Options
4554 @section Options That Control Optimization
4555 @cindex optimize options
4556 @cindex options, optimization
4558 These options control various sorts of optimizations.
4560 Without any optimization option, the compiler's goal is to reduce the
4561 cost of compilation and to make debugging produce the expected
4562 results.  Statements are independent: if you stop the program with a
4563 breakpoint between statements, you can then assign a new value to any
4564 variable or change the program counter to any other statement in the
4565 function and get exactly the results you would expect from the source
4566 code.
4568 Turning on optimization flags makes the compiler attempt to improve
4569 the performance and/or code size at the expense of compilation time
4570 and possibly the ability to debug the program.
4572 The compiler performs optimization based on the knowledge it has of
4573 the program.  Optimization levels @option{-O} and above, in
4574 particular, enable @emph{unit-at-a-time} mode, which allows the
4575 compiler to consider information gained from later functions in
4576 the file when compiling a function.  Compiling multiple files at
4577 once to a single output file in @emph{unit-at-a-time} mode allows
4578 the compiler to use information gained from all of the files when
4579 compiling each of them.
4581 Not all optimizations are controlled directly by a flag.  Only
4582 optimizations that have a flag are listed.
4584 @table @gcctabopt
4585 @item -O
4586 @itemx -O1
4587 @opindex O
4588 @opindex O1
4589 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4590 more memory for a large function.
4592 With @option{-O}, the compiler tries to reduce code size and execution
4593 time, without performing any optimizations that take a great deal of
4594 compilation time.
4596 @option{-O} turns on the following optimization flags:
4597 @gccoptlist{-fdefer-pop @gol
4598 -fdelayed-branch @gol
4599 -fguess-branch-probability @gol
4600 -fcprop-registers @gol
4601 -fif-conversion @gol
4602 -fif-conversion2 @gol
4603 -fsplit-wide-types @gol
4604 -ftree-ccp @gol
4605 -ftree-dce @gol
4606 -ftree-dominator-opts @gol
4607 -ftree-dse @gol
4608 -ftree-ter @gol
4609 -ftree-lrs @gol
4610 -ftree-sra @gol
4611 -ftree-copyrename @gol
4612 -ftree-fre @gol
4613 -ftree-ch @gol
4614 -funit-at-a-time @gol
4615 -fmerge-constants}
4617 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4618 where doing so does not interfere with debugging.
4620 @item -O2
4621 @opindex O2
4622 Optimize even more.  GCC performs nearly all supported optimizations
4623 that do not involve a space-speed tradeoff.  The compiler does not
4624 perform loop unrolling or function inlining when you specify @option{-O2}.
4625 As compared to @option{-O}, this option increases both compilation time
4626 and the performance of the generated code.
4628 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4629 also turns on the following optimization flags:
4630 @gccoptlist{-fthread-jumps @gol
4631 -fcrossjumping @gol
4632 -foptimize-sibling-calls @gol
4633 -fcse-follow-jumps  -fcse-skip-blocks @gol
4634 -fgcse  -fgcse-lm  @gol
4635 -fexpensive-optimizations @gol
4636 -frerun-cse-after-loop  @gol
4637 -fcaller-saves @gol
4638 -fpeephole2 @gol
4639 -fschedule-insns  -fschedule-insns2 @gol
4640 -fsched-interblock  -fsched-spec @gol
4641 -fregmove @gol
4642 -fstrict-aliasing -fstrict-overflow @gol
4643 -fdelete-null-pointer-checks @gol
4644 -freorder-blocks  -freorder-functions @gol
4645 -falign-functions  -falign-jumps @gol
4646 -falign-loops  -falign-labels @gol
4647 -ftree-vrp @gol
4648 -ftree-pre}
4650 Please note the warning under @option{-fgcse} about
4651 invoking @option{-O2} on programs that use computed gotos.
4653 @item -O3
4654 @opindex O3
4655 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4656 @option{-O2} and also turns on the @option{-finline-functions},
4657 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4659 @item -O0
4660 @opindex O0
4661 Reduce compilation time and make debugging produce the expected
4662 results.  This is the default.
4664 @item -Os
4665 @opindex Os
4666 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4667 do not typically increase code size.  It also performs further
4668 optimizations designed to reduce code size.
4670 @option{-Os} disables the following optimization flags:
4671 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4672 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4673 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4675 If you use multiple @option{-O} options, with or without level numbers,
4676 the last such option is the one that is effective.
4677 @end table
4679 Options of the form @option{-f@var{flag}} specify machine-independent
4680 flags.  Most flags have both positive and negative forms; the negative
4681 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4682 below, only one of the forms is listed---the one you typically will
4683 use.  You can figure out the other form by either removing @samp{no-}
4684 or adding it.
4686 The following options control specific optimizations.  They are either
4687 activated by @option{-O} options or are related to ones that are.  You
4688 can use the following flags in the rare cases when ``fine-tuning'' of
4689 optimizations to be performed is desired.
4691 @table @gcctabopt
4692 @item -fno-default-inline
4693 @opindex fno-default-inline
4694 Do not make member functions inline by default merely because they are
4695 defined inside the class scope (C++ only).  Otherwise, when you specify
4696 @w{@option{-O}}, member functions defined inside class scope are compiled
4697 inline by default; i.e., you don't need to add @samp{inline} in front of
4698 the member function name.
4700 @item -fno-defer-pop
4701 @opindex fno-defer-pop
4702 Always pop the arguments to each function call as soon as that function
4703 returns.  For machines which must pop arguments after a function call,
4704 the compiler normally lets arguments accumulate on the stack for several
4705 function calls and pops them all at once.
4707 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4709 @item -fforce-addr
4710 @opindex fforce-addr
4711 Force memory address constants to be copied into registers before
4712 doing arithmetic on them.
4714 @item -fforward-propagate
4715 @opindex fforward-propagate
4716 Perform a forward propagation pass on RTL.  The pass tries to combine two
4717 instructions and checks if the result can be simplified.  If loop unrolling
4718 is active, two passes are performed and the second is scheduled after
4719 loop unrolling.
4721 This option is enabled by default at optimization levels @option{-O2},
4722 @option{-O3}, @option{-Os}.
4724 @item -fomit-frame-pointer
4725 @opindex fomit-frame-pointer
4726 Don't keep the frame pointer in a register for functions that
4727 don't need one.  This avoids the instructions to save, set up and
4728 restore frame pointers; it also makes an extra register available
4729 in many functions.  @strong{It also makes debugging impossible on
4730 some machines.}
4732 On some machines, such as the VAX, this flag has no effect, because
4733 the standard calling sequence automatically handles the frame pointer
4734 and nothing is saved by pretending it doesn't exist.  The
4735 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4736 whether a target machine supports this flag.  @xref{Registers,,Register
4737 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4739 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4741 @item -foptimize-sibling-calls
4742 @opindex foptimize-sibling-calls
4743 Optimize sibling and tail recursive calls.
4745 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4747 @item -fno-inline
4748 @opindex fno-inline
4749 Don't pay attention to the @code{inline} keyword.  Normally this option
4750 is used to keep the compiler from expanding any functions inline.
4751 Note that if you are not optimizing, no functions can be expanded inline.
4753 @item -finline-functions
4754 @opindex finline-functions
4755 Integrate all simple functions into their callers.  The compiler
4756 heuristically decides which functions are simple enough to be worth
4757 integrating in this way.
4759 If all calls to a given function are integrated, and the function is
4760 declared @code{static}, then the function is normally not output as
4761 assembler code in its own right.
4763 Enabled at level @option{-O3}.
4765 @item -finline-functions-called-once
4766 @opindex finline-functions-called-once
4767 Consider all @code{static} functions called once for inlining into their
4768 caller even if they are not marked @code{inline}.  If a call to a given
4769 function is integrated, then the function is not output as assembler code
4770 in its own right.
4772 Enabled if @option{-funit-at-a-time} is enabled.
4774 @item -fearly-inlining
4775 @opindex fearly-inlining
4776 Inline functions marked by @code{always_inline} and functions whose body seems
4777 smaller than the function call overhead early before doing
4778 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4779 makes profiling significantly cheaper and usually inlining faster on programs
4780 having large chains of nested wrapper functions.
4782 Enabled by default.
4784 @item -finline-limit=@var{n}
4785 @opindex finline-limit
4786 By default, GCC limits the size of functions that can be inlined.  This flag
4787 allows the control of this limit for functions that are explicitly marked as
4788 inline (i.e., marked with the inline keyword or defined within the class
4789 definition in c++).  @var{n} is the size of functions that can be inlined in
4790 number of pseudo instructions (not counting parameter handling).  The default
4791 value of @var{n} is 600.
4792 Increasing this value can result in more inlined code at
4793 the cost of compilation time and memory consumption.  Decreasing usually makes
4794 the compilation faster and less code will be inlined (which presumably
4795 means slower programs).  This option is particularly useful for programs that
4796 use inlining heavily such as those based on recursive templates with C++.
4798 Inlining is actually controlled by a number of parameters, which may be
4799 specified individually by using @option{--param @var{name}=@var{value}}.
4800 The @option{-finline-limit=@var{n}} option sets some of these parameters
4801 as follows:
4803 @table @gcctabopt
4804 @item max-inline-insns-single
4805  is set to @var{n}/2.
4806 @item max-inline-insns-auto
4807  is set to @var{n}/2.
4808 @item min-inline-insns
4809  is set to 130 or @var{n}/4, whichever is smaller.
4810 @item max-inline-insns-rtl
4811  is set to @var{n}.
4812 @end table
4814 See below for a documentation of the individual
4815 parameters controlling inlining.
4817 @emph{Note:} pseudo instruction represents, in this particular context, an
4818 abstract measurement of function's size.  In no way does it represent a count
4819 of assembly instructions and as such its exact meaning might change from one
4820 release to an another.
4822 @item -fkeep-inline-functions
4823 @opindex fkeep-inline-functions
4824 In C, emit @code{static} functions that are declared @code{inline}
4825 into the object file, even if the function has been inlined into all
4826 of its callers.  This switch does not affect functions using the
4827 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
4828 inline functions into the object file.
4830 @item -fkeep-static-consts
4831 @opindex fkeep-static-consts
4832 Emit variables declared @code{static const} when optimization isn't turned
4833 on, even if the variables aren't referenced.
4835 GCC enables this option by default.  If you want to force the compiler to
4836 check if the variable was referenced, regardless of whether or not
4837 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4839 @item -fmerge-constants
4840 Attempt to merge identical constants (string constants and floating point
4841 constants) across compilation units.
4843 This option is the default for optimized compilation if the assembler and
4844 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4845 behavior.
4847 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4849 @item -fmerge-all-constants
4850 Attempt to merge identical constants and identical variables.
4852 This option implies @option{-fmerge-constants}.  In addition to
4853 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4854 arrays or initialized constant variables with integral or floating point
4855 types.  Languages like C or C++ require each non-automatic variable to
4856 have distinct location, so using this option will result in non-conforming
4857 behavior.
4859 @item -fmodulo-sched
4860 @opindex fmodulo-sched
4861 Perform swing modulo scheduling immediately before the first scheduling
4862 pass.  This pass looks at innermost loops and reorders their
4863 instructions by overlapping different iterations.
4865 @item -fno-branch-count-reg
4866 @opindex fno-branch-count-reg
4867 Do not use ``decrement and branch'' instructions on a count register,
4868 but instead generate a sequence of instructions that decrement a
4869 register, compare it against zero, then branch based upon the result.
4870 This option is only meaningful on architectures that support such
4871 instructions, which include x86, PowerPC, IA-64 and S/390.
4873 The default is @option{-fbranch-count-reg}.
4875 @item -fno-function-cse
4876 @opindex fno-function-cse
4877 Do not put function addresses in registers; make each instruction that
4878 calls a constant function contain the function's address explicitly.
4880 This option results in less efficient code, but some strange hacks
4881 that alter the assembler output may be confused by the optimizations
4882 performed when this option is not used.
4884 The default is @option{-ffunction-cse}
4886 @item -fno-zero-initialized-in-bss
4887 @opindex fno-zero-initialized-in-bss
4888 If the target supports a BSS section, GCC by default puts variables that
4889 are initialized to zero into BSS@.  This can save space in the resulting
4890 code.
4892 This option turns off this behavior because some programs explicitly
4893 rely on variables going to the data section.  E.g., so that the
4894 resulting executable can find the beginning of that section and/or make
4895 assumptions based on that.
4897 The default is @option{-fzero-initialized-in-bss}.
4899 @item -fbounds-check
4900 @opindex fbounds-check
4901 For front-ends that support it, generate additional code to check that
4902 indices used to access arrays are within the declared range.  This is
4903 currently only supported by the Java and Fortran front-ends, where
4904 this option defaults to true and false respectively.
4906 @item -fmudflap -fmudflapth -fmudflapir
4907 @opindex fmudflap
4908 @opindex fmudflapth
4909 @opindex fmudflapir
4910 @cindex bounds checking
4911 @cindex mudflap
4912 For front-ends that support it (C and C++), instrument all risky
4913 pointer/array dereferencing operations, some standard library
4914 string/heap functions, and some other associated constructs with
4915 range/validity tests.  Modules so instrumented should be immune to
4916 buffer overflows, invalid heap use, and some other classes of C/C++
4917 programming errors.  The instrumentation relies on a separate runtime
4918 library (@file{libmudflap}), which will be linked into a program if
4919 @option{-fmudflap} is given at link time.  Run-time behavior of the
4920 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4921 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4922 for its options.
4924 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4925 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4926 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4927 instrumentation should ignore pointer reads.  This produces less
4928 instrumentation (and therefore faster execution) and still provides
4929 some protection against outright memory corrupting writes, but allows
4930 erroneously read data to propagate within a program.
4932 @item -fthread-jumps
4933 @opindex fthread-jumps
4934 Perform optimizations where we check to see if a jump branches to a
4935 location where another comparison subsumed by the first is found.  If
4936 so, the first branch is redirected to either the destination of the
4937 second branch or a point immediately following it, depending on whether
4938 the condition is known to be true or false.
4940 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4942 @item -fsplit-wide-types
4943 @opindex -fsplit-wide-types
4944 When using a type that occupies multiple registers, such as @code{long
4945 long} on a 32-bit system, split the registers apart and allocate them
4946 independently.  This normally generates better code for those types,
4947 but may make debugging more difficult.
4949 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
4950 @option{-Os}.
4952 @item -fcse-follow-jumps
4953 @opindex fcse-follow-jumps
4954 In common subexpression elimination, scan through jump instructions
4955 when the target of the jump is not reached by any other path.  For
4956 example, when CSE encounters an @code{if} statement with an
4957 @code{else} clause, CSE will follow the jump when the condition
4958 tested is false.
4960 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4962 @item -fcse-skip-blocks
4963 @opindex fcse-skip-blocks
4964 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4965 follow jumps which conditionally skip over blocks.  When CSE
4966 encounters a simple @code{if} statement with no else clause,
4967 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4968 body of the @code{if}.
4970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4972 @item -frerun-cse-after-loop
4973 @opindex frerun-cse-after-loop
4974 Re-run common subexpression elimination after loop optimizations has been
4975 performed.
4977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4979 @item -fgcse
4980 @opindex fgcse
4981 Perform a global common subexpression elimination pass.
4982 This pass also performs global constant and copy propagation.
4984 @emph{Note:} When compiling a program using computed gotos, a GCC
4985 extension, you may get better runtime performance if you disable
4986 the global common subexpression elimination pass by adding
4987 @option{-fno-gcse} to the command line.
4989 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4991 @item -fgcse-lm
4992 @opindex fgcse-lm
4993 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4994 attempt to move loads which are only killed by stores into themselves.  This
4995 allows a loop containing a load/store sequence to be changed to a load outside
4996 the loop, and a copy/store within the loop.
4998 Enabled by default when gcse is enabled.
5000 @item -fgcse-sm
5001 @opindex fgcse-sm
5002 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5003 global common subexpression elimination.  This pass will attempt to move
5004 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5005 loops containing a load/store sequence can be changed to a load before
5006 the loop and a store after the loop.
5008 Not enabled at any optimization level.
5010 @item -fgcse-las
5011 @opindex fgcse-las
5012 When @option{-fgcse-las} is enabled, the global common subexpression
5013 elimination pass eliminates redundant loads that come after stores to the
5014 same memory location (both partial and full redundancies).
5016 Not enabled at any optimization level.
5018 @item -fgcse-after-reload
5019 @opindex fgcse-after-reload
5020 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5021 pass is performed after reload.  The purpose of this pass is to cleanup
5022 redundant spilling.
5024 @item -funsafe-loop-optimizations
5025 @opindex funsafe-loop-optimizations
5026 If given, the loop optimizer will assume that loop indices do not
5027 overflow, and that the loops with nontrivial exit condition are not
5028 infinite.  This enables a wider range of loop optimizations even if
5029 the loop optimizer itself cannot prove that these assumptions are valid.
5030 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5031 if it finds this kind of loop.
5033 @item -fcrossjumping
5034 @opindex crossjumping
5035 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5036 resulting code may or may not perform better than without cross-jumping.
5038 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5040 @item -fif-conversion
5041 @opindex if-conversion
5042 Attempt to transform conditional jumps into branch-less equivalents.  This
5043 include use of conditional moves, min, max, set flags and abs instructions, and
5044 some tricks doable by standard arithmetics.  The use of conditional execution
5045 on chips where it is available is controlled by @code{if-conversion2}.
5047 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5049 @item -fif-conversion2
5050 @opindex if-conversion2
5051 Use conditional execution (where available) to transform conditional jumps into
5052 branch-less equivalents.
5054 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5056 @item -fdelete-null-pointer-checks
5057 @opindex fdelete-null-pointer-checks
5058 Use global dataflow analysis to identify and eliminate useless checks
5059 for null pointers.  The compiler assumes that dereferencing a null
5060 pointer would have halted the program.  If a pointer is checked after
5061 it has already been dereferenced, it cannot be null.
5063 In some environments, this assumption is not true, and programs can
5064 safely dereference null pointers.  Use
5065 @option{-fno-delete-null-pointer-checks} to disable this optimization
5066 for programs which depend on that behavior.
5068 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5070 @item -fexpensive-optimizations
5071 @opindex fexpensive-optimizations
5072 Perform a number of minor optimizations that are relatively expensive.
5074 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5076 @item -foptimize-register-move
5077 @itemx -fregmove
5078 @opindex foptimize-register-move
5079 @opindex fregmove
5080 Attempt to reassign register numbers in move instructions and as
5081 operands of other simple instructions in order to maximize the amount of
5082 register tying.  This is especially helpful on machines with two-operand
5083 instructions.
5085 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5086 optimization.
5088 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5090 @item -fdelayed-branch
5091 @opindex fdelayed-branch
5092 If supported for the target machine, attempt to reorder instructions
5093 to exploit instruction slots available after delayed branch
5094 instructions.
5096 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5098 @item -fschedule-insns
5099 @opindex fschedule-insns
5100 If supported for the target machine, attempt to reorder instructions to
5101 eliminate execution stalls due to required data being unavailable.  This
5102 helps machines that have slow floating point or memory load instructions
5103 by allowing other instructions to be issued until the result of the load
5104 or floating point instruction is required.
5106 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5108 @item -fschedule-insns2
5109 @opindex fschedule-insns2
5110 Similar to @option{-fschedule-insns}, but requests an additional pass of
5111 instruction scheduling after register allocation has been done.  This is
5112 especially useful on machines with a relatively small number of
5113 registers and where memory load instructions take more than one cycle.
5115 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5117 @item -fno-sched-interblock
5118 @opindex fno-sched-interblock
5119 Don't schedule instructions across basic blocks.  This is normally
5120 enabled by default when scheduling before register allocation, i.e.@:
5121 with @option{-fschedule-insns} or at @option{-O2} or higher.
5123 @item -fno-sched-spec
5124 @opindex fno-sched-spec
5125 Don't allow speculative motion of non-load instructions.  This is normally
5126 enabled by default when scheduling before register allocation, i.e.@:
5127 with @option{-fschedule-insns} or at @option{-O2} or higher.
5129 @item -fsched-spec-load
5130 @opindex fsched-spec-load
5131 Allow speculative motion of some load instructions.  This only makes
5132 sense when scheduling before register allocation, i.e.@: with
5133 @option{-fschedule-insns} or at @option{-O2} or higher.
5135 @item -fsched-spec-load-dangerous
5136 @opindex fsched-spec-load-dangerous
5137 Allow speculative motion of more load instructions.  This only makes
5138 sense when scheduling before register allocation, i.e.@: with
5139 @option{-fschedule-insns} or at @option{-O2} or higher.
5141 @item -fsched-stalled-insns=@var{n}
5142 @opindex fsched-stalled-insns
5143 Define how many insns (if any) can be moved prematurely from the queue
5144 of stalled insns into the ready list, during the second scheduling pass.
5146 @item -fsched-stalled-insns-dep=@var{n}
5147 @opindex fsched-stalled-insns-dep
5148 Define how many insn groups (cycles) will be examined for a dependency
5149 on a stalled insn that is candidate for premature removal from the queue
5150 of stalled insns.  Has an effect only during the second scheduling pass,
5151 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5153 @item -fsched2-use-superblocks
5154 @opindex fsched2-use-superblocks
5155 When scheduling after register allocation, do use superblock scheduling
5156 algorithm.  Superblock scheduling allows motion across basic block boundaries
5157 resulting on faster schedules.  This option is experimental, as not all machine
5158 descriptions used by GCC model the CPU closely enough to avoid unreliable
5159 results from the algorithm.
5161 This only makes sense when scheduling after register allocation, i.e.@: with
5162 @option{-fschedule-insns2} or at @option{-O2} or higher.
5164 @item -fsched2-use-traces
5165 @opindex fsched2-use-traces
5166 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5167 allocation and additionally perform code duplication in order to increase the
5168 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5169 trace formation.
5171 This mode should produce faster but significantly longer programs.  Also
5172 without @option{-fbranch-probabilities} the traces constructed may not
5173 match the reality and hurt the performance.  This only makes
5174 sense when scheduling after register allocation, i.e.@: with
5175 @option{-fschedule-insns2} or at @option{-O2} or higher.
5177 @item -fsee
5178 @opindex fsee
5179 Eliminates redundant extension instructions and move the non redundant
5180 ones to optimal placement using LCM.
5182 @item -freschedule-modulo-scheduled-loops
5183 @opindex fscheduling-in-modulo-scheduled-loops
5184 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5185 we may want to prevent the later scheduling passes from changing its schedule, we use this
5186 option to control that.
5188 @item -fcaller-saves
5189 @opindex fcaller-saves
5190 Enable values to be allocated in registers that will be clobbered by
5191 function calls, by emitting extra instructions to save and restore the
5192 registers around such calls.  Such allocation is done only when it
5193 seems to result in better code than would otherwise be produced.
5195 This option is always enabled by default on certain machines, usually
5196 those which have no call-preserved registers to use instead.
5198 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5200 @item -ftree-pre
5201 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5202 enabled by default at @option{-O2} and @option{-O3}.
5204 @item -ftree-fre
5205 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5206 between FRE and PRE is that FRE only considers expressions
5207 that are computed on all paths leading to the redundant computation.
5208 This analysis faster than PRE, though it exposes fewer redundancies.
5209 This flag is enabled by default at @option{-O} and higher.
5211 @item -ftree-copy-prop
5212 Perform copy propagation on trees.  This pass eliminates unnecessary
5213 copy operations.  This flag is enabled by default at @option{-O} and
5214 higher.
5216 @item -ftree-store-copy-prop
5217 Perform copy propagation of memory loads and stores.  This pass
5218 eliminates unnecessary copy operations in memory references
5219 (structures, global variables, arrays, etc).  This flag is enabled by
5220 default at @option{-O2} and higher.
5222 @item -ftree-salias
5223 Perform structural alias analysis on trees.  This flag
5224 is enabled by default at @option{-O} and higher.
5226 @item -fipa-pta
5227 Perform interprocedural pointer analysis.
5229 @item -ftree-sink
5230 Perform forward store motion  on trees.  This flag is
5231 enabled by default at @option{-O} and higher.
5233 @item -ftree-ccp
5234 Perform sparse conditional constant propagation (CCP) on trees.  This
5235 pass only operates on local scalar variables and is enabled by default
5236 at @option{-O} and higher.
5238 @item -ftree-store-ccp
5239 Perform sparse conditional constant propagation (CCP) on trees.  This
5240 pass operates on both local scalar variables and memory stores and
5241 loads (global variables, structures, arrays, etc).  This flag is
5242 enabled by default at @option{-O2} and higher.
5244 @item -ftree-dce
5245 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5246 default at @option{-O} and higher.
5248 @item -ftree-dominator-opts
5249 Perform a variety of simple scalar cleanups (constant/copy
5250 propagation, redundancy elimination, range propagation and expression
5251 simplification) based on a dominator tree traversal.  This also
5252 performs jump threading (to reduce jumps to jumps). This flag is
5253 enabled by default at @option{-O} and higher.
5255 @item -ftree-ch
5256 Perform loop header copying on trees.  This is beneficial since it increases
5257 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5258 is enabled by default at @option{-O} and higher.  It is not enabled
5259 for @option{-Os}, since it usually increases code size.
5261 @item -ftree-loop-optimize
5262 Perform loop optimizations on trees.  This flag is enabled by default
5263 at @option{-O} and higher.
5265 @item -ftree-loop-linear
5266 Perform linear loop transformations on tree.  This flag can improve cache
5267 performance and allow further loop optimizations to take place.
5269 @item -ftree-loop-im
5270 Perform loop invariant motion on trees.  This pass moves only invariants that
5271 would be hard to handle at RTL level (function calls, operations that expand to
5272 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5273 operands of conditions that are invariant out of the loop, so that we can use
5274 just trivial invariantness analysis in loop unswitching.  The pass also includes
5275 store motion.
5277 @item -ftree-loop-ivcanon
5278 Create a canonical counter for number of iterations in the loop for that
5279 determining number of iterations requires complicated analysis.  Later
5280 optimizations then may determine the number easily.  Useful especially
5281 in connection with unrolling.
5283 @item -fivopts
5284 Perform induction variable optimizations (strength reduction, induction
5285 variable merging and induction variable elimination) on trees.
5287 @item -ftree-sra
5288 Perform scalar replacement of aggregates.  This pass replaces structure
5289 references with scalars to prevent committing structures to memory too
5290 early.  This flag is enabled by default at @option{-O} and higher.
5292 @item -ftree-copyrename
5293 Perform copy renaming on trees.  This pass attempts to rename compiler
5294 temporaries to other variables at copy locations, usually resulting in
5295 variable names which more closely resemble the original variables.  This flag
5296 is enabled by default at @option{-O} and higher.
5298 @item -ftree-ter
5299 Perform temporary expression replacement during the SSA->normal phase.  Single
5300 use/single def temporaries are replaced at their use location with their
5301 defining expression.  This results in non-GIMPLE code, but gives the expanders
5302 much more complex trees to work on resulting in better RTL generation.  This is
5303 enabled by default at @option{-O} and higher.
5305 @item -ftree-lrs
5306 Perform live range splitting during the SSA->normal phase.  Distinct live
5307 ranges of a variable are split into unique variables, allowing for better
5308 optimization later.  This is enabled by default at @option{-O} and higher.
5310 @item -ftree-vectorize
5311 Perform loop vectorization on trees.
5313 @item -ftree-vect-loop-version
5314 @opindex ftree-vect-loop-version
5315 Perform loop versioning when doing loop vectorization on trees.  When a loop
5316 appears to be vectorizable except that data alignment or data dependence cannot
5317 be determined at compile time then vectorized and non-vectorized versions of
5318 the loop are generated along with runtime checks for alignment or dependence
5319 to control which version is executed.  This option is enabled by default
5320 except at level @option{-Os} where it is disabled.
5322 @item -ftree-vrp
5323 Perform Value Range Propagation on trees.  This is similar to the
5324 constant propagation pass, but instead of values, ranges of values are
5325 propagated.  This allows the optimizers to remove unnecessary range
5326 checks like array bound checks and null pointer checks.  This is
5327 enabled by default at @option{-O2} and higher.  Null pointer check
5328 elimination is only done if @option{-fdelete-null-pointer-checks} is
5329 enabled.
5331 @item -ftracer
5332 @opindex ftracer
5333 Perform tail duplication to enlarge superblock size.  This transformation
5334 simplifies the control flow of the function allowing other optimizations to do
5335 better job.
5337 @item -funroll-loops
5338 @opindex funroll-loops
5339 Unroll loops whose number of iterations can be determined at compile
5340 time or upon entry to the loop.  @option{-funroll-loops} implies
5341 @option{-frerun-cse-after-loop}.  This option makes code larger,
5342 and may or may not make it run faster.
5344 @item -funroll-all-loops
5345 @opindex funroll-all-loops
5346 Unroll all loops, even if their number of iterations is uncertain when
5347 the loop is entered.  This usually makes programs run more slowly.
5348 @option{-funroll-all-loops} implies the same options as
5349 @option{-funroll-loops},
5351 @item -fsplit-ivs-in-unroller
5352 @opindex -fsplit-ivs-in-unroller
5353 Enables expressing of values of induction variables in later iterations
5354 of the unrolled loop using the value in the first iteration.  This breaks
5355 long dependency chains, thus improving efficiency of the scheduling passes.
5357 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5358 same effect.  However in cases the loop body is more complicated than
5359 a single basic block, this is not reliable.  It also does not work at all
5360 on some of the architectures due to restrictions in the CSE pass.
5362 This optimization is enabled by default.
5364 @item -fvariable-expansion-in-unroller
5365 @opindex -fvariable-expansion-in-unroller
5366 With this option, the compiler will create multiple copies of some
5367 local variables when unrolling a loop which can result in superior code.
5369 @item -fprefetch-loop-arrays
5370 @opindex fprefetch-loop-arrays
5371 If supported by the target machine, generate instructions to prefetch
5372 memory to improve the performance of loops that access large arrays.
5374 This option may generate better or worse code; results are highly
5375 dependent on the structure of loops within the source code.
5377 Disabled at level @option{-Os}.
5379 @item -fno-peephole
5380 @itemx -fno-peephole2
5381 @opindex fno-peephole
5382 @opindex fno-peephole2
5383 Disable any machine-specific peephole optimizations.  The difference
5384 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5385 are implemented in the compiler; some targets use one, some use the
5386 other, a few use both.
5388 @option{-fpeephole} is enabled by default.
5389 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5391 @item -fno-guess-branch-probability
5392 @opindex fno-guess-branch-probability
5393 Do not guess branch probabilities using heuristics.
5395 GCC will use heuristics to guess branch probabilities if they are
5396 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5397 heuristics are based on the control flow graph.  If some branch probabilities
5398 are specified by @samp{__builtin_expect}, then the heuristics will be
5399 used to guess branch probabilities for the rest of the control flow graph,
5400 taking the @samp{__builtin_expect} info into account.  The interactions
5401 between the heuristics and @samp{__builtin_expect} can be complex, and in
5402 some cases, it may be useful to disable the heuristics so that the effects
5403 of @samp{__builtin_expect} are easier to understand.
5405 The default is @option{-fguess-branch-probability} at levels
5406 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5408 @item -freorder-blocks
5409 @opindex freorder-blocks
5410 Reorder basic blocks in the compiled function in order to reduce number of
5411 taken branches and improve code locality.
5413 Enabled at levels @option{-O2}, @option{-O3}.
5415 @item -freorder-blocks-and-partition
5416 @opindex freorder-blocks-and-partition
5417 In addition to reordering basic blocks in the compiled function, in order
5418 to reduce number of taken branches, partitions hot and cold basic blocks
5419 into separate sections of the assembly and .o files, to improve
5420 paging and cache locality performance.
5422 This optimization is automatically turned off in the presence of
5423 exception handling, for linkonce sections, for functions with a user-defined
5424 section attribute and on any architecture that does not support named
5425 sections.
5427 @item -freorder-functions
5428 @opindex freorder-functions
5429 Reorder functions in the object file in order to
5430 improve code locality.  This is implemented by using special
5431 subsections @code{.text.hot} for most frequently executed functions and
5432 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5433 the linker so object file format must support named sections and linker must
5434 place them in a reasonable way.
5436 Also profile feedback must be available in to make this option effective.  See
5437 @option{-fprofile-arcs} for details.
5439 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5441 @item -fstrict-aliasing
5442 @opindex fstrict-aliasing
5443 Allows the compiler to assume the strictest aliasing rules applicable to
5444 the language being compiled.  For C (and C++), this activates
5445 optimizations based on the type of expressions.  In particular, an
5446 object of one type is assumed never to reside at the same address as an
5447 object of a different type, unless the types are almost the same.  For
5448 example, an @code{unsigned int} can alias an @code{int}, but not a
5449 @code{void*} or a @code{double}.  A character type may alias any other
5450 type.
5452 Pay special attention to code like this:
5453 @smallexample
5454 union a_union @{
5455   int i;
5456   double d;
5459 int f() @{
5460   a_union t;
5461   t.d = 3.0;
5462   return t.i;
5464 @end smallexample
5465 The practice of reading from a different union member than the one most
5466 recently written to (called ``type-punning'') is common.  Even with
5467 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5468 is accessed through the union type.  So, the code above will work as
5469 expected.  However, this code might not:
5470 @smallexample
5471 int f() @{
5472   a_union t;
5473   int* ip;
5474   t.d = 3.0;
5475   ip = &t.i;
5476   return *ip;
5478 @end smallexample
5480 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5482 @item -fstrict-overflow
5483 @opindex fstrict-overflow
5484 Allow the compiler to assume strict signed overflow rules, depending
5485 on the language being compiled.  For C (and C++) this means that
5486 overflow when doing arithmetic with signed numbers is undefined, which
5487 means that the compiler may assume that it will not happen.  This
5488 permits various optimizations.  For example, the compiler will assume
5489 that an expression like @code{i + 10 > i} will always be true for
5490 signed @code{i}.  This assumption is only valid if signed overflow is
5491 undefined, as the expression is false if @code{i + 10} overflows when
5492 using twos complement arithmetic.  When this option is in effect any
5493 attempt to determine whether an operation on signed numbers will
5494 overflow must be written carefully to not actually involve overflow.
5496 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
5497 that signed overflow is fully defined: it wraps.  When
5498 @option{-fwrapv} is used, there is no difference between
5499 @option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
5500 @option{-fwrapv} certain types of overflow are permitted.  For
5501 example, if the compiler gets an overflow when doing arithmetic on
5502 constants, the overflowed value can still be used with
5503 @option{-fwrapv}, but not otherwise.
5505 The @option{-fstrict-overflow} option is enabled at levels
5506 @option{-O2}, @option{-O3}, @option{-Os}.
5508 @item -falign-functions
5509 @itemx -falign-functions=@var{n}
5510 @opindex falign-functions
5511 Align the start of functions to the next power-of-two greater than
5512 @var{n}, skipping up to @var{n} bytes.  For instance,
5513 @option{-falign-functions=32} aligns functions to the next 32-byte
5514 boundary, but @option{-falign-functions=24} would align to the next
5515 32-byte boundary only if this can be done by skipping 23 bytes or less.
5517 @option{-fno-align-functions} and @option{-falign-functions=1} are
5518 equivalent and mean that functions will not be aligned.
5520 Some assemblers only support this flag when @var{n} is a power of two;
5521 in that case, it is rounded up.
5523 If @var{n} is not specified or is zero, use a machine-dependent default.
5525 Enabled at levels @option{-O2}, @option{-O3}.
5527 @item -falign-labels
5528 @itemx -falign-labels=@var{n}
5529 @opindex falign-labels
5530 Align all branch targets to a power-of-two boundary, skipping up to
5531 @var{n} bytes like @option{-falign-functions}.  This option can easily
5532 make code slower, because it must insert dummy operations for when the
5533 branch target is reached in the usual flow of the code.
5535 @option{-fno-align-labels} and @option{-falign-labels=1} are
5536 equivalent and mean that labels will not be aligned.
5538 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5539 are greater than this value, then their values are used instead.
5541 If @var{n} is not specified or is zero, use a machine-dependent default
5542 which is very likely to be @samp{1}, meaning no alignment.
5544 Enabled at levels @option{-O2}, @option{-O3}.
5546 @item -falign-loops
5547 @itemx -falign-loops=@var{n}
5548 @opindex falign-loops
5549 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5550 like @option{-falign-functions}.  The hope is that the loop will be
5551 executed many times, which will make up for any execution of the dummy
5552 operations.
5554 @option{-fno-align-loops} and @option{-falign-loops=1} are
5555 equivalent and mean that loops will not be aligned.
5557 If @var{n} is not specified or is zero, use a machine-dependent default.
5559 Enabled at levels @option{-O2}, @option{-O3}.
5561 @item -falign-jumps
5562 @itemx -falign-jumps=@var{n}
5563 @opindex falign-jumps
5564 Align branch targets to a power-of-two boundary, for branch targets
5565 where the targets can only be reached by jumping, skipping up to @var{n}
5566 bytes like @option{-falign-functions}.  In this case, no dummy operations
5567 need be executed.
5569 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5570 equivalent and mean that loops will not be aligned.
5572 If @var{n} is not specified or is zero, use a machine-dependent default.
5574 Enabled at levels @option{-O2}, @option{-O3}.
5576 @item -funit-at-a-time
5577 @opindex funit-at-a-time
5578 Parse the whole compilation unit before starting to produce code.
5579 This allows some extra optimizations to take place but consumes
5580 more memory (in general).  There are some compatibility issues
5581 with @emph{unit-at-a-time} mode:
5582 @itemize @bullet
5583 @item
5584 enabling @emph{unit-at-a-time} mode may change the order
5585 in which functions, variables, and top-level @code{asm} statements
5586 are emitted, and will likely break code relying on some particular
5587 ordering.  The majority of such top-level @code{asm} statements,
5588 though, can be replaced by @code{section} attributes.  The
5589 @option{fno-toplevel-reorder} option may be used to keep the ordering
5590 used in the input file, at the cost of some optimizations.
5592 @item
5593 @emph{unit-at-a-time} mode removes unreferenced static variables
5594 and functions.  This may result in undefined references
5595 when an @code{asm} statement refers directly to variables or functions
5596 that are otherwise unused.  In that case either the variable/function
5597 shall be listed as an operand of the @code{asm} statement operand or,
5598 in the case of top-level @code{asm} statements the attribute @code{used}
5599 shall be used on the declaration.
5601 @item
5602 Static functions now can use non-standard passing conventions that
5603 may break @code{asm} statements calling functions directly.  Again,
5604 attribute @code{used} will prevent this behavior.
5605 @end itemize
5607 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5608 but this scheme may not be supported by future releases of GCC@.
5610 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5612 @item -fno-toplevel-reorder
5613 Do not reorder top-level functions, variables, and @code{asm}
5614 statements.  Output them in the same order that they appear in the
5615 input file.  When this option is used, unreferenced static variables
5616 will not be removed.  This option is intended to support existing code
5617 which relies on a particular ordering.  For new code, it is better to
5618 use attributes.
5620 @item -fweb
5621 @opindex fweb
5622 Constructs webs as commonly used for register allocation purposes and assign
5623 each web individual pseudo register.  This allows the register allocation pass
5624 to operate on pseudos directly, but also strengthens several other optimization
5625 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5626 however, make debugging impossible, since variables will no longer stay in a
5627 ``home register''.
5629 Enabled by default with @option{-funroll-loops}.
5631 @item -fwhole-program
5632 @opindex fwhole-program
5633 Assume that the current compilation unit represents whole program being
5634 compiled.  All public functions and variables with the exception of @code{main}
5635 and those merged by attribute @code{externally_visible} become static functions
5636 and in a affect gets more aggressively optimized by interprocedural optimizers.
5637 While this option is equivalent to proper use of @code{static} keyword for
5638 programs consisting of single file, in combination with option
5639 @option{--combine} this flag can be used to compile most of smaller scale C
5640 programs since the functions and variables become local for the whole combined
5641 compilation unit, not for the single source file itself.
5644 @item -fno-cprop-registers
5645 @opindex fno-cprop-registers
5646 After register allocation and post-register allocation instruction splitting,
5647 we perform a copy-propagation pass to try to reduce scheduling dependencies
5648 and occasionally eliminate the copy.
5650 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5652 @item -fprofile-generate
5653 @opindex fprofile-generate
5655 Enable options usually used for instrumenting application to produce
5656 profile useful for later recompilation with profile feedback based
5657 optimization.  You must use @option{-fprofile-generate} both when
5658 compiling and when linking your program.
5660 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5662 @item -fprofile-use
5663 @opindex fprofile-use
5664 Enable profile feedback directed optimizations, and optimizations
5665 generally profitable only with profile feedback available.
5667 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5668 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5670 By default, GCC emits an error message if the feedback profiles do not
5671 match the source code.  This error can be turned into a warning by using
5672 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
5673 code.
5674 @end table
5676 The following options control compiler behavior regarding floating
5677 point arithmetic.  These options trade off between speed and
5678 correctness.  All must be specifically enabled.
5680 @table @gcctabopt
5681 @item -ffloat-store
5682 @opindex ffloat-store
5683 Do not store floating point variables in registers, and inhibit other
5684 options that might change whether a floating point value is taken from a
5685 register or memory.
5687 @cindex floating point precision
5688 This option prevents undesirable excess precision on machines such as
5689 the 68000 where the floating registers (of the 68881) keep more
5690 precision than a @code{double} is supposed to have.  Similarly for the
5691 x86 architecture.  For most programs, the excess precision does only
5692 good, but a few programs rely on the precise definition of IEEE floating
5693 point.  Use @option{-ffloat-store} for such programs, after modifying
5694 them to store all pertinent intermediate computations into variables.
5696 @item -ffast-math
5697 @opindex ffast-math
5698 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5699 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5700 @option{-fno-rounding-math}, @option{-fno-signaling-nans},
5701 @option{-fno-signed-zeros} and @option{fcx-limited-range}.
5703 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5705 This option should never be turned on by any @option{-O} option since
5706 it can result in incorrect output for programs which depend on
5707 an exact implementation of IEEE or ISO rules/specifications for
5708 math functions.
5710 @item -fno-math-errno
5711 @opindex fno-math-errno
5712 Do not set ERRNO after calling math functions that are executed
5713 with a single instruction, e.g., sqrt.  A program that relies on
5714 IEEE exceptions for math error handling may want to use this flag
5715 for speed while maintaining IEEE arithmetic compatibility.
5717 This option should never be turned on by any @option{-O} option since
5718 it can result in incorrect output for programs which depend on
5719 an exact implementation of IEEE or ISO rules/specifications for
5720 math functions.
5722 The default is @option{-fmath-errno}.
5724 On Darwin systems, the math library never sets @code{errno}.  There is
5725 therefore no reason for the compiler to consider the possibility that
5726 it might, and @option{-fno-math-errno} is the default.
5728 @item -funsafe-math-optimizations
5729 @opindex funsafe-math-optimizations
5730 Allow optimizations for floating-point arithmetic that (a) assume
5731 that arguments and results are valid and (b) may violate IEEE or
5732 ANSI standards.  When used at link-time, it may include libraries
5733 or startup files that change the default FPU control word or other
5734 similar optimizations.
5736 This option should never be turned on by any @option{-O} option since
5737 it can result in incorrect output for programs which depend on
5738 an exact implementation of IEEE or ISO rules/specifications for
5739 math functions.
5741 The default is @option{-fno-unsafe-math-optimizations}.
5743 @item -ffinite-math-only
5744 @opindex ffinite-math-only
5745 Allow optimizations for floating-point arithmetic that assume
5746 that arguments and results are not NaNs or +-Infs.
5748 This option should never be turned on by any @option{-O} option since
5749 it can result in incorrect output for programs which depend on
5750 an exact implementation of IEEE or ISO rules/specifications.
5752 The default is @option{-fno-finite-math-only}.
5754 @item -fno-signed-zeros
5755 @opindex fno-signed-zeros
5756 Allow optimizations for floating point arithmetic that ignore the
5757 signedness of zero.  IEEE arithmetic specifies the behavior of
5758 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
5759 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
5760 This option implies that the sign of a zero result isn't significant.
5762 The default is @option{-fsigned-zeros}.
5764 @item -fno-trapping-math
5765 @opindex fno-trapping-math
5766 Compile code assuming that floating-point operations cannot generate
5767 user-visible traps.  These traps include division by zero, overflow,
5768 underflow, inexact result and invalid operation.  This option implies
5769 @option{-fno-signaling-nans}.  Setting this option may allow faster
5770 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5772 This option should never be turned on by any @option{-O} option since
5773 it can result in incorrect output for programs which depend on
5774 an exact implementation of IEEE or ISO rules/specifications for
5775 math functions.
5777 The default is @option{-ftrapping-math}.
5779 @item -frounding-math
5780 @opindex frounding-math
5781 Disable transformations and optimizations that assume default floating
5782 point rounding behavior.  This is round-to-zero for all floating point
5783 to integer conversions, and round-to-nearest for all other arithmetic
5784 truncations.  This option should be specified for programs that change
5785 the FP rounding mode dynamically, or that may be executed with a
5786 non-default rounding mode.  This option disables constant folding of
5787 floating point expressions at compile-time (which may be affected by
5788 rounding mode) and arithmetic transformations that are unsafe in the
5789 presence of sign-dependent rounding modes.
5791 The default is @option{-fno-rounding-math}.
5793 This option is experimental and does not currently guarantee to
5794 disable all GCC optimizations that are affected by rounding mode.
5795 Future versions of GCC may provide finer control of this setting
5796 using C99's @code{FENV_ACCESS} pragma.  This command line option
5797 will be used to specify the default state for @code{FENV_ACCESS}.
5799 @item -frtl-abstract-sequences
5800 @opindex frtl-abstract-sequences
5801 It is a size optimization method. This option is to find identical
5802 sequences of code, which can be turned into pseudo-procedures  and
5803 then  replace  all  occurrences with  calls to  the  newly created
5804 subroutine. It is kind of an opposite of @option{-finline-functions}.
5805 This optimization runs at RTL level.
5807 @item -fsignaling-nans
5808 @opindex fsignaling-nans
5809 Compile code assuming that IEEE signaling NaNs may generate user-visible
5810 traps during floating-point operations.  Setting this option disables
5811 optimizations that may change the number of exceptions visible with
5812 signaling NaNs.  This option implies @option{-ftrapping-math}.
5814 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5815 be defined.
5817 The default is @option{-fno-signaling-nans}.
5819 This option is experimental and does not currently guarantee to
5820 disable all GCC optimizations that affect signaling NaN behavior.
5822 @item -fsingle-precision-constant
5823 @opindex fsingle-precision-constant
5824 Treat floating point constant as single precision constant instead of
5825 implicitly converting it to double precision constant.
5827 @item -fcx-limited-range
5828 @itemx -fno-cx-limited-range
5829 @opindex fcx-limited-range
5830 @opindex fno-cx-limited-range
5831 When enabled, this option states that a range reduction step is not
5832 needed when performing complex division.  The default is
5833 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5835 This option controls the default setting of the ISO C99 
5836 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5837 all languages.
5839 @end table
5841 The following options control optimizations that may improve
5842 performance, but are not enabled by any @option{-O} options.  This
5843 section includes experimental options that may produce broken code.
5845 @table @gcctabopt
5846 @item -fbranch-probabilities
5847 @opindex fbranch-probabilities
5848 After running a program compiled with @option{-fprofile-arcs}
5849 (@pxref{Debugging Options,, Options for Debugging Your Program or
5850 @command{gcc}}), you can compile it a second time using
5851 @option{-fbranch-probabilities}, to improve optimizations based on
5852 the number of times each branch was taken.  When the program
5853 compiled with @option{-fprofile-arcs} exits it saves arc execution
5854 counts to a file called @file{@var{sourcename}.gcda} for each source
5855 file.  The information in this data file is very dependent on the
5856 structure of the generated code, so you must use the same source code
5857 and the same optimization options for both compilations.
5859 With @option{-fbranch-probabilities}, GCC puts a
5860 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5861 These can be used to improve optimization.  Currently, they are only
5862 used in one place: in @file{reorg.c}, instead of guessing which path a
5863 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5864 exactly determine which path is taken more often.
5866 @item -fprofile-values
5867 @opindex fprofile-values
5868 If combined with @option{-fprofile-arcs}, it adds code so that some
5869 data about values of expressions in the program is gathered.
5871 With @option{-fbranch-probabilities}, it reads back the data gathered
5872 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5873 notes to instructions for their later usage in optimizations.
5875 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5877 @item -fvpt
5878 @opindex fvpt
5879 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5880 a code to gather information about values of expressions.
5882 With @option{-fbranch-probabilities}, it reads back the data gathered
5883 and actually performs the optimizations based on them.
5884 Currently the optimizations include specialization of division operation
5885 using the knowledge about the value of the denominator.
5887 @item -frename-registers
5888 @opindex frename-registers
5889 Attempt to avoid false dependencies in scheduled code by making use
5890 of registers left over after register allocation.  This optimization
5891 will most benefit processors with lots of registers.  Depending on the
5892 debug information format adopted by the target, however, it can
5893 make debugging impossible, since variables will no longer stay in
5894 a ``home register''.
5896 Enabled by default with @option{-funroll-loops}.
5898 @item -ftracer
5899 @opindex ftracer
5900 Perform tail duplication to enlarge superblock size.  This transformation
5901 simplifies the control flow of the function allowing other optimizations to do
5902 better job.
5904 Enabled with @option{-fprofile-use}.
5906 @item -funroll-loops
5907 @opindex funroll-loops
5908 Unroll loops whose number of iterations can be determined at compile time or
5909 upon entry to the loop.  @option{-funroll-loops} implies
5910 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5911 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5912 small constant number of iterations).  This option makes code larger, and may
5913 or may not make it run faster.
5915 Enabled with @option{-fprofile-use}.
5917 @item -funroll-all-loops
5918 @opindex funroll-all-loops
5919 Unroll all loops, even if their number of iterations is uncertain when
5920 the loop is entered.  This usually makes programs run more slowly.
5921 @option{-funroll-all-loops} implies the same options as
5922 @option{-funroll-loops}.
5924 @item -fpeel-loops
5925 @opindex fpeel-loops
5926 Peels the loops for that there is enough information that they do not
5927 roll much (from profile feedback).  It also turns on complete loop peeling
5928 (i.e.@: complete removal of loops with small constant number of iterations).
5930 Enabled with @option{-fprofile-use}.
5932 @item -fmove-loop-invariants
5933 @opindex fmove-loop-invariants
5934 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5935 at level @option{-O1}
5937 @item -funswitch-loops
5938 @opindex funswitch-loops
5939 Move branches with loop invariant conditions out of the loop, with duplicates
5940 of the loop on both branches (modified according to result of the condition).
5942 @item -ffunction-sections
5943 @itemx -fdata-sections
5944 @opindex ffunction-sections
5945 @opindex fdata-sections
5946 Place each function or data item into its own section in the output
5947 file if the target supports arbitrary sections.  The name of the
5948 function or the name of the data item determines the section's name
5949 in the output file.
5951 Use these options on systems where the linker can perform optimizations
5952 to improve locality of reference in the instruction space.  Most systems
5953 using the ELF object format and SPARC processors running Solaris 2 have
5954 linkers with such optimizations.  AIX may have these optimizations in
5955 the future.
5957 Only use these options when there are significant benefits from doing
5958 so.  When you specify these options, the assembler and linker will
5959 create larger object and executable files and will also be slower.
5960 You will not be able to use @code{gprof} on all systems if you
5961 specify this option and you may have problems with debugging if
5962 you specify both this option and @option{-g}.
5964 @item -fbranch-target-load-optimize
5965 @opindex fbranch-target-load-optimize
5966 Perform branch target register load optimization before prologue / epilogue
5967 threading.
5968 The use of target registers can typically be exposed only during reload,
5969 thus hoisting loads out of loops and doing inter-block scheduling needs
5970 a separate optimization pass.
5972 @item -fbranch-target-load-optimize2
5973 @opindex fbranch-target-load-optimize2
5974 Perform branch target register load optimization after prologue / epilogue
5975 threading.
5977 @item -fbtr-bb-exclusive
5978 @opindex fbtr-bb-exclusive
5979 When performing branch target register load optimization, don't reuse
5980 branch target registers in within any basic block.
5982 @item -fstack-protector
5983 Emit extra code to check for buffer overflows, such as stack smashing
5984 attacks.  This is done by adding a guard variable to functions with
5985 vulnerable objects.  This includes functions that call alloca, and
5986 functions with buffers larger than 8 bytes.  The guards are initialized
5987 when a function is entered and then checked when the function exits.
5988 If a guard check fails, an error message is printed and the program exits.
5990 @item -fstack-protector-all
5991 Like @option{-fstack-protector} except that all functions are protected.
5993 @item -fsection-anchors
5994 @opindex fsection-anchors
5995 Try to reduce the number of symbolic address calculations by using
5996 shared ``anchor'' symbols to address nearby objects.  This transformation
5997 can help to reduce the number of GOT entries and GOT accesses on some
5998 targets.
6000 For example, the implementation of the following function @code{foo}:
6002 @smallexample
6003 static int a, b, c;
6004 int foo (void) @{ return a + b + c; @}
6005 @end smallexample
6007 would usually calculate the addresses of all three variables, but if you
6008 compile it with @option{-fsection-anchors}, it will access the variables
6009 from a common anchor point instead.  The effect is similar to the
6010 following pseudocode (which isn't valid C):
6012 @smallexample
6013 int foo (void)
6015   register int *xr = &x;
6016   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6018 @end smallexample
6020 Not all targets support this option.
6022 @item --param @var{name}=@var{value}
6023 @opindex param
6024 In some places, GCC uses various constants to control the amount of
6025 optimization that is done.  For example, GCC will not inline functions
6026 that contain more that a certain number of instructions.  You can
6027 control some of these constants on the command-line using the
6028 @option{--param} option.
6030 The names of specific parameters, and the meaning of the values, are
6031 tied to the internals of the compiler, and are subject to change
6032 without notice in future releases.
6034 In each case, the @var{value} is an integer.  The allowable choices for
6035 @var{name} are given in the following table:
6037 @table @gcctabopt
6038 @item salias-max-implicit-fields
6039 The maximum number of fields in a variable without direct
6040 structure accesses for which structure aliasing will consider trying 
6041 to track each field.  The default is 5
6043 @item salias-max-array-elements
6044 The maximum number of elements an array can have and its elements
6045 still be tracked individually by structure aliasing. The default is 4
6047 @item sra-max-structure-size
6048 The maximum structure size, in bytes, at which the scalar replacement
6049 of aggregates (SRA) optimization will perform block copies.  The
6050 default value, 0, implies that GCC will select the most appropriate
6051 size itself.
6053 @item sra-field-structure-ratio
6054 The threshold ratio (as a percentage) between instantiated fields and
6055 the complete structure size.  We say that if the ratio of the number
6056 of bytes in instantiated fields to the number of bytes in the complete
6057 structure exceeds this parameter, then block copies are not used.  The
6058 default is 75.
6060 @item max-crossjump-edges
6061 The maximum number of incoming edges to consider for crossjumping.
6062 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6063 the number of edges incoming to each block.  Increasing values mean
6064 more aggressive optimization, making the compile time increase with
6065 probably small improvement in executable size.
6067 @item min-crossjump-insns
6068 The minimum number of instructions which must be matched at the end
6069 of two blocks before crossjumping will be performed on them.  This
6070 value is ignored in the case where all instructions in the block being
6071 crossjumped from are matched.  The default value is 5.
6073 @item max-grow-copy-bb-insns
6074 The maximum code size expansion factor when copying basic blocks
6075 instead of jumping.  The expansion is relative to a jump instruction.
6076 The default value is 8.
6078 @item max-goto-duplication-insns
6079 The maximum number of instructions to duplicate to a block that jumps
6080 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6081 passes, GCC factors computed gotos early in the compilation process,
6082 and unfactors them as late as possible.  Only computed jumps at the
6083 end of a basic blocks with no more than max-goto-duplication-insns are
6084 unfactored.  The default value is 8.
6086 @item max-delay-slot-insn-search
6087 The maximum number of instructions to consider when looking for an
6088 instruction to fill a delay slot.  If more than this arbitrary number of
6089 instructions is searched, the time savings from filling the delay slot
6090 will be minimal so stop searching.  Increasing values mean more
6091 aggressive optimization, making the compile time increase with probably
6092 small improvement in executable run time.
6094 @item max-delay-slot-live-search
6095 When trying to fill delay slots, the maximum number of instructions to
6096 consider when searching for a block with valid live register
6097 information.  Increasing this arbitrarily chosen value means more
6098 aggressive optimization, increasing the compile time.  This parameter
6099 should be removed when the delay slot code is rewritten to maintain the
6100 control-flow graph.
6102 @item max-gcse-memory
6103 The approximate maximum amount of memory that will be allocated in
6104 order to perform the global common subexpression elimination
6105 optimization.  If more memory than specified is required, the
6106 optimization will not be done.
6108 @item max-gcse-passes
6109 The maximum number of passes of GCSE to run.  The default is 1.
6111 @item max-pending-list-length
6112 The maximum number of pending dependencies scheduling will allow
6113 before flushing the current state and starting over.  Large functions
6114 with few branches or calls can create excessively large lists which
6115 needlessly consume memory and resources.
6117 @item max-inline-insns-single
6118 Several parameters control the tree inliner used in gcc.
6119 This number sets the maximum number of instructions (counted in GCC's
6120 internal representation) in a single function that the tree inliner
6121 will consider for inlining.  This only affects functions declared
6122 inline and methods implemented in a class declaration (C++).
6123 The default value is 450.
6125 @item max-inline-insns-auto
6126 When you use @option{-finline-functions} (included in @option{-O3}),
6127 a lot of functions that would otherwise not be considered for inlining
6128 by the compiler will be investigated.  To those functions, a different
6129 (more restrictive) limit compared to functions declared inline can
6130 be applied.
6131 The default value is 90.
6133 @item large-function-insns
6134 The limit specifying really large functions.  For functions larger than this
6135 limit after inlining inlining is constrained by
6136 @option{--param large-function-growth}.  This parameter is useful primarily
6137 to avoid extreme compilation time caused by non-linear algorithms used by the
6138 backend.
6139 This parameter is ignored when @option{-funit-at-a-time} is not used.
6140 The default value is 2700.
6142 @item large-function-growth
6143 Specifies maximal growth of large function caused by inlining in percents.
6144 This parameter is ignored when @option{-funit-at-a-time} is not used.
6145 The default value is 100 which limits large function growth to 2.0 times
6146 the original size.
6148 @item large-unit-insns
6149 The limit specifying large translation unit.  Growth caused by inlining of
6150 units larger than this limit is limited by @option{--param inline-unit-growth}.
6151 For small units this might be too tight (consider unit consisting of function A
6152 that is inline and B that just calls A three time.  If B is small relative to
6153 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6154 large units consisting of small inlininable functions however the overall unit
6155 growth limit is needed to avoid exponential explosion of code size.  Thus for
6156 smaller units, the size is increased to @option{--param large-unit-insns}
6157 before applying @option{--param inline-unit-growth}.  The default is 10000
6159 @item inline-unit-growth
6160 Specifies maximal overall growth of the compilation unit caused by inlining.
6161 This parameter is ignored when @option{-funit-at-a-time} is not used.
6162 The default value is 60 which limits unit growth to 1.6 times the original
6163 size.
6165 @item large-stack-frame
6166 The limit specifying large stack frames.  While inlining the algorithm is trying
6167 to not grow past this limit too much.  Default value is 256 bytes.
6169 @item large-stack-frame-growth
6170 Specifies maximal growth of large stack frames caused by inlining in percents.
6171 The default value is 1000 which limits large stack frame growth to 11 times
6172 the original size.
6174 @item max-inline-insns-recursive
6175 @itemx max-inline-insns-recursive-auto
6176 Specifies maximum number of instructions out-of-line copy of self recursive inline
6177 function can grow into by performing recursive inlining.
6179 For functions declared inline @option{--param max-inline-insns-recursive} is
6180 taken into account.  For function not declared inline, recursive inlining
6181 happens only when @option{-finline-functions} (included in @option{-O3}) is
6182 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6183 default value is 450.
6185 @item max-inline-recursive-depth
6186 @itemx max-inline-recursive-depth-auto
6187 Specifies maximum recursion depth used by the recursive inlining.
6189 For functions declared inline @option{--param max-inline-recursive-depth} is
6190 taken into account.  For function not declared inline, recursive inlining
6191 happens only when @option{-finline-functions} (included in @option{-O3}) is
6192 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6193 default value is 450.
6195 @item min-inline-recursive-probability
6196 Recursive inlining is profitable only for function having deep recursion
6197 in average and can hurt for function having little recursion depth by
6198 increasing the prologue size or complexity of function body to other
6199 optimizers.
6201 When profile feedback is available (see @option{-fprofile-generate}) the actual
6202 recursion depth can be guessed from probability that function will recurse via
6203 given call expression.  This parameter limits inlining only to call expression
6204 whose probability exceeds given threshold (in percents).  The default value is
6207 @item inline-call-cost
6208 Specify cost of call instruction relative to simple arithmetics operations
6209 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6210 functions and at the same time increases size of leaf function that is believed to
6211 reduce function size by being inlined.  In effect it increases amount of
6212 inlining for code having large abstraction penalty (many functions that just
6213 pass the arguments to other functions) and decrease inlining for code with low
6214 abstraction penalty.  The default value is 16.
6216 @item min-vect-loop-bound
6217 The minimum number of iterations under which a loop will not get vectorized 
6218 when @option{-ftree-vectorize} is used.  The number of iterations after 
6219 vectorization needs to be greater than the value specified by this option
6220 to allow vectorization.  The default value is 0.
6222 @item max-unrolled-insns
6223 The maximum number of instructions that a loop should have if that loop
6224 is unrolled, and if the loop is unrolled, it determines how many times
6225 the loop code is unrolled.
6227 @item max-average-unrolled-insns
6228 The maximum number of instructions biased by probabilities of their execution
6229 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6230 it determines how many times the loop code is unrolled.
6232 @item max-unroll-times
6233 The maximum number of unrollings of a single loop.
6235 @item max-peeled-insns
6236 The maximum number of instructions that a loop should have if that loop
6237 is peeled, and if the loop is peeled, it determines how many times
6238 the loop code is peeled.
6240 @item max-peel-times
6241 The maximum number of peelings of a single loop.
6243 @item max-completely-peeled-insns
6244 The maximum number of insns of a completely peeled loop.
6246 @item max-completely-peel-times
6247 The maximum number of iterations of a loop to be suitable for complete peeling.
6249 @item max-unswitch-insns
6250 The maximum number of insns of an unswitched loop.
6252 @item max-unswitch-level
6253 The maximum number of branches unswitched in a single loop.
6255 @item lim-expensive
6256 The minimum cost of an expensive expression in the loop invariant motion.
6258 @item iv-consider-all-candidates-bound
6259 Bound on number of candidates for induction variables below that
6260 all candidates are considered for each use in induction variable
6261 optimizations.  Only the most relevant candidates are considered
6262 if there are more candidates, to avoid quadratic time complexity.
6264 @item iv-max-considered-uses
6265 The induction variable optimizations give up on loops that contain more
6266 induction variable uses.
6268 @item iv-always-prune-cand-set-bound
6269 If number of candidates in the set is smaller than this value,
6270 we always try to remove unnecessary ivs from the set during its
6271 optimization when a new iv is added to the set.
6273 @item scev-max-expr-size
6274 Bound on size of expressions used in the scalar evolutions analyzer.
6275 Large expressions slow the analyzer.
6277 @item vect-max-version-checks
6278 The maximum number of runtime checks that can be performed when doing
6279 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6280 for more information.
6282 @item max-iterations-to-track
6284 The maximum number of iterations of a loop the brute force algorithm
6285 for analysis of # of iterations of the loop tries to evaluate.
6287 @item hot-bb-count-fraction
6288 Select fraction of the maximal count of repetitions of basic block in program
6289 given basic block needs to have to be considered hot.
6291 @item hot-bb-frequency-fraction
6292 Select fraction of the maximal frequency of executions of basic block in
6293 function given basic block needs to have to be considered hot
6295 @item max-predicted-iterations
6296 The maximum number of loop iterations we predict statically.  This is useful
6297 in cases where function contain single loop with known bound and other loop
6298 with unknown.  We predict the known number of iterations correctly, while
6299 the unknown number of iterations average to roughly 10.  This means that the
6300 loop without bounds would appear artificially cold relative to the other one.
6302 @item tracer-dynamic-coverage
6303 @itemx tracer-dynamic-coverage-feedback
6305 This value is used to limit superblock formation once the given percentage of
6306 executed instructions is covered.  This limits unnecessary code size
6307 expansion.
6309 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6310 feedback is available.  The real profiles (as opposed to statically estimated
6311 ones) are much less balanced allowing the threshold to be larger value.
6313 @item tracer-max-code-growth
6314 Stop tail duplication once code growth has reached given percentage.  This is
6315 rather hokey argument, as most of the duplicates will be eliminated later in
6316 cross jumping, so it may be set to much higher values than is the desired code
6317 growth.
6319 @item tracer-min-branch-ratio
6321 Stop reverse growth when the reverse probability of best edge is less than this
6322 threshold (in percent).
6324 @item tracer-min-branch-ratio
6325 @itemx tracer-min-branch-ratio-feedback
6327 Stop forward growth if the best edge do have probability lower than this
6328 threshold.
6330 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6331 compilation for profile feedback and one for compilation without.  The value
6332 for compilation with profile feedback needs to be more conservative (higher) in
6333 order to make tracer effective.
6335 @item max-cse-path-length
6337 Maximum number of basic blocks on path that cse considers.  The default is 10.
6339 @item max-cse-insns
6340 The maximum instructions CSE process before flushing. The default is 1000.
6342 @item max-aliased-vops
6344 Maximum number of virtual operands per statement allowed to represent
6345 aliases before triggering the alias grouping heuristic.  Alias
6346 grouping reduces compile times and memory consumption needed for
6347 aliasing at the expense of precision loss in alias information.
6349 @item ggc-min-expand
6351 GCC uses a garbage collector to manage its own memory allocation.  This
6352 parameter specifies the minimum percentage by which the garbage
6353 collector's heap should be allowed to expand between collections.
6354 Tuning this may improve compilation speed; it has no effect on code
6355 generation.
6357 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6358 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6359 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6360 GCC is not able to calculate RAM on a particular platform, the lower
6361 bound of 30% is used.  Setting this parameter and
6362 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6363 every opportunity.  This is extremely slow, but can be useful for
6364 debugging.
6366 @item ggc-min-heapsize
6368 Minimum size of the garbage collector's heap before it begins bothering
6369 to collect garbage.  The first collection occurs after the heap expands
6370 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6371 tuning this may improve compilation speed, and has no effect on code
6372 generation.
6374 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6375 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6376 with a lower bound of 4096 (four megabytes) and an upper bound of
6377 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6378 particular platform, the lower bound is used.  Setting this parameter
6379 very large effectively disables garbage collection.  Setting this
6380 parameter and @option{ggc-min-expand} to zero causes a full collection
6381 to occur at every opportunity.
6383 @item max-reload-search-insns
6384 The maximum number of instruction reload should look backward for equivalent
6385 register.  Increasing values mean more aggressive optimization, making the
6386 compile time increase with probably slightly better performance.  The default
6387 value is 100.
6389 @item max-cselib-memory-locations
6390 The maximum number of memory locations cselib should take into account.
6391 Increasing values mean more aggressive optimization, making the compile time
6392 increase with probably slightly better performance.  The default value is 500.
6394 @item max-flow-memory-locations
6395 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6396 The default value is 100.
6398 @item reorder-blocks-duplicate
6399 @itemx reorder-blocks-duplicate-feedback
6401 Used by basic block reordering pass to decide whether to use unconditional
6402 branch or duplicate the code on its destination.  Code is duplicated when its
6403 estimated size is smaller than this value multiplied by the estimated size of
6404 unconditional jump in the hot spots of the program.
6406 The @option{reorder-block-duplicate-feedback} is used only when profile
6407 feedback is available and may be set to higher values than
6408 @option{reorder-block-duplicate} since information about the hot spots is more
6409 accurate.
6411 @item max-sched-ready-insns
6412 The maximum number of instructions ready to be issued the scheduler should
6413 consider at any given time during the first scheduling pass.  Increasing
6414 values mean more thorough searches, making the compilation time increase
6415 with probably little benefit.  The default value is 100.
6417 @item max-sched-region-blocks
6418 The maximum number of blocks in a region to be considered for
6419 interblock scheduling.  The default value is 10.
6421 @item max-sched-region-insns
6422 The maximum number of insns in a region to be considered for
6423 interblock scheduling.  The default value is 100.
6425 @item min-spec-prob
6426 The minimum probability (in percents) of reaching a source block
6427 for interblock speculative scheduling.  The default value is 40.
6429 @item max-sched-extend-regions-iters
6430 The maximum number of iterations through CFG to extend regions.
6431 0 - disable region extension,
6432 N - do at most N iterations.
6433 The default value is 0.
6435 @item max-sched-insn-conflict-delay
6436 The maximum conflict delay for an insn to be considered for speculative motion.
6437 The default value is 3.
6439 @item sched-spec-prob-cutoff
6440 The minimal probability of speculation success (in percents), so that
6441 speculative insn will be scheduled.
6442 The default value is 40.
6444 @item max-last-value-rtl
6446 The maximum size measured as number of RTLs that can be recorded in an expression
6447 in combiner for a pseudo register as last known value of that register.  The default
6448 is 10000.
6450 @item integer-share-limit
6451 Small integer constants can use a shared data structure, reducing the
6452 compiler's memory usage and increasing its speed.  This sets the maximum
6453 value of a shared integer constant's.  The default value is 256.
6455 @item min-virtual-mappings
6456 Specifies the minimum number of virtual mappings in the incremental
6457 SSA updater that should be registered to trigger the virtual mappings
6458 heuristic defined by virtual-mappings-ratio.  The default value is
6459 100.
6461 @item virtual-mappings-ratio
6462 If the number of virtual mappings is virtual-mappings-ratio bigger
6463 than the number of virtual symbols to be updated, then the incremental
6464 SSA updater switches to a full update for those symbols.  The default
6465 ratio is 3.
6467 @item ssp-buffer-size
6468 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6469 protection when @option{-fstack-protection} is used.
6471 @item max-jump-thread-duplication-stmts
6472 Maximum number of statements allowed in a block that needs to be
6473 duplicated when threading jumps.
6475 @item max-fields-for-field-sensitive
6476 Maximum number of fields in a structure we will treat in
6477 a field sensitive manner during pointer analysis.
6479 @item prefetch-latency
6480 Estimate on average number of instructions that are executed before
6481 prefetch finishes.  The distance we prefetch ahead is proportional
6482 to this constant.  Increasing this number may also lead to less
6483 streams being prefetched (see @option{simultaneous-prefetches}).
6485 @item simultaneous-prefetches
6486 Maximum number of prefetches that can run at the same time.
6488 @item l1-cache-line-size
6489 The size of cache line in L1 cache, in bytes.
6491 @item l1-cache-size
6492 The number of cache lines in L1 cache.
6494 @item verify-canonical-types
6495 Whether the compiler should verify the ``canonical'' types used for
6496 type equality comparisons within the C++ and Objective-C++ front
6497 ends. Set to 1 (the default when GCC is configured with
6498 --enable-checking) to enable verification, 0 to disable verification
6499 (the default when GCC is configured with --disable-checking).
6501 @end table
6502 @end table
6504 @node Preprocessor Options
6505 @section Options Controlling the Preprocessor
6506 @cindex preprocessor options
6507 @cindex options, preprocessor
6509 These options control the C preprocessor, which is run on each C source
6510 file before actual compilation.
6512 If you use the @option{-E} option, nothing is done except preprocessing.
6513 Some of these options make sense only together with @option{-E} because
6514 they cause the preprocessor output to be unsuitable for actual
6515 compilation.
6517 @table @gcctabopt
6518 @opindex Wp
6519 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6520 and pass @var{option} directly through to the preprocessor.  If
6521 @var{option} contains commas, it is split into multiple options at the
6522 commas.  However, many options are modified, translated or interpreted
6523 by the compiler driver before being passed to the preprocessor, and
6524 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6525 interface is undocumented and subject to change, so whenever possible
6526 you should avoid using @option{-Wp} and let the driver handle the
6527 options instead.
6529 @item -Xpreprocessor @var{option}
6530 @opindex preprocessor
6531 Pass @var{option} as an option to the preprocessor.  You can use this to
6532 supply system-specific preprocessor options which GCC does not know how to
6533 recognize.
6535 If you want to pass an option that takes an argument, you must use
6536 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6537 @end table
6539 @include cppopts.texi
6541 @node Assembler Options
6542 @section Passing Options to the Assembler
6544 @c prevent bad page break with this line
6545 You can pass options to the assembler.
6547 @table @gcctabopt
6548 @item -Wa,@var{option}
6549 @opindex Wa
6550 Pass @var{option} as an option to the assembler.  If @var{option}
6551 contains commas, it is split into multiple options at the commas.
6553 @item -Xassembler @var{option}
6554 @opindex Xassembler
6555 Pass @var{option} as an option to the assembler.  You can use this to
6556 supply system-specific assembler options which GCC does not know how to
6557 recognize.
6559 If you want to pass an option that takes an argument, you must use
6560 @option{-Xassembler} twice, once for the option and once for the argument.
6562 @end table
6564 @node Link Options
6565 @section Options for Linking
6566 @cindex link options
6567 @cindex options, linking
6569 These options come into play when the compiler links object files into
6570 an executable output file.  They are meaningless if the compiler is
6571 not doing a link step.
6573 @table @gcctabopt
6574 @cindex file names
6575 @item @var{object-file-name}
6576 A file name that does not end in a special recognized suffix is
6577 considered to name an object file or library.  (Object files are
6578 distinguished from libraries by the linker according to the file
6579 contents.)  If linking is done, these object files are used as input
6580 to the linker.
6582 @item -c
6583 @itemx -S
6584 @itemx -E
6585 @opindex c
6586 @opindex S
6587 @opindex E
6588 If any of these options is used, then the linker is not run, and
6589 object file names should not be used as arguments.  @xref{Overall
6590 Options}.
6592 @cindex Libraries
6593 @item -l@var{library}
6594 @itemx -l @var{library}
6595 @opindex l
6596 Search the library named @var{library} when linking.  (The second
6597 alternative with the library as a separate argument is only for
6598 POSIX compliance and is not recommended.)
6600 It makes a difference where in the command you write this option; the
6601 linker searches and processes libraries and object files in the order they
6602 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6603 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6604 to functions in @samp{z}, those functions may not be loaded.
6606 The linker searches a standard list of directories for the library,
6607 which is actually a file named @file{lib@var{library}.a}.  The linker
6608 then uses this file as if it had been specified precisely by name.
6610 The directories searched include several standard system directories
6611 plus any that you specify with @option{-L}.
6613 Normally the files found this way are library files---archive files
6614 whose members are object files.  The linker handles an archive file by
6615 scanning through it for members which define symbols that have so far
6616 been referenced but not defined.  But if the file that is found is an
6617 ordinary object file, it is linked in the usual fashion.  The only
6618 difference between using an @option{-l} option and specifying a file name
6619 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6620 and searches several directories.
6622 @item -lobjc
6623 @opindex lobjc
6624 You need this special case of the @option{-l} option in order to
6625 link an Objective-C or Objective-C++ program.
6627 @item -nostartfiles
6628 @opindex nostartfiles
6629 Do not use the standard system startup files when linking.
6630 The standard system libraries are used normally, unless @option{-nostdlib}
6631 or @option{-nodefaultlibs} is used.
6633 @item -nodefaultlibs
6634 @opindex nodefaultlibs
6635 Do not use the standard system libraries when linking.
6636 Only the libraries you specify will be passed to the linker.
6637 The standard startup files are used normally, unless @option{-nostartfiles}
6638 is used.  The compiler may generate calls to @code{memcmp},
6639 @code{memset}, @code{memcpy} and @code{memmove}.
6640 These entries are usually resolved by entries in
6641 libc.  These entry points should be supplied through some other
6642 mechanism when this option is specified.
6644 @item -nostdlib
6645 @opindex nostdlib
6646 Do not use the standard system startup files or libraries when linking.
6647 No startup files and only the libraries you specify will be passed to
6648 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6649 @code{memcpy} and @code{memmove}.
6650 These entries are usually resolved by entries in
6651 libc.  These entry points should be supplied through some other
6652 mechanism when this option is specified.
6654 @cindex @option{-lgcc}, use with @option{-nostdlib}
6655 @cindex @option{-nostdlib} and unresolved references
6656 @cindex unresolved references and @option{-nostdlib}
6657 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6658 @cindex @option{-nodefaultlibs} and unresolved references
6659 @cindex unresolved references and @option{-nodefaultlibs}
6660 One of the standard libraries bypassed by @option{-nostdlib} and
6661 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6662 that GCC uses to overcome shortcomings of particular machines, or special
6663 needs for some languages.
6664 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6665 Collection (GCC) Internals},
6666 for more discussion of @file{libgcc.a}.)
6667 In most cases, you need @file{libgcc.a} even when you want to avoid
6668 other standard libraries.  In other words, when you specify @option{-nostdlib}
6669 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6670 This ensures that you have no unresolved references to internal GCC
6671 library subroutines.  (For example, @samp{__main}, used to ensure C++
6672 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6673 GNU Compiler Collection (GCC) Internals}.)
6675 @item -pie
6676 @opindex pie
6677 Produce a position independent executable on targets which support it.
6678 For predictable results, you must also specify the same set of options
6679 that were used to generate code (@option{-fpie}, @option{-fPIE},
6680 or model suboptions) when you specify this option.
6682 @item -rdynamic
6683 @opindex rdynamic
6684 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6685 that support it. This instructs the linker to add all symbols, not
6686 only used ones, to the dynamic symbol table. This option is needed
6687 for some uses of @code{dlopen} or to allow obtaining backtraces
6688 from within a program.
6690 @item -s
6691 @opindex s
6692 Remove all symbol table and relocation information from the executable.
6694 @item -static
6695 @opindex static
6696 On systems that support dynamic linking, this prevents linking with the shared
6697 libraries.  On other systems, this option has no effect.
6699 @item -shared
6700 @opindex shared
6701 Produce a shared object which can then be linked with other objects to
6702 form an executable.  Not all systems support this option.  For predictable
6703 results, you must also specify the same set of options that were used to
6704 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6705 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6706 needs to build supplementary stub code for constructors to work.  On
6707 multi-libbed systems, @samp{gcc -shared} must select the correct support
6708 libraries to link against.  Failing to supply the correct flags may lead
6709 to subtle defects.  Supplying them in cases where they are not necessary
6710 is innocuous.}
6712 @item -shared-libgcc
6713 @itemx -static-libgcc
6714 @opindex shared-libgcc
6715 @opindex static-libgcc
6716 On systems that provide @file{libgcc} as a shared library, these options
6717 force the use of either the shared or static version respectively.
6718 If no shared version of @file{libgcc} was built when the compiler was
6719 configured, these options have no effect.
6721 There are several situations in which an application should use the
6722 shared @file{libgcc} instead of the static version.  The most common
6723 of these is when the application wishes to throw and catch exceptions
6724 across different shared libraries.  In that case, each of the libraries
6725 as well as the application itself should use the shared @file{libgcc}.
6727 Therefore, the G++ and GCJ drivers automatically add
6728 @option{-shared-libgcc} whenever you build a shared library or a main
6729 executable, because C++ and Java programs typically use exceptions, so
6730 this is the right thing to do.
6732 If, instead, you use the GCC driver to create shared libraries, you may
6733 find that they will not always be linked with the shared @file{libgcc}.
6734 If GCC finds, at its configuration time, that you have a non-GNU linker
6735 or a GNU linker that does not support option @option{--eh-frame-hdr},
6736 it will link the shared version of @file{libgcc} into shared libraries
6737 by default.  Otherwise, it will take advantage of the linker and optimize
6738 away the linking with the shared version of @file{libgcc}, linking with
6739 the static version of libgcc by default.  This allows exceptions to
6740 propagate through such shared libraries, without incurring relocation
6741 costs at library load time.
6743 However, if a library or main executable is supposed to throw or catch
6744 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6745 for the languages used in the program, or using the option
6746 @option{-shared-libgcc}, such that it is linked with the shared
6747 @file{libgcc}.
6749 @item -symbolic
6750 @opindex symbolic
6751 Bind references to global symbols when building a shared object.  Warn
6752 about any unresolved references (unless overridden by the link editor
6753 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6754 this option.
6756 @item -Xlinker @var{option}
6757 @opindex Xlinker
6758 Pass @var{option} as an option to the linker.  You can use this to
6759 supply system-specific linker options which GCC does not know how to
6760 recognize.
6762 If you want to pass an option that takes an argument, you must use
6763 @option{-Xlinker} twice, once for the option and once for the argument.
6764 For example, to pass @option{-assert definitions}, you must write
6765 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6766 @option{-Xlinker "-assert definitions"}, because this passes the entire
6767 string as a single argument, which is not what the linker expects.
6769 @item -Wl,@var{option}
6770 @opindex Wl
6771 Pass @var{option} as an option to the linker.  If @var{option} contains
6772 commas, it is split into multiple options at the commas.
6774 @item -u @var{symbol}
6775 @opindex u
6776 Pretend the symbol @var{symbol} is undefined, to force linking of
6777 library modules to define it.  You can use @option{-u} multiple times with
6778 different symbols to force loading of additional library modules.
6779 @end table
6781 @node Directory Options
6782 @section Options for Directory Search
6783 @cindex directory options
6784 @cindex options, directory search
6785 @cindex search path
6787 These options specify directories to search for header files, for
6788 libraries and for parts of the compiler:
6790 @table @gcctabopt
6791 @item -I@var{dir}
6792 @opindex I
6793 Add the directory @var{dir} to the head of the list of directories to be
6794 searched for header files.  This can be used to override a system header
6795 file, substituting your own version, since these directories are
6796 searched before the system header file directories.  However, you should
6797 not use this option to add directories that contain vendor-supplied
6798 system header files (use @option{-isystem} for that).  If you use more than
6799 one @option{-I} option, the directories are scanned in left-to-right
6800 order; the standard system directories come after.
6802 If a standard system include directory, or a directory specified with
6803 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6804 option will be ignored.  The directory will still be searched but as a
6805 system directory at its normal position in the system include chain.
6806 This is to ensure that GCC's procedure to fix buggy system headers and
6807 the ordering for the include_next directive are not inadvertently changed.
6808 If you really need to change the search order for system directories,
6809 use the @option{-nostdinc} and/or @option{-isystem} options.
6811 @item -iquote@var{dir}
6812 @opindex iquote
6813 Add the directory @var{dir} to the head of the list of directories to
6814 be searched for header files only for the case of @samp{#include
6815 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6816 otherwise just like @option{-I}.
6818 @item -L@var{dir}
6819 @opindex L
6820 Add directory @var{dir} to the list of directories to be searched
6821 for @option{-l}.
6823 @item -B@var{prefix}
6824 @opindex B
6825 This option specifies where to find the executables, libraries,
6826 include files, and data files of the compiler itself.
6828 The compiler driver program runs one or more of the subprograms
6829 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6830 @var{prefix} as a prefix for each program it tries to run, both with and
6831 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6833 For each subprogram to be run, the compiler driver first tries the
6834 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6835 was not specified, the driver tries two standard prefixes, which are
6836 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6837 those results in a file name that is found, the unmodified program
6838 name is searched for using the directories specified in your
6839 @env{PATH} environment variable.
6841 The compiler will check to see if the path provided by the @option{-B}
6842 refers to a directory, and if necessary it will add a directory
6843 separator character at the end of the path.
6845 @option{-B} prefixes that effectively specify directory names also apply
6846 to libraries in the linker, because the compiler translates these
6847 options into @option{-L} options for the linker.  They also apply to
6848 includes files in the preprocessor, because the compiler translates these
6849 options into @option{-isystem} options for the preprocessor.  In this case,
6850 the compiler appends @samp{include} to the prefix.
6852 The run-time support file @file{libgcc.a} can also be searched for using
6853 the @option{-B} prefix, if needed.  If it is not found there, the two
6854 standard prefixes above are tried, and that is all.  The file is left
6855 out of the link if it is not found by those means.
6857 Another way to specify a prefix much like the @option{-B} prefix is to use
6858 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6859 Variables}.
6861 As a special kludge, if the path provided by @option{-B} is
6862 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6863 9, then it will be replaced by @file{[dir/]include}.  This is to help
6864 with boot-strapping the compiler.
6866 @item -specs=@var{file}
6867 @opindex specs
6868 Process @var{file} after the compiler reads in the standard @file{specs}
6869 file, in order to override the defaults that the @file{gcc} driver
6870 program uses when determining what switches to pass to @file{cc1},
6871 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6872 @option{-specs=@var{file}} can be specified on the command line, and they
6873 are processed in order, from left to right.
6875 @item --sysroot=@var{dir}
6876 @opindex sysroot
6877 Use @var{dir} as the logical root directory for headers and libraries.
6878 For example, if the compiler would normally search for headers in
6879 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6880 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6882 If you use both this option and the @option{-isysroot} option, then
6883 the @option{--sysroot} option will apply to libraries, but the
6884 @option{-isysroot} option will apply to header files.
6886 The GNU linker (beginning with version 2.16) has the necessary support
6887 for this option.  If your linker does not support this option, the
6888 header file aspect of @option{--sysroot} will still work, but the
6889 library aspect will not.
6891 @item -I-
6892 @opindex I-
6893 This option has been deprecated.  Please use @option{-iquote} instead for
6894 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6895 Any directories you specify with @option{-I} options before the @option{-I-}
6896 option are searched only for the case of @samp{#include "@var{file}"};
6897 they are not searched for @samp{#include <@var{file}>}.
6899 If additional directories are specified with @option{-I} options after
6900 the @option{-I-}, these directories are searched for all @samp{#include}
6901 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6902 this way.)
6904 In addition, the @option{-I-} option inhibits the use of the current
6905 directory (where the current input file came from) as the first search
6906 directory for @samp{#include "@var{file}"}.  There is no way to
6907 override this effect of @option{-I-}.  With @option{-I.} you can specify
6908 searching the directory which was current when the compiler was
6909 invoked.  That is not exactly the same as what the preprocessor does
6910 by default, but it is often satisfactory.
6912 @option{-I-} does not inhibit the use of the standard system directories
6913 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6914 independent.
6915 @end table
6917 @c man end
6919 @node Spec Files
6920 @section Specifying subprocesses and the switches to pass to them
6921 @cindex Spec Files
6923 @command{gcc} is a driver program.  It performs its job by invoking a
6924 sequence of other programs to do the work of compiling, assembling and
6925 linking.  GCC interprets its command-line parameters and uses these to
6926 deduce which programs it should invoke, and which command-line options
6927 it ought to place on their command lines.  This behavior is controlled
6928 by @dfn{spec strings}.  In most cases there is one spec string for each
6929 program that GCC can invoke, but a few programs have multiple spec
6930 strings to control their behavior.  The spec strings built into GCC can
6931 be overridden by using the @option{-specs=} command-line switch to specify
6932 a spec file.
6934 @dfn{Spec files} are plaintext files that are used to construct spec
6935 strings.  They consist of a sequence of directives separated by blank
6936 lines.  The type of directive is determined by the first non-whitespace
6937 character on the line and it can be one of the following:
6939 @table @code
6940 @item %@var{command}
6941 Issues a @var{command} to the spec file processor.  The commands that can
6942 appear here are:
6944 @table @code
6945 @item %include <@var{file}>
6946 @cindex %include
6947 Search for @var{file} and insert its text at the current point in the
6948 specs file.
6950 @item %include_noerr <@var{file}>
6951 @cindex %include_noerr
6952 Just like @samp{%include}, but do not generate an error message if the include
6953 file cannot be found.
6955 @item %rename @var{old_name} @var{new_name}
6956 @cindex %rename
6957 Rename the spec string @var{old_name} to @var{new_name}.
6959 @end table
6961 @item *[@var{spec_name}]:
6962 This tells the compiler to create, override or delete the named spec
6963 string.  All lines after this directive up to the next directive or
6964 blank line are considered to be the text for the spec string.  If this
6965 results in an empty string then the spec will be deleted.  (Or, if the
6966 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6967 does not currently exist a new spec will be created.  If the spec does
6968 exist then its contents will be overridden by the text of this
6969 directive, unless the first character of that text is the @samp{+}
6970 character, in which case the text will be appended to the spec.
6972 @item [@var{suffix}]:
6973 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6974 and up to the next directive or blank line are considered to make up the
6975 spec string for the indicated suffix.  When the compiler encounters an
6976 input file with the named suffix, it will processes the spec string in
6977 order to work out how to compile that file.  For example:
6979 @smallexample
6980 .ZZ:
6981 z-compile -input %i
6982 @end smallexample
6984 This says that any input file whose name ends in @samp{.ZZ} should be
6985 passed to the program @samp{z-compile}, which should be invoked with the
6986 command-line switch @option{-input} and with the result of performing the
6987 @samp{%i} substitution.  (See below.)
6989 As an alternative to providing a spec string, the text that follows a
6990 suffix directive can be one of the following:
6992 @table @code
6993 @item @@@var{language}
6994 This says that the suffix is an alias for a known @var{language}.  This is
6995 similar to using the @option{-x} command-line switch to GCC to specify a
6996 language explicitly.  For example:
6998 @smallexample
6999 .ZZ:
7000 @@c++
7001 @end smallexample
7003 Says that .ZZ files are, in fact, C++ source files.
7005 @item #@var{name}
7006 This causes an error messages saying:
7008 @smallexample
7009 @var{name} compiler not installed on this system.
7010 @end smallexample
7011 @end table
7013 GCC already has an extensive list of suffixes built into it.
7014 This directive will add an entry to the end of the list of suffixes, but
7015 since the list is searched from the end backwards, it is effectively
7016 possible to override earlier entries using this technique.
7018 @end table
7020 GCC has the following spec strings built into it.  Spec files can
7021 override these strings or create their own.  Note that individual
7022 targets can also add their own spec strings to this list.
7024 @smallexample
7025 asm          Options to pass to the assembler
7026 asm_final    Options to pass to the assembler post-processor
7027 cpp          Options to pass to the C preprocessor
7028 cc1          Options to pass to the C compiler
7029 cc1plus      Options to pass to the C++ compiler
7030 endfile      Object files to include at the end of the link
7031 link         Options to pass to the linker
7032 lib          Libraries to include on the command line to the linker
7033 libgcc       Decides which GCC support library to pass to the linker
7034 linker       Sets the name of the linker
7035 predefines   Defines to be passed to the C preprocessor
7036 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7037              by default
7038 startfile    Object files to include at the start of the link
7039 @end smallexample
7041 Here is a small example of a spec file:
7043 @smallexample
7044 %rename lib                 old_lib
7046 *lib:
7047 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7048 @end smallexample
7050 This example renames the spec called @samp{lib} to @samp{old_lib} and
7051 then overrides the previous definition of @samp{lib} with a new one.
7052 The new definition adds in some extra command-line options before
7053 including the text of the old definition.
7055 @dfn{Spec strings} are a list of command-line options to be passed to their
7056 corresponding program.  In addition, the spec strings can contain
7057 @samp{%}-prefixed sequences to substitute variable text or to
7058 conditionally insert text into the command line.  Using these constructs
7059 it is possible to generate quite complex command lines.
7061 Here is a table of all defined @samp{%}-sequences for spec
7062 strings.  Note that spaces are not generated automatically around the
7063 results of expanding these sequences.  Therefore you can concatenate them
7064 together or combine them with constant text in a single argument.
7066 @table @code
7067 @item %%
7068 Substitute one @samp{%} into the program name or argument.
7070 @item %i
7071 Substitute the name of the input file being processed.
7073 @item %b
7074 Substitute the basename of the input file being processed.
7075 This is the substring up to (and not including) the last period
7076 and not including the directory.
7078 @item %B
7079 This is the same as @samp{%b}, but include the file suffix (text after
7080 the last period).
7082 @item %d
7083 Marks the argument containing or following the @samp{%d} as a
7084 temporary file name, so that that file will be deleted if GCC exits
7085 successfully.  Unlike @samp{%g}, this contributes no text to the
7086 argument.
7088 @item %g@var{suffix}
7089 Substitute a file name that has suffix @var{suffix} and is chosen
7090 once per compilation, and mark the argument in the same way as
7091 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7092 name is now chosen in a way that is hard to predict even when previously
7093 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7094 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7095 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7096 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7097 was simply substituted with a file name chosen once per compilation,
7098 without regard to any appended suffix (which was therefore treated
7099 just like ordinary text), making such attacks more likely to succeed.
7101 @item %u@var{suffix}
7102 Like @samp{%g}, but generates a new temporary file name even if
7103 @samp{%u@var{suffix}} was already seen.
7105 @item %U@var{suffix}
7106 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7107 new one if there is no such last file name.  In the absence of any
7108 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7109 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7110 would involve the generation of two distinct file names, one
7111 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7112 simply substituted with a file name chosen for the previous @samp{%u},
7113 without regard to any appended suffix.
7115 @item %j@var{suffix}
7116 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7117 writable, and if save-temps is off; otherwise, substitute the name
7118 of a temporary file, just like @samp{%u}.  This temporary file is not
7119 meant for communication between processes, but rather as a junk
7120 disposal mechanism.
7122 @item %|@var{suffix}
7123 @itemx %m@var{suffix}
7124 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7125 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7126 all.  These are the two most common ways to instruct a program that it
7127 should read from standard input or write to standard output.  If you
7128 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7129 construct: see for example @file{f/lang-specs.h}.
7131 @item %.@var{SUFFIX}
7132 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7133 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7134 terminated by the next space or %.
7136 @item %w
7137 Marks the argument containing or following the @samp{%w} as the
7138 designated output file of this compilation.  This puts the argument
7139 into the sequence of arguments that @samp{%o} will substitute later.
7141 @item %o
7142 Substitutes the names of all the output files, with spaces
7143 automatically placed around them.  You should write spaces
7144 around the @samp{%o} as well or the results are undefined.
7145 @samp{%o} is for use in the specs for running the linker.
7146 Input files whose names have no recognized suffix are not compiled
7147 at all, but they are included among the output files, so they will
7148 be linked.
7150 @item %O
7151 Substitutes the suffix for object files.  Note that this is
7152 handled specially when it immediately follows @samp{%g, %u, or %U},
7153 because of the need for those to form complete file names.  The
7154 handling is such that @samp{%O} is treated exactly as if it had already
7155 been substituted, except that @samp{%g, %u, and %U} do not currently
7156 support additional @var{suffix} characters following @samp{%O} as they would
7157 following, for example, @samp{.o}.
7159 @item %p
7160 Substitutes the standard macro predefinitions for the
7161 current target machine.  Use this when running @code{cpp}.
7163 @item %P
7164 Like @samp{%p}, but puts @samp{__} before and after the name of each
7165 predefined macro, except for macros that start with @samp{__} or with
7166 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7169 @item %I
7170 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7171 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7172 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7173 and @option{-imultilib} as necessary.
7175 @item %s
7176 Current argument is the name of a library or startup file of some sort.
7177 Search for that file in a standard list of directories and substitute
7178 the full name found.
7180 @item %e@var{str}
7181 Print @var{str} as an error message.  @var{str} is terminated by a newline.
7182 Use this when inconsistent options are detected.
7184 @item %(@var{name})
7185 Substitute the contents of spec string @var{name} at this point.
7187 @item %[@var{name}]
7188 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7190 @item %x@{@var{option}@}
7191 Accumulate an option for @samp{%X}.
7193 @item %X
7194 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7195 spec string.
7197 @item %Y
7198 Output the accumulated assembler options specified by @option{-Wa}.
7200 @item %Z
7201 Output the accumulated preprocessor options specified by @option{-Wp}.
7203 @item %a
7204 Process the @code{asm} spec.  This is used to compute the
7205 switches to be passed to the assembler.
7207 @item %A
7208 Process the @code{asm_final} spec.  This is a spec string for
7209 passing switches to an assembler post-processor, if such a program is
7210 needed.
7212 @item %l
7213 Process the @code{link} spec.  This is the spec for computing the
7214 command line passed to the linker.  Typically it will make use of the
7215 @samp{%L %G %S %D and %E} sequences.
7217 @item %D
7218 Dump out a @option{-L} option for each directory that GCC believes might
7219 contain startup files.  If the target supports multilibs then the
7220 current multilib directory will be prepended to each of these paths.
7222 @item %L
7223 Process the @code{lib} spec.  This is a spec string for deciding which
7224 libraries should be included on the command line to the linker.
7226 @item %G
7227 Process the @code{libgcc} spec.  This is a spec string for deciding
7228 which GCC support library should be included on the command line to the linker.
7230 @item %S
7231 Process the @code{startfile} spec.  This is a spec for deciding which
7232 object files should be the first ones passed to the linker.  Typically
7233 this might be a file named @file{crt0.o}.
7235 @item %E
7236 Process the @code{endfile} spec.  This is a spec string that specifies
7237 the last object files that will be passed to the linker.
7239 @item %C
7240 Process the @code{cpp} spec.  This is used to construct the arguments
7241 to be passed to the C preprocessor.
7243 @item %1
7244 Process the @code{cc1} spec.  This is used to construct the options to be
7245 passed to the actual C compiler (@samp{cc1}).
7247 @item %2
7248 Process the @code{cc1plus} spec.  This is used to construct the options to be
7249 passed to the actual C++ compiler (@samp{cc1plus}).
7251 @item %*
7252 Substitute the variable part of a matched option.  See below.
7253 Note that each comma in the substituted string is replaced by
7254 a single space.
7256 @item %<@code{S}
7257 Remove all occurrences of @code{-S} from the command line.  Note---this
7258 command is position dependent.  @samp{%} commands in the spec string
7259 before this one will see @code{-S}, @samp{%} commands in the spec string
7260 after this one will not.
7262 @item %:@var{function}(@var{args})
7263 Call the named function @var{function}, passing it @var{args}.
7264 @var{args} is first processed as a nested spec string, then split
7265 into an argument vector in the usual fashion.  The function returns
7266 a string which is processed as if it had appeared literally as part
7267 of the current spec.
7269 The following built-in spec functions are provided:
7271 @table @code
7272 @item @code{if-exists}
7273 The @code{if-exists} spec function takes one argument, an absolute
7274 pathname to a file.  If the file exists, @code{if-exists} returns the
7275 pathname.  Here is a small example of its usage:
7277 @smallexample
7278 *startfile:
7279 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7280 @end smallexample
7282 @item @code{if-exists-else}
7283 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7284 spec function, except that it takes two arguments.  The first argument is
7285 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7286 returns the pathname.  If it does not exist, it returns the second argument.
7287 This way, @code{if-exists-else} can be used to select one file or another,
7288 based on the existence of the first.  Here is a small example of its usage:
7290 @smallexample
7291 *startfile:
7292 crt0%O%s %:if-exists(crti%O%s) \
7293 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7294 @end smallexample
7296 @item @code{replace-outfile}
7297 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7298 first argument in the outfiles array and replaces it with the second argument.  Here
7299 is a small example of its usage:
7301 @smallexample
7302 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7303 @end smallexample
7305 @end table
7307 @item %@{@code{S}@}
7308 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7309 If that switch was not specified, this substitutes nothing.  Note that
7310 the leading dash is omitted when specifying this option, and it is
7311 automatically inserted if the substitution is performed.  Thus the spec
7312 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7313 and would output the command line option @option{-foo}.
7315 @item %W@{@code{S}@}
7316 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7317 deleted on failure.
7319 @item %@{@code{S}*@}
7320 Substitutes all the switches specified to GCC whose names start
7321 with @code{-S}, but which also take an argument.  This is used for
7322 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7323 GCC considers @option{-o foo} as being
7324 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7325 text, including the space.  Thus two arguments would be generated.
7327 @item %@{@code{S}*&@code{T}*@}
7328 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7329 (the order of @code{S} and @code{T} in the spec is not significant).
7330 There can be any number of ampersand-separated variables; for each the
7331 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7333 @item %@{@code{S}:@code{X}@}
7334 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7336 @item %@{!@code{S}:@code{X}@}
7337 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7339 @item %@{@code{S}*:@code{X}@}
7340 Substitutes @code{X} if one or more switches whose names start with
7341 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7342 once, no matter how many such switches appeared.  However, if @code{%*}
7343 appears somewhere in @code{X}, then @code{X} will be substituted once
7344 for each matching switch, with the @code{%*} replaced by the part of
7345 that switch that matched the @code{*}.
7347 @item %@{.@code{S}:@code{X}@}
7348 Substitutes @code{X}, if processing a file with suffix @code{S}.
7350 @item %@{!.@code{S}:@code{X}@}
7351 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7353 @item %@{@code{S}|@code{P}:@code{X}@}
7354 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7355 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7356 although they have a stronger binding than the @samp{|}.  If @code{%*}
7357 appears in @code{X}, all of the alternatives must be starred, and only
7358 the first matching alternative is substituted.
7360 For example, a spec string like this:
7362 @smallexample
7363 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7364 @end smallexample
7366 will output the following command-line options from the following input
7367 command-line options:
7369 @smallexample
7370 fred.c        -foo -baz
7371 jim.d         -bar -boggle
7372 -d fred.c     -foo -baz -boggle
7373 -d jim.d      -bar -baz -boggle
7374 @end smallexample
7376 @item %@{S:X; T:Y; :D@}
7378 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7379 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7380 be as many clauses as you need.  This may be combined with @code{.},
7381 @code{!}, @code{|}, and @code{*} as needed.
7384 @end table
7386 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7387 construct may contain other nested @samp{%} constructs or spaces, or
7388 even newlines.  They are processed as usual, as described above.
7389 Trailing white space in @code{X} is ignored.  White space may also
7390 appear anywhere on the left side of the colon in these constructs,
7391 except between @code{.} or @code{*} and the corresponding word.
7393 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7394 handled specifically in these constructs.  If another value of
7395 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7396 @option{-W} switch is found later in the command line, the earlier
7397 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7398 just one letter, which passes all matching options.
7400 The character @samp{|} at the beginning of the predicate text is used to
7401 indicate that a command should be piped to the following command, but
7402 only if @option{-pipe} is specified.
7404 It is built into GCC which switches take arguments and which do not.
7405 (You might think it would be useful to generalize this to allow each
7406 compiler's spec to say which switches take arguments.  But this cannot
7407 be done in a consistent fashion.  GCC cannot even decide which input
7408 files have been specified without knowing which switches take arguments,
7409 and it must know which input files to compile in order to tell which
7410 compilers to run).
7412 GCC also knows implicitly that arguments starting in @option{-l} are to be
7413 treated as compiler output files, and passed to the linker in their
7414 proper position among the other output files.
7416 @c man begin OPTIONS
7418 @node Target Options
7419 @section Specifying Target Machine and Compiler Version
7420 @cindex target options
7421 @cindex cross compiling
7422 @cindex specifying machine version
7423 @cindex specifying compiler version and target machine
7424 @cindex compiler version, specifying
7425 @cindex target machine, specifying
7427 The usual way to run GCC is to run the executable called @file{gcc}, or
7428 @file{<machine>-gcc} when cross-compiling, or
7429 @file{<machine>-gcc-<version>} to run a version other than the one that
7430 was installed last.  Sometimes this is inconvenient, so GCC provides
7431 options that will switch to another cross-compiler or version.
7433 @table @gcctabopt
7434 @item -b @var{machine}
7435 @opindex b
7436 The argument @var{machine} specifies the target machine for compilation.
7438 The value to use for @var{machine} is the same as was specified as the
7439 machine type when configuring GCC as a cross-compiler.  For
7440 example, if a cross-compiler was configured with @samp{configure
7441 arm-elf}, meaning to compile for an arm processor with elf binaries,
7442 then you would specify @option{-b arm-elf} to run that cross compiler.
7443 Because there are other options beginning with @option{-b}, the
7444 configuration must contain a hyphen. 
7446 @item -V @var{version}
7447 @opindex V
7448 The argument @var{version} specifies which version of GCC to run.
7449 This is useful when multiple versions are installed.  For example,
7450 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7451 @end table
7453 The @option{-V} and @option{-b} options work by running the
7454 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7455 use them if you can just run that directly.
7457 @node Submodel Options
7458 @section Hardware Models and Configurations
7459 @cindex submodel options
7460 @cindex specifying hardware config
7461 @cindex hardware models and configurations, specifying
7462 @cindex machine dependent options
7464 Earlier we discussed the standard option @option{-b} which chooses among
7465 different installed compilers for completely different target
7466 machines, such as VAX vs.@: 68000 vs.@: 80386.
7468 In addition, each of these target machine types can have its own
7469 special options, starting with @samp{-m}, to choose among various
7470 hardware models or configurations---for example, 68010 vs 68020,
7471 floating coprocessor or none.  A single installed version of the
7472 compiler can compile for any model or configuration, according to the
7473 options specified.
7475 Some configurations of the compiler also support additional special
7476 options, usually for compatibility with other compilers on the same
7477 platform.
7479 @c This list is ordered alphanumerically by subsection name.
7480 @c It should be the same order and spelling as these options are listed
7481 @c in Machine Dependent Options
7483 @menu
7484 * ARC Options::
7485 * ARM Options::
7486 * AVR Options::
7487 * Blackfin Options::
7488 * CRIS Options::
7489 * CRX Options::
7490 * Darwin Options::
7491 * DEC Alpha Options::
7492 * DEC Alpha/VMS Options::
7493 * FRV Options::
7494 * GNU/Linux Options::
7495 * H8/300 Options::
7496 * HPPA Options::
7497 * i386 and x86-64 Options::
7498 * IA-64 Options::
7499 * M32C Options::
7500 * M32R/D Options::
7501 * M680x0 Options::
7502 * M68hc1x Options::
7503 * MCore Options::
7504 * MIPS Options::
7505 * MMIX Options::
7506 * MN10300 Options::
7507 * MT Options::
7508 * PDP-11 Options::
7509 * PowerPC Options::
7510 * RS/6000 and PowerPC Options::
7511 * S/390 and zSeries Options::
7512 * Score Options::
7513 * SH Options::
7514 * SPARC Options::
7515 * SPU Options::
7516 * System V Options::
7517 * TMS320C3x/C4x Options::
7518 * V850 Options::
7519 * VAX Options::
7520 * x86-64 Options::
7521 * Xstormy16 Options::
7522 * Xtensa Options::
7523 * zSeries Options::
7524 @end menu
7526 @node ARC Options
7527 @subsection ARC Options
7528 @cindex ARC Options
7530 These options are defined for ARC implementations:
7532 @table @gcctabopt
7533 @item -EL
7534 @opindex EL
7535 Compile code for little endian mode.  This is the default.
7537 @item -EB
7538 @opindex EB
7539 Compile code for big endian mode.
7541 @item -mmangle-cpu
7542 @opindex mmangle-cpu
7543 Prepend the name of the cpu to all public symbol names.
7544 In multiple-processor systems, there are many ARC variants with different
7545 instruction and register set characteristics.  This flag prevents code
7546 compiled for one cpu to be linked with code compiled for another.
7547 No facility exists for handling variants that are ``almost identical''.
7548 This is an all or nothing option.
7550 @item -mcpu=@var{cpu}
7551 @opindex mcpu
7552 Compile code for ARC variant @var{cpu}.
7553 Which variants are supported depend on the configuration.
7554 All variants support @option{-mcpu=base}, this is the default.
7556 @item -mtext=@var{text-section}
7557 @itemx -mdata=@var{data-section}
7558 @itemx -mrodata=@var{readonly-data-section}
7559 @opindex mtext
7560 @opindex mdata
7561 @opindex mrodata
7562 Put functions, data, and readonly data in @var{text-section},
7563 @var{data-section}, and @var{readonly-data-section} respectively
7564 by default.  This can be overridden with the @code{section} attribute.
7565 @xref{Variable Attributes}.
7567 @end table
7569 @node ARM Options
7570 @subsection ARM Options
7571 @cindex ARM options
7573 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7574 architectures:
7576 @table @gcctabopt
7577 @item -mabi=@var{name}
7578 @opindex mabi
7579 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7580 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7582 @item -mapcs-frame
7583 @opindex mapcs-frame
7584 Generate a stack frame that is compliant with the ARM Procedure Call
7585 Standard for all functions, even if this is not strictly necessary for
7586 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7587 with this option will cause the stack frames not to be generated for
7588 leaf functions.  The default is @option{-mno-apcs-frame}.
7590 @item -mapcs
7591 @opindex mapcs
7592 This is a synonym for @option{-mapcs-frame}.
7594 @ignore
7595 @c not currently implemented
7596 @item -mapcs-stack-check
7597 @opindex mapcs-stack-check
7598 Generate code to check the amount of stack space available upon entry to
7599 every function (that actually uses some stack space).  If there is
7600 insufficient space available then either the function
7601 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7602 called, depending upon the amount of stack space required.  The run time
7603 system is required to provide these functions.  The default is
7604 @option{-mno-apcs-stack-check}, since this produces smaller code.
7606 @c not currently implemented
7607 @item -mapcs-float
7608 @opindex mapcs-float
7609 Pass floating point arguments using the float point registers.  This is
7610 one of the variants of the APCS@.  This option is recommended if the
7611 target hardware has a floating point unit or if a lot of floating point
7612 arithmetic is going to be performed by the code.  The default is
7613 @option{-mno-apcs-float}, since integer only code is slightly increased in
7614 size if @option{-mapcs-float} is used.
7616 @c not currently implemented
7617 @item -mapcs-reentrant
7618 @opindex mapcs-reentrant
7619 Generate reentrant, position independent code.  The default is
7620 @option{-mno-apcs-reentrant}.
7621 @end ignore
7623 @item -mthumb-interwork
7624 @opindex mthumb-interwork
7625 Generate code which supports calling between the ARM and Thumb
7626 instruction sets.  Without this option the two instruction sets cannot
7627 be reliably used inside one program.  The default is
7628 @option{-mno-thumb-interwork}, since slightly larger code is generated
7629 when @option{-mthumb-interwork} is specified.
7631 @item -mno-sched-prolog
7632 @opindex mno-sched-prolog
7633 Prevent the reordering of instructions in the function prolog, or the
7634 merging of those instruction with the instructions in the function's
7635 body.  This means that all functions will start with a recognizable set
7636 of instructions (or in fact one of a choice from a small set of
7637 different function prologues), and this information can be used to
7638 locate the start if functions inside an executable piece of code.  The
7639 default is @option{-msched-prolog}.
7641 @item -mhard-float
7642 @opindex mhard-float
7643 Generate output containing floating point instructions.  This is the
7644 default.
7646 @item -msoft-float
7647 @opindex msoft-float
7648 Generate output containing library calls for floating point.
7649 @strong{Warning:} the requisite libraries are not available for all ARM
7650 targets.  Normally the facilities of the machine's usual C compiler are
7651 used, but this cannot be done directly in cross-compilation.  You must make
7652 your own arrangements to provide suitable library functions for
7653 cross-compilation.
7655 @option{-msoft-float} changes the calling convention in the output file;
7656 therefore, it is only useful if you compile @emph{all} of a program with
7657 this option.  In particular, you need to compile @file{libgcc.a}, the
7658 library that comes with GCC, with @option{-msoft-float} in order for
7659 this to work.
7661 @item -mfloat-abi=@var{name}
7662 @opindex mfloat-abi
7663 Specifies which ABI to use for floating point values.  Permissible values
7664 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7666 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7667 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7668 of floating point instructions, but still uses the soft-float calling
7669 conventions.
7671 @item -mlittle-endian
7672 @opindex mlittle-endian
7673 Generate code for a processor running in little-endian mode.  This is
7674 the default for all standard configurations.
7676 @item -mbig-endian
7677 @opindex mbig-endian
7678 Generate code for a processor running in big-endian mode; the default is
7679 to compile code for a little-endian processor.
7681 @item -mwords-little-endian
7682 @opindex mwords-little-endian
7683 This option only applies when generating code for big-endian processors.
7684 Generate code for a little-endian word order but a big-endian byte
7685 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7686 option should only be used if you require compatibility with code for
7687 big-endian ARM processors generated by versions of the compiler prior to
7688 2.8.
7690 @item -mcpu=@var{name}
7691 @opindex mcpu
7692 This specifies the name of the target ARM processor.  GCC uses this name
7693 to determine what kind of instructions it can emit when generating
7694 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7695 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7696 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7697 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7698 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7699 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7700 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7701 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7702 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7703 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7704 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7705 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7706 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7707 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
7708 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
7709 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
7711 @itemx -mtune=@var{name}
7712 @opindex mtune
7713 This option is very similar to the @option{-mcpu=} option, except that
7714 instead of specifying the actual target processor type, and hence
7715 restricting which instructions can be used, it specifies that GCC should
7716 tune the performance of the code as if the target were of the type
7717 specified in this option, but still choosing the instructions that it
7718 will generate based on the cpu specified by a @option{-mcpu=} option.
7719 For some ARM implementations better performance can be obtained by using
7720 this option.
7722 @item -march=@var{name}
7723 @opindex march
7724 This specifies the name of the target ARM architecture.  GCC uses this
7725 name to determine what kind of instructions it can emit when generating
7726 assembly code.  This option can be used in conjunction with or instead
7727 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7728 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7729 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7730 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
7731 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
7733 @item -mfpu=@var{name}
7734 @itemx -mfpe=@var{number}
7735 @itemx -mfp=@var{number}
7736 @opindex mfpu
7737 @opindex mfpe
7738 @opindex mfp
7739 This specifies what floating point hardware (or hardware emulation) is
7740 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7741 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7742 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7743 with older versions of GCC@.
7745 If @option{-msoft-float} is specified this specifies the format of
7746 floating point values.
7748 @item -mstructure-size-boundary=@var{n}
7749 @opindex mstructure-size-boundary
7750 The size of all structures and unions will be rounded up to a multiple
7751 of the number of bits set by this option.  Permissible values are 8, 32
7752 and 64.  The default value varies for different toolchains.  For the COFF
7753 targeted toolchain the default value is 8.  A value of 64 is only allowed
7754 if the underlying ABI supports it.
7756 Specifying the larger number can produce faster, more efficient code, but
7757 can also increase the size of the program.  Different values are potentially
7758 incompatible.  Code compiled with one value cannot necessarily expect to
7759 work with code or libraries compiled with another value, if they exchange
7760 information using structures or unions.
7762 @item -mabort-on-noreturn
7763 @opindex mabort-on-noreturn
7764 Generate a call to the function @code{abort} at the end of a
7765 @code{noreturn} function.  It will be executed if the function tries to
7766 return.
7768 @item -mlong-calls
7769 @itemx -mno-long-calls
7770 @opindex mlong-calls
7771 @opindex mno-long-calls
7772 Tells the compiler to perform function calls by first loading the
7773 address of the function into a register and then performing a subroutine
7774 call on this register.  This switch is needed if the target function
7775 will lie outside of the 64 megabyte addressing range of the offset based
7776 version of subroutine call instruction.
7778 Even if this switch is enabled, not all function calls will be turned
7779 into long calls.  The heuristic is that static functions, functions
7780 which have the @samp{short-call} attribute, functions that are inside
7781 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7782 definitions have already been compiled within the current compilation
7783 unit, will not be turned into long calls.  The exception to this rule is
7784 that weak function definitions, functions with the @samp{long-call}
7785 attribute or the @samp{section} attribute, and functions that are within
7786 the scope of a @samp{#pragma long_calls} directive, will always be
7787 turned into long calls.
7789 This feature is not enabled by default.  Specifying
7790 @option{-mno-long-calls} will restore the default behavior, as will
7791 placing the function calls within the scope of a @samp{#pragma
7792 long_calls_off} directive.  Note these switches have no effect on how
7793 the compiler generates code to handle function calls via function
7794 pointers.
7796 @item -mnop-fun-dllimport
7797 @opindex mnop-fun-dllimport
7798 Disable support for the @code{dllimport} attribute.
7800 @item -msingle-pic-base
7801 @opindex msingle-pic-base
7802 Treat the register used for PIC addressing as read-only, rather than
7803 loading it in the prologue for each function.  The run-time system is
7804 responsible for initializing this register with an appropriate value
7805 before execution begins.
7807 @item -mpic-register=@var{reg}
7808 @opindex mpic-register
7809 Specify the register to be used for PIC addressing.  The default is R10
7810 unless stack-checking is enabled, when R9 is used.
7812 @item -mcirrus-fix-invalid-insns
7813 @opindex mcirrus-fix-invalid-insns
7814 @opindex mno-cirrus-fix-invalid-insns
7815 Insert NOPs into the instruction stream to in order to work around
7816 problems with invalid Maverick instruction combinations.  This option
7817 is only valid if the @option{-mcpu=ep9312} option has been used to
7818 enable generation of instructions for the Cirrus Maverick floating
7819 point co-processor.  This option is not enabled by default, since the
7820 problem is only present in older Maverick implementations.  The default
7821 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7822 switch.
7824 @item -mpoke-function-name
7825 @opindex mpoke-function-name
7826 Write the name of each function into the text section, directly
7827 preceding the function prologue.  The generated code is similar to this:
7829 @smallexample
7830      t0
7831          .ascii "arm_poke_function_name", 0
7832          .align
7833      t1
7834          .word 0xff000000 + (t1 - t0)
7835      arm_poke_function_name
7836          mov     ip, sp
7837          stmfd   sp!, @{fp, ip, lr, pc@}
7838          sub     fp, ip, #4
7839 @end smallexample
7841 When performing a stack backtrace, code can inspect the value of
7842 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7843 location @code{pc - 12} and the top 8 bits are set, then we know that
7844 there is a function name embedded immediately preceding this location
7845 and has length @code{((pc[-3]) & 0xff000000)}.
7847 @item -mthumb
7848 @opindex mthumb
7849 Generate code for the Thumb instruction set.  The default is to
7850 use the 32-bit ARM instruction set.
7851 This option automatically enables either 16-bit Thumb-1 or
7852 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
7853 and @option{-march=@var{name}} options.
7855 @item -mtpcs-frame
7856 @opindex mtpcs-frame
7857 Generate a stack frame that is compliant with the Thumb Procedure Call
7858 Standard for all non-leaf functions.  (A leaf function is one that does
7859 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7861 @item -mtpcs-leaf-frame
7862 @opindex mtpcs-leaf-frame
7863 Generate a stack frame that is compliant with the Thumb Procedure Call
7864 Standard for all leaf functions.  (A leaf function is one that does
7865 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7867 @item -mcallee-super-interworking
7868 @opindex mcallee-super-interworking
7869 Gives all externally visible functions in the file being compiled an ARM
7870 instruction set header which switches to Thumb mode before executing the
7871 rest of the function.  This allows these functions to be called from
7872 non-interworking code.
7874 @item -mcaller-super-interworking
7875 @opindex mcaller-super-interworking
7876 Allows calls via function pointers (including virtual functions) to
7877 execute correctly regardless of whether the target code has been
7878 compiled for interworking or not.  There is a small overhead in the cost
7879 of executing a function pointer if this option is enabled.
7881 @item -mtp=@var{name}
7882 @opindex mtp
7883 Specify the access model for the thread local storage pointer.  The valid
7884 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7885 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7886 (supported in the arm6k architecture), and @option{auto}, which uses the
7887 best available method for the selected processor.  The default setting is
7888 @option{auto}.
7890 @end table
7892 @node AVR Options
7893 @subsection AVR Options
7894 @cindex AVR Options
7896 These options are defined for AVR implementations:
7898 @table @gcctabopt
7899 @item -mmcu=@var{mcu}
7900 @opindex mmcu
7901 Specify ATMEL AVR instruction set or MCU type.
7903 Instruction set avr1 is for the minimal AVR core, not supported by the C
7904 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7905 attiny11, attiny12, attiny15, attiny28).
7907 Instruction set avr2 (default) is for the classic AVR core with up to
7908 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7909 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7910 at90c8534, at90s8535).
7912 Instruction set avr3 is for the classic AVR core with up to 128K program
7913 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7915 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7916 memory space (MCU types: atmega8, atmega83, atmega85).
7918 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7919 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7920 atmega64, atmega128, at43usb355, at94k).
7922 @item -msize
7923 @opindex msize
7924 Output instruction sizes to the asm file.
7926 @item -minit-stack=@var{N}
7927 @opindex minit-stack
7928 Specify the initial stack address, which may be a symbol or numeric value,
7929 @samp{__stack} is the default.
7931 @item -mno-interrupts
7932 @opindex mno-interrupts
7933 Generated code is not compatible with hardware interrupts.
7934 Code size will be smaller.
7936 @item -mcall-prologues
7937 @opindex mcall-prologues
7938 Functions prologues/epilogues expanded as call to appropriate
7939 subroutines.  Code size will be smaller.
7941 @item -mno-tablejump
7942 @opindex mno-tablejump
7943 Do not generate tablejump insns which sometimes increase code size.
7945 @item -mtiny-stack
7946 @opindex mtiny-stack
7947 Change only the low 8 bits of the stack pointer.
7949 @item -mint8
7950 @opindex mint8
7951 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7952 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7953 and long long will be 4 bytes.  Please note that this option does not
7954 comply to the C standards, but it will provide you with smaller code
7955 size.
7956 @end table
7958 @node Blackfin Options
7959 @subsection Blackfin Options
7960 @cindex Blackfin Options
7962 @table @gcctabopt
7963 @item -momit-leaf-frame-pointer
7964 @opindex momit-leaf-frame-pointer
7965 Don't keep the frame pointer in a register for leaf functions.  This
7966 avoids the instructions to save, set up and restore frame pointers and
7967 makes an extra register available in leaf functions.  The option
7968 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7969 which might make debugging harder.
7971 @item -mspecld-anomaly
7972 @opindex mspecld-anomaly
7973 When enabled, the compiler will ensure that the generated code does not
7974 contain speculative loads after jump instructions.  This option is enabled
7975 by default.
7977 @item -mno-specld-anomaly
7978 @opindex mno-specld-anomaly
7979 Don't generate extra code to prevent speculative loads from occurring.
7981 @item -mcsync-anomaly
7982 @opindex mcsync-anomaly
7983 When enabled, the compiler will ensure that the generated code does not
7984 contain CSYNC or SSYNC instructions too soon after conditional branches.
7985 This option is enabled by default.
7987 @item -mno-csync-anomaly
7988 @opindex mno-csync-anomaly
7989 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7990 occurring too soon after a conditional branch.
7992 @item -mlow-64k
7993 @opindex mlow-64k
7994 When enabled, the compiler is free to take advantage of the knowledge that
7995 the entire program fits into the low 64k of memory.
7997 @item -mno-low-64k
7998 @opindex mno-low-64k
7999 Assume that the program is arbitrarily large.  This is the default.
8001 @item -mstack-check-l1
8002 @opindex mstack-check-l1
8003 Do stack checking using information placed into L1 scratchpad memory by the
8004 uClinux kernel.
8006 @item -mid-shared-library
8007 @opindex mid-shared-library
8008 Generate code that supports shared libraries via the library ID method.
8009 This allows for execute in place and shared libraries in an environment
8010 without virtual memory management.  This option implies @option{-fPIC}.
8012 @item -mno-id-shared-library
8013 @opindex mno-id-shared-library
8014 Generate code that doesn't assume ID based shared libraries are being used.
8015 This is the default.
8017 @item -mleaf-id-shared-library
8018 @opindex mleaf-id-shared-library
8019 Generate code that supports shared libraries via the library ID method,
8020 but assumes that this library or executable won't link against any other
8021 ID shared libraries.  That allows the compiler to use faster code for jumps
8022 and calls.
8024 @item -mno-leaf-id-shared-library
8025 @opindex mno-leaf-id-shared-library
8026 Do not assume that the code being compiled won't link against any ID shared
8027 libraries.  Slower code will be generated for jump and call insns.
8029 @item -mshared-library-id=n
8030 @opindex mshared-library-id
8031 Specified the identification number of the ID based shared library being
8032 compiled.  Specifying a value of 0 will generate more compact code, specifying
8033 other values will force the allocation of that number to the current
8034 library but is no more space or time efficient than omitting this option.
8036 @item -msep-data
8037 @opindex msep-data
8038 Generate code that allows the data segment to be located in a different
8039 area of memory from the text segment.  This allows for execute in place in
8040 an environment without virtual memory management by eliminating relocations
8041 against the text section.
8043 @item -mno-sep-data
8044 @opindex mno-sep-data
8045 Generate code that assumes that the data segment follows the text segment.
8046 This is the default.
8048 @item -mlong-calls
8049 @itemx -mno-long-calls
8050 @opindex mlong-calls
8051 @opindex mno-long-calls
8052 Tells the compiler to perform function calls by first loading the
8053 address of the function into a register and then performing a subroutine
8054 call on this register.  This switch is needed if the target function
8055 will lie outside of the 24 bit addressing range of the offset based
8056 version of subroutine call instruction.
8058 This feature is not enabled by default.  Specifying
8059 @option{-mno-long-calls} will restore the default behavior.  Note these
8060 switches have no effect on how the compiler generates code to handle
8061 function calls via function pointers.
8062 @end table
8064 @node CRIS Options
8065 @subsection CRIS Options
8066 @cindex CRIS Options
8068 These options are defined specifically for the CRIS ports.
8070 @table @gcctabopt
8071 @item -march=@var{architecture-type}
8072 @itemx -mcpu=@var{architecture-type}
8073 @opindex march
8074 @opindex mcpu
8075 Generate code for the specified architecture.  The choices for
8076 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8077 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
8078 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
8079 @samp{v10}.
8081 @item -mtune=@var{architecture-type}
8082 @opindex mtune
8083 Tune to @var{architecture-type} everything applicable about the generated
8084 code, except for the ABI and the set of available instructions.  The
8085 choices for @var{architecture-type} are the same as for
8086 @option{-march=@var{architecture-type}}.
8088 @item -mmax-stack-frame=@var{n}
8089 @opindex mmax-stack-frame
8090 Warn when the stack frame of a function exceeds @var{n} bytes.
8092 @item -melinux-stacksize=@var{n}
8093 @opindex melinux-stacksize
8094 Only available with the @samp{cris-axis-aout} target.  Arranges for
8095 indications in the program to the kernel loader that the stack of the
8096 program should be set to @var{n} bytes.
8098 @item -metrax4
8099 @itemx -metrax100
8100 @opindex metrax4
8101 @opindex metrax100
8102 The options @option{-metrax4} and @option{-metrax100} are synonyms for
8103 @option{-march=v3} and @option{-march=v8} respectively.
8105 @item -mmul-bug-workaround
8106 @itemx -mno-mul-bug-workaround
8107 @opindex mmul-bug-workaround
8108 @opindex mno-mul-bug-workaround
8109 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
8110 models where it applies.  This option is active by default.
8112 @item -mpdebug
8113 @opindex mpdebug
8114 Enable CRIS-specific verbose debug-related information in the assembly
8115 code.  This option also has the effect to turn off the @samp{#NO_APP}
8116 formatted-code indicator to the assembler at the beginning of the
8117 assembly file.
8119 @item -mcc-init
8120 @opindex mcc-init
8121 Do not use condition-code results from previous instruction; always emit
8122 compare and test instructions before use of condition codes.
8124 @item -mno-side-effects
8125 @opindex mno-side-effects
8126 Do not emit instructions with side-effects in addressing modes other than
8127 post-increment.
8129 @item -mstack-align
8130 @itemx -mno-stack-align
8131 @itemx -mdata-align
8132 @itemx -mno-data-align
8133 @itemx -mconst-align
8134 @itemx -mno-const-align
8135 @opindex mstack-align
8136 @opindex mno-stack-align
8137 @opindex mdata-align
8138 @opindex mno-data-align
8139 @opindex mconst-align
8140 @opindex mno-const-align
8141 These options (no-options) arranges (eliminate arrangements) for the
8142 stack-frame, individual data and constants to be aligned for the maximum
8143 single data access size for the chosen CPU model.  The default is to
8144 arrange for 32-bit alignment.  ABI details such as structure layout are
8145 not affected by these options.
8147 @item -m32-bit
8148 @itemx -m16-bit
8149 @itemx -m8-bit
8150 @opindex m32-bit
8151 @opindex m16-bit
8152 @opindex m8-bit
8153 Similar to the stack- data- and const-align options above, these options
8154 arrange for stack-frame, writable data and constants to all be 32-bit,
8155 16-bit or 8-bit aligned.  The default is 32-bit alignment.
8157 @item -mno-prologue-epilogue
8158 @itemx -mprologue-epilogue
8159 @opindex mno-prologue-epilogue
8160 @opindex mprologue-epilogue
8161 With @option{-mno-prologue-epilogue}, the normal function prologue and
8162 epilogue that sets up the stack-frame are omitted and no return
8163 instructions or return sequences are generated in the code.  Use this
8164 option only together with visual inspection of the compiled code: no
8165 warnings or errors are generated when call-saved registers must be saved,
8166 or storage for local variable needs to be allocated.
8168 @item -mno-gotplt
8169 @itemx -mgotplt
8170 @opindex mno-gotplt
8171 @opindex mgotplt
8172 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8173 instruction sequences that load addresses for functions from the PLT part
8174 of the GOT rather than (traditional on other architectures) calls to the
8175 PLT@.  The default is @option{-mgotplt}.
8177 @item -maout
8178 @opindex maout
8179 Legacy no-op option only recognized with the cris-axis-aout target.
8181 @item -melf
8182 @opindex melf
8183 Legacy no-op option only recognized with the cris-axis-elf and
8184 cris-axis-linux-gnu targets.
8186 @item -melinux
8187 @opindex melinux
8188 Only recognized with the cris-axis-aout target, where it selects a
8189 GNU/linux-like multilib, include files and instruction set for
8190 @option{-march=v8}.
8192 @item -mlinux
8193 @opindex mlinux
8194 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8196 @item -sim
8197 @opindex sim
8198 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8199 to link with input-output functions from a simulator library.  Code,
8200 initialized data and zero-initialized data are allocated consecutively.
8202 @item -sim2
8203 @opindex sim2
8204 Like @option{-sim}, but pass linker options to locate initialized data at
8205 0x40000000 and zero-initialized data at 0x80000000.
8206 @end table
8208 @node CRX Options
8209 @subsection CRX Options
8210 @cindex CRX Options
8212 These options are defined specifically for the CRX ports.
8214 @table @gcctabopt
8216 @item -mmac
8217 @opindex mmac
8218 Enable the use of multiply-accumulate instructions. Disabled by default.
8220 @item -mpush-args
8221 @opindex mpush-args
8222 Push instructions will be used to pass outgoing arguments when functions
8223 are called. Enabled by default.
8224 @end table
8226 @node Darwin Options
8227 @subsection Darwin Options
8228 @cindex Darwin options
8230 These options are defined for all architectures running the Darwin operating
8231 system.
8233 FSF GCC on Darwin does not create ``fat'' object files; it will create
8234 an object file for the single architecture that it was built to
8235 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8236 @option{-arch} options are used; it does so by running the compiler or
8237 linker multiple times and joining the results together with
8238 @file{lipo}.
8240 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8241 @samp{i686}) is determined by the flags that specify the ISA
8242 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8243 @option{-force_cpusubtype_ALL} option can be used to override this.
8245 The Darwin tools vary in their behavior when presented with an ISA
8246 mismatch.  The assembler, @file{as}, will only permit instructions to
8247 be used that are valid for the subtype of the file it is generating,
8248 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8249 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8250 and print an error if asked to create a shared library with a less
8251 restrictive subtype than its input files (for instance, trying to put
8252 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8253 for executables, @file{ld}, will quietly give the executable the most
8254 restrictive subtype of any of its input files.
8256 @table @gcctabopt
8257 @item -F@var{dir}
8258 @opindex F
8259 Add the framework directory @var{dir} to the head of the list of
8260 directories to be searched for header files.  These directories are
8261 interleaved with those specified by @option{-I} options and are
8262 scanned in a left-to-right order.
8264 A framework directory is a directory with frameworks in it.  A
8265 framework is a directory with a @samp{"Headers"} and/or
8266 @samp{"PrivateHeaders"} directory contained directly in it that ends
8267 in @samp{".framework"}.  The name of a framework is the name of this
8268 directory excluding the @samp{".framework"}.  Headers associated with
8269 the framework are found in one of those two directories, with
8270 @samp{"Headers"} being searched first.  A subframework is a framework
8271 directory that is in a framework's @samp{"Frameworks"} directory.
8272 Includes of subframework headers can only appear in a header of a
8273 framework that contains the subframework, or in a sibling subframework
8274 header.  Two subframeworks are siblings if they occur in the same
8275 framework.  A subframework should not have the same name as a
8276 framework, a warning will be issued if this is violated.  Currently a
8277 subframework cannot have subframeworks, in the future, the mechanism
8278 may be extended to support this.  The standard frameworks can be found
8279 in @samp{"/System/Library/Frameworks"} and
8280 @samp{"/Library/Frameworks"}.  An example include looks like
8281 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8282 the name of the framework and header.h is found in the
8283 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8285 @item -gused
8286 @opindex -gused
8287 Emit debugging information for symbols that are used.  For STABS
8288 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8289 This is by default ON@.
8291 @item -gfull
8292 @opindex -gfull
8293 Emit debugging information for all symbols and types.
8295 @item -mmacosx-version-min=@var{version}
8296 The earliest version of MacOS X that this executable will run on
8297 is @var{version}.  Typical values of @var{version} include @code{10.1},
8298 @code{10.2}, and @code{10.3.9}.
8300 The default for this option is to make choices that seem to be most
8301 useful.  
8303 @item -mkernel
8304 @opindex mkernel
8305 Enable kernel development mode.  The @option{-mkernel} option sets
8306 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8307 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8308 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8309 applicable.  This mode also sets @option{-mno-altivec},
8310 @option{-msoft-float}, @option{-fno-builtin} and
8311 @option{-mlong-branch} for PowerPC targets.
8313 @item -mone-byte-bool
8314 @opindex -mone-byte-bool
8315 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8316 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8317 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8318 option has no effect on x86.
8320 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8321 to generate code that is not binary compatible with code generated
8322 without that switch.  Using this switch may require recompiling all
8323 other modules in a program, including system libraries.  Use this
8324 switch to conform to a non-default data model.
8326 @item -mfix-and-continue
8327 @itemx -ffix-and-continue
8328 @itemx -findirect-data
8329 @opindex mfix-and-continue
8330 @opindex ffix-and-continue
8331 @opindex findirect-data
8332 Generate code suitable for fast turn around development.  Needed to
8333 enable gdb to dynamically load @code{.o} files into already running
8334 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8335 are provided for backwards compatibility.
8337 @item -all_load
8338 @opindex all_load
8339 Loads all members of static archive libraries.
8340 See man ld(1) for more information.
8342 @item -arch_errors_fatal
8343 @opindex arch_errors_fatal
8344 Cause the errors having to do with files that have the wrong architecture
8345 to be fatal.
8347 @item -bind_at_load
8348 @opindex bind_at_load
8349 Causes the output file to be marked such that the dynamic linker will
8350 bind all undefined references when the file is loaded or launched.
8352 @item -bundle
8353 @opindex bundle
8354 Produce a Mach-o bundle format file.
8355 See man ld(1) for more information.
8357 @item -bundle_loader @var{executable}
8358 @opindex bundle_loader
8359 This option specifies the @var{executable} that will be loading the build
8360 output file being linked.  See man ld(1) for more information.
8362 @item -dynamiclib
8363 @opindex -dynamiclib
8364 When passed this option, GCC will produce a dynamic library instead of
8365 an executable when linking, using the Darwin @file{libtool} command.
8367 @item -force_cpusubtype_ALL
8368 @opindex -force_cpusubtype_ALL
8369 This causes GCC's output file to have the @var{ALL} subtype, instead of
8370 one controlled by the @option{-mcpu} or @option{-march} option.
8372 @item -allowable_client  @var{client_name}
8373 @itemx -client_name
8374 @itemx -compatibility_version
8375 @itemx -current_version
8376 @itemx -dead_strip
8377 @itemx -dependency-file
8378 @itemx -dylib_file
8379 @itemx -dylinker_install_name
8380 @itemx -dynamic
8381 @itemx -exported_symbols_list
8382 @itemx -filelist
8383 @itemx -flat_namespace
8384 @itemx -force_flat_namespace
8385 @itemx -headerpad_max_install_names
8386 @itemx -image_base
8387 @itemx -init
8388 @itemx -install_name
8389 @itemx -keep_private_externs
8390 @itemx -multi_module
8391 @itemx -multiply_defined
8392 @itemx -multiply_defined_unused
8393 @itemx -noall_load
8394 @itemx -no_dead_strip_inits_and_terms
8395 @itemx -nofixprebinding
8396 @itemx -nomultidefs
8397 @itemx -noprebind
8398 @itemx -noseglinkedit
8399 @itemx -pagezero_size
8400 @itemx -prebind
8401 @itemx -prebind_all_twolevel_modules
8402 @itemx -private_bundle
8403 @itemx -read_only_relocs
8404 @itemx -sectalign
8405 @itemx -sectobjectsymbols
8406 @itemx -whyload
8407 @itemx -seg1addr
8408 @itemx -sectcreate
8409 @itemx -sectobjectsymbols
8410 @itemx -sectorder
8411 @itemx -segaddr
8412 @itemx -segs_read_only_addr
8413 @itemx -segs_read_write_addr
8414 @itemx -seg_addr_table
8415 @itemx -seg_addr_table_filename
8416 @itemx -seglinkedit
8417 @itemx -segprot
8418 @itemx -segs_read_only_addr
8419 @itemx -segs_read_write_addr
8420 @itemx -single_module
8421 @itemx -static
8422 @itemx -sub_library
8423 @itemx -sub_umbrella
8424 @itemx -twolevel_namespace
8425 @itemx -umbrella
8426 @itemx -undefined
8427 @itemx -unexported_symbols_list
8428 @itemx -weak_reference_mismatches
8429 @itemx -whatsloaded
8431 @opindex allowable_client
8432 @opindex client_name
8433 @opindex compatibility_version
8434 @opindex current_version
8435 @opindex dead_strip
8436 @opindex dependency-file
8437 @opindex dylib_file
8438 @opindex dylinker_install_name
8439 @opindex dynamic
8440 @opindex exported_symbols_list
8441 @opindex filelist
8442 @opindex flat_namespace
8443 @opindex force_flat_namespace
8444 @opindex headerpad_max_install_names
8445 @opindex image_base
8446 @opindex init
8447 @opindex install_name
8448 @opindex keep_private_externs
8449 @opindex multi_module
8450 @opindex multiply_defined
8451 @opindex multiply_defined_unused
8452 @opindex noall_load
8453 @opindex no_dead_strip_inits_and_terms
8454 @opindex nofixprebinding
8455 @opindex nomultidefs
8456 @opindex noprebind
8457 @opindex noseglinkedit
8458 @opindex pagezero_size
8459 @opindex prebind
8460 @opindex prebind_all_twolevel_modules
8461 @opindex private_bundle
8462 @opindex read_only_relocs
8463 @opindex sectalign
8464 @opindex sectobjectsymbols
8465 @opindex whyload
8466 @opindex seg1addr
8467 @opindex sectcreate
8468 @opindex sectobjectsymbols
8469 @opindex sectorder
8470 @opindex segaddr
8471 @opindex segs_read_only_addr
8472 @opindex segs_read_write_addr
8473 @opindex seg_addr_table
8474 @opindex seg_addr_table_filename
8475 @opindex seglinkedit
8476 @opindex segprot
8477 @opindex segs_read_only_addr
8478 @opindex segs_read_write_addr
8479 @opindex single_module
8480 @opindex static
8481 @opindex sub_library
8482 @opindex sub_umbrella
8483 @opindex twolevel_namespace
8484 @opindex umbrella
8485 @opindex undefined
8486 @opindex unexported_symbols_list
8487 @opindex weak_reference_mismatches
8488 @opindex whatsloaded
8490 These options are passed to the Darwin linker.  The Darwin linker man page
8491 describes them in detail.
8492 @end table
8494 @node DEC Alpha Options
8495 @subsection DEC Alpha Options
8497 These @samp{-m} options are defined for the DEC Alpha implementations:
8499 @table @gcctabopt
8500 @item -mno-soft-float
8501 @itemx -msoft-float
8502 @opindex mno-soft-float
8503 @opindex msoft-float
8504 Use (do not use) the hardware floating-point instructions for
8505 floating-point operations.  When @option{-msoft-float} is specified,
8506 functions in @file{libgcc.a} will be used to perform floating-point
8507 operations.  Unless they are replaced by routines that emulate the
8508 floating-point operations, or compiled in such a way as to call such
8509 emulations routines, these routines will issue floating-point
8510 operations.   If you are compiling for an Alpha without floating-point
8511 operations, you must ensure that the library is built so as not to call
8512 them.
8514 Note that Alpha implementations without floating-point operations are
8515 required to have floating-point registers.
8517 @item -mfp-reg
8518 @itemx -mno-fp-regs
8519 @opindex mfp-reg
8520 @opindex mno-fp-regs
8521 Generate code that uses (does not use) the floating-point register set.
8522 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8523 register set is not used, floating point operands are passed in integer
8524 registers as if they were integers and floating-point results are passed
8525 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8526 so any function with a floating-point argument or return value called by code
8527 compiled with @option{-mno-fp-regs} must also be compiled with that
8528 option.
8530 A typical use of this option is building a kernel that does not use,
8531 and hence need not save and restore, any floating-point registers.
8533 @item -mieee
8534 @opindex mieee
8535 The Alpha architecture implements floating-point hardware optimized for
8536 maximum performance.  It is mostly compliant with the IEEE floating
8537 point standard.  However, for full compliance, software assistance is
8538 required.  This option generates code fully IEEE compliant code
8539 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8540 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8541 defined during compilation.  The resulting code is less efficient but is
8542 able to correctly support denormalized numbers and exceptional IEEE
8543 values such as not-a-number and plus/minus infinity.  Other Alpha
8544 compilers call this option @option{-ieee_with_no_inexact}.
8546 @item -mieee-with-inexact
8547 @opindex mieee-with-inexact
8548 This is like @option{-mieee} except the generated code also maintains
8549 the IEEE @var{inexact-flag}.  Turning on this option causes the
8550 generated code to implement fully-compliant IEEE math.  In addition to
8551 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8552 macro.  On some Alpha implementations the resulting code may execute
8553 significantly slower than the code generated by default.  Since there is
8554 very little code that depends on the @var{inexact-flag}, you should
8555 normally not specify this option.  Other Alpha compilers call this
8556 option @option{-ieee_with_inexact}.
8558 @item -mfp-trap-mode=@var{trap-mode}
8559 @opindex mfp-trap-mode
8560 This option controls what floating-point related traps are enabled.
8561 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8562 The trap mode can be set to one of four values:
8564 @table @samp
8565 @item n
8566 This is the default (normal) setting.  The only traps that are enabled
8567 are the ones that cannot be disabled in software (e.g., division by zero
8568 trap).
8570 @item u
8571 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8572 as well.
8574 @item su
8575 Like @samp{u}, but the instructions are marked to be safe for software
8576 completion (see Alpha architecture manual for details).
8578 @item sui
8579 Like @samp{su}, but inexact traps are enabled as well.
8580 @end table
8582 @item -mfp-rounding-mode=@var{rounding-mode}
8583 @opindex mfp-rounding-mode
8584 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8585 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8588 @table @samp
8589 @item n
8590 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8591 the nearest machine number or towards the even machine number in case
8592 of a tie.
8594 @item m
8595 Round towards minus infinity.
8597 @item c
8598 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8600 @item d
8601 Dynamic rounding mode.  A field in the floating point control register
8602 (@var{fpcr}, see Alpha architecture reference manual) controls the
8603 rounding mode in effect.  The C library initializes this register for
8604 rounding towards plus infinity.  Thus, unless your program modifies the
8605 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8606 @end table
8608 @item -mtrap-precision=@var{trap-precision}
8609 @opindex mtrap-precision
8610 In the Alpha architecture, floating point traps are imprecise.  This
8611 means without software assistance it is impossible to recover from a
8612 floating trap and program execution normally needs to be terminated.
8613 GCC can generate code that can assist operating system trap handlers
8614 in determining the exact location that caused a floating point trap.
8615 Depending on the requirements of an application, different levels of
8616 precisions can be selected:
8618 @table @samp
8619 @item p
8620 Program precision.  This option is the default and means a trap handler
8621 can only identify which program caused a floating point exception.
8623 @item f
8624 Function precision.  The trap handler can determine the function that
8625 caused a floating point exception.
8627 @item i
8628 Instruction precision.  The trap handler can determine the exact
8629 instruction that caused a floating point exception.
8630 @end table
8632 Other Alpha compilers provide the equivalent options called
8633 @option{-scope_safe} and @option{-resumption_safe}.
8635 @item -mieee-conformant
8636 @opindex mieee-conformant
8637 This option marks the generated code as IEEE conformant.  You must not
8638 use this option unless you also specify @option{-mtrap-precision=i} and either
8639 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8640 is to emit the line @samp{.eflag 48} in the function prologue of the
8641 generated assembly file.  Under DEC Unix, this has the effect that
8642 IEEE-conformant math library routines will be linked in.
8644 @item -mbuild-constants
8645 @opindex mbuild-constants
8646 Normally GCC examines a 32- or 64-bit integer constant to
8647 see if it can construct it from smaller constants in two or three
8648 instructions.  If it cannot, it will output the constant as a literal and
8649 generate code to load it from the data segment at runtime.
8651 Use this option to require GCC to construct @emph{all} integer constants
8652 using code, even if it takes more instructions (the maximum is six).
8654 You would typically use this option to build a shared library dynamic
8655 loader.  Itself a shared library, it must relocate itself in memory
8656 before it can find the variables and constants in its own data segment.
8658 @item -malpha-as
8659 @itemx -mgas
8660 @opindex malpha-as
8661 @opindex mgas
8662 Select whether to generate code to be assembled by the vendor-supplied
8663 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8665 @item -mbwx
8666 @itemx -mno-bwx
8667 @itemx -mcix
8668 @itemx -mno-cix
8669 @itemx -mfix
8670 @itemx -mno-fix
8671 @itemx -mmax
8672 @itemx -mno-max
8673 @opindex mbwx
8674 @opindex mno-bwx
8675 @opindex mcix
8676 @opindex mno-cix
8677 @opindex mfix
8678 @opindex mno-fix
8679 @opindex mmax
8680 @opindex mno-max
8681 Indicate whether GCC should generate code to use the optional BWX,
8682 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8683 sets supported by the CPU type specified via @option{-mcpu=} option or that
8684 of the CPU on which GCC was built if none was specified.
8686 @item -mfloat-vax
8687 @itemx -mfloat-ieee
8688 @opindex mfloat-vax
8689 @opindex mfloat-ieee
8690 Generate code that uses (does not use) VAX F and G floating point
8691 arithmetic instead of IEEE single and double precision.
8693 @item -mexplicit-relocs
8694 @itemx -mno-explicit-relocs
8695 @opindex mexplicit-relocs
8696 @opindex mno-explicit-relocs
8697 Older Alpha assemblers provided no way to generate symbol relocations
8698 except via assembler macros.  Use of these macros does not allow
8699 optimal instruction scheduling.  GNU binutils as of version 2.12
8700 supports a new syntax that allows the compiler to explicitly mark
8701 which relocations should apply to which instructions.  This option
8702 is mostly useful for debugging, as GCC detects the capabilities of
8703 the assembler when it is built and sets the default accordingly.
8705 @item -msmall-data
8706 @itemx -mlarge-data
8707 @opindex msmall-data
8708 @opindex mlarge-data
8709 When @option{-mexplicit-relocs} is in effect, static data is
8710 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8711 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8712 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8713 16-bit relocations off of the @code{$gp} register.  This limits the
8714 size of the small data area to 64KB, but allows the variables to be
8715 directly accessed via a single instruction.
8717 The default is @option{-mlarge-data}.  With this option the data area
8718 is limited to just below 2GB@.  Programs that require more than 2GB of
8719 data must use @code{malloc} or @code{mmap} to allocate the data in the
8720 heap instead of in the program's data segment.
8722 When generating code for shared libraries, @option{-fpic} implies
8723 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8725 @item -msmall-text
8726 @itemx -mlarge-text
8727 @opindex msmall-text
8728 @opindex mlarge-text
8729 When @option{-msmall-text} is used, the compiler assumes that the
8730 code of the entire program (or shared library) fits in 4MB, and is
8731 thus reachable with a branch instruction.  When @option{-msmall-data}
8732 is used, the compiler can assume that all local symbols share the
8733 same @code{$gp} value, and thus reduce the number of instructions
8734 required for a function call from 4 to 1.
8736 The default is @option{-mlarge-text}.
8738 @item -mcpu=@var{cpu_type}
8739 @opindex mcpu
8740 Set the instruction set and instruction scheduling parameters for
8741 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8742 style name or the corresponding chip number.  GCC supports scheduling
8743 parameters for the EV4, EV5 and EV6 family of processors and will
8744 choose the default values for the instruction set from the processor
8745 you specify.  If you do not specify a processor type, GCC will default
8746 to the processor on which the compiler was built.
8748 Supported values for @var{cpu_type} are
8750 @table @samp
8751 @item ev4
8752 @itemx ev45
8753 @itemx 21064
8754 Schedules as an EV4 and has no instruction set extensions.
8756 @item ev5
8757 @itemx 21164
8758 Schedules as an EV5 and has no instruction set extensions.
8760 @item ev56
8761 @itemx 21164a
8762 Schedules as an EV5 and supports the BWX extension.
8764 @item pca56
8765 @itemx 21164pc
8766 @itemx 21164PC
8767 Schedules as an EV5 and supports the BWX and MAX extensions.
8769 @item ev6
8770 @itemx 21264
8771 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8773 @item ev67
8774 @itemx 21264a
8775 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8776 @end table
8778 @item -mtune=@var{cpu_type}
8779 @opindex mtune
8780 Set only the instruction scheduling parameters for machine type
8781 @var{cpu_type}.  The instruction set is not changed.
8783 @item -mmemory-latency=@var{time}
8784 @opindex mmemory-latency
8785 Sets the latency the scheduler should assume for typical memory
8786 references as seen by the application.  This number is highly
8787 dependent on the memory access patterns used by the application
8788 and the size of the external cache on the machine.
8790 Valid options for @var{time} are
8792 @table @samp
8793 @item @var{number}
8794 A decimal number representing clock cycles.
8796 @item L1
8797 @itemx L2
8798 @itemx L3
8799 @itemx main
8800 The compiler contains estimates of the number of clock cycles for
8801 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8802 (also called Dcache, Scache, and Bcache), as well as to main memory.
8803 Note that L3 is only valid for EV5.
8805 @end table
8806 @end table
8808 @node DEC Alpha/VMS Options
8809 @subsection DEC Alpha/VMS Options
8811 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8813 @table @gcctabopt
8814 @item -mvms-return-codes
8815 @opindex mvms-return-codes
8816 Return VMS condition codes from main.  The default is to return POSIX
8817 style condition (e.g.@ error) codes.
8818 @end table
8820 @node FRV Options
8821 @subsection FRV Options
8822 @cindex FRV Options
8824 @table @gcctabopt
8825 @item -mgpr-32
8826 @opindex mgpr-32
8828 Only use the first 32 general purpose registers.
8830 @item -mgpr-64
8831 @opindex mgpr-64
8833 Use all 64 general purpose registers.
8835 @item -mfpr-32
8836 @opindex mfpr-32
8838 Use only the first 32 floating point registers.
8840 @item -mfpr-64
8841 @opindex mfpr-64
8843 Use all 64 floating point registers
8845 @item -mhard-float
8846 @opindex mhard-float
8848 Use hardware instructions for floating point operations.
8850 @item -msoft-float
8851 @opindex msoft-float
8853 Use library routines for floating point operations.
8855 @item -malloc-cc
8856 @opindex malloc-cc
8858 Dynamically allocate condition code registers.
8860 @item -mfixed-cc
8861 @opindex mfixed-cc
8863 Do not try to dynamically allocate condition code registers, only
8864 use @code{icc0} and @code{fcc0}.
8866 @item -mdword
8867 @opindex mdword
8869 Change ABI to use double word insns.
8871 @item -mno-dword
8872 @opindex mno-dword
8874 Do not use double word instructions.
8876 @item -mdouble
8877 @opindex mdouble
8879 Use floating point double instructions.
8881 @item -mno-double
8882 @opindex mno-double
8884 Do not use floating point double instructions.
8886 @item -mmedia
8887 @opindex mmedia
8889 Use media instructions.
8891 @item -mno-media
8892 @opindex mno-media
8894 Do not use media instructions.
8896 @item -mmuladd
8897 @opindex mmuladd
8899 Use multiply and add/subtract instructions.
8901 @item -mno-muladd
8902 @opindex mno-muladd
8904 Do not use multiply and add/subtract instructions.
8906 @item -mfdpic
8907 @opindex mfdpic
8909 Select the FDPIC ABI, that uses function descriptors to represent
8910 pointers to functions.  Without any PIC/PIE-related options, it
8911 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8912 assumes GOT entries and small data are within a 12-bit range from the
8913 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8914 are computed with 32 bits.
8916 @item -minline-plt
8917 @opindex minline-plt
8919 Enable inlining of PLT entries in function calls to functions that are
8920 not known to bind locally.  It has no effect without @option{-mfdpic}.
8921 It's enabled by default if optimizing for speed and compiling for
8922 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8923 optimization option such as @option{-O3} or above is present in the
8924 command line.
8926 @item -mTLS
8927 @opindex TLS
8929 Assume a large TLS segment when generating thread-local code.
8931 @item -mtls
8932 @opindex tls
8934 Do not assume a large TLS segment when generating thread-local code.
8936 @item -mgprel-ro
8937 @opindex mgprel-ro
8939 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8940 that is known to be in read-only sections.  It's enabled by default,
8941 except for @option{-fpic} or @option{-fpie}: even though it may help
8942 make the global offset table smaller, it trades 1 instruction for 4.
8943 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8944 one of which may be shared by multiple symbols, and it avoids the need
8945 for a GOT entry for the referenced symbol, so it's more likely to be a
8946 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8948 @item -multilib-library-pic
8949 @opindex multilib-library-pic
8951 Link with the (library, not FD) pic libraries.  It's implied by
8952 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8953 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8954 it explicitly.
8956 @item -mlinked-fp
8957 @opindex mlinked-fp
8959 Follow the EABI requirement of always creating a frame pointer whenever
8960 a stack frame is allocated.  This option is enabled by default and can
8961 be disabled with @option{-mno-linked-fp}.
8963 @item -mlong-calls
8964 @opindex mlong-calls
8966 Use indirect addressing to call functions outside the current
8967 compilation unit.  This allows the functions to be placed anywhere
8968 within the 32-bit address space.
8970 @item -malign-labels
8971 @opindex malign-labels
8973 Try to align labels to an 8-byte boundary by inserting nops into the
8974 previous packet.  This option only has an effect when VLIW packing
8975 is enabled.  It doesn't create new packets; it merely adds nops to
8976 existing ones.
8978 @item -mlibrary-pic
8979 @opindex mlibrary-pic
8981 Generate position-independent EABI code.
8983 @item -macc-4
8984 @opindex macc-4
8986 Use only the first four media accumulator registers.
8988 @item -macc-8
8989 @opindex macc-8
8991 Use all eight media accumulator registers.
8993 @item -mpack
8994 @opindex mpack
8996 Pack VLIW instructions.
8998 @item -mno-pack
8999 @opindex mno-pack
9001 Do not pack VLIW instructions.
9003 @item -mno-eflags
9004 @opindex mno-eflags
9006 Do not mark ABI switches in e_flags.
9008 @item -mcond-move
9009 @opindex mcond-move
9011 Enable the use of conditional-move instructions (default).
9013 This switch is mainly for debugging the compiler and will likely be removed
9014 in a future version.
9016 @item -mno-cond-move
9017 @opindex mno-cond-move
9019 Disable the use of conditional-move instructions.
9021 This switch is mainly for debugging the compiler and will likely be removed
9022 in a future version.
9024 @item -mscc
9025 @opindex mscc
9027 Enable the use of conditional set instructions (default).
9029 This switch is mainly for debugging the compiler and will likely be removed
9030 in a future version.
9032 @item -mno-scc
9033 @opindex mno-scc
9035 Disable the use of conditional set instructions.
9037 This switch is mainly for debugging the compiler and will likely be removed
9038 in a future version.
9040 @item -mcond-exec
9041 @opindex mcond-exec
9043 Enable the use of conditional execution (default).
9045 This switch is mainly for debugging the compiler and will likely be removed
9046 in a future version.
9048 @item -mno-cond-exec
9049 @opindex mno-cond-exec
9051 Disable the use of conditional execution.
9053 This switch is mainly for debugging the compiler and will likely be removed
9054 in a future version.
9056 @item -mvliw-branch
9057 @opindex mvliw-branch
9059 Run a pass to pack branches into VLIW instructions (default).
9061 This switch is mainly for debugging the compiler and will likely be removed
9062 in a future version.
9064 @item -mno-vliw-branch
9065 @opindex mno-vliw-branch
9067 Do not run a pass to pack branches into VLIW instructions.
9069 This switch is mainly for debugging the compiler and will likely be removed
9070 in a future version.
9072 @item -mmulti-cond-exec
9073 @opindex mmulti-cond-exec
9075 Enable optimization of @code{&&} and @code{||} in conditional execution
9076 (default).
9078 This switch is mainly for debugging the compiler and will likely be removed
9079 in a future version.
9081 @item -mno-multi-cond-exec
9082 @opindex mno-multi-cond-exec
9084 Disable optimization of @code{&&} and @code{||} in conditional execution.
9086 This switch is mainly for debugging the compiler and will likely be removed
9087 in a future version.
9089 @item -mnested-cond-exec
9090 @opindex mnested-cond-exec
9092 Enable nested conditional execution optimizations (default).
9094 This switch is mainly for debugging the compiler and will likely be removed
9095 in a future version.
9097 @item -mno-nested-cond-exec
9098 @opindex mno-nested-cond-exec
9100 Disable nested conditional execution optimizations.
9102 This switch is mainly for debugging the compiler and will likely be removed
9103 in a future version.
9105 @item -moptimize-membar
9106 @opindex moptimize-membar
9108 This switch removes redundant @code{membar} instructions from the
9109 compiler generated code.  It is enabled by default.
9111 @item -mno-optimize-membar
9112 @opindex mno-optimize-membar
9114 This switch disables the automatic removal of redundant @code{membar}
9115 instructions from the generated code.
9117 @item -mtomcat-stats
9118 @opindex mtomcat-stats
9120 Cause gas to print out tomcat statistics.
9122 @item -mcpu=@var{cpu}
9123 @opindex mcpu
9125 Select the processor type for which to generate code.  Possible values are
9126 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9127 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9129 @end table
9131 @node GNU/Linux Options
9132 @subsection GNU/Linux Options
9134 These @samp{-m} options are defined for GNU/Linux targets:
9136 @table @gcctabopt
9137 @item -mglibc
9138 @opindex mglibc
9139 Use the GNU C library instead of uClibc.  This is the default except
9140 on @samp{*-*-linux-*uclibc*} targets.
9142 @item -muclibc
9143 @opindex muclibc
9144 Use uClibc instead of the GNU C library.  This is the default on
9145 @samp{*-*-linux-*uclibc*} targets.
9146 @end table
9148 @node H8/300 Options
9149 @subsection H8/300 Options
9151 These @samp{-m} options are defined for the H8/300 implementations:
9153 @table @gcctabopt
9154 @item -mrelax
9155 @opindex mrelax
9156 Shorten some address references at link time, when possible; uses the
9157 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9158 ld, Using ld}, for a fuller description.
9160 @item -mh
9161 @opindex mh
9162 Generate code for the H8/300H@.
9164 @item -ms
9165 @opindex ms
9166 Generate code for the H8S@.
9168 @item -mn
9169 @opindex mn
9170 Generate code for the H8S and H8/300H in the normal mode.  This switch
9171 must be used either with @option{-mh} or @option{-ms}.
9173 @item -ms2600
9174 @opindex ms2600
9175 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9177 @item -mint32
9178 @opindex mint32
9179 Make @code{int} data 32 bits by default.
9181 @item -malign-300
9182 @opindex malign-300
9183 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9184 The default for the H8/300H and H8S is to align longs and floats on 4
9185 byte boundaries.
9186 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9187 This option has no effect on the H8/300.
9188 @end table
9190 @node HPPA Options
9191 @subsection HPPA Options
9192 @cindex HPPA Options
9194 These @samp{-m} options are defined for the HPPA family of computers:
9196 @table @gcctabopt
9197 @item -march=@var{architecture-type}
9198 @opindex march
9199 Generate code for the specified architecture.  The choices for
9200 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9201 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9202 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9203 architecture option for your machine.  Code compiled for lower numbered
9204 architectures will run on higher numbered architectures, but not the
9205 other way around.
9207 @item -mpa-risc-1-0
9208 @itemx -mpa-risc-1-1
9209 @itemx -mpa-risc-2-0
9210 @opindex mpa-risc-1-0
9211 @opindex mpa-risc-1-1
9212 @opindex mpa-risc-2-0
9213 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9215 @item -mbig-switch
9216 @opindex mbig-switch
9217 Generate code suitable for big switch tables.  Use this option only if
9218 the assembler/linker complain about out of range branches within a switch
9219 table.
9221 @item -mjump-in-delay
9222 @opindex mjump-in-delay
9223 Fill delay slots of function calls with unconditional jump instructions
9224 by modifying the return pointer for the function call to be the target
9225 of the conditional jump.
9227 @item -mdisable-fpregs
9228 @opindex mdisable-fpregs
9229 Prevent floating point registers from being used in any manner.  This is
9230 necessary for compiling kernels which perform lazy context switching of
9231 floating point registers.  If you use this option and attempt to perform
9232 floating point operations, the compiler will abort.
9234 @item -mdisable-indexing
9235 @opindex mdisable-indexing
9236 Prevent the compiler from using indexing address modes.  This avoids some
9237 rather obscure problems when compiling MIG generated code under MACH@.
9239 @item -mno-space-regs
9240 @opindex mno-space-regs
9241 Generate code that assumes the target has no space registers.  This allows
9242 GCC to generate faster indirect calls and use unscaled index address modes.
9244 Such code is suitable for level 0 PA systems and kernels.
9246 @item -mfast-indirect-calls
9247 @opindex mfast-indirect-calls
9248 Generate code that assumes calls never cross space boundaries.  This
9249 allows GCC to emit code which performs faster indirect calls.
9251 This option will not work in the presence of shared libraries or nested
9252 functions.
9254 @item -mfixed-range=@var{register-range}
9255 @opindex mfixed-range
9256 Generate code treating the given register range as fixed registers.
9257 A fixed register is one that the register allocator can not use.  This is
9258 useful when compiling kernel code.  A register range is specified as
9259 two registers separated by a dash.  Multiple register ranges can be
9260 specified separated by a comma.
9262 @item -mlong-load-store
9263 @opindex mlong-load-store
9264 Generate 3-instruction load and store sequences as sometimes required by
9265 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9266 the HP compilers.
9268 @item -mportable-runtime
9269 @opindex mportable-runtime
9270 Use the portable calling conventions proposed by HP for ELF systems.
9272 @item -mgas
9273 @opindex mgas
9274 Enable the use of assembler directives only GAS understands.
9276 @item -mschedule=@var{cpu-type}
9277 @opindex mschedule
9278 Schedule code according to the constraints for the machine type
9279 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9280 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9281 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9282 proper scheduling option for your machine.  The default scheduling is
9283 @samp{8000}.
9285 @item -mlinker-opt
9286 @opindex mlinker-opt
9287 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9288 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9289 linkers in which they give bogus error messages when linking some programs.
9291 @item -msoft-float
9292 @opindex msoft-float
9293 Generate output containing library calls for floating point.
9294 @strong{Warning:} the requisite libraries are not available for all HPPA
9295 targets.  Normally the facilities of the machine's usual C compiler are
9296 used, but this cannot be done directly in cross-compilation.  You must make
9297 your own arrangements to provide suitable library functions for
9298 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9299 does provide software floating point support.
9301 @option{-msoft-float} changes the calling convention in the output file;
9302 therefore, it is only useful if you compile @emph{all} of a program with
9303 this option.  In particular, you need to compile @file{libgcc.a}, the
9304 library that comes with GCC, with @option{-msoft-float} in order for
9305 this to work.
9307 @item -msio
9308 @opindex msio
9309 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9310 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9311 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9312 options are available under HP-UX and HI-UX@.
9314 @item -mgnu-ld
9315 @opindex gnu-ld
9316 Use GNU ld specific options.  This passes @option{-shared} to ld when
9317 building a shared library.  It is the default when GCC is configured,
9318 explicitly or implicitly, with the GNU linker.  This option does not
9319 have any affect on which ld is called, it only changes what parameters
9320 are passed to that ld.  The ld that is called is determined by the
9321 @option{--with-ld} configure option, GCC's program search path, and
9322 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9323 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9324 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9326 @item -mhp-ld
9327 @opindex hp-ld
9328 Use HP ld specific options.  This passes @option{-b} to ld when building
9329 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9330 links.  It is the default when GCC is configured, explicitly or
9331 implicitly, with the HP linker.  This option does not have any affect on
9332 which ld is called, it only changes what parameters are passed to that
9333 ld.  The ld that is called is determined by the @option{--with-ld}
9334 configure option, GCC's program search path, and finally by the user's
9335 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9336 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9337 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9339 @item -mlong-calls
9340 @opindex mno-long-calls
9341 Generate code that uses long call sequences.  This ensures that a call
9342 is always able to reach linker generated stubs.  The default is to generate
9343 long calls only when the distance from the call site to the beginning
9344 of the function or translation unit, as the case may be, exceeds a
9345 predefined limit set by the branch type being used.  The limits for
9346 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9347 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9348 240,000 bytes.
9350 Distances are measured from the beginning of functions when using the
9351 @option{-ffunction-sections} option, or when using the @option{-mgas}
9352 and @option{-mno-portable-runtime} options together under HP-UX with
9353 the SOM linker.
9355 It is normally not desirable to use this option as it will degrade
9356 performance.  However, it may be useful in large applications,
9357 particularly when partial linking is used to build the application.
9359 The types of long calls used depends on the capabilities of the
9360 assembler and linker, and the type of code being generated.  The
9361 impact on systems that support long absolute calls, and long pic
9362 symbol-difference or pc-relative calls should be relatively small.
9363 However, an indirect call is used on 32-bit ELF systems in pic code
9364 and it is quite long.
9366 @item -munix=@var{unix-std}
9367 @opindex march
9368 Generate compiler predefines and select a startfile for the specified
9369 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9370 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9371 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9372 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9373 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9374 and later.
9376 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9377 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9378 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9379 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9380 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9381 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9383 It is @emph{important} to note that this option changes the interfaces
9384 for various library routines.  It also affects the operational behavior
9385 of the C library.  Thus, @emph{extreme} care is needed in using this
9386 option.
9388 Library code that is intended to operate with more than one UNIX
9389 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9390 as appropriate.  Most GNU software doesn't provide this capability.
9392 @item -nolibdld
9393 @opindex nolibdld
9394 Suppress the generation of link options to search libdld.sl when the
9395 @option{-static} option is specified on HP-UX 10 and later.
9397 @item -static
9398 @opindex static
9399 The HP-UX implementation of setlocale in libc has a dependency on
9400 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9401 when the @option{-static} option is specified, special link options
9402 are needed to resolve this dependency.
9404 On HP-UX 10 and later, the GCC driver adds the necessary options to
9405 link with libdld.sl when the @option{-static} option is specified.
9406 This causes the resulting binary to be dynamic.  On the 64-bit port,
9407 the linkers generate dynamic binaries by default in any case.  The
9408 @option{-nolibdld} option can be used to prevent the GCC driver from
9409 adding these link options.
9411 @item -threads
9412 @opindex threads
9413 Add support for multithreading with the @dfn{dce thread} library
9414 under HP-UX@.  This option sets flags for both the preprocessor and
9415 linker.
9416 @end table
9418 @node i386 and x86-64 Options
9419 @subsection Intel 386 and AMD x86-64 Options
9420 @cindex i386 Options
9421 @cindex x86-64 Options
9422 @cindex Intel 386 Options
9423 @cindex AMD x86-64 Options
9425 These @samp{-m} options are defined for the i386 and x86-64 family of
9426 computers:
9428 @table @gcctabopt
9429 @item -mtune=@var{cpu-type}
9430 @opindex mtune
9431 Tune to @var{cpu-type} everything applicable about the generated code, except
9432 for the ABI and the set of available instructions.  The choices for
9433 @var{cpu-type} are:
9434 @table @emph
9435 @item generic
9436 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9437 If you know the CPU on which your code will run, then you should use
9438 the corresponding @option{-mtune} option instead of
9439 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9440 of your application will have, then you should use this option.
9442 As new processors are deployed in the marketplace, the behavior of this
9443 option will change.  Therefore, if you upgrade to a newer version of
9444 GCC, the code generated option will change to reflect the processors
9445 that were most common when that version of GCC was released.
9447 There is no @option{-march=generic} option because @option{-march}
9448 indicates the instruction set the compiler can use, and there is no
9449 generic instruction set applicable to all processors.  In contrast,
9450 @option{-mtune} indicates the processor (or, in this case, collection of
9451 processors) for which the code is optimized.
9452 @item native
9453 This selects the CPU to tune for at compilation time by determining
9454 the processor type of the compiling machine.  Using @option{-mtune=native}
9455 will produce code optimized for the local machine under the constraints
9456 of the selected instruction set.  Using @option{-march=native} will
9457 enable all instruction subsets supported by the local machine (hence
9458 the result might not run on different machines).
9459 @item i386
9460 Original Intel's i386 CPU@.
9461 @item i486
9462 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9463 @item i586, pentium
9464 Intel Pentium CPU with no MMX support.
9465 @item pentium-mmx
9466 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9467 @item pentiumpro
9468 Intel PentiumPro CPU@.
9469 @item i686
9470 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9471 instruction set will be used, so the code will run on all i686 family chips.
9472 @item pentium2
9473 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9474 @item pentium3, pentium3m
9475 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9476 support.
9477 @item pentium-m
9478 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9479 support.  Used by Centrino notebooks.
9480 @item pentium4, pentium4m
9481 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9482 @item prescott
9483 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9484 set support.
9485 @item nocona
9486 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9487 SSE2 and SSE3 instruction set support.
9488 @item core2
9489 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
9490 instruction set support.
9491 @item k6
9492 AMD K6 CPU with MMX instruction set support.
9493 @item k6-2, k6-3
9494 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9495 @item athlon, athlon-tbird
9496 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9497 support.
9498 @item athlon-4, athlon-xp, athlon-mp
9499 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9500 instruction set support.
9501 @item k8, opteron, athlon64, athlon-fx
9502 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9503 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9504 @item winchip-c6
9505 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9506 set support.
9507 @item winchip2
9508 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9509 instruction set support.
9510 @item c3
9511 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9512 implemented for this chip.)
9513 @item c3-2
9514 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9515 implemented for this chip.)
9516 @item geode
9517 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
9518 @end table
9520 While picking a specific @var{cpu-type} will schedule things appropriately
9521 for that particular chip, the compiler will not generate any code that
9522 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9523 being used.
9525 @item -march=@var{cpu-type}
9526 @opindex march
9527 Generate instructions for the machine type @var{cpu-type}.  The choices
9528 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9529 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9531 @item -mcpu=@var{cpu-type}
9532 @opindex mcpu
9533 A deprecated synonym for @option{-mtune}.
9535 @item -m386
9536 @itemx -m486
9537 @itemx -mpentium
9538 @itemx -mpentiumpro
9539 @opindex m386
9540 @opindex m486
9541 @opindex mpentium
9542 @opindex mpentiumpro
9543 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9544 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9545 These synonyms are deprecated.
9547 @item -mfpmath=@var{unit}
9548 @opindex march
9549 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9550 for @var{unit} are:
9552 @table @samp
9553 @item 387
9554 Use the standard 387 floating point coprocessor present majority of chips and
9555 emulated otherwise.  Code compiled with this option will run almost everywhere.
9556 The temporary results are computed in 80bit precision instead of precision
9557 specified by the type resulting in slightly different results compared to most
9558 of other chips.  See @option{-ffloat-store} for more detailed description.
9560 This is the default choice for i386 compiler.
9562 @item sse
9563 Use scalar floating point instructions present in the SSE instruction set.
9564 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9565 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9566 instruction set supports only single precision arithmetics, thus the double and
9567 extended precision arithmetics is still done using 387.  Later version, present
9568 only in Pentium4 and the future AMD x86-64 chips supports double precision
9569 arithmetics too.
9571 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9572 or @option{-msse2} switches to enable SSE extensions and make this option
9573 effective.  For the x86-64 compiler, these extensions are enabled by default.
9575 The resulting code should be considerably faster in the majority of cases and avoid
9576 the numerical instability problems of 387 code, but may break some existing
9577 code that expects temporaries to be 80bit.
9579 This is the default choice for the x86-64 compiler.
9581 @item sse,387
9582 Attempt to utilize both instruction sets at once.  This effectively double the
9583 amount of available registers and on chips with separate execution units for
9584 387 and SSE the execution resources too.  Use this option with care, as it is
9585 still experimental, because the GCC register allocator does not model separate
9586 functional units well resulting in instable performance.
9587 @end table
9589 @item -masm=@var{dialect}
9590 @opindex masm=@var{dialect}
9591 Output asm instructions using selected @var{dialect}.  Supported
9592 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9593 not support @samp{intel}.
9595 @item -mieee-fp
9596 @itemx -mno-ieee-fp
9597 @opindex mieee-fp
9598 @opindex mno-ieee-fp
9599 Control whether or not the compiler uses IEEE floating point
9600 comparisons.  These handle correctly the case where the result of a
9601 comparison is unordered.
9603 @item -msoft-float
9604 @opindex msoft-float
9605 Generate output containing library calls for floating point.
9606 @strong{Warning:} the requisite libraries are not part of GCC@.
9607 Normally the facilities of the machine's usual C compiler are used, but
9608 this can't be done directly in cross-compilation.  You must make your
9609 own arrangements to provide suitable library functions for
9610 cross-compilation.
9612 On machines where a function returns floating point results in the 80387
9613 register stack, some floating point opcodes may be emitted even if
9614 @option{-msoft-float} is used.
9616 @item -mno-fp-ret-in-387
9617 @opindex mno-fp-ret-in-387
9618 Do not use the FPU registers for return values of functions.
9620 The usual calling convention has functions return values of types
9621 @code{float} and @code{double} in an FPU register, even if there
9622 is no FPU@.  The idea is that the operating system should emulate
9623 an FPU@.
9625 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9626 in ordinary CPU registers instead.
9628 @item -mno-fancy-math-387
9629 @opindex mno-fancy-math-387
9630 Some 387 emulators do not support the @code{sin}, @code{cos} and
9631 @code{sqrt} instructions for the 387.  Specify this option to avoid
9632 generating those instructions.  This option is the default on FreeBSD,
9633 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9634 indicates that the target cpu will always have an FPU and so the
9635 instruction will not need emulation.  As of revision 2.6.1, these
9636 instructions are not generated unless you also use the
9637 @option{-funsafe-math-optimizations} switch.
9639 @item -malign-double
9640 @itemx -mno-align-double
9641 @opindex malign-double
9642 @opindex mno-align-double
9643 Control whether GCC aligns @code{double}, @code{long double}, and
9644 @code{long long} variables on a two word boundary or a one word
9645 boundary.  Aligning @code{double} variables on a two word boundary will
9646 produce code that runs somewhat faster on a @samp{Pentium} at the
9647 expense of more memory.
9649 On x86-64, @option{-malign-double} is enabled by default.
9651 @strong{Warning:} if you use the @option{-malign-double} switch,
9652 structures containing the above types will be aligned differently than
9653 the published application binary interface specifications for the 386
9654 and will not be binary compatible with structures in code compiled
9655 without that switch.
9657 @item -m96bit-long-double
9658 @itemx -m128bit-long-double
9659 @opindex m96bit-long-double
9660 @opindex m128bit-long-double
9661 These switches control the size of @code{long double} type.  The i386
9662 application binary interface specifies the size to be 96 bits,
9663 so @option{-m96bit-long-double} is the default in 32 bit mode.
9665 Modern architectures (Pentium and newer) would prefer @code{long double}
9666 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9667 conforming to the ABI, this would not be possible.  So specifying a
9668 @option{-m128bit-long-double} will align @code{long double}
9669 to a 16 byte boundary by padding the @code{long double} with an additional
9670 32 bit zero.
9672 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9673 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9675 Notice that neither of these options enable any extra precision over the x87
9676 standard of 80 bits for a @code{long double}.
9678 @strong{Warning:} if you override the default value for your target ABI, the
9679 structures and arrays containing @code{long double} variables will change
9680 their size as well as function calling convention for function taking
9681 @code{long double} will be modified.  Hence they will not be binary
9682 compatible with arrays or structures in code compiled without that switch.
9684 @item -mmlarge-data-threshold=@var{number}
9685 @opindex mlarge-data-threshold=@var{number}
9686 When @option{-mcmodel=medium} is specified, the data greater than
9687 @var{threshold} are placed in large data section.  This value must be the
9688 same across all object linked into the binary and defaults to 65535.
9690 @item -msvr3-shlib
9691 @itemx -mno-svr3-shlib
9692 @opindex msvr3-shlib
9693 @opindex mno-svr3-shlib
9694 Control whether GCC places uninitialized local variables into the
9695 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9696 into @code{bss}.  These options are meaningful only on System V Release 3.
9698 @item -mrtd
9699 @opindex mrtd
9700 Use a different function-calling convention, in which functions that
9701 take a fixed number of arguments return with the @code{ret} @var{num}
9702 instruction, which pops their arguments while returning.  This saves one
9703 instruction in the caller since there is no need to pop the arguments
9704 there.
9706 You can specify that an individual function is called with this calling
9707 sequence with the function attribute @samp{stdcall}.  You can also
9708 override the @option{-mrtd} option by using the function attribute
9709 @samp{cdecl}.  @xref{Function Attributes}.
9711 @strong{Warning:} this calling convention is incompatible with the one
9712 normally used on Unix, so you cannot use it if you need to call
9713 libraries compiled with the Unix compiler.
9715 Also, you must provide function prototypes for all functions that
9716 take variable numbers of arguments (including @code{printf});
9717 otherwise incorrect code will be generated for calls to those
9718 functions.
9720 In addition, seriously incorrect code will result if you call a
9721 function with too many arguments.  (Normally, extra arguments are
9722 harmlessly ignored.)
9724 @item -mregparm=@var{num}
9725 @opindex mregparm
9726 Control how many registers are used to pass integer arguments.  By
9727 default, no registers are used to pass arguments, and at most 3
9728 registers can be used.  You can control this behavior for a specific
9729 function by using the function attribute @samp{regparm}.
9730 @xref{Function Attributes}.
9732 @strong{Warning:} if you use this switch, and
9733 @var{num} is nonzero, then you must build all modules with the same
9734 value, including any libraries.  This includes the system libraries and
9735 startup modules.
9737 @item -msseregparm
9738 @opindex msseregparm
9739 Use SSE register passing conventions for float and double arguments
9740 and return values.  You can control this behavior for a specific
9741 function by using the function attribute @samp{sseregparm}.
9742 @xref{Function Attributes}.
9744 @strong{Warning:} if you use this switch then you must build all
9745 modules with the same value, including any libraries.  This includes
9746 the system libraries and startup modules.
9748 @item -mstackrealign
9749 @opindex mstackrealign
9750 Realign the stack at entry.  On the Intel x86, the
9751 @option{-mstackrealign} option will generate an alternate prologue and
9752 epilogue that realigns the runtime stack.  This supports mixing legacy
9753 codes that keep a 4-byte aligned stack with modern codes that keep a
9754 16-byte stack for SSE compatibility.  The alternate prologue and
9755 epilogue are slower and bigger than the regular ones, and the
9756 alternate prologue requires an extra scratch register; this lowers the
9757 number of registers available if used in conjunction with the
9758 @code{regparm} attribute.  The @option{-mstackrealign} option is
9759 incompatible with the nested function prologue; this is considered a
9760 hard error.  See also the attribute @code{force_align_arg_pointer},
9761 applicable to individual functions.
9763 @item -mpreferred-stack-boundary=@var{num}
9764 @opindex mpreferred-stack-boundary
9765 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9766 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9767 the default is 4 (16 bytes or 128 bits).
9769 On Pentium and PentiumPro, @code{double} and @code{long double} values
9770 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9771 suffer significant run time performance penalties.  On Pentium III, the
9772 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9773 properly if it is not 16 byte aligned.
9775 To ensure proper alignment of this values on the stack, the stack boundary
9776 must be as aligned as that required by any value stored on the stack.
9777 Further, every function must be generated such that it keeps the stack
9778 aligned.  Thus calling a function compiled with a higher preferred
9779 stack boundary from a function compiled with a lower preferred stack
9780 boundary will most likely misalign the stack.  It is recommended that
9781 libraries that use callbacks always use the default setting.
9783 This extra alignment does consume extra stack space, and generally
9784 increases code size.  Code that is sensitive to stack space usage, such
9785 as embedded systems and operating system kernels, may want to reduce the
9786 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9788 @item -mmmx
9789 @itemx -mno-mmx
9790 @item -msse
9791 @itemx -mno-sse
9792 @item -msse2
9793 @itemx -mno-sse2
9794 @item -msse3
9795 @itemx -mno-sse3
9796 @item -mssse3
9797 @itemx -mno-ssse3
9798 @item -m3dnow
9799 @itemx -mno-3dnow
9800 @opindex mmmx
9801 @opindex mno-mmx
9802 @opindex msse
9803 @opindex mno-sse
9804 @opindex m3dnow
9805 @opindex mno-3dnow
9806 These switches enable or disable the use of instructions in the MMX,
9807 SSE, SSE2, SSE3, SSSE3 or 3DNow! extended instruction sets.
9808 These extensions are also available as built-in functions: see
9809 @ref{X86 Built-in Functions}, for details of the functions enabled and
9810 disabled by these switches.
9812 To have SSE/SSE2 instructions generated automatically from floating-point
9813 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9815 These options will enable GCC to use these extended instructions in
9816 generated code, even without @option{-mfpmath=sse}.  Applications which
9817 perform runtime CPU detection must compile separate files for each
9818 supported architecture, using the appropriate flags.  In particular,
9819 the file containing the CPU detection code should be compiled without
9820 these options.
9822 @item -mpush-args
9823 @itemx -mno-push-args
9824 @opindex mpush-args
9825 @opindex mno-push-args
9826 Use PUSH operations to store outgoing parameters.  This method is shorter
9827 and usually equally fast as method using SUB/MOV operations and is enabled
9828 by default.  In some cases disabling it may improve performance because of
9829 improved scheduling and reduced dependencies.
9831 @item -maccumulate-outgoing-args
9832 @opindex maccumulate-outgoing-args
9833 If enabled, the maximum amount of space required for outgoing arguments will be
9834 computed in the function prologue.  This is faster on most modern CPUs
9835 because of reduced dependencies, improved scheduling and reduced stack usage
9836 when preferred stack boundary is not equal to 2.  The drawback is a notable
9837 increase in code size.  This switch implies @option{-mno-push-args}.
9839 @item -mthreads
9840 @opindex mthreads
9841 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9842 on thread-safe exception handling must compile and link all code with the
9843 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9844 @option{-D_MT}; when linking, it links in a special thread helper library
9845 @option{-lmingwthrd} which cleans up per thread exception handling data.
9847 @item -mno-align-stringops
9848 @opindex mno-align-stringops
9849 Do not align destination of inlined string operations.  This switch reduces
9850 code size and improves performance in case the destination is already aligned,
9851 but GCC doesn't know about it.
9853 @item -minline-all-stringops
9854 @opindex minline-all-stringops
9855 By default GCC inlines string operations only when destination is known to be
9856 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9857 size, but may improve performance of code that depends on fast memcpy, strlen
9858 and memset for short lengths.
9860 @item -minline-stringops-dynamically
9861 @opindex minline-stringops-dynamically
9862 For string operation of unknown size, inline runtime checks so for small
9863 blocks inline code is used, while for large blocks library call is used.
9865 @item -mstringop-strategy=@var{alg}
9866 @opindex mstringop-strategy=@var{alg}
9867 Overwrite internal decision heuristic about particular algorithm to inline
9868 string operation with.  The allowed values are @code{rep_byte},
9869 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
9870 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
9871 expanding inline loop, @code{libcall} for always expanding library call.
9873 @item -momit-leaf-frame-pointer
9874 @opindex momit-leaf-frame-pointer
9875 Don't keep the frame pointer in a register for leaf functions.  This
9876 avoids the instructions to save, set up and restore frame pointers and
9877 makes an extra register available in leaf functions.  The option
9878 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9879 which might make debugging harder.
9881 @item -mtls-direct-seg-refs
9882 @itemx -mno-tls-direct-seg-refs
9883 @opindex mtls-direct-seg-refs
9884 Controls whether TLS variables may be accessed with offsets from the
9885 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9886 or whether the thread base pointer must be added.  Whether or not this
9887 is legal depends on the operating system, and whether it maps the
9888 segment to cover the entire TLS area.
9890 For systems that use GNU libc, the default is on.
9891 @end table
9893 These @samp{-m} switches are supported in addition to the above
9894 on AMD x86-64 processors in 64-bit environments.
9896 @table @gcctabopt
9897 @item -m32
9898 @itemx -m64
9899 @opindex m32
9900 @opindex m64
9901 Generate code for a 32-bit or 64-bit environment.
9902 The 32-bit environment sets int, long and pointer to 32 bits and
9903 generates code that runs on any i386 system.
9904 The 64-bit environment sets int to 32 bits and long and pointer
9905 to 64 bits and generates code for AMD's x86-64 architecture.
9907 @item -mno-red-zone
9908 @opindex no-red-zone
9909 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9910 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9911 stack pointer that will not be modified by signal or interrupt handlers
9912 and therefore can be used for temporary data without adjusting the stack
9913 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9915 @item -mcmodel=small
9916 @opindex mcmodel=small
9917 Generate code for the small code model: the program and its symbols must
9918 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9919 Programs can be statically or dynamically linked.  This is the default
9920 code model.
9922 @item -mcmodel=kernel
9923 @opindex mcmodel=kernel
9924 Generate code for the kernel code model.  The kernel runs in the
9925 negative 2 GB of the address space.
9926 This model has to be used for Linux kernel code.
9928 @item -mcmodel=medium
9929 @opindex mcmodel=medium
9930 Generate code for the medium model: The program is linked in the lower 2
9931 GB of the address space but symbols can be located anywhere in the
9932 address space.  Programs can be statically or dynamically linked, but
9933 building of shared libraries are not supported with the medium model.
9935 @item -mcmodel=large
9936 @opindex mcmodel=large
9937 Generate code for the large model: This model makes no assumptions
9938 about addresses and sizes of sections.  Currently GCC does not implement
9939 this model.
9940 @end table
9942 @node IA-64 Options
9943 @subsection IA-64 Options
9944 @cindex IA-64 Options
9946 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9948 @table @gcctabopt
9949 @item -mbig-endian
9950 @opindex mbig-endian
9951 Generate code for a big endian target.  This is the default for HP-UX@.
9953 @item -mlittle-endian
9954 @opindex mlittle-endian
9955 Generate code for a little endian target.  This is the default for AIX5
9956 and GNU/Linux.
9958 @item -mgnu-as
9959 @itemx -mno-gnu-as
9960 @opindex mgnu-as
9961 @opindex mno-gnu-as
9962 Generate (or don't) code for the GNU assembler.  This is the default.
9963 @c Also, this is the default if the configure option @option{--with-gnu-as}
9964 @c is used.
9966 @item -mgnu-ld
9967 @itemx -mno-gnu-ld
9968 @opindex mgnu-ld
9969 @opindex mno-gnu-ld
9970 Generate (or don't) code for the GNU linker.  This is the default.
9971 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9972 @c is used.
9974 @item -mno-pic
9975 @opindex mno-pic
9976 Generate code that does not use a global pointer register.  The result
9977 is not position independent code, and violates the IA-64 ABI@.
9979 @item -mvolatile-asm-stop
9980 @itemx -mno-volatile-asm-stop
9981 @opindex mvolatile-asm-stop
9982 @opindex mno-volatile-asm-stop
9983 Generate (or don't) a stop bit immediately before and after volatile asm
9984 statements.
9986 @item -mregister-names
9987 @itemx -mno-register-names
9988 @opindex mregister-names
9989 @opindex mno-register-names
9990 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9991 the stacked registers.  This may make assembler output more readable.
9993 @item -mno-sdata
9994 @itemx -msdata
9995 @opindex mno-sdata
9996 @opindex msdata
9997 Disable (or enable) optimizations that use the small data section.  This may
9998 be useful for working around optimizer bugs.
10000 @item -mconstant-gp
10001 @opindex mconstant-gp
10002 Generate code that uses a single constant global pointer value.  This is
10003 useful when compiling kernel code.
10005 @item -mauto-pic
10006 @opindex mauto-pic
10007 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10008 This is useful when compiling firmware code.
10010 @item -minline-float-divide-min-latency
10011 @opindex minline-float-divide-min-latency
10012 Generate code for inline divides of floating point values
10013 using the minimum latency algorithm.
10015 @item -minline-float-divide-max-throughput
10016 @opindex minline-float-divide-max-throughput
10017 Generate code for inline divides of floating point values
10018 using the maximum throughput algorithm.
10020 @item -minline-int-divide-min-latency
10021 @opindex minline-int-divide-min-latency
10022 Generate code for inline divides of integer values
10023 using the minimum latency algorithm.
10025 @item -minline-int-divide-max-throughput
10026 @opindex minline-int-divide-max-throughput
10027 Generate code for inline divides of integer values
10028 using the maximum throughput algorithm.
10030 @item -minline-sqrt-min-latency
10031 @opindex minline-sqrt-min-latency
10032 Generate code for inline square roots
10033 using the minimum latency algorithm.
10035 @item -minline-sqrt-max-throughput
10036 @opindex minline-sqrt-max-throughput
10037 Generate code for inline square roots
10038 using the maximum throughput algorithm.
10040 @item -mno-dwarf2-asm
10041 @itemx -mdwarf2-asm
10042 @opindex mno-dwarf2-asm
10043 @opindex mdwarf2-asm
10044 Don't (or do) generate assembler code for the DWARF2 line number debugging
10045 info.  This may be useful when not using the GNU assembler.
10047 @item -mearly-stop-bits
10048 @itemx -mno-early-stop-bits
10049 @opindex mearly-stop-bits
10050 @opindex mno-early-stop-bits
10051 Allow stop bits to be placed earlier than immediately preceding the
10052 instruction that triggered the stop bit.  This can improve instruction
10053 scheduling, but does not always do so.
10055 @item -mfixed-range=@var{register-range}
10056 @opindex mfixed-range
10057 Generate code treating the given register range as fixed registers.
10058 A fixed register is one that the register allocator can not use.  This is
10059 useful when compiling kernel code.  A register range is specified as
10060 two registers separated by a dash.  Multiple register ranges can be
10061 specified separated by a comma.
10063 @item -mtls-size=@var{tls-size}
10064 @opindex mtls-size
10065 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
10068 @item -mtune=@var{cpu-type}
10069 @opindex mtune
10070 Tune the instruction scheduling for a particular CPU, Valid values are
10071 itanium, itanium1, merced, itanium2, and mckinley.
10073 @item -mt
10074 @itemx -pthread
10075 @opindex mt
10076 @opindex pthread
10077 Add support for multithreading using the POSIX threads library.  This
10078 option sets flags for both the preprocessor and linker.  It does
10079 not affect the thread safety of object code produced by the compiler or
10080 that of libraries supplied with it.  These are HP-UX specific flags.
10082 @item -milp32
10083 @itemx -mlp64
10084 @opindex milp32
10085 @opindex mlp64
10086 Generate code for a 32-bit or 64-bit environment.
10087 The 32-bit environment sets int, long and pointer to 32 bits.
10088 The 64-bit environment sets int to 32 bits and long and pointer
10089 to 64 bits.  These are HP-UX specific flags.
10091 @item -mno-sched-br-data-spec
10092 @itemx -msched-br-data-spec
10093 @opindex -mno-sched-br-data-spec
10094 @opindex -msched-br-data-spec
10095 (Dis/En)able data speculative scheduling before reload.
10096 This will result in generation of the ld.a instructions and
10097 the corresponding check instructions (ld.c / chk.a).
10098 The default is 'disable'.
10100 @item -msched-ar-data-spec
10101 @itemx -mno-sched-ar-data-spec
10102 @opindex -msched-ar-data-spec
10103 @opindex -mno-sched-ar-data-spec
10104 (En/Dis)able data speculative scheduling after reload.
10105 This will result in generation of the ld.a instructions and
10106 the corresponding check instructions (ld.c / chk.a).
10107 The default is 'enable'.
10109 @item -mno-sched-control-spec
10110 @itemx -msched-control-spec
10111 @opindex -mno-sched-control-spec
10112 @opindex -msched-control-spec
10113 (Dis/En)able control speculative scheduling.  This feature is
10114 available only during region scheduling (i.e. before reload).
10115 This will result in generation of the ld.s instructions and
10116 the corresponding check instructions chk.s .
10117 The default is 'disable'.
10119 @item -msched-br-in-data-spec
10120 @itemx -mno-sched-br-in-data-spec
10121 @opindex -msched-br-in-data-spec
10122 @opindex -mno-sched-br-in-data-spec
10123 (En/Dis)able speculative scheduling of the instructions that
10124 are dependent on the data speculative loads before reload.
10125 This is effective only with @option{-msched-br-data-spec} enabled.
10126 The default is 'enable'.
10128 @item -msched-ar-in-data-spec
10129 @itemx -mno-sched-ar-in-data-spec
10130 @opindex -msched-ar-in-data-spec
10131 @opindex -mno-sched-ar-in-data-spec
10132 (En/Dis)able speculative scheduling of the instructions that
10133 are dependent on the data speculative loads after reload.
10134 This is effective only with @option{-msched-ar-data-spec} enabled.
10135 The default is 'enable'.
10137 @item -msched-in-control-spec
10138 @itemx -mno-sched-in-control-spec
10139 @opindex -msched-in-control-spec
10140 @opindex -mno-sched-in-control-spec
10141 (En/Dis)able speculative scheduling of the instructions that
10142 are dependent on the control speculative loads.
10143 This is effective only with @option{-msched-control-spec} enabled.
10144 The default is 'enable'.
10146 @item -msched-ldc
10147 @itemx -mno-sched-ldc
10148 @opindex -msched-ldc
10149 @opindex -mno-sched-ldc
10150 (En/Dis)able use of simple data speculation checks ld.c .
10151 If disabled, only chk.a instructions will be emitted to check
10152 data speculative loads.
10153 The default is 'enable'.
10155 @item -mno-sched-control-ldc
10156 @itemx -msched-control-ldc
10157 @opindex -mno-sched-control-ldc
10158 @opindex -msched-control-ldc 
10159 (Dis/En)able use of ld.c instructions to check control speculative loads.
10160 If enabled, in case of control speculative load with no speculatively
10161 scheduled dependent instructions this load will be emitted as ld.sa and
10162 ld.c will be used to check it.
10163 The default is 'disable'.
10165 @item -mno-sched-spec-verbose
10166 @itemx -msched-spec-verbose
10167 @opindex -mno-sched-spec-verbose
10168 @opindex -msched-spec-verbose
10169 (Dis/En)able printing of the information about speculative motions.
10171 @item -mno-sched-prefer-non-data-spec-insns
10172 @itemx -msched-prefer-non-data-spec-insns
10173 @opindex -mno-sched-prefer-non-data-spec-insns
10174 @opindex -msched-prefer-non-data-spec-insns
10175 If enabled, data speculative instructions will be chosen for schedule
10176 only if there are no other choices at the moment.  This will make
10177 the use of the data speculation much more conservative.
10178 The default is 'disable'.
10180 @item -mno-sched-prefer-non-control-spec-insns
10181 @itemx -msched-prefer-non-control-spec-insns
10182 @opindex -mno-sched-prefer-non-control-spec-insns
10183 @opindex -msched-prefer-non-control-spec-insns
10184 If enabled, control speculative instructions will be chosen for schedule
10185 only if there are no other choices at the moment.  This will make
10186 the use of the control speculation much more conservative.
10187 The default is 'disable'.
10189 @item -mno-sched-count-spec-in-critical-path
10190 @itemx -msched-count-spec-in-critical-path
10191 @opindex -mno-sched-count-spec-in-critical-path
10192 @opindex -msched-count-spec-in-critical-path
10193 If enabled, speculative dependencies will be considered during
10194 computation of the instructions priorities.  This will make the use of the
10195 speculation a bit more conservative.
10196 The default is 'disable'.
10198 @end table
10200 @node M32C Options
10201 @subsection M32C Options
10202 @cindex M32C options
10204 @table @gcctabopt
10205 @item -mcpu=@var{name}
10206 @opindex mcpu=
10207 Select the CPU for which code is generated.  @var{name} may be one of
10208 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10209 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10210 the M32C/80 series.
10212 @item -msim
10213 @opindex msim
10214 Specifies that the program will be run on the simulator.  This causes
10215 an alternate runtime library to be linked in which supports, for
10216 example, file I/O.  You must not use this option when generating
10217 programs that will run on real hardware; you must provide your own
10218 runtime library for whatever I/O functions are needed.
10220 @item -memregs=@var{number}
10221 @opindex memregs=
10222 Specifies the number of memory-based pseudo-registers GCC will use
10223 during code generation.  These pseudo-registers will be used like real
10224 registers, so there is a tradeoff between GCC's ability to fit the
10225 code into available registers, and the performance penalty of using
10226 memory instead of registers.  Note that all modules in a program must
10227 be compiled with the same value for this option.  Because of that, you
10228 must not use this option with the default runtime libraries gcc
10229 builds.
10231 @end table
10233 @node M32R/D Options
10234 @subsection M32R/D Options
10235 @cindex M32R/D options
10237 These @option{-m} options are defined for Renesas M32R/D architectures:
10239 @table @gcctabopt
10240 @item -m32r2
10241 @opindex m32r2
10242 Generate code for the M32R/2@.
10244 @item -m32rx
10245 @opindex m32rx
10246 Generate code for the M32R/X@.
10248 @item -m32r
10249 @opindex m32r
10250 Generate code for the M32R@.  This is the default.
10252 @item -mmodel=small
10253 @opindex mmodel=small
10254 Assume all objects live in the lower 16MB of memory (so that their addresses
10255 can be loaded with the @code{ld24} instruction), and assume all subroutines
10256 are reachable with the @code{bl} instruction.
10257 This is the default.
10259 The addressability of a particular object can be set with the
10260 @code{model} attribute.
10262 @item -mmodel=medium
10263 @opindex mmodel=medium
10264 Assume objects may be anywhere in the 32-bit address space (the compiler
10265 will generate @code{seth/add3} instructions to load their addresses), and
10266 assume all subroutines are reachable with the @code{bl} instruction.
10268 @item -mmodel=large
10269 @opindex mmodel=large
10270 Assume objects may be anywhere in the 32-bit address space (the compiler
10271 will generate @code{seth/add3} instructions to load their addresses), and
10272 assume subroutines may not be reachable with the @code{bl} instruction
10273 (the compiler will generate the much slower @code{seth/add3/jl}
10274 instruction sequence).
10276 @item -msdata=none
10277 @opindex msdata=none
10278 Disable use of the small data area.  Variables will be put into
10279 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10280 @code{section} attribute has been specified).
10281 This is the default.
10283 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10284 Objects may be explicitly put in the small data area with the
10285 @code{section} attribute using one of these sections.
10287 @item -msdata=sdata
10288 @opindex msdata=sdata
10289 Put small global and static data in the small data area, but do not
10290 generate special code to reference them.
10292 @item -msdata=use
10293 @opindex msdata=use
10294 Put small global and static data in the small data area, and generate
10295 special instructions to reference them.
10297 @item -G @var{num}
10298 @opindex G
10299 @cindex smaller data references
10300 Put global and static objects less than or equal to @var{num} bytes
10301 into the small data or bss sections instead of the normal data or bss
10302 sections.  The default value of @var{num} is 8.
10303 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10304 for this option to have any effect.
10306 All modules should be compiled with the same @option{-G @var{num}} value.
10307 Compiling with different values of @var{num} may or may not work; if it
10308 doesn't the linker will give an error message---incorrect code will not be
10309 generated.
10311 @item -mdebug
10312 @opindex mdebug
10313 Makes the M32R specific code in the compiler display some statistics
10314 that might help in debugging programs.
10316 @item -malign-loops
10317 @opindex malign-loops
10318 Align all loops to a 32-byte boundary.
10320 @item -mno-align-loops
10321 @opindex mno-align-loops
10322 Do not enforce a 32-byte alignment for loops.  This is the default.
10324 @item -missue-rate=@var{number}
10325 @opindex missue-rate=@var{number}
10326 Issue @var{number} instructions per cycle.  @var{number} can only be 1
10327 or 2.
10329 @item -mbranch-cost=@var{number}
10330 @opindex mbranch-cost=@var{number}
10331 @var{number} can only be 1 or 2.  If it is 1 then branches will be
10332 preferred over conditional code, if it is 2, then the opposite will
10333 apply.
10335 @item -mflush-trap=@var{number}
10336 @opindex mflush-trap=@var{number}
10337 Specifies the trap number to use to flush the cache.  The default is
10338 12.  Valid numbers are between 0 and 15 inclusive.
10340 @item -mno-flush-trap
10341 @opindex mno-flush-trap
10342 Specifies that the cache cannot be flushed by using a trap.
10344 @item -mflush-func=@var{name}
10345 @opindex mflush-func=@var{name}
10346 Specifies the name of the operating system function to call to flush
10347 the cache.  The default is @emph{_flush_cache}, but a function call
10348 will only be used if a trap is not available.
10350 @item -mno-flush-func
10351 @opindex mno-flush-func
10352 Indicates that there is no OS function for flushing the cache.
10354 @end table
10356 @node M680x0 Options
10357 @subsection M680x0 Options
10358 @cindex M680x0 options
10360 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
10361 The default settings depend on which architecture was selected when
10362 the compiler was configured; the defaults for the most common choices
10363 are given below.
10365 @table @gcctabopt
10366 @item -march=@var{arch}
10367 @opindex march
10368 Generate code for a specific M680x0 or ColdFire instruction set
10369 architecture.  Permissible values of @var{arch} for M680x0
10370 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
10371 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
10372 architectures are selected according to Freescale's ISA classification
10373 and the permissible values are: @samp{isaa}, @samp{isaaplus},
10374 @samp{isab} and @samp{isac}.
10376 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
10377 code for a ColdFire target.  The @var{arch} in this macro is one of the
10378 @option{-march} arguments given above.
10380 When used together, @option{-march} and @option{-mtune} select code
10381 that runs on a family of similar processors but that is optimized
10382 for a particular microarchitecture.
10384 @item -mcpu=@var{cpu}
10385 @opindex mcpu
10386 Generate code for a specific M680x0 or ColdFire processor.
10387 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
10388 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
10389 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
10390 below, which also classifies the CPUs into families:
10392 @multitable @columnfractions 0.20 0.80
10393 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
10394 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
10395 @item @samp{5206e} @tab @samp{5206e}
10396 @item @samp{5208} @tab @samp{5207} @samp{5208}
10397 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
10398 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
10399 @item @samp{5216} @tab @samp{5214} @samp{5216}
10400 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
10401 @item @samp{5225} @tab @samp{5224} @samp{5225}
10402 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
10403 @item @samp{5249} @tab @samp{5249}
10404 @item @samp{5250} @tab @samp{5250}
10405 @item @samp{5271} @tab @samp{5270} @samp{5271}
10406 @item @samp{5272} @tab @samp{5272}
10407 @item @samp{5275} @tab @samp{5274} @samp{5275}
10408 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
10409 @item @samp{5307} @tab @samp{5307}
10410 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
10411 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
10412 @item @samp{5407} @tab @samp{5407}
10413 @item @samp{5475} @tab @samp{5470} @samp{5471} @samp{5472} @samp{5473} @samp{5474} @samp{5475} @samp{547x} @samp{5480} @samp{5481} @samp{5482} @samp{5483} @samp{5484} @samp{5485}
10414 @end multitable
10416 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
10417 @var{arch} is compatible with @var{cpu}.  Other combinations of
10418 @option{-mcpu} and @option{-march} are rejected.
10420 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
10421 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
10422 where the value of @var{family} is given by the table above.
10424 @item -mtune=@var{tune}
10425 @opindex mtune
10426 Tune the code for a particular microarchitecture, within the
10427 constraints set by @option{-march} and @option{-mcpu}.
10428 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
10429 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
10430 and @samp{cpu32}.  The ColdFire microarchitectures
10431 are: @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
10433 You can also use @option{-mtune=68020-40} for code that needs
10434 to run relatively well on 68020, 68030 and 68040 targets.
10435 @option{-mtune=68020-60} is similar but includes 68060 targets
10436 as well.  These two options select the same tuning decisions as
10437 @option{-m68020-40} and @option{-m68020-60} respectively.
10439 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
10440 when tuning for 680x0 architecture @var{arch}.  It also defines
10441 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
10442 option is used.  If gcc is tuning for a range of architectures,
10443 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
10444 it defines the macros for every architecture in the range.
10446 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
10447 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
10448 of the arguments given above.
10450 @item -m68000
10451 @itemx -mc68000
10452 @opindex m68000
10453 @opindex mc68000
10454 Generate output for a 68000.  This is the default
10455 when the compiler is configured for 68000-based systems.
10456 It is equivalent to @option{-march=68000}.
10458 Use this option for microcontrollers with a 68000 or EC000 core,
10459 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10461 @item -m68010
10462 @opindex m68010
10463 Generate output for a 68010.  This is the default
10464 when the compiler is configured for 68010-based systems.
10465 It is equivalent to @option{-march=68010}.
10467 @item -m68020
10468 @itemx -mc68020
10469 @opindex m68020
10470 @opindex mc68020
10471 Generate output for a 68020.  This is the default
10472 when the compiler is configured for 68020-based systems.
10473 It is equivalent to @option{-march=68020}.
10475 @item -m68030
10476 @opindex m68030
10477 Generate output for a 68030.  This is the default when the compiler is
10478 configured for 68030-based systems.  It is equivalent to
10479 @option{-march=68030}.
10481 @item -m68040
10482 @opindex m68040
10483 Generate output for a 68040.  This is the default when the compiler is
10484 configured for 68040-based systems.  It is equivalent to
10485 @option{-march=68040}.
10487 This option inhibits the use of 68881/68882 instructions that have to be
10488 emulated by software on the 68040.  Use this option if your 68040 does not
10489 have code to emulate those instructions.
10491 @item -m68060
10492 @opindex m68060
10493 Generate output for a 68060.  This is the default when the compiler is
10494 configured for 68060-based systems.  It is equivalent to
10495 @option{-march=68060}.
10497 This option inhibits the use of 68020 and 68881/68882 instructions that
10498 have to be emulated by software on the 68060.  Use this option if your 68060
10499 does not have code to emulate those instructions.
10501 @item -mcpu32
10502 @opindex mcpu32
10503 Generate output for a CPU32.  This is the default
10504 when the compiler is configured for CPU32-based systems.
10505 It is equivalent to @option{-march=cpu32}.
10507 Use this option for microcontrollers with a
10508 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
10509 68336, 68340, 68341, 68349 and 68360.
10511 @item -m5200
10512 @opindex m5200
10513 Generate output for a 520X ColdFire CPU.  This is the default
10514 when the compiler is configured for 520X-based systems.
10515 It is equivalent to @option{-mcpu=5206}, and is now deprecated
10516 in favor of that option.
10518 Use this option for microcontroller with a 5200 core, including
10519 the MCF5202, MCF5203, MCF5204 and MCF5206.
10521 @item -m5206e
10522 @opindex m5206e
10523 Generate output for a 5206e ColdFire CPU.  The option is now
10524 deprecated in favor of the equivalent @option{-mcpu=5206e}.
10526 @item -m528x
10527 @opindex m528x
10528 Generate output for a member of the ColdFire 528X family.
10529 The option is now deprecated in favor of the equivalent
10530 @option{-mcpu=528x}.
10532 @item -m5307
10533 @opindex m5307
10534 Generate output for a ColdFire 5307 CPU.  The option is now deprecated
10535 in favor of the equivalent @option{-mcpu=5307}.
10537 @item -m5407
10538 @opindex m5407
10539 Generate output for a ColdFire 5407 CPU.  The option is now deprecated
10540 in favor of the equivalent @option{-mcpu=5407}.
10542 @item -mcfv4e
10543 @opindex mcfv4e
10544 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
10545 This includes use of hardware floating point instructions.
10546 The option is equivalent to @option{-mcpu=547x}, and is now
10547 deprecated in favor of that option.
10549 @item -m68020-40
10550 @opindex m68020-40
10551 Generate output for a 68040, without using any of the new instructions.
10552 This results in code which can run relatively efficiently on either a
10553 68020/68881 or a 68030 or a 68040.  The generated code does use the
10554 68881 instructions that are emulated on the 68040.
10556 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
10558 @item -m68020-60
10559 @opindex m68020-60
10560 Generate output for a 68060, without using any of the new instructions.
10561 This results in code which can run relatively efficiently on either a
10562 68020/68881 or a 68030 or a 68040.  The generated code does use the
10563 68881 instructions that are emulated on the 68060.
10565 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
10567 @item -mhard-float
10568 @itemx -m68881
10569 @opindex mhard-float
10570 @opindex m68881
10571 Generate floating-point instructions.  This is the default for 68020
10572 and above, and for ColdFire devices that have an FPU.  It defines the
10573 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
10574 on ColdFire targets.
10576 @item -msoft-float
10577 @opindex msoft-float
10578 Do not generate floating-point instructions; use library calls instead.
10579 This is the default for 68000, 68010, and 68832 targets.  It is also
10580 the default for ColdFire devices that have no FPU.
10582 @item -mdiv
10583 @itemx -mno-div
10584 @opindex mdiv
10585 @opindex mno-div
10586 Generate (do not generate) ColdFire hardware divide and remainder
10587 instructions.  If @option{-march} is used without @option{-mcpu},
10588 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
10589 architectures.  Otherwise, the default is taken from the target CPU
10590 (either the default CPU, or the one specified by @option{-mcpu}).  For
10591 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
10592 @option{-mcpu=5206e}.
10594 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
10596 @item -mshort
10597 @opindex mshort
10598 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10599 Additionally, parameters passed on the stack are also aligned to a
10600 16-bit boundary even on targets whose API mandates promotion to 32-bit.
10602 @item -mno-short
10603 @opindex -mno-short
10604 Do not consider type @code{int} to be 16 bits wide.  This is the default.
10606 @item -mnobitfield
10607 @itemx -mno-bitfield
10608 @opindex mnobitfield
10609 @opindex mno-bitfield
10610 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
10611 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10613 @item -mbitfield
10614 @opindex mbitfield
10615 Do use the bit-field instructions.  The @option{-m68020} option implies
10616 @option{-mbitfield}.  This is the default if you use a configuration
10617 designed for a 68020.
10619 @item -mrtd
10620 @opindex mrtd
10621 Use a different function-calling convention, in which functions
10622 that take a fixed number of arguments return with the @code{rtd}
10623 instruction, which pops their arguments while returning.  This
10624 saves one instruction in the caller since there is no need to pop
10625 the arguments there.
10627 This calling convention is incompatible with the one normally
10628 used on Unix, so you cannot use it if you need to call libraries
10629 compiled with the Unix compiler.
10631 Also, you must provide function prototypes for all functions that
10632 take variable numbers of arguments (including @code{printf});
10633 otherwise incorrect code will be generated for calls to those
10634 functions.
10636 In addition, seriously incorrect code will result if you call a
10637 function with too many arguments.  (Normally, extra arguments are
10638 harmlessly ignored.)
10640 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10641 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10643 @item -mno-rtd
10644 @opindex mno-rtd
10645 Do not use the calling conventions selected by @option{-mrtd}.
10646 This is the default.
10648 @item -malign-int
10649 @itemx -mno-align-int
10650 @opindex malign-int
10651 @opindex mno-align-int
10652 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10653 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10654 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10655 Aligning variables on 32-bit boundaries produces code that runs somewhat
10656 faster on processors with 32-bit busses at the expense of more memory.
10658 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10659 align structures containing the above types  differently than
10660 most published application binary interface specifications for the m68k.
10662 @item -mpcrel
10663 @opindex mpcrel
10664 Use the pc-relative addressing mode of the 68000 directly, instead of
10665 using a global offset table.  At present, this option implies @option{-fpic},
10666 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10667 not presently supported with @option{-mpcrel}, though this could be supported for
10668 68020 and higher processors.
10670 @item -mno-strict-align
10671 @itemx -mstrict-align
10672 @opindex mno-strict-align
10673 @opindex mstrict-align
10674 Do not (do) assume that unaligned memory references will be handled by
10675 the system.
10677 @item -msep-data
10678 Generate code that allows the data segment to be located in a different
10679 area of memory from the text segment.  This allows for execute in place in
10680 an environment without virtual memory management.  This option implies
10681 @option{-fPIC}.
10683 @item -mno-sep-data
10684 Generate code that assumes that the data segment follows the text segment.
10685 This is the default.
10687 @item -mid-shared-library
10688 Generate code that supports shared libraries via the library ID method.
10689 This allows for execute in place and shared libraries in an environment
10690 without virtual memory management.  This option implies @option{-fPIC}.
10692 @item -mno-id-shared-library
10693 Generate code that doesn't assume ID based shared libraries are being used.
10694 This is the default.
10696 @item -mshared-library-id=n
10697 Specified the identification number of the ID based shared library being
10698 compiled.  Specifying a value of 0 will generate more compact code, specifying
10699 other values will force the allocation of that number to the current
10700 library but is no more space or time efficient than omitting this option.
10702 @end table
10704 @node M68hc1x Options
10705 @subsection M68hc1x Options
10706 @cindex M68hc1x options
10708 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10709 microcontrollers.  The default values for these options depends on
10710 which style of microcontroller was selected when the compiler was configured;
10711 the defaults for the most common choices are given below.
10713 @table @gcctabopt
10714 @item -m6811
10715 @itemx -m68hc11
10716 @opindex m6811
10717 @opindex m68hc11
10718 Generate output for a 68HC11.  This is the default
10719 when the compiler is configured for 68HC11-based systems.
10721 @item -m6812
10722 @itemx -m68hc12
10723 @opindex m6812
10724 @opindex m68hc12
10725 Generate output for a 68HC12.  This is the default
10726 when the compiler is configured for 68HC12-based systems.
10728 @item -m68S12
10729 @itemx -m68hcs12
10730 @opindex m68S12
10731 @opindex m68hcs12
10732 Generate output for a 68HCS12.
10734 @item -mauto-incdec
10735 @opindex mauto-incdec
10736 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10737 addressing modes.
10739 @item -minmax
10740 @itemx -nominmax
10741 @opindex minmax
10742 @opindex mnominmax
10743 Enable the use of 68HC12 min and max instructions.
10745 @item -mlong-calls
10746 @itemx -mno-long-calls
10747 @opindex mlong-calls
10748 @opindex mno-long-calls
10749 Treat all calls as being far away (near).  If calls are assumed to be
10750 far away, the compiler will use the @code{call} instruction to
10751 call a function and the @code{rtc} instruction for returning.
10753 @item -mshort
10754 @opindex mshort
10755 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10757 @item -msoft-reg-count=@var{count}
10758 @opindex msoft-reg-count
10759 Specify the number of pseudo-soft registers which are used for the
10760 code generation.  The maximum number is 32.  Using more pseudo-soft
10761 register may or may not result in better code depending on the program.
10762 The default is 4 for 68HC11 and 2 for 68HC12.
10764 @end table
10766 @node MCore Options
10767 @subsection MCore Options
10768 @cindex MCore options
10770 These are the @samp{-m} options defined for the Motorola M*Core
10771 processors.
10773 @table @gcctabopt
10775 @item -mhardlit
10776 @itemx -mno-hardlit
10777 @opindex mhardlit
10778 @opindex mno-hardlit
10779 Inline constants into the code stream if it can be done in two
10780 instructions or less.
10782 @item -mdiv
10783 @itemx -mno-div
10784 @opindex mdiv
10785 @opindex mno-div
10786 Use the divide instruction.  (Enabled by default).
10788 @item -mrelax-immediate
10789 @itemx -mno-relax-immediate
10790 @opindex mrelax-immediate
10791 @opindex mno-relax-immediate
10792 Allow arbitrary sized immediates in bit operations.
10794 @item -mwide-bitfields
10795 @itemx -mno-wide-bitfields
10796 @opindex mwide-bitfields
10797 @opindex mno-wide-bitfields
10798 Always treat bit-fields as int-sized.
10800 @item -m4byte-functions
10801 @itemx -mno-4byte-functions
10802 @opindex m4byte-functions
10803 @opindex mno-4byte-functions
10804 Force all functions to be aligned to a four byte boundary.
10806 @item -mcallgraph-data
10807 @itemx -mno-callgraph-data
10808 @opindex mcallgraph-data
10809 @opindex mno-callgraph-data
10810 Emit callgraph information.
10812 @item -mslow-bytes
10813 @itemx -mno-slow-bytes
10814 @opindex mslow-bytes
10815 @opindex mno-slow-bytes
10816 Prefer word access when reading byte quantities.
10818 @item -mlittle-endian
10819 @itemx -mbig-endian
10820 @opindex mlittle-endian
10821 @opindex mbig-endian
10822 Generate code for a little endian target.
10824 @item -m210
10825 @itemx -m340
10826 @opindex m210
10827 @opindex m340
10828 Generate code for the 210 processor.
10829 @end table
10831 @node MIPS Options
10832 @subsection MIPS Options
10833 @cindex MIPS options
10835 @table @gcctabopt
10837 @item -EB
10838 @opindex EB
10839 Generate big-endian code.
10841 @item -EL
10842 @opindex EL
10843 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10844 configurations.
10846 @item -march=@var{arch}
10847 @opindex march
10848 Generate code that will run on @var{arch}, which can be the name of a
10849 generic MIPS ISA, or the name of a particular processor.
10850 The ISA names are:
10851 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10852 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10853 The processor names are:
10854 @samp{4kc}, @samp{4km}, @samp{4kp},
10855 @samp{4kec}, @samp{4kem}, @samp{4kep},
10856 @samp{5kc}, @samp{5kf},
10857 @samp{20kc},
10858 @samp{24kc}, @samp{24kf}, @samp{24kx},
10859 @samp{24kec}, @samp{24kef}, @samp{24kex},
10860 @samp{34kc}, @samp{34kf}, @samp{34kx},
10861 @samp{m4k},
10862 @samp{orion},
10863 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10864 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10865 @samp{rm7000}, @samp{rm9000},
10866 @samp{sb1},
10867 @samp{sr71000},
10868 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10869 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10870 The special value @samp{from-abi} selects the
10871 most compatible architecture for the selected ABI (that is,
10872 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10874 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10875 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10876 @samp{vr} may be written @samp{r}.
10878 GCC defines two macros based on the value of this option.  The first
10879 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10880 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10881 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10882 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10883 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10885 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10886 above.  In other words, it will have the full prefix and will not
10887 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10888 the macro names the resolved architecture (either @samp{"mips1"} or
10889 @samp{"mips3"}).  It names the default architecture when no
10890 @option{-march} option is given.
10892 @item -mtune=@var{arch}
10893 @opindex mtune
10894 Optimize for @var{arch}.  Among other things, this option controls
10895 the way instructions are scheduled, and the perceived cost of arithmetic
10896 operations.  The list of @var{arch} values is the same as for
10897 @option{-march}.
10899 When this option is not used, GCC will optimize for the processor
10900 specified by @option{-march}.  By using @option{-march} and
10901 @option{-mtune} together, it is possible to generate code that will
10902 run on a family of processors, but optimize the code for one
10903 particular member of that family.
10905 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10906 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10907 @samp{-march} ones described above.
10909 @item -mips1
10910 @opindex mips1
10911 Equivalent to @samp{-march=mips1}.
10913 @item -mips2
10914 @opindex mips2
10915 Equivalent to @samp{-march=mips2}.
10917 @item -mips3
10918 @opindex mips3
10919 Equivalent to @samp{-march=mips3}.
10921 @item -mips4
10922 @opindex mips4
10923 Equivalent to @samp{-march=mips4}.
10925 @item -mips32
10926 @opindex mips32
10927 Equivalent to @samp{-march=mips32}.
10929 @item -mips32r2
10930 @opindex mips32r2
10931 Equivalent to @samp{-march=mips32r2}.
10933 @item -mips64
10934 @opindex mips64
10935 Equivalent to @samp{-march=mips64}.
10937 @item -mips16
10938 @itemx -mno-mips16
10939 @opindex mips16
10940 @opindex mno-mips16
10941 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10942 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10944 @item -mabi=32
10945 @itemx -mabi=o64
10946 @itemx -mabi=n32
10947 @itemx -mabi=64
10948 @itemx -mabi=eabi
10949 @opindex mabi=32
10950 @opindex mabi=o64
10951 @opindex mabi=n32
10952 @opindex mabi=64
10953 @opindex mabi=eabi
10954 Generate code for the given ABI@.
10956 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10957 generates 64-bit code when you select a 64-bit architecture, but you
10958 can use @option{-mgp32} to get 32-bit code instead.
10960 For information about the O64 ABI, see
10961 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10963 GCC supports a variant of the o32 ABI in which floating-point registers
10964 are 64 rather than 32 bits wide.  You can select this combination with
10965 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
10966 and @samp{mfhc1} instructions and is therefore only supported for
10967 MIPS32R2 processors.
10969 The register assignments for arguments and return values remain the
10970 same, but each scalar value is passed in a single 64-bit register
10971 rather than a pair of 32-bit registers.  For example, scalar
10972 floating-point values are returned in @samp{$f0} only, not a
10973 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
10974 remains the same, but all 64 bits are saved.
10976 @item -mabicalls
10977 @itemx -mno-abicalls
10978 @opindex mabicalls
10979 @opindex mno-abicalls
10980 Generate (do not generate) code that is suitable for SVR4-style
10981 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
10982 systems.
10984 @item -mshared
10985 @itemx -mno-shared
10986 Generate (do not generate) code that is fully position-independent,
10987 and that can therefore be linked into shared libraries.  This option
10988 only affects @option{-mabicalls}.
10990 All @option{-mabicalls} code has traditionally been position-independent,
10991 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
10992 as an extension, the GNU toolchain allows executables to use absolute
10993 accesses for locally-binding symbols.  It can also use shorter GP
10994 initialization sequences and generate direct calls to locally-defined
10995 functions.  This mode is selected by @option{-mno-shared}.
10997 @option{-mno-shared} depends on binutils 2.16 or higher and generates
10998 objects that can only be linked by the GNU linker.  However, the option
10999 does not affect the ABI of the final executable; it only affects the ABI
11000 of relocatable objects.  Using @option{-mno-shared} will generally make
11001 executables both smaller and quicker.
11003 @option{-mshared} is the default.
11005 @item -mxgot
11006 @itemx -mno-xgot
11007 @opindex mxgot
11008 @opindex mno-xgot
11009 Lift (do not lift) the usual restrictions on the size of the global
11010 offset table.
11012 GCC normally uses a single instruction to load values from the GOT@.
11013 While this is relatively efficient, it will only work if the GOT
11014 is smaller than about 64k.  Anything larger will cause the linker
11015 to report an error such as:
11017 @cindex relocation truncated to fit (MIPS)
11018 @smallexample
11019 relocation truncated to fit: R_MIPS_GOT16 foobar
11020 @end smallexample
11022 If this happens, you should recompile your code with @option{-mxgot}.
11023 It should then work with very large GOTs, although it will also be
11024 less efficient, since it will take three instructions to fetch the
11025 value of a global symbol.
11027 Note that some linkers can create multiple GOTs.  If you have such a
11028 linker, you should only need to use @option{-mxgot} when a single object
11029 file accesses more than 64k's worth of GOT entries.  Very few do.
11031 These options have no effect unless GCC is generating position
11032 independent code.
11034 @item -mgp32
11035 @opindex mgp32
11036 Assume that general-purpose registers are 32 bits wide.
11038 @item -mgp64
11039 @opindex mgp64
11040 Assume that general-purpose registers are 64 bits wide.
11042 @item -mfp32
11043 @opindex mfp32
11044 Assume that floating-point registers are 32 bits wide.
11046 @item -mfp64
11047 @opindex mfp64
11048 Assume that floating-point registers are 64 bits wide.
11050 @item -mhard-float
11051 @opindex mhard-float
11052 Use floating-point coprocessor instructions.
11054 @item -msoft-float
11055 @opindex msoft-float
11056 Do not use floating-point coprocessor instructions.  Implement
11057 floating-point calculations using library calls instead.
11059 @item -msingle-float
11060 @opindex msingle-float
11061 Assume that the floating-point coprocessor only supports single-precision
11062 operations.
11064 @itemx -mdouble-float
11065 @opindex mdouble-float
11066 Assume that the floating-point coprocessor supports double-precision
11067 operations.  This is the default.
11069 @itemx -mdsp
11070 @itemx -mno-dsp
11071 @opindex mdsp
11072 @opindex mno-dsp
11073 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
11075 @itemx -mpaired-single
11076 @itemx -mno-paired-single
11077 @opindex mpaired-single
11078 @opindex mno-paired-single
11079 Use (do not use) paired-single floating-point instructions.
11080 @xref{MIPS Paired-Single Support}.  This option can only be used
11081 when generating 64-bit code and requires hardware floating-point
11082 support to be enabled.
11084 @itemx -mips3d
11085 @itemx -mno-mips3d
11086 @opindex mips3d
11087 @opindex mno-mips3d
11088 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
11089 The option @option{-mips3d} implies @option{-mpaired-single}.
11091 @item -mlong64
11092 @opindex mlong64
11093 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
11094 an explanation of the default and the way that the pointer size is
11095 determined.
11097 @item -mlong32
11098 @opindex mlong32
11099 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
11101 The default size of @code{int}s, @code{long}s and pointers depends on
11102 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
11103 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
11104 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
11105 or the same size as integer registers, whichever is smaller.
11107 @item -msym32
11108 @itemx -mno-sym32
11109 @opindex msym32
11110 @opindex mno-sym32
11111 Assume (do not assume) that all symbols have 32-bit values, regardless
11112 of the selected ABI@.  This option is useful in combination with
11113 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
11114 to generate shorter and faster references to symbolic addresses.
11116 @item -G @var{num}
11117 @opindex G
11118 @cindex smaller data references (MIPS)
11119 @cindex gp-relative references (MIPS)
11120 Put global and static items less than or equal to @var{num} bytes into
11121 the small data or bss section instead of the normal data or bss section.
11122 This allows the data to be accessed using a single instruction.
11124 All modules should be compiled with the same @option{-G @var{num}}
11125 value.
11127 @item -membedded-data
11128 @itemx -mno-embedded-data
11129 @opindex membedded-data
11130 @opindex mno-embedded-data
11131 Allocate variables to the read-only data section first if possible, then
11132 next in the small data section if possible, otherwise in data.  This gives
11133 slightly slower code than the default, but reduces the amount of RAM required
11134 when executing, and thus may be preferred for some embedded systems.
11136 @item -muninit-const-in-rodata
11137 @itemx -mno-uninit-const-in-rodata
11138 @opindex muninit-const-in-rodata
11139 @opindex mno-uninit-const-in-rodata
11140 Put uninitialized @code{const} variables in the read-only data section.
11141 This option is only meaningful in conjunction with @option{-membedded-data}.
11143 @item -msplit-addresses
11144 @itemx -mno-split-addresses
11145 @opindex msplit-addresses
11146 @opindex mno-split-addresses
11147 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
11148 relocation operators.  This option has been superseded by
11149 @option{-mexplicit-relocs} but is retained for backwards compatibility.
11151 @item -mexplicit-relocs
11152 @itemx -mno-explicit-relocs
11153 @opindex mexplicit-relocs
11154 @opindex mno-explicit-relocs
11155 Use (do not use) assembler relocation operators when dealing with symbolic
11156 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
11157 is to use assembler macros instead.
11159 @option{-mexplicit-relocs} is the default if GCC was configured
11160 to use an assembler that supports relocation operators.
11162 @item -mcheck-zero-division
11163 @itemx -mno-check-zero-division
11164 @opindex mcheck-zero-division
11165 @opindex mno-check-zero-division
11166 Trap (do not trap) on integer division by zero.
11168 The default is @option{-mcheck-zero-division}.
11170 @item -mdivide-traps
11171 @itemx -mdivide-breaks
11172 @opindex mdivide-traps
11173 @opindex mdivide-breaks
11174 MIPS systems check for division by zero by generating either a
11175 conditional trap or a break instruction.  Using traps results in
11176 smaller code, but is only supported on MIPS II and later.  Also, some
11177 versions of the Linux kernel have a bug that prevents trap from
11178 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
11179 allow conditional traps on architectures that support them and
11180 @option{-mdivide-breaks} to force the use of breaks.
11182 The default is usually @option{-mdivide-traps}, but this can be
11183 overridden at configure time using @option{--with-divide=breaks}.
11184 Divide-by-zero checks can be completely disabled using
11185 @option{-mno-check-zero-division}.
11187 @item -mmemcpy
11188 @itemx -mno-memcpy
11189 @opindex mmemcpy
11190 @opindex mno-memcpy
11191 Force (do not force) the use of @code{memcpy()} for non-trivial block
11192 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
11193 most constant-sized copies.
11195 @item -mlong-calls
11196 @itemx -mno-long-calls
11197 @opindex mlong-calls
11198 @opindex mno-long-calls
11199 Disable (do not disable) use of the @code{jal} instruction.  Calling
11200 functions using @code{jal} is more efficient but requires the caller
11201 and callee to be in the same 256 megabyte segment.
11203 This option has no effect on abicalls code.  The default is
11204 @option{-mno-long-calls}.
11206 @item -mmad
11207 @itemx -mno-mad
11208 @opindex mmad
11209 @opindex mno-mad
11210 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
11211 instructions, as provided by the R4650 ISA@.
11213 @item -mfused-madd
11214 @itemx -mno-fused-madd
11215 @opindex mfused-madd
11216 @opindex mno-fused-madd
11217 Enable (disable) use of the floating point multiply-accumulate
11218 instructions, when they are available.  The default is
11219 @option{-mfused-madd}.
11221 When multiply-accumulate instructions are used, the intermediate
11222 product is calculated to infinite precision and is not subject to
11223 the FCSR Flush to Zero bit.  This may be undesirable in some
11224 circumstances.
11226 @item -nocpp
11227 @opindex nocpp
11228 Tell the MIPS assembler to not run its preprocessor over user
11229 assembler files (with a @samp{.s} suffix) when assembling them.
11231 @item -mfix-r4000
11232 @itemx -mno-fix-r4000
11233 @opindex mfix-r4000
11234 @opindex mno-fix-r4000
11235 Work around certain R4000 CPU errata:
11236 @itemize @minus
11237 @item
11238 A double-word or a variable shift may give an incorrect result if executed
11239 immediately after starting an integer division.
11240 @item
11241 A double-word or a variable shift may give an incorrect result if executed
11242 while an integer multiplication is in progress.
11243 @item
11244 An integer division may give an incorrect result if started in a delay slot
11245 of a taken branch or a jump.
11246 @end itemize
11248 @item -mfix-r4400
11249 @itemx -mno-fix-r4400
11250 @opindex mfix-r4400
11251 @opindex mno-fix-r4400
11252 Work around certain R4400 CPU errata:
11253 @itemize @minus
11254 @item
11255 A double-word or a variable shift may give an incorrect result if executed
11256 immediately after starting an integer division.
11257 @end itemize
11259 @item -mfix-vr4120
11260 @itemx -mno-fix-vr4120
11261 @opindex mfix-vr4120
11262 Work around certain VR4120 errata:
11263 @itemize @minus
11264 @item
11265 @code{dmultu} does not always produce the correct result.
11266 @item
11267 @code{div} and @code{ddiv} do not always produce the correct result if one
11268 of the operands is negative.
11269 @end itemize
11270 The workarounds for the division errata rely on special functions in
11271 @file{libgcc.a}.  At present, these functions are only provided by
11272 the @code{mips64vr*-elf} configurations.
11274 Other VR4120 errata require a nop to be inserted between certain pairs of
11275 instructions.  These errata are handled by the assembler, not by GCC itself.
11277 @item -mfix-vr4130
11278 @opindex mfix-vr4130
11279 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
11280 workarounds are implemented by the assembler rather than by GCC,
11281 although GCC will avoid using @code{mflo} and @code{mfhi} if the
11282 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
11283 instructions are available instead.
11285 @item -mfix-sb1
11286 @itemx -mno-fix-sb1
11287 @opindex mfix-sb1
11288 Work around certain SB-1 CPU core errata.
11289 (This flag currently works around the SB-1 revision 2
11290 ``F1'' and ``F2'' floating point errata.)
11292 @item -mflush-func=@var{func}
11293 @itemx -mno-flush-func
11294 @opindex mflush-func
11295 Specifies the function to call to flush the I and D caches, or to not
11296 call any such function.  If called, the function must take the same
11297 arguments as the common @code{_flush_func()}, that is, the address of the
11298 memory range for which the cache is being flushed, the size of the
11299 memory range, and the number 3 (to flush both caches).  The default
11300 depends on the target GCC was configured for, but commonly is either
11301 @samp{_flush_func} or @samp{__cpu_flush}.
11303 @item -mbranch-likely
11304 @itemx -mno-branch-likely
11305 @opindex mbranch-likely
11306 @opindex mno-branch-likely
11307 Enable or disable use of Branch Likely instructions, regardless of the
11308 default for the selected architecture.  By default, Branch Likely
11309 instructions may be generated if they are supported by the selected
11310 architecture.  An exception is for the MIPS32 and MIPS64 architectures
11311 and processors which implement those architectures; for those, Branch
11312 Likely instructions will not be generated by default because the MIPS32
11313 and MIPS64 architectures specifically deprecate their use.
11315 @item -mfp-exceptions
11316 @itemx -mno-fp-exceptions
11317 @opindex mfp-exceptions
11318 Specifies whether FP exceptions are enabled.  This affects how we schedule
11319 FP instructions for some processors.  The default is that FP exceptions are
11320 enabled.
11322 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
11323 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
11324 FP pipe.
11326 @item -mvr4130-align
11327 @itemx -mno-vr4130-align
11328 @opindex mvr4130-align
11329 The VR4130 pipeline is two-way superscalar, but can only issue two
11330 instructions together if the first one is 8-byte aligned.  When this
11331 option is enabled, GCC will align pairs of instructions that it
11332 thinks should execute in parallel.
11334 This option only has an effect when optimizing for the VR4130.
11335 It normally makes code faster, but at the expense of making it bigger.
11336 It is enabled by default at optimization level @option{-O3}.
11337 @end table
11339 @node MMIX Options
11340 @subsection MMIX Options
11341 @cindex MMIX Options
11343 These options are defined for the MMIX:
11345 @table @gcctabopt
11346 @item -mlibfuncs
11347 @itemx -mno-libfuncs
11348 @opindex mlibfuncs
11349 @opindex mno-libfuncs
11350 Specify that intrinsic library functions are being compiled, passing all
11351 values in registers, no matter the size.
11353 @item -mepsilon
11354 @itemx -mno-epsilon
11355 @opindex mepsilon
11356 @opindex mno-epsilon
11357 Generate floating-point comparison instructions that compare with respect
11358 to the @code{rE} epsilon register.
11360 @item -mabi=mmixware
11361 @itemx -mabi=gnu
11362 @opindex mabi-mmixware
11363 @opindex mabi=gnu
11364 Generate code that passes function parameters and return values that (in
11365 the called function) are seen as registers @code{$0} and up, as opposed to
11366 the GNU ABI which uses global registers @code{$231} and up.
11368 @item -mzero-extend
11369 @itemx -mno-zero-extend
11370 @opindex mzero-extend
11371 @opindex mno-zero-extend
11372 When reading data from memory in sizes shorter than 64 bits, use (do not
11373 use) zero-extending load instructions by default, rather than
11374 sign-extending ones.
11376 @item -mknuthdiv
11377 @itemx -mno-knuthdiv
11378 @opindex mknuthdiv
11379 @opindex mno-knuthdiv
11380 Make the result of a division yielding a remainder have the same sign as
11381 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
11382 remainder follows the sign of the dividend.  Both methods are
11383 arithmetically valid, the latter being almost exclusively used.
11385 @item -mtoplevel-symbols
11386 @itemx -mno-toplevel-symbols
11387 @opindex mtoplevel-symbols
11388 @opindex mno-toplevel-symbols
11389 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11390 code can be used with the @code{PREFIX} assembly directive.
11392 @item -melf
11393 @opindex melf
11394 Generate an executable in the ELF format, rather than the default
11395 @samp{mmo} format used by the @command{mmix} simulator.
11397 @item -mbranch-predict
11398 @itemx -mno-branch-predict
11399 @opindex mbranch-predict
11400 @opindex mno-branch-predict
11401 Use (do not use) the probable-branch instructions, when static branch
11402 prediction indicates a probable branch.
11404 @item -mbase-addresses
11405 @itemx -mno-base-addresses
11406 @opindex mbase-addresses
11407 @opindex mno-base-addresses
11408 Generate (do not generate) code that uses @emph{base addresses}.  Using a
11409 base address automatically generates a request (handled by the assembler
11410 and the linker) for a constant to be set up in a global register.  The
11411 register is used for one or more base address requests within the range 0
11412 to 255 from the value held in the register.  The generally leads to short
11413 and fast code, but the number of different data items that can be
11414 addressed is limited.  This means that a program that uses lots of static
11415 data may require @option{-mno-base-addresses}.
11417 @item -msingle-exit
11418 @itemx -mno-single-exit
11419 @opindex msingle-exit
11420 @opindex mno-single-exit
11421 Force (do not force) generated code to have a single exit point in each
11422 function.
11423 @end table
11425 @node MN10300 Options
11426 @subsection MN10300 Options
11427 @cindex MN10300 options
11429 These @option{-m} options are defined for Matsushita MN10300 architectures:
11431 @table @gcctabopt
11432 @item -mmult-bug
11433 @opindex mmult-bug
11434 Generate code to avoid bugs in the multiply instructions for the MN10300
11435 processors.  This is the default.
11437 @item -mno-mult-bug
11438 @opindex mno-mult-bug
11439 Do not generate code to avoid bugs in the multiply instructions for the
11440 MN10300 processors.
11442 @item -mam33
11443 @opindex mam33
11444 Generate code which uses features specific to the AM33 processor.
11446 @item -mno-am33
11447 @opindex mno-am33
11448 Do not generate code which uses features specific to the AM33 processor.  This
11449 is the default.
11451 @item -mreturn-pointer-on-d0
11452 @opindex mreturn-pointer-on-d0
11453 When generating a function which returns a pointer, return the pointer
11454 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
11455 only in a0, and attempts to call such functions without a prototype
11456 would result in errors.  Note that this option is on by default; use
11457 @option{-mno-return-pointer-on-d0} to disable it.
11459 @item -mno-crt0
11460 @opindex mno-crt0
11461 Do not link in the C run-time initialization object file.
11463 @item -mrelax
11464 @opindex mrelax
11465 Indicate to the linker that it should perform a relaxation optimization pass
11466 to shorten branches, calls and absolute memory addresses.  This option only
11467 has an effect when used on the command line for the final link step.
11469 This option makes symbolic debugging impossible.
11470 @end table
11472 @node MT Options
11473 @subsection MT Options
11474 @cindex MT options
11476 These @option{-m} options are defined for Morpho MT architectures:
11478 @table @gcctabopt
11480 @item -march=@var{cpu-type}
11481 @opindex march
11482 Generate code that will run on @var{cpu-type}, which is the name of a system
11483 representing a certain processor type.  Possible values for
11484 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11485 @samp{ms1-16-003} and @samp{ms2}.
11487 When this option is not used, the default is @option{-march=ms1-16-002}.
11489 @item -mbacc
11490 @opindex mbacc
11491 Use byte loads and stores when generating code.
11493 @item -mno-bacc
11494 @opindex mno-bacc
11495 Do not use byte loads and stores when generating code.
11497 @item -msim
11498 @opindex msim
11499 Use simulator runtime
11501 @item -mno-crt0
11502 @opindex mno-crt0
11503 Do not link in the C run-time initialization object file
11504 @file{crti.o}.  Other run-time initialization and termination files
11505 such as @file{startup.o} and @file{exit.o} are still included on the
11506 linker command line.
11508 @end table
11510 @node PDP-11 Options
11511 @subsection PDP-11 Options
11512 @cindex PDP-11 Options
11514 These options are defined for the PDP-11:
11516 @table @gcctabopt
11517 @item -mfpu
11518 @opindex mfpu
11519 Use hardware FPP floating point.  This is the default.  (FIS floating
11520 point on the PDP-11/40 is not supported.)
11522 @item -msoft-float
11523 @opindex msoft-float
11524 Do not use hardware floating point.
11526 @item -mac0
11527 @opindex mac0
11528 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11530 @item -mno-ac0
11531 @opindex mno-ac0
11532 Return floating-point results in memory.  This is the default.
11534 @item -m40
11535 @opindex m40
11536 Generate code for a PDP-11/40.
11538 @item -m45
11539 @opindex m45
11540 Generate code for a PDP-11/45.  This is the default.
11542 @item -m10
11543 @opindex m10
11544 Generate code for a PDP-11/10.
11546 @item -mbcopy-builtin
11547 @opindex bcopy-builtin
11548 Use inline @code{movmemhi} patterns for copying memory.  This is the
11549 default.
11551 @item -mbcopy
11552 @opindex mbcopy
11553 Do not use inline @code{movmemhi} patterns for copying memory.
11555 @item -mint16
11556 @itemx -mno-int32
11557 @opindex mint16
11558 @opindex mno-int32
11559 Use 16-bit @code{int}.  This is the default.
11561 @item -mint32
11562 @itemx -mno-int16
11563 @opindex mint32
11564 @opindex mno-int16
11565 Use 32-bit @code{int}.
11567 @item -mfloat64
11568 @itemx -mno-float32
11569 @opindex mfloat64
11570 @opindex mno-float32
11571 Use 64-bit @code{float}.  This is the default.
11573 @item -mfloat32
11574 @itemx -mno-float64
11575 @opindex mfloat32
11576 @opindex mno-float64
11577 Use 32-bit @code{float}.
11579 @item -mabshi
11580 @opindex mabshi
11581 Use @code{abshi2} pattern.  This is the default.
11583 @item -mno-abshi
11584 @opindex mno-abshi
11585 Do not use @code{abshi2} pattern.
11587 @item -mbranch-expensive
11588 @opindex mbranch-expensive
11589 Pretend that branches are expensive.  This is for experimenting with
11590 code generation only.
11592 @item -mbranch-cheap
11593 @opindex mbranch-cheap
11594 Do not pretend that branches are expensive.  This is the default.
11596 @item -msplit
11597 @opindex msplit
11598 Generate code for a system with split I&D@.
11600 @item -mno-split
11601 @opindex mno-split
11602 Generate code for a system without split I&D@.  This is the default.
11604 @item -munix-asm
11605 @opindex munix-asm
11606 Use Unix assembler syntax.  This is the default when configured for
11607 @samp{pdp11-*-bsd}.
11609 @item -mdec-asm
11610 @opindex mdec-asm
11611 Use DEC assembler syntax.  This is the default when configured for any
11612 PDP-11 target other than @samp{pdp11-*-bsd}.
11613 @end table
11615 @node PowerPC Options
11616 @subsection PowerPC Options
11617 @cindex PowerPC options
11619 These are listed under @xref{RS/6000 and PowerPC Options}.
11621 @node RS/6000 and PowerPC Options
11622 @subsection IBM RS/6000 and PowerPC Options
11623 @cindex RS/6000 and PowerPC Options
11624 @cindex IBM RS/6000 and PowerPC Options
11626 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11627 @table @gcctabopt
11628 @item -mpower
11629 @itemx -mno-power
11630 @itemx -mpower2
11631 @itemx -mno-power2
11632 @itemx -mpowerpc
11633 @itemx -mno-powerpc
11634 @itemx -mpowerpc-gpopt
11635 @itemx -mno-powerpc-gpopt
11636 @itemx -mpowerpc-gfxopt
11637 @itemx -mno-powerpc-gfxopt
11638 @itemx -mpowerpc64
11639 @itemx -mno-powerpc64
11640 @itemx -mmfcrf
11641 @itemx -mno-mfcrf
11642 @itemx -mpopcntb
11643 @itemx -mno-popcntb
11644 @itemx -mfprnd
11645 @itemx -mno-fprnd
11646 @itemx -mmfpgpr
11647 @itemx -mno-mfpgpr
11648 @opindex mpower
11649 @opindex mno-power
11650 @opindex mpower2
11651 @opindex mno-power2
11652 @opindex mpowerpc
11653 @opindex mno-powerpc
11654 @opindex mpowerpc-gpopt
11655 @opindex mno-powerpc-gpopt
11656 @opindex mpowerpc-gfxopt
11657 @opindex mno-powerpc-gfxopt
11658 @opindex mpowerpc64
11659 @opindex mno-powerpc64
11660 @opindex mmfcrf
11661 @opindex mno-mfcrf
11662 @opindex mpopcntb
11663 @opindex mno-popcntb
11664 @opindex mfprnd
11665 @opindex mno-fprnd
11666 @opindex mmfpgpr
11667 @opindex mno-mfpgpr
11668 GCC supports two related instruction set architectures for the
11669 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11670 instructions supported by the @samp{rios} chip set used in the original
11671 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11672 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11673 the IBM 4xx, 6xx, and follow-on microprocessors.
11675 Neither architecture is a subset of the other.  However there is a
11676 large common subset of instructions supported by both.  An MQ
11677 register is included in processors supporting the POWER architecture.
11679 You use these options to specify which instructions are available on the
11680 processor you are using.  The default value of these options is
11681 determined when configuring GCC@.  Specifying the
11682 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11683 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11684 rather than the options listed above.
11686 The @option{-mpower} option allows GCC to generate instructions that
11687 are found only in the POWER architecture and to use the MQ register.
11688 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11689 to generate instructions that are present in the POWER2 architecture but
11690 not the original POWER architecture.
11692 The @option{-mpowerpc} option allows GCC to generate instructions that
11693 are found only in the 32-bit subset of the PowerPC architecture.
11694 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11695 GCC to use the optional PowerPC architecture instructions in the
11696 General Purpose group, including floating-point square root.  Specifying
11697 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11698 use the optional PowerPC architecture instructions in the Graphics
11699 group, including floating-point select.
11701 The @option{-mmfcrf} option allows GCC to generate the move from
11702 condition register field instruction implemented on the POWER4
11703 processor and other processors that support the PowerPC V2.01
11704 architecture.
11705 The @option{-mpopcntb} option allows GCC to generate the popcount and
11706 double precision FP reciprocal estimate instruction implemented on the
11707 POWER5 processor and other processors that support the PowerPC V2.02
11708 architecture.
11709 The @option{-mfprnd} option allows GCC to generate the FP round to
11710 integer instructions implemented on the POWER5+ processor and other
11711 processors that support the PowerPC V2.03 architecture.
11712 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
11713 general purpose register instructions implemented on the POWER6X
11714 processor and other processors that support the extended PowerPC V2.05
11715 architecture.
11717 The @option{-mpowerpc64} option allows GCC to generate the additional
11718 64-bit instructions that are found in the full PowerPC64 architecture
11719 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11720 @option{-mno-powerpc64}.
11722 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11723 will use only the instructions in the common subset of both
11724 architectures plus some special AIX common-mode calls, and will not use
11725 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11726 permits GCC to use any instruction from either architecture and to
11727 allow use of the MQ register; specify this for the Motorola MPC601.
11729 @item -mnew-mnemonics
11730 @itemx -mold-mnemonics
11731 @opindex mnew-mnemonics
11732 @opindex mold-mnemonics
11733 Select which mnemonics to use in the generated assembler code.  With
11734 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11735 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11736 assembler mnemonics defined for the POWER architecture.  Instructions
11737 defined in only one architecture have only one mnemonic; GCC uses that
11738 mnemonic irrespective of which of these options is specified.
11740 GCC defaults to the mnemonics appropriate for the architecture in
11741 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11742 value of these option.  Unless you are building a cross-compiler, you
11743 should normally not specify either @option{-mnew-mnemonics} or
11744 @option{-mold-mnemonics}, but should instead accept the default.
11746 @item -mcpu=@var{cpu_type}
11747 @opindex mcpu
11748 Set architecture type, register usage, choice of mnemonics, and
11749 instruction scheduling parameters for machine type @var{cpu_type}.
11750 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11751 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11752 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11753 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11754 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11755 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11756 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11757 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11758 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
11759 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11761 @option{-mcpu=common} selects a completely generic processor.  Code
11762 generated under this option will run on any POWER or PowerPC processor.
11763 GCC will use only the instructions in the common subset of both
11764 architectures, and will not use the MQ register.  GCC assumes a generic
11765 processor model for scheduling purposes.
11767 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11768 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11769 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11770 types, with an appropriate, generic processor model assumed for
11771 scheduling purposes.
11773 The other options specify a specific processor.  Code generated under
11774 those options will run best on that processor, and may not run at all on
11775 others.
11777 The @option{-mcpu} options automatically enable or disable the
11778 following options:
11780 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
11781 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
11782 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
11784 The particular options set for any particular CPU will vary between
11785 compiler versions, depending on what setting seems to produce optimal
11786 code for that CPU; it doesn't necessarily reflect the actual hardware's
11787 capabilities.  If you wish to set an individual option to a particular
11788 value, you may specify it after the @option{-mcpu} option, like
11789 @samp{-mcpu=970 -mno-altivec}.
11791 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11792 not enabled or disabled by the @option{-mcpu} option at present because
11793 AIX does not have full support for these options.  You may still
11794 enable or disable them individually if you're sure it'll work in your
11795 environment.
11797 @item -mtune=@var{cpu_type}
11798 @opindex mtune
11799 Set the instruction scheduling parameters for machine type
11800 @var{cpu_type}, but do not set the architecture type, register usage, or
11801 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11802 values for @var{cpu_type} are used for @option{-mtune} as for
11803 @option{-mcpu}.  If both are specified, the code generated will use the
11804 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11805 scheduling parameters set by @option{-mtune}.
11807 @item -mswdiv
11808 @itemx -mno-swdiv
11809 @opindex mswdiv
11810 @opindex mno-swdiv
11811 Generate code to compute division as reciprocal estimate and iterative
11812 refinement, creating opportunities for increased throughput.  This
11813 feature requires: optional PowerPC Graphics instruction set for single
11814 precision and FRE instruction for double precision, assuming divides
11815 cannot generate user-visible traps, and the domain values not include
11816 Infinities, denormals or zero denominator.
11818 @item -maltivec
11819 @itemx -mno-altivec
11820 @opindex maltivec
11821 @opindex mno-altivec
11822 Generate code that uses (does not use) AltiVec instructions, and also
11823 enable the use of built-in functions that allow more direct access to
11824 the AltiVec instruction set.  You may also need to set
11825 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11826 enhancements.
11828 @item -mvrsave
11829 @item -mno-vrsave
11830 @opindex mvrsave
11831 @opindex mno-vrsave
11832 Generate VRSAVE instructions when generating AltiVec code.
11834 @item -msecure-plt
11835 @opindex msecure-plt
11836 Generate code that allows ld and ld.so to build executables and shared
11837 libraries with non-exec .plt and .got sections.  This is a PowerPC
11838 32-bit SYSV ABI option.
11840 @item -mbss-plt
11841 @opindex mbss-plt
11842 Generate code that uses a BSS .plt section that ld.so fills in, and
11843 requires .plt and .got sections that are both writable and executable.
11844 This is a PowerPC 32-bit SYSV ABI option.
11846 @item -misel
11847 @itemx -mno-isel
11848 @opindex misel
11849 @opindex mno-isel
11850 This switch enables or disables the generation of ISEL instructions.
11852 @item -misel=@var{yes/no}
11853 This switch has been deprecated.  Use @option{-misel} and
11854 @option{-mno-isel} instead.
11856 @item -mspe
11857 @itemx -mno-spe
11858 @opindex mspe
11859 @opindex mno-spe
11860 This switch enables or disables the generation of SPE simd
11861 instructions.
11863 @item -mspe=@var{yes/no}
11864 This option has been deprecated.  Use @option{-mspe} and
11865 @option{-mno-spe} instead.
11867 @item -mfloat-gprs=@var{yes/single/double/no}
11868 @itemx -mfloat-gprs
11869 @opindex mfloat-gprs
11870 This switch enables or disables the generation of floating point
11871 operations on the general purpose registers for architectures that
11872 support it.
11874 The argument @var{yes} or @var{single} enables the use of
11875 single-precision floating point operations.
11877 The argument @var{double} enables the use of single and
11878 double-precision floating point operations.
11880 The argument @var{no} disables floating point operations on the
11881 general purpose registers.
11883 This option is currently only available on the MPC854x.
11885 @item -m32
11886 @itemx -m64
11887 @opindex m32
11888 @opindex m64
11889 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11890 targets (including GNU/Linux).  The 32-bit environment sets int, long
11891 and pointer to 32 bits and generates code that runs on any PowerPC
11892 variant.  The 64-bit environment sets int to 32 bits and long and
11893 pointer to 64 bits, and generates code for PowerPC64, as for
11894 @option{-mpowerpc64}.
11896 @item -mfull-toc
11897 @itemx -mno-fp-in-toc
11898 @itemx -mno-sum-in-toc
11899 @itemx -mminimal-toc
11900 @opindex mfull-toc
11901 @opindex mno-fp-in-toc
11902 @opindex mno-sum-in-toc
11903 @opindex mminimal-toc
11904 Modify generation of the TOC (Table Of Contents), which is created for
11905 every executable file.  The @option{-mfull-toc} option is selected by
11906 default.  In that case, GCC will allocate at least one TOC entry for
11907 each unique non-automatic variable reference in your program.  GCC
11908 will also place floating-point constants in the TOC@.  However, only
11909 16,384 entries are available in the TOC@.
11911 If you receive a linker error message that saying you have overflowed
11912 the available TOC space, you can reduce the amount of TOC space used
11913 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11914 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11915 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11916 generate code to calculate the sum of an address and a constant at
11917 run-time instead of putting that sum into the TOC@.  You may specify one
11918 or both of these options.  Each causes GCC to produce very slightly
11919 slower and larger code at the expense of conserving TOC space.
11921 If you still run out of space in the TOC even when you specify both of
11922 these options, specify @option{-mminimal-toc} instead.  This option causes
11923 GCC to make only one TOC entry for every file.  When you specify this
11924 option, GCC will produce code that is slower and larger but which
11925 uses extremely little TOC space.  You may wish to use this option
11926 only on files that contain less frequently executed code.
11928 @item -maix64
11929 @itemx -maix32
11930 @opindex maix64
11931 @opindex maix32
11932 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11933 @code{long} type, and the infrastructure needed to support them.
11934 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11935 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11936 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11938 @item -mxl-compat
11939 @itemx -mno-xl-compat
11940 @opindex mxl-compat
11941 @opindex mno-xl-compat
11942 Produce code that conforms more closely to IBM XL compiler semantics
11943 when using AIX-compatible ABI.  Pass floating-point arguments to
11944 prototyped functions beyond the register save area (RSA) on the stack
11945 in addition to argument FPRs.  Do not assume that most significant
11946 double in 128-bit long double value is properly rounded when comparing
11947 values and converting to double.  Use XL symbol names for long double
11948 support routines.
11950 The AIX calling convention was extended but not initially documented to
11951 handle an obscure K&R C case of calling a function that takes the
11952 address of its arguments with fewer arguments than declared.  IBM XL
11953 compilers access floating point arguments which do not fit in the
11954 RSA from the stack when a subroutine is compiled without
11955 optimization.  Because always storing floating-point arguments on the
11956 stack is inefficient and rarely needed, this option is not enabled by
11957 default and only is necessary when calling subroutines compiled by IBM
11958 XL compilers without optimization.
11960 @item -mpe
11961 @opindex mpe
11962 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11963 application written to use message passing with special startup code to
11964 enable the application to run.  The system must have PE installed in the
11965 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11966 must be overridden with the @option{-specs=} option to specify the
11967 appropriate directory location.  The Parallel Environment does not
11968 support threads, so the @option{-mpe} option and the @option{-pthread}
11969 option are incompatible.
11971 @item -malign-natural
11972 @itemx -malign-power
11973 @opindex malign-natural
11974 @opindex malign-power
11975 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11976 @option{-malign-natural} overrides the ABI-defined alignment of larger
11977 types, such as floating-point doubles, on their natural size-based boundary.
11978 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11979 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11981 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11982 is not supported.
11984 @item -msoft-float
11985 @itemx -mhard-float
11986 @opindex msoft-float
11987 @opindex mhard-float
11988 Generate code that does not use (uses) the floating-point register set.
11989 Software floating point emulation is provided if you use the
11990 @option{-msoft-float} option, and pass the option to GCC when linking.
11992 @item -mmultiple
11993 @itemx -mno-multiple
11994 @opindex mmultiple
11995 @opindex mno-multiple
11996 Generate code that uses (does not use) the load multiple word
11997 instructions and the store multiple word instructions.  These
11998 instructions are generated by default on POWER systems, and not
11999 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
12000 endian PowerPC systems, since those instructions do not work when the
12001 processor is in little endian mode.  The exceptions are PPC740 and
12002 PPC750 which permit the instructions usage in little endian mode.
12004 @item -mstring
12005 @itemx -mno-string
12006 @opindex mstring
12007 @opindex mno-string
12008 Generate code that uses (does not use) the load string instructions
12009 and the store string word instructions to save multiple registers and
12010 do small block moves.  These instructions are generated by default on
12011 POWER systems, and not generated on PowerPC systems.  Do not use
12012 @option{-mstring} on little endian PowerPC systems, since those
12013 instructions do not work when the processor is in little endian mode.
12014 The exceptions are PPC740 and PPC750 which permit the instructions
12015 usage in little endian mode.
12017 @item -mupdate
12018 @itemx -mno-update
12019 @opindex mupdate
12020 @opindex mno-update
12021 Generate code that uses (does not use) the load or store instructions
12022 that update the base register to the address of the calculated memory
12023 location.  These instructions are generated by default.  If you use
12024 @option{-mno-update}, there is a small window between the time that the
12025 stack pointer is updated and the address of the previous frame is
12026 stored, which means code that walks the stack frame across interrupts or
12027 signals may get corrupted data.
12029 @item -mfused-madd
12030 @itemx -mno-fused-madd
12031 @opindex mfused-madd
12032 @opindex mno-fused-madd
12033 Generate code that uses (does not use) the floating point multiply and
12034 accumulate instructions.  These instructions are generated by default if
12035 hardware floating is used.
12037 @item -mmulhw
12038 @itemx -mno-mulhw
12039 @opindex mmulhw
12040 @opindex mno-mulhw
12041 Generate code that uses (does not use) the half-word multiply and
12042 multiply-accumulate instructions on the IBM 405 and 440 processors.
12043 These instructions are generated by default when targetting those
12044 processors.
12046 @item -mdlmzb
12047 @itemx -mno-dlmzb
12048 @opindex mdlmzb
12049 @opindex mno-dlmzb
12050 Generate code that uses (does not use) the string-search @samp{dlmzb}
12051 instruction on the IBM 405 and 440 processors.  This instruction is
12052 generated by default when targetting those processors.
12054 @item -mno-bit-align
12055 @itemx -mbit-align
12056 @opindex mno-bit-align
12057 @opindex mbit-align
12058 On System V.4 and embedded PowerPC systems do not (do) force structures
12059 and unions that contain bit-fields to be aligned to the base type of the
12060 bit-field.
12062 For example, by default a structure containing nothing but 8
12063 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
12064 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
12065 the structure would be aligned to a 1 byte boundary and be one byte in
12066 size.
12068 @item -mno-strict-align
12069 @itemx -mstrict-align
12070 @opindex mno-strict-align
12071 @opindex mstrict-align
12072 On System V.4 and embedded PowerPC systems do not (do) assume that
12073 unaligned memory references will be handled by the system.
12075 @item -mrelocatable
12076 @itemx -mno-relocatable
12077 @opindex mrelocatable
12078 @opindex mno-relocatable
12079 On embedded PowerPC systems generate code that allows (does not allow)
12080 the program to be relocated to a different address at runtime.  If you
12081 use @option{-mrelocatable} on any module, all objects linked together must
12082 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
12084 @item -mrelocatable-lib
12085 @itemx -mno-relocatable-lib
12086 @opindex mrelocatable-lib
12087 @opindex mno-relocatable-lib
12088 On embedded PowerPC systems generate code that allows (does not allow)
12089 the program to be relocated to a different address at runtime.  Modules
12090 compiled with @option{-mrelocatable-lib} can be linked with either modules
12091 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
12092 with modules compiled with the @option{-mrelocatable} options.
12094 @item -mno-toc
12095 @itemx -mtoc
12096 @opindex mno-toc
12097 @opindex mtoc
12098 On System V.4 and embedded PowerPC systems do not (do) assume that
12099 register 2 contains a pointer to a global area pointing to the addresses
12100 used in the program.
12102 @item -mlittle
12103 @itemx -mlittle-endian
12104 @opindex mlittle
12105 @opindex mlittle-endian
12106 On System V.4 and embedded PowerPC systems compile code for the
12107 processor in little endian mode.  The @option{-mlittle-endian} option is
12108 the same as @option{-mlittle}.
12110 @item -mbig
12111 @itemx -mbig-endian
12112 @opindex mbig
12113 @opindex mbig-endian
12114 On System V.4 and embedded PowerPC systems compile code for the
12115 processor in big endian mode.  The @option{-mbig-endian} option is
12116 the same as @option{-mbig}.
12118 @item -mdynamic-no-pic
12119 @opindex mdynamic-no-pic
12120 On Darwin and Mac OS X systems, compile code so that it is not
12121 relocatable, but that its external references are relocatable.  The
12122 resulting code is suitable for applications, but not shared
12123 libraries.
12125 @item -mprioritize-restricted-insns=@var{priority}
12126 @opindex mprioritize-restricted-insns
12127 This option controls the priority that is assigned to
12128 dispatch-slot restricted instructions during the second scheduling
12129 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
12130 @var{no/highest/second-highest} priority to dispatch slot restricted
12131 instructions.
12133 @item -msched-costly-dep=@var{dependence_type}
12134 @opindex msched-costly-dep
12135 This option controls which dependences are considered costly
12136 by the target during instruction scheduling.  The argument
12137 @var{dependence_type} takes one of the following values:
12138 @var{no}: no dependence is costly,
12139 @var{all}: all dependences are costly,
12140 @var{true_store_to_load}: a true dependence from store to load is costly,
12141 @var{store_to_load}: any dependence from store to load is costly,
12142 @var{number}: any dependence which latency >= @var{number} is costly.
12144 @item -minsert-sched-nops=@var{scheme}
12145 @opindex minsert-sched-nops
12146 This option controls which nop insertion scheme will be used during
12147 the second scheduling pass.  The argument @var{scheme} takes one of the
12148 following values:
12149 @var{no}: Don't insert nops.
12150 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
12151 according to the scheduler's grouping.
12152 @var{regroup_exact}: Insert nops to force costly dependent insns into
12153 separate groups.  Insert exactly as many nops as needed to force an insn
12154 to a new group, according to the estimated processor grouping.
12155 @var{number}: Insert nops to force costly dependent insns into
12156 separate groups.  Insert @var{number} nops to force an insn to a new group.
12158 @item -mcall-sysv
12159 @opindex mcall-sysv
12160 On System V.4 and embedded PowerPC systems compile code using calling
12161 conventions that adheres to the March 1995 draft of the System V
12162 Application Binary Interface, PowerPC processor supplement.  This is the
12163 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
12165 @item -mcall-sysv-eabi
12166 @opindex mcall-sysv-eabi
12167 Specify both @option{-mcall-sysv} and @option{-meabi} options.
12169 @item -mcall-sysv-noeabi
12170 @opindex mcall-sysv-noeabi
12171 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
12173 @item -mcall-solaris
12174 @opindex mcall-solaris
12175 On System V.4 and embedded PowerPC systems compile code for the Solaris
12176 operating system.
12178 @item -mcall-linux
12179 @opindex mcall-linux
12180 On System V.4 and embedded PowerPC systems compile code for the
12181 Linux-based GNU system.
12183 @item -mcall-gnu
12184 @opindex mcall-gnu
12185 On System V.4 and embedded PowerPC systems compile code for the
12186 Hurd-based GNU system.
12188 @item -mcall-netbsd
12189 @opindex mcall-netbsd
12190 On System V.4 and embedded PowerPC systems compile code for the
12191 NetBSD operating system.
12193 @item -maix-struct-return
12194 @opindex maix-struct-return
12195 Return all structures in memory (as specified by the AIX ABI)@.
12197 @item -msvr4-struct-return
12198 @opindex msvr4-struct-return
12199 Return structures smaller than 8 bytes in registers (as specified by the
12200 SVR4 ABI)@.
12202 @item -mabi=@var{abi-type}
12203 @opindex mabi
12204 Extend the current ABI with a particular extension, or remove such extension.
12205 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
12206 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
12208 @item -mabi=spe
12209 @opindex mabi=spe
12210 Extend the current ABI with SPE ABI extensions.  This does not change
12211 the default ABI, instead it adds the SPE ABI extensions to the current
12212 ABI@.
12214 @item -mabi=no-spe
12215 @opindex mabi=no-spe
12216 Disable Booke SPE ABI extensions for the current ABI@.
12218 @item -mabi=ibmlongdouble
12219 @opindex mabi=ibmlongdouble
12220 Change the current ABI to use IBM extended precision long double.
12221 This is a PowerPC 32-bit SYSV ABI option.
12223 @item -mabi=ieeelongdouble
12224 @opindex mabi=ieeelongdouble
12225 Change the current ABI to use IEEE extended precision long double.
12226 This is a PowerPC 32-bit Linux ABI option.
12228 @item -mprototype
12229 @itemx -mno-prototype
12230 @opindex mprototype
12231 @opindex mno-prototype
12232 On System V.4 and embedded PowerPC systems assume that all calls to
12233 variable argument functions are properly prototyped.  Otherwise, the
12234 compiler must insert an instruction before every non prototyped call to
12235 set or clear bit 6 of the condition code register (@var{CR}) to
12236 indicate whether floating point values were passed in the floating point
12237 registers in case the function takes a variable arguments.  With
12238 @option{-mprototype}, only calls to prototyped variable argument functions
12239 will set or clear the bit.
12241 @item -msim
12242 @opindex msim
12243 On embedded PowerPC systems, assume that the startup module is called
12244 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
12245 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
12246 configurations.
12248 @item -mmvme
12249 @opindex mmvme
12250 On embedded PowerPC systems, assume that the startup module is called
12251 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
12252 @file{libc.a}.
12254 @item -mads
12255 @opindex mads
12256 On embedded PowerPC systems, assume that the startup module is called
12257 @file{crt0.o} and the standard C libraries are @file{libads.a} and
12258 @file{libc.a}.
12260 @item -myellowknife
12261 @opindex myellowknife
12262 On embedded PowerPC systems, assume that the startup module is called
12263 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
12264 @file{libc.a}.
12266 @item -mvxworks
12267 @opindex mvxworks
12268 On System V.4 and embedded PowerPC systems, specify that you are
12269 compiling for a VxWorks system.
12271 @item -mwindiss
12272 @opindex mwindiss
12273 Specify that you are compiling for the WindISS simulation environment.
12275 @item -memb
12276 @opindex memb
12277 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
12278 header to indicate that @samp{eabi} extended relocations are used.
12280 @item -meabi
12281 @itemx -mno-eabi
12282 @opindex meabi
12283 @opindex mno-eabi
12284 On System V.4 and embedded PowerPC systems do (do not) adhere to the
12285 Embedded Applications Binary Interface (eabi) which is a set of
12286 modifications to the System V.4 specifications.  Selecting @option{-meabi}
12287 means that the stack is aligned to an 8 byte boundary, a function
12288 @code{__eabi} is called to from @code{main} to set up the eabi
12289 environment, and the @option{-msdata} option can use both @code{r2} and
12290 @code{r13} to point to two separate small data areas.  Selecting
12291 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
12292 do not call an initialization function from @code{main}, and the
12293 @option{-msdata} option will only use @code{r13} to point to a single
12294 small data area.  The @option{-meabi} option is on by default if you
12295 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
12297 @item -msdata=eabi
12298 @opindex msdata=eabi
12299 On System V.4 and embedded PowerPC systems, put small initialized
12300 @code{const} global and static data in the @samp{.sdata2} section, which
12301 is pointed to by register @code{r2}.  Put small initialized
12302 non-@code{const} global and static data in the @samp{.sdata} section,
12303 which is pointed to by register @code{r13}.  Put small uninitialized
12304 global and static data in the @samp{.sbss} section, which is adjacent to
12305 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
12306 incompatible with the @option{-mrelocatable} option.  The
12307 @option{-msdata=eabi} option also sets the @option{-memb} option.
12309 @item -msdata=sysv
12310 @opindex msdata=sysv
12311 On System V.4 and embedded PowerPC systems, put small global and static
12312 data in the @samp{.sdata} section, which is pointed to by register
12313 @code{r13}.  Put small uninitialized global and static data in the
12314 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12315 The @option{-msdata=sysv} option is incompatible with the
12316 @option{-mrelocatable} option.
12318 @item -msdata=default
12319 @itemx -msdata
12320 @opindex msdata=default
12321 @opindex msdata
12322 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12323 compile code the same as @option{-msdata=eabi}, otherwise compile code the
12324 same as @option{-msdata=sysv}.
12326 @item -msdata-data
12327 @opindex msdata-data
12328 On System V.4 and embedded PowerPC systems, put small global
12329 data in the @samp{.sdata} section.  Put small uninitialized global
12330 data in the @samp{.sbss} section.  Do not use register @code{r13}
12331 to address small data however.  This is the default behavior unless
12332 other @option{-msdata} options are used.
12334 @item -msdata=none
12335 @itemx -mno-sdata
12336 @opindex msdata=none
12337 @opindex mno-sdata
12338 On embedded PowerPC systems, put all initialized global and static data
12339 in the @samp{.data} section, and all uninitialized data in the
12340 @samp{.bss} section.
12342 @item -G @var{num}
12343 @opindex G
12344 @cindex smaller data references (PowerPC)
12345 @cindex .sdata/.sdata2 references (PowerPC)
12346 On embedded PowerPC systems, put global and static items less than or
12347 equal to @var{num} bytes into the small data or bss sections instead of
12348 the normal data or bss section.  By default, @var{num} is 8.  The
12349 @option{-G @var{num}} switch is also passed to the linker.
12350 All modules should be compiled with the same @option{-G @var{num}} value.
12352 @item -mregnames
12353 @itemx -mno-regnames
12354 @opindex mregnames
12355 @opindex mno-regnames
12356 On System V.4 and embedded PowerPC systems do (do not) emit register
12357 names in the assembly language output using symbolic forms.
12359 @item -mlongcall
12360 @itemx -mno-longcall
12361 @opindex mlongcall
12362 @opindex mno-longcall
12363 By default assume that all calls are far away so that a longer more
12364 expensive calling sequence is required.  This is required for calls
12365 further than 32 megabytes (33,554,432 bytes) from the current location.
12366 A short call will be generated if the compiler knows
12367 the call cannot be that far away.  This setting can be overridden by
12368 the @code{shortcall} function attribute, or by @code{#pragma
12369 longcall(0)}.
12371 Some linkers are capable of detecting out-of-range calls and generating
12372 glue code on the fly.  On these systems, long calls are unnecessary and
12373 generate slower code.  As of this writing, the AIX linker can do this,
12374 as can the GNU linker for PowerPC/64.  It is planned to add this feature
12375 to the GNU linker for 32-bit PowerPC systems as well.
12377 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12378 callee, L42'', plus a ``branch island'' (glue code).  The two target
12379 addresses represent the callee and the ``branch island''.  The
12380 Darwin/PPC linker will prefer the first address and generate a ``bl
12381 callee'' if the PPC ``bl'' instruction will reach the callee directly;
12382 otherwise, the linker will generate ``bl L42'' to call the ``branch
12383 island''.  The ``branch island'' is appended to the body of the
12384 calling function; it computes the full 32-bit address of the callee
12385 and jumps to it.
12387 On Mach-O (Darwin) systems, this option directs the compiler emit to
12388 the glue for every direct call, and the Darwin linker decides whether
12389 to use or discard it.
12391 In the future, we may cause GCC to ignore all longcall specifications
12392 when the linker is known to generate glue.
12394 @item -pthread
12395 @opindex pthread
12396 Adds support for multithreading with the @dfn{pthreads} library.
12397 This option sets flags for both the preprocessor and linker.
12399 @end table
12401 @node S/390 and zSeries Options
12402 @subsection S/390 and zSeries Options
12403 @cindex S/390 and zSeries Options
12405 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
12407 @table @gcctabopt
12408 @item -mhard-float
12409 @itemx -msoft-float
12410 @opindex mhard-float
12411 @opindex msoft-float
12412 Use (do not use) the hardware floating-point instructions and registers
12413 for floating-point operations.  When @option{-msoft-float} is specified,
12414 functions in @file{libgcc.a} will be used to perform floating-point
12415 operations.  When @option{-mhard-float} is specified, the compiler
12416 generates IEEE floating-point instructions.  This is the default.
12418 @item -mlong-double-64
12419 @itemx -mlong-double-128
12420 @opindex mlong-double-64
12421 @opindex mlong-double-128
12422 These switches control the size of @code{long double} type. A size
12423 of 64bit makes the @code{long double} type equivalent to the @code{double}
12424 type. This is the default.
12426 @item -mbackchain
12427 @itemx -mno-backchain
12428 @opindex mbackchain
12429 @opindex mno-backchain
12430 Store (do not store) the address of the caller's frame as backchain pointer
12431 into the callee's stack frame.
12432 A backchain may be needed to allow debugging using tools that do not understand
12433 DWARF-2 call frame information.
12434 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12435 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12436 the backchain is placed into the topmost word of the 96/160 byte register
12437 save area.
12439 In general, code compiled with @option{-mbackchain} is call-compatible with
12440 code compiled with @option{-mmo-backchain}; however, use of the backchain
12441 for debugging purposes usually requires that the whole binary is built with
12442 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
12443 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12444 to build a linux kernel use @option{-msoft-float}.
12446 The default is to not maintain the backchain.
12448 @item -mpacked-stack
12449 @item -mno-packed-stack
12450 @opindex mpacked-stack
12451 @opindex mno-packed-stack
12452 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
12453 specified, the compiler uses the all fields of the 96/160 byte register save
12454 area only for their default purpose; unused fields still take up stack space.
12455 When @option{-mpacked-stack} is specified, register save slots are densely
12456 packed at the top of the register save area; unused space is reused for other
12457 purposes, allowing for more efficient use of the available stack space.
12458 However, when @option{-mbackchain} is also in effect, the topmost word of
12459 the save area is always used to store the backchain, and the return address
12460 register is always saved two words below the backchain.
12462 As long as the stack frame backchain is not used, code generated with
12463 @option{-mpacked-stack} is call-compatible with code generated with
12464 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
12465 S/390 or zSeries generated code that uses the stack frame backchain at run
12466 time, not just for debugging purposes.  Such code is not call-compatible
12467 with code compiled with @option{-mpacked-stack}.  Also, note that the
12468 combination of @option{-mbackchain},
12469 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12470 to build a linux kernel use @option{-msoft-float}.
12472 The default is to not use the packed stack layout.
12474 @item -msmall-exec
12475 @itemx -mno-small-exec
12476 @opindex msmall-exec
12477 @opindex mno-small-exec
12478 Generate (or do not generate) code using the @code{bras} instruction
12479 to do subroutine calls.
12480 This only works reliably if the total executable size does not
12481 exceed 64k.  The default is to use the @code{basr} instruction instead,
12482 which does not have this limitation.
12484 @item -m64
12485 @itemx -m31
12486 @opindex m64
12487 @opindex m31
12488 When @option{-m31} is specified, generate code compliant to the
12489 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
12490 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
12491 particular to generate 64-bit instructions.  For the @samp{s390}
12492 targets, the default is @option{-m31}, while the @samp{s390x}
12493 targets default to @option{-m64}.
12495 @item -mzarch
12496 @itemx -mesa
12497 @opindex mzarch
12498 @opindex mesa
12499 When @option{-mzarch} is specified, generate code using the
12500 instructions available on z/Architecture.
12501 When @option{-mesa} is specified, generate code using the
12502 instructions available on ESA/390.  Note that @option{-mesa} is
12503 not possible with @option{-m64}.
12504 When generating code compliant to the GNU/Linux for S/390 ABI,
12505 the default is @option{-mesa}.  When generating code compliant
12506 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12508 @item -mmvcle
12509 @itemx -mno-mvcle
12510 @opindex mmvcle
12511 @opindex mno-mvcle
12512 Generate (or do not generate) code using the @code{mvcle} instruction
12513 to perform block moves.  When @option{-mno-mvcle} is specified,
12514 use a @code{mvc} loop instead.  This is the default unless optimizing for
12515 size.
12517 @item -mdebug
12518 @itemx -mno-debug
12519 @opindex mdebug
12520 @opindex mno-debug
12521 Print (or do not print) additional debug information when compiling.
12522 The default is to not print debug information.
12524 @item -march=@var{cpu-type}
12525 @opindex march
12526 Generate code that will run on @var{cpu-type}, which is the name of a system
12527 representing a certain processor type.  Possible values for
12528 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12529 When generating code using the instructions available on z/Architecture,
12530 the default is @option{-march=z900}.  Otherwise, the default is
12531 @option{-march=g5}.
12533 @item -mtune=@var{cpu-type}
12534 @opindex mtune
12535 Tune to @var{cpu-type} everything applicable about the generated code,
12536 except for the ABI and the set of available instructions.
12537 The list of @var{cpu-type} values is the same as for @option{-march}.
12538 The default is the value used for @option{-march}.
12540 @item -mtpf-trace
12541 @itemx -mno-tpf-trace
12542 @opindex mtpf-trace
12543 @opindex mno-tpf-trace
12544 Generate code that adds (does not add) in TPF OS specific branches to trace
12545 routines in the operating system.  This option is off by default, even
12546 when compiling for the TPF OS@.
12548 @item -mfused-madd
12549 @itemx -mno-fused-madd
12550 @opindex mfused-madd
12551 @opindex mno-fused-madd
12552 Generate code that uses (does not use) the floating point multiply and
12553 accumulate instructions.  These instructions are generated by default if
12554 hardware floating point is used.
12556 @item -mwarn-framesize=@var{framesize}
12557 @opindex mwarn-framesize
12558 Emit a warning if the current function exceeds the given frame size.  Because
12559 this is a compile time check it doesn't need to be a real problem when the program
12560 runs.  It is intended to identify functions which most probably cause
12561 a stack overflow.  It is useful to be used in an environment with limited stack
12562 size e.g.@: the linux kernel.
12564 @item -mwarn-dynamicstack
12565 @opindex mwarn-dynamicstack
12566 Emit a warning if the function calls alloca or uses dynamically
12567 sized arrays.  This is generally a bad idea with a limited stack size.
12569 @item -mstack-guard=@var{stack-guard}
12570 @item -mstack-size=@var{stack-size}
12571 @opindex mstack-guard
12572 @opindex mstack-size
12573 These arguments always have to be used in conjunction.  If they are present the s390
12574 back end emits additional instructions in the function prologue which trigger a trap
12575 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12576 (remember that the stack on s390 grows downward).  These options are intended to
12577 be used to help debugging stack overflow problems.  The additionally emitted code
12578 causes only little overhead and hence can also be used in production like systems
12579 without greater performance degradation.  The given values have to be exact
12580 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12581 exceeding 64k.
12582 In order to be efficient the extra code makes the assumption that the stack starts
12583 at an address aligned to the value given by @var{stack-size}.
12584 @end table
12586 @node Score Options
12587 @subsection Score Options
12588 @cindex Score Options
12590 These options are defined for Score implementations:
12592 @table @gcctabopt
12593 @item -mel
12594 @opindex -mel
12595 Compile code for little endian mode. 
12597 @item -meb
12598 @opindex meb
12599 Compile code for big endian mode.  This is the default.
12601 @item -mmac
12602 @opindex mmac
12603 Enable the use of multiply-accumulate instructions. Disabled by default. 
12605 @item -mscore5u
12606 @opindex mscore5u
12607 Specify the SCORE5U of the target architecture.
12609 @item -mscore7
12610 @opindex mscore7
12611 Specify the SCORE7 of the target architecture. This is the default.
12612 @end table
12614 @node SH Options
12615 @subsection SH Options
12617 These @samp{-m} options are defined for the SH implementations:
12619 @table @gcctabopt
12620 @item -m1
12621 @opindex m1
12622 Generate code for the SH1.
12624 @item -m2
12625 @opindex m2
12626 Generate code for the SH2.
12628 @item -m2e
12629 Generate code for the SH2e.
12631 @item -m3
12632 @opindex m3
12633 Generate code for the SH3.
12635 @item -m3e
12636 @opindex m3e
12637 Generate code for the SH3e.
12639 @item -m4-nofpu
12640 @opindex m4-nofpu
12641 Generate code for the SH4 without a floating-point unit.
12643 @item -m4-single-only
12644 @opindex m4-single-only
12645 Generate code for the SH4 with a floating-point unit that only
12646 supports single-precision arithmetic.
12648 @item -m4-single
12649 @opindex m4-single
12650 Generate code for the SH4 assuming the floating-point unit is in
12651 single-precision mode by default.
12653 @item -m4
12654 @opindex m4
12655 Generate code for the SH4.
12657 @item -m4a-nofpu
12658 @opindex m4a-nofpu
12659 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12660 floating-point unit is not used.
12662 @item -m4a-single-only
12663 @opindex m4a-single-only
12664 Generate code for the SH4a, in such a way that no double-precision
12665 floating point operations are used.
12667 @item -m4a-single
12668 @opindex m4a-single
12669 Generate code for the SH4a assuming the floating-point unit is in
12670 single-precision mode by default.
12672 @item -m4a
12673 @opindex m4a
12674 Generate code for the SH4a.
12676 @item -m4al
12677 @opindex m4al
12678 Same as @option{-m4a-nofpu}, except that it implicitly passes
12679 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
12680 instructions at the moment.
12682 @item -mb
12683 @opindex mb
12684 Compile code for the processor in big endian mode.
12686 @item -ml
12687 @opindex ml
12688 Compile code for the processor in little endian mode.
12690 @item -mdalign
12691 @opindex mdalign
12692 Align doubles at 64-bit boundaries.  Note that this changes the calling
12693 conventions, and thus some functions from the standard C library will
12694 not work unless you recompile it first with @option{-mdalign}.
12696 @item -mrelax
12697 @opindex mrelax
12698 Shorten some address references at link time, when possible; uses the
12699 linker option @option{-relax}.
12701 @item -mbigtable
12702 @opindex mbigtable
12703 Use 32-bit offsets in @code{switch} tables.  The default is to use
12704 16-bit offsets.
12706 @item -mfmovd
12707 @opindex mfmovd
12708 Enable the use of the instruction @code{fmovd}.
12710 @item -mhitachi
12711 @opindex mhitachi
12712 Comply with the calling conventions defined by Renesas.
12714 @item -mrenesas
12715 @opindex mhitachi
12716 Comply with the calling conventions defined by Renesas.
12718 @item -mno-renesas
12719 @opindex mhitachi
12720 Comply with the calling conventions defined for GCC before the Renesas
12721 conventions were available.  This option is the default for all
12722 targets of the SH toolchain except for @samp{sh-symbianelf}.
12724 @item -mnomacsave
12725 @opindex mnomacsave
12726 Mark the @code{MAC} register as call-clobbered, even if
12727 @option{-mhitachi} is given.
12729 @item -mieee
12730 @opindex mieee
12731 Increase IEEE-compliance of floating-point code.
12732 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12733 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12734 comparisons of NANs / infinities incurs extra overhead in every
12735 floating point comparison, therefore the default is set to
12736 @option{-ffinite-math-only}.
12738 @item -minline-ic_invalidate
12739 @opindex minline-ic_invalidate
12740 Inline code to invalidate instruction cache entries after setting up
12741 nested function trampolines.
12742 This option has no effect if -musermode is in effect and the selected
12743 code generation option (e.g. -m4) does not allow the use of the icbi
12744 instruction.
12745 If the selected code generation option does not allow the use of the icbi
12746 instruction, and -musermode is not in effect, the inlined code will
12747 manipulate the instruction cache address array directly with an associative
12748 write.  This not only requires privileged mode, but it will also
12749 fail if the cache line had been mapped via the TLB and has become unmapped.
12751 @item -misize
12752 @opindex misize
12753 Dump instruction size and location in the assembly code.
12755 @item -mpadstruct
12756 @opindex mpadstruct
12757 This option is deprecated.  It pads structures to multiple of 4 bytes,
12758 which is incompatible with the SH ABI@.
12760 @item -mspace
12761 @opindex mspace
12762 Optimize for space instead of speed.  Implied by @option{-Os}.
12764 @item -mprefergot
12765 @opindex mprefergot
12766 When generating position-independent code, emit function calls using
12767 the Global Offset Table instead of the Procedure Linkage Table.
12769 @item -musermode
12770 @opindex musermode
12771 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
12772 if the inlined code would not work in user mode.
12773 This is the default when the target is @code{sh-*-linux*}.
12775 @item -multcost=@var{number}
12776 @opindex multcost=@var{number}
12777 Set the cost to assume for a multiply insn.
12779 @item -mdiv=@var{strategy}
12780 @opindex mdiv=@var{strategy}
12781 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12782 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12783 inv:call2, inv:fp .
12784 "fp" performs the operation in floating point.  This has a very high latency,
12785 but needs only a few instructions, so it might be a good choice if
12786 your code has enough easily exploitable ILP to allow the compiler to
12787 schedule the floating point instructions together with other instructions.
12788 Division by zero causes a floating point exception.
12789 "inv" uses integer operations to calculate the inverse of the divisor,
12790 and then multiplies the dividend with the inverse.  This strategy allows
12791 cse and hoisting of the inverse calculation.  Division by zero calculates
12792 an unspecified result, but does not trap.
12793 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12794 have been found, or if the entire operation has been hoisted to the same
12795 place, the last stages of the inverse calculation are intertwined with the
12796 final multiply to reduce the overall latency, at the expense of using a few
12797 more instructions, and thus offering fewer scheduling opportunities with
12798 other code.
12799 "call" calls a library function that usually implements the inv:minlat
12800 strategy.
12801 This gives high code density for m5-*media-nofpu compilations.
12802 "call2" uses a different entry point of the same library function, where it
12803 assumes that a pointer to a lookup table has already been set up, which
12804 exposes the pointer load to cse / code hoisting optimizations.
12805 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12806 code generation, but if the code stays unoptimized, revert to the "call",
12807 "call2", or "fp" strategies, respectively.  Note that the
12808 potentially-trapping side effect of division by zero is carried by a
12809 separate instruction, so it is possible that all the integer instructions
12810 are hoisted out, but the marker for the side effect stays where it is.
12811 A recombination to fp operations or a call is not possible in that case.
12812 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12813 that the inverse calculation was nor separated from the multiply, they speed
12814 up division where the dividend fits into 20 bits (plus sign where applicable),
12815 by inserting a test to skip a number of operations in this case; this test
12816 slows down the case of larger dividends.  inv20u assumes the case of a such
12817 a small dividend to be unlikely, and inv20l assumes it to be likely.
12819 @item -mdivsi3_libfunc=@var{name}
12820 @opindex mdivsi3_libfunc=@var{name}
12821 Set the name of the library function used for 32 bit signed division to
12822 @var{name}.  This only affect the name used in the call and inv:call
12823 division strategies, and the compiler will still expect the same
12824 sets of input/output/clobbered registers as if this option was not present.
12826 @item -madjust-unroll
12827 @opindex madjust-unroll
12828 Throttle unrolling to avoid thrashing target registers.
12829 This option only has an effect if the gcc code base supports the
12830 TARGET_ADJUST_UNROLL_MAX target hook.
12832 @item -mindexed-addressing
12833 @opindex mindexed-addressing
12834 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12835 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12836 semantics for the indexed addressing mode.  The architecture allows the
12837 implementation of processors with 64 bit MMU, which the OS could use to
12838 get 32 bit addressing, but since no current hardware implementation supports
12839 this or any other way to make the indexed addressing mode safe to use in
12840 the 32 bit ABI, the default is -mno-indexed-addressing.
12842 @item -mgettrcost=@var{number}
12843 @opindex mgettrcost=@var{number}
12844 Set the cost assumed for the gettr instruction to @var{number}.
12845 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12847 @item -mpt-fixed
12848 @opindex mpt-fixed
12849 Assume pt* instructions won't trap.  This will generally generate better
12850 scheduled code, but is unsafe on current hardware.  The current architecture
12851 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12852 This has the unintentional effect of making it unsafe to schedule ptabs /
12853 ptrel before a branch, or hoist it out of a loop.  For example,
12854 __do_global_ctors, a part of libgcc that runs constructors at program
12855 startup, calls functions in a list which is delimited by @minus{}1.  With the
12856 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
12857 That means that all the constructors will be run a bit quicker, but when
12858 the loop comes to the end of the list, the program crashes because ptabs
12859 loads @minus{}1 into a target register.  Since this option is unsafe for any
12860 hardware implementing the current architecture specification, the default
12861 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12862 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12863 this deters register allocation using target registers for storing
12864 ordinary integers.
12866 @item -minvalid-symbols
12867 @opindex minvalid-symbols
12868 Assume symbols might be invalid.  Ordinary function symbols generated by
12869 the compiler will always be valid to load with movi/shori/ptabs or
12870 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12871 to generate symbols that will cause ptabs / ptrel to trap.
12872 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12873 It will then prevent cross-basic-block cse, hoisting and most scheduling
12874 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12875 @end table
12877 @node SPARC Options
12878 @subsection SPARC Options
12879 @cindex SPARC options
12881 These @samp{-m} options are supported on the SPARC:
12883 @table @gcctabopt
12884 @item -mno-app-regs
12885 @itemx -mapp-regs
12886 @opindex mno-app-regs
12887 @opindex mapp-regs
12888 Specify @option{-mapp-regs} to generate output using the global registers
12889 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12890 is the default.
12892 To be fully SVR4 ABI compliant at the cost of some performance loss,
12893 specify @option{-mno-app-regs}.  You should compile libraries and system
12894 software with this option.
12896 @item -mfpu
12897 @itemx -mhard-float
12898 @opindex mfpu
12899 @opindex mhard-float
12900 Generate output containing floating point instructions.  This is the
12901 default.
12903 @item -mno-fpu
12904 @itemx -msoft-float
12905 @opindex mno-fpu
12906 @opindex msoft-float
12907 Generate output containing library calls for floating point.
12908 @strong{Warning:} the requisite libraries are not available for all SPARC
12909 targets.  Normally the facilities of the machine's usual C compiler are
12910 used, but this cannot be done directly in cross-compilation.  You must make
12911 your own arrangements to provide suitable library functions for
12912 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12913 @samp{sparclite-*-*} do provide software floating point support.
12915 @option{-msoft-float} changes the calling convention in the output file;
12916 therefore, it is only useful if you compile @emph{all} of a program with
12917 this option.  In particular, you need to compile @file{libgcc.a}, the
12918 library that comes with GCC, with @option{-msoft-float} in order for
12919 this to work.
12921 @item -mhard-quad-float
12922 @opindex mhard-quad-float
12923 Generate output containing quad-word (long double) floating point
12924 instructions.
12926 @item -msoft-quad-float
12927 @opindex msoft-quad-float
12928 Generate output containing library calls for quad-word (long double)
12929 floating point instructions.  The functions called are those specified
12930 in the SPARC ABI@.  This is the default.
12932 As of this writing, there are no SPARC implementations that have hardware
12933 support for the quad-word floating point instructions.  They all invoke
12934 a trap handler for one of these instructions, and then the trap handler
12935 emulates the effect of the instruction.  Because of the trap handler overhead,
12936 this is much slower than calling the ABI library routines.  Thus the
12937 @option{-msoft-quad-float} option is the default.
12939 @item -mno-unaligned-doubles
12940 @itemx -munaligned-doubles
12941 @opindex mno-unaligned-doubles
12942 @opindex munaligned-doubles
12943 Assume that doubles have 8 byte alignment.  This is the default.
12945 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12946 alignment only if they are contained in another type, or if they have an
12947 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12948 Specifying this option avoids some rare compatibility problems with code
12949 generated by other compilers.  It is not the default because it results
12950 in a performance loss, especially for floating point code.
12952 @item -mno-faster-structs
12953 @itemx -mfaster-structs
12954 @opindex mno-faster-structs
12955 @opindex mfaster-structs
12956 With @option{-mfaster-structs}, the compiler assumes that structures
12957 should have 8 byte alignment.  This enables the use of pairs of
12958 @code{ldd} and @code{std} instructions for copies in structure
12959 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12960 However, the use of this changed alignment directly violates the SPARC
12961 ABI@.  Thus, it's intended only for use on targets where the developer
12962 acknowledges that their resulting code will not be directly in line with
12963 the rules of the ABI@.
12965 @item -mimpure-text
12966 @opindex mimpure-text
12967 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12968 the compiler to not pass @option{-z text} to the linker when linking a
12969 shared object.  Using this option, you can link position-dependent
12970 code into a shared object.
12972 @option{-mimpure-text} suppresses the ``relocations remain against
12973 allocatable but non-writable sections'' linker error message.
12974 However, the necessary relocations will trigger copy-on-write, and the
12975 shared object is not actually shared across processes.  Instead of
12976 using @option{-mimpure-text}, you should compile all source code with
12977 @option{-fpic} or @option{-fPIC}.
12979 This option is only available on SunOS and Solaris.
12981 @item -mcpu=@var{cpu_type}
12982 @opindex mcpu
12983 Set the instruction set, register set, and instruction scheduling parameters
12984 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12985 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12986 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12987 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12988 @samp{ultrasparc3}, and @samp{niagara}.
12990 Default instruction scheduling parameters are used for values that select
12991 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12992 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12994 Here is a list of each supported architecture and their supported
12995 implementations.
12997 @smallexample
12998     v7:             cypress
12999     v8:             supersparc, hypersparc
13000     sparclite:      f930, f934, sparclite86x
13001     sparclet:       tsc701
13002     v9:             ultrasparc, ultrasparc3, niagara
13003 @end smallexample
13005 By default (unless configured otherwise), GCC generates code for the V7
13006 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
13007 additionally optimizes it for the Cypress CY7C602 chip, as used in the
13008 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
13009 SPARCStation 1, 2, IPX etc.
13011 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
13012 architecture.  The only difference from V7 code is that the compiler emits
13013 the integer multiply and integer divide instructions which exist in SPARC-V8
13014 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
13015 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
13016 2000 series.
13018 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
13019 the SPARC architecture.  This adds the integer multiply, integer divide step
13020 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
13021 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
13022 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
13023 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
13024 MB86934 chip, which is the more recent SPARClite with FPU@.
13026 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
13027 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
13028 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
13029 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
13030 optimizes it for the TEMIC SPARClet chip.
13032 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
13033 architecture.  This adds 64-bit integer and floating-point move instructions,
13034 3 additional floating-point condition code registers and conditional move
13035 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
13036 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
13037 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
13038 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
13039 @option{-mcpu=niagara}, the compiler additionally optimizes it for
13040 Sun UltraSPARC T1 chips.
13042 @item -mtune=@var{cpu_type}
13043 @opindex mtune
13044 Set the instruction scheduling parameters for machine type
13045 @var{cpu_type}, but do not set the instruction set or register set that the
13046 option @option{-mcpu=@var{cpu_type}} would.
13048 The same values for @option{-mcpu=@var{cpu_type}} can be used for
13049 @option{-mtune=@var{cpu_type}}, but the only useful values are those
13050 that select a particular cpu implementation.  Those are @samp{cypress},
13051 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
13052 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
13053 @samp{ultrasparc3}, and @samp{niagara}.
13055 @item -mv8plus
13056 @itemx -mno-v8plus
13057 @opindex mv8plus
13058 @opindex mno-v8plus
13059 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
13060 difference from the V8 ABI is that the global and out registers are
13061 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
13062 mode for all SPARC-V9 processors.
13064 @item -mvis
13065 @itemx -mno-vis
13066 @opindex mvis
13067 @opindex mno-vis
13068 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
13069 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
13070 @end table
13072 These @samp{-m} options are supported in addition to the above
13073 on SPARC-V9 processors in 64-bit environments:
13075 @table @gcctabopt
13076 @item -mlittle-endian
13077 @opindex mlittle-endian
13078 Generate code for a processor running in little-endian mode.  It is only
13079 available for a few configurations and most notably not on Solaris and Linux.
13081 @item -m32
13082 @itemx -m64
13083 @opindex m32
13084 @opindex m64
13085 Generate code for a 32-bit or 64-bit environment.
13086 The 32-bit environment sets int, long and pointer to 32 bits.
13087 The 64-bit environment sets int to 32 bits and long and pointer
13088 to 64 bits.
13090 @item -mcmodel=medlow
13091 @opindex mcmodel=medlow
13092 Generate code for the Medium/Low code model: 64-bit addresses, programs
13093 must be linked in the low 32 bits of memory.  Programs can be statically
13094 or dynamically linked.
13096 @item -mcmodel=medmid
13097 @opindex mcmodel=medmid
13098 Generate code for the Medium/Middle code model: 64-bit addresses, programs
13099 must be linked in the low 44 bits of memory, the text and data segments must
13100 be less than 2GB in size and the data segment must be located within 2GB of
13101 the text segment.
13103 @item -mcmodel=medany
13104 @opindex mcmodel=medany
13105 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
13106 may be linked anywhere in memory, the text and data segments must be less
13107 than 2GB in size and the data segment must be located within 2GB of the
13108 text segment.
13110 @item -mcmodel=embmedany
13111 @opindex mcmodel=embmedany
13112 Generate code for the Medium/Anywhere code model for embedded systems:
13113 64-bit addresses, the text and data segments must be less than 2GB in
13114 size, both starting anywhere in memory (determined at link time).  The
13115 global register %g4 points to the base of the data segment.  Programs
13116 are statically linked and PIC is not supported.
13118 @item -mstack-bias
13119 @itemx -mno-stack-bias
13120 @opindex mstack-bias
13121 @opindex mno-stack-bias
13122 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
13123 frame pointer if present, are offset by @minus{}2047 which must be added back
13124 when making stack frame references.  This is the default in 64-bit mode.
13125 Otherwise, assume no such offset is present.
13126 @end table
13128 These switches are supported in addition to the above on Solaris:
13130 @table @gcctabopt
13131 @item -threads
13132 @opindex threads
13133 Add support for multithreading using the Solaris threads library.  This
13134 option sets flags for both the preprocessor and linker.  This option does
13135 not affect the thread safety of object code produced by the compiler or
13136 that of libraries supplied with it.
13138 @item -pthreads
13139 @opindex pthreads
13140 Add support for multithreading using the POSIX threads library.  This
13141 option sets flags for both the preprocessor and linker.  This option does
13142 not affect the thread safety of object code produced  by the compiler or
13143 that of libraries supplied with it.
13145 @item -pthread
13146 @opindex pthread
13147 This is a synonym for @option{-pthreads}.
13148 @end table
13150 @node SPU Options
13151 @subsection SPU Options
13152 @cindex SPU options
13154 These @samp{-m} options are supported on the SPU:
13156 @table @gcctabopt
13157 @item -mwarn-reloc
13158 @itemx -merror-reloc
13159 @opindex mwarn-reloc
13160 @opindex merror-reloc
13162 The loader for SPU does not handle dynamic relocations.  By default, GCC
13163 will give an error when it generates code that requires a dynamic
13164 relocation.  @option{-mno-error-reloc} disables the error,
13165 @option{-mwarn-reloc} will generate a warning instead.
13167 @item -msafe-dma
13168 @itemx -munsafe-dma
13169 @opindex msafe-dma
13170 @opindex munsafe-dma
13172 Instructions which initiate or test completion of DMA must not be
13173 reordered with respect to loads and stores of the memory which is being
13174 accessed.  Users typically address this problem using the volatile
13175 keyword, but that can lead to inefficient code in places where the
13176 memory is known to not change.  Rather than mark the memory as volatile
13177 we treat the DMA instructions as potentially effecting all memory.  With
13178 @option{-munsafe-dma} users must use the volatile keyword to protect
13179 memory accesses.
13181 @item -mbranch-hints
13182 @opindex mbranch-hints
13184 By default, GCC will generate a branch hint instruction to avoid
13185 pipeline stalls for always taken or probably taken branches.  A hint
13186 will not be generated closer than 8 instructions away from its branch.
13187 There is little reason to disable them, except for debugging purposes,
13188 or to make an object a little bit smaller.
13190 @item -msmall-mem
13191 @itemx -mlarge-mem
13192 @opindex msmall-mem
13193 @opindex mlarge-mem
13195 By default, GCC generates code assuming that addresses are never larger
13196 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
13197 a full 32 bit address.
13199 @item -mstdmain
13200 @opindex mstdmain
13202 By default, GCC links against startup code that assumes the SPU-style
13203 main function interface (which has an unconventional parameter list).
13204 With @option{-mstdmain}, GCC will link your program against startup
13205 code that assumes a C99-style interface to @code{main}, including a
13206 local copy of @code{argv} strings.
13208 @item -mfixed-range=@var{register-range}
13209 @opindex mfixed-range
13210 Generate code treating the given register range as fixed registers.
13211 A fixed register is one that the register allocator can not use.  This is
13212 useful when compiling kernel code.  A register range is specified as
13213 two registers separated by a dash.  Multiple register ranges can be
13214 specified separated by a comma.
13216 @end table
13218 @node System V Options
13219 @subsection Options for System V
13221 These additional options are available on System V Release 4 for
13222 compatibility with other compilers on those systems:
13224 @table @gcctabopt
13225 @item -G
13226 @opindex G
13227 Create a shared object.
13228 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
13230 @item -Qy
13231 @opindex Qy
13232 Identify the versions of each tool used by the compiler, in a
13233 @code{.ident} assembler directive in the output.
13235 @item -Qn
13236 @opindex Qn
13237 Refrain from adding @code{.ident} directives to the output file (this is
13238 the default).
13240 @item -YP,@var{dirs}
13241 @opindex YP
13242 Search the directories @var{dirs}, and no others, for libraries
13243 specified with @option{-l}.
13245 @item -Ym,@var{dir}
13246 @opindex Ym
13247 Look in the directory @var{dir} to find the M4 preprocessor.
13248 The assembler uses this option.
13249 @c This is supposed to go with a -Yd for predefined M4 macro files, but
13250 @c the generic assembler that comes with Solaris takes just -Ym.
13251 @end table
13253 @node TMS320C3x/C4x Options
13254 @subsection TMS320C3x/C4x Options
13255 @cindex TMS320C3x/C4x Options
13257 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
13259 @table @gcctabopt
13261 @item -mcpu=@var{cpu_type}
13262 @opindex mcpu
13263 Set the instruction set, register set, and instruction scheduling
13264 parameters for machine type @var{cpu_type}.  Supported values for
13265 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
13266 @samp{c44}.  The default is @samp{c40} to generate code for the
13267 TMS320C40.
13269 @item -mbig-memory
13270 @itemx -mbig
13271 @itemx -msmall-memory
13272 @itemx -msmall
13273 @opindex mbig-memory
13274 @opindex mbig
13275 @opindex msmall-memory
13276 @opindex msmall
13277 Generates code for the big or small memory model.  The small memory
13278 model assumed that all data fits into one 64K word page.  At run-time
13279 the data page (DP) register must be set to point to the 64K page
13280 containing the .bss and .data program sections.  The big memory model is
13281 the default and requires reloading of the DP register for every direct
13282 memory access.
13284 @item -mbk
13285 @itemx -mno-bk
13286 @opindex mbk
13287 @opindex mno-bk
13288 Allow (disallow) allocation of general integer operands into the block
13289 count register BK@.
13291 @item -mdb
13292 @itemx -mno-db
13293 @opindex mdb
13294 @opindex mno-db
13295 Enable (disable) generation of code using decrement and branch,
13296 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
13297 on the safe side, this is disabled for the C3x, since the maximum
13298 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
13299 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
13300 that it can utilize the decrement and branch instruction, but will give
13301 up if there is more than one memory reference in the loop.  Thus a loop
13302 where the loop counter is decremented can generate slightly more
13303 efficient code, in cases where the RPTB instruction cannot be utilized.
13305 @item -mdp-isr-reload
13306 @itemx -mparanoid
13307 @opindex mdp-isr-reload
13308 @opindex mparanoid
13309 Force the DP register to be saved on entry to an interrupt service
13310 routine (ISR), reloaded to point to the data section, and restored on
13311 exit from the ISR@.  This should not be required unless someone has
13312 violated the small memory model by modifying the DP register, say within
13313 an object library.
13315 @item -mmpyi
13316 @itemx -mno-mpyi
13317 @opindex mmpyi
13318 @opindex mno-mpyi
13319 For the C3x use the 24-bit MPYI instruction for integer multiplies
13320 instead of a library call to guarantee 32-bit results.  Note that if one
13321 of the operands is a constant, then the multiplication will be performed
13322 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
13323 then squaring operations are performed inline instead of a library call.
13325 @item -mfast-fix
13326 @itemx -mno-fast-fix
13327 @opindex mfast-fix
13328 @opindex mno-fast-fix
13329 The C3x/C4x FIX instruction to convert a floating point value to an
13330 integer value chooses the nearest integer less than or equal to the
13331 floating point value rather than to the nearest integer.  Thus if the
13332 floating point number is negative, the result will be incorrectly
13333 truncated an additional code is necessary to detect and correct this
13334 case.  This option can be used to disable generation of the additional
13335 code required to correct the result.
13337 @item -mrptb
13338 @itemx -mno-rptb
13339 @opindex mrptb
13340 @opindex mno-rptb
13341 Enable (disable) generation of repeat block sequences using the RPTB
13342 instruction for zero overhead looping.  The RPTB construct is only used
13343 for innermost loops that do not call functions or jump across the loop
13344 boundaries.  There is no advantage having nested RPTB loops due to the
13345 overhead required to save and restore the RC, RS, and RE registers.
13346 This is enabled by default with @option{-O2}.
13348 @item -mrpts=@var{count}
13349 @itemx -mno-rpts
13350 @opindex mrpts
13351 @opindex mno-rpts
13352 Enable (disable) the use of the single instruction repeat instruction
13353 RPTS@.  If a repeat block contains a single instruction, and the loop
13354 count can be guaranteed to be less than the value @var{count}, GCC will
13355 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
13356 then a RPTS will be emitted even if the loop count cannot be determined
13357 at compile time.  Note that the repeated instruction following RPTS does
13358 not have to be reloaded from memory each iteration, thus freeing up the
13359 CPU buses for operands.  However, since interrupts are blocked by this
13360 instruction, it is disabled by default.
13362 @item -mloop-unsigned
13363 @itemx -mno-loop-unsigned
13364 @opindex mloop-unsigned
13365 @opindex mno-loop-unsigned
13366 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
13367 is @math{2^{31} + 1} since these instructions test if the iteration count is
13368 negative to terminate the loop.  If the iteration count is unsigned
13369 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
13370 exceeded.  This switch allows an unsigned iteration count.
13372 @item -mti
13373 @opindex mti
13374 Try to emit an assembler syntax that the TI assembler (asm30) is happy
13375 with.  This also enforces compatibility with the API employed by the TI
13376 C3x C compiler.  For example, long doubles are passed as structures
13377 rather than in floating point registers.
13379 @item -mregparm
13380 @itemx -mmemparm
13381 @opindex mregparm
13382 @opindex mmemparm
13383 Generate code that uses registers (stack) for passing arguments to functions.
13384 By default, arguments are passed in registers where possible rather
13385 than by pushing arguments on to the stack.
13387 @item -mparallel-insns
13388 @itemx -mno-parallel-insns
13389 @opindex mparallel-insns
13390 @opindex mno-parallel-insns
13391 Allow the generation of parallel instructions.  This is enabled by
13392 default with @option{-O2}.
13394 @item -mparallel-mpy
13395 @itemx -mno-parallel-mpy
13396 @opindex mparallel-mpy
13397 @opindex mno-parallel-mpy
13398 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
13399 provided @option{-mparallel-insns} is also specified.  These instructions have
13400 tight register constraints which can pessimize the code generation
13401 of large functions.
13403 @end table
13405 @node V850 Options
13406 @subsection V850 Options
13407 @cindex V850 Options
13409 These @samp{-m} options are defined for V850 implementations:
13411 @table @gcctabopt
13412 @item -mlong-calls
13413 @itemx -mno-long-calls
13414 @opindex mlong-calls
13415 @opindex mno-long-calls
13416 Treat all calls as being far away (near).  If calls are assumed to be
13417 far away, the compiler will always load the functions address up into a
13418 register, and call indirect through the pointer.
13420 @item -mno-ep
13421 @itemx -mep
13422 @opindex mno-ep
13423 @opindex mep
13424 Do not optimize (do optimize) basic blocks that use the same index
13425 pointer 4 or more times to copy pointer into the @code{ep} register, and
13426 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
13427 option is on by default if you optimize.
13429 @item -mno-prolog-function
13430 @itemx -mprolog-function
13431 @opindex mno-prolog-function
13432 @opindex mprolog-function
13433 Do not use (do use) external functions to save and restore registers
13434 at the prologue and epilogue of a function.  The external functions
13435 are slower, but use less code space if more than one function saves
13436 the same number of registers.  The @option{-mprolog-function} option
13437 is on by default if you optimize.
13439 @item -mspace
13440 @opindex mspace
13441 Try to make the code as small as possible.  At present, this just turns
13442 on the @option{-mep} and @option{-mprolog-function} options.
13444 @item -mtda=@var{n}
13445 @opindex mtda
13446 Put static or global variables whose size is @var{n} bytes or less into
13447 the tiny data area that register @code{ep} points to.  The tiny data
13448 area can hold up to 256 bytes in total (128 bytes for byte references).
13450 @item -msda=@var{n}
13451 @opindex msda
13452 Put static or global variables whose size is @var{n} bytes or less into
13453 the small data area that register @code{gp} points to.  The small data
13454 area can hold up to 64 kilobytes.
13456 @item -mzda=@var{n}
13457 @opindex mzda
13458 Put static or global variables whose size is @var{n} bytes or less into
13459 the first 32 kilobytes of memory.
13461 @item -mv850
13462 @opindex mv850
13463 Specify that the target processor is the V850.
13465 @item -mbig-switch
13466 @opindex mbig-switch
13467 Generate code suitable for big switch tables.  Use this option only if
13468 the assembler/linker complain about out of range branches within a switch
13469 table.
13471 @item -mapp-regs
13472 @opindex mapp-regs
13473 This option will cause r2 and r5 to be used in the code generated by
13474 the compiler.  This setting is the default.
13476 @item -mno-app-regs
13477 @opindex mno-app-regs
13478 This option will cause r2 and r5 to be treated as fixed registers.
13480 @item -mv850e1
13481 @opindex mv850e1
13482 Specify that the target processor is the V850E1.  The preprocessor
13483 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
13484 this option is used.
13486 @item -mv850e
13487 @opindex mv850e
13488 Specify that the target processor is the V850E@.  The preprocessor
13489 constant @samp{__v850e__} will be defined if this option is used.
13491 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13492 are defined then a default target processor will be chosen and the
13493 relevant @samp{__v850*__} preprocessor constant will be defined.
13495 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13496 defined, regardless of which processor variant is the target.
13498 @item -mdisable-callt
13499 @opindex mdisable-callt
13500 This option will suppress generation of the CALLT instruction for the
13501 v850e and v850e1 flavors of the v850 architecture.  The default is
13502 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
13504 @end table
13506 @node VAX Options
13507 @subsection VAX Options
13508 @cindex VAX options
13510 These @samp{-m} options are defined for the VAX:
13512 @table @gcctabopt
13513 @item -munix
13514 @opindex munix
13515 Do not output certain jump instructions (@code{aobleq} and so on)
13516 that the Unix assembler for the VAX cannot handle across long
13517 ranges.
13519 @item -mgnu
13520 @opindex mgnu
13521 Do output those jump instructions, on the assumption that you
13522 will assemble with the GNU assembler.
13524 @item -mg
13525 @opindex mg
13526 Output code for g-format floating point numbers instead of d-format.
13527 @end table
13529 @node x86-64 Options
13530 @subsection x86-64 Options
13531 @cindex x86-64 options
13533 These are listed under @xref{i386 and x86-64 Options}.
13535 @node Xstormy16 Options
13536 @subsection Xstormy16 Options
13537 @cindex Xstormy16 Options
13539 These options are defined for Xstormy16:
13541 @table @gcctabopt
13542 @item -msim
13543 @opindex msim
13544 Choose startup files and linker script suitable for the simulator.
13545 @end table
13547 @node Xtensa Options
13548 @subsection Xtensa Options
13549 @cindex Xtensa Options
13551 These options are supported for Xtensa targets:
13553 @table @gcctabopt
13554 @item -mconst16
13555 @itemx -mno-const16
13556 @opindex mconst16
13557 @opindex mno-const16
13558 Enable or disable use of @code{CONST16} instructions for loading
13559 constant values.  The @code{CONST16} instruction is currently not a
13560 standard option from Tensilica.  When enabled, @code{CONST16}
13561 instructions are always used in place of the standard @code{L32R}
13562 instructions.  The use of @code{CONST16} is enabled by default only if
13563 the @code{L32R} instruction is not available.
13565 @item -mfused-madd
13566 @itemx -mno-fused-madd
13567 @opindex mfused-madd
13568 @opindex mno-fused-madd
13569 Enable or disable use of fused multiply/add and multiply/subtract
13570 instructions in the floating-point option.  This has no effect if the
13571 floating-point option is not also enabled.  Disabling fused multiply/add
13572 and multiply/subtract instructions forces the compiler to use separate
13573 instructions for the multiply and add/subtract operations.  This may be
13574 desirable in some cases where strict IEEE 754-compliant results are
13575 required: the fused multiply add/subtract instructions do not round the
13576 intermediate result, thereby producing results with @emph{more} bits of
13577 precision than specified by the IEEE standard.  Disabling fused multiply
13578 add/subtract instructions also ensures that the program output is not
13579 sensitive to the compiler's ability to combine multiply and add/subtract
13580 operations.
13582 @item -mtext-section-literals
13583 @itemx -mno-text-section-literals
13584 @opindex mtext-section-literals
13585 @opindex mno-text-section-literals
13586 Control the treatment of literal pools.  The default is
13587 @option{-mno-text-section-literals}, which places literals in a separate
13588 section in the output file.  This allows the literal pool to be placed
13589 in a data RAM/ROM, and it also allows the linker to combine literal
13590 pools from separate object files to remove redundant literals and
13591 improve code size.  With @option{-mtext-section-literals}, the literals
13592 are interspersed in the text section in order to keep them as close as
13593 possible to their references.  This may be necessary for large assembly
13594 files.
13596 @item -mtarget-align
13597 @itemx -mno-target-align
13598 @opindex mtarget-align
13599 @opindex mno-target-align
13600 When this option is enabled, GCC instructs the assembler to
13601 automatically align instructions to reduce branch penalties at the
13602 expense of some code density.  The assembler attempts to widen density
13603 instructions to align branch targets and the instructions following call
13604 instructions.  If there are not enough preceding safe density
13605 instructions to align a target, no widening will be performed.  The
13606 default is @option{-mtarget-align}.  These options do not affect the
13607 treatment of auto-aligned instructions like @code{LOOP}, which the
13608 assembler will always align, either by widening density instructions or
13609 by inserting no-op instructions.
13611 @item -mlongcalls
13612 @itemx -mno-longcalls
13613 @opindex mlongcalls
13614 @opindex mno-longcalls
13615 When this option is enabled, GCC instructs the assembler to translate
13616 direct calls to indirect calls unless it can determine that the target
13617 of a direct call is in the range allowed by the call instruction.  This
13618 translation typically occurs for calls to functions in other source
13619 files.  Specifically, the assembler translates a direct @code{CALL}
13620 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13621 The default is @option{-mno-longcalls}.  This option should be used in
13622 programs where the call target can potentially be out of range.  This
13623 option is implemented in the assembler, not the compiler, so the
13624 assembly code generated by GCC will still show direct call
13625 instructions---look at the disassembled object code to see the actual
13626 instructions.  Note that the assembler will use an indirect call for
13627 every cross-file call, not just those that really will be out of range.
13628 @end table
13630 @node zSeries Options
13631 @subsection zSeries Options
13632 @cindex zSeries options
13634 These are listed under @xref{S/390 and zSeries Options}.
13636 @node Code Gen Options
13637 @section Options for Code Generation Conventions
13638 @cindex code generation conventions
13639 @cindex options, code generation
13640 @cindex run-time options
13642 These machine-independent options control the interface conventions
13643 used in code generation.
13645 Most of them have both positive and negative forms; the negative form
13646 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
13647 one of the forms is listed---the one which is not the default.  You
13648 can figure out the other form by either removing @samp{no-} or adding
13651 @table @gcctabopt
13652 @item -fbounds-check
13653 @opindex fbounds-check
13654 For front-ends that support it, generate additional code to check that
13655 indices used to access arrays are within the declared range.  This is
13656 currently only supported by the Java and Fortran front-ends, where
13657 this option defaults to true and false respectively.
13659 @item -ftrapv
13660 @opindex ftrapv
13661 This option generates traps for signed overflow on addition, subtraction,
13662 multiplication operations.
13664 @item -fwrapv
13665 @opindex fwrapv
13666 This option instructs the compiler to assume that signed arithmetic
13667 overflow of addition, subtraction and multiplication wraps around
13668 using twos-complement representation.  This flag enables some optimizations
13669 and disables others.  This option is enabled by default for the Java
13670 front-end, as required by the Java language specification.
13672 @item -fexceptions
13673 @opindex fexceptions
13674 Enable exception handling.  Generates extra code needed to propagate
13675 exceptions.  For some targets, this implies GCC will generate frame
13676 unwind information for all functions, which can produce significant data
13677 size overhead, although it does not affect execution.  If you do not
13678 specify this option, GCC will enable it by default for languages like
13679 C++ which normally require exception handling, and disable it for
13680 languages like C that do not normally require it.  However, you may need
13681 to enable this option when compiling C code that needs to interoperate
13682 properly with exception handlers written in C++.  You may also wish to
13683 disable this option if you are compiling older C++ programs that don't
13684 use exception handling.
13686 @item -fnon-call-exceptions
13687 @opindex fnon-call-exceptions
13688 Generate code that allows trapping instructions to throw exceptions.
13689 Note that this requires platform-specific runtime support that does
13690 not exist everywhere.  Moreover, it only allows @emph{trapping}
13691 instructions to throw exceptions, i.e.@: memory references or floating
13692 point instructions.  It does not allow exceptions to be thrown from
13693 arbitrary signal handlers such as @code{SIGALRM}.
13695 @item -funwind-tables
13696 @opindex funwind-tables
13697 Similar to @option{-fexceptions}, except that it will just generate any needed
13698 static data, but will not affect the generated code in any other way.
13699 You will normally not enable this option; instead, a language processor
13700 that needs this handling would enable it on your behalf.
13702 @item -fasynchronous-unwind-tables
13703 @opindex fasynchronous-unwind-tables
13704 Generate unwind table in dwarf2 format, if supported by target machine.  The
13705 table is exact at each instruction boundary, so it can be used for stack
13706 unwinding from asynchronous events (such as debugger or garbage collector).
13708 @item -fpcc-struct-return
13709 @opindex fpcc-struct-return
13710 Return ``short'' @code{struct} and @code{union} values in memory like
13711 longer ones, rather than in registers.  This convention is less
13712 efficient, but it has the advantage of allowing intercallability between
13713 GCC-compiled files and files compiled with other compilers, particularly
13714 the Portable C Compiler (pcc).
13716 The precise convention for returning structures in memory depends
13717 on the target configuration macros.
13719 Short structures and unions are those whose size and alignment match
13720 that of some integer type.
13722 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13723 switch is not binary compatible with code compiled with the
13724 @option{-freg-struct-return} switch.
13725 Use it to conform to a non-default application binary interface.
13727 @item -freg-struct-return
13728 @opindex freg-struct-return
13729 Return @code{struct} and @code{union} values in registers when possible.
13730 This is more efficient for small structures than
13731 @option{-fpcc-struct-return}.
13733 If you specify neither @option{-fpcc-struct-return} nor
13734 @option{-freg-struct-return}, GCC defaults to whichever convention is
13735 standard for the target.  If there is no standard convention, GCC
13736 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13737 the principal compiler.  In those cases, we can choose the standard, and
13738 we chose the more efficient register return alternative.
13740 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13741 switch is not binary compatible with code compiled with the
13742 @option{-fpcc-struct-return} switch.
13743 Use it to conform to a non-default application binary interface.
13745 @item -fshort-enums
13746 @opindex fshort-enums
13747 Allocate to an @code{enum} type only as many bytes as it needs for the
13748 declared range of possible values.  Specifically, the @code{enum} type
13749 will be equivalent to the smallest integer type which has enough room.
13751 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13752 code that is not binary compatible with code generated without that switch.
13753 Use it to conform to a non-default application binary interface.
13755 @item -fshort-double
13756 @opindex fshort-double
13757 Use the same size for @code{double} as for @code{float}.
13759 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13760 code that is not binary compatible with code generated without that switch.
13761 Use it to conform to a non-default application binary interface.
13763 @item -fshort-wchar
13764 @opindex fshort-wchar
13765 Override the underlying type for @samp{wchar_t} to be @samp{short
13766 unsigned int} instead of the default for the target.  This option is
13767 useful for building programs to run under WINE@.
13769 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13770 code that is not binary compatible with code generated without that switch.
13771 Use it to conform to a non-default application binary interface.
13773 @item -fno-common
13774 @opindex fno-common
13775 In C, allocate even uninitialized global variables in the data section of the
13776 object file, rather than generating them as common blocks.  This has the
13777 effect that if the same variable is declared (without @code{extern}) in
13778 two different compilations, you will get an error when you link them.
13779 The only reason this might be useful is if you wish to verify that the
13780 program will work on other systems which always work this way.
13782 @item -fno-ident
13783 @opindex fno-ident
13784 Ignore the @samp{#ident} directive.
13786 @item -finhibit-size-directive
13787 @opindex finhibit-size-directive
13788 Don't output a @code{.size} assembler directive, or anything else that
13789 would cause trouble if the function is split in the middle, and the
13790 two halves are placed at locations far apart in memory.  This option is
13791 used when compiling @file{crtstuff.c}; you should not need to use it
13792 for anything else.
13794 @item -fverbose-asm
13795 @opindex fverbose-asm
13796 Put extra commentary information in the generated assembly code to
13797 make it more readable.  This option is generally only of use to those
13798 who actually need to read the generated assembly code (perhaps while
13799 debugging the compiler itself).
13801 @option{-fno-verbose-asm}, the default, causes the
13802 extra information to be omitted and is useful when comparing two assembler
13803 files.
13805 @item -frecord-gcc-switches
13806 @opindex frecord-gcc-switches
13807 This switch causes the command line that was used to invoke the
13808 compiler to be recorded into the object file that is being created.
13809 This switch is only implemented on some targets and the exact format
13810 of the recording is target and binary file format dependent, but it
13811 usually takes the form of a section containing ASCII text.  This
13812 switch is related to the @option{-fverbose-asm} switch, but that
13813 switch only records information in the assembler output file as
13814 comments, so it never reaches the object file.
13816 @item -fpic
13817 @opindex fpic
13818 @cindex global offset table
13819 @cindex PIC
13820 Generate position-independent code (PIC) suitable for use in a shared
13821 library, if supported for the target machine.  Such code accesses all
13822 constant addresses through a global offset table (GOT)@.  The dynamic
13823 loader resolves the GOT entries when the program starts (the dynamic
13824 loader is not part of GCC; it is part of the operating system).  If
13825 the GOT size for the linked executable exceeds a machine-specific
13826 maximum size, you get an error message from the linker indicating that
13827 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13828 instead.  (These maximums are 8k on the SPARC and 32k
13829 on the m68k and RS/6000.  The 386 has no such limit.)
13831 Position-independent code requires special support, and therefore works
13832 only on certain machines.  For the 386, GCC supports PIC for System V
13833 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13834 position-independent.
13836 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13837 are defined to 1.
13839 @item -fPIC
13840 @opindex fPIC
13841 If supported for the target machine, emit position-independent code,
13842 suitable for dynamic linking and avoiding any limit on the size of the
13843 global offset table.  This option makes a difference on the m68k,
13844 PowerPC and SPARC@.
13846 Position-independent code requires special support, and therefore works
13847 only on certain machines.
13849 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13850 are defined to 2.
13852 @item -fpie
13853 @itemx -fPIE
13854 @opindex fpie
13855 @opindex fPIE
13856 These options are similar to @option{-fpic} and @option{-fPIC}, but
13857 generated position independent code can be only linked into executables.
13858 Usually these options are used when @option{-pie} GCC option will be
13859 used during linking.
13861 @item -fno-jump-tables
13862 @opindex fno-jump-tables
13863 Do not use jump tables for switch statements even where it would be
13864 more efficient than other code generation strategies.  This option is
13865 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13866 building code which forms part of a dynamic linker and cannot
13867 reference the address of a jump table.  On some targets, jump tables
13868 do not require a GOT and this option is not needed.
13870 @item -ffixed-@var{reg}
13871 @opindex ffixed
13872 Treat the register named @var{reg} as a fixed register; generated code
13873 should never refer to it (except perhaps as a stack pointer, frame
13874 pointer or in some other fixed role).
13876 @var{reg} must be the name of a register.  The register names accepted
13877 are machine-specific and are defined in the @code{REGISTER_NAMES}
13878 macro in the machine description macro file.
13880 This flag does not have a negative form, because it specifies a
13881 three-way choice.
13883 @item -fcall-used-@var{reg}
13884 @opindex fcall-used
13885 Treat the register named @var{reg} as an allocable register that is
13886 clobbered by function calls.  It may be allocated for temporaries or
13887 variables that do not live across a call.  Functions compiled this way
13888 will not save and restore the register @var{reg}.
13890 It is an error to used this flag with the frame pointer or stack pointer.
13891 Use of this flag for other registers that have fixed pervasive roles in
13892 the machine's execution model will produce disastrous results.
13894 This flag does not have a negative form, because it specifies a
13895 three-way choice.
13897 @item -fcall-saved-@var{reg}
13898 @opindex fcall-saved
13899 Treat the register named @var{reg} as an allocable register saved by
13900 functions.  It may be allocated even for temporaries or variables that
13901 live across a call.  Functions compiled this way will save and restore
13902 the register @var{reg} if they use it.
13904 It is an error to used this flag with the frame pointer or stack pointer.
13905 Use of this flag for other registers that have fixed pervasive roles in
13906 the machine's execution model will produce disastrous results.
13908 A different sort of disaster will result from the use of this flag for
13909 a register in which function values may be returned.
13911 This flag does not have a negative form, because it specifies a
13912 three-way choice.
13914 @item -fpack-struct[=@var{n}]
13915 @opindex fpack-struct
13916 Without a value specified, pack all structure members together without
13917 holes.  When a value is specified (which must be a small power of two), pack
13918 structure members according to this value, representing the maximum
13919 alignment (that is, objects with default alignment requirements larger than
13920 this will be output potentially unaligned at the next fitting location.
13922 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13923 code that is not binary compatible with code generated without that switch.
13924 Additionally, it makes the code suboptimal.
13925 Use it to conform to a non-default application binary interface.
13927 @item -finstrument-functions
13928 @opindex finstrument-functions
13929 Generate instrumentation calls for entry and exit to functions.  Just
13930 after function entry and just before function exit, the following
13931 profiling functions will be called with the address of the current
13932 function and its call site.  (On some platforms,
13933 @code{__builtin_return_address} does not work beyond the current
13934 function, so the call site information may not be available to the
13935 profiling functions otherwise.)
13937 @smallexample
13938 void __cyg_profile_func_enter (void *this_fn,
13939                                void *call_site);
13940 void __cyg_profile_func_exit  (void *this_fn,
13941                                void *call_site);
13942 @end smallexample
13944 The first argument is the address of the start of the current function,
13945 which may be looked up exactly in the symbol table.
13947 This instrumentation is also done for functions expanded inline in other
13948 functions.  The profiling calls will indicate where, conceptually, the
13949 inline function is entered and exited.  This means that addressable
13950 versions of such functions must be available.  If all your uses of a
13951 function are expanded inline, this may mean an additional expansion of
13952 code size.  If you use @samp{extern inline} in your C code, an
13953 addressable version of such functions must be provided.  (This is
13954 normally the case anyways, but if you get lucky and the optimizer always
13955 expands the functions inline, you might have gotten away without
13956 providing static copies.)
13958 A function may be given the attribute @code{no_instrument_function}, in
13959 which case this instrumentation will not be done.  This can be used, for
13960 example, for the profiling functions listed above, high-priority
13961 interrupt routines, and any functions from which the profiling functions
13962 cannot safely be called (perhaps signal handlers, if the profiling
13963 routines generate output or allocate memory).
13965 @item -fstack-check
13966 @opindex fstack-check
13967 Generate code to verify that you do not go beyond the boundary of the
13968 stack.  You should specify this flag if you are running in an
13969 environment with multiple threads, but only rarely need to specify it in
13970 a single-threaded environment since stack overflow is automatically
13971 detected on nearly all systems if there is only one stack.
13973 Note that this switch does not actually cause checking to be done; the
13974 operating system must do that.  The switch causes generation of code
13975 to ensure that the operating system sees the stack being extended.
13977 @item -fstack-limit-register=@var{reg}
13978 @itemx -fstack-limit-symbol=@var{sym}
13979 @itemx -fno-stack-limit
13980 @opindex fstack-limit-register
13981 @opindex fstack-limit-symbol
13982 @opindex fno-stack-limit
13983 Generate code to ensure that the stack does not grow beyond a certain value,
13984 either the value of a register or the address of a symbol.  If the stack
13985 would grow beyond the value, a signal is raised.  For most targets,
13986 the signal is raised before the stack overruns the boundary, so
13987 it is possible to catch the signal without taking special precautions.
13989 For instance, if the stack starts at absolute address @samp{0x80000000}
13990 and grows downwards, you can use the flags
13991 @option{-fstack-limit-symbol=__stack_limit} and
13992 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13993 of 128KB@.  Note that this may only work with the GNU linker.
13995 @cindex aliasing of parameters
13996 @cindex parameters, aliased
13997 @item -fargument-alias
13998 @itemx -fargument-noalias
13999 @itemx -fargument-noalias-global
14000 @itemx -fargument-noalias-anything
14001 @opindex fargument-alias
14002 @opindex fargument-noalias
14003 @opindex fargument-noalias-global
14004 @opindex fargument-noalias-anything
14005 Specify the possible relationships among parameters and between
14006 parameters and global data.
14008 @option{-fargument-alias} specifies that arguments (parameters) may
14009 alias each other and may alias global storage.@*
14010 @option{-fargument-noalias} specifies that arguments do not alias
14011 each other, but may alias global storage.@*
14012 @option{-fargument-noalias-global} specifies that arguments do not
14013 alias each other and do not alias global storage.
14014 @option{-fargument-noalias-anything} specifies that arguments do not
14015 alias any other storage.
14017 Each language will automatically use whatever option is required by
14018 the language standard.  You should not need to use these options yourself.
14020 @item -fleading-underscore
14021 @opindex fleading-underscore
14022 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
14023 change the way C symbols are represented in the object file.  One use
14024 is to help link with legacy assembly code.
14026 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
14027 generate code that is not binary compatible with code generated without that
14028 switch.  Use it to conform to a non-default application binary interface.
14029 Not all targets provide complete support for this switch.
14031 @item -ftls-model=@var{model}
14032 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
14033 The @var{model} argument should be one of @code{global-dynamic},
14034 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
14036 The default without @option{-fpic} is @code{initial-exec}; with
14037 @option{-fpic} the default is @code{global-dynamic}.
14039 @item -fvisibility=@var{default|internal|hidden|protected}
14040 @opindex fvisibility
14041 Set the default ELF image symbol visibility to the specified option---all
14042 symbols will be marked with this unless overridden within the code.
14043 Using this feature can very substantially improve linking and
14044 load times of shared object libraries, produce more optimized
14045 code, provide near-perfect API export and prevent symbol clashes.
14046 It is @strong{strongly} recommended that you use this in any shared objects
14047 you distribute.
14049 Despite the nomenclature, @code{default} always means public ie;
14050 available to be linked against from outside the shared object.
14051 @code{protected} and @code{internal} are pretty useless in real-world
14052 usage so the only other commonly used option will be @code{hidden}.
14053 The default if @option{-fvisibility} isn't specified is
14054 @code{default}, i.e., make every
14055 symbol public---this causes the same behavior as previous versions of
14056 GCC@.
14058 A good explanation of the benefits offered by ensuring ELF
14059 symbols have the correct visibility is given by ``How To Write
14060 Shared Libraries'' by Ulrich Drepper (which can be found at
14061 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
14062 solution made possible by this option to marking things hidden when
14063 the default is public is to make the default hidden and mark things
14064 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
14065 and @code{__attribute__ ((visibility("default")))} instead of
14066 @code{__declspec(dllexport)} you get almost identical semantics with
14067 identical syntax.  This is a great boon to those working with
14068 cross-platform projects.
14070 For those adding visibility support to existing code, you may find
14071 @samp{#pragma GCC visibility} of use.  This works by you enclosing
14072 the declarations you wish to set visibility for with (for example)
14073 @samp{#pragma GCC visibility push(hidden)} and
14074 @samp{#pragma GCC visibility pop}.
14075 Bear in mind that symbol visibility should be viewed @strong{as
14076 part of the API interface contract} and thus all new code should
14077 always specify visibility when it is not the default ie; declarations
14078 only for use within the local DSO should @strong{always} be marked explicitly
14079 as hidden as so to avoid PLT indirection overheads---making this
14080 abundantly clear also aids readability and self-documentation of the code.
14081 Note that due to ISO C++ specification requirements, operator new and
14082 operator delete must always be of default visibility.
14084 Be aware that headers from outside your project, in particular system
14085 headers and headers from any other library you use, may not be
14086 expecting to be compiled with visibility other than the default.  You
14087 may need to explicitly say @samp{#pragma GCC visibility push(default)}
14088 before including any such headers.
14090 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
14091 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
14092 no modifications.  However, this means that calls to @samp{extern}
14093 functions with no explicit visibility will use the PLT, so it is more
14094 effective to use @samp{__attribute ((visibility))} and/or
14095 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
14096 declarations should be treated as hidden.
14098 Note that @samp{-fvisibility} does affect C++ vague linkage
14099 entities. This means that, for instance, an exception class that will
14100 be thrown between DSOs must be explicitly marked with default
14101 visibility so that the @samp{type_info} nodes will be unified between
14102 the DSOs.
14104 An overview of these techniques, their benefits and how to use them
14105 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
14107 @end table
14109 @c man end
14111 @node Environment Variables
14112 @section Environment Variables Affecting GCC
14113 @cindex environment variables
14115 @c man begin ENVIRONMENT
14116 This section describes several environment variables that affect how GCC
14117 operates.  Some of them work by specifying directories or prefixes to use
14118 when searching for various kinds of files.  Some are used to specify other
14119 aspects of the compilation environment.
14121 Note that you can also specify places to search using options such as
14122 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
14123 take precedence over places specified using environment variables, which
14124 in turn take precedence over those specified by the configuration of GCC@.
14125 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
14126 GNU Compiler Collection (GCC) Internals}.
14128 @table @env
14129 @item LANG
14130 @itemx LC_CTYPE
14131 @c @itemx LC_COLLATE
14132 @itemx LC_MESSAGES
14133 @c @itemx LC_MONETARY
14134 @c @itemx LC_NUMERIC
14135 @c @itemx LC_TIME
14136 @itemx LC_ALL
14137 @findex LANG
14138 @findex LC_CTYPE
14139 @c @findex LC_COLLATE
14140 @findex LC_MESSAGES
14141 @c @findex LC_MONETARY
14142 @c @findex LC_NUMERIC
14143 @c @findex LC_TIME
14144 @findex LC_ALL
14145 @cindex locale
14146 These environment variables control the way that GCC uses
14147 localization information that allow GCC to work with different
14148 national conventions.  GCC inspects the locale categories
14149 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
14150 so.  These locale categories can be set to any value supported by your
14151 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
14152 Kingdom encoded in UTF-8.
14154 The @env{LC_CTYPE} environment variable specifies character
14155 classification.  GCC uses it to determine the character boundaries in
14156 a string; this is needed for some multibyte encodings that contain quote
14157 and escape characters that would otherwise be interpreted as a string
14158 end or escape.
14160 The @env{LC_MESSAGES} environment variable specifies the language to
14161 use in diagnostic messages.
14163 If the @env{LC_ALL} environment variable is set, it overrides the value
14164 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
14165 and @env{LC_MESSAGES} default to the value of the @env{LANG}
14166 environment variable.  If none of these variables are set, GCC
14167 defaults to traditional C English behavior.
14169 @item TMPDIR
14170 @findex TMPDIR
14171 If @env{TMPDIR} is set, it specifies the directory to use for temporary
14172 files.  GCC uses temporary files to hold the output of one stage of
14173 compilation which is to be used as input to the next stage: for example,
14174 the output of the preprocessor, which is the input to the compiler
14175 proper.
14177 @item GCC_EXEC_PREFIX
14178 @findex GCC_EXEC_PREFIX
14179 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
14180 names of the subprograms executed by the compiler.  No slash is added
14181 when this prefix is combined with the name of a subprogram, but you can
14182 specify a prefix that ends with a slash if you wish.
14184 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
14185 an appropriate prefix to use based on the pathname it was invoked with.
14187 If GCC cannot find the subprogram using the specified prefix, it
14188 tries looking in the usual places for the subprogram.
14190 The default value of @env{GCC_EXEC_PREFIX} is
14191 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
14192 the installed compiler. In many cases @var{prefix} is the value
14193 of @code{prefix} when you ran the @file{configure} script.
14195 Other prefixes specified with @option{-B} take precedence over this prefix.
14197 This prefix is also used for finding files such as @file{crt0.o} that are
14198 used for linking.
14200 In addition, the prefix is used in an unusual way in finding the
14201 directories to search for header files.  For each of the standard
14202 directories whose name normally begins with @samp{/usr/local/lib/gcc}
14203 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
14204 replacing that beginning with the specified prefix to produce an
14205 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
14206 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
14207 These alternate directories are searched first; the standard directories
14208 come next. If a standard directory begins with the configured 
14209 @var{prefix} then the value of @var{prefix} is replaced by 
14210 @env{GCC_EXEC_PREFIX} when looking for header files.
14212 @item COMPILER_PATH
14213 @findex COMPILER_PATH
14214 The value of @env{COMPILER_PATH} is a colon-separated list of
14215 directories, much like @env{PATH}.  GCC tries the directories thus
14216 specified when searching for subprograms, if it can't find the
14217 subprograms using @env{GCC_EXEC_PREFIX}.
14219 @item LIBRARY_PATH
14220 @findex LIBRARY_PATH
14221 The value of @env{LIBRARY_PATH} is a colon-separated list of
14222 directories, much like @env{PATH}.  When configured as a native compiler,
14223 GCC tries the directories thus specified when searching for special
14224 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
14225 using GCC also uses these directories when searching for ordinary
14226 libraries for the @option{-l} option (but directories specified with
14227 @option{-L} come first).
14229 @item LANG
14230 @findex LANG
14231 @cindex locale definition
14232 This variable is used to pass locale information to the compiler.  One way in
14233 which this information is used is to determine the character set to be used
14234 when character literals, string literals and comments are parsed in C and C++.
14235 When the compiler is configured to allow multibyte characters,
14236 the following values for @env{LANG} are recognized:
14238 @table @samp
14239 @item C-JIS
14240 Recognize JIS characters.
14241 @item C-SJIS
14242 Recognize SJIS characters.
14243 @item C-EUCJP
14244 Recognize EUCJP characters.
14245 @end table
14247 If @env{LANG} is not defined, or if it has some other value, then the
14248 compiler will use mblen and mbtowc as defined by the default locale to
14249 recognize and translate multibyte characters.
14250 @end table
14252 @noindent
14253 Some additional environments variables affect the behavior of the
14254 preprocessor.
14256 @include cppenv.texi
14258 @c man end
14260 @node Precompiled Headers
14261 @section Using Precompiled Headers
14262 @cindex precompiled headers
14263 @cindex speed of compilation
14265 Often large projects have many header files that are included in every
14266 source file.  The time the compiler takes to process these header files
14267 over and over again can account for nearly all of the time required to
14268 build the project.  To make builds faster, GCC allows users to
14269 `precompile' a header file; then, if builds can use the precompiled
14270 header file they will be much faster.
14272 To create a precompiled header file, simply compile it as you would any
14273 other file, if necessary using the @option{-x} option to make the driver
14274 treat it as a C or C++ header file.  You will probably want to use a
14275 tool like @command{make} to keep the precompiled header up-to-date when
14276 the headers it contains change.
14278 A precompiled header file will be searched for when @code{#include} is
14279 seen in the compilation.  As it searches for the included file
14280 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
14281 compiler looks for a precompiled header in each directory just before it
14282 looks for the include file in that directory.  The name searched for is
14283 the name specified in the @code{#include} with @samp{.gch} appended.  If
14284 the precompiled header file can't be used, it is ignored.
14286 For instance, if you have @code{#include "all.h"}, and you have
14287 @file{all.h.gch} in the same directory as @file{all.h}, then the
14288 precompiled header file will be used if possible, and the original
14289 header will be used otherwise.
14291 Alternatively, you might decide to put the precompiled header file in a
14292 directory and use @option{-I} to ensure that directory is searched
14293 before (or instead of) the directory containing the original header.
14294 Then, if you want to check that the precompiled header file is always
14295 used, you can put a file of the same name as the original header in this
14296 directory containing an @code{#error} command.
14298 This also works with @option{-include}.  So yet another way to use
14299 precompiled headers, good for projects not designed with precompiled
14300 header files in mind, is to simply take most of the header files used by
14301 a project, include them from another header file, precompile that header
14302 file, and @option{-include} the precompiled header.  If the header files
14303 have guards against multiple inclusion, they will be skipped because
14304 they've already been included (in the precompiled header).
14306 If you need to precompile the same header file for different
14307 languages, targets, or compiler options, you can instead make a
14308 @emph{directory} named like @file{all.h.gch}, and put each precompiled
14309 header in the directory, perhaps using @option{-o}.  It doesn't matter
14310 what you call the files in the directory, every precompiled header in
14311 the directory will be considered.  The first precompiled header
14312 encountered in the directory that is valid for this compilation will
14313 be used; they're searched in no particular order.
14315 There are many other possibilities, limited only by your imagination,
14316 good sense, and the constraints of your build system.
14318 A precompiled header file can be used only when these conditions apply:
14320 @itemize
14321 @item
14322 Only one precompiled header can be used in a particular compilation.
14324 @item
14325 A precompiled header can't be used once the first C token is seen.  You
14326 can have preprocessor directives before a precompiled header; you can
14327 even include a precompiled header from inside another header, so long as
14328 there are no C tokens before the @code{#include}.
14330 @item
14331 The precompiled header file must be produced for the same language as
14332 the current compilation.  You can't use a C precompiled header for a C++
14333 compilation.
14335 @item
14336 The precompiled header file must have been produced by the same compiler
14337 binary as the current compilation is using.
14339 @item
14340 Any macros defined before the precompiled header is included must
14341 either be defined in the same way as when the precompiled header was
14342 generated, or must not affect the precompiled header, which usually
14343 means that they don't appear in the precompiled header at all.
14345 The @option{-D} option is one way to define a macro before a
14346 precompiled header is included; using a @code{#define} can also do it.
14347 There are also some options that define macros implicitly, like
14348 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
14349 defined this way.
14351 @item If debugging information is output when using the precompiled
14352 header, using @option{-g} or similar, the same kind of debugging information
14353 must have been output when building the precompiled header.  However,
14354 a precompiled header built using @option{-g} can be used in a compilation
14355 when no debugging information is being output.
14357 @item The same @option{-m} options must generally be used when building
14358 and using the precompiled header.  @xref{Submodel Options},
14359 for any cases where this rule is relaxed.
14361 @item Each of the following options must be the same when building and using
14362 the precompiled header:
14364 @gccoptlist{-fexceptions -funit-at-a-time}
14366 @item
14367 Some other command-line options starting with @option{-f},
14368 @option{-p}, or @option{-O} must be defined in the same way as when
14369 the precompiled header was generated.  At present, it's not clear
14370 which options are safe to change and which are not; the safest choice
14371 is to use exactly the same options when generating and using the
14372 precompiled header.  The following are known to be safe:
14374 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
14375 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
14376 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
14377 -pedantic-errors}
14379 @end itemize
14381 For all of these except the last, the compiler will automatically
14382 ignore the precompiled header if the conditions aren't met.  If you
14383 find an option combination that doesn't work and doesn't cause the
14384 precompiled header to be ignored, please consider filing a bug report,
14385 see @ref{Bugs}.
14387 If you do use differing options when generating and using the
14388 precompiled header, the actual behavior will be a mixture of the
14389 behavior for the options.  For instance, if you use @option{-g} to
14390 generate the precompiled header but not when using it, you may or may
14391 not get debugging information for routines in the precompiled header.
14393 @node Running Protoize
14394 @section Running Protoize
14396 The program @code{protoize} is an optional part of GCC@.  You can use
14397 it to add prototypes to a program, thus converting the program to ISO
14398 C in one respect.  The companion program @code{unprotoize} does the
14399 reverse: it removes argument types from any prototypes that are found.
14401 When you run these programs, you must specify a set of source files as
14402 command line arguments.  The conversion programs start out by compiling
14403 these files to see what functions they define.  The information gathered
14404 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
14406 After scanning comes actual conversion.  The specified files are all
14407 eligible to be converted; any files they include (whether sources or
14408 just headers) are eligible as well.
14410 But not all the eligible files are converted.  By default,
14411 @code{protoize} and @code{unprotoize} convert only source and header
14412 files in the current directory.  You can specify additional directories
14413 whose files should be converted with the @option{-d @var{directory}}
14414 option.  You can also specify particular files to exclude with the
14415 @option{-x @var{file}} option.  A file is converted if it is eligible, its
14416 directory name matches one of the specified directory names, and its
14417 name within the directory has not been excluded.
14419 Basic conversion with @code{protoize} consists of rewriting most
14420 function definitions and function declarations to specify the types of
14421 the arguments.  The only ones not rewritten are those for varargs
14422 functions.
14424 @code{protoize} optionally inserts prototype declarations at the
14425 beginning of the source file, to make them available for any calls that
14426 precede the function's definition.  Or it can insert prototype
14427 declarations with block scope in the blocks where undeclared functions
14428 are called.
14430 Basic conversion with @code{unprotoize} consists of rewriting most
14431 function declarations to remove any argument types, and rewriting
14432 function definitions to the old-style pre-ISO form.
14434 Both conversion programs print a warning for any function declaration or
14435 definition that they can't convert.  You can suppress these warnings
14436 with @option{-q}.
14438 The output from @code{protoize} or @code{unprotoize} replaces the
14439 original source file.  The original file is renamed to a name ending
14440 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
14441 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
14442 for DOS) file already exists, then the source file is simply discarded.
14444 @code{protoize} and @code{unprotoize} both depend on GCC itself to
14445 scan the program and collect information about the functions it uses.
14446 So neither of these programs will work until GCC is installed.
14448 Here is a table of the options you can use with @code{protoize} and
14449 @code{unprotoize}.  Each option works with both programs unless
14450 otherwise stated.
14452 @table @code
14453 @item -B @var{directory}
14454 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
14455 usual directory (normally @file{/usr/local/lib}).  This file contains
14456 prototype information about standard system functions.  This option
14457 applies only to @code{protoize}.
14459 @item -c @var{compilation-options}
14460 Use @var{compilation-options} as the options when running @command{gcc} to
14461 produce the @samp{.X} files.  The special option @option{-aux-info} is
14462 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
14464 Note that the compilation options must be given as a single argument to
14465 @code{protoize} or @code{unprotoize}.  If you want to specify several
14466 @command{gcc} options, you must quote the entire set of compilation options
14467 to make them a single word in the shell.
14469 There are certain @command{gcc} arguments that you cannot use, because they
14470 would produce the wrong kind of output.  These include @option{-g},
14471 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
14472 the @var{compilation-options}, they are ignored.
14474 @item -C
14475 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
14476 systems) instead of @samp{.c}.  This is convenient if you are converting
14477 a C program to C++.  This option applies only to @code{protoize}.
14479 @item -g
14480 Add explicit global declarations.  This means inserting explicit
14481 declarations at the beginning of each source file for each function
14482 that is called in the file and was not declared.  These declarations
14483 precede the first function definition that contains a call to an
14484 undeclared function.  This option applies only to @code{protoize}.
14486 @item -i @var{string}
14487 Indent old-style parameter declarations with the string @var{string}.
14488 This option applies only to @code{protoize}.
14490 @code{unprotoize} converts prototyped function definitions to old-style
14491 function definitions, where the arguments are declared between the
14492 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
14493 uses five spaces as the indentation.  If you want to indent with just
14494 one space instead, use @option{-i " "}.
14496 @item -k
14497 Keep the @samp{.X} files.  Normally, they are deleted after conversion
14498 is finished.
14500 @item -l
14501 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
14502 a prototype declaration for each function in each block which calls the
14503 function without any declaration.  This option applies only to
14504 @code{protoize}.
14506 @item -n
14507 Make no real changes.  This mode just prints information about the conversions
14508 that would have been done without @option{-n}.
14510 @item -N
14511 Make no @samp{.save} files.  The original files are simply deleted.
14512 Use this option with caution.
14514 @item -p @var{program}
14515 Use the program @var{program} as the compiler.  Normally, the name
14516 @file{gcc} is used.
14518 @item -q
14519 Work quietly.  Most warnings are suppressed.
14521 @item -v
14522 Print the version number, just like @option{-v} for @command{gcc}.
14523 @end table
14525 If you need special compiler options to compile one of your program's
14526 source files, then you should generate that file's @samp{.X} file
14527 specially, by running @command{gcc} on that source file with the
14528 appropriate options and the option @option{-aux-info}.  Then run
14529 @code{protoize} on the entire set of files.  @code{protoize} will use
14530 the existing @samp{.X} file because it is newer than the source file.
14531 For example:
14533 @smallexample
14534 gcc -Dfoo=bar file1.c -aux-info file1.X
14535 protoize *.c
14536 @end smallexample
14538 @noindent
14539 You need to include the special files along with the rest in the
14540 @code{protoize} command, even though their @samp{.X} files already
14541 exist, because otherwise they won't get converted.
14543 @xref{Protoize Caveats}, for more information on how to use
14544 @code{protoize} successfully.