Merge -r 127928:132243 from trunk
[official-gcc.git] / gcc / doc / invoke.texi
blob355ed818ce1cfa59496348142ef2accfc4b80f87
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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, 2007, 2008
15 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``GNU General Public License'' and ``Funding
21 Free Software'', the Front-Cover texts being (a) (see below), and with
22 the Back-Cover Texts being (b) (see below).  A copy of the license is
23 included in the gfdl(7) man page.
25 (a) The FSF's Front-Cover Text is:
27      A GNU Manual
29 (b) The FSF's Back-Cover Text is:
31      You have freedom to copy and modify this GNU Manual, like GNU
32      software.  Copies published by the Free Software Foundation raise
33      funds for GNU development.
34 @c man end
35 @c Set file name and title for the man page.
36 @setfilename gcc
37 @settitle GNU project C and C++ compiler
38 @c man begin SYNOPSIS
39 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
40     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
41     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
42     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
43     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
44     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
45     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
47 Only the most useful options are listed here; see below for the
48 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
49 @c man end
50 @c man begin SEEALSO
51 gpl(7), gfdl(7), fsf-funding(7),
52 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
53 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
54 @file{ld}, @file{binutils} and @file{gdb}.
55 @c man end
56 @c man begin BUGS
57 For instructions on reporting bugs, see
58 @w{@value{BUGURL}}.
59 @c man end
60 @c man begin AUTHOR
61 See the Info entry for @command{gcc}, or
62 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
63 for contributors to GCC@.
64 @c man end
65 @end ignore
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
73 @c man begin DESCRIPTION
74 When you invoke GCC, it normally does preprocessing, compilation,
75 assembly and linking.  The ``overall options'' allow you to stop this
76 process at an intermediate stage.  For example, the @option{-c} option
77 says not to run the linker.  Then the output consists of object files
78 output by the assembler.
80 Other options are passed on to one stage of processing.  Some options
81 control the preprocessor and others the compiler itself.  Yet other
82 options control the assembler and linker; most of these are not
83 documented here, since you rarely need to use any of them.
85 @cindex C compilation options
86 Most of the command line options that you can use with GCC are useful
87 for C programs; when an option is only useful with another language
88 (usually C++), the explanation says so explicitly.  If the description
89 for a particular option does not mention a source language, you can use
90 that option with all supported languages.
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
101 -r}}.
103 @cindex order of options
104 @cindex options, order
105 You can mix options and other arguments.  For the most part, the order
106 you use doesn't matter.  Order does matter when you use several
107 options of the same kind; for example, if you specify @option{-L} more
108 than once, the directories are searched in the order specified.  Also,
109 the placement of the @option{-l} option is significant.
111 Many options have long names starting with @samp{-f} or with
112 @samp{-W}---for example,
113 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
114 these have both positive and negative forms; the negative form of
115 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
116 only one of these two forms, whichever one is not the default.
118 @c man end
120 @xref{Option Index}, for an index to GCC's options.
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 * Running Protoize::    Automatically adding or removing function prototypes.
152 @end menu
154 @c man begin OPTIONS
156 @node Option Summary
157 @section Option Summary
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{]}  --target-help  @gol
167 --version @@@var{file}}
169 @item C Language Options
170 @xref{C Dialect Options,,Options Controlling C Dialect}.
171 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
172 -aux-info @var{filename} @gol
173 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
174 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
175 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
176 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
177 -fsigned-bitfields  -fsigned-char @gol
178 -funsigned-bitfields  -funsigned-char}
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
193 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
194 -fno-default-inline  -fvisibility-inlines-hidden @gol
195 -fvisibility-ms-compat @gol
196 -Wabi  -Wctor-dtor-privacy @gol
197 -Wnon-virtual-dtor  -Wreorder @gol
198 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
199 -Wno-non-template-friend  -Wold-style-cast @gol
200 -Woverloaded-virtual  -Wno-pmf-conversions @gol
201 -Wsign-promo}
203 @item Objective-C and Objective-C++ Language Options
204 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
205 Objective-C and Objective-C++ Dialects}.
206 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
207 -fgnu-runtime  -fnext-runtime @gol
208 -fno-nil-receivers @gol
209 -fobjc-call-cxx-cdtors @gol
210 -fobjc-direct-dispatch @gol
211 -fobjc-exceptions @gol
212 -fobjc-gc @gol
213 -freplace-objc-classes @gol
214 -fzero-link @gol
215 -gen-decls @gol
216 -Wassign-intercept @gol
217 -Wno-protocol  -Wselector @gol
218 -Wstrict-selector-match @gol
219 -Wundeclared-selector}
221 @item Language Independent Options
222 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
223 @gccoptlist{-fmessage-length=@var{n}  @gol
224 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
225 -fdiagnostics-show-option}
227 @item Warning Options
228 @xref{Warning Options,,Options to Request or Suppress Warnings}.
229 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
230 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
231 -Wno-attributes -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
232 -Wchar-subscripts -Wclobbered  -Wcomment @gol
233 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated-declarations @gol
234 -Wdisabled-optimization  -Wno-div-by-zero  @gol
235 -Wempty-body  -Wno-endif-labels @gol
236 -Werror  -Werror=* @gol
237 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
238 -Wno-format-extra-args -Wformat-nonliteral @gol
239 -Wformat-security  -Wformat-y2k -Wignored-qualifiers @gol
240 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
241 -Wimport  -Wno-import  -Winit-self  -Winline @gol
242 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
243 -Winvalid-pch -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations @gol
244 -Wlogical-op -Wlong-long @gol
245 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
246 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
247 -Wmissing-noreturn @gol
248 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
249 -Woverlength-strings  -Wpacked  -Wpadded @gol
250 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
251 -Wredundant-decls @gol
252 -Wreturn-type  -Wsequence-point  -Wshadow @gol
253 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
254 -Wstrict-aliasing -Wstrict-aliasing=n @gol
255 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
256 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
257 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
258 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
259 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
260 -Wunused-value  -Wunused-variable @gol
261 -Wvariadic-macros -Wvla @gol
262 -Wvolatile-register-var  -Wwrite-strings}
264 @item C and Objective-C-only Warning Options
265 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
266 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
267 -Wold-style-declaration  -Wold-style-definition @gol
268 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
269 -Wdeclaration-after-statement -Wpointer-sign}
271 @item Debugging Options
272 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
273 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
274 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
275 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
276 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
277 -fdump-simple-rtl @gol
278 -fdump-ipa-all -fdump-ipa-cgraph @gol
279 -fdump-tree-all @gol
280 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
281 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
284 -fdump-tree-ch @gol
285 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-nrv -fdump-tree-vect @gol
294 -fdump-tree-sink @gol
295 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-salias @gol
297 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
299 -ftree-vectorizer-verbose=@var{n} @gol
300 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
301 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
302 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
303 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
304 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
305 -ftest-coverage  -ftime-report -fvar-tracking @gol
306 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
307 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
308 -fno-merge-debug-strings -fdebug-prefix-map=@var{old}=@var{new} @gol
309 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
310 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
311 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
312 -print-multi-directory  -print-multi-lib @gol
313 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
314 -print-sysroot-headers-suffix @gol
315 -save-temps  -time}
317 @item Optimization Options
318 @xref{Optimize Options,,Options that Control Optimization}.
319 @gccoptlist{
320 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
321 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
322 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
323 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
324 -fcheck-data-deps -fcprop-registers -fcrossjumping -fcse-follow-jumps @gol
325 -fcse-skip-blocks -fcx-limited-range -fdata-sections -fdce -fdce @gol
326 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
327 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
328 -ffinite-math-only -ffloat-store -fforward-propagate @gol
329 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
330 -fgcse-sm -fif-conversion -fif-conversion2 -finline-functions @gol
331 -finline-functions-called-once -finline-limit=@var{n} @gol
332 -finline-small-functions -fipa-cp -fipa-marix-reorg -fipa-pta @gol 
333 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
334 -fipa-type-escape -fira -fira-algorithm=@var{algorithm} @gol
335 -fira-coalesce -fira-ipra -fno-ira-move-spills @gol
336 -fira-propagate-cost -fno-ira-share-spill-slots @gol
337 -fno-ira-share-save-slots -fira-verbose=@var{n} @gol
338 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
339 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
340 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
341 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
342 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
343 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
344 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
345 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
346 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
347 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
348 -fprofile-generate -fprofile-use -fprofile-values -freciprocal-math @gol
349 -fregmove -frename-registers -freorder-blocks @gol
350 -freorder-blocks-and-partition -freorder-functions @gol
351 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
352 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
353 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
354 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
355 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
356 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
357 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
358 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer -ftree-ccp @gol
359 -ftree-ch -ftree-copy-prop -ftree-copyrename -ftree-dce @gol
360 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
361 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
362 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc -ftree-salias @gol
363 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-ter @gol
364 -ftree-vect-loop-version -ftree-vectorize -ftree-vrp -funit-at-a-time @gol
365 -funroll-all-loops -funroll-loops -funsafe-loop-optimizations @gol
366 -funsafe-math-optimizations -funswitch-loops @gol
367 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
368 -fwhole-program @gol
369 --param @var{name}=@var{value}
370 -O  -O0  -O1  -O2  -O3  -Os}
372 @item Preprocessor Options
373 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
374 @gccoptlist{-A@var{question}=@var{answer} @gol
375 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
376 -C  -dD  -dI  -dM  -dN @gol
377 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
378 -idirafter @var{dir} @gol
379 -include @var{file}  -imacros @var{file} @gol
380 -iprefix @var{file}  -iwithprefix @var{dir} @gol
381 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
382 -imultilib @var{dir} -isysroot @var{dir} @gol
383 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
384 -P  -fworking-directory  -remap @gol
385 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
386 -Xpreprocessor @var{option}}
388 @item Assembler Option
389 @xref{Assembler Options,,Passing Options to the Assembler}.
390 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
392 @item Linker Options
393 @xref{Link Options,,Options for Linking}.
394 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
395 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
396 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
397 -Wl,@var{option}  -Xlinker @var{option} @gol
398 -u @var{symbol}}
400 @item Directory Options
401 @xref{Directory Options,,Options for Directory Search}.
402 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
403 -specs=@var{file}  -I- --sysroot=@var{dir}}
405 @item Target Options
406 @c I wrote this xref this way to avoid overfull hbox. -- rms
407 @xref{Target Options}.
408 @gccoptlist{-V @var{version}  -b @var{machine}}
410 @item Machine Dependent Options
411 @xref{Submodel Options,,Hardware Models and Configurations}.
412 @c This list is ordered alphanumerically by subsection name.
413 @c Try and put the significant identifier (CPU or system) first,
414 @c so users have a clue at guessing where the ones they want will be.
416 @emph{ARC Options}
417 @gccoptlist{-EB  -EL @gol
418 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
419 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
421 @emph{ARM Options}
422 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
423 -mabi=@var{name} @gol
424 -mapcs-stack-check  -mno-apcs-stack-check @gol
425 -mapcs-float  -mno-apcs-float @gol
426 -mapcs-reentrant  -mno-apcs-reentrant @gol
427 -msched-prolog  -mno-sched-prolog @gol
428 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
429 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
430 -mthumb-interwork  -mno-thumb-interwork @gol
431 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
432 -mstructure-size-boundary=@var{n} @gol
433 -mabort-on-noreturn @gol
434 -mlong-calls  -mno-long-calls @gol
435 -msingle-pic-base  -mno-single-pic-base @gol
436 -mpic-register=@var{reg} @gol
437 -mnop-fun-dllimport @gol
438 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
439 -mpoke-function-name @gol
440 -mthumb  -marm @gol
441 -mtpcs-frame  -mtpcs-leaf-frame @gol
442 -mcaller-super-interworking  -mcallee-super-interworking @gol
443 -mtp=@var{name}}
445 @emph{AVR Options}
446 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
447 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
449 @emph{Blackfin Options}
450 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
451 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
452 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
453 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
454 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
455 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
456 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
457 -mfast-fp -minline-plt}
459 @emph{CRIS Options}
460 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
461 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
462 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
463 -mstack-align  -mdata-align  -mconst-align @gol
464 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
465 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
466 -mmul-bug-workaround  -mno-mul-bug-workaround}
468 @emph{CRX Options}
469 @gccoptlist{-mmac -mpush-args}
471 @emph{Darwin Options}
472 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
473 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
474 -client_name  -compatibility_version  -current_version @gol
475 -dead_strip @gol
476 -dependency-file  -dylib_file  -dylinker_install_name @gol
477 -dynamic  -dynamiclib  -exported_symbols_list @gol
478 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
479 -force_flat_namespace  -headerpad_max_install_names @gol
480 -iframework @gol
481 -image_base  -init  -install_name  -keep_private_externs @gol
482 -multi_module  -multiply_defined  -multiply_defined_unused @gol
483 -noall_load   -no_dead_strip_inits_and_terms @gol
484 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
485 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
486 -private_bundle  -read_only_relocs  -sectalign @gol
487 -sectobjectsymbols  -whyload  -seg1addr @gol
488 -sectcreate  -sectobjectsymbols  -sectorder @gol
489 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
490 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
491 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
492 -single_module  -static  -sub_library  -sub_umbrella @gol
493 -twolevel_namespace  -umbrella  -undefined @gol
494 -unexported_symbols_list  -weak_reference_mismatches @gol
495 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
496 -mkernel -mone-byte-bool}
498 @emph{DEC Alpha Options}
499 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
500 -mieee  -mieee-with-inexact  -mieee-conformant @gol
501 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
502 -mtrap-precision=@var{mode}  -mbuild-constants @gol
503 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
504 -mbwx  -mmax  -mfix  -mcix @gol
505 -mfloat-vax  -mfloat-ieee @gol
506 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
507 -msmall-text  -mlarge-text @gol
508 -mmemory-latency=@var{time}}
510 @emph{DEC Alpha/VMS Options}
511 @gccoptlist{-mvms-return-codes}
513 @emph{FRV Options}
514 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
515 -mhard-float  -msoft-float @gol
516 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
517 -mdouble  -mno-double @gol
518 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
519 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
520 -mlinked-fp  -mlong-calls  -malign-labels @gol
521 -mlibrary-pic  -macc-4  -macc-8 @gol
522 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
523 -moptimize-membar -mno-optimize-membar @gol
524 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
525 -mvliw-branch  -mno-vliw-branch @gol
526 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
527 -mno-nested-cond-exec  -mtomcat-stats @gol
528 -mTLS -mtls @gol
529 -mcpu=@var{cpu}}
531 @emph{GNU/Linux Options}
532 @gccoptlist{-muclibc}
534 @emph{H8/300 Options}
535 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
537 @emph{HPPA Options}
538 @gccoptlist{-march=@var{architecture-type} @gol
539 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
540 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
541 -mfixed-range=@var{register-range} @gol
542 -mjump-in-delay -mlinker-opt -mlong-calls @gol
543 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
544 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
545 -mno-jump-in-delay  -mno-long-load-store @gol
546 -mno-portable-runtime  -mno-soft-float @gol
547 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
548 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
549 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
550 -munix=@var{unix-std}  -nolibdld  -static  -threads}
552 @emph{i386 and x86-64 Options}
553 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
554 -mfpmath=@var{unit} @gol
555 -masm=@var{dialect}  -mno-fancy-math-387 @gol
556 -mno-fp-ret-in-387  -msoft-float @gol
557 -mno-wide-multiply  -mrtd  -malign-double @gol
558 -mpreferred-stack-boundary=@var{num} -mcx16 -msahf -mrecip @gol
559 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
560 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
561 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
562 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
563 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
564 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
565 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
566 -mcmodel=@var{code-model} @gol
567 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
568 -mfused-madd -mno-fused-madd}
570 @emph{IA-64 Options}
571 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
572 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
573 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
574 -minline-float-divide-max-throughput @gol
575 -minline-int-divide-min-latency @gol
576 -minline-int-divide-max-throughput  @gol
577 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
578 -mno-dwarf2-asm -mearly-stop-bits @gol
579 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
580 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
581 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
582 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
583 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
584 -mno-sched-prefer-non-data-spec-insns @gol
585 -mno-sched-prefer-non-control-spec-insns @gol
586 -mno-sched-count-spec-in-critical-path}
588 @emph{M32R/D Options}
589 @gccoptlist{-m32r2 -m32rx -m32r @gol
590 -mdebug @gol
591 -malign-loops -mno-align-loops @gol
592 -missue-rate=@var{number} @gol
593 -mbranch-cost=@var{number} @gol
594 -mmodel=@var{code-size-model-type} @gol
595 -msdata=@var{sdata-type} @gol
596 -mno-flush-func -mflush-func=@var{name} @gol
597 -mno-flush-trap -mflush-trap=@var{number} @gol
598 -G @var{num}}
600 @emph{M32C Options}
601 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
603 @emph{M680x0 Options}
604 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
605 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
606 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
607 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
608 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
609 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
610 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
611 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
613 @emph{M68hc1x Options}
614 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
615 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
616 -msoft-reg-count=@var{count}}
618 @emph{MCore Options}
619 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
620 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
621 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
622 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
623 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
625 @emph{MIPS Options}
626 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
627 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
628 -mips16  -mno-mips16  -mflip-mips16 @gol
629 -minterlink-mips16  -mno-interlink-mips16 @gol
630 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
631 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
632 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
633 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
634 -msmartmips  -mno-smartmips @gol
635 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
636 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
637 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
638 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
639 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
640 -membedded-data  -mno-embedded-data @gol
641 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
642 -mcode-readable=@var{setting} @gol
643 -msplit-addresses  -mno-split-addresses @gol
644 -mexplicit-relocs  -mno-explicit-relocs @gol
645 -mcheck-zero-division  -mno-check-zero-division @gol
646 -mdivide-traps  -mdivide-breaks @gol
647 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
648 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
649 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
650 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
651 -mfix-sb1  -mno-fix-sb1 @gol
652 -mflush-func=@var{func}  -mno-flush-func @gol
653 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
654 -mfp-exceptions -mno-fp-exceptions @gol
655 -mvr4130-align -mno-vr4130-align}
657 @emph{MMIX Options}
658 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
659 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
660 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
661 -mno-base-addresses  -msingle-exit  -mno-single-exit}
663 @emph{MN10300 Options}
664 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
665 -mam33  -mno-am33 @gol
666 -mam33-2  -mno-am33-2 @gol
667 -mreturn-pointer-on-d0 @gol
668 -mno-crt0  -mrelax}
670 @emph{MT Options}
671 @gccoptlist{-mno-crt0 -mbacc -msim @gol
672 -march=@var{cpu-type} }
674 @emph{PDP-11 Options}
675 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
676 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
677 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
678 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
679 -mbranch-expensive  -mbranch-cheap @gol
680 -msplit  -mno-split  -munix-asm  -mdec-asm}
682 @emph{PowerPC Options}
683 See RS/6000 and PowerPC Options.
685 @emph{RS/6000 and PowerPC Options}
686 @gccoptlist{-mcpu=@var{cpu-type} @gol
687 -mtune=@var{cpu-type} @gol
688 -mpower  -mno-power  -mpower2  -mno-power2 @gol
689 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
690 -maltivec  -mno-altivec @gol
691 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
692 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
693 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
694 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
695 -mnew-mnemonics  -mold-mnemonics @gol
696 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
697 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
698 -malign-power  -malign-natural @gol
699 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
700 -mstring  -mno-string  -mupdate  -mno-update @gol
701 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
702 -mstrict-align  -mno-strict-align  -mrelocatable @gol
703 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
704 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
705 -mdynamic-no-pic  -maltivec  -mswdiv @gol
706 -mprioritize-restricted-insns=@var{priority} @gol
707 -msched-costly-dep=@var{dependence_type} @gol
708 -minsert-sched-nops=@var{scheme} @gol
709 -mcall-sysv  -mcall-netbsd @gol
710 -maix-struct-return  -msvr4-struct-return @gol
711 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
712 -misel -mno-isel @gol
713 -misel=yes  -misel=no @gol
714 -mspe -mno-spe @gol
715 -mspe=yes  -mspe=no @gol
716 -mpaired @gol
717 -mvrsave -mno-vrsave @gol
718 -mmulhw -mno-mulhw @gol
719 -mdlmzb -mno-dlmzb @gol
720 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
721 -mprototype  -mno-prototype @gol
722 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
723 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
725 @emph{S/390 and zSeries Options}
726 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
727 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
728 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
729 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
730 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
731 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
732 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
734 @emph{Score Options}
735 @gccoptlist{-meb -mel @gol
736 -mnhwloop @gol
737 -muls @gol
738 -mmac @gol
739 -mscore5 -mscore5u -mscore7 -mscore7d}
741 @emph{SH Options}
742 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
743 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
744 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
745 -m5-64media  -m5-64media-nofpu @gol
746 -m5-32media  -m5-32media-nofpu @gol
747 -m5-compact  -m5-compact-nofpu @gol
748 -mb  -ml  -mdalign  -mrelax @gol
749 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
750 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
751 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
752 -mdivsi3_libfunc=@var{name}  @gol
753 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
754  -minvalid-symbols}
756 @emph{SPARC Options}
757 @gccoptlist{-mcpu=@var{cpu-type} @gol
758 -mtune=@var{cpu-type} @gol
759 -mcmodel=@var{code-model} @gol
760 -m32  -m64  -mapp-regs  -mno-app-regs @gol
761 -mfaster-structs  -mno-faster-structs @gol
762 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
763 -mhard-quad-float  -msoft-quad-float @gol
764 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
765 -mstack-bias  -mno-stack-bias @gol
766 -munaligned-doubles  -mno-unaligned-doubles @gol
767 -mv8plus  -mno-v8plus  -mvis  -mno-vis
768 -threads -pthreads -pthread}
770 @emph{SPU Options}
771 @gccoptlist{-mwarn-reloc -merror-reloc @gol
772 -msafe-dma -munsafe-dma @gol
773 -mbranch-hints @gol
774 -msmall-mem -mlarge-mem -mstdmain @gol
775 -mfixed-range=@var{register-range}}
777 @emph{System V Options}
778 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
780 @emph{V850 Options}
781 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
782 -mprolog-function  -mno-prolog-function  -mspace @gol
783 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
784 -mapp-regs  -mno-app-regs @gol
785 -mdisable-callt  -mno-disable-callt @gol
786 -mv850e1 @gol
787 -mv850e @gol
788 -mv850  -mbig-switch}
790 @emph{VAX Options}
791 @gccoptlist{-mg  -mgnu  -munix}
793 @emph{VxWorks Options}
794 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
795 -Xbind-lazy  -Xbind-now}
797 @emph{x86-64 Options}
798 See i386 and x86-64 Options.
800 @emph{Xstormy16 Options}
801 @gccoptlist{-msim}
803 @emph{Xtensa Options}
804 @gccoptlist{-mconst16 -mno-const16 @gol
805 -mfused-madd  -mno-fused-madd @gol
806 -mtext-section-literals  -mno-text-section-literals @gol
807 -mtarget-align  -mno-target-align @gol
808 -mlongcalls  -mno-longcalls}
810 @emph{zSeries Options}
811 See S/390 and zSeries Options.
813 @item Code Generation Options
814 @xref{Code Gen Options,,Options for Code Generation Conventions}.
815 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
816 -ffixed-@var{reg}  -fexceptions @gol
817 -fnon-call-exceptions  -funwind-tables @gol
818 -fasynchronous-unwind-tables @gol
819 -finhibit-size-directive  -finstrument-functions @gol
820 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
821 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
822 -fno-common  -fno-ident @gol
823 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
824 -fno-jump-tables @gol
825 -frecord-gcc-switches @gol
826 -freg-struct-return  -fshort-enums @gol
827 -fshort-double  -fshort-wchar @gol
828 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
829 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
830 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
831 -fargument-noalias-global  -fargument-noalias-anything @gol
832 -fleading-underscore  -ftls-model=@var{model} @gol
833 -ftrapv  -fwrapv  -fbounds-check @gol
834 -fvisibility}
835 @end table
837 @menu
838 * Overall Options::     Controlling the kind of output:
839                         an executable, object files, assembler files,
840                         or preprocessed source.
841 * C Dialect Options::   Controlling the variant of C language compiled.
842 * C++ Dialect Options:: Variations on C++.
843 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
844                         and Objective-C++.
845 * Language Independent Options:: Controlling how diagnostics should be
846                         formatted.
847 * Warning Options::     How picky should the compiler be?
848 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
849 * Optimize Options::    How much optimization?
850 * Preprocessor Options:: Controlling header files and macro definitions.
851                          Also, getting dependency information for Make.
852 * Assembler Options::   Passing options to the assembler.
853 * Link Options::        Specifying libraries and so on.
854 * Directory Options::   Where to find header files and libraries.
855                         Where to find the compiler executable files.
856 * Spec Files::          How to pass switches to sub-processes.
857 * Target Options::      Running a cross-compiler, or an old version of GCC.
858 @end menu
860 @node Overall Options
861 @section Options Controlling the Kind of Output
863 Compilation can involve up to four stages: preprocessing, compilation
864 proper, assembly and linking, always in that order.  GCC is capable of
865 preprocessing and compiling several files either into several
866 assembler input files, or into one assembler input file; then each
867 assembler input file produces an object file, and linking combines all
868 the object files (those newly compiled, and those specified as input)
869 into an executable file.
871 @cindex file name suffix
872 For any given input file, the file name suffix determines what kind of
873 compilation is done:
875 @table @gcctabopt
876 @item @var{file}.c
877 C source code which must be preprocessed.
879 @item @var{file}.i
880 C source code which should not be preprocessed.
882 @item @var{file}.ii
883 C++ source code which should not be preprocessed.
885 @item @var{file}.m
886 Objective-C source code.  Note that you must link with the @file{libobjc}
887 library to make an Objective-C program work.
889 @item @var{file}.mi
890 Objective-C source code which should not be preprocessed.
892 @item @var{file}.mm
893 @itemx @var{file}.M
894 Objective-C++ source code.  Note that you must link with the @file{libobjc}
895 library to make an Objective-C++ program work.  Note that @samp{.M} refers
896 to a literal capital M@.
898 @item @var{file}.mii
899 Objective-C++ source code which should not be preprocessed.
901 @item @var{file}.h
902 C, C++, Objective-C or Objective-C++ header file to be turned into a
903 precompiled header.
905 @item @var{file}.cc
906 @itemx @var{file}.cp
907 @itemx @var{file}.cxx
908 @itemx @var{file}.cpp
909 @itemx @var{file}.CPP
910 @itemx @var{file}.c++
911 @itemx @var{file}.C
912 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
913 the last two letters must both be literally @samp{x}.  Likewise,
914 @samp{.C} refers to a literal capital C@.
916 @item @var{file}.mm
917 @itemx @var{file}.M
918 Objective-C++ source code which must be preprocessed.
920 @item @var{file}.mii
921 Objective-C++ source code which should not be preprocessed.
923 @item @var{file}.hh
924 @itemx @var{file}.H
925 @itemx @var{file}.hp
926 @itemx @var{file}.hxx
927 @itemx @var{file}.hpp
928 @itemx @var{file}.HPP
929 @itemx @var{file}.h++
930 @itemx @var{file}.tcc
931 C++ header file to be turned into a precompiled header.
933 @item @var{file}.f
934 @itemx @var{file}.for
935 @itemx @var{file}.FOR
936 Fixed form Fortran source code which should not be preprocessed.
938 @item @var{file}.F
939 @itemx @var{file}.fpp
940 @itemx @var{file}.FPP
941 Fixed form Fortran source code which must be preprocessed (with the traditional
942 preprocessor).
944 @item @var{file}.f90
945 @itemx @var{file}.f95
946 Free form Fortran source code which should not be preprocessed.
948 @item @var{file}.F90
949 @itemx @var{file}.F95
950 Free form Fortran source code which must be preprocessed (with the
951 traditional preprocessor).
953 @c FIXME: Descriptions of Java file types.
954 @c @var{file}.java
955 @c @var{file}.class
956 @c @var{file}.zip
957 @c @var{file}.jar
959 @item @var{file}.ads
960 Ada source code file which contains a library unit declaration (a
961 declaration of a package, subprogram, or generic, or a generic
962 instantiation), or a library unit renaming declaration (a package,
963 generic, or subprogram renaming declaration).  Such files are also
964 called @dfn{specs}.
966 @itemx @var{file}.adb
967 Ada source code file containing a library unit body (a subprogram or
968 package body).  Such files are also called @dfn{bodies}.
970 @c GCC also knows about some suffixes for languages not yet included:
971 @c Pascal:
972 @c @var{file}.p
973 @c @var{file}.pas
974 @c Ratfor:
975 @c @var{file}.r
977 @item @var{file}.s
978 Assembler code.
980 @item @var{file}.S
981 @itemx @var{file}.sx
982 Assembler code which must be preprocessed.
984 @item @var{other}
985 An object file to be fed straight into linking.
986 Any file name with no recognized suffix is treated this way.
987 @end table
989 @opindex x
990 You can specify the input language explicitly with the @option{-x} option:
992 @table @gcctabopt
993 @item -x @var{language}
994 Specify explicitly the @var{language} for the following input files
995 (rather than letting the compiler choose a default based on the file
996 name suffix).  This option applies to all following input files until
997 the next @option{-x} option.  Possible values for @var{language} are:
998 @smallexample
999 c  c-header  c-cpp-output
1000 c++  c++-header  c++-cpp-output
1001 objective-c  objective-c-header  objective-c-cpp-output
1002 objective-c++ objective-c++-header objective-c++-cpp-output
1003 assembler  assembler-with-cpp
1005 f95  f95-cpp-input
1006 java
1007 treelang
1008 @end smallexample
1010 @item -x none
1011 Turn off any specification of a language, so that subsequent files are
1012 handled according to their file name suffixes (as they are if @option{-x}
1013 has not been used at all).
1015 @item -pass-exit-codes
1016 @opindex pass-exit-codes
1017 Normally the @command{gcc} program will exit with the code of 1 if any
1018 phase of the compiler returns a non-success return code.  If you specify
1019 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1020 numerically highest error produced by any phase that returned an error
1021 indication.  The C, C++, and Fortran frontends return 4, if an internal
1022 compiler error is encountered.
1023 @end table
1025 If you only want some of the stages of compilation, you can use
1026 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1027 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1028 @command{gcc} is to stop.  Note that some combinations (for example,
1029 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1031 @table @gcctabopt
1032 @item -c
1033 @opindex c
1034 Compile or assemble the source files, but do not link.  The linking
1035 stage simply is not done.  The ultimate output is in the form of an
1036 object file for each source file.
1038 By default, the object file name for a source file is made by replacing
1039 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1041 Unrecognized input files, not requiring compilation or assembly, are
1042 ignored.
1044 @item -S
1045 @opindex S
1046 Stop after the stage of compilation proper; do not assemble.  The output
1047 is in the form of an assembler code file for each non-assembler input
1048 file specified.
1050 By default, the assembler file name for a source file is made by
1051 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1053 Input files that don't require compilation are ignored.
1055 @item -E
1056 @opindex E
1057 Stop after the preprocessing stage; do not run the compiler proper.  The
1058 output is in the form of preprocessed source code, which is sent to the
1059 standard output.
1061 Input files which don't require preprocessing are ignored.
1063 @cindex output file option
1064 @item -o @var{file}
1065 @opindex o
1066 Place output in file @var{file}.  This applies regardless to whatever
1067 sort of output is being produced, whether it be an executable file,
1068 an object file, an assembler file or preprocessed C code.
1070 If @option{-o} is not specified, the default is to put an executable
1071 file in @file{a.out}, the object file for
1072 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1073 assembler file in @file{@var{source}.s}, a precompiled header file in
1074 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1075 standard output.
1077 @item -v
1078 @opindex v
1079 Print (on standard error output) the commands executed to run the stages
1080 of compilation.  Also print the version number of the compiler driver
1081 program and of the preprocessor and the compiler proper.
1083 @item -###
1084 @opindex ###
1085 Like @option{-v} except the commands are not executed and all command
1086 arguments are quoted.  This is useful for shell scripts to capture the
1087 driver-generated command lines.
1089 @item -pipe
1090 @opindex pipe
1091 Use pipes rather than temporary files for communication between the
1092 various stages of compilation.  This fails to work on some systems where
1093 the assembler is unable to read from a pipe; but the GNU assembler has
1094 no trouble.
1096 @item -combine
1097 @opindex combine
1098 If you are compiling multiple source files, this option tells the driver
1099 to pass all the source files to the compiler at once (for those
1100 languages for which the compiler can handle this).  This will allow
1101 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1102 language for which this is supported is C@.  If you pass source files for
1103 multiple languages to the driver, using this option, the driver will invoke
1104 the compiler(s) that support IMA once each, passing each compiler all the
1105 source files appropriate for it.  For those languages that do not support
1106 IMA this option will be ignored, and the compiler will be invoked once for
1107 each source file in that language.  If you use this option in conjunction
1108 with @option{-save-temps}, the compiler will generate multiple
1109 pre-processed files
1110 (one for each source file), but only one (combined) @file{.o} or
1111 @file{.s} file.
1113 @item --help
1114 @opindex help
1115 Print (on the standard output) a description of the command line options
1116 understood by @command{gcc}.  If the @option{-v} option is also specified
1117 then @option{--help} will also be passed on to the various processes
1118 invoked by @command{gcc}, so that they can display the command line options
1119 they accept.  If the @option{-Wextra} option has also been specified
1120 (prior to the @option{--help} option), then command line options which
1121 have no documentation associated with them will also be displayed.
1123 @item --target-help
1124 @opindex target-help
1125 Print (on the standard output) a description of target-specific command
1126 line options for each tool.  For some targets extra target-specific
1127 information may also be printed.
1129 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1130 Print (on the standard output) a description of the command line
1131 options understood by the compiler that fit into a specific class.
1132 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1133 @samp{params}, or @var{language}:
1135 @table @asis
1136 @item @samp{optimizers}
1137 This will display all of the optimization options supported by the
1138 compiler.
1140 @item @samp{warnings}
1141 This will display all of the options controlling warning messages
1142 produced by the compiler.
1144 @item @samp{target}
1145 This will display target-specific options.  Unlike the
1146 @option{--target-help} option however, target-specific options of the
1147 linker and assembler will not be displayed.  This is because those
1148 tools do not currently support the extended @option{--help=} syntax.
1150 @item @samp{params}
1151 This will display the values recognized by the @option{--param}
1152 option.
1154 @item @var{language}
1155 This will display the options supported for @var{language}, where 
1156 @var{language} is the name of one of the languages supported in this 
1157 version of GCC.
1159 @item @samp{common}
1160 This will display the options that are common to all languages.
1161 @end table
1163 It is possible to further refine the output of the @option{--help=}
1164 option by adding a comma separated list of qualifiers after the
1165 class.  These can be any from the following list:
1167 @table @asis
1168 @item @samp{undocumented}
1169 Display only those options which are undocumented.
1171 @item @samp{joined}
1172 Display options which take an argument that appears after an equal
1173 sign in the same continuous piece of text, such as:
1174 @samp{--help=target}.
1176 @item @samp{separate}
1177 Display options which take an argument that appears as a separate word
1178 following the original option, such as: @samp{-o output-file}.
1179 @end table
1181 Thus for example to display all the undocumented target-specific
1182 switches supported by the compiler the following can be used:
1184 @smallexample
1185 --help=target,undocumented
1186 @end smallexample
1188 The sense of a qualifier can be inverted by prefixing it with the
1189 @var{^} character, so for example to display all binary warning
1190 options (i.e. ones that are either on or off and that do not take an
1191 argument), which have a description the following can be used:
1193 @smallexample
1194 --help=warnings,^joined,^undocumented
1195 @end smallexample
1197 A class can also be used as a qualifier, although this usually
1198 restricts the output by so much that there is nothing to display.  One
1199 case where it does work however is when one of the classes is
1200 @var{target}.  So for example to display all the target-specific
1201 optimization options the following can be used:
1203 @smallexample
1204 --help=target,optimizers
1205 @end smallexample
1207 The @option{--help=} option can be repeated on the command line.  Each
1208 successive use will display its requested class of options, skipping
1209 those that have already been displayed.
1211 If the @option{-Q} option appears on the command line before the
1212 @option{--help=} option, then the descriptive text displayed by
1213 @option{--help=} is changed.  Instead of describing the displayed
1214 options, an indication is given as to whether the option is enabled,
1215 disabled or set to a specific value (assuming that the compiler
1216 knows this at the point where the @option{--help=} option is used).
1218 Here is a truncated example from the ARM port of @command{gcc}:
1220 @smallexample
1221   % gcc -Q -mabi=2 --help=target -c
1222   The following options are target specific:
1223   -mabi=                                2
1224   -mabort-on-noreturn                   [disabled]
1225   -mapcs                                [disabled]
1226 @end smallexample
1228 The output is sensitive to the effects of previous command line
1229 options, so for example it is possible to find out which optimizations
1230 are enabled at @option{-O2} by using:
1232 @smallexample
1233 -O2 --help=optimizers
1234 @end smallexample
1236 Alternatively you can discover which binary optimizations are enabled
1237 by @option{-O3} by using:
1239 @smallexample
1240 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1241 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1242 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1243 @end smallexample
1245 @item --version
1246 @opindex version
1247 Display the version number and copyrights of the invoked GCC@.
1249 @include @value{srcdir}/../libiberty/at-file.texi
1250 @end table
1252 @node Invoking G++
1253 @section Compiling C++ Programs
1255 @cindex suffixes for C++ source
1256 @cindex C++ source file suffixes
1257 C++ source files conventionally use one of the suffixes @samp{.C},
1258 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1259 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1260 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1261 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1262 files with these names and compiles them as C++ programs even if you
1263 call the compiler the same way as for compiling C programs (usually
1264 with the name @command{gcc}).
1266 @findex g++
1267 @findex c++
1268 However, the use of @command{gcc} does not add the C++ library.
1269 @command{g++} is a program that calls GCC and treats @samp{.c},
1270 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1271 files unless @option{-x} is used, and automatically specifies linking
1272 against the C++ library.  This program is also useful when
1273 precompiling a C header file with a @samp{.h} extension for use in C++
1274 compilations.  On many systems, @command{g++} is also installed with
1275 the name @command{c++}.
1277 @cindex invoking @command{g++}
1278 When you compile C++ programs, you may specify many of the same
1279 command-line options that you use for compiling programs in any
1280 language; or command-line options meaningful for C and related
1281 languages; or options that are meaningful only for C++ programs.
1282 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1283 explanations of options for languages related to C@.
1284 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1285 explanations of options that are meaningful only for C++ programs.
1287 @node C Dialect Options
1288 @section Options Controlling C Dialect
1289 @cindex dialect options
1290 @cindex language dialect options
1291 @cindex options, dialect
1293 The following options control the dialect of C (or languages derived
1294 from C, such as C++, Objective-C and Objective-C++) that the compiler
1295 accepts:
1297 @table @gcctabopt
1298 @cindex ANSI support
1299 @cindex ISO support
1300 @item -ansi
1301 @opindex ansi
1302 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1303 equivalent to @samp{-std=c++98}.
1305 This turns off certain features of GCC that are incompatible with ISO
1306 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1307 such as the @code{asm} and @code{typeof} keywords, and
1308 predefined macros such as @code{unix} and @code{vax} that identify the
1309 type of system you are using.  It also enables the undesirable and
1310 rarely used ISO trigraph feature.  For the C compiler,
1311 it disables recognition of C++ style @samp{//} comments as well as
1312 the @code{inline} keyword.
1314 The alternate keywords @code{__asm__}, @code{__extension__},
1315 @code{__inline__} and @code{__typeof__} continue to work despite
1316 @option{-ansi}.  You would not want to use them in an ISO C program, of
1317 course, but it is useful to put them in header files that might be included
1318 in compilations done with @option{-ansi}.  Alternate predefined macros
1319 such as @code{__unix__} and @code{__vax__} are also available, with or
1320 without @option{-ansi}.
1322 The @option{-ansi} option does not cause non-ISO programs to be
1323 rejected gratuitously.  For that, @option{-pedantic} is required in
1324 addition to @option{-ansi}.  @xref{Warning Options}.
1326 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1327 option is used.  Some header files may notice this macro and refrain
1328 from declaring certain functions or defining certain macros that the
1329 ISO standard doesn't call for; this is to avoid interfering with any
1330 programs that might use these names for other things.
1332 Functions that would normally be built in but do not have semantics
1333 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1334 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1335 built-in functions provided by GCC}, for details of the functions
1336 affected.
1338 @item -std=
1339 @opindex std
1340 Determine the language standard. @xref{Standards,,Language Standards
1341 Supported by GCC}, for details of these standard versions.  This option
1342 is currently only supported when compiling C or C++. 
1344 A value for this option must be provided; possible values are
1346 @table @samp
1347 @item c89
1348 @itemx iso9899:1990
1349 ISO C90 (same as @option{-ansi}).
1351 @item iso9899:199409
1352 ISO C90 as modified in amendment 1.
1354 @item c99
1355 @itemx c9x
1356 @itemx iso9899:1999
1357 @itemx iso9899:199x
1358 ISO C99.  Note that this standard is not yet fully supported; see
1359 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1360 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1362 @item gnu89
1363 Default, ISO C90 plus GNU extensions (including some C99 features).
1365 @item gnu99
1366 @itemx gnu9x
1367 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1368 this will become the default.  The name @samp{gnu9x} is deprecated.
1370 @item c++98
1371 The 1998 ISO C++ standard plus amendments.
1373 @item gnu++98
1374 The same as @option{-std=c++98} plus GNU extensions.  This is the
1375 default for C++ code.
1377 @item c++0x
1378 The working draft of the upcoming ISO C++0x standard. This option
1379 enables experimental features that are likely to be included in
1380 C++0x. The working draft is constantly changing, and any feature that is
1381 enabled by this flag may be removed from future versions of GCC if it is
1382 not part of the C++0x standard.
1384 @item gnu++0x
1385 The same as @option{-std=c++0x} plus GNU extensions. As with
1386 @option{-std=c++0x}, this option enables experimental features that may
1387 be removed in future versions of GCC.
1388 @end table
1390 Even when this option is not specified, you can still use some of the
1391 features of newer standards in so far as they do not conflict with
1392 previous C standards.  For example, you may use @code{__restrict__} even
1393 when @option{-std=c99} is not specified.
1395 The @option{-std} options specifying some version of ISO C have the same
1396 effects as @option{-ansi}, except that features that were not in ISO C90
1397 but are in the specified version (for example, @samp{//} comments and
1398 the @code{inline} keyword in ISO C99) are not disabled.
1400 @item -fgnu89-inline
1401 @opindex fgnu89-inline
1402 The option @option{-fgnu89-inline} tells GCC to use the traditional
1403 GNU semantics for @code{inline} functions when in C99 mode.
1404 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1405 is accepted and ignored by GCC versions 4.1.3 up to but not including
1406 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1407 C99 mode.  Using this option is roughly equivalent to adding the
1408 @code{gnu_inline} function attribute to all inline functions
1409 (@pxref{Function Attributes}).
1411 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1412 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1413 specifies the default behavior).  This option was first supported in
1414 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1416 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1417 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1418 in effect for @code{inline} functions.  @xref{Common Predefined
1419 Macros,,,cpp,The C Preprocessor}.
1421 @item -aux-info @var{filename}
1422 @opindex aux-info
1423 Output to the given filename prototyped declarations for all functions
1424 declared and/or defined in a translation unit, including those in header
1425 files.  This option is silently ignored in any language other than C@.
1427 Besides declarations, the file indicates, in comments, the origin of
1428 each declaration (source file and line), whether the declaration was
1429 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1430 @samp{O} for old, respectively, in the first character after the line
1431 number and the colon), and whether it came from a declaration or a
1432 definition (@samp{C} or @samp{F}, respectively, in the following
1433 character).  In the case of function definitions, a K&R-style list of
1434 arguments followed by their declarations is also provided, inside
1435 comments, after the declaration.
1437 @item -fno-asm
1438 @opindex fno-asm
1439 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1440 keyword, so that code can use these words as identifiers.  You can use
1441 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1442 instead.  @option{-ansi} implies @option{-fno-asm}.
1444 In C++, this switch only affects the @code{typeof} keyword, since
1445 @code{asm} and @code{inline} are standard keywords.  You may want to
1446 use the @option{-fno-gnu-keywords} flag instead, which has the same
1447 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1448 switch only affects the @code{asm} and @code{typeof} keywords, since
1449 @code{inline} is a standard keyword in ISO C99.
1451 @item -fno-builtin
1452 @itemx -fno-builtin-@var{function}
1453 @opindex fno-builtin
1454 @cindex built-in functions
1455 Don't recognize built-in functions that do not begin with
1456 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1457 functions provided by GCC}, for details of the functions affected,
1458 including those which are not built-in functions when @option{-ansi} or
1459 @option{-std} options for strict ISO C conformance are used because they
1460 do not have an ISO standard meaning.
1462 GCC normally generates special code to handle certain built-in functions
1463 more efficiently; for instance, calls to @code{alloca} may become single
1464 instructions that adjust the stack directly, and calls to @code{memcpy}
1465 may become inline copy loops.  The resulting code is often both smaller
1466 and faster, but since the function calls no longer appear as such, you
1467 cannot set a breakpoint on those calls, nor can you change the behavior
1468 of the functions by linking with a different library.  In addition,
1469 when a function is recognized as a built-in function, GCC may use
1470 information about that function to warn about problems with calls to
1471 that function, or to generate more efficient code, even if the
1472 resulting code still contains calls to that function.  For example,
1473 warnings are given with @option{-Wformat} for bad calls to
1474 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1475 known not to modify global memory.
1477 With the @option{-fno-builtin-@var{function}} option
1478 only the built-in function @var{function} is
1479 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1480 function is named this is not built-in in this version of GCC, this
1481 option is ignored.  There is no corresponding
1482 @option{-fbuiltin-@var{function}} option; if you wish to enable
1483 built-in functions selectively when using @option{-fno-builtin} or
1484 @option{-ffreestanding}, you may define macros such as:
1486 @smallexample
1487 #define abs(n)          __builtin_abs ((n))
1488 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1489 @end smallexample
1491 @item -fhosted
1492 @opindex fhosted
1493 @cindex hosted environment
1495 Assert that compilation takes place in a hosted environment.  This implies
1496 @option{-fbuiltin}.  A hosted environment is one in which the
1497 entire standard library is available, and in which @code{main} has a return
1498 type of @code{int}.  Examples are nearly everything except a kernel.
1499 This is equivalent to @option{-fno-freestanding}.
1501 @item -ffreestanding
1502 @opindex ffreestanding
1503 @cindex hosted environment
1505 Assert that compilation takes place in a freestanding environment.  This
1506 implies @option{-fno-builtin}.  A freestanding environment
1507 is one in which the standard library may not exist, and program startup may
1508 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1509 This is equivalent to @option{-fno-hosted}.
1511 @xref{Standards,,Language Standards Supported by GCC}, for details of
1512 freestanding and hosted environments.
1514 @item -fopenmp
1515 @opindex fopenmp
1516 @cindex openmp parallel
1517 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1518 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1519 compiler generates parallel code according to the OpenMP Application
1520 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1521 implies @option{-pthread}, and thus is only supported on targets that
1522 have support for @option{-pthread}.
1524 @item -fms-extensions
1525 @opindex fms-extensions
1526 Accept some non-standard constructs used in Microsoft header files.
1528 Some cases of unnamed fields in structures and unions are only
1529 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1530 fields within structs/unions}, for details.
1532 @item -trigraphs
1533 @opindex trigraphs
1534 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1535 options for strict ISO C conformance) implies @option{-trigraphs}.
1537 @item -no-integrated-cpp
1538 @opindex no-integrated-cpp
1539 Performs a compilation in two passes: preprocessing and compiling.  This
1540 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1541 @option{-B} option.  The user supplied compilation step can then add in
1542 an additional preprocessing step after normal preprocessing but before
1543 compiling.  The default is to use the integrated cpp (internal cpp)
1545 The semantics of this option will change if "cc1", "cc1plus", and
1546 "cc1obj" are merged.
1548 @cindex traditional C language
1549 @cindex C language, traditional
1550 @item -traditional
1551 @itemx -traditional-cpp
1552 @opindex traditional-cpp
1553 @opindex traditional
1554 Formerly, these options caused GCC to attempt to emulate a pre-standard
1555 C compiler.  They are now only supported with the @option{-E} switch.
1556 The preprocessor continues to support a pre-standard mode.  See the GNU
1557 CPP manual for details.
1559 @item -fcond-mismatch
1560 @opindex fcond-mismatch
1561 Allow conditional expressions with mismatched types in the second and
1562 third arguments.  The value of such an expression is void.  This option
1563 is not supported for C++.
1565 @item -flax-vector-conversions
1566 @opindex flax-vector-conversions
1567 Allow implicit conversions between vectors with differing numbers of
1568 elements and/or incompatible element types.  This option should not be
1569 used for new code.
1571 @item -funsigned-char
1572 @opindex funsigned-char
1573 Let the type @code{char} be unsigned, like @code{unsigned char}.
1575 Each kind of machine has a default for what @code{char} should
1576 be.  It is either like @code{unsigned char} by default or like
1577 @code{signed char} by default.
1579 Ideally, a portable program should always use @code{signed char} or
1580 @code{unsigned char} when it depends on the signedness of an object.
1581 But many programs have been written to use plain @code{char} and
1582 expect it to be signed, or expect it to be unsigned, depending on the
1583 machines they were written for.  This option, and its inverse, let you
1584 make such a program work with the opposite default.
1586 The type @code{char} is always a distinct type from each of
1587 @code{signed char} or @code{unsigned char}, even though its behavior
1588 is always just like one of those two.
1590 @item -fsigned-char
1591 @opindex fsigned-char
1592 Let the type @code{char} be signed, like @code{signed char}.
1594 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1595 the negative form of @option{-funsigned-char}.  Likewise, the option
1596 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1598 @item -fsigned-bitfields
1599 @itemx -funsigned-bitfields
1600 @itemx -fno-signed-bitfields
1601 @itemx -fno-unsigned-bitfields
1602 @opindex fsigned-bitfields
1603 @opindex funsigned-bitfields
1604 @opindex fno-signed-bitfields
1605 @opindex fno-unsigned-bitfields
1606 These options control whether a bit-field is signed or unsigned, when the
1607 declaration does not use either @code{signed} or @code{unsigned}.  By
1608 default, such a bit-field is signed, because this is consistent: the
1609 basic integer types such as @code{int} are signed types.
1610 @end table
1612 @node C++ Dialect Options
1613 @section Options Controlling C++ Dialect
1615 @cindex compiler options, C++
1616 @cindex C++ options, command line
1617 @cindex options, C++
1618 This section describes the command-line options that are only meaningful
1619 for C++ programs; but you can also use most of the GNU compiler options
1620 regardless of what language your program is in.  For example, you
1621 might compile a file @code{firstClass.C} like this:
1623 @smallexample
1624 g++ -g -frepo -O -c firstClass.C
1625 @end smallexample
1627 @noindent
1628 In this example, only @option{-frepo} is an option meant
1629 only for C++ programs; you can use the other options with any
1630 language supported by GCC@.
1632 Here is a list of options that are @emph{only} for compiling C++ programs:
1634 @table @gcctabopt
1636 @item -fabi-version=@var{n}
1637 @opindex fabi-version
1638 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1639 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1640 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1641 the version that conforms most closely to the C++ ABI specification.
1642 Therefore, the ABI obtained using version 0 will change as ABI bugs
1643 are fixed.
1645 The default is version 2.
1647 @item -fno-access-control
1648 @opindex fno-access-control
1649 Turn off all access checking.  This switch is mainly useful for working
1650 around bugs in the access control code.
1652 @item -fcheck-new
1653 @opindex fcheck-new
1654 Check that the pointer returned by @code{operator new} is non-null
1655 before attempting to modify the storage allocated.  This check is
1656 normally unnecessary because the C++ standard specifies that
1657 @code{operator new} will only return @code{0} if it is declared
1658 @samp{throw()}, in which case the compiler will always check the
1659 return value even without this option.  In all other cases, when
1660 @code{operator new} has a non-empty exception specification, memory
1661 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1662 @samp{new (nothrow)}.
1664 @item -fconserve-space
1665 @opindex fconserve-space
1666 Put uninitialized or runtime-initialized global variables into the
1667 common segment, as C does.  This saves space in the executable at the
1668 cost of not diagnosing duplicate definitions.  If you compile with this
1669 flag and your program mysteriously crashes after @code{main()} has
1670 completed, you may have an object that is being destroyed twice because
1671 two definitions were merged.
1673 This option is no longer useful on most targets, now that support has
1674 been added for putting variables into BSS without making them common.
1676 @item -ffriend-injection
1677 @opindex ffriend-injection
1678 Inject friend functions into the enclosing namespace, so that they are
1679 visible outside the scope of the class in which they are declared.
1680 Friend functions were documented to work this way in the old Annotated
1681 C++ Reference Manual, and versions of G++ before 4.1 always worked
1682 that way.  However, in ISO C++ a friend function which is not declared
1683 in an enclosing scope can only be found using argument dependent
1684 lookup.  This option causes friends to be injected as they were in
1685 earlier releases.
1687 This option is for compatibility, and may be removed in a future
1688 release of G++.
1690 @item -fno-elide-constructors
1691 @opindex fno-elide-constructors
1692 The C++ standard allows an implementation to omit creating a temporary
1693 which is only used to initialize another object of the same type.
1694 Specifying this option disables that optimization, and forces G++ to
1695 call the copy constructor in all cases.
1697 @item -fno-enforce-eh-specs
1698 @opindex fno-enforce-eh-specs
1699 Don't generate code to check for violation of exception specifications
1700 at runtime.  This option violates the C++ standard, but may be useful
1701 for reducing code size in production builds, much like defining
1702 @samp{NDEBUG}.  This does not give user code permission to throw
1703 exceptions in violation of the exception specifications; the compiler
1704 will still optimize based on the specifications, so throwing an
1705 unexpected exception will result in undefined behavior.
1707 @item -ffor-scope
1708 @itemx -fno-for-scope
1709 @opindex ffor-scope
1710 @opindex fno-for-scope
1711 If @option{-ffor-scope} is specified, the scope of variables declared in
1712 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1713 as specified by the C++ standard.
1714 If @option{-fno-for-scope} is specified, the scope of variables declared in
1715 a @i{for-init-statement} extends to the end of the enclosing scope,
1716 as was the case in old versions of G++, and other (traditional)
1717 implementations of C++.
1719 The default if neither flag is given to follow the standard,
1720 but to allow and give a warning for old-style code that would
1721 otherwise be invalid, or have different behavior.
1723 @item -fno-gnu-keywords
1724 @opindex fno-gnu-keywords
1725 Do not recognize @code{typeof} as a keyword, so that code can use this
1726 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1727 @option{-ansi} implies @option{-fno-gnu-keywords}.
1729 @item -fno-implicit-templates
1730 @opindex fno-implicit-templates
1731 Never emit code for non-inline templates which are instantiated
1732 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1733 @xref{Template Instantiation}, for more information.
1735 @item -fno-implicit-inline-templates
1736 @opindex fno-implicit-inline-templates
1737 Don't emit code for implicit instantiations of inline templates, either.
1738 The default is to handle inlines differently so that compiles with and
1739 without optimization will need the same set of explicit instantiations.
1741 @item -fno-implement-inlines
1742 @opindex fno-implement-inlines
1743 To save space, do not emit out-of-line copies of inline functions
1744 controlled by @samp{#pragma implementation}.  This will cause linker
1745 errors if these functions are not inlined everywhere they are called.
1747 @item -fms-extensions
1748 @opindex fms-extensions
1749 Disable pedantic warnings about constructs used in MFC, such as implicit
1750 int and getting a pointer to member function via non-standard syntax.
1752 @item -fno-nonansi-builtins
1753 @opindex fno-nonansi-builtins
1754 Disable built-in declarations of functions that are not mandated by
1755 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1756 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1758 @item -fno-operator-names
1759 @opindex fno-operator-names
1760 Do not treat the operator name keywords @code{and}, @code{bitand},
1761 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1762 synonyms as keywords.
1764 @item -fno-optional-diags
1765 @opindex fno-optional-diags
1766 Disable diagnostics that the standard says a compiler does not need to
1767 issue.  Currently, the only such diagnostic issued by G++ is the one for
1768 a name having multiple meanings within a class.
1770 @item -fpermissive
1771 @opindex fpermissive
1772 Downgrade some diagnostics about nonconformant code from errors to
1773 warnings.  Thus, using @option{-fpermissive} will allow some
1774 nonconforming code to compile.
1776 @item -frepo
1777 @opindex frepo
1778 Enable automatic template instantiation at link time.  This option also
1779 implies @option{-fno-implicit-templates}.  @xref{Template
1780 Instantiation}, for more information.
1782 @item -fno-rtti
1783 @opindex fno-rtti
1784 Disable generation of information about every class with virtual
1785 functions for use by the C++ runtime type identification features
1786 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1787 of the language, you can save some space by using this flag.  Note that
1788 exception handling uses the same information, but it will generate it as
1789 needed. The @samp{dynamic_cast} operator can still be used for casts that
1790 do not require runtime type information, i.e.@: casts to @code{void *} or to
1791 unambiguous base classes.
1793 @item -fstats
1794 @opindex fstats
1795 Emit statistics about front-end processing at the end of the compilation.
1796 This information is generally only useful to the G++ development team.
1798 @item -ftemplate-depth-@var{n}
1799 @opindex ftemplate-depth
1800 Set the maximum instantiation depth for template classes to @var{n}.
1801 A limit on the template instantiation depth is needed to detect
1802 endless recursions during template class instantiation.  ANSI/ISO C++
1803 conforming programs must not rely on a maximum depth greater than 17.
1805 @item -fno-threadsafe-statics
1806 @opindex fno-threadsafe-statics
1807 Do not emit the extra code to use the routines specified in the C++
1808 ABI for thread-safe initialization of local statics.  You can use this
1809 option to reduce code size slightly in code that doesn't need to be
1810 thread-safe.
1812 @item -fuse-cxa-atexit
1813 @opindex fuse-cxa-atexit
1814 Register destructors for objects with static storage duration with the
1815 @code{__cxa_atexit} function rather than the @code{atexit} function.
1816 This option is required for fully standards-compliant handling of static
1817 destructors, but will only work if your C library supports
1818 @code{__cxa_atexit}.
1820 @item -fno-use-cxa-get-exception-ptr
1821 @opindex fno-use-cxa-get-exception-ptr
1822 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1823 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1824 if the runtime routine is not available.
1826 @item -fvisibility-inlines-hidden
1827 @opindex fvisibility-inlines-hidden
1828 This switch declares that the user does not attempt to compare
1829 pointers to inline methods where the addresses of the two functions
1830 were taken in different shared objects.
1832 The effect of this is that GCC may, effectively, mark inline methods with
1833 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1834 appear in the export table of a DSO and do not require a PLT indirection
1835 when used within the DSO@.  Enabling this option can have a dramatic effect
1836 on load and link times of a DSO as it massively reduces the size of the
1837 dynamic export table when the library makes heavy use of templates.
1839 The behavior of this switch is not quite the same as marking the
1840 methods as hidden directly, because it does not affect static variables
1841 local to the function or cause the compiler to deduce that
1842 the function is defined in only one shared object.
1844 You may mark a method as having a visibility explicitly to negate the
1845 effect of the switch for that method.  For example, if you do want to
1846 compare pointers to a particular inline method, you might mark it as
1847 having default visibility.  Marking the enclosing class with explicit
1848 visibility will have no effect.
1850 Explicitly instantiated inline methods are unaffected by this option
1851 as their linkage might otherwise cross a shared library boundary.
1852 @xref{Template Instantiation}.
1854 @item -fvisibility-ms-compat
1855 @opindex fvisibility-ms-compat
1856 This flag attempts to use visibility settings to make GCC's C++
1857 linkage model compatible with that of Microsoft Visual Studio.
1859 The flag makes these changes to GCC's linkage model:
1861 @enumerate
1862 @item
1863 It sets the default visibility to @code{hidden}, like
1864 @option{-fvisibility=hidden}.
1866 @item
1867 Types, but not their members, are not hidden by default.
1869 @item
1870 The One Definition Rule is relaxed for types without explicit
1871 visibility specifications which are defined in more than one different
1872 shared object: those declarations are permitted if they would have
1873 been permitted when this option was not used.
1874 @end enumerate
1876 In new code it is better to use @option{-fvisibility=hidden} and
1877 export those classes which are intended to be externally visible.
1878 Unfortunately it is possible for code to rely, perhaps accidentally,
1879 on the Visual Studio behavior.
1881 Among the consequences of these changes are that static data members
1882 of the same type with the same name but defined in different shared
1883 objects will be different, so changing one will not change the other;
1884 and that pointers to function members defined in different shared
1885 objects may not compare equal.  When this flag is given, it is a
1886 violation of the ODR to define types with the same name differently.
1888 @item -fno-weak
1889 @opindex fno-weak
1890 Do not use weak symbol support, even if it is provided by the linker.
1891 By default, G++ will use weak symbols if they are available.  This
1892 option exists only for testing, and should not be used by end-users;
1893 it will result in inferior code and has no benefits.  This option may
1894 be removed in a future release of G++.
1896 @item -nostdinc++
1897 @opindex nostdinc++
1898 Do not search for header files in the standard directories specific to
1899 C++, but do still search the other standard directories.  (This option
1900 is used when building the C++ library.)
1901 @end table
1903 In addition, these optimization, warning, and code generation options
1904 have meanings only for C++ programs:
1906 @table @gcctabopt
1907 @item -fno-default-inline
1908 @opindex fno-default-inline
1909 Do not assume @samp{inline} for functions defined inside a class scope.
1910 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1911 functions will have linkage like inline functions; they just won't be
1912 inlined by default.
1914 @item -Wabi @r{(C++ and Objective-C++ only)}
1915 @opindex Wabi
1916 @opindex Wno-abi
1917 Warn when G++ generates code that is probably not compatible with the
1918 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1919 all such cases, there are probably some cases that are not warned about,
1920 even though G++ is generating incompatible code.  There may also be
1921 cases where warnings are emitted even though the code that is generated
1922 will be compatible.
1924 You should rewrite your code to avoid these warnings if you are
1925 concerned about the fact that code generated by G++ may not be binary
1926 compatible with code generated by other compilers.
1928 The known incompatibilities at this point include:
1930 @itemize @bullet
1932 @item
1933 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1934 pack data into the same byte as a base class.  For example:
1936 @smallexample
1937 struct A @{ virtual void f(); int f1 : 1; @};
1938 struct B : public A @{ int f2 : 1; @};
1939 @end smallexample
1941 @noindent
1942 In this case, G++ will place @code{B::f2} into the same byte
1943 as@code{A::f1}; other compilers will not.  You can avoid this problem
1944 by explicitly padding @code{A} so that its size is a multiple of the
1945 byte size on your platform; that will cause G++ and other compilers to
1946 layout @code{B} identically.
1948 @item
1949 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1950 tail padding when laying out virtual bases.  For example:
1952 @smallexample
1953 struct A @{ virtual void f(); char c1; @};
1954 struct B @{ B(); char c2; @};
1955 struct C : public A, public virtual B @{@};
1956 @end smallexample
1958 @noindent
1959 In this case, G++ will not place @code{B} into the tail-padding for
1960 @code{A}; other compilers will.  You can avoid this problem by
1961 explicitly padding @code{A} so that its size is a multiple of its
1962 alignment (ignoring virtual base classes); that will cause G++ and other
1963 compilers to layout @code{C} identically.
1965 @item
1966 Incorrect handling of bit-fields with declared widths greater than that
1967 of their underlying types, when the bit-fields appear in a union.  For
1968 example:
1970 @smallexample
1971 union U @{ int i : 4096; @};
1972 @end smallexample
1974 @noindent
1975 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1976 union too small by the number of bits in an @code{int}.
1978 @item
1979 Empty classes can be placed at incorrect offsets.  For example:
1981 @smallexample
1982 struct A @{@};
1984 struct B @{
1985   A a;
1986   virtual void f ();
1989 struct C : public B, public A @{@};
1990 @end smallexample
1992 @noindent
1993 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1994 it should be placed at offset zero.  G++ mistakenly believes that the
1995 @code{A} data member of @code{B} is already at offset zero.
1997 @item
1998 Names of template functions whose types involve @code{typename} or
1999 template template parameters can be mangled incorrectly.
2001 @smallexample
2002 template <typename Q>
2003 void f(typename Q::X) @{@}
2005 template <template <typename> class Q>
2006 void f(typename Q<int>::X) @{@}
2007 @end smallexample
2009 @noindent
2010 Instantiations of these templates may be mangled incorrectly.
2012 @end itemize
2014 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2015 @opindex Wctor-dtor-privacy
2016 @opindex Wno-ctor-dtor-privacy
2017 Warn when a class seems unusable because all the constructors or
2018 destructors in that class are private, and it has neither friends nor
2019 public static member functions.
2021 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2022 @opindex Wnon-virtual-dtor
2023 @opindex Wno-non-virtual-dtor
2024 Warn when a class has virtual functions and accessible non-virtual
2025 destructor, in which case it would be possible but unsafe to delete
2026 an instance of a derived class through a pointer to the base class.
2027 This warning is also enabled if -Weffc++ is specified.
2029 @item -Wreorder @r{(C++ and Objective-C++ only)}
2030 @opindex Wreorder
2031 @opindex Wno-reorder
2032 @cindex reordering, warning
2033 @cindex warning for reordering of member initializers
2034 Warn when the order of member initializers given in the code does not
2035 match the order in which they must be executed.  For instance:
2037 @smallexample
2038 struct A @{
2039   int i;
2040   int j;
2041   A(): j (0), i (1) @{ @}
2043 @end smallexample
2045 The compiler will rearrange the member initializers for @samp{i}
2046 and @samp{j} to match the declaration order of the members, emitting
2047 a warning to that effect.  This warning is enabled by @option{-Wall}.
2048 @end table
2050 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2052 @table @gcctabopt
2053 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2054 @opindex Weffc++
2055 @opindex Wno-effc++
2056 Warn about violations of the following style guidelines from Scott Meyers'
2057 @cite{Effective C++} book:
2059 @itemize @bullet
2060 @item
2061 Item 11:  Define a copy constructor and an assignment operator for classes
2062 with dynamically allocated memory.
2064 @item
2065 Item 12:  Prefer initialization to assignment in constructors.
2067 @item
2068 Item 14:  Make destructors virtual in base classes.
2070 @item
2071 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2073 @item
2074 Item 23:  Don't try to return a reference when you must return an object.
2076 @end itemize
2078 Also warn about violations of the following style guidelines from
2079 Scott Meyers' @cite{More Effective C++} book:
2081 @itemize @bullet
2082 @item
2083 Item 6:  Distinguish between prefix and postfix forms of increment and
2084 decrement operators.
2086 @item
2087 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2089 @end itemize
2091 When selecting this option, be aware that the standard library
2092 headers do not obey all of these guidelines; use @samp{grep -v}
2093 to filter out those warnings.
2095 @item -Wno-deprecated @r{(C++ and Objective-C++ only)}
2096 @opindex Wno-deprecated
2097 @opindex Wdeprecated
2098 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
2100 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2101 @opindex Wstrict-null-sentinel
2102 @opindex Wno-strict-null-sentinel
2103 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2104 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2105 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2106 it is guaranteed to of the same size as a pointer.  But this use is
2107 not portable across different compilers.
2109 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2110 @opindex Wno-non-template-friend
2111 @opindex Wnon-template-friend
2112 Disable warnings when non-templatized friend functions are declared
2113 within a template.  Since the advent of explicit template specification
2114 support in G++, if the name of the friend is an unqualified-id (i.e.,
2115 @samp{friend foo(int)}), the C++ language specification demands that the
2116 friend declare or define an ordinary, nontemplate function.  (Section
2117 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2118 could be interpreted as a particular specialization of a templatized
2119 function.  Because this non-conforming behavior is no longer the default
2120 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2121 check existing code for potential trouble spots and is on by default.
2122 This new compiler behavior can be turned off with
2123 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2124 but disables the helpful warning.
2126 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2127 @opindex Wold-style-cast
2128 @opindex Wno-old-style-cast
2129 Warn if an old-style (C-style) cast to a non-void type is used within
2130 a C++ program.  The new-style casts (@samp{dynamic_cast},
2131 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2132 less vulnerable to unintended effects and much easier to search for.
2134 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2135 @opindex Woverloaded-virtual
2136 @opindex Wno-overloaded-virtual
2137 @cindex overloaded virtual fn, warning
2138 @cindex warning for overloaded virtual fn
2139 Warn when a function declaration hides virtual functions from a
2140 base class.  For example, in:
2142 @smallexample
2143 struct A @{
2144   virtual void f();
2147 struct B: public A @{
2148   void f(int);
2150 @end smallexample
2152 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2153 like:
2155 @smallexample
2156 B* b;
2157 b->f();
2158 @end smallexample
2160 will fail to compile.
2162 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2163 @opindex Wno-pmf-conversions
2164 @opindex Wpmf-conversions
2165 Disable the diagnostic for converting a bound pointer to member function
2166 to a plain pointer.
2168 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2169 @opindex Wsign-promo
2170 @opindex Wno-sign-promo
2171 Warn when overload resolution chooses a promotion from unsigned or
2172 enumerated type to a signed type, over a conversion to an unsigned type of
2173 the same size.  Previous versions of G++ would try to preserve
2174 unsignedness, but the standard mandates the current behavior.
2176 @smallexample
2177 struct A @{
2178   operator int ();
2179   A& operator = (int);
2182 main ()
2184   A a,b;
2185   a = b;
2187 @end smallexample
2189 In this example, G++ will synthesize a default @samp{A& operator =
2190 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2191 @end table
2193 @node Objective-C and Objective-C++ Dialect Options
2194 @section Options Controlling Objective-C and Objective-C++ Dialects
2196 @cindex compiler options, Objective-C and Objective-C++
2197 @cindex Objective-C and Objective-C++ options, command line
2198 @cindex options, Objective-C and Objective-C++
2199 (NOTE: This manual does not describe the Objective-C and Objective-C++
2200 languages themselves.  See @xref{Standards,,Language Standards
2201 Supported by GCC}, for references.)
2203 This section describes the command-line options that are only meaningful
2204 for Objective-C and Objective-C++ programs, but you can also use most of
2205 the language-independent GNU compiler options.
2206 For example, you might compile a file @code{some_class.m} like this:
2208 @smallexample
2209 gcc -g -fgnu-runtime -O -c some_class.m
2210 @end smallexample
2212 @noindent
2213 In this example, @option{-fgnu-runtime} is an option meant only for
2214 Objective-C and Objective-C++ programs; you can use the other options with
2215 any language supported by GCC@.
2217 Note that since Objective-C is an extension of the C language, Objective-C
2218 compilations may also use options specific to the C front-end (e.g.,
2219 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2220 C++-specific options (e.g., @option{-Wabi}).
2222 Here is a list of options that are @emph{only} for compiling Objective-C
2223 and Objective-C++ programs:
2225 @table @gcctabopt
2226 @item -fconstant-string-class=@var{class-name}
2227 @opindex fconstant-string-class
2228 Use @var{class-name} as the name of the class to instantiate for each
2229 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2230 class name is @code{NXConstantString} if the GNU runtime is being used, and
2231 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2232 @option{-fconstant-cfstrings} option, if also present, will override the
2233 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2234 to be laid out as constant CoreFoundation strings.
2236 @item -fgnu-runtime
2237 @opindex fgnu-runtime
2238 Generate object code compatible with the standard GNU Objective-C
2239 runtime.  This is the default for most types of systems.
2241 @item -fnext-runtime
2242 @opindex fnext-runtime
2243 Generate output compatible with the NeXT runtime.  This is the default
2244 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2245 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2246 used.
2248 @item -fno-nil-receivers
2249 @opindex fno-nil-receivers
2250 Assume that all Objective-C message dispatches (e.g.,
2251 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2252 is not @code{nil}.  This allows for more efficient entry points in the runtime
2253 to be used.  Currently, this option is only available in conjunction with
2254 the NeXT runtime on Mac OS X 10.3 and later.
2256 @item -fobjc-call-cxx-cdtors
2257 @opindex fobjc-call-cxx-cdtors
2258 For each Objective-C class, check if any of its instance variables is a
2259 C++ object with a non-trivial default constructor.  If so, synthesize a
2260 special @code{- (id) .cxx_construct} instance method that will run
2261 non-trivial default constructors on any such instance variables, in order,
2262 and then return @code{self}.  Similarly, check if any instance variable
2263 is a C++ object with a non-trivial destructor, and if so, synthesize a
2264 special @code{- (void) .cxx_destruct} method that will run
2265 all such default destructors, in reverse order.
2267 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2268 thusly generated will only operate on instance variables declared in the
2269 current Objective-C class, and not those inherited from superclasses.  It
2270 is the responsibility of the Objective-C runtime to invoke all such methods
2271 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2272 will be invoked by the runtime immediately after a new object
2273 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2274 be invoked immediately before the runtime deallocates an object instance.
2276 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2277 support for invoking the @code{- (id) .cxx_construct} and
2278 @code{- (void) .cxx_destruct} methods.
2280 @item -fobjc-direct-dispatch
2281 @opindex fobjc-direct-dispatch
2282 Allow fast jumps to the message dispatcher.  On Darwin this is
2283 accomplished via the comm page.
2285 @item -fobjc-exceptions
2286 @opindex fobjc-exceptions
2287 Enable syntactic support for structured exception handling in Objective-C,
2288 similar to what is offered by C++ and Java.  This option is
2289 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2290 earlier.
2292 @smallexample
2293   @@try @{
2294     @dots{}
2295        @@throw expr;
2296     @dots{}
2297   @}
2298   @@catch (AnObjCClass *exc) @{
2299     @dots{}
2300       @@throw expr;
2301     @dots{}
2302       @@throw;
2303     @dots{}
2304   @}
2305   @@catch (AnotherClass *exc) @{
2306     @dots{}
2307   @}
2308   @@catch (id allOthers) @{
2309     @dots{}
2310   @}
2311   @@finally @{
2312     @dots{}
2313       @@throw expr;
2314     @dots{}
2315   @}
2316 @end smallexample
2318 The @code{@@throw} statement may appear anywhere in an Objective-C or
2319 Objective-C++ program; when used inside of a @code{@@catch} block, the
2320 @code{@@throw} may appear without an argument (as shown above), in which case
2321 the object caught by the @code{@@catch} will be rethrown.
2323 Note that only (pointers to) Objective-C objects may be thrown and
2324 caught using this scheme.  When an object is thrown, it will be caught
2325 by the nearest @code{@@catch} clause capable of handling objects of that type,
2326 analogously to how @code{catch} blocks work in C++ and Java.  A
2327 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2328 any and all Objective-C exceptions not caught by previous @code{@@catch}
2329 clauses (if any).
2331 The @code{@@finally} clause, if present, will be executed upon exit from the
2332 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2333 regardless of whether any exceptions are thrown, caught or rethrown
2334 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2335 of the @code{finally} clause in Java.
2337 There are several caveats to using the new exception mechanism:
2339 @itemize @bullet
2340 @item
2341 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2342 idioms provided by the @code{NSException} class, the new
2343 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2344 systems, due to additional functionality needed in the (NeXT) Objective-C
2345 runtime.
2347 @item
2348 As mentioned above, the new exceptions do not support handling
2349 types other than Objective-C objects.   Furthermore, when used from
2350 Objective-C++, the Objective-C exception model does not interoperate with C++
2351 exceptions at this time.  This means you cannot @code{@@throw} an exception
2352 from Objective-C and @code{catch} it in C++, or vice versa
2353 (i.e., @code{throw @dots{} @@catch}).
2354 @end itemize
2356 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2357 blocks for thread-safe execution:
2359 @smallexample
2360   @@synchronized (ObjCClass *guard) @{
2361     @dots{}
2362   @}
2363 @end smallexample
2365 Upon entering the @code{@@synchronized} block, a thread of execution shall
2366 first check whether a lock has been placed on the corresponding @code{guard}
2367 object by another thread.  If it has, the current thread shall wait until
2368 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2369 the current thread will place its own lock on it, execute the code contained in
2370 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2371 making @code{guard} available to other threads).
2373 Unlike Java, Objective-C does not allow for entire methods to be marked
2374 @code{@@synchronized}.  Note that throwing exceptions out of
2375 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2376 to be unlocked properly.
2378 @item -fobjc-gc
2379 @opindex fobjc-gc
2380 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2382 @item -freplace-objc-classes
2383 @opindex freplace-objc-classes
2384 Emit a special marker instructing @command{ld(1)} not to statically link in
2385 the resulting object file, and allow @command{dyld(1)} to load it in at
2386 run time instead.  This is used in conjunction with the Fix-and-Continue
2387 debugging mode, where the object file in question may be recompiled and
2388 dynamically reloaded in the course of program execution, without the need
2389 to restart the program itself.  Currently, Fix-and-Continue functionality
2390 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2391 and later.
2393 @item -fzero-link
2394 @opindex fzero-link
2395 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2396 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2397 compile time) with static class references that get initialized at load time,
2398 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2399 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2400 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2401 for individual class implementations to be modified during program execution.
2403 @item -gen-decls
2404 @opindex gen-decls
2405 Dump interface declarations for all classes seen in the source file to a
2406 file named @file{@var{sourcename}.decl}.
2408 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2409 @opindex Wassign-intercept
2410 @opindex Wno-assign-intercept
2411 Warn whenever an Objective-C assignment is being intercepted by the
2412 garbage collector.
2414 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2415 @opindex Wno-protocol
2416 @opindex Wprotocol
2417 If a class is declared to implement a protocol, a warning is issued for
2418 every method in the protocol that is not implemented by the class.  The
2419 default behavior is to issue a warning for every method not explicitly
2420 implemented in the class, even if a method implementation is inherited
2421 from the superclass.  If you use the @option{-Wno-protocol} option, then
2422 methods inherited from the superclass are considered to be implemented,
2423 and no warning is issued for them.
2425 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2426 @opindex Wselector
2427 @opindex Wno-selector
2428 Warn if multiple methods of different types for the same selector are
2429 found during compilation.  The check is performed on the list of methods
2430 in the final stage of compilation.  Additionally, a check is performed
2431 for each selector appearing in a @code{@@selector(@dots{})}
2432 expression, and a corresponding method for that selector has been found
2433 during compilation.  Because these checks scan the method table only at
2434 the end of compilation, these warnings are not produced if the final
2435 stage of compilation is not reached, for example because an error is
2436 found during compilation, or because the @option{-fsyntax-only} option is
2437 being used.
2439 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2440 @opindex Wstrict-selector-match
2441 @opindex Wno-strict-selector-match
2442 Warn if multiple methods with differing argument and/or return types are
2443 found for a given selector when attempting to send a message using this
2444 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2445 is off (which is the default behavior), the compiler will omit such warnings
2446 if any differences found are confined to types which share the same size
2447 and alignment.
2449 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2450 @opindex Wundeclared-selector
2451 @opindex Wno-undeclared-selector
2452 Warn if a @code{@@selector(@dots{})} expression referring to an
2453 undeclared selector is found.  A selector is considered undeclared if no
2454 method with that name has been declared before the
2455 @code{@@selector(@dots{})} expression, either explicitly in an
2456 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2457 an @code{@@implementation} section.  This option always performs its
2458 checks as soon as a @code{@@selector(@dots{})} expression is found,
2459 while @option{-Wselector} only performs its checks in the final stage of
2460 compilation.  This also enforces the coding style convention
2461 that methods and selectors must be declared before being used.
2463 @item -print-objc-runtime-info
2464 @opindex print-objc-runtime-info
2465 Generate C header describing the largest structure that is passed by
2466 value, if any.
2468 @end table
2470 @node Language Independent Options
2471 @section Options to Control Diagnostic Messages Formatting
2472 @cindex options to control diagnostics formatting
2473 @cindex diagnostic messages
2474 @cindex message formatting
2476 Traditionally, diagnostic messages have been formatted irrespective of
2477 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2478 below can be used to control the diagnostic messages formatting
2479 algorithm, e.g.@: how many characters per line, how often source location
2480 information should be reported.  Right now, only the C++ front end can
2481 honor these options.  However it is expected, in the near future, that
2482 the remaining front ends would be able to digest them correctly.
2484 @table @gcctabopt
2485 @item -fmessage-length=@var{n}
2486 @opindex fmessage-length
2487 Try to format error messages so that they fit on lines of about @var{n}
2488 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2489 the front ends supported by GCC@.  If @var{n} is zero, then no
2490 line-wrapping will be done; each error message will appear on a single
2491 line.
2493 @opindex fdiagnostics-show-location
2494 @item -fdiagnostics-show-location=once
2495 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2496 reporter to emit @emph{once} source location information; that is, in
2497 case the message is too long to fit on a single physical line and has to
2498 be wrapped, the source location won't be emitted (as prefix) again,
2499 over and over, in subsequent continuation lines.  This is the default
2500 behavior.
2502 @item -fdiagnostics-show-location=every-line
2503 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2504 messages reporter to emit the same source location information (as
2505 prefix) for physical lines that result from the process of breaking
2506 a message which is too long to fit on a single line.
2508 @item -fdiagnostics-show-option
2509 @opindex fdiagnostics-show-option
2510 This option instructs the diagnostic machinery to add text to each
2511 diagnostic emitted, which indicates which command line option directly
2512 controls that diagnostic, when such an option is known to the
2513 diagnostic machinery.
2515 @item -Wcoverage-mismatch
2516 @opindex Wcoverage-mismatch
2517 Warn if feedback profiles do not match when using the
2518 @option{-fprofile-use} option.
2519 If a source file was changed between @option{-fprofile-gen} and
2520 @option{-fprofile-use}, the files with the profile feedback can fail
2521 to match the source file and GCC can not use the profile feedback
2522 information.  By default, GCC emits an error message in this case.
2523 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2524 error.  GCC does not use appropriate feedback profiles, so using this
2525 option can result in poorly optimized code.  This option is useful
2526 only in the case of very minor changes such as bug fixes to an
2527 existing code-base.
2529 @end table
2531 @node Warning Options
2532 @section Options to Request or Suppress Warnings
2533 @cindex options to control warnings
2534 @cindex warning messages
2535 @cindex messages, warning
2536 @cindex suppressing warnings
2538 Warnings are diagnostic messages that report constructions which
2539 are not inherently erroneous but which are risky or suggest there
2540 may have been an error.
2542 The following language-independent options do not enable specific
2543 warnings but control the kinds of diagnostics produced by GCC.
2545 @table @gcctabopt
2546 @cindex syntax checking
2547 @item -fsyntax-only
2548 @opindex fsyntax-only
2549 Check the code for syntax errors, but don't do anything beyond that.
2551 @item -w
2552 @opindex w
2553 Inhibit all warning messages.
2555 @item -Werror
2556 @opindex Werror
2557 @opindex Wno-error
2558 Make all warnings into errors.
2560 @item -Werror=
2561 @opindex Werror=
2562 @opindex Wno-error=
2563 Make the specified warning into an error.  The specifier for a warning
2564 is appended, for example @option{-Werror=switch} turns the warnings
2565 controlled by @option{-Wswitch} into errors.  This switch takes a
2566 negative form, to be used to negate @option{-Werror} for specific
2567 warnings, for example @option{-Wno-error=switch} makes
2568 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2569 is in effect.  You can use the @option{-fdiagnostics-show-option}
2570 option to have each controllable warning amended with the option which
2571 controls it, to determine what to use with this option.
2573 Note that specifying @option{-Werror=}@var{foo} automatically implies
2574 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2575 imply anything.
2577 @item -Wfatal-errors
2578 @opindex Wfatal-errors
2579 @opindex Wno-fatal-errors
2580 This option causes the compiler to abort compilation on the first error
2581 occurred rather than trying to keep going and printing further error
2582 messages.
2584 @end table
2586 You can request many specific warnings with options beginning
2587 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2588 implicit declarations.  Each of these specific warning options also
2589 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2590 example, @option{-Wno-implicit}.  This manual lists only one of the
2591 two forms, whichever is not the default.  For further,
2592 language-specific options also refer to @ref{C++ Dialect Options} and
2593 @ref{Objective-C and Objective-C++ Dialect Options}.
2595 @table @gcctabopt
2596 @item -pedantic
2597 @opindex pedantic
2598 Issue all the warnings demanded by strict ISO C and ISO C++;
2599 reject all programs that use forbidden extensions, and some other
2600 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2601 version of the ISO C standard specified by any @option{-std} option used.
2603 Valid ISO C and ISO C++ programs should compile properly with or without
2604 this option (though a rare few will require @option{-ansi} or a
2605 @option{-std} option specifying the required version of ISO C)@.  However,
2606 without this option, certain GNU extensions and traditional C and C++
2607 features are supported as well.  With this option, they are rejected.
2609 @option{-pedantic} does not cause warning messages for use of the
2610 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2611 warnings are also disabled in the expression that follows
2612 @code{__extension__}.  However, only system header files should use
2613 these escape routes; application programs should avoid them.
2614 @xref{Alternate Keywords}.
2616 Some users try to use @option{-pedantic} to check programs for strict ISO
2617 C conformance.  They soon find that it does not do quite what they want:
2618 it finds some non-ISO practices, but not all---only those for which
2619 ISO C @emph{requires} a diagnostic, and some others for which
2620 diagnostics have been added.
2622 A feature to report any failure to conform to ISO C might be useful in
2623 some instances, but would require considerable additional work and would
2624 be quite different from @option{-pedantic}.  We don't have plans to
2625 support such a feature in the near future.
2627 Where the standard specified with @option{-std} represents a GNU
2628 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2629 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2630 extended dialect is based.  Warnings from @option{-pedantic} are given
2631 where they are required by the base standard.  (It would not make sense
2632 for such warnings to be given only for features not in the specified GNU
2633 C dialect, since by definition the GNU dialects of C include all
2634 features the compiler supports with the given option, and there would be
2635 nothing to warn about.)
2637 @item -pedantic-errors
2638 @opindex pedantic-errors
2639 Like @option{-pedantic}, except that errors are produced rather than
2640 warnings.
2642 @item -Wall
2643 @opindex Wall
2644 @opindex Wno-all
2645 This enables all the warnings about constructions that some users
2646 consider questionable, and that are easy to avoid (or modify to
2647 prevent the warning), even in conjunction with macros.  This also
2648 enables some language-specific warnings described in @ref{C++ Dialect
2649 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2651 @option{-Wall} turns on the following warning flags:
2653 @gccoptlist{-Waddress   @gol
2654 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2655 -Wc++0x-compat  @gol
2656 -Wchar-subscripts  @gol
2657 -Wimplicit-int  @gol
2658 -Wimplicit-function-declaration  @gol
2659 -Wcomment  @gol
2660 -Wformat   @gol
2661 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2662 -Wmissing-braces  @gol
2663 -Wnonnull  @gol
2664 -Wparentheses  @gol
2665 -Wpointer-sign  @gol
2666 -Wreorder   @gol
2667 -Wreturn-type  @gol
2668 -Wsequence-point  @gol
2669 -Wsign-compare @r{(only in C++)}  @gol
2670 -Wstrict-aliasing  @gol
2671 -Wstrict-overflow=1  @gol
2672 -Wswitch  @gol
2673 -Wtrigraphs  @gol
2674 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2675 -Wunknown-pragmas  @gol
2676 -Wunused-function  @gol
2677 -Wunused-label     @gol
2678 -Wunused-value     @gol
2679 -Wunused-variable  @gol
2682 Note that some warning flags are not implied by @option{-Wall}.  Some of
2683 them warn about constructions that users generally do not consider
2684 questionable, but which occasionally you might wish to check for;
2685 others warn about constructions that are necessary or hard to avoid in
2686 some cases, and there is no simple way to modify the code to suppress
2687 the warning. Some of them are enabled by @option{-Wextra} but many of
2688 them must be enabled individually.
2690 @item -Wextra
2691 @opindex W
2692 @opindex Wextra
2693 @opindex Wno-extra
2694 This enables some extra warning flags that are not enabled by
2695 @option{-Wall}. (This option used to be called @option{-W}.  The older
2696 name is still supported, but the newer name is more descriptive.)
2698 @gccoptlist{-Wclobbered  @gol
2699 -Wempty-body  @gol
2700 -Wignored-qualifiers @gol
2701 -Wmissing-field-initializers  @gol
2702 -Wmissing-parameter-type @r{(C only)}  @gol
2703 -Wold-style-declaration @r{(C only)}  @gol
2704 -Woverride-init  @gol
2705 -Wsign-compare  @gol
2706 -Wtype-limits  @gol
2707 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2708 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2711 The option @option{-Wextra} also prints warning messages for the
2712 following cases:
2714 @itemize @bullet
2716 @item
2717 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2718 @samp{>}, or @samp{>=}.
2720 @item 
2721 (C++ only) An enumerator and a non-enumerator both appear in a
2722 conditional expression.
2724 @item 
2725 (C++ only) A non-static reference or non-static @samp{const} member
2726 appears in a class without constructors.
2728 @item 
2729 (C++ only) Ambiguous virtual bases.
2731 @item 
2732 (C++ only) Subscripting an array which has been declared @samp{register}.
2734 @item 
2735 (C++ only) Taking the address of a variable which has been declared
2736 @samp{register}.
2738 @item 
2739 (C++ only) A base class is not initialized in a derived class' copy
2740 constructor.
2742 @end itemize
2744 @item -Wno-import
2745 @opindex Wno-import
2746 @opindex Wimport
2747 Inhibit warning messages about the use of @samp{#import}.
2749 @item -Wchar-subscripts
2750 @opindex Wchar-subscripts
2751 @opindex Wno-char-subscripts
2752 Warn if an array subscript has type @code{char}.  This is a common cause
2753 of error, as programmers often forget that this type is signed on some
2754 machines.
2755 This warning is enabled by @option{-Wall}.
2757 @item -Wcomment
2758 @opindex Wcomment
2759 @opindex Wno-comment
2760 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2761 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2762 This warning is enabled by @option{-Wall}.
2764 @item -Wformat
2765 @opindex Wformat
2766 @opindex Wno-format
2767 @opindex ffreestanding
2768 @opindex fno-builtin
2769 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2770 the arguments supplied have types appropriate to the format string
2771 specified, and that the conversions specified in the format string make
2772 sense.  This includes standard functions, and others specified by format
2773 attributes (@pxref{Function Attributes}), in the @code{printf},
2774 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2775 not in the C standard) families (or other target-specific families).
2776 Which functions are checked without format attributes having been
2777 specified depends on the standard version selected, and such checks of
2778 functions without the attribute specified are disabled by
2779 @option{-ffreestanding} or @option{-fno-builtin}.
2781 The formats are checked against the format features supported by GNU
2782 libc version 2.2.  These include all ISO C90 and C99 features, as well
2783 as features from the Single Unix Specification and some BSD and GNU
2784 extensions.  Other library implementations may not support all these
2785 features; GCC does not support warning about features that go beyond a
2786 particular library's limitations.  However, if @option{-pedantic} is used
2787 with @option{-Wformat}, warnings will be given about format features not
2788 in the selected standard version (but not for @code{strfmon} formats,
2789 since those are not in any version of the C standard).  @xref{C Dialect
2790 Options,,Options Controlling C Dialect}.
2792 Since @option{-Wformat} also checks for null format arguments for
2793 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2795 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2796 aspects of format checking, the options @option{-Wformat-y2k},
2797 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2798 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2799 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2801 @item -Wformat-y2k
2802 @opindex Wformat-y2k
2803 @opindex Wno-format-y2k
2804 If @option{-Wformat} is specified, also warn about @code{strftime}
2805 formats which may yield only a two-digit year.
2807 @item -Wno-format-extra-args
2808 @opindex Wno-format-extra-args
2809 @opindex Wformat-extra-args
2810 If @option{-Wformat} is specified, do not warn about excess arguments to a
2811 @code{printf} or @code{scanf} format function.  The C standard specifies
2812 that such arguments are ignored.
2814 Where the unused arguments lie between used arguments that are
2815 specified with @samp{$} operand number specifications, normally
2816 warnings are still given, since the implementation could not know what
2817 type to pass to @code{va_arg} to skip the unused arguments.  However,
2818 in the case of @code{scanf} formats, this option will suppress the
2819 warning if the unused arguments are all pointers, since the Single
2820 Unix Specification says that such unused arguments are allowed.
2822 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2823 @opindex Wno-format-zero-length
2824 @opindex Wformat-zero-length
2825 If @option{-Wformat} is specified, do not warn about zero-length formats.
2826 The C standard specifies that zero-length formats are allowed.
2828 @item -Wformat-nonliteral
2829 @opindex Wformat-nonliteral
2830 @opindex Wno-format-nonliteral
2831 If @option{-Wformat} is specified, also warn if the format string is not a
2832 string literal and so cannot be checked, unless the format function
2833 takes its format arguments as a @code{va_list}.
2835 @item -Wformat-security
2836 @opindex Wformat-security
2837 @opindex Wno-format-security
2838 If @option{-Wformat} is specified, also warn about uses of format
2839 functions that represent possible security problems.  At present, this
2840 warns about calls to @code{printf} and @code{scanf} functions where the
2841 format string is not a string literal and there are no format arguments,
2842 as in @code{printf (foo);}.  This may be a security hole if the format
2843 string came from untrusted input and contains @samp{%n}.  (This is
2844 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2845 in future warnings may be added to @option{-Wformat-security} that are not
2846 included in @option{-Wformat-nonliteral}.)
2848 @item -Wformat=2
2849 @opindex Wformat=2
2850 @opindex Wno-format=2
2851 Enable @option{-Wformat} plus format checks not included in
2852 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2853 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2855 @item -Wnonnull @r{(C and Objective-C only)}
2856 @opindex Wnonnull
2857 @opindex Wno-nonnull
2858 Warn about passing a null pointer for arguments marked as
2859 requiring a non-null value by the @code{nonnull} function attribute.
2861 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2862 can be disabled with the @option{-Wno-nonnull} option.
2864 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2865 @opindex Winit-self
2866 @opindex Wno-init-self
2867 Warn about uninitialized variables which are initialized with themselves.
2868 Note this option can only be used with the @option{-Wuninitialized} option,
2869 which in turn only works with @option{-O1} and above.
2871 For example, GCC will warn about @code{i} being uninitialized in the
2872 following snippet only when @option{-Winit-self} has been specified:
2873 @smallexample
2874 @group
2875 int f()
2877   int i = i;
2878   return i;
2880 @end group
2881 @end smallexample
2883 @item -Wimplicit-int @r{(C and Objective-C only)}
2884 @opindex Wimplicit-int
2885 @opindex Wno-implicit-int
2886 Warn when a declaration does not specify a type.
2887 This warning is enabled by @option{-Wall}.
2889 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2890 @opindex Wimplicit-function-declaration
2891 @opindex Wno-implicit-function-declaration
2892 Give a warning whenever a function is used before being declared. In
2893 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2894 enabled by default and it is made into an error by
2895 @option{-pedantic-errors}. This warning is also enabled by
2896 @option{-Wall}.
2898 @item -Wimplicit
2899 @opindex Wimplicit
2900 @opindex Wno-implicit
2901 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2902 This warning is enabled by @option{-Wall}.
2904 @item -Wignored-qualifiers @r{(C and C++ only)}
2905 @opindex Wignored-qualifiers
2906 @opindex Wno-ignored-qualifiers
2907 Warn if the return type of a function has a type qualifier
2908 such as @code{const}.  For ISO C such a type qualifier has no effect,
2909 since the value returned by a function is not an lvalue.
2910 For C++, the warning is only emitted for scalar types or @code{void}.
2911 ISO C prohibits qualified @code{void} return types on function
2912 definitions, so such return types always receive a warning
2913 even without this option.
2915 This warning is also enabled by @option{-Wextra}.
2917 @item -Wmain
2918 @opindex Wmain
2919 @opindex Wno-main
2920 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2921 function with external linkage, returning int, taking either zero
2922 arguments, two, or three arguments of appropriate types.
2923 This warning is enabled by @option{-Wall}.
2925 @item -Wmissing-braces
2926 @opindex Wmissing-braces
2927 @opindex Wno-missing-braces
2928 Warn if an aggregate or union initializer is not fully bracketed.  In
2929 the following example, the initializer for @samp{a} is not fully
2930 bracketed, but that for @samp{b} is fully bracketed.
2932 @smallexample
2933 int a[2][2] = @{ 0, 1, 2, 3 @};
2934 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2935 @end smallexample
2937 This warning is enabled by @option{-Wall}.
2939 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2940 @opindex Wmissing-include-dirs
2941 @opindex Wno-missing-include-dirs
2942 Warn if a user-supplied include directory does not exist.
2944 @item -Wparentheses
2945 @opindex Wparentheses
2946 @opindex Wno-parentheses
2947 Warn if parentheses are omitted in certain contexts, such
2948 as when there is an assignment in a context where a truth value
2949 is expected, or when operators are nested whose precedence people
2950 often get confused about.
2952 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2953 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2954 interpretation from that of ordinary mathematical notation.
2956 Also warn about constructions where there may be confusion to which
2957 @code{if} statement an @code{else} branch belongs.  Here is an example of
2958 such a case:
2960 @smallexample
2961 @group
2963   if (a)
2964     if (b)
2965       foo ();
2966   else
2967     bar ();
2969 @end group
2970 @end smallexample
2972 In C/C++, every @code{else} branch belongs to the innermost possible
2973 @code{if} statement, which in this example is @code{if (b)}.  This is
2974 often not what the programmer expected, as illustrated in the above
2975 example by indentation the programmer chose.  When there is the
2976 potential for this confusion, GCC will issue a warning when this flag
2977 is specified.  To eliminate the warning, add explicit braces around
2978 the innermost @code{if} statement so there is no way the @code{else}
2979 could belong to the enclosing @code{if}.  The resulting code would
2980 look like this:
2982 @smallexample
2983 @group
2985   if (a)
2986     @{
2987       if (b)
2988         foo ();
2989       else
2990         bar ();
2991     @}
2993 @end group
2994 @end smallexample
2996 This warning is enabled by @option{-Wall}.
2998 @item -Wsequence-point
2999 @opindex Wsequence-point
3000 @opindex Wno-sequence-point
3001 Warn about code that may have undefined semantics because of violations
3002 of sequence point rules in the C and C++ standards.
3004 The C and C++ standards defines the order in which expressions in a C/C++
3005 program are evaluated in terms of @dfn{sequence points}, which represent
3006 a partial ordering between the execution of parts of the program: those
3007 executed before the sequence point, and those executed after it.  These
3008 occur after the evaluation of a full expression (one which is not part
3009 of a larger expression), after the evaluation of the first operand of a
3010 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3011 function is called (but after the evaluation of its arguments and the
3012 expression denoting the called function), and in certain other places.
3013 Other than as expressed by the sequence point rules, the order of
3014 evaluation of subexpressions of an expression is not specified.  All
3015 these rules describe only a partial order rather than a total order,
3016 since, for example, if two functions are called within one expression
3017 with no sequence point between them, the order in which the functions
3018 are called is not specified.  However, the standards committee have
3019 ruled that function calls do not overlap.
3021 It is not specified when between sequence points modifications to the
3022 values of objects take effect.  Programs whose behavior depends on this
3023 have undefined behavior; the C and C++ standards specify that ``Between
3024 the previous and next sequence point an object shall have its stored
3025 value modified at most once by the evaluation of an expression.
3026 Furthermore, the prior value shall be read only to determine the value
3027 to be stored.''.  If a program breaks these rules, the results on any
3028 particular implementation are entirely unpredictable.
3030 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3031 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3032 diagnosed by this option, and it may give an occasional false positive
3033 result, but in general it has been found fairly effective at detecting
3034 this sort of problem in programs.
3036 The standard is worded confusingly, therefore there is some debate
3037 over the precise meaning of the sequence point rules in subtle cases.
3038 Links to discussions of the problem, including proposed formal
3039 definitions, may be found on the GCC readings page, at
3040 @w{@uref{http://gcc.gnu.org/readings.html}}.
3042 This warning is enabled by @option{-Wall} for C and C++.
3044 @item -Wreturn-type
3045 @opindex Wreturn-type
3046 @opindex Wno-return-type
3047 Warn whenever a function is defined with a return-type that defaults
3048 to @code{int}.  Also warn about any @code{return} statement with no
3049 return-value in a function whose return-type is not @code{void}
3050 (falling off the end of the function body is considered returning
3051 without a value), and about a @code{return} statement with a
3052 expression in a function whose return-type is @code{void}.
3054 For C++, a function without return type always produces a diagnostic
3055 message, even when @option{-Wno-return-type} is specified.  The only
3056 exceptions are @samp{main} and functions defined in system headers.
3058 This warning is enabled by @option{-Wall}.
3060 @item -Wswitch
3061 @opindex Wswitch
3062 @opindex Wno-switch
3063 Warn whenever a @code{switch} statement has an index of enumerated type
3064 and lacks a @code{case} for one or more of the named codes of that
3065 enumeration.  (The presence of a @code{default} label prevents this
3066 warning.)  @code{case} labels outside the enumeration range also
3067 provoke warnings when this option is used.
3068 This warning is enabled by @option{-Wall}.
3070 @item -Wswitch-default
3071 @opindex Wswitch-default
3072 @opindex Wno-switch-default
3073 Warn whenever a @code{switch} statement does not have a @code{default}
3074 case.
3076 @item -Wswitch-enum
3077 @opindex Wswitch-enum
3078 @opindex Wno-switch-enum
3079 Warn whenever a @code{switch} statement has an index of enumerated type
3080 and lacks a @code{case} for one or more of the named codes of that
3081 enumeration.  @code{case} labels outside the enumeration range also
3082 provoke warnings when this option is used.
3084 @item -Wtrigraphs
3085 @opindex Wtrigraphs
3086 @opindex Wno-trigraphs
3087 Warn if any trigraphs are encountered that might change the meaning of
3088 the program (trigraphs within comments are not warned about).
3089 This warning is enabled by @option{-Wall}.
3091 @item -Wunused-function
3092 @opindex Wunused-function
3093 @opindex Wno-unused-function
3094 Warn whenever a static function is declared but not defined or a
3095 non-inline static function is unused.
3096 This warning is enabled by @option{-Wall}.
3098 @item -Wunused-label
3099 @opindex Wunused-label
3100 @opindex Wno-unused-label
3101 Warn whenever a label is declared but not used.
3102 This warning is enabled by @option{-Wall}.
3104 To suppress this warning use the @samp{unused} attribute
3105 (@pxref{Variable Attributes}).
3107 @item -Wunused-parameter
3108 @opindex Wunused-parameter
3109 @opindex Wno-unused-parameter
3110 Warn whenever a function parameter is unused aside from its declaration.
3112 To suppress this warning use the @samp{unused} attribute
3113 (@pxref{Variable Attributes}).
3115 @item -Wunused-variable
3116 @opindex Wunused-variable
3117 @opindex Wno-unused-variable
3118 Warn whenever a local variable or non-constant static variable is unused
3119 aside from its declaration.
3120 This warning is enabled by @option{-Wall}.
3122 To suppress this warning use the @samp{unused} attribute
3123 (@pxref{Variable Attributes}).
3125 @item -Wunused-value
3126 @opindex Wunused-value
3127 @opindex Wno-unused-value
3128 Warn whenever a statement computes a result that is explicitly not
3129 used. To suppress this warning cast the unused expression to
3130 @samp{void}. This includes an expression-statement or the left-hand
3131 side of a comma expression that contains no side effects. For example,
3132 an expression such as @samp{x[i,j]} will cause a warning, while
3133 @samp{x[(void)i,j]} will not.
3135 This warning is enabled by @option{-Wall}.
3137 @item -Wunused
3138 @opindex Wunused
3139 @opindex Wno-unused
3140 All the above @option{-Wunused} options combined.
3142 In order to get a warning about an unused function parameter, you must
3143 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3144 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3146 @item -Wuninitialized
3147 @opindex Wuninitialized
3148 @opindex Wno-uninitialized
3149 Warn if an automatic variable is used without first being initialized or
3150 if a variable may be clobbered by a @code{setjmp} call.
3152 These warnings are possible only in optimizing compilation,
3153 because they require data flow information that is computed only
3154 when optimizing.  If you do not specify @option{-O}, you will not get
3155 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3156 requiring @option{-O}.
3158 If you want to warn about code which uses the uninitialized value of the
3159 variable in its own initializer, use the @option{-Winit-self} option.
3161 These warnings occur for individual uninitialized or clobbered
3162 elements of structure, union or array variables as well as for
3163 variables which are uninitialized or clobbered as a whole.  They do
3164 not occur for variables or elements declared @code{volatile}.  Because
3165 these warnings depend on optimization, the exact variables or elements
3166 for which there are warnings will depend on the precise optimization
3167 options and version of GCC used.
3169 Note that there may be no warning about a variable that is used only
3170 to compute a value that itself is never used, because such
3171 computations may be deleted by data flow analysis before the warnings
3172 are printed.
3174 These warnings are made optional because GCC is not smart
3175 enough to see all the reasons why the code might be correct
3176 despite appearing to have an error.  Here is one example of how
3177 this can happen:
3179 @smallexample
3180 @group
3182   int x;
3183   switch (y)
3184     @{
3185     case 1: x = 1;
3186       break;
3187     case 2: x = 4;
3188       break;
3189     case 3: x = 5;
3190     @}
3191   foo (x);
3193 @end group
3194 @end smallexample
3196 @noindent
3197 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3198 always initialized, but GCC doesn't know this.  Here is
3199 another common case:
3201 @smallexample
3203   int save_y;
3204   if (change_y) save_y = y, y = new_y;
3205   @dots{}
3206   if (change_y) y = save_y;
3208 @end smallexample
3210 @noindent
3211 This has no bug because @code{save_y} is used only if it is set.
3213 @cindex @code{longjmp} warnings
3214 This option also warns when a non-volatile automatic variable might be
3215 changed by a call to @code{longjmp}.  These warnings as well are possible
3216 only in optimizing compilation.
3218 The compiler sees only the calls to @code{setjmp}.  It cannot know
3219 where @code{longjmp} will be called; in fact, a signal handler could
3220 call it at any point in the code.  As a result, you may get a warning
3221 even when there is in fact no problem because @code{longjmp} cannot
3222 in fact be called at the place which would cause a problem.
3224 Some spurious warnings can be avoided if you declare all the functions
3225 you use that never return as @code{noreturn}.  @xref{Function
3226 Attributes}.
3228 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3229 optimizing compilations (@option{-O1} and above).
3231 @item -Wunknown-pragmas
3232 @opindex Wunknown-pragmas
3233 @opindex Wno-unknown-pragmas
3234 @cindex warning for unknown pragmas
3235 @cindex unknown pragmas, warning
3236 @cindex pragmas, warning of unknown
3237 Warn when a #pragma directive is encountered which is not understood by
3238 GCC@.  If this command line option is used, warnings will even be issued
3239 for unknown pragmas in system header files.  This is not the case if
3240 the warnings were only enabled by the @option{-Wall} command line option.
3242 @item -Wno-pragmas
3243 @opindex Wno-pragmas
3244 @opindex Wpragmas
3245 Do not warn about misuses of pragmas, such as incorrect parameters,
3246 invalid syntax, or conflicts between pragmas.  See also
3247 @samp{-Wunknown-pragmas}.
3249 @item -Wstrict-aliasing
3250 @opindex Wstrict-aliasing
3251 @opindex Wno-strict-aliasing
3252 This option is only active when @option{-fstrict-aliasing} is active.
3253 It warns about code which might break the strict aliasing rules that the
3254 compiler is using for optimization.  The warning does not catch all
3255 cases, but does attempt to catch the more common pitfalls.  It is
3256 included in @option{-Wall}.
3257 It is equivalent to @option{-Wstrict-aliasing=3}
3259 @item -Wstrict-aliasing=n
3260 @opindex Wstrict-aliasing=n
3261 @opindex Wno-strict-aliasing=n
3262 This option is only active when @option{-fstrict-aliasing} is active.
3263 It warns about code which might break the strict aliasing rules that the
3264 compiler is using for optimization.
3265 Higher levels correspond to higher accuracy (fewer false positives).
3266 Higher levels also correspond to more effort, similar to the way -O works.
3267 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3268 with n=3.
3270 Level 1: Most aggressive, quick, least accurate.
3271 Possibly useful when higher levels
3272 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3273 false negatives.  However, it has many false positives.
3274 Warns for all pointer conversions between possibly incompatible types, 
3275 even if never dereferenced.  Runs in the frontend only.
3277 Level 2: Aggressive, quick, not too precise.
3278 May still have many false positives (not as many as level 1 though),
3279 and few false negatives (but possibly more than level 1).
3280 Unlike level 1, it only warns when an address is taken.  Warns about
3281 incomplete types.  Runs in the frontend only.
3283 Level 3 (default for @option{-Wstrict-aliasing}): 
3284 Should have very few false positives and few false 
3285 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3286 Takes care of the common punn+dereference pattern in the frontend:
3287 @code{*(int*)&some_float}.
3288 If optimization is enabled, it also runs in the backend, where it deals 
3289 with multiple statement cases using flow-sensitive points-to information.
3290 Only warns when the converted pointer is dereferenced.
3291 Does not warn about incomplete types.
3293 @item -Wstrict-overflow
3294 @itemx -Wstrict-overflow=@var{n}
3295 @opindex Wstrict-overflow
3296 @opindex Wno-strict-overflow
3297 This option is only active when @option{-fstrict-overflow} is active.
3298 It warns about cases where the compiler optimizes based on the
3299 assumption that signed overflow does not occur.  Note that it does not
3300 warn about all cases where the code might overflow: it only warns
3301 about cases where the compiler implements some optimization.  Thus
3302 this warning depends on the optimization level.
3304 An optimization which assumes that signed overflow does not occur is
3305 perfectly safe if the values of the variables involved are such that
3306 overflow never does, in fact, occur.  Therefore this warning can
3307 easily give a false positive: a warning about code which is not
3308 actually a problem.  To help focus on important issues, several
3309 warning levels are defined.  No warnings are issued for the use of
3310 undefined signed overflow when estimating how many iterations a loop
3311 will require, in particular when determining whether a loop will be
3312 executed at all.
3314 @table @gcctabopt
3315 @item -Wstrict-overflow=1
3316 Warn about cases which are both questionable and easy to avoid.  For
3317 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3318 compiler will simplify this to @code{1}.  This level of
3319 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3320 are not, and must be explicitly requested.
3322 @item -Wstrict-overflow=2
3323 Also warn about other cases where a comparison is simplified to a
3324 constant.  For example: @code{abs (x) >= 0}.  This can only be
3325 simplified when @option{-fstrict-overflow} is in effect, because
3326 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3327 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3328 @option{-Wstrict-overflow=2}.
3330 @item -Wstrict-overflow=3
3331 Also warn about other cases where a comparison is simplified.  For
3332 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3334 @item -Wstrict-overflow=4
3335 Also warn about other simplifications not covered by the above cases.
3336 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3338 @item -Wstrict-overflow=5
3339 Also warn about cases where the compiler reduces the magnitude of a
3340 constant involved in a comparison.  For example: @code{x + 2 > y} will
3341 be simplified to @code{x + 1 >= y}.  This is reported only at the
3342 highest warning level because this simplification applies to many
3343 comparisons, so this warning level will give a very large number of
3344 false positives.
3345 @end table
3347 @item -Warray-bounds
3348 @opindex Wno-array-bounds
3349 @opindex Warray-bounds
3350 This option is only active when @option{-ftree-vrp} is active
3351 (default for -O2 and above). It warns about subscripts to arrays
3352 that are always out of bounds. This warning is enabled by @option{-Wall}.
3354 @item -Wno-div-by-zero
3355 @opindex Wno-div-by-zero
3356 @opindex Wdiv-by-zero
3357 Do not warn about compile-time integer division by zero.  Floating point
3358 division by zero is not warned about, as it can be a legitimate way of
3359 obtaining infinities and NaNs.
3361 @item -Wsystem-headers
3362 @opindex Wsystem-headers
3363 @opindex Wno-system-headers
3364 @cindex warnings from system headers
3365 @cindex system headers, warnings from
3366 Print warning messages for constructs found in system header files.
3367 Warnings from system headers are normally suppressed, on the assumption
3368 that they usually do not indicate real problems and would only make the
3369 compiler output harder to read.  Using this command line option tells
3370 GCC to emit warnings from system headers as if they occurred in user
3371 code.  However, note that using @option{-Wall} in conjunction with this
3372 option will @emph{not} warn about unknown pragmas in system
3373 headers---for that, @option{-Wunknown-pragmas} must also be used.
3375 @item -Wfloat-equal
3376 @opindex Wfloat-equal
3377 @opindex Wno-float-equal
3378 Warn if floating point values are used in equality comparisons.
3380 The idea behind this is that sometimes it is convenient (for the
3381 programmer) to consider floating-point values as approximations to
3382 infinitely precise real numbers.  If you are doing this, then you need
3383 to compute (by analyzing the code, or in some other way) the maximum or
3384 likely maximum error that the computation introduces, and allow for it
3385 when performing comparisons (and when producing output, but that's a
3386 different problem).  In particular, instead of testing for equality, you
3387 would check to see whether the two values have ranges that overlap; and
3388 this is done with the relational operators, so equality comparisons are
3389 probably mistaken.
3391 @item -Wtraditional @r{(C and Objective-C only)}
3392 @opindex Wtraditional
3393 @opindex Wno-traditional
3394 Warn about certain constructs that behave differently in traditional and
3395 ISO C@.  Also warn about ISO C constructs that have no traditional C
3396 equivalent, and/or problematic constructs which should be avoided.
3398 @itemize @bullet
3399 @item
3400 Macro parameters that appear within string literals in the macro body.
3401 In traditional C macro replacement takes place within string literals,
3402 but does not in ISO C@.
3404 @item
3405 In traditional C, some preprocessor directives did not exist.
3406 Traditional preprocessors would only consider a line to be a directive
3407 if the @samp{#} appeared in column 1 on the line.  Therefore
3408 @option{-Wtraditional} warns about directives that traditional C
3409 understands but would ignore because the @samp{#} does not appear as the
3410 first character on the line.  It also suggests you hide directives like
3411 @samp{#pragma} not understood by traditional C by indenting them.  Some
3412 traditional implementations would not recognize @samp{#elif}, so it
3413 suggests avoiding it altogether.
3415 @item
3416 A function-like macro that appears without arguments.
3418 @item
3419 The unary plus operator.
3421 @item
3422 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3423 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3424 constants.)  Note, these suffixes appear in macros defined in the system
3425 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3426 Use of these macros in user code might normally lead to spurious
3427 warnings, however GCC's integrated preprocessor has enough context to
3428 avoid warning in these cases.
3430 @item
3431 A function declared external in one block and then used after the end of
3432 the block.
3434 @item
3435 A @code{switch} statement has an operand of type @code{long}.
3437 @item
3438 A non-@code{static} function declaration follows a @code{static} one.
3439 This construct is not accepted by some traditional C compilers.
3441 @item
3442 The ISO type of an integer constant has a different width or
3443 signedness from its traditional type.  This warning is only issued if
3444 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3445 typically represent bit patterns, are not warned about.
3447 @item
3448 Usage of ISO string concatenation is detected.
3450 @item
3451 Initialization of automatic aggregates.
3453 @item
3454 Identifier conflicts with labels.  Traditional C lacks a separate
3455 namespace for labels.
3457 @item
3458 Initialization of unions.  If the initializer is zero, the warning is
3459 omitted.  This is done under the assumption that the zero initializer in
3460 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3461 initializer warnings and relies on default initialization to zero in the
3462 traditional C case.
3464 @item
3465 Conversions by prototypes between fixed/floating point values and vice
3466 versa.  The absence of these prototypes when compiling with traditional
3467 C would cause serious problems.  This is a subset of the possible
3468 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3470 @item
3471 Use of ISO C style function definitions.  This warning intentionally is
3472 @emph{not} issued for prototype declarations or variadic functions
3473 because these ISO C features will appear in your code when using
3474 libiberty's traditional C compatibility macros, @code{PARAMS} and
3475 @code{VPARAMS}.  This warning is also bypassed for nested functions
3476 because that feature is already a GCC extension and thus not relevant to
3477 traditional C compatibility.
3478 @end itemize
3480 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3481 @opindex Wtraditional-conversion
3482 @opindex Wno-traditional-conversion
3483 Warn if a prototype causes a type conversion that is different from what
3484 would happen to the same argument in the absence of a prototype.  This
3485 includes conversions of fixed point to floating and vice versa, and
3486 conversions changing the width or signedness of a fixed point argument
3487 except when the same as the default promotion.
3489 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3490 @opindex Wdeclaration-after-statement
3491 @opindex Wno-declaration-after-statement
3492 Warn when a declaration is found after a statement in a block.  This
3493 construct, known from C++, was introduced with ISO C99 and is by default
3494 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3495 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3497 @item -Wundef
3498 @opindex Wundef
3499 @opindex Wno-undef
3500 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3502 @item -Wno-endif-labels
3503 @opindex Wno-endif-labels
3504 @opindex Wendif-labels
3505 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3507 @item -Wshadow
3508 @opindex Wshadow
3509 @opindex Wno-shadow
3510 Warn whenever a local variable shadows another local variable, parameter or
3511 global variable or whenever a built-in function is shadowed.
3513 @item -Wlarger-than-@var{len}
3514 @opindex Wlarger-than-@var{len}
3515 Warn whenever an object of larger than @var{len} bytes is defined.
3517 @item -Wunsafe-loop-optimizations
3518 @opindex Wunsafe-loop-optimizations
3519 @opindex Wno-unsafe-loop-optimizations
3520 Warn if the loop cannot be optimized because the compiler could not
3521 assume anything on the bounds of the loop indices.  With
3522 @option{-funsafe-loop-optimizations} warn if the compiler made
3523 such assumptions.
3525 @item -Wpointer-arith
3526 @opindex Wpointer-arith
3527 @opindex Wno-pointer-arith
3528 Warn about anything that depends on the ``size of'' a function type or
3529 of @code{void}.  GNU C assigns these types a size of 1, for
3530 convenience in calculations with @code{void *} pointers and pointers
3531 to functions.  In C++, warn also when an arithmetic operation involves
3532 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3534 @item -Wtype-limits
3535 @opindex Wtype-limits
3536 @opindex Wno-type-limits
3537 Warn if a comparison is always true or always false due to the limited
3538 range of the data type, but do not warn for constant expressions.  For
3539 example, warn if an unsigned variable is compared against zero with
3540 @samp{<} or @samp{>=}.  This warning is also enabled by
3541 @option{-Wextra}.
3543 @item -Wbad-function-cast @r{(C and Objective-C only)}
3544 @opindex Wbad-function-cast
3545 @opindex Wno-bad-function-cast
3546 Warn whenever a function call is cast to a non-matching type.
3547 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3549 @item -Wc++-compat @r{(C and Objective-C only)}
3550 Warn about ISO C constructs that are outside of the common subset of
3551 ISO C and ISO C++, e.g.@: request for implicit conversion from
3552 @code{void *} to a pointer to non-@code{void} type.
3554 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3555 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3556 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3557 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3559 @item -Wcast-qual
3560 @opindex Wcast-qual
3561 @opindex Wno-cast-qual
3562 Warn whenever a pointer is cast so as to remove a type qualifier from
3563 the target type.  For example, warn if a @code{const char *} is cast
3564 to an ordinary @code{char *}.
3566 @item -Wcast-align
3567 @opindex Wcast-align
3568 @opindex Wno-cast-align
3569 Warn whenever a pointer is cast such that the required alignment of the
3570 target is increased.  For example, warn if a @code{char *} is cast to
3571 an @code{int *} on machines where integers can only be accessed at
3572 two- or four-byte boundaries.
3574 @item -Wwrite-strings
3575 @opindex Wwrite-strings
3576 @opindex Wno-write-strings
3577 When compiling C, give string constants the type @code{const
3578 char[@var{length}]} so that
3579 copying the address of one into a non-@code{const} @code{char *}
3580 pointer will get a warning; when compiling C++, warn about the
3581 deprecated conversion from string literals to @code{char *}.  This
3582 warning, by default, is enabled for C++ programs.
3583 These warnings will help you find at
3584 compile time code that can try to write into a string constant, but
3585 only if you have been very careful about using @code{const} in
3586 declarations and prototypes.  Otherwise, it will just be a nuisance;
3587 this is why we did not make @option{-Wall} request these warnings.
3589 @item -Wclobbered
3590 @opindex Wclobbered
3591 @opindex Wno-clobbered
3592 Warn for variables that might be changed by @samp{longjmp} or
3593 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3595 @item -Wconversion
3596 @opindex Wconversion
3597 @opindex Wno-conversion
3598 Warn for implicit conversions that may alter a value. This includes
3599 conversions between real and integer, like @code{abs (x)} when
3600 @code{x} is @code{double}; conversions between signed and unsigned,
3601 like @code{unsigned ui = -1}; and conversions to smaller types, like
3602 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3603 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3604 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3605 conversions between signed and unsigned integers can be disabled by
3606 using @option{-Wno-sign-conversion}.
3608 For C++, also warn for conversions between @code{NULL} and non-pointer
3609 types; confusing overload resolution for user-defined conversions; and
3610 conversions that will never use a type conversion operator:
3611 conversions to @code{void}, the same type, a base class or a reference
3612 to them. Warnings about conversions between signed and unsigned
3613 integers are disabled by default in C++ unless
3614 @option{-Wsign-conversion} is explicitly enabled.
3616 @item -Wempty-body
3617 @opindex Wempty-body
3618 @opindex Wno-empty-body
3619 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3620 while} statement.  Additionally, in C++, warn when an empty body occurs
3621 in a @samp{while} or @samp{for} statement with no whitespacing before
3622 the semicolon.  This warning is also enabled by @option{-Wextra}.
3624 @item -Wsign-compare
3625 @opindex Wsign-compare
3626 @opindex Wno-sign-compare
3627 @cindex warning for comparison of signed and unsigned values
3628 @cindex comparison of signed and unsigned values, warning
3629 @cindex signed and unsigned values, comparison warning
3630 Warn when a comparison between signed and unsigned values could produce
3631 an incorrect result when the signed value is converted to unsigned.
3632 This warning is also enabled by @option{-Wextra}; to get the other warnings
3633 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3635 @item -Wsign-conversion
3636 @opindex Wsign-conversion
3637 @opindex Wno-sign-conversion
3638 Warn for implicit conversions that may change the sign of an integer
3639 value, like assigning a signed integer expression to an unsigned
3640 integer variable. An explicit cast silences the warning. In C, this
3641 option is enabled also by @option{-Wconversion}.
3643 @item -Waddress
3644 @opindex Waddress
3645 @opindex Wno-address
3646 Warn about suspicious uses of memory addresses. These include using
3647 the address of a function in a conditional expression, such as
3648 @code{void func(void); if (func)}, and comparisons against the memory
3649 address of a string literal, such as @code{if (x == "abc")}.  Such
3650 uses typically indicate a programmer error: the address of a function
3651 always evaluates to true, so their use in a conditional usually
3652 indicate that the programmer forgot the parentheses in a function
3653 call; and comparisons against string literals result in unspecified
3654 behavior and are not portable in C, so they usually indicate that the
3655 programmer intended to use @code{strcmp}.  This warning is enabled by
3656 @option{-Wall}.
3658 @item -Wlogical-op
3659 @opindex Wlogical-op
3660 @opindex Wno-logical-op
3661 Warn about suspicious uses of logical operators in expressions.
3662 This includes using logical operators in contexts where a
3663 bit-wise operator is likely to be expected.
3665 @item -Waggregate-return
3666 @opindex Waggregate-return
3667 @opindex Wno-aggregate-return
3668 Warn if any functions that return structures or unions are defined or
3669 called.  (In languages where you can return an array, this also elicits
3670 a warning.)
3672 @item -Wno-attributes
3673 @opindex Wno-attributes
3674 @opindex Wattributes
3675 Do not warn if an unexpected @code{__attribute__} is used, such as
3676 unrecognized attributes, function attributes applied to variables,
3677 etc.  This will not stop errors for incorrect use of supported
3678 attributes.
3680 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3681 @opindex Wstrict-prototypes
3682 @opindex Wno-strict-prototypes
3683 Warn if a function is declared or defined without specifying the
3684 argument types.  (An old-style function definition is permitted without
3685 a warning if preceded by a declaration which specifies the argument
3686 types.)
3688 @item -Wold-style-declaration @r{(C and Objective-C only)}
3689 @opindex Wold-style-declaration
3690 @opindex Wno-old-style-declaration
3691 Warn for obsolescent usages, according to the C Standard, in a
3692 declaration. For example, warn if storage-class specifiers like
3693 @code{static} are not the first things in a declaration.  This warning
3694 is also enabled by @option{-Wextra}.
3696 @item -Wold-style-definition @r{(C and Objective-C only)}
3697 @opindex Wold-style-definition
3698 @opindex Wno-old-style-definition
3699 Warn if an old-style function definition is used.  A warning is given
3700 even if there is a previous prototype.
3702 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3703 @opindex Wmissing-parameter-type
3704 @opindex Wno-missing-parameter-type
3705 A function parameter is declared without a type specifier in K&R-style
3706 functions:
3708 @smallexample
3709 void foo(bar) @{ @}
3710 @end smallexample
3712 This warning is also enabled by @option{-Wextra}.
3714 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3715 @opindex Wmissing-prototypes
3716 @opindex Wno-missing-prototypes
3717 Warn if a global function is defined without a previous prototype
3718 declaration.  This warning is issued even if the definition itself
3719 provides a prototype.  The aim is to detect global functions that fail
3720 to be declared in header files.
3722 @item -Wmissing-declarations
3723 @opindex Wmissing-declarations
3724 @opindex Wno-missing-declarations
3725 Warn if a global function is defined without a previous declaration.
3726 Do so even if the definition itself provides a prototype.
3727 Use this option to detect global functions that are not declared in
3728 header files.  In C++, no warnings are issued for function templates,
3729 or for inline functions, or for functions in anonymous namespaces.
3731 @item -Wmissing-field-initializers
3732 @opindex Wmissing-field-initializers
3733 @opindex Wno-missing-field-initializers
3734 @opindex W
3735 @opindex Wextra
3736 @opindex Wno-extra
3737 Warn if a structure's initializer has some fields missing.  For
3738 example, the following code would cause such a warning, because
3739 @code{x.h} is implicitly zero:
3741 @smallexample
3742 struct s @{ int f, g, h; @};
3743 struct s x = @{ 3, 4 @};
3744 @end smallexample
3746 This option does not warn about designated initializers, so the following
3747 modification would not trigger a warning:
3749 @smallexample
3750 struct s @{ int f, g, h; @};
3751 struct s x = @{ .f = 3, .g = 4 @};
3752 @end smallexample
3754 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3755 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3757 @item -Wmissing-noreturn
3758 @opindex Wmissing-noreturn
3759 @opindex Wno-missing-noreturn
3760 Warn about functions which might be candidates for attribute @code{noreturn}.
3761 Note these are only possible candidates, not absolute ones.  Care should
3762 be taken to manually verify functions actually do not ever return before
3763 adding the @code{noreturn} attribute, otherwise subtle code generation
3764 bugs could be introduced.  You will not get a warning for @code{main} in
3765 hosted C environments.
3767 @item -Wmissing-format-attribute
3768 @opindex Wmissing-format-attribute
3769 @opindex Wno-missing-format-attribute
3770 @opindex Wformat
3771 @opindex Wno-format
3772 Warn about function pointers which might be candidates for @code{format}
3773 attributes.  Note these are only possible candidates, not absolute ones.
3774 GCC will guess that function pointers with @code{format} attributes that
3775 are used in assignment, initialization, parameter passing or return
3776 statements should have a corresponding @code{format} attribute in the
3777 resulting type.  I.e.@: the left-hand side of the assignment or
3778 initialization, the type of the parameter variable, or the return type
3779 of the containing function respectively should also have a @code{format}
3780 attribute to avoid the warning.
3782 GCC will also warn about function definitions which might be
3783 candidates for @code{format} attributes.  Again, these are only
3784 possible candidates.  GCC will guess that @code{format} attributes
3785 might be appropriate for any function that calls a function like
3786 @code{vprintf} or @code{vscanf}, but this might not always be the
3787 case, and some functions for which @code{format} attributes are
3788 appropriate may not be detected.
3790 @item -Wno-multichar
3791 @opindex Wno-multichar
3792 @opindex Wmultichar
3793 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3794 Usually they indicate a typo in the user's code, as they have
3795 implementation-defined values, and should not be used in portable code.
3797 @item -Wnormalized=<none|id|nfc|nfkc>
3798 @opindex Wnormalized=
3799 @cindex NFC
3800 @cindex NFKC
3801 @cindex character set, input normalization
3802 In ISO C and ISO C++, two identifiers are different if they are
3803 different sequences of characters.  However, sometimes when characters
3804 outside the basic ASCII character set are used, you can have two
3805 different character sequences that look the same.  To avoid confusion,
3806 the ISO 10646 standard sets out some @dfn{normalization rules} which
3807 when applied ensure that two sequences that look the same are turned into
3808 the same sequence.  GCC can warn you if you are using identifiers which
3809 have not been normalized; this option controls that warning.
3811 There are four levels of warning that GCC supports.  The default is
3812 @option{-Wnormalized=nfc}, which warns about any identifier which is
3813 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3814 recommended form for most uses.
3816 Unfortunately, there are some characters which ISO C and ISO C++ allow
3817 in identifiers that when turned into NFC aren't allowable as
3818 identifiers.  That is, there's no way to use these symbols in portable
3819 ISO C or C++ and have all your identifiers in NFC.
3820 @option{-Wnormalized=id} suppresses the warning for these characters.
3821 It is hoped that future versions of the standards involved will correct
3822 this, which is why this option is not the default.
3824 You can switch the warning off for all characters by writing
3825 @option{-Wnormalized=none}.  You would only want to do this if you
3826 were using some other normalization scheme (like ``D''), because
3827 otherwise you can easily create bugs that are literally impossible to see.
3829 Some characters in ISO 10646 have distinct meanings but look identical
3830 in some fonts or display methodologies, especially once formatting has
3831 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3832 LETTER N'', will display just like a regular @code{n} which has been
3833 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3834 normalization scheme to convert all these into a standard form as
3835 well, and GCC will warn if your code is not in NFKC if you use
3836 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3837 about every identifier that contains the letter O because it might be
3838 confused with the digit 0, and so is not the default, but may be
3839 useful as a local coding convention if the programming environment is
3840 unable to be fixed to display these characters distinctly.
3842 @item -Wno-deprecated-declarations
3843 @opindex Wno-deprecated-declarations
3844 @opindex Wdeprecated-declarations
3845 Do not warn about uses of functions (@pxref{Function Attributes}),
3846 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3847 Attributes}) marked as deprecated by using the @code{deprecated}
3848 attribute.
3850 @item -Wno-overflow
3851 @opindex Wno-overflow
3852 @opindex Woverflow
3853 Do not warn about compile-time overflow in constant expressions.
3855 @item -Woverride-init @r{(C and Objective-C only)}
3856 @opindex Woverride-init
3857 @opindex Wno-override-init
3858 @opindex W
3859 @opindex Wextra
3860 @opindex Wno-extra
3861 Warn if an initialized field without side effects is overridden when
3862 using designated initializers (@pxref{Designated Inits, , Designated
3863 Initializers}).
3865 This warning is included in @option{-Wextra}.  To get other
3866 @option{-Wextra} warnings without this one, use @samp{-Wextra
3867 -Wno-override-init}.
3869 @item -Wpacked
3870 @opindex Wpacked
3871 @opindex Wno-packed
3872 Warn if a structure is given the packed attribute, but the packed
3873 attribute has no effect on the layout or size of the structure.
3874 Such structures may be mis-aligned for little benefit.  For
3875 instance, in this code, the variable @code{f.x} in @code{struct bar}
3876 will be misaligned even though @code{struct bar} does not itself
3877 have the packed attribute:
3879 @smallexample
3880 @group
3881 struct foo @{
3882   int x;
3883   char a, b, c, d;
3884 @} __attribute__((packed));
3885 struct bar @{
3886   char z;
3887   struct foo f;
3889 @end group
3890 @end smallexample
3892 @item -Wpadded
3893 @opindex Wpadded
3894 @opindex Wno-padded
3895 Warn if padding is included in a structure, either to align an element
3896 of the structure or to align the whole structure.  Sometimes when this
3897 happens it is possible to rearrange the fields of the structure to
3898 reduce the padding and so make the structure smaller.
3900 @item -Wredundant-decls
3901 @opindex Wredundant-decls
3902 @opindex Wno-redundant-decls
3903 Warn if anything is declared more than once in the same scope, even in
3904 cases where multiple declaration is valid and changes nothing.
3906 @item -Wnested-externs @r{(C and Objective-C only)}
3907 @opindex Wnested-externs
3908 @opindex Wno-nested-externs
3909 Warn if an @code{extern} declaration is encountered within a function.
3911 @item -Wunreachable-code
3912 @opindex Wunreachable-code
3913 @opindex Wno-unreachable-code
3914 Warn if the compiler detects that code will never be executed.
3916 This option is intended to warn when the compiler detects that at
3917 least a whole line of source code will never be executed, because
3918 some condition is never satisfied or because it is after a
3919 procedure that never returns.
3921 It is possible for this option to produce a warning even though there
3922 are circumstances under which part of the affected line can be executed,
3923 so care should be taken when removing apparently-unreachable code.
3925 For instance, when a function is inlined, a warning may mean that the
3926 line is unreachable in only one inlined copy of the function.
3928 This option is not made part of @option{-Wall} because in a debugging
3929 version of a program there is often substantial code which checks
3930 correct functioning of the program and is, hopefully, unreachable
3931 because the program does work.  Another common use of unreachable
3932 code is to provide behavior which is selectable at compile-time.
3934 @item -Winline
3935 @opindex Winline
3936 @opindex Wno-inline
3937 Warn if a function can not be inlined and it was declared as inline.
3938 Even with this option, the compiler will not warn about failures to
3939 inline functions declared in system headers.
3941 The compiler uses a variety of heuristics to determine whether or not
3942 to inline a function.  For example, the compiler takes into account
3943 the size of the function being inlined and the amount of inlining
3944 that has already been done in the current function.  Therefore,
3945 seemingly insignificant changes in the source program can cause the
3946 warnings produced by @option{-Winline} to appear or disappear.
3948 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
3949 @opindex Wno-invalid-offsetof
3950 @opindex Winvalid-offsetof
3951 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3952 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3953 to a non-POD type is undefined.  In existing C++ implementations,
3954 however, @samp{offsetof} typically gives meaningful results even when
3955 applied to certain kinds of non-POD types. (Such as a simple
3956 @samp{struct} that fails to be a POD type only by virtue of having a
3957 constructor.)  This flag is for users who are aware that they are
3958 writing nonportable code and who have deliberately chosen to ignore the
3959 warning about it.
3961 The restrictions on @samp{offsetof} may be relaxed in a future version
3962 of the C++ standard.
3964 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
3965 @opindex Wno-int-to-pointer-cast
3966 @opindex Wint-to-pointer-cast
3967 Suppress warnings from casts to pointer type of an integer of a
3968 different size.
3970 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
3971 @opindex Wno-pointer-to-int-cast
3972 @opindex Wpointer-to-int-cast
3973 Suppress warnings from casts from a pointer to an integer type of a
3974 different size.
3976 @item -Winvalid-pch
3977 @opindex Winvalid-pch
3978 @opindex Wno-invalid-pch
3979 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3980 the search path but can't be used.
3982 @item -Wlong-long
3983 @opindex Wlong-long
3984 @opindex Wno-long-long
3985 Warn if @samp{long long} type is used.  This is default.  To inhibit
3986 the warning messages, use @option{-Wno-long-long}.  Flags
3987 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3988 only when @option{-pedantic} flag is used.
3990 @item -Wvariadic-macros
3991 @opindex Wvariadic-macros
3992 @opindex Wno-variadic-macros
3993 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3994 alternate syntax when in pedantic ISO C99 mode.  This is default.
3995 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3997 @item -Wvla
3998 @opindex Wvla
3999 @opindex Wno-vla
4000 Warn if variable length array is used in the code.
4001 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4002 the variable length array.
4004 @item -Wvolatile-register-var
4005 @opindex Wvolatile-register-var
4006 @opindex Wno-volatile-register-var
4007 Warn if a register variable is declared volatile.  The volatile
4008 modifier does not inhibit all optimizations that may eliminate reads
4009 and/or writes to register variables.
4011 @item -Wdisabled-optimization
4012 @opindex Wdisabled-optimization
4013 @opindex Wno-disabled-optimization
4014 Warn if a requested optimization pass is disabled.  This warning does
4015 not generally indicate that there is anything wrong with your code; it
4016 merely indicates that GCC's optimizers were unable to handle the code
4017 effectively.  Often, the problem is that your code is too big or too
4018 complex; GCC will refuse to optimize programs when the optimization
4019 itself is likely to take inordinate amounts of time.
4021 @item -Wpointer-sign @r{(C and Objective-C only)}
4022 @opindex Wpointer-sign
4023 @opindex Wno-pointer-sign
4024 Warn for pointer argument passing or assignment with different signedness.
4025 This option is only supported for C and Objective-C@.  It is implied by
4026 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4027 @option{-Wno-pointer-sign}.
4029 @item -Wstack-protector
4030 @opindex Wstack-protector
4031 @opindex Wno-stack-protector
4032 This option is only active when @option{-fstack-protector} is active.  It
4033 warns about functions that will not be protected against stack smashing.
4035 @item -Woverlength-strings
4036 @opindex Woverlength-strings
4037 @opindex Wno-overlength-strings
4038 Warn about string constants which are longer than the ``minimum
4039 maximum'' length specified in the C standard.  Modern compilers
4040 generally allow string constants which are much longer than the
4041 standard's minimum limit, but very portable programs should avoid
4042 using longer strings.
4044 The limit applies @emph{after} string constant concatenation, and does
4045 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4046 C99, it was raised to 4095.  C++98 does not specify a normative
4047 minimum maximum, so we do not diagnose overlength strings in C++@.
4049 This option is implied by @option{-pedantic}, and can be disabled with
4050 @option{-Wno-overlength-strings}.
4051 @end table
4053 @node Debugging Options
4054 @section Options for Debugging Your Program or GCC
4055 @cindex options, debugging
4056 @cindex debugging information options
4058 GCC has various special options that are used for debugging
4059 either your program or GCC:
4061 @table @gcctabopt
4062 @item -g
4063 @opindex g
4064 Produce debugging information in the operating system's native format
4065 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4066 information.
4068 On most systems that use stabs format, @option{-g} enables use of extra
4069 debugging information that only GDB can use; this extra information
4070 makes debugging work better in GDB but will probably make other debuggers
4071 crash or
4072 refuse to read the program.  If you want to control for certain whether
4073 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4074 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4076 GCC allows you to use @option{-g} with
4077 @option{-O}.  The shortcuts taken by optimized code may occasionally
4078 produce surprising results: some variables you declared may not exist
4079 at all; flow of control may briefly move where you did not expect it;
4080 some statements may not be executed because they compute constant
4081 results or their values were already at hand; some statements may
4082 execute in different places because they were moved out of loops.
4084 Nevertheless it proves possible to debug optimized output.  This makes
4085 it reasonable to use the optimizer for programs that might have bugs.
4087 The following options are useful when GCC is generated with the
4088 capability for more than one debugging format.
4090 @item -ggdb
4091 @opindex ggdb
4092 Produce debugging information for use by GDB@.  This means to use the
4093 most expressive format available (DWARF 2, stabs, or the native format
4094 if neither of those are supported), including GDB extensions if at all
4095 possible.
4097 @item -gstabs
4098 @opindex gstabs
4099 Produce debugging information in stabs format (if that is supported),
4100 without GDB extensions.  This is the format used by DBX on most BSD
4101 systems.  On MIPS, Alpha and System V Release 4 systems this option
4102 produces stabs debugging output which is not understood by DBX or SDB@.
4103 On System V Release 4 systems this option requires the GNU assembler.
4105 @item -feliminate-unused-debug-symbols
4106 @opindex feliminate-unused-debug-symbols
4107 Produce debugging information in stabs format (if that is supported),
4108 for only symbols that are actually used.
4110 @item -femit-class-debug-always
4111 Instead of emitting debugging information for a C++ class in only one
4112 object file, emit it in all object files using the class.  This option
4113 should be used only with debuggers that are unable to handle the way GCC
4114 normally emits debugging information for classes because using this
4115 option will increase the size of debugging information by as much as a
4116 factor of two.
4118 @item -gstabs+
4119 @opindex gstabs+
4120 Produce debugging information in stabs format (if that is supported),
4121 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4122 use of these extensions is likely to make other debuggers crash or
4123 refuse to read the program.
4125 @item -gcoff
4126 @opindex gcoff
4127 Produce debugging information in COFF format (if that is supported).
4128 This is the format used by SDB on most System V systems prior to
4129 System V Release 4.
4131 @item -gxcoff
4132 @opindex gxcoff
4133 Produce debugging information in XCOFF format (if that is supported).
4134 This is the format used by the DBX debugger on IBM RS/6000 systems.
4136 @item -gxcoff+
4137 @opindex gxcoff+
4138 Produce debugging information in XCOFF format (if that is supported),
4139 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4140 use of these extensions is likely to make other debuggers crash or
4141 refuse to read the program, and may cause assemblers other than the GNU
4142 assembler (GAS) to fail with an error.
4144 @item -gdwarf-2
4145 @opindex gdwarf-2
4146 Produce debugging information in DWARF version 2 format (if that is
4147 supported).  This is the format used by DBX on IRIX 6.  With this
4148 option, GCC uses features of DWARF version 3 when they are useful;
4149 version 3 is upward compatible with version 2, but may still cause
4150 problems for older debuggers.
4152 @item -gvms
4153 @opindex gvms
4154 Produce debugging information in VMS debug format (if that is
4155 supported).  This is the format used by DEBUG on VMS systems.
4157 @item -g@var{level}
4158 @itemx -ggdb@var{level}
4159 @itemx -gstabs@var{level}
4160 @itemx -gcoff@var{level}
4161 @itemx -gxcoff@var{level}
4162 @itemx -gvms@var{level}
4163 Request debugging information and also use @var{level} to specify how
4164 much information.  The default level is 2.
4166 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4167 @option{-g}.
4169 Level 1 produces minimal information, enough for making backtraces in
4170 parts of the program that you don't plan to debug.  This includes
4171 descriptions of functions and external variables, but no information
4172 about local variables and no line numbers.
4174 Level 3 includes extra information, such as all the macro definitions
4175 present in the program.  Some debuggers support macro expansion when
4176 you use @option{-g3}.
4178 @option{-gdwarf-2} does not accept a concatenated debug level, because
4179 GCC used to support an option @option{-gdwarf} that meant to generate
4180 debug information in version 1 of the DWARF format (which is very
4181 different from version 2), and it would have been too confusing.  That
4182 debug format is long obsolete, but the option cannot be changed now.
4183 Instead use an additional @option{-g@var{level}} option to change the
4184 debug level for DWARF2.
4186 @item -feliminate-dwarf2-dups
4187 @opindex feliminate-dwarf2-dups
4188 Compress DWARF2 debugging information by eliminating duplicated
4189 information about each symbol.  This option only makes sense when
4190 generating DWARF2 debugging information with @option{-gdwarf-2}.
4192 @item -femit-struct-debug-baseonly
4193 Emit debug information for struct-like types
4194 only when the base name of the compilation source file
4195 matches the base name of file in which the struct was defined.
4197 This option substantially reduces the size of debugging information,
4198 but at significant potential loss in type information to the debugger.
4199 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4200 See @option{-femit-struct-debug-detailed} for more detailed control.
4202 This option works only with DWARF 2.
4204 @item -femit-struct-debug-reduced
4205 Emit debug information for struct-like types
4206 only when the base name of the compilation source file
4207 matches the base name of file in which the type was defined,
4208 unless the struct is a template or defined in a system header.
4210 This option significantly reduces the size of debugging information,
4211 with some potential loss in type information to the debugger.
4212 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4213 See @option{-femit-struct-debug-detailed} for more detailed control.
4215 This option works only with DWARF 2.
4217 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4218 Specify the struct-like types
4219 for which the compiler will generate debug information.
4220 The intent is to reduce duplicate struct debug information
4221 between different object files within the same program.
4223 This option is a detailed version of
4224 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4225 which will serve for most needs.
4227 A specification has the syntax
4228 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4230 The optional first word limits the specification to
4231 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4232 A struct type is used directly when it is the type of a variable, member.
4233 Indirect uses arise through pointers to structs.
4234 That is, when use of an incomplete struct would be legal, the use is indirect.
4235 An example is
4236 @samp{struct one direct; struct two * indirect;}.
4238 The optional second word limits the specification to
4239 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4240 Generic structs are a bit complicated to explain.
4241 For C++, these are non-explicit specializations of template classes,
4242 or non-template classes within the above.
4243 Other programming languages have generics,
4244 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4246 The third word specifies the source files for those
4247 structs for which the compiler will emit debug information.
4248 The values @samp{none} and @samp{any} have the normal meaning.
4249 The value @samp{base} means that
4250 the base of name of the file in which the type declaration appears
4251 must match the base of the name of the main compilation file.
4252 In practice, this means that
4253 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4254 but types declared in other header will not.
4255 The value @samp{sys} means those types satisfying @samp{base}
4256 or declared in system or compiler headers.
4258 You may need to experiment to determine the best settings for your application.
4260 The default is @samp{-femit-struct-debug-detailed=all}.
4262 This option works only with DWARF 2.
4264 @item -fno-merge-debug-strings
4265 @opindex fmerge-debug-strings
4266 @opindex fno-merge-debug-strings
4267 Direct the linker to merge together strings which are identical in
4268 different object files.  This is not supported by all assemblers or
4269 linker.  This decreases the size of the debug information in the
4270 output file at the cost of increasing link processing time.  This is
4271 on by default.
4273 @item -fdebug-prefix-map=@var{old}=@var{new}
4274 @opindex fdebug-prefix-map
4275 When compiling files in directory @file{@var{old}}, record debugging
4276 information describing them as in @file{@var{new}} instead.
4278 @cindex @command{prof}
4279 @item -p
4280 @opindex p
4281 Generate extra code to write profile information suitable for the
4282 analysis program @command{prof}.  You must use this option when compiling
4283 the source files you want data about, and you must also use it when
4284 linking.
4286 @cindex @command{gprof}
4287 @item -pg
4288 @opindex pg
4289 Generate extra code to write profile information suitable for the
4290 analysis program @command{gprof}.  You must use this option when compiling
4291 the source files you want data about, and you must also use it when
4292 linking.
4294 @item -Q
4295 @opindex Q
4296 Makes the compiler print out each function name as it is compiled, and
4297 print some statistics about each pass when it finishes.
4299 @item -ftime-report
4300 @opindex ftime-report
4301 Makes the compiler print some statistics about the time consumed by each
4302 pass when it finishes.
4304 @item -fmem-report
4305 @opindex fmem-report
4306 Makes the compiler print some statistics about permanent memory
4307 allocation when it finishes.
4309 @item -fpre-ipa-mem-report
4310 @opindex fpre-ipa-mem-report
4311 @item -fpost-ipa-mem-report
4312 @opindex fpost-ipa-mem-report
4313 Makes the compiler print some statistics about permanent memory
4314 allocation before or after interprocedural optimization.
4316 @item -fprofile-arcs
4317 @opindex fprofile-arcs
4318 Add code so that program flow @dfn{arcs} are instrumented.  During
4319 execution the program records how many times each branch and call is
4320 executed and how many times it is taken or returns.  When the compiled
4321 program exits it saves this data to a file called
4322 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4323 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4324 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4325 @var{auxname} is generated from the name of the output file, if
4326 explicitly specified and it is not the final executable, otherwise it is
4327 the basename of the source file.  In both cases any suffix is removed
4328 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4329 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4330 @xref{Cross-profiling}.
4332 @cindex @command{gcov}
4333 @item --coverage
4334 @opindex coverage
4336 This option is used to compile and link code instrumented for coverage
4337 analysis.  The option is a synonym for @option{-fprofile-arcs}
4338 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4339 linking).  See the documentation for those options for more details.
4341 @itemize
4343 @item
4344 Compile the source files with @option{-fprofile-arcs} plus optimization
4345 and code generation options.  For test coverage analysis, use the
4346 additional @option{-ftest-coverage} option.  You do not need to profile
4347 every source file in a program.
4349 @item
4350 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4351 (the latter implies the former).
4353 @item
4354 Run the program on a representative workload to generate the arc profile
4355 information.  This may be repeated any number of times.  You can run
4356 concurrent instances of your program, and provided that the file system
4357 supports locking, the data files will be correctly updated.  Also
4358 @code{fork} calls are detected and correctly handled (double counting
4359 will not happen).
4361 @item
4362 For profile-directed optimizations, compile the source files again with
4363 the same optimization and code generation options plus
4364 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4365 Control Optimization}).
4367 @item
4368 For test coverage analysis, use @command{gcov} to produce human readable
4369 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4370 @command{gcov} documentation for further information.
4372 @end itemize
4374 With @option{-fprofile-arcs}, for each function of your program GCC
4375 creates a program flow graph, then finds a spanning tree for the graph.
4376 Only arcs that are not on the spanning tree have to be instrumented: the
4377 compiler adds code to count the number of times that these arcs are
4378 executed.  When an arc is the only exit or only entrance to a block, the
4379 instrumentation code can be added to the block; otherwise, a new basic
4380 block must be created to hold the instrumentation code.
4382 @need 2000
4383 @item -ftest-coverage
4384 @opindex ftest-coverage
4385 Produce a notes file that the @command{gcov} code-coverage utility
4386 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4387 show program coverage.  Each source file's note file is called
4388 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4389 above for a description of @var{auxname} and instructions on how to
4390 generate test coverage data.  Coverage data will match the source files
4391 more closely, if you do not optimize.
4393 @item -fdbg-cnt-list
4394 @opindex fdbg-cnt-list
4395 Print the name and the counter upperbound for all debug counters.
4397 @item -fdbg-cnt=@var{counter-value-list}
4398 @opindex fdbg-cnt
4399 Set the internal debug counter upperbound. @var{counter-value-list} 
4400 is a comma-separated list of @var{name}:@var{value} pairs
4401 which sets the upperbound of each debug counter @var{name} to @var{value}.
4402 All debug counters have the initial upperbound of @var{UINT_MAX},
4403 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4404 e.g. With -fdbg-cnt=dce:10,tail_call:0
4405 dbg_cnt(dce) will return true only for first 10 invocations
4406 and dbg_cnt(tail_call) will return false always.
4408 @item -d@var{letters}
4409 @item -fdump-rtl-@var{pass}
4410 @opindex d
4411 Says to make debugging dumps during compilation at times specified by
4412 @var{letters}.    This is used for debugging the RTL-based passes of the
4413 compiler.  The file names for most of the dumps are made by appending a
4414 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4415 from the name of the output file, if explicitly specified and it is not
4416 an executable, otherwise it is the basename of the source file. These
4417 switches may have different effects when @option{-E} is used for
4418 preprocessing.
4420 Most debug dumps can be enabled either passing a letter to the @option{-d}
4421 option, or with a long @option{-fdump-rtl} switch; here are the possible
4422 letters for use in @var{letters} and @var{pass}, and their meanings:
4424 @table @gcctabopt
4425 @item -dA
4426 @opindex dA
4427 Annotate the assembler output with miscellaneous debugging information.
4429 @item -dB
4430 @itemx -fdump-rtl-bbro
4431 @opindex dB
4432 @opindex fdump-rtl-bbro
4433 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4435 @item -dc
4436 @itemx -fdump-rtl-combine
4437 @opindex dc
4438 @opindex fdump-rtl-combine
4439 Dump after the RTL instruction combination pass, to the file
4440 @file{@var{file}.129r.combine}.
4442 @item -dC
4443 @itemx -fdump-rtl-ce1
4444 @itemx -fdump-rtl-ce2
4445 @opindex dC
4446 @opindex fdump-rtl-ce1
4447 @opindex fdump-rtl-ce2
4448 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
4449 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
4450 and @option{-fdump-rtl-ce2} enable dumping after the second if
4451 conversion, to the file @file{@var{file}.130r.ce2}.
4453 @item -dd
4454 @itemx -fdump-rtl-btl
4455 @itemx -fdump-rtl-dbr
4456 @opindex dd
4457 @opindex fdump-rtl-btl
4458 @opindex fdump-rtl-dbr
4459 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
4460 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
4461 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
4462 scheduling, to @file{@var{file}.36.dbr}.
4464 @item -dD
4465 @opindex dD
4466 Dump all macro definitions, at the end of preprocessing, in addition to
4467 normal output.
4469 @item -dE
4470 @itemx -fdump-rtl-ce3
4471 @opindex dE
4472 @opindex fdump-rtl-ce3
4473 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4475 @item -df
4476 @itemx -fdump-rtl-cfg
4477 @itemx -fdump-rtl-life
4478 @opindex df
4479 @opindex fdump-rtl-cfg
4480 @opindex fdump-rtl-life
4481 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
4482 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
4483 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4484 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4486 @item -dg
4487 @itemx -fdump-rtl-greg
4488 @opindex dg
4489 @opindex fdump-rtl-greg
4490 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4492 @item -dG
4493 @itemx -fdump-rtl-gcse
4494 @itemx -fdump-rtl-bypass
4495 @opindex dG
4496 @opindex fdump-rtl-gcse
4497 @opindex fdump-rtl-bypass
4498 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4499 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
4500 enable dumping after jump bypassing and control flow optimizations, to
4501 @file{@var{file}.115r.bypass}.
4503 @item -dh
4504 @itemx -fdump-rtl-eh
4505 @opindex dh
4506 @opindex fdump-rtl-eh
4507 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4509 @item -di
4510 @itemx -fdump-rtl-sibling
4511 @opindex di
4512 @opindex fdump-rtl-sibling
4513 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4515 @item -dj
4516 @itemx -fdump-rtl-jump
4517 @opindex dj
4518 @opindex fdump-rtl-jump
4519 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4521 @item -dk
4522 @itemx -fdump-rtl-stack
4523 @opindex dk
4524 @opindex fdump-rtl-stack
4525 Dump after conversion from GCC's "flat register file" registers to the
4526 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4528 @item -dl
4529 @itemx -fdump-rtl-lreg
4530 @opindex dl
4531 @opindex fdump-rtl-lreg
4532 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4534 @item -dL
4535 @itemx -fdump-rtl-loop2
4536 @opindex dL
4537 @opindex fdump-rtl-loop2
4538 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4539 loop optimization pass, to @file{@var{file}.119r.loop2},
4540 @file{@var{file}.120r.loop2_init},
4541 @file{@var{file}.121r.loop2_invariant}, and
4542 @file{@var{file}.125r.loop2_done}.
4544 @item -dm
4545 @itemx -fdump-rtl-sms
4546 @opindex dm
4547 @opindex fdump-rtl-sms
4548 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4550 @item -dM
4551 @itemx -fdump-rtl-mach
4552 @opindex dM
4553 @opindex fdump-rtl-mach
4554 Dump after performing the machine dependent reorganization pass, to
4555 @file{@var{file}.155r.mach} if that pass exists.
4557 @item -dn
4558 @itemx -fdump-rtl-rnreg
4559 @opindex dn
4560 @opindex fdump-rtl-rnreg
4561 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4563 @item -dN
4564 @itemx -fdump-rtl-regmove
4565 @opindex dN
4566 @opindex fdump-rtl-regmove
4567 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4569 @item -do
4570 @itemx -fdump-rtl-postreload
4571 @opindex do
4572 @opindex fdump-rtl-postreload
4573 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4575 @item -dr
4576 @itemx -fdump-rtl-expand
4577 @opindex dr
4578 @opindex fdump-rtl-expand
4579 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4581 @item -dR
4582 @itemx -fdump-rtl-sched2
4583 @opindex dR
4584 @opindex fdump-rtl-sched2
4585 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4587 @item -ds
4588 @itemx -fdump-rtl-cse
4589 @opindex ds
4590 @opindex fdump-rtl-cse
4591 Dump after CSE (including the jump optimization that sometimes follows
4592 CSE), to @file{@var{file}.113r.cse}.
4594 @item -dS
4595 @itemx -fdump-rtl-sched1
4596 @opindex dS
4597 @opindex fdump-rtl-sched1
4598 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4600 @item -dt
4601 @itemx -fdump-rtl-cse2
4602 @opindex dt
4603 @opindex fdump-rtl-cse2
4604 Dump after the second CSE pass (including the jump optimization that
4605 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4607 @item -dT
4608 @itemx -fdump-rtl-tracer
4609 @opindex dT
4610 @opindex fdump-rtl-tracer
4611 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4613 @item -dV
4614 @itemx -fdump-rtl-vpt
4615 @itemx -fdump-rtl-vartrack
4616 @opindex dV
4617 @opindex fdump-rtl-vpt
4618 @opindex fdump-rtl-vartrack
4619 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4620 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4621 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4622 to @file{@var{file}.154r.vartrack}.
4624 @item -dw
4625 @itemx -fdump-rtl-flow2
4626 @opindex dw
4627 @opindex fdump-rtl-flow2
4628 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4630 @item -dz
4631 @itemx -fdump-rtl-peephole2
4632 @opindex dz
4633 @opindex fdump-rtl-peephole2
4634 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4636 @item -dZ
4637 @itemx -fdump-rtl-web
4638 @opindex dZ
4639 @opindex fdump-rtl-web
4640 Dump after live range splitting, to @file{@var{file}.126r.web}.
4642 @item -da
4643 @itemx -fdump-rtl-all
4644 @opindex da
4645 @opindex fdump-rtl-all
4646 Produce all the dumps listed above.
4648 @item -dH
4649 @opindex dH
4650 Produce a core dump whenever an error occurs.
4652 @item -dm
4653 @opindex dm
4654 Print statistics on memory usage, at the end of the run, to
4655 standard error.
4657 @item -dp
4658 @opindex dp
4659 Annotate the assembler output with a comment indicating which
4660 pattern and alternative was used.  The length of each instruction is
4661 also printed.
4663 @item -dP
4664 @opindex dP
4665 Dump the RTL in the assembler output as a comment before each instruction.
4666 Also turns on @option{-dp} annotation.
4668 @item -dv
4669 @opindex dv
4670 For each of the other indicated dump files (either with @option{-d} or
4671 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4672 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4674 @item -dx
4675 @opindex dx
4676 Just generate RTL for a function instead of compiling it.  Usually used
4677 with @samp{r} (@option{-fdump-rtl-expand}).
4679 @item -dy
4680 @opindex dy
4681 Dump debugging information during parsing, to standard error.
4682 @end table
4684 @item -fdump-noaddr
4685 @opindex fdump-noaddr
4686 When doing debugging dumps (see @option{-d} option above), suppress
4687 address output.  This makes it more feasible to use diff on debugging
4688 dumps for compiler invocations with different compiler binaries and/or
4689 different text / bss / data / heap / stack / dso start locations.
4691 @item -fdump-unnumbered
4692 @opindex fdump-unnumbered
4693 When doing debugging dumps (see @option{-d} option above), suppress instruction
4694 numbers and address output.  This makes it more feasible to
4695 use diff on debugging dumps for compiler invocations with different
4696 options, in particular with and without @option{-g}.
4698 @item -fdump-simple-rtl
4699 @opindex fdump-simple-rtl
4700 When doing debugging dumps (see @option{-d} option above), suppress
4701 output of flags, modes, etc.  This makes rtl dumps more compact.
4703 @item -fdump-translation-unit @r{(C++ only)}
4704 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4705 @opindex fdump-translation-unit
4706 Dump a representation of the tree structure for the entire translation
4707 unit to a file.  The file name is made by appending @file{.tu} to the
4708 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4709 controls the details of the dump as described for the
4710 @option{-fdump-tree} options.
4712 @item -fdump-class-hierarchy @r{(C++ only)}
4713 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4714 @opindex fdump-class-hierarchy
4715 Dump a representation of each class's hierarchy and virtual function
4716 table layout to a file.  The file name is made by appending @file{.class}
4717 to the source file name.  If the @samp{-@var{options}} form is used,
4718 @var{options} controls the details of the dump as described for the
4719 @option{-fdump-tree} options.
4721 @item -fdump-ipa-@var{switch}
4722 @opindex fdump-ipa
4723 Control the dumping at various stages of inter-procedural analysis
4724 language tree to a file.  The file name is generated by appending a switch
4725 specific suffix to the source file name.  The following dumps are possible:
4727 @table @samp
4728 @item all
4729 Enables all inter-procedural analysis dumps; currently the only produced
4730 dump is the @samp{cgraph} dump.
4732 @item cgraph
4733 Dumps information about call-graph optimization, unused function removal,
4734 and inlining decisions.
4735 @end table
4737 @item -fdump-tree-@var{switch}
4738 @itemx -fdump-tree-@var{switch}-@var{options}
4739 @opindex fdump-tree
4740 Control the dumping at various stages of processing the intermediate
4741 language tree to a file.  The file name is generated by appending a switch
4742 specific suffix to the source file name.  If the @samp{-@var{options}}
4743 form is used, @var{options} is a list of @samp{-} separated options that
4744 control the details of the dump.  Not all options are applicable to all
4745 dumps, those which are not meaningful will be ignored.  The following
4746 options are available
4748 @table @samp
4749 @item address
4750 Print the address of each node.  Usually this is not meaningful as it
4751 changes according to the environment and source file.  Its primary use
4752 is for tying up a dump file with a debug environment.
4753 @item slim
4754 Inhibit dumping of members of a scope or body of a function merely
4755 because that scope has been reached.  Only dump such items when they
4756 are directly reachable by some other path.  When dumping pretty-printed
4757 trees, this option inhibits dumping the bodies of control structures.
4758 @item raw
4759 Print a raw representation of the tree.  By default, trees are
4760 pretty-printed into a C-like representation.
4761 @item details
4762 Enable more detailed dumps (not honored by every dump option).
4763 @item stats
4764 Enable dumping various statistics about the pass (not honored by every dump
4765 option).
4766 @item blocks
4767 Enable showing basic block boundaries (disabled in raw dumps).
4768 @item vops
4769 Enable showing virtual operands for every statement.
4770 @item lineno
4771 Enable showing line numbers for statements.
4772 @item uid
4773 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4774 @item all
4775 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4776 @end table
4778 The following tree dumps are possible:
4779 @table @samp
4781 @item original
4782 Dump before any tree based optimization, to @file{@var{file}.original}.
4784 @item optimized
4785 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4787 @item inlined
4788 Dump after function inlining, to @file{@var{file}.inlined}.
4790 @item gimple
4791 @opindex fdump-tree-gimple
4792 Dump each function before and after the gimplification pass to a file.  The
4793 file name is made by appending @file{.gimple} to the source file name.
4795 @item cfg
4796 @opindex fdump-tree-cfg
4797 Dump the control flow graph of each function to a file.  The file name is
4798 made by appending @file{.cfg} to the source file name.
4800 @item vcg
4801 @opindex fdump-tree-vcg
4802 Dump the control flow graph of each function to a file in VCG format.  The
4803 file name is made by appending @file{.vcg} to the source file name.  Note
4804 that if the file contains more than one function, the generated file cannot
4805 be used directly by VCG@.  You will need to cut and paste each function's
4806 graph into its own separate file first.
4808 @item ch
4809 @opindex fdump-tree-ch
4810 Dump each function after copying loop headers.  The file name is made by
4811 appending @file{.ch} to the source file name.
4813 @item ssa
4814 @opindex fdump-tree-ssa
4815 Dump SSA related information to a file.  The file name is made by appending
4816 @file{.ssa} to the source file name.
4818 @item salias
4819 @opindex fdump-tree-salias
4820 Dump structure aliasing variable information to a file.  This file name
4821 is made by appending @file{.salias} to the source file name.
4823 @item alias
4824 @opindex fdump-tree-alias
4825 Dump aliasing information for each function.  The file name is made by
4826 appending @file{.alias} to the source file name.
4828 @item ccp
4829 @opindex fdump-tree-ccp
4830 Dump each function after CCP@.  The file name is made by appending
4831 @file{.ccp} to the source file name.
4833 @item storeccp
4834 @opindex fdump-tree-storeccp
4835 Dump each function after STORE-CCP.  The file name is made by appending
4836 @file{.storeccp} to the source file name.
4838 @item pre
4839 @opindex fdump-tree-pre
4840 Dump trees after partial redundancy elimination.  The file name is made
4841 by appending @file{.pre} to the source file name.
4843 @item fre
4844 @opindex fdump-tree-fre
4845 Dump trees after full redundancy elimination.  The file name is made
4846 by appending @file{.fre} to the source file name.
4848 @item copyprop
4849 @opindex fdump-tree-copyprop
4850 Dump trees after copy propagation.  The file name is made
4851 by appending @file{.copyprop} to the source file name.
4853 @item store_copyprop
4854 @opindex fdump-tree-store_copyprop
4855 Dump trees after store copy-propagation.  The file name is made
4856 by appending @file{.store_copyprop} to the source file name.
4858 @item dce
4859 @opindex fdump-tree-dce
4860 Dump each function after dead code elimination.  The file name is made by
4861 appending @file{.dce} to the source file name.
4863 @item mudflap
4864 @opindex fdump-tree-mudflap
4865 Dump each function after adding mudflap instrumentation.  The file name is
4866 made by appending @file{.mudflap} to the source file name.
4868 @item sra
4869 @opindex fdump-tree-sra
4870 Dump each function after performing scalar replacement of aggregates.  The
4871 file name is made by appending @file{.sra} to the source file name.
4873 @item sink
4874 @opindex fdump-tree-sink
4875 Dump each function after performing code sinking.  The file name is made
4876 by appending @file{.sink} to the source file name.
4878 @item dom
4879 @opindex fdump-tree-dom
4880 Dump each function after applying dominator tree optimizations.  The file
4881 name is made by appending @file{.dom} to the source file name.
4883 @item dse
4884 @opindex fdump-tree-dse
4885 Dump each function after applying dead store elimination.  The file
4886 name is made by appending @file{.dse} to the source file name.
4888 @item phiopt
4889 @opindex fdump-tree-phiopt
4890 Dump each function after optimizing PHI nodes into straightline code.  The file
4891 name is made by appending @file{.phiopt} to the source file name.
4893 @item forwprop
4894 @opindex fdump-tree-forwprop
4895 Dump each function after forward propagating single use variables.  The file
4896 name is made by appending @file{.forwprop} to the source file name.
4898 @item copyrename
4899 @opindex fdump-tree-copyrename
4900 Dump each function after applying the copy rename optimization.  The file
4901 name is made by appending @file{.copyrename} to the source file name.
4903 @item nrv
4904 @opindex fdump-tree-nrv
4905 Dump each function after applying the named return value optimization on
4906 generic trees.  The file name is made by appending @file{.nrv} to the source
4907 file name.
4909 @item vect
4910 @opindex fdump-tree-vect
4911 Dump each function after applying vectorization of loops.  The file name is
4912 made by appending @file{.vect} to the source file name.
4914 @item vrp
4915 @opindex fdump-tree-vrp
4916 Dump each function after Value Range Propagation (VRP).  The file name
4917 is made by appending @file{.vrp} to the source file name.
4919 @item all
4920 @opindex fdump-tree-all
4921 Enable all the available tree dumps with the flags provided in this option.
4922 @end table
4924 @item -ftree-vectorizer-verbose=@var{n}
4925 @opindex ftree-vectorizer-verbose
4926 This option controls the amount of debugging output the vectorizer prints.
4927 This information is written to standard error, unless
4928 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4929 in which case it is output to the usual dump listing file, @file{.vect}.
4930 For @var{n}=0 no diagnostic information is reported.
4931 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4932 and the total number of loops that got vectorized.
4933 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4934 the first analysis phase (vect_analyze_loop_form) - i.e. countable,
4935 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4936 level that @option{-fdump-tree-vect-stats} uses.
4937 Higher verbosity levels mean either more information dumped for each
4938 reported loop, or same amount of information reported for more loops:
4939 If @var{n}=3, alignment related information is added to the reports.
4940 If @var{n}=4, data-references related information (e.g. memory dependences,
4941 memory access-patterns) is added to the reports.
4942 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4943 that did not pass the first analysis phase (i.e. may not be countable, or
4944 may have complicated control-flow).
4945 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4946 For @var{n}=7, all the information the vectorizer generates during its
4947 analysis and transformation is reported.  This is the same verbosity level
4948 that @option{-fdump-tree-vect-details} uses.
4950 @item -frandom-seed=@var{string}
4951 @opindex frandom-string
4952 This option provides a seed that GCC uses when it would otherwise use
4953 random numbers.  It is used to generate certain symbol names
4954 that have to be different in every compiled file.  It is also used to
4955 place unique stamps in coverage data files and the object files that
4956 produce them.  You can use the @option{-frandom-seed} option to produce
4957 reproducibly identical object files.
4959 The @var{string} should be different for every file you compile.
4961 @item -fsched-verbose=@var{n}
4962 @opindex fsched-verbose
4963 On targets that use instruction scheduling, this option controls the
4964 amount of debugging output the scheduler prints.  This information is
4965 written to standard error, unless @option{-dS} or @option{-dR} is
4966 specified, in which case it is output to the usual dump
4967 listing file, @file{.sched} or @file{.sched2} respectively.  However
4968 for @var{n} greater than nine, the output is always printed to standard
4969 error.
4971 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4972 same information as @option{-dRS}.  For @var{n} greater than one, it
4973 also output basic block probabilities, detailed ready list information
4974 and unit/insn info.  For @var{n} greater than two, it includes RTL
4975 at abort point, control-flow and regions info.  And for @var{n} over
4976 four, @option{-fsched-verbose} also includes dependence info.
4978 @item -save-temps
4979 @opindex save-temps
4980 Store the usual ``temporary'' intermediate files permanently; place them
4981 in the current directory and name them based on the source file.  Thus,
4982 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4983 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4984 preprocessed @file{foo.i} output file even though the compiler now
4985 normally uses an integrated preprocessor.
4987 When used in combination with the @option{-x} command line option,
4988 @option{-save-temps} is sensible enough to avoid over writing an
4989 input source file with the same extension as an intermediate file.
4990 The corresponding intermediate file may be obtained by renaming the
4991 source file before using @option{-save-temps}.
4993 @item -time
4994 @opindex time
4995 Report the CPU time taken by each subprocess in the compilation
4996 sequence.  For C source files, this is the compiler proper and assembler
4997 (plus the linker if linking is done).  The output looks like this:
4999 @smallexample
5000 # cc1 0.12 0.01
5001 # as 0.00 0.01
5002 @end smallexample
5004 The first number on each line is the ``user time'', that is time spent
5005 executing the program itself.  The second number is ``system time'',
5006 time spent executing operating system routines on behalf of the program.
5007 Both numbers are in seconds.
5009 @item -fvar-tracking
5010 @opindex fvar-tracking
5011 Run variable tracking pass.  It computes where variables are stored at each
5012 position in code.  Better debugging information is then generated
5013 (if the debugging information format supports this information).
5015 It is enabled by default when compiling with optimization (@option{-Os},
5016 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
5017 the debug info format supports it.
5019 @item -print-file-name=@var{library}
5020 @opindex print-file-name
5021 Print the full absolute name of the library file @var{library} that
5022 would be used when linking---and don't do anything else.  With this
5023 option, GCC does not compile or link anything; it just prints the
5024 file name.
5026 @item -print-multi-directory
5027 @opindex print-multi-directory
5028 Print the directory name corresponding to the multilib selected by any
5029 other switches present in the command line.  This directory is supposed
5030 to exist in @env{GCC_EXEC_PREFIX}.
5032 @item -print-multi-lib
5033 @opindex print-multi-lib
5034 Print the mapping from multilib directory names to compiler switches
5035 that enable them.  The directory name is separated from the switches by
5036 @samp{;}, and each switch starts with an @samp{@@} instead of the
5037 @samp{-}, without spaces between multiple switches.  This is supposed to
5038 ease shell-processing.
5040 @item -print-prog-name=@var{program}
5041 @opindex print-prog-name
5042 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5044 @item -print-libgcc-file-name
5045 @opindex print-libgcc-file-name
5046 Same as @option{-print-file-name=libgcc.a}.
5048 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5049 but you do want to link with @file{libgcc.a}.  You can do
5051 @smallexample
5052 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5053 @end smallexample
5055 @item -print-search-dirs
5056 @opindex print-search-dirs
5057 Print the name of the configured installation directory and a list of
5058 program and library directories @command{gcc} will search---and don't do anything else.
5060 This is useful when @command{gcc} prints the error message
5061 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5062 To resolve this you either need to put @file{cpp0} and the other compiler
5063 components where @command{gcc} expects to find them, or you can set the environment
5064 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5065 Don't forget the trailing @samp{/}.
5066 @xref{Environment Variables}.
5068 @item -print-sysroot-headers-suffix
5069 @opindex print-sysroot-headers-suffix
5070 Print the suffix added to the target sysroot when searching for
5071 headers, or give an error if the compiler is not configured with such
5072 a suffix---and don't do anything else.
5074 @item -dumpmachine
5075 @opindex dumpmachine
5076 Print the compiler's target machine (for example,
5077 @samp{i686-pc-linux-gnu})---and don't do anything else.
5079 @item -dumpversion
5080 @opindex dumpversion
5081 Print the compiler version (for example, @samp{3.0})---and don't do
5082 anything else.
5084 @item -dumpspecs
5085 @opindex dumpspecs
5086 Print the compiler's built-in specs---and don't do anything else.  (This
5087 is used when GCC itself is being built.)  @xref{Spec Files}.
5089 @item -feliminate-unused-debug-types
5090 @opindex feliminate-unused-debug-types
5091 Normally, when producing DWARF2 output, GCC will emit debugging
5092 information for all types declared in a compilation
5093 unit, regardless of whether or not they are actually used
5094 in that compilation unit.  Sometimes this is useful, such as
5095 if, in the debugger, you want to cast a value to a type that is
5096 not actually used in your program (but is declared).  More often,
5097 however, this results in a significant amount of wasted space.
5098 With this option, GCC will avoid producing debug symbol output
5099 for types that are nowhere used in the source file being compiled.
5100 @end table
5102 @node Optimize Options
5103 @section Options That Control Optimization
5104 @cindex optimize options
5105 @cindex options, optimization
5107 These options control various sorts of optimizations.
5109 Without any optimization option, the compiler's goal is to reduce the
5110 cost of compilation and to make debugging produce the expected
5111 results.  Statements are independent: if you stop the program with a
5112 breakpoint between statements, you can then assign a new value to any
5113 variable or change the program counter to any other statement in the
5114 function and get exactly the results you would expect from the source
5115 code.
5117 Turning on optimization flags makes the compiler attempt to improve
5118 the performance and/or code size at the expense of compilation time
5119 and possibly the ability to debug the program.
5121 The compiler performs optimization based on the knowledge it has of
5122 the program.  Optimization levels @option{-O} and above, in
5123 particular, enable @emph{unit-at-a-time} mode, which allows the
5124 compiler to consider information gained from later functions in
5125 the file when compiling a function.  Compiling multiple files at
5126 once to a single output file in @emph{unit-at-a-time} mode allows
5127 the compiler to use information gained from all of the files when
5128 compiling each of them.
5130 Not all optimizations are controlled directly by a flag.  Only
5131 optimizations that have a flag are listed.
5133 @table @gcctabopt
5134 @item -O
5135 @itemx -O1
5136 @opindex O
5137 @opindex O1
5138 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5139 more memory for a large function.
5141 With @option{-O}, the compiler tries to reduce code size and execution
5142 time, without performing any optimizations that take a great deal of
5143 compilation time.
5145 @option{-O} turns on the following optimization flags:
5146 @gccoptlist{
5147 -fauto-inc-dec @gol
5148 -fcprop-registers @gol
5149 -fdce @gol
5150 -fdefer-pop @gol
5151 -fdelayed-branch @gol
5152 -fdse @gol
5153 -fguess-branch-probability @gol
5154 -fif-conversion2 @gol
5155 -fif-conversion @gol
5156 -finline-small-functions @gol
5157 -fipa-pure-const @gol
5158 -fipa-reference @gol
5159 -fmerge-constants
5160 -fsplit-wide-types @gol
5161 -ftree-ccp @gol
5162 -ftree-ch @gol
5163 -ftree-copyrename @gol
5164 -ftree-dce @gol
5165 -ftree-dominator-opts @gol
5166 -ftree-dse @gol
5167 -ftree-fre @gol
5168 -ftree-sra @gol
5169 -ftree-ter @gol
5170 -funit-at-a-time}
5172 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5173 where doing so does not interfere with debugging.
5175 @item -O2
5176 @opindex O2
5177 Optimize even more.  GCC performs nearly all supported optimizations
5178 that do not involve a space-speed tradeoff.  The compiler does not
5179 perform loop unrolling or function inlining when you specify @option{-O2}.
5180 As compared to @option{-O}, this option increases both compilation time
5181 and the performance of the generated code.
5183 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5184 also turns on the following optimization flags:
5185 @gccoptlist{-fthread-jumps @gol
5186 -falign-functions  -falign-jumps @gol
5187 -falign-loops  -falign-labels @gol
5188 -fcaller-saves @gol
5189 -fcrossjumping @gol
5190 -fcse-follow-jumps  -fcse-skip-blocks @gol
5191 -fdelete-null-pointer-checks @gol
5192 -fexpensive-optimizations @gol
5193 -fgcse  -fgcse-lm  @gol
5194 -foptimize-sibling-calls @gol
5195 -fpeephole2 @gol
5196 -fregmove @gol
5197 -freorder-blocks  -freorder-functions @gol
5198 -frerun-cse-after-loop  @gol
5199 -fsched-interblock  -fsched-spec @gol
5200 -fschedule-insns  -fschedule-insns2 @gol
5201 -fstrict-aliasing -fstrict-overflow @gol
5202 -ftree-pre @gol
5203 -ftree-vrp}
5205 Please note the warning under @option{-fgcse} about
5206 invoking @option{-O2} on programs that use computed gotos.
5208 @item -O3
5209 @opindex O3
5210 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5211 @option{-O2} and also turns on the @option{-finline-functions},
5212 @option{-funswitch-loops}, @option{-fpredictive-commoning} and
5213 @option{-fgcse-after-reload} options.
5215 @item -O0
5216 @opindex O0
5217 Reduce compilation time and make debugging produce the expected
5218 results.  This is the default.
5220 @item -Os
5221 @opindex Os
5222 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5223 do not typically increase code size.  It also performs further
5224 optimizations designed to reduce code size.
5226 @option{-Os} disables the following optimization flags:
5227 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5228 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5229 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5231 If you use multiple @option{-O} options, with or without level numbers,
5232 the last such option is the one that is effective.
5233 @end table
5235 Options of the form @option{-f@var{flag}} specify machine-independent
5236 flags.  Most flags have both positive and negative forms; the negative
5237 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5238 below, only one of the forms is listed---the one you typically will
5239 use.  You can figure out the other form by either removing @samp{no-}
5240 or adding it.
5242 The following options control specific optimizations.  They are either
5243 activated by @option{-O} options or are related to ones that are.  You
5244 can use the following flags in the rare cases when ``fine-tuning'' of
5245 optimizations to be performed is desired.
5247 @table @gcctabopt
5248 @item -fno-default-inline
5249 @opindex fno-default-inline
5250 Do not make member functions inline by default merely because they are
5251 defined inside the class scope (C++ only).  Otherwise, when you specify
5252 @w{@option{-O}}, member functions defined inside class scope are compiled
5253 inline by default; i.e., you don't need to add @samp{inline} in front of
5254 the member function name.
5256 @item -fno-defer-pop
5257 @opindex fno-defer-pop
5258 Always pop the arguments to each function call as soon as that function
5259 returns.  For machines which must pop arguments after a function call,
5260 the compiler normally lets arguments accumulate on the stack for several
5261 function calls and pops them all at once.
5263 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5265 @item -fforward-propagate
5266 @opindex fforward-propagate
5267 Perform a forward propagation pass on RTL.  The pass tries to combine two
5268 instructions and checks if the result can be simplified.  If loop unrolling
5269 is active, two passes are performed and the second is scheduled after
5270 loop unrolling.
5272 This option is enabled by default at optimization levels @option{-O2},
5273 @option{-O3}, @option{-Os}.
5275 @item -fomit-frame-pointer
5276 @opindex fomit-frame-pointer
5277 Don't keep the frame pointer in a register for functions that
5278 don't need one.  This avoids the instructions to save, set up and
5279 restore frame pointers; it also makes an extra register available
5280 in many functions.  @strong{It also makes debugging impossible on
5281 some machines.}
5283 On some machines, such as the VAX, this flag has no effect, because
5284 the standard calling sequence automatically handles the frame pointer
5285 and nothing is saved by pretending it doesn't exist.  The
5286 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5287 whether a target machine supports this flag.  @xref{Registers,,Register
5288 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5290 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5292 @item -foptimize-sibling-calls
5293 @opindex foptimize-sibling-calls
5294 Optimize sibling and tail recursive calls.
5296 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5298 @item -fno-inline
5299 @opindex fno-inline
5300 Don't pay attention to the @code{inline} keyword.  Normally this option
5301 is used to keep the compiler from expanding any functions inline.
5302 Note that if you are not optimizing, no functions can be expanded inline.
5304 @item -finline-small-functions
5305 @opindex finline-small-functions
5306 Integrate functions into their callers when their body is smaller than expected
5307 function call code (so overall size of program gets smaller).  The compiler
5308 heuristically decides which functions are simple enough to be worth integrating
5309 in this way.
5311 Enabled at level @option{-O2}.
5313 @item -finline-functions
5314 @opindex finline-functions
5315 Integrate all simple functions into their callers.  The compiler
5316 heuristically decides which functions are simple enough to be worth
5317 integrating in this way.
5319 If all calls to a given function are integrated, and the function is
5320 declared @code{static}, then the function is normally not output as
5321 assembler code in its own right.
5323 Enabled at level @option{-O3}.
5325 @item -finline-functions-called-once
5326 @opindex finline-functions-called-once
5327 Consider all @code{static} functions called once for inlining into their
5328 caller even if they are not marked @code{inline}.  If a call to a given
5329 function is integrated, then the function is not output as assembler code
5330 in its own right.
5332 Enabled if @option{-funit-at-a-time} is enabled.
5334 @item -fearly-inlining
5335 @opindex fearly-inlining
5336 Inline functions marked by @code{always_inline} and functions whose body seems
5337 smaller than the function call overhead early before doing
5338 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5339 makes profiling significantly cheaper and usually inlining faster on programs
5340 having large chains of nested wrapper functions.
5342 Enabled by default.
5344 @item -finline-limit=@var{n}
5345 @opindex finline-limit
5346 By default, GCC limits the size of functions that can be inlined.  This flag
5347 allows coarse control of this limit.  @var{n} is the size of functions that
5348 can be inlined in number of pseudo instructions.
5350 Inlining is actually controlled by a number of parameters, which may be
5351 specified individually by using @option{--param @var{name}=@var{value}}.
5352 The @option{-finline-limit=@var{n}} option sets some of these parameters
5353 as follows:
5355 @table @gcctabopt
5356 @item max-inline-insns-single
5357  is set to @var{n}/2.
5358 @item max-inline-insns-auto
5359  is set to @var{n}/2.
5360 @end table
5362 See below for a documentation of the individual
5363 parameters controlling inlining and for the defaults of these parameters.
5365 @emph{Note:} there may be no value to @option{-finline-limit} that results
5366 in default behavior.
5368 @emph{Note:} pseudo instruction represents, in this particular context, an
5369 abstract measurement of function's size.  In no way does it represent a count
5370 of assembly instructions and as such its exact meaning might change from one
5371 release to an another.
5373 @item -fkeep-inline-functions
5374 @opindex fkeep-inline-functions
5375 In C, emit @code{static} functions that are declared @code{inline}
5376 into the object file, even if the function has been inlined into all
5377 of its callers.  This switch does not affect functions using the
5378 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5379 inline functions into the object file.
5381 @item -fkeep-static-consts
5382 @opindex fkeep-static-consts
5383 Emit variables declared @code{static const} when optimization isn't turned
5384 on, even if the variables aren't referenced.
5386 GCC enables this option by default.  If you want to force the compiler to
5387 check if the variable was referenced, regardless of whether or not
5388 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5390 @item -fmerge-constants
5391 @opindex fmerge-constants
5392 Attempt to merge identical constants (string constants and floating point
5393 constants) across compilation units.
5395 This option is the default for optimized compilation if the assembler and
5396 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5397 behavior.
5399 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5401 @item -fmerge-all-constants
5402 @opindex fmerge-all-constants
5403 Attempt to merge identical constants and identical variables.
5405 This option implies @option{-fmerge-constants}.  In addition to
5406 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5407 arrays or initialized constant variables with integral or floating point
5408 types.  Languages like C or C++ require each non-automatic variable to
5409 have distinct location, so using this option will result in non-conforming
5410 behavior.
5412 @item -fmodulo-sched
5413 @opindex fmodulo-sched
5414 Perform swing modulo scheduling immediately before the first scheduling
5415 pass.  This pass looks at innermost loops and reorders their
5416 instructions by overlapping different iterations.
5418 @item -fmodulo-sched-allow-regmoves
5419 @opindex fmodulo-sched-allow-regmoves
5420 Perform more aggressive SMS based modulo scheduling with register moves
5421 allowed.  By setting this flag certain anti-dependences edges will be
5422 deleted which will trigger the generation of reg-moves based on the
5423 life-range analysis.  This option is effective only with
5424 @option{-fmodulo-sched} enabled.
5426 @item -fno-branch-count-reg
5427 @opindex fno-branch-count-reg
5428 Do not use ``decrement and branch'' instructions on a count register,
5429 but instead generate a sequence of instructions that decrement a
5430 register, compare it against zero, then branch based upon the result.
5431 This option is only meaningful on architectures that support such
5432 instructions, which include x86, PowerPC, IA-64 and S/390.
5434 The default is @option{-fbranch-count-reg}.
5436 @item -fno-function-cse
5437 @opindex fno-function-cse
5438 Do not put function addresses in registers; make each instruction that
5439 calls a constant function contain the function's address explicitly.
5441 This option results in less efficient code, but some strange hacks
5442 that alter the assembler output may be confused by the optimizations
5443 performed when this option is not used.
5445 The default is @option{-ffunction-cse}
5447 @item -fno-zero-initialized-in-bss
5448 @opindex fno-zero-initialized-in-bss
5449 If the target supports a BSS section, GCC by default puts variables that
5450 are initialized to zero into BSS@.  This can save space in the resulting
5451 code.
5453 This option turns off this behavior because some programs explicitly
5454 rely on variables going to the data section.  E.g., so that the
5455 resulting executable can find the beginning of that section and/or make
5456 assumptions based on that.
5458 The default is @option{-fzero-initialized-in-bss}.
5460 @item -fmudflap -fmudflapth -fmudflapir
5461 @opindex fmudflap
5462 @opindex fmudflapth
5463 @opindex fmudflapir
5464 @cindex bounds checking
5465 @cindex mudflap
5466 For front-ends that support it (C and C++), instrument all risky
5467 pointer/array dereferencing operations, some standard library
5468 string/heap functions, and some other associated constructs with
5469 range/validity tests.  Modules so instrumented should be immune to
5470 buffer overflows, invalid heap use, and some other classes of C/C++
5471 programming errors.  The instrumentation relies on a separate runtime
5472 library (@file{libmudflap}), which will be linked into a program if
5473 @option{-fmudflap} is given at link time.  Run-time behavior of the
5474 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5475 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5476 for its options.
5478 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5479 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5480 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5481 instrumentation should ignore pointer reads.  This produces less
5482 instrumentation (and therefore faster execution) and still provides
5483 some protection against outright memory corrupting writes, but allows
5484 erroneously read data to propagate within a program.
5486 @item -fthread-jumps
5487 @opindex fthread-jumps
5488 Perform optimizations where we check to see if a jump branches to a
5489 location where another comparison subsumed by the first is found.  If
5490 so, the first branch is redirected to either the destination of the
5491 second branch or a point immediately following it, depending on whether
5492 the condition is known to be true or false.
5494 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5496 @item -fsplit-wide-types
5497 @opindex fsplit-wide-types
5498 When using a type that occupies multiple registers, such as @code{long
5499 long} on a 32-bit system, split the registers apart and allocate them
5500 independently.  This normally generates better code for those types,
5501 but may make debugging more difficult.
5503 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5504 @option{-Os}.
5506 @item -fcse-follow-jumps
5507 @opindex fcse-follow-jumps
5508 In common subexpression elimination (CSE), scan through jump instructions
5509 when the target of the jump is not reached by any other path.  For
5510 example, when CSE encounters an @code{if} statement with an
5511 @code{else} clause, CSE will follow the jump when the condition
5512 tested is false.
5514 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5516 @item -fcse-skip-blocks
5517 @opindex fcse-skip-blocks
5518 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5519 follow jumps which conditionally skip over blocks.  When CSE
5520 encounters a simple @code{if} statement with no else clause,
5521 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5522 body of the @code{if}.
5524 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5526 @item -frerun-cse-after-loop
5527 @opindex frerun-cse-after-loop
5528 Re-run common subexpression elimination after loop optimizations has been
5529 performed.
5531 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5533 @item -fgcse
5534 @opindex fgcse
5535 Perform a global common subexpression elimination pass.
5536 This pass also performs global constant and copy propagation.
5538 @emph{Note:} When compiling a program using computed gotos, a GCC
5539 extension, you may get better runtime performance if you disable
5540 the global common subexpression elimination pass by adding
5541 @option{-fno-gcse} to the command line.
5543 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5545 @item -fgcse-lm
5546 @opindex fgcse-lm
5547 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5548 attempt to move loads which are only killed by stores into themselves.  This
5549 allows a loop containing a load/store sequence to be changed to a load outside
5550 the loop, and a copy/store within the loop.
5552 Enabled by default when gcse is enabled.
5554 @item -fgcse-sm
5555 @opindex fgcse-sm
5556 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5557 global common subexpression elimination.  This pass will attempt to move
5558 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5559 loops containing a load/store sequence can be changed to a load before
5560 the loop and a store after the loop.
5562 Not enabled at any optimization level.
5564 @item -fgcse-las
5565 @opindex fgcse-las
5566 When @option{-fgcse-las} is enabled, the global common subexpression
5567 elimination pass eliminates redundant loads that come after stores to the
5568 same memory location (both partial and full redundancies).
5570 Not enabled at any optimization level.
5572 @item -fgcse-after-reload
5573 @opindex fgcse-after-reload
5574 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5575 pass is performed after reload.  The purpose of this pass is to cleanup
5576 redundant spilling.
5578 @item -funsafe-loop-optimizations
5579 @opindex funsafe-loop-optimizations
5580 If given, the loop optimizer will assume that loop indices do not
5581 overflow, and that the loops with nontrivial exit condition are not
5582 infinite.  This enables a wider range of loop optimizations even if
5583 the loop optimizer itself cannot prove that these assumptions are valid.
5584 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5585 if it finds this kind of loop.
5587 @item -fcrossjumping
5588 @opindex fcrossjumping
5589 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5590 resulting code may or may not perform better than without cross-jumping.
5592 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5594 @item -fauto-inc-dec
5595 @opindex fauto-inc-dec
5596 Combine increments or decrements of addresses with memory accesses.
5597 This pass is always skipped on architectures that do not have
5598 instructions to support this.  Enabled by default at @option{-O} and
5599 higher on architectures that support this.
5601 @item -fdce
5602 @opindex fdce
5603 Perform dead code elimination (DCE) on RTL.
5604 Enabled by default at @option{-O} and higher.
5606 @item -fdse
5607 @opindex fdse
5608 Perform dead store elimination (DSE) on RTL.
5609 Enabled by default at @option{-O} and higher.
5611 @item -fif-conversion
5612 @opindex fif-conversion
5613 Attempt to transform conditional jumps into branch-less equivalents.  This
5614 include use of conditional moves, min, max, set flags and abs instructions, and
5615 some tricks doable by standard arithmetics.  The use of conditional execution
5616 on chips where it is available is controlled by @code{if-conversion2}.
5618 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5620 @item -fif-conversion2
5621 @opindex fif-conversion2
5622 Use conditional execution (where available) to transform conditional jumps into
5623 branch-less equivalents.
5625 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5627 @item -fdelete-null-pointer-checks
5628 @opindex fdelete-null-pointer-checks
5629 Use global dataflow analysis to identify and eliminate useless checks
5630 for null pointers.  The compiler assumes that dereferencing a null
5631 pointer would have halted the program.  If a pointer is checked after
5632 it has already been dereferenced, it cannot be null.
5634 In some environments, this assumption is not true, and programs can
5635 safely dereference null pointers.  Use
5636 @option{-fno-delete-null-pointer-checks} to disable this optimization
5637 for programs which depend on that behavior.
5639 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5641 @item -fexpensive-optimizations
5642 @opindex fexpensive-optimizations
5643 Perform a number of minor optimizations that are relatively expensive.
5645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5647 @item -foptimize-register-move
5648 @itemx -fregmove
5649 @opindex foptimize-register-move
5650 @opindex fregmove
5651 Attempt to reassign register numbers in move instructions and as
5652 operands of other simple instructions in order to maximize the amount of
5653 register tying.  This is especially helpful on machines with two-operand
5654 instructions.
5656 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5657 optimization.
5659 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5661 @item -fira
5662 @opindex fira
5663 If supported for the target machine, use the integrated register
5664 allocator (@acronym{IRA}) for the register allocation.
5666 @item -fira-algorithm=@var{algorithm}
5667 Use specified algorithm for the integrated register allocator.  The
5668 @var{algorithm} argument should be one of @code{regional}, @code{CB},
5669 or @code{mixed}.  The second algorithm specifies Chaitin-Briggs
5670 coloring, the first one specifies regional coloring based on
5671 Chaitin-Briggs coloring, and the third one which is the default
5672 specifies a mix of Chaitin-Briggs and regional algorithms where loops
5673 with small register pressure are ignored.  The first algorithm can
5674 give best result for machines with small size and irregular register
5675 set, the second one is faster and generates decent code and the
5676 smallest size code, and the mixed algorithm usually give the best
5677 results in most cases and for most architectures.
5679 @item -fira-coalescing
5680 @opindex fira-coalescing
5681 Do optimistic register coalescing.  This option might be profitable for
5682 architectures with big regular register files.
5684 @item -fira-ipra
5685 @opindex fira-ipra
5686 Switch on a simple form of inter-procedural register allocation when
5687 the integrated register allocator (@acronym{IRA}) is used.
5689 @item -fira-propagate-cost
5690 @opindex -fira-propagate-cost
5691 This is an experimental option used to propagate hard reg costs down
5692 to nested regions for regional or mixed ira allocation algorithm.
5694 @item -fno-ira-move-spills
5695 @opindex fno-ira-move-spills
5696 Switch off increasing gap between the corresponding save and restore
5697 insns.  All saves and the corresponding restores of call used hard
5698 registers living through a call will be in the same basic block.
5700 @item -fno-ira-share-save-slots
5701 @opindex fno-ira-share-save-slots
5702 Switch off sharing stack slots used for saving call used hard
5703 registers living through a call.  Each hard register will get a
5704 separate stack slot and as a result function stack frame will be
5705 bigger.
5707 @item -fno-ira-share-spill-slots
5708 @opindex fno-ira-share-spill-slots
5709 Switch off sharing stack slots allocated for pseudo-registers.  Each
5710 pseudo-register which did not get a hard register will get a separate
5711 stack slot and as a result function stack frame will be bigger.
5713 @item -fira-verbose=@var{n}
5714 @opindex fira-verbose
5715 Set up how verbose dump file for the integrated register allocator
5716 will be.  Default value is 5.  If the value is greater or equal to 10,
5717 the dump file will be stderr as if the value were @var{n} minus 10.
5719 @item -fdelayed-branch
5720 @opindex fdelayed-branch
5721 If supported for the target machine, attempt to reorder instructions
5722 to exploit instruction slots available after delayed branch
5723 instructions.
5725 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5727 @item -fschedule-insns
5728 @opindex fschedule-insns
5729 If supported for the target machine, attempt to reorder instructions to
5730 eliminate execution stalls due to required data being unavailable.  This
5731 helps machines that have slow floating point or memory load instructions
5732 by allowing other instructions to be issued until the result of the load
5733 or floating point instruction is required.
5735 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5737 @item -fschedule-insns2
5738 @opindex fschedule-insns2
5739 Similar to @option{-fschedule-insns}, but requests an additional pass of
5740 instruction scheduling after register allocation has been done.  This is
5741 especially useful on machines with a relatively small number of
5742 registers and where memory load instructions take more than one cycle.
5744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5746 @item -fno-sched-interblock
5747 @opindex fno-sched-interblock
5748 Don't schedule instructions across basic blocks.  This is normally
5749 enabled by default when scheduling before register allocation, i.e.@:
5750 with @option{-fschedule-insns} or at @option{-O2} or higher.
5752 @item -fno-sched-spec
5753 @opindex fno-sched-spec
5754 Don't allow speculative motion of non-load instructions.  This is normally
5755 enabled by default when scheduling before register allocation, i.e.@:
5756 with @option{-fschedule-insns} or at @option{-O2} or higher.
5758 @item -fsched-spec-load
5759 @opindex fsched-spec-load
5760 Allow speculative motion of some load instructions.  This only makes
5761 sense when scheduling before register allocation, i.e.@: with
5762 @option{-fschedule-insns} or at @option{-O2} or higher.
5764 @item -fsched-spec-load-dangerous
5765 @opindex fsched-spec-load-dangerous
5766 Allow speculative motion of more load instructions.  This only makes
5767 sense when scheduling before register allocation, i.e.@: with
5768 @option{-fschedule-insns} or at @option{-O2} or higher.
5770 @item -fsched-stalled-insns
5771 @itemx -fsched-stalled-insns=@var{n}
5772 @opindex fsched-stalled-insns
5773 Define how many insns (if any) can be moved prematurely from the queue
5774 of stalled insns into the ready list, during the second scheduling pass.
5775 @option{-fno-sched-stalled-insns} means that no insns will be moved
5776 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5777 on how many queued insns can be moved prematurely.
5778 @option{-fsched-stalled-insns} without a value is equivalent to
5779 @option{-fsched-stalled-insns=1}.
5781 @item -fsched-stalled-insns-dep
5782 @itemx -fsched-stalled-insns-dep=@var{n}
5783 @opindex fsched-stalled-insns-dep
5784 Define how many insn groups (cycles) will be examined for a dependency
5785 on a stalled insn that is candidate for premature removal from the queue
5786 of stalled insns.  This has an effect only during the second scheduling pass,
5787 and only if @option{-fsched-stalled-insns} is used.
5788 @option{-fno-sched-stalled-insns-dep} is equivalent to
5789 @option{-fsched-stalled-insns-dep=0}.
5790 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5791 @option{-fsched-stalled-insns-dep=1}.
5793 @item -fsched2-use-superblocks
5794 @opindex fsched2-use-superblocks
5795 When scheduling after register allocation, do use superblock scheduling
5796 algorithm.  Superblock scheduling allows motion across basic block boundaries
5797 resulting on faster schedules.  This option is experimental, as not all machine
5798 descriptions used by GCC model the CPU closely enough to avoid unreliable
5799 results from the algorithm.
5801 This only makes sense when scheduling after register allocation, i.e.@: with
5802 @option{-fschedule-insns2} or at @option{-O2} or higher.
5804 @item -fsched2-use-traces
5805 @opindex fsched2-use-traces
5806 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5807 allocation and additionally perform code duplication in order to increase the
5808 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5809 trace formation.
5811 This mode should produce faster but significantly longer programs.  Also
5812 without @option{-fbranch-probabilities} the traces constructed may not
5813 match the reality and hurt the performance.  This only makes
5814 sense when scheduling after register allocation, i.e.@: with
5815 @option{-fschedule-insns2} or at @option{-O2} or higher.
5817 @item -fsee
5818 @opindex fsee
5819 Eliminate redundant sign extension instructions and move the non-redundant
5820 ones to optimal placement using lazy code motion (LCM).
5822 @item -freschedule-modulo-scheduled-loops
5823 @opindex freschedule-modulo-scheduled-loops
5824 The modulo scheduling comes before the traditional scheduling, if a loop
5825 was modulo scheduled we may want to prevent the later scheduling passes
5826 from changing its schedule, we use this option to control that.
5828 @item -fcaller-saves
5829 @opindex fcaller-saves
5830 Enable values to be allocated in registers that will be clobbered by
5831 function calls, by emitting extra instructions to save and restore the
5832 registers around such calls.  Such allocation is done only when it
5833 seems to result in better code than would otherwise be produced.
5835 This option is always enabled by default on certain machines, usually
5836 those which have no call-preserved registers to use instead.
5838 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5840 @item -ftree-reassoc
5841 @opindex ftree-reassoc
5842 Perform reassociation on trees.  This flag is enabled by default
5843 at @option{-O} and higher.
5845 @item -ftree-pre
5846 @opindex ftree-pre
5847 Perform partial redundancy elimination (PRE) on trees.  This flag is
5848 enabled by default at @option{-O2} and @option{-O3}.
5850 @item -ftree-fre
5851 @opindex ftree-fre
5852 Perform full redundancy elimination (FRE) on trees.  The difference
5853 between FRE and PRE is that FRE only considers expressions
5854 that are computed on all paths leading to the redundant computation.
5855 This analysis is faster than PRE, though it exposes fewer redundancies.
5856 This flag is enabled by default at @option{-O} and higher.
5858 @item -ftree-copy-prop
5859 @opindex ftree-copy-prop
5860 Perform copy propagation on trees.  This pass eliminates unnecessary
5861 copy operations.  This flag is enabled by default at @option{-O} and
5862 higher.
5864 @item -ftree-salias
5865 @opindex ftree-salias
5866 Perform structural alias analysis on trees.  This flag
5867 is enabled by default at @option{-O} and higher.
5869 @item -fipa-pure-const
5870 @opindex fipa-pure-const
5871 Discover which functions are pure or constant.
5872 Enabled by default at @option{-O} and higher.
5874 @item -fipa-reference
5875 @opindex fipa-reference
5876 Discover which static variables do not escape cannot escape the
5877 compilation unit.
5878 Enabled by default at @option{-O} and higher.
5880 @item -fipa-struct-reorg
5881 @opindex fipa-struct-reorg
5882 Perform structure reorganization optimization, that change C-like structures 
5883 layout in order to better utilize spatial locality.  This transformation is 
5884 affective for programs containing arrays of structures.  Available in two 
5885 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5886 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5887 to provide the safety of this transformation.  It works only in whole program
5888 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5889 enabled.  Structures considered @samp{cold} by this transformation are not
5890 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5892 With this flag, the program debug info reflects a new structure layout.
5894 @item -fipa-pta
5895 @opindex fipa-pta
5896 Perform interprocedural pointer analysis.
5898 @item -fipa-cp
5899 @opindex fipa-cp
5900 Perform interprocedural constant propagation.
5901 This optimization analyzes the program to determine when values passed
5902 to functions are constants and then optimizes accordingly.  
5903 This optimization can substantially increase performance
5904 if the application has constants passed to functions, but
5905 because this optimization can create multiple copies of functions,
5906 it may significantly increase code size.
5908 @item -fipa-matrix-reorg
5909 @opindex fipa-matrix-reorg
5910 Perform matrix flattening and transposing.
5911 Matrix flattening tries to replace a m-dimensional matrix 
5912 with its equivalent n-dimensional matrix, where n < m.
5913 This reduces the level of indirection needed for accessing the elements
5914 of the matrix. The second optimization is matrix transposing that
5915 attemps to change the order of the matrix's dimensions in order to 
5916 improve cache locality.
5917 Both optimizations need fwhole-program flag. 
5918 Transposing is enabled only if profiling information is avaliable.
5921 @item -ftree-sink
5922 @opindex ftree-sink
5923 Perform forward store motion  on trees.  This flag is
5924 enabled by default at @option{-O} and higher.
5926 @item -ftree-ccp
5927 @opindex ftree-ccp
5928 Perform sparse conditional constant propagation (CCP) on trees.  This
5929 pass only operates on local scalar variables and is enabled by default
5930 at @option{-O} and higher.
5932 @item -ftree-store-ccp
5933 @opindex ftree-store-ccp
5934 Perform sparse conditional constant propagation (CCP) on trees.  This
5935 pass operates on both local scalar variables and memory stores and
5936 loads (global variables, structures, arrays, etc).  This flag is
5937 enabled by default at @option{-O2} and higher.
5939 @item -ftree-dce
5940 @opindex ftree-dce
5941 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5942 default at @option{-O} and higher.
5944 @item -ftree-dominator-opts
5945 @opindex ftree-dominator-opts
5946 Perform a variety of simple scalar cleanups (constant/copy
5947 propagation, redundancy elimination, range propagation and expression
5948 simplification) based on a dominator tree traversal.  This also
5949 performs jump threading (to reduce jumps to jumps). This flag is
5950 enabled by default at @option{-O} and higher.
5952 @item -ftree-dse
5953 @opindex ftree-dse
5954 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5955 a memory location which will later be overwritten by another store without
5956 any intervening loads.  In this case the earlier store can be deleted.  This
5957 flag is enabled by default at @option{-O} and higher.
5959 @item -ftree-ch
5960 @opindex ftree-ch
5961 Perform loop header copying on trees.  This is beneficial since it increases
5962 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5963 is enabled by default at @option{-O} and higher.  It is not enabled
5964 for @option{-Os}, since it usually increases code size.
5966 @item -ftree-loop-optimize
5967 @opindex ftree-loop-optimize
5968 Perform loop optimizations on trees.  This flag is enabled by default
5969 at @option{-O} and higher.
5971 @item -ftree-loop-linear
5972 @opindex ftree-loop-linear
5973 Perform linear loop transformations on tree.  This flag can improve cache
5974 performance and allow further loop optimizations to take place.
5976 @item -fcheck-data-deps
5977 @opindex fcheck-data-deps
5978 Compare the results of several data dependence analyzers.  This option
5979 is used for debugging the data dependence analyzers.
5981 @item -ftree-loop-im
5982 @opindex ftree-loop-im
5983 Perform loop invariant motion on trees.  This pass moves only invariants that
5984 would be hard to handle at RTL level (function calls, operations that expand to
5985 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5986 operands of conditions that are invariant out of the loop, so that we can use
5987 just trivial invariantness analysis in loop unswitching.  The pass also includes
5988 store motion.
5990 @item -ftree-loop-ivcanon
5991 @opindex ftree-loop-ivcanon
5992 Create a canonical counter for number of iterations in the loop for that
5993 determining number of iterations requires complicated analysis.  Later
5994 optimizations then may determine the number easily.  Useful especially
5995 in connection with unrolling.
5997 @item -fivopts
5998 @opindex fivopts
5999 Perform induction variable optimizations (strength reduction, induction
6000 variable merging and induction variable elimination) on trees.
6002 @item -ftree-parallelize-loops=n
6003 @opindex ftree-parallelize-loops
6004 Parallelize loops, i.e., split their iteration space to run in n threads.
6005 This is only possible for loops whose iterations are independent
6006 and can be arbitrarily reordered.  The optimization is only
6007 profitable on multiprocessor machines, for loops that are CPU-intensive,
6008 rather than constrained e.g. by memory bandwidth.  This option
6009 implies @option{-pthread}, and thus is only supported on targets
6010 that have support for @option{-pthread}.
6012 @item -ftree-sra
6013 @opindex ftree-sra
6014 Perform scalar replacement of aggregates.  This pass replaces structure
6015 references with scalars to prevent committing structures to memory too
6016 early.  This flag is enabled by default at @option{-O} and higher.
6018 @item -ftree-copyrename
6019 @opindex ftree-copyrename
6020 Perform copy renaming on trees.  This pass attempts to rename compiler
6021 temporaries to other variables at copy locations, usually resulting in
6022 variable names which more closely resemble the original variables.  This flag
6023 is enabled by default at @option{-O} and higher.
6025 @item -ftree-ter
6026 @opindex ftree-ter
6027 Perform temporary expression replacement during the SSA->normal phase.  Single
6028 use/single def temporaries are replaced at their use location with their
6029 defining expression.  This results in non-GIMPLE code, but gives the expanders
6030 much more complex trees to work on resulting in better RTL generation.  This is
6031 enabled by default at @option{-O} and higher.
6033 @item -ftree-vectorize
6034 @opindex ftree-vectorize
6035 Perform loop vectorization on trees.
6037 @item -ftree-vect-loop-version
6038 @opindex ftree-vect-loop-version
6039 Perform loop versioning when doing loop vectorization on trees.  When a loop
6040 appears to be vectorizable except that data alignment or data dependence cannot
6041 be determined at compile time then vectorized and non-vectorized versions of
6042 the loop are generated along with runtime checks for alignment or dependence
6043 to control which version is executed.  This option is enabled by default
6044 except at level @option{-Os} where it is disabled.
6046 @item -fvect-cost-model
6047 @opindex fvect-cost-model
6048 Enable cost model for vectorization.
6050 @item -ftree-vrp
6051 @opindex ftree-vrp
6052 Perform Value Range Propagation on trees.  This is similar to the
6053 constant propagation pass, but instead of values, ranges of values are
6054 propagated.  This allows the optimizers to remove unnecessary range
6055 checks like array bound checks and null pointer checks.  This is
6056 enabled by default at @option{-O2} and higher.  Null pointer check
6057 elimination is only done if @option{-fdelete-null-pointer-checks} is
6058 enabled.
6060 @item -ftracer
6061 @opindex ftracer
6062 Perform tail duplication to enlarge superblock size.  This transformation
6063 simplifies the control flow of the function allowing other optimizations to do
6064 better job.
6066 @item -funroll-loops
6067 @opindex funroll-loops
6068 Unroll loops whose number of iterations can be determined at compile
6069 time or upon entry to the loop.  @option{-funroll-loops} implies
6070 @option{-frerun-cse-after-loop}.  This option makes code larger,
6071 and may or may not make it run faster.
6073 @item -funroll-all-loops
6074 @opindex funroll-all-loops
6075 Unroll all loops, even if their number of iterations is uncertain when
6076 the loop is entered.  This usually makes programs run more slowly.
6077 @option{-funroll-all-loops} implies the same options as
6078 @option{-funroll-loops},
6080 @item -fsplit-ivs-in-unroller
6081 @opindex fsplit-ivs-in-unroller
6082 Enables expressing of values of induction variables in later iterations
6083 of the unrolled loop using the value in the first iteration.  This breaks
6084 long dependency chains, thus improving efficiency of the scheduling passes.
6086 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6087 same effect.  However in cases the loop body is more complicated than
6088 a single basic block, this is not reliable.  It also does not work at all
6089 on some of the architectures due to restrictions in the CSE pass.
6091 This optimization is enabled by default.
6093 @item -fvariable-expansion-in-unroller
6094 @opindex fvariable-expansion-in-unroller
6095 With this option, the compiler will create multiple copies of some
6096 local variables when unrolling a loop which can result in superior code.
6098 @item -fpredictive-commoning
6099 @opindex fpredictive-commoning
6100 Perform predictive commoning optimization, i.e., reusing computations
6101 (especially memory loads and stores) performed in previous
6102 iterations of loops.
6104 This option is enabled at level @option{-O3}.
6106 @item -fprefetch-loop-arrays
6107 @opindex fprefetch-loop-arrays
6108 If supported by the target machine, generate instructions to prefetch
6109 memory to improve the performance of loops that access large arrays.
6111 This option may generate better or worse code; results are highly
6112 dependent on the structure of loops within the source code.
6114 Disabled at level @option{-Os}.
6116 @item -fno-peephole
6117 @itemx -fno-peephole2
6118 @opindex fno-peephole
6119 @opindex fno-peephole2
6120 Disable any machine-specific peephole optimizations.  The difference
6121 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6122 are implemented in the compiler; some targets use one, some use the
6123 other, a few use both.
6125 @option{-fpeephole} is enabled by default.
6126 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6128 @item -fno-guess-branch-probability
6129 @opindex fno-guess-branch-probability
6130 Do not guess branch probabilities using heuristics.
6132 GCC will use heuristics to guess branch probabilities if they are
6133 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6134 heuristics are based on the control flow graph.  If some branch probabilities
6135 are specified by @samp{__builtin_expect}, then the heuristics will be
6136 used to guess branch probabilities for the rest of the control flow graph,
6137 taking the @samp{__builtin_expect} info into account.  The interactions
6138 between the heuristics and @samp{__builtin_expect} can be complex, and in
6139 some cases, it may be useful to disable the heuristics so that the effects
6140 of @samp{__builtin_expect} are easier to understand.
6142 The default is @option{-fguess-branch-probability} at levels
6143 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6145 @item -freorder-blocks
6146 @opindex freorder-blocks
6147 Reorder basic blocks in the compiled function in order to reduce number of
6148 taken branches and improve code locality.
6150 Enabled at levels @option{-O2}, @option{-O3}.
6152 @item -freorder-blocks-and-partition
6153 @opindex freorder-blocks-and-partition
6154 In addition to reordering basic blocks in the compiled function, in order
6155 to reduce number of taken branches, partitions hot and cold basic blocks
6156 into separate sections of the assembly and .o files, to improve
6157 paging and cache locality performance.
6159 This optimization is automatically turned off in the presence of
6160 exception handling, for linkonce sections, for functions with a user-defined
6161 section attribute and on any architecture that does not support named
6162 sections.
6164 @item -freorder-functions
6165 @opindex freorder-functions
6166 Reorder functions in the object file in order to
6167 improve code locality.  This is implemented by using special
6168 subsections @code{.text.hot} for most frequently executed functions and
6169 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6170 the linker so object file format must support named sections and linker must
6171 place them in a reasonable way.
6173 Also profile feedback must be available in to make this option effective.  See
6174 @option{-fprofile-arcs} for details.
6176 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6178 @item -fstrict-aliasing
6179 @opindex fstrict-aliasing
6180 Allows the compiler to assume the strictest aliasing rules applicable to
6181 the language being compiled.  For C (and C++), this activates
6182 optimizations based on the type of expressions.  In particular, an
6183 object of one type is assumed never to reside at the same address as an
6184 object of a different type, unless the types are almost the same.  For
6185 example, an @code{unsigned int} can alias an @code{int}, but not a
6186 @code{void*} or a @code{double}.  A character type may alias any other
6187 type.
6189 Pay special attention to code like this:
6190 @smallexample
6191 union a_union @{
6192   int i;
6193   double d;
6196 int f() @{
6197   a_union t;
6198   t.d = 3.0;
6199   return t.i;
6201 @end smallexample
6202 The practice of reading from a different union member than the one most
6203 recently written to (called ``type-punning'') is common.  Even with
6204 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6205 is accessed through the union type.  So, the code above will work as
6206 expected.  However, this code might not:
6207 @smallexample
6208 int f() @{
6209   a_union t;
6210   int* ip;
6211   t.d = 3.0;
6212   ip = &t.i;
6213   return *ip;
6215 @end smallexample
6217 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6219 @item -fstrict-overflow
6220 @opindex fstrict-overflow
6221 Allow the compiler to assume strict signed overflow rules, depending
6222 on the language being compiled.  For C (and C++) this means that
6223 overflow when doing arithmetic with signed numbers is undefined, which
6224 means that the compiler may assume that it will not happen.  This
6225 permits various optimizations.  For example, the compiler will assume
6226 that an expression like @code{i + 10 > i} will always be true for
6227 signed @code{i}.  This assumption is only valid if signed overflow is
6228 undefined, as the expression is false if @code{i + 10} overflows when
6229 using twos complement arithmetic.  When this option is in effect any
6230 attempt to determine whether an operation on signed numbers will
6231 overflow must be written carefully to not actually involve overflow.
6233 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6234 that signed overflow is fully defined: it wraps.  When
6235 @option{-fwrapv} is used, there is no difference between
6236 @option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
6237 @option{-fwrapv} certain types of overflow are permitted.  For
6238 example, if the compiler gets an overflow when doing arithmetic on
6239 constants, the overflowed value can still be used with
6240 @option{-fwrapv}, but not otherwise.
6242 The @option{-fstrict-overflow} option is enabled at levels
6243 @option{-O2}, @option{-O3}, @option{-Os}.
6245 @item -falign-functions
6246 @itemx -falign-functions=@var{n}
6247 @opindex falign-functions
6248 Align the start of functions to the next power-of-two greater than
6249 @var{n}, skipping up to @var{n} bytes.  For instance,
6250 @option{-falign-functions=32} aligns functions to the next 32-byte
6251 boundary, but @option{-falign-functions=24} would align to the next
6252 32-byte boundary only if this can be done by skipping 23 bytes or less.
6254 @option{-fno-align-functions} and @option{-falign-functions=1} are
6255 equivalent and mean that functions will not be aligned.
6257 Some assemblers only support this flag when @var{n} is a power of two;
6258 in that case, it is rounded up.
6260 If @var{n} is not specified or is zero, use a machine-dependent default.
6262 Enabled at levels @option{-O2}, @option{-O3}.
6264 @item -falign-labels
6265 @itemx -falign-labels=@var{n}
6266 @opindex falign-labels
6267 Align all branch targets to a power-of-two boundary, skipping up to
6268 @var{n} bytes like @option{-falign-functions}.  This option can easily
6269 make code slower, because it must insert dummy operations for when the
6270 branch target is reached in the usual flow of the code.
6272 @option{-fno-align-labels} and @option{-falign-labels=1} are
6273 equivalent and mean that labels will not be aligned.
6275 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6276 are greater than this value, then their values are used instead.
6278 If @var{n} is not specified or is zero, use a machine-dependent default
6279 which is very likely to be @samp{1}, meaning no alignment.
6281 Enabled at levels @option{-O2}, @option{-O3}.
6283 @item -falign-loops
6284 @itemx -falign-loops=@var{n}
6285 @opindex falign-loops
6286 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6287 like @option{-falign-functions}.  The hope is that the loop will be
6288 executed many times, which will make up for any execution of the dummy
6289 operations.
6291 @option{-fno-align-loops} and @option{-falign-loops=1} are
6292 equivalent and mean that loops will not be aligned.
6294 If @var{n} is not specified or is zero, use a machine-dependent default.
6296 Enabled at levels @option{-O2}, @option{-O3}.
6298 @item -falign-jumps
6299 @itemx -falign-jumps=@var{n}
6300 @opindex falign-jumps
6301 Align branch targets to a power-of-two boundary, for branch targets
6302 where the targets can only be reached by jumping, skipping up to @var{n}
6303 bytes like @option{-falign-functions}.  In this case, no dummy operations
6304 need be executed.
6306 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6307 equivalent and mean that loops will not be aligned.
6309 If @var{n} is not specified or is zero, use a machine-dependent default.
6311 Enabled at levels @option{-O2}, @option{-O3}.
6313 @item -funit-at-a-time
6314 @opindex funit-at-a-time
6315 Parse the whole compilation unit before starting to produce code.
6316 This allows some extra optimizations to take place but consumes
6317 more memory (in general).  There are some compatibility issues
6318 with @emph{unit-at-a-time} mode:
6319 @itemize @bullet
6320 @item
6321 enabling @emph{unit-at-a-time} mode may change the order
6322 in which functions, variables, and top-level @code{asm} statements
6323 are emitted, and will likely break code relying on some particular
6324 ordering.  The majority of such top-level @code{asm} statements,
6325 though, can be replaced by @code{section} attributes.  The
6326 @option{fno-toplevel-reorder} option may be used to keep the ordering
6327 used in the input file, at the cost of some optimizations.
6329 @item
6330 @emph{unit-at-a-time} mode removes unreferenced static variables
6331 and functions.  This may result in undefined references
6332 when an @code{asm} statement refers directly to variables or functions
6333 that are otherwise unused.  In that case either the variable/function
6334 shall be listed as an operand of the @code{asm} statement operand or,
6335 in the case of top-level @code{asm} statements the attribute @code{used}
6336 shall be used on the declaration.
6338 @item
6339 Static functions now can use non-standard passing conventions that
6340 may break @code{asm} statements calling functions directly.  Again,
6341 attribute @code{used} will prevent this behavior.
6342 @end itemize
6344 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6345 but this scheme may not be supported by future releases of GCC@.
6347 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6349 @item -fno-toplevel-reorder
6350 @opindex fno-toplevel-reorder
6351 Do not reorder top-level functions, variables, and @code{asm}
6352 statements.  Output them in the same order that they appear in the
6353 input file.  When this option is used, unreferenced static variables
6354 will not be removed.  This option is intended to support existing code
6355 which relies on a particular ordering.  For new code, it is better to
6356 use attributes.
6358 @item -fweb
6359 @opindex fweb
6360 Constructs webs as commonly used for register allocation purposes and assign
6361 each web individual pseudo register.  This allows the register allocation pass
6362 to operate on pseudos directly, but also strengthens several other optimization
6363 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6364 however, make debugging impossible, since variables will no longer stay in a
6365 ``home register''.
6367 Enabled by default with @option{-funroll-loops}.
6369 @item -fwhole-program
6370 @opindex fwhole-program
6371 Assume that the current compilation unit represents whole program being
6372 compiled.  All public functions and variables with the exception of @code{main}
6373 and those merged by attribute @code{externally_visible} become static functions
6374 and in a affect gets more aggressively optimized by interprocedural optimizers.
6375 While this option is equivalent to proper use of @code{static} keyword for
6376 programs consisting of single file, in combination with option
6377 @option{--combine} this flag can be used to compile most of smaller scale C
6378 programs since the functions and variables become local for the whole combined
6379 compilation unit, not for the single source file itself.
6381 This option is not supported for Fortran programs.
6383 @item -fcprop-registers
6384 @opindex fcprop-registers
6385 After register allocation and post-register allocation instruction splitting,
6386 we perform a copy-propagation pass to try to reduce scheduling dependencies
6387 and occasionally eliminate the copy.
6389 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6391 @item -fprofile-generate
6392 @opindex fprofile-generate
6394 Enable options usually used for instrumenting application to produce
6395 profile useful for later recompilation with profile feedback based
6396 optimization.  You must use @option{-fprofile-generate} both when
6397 compiling and when linking your program.
6399 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6401 @item -fprofile-use
6402 @opindex fprofile-use
6403 Enable profile feedback directed optimizations, and optimizations
6404 generally profitable only with profile feedback available.
6406 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6407 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6409 By default, GCC emits an error message if the feedback profiles do not
6410 match the source code.  This error can be turned into a warning by using
6411 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6412 code.
6413 @end table
6415 The following options control compiler behavior regarding floating
6416 point arithmetic.  These options trade off between speed and
6417 correctness.  All must be specifically enabled.
6419 @table @gcctabopt
6420 @item -ffloat-store
6421 @opindex ffloat-store
6422 Do not store floating point variables in registers, and inhibit other
6423 options that might change whether a floating point value is taken from a
6424 register or memory.
6426 @cindex floating point precision
6427 This option prevents undesirable excess precision on machines such as
6428 the 68000 where the floating registers (of the 68881) keep more
6429 precision than a @code{double} is supposed to have.  Similarly for the
6430 x86 architecture.  For most programs, the excess precision does only
6431 good, but a few programs rely on the precise definition of IEEE floating
6432 point.  Use @option{-ffloat-store} for such programs, after modifying
6433 them to store all pertinent intermediate computations into variables.
6435 @item -ffast-math
6436 @opindex ffast-math
6437 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6438 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6439 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6441 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6443 This option is not turned on by any @option{-O} option since
6444 it can result in incorrect output for programs which depend on
6445 an exact implementation of IEEE or ISO rules/specifications for
6446 math functions. It may, however, yield faster code for programs
6447 that do not require the guarantees of these specifications.
6449 @item -fno-math-errno
6450 @opindex fno-math-errno
6451 Do not set ERRNO after calling math functions that are executed
6452 with a single instruction, e.g., sqrt.  A program that relies on
6453 IEEE exceptions for math error handling may want to use this flag
6454 for speed while maintaining IEEE arithmetic compatibility.
6456 This option is not turned on by any @option{-O} option since
6457 it can result in incorrect output for programs which depend on
6458 an exact implementation of IEEE or ISO rules/specifications for
6459 math functions. It may, however, yield faster code for programs
6460 that do not require the guarantees of these specifications.
6462 The default is @option{-fmath-errno}.
6464 On Darwin systems, the math library never sets @code{errno}.  There is
6465 therefore no reason for the compiler to consider the possibility that
6466 it might, and @option{-fno-math-errno} is the default.
6468 @item -funsafe-math-optimizations
6469 @opindex funsafe-math-optimizations
6471 Allow optimizations for floating-point arithmetic that (a) assume
6472 that arguments and results are valid and (b) may violate IEEE or
6473 ANSI standards.  When used at link-time, it may include libraries
6474 or startup files that change the default FPU control word or other
6475 similar optimizations.
6477 This option is not turned on by any @option{-O} option since
6478 it can result in incorrect output for programs which depend on
6479 an exact implementation of IEEE or ISO rules/specifications for
6480 math functions. It may, however, yield faster code for programs
6481 that do not require the guarantees of these specifications.
6482 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6483 @option{-fassociative-math} and @option{-freciprocal-math}.
6485 The default is @option{-fno-unsafe-math-optimizations}.
6487 @item -fassociative-math
6488 @opindex fassociative-math
6490 Allow re-association of operands in series of floating-point operations.
6491 This violates the ISO C and C++ language standard by possibly changing
6492 computation result.  NOTE: re-ordering may change the sign of zero as
6493 well as ignore NaNs and inhibit or create underflow or overflow (and
6494 thus cannot be used on a code which relies on rounding behavior like
6495 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6496 and thus may not be used when ordered comparisons are required.
6497 This option requires that both @option{-fno-signed-zeros} and
6498 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6499 much sense with @option{-frounding-math}.
6501 The default is @option{-fno-associative-math}.
6503 @item -freciprocal-math
6504 @opindex freciprocal-math
6506 Allow the reciprocal of a value to be used instead of dividing by
6507 the value if this enables optimizations.  For example @code{x / y}
6508 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6509 is subject to common subexpression elimination.  Note that this loses
6510 precision and increases the number of flops operating on the value.
6512 The default is @option{-fno-reciprocal-math}.
6514 @item -ffinite-math-only
6515 @opindex ffinite-math-only
6516 Allow optimizations for floating-point arithmetic that assume
6517 that arguments and results are not NaNs or +-Infs.
6519 This option is not turned on by any @option{-O} option since
6520 it can result in incorrect output for programs which depend on
6521 an exact implementation of IEEE or ISO rules/specifications for
6522 math functions. It may, however, yield faster code for programs
6523 that do not require the guarantees of these specifications.
6525 The default is @option{-fno-finite-math-only}.
6527 @item -fno-signed-zeros
6528 @opindex fno-signed-zeros
6529 Allow optimizations for floating point arithmetic that ignore the
6530 signedness of zero.  IEEE arithmetic specifies the behavior of
6531 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6532 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6533 This option implies that the sign of a zero result isn't significant.
6535 The default is @option{-fsigned-zeros}.
6537 @item -fno-trapping-math
6538 @opindex fno-trapping-math
6539 Compile code assuming that floating-point operations cannot generate
6540 user-visible traps.  These traps include division by zero, overflow,
6541 underflow, inexact result and invalid operation.  This option requires
6542 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6543 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6545 This option should never be turned on by any @option{-O} option since
6546 it can result in incorrect output for programs which depend on
6547 an exact implementation of IEEE or ISO rules/specifications for
6548 math functions.
6550 The default is @option{-ftrapping-math}.
6552 @item -frounding-math
6553 @opindex frounding-math
6554 Disable transformations and optimizations that assume default floating
6555 point rounding behavior.  This is round-to-zero for all floating point
6556 to integer conversions, and round-to-nearest for all other arithmetic
6557 truncations.  This option should be specified for programs that change
6558 the FP rounding mode dynamically, or that may be executed with a
6559 non-default rounding mode.  This option disables constant folding of
6560 floating point expressions at compile-time (which may be affected by
6561 rounding mode) and arithmetic transformations that are unsafe in the
6562 presence of sign-dependent rounding modes.
6564 The default is @option{-fno-rounding-math}.
6566 This option is experimental and does not currently guarantee to
6567 disable all GCC optimizations that are affected by rounding mode.
6568 Future versions of GCC may provide finer control of this setting
6569 using C99's @code{FENV_ACCESS} pragma.  This command line option
6570 will be used to specify the default state for @code{FENV_ACCESS}.
6572 @item -frtl-abstract-sequences
6573 @opindex frtl-abstract-sequences
6574 It is a size optimization method. This option is to find identical
6575 sequences of code, which can be turned into pseudo-procedures  and
6576 then  replace  all  occurrences with  calls to  the  newly created
6577 subroutine. It is kind of an opposite of @option{-finline-functions}.
6578 This optimization runs at RTL level.
6580 @item -fsignaling-nans
6581 @opindex fsignaling-nans
6582 Compile code assuming that IEEE signaling NaNs may generate user-visible
6583 traps during floating-point operations.  Setting this option disables
6584 optimizations that may change the number of exceptions visible with
6585 signaling NaNs.  This option implies @option{-ftrapping-math}.
6587 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6588 be defined.
6590 The default is @option{-fno-signaling-nans}.
6592 This option is experimental and does not currently guarantee to
6593 disable all GCC optimizations that affect signaling NaN behavior.
6595 @item -fsingle-precision-constant
6596 @opindex fsingle-precision-constant
6597 Treat floating point constant as single precision constant instead of
6598 implicitly converting it to double precision constant.
6600 @item -fcx-limited-range
6601 @opindex fcx-limited-range
6602 When enabled, this option states that a range reduction step is not
6603 needed when performing complex division.  The default is
6604 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
6606 This option controls the default setting of the ISO C99
6607 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6608 all languages.
6610 @end table
6612 The following options control optimizations that may improve
6613 performance, but are not enabled by any @option{-O} options.  This
6614 section includes experimental options that may produce broken code.
6616 @table @gcctabopt
6617 @item -fbranch-probabilities
6618 @opindex fbranch-probabilities
6619 After running a program compiled with @option{-fprofile-arcs}
6620 (@pxref{Debugging Options,, Options for Debugging Your Program or
6621 @command{gcc}}), you can compile it a second time using
6622 @option{-fbranch-probabilities}, to improve optimizations based on
6623 the number of times each branch was taken.  When the program
6624 compiled with @option{-fprofile-arcs} exits it saves arc execution
6625 counts to a file called @file{@var{sourcename}.gcda} for each source
6626 file.  The information in this data file is very dependent on the
6627 structure of the generated code, so you must use the same source code
6628 and the same optimization options for both compilations.
6630 With @option{-fbranch-probabilities}, GCC puts a
6631 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6632 These can be used to improve optimization.  Currently, they are only
6633 used in one place: in @file{reorg.c}, instead of guessing which path a
6634 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6635 exactly determine which path is taken more often.
6637 @item -fprofile-values
6638 @opindex fprofile-values
6639 If combined with @option{-fprofile-arcs}, it adds code so that some
6640 data about values of expressions in the program is gathered.
6642 With @option{-fbranch-probabilities}, it reads back the data gathered
6643 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6644 notes to instructions for their later usage in optimizations.
6646 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6648 @item -fvpt
6649 @opindex fvpt
6650 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6651 a code to gather information about values of expressions.
6653 With @option{-fbranch-probabilities}, it reads back the data gathered
6654 and actually performs the optimizations based on them.
6655 Currently the optimizations include specialization of division operation
6656 using the knowledge about the value of the denominator.
6658 @item -frename-registers
6659 @opindex frename-registers
6660 Attempt to avoid false dependencies in scheduled code by making use
6661 of registers left over after register allocation.  This optimization
6662 will most benefit processors with lots of registers.  Depending on the
6663 debug information format adopted by the target, however, it can
6664 make debugging impossible, since variables will no longer stay in
6665 a ``home register''.
6667 Enabled by default with @option{-funroll-loops}.
6669 @item -ftracer
6670 @opindex ftracer
6671 Perform tail duplication to enlarge superblock size.  This transformation
6672 simplifies the control flow of the function allowing other optimizations to do
6673 better job.
6675 Enabled with @option{-fprofile-use}.
6677 @item -funroll-loops
6678 @opindex funroll-loops
6679 Unroll loops whose number of iterations can be determined at compile time or
6680 upon entry to the loop.  @option{-funroll-loops} implies
6681 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6682 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6683 small constant number of iterations).  This option makes code larger, and may
6684 or may not make it run faster.
6686 Enabled with @option{-fprofile-use}.
6688 @item -funroll-all-loops
6689 @opindex funroll-all-loops
6690 Unroll all loops, even if their number of iterations is uncertain when
6691 the loop is entered.  This usually makes programs run more slowly.
6692 @option{-funroll-all-loops} implies the same options as
6693 @option{-funroll-loops}.
6695 @item -fpeel-loops
6696 @opindex fpeel-loops
6697 Peels the loops for that there is enough information that they do not
6698 roll much (from profile feedback).  It also turns on complete loop peeling
6699 (i.e.@: complete removal of loops with small constant number of iterations).
6701 Enabled with @option{-fprofile-use}.
6703 @item -fmove-loop-invariants
6704 @opindex fmove-loop-invariants
6705 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6706 at level @option{-O1}
6708 @item -funswitch-loops
6709 @opindex funswitch-loops
6710 Move branches with loop invariant conditions out of the loop, with duplicates
6711 of the loop on both branches (modified according to result of the condition).
6713 @item -ffunction-sections
6714 @itemx -fdata-sections
6715 @opindex ffunction-sections
6716 @opindex fdata-sections
6717 Place each function or data item into its own section in the output
6718 file if the target supports arbitrary sections.  The name of the
6719 function or the name of the data item determines the section's name
6720 in the output file.
6722 Use these options on systems where the linker can perform optimizations
6723 to improve locality of reference in the instruction space.  Most systems
6724 using the ELF object format and SPARC processors running Solaris 2 have
6725 linkers with such optimizations.  AIX may have these optimizations in
6726 the future.
6728 Only use these options when there are significant benefits from doing
6729 so.  When you specify these options, the assembler and linker will
6730 create larger object and executable files and will also be slower.
6731 You will not be able to use @code{gprof} on all systems if you
6732 specify this option and you may have problems with debugging if
6733 you specify both this option and @option{-g}.
6735 @item -fbranch-target-load-optimize
6736 @opindex fbranch-target-load-optimize
6737 Perform branch target register load optimization before prologue / epilogue
6738 threading.
6739 The use of target registers can typically be exposed only during reload,
6740 thus hoisting loads out of loops and doing inter-block scheduling needs
6741 a separate optimization pass.
6743 @item -fbranch-target-load-optimize2
6744 @opindex fbranch-target-load-optimize2
6745 Perform branch target register load optimization after prologue / epilogue
6746 threading.
6748 @item -fbtr-bb-exclusive
6749 @opindex fbtr-bb-exclusive
6750 When performing branch target register load optimization, don't reuse
6751 branch target registers in within any basic block.
6753 @item -fstack-protector
6754 @opindex fstack-protector
6755 Emit extra code to check for buffer overflows, such as stack smashing
6756 attacks.  This is done by adding a guard variable to functions with
6757 vulnerable objects.  This includes functions that call alloca, and
6758 functions with buffers larger than 8 bytes.  The guards are initialized
6759 when a function is entered and then checked when the function exits.
6760 If a guard check fails, an error message is printed and the program exits.
6762 @item -fstack-protector-all
6763 @opindex fstack-protector-all
6764 Like @option{-fstack-protector} except that all functions are protected.
6766 @item -fsection-anchors
6767 @opindex fsection-anchors
6768 Try to reduce the number of symbolic address calculations by using
6769 shared ``anchor'' symbols to address nearby objects.  This transformation
6770 can help to reduce the number of GOT entries and GOT accesses on some
6771 targets.
6773 For example, the implementation of the following function @code{foo}:
6775 @smallexample
6776 static int a, b, c;
6777 int foo (void) @{ return a + b + c; @}
6778 @end smallexample
6780 would usually calculate the addresses of all three variables, but if you
6781 compile it with @option{-fsection-anchors}, it will access the variables
6782 from a common anchor point instead.  The effect is similar to the
6783 following pseudocode (which isn't valid C):
6785 @smallexample
6786 int foo (void)
6788   register int *xr = &x;
6789   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6791 @end smallexample
6793 Not all targets support this option.
6795 @item --param @var{name}=@var{value}
6796 @opindex param
6797 In some places, GCC uses various constants to control the amount of
6798 optimization that is done.  For example, GCC will not inline functions
6799 that contain more that a certain number of instructions.  You can
6800 control some of these constants on the command-line using the
6801 @option{--param} option.
6803 The names of specific parameters, and the meaning of the values, are
6804 tied to the internals of the compiler, and are subject to change
6805 without notice in future releases.
6807 In each case, the @var{value} is an integer.  The allowable choices for
6808 @var{name} are given in the following table:
6810 @table @gcctabopt
6811 @item salias-max-implicit-fields
6812 The maximum number of fields in a variable without direct
6813 structure accesses for which structure aliasing will consider trying
6814 to track each field.  The default is 5
6816 @item salias-max-array-elements
6817 The maximum number of elements an array can have and its elements
6818 still be tracked individually by structure aliasing. The default is 4
6820 @item sra-max-structure-size
6821 The maximum structure size, in bytes, at which the scalar replacement
6822 of aggregates (SRA) optimization will perform block copies.  The
6823 default value, 0, implies that GCC will select the most appropriate
6824 size itself.
6826 @item sra-field-structure-ratio
6827 The threshold ratio (as a percentage) between instantiated fields and
6828 the complete structure size.  We say that if the ratio of the number
6829 of bytes in instantiated fields to the number of bytes in the complete
6830 structure exceeds this parameter, then block copies are not used.  The
6831 default is 75.
6833 @item struct-reorg-cold-struct-ratio
6834 The threshold ratio (as a percentage) between a structure frequency
6835 and the frequency of the hottest structure in the program.  This parameter
6836 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6837 We say that if the ratio of a structure frequency, calculated by profiling, 
6838 to the hottest structure frequency in the program is less than this 
6839 parameter, then structure reorganization is not applied to this structure.
6840 The default is 10.
6842 @item max-crossjump-edges
6843 The maximum number of incoming edges to consider for crossjumping.
6844 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6845 the number of edges incoming to each block.  Increasing values mean
6846 more aggressive optimization, making the compile time increase with
6847 probably small improvement in executable size.
6849 @item min-crossjump-insns
6850 The minimum number of instructions which must be matched at the end
6851 of two blocks before crossjumping will be performed on them.  This
6852 value is ignored in the case where all instructions in the block being
6853 crossjumped from are matched.  The default value is 5.
6855 @item max-grow-copy-bb-insns
6856 The maximum code size expansion factor when copying basic blocks
6857 instead of jumping.  The expansion is relative to a jump instruction.
6858 The default value is 8.
6860 @item max-goto-duplication-insns
6861 The maximum number of instructions to duplicate to a block that jumps
6862 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6863 passes, GCC factors computed gotos early in the compilation process,
6864 and unfactors them as late as possible.  Only computed jumps at the
6865 end of a basic blocks with no more than max-goto-duplication-insns are
6866 unfactored.  The default value is 8.
6868 @item max-delay-slot-insn-search
6869 The maximum number of instructions to consider when looking for an
6870 instruction to fill a delay slot.  If more than this arbitrary number of
6871 instructions is searched, the time savings from filling the delay slot
6872 will be minimal so stop searching.  Increasing values mean more
6873 aggressive optimization, making the compile time increase with probably
6874 small improvement in executable run time.
6876 @item max-delay-slot-live-search
6877 When trying to fill delay slots, the maximum number of instructions to
6878 consider when searching for a block with valid live register
6879 information.  Increasing this arbitrarily chosen value means more
6880 aggressive optimization, increasing the compile time.  This parameter
6881 should be removed when the delay slot code is rewritten to maintain the
6882 control-flow graph.
6884 @item max-gcse-memory
6885 The approximate maximum amount of memory that will be allocated in
6886 order to perform the global common subexpression elimination
6887 optimization.  If more memory than specified is required, the
6888 optimization will not be done.
6890 @item max-gcse-passes
6891 The maximum number of passes of GCSE to run.  The default is 1.
6893 @item max-pending-list-length
6894 The maximum number of pending dependencies scheduling will allow
6895 before flushing the current state and starting over.  Large functions
6896 with few branches or calls can create excessively large lists which
6897 needlessly consume memory and resources.
6899 @item max-inline-insns-single
6900 Several parameters control the tree inliner used in gcc.
6901 This number sets the maximum number of instructions (counted in GCC's
6902 internal representation) in a single function that the tree inliner
6903 will consider for inlining.  This only affects functions declared
6904 inline and methods implemented in a class declaration (C++).
6905 The default value is 450.
6907 @item max-inline-insns-auto
6908 When you use @option{-finline-functions} (included in @option{-O3}),
6909 a lot of functions that would otherwise not be considered for inlining
6910 by the compiler will be investigated.  To those functions, a different
6911 (more restrictive) limit compared to functions declared inline can
6912 be applied.
6913 The default value is 90.
6915 @item large-function-insns
6916 The limit specifying really large functions.  For functions larger than this
6917 limit after inlining inlining is constrained by
6918 @option{--param large-function-growth}.  This parameter is useful primarily
6919 to avoid extreme compilation time caused by non-linear algorithms used by the
6920 backend.
6921 This parameter is ignored when @option{-funit-at-a-time} is not used.
6922 The default value is 2700.
6924 @item large-function-growth
6925 Specifies maximal growth of large function caused by inlining in percents.
6926 This parameter is ignored when @option{-funit-at-a-time} is not used.
6927 The default value is 100 which limits large function growth to 2.0 times
6928 the original size.
6930 @item large-unit-insns
6931 The limit specifying large translation unit.  Growth caused by inlining of
6932 units larger than this limit is limited by @option{--param inline-unit-growth}.
6933 For small units this might be too tight (consider unit consisting of function A
6934 that is inline and B that just calls A three time.  If B is small relative to
6935 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6936 large units consisting of small inlineable functions however the overall unit
6937 growth limit is needed to avoid exponential explosion of code size.  Thus for
6938 smaller units, the size is increased to @option{--param large-unit-insns}
6939 before applying @option{--param inline-unit-growth}.  The default is 10000
6941 @item inline-unit-growth
6942 Specifies maximal overall growth of the compilation unit caused by inlining.
6943 This parameter is ignored when @option{-funit-at-a-time} is not used.
6944 The default value is 30 which limits unit growth to 1.3 times the original
6945 size.
6947 @item large-stack-frame
6948 The limit specifying large stack frames.  While inlining the algorithm is trying
6949 to not grow past this limit too much.  Default value is 256 bytes.
6951 @item large-stack-frame-growth
6952 Specifies maximal growth of large stack frames caused by inlining in percents.
6953 The default value is 1000 which limits large stack frame growth to 11 times
6954 the original size.
6956 @item max-inline-insns-recursive
6957 @itemx max-inline-insns-recursive-auto
6958 Specifies maximum number of instructions out-of-line copy of self recursive inline
6959 function can grow into by performing recursive inlining.
6961 For functions declared inline @option{--param max-inline-insns-recursive} is
6962 taken into account.  For function not declared inline, recursive inlining
6963 happens only when @option{-finline-functions} (included in @option{-O3}) is
6964 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6965 default value is 450.
6967 @item max-inline-recursive-depth
6968 @itemx max-inline-recursive-depth-auto
6969 Specifies maximum recursion depth used by the recursive inlining.
6971 For functions declared inline @option{--param max-inline-recursive-depth} is
6972 taken into account.  For function not declared inline, recursive inlining
6973 happens only when @option{-finline-functions} (included in @option{-O3}) is
6974 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6975 default value is 8.
6977 @item min-inline-recursive-probability
6978 Recursive inlining is profitable only for function having deep recursion
6979 in average and can hurt for function having little recursion depth by
6980 increasing the prologue size or complexity of function body to other
6981 optimizers.
6983 When profile feedback is available (see @option{-fprofile-generate}) the actual
6984 recursion depth can be guessed from probability that function will recurse via
6985 given call expression.  This parameter limits inlining only to call expression
6986 whose probability exceeds given threshold (in percents).  The default value is
6989 @item inline-call-cost
6990 Specify cost of call instruction relative to simple arithmetics operations
6991 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6992 functions and at the same time increases size of leaf function that is believed to
6993 reduce function size by being inlined.  In effect it increases amount of
6994 inlining for code having large abstraction penalty (many functions that just
6995 pass the arguments to other functions) and decrease inlining for code with low
6996 abstraction penalty.  The default value is 12.
6998 @item min-vect-loop-bound
6999 The minimum number of iterations under which a loop will not get vectorized
7000 when @option{-ftree-vectorize} is used.  The number of iterations after
7001 vectorization needs to be greater than the value specified by this option
7002 to allow vectorization.  The default value is 0.
7004 @item max-unrolled-insns
7005 The maximum number of instructions that a loop should have if that loop
7006 is unrolled, and if the loop is unrolled, it determines how many times
7007 the loop code is unrolled.
7009 @item max-average-unrolled-insns
7010 The maximum number of instructions biased by probabilities of their execution
7011 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7012 it determines how many times the loop code is unrolled.
7014 @item max-unroll-times
7015 The maximum number of unrollings of a single loop.
7017 @item max-peeled-insns
7018 The maximum number of instructions that a loop should have if that loop
7019 is peeled, and if the loop is peeled, it determines how many times
7020 the loop code is peeled.
7022 @item max-peel-times
7023 The maximum number of peelings of a single loop.
7025 @item max-completely-peeled-insns
7026 The maximum number of insns of a completely peeled loop.
7028 @item max-completely-peel-times
7029 The maximum number of iterations of a loop to be suitable for complete peeling.
7031 @item max-unswitch-insns
7032 The maximum number of insns of an unswitched loop.
7034 @item max-unswitch-level
7035 The maximum number of branches unswitched in a single loop.
7037 @item lim-expensive
7038 The minimum cost of an expensive expression in the loop invariant motion.
7040 @item iv-consider-all-candidates-bound
7041 Bound on number of candidates for induction variables below that
7042 all candidates are considered for each use in induction variable
7043 optimizations.  Only the most relevant candidates are considered
7044 if there are more candidates, to avoid quadratic time complexity.
7046 @item iv-max-considered-uses
7047 The induction variable optimizations give up on loops that contain more
7048 induction variable uses.
7050 @item iv-always-prune-cand-set-bound
7051 If number of candidates in the set is smaller than this value,
7052 we always try to remove unnecessary ivs from the set during its
7053 optimization when a new iv is added to the set.
7055 @item scev-max-expr-size
7056 Bound on size of expressions used in the scalar evolutions analyzer.
7057 Large expressions slow the analyzer.
7059 @item omega-max-vars
7060 The maximum number of variables in an Omega constraint system.
7061 The default value is 128.
7063 @item omega-max-geqs
7064 The maximum number of inequalities in an Omega constraint system.
7065 The default value is 256.
7067 @item omega-max-eqs
7068 The maximum number of equalities in an Omega constraint system.
7069 The default value is 128.
7071 @item omega-max-wild-cards
7072 The maximum number of wildcard variables that the Omega solver will
7073 be able to insert.  The default value is 18.
7075 @item omega-hash-table-size
7076 The size of the hash table in the Omega solver.  The default value is
7077 550.
7079 @item omega-max-keys
7080 The maximal number of keys used by the Omega solver.  The default
7081 value is 500.
7083 @item omega-eliminate-redundant-constraints
7084 When set to 1, use expensive methods to eliminate all redundant
7085 constraints.  The default value is 0.
7087 @item vect-max-version-for-alignment-checks
7088 The maximum number of runtime checks that can be performed when
7089 doing loop versioning for alignment in the vectorizer.  See option
7090 ftree-vect-loop-version for more information.
7092 @item vect-max-version-for-alias-checks
7093 The maximum number of runtime checks that can be performed when
7094 doing loop versioning for alias in the vectorizer.  See option
7095 ftree-vect-loop-version for more information.
7097 @item max-iterations-to-track
7099 The maximum number of iterations of a loop the brute force algorithm
7100 for analysis of # of iterations of the loop tries to evaluate.
7102 @item hot-bb-count-fraction
7103 Select fraction of the maximal count of repetitions of basic block in program
7104 given basic block needs to have to be considered hot.
7106 @item hot-bb-frequency-fraction
7107 Select fraction of the maximal frequency of executions of basic block in
7108 function given basic block needs to have to be considered hot
7110 @item max-predicted-iterations
7111 The maximum number of loop iterations we predict statically.  This is useful
7112 in cases where function contain single loop with known bound and other loop
7113 with unknown.  We predict the known number of iterations correctly, while
7114 the unknown number of iterations average to roughly 10.  This means that the
7115 loop without bounds would appear artificially cold relative to the other one.
7117 @item align-threshold
7119 Select fraction of the maximal frequency of executions of basic block in
7120 function given basic block will get aligned.
7122 @item align-loop-iterations
7124 A loop expected to iterate at lest the selected number of iterations will get
7125 aligned.
7127 @item tracer-dynamic-coverage
7128 @itemx tracer-dynamic-coverage-feedback
7130 This value is used to limit superblock formation once the given percentage of
7131 executed instructions is covered.  This limits unnecessary code size
7132 expansion.
7134 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7135 feedback is available.  The real profiles (as opposed to statically estimated
7136 ones) are much less balanced allowing the threshold to be larger value.
7138 @item tracer-max-code-growth
7139 Stop tail duplication once code growth has reached given percentage.  This is
7140 rather hokey argument, as most of the duplicates will be eliminated later in
7141 cross jumping, so it may be set to much higher values than is the desired code
7142 growth.
7144 @item tracer-min-branch-ratio
7146 Stop reverse growth when the reverse probability of best edge is less than this
7147 threshold (in percent).
7149 @item tracer-min-branch-ratio
7150 @itemx tracer-min-branch-ratio-feedback
7152 Stop forward growth if the best edge do have probability lower than this
7153 threshold.
7155 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7156 compilation for profile feedback and one for compilation without.  The value
7157 for compilation with profile feedback needs to be more conservative (higher) in
7158 order to make tracer effective.
7160 @item max-cse-path-length
7162 Maximum number of basic blocks on path that cse considers.  The default is 10.
7164 @item max-cse-insns
7165 The maximum instructions CSE process before flushing. The default is 1000.
7167 @item max-aliased-vops
7169 Maximum number of virtual operands per function allowed to represent
7170 aliases before triggering the alias partitioning heuristic.  Alias
7171 partitioning reduces compile times and memory consumption needed for
7172 aliasing at the expense of precision loss in alias information.  The
7173 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7174 for -O3.
7176 Notice that if a function contains more memory statements than the
7177 value of this parameter, it is not really possible to achieve this
7178 reduction.  In this case, the compiler will use the number of memory
7179 statements as the value for @option{max-aliased-vops}.
7181 @item avg-aliased-vops
7183 Average number of virtual operands per statement allowed to represent
7184 aliases before triggering the alias partitioning heuristic.  This
7185 works in conjunction with @option{max-aliased-vops}.  If a function
7186 contains more than @option{max-aliased-vops} virtual operators, then
7187 memory symbols will be grouped into memory partitions until either the
7188 total number of virtual operators is below @option{max-aliased-vops}
7189 or the average number of virtual operators per memory statement is
7190 below @option{avg-aliased-vops}.  The default value for this parameter
7191 is 1 for -O1 and -O2, and 3 for -O3.
7193 @item ggc-min-expand
7195 GCC uses a garbage collector to manage its own memory allocation.  This
7196 parameter specifies the minimum percentage by which the garbage
7197 collector's heap should be allowed to expand between collections.
7198 Tuning this may improve compilation speed; it has no effect on code
7199 generation.
7201 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7202 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7203 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7204 GCC is not able to calculate RAM on a particular platform, the lower
7205 bound of 30% is used.  Setting this parameter and
7206 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7207 every opportunity.  This is extremely slow, but can be useful for
7208 debugging.
7210 @item ggc-min-heapsize
7212 Minimum size of the garbage collector's heap before it begins bothering
7213 to collect garbage.  The first collection occurs after the heap expands
7214 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7215 tuning this may improve compilation speed, and has no effect on code
7216 generation.
7218 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7219 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7220 with a lower bound of 4096 (four megabytes) and an upper bound of
7221 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7222 particular platform, the lower bound is used.  Setting this parameter
7223 very large effectively disables garbage collection.  Setting this
7224 parameter and @option{ggc-min-expand} to zero causes a full collection
7225 to occur at every opportunity.
7227 @item max-reload-search-insns
7228 The maximum number of instruction reload should look backward for equivalent
7229 register.  Increasing values mean more aggressive optimization, making the
7230 compile time increase with probably slightly better performance.  The default
7231 value is 100.
7233 @item max-cselib-memory-locations
7234 The maximum number of memory locations cselib should take into account.
7235 Increasing values mean more aggressive optimization, making the compile time
7236 increase with probably slightly better performance.  The default value is 500.
7238 @item max-flow-memory-locations
7239 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
7240 The default value is 100.
7242 @item reorder-blocks-duplicate
7243 @itemx reorder-blocks-duplicate-feedback
7245 Used by basic block reordering pass to decide whether to use unconditional
7246 branch or duplicate the code on its destination.  Code is duplicated when its
7247 estimated size is smaller than this value multiplied by the estimated size of
7248 unconditional jump in the hot spots of the program.
7250 The @option{reorder-block-duplicate-feedback} is used only when profile
7251 feedback is available and may be set to higher values than
7252 @option{reorder-block-duplicate} since information about the hot spots is more
7253 accurate.
7255 @item max-sched-ready-insns
7256 The maximum number of instructions ready to be issued the scheduler should
7257 consider at any given time during the first scheduling pass.  Increasing
7258 values mean more thorough searches, making the compilation time increase
7259 with probably little benefit.  The default value is 100.
7261 @item max-sched-region-blocks
7262 The maximum number of blocks in a region to be considered for
7263 interblock scheduling.  The default value is 10.
7265 @item max-sched-region-insns
7266 The maximum number of insns in a region to be considered for
7267 interblock scheduling.  The default value is 100.
7269 @item min-spec-prob
7270 The minimum probability (in percents) of reaching a source block
7271 for interblock speculative scheduling.  The default value is 40.
7273 @item max-sched-extend-regions-iters
7274 The maximum number of iterations through CFG to extend regions.
7275 0 - disable region extension,
7276 N - do at most N iterations.
7277 The default value is 0.
7279 @item max-sched-insn-conflict-delay
7280 The maximum conflict delay for an insn to be considered for speculative motion.
7281 The default value is 3.
7283 @item sched-spec-prob-cutoff
7284 The minimal probability of speculation success (in percents), so that
7285 speculative insn will be scheduled.
7286 The default value is 40.
7288 @item max-last-value-rtl
7290 The maximum size measured as number of RTLs that can be recorded in an expression
7291 in combiner for a pseudo register as last known value of that register.  The default
7292 is 10000.
7294 @item integer-share-limit
7295 Small integer constants can use a shared data structure, reducing the
7296 compiler's memory usage and increasing its speed.  This sets the maximum
7297 value of a shared integer constant.  The default value is 256.
7299 @item min-virtual-mappings
7300 Specifies the minimum number of virtual mappings in the incremental
7301 SSA updater that should be registered to trigger the virtual mappings
7302 heuristic defined by virtual-mappings-ratio.  The default value is
7303 100.
7305 @item virtual-mappings-ratio
7306 If the number of virtual mappings is virtual-mappings-ratio bigger
7307 than the number of virtual symbols to be updated, then the incremental
7308 SSA updater switches to a full update for those symbols.  The default
7309 ratio is 3.
7311 @item ssp-buffer-size
7312 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7313 protection when @option{-fstack-protection} is used.
7315 @item max-jump-thread-duplication-stmts
7316 Maximum number of statements allowed in a block that needs to be
7317 duplicated when threading jumps.
7319 @item max-fields-for-field-sensitive
7320 Maximum number of fields in a structure we will treat in
7321 a field sensitive manner during pointer analysis.
7323 @item prefetch-latency
7324 Estimate on average number of instructions that are executed before
7325 prefetch finishes.  The distance we prefetch ahead is proportional
7326 to this constant.  Increasing this number may also lead to less
7327 streams being prefetched (see @option{simultaneous-prefetches}).
7329 @item simultaneous-prefetches
7330 Maximum number of prefetches that can run at the same time.
7332 @item l1-cache-line-size
7333 The size of cache line in L1 cache, in bytes.
7335 @item l1-cache-size
7336 The size of L1 cache, in kilobytes.
7338 @item l2-cache-size
7339 The size of L2 cache, in kilobytes.
7341 @item use-canonical-types
7342 Whether the compiler should use the ``canonical'' type system.  By
7343 default, this should always be 1, which uses a more efficient internal
7344 mechanism for comparing types in C++ and Objective-C++.  However, if
7345 bugs in the canonical type system are causing compilation failures,
7346 set this value to 0 to disable canonical types.
7348 @item max-partial-antic-length
7349 Maximum length of the partial antic set computed during the tree
7350 partial redundancy elimination optimization (@option{-ftree-pre}) when
7351 optimizing at @option{-O3} and above.  For some sorts of source code
7352 the enhanced partial redundancy elimination optimization can run away,
7353 consuming all of the memory available on the host machine.  This
7354 parameter sets a limit on the length of the sets that are computed,
7355 which prevents the runaway behaviour.  Setting a value of 0 for
7356 this paramter will allow an unlimited set length.
7358 @item sccvn-max-scc-size
7359 Maximum size of a strongly connected component (SCC) during SCCVN
7360 processing.  If this limit is hit, SCCVN processing for the whole
7361 function will not be done and optimizations depending on it will
7362 be disabled.  The default maximum SCC size is 10000.
7364 @end table
7365 @end table
7367 @node Preprocessor Options
7368 @section Options Controlling the Preprocessor
7369 @cindex preprocessor options
7370 @cindex options, preprocessor
7372 These options control the C preprocessor, which is run on each C source
7373 file before actual compilation.
7375 If you use the @option{-E} option, nothing is done except preprocessing.
7376 Some of these options make sense only together with @option{-E} because
7377 they cause the preprocessor output to be unsuitable for actual
7378 compilation.
7380 @table @gcctabopt
7381 @opindex Wp
7382 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7383 and pass @var{option} directly through to the preprocessor.  If
7384 @var{option} contains commas, it is split into multiple options at the
7385 commas.  However, many options are modified, translated or interpreted
7386 by the compiler driver before being passed to the preprocessor, and
7387 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7388 interface is undocumented and subject to change, so whenever possible
7389 you should avoid using @option{-Wp} and let the driver handle the
7390 options instead.
7392 @item -Xpreprocessor @var{option}
7393 @opindex preprocessor
7394 Pass @var{option} as an option to the preprocessor.  You can use this to
7395 supply system-specific preprocessor options which GCC does not know how to
7396 recognize.
7398 If you want to pass an option that takes an argument, you must use
7399 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7400 @end table
7402 @include cppopts.texi
7404 @node Assembler Options
7405 @section Passing Options to the Assembler
7407 @c prevent bad page break with this line
7408 You can pass options to the assembler.
7410 @table @gcctabopt
7411 @item -Wa,@var{option}
7412 @opindex Wa
7413 Pass @var{option} as an option to the assembler.  If @var{option}
7414 contains commas, it is split into multiple options at the commas.
7416 @item -Xassembler @var{option}
7417 @opindex Xassembler
7418 Pass @var{option} as an option to the assembler.  You can use this to
7419 supply system-specific assembler options which GCC does not know how to
7420 recognize.
7422 If you want to pass an option that takes an argument, you must use
7423 @option{-Xassembler} twice, once for the option and once for the argument.
7425 @end table
7427 @node Link Options
7428 @section Options for Linking
7429 @cindex link options
7430 @cindex options, linking
7432 These options come into play when the compiler links object files into
7433 an executable output file.  They are meaningless if the compiler is
7434 not doing a link step.
7436 @table @gcctabopt
7437 @cindex file names
7438 @item @var{object-file-name}
7439 A file name that does not end in a special recognized suffix is
7440 considered to name an object file or library.  (Object files are
7441 distinguished from libraries by the linker according to the file
7442 contents.)  If linking is done, these object files are used as input
7443 to the linker.
7445 @item -c
7446 @itemx -S
7447 @itemx -E
7448 @opindex c
7449 @opindex S
7450 @opindex E
7451 If any of these options is used, then the linker is not run, and
7452 object file names should not be used as arguments.  @xref{Overall
7453 Options}.
7455 @cindex Libraries
7456 @item -l@var{library}
7457 @itemx -l @var{library}
7458 @opindex l
7459 Search the library named @var{library} when linking.  (The second
7460 alternative with the library as a separate argument is only for
7461 POSIX compliance and is not recommended.)
7463 It makes a difference where in the command you write this option; the
7464 linker searches and processes libraries and object files in the order they
7465 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7466 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7467 to functions in @samp{z}, those functions may not be loaded.
7469 The linker searches a standard list of directories for the library,
7470 which is actually a file named @file{lib@var{library}.a}.  The linker
7471 then uses this file as if it had been specified precisely by name.
7473 The directories searched include several standard system directories
7474 plus any that you specify with @option{-L}.
7476 Normally the files found this way are library files---archive files
7477 whose members are object files.  The linker handles an archive file by
7478 scanning through it for members which define symbols that have so far
7479 been referenced but not defined.  But if the file that is found is an
7480 ordinary object file, it is linked in the usual fashion.  The only
7481 difference between using an @option{-l} option and specifying a file name
7482 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7483 and searches several directories.
7485 @item -lobjc
7486 @opindex lobjc
7487 You need this special case of the @option{-l} option in order to
7488 link an Objective-C or Objective-C++ program.
7490 @item -nostartfiles
7491 @opindex nostartfiles
7492 Do not use the standard system startup files when linking.
7493 The standard system libraries are used normally, unless @option{-nostdlib}
7494 or @option{-nodefaultlibs} is used.
7496 @item -nodefaultlibs
7497 @opindex nodefaultlibs
7498 Do not use the standard system libraries when linking.
7499 Only the libraries you specify will be passed to the linker.
7500 The standard startup files are used normally, unless @option{-nostartfiles}
7501 is used.  The compiler may generate calls to @code{memcmp},
7502 @code{memset}, @code{memcpy} and @code{memmove}.
7503 These entries are usually resolved by entries in
7504 libc.  These entry points should be supplied through some other
7505 mechanism when this option is specified.
7507 @item -nostdlib
7508 @opindex nostdlib
7509 Do not use the standard system startup files or libraries when linking.
7510 No startup files and only the libraries you specify will be passed to
7511 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7512 @code{memcpy} and @code{memmove}.
7513 These entries are usually resolved by entries in
7514 libc.  These entry points should be supplied through some other
7515 mechanism when this option is specified.
7517 @cindex @option{-lgcc}, use with @option{-nostdlib}
7518 @cindex @option{-nostdlib} and unresolved references
7519 @cindex unresolved references and @option{-nostdlib}
7520 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7521 @cindex @option{-nodefaultlibs} and unresolved references
7522 @cindex unresolved references and @option{-nodefaultlibs}
7523 One of the standard libraries bypassed by @option{-nostdlib} and
7524 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7525 that GCC uses to overcome shortcomings of particular machines, or special
7526 needs for some languages.
7527 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7528 Collection (GCC) Internals},
7529 for more discussion of @file{libgcc.a}.)
7530 In most cases, you need @file{libgcc.a} even when you want to avoid
7531 other standard libraries.  In other words, when you specify @option{-nostdlib}
7532 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7533 This ensures that you have no unresolved references to internal GCC
7534 library subroutines.  (For example, @samp{__main}, used to ensure C++
7535 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7536 GNU Compiler Collection (GCC) Internals}.)
7538 @item -pie
7539 @opindex pie
7540 Produce a position independent executable on targets which support it.
7541 For predictable results, you must also specify the same set of options
7542 that were used to generate code (@option{-fpie}, @option{-fPIE},
7543 or model suboptions) when you specify this option.
7545 @item -rdynamic
7546 @opindex rdynamic
7547 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7548 that support it. This instructs the linker to add all symbols, not
7549 only used ones, to the dynamic symbol table. This option is needed
7550 for some uses of @code{dlopen} or to allow obtaining backtraces
7551 from within a program.
7553 @item -s
7554 @opindex s
7555 Remove all symbol table and relocation information from the executable.
7557 @item -static
7558 @opindex static
7559 On systems that support dynamic linking, this prevents linking with the shared
7560 libraries.  On other systems, this option has no effect.
7562 @item -shared
7563 @opindex shared
7564 Produce a shared object which can then be linked with other objects to
7565 form an executable.  Not all systems support this option.  For predictable
7566 results, you must also specify the same set of options that were used to
7567 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7568 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7569 needs to build supplementary stub code for constructors to work.  On
7570 multi-libbed systems, @samp{gcc -shared} must select the correct support
7571 libraries to link against.  Failing to supply the correct flags may lead
7572 to subtle defects.  Supplying them in cases where they are not necessary
7573 is innocuous.}
7575 @item -shared-libgcc
7576 @itemx -static-libgcc
7577 @opindex shared-libgcc
7578 @opindex static-libgcc
7579 On systems that provide @file{libgcc} as a shared library, these options
7580 force the use of either the shared or static version respectively.
7581 If no shared version of @file{libgcc} was built when the compiler was
7582 configured, these options have no effect.
7584 There are several situations in which an application should use the
7585 shared @file{libgcc} instead of the static version.  The most common
7586 of these is when the application wishes to throw and catch exceptions
7587 across different shared libraries.  In that case, each of the libraries
7588 as well as the application itself should use the shared @file{libgcc}.
7590 Therefore, the G++ and GCJ drivers automatically add
7591 @option{-shared-libgcc} whenever you build a shared library or a main
7592 executable, because C++ and Java programs typically use exceptions, so
7593 this is the right thing to do.
7595 If, instead, you use the GCC driver to create shared libraries, you may
7596 find that they will not always be linked with the shared @file{libgcc}.
7597 If GCC finds, at its configuration time, that you have a non-GNU linker
7598 or a GNU linker that does not support option @option{--eh-frame-hdr},
7599 it will link the shared version of @file{libgcc} into shared libraries
7600 by default.  Otherwise, it will take advantage of the linker and optimize
7601 away the linking with the shared version of @file{libgcc}, linking with
7602 the static version of libgcc by default.  This allows exceptions to
7603 propagate through such shared libraries, without incurring relocation
7604 costs at library load time.
7606 However, if a library or main executable is supposed to throw or catch
7607 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7608 for the languages used in the program, or using the option
7609 @option{-shared-libgcc}, such that it is linked with the shared
7610 @file{libgcc}.
7612 @item -symbolic
7613 @opindex symbolic
7614 Bind references to global symbols when building a shared object.  Warn
7615 about any unresolved references (unless overridden by the link editor
7616 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7617 this option.
7619 @item -Xlinker @var{option}
7620 @opindex Xlinker
7621 Pass @var{option} as an option to the linker.  You can use this to
7622 supply system-specific linker options which GCC does not know how to
7623 recognize.
7625 If you want to pass an option that takes an argument, you must use
7626 @option{-Xlinker} twice, once for the option and once for the argument.
7627 For example, to pass @option{-assert definitions}, you must write
7628 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7629 @option{-Xlinker "-assert definitions"}, because this passes the entire
7630 string as a single argument, which is not what the linker expects.
7632 @item -Wl,@var{option}
7633 @opindex Wl
7634 Pass @var{option} as an option to the linker.  If @var{option} contains
7635 commas, it is split into multiple options at the commas.
7637 @item -u @var{symbol}
7638 @opindex u
7639 Pretend the symbol @var{symbol} is undefined, to force linking of
7640 library modules to define it.  You can use @option{-u} multiple times with
7641 different symbols to force loading of additional library modules.
7642 @end table
7644 @node Directory Options
7645 @section Options for Directory Search
7646 @cindex directory options
7647 @cindex options, directory search
7648 @cindex search path
7650 These options specify directories to search for header files, for
7651 libraries and for parts of the compiler:
7653 @table @gcctabopt
7654 @item -I@var{dir}
7655 @opindex I
7656 Add the directory @var{dir} to the head of the list of directories to be
7657 searched for header files.  This can be used to override a system header
7658 file, substituting your own version, since these directories are
7659 searched before the system header file directories.  However, you should
7660 not use this option to add directories that contain vendor-supplied
7661 system header files (use @option{-isystem} for that).  If you use more than
7662 one @option{-I} option, the directories are scanned in left-to-right
7663 order; the standard system directories come after.
7665 If a standard system include directory, or a directory specified with
7666 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7667 option will be ignored.  The directory will still be searched but as a
7668 system directory at its normal position in the system include chain.
7669 This is to ensure that GCC's procedure to fix buggy system headers and
7670 the ordering for the include_next directive are not inadvertently changed.
7671 If you really need to change the search order for system directories,
7672 use the @option{-nostdinc} and/or @option{-isystem} options.
7674 @item -iquote@var{dir}
7675 @opindex iquote
7676 Add the directory @var{dir} to the head of the list of directories to
7677 be searched for header files only for the case of @samp{#include
7678 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7679 otherwise just like @option{-I}.
7681 @item -L@var{dir}
7682 @opindex L
7683 Add directory @var{dir} to the list of directories to be searched
7684 for @option{-l}.
7686 @item -B@var{prefix}
7687 @opindex B
7688 This option specifies where to find the executables, libraries,
7689 include files, and data files of the compiler itself.
7691 The compiler driver program runs one or more of the subprograms
7692 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7693 @var{prefix} as a prefix for each program it tries to run, both with and
7694 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7696 For each subprogram to be run, the compiler driver first tries the
7697 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7698 was not specified, the driver tries two standard prefixes, which are
7699 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7700 those results in a file name that is found, the unmodified program
7701 name is searched for using the directories specified in your
7702 @env{PATH} environment variable.
7704 The compiler will check to see if the path provided by the @option{-B}
7705 refers to a directory, and if necessary it will add a directory
7706 separator character at the end of the path.
7708 @option{-B} prefixes that effectively specify directory names also apply
7709 to libraries in the linker, because the compiler translates these
7710 options into @option{-L} options for the linker.  They also apply to
7711 includes files in the preprocessor, because the compiler translates these
7712 options into @option{-isystem} options for the preprocessor.  In this case,
7713 the compiler appends @samp{include} to the prefix.
7715 The run-time support file @file{libgcc.a} can also be searched for using
7716 the @option{-B} prefix, if needed.  If it is not found there, the two
7717 standard prefixes above are tried, and that is all.  The file is left
7718 out of the link if it is not found by those means.
7720 Another way to specify a prefix much like the @option{-B} prefix is to use
7721 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7722 Variables}.
7724 As a special kludge, if the path provided by @option{-B} is
7725 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7726 9, then it will be replaced by @file{[dir/]include}.  This is to help
7727 with boot-strapping the compiler.
7729 @item -specs=@var{file}
7730 @opindex specs
7731 Process @var{file} after the compiler reads in the standard @file{specs}
7732 file, in order to override the defaults that the @file{gcc} driver
7733 program uses when determining what switches to pass to @file{cc1},
7734 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7735 @option{-specs=@var{file}} can be specified on the command line, and they
7736 are processed in order, from left to right.
7738 @item --sysroot=@var{dir}
7739 @opindex sysroot
7740 Use @var{dir} as the logical root directory for headers and libraries.
7741 For example, if the compiler would normally search for headers in
7742 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7743 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7745 If you use both this option and the @option{-isysroot} option, then
7746 the @option{--sysroot} option will apply to libraries, but the
7747 @option{-isysroot} option will apply to header files.
7749 The GNU linker (beginning with version 2.16) has the necessary support
7750 for this option.  If your linker does not support this option, the
7751 header file aspect of @option{--sysroot} will still work, but the
7752 library aspect will not.
7754 @item -I-
7755 @opindex I-
7756 This option has been deprecated.  Please use @option{-iquote} instead for
7757 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7758 Any directories you specify with @option{-I} options before the @option{-I-}
7759 option are searched only for the case of @samp{#include "@var{file}"};
7760 they are not searched for @samp{#include <@var{file}>}.
7762 If additional directories are specified with @option{-I} options after
7763 the @option{-I-}, these directories are searched for all @samp{#include}
7764 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7765 this way.)
7767 In addition, the @option{-I-} option inhibits the use of the current
7768 directory (where the current input file came from) as the first search
7769 directory for @samp{#include "@var{file}"}.  There is no way to
7770 override this effect of @option{-I-}.  With @option{-I.} you can specify
7771 searching the directory which was current when the compiler was
7772 invoked.  That is not exactly the same as what the preprocessor does
7773 by default, but it is often satisfactory.
7775 @option{-I-} does not inhibit the use of the standard system directories
7776 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7777 independent.
7778 @end table
7780 @c man end
7782 @node Spec Files
7783 @section Specifying subprocesses and the switches to pass to them
7784 @cindex Spec Files
7786 @command{gcc} is a driver program.  It performs its job by invoking a
7787 sequence of other programs to do the work of compiling, assembling and
7788 linking.  GCC interprets its command-line parameters and uses these to
7789 deduce which programs it should invoke, and which command-line options
7790 it ought to place on their command lines.  This behavior is controlled
7791 by @dfn{spec strings}.  In most cases there is one spec string for each
7792 program that GCC can invoke, but a few programs have multiple spec
7793 strings to control their behavior.  The spec strings built into GCC can
7794 be overridden by using the @option{-specs=} command-line switch to specify
7795 a spec file.
7797 @dfn{Spec files} are plaintext files that are used to construct spec
7798 strings.  They consist of a sequence of directives separated by blank
7799 lines.  The type of directive is determined by the first non-whitespace
7800 character on the line and it can be one of the following:
7802 @table @code
7803 @item %@var{command}
7804 Issues a @var{command} to the spec file processor.  The commands that can
7805 appear here are:
7807 @table @code
7808 @item %include <@var{file}>
7809 @cindex %include
7810 Search for @var{file} and insert its text at the current point in the
7811 specs file.
7813 @item %include_noerr <@var{file}>
7814 @cindex %include_noerr
7815 Just like @samp{%include}, but do not generate an error message if the include
7816 file cannot be found.
7818 @item %rename @var{old_name} @var{new_name}
7819 @cindex %rename
7820 Rename the spec string @var{old_name} to @var{new_name}.
7822 @end table
7824 @item *[@var{spec_name}]:
7825 This tells the compiler to create, override or delete the named spec
7826 string.  All lines after this directive up to the next directive or
7827 blank line are considered to be the text for the spec string.  If this
7828 results in an empty string then the spec will be deleted.  (Or, if the
7829 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7830 does not currently exist a new spec will be created.  If the spec does
7831 exist then its contents will be overridden by the text of this
7832 directive, unless the first character of that text is the @samp{+}
7833 character, in which case the text will be appended to the spec.
7835 @item [@var{suffix}]:
7836 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7837 and up to the next directive or blank line are considered to make up the
7838 spec string for the indicated suffix.  When the compiler encounters an
7839 input file with the named suffix, it will processes the spec string in
7840 order to work out how to compile that file.  For example:
7842 @smallexample
7843 .ZZ:
7844 z-compile -input %i
7845 @end smallexample
7847 This says that any input file whose name ends in @samp{.ZZ} should be
7848 passed to the program @samp{z-compile}, which should be invoked with the
7849 command-line switch @option{-input} and with the result of performing the
7850 @samp{%i} substitution.  (See below.)
7852 As an alternative to providing a spec string, the text that follows a
7853 suffix directive can be one of the following:
7855 @table @code
7856 @item @@@var{language}
7857 This says that the suffix is an alias for a known @var{language}.  This is
7858 similar to using the @option{-x} command-line switch to GCC to specify a
7859 language explicitly.  For example:
7861 @smallexample
7862 .ZZ:
7863 @@c++
7864 @end smallexample
7866 Says that .ZZ files are, in fact, C++ source files.
7868 @item #@var{name}
7869 This causes an error messages saying:
7871 @smallexample
7872 @var{name} compiler not installed on this system.
7873 @end smallexample
7874 @end table
7876 GCC already has an extensive list of suffixes built into it.
7877 This directive will add an entry to the end of the list of suffixes, but
7878 since the list is searched from the end backwards, it is effectively
7879 possible to override earlier entries using this technique.
7881 @end table
7883 GCC has the following spec strings built into it.  Spec files can
7884 override these strings or create their own.  Note that individual
7885 targets can also add their own spec strings to this list.
7887 @smallexample
7888 asm          Options to pass to the assembler
7889 asm_final    Options to pass to the assembler post-processor
7890 cpp          Options to pass to the C preprocessor
7891 cc1          Options to pass to the C compiler
7892 cc1plus      Options to pass to the C++ compiler
7893 endfile      Object files to include at the end of the link
7894 link         Options to pass to the linker
7895 lib          Libraries to include on the command line to the linker
7896 libgcc       Decides which GCC support library to pass to the linker
7897 linker       Sets the name of the linker
7898 predefines   Defines to be passed to the C preprocessor
7899 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7900              by default
7901 startfile    Object files to include at the start of the link
7902 @end smallexample
7904 Here is a small example of a spec file:
7906 @smallexample
7907 %rename lib                 old_lib
7909 *lib:
7910 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7911 @end smallexample
7913 This example renames the spec called @samp{lib} to @samp{old_lib} and
7914 then overrides the previous definition of @samp{lib} with a new one.
7915 The new definition adds in some extra command-line options before
7916 including the text of the old definition.
7918 @dfn{Spec strings} are a list of command-line options to be passed to their
7919 corresponding program.  In addition, the spec strings can contain
7920 @samp{%}-prefixed sequences to substitute variable text or to
7921 conditionally insert text into the command line.  Using these constructs
7922 it is possible to generate quite complex command lines.
7924 Here is a table of all defined @samp{%}-sequences for spec
7925 strings.  Note that spaces are not generated automatically around the
7926 results of expanding these sequences.  Therefore you can concatenate them
7927 together or combine them with constant text in a single argument.
7929 @table @code
7930 @item %%
7931 Substitute one @samp{%} into the program name or argument.
7933 @item %i
7934 Substitute the name of the input file being processed.
7936 @item %b
7937 Substitute the basename of the input file being processed.
7938 This is the substring up to (and not including) the last period
7939 and not including the directory.
7941 @item %B
7942 This is the same as @samp{%b}, but include the file suffix (text after
7943 the last period).
7945 @item %d
7946 Marks the argument containing or following the @samp{%d} as a
7947 temporary file name, so that that file will be deleted if GCC exits
7948 successfully.  Unlike @samp{%g}, this contributes no text to the
7949 argument.
7951 @item %g@var{suffix}
7952 Substitute a file name that has suffix @var{suffix} and is chosen
7953 once per compilation, and mark the argument in the same way as
7954 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7955 name is now chosen in a way that is hard to predict even when previously
7956 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7957 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7958 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7959 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7960 was simply substituted with a file name chosen once per compilation,
7961 without regard to any appended suffix (which was therefore treated
7962 just like ordinary text), making such attacks more likely to succeed.
7964 @item %u@var{suffix}
7965 Like @samp{%g}, but generates a new temporary file name even if
7966 @samp{%u@var{suffix}} was already seen.
7968 @item %U@var{suffix}
7969 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7970 new one if there is no such last file name.  In the absence of any
7971 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7972 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7973 would involve the generation of two distinct file names, one
7974 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7975 simply substituted with a file name chosen for the previous @samp{%u},
7976 without regard to any appended suffix.
7978 @item %j@var{suffix}
7979 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7980 writable, and if save-temps is off; otherwise, substitute the name
7981 of a temporary file, just like @samp{%u}.  This temporary file is not
7982 meant for communication between processes, but rather as a junk
7983 disposal mechanism.
7985 @item %|@var{suffix}
7986 @itemx %m@var{suffix}
7987 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7988 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7989 all.  These are the two most common ways to instruct a program that it
7990 should read from standard input or write to standard output.  If you
7991 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7992 construct: see for example @file{f/lang-specs.h}.
7994 @item %.@var{SUFFIX}
7995 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7996 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7997 terminated by the next space or %.
7999 @item %w
8000 Marks the argument containing or following the @samp{%w} as the
8001 designated output file of this compilation.  This puts the argument
8002 into the sequence of arguments that @samp{%o} will substitute later.
8004 @item %o
8005 Substitutes the names of all the output files, with spaces
8006 automatically placed around them.  You should write spaces
8007 around the @samp{%o} as well or the results are undefined.
8008 @samp{%o} is for use in the specs for running the linker.
8009 Input files whose names have no recognized suffix are not compiled
8010 at all, but they are included among the output files, so they will
8011 be linked.
8013 @item %O
8014 Substitutes the suffix for object files.  Note that this is
8015 handled specially when it immediately follows @samp{%g, %u, or %U},
8016 because of the need for those to form complete file names.  The
8017 handling is such that @samp{%O} is treated exactly as if it had already
8018 been substituted, except that @samp{%g, %u, and %U} do not currently
8019 support additional @var{suffix} characters following @samp{%O} as they would
8020 following, for example, @samp{.o}.
8022 @item %p
8023 Substitutes the standard macro predefinitions for the
8024 current target machine.  Use this when running @code{cpp}.
8026 @item %P
8027 Like @samp{%p}, but puts @samp{__} before and after the name of each
8028 predefined macro, except for macros that start with @samp{__} or with
8029 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8032 @item %I
8033 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8034 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8035 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8036 and @option{-imultilib} as necessary.
8038 @item %s
8039 Current argument is the name of a library or startup file of some sort.
8040 Search for that file in a standard list of directories and substitute
8041 the full name found.
8043 @item %e@var{str}
8044 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8045 Use this when inconsistent options are detected.
8047 @item %(@var{name})
8048 Substitute the contents of spec string @var{name} at this point.
8050 @item %[@var{name}]
8051 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8053 @item %x@{@var{option}@}
8054 Accumulate an option for @samp{%X}.
8056 @item %X
8057 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8058 spec string.
8060 @item %Y
8061 Output the accumulated assembler options specified by @option{-Wa}.
8063 @item %Z
8064 Output the accumulated preprocessor options specified by @option{-Wp}.
8066 @item %a
8067 Process the @code{asm} spec.  This is used to compute the
8068 switches to be passed to the assembler.
8070 @item %A
8071 Process the @code{asm_final} spec.  This is a spec string for
8072 passing switches to an assembler post-processor, if such a program is
8073 needed.
8075 @item %l
8076 Process the @code{link} spec.  This is the spec for computing the
8077 command line passed to the linker.  Typically it will make use of the
8078 @samp{%L %G %S %D and %E} sequences.
8080 @item %D
8081 Dump out a @option{-L} option for each directory that GCC believes might
8082 contain startup files.  If the target supports multilibs then the
8083 current multilib directory will be prepended to each of these paths.
8085 @item %L
8086 Process the @code{lib} spec.  This is a spec string for deciding which
8087 libraries should be included on the command line to the linker.
8089 @item %G
8090 Process the @code{libgcc} spec.  This is a spec string for deciding
8091 which GCC support library should be included on the command line to the linker.
8093 @item %S
8094 Process the @code{startfile} spec.  This is a spec for deciding which
8095 object files should be the first ones passed to the linker.  Typically
8096 this might be a file named @file{crt0.o}.
8098 @item %E
8099 Process the @code{endfile} spec.  This is a spec string that specifies
8100 the last object files that will be passed to the linker.
8102 @item %C
8103 Process the @code{cpp} spec.  This is used to construct the arguments
8104 to be passed to the C preprocessor.
8106 @item %1
8107 Process the @code{cc1} spec.  This is used to construct the options to be
8108 passed to the actual C compiler (@samp{cc1}).
8110 @item %2
8111 Process the @code{cc1plus} spec.  This is used to construct the options to be
8112 passed to the actual C++ compiler (@samp{cc1plus}).
8114 @item %*
8115 Substitute the variable part of a matched option.  See below.
8116 Note that each comma in the substituted string is replaced by
8117 a single space.
8119 @item %<@code{S}
8120 Remove all occurrences of @code{-S} from the command line.  Note---this
8121 command is position dependent.  @samp{%} commands in the spec string
8122 before this one will see @code{-S}, @samp{%} commands in the spec string
8123 after this one will not.
8125 @item %:@var{function}(@var{args})
8126 Call the named function @var{function}, passing it @var{args}.
8127 @var{args} is first processed as a nested spec string, then split
8128 into an argument vector in the usual fashion.  The function returns
8129 a string which is processed as if it had appeared literally as part
8130 of the current spec.
8132 The following built-in spec functions are provided:
8134 @table @code
8135 @item @code{getenv}
8136 The @code{getenv} spec function takes two arguments: an environment
8137 variable name and a string.  If the environment variable is not
8138 defined, a fatal error is issued.  Otherwise, the return value is the
8139 value of the environment variable concatenated with the string.  For
8140 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8142 @smallexample
8143 %:getenv(TOPDIR /include)
8144 @end smallexample
8146 expands to @file{/path/to/top/include}.
8148 @item @code{if-exists}
8149 The @code{if-exists} spec function takes one argument, an absolute
8150 pathname to a file.  If the file exists, @code{if-exists} returns the
8151 pathname.  Here is a small example of its usage:
8153 @smallexample
8154 *startfile:
8155 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8156 @end smallexample
8158 @item @code{if-exists-else}
8159 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8160 spec function, except that it takes two arguments.  The first argument is
8161 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8162 returns the pathname.  If it does not exist, it returns the second argument.
8163 This way, @code{if-exists-else} can be used to select one file or another,
8164 based on the existence of the first.  Here is a small example of its usage:
8166 @smallexample
8167 *startfile:
8168 crt0%O%s %:if-exists(crti%O%s) \
8169 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8170 @end smallexample
8172 @item @code{replace-outfile}
8173 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8174 first argument in the outfiles array and replaces it with the second argument.  Here
8175 is a small example of its usage:
8177 @smallexample
8178 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8179 @end smallexample
8181 @item @code{print-asm-header}
8182 The @code{print-asm-header} function takes no arguments and simply
8183 prints a banner like:
8185 @smallexample
8186 Assembler options
8187 =================
8189 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8190 @end smallexample
8192 It is used to separate compiler options from assembler options
8193 in the @option{--target-help} output.
8194 @end table
8196 @item %@{@code{S}@}
8197 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8198 If that switch was not specified, this substitutes nothing.  Note that
8199 the leading dash is omitted when specifying this option, and it is
8200 automatically inserted if the substitution is performed.  Thus the spec
8201 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8202 and would output the command line option @option{-foo}.
8204 @item %W@{@code{S}@}
8205 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8206 deleted on failure.
8208 @item %@{@code{S}*@}
8209 Substitutes all the switches specified to GCC whose names start
8210 with @code{-S}, but which also take an argument.  This is used for
8211 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8212 GCC considers @option{-o foo} as being
8213 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8214 text, including the space.  Thus two arguments would be generated.
8216 @item %@{@code{S}*&@code{T}*@}
8217 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8218 (the order of @code{S} and @code{T} in the spec is not significant).
8219 There can be any number of ampersand-separated variables; for each the
8220 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8222 @item %@{@code{S}:@code{X}@}
8223 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8225 @item %@{!@code{S}:@code{X}@}
8226 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8228 @item %@{@code{S}*:@code{X}@}
8229 Substitutes @code{X} if one or more switches whose names start with
8230 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8231 once, no matter how many such switches appeared.  However, if @code{%*}
8232 appears somewhere in @code{X}, then @code{X} will be substituted once
8233 for each matching switch, with the @code{%*} replaced by the part of
8234 that switch that matched the @code{*}.
8236 @item %@{.@code{S}:@code{X}@}
8237 Substitutes @code{X}, if processing a file with suffix @code{S}.
8239 @item %@{!.@code{S}:@code{X}@}
8240 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8242 @item %@{,@code{S}:@code{X}@}
8243 Substitutes @code{X}, if processing a file for language @code{S}.
8245 @item %@{!,@code{S}:@code{X}@}
8246 Substitutes @code{X}, if not processing a file for language @code{S}.
8248 @item %@{@code{S}|@code{P}:@code{X}@}
8249 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8250 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8251 @code{*} sequences as well, although they have a stronger binding than
8252 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8253 alternatives must be starred, and only the first matching alternative
8254 is substituted.
8256 For example, a spec string like this:
8258 @smallexample
8259 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8260 @end smallexample
8262 will output the following command-line options from the following input
8263 command-line options:
8265 @smallexample
8266 fred.c        -foo -baz
8267 jim.d         -bar -boggle
8268 -d fred.c     -foo -baz -boggle
8269 -d jim.d      -bar -baz -boggle
8270 @end smallexample
8272 @item %@{S:X; T:Y; :D@}
8274 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8275 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8276 be as many clauses as you need.  This may be combined with @code{.},
8277 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8280 @end table
8282 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8283 construct may contain other nested @samp{%} constructs or spaces, or
8284 even newlines.  They are processed as usual, as described above.
8285 Trailing white space in @code{X} is ignored.  White space may also
8286 appear anywhere on the left side of the colon in these constructs,
8287 except between @code{.} or @code{*} and the corresponding word.
8289 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8290 handled specifically in these constructs.  If another value of
8291 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8292 @option{-W} switch is found later in the command line, the earlier
8293 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8294 just one letter, which passes all matching options.
8296 The character @samp{|} at the beginning of the predicate text is used to
8297 indicate that a command should be piped to the following command, but
8298 only if @option{-pipe} is specified.
8300 It is built into GCC which switches take arguments and which do not.
8301 (You might think it would be useful to generalize this to allow each
8302 compiler's spec to say which switches take arguments.  But this cannot
8303 be done in a consistent fashion.  GCC cannot even decide which input
8304 files have been specified without knowing which switches take arguments,
8305 and it must know which input files to compile in order to tell which
8306 compilers to run).
8308 GCC also knows implicitly that arguments starting in @option{-l} are to be
8309 treated as compiler output files, and passed to the linker in their
8310 proper position among the other output files.
8312 @c man begin OPTIONS
8314 @node Target Options
8315 @section Specifying Target Machine and Compiler Version
8316 @cindex target options
8317 @cindex cross compiling
8318 @cindex specifying machine version
8319 @cindex specifying compiler version and target machine
8320 @cindex compiler version, specifying
8321 @cindex target machine, specifying
8323 The usual way to run GCC is to run the executable called @file{gcc}, or
8324 @file{<machine>-gcc} when cross-compiling, or
8325 @file{<machine>-gcc-<version>} to run a version other than the one that
8326 was installed last.  Sometimes this is inconvenient, so GCC provides
8327 options that will switch to another cross-compiler or version.
8329 @table @gcctabopt
8330 @item -b @var{machine}
8331 @opindex b
8332 The argument @var{machine} specifies the target machine for compilation.
8334 The value to use for @var{machine} is the same as was specified as the
8335 machine type when configuring GCC as a cross-compiler.  For
8336 example, if a cross-compiler was configured with @samp{configure
8337 arm-elf}, meaning to compile for an arm processor with elf binaries,
8338 then you would specify @option{-b arm-elf} to run that cross compiler.
8339 Because there are other options beginning with @option{-b}, the
8340 configuration must contain a hyphen.
8342 @item -V @var{version}
8343 @opindex V
8344 The argument @var{version} specifies which version of GCC to run.
8345 This is useful when multiple versions are installed.  For example,
8346 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8347 @end table
8349 The @option{-V} and @option{-b} options work by running the
8350 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8351 use them if you can just run that directly.
8353 @node Submodel Options
8354 @section Hardware Models and Configurations
8355 @cindex submodel options
8356 @cindex specifying hardware config
8357 @cindex hardware models and configurations, specifying
8358 @cindex machine dependent options
8360 Earlier we discussed the standard option @option{-b} which chooses among
8361 different installed compilers for completely different target
8362 machines, such as VAX vs.@: 68000 vs.@: 80386.
8364 In addition, each of these target machine types can have its own
8365 special options, starting with @samp{-m}, to choose among various
8366 hardware models or configurations---for example, 68010 vs 68020,
8367 floating coprocessor or none.  A single installed version of the
8368 compiler can compile for any model or configuration, according to the
8369 options specified.
8371 Some configurations of the compiler also support additional special
8372 options, usually for compatibility with other compilers on the same
8373 platform.
8375 @c This list is ordered alphanumerically by subsection name.
8376 @c It should be the same order and spelling as these options are listed
8377 @c in Machine Dependent Options
8379 @menu
8380 * ARC Options::
8381 * ARM Options::
8382 * AVR Options::
8383 * Blackfin Options::
8384 * CRIS Options::
8385 * CRX Options::
8386 * Darwin Options::
8387 * DEC Alpha Options::
8388 * DEC Alpha/VMS Options::
8389 * FRV Options::
8390 * GNU/Linux Options::
8391 * H8/300 Options::
8392 * HPPA Options::
8393 * i386 and x86-64 Options::
8394 * IA-64 Options::
8395 * M32C Options::
8396 * M32R/D Options::
8397 * M680x0 Options::
8398 * M68hc1x Options::
8399 * MCore Options::
8400 * MIPS Options::
8401 * MMIX Options::
8402 * MN10300 Options::
8403 * MT Options::
8404 * PDP-11 Options::
8405 * PowerPC Options::
8406 * RS/6000 and PowerPC Options::
8407 * S/390 and zSeries Options::
8408 * Score Options::
8409 * SH Options::
8410 * SPARC Options::
8411 * SPU Options::
8412 * System V Options::
8413 * V850 Options::
8414 * VAX Options::
8415 * VxWorks Options::
8416 * x86-64 Options::
8417 * Xstormy16 Options::
8418 * Xtensa Options::
8419 * zSeries Options::
8420 @end menu
8422 @node ARC Options
8423 @subsection ARC Options
8424 @cindex ARC Options
8426 These options are defined for ARC implementations:
8428 @table @gcctabopt
8429 @item -EL
8430 @opindex EL
8431 Compile code for little endian mode.  This is the default.
8433 @item -EB
8434 @opindex EB
8435 Compile code for big endian mode.
8437 @item -mmangle-cpu
8438 @opindex mmangle-cpu
8439 Prepend the name of the cpu to all public symbol names.
8440 In multiple-processor systems, there are many ARC variants with different
8441 instruction and register set characteristics.  This flag prevents code
8442 compiled for one cpu to be linked with code compiled for another.
8443 No facility exists for handling variants that are ``almost identical''.
8444 This is an all or nothing option.
8446 @item -mcpu=@var{cpu}
8447 @opindex mcpu
8448 Compile code for ARC variant @var{cpu}.
8449 Which variants are supported depend on the configuration.
8450 All variants support @option{-mcpu=base}, this is the default.
8452 @item -mtext=@var{text-section}
8453 @itemx -mdata=@var{data-section}
8454 @itemx -mrodata=@var{readonly-data-section}
8455 @opindex mtext
8456 @opindex mdata
8457 @opindex mrodata
8458 Put functions, data, and readonly data in @var{text-section},
8459 @var{data-section}, and @var{readonly-data-section} respectively
8460 by default.  This can be overridden with the @code{section} attribute.
8461 @xref{Variable Attributes}.
8463 @end table
8465 @node ARM Options
8466 @subsection ARM Options
8467 @cindex ARM options
8469 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8470 architectures:
8472 @table @gcctabopt
8473 @item -mabi=@var{name}
8474 @opindex mabi
8475 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8476 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8478 @item -mapcs-frame
8479 @opindex mapcs-frame
8480 Generate a stack frame that is compliant with the ARM Procedure Call
8481 Standard for all functions, even if this is not strictly necessary for
8482 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8483 with this option will cause the stack frames not to be generated for
8484 leaf functions.  The default is @option{-mno-apcs-frame}.
8486 @item -mapcs
8487 @opindex mapcs
8488 This is a synonym for @option{-mapcs-frame}.
8490 @ignore
8491 @c not currently implemented
8492 @item -mapcs-stack-check
8493 @opindex mapcs-stack-check
8494 Generate code to check the amount of stack space available upon entry to
8495 every function (that actually uses some stack space).  If there is
8496 insufficient space available then either the function
8497 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8498 called, depending upon the amount of stack space required.  The run time
8499 system is required to provide these functions.  The default is
8500 @option{-mno-apcs-stack-check}, since this produces smaller code.
8502 @c not currently implemented
8503 @item -mapcs-float
8504 @opindex mapcs-float
8505 Pass floating point arguments using the float point registers.  This is
8506 one of the variants of the APCS@.  This option is recommended if the
8507 target hardware has a floating point unit or if a lot of floating point
8508 arithmetic is going to be performed by the code.  The default is
8509 @option{-mno-apcs-float}, since integer only code is slightly increased in
8510 size if @option{-mapcs-float} is used.
8512 @c not currently implemented
8513 @item -mapcs-reentrant
8514 @opindex mapcs-reentrant
8515 Generate reentrant, position independent code.  The default is
8516 @option{-mno-apcs-reentrant}.
8517 @end ignore
8519 @item -mthumb-interwork
8520 @opindex mthumb-interwork
8521 Generate code which supports calling between the ARM and Thumb
8522 instruction sets.  Without this option the two instruction sets cannot
8523 be reliably used inside one program.  The default is
8524 @option{-mno-thumb-interwork}, since slightly larger code is generated
8525 when @option{-mthumb-interwork} is specified.
8527 @item -mno-sched-prolog
8528 @opindex mno-sched-prolog
8529 Prevent the reordering of instructions in the function prolog, or the
8530 merging of those instruction with the instructions in the function's
8531 body.  This means that all functions will start with a recognizable set
8532 of instructions (or in fact one of a choice from a small set of
8533 different function prologues), and this information can be used to
8534 locate the start if functions inside an executable piece of code.  The
8535 default is @option{-msched-prolog}.
8537 @item -mhard-float
8538 @opindex mhard-float
8539 Generate output containing floating point instructions.  This is the
8540 default.
8542 @item -msoft-float
8543 @opindex msoft-float
8544 Generate output containing library calls for floating point.
8545 @strong{Warning:} the requisite libraries are not available for all ARM
8546 targets.  Normally the facilities of the machine's usual C compiler are
8547 used, but this cannot be done directly in cross-compilation.  You must make
8548 your own arrangements to provide suitable library functions for
8549 cross-compilation.
8551 @option{-msoft-float} changes the calling convention in the output file;
8552 therefore, it is only useful if you compile @emph{all} of a program with
8553 this option.  In particular, you need to compile @file{libgcc.a}, the
8554 library that comes with GCC, with @option{-msoft-float} in order for
8555 this to work.
8557 @item -mfloat-abi=@var{name}
8558 @opindex mfloat-abi
8559 Specifies which ABI to use for floating point values.  Permissible values
8560 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8562 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8563 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8564 of floating point instructions, but still uses the soft-float calling
8565 conventions.
8567 @item -mlittle-endian
8568 @opindex mlittle-endian
8569 Generate code for a processor running in little-endian mode.  This is
8570 the default for all standard configurations.
8572 @item -mbig-endian
8573 @opindex mbig-endian
8574 Generate code for a processor running in big-endian mode; the default is
8575 to compile code for a little-endian processor.
8577 @item -mwords-little-endian
8578 @opindex mwords-little-endian
8579 This option only applies when generating code for big-endian processors.
8580 Generate code for a little-endian word order but a big-endian byte
8581 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8582 option should only be used if you require compatibility with code for
8583 big-endian ARM processors generated by versions of the compiler prior to
8584 2.8.
8586 @item -mcpu=@var{name}
8587 @opindex mcpu
8588 This specifies the name of the target ARM processor.  GCC uses this name
8589 to determine what kind of instructions it can emit when generating
8590 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8591 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8592 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8593 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8594 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8595 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8596 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8597 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8598 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8599 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8600 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8601 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8602 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8603 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8604 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
8605 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8607 @itemx -mtune=@var{name}
8608 @opindex mtune
8609 This option is very similar to the @option{-mcpu=} option, except that
8610 instead of specifying the actual target processor type, and hence
8611 restricting which instructions can be used, it specifies that GCC should
8612 tune the performance of the code as if the target were of the type
8613 specified in this option, but still choosing the instructions that it
8614 will generate based on the cpu specified by a @option{-mcpu=} option.
8615 For some ARM implementations better performance can be obtained by using
8616 this option.
8618 @item -march=@var{name}
8619 @opindex march
8620 This specifies the name of the target ARM architecture.  GCC uses this
8621 name to determine what kind of instructions it can emit when generating
8622 assembly code.  This option can be used in conjunction with or instead
8623 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8624 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8625 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8626 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
8627 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
8629 @item -mfpu=@var{name}
8630 @itemx -mfpe=@var{number}
8631 @itemx -mfp=@var{number}
8632 @opindex mfpu
8633 @opindex mfpe
8634 @opindex mfp
8635 This specifies what floating point hardware (or hardware emulation) is
8636 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8637 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8638 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8639 with older versions of GCC@.
8641 If @option{-msoft-float} is specified this specifies the format of
8642 floating point values.
8644 @item -mstructure-size-boundary=@var{n}
8645 @opindex mstructure-size-boundary
8646 The size of all structures and unions will be rounded up to a multiple
8647 of the number of bits set by this option.  Permissible values are 8, 32
8648 and 64.  The default value varies for different toolchains.  For the COFF
8649 targeted toolchain the default value is 8.  A value of 64 is only allowed
8650 if the underlying ABI supports it.
8652 Specifying the larger number can produce faster, more efficient code, but
8653 can also increase the size of the program.  Different values are potentially
8654 incompatible.  Code compiled with one value cannot necessarily expect to
8655 work with code or libraries compiled with another value, if they exchange
8656 information using structures or unions.
8658 @item -mabort-on-noreturn
8659 @opindex mabort-on-noreturn
8660 Generate a call to the function @code{abort} at the end of a
8661 @code{noreturn} function.  It will be executed if the function tries to
8662 return.
8664 @item -mlong-calls
8665 @itemx -mno-long-calls
8666 @opindex mlong-calls
8667 @opindex mno-long-calls
8668 Tells the compiler to perform function calls by first loading the
8669 address of the function into a register and then performing a subroutine
8670 call on this register.  This switch is needed if the target function
8671 will lie outside of the 64 megabyte addressing range of the offset based
8672 version of subroutine call instruction.
8674 Even if this switch is enabled, not all function calls will be turned
8675 into long calls.  The heuristic is that static functions, functions
8676 which have the @samp{short-call} attribute, functions that are inside
8677 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8678 definitions have already been compiled within the current compilation
8679 unit, will not be turned into long calls.  The exception to this rule is
8680 that weak function definitions, functions with the @samp{long-call}
8681 attribute or the @samp{section} attribute, and functions that are within
8682 the scope of a @samp{#pragma long_calls} directive, will always be
8683 turned into long calls.
8685 This feature is not enabled by default.  Specifying
8686 @option{-mno-long-calls} will restore the default behavior, as will
8687 placing the function calls within the scope of a @samp{#pragma
8688 long_calls_off} directive.  Note these switches have no effect on how
8689 the compiler generates code to handle function calls via function
8690 pointers.
8692 @item -mnop-fun-dllimport
8693 @opindex mnop-fun-dllimport
8694 Disable support for the @code{dllimport} attribute.
8696 @item -msingle-pic-base
8697 @opindex msingle-pic-base
8698 Treat the register used for PIC addressing as read-only, rather than
8699 loading it in the prologue for each function.  The run-time system is
8700 responsible for initializing this register with an appropriate value
8701 before execution begins.
8703 @item -mpic-register=@var{reg}
8704 @opindex mpic-register
8705 Specify the register to be used for PIC addressing.  The default is R10
8706 unless stack-checking is enabled, when R9 is used.
8708 @item -mcirrus-fix-invalid-insns
8709 @opindex mcirrus-fix-invalid-insns
8710 @opindex mno-cirrus-fix-invalid-insns
8711 Insert NOPs into the instruction stream to in order to work around
8712 problems with invalid Maverick instruction combinations.  This option
8713 is only valid if the @option{-mcpu=ep9312} option has been used to
8714 enable generation of instructions for the Cirrus Maverick floating
8715 point co-processor.  This option is not enabled by default, since the
8716 problem is only present in older Maverick implementations.  The default
8717 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8718 switch.
8720 @item -mpoke-function-name
8721 @opindex mpoke-function-name
8722 Write the name of each function into the text section, directly
8723 preceding the function prologue.  The generated code is similar to this:
8725 @smallexample
8726      t0
8727          .ascii "arm_poke_function_name", 0
8728          .align
8729      t1
8730          .word 0xff000000 + (t1 - t0)
8731      arm_poke_function_name
8732          mov     ip, sp
8733          stmfd   sp!, @{fp, ip, lr, pc@}
8734          sub     fp, ip, #4
8735 @end smallexample
8737 When performing a stack backtrace, code can inspect the value of
8738 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8739 location @code{pc - 12} and the top 8 bits are set, then we know that
8740 there is a function name embedded immediately preceding this location
8741 and has length @code{((pc[-3]) & 0xff000000)}.
8743 @item -mthumb
8744 @opindex mthumb
8745 Generate code for the Thumb instruction set.  The default is to
8746 use the 32-bit ARM instruction set.
8747 This option automatically enables either 16-bit Thumb-1 or
8748 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8749 and @option{-march=@var{name}} options.
8751 @item -mtpcs-frame
8752 @opindex mtpcs-frame
8753 Generate a stack frame that is compliant with the Thumb Procedure Call
8754 Standard for all non-leaf functions.  (A leaf function is one that does
8755 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8757 @item -mtpcs-leaf-frame
8758 @opindex mtpcs-leaf-frame
8759 Generate a stack frame that is compliant with the Thumb Procedure Call
8760 Standard for all leaf functions.  (A leaf function is one that does
8761 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8763 @item -mcallee-super-interworking
8764 @opindex mcallee-super-interworking
8765 Gives all externally visible functions in the file being compiled an ARM
8766 instruction set header which switches to Thumb mode before executing the
8767 rest of the function.  This allows these functions to be called from
8768 non-interworking code.
8770 @item -mcaller-super-interworking
8771 @opindex mcaller-super-interworking
8772 Allows calls via function pointers (including virtual functions) to
8773 execute correctly regardless of whether the target code has been
8774 compiled for interworking or not.  There is a small overhead in the cost
8775 of executing a function pointer if this option is enabled.
8777 @item -mtp=@var{name}
8778 @opindex mtp
8779 Specify the access model for the thread local storage pointer.  The valid
8780 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8781 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8782 (supported in the arm6k architecture), and @option{auto}, which uses the
8783 best available method for the selected processor.  The default setting is
8784 @option{auto}.
8786 @end table
8788 @node AVR Options
8789 @subsection AVR Options
8790 @cindex AVR Options
8792 These options are defined for AVR implementations:
8794 @table @gcctabopt
8795 @item -mmcu=@var{mcu}
8796 @opindex mmcu
8797 Specify ATMEL AVR instruction set or MCU type.
8799 Instruction set avr1 is for the minimal AVR core, not supported by the C
8800 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8801 attiny11, attiny12, attiny15, attiny28).
8803 Instruction set avr2 (default) is for the classic AVR core with up to
8804 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8805 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8806 at90c8534, at90s8535).
8808 Instruction set avr3 is for the classic AVR core with up to 128K program
8809 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8811 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8812 memory space (MCU types: atmega8, atmega83, atmega85).
8814 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8815 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8816 atmega64, atmega128, at43usb355, at94k).
8818 @item -msize
8819 @opindex msize
8820 Output instruction sizes to the asm file.
8822 @item -minit-stack=@var{N}
8823 @opindex minit-stack
8824 Specify the initial stack address, which may be a symbol or numeric value,
8825 @samp{__stack} is the default.
8827 @item -mno-interrupts
8828 @opindex mno-interrupts
8829 Generated code is not compatible with hardware interrupts.
8830 Code size will be smaller.
8832 @item -mcall-prologues
8833 @opindex mcall-prologues
8834 Functions prologues/epilogues expanded as call to appropriate
8835 subroutines.  Code size will be smaller.
8837 @item -mno-tablejump
8838 @opindex mno-tablejump
8839 Do not generate tablejump insns which sometimes increase code size.
8841 @item -mtiny-stack
8842 @opindex mtiny-stack
8843 Change only the low 8 bits of the stack pointer.
8845 @item -mint8
8846 @opindex mint8
8847 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8848 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8849 and long long will be 4 bytes.  Please note that this option does not
8850 comply to the C standards, but it will provide you with smaller code
8851 size.
8852 @end table
8854 @node Blackfin Options
8855 @subsection Blackfin Options
8856 @cindex Blackfin Options
8858 @table @gcctabopt
8859 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8860 @opindex mcpu=
8861 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8862 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8863 @samp{bf525}, @samp{bf526}, @samp{bf527},
8864 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8865 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8866 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8867 @samp{bf561}.
8868 The optional @var{sirevision} specifies the silicon revision of the target
8869 Blackfin processor.  Any workarounds available for the targeted silicon revision
8870 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8871 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8872 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8873 hexadecimal digits representing the major and minor numbers in the silicon
8874 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8875 is not defined.  If @var{sirevision} is @samp{any}, the
8876 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8877 If this optional @var{sirevision} is not used, GCC assumes the latest known
8878 silicon revision of the targeted Blackfin processor.
8880 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8881 Only the processor macro is defined.
8882 Without this option, @samp{bf532} is used as the processor by default.
8883 The corresponding predefined processor macros for @var{cpu} is to
8884 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8885 provided by libgloss to be linked in if @option{-msim} is not given.
8887 @item -msim
8888 @opindex msim
8889 Specifies that the program will be run on the simulator.  This causes
8890 the simulator BSP provided by libgloss to be linked in.  This option
8891 has effect only for @samp{bfin-elf} toolchain.
8892 Certain other options, such as @option{-mid-shared-library} and
8893 @option{-mfdpic}, imply @option{-msim}.
8895 @item -momit-leaf-frame-pointer
8896 @opindex momit-leaf-frame-pointer
8897 Don't keep the frame pointer in a register for leaf functions.  This
8898 avoids the instructions to save, set up and restore frame pointers and
8899 makes an extra register available in leaf functions.  The option
8900 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8901 which might make debugging harder.
8903 @item -mspecld-anomaly
8904 @opindex mspecld-anomaly
8905 When enabled, the compiler will ensure that the generated code does not
8906 contain speculative loads after jump instructions. If this option is used,
8907 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8909 @item -mno-specld-anomaly
8910 @opindex mno-specld-anomaly
8911 Don't generate extra code to prevent speculative loads from occurring.
8913 @item -mcsync-anomaly
8914 @opindex mcsync-anomaly
8915 When enabled, the compiler will ensure that the generated code does not
8916 contain CSYNC or SSYNC instructions too soon after conditional branches.
8917 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8919 @item -mno-csync-anomaly
8920 @opindex mno-csync-anomaly
8921 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8922 occurring too soon after a conditional branch.
8924 @item -mlow-64k
8925 @opindex mlow-64k
8926 When enabled, the compiler is free to take advantage of the knowledge that
8927 the entire program fits into the low 64k of memory.
8929 @item -mno-low-64k
8930 @opindex mno-low-64k
8931 Assume that the program is arbitrarily large.  This is the default.
8933 @item -mstack-check-l1
8934 @opindex mstack-check-l1
8935 Do stack checking using information placed into L1 scratchpad memory by the
8936 uClinux kernel.
8938 @item -mid-shared-library
8939 @opindex mid-shared-library
8940 Generate code that supports shared libraries via the library ID method.
8941 This allows for execute in place and shared libraries in an environment
8942 without virtual memory management.  This option implies @option{-fPIC}.
8943 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8945 @item -mno-id-shared-library
8946 @opindex mno-id-shared-library
8947 Generate code that doesn't assume ID based shared libraries are being used.
8948 This is the default.
8950 @item -mleaf-id-shared-library
8951 @opindex mleaf-id-shared-library
8952 Generate code that supports shared libraries via the library ID method,
8953 but assumes that this library or executable won't link against any other
8954 ID shared libraries.  That allows the compiler to use faster code for jumps
8955 and calls.
8957 @item -mno-leaf-id-shared-library
8958 @opindex mno-leaf-id-shared-library
8959 Do not assume that the code being compiled won't link against any ID shared
8960 libraries.  Slower code will be generated for jump and call insns.
8962 @item -mshared-library-id=n
8963 @opindex mshared-library-id
8964 Specified the identification number of the ID based shared library being
8965 compiled.  Specifying a value of 0 will generate more compact code, specifying
8966 other values will force the allocation of that number to the current
8967 library but is no more space or time efficient than omitting this option.
8969 @item -msep-data
8970 @opindex msep-data
8971 Generate code that allows the data segment to be located in a different
8972 area of memory from the text segment.  This allows for execute in place in
8973 an environment without virtual memory management by eliminating relocations
8974 against the text section.
8976 @item -mno-sep-data
8977 @opindex mno-sep-data
8978 Generate code that assumes that the data segment follows the text segment.
8979 This is the default.
8981 @item -mlong-calls
8982 @itemx -mno-long-calls
8983 @opindex mlong-calls
8984 @opindex mno-long-calls
8985 Tells the compiler to perform function calls by first loading the
8986 address of the function into a register and then performing a subroutine
8987 call on this register.  This switch is needed if the target function
8988 will lie outside of the 24 bit addressing range of the offset based
8989 version of subroutine call instruction.
8991 This feature is not enabled by default.  Specifying
8992 @option{-mno-long-calls} will restore the default behavior.  Note these
8993 switches have no effect on how the compiler generates code to handle
8994 function calls via function pointers.
8996 @item -mfast-fp
8997 @opindex mfast-fp
8998 Link with the fast floating-point library. This library relaxes some of
8999 the IEEE floating-point standard's rules for checking inputs against
9000 Not-a-Number (NAN), in the interest of performance.
9002 @item -minline-plt
9003 @opindex minline-plt
9004 Enable inlining of PLT entries in function calls to functions that are
9005 not known to bind locally.  It has no effect without @option{-mfdpic}.
9006 @end table
9008 @node CRIS Options
9009 @subsection CRIS Options
9010 @cindex CRIS Options
9012 These options are defined specifically for the CRIS ports.
9014 @table @gcctabopt
9015 @item -march=@var{architecture-type}
9016 @itemx -mcpu=@var{architecture-type}
9017 @opindex march
9018 @opindex mcpu
9019 Generate code for the specified architecture.  The choices for
9020 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9021 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9022 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9023 @samp{v10}.
9025 @item -mtune=@var{architecture-type}
9026 @opindex mtune
9027 Tune to @var{architecture-type} everything applicable about the generated
9028 code, except for the ABI and the set of available instructions.  The
9029 choices for @var{architecture-type} are the same as for
9030 @option{-march=@var{architecture-type}}.
9032 @item -mmax-stack-frame=@var{n}
9033 @opindex mmax-stack-frame
9034 Warn when the stack frame of a function exceeds @var{n} bytes.
9036 @item -melinux-stacksize=@var{n}
9037 @opindex melinux-stacksize
9038 Only available with the @samp{cris-axis-aout} target.  Arranges for
9039 indications in the program to the kernel loader that the stack of the
9040 program should be set to @var{n} bytes.
9042 @item -metrax4
9043 @itemx -metrax100
9044 @opindex metrax4
9045 @opindex metrax100
9046 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9047 @option{-march=v3} and @option{-march=v8} respectively.
9049 @item -mmul-bug-workaround
9050 @itemx -mno-mul-bug-workaround
9051 @opindex mmul-bug-workaround
9052 @opindex mno-mul-bug-workaround
9053 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9054 models where it applies.  This option is active by default.
9056 @item -mpdebug
9057 @opindex mpdebug
9058 Enable CRIS-specific verbose debug-related information in the assembly
9059 code.  This option also has the effect to turn off the @samp{#NO_APP}
9060 formatted-code indicator to the assembler at the beginning of the
9061 assembly file.
9063 @item -mcc-init
9064 @opindex mcc-init
9065 Do not use condition-code results from previous instruction; always emit
9066 compare and test instructions before use of condition codes.
9068 @item -mno-side-effects
9069 @opindex mno-side-effects
9070 Do not emit instructions with side-effects in addressing modes other than
9071 post-increment.
9073 @item -mstack-align
9074 @itemx -mno-stack-align
9075 @itemx -mdata-align
9076 @itemx -mno-data-align
9077 @itemx -mconst-align
9078 @itemx -mno-const-align
9079 @opindex mstack-align
9080 @opindex mno-stack-align
9081 @opindex mdata-align
9082 @opindex mno-data-align
9083 @opindex mconst-align
9084 @opindex mno-const-align
9085 These options (no-options) arranges (eliminate arrangements) for the
9086 stack-frame, individual data and constants to be aligned for the maximum
9087 single data access size for the chosen CPU model.  The default is to
9088 arrange for 32-bit alignment.  ABI details such as structure layout are
9089 not affected by these options.
9091 @item -m32-bit
9092 @itemx -m16-bit
9093 @itemx -m8-bit
9094 @opindex m32-bit
9095 @opindex m16-bit
9096 @opindex m8-bit
9097 Similar to the stack- data- and const-align options above, these options
9098 arrange for stack-frame, writable data and constants to all be 32-bit,
9099 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9101 @item -mno-prologue-epilogue
9102 @itemx -mprologue-epilogue
9103 @opindex mno-prologue-epilogue
9104 @opindex mprologue-epilogue
9105 With @option{-mno-prologue-epilogue}, the normal function prologue and
9106 epilogue that sets up the stack-frame are omitted and no return
9107 instructions or return sequences are generated in the code.  Use this
9108 option only together with visual inspection of the compiled code: no
9109 warnings or errors are generated when call-saved registers must be saved,
9110 or storage for local variable needs to be allocated.
9112 @item -mno-gotplt
9113 @itemx -mgotplt
9114 @opindex mno-gotplt
9115 @opindex mgotplt
9116 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9117 instruction sequences that load addresses for functions from the PLT part
9118 of the GOT rather than (traditional on other architectures) calls to the
9119 PLT@.  The default is @option{-mgotplt}.
9121 @item -maout
9122 @opindex maout
9123 Legacy no-op option only recognized with the cris-axis-aout target.
9125 @item -melf
9126 @opindex melf
9127 Legacy no-op option only recognized with the cris-axis-elf and
9128 cris-axis-linux-gnu targets.
9130 @item -melinux
9131 @opindex melinux
9132 Only recognized with the cris-axis-aout target, where it selects a
9133 GNU/linux-like multilib, include files and instruction set for
9134 @option{-march=v8}.
9136 @item -mlinux
9137 @opindex mlinux
9138 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9140 @item -sim
9141 @opindex sim
9142 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9143 to link with input-output functions from a simulator library.  Code,
9144 initialized data and zero-initialized data are allocated consecutively.
9146 @item -sim2
9147 @opindex sim2
9148 Like @option{-sim}, but pass linker options to locate initialized data at
9149 0x40000000 and zero-initialized data at 0x80000000.
9150 @end table
9152 @node CRX Options
9153 @subsection CRX Options
9154 @cindex CRX Options
9156 These options are defined specifically for the CRX ports.
9158 @table @gcctabopt
9160 @item -mmac
9161 @opindex mmac
9162 Enable the use of multiply-accumulate instructions. Disabled by default.
9164 @item -mpush-args
9165 @opindex mpush-args
9166 Push instructions will be used to pass outgoing arguments when functions
9167 are called. Enabled by default.
9168 @end table
9170 @node Darwin Options
9171 @subsection Darwin Options
9172 @cindex Darwin options
9174 These options are defined for all architectures running the Darwin operating
9175 system.
9177 FSF GCC on Darwin does not create ``fat'' object files; it will create
9178 an object file for the single architecture that it was built to
9179 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9180 @option{-arch} options are used; it does so by running the compiler or
9181 linker multiple times and joining the results together with
9182 @file{lipo}.
9184 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9185 @samp{i686}) is determined by the flags that specify the ISA
9186 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9187 @option{-force_cpusubtype_ALL} option can be used to override this.
9189 The Darwin tools vary in their behavior when presented with an ISA
9190 mismatch.  The assembler, @file{as}, will only permit instructions to
9191 be used that are valid for the subtype of the file it is generating,
9192 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9193 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9194 and print an error if asked to create a shared library with a less
9195 restrictive subtype than its input files (for instance, trying to put
9196 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9197 for executables, @file{ld}, will quietly give the executable the most
9198 restrictive subtype of any of its input files.
9200 @table @gcctabopt
9201 @item -F@var{dir}
9202 @opindex F
9203 Add the framework directory @var{dir} to the head of the list of
9204 directories to be searched for header files.  These directories are
9205 interleaved with those specified by @option{-I} options and are
9206 scanned in a left-to-right order.
9208 A framework directory is a directory with frameworks in it.  A
9209 framework is a directory with a @samp{"Headers"} and/or
9210 @samp{"PrivateHeaders"} directory contained directly in it that ends
9211 in @samp{".framework"}.  The name of a framework is the name of this
9212 directory excluding the @samp{".framework"}.  Headers associated with
9213 the framework are found in one of those two directories, with
9214 @samp{"Headers"} being searched first.  A subframework is a framework
9215 directory that is in a framework's @samp{"Frameworks"} directory.
9216 Includes of subframework headers can only appear in a header of a
9217 framework that contains the subframework, or in a sibling subframework
9218 header.  Two subframeworks are siblings if they occur in the same
9219 framework.  A subframework should not have the same name as a
9220 framework, a warning will be issued if this is violated.  Currently a
9221 subframework cannot have subframeworks, in the future, the mechanism
9222 may be extended to support this.  The standard frameworks can be found
9223 in @samp{"/System/Library/Frameworks"} and
9224 @samp{"/Library/Frameworks"}.  An example include looks like
9225 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9226 the name of the framework and header.h is found in the
9227 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9229 @item -iframework@var{dir}
9230 @opindex iframework
9231 Like @option{-F} except the directory is a treated as a system
9232 directory.  The main difference between this @option{-iframework} and
9233 @option{-F} is that with @option{-iframework} the compiler does not
9234 warn about constructs contained within header files found via
9235 @var{dir}.  This option is valid only for the C family of languages.
9237 @item -gused
9238 @opindex gused
9239 Emit debugging information for symbols that are used.  For STABS
9240 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9241 This is by default ON@.
9243 @item -gfull
9244 @opindex gfull
9245 Emit debugging information for all symbols and types.
9247 @item -mmacosx-version-min=@var{version}
9248 The earliest version of MacOS X that this executable will run on
9249 is @var{version}.  Typical values of @var{version} include @code{10.1},
9250 @code{10.2}, and @code{10.3.9}.
9252 If the compiler was built to use the system's headers by default,
9253 then the default for this option is the system version on which the
9254 compiler is running, otherwise the default is to make choices which
9255 are compatible with as many systems and code bases as possible.
9257 @item -mkernel
9258 @opindex mkernel
9259 Enable kernel development mode.  The @option{-mkernel} option sets
9260 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9261 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9262 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9263 applicable.  This mode also sets @option{-mno-altivec},
9264 @option{-msoft-float}, @option{-fno-builtin} and
9265 @option{-mlong-branch} for PowerPC targets.
9267 @item -mone-byte-bool
9268 @opindex mone-byte-bool
9269 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9270 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9271 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9272 option has no effect on x86.
9274 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9275 to generate code that is not binary compatible with code generated
9276 without that switch.  Using this switch may require recompiling all
9277 other modules in a program, including system libraries.  Use this
9278 switch to conform to a non-default data model.
9280 @item -mfix-and-continue
9281 @itemx -ffix-and-continue
9282 @itemx -findirect-data
9283 @opindex mfix-and-continue
9284 @opindex ffix-and-continue
9285 @opindex findirect-data
9286 Generate code suitable for fast turn around development.  Needed to
9287 enable gdb to dynamically load @code{.o} files into already running
9288 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9289 are provided for backwards compatibility.
9291 @item -all_load
9292 @opindex all_load
9293 Loads all members of static archive libraries.
9294 See man ld(1) for more information.
9296 @item -arch_errors_fatal
9297 @opindex arch_errors_fatal
9298 Cause the errors having to do with files that have the wrong architecture
9299 to be fatal.
9301 @item -bind_at_load
9302 @opindex bind_at_load
9303 Causes the output file to be marked such that the dynamic linker will
9304 bind all undefined references when the file is loaded or launched.
9306 @item -bundle
9307 @opindex bundle
9308 Produce a Mach-o bundle format file.
9309 See man ld(1) for more information.
9311 @item -bundle_loader @var{executable}
9312 @opindex bundle_loader
9313 This option specifies the @var{executable} that will be loading the build
9314 output file being linked.  See man ld(1) for more information.
9316 @item -dynamiclib
9317 @opindex dynamiclib
9318 When passed this option, GCC will produce a dynamic library instead of
9319 an executable when linking, using the Darwin @file{libtool} command.
9321 @item -force_cpusubtype_ALL
9322 @opindex force_cpusubtype_ALL
9323 This causes GCC's output file to have the @var{ALL} subtype, instead of
9324 one controlled by the @option{-mcpu} or @option{-march} option.
9326 @item -allowable_client  @var{client_name}
9327 @itemx -client_name
9328 @itemx -compatibility_version
9329 @itemx -current_version
9330 @itemx -dead_strip
9331 @itemx -dependency-file
9332 @itemx -dylib_file
9333 @itemx -dylinker_install_name
9334 @itemx -dynamic
9335 @itemx -exported_symbols_list
9336 @itemx -filelist
9337 @itemx -flat_namespace
9338 @itemx -force_flat_namespace
9339 @itemx -headerpad_max_install_names
9340 @itemx -image_base
9341 @itemx -init
9342 @itemx -install_name
9343 @itemx -keep_private_externs
9344 @itemx -multi_module
9345 @itemx -multiply_defined
9346 @itemx -multiply_defined_unused
9347 @itemx -noall_load
9348 @itemx -no_dead_strip_inits_and_terms
9349 @itemx -nofixprebinding
9350 @itemx -nomultidefs
9351 @itemx -noprebind
9352 @itemx -noseglinkedit
9353 @itemx -pagezero_size
9354 @itemx -prebind
9355 @itemx -prebind_all_twolevel_modules
9356 @itemx -private_bundle
9357 @itemx -read_only_relocs
9358 @itemx -sectalign
9359 @itemx -sectobjectsymbols
9360 @itemx -whyload
9361 @itemx -seg1addr
9362 @itemx -sectcreate
9363 @itemx -sectobjectsymbols
9364 @itemx -sectorder
9365 @itemx -segaddr
9366 @itemx -segs_read_only_addr
9367 @itemx -segs_read_write_addr
9368 @itemx -seg_addr_table
9369 @itemx -seg_addr_table_filename
9370 @itemx -seglinkedit
9371 @itemx -segprot
9372 @itemx -segs_read_only_addr
9373 @itemx -segs_read_write_addr
9374 @itemx -single_module
9375 @itemx -static
9376 @itemx -sub_library
9377 @itemx -sub_umbrella
9378 @itemx -twolevel_namespace
9379 @itemx -umbrella
9380 @itemx -undefined
9381 @itemx -unexported_symbols_list
9382 @itemx -weak_reference_mismatches
9383 @itemx -whatsloaded
9385 @opindex allowable_client
9386 @opindex client_name
9387 @opindex compatibility_version
9388 @opindex current_version
9389 @opindex dead_strip
9390 @opindex dependency-file
9391 @opindex dylib_file
9392 @opindex dylinker_install_name
9393 @opindex dynamic
9394 @opindex exported_symbols_list
9395 @opindex filelist
9396 @opindex flat_namespace
9397 @opindex force_flat_namespace
9398 @opindex headerpad_max_install_names
9399 @opindex image_base
9400 @opindex init
9401 @opindex install_name
9402 @opindex keep_private_externs
9403 @opindex multi_module
9404 @opindex multiply_defined
9405 @opindex multiply_defined_unused
9406 @opindex noall_load
9407 @opindex no_dead_strip_inits_and_terms
9408 @opindex nofixprebinding
9409 @opindex nomultidefs
9410 @opindex noprebind
9411 @opindex noseglinkedit
9412 @opindex pagezero_size
9413 @opindex prebind
9414 @opindex prebind_all_twolevel_modules
9415 @opindex private_bundle
9416 @opindex read_only_relocs
9417 @opindex sectalign
9418 @opindex sectobjectsymbols
9419 @opindex whyload
9420 @opindex seg1addr
9421 @opindex sectcreate
9422 @opindex sectobjectsymbols
9423 @opindex sectorder
9424 @opindex segaddr
9425 @opindex segs_read_only_addr
9426 @opindex segs_read_write_addr
9427 @opindex seg_addr_table
9428 @opindex seg_addr_table_filename
9429 @opindex seglinkedit
9430 @opindex segprot
9431 @opindex segs_read_only_addr
9432 @opindex segs_read_write_addr
9433 @opindex single_module
9434 @opindex static
9435 @opindex sub_library
9436 @opindex sub_umbrella
9437 @opindex twolevel_namespace
9438 @opindex umbrella
9439 @opindex undefined
9440 @opindex unexported_symbols_list
9441 @opindex weak_reference_mismatches
9442 @opindex whatsloaded
9444 These options are passed to the Darwin linker.  The Darwin linker man page
9445 describes them in detail.
9446 @end table
9448 @node DEC Alpha Options
9449 @subsection DEC Alpha Options
9451 These @samp{-m} options are defined for the DEC Alpha implementations:
9453 @table @gcctabopt
9454 @item -mno-soft-float
9455 @itemx -msoft-float
9456 @opindex mno-soft-float
9457 @opindex msoft-float
9458 Use (do not use) the hardware floating-point instructions for
9459 floating-point operations.  When @option{-msoft-float} is specified,
9460 functions in @file{libgcc.a} will be used to perform floating-point
9461 operations.  Unless they are replaced by routines that emulate the
9462 floating-point operations, or compiled in such a way as to call such
9463 emulations routines, these routines will issue floating-point
9464 operations.   If you are compiling for an Alpha without floating-point
9465 operations, you must ensure that the library is built so as not to call
9466 them.
9468 Note that Alpha implementations without floating-point operations are
9469 required to have floating-point registers.
9471 @item -mfp-reg
9472 @itemx -mno-fp-regs
9473 @opindex mfp-reg
9474 @opindex mno-fp-regs
9475 Generate code that uses (does not use) the floating-point register set.
9476 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9477 register set is not used, floating point operands are passed in integer
9478 registers as if they were integers and floating-point results are passed
9479 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9480 so any function with a floating-point argument or return value called by code
9481 compiled with @option{-mno-fp-regs} must also be compiled with that
9482 option.
9484 A typical use of this option is building a kernel that does not use,
9485 and hence need not save and restore, any floating-point registers.
9487 @item -mieee
9488 @opindex mieee
9489 The Alpha architecture implements floating-point hardware optimized for
9490 maximum performance.  It is mostly compliant with the IEEE floating
9491 point standard.  However, for full compliance, software assistance is
9492 required.  This option generates code fully IEEE compliant code
9493 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9494 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9495 defined during compilation.  The resulting code is less efficient but is
9496 able to correctly support denormalized numbers and exceptional IEEE
9497 values such as not-a-number and plus/minus infinity.  Other Alpha
9498 compilers call this option @option{-ieee_with_no_inexact}.
9500 @item -mieee-with-inexact
9501 @opindex mieee-with-inexact
9502 This is like @option{-mieee} except the generated code also maintains
9503 the IEEE @var{inexact-flag}.  Turning on this option causes the
9504 generated code to implement fully-compliant IEEE math.  In addition to
9505 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9506 macro.  On some Alpha implementations the resulting code may execute
9507 significantly slower than the code generated by default.  Since there is
9508 very little code that depends on the @var{inexact-flag}, you should
9509 normally not specify this option.  Other Alpha compilers call this
9510 option @option{-ieee_with_inexact}.
9512 @item -mfp-trap-mode=@var{trap-mode}
9513 @opindex mfp-trap-mode
9514 This option controls what floating-point related traps are enabled.
9515 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9516 The trap mode can be set to one of four values:
9518 @table @samp
9519 @item n
9520 This is the default (normal) setting.  The only traps that are enabled
9521 are the ones that cannot be disabled in software (e.g., division by zero
9522 trap).
9524 @item u
9525 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9526 as well.
9528 @item su
9529 Like @samp{u}, but the instructions are marked to be safe for software
9530 completion (see Alpha architecture manual for details).
9532 @item sui
9533 Like @samp{su}, but inexact traps are enabled as well.
9534 @end table
9536 @item -mfp-rounding-mode=@var{rounding-mode}
9537 @opindex mfp-rounding-mode
9538 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9539 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9542 @table @samp
9543 @item n
9544 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9545 the nearest machine number or towards the even machine number in case
9546 of a tie.
9548 @item m
9549 Round towards minus infinity.
9551 @item c
9552 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9554 @item d
9555 Dynamic rounding mode.  A field in the floating point control register
9556 (@var{fpcr}, see Alpha architecture reference manual) controls the
9557 rounding mode in effect.  The C library initializes this register for
9558 rounding towards plus infinity.  Thus, unless your program modifies the
9559 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9560 @end table
9562 @item -mtrap-precision=@var{trap-precision}
9563 @opindex mtrap-precision
9564 In the Alpha architecture, floating point traps are imprecise.  This
9565 means without software assistance it is impossible to recover from a
9566 floating trap and program execution normally needs to be terminated.
9567 GCC can generate code that can assist operating system trap handlers
9568 in determining the exact location that caused a floating point trap.
9569 Depending on the requirements of an application, different levels of
9570 precisions can be selected:
9572 @table @samp
9573 @item p
9574 Program precision.  This option is the default and means a trap handler
9575 can only identify which program caused a floating point exception.
9577 @item f
9578 Function precision.  The trap handler can determine the function that
9579 caused a floating point exception.
9581 @item i
9582 Instruction precision.  The trap handler can determine the exact
9583 instruction that caused a floating point exception.
9584 @end table
9586 Other Alpha compilers provide the equivalent options called
9587 @option{-scope_safe} and @option{-resumption_safe}.
9589 @item -mieee-conformant
9590 @opindex mieee-conformant
9591 This option marks the generated code as IEEE conformant.  You must not
9592 use this option unless you also specify @option{-mtrap-precision=i} and either
9593 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9594 is to emit the line @samp{.eflag 48} in the function prologue of the
9595 generated assembly file.  Under DEC Unix, this has the effect that
9596 IEEE-conformant math library routines will be linked in.
9598 @item -mbuild-constants
9599 @opindex mbuild-constants
9600 Normally GCC examines a 32- or 64-bit integer constant to
9601 see if it can construct it from smaller constants in two or three
9602 instructions.  If it cannot, it will output the constant as a literal and
9603 generate code to load it from the data segment at runtime.
9605 Use this option to require GCC to construct @emph{all} integer constants
9606 using code, even if it takes more instructions (the maximum is six).
9608 You would typically use this option to build a shared library dynamic
9609 loader.  Itself a shared library, it must relocate itself in memory
9610 before it can find the variables and constants in its own data segment.
9612 @item -malpha-as
9613 @itemx -mgas
9614 @opindex malpha-as
9615 @opindex mgas
9616 Select whether to generate code to be assembled by the vendor-supplied
9617 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9619 @item -mbwx
9620 @itemx -mno-bwx
9621 @itemx -mcix
9622 @itemx -mno-cix
9623 @itemx -mfix
9624 @itemx -mno-fix
9625 @itemx -mmax
9626 @itemx -mno-max
9627 @opindex mbwx
9628 @opindex mno-bwx
9629 @opindex mcix
9630 @opindex mno-cix
9631 @opindex mfix
9632 @opindex mno-fix
9633 @opindex mmax
9634 @opindex mno-max
9635 Indicate whether GCC should generate code to use the optional BWX,
9636 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9637 sets supported by the CPU type specified via @option{-mcpu=} option or that
9638 of the CPU on which GCC was built if none was specified.
9640 @item -mfloat-vax
9641 @itemx -mfloat-ieee
9642 @opindex mfloat-vax
9643 @opindex mfloat-ieee
9644 Generate code that uses (does not use) VAX F and G floating point
9645 arithmetic instead of IEEE single and double precision.
9647 @item -mexplicit-relocs
9648 @itemx -mno-explicit-relocs
9649 @opindex mexplicit-relocs
9650 @opindex mno-explicit-relocs
9651 Older Alpha assemblers provided no way to generate symbol relocations
9652 except via assembler macros.  Use of these macros does not allow
9653 optimal instruction scheduling.  GNU binutils as of version 2.12
9654 supports a new syntax that allows the compiler to explicitly mark
9655 which relocations should apply to which instructions.  This option
9656 is mostly useful for debugging, as GCC detects the capabilities of
9657 the assembler when it is built and sets the default accordingly.
9659 @item -msmall-data
9660 @itemx -mlarge-data
9661 @opindex msmall-data
9662 @opindex mlarge-data
9663 When @option{-mexplicit-relocs} is in effect, static data is
9664 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9665 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9666 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9667 16-bit relocations off of the @code{$gp} register.  This limits the
9668 size of the small data area to 64KB, but allows the variables to be
9669 directly accessed via a single instruction.
9671 The default is @option{-mlarge-data}.  With this option the data area
9672 is limited to just below 2GB@.  Programs that require more than 2GB of
9673 data must use @code{malloc} or @code{mmap} to allocate the data in the
9674 heap instead of in the program's data segment.
9676 When generating code for shared libraries, @option{-fpic} implies
9677 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9679 @item -msmall-text
9680 @itemx -mlarge-text
9681 @opindex msmall-text
9682 @opindex mlarge-text
9683 When @option{-msmall-text} is used, the compiler assumes that the
9684 code of the entire program (or shared library) fits in 4MB, and is
9685 thus reachable with a branch instruction.  When @option{-msmall-data}
9686 is used, the compiler can assume that all local symbols share the
9687 same @code{$gp} value, and thus reduce the number of instructions
9688 required for a function call from 4 to 1.
9690 The default is @option{-mlarge-text}.
9692 @item -mcpu=@var{cpu_type}
9693 @opindex mcpu
9694 Set the instruction set and instruction scheduling parameters for
9695 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9696 style name or the corresponding chip number.  GCC supports scheduling
9697 parameters for the EV4, EV5 and EV6 family of processors and will
9698 choose the default values for the instruction set from the processor
9699 you specify.  If you do not specify a processor type, GCC will default
9700 to the processor on which the compiler was built.
9702 Supported values for @var{cpu_type} are
9704 @table @samp
9705 @item ev4
9706 @itemx ev45
9707 @itemx 21064
9708 Schedules as an EV4 and has no instruction set extensions.
9710 @item ev5
9711 @itemx 21164
9712 Schedules as an EV5 and has no instruction set extensions.
9714 @item ev56
9715 @itemx 21164a
9716 Schedules as an EV5 and supports the BWX extension.
9718 @item pca56
9719 @itemx 21164pc
9720 @itemx 21164PC
9721 Schedules as an EV5 and supports the BWX and MAX extensions.
9723 @item ev6
9724 @itemx 21264
9725 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9727 @item ev67
9728 @itemx 21264a
9729 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9730 @end table
9732 @item -mtune=@var{cpu_type}
9733 @opindex mtune
9734 Set only the instruction scheduling parameters for machine type
9735 @var{cpu_type}.  The instruction set is not changed.
9737 @item -mmemory-latency=@var{time}
9738 @opindex mmemory-latency
9739 Sets the latency the scheduler should assume for typical memory
9740 references as seen by the application.  This number is highly
9741 dependent on the memory access patterns used by the application
9742 and the size of the external cache on the machine.
9744 Valid options for @var{time} are
9746 @table @samp
9747 @item @var{number}
9748 A decimal number representing clock cycles.
9750 @item L1
9751 @itemx L2
9752 @itemx L3
9753 @itemx main
9754 The compiler contains estimates of the number of clock cycles for
9755 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9756 (also called Dcache, Scache, and Bcache), as well as to main memory.
9757 Note that L3 is only valid for EV5.
9759 @end table
9760 @end table
9762 @node DEC Alpha/VMS Options
9763 @subsection DEC Alpha/VMS Options
9765 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9767 @table @gcctabopt
9768 @item -mvms-return-codes
9769 @opindex mvms-return-codes
9770 Return VMS condition codes from main.  The default is to return POSIX
9771 style condition (e.g.@: error) codes.
9772 @end table
9774 @node FRV Options
9775 @subsection FRV Options
9776 @cindex FRV Options
9778 @table @gcctabopt
9779 @item -mgpr-32
9780 @opindex mgpr-32
9782 Only use the first 32 general purpose registers.
9784 @item -mgpr-64
9785 @opindex mgpr-64
9787 Use all 64 general purpose registers.
9789 @item -mfpr-32
9790 @opindex mfpr-32
9792 Use only the first 32 floating point registers.
9794 @item -mfpr-64
9795 @opindex mfpr-64
9797 Use all 64 floating point registers
9799 @item -mhard-float
9800 @opindex mhard-float
9802 Use hardware instructions for floating point operations.
9804 @item -msoft-float
9805 @opindex msoft-float
9807 Use library routines for floating point operations.
9809 @item -malloc-cc
9810 @opindex malloc-cc
9812 Dynamically allocate condition code registers.
9814 @item -mfixed-cc
9815 @opindex mfixed-cc
9817 Do not try to dynamically allocate condition code registers, only
9818 use @code{icc0} and @code{fcc0}.
9820 @item -mdword
9821 @opindex mdword
9823 Change ABI to use double word insns.
9825 @item -mno-dword
9826 @opindex mno-dword
9828 Do not use double word instructions.
9830 @item -mdouble
9831 @opindex mdouble
9833 Use floating point double instructions.
9835 @item -mno-double
9836 @opindex mno-double
9838 Do not use floating point double instructions.
9840 @item -mmedia
9841 @opindex mmedia
9843 Use media instructions.
9845 @item -mno-media
9846 @opindex mno-media
9848 Do not use media instructions.
9850 @item -mmuladd
9851 @opindex mmuladd
9853 Use multiply and add/subtract instructions.
9855 @item -mno-muladd
9856 @opindex mno-muladd
9858 Do not use multiply and add/subtract instructions.
9860 @item -mfdpic
9861 @opindex mfdpic
9863 Select the FDPIC ABI, that uses function descriptors to represent
9864 pointers to functions.  Without any PIC/PIE-related options, it
9865 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9866 assumes GOT entries and small data are within a 12-bit range from the
9867 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9868 are computed with 32 bits.
9869 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9871 @item -minline-plt
9872 @opindex minline-plt
9874 Enable inlining of PLT entries in function calls to functions that are
9875 not known to bind locally.  It has no effect without @option{-mfdpic}.
9876 It's enabled by default if optimizing for speed and compiling for
9877 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9878 optimization option such as @option{-O3} or above is present in the
9879 command line.
9881 @item -mTLS
9882 @opindex TLS
9884 Assume a large TLS segment when generating thread-local code.
9886 @item -mtls
9887 @opindex tls
9889 Do not assume a large TLS segment when generating thread-local code.
9891 @item -mgprel-ro
9892 @opindex mgprel-ro
9894 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9895 that is known to be in read-only sections.  It's enabled by default,
9896 except for @option{-fpic} or @option{-fpie}: even though it may help
9897 make the global offset table smaller, it trades 1 instruction for 4.
9898 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9899 one of which may be shared by multiple symbols, and it avoids the need
9900 for a GOT entry for the referenced symbol, so it's more likely to be a
9901 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9903 @item -multilib-library-pic
9904 @opindex multilib-library-pic
9906 Link with the (library, not FD) pic libraries.  It's implied by
9907 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9908 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9909 it explicitly.
9911 @item -mlinked-fp
9912 @opindex mlinked-fp
9914 Follow the EABI requirement of always creating a frame pointer whenever
9915 a stack frame is allocated.  This option is enabled by default and can
9916 be disabled with @option{-mno-linked-fp}.
9918 @item -mlong-calls
9919 @opindex mlong-calls
9921 Use indirect addressing to call functions outside the current
9922 compilation unit.  This allows the functions to be placed anywhere
9923 within the 32-bit address space.
9925 @item -malign-labels
9926 @opindex malign-labels
9928 Try to align labels to an 8-byte boundary by inserting nops into the
9929 previous packet.  This option only has an effect when VLIW packing
9930 is enabled.  It doesn't create new packets; it merely adds nops to
9931 existing ones.
9933 @item -mlibrary-pic
9934 @opindex mlibrary-pic
9936 Generate position-independent EABI code.
9938 @item -macc-4
9939 @opindex macc-4
9941 Use only the first four media accumulator registers.
9943 @item -macc-8
9944 @opindex macc-8
9946 Use all eight media accumulator registers.
9948 @item -mpack
9949 @opindex mpack
9951 Pack VLIW instructions.
9953 @item -mno-pack
9954 @opindex mno-pack
9956 Do not pack VLIW instructions.
9958 @item -mno-eflags
9959 @opindex mno-eflags
9961 Do not mark ABI switches in e_flags.
9963 @item -mcond-move
9964 @opindex mcond-move
9966 Enable the use of conditional-move instructions (default).
9968 This switch is mainly for debugging the compiler and will likely be removed
9969 in a future version.
9971 @item -mno-cond-move
9972 @opindex mno-cond-move
9974 Disable the use of conditional-move instructions.
9976 This switch is mainly for debugging the compiler and will likely be removed
9977 in a future version.
9979 @item -mscc
9980 @opindex mscc
9982 Enable the use of conditional set instructions (default).
9984 This switch is mainly for debugging the compiler and will likely be removed
9985 in a future version.
9987 @item -mno-scc
9988 @opindex mno-scc
9990 Disable the use of conditional set instructions.
9992 This switch is mainly for debugging the compiler and will likely be removed
9993 in a future version.
9995 @item -mcond-exec
9996 @opindex mcond-exec
9998 Enable the use of conditional execution (default).
10000 This switch is mainly for debugging the compiler and will likely be removed
10001 in a future version.
10003 @item -mno-cond-exec
10004 @opindex mno-cond-exec
10006 Disable the use of conditional execution.
10008 This switch is mainly for debugging the compiler and will likely be removed
10009 in a future version.
10011 @item -mvliw-branch
10012 @opindex mvliw-branch
10014 Run a pass to pack branches into VLIW instructions (default).
10016 This switch is mainly for debugging the compiler and will likely be removed
10017 in a future version.
10019 @item -mno-vliw-branch
10020 @opindex mno-vliw-branch
10022 Do not run a pass to pack branches into VLIW instructions.
10024 This switch is mainly for debugging the compiler and will likely be removed
10025 in a future version.
10027 @item -mmulti-cond-exec
10028 @opindex mmulti-cond-exec
10030 Enable optimization of @code{&&} and @code{||} in conditional execution
10031 (default).
10033 This switch is mainly for debugging the compiler and will likely be removed
10034 in a future version.
10036 @item -mno-multi-cond-exec
10037 @opindex mno-multi-cond-exec
10039 Disable optimization of @code{&&} and @code{||} in conditional execution.
10041 This switch is mainly for debugging the compiler and will likely be removed
10042 in a future version.
10044 @item -mnested-cond-exec
10045 @opindex mnested-cond-exec
10047 Enable nested conditional execution optimizations (default).
10049 This switch is mainly for debugging the compiler and will likely be removed
10050 in a future version.
10052 @item -mno-nested-cond-exec
10053 @opindex mno-nested-cond-exec
10055 Disable nested conditional execution optimizations.
10057 This switch is mainly for debugging the compiler and will likely be removed
10058 in a future version.
10060 @item -moptimize-membar
10061 @opindex moptimize-membar
10063 This switch removes redundant @code{membar} instructions from the
10064 compiler generated code.  It is enabled by default.
10066 @item -mno-optimize-membar
10067 @opindex mno-optimize-membar
10069 This switch disables the automatic removal of redundant @code{membar}
10070 instructions from the generated code.
10072 @item -mtomcat-stats
10073 @opindex mtomcat-stats
10075 Cause gas to print out tomcat statistics.
10077 @item -mcpu=@var{cpu}
10078 @opindex mcpu
10080 Select the processor type for which to generate code.  Possible values are
10081 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10082 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10084 @end table
10086 @node GNU/Linux Options
10087 @subsection GNU/Linux Options
10089 These @samp{-m} options are defined for GNU/Linux targets:
10091 @table @gcctabopt
10092 @item -mglibc
10093 @opindex mglibc
10094 Use the GNU C library instead of uClibc.  This is the default except
10095 on @samp{*-*-linux-*uclibc*} targets.
10097 @item -muclibc
10098 @opindex muclibc
10099 Use uClibc instead of the GNU C library.  This is the default on
10100 @samp{*-*-linux-*uclibc*} targets.
10101 @end table
10103 @node H8/300 Options
10104 @subsection H8/300 Options
10106 These @samp{-m} options are defined for the H8/300 implementations:
10108 @table @gcctabopt
10109 @item -mrelax
10110 @opindex mrelax
10111 Shorten some address references at link time, when possible; uses the
10112 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10113 ld, Using ld}, for a fuller description.
10115 @item -mh
10116 @opindex mh
10117 Generate code for the H8/300H@.
10119 @item -ms
10120 @opindex ms
10121 Generate code for the H8S@.
10123 @item -mn
10124 @opindex mn
10125 Generate code for the H8S and H8/300H in the normal mode.  This switch
10126 must be used either with @option{-mh} or @option{-ms}.
10128 @item -ms2600
10129 @opindex ms2600
10130 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10132 @item -mint32
10133 @opindex mint32
10134 Make @code{int} data 32 bits by default.
10136 @item -malign-300
10137 @opindex malign-300
10138 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10139 The default for the H8/300H and H8S is to align longs and floats on 4
10140 byte boundaries.
10141 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10142 This option has no effect on the H8/300.
10143 @end table
10145 @node HPPA Options
10146 @subsection HPPA Options
10147 @cindex HPPA Options
10149 These @samp{-m} options are defined for the HPPA family of computers:
10151 @table @gcctabopt
10152 @item -march=@var{architecture-type}
10153 @opindex march
10154 Generate code for the specified architecture.  The choices for
10155 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10156 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10157 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10158 architecture option for your machine.  Code compiled for lower numbered
10159 architectures will run on higher numbered architectures, but not the
10160 other way around.
10162 @item -mpa-risc-1-0
10163 @itemx -mpa-risc-1-1
10164 @itemx -mpa-risc-2-0
10165 @opindex mpa-risc-1-0
10166 @opindex mpa-risc-1-1
10167 @opindex mpa-risc-2-0
10168 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10170 @item -mbig-switch
10171 @opindex mbig-switch
10172 Generate code suitable for big switch tables.  Use this option only if
10173 the assembler/linker complain about out of range branches within a switch
10174 table.
10176 @item -mjump-in-delay
10177 @opindex mjump-in-delay
10178 Fill delay slots of function calls with unconditional jump instructions
10179 by modifying the return pointer for the function call to be the target
10180 of the conditional jump.
10182 @item -mdisable-fpregs
10183 @opindex mdisable-fpregs
10184 Prevent floating point registers from being used in any manner.  This is
10185 necessary for compiling kernels which perform lazy context switching of
10186 floating point registers.  If you use this option and attempt to perform
10187 floating point operations, the compiler will abort.
10189 @item -mdisable-indexing
10190 @opindex mdisable-indexing
10191 Prevent the compiler from using indexing address modes.  This avoids some
10192 rather obscure problems when compiling MIG generated code under MACH@.
10194 @item -mno-space-regs
10195 @opindex mno-space-regs
10196 Generate code that assumes the target has no space registers.  This allows
10197 GCC to generate faster indirect calls and use unscaled index address modes.
10199 Such code is suitable for level 0 PA systems and kernels.
10201 @item -mfast-indirect-calls
10202 @opindex mfast-indirect-calls
10203 Generate code that assumes calls never cross space boundaries.  This
10204 allows GCC to emit code which performs faster indirect calls.
10206 This option will not work in the presence of shared libraries or nested
10207 functions.
10209 @item -mfixed-range=@var{register-range}
10210 @opindex mfixed-range
10211 Generate code treating the given register range as fixed registers.
10212 A fixed register is one that the register allocator can not use.  This is
10213 useful when compiling kernel code.  A register range is specified as
10214 two registers separated by a dash.  Multiple register ranges can be
10215 specified separated by a comma.
10217 @item -mlong-load-store
10218 @opindex mlong-load-store
10219 Generate 3-instruction load and store sequences as sometimes required by
10220 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10221 the HP compilers.
10223 @item -mportable-runtime
10224 @opindex mportable-runtime
10225 Use the portable calling conventions proposed by HP for ELF systems.
10227 @item -mgas
10228 @opindex mgas
10229 Enable the use of assembler directives only GAS understands.
10231 @item -mschedule=@var{cpu-type}
10232 @opindex mschedule
10233 Schedule code according to the constraints for the machine type
10234 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10235 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10236 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10237 proper scheduling option for your machine.  The default scheduling is
10238 @samp{8000}.
10240 @item -mlinker-opt
10241 @opindex mlinker-opt
10242 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10243 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10244 linkers in which they give bogus error messages when linking some programs.
10246 @item -msoft-float
10247 @opindex msoft-float
10248 Generate output containing library calls for floating point.
10249 @strong{Warning:} the requisite libraries are not available for all HPPA
10250 targets.  Normally the facilities of the machine's usual C compiler are
10251 used, but this cannot be done directly in cross-compilation.  You must make
10252 your own arrangements to provide suitable library functions for
10253 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
10254 does provide software floating point support.
10256 @option{-msoft-float} changes the calling convention in the output file;
10257 therefore, it is only useful if you compile @emph{all} of a program with
10258 this option.  In particular, you need to compile @file{libgcc.a}, the
10259 library that comes with GCC, with @option{-msoft-float} in order for
10260 this to work.
10262 @item -msio
10263 @opindex msio
10264 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10265 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10266 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10267 options are available under HP-UX and HI-UX@.
10269 @item -mgnu-ld
10270 @opindex gnu-ld
10271 Use GNU ld specific options.  This passes @option{-shared} to ld when
10272 building a shared library.  It is the default when GCC is configured,
10273 explicitly or implicitly, with the GNU linker.  This option does not
10274 have any affect on which ld is called, it only changes what parameters
10275 are passed to that ld.  The ld that is called is determined by the
10276 @option{--with-ld} configure option, GCC's program search path, and
10277 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10278 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10279 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10281 @item -mhp-ld
10282 @opindex hp-ld
10283 Use HP ld specific options.  This passes @option{-b} to ld when building
10284 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10285 links.  It is the default when GCC is configured, explicitly or
10286 implicitly, with the HP linker.  This option does not have any affect on
10287 which ld is called, it only changes what parameters are passed to that
10288 ld.  The ld that is called is determined by the @option{--with-ld}
10289 configure option, GCC's program search path, and finally by the user's
10290 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10291 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10292 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10294 @item -mlong-calls
10295 @opindex mno-long-calls
10296 Generate code that uses long call sequences.  This ensures that a call
10297 is always able to reach linker generated stubs.  The default is to generate
10298 long calls only when the distance from the call site to the beginning
10299 of the function or translation unit, as the case may be, exceeds a
10300 predefined limit set by the branch type being used.  The limits for
10301 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10302 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10303 240,000 bytes.
10305 Distances are measured from the beginning of functions when using the
10306 @option{-ffunction-sections} option, or when using the @option{-mgas}
10307 and @option{-mno-portable-runtime} options together under HP-UX with
10308 the SOM linker.
10310 It is normally not desirable to use this option as it will degrade
10311 performance.  However, it may be useful in large applications,
10312 particularly when partial linking is used to build the application.
10314 The types of long calls used depends on the capabilities of the
10315 assembler and linker, and the type of code being generated.  The
10316 impact on systems that support long absolute calls, and long pic
10317 symbol-difference or pc-relative calls should be relatively small.
10318 However, an indirect call is used on 32-bit ELF systems in pic code
10319 and it is quite long.
10321 @item -munix=@var{unix-std}
10322 @opindex march
10323 Generate compiler predefines and select a startfile for the specified
10324 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10325 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10326 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10327 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10328 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10329 and later.
10331 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10332 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10333 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10334 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10335 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10336 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10338 It is @emph{important} to note that this option changes the interfaces
10339 for various library routines.  It also affects the operational behavior
10340 of the C library.  Thus, @emph{extreme} care is needed in using this
10341 option.
10343 Library code that is intended to operate with more than one UNIX
10344 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10345 as appropriate.  Most GNU software doesn't provide this capability.
10347 @item -nolibdld
10348 @opindex nolibdld
10349 Suppress the generation of link options to search libdld.sl when the
10350 @option{-static} option is specified on HP-UX 10 and later.
10352 @item -static
10353 @opindex static
10354 The HP-UX implementation of setlocale in libc has a dependency on
10355 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10356 when the @option{-static} option is specified, special link options
10357 are needed to resolve this dependency.
10359 On HP-UX 10 and later, the GCC driver adds the necessary options to
10360 link with libdld.sl when the @option{-static} option is specified.
10361 This causes the resulting binary to be dynamic.  On the 64-bit port,
10362 the linkers generate dynamic binaries by default in any case.  The
10363 @option{-nolibdld} option can be used to prevent the GCC driver from
10364 adding these link options.
10366 @item -threads
10367 @opindex threads
10368 Add support for multithreading with the @dfn{dce thread} library
10369 under HP-UX@.  This option sets flags for both the preprocessor and
10370 linker.
10371 @end table
10373 @node i386 and x86-64 Options
10374 @subsection Intel 386 and AMD x86-64 Options
10375 @cindex i386 Options
10376 @cindex x86-64 Options
10377 @cindex Intel 386 Options
10378 @cindex AMD x86-64 Options
10380 These @samp{-m} options are defined for the i386 and x86-64 family of
10381 computers:
10383 @table @gcctabopt
10384 @item -mtune=@var{cpu-type}
10385 @opindex mtune
10386 Tune to @var{cpu-type} everything applicable about the generated code, except
10387 for the ABI and the set of available instructions.  The choices for
10388 @var{cpu-type} are:
10389 @table @emph
10390 @item generic
10391 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10392 If you know the CPU on which your code will run, then you should use
10393 the corresponding @option{-mtune} option instead of
10394 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10395 of your application will have, then you should use this option.
10397 As new processors are deployed in the marketplace, the behavior of this
10398 option will change.  Therefore, if you upgrade to a newer version of
10399 GCC, the code generated option will change to reflect the processors
10400 that were most common when that version of GCC was released.
10402 There is no @option{-march=generic} option because @option{-march}
10403 indicates the instruction set the compiler can use, and there is no
10404 generic instruction set applicable to all processors.  In contrast,
10405 @option{-mtune} indicates the processor (or, in this case, collection of
10406 processors) for which the code is optimized.
10407 @item native
10408 This selects the CPU to tune for at compilation time by determining
10409 the processor type of the compiling machine.  Using @option{-mtune=native}
10410 will produce code optimized for the local machine under the constraints
10411 of the selected instruction set.  Using @option{-march=native} will
10412 enable all instruction subsets supported by the local machine (hence
10413 the result might not run on different machines).
10414 @item i386
10415 Original Intel's i386 CPU@.
10416 @item i486
10417 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10418 @item i586, pentium
10419 Intel Pentium CPU with no MMX support.
10420 @item pentium-mmx
10421 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10422 @item pentiumpro
10423 Intel PentiumPro CPU@.
10424 @item i686
10425 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10426 instruction set will be used, so the code will run on all i686 family chips.
10427 @item pentium2
10428 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10429 @item pentium3, pentium3m
10430 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10431 support.
10432 @item pentium-m
10433 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10434 support.  Used by Centrino notebooks.
10435 @item pentium4, pentium4m
10436 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10437 @item prescott
10438 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10439 set support.
10440 @item nocona
10441 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10442 SSE2 and SSE3 instruction set support.
10443 @item core2
10444 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10445 instruction set support.
10446 @item k6
10447 AMD K6 CPU with MMX instruction set support.
10448 @item k6-2, k6-3
10449 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10450 @item athlon, athlon-tbird
10451 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10452 support.
10453 @item athlon-4, athlon-xp, athlon-mp
10454 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10455 instruction set support.
10456 @item k8, opteron, athlon64, athlon-fx
10457 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10458 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10459 @item k8-sse3, opteron-sse3, athlon64-sse3
10460 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10461 @item amdfam10, barcelona
10462 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10463 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10464 instruction set extensions.)
10465 @item winchip-c6
10466 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10467 set support.
10468 @item winchip2
10469 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10470 instruction set support.
10471 @item c3
10472 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10473 implemented for this chip.)
10474 @item c3-2
10475 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10476 implemented for this chip.)
10477 @item geode
10478 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10479 @end table
10481 While picking a specific @var{cpu-type} will schedule things appropriately
10482 for that particular chip, the compiler will not generate any code that
10483 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10484 being used.
10486 @item -march=@var{cpu-type}
10487 @opindex march
10488 Generate instructions for the machine type @var{cpu-type}.  The choices
10489 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10490 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10492 @item -mcpu=@var{cpu-type}
10493 @opindex mcpu
10494 A deprecated synonym for @option{-mtune}.
10496 @item -mfpmath=@var{unit}
10497 @opindex march
10498 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10499 for @var{unit} are:
10501 @table @samp
10502 @item 387
10503 Use the standard 387 floating point coprocessor present majority of chips and
10504 emulated otherwise.  Code compiled with this option will run almost everywhere.
10505 The temporary results are computed in 80bit precision instead of precision
10506 specified by the type resulting in slightly different results compared to most
10507 of other chips.  See @option{-ffloat-store} for more detailed description.
10509 This is the default choice for i386 compiler.
10511 @item sse
10512 Use scalar floating point instructions present in the SSE instruction set.
10513 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10514 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10515 instruction set supports only single precision arithmetics, thus the double and
10516 extended precision arithmetics is still done using 387.  Later version, present
10517 only in Pentium4 and the future AMD x86-64 chips supports double precision
10518 arithmetics too.
10520 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10521 or @option{-msse2} switches to enable SSE extensions and make this option
10522 effective.  For the x86-64 compiler, these extensions are enabled by default.
10524 The resulting code should be considerably faster in the majority of cases and avoid
10525 the numerical instability problems of 387 code, but may break some existing
10526 code that expects temporaries to be 80bit.
10528 This is the default choice for the x86-64 compiler.
10530 @item sse,387
10531 Attempt to utilize both instruction sets at once.  This effectively double the
10532 amount of available registers and on chips with separate execution units for
10533 387 and SSE the execution resources too.  Use this option with care, as it is
10534 still experimental, because the GCC register allocator does not model separate
10535 functional units well resulting in instable performance.
10536 @end table
10538 @item -masm=@var{dialect}
10539 @opindex masm=@var{dialect}
10540 Output asm instructions using selected @var{dialect}.  Supported
10541 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10542 not support @samp{intel}.
10544 @item -mieee-fp
10545 @itemx -mno-ieee-fp
10546 @opindex mieee-fp
10547 @opindex mno-ieee-fp
10548 Control whether or not the compiler uses IEEE floating point
10549 comparisons.  These handle correctly the case where the result of a
10550 comparison is unordered.
10552 @item -msoft-float
10553 @opindex msoft-float
10554 Generate output containing library calls for floating point.
10555 @strong{Warning:} the requisite libraries are not part of GCC@.
10556 Normally the facilities of the machine's usual C compiler are used, but
10557 this can't be done directly in cross-compilation.  You must make your
10558 own arrangements to provide suitable library functions for
10559 cross-compilation.
10561 On machines where a function returns floating point results in the 80387
10562 register stack, some floating point opcodes may be emitted even if
10563 @option{-msoft-float} is used.
10565 @item -mno-fp-ret-in-387
10566 @opindex mno-fp-ret-in-387
10567 Do not use the FPU registers for return values of functions.
10569 The usual calling convention has functions return values of types
10570 @code{float} and @code{double} in an FPU register, even if there
10571 is no FPU@.  The idea is that the operating system should emulate
10572 an FPU@.
10574 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10575 in ordinary CPU registers instead.
10577 @item -mno-fancy-math-387
10578 @opindex mno-fancy-math-387
10579 Some 387 emulators do not support the @code{sin}, @code{cos} and
10580 @code{sqrt} instructions for the 387.  Specify this option to avoid
10581 generating those instructions.  This option is the default on FreeBSD,
10582 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10583 indicates that the target cpu will always have an FPU and so the
10584 instruction will not need emulation.  As of revision 2.6.1, these
10585 instructions are not generated unless you also use the
10586 @option{-funsafe-math-optimizations} switch.
10588 @item -malign-double
10589 @itemx -mno-align-double
10590 @opindex malign-double
10591 @opindex mno-align-double
10592 Control whether GCC aligns @code{double}, @code{long double}, and
10593 @code{long long} variables on a two word boundary or a one word
10594 boundary.  Aligning @code{double} variables on a two word boundary will
10595 produce code that runs somewhat faster on a @samp{Pentium} at the
10596 expense of more memory.
10598 On x86-64, @option{-malign-double} is enabled by default.
10600 @strong{Warning:} if you use the @option{-malign-double} switch,
10601 structures containing the above types will be aligned differently than
10602 the published application binary interface specifications for the 386
10603 and will not be binary compatible with structures in code compiled
10604 without that switch.
10606 @item -m96bit-long-double
10607 @itemx -m128bit-long-double
10608 @opindex m96bit-long-double
10609 @opindex m128bit-long-double
10610 These switches control the size of @code{long double} type.  The i386
10611 application binary interface specifies the size to be 96 bits,
10612 so @option{-m96bit-long-double} is the default in 32 bit mode.
10614 Modern architectures (Pentium and newer) would prefer @code{long double}
10615 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10616 conforming to the ABI, this would not be possible.  So specifying a
10617 @option{-m128bit-long-double} will align @code{long double}
10618 to a 16 byte boundary by padding the @code{long double} with an additional
10619 32 bit zero.
10621 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10622 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10624 Notice that neither of these options enable any extra precision over the x87
10625 standard of 80 bits for a @code{long double}.
10627 @strong{Warning:} if you override the default value for your target ABI, the
10628 structures and arrays containing @code{long double} variables will change
10629 their size as well as function calling convention for function taking
10630 @code{long double} will be modified.  Hence they will not be binary
10631 compatible with arrays or structures in code compiled without that switch.
10633 @item -mmlarge-data-threshold=@var{number}
10634 @opindex mlarge-data-threshold=@var{number}
10635 When @option{-mcmodel=medium} is specified, the data greater than
10636 @var{threshold} are placed in large data section.  This value must be the
10637 same across all object linked into the binary and defaults to 65535.
10639 @item -mrtd
10640 @opindex mrtd
10641 Use a different function-calling convention, in which functions that
10642 take a fixed number of arguments return with the @code{ret} @var{num}
10643 instruction, which pops their arguments while returning.  This saves one
10644 instruction in the caller since there is no need to pop the arguments
10645 there.
10647 You can specify that an individual function is called with this calling
10648 sequence with the function attribute @samp{stdcall}.  You can also
10649 override the @option{-mrtd} option by using the function attribute
10650 @samp{cdecl}.  @xref{Function Attributes}.
10652 @strong{Warning:} this calling convention is incompatible with the one
10653 normally used on Unix, so you cannot use it if you need to call
10654 libraries compiled with the Unix compiler.
10656 Also, you must provide function prototypes for all functions that
10657 take variable numbers of arguments (including @code{printf});
10658 otherwise incorrect code will be generated for calls to those
10659 functions.
10661 In addition, seriously incorrect code will result if you call a
10662 function with too many arguments.  (Normally, extra arguments are
10663 harmlessly ignored.)
10665 @item -mregparm=@var{num}
10666 @opindex mregparm
10667 Control how many registers are used to pass integer arguments.  By
10668 default, no registers are used to pass arguments, and at most 3
10669 registers can be used.  You can control this behavior for a specific
10670 function by using the function attribute @samp{regparm}.
10671 @xref{Function Attributes}.
10673 @strong{Warning:} if you use this switch, and
10674 @var{num} is nonzero, then you must build all modules with the same
10675 value, including any libraries.  This includes the system libraries and
10676 startup modules.
10678 @item -msseregparm
10679 @opindex msseregparm
10680 Use SSE register passing conventions for float and double arguments
10681 and return values.  You can control this behavior for a specific
10682 function by using the function attribute @samp{sseregparm}.
10683 @xref{Function Attributes}.
10685 @strong{Warning:} if you use this switch then you must build all
10686 modules with the same value, including any libraries.  This includes
10687 the system libraries and startup modules.
10689 @item -mpc32
10690 @itemx -mpc64
10691 @itemx -mpc80
10692 @opindex mpc32
10693 @opindex mpc64
10694 @opindex mpc80
10696 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10697 is specified, the significands of results of floating-point operations are
10698 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10699 significands of results of floating-point operations to 53 bits (double
10700 precision) and @option{-mpc80} rounds the significands of results of
10701 floating-point operations to 64 bits (extended double precision), which is
10702 the default.  When this option is used, floating-point operations in higher
10703 precisions are not available to the programmer without setting the FPU
10704 control word explicitly.
10706 Setting the rounding of floating-point operations to less than the default
10707 80 bits can speed some programs by 2% or more.  Note that some mathematical
10708 libraries assume that extended precision (80 bit) floating-point operations
10709 are enabled by default; routines in such libraries could suffer significant
10710 loss of accuracy, typically through so-called "catastrophic cancellation",
10711 when this option is used to set the precision to less than extended precision. 
10713 @item -mstackrealign
10714 @opindex mstackrealign
10715 Realign the stack at entry.  On the Intel x86, the
10716 @option{-mstackrealign} option will generate an alternate prologue and
10717 epilogue that realigns the runtime stack.  This supports mixing legacy
10718 codes that keep a 4-byte aligned stack with modern codes that keep a
10719 16-byte stack for SSE compatibility.  The alternate prologue and
10720 epilogue are slower and bigger than the regular ones, and the
10721 alternate prologue requires an extra scratch register; this lowers the
10722 number of registers available if used in conjunction with the
10723 @code{regparm} attribute.  The @option{-mstackrealign} option is
10724 incompatible with the nested function prologue; this is considered a
10725 hard error.  See also the attribute @code{force_align_arg_pointer},
10726 applicable to individual functions.
10728 @item -mpreferred-stack-boundary=@var{num}
10729 @opindex mpreferred-stack-boundary
10730 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10731 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10732 the default is 4 (16 bytes or 128 bits).
10734 On Pentium and PentiumPro, @code{double} and @code{long double} values
10735 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10736 suffer significant run time performance penalties.  On Pentium III, the
10737 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10738 properly if it is not 16 byte aligned.
10740 To ensure proper alignment of this values on the stack, the stack boundary
10741 must be as aligned as that required by any value stored on the stack.
10742 Further, every function must be generated such that it keeps the stack
10743 aligned.  Thus calling a function compiled with a higher preferred
10744 stack boundary from a function compiled with a lower preferred stack
10745 boundary will most likely misalign the stack.  It is recommended that
10746 libraries that use callbacks always use the default setting.
10748 This extra alignment does consume extra stack space, and generally
10749 increases code size.  Code that is sensitive to stack space usage, such
10750 as embedded systems and operating system kernels, may want to reduce the
10751 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10753 @item -mmmx
10754 @itemx -mno-mmx
10755 @item -msse
10756 @itemx -mno-sse
10757 @item -msse2
10758 @itemx -mno-sse2
10759 @item -msse3
10760 @itemx -mno-sse3
10761 @item -mssse3
10762 @itemx -mno-ssse3
10763 @item -msse4.1
10764 @itemx -mno-sse4.1
10765 @item -msse4.2
10766 @itemx -mno-sse4.2
10767 @item -msse4
10768 @itemx -mno-sse4
10769 @item -msse4a
10770 @item -mno-sse4a
10771 @item -msse5
10772 @itemx -mno-sse5
10773 @item -m3dnow
10774 @itemx -mno-3dnow
10775 @item -mpopcnt
10776 @itemx -mno-popcnt
10777 @item -mabm
10778 @itemx -mno-abm
10779 @opindex mmmx
10780 @opindex mno-mmx
10781 @opindex msse
10782 @opindex mno-sse
10783 @opindex m3dnow
10784 @opindex mno-3dnow
10785 These switches enable or disable the use of instructions in the MMX,
10786 SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4A, SSE5, ABM or 3DNow!@: extended
10787 instruction sets.
10788 These extensions are also available as built-in functions: see
10789 @ref{X86 Built-in Functions}, for details of the functions enabled and
10790 disabled by these switches.
10792 To have SSE/SSE2 instructions generated automatically from floating-point
10793 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10795 These options will enable GCC to use these extended instructions in
10796 generated code, even without @option{-mfpmath=sse}.  Applications which
10797 perform runtime CPU detection must compile separate files for each
10798 supported architecture, using the appropriate flags.  In particular,
10799 the file containing the CPU detection code should be compiled without
10800 these options.
10802 @item -mcx16
10803 @opindex mcx16
10804 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10805 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10806 data types.  This is useful for high resolution counters that could be updated
10807 by multiple processors (or cores).  This instruction is generated as part of
10808 atomic built-in functions: see @ref{Atomic Builtins} for details.
10810 @item -msahf
10811 @opindex msahf
10812 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10813 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10814 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10815 SAHF are load and store instructions, respectively, for certain status flags.
10816 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10817 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10819 @item -mrecip
10820 @opindex mrecip
10821 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10822 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10823 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10824 variants) for single precision floating point arguments.  These instructions
10825 are generated only when @option{-funsafe-math-optimizations} is enabled
10826 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10827 Note that while the throughput of the sequence is higher than the throughput
10828 of the non-reciprocal instruction, the precision of the sequence can be
10829 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10831 @item -mveclibabi=@var{type}
10832 @opindex mveclibabi
10833 Specifies the ABI type to use for vectorizing intrinsics using an
10834 external library.  Supported types are @code{acml} for the AMD
10835 math core library style of interfacing.  GCC will currently emit
10836 calls to @code{__vrd2_sin}, @code{__vrd2_cos}, @code{__vrd2_exp},
10837 @code{__vrd2_log}, @code{__vrd2_log2}, @code{__vrd2_log10},
10838 @code{__vrs4_sinf}, @code{__vrs4_cosf}, @code{__vrs4_expf},
10839 @code{__vrs4_logf}, @code{__vrs4_log2f}, @code{__vrs4_log10f}
10840 and @code{__vrs4_powf} when using this type and @option{-ftree-vectorize}
10841 is enabled.  A ACML ABI compatible library will have to be specified
10842 at link time.
10844 @item -mpush-args
10845 @itemx -mno-push-args
10846 @opindex mpush-args
10847 @opindex mno-push-args
10848 Use PUSH operations to store outgoing parameters.  This method is shorter
10849 and usually equally fast as method using SUB/MOV operations and is enabled
10850 by default.  In some cases disabling it may improve performance because of
10851 improved scheduling and reduced dependencies.
10853 @item -maccumulate-outgoing-args
10854 @opindex maccumulate-outgoing-args
10855 If enabled, the maximum amount of space required for outgoing arguments will be
10856 computed in the function prologue.  This is faster on most modern CPUs
10857 because of reduced dependencies, improved scheduling and reduced stack usage
10858 when preferred stack boundary is not equal to 2.  The drawback is a notable
10859 increase in code size.  This switch implies @option{-mno-push-args}.
10861 @item -mthreads
10862 @opindex mthreads
10863 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10864 on thread-safe exception handling must compile and link all code with the
10865 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10866 @option{-D_MT}; when linking, it links in a special thread helper library
10867 @option{-lmingwthrd} which cleans up per thread exception handling data.
10869 @item -mno-align-stringops
10870 @opindex mno-align-stringops
10871 Do not align destination of inlined string operations.  This switch reduces
10872 code size and improves performance in case the destination is already aligned,
10873 but GCC doesn't know about it.
10875 @item -minline-all-stringops
10876 @opindex minline-all-stringops
10877 By default GCC inlines string operations only when destination is known to be
10878 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10879 size, but may improve performance of code that depends on fast memcpy, strlen
10880 and memset for short lengths.
10882 @item -minline-stringops-dynamically
10883 @opindex minline-stringops-dynamically
10884 For string operation of unknown size, inline runtime checks so for small
10885 blocks inline code is used, while for large blocks library call is used.
10887 @item -mstringop-strategy=@var{alg}
10888 @opindex mstringop-strategy=@var{alg}
10889 Overwrite internal decision heuristic about particular algorithm to inline
10890 string operation with.  The allowed values are @code{rep_byte},
10891 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10892 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10893 expanding inline loop, @code{libcall} for always expanding library call.
10895 @item -momit-leaf-frame-pointer
10896 @opindex momit-leaf-frame-pointer
10897 Don't keep the frame pointer in a register for leaf functions.  This
10898 avoids the instructions to save, set up and restore frame pointers and
10899 makes an extra register available in leaf functions.  The option
10900 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10901 which might make debugging harder.
10903 @item -mtls-direct-seg-refs
10904 @itemx -mno-tls-direct-seg-refs
10905 @opindex mtls-direct-seg-refs
10906 Controls whether TLS variables may be accessed with offsets from the
10907 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10908 or whether the thread base pointer must be added.  Whether or not this
10909 is legal depends on the operating system, and whether it maps the
10910 segment to cover the entire TLS area.
10912 For systems that use GNU libc, the default is on.
10914 @item -mfused-madd
10915 @itemx -mno-fused-madd
10916 @opindex mfused-madd
10917 Enable automatic generation of fused floating point multiply-add instructions
10918 if the ISA supports such instructions.  The -mfused-madd option is on by
10919 default.  The fused multiply-add instructions have a different
10920 rounding behavior compared to executing a multiply followed by an add.
10921 @end table
10923 These @samp{-m} switches are supported in addition to the above
10924 on AMD x86-64 processors in 64-bit environments.
10926 @table @gcctabopt
10927 @item -m32
10928 @itemx -m64
10929 @opindex m32
10930 @opindex m64
10931 Generate code for a 32-bit or 64-bit environment.
10932 The 32-bit environment sets int, long and pointer to 32 bits and
10933 generates code that runs on any i386 system.
10934 The 64-bit environment sets int to 32 bits and long and pointer
10935 to 64 bits and generates code for AMD's x86-64 architecture. For
10936 darwin only the -m64 option turns off the @option{-fno-pic} and
10937 @option{-mdynamic-no-pic} options.
10939 @item -mno-red-zone
10940 @opindex no-red-zone
10941 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10942 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10943 stack pointer that will not be modified by signal or interrupt handlers
10944 and therefore can be used for temporary data without adjusting the stack
10945 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10947 @item -mcmodel=small
10948 @opindex mcmodel=small
10949 Generate code for the small code model: the program and its symbols must
10950 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10951 Programs can be statically or dynamically linked.  This is the default
10952 code model.
10954 @item -mcmodel=kernel
10955 @opindex mcmodel=kernel
10956 Generate code for the kernel code model.  The kernel runs in the
10957 negative 2 GB of the address space.
10958 This model has to be used for Linux kernel code.
10960 @item -mcmodel=medium
10961 @opindex mcmodel=medium
10962 Generate code for the medium model: The program is linked in the lower 2
10963 GB of the address space but symbols can be located anywhere in the
10964 address space.  Programs can be statically or dynamically linked, but
10965 building of shared libraries are not supported with the medium model.
10967 @item -mcmodel=large
10968 @opindex mcmodel=large
10969 Generate code for the large model: This model makes no assumptions
10970 about addresses and sizes of sections.
10971 @end table
10973 @node IA-64 Options
10974 @subsection IA-64 Options
10975 @cindex IA-64 Options
10977 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10979 @table @gcctabopt
10980 @item -mbig-endian
10981 @opindex mbig-endian
10982 Generate code for a big endian target.  This is the default for HP-UX@.
10984 @item -mlittle-endian
10985 @opindex mlittle-endian
10986 Generate code for a little endian target.  This is the default for AIX5
10987 and GNU/Linux.
10989 @item -mgnu-as
10990 @itemx -mno-gnu-as
10991 @opindex mgnu-as
10992 @opindex mno-gnu-as
10993 Generate (or don't) code for the GNU assembler.  This is the default.
10994 @c Also, this is the default if the configure option @option{--with-gnu-as}
10995 @c is used.
10997 @item -mgnu-ld
10998 @itemx -mno-gnu-ld
10999 @opindex mgnu-ld
11000 @opindex mno-gnu-ld
11001 Generate (or don't) code for the GNU linker.  This is the default.
11002 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11003 @c is used.
11005 @item -mno-pic
11006 @opindex mno-pic
11007 Generate code that does not use a global pointer register.  The result
11008 is not position independent code, and violates the IA-64 ABI@.
11010 @item -mvolatile-asm-stop
11011 @itemx -mno-volatile-asm-stop
11012 @opindex mvolatile-asm-stop
11013 @opindex mno-volatile-asm-stop
11014 Generate (or don't) a stop bit immediately before and after volatile asm
11015 statements.
11017 @item -mregister-names
11018 @itemx -mno-register-names
11019 @opindex mregister-names
11020 @opindex mno-register-names
11021 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11022 the stacked registers.  This may make assembler output more readable.
11024 @item -mno-sdata
11025 @itemx -msdata
11026 @opindex mno-sdata
11027 @opindex msdata
11028 Disable (or enable) optimizations that use the small data section.  This may
11029 be useful for working around optimizer bugs.
11031 @item -mconstant-gp
11032 @opindex mconstant-gp
11033 Generate code that uses a single constant global pointer value.  This is
11034 useful when compiling kernel code.
11036 @item -mauto-pic
11037 @opindex mauto-pic
11038 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11039 This is useful when compiling firmware code.
11041 @item -minline-float-divide-min-latency
11042 @opindex minline-float-divide-min-latency
11043 Generate code for inline divides of floating point values
11044 using the minimum latency algorithm.
11046 @item -minline-float-divide-max-throughput
11047 @opindex minline-float-divide-max-throughput
11048 Generate code for inline divides of floating point values
11049 using the maximum throughput algorithm.
11051 @item -minline-int-divide-min-latency
11052 @opindex minline-int-divide-min-latency
11053 Generate code for inline divides of integer values
11054 using the minimum latency algorithm.
11056 @item -minline-int-divide-max-throughput
11057 @opindex minline-int-divide-max-throughput
11058 Generate code for inline divides of integer values
11059 using the maximum throughput algorithm.
11061 @item -minline-sqrt-min-latency
11062 @opindex minline-sqrt-min-latency
11063 Generate code for inline square roots
11064 using the minimum latency algorithm.
11066 @item -minline-sqrt-max-throughput
11067 @opindex minline-sqrt-max-throughput
11068 Generate code for inline square roots
11069 using the maximum throughput algorithm.
11071 @item -mno-dwarf2-asm
11072 @itemx -mdwarf2-asm
11073 @opindex mno-dwarf2-asm
11074 @opindex mdwarf2-asm
11075 Don't (or do) generate assembler code for the DWARF2 line number debugging
11076 info.  This may be useful when not using the GNU assembler.
11078 @item -mearly-stop-bits
11079 @itemx -mno-early-stop-bits
11080 @opindex mearly-stop-bits
11081 @opindex mno-early-stop-bits
11082 Allow stop bits to be placed earlier than immediately preceding the
11083 instruction that triggered the stop bit.  This can improve instruction
11084 scheduling, but does not always do so.
11086 @item -mfixed-range=@var{register-range}
11087 @opindex mfixed-range
11088 Generate code treating the given register range as fixed registers.
11089 A fixed register is one that the register allocator can not use.  This is
11090 useful when compiling kernel code.  A register range is specified as
11091 two registers separated by a dash.  Multiple register ranges can be
11092 specified separated by a comma.
11094 @item -mtls-size=@var{tls-size}
11095 @opindex mtls-size
11096 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11099 @item -mtune=@var{cpu-type}
11100 @opindex mtune
11101 Tune the instruction scheduling for a particular CPU, Valid values are
11102 itanium, itanium1, merced, itanium2, and mckinley.
11104 @item -mt
11105 @itemx -pthread
11106 @opindex mt
11107 @opindex pthread
11108 Add support for multithreading using the POSIX threads library.  This
11109 option sets flags for both the preprocessor and linker.  It does
11110 not affect the thread safety of object code produced by the compiler or
11111 that of libraries supplied with it.  These are HP-UX specific flags.
11113 @item -milp32
11114 @itemx -mlp64
11115 @opindex milp32
11116 @opindex mlp64
11117 Generate code for a 32-bit or 64-bit environment.
11118 The 32-bit environment sets int, long and pointer to 32 bits.
11119 The 64-bit environment sets int to 32 bits and long and pointer
11120 to 64 bits.  These are HP-UX specific flags.
11122 @item -mno-sched-br-data-spec
11123 @itemx -msched-br-data-spec
11124 @opindex mno-sched-br-data-spec
11125 @opindex msched-br-data-spec
11126 (Dis/En)able data speculative scheduling before reload.
11127 This will result in generation of the ld.a instructions and
11128 the corresponding check instructions (ld.c / chk.a).
11129 The default is 'disable'.
11131 @item -msched-ar-data-spec
11132 @itemx -mno-sched-ar-data-spec
11133 @opindex msched-ar-data-spec
11134 @opindex mno-sched-ar-data-spec
11135 (En/Dis)able data speculative scheduling after reload.
11136 This will result in generation of the ld.a instructions and
11137 the corresponding check instructions (ld.c / chk.a).
11138 The default is 'enable'.
11140 @item -mno-sched-control-spec
11141 @itemx -msched-control-spec
11142 @opindex mno-sched-control-spec
11143 @opindex msched-control-spec
11144 (Dis/En)able control speculative scheduling.  This feature is
11145 available only during region scheduling (i.e.@: before reload).
11146 This will result in generation of the ld.s instructions and
11147 the corresponding check instructions chk.s .
11148 The default is 'disable'.
11150 @item -msched-br-in-data-spec
11151 @itemx -mno-sched-br-in-data-spec
11152 @opindex msched-br-in-data-spec
11153 @opindex mno-sched-br-in-data-spec
11154 (En/Dis)able speculative scheduling of the instructions that
11155 are dependent on the data speculative loads before reload.
11156 This is effective only with @option{-msched-br-data-spec} enabled.
11157 The default is 'enable'.
11159 @item -msched-ar-in-data-spec
11160 @itemx -mno-sched-ar-in-data-spec
11161 @opindex msched-ar-in-data-spec
11162 @opindex mno-sched-ar-in-data-spec
11163 (En/Dis)able speculative scheduling of the instructions that
11164 are dependent on the data speculative loads after reload.
11165 This is effective only with @option{-msched-ar-data-spec} enabled.
11166 The default is 'enable'.
11168 @item -msched-in-control-spec
11169 @itemx -mno-sched-in-control-spec
11170 @opindex msched-in-control-spec
11171 @opindex mno-sched-in-control-spec
11172 (En/Dis)able speculative scheduling of the instructions that
11173 are dependent on the control speculative loads.
11174 This is effective only with @option{-msched-control-spec} enabled.
11175 The default is 'enable'.
11177 @item -msched-ldc
11178 @itemx -mno-sched-ldc
11179 @opindex msched-ldc
11180 @opindex mno-sched-ldc
11181 (En/Dis)able use of simple data speculation checks ld.c .
11182 If disabled, only chk.a instructions will be emitted to check
11183 data speculative loads.
11184 The default is 'enable'.
11186 @item -mno-sched-control-ldc
11187 @itemx -msched-control-ldc
11188 @opindex mno-sched-control-ldc
11189 @opindex msched-control-ldc
11190 (Dis/En)able use of ld.c instructions to check control speculative loads.
11191 If enabled, in case of control speculative load with no speculatively
11192 scheduled dependent instructions this load will be emitted as ld.sa and
11193 ld.c will be used to check it.
11194 The default is 'disable'.
11196 @item -mno-sched-spec-verbose
11197 @itemx -msched-spec-verbose
11198 @opindex mno-sched-spec-verbose
11199 @opindex msched-spec-verbose
11200 (Dis/En)able printing of the information about speculative motions.
11202 @item -mno-sched-prefer-non-data-spec-insns
11203 @itemx -msched-prefer-non-data-spec-insns
11204 @opindex mno-sched-prefer-non-data-spec-insns
11205 @opindex msched-prefer-non-data-spec-insns
11206 If enabled, data speculative instructions will be chosen for schedule
11207 only if there are no other choices at the moment.  This will make
11208 the use of the data speculation much more conservative.
11209 The default is 'disable'.
11211 @item -mno-sched-prefer-non-control-spec-insns
11212 @itemx -msched-prefer-non-control-spec-insns
11213 @opindex mno-sched-prefer-non-control-spec-insns
11214 @opindex msched-prefer-non-control-spec-insns
11215 If enabled, control speculative instructions will be chosen for schedule
11216 only if there are no other choices at the moment.  This will make
11217 the use of the control speculation much more conservative.
11218 The default is 'disable'.
11220 @item -mno-sched-count-spec-in-critical-path
11221 @itemx -msched-count-spec-in-critical-path
11222 @opindex mno-sched-count-spec-in-critical-path
11223 @opindex msched-count-spec-in-critical-path
11224 If enabled, speculative dependencies will be considered during
11225 computation of the instructions priorities.  This will make the use of the
11226 speculation a bit more conservative.
11227 The default is 'disable'.
11229 @end table
11231 @node M32C Options
11232 @subsection M32C Options
11233 @cindex M32C options
11235 @table @gcctabopt
11236 @item -mcpu=@var{name}
11237 @opindex mcpu=
11238 Select the CPU for which code is generated.  @var{name} may be one of
11239 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11240 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11241 the M32C/80 series.
11243 @item -msim
11244 @opindex msim
11245 Specifies that the program will be run on the simulator.  This causes
11246 an alternate runtime library to be linked in which supports, for
11247 example, file I/O.  You must not use this option when generating
11248 programs that will run on real hardware; you must provide your own
11249 runtime library for whatever I/O functions are needed.
11251 @item -memregs=@var{number}
11252 @opindex memregs=
11253 Specifies the number of memory-based pseudo-registers GCC will use
11254 during code generation.  These pseudo-registers will be used like real
11255 registers, so there is a tradeoff between GCC's ability to fit the
11256 code into available registers, and the performance penalty of using
11257 memory instead of registers.  Note that all modules in a program must
11258 be compiled with the same value for this option.  Because of that, you
11259 must not use this option with the default runtime libraries gcc
11260 builds.
11262 @end table
11264 @node M32R/D Options
11265 @subsection M32R/D Options
11266 @cindex M32R/D options
11268 These @option{-m} options are defined for Renesas M32R/D architectures:
11270 @table @gcctabopt
11271 @item -m32r2
11272 @opindex m32r2
11273 Generate code for the M32R/2@.
11275 @item -m32rx
11276 @opindex m32rx
11277 Generate code for the M32R/X@.
11279 @item -m32r
11280 @opindex m32r
11281 Generate code for the M32R@.  This is the default.
11283 @item -mmodel=small
11284 @opindex mmodel=small
11285 Assume all objects live in the lower 16MB of memory (so that their addresses
11286 can be loaded with the @code{ld24} instruction), and assume all subroutines
11287 are reachable with the @code{bl} instruction.
11288 This is the default.
11290 The addressability of a particular object can be set with the
11291 @code{model} attribute.
11293 @item -mmodel=medium
11294 @opindex mmodel=medium
11295 Assume objects may be anywhere in the 32-bit address space (the compiler
11296 will generate @code{seth/add3} instructions to load their addresses), and
11297 assume all subroutines are reachable with the @code{bl} instruction.
11299 @item -mmodel=large
11300 @opindex mmodel=large
11301 Assume objects may be anywhere in the 32-bit address space (the compiler
11302 will generate @code{seth/add3} instructions to load their addresses), and
11303 assume subroutines may not be reachable with the @code{bl} instruction
11304 (the compiler will generate the much slower @code{seth/add3/jl}
11305 instruction sequence).
11307 @item -msdata=none
11308 @opindex msdata=none
11309 Disable use of the small data area.  Variables will be put into
11310 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11311 @code{section} attribute has been specified).
11312 This is the default.
11314 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11315 Objects may be explicitly put in the small data area with the
11316 @code{section} attribute using one of these sections.
11318 @item -msdata=sdata
11319 @opindex msdata=sdata
11320 Put small global and static data in the small data area, but do not
11321 generate special code to reference them.
11323 @item -msdata=use
11324 @opindex msdata=use
11325 Put small global and static data in the small data area, and generate
11326 special instructions to reference them.
11328 @item -G @var{num}
11329 @opindex G
11330 @cindex smaller data references
11331 Put global and static objects less than or equal to @var{num} bytes
11332 into the small data or bss sections instead of the normal data or bss
11333 sections.  The default value of @var{num} is 8.
11334 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11335 for this option to have any effect.
11337 All modules should be compiled with the same @option{-G @var{num}} value.
11338 Compiling with different values of @var{num} may or may not work; if it
11339 doesn't the linker will give an error message---incorrect code will not be
11340 generated.
11342 @item -mdebug
11343 @opindex mdebug
11344 Makes the M32R specific code in the compiler display some statistics
11345 that might help in debugging programs.
11347 @item -malign-loops
11348 @opindex malign-loops
11349 Align all loops to a 32-byte boundary.
11351 @item -mno-align-loops
11352 @opindex mno-align-loops
11353 Do not enforce a 32-byte alignment for loops.  This is the default.
11355 @item -missue-rate=@var{number}
11356 @opindex missue-rate=@var{number}
11357 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11358 or 2.
11360 @item -mbranch-cost=@var{number}
11361 @opindex mbranch-cost=@var{number}
11362 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11363 preferred over conditional code, if it is 2, then the opposite will
11364 apply.
11366 @item -mflush-trap=@var{number}
11367 @opindex mflush-trap=@var{number}
11368 Specifies the trap number to use to flush the cache.  The default is
11369 12.  Valid numbers are between 0 and 15 inclusive.
11371 @item -mno-flush-trap
11372 @opindex mno-flush-trap
11373 Specifies that the cache cannot be flushed by using a trap.
11375 @item -mflush-func=@var{name}
11376 @opindex mflush-func=@var{name}
11377 Specifies the name of the operating system function to call to flush
11378 the cache.  The default is @emph{_flush_cache}, but a function call
11379 will only be used if a trap is not available.
11381 @item -mno-flush-func
11382 @opindex mno-flush-func
11383 Indicates that there is no OS function for flushing the cache.
11385 @end table
11387 @node M680x0 Options
11388 @subsection M680x0 Options
11389 @cindex M680x0 options
11391 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11392 The default settings depend on which architecture was selected when
11393 the compiler was configured; the defaults for the most common choices
11394 are given below.
11396 @table @gcctabopt
11397 @item -march=@var{arch}
11398 @opindex march
11399 Generate code for a specific M680x0 or ColdFire instruction set
11400 architecture.  Permissible values of @var{arch} for M680x0
11401 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11402 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11403 architectures are selected according to Freescale's ISA classification
11404 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11405 @samp{isab} and @samp{isac}.
11407 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11408 code for a ColdFire target.  The @var{arch} in this macro is one of the
11409 @option{-march} arguments given above.
11411 When used together, @option{-march} and @option{-mtune} select code
11412 that runs on a family of similar processors but that is optimized
11413 for a particular microarchitecture.
11415 @item -mcpu=@var{cpu}
11416 @opindex mcpu
11417 Generate code for a specific M680x0 or ColdFire processor.
11418 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11419 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11420 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11421 below, which also classifies the CPUs into families:
11423 @multitable @columnfractions 0.20 0.80
11424 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11425 @item @samp{51qe} @tab @samp{51qe}
11426 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11427 @item @samp{5206e} @tab @samp{5206e}
11428 @item @samp{5208} @tab @samp{5207} @samp{5208}
11429 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11430 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11431 @item @samp{5216} @tab @samp{5214} @samp{5216}
11432 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11433 @item @samp{5225} @tab @samp{5224} @samp{5225}
11434 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11435 @item @samp{5249} @tab @samp{5249}
11436 @item @samp{5250} @tab @samp{5250}
11437 @item @samp{5271} @tab @samp{5270} @samp{5271}
11438 @item @samp{5272} @tab @samp{5272}
11439 @item @samp{5275} @tab @samp{5274} @samp{5275}
11440 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11441 @item @samp{5307} @tab @samp{5307}
11442 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11443 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11444 @item @samp{5407} @tab @samp{5407}
11445 @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}
11446 @end multitable
11448 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11449 @var{arch} is compatible with @var{cpu}.  Other combinations of
11450 @option{-mcpu} and @option{-march} are rejected.
11452 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11453 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11454 where the value of @var{family} is given by the table above.
11456 @item -mtune=@var{tune}
11457 @opindex mtune
11458 Tune the code for a particular microarchitecture, within the
11459 constraints set by @option{-march} and @option{-mcpu}.
11460 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11461 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11462 and @samp{cpu32}.  The ColdFire microarchitectures
11463 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11465 You can also use @option{-mtune=68020-40} for code that needs
11466 to run relatively well on 68020, 68030 and 68040 targets.
11467 @option{-mtune=68020-60} is similar but includes 68060 targets
11468 as well.  These two options select the same tuning decisions as
11469 @option{-m68020-40} and @option{-m68020-60} respectively.
11471 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11472 when tuning for 680x0 architecture @var{arch}.  It also defines
11473 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11474 option is used.  If gcc is tuning for a range of architectures,
11475 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11476 it defines the macros for every architecture in the range.
11478 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11479 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11480 of the arguments given above.
11482 @item -m68000
11483 @itemx -mc68000
11484 @opindex m68000
11485 @opindex mc68000
11486 Generate output for a 68000.  This is the default
11487 when the compiler is configured for 68000-based systems.
11488 It is equivalent to @option{-march=68000}.
11490 Use this option for microcontrollers with a 68000 or EC000 core,
11491 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11493 @item -m68010
11494 @opindex m68010
11495 Generate output for a 68010.  This is the default
11496 when the compiler is configured for 68010-based systems.
11497 It is equivalent to @option{-march=68010}.
11499 @item -m68020
11500 @itemx -mc68020
11501 @opindex m68020
11502 @opindex mc68020
11503 Generate output for a 68020.  This is the default
11504 when the compiler is configured for 68020-based systems.
11505 It is equivalent to @option{-march=68020}.
11507 @item -m68030
11508 @opindex m68030
11509 Generate output for a 68030.  This is the default when the compiler is
11510 configured for 68030-based systems.  It is equivalent to
11511 @option{-march=68030}.
11513 @item -m68040
11514 @opindex m68040
11515 Generate output for a 68040.  This is the default when the compiler is
11516 configured for 68040-based systems.  It is equivalent to
11517 @option{-march=68040}.
11519 This option inhibits the use of 68881/68882 instructions that have to be
11520 emulated by software on the 68040.  Use this option if your 68040 does not
11521 have code to emulate those instructions.
11523 @item -m68060
11524 @opindex m68060
11525 Generate output for a 68060.  This is the default when the compiler is
11526 configured for 68060-based systems.  It is equivalent to
11527 @option{-march=68060}.
11529 This option inhibits the use of 68020 and 68881/68882 instructions that
11530 have to be emulated by software on the 68060.  Use this option if your 68060
11531 does not have code to emulate those instructions.
11533 @item -mcpu32
11534 @opindex mcpu32
11535 Generate output for a CPU32.  This is the default
11536 when the compiler is configured for CPU32-based systems.
11537 It is equivalent to @option{-march=cpu32}.
11539 Use this option for microcontrollers with a
11540 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11541 68336, 68340, 68341, 68349 and 68360.
11543 @item -m5200
11544 @opindex m5200
11545 Generate output for a 520X ColdFire CPU.  This is the default
11546 when the compiler is configured for 520X-based systems.
11547 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11548 in favor of that option.
11550 Use this option for microcontroller with a 5200 core, including
11551 the MCF5202, MCF5203, MCF5204 and MCF5206.
11553 @item -m5206e
11554 @opindex m5206e
11555 Generate output for a 5206e ColdFire CPU.  The option is now
11556 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11558 @item -m528x
11559 @opindex m528x
11560 Generate output for a member of the ColdFire 528X family.
11561 The option is now deprecated in favor of the equivalent
11562 @option{-mcpu=528x}.
11564 @item -m5307
11565 @opindex m5307
11566 Generate output for a ColdFire 5307 CPU.  The option is now deprecated
11567 in favor of the equivalent @option{-mcpu=5307}.
11569 @item -m5407
11570 @opindex m5407
11571 Generate output for a ColdFire 5407 CPU.  The option is now deprecated
11572 in favor of the equivalent @option{-mcpu=5407}.
11574 @item -mcfv4e
11575 @opindex mcfv4e
11576 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11577 This includes use of hardware floating point instructions.
11578 The option is equivalent to @option{-mcpu=547x}, and is now
11579 deprecated in favor of that option.
11581 @item -m68020-40
11582 @opindex m68020-40
11583 Generate output for a 68040, without using any of the new instructions.
11584 This results in code which can run relatively efficiently on either a
11585 68020/68881 or a 68030 or a 68040.  The generated code does use the
11586 68881 instructions that are emulated on the 68040.
11588 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11590 @item -m68020-60
11591 @opindex m68020-60
11592 Generate output for a 68060, without using any of the new instructions.
11593 This results in code which can run relatively efficiently on either a
11594 68020/68881 or a 68030 or a 68040.  The generated code does use the
11595 68881 instructions that are emulated on the 68060.
11597 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11599 @item -mhard-float
11600 @itemx -m68881
11601 @opindex mhard-float
11602 @opindex m68881
11603 Generate floating-point instructions.  This is the default for 68020
11604 and above, and for ColdFire devices that have an FPU.  It defines the
11605 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11606 on ColdFire targets.
11608 @item -msoft-float
11609 @opindex msoft-float
11610 Do not generate floating-point instructions; use library calls instead.
11611 This is the default for 68000, 68010, and 68832 targets.  It is also
11612 the default for ColdFire devices that have no FPU.
11614 @item -mdiv
11615 @itemx -mno-div
11616 @opindex mdiv
11617 @opindex mno-div
11618 Generate (do not generate) ColdFire hardware divide and remainder
11619 instructions.  If @option{-march} is used without @option{-mcpu},
11620 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11621 architectures.  Otherwise, the default is taken from the target CPU
11622 (either the default CPU, or the one specified by @option{-mcpu}).  For
11623 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11624 @option{-mcpu=5206e}.
11626 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11628 @item -mshort
11629 @opindex mshort
11630 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11631 Additionally, parameters passed on the stack are also aligned to a
11632 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11634 @item -mno-short
11635 @opindex mno-short
11636 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11638 @item -mnobitfield
11639 @itemx -mno-bitfield
11640 @opindex mnobitfield
11641 @opindex mno-bitfield
11642 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11643 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11645 @item -mbitfield
11646 @opindex mbitfield
11647 Do use the bit-field instructions.  The @option{-m68020} option implies
11648 @option{-mbitfield}.  This is the default if you use a configuration
11649 designed for a 68020.
11651 @item -mrtd
11652 @opindex mrtd
11653 Use a different function-calling convention, in which functions
11654 that take a fixed number of arguments return with the @code{rtd}
11655 instruction, which pops their arguments while returning.  This
11656 saves one instruction in the caller since there is no need to pop
11657 the arguments there.
11659 This calling convention is incompatible with the one normally
11660 used on Unix, so you cannot use it if you need to call libraries
11661 compiled with the Unix compiler.
11663 Also, you must provide function prototypes for all functions that
11664 take variable numbers of arguments (including @code{printf});
11665 otherwise incorrect code will be generated for calls to those
11666 functions.
11668 In addition, seriously incorrect code will result if you call a
11669 function with too many arguments.  (Normally, extra arguments are
11670 harmlessly ignored.)
11672 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11673 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11675 @item -mno-rtd
11676 @opindex mno-rtd
11677 Do not use the calling conventions selected by @option{-mrtd}.
11678 This is the default.
11680 @item -malign-int
11681 @itemx -mno-align-int
11682 @opindex malign-int
11683 @opindex mno-align-int
11684 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11685 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11686 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11687 Aligning variables on 32-bit boundaries produces code that runs somewhat
11688 faster on processors with 32-bit busses at the expense of more memory.
11690 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11691 align structures containing the above types  differently than
11692 most published application binary interface specifications for the m68k.
11694 @item -mpcrel
11695 @opindex mpcrel
11696 Use the pc-relative addressing mode of the 68000 directly, instead of
11697 using a global offset table.  At present, this option implies @option{-fpic},
11698 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11699 not presently supported with @option{-mpcrel}, though this could be supported for
11700 68020 and higher processors.
11702 @item -mno-strict-align
11703 @itemx -mstrict-align
11704 @opindex mno-strict-align
11705 @opindex mstrict-align
11706 Do not (do) assume that unaligned memory references will be handled by
11707 the system.
11709 @item -msep-data
11710 Generate code that allows the data segment to be located in a different
11711 area of memory from the text segment.  This allows for execute in place in
11712 an environment without virtual memory management.  This option implies
11713 @option{-fPIC}.
11715 @item -mno-sep-data
11716 Generate code that assumes that the data segment follows the text segment.
11717 This is the default.
11719 @item -mid-shared-library
11720 Generate code that supports shared libraries via the library ID method.
11721 This allows for execute in place and shared libraries in an environment
11722 without virtual memory management.  This option implies @option{-fPIC}.
11724 @item -mno-id-shared-library
11725 Generate code that doesn't assume ID based shared libraries are being used.
11726 This is the default.
11728 @item -mshared-library-id=n
11729 Specified the identification number of the ID based shared library being
11730 compiled.  Specifying a value of 0 will generate more compact code, specifying
11731 other values will force the allocation of that number to the current
11732 library but is no more space or time efficient than omitting this option.
11734 @end table
11736 @node M68hc1x Options
11737 @subsection M68hc1x Options
11738 @cindex M68hc1x options
11740 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11741 microcontrollers.  The default values for these options depends on
11742 which style of microcontroller was selected when the compiler was configured;
11743 the defaults for the most common choices are given below.
11745 @table @gcctabopt
11746 @item -m6811
11747 @itemx -m68hc11
11748 @opindex m6811
11749 @opindex m68hc11
11750 Generate output for a 68HC11.  This is the default
11751 when the compiler is configured for 68HC11-based systems.
11753 @item -m6812
11754 @itemx -m68hc12
11755 @opindex m6812
11756 @opindex m68hc12
11757 Generate output for a 68HC12.  This is the default
11758 when the compiler is configured for 68HC12-based systems.
11760 @item -m68S12
11761 @itemx -m68hcs12
11762 @opindex m68S12
11763 @opindex m68hcs12
11764 Generate output for a 68HCS12.
11766 @item -mauto-incdec
11767 @opindex mauto-incdec
11768 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11769 addressing modes.
11771 @item -minmax
11772 @itemx -nominmax
11773 @opindex minmax
11774 @opindex mnominmax
11775 Enable the use of 68HC12 min and max instructions.
11777 @item -mlong-calls
11778 @itemx -mno-long-calls
11779 @opindex mlong-calls
11780 @opindex mno-long-calls
11781 Treat all calls as being far away (near).  If calls are assumed to be
11782 far away, the compiler will use the @code{call} instruction to
11783 call a function and the @code{rtc} instruction for returning.
11785 @item -mshort
11786 @opindex mshort
11787 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11789 @item -msoft-reg-count=@var{count}
11790 @opindex msoft-reg-count
11791 Specify the number of pseudo-soft registers which are used for the
11792 code generation.  The maximum number is 32.  Using more pseudo-soft
11793 register may or may not result in better code depending on the program.
11794 The default is 4 for 68HC11 and 2 for 68HC12.
11796 @end table
11798 @node MCore Options
11799 @subsection MCore Options
11800 @cindex MCore options
11802 These are the @samp{-m} options defined for the Motorola M*Core
11803 processors.
11805 @table @gcctabopt
11807 @item -mhardlit
11808 @itemx -mno-hardlit
11809 @opindex mhardlit
11810 @opindex mno-hardlit
11811 Inline constants into the code stream if it can be done in two
11812 instructions or less.
11814 @item -mdiv
11815 @itemx -mno-div
11816 @opindex mdiv
11817 @opindex mno-div
11818 Use the divide instruction.  (Enabled by default).
11820 @item -mrelax-immediate
11821 @itemx -mno-relax-immediate
11822 @opindex mrelax-immediate
11823 @opindex mno-relax-immediate
11824 Allow arbitrary sized immediates in bit operations.
11826 @item -mwide-bitfields
11827 @itemx -mno-wide-bitfields
11828 @opindex mwide-bitfields
11829 @opindex mno-wide-bitfields
11830 Always treat bit-fields as int-sized.
11832 @item -m4byte-functions
11833 @itemx -mno-4byte-functions
11834 @opindex m4byte-functions
11835 @opindex mno-4byte-functions
11836 Force all functions to be aligned to a four byte boundary.
11838 @item -mcallgraph-data
11839 @itemx -mno-callgraph-data
11840 @opindex mcallgraph-data
11841 @opindex mno-callgraph-data
11842 Emit callgraph information.
11844 @item -mslow-bytes
11845 @itemx -mno-slow-bytes
11846 @opindex mslow-bytes
11847 @opindex mno-slow-bytes
11848 Prefer word access when reading byte quantities.
11850 @item -mlittle-endian
11851 @itemx -mbig-endian
11852 @opindex mlittle-endian
11853 @opindex mbig-endian
11854 Generate code for a little endian target.
11856 @item -m210
11857 @itemx -m340
11858 @opindex m210
11859 @opindex m340
11860 Generate code for the 210 processor.
11861 @end table
11863 @node MIPS Options
11864 @subsection MIPS Options
11865 @cindex MIPS options
11867 @table @gcctabopt
11869 @item -EB
11870 @opindex EB
11871 Generate big-endian code.
11873 @item -EL
11874 @opindex EL
11875 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11876 configurations.
11878 @item -march=@var{arch}
11879 @opindex march
11880 Generate code that will run on @var{arch}, which can be the name of a
11881 generic MIPS ISA, or the name of a particular processor.
11882 The ISA names are:
11883 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11884 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11885 The processor names are:
11886 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11887 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11888 @samp{5kc}, @samp{5kf},
11889 @samp{20kc},
11890 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11891 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11892 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11893 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11894 @samp{m4k},
11895 @samp{orion},
11896 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11897 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11898 @samp{rm7000}, @samp{rm9000},
11899 @samp{sb1},
11900 @samp{sr71000},
11901 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11902 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11903 The special value @samp{from-abi} selects the
11904 most compatible architecture for the selected ABI (that is,
11905 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11907 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11908 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11909 @samp{vr} may be written @samp{r}.
11911 Names of the form @samp{@var{n}f2_1} refer to processors with
11912 FPUs clocked at half the rate of the core, names of the form
11913 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11914 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11915 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11916 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11917 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11918 accepted as synonyms for @samp{@var{n}f1_1}.
11920 GCC defines two macros based on the value of this option.  The first
11921 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11922 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11923 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11924 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11925 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11927 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11928 above.  In other words, it will have the full prefix and will not
11929 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11930 the macro names the resolved architecture (either @samp{"mips1"} or
11931 @samp{"mips3"}).  It names the default architecture when no
11932 @option{-march} option is given.
11934 @item -mtune=@var{arch}
11935 @opindex mtune
11936 Optimize for @var{arch}.  Among other things, this option controls
11937 the way instructions are scheduled, and the perceived cost of arithmetic
11938 operations.  The list of @var{arch} values is the same as for
11939 @option{-march}.
11941 When this option is not used, GCC will optimize for the processor
11942 specified by @option{-march}.  By using @option{-march} and
11943 @option{-mtune} together, it is possible to generate code that will
11944 run on a family of processors, but optimize the code for one
11945 particular member of that family.
11947 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11948 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11949 @samp{-march} ones described above.
11951 @item -mips1
11952 @opindex mips1
11953 Equivalent to @samp{-march=mips1}.
11955 @item -mips2
11956 @opindex mips2
11957 Equivalent to @samp{-march=mips2}.
11959 @item -mips3
11960 @opindex mips3
11961 Equivalent to @samp{-march=mips3}.
11963 @item -mips4
11964 @opindex mips4
11965 Equivalent to @samp{-march=mips4}.
11967 @item -mips32
11968 @opindex mips32
11969 Equivalent to @samp{-march=mips32}.
11971 @item -mips32r2
11972 @opindex mips32r2
11973 Equivalent to @samp{-march=mips32r2}.
11975 @item -mips64
11976 @opindex mips64
11977 Equivalent to @samp{-march=mips64}.
11979 @item -mips16
11980 @itemx -mno-mips16
11981 @opindex mips16
11982 @opindex mno-mips16
11983 Generate (do not generate) MIPS16 code.  If GCC is targetting a
11984 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
11986 MIPS16 code generation can also be controlled on a per-function basis
11987 by means of @code{mips16} and @code{nomips16} attributes.  
11988 @xref{Function Attributes}, for more information.
11990 @item -mflip-mips16
11991 @opindex mflip-mips16
11992 Generate MIPS16 code on alternating functions.  This option is provided
11993 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
11994 not intended for ordinary use in compiling user code.
11996 @item -minterlink-mips16
11997 @itemx -mno-interlink-mips16
11998 @opindex minterlink-mips16
11999 @opindex mno-interlink-mips16
12000 Require (do not require) that non-MIPS16 code be link-compatible with
12001 MIPS16 code.
12003 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12004 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12005 therefore disables direct jumps unless GCC knows that the target of the
12006 jump is not MIPS16.
12008 @item -mabi=32
12009 @itemx -mabi=o64
12010 @itemx -mabi=n32
12011 @itemx -mabi=64
12012 @itemx -mabi=eabi
12013 @opindex mabi=32
12014 @opindex mabi=o64
12015 @opindex mabi=n32
12016 @opindex mabi=64
12017 @opindex mabi=eabi
12018 Generate code for the given ABI@.
12020 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12021 generates 64-bit code when you select a 64-bit architecture, but you
12022 can use @option{-mgp32} to get 32-bit code instead.
12024 For information about the O64 ABI, see
12025 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12027 GCC supports a variant of the o32 ABI in which floating-point registers
12028 are 64 rather than 32 bits wide.  You can select this combination with
12029 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12030 and @samp{mfhc1} instructions and is therefore only supported for
12031 MIPS32R2 processors.
12033 The register assignments for arguments and return values remain the
12034 same, but each scalar value is passed in a single 64-bit register
12035 rather than a pair of 32-bit registers.  For example, scalar
12036 floating-point values are returned in @samp{$f0} only, not a
12037 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12038 remains the same, but all 64 bits are saved.
12040 @item -mabicalls
12041 @itemx -mno-abicalls
12042 @opindex mabicalls
12043 @opindex mno-abicalls
12044 Generate (do not generate) code that is suitable for SVR4-style
12045 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12046 systems.
12048 @item -mshared
12049 @itemx -mno-shared
12050 Generate (do not generate) code that is fully position-independent,
12051 and that can therefore be linked into shared libraries.  This option
12052 only affects @option{-mabicalls}.
12054 All @option{-mabicalls} code has traditionally been position-independent,
12055 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12056 as an extension, the GNU toolchain allows executables to use absolute
12057 accesses for locally-binding symbols.  It can also use shorter GP
12058 initialization sequences and generate direct calls to locally-defined
12059 functions.  This mode is selected by @option{-mno-shared}.
12061 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12062 objects that can only be linked by the GNU linker.  However, the option
12063 does not affect the ABI of the final executable; it only affects the ABI
12064 of relocatable objects.  Using @option{-mno-shared} will generally make
12065 executables both smaller and quicker.
12067 @option{-mshared} is the default.
12069 @item -mxgot
12070 @itemx -mno-xgot
12071 @opindex mxgot
12072 @opindex mno-xgot
12073 Lift (do not lift) the usual restrictions on the size of the global
12074 offset table.
12076 GCC normally uses a single instruction to load values from the GOT@.
12077 While this is relatively efficient, it will only work if the GOT
12078 is smaller than about 64k.  Anything larger will cause the linker
12079 to report an error such as:
12081 @cindex relocation truncated to fit (MIPS)
12082 @smallexample
12083 relocation truncated to fit: R_MIPS_GOT16 foobar
12084 @end smallexample
12086 If this happens, you should recompile your code with @option{-mxgot}.
12087 It should then work with very large GOTs, although it will also be
12088 less efficient, since it will take three instructions to fetch the
12089 value of a global symbol.
12091 Note that some linkers can create multiple GOTs.  If you have such a
12092 linker, you should only need to use @option{-mxgot} when a single object
12093 file accesses more than 64k's worth of GOT entries.  Very few do.
12095 These options have no effect unless GCC is generating position
12096 independent code.
12098 @item -mgp32
12099 @opindex mgp32
12100 Assume that general-purpose registers are 32 bits wide.
12102 @item -mgp64
12103 @opindex mgp64
12104 Assume that general-purpose registers are 64 bits wide.
12106 @item -mfp32
12107 @opindex mfp32
12108 Assume that floating-point registers are 32 bits wide.
12110 @item -mfp64
12111 @opindex mfp64
12112 Assume that floating-point registers are 64 bits wide.
12114 @item -mhard-float
12115 @opindex mhard-float
12116 Use floating-point coprocessor instructions.
12118 @item -msoft-float
12119 @opindex msoft-float
12120 Do not use floating-point coprocessor instructions.  Implement
12121 floating-point calculations using library calls instead.
12123 @item -msingle-float
12124 @opindex msingle-float
12125 Assume that the floating-point coprocessor only supports single-precision
12126 operations.
12128 @item -mdouble-float
12129 @opindex mdouble-float
12130 Assume that the floating-point coprocessor supports double-precision
12131 operations.  This is the default.
12133 @item -mllsc
12134 @itemx -mno-llsc
12135 @opindex mllsc
12136 @opindex mno-llsc
12137 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12138 implement atomic memory built-in functions.  When neither option is
12139 specified, GCC will use the instructions if the target architecture
12140 supports them.
12142 @option{-mllsc} is useful if the runtime environment can emulate the
12143 instructions and @option{-mno-llsc} can be useful when compiling for
12144 nonstandard ISAs.  You can make either option the default by
12145 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12146 respectively.  @option{--with-llsc} is the default for some
12147 configurations; see the installation documentation for details.
12149 @item -mdsp
12150 @itemx -mno-dsp
12151 @opindex mdsp
12152 @opindex mno-dsp
12153 Use (do not use) revision 1 of the MIPS DSP ASE.
12154 @xref{MIPS DSP Built-in Functions}.  This option defines the
12155 preprocessor macro @samp{__mips_dsp}.  It also defines
12156 @samp{__mips_dsp_rev} to 1.
12158 @item -mdspr2
12159 @itemx -mno-dspr2
12160 @opindex mdspr2
12161 @opindex mno-dspr2
12162 Use (do not use) revision 2 of the MIPS DSP ASE.
12163 @xref{MIPS DSP Built-in Functions}.  This option defines the
12164 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12165 It also defines @samp{__mips_dsp_rev} to 2.
12167 @item -msmartmips
12168 @itemx -mno-smartmips
12169 @opindex msmartmips
12170 @opindex mno-smartmips
12171 Use (do not use) the MIPS SmartMIPS ASE.
12173 @item -mpaired-single
12174 @itemx -mno-paired-single
12175 @opindex mpaired-single
12176 @opindex mno-paired-single
12177 Use (do not use) paired-single floating-point instructions.
12178 @xref{MIPS Paired-Single Support}.  This option requires
12179 hardware floating-point support to be enabled.
12181 @item -mdmx
12182 @itemx -mno-mdmx
12183 @opindex mdmx
12184 @opindex mno-mdmx
12185 Use (do not use) MIPS Digital Media Extension instructions.
12186 This option can only be used when generating 64-bit code and requires
12187 hardware floating-point support to be enabled.
12189 @item -mips3d
12190 @itemx -mno-mips3d
12191 @opindex mips3d
12192 @opindex mno-mips3d
12193 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12194 The option @option{-mips3d} implies @option{-mpaired-single}.
12196 @item -mmt
12197 @itemx -mno-mt
12198 @opindex mmt
12199 @opindex mno-mt
12200 Use (do not use) MT Multithreading instructions.
12202 @item -mlong64
12203 @opindex mlong64
12204 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12205 an explanation of the default and the way that the pointer size is
12206 determined.
12208 @item -mlong32
12209 @opindex mlong32
12210 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12212 The default size of @code{int}s, @code{long}s and pointers depends on
12213 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12214 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12215 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12216 or the same size as integer registers, whichever is smaller.
12218 @item -msym32
12219 @itemx -mno-sym32
12220 @opindex msym32
12221 @opindex mno-sym32
12222 Assume (do not assume) that all symbols have 32-bit values, regardless
12223 of the selected ABI@.  This option is useful in combination with
12224 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12225 to generate shorter and faster references to symbolic addresses.
12227 @item -G @var{num}
12228 @opindex G
12229 Put definitions of externally-visible data in a small data section
12230 if that data is no bigger than @var{num} bytes.  GCC can then access
12231 the data more efficiently; see @option{-mgpopt} for details.
12233 The default @option{-G} option depends on the configuration.
12235 @item -mlocal-sdata
12236 @itemx -mno-local-sdata
12237 @opindex mlocal-sdata
12238 @opindex mno-local-sdata
12239 Extend (do not extend) the @option{-G} behavior to local data too,
12240 such as to static variables in C.  @option{-mlocal-sdata} is the
12241 default for all configurations.
12243 If the linker complains that an application is using too much small data,
12244 you might want to try rebuilding the less performance-critical parts with
12245 @option{-mno-local-sdata}.  You might also want to build large
12246 libraries with @option{-mno-local-sdata}, so that the libraries leave
12247 more room for the main program.
12249 @item -mextern-sdata
12250 @itemx -mno-extern-sdata
12251 @opindex mextern-sdata
12252 @opindex mno-extern-sdata
12253 Assume (do not assume) that externally-defined data will be in
12254 a small data section if that data is within the @option{-G} limit.
12255 @option{-mextern-sdata} is the default for all configurations.
12257 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12258 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12259 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12260 is placed in a small data section.  If @var{Var} is defined by another
12261 module, you must either compile that module with a high-enough
12262 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12263 definition.  If @var{Var} is common, you must link the application
12264 with a high-enough @option{-G} setting.
12266 The easiest way of satisfying these restrictions is to compile
12267 and link every module with the same @option{-G} option.  However,
12268 you may wish to build a library that supports several different
12269 small data limits.  You can do this by compiling the library with
12270 the highest supported @option{-G} setting and additionally using
12271 @option{-mno-extern-sdata} to stop the library from making assumptions
12272 about externally-defined data.
12274 @item -mgpopt
12275 @itemx -mno-gpopt
12276 @opindex mgpopt
12277 @opindex mno-gpopt
12278 Use (do not use) GP-relative accesses for symbols that are known to be
12279 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12280 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12281 configurations.
12283 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12284 might not hold the value of @code{_gp}.  For example, if the code is
12285 part of a library that might be used in a boot monitor, programs that
12286 call boot monitor routines will pass an unknown value in @code{$gp}.
12287 (In such situations, the boot monitor itself would usually be compiled
12288 with @option{-G0}.)
12290 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12291 @option{-mno-extern-sdata}.
12293 @item -membedded-data
12294 @itemx -mno-embedded-data
12295 @opindex membedded-data
12296 @opindex mno-embedded-data
12297 Allocate variables to the read-only data section first if possible, then
12298 next in the small data section if possible, otherwise in data.  This gives
12299 slightly slower code than the default, but reduces the amount of RAM required
12300 when executing, and thus may be preferred for some embedded systems.
12302 @item -muninit-const-in-rodata
12303 @itemx -mno-uninit-const-in-rodata
12304 @opindex muninit-const-in-rodata
12305 @opindex mno-uninit-const-in-rodata
12306 Put uninitialized @code{const} variables in the read-only data section.
12307 This option is only meaningful in conjunction with @option{-membedded-data}.
12309 @item -mcode-readable=@var{setting}
12310 @opindex mcode-readable
12311 Specify whether GCC may generate code that reads from executable sections.
12312 There are three possible settings:
12314 @table @gcctabopt
12315 @item -mcode-readable=yes
12316 Instructions may freely access executable sections.  This is the
12317 default setting.
12319 @item -mcode-readable=pcrel
12320 MIPS16 PC-relative load instructions can access executable sections,
12321 but other instructions must not do so.  This option is useful on 4KSc
12322 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12323 It is also useful on processors that can be configured to have a dual
12324 instruction/data SRAM interface and that, like the M4K, automatically
12325 redirect PC-relative loads to the instruction RAM.
12327 @item -mcode-readable=no
12328 Instructions must not access executable sections.  This option can be
12329 useful on targets that are configured to have a dual instruction/data
12330 SRAM interface but that (unlike the M4K) do not automatically redirect
12331 PC-relative loads to the instruction RAM.
12332 @end table
12334 @item -msplit-addresses
12335 @itemx -mno-split-addresses
12336 @opindex msplit-addresses
12337 @opindex mno-split-addresses
12338 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12339 relocation operators.  This option has been superseded by
12340 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12342 @item -mexplicit-relocs
12343 @itemx -mno-explicit-relocs
12344 @opindex mexplicit-relocs
12345 @opindex mno-explicit-relocs
12346 Use (do not use) assembler relocation operators when dealing with symbolic
12347 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12348 is to use assembler macros instead.
12350 @option{-mexplicit-relocs} is the default if GCC was configured
12351 to use an assembler that supports relocation operators.
12353 @item -mcheck-zero-division
12354 @itemx -mno-check-zero-division
12355 @opindex mcheck-zero-division
12356 @opindex mno-check-zero-division
12357 Trap (do not trap) on integer division by zero.
12359 The default is @option{-mcheck-zero-division}.
12361 @item -mdivide-traps
12362 @itemx -mdivide-breaks
12363 @opindex mdivide-traps
12364 @opindex mdivide-breaks
12365 MIPS systems check for division by zero by generating either a
12366 conditional trap or a break instruction.  Using traps results in
12367 smaller code, but is only supported on MIPS II and later.  Also, some
12368 versions of the Linux kernel have a bug that prevents trap from
12369 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12370 allow conditional traps on architectures that support them and
12371 @option{-mdivide-breaks} to force the use of breaks.
12373 The default is usually @option{-mdivide-traps}, but this can be
12374 overridden at configure time using @option{--with-divide=breaks}.
12375 Divide-by-zero checks can be completely disabled using
12376 @option{-mno-check-zero-division}.
12378 @item -mmemcpy
12379 @itemx -mno-memcpy
12380 @opindex mmemcpy
12381 @opindex mno-memcpy
12382 Force (do not force) the use of @code{memcpy()} for non-trivial block
12383 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12384 most constant-sized copies.
12386 @item -mlong-calls
12387 @itemx -mno-long-calls
12388 @opindex mlong-calls
12389 @opindex mno-long-calls
12390 Disable (do not disable) use of the @code{jal} instruction.  Calling
12391 functions using @code{jal} is more efficient but requires the caller
12392 and callee to be in the same 256 megabyte segment.
12394 This option has no effect on abicalls code.  The default is
12395 @option{-mno-long-calls}.
12397 @item -mmad
12398 @itemx -mno-mad
12399 @opindex mmad
12400 @opindex mno-mad
12401 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12402 instructions, as provided by the R4650 ISA@.
12404 @item -mfused-madd
12405 @itemx -mno-fused-madd
12406 @opindex mfused-madd
12407 @opindex mno-fused-madd
12408 Enable (disable) use of the floating point multiply-accumulate
12409 instructions, when they are available.  The default is
12410 @option{-mfused-madd}.
12412 When multiply-accumulate instructions are used, the intermediate
12413 product is calculated to infinite precision and is not subject to
12414 the FCSR Flush to Zero bit.  This may be undesirable in some
12415 circumstances.
12417 @item -nocpp
12418 @opindex nocpp
12419 Tell the MIPS assembler to not run its preprocessor over user
12420 assembler files (with a @samp{.s} suffix) when assembling them.
12422 @item -mfix-r4000
12423 @itemx -mno-fix-r4000
12424 @opindex mfix-r4000
12425 @opindex mno-fix-r4000
12426 Work around certain R4000 CPU errata:
12427 @itemize @minus
12428 @item
12429 A double-word or a variable shift may give an incorrect result if executed
12430 immediately after starting an integer division.
12431 @item
12432 A double-word or a variable shift may give an incorrect result if executed
12433 while an integer multiplication is in progress.
12434 @item
12435 An integer division may give an incorrect result if started in a delay slot
12436 of a taken branch or a jump.
12437 @end itemize
12439 @item -mfix-r4400
12440 @itemx -mno-fix-r4400
12441 @opindex mfix-r4400
12442 @opindex mno-fix-r4400
12443 Work around certain R4400 CPU errata:
12444 @itemize @minus
12445 @item
12446 A double-word or a variable shift may give an incorrect result if executed
12447 immediately after starting an integer division.
12448 @end itemize
12450 @item -mfix-vr4120
12451 @itemx -mno-fix-vr4120
12452 @opindex mfix-vr4120
12453 Work around certain VR4120 errata:
12454 @itemize @minus
12455 @item
12456 @code{dmultu} does not always produce the correct result.
12457 @item
12458 @code{div} and @code{ddiv} do not always produce the correct result if one
12459 of the operands is negative.
12460 @end itemize
12461 The workarounds for the division errata rely on special functions in
12462 @file{libgcc.a}.  At present, these functions are only provided by
12463 the @code{mips64vr*-elf} configurations.
12465 Other VR4120 errata require a nop to be inserted between certain pairs of
12466 instructions.  These errata are handled by the assembler, not by GCC itself.
12468 @item -mfix-vr4130
12469 @opindex mfix-vr4130
12470 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12471 workarounds are implemented by the assembler rather than by GCC,
12472 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12473 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12474 instructions are available instead.
12476 @item -mfix-sb1
12477 @itemx -mno-fix-sb1
12478 @opindex mfix-sb1
12479 Work around certain SB-1 CPU core errata.
12480 (This flag currently works around the SB-1 revision 2
12481 ``F1'' and ``F2'' floating point errata.)
12483 @item -mflush-func=@var{func}
12484 @itemx -mno-flush-func
12485 @opindex mflush-func
12486 Specifies the function to call to flush the I and D caches, or to not
12487 call any such function.  If called, the function must take the same
12488 arguments as the common @code{_flush_func()}, that is, the address of the
12489 memory range for which the cache is being flushed, the size of the
12490 memory range, and the number 3 (to flush both caches).  The default
12491 depends on the target GCC was configured for, but commonly is either
12492 @samp{_flush_func} or @samp{__cpu_flush}.
12494 @item mbranch-cost=@var{num}
12495 @opindex mbranch-cost
12496 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12497 This cost is only a heuristic and is not guaranteed to produce
12498 consistent results across releases.  A zero cost redundantly selects
12499 the default, which is based on the @option{-mtune} setting.
12501 @item -mbranch-likely
12502 @itemx -mno-branch-likely
12503 @opindex mbranch-likely
12504 @opindex mno-branch-likely
12505 Enable or disable use of Branch Likely instructions, regardless of the
12506 default for the selected architecture.  By default, Branch Likely
12507 instructions may be generated if they are supported by the selected
12508 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12509 and processors which implement those architectures; for those, Branch
12510 Likely instructions will not be generated by default because the MIPS32
12511 and MIPS64 architectures specifically deprecate their use.
12513 @item -mfp-exceptions
12514 @itemx -mno-fp-exceptions
12515 @opindex mfp-exceptions
12516 Specifies whether FP exceptions are enabled.  This affects how we schedule
12517 FP instructions for some processors.  The default is that FP exceptions are
12518 enabled.
12520 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12521 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12522 FP pipe.
12524 @item -mvr4130-align
12525 @itemx -mno-vr4130-align
12526 @opindex mvr4130-align
12527 The VR4130 pipeline is two-way superscalar, but can only issue two
12528 instructions together if the first one is 8-byte aligned.  When this
12529 option is enabled, GCC will align pairs of instructions that it
12530 thinks should execute in parallel.
12532 This option only has an effect when optimizing for the VR4130.
12533 It normally makes code faster, but at the expense of making it bigger.
12534 It is enabled by default at optimization level @option{-O3}.
12535 @end table
12537 @node MMIX Options
12538 @subsection MMIX Options
12539 @cindex MMIX Options
12541 These options are defined for the MMIX:
12543 @table @gcctabopt
12544 @item -mlibfuncs
12545 @itemx -mno-libfuncs
12546 @opindex mlibfuncs
12547 @opindex mno-libfuncs
12548 Specify that intrinsic library functions are being compiled, passing all
12549 values in registers, no matter the size.
12551 @item -mepsilon
12552 @itemx -mno-epsilon
12553 @opindex mepsilon
12554 @opindex mno-epsilon
12555 Generate floating-point comparison instructions that compare with respect
12556 to the @code{rE} epsilon register.
12558 @item -mabi=mmixware
12559 @itemx -mabi=gnu
12560 @opindex mabi-mmixware
12561 @opindex mabi=gnu
12562 Generate code that passes function parameters and return values that (in
12563 the called function) are seen as registers @code{$0} and up, as opposed to
12564 the GNU ABI which uses global registers @code{$231} and up.
12566 @item -mzero-extend
12567 @itemx -mno-zero-extend
12568 @opindex mzero-extend
12569 @opindex mno-zero-extend
12570 When reading data from memory in sizes shorter than 64 bits, use (do not
12571 use) zero-extending load instructions by default, rather than
12572 sign-extending ones.
12574 @item -mknuthdiv
12575 @itemx -mno-knuthdiv
12576 @opindex mknuthdiv
12577 @opindex mno-knuthdiv
12578 Make the result of a division yielding a remainder have the same sign as
12579 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12580 remainder follows the sign of the dividend.  Both methods are
12581 arithmetically valid, the latter being almost exclusively used.
12583 @item -mtoplevel-symbols
12584 @itemx -mno-toplevel-symbols
12585 @opindex mtoplevel-symbols
12586 @opindex mno-toplevel-symbols
12587 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12588 code can be used with the @code{PREFIX} assembly directive.
12590 @item -melf
12591 @opindex melf
12592 Generate an executable in the ELF format, rather than the default
12593 @samp{mmo} format used by the @command{mmix} simulator.
12595 @item -mbranch-predict
12596 @itemx -mno-branch-predict
12597 @opindex mbranch-predict
12598 @opindex mno-branch-predict
12599 Use (do not use) the probable-branch instructions, when static branch
12600 prediction indicates a probable branch.
12602 @item -mbase-addresses
12603 @itemx -mno-base-addresses
12604 @opindex mbase-addresses
12605 @opindex mno-base-addresses
12606 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12607 base address automatically generates a request (handled by the assembler
12608 and the linker) for a constant to be set up in a global register.  The
12609 register is used for one or more base address requests within the range 0
12610 to 255 from the value held in the register.  The generally leads to short
12611 and fast code, but the number of different data items that can be
12612 addressed is limited.  This means that a program that uses lots of static
12613 data may require @option{-mno-base-addresses}.
12615 @item -msingle-exit
12616 @itemx -mno-single-exit
12617 @opindex msingle-exit
12618 @opindex mno-single-exit
12619 Force (do not force) generated code to have a single exit point in each
12620 function.
12621 @end table
12623 @node MN10300 Options
12624 @subsection MN10300 Options
12625 @cindex MN10300 options
12627 These @option{-m} options are defined for Matsushita MN10300 architectures:
12629 @table @gcctabopt
12630 @item -mmult-bug
12631 @opindex mmult-bug
12632 Generate code to avoid bugs in the multiply instructions for the MN10300
12633 processors.  This is the default.
12635 @item -mno-mult-bug
12636 @opindex mno-mult-bug
12637 Do not generate code to avoid bugs in the multiply instructions for the
12638 MN10300 processors.
12640 @item -mam33
12641 @opindex mam33
12642 Generate code which uses features specific to the AM33 processor.
12644 @item -mno-am33
12645 @opindex mno-am33
12646 Do not generate code which uses features specific to the AM33 processor.  This
12647 is the default.
12649 @item -mreturn-pointer-on-d0
12650 @opindex mreturn-pointer-on-d0
12651 When generating a function which returns a pointer, return the pointer
12652 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12653 only in a0, and attempts to call such functions without a prototype
12654 would result in errors.  Note that this option is on by default; use
12655 @option{-mno-return-pointer-on-d0} to disable it.
12657 @item -mno-crt0
12658 @opindex mno-crt0
12659 Do not link in the C run-time initialization object file.
12661 @item -mrelax
12662 @opindex mrelax
12663 Indicate to the linker that it should perform a relaxation optimization pass
12664 to shorten branches, calls and absolute memory addresses.  This option only
12665 has an effect when used on the command line for the final link step.
12667 This option makes symbolic debugging impossible.
12668 @end table
12670 @node MT Options
12671 @subsection MT Options
12672 @cindex MT options
12674 These @option{-m} options are defined for Morpho MT architectures:
12676 @table @gcctabopt
12678 @item -march=@var{cpu-type}
12679 @opindex march
12680 Generate code that will run on @var{cpu-type}, which is the name of a system
12681 representing a certain processor type.  Possible values for
12682 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12683 @samp{ms1-16-003} and @samp{ms2}.
12685 When this option is not used, the default is @option{-march=ms1-16-002}.
12687 @item -mbacc
12688 @opindex mbacc
12689 Use byte loads and stores when generating code.
12691 @item -mno-bacc
12692 @opindex mno-bacc
12693 Do not use byte loads and stores when generating code.
12695 @item -msim
12696 @opindex msim
12697 Use simulator runtime
12699 @item -mno-crt0
12700 @opindex mno-crt0
12701 Do not link in the C run-time initialization object file
12702 @file{crti.o}.  Other run-time initialization and termination files
12703 such as @file{startup.o} and @file{exit.o} are still included on the
12704 linker command line.
12706 @end table
12708 @node PDP-11 Options
12709 @subsection PDP-11 Options
12710 @cindex PDP-11 Options
12712 These options are defined for the PDP-11:
12714 @table @gcctabopt
12715 @item -mfpu
12716 @opindex mfpu
12717 Use hardware FPP floating point.  This is the default.  (FIS floating
12718 point on the PDP-11/40 is not supported.)
12720 @item -msoft-float
12721 @opindex msoft-float
12722 Do not use hardware floating point.
12724 @item -mac0
12725 @opindex mac0
12726 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12728 @item -mno-ac0
12729 @opindex mno-ac0
12730 Return floating-point results in memory.  This is the default.
12732 @item -m40
12733 @opindex m40
12734 Generate code for a PDP-11/40.
12736 @item -m45
12737 @opindex m45
12738 Generate code for a PDP-11/45.  This is the default.
12740 @item -m10
12741 @opindex m10
12742 Generate code for a PDP-11/10.
12744 @item -mbcopy-builtin
12745 @opindex bcopy-builtin
12746 Use inline @code{movmemhi} patterns for copying memory.  This is the
12747 default.
12749 @item -mbcopy
12750 @opindex mbcopy
12751 Do not use inline @code{movmemhi} patterns for copying memory.
12753 @item -mint16
12754 @itemx -mno-int32
12755 @opindex mint16
12756 @opindex mno-int32
12757 Use 16-bit @code{int}.  This is the default.
12759 @item -mint32
12760 @itemx -mno-int16
12761 @opindex mint32
12762 @opindex mno-int16
12763 Use 32-bit @code{int}.
12765 @item -mfloat64
12766 @itemx -mno-float32
12767 @opindex mfloat64
12768 @opindex mno-float32
12769 Use 64-bit @code{float}.  This is the default.
12771 @item -mfloat32
12772 @itemx -mno-float64
12773 @opindex mfloat32
12774 @opindex mno-float64
12775 Use 32-bit @code{float}.
12777 @item -mabshi
12778 @opindex mabshi
12779 Use @code{abshi2} pattern.  This is the default.
12781 @item -mno-abshi
12782 @opindex mno-abshi
12783 Do not use @code{abshi2} pattern.
12785 @item -mbranch-expensive
12786 @opindex mbranch-expensive
12787 Pretend that branches are expensive.  This is for experimenting with
12788 code generation only.
12790 @item -mbranch-cheap
12791 @opindex mbranch-cheap
12792 Do not pretend that branches are expensive.  This is the default.
12794 @item -msplit
12795 @opindex msplit
12796 Generate code for a system with split I&D@.
12798 @item -mno-split
12799 @opindex mno-split
12800 Generate code for a system without split I&D@.  This is the default.
12802 @item -munix-asm
12803 @opindex munix-asm
12804 Use Unix assembler syntax.  This is the default when configured for
12805 @samp{pdp11-*-bsd}.
12807 @item -mdec-asm
12808 @opindex mdec-asm
12809 Use DEC assembler syntax.  This is the default when configured for any
12810 PDP-11 target other than @samp{pdp11-*-bsd}.
12811 @end table
12813 @node PowerPC Options
12814 @subsection PowerPC Options
12815 @cindex PowerPC options
12817 These are listed under @xref{RS/6000 and PowerPC Options}.
12819 @node RS/6000 and PowerPC Options
12820 @subsection IBM RS/6000 and PowerPC Options
12821 @cindex RS/6000 and PowerPC Options
12822 @cindex IBM RS/6000 and PowerPC Options
12824 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12825 @table @gcctabopt
12826 @item -mpower
12827 @itemx -mno-power
12828 @itemx -mpower2
12829 @itemx -mno-power2
12830 @itemx -mpowerpc
12831 @itemx -mno-powerpc
12832 @itemx -mpowerpc-gpopt
12833 @itemx -mno-powerpc-gpopt
12834 @itemx -mpowerpc-gfxopt
12835 @itemx -mno-powerpc-gfxopt
12836 @itemx -mpowerpc64
12837 @itemx -mno-powerpc64
12838 @itemx -mmfcrf
12839 @itemx -mno-mfcrf
12840 @itemx -mpopcntb
12841 @itemx -mno-popcntb
12842 @itemx -mfprnd
12843 @itemx -mno-fprnd
12844 @itemx -mcmpb
12845 @itemx -mno-cmpb
12846 @itemx -mmfpgpr
12847 @itemx -mno-mfpgpr
12848 @itemx -mhard-dfp
12849 @itemx -mno-hard-dfp
12850 @opindex mpower
12851 @opindex mno-power
12852 @opindex mpower2
12853 @opindex mno-power2
12854 @opindex mpowerpc
12855 @opindex mno-powerpc
12856 @opindex mpowerpc-gpopt
12857 @opindex mno-powerpc-gpopt
12858 @opindex mpowerpc-gfxopt
12859 @opindex mno-powerpc-gfxopt
12860 @opindex mpowerpc64
12861 @opindex mno-powerpc64
12862 @opindex mmfcrf
12863 @opindex mno-mfcrf
12864 @opindex mpopcntb
12865 @opindex mno-popcntb
12866 @opindex mfprnd
12867 @opindex mno-fprnd
12868 @opindex mcmpb
12869 @opindex mno-cmpb
12870 @opindex mmfpgpr
12871 @opindex mno-mfpgpr
12872 @opindex mhard-dfp
12873 @opindex mno-hard-dfp
12874 GCC supports two related instruction set architectures for the
12875 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12876 instructions supported by the @samp{rios} chip set used in the original
12877 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12878 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12879 the IBM 4xx, 6xx, and follow-on microprocessors.
12881 Neither architecture is a subset of the other.  However there is a
12882 large common subset of instructions supported by both.  An MQ
12883 register is included in processors supporting the POWER architecture.
12885 You use these options to specify which instructions are available on the
12886 processor you are using.  The default value of these options is
12887 determined when configuring GCC@.  Specifying the
12888 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12889 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12890 rather than the options listed above.
12892 The @option{-mpower} option allows GCC to generate instructions that
12893 are found only in the POWER architecture and to use the MQ register.
12894 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12895 to generate instructions that are present in the POWER2 architecture but
12896 not the original POWER architecture.
12898 The @option{-mpowerpc} option allows GCC to generate instructions that
12899 are found only in the 32-bit subset of the PowerPC architecture.
12900 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12901 GCC to use the optional PowerPC architecture instructions in the
12902 General Purpose group, including floating-point square root.  Specifying
12903 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12904 use the optional PowerPC architecture instructions in the Graphics
12905 group, including floating-point select.
12907 The @option{-mmfcrf} option allows GCC to generate the move from
12908 condition register field instruction implemented on the POWER4
12909 processor and other processors that support the PowerPC V2.01
12910 architecture.
12911 The @option{-mpopcntb} option allows GCC to generate the popcount and
12912 double precision FP reciprocal estimate instruction implemented on the
12913 POWER5 processor and other processors that support the PowerPC V2.02
12914 architecture.
12915 The @option{-mfprnd} option allows GCC to generate the FP round to
12916 integer instructions implemented on the POWER5+ processor and other
12917 processors that support the PowerPC V2.03 architecture.
12918 The @option{-mcmpb} option allows GCC to generate the compare bytes
12919 instruction implemented on the POWER6 processor and other processors
12920 that support the PowerPC V2.05 architecture.
12921 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12922 general purpose register instructions implemented on the POWER6X
12923 processor and other processors that support the extended PowerPC V2.05
12924 architecture.
12925 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12926 point instructions implemented on some POWER processors.
12928 The @option{-mpowerpc64} option allows GCC to generate the additional
12929 64-bit instructions that are found in the full PowerPC64 architecture
12930 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12931 @option{-mno-powerpc64}.
12933 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12934 will use only the instructions in the common subset of both
12935 architectures plus some special AIX common-mode calls, and will not use
12936 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12937 permits GCC to use any instruction from either architecture and to
12938 allow use of the MQ register; specify this for the Motorola MPC601.
12940 @item -mnew-mnemonics
12941 @itemx -mold-mnemonics
12942 @opindex mnew-mnemonics
12943 @opindex mold-mnemonics
12944 Select which mnemonics to use in the generated assembler code.  With
12945 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12946 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12947 assembler mnemonics defined for the POWER architecture.  Instructions
12948 defined in only one architecture have only one mnemonic; GCC uses that
12949 mnemonic irrespective of which of these options is specified.
12951 GCC defaults to the mnemonics appropriate for the architecture in
12952 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12953 value of these option.  Unless you are building a cross-compiler, you
12954 should normally not specify either @option{-mnew-mnemonics} or
12955 @option{-mold-mnemonics}, but should instead accept the default.
12957 @item -mcpu=@var{cpu_type}
12958 @opindex mcpu
12959 Set architecture type, register usage, choice of mnemonics, and
12960 instruction scheduling parameters for machine type @var{cpu_type}.
12961 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12962 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
12963 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12964 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12965 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12966 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
12967 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
12968 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
12969 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
12970 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
12972 @option{-mcpu=common} selects a completely generic processor.  Code
12973 generated under this option will run on any POWER or PowerPC processor.
12974 GCC will use only the instructions in the common subset of both
12975 architectures, and will not use the MQ register.  GCC assumes a generic
12976 processor model for scheduling purposes.
12978 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
12979 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
12980 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
12981 types, with an appropriate, generic processor model assumed for
12982 scheduling purposes.
12984 The other options specify a specific processor.  Code generated under
12985 those options will run best on that processor, and may not run at all on
12986 others.
12988 The @option{-mcpu} options automatically enable or disable the
12989 following options:
12991 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
12992 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
12993 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
12995 The particular options set for any particular CPU will vary between
12996 compiler versions, depending on what setting seems to produce optimal
12997 code for that CPU; it doesn't necessarily reflect the actual hardware's
12998 capabilities.  If you wish to set an individual option to a particular
12999 value, you may specify it after the @option{-mcpu} option, like
13000 @samp{-mcpu=970 -mno-altivec}.
13002 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13003 not enabled or disabled by the @option{-mcpu} option at present because
13004 AIX does not have full support for these options.  You may still
13005 enable or disable them individually if you're sure it'll work in your
13006 environment.
13008 @item -mtune=@var{cpu_type}
13009 @opindex mtune
13010 Set the instruction scheduling parameters for machine type
13011 @var{cpu_type}, but do not set the architecture type, register usage, or
13012 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13013 values for @var{cpu_type} are used for @option{-mtune} as for
13014 @option{-mcpu}.  If both are specified, the code generated will use the
13015 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13016 scheduling parameters set by @option{-mtune}.
13018 @item -mswdiv
13019 @itemx -mno-swdiv
13020 @opindex mswdiv
13021 @opindex mno-swdiv
13022 Generate code to compute division as reciprocal estimate and iterative
13023 refinement, creating opportunities for increased throughput.  This
13024 feature requires: optional PowerPC Graphics instruction set for single
13025 precision and FRE instruction for double precision, assuming divides
13026 cannot generate user-visible traps, and the domain values not include
13027 Infinities, denormals or zero denominator.
13029 @item -maltivec
13030 @itemx -mno-altivec
13031 @opindex maltivec
13032 @opindex mno-altivec
13033 Generate code that uses (does not use) AltiVec instructions, and also
13034 enable the use of built-in functions that allow more direct access to
13035 the AltiVec instruction set.  You may also need to set
13036 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13037 enhancements.
13039 @item -mvrsave
13040 @item -mno-vrsave
13041 @opindex mvrsave
13042 @opindex mno-vrsave
13043 Generate VRSAVE instructions when generating AltiVec code.
13045 @item -msecure-plt
13046 @opindex msecure-plt
13047 Generate code that allows ld and ld.so to build executables and shared
13048 libraries with non-exec .plt and .got sections.  This is a PowerPC
13049 32-bit SYSV ABI option.
13051 @item -mbss-plt
13052 @opindex mbss-plt
13053 Generate code that uses a BSS .plt section that ld.so fills in, and
13054 requires .plt and .got sections that are both writable and executable.
13055 This is a PowerPC 32-bit SYSV ABI option.
13057 @item -misel
13058 @itemx -mno-isel
13059 @opindex misel
13060 @opindex mno-isel
13061 This switch enables or disables the generation of ISEL instructions.
13063 @item -misel=@var{yes/no}
13064 This switch has been deprecated.  Use @option{-misel} and
13065 @option{-mno-isel} instead.
13067 @item -mspe
13068 @itemx -mno-spe
13069 @opindex mspe
13070 @opindex mno-spe
13071 This switch enables or disables the generation of SPE simd
13072 instructions.
13074 @item -mpaired
13075 @itemx -mno-paired
13076 @opindex mpaired
13077 @opindex mno-paired
13078 This switch enables or disables the generation of PAIRED simd
13079 instructions.
13081 @item -mspe=@var{yes/no}
13082 This option has been deprecated.  Use @option{-mspe} and
13083 @option{-mno-spe} instead.
13085 @item -mfloat-gprs=@var{yes/single/double/no}
13086 @itemx -mfloat-gprs
13087 @opindex mfloat-gprs
13088 This switch enables or disables the generation of floating point
13089 operations on the general purpose registers for architectures that
13090 support it.
13092 The argument @var{yes} or @var{single} enables the use of
13093 single-precision floating point operations.
13095 The argument @var{double} enables the use of single and
13096 double-precision floating point operations.
13098 The argument @var{no} disables floating point operations on the
13099 general purpose registers.
13101 This option is currently only available on the MPC854x.
13103 @item -m32
13104 @itemx -m64
13105 @opindex m32
13106 @opindex m64
13107 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13108 targets (including GNU/Linux).  The 32-bit environment sets int, long
13109 and pointer to 32 bits and generates code that runs on any PowerPC
13110 variant.  The 64-bit environment sets int to 32 bits and long and
13111 pointer to 64 bits, and generates code for PowerPC64, as for
13112 @option{-mpowerpc64}.
13114 @item -mfull-toc
13115 @itemx -mno-fp-in-toc
13116 @itemx -mno-sum-in-toc
13117 @itemx -mminimal-toc
13118 @opindex mfull-toc
13119 @opindex mno-fp-in-toc
13120 @opindex mno-sum-in-toc
13121 @opindex mminimal-toc
13122 Modify generation of the TOC (Table Of Contents), which is created for
13123 every executable file.  The @option{-mfull-toc} option is selected by
13124 default.  In that case, GCC will allocate at least one TOC entry for
13125 each unique non-automatic variable reference in your program.  GCC
13126 will also place floating-point constants in the TOC@.  However, only
13127 16,384 entries are available in the TOC@.
13129 If you receive a linker error message that saying you have overflowed
13130 the available TOC space, you can reduce the amount of TOC space used
13131 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13132 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13133 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13134 generate code to calculate the sum of an address and a constant at
13135 run-time instead of putting that sum into the TOC@.  You may specify one
13136 or both of these options.  Each causes GCC to produce very slightly
13137 slower and larger code at the expense of conserving TOC space.
13139 If you still run out of space in the TOC even when you specify both of
13140 these options, specify @option{-mminimal-toc} instead.  This option causes
13141 GCC to make only one TOC entry for every file.  When you specify this
13142 option, GCC will produce code that is slower and larger but which
13143 uses extremely little TOC space.  You may wish to use this option
13144 only on files that contain less frequently executed code.
13146 @item -maix64
13147 @itemx -maix32
13148 @opindex maix64
13149 @opindex maix32
13150 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13151 @code{long} type, and the infrastructure needed to support them.
13152 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13153 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13154 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13156 @item -mxl-compat
13157 @itemx -mno-xl-compat
13158 @opindex mxl-compat
13159 @opindex mno-xl-compat
13160 Produce code that conforms more closely to IBM XL compiler semantics
13161 when using AIX-compatible ABI.  Pass floating-point arguments to
13162 prototyped functions beyond the register save area (RSA) on the stack
13163 in addition to argument FPRs.  Do not assume that most significant
13164 double in 128-bit long double value is properly rounded when comparing
13165 values and converting to double.  Use XL symbol names for long double
13166 support routines.
13168 The AIX calling convention was extended but not initially documented to
13169 handle an obscure K&R C case of calling a function that takes the
13170 address of its arguments with fewer arguments than declared.  IBM XL
13171 compilers access floating point arguments which do not fit in the
13172 RSA from the stack when a subroutine is compiled without
13173 optimization.  Because always storing floating-point arguments on the
13174 stack is inefficient and rarely needed, this option is not enabled by
13175 default and only is necessary when calling subroutines compiled by IBM
13176 XL compilers without optimization.
13178 @item -mpe
13179 @opindex mpe
13180 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13181 application written to use message passing with special startup code to
13182 enable the application to run.  The system must have PE installed in the
13183 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13184 must be overridden with the @option{-specs=} option to specify the
13185 appropriate directory location.  The Parallel Environment does not
13186 support threads, so the @option{-mpe} option and the @option{-pthread}
13187 option are incompatible.
13189 @item -malign-natural
13190 @itemx -malign-power
13191 @opindex malign-natural
13192 @opindex malign-power
13193 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13194 @option{-malign-natural} overrides the ABI-defined alignment of larger
13195 types, such as floating-point doubles, on their natural size-based boundary.
13196 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13197 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13199 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13200 is not supported.
13202 @item -msoft-float
13203 @itemx -mhard-float
13204 @opindex msoft-float
13205 @opindex mhard-float
13206 Generate code that does not use (uses) the floating-point register set.
13207 Software floating point emulation is provided if you use the
13208 @option{-msoft-float} option, and pass the option to GCC when linking.
13210 @item -mmultiple
13211 @itemx -mno-multiple
13212 @opindex mmultiple
13213 @opindex mno-multiple
13214 Generate code that uses (does not use) the load multiple word
13215 instructions and the store multiple word instructions.  These
13216 instructions are generated by default on POWER systems, and not
13217 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13218 endian PowerPC systems, since those instructions do not work when the
13219 processor is in little endian mode.  The exceptions are PPC740 and
13220 PPC750 which permit the instructions usage in little endian mode.
13222 @item -mstring
13223 @itemx -mno-string
13224 @opindex mstring
13225 @opindex mno-string
13226 Generate code that uses (does not use) the load string instructions
13227 and the store string word instructions to save multiple registers and
13228 do small block moves.  These instructions are generated by default on
13229 POWER systems, and not generated on PowerPC systems.  Do not use
13230 @option{-mstring} on little endian PowerPC systems, since those
13231 instructions do not work when the processor is in little endian mode.
13232 The exceptions are PPC740 and PPC750 which permit the instructions
13233 usage in little endian mode.
13235 @item -mupdate
13236 @itemx -mno-update
13237 @opindex mupdate
13238 @opindex mno-update
13239 Generate code that uses (does not use) the load or store instructions
13240 that update the base register to the address of the calculated memory
13241 location.  These instructions are generated by default.  If you use
13242 @option{-mno-update}, there is a small window between the time that the
13243 stack pointer is updated and the address of the previous frame is
13244 stored, which means code that walks the stack frame across interrupts or
13245 signals may get corrupted data.
13247 @item -mfused-madd
13248 @itemx -mno-fused-madd
13249 @opindex mfused-madd
13250 @opindex mno-fused-madd
13251 Generate code that uses (does not use) the floating point multiply and
13252 accumulate instructions.  These instructions are generated by default if
13253 hardware floating is used.
13255 @item -mmulhw
13256 @itemx -mno-mulhw
13257 @opindex mmulhw
13258 @opindex mno-mulhw
13259 Generate code that uses (does not use) the half-word multiply and
13260 multiply-accumulate instructions on the IBM 405 and 440 processors.
13261 These instructions are generated by default when targetting those
13262 processors.
13264 @item -mdlmzb
13265 @itemx -mno-dlmzb
13266 @opindex mdlmzb
13267 @opindex mno-dlmzb
13268 Generate code that uses (does not use) the string-search @samp{dlmzb}
13269 instruction on the IBM 405 and 440 processors.  This instruction is
13270 generated by default when targetting those processors.
13272 @item -mno-bit-align
13273 @itemx -mbit-align
13274 @opindex mno-bit-align
13275 @opindex mbit-align
13276 On System V.4 and embedded PowerPC systems do not (do) force structures
13277 and unions that contain bit-fields to be aligned to the base type of the
13278 bit-field.
13280 For example, by default a structure containing nothing but 8
13281 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13282 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13283 the structure would be aligned to a 1 byte boundary and be one byte in
13284 size.
13286 @item -mno-strict-align
13287 @itemx -mstrict-align
13288 @opindex mno-strict-align
13289 @opindex mstrict-align
13290 On System V.4 and embedded PowerPC systems do not (do) assume that
13291 unaligned memory references will be handled by the system.
13293 @item -mrelocatable
13294 @itemx -mno-relocatable
13295 @opindex mrelocatable
13296 @opindex mno-relocatable
13297 On embedded PowerPC systems generate code that allows (does not allow)
13298 the program to be relocated to a different address at runtime.  If you
13299 use @option{-mrelocatable} on any module, all objects linked together must
13300 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13302 @item -mrelocatable-lib
13303 @itemx -mno-relocatable-lib
13304 @opindex mrelocatable-lib
13305 @opindex mno-relocatable-lib
13306 On embedded PowerPC systems generate code that allows (does not allow)
13307 the program to be relocated to a different address at runtime.  Modules
13308 compiled with @option{-mrelocatable-lib} can be linked with either modules
13309 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13310 with modules compiled with the @option{-mrelocatable} options.
13312 @item -mno-toc
13313 @itemx -mtoc
13314 @opindex mno-toc
13315 @opindex mtoc
13316 On System V.4 and embedded PowerPC systems do not (do) assume that
13317 register 2 contains a pointer to a global area pointing to the addresses
13318 used in the program.
13320 @item -mlittle
13321 @itemx -mlittle-endian
13322 @opindex mlittle
13323 @opindex mlittle-endian
13324 On System V.4 and embedded PowerPC systems compile code for the
13325 processor in little endian mode.  The @option{-mlittle-endian} option is
13326 the same as @option{-mlittle}.
13328 @item -mbig
13329 @itemx -mbig-endian
13330 @opindex mbig
13331 @opindex mbig-endian
13332 On System V.4 and embedded PowerPC systems compile code for the
13333 processor in big endian mode.  The @option{-mbig-endian} option is
13334 the same as @option{-mbig}.
13336 @item -mdynamic-no-pic
13337 @opindex mdynamic-no-pic
13338 On Darwin and Mac OS X systems, compile code so that it is not
13339 relocatable, but that its external references are relocatable.  The
13340 resulting code is suitable for applications, but not shared
13341 libraries.
13343 @item -mprioritize-restricted-insns=@var{priority}
13344 @opindex mprioritize-restricted-insns
13345 This option controls the priority that is assigned to
13346 dispatch-slot restricted instructions during the second scheduling
13347 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13348 @var{no/highest/second-highest} priority to dispatch slot restricted
13349 instructions.
13351 @item -msched-costly-dep=@var{dependence_type}
13352 @opindex msched-costly-dep
13353 This option controls which dependences are considered costly
13354 by the target during instruction scheduling.  The argument
13355 @var{dependence_type} takes one of the following values:
13356 @var{no}: no dependence is costly,
13357 @var{all}: all dependences are costly,
13358 @var{true_store_to_load}: a true dependence from store to load is costly,
13359 @var{store_to_load}: any dependence from store to load is costly,
13360 @var{number}: any dependence which latency >= @var{number} is costly.
13362 @item -minsert-sched-nops=@var{scheme}
13363 @opindex minsert-sched-nops
13364 This option controls which nop insertion scheme will be used during
13365 the second scheduling pass.  The argument @var{scheme} takes one of the
13366 following values:
13367 @var{no}: Don't insert nops.
13368 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13369 according to the scheduler's grouping.
13370 @var{regroup_exact}: Insert nops to force costly dependent insns into
13371 separate groups.  Insert exactly as many nops as needed to force an insn
13372 to a new group, according to the estimated processor grouping.
13373 @var{number}: Insert nops to force costly dependent insns into
13374 separate groups.  Insert @var{number} nops to force an insn to a new group.
13376 @item -mcall-sysv
13377 @opindex mcall-sysv
13378 On System V.4 and embedded PowerPC systems compile code using calling
13379 conventions that adheres to the March 1995 draft of the System V
13380 Application Binary Interface, PowerPC processor supplement.  This is the
13381 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13383 @item -mcall-sysv-eabi
13384 @opindex mcall-sysv-eabi
13385 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13387 @item -mcall-sysv-noeabi
13388 @opindex mcall-sysv-noeabi
13389 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13391 @item -mcall-solaris
13392 @opindex mcall-solaris
13393 On System V.4 and embedded PowerPC systems compile code for the Solaris
13394 operating system.
13396 @item -mcall-linux
13397 @opindex mcall-linux
13398 On System V.4 and embedded PowerPC systems compile code for the
13399 Linux-based GNU system.
13401 @item -mcall-gnu
13402 @opindex mcall-gnu
13403 On System V.4 and embedded PowerPC systems compile code for the
13404 Hurd-based GNU system.
13406 @item -mcall-netbsd
13407 @opindex mcall-netbsd
13408 On System V.4 and embedded PowerPC systems compile code for the
13409 NetBSD operating system.
13411 @item -maix-struct-return
13412 @opindex maix-struct-return
13413 Return all structures in memory (as specified by the AIX ABI)@.
13415 @item -msvr4-struct-return
13416 @opindex msvr4-struct-return
13417 Return structures smaller than 8 bytes in registers (as specified by the
13418 SVR4 ABI)@.
13420 @item -mabi=@var{abi-type}
13421 @opindex mabi
13422 Extend the current ABI with a particular extension, or remove such extension.
13423 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13424 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13426 @item -mabi=spe
13427 @opindex mabi=spe
13428 Extend the current ABI with SPE ABI extensions.  This does not change
13429 the default ABI, instead it adds the SPE ABI extensions to the current
13430 ABI@.
13432 @item -mabi=no-spe
13433 @opindex mabi=no-spe
13434 Disable Booke SPE ABI extensions for the current ABI@.
13436 @item -mabi=ibmlongdouble
13437 @opindex mabi=ibmlongdouble
13438 Change the current ABI to use IBM extended precision long double.
13439 This is a PowerPC 32-bit SYSV ABI option.
13441 @item -mabi=ieeelongdouble
13442 @opindex mabi=ieeelongdouble
13443 Change the current ABI to use IEEE extended precision long double.
13444 This is a PowerPC 32-bit Linux ABI option.
13446 @item -mprototype
13447 @itemx -mno-prototype
13448 @opindex mprototype
13449 @opindex mno-prototype
13450 On System V.4 and embedded PowerPC systems assume that all calls to
13451 variable argument functions are properly prototyped.  Otherwise, the
13452 compiler must insert an instruction before every non prototyped call to
13453 set or clear bit 6 of the condition code register (@var{CR}) to
13454 indicate whether floating point values were passed in the floating point
13455 registers in case the function takes a variable arguments.  With
13456 @option{-mprototype}, only calls to prototyped variable argument functions
13457 will set or clear the bit.
13459 @item -msim
13460 @opindex msim
13461 On embedded PowerPC systems, assume that the startup module is called
13462 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13463 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13464 configurations.
13466 @item -mmvme
13467 @opindex mmvme
13468 On embedded PowerPC systems, assume that the startup module is called
13469 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13470 @file{libc.a}.
13472 @item -mads
13473 @opindex mads
13474 On embedded PowerPC systems, assume that the startup module is called
13475 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13476 @file{libc.a}.
13478 @item -myellowknife
13479 @opindex myellowknife
13480 On embedded PowerPC systems, assume that the startup module is called
13481 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13482 @file{libc.a}.
13484 @item -mvxworks
13485 @opindex mvxworks
13486 On System V.4 and embedded PowerPC systems, specify that you are
13487 compiling for a VxWorks system.
13489 @item -mwindiss
13490 @opindex mwindiss
13491 Specify that you are compiling for the WindISS simulation environment.
13493 @item -memb
13494 @opindex memb
13495 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13496 header to indicate that @samp{eabi} extended relocations are used.
13498 @item -meabi
13499 @itemx -mno-eabi
13500 @opindex meabi
13501 @opindex mno-eabi
13502 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13503 Embedded Applications Binary Interface (eabi) which is a set of
13504 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13505 means that the stack is aligned to an 8 byte boundary, a function
13506 @code{__eabi} is called to from @code{main} to set up the eabi
13507 environment, and the @option{-msdata} option can use both @code{r2} and
13508 @code{r13} to point to two separate small data areas.  Selecting
13509 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13510 do not call an initialization function from @code{main}, and the
13511 @option{-msdata} option will only use @code{r13} to point to a single
13512 small data area.  The @option{-meabi} option is on by default if you
13513 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13515 @item -msdata=eabi
13516 @opindex msdata=eabi
13517 On System V.4 and embedded PowerPC systems, put small initialized
13518 @code{const} global and static data in the @samp{.sdata2} section, which
13519 is pointed to by register @code{r2}.  Put small initialized
13520 non-@code{const} global and static data in the @samp{.sdata} section,
13521 which is pointed to by register @code{r13}.  Put small uninitialized
13522 global and static data in the @samp{.sbss} section, which is adjacent to
13523 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13524 incompatible with the @option{-mrelocatable} option.  The
13525 @option{-msdata=eabi} option also sets the @option{-memb} option.
13527 @item -msdata=sysv
13528 @opindex msdata=sysv
13529 On System V.4 and embedded PowerPC systems, put small global and static
13530 data in the @samp{.sdata} section, which is pointed to by register
13531 @code{r13}.  Put small uninitialized global and static data in the
13532 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13533 The @option{-msdata=sysv} option is incompatible with the
13534 @option{-mrelocatable} option.
13536 @item -msdata=default
13537 @itemx -msdata
13538 @opindex msdata=default
13539 @opindex msdata
13540 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13541 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13542 same as @option{-msdata=sysv}.
13544 @item -msdata-data
13545 @opindex msdata-data
13546 On System V.4 and embedded PowerPC systems, put small global
13547 data in the @samp{.sdata} section.  Put small uninitialized global
13548 data in the @samp{.sbss} section.  Do not use register @code{r13}
13549 to address small data however.  This is the default behavior unless
13550 other @option{-msdata} options are used.
13552 @item -msdata=none
13553 @itemx -mno-sdata
13554 @opindex msdata=none
13555 @opindex mno-sdata
13556 On embedded PowerPC systems, put all initialized global and static data
13557 in the @samp{.data} section, and all uninitialized data in the
13558 @samp{.bss} section.
13560 @item -G @var{num}
13561 @opindex G
13562 @cindex smaller data references (PowerPC)
13563 @cindex .sdata/.sdata2 references (PowerPC)
13564 On embedded PowerPC systems, put global and static items less than or
13565 equal to @var{num} bytes into the small data or bss sections instead of
13566 the normal data or bss section.  By default, @var{num} is 8.  The
13567 @option{-G @var{num}} switch is also passed to the linker.
13568 All modules should be compiled with the same @option{-G @var{num}} value.
13570 @item -mregnames
13571 @itemx -mno-regnames
13572 @opindex mregnames
13573 @opindex mno-regnames
13574 On System V.4 and embedded PowerPC systems do (do not) emit register
13575 names in the assembly language output using symbolic forms.
13577 @item -mlongcall
13578 @itemx -mno-longcall
13579 @opindex mlongcall
13580 @opindex mno-longcall
13581 By default assume that all calls are far away so that a longer more
13582 expensive calling sequence is required.  This is required for calls
13583 further than 32 megabytes (33,554,432 bytes) from the current location.
13584 A short call will be generated if the compiler knows
13585 the call cannot be that far away.  This setting can be overridden by
13586 the @code{shortcall} function attribute, or by @code{#pragma
13587 longcall(0)}.
13589 Some linkers are capable of detecting out-of-range calls and generating
13590 glue code on the fly.  On these systems, long calls are unnecessary and
13591 generate slower code.  As of this writing, the AIX linker can do this,
13592 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13593 to the GNU linker for 32-bit PowerPC systems as well.
13595 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13596 callee, L42'', plus a ``branch island'' (glue code).  The two target
13597 addresses represent the callee and the ``branch island''.  The
13598 Darwin/PPC linker will prefer the first address and generate a ``bl
13599 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13600 otherwise, the linker will generate ``bl L42'' to call the ``branch
13601 island''.  The ``branch island'' is appended to the body of the
13602 calling function; it computes the full 32-bit address of the callee
13603 and jumps to it.
13605 On Mach-O (Darwin) systems, this option directs the compiler emit to
13606 the glue for every direct call, and the Darwin linker decides whether
13607 to use or discard it.
13609 In the future, we may cause GCC to ignore all longcall specifications
13610 when the linker is known to generate glue.
13612 @item -pthread
13613 @opindex pthread
13614 Adds support for multithreading with the @dfn{pthreads} library.
13615 This option sets flags for both the preprocessor and linker.
13617 @end table
13619 @node S/390 and zSeries Options
13620 @subsection S/390 and zSeries Options
13621 @cindex S/390 and zSeries Options
13623 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13625 @table @gcctabopt
13626 @item -mhard-float
13627 @itemx -msoft-float
13628 @opindex mhard-float
13629 @opindex msoft-float
13630 Use (do not use) the hardware floating-point instructions and registers
13631 for floating-point operations.  When @option{-msoft-float} is specified,
13632 functions in @file{libgcc.a} will be used to perform floating-point
13633 operations.  When @option{-mhard-float} is specified, the compiler
13634 generates IEEE floating-point instructions.  This is the default.
13636 @item -mlong-double-64
13637 @itemx -mlong-double-128
13638 @opindex mlong-double-64
13639 @opindex mlong-double-128
13640 These switches control the size of @code{long double} type. A size
13641 of 64bit makes the @code{long double} type equivalent to the @code{double}
13642 type. This is the default.
13644 @item -mbackchain
13645 @itemx -mno-backchain
13646 @opindex mbackchain
13647 @opindex mno-backchain
13648 Store (do not store) the address of the caller's frame as backchain pointer
13649 into the callee's stack frame.
13650 A backchain may be needed to allow debugging using tools that do not understand
13651 DWARF-2 call frame information.
13652 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13653 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13654 the backchain is placed into the topmost word of the 96/160 byte register
13655 save area.
13657 In general, code compiled with @option{-mbackchain} is call-compatible with
13658 code compiled with @option{-mmo-backchain}; however, use of the backchain
13659 for debugging purposes usually requires that the whole binary is built with
13660 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13661 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13662 to build a linux kernel use @option{-msoft-float}.
13664 The default is to not maintain the backchain.
13666 @item -mpacked-stack
13667 @item -mno-packed-stack
13668 @opindex mpacked-stack
13669 @opindex mno-packed-stack
13670 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13671 specified, the compiler uses the all fields of the 96/160 byte register save
13672 area only for their default purpose; unused fields still take up stack space.
13673 When @option{-mpacked-stack} is specified, register save slots are densely
13674 packed at the top of the register save area; unused space is reused for other
13675 purposes, allowing for more efficient use of the available stack space.
13676 However, when @option{-mbackchain} is also in effect, the topmost word of
13677 the save area is always used to store the backchain, and the return address
13678 register is always saved two words below the backchain.
13680 As long as the stack frame backchain is not used, code generated with
13681 @option{-mpacked-stack} is call-compatible with code generated with
13682 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13683 S/390 or zSeries generated code that uses the stack frame backchain at run
13684 time, not just for debugging purposes.  Such code is not call-compatible
13685 with code compiled with @option{-mpacked-stack}.  Also, note that the
13686 combination of @option{-mbackchain},
13687 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13688 to build a linux kernel use @option{-msoft-float}.
13690 The default is to not use the packed stack layout.
13692 @item -msmall-exec
13693 @itemx -mno-small-exec
13694 @opindex msmall-exec
13695 @opindex mno-small-exec
13696 Generate (or do not generate) code using the @code{bras} instruction
13697 to do subroutine calls.
13698 This only works reliably if the total executable size does not
13699 exceed 64k.  The default is to use the @code{basr} instruction instead,
13700 which does not have this limitation.
13702 @item -m64
13703 @itemx -m31
13704 @opindex m64
13705 @opindex m31
13706 When @option{-m31} is specified, generate code compliant to the
13707 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13708 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13709 particular to generate 64-bit instructions.  For the @samp{s390}
13710 targets, the default is @option{-m31}, while the @samp{s390x}
13711 targets default to @option{-m64}.
13713 @item -mzarch
13714 @itemx -mesa
13715 @opindex mzarch
13716 @opindex mesa
13717 When @option{-mzarch} is specified, generate code using the
13718 instructions available on z/Architecture.
13719 When @option{-mesa} is specified, generate code using the
13720 instructions available on ESA/390.  Note that @option{-mesa} is
13721 not possible with @option{-m64}.
13722 When generating code compliant to the GNU/Linux for S/390 ABI,
13723 the default is @option{-mesa}.  When generating code compliant
13724 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13726 @item -mmvcle
13727 @itemx -mno-mvcle
13728 @opindex mmvcle
13729 @opindex mno-mvcle
13730 Generate (or do not generate) code using the @code{mvcle} instruction
13731 to perform block moves.  When @option{-mno-mvcle} is specified,
13732 use a @code{mvc} loop instead.  This is the default unless optimizing for
13733 size.
13735 @item -mdebug
13736 @itemx -mno-debug
13737 @opindex mdebug
13738 @opindex mno-debug
13739 Print (or do not print) additional debug information when compiling.
13740 The default is to not print debug information.
13742 @item -march=@var{cpu-type}
13743 @opindex march
13744 Generate code that will run on @var{cpu-type}, which is the name of a system
13745 representing a certain processor type.  Possible values for
13746 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13747 When generating code using the instructions available on z/Architecture,
13748 the default is @option{-march=z900}.  Otherwise, the default is
13749 @option{-march=g5}.
13751 @item -mtune=@var{cpu-type}
13752 @opindex mtune
13753 Tune to @var{cpu-type} everything applicable about the generated code,
13754 except for the ABI and the set of available instructions.
13755 The list of @var{cpu-type} values is the same as for @option{-march}.
13756 The default is the value used for @option{-march}.
13758 @item -mtpf-trace
13759 @itemx -mno-tpf-trace
13760 @opindex mtpf-trace
13761 @opindex mno-tpf-trace
13762 Generate code that adds (does not add) in TPF OS specific branches to trace
13763 routines in the operating system.  This option is off by default, even
13764 when compiling for the TPF OS@.
13766 @item -mfused-madd
13767 @itemx -mno-fused-madd
13768 @opindex mfused-madd
13769 @opindex mno-fused-madd
13770 Generate code that uses (does not use) the floating point multiply and
13771 accumulate instructions.  These instructions are generated by default if
13772 hardware floating point is used.
13774 @item -mwarn-framesize=@var{framesize}
13775 @opindex mwarn-framesize
13776 Emit a warning if the current function exceeds the given frame size.  Because
13777 this is a compile time check it doesn't need to be a real problem when the program
13778 runs.  It is intended to identify functions which most probably cause
13779 a stack overflow.  It is useful to be used in an environment with limited stack
13780 size e.g.@: the linux kernel.
13782 @item -mwarn-dynamicstack
13783 @opindex mwarn-dynamicstack
13784 Emit a warning if the function calls alloca or uses dynamically
13785 sized arrays.  This is generally a bad idea with a limited stack size.
13787 @item -mstack-guard=@var{stack-guard}
13788 @item -mstack-size=@var{stack-size}
13789 @opindex mstack-guard
13790 @opindex mstack-size
13791 If these options are provided the s390 back end emits additional instructions in
13792 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13793 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13794 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13795 the frame size of the compiled function is chosen.
13796 These options are intended to be used to help debugging stack overflow problems.
13797 The additionally emitted code causes only little overhead and hence can also be
13798 used in production like systems without greater performance degradation.  The given
13799 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13800 @var{stack-guard} without exceeding 64k.
13801 In order to be efficient the extra code makes the assumption that the stack starts
13802 at an address aligned to the value given by @var{stack-size}.
13803 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13804 @end table
13806 @node Score Options
13807 @subsection Score Options
13808 @cindex Score Options
13810 These options are defined for Score implementations:
13812 @table @gcctabopt
13813 @item -meb
13814 @opindex meb
13815 Compile code for big endian mode.  This is the default.
13817 @item -mel
13818 @opindex mel
13819 Compile code for little endian mode. 
13821 @item -mnhwloop
13822 @opindex mnhwloop
13823 Disable generate bcnz instruction.
13825 @item -muls
13826 @opindex muls
13827 Enable generate unaligned load and store instruction.
13829 @item -mmac
13830 @opindex mmac
13831 Enable the use of multiply-accumulate instructions. Disabled by default. 
13833 @item -mscore5
13834 @opindex mscore5
13835 Specify the SCORE5 as the target architecture.
13837 @item -mscore5u
13838 @opindex mscore5u
13839 Specify the SCORE5U of the target architecture.
13841 @item -mscore7
13842 @opindex mscore7
13843 Specify the SCORE7 as the target architecture. This is the default.
13845 @item -mscore7d
13846 @opindex mscore7d
13847 Specify the SCORE7D as the target architecture.
13848 @end table
13850 @node SH Options
13851 @subsection SH Options
13853 These @samp{-m} options are defined for the SH implementations:
13855 @table @gcctabopt
13856 @item -m1
13857 @opindex m1
13858 Generate code for the SH1.
13860 @item -m2
13861 @opindex m2
13862 Generate code for the SH2.
13864 @item -m2e
13865 Generate code for the SH2e.
13867 @item -m3
13868 @opindex m3
13869 Generate code for the SH3.
13871 @item -m3e
13872 @opindex m3e
13873 Generate code for the SH3e.
13875 @item -m4-nofpu
13876 @opindex m4-nofpu
13877 Generate code for the SH4 without a floating-point unit.
13879 @item -m4-single-only
13880 @opindex m4-single-only
13881 Generate code for the SH4 with a floating-point unit that only
13882 supports single-precision arithmetic.
13884 @item -m4-single
13885 @opindex m4-single
13886 Generate code for the SH4 assuming the floating-point unit is in
13887 single-precision mode by default.
13889 @item -m4
13890 @opindex m4
13891 Generate code for the SH4.
13893 @item -m4a-nofpu
13894 @opindex m4a-nofpu
13895 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13896 floating-point unit is not used.
13898 @item -m4a-single-only
13899 @opindex m4a-single-only
13900 Generate code for the SH4a, in such a way that no double-precision
13901 floating point operations are used.
13903 @item -m4a-single
13904 @opindex m4a-single
13905 Generate code for the SH4a assuming the floating-point unit is in
13906 single-precision mode by default.
13908 @item -m4a
13909 @opindex m4a
13910 Generate code for the SH4a.
13912 @item -m4al
13913 @opindex m4al
13914 Same as @option{-m4a-nofpu}, except that it implicitly passes
13915 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13916 instructions at the moment.
13918 @item -mb
13919 @opindex mb
13920 Compile code for the processor in big endian mode.
13922 @item -ml
13923 @opindex ml
13924 Compile code for the processor in little endian mode.
13926 @item -mdalign
13927 @opindex mdalign
13928 Align doubles at 64-bit boundaries.  Note that this changes the calling
13929 conventions, and thus some functions from the standard C library will
13930 not work unless you recompile it first with @option{-mdalign}.
13932 @item -mrelax
13933 @opindex mrelax
13934 Shorten some address references at link time, when possible; uses the
13935 linker option @option{-relax}.
13937 @item -mbigtable
13938 @opindex mbigtable
13939 Use 32-bit offsets in @code{switch} tables.  The default is to use
13940 16-bit offsets.
13942 @item -mfmovd
13943 @opindex mfmovd
13944 Enable the use of the instruction @code{fmovd}.
13946 @item -mhitachi
13947 @opindex mhitachi
13948 Comply with the calling conventions defined by Renesas.
13950 @item -mrenesas
13951 @opindex mhitachi
13952 Comply with the calling conventions defined by Renesas.
13954 @item -mno-renesas
13955 @opindex mhitachi
13956 Comply with the calling conventions defined for GCC before the Renesas
13957 conventions were available.  This option is the default for all
13958 targets of the SH toolchain except for @samp{sh-symbianelf}.
13960 @item -mnomacsave
13961 @opindex mnomacsave
13962 Mark the @code{MAC} register as call-clobbered, even if
13963 @option{-mhitachi} is given.
13965 @item -mieee
13966 @opindex mieee
13967 Increase IEEE-compliance of floating-point code.
13968 At the moment, this is equivalent to @option{-fno-finite-math-only}.
13969 When generating 16 bit SH opcodes, getting IEEE-conforming results for
13970 comparisons of NANs / infinities incurs extra overhead in every
13971 floating point comparison, therefore the default is set to
13972 @option{-ffinite-math-only}.
13974 @item -minline-ic_invalidate
13975 @opindex minline-ic_invalidate
13976 Inline code to invalidate instruction cache entries after setting up
13977 nested function trampolines.
13978 This option has no effect if -musermode is in effect and the selected
13979 code generation option (e.g. -m4) does not allow the use of the icbi
13980 instruction.
13981 If the selected code generation option does not allow the use of the icbi
13982 instruction, and -musermode is not in effect, the inlined code will
13983 manipulate the instruction cache address array directly with an associative
13984 write.  This not only requires privileged mode, but it will also
13985 fail if the cache line had been mapped via the TLB and has become unmapped.
13987 @item -misize
13988 @opindex misize
13989 Dump instruction size and location in the assembly code.
13991 @item -mpadstruct
13992 @opindex mpadstruct
13993 This option is deprecated.  It pads structures to multiple of 4 bytes,
13994 which is incompatible with the SH ABI@.
13996 @item -mspace
13997 @opindex mspace
13998 Optimize for space instead of speed.  Implied by @option{-Os}.
14000 @item -mprefergot
14001 @opindex mprefergot
14002 When generating position-independent code, emit function calls using
14003 the Global Offset Table instead of the Procedure Linkage Table.
14005 @item -musermode
14006 @opindex musermode
14007 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14008 if the inlined code would not work in user mode.
14009 This is the default when the target is @code{sh-*-linux*}.
14011 @item -multcost=@var{number}
14012 @opindex multcost=@var{number}
14013 Set the cost to assume for a multiply insn.
14015 @item -mdiv=@var{strategy}
14016 @opindex mdiv=@var{strategy}
14017 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14018 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14019 inv:call2, inv:fp .
14020 "fp" performs the operation in floating point.  This has a very high latency,
14021 but needs only a few instructions, so it might be a good choice if
14022 your code has enough easily exploitable ILP to allow the compiler to
14023 schedule the floating point instructions together with other instructions.
14024 Division by zero causes a floating point exception.
14025 "inv" uses integer operations to calculate the inverse of the divisor,
14026 and then multiplies the dividend with the inverse.  This strategy allows
14027 cse and hoisting of the inverse calculation.  Division by zero calculates
14028 an unspecified result, but does not trap.
14029 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14030 have been found, or if the entire operation has been hoisted to the same
14031 place, the last stages of the inverse calculation are intertwined with the
14032 final multiply to reduce the overall latency, at the expense of using a few
14033 more instructions, and thus offering fewer scheduling opportunities with
14034 other code.
14035 "call" calls a library function that usually implements the inv:minlat
14036 strategy.
14037 This gives high code density for m5-*media-nofpu compilations.
14038 "call2" uses a different entry point of the same library function, where it
14039 assumes that a pointer to a lookup table has already been set up, which
14040 exposes the pointer load to cse / code hoisting optimizations.
14041 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14042 code generation, but if the code stays unoptimized, revert to the "call",
14043 "call2", or "fp" strategies, respectively.  Note that the
14044 potentially-trapping side effect of division by zero is carried by a
14045 separate instruction, so it is possible that all the integer instructions
14046 are hoisted out, but the marker for the side effect stays where it is.
14047 A recombination to fp operations or a call is not possible in that case.
14048 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14049 that the inverse calculation was nor separated from the multiply, they speed
14050 up division where the dividend fits into 20 bits (plus sign where applicable),
14051 by inserting a test to skip a number of operations in this case; this test
14052 slows down the case of larger dividends.  inv20u assumes the case of a such
14053 a small dividend to be unlikely, and inv20l assumes it to be likely.
14055 @item -mdivsi3_libfunc=@var{name}
14056 @opindex mdivsi3_libfunc=@var{name}
14057 Set the name of the library function used for 32 bit signed division to
14058 @var{name}.  This only affect the name used in the call and inv:call
14059 division strategies, and the compiler will still expect the same
14060 sets of input/output/clobbered registers as if this option was not present.
14062 @item -madjust-unroll
14063 @opindex madjust-unroll
14064 Throttle unrolling to avoid thrashing target registers.
14065 This option only has an effect if the gcc code base supports the
14066 TARGET_ADJUST_UNROLL_MAX target hook.
14068 @item -mindexed-addressing
14069 @opindex mindexed-addressing
14070 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14071 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14072 semantics for the indexed addressing mode.  The architecture allows the
14073 implementation of processors with 64 bit MMU, which the OS could use to
14074 get 32 bit addressing, but since no current hardware implementation supports
14075 this or any other way to make the indexed addressing mode safe to use in
14076 the 32 bit ABI, the default is -mno-indexed-addressing.
14078 @item -mgettrcost=@var{number}
14079 @opindex mgettrcost=@var{number}
14080 Set the cost assumed for the gettr instruction to @var{number}.
14081 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14083 @item -mpt-fixed
14084 @opindex mpt-fixed
14085 Assume pt* instructions won't trap.  This will generally generate better
14086 scheduled code, but is unsafe on current hardware.  The current architecture
14087 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14088 This has the unintentional effect of making it unsafe to schedule ptabs /
14089 ptrel before a branch, or hoist it out of a loop.  For example,
14090 __do_global_ctors, a part of libgcc that runs constructors at program
14091 startup, calls functions in a list which is delimited by @minus{}1.  With the
14092 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14093 That means that all the constructors will be run a bit quicker, but when
14094 the loop comes to the end of the list, the program crashes because ptabs
14095 loads @minus{}1 into a target register.  Since this option is unsafe for any
14096 hardware implementing the current architecture specification, the default
14097 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14098 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14099 this deters register allocation using target registers for storing
14100 ordinary integers.
14102 @item -minvalid-symbols
14103 @opindex minvalid-symbols
14104 Assume symbols might be invalid.  Ordinary function symbols generated by
14105 the compiler will always be valid to load with movi/shori/ptabs or
14106 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14107 to generate symbols that will cause ptabs / ptrel to trap.
14108 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14109 It will then prevent cross-basic-block cse, hoisting and most scheduling
14110 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14111 @end table
14113 @node SPARC Options
14114 @subsection SPARC Options
14115 @cindex SPARC options
14117 These @samp{-m} options are supported on the SPARC:
14119 @table @gcctabopt
14120 @item -mno-app-regs
14121 @itemx -mapp-regs
14122 @opindex mno-app-regs
14123 @opindex mapp-regs
14124 Specify @option{-mapp-regs} to generate output using the global registers
14125 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14126 is the default.
14128 To be fully SVR4 ABI compliant at the cost of some performance loss,
14129 specify @option{-mno-app-regs}.  You should compile libraries and system
14130 software with this option.
14132 @item -mfpu
14133 @itemx -mhard-float
14134 @opindex mfpu
14135 @opindex mhard-float
14136 Generate output containing floating point instructions.  This is the
14137 default.
14139 @item -mno-fpu
14140 @itemx -msoft-float
14141 @opindex mno-fpu
14142 @opindex msoft-float
14143 Generate output containing library calls for floating point.
14144 @strong{Warning:} the requisite libraries are not available for all SPARC
14145 targets.  Normally the facilities of the machine's usual C compiler are
14146 used, but this cannot be done directly in cross-compilation.  You must make
14147 your own arrangements to provide suitable library functions for
14148 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14149 @samp{sparclite-*-*} do provide software floating point support.
14151 @option{-msoft-float} changes the calling convention in the output file;
14152 therefore, it is only useful if you compile @emph{all} of a program with
14153 this option.  In particular, you need to compile @file{libgcc.a}, the
14154 library that comes with GCC, with @option{-msoft-float} in order for
14155 this to work.
14157 @item -mhard-quad-float
14158 @opindex mhard-quad-float
14159 Generate output containing quad-word (long double) floating point
14160 instructions.
14162 @item -msoft-quad-float
14163 @opindex msoft-quad-float
14164 Generate output containing library calls for quad-word (long double)
14165 floating point instructions.  The functions called are those specified
14166 in the SPARC ABI@.  This is the default.
14168 As of this writing, there are no SPARC implementations that have hardware
14169 support for the quad-word floating point instructions.  They all invoke
14170 a trap handler for one of these instructions, and then the trap handler
14171 emulates the effect of the instruction.  Because of the trap handler overhead,
14172 this is much slower than calling the ABI library routines.  Thus the
14173 @option{-msoft-quad-float} option is the default.
14175 @item -mno-unaligned-doubles
14176 @itemx -munaligned-doubles
14177 @opindex mno-unaligned-doubles
14178 @opindex munaligned-doubles
14179 Assume that doubles have 8 byte alignment.  This is the default.
14181 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14182 alignment only if they are contained in another type, or if they have an
14183 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14184 Specifying this option avoids some rare compatibility problems with code
14185 generated by other compilers.  It is not the default because it results
14186 in a performance loss, especially for floating point code.
14188 @item -mno-faster-structs
14189 @itemx -mfaster-structs
14190 @opindex mno-faster-structs
14191 @opindex mfaster-structs
14192 With @option{-mfaster-structs}, the compiler assumes that structures
14193 should have 8 byte alignment.  This enables the use of pairs of
14194 @code{ldd} and @code{std} instructions for copies in structure
14195 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14196 However, the use of this changed alignment directly violates the SPARC
14197 ABI@.  Thus, it's intended only for use on targets where the developer
14198 acknowledges that their resulting code will not be directly in line with
14199 the rules of the ABI@.
14201 @item -mimpure-text
14202 @opindex mimpure-text
14203 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14204 the compiler to not pass @option{-z text} to the linker when linking a
14205 shared object.  Using this option, you can link position-dependent
14206 code into a shared object.
14208 @option{-mimpure-text} suppresses the ``relocations remain against
14209 allocatable but non-writable sections'' linker error message.
14210 However, the necessary relocations will trigger copy-on-write, and the
14211 shared object is not actually shared across processes.  Instead of
14212 using @option{-mimpure-text}, you should compile all source code with
14213 @option{-fpic} or @option{-fPIC}.
14215 This option is only available on SunOS and Solaris.
14217 @item -mcpu=@var{cpu_type}
14218 @opindex mcpu
14219 Set the instruction set, register set, and instruction scheduling parameters
14220 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14221 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14222 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14223 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14224 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14226 Default instruction scheduling parameters are used for values that select
14227 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14228 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14230 Here is a list of each supported architecture and their supported
14231 implementations.
14233 @smallexample
14234     v7:             cypress
14235     v8:             supersparc, hypersparc
14236     sparclite:      f930, f934, sparclite86x
14237     sparclet:       tsc701
14238     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14239 @end smallexample
14241 By default (unless configured otherwise), GCC generates code for the V7
14242 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14243 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14244 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14245 SPARCStation 1, 2, IPX etc.
14247 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14248 architecture.  The only difference from V7 code is that the compiler emits
14249 the integer multiply and integer divide instructions which exist in SPARC-V8
14250 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14251 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14252 2000 series.
14254 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14255 the SPARC architecture.  This adds the integer multiply, integer divide step
14256 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14257 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14258 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14259 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14260 MB86934 chip, which is the more recent SPARClite with FPU@.
14262 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14263 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14264 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14265 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14266 optimizes it for the TEMIC SPARClet chip.
14268 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14269 architecture.  This adds 64-bit integer and floating-point move instructions,
14270 3 additional floating-point condition code registers and conditional move
14271 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14272 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14273 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14274 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14275 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14276 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14277 additionally optimizes it for Sun UltraSPARC T2 chips.
14279 @item -mtune=@var{cpu_type}
14280 @opindex mtune
14281 Set the instruction scheduling parameters for machine type
14282 @var{cpu_type}, but do not set the instruction set or register set that the
14283 option @option{-mcpu=@var{cpu_type}} would.
14285 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14286 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14287 that select a particular cpu implementation.  Those are @samp{cypress},
14288 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14289 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14290 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14292 @item -mv8plus
14293 @itemx -mno-v8plus
14294 @opindex mv8plus
14295 @opindex mno-v8plus
14296 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14297 difference from the V8 ABI is that the global and out registers are
14298 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14299 mode for all SPARC-V9 processors.
14301 @item -mvis
14302 @itemx -mno-vis
14303 @opindex mvis
14304 @opindex mno-vis
14305 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14306 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14307 @end table
14309 These @samp{-m} options are supported in addition to the above
14310 on SPARC-V9 processors in 64-bit environments:
14312 @table @gcctabopt
14313 @item -mlittle-endian
14314 @opindex mlittle-endian
14315 Generate code for a processor running in little-endian mode.  It is only
14316 available for a few configurations and most notably not on Solaris and Linux.
14318 @item -m32
14319 @itemx -m64
14320 @opindex m32
14321 @opindex m64
14322 Generate code for a 32-bit or 64-bit environment.
14323 The 32-bit environment sets int, long and pointer to 32 bits.
14324 The 64-bit environment sets int to 32 bits and long and pointer
14325 to 64 bits.
14327 @item -mcmodel=medlow
14328 @opindex mcmodel=medlow
14329 Generate code for the Medium/Low code model: 64-bit addresses, programs
14330 must be linked in the low 32 bits of memory.  Programs can be statically
14331 or dynamically linked.
14333 @item -mcmodel=medmid
14334 @opindex mcmodel=medmid
14335 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14336 must be linked in the low 44 bits of memory, the text and data segments must
14337 be less than 2GB in size and the data segment must be located within 2GB of
14338 the text segment.
14340 @item -mcmodel=medany
14341 @opindex mcmodel=medany
14342 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14343 may be linked anywhere in memory, the text and data segments must be less
14344 than 2GB in size and the data segment must be located within 2GB of the
14345 text segment.
14347 @item -mcmodel=embmedany
14348 @opindex mcmodel=embmedany
14349 Generate code for the Medium/Anywhere code model for embedded systems:
14350 64-bit addresses, the text and data segments must be less than 2GB in
14351 size, both starting anywhere in memory (determined at link time).  The
14352 global register %g4 points to the base of the data segment.  Programs
14353 are statically linked and PIC is not supported.
14355 @item -mstack-bias
14356 @itemx -mno-stack-bias
14357 @opindex mstack-bias
14358 @opindex mno-stack-bias
14359 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14360 frame pointer if present, are offset by @minus{}2047 which must be added back
14361 when making stack frame references.  This is the default in 64-bit mode.
14362 Otherwise, assume no such offset is present.
14363 @end table
14365 These switches are supported in addition to the above on Solaris:
14367 @table @gcctabopt
14368 @item -threads
14369 @opindex threads
14370 Add support for multithreading using the Solaris threads library.  This
14371 option sets flags for both the preprocessor and linker.  This option does
14372 not affect the thread safety of object code produced by the compiler or
14373 that of libraries supplied with it.
14375 @item -pthreads
14376 @opindex pthreads
14377 Add support for multithreading using the POSIX threads library.  This
14378 option sets flags for both the preprocessor and linker.  This option does
14379 not affect the thread safety of object code produced  by the compiler or
14380 that of libraries supplied with it.
14382 @item -pthread
14383 @opindex pthread
14384 This is a synonym for @option{-pthreads}.
14385 @end table
14387 @node SPU Options
14388 @subsection SPU Options
14389 @cindex SPU options
14391 These @samp{-m} options are supported on the SPU:
14393 @table @gcctabopt
14394 @item -mwarn-reloc
14395 @itemx -merror-reloc
14396 @opindex mwarn-reloc
14397 @opindex merror-reloc
14399 The loader for SPU does not handle dynamic relocations.  By default, GCC
14400 will give an error when it generates code that requires a dynamic
14401 relocation.  @option{-mno-error-reloc} disables the error,
14402 @option{-mwarn-reloc} will generate a warning instead.
14404 @item -msafe-dma
14405 @itemx -munsafe-dma
14406 @opindex msafe-dma
14407 @opindex munsafe-dma
14409 Instructions which initiate or test completion of DMA must not be
14410 reordered with respect to loads and stores of the memory which is being
14411 accessed.  Users typically address this problem using the volatile
14412 keyword, but that can lead to inefficient code in places where the
14413 memory is known to not change.  Rather than mark the memory as volatile
14414 we treat the DMA instructions as potentially effecting all memory.  With
14415 @option{-munsafe-dma} users must use the volatile keyword to protect
14416 memory accesses.
14418 @item -mbranch-hints
14419 @opindex mbranch-hints
14421 By default, GCC will generate a branch hint instruction to avoid
14422 pipeline stalls for always taken or probably taken branches.  A hint
14423 will not be generated closer than 8 instructions away from its branch.
14424 There is little reason to disable them, except for debugging purposes,
14425 or to make an object a little bit smaller.
14427 @item -msmall-mem
14428 @itemx -mlarge-mem
14429 @opindex msmall-mem
14430 @opindex mlarge-mem
14432 By default, GCC generates code assuming that addresses are never larger
14433 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14434 a full 32 bit address.
14436 @item -mstdmain
14437 @opindex mstdmain
14439 By default, GCC links against startup code that assumes the SPU-style
14440 main function interface (which has an unconventional parameter list).
14441 With @option{-mstdmain}, GCC will link your program against startup
14442 code that assumes a C99-style interface to @code{main}, including a
14443 local copy of @code{argv} strings.
14445 @item -mfixed-range=@var{register-range}
14446 @opindex mfixed-range
14447 Generate code treating the given register range as fixed registers.
14448 A fixed register is one that the register allocator can not use.  This is
14449 useful when compiling kernel code.  A register range is specified as
14450 two registers separated by a dash.  Multiple register ranges can be
14451 specified separated by a comma.
14453 @end table
14455 @node System V Options
14456 @subsection Options for System V
14458 These additional options are available on System V Release 4 for
14459 compatibility with other compilers on those systems:
14461 @table @gcctabopt
14462 @item -G
14463 @opindex G
14464 Create a shared object.
14465 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14467 @item -Qy
14468 @opindex Qy
14469 Identify the versions of each tool used by the compiler, in a
14470 @code{.ident} assembler directive in the output.
14472 @item -Qn
14473 @opindex Qn
14474 Refrain from adding @code{.ident} directives to the output file (this is
14475 the default).
14477 @item -YP,@var{dirs}
14478 @opindex YP
14479 Search the directories @var{dirs}, and no others, for libraries
14480 specified with @option{-l}.
14482 @item -Ym,@var{dir}
14483 @opindex Ym
14484 Look in the directory @var{dir} to find the M4 preprocessor.
14485 The assembler uses this option.
14486 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14487 @c the generic assembler that comes with Solaris takes just -Ym.
14488 @end table
14490 @node V850 Options
14491 @subsection V850 Options
14492 @cindex V850 Options
14494 These @samp{-m} options are defined for V850 implementations:
14496 @table @gcctabopt
14497 @item -mlong-calls
14498 @itemx -mno-long-calls
14499 @opindex mlong-calls
14500 @opindex mno-long-calls
14501 Treat all calls as being far away (near).  If calls are assumed to be
14502 far away, the compiler will always load the functions address up into a
14503 register, and call indirect through the pointer.
14505 @item -mno-ep
14506 @itemx -mep
14507 @opindex mno-ep
14508 @opindex mep
14509 Do not optimize (do optimize) basic blocks that use the same index
14510 pointer 4 or more times to copy pointer into the @code{ep} register, and
14511 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14512 option is on by default if you optimize.
14514 @item -mno-prolog-function
14515 @itemx -mprolog-function
14516 @opindex mno-prolog-function
14517 @opindex mprolog-function
14518 Do not use (do use) external functions to save and restore registers
14519 at the prologue and epilogue of a function.  The external functions
14520 are slower, but use less code space if more than one function saves
14521 the same number of registers.  The @option{-mprolog-function} option
14522 is on by default if you optimize.
14524 @item -mspace
14525 @opindex mspace
14526 Try to make the code as small as possible.  At present, this just turns
14527 on the @option{-mep} and @option{-mprolog-function} options.
14529 @item -mtda=@var{n}
14530 @opindex mtda
14531 Put static or global variables whose size is @var{n} bytes or less into
14532 the tiny data area that register @code{ep} points to.  The tiny data
14533 area can hold up to 256 bytes in total (128 bytes for byte references).
14535 @item -msda=@var{n}
14536 @opindex msda
14537 Put static or global variables whose size is @var{n} bytes or less into
14538 the small data area that register @code{gp} points to.  The small data
14539 area can hold up to 64 kilobytes.
14541 @item -mzda=@var{n}
14542 @opindex mzda
14543 Put static or global variables whose size is @var{n} bytes or less into
14544 the first 32 kilobytes of memory.
14546 @item -mv850
14547 @opindex mv850
14548 Specify that the target processor is the V850.
14550 @item -mbig-switch
14551 @opindex mbig-switch
14552 Generate code suitable for big switch tables.  Use this option only if
14553 the assembler/linker complain about out of range branches within a switch
14554 table.
14556 @item -mapp-regs
14557 @opindex mapp-regs
14558 This option will cause r2 and r5 to be used in the code generated by
14559 the compiler.  This setting is the default.
14561 @item -mno-app-regs
14562 @opindex mno-app-regs
14563 This option will cause r2 and r5 to be treated as fixed registers.
14565 @item -mv850e1
14566 @opindex mv850e1
14567 Specify that the target processor is the V850E1.  The preprocessor
14568 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14569 this option is used.
14571 @item -mv850e
14572 @opindex mv850e
14573 Specify that the target processor is the V850E@.  The preprocessor
14574 constant @samp{__v850e__} will be defined if this option is used.
14576 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14577 are defined then a default target processor will be chosen and the
14578 relevant @samp{__v850*__} preprocessor constant will be defined.
14580 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14581 defined, regardless of which processor variant is the target.
14583 @item -mdisable-callt
14584 @opindex mdisable-callt
14585 This option will suppress generation of the CALLT instruction for the
14586 v850e and v850e1 flavors of the v850 architecture.  The default is
14587 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14589 @end table
14591 @node VAX Options
14592 @subsection VAX Options
14593 @cindex VAX options
14595 These @samp{-m} options are defined for the VAX:
14597 @table @gcctabopt
14598 @item -munix
14599 @opindex munix
14600 Do not output certain jump instructions (@code{aobleq} and so on)
14601 that the Unix assembler for the VAX cannot handle across long
14602 ranges.
14604 @item -mgnu
14605 @opindex mgnu
14606 Do output those jump instructions, on the assumption that you
14607 will assemble with the GNU assembler.
14609 @item -mg
14610 @opindex mg
14611 Output code for g-format floating point numbers instead of d-format.
14612 @end table
14614 @node VxWorks Options
14615 @subsection VxWorks Options
14616 @cindex VxWorks Options
14618 The options in this section are defined for all VxWorks targets.
14619 Options specific to the target hardware are listed with the other
14620 options for that target.
14622 @table @gcctabopt
14623 @item -mrtp
14624 @opindex mrtp
14625 GCC can generate code for both VxWorks kernels and real time processes
14626 (RTPs).  This option switches from the former to the latter.  It also
14627 defines the preprocessor macro @code{__RTP__}.
14629 @item -non-static
14630 @opindex non-static
14631 Link an RTP executable against shared libraries rather than static
14632 libraries.  The options @option{-static} and @option{-shared} can
14633 also be used for RTPs (@pxref{Link Options}); @option{-static}
14634 is the default.
14636 @item -Bstatic
14637 @itemx -Bdynamic
14638 @opindex Bstatic
14639 @opindex Bdynamic
14640 These options are passed down to the linker.  They are defined for
14641 compatibility with Diab.
14643 @item -Xbind-lazy
14644 @opindex Xbind-lazy
14645 Enable lazy binding of function calls.  This option is equivalent to
14646 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14648 @item -Xbind-now
14649 @opindex Xbind-now
14650 Disable lazy binding of function calls.  This option is the default and
14651 is defined for compatibility with Diab.
14652 @end table
14654 @node x86-64 Options
14655 @subsection x86-64 Options
14656 @cindex x86-64 options
14658 These are listed under @xref{i386 and x86-64 Options}.
14660 @node Xstormy16 Options
14661 @subsection Xstormy16 Options
14662 @cindex Xstormy16 Options
14664 These options are defined for Xstormy16:
14666 @table @gcctabopt
14667 @item -msim
14668 @opindex msim
14669 Choose startup files and linker script suitable for the simulator.
14670 @end table
14672 @node Xtensa Options
14673 @subsection Xtensa Options
14674 @cindex Xtensa Options
14676 These options are supported for Xtensa targets:
14678 @table @gcctabopt
14679 @item -mconst16
14680 @itemx -mno-const16
14681 @opindex mconst16
14682 @opindex mno-const16
14683 Enable or disable use of @code{CONST16} instructions for loading
14684 constant values.  The @code{CONST16} instruction is currently not a
14685 standard option from Tensilica.  When enabled, @code{CONST16}
14686 instructions are always used in place of the standard @code{L32R}
14687 instructions.  The use of @code{CONST16} is enabled by default only if
14688 the @code{L32R} instruction is not available.
14690 @item -mfused-madd
14691 @itemx -mno-fused-madd
14692 @opindex mfused-madd
14693 @opindex mno-fused-madd
14694 Enable or disable use of fused multiply/add and multiply/subtract
14695 instructions in the floating-point option.  This has no effect if the
14696 floating-point option is not also enabled.  Disabling fused multiply/add
14697 and multiply/subtract instructions forces the compiler to use separate
14698 instructions for the multiply and add/subtract operations.  This may be
14699 desirable in some cases where strict IEEE 754-compliant results are
14700 required: the fused multiply add/subtract instructions do not round the
14701 intermediate result, thereby producing results with @emph{more} bits of
14702 precision than specified by the IEEE standard.  Disabling fused multiply
14703 add/subtract instructions also ensures that the program output is not
14704 sensitive to the compiler's ability to combine multiply and add/subtract
14705 operations.
14707 @item -mtext-section-literals
14708 @itemx -mno-text-section-literals
14709 @opindex mtext-section-literals
14710 @opindex mno-text-section-literals
14711 Control the treatment of literal pools.  The default is
14712 @option{-mno-text-section-literals}, which places literals in a separate
14713 section in the output file.  This allows the literal pool to be placed
14714 in a data RAM/ROM, and it also allows the linker to combine literal
14715 pools from separate object files to remove redundant literals and
14716 improve code size.  With @option{-mtext-section-literals}, the literals
14717 are interspersed in the text section in order to keep them as close as
14718 possible to their references.  This may be necessary for large assembly
14719 files.
14721 @item -mtarget-align
14722 @itemx -mno-target-align
14723 @opindex mtarget-align
14724 @opindex mno-target-align
14725 When this option is enabled, GCC instructs the assembler to
14726 automatically align instructions to reduce branch penalties at the
14727 expense of some code density.  The assembler attempts to widen density
14728 instructions to align branch targets and the instructions following call
14729 instructions.  If there are not enough preceding safe density
14730 instructions to align a target, no widening will be performed.  The
14731 default is @option{-mtarget-align}.  These options do not affect the
14732 treatment of auto-aligned instructions like @code{LOOP}, which the
14733 assembler will always align, either by widening density instructions or
14734 by inserting no-op instructions.
14736 @item -mlongcalls
14737 @itemx -mno-longcalls
14738 @opindex mlongcalls
14739 @opindex mno-longcalls
14740 When this option is enabled, GCC instructs the assembler to translate
14741 direct calls to indirect calls unless it can determine that the target
14742 of a direct call is in the range allowed by the call instruction.  This
14743 translation typically occurs for calls to functions in other source
14744 files.  Specifically, the assembler translates a direct @code{CALL}
14745 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14746 The default is @option{-mno-longcalls}.  This option should be used in
14747 programs where the call target can potentially be out of range.  This
14748 option is implemented in the assembler, not the compiler, so the
14749 assembly code generated by GCC will still show direct call
14750 instructions---look at the disassembled object code to see the actual
14751 instructions.  Note that the assembler will use an indirect call for
14752 every cross-file call, not just those that really will be out of range.
14753 @end table
14755 @node zSeries Options
14756 @subsection zSeries Options
14757 @cindex zSeries options
14759 These are listed under @xref{S/390 and zSeries Options}.
14761 @node Code Gen Options
14762 @section Options for Code Generation Conventions
14763 @cindex code generation conventions
14764 @cindex options, code generation
14765 @cindex run-time options
14767 These machine-independent options control the interface conventions
14768 used in code generation.
14770 Most of them have both positive and negative forms; the negative form
14771 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14772 one of the forms is listed---the one which is not the default.  You
14773 can figure out the other form by either removing @samp{no-} or adding
14776 @table @gcctabopt
14777 @item -fbounds-check
14778 @opindex fbounds-check
14779 For front-ends that support it, generate additional code to check that
14780 indices used to access arrays are within the declared range.  This is
14781 currently only supported by the Java and Fortran front-ends, where
14782 this option defaults to true and false respectively.
14784 @item -ftrapv
14785 @opindex ftrapv
14786 This option generates traps for signed overflow on addition, subtraction,
14787 multiplication operations.
14789 @item -fwrapv
14790 @opindex fwrapv
14791 This option instructs the compiler to assume that signed arithmetic
14792 overflow of addition, subtraction and multiplication wraps around
14793 using twos-complement representation.  This flag enables some optimizations
14794 and disables others.  This option is enabled by default for the Java
14795 front-end, as required by the Java language specification.
14797 @item -fexceptions
14798 @opindex fexceptions
14799 Enable exception handling.  Generates extra code needed to propagate
14800 exceptions.  For some targets, this implies GCC will generate frame
14801 unwind information for all functions, which can produce significant data
14802 size overhead, although it does not affect execution.  If you do not
14803 specify this option, GCC will enable it by default for languages like
14804 C++ which normally require exception handling, and disable it for
14805 languages like C that do not normally require it.  However, you may need
14806 to enable this option when compiling C code that needs to interoperate
14807 properly with exception handlers written in C++.  You may also wish to
14808 disable this option if you are compiling older C++ programs that don't
14809 use exception handling.
14811 @item -fnon-call-exceptions
14812 @opindex fnon-call-exceptions
14813 Generate code that allows trapping instructions to throw exceptions.
14814 Note that this requires platform-specific runtime support that does
14815 not exist everywhere.  Moreover, it only allows @emph{trapping}
14816 instructions to throw exceptions, i.e.@: memory references or floating
14817 point instructions.  It does not allow exceptions to be thrown from
14818 arbitrary signal handlers such as @code{SIGALRM}.
14820 @item -funwind-tables
14821 @opindex funwind-tables
14822 Similar to @option{-fexceptions}, except that it will just generate any needed
14823 static data, but will not affect the generated code in any other way.
14824 You will normally not enable this option; instead, a language processor
14825 that needs this handling would enable it on your behalf.
14827 @item -fasynchronous-unwind-tables
14828 @opindex fasynchronous-unwind-tables
14829 Generate unwind table in dwarf2 format, if supported by target machine.  The
14830 table is exact at each instruction boundary, so it can be used for stack
14831 unwinding from asynchronous events (such as debugger or garbage collector).
14833 @item -fpcc-struct-return
14834 @opindex fpcc-struct-return
14835 Return ``short'' @code{struct} and @code{union} values in memory like
14836 longer ones, rather than in registers.  This convention is less
14837 efficient, but it has the advantage of allowing intercallability between
14838 GCC-compiled files and files compiled with other compilers, particularly
14839 the Portable C Compiler (pcc).
14841 The precise convention for returning structures in memory depends
14842 on the target configuration macros.
14844 Short structures and unions are those whose size and alignment match
14845 that of some integer type.
14847 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14848 switch is not binary compatible with code compiled with the
14849 @option{-freg-struct-return} switch.
14850 Use it to conform to a non-default application binary interface.
14852 @item -freg-struct-return
14853 @opindex freg-struct-return
14854 Return @code{struct} and @code{union} values in registers when possible.
14855 This is more efficient for small structures than
14856 @option{-fpcc-struct-return}.
14858 If you specify neither @option{-fpcc-struct-return} nor
14859 @option{-freg-struct-return}, GCC defaults to whichever convention is
14860 standard for the target.  If there is no standard convention, GCC
14861 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14862 the principal compiler.  In those cases, we can choose the standard, and
14863 we chose the more efficient register return alternative.
14865 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14866 switch is not binary compatible with code compiled with the
14867 @option{-fpcc-struct-return} switch.
14868 Use it to conform to a non-default application binary interface.
14870 @item -fshort-enums
14871 @opindex fshort-enums
14872 Allocate to an @code{enum} type only as many bytes as it needs for the
14873 declared range of possible values.  Specifically, the @code{enum} type
14874 will be equivalent to the smallest integer type which has enough room.
14876 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14877 code that is not binary compatible with code generated without that switch.
14878 Use it to conform to a non-default application binary interface.
14880 @item -fshort-double
14881 @opindex fshort-double
14882 Use the same size for @code{double} as for @code{float}.
14884 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14885 code that is not binary compatible with code generated without that switch.
14886 Use it to conform to a non-default application binary interface.
14888 @item -fshort-wchar
14889 @opindex fshort-wchar
14890 Override the underlying type for @samp{wchar_t} to be @samp{short
14891 unsigned int} instead of the default for the target.  This option is
14892 useful for building programs to run under WINE@.
14894 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14895 code that is not binary compatible with code generated without that switch.
14896 Use it to conform to a non-default application binary interface.
14898 @item -fno-common
14899 @opindex fno-common
14900 In C, allocate even uninitialized global variables in the data section of the
14901 object file, rather than generating them as common blocks.  This has the
14902 effect that if the same variable is declared (without @code{extern}) in
14903 two different compilations, you will get an error when you link them.
14904 The only reason this might be useful is if you wish to verify that the
14905 program will work on other systems which always work this way.
14907 @item -fno-ident
14908 @opindex fno-ident
14909 Ignore the @samp{#ident} directive.
14911 @item -finhibit-size-directive
14912 @opindex finhibit-size-directive
14913 Don't output a @code{.size} assembler directive, or anything else that
14914 would cause trouble if the function is split in the middle, and the
14915 two halves are placed at locations far apart in memory.  This option is
14916 used when compiling @file{crtstuff.c}; you should not need to use it
14917 for anything else.
14919 @item -fverbose-asm
14920 @opindex fverbose-asm
14921 Put extra commentary information in the generated assembly code to
14922 make it more readable.  This option is generally only of use to those
14923 who actually need to read the generated assembly code (perhaps while
14924 debugging the compiler itself).
14926 @option{-fno-verbose-asm}, the default, causes the
14927 extra information to be omitted and is useful when comparing two assembler
14928 files.
14930 @item -frecord-gcc-switches
14931 @opindex frecord-gcc-switches
14932 This switch causes the command line that was used to invoke the
14933 compiler to be recorded into the object file that is being created.
14934 This switch is only implemented on some targets and the exact format
14935 of the recording is target and binary file format dependent, but it
14936 usually takes the form of a section containing ASCII text.  This
14937 switch is related to the @option{-fverbose-asm} switch, but that
14938 switch only records information in the assembler output file as
14939 comments, so it never reaches the object file.
14941 @item -fpic
14942 @opindex fpic
14943 @cindex global offset table
14944 @cindex PIC
14945 Generate position-independent code (PIC) suitable for use in a shared
14946 library, if supported for the target machine.  Such code accesses all
14947 constant addresses through a global offset table (GOT)@.  The dynamic
14948 loader resolves the GOT entries when the program starts (the dynamic
14949 loader is not part of GCC; it is part of the operating system).  If
14950 the GOT size for the linked executable exceeds a machine-specific
14951 maximum size, you get an error message from the linker indicating that
14952 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14953 instead.  (These maximums are 8k on the SPARC and 32k
14954 on the m68k and RS/6000.  The 386 has no such limit.)
14956 Position-independent code requires special support, and therefore works
14957 only on certain machines.  For the 386, GCC supports PIC for System V
14958 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
14959 position-independent.
14961 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14962 are defined to 1.
14964 @item -fPIC
14965 @opindex fPIC
14966 If supported for the target machine, emit position-independent code,
14967 suitable for dynamic linking and avoiding any limit on the size of the
14968 global offset table.  This option makes a difference on the m68k,
14969 PowerPC and SPARC@.
14971 Position-independent code requires special support, and therefore works
14972 only on certain machines.
14974 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14975 are defined to 2.
14977 @item -fpie
14978 @itemx -fPIE
14979 @opindex fpie
14980 @opindex fPIE
14981 These options are similar to @option{-fpic} and @option{-fPIC}, but
14982 generated position independent code can be only linked into executables.
14983 Usually these options are used when @option{-pie} GCC option will be
14984 used during linking.
14986 @option{-fpie} and @option{-fPIE} both define the macros
14987 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
14988 for @option{-fpie} and 2 for @option{-fPIE}.
14990 @item -fno-jump-tables
14991 @opindex fno-jump-tables
14992 Do not use jump tables for switch statements even where it would be
14993 more efficient than other code generation strategies.  This option is
14994 of use in conjunction with @option{-fpic} or @option{-fPIC} for
14995 building code which forms part of a dynamic linker and cannot
14996 reference the address of a jump table.  On some targets, jump tables
14997 do not require a GOT and this option is not needed.
14999 @item -ffixed-@var{reg}
15000 @opindex ffixed
15001 Treat the register named @var{reg} as a fixed register; generated code
15002 should never refer to it (except perhaps as a stack pointer, frame
15003 pointer or in some other fixed role).
15005 @var{reg} must be the name of a register.  The register names accepted
15006 are machine-specific and are defined in the @code{REGISTER_NAMES}
15007 macro in the machine description macro file.
15009 This flag does not have a negative form, because it specifies a
15010 three-way choice.
15012 @item -fcall-used-@var{reg}
15013 @opindex fcall-used
15014 Treat the register named @var{reg} as an allocable register that is
15015 clobbered by function calls.  It may be allocated for temporaries or
15016 variables that do not live across a call.  Functions compiled this way
15017 will not save and restore the register @var{reg}.
15019 It is an error to used this flag with the frame pointer or stack pointer.
15020 Use of this flag for other registers that have fixed pervasive roles in
15021 the machine's execution model will produce disastrous results.
15023 This flag does not have a negative form, because it specifies a
15024 three-way choice.
15026 @item -fcall-saved-@var{reg}
15027 @opindex fcall-saved
15028 Treat the register named @var{reg} as an allocable register saved by
15029 functions.  It may be allocated even for temporaries or variables that
15030 live across a call.  Functions compiled this way will save and restore
15031 the register @var{reg} if they use it.
15033 It is an error to used this flag with the frame pointer or stack pointer.
15034 Use of this flag for other registers that have fixed pervasive roles in
15035 the machine's execution model will produce disastrous results.
15037 A different sort of disaster will result from the use of this flag for
15038 a register in which function values may be returned.
15040 This flag does not have a negative form, because it specifies a
15041 three-way choice.
15043 @item -fpack-struct[=@var{n}]
15044 @opindex fpack-struct
15045 Without a value specified, pack all structure members together without
15046 holes.  When a value is specified (which must be a small power of two), pack
15047 structure members according to this value, representing the maximum
15048 alignment (that is, objects with default alignment requirements larger than
15049 this will be output potentially unaligned at the next fitting location.
15051 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15052 code that is not binary compatible with code generated without that switch.
15053 Additionally, it makes the code suboptimal.
15054 Use it to conform to a non-default application binary interface.
15056 @item -finstrument-functions
15057 @opindex finstrument-functions
15058 Generate instrumentation calls for entry and exit to functions.  Just
15059 after function entry and just before function exit, the following
15060 profiling functions will be called with the address of the current
15061 function and its call site.  (On some platforms,
15062 @code{__builtin_return_address} does not work beyond the current
15063 function, so the call site information may not be available to the
15064 profiling functions otherwise.)
15066 @smallexample
15067 void __cyg_profile_func_enter (void *this_fn,
15068                                void *call_site);
15069 void __cyg_profile_func_exit  (void *this_fn,
15070                                void *call_site);
15071 @end smallexample
15073 The first argument is the address of the start of the current function,
15074 which may be looked up exactly in the symbol table.
15076 This instrumentation is also done for functions expanded inline in other
15077 functions.  The profiling calls will indicate where, conceptually, the
15078 inline function is entered and exited.  This means that addressable
15079 versions of such functions must be available.  If all your uses of a
15080 function are expanded inline, this may mean an additional expansion of
15081 code size.  If you use @samp{extern inline} in your C code, an
15082 addressable version of such functions must be provided.  (This is
15083 normally the case anyways, but if you get lucky and the optimizer always
15084 expands the functions inline, you might have gotten away without
15085 providing static copies.)
15087 A function may be given the attribute @code{no_instrument_function}, in
15088 which case this instrumentation will not be done.  This can be used, for
15089 example, for the profiling functions listed above, high-priority
15090 interrupt routines, and any functions from which the profiling functions
15091 cannot safely be called (perhaps signal handlers, if the profiling
15092 routines generate output or allocate memory).
15094 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15095 @opindex finstrument-functions-exclude-file-list
15097 Set the list of functions that are excluded from instrumentation (see
15098 the description of @code{-finstrument-functions}).  If the file that
15099 contains a function definition matches with one of @var{file}, then
15100 that function is not instrumented.  The match is done on substrings:
15101 if the @var{file} parameter is a substring of the file name, it is
15102 considered to be a match.
15104 For example,
15105 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15106 will exclude any inline function defined in files whose pathnames
15107 contain @code{/bits/stl} or @code{include/sys}.
15109 If, for some reason, you want to include letter @code{','} in one of
15110 @var{sym}, write @code{'\,'}. For example,
15111 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15112 (note the single quote surrounding the option).
15114 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15115 @opindex finstrument-functions-exclude-function-list
15117 This is similar to @code{-finstrument-functions-exclude-file-list},
15118 but this option sets the list of function names to be excluded from
15119 instrumentation.  The function name to be matched is its user-visible
15120 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15121 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15122 match is done on substrings: if the @var{sym} parameter is a substring
15123 of the function name, it is considered to be a match.
15125 @item -fstack-check
15126 @opindex fstack-check
15127 Generate code to verify that you do not go beyond the boundary of the
15128 stack.  You should specify this flag if you are running in an
15129 environment with multiple threads, but only rarely need to specify it in
15130 a single-threaded environment since stack overflow is automatically
15131 detected on nearly all systems if there is only one stack.
15133 Note that this switch does not actually cause checking to be done; the
15134 operating system must do that.  The switch causes generation of code
15135 to ensure that the operating system sees the stack being extended.
15137 @item -fstack-limit-register=@var{reg}
15138 @itemx -fstack-limit-symbol=@var{sym}
15139 @itemx -fno-stack-limit
15140 @opindex fstack-limit-register
15141 @opindex fstack-limit-symbol
15142 @opindex fno-stack-limit
15143 Generate code to ensure that the stack does not grow beyond a certain value,
15144 either the value of a register or the address of a symbol.  If the stack
15145 would grow beyond the value, a signal is raised.  For most targets,
15146 the signal is raised before the stack overruns the boundary, so
15147 it is possible to catch the signal without taking special precautions.
15149 For instance, if the stack starts at absolute address @samp{0x80000000}
15150 and grows downwards, you can use the flags
15151 @option{-fstack-limit-symbol=__stack_limit} and
15152 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15153 of 128KB@.  Note that this may only work with the GNU linker.
15155 @cindex aliasing of parameters
15156 @cindex parameters, aliased
15157 @item -fargument-alias
15158 @itemx -fargument-noalias
15159 @itemx -fargument-noalias-global
15160 @itemx -fargument-noalias-anything
15161 @opindex fargument-alias
15162 @opindex fargument-noalias
15163 @opindex fargument-noalias-global
15164 @opindex fargument-noalias-anything
15165 Specify the possible relationships among parameters and between
15166 parameters and global data.
15168 @option{-fargument-alias} specifies that arguments (parameters) may
15169 alias each other and may alias global storage.@*
15170 @option{-fargument-noalias} specifies that arguments do not alias
15171 each other, but may alias global storage.@*
15172 @option{-fargument-noalias-global} specifies that arguments do not
15173 alias each other and do not alias global storage.
15174 @option{-fargument-noalias-anything} specifies that arguments do not
15175 alias any other storage.
15177 Each language will automatically use whatever option is required by
15178 the language standard.  You should not need to use these options yourself.
15180 @item -fleading-underscore
15181 @opindex fleading-underscore
15182 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15183 change the way C symbols are represented in the object file.  One use
15184 is to help link with legacy assembly code.
15186 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15187 generate code that is not binary compatible with code generated without that
15188 switch.  Use it to conform to a non-default application binary interface.
15189 Not all targets provide complete support for this switch.
15191 @item -ftls-model=@var{model}
15192 @opindex ftls-model
15193 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15194 The @var{model} argument should be one of @code{global-dynamic},
15195 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15197 The default without @option{-fpic} is @code{initial-exec}; with
15198 @option{-fpic} the default is @code{global-dynamic}.
15200 @item -fvisibility=@var{default|internal|hidden|protected}
15201 @opindex fvisibility
15202 Set the default ELF image symbol visibility to the specified option---all
15203 symbols will be marked with this unless overridden within the code.
15204 Using this feature can very substantially improve linking and
15205 load times of shared object libraries, produce more optimized
15206 code, provide near-perfect API export and prevent symbol clashes.
15207 It is @strong{strongly} recommended that you use this in any shared objects
15208 you distribute.
15210 Despite the nomenclature, @code{default} always means public ie;
15211 available to be linked against from outside the shared object.
15212 @code{protected} and @code{internal} are pretty useless in real-world
15213 usage so the only other commonly used option will be @code{hidden}.
15214 The default if @option{-fvisibility} isn't specified is
15215 @code{default}, i.e., make every
15216 symbol public---this causes the same behavior as previous versions of
15217 GCC@.
15219 A good explanation of the benefits offered by ensuring ELF
15220 symbols have the correct visibility is given by ``How To Write
15221 Shared Libraries'' by Ulrich Drepper (which can be found at
15222 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15223 solution made possible by this option to marking things hidden when
15224 the default is public is to make the default hidden and mark things
15225 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15226 and @code{__attribute__ ((visibility("default")))} instead of
15227 @code{__declspec(dllexport)} you get almost identical semantics with
15228 identical syntax.  This is a great boon to those working with
15229 cross-platform projects.
15231 For those adding visibility support to existing code, you may find
15232 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15233 the declarations you wish to set visibility for with (for example)
15234 @samp{#pragma GCC visibility push(hidden)} and
15235 @samp{#pragma GCC visibility pop}.
15236 Bear in mind that symbol visibility should be viewed @strong{as
15237 part of the API interface contract} and thus all new code should
15238 always specify visibility when it is not the default ie; declarations
15239 only for use within the local DSO should @strong{always} be marked explicitly
15240 as hidden as so to avoid PLT indirection overheads---making this
15241 abundantly clear also aids readability and self-documentation of the code.
15242 Note that due to ISO C++ specification requirements, operator new and
15243 operator delete must always be of default visibility.
15245 Be aware that headers from outside your project, in particular system
15246 headers and headers from any other library you use, may not be
15247 expecting to be compiled with visibility other than the default.  You
15248 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15249 before including any such headers.
15251 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15252 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15253 no modifications.  However, this means that calls to @samp{extern}
15254 functions with no explicit visibility will use the PLT, so it is more
15255 effective to use @samp{__attribute ((visibility))} and/or
15256 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15257 declarations should be treated as hidden.
15259 Note that @samp{-fvisibility} does affect C++ vague linkage
15260 entities. This means that, for instance, an exception class that will
15261 be thrown between DSOs must be explicitly marked with default
15262 visibility so that the @samp{type_info} nodes will be unified between
15263 the DSOs.
15265 An overview of these techniques, their benefits and how to use them
15266 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15268 @end table
15270 @c man end
15272 @node Environment Variables
15273 @section Environment Variables Affecting GCC
15274 @cindex environment variables
15276 @c man begin ENVIRONMENT
15277 This section describes several environment variables that affect how GCC
15278 operates.  Some of them work by specifying directories or prefixes to use
15279 when searching for various kinds of files.  Some are used to specify other
15280 aspects of the compilation environment.
15282 Note that you can also specify places to search using options such as
15283 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15284 take precedence over places specified using environment variables, which
15285 in turn take precedence over those specified by the configuration of GCC@.
15286 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15287 GNU Compiler Collection (GCC) Internals}.
15289 @table @env
15290 @item LANG
15291 @itemx LC_CTYPE
15292 @c @itemx LC_COLLATE
15293 @itemx LC_MESSAGES
15294 @c @itemx LC_MONETARY
15295 @c @itemx LC_NUMERIC
15296 @c @itemx LC_TIME
15297 @itemx LC_ALL
15298 @findex LANG
15299 @findex LC_CTYPE
15300 @c @findex LC_COLLATE
15301 @findex LC_MESSAGES
15302 @c @findex LC_MONETARY
15303 @c @findex LC_NUMERIC
15304 @c @findex LC_TIME
15305 @findex LC_ALL
15306 @cindex locale
15307 These environment variables control the way that GCC uses
15308 localization information that allow GCC to work with different
15309 national conventions.  GCC inspects the locale categories
15310 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15311 so.  These locale categories can be set to any value supported by your
15312 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15313 Kingdom encoded in UTF-8.
15315 The @env{LC_CTYPE} environment variable specifies character
15316 classification.  GCC uses it to determine the character boundaries in
15317 a string; this is needed for some multibyte encodings that contain quote
15318 and escape characters that would otherwise be interpreted as a string
15319 end or escape.
15321 The @env{LC_MESSAGES} environment variable specifies the language to
15322 use in diagnostic messages.
15324 If the @env{LC_ALL} environment variable is set, it overrides the value
15325 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15326 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15327 environment variable.  If none of these variables are set, GCC
15328 defaults to traditional C English behavior.
15330 @item TMPDIR
15331 @findex TMPDIR
15332 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15333 files.  GCC uses temporary files to hold the output of one stage of
15334 compilation which is to be used as input to the next stage: for example,
15335 the output of the preprocessor, which is the input to the compiler
15336 proper.
15338 @item GCC_EXEC_PREFIX
15339 @findex GCC_EXEC_PREFIX
15340 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15341 names of the subprograms executed by the compiler.  No slash is added
15342 when this prefix is combined with the name of a subprogram, but you can
15343 specify a prefix that ends with a slash if you wish.
15345 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15346 an appropriate prefix to use based on the pathname it was invoked with.
15348 If GCC cannot find the subprogram using the specified prefix, it
15349 tries looking in the usual places for the subprogram.
15351 The default value of @env{GCC_EXEC_PREFIX} is
15352 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15353 the installed compiler. In many cases @var{prefix} is the value
15354 of @code{prefix} when you ran the @file{configure} script.
15356 Other prefixes specified with @option{-B} take precedence over this prefix.
15358 This prefix is also used for finding files such as @file{crt0.o} that are
15359 used for linking.
15361 In addition, the prefix is used in an unusual way in finding the
15362 directories to search for header files.  For each of the standard
15363 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15364 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15365 replacing that beginning with the specified prefix to produce an
15366 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15367 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15368 These alternate directories are searched first; the standard directories
15369 come next. If a standard directory begins with the configured
15370 @var{prefix} then the value of @var{prefix} is replaced by
15371 @env{GCC_EXEC_PREFIX} when looking for header files.
15373 @item COMPILER_PATH
15374 @findex COMPILER_PATH
15375 The value of @env{COMPILER_PATH} is a colon-separated list of
15376 directories, much like @env{PATH}.  GCC tries the directories thus
15377 specified when searching for subprograms, if it can't find the
15378 subprograms using @env{GCC_EXEC_PREFIX}.
15380 @item LIBRARY_PATH
15381 @findex LIBRARY_PATH
15382 The value of @env{LIBRARY_PATH} is a colon-separated list of
15383 directories, much like @env{PATH}.  When configured as a native compiler,
15384 GCC tries the directories thus specified when searching for special
15385 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15386 using GCC also uses these directories when searching for ordinary
15387 libraries for the @option{-l} option (but directories specified with
15388 @option{-L} come first).
15390 @item LANG
15391 @findex LANG
15392 @cindex locale definition
15393 This variable is used to pass locale information to the compiler.  One way in
15394 which this information is used is to determine the character set to be used
15395 when character literals, string literals and comments are parsed in C and C++.
15396 When the compiler is configured to allow multibyte characters,
15397 the following values for @env{LANG} are recognized:
15399 @table @samp
15400 @item C-JIS
15401 Recognize JIS characters.
15402 @item C-SJIS
15403 Recognize SJIS characters.
15404 @item C-EUCJP
15405 Recognize EUCJP characters.
15406 @end table
15408 If @env{LANG} is not defined, or if it has some other value, then the
15409 compiler will use mblen and mbtowc as defined by the default locale to
15410 recognize and translate multibyte characters.
15411 @end table
15413 @noindent
15414 Some additional environments variables affect the behavior of the
15415 preprocessor.
15417 @include cppenv.texi
15419 @c man end
15421 @node Precompiled Headers
15422 @section Using Precompiled Headers
15423 @cindex precompiled headers
15424 @cindex speed of compilation
15426 Often large projects have many header files that are included in every
15427 source file.  The time the compiler takes to process these header files
15428 over and over again can account for nearly all of the time required to
15429 build the project.  To make builds faster, GCC allows users to
15430 `precompile' a header file; then, if builds can use the precompiled
15431 header file they will be much faster.
15433 To create a precompiled header file, simply compile it as you would any
15434 other file, if necessary using the @option{-x} option to make the driver
15435 treat it as a C or C++ header file.  You will probably want to use a
15436 tool like @command{make} to keep the precompiled header up-to-date when
15437 the headers it contains change.
15439 A precompiled header file will be searched for when @code{#include} is
15440 seen in the compilation.  As it searches for the included file
15441 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15442 compiler looks for a precompiled header in each directory just before it
15443 looks for the include file in that directory.  The name searched for is
15444 the name specified in the @code{#include} with @samp{.gch} appended.  If
15445 the precompiled header file can't be used, it is ignored.
15447 For instance, if you have @code{#include "all.h"}, and you have
15448 @file{all.h.gch} in the same directory as @file{all.h}, then the
15449 precompiled header file will be used if possible, and the original
15450 header will be used otherwise.
15452 Alternatively, you might decide to put the precompiled header file in a
15453 directory and use @option{-I} to ensure that directory is searched
15454 before (or instead of) the directory containing the original header.
15455 Then, if you want to check that the precompiled header file is always
15456 used, you can put a file of the same name as the original header in this
15457 directory containing an @code{#error} command.
15459 This also works with @option{-include}.  So yet another way to use
15460 precompiled headers, good for projects not designed with precompiled
15461 header files in mind, is to simply take most of the header files used by
15462 a project, include them from another header file, precompile that header
15463 file, and @option{-include} the precompiled header.  If the header files
15464 have guards against multiple inclusion, they will be skipped because
15465 they've already been included (in the precompiled header).
15467 If you need to precompile the same header file for different
15468 languages, targets, or compiler options, you can instead make a
15469 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15470 header in the directory, perhaps using @option{-o}.  It doesn't matter
15471 what you call the files in the directory, every precompiled header in
15472 the directory will be considered.  The first precompiled header
15473 encountered in the directory that is valid for this compilation will
15474 be used; they're searched in no particular order.
15476 There are many other possibilities, limited only by your imagination,
15477 good sense, and the constraints of your build system.
15479 A precompiled header file can be used only when these conditions apply:
15481 @itemize
15482 @item
15483 Only one precompiled header can be used in a particular compilation.
15485 @item
15486 A precompiled header can't be used once the first C token is seen.  You
15487 can have preprocessor directives before a precompiled header; you can
15488 even include a precompiled header from inside another header, so long as
15489 there are no C tokens before the @code{#include}.
15491 @item
15492 The precompiled header file must be produced for the same language as
15493 the current compilation.  You can't use a C precompiled header for a C++
15494 compilation.
15496 @item
15497 The precompiled header file must have been produced by the same compiler
15498 binary as the current compilation is using.
15500 @item
15501 Any macros defined before the precompiled header is included must
15502 either be defined in the same way as when the precompiled header was
15503 generated, or must not affect the precompiled header, which usually
15504 means that they don't appear in the precompiled header at all.
15506 The @option{-D} option is one way to define a macro before a
15507 precompiled header is included; using a @code{#define} can also do it.
15508 There are also some options that define macros implicitly, like
15509 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15510 defined this way.
15512 @item If debugging information is output when using the precompiled
15513 header, using @option{-g} or similar, the same kind of debugging information
15514 must have been output when building the precompiled header.  However,
15515 a precompiled header built using @option{-g} can be used in a compilation
15516 when no debugging information is being output.
15518 @item The same @option{-m} options must generally be used when building
15519 and using the precompiled header.  @xref{Submodel Options},
15520 for any cases where this rule is relaxed.
15522 @item Each of the following options must be the same when building and using
15523 the precompiled header:
15525 @gccoptlist{-fexceptions -funit-at-a-time}
15527 @item
15528 Some other command-line options starting with @option{-f},
15529 @option{-p}, or @option{-O} must be defined in the same way as when
15530 the precompiled header was generated.  At present, it's not clear
15531 which options are safe to change and which are not; the safest choice
15532 is to use exactly the same options when generating and using the
15533 precompiled header.  The following are known to be safe:
15535 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15536 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15537 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15538 -pedantic-errors}
15540 @end itemize
15542 For all of these except the last, the compiler will automatically
15543 ignore the precompiled header if the conditions aren't met.  If you
15544 find an option combination that doesn't work and doesn't cause the
15545 precompiled header to be ignored, please consider filing a bug report,
15546 see @ref{Bugs}.
15548 If you do use differing options when generating and using the
15549 precompiled header, the actual behavior will be a mixture of the
15550 behavior for the options.  For instance, if you use @option{-g} to
15551 generate the precompiled header but not when using it, you may or may
15552 not get debugging information for routines in the precompiled header.
15554 @node Running Protoize
15555 @section Running Protoize
15557 The program @code{protoize} is an optional part of GCC@.  You can use
15558 it to add prototypes to a program, thus converting the program to ISO
15559 C in one respect.  The companion program @code{unprotoize} does the
15560 reverse: it removes argument types from any prototypes that are found.
15562 When you run these programs, you must specify a set of source files as
15563 command line arguments.  The conversion programs start out by compiling
15564 these files to see what functions they define.  The information gathered
15565 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15567 After scanning comes actual conversion.  The specified files are all
15568 eligible to be converted; any files they include (whether sources or
15569 just headers) are eligible as well.
15571 But not all the eligible files are converted.  By default,
15572 @code{protoize} and @code{unprotoize} convert only source and header
15573 files in the current directory.  You can specify additional directories
15574 whose files should be converted with the @option{-d @var{directory}}
15575 option.  You can also specify particular files to exclude with the
15576 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15577 directory name matches one of the specified directory names, and its
15578 name within the directory has not been excluded.
15580 Basic conversion with @code{protoize} consists of rewriting most
15581 function definitions and function declarations to specify the types of
15582 the arguments.  The only ones not rewritten are those for varargs
15583 functions.
15585 @code{protoize} optionally inserts prototype declarations at the
15586 beginning of the source file, to make them available for any calls that
15587 precede the function's definition.  Or it can insert prototype
15588 declarations with block scope in the blocks where undeclared functions
15589 are called.
15591 Basic conversion with @code{unprotoize} consists of rewriting most
15592 function declarations to remove any argument types, and rewriting
15593 function definitions to the old-style pre-ISO form.
15595 Both conversion programs print a warning for any function declaration or
15596 definition that they can't convert.  You can suppress these warnings
15597 with @option{-q}.
15599 The output from @code{protoize} or @code{unprotoize} replaces the
15600 original source file.  The original file is renamed to a name ending
15601 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15602 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15603 for DOS) file already exists, then the source file is simply discarded.
15605 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15606 scan the program and collect information about the functions it uses.
15607 So neither of these programs will work until GCC is installed.
15609 Here is a table of the options you can use with @code{protoize} and
15610 @code{unprotoize}.  Each option works with both programs unless
15611 otherwise stated.
15613 @table @code
15614 @item -B @var{directory}
15615 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15616 usual directory (normally @file{/usr/local/lib}).  This file contains
15617 prototype information about standard system functions.  This option
15618 applies only to @code{protoize}.
15620 @item -c @var{compilation-options}
15621 Use @var{compilation-options} as the options when running @command{gcc} to
15622 produce the @samp{.X} files.  The special option @option{-aux-info} is
15623 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15625 Note that the compilation options must be given as a single argument to
15626 @code{protoize} or @code{unprotoize}.  If you want to specify several
15627 @command{gcc} options, you must quote the entire set of compilation options
15628 to make them a single word in the shell.
15630 There are certain @command{gcc} arguments that you cannot use, because they
15631 would produce the wrong kind of output.  These include @option{-g},
15632 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15633 the @var{compilation-options}, they are ignored.
15635 @item -C
15636 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15637 systems) instead of @samp{.c}.  This is convenient if you are converting
15638 a C program to C++.  This option applies only to @code{protoize}.
15640 @item -g
15641 Add explicit global declarations.  This means inserting explicit
15642 declarations at the beginning of each source file for each function
15643 that is called in the file and was not declared.  These declarations
15644 precede the first function definition that contains a call to an
15645 undeclared function.  This option applies only to @code{protoize}.
15647 @item -i @var{string}
15648 Indent old-style parameter declarations with the string @var{string}.
15649 This option applies only to @code{protoize}.
15651 @code{unprotoize} converts prototyped function definitions to old-style
15652 function definitions, where the arguments are declared between the
15653 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15654 uses five spaces as the indentation.  If you want to indent with just
15655 one space instead, use @option{-i " "}.
15657 @item -k
15658 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15659 is finished.
15661 @item -l
15662 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15663 a prototype declaration for each function in each block which calls the
15664 function without any declaration.  This option applies only to
15665 @code{protoize}.
15667 @item -n
15668 Make no real changes.  This mode just prints information about the conversions
15669 that would have been done without @option{-n}.
15671 @item -N
15672 Make no @samp{.save} files.  The original files are simply deleted.
15673 Use this option with caution.
15675 @item -p @var{program}
15676 Use the program @var{program} as the compiler.  Normally, the name
15677 @file{gcc} is used.
15679 @item -q
15680 Work quietly.  Most warnings are suppressed.
15682 @item -v
15683 Print the version number, just like @option{-v} for @command{gcc}.
15684 @end table
15686 If you need special compiler options to compile one of your program's
15687 source files, then you should generate that file's @samp{.X} file
15688 specially, by running @command{gcc} on that source file with the
15689 appropriate options and the option @option{-aux-info}.  Then run
15690 @code{protoize} on the entire set of files.  @code{protoize} will use
15691 the existing @samp{.X} file because it is newer than the source file.
15692 For example:
15694 @smallexample
15695 gcc -Dfoo=bar file1.c -aux-info file1.X
15696 protoize *.c
15697 @end smallexample
15699 @noindent
15700 You need to include the special files along with the rest in the
15701 @code{protoize} command, even though their @samp{.X} files already
15702 exist, because otherwise they won't get converted.
15704 @xref{Protoize Caveats}, for more information on how to use
15705 @code{protoize} successfully.