c7187f2c42dbefa38234a1d6526edda24c77e574
[gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
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, 2009, 2010
15 Free Software Foundation, Inc.
16
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3 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.
24
25 (a) The FSF's Front-Cover Text is:
26
27 A GNU Manual
28
29 (b) The FSF's Back-Cover Text is:
30
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{}
46
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
66
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
72
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.
79
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.
84
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.
91
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
95
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{-dv} is very different from @w{@samp{-d
101 -v}}.
102
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.
110
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.
117
118 @c man end
119
120 @xref{Option Index}, for an index to GCC's options.
121
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 @end menu
152
153 @c man begin OPTIONS
154
155 @node Option Summary
156 @section Option Summary
157
158 Here is a summary of all the options, grouped by type. Explanations are
159 in the following sections.
160
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c -S -E -o @var{file} -no-canonical-prefixes @gol
165 -pipe -pass-exit-codes @gol
166 -x @var{language} -v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help @gol
167 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg} @gol
168 -fdump-ada-spec@r{[}-slim@r{]}} -fdump-go-spec=@var{file}
169
170 @item C Language Options
171 @xref{C Dialect Options,,Options Controlling C Dialect}.
172 @gccoptlist{-ansi -std=@var{standard} -fgnu89-inline @gol
173 -aux-info @var{filename} @gol
174 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
175 -fhosted -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
176 -trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
177 -fallow-single-precision -fcond-mismatch -flax-vector-conversions @gol
178 -fsigned-bitfields -fsigned-char @gol
179 -funsigned-bitfields -funsigned-char}
180
181 @item C++ Language Options
182 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
183 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
184 -fconserve-space -ffriend-injection @gol
185 -fno-elide-constructors @gol
186 -fno-enforce-eh-specs @gol
187 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
188 -fno-implicit-templates @gol
189 -fno-implicit-inline-templates @gol
190 -fno-implement-inlines -fms-extensions @gol
191 -fno-nonansi-builtins -fnothrow-opt -fno-operator-names @gol
192 -fno-optional-diags -fpermissive @gol
193 -fno-pretty-templates @gol
194 -frepo -fno-rtti -fstats -ftemplate-depth=@var{n} @gol
195 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
196 -fno-default-inline -fvisibility-inlines-hidden @gol
197 -fvisibility-ms-compat @gol
198 -Wabi -Wconversion-null -Wctor-dtor-privacy @gol
199 -Wnoexcept -Wnon-virtual-dtor -Wreorder @gol
200 -Weffc++ -Wstrict-null-sentinel @gol
201 -Wno-non-template-friend -Wold-style-cast @gol
202 -Woverloaded-virtual -Wno-pmf-conversions @gol
203 -Wsign-promo}
204
205 @item Objective-C and Objective-C++ Language Options
206 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
207 Objective-C and Objective-C++ Dialects}.
208 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
209 -fgnu-runtime -fnext-runtime @gol
210 -fno-nil-receivers @gol
211 -fobjc-call-cxx-cdtors @gol
212 -fobjc-direct-dispatch @gol
213 -fobjc-exceptions @gol
214 -fobjc-gc @gol
215 -fobjc-std=objc1 @gol
216 -freplace-objc-classes @gol
217 -fzero-link @gol
218 -gen-decls @gol
219 -Wassign-intercept @gol
220 -Wno-protocol -Wselector @gol
221 -Wstrict-selector-match @gol
222 -Wundeclared-selector}
223
224 @item Language Independent Options
225 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
226 @gccoptlist{-fmessage-length=@var{n} @gol
227 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
228 -fdiagnostics-show-option}
229
230 @item Warning Options
231 @xref{Warning Options,,Options to Request or Suppress Warnings}.
232 @gccoptlist{-fsyntax-only fmax-errors=@var{n} -pedantic @gol
233 -pedantic-errors @gol
234 -w -Wextra -Wall -Waddress -Waggregate-return -Warray-bounds @gol
235 -Wno-attributes -Wno-builtin-macro-redefined @gol
236 -Wc++-compat -Wc++0x-compat -Wcast-align -Wcast-qual @gol
237 -Wchar-subscripts -Wclobbered -Wcomment @gol
238 -Wconversion -Wcoverage-mismatch -Wcpp -Wno-deprecated @gol
239 -Wno-deprecated-declarations -Wdisabled-optimization @gol
240 -Wno-div-by-zero -Wdouble-promotion -Wempty-body -Wenum-compare @gol
241 -Wno-endif-labels -Werror -Werror=* @gol
242 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
243 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
244 -Wformat-security -Wformat-y2k @gol
245 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
246 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
247 -Winit-self -Winline @gol
248 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
249 -Winvalid-pch -Wlarger-than=@var{len} -Wunsafe-loop-optimizations @gol
250 -Wlogical-op -Wlong-long @gol
251 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
252 -Wmissing-format-attribute -Wmissing-include-dirs @gol
253 -Wno-mudflap @gol
254 -Wno-multichar -Wnonnull -Wno-overflow @gol
255 -Woverlength-strings -Wpacked -Wpacked-bitfield-compat -Wpadded @gol
256 -Wparentheses -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
257 -Wpointer-arith -Wno-pointer-to-int-cast @gol
258 -Wredundant-decls @gol
259 -Wreturn-type -Wsequence-point -Wshadow @gol
260 -Wsign-compare -Wsign-conversion -Wstack-protector @gol
261 -Wstrict-aliasing -Wstrict-aliasing=n @gol
262 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
263 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]} @gol
264 -Wswitch -Wswitch-default -Wswitch-enum -Wsync-nand @gol
265 -Wsystem-headers -Wtrampolines -Wtrigraphs -Wtype-limits -Wundef @gol
266 -Wuninitialized -Wunknown-pragmas -Wno-pragmas @gol
267 -Wunsuffixed-float-constants -Wunused -Wunused-function @gol
268 -Wunused-label -Wunused-parameter -Wno-unused-result -Wunused-value @gol
269 -Wunused-variable -Wunused-but-set-parameter -Wunused-but-set-variable @gol
270 -Wvariadic-macros -Wvla -Wvolatile-register-var -Wwrite-strings}
271
272 @item C and Objective-C-only Warning Options
273 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
274 -Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs @gol
275 -Wold-style-declaration -Wold-style-definition @gol
276 -Wstrict-prototypes -Wtraditional -Wtraditional-conversion @gol
277 -Wdeclaration-after-statement -Wpointer-sign}
278
279 @item Debugging Options
280 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
281 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
282 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
283 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
284 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
285 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
286 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
287 -fdump-statistics @gol
288 -fdump-tree-all @gol
289 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
292 -fdump-tree-ch @gol
293 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
299 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
300 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-nrv -fdump-tree-vect @gol
303 -fdump-tree-sink @gol
304 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
308 -ftree-vectorizer-verbose=@var{n} @gol
309 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
310 -fdump-final-insns=@var{file} @gol
311 -fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second @gol
312 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
313 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
314 -fenable-icf-debug @gol
315 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
316 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
317 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
318 -fstack-usage -ftest-coverage -ftime-report -fvar-tracking @gol
319 -fvar-tracking-assignments -fvar-tracking-assignments-toggle @gol
320 -g -g@var{level} -gtoggle -gcoff -gdwarf-@var{version} @gol
321 -ggdb -gstabs -gstabs+ -gstrict-dwarf -gno-strict-dwarf @gol
322 -gvms -gxcoff -gxcoff+ @gol
323 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
324 -fdebug-prefix-map=@var{old}=@var{new} @gol
325 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
326 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
327 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
328 -print-multi-directory -print-multi-lib -print-multi-os-directory @gol
329 -print-prog-name=@var{program} -print-search-dirs -Q @gol
330 -print-sysroot -print-sysroot-headers-suffix @gol
331 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
332
333 @item Optimization Options
334 @xref{Optimize Options,,Options that Control Optimization}.
335 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
336 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
337 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
338 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
339 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
340 -fcprop-registers -fcrossjumping @gol
341 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
342 -fcx-limited-range @gol
343 -fdata-sections -fdce -fdce -fdelayed-branch @gol
344 -fdelete-null-pointer-checks -fdse -fdevirtualize -fdse @gol
345 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
346 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
347 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
348 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
349 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
350 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
351 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
352 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
353 -fipa-struct-reorg -fira-algorithm=@var{algorithm} @gol
354 -fira-region=@var{region} @gol
355 -fira-loop-pressure -fno-ira-share-save-slots @gol
356 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
357 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
358 -floop-block -floop-flatten -floop-interchange -floop-strip-mine @gol
359 -floop-parallelize-all -flto -flto-compression-level
360 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
361 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
362 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
363 -fno-default-inline @gol
364 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
365 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
366 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
367 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
368 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
369 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
370 -fprefetch-loop-arrays @gol
371 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
372 -fprofile-generate=@var{path} @gol
373 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
374 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
375 -freorder-blocks-and-partition -freorder-functions @gol
376 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
377 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
378 -fsched-spec-load -fsched-spec-load-dangerous @gol
379 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
380 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
381 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
382 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
383 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
384 -fselective-scheduling -fselective-scheduling2 @gol
385 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
386 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
387 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
388 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
389 -ftree-bit-ccp @gol
390 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
391 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
392 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
393 -ftree-loop-if-convert-memory-writes -ftree-loop-im @gol
394 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
395 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
396 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
397 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
398 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
399 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
400 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
401 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
402 -fwhole-program -fwpa -fuse-linker-plugin @gol
403 --param @var{name}=@var{value}
404 -O -O0 -O1 -O2 -O3 -Os -Ofast}
405
406 @item Preprocessor Options
407 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
408 @gccoptlist{-A@var{question}=@var{answer} @gol
409 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
410 -C -dD -dI -dM -dN @gol
411 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
412 -idirafter @var{dir} @gol
413 -include @var{file} -imacros @var{file} @gol
414 -iprefix @var{file} -iwithprefix @var{dir} @gol
415 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
416 -imultilib @var{dir} -isysroot @var{dir} @gol
417 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
418 -P -fworking-directory -remap @gol
419 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
420 -Xpreprocessor @var{option}}
421
422 @item Assembler Option
423 @xref{Assembler Options,,Passing Options to the Assembler}.
424 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
425
426 @item Linker Options
427 @xref{Link Options,,Options for Linking}.
428 @gccoptlist{@var{object-file-name} -l@var{library} @gol
429 -nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
430 -s -static -static-libgcc -static-libstdc++ -shared @gol
431 -shared-libgcc -symbolic @gol
432 -T @var{script} -Wl,@var{option} -Xlinker @var{option} @gol
433 -u @var{symbol}}
434
435 @item Directory Options
436 @xref{Directory Options,,Options for Directory Search}.
437 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
438 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
439 --sysroot=@var{dir}
440
441 @item Machine Dependent Options
442 @xref{Submodel Options,,Hardware Models and Configurations}.
443 @c This list is ordered alphanumerically by subsection name.
444 @c Try and put the significant identifier (CPU or system) first,
445 @c so users have a clue at guessing where the ones they want will be.
446
447 @emph{ARC Options}
448 @gccoptlist{-EB -EL @gol
449 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
450 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
451
452 @emph{ARM Options}
453 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
454 -mabi=@var{name} @gol
455 -mapcs-stack-check -mno-apcs-stack-check @gol
456 -mapcs-float -mno-apcs-float @gol
457 -mapcs-reentrant -mno-apcs-reentrant @gol
458 -msched-prolog -mno-sched-prolog @gol
459 -mlittle-endian -mbig-endian -mwords-little-endian @gol
460 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
461 -mfp16-format=@var{name}
462 -mthumb-interwork -mno-thumb-interwork @gol
463 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
464 -mstructure-size-boundary=@var{n} @gol
465 -mabort-on-noreturn @gol
466 -mlong-calls -mno-long-calls @gol
467 -msingle-pic-base -mno-single-pic-base @gol
468 -mpic-register=@var{reg} @gol
469 -mnop-fun-dllimport @gol
470 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
471 -mpoke-function-name @gol
472 -mthumb -marm @gol
473 -mtpcs-frame -mtpcs-leaf-frame @gol
474 -mcaller-super-interworking -mcallee-super-interworking @gol
475 -mtp=@var{name} @gol
476 -mword-relocations @gol
477 -mfix-cortex-m3-ldrd}
478
479 @emph{AVR Options}
480 @gccoptlist{-mmcu=@var{mcu} -mno-interrupts @gol
481 -mcall-prologues -mtiny-stack -mint8}
482
483 @emph{Blackfin Options}
484 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
485 -msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
486 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
487 -mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
488 -mno-id-shared-library -mshared-library-id=@var{n} @gol
489 -mleaf-id-shared-library -mno-leaf-id-shared-library @gol
490 -msep-data -mno-sep-data -mlong-calls -mno-long-calls @gol
491 -mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram @gol
492 -micplb}
493
494 @emph{CRIS Options}
495 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
496 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
497 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
498 -mstack-align -mdata-align -mconst-align @gol
499 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
500 -melf -maout -melinux -mlinux -sim -sim2 @gol
501 -mmul-bug-workaround -mno-mul-bug-workaround}
502
503 @emph{CRX Options}
504 @gccoptlist{-mmac -mpush-args}
505
506 @emph{Darwin Options}
507 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
508 -arch_only -bind_at_load -bundle -bundle_loader @gol
509 -client_name -compatibility_version -current_version @gol
510 -dead_strip @gol
511 -dependency-file -dylib_file -dylinker_install_name @gol
512 -dynamic -dynamiclib -exported_symbols_list @gol
513 -filelist -flat_namespace -force_cpusubtype_ALL @gol
514 -force_flat_namespace -headerpad_max_install_names @gol
515 -iframework @gol
516 -image_base -init -install_name -keep_private_externs @gol
517 -multi_module -multiply_defined -multiply_defined_unused @gol
518 -noall_load -no_dead_strip_inits_and_terms @gol
519 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
520 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
521 -private_bundle -read_only_relocs -sectalign @gol
522 -sectobjectsymbols -whyload -seg1addr @gol
523 -sectcreate -sectobjectsymbols -sectorder @gol
524 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
525 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
526 -segprot -segs_read_only_addr -segs_read_write_addr @gol
527 -single_module -static -sub_library -sub_umbrella @gol
528 -twolevel_namespace -umbrella -undefined @gol
529 -unexported_symbols_list -weak_reference_mismatches @gol
530 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
531 -mkernel -mone-byte-bool}
532
533 @emph{DEC Alpha Options}
534 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
535 -mieee -mieee-with-inexact -mieee-conformant @gol
536 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
537 -mtrap-precision=@var{mode} -mbuild-constants @gol
538 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
539 -mbwx -mmax -mfix -mcix @gol
540 -mfloat-vax -mfloat-ieee @gol
541 -mexplicit-relocs -msmall-data -mlarge-data @gol
542 -msmall-text -mlarge-text @gol
543 -mmemory-latency=@var{time}}
544
545 @emph{DEC Alpha/VMS Options}
546 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
547
548 @emph{FR30 Options}
549 @gccoptlist{-msmall-model -mno-lsim}
550
551 @emph{FRV Options}
552 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
553 -mhard-float -msoft-float @gol
554 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
555 -mdouble -mno-double @gol
556 -mmedia -mno-media -mmuladd -mno-muladd @gol
557 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
558 -mlinked-fp -mlong-calls -malign-labels @gol
559 -mlibrary-pic -macc-4 -macc-8 @gol
560 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
561 -moptimize-membar -mno-optimize-membar @gol
562 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
563 -mvliw-branch -mno-vliw-branch @gol
564 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
565 -mno-nested-cond-exec -mtomcat-stats @gol
566 -mTLS -mtls @gol
567 -mcpu=@var{cpu}}
568
569 @emph{GNU/Linux Options}
570 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
571 -tno-android-cc -tno-android-ld}
572
573 @emph{H8/300 Options}
574 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
575
576 @emph{HPPA Options}
577 @gccoptlist{-march=@var{architecture-type} @gol
578 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
579 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
580 -mfixed-range=@var{register-range} @gol
581 -mjump-in-delay -mlinker-opt -mlong-calls @gol
582 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
583 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
584 -mno-jump-in-delay -mno-long-load-store @gol
585 -mno-portable-runtime -mno-soft-float @gol
586 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
587 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
588 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
589 -munix=@var{unix-std} -nolibdld -static -threads}
590
591 @emph{i386 and x86-64 Options}
592 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
593 -mfpmath=@var{unit} @gol
594 -masm=@var{dialect} -mno-fancy-math-387 @gol
595 -mno-fp-ret-in-387 -msoft-float @gol
596 -mno-wide-multiply -mrtd -malign-double @gol
597 -mpreferred-stack-boundary=@var{num}
598 -mincoming-stack-boundary=@var{num} @gol
599 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip -mvzeroupper @gol
600 -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
601 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfused-madd @gol
602 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlwp @gol
603 -mthreads -mno-align-stringops -minline-all-stringops @gol
604 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
605 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
606 -m96bit-long-double -mregparm=@var{num} -msseregparm @gol
607 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
608 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
609 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
610 -mcmodel=@var{code-model} -mabi=@var{name} @gol
611 -m32 -m64 -mlarge-data-threshold=@var{num} @gol
612 -msse2avx -mfentry -m8bit-idiv}
613
614 @emph{IA-64 Options}
615 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
616 -mvolatile-asm-stop -mregister-names -msdata -mno-sdata @gol
617 -mconstant-gp -mauto-pic -mfused-madd @gol
618 -minline-float-divide-min-latency @gol
619 -minline-float-divide-max-throughput @gol
620 -mno-inline-float-divide @gol
621 -minline-int-divide-min-latency @gol
622 -minline-int-divide-max-throughput @gol
623 -mno-inline-int-divide @gol
624 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
625 -mno-inline-sqrt @gol
626 -mdwarf2-asm -mearly-stop-bits @gol
627 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
628 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
629 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
630 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
631 -msched-spec-ldc -msched-spec-control-ldc @gol
632 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
633 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
634 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
635 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
636
637 @emph{IA-64/VMS Options}
638 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
639
640 @emph{LM32 Options}
641 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
642 -msign-extend-enabled -muser-enabled}
643
644 @emph{M32R/D Options}
645 @gccoptlist{-m32r2 -m32rx -m32r @gol
646 -mdebug @gol
647 -malign-loops -mno-align-loops @gol
648 -missue-rate=@var{number} @gol
649 -mbranch-cost=@var{number} @gol
650 -mmodel=@var{code-size-model-type} @gol
651 -msdata=@var{sdata-type} @gol
652 -mno-flush-func -mflush-func=@var{name} @gol
653 -mno-flush-trap -mflush-trap=@var{number} @gol
654 -G @var{num}}
655
656 @emph{M32C Options}
657 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
658
659 @emph{M680x0 Options}
660 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune}
661 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
662 -m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
663 -mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020 @gol
664 -mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort @gol
665 -mno-short -mhard-float -m68881 -msoft-float -mpcrel @gol
666 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
667 -mshared-library-id=n -mid-shared-library -mno-id-shared-library @gol
668 -mxgot -mno-xgot}
669
670 @emph{M68hc1x Options}
671 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
672 -mauto-incdec -minmax -mlong-calls -mshort @gol
673 -msoft-reg-count=@var{count}}
674
675 @emph{MCore Options}
676 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
677 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
678 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
679 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
680 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
681
682 @emph{MeP Options}
683 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
684 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
685 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
686 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
687 -mtiny=@var{n}}
688
689 @emph{MicroBlaze Options}
690 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
691 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
692 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
693 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
694 -mxl-mode-@var{app-model}}
695
696 @emph{MIPS Options}
697 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
698 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 @gol
699 -mips64 -mips64r2 @gol
700 -mips16 -mno-mips16 -mflip-mips16 @gol
701 -minterlink-mips16 -mno-interlink-mips16 @gol
702 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
703 -mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot @gol
704 -mgp32 -mgp64 -mfp32 -mfp64 -mhard-float -msoft-float @gol
705 -msingle-float -mdouble-float -mdsp -mno-dsp -mdspr2 -mno-dspr2 @gol
706 -mfpu=@var{fpu-type} @gol
707 -msmartmips -mno-smartmips @gol
708 -mpaired-single -mno-paired-single -mdmx -mno-mdmx @gol
709 -mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc @gol
710 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
711 -G@var{num} -mlocal-sdata -mno-local-sdata @gol
712 -mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt @gol
713 -membedded-data -mno-embedded-data @gol
714 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
715 -mcode-readable=@var{setting} @gol
716 -msplit-addresses -mno-split-addresses @gol
717 -mexplicit-relocs -mno-explicit-relocs @gol
718 -mcheck-zero-division -mno-check-zero-division @gol
719 -mdivide-traps -mdivide-breaks @gol
720 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
721 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
722 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
723 -mfix-r10000 -mno-fix-r10000 -mfix-vr4120 -mno-fix-vr4120 @gol
724 -mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1 @gol
725 -mflush-func=@var{func} -mno-flush-func @gol
726 -mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely @gol
727 -mfp-exceptions -mno-fp-exceptions @gol
728 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
729 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
730
731 @emph{MMIX Options}
732 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
733 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
734 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
735 -mno-base-addresses -msingle-exit -mno-single-exit}
736
737 @emph{MN10300 Options}
738 @gccoptlist{-mmult-bug -mno-mult-bug @gol
739 -mno-am33 -mam33 -mam33-2 -mam34 @gol
740 -mtune=@var{cpu-type} @gol
741 -mreturn-pointer-on-d0 @gol
742 -mno-crt0 -mrelax}
743
744 @emph{PDP-11 Options}
745 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
746 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
747 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
748 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
749 -mbranch-expensive -mbranch-cheap @gol
750 -munix-asm -mdec-asm}
751
752 @emph{picoChip Options}
753 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
754 -msymbol-as-address -mno-inefficient-warnings}
755
756 @emph{PowerPC Options}
757 See RS/6000 and PowerPC Options.
758
759 @emph{RS/6000 and PowerPC Options}
760 @gccoptlist{-mcpu=@var{cpu-type} @gol
761 -mtune=@var{cpu-type} @gol
762 -mcmodel=@var{code-model} @gol
763 -mpower -mno-power -mpower2 -mno-power2 @gol
764 -mpowerpc -mpowerpc64 -mno-powerpc @gol
765 -maltivec -mno-altivec @gol
766 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
767 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
768 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd @gol
769 -mfprnd -mno-fprnd @gol
770 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
771 -mnew-mnemonics -mold-mnemonics @gol
772 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
773 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
774 -malign-power -malign-natural @gol
775 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
776 -msingle-float -mdouble-float -msimple-fpu @gol
777 -mstring -mno-string -mupdate -mno-update @gol
778 -mavoid-indexed-addresses -mno-avoid-indexed-addresses @gol
779 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
780 -mstrict-align -mno-strict-align -mrelocatable @gol
781 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
782 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
783 -mdynamic-no-pic -maltivec -mswdiv -msingle-pic-base @gol
784 -mprioritize-restricted-insns=@var{priority} @gol
785 -msched-costly-dep=@var{dependence_type} @gol
786 -minsert-sched-nops=@var{scheme} @gol
787 -mcall-sysv -mcall-netbsd @gol
788 -maix-struct-return -msvr4-struct-return @gol
789 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
790 -mblock-move-inline-limit=@var{num} @gol
791 -misel -mno-isel @gol
792 -misel=yes -misel=no @gol
793 -mspe -mno-spe @gol
794 -mspe=yes -mspe=no @gol
795 -mpaired @gol
796 -mgen-cell-microcode -mwarn-cell-microcode @gol
797 -mvrsave -mno-vrsave @gol
798 -mmulhw -mno-mulhw @gol
799 -mdlmzb -mno-dlmzb @gol
800 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
801 -mprototype -mno-prototype @gol
802 -msim -mmvme -mads -myellowknife -memb -msdata @gol
803 -msdata=@var{opt} -mvxworks -G @var{num} -pthread @gol
804 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision
805 -mno-recip-precision @gol
806 -mveclibabi=@var{type} -mfriz -mno-friz}
807
808 @emph{RX Options}
809 @gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu@gol
810 -mcpu=@gol
811 -mbig-endian-data -mlittle-endian-data @gol
812 -msmall-data @gol
813 -msim -mno-sim@gol
814 -mas100-syntax -mno-as100-syntax@gol
815 -mrelax@gol
816 -mmax-constant-size=@gol
817 -mint-register=@gol
818 -msave-acc-in-interrupts}
819
820 @emph{S/390 and zSeries Options}
821 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
822 -mhard-float -msoft-float -mhard-dfp -mno-hard-dfp @gol
823 -mlong-double-64 -mlong-double-128 @gol
824 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
825 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
826 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
827 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
828 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
829
830 @emph{Score Options}
831 @gccoptlist{-meb -mel @gol
832 -mnhwloop @gol
833 -muls @gol
834 -mmac @gol
835 -mscore5 -mscore5u -mscore7 -mscore7d}
836
837 @emph{SH Options}
838 @gccoptlist{-m1 -m2 -m2e @gol
839 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
840 -m3 -m3e @gol
841 -m4-nofpu -m4-single-only -m4-single -m4 @gol
842 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
843 -m5-64media -m5-64media-nofpu @gol
844 -m5-32media -m5-32media-nofpu @gol
845 -m5-compact -m5-compact-nofpu @gol
846 -mb -ml -mdalign -mrelax @gol
847 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
848 -mieee -mbitops -misize -minline-ic_invalidate -mpadstruct -mspace @gol
849 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
850 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
851 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
852 -maccumulate-outgoing-args -minvalid-symbols}
853
854 @emph{Solaris 2 Options}
855 @gccoptlist{-mimpure-text -mno-impure-text @gol
856 -threads -pthreads -pthread}
857
858 @emph{SPARC Options}
859 @gccoptlist{-mcpu=@var{cpu-type} @gol
860 -mtune=@var{cpu-type} @gol
861 -mcmodel=@var{code-model} @gol
862 -m32 -m64 -mapp-regs -mno-app-regs @gol
863 -mfaster-structs -mno-faster-structs @gol
864 -mfpu -mno-fpu -mhard-float -msoft-float @gol
865 -mhard-quad-float -msoft-quad-float @gol
866 -mlittle-endian @gol
867 -mstack-bias -mno-stack-bias @gol
868 -munaligned-doubles -mno-unaligned-doubles @gol
869 -mv8plus -mno-v8plus -mvis -mno-vis}
870
871 @emph{SPU Options}
872 @gccoptlist{-mwarn-reloc -merror-reloc @gol
873 -msafe-dma -munsafe-dma @gol
874 -mbranch-hints @gol
875 -msmall-mem -mlarge-mem -mstdmain @gol
876 -mfixed-range=@var{register-range} @gol
877 -mea32 -mea64 @gol
878 -maddress-space-conversion -mno-address-space-conversion @gol
879 -mcache-size=@var{cache-size} @gol
880 -matomic-updates -mno-atomic-updates}
881
882 @emph{System V Options}
883 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
884
885 @emph{V850 Options}
886 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
887 -mprolog-function -mno-prolog-function -mspace @gol
888 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
889 -mapp-regs -mno-app-regs @gol
890 -mdisable-callt -mno-disable-callt @gol
891 -mv850e2v3 @gol
892 -mv850e2 @gol
893 -mv850e1 @gol
894 -mv850e @gol
895 -mv850 -mbig-switch}
896
897 @emph{VAX Options}
898 @gccoptlist{-mg -mgnu -munix}
899
900 @emph{VxWorks Options}
901 @gccoptlist{-mrtp -non-static -Bstatic -Bdynamic @gol
902 -Xbind-lazy -Xbind-now}
903
904 @emph{x86-64 Options}
905 See i386 and x86-64 Options.
906
907 @emph{i386 and x86-64 Windows Options}
908 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
909 -mnop-fun-dllimport -mthread @gol
910 -municode -mwin32 -mwindows -fno-set-stack-executable}
911
912 @emph{Xstormy16 Options}
913 @gccoptlist{-msim}
914
915 @emph{Xtensa Options}
916 @gccoptlist{-mconst16 -mno-const16 @gol
917 -mfused-madd -mno-fused-madd @gol
918 -mforce-no-pic @gol
919 -mserialize-volatile -mno-serialize-volatile @gol
920 -mtext-section-literals -mno-text-section-literals @gol
921 -mtarget-align -mno-target-align @gol
922 -mlongcalls -mno-longcalls}
923
924 @emph{zSeries Options}
925 See S/390 and zSeries Options.
926
927 @item Code Generation Options
928 @xref{Code Gen Options,,Options for Code Generation Conventions}.
929 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
930 -ffixed-@var{reg} -fexceptions @gol
931 -fnon-call-exceptions -funwind-tables @gol
932 -fasynchronous-unwind-tables @gol
933 -finhibit-size-directive -finstrument-functions @gol
934 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
935 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
936 -fno-common -fno-ident @gol
937 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
938 -fno-jump-tables @gol
939 -frecord-gcc-switches @gol
940 -freg-struct-return -fshort-enums @gol
941 -fshort-double -fshort-wchar @gol
942 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
943 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
944 -fno-stack-limit -fsplit-stack @gol
945 -fleading-underscore -ftls-model=@var{model} @gol
946 -ftrapv -fwrapv -fbounds-check @gol
947 -fvisibility -fstrict-volatile-bitfields}
948 @end table
949
950 @menu
951 * Overall Options:: Controlling the kind of output:
952 an executable, object files, assembler files,
953 or preprocessed source.
954 * C Dialect Options:: Controlling the variant of C language compiled.
955 * C++ Dialect Options:: Variations on C++.
956 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
957 and Objective-C++.
958 * Language Independent Options:: Controlling how diagnostics should be
959 formatted.
960 * Warning Options:: How picky should the compiler be?
961 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
962 * Optimize Options:: How much optimization?
963 * Preprocessor Options:: Controlling header files and macro definitions.
964 Also, getting dependency information for Make.
965 * Assembler Options:: Passing options to the assembler.
966 * Link Options:: Specifying libraries and so on.
967 * Directory Options:: Where to find header files and libraries.
968 Where to find the compiler executable files.
969 * Spec Files:: How to pass switches to sub-processes.
970 * Target Options:: Running a cross-compiler, or an old version of GCC.
971 @end menu
972
973 @node Overall Options
974 @section Options Controlling the Kind of Output
975
976 Compilation can involve up to four stages: preprocessing, compilation
977 proper, assembly and linking, always in that order. GCC is capable of
978 preprocessing and compiling several files either into several
979 assembler input files, or into one assembler input file; then each
980 assembler input file produces an object file, and linking combines all
981 the object files (those newly compiled, and those specified as input)
982 into an executable file.
983
984 @cindex file name suffix
985 For any given input file, the file name suffix determines what kind of
986 compilation is done:
987
988 @table @gcctabopt
989 @item @var{file}.c
990 C source code which must be preprocessed.
991
992 @item @var{file}.i
993 C source code which should not be preprocessed.
994
995 @item @var{file}.ii
996 C++ source code which should not be preprocessed.
997
998 @item @var{file}.m
999 Objective-C source code. Note that you must link with the @file{libobjc}
1000 library to make an Objective-C program work.
1001
1002 @item @var{file}.mi
1003 Objective-C source code which should not be preprocessed.
1004
1005 @item @var{file}.mm
1006 @itemx @var{file}.M
1007 Objective-C++ source code. Note that you must link with the @file{libobjc}
1008 library to make an Objective-C++ program work. Note that @samp{.M} refers
1009 to a literal capital M@.
1010
1011 @item @var{file}.mii
1012 Objective-C++ source code which should not be preprocessed.
1013
1014 @item @var{file}.h
1015 C, C++, Objective-C or Objective-C++ header file to be turned into a
1016 precompiled header (default), or C, C++ header file to be turned into an
1017 Ada spec (via the @option{-fdump-ada-spec} switch).
1018
1019 @item @var{file}.cc
1020 @itemx @var{file}.cp
1021 @itemx @var{file}.cxx
1022 @itemx @var{file}.cpp
1023 @itemx @var{file}.CPP
1024 @itemx @var{file}.c++
1025 @itemx @var{file}.C
1026 C++ source code which must be preprocessed. Note that in @samp{.cxx},
1027 the last two letters must both be literally @samp{x}. Likewise,
1028 @samp{.C} refers to a literal capital C@.
1029
1030 @item @var{file}.mm
1031 @itemx @var{file}.M
1032 Objective-C++ source code which must be preprocessed.
1033
1034 @item @var{file}.mii
1035 Objective-C++ source code which should not be preprocessed.
1036
1037 @item @var{file}.hh
1038 @itemx @var{file}.H
1039 @itemx @var{file}.hp
1040 @itemx @var{file}.hxx
1041 @itemx @var{file}.hpp
1042 @itemx @var{file}.HPP
1043 @itemx @var{file}.h++
1044 @itemx @var{file}.tcc
1045 C++ header file to be turned into a precompiled header or Ada spec.
1046
1047 @item @var{file}.f
1048 @itemx @var{file}.for
1049 @itemx @var{file}.ftn
1050 Fixed form Fortran source code which should not be preprocessed.
1051
1052 @item @var{file}.F
1053 @itemx @var{file}.FOR
1054 @itemx @var{file}.fpp
1055 @itemx @var{file}.FPP
1056 @itemx @var{file}.FTN
1057 Fixed form Fortran source code which must be preprocessed (with the traditional
1058 preprocessor).
1059
1060 @item @var{file}.f90
1061 @itemx @var{file}.f95
1062 @itemx @var{file}.f03
1063 @itemx @var{file}.f08
1064 Free form Fortran source code which should not be preprocessed.
1065
1066 @item @var{file}.F90
1067 @itemx @var{file}.F95
1068 @itemx @var{file}.F03
1069 @itemx @var{file}.F08
1070 Free form Fortran source code which must be preprocessed (with the
1071 traditional preprocessor).
1072
1073 @item @var{file}.go
1074 Go source code.
1075
1076 @c FIXME: Descriptions of Java file types.
1077 @c @var{file}.java
1078 @c @var{file}.class
1079 @c @var{file}.zip
1080 @c @var{file}.jar
1081
1082 @item @var{file}.ads
1083 Ada source code file which contains a library unit declaration (a
1084 declaration of a package, subprogram, or generic, or a generic
1085 instantiation), or a library unit renaming declaration (a package,
1086 generic, or subprogram renaming declaration). Such files are also
1087 called @dfn{specs}.
1088
1089 @item @var{file}.adb
1090 Ada source code file containing a library unit body (a subprogram or
1091 package body). Such files are also called @dfn{bodies}.
1092
1093 @c GCC also knows about some suffixes for languages not yet included:
1094 @c Pascal:
1095 @c @var{file}.p
1096 @c @var{file}.pas
1097 @c Ratfor:
1098 @c @var{file}.r
1099
1100 @item @var{file}.s
1101 Assembler code.
1102
1103 @item @var{file}.S
1104 @itemx @var{file}.sx
1105 Assembler code which must be preprocessed.
1106
1107 @item @var{other}
1108 An object file to be fed straight into linking.
1109 Any file name with no recognized suffix is treated this way.
1110 @end table
1111
1112 @opindex x
1113 You can specify the input language explicitly with the @option{-x} option:
1114
1115 @table @gcctabopt
1116 @item -x @var{language}
1117 Specify explicitly the @var{language} for the following input files
1118 (rather than letting the compiler choose a default based on the file
1119 name suffix). This option applies to all following input files until
1120 the next @option{-x} option. Possible values for @var{language} are:
1121 @smallexample
1122 c c-header cpp-output
1123 c++ c++-header c++-cpp-output
1124 objective-c objective-c-header objective-c-cpp-output
1125 objective-c++ objective-c++-header objective-c++-cpp-output
1126 assembler assembler-with-cpp
1127 ada
1128 f77 f77-cpp-input f95 f95-cpp-input
1129 go
1130 java
1131 @end smallexample
1132
1133 @item -x none
1134 Turn off any specification of a language, so that subsequent files are
1135 handled according to their file name suffixes (as they are if @option{-x}
1136 has not been used at all).
1137
1138 @item -pass-exit-codes
1139 @opindex pass-exit-codes
1140 Normally the @command{gcc} program will exit with the code of 1 if any
1141 phase of the compiler returns a non-success return code. If you specify
1142 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1143 numerically highest error produced by any phase that returned an error
1144 indication. The C, C++, and Fortran frontends return 4, if an internal
1145 compiler error is encountered.
1146 @end table
1147
1148 If you only want some of the stages of compilation, you can use
1149 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1150 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1151 @command{gcc} is to stop. Note that some combinations (for example,
1152 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1153
1154 @table @gcctabopt
1155 @item -c
1156 @opindex c
1157 Compile or assemble the source files, but do not link. The linking
1158 stage simply is not done. The ultimate output is in the form of an
1159 object file for each source file.
1160
1161 By default, the object file name for a source file is made by replacing
1162 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1163
1164 Unrecognized input files, not requiring compilation or assembly, are
1165 ignored.
1166
1167 @item -S
1168 @opindex S
1169 Stop after the stage of compilation proper; do not assemble. The output
1170 is in the form of an assembler code file for each non-assembler input
1171 file specified.
1172
1173 By default, the assembler file name for a source file is made by
1174 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1175
1176 Input files that don't require compilation are ignored.
1177
1178 @item -E
1179 @opindex E
1180 Stop after the preprocessing stage; do not run the compiler proper. The
1181 output is in the form of preprocessed source code, which is sent to the
1182 standard output.
1183
1184 Input files which don't require preprocessing are ignored.
1185
1186 @cindex output file option
1187 @item -o @var{file}
1188 @opindex o
1189 Place output in file @var{file}. This applies regardless to whatever
1190 sort of output is being produced, whether it be an executable file,
1191 an object file, an assembler file or preprocessed C code.
1192
1193 If @option{-o} is not specified, the default is to put an executable
1194 file in @file{a.out}, the object file for
1195 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1196 assembler file in @file{@var{source}.s}, a precompiled header file in
1197 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1198 standard output.
1199
1200 @item -v
1201 @opindex v
1202 Print (on standard error output) the commands executed to run the stages
1203 of compilation. Also print the version number of the compiler driver
1204 program and of the preprocessor and the compiler proper.
1205
1206 @item -###
1207 @opindex ###
1208 Like @option{-v} except the commands are not executed and arguments
1209 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1210 This is useful for shell scripts to capture the driver-generated command lines.
1211
1212 @item -pipe
1213 @opindex pipe
1214 Use pipes rather than temporary files for communication between the
1215 various stages of compilation. This fails to work on some systems where
1216 the assembler is unable to read from a pipe; but the GNU assembler has
1217 no trouble.
1218
1219 @item --help
1220 @opindex help
1221 Print (on the standard output) a description of the command line options
1222 understood by @command{gcc}. If the @option{-v} option is also specified
1223 then @option{--help} will also be passed on to the various processes
1224 invoked by @command{gcc}, so that they can display the command line options
1225 they accept. If the @option{-Wextra} option has also been specified
1226 (prior to the @option{--help} option), then command line options which
1227 have no documentation associated with them will also be displayed.
1228
1229 @item --target-help
1230 @opindex target-help
1231 Print (on the standard output) a description of target-specific command
1232 line options for each tool. For some targets extra target-specific
1233 information may also be printed.
1234
1235 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1236 Print (on the standard output) a description of the command line
1237 options understood by the compiler that fit into all specified classes
1238 and qualifiers. These are the supported classes:
1239
1240 @table @asis
1241 @item @samp{optimizers}
1242 This will display all of the optimization options supported by the
1243 compiler.
1244
1245 @item @samp{warnings}
1246 This will display all of the options controlling warning messages
1247 produced by the compiler.
1248
1249 @item @samp{target}
1250 This will display target-specific options. Unlike the
1251 @option{--target-help} option however, target-specific options of the
1252 linker and assembler will not be displayed. This is because those
1253 tools do not currently support the extended @option{--help=} syntax.
1254
1255 @item @samp{params}
1256 This will display the values recognized by the @option{--param}
1257 option.
1258
1259 @item @var{language}
1260 This will display the options supported for @var{language}, where
1261 @var{language} is the name of one of the languages supported in this
1262 version of GCC.
1263
1264 @item @samp{common}
1265 This will display the options that are common to all languages.
1266 @end table
1267
1268 These are the supported qualifiers:
1269
1270 @table @asis
1271 @item @samp{undocumented}
1272 Display only those options which are undocumented.
1273
1274 @item @samp{joined}
1275 Display options which take an argument that appears after an equal
1276 sign in the same continuous piece of text, such as:
1277 @samp{--help=target}.
1278
1279 @item @samp{separate}
1280 Display options which take an argument that appears as a separate word
1281 following the original option, such as: @samp{-o output-file}.
1282 @end table
1283
1284 Thus for example to display all the undocumented target-specific
1285 switches supported by the compiler the following can be used:
1286
1287 @smallexample
1288 --help=target,undocumented
1289 @end smallexample
1290
1291 The sense of a qualifier can be inverted by prefixing it with the
1292 @samp{^} character, so for example to display all binary warning
1293 options (i.e., ones that are either on or off and that do not take an
1294 argument), which have a description the following can be used:
1295
1296 @smallexample
1297 --help=warnings,^joined,^undocumented
1298 @end smallexample
1299
1300 The argument to @option{--help=} should not consist solely of inverted
1301 qualifiers.
1302
1303 Combining several classes is possible, although this usually
1304 restricts the output by so much that there is nothing to display. One
1305 case where it does work however is when one of the classes is
1306 @var{target}. So for example to display all the target-specific
1307 optimization options the following can be used:
1308
1309 @smallexample
1310 --help=target,optimizers
1311 @end smallexample
1312
1313 The @option{--help=} option can be repeated on the command line. Each
1314 successive use will display its requested class of options, skipping
1315 those that have already been displayed.
1316
1317 If the @option{-Q} option appears on the command line before the
1318 @option{--help=} option, then the descriptive text displayed by
1319 @option{--help=} is changed. Instead of describing the displayed
1320 options, an indication is given as to whether the option is enabled,
1321 disabled or set to a specific value (assuming that the compiler
1322 knows this at the point where the @option{--help=} option is used).
1323
1324 Here is a truncated example from the ARM port of @command{gcc}:
1325
1326 @smallexample
1327 % gcc -Q -mabi=2 --help=target -c
1328 The following options are target specific:
1329 -mabi= 2
1330 -mabort-on-noreturn [disabled]
1331 -mapcs [disabled]
1332 @end smallexample
1333
1334 The output is sensitive to the effects of previous command line
1335 options, so for example it is possible to find out which optimizations
1336 are enabled at @option{-O2} by using:
1337
1338 @smallexample
1339 -Q -O2 --help=optimizers
1340 @end smallexample
1341
1342 Alternatively you can discover which binary optimizations are enabled
1343 by @option{-O3} by using:
1344
1345 @smallexample
1346 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1347 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1348 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1349 @end smallexample
1350
1351 @item -no-canonical-prefixes
1352 @opindex no-canonical-prefixes
1353 Do not expand any symbolic links, resolve references to @samp{/../}
1354 or @samp{/./}, or make the path absolute when generating a relative
1355 prefix.
1356
1357 @item --version
1358 @opindex version
1359 Display the version number and copyrights of the invoked GCC@.
1360
1361 @item -wrapper
1362 @opindex wrapper
1363 Invoke all subcommands under a wrapper program. The name of the
1364 wrapper program and its parameters are passed as a comma separated
1365 list.
1366
1367 @smallexample
1368 gcc -c t.c -wrapper gdb,--args
1369 @end smallexample
1370
1371 This will invoke all subprograms of @command{gcc} under
1372 @samp{gdb --args}, thus the invocation of @command{cc1} will be
1373 @samp{gdb --args cc1 @dots{}}.
1374
1375 @item -fplugin=@var{name}.so
1376 Load the plugin code in file @var{name}.so, assumed to be a
1377 shared object to be dlopen'd by the compiler. The base name of
1378 the shared object file is used to identify the plugin for the
1379 purposes of argument parsing (See
1380 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1381 Each plugin should define the callback functions specified in the
1382 Plugins API.
1383
1384 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1385 Define an argument called @var{key} with a value of @var{value}
1386 for the plugin called @var{name}.
1387
1388 @item -fdump-ada-spec@r{[}-slim@r{]}
1389 For C and C++ source and include files, generate corresponding Ada
1390 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1391 GNAT User's Guide}, which provides detailed documentation on this feature.
1392
1393 @item -fdump-go-spec=@var{file}
1394 For input files in any language, generate corresponding Go
1395 declarations in @var{file}. This generates Go @code{const},
1396 @code{type}, @code{var}, and @code{func} declarations which may be a
1397 useful way to start writing a Go interface to code written in some
1398 other language.
1399
1400 @include @value{srcdir}/../libiberty/at-file.texi
1401 @end table
1402
1403 @node Invoking G++
1404 @section Compiling C++ Programs
1405
1406 @cindex suffixes for C++ source
1407 @cindex C++ source file suffixes
1408 C++ source files conventionally use one of the suffixes @samp{.C},
1409 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1410 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1411 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1412 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1413 files with these names and compiles them as C++ programs even if you
1414 call the compiler the same way as for compiling C programs (usually
1415 with the name @command{gcc}).
1416
1417 @findex g++
1418 @findex c++
1419 However, the use of @command{gcc} does not add the C++ library.
1420 @command{g++} is a program that calls GCC and treats @samp{.c},
1421 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1422 files unless @option{-x} is used, and automatically specifies linking
1423 against the C++ library. This program is also useful when
1424 precompiling a C header file with a @samp{.h} extension for use in C++
1425 compilations. On many systems, @command{g++} is also installed with
1426 the name @command{c++}.
1427
1428 @cindex invoking @command{g++}
1429 When you compile C++ programs, you may specify many of the same
1430 command-line options that you use for compiling programs in any
1431 language; or command-line options meaningful for C and related
1432 languages; or options that are meaningful only for C++ programs.
1433 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1434 explanations of options for languages related to C@.
1435 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1436 explanations of options that are meaningful only for C++ programs.
1437
1438 @node C Dialect Options
1439 @section Options Controlling C Dialect
1440 @cindex dialect options
1441 @cindex language dialect options
1442 @cindex options, dialect
1443
1444 The following options control the dialect of C (or languages derived
1445 from C, such as C++, Objective-C and Objective-C++) that the compiler
1446 accepts:
1447
1448 @table @gcctabopt
1449 @cindex ANSI support
1450 @cindex ISO support
1451 @item -ansi
1452 @opindex ansi
1453 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1454 equivalent to @samp{-std=c++98}.
1455
1456 This turns off certain features of GCC that are incompatible with ISO
1457 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1458 such as the @code{asm} and @code{typeof} keywords, and
1459 predefined macros such as @code{unix} and @code{vax} that identify the
1460 type of system you are using. It also enables the undesirable and
1461 rarely used ISO trigraph feature. For the C compiler,
1462 it disables recognition of C++ style @samp{//} comments as well as
1463 the @code{inline} keyword.
1464
1465 The alternate keywords @code{__asm__}, @code{__extension__},
1466 @code{__inline__} and @code{__typeof__} continue to work despite
1467 @option{-ansi}. You would not want to use them in an ISO C program, of
1468 course, but it is useful to put them in header files that might be included
1469 in compilations done with @option{-ansi}. Alternate predefined macros
1470 such as @code{__unix__} and @code{__vax__} are also available, with or
1471 without @option{-ansi}.
1472
1473 The @option{-ansi} option does not cause non-ISO programs to be
1474 rejected gratuitously. For that, @option{-pedantic} is required in
1475 addition to @option{-ansi}. @xref{Warning Options}.
1476
1477 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1478 option is used. Some header files may notice this macro and refrain
1479 from declaring certain functions or defining certain macros that the
1480 ISO standard doesn't call for; this is to avoid interfering with any
1481 programs that might use these names for other things.
1482
1483 Functions that would normally be built in but do not have semantics
1484 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1485 functions when @option{-ansi} is used. @xref{Other Builtins,,Other
1486 built-in functions provided by GCC}, for details of the functions
1487 affected.
1488
1489 @item -std=
1490 @opindex std
1491 Determine the language standard. @xref{Standards,,Language Standards
1492 Supported by GCC}, for details of these standard versions. This option
1493 is currently only supported when compiling C or C++.
1494
1495 The compiler can accept several base standards, such as @samp{c90} or
1496 @samp{c++98}, and GNU dialects of those standards, such as
1497 @samp{gnu90} or @samp{gnu++98}. By specifying a base standard, the
1498 compiler will accept all programs following that standard and those
1499 using GNU extensions that do not contradict it. For example,
1500 @samp{-std=c90} turns off certain features of GCC that are
1501 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1502 keywords, but not other GNU extensions that do not have a meaning in
1503 ISO C90, such as omitting the middle term of a @code{?:}
1504 expression. On the other hand, by specifying a GNU dialect of a
1505 standard, all features the compiler support are enabled, even when
1506 those features change the meaning of the base standard and some
1507 strict-conforming programs may be rejected. The particular standard
1508 is used by @option{-pedantic} to identify which features are GNU
1509 extensions given that version of the standard. For example
1510 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1511 comments, while @samp{-std=gnu99 -pedantic} would not.
1512
1513 A value for this option must be provided; possible values are
1514
1515 @table @samp
1516 @item c90
1517 @itemx c89
1518 @itemx iso9899:1990
1519 Support all ISO C90 programs (certain GNU extensions that conflict
1520 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1521
1522 @item iso9899:199409
1523 ISO C90 as modified in amendment 1.
1524
1525 @item c99
1526 @itemx c9x
1527 @itemx iso9899:1999
1528 @itemx iso9899:199x
1529 ISO C99. Note that this standard is not yet fully supported; see
1530 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1531 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1532
1533 @item c1x
1534 ISO C1X, the draft of the next revision of the ISO C standard.
1535 Support is limited and experimental and features enabled by this
1536 option may be changed or removed if changed in or removed from the
1537 standard draft.
1538
1539 @item gnu90
1540 @itemx gnu89
1541 GNU dialect of ISO C90 (including some C99 features). This
1542 is the default for C code.
1543
1544 @item gnu99
1545 @itemx gnu9x
1546 GNU dialect of ISO C99. When ISO C99 is fully implemented in GCC,
1547 this will become the default. The name @samp{gnu9x} is deprecated.
1548
1549 @item gnu1x
1550 GNU dialect of ISO C1X. Support is limited and experimental and
1551 features enabled by this option may be changed or removed if changed
1552 in or removed from the standard draft.
1553
1554 @item c++98
1555 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1556 C++ code.
1557
1558 @item gnu++98
1559 GNU dialect of @option{-std=c++98}. This is the default for
1560 C++ code.
1561
1562 @item c++0x
1563 The working draft of the upcoming ISO C++0x standard. This option
1564 enables experimental features that are likely to be included in
1565 C++0x. The working draft is constantly changing, and any feature that is
1566 enabled by this flag may be removed from future versions of GCC if it is
1567 not part of the C++0x standard.
1568
1569 @item gnu++0x
1570 GNU dialect of @option{-std=c++0x}. This option enables
1571 experimental features that may be removed in future versions of GCC.
1572 @end table
1573
1574 @item -fgnu89-inline
1575 @opindex fgnu89-inline
1576 The option @option{-fgnu89-inline} tells GCC to use the traditional
1577 GNU semantics for @code{inline} functions when in C99 mode.
1578 @xref{Inline,,An Inline Function is As Fast As a Macro}. This option
1579 is accepted and ignored by GCC versions 4.1.3 up to but not including
1580 4.3. In GCC versions 4.3 and later it changes the behavior of GCC in
1581 C99 mode. Using this option is roughly equivalent to adding the
1582 @code{gnu_inline} function attribute to all inline functions
1583 (@pxref{Function Attributes}).
1584
1585 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1586 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1587 specifies the default behavior). This option was first supported in
1588 GCC 4.3. This option is not supported in @option{-std=c90} or
1589 @option{-std=gnu90} mode.
1590
1591 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1592 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1593 in effect for @code{inline} functions. @xref{Common Predefined
1594 Macros,,,cpp,The C Preprocessor}.
1595
1596 @item -aux-info @var{filename}
1597 @opindex aux-info
1598 Output to the given filename prototyped declarations for all functions
1599 declared and/or defined in a translation unit, including those in header
1600 files. This option is silently ignored in any language other than C@.
1601
1602 Besides declarations, the file indicates, in comments, the origin of
1603 each declaration (source file and line), whether the declaration was
1604 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1605 @samp{O} for old, respectively, in the first character after the line
1606 number and the colon), and whether it came from a declaration or a
1607 definition (@samp{C} or @samp{F}, respectively, in the following
1608 character). In the case of function definitions, a K&R-style list of
1609 arguments followed by their declarations is also provided, inside
1610 comments, after the declaration.
1611
1612 @item -fno-asm
1613 @opindex fno-asm
1614 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1615 keyword, so that code can use these words as identifiers. You can use
1616 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1617 instead. @option{-ansi} implies @option{-fno-asm}.
1618
1619 In C++, this switch only affects the @code{typeof} keyword, since
1620 @code{asm} and @code{inline} are standard keywords. You may want to
1621 use the @option{-fno-gnu-keywords} flag instead, which has the same
1622 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1623 switch only affects the @code{asm} and @code{typeof} keywords, since
1624 @code{inline} is a standard keyword in ISO C99.
1625
1626 @item -fno-builtin
1627 @itemx -fno-builtin-@var{function}
1628 @opindex fno-builtin
1629 @cindex built-in functions
1630 Don't recognize built-in functions that do not begin with
1631 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1632 functions provided by GCC}, for details of the functions affected,
1633 including those which are not built-in functions when @option{-ansi} or
1634 @option{-std} options for strict ISO C conformance are used because they
1635 do not have an ISO standard meaning.
1636
1637 GCC normally generates special code to handle certain built-in functions
1638 more efficiently; for instance, calls to @code{alloca} may become single
1639 instructions that adjust the stack directly, and calls to @code{memcpy}
1640 may become inline copy loops. The resulting code is often both smaller
1641 and faster, but since the function calls no longer appear as such, you
1642 cannot set a breakpoint on those calls, nor can you change the behavior
1643 of the functions by linking with a different library. In addition,
1644 when a function is recognized as a built-in function, GCC may use
1645 information about that function to warn about problems with calls to
1646 that function, or to generate more efficient code, even if the
1647 resulting code still contains calls to that function. For example,
1648 warnings are given with @option{-Wformat} for bad calls to
1649 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1650 known not to modify global memory.
1651
1652 With the @option{-fno-builtin-@var{function}} option
1653 only the built-in function @var{function} is
1654 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1655 function is named that is not built-in in this version of GCC, this
1656 option is ignored. There is no corresponding
1657 @option{-fbuiltin-@var{function}} option; if you wish to enable
1658 built-in functions selectively when using @option{-fno-builtin} or
1659 @option{-ffreestanding}, you may define macros such as:
1660
1661 @smallexample
1662 #define abs(n) __builtin_abs ((n))
1663 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1664 @end smallexample
1665
1666 @item -fhosted
1667 @opindex fhosted
1668 @cindex hosted environment
1669
1670 Assert that compilation takes place in a hosted environment. This implies
1671 @option{-fbuiltin}. A hosted environment is one in which the
1672 entire standard library is available, and in which @code{main} has a return
1673 type of @code{int}. Examples are nearly everything except a kernel.
1674 This is equivalent to @option{-fno-freestanding}.
1675
1676 @item -ffreestanding
1677 @opindex ffreestanding
1678 @cindex hosted environment
1679
1680 Assert that compilation takes place in a freestanding environment. This
1681 implies @option{-fno-builtin}. A freestanding environment
1682 is one in which the standard library may not exist, and program startup may
1683 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1684 This is equivalent to @option{-fno-hosted}.
1685
1686 @xref{Standards,,Language Standards Supported by GCC}, for details of
1687 freestanding and hosted environments.
1688
1689 @item -fopenmp
1690 @opindex fopenmp
1691 @cindex OpenMP parallel
1692 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1693 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
1694 compiler generates parallel code according to the OpenMP Application
1695 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}. This option
1696 implies @option{-pthread}, and thus is only supported on targets that
1697 have support for @option{-pthread}.
1698
1699 @item -fms-extensions
1700 @opindex fms-extensions
1701 Accept some non-standard constructs used in Microsoft header files.
1702
1703 In C++ code, this allows member names in structures to be similar
1704 to previous types declarations.
1705
1706 @smallexample
1707 typedef int UOW;
1708 struct ABC @{
1709 UOW UOW;
1710 @};
1711 @end smallexample
1712
1713 Some cases of unnamed fields in structures and unions are only
1714 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1715 fields within structs/unions}, for details.
1716
1717 @item -fplan9-extensions
1718 Accept some non-standard constructs used in Plan 9 code.
1719
1720 This enables @option{-fms-extensions}, permits passing pointers to
1721 structures with anonymous fields to functions which expect pointers to
1722 elements of the type of the field, and permits referring to anonymous
1723 fields declared using a typedef. @xref{Unnamed Fields,,Unnamed
1724 struct/union fields within structs/unions}, for details. This is only
1725 supported for C, not C++.
1726
1727 @item -trigraphs
1728 @opindex trigraphs
1729 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1730 options for strict ISO C conformance) implies @option{-trigraphs}.
1731
1732 @item -no-integrated-cpp
1733 @opindex no-integrated-cpp
1734 Performs a compilation in two passes: preprocessing and compiling. This
1735 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1736 @option{-B} option. The user supplied compilation step can then add in
1737 an additional preprocessing step after normal preprocessing but before
1738 compiling. The default is to use the integrated cpp (internal cpp)
1739
1740 The semantics of this option will change if "cc1", "cc1plus", and
1741 "cc1obj" are merged.
1742
1743 @cindex traditional C language
1744 @cindex C language, traditional
1745 @item -traditional
1746 @itemx -traditional-cpp
1747 @opindex traditional-cpp
1748 @opindex traditional
1749 Formerly, these options caused GCC to attempt to emulate a pre-standard
1750 C compiler. They are now only supported with the @option{-E} switch.
1751 The preprocessor continues to support a pre-standard mode. See the GNU
1752 CPP manual for details.
1753
1754 @item -fcond-mismatch
1755 @opindex fcond-mismatch
1756 Allow conditional expressions with mismatched types in the second and
1757 third arguments. The value of such an expression is void. This option
1758 is not supported for C++.
1759
1760 @item -flax-vector-conversions
1761 @opindex flax-vector-conversions
1762 Allow implicit conversions between vectors with differing numbers of
1763 elements and/or incompatible element types. This option should not be
1764 used for new code.
1765
1766 @item -funsigned-char
1767 @opindex funsigned-char
1768 Let the type @code{char} be unsigned, like @code{unsigned char}.
1769
1770 Each kind of machine has a default for what @code{char} should
1771 be. It is either like @code{unsigned char} by default or like
1772 @code{signed char} by default.
1773
1774 Ideally, a portable program should always use @code{signed char} or
1775 @code{unsigned char} when it depends on the signedness of an object.
1776 But many programs have been written to use plain @code{char} and
1777 expect it to be signed, or expect it to be unsigned, depending on the
1778 machines they were written for. This option, and its inverse, let you
1779 make such a program work with the opposite default.
1780
1781 The type @code{char} is always a distinct type from each of
1782 @code{signed char} or @code{unsigned char}, even though its behavior
1783 is always just like one of those two.
1784
1785 @item -fsigned-char
1786 @opindex fsigned-char
1787 Let the type @code{char} be signed, like @code{signed char}.
1788
1789 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1790 the negative form of @option{-funsigned-char}. Likewise, the option
1791 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1792
1793 @item -fsigned-bitfields
1794 @itemx -funsigned-bitfields
1795 @itemx -fno-signed-bitfields
1796 @itemx -fno-unsigned-bitfields
1797 @opindex fsigned-bitfields
1798 @opindex funsigned-bitfields
1799 @opindex fno-signed-bitfields
1800 @opindex fno-unsigned-bitfields
1801 These options control whether a bit-field is signed or unsigned, when the
1802 declaration does not use either @code{signed} or @code{unsigned}. By
1803 default, such a bit-field is signed, because this is consistent: the
1804 basic integer types such as @code{int} are signed types.
1805 @end table
1806
1807 @node C++ Dialect Options
1808 @section Options Controlling C++ Dialect
1809
1810 @cindex compiler options, C++
1811 @cindex C++ options, command line
1812 @cindex options, C++
1813 This section describes the command-line options that are only meaningful
1814 for C++ programs; but you can also use most of the GNU compiler options
1815 regardless of what language your program is in. For example, you
1816 might compile a file @code{firstClass.C} like this:
1817
1818 @smallexample
1819 g++ -g -frepo -O -c firstClass.C
1820 @end smallexample
1821
1822 @noindent
1823 In this example, only @option{-frepo} is an option meant
1824 only for C++ programs; you can use the other options with any
1825 language supported by GCC@.
1826
1827 Here is a list of options that are @emph{only} for compiling C++ programs:
1828
1829 @table @gcctabopt
1830
1831 @item -fabi-version=@var{n}
1832 @opindex fabi-version
1833 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1834 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1835 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1836 the version that conforms most closely to the C++ ABI specification.
1837 Therefore, the ABI obtained using version 0 will change as ABI bugs
1838 are fixed.
1839
1840 The default is version 2.
1841
1842 Version 3 corrects an error in mangling a constant address as a
1843 template argument.
1844
1845 Version 4 implements a standard mangling for vector types.
1846
1847 See also @option{-Wabi}.
1848
1849 @item -fno-access-control
1850 @opindex fno-access-control
1851 Turn off all access checking. This switch is mainly useful for working
1852 around bugs in the access control code.
1853
1854 @item -fcheck-new
1855 @opindex fcheck-new
1856 Check that the pointer returned by @code{operator new} is non-null
1857 before attempting to modify the storage allocated. This check is
1858 normally unnecessary because the C++ standard specifies that
1859 @code{operator new} will only return @code{0} if it is declared
1860 @samp{throw()}, in which case the compiler will always check the
1861 return value even without this option. In all other cases, when
1862 @code{operator new} has a non-empty exception specification, memory
1863 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1864 @samp{new (nothrow)}.
1865
1866 @item -fconserve-space
1867 @opindex fconserve-space
1868 Put uninitialized or runtime-initialized global variables into the
1869 common segment, as C does. This saves space in the executable at the
1870 cost of not diagnosing duplicate definitions. If you compile with this
1871 flag and your program mysteriously crashes after @code{main()} has
1872 completed, you may have an object that is being destroyed twice because
1873 two definitions were merged.
1874
1875 This option is no longer useful on most targets, now that support has
1876 been added for putting variables into BSS without making them common.
1877
1878 @item -fno-deduce-init-list
1879 @opindex fno-deduce-init-list
1880 Disable deduction of a template type parameter as
1881 std::initializer_list from a brace-enclosed initializer list, i.e.
1882
1883 @smallexample
1884 template <class T> auto forward(T t) -> decltype (realfn (t))
1885 @{
1886 return realfn (t);
1887 @}
1888
1889 void f()
1890 @{
1891 forward(@{1,2@}); // call forward<std::initializer_list<int>>
1892 @}
1893 @end smallexample
1894
1895 This option is present because this deduction is an extension to the
1896 current specification in the C++0x working draft, and there was
1897 some concern about potential overload resolution problems.
1898
1899 @item -ffriend-injection
1900 @opindex ffriend-injection
1901 Inject friend functions into the enclosing namespace, so that they are
1902 visible outside the scope of the class in which they are declared.
1903 Friend functions were documented to work this way in the old Annotated
1904 C++ Reference Manual, and versions of G++ before 4.1 always worked
1905 that way. However, in ISO C++ a friend function which is not declared
1906 in an enclosing scope can only be found using argument dependent
1907 lookup. This option causes friends to be injected as they were in
1908 earlier releases.
1909
1910 This option is for compatibility, and may be removed in a future
1911 release of G++.
1912
1913 @item -fno-elide-constructors
1914 @opindex fno-elide-constructors
1915 The C++ standard allows an implementation to omit creating a temporary
1916 which is only used to initialize another object of the same type.
1917 Specifying this option disables that optimization, and forces G++ to
1918 call the copy constructor in all cases.
1919
1920 @item -fno-enforce-eh-specs
1921 @opindex fno-enforce-eh-specs
1922 Don't generate code to check for violation of exception specifications
1923 at runtime. This option violates the C++ standard, but may be useful
1924 for reducing code size in production builds, much like defining
1925 @samp{NDEBUG}. This does not give user code permission to throw
1926 exceptions in violation of the exception specifications; the compiler
1927 will still optimize based on the specifications, so throwing an
1928 unexpected exception will result in undefined behavior.
1929
1930 @item -ffor-scope
1931 @itemx -fno-for-scope
1932 @opindex ffor-scope
1933 @opindex fno-for-scope
1934 If @option{-ffor-scope} is specified, the scope of variables declared in
1935 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1936 as specified by the C++ standard.
1937 If @option{-fno-for-scope} is specified, the scope of variables declared in
1938 a @i{for-init-statement} extends to the end of the enclosing scope,
1939 as was the case in old versions of G++, and other (traditional)
1940 implementations of C++.
1941
1942 The default if neither flag is given to follow the standard,
1943 but to allow and give a warning for old-style code that would
1944 otherwise be invalid, or have different behavior.
1945
1946 @item -fno-gnu-keywords
1947 @opindex fno-gnu-keywords
1948 Do not recognize @code{typeof} as a keyword, so that code can use this
1949 word as an identifier. You can use the keyword @code{__typeof__} instead.
1950 @option{-ansi} implies @option{-fno-gnu-keywords}.
1951
1952 @item -fno-implicit-templates
1953 @opindex fno-implicit-templates
1954 Never emit code for non-inline templates which are instantiated
1955 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1956 @xref{Template Instantiation}, for more information.
1957
1958 @item -fno-implicit-inline-templates
1959 @opindex fno-implicit-inline-templates
1960 Don't emit code for implicit instantiations of inline templates, either.
1961 The default is to handle inlines differently so that compiles with and
1962 without optimization will need the same set of explicit instantiations.
1963
1964 @item -fno-implement-inlines
1965 @opindex fno-implement-inlines
1966 To save space, do not emit out-of-line copies of inline functions
1967 controlled by @samp{#pragma implementation}. This will cause linker
1968 errors if these functions are not inlined everywhere they are called.
1969
1970 @item -fms-extensions
1971 @opindex fms-extensions
1972 Disable pedantic warnings about constructs used in MFC, such as implicit
1973 int and getting a pointer to member function via non-standard syntax.
1974
1975 @item -fno-nonansi-builtins
1976 @opindex fno-nonansi-builtins
1977 Disable built-in declarations of functions that are not mandated by
1978 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1979 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1980
1981 @item -fnothrow-opt
1982 @opindex fnothrow-opt
1983 Treat a @code{throw()} exception specification as though it were a
1984 @code{noexcept} specification to reduce or eliminate the text size
1985 overhead relative to a function with no exception specification. If
1986 the function has local variables of types with non-trivial
1987 destructors, the exception specification will actually make the
1988 function smaller because the EH cleanups for those variables can be
1989 optimized away. The semantic effect is that an exception thrown out of
1990 a function with such an exception specification will result in a call
1991 to @code{terminate} rather than @code{unexpected}.
1992
1993 @item -fno-operator-names
1994 @opindex fno-operator-names
1995 Do not treat the operator name keywords @code{and}, @code{bitand},
1996 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1997 synonyms as keywords.
1998
1999 @item -fno-optional-diags
2000 @opindex fno-optional-diags
2001 Disable diagnostics that the standard says a compiler does not need to
2002 issue. Currently, the only such diagnostic issued by G++ is the one for
2003 a name having multiple meanings within a class.
2004
2005 @item -fpermissive
2006 @opindex fpermissive
2007 Downgrade some diagnostics about nonconformant code from errors to
2008 warnings. Thus, using @option{-fpermissive} will allow some
2009 nonconforming code to compile.
2010
2011 @item -fno-pretty-templates
2012 @opindex fno-pretty-templates
2013 When an error message refers to a specialization of a function
2014 template, the compiler will normally print the signature of the
2015 template followed by the template arguments and any typedefs or
2016 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2017 rather than @code{void f(int)}) so that it's clear which template is
2018 involved. When an error message refers to a specialization of a class
2019 template, the compiler will omit any template arguments which match
2020 the default template arguments for that template. If either of these
2021 behaviors make it harder to understand the error message rather than
2022 easier, using @option{-fno-pretty-templates} will disable them.
2023
2024 @item -frepo
2025 @opindex frepo
2026 Enable automatic template instantiation at link time. This option also
2027 implies @option{-fno-implicit-templates}. @xref{Template
2028 Instantiation}, for more information.
2029
2030 @item -fno-rtti
2031 @opindex fno-rtti
2032 Disable generation of information about every class with virtual
2033 functions for use by the C++ runtime type identification features
2034 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
2035 of the language, you can save some space by using this flag. Note that
2036 exception handling uses the same information, but it will generate it as
2037 needed. The @samp{dynamic_cast} operator can still be used for casts that
2038 do not require runtime type information, i.e.@: casts to @code{void *} or to
2039 unambiguous base classes.
2040
2041 @item -fstats
2042 @opindex fstats
2043 Emit statistics about front-end processing at the end of the compilation.
2044 This information is generally only useful to the G++ development team.
2045
2046 @item -fstrict-enums
2047 @opindex fstrict-enums
2048 Allow the compiler to optimize using the assumption that a value of
2049 enumeration type can only be one of the values of the enumeration (as
2050 defined in the C++ standard; basically, a value which can be
2051 represented in the minimum number of bits needed to represent all the
2052 enumerators). This assumption may not be valid if the program uses a
2053 cast to convert an arbitrary integer value to the enumeration type.
2054
2055 @item -ftemplate-depth=@var{n}
2056 @opindex ftemplate-depth
2057 Set the maximum instantiation depth for template classes to @var{n}.
2058 A limit on the template instantiation depth is needed to detect
2059 endless recursions during template class instantiation. ANSI/ISO C++
2060 conforming programs must not rely on a maximum depth greater than 17
2061 (changed to 1024 in C++0x).
2062
2063 @item -fno-threadsafe-statics
2064 @opindex fno-threadsafe-statics
2065 Do not emit the extra code to use the routines specified in the C++
2066 ABI for thread-safe initialization of local statics. You can use this
2067 option to reduce code size slightly in code that doesn't need to be
2068 thread-safe.
2069
2070 @item -fuse-cxa-atexit
2071 @opindex fuse-cxa-atexit
2072 Register destructors for objects with static storage duration with the
2073 @code{__cxa_atexit} function rather than the @code{atexit} function.
2074 This option is required for fully standards-compliant handling of static
2075 destructors, but will only work if your C library supports
2076 @code{__cxa_atexit}.
2077
2078 @item -fno-use-cxa-get-exception-ptr
2079 @opindex fno-use-cxa-get-exception-ptr
2080 Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
2081 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2082 if the runtime routine is not available.
2083
2084 @item -fvisibility-inlines-hidden
2085 @opindex fvisibility-inlines-hidden
2086 This switch declares that the user does not attempt to compare
2087 pointers to inline methods where the addresses of the two functions
2088 were taken in different shared objects.
2089
2090 The effect of this is that GCC may, effectively, mark inline methods with
2091 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2092 appear in the export table of a DSO and do not require a PLT indirection
2093 when used within the DSO@. Enabling this option can have a dramatic effect
2094 on load and link times of a DSO as it massively reduces the size of the
2095 dynamic export table when the library makes heavy use of templates.
2096
2097 The behavior of this switch is not quite the same as marking the
2098 methods as hidden directly, because it does not affect static variables
2099 local to the function or cause the compiler to deduce that
2100 the function is defined in only one shared object.
2101
2102 You may mark a method as having a visibility explicitly to negate the
2103 effect of the switch for that method. For example, if you do want to
2104 compare pointers to a particular inline method, you might mark it as
2105 having default visibility. Marking the enclosing class with explicit
2106 visibility will have no effect.
2107
2108 Explicitly instantiated inline methods are unaffected by this option
2109 as their linkage might otherwise cross a shared library boundary.
2110 @xref{Template Instantiation}.
2111
2112 @item -fvisibility-ms-compat
2113 @opindex fvisibility-ms-compat
2114 This flag attempts to use visibility settings to make GCC's C++
2115 linkage model compatible with that of Microsoft Visual Studio.
2116
2117 The flag makes these changes to GCC's linkage model:
2118
2119 @enumerate
2120 @item
2121 It sets the default visibility to @code{hidden}, like
2122 @option{-fvisibility=hidden}.
2123
2124 @item
2125 Types, but not their members, are not hidden by default.
2126
2127 @item
2128 The One Definition Rule is relaxed for types without explicit
2129 visibility specifications which are defined in more than one different
2130 shared object: those declarations are permitted if they would have
2131 been permitted when this option was not used.
2132 @end enumerate
2133
2134 In new code it is better to use @option{-fvisibility=hidden} and
2135 export those classes which are intended to be externally visible.
2136 Unfortunately it is possible for code to rely, perhaps accidentally,
2137 on the Visual Studio behavior.
2138
2139 Among the consequences of these changes are that static data members
2140 of the same type with the same name but defined in different shared
2141 objects will be different, so changing one will not change the other;
2142 and that pointers to function members defined in different shared
2143 objects may not compare equal. When this flag is given, it is a
2144 violation of the ODR to define types with the same name differently.
2145
2146 @item -fno-weak
2147 @opindex fno-weak
2148 Do not use weak symbol support, even if it is provided by the linker.
2149 By default, G++ will use weak symbols if they are available. This
2150 option exists only for testing, and should not be used by end-users;
2151 it will result in inferior code and has no benefits. This option may
2152 be removed in a future release of G++.
2153
2154 @item -nostdinc++
2155 @opindex nostdinc++
2156 Do not search for header files in the standard directories specific to
2157 C++, but do still search the other standard directories. (This option
2158 is used when building the C++ library.)
2159 @end table
2160
2161 In addition, these optimization, warning, and code generation options
2162 have meanings only for C++ programs:
2163
2164 @table @gcctabopt
2165 @item -fno-default-inline
2166 @opindex fno-default-inline
2167 Do not assume @samp{inline} for functions defined inside a class scope.
2168 @xref{Optimize Options,,Options That Control Optimization}. Note that these
2169 functions will have linkage like inline functions; they just won't be
2170 inlined by default.
2171
2172 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2173 @opindex Wabi
2174 @opindex Wno-abi
2175 Warn when G++ generates code that is probably not compatible with the
2176 vendor-neutral C++ ABI@. Although an effort has been made to warn about
2177 all such cases, there are probably some cases that are not warned about,
2178 even though G++ is generating incompatible code. There may also be
2179 cases where warnings are emitted even though the code that is generated
2180 will be compatible.
2181
2182 You should rewrite your code to avoid these warnings if you are
2183 concerned about the fact that code generated by G++ may not be binary
2184 compatible with code generated by other compilers.
2185
2186 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2187
2188 @itemize @bullet
2189
2190 @item
2191 A template with a non-type template parameter of reference type is
2192 mangled incorrectly:
2193 @smallexample
2194 extern int N;
2195 template <int &> struct S @{@};
2196 void n (S<N>) @{2@}
2197 @end smallexample
2198
2199 This is fixed in @option{-fabi-version=3}.
2200
2201 @item
2202 SIMD vector types declared using @code{__attribute ((vector_size))} are
2203 mangled in a non-standard way that does not allow for overloading of
2204 functions taking vectors of different sizes.
2205
2206 The mangling is changed in @option{-fabi-version=4}.
2207 @end itemize
2208
2209 The known incompatibilities in @option{-fabi-version=1} include:
2210
2211 @itemize @bullet
2212
2213 @item
2214 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
2215 pack data into the same byte as a base class. For example:
2216
2217 @smallexample
2218 struct A @{ virtual void f(); int f1 : 1; @};
2219 struct B : public A @{ int f2 : 1; @};
2220 @end smallexample
2221
2222 @noindent
2223 In this case, G++ will place @code{B::f2} into the same byte
2224 as@code{A::f1}; other compilers will not. You can avoid this problem
2225 by explicitly padding @code{A} so that its size is a multiple of the
2226 byte size on your platform; that will cause G++ and other compilers to
2227 layout @code{B} identically.
2228
2229 @item
2230 Incorrect handling of tail-padding for virtual bases. G++ does not use
2231 tail padding when laying out virtual bases. For example:
2232
2233 @smallexample
2234 struct A @{ virtual void f(); char c1; @};
2235 struct B @{ B(); char c2; @};
2236 struct C : public A, public virtual B @{@};
2237 @end smallexample
2238
2239 @noindent
2240 In this case, G++ will not place @code{B} into the tail-padding for
2241 @code{A}; other compilers will. You can avoid this problem by
2242 explicitly padding @code{A} so that its size is a multiple of its
2243 alignment (ignoring virtual base classes); that will cause G++ and other
2244 compilers to layout @code{C} identically.
2245
2246 @item
2247 Incorrect handling of bit-fields with declared widths greater than that
2248 of their underlying types, when the bit-fields appear in a union. For
2249 example:
2250
2251 @smallexample
2252 union U @{ int i : 4096; @};
2253 @end smallexample
2254
2255 @noindent
2256 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2257 union too small by the number of bits in an @code{int}.
2258
2259 @item
2260 Empty classes can be placed at incorrect offsets. For example:
2261
2262 @smallexample
2263 struct A @{@};
2264
2265 struct B @{
2266 A a;
2267 virtual void f ();
2268 @};
2269
2270 struct C : public B, public A @{@};
2271 @end smallexample
2272
2273 @noindent
2274 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2275 it should be placed at offset zero. G++ mistakenly believes that the
2276 @code{A} data member of @code{B} is already at offset zero.
2277
2278 @item
2279 Names of template functions whose types involve @code{typename} or
2280 template template parameters can be mangled incorrectly.
2281
2282 @smallexample
2283 template <typename Q>
2284 void f(typename Q::X) @{@}
2285
2286 template <template <typename> class Q>
2287 void f(typename Q<int>::X) @{@}
2288 @end smallexample
2289
2290 @noindent
2291 Instantiations of these templates may be mangled incorrectly.
2292
2293 @end itemize
2294
2295 It also warns psABI related changes. The known psABI changes at this
2296 point include:
2297
2298 @itemize @bullet
2299
2300 @item
2301 For SYSV/x86-64, when passing union with long double, it is changed to
2302 pass in memory as specified in psABI. For example:
2303
2304 @smallexample
2305 union U @{
2306 long double ld;
2307 int i;
2308 @};
2309 @end smallexample
2310
2311 @noindent
2312 @code{union U} will always be passed in memory.
2313
2314 @end itemize
2315
2316 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2317 @opindex Wctor-dtor-privacy
2318 @opindex Wno-ctor-dtor-privacy
2319 Warn when a class seems unusable because all the constructors or
2320 destructors in that class are private, and it has neither friends nor
2321 public static member functions.
2322
2323 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2324 @opindex Wnoexcept
2325 @opindex Wno-noexcept
2326 Warn when a noexcept-expression evaluates to false because of a call
2327 to a function that does not have a non-throwing exception
2328 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2329 the compiler to never throw an exception.
2330
2331 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2332 @opindex Wnon-virtual-dtor
2333 @opindex Wno-non-virtual-dtor
2334 Warn when a class has virtual functions and accessible non-virtual
2335 destructor, in which case it would be possible but unsafe to delete
2336 an instance of a derived class through a pointer to the base class.
2337 This warning is also enabled if -Weffc++ is specified.
2338
2339 @item -Wreorder @r{(C++ and Objective-C++ only)}
2340 @opindex Wreorder
2341 @opindex Wno-reorder
2342 @cindex reordering, warning
2343 @cindex warning for reordering of member initializers
2344 Warn when the order of member initializers given in the code does not
2345 match the order in which they must be executed. For instance:
2346
2347 @smallexample
2348 struct A @{
2349 int i;
2350 int j;
2351 A(): j (0), i (1) @{ @}
2352 @};
2353 @end smallexample
2354
2355 The compiler will rearrange the member initializers for @samp{i}
2356 and @samp{j} to match the declaration order of the members, emitting
2357 a warning to that effect. This warning is enabled by @option{-Wall}.
2358 @end table
2359
2360 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2361
2362 @table @gcctabopt
2363 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2364 @opindex Weffc++
2365 @opindex Wno-effc++
2366 Warn about violations of the following style guidelines from Scott Meyers'
2367 @cite{Effective C++} book:
2368
2369 @itemize @bullet
2370 @item
2371 Item 11: Define a copy constructor and an assignment operator for classes
2372 with dynamically allocated memory.
2373
2374 @item
2375 Item 12: Prefer initialization to assignment in constructors.
2376
2377 @item
2378 Item 14: Make destructors virtual in base classes.
2379
2380 @item
2381 Item 15: Have @code{operator=} return a reference to @code{*this}.
2382
2383 @item
2384 Item 23: Don't try to return a reference when you must return an object.
2385
2386 @end itemize
2387
2388 Also warn about violations of the following style guidelines from
2389 Scott Meyers' @cite{More Effective C++} book:
2390
2391 @itemize @bullet
2392 @item
2393 Item 6: Distinguish between prefix and postfix forms of increment and
2394 decrement operators.
2395
2396 @item
2397 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
2398
2399 @end itemize
2400
2401 When selecting this option, be aware that the standard library
2402 headers do not obey all of these guidelines; use @samp{grep -v}
2403 to filter out those warnings.
2404
2405 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2406 @opindex Wstrict-null-sentinel
2407 @opindex Wno-strict-null-sentinel
2408 Warn also about the use of an uncasted @code{NULL} as sentinel. When
2409 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2410 to @code{__null}. Although it is a null pointer constant not a null pointer,
2411 it is guaranteed to be of the same size as a pointer. But this use is
2412 not portable across different compilers.
2413
2414 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2415 @opindex Wno-non-template-friend
2416 @opindex Wnon-template-friend
2417 Disable warnings when non-templatized friend functions are declared
2418 within a template. Since the advent of explicit template specification
2419 support in G++, if the name of the friend is an unqualified-id (i.e.,
2420 @samp{friend foo(int)}), the C++ language specification demands that the
2421 friend declare or define an ordinary, nontemplate function. (Section
2422 14.5.3). Before G++ implemented explicit specification, unqualified-ids
2423 could be interpreted as a particular specialization of a templatized
2424 function. Because this non-conforming behavior is no longer the default
2425 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2426 check existing code for potential trouble spots and is on by default.
2427 This new compiler behavior can be turned off with
2428 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2429 but disables the helpful warning.
2430
2431 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2432 @opindex Wold-style-cast
2433 @opindex Wno-old-style-cast
2434 Warn if an old-style (C-style) cast to a non-void type is used within
2435 a C++ program. The new-style casts (@samp{dynamic_cast},
2436 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2437 less vulnerable to unintended effects and much easier to search for.
2438
2439 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2440 @opindex Woverloaded-virtual
2441 @opindex Wno-overloaded-virtual
2442 @cindex overloaded virtual function, warning
2443 @cindex warning for overloaded virtual function
2444 Warn when a function declaration hides virtual functions from a
2445 base class. For example, in:
2446
2447 @smallexample
2448 struct A @{
2449 virtual void f();
2450 @};
2451
2452 struct B: public A @{
2453 void f(int);
2454 @};
2455 @end smallexample
2456
2457 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2458 like:
2459
2460 @smallexample
2461 B* b;
2462 b->f();
2463 @end smallexample
2464
2465 will fail to compile.
2466
2467 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2468 @opindex Wno-pmf-conversions
2469 @opindex Wpmf-conversions
2470 Disable the diagnostic for converting a bound pointer to member function
2471 to a plain pointer.
2472
2473 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2474 @opindex Wsign-promo
2475 @opindex Wno-sign-promo
2476 Warn when overload resolution chooses a promotion from unsigned or
2477 enumerated type to a signed type, over a conversion to an unsigned type of
2478 the same size. Previous versions of G++ would try to preserve
2479 unsignedness, but the standard mandates the current behavior.
2480
2481 @smallexample
2482 struct A @{
2483 operator int ();
2484 A& operator = (int);
2485 @};
2486
2487 main ()
2488 @{
2489 A a,b;
2490 a = b;
2491 @}
2492 @end smallexample
2493
2494 In this example, G++ will synthesize a default @samp{A& operator =
2495 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2496 @end table
2497
2498 @node Objective-C and Objective-C++ Dialect Options
2499 @section Options Controlling Objective-C and Objective-C++ Dialects
2500
2501 @cindex compiler options, Objective-C and Objective-C++
2502 @cindex Objective-C and Objective-C++ options, command line
2503 @cindex options, Objective-C and Objective-C++
2504 (NOTE: This manual does not describe the Objective-C and Objective-C++
2505 languages themselves. See @xref{Standards,,Language Standards
2506 Supported by GCC}, for references.)
2507
2508 This section describes the command-line options that are only meaningful
2509 for Objective-C and Objective-C++ programs, but you can also use most of
2510 the language-independent GNU compiler options.
2511 For example, you might compile a file @code{some_class.m} like this:
2512
2513 @smallexample
2514 gcc -g -fgnu-runtime -O -c some_class.m
2515 @end smallexample
2516
2517 @noindent
2518 In this example, @option{-fgnu-runtime} is an option meant only for
2519 Objective-C and Objective-C++ programs; you can use the other options with
2520 any language supported by GCC@.
2521
2522 Note that since Objective-C is an extension of the C language, Objective-C
2523 compilations may also use options specific to the C front-end (e.g.,
2524 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
2525 C++-specific options (e.g., @option{-Wabi}).
2526
2527 Here is a list of options that are @emph{only} for compiling Objective-C
2528 and Objective-C++ programs:
2529
2530 @table @gcctabopt
2531 @item -fconstant-string-class=@var{class-name}
2532 @opindex fconstant-string-class
2533 Use @var{class-name} as the name of the class to instantiate for each
2534 literal string specified with the syntax @code{@@"@dots{}"}. The default
2535 class name is @code{NXConstantString} if the GNU runtime is being used, and
2536 @code{NSConstantString} if the NeXT runtime is being used (see below). The
2537 @option{-fconstant-cfstrings} option, if also present, will override the
2538 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2539 to be laid out as constant CoreFoundation strings.
2540
2541 @item -fgnu-runtime
2542 @opindex fgnu-runtime
2543 Generate object code compatible with the standard GNU Objective-C
2544 runtime. This is the default for most types of systems.
2545
2546 @item -fnext-runtime
2547 @opindex fnext-runtime
2548 Generate output compatible with the NeXT runtime. This is the default
2549 for NeXT-based systems, including Darwin and Mac OS X@. The macro
2550 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2551 used.
2552
2553 @item -fno-nil-receivers
2554 @opindex fno-nil-receivers
2555 Assume that all Objective-C message dispatches (@code{[receiver
2556 message:arg]}) in this translation unit ensure that the receiver is
2557 not @code{nil}. This allows for more efficient entry points in the
2558 runtime to be used. Currently, this option is only available in
2559 conjunction with the NeXT runtime on Mac OS X 10.3 and later.
2560
2561 @item -fobjc-call-cxx-cdtors
2562 @opindex fobjc-call-cxx-cdtors
2563 For each Objective-C class, check if any of its instance variables is a
2564 C++ object with a non-trivial default constructor. If so, synthesize a
2565 special @code{- (id) .cxx_construct} instance method that will run
2566 non-trivial default constructors on any such instance variables, in order,
2567 and then return @code{self}. Similarly, check if any instance variable
2568 is a C++ object with a non-trivial destructor, and if so, synthesize a
2569 special @code{- (void) .cxx_destruct} method that will run
2570 all such default destructors, in reverse order.
2571
2572 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2573 methods thusly generated will only operate on instance variables
2574 declared in the current Objective-C class, and not those inherited
2575 from superclasses. It is the responsibility of the Objective-C
2576 runtime to invoke all such methods in an object's inheritance
2577 hierarchy. The @code{- (id) .cxx_construct} methods will be invoked
2578 by the runtime immediately after a new object instance is allocated;
2579 the @code{- (void) .cxx_destruct} methods will be invoked immediately
2580 before the runtime deallocates an object instance.
2581
2582 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2583 support for invoking the @code{- (id) .cxx_construct} and
2584 @code{- (void) .cxx_destruct} methods.
2585
2586 @item -fobjc-direct-dispatch
2587 @opindex fobjc-direct-dispatch
2588 Allow fast jumps to the message dispatcher. On Darwin this is
2589 accomplished via the comm page.
2590
2591 @item -fobjc-exceptions
2592 @opindex fobjc-exceptions
2593 Enable syntactic support for structured exception handling in
2594 Objective-C, similar to what is offered by C++ and Java. This option
2595 is required to use the Objective-C keywords @code{@@try},
2596 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2597 @code{@@synchronized}. This option is available with both the GNU
2598 runtime and the NeXT runtime (but not available in conjunction with
2599 the NeXT runtime on Mac OS X 10.2 and earlier).
2600
2601 @item -fobjc-gc
2602 @opindex fobjc-gc
2603 Enable garbage collection (GC) in Objective-C and Objective-C++
2604 programs. This option is only available with the NeXT runtime; the
2605 GNU runtime has a different garbage collection implementation that
2606 does not require special compiler flags.
2607
2608 @item -fobjc-std=objc1
2609 @opindex fobjc-std
2610 Conform to the language syntax of Objective-C 1.0, the language
2611 recognized by GCC 4.0. This only affects the Objective-C additions to
2612 the C/C++ language; it does not affect conformance to C/C++ standards,
2613 which is controlled by the separate C/C++ dialect option flags. When
2614 this option is used with the Objective-C or Objective-C++ compiler,
2615 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2616 This is useful if you need to make sure that your Objective-C code can
2617 be compiled with older versions of GCC.
2618
2619 @item -freplace-objc-classes
2620 @opindex freplace-objc-classes
2621 Emit a special marker instructing @command{ld(1)} not to statically link in
2622 the resulting object file, and allow @command{dyld(1)} to load it in at
2623 run time instead. This is used in conjunction with the Fix-and-Continue
2624 debugging mode, where the object file in question may be recompiled and
2625 dynamically reloaded in the course of program execution, without the need
2626 to restart the program itself. Currently, Fix-and-Continue functionality
2627 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2628 and later.
2629
2630 @item -fzero-link
2631 @opindex fzero-link
2632 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2633 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2634 compile time) with static class references that get initialized at load time,
2635 which improves run-time performance. Specifying the @option{-fzero-link} flag
2636 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2637 to be retained. This is useful in Zero-Link debugging mode, since it allows
2638 for individual class implementations to be modified during program execution.
2639 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2640 regardless of command line options.
2641
2642 @item -gen-decls
2643 @opindex gen-decls
2644 Dump interface declarations for all classes seen in the source file to a
2645 file named @file{@var{sourcename}.decl}.
2646
2647 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2648 @opindex Wassign-intercept
2649 @opindex Wno-assign-intercept
2650 Warn whenever an Objective-C assignment is being intercepted by the
2651 garbage collector.
2652
2653 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2654 @opindex Wno-protocol
2655 @opindex Wprotocol
2656 If a class is declared to implement a protocol, a warning is issued for
2657 every method in the protocol that is not implemented by the class. The
2658 default behavior is to issue a warning for every method not explicitly
2659 implemented in the class, even if a method implementation is inherited
2660 from the superclass. If you use the @option{-Wno-protocol} option, then
2661 methods inherited from the superclass are considered to be implemented,
2662 and no warning is issued for them.
2663
2664 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2665 @opindex Wselector
2666 @opindex Wno-selector
2667 Warn if multiple methods of different types for the same selector are
2668 found during compilation. The check is performed on the list of methods
2669 in the final stage of compilation. Additionally, a check is performed
2670 for each selector appearing in a @code{@@selector(@dots{})}
2671 expression, and a corresponding method for that selector has been found
2672 during compilation. Because these checks scan the method table only at
2673 the end of compilation, these warnings are not produced if the final
2674 stage of compilation is not reached, for example because an error is
2675 found during compilation, or because the @option{-fsyntax-only} option is
2676 being used.
2677
2678 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2679 @opindex Wstrict-selector-match
2680 @opindex Wno-strict-selector-match
2681 Warn if multiple methods with differing argument and/or return types are
2682 found for a given selector when attempting to send a message using this
2683 selector to a receiver of type @code{id} or @code{Class}. When this flag
2684 is off (which is the default behavior), the compiler will omit such warnings
2685 if any differences found are confined to types which share the same size
2686 and alignment.
2687
2688 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2689 @opindex Wundeclared-selector
2690 @opindex Wno-undeclared-selector
2691 Warn if a @code{@@selector(@dots{})} expression referring to an
2692 undeclared selector is found. A selector is considered undeclared if no
2693 method with that name has been declared before the
2694 @code{@@selector(@dots{})} expression, either explicitly in an
2695 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2696 an @code{@@implementation} section. This option always performs its
2697 checks as soon as a @code{@@selector(@dots{})} expression is found,
2698 while @option{-Wselector} only performs its checks in the final stage of
2699 compilation. This also enforces the coding style convention
2700 that methods and selectors must be declared before being used.
2701
2702 @item -print-objc-runtime-info
2703 @opindex print-objc-runtime-info
2704 Generate C header describing the largest structure that is passed by
2705 value, if any.
2706
2707 @end table
2708
2709 @node Language Independent Options
2710 @section Options to Control Diagnostic Messages Formatting
2711 @cindex options to control diagnostics formatting
2712 @cindex diagnostic messages
2713 @cindex message formatting
2714
2715 Traditionally, diagnostic messages have been formatted irrespective of
2716 the output device's aspect (e.g.@: its width, @dots{}). The options described
2717 below can be used to control the diagnostic messages formatting
2718 algorithm, e.g.@: how many characters per line, how often source location
2719 information should be reported. Right now, only the C++ front end can
2720 honor these options. However it is expected, in the near future, that
2721 the remaining front ends would be able to digest them correctly.
2722
2723 @table @gcctabopt
2724 @item -fmessage-length=@var{n}
2725 @opindex fmessage-length
2726 Try to format error messages so that they fit on lines of about @var{n}
2727 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2728 the front ends supported by GCC@. If @var{n} is zero, then no
2729 line-wrapping will be done; each error message will appear on a single
2730 line.
2731
2732 @opindex fdiagnostics-show-location
2733 @item -fdiagnostics-show-location=once
2734 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2735 reporter to emit @emph{once} source location information; that is, in
2736 case the message is too long to fit on a single physical line and has to
2737 be wrapped, the source location won't be emitted (as prefix) again,
2738 over and over, in subsequent continuation lines. This is the default
2739 behavior.
2740
2741 @item -fdiagnostics-show-location=every-line
2742 Only meaningful in line-wrapping mode. Instructs the diagnostic
2743 messages reporter to emit the same source location information (as
2744 prefix) for physical lines that result from the process of breaking
2745 a message which is too long to fit on a single line.
2746
2747 @item -fdiagnostics-show-option
2748 @opindex fdiagnostics-show-option
2749 This option instructs the diagnostic machinery to add text to each
2750 diagnostic emitted, which indicates which command line option directly
2751 controls that diagnostic, when such an option is known to the
2752 diagnostic machinery.
2753
2754 @item -Wcoverage-mismatch
2755 @opindex Wcoverage-mismatch
2756 Warn if feedback profiles do not match when using the
2757 @option{-fprofile-use} option.
2758 If a source file was changed between @option{-fprofile-gen} and
2759 @option{-fprofile-use}, the files with the profile feedback can fail
2760 to match the source file and GCC can not use the profile feedback
2761 information. By default, this warning is enabled and is treated as an
2762 error. @option{-Wno-coverage-mismatch} can be used to disable the
2763 warning or @option{-Wno-error=coverage-mismatch} can be used to
2764 disable the error. Disable the error for this warning can result in
2765 poorly optimized code, so disabling the error is useful only in the
2766 case of very minor changes such as bug fixes to an existing code-base.
2767 Completely disabling the warning is not recommended.
2768
2769 @end table
2770
2771 @node Warning Options
2772 @section Options to Request or Suppress Warnings
2773 @cindex options to control warnings
2774 @cindex warning messages
2775 @cindex messages, warning
2776 @cindex suppressing warnings
2777
2778 Warnings are diagnostic messages that report constructions which
2779 are not inherently erroneous but which are risky or suggest there
2780 may have been an error.
2781
2782 The following language-independent options do not enable specific
2783 warnings but control the kinds of diagnostics produced by GCC.
2784
2785 @table @gcctabopt
2786 @cindex syntax checking
2787 @item -fsyntax-only
2788 @opindex fsyntax-only
2789 Check the code for syntax errors, but don't do anything beyond that.
2790
2791 @item -fmax-errors=@var{n}
2792 @opindex fmax-errors
2793 Limits the maximum number of error messages to @var{n}, at which point
2794 GCC bails out rather than attempting to continue processing the source
2795 code. If @var{n} is 0 (the default), there is no limit on the number
2796 of error messages produced. If @option{-Wfatal-errors} is also
2797 specified, then @option{-Wfatal-errors} takes precedence over this
2798 option.
2799
2800 @item -w
2801 @opindex w
2802 Inhibit all warning messages.
2803
2804 @item -Werror
2805 @opindex Werror
2806 @opindex Wno-error
2807 Make all warnings into errors.
2808
2809 @item -Werror=
2810 @opindex Werror=
2811 @opindex Wno-error=
2812 Make the specified warning into an error. The specifier for a warning
2813 is appended, for example @option{-Werror=switch} turns the warnings
2814 controlled by @option{-Wswitch} into errors. This switch takes a
2815 negative form, to be used to negate @option{-Werror} for specific
2816 warnings, for example @option{-Wno-error=switch} makes
2817 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2818 is in effect. You can use the @option{-fdiagnostics-show-option}
2819 option to have each controllable warning amended with the option which
2820 controls it, to determine what to use with this option.
2821
2822 Note that specifying @option{-Werror=}@var{foo} automatically implies
2823 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
2824 imply anything.
2825
2826 @item -Wfatal-errors
2827 @opindex Wfatal-errors
2828 @opindex Wno-fatal-errors
2829 This option causes the compiler to abort compilation on the first error
2830 occurred rather than trying to keep going and printing further error
2831 messages.
2832
2833 @end table
2834
2835 You can request many specific warnings with options beginning
2836 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2837 implicit declarations. Each of these specific warning options also
2838 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2839 example, @option{-Wno-implicit}. This manual lists only one of the
2840 two forms, whichever is not the default. For further,
2841 language-specific options also refer to @ref{C++ Dialect Options} and
2842 @ref{Objective-C and Objective-C++ Dialect Options}.
2843
2844 When an unrecognized warning option is requested (e.g.,
2845 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2846 that the option is not recognized. However, if the @option{-Wno-} form
2847 is used, the behavior is slightly different: No diagnostic will be
2848 produced for @option{-Wno-unknown-warning} unless other diagnostics
2849 are being produced. This allows the use of new @option{-Wno-} options
2850 with old compilers, but if something goes wrong, the compiler will
2851 warn that an unrecognized option was used.
2852
2853 @table @gcctabopt
2854 @item -pedantic
2855 @opindex pedantic
2856 Issue all the warnings demanded by strict ISO C and ISO C++;
2857 reject all programs that use forbidden extensions, and some other
2858 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2859 version of the ISO C standard specified by any @option{-std} option used.
2860
2861 Valid ISO C and ISO C++ programs should compile properly with or without
2862 this option (though a rare few will require @option{-ansi} or a
2863 @option{-std} option specifying the required version of ISO C)@. However,
2864 without this option, certain GNU extensions and traditional C and C++
2865 features are supported as well. With this option, they are rejected.
2866
2867 @option{-pedantic} does not cause warning messages for use of the
2868 alternate keywords whose names begin and end with @samp{__}. Pedantic
2869 warnings are also disabled in the expression that follows
2870 @code{__extension__}. However, only system header files should use
2871 these escape routes; application programs should avoid them.
2872 @xref{Alternate Keywords}.
2873
2874 Some users try to use @option{-pedantic} to check programs for strict ISO
2875 C conformance. They soon find that it does not do quite what they want:
2876 it finds some non-ISO practices, but not all---only those for which
2877 ISO C @emph{requires} a diagnostic, and some others for which
2878 diagnostics have been added.
2879
2880 A feature to report any failure to conform to ISO C might be useful in
2881 some instances, but would require considerable additional work and would
2882 be quite different from @option{-pedantic}. We don't have plans to
2883 support such a feature in the near future.
2884
2885 Where the standard specified with @option{-std} represents a GNU
2886 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2887 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2888 extended dialect is based. Warnings from @option{-pedantic} are given
2889 where they are required by the base standard. (It would not make sense
2890 for such warnings to be given only for features not in the specified GNU
2891 C dialect, since by definition the GNU dialects of C include all
2892 features the compiler supports with the given option, and there would be
2893 nothing to warn about.)
2894
2895 @item -pedantic-errors
2896 @opindex pedantic-errors
2897 Like @option{-pedantic}, except that errors are produced rather than
2898 warnings.
2899
2900 @item -Wall
2901 @opindex Wall
2902 @opindex Wno-all
2903 This enables all the warnings about constructions that some users
2904 consider questionable, and that are easy to avoid (or modify to
2905 prevent the warning), even in conjunction with macros. This also
2906 enables some language-specific warnings described in @ref{C++ Dialect
2907 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2908
2909 @option{-Wall} turns on the following warning flags:
2910
2911 @gccoptlist{-Waddress @gol
2912 -Warray-bounds @r{(only with} @option{-O2}@r{)} @gol
2913 -Wc++0x-compat @gol
2914 -Wchar-subscripts @gol
2915 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2916 -Wimplicit-int @r{(C and Objective-C only)} @gol
2917 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
2918 -Wcomment @gol
2919 -Wformat @gol
2920 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} @gol
2921 -Wmissing-braces @gol
2922 -Wnonnull @gol
2923 -Wparentheses @gol
2924 -Wpointer-sign @gol
2925 -Wreorder @gol
2926 -Wreturn-type @gol
2927 -Wsequence-point @gol
2928 -Wsign-compare @r{(only in C++)} @gol
2929 -Wstrict-aliasing @gol
2930 -Wstrict-overflow=1 @gol
2931 -Wswitch @gol
2932 -Wtrigraphs @gol
2933 -Wuninitialized @gol
2934 -Wunknown-pragmas @gol
2935 -Wunused-function @gol
2936 -Wunused-label @gol
2937 -Wunused-value @gol
2938 -Wunused-variable @gol
2939 -Wvolatile-register-var @gol
2940 }
2941
2942 Note that some warning flags are not implied by @option{-Wall}. Some of
2943 them warn about constructions that users generally do not consider
2944 questionable, but which occasionally you might wish to check for;
2945 others warn about constructions that are necessary or hard to avoid in
2946 some cases, and there is no simple way to modify the code to suppress
2947 the warning. Some of them are enabled by @option{-Wextra} but many of
2948 them must be enabled individually.
2949
2950 @item -Wextra
2951 @opindex W
2952 @opindex Wextra
2953 @opindex Wno-extra
2954 This enables some extra warning flags that are not enabled by
2955 @option{-Wall}. (This option used to be called @option{-W}. The older
2956 name is still supported, but the newer name is more descriptive.)
2957
2958 @gccoptlist{-Wclobbered @gol
2959 -Wempty-body @gol
2960 -Wignored-qualifiers @gol
2961 -Wmissing-field-initializers @gol
2962 -Wmissing-parameter-type @r{(C only)} @gol
2963 -Wold-style-declaration @r{(C only)} @gol
2964 -Woverride-init @gol
2965 -Wsign-compare @gol
2966 -Wtype-limits @gol
2967 -Wuninitialized @gol
2968 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2969 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2970 }
2971
2972 The option @option{-Wextra} also prints warning messages for the
2973 following cases:
2974
2975 @itemize @bullet
2976
2977 @item
2978 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2979 @samp{>}, or @samp{>=}.
2980
2981 @item
2982 (C++ only) An enumerator and a non-enumerator both appear in a
2983 conditional expression.
2984
2985 @item
2986 (C++ only) Ambiguous virtual bases.
2987
2988 @item
2989 (C++ only) Subscripting an array which has been declared @samp{register}.
2990
2991 @item
2992 (C++ only) Taking the address of a variable which has been declared
2993 @samp{register}.
2994
2995 @item
2996 (C++ only) A base class is not initialized in a derived class' copy
2997 constructor.
2998
2999 @end itemize
3000
3001 @item -Wchar-subscripts
3002 @opindex Wchar-subscripts
3003 @opindex Wno-char-subscripts
3004 Warn if an array subscript has type @code{char}. This is a common cause
3005 of error, as programmers often forget that this type is signed on some
3006 machines.
3007 This warning is enabled by @option{-Wall}.
3008
3009 @item -Wcomment
3010 @opindex Wcomment
3011 @opindex Wno-comment
3012 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3013 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3014 This warning is enabled by @option{-Wall}.
3015
3016 @item -Wno-cpp \
3017 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3018
3019 Suppress warning messages emitted by @code{#warning} directives.
3020
3021 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3022 @opindex Wdouble-promotion
3023 @opindex Wno-double-promotion
3024 Give a warning when a value of type @code{float} is implicitly
3025 promoted to @code{double}. CPUs with a 32-bit ``single-precision''
3026 floating-point unit implement @code{float} in hardware, but emulate
3027 @code{double} in software. On such a machine, doing computations
3028 using @code{double} values is much more expensive because of the
3029 overhead required for software emulation.
3030
3031 It is easy to accidentally do computations with @code{double} because
3032 floating-point literals are implicitly of type @code{double}. For
3033 example, in:
3034 @smallexample
3035 @group
3036 float area(float radius)
3037 @{
3038 return 3.14159 * radius * radius;
3039 @}
3040 @end group
3041 @end smallexample
3042 the compiler will perform the entire computation with @code{double}
3043 because the floating-point literal is a @code{double}.
3044
3045 @item -Wformat
3046 @opindex Wformat
3047 @opindex Wno-format
3048 @opindex ffreestanding
3049 @opindex fno-builtin
3050 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3051 the arguments supplied have types appropriate to the format string
3052 specified, and that the conversions specified in the format string make
3053 sense. This includes standard functions, and others specified by format
3054 attributes (@pxref{Function Attributes}), in the @code{printf},
3055 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3056 not in the C standard) families (or other target-specific families).
3057 Which functions are checked without format attributes having been
3058 specified depends on the standard version selected, and such checks of
3059 functions without the attribute specified are disabled by
3060 @option{-ffreestanding} or @option{-fno-builtin}.
3061
3062 The formats are checked against the format features supported by GNU
3063 libc version 2.2. These include all ISO C90 and C99 features, as well
3064 as features from the Single Unix Specification and some BSD and GNU
3065 extensions. Other library implementations may not support all these
3066 features; GCC does not support warning about features that go beyond a
3067 particular library's limitations. However, if @option{-pedantic} is used
3068 with @option{-Wformat}, warnings will be given about format features not
3069 in the selected standard version (but not for @code{strfmon} formats,
3070 since those are not in any version of the C standard). @xref{C Dialect
3071 Options,,Options Controlling C Dialect}.
3072
3073 Since @option{-Wformat} also checks for null format arguments for
3074 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3075
3076 @option{-Wformat} is included in @option{-Wall}. For more control over some
3077 aspects of format checking, the options @option{-Wformat-y2k},
3078 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3079 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3080 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3081
3082 @item -Wformat-y2k
3083 @opindex Wformat-y2k
3084 @opindex Wno-format-y2k
3085 If @option{-Wformat} is specified, also warn about @code{strftime}
3086 formats which may yield only a two-digit year.
3087
3088 @item -Wno-format-contains-nul
3089 @opindex Wno-format-contains-nul
3090 @opindex Wformat-contains-nul
3091 If @option{-Wformat} is specified, do not warn about format strings that
3092 contain NUL bytes.
3093
3094 @item -Wno-format-extra-args
3095 @opindex Wno-format-extra-args
3096 @opindex Wformat-extra-args
3097 If @option{-Wformat} is specified, do not warn about excess arguments to a
3098 @code{printf} or @code{scanf} format function. The C standard specifies
3099 that such arguments are ignored.
3100
3101 Where the unused arguments lie between used arguments that are
3102 specified with @samp{$} operand number specifications, normally
3103 warnings are still given, since the implementation could not know what
3104 type to pass to @code{va_arg} to skip the unused arguments. However,
3105 in the case of @code{scanf} formats, this option will suppress the
3106 warning if the unused arguments are all pointers, since the Single
3107 Unix Specification says that such unused arguments are allowed.
3108
3109 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3110 @opindex Wno-format-zero-length
3111 @opindex Wformat-zero-length
3112 If @option{-Wformat} is specified, do not warn about zero-length formats.
3113 The C standard specifies that zero-length formats are allowed.
3114
3115 @item -Wformat-nonliteral
3116 @opindex Wformat-nonliteral
3117 @opindex Wno-format-nonliteral
3118 If @option{-Wformat} is specified, also warn if the format string is not a
3119 string literal and so cannot be checked, unless the format function
3120 takes its format arguments as a @code{va_list}.
3121
3122 @item -Wformat-security
3123 @opindex Wformat-security
3124 @opindex Wno-format-security
3125 If @option{-Wformat} is specified, also warn about uses of format
3126 functions that represent possible security problems. At present, this
3127 warns about calls to @code{printf} and @code{scanf} functions where the
3128 format string is not a string literal and there are no format arguments,
3129 as in @code{printf (foo);}. This may be a security hole if the format
3130 string came from untrusted input and contains @samp{%n}. (This is
3131 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3132 in future warnings may be added to @option{-Wformat-security} that are not
3133 included in @option{-Wformat-nonliteral}.)
3134
3135 @item -Wformat=2
3136 @opindex Wformat=2
3137 @opindex Wno-format=2
3138 Enable @option{-Wformat} plus format checks not included in
3139 @option{-Wformat}. Currently equivalent to @samp{-Wformat
3140 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3141
3142 @item -Wnonnull @r{(C and Objective-C only)}
3143 @opindex Wnonnull
3144 @opindex Wno-nonnull
3145 Warn about passing a null pointer for arguments marked as
3146 requiring a non-null value by the @code{nonnull} function attribute.
3147
3148 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
3149 can be disabled with the @option{-Wno-nonnull} option.
3150
3151 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3152 @opindex Winit-self
3153 @opindex Wno-init-self
3154 Warn about uninitialized variables which are initialized with themselves.
3155 Note this option can only be used with the @option{-Wuninitialized} option.
3156
3157 For example, GCC will warn about @code{i} being uninitialized in the
3158 following snippet only when @option{-Winit-self} has been specified:
3159 @smallexample
3160 @group
3161 int f()
3162 @{
3163 int i = i;
3164 return i;
3165 @}
3166 @end group
3167 @end smallexample
3168
3169 @item -Wimplicit-int @r{(C and Objective-C only)}
3170 @opindex Wimplicit-int
3171 @opindex Wno-implicit-int
3172 Warn when a declaration does not specify a type.
3173 This warning is enabled by @option{-Wall}.
3174
3175 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3176 @opindex Wimplicit-function-declaration
3177 @opindex Wno-implicit-function-declaration
3178 Give a warning whenever a function is used before being declared. In
3179 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3180 enabled by default and it is made into an error by
3181 @option{-pedantic-errors}. This warning is also enabled by
3182 @option{-Wall}.
3183
3184 @item -Wimplicit @r{(C and Objective-C only)}
3185 @opindex Wimplicit
3186 @opindex Wno-implicit
3187 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3188 This warning is enabled by @option{-Wall}.
3189
3190 @item -Wignored-qualifiers @r{(C and C++ only)}
3191 @opindex Wignored-qualifiers
3192 @opindex Wno-ignored-qualifiers
3193 Warn if the return type of a function has a type qualifier
3194 such as @code{const}. For ISO C such a type qualifier has no effect,
3195 since the value returned by a function is not an lvalue.
3196 For C++, the warning is only emitted for scalar types or @code{void}.
3197 ISO C prohibits qualified @code{void} return types on function
3198 definitions, so such return types always receive a warning
3199 even without this option.
3200
3201 This warning is also enabled by @option{-Wextra}.
3202
3203 @item -Wmain
3204 @opindex Wmain
3205 @opindex Wno-main
3206 Warn if the type of @samp{main} is suspicious. @samp{main} should be
3207 a function with external linkage, returning int, taking either zero
3208 arguments, two, or three arguments of appropriate types. This warning
3209 is enabled by default in C++ and is enabled by either @option{-Wall}
3210 or @option{-pedantic}.
3211
3212 @item -Wmissing-braces
3213 @opindex Wmissing-braces
3214 @opindex Wno-missing-braces
3215 Warn if an aggregate or union initializer is not fully bracketed. In
3216 the following example, the initializer for @samp{a} is not fully
3217 bracketed, but that for @samp{b} is fully bracketed.
3218
3219 @smallexample
3220 int a[2][2] = @{ 0, 1, 2, 3 @};
3221 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3222 @end smallexample
3223
3224 This warning is enabled by @option{-Wall}.
3225
3226 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3227 @opindex Wmissing-include-dirs
3228 @opindex Wno-missing-include-dirs
3229 Warn if a user-supplied include directory does not exist.
3230
3231 @item -Wparentheses
3232 @opindex Wparentheses
3233 @opindex Wno-parentheses
3234 Warn if parentheses are omitted in certain contexts, such
3235 as when there is an assignment in a context where a truth value
3236 is expected, or when operators are nested whose precedence people
3237 often get confused about.
3238
3239 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3240 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3241 interpretation from that of ordinary mathematical notation.
3242
3243 Also warn about constructions where there may be confusion to which
3244 @code{if} statement an @code{else} branch belongs. Here is an example of
3245 such a case:
3246
3247 @smallexample
3248 @group
3249 @{
3250 if (a)
3251 if (b)
3252 foo ();
3253 else
3254 bar ();
3255 @}
3256 @end group
3257 @end smallexample
3258
3259 In C/C++, every @code{else} branch belongs to the innermost possible
3260 @code{if} statement, which in this example is @code{if (b)}. This is
3261 often not what the programmer expected, as illustrated in the above
3262 example by indentation the programmer chose. When there is the
3263 potential for this confusion, GCC will issue a warning when this flag
3264 is specified. To eliminate the warning, add explicit braces around
3265 the innermost @code{if} statement so there is no way the @code{else}
3266 could belong to the enclosing @code{if}. The resulting code would
3267 look like this:
3268
3269 @smallexample
3270 @group
3271 @{
3272 if (a)
3273 @{
3274 if (b)
3275 foo ();
3276 else
3277 bar ();
3278 @}
3279 @}
3280 @end group
3281 @end smallexample
3282
3283 Also warn for dangerous uses of the
3284 ?: with omitted middle operand GNU extension. When the condition
3285 in the ?: operator is a boolean expression the omitted value will
3286 be always 1. Often the user expects it to be a value computed
3287 inside the conditional expression instead.
3288
3289 This warning is enabled by @option{-Wall}.
3290
3291 @item -Wsequence-point
3292 @opindex Wsequence-point
3293 @opindex Wno-sequence-point
3294 Warn about code that may have undefined semantics because of violations
3295 of sequence point rules in the C and C++ standards.
3296
3297 The C and C++ standards defines the order in which expressions in a C/C++
3298 program are evaluated in terms of @dfn{sequence points}, which represent
3299 a partial ordering between the execution of parts of the program: those
3300 executed before the sequence point, and those executed after it. These
3301 occur after the evaluation of a full expression (one which is not part
3302 of a larger expression), after the evaluation of the first operand of a
3303 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3304 function is called (but after the evaluation of its arguments and the
3305 expression denoting the called function), and in certain other places.
3306 Other than as expressed by the sequence point rules, the order of
3307 evaluation of subexpressions of an expression is not specified. All
3308 these rules describe only a partial order rather than a total order,
3309 since, for example, if two functions are called within one expression
3310 with no sequence point between them, the order in which the functions
3311 are called is not specified. However, the standards committee have
3312 ruled that function calls do not overlap.
3313
3314 It is not specified when between sequence points modifications to the
3315 values of objects take effect. Programs whose behavior depends on this
3316 have undefined behavior; the C and C++ standards specify that ``Between
3317 the previous and next sequence point an object shall have its stored
3318 value modified at most once by the evaluation of an expression.
3319 Furthermore, the prior value shall be read only to determine the value
3320 to be stored.''. If a program breaks these rules, the results on any
3321 particular implementation are entirely unpredictable.
3322
3323 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3324 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
3325 diagnosed by this option, and it may give an occasional false positive
3326 result, but in general it has been found fairly effective at detecting
3327 this sort of problem in programs.
3328
3329 The standard is worded confusingly, therefore there is some debate
3330 over the precise meaning of the sequence point rules in subtle cases.
3331 Links to discussions of the problem, including proposed formal
3332 definitions, may be found on the GCC readings page, at
3333 @uref{http://gcc.gnu.org/@/readings.html}.
3334
3335 This warning is enabled by @option{-Wall} for C and C++.
3336
3337 @item -Wreturn-type
3338 @opindex Wreturn-type
3339 @opindex Wno-return-type
3340 Warn whenever a function is defined with a return-type that defaults
3341 to @code{int}. Also warn about any @code{return} statement with no
3342 return-value in a function whose return-type is not @code{void}
3343 (falling off the end of the function body is considered returning
3344 without a value), and about a @code{return} statement with an
3345 expression in a function whose return-type is @code{void}.
3346
3347 For C++, a function without return type always produces a diagnostic
3348 message, even when @option{-Wno-return-type} is specified. The only
3349 exceptions are @samp{main} and functions defined in system headers.
3350
3351 This warning is enabled by @option{-Wall}.
3352
3353 @item -Wswitch
3354 @opindex Wswitch
3355 @opindex Wno-switch
3356 Warn whenever a @code{switch} statement has an index of enumerated type
3357 and lacks a @code{case} for one or more of the named codes of that
3358 enumeration. (The presence of a @code{default} label prevents this
3359 warning.) @code{case} labels outside the enumeration range also
3360 provoke warnings when this option is used (even if there is a
3361 @code{default} label).
3362 This warning is enabled by @option{-Wall}.
3363
3364 @item -Wswitch-default
3365 @opindex Wswitch-default
3366 @opindex Wno-switch-default
3367 Warn whenever a @code{switch} statement does not have a @code{default}
3368 case.
3369
3370 @item -Wswitch-enum
3371 @opindex Wswitch-enum
3372 @opindex Wno-switch-enum
3373 Warn whenever a @code{switch} statement has an index of enumerated type
3374 and lacks a @code{case} for one or more of the named codes of that
3375 enumeration. @code{case} labels outside the enumeration range also
3376 provoke warnings when this option is used. The only difference
3377 between @option{-Wswitch} and this option is that this option gives a
3378 warning about an omitted enumeration code even if there is a
3379 @code{default} label.
3380
3381 @item -Wsync-nand @r{(C and C++ only)}
3382 @opindex Wsync-nand
3383 @opindex Wno-sync-nand
3384 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3385 built-in functions are used. These functions changed semantics in GCC 4.4.
3386
3387 @item -Wtrigraphs
3388 @opindex Wtrigraphs
3389 @opindex Wno-trigraphs
3390 Warn if any trigraphs are encountered that might change the meaning of
3391 the program (trigraphs within comments are not warned about).
3392 This warning is enabled by @option{-Wall}.
3393
3394 @item -Wunused-but-set-parameter
3395 @opindex Wunused-but-set-parameter
3396 @opindex Wno-unused-but-set-parameter
3397 Warn whenever a function parameter is assigned to, but otherwise unused
3398 (aside from its declaration).
3399
3400 To suppress this warning use the @samp{unused} attribute
3401 (@pxref{Variable Attributes}).
3402
3403 This warning is also enabled by @option{-Wunused} together with
3404 @option{-Wextra}.
3405
3406 @item -Wunused-but-set-variable
3407 @opindex Wunused-but-set-variable
3408 @opindex Wno-unused-but-set-variable
3409 Warn whenever a local variable is assigned to, but otherwise unused
3410 (aside from its declaration).
3411 This warning is enabled by @option{-Wall}.
3412
3413 To suppress this warning use the @samp{unused} attribute
3414 (@pxref{Variable Attributes}).
3415
3416 This warning is also enabled by @option{-Wunused}, which is enabled
3417 by @option{-Wall}.
3418
3419 @item -Wunused-function
3420 @opindex Wunused-function
3421 @opindex Wno-unused-function
3422 Warn whenever a static function is declared but not defined or a
3423 non-inline static function is unused.
3424 This warning is enabled by @option{-Wall}.
3425
3426 @item -Wunused-label
3427 @opindex Wunused-label
3428 @opindex Wno-unused-label
3429 Warn whenever a label is declared but not used.
3430 This warning is enabled by @option{-Wall}.
3431
3432 To suppress this warning use the @samp{unused} attribute
3433 (@pxref{Variable Attributes}).
3434
3435 @item -Wunused-parameter
3436 @opindex Wunused-parameter
3437 @opindex Wno-unused-parameter
3438 Warn whenever a function parameter is unused aside from its declaration.
3439
3440 To suppress this warning use the @samp{unused} attribute
3441 (@pxref{Variable Attributes}).
3442
3443 @item -Wno-unused-result
3444 @opindex Wunused-result
3445 @opindex Wno-unused-result
3446 Do not warn if a caller of a function marked with attribute
3447 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3448 its return value. The default is @option{-Wunused-result}.
3449
3450 @item -Wunused-variable
3451 @opindex Wunused-variable
3452 @opindex Wno-unused-variable
3453 Warn whenever a local variable or non-constant static variable is unused
3454 aside from its declaration.
3455 This warning is enabled by @option{-Wall}.
3456
3457 To suppress this warning use the @samp{unused} attribute
3458 (@pxref{Variable Attributes}).
3459
3460 @item -Wunused-value
3461 @opindex Wunused-value
3462 @opindex Wno-unused-value
3463 Warn whenever a statement computes a result that is explicitly not
3464 used. To suppress this warning cast the unused expression to
3465 @samp{void}. This includes an expression-statement or the left-hand
3466 side of a comma expression that contains no side effects. For example,
3467 an expression such as @samp{x[i,j]} will cause a warning, while
3468 @samp{x[(void)i,j]} will not.
3469
3470 This warning is enabled by @option{-Wall}.
3471
3472 @item -Wunused
3473 @opindex Wunused
3474 @opindex Wno-unused
3475 All the above @option{-Wunused} options combined.
3476
3477 In order to get a warning about an unused function parameter, you must
3478 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3479 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3480
3481 @item -Wuninitialized
3482 @opindex Wuninitialized
3483 @opindex Wno-uninitialized
3484 Warn if an automatic variable is used without first being initialized
3485 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3486 warn if a non-static reference or non-static @samp{const} member
3487 appears in a class without constructors.
3488
3489 If you want to warn about code which uses the uninitialized value of the
3490 variable in its own initializer, use the @option{-Winit-self} option.
3491
3492 These warnings occur for individual uninitialized or clobbered
3493 elements of structure, union or array variables as well as for
3494 variables which are uninitialized or clobbered as a whole. They do
3495 not occur for variables or elements declared @code{volatile}. Because
3496 these warnings depend on optimization, the exact variables or elements
3497 for which there are warnings will depend on the precise optimization
3498 options and version of GCC used.
3499
3500 Note that there may be no warning about a variable that is used only
3501 to compute a value that itself is never used, because such
3502 computations may be deleted by data flow analysis before the warnings
3503 are printed.
3504
3505 These warnings are made optional because GCC is not smart
3506 enough to see all the reasons why the code might be correct
3507 despite appearing to have an error. Here is one example of how
3508 this can happen:
3509
3510 @smallexample
3511 @group
3512 @{
3513 int x;
3514 switch (y)
3515 @{
3516 case 1: x = 1;
3517 break;
3518 case 2: x = 4;
3519 break;
3520 case 3: x = 5;
3521 @}
3522 foo (x);
3523 @}
3524 @end group
3525 @end smallexample
3526
3527 @noindent
3528 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3529 always initialized, but GCC doesn't know this. Here is
3530 another common case:
3531
3532 @smallexample
3533 @{
3534 int save_y;
3535 if (change_y) save_y = y, y = new_y;
3536 @dots{}
3537 if (change_y) y = save_y;
3538 @}
3539 @end smallexample
3540
3541 @noindent
3542 This has no bug because @code{save_y} is used only if it is set.
3543
3544 @cindex @code{longjmp} warnings
3545 This option also warns when a non-volatile automatic variable might be
3546 changed by a call to @code{longjmp}. These warnings as well are possible
3547 only in optimizing compilation.
3548
3549 The compiler sees only the calls to @code{setjmp}. It cannot know
3550 where @code{longjmp} will be called; in fact, a signal handler could
3551 call it at any point in the code. As a result, you may get a warning
3552 even when there is in fact no problem because @code{longjmp} cannot
3553 in fact be called at the place which would cause a problem.
3554
3555 Some spurious warnings can be avoided if you declare all the functions
3556 you use that never return as @code{noreturn}. @xref{Function
3557 Attributes}.
3558
3559 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3560
3561 @item -Wunknown-pragmas
3562 @opindex Wunknown-pragmas
3563 @opindex Wno-unknown-pragmas
3564 @cindex warning for unknown pragmas
3565 @cindex unknown pragmas, warning
3566 @cindex pragmas, warning of unknown
3567 Warn when a #pragma directive is encountered which is not understood by
3568 GCC@. If this command line option is used, warnings will even be issued
3569 for unknown pragmas in system header files. This is not the case if
3570 the warnings were only enabled by the @option{-Wall} command line option.
3571
3572 @item -Wno-pragmas
3573 @opindex Wno-pragmas
3574 @opindex Wpragmas
3575 Do not warn about misuses of pragmas, such as incorrect parameters,
3576 invalid syntax, or conflicts between pragmas. See also
3577 @samp{-Wunknown-pragmas}.
3578
3579 @item -Wstrict-aliasing
3580 @opindex Wstrict-aliasing
3581 @opindex Wno-strict-aliasing
3582 This option is only active when @option{-fstrict-aliasing} is active.
3583 It warns about code which might break the strict aliasing rules that the
3584 compiler is using for optimization. The warning does not catch all
3585 cases, but does attempt to catch the more common pitfalls. It is
3586 included in @option{-Wall}.
3587 It is equivalent to @option{-Wstrict-aliasing=3}
3588
3589 @item -Wstrict-aliasing=n
3590 @opindex Wstrict-aliasing=n
3591 @opindex Wno-strict-aliasing=n
3592 This option is only active when @option{-fstrict-aliasing} is active.
3593 It warns about code which might break the strict aliasing rules that the
3594 compiler is using for optimization.
3595 Higher levels correspond to higher accuracy (fewer false positives).
3596 Higher levels also correspond to more effort, similar to the way -O works.
3597 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3598 with n=3.
3599
3600 Level 1: Most aggressive, quick, least accurate.
3601 Possibly useful when higher levels
3602 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3603 false negatives. However, it has many false positives.
3604 Warns for all pointer conversions between possibly incompatible types,
3605 even if never dereferenced. Runs in the frontend only.
3606
3607 Level 2: Aggressive, quick, not too precise.
3608 May still have many false positives (not as many as level 1 though),
3609 and few false negatives (but possibly more than level 1).
3610 Unlike level 1, it only warns when an address is taken. Warns about
3611 incomplete types. Runs in the frontend only.
3612
3613 Level 3 (default for @option{-Wstrict-aliasing}):
3614 Should have very few false positives and few false
3615 negatives. Slightly slower than levels 1 or 2 when optimization is enabled.
3616 Takes care of the common pun+dereference pattern in the frontend:
3617 @code{*(int*)&some_float}.
3618 If optimization is enabled, it also runs in the backend, where it deals
3619 with multiple statement cases using flow-sensitive points-to information.
3620 Only warns when the converted pointer is dereferenced.
3621 Does not warn about incomplete types.
3622
3623 @item -Wstrict-overflow
3624 @itemx -Wstrict-overflow=@var{n}
3625 @opindex Wstrict-overflow
3626 @opindex Wno-strict-overflow
3627 This option is only active when @option{-fstrict-overflow} is active.
3628 It warns about cases where the compiler optimizes based on the
3629 assumption that signed overflow does not occur. Note that it does not
3630 warn about all cases where the code might overflow: it only warns
3631 about cases where the compiler implements some optimization. Thus
3632 this warning depends on the optimization level.
3633
3634 An optimization which assumes that signed overflow does not occur is
3635 perfectly safe if the values of the variables involved are such that
3636 overflow never does, in fact, occur. Therefore this warning can
3637 easily give a false positive: a warning about code which is not
3638 actually a problem. To help focus on important issues, several
3639 warning levels are defined. No warnings are issued for the use of
3640 undefined signed overflow when estimating how many iterations a loop
3641 will require, in particular when determining whether a loop will be
3642 executed at all.
3643
3644 @table @gcctabopt
3645 @item -Wstrict-overflow=1
3646 Warn about cases which are both questionable and easy to avoid. For
3647 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3648 compiler will simplify this to @code{1}. This level of
3649 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3650 are not, and must be explicitly requested.
3651
3652 @item -Wstrict-overflow=2
3653 Also warn about other cases where a comparison is simplified to a
3654 constant. For example: @code{abs (x) >= 0}. This can only be
3655 simplified when @option{-fstrict-overflow} is in effect, because
3656 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3657 zero. @option{-Wstrict-overflow} (with no level) is the same as
3658 @option{-Wstrict-overflow=2}.
3659
3660 @item -Wstrict-overflow=3
3661 Also warn about other cases where a comparison is simplified. For
3662 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3663
3664 @item -Wstrict-overflow=4
3665 Also warn about other simplifications not covered by the above cases.
3666 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3667
3668 @item -Wstrict-overflow=5
3669 Also warn about cases where the compiler reduces the magnitude of a
3670 constant involved in a comparison. For example: @code{x + 2 > y} will
3671 be simplified to @code{x + 1 >= y}. This is reported only at the
3672 highest warning level because this simplification applies to many
3673 comparisons, so this warning level will give a very large number of
3674 false positives.
3675 @end table
3676
3677 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3678 @opindex Wsuggest-attribute=
3679 @opindex Wno-suggest-attribute=
3680 Warn for cases where adding an attribute may be beneficial. The
3681 attributes currently supported are listed below.
3682
3683 @table @gcctabopt
3684 @item -Wsuggest-attribute=pure
3685 @itemx -Wsuggest-attribute=const
3686 @itemx -Wsuggest-attribute=noreturn
3687 @opindex Wsuggest-attribute=pure
3688 @opindex Wno-suggest-attribute=pure
3689 @opindex Wsuggest-attribute=const
3690 @opindex Wno-suggest-attribute=const
3691 @opindex Wsuggest-attribute=noreturn
3692 @opindex Wno-suggest-attribute=noreturn
3693
3694 Warn about functions which might be candidates for attributes
3695 @code{pure}, @code{const} or @code{noreturn}. The compiler only warns for
3696 functions visible in other compilation units or (in the case of @code{pure} and
3697 @code{const}) if it cannot prove that the function returns normally. A function
3698 returns normally if it doesn't contain an infinite loop nor returns abnormally
3699 by throwing, calling @code{abort()} or trapping. This analysis requires option
3700 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3701 higher. Higher optimization levels improve the accuracy of the analysis.
3702 @end table
3703
3704 @item -Warray-bounds
3705 @opindex Wno-array-bounds
3706 @opindex Warray-bounds
3707 This option is only active when @option{-ftree-vrp} is active
3708 (default for @option{-O2} and above). It warns about subscripts to arrays
3709 that are always out of bounds. This warning is enabled by @option{-Wall}.
3710
3711 @item -Wno-div-by-zero
3712 @opindex Wno-div-by-zero
3713 @opindex Wdiv-by-zero
3714 Do not warn about compile-time integer division by zero. Floating point
3715 division by zero is not warned about, as it can be a legitimate way of
3716 obtaining infinities and NaNs.
3717
3718 @item -Wsystem-headers
3719 @opindex Wsystem-headers
3720 @opindex Wno-system-headers
3721 @cindex warnings from system headers
3722 @cindex system headers, warnings from
3723 Print warning messages for constructs found in system header files.
3724 Warnings from system headers are normally suppressed, on the assumption
3725 that they usually do not indicate real problems and would only make the
3726 compiler output harder to read. Using this command line option tells
3727 GCC to emit warnings from system headers as if they occurred in user
3728 code. However, note that using @option{-Wall} in conjunction with this
3729 option will @emph{not} warn about unknown pragmas in system
3730 headers---for that, @option{-Wunknown-pragmas} must also be used.
3731
3732 @item -Wtrampolines
3733 @opindex Wtrampolines
3734 @opindex Wno-trampolines
3735 Warn about trampolines generated for pointers to nested functions.
3736
3737 A trampoline is a small piece of data or code that is created at run
3738 time on the stack when the address of a nested function is taken, and
3739 is used to call the nested function indirectly. For some targets, it
3740 is made up of data only and thus requires no special treatment. But,
3741 for most targets, it is made up of code and thus requires the stack
3742 to be made executable in order for the program to work properly.
3743
3744 @item -Wfloat-equal
3745 @opindex Wfloat-equal
3746 @opindex Wno-float-equal
3747 Warn if floating point values are used in equality comparisons.
3748
3749 The idea behind this is that sometimes it is convenient (for the
3750 programmer) to consider floating-point values as approximations to
3751 infinitely precise real numbers. If you are doing this, then you need
3752 to compute (by analyzing the code, or in some other way) the maximum or
3753 likely maximum error that the computation introduces, and allow for it
3754 when performing comparisons (and when producing output, but that's a
3755 different problem). In particular, instead of testing for equality, you
3756 would check to see whether the two values have ranges that overlap; and
3757 this is done with the relational operators, so equality comparisons are
3758 probably mistaken.
3759
3760 @item -Wtraditional @r{(C and Objective-C only)}
3761 @opindex Wtraditional
3762 @opindex Wno-traditional
3763 Warn about certain constructs that behave differently in traditional and
3764 ISO C@. Also warn about ISO C constructs that have no traditional C
3765 equivalent, and/or problematic constructs which should be avoided.
3766
3767 @itemize @bullet
3768 @item
3769 Macro parameters that appear within string literals in the macro body.
3770 In traditional C macro replacement takes place within string literals,
3771 but does not in ISO C@.
3772
3773 @item
3774 In traditional C, some preprocessor directives did not exist.
3775 Traditional preprocessors would only consider a line to be a directive
3776 if the @samp{#} appeared in column 1 on the line. Therefore
3777 @option{-Wtraditional} warns about directives that traditional C
3778 understands but would ignore because the @samp{#} does not appear as the
3779 first character on the line. It also suggests you hide directives like
3780 @samp{#pragma} not understood by traditional C by indenting them. Some
3781 traditional implementations would not recognize @samp{#elif}, so it
3782 suggests avoiding it altogether.
3783
3784 @item
3785 A function-like macro that appears without arguments.
3786
3787 @item
3788 The unary plus operator.
3789
3790 @item
3791 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3792 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
3793 constants.) Note, these suffixes appear in macros defined in the system
3794 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3795 Use of these macros in user code might normally lead to spurious
3796 warnings, however GCC's integrated preprocessor has enough context to
3797 avoid warning in these cases.
3798
3799 @item
3800 A function declared external in one block and then used after the end of
3801 the block.
3802
3803 @item
3804 A @code{switch} statement has an operand of type @code{long}.
3805
3806 @item
3807 A non-@code{static} function declaration follows a @code{static} one.
3808 This construct is not accepted by some traditional C compilers.
3809
3810 @item
3811 The ISO type of an integer constant has a different width or
3812 signedness from its traditional type. This warning is only issued if
3813 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
3814 typically represent bit patterns, are not warned about.
3815
3816 @item
3817 Usage of ISO string concatenation is detected.
3818
3819 @item
3820 Initialization of automatic aggregates.
3821
3822 @item
3823 Identifier conflicts with labels. Traditional C lacks a separate
3824 namespace for labels.
3825
3826 @item
3827 Initialization of unions. If the initializer is zero, the warning is
3828 omitted. This is done under the assumption that the zero initializer in
3829 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3830 initializer warnings and relies on default initialization to zero in the
3831 traditional C case.
3832
3833 @item
3834 Conversions by prototypes between fixed/floating point values and vice
3835 versa. The absence of these prototypes when compiling with traditional
3836 C would cause serious problems. This is a subset of the possible
3837 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3838
3839 @item
3840 Use of ISO C style function definitions. This warning intentionally is
3841 @emph{not} issued for prototype declarations or variadic functions
3842 because these ISO C features will appear in your code when using
3843 libiberty's traditional C compatibility macros, @code{PARAMS} and
3844 @code{VPARAMS}. This warning is also bypassed for nested functions
3845 because that feature is already a GCC extension and thus not relevant to
3846 traditional C compatibility.
3847 @end itemize
3848
3849 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3850 @opindex Wtraditional-conversion
3851 @opindex Wno-traditional-conversion
3852 Warn if a prototype causes a type conversion that is different from what
3853 would happen to the same argument in the absence of a prototype. This
3854 includes conversions of fixed point to floating and vice versa, and
3855 conversions changing the width or signedness of a fixed point argument
3856 except when the same as the default promotion.
3857
3858 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3859 @opindex Wdeclaration-after-statement
3860 @opindex Wno-declaration-after-statement
3861 Warn when a declaration is found after a statement in a block. This
3862 construct, known from C++, was introduced with ISO C99 and is by default
3863 allowed in GCC@. It is not supported by ISO C90 and was not supported by
3864 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
3865
3866 @item -Wundef
3867 @opindex Wundef
3868 @opindex Wno-undef
3869 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3870
3871 @item -Wno-endif-labels
3872 @opindex Wno-endif-labels
3873 @opindex Wendif-labels
3874 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3875
3876 @item -Wshadow
3877 @opindex Wshadow
3878 @opindex Wno-shadow
3879 Warn whenever a local variable or type declaration shadows another variable,
3880 parameter, type, or class member (in C++), or whenever a built-in function
3881 is shadowed. Note that in C++, the compiler will not warn if a local variable
3882 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
3883
3884 @item -Wlarger-than=@var{len}
3885 @opindex Wlarger-than=@var{len}
3886 @opindex Wlarger-than-@var{len}
3887 Warn whenever an object of larger than @var{len} bytes is defined.
3888
3889 @item -Wframe-larger-than=@var{len}
3890 @opindex Wframe-larger-than
3891 Warn if the size of a function frame is larger than @var{len} bytes.
3892 The computation done to determine the stack frame size is approximate
3893 and not conservative.
3894 The actual requirements may be somewhat greater than @var{len}
3895 even if you do not get a warning. In addition, any space allocated
3896 via @code{alloca}, variable-length arrays, or related constructs
3897 is not included by the compiler when determining
3898 whether or not to issue a warning.
3899
3900 @item -Wunsafe-loop-optimizations
3901 @opindex Wunsafe-loop-optimizations
3902 @opindex Wno-unsafe-loop-optimizations
3903 Warn if the loop cannot be optimized because the compiler could not
3904 assume anything on the bounds of the loop indices. With
3905 @option{-funsafe-loop-optimizations} warn if the compiler made
3906 such assumptions.
3907
3908 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3909 @opindex Wno-pedantic-ms-format
3910 @opindex Wpedantic-ms-format
3911 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3912 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3913 depending on the MS runtime, when you are using the options @option{-Wformat}
3914 and @option{-pedantic} without gnu-extensions.
3915
3916 @item -Wpointer-arith
3917 @opindex Wpointer-arith
3918 @opindex Wno-pointer-arith
3919 Warn about anything that depends on the ``size of'' a function type or
3920 of @code{void}. GNU C assigns these types a size of 1, for
3921 convenience in calculations with @code{void *} pointers and pointers
3922 to functions. In C++, warn also when an arithmetic operation involves
3923 @code{NULL}. This warning is also enabled by @option{-pedantic}.
3924
3925 @item -Wtype-limits
3926 @opindex Wtype-limits
3927 @opindex Wno-type-limits
3928 Warn if a comparison is always true or always false due to the limited
3929 range of the data type, but do not warn for constant expressions. For
3930 example, warn if an unsigned variable is compared against zero with
3931 @samp{<} or @samp{>=}. This warning is also enabled by
3932 @option{-Wextra}.
3933
3934 @item -Wbad-function-cast @r{(C and Objective-C only)}
3935 @opindex Wbad-function-cast
3936 @opindex Wno-bad-function-cast
3937 Warn whenever a function call is cast to a non-matching type.
3938 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3939
3940 @item -Wc++-compat @r{(C and Objective-C only)}
3941 Warn about ISO C constructs that are outside of the common subset of
3942 ISO C and ISO C++, e.g.@: request for implicit conversion from
3943 @code{void *} to a pointer to non-@code{void} type.
3944
3945 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3946 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3947 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3948 in ISO C++ 200x. This warning is enabled by @option{-Wall}.
3949
3950 @item -Wcast-qual
3951 @opindex Wcast-qual
3952 @opindex Wno-cast-qual
3953 Warn whenever a pointer is cast so as to remove a type qualifier from
3954 the target type. For example, warn if a @code{const char *} is cast
3955 to an ordinary @code{char *}.
3956
3957 Also warn when making a cast which introduces a type qualifier in an
3958 unsafe way. For example, casting @code{char **} to @code{const char **}
3959 is unsafe, as in this example:
3960
3961 @smallexample
3962 /* p is char ** value. */
3963 const char **q = (const char **) p;
3964 /* Assignment of readonly string to const char * is OK. */
3965 *q = "string";
3966 /* Now char** pointer points to read-only memory. */
3967 **p = 'b';
3968 @end smallexample
3969
3970 @item -Wcast-align
3971 @opindex Wcast-align
3972 @opindex Wno-cast-align
3973 Warn whenever a pointer is cast such that the required alignment of the
3974 target is increased. For example, warn if a @code{char *} is cast to
3975 an @code{int *} on machines where integers can only be accessed at
3976 two- or four-byte boundaries.
3977
3978 @item -Wwrite-strings
3979 @opindex Wwrite-strings
3980 @opindex Wno-write-strings
3981 When compiling C, give string constants the type @code{const
3982 char[@var{length}]} so that copying the address of one into a
3983 non-@code{const} @code{char *} pointer will get a warning. These
3984 warnings will help you find at compile time code that can try to write
3985 into a string constant, but only if you have been very careful about
3986 using @code{const} in declarations and prototypes. Otherwise, it will
3987 just be a nuisance. This is why we did not make @option{-Wall} request
3988 these warnings.
3989
3990 When compiling C++, warn about the deprecated conversion from string
3991 literals to @code{char *}. This warning is enabled by default for C++
3992 programs.
3993
3994 @item -Wclobbered
3995 @opindex Wclobbered
3996 @opindex Wno-clobbered
3997 Warn for variables that might be changed by @samp{longjmp} or
3998 @samp{vfork}. This warning is also enabled by @option{-Wextra}.
3999
4000 @item -Wconversion
4001 @opindex Wconversion
4002 @opindex Wno-conversion
4003 Warn for implicit conversions that may alter a value. This includes
4004 conversions between real and integer, like @code{abs (x)} when
4005 @code{x} is @code{double}; conversions between signed and unsigned,
4006 like @code{unsigned ui = -1}; and conversions to smaller types, like
4007 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4008 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4009 changed by the conversion like in @code{abs (2.0)}. Warnings about
4010 conversions between signed and unsigned integers can be disabled by
4011 using @option{-Wno-sign-conversion}.
4012
4013 For C++, also warn for confusing overload resolution for user-defined
4014 conversions; and conversions that will never use a type conversion
4015 operator: conversions to @code{void}, the same type, a base class or a
4016 reference to them. Warnings about conversions between signed and
4017 unsigned integers are disabled by default in C++ unless
4018 @option{-Wsign-conversion} is explicitly enabled.
4019
4020 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4021 @opindex Wconversion-null
4022 @opindex Wno-conversion-null
4023 Do not warn for conversions between @code{NULL} and non-pointer
4024 types. @option{-Wconversion-null} is enabled by default.
4025
4026 @item -Wempty-body
4027 @opindex Wempty-body
4028 @opindex Wno-empty-body
4029 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4030 while} statement. This warning is also enabled by @option{-Wextra}.
4031
4032 @item -Wenum-compare
4033 @opindex Wenum-compare
4034 @opindex Wno-enum-compare
4035 Warn about a comparison between values of different enum types. In C++
4036 this warning is enabled by default. In C this warning is enabled by
4037 @option{-Wall}.
4038
4039 @item -Wjump-misses-init @r{(C, Objective-C only)}
4040 @opindex Wjump-misses-init
4041 @opindex Wno-jump-misses-init
4042 Warn if a @code{goto} statement or a @code{switch} statement jumps
4043 forward across the initialization of a variable, or jumps backward to a
4044 label after the variable has been initialized. This only warns about
4045 variables which are initialized when they are declared. This warning is
4046 only supported for C and Objective C; in C++ this sort of branch is an
4047 error in any case.
4048
4049 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It
4050 can be disabled with the @option{-Wno-jump-misses-init} option.
4051
4052 @item -Wsign-compare
4053 @opindex Wsign-compare
4054 @opindex Wno-sign-compare
4055 @cindex warning for comparison of signed and unsigned values
4056 @cindex comparison of signed and unsigned values, warning
4057 @cindex signed and unsigned values, comparison warning
4058 Warn when a comparison between signed and unsigned values could produce
4059 an incorrect result when the signed value is converted to unsigned.
4060 This warning is also enabled by @option{-Wextra}; to get the other warnings
4061 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4062
4063 @item -Wsign-conversion
4064 @opindex Wsign-conversion
4065 @opindex Wno-sign-conversion
4066 Warn for implicit conversions that may change the sign of an integer
4067 value, like assigning a signed integer expression to an unsigned
4068 integer variable. An explicit cast silences the warning. In C, this
4069 option is enabled also by @option{-Wconversion}.
4070
4071 @item -Waddress
4072 @opindex Waddress
4073 @opindex Wno-address
4074 Warn about suspicious uses of memory addresses. These include using
4075 the address of a function in a conditional expression, such as
4076 @code{void func(void); if (func)}, and comparisons against the memory
4077 address of a string literal, such as @code{if (x == "abc")}. Such
4078 uses typically indicate a programmer error: the address of a function
4079 always evaluates to true, so their use in a conditional usually
4080 indicate that the programmer forgot the parentheses in a function
4081 call; and comparisons against string literals result in unspecified
4082 behavior and are not portable in C, so they usually indicate that the
4083 programmer intended to use @code{strcmp}. This warning is enabled by
4084 @option{-Wall}.
4085
4086 @item -Wlogical-op
4087 @opindex Wlogical-op
4088 @opindex Wno-logical-op
4089 Warn about suspicious uses of logical operators in expressions.
4090 This includes using logical operators in contexts where a
4091 bit-wise operator is likely to be expected.
4092
4093 @item -Waggregate-return
4094 @opindex Waggregate-return
4095 @opindex Wno-aggregate-return
4096 Warn if any functions that return structures or unions are defined or
4097 called. (In languages where you can return an array, this also elicits
4098 a warning.)
4099
4100 @item -Wno-attributes
4101 @opindex Wno-attributes
4102 @opindex Wattributes
4103 Do not warn if an unexpected @code{__attribute__} is used, such as
4104 unrecognized attributes, function attributes applied to variables,
4105 etc. This will not stop errors for incorrect use of supported
4106 attributes.
4107
4108 @item -Wno-builtin-macro-redefined
4109 @opindex Wno-builtin-macro-redefined
4110 @opindex Wbuiltin-macro-redefined
4111 Do not warn if certain built-in macros are redefined. This suppresses
4112 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4113 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4114
4115 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4116 @opindex Wstrict-prototypes
4117 @opindex Wno-strict-prototypes
4118 Warn if a function is declared or defined without specifying the
4119 argument types. (An old-style function definition is permitted without
4120 a warning if preceded by a declaration which specifies the argument
4121 types.)
4122
4123 @item -Wold-style-declaration @r{(C and Objective-C only)}
4124 @opindex Wold-style-declaration
4125 @opindex Wno-old-style-declaration
4126 Warn for obsolescent usages, according to the C Standard, in a
4127 declaration. For example, warn if storage-class specifiers like
4128 @code{static} are not the first things in a declaration. This warning
4129 is also enabled by @option{-Wextra}.
4130
4131 @item -Wold-style-definition @r{(C and Objective-C only)}
4132 @opindex Wold-style-definition
4133 @opindex Wno-old-style-definition
4134 Warn if an old-style function definition is used. A warning is given
4135 even if there is a previous prototype.
4136
4137 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4138 @opindex Wmissing-parameter-type
4139 @opindex Wno-missing-parameter-type
4140 A function parameter is declared without a type specifier in K&R-style
4141 functions:
4142
4143 @smallexample
4144 void foo(bar) @{ @}
4145 @end smallexample
4146
4147 This warning is also enabled by @option{-Wextra}.
4148
4149 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4150 @opindex Wmissing-prototypes
4151 @opindex Wno-missing-prototypes
4152 Warn if a global function is defined without a previous prototype
4153 declaration. This warning is issued even if the definition itself
4154 provides a prototype. The aim is to detect global functions that fail
4155 to be declared in header files.
4156
4157 @item -Wmissing-declarations
4158 @opindex Wmissing-declarations
4159 @opindex Wno-missing-declarations
4160 Warn if a global function is defined without a previous declaration.
4161 Do so even if the definition itself provides a prototype.
4162 Use this option to detect global functions that are not declared in
4163 header files. In C++, no warnings are issued for function templates,
4164 or for inline functions, or for functions in anonymous namespaces.
4165
4166 @item -Wmissing-field-initializers
4167 @opindex Wmissing-field-initializers
4168 @opindex Wno-missing-field-initializers
4169 @opindex W
4170 @opindex Wextra
4171 @opindex Wno-extra
4172 Warn if a structure's initializer has some fields missing. For
4173 example, the following code would cause such a warning, because
4174 @code{x.h} is implicitly zero:
4175
4176 @smallexample
4177 struct s @{ int f, g, h; @};
4178 struct s x = @{ 3, 4 @};
4179 @end smallexample
4180
4181 This option does not warn about designated initializers, so the following
4182 modification would not trigger a warning:
4183
4184 @smallexample
4185 struct s @{ int f, g, h; @};
4186 struct s x = @{ .f = 3, .g = 4 @};
4187 @end smallexample
4188
4189 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
4190 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4191
4192 @item -Wmissing-format-attribute
4193 @opindex Wmissing-format-attribute
4194 @opindex Wno-missing-format-attribute
4195 @opindex Wformat
4196 @opindex Wno-format
4197 Warn about function pointers which might be candidates for @code{format}
4198 attributes. Note these are only possible candidates, not absolute ones.
4199 GCC will guess that function pointers with @code{format} attributes that
4200 are used in assignment, initialization, parameter passing or return
4201 statements should have a corresponding @code{format} attribute in the
4202 resulting type. I.e.@: the left-hand side of the assignment or
4203 initialization, the type of the parameter variable, or the return type
4204 of the containing function respectively should also have a @code{format}
4205 attribute to avoid the warning.
4206
4207 GCC will also warn about function definitions which might be
4208 candidates for @code{format} attributes. Again, these are only
4209 possible candidates. GCC will guess that @code{format} attributes
4210 might be appropriate for any function that calls a function like
4211 @code{vprintf} or @code{vscanf}, but this might not always be the
4212 case, and some functions for which @code{format} attributes are
4213 appropriate may not be detected.
4214
4215 @item -Wno-multichar
4216 @opindex Wno-multichar
4217 @opindex Wmultichar
4218 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4219 Usually they indicate a typo in the user's code, as they have
4220 implementation-defined values, and should not be used in portable code.
4221
4222 @item -Wnormalized=<none|id|nfc|nfkc>
4223 @opindex Wnormalized=
4224 @cindex NFC
4225 @cindex NFKC
4226 @cindex character set, input normalization
4227 In ISO C and ISO C++, two identifiers are different if they are
4228 different sequences of characters. However, sometimes when characters
4229 outside the basic ASCII character set are used, you can have two
4230 different character sequences that look the same. To avoid confusion,
4231 the ISO 10646 standard sets out some @dfn{normalization rules} which
4232 when applied ensure that two sequences that look the same are turned into
4233 the same sequence. GCC can warn you if you are using identifiers which
4234 have not been normalized; this option controls that warning.
4235
4236 There are four levels of warning that GCC supports. The default is
4237 @option{-Wnormalized=nfc}, which warns about any identifier which is
4238 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
4239 recommended form for most uses.
4240
4241 Unfortunately, there are some characters which ISO C and ISO C++ allow
4242 in identifiers that when turned into NFC aren't allowable as
4243 identifiers. That is, there's no way to use these symbols in portable
4244 ISO C or C++ and have all your identifiers in NFC@.
4245 @option{-Wnormalized=id} suppresses the warning for these characters.
4246 It is hoped that future versions of the standards involved will correct
4247 this, which is why this option is not the default.
4248
4249 You can switch the warning off for all characters by writing
4250 @option{-Wnormalized=none}. You would only want to do this if you
4251 were using some other normalization scheme (like ``D''), because
4252 otherwise you can easily create bugs that are literally impossible to see.
4253
4254 Some characters in ISO 10646 have distinct meanings but look identical
4255 in some fonts or display methodologies, especially once formatting has
4256 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4257 LETTER N'', will display just like a regular @code{n} which has been
4258 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
4259 normalization scheme to convert all these into a standard form as
4260 well, and GCC will warn if your code is not in NFKC if you use
4261 @option{-Wnormalized=nfkc}. This warning is comparable to warning
4262 about every identifier that contains the letter O because it might be
4263 confused with the digit 0, and so is not the default, but may be
4264 useful as a local coding convention if the programming environment is
4265 unable to be fixed to display these characters distinctly.
4266
4267 @item -Wno-deprecated
4268 @opindex Wno-deprecated
4269 @opindex Wdeprecated
4270 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
4271
4272 @item -Wno-deprecated-declarations
4273 @opindex Wno-deprecated-declarations
4274 @opindex Wdeprecated-declarations
4275 Do not warn about uses of functions (@pxref{Function Attributes}),
4276 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4277 Attributes}) marked as deprecated by using the @code{deprecated}
4278 attribute.
4279
4280 @item -Wno-overflow
4281 @opindex Wno-overflow
4282 @opindex Woverflow
4283 Do not warn about compile-time overflow in constant expressions.
4284
4285 @item -Woverride-init @r{(C and Objective-C only)}
4286 @opindex Woverride-init
4287 @opindex Wno-override-init
4288 @opindex W
4289 @opindex Wextra
4290 @opindex Wno-extra
4291 Warn if an initialized field without side effects is overridden when
4292 using designated initializers (@pxref{Designated Inits, , Designated
4293 Initializers}).
4294
4295 This warning is included in @option{-Wextra}. To get other
4296 @option{-Wextra} warnings without this one, use @samp{-Wextra
4297 -Wno-override-init}.
4298
4299 @item -Wpacked
4300 @opindex Wpacked
4301 @opindex Wno-packed
4302 Warn if a structure is given the packed attribute, but the packed
4303 attribute has no effect on the layout or size of the structure.
4304 Such structures may be mis-aligned for little benefit. For
4305 instance, in this code, the variable @code{f.x} in @code{struct bar}
4306 will be misaligned even though @code{struct bar} does not itself
4307 have the packed attribute:
4308
4309 @smallexample
4310 @group
4311 struct foo @{
4312 int x;
4313 char a, b, c, d;
4314 @} __attribute__((packed));
4315 struct bar @{
4316 char z;
4317 struct foo f;
4318 @};
4319 @end group
4320 @end smallexample
4321
4322 @item -Wpacked-bitfield-compat
4323 @opindex Wpacked-bitfield-compat
4324 @opindex Wno-packed-bitfield-compat
4325 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4326 on bit-fields of type @code{char}. This has been fixed in GCC 4.4 but
4327 the change can lead to differences in the structure layout. GCC
4328 informs you when the offset of such a field has changed in GCC 4.4.
4329 For example there is no longer a 4-bit padding between field @code{a}
4330 and @code{b} in this structure:
4331
4332 @smallexample
4333 struct foo
4334 @{
4335 char a:4;
4336 char b:8;
4337 @} __attribute__ ((packed));
4338 @end smallexample
4339
4340 This warning is enabled by default. Use
4341 @option{-Wno-packed-bitfield-compat} to disable this warning.
4342
4343 @item -Wpadded
4344 @opindex Wpadded
4345 @opindex Wno-padded
4346 Warn if padding is included in a structure, either to align an element
4347 of the structure or to align the whole structure. Sometimes when this
4348 happens it is possible to rearrange the fields of the structure to
4349 reduce the padding and so make the structure smaller.
4350
4351 @item -Wredundant-decls
4352 @opindex Wredundant-decls
4353 @opindex Wno-redundant-decls
4354 Warn if anything is declared more than once in the same scope, even in
4355 cases where multiple declaration is valid and changes nothing.
4356
4357 @item -Wnested-externs @r{(C and Objective-C only)}
4358 @opindex Wnested-externs
4359 @opindex Wno-nested-externs
4360 Warn if an @code{extern} declaration is encountered within a function.
4361
4362 @item -Winline
4363 @opindex Winline
4364 @opindex Wno-inline
4365 Warn if a function can not be inlined and it was declared as inline.
4366 Even with this option, the compiler will not warn about failures to
4367 inline functions declared in system headers.
4368
4369 The compiler uses a variety of heuristics to determine whether or not
4370 to inline a function. For example, the compiler takes into account
4371 the size of the function being inlined and the amount of inlining
4372 that has already been done in the current function. Therefore,
4373 seemingly insignificant changes in the source program can cause the
4374 warnings produced by @option{-Winline} to appear or disappear.
4375
4376 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4377 @opindex Wno-invalid-offsetof
4378 @opindex Winvalid-offsetof
4379 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4380 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
4381 to a non-POD type is undefined. In existing C++ implementations,
4382 however, @samp{offsetof} typically gives meaningful results even when
4383 applied to certain kinds of non-POD types. (Such as a simple
4384 @samp{struct} that fails to be a POD type only by virtue of having a
4385 constructor.) This flag is for users who are aware that they are
4386 writing nonportable code and who have deliberately chosen to ignore the
4387 warning about it.
4388
4389 The restrictions on @samp{offsetof} may be relaxed in a future version
4390 of the C++ standard.
4391
4392 @item -Wno-int-to-pointer-cast
4393 @opindex Wno-int-to-pointer-cast
4394 @opindex Wint-to-pointer-cast
4395 Suppress warnings from casts to pointer type of an integer of a
4396 different size. In C++, casting to a pointer type of smaller size is
4397 an error. @option{Wint-to-pointer-cast} is enabled by default.
4398
4399
4400 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4401 @opindex Wno-pointer-to-int-cast
4402 @opindex Wpointer-to-int-cast
4403 Suppress warnings from casts from a pointer to an integer type of a
4404 different size.
4405
4406 @item -Winvalid-pch
4407 @opindex Winvalid-pch
4408 @opindex Wno-invalid-pch
4409 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4410 the search path but can't be used.
4411
4412 @item -Wlong-long
4413 @opindex Wlong-long
4414 @opindex Wno-long-long
4415 Warn if @samp{long long} type is used. This is enabled by either
4416 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4417 modes. To inhibit the warning messages, use @option{-Wno-long-long}.
4418
4419 @item -Wvariadic-macros
4420 @opindex Wvariadic-macros
4421 @opindex Wno-variadic-macros
4422 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4423 alternate syntax when in pedantic ISO C99 mode. This is default.
4424 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4425
4426 @item -Wvla
4427 @opindex Wvla
4428 @opindex Wno-vla
4429 Warn if variable length array is used in the code.
4430 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4431 the variable length array.
4432
4433 @item -Wvolatile-register-var
4434 @opindex Wvolatile-register-var
4435 @opindex Wno-volatile-register-var
4436 Warn if a register variable is declared volatile. The volatile
4437 modifier does not inhibit all optimizations that may eliminate reads
4438 and/or writes to register variables. This warning is enabled by
4439 @option{-Wall}.
4440
4441 @item -Wdisabled-optimization
4442 @opindex Wdisabled-optimization
4443 @opindex Wno-disabled-optimization
4444 Warn if a requested optimization pass is disabled. This warning does
4445 not generally indicate that there is anything wrong with your code; it
4446 merely indicates that GCC's optimizers were unable to handle the code
4447 effectively. Often, the problem is that your code is too big or too
4448 complex; GCC will refuse to optimize programs when the optimization
4449 itself is likely to take inordinate amounts of time.
4450
4451 @item -Wpointer-sign @r{(C and Objective-C only)}
4452 @opindex Wpointer-sign
4453 @opindex Wno-pointer-sign
4454 Warn for pointer argument passing or assignment with different signedness.
4455 This option is only supported for C and Objective-C@. It is implied by
4456 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4457 @option{-Wno-pointer-sign}.
4458
4459 @item -Wstack-protector
4460 @opindex Wstack-protector
4461 @opindex Wno-stack-protector
4462 This option is only active when @option{-fstack-protector} is active. It
4463 warns about functions that will not be protected against stack smashing.
4464
4465 @item -Wno-mudflap
4466 @opindex Wno-mudflap
4467 Suppress warnings about constructs that cannot be instrumented by
4468 @option{-fmudflap}.
4469
4470 @item -Woverlength-strings
4471 @opindex Woverlength-strings
4472 @opindex Wno-overlength-strings
4473 Warn about string constants which are longer than the ``minimum
4474 maximum'' length specified in the C standard. Modern compilers
4475 generally allow string constants which are much longer than the
4476 standard's minimum limit, but very portable programs should avoid
4477 using longer strings.
4478
4479 The limit applies @emph{after} string constant concatenation, and does
4480 not count the trailing NUL@. In C90, the limit was 509 characters; in
4481 C99, it was raised to 4095. C++98 does not specify a normative
4482 minimum maximum, so we do not diagnose overlength strings in C++@.
4483
4484 This option is implied by @option{-pedantic}, and can be disabled with
4485 @option{-Wno-overlength-strings}.
4486
4487 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4488 @opindex Wunsuffixed-float-constants
4489
4490 GCC will issue a warning for any floating constant that does not have
4491 a suffix. When used together with @option{-Wsystem-headers} it will
4492 warn about such constants in system header files. This can be useful
4493 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4494 from the decimal floating-point extension to C99.
4495 @end table
4496
4497 @node Debugging Options
4498 @section Options for Debugging Your Program or GCC
4499 @cindex options, debugging
4500 @cindex debugging information options
4501
4502 GCC has various special options that are used for debugging
4503 either your program or GCC:
4504
4505 @table @gcctabopt
4506 @item -g
4507 @opindex g
4508 Produce debugging information in the operating system's native format
4509 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
4510 information.
4511
4512 On most systems that use stabs format, @option{-g} enables use of extra
4513 debugging information that only GDB can use; this extra information
4514 makes debugging work better in GDB but will probably make other debuggers
4515 crash or
4516 refuse to read the program. If you want to control for certain whether
4517 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4518 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4519
4520 GCC allows you to use @option{-g} with
4521 @option{-O}. The shortcuts taken by optimized code may occasionally
4522 produce surprising results: some variables you declared may not exist
4523 at all; flow of control may briefly move where you did not expect it;
4524 some statements may not be executed because they compute constant
4525 results or their values were already at hand; some statements may
4526 execute in different places because they were moved out of loops.
4527
4528 Nevertheless it proves possible to debug optimized output. This makes
4529 it reasonable to use the optimizer for programs that might have bugs.
4530
4531 The following options are useful when GCC is generated with the
4532 capability for more than one debugging format.
4533
4534 @item -ggdb
4535 @opindex ggdb
4536 Produce debugging information for use by GDB@. This means to use the
4537 most expressive format available (DWARF 2, stabs, or the native format
4538 if neither of those are supported), including GDB extensions if at all
4539 possible.
4540
4541 @item -gstabs
4542 @opindex gstabs
4543 Produce debugging information in stabs format (if that is supported),
4544 without GDB extensions. This is the format used by DBX on most BSD
4545 systems. On MIPS, Alpha and System V Release 4 systems this option
4546 produces stabs debugging output which is not understood by DBX or SDB@.
4547 On System V Release 4 systems this option requires the GNU assembler.
4548
4549 @item -feliminate-unused-debug-symbols
4550 @opindex feliminate-unused-debug-symbols
4551 Produce debugging information in stabs format (if that is supported),
4552 for only symbols that are actually used.
4553
4554 @item -femit-class-debug-always
4555 Instead of emitting debugging information for a C++ class in only one
4556 object file, emit it in all object files using the class. This option
4557 should be used only with debuggers that are unable to handle the way GCC
4558 normally emits debugging information for classes because using this
4559 option will increase the size of debugging information by as much as a
4560 factor of two.
4561
4562 @item -gstabs+
4563 @opindex gstabs+
4564 Produce debugging information in stabs format (if that is supported),
4565 using GNU extensions understood only by the GNU debugger (GDB)@. The
4566 use of these extensions is likely to make other debuggers crash or
4567 refuse to read the program.
4568
4569 @item -gcoff
4570 @opindex gcoff
4571 Produce debugging information in COFF format (if that is supported).
4572 This is the format used by SDB on most System V systems prior to
4573 System V Release 4.
4574
4575 @item -gxcoff
4576 @opindex gxcoff
4577 Produce debugging information in XCOFF format (if that is supported).
4578 This is the format used by the DBX debugger on IBM RS/6000 systems.
4579
4580 @item -gxcoff+
4581 @opindex gxcoff+
4582 Produce debugging information in XCOFF format (if that is supported),
4583 using GNU extensions understood only by the GNU debugger (GDB)@. The
4584 use of these extensions is likely to make other debuggers crash or
4585 refuse to read the program, and may cause assemblers other than the GNU
4586 assembler (GAS) to fail with an error.
4587
4588 @item -gdwarf-@var{version}
4589 @opindex gdwarf-@var{version}
4590 Produce debugging information in DWARF format (if that is
4591 supported). This is the format used by DBX on IRIX 6. The value
4592 of @var{version} may be either 2, 3 or 4; the default version is 2.
4593
4594 Note that with DWARF version 2 some ports require, and will always
4595 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4596
4597 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4598 for maximum benefit.
4599
4600 @item -gstrict-dwarf
4601 @opindex gstrict-dwarf
4602 Disallow using extensions of later DWARF standard version than selected
4603 with @option{-gdwarf-@var{version}}. On most targets using non-conflicting
4604 DWARF extensions from later standard versions is allowed.
4605
4606 @item -gno-strict-dwarf
4607 @opindex gno-strict-dwarf
4608 Allow using extensions of later DWARF standard version than selected with
4609 @option{-gdwarf-@var{version}}.
4610
4611 @item -gvms
4612 @opindex gvms
4613 Produce debugging information in VMS debug format (if that is
4614 supported). This is the format used by DEBUG on VMS systems.
4615
4616 @item -g@var{level}
4617 @itemx -ggdb@var{level}
4618 @itemx -gstabs@var{level}
4619 @itemx -gcoff@var{level}
4620 @itemx -gxcoff@var{level}
4621 @itemx -gvms@var{level}
4622 Request debugging information and also use @var{level} to specify how
4623 much information. The default level is 2.
4624
4625 Level 0 produces no debug information at all. Thus, @option{-g0} negates
4626 @option{-g}.
4627
4628 Level 1 produces minimal information, enough for making backtraces in
4629 parts of the program that you don't plan to debug. This includes
4630 descriptions of functions and external variables, but no information
4631 about local variables and no line numbers.
4632
4633 Level 3 includes extra information, such as all the macro definitions
4634 present in the program. Some debuggers support macro expansion when
4635 you use @option{-g3}.
4636
4637 @option{-gdwarf-2} does not accept a concatenated debug level, because
4638 GCC used to support an option @option{-gdwarf} that meant to generate
4639 debug information in version 1 of the DWARF format (which is very
4640 different from version 2), and it would have been too confusing. That
4641 debug format is long obsolete, but the option cannot be changed now.
4642 Instead use an additional @option{-g@var{level}} option to change the
4643 debug level for DWARF.
4644
4645 @item -gtoggle
4646 @opindex gtoggle
4647 Turn off generation of debug info, if leaving out this option would have
4648 generated it, or turn it on at level 2 otherwise. The position of this
4649 argument in the command line does not matter, it takes effect after all
4650 other options are processed, and it does so only once, no matter how
4651 many times it is given. This is mainly intended to be used with
4652 @option{-fcompare-debug}.
4653
4654 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4655 @opindex fdump-final-insns
4656 Dump the final internal representation (RTL) to @var{file}. If the
4657 optional argument is omitted (or if @var{file} is @code{.}), the name
4658 of the dump file will be determined by appending @code{.gkd} to the
4659 compilation output file name.
4660
4661 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4662 @opindex fcompare-debug
4663 @opindex fno-compare-debug
4664 If no error occurs during compilation, run the compiler a second time,
4665 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4666 passed to the second compilation. Dump the final internal
4667 representation in both compilations, and print an error if they differ.
4668
4669 If the equal sign is omitted, the default @option{-gtoggle} is used.
4670
4671 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4672 and nonzero, implicitly enables @option{-fcompare-debug}. If
4673 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4674 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4675 is used.
4676
4677 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4678 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4679 of the final representation and the second compilation, preventing even
4680 @env{GCC_COMPARE_DEBUG} from taking effect.
4681
4682 To verify full coverage during @option{-fcompare-debug} testing, set
4683 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4684 which GCC will reject as an invalid option in any actual compilation
4685 (rather than preprocessing, assembly or linking). To get just a
4686 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4687 not overridden} will do.
4688
4689 @item -fcompare-debug-second
4690 @opindex fcompare-debug-second
4691 This option is implicitly passed to the compiler for the second
4692 compilation requested by @option{-fcompare-debug}, along with options to
4693 silence warnings, and omitting other options that would cause
4694 side-effect compiler outputs to files or to the standard output. Dump
4695 files and preserved temporary files are renamed so as to contain the
4696 @code{.gk} additional extension during the second compilation, to avoid
4697 overwriting those generated by the first.
4698
4699 When this option is passed to the compiler driver, it causes the
4700 @emph{first} compilation to be skipped, which makes it useful for little
4701 other than debugging the compiler proper.
4702
4703 @item -feliminate-dwarf2-dups
4704 @opindex feliminate-dwarf2-dups
4705 Compress DWARF2 debugging information by eliminating duplicated
4706 information about each symbol. This option only makes sense when
4707 generating DWARF2 debugging information with @option{-gdwarf-2}.
4708
4709 @item -femit-struct-debug-baseonly
4710 Emit debug information for struct-like types
4711 only when the base name of the compilation source file
4712 matches the base name of file in which the struct was defined.
4713
4714 This option substantially reduces the size of debugging information,
4715 but at significant potential loss in type information to the debugger.
4716 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4717 See @option{-femit-struct-debug-detailed} for more detailed control.
4718
4719 This option works only with DWARF 2.
4720
4721 @item -femit-struct-debug-reduced
4722 Emit debug information for struct-like types
4723 only when the base name of the compilation source file
4724 matches the base name of file in which the type was defined,
4725 unless the struct is a template or defined in a system header.
4726
4727 This option significantly reduces the size of debugging information,
4728 with some potential loss in type information to the debugger.
4729 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4730 See @option{-femit-struct-debug-detailed} for more detailed control.
4731
4732 This option works only with DWARF 2.
4733
4734 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4735 Specify the struct-like types
4736 for which the compiler will generate debug information.
4737 The intent is to reduce duplicate struct debug information
4738 between different object files within the same program.
4739
4740 This option is a detailed version of
4741 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4742 which will serve for most needs.
4743
4744 A specification has the syntax@*
4745 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4746
4747 The optional first word limits the specification to
4748 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4749 A struct type is used directly when it is the type of a variable, member.
4750 Indirect uses arise through pointers to structs.
4751 That is, when use of an incomplete struct would be legal, the use is indirect.
4752 An example is
4753 @samp{struct one direct; struct two * indirect;}.
4754
4755 The optional second word limits the specification to
4756 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4757 Generic structs are a bit complicated to explain.
4758 For C++, these are non-explicit specializations of template classes,
4759 or non-template classes within the above.
4760 Other programming languages have generics,
4761 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4762
4763 The third word specifies the source files for those
4764 structs for which the compiler will emit debug information.
4765 The values @samp{none} and @samp{any} have the normal meaning.
4766 The value @samp{base} means that
4767 the base of name of the file in which the type declaration appears
4768 must match the base of the name of the main compilation file.
4769 In practice, this means that
4770 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4771 but types declared in other header will not.
4772 The value @samp{sys} means those types satisfying @samp{base}
4773 or declared in system or compiler headers.
4774
4775 You may need to experiment to determine the best settings for your application.
4776
4777 The default is @samp{-femit-struct-debug-detailed=all}.
4778
4779 This option works only with DWARF 2.
4780
4781 @item -fenable-icf-debug
4782 @opindex fenable-icf-debug
4783 Generate additional debug information to support identical code folding (ICF).
4784 This option only works with DWARF version 2 or higher.
4785
4786 @item -fno-merge-debug-strings
4787 @opindex fmerge-debug-strings
4788 @opindex fno-merge-debug-strings
4789 Direct the linker to not merge together strings in the debugging
4790 information which are identical in different object files. Merging is
4791 not supported by all assemblers or linkers. Merging decreases the size
4792 of the debug information in the output file at the cost of increasing
4793 link processing time. Merging is enabled by default.
4794
4795 @item -fdebug-prefix-map=@var{old}=@var{new}
4796 @opindex fdebug-prefix-map
4797 When compiling files in directory @file{@var{old}}, record debugging
4798 information describing them as in @file{@var{new}} instead.
4799
4800 @item -fno-dwarf2-cfi-asm
4801 @opindex fdwarf2-cfi-asm
4802 @opindex fno-dwarf2-cfi-asm
4803 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4804 instead of using GAS @code{.cfi_*} directives.
4805
4806 @cindex @command{prof}
4807 @item -p
4808 @opindex p
4809 Generate extra code to write profile information suitable for the
4810 analysis program @command{prof}. You must use this option when compiling
4811 the source files you want data about, and you must also use it when
4812 linking.
4813
4814 @cindex @command{gprof}
4815 @item -pg
4816 @opindex pg
4817 Generate extra code to write profile information suitable for the
4818 analysis program @command{gprof}. You must use this option when compiling
4819 the source files you want data about, and you must also use it when
4820 linking.
4821
4822 @item -Q
4823 @opindex Q
4824 Makes the compiler print out each function name as it is compiled, and
4825 print some statistics about each pass when it finishes.
4826
4827 @item -ftime-report
4828 @opindex ftime-report
4829 Makes the compiler print some statistics about the time consumed by each
4830 pass when it finishes.
4831
4832 @item -fmem-report
4833 @opindex fmem-report
4834 Makes the compiler print some statistics about permanent memory
4835 allocation when it finishes.
4836
4837 @item -fpre-ipa-mem-report
4838 @opindex fpre-ipa-mem-report
4839 @item -fpost-ipa-mem-report
4840 @opindex fpost-ipa-mem-report
4841 Makes the compiler print some statistics about permanent memory
4842 allocation before or after interprocedural optimization.
4843
4844 @item -fstack-usage
4845 @opindex fstack-usage
4846 Makes the compiler output stack usage information for the program, on a
4847 per-function basis. The filename for the dump is made by appending
4848 @file{.su} to the @var{auxname}. @var{auxname} is generated from the name of
4849 the output file, if explicitly specified and it is not an executable,
4850 otherwise it is the basename of the source file. An entry is made up
4851 of three fields:
4852
4853 @itemize
4854 @item
4855 The name of the function.
4856 @item
4857 A number of bytes.
4858 @item
4859 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
4860 @end itemize
4861
4862 The qualifier @code{static} means that the function manipulates the stack
4863 statically: a fixed number of bytes are allocated for the frame on function
4864 entry and released on function exit; no stack adjustments are otherwise made
4865 in the function. The second field is this fixed number of bytes.
4866
4867 The qualifier @code{dynamic} means that the function manipulates the stack
4868 dynamically: in addition to the static allocation described above, stack
4869 adjustments are made in the body of the function, for example to push/pop
4870 arguments around function calls. If the qualifier @code{bounded} is also
4871 present, the amount of these adjustments is bounded at compile-time and
4872 the second field is an upper bound of the total amount of stack used by
4873 the function. If it is not present, the amount of these adjustments is
4874 not bounded at compile-time and the second field only represents the
4875 bounded part.
4876
4877 @item -fprofile-arcs
4878 @opindex fprofile-arcs
4879 Add code so that program flow @dfn{arcs} are instrumented. During
4880 execution the program records how many times each branch and call is
4881 executed and how many times it is taken or returns. When the compiled
4882 program exits it saves this data to a file called
4883 @file{@var{auxname}.gcda} for each source file. The data may be used for
4884 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4885 test coverage analysis (@option{-ftest-coverage}). Each object file's
4886 @var{auxname} is generated from the name of the output file, if
4887 explicitly specified and it is not the final executable, otherwise it is
4888 the basename of the source file. In both cases any suffix is removed
4889 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4890 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4891 @xref{Cross-profiling}.
4892
4893 @cindex @command{gcov}
4894 @item --coverage
4895 @opindex coverage
4896
4897 This option is used to compile and link code instrumented for coverage
4898 analysis. The option is a synonym for @option{-fprofile-arcs}
4899 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4900 linking). See the documentation for those options for more details.
4901
4902 @itemize
4903
4904 @item
4905 Compile the source files with @option{-fprofile-arcs} plus optimization
4906 and code generation options. For test coverage analysis, use the
4907 additional @option{-ftest-coverage} option. You do not need to profile
4908 every source file in a program.
4909
4910 @item
4911 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4912 (the latter implies the former).
4913
4914 @item
4915 Run the program on a representative workload to generate the arc profile
4916 information. This may be repeated any number of times. You can run
4917 concurrent instances of your program, and provided that the file system
4918 supports locking, the data files will be correctly updated. Also
4919 @code{fork} calls are detected and correctly handled (double counting
4920 will not happen).
4921
4922 @item
4923 For profile-directed optimizations, compile the source files again with
4924 the same optimization and code generation options plus
4925 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4926 Control Optimization}).
4927
4928 @item
4929 For test coverage analysis, use @command{gcov} to produce human readable
4930 information from the @file{.gcno} and @file{.gcda} files. Refer to the
4931 @command{gcov} documentation for further information.
4932
4933 @end itemize
4934
4935 With @option{-fprofile-arcs}, for each function of your program GCC
4936 creates a program flow graph, then finds a spanning tree for the graph.
4937 Only arcs that are not on the spanning tree have to be instrumented: the
4938 compiler adds code to count the number of times that these arcs are
4939 executed. When an arc is the only exit or only entrance to a block, the
4940 instrumentation code can be added to the block; otherwise, a new basic
4941 block must be created to hold the instrumentation code.
4942
4943 @need 2000
4944 @item -ftest-coverage
4945 @opindex ftest-coverage
4946 Produce a notes file that the @command{gcov} code-coverage utility
4947 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4948 show program coverage. Each source file's note file is called
4949 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
4950 above for a description of @var{auxname} and instructions on how to
4951 generate test coverage data. Coverage data will match the source files
4952 more closely, if you do not optimize.
4953
4954 @item -fdbg-cnt-list
4955 @opindex fdbg-cnt-list
4956 Print the name and the counter upper bound for all debug counters.
4957
4958 @item -fdbg-cnt=@var{counter-value-list}
4959 @opindex fdbg-cnt
4960 Set the internal debug counter upper bound. @var{counter-value-list}
4961 is a comma-separated list of @var{name}:@var{value} pairs
4962 which sets the upper bound of each debug counter @var{name} to @var{value}.
4963 All debug counters have the initial upper bound of @var{UINT_MAX},
4964 thus dbg_cnt() returns true always unless the upper bound is set by this option.
4965 e.g. With -fdbg-cnt=dce:10,tail_call:0
4966 dbg_cnt(dce) will return true only for first 10 invocations
4967 and dbg_cnt(tail_call) will return false always.
4968
4969 @item -d@var{letters}
4970 @itemx -fdump-rtl-@var{pass}
4971 @opindex d
4972 Says to make debugging dumps during compilation at times specified by
4973 @var{letters}. This is used for debugging the RTL-based passes of the
4974 compiler. The file names for most of the dumps are made by appending
4975 a pass number and a word to the @var{dumpname}, and the files are
4976 created in the directory of the output file. Note that the pass
4977 number is computed statically as passes get registered into the pass
4978 manager. Thus the numbering is not related to the dynamic order of
4979 execution of passes. In particular, a pass installed by a plugin
4980 could have a number over 200 even if it executed quite early.
4981 @var{dumpname} is generated from the name of the output file, if
4982 explicitly specified and it is not an executable, otherwise it is the
4983 basename of the source file. These switches may have different effects
4984 when @option{-E} is used for preprocessing.
4985
4986 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4987 @option{-d} option @var{letters}. Here are the possible
4988 letters for use in @var{pass} and @var{letters}, and their meanings:
4989
4990 @table @gcctabopt
4991
4992 @item -fdump-rtl-alignments
4993 @opindex fdump-rtl-alignments
4994 Dump after branch alignments have been computed.
4995
4996 @item -fdump-rtl-asmcons
4997 @opindex fdump-rtl-asmcons
4998 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4999
5000 @item -fdump-rtl-auto_inc_dec
5001 @opindex fdump-rtl-auto_inc_dec
5002 Dump after auto-inc-dec discovery. This pass is only run on
5003 architectures that have auto inc or auto dec instructions.
5004
5005 @item -fdump-rtl-barriers
5006 @opindex fdump-rtl-barriers
5007 Dump after cleaning up the barrier instructions.
5008
5009 @item -fdump-rtl-bbpart
5010 @opindex fdump-rtl-bbpart
5011 Dump after partitioning hot and cold basic blocks.
5012
5013 @item -fdump-rtl-bbro
5014 @opindex fdump-rtl-bbro
5015 Dump after block reordering.
5016
5017 @item -fdump-rtl-btl1
5018 @itemx -fdump-rtl-btl2
5019 @opindex fdump-rtl-btl2
5020 @opindex fdump-rtl-btl2
5021 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5022 after the two branch
5023 target load optimization passes.
5024
5025 @item -fdump-rtl-bypass
5026 @opindex fdump-rtl-bypass
5027 Dump after jump bypassing and control flow optimizations.
5028
5029 @item -fdump-rtl-combine
5030 @opindex fdump-rtl-combine
5031 Dump after the RTL instruction combination pass.
5032
5033 @item -fdump-rtl-compgotos
5034 @opindex fdump-rtl-compgotos
5035 Dump after duplicating the computed gotos.
5036
5037 @item -fdump-rtl-ce1
5038 @itemx -fdump-rtl-ce2
5039 @itemx -fdump-rtl-ce3
5040 @opindex fdump-rtl-ce1
5041 @opindex fdump-rtl-ce2
5042 @opindex fdump-rtl-ce3
5043 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5044 @option{-fdump-rtl-ce3} enable dumping after the three
5045 if conversion passes.
5046
5047 @itemx -fdump-rtl-cprop_hardreg
5048 @opindex fdump-rtl-cprop_hardreg
5049 Dump after hard register copy propagation.
5050
5051 @itemx -fdump-rtl-csa
5052 @opindex fdump-rtl-csa
5053 Dump after combining stack adjustments.
5054
5055 @item -fdump-rtl-cse1
5056 @itemx -fdump-rtl-cse2
5057 @opindex fdump-rtl-cse1
5058 @opindex fdump-rtl-cse2
5059 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5060 the two common sub-expression elimination passes.
5061
5062 @itemx -fdump-rtl-dce
5063 @opindex fdump-rtl-dce
5064 Dump after the standalone dead code elimination passes.
5065
5066 @itemx -fdump-rtl-dbr
5067 @opindex fdump-rtl-dbr
5068 Dump after delayed branch scheduling.
5069
5070 @item -fdump-rtl-dce1
5071 @itemx -fdump-rtl-dce2
5072 @opindex fdump-rtl-dce1
5073 @opindex fdump-rtl-dce2
5074 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5075 the two dead store elimination passes.
5076
5077 @item -fdump-rtl-eh
5078 @opindex fdump-rtl-eh
5079 Dump after finalization of EH handling code.
5080
5081 @item -fdump-rtl-eh_ranges
5082 @opindex fdump-rtl-eh_ranges
5083 Dump after conversion of EH handling range regions.
5084
5085 @item -fdump-rtl-expand
5086 @opindex fdump-rtl-expand
5087 Dump after RTL generation.
5088
5089 @item -fdump-rtl-fwprop1
5090 @itemx -fdump-rtl-fwprop2
5091 @opindex fdump-rtl-fwprop1
5092 @opindex fdump-rtl-fwprop2
5093 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5094 dumping after the two forward propagation passes.
5095
5096 @item -fdump-rtl-gcse1
5097 @itemx -fdump-rtl-gcse2
5098 @opindex fdump-rtl-gcse1
5099 @opindex fdump-rtl-gcse2
5100 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5101 after global common subexpression elimination.
5102
5103 @item -fdump-rtl-init-regs
5104 @opindex fdump-rtl-init-regs
5105 Dump after the initialization of the registers.
5106
5107 @item -fdump-rtl-initvals
5108 @opindex fdump-rtl-initvals
5109 Dump after the computation of the initial value sets.
5110
5111 @itemx -fdump-rtl-into_cfglayout
5112 @opindex fdump-rtl-into_cfglayout
5113 Dump after converting to cfglayout mode.
5114
5115 @item -fdump-rtl-ira
5116 @opindex fdump-rtl-ira
5117 Dump after iterated register allocation.
5118
5119 @item -fdump-rtl-jump
5120 @opindex fdump-rtl-jump
5121 Dump after the second jump optimization.
5122
5123 @item -fdump-rtl-loop2
5124 @opindex fdump-rtl-loop2
5125 @option{-fdump-rtl-loop2} enables dumping after the rtl
5126 loop optimization passes.
5127
5128 @item -fdump-rtl-mach
5129 @opindex fdump-rtl-mach
5130 Dump after performing the machine dependent reorganization pass, if that
5131 pass exists.
5132
5133 @item -fdump-rtl-mode_sw
5134 @opindex fdump-rtl-mode_sw
5135 Dump after removing redundant mode switches.
5136
5137 @item -fdump-rtl-rnreg
5138 @opindex fdump-rtl-rnreg
5139 Dump after register renumbering.
5140
5141 @itemx -fdump-rtl-outof_cfglayout
5142 @opindex fdump-rtl-outof_cfglayout
5143 Dump after converting from cfglayout mode.
5144
5145 @item -fdump-rtl-peephole2
5146 @opindex fdump-rtl-peephole2
5147 Dump after the peephole pass.
5148
5149 @item -fdump-rtl-postreload
5150 @opindex fdump-rtl-postreload
5151 Dump after post-reload optimizations.
5152
5153 @itemx -fdump-rtl-pro_and_epilogue
5154 @opindex fdump-rtl-pro_and_epilogue
5155 Dump after generating the function pro and epilogues.
5156
5157 @item -fdump-rtl-regmove
5158 @opindex fdump-rtl-regmove
5159 Dump after the register move pass.
5160
5161 @item -fdump-rtl-sched1
5162 @itemx -fdump-rtl-sched2
5163 @opindex fdump-rtl-sched1
5164 @opindex fdump-rtl-sched2
5165 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5166 after the basic block scheduling passes.
5167
5168 @item -fdump-rtl-see
5169 @opindex fdump-rtl-see
5170 Dump after sign extension elimination.
5171
5172 @item -fdump-rtl-seqabstr
5173 @opindex fdump-rtl-seqabstr
5174 Dump after common sequence discovery.
5175
5176 @item -fdump-rtl-shorten
5177 @opindex fdump-rtl-shorten
5178 Dump after shortening branches.
5179
5180 @item -fdump-rtl-sibling
5181 @opindex fdump-rtl-sibling
5182 Dump after sibling call optimizations.
5183
5184 @item -fdump-rtl-split1
5185 @itemx -fdump-rtl-split2
5186 @itemx -fdump-rtl-split3
5187 @itemx -fdump-rtl-split4
5188 @itemx -fdump-rtl-split5
5189 @opindex fdump-rtl-split1
5190 @opindex fdump-rtl-split2
5191 @opindex fdump-rtl-split3
5192 @opindex fdump-rtl-split4
5193 @opindex fdump-rtl-split5
5194 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5195 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5196 @option{-fdump-rtl-split5} enable dumping after five rounds of
5197 instruction splitting.
5198
5199 @item -fdump-rtl-sms
5200 @opindex fdump-rtl-sms
5201 Dump after modulo scheduling. This pass is only run on some
5202 architectures.
5203
5204 @item -fdump-rtl-stack
5205 @opindex fdump-rtl-stack
5206 Dump after conversion from GCC's "flat register file" registers to the
5207 x87's stack-like registers. This pass is only run on x86 variants.
5208
5209 @item -fdump-rtl-subreg1
5210 @itemx -fdump-rtl-subreg2
5211 @opindex fdump-rtl-subreg1
5212 @opindex fdump-rtl-subreg2
5213 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5214 the two subreg expansion passes.
5215
5216 @item -fdump-rtl-unshare
5217 @opindex fdump-rtl-unshare
5218 Dump after all rtl has been unshared.
5219
5220 @item -fdump-rtl-vartrack
5221 @opindex fdump-rtl-vartrack
5222 Dump after variable tracking.
5223
5224 @item -fdump-rtl-vregs
5225 @opindex fdump-rtl-vregs
5226 Dump after converting virtual registers to hard registers.
5227
5228 @item -fdump-rtl-web
5229 @opindex fdump-rtl-web
5230 Dump after live range splitting.
5231
5232 @item -fdump-rtl-regclass
5233 @itemx -fdump-rtl-subregs_of_mode_init
5234 @itemx -fdump-rtl-subregs_of_mode_finish
5235 @itemx -fdump-rtl-dfinit
5236 @itemx -fdump-rtl-dfinish
5237 @opindex fdump-rtl-regclass
5238 @opindex fdump-rtl-subregs_of_mode_init
5239 @opindex fdump-rtl-subregs_of_mode_finish
5240 @opindex fdump-rtl-dfinit
5241 @opindex fdump-rtl-dfinish
5242 These dumps are defined but always produce empty files.
5243
5244 @item -fdump-rtl-all
5245 @opindex fdump-rtl-all
5246 Produce all the dumps listed above.
5247
5248 @item -dA
5249 @opindex dA
5250 Annotate the assembler output with miscellaneous debugging information.
5251
5252 @item -dD
5253 @opindex dD
5254 Dump all macro definitions, at the end of preprocessing, in addition to
5255 normal output.
5256
5257 @item -dH
5258 @opindex dH
5259 Produce a core dump whenever an error occurs.
5260
5261 @item -dm
5262 @opindex dm
5263 Print statistics on memory usage, at the end of the run, to
5264 standard error.
5265
5266 @item -dp
5267 @opindex dp
5268 Annotate the assembler output with a comment indicating which
5269 pattern and alternative was used. The length of each instruction is
5270 also printed.
5271
5272 @item -dP
5273 @opindex dP
5274 Dump the RTL in the assembler output as a comment before each instruction.
5275 Also turns on @option{-dp} annotation.
5276
5277 @item -dv
5278 @opindex dv
5279 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5280 dump a representation of the control flow graph suitable for viewing with VCG
5281 to @file{@var{file}.@var{pass}.vcg}.
5282
5283 @item -dx
5284 @opindex dx
5285 Just generate RTL for a function instead of compiling it. Usually used
5286 with @option{-fdump-rtl-expand}.
5287 @end table
5288
5289 @item -fdump-noaddr
5290 @opindex fdump-noaddr
5291 When doing debugging dumps, suppress address output. This makes it more
5292 feasible to use diff on debugging dumps for compiler invocations with
5293 different compiler binaries and/or different
5294 text / bss / data / heap / stack / dso start locations.
5295
5296 @item -fdump-unnumbered
5297 @opindex fdump-unnumbered
5298 When doing debugging dumps, suppress instruction numbers and address output.
5299 This makes it more feasible to use diff on debugging dumps for compiler
5300 invocations with different options, in particular with and without
5301 @option{-g}.
5302
5303 @item -fdump-unnumbered-links
5304 @opindex fdump-unnumbered-links
5305 When doing debugging dumps (see @option{-d} option above), suppress
5306 instruction numbers for the links to the previous and next instructions
5307 in a sequence.
5308
5309 @item -fdump-translation-unit @r{(C++ only)}
5310 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5311 @opindex fdump-translation-unit
5312 Dump a representation of the tree structure for the entire translation
5313 unit to a file. The file name is made by appending @file{.tu} to the
5314 source file name, and the file is created in the same directory as the
5315 output file. If the @samp{-@var{options}} form is used, @var{options}
5316 controls the details of the dump as described for the
5317 @option{-fdump-tree} options.
5318
5319 @item -fdump-class-hierarchy @r{(C++ only)}
5320 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5321 @opindex fdump-class-hierarchy
5322 Dump a representation of each class's hierarchy and virtual function
5323 table layout to a file. The file name is made by appending
5324 @file{.class} to the source file name, and the file is created in the
5325 same directory as the output file. If the @samp{-@var{options}} form
5326 is used, @var{options} controls the details of the dump as described
5327 for the @option{-fdump-tree} options.
5328
5329 @item -fdump-ipa-@var{switch}
5330 @opindex fdump-ipa
5331 Control the dumping at various stages of inter-procedural analysis
5332 language tree to a file. The file name is generated by appending a
5333 switch specific suffix to the source file name, and the file is created
5334 in the same directory as the output file. The following dumps are
5335 possible:
5336
5337 @table @samp
5338 @item all
5339 Enables all inter-procedural analysis dumps.
5340
5341 @item cgraph
5342 Dumps information about call-graph optimization, unused function removal,
5343 and inlining decisions.
5344
5345 @item inline
5346 Dump after function inlining.
5347
5348 @end table
5349
5350 @item -fdump-statistics-@var{option}
5351 @opindex fdump-statistics
5352 Enable and control dumping of pass statistics in a separate file. The
5353 file name is generated by appending a suffix ending in
5354 @samp{.statistics} to the source file name, and the file is created in
5355 the same directory as the output file. If the @samp{-@var{option}}
5356 form is used, @samp{-stats} will cause counters to be summed over the
5357 whole compilation unit while @samp{-details} will dump every event as
5358 the passes generate them. The default with no option is to sum
5359 counters for each function compiled.
5360
5361 @item -fdump-tree-@var{switch}
5362 @itemx -fdump-tree-@var{switch}-@var{options}
5363 @opindex fdump-tree
5364 Control the dumping at various stages of processing the intermediate
5365 language tree to a file. The file name is generated by appending a
5366 switch specific suffix to the source file name, and the file is
5367 created in the same directory as the output file. If the
5368 @samp{-@var{options}} form is used, @var{options} is a list of
5369 @samp{-} separated options that control the details of the dump. Not
5370 all options are applicable to all dumps, those which are not
5371 meaningful will be ignored. The following options are available
5372
5373 @table @samp
5374 @item address
5375 Print the address of each node. Usually this is not meaningful as it
5376 changes according to the environment and source file. Its primary use
5377 is for tying up a dump file with a debug environment.
5378 @item asmname
5379 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5380 in the dump instead of @code{DECL_NAME}. Its primary use is ease of
5381 use working backward from mangled names in the assembly file.
5382 @item slim
5383 Inhibit dumping of members of a scope or body of a function merely
5384 because that scope has been reached. Only dump such items when they
5385 are directly reachable by some other path. When dumping pretty-printed
5386 trees, this option inhibits dumping the bodies of control structures.
5387 @item raw
5388 Print a raw representation of the tree. By default, trees are
5389 pretty-printed into a C-like representation.
5390 @item details
5391 Enable more detailed dumps (not honored by every dump option).
5392 @item stats
5393 Enable dumping various statistics about the pass (not honored by every dump
5394 option).
5395 @item blocks
5396 Enable showing basic block boundaries (disabled in raw dumps).
5397 @item vops
5398 Enable showing virtual operands for every statement.
5399 @item lineno
5400 Enable showing line numbers for statements.
5401 @item uid
5402 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5403 @item verbose
5404 Enable showing the tree dump for each statement.
5405 @item eh
5406 Enable showing the EH region number holding each statement.
5407 @item all
5408 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5409 and @option{lineno}.
5410 @end table
5411
5412 The following tree dumps are possible:
5413 @table @samp
5414
5415 @item original
5416 @opindex fdump-tree-original
5417 Dump before any tree based optimization, to @file{@var{file}.original}.
5418
5419 @item optimized
5420 @opindex fdump-tree-optimized
5421 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5422
5423 @item gimple
5424 @opindex fdump-tree-gimple
5425 Dump each function before and after the gimplification pass to a file. The
5426 file name is made by appending @file{.gimple} to the source file name.
5427
5428 @item cfg
5429 @opindex fdump-tree-cfg
5430 Dump the control flow graph of each function to a file. The file name is
5431 made by appending @file{.cfg} to the source file name.
5432
5433 @item vcg
5434 @opindex fdump-tree-vcg
5435 Dump the control flow graph of each function to a file in VCG format. The
5436 file name is made by appending @file{.vcg} to the source file name. Note
5437 that if the file contains more than one function, the generated file cannot
5438 be used directly by VCG@. You will need to cut and paste each function's
5439 graph into its own separate file first.
5440
5441 @item ch
5442 @opindex fdump-tree-ch
5443 Dump each function after copying loop headers. The file name is made by
5444 appending @file{.ch} to the source file name.
5445
5446 @item ssa
5447 @opindex fdump-tree-ssa
5448 Dump SSA related information to a file. The file name is made by appending
5449 @file{.ssa} to the source file name.
5450
5451 @item alias
5452 @opindex fdump-tree-alias
5453 Dump aliasing information for each function. The file name is made by
5454 appending @file{.alias} to the source file name.
5455
5456 @item ccp
5457 @opindex fdump-tree-ccp
5458 Dump each function after CCP@. The file name is made by appending
5459 @file{.ccp} to the source file name.
5460
5461 @item storeccp
5462 @opindex fdump-tree-storeccp
5463 Dump each function after STORE-CCP@. The file name is made by appending
5464 @file{.storeccp} to the source file name.
5465
5466 @item pre
5467 @opindex fdump-tree-pre
5468 Dump trees after partial redundancy elimination. The file name is made
5469 by appending @file{.pre} to the source file name.
5470
5471 @item fre
5472 @opindex fdump-tree-fre
5473 Dump trees after full redundancy elimination. The file name is made
5474 by appending @file{.fre} to the source file name.
5475
5476 @item copyprop
5477 @opindex fdump-tree-copyprop
5478 Dump trees after copy propagation. The file name is made
5479 by appending @file{.copyprop} to the source file name.
5480
5481 @item store_copyprop
5482 @opindex fdump-tree-store_copyprop
5483 Dump trees after store copy-propagation. The file name is made
5484 by appending @file{.store_copyprop} to the source file name.
5485
5486 @item dce
5487 @opindex fdump-tree-dce
5488 Dump each function after dead code elimination. The file name is made by
5489 appending @file{.dce} to the source file name.
5490
5491 @item mudflap
5492 @opindex fdump-tree-mudflap
5493 Dump each function after adding mudflap instrumentation. The file name is
5494 made by appending @file{.mudflap} to the source file name.
5495
5496 @item sra
5497 @opindex fdump-tree-sra
5498 Dump each function after performing scalar replacement of aggregates. The
5499 file name is made by appending @file{.sra} to the source file name.
5500
5501 @item sink
5502 @opindex fdump-tree-sink
5503 Dump each function after performing code sinking. The file name is made
5504 by appending @file{.sink} to the source file name.
5505
5506 @item dom
5507 @opindex fdump-tree-dom
5508 Dump each function after applying dominator tree optimizations. The file
5509 name is made by appending @file{.dom} to the source file name.
5510
5511 @item dse
5512 @opindex fdump-tree-dse
5513 Dump each function after applying dead store elimination. The file
5514 name is made by appending @file{.dse} to the source file name.
5515
5516 @item phiopt
5517 @opindex fdump-tree-phiopt
5518 Dump each function after optimizing PHI nodes into straightline code. The file
5519 name is made by appending @file{.phiopt} to the source file name.
5520
5521 @item forwprop
5522 @opindex fdump-tree-forwprop
5523 Dump each function after forward propagating single use variables. The file
5524 name is made by appending @file{.forwprop} to the source file name.
5525
5526 @item copyrename
5527 @opindex fdump-tree-copyrename
5528 Dump each function after applying the copy rename optimization. The file
5529 name is made by appending @file{.copyrename} to the source file name.
5530
5531 @item nrv
5532 @opindex fdump-tree-nrv
5533 Dump each function after applying the named return value optimization on
5534 generic trees. The file name is made by appending @file{.nrv} to the source
5535 file name.
5536
5537 @item vect
5538 @opindex fdump-tree-vect
5539 Dump each function after applying vectorization of loops. The file name is
5540 made by appending @file{.vect} to the source file name.
5541
5542 @item slp
5543 @opindex fdump-tree-slp
5544 Dump each function after applying vectorization of basic blocks. The file name
5545 is made by appending @file{.slp} to the source file name.
5546
5547 @item vrp
5548 @opindex fdump-tree-vrp
5549 Dump each function after Value Range Propagation (VRP). The file name
5550 is made by appending @file{.vrp} to the source file name.
5551
5552 @item all
5553 @opindex fdump-tree-all
5554 Enable all the available tree dumps with the flags provided in this option.
5555 @end table
5556
5557 @item -ftree-vectorizer-verbose=@var{n}
5558 @opindex ftree-vectorizer-verbose
5559 This option controls the amount of debugging output the vectorizer prints.
5560 This information is written to standard error, unless
5561 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5562 in which case it is output to the usual dump listing file, @file{.vect}.
5563 For @var{n}=0 no diagnostic information is reported.
5564 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5565 and the total number of loops that got vectorized.
5566 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5567 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5568 inner-most, single-bb, single-entry/exit loops. This is the same verbosity
5569 level that @option{-fdump-tree-vect-stats} uses.
5570 Higher verbosity levels mean either more information dumped for each
5571 reported loop, or same amount of information reported for more loops:
5572 if @var{n}=3, vectorizer cost model information is reported.
5573 If @var{n}=4, alignment related information is added to the reports.
5574 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5575 memory access-patterns) is added to the reports.
5576 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5577 that did not pass the first analysis phase (i.e., may not be countable, or
5578 may have complicated control-flow).
5579 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5580 If @var{n}=8, SLP related information is added to the reports.
5581 For @var{n}=9, all the information the vectorizer generates during its
5582 analysis and transformation is reported. This is the same verbosity level
5583 that @option{-fdump-tree-vect-details} uses.
5584
5585 @item -frandom-seed=@var{string}
5586 @opindex frandom-seed
5587 This option provides a seed that GCC uses when it would otherwise use
5588 random numbers. It is used to generate certain symbol names
5589 that have to be different in every compiled file. It is also used to
5590 place unique stamps in coverage data files and the object files that
5591 produce them. You can use the @option{-frandom-seed} option to produce
5592 reproducibly identical object files.
5593
5594 The @var{string} should be different for every file you compile.
5595
5596 @item -fsched-verbose=@var{n}
5597 @opindex fsched-verbose
5598 On targets that use instruction scheduling, this option controls the
5599 amount of debugging output the scheduler prints. This information is
5600 written to standard error, unless @option{-fdump-rtl-sched1} or
5601 @option{-fdump-rtl-sched2} is specified, in which case it is output
5602 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5603 respectively. However for @var{n} greater than nine, the output is
5604 always printed to standard error.
5605
5606 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5607 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5608 For @var{n} greater than one, it also output basic block probabilities,
5609 detailed ready list information and unit/insn info. For @var{n} greater
5610 than two, it includes RTL at abort point, control-flow and regions info.
5611 And for @var{n} over four, @option{-fsched-verbose} also includes
5612 dependence info.
5613
5614 @item -save-temps
5615 @itemx -save-temps=cwd
5616 @opindex save-temps
5617 Store the usual ``temporary'' intermediate files permanently; place them
5618 in the current directory and name them based on the source file. Thus,
5619 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5620 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
5621 preprocessed @file{foo.i} output file even though the compiler now
5622 normally uses an integrated preprocessor.
5623
5624 When used in combination with the @option{-x} command line option,
5625 @option{-save-temps} is sensible enough to avoid over writing an
5626 input source file with the same extension as an intermediate file.
5627 The corresponding intermediate file may be obtained by renaming the
5628 source file before using @option{-save-temps}.
5629
5630 If you invoke GCC in parallel, compiling several different source
5631 files that share a common base name in different subdirectories or the
5632 same source file compiled for multiple output destinations, it is
5633 likely that the different parallel compilers will interfere with each
5634 other, and overwrite the temporary files. For instance:
5635
5636 @smallexample
5637 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5638 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5639 @end smallexample
5640
5641 may result in @file{foo.i} and @file{foo.o} being written to
5642 simultaneously by both compilers.
5643
5644 @item -save-temps=obj
5645 @opindex save-temps=obj
5646 Store the usual ``temporary'' intermediate files permanently. If the
5647 @option{-o} option is used, the temporary files are based on the
5648 object file. If the @option{-o} option is not used, the
5649 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5650
5651 For example:
5652
5653 @smallexample
5654 gcc -save-temps=obj -c foo.c
5655 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5656 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5657 @end smallexample
5658
5659 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5660 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5661 @file{dir2/yfoobar.o}.
5662
5663 @item -time@r{[}=@var{file}@r{]}
5664 @opindex time
5665 Report the CPU time taken by each subprocess in the compilation
5666 sequence. For C source files, this is the compiler proper and assembler
5667 (plus the linker if linking is done).
5668
5669 Without the specification of an output file, the output looks like this:
5670
5671 @smallexample
5672 # cc1 0.12 0.01
5673 # as 0.00 0.01
5674 @end smallexample
5675
5676 The first number on each line is the ``user time'', that is time spent
5677 executing the program itself. The second number is ``system time'',
5678 time spent executing operating system routines on behalf of the program.
5679 Both numbers are in seconds.
5680
5681 With the specification of an output file, the output is appended to the
5682 named file, and it looks like this:
5683
5684 @smallexample
5685 0.12 0.01 cc1 @var{options}
5686 0.00 0.01 as @var{options}
5687 @end smallexample
5688
5689 The ``user time'' and the ``system time'' are moved before the program
5690 name, and the options passed to the program are displayed, so that one
5691 can later tell what file was being compiled, and with which options.
5692
5693 @item -fvar-tracking
5694 @opindex fvar-tracking
5695 Run variable tracking pass. It computes where variables are stored at each
5696 position in code. Better debugging information is then generated
5697 (if the debugging information format supports this information).
5698
5699 It is enabled by default when compiling with optimization (@option{-Os},
5700 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5701 the debug info format supports it.
5702
5703 @item -fvar-tracking-assignments
5704 @opindex fvar-tracking-assignments
5705 @opindex fno-var-tracking-assignments
5706 Annotate assignments to user variables early in the compilation and
5707 attempt to carry the annotations over throughout the compilation all the
5708 way to the end, in an attempt to improve debug information while
5709 optimizing. Use of @option{-gdwarf-4} is recommended along with it.
5710
5711 It can be enabled even if var-tracking is disabled, in which case
5712 annotations will be created and maintained, but discarded at the end.
5713
5714 @item -fvar-tracking-assignments-toggle
5715 @opindex fvar-tracking-assignments-toggle
5716 @opindex fno-var-tracking-assignments-toggle
5717 Toggle @option{-fvar-tracking-assignments}, in the same way that
5718 @option{-gtoggle} toggles @option{-g}.
5719
5720 @item -print-file-name=@var{library}
5721 @opindex print-file-name
5722 Print the full absolute name of the library file @var{library} that
5723 would be used when linking---and don't do anything else. With this
5724 option, GCC does not compile or link anything; it just prints the
5725 file name.
5726
5727 @item -print-multi-directory
5728 @opindex print-multi-directory
5729 Print the directory name corresponding to the multilib selected by any
5730 other switches present in the command line. This directory is supposed
5731 to exist in @env{GCC_EXEC_PREFIX}.
5732
5733 @item -print-multi-lib
5734 @opindex print-multi-lib
5735 Print the mapping from multilib directory names to compiler switches
5736 that enable them. The directory name is separated from the switches by
5737 @samp{;}, and each switch starts with an @samp{@@} instead of the
5738 @samp{-}, without spaces between multiple switches. This is supposed to
5739 ease shell-processing.
5740
5741 @item -print-multi-os-directory
5742 @opindex print-multi-os-directory
5743 Print the path to OS libraries for the selected
5744 multilib, relative to some @file{lib} subdirectory. If OS libraries are
5745 present in the @file{lib} subdirectory and no multilibs are used, this is
5746 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5747 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5748 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5749 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5750
5751 @item -print-prog-name=@var{program}
5752 @opindex print-prog-name
5753 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5754
5755 @item -print-libgcc-file-name
5756 @opindex print-libgcc-file-name
5757 Same as @option{-print-file-name=libgcc.a}.
5758
5759 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5760 but you do want to link with @file{libgcc.a}. You can do
5761
5762 @smallexample
5763 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5764 @end smallexample
5765
5766 @item -print-search-dirs
5767 @opindex print-search-dirs
5768 Print the name of the configured installation directory and a list of
5769 program and library directories @command{gcc} will search---and don't do anything else.
5770
5771 This is useful when @command{gcc} prints the error message
5772 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5773 To resolve this you either need to put @file{cpp0} and the other compiler
5774 components where @command{gcc} expects to find them, or you can set the environment
5775 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5776 Don't forget the trailing @samp{/}.
5777 @xref{Environment Variables}.
5778
5779 @item -print-sysroot
5780 @opindex print-sysroot
5781 Print the target sysroot directory that will be used during
5782 compilation. This is the target sysroot specified either at configure
5783 time or using the @option{--sysroot} option, possibly with an extra
5784 suffix that depends on compilation options. If no target sysroot is
5785 specified, the option prints nothing.
5786
5787 @item -print-sysroot-headers-suffix
5788 @opindex print-sysroot-headers-suffix
5789 Print the suffix added to the target sysroot when searching for
5790 headers, or give an error if the compiler is not configured with such
5791 a suffix---and don't do anything else.
5792
5793 @item -dumpmachine
5794 @opindex dumpmachine
5795 Print the compiler's target machine (for example,
5796 @samp{i686-pc-linux-gnu})---and don't do anything else.
5797
5798 @item -dumpversion
5799 @opindex dumpversion
5800 Print the compiler version (for example, @samp{3.0})---and don't do
5801 anything else.
5802
5803 @item -dumpspecs
5804 @opindex dumpspecs
5805 Print the compiler's built-in specs---and don't do anything else. (This
5806 is used when GCC itself is being built.) @xref{Spec Files}.
5807
5808 @item -feliminate-unused-debug-types
5809 @opindex feliminate-unused-debug-types
5810 Normally, when producing DWARF2 output, GCC will emit debugging
5811 information for all types declared in a compilation
5812 unit, regardless of whether or not they are actually used
5813 in that compilation unit. Sometimes this is useful, such as
5814 if, in the debugger, you want to cast a value to a type that is
5815 not actually used in your program (but is declared). More often,
5816 however, this results in a significant amount of wasted space.
5817 With this option, GCC will avoid producing debug symbol output
5818 for types that are nowhere used in the source file being compiled.
5819 @end table
5820
5821 @node Optimize Options
5822 @section Options That Control Optimization
5823 @cindex optimize options
5824 @cindex options, optimization
5825
5826 These options control various sorts of optimizations.
5827
5828 Without any optimization option, the compiler's goal is to reduce the
5829 cost of compilation and to make debugging produce the expected
5830 results. Statements are independent: if you stop the program with a
5831 breakpoint between statements, you can then assign a new value to any
5832 variable or change the program counter to any other statement in the
5833 function and get exactly the results you would expect from the source
5834 code.
5835
5836 Turning on optimization flags makes the compiler attempt to improve
5837 the performance and/or code size at the expense of compilation time
5838 and possibly the ability to debug the program.
5839
5840 The compiler performs optimization based on the knowledge it has of the
5841 program. Compiling multiple files at once to a single output file mode allows
5842 the compiler to use information gained from all of the files when compiling
5843 each of them.
5844
5845 Not all optimizations are controlled directly by a flag. Only
5846 optimizations that have a flag are listed in this section.
5847
5848 Most optimizations are only enabled if an @option{-O} level is set on
5849 the command line. Otherwise they are disabled, even if individual
5850 optimization flags are specified.
5851
5852 Depending on the target and how GCC was configured, a slightly different
5853 set of optimizations may be enabled at each @option{-O} level than
5854 those listed here. You can invoke GCC with @samp{-Q --help=optimizers}
5855 to find out the exact set of optimizations that are enabled at each level.
5856 @xref{Overall Options}, for examples.
5857
5858 @table @gcctabopt
5859 @item -O
5860 @itemx -O1
5861 @opindex O
5862 @opindex O1
5863 Optimize. Optimizing compilation takes somewhat more time, and a lot
5864 more memory for a large function.
5865
5866 With @option{-O}, the compiler tries to reduce code size and execution
5867 time, without performing any optimizations that take a great deal of
5868 compilation time.
5869
5870 @option{-O} turns on the following optimization flags:
5871 @gccoptlist{
5872 -fauto-inc-dec @gol
5873 -fcprop-registers @gol
5874 -fdce @gol
5875 -fdefer-pop @gol
5876 -fdelayed-branch @gol
5877 -fdse @gol
5878 -fguess-branch-probability @gol
5879 -fif-conversion2 @gol
5880 -fif-conversion @gol
5881 -fipa-pure-const @gol
5882 -fipa-profile @gol
5883 -fipa-reference @gol
5884 -fmerge-constants
5885 -fsplit-wide-types @gol
5886 -ftree-bit-ccp @gol
5887 -ftree-builtin-call-dce @gol
5888 -ftree-ccp @gol
5889 -ftree-ch @gol
5890 -ftree-copyrename @gol
5891 -ftree-dce @gol
5892 -ftree-dominator-opts @gol
5893 -ftree-dse @gol
5894 -ftree-forwprop @gol
5895 -ftree-fre @gol
5896 -ftree-phiprop @gol
5897 -ftree-sra @gol
5898 -ftree-pta @gol
5899 -ftree-ter @gol
5900 -funit-at-a-time}
5901
5902 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5903 where doing so does not interfere with debugging.
5904
5905 @item -O2
5906 @opindex O2
5907 Optimize even more. GCC performs nearly all supported optimizations
5908 that do not involve a space-speed tradeoff.
5909 As compared to @option{-O}, this option increases both compilation time
5910 and the performance of the generated code.
5911
5912 @option{-O2} turns on all optimization flags specified by @option{-O}. It
5913 also turns on the following optimization flags:
5914 @gccoptlist{-fthread-jumps @gol
5915 -falign-functions -falign-jumps @gol
5916 -falign-loops -falign-labels @gol
5917 -fcaller-saves @gol
5918 -fcrossjumping @gol
5919 -fcse-follow-jumps -fcse-skip-blocks @gol
5920 -fdelete-null-pointer-checks @gol
5921 -fdevirtualize @gol
5922 -fexpensive-optimizations @gol
5923 -fgcse -fgcse-lm @gol
5924 -finline-small-functions @gol
5925 -findirect-inlining @gol
5926 -fipa-sra @gol
5927 -foptimize-sibling-calls @gol
5928 -fpartial-inlining @gol
5929 -fpeephole2 @gol
5930 -fregmove @gol
5931 -freorder-blocks -freorder-functions @gol
5932 -frerun-cse-after-loop @gol
5933 -fsched-interblock -fsched-spec @gol
5934 -fschedule-insns -fschedule-insns2 @gol
5935 -fstrict-aliasing -fstrict-overflow @gol
5936 -ftree-switch-conversion @gol
5937 -ftree-pre @gol
5938 -ftree-vrp}
5939
5940 Please note the warning under @option{-fgcse} about
5941 invoking @option{-O2} on programs that use computed gotos.
5942
5943 @item -O3
5944 @opindex O3
5945 Optimize yet more. @option{-O3} turns on all optimizations specified
5946 by @option{-O2} and also turns on the @option{-finline-functions},
5947 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5948 @option{-fgcse-after-reload}, @option{-ftree-vectorize} and
5949 @option{-fipa-cp-clone} options.
5950
5951 @item -O0
5952 @opindex O0
5953 Reduce compilation time and make debugging produce the expected
5954 results. This is the default.
5955
5956 @item -Os
5957 @opindex Os
5958 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
5959 do not typically increase code size. It also performs further
5960 optimizations designed to reduce code size.
5961
5962 @option{-Os} disables the following optimization flags:
5963 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
5964 -falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
5965 -fprefetch-loop-arrays -ftree-vect-loop-version}
5966
5967 @item -Ofast
5968 @opindex Ofast
5969 Disregard strict standards compliance. @option{-Ofast} enables all
5970 @option{-O3} optimizations. It also enables optimizations that are not
5971 valid for all standard compliant programs.
5972 It turns on @option{-ffast-math}.
5973
5974 If you use multiple @option{-O} options, with or without level numbers,
5975 the last such option is the one that is effective.
5976 @end table
5977
5978 Options of the form @option{-f@var{flag}} specify machine-independent
5979 flags. Most flags have both positive and negative forms; the negative
5980 form of @option{-ffoo} would be @option{-fno-foo}. In the table
5981 below, only one of the forms is listed---the one you typically will
5982 use. You can figure out the other form by either removing @samp{no-}
5983 or adding it.
5984
5985 The following options control specific optimizations. They are either
5986 activated by @option{-O} options or are related to ones that are. You
5987 can use the following flags in the rare cases when ``fine-tuning'' of
5988 optimizations to be performed is desired.
5989
5990 @table @gcctabopt
5991 @item -fno-default-inline
5992 @opindex fno-default-inline
5993 Do not make member functions inline by default merely because they are
5994 defined inside the class scope (C++ only). Otherwise, when you specify
5995 @w{@option{-O}}, member functions defined inside class scope are compiled
5996 inline by default; i.e., you don't need to add @samp{inline} in front of
5997 the member function name.
5998
5999 @item -fno-defer-pop
6000 @opindex fno-defer-pop
6001 Always pop the arguments to each function call as soon as that function
6002 returns. For machines which must pop arguments after a function call,
6003 the compiler normally lets arguments accumulate on the stack for several
6004 function calls and pops them all at once.
6005
6006 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6007
6008 @item -fforward-propagate
6009 @opindex fforward-propagate
6010 Perform a forward propagation pass on RTL@. The pass tries to combine two
6011 instructions and checks if the result can be simplified. If loop unrolling
6012 is active, two passes are performed and the second is scheduled after
6013 loop unrolling.
6014
6015 This option is enabled by default at optimization levels @option{-O},
6016 @option{-O2}, @option{-O3}, @option{-Os}.
6017
6018 @item -ffp-contract=@var{style}
6019 @opindex ffp-contract
6020 @option{-ffp-contract=off} disables floating-point expression contraction.
6021 @option{-ffp-contract=fast} enables floating-point expression contraction
6022 such as forming of fused multiply-add operations if the target has
6023 native support for them.
6024 @option{-ffp-contract=on} enables floating-point expression contraction
6025 if allowed by the language standard. This is currently not implemented
6026 and treated equal to @option{-ffp-contract=off}.
6027
6028 The default is @option{-ffp-contract=fast}.
6029
6030 @item -fomit-frame-pointer
6031 @opindex fomit-frame-pointer
6032 Don't keep the frame pointer in a register for functions that
6033 don't need one. This avoids the instructions to save, set up and
6034 restore frame pointers; it also makes an extra register available
6035 in many functions. @strong{It also makes debugging impossible on
6036 some machines.}
6037
6038 On some machines, such as the VAX, this flag has no effect, because
6039 the standard calling sequence automatically handles the frame pointer
6040 and nothing is saved by pretending it doesn't exist. The
6041 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6042 whether a target machine supports this flag. @xref{Registers,,Register
6043 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6044
6045 Starting with GCC version 4.6, the default setting (when not optimizing for
6046 size) for 32-bit Linux x86 and 32-bit Darwin x86 targets has been changed to
6047 @option{-fomit-frame-pointer}. The default can be reverted to
6048 @option{-fno-omit-frame-pointer} by configuring GCC with the
6049 @option{--enable-frame-pointer} configure option.
6050
6051 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6052
6053 @item -foptimize-sibling-calls
6054 @opindex foptimize-sibling-calls
6055 Optimize sibling and tail recursive calls.
6056
6057 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6058
6059 @item -fno-inline
6060 @opindex fno-inline
6061 Don't pay attention to the @code{inline} keyword. Normally this option
6062 is used to keep the compiler from expanding any functions inline.
6063 Note that if you are not optimizing, no functions can be expanded inline.
6064
6065 @item -finline-small-functions
6066 @opindex finline-small-functions
6067 Integrate functions into their callers when their body is smaller than expected
6068 function call code (so overall size of program gets smaller). The compiler
6069 heuristically decides which functions are simple enough to be worth integrating
6070 in this way.
6071
6072 Enabled at level @option{-O2}.
6073
6074 @item -findirect-inlining
6075 @opindex findirect-inlining
6076 Inline also indirect calls that are discovered to be known at compile
6077 time thanks to previous inlining. This option has any effect only
6078 when inlining itself is turned on by the @option{-finline-functions}
6079 or @option{-finline-small-functions} options.
6080
6081 Enabled at level @option{-O2}.
6082
6083 @item -finline-functions
6084 @opindex finline-functions
6085 Integrate all simple functions into their callers. The compiler
6086 heuristically decides which functions are simple enough to be worth
6087 integrating in this way.
6088
6089 If all calls to a given function are integrated, and the function is
6090 declared @code{static}, then the function is normally not output as
6091 assembler code in its own right.
6092
6093 Enabled at level @option{-O3}.
6094
6095 @item -finline-functions-called-once
6096 @opindex finline-functions-called-once
6097 Consider all @code{static} functions called once for inlining into their
6098 caller even if they are not marked @code{inline}. If a call to a given
6099 function is integrated, then the function is not output as assembler code
6100 in its own right.
6101
6102 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6103
6104 @item -fearly-inlining
6105 @opindex fearly-inlining
6106 Inline functions marked by @code{always_inline} and functions whose body seems
6107 smaller than the function call overhead early before doing
6108 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
6109 makes profiling significantly cheaper and usually inlining faster on programs
6110 having large chains of nested wrapper functions.
6111
6112 Enabled by default.
6113
6114 @item -fipa-sra
6115 @opindex fipa-sra
6116 Perform interprocedural scalar replacement of aggregates, removal of
6117 unused parameters and replacement of parameters passed by reference
6118 by parameters passed by value.
6119
6120 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6121
6122 @item -finline-limit=@var{n}
6123 @opindex finline-limit
6124 By default, GCC limits the size of functions that can be inlined. This flag
6125 allows coarse control of this limit. @var{n} is the size of functions that
6126 can be inlined in number of pseudo instructions.
6127
6128 Inlining is actually controlled by a number of parameters, which may be
6129 specified individually by using @option{--param @var{name}=@var{value}}.
6130 The @option{-finline-limit=@var{n}} option sets some of these parameters
6131 as follows:
6132
6133 @table @gcctabopt
6134 @item max-inline-insns-single
6135 is set to @var{n}/2.
6136 @item max-inline-insns-auto
6137 is set to @var{n}/2.
6138 @end table
6139
6140 See below for a documentation of the individual
6141 parameters controlling inlining and for the defaults of these parameters.
6142
6143 @emph{Note:} there may be no value to @option{-finline-limit} that results
6144 in default behavior.
6145
6146 @emph{Note:} pseudo instruction represents, in this particular context, an
6147 abstract measurement of function's size. In no way does it represent a count
6148 of assembly instructions and as such its exact meaning might change from one
6149 release to an another.
6150
6151 @item -fkeep-inline-functions
6152 @opindex fkeep-inline-functions
6153 In C, emit @code{static} functions that are declared @code{inline}
6154 into the object file, even if the function has been inlined into all
6155 of its callers. This switch does not affect functions using the
6156 @code{extern inline} extension in GNU C90@. In C++, emit any and all
6157 inline functions into the object file.
6158
6159 @item -fkeep-static-consts
6160 @opindex fkeep-static-consts
6161 Emit variables declared @code{static const} when optimization isn't turned
6162 on, even if the variables aren't referenced.
6163
6164 GCC enables this option by default. If you want to force the compiler to
6165 check if the variable was referenced, regardless of whether or not
6166 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6167
6168 @item -fmerge-constants
6169 @opindex fmerge-constants
6170 Attempt to merge identical constants (string constants and floating point
6171 constants) across compilation units.
6172
6173 This option is the default for optimized compilation if the assembler and
6174 linker support it. Use @option{-fno-merge-constants} to inhibit this
6175 behavior.
6176
6177 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6178
6179 @item -fmerge-all-constants
6180 @opindex fmerge-all-constants
6181 Attempt to merge identical constants and identical variables.
6182
6183 This option implies @option{-fmerge-constants}. In addition to
6184 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6185 arrays or initialized constant variables with integral or floating point
6186 types. Languages like C or C++ require each variable, including multiple
6187 instances of the same variable in recursive calls, to have distinct locations,
6188 so using this option will result in non-conforming
6189 behavior.
6190
6191 @item -fmodulo-sched
6192 @opindex fmodulo-sched
6193 Perform swing modulo scheduling immediately before the first scheduling
6194 pass. This pass looks at innermost loops and reorders their
6195 instructions by overlapping different iterations.
6196
6197 @item -fmodulo-sched-allow-regmoves
6198 @opindex fmodulo-sched-allow-regmoves
6199 Perform more aggressive SMS based modulo scheduling with register moves
6200 allowed. By setting this flag certain anti-dependences edges will be
6201 deleted which will trigger the generation of reg-moves based on the
6202 life-range analysis. This option is effective only with
6203 @option{-fmodulo-sched} enabled.
6204
6205 @item -fno-branch-count-reg
6206 @opindex fno-branch-count-reg
6207 Do not use ``decrement and branch'' instructions on a count register,
6208 but instead generate a sequence of instructions that decrement a
6209 register, compare it against zero, then branch based upon the result.
6210 This option is only meaningful on architectures that support such
6211 instructions, which include x86, PowerPC, IA-64 and S/390.
6212
6213 The default is @option{-fbranch-count-reg}.
6214
6215 @item -fno-function-cse
6216 @opindex fno-function-cse
6217 Do not put function addresses in registers; make each instruction that
6218 calls a constant function contain the function's address explicitly.
6219
6220 This option results in less efficient code, but some strange hacks
6221 that alter the assembler output may be confused by the optimizations
6222 performed when this option is not used.
6223
6224 The default is @option{-ffunction-cse}
6225
6226 @item -fno-zero-initialized-in-bss
6227 @opindex fno-zero-initialized-in-bss
6228 If the target supports a BSS section, GCC by default puts variables that
6229 are initialized to zero into BSS@. This can save space in the resulting
6230 code.
6231
6232 This option turns off this behavior because some programs explicitly
6233 rely on variables going to the data section. E.g., so that the
6234 resulting executable can find the beginning of that section and/or make
6235 assumptions based on that.
6236
6237 The default is @option{-fzero-initialized-in-bss}.
6238
6239 @item -fmudflap -fmudflapth -fmudflapir
6240 @opindex fmudflap
6241 @opindex fmudflapth
6242 @opindex fmudflapir
6243 @cindex bounds checking
6244 @cindex mudflap
6245 For front-ends that support it (C and C++), instrument all risky
6246 pointer/array dereferencing operations, some standard library
6247 string/heap functions, and some other associated constructs with
6248 range/validity tests. Modules so instrumented should be immune to
6249 buffer overflows, invalid heap use, and some other classes of C/C++
6250 programming errors. The instrumentation relies on a separate runtime
6251 library (@file{libmudflap}), which will be linked into a program if
6252 @option{-fmudflap} is given at link time. Run-time behavior of the
6253 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6254 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
6255 for its options.
6256
6257 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6258 link if your program is multi-threaded. Use @option{-fmudflapir}, in
6259 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6260 instrumentation should ignore pointer reads. This produces less
6261 instrumentation (and therefore faster execution) and still provides
6262 some protection against outright memory corrupting writes, but allows
6263 erroneously read data to propagate within a program.
6264
6265 @item -fthread-jumps
6266 @opindex fthread-jumps
6267 Perform optimizations where we check to see if a jump branches to a
6268 location where another comparison subsumed by the first is found. If
6269 so, the first branch is redirected to either the destination of the
6270 second branch or a point immediately following it, depending on whether
6271 the condition is known to be true or false.
6272
6273 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6274
6275 @item -fsplit-wide-types
6276 @opindex fsplit-wide-types
6277 When using a type that occupies multiple registers, such as @code{long
6278 long} on a 32-bit system, split the registers apart and allocate them
6279 independently. This normally generates better code for those types,
6280 but may make debugging more difficult.
6281
6282 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6283 @option{-Os}.
6284
6285 @item -fcse-follow-jumps
6286 @opindex fcse-follow-jumps
6287 In common subexpression elimination (CSE), scan through jump instructions
6288 when the target of the jump is not reached by any other path. For
6289 example, when CSE encounters an @code{if} statement with an
6290 @code{else} clause, CSE will follow the jump when the condition
6291 tested is false.
6292
6293 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6294
6295 @item -fcse-skip-blocks
6296 @opindex fcse-skip-blocks
6297 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6298 follow jumps which conditionally skip over blocks. When CSE
6299 encounters a simple @code{if} statement with no else clause,
6300 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6301 body of the @code{if}.
6302
6303 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6304
6305 @item -frerun-cse-after-loop
6306 @opindex frerun-cse-after-loop
6307 Re-run common subexpression elimination after loop optimizations has been
6308 performed.
6309
6310 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6311
6312 @item -fgcse
6313 @opindex fgcse
6314 Perform a global common subexpression elimination pass.
6315 This pass also performs global constant and copy propagation.
6316
6317 @emph{Note:} When compiling a program using computed gotos, a GCC
6318 extension, you may get better runtime performance if you disable
6319 the global common subexpression elimination pass by adding
6320 @option{-fno-gcse} to the command line.
6321
6322 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6323
6324 @item -fgcse-lm
6325 @opindex fgcse-lm
6326 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6327 attempt to move loads which are only killed by stores into themselves. This
6328 allows a loop containing a load/store sequence to be changed to a load outside
6329 the loop, and a copy/store within the loop.
6330
6331 Enabled by default when gcse is enabled.
6332
6333 @item -fgcse-sm
6334 @opindex fgcse-sm
6335 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6336 global common subexpression elimination. This pass will attempt to move
6337 stores out of loops. When used in conjunction with @option{-fgcse-lm},
6338 loops containing a load/store sequence can be changed to a load before
6339 the loop and a store after the loop.
6340
6341 Not enabled at any optimization level.
6342
6343 @item -fgcse-las
6344 @opindex fgcse-las
6345 When @option{-fgcse-las} is enabled, the global common subexpression
6346 elimination pass eliminates redundant loads that come after stores to the
6347 same memory location (both partial and full redundancies).
6348
6349 Not enabled at any optimization level.
6350
6351 @item -fgcse-after-reload
6352 @opindex fgcse-after-reload
6353 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6354 pass is performed after reload. The purpose of this pass is to cleanup
6355 redundant spilling.
6356
6357 @item -funsafe-loop-optimizations
6358 @opindex funsafe-loop-optimizations
6359 If given, the loop optimizer will assume that loop indices do not
6360 overflow, and that the loops with nontrivial exit condition are not
6361 infinite. This enables a wider range of loop optimizations even if
6362 the loop optimizer itself cannot prove that these assumptions are valid.
6363 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6364 if it finds this kind of loop.
6365
6366 @item -fcrossjumping
6367 @opindex fcrossjumping
6368 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
6369 resulting code may or may not perform better than without cross-jumping.
6370
6371 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6372
6373 @item -fauto-inc-dec
6374 @opindex fauto-inc-dec
6375 Combine increments or decrements of addresses with memory accesses.
6376 This pass is always skipped on architectures that do not have
6377 instructions to support this. Enabled by default at @option{-O} and
6378 higher on architectures that support this.
6379
6380 @item -fdce
6381 @opindex fdce
6382 Perform dead code elimination (DCE) on RTL@.
6383 Enabled by default at @option{-O} and higher.
6384
6385 @item -fdse
6386 @opindex fdse
6387 Perform dead store elimination (DSE) on RTL@.
6388 Enabled by default at @option{-O} and higher.
6389
6390 @item -fif-conversion
6391 @opindex fif-conversion
6392 Attempt to transform conditional jumps into branch-less equivalents. This
6393 include use of conditional moves, min, max, set flags and abs instructions, and
6394 some tricks doable by standard arithmetics. The use of conditional execution
6395 on chips where it is available is controlled by @code{if-conversion2}.
6396
6397 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6398
6399 @item -fif-conversion2
6400 @opindex fif-conversion2
6401 Use conditional execution (where available) to transform conditional jumps into
6402 branch-less equivalents.
6403
6404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6405
6406 @item -fdelete-null-pointer-checks
6407 @opindex fdelete-null-pointer-checks
6408 Assume that programs cannot safely dereference null pointers, and that
6409 no code or data element resides there. This enables simple constant
6410 folding optimizations at all optimization levels. In addition, other
6411 optimization passes in GCC use this flag to control global dataflow
6412 analyses that eliminate useless checks for null pointers; these assume
6413 that if a pointer is checked after it has already been dereferenced,
6414 it cannot be null.
6415
6416 Note however that in some environments this assumption is not true.
6417 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6418 for programs which depend on that behavior.
6419
6420 Some targets, especially embedded ones, disable this option at all levels.
6421 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6422 @option{-O2}, @option{-O3}, @option{-Os}. Passes that use the information
6423 are enabled independently at different optimization levels.
6424
6425 @item -fdevirtualize
6426 @opindex fdevirtualize
6427 Attempt to convert calls to virtual functions to direct calls. This
6428 is done both within a procedure and interprocedurally as part of
6429 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6430 propagation (@option{-fipa-cp}).
6431 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6432
6433 @item -fexpensive-optimizations
6434 @opindex fexpensive-optimizations
6435 Perform a number of minor optimizations that are relatively expensive.
6436
6437 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6438
6439 @item -foptimize-register-move
6440 @itemx -fregmove
6441 @opindex foptimize-register-move
6442 @opindex fregmove
6443 Attempt to reassign register numbers in move instructions and as
6444 operands of other simple instructions in order to maximize the amount of
6445 register tying. This is especially helpful on machines with two-operand
6446 instructions.
6447
6448 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6449 optimization.
6450
6451 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6452
6453 @item -fira-algorithm=@var{algorithm}
6454 Use specified coloring algorithm for the integrated register
6455 allocator. The @var{algorithm} argument should be @code{priority} or
6456 @code{CB}. The first algorithm specifies Chow's priority coloring,
6457 the second one specifies Chaitin-Briggs coloring. The second
6458 algorithm can be unimplemented for some architectures. If it is
6459 implemented, it is the default because Chaitin-Briggs coloring as a
6460 rule generates a better code.
6461
6462 @item -fira-region=@var{region}
6463 Use specified regions for the integrated register allocator. The
6464 @var{region} argument should be one of @code{all}, @code{mixed}, or
6465 @code{one}. The first value means using all loops as register
6466 allocation regions, the second value which is the default means using
6467 all loops except for loops with small register pressure as the
6468 regions, and third one means using all function as a single region.
6469 The first value can give best result for machines with small size and
6470 irregular register set, the third one results in faster and generates
6471 decent code and the smallest size code, and the default value usually
6472 give the best results in most cases and for most architectures.
6473
6474 @item -fira-loop-pressure
6475 @opindex fira-loop-pressure
6476 Use IRA to evaluate register pressure in loops for decision to move
6477 loop invariants. Usage of this option usually results in generation
6478 of faster and smaller code on machines with big register files (>= 32
6479 registers) but it can slow compiler down.
6480
6481 This option is enabled at level @option{-O3} for some targets.
6482
6483 @item -fno-ira-share-save-slots
6484 @opindex fno-ira-share-save-slots
6485 Switch off sharing stack slots used for saving call used hard
6486 registers living through a call. Each hard register will get a
6487 separate stack slot and as a result function stack frame will be
6488 bigger.
6489
6490 @item -fno-ira-share-spill-slots
6491 @opindex fno-ira-share-spill-slots
6492 Switch off sharing stack slots allocated for pseudo-registers. Each
6493 pseudo-register which did not get a hard register will get a separate
6494 stack slot and as a result function stack frame will be bigger.
6495
6496 @item -fira-verbose=@var{n}
6497 @opindex fira-verbose
6498 Set up how verbose dump file for the integrated register allocator
6499 will be. Default value is 5. If the value is greater or equal to 10,
6500 the dump file will be stderr as if the value were @var{n} minus 10.
6501
6502 @item -fdelayed-branch
6503 @opindex fdelayed-branch
6504 If supported for the target machine, attempt to reorder instructions
6505 to exploit instruction slots available after delayed branch
6506 instructions.
6507
6508 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6509
6510 @item -fschedule-insns
6511 @opindex fschedule-insns
6512 If supported for the target machine, attempt to reorder instructions to
6513 eliminate execution stalls due to required data being unavailable. This
6514 helps machines that have slow floating point or memory load instructions
6515 by allowing other instructions to be issued until the result of the load
6516 or floating point instruction is required.
6517
6518 Enabled at levels @option{-O2}, @option{-O3}.
6519
6520 @item -fschedule-insns2
6521 @opindex fschedule-insns2
6522 Similar to @option{-fschedule-insns}, but requests an additional pass of
6523 instruction scheduling after register allocation has been done. This is
6524 especially useful on machines with a relatively small number of
6525 registers and where memory load instructions take more than one cycle.
6526
6527 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6528
6529 @item -fno-sched-interblock
6530 @opindex fno-sched-interblock
6531 Don't schedule instructions across basic blocks. This is normally
6532 enabled by default when scheduling before register allocation, i.e.@:
6533 with @option{-fschedule-insns} or at @option{-O2} or higher.
6534
6535 @item -fno-sched-spec
6536 @opindex fno-sched-spec
6537 Don't allow speculative motion of non-load instructions. This is normally
6538 enabled by default when scheduling before register allocation, i.e.@:
6539 with @option{-fschedule-insns} or at @option{-O2} or higher.
6540
6541 @item -fsched-pressure
6542 @opindex fsched-pressure
6543 Enable register pressure sensitive insn scheduling before the register
6544 allocation. This only makes sense when scheduling before register
6545 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6546 @option{-O2} or higher. Usage of this option can improve the
6547 generated code and decrease its size by preventing register pressure
6548 increase above the number of available hard registers and as a
6549 consequence register spills in the register allocation.
6550
6551 @item -fsched-spec-load
6552 @opindex fsched-spec-load
6553 Allow speculative motion of some load instructions. This only makes
6554 sense when scheduling before register allocation, i.e.@: with
6555 @option{-fschedule-insns} or at @option{-O2} or higher.
6556
6557 @item -fsched-spec-load-dangerous
6558 @opindex fsched-spec-load-dangerous
6559 Allow speculative motion of more load instructions. This only makes
6560 sense when scheduling before register allocation, i.e.@: with
6561 @option{-fschedule-insns} or at @option{-O2} or higher.
6562
6563 @item -fsched-stalled-insns
6564 @itemx -fsched-stalled-insns=@var{n}
6565 @opindex fsched-stalled-insns
6566 Define how many insns (if any) can be moved prematurely from the queue
6567 of stalled insns into the ready list, during the second scheduling pass.
6568 @option{-fno-sched-stalled-insns} means that no insns will be moved
6569 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6570 on how many queued insns can be moved prematurely.
6571 @option{-fsched-stalled-insns} without a value is equivalent to
6572 @option{-fsched-stalled-insns=1}.
6573
6574 @item -fsched-stalled-insns-dep
6575 @itemx -fsched-stalled-insns-dep=@var{n}
6576 @opindex fsched-stalled-insns-dep
6577 Define how many insn groups (cycles) will be examined for a dependency
6578 on a stalled insn that is candidate for premature removal from the queue
6579 of stalled insns. This has an effect only during the second scheduling pass,
6580 and only if @option{-fsched-stalled-insns} is used.
6581 @option{-fno-sched-stalled-insns-dep} is equivalent to
6582 @option{-fsched-stalled-insns-dep=0}.
6583 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6584 @option{-fsched-stalled-insns-dep=1}.
6585
6586 @item -fsched2-use-superblocks
6587 @opindex fsched2-use-superblocks
6588 When scheduling after register allocation, do use superblock scheduling
6589 algorithm. Superblock scheduling allows motion across basic block boundaries
6590 resulting on faster schedules. This option is experimental, as not all machine
6591 descriptions used by GCC model the CPU closely enough to avoid unreliable
6592 results from the algorithm.
6593
6594 This only makes sense when scheduling after register allocation, i.e.@: with
6595 @option{-fschedule-insns2} or at @option{-O2} or higher.
6596
6597 @item -fsched-group-heuristic
6598 @opindex fsched-group-heuristic
6599 Enable the group heuristic in the scheduler. This heuristic favors
6600 the instruction that belongs to a schedule group. This is enabled
6601 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6602 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6603
6604 @item -fsched-critical-path-heuristic
6605 @opindex fsched-critical-path-heuristic
6606 Enable the critical-path heuristic in the scheduler. This heuristic favors
6607 instructions on the critical path. This is enabled by default when
6608 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6609 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6610
6611 @item -fsched-spec-insn-heuristic
6612 @opindex fsched-spec-insn-heuristic
6613 Enable the speculative instruction heuristic in the scheduler. This
6614 heuristic favors speculative instructions with greater dependency weakness.
6615 This is enabled by default when scheduling is enabled, i.e.@:
6616 with @option{-fschedule-insns} or @option{-fschedule-insns2}
6617 or at @option{-O2} or higher.
6618
6619 @item -fsched-rank-heuristic
6620 @opindex fsched-rank-heuristic
6621 Enable the rank heuristic in the scheduler. This heuristic favors
6622 the instruction belonging to a basic block with greater size or frequency.
6623 This is enabled by default when scheduling is enabled, i.e.@:
6624 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6625 at @option{-O2} or higher.
6626
6627 @item -fsched-last-insn-heuristic
6628 @opindex fsched-last-insn-heuristic
6629 Enable the last-instruction heuristic in the scheduler. This heuristic
6630 favors the instruction that is less dependent on the last instruction
6631 scheduled. This is enabled by default when scheduling is enabled,
6632 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6633 at @option{-O2} or higher.
6634
6635 @item -fsched-dep-count-heuristic
6636 @opindex fsched-dep-count-heuristic
6637 Enable the dependent-count heuristic in the scheduler. This heuristic
6638 favors the instruction that has more instructions depending on it.
6639 This is enabled by default when scheduling is enabled, i.e.@:
6640 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6641 at @option{-O2} or higher.
6642
6643 @item -freschedule-modulo-scheduled-loops
6644 @opindex freschedule-modulo-scheduled-loops
6645 The modulo scheduling comes before the traditional scheduling, if a loop
6646 was modulo scheduled we may want to prevent the later scheduling passes
6647 from changing its schedule, we use this option to control that.
6648
6649 @item -fselective-scheduling
6650 @opindex fselective-scheduling
6651 Schedule instructions using selective scheduling algorithm. Selective
6652 scheduling runs instead of the first scheduler pass.
6653
6654 @item -fselective-scheduling2
6655 @opindex fselective-scheduling2
6656 Schedule instructions using selective scheduling algorithm. Selective
6657 scheduling runs instead of the second scheduler pass.
6658
6659 @item -fsel-sched-pipelining
6660 @opindex fsel-sched-pipelining
6661 Enable software pipelining of innermost loops during selective scheduling.
6662 This option has no effect until one of @option{-fselective-scheduling} or
6663 @option{-fselective-scheduling2} is turned on.
6664
6665 @item -fsel-sched-pipelining-outer-loops
6666 @opindex fsel-sched-pipelining-outer-loops
6667 When pipelining loops during selective scheduling, also pipeline outer loops.
6668 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6669
6670 @item -fcaller-saves
6671 @opindex fcaller-saves
6672 Enable values to be allocated in registers that will be clobbered by
6673 function calls, by emitting extra instructions to save and restore the
6674 registers around such calls. Such allocation is done only when it
6675 seems to result in better code than would otherwise be produced.
6676
6677 This option is always enabled by default on certain machines, usually
6678 those which have no call-preserved registers to use instead.
6679
6680 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6681
6682 @item -fcombine-stack-adjustments
6683 @opindex fcombine-stack-adjustments
6684 Tracks stack adjustments (pushes and pops) and stack memory references
6685 and then tries to find ways to combine them.
6686
6687 Enabled by default at @option{-O1} and higher.
6688
6689 @item -fconserve-stack
6690 @opindex fconserve-stack
6691 Attempt to minimize stack usage. The compiler will attempt to use less
6692 stack space, even if that makes the program slower. This option
6693 implies setting the @option{large-stack-frame} parameter to 100
6694 and the @option{large-stack-frame-growth} parameter to 400.
6695
6696 @item -ftree-reassoc
6697 @opindex ftree-reassoc
6698 Perform reassociation on trees. This flag is enabled by default
6699 at @option{-O} and higher.
6700
6701 @item -ftree-pre
6702 @opindex ftree-pre
6703 Perform partial redundancy elimination (PRE) on trees. This flag is
6704 enabled by default at @option{-O2} and @option{-O3}.
6705
6706 @item -ftree-forwprop
6707 @opindex ftree-forwprop
6708 Perform forward propagation on trees. This flag is enabled by default
6709 at @option{-O} and higher.
6710
6711 @item -ftree-fre
6712 @opindex ftree-fre
6713 Perform full redundancy elimination (FRE) on trees. The difference
6714 between FRE and PRE is that FRE only considers expressions
6715 that are computed on all paths leading to the redundant computation.
6716 This analysis is faster than PRE, though it exposes fewer redundancies.
6717 This flag is enabled by default at @option{-O} and higher.
6718
6719 @item -ftree-phiprop
6720 @opindex ftree-phiprop
6721 Perform hoisting of loads from conditional pointers on trees. This
6722 pass is enabled by default at @option{-O} and higher.
6723
6724 @item -ftree-copy-prop
6725 @opindex ftree-copy-prop
6726 Perform copy propagation on trees. This pass eliminates unnecessary
6727 copy operations. This flag is enabled by default at @option{-O} and
6728 higher.
6729
6730 @item -fipa-pure-const
6731 @opindex fipa-pure-const
6732 Discover which functions are pure or constant.
6733 Enabled by default at @option{-O} and higher.
6734
6735 @item -fipa-reference
6736 @opindex fipa-reference
6737 Discover which static variables do not escape cannot escape the
6738 compilation unit.
6739 Enabled by default at @option{-O} and higher.
6740
6741 @item -fipa-struct-reorg
6742 @opindex fipa-struct-reorg
6743 Perform structure reorganization optimization, that change C-like structures
6744 layout in order to better utilize spatial locality. This transformation is
6745 affective for programs containing arrays of structures. Available in two
6746 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6747 or static (which uses built-in heuristics). It works only in whole program
6748 mode, so it requires @option{-fwhole-program} to be
6749 enabled. Structures considered @samp{cold} by this transformation are not
6750 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6751
6752 With this flag, the program debug info reflects a new structure layout.
6753
6754 @item -fipa-pta
6755 @opindex fipa-pta
6756 Perform interprocedural pointer analysis and interprocedural modification
6757 and reference analysis. This option can cause excessive memory and
6758 compile-time usage on large compilation units. It is not enabled by
6759 default at any optimization level.
6760
6761 @item -fipa-profile
6762 @opindex fipa-profile
6763 Perform interprocedural profile propagation. The functions called only from
6764 cold functions are marked as cold. Also functions executed once (such as
6765 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6766 functions and loop less parts of functions executed once are then optimized for
6767 size.
6768 Enabled by default at @option{-O} and higher.
6769
6770 @item -fipa-cp
6771 @opindex fipa-cp
6772 Perform interprocedural constant propagation.
6773 This optimization analyzes the program to determine when values passed
6774 to functions are constants and then optimizes accordingly.
6775 This optimization can substantially increase performance
6776 if the application has constants passed to functions.
6777 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6778
6779 @item -fipa-cp-clone
6780 @opindex fipa-cp-clone
6781 Perform function cloning to make interprocedural constant propagation stronger.
6782 When enabled, interprocedural constant propagation will perform function cloning
6783 when externally visible function can be called with constant arguments.
6784 Because this optimization can create multiple copies of functions,
6785 it may significantly increase code size
6786 (see @option{--param ipcp-unit-growth=@var{value}}).
6787 This flag is enabled by default at @option{-O3}.
6788
6789 @item -fipa-matrix-reorg
6790 @opindex fipa-matrix-reorg
6791 Perform matrix flattening and transposing.
6792 Matrix flattening tries to replace an @math{m}-dimensional matrix
6793 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6794 This reduces the level of indirection needed for accessing the elements
6795 of the matrix. The second optimization is matrix transposing that
6796 attempts to change the order of the matrix's dimensions in order to
6797 improve cache locality.
6798 Both optimizations need the @option{-fwhole-program} flag.
6799 Transposing is enabled only if profiling information is available.
6800
6801 @item -ftree-sink
6802 @opindex ftree-sink
6803 Perform forward store motion on trees. This flag is
6804 enabled by default at @option{-O} and higher.
6805
6806 @item -ftree-bit-ccp
6807 @opindex ftree-bit-ccp
6808 Perform sparse conditional bit constant propagation on trees and propagate
6809 pointer alignment information.
6810 This pass only operates on local scalar variables and is enabled by default
6811 at @option{-O} and higher. It requires that @option{-ftree-ccp} is enabled.
6812
6813 @item -ftree-ccp
6814 @opindex ftree-ccp
6815 Perform sparse conditional constant propagation (CCP) on trees. This
6816 pass only operates on local scalar variables and is enabled by default
6817 at @option{-O} and higher.
6818
6819 @item -ftree-switch-conversion
6820 Perform conversion of simple initializations in a switch to
6821 initializations from a scalar array. This flag is enabled by default
6822 at @option{-O2} and higher.
6823
6824 @item -ftree-dce
6825 @opindex ftree-dce
6826 Perform dead code elimination (DCE) on trees. This flag is enabled by
6827 default at @option{-O} and higher.
6828
6829 @item -ftree-builtin-call-dce
6830 @opindex ftree-builtin-call-dce
6831 Perform conditional dead code elimination (DCE) for calls to builtin functions
6832 that may set @code{errno} but are otherwise side-effect free. This flag is
6833 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6834 specified.
6835
6836 @item -ftree-dominator-opts
6837 @opindex ftree-dominator-opts
6838 Perform a variety of simple scalar cleanups (constant/copy
6839 propagation, redundancy elimination, range propagation and expression
6840 simplification) based on a dominator tree traversal. This also
6841 performs jump threading (to reduce jumps to jumps). This flag is
6842 enabled by default at @option{-O} and higher.
6843
6844 @item -ftree-dse
6845 @opindex ftree-dse
6846 Perform dead store elimination (DSE) on trees. A dead store is a store into
6847 a memory location which will later be overwritten by another store without
6848 any intervening loads. In this case the earlier store can be deleted. This
6849 flag is enabled by default at @option{-O} and higher.
6850
6851 @item -ftree-ch
6852 @opindex ftree-ch
6853 Perform loop header copying on trees. This is beneficial since it increases
6854 effectiveness of code motion optimizations. It also saves one jump. This flag
6855 is enabled by default at @option{-O} and higher. It is not enabled
6856 for @option{-Os}, since it usually increases code size.
6857
6858 @item -ftree-loop-optimize
6859 @opindex ftree-loop-optimize
6860 Perform loop optimizations on trees. This flag is enabled by default
6861 at @option{-O} and higher.
6862
6863 @item -ftree-loop-linear
6864 @opindex ftree-loop-linear
6865 Perform linear loop transformations on tree. This flag can improve cache
6866 performance and allow further loop optimizations to take place.
6867
6868 @item -floop-interchange
6869 @opindex floop-interchange
6870 Perform loop interchange transformations on loops. Interchanging two
6871 nested loops switches the inner and outer loops. For example, given a
6872 loop like:
6873 @smallexample
6874 DO J = 1, M
6875 DO I = 1, N
6876 A(J, I) = A(J, I) * C
6877 ENDDO
6878 ENDDO
6879 @end smallexample
6880 loop interchange will transform the loop as if the user had written:
6881 @smallexample
6882 DO I = 1, N
6883 DO J = 1, M
6884 A(J, I) = A(J, I) * C
6885 ENDDO
6886 ENDDO
6887 @end smallexample
6888 which can be beneficial when @code{N} is larger than the caches,
6889 because in Fortran, the elements of an array are stored in memory
6890 contiguously by column, and the original loop iterates over rows,
6891 potentially creating at each access a cache miss. This optimization
6892 applies to all the languages supported by GCC and is not limited to
6893 Fortran. To use this code transformation, GCC has to be configured
6894 with @option{--with-ppl} and @option{--with-cloog} to enable the
6895 Graphite loop transformation infrastructure.
6896
6897 @item -floop-strip-mine
6898 @opindex floop-strip-mine
6899 Perform loop strip mining transformations on loops. Strip mining
6900 splits a loop into two nested loops. The outer loop has strides
6901 equal to the strip size and the inner loop has strides of the
6902 original loop within a strip. The strip length can be changed
6903 using the @option{loop-block-tile-size} parameter. For example,
6904 given a loop like:
6905 @smallexample
6906 DO I = 1, N
6907 A(I) = A(I) + C
6908 ENDDO
6909 @end smallexample
6910 loop strip mining will transform the loop as if the user had written:
6911 @smallexample
6912 DO II = 1, N, 51
6913 DO I = II, min (II + 50, N)
6914 A(I) = A(I) + C
6915 ENDDO
6916 ENDDO
6917 @end smallexample
6918 This optimization applies to all the languages supported by GCC and is
6919 not limited to Fortran. To use this code transformation, GCC has to
6920 be configured with @option{--with-ppl} and @option{--with-cloog} to
6921 enable the Graphite loop transformation infrastructure.
6922
6923 @item -floop-block
6924 @opindex floop-block
6925 Perform loop blocking transformations on loops. Blocking strip mines
6926 each loop in the loop nest such that the memory accesses of the
6927 element loops fit inside caches. The strip length can be changed
6928 using the @option{loop-block-tile-size} parameter. For example, given
6929 a loop like:
6930 @smallexample
6931 DO I = 1, N
6932 DO J = 1, M
6933 A(J, I) = B(I) + C(J)
6934 ENDDO
6935 ENDDO
6936 @end smallexample
6937 loop blocking will transform the loop as if the user had written:
6938 @smallexample
6939 DO II = 1, N, 51
6940 DO JJ = 1, M, 51
6941 DO I = II, min (II + 50, N)
6942 DO J = JJ, min (JJ + 50, M)
6943 A(J, I) = B(I) + C(J)
6944 ENDDO
6945 ENDDO
6946 ENDDO
6947 ENDDO
6948 @end smallexample
6949 which can be beneficial when @code{M} is larger than the caches,
6950 because the innermost loop will iterate over a smaller amount of data
6951 that can be kept in the caches. This optimization applies to all the
6952 languages supported by GCC and is not limited to Fortran. To use this
6953 code transformation, GCC has to be configured with @option{--with-ppl}
6954 and @option{--with-cloog} to enable the Graphite loop transformation
6955 infrastructure.
6956
6957 @item -fgraphite-identity
6958 @opindex fgraphite-identity
6959 Enable the identity transformation for graphite. For every SCoP we generate
6960 the polyhedral representation and transform it back to gimple. Using
6961 @option{-fgraphite-identity} we can check the costs or benefits of the
6962 GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations
6963 are also performed by the code generator CLooG, like index splitting and
6964 dead code elimination in loops.
6965
6966 @item -floop-flatten
6967 @opindex floop-flatten
6968 Removes the loop nesting structure: transforms the loop nest into a
6969 single loop. This transformation can be useful to vectorize all the
6970 levels of the loop nest.
6971
6972 @item -floop-parallelize-all
6973 @opindex floop-parallelize-all
6974 Use the Graphite data dependence analysis to identify loops that can
6975 be parallelized. Parallelize all the loops that can be analyzed to
6976 not contain loop carried dependences without checking that it is
6977 profitable to parallelize the loops.
6978
6979 @item -fcheck-data-deps
6980 @opindex fcheck-data-deps
6981 Compare the results of several data dependence analyzers. This option
6982 is used for debugging the data dependence analyzers.
6983
6984 @item -ftree-loop-if-convert
6985 Attempt to transform conditional jumps in the innermost loops to
6986 branch-less equivalents. The intent is to remove control-flow from
6987 the innermost loops in order to improve the ability of the
6988 vectorization pass to handle these loops. This is enabled by default
6989 if vectorization is enabled.
6990
6991 @item -ftree-loop-if-convert-stores
6992 Attempt to also if-convert conditional jumps containing memory writes.
6993 This transformation can be unsafe for multi-threaded programs as it
6994 transforms conditional memory writes into unconditional memory writes.
6995 For example,
6996 @smallexample
6997 for (i = 0; i < N; i++)
6998 if (cond)
6999 A[i] = expr;
7000 @end smallexample
7001 would be transformed to
7002 @smallexample
7003 for (i = 0; i < N; i++)
7004 A[i] = cond ? expr : A[i];
7005 @end smallexample
7006 potentially producing data races.
7007
7008 @item -ftree-loop-distribution
7009 Perform loop distribution. This flag can improve cache performance on
7010 big loop bodies and allow further loop optimizations, like
7011 parallelization or vectorization, to take place. For example, the loop
7012 @smallexample
7013 DO I = 1, N
7014 A(I) = B(I) + C
7015 D(I) = E(I) * F
7016 ENDDO
7017 @end smallexample
7018 is transformed to
7019 @smallexample
7020 DO I = 1, N
7021 A(I) = B(I) + C
7022 ENDDO
7023 DO I = 1, N
7024 D(I) = E(I) * F
7025 ENDDO
7026 @end smallexample
7027
7028 @item -ftree-loop-distribute-patterns
7029 Perform loop distribution of patterns that can be code generated with
7030 calls to a library. This flag is enabled by default at @option{-O3}.
7031
7032 This pass distributes the initialization loops and generates a call to
7033 memset zero. For example, the loop
7034 @smallexample
7035 DO I = 1, N
7036 A(I) = 0
7037 B(I) = A(I) + I
7038 ENDDO
7039 @end smallexample
7040 is transformed to
7041 @smallexample
7042 DO I = 1, N
7043 A(I) = 0
7044 ENDDO
7045 DO I = 1, N
7046 B(I) = A(I) + I
7047 ENDDO
7048 @end smallexample
7049 and the initialization loop is transformed into a call to memset zero.
7050
7051 @item -ftree-loop-im
7052 @opindex ftree-loop-im
7053 Perform loop invariant motion on trees. This pass moves only invariants that
7054 would be hard to handle at RTL level (function calls, operations that expand to
7055 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
7056 operands of conditions that are invariant out of the loop, so that we can use
7057 just trivial invariantness analysis in loop unswitching. The pass also includes
7058 store motion.
7059
7060 @item -ftree-loop-ivcanon
7061 @opindex ftree-loop-ivcanon
7062 Create a canonical counter for number of iterations in the loop for that
7063 determining number of iterations requires complicated analysis. Later
7064 optimizations then may determine the number easily. Useful especially
7065 in connection with unrolling.
7066
7067 @item -fivopts
7068 @opindex fivopts
7069 Perform induction variable optimizations (strength reduction, induction
7070 variable merging and induction variable elimination) on trees.
7071
7072 @item -ftree-parallelize-loops=n
7073 @opindex ftree-parallelize-loops
7074 Parallelize loops, i.e., split their iteration space to run in n threads.
7075 This is only possible for loops whose iterations are independent
7076 and can be arbitrarily reordered. The optimization is only
7077 profitable on multiprocessor machines, for loops that are CPU-intensive,
7078 rather than constrained e.g.@: by memory bandwidth. This option
7079 implies @option{-pthread}, and thus is only supported on targets
7080 that have support for @option{-pthread}.
7081
7082 @item -ftree-pta
7083 @opindex ftree-pta
7084 Perform function-local points-to analysis on trees. This flag is
7085 enabled by default at @option{-O} and higher.
7086
7087 @item -ftree-sra
7088 @opindex ftree-sra
7089 Perform scalar replacement of aggregates. This pass replaces structure
7090 references with scalars to prevent committing structures to memory too
7091 early. This flag is enabled by default at @option{-O} and higher.
7092
7093 @item -ftree-copyrename
7094 @opindex ftree-copyrename
7095 Perform copy renaming on trees. This pass attempts to rename compiler
7096 temporaries to other variables at copy locations, usually resulting in
7097 variable names which more closely resemble the original variables. This flag
7098 is enabled by default at @option{-O} and higher.
7099
7100 @item -ftree-ter
7101 @opindex ftree-ter
7102 Perform temporary expression replacement during the SSA->normal phase. Single
7103 use/single def temporaries are replaced at their use location with their
7104 defining expression. This results in non-GIMPLE code, but gives the expanders
7105 much more complex trees to work on resulting in better RTL generation. This is
7106 enabled by default at @option{-O} and higher.
7107
7108 @item -ftree-vectorize
7109 @opindex ftree-vectorize
7110 Perform loop vectorization on trees. This flag is enabled by default at
7111 @option{-O3}.
7112
7113 @item -ftree-slp-vectorize
7114 @opindex ftree-slp-vectorize
7115 Perform basic block vectorization on trees. This flag is enabled by default at
7116 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7117
7118 @item -ftree-vect-loop-version
7119 @opindex ftree-vect-loop-version
7120 Perform loop versioning when doing loop vectorization on trees. When a loop
7121 appears to be vectorizable except that data alignment or data dependence cannot
7122 be determined at compile time then vectorized and non-vectorized versions of
7123 the loop are generated along with runtime checks for alignment or dependence
7124 to control which version is executed. This option is enabled by default
7125 except at level @option{-Os} where it is disabled.
7126
7127 @item -fvect-cost-model
7128 @opindex fvect-cost-model
7129 Enable cost model for vectorization.
7130
7131 @item -ftree-vrp
7132 @opindex ftree-vrp
7133 Perform Value Range Propagation on trees. This is similar to the
7134 constant propagation pass, but instead of values, ranges of values are
7135 propagated. This allows the optimizers to remove unnecessary range
7136 checks like array bound checks and null pointer checks. This is
7137 enabled by default at @option{-O2} and higher. Null pointer check
7138 elimination is only done if @option{-fdelete-null-pointer-checks} is
7139 enabled.
7140
7141 @item -ftracer
7142 @opindex ftracer
7143 Perform tail duplication to enlarge superblock size. This transformation
7144 simplifies the control flow of the function allowing other optimizations to do
7145 better job.
7146
7147 @item -funroll-loops
7148 @opindex funroll-loops
7149 Unroll loops whose number of iterations can be determined at compile
7150 time or upon entry to the loop. @option{-funroll-loops} implies
7151 @option{-frerun-cse-after-loop}. This option makes code larger,
7152 and may or may not make it run faster.
7153
7154 @item -funroll-all-loops
7155 @opindex funroll-all-loops
7156 Unroll all loops, even if their number of iterations is uncertain when
7157 the loop is entered. This usually makes programs run more slowly.
7158 @option{-funroll-all-loops} implies the same options as
7159 @option{-funroll-loops},
7160
7161 @item -fsplit-ivs-in-unroller
7162 @opindex fsplit-ivs-in-unroller
7163 Enables expressing of values of induction variables in later iterations
7164 of the unrolled loop using the value in the first iteration. This breaks
7165 long dependency chains, thus improving efficiency of the scheduling passes.
7166
7167 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7168 same effect. However in cases the loop body is more complicated than
7169 a single basic block, this is not reliable. It also does not work at all
7170 on some of the architectures due to restrictions in the CSE pass.
7171
7172 This optimization is enabled by default.
7173
7174 @item -fvariable-expansion-in-unroller
7175 @opindex fvariable-expansion-in-unroller
7176 With this option, the compiler will create multiple copies of some
7177 local variables when unrolling a loop which can result in superior code.
7178
7179 @item -fpartial-inlining
7180 @opindex fpartial-inlining
7181 Inline parts of functions. This option has any effect only
7182 when inlining itself is turned on by the @option{-finline-functions}
7183 or @option{-finline-small-functions} options.
7184
7185 Enabled at level @option{-O2}.
7186
7187 @item -fpredictive-commoning
7188 @opindex fpredictive-commoning
7189 Perform predictive commoning optimization, i.e., reusing computations
7190 (especially memory loads and stores) performed in previous
7191 iterations of loops.
7192
7193 This option is enabled at level @option{-O3}.
7194
7195 @item -fprefetch-loop-arrays
7196 @opindex fprefetch-loop-arrays
7197 If supported by the target machine, generate instructions to prefetch
7198 memory to improve the performance of loops that access large arrays.
7199
7200 This option may generate better or worse code; results are highly
7201 dependent on the structure of loops within the source code.
7202
7203 Disabled at level @option{-Os}.
7204
7205 @item -fno-peephole
7206 @itemx -fno-peephole2
7207 @opindex fno-peephole
7208 @opindex fno-peephole2
7209 Disable any machine-specific peephole optimizations. The difference
7210 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7211 are implemented in the compiler; some targets use one, some use the
7212 other, a few use both.
7213
7214 @option{-fpeephole} is enabled by default.
7215 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7216
7217 @item -fno-guess-branch-probability
7218 @opindex fno-guess-branch-probability
7219 Do not guess branch probabilities using heuristics.
7220
7221 GCC will use heuristics to guess branch probabilities if they are
7222 not provided by profiling feedback (@option{-fprofile-arcs}). These
7223 heuristics are based on the control flow graph. If some branch probabilities
7224 are specified by @samp{__builtin_expect}, then the heuristics will be
7225 used to guess branch probabilities for the rest of the control flow graph,
7226 taking the @samp{__builtin_expect} info into account. The interactions
7227 between the heuristics and @samp{__builtin_expect} can be complex, and in
7228 some cases, it may be useful to disable the heuristics so that the effects
7229 of @samp{__builtin_expect} are easier to understand.
7230
7231 The default is @option{-fguess-branch-probability} at levels
7232 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7233
7234 @item -freorder-blocks
7235 @opindex freorder-blocks
7236 Reorder basic blocks in the compiled function in order to reduce number of
7237 taken branches and improve code locality.
7238
7239 Enabled at levels @option{-O2}, @option{-O3}.
7240
7241 @item -freorder-blocks-and-partition
7242 @opindex freorder-blocks-and-partition
7243 In addition to reordering basic blocks in the compiled function, in order
7244 to reduce number of taken branches, partitions hot and cold basic blocks
7245 into separate sections of the assembly and .o files, to improve
7246 paging and cache locality performance.
7247
7248 This optimization is automatically turned off in the presence of
7249 exception handling, for linkonce sections, for functions with a user-defined
7250 section attribute and on any architecture that does not support named
7251 sections.
7252
7253 @item -freorder-functions
7254 @opindex freorder-functions
7255 Reorder functions in the object file in order to
7256 improve code locality. This is implemented by using special
7257 subsections @code{.text.hot} for most frequently executed functions and
7258 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
7259 the linker so object file format must support named sections and linker must
7260 place them in a reasonable way.
7261
7262 Also profile feedback must be available in to make this option effective. See
7263 @option{-fprofile-arcs} for details.
7264
7265 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7266
7267 @item -fstrict-aliasing
7268 @opindex fstrict-aliasing
7269 Allow the compiler to assume the strictest aliasing rules applicable to
7270 the language being compiled. For C (and C++), this activates
7271 optimizations based on the type of expressions. In particular, an
7272 object of one type is assumed never to reside at the same address as an
7273 object of a different type, unless the types are almost the same. For
7274 example, an @code{unsigned int} can alias an @code{int}, but not a
7275 @code{void*} or a @code{double}. A character type may alias any other
7276 type.
7277
7278 @anchor{Type-punning}Pay special attention to code like this:
7279 @smallexample
7280 union a_union @{
7281 int i;
7282 double d;
7283 @};
7284
7285 int f() @{
7286 union a_union t;
7287 t.d = 3.0;
7288 return t.i;
7289 @}
7290 @end smallexample
7291 The practice of reading from a different union member than the one most
7292 recently written to (called ``type-punning'') is common. Even with
7293 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7294 is accessed through the union type. So, the code above will work as
7295 expected. @xref{Structures unions enumerations and bit-fields
7296 implementation}. However, this code might not:
7297 @smallexample
7298 int f() @{
7299 union a_union t;
7300 int* ip;
7301 t.d = 3.0;
7302 ip = &t.i;
7303 return *ip;
7304 @}
7305 @end smallexample
7306
7307 Similarly, access by taking the address, casting the resulting pointer
7308 and dereferencing the result has undefined behavior, even if the cast
7309 uses a union type, e.g.:
7310 @smallexample
7311 int f() @{
7312 double d = 3.0;
7313 return ((union a_union *) &d)->i;
7314 @}
7315 @end smallexample
7316
7317 The @option{-fstrict-aliasing} option is enabled at levels
7318 @option{-O2}, @option{-O3}, @option{-Os}.
7319
7320 @item -fstrict-overflow
7321 @opindex fstrict-overflow
7322 Allow the compiler to assume strict signed overflow rules, depending
7323 on the language being compiled. For C (and C++) this means that
7324 overflow when doing arithmetic with signed numbers is undefined, which
7325 means that the compiler may assume that it will not happen. This
7326 permits various optimizations. For example, the compiler will assume
7327 that an expression like @code{i + 10 > i} will always be true for
7328 signed @code{i}. This assumption is only valid if signed overflow is
7329 undefined, as the expression is false if @code{i + 10} overflows when
7330 using twos complement arithmetic. When this option is in effect any
7331 attempt to determine whether an operation on signed numbers will
7332 overflow must be written carefully to not actually involve overflow.
7333
7334 This option also allows the compiler to assume strict pointer
7335 semantics: given a pointer to an object, if adding an offset to that
7336 pointer does not produce a pointer to the same object, the addition is
7337 undefined. This permits the compiler to conclude that @code{p + u >
7338 p} is always true for a pointer @code{p} and unsigned integer
7339 @code{u}. This assumption is only valid because pointer wraparound is
7340 undefined, as the expression is false if @code{p + u} overflows using
7341 twos complement arithmetic.
7342
7343 See also the @option{-fwrapv} option. Using @option{-fwrapv} means
7344 that integer signed overflow is fully defined: it wraps. When
7345 @option{-fwrapv} is used, there is no difference between
7346 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7347 integers. With @option{-fwrapv} certain types of overflow are
7348 permitted. For example, if the compiler gets an overflow when doing
7349 arithmetic on constants, the overflowed value can still be used with
7350 @option{-fwrapv}, but not otherwise.
7351
7352 The @option{-fstrict-overflow} option is enabled at levels
7353 @option{-O2}, @option{-O3}, @option{-Os}.
7354
7355 @item -falign-functions
7356 @itemx -falign-functions=@var{n}
7357 @opindex falign-functions
7358 Align the start of functions to the next power-of-two greater than
7359 @var{n}, skipping up to @var{n} bytes. For instance,
7360 @option{-falign-functions=32} aligns functions to the next 32-byte
7361 boundary, but @option{-falign-functions=24} would align to the next
7362 32-byte boundary only if this can be done by skipping 23 bytes or less.
7363
7364 @option{-fno-align-functions} and @option{-falign-functions=1} are
7365 equivalent and mean that functions will not be aligned.
7366
7367 Some assemblers only support this flag when @var{n} is a power of two;
7368 in that case, it is rounded up.
7369
7370 If @var{n} is not specified or is zero, use a machine-dependent default.
7371
7372 Enabled at levels @option{-O2}, @option{-O3}.
7373
7374 @item -falign-labels
7375 @itemx -falign-labels=@var{n}
7376 @opindex falign-labels
7377 Align all branch targets to a power-of-two boundary, skipping up to
7378 @var{n} bytes like @option{-falign-functions}. This option can easily
7379 make code slower, because it must insert dummy operations for when the
7380 branch target is reached in the usual flow of the code.
7381
7382 @option{-fno-align-labels} and @option{-falign-labels=1} are
7383 equivalent and mean that labels will not be aligned.
7384
7385 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7386 are greater than this value, then their values are used instead.
7387
7388 If @var{n} is not specified or is zero, use a machine-dependent default
7389 which is very likely to be @samp{1}, meaning no alignment.
7390
7391 Enabled at levels @option{-O2}, @option{-O3}.
7392
7393 @item -falign-loops
7394 @itemx -falign-loops=@var{n}
7395 @opindex falign-loops
7396 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7397 like @option{-falign-functions}. The hope is that the loop will be
7398 executed many times, which will make up for any execution of the dummy
7399 operations.
7400
7401 @option{-fno-align-loops} and @option{-falign-loops=1} are
7402 equivalent and mean that loops will not be aligned.
7403
7404 If @var{n} is not specified or is zero, use a machine-dependent default.
7405
7406 Enabled at levels @option{-O2}, @option{-O3}.
7407
7408 @item -falign-jumps
7409 @itemx -falign-jumps=@var{n}
7410 @opindex falign-jumps
7411 Align branch targets to a power-of-two boundary, for branch targets
7412 where the targets can only be reached by jumping, skipping up to @var{n}
7413 bytes like @option{-falign-functions}. In this case, no dummy operations
7414 need be executed.
7415
7416 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7417 equivalent and mean that loops will not be aligned.
7418
7419 If @var{n} is not specified or is zero, use a machine-dependent default.
7420
7421 Enabled at levels @option{-O2}, @option{-O3}.
7422
7423 @item -funit-at-a-time
7424 @opindex funit-at-a-time
7425 This option is left for compatibility reasons. @option{-funit-at-a-time}
7426 has no effect, while @option{-fno-unit-at-a-time} implies
7427 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7428
7429 Enabled by default.
7430
7431 @item -fno-toplevel-reorder
7432 @opindex fno-toplevel-reorder
7433 Do not reorder top-level functions, variables, and @code{asm}
7434 statements. Output them in the same order that they appear in the
7435 input file. When this option is used, unreferenced static variables
7436 will not be removed. This option is intended to support existing code
7437 which relies on a particular ordering. For new code, it is better to
7438 use attributes.
7439
7440 Enabled at level @option{-O0}. When disabled explicitly, it also imply
7441 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7442 targets.
7443
7444 @item -fweb
7445 @opindex fweb
7446 Constructs webs as commonly used for register allocation purposes and assign
7447 each web individual pseudo register. This allows the register allocation pass
7448 to operate on pseudos directly, but also strengthens several other optimization
7449 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
7450 however, make debugging impossible, since variables will no longer stay in a
7451 ``home register''.
7452
7453 Enabled by default with @option{-funroll-loops}.
7454
7455 @item -fwhole-program
7456 @opindex fwhole-program
7457 Assume that the current compilation unit represents the whole program being
7458 compiled. All public functions and variables with the exception of @code{main}
7459 and those merged by attribute @code{externally_visible} become static functions
7460 and in effect are optimized more aggressively by interprocedural optimizers. If @command{gold} is used as the linker plugin, @code{externally_visible} attributes are automatically added to functions (not variable yet due to a current @command{gold} issue) that are accessed outside of LTO objects according to resolution file produced by @command{gold}. For other linkers that cannot generate resolution file, explicit @code{externally_visible} attributes are still necessary.
7461 While this option is equivalent to proper use of the @code{static} keyword for
7462 programs consisting of a single file, in combination with option
7463 @option{-flto} this flag can be used to
7464 compile many smaller scale programs since the functions and variables become
7465 local for the whole combined compilation unit, not for the single source file
7466 itself.
7467
7468 This option implies @option{-fwhole-file} for Fortran programs.
7469
7470 @item -flto[=@var{n}]
7471 @opindex flto
7472 This option runs the standard link-time optimizer. When invoked
7473 with source code, it generates GIMPLE (one of GCC's internal
7474 representations) and writes it to special ELF sections in the object
7475 file. When the object files are linked together, all the function
7476 bodies are read from these ELF sections and instantiated as if they
7477 had been part of the same translation unit.
7478
7479 To use the link-timer optimizer, @option{-flto} needs to be specified at
7480 compile time and during the final link. For example,
7481
7482 @smallexample
7483 gcc -c -O2 -flto foo.c
7484 gcc -c -O2 -flto bar.c
7485 gcc -o myprog -flto -O2 foo.o bar.o
7486 @end smallexample
7487
7488 The first two invocations to GCC will save a bytecode representation
7489 of GIMPLE into special ELF sections inside @file{foo.o} and
7490 @file{bar.o}. The final invocation will read the GIMPLE bytecode from
7491 @file{foo.o} and @file{bar.o}, merge the two files into a single
7492 internal image, and compile the result as usual. Since both
7493 @file{foo.o} and @file{bar.o} are merged into a single image, this
7494 causes all the inter-procedural analyses and optimizations in GCC to
7495 work across the two files as if they were a single one. This means,
7496 for example, that the inliner will be able to inline functions in
7497 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7498
7499 Another (simpler) way to enable link-time optimization is,
7500
7501 @smallexample
7502 gcc -o myprog -flto -O2 foo.c bar.c
7503 @end smallexample
7504
7505 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7506 merge them together into a single GIMPLE representation and optimize
7507 them as usual to produce @file{myprog}.
7508
7509 The only important thing to keep in mind is that to enable link-time
7510 optimizations the @option{-flto} flag needs to be passed to both the
7511 compile and the link commands.
7512
7513 To make whole program optimization effective, it is necessary to make
7514 certain whole program assumptions. The compiler needs to know
7515 what functions and variables can be accessed by libraries and runtime
7516 outside of the link time optimized unit. When supported by the linker,
7517 the linker plugin (see @option{-fuse-linker-plugin}) passes to the
7518 compiler information about used and externally visible symbols. When
7519 the linker plugin is not available, @option{-fwhole-program} should be
7520 used to allow the compiler to make these assumptions, which will lead
7521 to more aggressive optimization decisions.
7522
7523 Note that when a file is compiled with @option{-flto}, the generated
7524 object file will be larger than a regular object file because it will
7525 contain GIMPLE bytecodes and the usual final code. This means that
7526 object files with LTO information can be linked as a normal object
7527 file. So, in the previous example, if the final link is done with
7528
7529 @smallexample
7530 gcc -o myprog foo.o bar.o
7531 @end smallexample
7532
7533 The only difference will be that no inter-procedural optimizations
7534 will be applied to produce @file{myprog}. The two object files
7535 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7536 linker.
7537
7538 Additionally, the optimization flags used to compile individual files
7539 are not necessarily related to those used at link-time. For instance,
7540
7541 @smallexample
7542 gcc -c -O0 -flto foo.c
7543 gcc -c -O0 -flto bar.c
7544 gcc -o myprog -flto -O3 foo.o bar.o
7545 @end smallexample
7546
7547 This will produce individual object files with unoptimized assembler
7548 code, but the resulting binary @file{myprog} will be optimized at
7549 @option{-O3}. Now, if the final binary is generated without
7550 @option{-flto}, then @file{myprog} will not be optimized.
7551
7552 When producing the final binary with @option{-flto}, GCC will only
7553 apply link-time optimizations to those files that contain bytecode.
7554 Therefore, you can mix and match object files and libraries with
7555 GIMPLE bytecodes and final object code. GCC will automatically select
7556 which files to optimize in LTO mode and which files to link without
7557 further processing.
7558
7559 There are some code generation flags that GCC will preserve when
7560 generating bytecodes, as they need to be used during the final link
7561 stage. Currently, the following options are saved into the GIMPLE
7562 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7563 @option{-m} target flags.
7564
7565 At link time, these options are read-in and reapplied. Note that the
7566 current implementation makes no attempt at recognizing conflicting
7567 values for these options. If two or more files have a conflicting
7568 value (e.g., one file is compiled with @option{-fPIC} and another
7569 isn't), the compiler will simply use the last value read from the
7570 bytecode files. It is recommended, then, that all the files
7571 participating in the same link be compiled with the same options.
7572
7573 Another feature of LTO is that it is possible to apply interprocedural
7574 optimizations on files written in different languages. This requires
7575 some support in the language front end. Currently, the C, C++ and
7576 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7577 something like this should work
7578
7579 @smallexample
7580 gcc -c -flto foo.c
7581 g++ -c -flto bar.cc
7582 gfortran -c -flto baz.f90
7583 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7584 @end smallexample
7585
7586 Notice that the final link is done with @command{g++} to get the C++
7587 runtime libraries and @option{-lgfortran} is added to get the Fortran
7588 runtime libraries. In general, when mixing languages in LTO mode, you
7589 should use the same link command used when mixing languages in a
7590 regular (non-LTO) compilation. This means that if your build process
7591 was mixing languages before, all you need to add is @option{-flto} to
7592 all the compile and link commands.
7593
7594 If LTO encounters objects with C linkage declared with incompatible
7595 types in separate translation units to be linked together (undefined
7596 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7597 issued. The behavior is still undefined at runtime.
7598
7599 If object files containing GIMPLE bytecode are stored in a library archive, say
7600 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
7601 are using a linker with linker plugin support. To enable this feature, use
7602 the flag @option{-fuse-linker-plugin} at link-time:
7603
7604 @smallexample
7605 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7606 @end smallexample
7607
7608 With the linker plugin enabled, the linker will extract the needed
7609 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7610 to make them part of the aggregated GIMPLE image to be optimized.
7611
7612 If you are not using a linker with linker plugin support and/or do not
7613 enable linker plugin then the objects inside @file{libfoo.a}
7614 will be extracted and linked as usual, but they will not participate
7615 in the LTO optimization process.
7616
7617 Link time optimizations do not require the presence of the whole program to
7618 operate. If the program does not require any symbols to be exported, it is
7619 possible to combine @option{-flto} and with @option{-fwhole-program} to allow
7620 the interprocedural optimizers to use more aggressive assumptions which may
7621 lead to improved optimization opportunities.
7622 Use of @option{-fwhole-program} is not needed when linker plugin is
7623 active (see @option{-fuse-linker-plugin}).
7624
7625 Regarding portability: the current implementation of LTO makes no
7626 attempt at generating bytecode that can be ported between different
7627 types of hosts. The bytecode files are versioned and there is a
7628 strict version check, so bytecode files generated in one version of
7629 GCC will not work with an older/newer version of GCC.
7630
7631 Link time optimization does not play well with generating debugging
7632 information. Combining @option{-flto} with
7633 @option{-g} is currently experimental and expected to produce wrong
7634 results.
7635
7636 If you specify the optional @var{n}, the optimization and code
7637 generation done at link time is executed in parallel using @var{n}
7638 parallel jobs by utilizing an installed @command{make} program. The
7639 environment variable @env{MAKE} may be used to override the program
7640 used. The default value for @var{n} is 1.
7641
7642 You can also specify @option{-flto=jobserver} to use GNU make's
7643 job server mode to determine the number of parallel jobs. This
7644 is useful when the Makefile calling GCC is already executing in parallel.
7645 The parent Makefile will need a @samp{+} prepended to the command recipe
7646 for this to work. This will likely only work if @env{MAKE} is
7647 GNU make.
7648
7649 This option is disabled by default.
7650
7651 @item -flto-partition=@var{alg}
7652 @opindex flto-partition
7653 Specify the partitioning algorithm used by the link time optimizer.
7654 The value is either @code{1to1} to specify a partitioning mirroring
7655 the original source files or @code{balanced} to specify partitioning
7656 into equally sized chunks (whenever possible). Specifying @code{none}
7657 as an algorithm disables partitioning and streaming completely. The
7658 default value is @code{balanced}.
7659
7660 @item -flto-compression-level=@var{n}
7661 This option specifies the level of compression used for intermediate
7662 language written to LTO object files, and is only meaningful in
7663 conjunction with LTO mode (@option{-flto}). Valid
7664 values are 0 (no compression) to 9 (maximum compression). Values
7665 outside this range are clamped to either 0 or 9. If the option is not
7666 given, a default balanced compression setting is used.
7667
7668 @item -flto-report
7669 Prints a report with internal details on the workings of the link-time
7670 optimizer. The contents of this report vary from version to version,
7671 it is meant to be useful to GCC developers when processing object
7672 files in LTO mode (via @option{-flto}).
7673
7674 Disabled by default.
7675
7676 @item -fuse-linker-plugin
7677 Enables the use of linker plugin during link time optimization. This option
7678 relies on the linker plugin support in linker that is available in @code{gold}
7679 or in GNU ld 2.21.51 or newer..
7680
7681 This option enables the extraction of object files with GIMPLE bytecode out of
7682 library archives. This improves the quality of optimization by exposing more
7683 code the the link time optimizer. This information specify what symbols
7684 can be accessed externally (by non-LTO object or during dynamic linking).
7685 Resulting code quality improvements on binaries (and shared libaries that do
7686 use hidden visibility) is similar to @code{-fwhole-program}. See
7687 @option{-flto} for a description on the effect of this flag and how to use it.
7688
7689 Enabled by default when LTO support in GCC is enabled and GCC was compiled
7690 with linker supporting plugins (GNU ld or @code{gold}).
7691
7692 @item -fcprop-registers
7693 @opindex fcprop-registers
7694 After register allocation and post-register allocation instruction splitting,
7695 we perform a copy-propagation pass to try to reduce scheduling dependencies
7696 and occasionally eliminate the copy.
7697
7698 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7699
7700 @item -fprofile-correction
7701 @opindex fprofile-correction
7702 Profiles collected using an instrumented binary for multi-threaded programs may
7703 be inconsistent due to missed counter updates. When this option is specified,
7704 GCC will use heuristics to correct or smooth out such inconsistencies. By
7705 default, GCC will emit an error message when an inconsistent profile is detected.
7706
7707 @item -fprofile-dir=@var{path}
7708 @opindex fprofile-dir
7709
7710 Set the directory to search the profile data files in to @var{path}.
7711 This option affects only the profile data generated by
7712 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7713 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7714 and its related options.
7715 By default, GCC will use the current directory as @var{path}
7716 thus the profile data file will appear in the same directory as the object file.
7717
7718 @item -fprofile-generate
7719 @itemx -fprofile-generate=@var{path}
7720 @opindex fprofile-generate
7721
7722 Enable options usually used for instrumenting application to produce
7723 profile useful for later recompilation with profile feedback based
7724 optimization. You must use @option{-fprofile-generate} both when
7725 compiling and when linking your program.
7726
7727 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7728
7729 If @var{path} is specified, GCC will look at the @var{path} to find
7730 the profile feedback data files. See @option{-fprofile-dir}.
7731
7732 @item -fprofile-use
7733 @itemx -fprofile-use=@var{path}
7734 @opindex fprofile-use
7735 Enable profile feedback directed optimizations, and optimizations
7736 generally profitable only with profile feedback available.
7737
7738 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7739 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7740
7741 By default, GCC emits an error message if the feedback profiles do not
7742 match the source code. This error can be turned into a warning by using
7743 @option{-Wcoverage-mismatch}. Note this may result in poorly optimized
7744 code.
7745
7746 If @var{path} is specified, GCC will look at the @var{path} to find
7747 the profile feedback data files. See @option{-fprofile-dir}.
7748 @end table
7749
7750 The following options control compiler behavior regarding floating
7751 point arithmetic. These options trade off between speed and
7752 correctness. All must be specifically enabled.
7753
7754 @table @gcctabopt
7755 @item -ffloat-store
7756 @opindex ffloat-store
7757 Do not store floating point variables in registers, and inhibit other
7758 options that might change whether a floating point value is taken from a
7759 register or memory.
7760
7761 @cindex floating point precision
7762 This option prevents undesirable excess precision on machines such as
7763 the 68000 where the floating registers (of the 68881) keep more
7764 precision than a @code{double} is supposed to have. Similarly for the
7765 x86 architecture. For most programs, the excess precision does only
7766 good, but a few programs rely on the precise definition of IEEE floating
7767 point. Use @option{-ffloat-store} for such programs, after modifying
7768 them to store all pertinent intermediate computations into variables.
7769
7770 @item -fexcess-precision=@var{style}
7771 @opindex fexcess-precision
7772 This option allows further control over excess precision on machines
7773 where floating-point registers have more precision than the IEEE
7774 @code{float} and @code{double} types and the processor does not
7775 support operations rounding to those types. By default,
7776 @option{-fexcess-precision=fast} is in effect; this means that
7777 operations are carried out in the precision of the registers and that
7778 it is unpredictable when rounding to the types specified in the source
7779 code takes place. When compiling C, if
7780 @option{-fexcess-precision=standard} is specified then excess
7781 precision will follow the rules specified in ISO C99; in particular,
7782 both casts and assignments cause values to be rounded to their
7783 semantic types (whereas @option{-ffloat-store} only affects
7784 assignments). This option is enabled by default for C if a strict
7785 conformance option such as @option{-std=c99} is used.
7786
7787 @opindex mfpmath
7788 @option{-fexcess-precision=standard} is not implemented for languages
7789 other than C, and has no effect if
7790 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7791 specified. On the x86, it also has no effect if @option{-mfpmath=sse}
7792 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7793 semantics apply without excess precision, and in the latter, rounding
7794 is unpredictable.
7795
7796 @item -ffast-math
7797 @opindex ffast-math
7798 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7799 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7800 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7801
7802 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7803
7804 This option is not turned on by any @option{-O} option besides
7805 @option{-Ofast} since it can result in incorrect output for programs
7806 which depend on an exact implementation of IEEE or ISO rules/specifications
7807 for math functions. It may, however, yield faster code for programs
7808 that do not require the guarantees of these specifications.
7809
7810 @item -fno-math-errno
7811 @opindex fno-math-errno
7812 Do not set ERRNO after calling math functions that are executed
7813 with a single instruction, e.g., sqrt. A program that relies on
7814 IEEE exceptions for math error handling may want to use this flag
7815 for speed while maintaining IEEE arithmetic compatibility.
7816
7817 This option is not turned on by any @option{-O} option since
7818 it can result in incorrect output for programs which depend on
7819 an exact implementation of IEEE or ISO rules/specifications for
7820 math functions. It may, however, yield faster code for programs
7821 that do not require the guarantees of these specifications.
7822
7823 The default is @option{-fmath-errno}.
7824
7825 On Darwin systems, the math library never sets @code{errno}. There is
7826 therefore no reason for the compiler to consider the possibility that
7827 it might, and @option{-fno-math-errno} is the default.
7828
7829 @item -funsafe-math-optimizations
7830 @opindex funsafe-math-optimizations
7831
7832 Allow optimizations for floating-point arithmetic that (a) assume
7833 that arguments and results are valid and (b) may violate IEEE or
7834 ANSI standards. When used at link-time, it may include libraries
7835 or startup files that change the default FPU control word or other
7836 similar optimizations.
7837
7838 This option is not turned on by any @option{-O} option since
7839 it can result in incorrect output for programs which depend on
7840 an exact implementation of IEEE or ISO rules/specifications for
7841 math functions. It may, however, yield faster code for programs
7842 that do not require the guarantees of these specifications.
7843 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7844 @option{-fassociative-math} and @option{-freciprocal-math}.
7845
7846 The default is @option{-fno-unsafe-math-optimizations}.
7847
7848 @item -fassociative-math
7849 @opindex fassociative-math
7850
7851 Allow re-association of operands in series of floating-point operations.
7852 This violates the ISO C and C++ language standard by possibly changing
7853 computation result. NOTE: re-ordering may change the sign of zero as
7854 well as ignore NaNs and inhibit or create underflow or overflow (and
7855 thus cannot be used on a code which relies on rounding behavior like
7856 @code{(x + 2**52) - 2**52)}. May also reorder floating-point comparisons
7857 and thus may not be used when ordered comparisons are required.
7858 This option requires that both @option{-fno-signed-zeros} and
7859 @option{-fno-trapping-math} be in effect. Moreover, it doesn't make
7860 much sense with @option{-frounding-math}. For Fortran the option
7861 is automatically enabled when both @option{-fno-signed-zeros} and
7862 @option{-fno-trapping-math} are in effect.
7863
7864 The default is @option{-fno-associative-math}.
7865
7866 @item -freciprocal-math
7867 @opindex freciprocal-math
7868
7869 Allow the reciprocal of a value to be used instead of dividing by
7870 the value if this enables optimizations. For example @code{x / y}
7871 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7872 is subject to common subexpression elimination. Note that this loses
7873 precision and increases the number of flops operating on the value.
7874
7875 The default is @option{-fno-reciprocal-math}.
7876
7877 @item -ffinite-math-only
7878 @opindex ffinite-math-only
7879 Allow optimizations for floating-point arithmetic that assume
7880 that arguments and results are not NaNs or +-Infs.
7881
7882 This option is not turned on by any @option{-O} option since
7883 it can result in incorrect output for programs which depend on
7884 an exact implementation of IEEE or ISO rules/specifications for
7885 math functions. It may, however, yield faster code for programs
7886 that do not require the guarantees of these specifications.
7887
7888 The default is @option{-fno-finite-math-only}.
7889
7890 @item -fno-signed-zeros
7891 @opindex fno-signed-zeros
7892 Allow optimizations for floating point arithmetic that ignore the
7893 signedness of zero. IEEE arithmetic specifies the behavior of
7894 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7895 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7896 This option implies that the sign of a zero result isn't significant.
7897
7898 The default is @option{-fsigned-zeros}.
7899
7900 @item -fno-trapping-math
7901 @opindex fno-trapping-math
7902 Compile code assuming that floating-point operations cannot generate
7903 user-visible traps. These traps include division by zero, overflow,
7904 underflow, inexact result and invalid operation. This option requires
7905 that @option{-fno-signaling-nans} be in effect. Setting this option may
7906 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7907
7908 This option should never be turned on by any @option{-O} option since
7909 it can result in incorrect output for programs which depend on
7910 an exact implementation of IEEE or ISO rules/specifications for
7911 math functions.
7912
7913 The default is @option{-ftrapping-math}.
7914
7915 @item -frounding-math
7916 @opindex frounding-math
7917 Disable transformations and optimizations that assume default floating
7918 point rounding behavior. This is round-to-zero for all floating point
7919 to integer conversions, and round-to-nearest for all other arithmetic
7920 truncations. This option should be specified for programs that change
7921 the FP rounding mode dynamically, or that may be executed with a
7922 non-default rounding mode. This option disables constant folding of
7923 floating point expressions at compile-time (which may be affected by
7924 rounding mode) and arithmetic transformations that are unsafe in the
7925 presence of sign-dependent rounding modes.
7926
7927 The default is @option{-fno-rounding-math}.
7928
7929 This option is experimental and does not currently guarantee to
7930 disable all GCC optimizations that are affected by rounding mode.
7931 Future versions of GCC may provide finer control of this setting
7932 using C99's @code{FENV_ACCESS} pragma. This command line option
7933 will be used to specify the default state for @code{FENV_ACCESS}.
7934
7935 @item -fsignaling-nans
7936 @opindex fsignaling-nans
7937 Compile code assuming that IEEE signaling NaNs may generate user-visible
7938 traps during floating-point operations. Setting this option disables
7939 optimizations that may change the number of exceptions visible with
7940 signaling NaNs. This option implies @option{-ftrapping-math}.
7941
7942 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7943 be defined.
7944
7945 The default is @option{-fno-signaling-nans}.
7946
7947 This option is experimental and does not currently guarantee to
7948 disable all GCC optimizations that affect signaling NaN behavior.
7949
7950 @item -fsingle-precision-constant
7951 @opindex fsingle-precision-constant
7952 Treat floating point constant as single precision constant instead of
7953 implicitly converting it to double precision constant.
7954
7955 @item -fcx-limited-range
7956 @opindex fcx-limited-range
7957 When enabled, this option states that a range reduction step is not
7958 needed when performing complex division. Also, there is no checking
7959 whether the result of a complex multiplication or division is @code{NaN
7960 + I*NaN}, with an attempt to rescue the situation in that case. The
7961 default is @option{-fno-cx-limited-range}, but is enabled by
7962 @option{-ffast-math}.
7963
7964 This option controls the default setting of the ISO C99
7965 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
7966 all languages.
7967
7968 @item -fcx-fortran-rules
7969 @opindex fcx-fortran-rules
7970 Complex multiplication and division follow Fortran rules. Range
7971 reduction is done as part of complex division, but there is no checking
7972 whether the result of a complex multiplication or division is @code{NaN
7973 + I*NaN}, with an attempt to rescue the situation in that case.
7974
7975 The default is @option{-fno-cx-fortran-rules}.
7976
7977 @end table
7978
7979 The following options control optimizations that may improve
7980 performance, but are not enabled by any @option{-O} options. This
7981 section includes experimental options that may produce broken code.
7982
7983 @table @gcctabopt
7984 @item -fbranch-probabilities
7985 @opindex fbranch-probabilities
7986 After running a program compiled with @option{-fprofile-arcs}
7987 (@pxref{Debugging Options,, Options for Debugging Your Program or
7988 @command{gcc}}), you can compile it a second time using
7989 @option{-fbranch-probabilities}, to improve optimizations based on
7990 the number of times each branch was taken. When the program
7991 compiled with @option{-fprofile-arcs} exits it saves arc execution
7992 counts to a file called @file{@var{sourcename}.gcda} for each source
7993 file. The information in this data file is very dependent on the
7994 structure of the generated code, so you must use the same source code
7995 and the same optimization options for both compilations.
7996
7997 With @option{-fbranch-probabilities}, GCC puts a
7998 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7999 These can be used to improve optimization. Currently, they are only
8000 used in one place: in @file{reorg.c}, instead of guessing which path a
8001 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
8002 exactly determine which path is taken more often.
8003
8004 @item -fprofile-values
8005 @opindex fprofile-values
8006 If combined with @option{-fprofile-arcs}, it adds code so that some
8007 data about values of expressions in the program is gathered.
8008
8009 With @option{-fbranch-probabilities}, it reads back the data gathered
8010 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
8011 notes to instructions for their later usage in optimizations.
8012
8013 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8014
8015 @item -fvpt
8016 @opindex fvpt
8017 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8018 a code to gather information about values of expressions.
8019
8020 With @option{-fbranch-probabilities}, it reads back the data gathered
8021 and actually performs the optimizations based on them.
8022 Currently the optimizations include specialization of division operation
8023 using the knowledge about the value of the denominator.
8024
8025 @item -frename-registers
8026 @opindex frename-registers
8027 Attempt to avoid false dependencies in scheduled code by making use
8028 of registers left over after register allocation. This optimization
8029 will most benefit processors with lots of registers. Depending on the
8030 debug information format adopted by the target, however, it can
8031 make debugging impossible, since variables will no longer stay in
8032 a ``home register''.
8033
8034 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8035
8036 @item -ftracer
8037 @opindex ftracer
8038 Perform tail duplication to enlarge superblock size. This transformation
8039 simplifies the control flow of the function allowing other optimizations to do
8040 better job.
8041
8042 Enabled with @option{-fprofile-use}.
8043
8044 @item -funroll-loops
8045 @opindex funroll-loops
8046 Unroll loops whose number of iterations can be determined at compile time or
8047 upon entry to the loop. @option{-funroll-loops} implies
8048 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8049 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8050 small constant number of iterations). This option makes code larger, and may
8051 or may not make it run faster.
8052
8053 Enabled with @option{-fprofile-use}.
8054
8055 @item -funroll-all-loops
8056 @opindex funroll-all-loops
8057 Unroll all loops, even if their number of iterations is uncertain when
8058 the loop is entered. This usually makes programs run more slowly.
8059 @option{-funroll-all-loops} implies the same options as
8060 @option{-funroll-loops}.
8061
8062 @item -fpeel-loops
8063 @opindex fpeel-loops
8064 Peels the loops for that there is enough information that they do not
8065 roll much (from profile feedback). It also turns on complete loop peeling
8066 (i.e.@: complete removal of loops with small constant number of iterations).
8067
8068 Enabled with @option{-fprofile-use}.
8069
8070 @item -fmove-loop-invariants
8071 @opindex fmove-loop-invariants
8072 Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
8073 at level @option{-O1}
8074
8075 @item -funswitch-loops
8076 @opindex funswitch-loops
8077 Move branches with loop invariant conditions out of the loop, with duplicates
8078 of the loop on both branches (modified according to result of the condition).
8079
8080 @item -ffunction-sections
8081 @itemx -fdata-sections
8082 @opindex ffunction-sections
8083 @opindex fdata-sections
8084 Place each function or data item into its own section in the output
8085 file if the target supports arbitrary sections. The name of the
8086 function or the name of the data item determines the section's name
8087 in the output file.
8088
8089 Use these options on systems where the linker can perform optimizations
8090 to improve locality of reference in the instruction space. Most systems
8091 using the ELF object format and SPARC processors running Solaris 2 have
8092 linkers with such optimizations. AIX may have these optimizations in
8093 the future.
8094
8095 Only use these options when there are significant benefits from doing
8096 so. When you specify these options, the assembler and linker will
8097 create larger object and executable files and will also be slower.
8098 You will not be able to use @code{gprof} on all systems if you
8099 specify this option and you may have problems with debugging if
8100 you specify both this option and @option{-g}.
8101
8102 @item -fbranch-target-load-optimize
8103 @opindex fbranch-target-load-optimize
8104 Perform branch target register load optimization before prologue / epilogue
8105 threading.
8106 The use of target registers can typically be exposed only during reload,
8107 thus hoisting loads out of loops and doing inter-block scheduling needs
8108 a separate optimization pass.
8109
8110 @item -fbranch-target-load-optimize2
8111 @opindex fbranch-target-load-optimize2
8112 Perform branch target register load optimization after prologue / epilogue
8113 threading.
8114
8115 @item -fbtr-bb-exclusive
8116 @opindex fbtr-bb-exclusive
8117 When performing branch target register load optimization, don't reuse
8118 branch target registers in within any basic block.
8119
8120 @item -fstack-protector
8121 @opindex fstack-protector
8122 Emit extra code to check for buffer overflows, such as stack smashing
8123 attacks. This is done by adding a guard variable to functions with
8124 vulnerable objects. This includes functions that call alloca, and
8125 functions with buffers larger than 8 bytes. The guards are initialized
8126 when a function is entered and then checked when the function exits.
8127 If a guard check fails, an error message is printed and the program exits.
8128
8129 @item -fstack-protector-all
8130 @opindex fstack-protector-all
8131 Like @option{-fstack-protector} except that all functions are protected.
8132
8133 @item -fsection-anchors
8134 @opindex fsection-anchors
8135 Try to reduce the number of symbolic address calculations by using
8136 shared ``anchor'' symbols to address nearby objects. This transformation
8137 can help to reduce the number of GOT entries and GOT accesses on some
8138 targets.
8139
8140 For example, the implementation of the following function @code{foo}:
8141
8142 @smallexample
8143 static int a, b, c;
8144 int foo (void) @{ return a + b + c; @}
8145 @end smallexample
8146
8147 would usually calculate the addresses of all three variables, but if you
8148 compile it with @option{-fsection-anchors}, it will access the variables
8149 from a common anchor point instead. The effect is similar to the
8150 following pseudocode (which isn't valid C):
8151
8152 @smallexample
8153 int foo (void)
8154 @{
8155 register int *xr = &x;
8156 return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8157 @}
8158 @end smallexample
8159
8160 Not all targets support this option.
8161
8162 @item --param @var{name}=@var{value}
8163 @opindex param
8164 In some places, GCC uses various constants to control the amount of
8165 optimization that is done. For example, GCC will not inline functions
8166 that contain more that a certain number of instructions. You can
8167 control some of these constants on the command-line using the
8168 @option{--param} option.
8169
8170 The names of specific parameters, and the meaning of the values, are
8171 tied to the internals of the compiler, and are subject to change
8172 without notice in future releases.
8173
8174 In each case, the @var{value} is an integer. The allowable choices for
8175 @var{name} are given in the following table:
8176
8177 @table @gcctabopt
8178 @item struct-reorg-cold-struct-ratio
8179 The threshold ratio (as a percentage) between a structure frequency
8180 and the frequency of the hottest structure in the program. This parameter
8181 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
8182 We say that if the ratio of a structure frequency, calculated by profiling,
8183 to the hottest structure frequency in the program is less than this
8184 parameter, then structure reorganization is not applied to this structure.
8185 The default is 10.
8186
8187 @item predictable-branch-outcome
8188 When branch is predicted to be taken with probability lower than this threshold
8189 (in percent), then it is considered well predictable. The default is 10.
8190
8191 @item max-crossjump-edges
8192 The maximum number of incoming edges to consider for crossjumping.
8193 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8194 the number of edges incoming to each block. Increasing values mean
8195 more aggressive optimization, making the compile time increase with
8196 probably small improvement in executable size.
8197
8198 @item min-crossjump-insns
8199 The minimum number of instructions which must be matched at the end
8200 of two blocks before crossjumping will be performed on them. This
8201 value is ignored in the case where all instructions in the block being
8202 crossjumped from are matched. The default value is 5.
8203
8204 @item max-grow-copy-bb-insns
8205 The maximum code size expansion factor when copying basic blocks
8206 instead of jumping. The expansion is relative to a jump instruction.
8207 The default value is 8.
8208
8209 @item max-goto-duplication-insns
8210 The maximum number of instructions to duplicate to a block that jumps
8211 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
8212 passes, GCC factors computed gotos early in the compilation process,
8213 and unfactors them as late as possible. Only computed jumps at the
8214 end of a basic blocks with no more than max-goto-duplication-insns are
8215 unfactored. The default value is 8.
8216
8217 @item max-delay-slot-insn-search
8218 The maximum number of instructions to consider when looking for an
8219 instruction to fill a delay slot. If more than this arbitrary number of
8220 instructions is searched, the time savings from filling the delay slot
8221 will be minimal so stop searching. Increasing values mean more
8222 aggressive optimization, making the compile time increase with probably
8223 small improvement in executable run time.
8224
8225 @item max-delay-slot-live-search
8226 When trying to fill delay slots, the maximum number of instructions to
8227 consider when searching for a block with valid live register
8228 information. Increasing this arbitrarily chosen value means more
8229 aggressive optimization, increasing the compile time. This parameter
8230 should be removed when the delay slot code is rewritten to maintain the
8231 control-flow graph.
8232
8233 @item max-gcse-memory
8234 The approximate maximum amount of memory that will be allocated in
8235 order to perform the global common subexpression elimination
8236 optimization. If more memory than specified is required, the
8237 optimization will not be done.
8238
8239 @item max-gcse-insertion-ratio
8240 If the ratio of expression insertions to deletions is larger than this value
8241 for any expression, then RTL PRE will insert or remove the expression and thus
8242 leave partially redundant computations in the instruction stream. The default value is 20.
8243
8244 @item max-pending-list-length
8245 The maximum number of pending dependencies scheduling will allow
8246 before flushing the current state and starting over. Large functions
8247 with few branches or calls can create excessively large lists which
8248 needlessly consume memory and resources.
8249
8250 @item max-inline-insns-single
8251 Several parameters control the tree inliner used in gcc.
8252 This number sets the maximum number of instructions (counted in GCC's
8253 internal representation) in a single function that the tree inliner
8254 will consider for inlining. This only affects functions declared
8255 inline and methods implemented in a class declaration (C++).
8256 The default value is 300.
8257
8258 @item max-inline-insns-auto
8259 When you use @option{-finline-functions} (included in @option{-O3}),
8260 a lot of functions that would otherwise not be considered for inlining
8261 by the compiler will be investigated. To those functions, a different
8262 (more restrictive) limit compared to functions declared inline can
8263 be applied.
8264 The default value is 40.
8265
8266 @item large-function-insns
8267 The limit specifying really large functions. For functions larger than this
8268 limit after inlining, inlining is constrained by
8269 @option{--param large-function-growth}. This parameter is useful primarily
8270 to avoid extreme compilation time caused by non-linear algorithms used by the
8271 backend.
8272 The default value is 2700.
8273
8274 @item large-function-growth
8275 Specifies maximal growth of large function caused by inlining in percents.
8276 The default value is 100 which limits large function growth to 2.0 times
8277 the original size.
8278
8279 @item large-unit-insns
8280 The limit specifying large translation unit. Growth caused by inlining of
8281 units larger than this limit is limited by @option{--param inline-unit-growth}.
8282 For small units this might be too tight (consider unit consisting of function A
8283 that is inline and B that just calls A three time. If B is small relative to
8284 A, the growth of unit is 300\% and yet such inlining is very sane. For very
8285 large units consisting of small inlineable functions however the overall unit
8286 growth limit is needed to avoid exponential explosion of code size. Thus for
8287 smaller units, the size is increased to @option{--param large-unit-insns}
8288 before applying @option{--param inline-unit-growth}. The default is 10000
8289
8290 @item inline-unit-growth
8291 Specifies maximal overall growth of the compilation unit caused by inlining.
8292 The default value is 30 which limits unit growth to 1.3 times the original
8293 size.
8294
8295 @item ipcp-unit-growth
8296 Specifies maximal overall growth of the compilation unit caused by
8297 interprocedural constant propagation. The default value is 10 which limits
8298 unit growth to 1.1 times the original size.
8299
8300 @item large-stack-frame
8301 The limit specifying large stack frames. While inlining the algorithm is trying
8302 to not grow past this limit too much. Default value is 256 bytes.
8303
8304 @item large-stack-frame-growth
8305 Specifies maximal growth of large stack frames caused by inlining in percents.
8306 The default value is 1000 which limits large stack frame growth to 11 times
8307 the original size.
8308
8309 @item max-inline-insns-recursive
8310 @itemx max-inline-insns-recursive-auto
8311 Specifies maximum number of instructions out-of-line copy of self recursive inline
8312 function can grow into by performing recursive inlining.
8313
8314 For functions declared inline @option{--param max-inline-insns-recursive} is
8315 taken into account. For function not declared inline, recursive inlining
8316 happens only when @option{-finline-functions} (included in @option{-O3}) is
8317 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
8318 default value is 450.
8319
8320 @item max-inline-recursive-depth
8321 @itemx max-inline-recursive-depth-auto
8322 Specifies maximum recursion depth used by the recursive inlining.
8323
8324 For functions declared inline @option{--param max-inline-recursive-depth} is
8325 taken into account. For function not declared inline, recursive inlining
8326 happens only when @option{-finline-functions} (included in @option{-O3}) is
8327 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
8328 default value is 8.
8329
8330 @item min-inline-recursive-probability
8331 Recursive inlining is profitable only for function having deep recursion
8332 in average and can hurt for function having little recursion depth by
8333 increasing the prologue size or complexity of function body to other
8334 optimizers.
8335
8336 When profile feedback is available (see @option{-fprofile-generate}) the actual
8337 recursion depth can be guessed from probability that function will recurse via
8338 given call expression. This parameter limits inlining only to call expression
8339 whose probability exceeds given threshold (in percents). The default value is
8340 10.
8341
8342 @item early-inlining-insns
8343 Specify growth that early inliner can make. In effect it increases amount of
8344 inlining for code having large abstraction penalty. The default value is 10.
8345
8346 @item max-early-inliner-iterations
8347 @itemx max-early-inliner-iterations
8348 Limit of iterations of early inliner. This basically bounds number of nested
8349 indirect calls early inliner can resolve. Deeper chains are still handled by
8350 late inlining.
8351
8352 @item comdat-sharing-probability
8353 @itemx comdat-sharing-probability
8354 Probability (in percent) that C++ inline function with comdat visibility
8355 will be shared across multiple compilation units. The default value is 20.
8356
8357 @item min-vect-loop-bound
8358 The minimum number of iterations under which a loop will not get vectorized
8359 when @option{-ftree-vectorize} is used. The number of iterations after
8360 vectorization needs to be greater than the value specified by this option
8361 to allow vectorization. The default value is 0.
8362
8363 @item gcse-cost-distance-ratio
8364 Scaling factor in calculation of maximum distance an expression
8365 can be moved by GCSE optimizations. This is currently supported only in the
8366 code hoisting pass. The bigger the ratio, the more aggressive code hoisting
8367 will be with simple expressions, i.e., the expressions which have cost
8368 less than @option{gcse-unrestricted-cost}. Specifying 0 will disable
8369 hoisting of simple expressions. The default value is 10.
8370
8371 @item gcse-unrestricted-cost
8372 Cost, roughly measured as the cost of a single typical machine
8373 instruction, at which GCSE optimizations will not constrain
8374 the distance an expression can travel. This is currently
8375 supported only in the code hoisting pass. The lesser the cost,
8376 the more aggressive code hoisting will be. Specifying 0 will
8377 allow all expressions to travel unrestricted distances.
8378 The default value is 3.
8379
8380 @item max-hoist-depth
8381 The depth of search in the dominator tree for expressions to hoist.
8382 This is used to avoid quadratic behavior in hoisting algorithm.
8383 The value of 0 will avoid limiting the search, but may slow down compilation
8384 of huge functions. The default value is 30.
8385
8386 @item max-unrolled-insns
8387 The maximum number of instructions that a loop should have if that loop
8388 is unrolled, and if the loop is unrolled, it determines how many times
8389 the loop code is unrolled.
8390
8391 @item max-average-unrolled-insns
8392 The maximum number of instructions biased by probabilities of their execution
8393 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8394 it determines how many times the loop code is unrolled.
8395
8396 @item max-unroll-times
8397 The maximum number of unrollings of a single loop.
8398
8399 @item max-peeled-insns
8400 The maximum number of instructions that a loop should have if that loop
8401 is peeled, and if the loop is peeled, it determines how many times
8402 the loop code is peeled.
8403
8404 @item max-peel-times
8405 The maximum number of peelings of a single loop.
8406
8407 @item max-completely-peeled-insns
8408 The maximum number of insns of a completely peeled loop.
8409
8410 @item max-completely-peel-times
8411 The maximum number of iterations of a loop to be suitable for complete peeling.
8412
8413 @item max-completely-peel-loop-nest-depth
8414 The maximum depth of a loop nest suitable for complete peeling.
8415
8416 @item max-unswitch-insns
8417 The maximum number of insns of an unswitched loop.
8418
8419 @item max-unswitch-level
8420 The maximum number of branches unswitched in a single loop.
8421
8422 @item lim-expensive
8423 The minimum cost of an expensive expression in the loop invariant motion.
8424
8425 @item iv-consider-all-candidates-bound
8426 Bound on number of candidates for induction variables below that
8427 all candidates are considered for each use in induction variable
8428 optimizations. Only the most relevant candidates are considered
8429 if there are more candidates, to avoid quadratic time complexity.
8430
8431 @item iv-max-considered-uses
8432 The induction variable optimizations give up on loops that contain more
8433 induction variable uses.
8434
8435 @item iv-always-prune-cand-set-bound
8436 If number of candidates in the set is smaller than this value,
8437 we always try to remove unnecessary ivs from the set during its
8438 optimization when a new iv is added to the set.
8439
8440 @item scev-max-expr-size
8441 Bound on size of expressions used in the scalar evolutions analyzer.
8442 Large expressions slow the analyzer.
8443
8444 @item omega-max-vars
8445 The maximum number of variables in an Omega constraint system.
8446 The default value is 128.
8447
8448 @item omega-max-geqs
8449 The maximum number of inequalities in an Omega constraint system.
8450 The default value is 256.
8451
8452 @item omega-max-eqs
8453 The maximum number of equalities in an Omega constraint system.
8454 The default value is 128.
8455
8456 @item omega-max-wild-cards
8457 The maximum number of wildcard variables that the Omega solver will
8458 be able to insert. The default value is 18.
8459
8460 @item omega-hash-table-size
8461 The size of the hash table in the Omega solver. The default value is
8462 550.
8463
8464 @item omega-max-keys
8465 The maximal number of keys used by the Omega solver. The default
8466 value is 500.
8467
8468 @item omega-eliminate-redundant-constraints
8469 When set to 1, use expensive methods to eliminate all redundant
8470 constraints. The default value is 0.
8471
8472 @item vect-max-version-for-alignment-checks
8473 The maximum number of runtime checks that can be performed when
8474 doing loop versioning for alignment in the vectorizer. See option
8475 ftree-vect-loop-version for more information.
8476
8477 @item vect-max-version-for-alias-checks
8478 The maximum number of runtime checks that can be performed when
8479 doing loop versioning for alias in the vectorizer. See option
8480 ftree-vect-loop-version for more information.
8481
8482 @item max-iterations-to-track
8483
8484 The maximum number of iterations of a loop the brute force algorithm
8485 for analysis of # of iterations of the loop tries to evaluate.
8486
8487 @item hot-bb-count-fraction
8488 Select fraction of the maximal count of repetitions of basic block in program
8489 given basic block needs to have to be considered hot.
8490
8491 @item hot-bb-frequency-fraction
8492 Select fraction of the maximal frequency of executions of basic block in
8493 function given basic block needs to have to be considered hot
8494
8495 @item max-predicted-iterations
8496 The maximum number of loop iterations we predict statically. This is useful
8497 in cases where function contain single loop with known bound and other loop
8498 with unknown. We predict the known number of iterations correctly, while
8499 the unknown number of iterations average to roughly 10. This means that the
8500 loop without bounds would appear artificially cold relative to the other one.
8501
8502 @item align-threshold
8503
8504 Select fraction of the maximal frequency of executions of basic block in
8505 function given basic block will get aligned.
8506
8507 @item align-loop-iterations
8508
8509 A loop expected to iterate at lest the selected number of iterations will get
8510 aligned.
8511
8512 @item tracer-dynamic-coverage
8513 @itemx tracer-dynamic-coverage-feedback
8514
8515 This value is used to limit superblock formation once the given percentage of
8516 executed instructions is covered. This limits unnecessary code size
8517 expansion.
8518
8519 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8520 feedback is available. The real profiles (as opposed to statically estimated
8521 ones) are much less balanced allowing the threshold to be larger value.
8522
8523 @item tracer-max-code-growth
8524 Stop tail duplication once code growth has reached given percentage. This is
8525 rather hokey argument, as most of the duplicates will be eliminated later in
8526 cross jumping, so it may be set to much higher values than is the desired code
8527 growth.
8528
8529 @item tracer-min-branch-ratio
8530
8531 Stop reverse growth when the reverse probability of best edge is less than this
8532 threshold (in percent).
8533
8534 @item tracer-min-branch-ratio
8535 @itemx tracer-min-branch-ratio-feedback
8536
8537 Stop forward growth if the best edge do have probability lower than this
8538 threshold.
8539
8540 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8541 compilation for profile feedback and one for compilation without. The value
8542 for compilation with profile feedback needs to be more conservative (higher) in
8543 order to make tracer effective.
8544
8545 @item max-cse-path-length
8546
8547 Maximum number of basic blocks on path that cse considers. The default is 10.
8548
8549 @item max-cse-insns
8550 The maximum instructions CSE process before flushing. The default is 1000.
8551
8552 @item ggc-min-expand
8553
8554 GCC uses a garbage collector to manage its own memory allocation. This
8555 parameter specifies the minimum percentage by which the garbage
8556 collector's heap should be allowed to expand between collections.
8557 Tuning this may improve compilation speed; it has no effect on code
8558 generation.
8559
8560 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8561 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
8562 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
8563 GCC is not able to calculate RAM on a particular platform, the lower
8564 bound of 30% is used. Setting this parameter and
8565 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8566 every opportunity. This is extremely slow, but can be useful for
8567 debugging.
8568
8569 @item ggc-min-heapsize
8570
8571 Minimum size of the garbage collector's heap before it begins bothering
8572 to collect garbage. The first collection occurs after the heap expands
8573 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
8574 tuning this may improve compilation speed, and has no effect on code
8575 generation.
8576
8577 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8578 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8579 with a lower bound of 4096 (four megabytes) and an upper bound of
8580 131072 (128 megabytes). If GCC is not able to calculate RAM on a
8581 particular platform, the lower bound is used. Setting this parameter
8582 very large effectively disables garbage collection. Setting this
8583 parameter and @option{ggc-min-expand} to zero causes a full collection
8584 to occur at every opportunity.
8585
8586 @item max-reload-search-insns
8587 The maximum number of instruction reload should look backward for equivalent
8588 register. Increasing values mean more aggressive optimization, making the
8589 compile time increase with probably slightly better performance. The default
8590 value is 100.
8591
8592 @item max-cselib-memory-locations
8593 The maximum number of memory locations cselib should take into account.
8594 Increasing values mean more aggressive optimization, making the compile time
8595 increase with probably slightly better performance. The default value is 500.
8596
8597 @item reorder-blocks-duplicate
8598 @itemx reorder-blocks-duplicate-feedback
8599
8600 Used by basic block reordering pass to decide whether to use unconditional
8601 branch or duplicate the code on its destination. Code is duplicated when its
8602 estimated size is smaller than this value multiplied by the estimated size of
8603 unconditional jump in the hot spots of the program.
8604
8605 The @option{reorder-block-duplicate-feedback} is used only when profile
8606 feedback is available and may be set to higher values than
8607 @option{reorder-block-duplicate} since information about the hot spots is more
8608 accurate.
8609
8610 @item max-sched-ready-insns
8611 The maximum number of instructions ready to be issued the scheduler should
8612 consider at any given time during the first scheduling pass. Increasing
8613 values mean more thorough searches, making the compilation time increase
8614 with probably little benefit. The default value is 100.
8615
8616 @item max-sched-region-blocks
8617 The maximum number of blocks in a region to be considered for
8618 interblock scheduling. The default value is 10.
8619
8620 @item max-pipeline-region-blocks
8621 The maximum number of blocks in a region to be considered for
8622 pipelining in the selective scheduler. The default value is 15.
8623
8624 @item max-sched-region-insns
8625 The maximum number of insns in a region to be considered for
8626 interblock scheduling. The default value is 100.
8627
8628 @item max-pipeline-region-insns
8629 The maximum number of insns in a region to be considered for
8630 pipelining in the selective scheduler. The default value is 200.
8631
8632 @item min-spec-prob
8633 The minimum probability (in percents) of reaching a source block
8634 for interblock speculative scheduling. The default value is 40.
8635
8636 @item max-sched-extend-regions-iters
8637 The maximum number of iterations through CFG to extend regions.
8638 0 - disable region extension,
8639 N - do at most N iterations.
8640 The default value is 0.
8641
8642 @item max-sched-insn-conflict-delay
8643 The maximum conflict delay for an insn to be considered for speculative motion.
8644 The default value is 3.
8645
8646 @item sched-spec-prob-cutoff
8647 The minimal probability of speculation success (in percents), so that
8648 speculative insn will be scheduled.
8649 The default value is 40.
8650
8651 @item sched-mem-true-dep-cost
8652 Minimal distance (in CPU cycles) between store and load targeting same
8653 memory locations. The default value is 1.
8654
8655 @item selsched-max-lookahead
8656 The maximum size of the lookahead window of selective scheduling. It is a
8657 depth of search for available instructions.
8658 The default value is 50.
8659
8660 @item selsched-max-sched-times
8661 The maximum number of times that an instruction will be scheduled during
8662 selective scheduling. This is the limit on the number of iterations
8663 through which the instruction may be pipelined. The default value is 2.
8664
8665 @item selsched-max-insns-to-rename
8666 The maximum number of best instructions in the ready list that are considered
8667 for renaming in the selective scheduler. The default value is 2.
8668
8669 @item max-last-value-rtl
8670 The maximum size measured as number of RTLs that can be recorded in an expression
8671 in combiner for a pseudo register as last known value of that register. The default
8672 is 10000.
8673
8674 @item integer-share-limit
8675 Small integer constants can use a shared data structure, reducing the
8676 compiler's memory usage and increasing its speed. This sets the maximum
8677 value of a shared integer constant. The default value is 256.
8678
8679 @item min-virtual-mappings
8680 Specifies the minimum number of virtual mappings in the incremental
8681 SSA updater that should be registered to trigger the virtual mappings
8682 heuristic defined by virtual-mappings-ratio. The default value is
8683 100.
8684
8685 @item virtual-mappings-ratio
8686 If the number of virtual mappings is virtual-mappings-ratio bigger
8687 than the number of virtual symbols to be updated, then the incremental
8688 SSA updater switches to a full update for those symbols. The default
8689 ratio is 3.
8690
8691 @item ssp-buffer-size
8692 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8693 protection when @option{-fstack-protection} is used.
8694
8695 @item max-jump-thread-duplication-stmts
8696 Maximum number of statements allowed in a block that needs to be
8697 duplicated when threading jumps.
8698
8699 @item max-fields-for-field-sensitive
8700 Maximum number of fields in a structure we will treat in
8701 a field sensitive manner during pointer analysis. The default is zero
8702 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8703
8704 @item prefetch-latency
8705 Estimate on average number of instructions that are executed before
8706 prefetch finishes. The distance we prefetch ahead is proportional
8707 to this constant. Increasing this number may also lead to less
8708 streams being prefetched (see @option{simultaneous-prefetches}).
8709
8710 @item simultaneous-prefetches
8711 Maximum number of prefetches that can run at the same time.
8712
8713 @item l1-cache-line-size
8714 The size of cache line in L1 cache, in bytes.
8715
8716 @item l1-cache-size
8717 The size of L1 cache, in kilobytes.
8718
8719 @item l2-cache-size
8720 The size of L2 cache, in kilobytes.
8721
8722 @item min-insn-to-prefetch-ratio
8723 The minimum ratio between the number of instructions and the
8724 number of prefetches to enable prefetching in a loop.
8725
8726 @item prefetch-min-insn-to-mem-ratio
8727 The minimum ratio between the number of instructions and the
8728 number of memory references to enable prefetching in a loop.
8729
8730 @item use-canonical-types
8731 Whether the compiler should use the ``canonical'' type system. By
8732 default, this should always be 1, which uses a more efficient internal
8733 mechanism for comparing types in C++ and Objective-C++. However, if
8734 bugs in the canonical type system are causing compilation failures,
8735 set this value to 0 to disable canonical types.
8736
8737 @item switch-conversion-max-branch-ratio
8738 Switch initialization conversion will refuse to create arrays that are
8739 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8740 branches in the switch.
8741
8742 @item max-partial-antic-length
8743 Maximum length of the partial antic set computed during the tree
8744 partial redundancy elimination optimization (@option{-ftree-pre}) when
8745 optimizing at @option{-O3} and above. For some sorts of source code
8746 the enhanced partial redundancy elimination optimization can run away,
8747 consuming all of the memory available on the host machine. This
8748 parameter sets a limit on the length of the sets that are computed,
8749 which prevents the runaway behavior. Setting a value of 0 for
8750 this parameter will allow an unlimited set length.
8751
8752 @item sccvn-max-scc-size
8753 Maximum size of a strongly connected component (SCC) during SCCVN
8754 processing. If this limit is hit, SCCVN processing for the whole
8755 function will not be done and optimizations depending on it will
8756 be disabled. The default maximum SCC size is 10000.
8757
8758 @item ira-max-loops-num
8759 IRA uses a regional register allocation by default. If a function
8760 contains loops more than number given by the parameter, only at most
8761 given number of the most frequently executed loops will form regions
8762 for the regional register allocation. The default value of the
8763 parameter is 100.
8764
8765 @item ira-max-conflict-table-size
8766 Although IRA uses a sophisticated algorithm of compression conflict
8767 table, the table can be still big for huge functions. If the conflict
8768 table for a function could be more than size in MB given by the
8769 parameter, the conflict table is not built and faster, simpler, and
8770 lower quality register allocation algorithm will be used. The
8771 algorithm do not use pseudo-register conflicts. The default value of
8772 the parameter is 2000.
8773
8774 @item ira-loop-reserved-regs
8775 IRA can be used to evaluate more accurate register pressure in loops
8776 for decision to move loop invariants (see @option{-O3}). The number
8777 of available registers reserved for some other purposes is described
8778 by this parameter. The default value of the parameter is 2 which is
8779 minimal number of registers needed for execution of typical
8780 instruction. This value is the best found from numerous experiments.
8781
8782 @item loop-invariant-max-bbs-in-loop
8783 Loop invariant motion can be very expensive, both in compile time and
8784 in amount of needed compile time memory, with very large loops. Loops
8785 with more basic blocks than this parameter won't have loop invariant
8786 motion optimization performed on them. The default value of the
8787 parameter is 1000 for -O1 and 10000 for -O2 and above.
8788
8789 @item max-vartrack-size
8790 Sets a maximum number of hash table slots to use during variable
8791 tracking dataflow analysis of any function. If this limit is exceeded
8792 with variable tracking at assignments enabled, analysis for that
8793 function is retried without it, after removing all debug insns from
8794 the function. If the limit is exceeded even without debug insns, var
8795 tracking analysis is completely disabled for the function. Setting
8796 the parameter to zero makes it unlimited.
8797
8798 @item min-nondebug-insn-uid
8799 Use uids starting at this parameter for nondebug insns. The range below
8800 the parameter is reserved exclusively for debug insns created by
8801 @option{-fvar-tracking-assignments}, but debug insns may get
8802 (non-overlapping) uids above it if the reserved range is exhausted.
8803
8804 @item ipa-sra-ptr-growth-factor
8805 IPA-SRA will replace a pointer to an aggregate with one or more new
8806 parameters only when their cumulative size is less or equal to
8807 @option{ipa-sra-ptr-growth-factor} times the size of the original
8808 pointer parameter.
8809
8810 @item graphite-max-nb-scop-params
8811 To avoid exponential effects in the Graphite loop transforms, the
8812 number of parameters in a Static Control Part (SCoP) is bounded. The
8813 default value is 10 parameters. A variable whose value is unknown at
8814 compile time and defined outside a SCoP is a parameter of the SCoP.
8815
8816 @item graphite-max-bbs-per-function
8817 To avoid exponential effects in the detection of SCoPs, the size of
8818 the functions analyzed by Graphite is bounded. The default value is
8819 100 basic blocks.
8820
8821 @item loop-block-tile-size
8822 Loop blocking or strip mining transforms, enabled with
8823 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8824 loop in the loop nest by a given number of iterations. The strip
8825 length can be changed using the @option{loop-block-tile-size}
8826 parameter. The default value is 51 iterations.
8827
8828 @item devirt-type-list-size
8829 IPA-CP attempts to track all possible types passed to a function's
8830 parameter in order to perform devirtualization.
8831 @option{devirt-type-list-size} is the maximum number of types it
8832 stores per a single formal parameter of a function.
8833
8834 @item lto-partitions
8835 Specify desired number of partitions produced during WHOPR compilation.
8836 The number of partitions should exceed the number of CPUs used for compilation.
8837 The default value is 32.
8838
8839 @item lto-minpartition
8840 Size of minimal partition for WHOPR (in estimated instructions).
8841 This prevents expenses of splitting very small programs into too many
8842 partitions.
8843
8844 @item cxx-max-namespaces-for-diagnostic-help
8845 The maximum number of namespaces to consult for suggestions when C++
8846 name lookup fails for an identifier. The default is 1000.
8847
8848 @end table
8849 @end table
8850
8851 @node Preprocessor Options
8852 @section Options Controlling the Preprocessor
8853 @cindex preprocessor options
8854 @cindex options, preprocessor
8855
8856 These options control the C preprocessor, which is run on each C source
8857 file before actual compilation.
8858
8859 If you use the @option{-E} option, nothing is done except preprocessing.
8860 Some of these options make sense only together with @option{-E} because
8861 they cause the preprocessor output to be unsuitable for actual
8862 compilation.
8863
8864 @table @gcctabopt
8865 @item -Wp,@var{option}
8866 @opindex Wp
8867 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8868 and pass @var{option} directly through to the preprocessor. If
8869 @var{option} contains commas, it is split into multiple options at the
8870 commas. However, many options are modified, translated or interpreted
8871 by the compiler driver before being passed to the preprocessor, and
8872 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
8873 interface is undocumented and subject to change, so whenever possible
8874 you should avoid using @option{-Wp} and let the driver handle the
8875 options instead.
8876
8877 @item -Xpreprocessor @var{option}
8878 @opindex Xpreprocessor
8879 Pass @var{option} as an option to the preprocessor. You can use this to
8880 supply system-specific preprocessor options which GCC does not know how to
8881 recognize.
8882
8883 If you want to pass an option that takes an argument, you must use
8884 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8885 @end table
8886
8887 @include cppopts.texi
8888
8889 @node Assembler Options
8890 @section Passing Options to the Assembler
8891
8892 @c prevent bad page break with this line
8893 You can pass options to the assembler.
8894
8895 @table @gcctabopt
8896 @item -Wa,@var{option}
8897 @opindex Wa
8898 Pass @var{option} as an option to the assembler. If @var{option}
8899 contains commas, it is split into multiple options at the commas.
8900
8901 @item -Xassembler @var{option}
8902 @opindex Xassembler
8903 Pass @var{option} as an option to the assembler. You can use this to
8904 supply system-specific assembler options which GCC does not know how to
8905 recognize.
8906
8907 If you want to pass an option that takes an argument, you must use
8908 @option{-Xassembler} twice, once for the option and once for the argument.
8909
8910 @end table
8911
8912 @node Link Options
8913 @section Options for Linking
8914 @cindex link options
8915 @cindex options, linking
8916
8917 These options come into play when the compiler links object files into
8918 an executable output file. They are meaningless if the compiler is
8919 not doing a link step.
8920
8921 @table @gcctabopt
8922 @cindex file names
8923 @item @var{object-file-name}
8924 A file name that does not end in a special recognized suffix is
8925 considered to name an object file or library. (Object files are
8926 distinguished from libraries by the linker according to the file
8927 contents.) If linking is done, these object files are used as input
8928 to the linker.
8929
8930 @item -c
8931 @itemx -S
8932 @itemx -E
8933 @opindex c
8934 @opindex S
8935 @opindex E
8936 If any of these options is used, then the linker is not run, and
8937 object file names should not be used as arguments. @xref{Overall
8938 Options}.
8939
8940 @cindex Libraries
8941 @item -l@var{library}
8942 @itemx -l @var{library}
8943 @opindex l
8944 Search the library named @var{library} when linking. (The second
8945 alternative with the library as a separate argument is only for
8946 POSIX compliance and is not recommended.)
8947
8948 It makes a difference where in the command you write this option; the
8949 linker searches and processes libraries and object files in the order they
8950 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8951 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
8952 to functions in @samp{z}, those functions may not be loaded.
8953
8954 The linker searches a standard list of directories for the library,
8955 which is actually a file named @file{lib@var{library}.a}. The linker
8956 then uses this file as if it had been specified precisely by name.
8957
8958 The directories searched include several standard system directories
8959 plus any that you specify with @option{-L}.
8960
8961 Normally the files found this way are library files---archive files
8962 whose members are object files. The linker handles an archive file by
8963 scanning through it for members which define symbols that have so far
8964 been referenced but not defined. But if the file that is found is an
8965 ordinary object file, it is linked in the usual fashion. The only
8966 difference between using an @option{-l} option and specifying a file name
8967 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8968 and searches several directories.
8969
8970 @item -lobjc
8971 @opindex lobjc
8972 You need this special case of the @option{-l} option in order to
8973 link an Objective-C or Objective-C++ program.
8974
8975 @item -nostartfiles
8976 @opindex nostartfiles
8977 Do not use the standard system startup files when linking.
8978 The standard system libraries are used normally, unless @option{-nostdlib}
8979 or @option{-nodefaultlibs} is used.
8980
8981 @item -nodefaultlibs
8982 @opindex nodefaultlibs
8983 Do not use the standard system libraries when linking.
8984 Only the libraries you specify will be passed to the linker, options
8985 specifying linkage of the system libraries, such as @code{-static-libgcc}
8986 or @code{-shared-libgcc}, will be ignored.
8987 The standard startup files are used normally, unless @option{-nostartfiles}
8988 is used. The compiler may generate calls to @code{memcmp},
8989 @code{memset}, @code{memcpy} and @code{memmove}.
8990 These entries are usually resolved by entries in
8991 libc. These entry points should be supplied through some other
8992 mechanism when this option is specified.
8993
8994 @item -nostdlib
8995 @opindex nostdlib
8996 Do not use the standard system startup files or libraries when linking.
8997 No startup files and only the libraries you specify will be passed to
8998 the linker, options specifying linkage of the system libraries, such as
8999 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
9000 The compiler may generate calls to @code{memcmp}, @code{memset},
9001 @code{memcpy} and @code{memmove}.
9002 These entries are usually resolved by entries in
9003 libc. These entry points should be supplied through some other
9004 mechanism when this option is specified.
9005
9006 @cindex @option{-lgcc}, use with @option{-nostdlib}
9007 @cindex @option{-nostdlib} and unresolved references
9008 @cindex unresolved references and @option{-nostdlib}
9009 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9010 @cindex @option{-nodefaultlibs} and unresolved references
9011 @cindex unresolved references and @option{-nodefaultlibs}
9012 One of the standard libraries bypassed by @option{-nostdlib} and
9013 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9014 that GCC uses to overcome shortcomings of particular machines, or special
9015 needs for some languages.
9016 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9017 Collection (GCC) Internals},
9018 for more discussion of @file{libgcc.a}.)
9019 In most cases, you need @file{libgcc.a} even when you want to avoid
9020 other standard libraries. In other words, when you specify @option{-nostdlib}
9021 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9022 This ensures that you have no unresolved references to internal GCC
9023 library subroutines. (For example, @samp{__main}, used to ensure C++
9024 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
9025 GNU Compiler Collection (GCC) Internals}.)
9026
9027 @item -pie
9028 @opindex pie
9029 Produce a position independent executable on targets which support it.
9030 For predictable results, you must also specify the same set of options
9031 that were used to generate code (@option{-fpie}, @option{-fPIE},
9032 or model suboptions) when you specify this option.
9033
9034 @item -rdynamic
9035 @opindex rdynamic
9036 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9037 that support it. This instructs the linker to add all symbols, not
9038 only used ones, to the dynamic symbol table. This option is needed
9039 for some uses of @code{dlopen} or to allow obtaining backtraces
9040 from within a program.
9041
9042 @item -s
9043 @opindex s
9044 Remove all symbol table and relocation information from the executable.
9045
9046 @item -static
9047 @opindex static
9048 On systems that support dynamic linking, this prevents linking with the shared
9049 libraries. On other systems, this option has no effect.
9050
9051 @item -shared
9052 @opindex shared
9053 Produce a shared object which can then be linked with other objects to
9054 form an executable. Not all systems support this option. For predictable
9055 results, you must also specify the same set of options that were used to
9056 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
9057 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
9058 needs to build supplementary stub code for constructors to work. On
9059 multi-libbed systems, @samp{gcc -shared} must select the correct support
9060 libraries to link against. Failing to supply the correct flags may lead
9061 to subtle defects. Supplying them in cases where they are not necessary
9062 is innocuous.}
9063
9064 @item -shared-libgcc
9065 @itemx -static-libgcc
9066 @opindex shared-libgcc
9067 @opindex static-libgcc
9068 On systems that provide @file{libgcc} as a shared library, these options
9069 force the use of either the shared or static version respectively.
9070 If no shared version of @file{libgcc} was built when the compiler was
9071 configured, these options have no effect.
9072
9073 There are several situations in which an application should use the
9074 shared @file{libgcc} instead of the static version. The most common
9075 of these is when the application wishes to throw and catch exceptions
9076 across different shared libraries. In that case, each of the libraries
9077 as well as the application itself should use the shared @file{libgcc}.
9078
9079 Therefore, the G++ and GCJ drivers automatically add
9080 @option{-shared-libgcc} whenever you build a shared library or a main
9081 executable, because C++ and Java programs typically use exceptions, so
9082 this is the right thing to do.
9083
9084 If, instead, you use the GCC driver to create shared libraries, you may
9085 find that they will not always be linked with the shared @file{libgcc}.
9086 If GCC finds, at its configuration time, that you have a non-GNU linker
9087 or a GNU linker that does not support option @option{--eh-frame-hdr},
9088 it will link the shared version of @file{libgcc} into shared libraries
9089 by default. Otherwise, it will take advantage of the linker and optimize
9090 away the linking with the shared version of @file{libgcc}, linking with
9091 the static version of libgcc by default. This allows exceptions to
9092 propagate through such shared libraries, without incurring relocation
9093 costs at library load time.
9094
9095 However, if a library or main executable is supposed to throw or catch
9096 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9097 for the languages used in the program, or using the option
9098 @option{-shared-libgcc}, such that it is linked with the shared
9099 @file{libgcc}.
9100
9101 @item -static-libstdc++
9102 When the @command{g++} program is used to link a C++ program, it will
9103 normally automatically link against @option{libstdc++}. If
9104 @file{libstdc++} is available as a shared library, and the
9105 @option{-static} option is not used, then this will link against the
9106 shared version of @file{libstdc++}. That is normally fine. However, it
9107 is sometimes useful to freeze the version of @file{libstdc++} used by
9108 the program without going all the way to a fully static link. The
9109 @option{-static-libstdc++} option directs the @command{g++} driver to
9110 link @file{libstdc++} statically, without necessarily linking other
9111 libraries statically.
9112
9113 @item -symbolic
9114 @opindex symbolic
9115 Bind references to global symbols when building a shared object. Warn
9116 about any unresolved references (unless overridden by the link editor
9117 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
9118 this option.
9119
9120 @item -T @var{script}
9121 @opindex T
9122 @cindex linker script
9123 Use @var{script} as the linker script. This option is supported by most
9124 systems using the GNU linker. On some targets, such as bare-board
9125 targets without an operating system, the @option{-T} option may be required
9126 when linking to avoid references to undefined symbols.
9127
9128 @item -Xlinker @var{option}
9129 @opindex Xlinker
9130 Pass @var{option} as an option to the linker. You can use this to
9131 supply system-specific linker options which GCC does not know how to
9132 recognize.
9133
9134 If you want to pass an option that takes a separate argument, you must use
9135 @option{-Xlinker} twice, once for the option and once for the argument.
9136 For example, to pass @option{-assert definitions}, you must write
9137 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
9138 @option{-Xlinker "-assert definitions"}, because this passes the entire
9139 string as a single argument, which is not what the linker expects.
9140
9141 When using the GNU linker, it is usually more convenient to pass
9142 arguments to linker options using the @option{@var{option}=@var{value}}
9143 syntax than as separate arguments. For example, you can specify
9144 @samp{-Xlinker -Map=output.map} rather than
9145 @samp{-Xlinker -Map -Xlinker output.map}. Other linkers may not support
9146 this syntax for command-line options.
9147
9148 @item -Wl,@var{option}
9149 @opindex Wl
9150 Pass @var{option} as an option to the linker. If @var{option} contains
9151 commas, it is split into multiple options at the commas. You can use this
9152 syntax to pass an argument to the option.
9153 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9154 linker. When using the GNU linker, you can also get the same effect with
9155 @samp{-Wl,-Map=output.map}.
9156
9157 @item -u @var{symbol}
9158 @opindex u
9159 Pretend the symbol @var{symbol} is undefined, to force linking of
9160 library modules to define it. You can use @option{-u} multiple times with
9161 different symbols to force loading of additional library modules.
9162 @end table
9163
9164 @node Directory Options
9165 @section Options for Directory Search
9166 @cindex directory options
9167 @cindex options, directory search
9168 @cindex search path
9169
9170 These options specify directories to search for header files, for
9171 libraries and for parts of the compiler:
9172
9173 @table @gcctabopt
9174 @item -I@var{dir}
9175 @opindex I
9176 Add the directory @var{dir} to the head of the list of directories to be
9177 searched for header files. This can be used to override a system header
9178 file, substituting your own version, since these directories are
9179 searched before the system header file directories. However, you should
9180 not use this option to add directories that contain vendor-supplied
9181 system header files (use @option{-isystem} for that). If you use more than
9182 one @option{-I} option, the directories are scanned in left-to-right
9183 order; the standard system directories come after.
9184
9185 If a standard system include directory, or a directory specified with
9186 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9187 option will be ignored. The directory will still be searched but as a
9188 system directory at its normal position in the system include chain.
9189 This is to ensure that GCC's procedure to fix buggy system headers and
9190 the ordering for the include_next directive are not inadvertently changed.
9191 If you really need to change the search order for system directories,
9192 use the @option{-nostdinc} and/or @option{-isystem} options.
9193
9194 @item -iplugindir=@var{dir}
9195 Set the directory to search for plugins which are passed
9196 by @option{-fplugin=@var{name}} instead of
9197 @option{-fplugin=@var{path}/@var{name}.so}. This option is not meant
9198 to be used by the user, but only passed by the driver.
9199
9200 @item -iquote@var{dir}
9201 @opindex iquote
9202 Add the directory @var{dir} to the head of the list of directories to
9203 be searched for header files only for the case of @samp{#include
9204 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9205 otherwise just like @option{-I}.
9206
9207 @item -L@var{dir}
9208 @opindex L
9209 Add directory @var{dir} to the list of directories to be searched
9210 for @option{-l}.
9211
9212 @item -B@var{prefix}
9213 @opindex B
9214 This option specifies where to find the executables, libraries,
9215 include files, and data files of the compiler itself.
9216
9217 The compiler driver program runs one or more of the subprograms
9218 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
9219 @var{prefix} as a prefix for each program it tries to run, both with and
9220 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9221
9222 For each subprogram to be run, the compiler driver first tries the
9223 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
9224 was not specified, the driver tries two standard prefixes, which are
9225 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
9226 those results in a file name that is found, the unmodified program
9227 name is searched for using the directories specified in your
9228 @env{PATH} environment variable.
9229
9230 The compiler will check to see if the path provided by the @option{-B}
9231 refers to a directory, and if necessary it will add a directory
9232 separator character at the end of the path.
9233
9234 @option{-B} prefixes that effectively specify directory names also apply
9235 to libraries in the linker, because the compiler translates these
9236 options into @option{-L} options for the linker. They also apply to
9237 includes files in the preprocessor, because the compiler translates these
9238 options into @option{-isystem} options for the preprocessor. In this case,
9239 the compiler appends @samp{include} to the prefix.
9240
9241 The run-time support file @file{libgcc.a} can also be searched for using
9242 the @option{-B} prefix, if needed. If it is not found there, the two
9243 standard prefixes above are tried, and that is all. The file is left
9244 out of the link if it is not found by those means.
9245
9246 Another way to specify a prefix much like the @option{-B} prefix is to use
9247 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
9248 Variables}.
9249
9250 As a special kludge, if the path provided by @option{-B} is
9251 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9252 9, then it will be replaced by @file{[dir/]include}. This is to help
9253 with boot-strapping the compiler.
9254
9255 @item -specs=@var{file}
9256 @opindex specs
9257 Process @var{file} after the compiler reads in the standard @file{specs}
9258 file, in order to override the defaults that the @file{gcc} driver
9259 program uses when determining what switches to pass to @file{cc1},
9260 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
9261 @option{-specs=@var{file}} can be specified on the command line, and they
9262 are processed in order, from left to right.
9263
9264 @item --sysroot=@var{dir}
9265 @opindex sysroot
9266 Use @var{dir} as the logical root directory for headers and libraries.
9267 For example, if the compiler would normally search for headers in
9268 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9269 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9270
9271 If you use both this option and the @option{-isysroot} option, then
9272 the @option{--sysroot} option will apply to libraries, but the
9273 @option{-isysroot} option will apply to header files.
9274
9275 The GNU linker (beginning with version 2.16) has the necessary support
9276 for this option. If your linker does not support this option, the
9277 header file aspect of @option{--sysroot} will still work, but the
9278 library aspect will not.
9279
9280 @item -I-
9281 @opindex I-
9282 This option has been deprecated. Please use @option{-iquote} instead for
9283 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9284 Any directories you specify with @option{-I} options before the @option{-I-}
9285 option are searched only for the case of @samp{#include "@var{file}"};
9286 they are not searched for @samp{#include <@var{file}>}.
9287
9288 If additional directories are specified with @option{-I} options after
9289 the @option{-I-}, these directories are searched for all @samp{#include}
9290 directives. (Ordinarily @emph{all} @option{-I} directories are used
9291 this way.)
9292
9293 In addition, the @option{-I-} option inhibits the use of the current
9294 directory (where the current input file came from) as the first search
9295 directory for @samp{#include "@var{file}"}. There is no way to
9296 override this effect of @option{-I-}. With @option{-I.} you can specify
9297 searching the directory which was current when the compiler was
9298 invoked. That is not exactly the same as what the preprocessor does
9299 by default, but it is often satisfactory.
9300
9301 @option{-I-} does not inhibit the use of the standard system directories
9302 for header files. Thus, @option{-I-} and @option{-nostdinc} are
9303 independent.
9304 @end table
9305
9306 @c man end
9307
9308 @node Spec Files
9309 @section Specifying subprocesses and the switches to pass to them
9310 @cindex Spec Files
9311
9312 @command{gcc} is a driver program. It performs its job by invoking a
9313 sequence of other programs to do the work of compiling, assembling and
9314 linking. GCC interprets its command-line parameters and uses these to
9315 deduce which programs it should invoke, and which command-line options
9316 it ought to place on their command lines. This behavior is controlled
9317 by @dfn{spec strings}. In most cases there is one spec string for each
9318 program that GCC can invoke, but a few programs have multiple spec
9319 strings to control their behavior. The spec strings built into GCC can
9320 be overridden by using the @option{-specs=} command-line switch to specify
9321 a spec file.
9322
9323 @dfn{Spec files} are plaintext files that are used to construct spec
9324 strings. They consist of a sequence of directives separated by blank
9325 lines. The type of directive is determined by the first non-whitespace
9326 character on the line and it can be one of the following:
9327
9328 @table @code
9329 @item %@var{command}
9330 Issues a @var{command} to the spec file processor. The commands that can
9331 appear here are:
9332
9333 @table @code
9334 @item %include <@var{file}>
9335 @cindex @code{%include}
9336 Search for @var{file} and insert its text at the current point in the
9337 specs file.
9338
9339 @item %include_noerr <@var{file}>
9340 @cindex @code{%include_noerr}
9341 Just like @samp{%include}, but do not generate an error message if the include
9342 file cannot be found.
9343
9344 @item %rename @var{old_name} @var{new_name}
9345 @cindex @code{%rename}
9346 Rename the spec string @var{old_name} to @var{new_name}.
9347
9348 @end table
9349
9350 @item *[@var{spec_name}]:
9351 This tells the compiler to create, override or delete the named spec
9352 string. All lines after this directive up to the next directive or
9353 blank line are considered to be the text for the spec string. If this
9354 results in an empty string then the spec will be deleted. (Or, if the
9355 spec did not exist, then nothing will happened.) Otherwise, if the spec
9356 does not currently exist a new spec will be created. If the spec does
9357 exist then its contents will be overridden by the text of this
9358 directive, unless the first character of that text is the @samp{+}
9359 character, in which case the text will be appended to the spec.
9360
9361 @item [@var{suffix}]:
9362 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
9363 and up to the next directive or blank line are considered to make up the
9364 spec string for the indicated suffix. When the compiler encounters an
9365 input file with the named suffix, it will processes the spec string in
9366 order to work out how to compile that file. For example:
9367
9368 @smallexample
9369 .ZZ:
9370 z-compile -input %i
9371 @end smallexample
9372
9373 This says that any input file whose name ends in @samp{.ZZ} should be
9374 passed to the program @samp{z-compile}, which should be invoked with the
9375 command-line switch @option{-input} and with the result of performing the
9376 @samp{%i} substitution. (See below.)
9377
9378 As an alternative to providing a spec string, the text that follows a
9379 suffix directive can be one of the following:
9380
9381 @table @code
9382 @item @@@var{language}
9383 This says that the suffix is an alias for a known @var{language}. This is
9384 similar to using the @option{-x} command-line switch to GCC to specify a
9385 language explicitly. For example:
9386
9387 @smallexample
9388 .ZZ:
9389 @@c++
9390 @end smallexample
9391
9392 Says that .ZZ files are, in fact, C++ source files.
9393
9394 @item #@var{name}
9395 This causes an error messages saying:
9396
9397 @smallexample
9398 @var{name} compiler not installed on this system.
9399 @end smallexample
9400 @end table
9401
9402 GCC already has an extensive list of suffixes built into it.
9403 This directive will add an entry to the end of the list of suffixes, but
9404 since the list is searched from the end backwards, it is effectively
9405 possible to override earlier entries using this technique.
9406
9407 @end table
9408
9409 GCC has the following spec strings built into it. Spec files can
9410 override these strings or create their own. Note that individual
9411 targets can also add their own spec strings to this list.
9412
9413 @smallexample
9414 asm Options to pass to the assembler
9415 asm_final Options to pass to the assembler post-processor
9416 cpp Options to pass to the C preprocessor
9417 cc1 Options to pass to the C compiler
9418 cc1plus Options to pass to the C++ compiler
9419 endfile Object files to include at the end of the link
9420 link Options to pass to the linker
9421 lib Libraries to include on the command line to the linker
9422 libgcc Decides which GCC support library to pass to the linker
9423 linker Sets the name of the linker
9424 predefines Defines to be passed to the C preprocessor
9425 signed_char Defines to pass to CPP to say whether @code{char} is signed
9426 by default
9427 startfile Object files to include at the start of the link
9428 @end smallexample
9429
9430 Here is a small example of a spec file:
9431
9432 @smallexample
9433 %rename lib old_lib
9434
9435 *lib:
9436 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9437 @end smallexample
9438
9439 This example renames the spec called @samp{lib} to @samp{old_lib} and
9440 then overrides the previous definition of @samp{lib} with a new one.
9441 The new definition adds in some extra command-line options before
9442 including the text of the old definition.
9443
9444 @dfn{Spec strings} are a list of command-line options to be passed to their
9445 corresponding program. In addition, the spec strings can contain
9446 @samp{%}-prefixed sequences to substitute variable text or to
9447 conditionally insert text into the command line. Using these constructs
9448 it is possible to generate quite complex command lines.
9449
9450 Here is a table of all defined @samp{%}-sequences for spec
9451 strings. Note that spaces are not generated automatically around the
9452 results of expanding these sequences. Therefore you can concatenate them
9453 together or combine them with constant text in a single argument.
9454
9455 @table @code
9456 @item %%
9457 Substitute one @samp{%} into the program name or argument.
9458
9459 @item %i
9460 Substitute the name of the input file being processed.
9461
9462 @item %b
9463 Substitute the basename of the input file being processed.
9464 This is the substring up to (and not including) the last period
9465 and not including the directory.
9466
9467 @item %B
9468 This is the same as @samp{%b}, but include the file suffix (text after
9469 the last period).
9470
9471 @item %d
9472 Marks the argument containing or following the @samp{%d} as a
9473 temporary file name, so that that file will be deleted if GCC exits
9474 successfully. Unlike @samp{%g}, this contributes no text to the
9475 argument.
9476
9477 @item %g@var{suffix}
9478 Substitute a file name that has suffix @var{suffix} and is chosen
9479 once per compilation, and mark the argument in the same way as
9480 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
9481 name is now chosen in a way that is hard to predict even when previously
9482 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9483 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
9484 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9485 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
9486 was simply substituted with a file name chosen once per compilation,
9487 without regard to any appended suffix (which was therefore treated
9488 just like ordinary text), making such attacks more likely to succeed.
9489
9490 @item %u@var{suffix}
9491 Like @samp{%g}, but generates a new temporary file name even if
9492 @samp{%u@var{suffix}} was already seen.
9493
9494 @item %U@var{suffix}
9495 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9496 new one if there is no such last file name. In the absence of any
9497 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9498 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9499 would involve the generation of two distinct file names, one
9500 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
9501 simply substituted with a file name chosen for the previous @samp{%u},
9502 without regard to any appended suffix.
9503
9504 @item %j@var{suffix}
9505 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9506 writable, and if save-temps is off; otherwise, substitute the name
9507 of a temporary file, just like @samp{%u}. This temporary file is not
9508 meant for communication between processes, but rather as a junk
9509 disposal mechanism.
9510
9511 @item %|@var{suffix}
9512 @itemx %m@var{suffix}
9513 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
9514 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9515 all. These are the two most common ways to instruct a program that it
9516 should read from standard input or write to standard output. If you
9517 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9518 construct: see for example @file{f/lang-specs.h}.
9519
9520 @item %.@var{SUFFIX}
9521 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9522 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
9523 terminated by the next space or %.
9524
9525 @item %w
9526 Marks the argument containing or following the @samp{%w} as the
9527 designated output file of this compilation. This puts the argument
9528 into the sequence of arguments that @samp{%o} will substitute later.
9529
9530 @item %o
9531 Substitutes the names of all the output files, with spaces
9532 automatically placed around them. You should write spaces
9533 around the @samp{%o} as well or the results are undefined.
9534 @samp{%o} is for use in the specs for running the linker.
9535 Input files whose names have no recognized suffix are not compiled
9536 at all, but they are included among the output files, so they will
9537 be linked.
9538
9539 @item %O
9540 Substitutes the suffix for object files. Note that this is
9541 handled specially when it immediately follows @samp{%g, %u, or %U},
9542 because of the need for those to form complete file names. The
9543 handling is such that @samp{%O} is treated exactly as if it had already
9544 been substituted, except that @samp{%g, %u, and %U} do not currently
9545 support additional @var{suffix} characters following @samp{%O} as they would
9546 following, for example, @samp{.o}.
9547
9548 @item %p
9549 Substitutes the standard macro predefinitions for the
9550 current target machine. Use this when running @code{cpp}.
9551
9552 @item %P
9553 Like @samp{%p}, but puts @samp{__} before and after the name of each
9554 predefined macro, except for macros that start with @samp{__} or with
9555 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
9556 C@.
9557
9558 @item %I
9559 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9560 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9561 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9562 and @option{-imultilib} as necessary.
9563
9564 @item %s
9565 Current argument is the name of a library or startup file of some sort.
9566 Search for that file in a standard list of directories and substitute
9567 the full name found. The current working directory is included in the
9568 list of directories scanned.
9569
9570 @item %T
9571 Current argument is the name of a linker script. Search for that file
9572 in the current list of directories to scan for libraries. If the file
9573 is located insert a @option{--script} option into the command line
9574 followed by the full path name found. If the file is not found then
9575 generate an error message. Note: the current working directory is not
9576 searched.
9577
9578 @item %e@var{str}
9579 Print @var{str} as an error message. @var{str} is terminated by a newline.
9580 Use this when inconsistent options are detected.
9581
9582 @item %(@var{name})
9583 Substitute the contents of spec string @var{name} at this point.
9584
9585 @item %[@var{name}]
9586 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9587
9588 @item %x@{@var{option}@}
9589 Accumulate an option for @samp{%X}.
9590
9591 @item %X
9592 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9593 spec string.
9594
9595 @item %Y
9596 Output the accumulated assembler options specified by @option{-Wa}.
9597
9598 @item %Z
9599 Output the accumulated preprocessor options specified by @option{-Wp}.
9600
9601 @item %a
9602 Process the @code{asm} spec. This is used to compute the
9603 switches to be passed to the assembler.
9604
9605 @item %A
9606 Process the @code{asm_final} spec. This is a spec string for
9607 passing switches to an assembler post-processor, if such a program is
9608 needed.
9609
9610 @item %l
9611 Process the @code{link} spec. This is the spec for computing the
9612 command line passed to the linker. Typically it will make use of the
9613 @samp{%L %G %S %D and %E} sequences.
9614
9615 @item %D
9616 Dump out a @option{-L} option for each directory that GCC believes might
9617 contain startup files. If the target supports multilibs then the
9618 current multilib directory will be prepended to each of these paths.
9619
9620 @item %L
9621 Process the @code{lib} spec. This is a spec string for deciding which
9622 libraries should be included on the command line to the linker.
9623
9624 @item %G
9625 Process the @code{libgcc} spec. This is a spec string for deciding
9626 which GCC support library should be included on the command line to the linker.
9627
9628 @item %S
9629 Process the @code{startfile} spec. This is a spec for deciding which
9630 object files should be the first ones passed to the linker. Typically
9631 this might be a file named @file{crt0.o}.
9632
9633 @item %E
9634 Process the @code{endfile} spec. This is a spec string that specifies
9635 the last object files that will be passed to the linker.
9636
9637 @item %C
9638 Process the @code{cpp} spec. This is used to construct the arguments
9639 to be passed to the C preprocessor.
9640
9641 @item %1
9642 Process the @code{cc1} spec. This is used to construct the options to be
9643 passed to the actual C compiler (@samp{cc1}).
9644
9645 @item %2
9646 Process the @code{cc1plus} spec. This is used to construct the options to be
9647 passed to the actual C++ compiler (@samp{cc1plus}).
9648
9649 @item %*
9650 Substitute the variable part of a matched option. See below.
9651 Note that each comma in the substituted string is replaced by
9652 a single space.
9653
9654 @item %<@code{S}
9655 Remove all occurrences of @code{-S} from the command line. Note---this
9656 command is position dependent. @samp{%} commands in the spec string
9657 before this one will see @code{-S}, @samp{%} commands in the spec string
9658 after this one will not.
9659
9660 @item %:@var{function}(@var{args})
9661 Call the named function @var{function}, passing it @var{args}.
9662 @var{args} is first processed as a nested spec string, then split
9663 into an argument vector in the usual fashion. The function returns
9664 a string which is processed as if it had appeared literally as part
9665 of the current spec.
9666
9667 The following built-in spec functions are provided:
9668
9669 @table @code
9670 @item @code{getenv}
9671 The @code{getenv} spec function takes two arguments: an environment
9672 variable name and a string. If the environment variable is not
9673 defined, a fatal error is issued. Otherwise, the return value is the
9674 value of the environment variable concatenated with the string. For
9675 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9676
9677 @smallexample
9678 %:getenv(TOPDIR /include)
9679 @end smallexample
9680
9681 expands to @file{/path/to/top/include}.
9682
9683 @item @code{if-exists}
9684 The @code{if-exists} spec function takes one argument, an absolute
9685 pathname to a file. If the file exists, @code{if-exists} returns the
9686 pathname. Here is a small example of its usage:
9687
9688 @smallexample
9689 *startfile:
9690 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9691 @end smallexample
9692
9693 @item @code{if-exists-else}
9694 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9695 spec function, except that it takes two arguments. The first argument is
9696 an absolute pathname to a file. If the file exists, @code{if-exists-else}
9697 returns the pathname. If it does not exist, it returns the second argument.
9698 This way, @code{if-exists-else} can be used to select one file or another,
9699 based on the existence of the first. Here is a small example of its usage:
9700
9701 @smallexample
9702 *startfile:
9703 crt0%O%s %:if-exists(crti%O%s) \
9704 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9705 @end smallexample
9706
9707 @item @code{replace-outfile}
9708 The @code{replace-outfile} spec function takes two arguments. It looks for the
9709 first argument in the outfiles array and replaces it with the second argument. Here
9710 is a small example of its usage:
9711
9712 @smallexample
9713 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9714 @end smallexample
9715
9716 @item @code{remove-outfile}
9717 The @code{remove-outfile} spec function takes one argument. It looks for the
9718 first argument in the outfiles array and removes it. Here is a small example
9719 its usage:
9720
9721 @smallexample
9722 %:remove-outfile(-lm)
9723 @end smallexample
9724
9725 @item @code{pass-through-libs}
9726 The @code{pass-through-libs} spec function takes any number of arguments. It
9727 finds any @option{-l} options and any non-options ending in ".a" (which it
9728 assumes are the names of linker input library archive files) and returns a
9729 result containing all the found arguments each prepended by
9730 @option{-plugin-opt=-pass-through=} and joined by spaces. This list is
9731 intended to be passed to the LTO linker plugin.
9732
9733 @smallexample
9734 %:pass-through-libs(%G %L %G)
9735 @end smallexample
9736
9737 @item @code{print-asm-header}
9738 The @code{print-asm-header} function takes no arguments and simply
9739 prints a banner like:
9740
9741 @smallexample
9742 Assembler options
9743 =================
9744
9745 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9746 @end smallexample
9747
9748 It is used to separate compiler options from assembler options
9749 in the @option{--target-help} output.
9750 @end table
9751
9752 @item %@{@code{S}@}
9753 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9754 If that switch was not specified, this substitutes nothing. Note that
9755 the leading dash is omitted when specifying this option, and it is
9756 automatically inserted if the substitution is performed. Thus the spec
9757 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9758 and would output the command line option @option{-foo}.
9759
9760 @item %W@{@code{S}@}
9761 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9762 deleted on failure.
9763
9764 @item %@{@code{S}*@}
9765 Substitutes all the switches specified to GCC whose names start
9766 with @code{-S}, but which also take an argument. This is used for
9767 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9768 GCC considers @option{-o foo} as being
9769 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
9770 text, including the space. Thus two arguments would be generated.
9771
9772 @item %@{@code{S}*&@code{T}*@}
9773 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9774 (the order of @code{S} and @code{T} in the spec is not significant).
9775 There can be any number of ampersand-separated variables; for each the
9776 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
9777
9778 @item %@{@code{S}:@code{X}@}
9779 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9780
9781 @item %@{!@code{S}:@code{X}@}
9782 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9783
9784 @item %@{@code{S}*:@code{X}@}
9785 Substitutes @code{X} if one or more switches whose names start with
9786 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
9787 once, no matter how many such switches appeared. However, if @code{%*}
9788 appears somewhere in @code{X}, then @code{X} will be substituted once
9789 for each matching switch, with the @code{%*} replaced by the part of
9790 that switch that matched the @code{*}.
9791
9792 @item %@{.@code{S}:@code{X}@}
9793 Substitutes @code{X}, if processing a file with suffix @code{S}.
9794
9795 @item %@{!.@code{S}:@code{X}@}
9796 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9797
9798 @item %@{,@code{S}:@code{X}@}
9799 Substitutes @code{X}, if processing a file for language @code{S}.
9800
9801 @item %@{!,@code{S}:@code{X}@}
9802 Substitutes @code{X}, if not processing a file for language @code{S}.
9803
9804 @item %@{@code{S}|@code{P}:@code{X}@}
9805 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9806 GCC@. This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9807 @code{*} sequences as well, although they have a stronger binding than
9808 the @samp{|}. If @code{%*} appears in @code{X}, all of the
9809 alternatives must be starred, and only the first matching alternative
9810 is substituted.
9811
9812 For example, a spec string like this:
9813
9814 @smallexample
9815 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9816 @end smallexample
9817
9818 will output the following command-line options from the following input
9819 command-line options:
9820
9821 @smallexample
9822 fred.c -foo -baz
9823 jim.d -bar -boggle
9824 -d fred.c -foo -baz -boggle
9825 -d jim.d -bar -baz -boggle
9826 @end smallexample
9827
9828 @item %@{S:X; T:Y; :D@}
9829
9830 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9831 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
9832 be as many clauses as you need. This may be combined with @code{.},
9833 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9834
9835
9836 @end table
9837
9838 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9839 construct may contain other nested @samp{%} constructs or spaces, or
9840 even newlines. They are processed as usual, as described above.
9841 Trailing white space in @code{X} is ignored. White space may also
9842 appear anywhere on the left side of the colon in these constructs,
9843 except between @code{.} or @code{*} and the corresponding word.
9844
9845 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9846 handled specifically in these constructs. If another value of
9847 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9848 @option{-W} switch is found later in the command line, the earlier
9849 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9850 just one letter, which passes all matching options.
9851
9852 The character @samp{|} at the beginning of the predicate text is used to
9853 indicate that a command should be piped to the following command, but
9854 only if @option{-pipe} is specified.
9855
9856 It is built into GCC which switches take arguments and which do not.
9857 (You might think it would be useful to generalize this to allow each
9858 compiler's spec to say which switches take arguments. But this cannot
9859 be done in a consistent fashion. GCC cannot even decide which input
9860 files have been specified without knowing which switches take arguments,
9861 and it must know which input files to compile in order to tell which
9862 compilers to run).
9863
9864 GCC also knows implicitly that arguments starting in @option{-l} are to be
9865 treated as compiler output files, and passed to the linker in their
9866 proper position among the other output files.
9867
9868 @c man begin OPTIONS
9869
9870 @node Target Options
9871 @section Specifying Target Machine and Compiler Version
9872 @cindex target options
9873 @cindex cross compiling
9874 @cindex specifying machine version
9875 @cindex specifying compiler version and target machine
9876 @cindex compiler version, specifying
9877 @cindex target machine, specifying
9878
9879 The usual way to run GCC is to run the executable called @command{gcc}, or
9880 @command{@var{machine}-gcc} when cross-compiling, or
9881 @command{@var{machine}-gcc-@var{version}} to run a version other than the
9882 one that was installed last.
9883
9884 @node Submodel Options
9885 @section Hardware Models and Configurations
9886 @cindex submodel options
9887 @cindex specifying hardware config
9888 @cindex hardware models and configurations, specifying
9889 @cindex machine dependent options
9890
9891 Each target machine types can have its own
9892 special options, starting with @samp{-m}, to choose among various
9893 hardware models or configurations---for example, 68010 vs 68020,
9894 floating coprocessor or none. A single installed version of the
9895 compiler can compile for any model or configuration, according to the
9896 options specified.
9897
9898 Some configurations of the compiler also support additional special
9899 options, usually for compatibility with other compilers on the same
9900 platform.
9901
9902 @c This list is ordered alphanumerically by subsection name.
9903 @c It should be the same order and spelling as these options are listed
9904 @c in Machine Dependent Options
9905
9906 @menu
9907 * ARC Options::
9908 * ARM Options::
9909 * AVR Options::
9910 * Blackfin Options::
9911 * CRIS Options::
9912 * CRX Options::
9913 * Darwin Options::
9914 * DEC Alpha Options::
9915 * DEC Alpha/VMS Options::
9916 * FR30 Options::
9917 * FRV Options::
9918 * GNU/Linux Options::
9919 * H8/300 Options::
9920 * HPPA Options::
9921 * i386 and x86-64 Options::
9922 * i386 and x86-64 Windows Options::
9923 * IA-64 Options::
9924 * IA-64/VMS Options::
9925 * LM32 Options::
9926 * M32C Options::
9927 * M32R/D Options::
9928 * M680x0 Options::
9929 * M68hc1x Options::
9930 * MCore Options::
9931 * MeP Options::
9932 * MicroBlaze Options::
9933 * MIPS Options::
9934 * MMIX Options::
9935 * MN10300 Options::
9936 * PDP-11 Options::
9937 * picoChip Options::
9938 * PowerPC Options::
9939 * RS/6000 and PowerPC Options::
9940 * RX Options::
9941 * S/390 and zSeries Options::
9942 * Score Options::
9943 * SH Options::
9944 * Solaris 2 Options::
9945 * SPARC Options::
9946 * SPU Options::
9947 * System V Options::
9948 * V850 Options::
9949 * VAX Options::
9950 * VxWorks Options::
9951 * x86-64 Options::
9952 * Xstormy16 Options::
9953 * Xtensa Options::
9954 * zSeries Options::
9955 @end menu
9956
9957 @node ARC Options
9958 @subsection ARC Options
9959 @cindex ARC Options
9960
9961 These options are defined for ARC implementations:
9962
9963 @table @gcctabopt
9964 @item -EL
9965 @opindex EL
9966 Compile code for little endian mode. This is the default.
9967
9968 @item -EB
9969 @opindex EB
9970 Compile code for big endian mode.
9971
9972 @item -mmangle-cpu
9973 @opindex mmangle-cpu
9974 Prepend the name of the cpu to all public symbol names.
9975 In multiple-processor systems, there are many ARC variants with different
9976 instruction and register set characteristics. This flag prevents code
9977 compiled for one cpu to be linked with code compiled for another.
9978 No facility exists for handling variants that are ``almost identical''.
9979 This is an all or nothing option.
9980
9981 @item -mcpu=@var{cpu}
9982 @opindex mcpu
9983 Compile code for ARC variant @var{cpu}.
9984 Which variants are supported depend on the configuration.
9985 All variants support @option{-mcpu=base}, this is the default.
9986
9987 @item -mtext=@var{text-section}
9988 @itemx -mdata=@var{data-section}
9989 @itemx -mrodata=@var{readonly-data-section}
9990 @opindex mtext
9991 @opindex mdata
9992 @opindex mrodata
9993 Put functions, data, and readonly data in @var{text-section},
9994 @var{data-section}, and @var{readonly-data-section} respectively
9995 by default. This can be overridden with the @code{section} attribute.
9996 @xref{Variable Attributes}.
9997
9998 @end table
9999
10000 @node ARM Options
10001 @subsection ARM Options
10002 @cindex ARM options
10003
10004 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10005 architectures:
10006
10007 @table @gcctabopt
10008 @item -mabi=@var{name}
10009 @opindex mabi
10010 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
10011 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10012
10013 @item -mapcs-frame
10014 @opindex mapcs-frame
10015 Generate a stack frame that is compliant with the ARM Procedure Call
10016 Standard for all functions, even if this is not strictly necessary for
10017 correct execution of the code. Specifying @option{-fomit-frame-pointer}
10018 with this option will cause the stack frames not to be generated for
10019 leaf functions. The default is @option{-mno-apcs-frame}.
10020
10021 @item -mapcs
10022 @opindex mapcs
10023 This is a synonym for @option{-mapcs-frame}.
10024
10025 @ignore
10026 @c not currently implemented
10027 @item -mapcs-stack-check
10028 @opindex mapcs-stack-check
10029 Generate code to check the amount of stack space available upon entry to
10030 every function (that actually uses some stack space). If there is
10031 insufficient space available then either the function
10032 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
10033 called, depending upon the amount of stack space required. The run time
10034 system is required to provide these functions. The default is
10035 @option{-mno-apcs-stack-check}, since this produces smaller code.
10036
10037 @c not currently implemented
10038 @item -mapcs-float
10039 @opindex mapcs-float
10040 Pass floating point arguments using the float point registers. This is
10041 one of the variants of the APCS@. This option is recommended if the
10042 target hardware has a floating point unit or if a lot of floating point
10043 arithmetic is going to be performed by the code. The default is
10044 @option{-mno-apcs-float}, since integer only code is slightly increased in
10045 size if @option{-mapcs-float} is used.
10046
10047 @c not currently implemented
10048 @item -mapcs-reentrant
10049 @opindex mapcs-reentrant
10050 Generate reentrant, position independent code. The default is
10051 @option{-mno-apcs-reentrant}.
10052 @end ignore
10053
10054 @item -mthumb-interwork
10055 @opindex mthumb-interwork
10056 Generate code which supports calling between the ARM and Thumb
10057 instruction sets. Without this option the two instruction sets cannot
10058 be reliably used inside one program. The default is
10059 @option{-mno-thumb-interwork}, since slightly larger code is generated
10060 when @option{-mthumb-interwork} is specified.
10061
10062 @item -mno-sched-prolog
10063 @opindex mno-sched-prolog
10064 Prevent the reordering of instructions in the function prolog, or the
10065 merging of those instruction with the instructions in the function's
10066 body. This means that all functions will start with a recognizable set
10067 of instructions (or in fact one of a choice from a small set of
10068 different function prologues), and this information can be used to
10069 locate the start if functions inside an executable piece of code. The
10070 default is @option{-msched-prolog}.
10071
10072 @item -mfloat-abi=@var{name}
10073 @opindex mfloat-abi
10074 Specifies which floating-point ABI to use. Permissible values
10075 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10076
10077 Specifying @samp{soft} causes GCC to generate output containing
10078 library calls for floating-point operations.
10079 @samp{softfp} allows the generation of code using hardware floating-point
10080 instructions, but still uses the soft-float calling conventions.
10081 @samp{hard} allows generation of floating-point instructions
10082 and uses FPU-specific calling conventions.
10083
10084 The default depends on the specific target configuration. Note that
10085 the hard-float and soft-float ABIs are not link-compatible; you must
10086 compile your entire program with the same ABI, and link with a
10087 compatible set of libraries.
10088
10089 @item -mhard-float
10090 @opindex mhard-float
10091 Equivalent to @option{-mfloat-abi=hard}.
10092
10093 @item -msoft-float
10094 @opindex msoft-float
10095 Equivalent to @option{-mfloat-abi=soft}.
10096
10097 @item -mlittle-endian
10098 @opindex mlittle-endian
10099 Generate code for a processor running in little-endian mode. This is
10100 the default for all standard configurations.
10101
10102 @item -mbig-endian
10103 @opindex mbig-endian
10104 Generate code for a processor running in big-endian mode; the default is
10105 to compile code for a little-endian processor.
10106
10107 @item -mwords-little-endian
10108 @opindex mwords-little-endian
10109 This option only applies when generating code for big-endian processors.
10110 Generate code for a little-endian word order but a big-endian byte
10111 order. That is, a byte order of the form @samp{32107654}. Note: this
10112 option should only be used if you require compatibility with code for
10113 big-endian ARM processors generated by versions of the compiler prior to
10114 2.8.
10115
10116 @item -mcpu=@var{name}
10117 @opindex mcpu
10118 This specifies the name of the target ARM processor. GCC uses this name
10119 to determine what kind of instructions it can emit when generating
10120 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
10121 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10122 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10123 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10124 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10125 @samp{arm720},
10126 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10127 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10128 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10129 @samp{strongarm1110},
10130 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10131 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10132 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10133 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10134 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10135 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10136 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10137 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a15},
10138 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m4}, @samp{cortex-m3},
10139 @samp{cortex-m1},
10140 @samp{cortex-m0},
10141 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10142
10143 @item -mtune=@var{name}
10144 @opindex mtune
10145 This option is very similar to the @option{-mcpu=} option, except that
10146 instead of specifying the actual target processor type, and hence
10147 restricting which instructions can be used, it specifies that GCC should
10148 tune the performance of the code as if the target were of the type
10149 specified in this option, but still choosing the instructions that it
10150 will generate based on the cpu specified by a @option{-mcpu=} option.
10151 For some ARM implementations better performance can be obtained by using
10152 this option.
10153
10154 @item -march=@var{name}
10155 @opindex march
10156 This specifies the name of the target ARM architecture. GCC uses this
10157 name to determine what kind of instructions it can emit when generating
10158 assembly code. This option can be used in conjunction with or instead
10159 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
10160 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10161 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10162 @samp{armv6}, @samp{armv6j},
10163 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10164 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10165 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10166
10167 @item -mfpu=@var{name}
10168 @itemx -mfpe=@var{number}
10169 @itemx -mfp=@var{number}
10170 @opindex mfpu
10171 @opindex mfpe
10172 @opindex mfp
10173 This specifies what floating point hardware (or hardware emulation) is
10174 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
10175 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10176 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10177 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10178 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10179 @option{-mfp} and @option{-mfpe} are synonyms for
10180 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10181 of GCC@.
10182
10183 If @option{-msoft-float} is specified this specifies the format of
10184 floating point values.
10185
10186 If the selected floating-point hardware includes the NEON extension
10187 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10188 operations will not be used by GCC's auto-vectorization pass unless
10189 @option{-funsafe-math-optimizations} is also specified. This is
10190 because NEON hardware does not fully implement the IEEE 754 standard for
10191 floating-point arithmetic (in particular denormal values are treated as
10192 zero), so the use of NEON instructions may lead to a loss of precision.
10193
10194 @item -mfp16-format=@var{name}
10195 @opindex mfp16-format
10196 Specify the format of the @code{__fp16} half-precision floating-point type.
10197 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10198 the default is @samp{none}, in which case the @code{__fp16} type is not
10199 defined. @xref{Half-Precision}, for more information.
10200
10201 @item -mstructure-size-boundary=@var{n}
10202 @opindex mstructure-size-boundary
10203 The size of all structures and unions will be rounded up to a multiple
10204 of the number of bits set by this option. Permissible values are 8, 32
10205 and 64. The default value varies for different toolchains. For the COFF
10206 targeted toolchain the default value is 8. A value of 64 is only allowed
10207 if the underlying ABI supports it.
10208
10209 Specifying the larger number can produce faster, more efficient code, but
10210 can also increase the size of the program. Different values are potentially
10211 incompatible. Code compiled with one value cannot necessarily expect to
10212 work with code or libraries compiled with another value, if they exchange
10213 information using structures or unions.
10214
10215 @item -mabort-on-noreturn
10216 @opindex mabort-on-noreturn
10217 Generate a call to the function @code{abort} at the end of a
10218 @code{noreturn} function. It will be executed if the function tries to
10219 return.
10220
10221 @item -mlong-calls
10222 @itemx -mno-long-calls
10223 @opindex mlong-calls
10224 @opindex mno-long-calls
10225 Tells the compiler to perform function calls by first loading the
10226 address of the function into a register and then performing a subroutine
10227 call on this register. This switch is needed if the target function
10228 will lie outside of the 64 megabyte addressing range of the offset based
10229 version of subroutine call instruction.
10230
10231 Even if this switch is enabled, not all function calls will be turned
10232 into long calls. The heuristic is that static functions, functions
10233 which have the @samp{short-call} attribute, functions that are inside
10234 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10235 definitions have already been compiled within the current compilation
10236 unit, will not be turned into long calls. The exception to this rule is
10237 that weak function definitions, functions with the @samp{long-call}
10238 attribute or the @samp{section} attribute, and functions that are within
10239 the scope of a @samp{#pragma long_calls} directive, will always be
10240 turned into long calls.
10241
10242 This feature is not enabled by default. Specifying
10243 @option{-mno-long-calls} will restore the default behavior, as will
10244 placing the function calls within the scope of a @samp{#pragma
10245 long_calls_off} directive. Note these switches have no effect on how
10246 the compiler generates code to handle function calls via function
10247 pointers.
10248
10249 @item -msingle-pic-base
10250 @opindex msingle-pic-base
10251 Treat the register used for PIC addressing as read-only, rather than
10252 loading it in the prologue for each function. The run-time system is
10253 responsible for initializing this register with an appropriate value
10254 before execution begins.
10255
10256 @item -mpic-register=@var{reg}
10257 @opindex mpic-register
10258 Specify the register to be used for PIC addressing. The default is R10
10259 unless stack-checking is enabled, when R9 is used.
10260
10261 @item -mcirrus-fix-invalid-insns
10262 @opindex mcirrus-fix-invalid-insns
10263 @opindex mno-cirrus-fix-invalid-insns
10264 Insert NOPs into the instruction stream to in order to work around
10265 problems with invalid Maverick instruction combinations. This option
10266 is only valid if the @option{-mcpu=ep9312} option has been used to
10267 enable generation of instructions for the Cirrus Maverick floating
10268 point co-processor. This option is not enabled by default, since the
10269 problem is only present in older Maverick implementations. The default
10270 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10271 switch.
10272
10273 @item -mpoke-function-name
10274 @opindex mpoke-function-name
10275 Write the name of each function into the text section, directly
10276 preceding the function prologue. The generated code is similar to this:
10277
10278 @smallexample
10279 t0
10280 .ascii "arm_poke_function_name", 0
10281 .align
10282 t1
10283 .word 0xff000000 + (t1 - t0)
10284 arm_poke_function_name
10285 mov ip, sp
10286 stmfd sp!, @{fp, ip, lr, pc@}
10287 sub fp, ip, #4
10288 @end smallexample
10289
10290 When performing a stack backtrace, code can inspect the value of
10291 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
10292 location @code{pc - 12} and the top 8 bits are set, then we know that
10293 there is a function name embedded immediately preceding this location
10294 and has length @code{((pc[-3]) & 0xff000000)}.
10295
10296 @item -mthumb
10297 @opindex mthumb
10298 Generate code for the Thumb instruction set. The default is to
10299 use the 32-bit ARM instruction set.
10300 This option automatically enables either 16-bit Thumb-1 or
10301 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10302 and @option{-march=@var{name}} options. This option is not passed to the
10303 assembler. If you want to force assembler files to be interpreted as Thumb code,
10304 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10305 option directly to the assembler by prefixing it with @option{-Wa}.
10306
10307 @item -mtpcs-frame
10308 @opindex mtpcs-frame
10309 Generate a stack frame that is compliant with the Thumb Procedure Call
10310 Standard for all non-leaf functions. (A leaf function is one that does
10311 not call any other functions.) The default is @option{-mno-tpcs-frame}.
10312
10313 @item -mtpcs-leaf-frame
10314 @opindex mtpcs-leaf-frame
10315 Generate a stack frame that is compliant with the Thumb Procedure Call
10316 Standard for all leaf functions. (A leaf function is one that does
10317 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
10318
10319 @item -mcallee-super-interworking
10320 @opindex mcallee-super-interworking
10321 Gives all externally visible functions in the file being compiled an ARM
10322 instruction set header which switches to Thumb mode before executing the
10323 rest of the function. This allows these functions to be called from
10324 non-interworking code. This option is not valid in AAPCS configurations
10325 because interworking is enabled by default.
10326
10327 @item -mcaller-super-interworking
10328 @opindex mcaller-super-interworking
10329 Allows calls via function pointers (including virtual functions) to
10330 execute correctly regardless of whether the target code has been
10331 compiled for interworking or not. There is a small overhead in the cost
10332 of executing a function pointer if this option is enabled. This option
10333 is not valid in AAPCS configurations because interworking is enabled
10334 by default.
10335
10336 @item -mtp=@var{name}
10337 @opindex mtp
10338 Specify the access model for the thread local storage pointer. The valid
10339 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10340 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10341 (supported in the arm6k architecture), and @option{auto}, which uses the
10342 best available method for the selected processor. The default setting is
10343 @option{auto}.
10344
10345 @item -mword-relocations
10346 @opindex mword-relocations
10347 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10348 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10349 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10350 is specified.
10351
10352 @item -mfix-cortex-m3-ldrd
10353 @opindex mfix-cortex-m3-ldrd
10354 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10355 with overlapping destination and base registers are used. This option avoids
10356 generating these instructions. This option is enabled by default when
10357 @option{-mcpu=cortex-m3} is specified.
10358
10359 @end table
10360
10361 @node AVR Options
10362 @subsection AVR Options
10363 @cindex AVR Options
10364
10365 These options are defined for AVR implementations:
10366
10367 @table @gcctabopt
10368 @item -mmcu=@var{mcu}
10369 @opindex mmcu
10370 Specify ATMEL AVR instruction set or MCU type.
10371
10372 Instruction set avr1 is for the minimal AVR core, not supported by the C
10373 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10374 attiny11, attiny12, attiny15, attiny28).
10375
10376 Instruction set avr2 (default) is for the classic AVR core with up to
10377 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10378 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10379 at90c8534, at90s8535).
10380
10381 Instruction set avr3 is for the classic AVR core with up to 128K program
10382 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10383
10384 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10385 memory space (MCU types: atmega8, atmega83, atmega85).
10386
10387 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10388 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10389 atmega64, atmega128, at43usb355, at94k).
10390
10391 @item -mno-interrupts
10392 @opindex mno-interrupts
10393 Generated code is not compatible with hardware interrupts.
10394 Code size will be smaller.
10395
10396 @item -mcall-prologues
10397 @opindex mcall-prologues
10398 Functions prologues/epilogues expanded as call to appropriate
10399 subroutines. Code size will be smaller.
10400
10401 @item -mtiny-stack
10402 @opindex mtiny-stack
10403 Change only the low 8 bits of the stack pointer.
10404
10405 @item -mint8
10406 @opindex mint8
10407 Assume int to be 8 bit integer. This affects the sizes of all types: A
10408 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10409 and long long will be 4 bytes. Please note that this option does not
10410 comply to the C standards, but it will provide you with smaller code
10411 size.
10412 @end table
10413
10414 @node Blackfin Options
10415 @subsection Blackfin Options
10416 @cindex Blackfin Options
10417
10418 @table @gcctabopt
10419 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10420 @opindex mcpu=
10421 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
10422 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10423 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10424 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10425 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10426 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10427 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10428 @samp{bf561}.
10429 The optional @var{sirevision} specifies the silicon revision of the target
10430 Blackfin processor. Any workarounds available for the targeted silicon revision
10431 will be enabled. If @var{sirevision} is @samp{none}, no workarounds are enabled.
10432 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10433 will be enabled. The @code{__SILICON_REVISION__} macro is defined to two
10434 hexadecimal digits representing the major and minor numbers in the silicon
10435 revision. If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10436 is not defined. If @var{sirevision} is @samp{any}, the
10437 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10438 If this optional @var{sirevision} is not used, GCC assumes the latest known
10439 silicon revision of the targeted Blackfin processor.
10440
10441 Support for @samp{bf561} is incomplete. For @samp{bf561},
10442 Only the processor macro is defined.
10443 Without this option, @samp{bf532} is used as the processor by default.
10444 The corresponding predefined processor macros for @var{cpu} is to
10445 be defined. And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10446 provided by libgloss to be linked in if @option{-msim} is not given.
10447
10448 @item -msim
10449 @opindex msim
10450 Specifies that the program will be run on the simulator. This causes
10451 the simulator BSP provided by libgloss to be linked in. This option
10452 has effect only for @samp{bfin-elf} toolchain.
10453 Certain other options, such as @option{-mid-shared-library} and
10454 @option{-mfdpic}, imply @option{-msim}.
10455
10456 @item -momit-leaf-frame-pointer
10457 @opindex momit-leaf-frame-pointer
10458 Don't keep the frame pointer in a register for leaf functions. This
10459 avoids the instructions to save, set up and restore frame pointers and
10460 makes an extra register available in leaf functions. The option
10461 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10462 which might make debugging harder.
10463
10464 @item -mspecld-anomaly
10465 @opindex mspecld-anomaly
10466 When enabled, the compiler will ensure that the generated code does not
10467 contain speculative loads after jump instructions. If this option is used,
10468 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10469
10470 @item -mno-specld-anomaly
10471 @opindex mno-specld-anomaly
10472 Don't generate extra code to prevent speculative loads from occurring.
10473
10474 @item -mcsync-anomaly
10475 @opindex mcsync-anomaly
10476 When enabled, the compiler will ensure that the generated code does not
10477 contain CSYNC or SSYNC instructions too soon after conditional branches.
10478 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10479
10480 @item -mno-csync-anomaly
10481 @opindex mno-csync-anomaly
10482 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10483 occurring too soon after a conditional branch.
10484
10485 @item -mlow-64k
10486 @opindex mlow-64k
10487 When enabled, the compiler is free to take advantage of the knowledge that
10488 the entire program fits into the low 64k of memory.
10489
10490 @item -mno-low-64k
10491 @opindex mno-low-64k
10492 Assume that the program is arbitrarily large. This is the default.
10493
10494 @item -mstack-check-l1
10495 @opindex mstack-check-l1
10496 Do stack checking using information placed into L1 scratchpad memory by the
10497 uClinux kernel.
10498
10499 @item -mid-shared-library
10500 @opindex mid-shared-library
10501 Generate code that supports shared libraries via the library ID method.
10502 This allows for execute in place and shared libraries in an environment
10503 without virtual memory management. This option implies @option{-fPIC}.
10504 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10505
10506 @item -mno-id-shared-library
10507 @opindex mno-id-shared-library
10508 Generate code that doesn't assume ID based shared libraries are being used.
10509 This is the default.
10510
10511 @item -mleaf-id-shared-library
10512 @opindex mleaf-id-shared-library
10513 Generate code that supports shared libraries via the library ID method,
10514 but assumes that this library or executable won't link against any other
10515 ID shared libraries. That allows the compiler to use faster code for jumps
10516 and calls.
10517
10518 @item -mno-leaf-id-shared-library
10519 @opindex mno-leaf-id-shared-library
10520 Do not assume that the code being compiled won't link against any ID shared
10521 libraries. Slower code will be generated for jump and call insns.
10522
10523 @item -mshared-library-id=n
10524 @opindex mshared-library-id
10525 Specified the identification number of the ID based shared library being
10526 compiled. Specifying a value of 0 will generate more compact code, specifying
10527 other values will force the allocation of that number to the current
10528 library but is no more space or time efficient than omitting this option.
10529
10530 @item -msep-data
10531 @opindex msep-data
10532 Generate code that allows the data segment to be located in a different
10533 area of memory from the text segment. This allows for execute in place in
10534 an environment without virtual memory management by eliminating relocations
10535 against the text section.
10536
10537 @item -mno-sep-data
10538 @opindex mno-sep-data
10539 Generate code that assumes that the data segment follows the text segment.
10540 This is the default.
10541
10542 @item -mlong-calls
10543 @itemx -mno-long-calls
10544 @opindex mlong-calls
10545 @opindex mno-long-calls
10546 Tells the compiler to perform function calls by first loading the
10547 address of the function into a register and then performing a subroutine
10548 call on this register. This switch is needed if the target function
10549 will lie outside of the 24 bit addressing range of the offset based
10550 version of subroutine call instruction.
10551
10552 This feature is not enabled by default. Specifying
10553 @option{-mno-long-calls} will restore the default behavior. Note these
10554 switches have no effect on how the compiler generates code to handle
10555 function calls via function pointers.
10556
10557 @item -mfast-fp
10558 @opindex mfast-fp
10559 Link with the fast floating-point library. This library relaxes some of
10560 the IEEE floating-point standard's rules for checking inputs against
10561 Not-a-Number (NAN), in the interest of performance.
10562
10563 @item -minline-plt
10564 @opindex minline-plt
10565 Enable inlining of PLT entries in function calls to functions that are
10566 not known to bind locally. It has no effect without @option{-mfdpic}.
10567
10568 @item -mmulticore
10569 @opindex mmulticore
10570 Build standalone application for multicore Blackfin processor. Proper
10571 start files and link scripts will be used to support multicore.
10572 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10573 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10574 @option{-mcorea} or @option{-mcoreb}. If it's used without
10575 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10576 programming model is used. In this model, the main function of Core B
10577 should be named as coreb_main. If it's used with @option{-mcorea} or
10578 @option{-mcoreb}, one application per core programming model is used.
10579 If this option is not used, single core application programming
10580 model is used.
10581
10582 @item -mcorea
10583 @opindex mcorea
10584 Build standalone application for Core A of BF561 when using
10585 one application per core programming model. Proper start files
10586 and link scripts will be used to support Core A. This option
10587 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10588
10589 @item -mcoreb
10590 @opindex mcoreb
10591 Build standalone application for Core B of BF561 when using
10592 one application per core programming model. Proper start files
10593 and link scripts will be used to support Core B. This option
10594 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10595 should be used instead of main. It must be used with
10596 @option{-mmulticore}.
10597
10598 @item -msdram
10599 @opindex msdram
10600 Build standalone application for SDRAM. Proper start files and
10601 link scripts will be used to put the application into SDRAM.
10602 Loader should initialize SDRAM before loading the application
10603 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10604
10605 @item -micplb
10606 @opindex micplb
10607 Assume that ICPLBs are enabled at runtime. This has an effect on certain
10608 anomaly workarounds. For Linux targets, the default is to assume ICPLBs
10609 are enabled; for standalone applications the default is off.
10610 @end table
10611
10612 @node CRIS Options
10613 @subsection CRIS Options
10614 @cindex CRIS Options
10615
10616 These options are defined specifically for the CRIS ports.
10617
10618 @table @gcctabopt
10619 @item -march=@var{architecture-type}
10620 @itemx -mcpu=@var{architecture-type}
10621 @opindex march
10622 @opindex mcpu
10623 Generate code for the specified architecture. The choices for
10624 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10625 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10626 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10627 @samp{v10}.
10628
10629 @item -mtune=@var{architecture-type}
10630 @opindex mtune
10631 Tune to @var{architecture-type} everything applicable about the generated
10632 code, except for the ABI and the set of available instructions. The
10633 choices for @var{architecture-type} are the same as for
10634 @option{-march=@var{architecture-type}}.
10635
10636 @item -mmax-stack-frame=@var{n}
10637 @opindex mmax-stack-frame
10638 Warn when the stack frame of a function exceeds @var{n} bytes.
10639
10640 @item -metrax4
10641 @itemx -metrax100
10642 @opindex metrax4
10643 @opindex metrax100
10644 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10645 @option{-march=v3} and @option{-march=v8} respectively.
10646
10647 @item -mmul-bug-workaround
10648 @itemx -mno-mul-bug-workaround
10649 @opindex mmul-bug-workaround
10650 @opindex mno-mul-bug-workaround
10651 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10652 models where it applies. This option is active by default.
10653
10654 @item -mpdebug
10655 @opindex mpdebug
10656 Enable CRIS-specific verbose debug-related information in the assembly
10657 code. This option also has the effect to turn off the @samp{#NO_APP}
10658 formatted-code indicator to the assembler at the beginning of the
10659 assembly file.
10660
10661 @item -mcc-init
10662 @opindex mcc-init
10663 Do not use condition-code results from previous instruction; always emit
10664 compare and test instructions before use of condition codes.
10665
10666 @item -mno-side-effects
10667 @opindex mno-side-effects
10668 Do not emit instructions with side-effects in addressing modes other than
10669 post-increment.
10670
10671 @item -mstack-align
10672 @itemx -mno-stack-align
10673 @itemx -mdata-align
10674 @itemx -mno-data-align
10675 @itemx -mconst-align
10676 @itemx -mno-const-align
10677 @opindex mstack-align
10678 @opindex mno-stack-align
10679 @opindex mdata-align
10680 @opindex mno-data-align
10681 @opindex mconst-align
10682 @opindex mno-const-align
10683 These options (no-options) arranges (eliminate arrangements) for the
10684 stack-frame, individual data and constants to be aligned for the maximum
10685 single data access size for the chosen CPU model. The default is to
10686 arrange for 32-bit alignment. ABI details such as structure layout are
10687 not affected by these options.
10688
10689 @item -m32-bit
10690 @itemx -m16-bit
10691 @itemx -m8-bit
10692 @opindex m32-bit
10693 @opindex m16-bit
10694 @opindex m8-bit
10695 Similar to the stack- data- and const-align options above, these options
10696 arrange for stack-frame, writable data and constants to all be 32-bit,
10697 16-bit or 8-bit aligned. The default is 32-bit alignment.
10698
10699 @item -mno-prologue-epilogue
10700 @itemx -mprologue-epilogue
10701 @opindex mno-prologue-epilogue
10702 @opindex mprologue-epilogue
10703 With @option{-mno-prologue-epilogue}, the normal function prologue and
10704 epilogue that sets up the stack-frame are omitted and no return
10705 instructions or return sequences are generated in the code. Use this
10706 option only together with visual inspection of the compiled code: no
10707 warnings or errors are generated when call-saved registers must be saved,
10708 or storage for local variable needs to be allocated.
10709
10710 @item -mno-gotplt
10711 @itemx -mgotplt
10712 @opindex mno-gotplt
10713 @opindex mgotplt
10714 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10715 instruction sequences that load addresses for functions from the PLT part
10716 of the GOT rather than (traditional on other architectures) calls to the
10717 PLT@. The default is @option{-mgotplt}.
10718
10719 @item -melf
10720 @opindex melf
10721 Legacy no-op option only recognized with the cris-axis-elf and
10722 cris-axis-linux-gnu targets.
10723
10724 @item -mlinux
10725 @opindex mlinux
10726 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10727
10728 @item -sim
10729 @opindex sim
10730 This option, recognized for the cris-axis-elf arranges
10731 to link with input-output functions from a simulator library. Code,
10732 initialized data and zero-initialized data are allocated consecutively.
10733
10734 @item -sim2
10735 @opindex sim2
10736 Like @option{-sim}, but pass linker options to locate initialized data at
10737 0x40000000 and zero-initialized data at 0x80000000.
10738 @end table
10739
10740 @node CRX Options
10741 @subsection CRX Options
10742 @cindex CRX Options
10743
10744 These options are defined specifically for the CRX ports.
10745
10746 @table @gcctabopt
10747
10748 @item -mmac
10749 @opindex mmac
10750 Enable the use of multiply-accumulate instructions. Disabled by default.
10751
10752 @item -mpush-args
10753 @opindex mpush-args
10754 Push instructions will be used to pass outgoing arguments when functions
10755 are called. Enabled by default.
10756 @end table
10757
10758 @node Darwin Options
10759 @subsection Darwin Options
10760 @cindex Darwin options
10761
10762 These options are defined for all architectures running the Darwin operating
10763 system.
10764
10765 FSF GCC on Darwin does not create ``fat'' object files; it will create
10766 an object file for the single architecture that it was built to
10767 target. Apple's GCC on Darwin does create ``fat'' files if multiple
10768 @option{-arch} options are used; it does so by running the compiler or
10769 linker multiple times and joining the results together with
10770 @file{lipo}.
10771
10772 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10773 @samp{i686}) is determined by the flags that specify the ISA
10774 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
10775 @option{-force_cpusubtype_ALL} option can be used to override this.
10776
10777 The Darwin tools vary in their behavior when presented with an ISA
10778 mismatch. The assembler, @file{as}, will only permit instructions to
10779 be used that are valid for the subtype of the file it is generating,
10780 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10781 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10782 and print an error if asked to create a shared library with a less
10783 restrictive subtype than its input files (for instance, trying to put
10784 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
10785 for executables, @file{ld}, will quietly give the executable the most
10786 restrictive subtype of any of its input files.
10787
10788 @table @gcctabopt
10789 @item -F@var{dir}
10790 @opindex F
10791 Add the framework directory @var{dir} to the head of the list of
10792 directories to be searched for header files. These directories are
10793 interleaved with those specified by @option{-I} options and are
10794 scanned in a left-to-right order.
10795
10796 A framework directory is a directory with frameworks in it. A
10797 framework is a directory with a @samp{"Headers"} and/or
10798 @samp{"PrivateHeaders"} directory contained directly in it that ends
10799 in @samp{".framework"}. The name of a framework is the name of this
10800 directory excluding the @samp{".framework"}. Headers associated with
10801 the framework are found in one of those two directories, with
10802 @samp{"Headers"} being searched first. A subframework is a framework
10803 directory that is in a framework's @samp{"Frameworks"} directory.
10804 Includes of subframework headers can only appear in a header of a
10805 framework that contains the subframework, or in a sibling subframework
10806 header. Two subframeworks are siblings if they occur in the same
10807 framework. A subframework should not have the same name as a
10808 framework, a warning will be issued if this is violated. Currently a
10809 subframework cannot have subframeworks, in the future, the mechanism
10810 may be extended to support this. The standard frameworks can be found
10811 in @samp{"/System/Library/Frameworks"} and
10812 @samp{"/Library/Frameworks"}. An example include looks like
10813 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10814 the name of the framework and header.h is found in the
10815 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10816
10817 @item -iframework@var{dir}
10818 @opindex iframework
10819 Like @option{-F} except the directory is a treated as a system
10820 directory. The main difference between this @option{-iframework} and
10821 @option{-F} is that with @option{-iframework} the compiler does not
10822 warn about constructs contained within header files found via
10823 @var{dir}. This option is valid only for the C family of languages.
10824
10825 @item -gused
10826 @opindex gused
10827 Emit debugging information for symbols that are used. For STABS
10828 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10829 This is by default ON@.
10830
10831 @item -gfull
10832 @opindex gfull
10833 Emit debugging information for all symbols and types.
10834
10835 @item -mmacosx-version-min=@var{version}
10836 The earliest version of MacOS X that this executable will run on
10837 is @var{version}. Typical values of @var{version} include @code{10.1},
10838 @code{10.2}, and @code{10.3.9}.
10839
10840 If the compiler was built to use the system's headers by default,
10841 then the default for this option is the system version on which the
10842 compiler is running, otherwise the default is to make choices which
10843 are compatible with as many systems and code bases as possible.
10844
10845 @item -mkernel
10846 @opindex mkernel
10847 Enable kernel development mode. The @option{-mkernel} option sets
10848 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10849 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10850 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10851 applicable. This mode also sets @option{-mno-altivec},
10852 @option{-msoft-float}, @option{-fno-builtin} and
10853 @option{-mlong-branch} for PowerPC targets.
10854
10855 @item -mone-byte-bool
10856 @opindex mone-byte-bool
10857 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10858 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10859 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10860 option has no effect on x86.
10861
10862 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10863 to generate code that is not binary compatible with code generated
10864 without that switch. Using this switch may require recompiling all
10865 other modules in a program, including system libraries. Use this
10866 switch to conform to a non-default data model.
10867
10868 @item -mfix-and-continue
10869 @itemx -ffix-and-continue
10870 @itemx -findirect-data
10871 @opindex mfix-and-continue
10872 @opindex ffix-and-continue
10873 @opindex findirect-data
10874 Generate code suitable for fast turn around development. Needed to
10875 enable gdb to dynamically load @code{.o} files into already running
10876 programs. @option{-findirect-data} and @option{-ffix-and-continue}
10877 are provided for backwards compatibility.
10878
10879 @item -all_load
10880 @opindex all_load
10881 Loads all members of static archive libraries.
10882 See man ld(1) for more information.
10883
10884 @item -arch_errors_fatal
10885 @opindex arch_errors_fatal
10886 Cause the errors having to do with files that have the wrong architecture
10887 to be fatal.
10888
10889 @item -bind_at_load
10890 @opindex bind_at_load
10891 Causes the output file to be marked such that the dynamic linker will
10892 bind all undefined references when the file is loaded or launched.
10893
10894 @item -bundle
10895 @opindex bundle
10896 Produce a Mach-o bundle format file.
10897 See man ld(1) for more information.
10898
10899 @item -bundle_loader @var{executable}
10900 @opindex bundle_loader
10901 This option specifies the @var{executable} that will be loading the build
10902 output file being linked. See man ld(1) for more information.
10903
10904 @item -dynamiclib
10905 @opindex dynamiclib
10906 When passed this option, GCC will produce a dynamic library instead of
10907 an executable when linking, using the Darwin @file{libtool} command.
10908
10909 @item -force_cpusubtype_ALL
10910 @opindex force_cpusubtype_ALL
10911 This causes GCC's output file to have the @var{ALL} subtype, instead of
10912 one controlled by the @option{-mcpu} or @option{-march} option.
10913
10914 @item -allowable_client @var{client_name}
10915 @itemx -client_name
10916 @itemx -compatibility_version
10917 @itemx -current_version
10918 @itemx -dead_strip
10919 @itemx -dependency-file
10920 @itemx -dylib_file
10921 @itemx -dylinker_install_name
10922 @itemx -dynamic
10923 @itemx -exported_symbols_list
10924 @itemx -filelist
10925 @need 800
10926 @itemx -flat_namespace
10927 @itemx -force_flat_namespace
10928 @itemx -headerpad_max_install_names
10929 @itemx -image_base
10930 @itemx -init
10931 @itemx -install_name
10932 @itemx -keep_private_externs
10933 @itemx -multi_module
10934 @itemx -multiply_defined
10935 @itemx -multiply_defined_unused
10936 @need 800
10937 @itemx -noall_load
10938 @itemx -no_dead_strip_inits_and_terms
10939 @itemx -nofixprebinding
10940 @itemx -nomultidefs
10941 @itemx -noprebind
10942 @itemx -noseglinkedit
10943 @itemx -pagezero_size
10944 @itemx -prebind
10945 @itemx -prebind_all_twolevel_modules
10946 @itemx -private_bundle
10947 @need 800
10948 @itemx -read_only_relocs
10949 @itemx -sectalign
10950 @itemx -sectobjectsymbols
10951 @itemx -whyload
10952 @itemx -seg1addr
10953 @itemx -sectcreate
10954 @itemx -sectobjectsymbols
10955 @itemx -sectorder
10956 @itemx -segaddr
10957 @itemx -segs_read_only_addr
10958 @need 800
10959 @itemx -segs_read_write_addr
10960 @itemx -seg_addr_table
10961 @itemx -seg_addr_table_filename
10962 @itemx -seglinkedit
10963 @itemx -segprot
10964 @itemx -segs_read_only_addr
10965 @itemx -segs_read_write_addr
10966 @itemx -single_module
10967 @itemx -static
10968 @itemx -sub_library
10969 @need 800
10970 @itemx -sub_umbrella
10971 @itemx -twolevel_namespace
10972 @itemx -umbrella
10973 @itemx -undefined
10974 @itemx -unexported_symbols_list
10975 @itemx -weak_reference_mismatches
10976 @itemx -whatsloaded
10977 @opindex allowable_client
10978 @opindex client_name
10979 @opindex compatibility_version
10980 @opindex current_version
10981 @opindex dead_strip
10982 @opindex dependency-file
10983 @opindex dylib_file
10984 @opindex dylinker_install_name
10985 @opindex dynamic
10986 @opindex exported_symbols_list
10987 @opindex filelist
10988 @opindex flat_namespace
10989 @opindex force_flat_namespace
10990 @opindex headerpad_max_install_names
10991 @opindex image_base
10992 @opindex init
10993 @opindex install_name
10994 @opindex keep_private_externs
10995 @opindex multi_module
10996 @opindex multiply_defined
10997 @opindex multiply_defined_unused
10998 @opindex noall_load
10999 @opindex no_dead_strip_inits_and_terms
11000 @opindex nofixprebinding
11001 @opindex nomultidefs
11002 @opindex noprebind
11003 @opindex noseglinkedit
11004 @opindex pagezero_size
11005 @opindex prebind
11006 @opindex prebind_all_twolevel_modules
11007 @opindex private_bundle
11008 @opindex read_only_relocs
11009 @opindex sectalign
11010 @opindex sectobjectsymbols
11011 @opindex whyload
11012 @opindex seg1addr
11013 @opindex sectcreate
11014 @opindex sectobjectsymbols
11015 @opindex sectorder
11016 @opindex segaddr
11017 @opindex segs_read_only_addr
11018 @opindex segs_read_write_addr
11019 @opindex seg_addr_table
11020 @opindex seg_addr_table_filename
11021 @opindex seglinkedit
11022 @opindex segprot
11023 @opindex segs_read_only_addr
11024 @opindex segs_read_write_addr
11025 @opindex single_module
11026 @opindex static
11027 @opindex sub_library
11028 @opindex sub_umbrella
11029 @opindex twolevel_namespace
11030 @opindex umbrella
11031 @opindex undefined
11032 @opindex unexported_symbols_list
11033 @opindex weak_reference_mismatches
11034 @opindex whatsloaded
11035 These options are passed to the Darwin linker. The Darwin linker man page
11036 describes them in detail.
11037 @end table
11038
11039 @node DEC Alpha Options
11040 @subsection DEC Alpha Options
11041
11042 These @samp{-m} options are defined for the DEC Alpha implementations:
11043
11044 @table @gcctabopt
11045 @item -mno-soft-float
11046 @itemx -msoft-float
11047 @opindex mno-soft-float
11048 @opindex msoft-float
11049 Use (do not use) the hardware floating-point instructions for
11050 floating-point operations. When @option{-msoft-float} is specified,
11051 functions in @file{libgcc.a} will be used to perform floating-point
11052 operations. Unless they are replaced by routines that emulate the
11053 floating-point operations, or compiled in such a way as to call such
11054 emulations routines, these routines will issue floating-point
11055 operations. If you are compiling for an Alpha without floating-point
11056 operations, you must ensure that the library is built so as not to call
11057 them.
11058
11059 Note that Alpha implementations without floating-point operations are
11060 required to have floating-point registers.
11061
11062 @item -mfp-reg
11063 @itemx -mno-fp-regs
11064 @opindex mfp-reg
11065 @opindex mno-fp-regs
11066 Generate code that uses (does not use) the floating-point register set.
11067 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
11068 register set is not used, floating point operands are passed in integer
11069 registers as if they were integers and floating-point results are passed
11070 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
11071 so any function with a floating-point argument or return value called by code
11072 compiled with @option{-mno-fp-regs} must also be compiled with that
11073 option.
11074
11075 A typical use of this option is building a kernel that does not use,
11076 and hence need not save and restore, any floating-point registers.
11077
11078 @item -mieee
11079 @opindex mieee
11080 The Alpha architecture implements floating-point hardware optimized for
11081 maximum performance. It is mostly compliant with the IEEE floating
11082 point standard. However, for full compliance, software assistance is
11083 required. This option generates code fully IEEE compliant code
11084 @emph{except} that the @var{inexact-flag} is not maintained (see below).
11085 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
11086 defined during compilation. The resulting code is less efficient but is
11087 able to correctly support denormalized numbers and exceptional IEEE
11088 values such as not-a-number and plus/minus infinity. Other Alpha
11089 compilers call this option @option{-ieee_with_no_inexact}.
11090
11091 @item -mieee-with-inexact
11092 @opindex mieee-with-inexact
11093 This is like @option{-mieee} except the generated code also maintains
11094 the IEEE @var{inexact-flag}. Turning on this option causes the
11095 generated code to implement fully-compliant IEEE math. In addition to
11096 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
11097 macro. On some Alpha implementations the resulting code may execute
11098 significantly slower than the code generated by default. Since there is
11099 very little code that depends on the @var{inexact-flag}, you should
11100 normally not specify this option. Other Alpha compilers call this
11101 option @option{-ieee_with_inexact}.
11102
11103 @item -mfp-trap-mode=@var{trap-mode}
11104 @opindex mfp-trap-mode
11105 This option controls what floating-point related traps are enabled.
11106 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
11107 The trap mode can be set to one of four values:
11108
11109 @table @samp
11110 @item n
11111 This is the default (normal) setting. The only traps that are enabled
11112 are the ones that cannot be disabled in software (e.g., division by zero
11113 trap).
11114
11115 @item u
11116 In addition to the traps enabled by @samp{n}, underflow traps are enabled
11117 as well.
11118
11119 @item su
11120 Like @samp{u}, but the instructions are marked to be safe for software
11121 completion (see Alpha architecture manual for details).
11122
11123 @item sui
11124 Like @samp{su}, but inexact traps are enabled as well.
11125 @end table
11126
11127 @item -mfp-rounding-mode=@var{rounding-mode}
11128 @opindex mfp-rounding-mode
11129 Selects the IEEE rounding mode. Other Alpha compilers call this option
11130 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
11131 of:
11132
11133 @table @samp
11134 @item n
11135 Normal IEEE rounding mode. Floating point numbers are rounded towards
11136 the nearest machine number or towards the even machine number in case
11137 of a tie.
11138
11139 @item m
11140 Round towards minus infinity.
11141
11142 @item c
11143 Chopped rounding mode. Floating point numbers are rounded towards zero.
11144
11145 @item d
11146 Dynamic rounding mode. A field in the floating point control register
11147 (@var{fpcr}, see Alpha architecture reference manual) controls the
11148 rounding mode in effect. The C library initializes this register for
11149 rounding towards plus infinity. Thus, unless your program modifies the
11150 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
11151 @end table
11152
11153 @item -mtrap-precision=@var{trap-precision}
11154 @opindex mtrap-precision
11155 In the Alpha architecture, floating point traps are imprecise. This
11156 means without software assistance it is impossible to recover from a
11157 floating trap and program execution normally needs to be terminated.
11158 GCC can generate code that can assist operating system trap handlers
11159 in determining the exact location that caused a floating point trap.
11160 Depending on the requirements of an application, different levels of
11161 precisions can be selected:
11162
11163 @table @samp
11164 @item p
11165 Program precision. This option is the default and means a trap handler
11166 can only identify which program caused a floating point exception.
11167
11168 @item f
11169 Function precision. The trap handler can determine the function that
11170 caused a floating point exception.
11171
11172 @item i
11173 Instruction precision. The trap handler can determine the exact
11174 instruction that caused a floating point exception.
11175 @end table
11176
11177 Other Alpha compilers provide the equivalent options called
11178 @option{-scope_safe} and @option{-resumption_safe}.
11179
11180 @item -mieee-conformant
11181 @opindex mieee-conformant
11182 This option marks the generated code as IEEE conformant. You must not
11183 use this option unless you also specify @option{-mtrap-precision=i} and either
11184 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
11185 is to emit the line @samp{.eflag 48} in the function prologue of the
11186 generated assembly file. Under DEC Unix, this has the effect that
11187 IEEE-conformant math library routines will be linked in.
11188
11189 @item -mbuild-constants
11190 @opindex mbuild-constants
11191 Normally GCC examines a 32- or 64-bit integer constant to
11192 see if it can construct it from smaller constants in two or three
11193 instructions. If it cannot, it will output the constant as a literal and
11194 generate code to load it from the data segment at runtime.
11195
11196 Use this option to require GCC to construct @emph{all} integer constants
11197 using code, even if it takes more instructions (the maximum is six).
11198
11199 You would typically use this option to build a shared library dynamic
11200 loader. Itself a shared library, it must relocate itself in memory
11201 before it can find the variables and constants in its own data segment.
11202
11203 @item -malpha-as
11204 @itemx -mgas
11205 @opindex malpha-as
11206 @opindex mgas
11207 Select whether to generate code to be assembled by the vendor-supplied
11208 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
11209
11210 @item -mbwx
11211 @itemx -mno-bwx
11212 @itemx -mcix
11213 @itemx -mno-cix
11214 @itemx -mfix
11215 @itemx -mno-fix
11216 @itemx -mmax
11217 @itemx -mno-max
11218 @opindex mbwx
11219 @opindex mno-bwx
11220 @opindex mcix
11221 @opindex mno-cix
11222 @opindex mfix
11223 @opindex mno-fix
11224 @opindex mmax
11225 @opindex mno-max
11226 Indicate whether GCC should generate code to use the optional BWX,
11227 CIX, FIX and MAX instruction sets. The default is to use the instruction
11228 sets supported by the CPU type specified via @option{-mcpu=} option or that
11229 of the CPU on which GCC was built if none was specified.
11230
11231 @item -mfloat-vax
11232 @itemx -mfloat-ieee
11233 @opindex mfloat-vax
11234 @opindex mfloat-ieee
11235 Generate code that uses (does not use) VAX F and G floating point
11236 arithmetic instead of IEEE single and double precision.
11237
11238 @item -mexplicit-relocs
11239 @itemx -mno-explicit-relocs
11240 @opindex mexplicit-relocs
11241 @opindex mno-explicit-relocs
11242 Older Alpha assemblers provided no way to generate symbol relocations
11243 except via assembler macros. Use of these macros does not allow
11244 optimal instruction scheduling. GNU binutils as of version 2.12
11245 supports a new syntax that allows the compiler to explicitly mark
11246 which relocations should apply to which instructions. This option
11247 is mostly useful for debugging, as GCC detects the capabilities of
11248 the assembler when it is built and sets the default accordingly.
11249
11250 @item -msmall-data
11251 @itemx -mlarge-data
11252 @opindex msmall-data
11253 @opindex mlarge-data
11254 When @option{-mexplicit-relocs} is in effect, static data is
11255 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
11256 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11257 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11258 16-bit relocations off of the @code{$gp} register. This limits the
11259 size of the small data area to 64KB, but allows the variables to be
11260 directly accessed via a single instruction.
11261
11262 The default is @option{-mlarge-data}. With this option the data area
11263 is limited to just below 2GB@. Programs that require more than 2GB of
11264 data must use @code{malloc} or @code{mmap} to allocate the data in the
11265 heap instead of in the program's data segment.
11266
11267 When generating code for shared libraries, @option{-fpic} implies
11268 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11269
11270 @item -msmall-text
11271 @itemx -mlarge-text
11272 @opindex msmall-text
11273 @opindex mlarge-text
11274 When @option{-msmall-text} is used, the compiler assumes that the
11275 code of the entire program (or shared library) fits in 4MB, and is
11276 thus reachable with a branch instruction. When @option{-msmall-data}
11277 is used, the compiler can assume that all local symbols share the
11278 same @code{$gp} value, and thus reduce the number of instructions
11279 required for a function call from 4 to 1.
11280
11281 The default is @option{-mlarge-text}.
11282
11283 @item -mcpu=@var{cpu_type}
11284 @opindex mcpu
11285 Set the instruction set and instruction scheduling parameters for
11286 machine type @var{cpu_type}. You can specify either the @samp{EV}
11287 style name or the corresponding chip number. GCC supports scheduling
11288 parameters for the EV4, EV5 and EV6 family of processors and will
11289 choose the default values for the instruction set from the processor
11290 you specify. If you do not specify a processor type, GCC will default
11291 to the processor on which the compiler was built.
11292
11293 Supported values for @var{cpu_type} are
11294
11295 @table @samp
11296 @item ev4
11297 @itemx ev45
11298 @itemx 21064
11299 Schedules as an EV4 and has no instruction set extensions.
11300
11301 @item ev5
11302 @itemx 21164
11303 Schedules as an EV5 and has no instruction set extensions.
11304
11305 @item ev56
11306 @itemx 21164a
11307 Schedules as an EV5 and supports the BWX extension.
11308
11309 @item pca56
11310 @itemx 21164pc
11311 @itemx 21164PC
11312 Schedules as an EV5 and supports the BWX and MAX extensions.
11313
11314 @item ev6
11315 @itemx 21264
11316 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11317
11318 @item ev67
11319 @itemx 21264a
11320 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11321 @end table
11322
11323 Native Linux/GNU toolchains also support the value @samp{native},
11324 which selects the best architecture option for the host processor.
11325 @option{-mcpu=native} has no effect if GCC does not recognize
11326 the processor.
11327
11328 @item -mtune=@var{cpu_type}
11329 @opindex mtune
11330 Set only the instruction scheduling parameters for machine type
11331 @var{cpu_type}. The instruction set is not changed.
11332
11333 Native Linux/GNU toolchains also support the value @samp{native},
11334 which selects the best architecture option for the host processor.
11335 @option{-mtune=native} has no effect if GCC does not recognize
11336 the processor.
11337
11338 @item -mmemory-latency=@var{time}
11339 @opindex mmemory-latency
11340 Sets the latency the scheduler should assume for typical memory
11341 references as seen by the application. This number is highly
11342 dependent on the memory access patterns used by the application
11343 and the size of the external cache on the machine.
11344
11345 Valid options for @var{time} are
11346
11347 @table @samp
11348 @item @var{number}
11349 A decimal number representing clock cycles.
11350
11351 @item L1
11352 @itemx L2
11353 @itemx L3
11354 @itemx main
11355 The compiler contains estimates of the number of clock cycles for
11356 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11357 (also called Dcache, Scache, and Bcache), as well as to main memory.
11358 Note that L3 is only valid for EV5.
11359
11360 @end table
11361 @end table
11362
11363 @node DEC Alpha/VMS Options
11364 @subsection DEC Alpha/VMS Options
11365
11366 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11367
11368 @table @gcctabopt
11369 @item -mvms-return-codes
11370 @opindex mvms-return-codes
11371 Return VMS condition codes from main. The default is to return POSIX
11372 style condition (e.g.@: error) codes.
11373
11374 @item -mdebug-main=@var{prefix}
11375 @opindex mdebug-main=@var{prefix}
11376 Flag the first routine whose name starts with @var{prefix} as the main
11377 routine for the debugger.
11378
11379 @item -mmalloc64
11380 @opindex mmalloc64
11381 Default to 64bit memory allocation routines.
11382 @end table
11383
11384 @node FR30 Options
11385 @subsection FR30 Options
11386 @cindex FR30 Options
11387
11388 These options are defined specifically for the FR30 port.
11389
11390 @table @gcctabopt
11391
11392 @item -msmall-model
11393 @opindex msmall-model
11394 Use the small address space model. This can produce smaller code, but
11395 it does assume that all symbolic values and addresses will fit into a
11396 20-bit range.
11397
11398 @item -mno-lsim
11399 @opindex mno-lsim
11400 Assume that run-time support has been provided and so there is no need
11401 to include the simulator library (@file{libsim.a}) on the linker
11402 command line.
11403
11404 @end table
11405
11406 @node FRV Options
11407 @subsection FRV Options
11408 @cindex FRV Options
11409
11410 @table @gcctabopt
11411 @item -mgpr-32
11412 @opindex mgpr-32
11413
11414 Only use the first 32 general purpose registers.
11415
11416 @item -mgpr-64
11417 @opindex mgpr-64
11418
11419 Use all 64 general purpose registers.
11420
11421 @item -mfpr-32
11422 @opindex mfpr-32
11423
11424 Use only the first 32 floating point registers.
11425
11426 @item -mfpr-64
11427 @opindex mfpr-64
11428
11429 Use all 64 floating point registers
11430
11431 @item -mhard-float
11432 @opindex mhard-float
11433
11434 Use hardware instructions for floating point operations.
11435
11436 @item -msoft-float
11437 @opindex msoft-float
11438
11439 Use library routines for floating point operations.
11440
11441 @item -malloc-cc
11442 @opindex malloc-cc
11443
11444 Dynamically allocate condition code registers.
11445
11446 @item -mfixed-cc
11447 @opindex mfixed-cc
11448
11449 Do not try to dynamically allocate condition code registers, only
11450 use @code{icc0} and @code{fcc0}.
11451
11452 @item -mdword
11453 @opindex mdword
11454
11455 Change ABI to use double word insns.
11456
11457 @item -mno-dword
11458 @opindex mno-dword
11459
11460 Do not use double word instructions.
11461
11462 @item -mdouble
11463 @opindex mdouble
11464
11465 Use floating point double instructions.
11466
11467 @item -mno-double
11468 @opindex mno-double
11469
11470 Do not use floating point double instructions.
11471
11472 @item -mmedia
11473 @opindex mmedia
11474
11475 Use media instructions.
11476
11477 @item -mno-media
11478 @opindex mno-media
11479
11480 Do not use media instructions.
11481
11482 @item -mmuladd
11483 @opindex mmuladd
11484
11485 Use multiply and add/subtract instructions.
11486
11487 @item -mno-muladd
11488 @opindex mno-muladd
11489
11490 Do not use multiply and add/subtract instructions.
11491
11492 @item -mfdpic
11493 @opindex mfdpic
11494
11495 Select the FDPIC ABI, that uses function descriptors to represent
11496 pointers to functions. Without any PIC/PIE-related options, it
11497 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
11498 assumes GOT entries and small data are within a 12-bit range from the
11499 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11500 are computed with 32 bits.
11501 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11502
11503 @item -minline-plt
11504 @opindex minline-plt
11505
11506 Enable inlining of PLT entries in function calls to functions that are
11507 not known to bind locally. It has no effect without @option{-mfdpic}.
11508 It's enabled by default if optimizing for speed and compiling for
11509 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11510 optimization option such as @option{-O3} or above is present in the
11511 command line.
11512
11513 @item -mTLS
11514 @opindex mTLS
11515
11516 Assume a large TLS segment when generating thread-local code.
11517
11518 @item -mtls
11519 @opindex mtls
11520
11521 Do not assume a large TLS segment when generating thread-local code.
11522
11523 @item -mgprel-ro
11524 @opindex mgprel-ro
11525
11526 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11527 that is known to be in read-only sections. It's enabled by default,
11528 except for @option{-fpic} or @option{-fpie}: even though it may help
11529 make the global offset table smaller, it trades 1 instruction for 4.
11530 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11531 one of which may be shared by multiple symbols, and it avoids the need
11532 for a GOT entry for the referenced symbol, so it's more likely to be a
11533 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
11534
11535 @item -multilib-library-pic
11536 @opindex multilib-library-pic
11537
11538 Link with the (library, not FD) pic libraries. It's implied by
11539 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11540 @option{-fpic} without @option{-mfdpic}. You should never have to use
11541 it explicitly.
11542
11543 @item -mlinked-fp
11544 @opindex mlinked-fp
11545
11546 Follow the EABI requirement of always creating a frame pointer whenever
11547 a stack frame is allocated. This option is enabled by default and can
11548 be disabled with @option{-mno-linked-fp}.
11549
11550 @item -mlong-calls
11551 @opindex mlong-calls
11552
11553 Use indirect addressing to call functions outside the current
11554 compilation unit. This allows the functions to be placed anywhere
11555 within the 32-bit address space.
11556
11557 @item -malign-labels
11558 @opindex malign-labels
11559
11560 Try to align labels to an 8-byte boundary by inserting nops into the
11561 previous packet. This option only has an effect when VLIW packing
11562 is enabled. It doesn't create new packets; it merely adds nops to
11563 existing ones.
11564
11565 @item -mlibrary-pic
11566 @opindex mlibrary-pic
11567
11568 Generate position-independent EABI code.
11569
11570 @item -macc-4
11571 @opindex macc-4
11572
11573 Use only the first four media accumulator registers.
11574
11575 @item -macc-8
11576 @opindex macc-8
11577
11578 Use all eight media accumulator registers.
11579
11580 @item -mpack
11581 @opindex mpack
11582
11583 Pack VLIW instructions.
11584
11585 @item -mno-pack
11586 @opindex mno-pack
11587
11588 Do not pack VLIW instructions.
11589
11590 @item -mno-eflags
11591 @opindex mno-eflags
11592
11593 Do not mark ABI switches in e_flags.
11594
11595 @item -mcond-move
11596 @opindex mcond-move
11597
11598 Enable the use of conditional-move instructions (default).
11599
11600 This switch is mainly for debugging the compiler and will likely be removed
11601 in a future version.
11602
11603 @item -mno-cond-move
11604 @opindex mno-cond-move
11605
11606 Disable the use of conditional-move instructions.
11607
11608 This switch is mainly for debugging the compiler and will likely be removed
11609 in a future version.
11610
11611 @item -mscc
11612 @opindex mscc
11613
11614 Enable the use of conditional set instructions (default).
11615
11616 This switch is mainly for debugging the compiler and will likely be removed
11617 in a future version.
11618
11619 @item -mno-scc
11620 @opindex mno-scc
11621
11622 Disable the use of conditional set instructions.
11623
11624 This switch is mainly for debugging the compiler and will likely be removed
11625 in a future version.
11626
11627 @item -mcond-exec
11628 @opindex mcond-exec
11629
11630 Enable the use of conditional execution (default).
11631
11632 This switch is mainly for debugging the compiler and will likely be removed
11633 in a future version.
11634
11635 @item -mno-cond-exec
11636 @opindex mno-cond-exec
11637
11638 Disable the use of conditional execution.
11639
11640 This switch is mainly for debugging the compiler and will likely be removed
11641 in a future version.
11642
11643 @item -mvliw-branch
11644 @opindex mvliw-branch
11645
11646 Run a pass to pack branches into VLIW instructions (default).
11647
11648 This switch is mainly for debugging the compiler and will likely be removed
11649 in a future version.
11650
11651 @item -mno-vliw-branch
11652 @opindex mno-vliw-branch
11653
11654 Do not run a pass to pack branches into VLIW instructions.
11655
11656 This switch is mainly for debugging the compiler and will likely be removed
11657 in a future version.
11658
11659 @item -mmulti-cond-exec
11660 @opindex mmulti-cond-exec
11661
11662 Enable optimization of @code{&&} and @code{||} in conditional execution
11663 (default).
11664
11665 This switch is mainly for debugging the compiler and will likely be removed
11666 in a future version.
11667
11668 @item -mno-multi-cond-exec
11669 @opindex mno-multi-cond-exec
11670
11671 Disable optimization of @code{&&} and @code{||} in conditional execution.
11672
11673 This switch is mainly for debugging the compiler and will likely be removed
11674 in a future version.
11675
11676 @item -mnested-cond-exec
11677 @opindex mnested-cond-exec
11678
11679 Enable nested conditional execution optimizations (default).
11680
11681 This switch is mainly for debugging the compiler and will likely be removed
11682 in a future version.
11683
11684 @item -mno-nested-cond-exec
11685 @opindex mno-nested-cond-exec
11686
11687 Disable nested conditional execution optimizations.
11688
11689 This switch is mainly for debugging the compiler and will likely be removed
11690 in a future version.
11691
11692 @item -moptimize-membar
11693 @opindex moptimize-membar
11694
11695 This switch removes redundant @code{membar} instructions from the
11696 compiler generated code. It is enabled by default.
11697
11698 @item -mno-optimize-membar
11699 @opindex mno-optimize-membar
11700
11701 This switch disables the automatic removal of redundant @code{membar}
11702 instructions from the generated code.
11703
11704 @item -mtomcat-stats
11705 @opindex mtomcat-stats
11706
11707 Cause gas to print out tomcat statistics.
11708
11709 @item -mcpu=@var{cpu}
11710 @opindex mcpu
11711
11712 Select the processor type for which to generate code. Possible values are
11713 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11714 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11715
11716 @end table
11717
11718 @node GNU/Linux Options
11719 @subsection GNU/Linux Options
11720
11721 These @samp{-m} options are defined for GNU/Linux targets:
11722
11723 @table @gcctabopt
11724 @item -mglibc
11725 @opindex mglibc
11726 Use the GNU C library. This is the default except
11727 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
11728
11729 @item -muclibc
11730 @opindex muclibc
11731 Use uClibc C library. This is the default on
11732 @samp{*-*-linux-*uclibc*} targets.
11733
11734 @item -mbionic
11735 @opindex mbionic
11736 Use Bionic C library. This is the default on
11737 @samp{*-*-linux-*android*} targets.
11738
11739 @item -mandroid
11740 @opindex mandroid
11741 Compile code compatible with Android platform. This is the default on
11742 @samp{*-*-linux-*android*} targets.
11743
11744 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
11745 @option{-fno-exceptions} and @option{-fno-rtti} by default. When linking,
11746 this option makes the GCC driver pass Android-specific options to the linker.
11747 Finally, this option causes the preprocessor macro @code{__ANDROID__}
11748 to be defined.
11749
11750 @item -tno-android-cc
11751 @opindex tno-android-cc
11752 Disable compilation effects of @option{-mandroid}, i.e., do not enable
11753 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
11754 @option{-fno-rtti} by default.
11755
11756 @item -tno-android-ld
11757 @opindex tno-android-ld
11758 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
11759 linking options to the linker.
11760
11761 @end table
11762
11763 @node H8/300 Options
11764 @subsection H8/300 Options
11765
11766 These @samp{-m} options are defined for the H8/300 implementations:
11767
11768 @table @gcctabopt
11769 @item -mrelax
11770 @opindex mrelax
11771 Shorten some address references at link time, when possible; uses the
11772 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
11773 ld, Using ld}, for a fuller description.
11774
11775 @item -mh
11776 @opindex mh
11777 Generate code for the H8/300H@.
11778
11779 @item -ms
11780 @opindex ms
11781 Generate code for the H8S@.
11782
11783 @item -mn
11784 @opindex mn
11785 Generate code for the H8S and H8/300H in the normal mode. This switch
11786 must be used either with @option{-mh} or @option{-ms}.
11787
11788 @item -ms2600
11789 @opindex ms2600
11790 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
11791
11792 @item -mint32
11793 @opindex mint32
11794 Make @code{int} data 32 bits by default.
11795
11796 @item -malign-300
11797 @opindex malign-300
11798 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11799 The default for the H8/300H and H8S is to align longs and floats on 4
11800 byte boundaries.
11801 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11802 This option has no effect on the H8/300.
11803 @end table
11804
11805 @node HPPA Options
11806 @subsection HPPA Options
11807 @cindex HPPA Options
11808
11809 These @samp{-m} options are defined for the HPPA family of computers:
11810
11811 @table @gcctabopt
11812 @item -march=@var{architecture-type}
11813 @opindex march
11814 Generate code for the specified architecture. The choices for
11815 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11816 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
11817 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11818 architecture option for your machine. Code compiled for lower numbered
11819 architectures will run on higher numbered architectures, but not the
11820 other way around.
11821
11822 @item -mpa-risc-1-0
11823 @itemx -mpa-risc-1-1
11824 @itemx -mpa-risc-2-0
11825 @opindex mpa-risc-1-0
11826 @opindex mpa-risc-1-1
11827 @opindex mpa-risc-2-0
11828 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11829
11830 @item -mbig-switch
11831 @opindex mbig-switch
11832 Generate code suitable for big switch tables. Use this option only if
11833 the assembler/linker complain about out of range branches within a switch
11834 table.
11835
11836 @item -mjump-in-delay
11837 @opindex mjump-in-delay
11838 Fill delay slots of function calls with unconditional jump instructions
11839 by modifying the return pointer for the function call to be the target
11840 of the conditional jump.
11841
11842 @item -mdisable-fpregs
11843 @opindex mdisable-fpregs
11844 Prevent floating point registers from being used in any manner. This is
11845 necessary for compiling kernels which perform lazy context switching of
11846 floating point registers. If you use this option and attempt to perform
11847 floating point operations, the compiler will abort.
11848
11849 @item -mdisable-indexing
11850 @opindex mdisable-indexing
11851 Prevent the compiler from using indexing address modes. This avoids some
11852 rather obscure problems when compiling MIG generated code under MACH@.
11853
11854 @item -mno-space-regs
11855 @opindex mno-space-regs
11856 Generate code that assumes the target has no space registers. This allows
11857 GCC to generate faster indirect calls and use unscaled index address modes.
11858
11859 Such code is suitable for level 0 PA systems and kernels.
11860
11861 @item -mfast-indirect-calls
11862 @opindex mfast-indirect-calls
11863 Generate code that assumes calls never cross space boundaries. This
11864 allows GCC to emit code which performs faster indirect calls.
11865
11866 This option will not work in the presence of shared libraries or nested
11867 functions.
11868
11869 @item -mfixed-range=@var{register-range}
11870 @opindex mfixed-range
11871 Generate code treating the given register range as fixed registers.
11872 A fixed register is one that the register allocator can not use. This is
11873 useful when compiling kernel code. A register range is specified as
11874 two registers separated by a dash. Multiple register ranges can be
11875 specified separated by a comma.
11876
11877 @item -mlong-load-store
11878 @opindex mlong-load-store
11879 Generate 3-instruction load and store sequences as sometimes required by
11880 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
11881 the HP compilers.
11882
11883 @item -mportable-runtime
11884 @opindex mportable-runtime
11885 Use the portable calling conventions proposed by HP for ELF systems.
11886
11887 @item -mgas
11888 @opindex mgas
11889 Enable the use of assembler directives only GAS understands.
11890
11891 @item -mschedule=@var{cpu-type}
11892 @opindex mschedule
11893 Schedule code according to the constraints for the machine type
11894 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
11895 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
11896 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11897 proper scheduling option for your machine. The default scheduling is
11898 @samp{8000}.
11899
11900 @item -mlinker-opt
11901 @opindex mlinker-opt
11902 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
11903 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
11904 linkers in which they give bogus error messages when linking some programs.
11905
11906 @item -msoft-float
11907 @opindex msoft-float
11908 Generate output containing library calls for floating point.
11909 @strong{Warning:} the requisite libraries are not available for all HPPA
11910 targets. Normally the facilities of the machine's usual C compiler are
11911 used, but this cannot be done directly in cross-compilation. You must make
11912 your own arrangements to provide suitable library functions for
11913 cross-compilation.
11914
11915 @option{-msoft-float} changes the calling convention in the output file;
11916 therefore, it is only useful if you compile @emph{all} of a program with
11917 this option. In particular, you need to compile @file{libgcc.a}, the
11918 library that comes with GCC, with @option{-msoft-float} in order for
11919 this to work.
11920
11921 @item -msio
11922 @opindex msio
11923 Generate the predefine, @code{_SIO}, for server IO@. The default is
11924 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
11925 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
11926 options are available under HP-UX and HI-UX@.
11927
11928 @item -mgnu-ld
11929 @opindex mgnu-ld
11930 Use GNU ld specific options. This passes @option{-shared} to ld when
11931 building a shared library. It is the default when GCC is configured,
11932 explicitly or implicitly, with the GNU linker. This option does not
11933 have any affect on which ld is called, it only changes what parameters
11934 are passed to that ld. The ld that is called is determined by the
11935 @option{--with-ld} configure option, GCC's program search path, and
11936 finally by the user's @env{PATH}. The linker used by GCC can be printed
11937 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
11938 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11939
11940 @item -mhp-ld
11941 @opindex mhp-ld
11942 Use HP ld specific options. This passes @option{-b} to ld when building
11943 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11944 links. It is the default when GCC is configured, explicitly or
11945 implicitly, with the HP linker. This option does not have any affect on
11946 which ld is called, it only changes what parameters are passed to that
11947 ld. The ld that is called is determined by the @option{--with-ld}
11948 configure option, GCC's program search path, and finally by the user's
11949 @env{PATH}. The linker used by GCC can be printed using @samp{which
11950 `gcc -print-prog-name=ld`}. This option is only available on the 64 bit
11951 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11952
11953 @item -mlong-calls
11954 @opindex mno-long-calls
11955 Generate code that uses long call sequences. This ensures that a call
11956 is always able to reach linker generated stubs. The default is to generate
11957 long calls only when the distance from the call site to the beginning
11958 of the function or translation unit, as the case may be, exceeds a
11959 predefined limit set by the branch type being used. The limits for
11960 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11961 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
11962 240,000 bytes.
11963
11964 Distances are measured from the beginning of functions when using the
11965 @option{-ffunction-sections} option, or when using the @option{-mgas}
11966 and @option{-mno-portable-runtime} options together under HP-UX with
11967 the SOM linker.
11968
11969 It is normally not desirable to use this option as it will degrade
11970 performance. However, it may be useful in large applications,
11971 particularly when partial linking is used to build the application.
11972
11973 The types of long calls used depends on the capabilities of the
11974 assembler and linker, and the type of code being generated. The
11975 impact on systems that support long absolute calls, and long pic
11976 symbol-difference or pc-relative calls should be relatively small.
11977 However, an indirect call is used on 32-bit ELF systems in pic code
11978 and it is quite long.
11979
11980 @item -munix=@var{unix-std}
11981 @opindex march
11982 Generate compiler predefines and select a startfile for the specified
11983 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
11984 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
11985 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
11986 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
11987 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11988 and later.
11989
11990 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11991 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11992 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11993 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11994 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11995 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11996
11997 It is @emph{important} to note that this option changes the interfaces
11998 for various library routines. It also affects the operational behavior
11999 of the C library. Thus, @emph{extreme} care is needed in using this
12000 option.
12001
12002 Library code that is intended to operate with more than one UNIX
12003 standard must test, set and restore the variable @var{__xpg4_extended_mask}
12004 as appropriate. Most GNU software doesn't provide this capability.
12005
12006 @item -nolibdld
12007 @opindex nolibdld
12008 Suppress the generation of link options to search libdld.sl when the
12009 @option{-static} option is specified on HP-UX 10 and later.
12010
12011 @item -static
12012 @opindex static
12013 The HP-UX implementation of setlocale in libc has a dependency on
12014 libdld.sl. There isn't an archive version of libdld.sl. Thus,
12015 when the @option{-static} option is specified, special link options
12016 are needed to resolve this dependency.
12017
12018 On HP-UX 10 and later, the GCC driver adds the necessary options to
12019 link with libdld.sl when the @option{-static} option is specified.
12020 This causes the resulting binary to be dynamic. On the 64-bit port,
12021 the linkers generate dynamic binaries by default in any case. The
12022 @option{-nolibdld} option can be used to prevent the GCC driver from
12023 adding these link options.
12024
12025 @item -threads
12026 @opindex threads
12027 Add support for multithreading with the @dfn{dce thread} library
12028 under HP-UX@. This option sets flags for both the preprocessor and
12029 linker.
12030 @end table
12031
12032 @node i386 and x86-64 Options
12033 @subsection Intel 386 and AMD x86-64 Options
12034 @cindex i386 Options
12035 @cindex x86-64 Options
12036 @cindex Intel 386 Options
12037 @cindex AMD x86-64 Options
12038
12039 These @samp{-m} options are defined for the i386 and x86-64 family of
12040 computers:
12041
12042 @table @gcctabopt
12043 @item -mtune=@var{cpu-type}
12044 @opindex mtune
12045 Tune to @var{cpu-type} everything applicable about the generated code, except
12046 for the ABI and the set of available instructions. The choices for
12047 @var{cpu-type} are:
12048 @table @emph
12049 @item generic
12050 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
12051 If you know the CPU on which your code will run, then you should use
12052 the corresponding @option{-mtune} option instead of
12053 @option{-mtune=generic}. But, if you do not know exactly what CPU users
12054 of your application will have, then you should use this option.
12055
12056 As new processors are deployed in the marketplace, the behavior of this
12057 option will change. Therefore, if you upgrade to a newer version of
12058 GCC, the code generated option will change to reflect the processors
12059 that were most common when that version of GCC was released.
12060
12061 There is no @option{-march=generic} option because @option{-march}
12062 indicates the instruction set the compiler can use, and there is no
12063 generic instruction set applicable to all processors. In contrast,
12064 @option{-mtune} indicates the processor (or, in this case, collection of
12065 processors) for which the code is optimized.
12066 @item native
12067 This selects the CPU to tune for at compilation time by determining
12068 the processor type of the compiling machine. Using @option{-mtune=native}
12069 will produce code optimized for the local machine under the constraints
12070 of the selected instruction set. Using @option{-march=native} will
12071 enable all instruction subsets supported by the local machine (hence
12072 the result might not run on different machines).
12073 @item i386
12074 Original Intel's i386 CPU@.
12075 @item i486
12076 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
12077 @item i586, pentium
12078 Intel Pentium CPU with no MMX support.
12079 @item pentium-mmx
12080 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
12081 @item pentiumpro
12082 Intel PentiumPro CPU@.
12083 @item i686
12084 Same as @code{generic}, but when used as @code{march} option, PentiumPro
12085 instruction set will be used, so the code will run on all i686 family chips.
12086 @item pentium2
12087 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
12088 @item pentium3, pentium3m
12089 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
12090 support.
12091 @item pentium-m
12092 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
12093 support. Used by Centrino notebooks.
12094 @item pentium4, pentium4m
12095 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
12096 @item prescott
12097 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
12098 set support.
12099 @item nocona
12100 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
12101 SSE2 and SSE3 instruction set support.
12102 @item core2
12103 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12104 instruction set support.
12105 @item corei7
12106 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
12107 and SSE4.2 instruction set support.
12108 @item corei7-avx
12109 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
12110 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
12111 @item atom
12112 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12113 instruction set support.
12114 @item k6
12115 AMD K6 CPU with MMX instruction set support.
12116 @item k6-2, k6-3
12117 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
12118 @item athlon, athlon-tbird
12119 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
12120 support.
12121 @item athlon-4, athlon-xp, athlon-mp
12122 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
12123 instruction set support.
12124 @item k8, opteron, athlon64, athlon-fx
12125 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
12126 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
12127 @item k8-sse3, opteron-sse3, athlon64-sse3
12128 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
12129 @item amdfam10, barcelona
12130 AMD Family 10h core based CPUs with x86-64 instruction set support. (This
12131 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12132 instruction set extensions.)
12133 @item winchip-c6
12134 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
12135 set support.
12136 @item winchip2
12137 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
12138 instruction set support.
12139 @item c3
12140 Via C3 CPU with MMX and 3DNow!@: instruction set support. (No scheduling is
12141 implemented for this chip.)
12142 @item c3-2
12143 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
12144 implemented for this chip.)
12145 @item geode
12146 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
12147 @end table
12148
12149 While picking a specific @var{cpu-type} will schedule things appropriately
12150 for that particular chip, the compiler will not generate any code that
12151 does not run on the i386 without the @option{-march=@var{cpu-type}} option
12152 being used.
12153
12154 @item -march=@var{cpu-type}
12155 @opindex march
12156 Generate instructions for the machine type @var{cpu-type}. The choices
12157 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
12158 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
12159
12160 @item -mcpu=@var{cpu-type}
12161 @opindex mcpu
12162 A deprecated synonym for @option{-mtune}.
12163
12164 @item -mfpmath=@var{unit}
12165 @opindex mfpmath
12166 Generate floating point arithmetics for selected unit @var{unit}. The choices
12167 for @var{unit} are:
12168
12169 @table @samp
12170 @item 387
12171 Use the standard 387 floating point coprocessor present majority of chips and
12172 emulated otherwise. Code compiled with this option will run almost everywhere.
12173 The temporary results are computed in 80bit precision instead of precision
12174 specified by the type resulting in slightly different results compared to most
12175 of other chips. See @option{-ffloat-store} for more detailed description.
12176
12177 This is the default choice for i386 compiler.
12178
12179 @item sse
12180 Use scalar floating point instructions present in the SSE instruction set.
12181 This instruction set is supported by Pentium3 and newer chips, in the AMD line
12182 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
12183 instruction set supports only single precision arithmetics, thus the double and
12184 extended precision arithmetics is still done using 387. Later version, present
12185 only in Pentium4 and the future AMD x86-64 chips supports double precision
12186 arithmetics too.
12187
12188 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
12189 or @option{-msse2} switches to enable SSE extensions and make this option
12190 effective. For the x86-64 compiler, these extensions are enabled by default.
12191
12192 The resulting code should be considerably faster in the majority of cases and avoid
12193 the numerical instability problems of 387 code, but may break some existing
12194 code that expects temporaries to be 80bit.
12195
12196 This is the default choice for the x86-64 compiler.
12197
12198 @item sse,387
12199 @itemx sse+387
12200 @itemx both
12201 Attempt to utilize both instruction sets at once. This effectively double the
12202 amount of available registers and on chips with separate execution units for
12203 387 and SSE the execution resources too. Use this option with care, as it is
12204 still experimental, because the GCC register allocator does not model separate
12205 functional units well resulting in instable performance.
12206 @end table
12207
12208 @item -masm=@var{dialect}
12209 @opindex masm=@var{dialect}
12210 Output asm instructions using selected @var{dialect}. Supported
12211 choices are @samp{intel} or @samp{att} (the default one). Darwin does
12212 not support @samp{intel}.
12213
12214 @item -mieee-fp
12215 @itemx -mno-ieee-fp
12216 @opindex mieee-fp
12217 @opindex mno-ieee-fp
12218 Control whether or not the compiler uses IEEE floating point
12219 comparisons. These handle correctly the case where the result of a
12220 comparison is unordered.
12221
12222 @item -msoft-float
12223 @opindex msoft-float
12224 Generate output containing library calls for floating point.
12225 @strong{Warning:} the requisite libraries are not part of GCC@.
12226 Normally the facilities of the machine's usual C compiler are used, but
12227 this can't be done directly in cross-compilation. You must make your
12228 own arrangements to provide suitable library functions for
12229 cross-compilation.
12230
12231 On machines where a function returns floating point results in the 80387
12232 register stack, some floating point opcodes may be emitted even if
12233 @option{-msoft-float} is used.
12234
12235 @item -mno-fp-ret-in-387
12236 @opindex mno-fp-ret-in-387
12237 Do not use the FPU registers for return values of functions.
12238
12239 The usual calling convention has functions return values of types
12240 @code{float} and @code{double} in an FPU register, even if there
12241 is no FPU@. The idea is that the operating system should emulate
12242 an FPU@.
12243
12244 The option @option{-mno-fp-ret-in-387} causes such values to be returned
12245 in ordinary CPU registers instead.
12246
12247 @item -mno-fancy-math-387
12248 @opindex mno-fancy-math-387
12249 Some 387 emulators do not support the @code{sin}, @code{cos} and
12250 @code{sqrt} instructions for the 387. Specify this option to avoid
12251 generating those instructions. This option is the default on FreeBSD,
12252 OpenBSD and NetBSD@. This option is overridden when @option{-march}
12253 indicates that the target cpu will always have an FPU and so the
12254 instruction will not need emulation. As of revision 2.6.1, these
12255 instructions are not generated unless you also use the
12256 @option{-funsafe-math-optimizations} switch.
12257
12258 @item -malign-double
12259 @itemx -mno-align-double
12260 @opindex malign-double
12261 @opindex mno-align-double
12262 Control whether GCC aligns @code{double}, @code{long double}, and
12263 @code{long long} variables on a two word boundary or a one word
12264 boundary. Aligning @code{double} variables on a two word boundary will
12265 produce code that runs somewhat faster on a @samp{Pentium} at the
12266 expense of more memory.
12267
12268 On x86-64, @option{-malign-double} is enabled by default.
12269
12270 @strong{Warning:} if you use the @option{-malign-double} switch,
12271 structures containing the above types will be aligned differently than
12272 the published application binary interface specifications for the 386
12273 and will not be binary compatible with structures in code compiled
12274 without that switch.
12275
12276 @item -m96bit-long-double
12277 @itemx -m128bit-long-double
12278 @opindex m96bit-long-double
12279 @opindex m128bit-long-double
12280 These switches control the size of @code{long double} type. The i386
12281 application binary interface specifies the size to be 96 bits,
12282 so @option{-m96bit-long-double} is the default in 32 bit mode.
12283
12284 Modern architectures (Pentium and newer) would prefer @code{long double}
12285 to be aligned to an 8 or 16 byte boundary. In arrays or structures
12286 conforming to the ABI, this would not be possible. So specifying a
12287 @option{-m128bit-long-double} will align @code{long double}
12288 to a 16 byte boundary by padding the @code{long double} with an additional
12289 32 bit zero.
12290
12291 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12292 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12293
12294 Notice that neither of these options enable any extra precision over the x87
12295 standard of 80 bits for a @code{long double}.
12296
12297 @strong{Warning:} if you override the default value for your target ABI, the
12298 structures and arrays containing @code{long double} variables will change
12299 their size as well as function calling convention for function taking
12300 @code{long double} will be modified. Hence they will not be binary
12301 compatible with arrays or structures in code compiled without that switch.
12302
12303 @item -mlarge-data-threshold=@var{number}
12304 @opindex mlarge-data-threshold=@var{number}
12305 When @option{-mcmodel=medium} is specified, the data greater than
12306 @var{threshold} are placed in large data section. This value must be the
12307 same across all object linked into the binary and defaults to 65535.
12308
12309 @item -mrtd
12310 @opindex mrtd
12311 Use a different function-calling convention, in which functions that
12312 take a fixed number of arguments return with the @code{ret} @var{num}
12313 instruction, which pops their arguments while returning. This saves one
12314 instruction in the caller since there is no need to pop the arguments
12315 there.
12316
12317 You can specify that an individual function is called with this calling
12318 sequence with the function attribute @samp{stdcall}. You can also
12319 override the @option{-mrtd} option by using the function attribute
12320 @samp{cdecl}. @xref{Function Attributes}.
12321
12322 @strong{Warning:} this calling convention is incompatible with the one
12323 normally used on Unix, so you cannot use it if you need to call
12324 libraries compiled with the Unix compiler.
12325
12326 Also, you must provide function prototypes for all functions that
12327 take variable numbers of arguments (including @code{printf});
12328 otherwise incorrect code will be generated for calls to those
12329 functions.
12330
12331 In addition, seriously incorrect code will result if you call a
12332 function with too many arguments. (Normally, extra arguments are
12333 harmlessly ignored.)
12334
12335 @item -mregparm=@var{num}
12336 @opindex mregparm
12337 Control how many registers are used to pass integer arguments. By
12338 default, no registers are used to pass arguments, and at most 3
12339 registers can be used. You can control this behavior for a specific
12340 function by using the function attribute @samp{regparm}.
12341 @xref{Function Attributes}.
12342
12343 @strong{Warning:} if you use this switch, and
12344 @var{num} is nonzero, then you must build all modules with the same
12345 value, including any libraries. This includes the system libraries and
12346 startup modules.
12347
12348 @item -msseregparm
12349 @opindex msseregparm
12350 Use SSE register passing conventions for float and double arguments
12351 and return values. You can control this behavior for a specific
12352 function by using the function attribute @samp{sseregparm}.
12353 @xref{Function Attributes}.
12354
12355 @strong{Warning:} if you use this switch then you must build all
12356 modules with the same value, including any libraries. This includes
12357 the system libraries and startup modules.
12358
12359 @item -mvect8-ret-in-mem
12360 @opindex mvect8-ret-in-mem
12361 Return 8-byte vectors in memory instead of MMX registers. This is the
12362 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
12363 Studio compilers until version 12. Later compiler versions (starting
12364 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
12365 is the default on Solaris@tie{}10 and later. @emph{Only} use this option if
12366 you need to remain compatible with existing code produced by those
12367 previous compiler versions or older versions of GCC.
12368
12369 @item -mpc32
12370 @itemx -mpc64
12371 @itemx -mpc80
12372 @opindex mpc32
12373 @opindex mpc64
12374 @opindex mpc80
12375
12376 Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32}
12377 is specified, the significands of results of floating-point operations are
12378 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12379 significands of results of floating-point operations to 53 bits (double
12380 precision) and @option{-mpc80} rounds the significands of results of
12381 floating-point operations to 64 bits (extended double precision), which is
12382 the default. When this option is used, floating-point operations in higher
12383 precisions are not available to the programmer without setting the FPU
12384 control word explicitly.
12385
12386 Setting the rounding of floating-point operations to less than the default
12387 80 bits can speed some programs by 2% or more. Note that some mathematical
12388 libraries assume that extended precision (80 bit) floating-point operations
12389 are enabled by default; routines in such libraries could suffer significant
12390 loss of accuracy, typically through so-called "catastrophic cancellation",
12391 when this option is used to set the precision to less than extended precision.
12392
12393 @item -mstackrealign
12394 @opindex mstackrealign
12395 Realign the stack at entry. On the Intel x86, the @option{-mstackrealign}
12396 option will generate an alternate prologue and epilogue that realigns the
12397 runtime stack if necessary. This supports mixing legacy codes that keep
12398 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12399 SSE compatibility. See also the attribute @code{force_align_arg_pointer},
12400 applicable to individual functions.
12401
12402 @item -mpreferred-stack-boundary=@var{num}
12403 @opindex mpreferred-stack-boundary
12404 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12405 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
12406 the default is 4 (16 bytes or 128 bits).
12407
12408 @item -mincoming-stack-boundary=@var{num}
12409 @opindex mincoming-stack-boundary
12410 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12411 boundary. If @option{-mincoming-stack-boundary} is not specified,
12412 the one specified by @option{-mpreferred-stack-boundary} will be used.
12413
12414 On Pentium and PentiumPro, @code{double} and @code{long double} values
12415 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12416 suffer significant run time performance penalties. On Pentium III, the
12417 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12418 properly if it is not 16 byte aligned.
12419
12420 To ensure proper alignment of this values on the stack, the stack boundary
12421 must be as aligned as that required by any value stored on the stack.
12422 Further, every function must be generated such that it keeps the stack
12423 aligned. Thus calling a function compiled with a higher preferred
12424 stack boundary from a function compiled with a lower preferred stack
12425 boundary will most likely misalign the stack. It is recommended that
12426 libraries that use callbacks always use the default setting.
12427
12428 This extra alignment does consume extra stack space, and generally
12429 increases code size. Code that is sensitive to stack space usage, such
12430 as embedded systems and operating system kernels, may want to reduce the
12431 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12432
12433 @item -mmmx
12434 @itemx -mno-mmx
12435 @itemx -msse
12436 @itemx -mno-sse
12437 @itemx -msse2
12438 @itemx -mno-sse2
12439 @itemx -msse3
12440 @itemx -mno-sse3
12441 @itemx -mssse3
12442 @itemx -mno-ssse3
12443 @itemx -msse4.1
12444 @need 800
12445 @itemx -mno-sse4.1
12446 @itemx -msse4.2
12447 @itemx -mno-sse4.2
12448 @itemx -msse4
12449 @itemx -mno-sse4
12450 @itemx -mavx
12451 @itemx -mno-avx
12452 @itemx -maes
12453 @itemx -mno-aes
12454 @itemx -mpclmul
12455 @need 800
12456 @itemx -mno-pclmul
12457 @itemx -mfsgsbase
12458 @itemx -mno-fsgsbase
12459 @itemx -mrdrnd
12460 @itemx -mno-rdrnd
12461 @itemx -mf16c
12462 @itemx -mno-f16c
12463 @itemx -msse4a
12464 @itemx -mno-sse4a
12465 @itemx -mfma4
12466 @need 800
12467 @itemx -mno-fma4
12468 @itemx -mxop
12469 @itemx -mno-xop
12470 @itemx -mlwp
12471 @itemx -mno-lwp
12472 @itemx -m3dnow
12473 @itemx -mno-3dnow
12474 @itemx -mpopcnt
12475 @itemx -mno-popcnt
12476 @itemx -mabm
12477 @itemx -mno-abm
12478 @itemx -mbmi
12479 @itemx -mno-bmi
12480 @itemx -mtbm
12481 @itemx -mno-tbm
12482 @opindex mmmx
12483 @opindex mno-mmx
12484 @opindex msse
12485 @opindex mno-sse
12486 @opindex m3dnow
12487 @opindex mno-3dnow
12488 These switches enable or disable the use of instructions in the MMX,
12489 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, FSGSBASE, RDRND,
12490 F16C, SSE4A, FMA4, XOP, LWP, ABM, BMI, or 3DNow!@: extended instruction sets.
12491 These extensions are also available as built-in functions: see
12492 @ref{X86 Built-in Functions}, for details of the functions enabled and
12493 disabled by these switches.
12494
12495 To have SSE/SSE2 instructions generated automatically from floating-point
12496 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12497
12498 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12499 generates new AVX instructions or AVX equivalence for all SSEx instructions
12500 when needed.
12501
12502 These options will enable GCC to use these extended instructions in
12503 generated code, even without @option{-mfpmath=sse}. Applications which
12504 perform runtime CPU detection must compile separate files for each
12505 supported architecture, using the appropriate flags. In particular,
12506 the file containing the CPU detection code should be compiled without
12507 these options.
12508
12509 @item -mfused-madd
12510 @itemx -mno-fused-madd
12511 @opindex mfused-madd
12512 @opindex mno-fused-madd
12513 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12514 instructions. The default is to use these instructions.
12515
12516 @item -mcld
12517 @opindex mcld
12518 This option instructs GCC to emit a @code{cld} instruction in the prologue
12519 of functions that use string instructions. String instructions depend on
12520 the DF flag to select between autoincrement or autodecrement mode. While the
12521 ABI specifies the DF flag to be cleared on function entry, some operating
12522 systems violate this specification by not clearing the DF flag in their
12523 exception dispatchers. The exception handler can be invoked with the DF flag
12524 set which leads to wrong direction mode, when string instructions are used.
12525 This option can be enabled by default on 32-bit x86 targets by configuring
12526 GCC with the @option{--enable-cld} configure option. Generation of @code{cld}
12527 instructions can be suppressed with the @option{-mno-cld} compiler option
12528 in this case.
12529
12530 @item -mvzeroupper
12531 @opindex mvzeroupper
12532 This option instructs GCC to emit a @code{vzeroupper} instruction
12533 before a transfer of control flow out of the function to minimize
12534 AVX to SSE transition penalty as well as remove unnecessary zeroupper
12535 intrinsics.
12536
12537 @item -mcx16
12538 @opindex mcx16
12539 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12540 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12541 data types. This is useful for high resolution counters that could be updated
12542 by multiple processors (or cores). This instruction is generated as part of
12543 atomic built-in functions: see @ref{Atomic Builtins} for details.
12544
12545 @item -msahf
12546 @opindex msahf
12547 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12548 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12549 by AMD64 until introduction of Pentium 4 G1 step in December 2005. LAHF and
12550 SAHF are load and store instructions, respectively, for certain status flags.
12551 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12552 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12553
12554 @item -mmovbe
12555 @opindex mmovbe
12556 This option will enable GCC to use movbe instruction to implement
12557 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12558
12559 @item -mcrc32
12560 @opindex mcrc32
12561 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12562 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12563 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12564
12565 @item -mrecip
12566 @opindex mrecip
12567 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12568 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12569 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12570 variants) for single precision floating point arguments. These instructions
12571 are generated only when @option{-funsafe-math-optimizations} is enabled
12572 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12573 Note that while the throughput of the sequence is higher than the throughput
12574 of the non-reciprocal instruction, the precision of the sequence can be
12575 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12576
12577 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12578 already with @option{-ffast-math} (or the above option combination), and
12579 doesn't need @option{-mrecip}.
12580
12581 @item -mveclibabi=@var{type}
12582 @opindex mveclibabi
12583 Specifies the ABI type to use for vectorizing intrinsics using an
12584 external library. Supported types are @code{svml} for the Intel short
12585 vector math library and @code{acml} for the AMD math core library style
12586 of interfacing. GCC will currently emit calls to @code{vmldExp2},
12587 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12588 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12589 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12590 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12591 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12592 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12593 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12594 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12595 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12596 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12597 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12598 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12599 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12600 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12601 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12602 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12603 compatible library will have to be specified at link time.
12604
12605 @item -mabi=@var{name}
12606 @opindex mabi
12607 Generate code for the specified calling convention. Permissible values
12608 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12609 @samp{ms} for the Microsoft ABI. The default is to use the Microsoft
12610 ABI when targeting Windows. On all other systems, the default is the
12611 SYSV ABI. You can control this behavior for a specific function by
12612 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12613 @xref{Function Attributes}.
12614
12615 @item -mpush-args
12616 @itemx -mno-push-args
12617 @opindex mpush-args
12618 @opindex mno-push-args
12619 Use PUSH operations to store outgoing parameters. This method is shorter
12620 and usually equally fast as method using SUB/MOV operations and is enabled
12621 by default. In some cases disabling it may improve performance because of
12622 improved scheduling and reduced dependencies.
12623
12624 @item -maccumulate-outgoing-args
12625 @opindex maccumulate-outgoing-args
12626 If enabled, the maximum amount of space required for outgoing arguments will be
12627 computed in the function prologue. This is faster on most modern CPUs
12628 because of reduced dependencies, improved scheduling and reduced stack usage
12629 when preferred stack boundary is not equal to 2. The drawback is a notable
12630 increase in code size. This switch implies @option{-mno-push-args}.
12631
12632 @item -mthreads
12633 @opindex mthreads
12634 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
12635 on thread-safe exception handling must compile and link all code with the
12636 @option{-mthreads} option. When compiling, @option{-mthreads} defines
12637 @option{-D_MT}; when linking, it links in a special thread helper library
12638 @option{-lmingwthrd} which cleans up per thread exception handling data.
12639
12640 @item -mno-align-stringops
12641 @opindex mno-align-stringops
12642 Do not align destination of inlined string operations. This switch reduces
12643 code size and improves performance in case the destination is already aligned,
12644 but GCC doesn't know about it.
12645
12646 @item -minline-all-stringops
12647 @opindex minline-all-stringops
12648 By default GCC inlines string operations only when destination is known to be
12649 aligned at least to 4 byte boundary. This enables more inlining, increase code
12650 size, but may improve performance of code that depends on fast memcpy, strlen
12651 and memset for short lengths.
12652
12653 @item -minline-stringops-dynamically
12654 @opindex minline-stringops-dynamically
12655 For string operation of unknown size, inline runtime checks so for small
12656 blocks inline code is used, while for large blocks library call is used.
12657
12658 @item -mstringop-strategy=@var{alg}
12659 @opindex mstringop-strategy=@var{alg}
12660 Overwrite internal decision heuristic about particular algorithm to inline
12661 string operation with. The allowed values are @code{rep_byte},
12662 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12663 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12664 expanding inline loop, @code{libcall} for always expanding library call.
12665
12666 @item -momit-leaf-frame-pointer
12667 @opindex momit-leaf-frame-pointer
12668 Don't keep the frame pointer in a register for leaf functions. This
12669 avoids the instructions to save, set up and restore frame pointers and
12670 makes an extra register available in leaf functions. The option
12671 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12672 which might make debugging harder.
12673
12674 @item -mtls-direct-seg-refs
12675 @itemx -mno-tls-direct-seg-refs
12676 @opindex mtls-direct-seg-refs
12677 Controls whether TLS variables may be accessed with offsets from the
12678 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12679 or whether the thread base pointer must be added. Whether or not this
12680 is legal depends on the operating system, and whether it maps the
12681 segment to cover the entire TLS area.
12682
12683 For systems that use GNU libc, the default is on.
12684
12685 @item -msse2avx
12686 @itemx -mno-sse2avx
12687 @opindex msse2avx
12688 Specify that the assembler should encode SSE instructions with VEX
12689 prefix. The option @option{-mavx} turns this on by default.
12690
12691 @item -mfentry
12692 @itemx -mno-fentry
12693 @opindex mfentry
12694 If profiling is active @option{-pg} put the profiling
12695 counter call before prologue.
12696 Note: On x86 architectures the attribute @code{ms_hook_prologue}
12697 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
12698
12699 @item -m8bit-idiv
12700 @itemx -mno-8bit-idiv
12701 @opindex 8bit-idiv
12702 On some processors, like Intel Atom, 8bit unsigned integer divide is
12703 much faster than 32bit/64bit integer divide. This option will generate a
12704 runt-time check. If both dividend and divisor are within range of 0
12705 to 255, 8bit unsigned integer divide will be used instead of
12706 32bit/64bit integer divide.
12707
12708 @end table
12709
12710 These @samp{-m} switches are supported in addition to the above
12711 on AMD x86-64 processors in 64-bit environments.
12712
12713 @table @gcctabopt
12714 @item -m32
12715 @itemx -m64
12716 @opindex m32
12717 @opindex m64
12718 Generate code for a 32-bit or 64-bit environment.
12719 The 32-bit environment sets int, long and pointer to 32 bits and
12720 generates code that runs on any i386 system.
12721 The 64-bit environment sets int to 32 bits and long and pointer
12722 to 64 bits and generates code for AMD's x86-64 architecture. For
12723 darwin only the -m64 option turns off the @option{-fno-pic} and
12724 @option{-mdynamic-no-pic} options.
12725
12726 @item -mno-red-zone
12727 @opindex mno-red-zone
12728 Do not use a so called red zone for x86-64 code. The red zone is mandated
12729 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12730 stack pointer that will not be modified by signal or interrupt handlers
12731 and therefore can be used for temporary data without adjusting the stack
12732 pointer. The flag @option{-mno-red-zone} disables this red zone.
12733
12734 @item -mcmodel=small
12735 @opindex mcmodel=small
12736 Generate code for the small code model: the program and its symbols must
12737 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
12738 Programs can be statically or dynamically linked. This is the default
12739 code model.
12740
12741 @item -mcmodel=kernel
12742 @opindex mcmodel=kernel
12743 Generate code for the kernel code model. The kernel runs in the
12744 negative 2 GB of the address space.
12745 This model has to be used for Linux kernel code.
12746
12747 @item -mcmodel=medium
12748 @opindex mcmodel=medium
12749 Generate code for the medium model: The program is linked in the lower 2
12750 GB of the address space. Small symbols are also placed there. Symbols
12751 with sizes larger than @option{-mlarge-data-threshold} are put into
12752 large data or bss sections and can be located above 2GB. Programs can
12753 be statically or dynamically linked.
12754
12755 @item -mcmodel=large
12756 @opindex mcmodel=large
12757 Generate code for the large model: This model makes no assumptions
12758 about addresses and sizes of sections.
12759 @end table
12760
12761 @node IA-64 Options
12762 @subsection IA-64 Options
12763 @cindex IA-64 Options
12764
12765 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12766
12767 @table @gcctabopt
12768 @item -mbig-endian
12769 @opindex mbig-endian
12770 Generate code for a big endian target. This is the default for HP-UX@.
12771
12772 @item -mlittle-endian
12773 @opindex mlittle-endian
12774 Generate code for a little endian target. This is the default for AIX5
12775 and GNU/Linux.
12776
12777 @item -mgnu-as
12778 @itemx -mno-gnu-as
12779 @opindex mgnu-as
12780 @opindex mno-gnu-as
12781 Generate (or don't) code for the GNU assembler. This is the default.
12782 @c Also, this is the default if the configure option @option{--with-gnu-as}
12783 @c is used.
12784
12785 @item -mgnu-ld
12786 @itemx -mno-gnu-ld
12787 @opindex mgnu-ld
12788 @opindex mno-gnu-ld
12789 Generate (or don't) code for the GNU linker. This is the default.
12790 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12791 @c is used.
12792
12793 @item -mno-pic
12794 @opindex mno-pic
12795 Generate code that does not use a global pointer register. The result
12796 is not position independent code, and violates the IA-64 ABI@.
12797
12798 @item -mvolatile-asm-stop
12799 @itemx -mno-volatile-asm-stop
12800 @opindex mvolatile-asm-stop
12801 @opindex mno-volatile-asm-stop
12802 Generate (or don't) a stop bit immediately before and after volatile asm
12803 statements.
12804
12805 @item -mregister-names
12806 @itemx -mno-register-names
12807 @opindex mregister-names
12808 @opindex mno-register-names
12809 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12810 the stacked registers. This may make assembler output more readable.
12811
12812 @item -mno-sdata
12813 @itemx -msdata
12814 @opindex mno-sdata
12815 @opindex msdata
12816 Disable (or enable) optimizations that use the small data section. This may
12817 be useful for working around optimizer bugs.
12818
12819 @item -mconstant-gp
12820 @opindex mconstant-gp
12821 Generate code that uses a single constant global pointer value. This is
12822 useful when compiling kernel code.
12823
12824 @item -mauto-pic
12825 @opindex mauto-pic
12826 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
12827 This is useful when compiling firmware code.
12828
12829 @item -minline-float-divide-min-latency
12830 @opindex minline-float-divide-min-latency
12831 Generate code for inline divides of floating point values
12832 using the minimum latency algorithm.
12833
12834 @item -minline-float-divide-max-throughput
12835 @opindex minline-float-divide-max-throughput
12836 Generate code for inline divides of floating point values
12837 using the maximum throughput algorithm.
12838
12839 @item -mno-inline-float-divide
12840 @opindex mno-inline-float-divide
12841 Do not generate inline code for divides of floating point values.
12842
12843 @item -minline-int-divide-min-latency
12844 @opindex minline-int-divide-min-latency
12845 Generate code for inline divides of integer values
12846 using the minimum latency algorithm.
12847
12848 @item -minline-int-divide-max-throughput
12849 @opindex minline-int-divide-max-throughput
12850 Generate code for inline divides of integer values
12851 using the maximum throughput algorithm.
12852
12853 @item -mno-inline-int-divide
12854 @opindex mno-inline-int-divide
12855 Do not generate inline code for divides of integer values.
12856
12857 @item -minline-sqrt-min-latency
12858 @opindex minline-sqrt-min-latency
12859 Generate code for inline square roots
12860 using the minimum latency algorithm.
12861
12862 @item -minline-sqrt-max-throughput
12863 @opindex minline-sqrt-max-throughput
12864 Generate code for inline square roots
12865 using the maximum throughput algorithm.
12866
12867 @item -mno-inline-sqrt
12868 @opindex mno-inline-sqrt
12869 Do not generate inline code for sqrt.
12870
12871 @item -mfused-madd
12872 @itemx -mno-fused-madd
12873 @opindex mfused-madd
12874 @opindex mno-fused-madd
12875 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12876 instructions. The default is to use these instructions.
12877
12878 @item -mno-dwarf2-asm
12879 @itemx -mdwarf2-asm
12880 @opindex mno-dwarf2-asm
12881 @opindex mdwarf2-asm
12882 Don't (or do) generate assembler code for the DWARF2 line number debugging
12883 info. This may be useful when not using the GNU assembler.
12884
12885 @item -mearly-stop-bits
12886 @itemx -mno-early-stop-bits
12887 @opindex mearly-stop-bits
12888 @opindex mno-early-stop-bits
12889 Allow stop bits to be placed earlier than immediately preceding the
12890 instruction that triggered the stop bit. This can improve instruction
12891 scheduling, but does not always do so.
12892
12893 @item -mfixed-range=@var{register-range}
12894 @opindex mfixed-range
12895 Generate code treating the given register range as fixed registers.
12896 A fixed register is one that the register allocator can not use. This is
12897 useful when compiling kernel code. A register range is specified as
12898 two registers separated by a dash. Multiple register ranges can be
12899 specified separated by a comma.
12900
12901 @item -mtls-size=@var{tls-size}
12902 @opindex mtls-size
12903 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
12904 64.
12905
12906 @item -mtune=@var{cpu-type}
12907 @opindex mtune
12908 Tune the instruction scheduling for a particular CPU, Valid values are
12909 itanium, itanium1, merced, itanium2, and mckinley.
12910
12911 @item -milp32
12912 @itemx -mlp64
12913 @opindex milp32
12914 @opindex mlp64
12915 Generate code for a 32-bit or 64-bit environment.
12916 The 32-bit environment sets int, long and pointer to 32 bits.
12917 The 64-bit environment sets int to 32 bits and long and pointer
12918 to 64 bits. These are HP-UX specific flags.
12919
12920 @item -mno-sched-br-data-spec
12921 @itemx -msched-br-data-spec
12922 @opindex mno-sched-br-data-spec
12923 @opindex msched-br-data-spec
12924 (Dis/En)able data speculative scheduling before reload.
12925 This will result in generation of the ld.a instructions and
12926 the corresponding check instructions (ld.c / chk.a).
12927 The default is 'disable'.
12928
12929 @item -msched-ar-data-spec
12930 @itemx -mno-sched-ar-data-spec
12931 @opindex msched-ar-data-spec
12932 @opindex mno-sched-ar-data-spec
12933 (En/Dis)able data speculative scheduling after reload.
12934 This will result in generation of the ld.a instructions and
12935 the corresponding check instructions (ld.c / chk.a).
12936 The default is 'enable'.
12937
12938 @item -mno-sched-control-spec
12939 @itemx -msched-control-spec
12940 @opindex mno-sched-control-spec
12941 @opindex msched-control-spec
12942 (Dis/En)able control speculative scheduling. This feature is
12943 available only during region scheduling (i.e.@: before reload).
12944 This will result in generation of the ld.s instructions and
12945 the corresponding check instructions chk.s .
12946 The default is 'disable'.
12947
12948 @item -msched-br-in-data-spec
12949 @itemx -mno-sched-br-in-data-spec
12950 @opindex msched-br-in-data-spec
12951 @opindex mno-sched-br-in-data-spec
12952 (En/Dis)able speculative scheduling of the instructions that
12953 are dependent on the data speculative loads before reload.
12954 This is effective only with @option{-msched-br-data-spec} enabled.
12955 The default is 'enable'.
12956
12957 @item -msched-ar-in-data-spec
12958 @itemx -mno-sched-ar-in-data-spec
12959 @opindex msched-ar-in-data-spec
12960 @opindex mno-sched-ar-in-data-spec
12961 (En/Dis)able speculative scheduling of the instructions that
12962 are dependent on the data speculative loads after reload.
12963 This is effective only with @option{-msched-ar-data-spec} enabled.
12964 The default is 'enable'.
12965
12966 @item -msched-in-control-spec
12967 @itemx -mno-sched-in-control-spec
12968 @opindex msched-in-control-spec
12969 @opindex mno-sched-in-control-spec
12970 (En/Dis)able speculative scheduling of the instructions that
12971 are dependent on the control speculative loads.
12972 This is effective only with @option{-msched-control-spec} enabled.
12973 The default is 'enable'.
12974
12975 @item -mno-sched-prefer-non-data-spec-insns
12976 @itemx -msched-prefer-non-data-spec-insns
12977 @opindex mno-sched-prefer-non-data-spec-insns
12978 @opindex msched-prefer-non-data-spec-insns
12979 If enabled, data speculative instructions will be chosen for schedule
12980 only if there are no other choices at the moment. This will make
12981 the use of the data speculation much more conservative.
12982 The default is 'disable'.
12983
12984 @item -mno-sched-prefer-non-control-spec-insns
12985 @itemx -msched-prefer-non-control-spec-insns
12986 @opindex mno-sched-prefer-non-control-spec-insns
12987 @opindex msched-prefer-non-control-spec-insns
12988 If enabled, control speculative instructions will be chosen for schedule
12989 only if there are no other choices at the moment. This will make
12990 the use of the control speculation much more conservative.
12991 The default is 'disable'.
12992
12993 @item -mno-sched-count-spec-in-critical-path
12994 @itemx -msched-count-spec-in-critical-path
12995 @opindex mno-sched-count-spec-in-critical-path
12996 @opindex msched-count-spec-in-critical-path
12997 If enabled, speculative dependencies will be considered during
12998 computation of the instructions priorities. This will make the use of the
12999 speculation a bit more conservative.
13000 The default is 'disable'.
13001
13002 @item -msched-spec-ldc
13003 @opindex msched-spec-ldc
13004 Use a simple data speculation check. This option is on by default.
13005
13006 @item -msched-control-spec-ldc
13007 @opindex msched-spec-ldc
13008 Use a simple check for control speculation. This option is on by default.
13009
13010 @item -msched-stop-bits-after-every-cycle
13011 @opindex msched-stop-bits-after-every-cycle
13012 Place a stop bit after every cycle when scheduling. This option is on
13013 by default.
13014
13015 @item -msched-fp-mem-deps-zero-cost
13016 @opindex msched-fp-mem-deps-zero-cost
13017 Assume that floating-point stores and loads are not likely to cause a conflict
13018 when placed into the same instruction group. This option is disabled by
13019 default.
13020
13021 @item -msel-sched-dont-check-control-spec
13022 @opindex msel-sched-dont-check-control-spec
13023 Generate checks for control speculation in selective scheduling.
13024 This flag is disabled by default.
13025
13026 @item -msched-max-memory-insns=@var{max-insns}
13027 @opindex msched-max-memory-insns
13028 Limit on the number of memory insns per instruction group, giving lower
13029 priority to subsequent memory insns attempting to schedule in the same
13030 instruction group. Frequently useful to prevent cache bank conflicts.
13031 The default value is 1.
13032
13033 @item -msched-max-memory-insns-hard-limit
13034 @opindex msched-max-memory-insns-hard-limit
13035 Disallow more than `msched-max-memory-insns' in instruction group.
13036 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
13037 when limit is reached but may still schedule memory operations.
13038
13039 @end table
13040
13041 @node IA-64/VMS Options
13042 @subsection IA-64/VMS Options
13043
13044 These @samp{-m} options are defined for the IA-64/VMS implementations:
13045
13046 @table @gcctabopt
13047 @item -mvms-return-codes
13048 @opindex mvms-return-codes
13049 Return VMS condition codes from main. The default is to return POSIX
13050 style condition (e.g.@ error) codes.
13051
13052 @item -mdebug-main=@var{prefix}
13053 @opindex mdebug-main=@var{prefix}
13054 Flag the first routine whose name starts with @var{prefix} as the main
13055 routine for the debugger.
13056
13057 @item -mmalloc64
13058 @opindex mmalloc64
13059 Default to 64bit memory allocation routines.
13060 @end table
13061
13062 @node LM32 Options
13063 @subsection LM32 Options
13064 @cindex LM32 options
13065
13066 These @option{-m} options are defined for the Lattice Mico32 architecture:
13067
13068 @table @gcctabopt
13069 @item -mbarrel-shift-enabled
13070 @opindex mbarrel-shift-enabled
13071 Enable barrel-shift instructions.
13072
13073 @item -mdivide-enabled
13074 @opindex mdivide-enabled
13075 Enable divide and modulus instructions.
13076
13077 @item -mmultiply-enabled
13078 @opindex multiply-enabled
13079 Enable multiply instructions.
13080
13081 @item -msign-extend-enabled
13082 @opindex msign-extend-enabled
13083 Enable sign extend instructions.
13084
13085 @item -muser-enabled
13086 @opindex muser-enabled
13087 Enable user-defined instructions.
13088
13089 @end table
13090
13091 @node M32C Options
13092 @subsection M32C Options
13093 @cindex M32C options
13094
13095 @table @gcctabopt
13096 @item -mcpu=@var{name}
13097 @opindex mcpu=
13098 Select the CPU for which code is generated. @var{name} may be one of
13099 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
13100 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
13101 the M32C/80 series.
13102
13103 @item -msim
13104 @opindex msim
13105 Specifies that the program will be run on the simulator. This causes
13106 an alternate runtime library to be linked in which supports, for
13107 example, file I/O@. You must not use this option when generating
13108 programs that will run on real hardware; you must provide your own
13109 runtime library for whatever I/O functions are needed.
13110
13111 @item -memregs=@var{number}
13112 @opindex memregs=
13113 Specifies the number of memory-based pseudo-registers GCC will use
13114 during code generation. These pseudo-registers will be used like real
13115 registers, so there is a tradeoff between GCC's ability to fit the
13116 code into available registers, and the performance penalty of using
13117 memory instead of registers. Note that all modules in a program must
13118 be compiled with the same value for this option. Because of that, you
13119 must not use this option with the default runtime libraries gcc
13120 builds.
13121
13122 @end table
13123
13124 @node M32R/D Options
13125 @subsection M32R/D Options
13126 @cindex M32R/D options
13127
13128 These @option{-m} options are defined for Renesas M32R/D architectures:
13129
13130 @table @gcctabopt
13131 @item -m32r2
13132 @opindex m32r2
13133 Generate code for the M32R/2@.
13134
13135 @item -m32rx
13136 @opindex m32rx
13137 Generate code for the M32R/X@.
13138
13139 @item -m32r
13140 @opindex m32r
13141 Generate code for the M32R@. This is the default.
13142
13143 @item -mmodel=small
13144 @opindex mmodel=small
13145 Assume all objects live in the lower 16MB of memory (so that their addresses
13146 can be loaded with the @code{ld24} instruction), and assume all subroutines
13147 are reachable with the @code{bl} instruction.
13148 This is the default.
13149
13150 The addressability of a particular object can be set with the
13151 @code{model} attribute.
13152
13153 @item -mmodel=medium
13154 @opindex mmodel=medium
13155 Assume objects may be anywhere in the 32-bit address space (the compiler
13156 will generate @code{seth/add3} instructions to load their addresses), and
13157 assume all subroutines are reachable with the @code{bl} instruction.
13158
13159 @item -mmodel=large
13160 @opindex mmodel=large
13161 Assume objects may be anywhere in the 32-bit address space (the compiler
13162 will generate @code{seth/add3} instructions to load their addresses), and
13163 assume subroutines may not be reachable with the @code{bl} instruction
13164 (the compiler will generate the much slower @code{seth/add3/jl}
13165 instruction sequence).
13166
13167 @item -msdata=none
13168 @opindex msdata=none
13169 Disable use of the small data area. Variables will be put into
13170 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
13171 @code{section} attribute has been specified).
13172 This is the default.
13173
13174 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
13175 Objects may be explicitly put in the small data area with the
13176 @code{section} attribute using one of these sections.
13177
13178 @item -msdata=sdata
13179 @opindex msdata=sdata
13180 Put small global and static data in the small data area, but do not
13181 generate special code to reference them.
13182
13183 @item -msdata=use
13184 @opindex msdata=use
13185 Put small global and static data in the small data area, and generate
13186 special instructions to reference them.
13187
13188 @item -G @var{num}
13189 @opindex G
13190 @cindex smaller data references
13191 Put global and static objects less than or equal to @var{num} bytes
13192 into the small data or bss sections instead of the normal data or bss
13193 sections. The default value of @var{num} is 8.
13194 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
13195 for this option to have any effect.
13196
13197 All modules should be compiled with the same @option{-G @var{num}} value.
13198 Compiling with different values of @var{num} may or may not work; if it
13199 doesn't the linker will give an error message---incorrect code will not be
13200 generated.
13201
13202 @item -mdebug
13203 @opindex mdebug
13204 Makes the M32R specific code in the compiler display some statistics
13205 that might help in debugging programs.
13206
13207 @item -malign-loops
13208 @opindex malign-loops
13209 Align all loops to a 32-byte boundary.
13210
13211 @item -mno-align-loops
13212 @opindex mno-align-loops
13213 Do not enforce a 32-byte alignment for loops. This is the default.
13214
13215 @item -missue-rate=@var{number}
13216 @opindex missue-rate=@var{number}
13217 Issue @var{number} instructions per cycle. @var{number} can only be 1
13218 or 2.
13219
13220 @item -mbranch-cost=@var{number}
13221 @opindex mbranch-cost=@var{number}
13222 @var{number} can only be 1 or 2. If it is 1 then branches will be
13223 preferred over conditional code, if it is 2, then the opposite will
13224 apply.
13225
13226 @item -mflush-trap=@var{number}
13227 @opindex mflush-trap=@var{number}
13228 Specifies the trap number to use to flush the cache. The default is
13229 12. Valid numbers are between 0 and 15 inclusive.
13230
13231 @item -mno-flush-trap
13232 @opindex mno-flush-trap
13233 Specifies that the cache cannot be flushed by using a trap.
13234
13235 @item -mflush-func=@var{name}
13236 @opindex mflush-func=@var{name}
13237 Specifies the name of the operating system function to call to flush
13238 the cache. The default is @emph{_flush_cache}, but a function call
13239 will only be used if a trap is not available.
13240
13241 @item -mno-flush-func
13242 @opindex mno-flush-func
13243 Indicates that there is no OS function for flushing the cache.
13244
13245 @end table
13246
13247 @node M680x0 Options
13248 @subsection M680x0 Options
13249 @cindex M680x0 options
13250
13251 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
13252 The default settings depend on which architecture was selected when
13253 the compiler was configured; the defaults for the most common choices
13254 are given below.
13255
13256 @table @gcctabopt
13257 @item -march=@var{arch}
13258 @opindex march
13259 Generate code for a specific M680x0 or ColdFire instruction set
13260 architecture. Permissible values of @var{arch} for M680x0
13261 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
13262 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire
13263 architectures are selected according to Freescale's ISA classification
13264 and the permissible values are: @samp{isaa}, @samp{isaaplus},
13265 @samp{isab} and @samp{isac}.
13266
13267 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
13268 code for a ColdFire target. The @var{arch} in this macro is one of the
13269 @option{-march} arguments given above.
13270
13271 When used together, @option{-march} and @option{-mtune} select code
13272 that runs on a family of similar processors but that is optimized
13273 for a particular microarchitecture.
13274
13275 @item -mcpu=@var{cpu}
13276 @opindex mcpu
13277 Generate code for a specific M680x0 or ColdFire processor.
13278 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
13279 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
13280 and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table
13281 below, which also classifies the CPUs into families:
13282
13283 @multitable @columnfractions 0.20 0.80
13284 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
13285 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
13286 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
13287 @item @samp{5206e} @tab @samp{5206e}
13288 @item @samp{5208} @tab @samp{5207} @samp{5208}
13289 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
13290 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
13291 @item @samp{5216} @tab @samp{5214} @samp{5216}
13292 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
13293 @item @samp{5225} @tab @samp{5224} @samp{5225}
13294 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
13295 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
13296 @item @samp{5249} @tab @samp{5249}
13297 @item @samp{5250} @tab @samp{5250}
13298 @item @samp{5271} @tab @samp{5270} @samp{5271}
13299 @item @samp{5272} @tab @samp{5272}
13300 @item @samp{5275} @tab @samp{5274} @samp{5275}
13301 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
13302 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
13303 @item @samp{5307} @tab @samp{5307}
13304 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
13305 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
13306 @item @samp{5407} @tab @samp{5407}
13307 @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}
13308 @end multitable
13309
13310 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
13311 @var{arch} is compatible with @var{cpu}. Other combinations of
13312 @option{-mcpu} and @option{-march} are rejected.
13313
13314 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
13315 @var{cpu} is selected. It also defines @samp{__mcf_family_@var{family}},
13316 where the value of @var{family} is given by the table above.
13317
13318 @item -mtune=@var{tune}
13319 @opindex mtune
13320 Tune the code for a particular microarchitecture, within the
13321 constraints set by @option{-march} and @option{-mcpu}.
13322 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
13323 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
13324 and @samp{cpu32}. The ColdFire microarchitectures
13325 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
13326
13327 You can also use @option{-mtune=68020-40} for code that needs
13328 to run relatively well on 68020, 68030 and 68040 targets.
13329 @option{-mtune=68020-60} is similar but includes 68060 targets
13330 as well. These two options select the same tuning decisions as
13331 @option{-m68020-40} and @option{-m68020-60} respectively.
13332
13333 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
13334 when tuning for 680x0 architecture @var{arch}. It also defines
13335 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
13336 option is used. If gcc is tuning for a range of architectures,
13337 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
13338 it defines the macros for every architecture in the range.
13339
13340 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
13341 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
13342 of the arguments given above.
13343
13344 @item -m68000
13345 @itemx -mc68000
13346 @opindex m68000
13347 @opindex mc68000
13348 Generate output for a 68000. This is the default
13349 when the compiler is configured for 68000-based systems.
13350 It is equivalent to @option{-march=68000}.
13351
13352 Use this option for microcontrollers with a 68000 or EC000 core,
13353 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
13354
13355 @item -m68010
13356 @opindex m68010
13357 Generate output for a 68010. This is the default
13358 when the compiler is configured for 68010-based systems.
13359 It is equivalent to @option{-march=68010}.
13360
13361 @item -m68020
13362 @itemx -mc68020
13363 @opindex m68020
13364 @opindex mc68020
13365 Generate output for a 68020. This is the default
13366 when the compiler is configured for 68020-based systems.
13367 It is equivalent to @option{-march=68020}.
13368
13369 @item -m68030
13370 @opindex m68030
13371 Generate output for a 68030. This is the default when the compiler is
13372 configured for 68030-based systems. It is equivalent to
13373 @option{-march=68030}.
13374
13375 @item -m68040
13376 @opindex m68040
13377 Generate output for a 68040. This is the default when the compiler is
13378 configured for 68040-based systems. It is equivalent to
13379 @option{-march=68040}.
13380
13381 This option inhibits the use of 68881/68882 instructions that have to be
13382 emulated by software on the 68040. Use this option if your 68040 does not
13383 have code to emulate those instructions.
13384
13385 @item -m68060
13386 @opindex m68060
13387 Generate output for a 68060. This is the default when the compiler is
13388 configured for 68060-based systems. It is equivalent to
13389 @option{-march=68060}.
13390
13391 This option inhibits the use of 68020 and 68881/68882 instructions that
13392 have to be emulated by software on the 68060. Use this option if your 68060
13393 does not have code to emulate those instructions.
13394
13395 @item -mcpu32
13396 @opindex mcpu32
13397 Generate output for a CPU32. This is the default
13398 when the compiler is configured for CPU32-based systems.
13399 It is equivalent to @option{-march=cpu32}.
13400
13401 Use this option for microcontrollers with a
13402 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13403 68336, 68340, 68341, 68349 and 68360.
13404
13405 @item -m5200
13406 @opindex m5200
13407 Generate output for a 520X ColdFire CPU@. This is the default
13408 when the compiler is configured for 520X-based systems.
13409 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13410 in favor of that option.
13411
13412 Use this option for microcontroller with a 5200 core, including
13413 the MCF5202, MCF5203, MCF5204 and MCF5206.
13414
13415 @item -m5206e
13416 @opindex m5206e
13417 Generate output for a 5206e ColdFire CPU@. The option is now
13418 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13419
13420 @item -m528x
13421 @opindex m528x
13422 Generate output for a member of the ColdFire 528X family.
13423 The option is now deprecated in favor of the equivalent
13424 @option{-mcpu=528x}.
13425
13426 @item -m5307
13427 @opindex m5307
13428 Generate output for a ColdFire 5307 CPU@. The option is now deprecated
13429 in favor of the equivalent @option{-mcpu=5307}.
13430
13431 @item -m5407
13432 @opindex m5407
13433 Generate output for a ColdFire 5407 CPU@. The option is now deprecated
13434 in favor of the equivalent @option{-mcpu=5407}.
13435
13436 @item -mcfv4e
13437 @opindex mcfv4e
13438 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13439 This includes use of hardware floating point instructions.
13440 The option is equivalent to @option{-mcpu=547x}, and is now
13441 deprecated in favor of that option.
13442
13443 @item -m68020-40
13444 @opindex m68020-40
13445 Generate output for a 68040, without using any of the new instructions.
13446 This results in code which can run relatively efficiently on either a
13447 68020/68881 or a 68030 or a 68040. The generated code does use the
13448 68881 instructions that are emulated on the 68040.
13449
13450 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13451
13452 @item -m68020-60
13453 @opindex m68020-60
13454 Generate output for a 68060, without using any of the new instructions.
13455 This results in code which can run relatively efficiently on either a
13456 68020/68881 or a 68030 or a 68040. The generated code does use the
13457 68881 instructions that are emulated on the 68060.
13458
13459 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13460
13461 @item -mhard-float
13462 @itemx -m68881
13463 @opindex mhard-float
13464 @opindex m68881
13465 Generate floating-point instructions. This is the default for 68020
13466 and above, and for ColdFire devices that have an FPU@. It defines the
13467 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13468 on ColdFire targets.
13469
13470 @item -msoft-float
13471 @opindex msoft-float
13472 Do not generate floating-point instructions; use library calls instead.
13473 This is the default for 68000, 68010, and 68832 targets. It is also
13474 the default for ColdFire devices that have no FPU.
13475
13476 @item -mdiv
13477 @itemx -mno-div
13478 @opindex mdiv
13479 @opindex mno-div
13480 Generate (do not generate) ColdFire hardware divide and remainder
13481 instructions. If @option{-march} is used without @option{-mcpu},
13482 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13483 architectures. Otherwise, the default is taken from the target CPU
13484 (either the default CPU, or the one specified by @option{-mcpu}). For
13485 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13486 @option{-mcpu=5206e}.
13487
13488 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13489
13490 @item -mshort
13491 @opindex mshort
13492 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13493 Additionally, parameters passed on the stack are also aligned to a
13494 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13495
13496 @item -mno-short
13497 @opindex mno-short
13498 Do not consider type @code{int} to be 16 bits wide. This is the default.
13499
13500 @item -mnobitfield
13501 @itemx -mno-bitfield
13502 @opindex mnobitfield
13503 @opindex mno-bitfield
13504 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
13505 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13506
13507 @item -mbitfield
13508 @opindex mbitfield
13509 Do use the bit-field instructions. The @option{-m68020} option implies
13510 @option{-mbitfield}. This is the default if you use a configuration
13511 designed for a 68020.
13512
13513 @item -mrtd
13514 @opindex mrtd
13515 Use a different function-calling convention, in which functions
13516 that take a fixed number of arguments return with the @code{rtd}
13517 instruction, which pops their arguments while returning. This
13518 saves one instruction in the caller since there is no need to pop
13519 the arguments there.
13520
13521 This calling convention is incompatible with the one normally
13522 used on Unix, so you cannot use it if you need to call libraries
13523 compiled with the Unix compiler.
13524
13525 Also, you must provide function prototypes for all functions that
13526 take variable numbers of arguments (including @code{printf});
13527 otherwise incorrect code will be generated for calls to those
13528 functions.
13529
13530 In addition, seriously incorrect code will result if you call a
13531 function with too many arguments. (Normally, extra arguments are
13532 harmlessly ignored.)
13533
13534 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13535 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13536
13537 @item -mno-rtd
13538 @opindex mno-rtd
13539 Do not use the calling conventions selected by @option{-mrtd}.
13540 This is the default.
13541
13542 @item -malign-int
13543 @itemx -mno-align-int
13544 @opindex malign-int
13545 @opindex mno-align-int
13546 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13547 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13548 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13549 Aligning variables on 32-bit boundaries produces code that runs somewhat
13550 faster on processors with 32-bit busses at the expense of more memory.
13551
13552 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13553 align structures containing the above types differently than
13554 most published application binary interface specifications for the m68k.
13555
13556 @item -mpcrel
13557 @opindex mpcrel
13558 Use the pc-relative addressing mode of the 68000 directly, instead of
13559 using a global offset table. At present, this option implies @option{-fpic},
13560 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
13561 not presently supported with @option{-mpcrel}, though this could be supported for
13562 68020 and higher processors.
13563
13564 @item -mno-strict-align
13565 @itemx -mstrict-align
13566 @opindex mno-strict-align
13567 @opindex mstrict-align
13568 Do not (do) assume that unaligned memory references will be handled by
13569 the system.
13570
13571 @item -msep-data
13572 Generate code that allows the data segment to be located in a different
13573 area of memory from the text segment. This allows for execute in place in
13574 an environment without virtual memory management. This option implies
13575 @option{-fPIC}.
13576
13577 @item -mno-sep-data
13578 Generate code that assumes that the data segment follows the text segment.
13579 This is the default.
13580
13581 @item -mid-shared-library
13582 Generate code that supports shared libraries via the library ID method.
13583 This allows for execute in place and shared libraries in an environment
13584 without virtual memory management. This option implies @option{-fPIC}.
13585
13586 @item -mno-id-shared-library
13587 Generate code that doesn't assume ID based shared libraries are being used.
13588 This is the default.
13589
13590 @item -mshared-library-id=n
13591 Specified the identification number of the ID based shared library being
13592 compiled. Specifying a value of 0 will generate more compact code, specifying
13593 other values will force the allocation of that number to the current
13594 library but is no more space or time efficient than omitting this option.
13595
13596 @item -mxgot
13597 @itemx -mno-xgot
13598 @opindex mxgot
13599 @opindex mno-xgot
13600 When generating position-independent code for ColdFire, generate code
13601 that works if the GOT has more than 8192 entries. This code is
13602 larger and slower than code generated without this option. On M680x0
13603 processors, this option is not needed; @option{-fPIC} suffices.
13604
13605 GCC normally uses a single instruction to load values from the GOT@.
13606 While this is relatively efficient, it only works if the GOT
13607 is smaller than about 64k. Anything larger causes the linker
13608 to report an error such as:
13609
13610 @cindex relocation truncated to fit (ColdFire)
13611 @smallexample
13612 relocation truncated to fit: R_68K_GOT16O foobar
13613 @end smallexample
13614
13615 If this happens, you should recompile your code with @option{-mxgot}.
13616 It should then work with very large GOTs. However, code generated with
13617 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13618 the value of a global symbol.
13619
13620 Note that some linkers, including newer versions of the GNU linker,
13621 can create multiple GOTs and sort GOT entries. If you have such a linker,
13622 you should only need to use @option{-mxgot} when compiling a single
13623 object file that accesses more than 8192 GOT entries. Very few do.
13624
13625 These options have no effect unless GCC is generating
13626 position-independent code.
13627
13628 @end table
13629
13630 @node M68hc1x Options
13631 @subsection M68hc1x Options
13632 @cindex M68hc1x options
13633
13634 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13635 microcontrollers. The default values for these options depends on
13636 which style of microcontroller was selected when the compiler was configured;
13637 the defaults for the most common choices are given below.
13638
13639 @table @gcctabopt
13640 @item -m6811
13641 @itemx -m68hc11
13642 @opindex m6811
13643 @opindex m68hc11
13644 Generate output for a 68HC11. This is the default
13645 when the compiler is configured for 68HC11-based systems.
13646
13647 @item -m6812
13648 @itemx -m68hc12
13649 @opindex m6812
13650 @opindex m68hc12
13651 Generate output for a 68HC12. This is the default
13652 when the compiler is configured for 68HC12-based systems.
13653
13654 @item -m68S12
13655 @itemx -m68hcs12
13656 @opindex m68S12
13657 @opindex m68hcs12
13658 Generate output for a 68HCS12.
13659
13660 @item -mauto-incdec
13661 @opindex mauto-incdec
13662 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13663 addressing modes.
13664
13665 @item -minmax
13666 @itemx -mnominmax
13667 @opindex minmax
13668 @opindex mnominmax
13669 Enable the use of 68HC12 min and max instructions.
13670
13671 @item -mlong-calls
13672 @itemx -mno-long-calls
13673 @opindex mlong-calls
13674 @opindex mno-long-calls
13675 Treat all calls as being far away (near). If calls are assumed to be
13676 far away, the compiler will use the @code{call} instruction to
13677 call a function and the @code{rtc} instruction for returning.
13678
13679 @item -mshort
13680 @opindex mshort
13681 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13682
13683 @item -msoft-reg-count=@var{count}
13684 @opindex msoft-reg-count
13685 Specify the number of pseudo-soft registers which are used for the
13686 code generation. The maximum number is 32. Using more pseudo-soft
13687 register may or may not result in better code depending on the program.
13688 The default is 4 for 68HC11 and 2 for 68HC12.
13689
13690 @end table
13691
13692 @node MCore Options
13693 @subsection MCore Options
13694 @cindex MCore options
13695
13696 These are the @samp{-m} options defined for the Motorola M*Core
13697 processors.
13698
13699 @table @gcctabopt
13700
13701 @item -mhardlit
13702 @itemx -mno-hardlit
13703 @opindex mhardlit
13704 @opindex mno-hardlit
13705 Inline constants into the code stream if it can be done in two
13706 instructions or less.
13707
13708 @item -mdiv
13709 @itemx -mno-div
13710 @opindex mdiv
13711 @opindex mno-div
13712 Use the divide instruction. (Enabled by default).
13713
13714 @item -mrelax-immediate
13715 @itemx -mno-relax-immediate
13716 @opindex mrelax-immediate
13717 @opindex mno-relax-immediate
13718 Allow arbitrary sized immediates in bit operations.
13719
13720 @item -mwide-bitfields
13721 @itemx -mno-wide-bitfields
13722 @opindex mwide-bitfields
13723 @opindex mno-wide-bitfields
13724 Always treat bit-fields as int-sized.
13725
13726 @item -m4byte-functions
13727 @itemx -mno-4byte-functions
13728 @opindex m4byte-functions
13729 @opindex mno-4byte-functions
13730 Force all functions to be aligned to a four byte boundary.
13731
13732 @item -mcallgraph-data
13733 @itemx -mno-callgraph-data
13734 @opindex mcallgraph-data
13735 @opindex mno-callgraph-data
13736 Emit callgraph information.
13737
13738 @item -mslow-bytes
13739 @itemx -mno-slow-bytes
13740 @opindex mslow-bytes
13741 @opindex mno-slow-bytes
13742 Prefer word access when reading byte quantities.
13743
13744 @item -mlittle-endian
13745 @itemx -mbig-endian
13746 @opindex mlittle-endian
13747 @opindex mbig-endian
13748 Generate code for a little endian target.
13749
13750 @item -m210
13751 @itemx -m340
13752 @opindex m210
13753 @opindex m340
13754 Generate code for the 210 processor.
13755
13756 @item -mno-lsim
13757 @opindex mno-lsim
13758 Assume that run-time support has been provided and so omit the
13759 simulator library (@file{libsim.a)} from the linker command line.
13760
13761 @item -mstack-increment=@var{size}
13762 @opindex mstack-increment
13763 Set the maximum amount for a single stack increment operation. Large
13764 values can increase the speed of programs which contain functions
13765 that need a large amount of stack space, but they can also trigger a
13766 segmentation fault if the stack is extended too much. The default
13767 value is 0x1000.
13768
13769 @end table
13770
13771 @node MeP Options
13772 @subsection MeP Options
13773 @cindex MeP options
13774
13775 @table @gcctabopt
13776
13777 @item -mabsdiff
13778 @opindex mabsdiff
13779 Enables the @code{abs} instruction, which is the absolute difference
13780 between two registers.
13781
13782 @item -mall-opts
13783 @opindex mall-opts
13784 Enables all the optional instructions - average, multiply, divide, bit
13785 operations, leading zero, absolute difference, min/max, clip, and
13786 saturation.
13787
13788
13789 @item -maverage
13790 @opindex maverage
13791 Enables the @code{ave} instruction, which computes the average of two
13792 registers.
13793
13794 @item -mbased=@var{n}
13795 @opindex mbased=
13796 Variables of size @var{n} bytes or smaller will be placed in the
13797 @code{.based} section by default. Based variables use the @code{$tp}
13798 register as a base register, and there is a 128 byte limit to the
13799 @code{.based} section.
13800
13801 @item -mbitops
13802 @opindex mbitops
13803 Enables the bit operation instructions - bit test (@code{btstm}), set
13804 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13805 test-and-set (@code{tas}).
13806
13807 @item -mc=@var{name}
13808 @opindex mc=
13809 Selects which section constant data will be placed in. @var{name} may
13810 be @code{tiny}, @code{near}, or @code{far}.
13811
13812 @item -mclip
13813 @opindex mclip
13814 Enables the @code{clip} instruction. Note that @code{-mclip} is not
13815 useful unless you also provide @code{-mminmax}.
13816
13817 @item -mconfig=@var{name}
13818 @opindex mconfig=
13819 Selects one of the build-in core configurations. Each MeP chip has
13820 one or more modules in it; each module has a core CPU and a variety of
13821 coprocessors, optional instructions, and peripherals. The
13822 @code{MeP-Integrator} tool, not part of GCC, provides these
13823 configurations through this option; using this option is the same as
13824 using all the corresponding command line options. The default
13825 configuration is @code{default}.
13826
13827 @item -mcop
13828 @opindex mcop
13829 Enables the coprocessor instructions. By default, this is a 32-bit
13830 coprocessor. Note that the coprocessor is normally enabled via the
13831 @code{-mconfig=} option.
13832
13833 @item -mcop32
13834 @opindex mcop32
13835 Enables the 32-bit coprocessor's instructions.
13836
13837 @item -mcop64
13838 @opindex mcop64
13839 Enables the 64-bit coprocessor's instructions.
13840
13841 @item -mivc2
13842 @opindex mivc2
13843 Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor.
13844
13845 @item -mdc
13846 @opindex mdc
13847 Causes constant variables to be placed in the @code{.near} section.
13848
13849 @item -mdiv
13850 @opindex mdiv
13851 Enables the @code{div} and @code{divu} instructions.
13852
13853 @item -meb
13854 @opindex meb
13855 Generate big-endian code.
13856
13857 @item -mel
13858 @opindex mel
13859 Generate little-endian code.
13860
13861 @item -mio-volatile
13862 @opindex mio-volatile
13863 Tells the compiler that any variable marked with the @code{io}
13864 attribute is to be considered volatile.
13865
13866 @item -ml
13867 @opindex ml
13868 Causes variables to be assigned to the @code{.far} section by default.
13869
13870 @item -mleadz
13871 @opindex mleadz
13872 Enables the @code{leadz} (leading zero) instruction.
13873
13874 @item -mm
13875 @opindex mm
13876 Causes variables to be assigned to the @code{.near} section by default.
13877
13878 @item -mminmax
13879 @opindex mminmax
13880 Enables the @code{min} and @code{max} instructions.
13881
13882 @item -mmult
13883 @opindex mmult
13884 Enables the multiplication and multiply-accumulate instructions.
13885
13886 @item -mno-opts
13887 @opindex mno-opts
13888 Disables all the optional instructions enabled by @code{-mall-opts}.
13889
13890 @item -mrepeat
13891 @opindex mrepeat
13892 Enables the @code{repeat} and @code{erepeat} instructions, used for
13893 low-overhead looping.
13894
13895 @item -ms
13896 @opindex ms
13897 Causes all variables to default to the @code{.tiny} section. Note
13898 that there is a 65536 byte limit to this section. Accesses to these
13899 variables use the @code{%gp} base register.
13900
13901 @item -msatur
13902 @opindex msatur
13903 Enables the saturation instructions. Note that the compiler does not
13904 currently generate these itself, but this option is included for
13905 compatibility with other tools, like @code{as}.
13906
13907 @item -msdram
13908 @opindex msdram
13909 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13910
13911 @item -msim
13912 @opindex msim
13913 Link the simulator runtime libraries.
13914
13915 @item -msimnovec
13916 @opindex msimnovec
13917 Link the simulator runtime libraries, excluding built-in support
13918 for reset and exception vectors and tables.
13919
13920 @item -mtf
13921 @opindex mtf
13922 Causes all functions to default to the @code{.far} section. Without
13923 this option, functions default to the @code{.near} section.
13924
13925 @item -mtiny=@var{n}
13926 @opindex mtiny=
13927 Variables that are @var{n} bytes or smaller will be allocated to the
13928 @code{.tiny} section. These variables use the @code{$gp} base
13929 register. The default for this option is 4, but note that there's a
13930 65536 byte limit to the @code{.tiny} section.
13931
13932 @end table
13933
13934 @node MicroBlaze Options
13935 @subsection MicroBlaze Options
13936 @cindex MicroBlaze Options
13937
13938 @table @gcctabopt
13939
13940 @item -msoft-float
13941 @opindex msoft-float
13942 Use software emulation for floating point (default).
13943
13944 @item -mhard-float
13945 @opindex mhard-float
13946 Use hardware floating point instructions.
13947
13948 @item -mmemcpy
13949 @opindex mmemcpy
13950 Do not optimize block moves, use @code{memcpy}.
13951
13952 @item -mno-clearbss
13953 @opindex mno-clearbss
13954 This option is deprecated. Use @option{-fno-zero-initialized-in-bss} instead.
13955
13956 @item -mcpu=@var{cpu-type}
13957 @opindex mcpu=
13958 Use features of and schedule code for given CPU.
13959 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
13960 where @var{X} is a major version, @var{YY} is the minor version, and
13961 @var{Z} is compatibility code. Example values are @samp{v3.00.a},
13962 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
13963
13964 @item -mxl-soft-mul
13965 @opindex mxl-soft-mul
13966 Use software multiply emulation (default).
13967
13968 @item -mxl-soft-div
13969 @opindex mxl-soft-div
13970 Use software emulation for divides (default).
13971
13972 @item -mxl-barrel-shift
13973 @opindex mxl-barrel-shift
13974 Use the hardware barrel shifter.
13975
13976 @item -mxl-pattern-compare
13977 @opindex mxl-pattern-compare
13978 Use pattern compare instructions.
13979
13980 @item -msmall-divides
13981 @opindex msmall-divides
13982 Use table lookup optimization for small signed integer divisions.
13983
13984 @item -mxl-stack-check
13985 @opindex mxl-stack-check
13986 This option is deprecated. Use -fstack-check instead.
13987
13988 @item -mxl-gp-opt
13989 @opindex mxl-gp-opt
13990 Use GP relative sdata/sbss sections.
13991
13992 @item -mxl-multiply-high
13993 @opindex mxl-multiply-high
13994 Use multiply high instructions for high part of 32x32 multiply.
13995
13996 @item -mxl-float-convert
13997 @opindex mxl-float-convert
13998 Use hardware floating point conversion instructions.
13999
14000 @item -mxl-float-sqrt
14001 @opindex mxl-float-sqrt
14002 Use hardware floating point square root instruction.
14003
14004 @item -mxl-mode-@var{app-model}
14005 Select application model @var{app-model}. Valid models are
14006 @table @samp
14007 @item executable
14008 normal executable (default), uses startup code @file{crt0.o}.
14009
14010 @item xmdstub
14011 for use with Xilinx Microprocessor Debugger (XMD) based
14012 software intrusive debug agent called xmdstub. This uses startup file
14013 @file{crt1.o} and sets the start address of the program to be 0x800.
14014
14015 @item bootstrap
14016 for applications that are loaded using a bootloader.
14017 This model uses startup file @file{crt2.o} which does not contain a processor
14018 reset vector handler. This is suitable for transferring control on a
14019 processor reset to the bootloader rather than the application.
14020
14021 @item novectors
14022 for applications that do not require any of the
14023 MicroBlaze vectors. This option may be useful for applications running
14024 within a monitoring application. This model uses @file{crt3.o} as a startup file.
14025 @end table
14026
14027 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
14028 @option{-mxl-mode-@var{app-model}}.
14029
14030 @end table
14031
14032 @node MIPS Options
14033 @subsection MIPS Options
14034 @cindex MIPS options
14035
14036 @table @gcctabopt
14037
14038 @item -EB
14039 @opindex EB
14040 Generate big-endian code.
14041
14042 @item -EL
14043 @opindex EL
14044 Generate little-endian code. This is the default for @samp{mips*el-*-*}
14045 configurations.
14046
14047 @item -march=@var{arch}
14048 @opindex march
14049 Generate code that will run on @var{arch}, which can be the name of a
14050 generic MIPS ISA, or the name of a particular processor.
14051 The ISA names are:
14052 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
14053 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
14054 The processor names are:
14055 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
14056 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
14057 @samp{5kc}, @samp{5kf},
14058 @samp{20kc},
14059 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
14060 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
14061 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
14062 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
14063 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
14064 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
14065 @samp{m4k},
14066 @samp{octeon},
14067 @samp{orion},
14068 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
14069 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
14070 @samp{rm7000}, @samp{rm9000},
14071 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
14072 @samp{sb1},
14073 @samp{sr71000},
14074 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
14075 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
14076 and @samp{xlr}.
14077 The special value @samp{from-abi} selects the
14078 most compatible architecture for the selected ABI (that is,
14079 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
14080
14081 Native Linux/GNU toolchains also support the value @samp{native},
14082 which selects the best architecture option for the host processor.
14083 @option{-march=native} has no effect if GCC does not recognize
14084 the processor.
14085
14086 In processor names, a final @samp{000} can be abbreviated as @samp{k}
14087 (for example, @samp{-march=r2k}). Prefixes are optional, and
14088 @samp{vr} may be written @samp{r}.
14089
14090 Names of the form @samp{@var{n}f2_1} refer to processors with
14091 FPUs clocked at half the rate of the core, names of the form
14092 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
14093 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
14094 processors with FPUs clocked a ratio of 3:2 with respect to the core.
14095 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
14096 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
14097 accepted as synonyms for @samp{@var{n}f1_1}.
14098
14099 GCC defines two macros based on the value of this option. The first
14100 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
14101 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
14102 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
14103 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
14104 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
14105
14106 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
14107 above. In other words, it will have the full prefix and will not
14108 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
14109 the macro names the resolved architecture (either @samp{"mips1"} or
14110 @samp{"mips3"}). It names the default architecture when no
14111 @option{-march} option is given.
14112
14113 @item -mtune=@var{arch}
14114 @opindex mtune
14115 Optimize for @var{arch}. Among other things, this option controls
14116 the way instructions are scheduled, and the perceived cost of arithmetic
14117 operations. The list of @var{arch} values is the same as for
14118 @option{-march}.
14119
14120 When this option is not used, GCC will optimize for the processor
14121 specified by @option{-march}. By using @option{-march} and
14122 @option{-mtune} together, it is possible to generate code that will
14123 run on a family of processors, but optimize the code for one
14124 particular member of that family.
14125
14126 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
14127 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
14128 @samp{-march} ones described above.
14129
14130 @item -mips1
14131 @opindex mips1
14132 Equivalent to @samp{-march=mips1}.
14133
14134 @item -mips2
14135 @opindex mips2
14136 Equivalent to @samp{-march=mips2}.
14137
14138 @item -mips3
14139 @opindex mips3
14140 Equivalent to @samp{-march=mips3}.
14141
14142 @item -mips4
14143 @opindex mips4
14144 Equivalent to @samp{-march=mips4}.
14145
14146 @item -mips32
14147 @opindex mips32
14148 Equivalent to @samp{-march=mips32}.
14149
14150 @item -mips32r2
14151 @opindex mips32r2
14152 Equivalent to @samp{-march=mips32r2}.
14153
14154 @item -mips64
14155 @opindex mips64
14156 Equivalent to @samp{-march=mips64}.
14157
14158 @item -mips64r2
14159 @opindex mips64r2
14160 Equivalent to @samp{-march=mips64r2}.
14161
14162 @item -mips16
14163 @itemx -mno-mips16
14164 @opindex mips16
14165 @opindex mno-mips16
14166 Generate (do not generate) MIPS16 code. If GCC is targetting a
14167 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
14168
14169 MIPS16 code generation can also be controlled on a per-function basis
14170 by means of @code{mips16} and @code{nomips16} attributes.
14171 @xref{Function Attributes}, for more information.
14172
14173 @item -mflip-mips16
14174 @opindex mflip-mips16
14175 Generate MIPS16 code on alternating functions. This option is provided
14176 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
14177 not intended for ordinary use in compiling user code.
14178
14179 @item -minterlink-mips16
14180 @itemx -mno-interlink-mips16
14181 @opindex minterlink-mips16
14182 @opindex mno-interlink-mips16
14183 Require (do not require) that non-MIPS16 code be link-compatible with
14184 MIPS16 code.
14185
14186 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
14187 it must either use a call or an indirect jump. @option{-minterlink-mips16}
14188 therefore disables direct jumps unless GCC knows that the target of the
14189 jump is not MIPS16.
14190
14191 @item -mabi=32
14192 @itemx -mabi=o64
14193 @itemx -mabi=n32
14194 @itemx -mabi=64
14195 @itemx -mabi=eabi
14196 @opindex mabi=32
14197 @opindex mabi=o64
14198 @opindex mabi=n32
14199 @opindex mabi=64
14200 @opindex mabi=eabi
14201 Generate code for the given ABI@.
14202
14203 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
14204 generates 64-bit code when you select a 64-bit architecture, but you
14205 can use @option{-mgp32} to get 32-bit code instead.
14206
14207 For information about the O64 ABI, see
14208 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
14209
14210 GCC supports a variant of the o32 ABI in which floating-point registers
14211 are 64 rather than 32 bits wide. You can select this combination with
14212 @option{-mabi=32} @option{-mfp64}. This ABI relies on the @samp{mthc1}
14213 and @samp{mfhc1} instructions and is therefore only supported for
14214 MIPS32R2 processors.
14215
14216 The register assignments for arguments and return values remain the
14217 same, but each scalar value is passed in a single 64-bit register
14218 rather than a pair of 32-bit registers. For example, scalar
14219 floating-point values are returned in @samp{$f0} only, not a
14220 @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also
14221 remains the same, but all 64 bits are saved.
14222
14223 @item -mabicalls
14224 @itemx -mno-abicalls
14225 @opindex mabicalls
14226 @opindex mno-abicalls
14227 Generate (do not generate) code that is suitable for SVR4-style
14228 dynamic objects. @option{-mabicalls} is the default for SVR4-based
14229 systems.
14230
14231 @item -mshared
14232 @itemx -mno-shared
14233 Generate (do not generate) code that is fully position-independent,
14234 and that can therefore be linked into shared libraries. This option
14235 only affects @option{-mabicalls}.
14236
14237 All @option{-mabicalls} code has traditionally been position-independent,
14238 regardless of options like @option{-fPIC} and @option{-fpic}. However,
14239 as an extension, the GNU toolchain allows executables to use absolute
14240 accesses for locally-binding symbols. It can also use shorter GP
14241 initialization sequences and generate direct calls to locally-defined
14242 functions. This mode is selected by @option{-mno-shared}.
14243
14244 @option{-mno-shared} depends on binutils 2.16 or higher and generates
14245 objects that can only be linked by the GNU linker. However, the option
14246 does not affect the ABI of the final executable; it only affects the ABI
14247 of relocatable objects. Using @option{-mno-shared} will generally make
14248 executables both smaller and quicker.
14249
14250 @option{-mshared} is the default.
14251
14252 @item -mplt
14253 @itemx -mno-plt
14254 @opindex mplt
14255 @opindex mno-plt
14256 Assume (do not assume) that the static and dynamic linkers
14257 support PLTs and copy relocations. This option only affects
14258 @samp{-mno-shared -mabicalls}. For the n64 ABI, this option
14259 has no effect without @samp{-msym32}.
14260
14261 You can make @option{-mplt} the default by configuring
14262 GCC with @option{--with-mips-plt}. The default is
14263 @option{-mno-plt} otherwise.
14264
14265 @item -mxgot
14266 @itemx -mno-xgot
14267 @opindex mxgot
14268 @opindex mno-xgot
14269 Lift (do not lift) the usual restrictions on the size of the global
14270 offset table.
14271
14272 GCC normally uses a single instruction to load values from the GOT@.
14273 While this is relatively efficient, it will only work if the GOT
14274 is smaller than about 64k. Anything larger will cause the linker
14275 to report an error such as:
14276
14277 @cindex relocation truncated to fit (MIPS)
14278 @smallexample
14279 relocation truncated to fit: R_MIPS_GOT16 foobar
14280 @end smallexample
14281
14282 If this happens, you should recompile your code with @option{-mxgot}.
14283 It should then work with very large GOTs, although it will also be
14284 less efficient, since it will take three instructions to fetch the
14285 value of a global symbol.
14286
14287 Note that some linkers can create multiple GOTs. If you have such a
14288 linker, you should only need to use @option{-mxgot} when a single object
14289 file accesses more than 64k's worth of GOT entries. Very few do.
14290
14291 These options have no effect unless GCC is generating position
14292 independent code.
14293
14294 @item -mgp32
14295 @opindex mgp32
14296 Assume that general-purpose registers are 32 bits wide.
14297
14298 @item -mgp64
14299 @opindex mgp64
14300 Assume that general-purpose registers are 64 bits wide.
14301
14302 @item -mfp32
14303 @opindex mfp32
14304 Assume that floating-point registers are 32 bits wide.
14305
14306 @item -mfp64
14307 @opindex mfp64
14308 Assume that floating-point registers are 64 bits wide.
14309
14310 @item -mhard-float
14311 @opindex mhard-float
14312 Use floating-point coprocessor instructions.
14313
14314 @item -msoft-float
14315 @opindex msoft-float
14316 Do not use floating-point coprocessor instructions. Implement
14317 floating-point calculations using library calls instead.
14318
14319 @item -msingle-float
14320 @opindex msingle-float
14321 Assume that the floating-point coprocessor only supports single-precision
14322 operations.
14323
14324 @item -mdouble-float
14325 @opindex mdouble-float
14326 Assume that the floating-point coprocessor supports double-precision
14327 operations. This is the default.
14328
14329 @item -mllsc
14330 @itemx -mno-llsc
14331 @opindex mllsc
14332 @opindex mno-llsc
14333 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
14334 implement atomic memory built-in functions. When neither option is
14335 specified, GCC will use the instructions if the target architecture
14336 supports them.
14337
14338 @option{-mllsc} is useful if the runtime environment can emulate the
14339 instructions and @option{-mno-llsc} can be useful when compiling for
14340 nonstandard ISAs. You can make either option the default by
14341 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
14342 respectively. @option{--with-llsc} is the default for some
14343 configurations; see the installation documentation for details.
14344
14345 @item -mdsp
14346 @itemx -mno-dsp
14347 @opindex mdsp
14348 @opindex mno-dsp
14349 Use (do not use) revision 1 of the MIPS DSP ASE@.
14350 @xref{MIPS DSP Built-in Functions}. This option defines the
14351 preprocessor macro @samp{__mips_dsp}. It also defines
14352 @samp{__mips_dsp_rev} to 1.
14353
14354 @item -mdspr2
14355 @itemx -mno-dspr2
14356 @opindex mdspr2
14357 @opindex mno-dspr2
14358 Use (do not use) revision 2 of the MIPS DSP ASE@.
14359 @xref{MIPS DSP Built-in Functions}. This option defines the
14360 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
14361 It also defines @samp{__mips_dsp_rev} to 2.
14362
14363 @item -msmartmips
14364 @itemx -mno-smartmips
14365 @opindex msmartmips
14366 @opindex mno-smartmips
14367 Use (do not use) the MIPS SmartMIPS ASE.
14368
14369 @item -mpaired-single
14370 @itemx -mno-paired-single
14371 @opindex mpaired-single
14372 @opindex mno-paired-single
14373 Use (do not use) paired-single floating-point instructions.
14374 @xref{MIPS Paired-Single Support}. This option requires
14375 hardware floating-point support to be enabled.
14376
14377 @item -mdmx
14378 @itemx -mno-mdmx
14379 @opindex mdmx
14380 @opindex mno-mdmx
14381 Use (do not use) MIPS Digital Media Extension instructions.
14382 This option can only be used when generating 64-bit code and requires
14383 hardware floating-point support to be enabled.
14384
14385 @item -mips3d
14386 @itemx -mno-mips3d
14387 @opindex mips3d
14388 @opindex mno-mips3d
14389 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
14390 The option @option{-mips3d} implies @option{-mpaired-single}.
14391
14392 @item -mmt
14393 @itemx -mno-mt
14394 @opindex mmt
14395 @opindex mno-mt
14396 Use (do not use) MT Multithreading instructions.
14397
14398 @item -mlong64
14399 @opindex mlong64
14400 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
14401 an explanation of the default and the way that the pointer size is
14402 determined.
14403
14404 @item -mlong32
14405 @opindex mlong32
14406 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
14407
14408 The default size of @code{int}s, @code{long}s and pointers depends on
14409 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
14410 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
14411 32-bit @code{long}s. Pointers are the same size as @code{long}s,
14412 or the same size as integer registers, whichever is smaller.
14413
14414 @item -msym32
14415 @itemx -mno-sym32
14416 @opindex msym32
14417 @opindex mno-sym32
14418 Assume (do not assume) that all symbols have 32-bit values, regardless
14419 of the selected ABI@. This option is useful in combination with
14420 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
14421 to generate shorter and faster references to symbolic addresses.
14422
14423 @item -G @var{num}
14424 @opindex G
14425 Put definitions of externally-visible data in a small data section
14426 if that data is no bigger than @var{num} bytes. GCC can then access
14427 the data more efficiently; see @option{-mgpopt} for details.
14428
14429 The default @option{-G} option depends on the configuration.
14430
14431 @item -mlocal-sdata
14432 @itemx -mno-local-sdata
14433 @opindex mlocal-sdata
14434 @opindex mno-local-sdata
14435 Extend (do not extend) the @option{-G} behavior to local data too,
14436 such as to static variables in C@. @option{-mlocal-sdata} is the
14437 default for all configurations.
14438
14439 If the linker complains that an application is using too much small data,
14440 you might want to try rebuilding the less performance-critical parts with
14441 @option{-mno-local-sdata}. You might also want to build large
14442 libraries with @option{-mno-local-sdata}, so that the libraries leave
14443 more room for the main program.
14444
14445 @item -mextern-sdata
14446 @itemx -mno-extern-sdata
14447 @opindex mextern-sdata
14448 @opindex mno-extern-sdata
14449 Assume (do not assume) that externally-defined data will be in
14450 a small data section if that data is within the @option{-G} limit.
14451 @option{-mextern-sdata} is the default for all configurations.
14452
14453 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
14454 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
14455 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14456 is placed in a small data section. If @var{Var} is defined by another
14457 module, you must either compile that module with a high-enough
14458 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14459 definition. If @var{Var} is common, you must link the application
14460 with a high-enough @option{-G} setting.
14461
14462 The easiest way of satisfying these restrictions is to compile
14463 and link every module with the same @option{-G} option. However,
14464 you may wish to build a library that supports several different
14465 small data limits. You can do this by compiling the library with
14466 the highest supported @option{-G} setting and additionally using
14467 @option{-mno-extern-sdata} to stop the library from making assumptions
14468 about externally-defined data.
14469
14470 @item -mgpopt
14471 @itemx -mno-gpopt
14472 @opindex mgpopt
14473 @opindex mno-gpopt
14474 Use (do not use) GP-relative accesses for symbols that are known to be
14475 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14476 @option{-mextern-sdata}. @option{-mgpopt} is the default for all
14477 configurations.
14478
14479 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14480 might not hold the value of @code{_gp}. For example, if the code is
14481 part of a library that might be used in a boot monitor, programs that
14482 call boot monitor routines will pass an unknown value in @code{$gp}.
14483 (In such situations, the boot monitor itself would usually be compiled
14484 with @option{-G0}.)
14485
14486 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14487 @option{-mno-extern-sdata}.
14488
14489 @item -membedded-data
14490 @itemx -mno-embedded-data
14491 @opindex membedded-data
14492 @opindex mno-embedded-data
14493 Allocate variables to the read-only data section first if possible, then
14494 next in the small data section if possible, otherwise in data. This gives
14495 slightly slower code than the default, but reduces the amount of RAM required
14496 when executing, and thus may be preferred for some embedded systems.
14497
14498 @item -muninit-const-in-rodata
14499 @itemx -mno-uninit-const-in-rodata
14500 @opindex muninit-const-in-rodata
14501 @opindex mno-uninit-const-in-rodata
14502 Put uninitialized @code{const} variables in the read-only data section.
14503 This option is only meaningful in conjunction with @option{-membedded-data}.
14504
14505 @item -mcode-readable=@var{setting}
14506 @opindex mcode-readable
14507 Specify whether GCC may generate code that reads from executable sections.
14508 There are three possible settings:
14509
14510 @table @gcctabopt
14511 @item -mcode-readable=yes
14512 Instructions may freely access executable sections. This is the
14513 default setting.
14514
14515 @item -mcode-readable=pcrel
14516 MIPS16 PC-relative load instructions can access executable sections,
14517 but other instructions must not do so. This option is useful on 4KSc
14518 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14519 It is also useful on processors that can be configured to have a dual
14520 instruction/data SRAM interface and that, like the M4K, automatically
14521 redirect PC-relative loads to the instruction RAM.
14522
14523 @item -mcode-readable=no
14524 Instructions must not access executable sections. This option can be
14525 useful on targets that are configured to have a dual instruction/data
14526 SRAM interface but that (unlike the M4K) do not automatically redirect
14527 PC-relative loads to the instruction RAM.
14528 @end table
14529
14530 @item -msplit-addresses
14531 @itemx -mno-split-addresses
14532 @opindex msplit-addresses
14533 @opindex mno-split-addresses
14534 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14535 relocation operators. This option has been superseded by
14536 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14537
14538 @item -mexplicit-relocs
14539 @itemx -mno-explicit-relocs
14540 @opindex mexplicit-relocs
14541 @opindex mno-explicit-relocs
14542 Use (do not use) assembler relocation operators when dealing with symbolic
14543 addresses. The alternative, selected by @option{-mno-explicit-relocs},
14544 is to use assembler macros instead.
14545
14546 @option{-mexplicit-relocs} is the default if GCC was configured
14547 to use an assembler that supports relocation operators.
14548
14549 @item -mcheck-zero-division
14550 @itemx -mno-check-zero-division
14551 @opindex mcheck-zero-division
14552 @opindex mno-check-zero-division
14553 Trap (do not trap) on integer division by zero.
14554
14555 The default is @option{-mcheck-zero-division}.
14556
14557 @item -mdivide-traps
14558 @itemx -mdivide-breaks
14559 @opindex mdivide-traps
14560 @opindex mdivide-breaks
14561 MIPS systems check for division by zero by generating either a
14562 conditional trap or a break instruction. Using traps results in
14563 smaller code, but is only supported on MIPS II and later. Also, some
14564 versions of the Linux kernel have a bug that prevents trap from
14565 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
14566 allow conditional traps on architectures that support them and
14567 @option{-mdivide-breaks} to force the use of breaks.
14568
14569 The default is usually @option{-mdivide-traps}, but this can be
14570 overridden at configure time using @option{--with-divide=breaks}.
14571 Divide-by-zero checks can be completely disabled using
14572 @option{-mno-check-zero-division}.
14573
14574 @item -mmemcpy
14575 @itemx -mno-memcpy
14576 @opindex mmemcpy
14577 @opindex mno-memcpy
14578 Force (do not force) the use of @code{memcpy()} for non-trivial block
14579 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
14580 most constant-sized copies.
14581
14582 @item -mlong-calls
14583 @itemx -mno-long-calls
14584 @opindex mlong-calls
14585 @opindex mno-long-calls
14586 Disable (do not disable) use of the @code{jal} instruction. Calling
14587 functions using @code{jal} is more efficient but requires the caller
14588 and callee to be in the same 256 megabyte segment.
14589
14590 This option has no effect on abicalls code. The default is
14591 @option{-mno-long-calls}.
14592
14593 @item -mmad
14594 @itemx -mno-mad
14595 @opindex mmad
14596 @opindex mno-mad
14597 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14598 instructions, as provided by the R4650 ISA@.
14599
14600 @item -mfused-madd
14601 @itemx -mno-fused-madd
14602 @opindex mfused-madd
14603 @opindex mno-fused-madd
14604 Enable (disable) use of the floating point multiply-accumulate
14605 instructions, when they are available. The default is
14606 @option{-mfused-madd}.
14607
14608 When multiply-accumulate instructions are used, the intermediate
14609 product is calculated to infinite precision and is not subject to
14610 the FCSR Flush to Zero bit. This may be undesirable in some
14611 circumstances.
14612
14613 @item -nocpp
14614 @opindex nocpp
14615 Tell the MIPS assembler to not run its preprocessor over user
14616 assembler files (with a @samp{.s} suffix) when assembling them.
14617
14618 @item -mfix-r4000
14619 @itemx -mno-fix-r4000
14620 @opindex mfix-r4000
14621 @opindex mno-fix-r4000
14622 Work around certain R4000 CPU errata:
14623 @itemize @minus
14624 @item
14625 A double-word or a variable shift may give an incorrect result if executed
14626 immediately after starting an integer division.
14627 @item
14628 A double-word or a variable shift may give an incorrect result if executed
14629 while an integer multiplication is in progress.
14630 @item
14631 An integer division may give an incorrect result if started in a delay slot
14632 of a taken branch or a jump.
14633 @end itemize
14634
14635 @item -mfix-r4400
14636 @itemx -mno-fix-r4400
14637 @opindex mfix-r4400
14638 @opindex mno-fix-r4400
14639 Work around certain R4400 CPU errata:
14640 @itemize @minus
14641 @item
14642 A double-word or a variable shift may give an incorrect result if executed
14643 immediately after starting an integer division.
14644 @end itemize
14645
14646 @item -mfix-r10000
14647 @itemx -mno-fix-r10000
14648 @opindex mfix-r10000
14649 @opindex mno-fix-r10000
14650 Work around certain R10000 errata:
14651 @itemize @minus
14652 @item
14653 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14654 prior to 3.0. They may deadlock on revisions 2.6 and earlier.
14655 @end itemize
14656
14657 This option can only be used if the target architecture supports
14658 branch-likely instructions. @option{-mfix-r10000} is the default when
14659 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14660 otherwise.
14661
14662 @item -mfix-vr4120
14663 @itemx -mno-fix-vr4120
14664 @opindex mfix-vr4120
14665 Work around certain VR4120 errata:
14666 @itemize @minus
14667 @item
14668 @code{dmultu} does not always produce the correct result.
14669 @item
14670 @code{div} and @code{ddiv} do not always produce the correct result if one
14671 of the operands is negative.
14672 @end itemize
14673 The workarounds for the division errata rely on special functions in
14674 @file{libgcc.a}. At present, these functions are only provided by
14675 the @code{mips64vr*-elf} configurations.
14676
14677 Other VR4120 errata require a nop to be inserted between certain pairs of
14678 instructions. These errata are handled by the assembler, not by GCC itself.
14679
14680 @item -mfix-vr4130
14681 @opindex mfix-vr4130
14682 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
14683 workarounds are implemented by the assembler rather than by GCC,
14684 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14685 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14686 instructions are available instead.
14687
14688 @item -mfix-sb1
14689 @itemx -mno-fix-sb1
14690 @opindex mfix-sb1
14691 Work around certain SB-1 CPU core errata.
14692 (This flag currently works around the SB-1 revision 2
14693 ``F1'' and ``F2'' floating point errata.)
14694
14695 @item -mr10k-cache-barrier=@var{setting}
14696 @opindex mr10k-cache-barrier
14697 Specify whether GCC should insert cache barriers to avoid the
14698 side-effects of speculation on R10K processors.
14699
14700 In common with many processors, the R10K tries to predict the outcome
14701 of a conditional branch and speculatively executes instructions from
14702 the ``taken'' branch. It later aborts these instructions if the
14703 predicted outcome was wrong. However, on the R10K, even aborted
14704 instructions can have side effects.
14705
14706 This problem only affects kernel stores and, depending on the system,
14707 kernel loads. As an example, a speculatively-executed store may load
14708 the target memory into cache and mark the cache line as dirty, even if
14709 the store itself is later aborted. If a DMA operation writes to the
14710 same area of memory before the ``dirty'' line is flushed, the cached
14711 data will overwrite the DMA-ed data. See the R10K processor manual
14712 for a full description, including other potential problems.
14713
14714 One workaround is to insert cache barrier instructions before every memory
14715 access that might be speculatively executed and that might have side
14716 effects even if aborted. @option{-mr10k-cache-barrier=@var{setting}}
14717 controls GCC's implementation of this workaround. It assumes that
14718 aborted accesses to any byte in the following regions will not have
14719 side effects:
14720
14721 @enumerate
14722 @item
14723 the memory occupied by the current function's stack frame;
14724
14725 @item
14726 the memory occupied by an incoming stack argument;
14727
14728 @item
14729 the memory occupied by an object with a link-time-constant address.
14730 @end enumerate
14731
14732 It is the kernel's responsibility to ensure that speculative
14733 accesses to these regions are indeed safe.
14734
14735 If the input program contains a function declaration such as:
14736
14737 @smallexample
14738 void foo (void);
14739 @end smallexample
14740
14741 then the implementation of @code{foo} must allow @code{j foo} and
14742 @code{jal foo} to be executed speculatively. GCC honors this
14743 restriction for functions it compiles itself. It expects non-GCC
14744 functions (such as hand-written assembly code) to do the same.
14745
14746 The option has three forms:
14747
14748 @table @gcctabopt
14749 @item -mr10k-cache-barrier=load-store
14750 Insert a cache barrier before a load or store that might be
14751 speculatively executed and that might have side effects even
14752 if aborted.
14753
14754 @item -mr10k-cache-barrier=store
14755 Insert a cache barrier before a store that might be speculatively
14756 executed and that might have side effects even if aborted.
14757
14758 @item -mr10k-cache-barrier=none
14759 Disable the insertion of cache barriers. This is the default setting.
14760 @end table
14761
14762 @item -mflush-func=@var{func}
14763 @itemx -mno-flush-func
14764 @opindex mflush-func
14765 Specifies the function to call to flush the I and D caches, or to not
14766 call any such function. If called, the function must take the same
14767 arguments as the common @code{_flush_func()}, that is, the address of the
14768 memory range for which the cache is being flushed, the size of the
14769 memory range, and the number 3 (to flush both caches). The default
14770 depends on the target GCC was configured for, but commonly is either
14771 @samp{_flush_func} or @samp{__cpu_flush}.
14772
14773 @item mbranch-cost=@var{num}
14774 @opindex mbranch-cost
14775 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14776 This cost is only a heuristic and is not guaranteed to produce
14777 consistent results across releases. A zero cost redundantly selects
14778 the default, which is based on the @option{-mtune} setting.
14779
14780 @item -mbranch-likely
14781 @itemx -mno-branch-likely
14782 @opindex mbranch-likely
14783 @opindex mno-branch-likely
14784 Enable or disable use of Branch Likely instructions, regardless of the
14785 default for the selected architecture. By default, Branch Likely
14786 instructions may be generated if they are supported by the selected
14787 architecture. An exception is for the MIPS32 and MIPS64 architectures
14788 and processors which implement those architectures; for those, Branch
14789 Likely instructions will not be generated by default because the MIPS32
14790 and MIPS64 architectures specifically deprecate their use.
14791
14792 @item -mfp-exceptions
14793 @itemx -mno-fp-exceptions
14794 @opindex mfp-exceptions
14795 Specifies whether FP exceptions are enabled. This affects how we schedule
14796 FP instructions for some processors. The default is that FP exceptions are
14797 enabled.
14798
14799 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14800 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
14801 FP pipe.
14802
14803 @item -mvr4130-align
14804 @itemx -mno-vr4130-align
14805 @opindex mvr4130-align
14806 The VR4130 pipeline is two-way superscalar, but can only issue two
14807 instructions together if the first one is 8-byte aligned. When this
14808 option is enabled, GCC will align pairs of instructions that it
14809 thinks should execute in parallel.
14810
14811 This option only has an effect when optimizing for the VR4130.
14812 It normally makes code faster, but at the expense of making it bigger.
14813 It is enabled by default at optimization level @option{-O3}.
14814
14815 @item -msynci
14816 @itemx -mno-synci
14817 @opindex msynci
14818 Enable (disable) generation of @code{synci} instructions on
14819 architectures that support it. The @code{synci} instructions (if
14820 enabled) will be generated when @code{__builtin___clear_cache()} is
14821 compiled.
14822
14823 This option defaults to @code{-mno-synci}, but the default can be
14824 overridden by configuring with @code{--with-synci}.
14825
14826 When compiling code for single processor systems, it is generally safe
14827 to use @code{synci}. However, on many multi-core (SMP) systems, it
14828 will not invalidate the instruction caches on all cores and may lead
14829 to undefined behavior.
14830
14831 @item -mrelax-pic-calls
14832 @itemx -mno-relax-pic-calls
14833 @opindex mrelax-pic-calls
14834 Try to turn PIC calls that are normally dispatched via register
14835 @code{$25} into direct calls. This is only possible if the linker can
14836 resolve the destination at link-time and if the destination is within
14837 range for a direct call.
14838
14839 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14840 an assembler and a linker that supports the @code{.reloc} assembly
14841 directive and @code{-mexplicit-relocs} is in effect. With
14842 @code{-mno-explicit-relocs}, this optimization can be performed by the
14843 assembler and the linker alone without help from the compiler.
14844
14845 @item -mmcount-ra-address
14846 @itemx -mno-mcount-ra-address
14847 @opindex mmcount-ra-address
14848 @opindex mno-mcount-ra-address
14849 Emit (do not emit) code that allows @code{_mcount} to modify the
14850 calling function's return address. When enabled, this option extends
14851 the usual @code{_mcount} interface with a new @var{ra-address}
14852 parameter, which has type @code{intptr_t *} and is passed in register
14853 @code{$12}. @code{_mcount} can then modify the return address by
14854 doing both of the following:
14855 @itemize
14856 @item
14857 Returning the new address in register @code{$31}.
14858 @item
14859 Storing the new address in @code{*@var{ra-address}},
14860 if @var{ra-address} is nonnull.
14861 @end itemize
14862
14863 The default is @option{-mno-mcount-ra-address}.
14864
14865 @end table
14866
14867 @node MMIX Options
14868 @subsection MMIX Options
14869 @cindex MMIX Options
14870
14871 These options are defined for the MMIX:
14872
14873 @table @gcctabopt
14874 @item -mlibfuncs
14875 @itemx -mno-libfuncs
14876 @opindex mlibfuncs
14877 @opindex mno-libfuncs
14878 Specify that intrinsic library functions are being compiled, passing all
14879 values in registers, no matter the size.
14880
14881 @item -mepsilon
14882 @itemx -mno-epsilon
14883 @opindex mepsilon
14884 @opindex mno-epsilon
14885 Generate floating-point comparison instructions that compare with respect
14886 to the @code{rE} epsilon register.
14887
14888 @item -mabi=mmixware
14889 @itemx -mabi=gnu
14890 @opindex mabi=mmixware
14891 @opindex mabi=gnu
14892 Generate code that passes function parameters and return values that (in
14893 the called function) are seen as registers @code{$0} and up, as opposed to
14894 the GNU ABI which uses global registers @code{$231} and up.
14895
14896 @item -mzero-extend
14897 @itemx -mno-zero-extend
14898 @opindex mzero-extend
14899 @opindex mno-zero-extend
14900 When reading data from memory in sizes shorter than 64 bits, use (do not
14901 use) zero-extending load instructions by default, rather than
14902 sign-extending ones.
14903
14904 @item -mknuthdiv
14905 @itemx -mno-knuthdiv
14906 @opindex mknuthdiv
14907 @opindex mno-knuthdiv
14908 Make the result of a division yielding a remainder have the same sign as
14909 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
14910 remainder follows the sign of the dividend. Both methods are
14911 arithmetically valid, the latter being almost exclusively used.
14912
14913 @item -mtoplevel-symbols
14914 @itemx -mno-toplevel-symbols
14915 @opindex mtoplevel-symbols
14916 @opindex mno-toplevel-symbols
14917 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14918 code can be used with the @code{PREFIX} assembly directive.
14919
14920 @item -melf
14921 @opindex melf
14922 Generate an executable in the ELF format, rather than the default
14923 @samp{mmo} format used by the @command{mmix} simulator.
14924
14925 @item -mbranch-predict
14926 @itemx -mno-branch-predict
14927 @opindex mbranch-predict
14928 @opindex mno-branch-predict
14929 Use (do not use) the probable-branch instructions, when static branch
14930 prediction indicates a probable branch.
14931
14932 @item -mbase-addresses
14933 @itemx -mno-base-addresses
14934 @opindex mbase-addresses
14935 @opindex mno-base-addresses
14936 Generate (do not generate) code that uses @emph{base addresses}. Using a
14937 base address automatically generates a request (handled by the assembler
14938 and the linker) for a constant to be set up in a global register. The
14939 register is used for one or more base address requests within the range 0
14940 to 255 from the value held in the register. The generally leads to short
14941 and fast code, but the number of different data items that can be
14942 addressed is limited. This means that a program that uses lots of static
14943 data may require @option{-mno-base-addresses}.
14944
14945 @item -msingle-exit
14946 @itemx -mno-single-exit
14947 @opindex msingle-exit
14948 @opindex mno-single-exit
14949 Force (do not force) generated code to have a single exit point in each
14950 function.
14951 @end table
14952
14953 @node MN10300 Options
14954 @subsection MN10300 Options
14955 @cindex MN10300 options
14956
14957 These @option{-m} options are defined for Matsushita MN10300 architectures:
14958
14959 @table @gcctabopt
14960 @item -mmult-bug
14961 @opindex mmult-bug
14962 Generate code to avoid bugs in the multiply instructions for the MN10300
14963 processors. This is the default.
14964
14965 @item -mno-mult-bug
14966 @opindex mno-mult-bug
14967 Do not generate code to avoid bugs in the multiply instructions for the
14968 MN10300 processors.
14969
14970 @item -mam33
14971 @opindex mam33
14972 Generate code which uses features specific to the AM33 processor.
14973
14974 @item -mno-am33
14975 @opindex mno-am33
14976 Do not generate code which uses features specific to the AM33 processor. This
14977 is the default.
14978
14979 @item -mam33-2
14980 @opindex mam33-2
14981 Generate code which uses features specific to the AM33/2.0 processor.
14982
14983 @item -mam34
14984 @opindex mam34
14985 Generate code which uses features specific to the AM34 processor.
14986
14987 @item -mtune=@var{cpu-type}
14988 @opindex mtune
14989 Use the timing characteristics of the indicated CPU type when
14990 scheduling instructions. This does not change the targeted processor
14991 type. The CPU type must be one of @samp{mn10300}, @samp{am33},
14992 @samp{am33-2} or @samp{am34}.
14993
14994 @item -mreturn-pointer-on-d0
14995 @opindex mreturn-pointer-on-d0
14996 When generating a function which returns a pointer, return the pointer
14997 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
14998 only in a0, and attempts to call such functions without a prototype
14999 would result in errors. Note that this option is on by default; use
15000 @option{-mno-return-pointer-on-d0} to disable it.
15001
15002 @item -mno-crt0
15003 @opindex mno-crt0
15004 Do not link in the C run-time initialization object file.
15005
15006 @item -mrelax
15007 @opindex mrelax
15008 Indicate to the linker that it should perform a relaxation optimization pass
15009 to shorten branches, calls and absolute memory addresses. This option only
15010 has an effect when used on the command line for the final link step.
15011
15012 This option makes symbolic debugging impossible.
15013 @end table
15014
15015 @node PDP-11 Options
15016 @subsection PDP-11 Options
15017 @cindex PDP-11 Options
15018
15019 These options are defined for the PDP-11:
15020
15021 @table @gcctabopt
15022 @item -mfpu
15023 @opindex mfpu
15024 Use hardware FPP floating point. This is the default. (FIS floating
15025 point on the PDP-11/40 is not supported.)
15026
15027 @item -msoft-float
15028 @opindex msoft-float
15029 Do not use hardware floating point.
15030
15031 @item -mac0
15032 @opindex mac0
15033 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
15034
15035 @item -mno-ac0
15036 @opindex mno-ac0
15037 Return floating-point results in memory. This is the default.
15038
15039 @item -m40
15040 @opindex m40
15041 Generate code for a PDP-11/40.
15042
15043 @item -m45
15044 @opindex m45
15045 Generate code for a PDP-11/45. This is the default.
15046
15047 @item -m10
15048 @opindex m10
15049 Generate code for a PDP-11/10.
15050
15051 @item -mbcopy-builtin
15052 @opindex mbcopy-builtin
15053 Use inline @code{movmemhi} patterns for copying memory. This is the
15054 default.
15055
15056 @item -mbcopy
15057 @opindex mbcopy
15058 Do not use inline @code{movmemhi} patterns for copying memory.
15059
15060 @item -mint16
15061 @itemx -mno-int32
15062 @opindex mint16
15063 @opindex mno-int32
15064 Use 16-bit @code{int}. This is the default.
15065
15066 @item -mint32
15067 @itemx -mno-int16
15068 @opindex mint32
15069 @opindex mno-int16
15070 Use 32-bit @code{int}.
15071
15072 @item -mfloat64
15073 @itemx -mno-float32
15074 @opindex mfloat64
15075 @opindex mno-float32
15076 Use 64-bit @code{float}. This is the default.
15077
15078 @item -mfloat32
15079 @itemx -mno-float64
15080 @opindex mfloat32
15081 @opindex mno-float64
15082 Use 32-bit @code{float}.
15083
15084 @item -mabshi
15085 @opindex mabshi
15086 Use @code{abshi2} pattern. This is the default.
15087
15088 @item -mno-abshi
15089 @opindex mno-abshi
15090 Do not use @code{abshi2} pattern.
15091
15092 @item -mbranch-expensive
15093 @opindex mbranch-expensive
15094 Pretend that branches are expensive. This is for experimenting with
15095 code generation only.
15096
15097 @item -mbranch-cheap
15098 @opindex mbranch-cheap
15099 Do not pretend that branches are expensive. This is the default.
15100
15101 @item -munix-asm
15102 @opindex munix-asm
15103 Use Unix assembler syntax. This is the default when configured for
15104 @samp{pdp11-*-bsd}.
15105
15106 @item -mdec-asm
15107 @opindex mdec-asm
15108 Use DEC assembler syntax. This is the default when configured for any
15109 PDP-11 target other than @samp{pdp11-*-bsd}.
15110 @end table
15111
15112 @node picoChip Options
15113 @subsection picoChip Options
15114 @cindex picoChip options
15115
15116 These @samp{-m} options are defined for picoChip implementations:
15117
15118 @table @gcctabopt
15119
15120 @item -mae=@var{ae_type}
15121 @opindex mcpu
15122 Set the instruction set, register set, and instruction scheduling
15123 parameters for array element type @var{ae_type}. Supported values
15124 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
15125
15126 @option{-mae=ANY} selects a completely generic AE type. Code
15127 generated with this option will run on any of the other AE types. The
15128 code will not be as efficient as it would be if compiled for a specific
15129 AE type, and some types of operation (e.g., multiplication) will not
15130 work properly on all types of AE.
15131
15132 @option{-mae=MUL} selects a MUL AE type. This is the most useful AE type
15133 for compiled code, and is the default.
15134
15135 @option{-mae=MAC} selects a DSP-style MAC AE. Code compiled with this
15136 option may suffer from poor performance of byte (char) manipulation,
15137 since the DSP AE does not provide hardware support for byte load/stores.
15138
15139 @item -msymbol-as-address
15140 Enable the compiler to directly use a symbol name as an address in a
15141 load/store instruction, without first loading it into a
15142 register. Typically, the use of this option will generate larger
15143 programs, which run faster than when the option isn't used. However, the
15144 results vary from program to program, so it is left as a user option,
15145 rather than being permanently enabled.
15146
15147 @item -mno-inefficient-warnings
15148 Disables warnings about the generation of inefficient code. These
15149 warnings can be generated, for example, when compiling code which
15150 performs byte-level memory operations on the MAC AE type. The MAC AE has
15151 no hardware support for byte-level memory operations, so all byte
15152 load/stores must be synthesized from word load/store operations. This is
15153 inefficient and a warning will be generated indicating to the programmer
15154 that they should rewrite the code to avoid byte operations, or to target
15155 an AE type which has the necessary hardware support. This option enables
15156 the warning to be turned off.
15157
15158 @end table
15159
15160 @node PowerPC Options
15161 @subsection PowerPC Options
15162 @cindex PowerPC options
15163
15164 These are listed under @xref{RS/6000 and PowerPC Options}.
15165
15166 @node RS/6000 and PowerPC Options
15167 @subsection IBM RS/6000 and PowerPC Options
15168 @cindex RS/6000 and PowerPC Options
15169 @cindex IBM RS/6000 and PowerPC Options
15170
15171 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
15172 @table @gcctabopt
15173 @item -mpower
15174 @itemx -mno-power
15175 @itemx -mpower2
15176 @itemx -mno-power2
15177 @itemx -mpowerpc
15178 @itemx -mno-powerpc
15179 @itemx -mpowerpc-gpopt
15180 @itemx -mno-powerpc-gpopt
15181 @itemx -mpowerpc-gfxopt
15182 @itemx -mno-powerpc-gfxopt
15183 @need 800
15184 @itemx -mpowerpc64
15185 @itemx -mno-powerpc64
15186 @itemx -mmfcrf
15187 @itemx -mno-mfcrf
15188 @itemx -mpopcntb
15189 @itemx -mno-popcntb
15190 @itemx -mpopcntd
15191 @itemx -mno-popcntd
15192 @itemx -mfprnd
15193 @itemx -mno-fprnd
15194 @need 800
15195 @itemx -mcmpb
15196 @itemx -mno-cmpb
15197 @itemx -mmfpgpr
15198 @itemx -mno-mfpgpr
15199 @itemx -mhard-dfp
15200 @itemx -mno-hard-dfp
15201 @opindex mpower
15202 @opindex mno-power
15203 @opindex mpower2
15204 @opindex mno-power2
15205 @opindex mpowerpc
15206 @opindex mno-powerpc
15207 @opindex mpowerpc-gpopt
15208 @opindex mno-powerpc-gpopt
15209 @opindex mpowerpc-gfxopt
15210 @opindex mno-powerpc-gfxopt
15211 @opindex mpowerpc64
15212 @opindex mno-powerpc64
15213 @opindex mmfcrf
15214 @opindex mno-mfcrf
15215 @opindex mpopcntb
15216 @opindex mno-popcntb
15217 @opindex mpopcntd
15218 @opindex mno-popcntd
15219 @opindex mfprnd
15220 @opindex mno-fprnd
15221 @opindex mcmpb
15222 @opindex mno-cmpb
15223 @opindex mmfpgpr
15224 @opindex mno-mfpgpr
15225 @opindex mhard-dfp
15226 @opindex mno-hard-dfp
15227 GCC supports two related instruction set architectures for the
15228 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
15229 instructions supported by the @samp{rios} chip set used in the original
15230 RS/6000 systems and the @dfn{PowerPC} instruction set is the
15231 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
15232 the IBM 4xx, 6xx, and follow-on microprocessors.
15233
15234 Neither architecture is a subset of the other. However there is a
15235 large common subset of instructions supported by both. An MQ
15236 register is included in processors supporting the POWER architecture.
15237
15238 You use these options to specify which instructions are available on the
15239 processor you are using. The default value of these options is
15240 determined when configuring GCC@. Specifying the
15241 @option{-mcpu=@var{cpu_type}} overrides the specification of these
15242 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
15243 rather than the options listed above.
15244
15245 The @option{-mpower} option allows GCC to generate instructions that
15246 are found only in the POWER architecture and to use the MQ register.
15247 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
15248 to generate instructions that are present in the POWER2 architecture but
15249 not the original POWER architecture.
15250
15251 The @option{-mpowerpc} option allows GCC to generate instructions that
15252 are found only in the 32-bit subset of the PowerPC architecture.
15253 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
15254 GCC to use the optional PowerPC architecture instructions in the
15255 General Purpose group, including floating-point square root. Specifying
15256 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
15257 use the optional PowerPC architecture instructions in the Graphics
15258 group, including floating-point select.
15259
15260 The @option{-mmfcrf} option allows GCC to generate the move from
15261 condition register field instruction implemented on the POWER4
15262 processor and other processors that support the PowerPC V2.01
15263 architecture.
15264 The @option{-mpopcntb} option allows GCC to generate the popcount and
15265 double precision FP reciprocal estimate instruction implemented on the
15266 POWER5 processor and other processors that support the PowerPC V2.02
15267 architecture.
15268 The @option{-mpopcntd} option allows GCC to generate the popcount
15269 instruction implemented on the POWER7 processor and other processors
15270 that support the PowerPC V2.06 architecture.
15271 The @option{-mfprnd} option allows GCC to generate the FP round to
15272 integer instructions implemented on the POWER5+ processor and other
15273 processors that support the PowerPC V2.03 architecture.
15274 The @option{-mcmpb} option allows GCC to generate the compare bytes
15275 instruction implemented on the POWER6 processor and other processors
15276 that support the PowerPC V2.05 architecture.
15277 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
15278 general purpose register instructions implemented on the POWER6X
15279 processor and other processors that support the extended PowerPC V2.05
15280 architecture.
15281 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
15282 point instructions implemented on some POWER processors.
15283
15284 The @option{-mpowerpc64} option allows GCC to generate the additional
15285 64-bit instructions that are found in the full PowerPC64 architecture
15286 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
15287 @option{-mno-powerpc64}.
15288
15289 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
15290 will use only the instructions in the common subset of both
15291 architectures plus some special AIX common-mode calls, and will not use
15292 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
15293 permits GCC to use any instruction from either architecture and to
15294 allow use of the MQ register; specify this for the Motorola MPC601.
15295
15296 @item -mnew-mnemonics
15297 @itemx -mold-mnemonics
15298 @opindex mnew-mnemonics
15299 @opindex mold-mnemonics
15300 Select which mnemonics to use in the generated assembler code. With
15301 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
15302 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
15303 assembler mnemonics defined for the POWER architecture. Instructions
15304 defined in only one architecture have only one mnemonic; GCC uses that
15305 mnemonic irrespective of which of these options is specified.
15306
15307 GCC defaults to the mnemonics appropriate for the architecture in
15308 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
15309 value of these option. Unless you are building a cross-compiler, you
15310 should normally not specify either @option{-mnew-mnemonics} or
15311 @option{-mold-mnemonics}, but should instead accept the default.
15312
15313 @item -mcpu=@var{cpu_type}
15314 @opindex mcpu
15315 Set architecture type, register usage, choice of mnemonics, and
15316 instruction scheduling parameters for machine type @var{cpu_type}.
15317 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
15318 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
15319 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
15320 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
15321 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
15322 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
15323 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
15324 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
15325 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
15326 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
15327 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
15328
15329 @option{-mcpu=common} selects a completely generic processor. Code
15330 generated under this option will run on any POWER or PowerPC processor.
15331 GCC will use only the instructions in the common subset of both
15332 architectures, and will not use the MQ register. GCC assumes a generic
15333 processor model for scheduling purposes.
15334
15335 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
15336 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
15337 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
15338 types, with an appropriate, generic processor model assumed for
15339 scheduling purposes.
15340
15341 The other options specify a specific processor. Code generated under
15342 those options will run best on that processor, and may not run at all on
15343 others.
15344
15345 The @option{-mcpu} options automatically enable or disable the
15346 following options:
15347
15348 @gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple @gol
15349 -mnew-mnemonics -mpopcntb -mpopcntd -mpower -mpower2 -mpowerpc64 @gol
15350 -mpowerpc-gpopt -mpowerpc-gfxopt -msingle-float -mdouble-float @gol
15351 -msimple-fpu -mstring -mmulhw -mdlmzb -mmfpgpr -mvsx}
15352
15353 The particular options set for any particular CPU will vary between
15354 compiler versions, depending on what setting seems to produce optimal
15355 code for that CPU; it doesn't necessarily reflect the actual hardware's
15356 capabilities. If you wish to set an individual option to a particular
15357 value, you may specify it after the @option{-mcpu} option, like
15358 @samp{-mcpu=970 -mno-altivec}.
15359
15360 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
15361 not enabled or disabled by the @option{-mcpu} option at present because
15362 AIX does not have full support for these options. You may still
15363 enable or disable them individually if you're sure it'll work in your
15364 environment.
15365
15366 @item -mtune=@var{cpu_type}
15367 @opindex mtune
15368 Set the instruction scheduling parameters for machine type
15369 @var{cpu_type}, but do not set the architecture type, register usage, or
15370 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
15371 values for @var{cpu_type} are used for @option{-mtune} as for
15372 @option{-mcpu}. If both are specified, the code generated will use the
15373 architecture, registers, and mnemonics set by @option{-mcpu}, but the
15374 scheduling parameters set by @option{-mtune}.
15375
15376 @item -mcmodel=small
15377 @opindex mcmodel=small
15378 Generate PowerPC64 code for the small model: The TOC is limited to
15379 64k.
15380
15381 @item -mcmodel=medium
15382 @opindex mcmodel=medium
15383 Generate PowerPC64 code for the medium model: The TOC and other static
15384 data may be up to a total of 4G in size.
15385
15386 @item -mcmodel=large
15387 @opindex mcmodel=large
15388 Generate PowerPC64 code for the large model: The TOC may be up to 4G
15389 in size. Other data and code is only limited by the 64-bit address
15390 space.
15391
15392 @item -maltivec
15393 @itemx -mno-altivec
15394 @opindex maltivec
15395 @opindex mno-altivec
15396 Generate code that uses (does not use) AltiVec instructions, and also
15397 enable the use of built-in functions that allow more direct access to
15398 the AltiVec instruction set. You may also need to set
15399 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
15400 enhancements.
15401
15402 @item -mvrsave
15403 @itemx -mno-vrsave
15404 @opindex mvrsave
15405 @opindex mno-vrsave
15406 Generate VRSAVE instructions when generating AltiVec code.
15407
15408 @item -mgen-cell-microcode
15409 @opindex mgen-cell-microcode
15410 Generate Cell microcode instructions
15411
15412 @item -mwarn-cell-microcode
15413 @opindex mwarn-cell-microcode
15414 Warning when a Cell microcode instruction is going to emitted. An example
15415 of a Cell microcode instruction is a variable shift.
15416
15417 @item -msecure-plt
15418 @opindex msecure-plt
15419 Generate code that allows ld and ld.so to build executables and shared
15420 libraries with non-exec .plt and .got sections. This is a PowerPC
15421 32-bit SYSV ABI option.
15422
15423 @item -mbss-plt
15424 @opindex mbss-plt
15425 Generate code that uses a BSS .plt section that ld.so fills in, and
15426 requires .plt and .got sections that are both writable and executable.
15427 This is a PowerPC 32-bit SYSV ABI option.
15428
15429 @item -misel
15430 @itemx -mno-isel
15431 @opindex misel
15432 @opindex mno-isel
15433 This switch enables or disables the generation of ISEL instructions.
15434
15435 @item -misel=@var{yes/no}
15436 This switch has been deprecated. Use @option{-misel} and
15437 @option{-mno-isel} instead.
15438
15439 @item -mspe
15440 @itemx -mno-spe
15441 @opindex mspe
15442 @opindex mno-spe
15443 This switch enables or disables the generation of SPE simd
15444 instructions.
15445
15446 @item -mpaired
15447 @itemx -mno-paired
15448 @opindex mpaired
15449 @opindex mno-paired
15450 This switch enables or disables the generation of PAIRED simd
15451 instructions.
15452
15453 @item -mspe=@var{yes/no}
15454 This option has been deprecated. Use @option{-mspe} and
15455 @option{-mno-spe} instead.
15456
15457 @item -mvsx
15458 @itemx -mno-vsx
15459 @opindex mvsx
15460 @opindex mno-vsx
15461 Generate code that uses (does not use) vector/scalar (VSX)
15462 instructions, and also enable the use of built-in functions that allow
15463 more direct access to the VSX instruction set.
15464
15465 @item -mfloat-gprs=@var{yes/single/double/no}
15466 @itemx -mfloat-gprs
15467 @opindex mfloat-gprs
15468 This switch enables or disables the generation of floating point
15469 operations on the general purpose registers for architectures that
15470 support it.
15471
15472 The argument @var{yes} or @var{single} enables the use of
15473 single-precision floating point operations.
15474
15475 The argument @var{double} enables the use of single and
15476 double-precision floating point operations.
15477
15478 The argument @var{no} disables floating point operations on the
15479 general purpose registers.
15480
15481 This option is currently only available on the MPC854x.
15482
15483 @item -m32
15484 @itemx -m64
15485 @opindex m32
15486 @opindex m64
15487 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15488 targets (including GNU/Linux). The 32-bit environment sets int, long
15489 and pointer to 32 bits and generates code that runs on any PowerPC
15490 variant. The 64-bit environment sets int to 32 bits and long and
15491 pointer to 64 bits, and generates code for PowerPC64, as for
15492 @option{-mpowerpc64}.
15493
15494 @item -mfull-toc
15495 @itemx -mno-fp-in-toc
15496 @itemx -mno-sum-in-toc
15497 @itemx -mminimal-toc
15498 @opindex mfull-toc
15499 @opindex mno-fp-in-toc
15500 @opindex mno-sum-in-toc
15501 @opindex mminimal-toc
15502 Modify generation of the TOC (Table Of Contents), which is created for
15503 every executable file. The @option{-mfull-toc} option is selected by
15504 default. In that case, GCC will allocate at least one TOC entry for
15505 each unique non-automatic variable reference in your program. GCC
15506 will also place floating-point constants in the TOC@. However, only
15507 16,384 entries are available in the TOC@.
15508
15509 If you receive a linker error message that saying you have overflowed
15510 the available TOC space, you can reduce the amount of TOC space used
15511 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15512 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15513 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15514 generate code to calculate the sum of an address and a constant at
15515 run-time instead of putting that sum into the TOC@. You may specify one
15516 or both of these options. Each causes GCC to produce very slightly
15517 slower and larger code at the expense of conserving TOC space.
15518
15519 If you still run out of space in the TOC even when you specify both of
15520 these options, specify @option{-mminimal-toc} instead. This option causes
15521 GCC to make only one TOC entry for every file. When you specify this
15522 option, GCC will produce code that is slower and larger but which
15523 uses extremely little TOC space. You may wish to use this option
15524 only on files that contain less frequently executed code.
15525
15526 @item -maix64
15527 @itemx -maix32
15528 @opindex maix64
15529 @opindex maix32
15530 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15531 @code{long} type, and the infrastructure needed to support them.
15532 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15533 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15534 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
15535
15536 @item -mxl-compat
15537 @itemx -mno-xl-compat
15538 @opindex mxl-compat
15539 @opindex mno-xl-compat
15540 Produce code that conforms more closely to IBM XL compiler semantics
15541 when using AIX-compatible ABI@. Pass floating-point arguments to
15542 prototyped functions beyond the register save area (RSA) on the stack
15543 in addition to argument FPRs. Do not assume that most significant
15544 double in 128-bit long double value is properly rounded when comparing
15545 values and converting to double. Use XL symbol names for long double
15546 support routines.
15547
15548 The AIX calling convention was extended but not initially documented to
15549 handle an obscure K&R C case of calling a function that takes the
15550 address of its arguments with fewer arguments than declared. IBM XL
15551 compilers access floating point arguments which do not fit in the
15552 RSA from the stack when a subroutine is compiled without
15553 optimization. Because always storing floating-point arguments on the
15554 stack is inefficient and rarely needed, this option is not enabled by
15555 default and only is necessary when calling subroutines compiled by IBM
15556 XL compilers without optimization.
15557
15558 @item -mpe
15559 @opindex mpe
15560 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
15561 application written to use message passing with special startup code to
15562 enable the application to run. The system must have PE installed in the
15563 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15564 must be overridden with the @option{-specs=} option to specify the
15565 appropriate directory location. The Parallel Environment does not
15566 support threads, so the @option{-mpe} option and the @option{-pthread}
15567 option are incompatible.
15568
15569 @item -malign-natural
15570 @itemx -malign-power
15571 @opindex malign-natural
15572 @opindex malign-power
15573 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15574 @option{-malign-natural} overrides the ABI-defined alignment of larger
15575 types, such as floating-point doubles, on their natural size-based boundary.
15576 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15577 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
15578
15579 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15580 is not supported.
15581
15582 @item -msoft-float
15583 @itemx -mhard-float
15584 @opindex msoft-float
15585 @opindex mhard-float
15586 Generate code that does not use (uses) the floating-point register set.
15587 Software floating point emulation is provided if you use the
15588 @option{-msoft-float} option, and pass the option to GCC when linking.
15589
15590 @item -msingle-float
15591 @itemx -mdouble-float
15592 @opindex msingle-float
15593 @opindex mdouble-float
15594 Generate code for single or double-precision floating point operations.
15595 @option{-mdouble-float} implies @option{-msingle-float}.
15596
15597 @item -msimple-fpu
15598 @opindex msimple-fpu
15599 Do not generate sqrt and div instructions for hardware floating point unit.
15600
15601 @item -mfpu
15602 @opindex mfpu
15603 Specify type of floating point unit. Valid values are @var{sp_lite}
15604 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15605 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15606 and @var{dp_full} (equivalent to -mdouble-float).
15607
15608 @item -mxilinx-fpu
15609 @opindex mxilinx-fpu
15610 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15611
15612 @item -mmultiple
15613 @itemx -mno-multiple
15614 @opindex mmultiple
15615 @opindex mno-multiple
15616 Generate code that uses (does not use) the load multiple word
15617 instructions and the store multiple word instructions. These
15618 instructions are generated by default on POWER systems, and not
15619 generated on PowerPC systems. Do not use @option{-mmultiple} on little
15620 endian PowerPC systems, since those instructions do not work when the
15621 processor is in little endian mode. The exceptions are PPC740 and
15622 PPC750 which permit the instructions usage in little endian mode.
15623
15624 @item -mstring
15625 @itemx -mno-string
15626 @opindex mstring
15627 @opindex mno-string
15628 Generate code that uses (does not use) the load string instructions
15629 and the store string word instructions to save multiple registers and
15630 do small block moves. These instructions are generated by default on
15631 POWER systems, and not generated on PowerPC systems. Do not use
15632 @option{-mstring} on little endian PowerPC systems, since those
15633 instructions do not work when the processor is in little endian mode.
15634 The exceptions are PPC740 and PPC750 which permit the instructions
15635 usage in little endian mode.
15636
15637 @item -mupdate
15638 @itemx -mno-update
15639 @opindex mupdate
15640 @opindex mno-update
15641 Generate code that uses (does not use) the load or store instructions
15642 that update the base register to the address of the calculated memory
15643 location. These instructions are generated by default. If you use
15644 @option{-mno-update}, there is a small window between the time that the
15645 stack pointer is updated and the address of the previous frame is
15646 stored, which means code that walks the stack frame across interrupts or
15647 signals may get corrupted data.
15648
15649 @item -mavoid-indexed-addresses
15650 @itemx -mno-avoid-indexed-addresses
15651 @opindex mavoid-indexed-addresses
15652 @opindex mno-avoid-indexed-addresses
15653 Generate code that tries to avoid (not avoid) the use of indexed load
15654 or store instructions. These instructions can incur a performance
15655 penalty on Power6 processors in certain situations, such as when
15656 stepping through large arrays that cross a 16M boundary. This option
15657 is enabled by default when targetting Power6 and disabled otherwise.
15658
15659 @item -mfused-madd
15660 @itemx -mno-fused-madd
15661 @opindex mfused-madd
15662 @opindex mno-fused-madd
15663 Generate code that uses (does not use) the floating point multiply and
15664 accumulate instructions. These instructions are generated by default
15665 if hardware floating point is used. The machine dependent
15666 @option{-mfused-madd} option is now mapped to the machine independent
15667 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
15668 mapped to @option{-ffp-contract=off}.
15669
15670 @item -mmulhw
15671 @itemx -mno-mulhw
15672 @opindex mmulhw
15673 @opindex mno-mulhw
15674 Generate code that uses (does not use) the half-word multiply and
15675 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15676 These instructions are generated by default when targetting those
15677 processors.
15678
15679 @item -mdlmzb
15680 @itemx -mno-dlmzb
15681 @opindex mdlmzb
15682 @opindex mno-dlmzb
15683 Generate code that uses (does not use) the string-search @samp{dlmzb}
15684 instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
15685 generated by default when targetting those processors.
15686
15687 @item -mno-bit-align
15688 @itemx -mbit-align
15689 @opindex mno-bit-align
15690 @opindex mbit-align
15691 On System V.4 and embedded PowerPC systems do not (do) force structures
15692 and unions that contain bit-fields to be aligned to the base type of the
15693 bit-field.
15694
15695 For example, by default a structure containing nothing but 8
15696 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15697 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
15698 the structure would be aligned to a 1 byte boundary and be one byte in
15699 size.
15700
15701 @item -mno-strict-align
15702 @itemx -mstrict-align
15703 @opindex mno-strict-align
15704 @opindex mstrict-align
15705 On System V.4 and embedded PowerPC systems do not (do) assume that
15706 unaligned memory references will be handled by the system.
15707
15708 @item -mrelocatable
15709 @itemx -mno-relocatable
15710 @opindex mrelocatable
15711 @opindex mno-relocatable
15712 Generate code that allows (does not allow) a static executable to be
15713 relocated to a different address at runtime. A simple embedded
15714 PowerPC system loader should relocate the entire contents of
15715 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
15716 a table of 32-bit addresses generated by this option. For this to
15717 work, all objects linked together must be compiled with
15718 @option{-mrelocatable} or @option{-mrelocatable-lib}.
15719 @option{-mrelocatable} code aligns the stack to an 8 byte boundary.
15720
15721 @item -mrelocatable-lib
15722 @itemx -mno-relocatable-lib
15723 @opindex mrelocatable-lib
15724 @opindex mno-relocatable-lib
15725 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
15726 @code{.fixup} section to allow static executables to be relocated at
15727 runtime, but @option{-mrelocatable-lib} does not use the smaller stack
15728 alignment of @option{-mrelocatable}. Objects compiled with
15729 @option{-mrelocatable-lib} may be linked with objects compiled with
15730 any combination of the @option{-mrelocatable} options.
15731
15732 @item -mno-toc
15733 @itemx -mtoc
15734 @opindex mno-toc
15735 @opindex mtoc
15736 On System V.4 and embedded PowerPC systems do not (do) assume that
15737 register 2 contains a pointer to a global area pointing to the addresses
15738 used in the program.
15739
15740 @item -mlittle
15741 @itemx -mlittle-endian
15742 @opindex mlittle
15743 @opindex mlittle-endian
15744 On System V.4 and embedded PowerPC systems compile code for the
15745 processor in little endian mode. The @option{-mlittle-endian} option is
15746 the same as @option{-mlittle}.
15747
15748 @item -mbig
15749 @itemx -mbig-endian
15750 @opindex mbig
15751 @opindex mbig-endian
15752 On System V.4 and embedded PowerPC systems compile code for the
15753 processor in big endian mode. The @option{-mbig-endian} option is
15754 the same as @option{-mbig}.
15755
15756 @item -mdynamic-no-pic
15757 @opindex mdynamic-no-pic
15758 On Darwin and Mac OS X systems, compile code so that it is not
15759 relocatable, but that its external references are relocatable. The
15760 resulting code is suitable for applications, but not shared
15761 libraries.
15762
15763 @item -msingle-pic-base
15764 @opindex msingle-pic-base
15765 Treat the register used for PIC addressing as read-only, rather than
15766 loading it in the prologue for each function. The run-time system is
15767 responsible for initializing this register with an appropriate value
15768 before execution begins.
15769
15770 @item -mprioritize-restricted-insns=@var{priority}
15771 @opindex mprioritize-restricted-insns
15772 This option controls the priority that is assigned to
15773 dispatch-slot restricted instructions during the second scheduling
15774 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
15775 @var{no/highest/second-highest} priority to dispatch slot restricted
15776 instructions.
15777
15778 @item -msched-costly-dep=@var{dependence_type}
15779 @opindex msched-costly-dep
15780 This option controls which dependences are considered costly
15781 by the target during instruction scheduling. The argument
15782 @var{dependence_type} takes one of the following values:
15783 @var{no}: no dependence is costly,
15784 @var{all}: all dependences are costly,
15785 @var{true_store_to_load}: a true dependence from store to load is costly,
15786 @var{store_to_load}: any dependence from store to load is costly,
15787 @var{number}: any dependence which latency >= @var{number} is costly.
15788
15789 @item -minsert-sched-nops=@var{scheme}
15790 @opindex minsert-sched-nops
15791 This option controls which nop insertion scheme will be used during
15792 the second scheduling pass. The argument @var{scheme} takes one of the
15793 following values:
15794 @var{no}: Don't insert nops.
15795 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15796 according to the scheduler's grouping.
15797 @var{regroup_exact}: Insert nops to force costly dependent insns into
15798 separate groups. Insert exactly as many nops as needed to force an insn
15799 to a new group, according to the estimated processor grouping.
15800 @var{number}: Insert nops to force costly dependent insns into
15801 separate groups. Insert @var{number} nops to force an insn to a new group.
15802
15803 @item -mcall-sysv
15804 @opindex mcall-sysv
15805 On System V.4 and embedded PowerPC systems compile code using calling
15806 conventions that adheres to the March 1995 draft of the System V
15807 Application Binary Interface, PowerPC processor supplement. This is the
15808 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15809
15810 @item -mcall-sysv-eabi
15811 @itemx -mcall-eabi
15812 @opindex mcall-sysv-eabi
15813 @opindex mcall-eabi
15814 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15815
15816 @item -mcall-sysv-noeabi
15817 @opindex mcall-sysv-noeabi
15818 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15819
15820 @item -mcall-aixdesc
15821 @opindex m
15822 On System V.4 and embedded PowerPC systems compile code for the AIX
15823 operating system.
15824
15825 @item -mcall-linux
15826 @opindex mcall-linux
15827 On System V.4 and embedded PowerPC systems compile code for the
15828 Linux-based GNU system.
15829
15830 @item -mcall-gnu
15831 @opindex mcall-gnu
15832 On System V.4 and embedded PowerPC systems compile code for the
15833 Hurd-based GNU system.
15834
15835 @item -mcall-freebsd
15836 @opindex mcall-freebsd
15837 On System V.4 and embedded PowerPC systems compile code for the
15838 FreeBSD operating system.
15839
15840 @item -mcall-netbsd
15841 @opindex mcall-netbsd
15842 On System V.4 and embedded PowerPC systems compile code for the
15843 NetBSD operating system.
15844
15845 @item -mcall-openbsd
15846 @opindex mcall-netbsd
15847 On System V.4 and embedded PowerPC systems compile code for the
15848 OpenBSD operating system.
15849
15850 @item -maix-struct-return
15851 @opindex maix-struct-return
15852 Return all structures in memory (as specified by the AIX ABI)@.
15853
15854 @item -msvr4-struct-return
15855 @opindex msvr4-struct-return
15856 Return structures smaller than 8 bytes in registers (as specified by the
15857 SVR4 ABI)@.
15858
15859 @item -mabi=@var{abi-type}
15860 @opindex mabi
15861 Extend the current ABI with a particular extension, or remove such extension.
15862 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15863 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15864
15865 @item -mabi=spe
15866 @opindex mabi=spe
15867 Extend the current ABI with SPE ABI extensions. This does not change
15868 the default ABI, instead it adds the SPE ABI extensions to the current
15869 ABI@.
15870
15871 @item -mabi=no-spe
15872 @opindex mabi=no-spe
15873 Disable Booke SPE ABI extensions for the current ABI@.
15874
15875 @item -mabi=ibmlongdouble
15876 @opindex mabi=ibmlongdouble
15877 Change the current ABI to use IBM extended precision long double.
15878 This is a PowerPC 32-bit SYSV ABI option.
15879
15880 @item -mabi=ieeelongdouble
15881 @opindex mabi=ieeelongdouble
15882 Change the current ABI to use IEEE extended precision long double.
15883 This is a PowerPC 32-bit Linux ABI option.
15884
15885 @item -mprototype
15886 @itemx -mno-prototype
15887 @opindex mprototype
15888 @opindex mno-prototype
15889 On System V.4 and embedded PowerPC systems assume that all calls to
15890 variable argument functions are properly prototyped. Otherwise, the
15891 compiler must insert an instruction before every non prototyped call to
15892 set or clear bit 6 of the condition code register (@var{CR}) to
15893 indicate whether floating point values were passed in the floating point
15894 registers in case the function takes a variable arguments. With
15895 @option{-mprototype}, only calls to prototyped variable argument functions
15896 will set or clear the bit.
15897
15898 @item -msim
15899 @opindex msim
15900 On embedded PowerPC systems, assume that the startup module is called
15901 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15902 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}
15903 configurations.
15904
15905 @item -mmvme
15906 @opindex mmvme
15907 On embedded PowerPC systems, assume that the startup module is called
15908 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15909 @file{libc.a}.
15910
15911 @item -mads
15912 @opindex mads
15913 On embedded PowerPC systems, assume that the startup module is called
15914 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15915 @file{libc.a}.
15916
15917 @item -myellowknife
15918 @opindex myellowknife
15919 On embedded PowerPC systems, assume that the startup module is called
15920 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15921 @file{libc.a}.
15922
15923 @item -mvxworks
15924 @opindex mvxworks
15925 On System V.4 and embedded PowerPC systems, specify that you are
15926 compiling for a VxWorks system.
15927
15928 @item -memb
15929 @opindex memb
15930 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15931 header to indicate that @samp{eabi} extended relocations are used.
15932
15933 @item -meabi
15934 @itemx -mno-eabi
15935 @opindex meabi
15936 @opindex mno-eabi
15937 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15938 Embedded Applications Binary Interface (eabi) which is a set of
15939 modifications to the System V.4 specifications. Selecting @option{-meabi}
15940 means that the stack is aligned to an 8 byte boundary, a function
15941 @code{__eabi} is called to from @code{main} to set up the eabi
15942 environment, and the @option{-msdata} option can use both @code{r2} and
15943 @code{r13} to point to two separate small data areas. Selecting
15944 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15945 do not call an initialization function from @code{main}, and the
15946 @option{-msdata} option will only use @code{r13} to point to a single
15947 small data area. The @option{-meabi} option is on by default if you
15948 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15949
15950 @item -msdata=eabi
15951 @opindex msdata=eabi
15952 On System V.4 and embedded PowerPC systems, put small initialized
15953 @code{const} global and static data in the @samp{.sdata2} section, which
15954 is pointed to by register @code{r2}. Put small initialized
15955 non-@code{const} global and static data in the @samp{.sdata} section,
15956 which is pointed to by register @code{r13}. Put small uninitialized
15957 global and static data in the @samp{.sbss} section, which is adjacent to
15958 the @samp{.sdata} section. The @option{-msdata=eabi} option is
15959 incompatible with the @option{-mrelocatable} option. The
15960 @option{-msdata=eabi} option also sets the @option{-memb} option.
15961
15962 @item -msdata=sysv
15963 @opindex msdata=sysv
15964 On System V.4 and embedded PowerPC systems, put small global and static
15965 data in the @samp{.sdata} section, which is pointed to by register
15966 @code{r13}. Put small uninitialized global and static data in the
15967 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15968 The @option{-msdata=sysv} option is incompatible with the
15969 @option{-mrelocatable} option.
15970
15971 @item -msdata=default
15972 @itemx -msdata
15973 @opindex msdata=default
15974 @opindex msdata
15975 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15976 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15977 same as @option{-msdata=sysv}.
15978
15979 @item -msdata=data
15980 @opindex msdata=data
15981 On System V.4 and embedded PowerPC systems, put small global
15982 data in the @samp{.sdata} section. Put small uninitialized global
15983 data in the @samp{.sbss} section. Do not use register @code{r13}
15984 to address small data however. This is the default behavior unless
15985 other @option{-msdata} options are used.
15986
15987 @item -msdata=none
15988 @itemx -mno-sdata
15989 @opindex msdata=none
15990 @opindex mno-sdata
15991 On embedded PowerPC systems, put all initialized global and static data
15992 in the @samp{.data} section, and all uninitialized data in the
15993 @samp{.bss} section.
15994
15995 @item -mblock-move-inline-limit=@var{num}
15996 @opindex mblock-move-inline-limit
15997 Inline all block moves (such as calls to @code{memcpy} or structure
15998 copies) less than or equal to @var{num} bytes. The minimum value for
15999 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
16000 targets. The default value is target-specific.
16001
16002 @item -G @var{num}
16003 @opindex G
16004 @cindex smaller data references (PowerPC)
16005 @cindex .sdata/.sdata2 references (PowerPC)
16006 On embedded PowerPC systems, put global and static items less than or
16007 equal to @var{num} bytes into the small data or bss sections instead of
16008 the normal data or bss section. By default, @var{num} is 8. The
16009 @option{-G @var{num}} switch is also passed to the linker.
16010 All modules should be compiled with the same @option{-G @var{num}} value.
16011
16012 @item -mregnames
16013 @itemx -mno-regnames
16014 @opindex mregnames
16015 @opindex mno-regnames
16016 On System V.4 and embedded PowerPC systems do (do not) emit register
16017 names in the assembly language output using symbolic forms.
16018
16019 @item -mlongcall
16020 @itemx -mno-longcall
16021 @opindex mlongcall
16022 @opindex mno-longcall
16023 By default assume that all calls are far away so that a longer more
16024 expensive calling sequence is required. This is required for calls
16025 further than 32 megabytes (33,554,432 bytes) from the current location.
16026 A short call will be generated if the compiler knows
16027 the call cannot be that far away. This setting can be overridden by
16028 the @code{shortcall} function attribute, or by @code{#pragma
16029 longcall(0)}.
16030
16031 Some linkers are capable of detecting out-of-range calls and generating
16032 glue code on the fly. On these systems, long calls are unnecessary and
16033 generate slower code. As of this writing, the AIX linker can do this,
16034 as can the GNU linker for PowerPC/64. It is planned to add this feature
16035 to the GNU linker for 32-bit PowerPC systems as well.
16036
16037 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
16038 callee, L42'', plus a ``branch island'' (glue code). The two target
16039 addresses represent the callee and the ``branch island''. The
16040 Darwin/PPC linker will prefer the first address and generate a ``bl
16041 callee'' if the PPC ``bl'' instruction will reach the callee directly;
16042 otherwise, the linker will generate ``bl L42'' to call the ``branch
16043 island''. The ``branch island'' is appended to the body of the
16044 calling function; it computes the full 32-bit address of the callee
16045 and jumps to it.
16046
16047 On Mach-O (Darwin) systems, this option directs the compiler emit to
16048 the glue for every direct call, and the Darwin linker decides whether
16049 to use or discard it.
16050
16051 In the future, we may cause GCC to ignore all longcall specifications
16052 when the linker is known to generate glue.
16053
16054 @item -mtls-markers
16055 @itemx -mno-tls-markers
16056 @opindex mtls-markers
16057 @opindex mno-tls-markers
16058 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
16059 specifying the function argument. The relocation allows ld to
16060 reliably associate function call with argument setup instructions for
16061 TLS optimization, which in turn allows gcc to better schedule the
16062 sequence.
16063
16064 @item -pthread
16065 @opindex pthread
16066 Adds support for multithreading with the @dfn{pthreads} library.
16067 This option sets flags for both the preprocessor and linker.
16068
16069 @item -mrecip
16070 @itemx -mno-recip
16071 @opindex mrecip
16072 This option will enable GCC to use the reciprocal estimate and
16073 reciprocal square root estimate instructions with additional
16074 Newton-Raphson steps to increase precision instead of doing a divide or
16075 square root and divide for floating point arguments. You should use
16076 the @option{-ffast-math} option when using @option{-mrecip} (or at
16077 least @option{-funsafe-math-optimizations},
16078 @option{-finite-math-only}, @option{-freciprocal-math} and
16079 @option{-fno-trapping-math}). Note that while the throughput of the
16080 sequence is generally higher than the throughput of the non-reciprocal
16081 instruction, the precision of the sequence can be decreased by up to 2
16082 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
16083 roots.
16084
16085 @item -mrecip=@var{opt}
16086 @opindex mrecip=opt
16087 This option allows to control which reciprocal estimate instructions
16088 may be used. @var{opt} is a comma separated list of options, that may
16089 be preceded by a @code{!} to invert the option:
16090 @code{all}: enable all estimate instructions,
16091 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
16092 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
16093 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
16094 @code{divf}: enable the single precision reciprocal approximation instructions;
16095 @code{divd}: enable the double precision reciprocal approximation instructions;
16096 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
16097 @code{rsqrtf}: enable the single precision reciprocal square root approximation instructions;
16098 @code{rsqrtd}: enable the double precision reciprocal square root approximation instructions;
16099
16100 So for example, @option{-mrecip=all,!rsqrtd} would enable the
16101 all of the reciprocal estimate instructions, except for the
16102 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
16103 which handle the double precision reciprocal square root calculations.
16104
16105 @item -mrecip-precision
16106 @itemx -mno-recip-precision
16107 @opindex mrecip-precision
16108 Assume (do not assume) that the reciprocal estimate instructions
16109 provide higher precision estimates than is mandated by the powerpc
16110 ABI. Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
16111 automatically selects @option{-mrecip-precision}. The double
16112 precision square root estimate instructions are not generated by
16113 default on low precision machines, since they do not provide an
16114 estimate that converges after three steps.
16115
16116 @item -mveclibabi=@var{type}
16117 @opindex mveclibabi
16118 Specifies the ABI type to use for vectorizing intrinsics using an
16119 external library. The only type supported at present is @code{mass},
16120 which specifies to use IBM's Mathematical Acceleration Subsystem
16121 (MASS) libraries for vectorizing intrinsics using external libraries.
16122 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
16123 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
16124 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
16125 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
16126 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
16127 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
16128 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
16129 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
16130 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
16131 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
16132 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
16133 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
16134 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
16135 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
16136 for power7. Both @option{-ftree-vectorize} and
16137 @option{-funsafe-math-optimizations} have to be enabled. The MASS
16138 libraries will have to be specified at link time.
16139
16140 @item -mfriz
16141 @itemx -mno-friz
16142 @opindex mfriz
16143 Generate (do not generate) the @code{friz} instruction when the
16144 @option{-funsafe-math-optimizations} option is used to optimize
16145 rounding a floating point value to 64-bit integer and back to floating
16146 point. The @code{friz} instruction does not return the same value if
16147 the floating point number is too large to fit in an integer.
16148 @end table
16149
16150 @node RX Options
16151 @subsection RX Options
16152 @cindex RX Options
16153
16154 These command line options are defined for RX targets:
16155
16156 @table @gcctabopt
16157 @item -m64bit-doubles
16158 @itemx -m32bit-doubles
16159 @opindex m64bit-doubles
16160 @opindex m32bit-doubles
16161 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
16162 or 32-bits (@option{-m32bit-doubles}) in size. The default is
16163 @option{-m32bit-doubles}. @emph{Note} RX floating point hardware only
16164 works on 32-bit values, which is why the default is
16165 @option{-m32bit-doubles}.
16166
16167 @item -fpu
16168 @itemx -nofpu
16169 @opindex fpu
16170 @opindex nofpu
16171 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
16172 floating point hardware. The default is enabled for the @var{RX600}
16173 series and disabled for the @var{RX200} series.
16174
16175 Floating point instructions will only be generated for 32-bit floating
16176 point values however, so if the @option{-m64bit-doubles} option is in
16177 use then the FPU hardware will not be used for doubles.
16178
16179 @emph{Note} If the @option{-fpu} option is enabled then
16180 @option{-funsafe-math-optimizations} is also enabled automatically.
16181 This is because the RX FPU instructions are themselves unsafe.
16182
16183 @item -mcpu=@var{name}
16184 @opindex -mcpu
16185 Selects the type of RX CPU to be targeted. Currently three types are
16186 supported, the generic @var{RX600} and @var{RX200} series hardware and
16187 the specific @var{RX610} cpu. The default is @var{RX600}.
16188
16189 The only difference between @var{RX600} and @var{RX610} is that the
16190 @var{RX610} does not support the @code{MVTIPL} instruction.
16191
16192 The @var{RX200} series does not have a hardware floating point unit
16193 and so @option{-nofpu} is enabled by default when this type is
16194 selected.
16195
16196 @item -mbig-endian-data
16197 @itemx -mlittle-endian-data
16198 @opindex mbig-endian-data
16199 @opindex mlittle-endian-data
16200 Store data (but not code) in the big-endian format. The default is
16201 @option{-mlittle-endian-data}, i.e.@: to store data in the little endian
16202 format.
16203
16204 @item -msmall-data-limit=@var{N}
16205 @opindex msmall-data-limit
16206 Specifies the maximum size in bytes of global and static variables
16207 which can be placed into the small data area. Using the small data
16208 area can lead to smaller and faster code, but the size of area is
16209 limited and it is up to the programmer to ensure that the area does
16210 not overflow. Also when the small data area is used one of the RX's
16211 registers (@code{r13}) is reserved for use pointing to this area, so
16212 it is no longer available for use by the compiler. This could result
16213 in slower and/or larger code if variables which once could have been
16214 held in @code{r13} are now pushed onto the stack.
16215
16216 Note, common variables (variables which have not been initialised) and
16217 constants are not placed into the small data area as they are assigned
16218 to other sections in the output executable.
16219
16220 The default value is zero, which disables this feature. Note, this
16221 feature is not enabled by default with higher optimization levels
16222 (@option{-O2} etc) because of the potentially detrimental effects of
16223 reserving register @code{r13}. It is up to the programmer to
16224 experiment and discover whether this feature is of benefit to their
16225 program.
16226
16227 @item -msim
16228 @itemx -mno-sim
16229 @opindex msim
16230 @opindex mno-sim
16231 Use the simulator runtime. The default is to use the libgloss board
16232 specific runtime.
16233
16234 @item -mas100-syntax
16235 @itemx -mno-as100-syntax
16236 @opindex mas100-syntax
16237 @opindex mno-as100-syntax
16238 When generating assembler output use a syntax that is compatible with
16239 Renesas's AS100 assembler. This syntax can also be handled by the GAS
16240 assembler but it has some restrictions so generating it is not the
16241 default option.
16242
16243 @item -mmax-constant-size=@var{N}
16244 @opindex mmax-constant-size
16245 Specifies the maximum size, in bytes, of a constant that can be used as
16246 an operand in a RX instruction. Although the RX instruction set does
16247 allow constants of up to 4 bytes in length to be used in instructions,
16248 a longer value equates to a longer instruction. Thus in some
16249 circumstances it can be beneficial to restrict the size of constants
16250 that are used in instructions. Constants that are too big are instead
16251 placed into a constant pool and referenced via register indirection.
16252
16253 The value @var{N} can be between 0 and 4. A value of 0 (the default)
16254 or 4 means that constants of any size are allowed.
16255
16256 @item -mrelax
16257 @opindex mrelax
16258 Enable linker relaxation. Linker relaxation is a process whereby the
16259 linker will attempt to reduce the size of a program by finding shorter
16260 versions of various instructions. Disabled by default.
16261
16262 @item -mint-register=@var{N}
16263 @opindex mint-register
16264 Specify the number of registers to reserve for fast interrupt handler
16265 functions. The value @var{N} can be between 0 and 4. A value of 1
16266 means that register @code{r13} will be reserved for the exclusive use
16267 of fast interrupt handlers. A value of 2 reserves @code{r13} and
16268 @code{r12}. A value of 3 reserves @code{r13}, @code{r12} and
16269 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
16270 A value of 0, the default, does not reserve any registers.
16271
16272 @item -msave-acc-in-interrupts
16273 @opindex msave-acc-in-interrupts
16274 Specifies that interrupt handler functions should preserve the
16275 accumulator register. This is only necessary if normal code might use
16276 the accumulator register, for example because it performs 64-bit
16277 multiplications. The default is to ignore the accumulator as this
16278 makes the interrupt handlers faster.
16279
16280 @end table
16281
16282 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
16283 has special significance to the RX port when used with the
16284 @code{interrupt} function attribute. This attribute indicates a
16285 function intended to process fast interrupts. GCC will will ensure
16286 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
16287 and/or @code{r13} and only provided that the normal use of the
16288 corresponding registers have been restricted via the
16289 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
16290 options.
16291
16292 @node S/390 and zSeries Options
16293 @subsection S/390 and zSeries Options
16294 @cindex S/390 and zSeries Options
16295
16296 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
16297
16298 @table @gcctabopt
16299 @item -mhard-float
16300 @itemx -msoft-float
16301 @opindex mhard-float
16302 @opindex msoft-float
16303 Use (do not use) the hardware floating-point instructions and registers
16304 for floating-point operations. When @option{-msoft-float} is specified,
16305 functions in @file{libgcc.a} will be used to perform floating-point
16306 operations. When @option{-mhard-float} is specified, the compiler
16307 generates IEEE floating-point instructions. This is the default.
16308
16309 @item -mhard-dfp
16310 @itemx -mno-hard-dfp
16311 @opindex mhard-dfp
16312 @opindex mno-hard-dfp
16313 Use (do not use) the hardware decimal-floating-point instructions for
16314 decimal-floating-point operations. When @option{-mno-hard-dfp} is
16315 specified, functions in @file{libgcc.a} will be used to perform
16316 decimal-floating-point operations. When @option{-mhard-dfp} is
16317 specified, the compiler generates decimal-floating-point hardware
16318 instructions. This is the default for @option{-march=z9-ec} or higher.
16319
16320 @item -mlong-double-64
16321 @itemx -mlong-double-128
16322 @opindex mlong-double-64
16323 @opindex mlong-double-128
16324 These switches control the size of @code{long double} type. A size
16325 of 64bit makes the @code{long double} type equivalent to the @code{double}
16326 type. This is the default.
16327
16328 @item -mbackchain
16329 @itemx -mno-backchain
16330 @opindex mbackchain
16331 @opindex mno-backchain
16332 Store (do not store) the address of the caller's frame as backchain pointer
16333 into the callee's stack frame.
16334 A backchain may be needed to allow debugging using tools that do not understand
16335 DWARF-2 call frame information.
16336 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
16337 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
16338 the backchain is placed into the topmost word of the 96/160 byte register
16339 save area.
16340
16341 In general, code compiled with @option{-mbackchain} is call-compatible with
16342 code compiled with @option{-mmo-backchain}; however, use of the backchain
16343 for debugging purposes usually requires that the whole binary is built with
16344 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
16345 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
16346 to build a linux kernel use @option{-msoft-float}.
16347
16348 The default is to not maintain the backchain.
16349
16350 @item -mpacked-stack
16351 @itemx -mno-packed-stack
16352 @opindex mpacked-stack
16353 @opindex mno-packed-stack
16354 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
16355 specified, the compiler uses the all fields of the 96/160 byte register save
16356 area only for their default purpose; unused fields still take up stack space.
16357 When @option{-mpacked-stack} is specified, register save slots are densely
16358 packed at the top of the register save area; unused space is reused for other
16359 purposes, allowing for more efficient use of the available stack space.
16360 However, when @option{-mbackchain} is also in effect, the topmost word of
16361 the save area is always used to store the backchain, and the return address
16362 register is always saved two words below the backchain.
16363
16364 As long as the stack frame backchain is not used, code generated with
16365 @option{-mpacked-stack} is call-compatible with code generated with
16366 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
16367 S/390 or zSeries generated code that uses the stack frame backchain at run
16368 time, not just for debugging purposes. Such code is not call-compatible
16369 with code compiled with @option{-mpacked-stack}. Also, note that the
16370 combination of @option{-mbackchain},
16371 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
16372 to build a linux kernel use @option{-msoft-float}.
16373
16374 The default is to not use the packed stack layout.
16375
16376 @item -msmall-exec
16377 @itemx -mno-small-exec
16378 @opindex msmall-exec
16379 @opindex mno-small-exec
16380 Generate (or do not generate) code using the @code{bras} instruction
16381 to do subroutine calls.
16382 This only works reliably if the total executable size does not
16383 exceed 64k. The default is to use the @code{basr} instruction instead,
16384 which does not have this limitation.
16385
16386 @item -m64
16387 @itemx -m31
16388 @opindex m64
16389 @opindex m31
16390 When @option{-m31} is specified, generate code compliant to the
16391 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
16392 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
16393 particular to generate 64-bit instructions. For the @samp{s390}
16394 targets, the default is @option{-m31}, while the @samp{s390x}
16395 targets default to @option{-m64}.
16396
16397 @item -mzarch
16398 @itemx -mesa
16399 @opindex mzarch
16400 @opindex mesa
16401 When @option{-mzarch} is specified, generate code using the
16402 instructions available on z/Architecture.
16403 When @option{-mesa} is specified, generate code using the
16404 instructions available on ESA/390. Note that @option{-mesa} is
16405 not possible with @option{-m64}.
16406 When generating code compliant to the GNU/Linux for S/390 ABI,
16407 the default is @option{-mesa}. When generating code compliant
16408 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
16409
16410 @item -mmvcle
16411 @itemx -mno-mvcle
16412 @opindex mmvcle
16413 @opindex mno-mvcle
16414 Generate (or do not generate) code using the @code{mvcle} instruction
16415 to perform block moves. When @option{-mno-mvcle} is specified,
16416 use a @code{mvc} loop instead. This is the default unless optimizing for
16417 size.
16418
16419 @item -mdebug
16420 @itemx -mno-debug
16421 @opindex mdebug
16422 @opindex mno-debug
16423 Print (or do not print) additional debug information when compiling.
16424 The default is to not print debug information.
16425
16426 @item -march=@var{cpu-type}
16427 @opindex march
16428 Generate code that will run on @var{cpu-type}, which is the name of a system
16429 representing a certain processor type. Possible values for
16430 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
16431 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
16432 When generating code using the instructions available on z/Architecture,
16433 the default is @option{-march=z900}. Otherwise, the default is
16434 @option{-march=g5}.
16435
16436 @item -mtune=@var{cpu-type}
16437 @opindex mtune
16438 Tune to @var{cpu-type} everything applicable about the generated code,
16439 except for the ABI and the set of available instructions.
16440 The list of @var{cpu-type} values is the same as for @option{-march}.
16441 The default is the value used for @option{-march}.
16442
16443 @item -mtpf-trace
16444 @itemx -mno-tpf-trace
16445 @opindex mtpf-trace
16446 @opindex mno-tpf-trace
16447 Generate code that adds (does not add) in TPF OS specific branches to trace
16448 routines in the operating system. This option is off by default, even
16449 when compiling for the TPF OS@.
16450
16451 @item -mfused-madd
16452 @itemx -mno-fused-madd
16453 @opindex mfused-madd
16454 @opindex mno-fused-madd
16455 Generate code that uses (does not use) the floating point multiply and
16456 accumulate instructions. These instructions are generated by default if
16457 hardware floating point is used.
16458
16459 @item -mwarn-framesize=@var{framesize}
16460 @opindex mwarn-framesize
16461 Emit a warning if the current function exceeds the given frame size. Because
16462 this is a compile time check it doesn't need to be a real problem when the program
16463 runs. It is intended to identify functions which most probably cause
16464 a stack overflow. It is useful to be used in an environment with limited stack
16465 size e.g.@: the linux kernel.
16466
16467 @item -mwarn-dynamicstack
16468 @opindex mwarn-dynamicstack
16469 Emit a warning if the function calls alloca or uses dynamically
16470 sized arrays. This is generally a bad idea with a limited stack size.
16471
16472 @item -mstack-guard=@var{stack-guard}
16473 @itemx -mstack-size=@var{stack-size}
16474 @opindex mstack-guard
16475 @opindex mstack-size
16476 If these options are provided the s390 back end emits additional instructions in
16477 the function prologue which trigger a trap if the stack size is @var{stack-guard}
16478 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
16479 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
16480 the frame size of the compiled function is chosen.
16481 These options are intended to be used to help debugging stack overflow problems.
16482 The additionally emitted code causes only little overhead and hence can also be
16483 used in production like systems without greater performance degradation. The given
16484 values have to be exact powers of 2 and @var{stack-size} has to be greater than
16485 @var{stack-guard} without exceeding 64k.
16486 In order to be efficient the extra code makes the assumption that the stack starts
16487 at an address aligned to the value given by @var{stack-size}.
16488 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
16489 @end table
16490
16491 @node Score Options
16492 @subsection Score Options
16493 @cindex Score Options
16494
16495 These options are defined for Score implementations:
16496
16497 @table @gcctabopt
16498 @item -meb
16499 @opindex meb
16500 Compile code for big endian mode. This is the default.
16501
16502 @item -mel
16503 @opindex mel
16504 Compile code for little endian mode.
16505
16506 @item -mnhwloop
16507 @opindex mnhwloop
16508 Disable generate bcnz instruction.
16509
16510 @item -muls
16511 @opindex muls
16512 Enable generate unaligned load and store instruction.
16513
16514 @item -mmac
16515 @opindex mmac
16516 Enable the use of multiply-accumulate instructions. Disabled by default.
16517
16518 @item -mscore5
16519 @opindex mscore5
16520 Specify the SCORE5 as the target architecture.
16521
16522 @item -mscore5u
16523 @opindex mscore5u
16524 Specify the SCORE5U of the target architecture.
16525
16526 @item -mscore7
16527 @opindex mscore7
16528 Specify the SCORE7 as the target architecture. This is the default.
16529
16530 @item -mscore7d
16531 @opindex mscore7d
16532 Specify the SCORE7D as the target architecture.
16533 @end table
16534
16535 @node SH Options
16536 @subsection SH Options
16537
16538 These @samp{-m} options are defined for the SH implementations:
16539
16540 @table @gcctabopt
16541 @item -m1
16542 @opindex m1
16543 Generate code for the SH1.
16544
16545 @item -m2
16546 @opindex m2
16547 Generate code for the SH2.
16548
16549 @item -m2e
16550 Generate code for the SH2e.
16551
16552 @item -m2a-nofpu
16553 @opindex m2a-nofpu
16554 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
16555 that the floating-point unit is not used.
16556
16557 @item -m2a-single-only
16558 @opindex m2a-single-only
16559 Generate code for the SH2a-FPU, in such a way that no double-precision
16560 floating point operations are used.
16561
16562 @item -m2a-single
16563 @opindex m2a-single
16564 Generate code for the SH2a-FPU assuming the floating-point unit is in
16565 single-precision mode by default.
16566
16567 @item -m2a
16568 @opindex m2a
16569 Generate code for the SH2a-FPU assuming the floating-point unit is in
16570 double-precision mode by default.
16571
16572 @item -m3
16573 @opindex m3
16574 Generate code for the SH3.
16575
16576 @item -m3e
16577 @opindex m3e
16578 Generate code for the SH3e.
16579
16580 @item -m4-nofpu
16581 @opindex m4-nofpu
16582 Generate code for the SH4 without a floating-point unit.
16583
16584 @item -m4-single-only
16585 @opindex m4-single-only
16586 Generate code for the SH4 with a floating-point unit that only
16587 supports single-precision arithmetic.
16588
16589 @item -m4-single
16590 @opindex m4-single
16591 Generate code for the SH4 assuming the floating-point unit is in
16592 single-precision mode by default.
16593
16594 @item -m4
16595 @opindex m4
16596 Generate code for the SH4.
16597
16598 @item -m4a-nofpu
16599 @opindex m4a-nofpu
16600 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16601 floating-point unit is not used.
16602
16603 @item -m4a-single-only
16604 @opindex m4a-single-only
16605 Generate code for the SH4a, in such a way that no double-precision
16606 floating point operations are used.
16607
16608 @item -m4a-single
16609 @opindex m4a-single
16610 Generate code for the SH4a assuming the floating-point unit is in
16611 single-precision mode by default.
16612
16613 @item -m4a
16614 @opindex m4a
16615 Generate code for the SH4a.
16616
16617 @item -m4al
16618 @opindex m4al
16619 Same as @option{-m4a-nofpu}, except that it implicitly passes
16620 @option{-dsp} to the assembler. GCC doesn't generate any DSP
16621 instructions at the moment.
16622
16623 @item -mb
16624 @opindex mb
16625 Compile code for the processor in big endian mode.
16626
16627 @item -ml
16628 @opindex ml
16629 Compile code for the processor in little endian mode.
16630
16631 @item -mdalign
16632 @opindex mdalign
16633 Align doubles at 64-bit boundaries. Note that this changes the calling
16634 conventions, and thus some functions from the standard C library will
16635 not work unless you recompile it first with @option{-mdalign}.
16636
16637 @item -mrelax
16638 @opindex mrelax
16639 Shorten some address references at link time, when possible; uses the
16640 linker option @option{-relax}.
16641
16642 @item -mbigtable
16643 @opindex mbigtable
16644 Use 32-bit offsets in @code{switch} tables. The default is to use
16645 16-bit offsets.
16646
16647 @item -mbitops
16648 @opindex mbitops
16649 Enable the use of bit manipulation instructions on SH2A.
16650
16651 @item -mfmovd
16652 @opindex mfmovd
16653 Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for
16654 alignment constraints.
16655
16656 @item -mhitachi
16657 @opindex mhitachi
16658 Comply with the calling conventions defined by Renesas.
16659
16660 @item -mrenesas
16661 @opindex mhitachi
16662 Comply with the calling conventions defined by Renesas.
16663
16664 @item -mno-renesas
16665 @opindex mhitachi
16666 Comply with the calling conventions defined for GCC before the Renesas
16667 conventions were available. This option is the default for all
16668 targets of the SH toolchain except for @samp{sh-symbianelf}.
16669
16670 @item -mnomacsave
16671 @opindex mnomacsave
16672 Mark the @code{MAC} register as call-clobbered, even if
16673 @option{-mhitachi} is given.
16674
16675 @item -mieee
16676 @opindex mieee
16677 Increase IEEE-compliance of floating-point code.
16678 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16679 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16680 comparisons of NANs / infinities incurs extra overhead in every
16681 floating point comparison, therefore the default is set to
16682 @option{-ffinite-math-only}.
16683
16684 @item -minline-ic_invalidate
16685 @opindex minline-ic_invalidate
16686 Inline code to invalidate instruction cache entries after setting up
16687 nested function trampolines.
16688 This option has no effect if -musermode is in effect and the selected
16689 code generation option (e.g. -m4) does not allow the use of the icbi
16690 instruction.
16691 If the selected code generation option does not allow the use of the icbi
16692 instruction, and -musermode is not in effect, the inlined code will
16693 manipulate the instruction cache address array directly with an associative
16694 write. This not only requires privileged mode, but it will also
16695 fail if the cache line had been mapped via the TLB and has become unmapped.
16696
16697 @item -misize
16698 @opindex misize
16699 Dump instruction size and location in the assembly code.
16700
16701 @item -mpadstruct
16702 @opindex mpadstruct
16703 This option is deprecated. It pads structures to multiple of 4 bytes,
16704 which is incompatible with the SH ABI@.
16705
16706 @item -mspace
16707 @opindex mspace
16708 Optimize for space instead of speed. Implied by @option{-Os}.
16709
16710 @item -mprefergot
16711 @opindex mprefergot
16712 When generating position-independent code, emit function calls using
16713 the Global Offset Table instead of the Procedure Linkage Table.
16714
16715 @item -musermode
16716 @opindex musermode
16717 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16718 if the inlined code would not work in user mode.
16719 This is the default when the target is @code{sh-*-linux*}.
16720
16721 @item -multcost=@var{number}
16722 @opindex multcost=@var{number}
16723 Set the cost to assume for a multiply insn.
16724
16725 @item -mdiv=@var{strategy}
16726 @opindex mdiv=@var{strategy}
16727 Set the division strategy to use for SHmedia code. @var{strategy} must be
16728 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16729 inv:call2, inv:fp .
16730 "fp" performs the operation in floating point. This has a very high latency,
16731 but needs only a few instructions, so it might be a good choice if
16732 your code has enough easily exploitable ILP to allow the compiler to
16733 schedule the floating point instructions together with other instructions.
16734 Division by zero causes a floating point exception.
16735 "inv" uses integer operations to calculate the inverse of the divisor,
16736 and then multiplies the dividend with the inverse. This strategy allows
16737 cse and hoisting of the inverse calculation. Division by zero calculates
16738 an unspecified result, but does not trap.
16739 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16740 have been found, or if the entire operation has been hoisted to the same
16741 place, the last stages of the inverse calculation are intertwined with the
16742 final multiply to reduce the overall latency, at the expense of using a few
16743 more instructions, and thus offering fewer scheduling opportunities with
16744 other code.
16745 "call" calls a library function that usually implements the inv:minlat
16746 strategy.
16747 This gives high code density for m5-*media-nofpu compilations.
16748 "call2" uses a different entry point of the same library function, where it
16749 assumes that a pointer to a lookup table has already been set up, which
16750 exposes the pointer load to cse / code hoisting optimizations.
16751 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16752 code generation, but if the code stays unoptimized, revert to the "call",
16753 "call2", or "fp" strategies, respectively. Note that the
16754 potentially-trapping side effect of division by zero is carried by a
16755 separate instruction, so it is possible that all the integer instructions
16756 are hoisted out, but the marker for the side effect stays where it is.
16757 A recombination to fp operations or a call is not possible in that case.
16758 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
16759 that the inverse calculation was nor separated from the multiply, they speed
16760 up division where the dividend fits into 20 bits (plus sign where applicable),
16761 by inserting a test to skip a number of operations in this case; this test
16762 slows down the case of larger dividends. inv20u assumes the case of a such
16763 a small dividend to be unlikely, and inv20l assumes it to be likely.
16764
16765 @item -maccumulate-outgoing-args
16766 @opindex maccumulate-outgoing-args
16767 Reserve space once for outgoing arguments in the function prologue rather
16768 than around each call. Generally beneficial for performance and size. Also
16769 needed for unwinding to avoid changing the stack frame around conditional code.
16770
16771 @item -mdivsi3_libfunc=@var{name}
16772 @opindex mdivsi3_libfunc=@var{name}
16773 Set the name of the library function used for 32 bit signed division to
16774 @var{name}. This only affect the name used in the call and inv:call
16775 division strategies, and the compiler will still expect the same
16776 sets of input/output/clobbered registers as if this option was not present.
16777
16778 @item -mfixed-range=@var{register-range}
16779 @opindex mfixed-range
16780 Generate code treating the given register range as fixed registers.
16781 A fixed register is one that the register allocator can not use. This is
16782 useful when compiling kernel code. A register range is specified as
16783 two registers separated by a dash. Multiple register ranges can be
16784 specified separated by a comma.
16785
16786 @item -madjust-unroll
16787 @opindex madjust-unroll
16788 Throttle unrolling to avoid thrashing target registers.
16789 This option only has an effect if the gcc code base supports the
16790 TARGET_ADJUST_UNROLL_MAX target hook.
16791
16792 @item -mindexed-addressing
16793 @opindex mindexed-addressing
16794 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16795 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16796 semantics for the indexed addressing mode. The architecture allows the
16797 implementation of processors with 64 bit MMU, which the OS could use to
16798 get 32 bit addressing, but since no current hardware implementation supports
16799 this or any other way to make the indexed addressing mode safe to use in
16800 the 32 bit ABI, the default is -mno-indexed-addressing.
16801
16802 @item -mgettrcost=@var{number}
16803 @opindex mgettrcost=@var{number}
16804 Set the cost assumed for the gettr instruction to @var{number}.
16805 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16806
16807 @item -mpt-fixed
16808 @opindex mpt-fixed
16809 Assume pt* instructions won't trap. This will generally generate better
16810 scheduled code, but is unsafe on current hardware. The current architecture
16811 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16812 This has the unintentional effect of making it unsafe to schedule ptabs /
16813 ptrel before a branch, or hoist it out of a loop. For example,
16814 __do_global_ctors, a part of libgcc that runs constructors at program
16815 startup, calls functions in a list which is delimited by @minus{}1. With the
16816 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16817 That means that all the constructors will be run a bit quicker, but when
16818 the loop comes to the end of the list, the program crashes because ptabs
16819 loads @minus{}1 into a target register. Since this option is unsafe for any
16820 hardware implementing the current architecture specification, the default
16821 is -mno-pt-fixed. Unless the user specifies a specific cost with
16822 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16823 this deters register allocation using target registers for storing
16824 ordinary integers.
16825
16826 @item -minvalid-symbols
16827 @opindex minvalid-symbols
16828 Assume symbols might be invalid. Ordinary function symbols generated by
16829 the compiler will always be valid to load with movi/shori/ptabs or
16830 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16831 to generate symbols that will cause ptabs / ptrel to trap.
16832 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16833 It will then prevent cross-basic-block cse, hoisting and most scheduling
16834 of symbol loads. The default is @option{-mno-invalid-symbols}.
16835 @end table
16836
16837 @node Solaris 2 Options
16838 @subsection Solaris 2 Options
16839 @cindex Solaris 2 options
16840
16841 These @samp{-m} options are supported on Solaris 2:
16842
16843 @table @gcctabopt
16844 @item -mimpure-text
16845 @opindex mimpure-text
16846 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16847 the compiler to not pass @option{-z text} to the linker when linking a
16848 shared object. Using this option, you can link position-dependent
16849 code into a shared object.
16850
16851 @option{-mimpure-text} suppresses the ``relocations remain against
16852 allocatable but non-writable sections'' linker error message.
16853 However, the necessary relocations will trigger copy-on-write, and the
16854 shared object is not actually shared across processes. Instead of
16855 using @option{-mimpure-text}, you should compile all source code with
16856 @option{-fpic} or @option{-fPIC}.
16857
16858 @end table
16859
16860 These switches are supported in addition to the above on Solaris 2:
16861
16862 @table @gcctabopt
16863 @item -threads
16864 @opindex threads
16865 Add support for multithreading using the Solaris threads library. This
16866 option sets flags for both the preprocessor and linker. This option does
16867 not affect the thread safety of object code produced by the compiler or
16868 that of libraries supplied with it.
16869
16870 @item -pthreads
16871 @opindex pthreads
16872 Add support for multithreading using the POSIX threads library. This
16873 option sets flags for both the preprocessor and linker. This option does
16874 not affect the thread safety of object code produced by the compiler or
16875 that of libraries supplied with it.
16876
16877 @item -pthread
16878 @opindex pthread
16879 This is a synonym for @option{-pthreads}.
16880 @end table
16881
16882 @node SPARC Options
16883 @subsection SPARC Options
16884 @cindex SPARC options
16885
16886 These @samp{-m} options are supported on the SPARC:
16887
16888 @table @gcctabopt
16889 @item -mno-app-regs
16890 @itemx -mapp-regs
16891 @opindex mno-app-regs
16892 @opindex mapp-regs
16893 Specify @option{-mapp-regs} to generate output using the global registers
16894 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
16895 is the default.
16896
16897 To be fully SVR4 ABI compliant at the cost of some performance loss,
16898 specify @option{-mno-app-regs}. You should compile libraries and system
16899 software with this option.
16900
16901 @item -mfpu
16902 @itemx -mhard-float
16903 @opindex mfpu
16904 @opindex mhard-float
16905 Generate output containing floating point instructions. This is the
16906 default.
16907
16908 @item -mno-fpu
16909 @itemx -msoft-float
16910 @opindex mno-fpu
16911 @opindex msoft-float
16912 Generate output containing library calls for floating point.
16913 @strong{Warning:} the requisite libraries are not available for all SPARC
16914 targets. Normally the facilities of the machine's usual C compiler are
16915 used, but this cannot be done directly in cross-compilation. You must make
16916 your own arrangements to provide suitable library functions for
16917 cross-compilation. The embedded targets @samp{sparc-*-aout} and
16918 @samp{sparclite-*-*} do provide software floating point support.
16919
16920 @option{-msoft-float} changes the calling convention in the output file;
16921 therefore, it is only useful if you compile @emph{all} of a program with
16922 this option. In particular, you need to compile @file{libgcc.a}, the
16923 library that comes with GCC, with @option{-msoft-float} in order for
16924 this to work.
16925
16926 @item -mhard-quad-float
16927 @opindex mhard-quad-float
16928 Generate output containing quad-word (long double) floating point
16929 instructions.
16930
16931 @item -msoft-quad-float
16932 @opindex msoft-quad-float
16933 Generate output containing library calls for quad-word (long double)
16934 floating point instructions. The functions called are those specified
16935 in the SPARC ABI@. This is the default.
16936
16937 As of this writing, there are no SPARC implementations that have hardware
16938 support for the quad-word floating point instructions. They all invoke
16939 a trap handler for one of these instructions, and then the trap handler
16940 emulates the effect of the instruction. Because of the trap handler overhead,
16941 this is much slower than calling the ABI library routines. Thus the
16942 @option{-msoft-quad-float} option is the default.
16943
16944 @item -mno-unaligned-doubles
16945 @itemx -munaligned-doubles
16946 @opindex mno-unaligned-doubles
16947 @opindex munaligned-doubles
16948 Assume that doubles have 8 byte alignment. This is the default.
16949
16950 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16951 alignment only if they are contained in another type, or if they have an
16952 absolute address. Otherwise, it assumes they have 4 byte alignment.
16953 Specifying this option avoids some rare compatibility problems with code
16954 generated by other compilers. It is not the default because it results
16955 in a performance loss, especially for floating point code.
16956
16957 @item -mno-faster-structs
16958 @itemx -mfaster-structs
16959 @opindex mno-faster-structs
16960 @opindex mfaster-structs
16961 With @option{-mfaster-structs}, the compiler assumes that structures
16962 should have 8 byte alignment. This enables the use of pairs of
16963 @code{ldd} and @code{std} instructions for copies in structure
16964 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16965 However, the use of this changed alignment directly violates the SPARC
16966 ABI@. Thus, it's intended only for use on targets where the developer
16967 acknowledges that their resulting code will not be directly in line with
16968 the rules of the ABI@.
16969
16970 @item -mcpu=@var{cpu_type}
16971 @opindex mcpu
16972 Set the instruction set, register set, and instruction scheduling parameters
16973 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
16974 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
16975 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
16976 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16977 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16978
16979 Default instruction scheduling parameters are used for values that select
16980 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
16981 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16982
16983 Here is a list of each supported architecture and their supported
16984 implementations.
16985
16986 @smallexample
16987 v7: cypress
16988 v8: supersparc, hypersparc, leon
16989 sparclite: f930, f934, sparclite86x
16990 sparclet: tsc701
16991 v9: ultrasparc, ultrasparc3, niagara, niagara2
16992 @end smallexample
16993
16994 By default (unless configured otherwise), GCC generates code for the V7
16995 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
16996 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16997 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
16998 SPARCStation 1, 2, IPX etc.
16999
17000 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
17001 architecture. The only difference from V7 code is that the compiler emits
17002 the integer multiply and integer divide instructions which exist in SPARC-V8
17003 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
17004 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
17005 2000 series.
17006
17007 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
17008 the SPARC architecture. This adds the integer multiply, integer divide step
17009 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
17010 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
17011 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
17012 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
17013 MB86934 chip, which is the more recent SPARClite with FPU@.
17014
17015 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
17016 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
17017 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
17018 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
17019 optimizes it for the TEMIC SPARClet chip.
17020
17021 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
17022 architecture. This adds 64-bit integer and floating-point move instructions,
17023 3 additional floating-point condition code registers and conditional move
17024 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
17025 optimizes it for the Sun UltraSPARC I/II/IIi chips. With
17026 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
17027 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With
17028 @option{-mcpu=niagara}, the compiler additionally optimizes it for
17029 Sun UltraSPARC T1 chips. With @option{-mcpu=niagara2}, the compiler
17030 additionally optimizes it for Sun UltraSPARC T2 chips.
17031
17032 @item -mtune=@var{cpu_type}
17033 @opindex mtune
17034 Set the instruction scheduling parameters for machine type
17035 @var{cpu_type}, but do not set the instruction set or register set that the
17036 option @option{-mcpu=@var{cpu_type}} would.
17037
17038 The same values for @option{-mcpu=@var{cpu_type}} can be used for
17039 @option{-mtune=@var{cpu_type}}, but the only useful values are those
17040 that select a particular cpu implementation. Those are @samp{cypress},
17041 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
17042 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
17043 @samp{niagara}, and @samp{niagara2}.
17044
17045 @item -mv8plus
17046 @itemx -mno-v8plus
17047 @opindex mv8plus
17048 @opindex mno-v8plus
17049 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
17050 difference from the V8 ABI is that the global and out registers are
17051 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
17052 mode for all SPARC-V9 processors.
17053
17054 @item -mvis
17055 @itemx -mno-vis
17056 @opindex mvis
17057 @opindex mno-vis
17058 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
17059 Visual Instruction Set extensions. The default is @option{-mno-vis}.
17060 @end table
17061
17062 These @samp{-m} options are supported in addition to the above
17063 on SPARC-V9 processors in 64-bit environments:
17064
17065 @table @gcctabopt
17066 @item -mlittle-endian
17067 @opindex mlittle-endian
17068 Generate code for a processor running in little-endian mode. It is only
17069 available for a few configurations and most notably not on Solaris and Linux.
17070
17071 @item -m32
17072 @itemx -m64
17073 @opindex m32
17074 @opindex m64
17075 Generate code for a 32-bit or 64-bit environment.
17076 The 32-bit environment sets int, long and pointer to 32 bits.
17077 The 64-bit environment sets int to 32 bits and long and pointer
17078 to 64 bits.
17079
17080 @item -mcmodel=medlow
17081 @opindex mcmodel=medlow
17082 Generate code for the Medium/Low code model: 64-bit addresses, programs
17083 must be linked in the low 32 bits of memory. Programs can be statically
17084 or dynamically linked.
17085
17086 @item -mcmodel=medmid
17087 @opindex mcmodel=medmid
17088 Generate code for the Medium/Middle code model: 64-bit addresses, programs
17089 must be linked in the low 44 bits of memory, the text and data segments must
17090 be less than 2GB in size and the data segment must be located within 2GB of
17091 the text segment.
17092
17093 @item -mcmodel=medany
17094 @opindex mcmodel=medany
17095 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
17096 may be linked anywhere in memory, the text and data segments must be less
17097 than 2GB in size and the data segment must be located within 2GB of the
17098 text segment.
17099
17100 @item -mcmodel=embmedany
17101 @opindex mcmodel=embmedany
17102 Generate code for the Medium/Anywhere code model for embedded systems:
17103 64-bit addresses, the text and data segments must be less than 2GB in
17104 size, both starting anywhere in memory (determined at link time). The
17105 global register %g4 points to the base of the data segment. Programs
17106 are statically linked and PIC is not supported.
17107
17108 @item -mstack-bias
17109 @itemx -mno-stack-bias
17110 @opindex mstack-bias
17111 @opindex mno-stack-bias
17112 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
17113 frame pointer if present, are offset by @minus{}2047 which must be added back
17114 when making stack frame references. This is the default in 64-bit mode.
17115 Otherwise, assume no such offset is present.
17116 @end table
17117
17118 @node SPU Options
17119 @subsection SPU Options
17120 @cindex SPU options
17121
17122 These @samp{-m} options are supported on the SPU:
17123
17124 @table @gcctabopt
17125 @item -mwarn-reloc
17126 @itemx -merror-reloc
17127 @opindex mwarn-reloc
17128 @opindex merror-reloc
17129
17130 The loader for SPU does not handle dynamic relocations. By default, GCC
17131 will give an error when it generates code that requires a dynamic
17132 relocation. @option{-mno-error-reloc} disables the error,
17133 @option{-mwarn-reloc} will generate a warning instead.
17134
17135 @item -msafe-dma
17136 @itemx -munsafe-dma
17137 @opindex msafe-dma
17138 @opindex munsafe-dma
17139
17140 Instructions which initiate or test completion of DMA must not be
17141 reordered with respect to loads and stores of the memory which is being
17142 accessed. Users typically address this problem using the volatile
17143 keyword, but that can lead to inefficient code in places where the
17144 memory is known to not change. Rather than mark the memory as volatile
17145 we treat the DMA instructions as potentially effecting all memory. With
17146 @option{-munsafe-dma} users must use the volatile keyword to protect
17147 memory accesses.
17148
17149 @item -mbranch-hints
17150 @opindex mbranch-hints
17151
17152 By default, GCC will generate a branch hint instruction to avoid
17153 pipeline stalls for always taken or probably taken branches. A hint
17154 will not be generated closer than 8 instructions away from its branch.
17155 There is little reason to disable them, except for debugging purposes,
17156 or to make an object a little bit smaller.
17157
17158 @item -msmall-mem
17159 @itemx -mlarge-mem
17160 @opindex msmall-mem
17161 @opindex mlarge-mem
17162
17163 By default, GCC generates code assuming that addresses are never larger
17164 than 18 bits. With @option{-mlarge-mem} code is generated that assumes
17165 a full 32 bit address.
17166
17167 @item -mstdmain
17168 @opindex mstdmain
17169
17170 By default, GCC links against startup code that assumes the SPU-style
17171 main function interface (which has an unconventional parameter list).
17172 With @option{-mstdmain}, GCC will link your program against startup
17173 code that assumes a C99-style interface to @code{main}, including a
17174 local copy of @code{argv} strings.
17175
17176 @item -mfixed-range=@var{register-range}
17177 @opindex mfixed-range
17178 Generate code treating the given register range as fixed registers.
17179 A fixed register is one that the register allocator can not use. This is
17180 useful when compiling kernel code. A register range is specified as
17181 two registers separated by a dash. Multiple register ranges can be
17182 specified separated by a comma.
17183
17184 @item -mea32
17185 @itemx -mea64
17186 @opindex mea32
17187 @opindex mea64
17188 Compile code assuming that pointers to the PPU address space accessed
17189 via the @code{__ea} named address space qualifier are either 32 or 64
17190 bits wide. The default is 32 bits. As this is an ABI changing option,
17191 all object code in an executable must be compiled with the same setting.
17192
17193 @item -maddress-space-conversion
17194 @itemx -mno-address-space-conversion
17195 @opindex maddress-space-conversion
17196 @opindex mno-address-space-conversion
17197 Allow/disallow treating the @code{__ea} address space as superset
17198 of the generic address space. This enables explicit type casts
17199 between @code{__ea} and generic pointer as well as implicit
17200 conversions of generic pointers to @code{__ea} pointers. The
17201 default is to allow address space pointer conversions.
17202
17203 @item -mcache-size=@var{cache-size}
17204 @opindex mcache-size
17205 This option controls the version of libgcc that the compiler links to an
17206 executable and selects a software-managed cache for accessing variables
17207 in the @code{__ea} address space with a particular cache size. Possible
17208 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
17209 and @samp{128}. The default cache size is 64KB.
17210
17211 @item -matomic-updates
17212 @itemx -mno-atomic-updates
17213 @opindex matomic-updates
17214 @opindex mno-atomic-updates
17215 This option controls the version of libgcc that the compiler links to an
17216 executable and selects whether atomic updates to the software-managed
17217 cache of PPU-side variables are used. If you use atomic updates, changes
17218 to a PPU variable from SPU code using the @code{__ea} named address space
17219 qualifier will not interfere with changes to other PPU variables residing
17220 in the same cache line from PPU code. If you do not use atomic updates,
17221 such interference may occur; however, writing back cache lines will be
17222 more efficient. The default behavior is to use atomic updates.
17223
17224 @item -mdual-nops
17225 @itemx -mdual-nops=@var{n}
17226 @opindex mdual-nops
17227 By default, GCC will insert nops to increase dual issue when it expects
17228 it to increase performance. @var{n} can be a value from 0 to 10. A
17229 smaller @var{n} will insert fewer nops. 10 is the default, 0 is the
17230 same as @option{-mno-dual-nops}. Disabled with @option{-Os}.
17231
17232 @item -mhint-max-nops=@var{n}
17233 @opindex mhint-max-nops
17234 Maximum number of nops to insert for a branch hint. A branch hint must
17235 be at least 8 instructions away from the branch it is effecting. GCC
17236 will insert up to @var{n} nops to enforce this, otherwise it will not
17237 generate the branch hint.
17238
17239 @item -mhint-max-distance=@var{n}
17240 @opindex mhint-max-distance
17241 The encoding of the branch hint instruction limits the hint to be within
17242 256 instructions of the branch it is effecting. By default, GCC makes
17243 sure it is within 125.
17244
17245 @item -msafe-hints
17246 @opindex msafe-hints
17247 Work around a hardware bug which causes the SPU to stall indefinitely.
17248 By default, GCC will insert the @code{hbrp} instruction to make sure
17249 this stall won't happen.
17250
17251 @end table
17252
17253 @node System V Options
17254 @subsection Options for System V
17255
17256 These additional options are available on System V Release 4 for
17257 compatibility with other compilers on those systems:
17258
17259 @table @gcctabopt
17260 @item -G
17261 @opindex G
17262 Create a shared object.
17263 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
17264
17265 @item -Qy
17266 @opindex Qy
17267 Identify the versions of each tool used by the compiler, in a
17268 @code{.ident} assembler directive in the output.
17269
17270 @item -Qn
17271 @opindex Qn
17272 Refrain from adding @code{.ident} directives to the output file (this is
17273 the default).
17274
17275 @item -YP,@var{dirs}
17276 @opindex YP
17277 Search the directories @var{dirs}, and no others, for libraries
17278 specified with @option{-l}.
17279
17280 @item -Ym,@var{dir}
17281 @opindex Ym
17282 Look in the directory @var{dir} to find the M4 preprocessor.
17283 The assembler uses this option.
17284 @c This is supposed to go with a -Yd for predefined M4 macro files, but
17285 @c the generic assembler that comes with Solaris takes just -Ym.
17286 @end table
17287
17288 @node V850 Options
17289 @subsection V850 Options
17290 @cindex V850 Options
17291
17292 These @samp{-m} options are defined for V850 implementations:
17293
17294 @table @gcctabopt
17295 @item -mlong-calls
17296 @itemx -mno-long-calls
17297 @opindex mlong-calls
17298 @opindex mno-long-calls
17299 Treat all calls as being far away (near). If calls are assumed to be
17300 far away, the compiler will always load the functions address up into a
17301 register, and call indirect through the pointer.
17302
17303 @item -mno-ep
17304 @itemx -mep
17305 @opindex mno-ep
17306 @opindex mep
17307 Do not optimize (do optimize) basic blocks that use the same index
17308 pointer 4 or more times to copy pointer into the @code{ep} register, and
17309 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
17310 option is on by default if you optimize.
17311
17312 @item -mno-prolog-function
17313 @itemx -mprolog-function
17314 @opindex mno-prolog-function
17315 @opindex mprolog-function
17316 Do not use (do use) external functions to save and restore registers
17317 at the prologue and epilogue of a function. The external functions
17318 are slower, but use less code space if more than one function saves
17319 the same number of registers. The @option{-mprolog-function} option
17320 is on by default if you optimize.
17321
17322 @item -mspace
17323 @opindex mspace
17324 Try to make the code as small as possible. At present, this just turns
17325 on the @option{-mep} and @option{-mprolog-function} options.
17326
17327 @item -mtda=@var{n}
17328 @opindex mtda
17329 Put static or global variables whose size is @var{n} bytes or less into
17330 the tiny data area that register @code{ep} points to. The tiny data
17331 area can hold up to 256 bytes in total (128 bytes for byte references).
17332
17333 @item -msda=@var{n}
17334 @opindex msda
17335 Put static or global variables whose size is @var{n} bytes or less into
17336 the small data area that register @code{gp} points to. The small data
17337 area can hold up to 64 kilobytes.
17338
17339 @item -mzda=@var{n}
17340 @opindex mzda
17341 Put static or global variables whose size is @var{n} bytes or less into
17342 the first 32 kilobytes of memory.
17343
17344 @item -mv850
17345 @opindex mv850
17346 Specify that the target processor is the V850.
17347
17348 @item -mbig-switch
17349 @opindex mbig-switch
17350 Generate code suitable for big switch tables. Use this option only if
17351 the assembler/linker complain about out of range branches within a switch
17352 table.
17353
17354 @item -mapp-regs
17355 @opindex mapp-regs
17356 This option will cause r2 and r5 to be used in the code generated by
17357 the compiler. This setting is the default.
17358
17359 @item -mno-app-regs
17360 @opindex mno-app-regs
17361 This option will cause r2 and r5 to be treated as fixed registers.
17362
17363 @item -mv850e2v3
17364 @opindex mv850e2v3
17365 Specify that the target processor is the V850E2V3. The preprocessor
17366 constants @samp{__v850e2v3__} will be defined if
17367 this option is used.
17368
17369 @item -mv850e2
17370 @opindex mv850e2
17371 Specify that the target processor is the V850E2. The preprocessor
17372 constants @samp{__v850e2__} will be defined if
17373
17374 @item -mv850e1
17375 @opindex mv850e1
17376 Specify that the target processor is the V850E1. The preprocessor
17377 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
17378
17379 @item -mv850e
17380 @opindex mv850e
17381 Specify that the target processor is the V850E@. The preprocessor
17382 constant @samp{__v850e__} will be defined if this option is used.
17383
17384 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
17385 nor @option{-mv850e2} nor @option{-mv850e2v3}
17386 are defined then a default target processor will be chosen and the
17387 relevant @samp{__v850*__} preprocessor constant will be defined.
17388
17389 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
17390 defined, regardless of which processor variant is the target.
17391
17392 @item -mdisable-callt
17393 @opindex mdisable-callt
17394 This option will suppress generation of the CALLT instruction for the
17395 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture. The default is
17396 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
17397
17398 @end table
17399
17400 @node VAX Options
17401 @subsection VAX Options
17402 @cindex VAX options
17403
17404 These @samp{-m} options are defined for the VAX:
17405
17406 @table @gcctabopt
17407 @item -munix
17408 @opindex munix
17409 Do not output certain jump instructions (@code{aobleq} and so on)
17410 that the Unix assembler for the VAX cannot handle across long
17411 ranges.
17412
17413 @item -mgnu
17414 @opindex mgnu
17415 Do output those jump instructions, on the assumption that you
17416 will assemble with the GNU assembler.
17417
17418 @item -mg
17419 @opindex mg
17420 Output code for g-format floating point numbers instead of d-format.
17421 @end table
17422
17423 @node VxWorks Options
17424 @subsection VxWorks Options
17425 @cindex VxWorks Options
17426
17427 The options in this section are defined for all VxWorks targets.
17428 Options specific to the target hardware are listed with the other
17429 options for that target.
17430
17431 @table @gcctabopt
17432 @item -mrtp
17433 @opindex mrtp
17434 GCC can generate code for both VxWorks kernels and real time processes
17435 (RTPs). This option switches from the former to the latter. It also
17436 defines the preprocessor macro @code{__RTP__}.
17437
17438 @item -non-static
17439 @opindex non-static
17440 Link an RTP executable against shared libraries rather than static
17441 libraries. The options @option{-static} and @option{-shared} can
17442 also be used for RTPs (@pxref{Link Options}); @option{-static}
17443 is the default.
17444
17445 @item -Bstatic
17446 @itemx -Bdynamic
17447 @opindex Bstatic
17448 @opindex Bdynamic
17449 These options are passed down to the linker. They are defined for
17450 compatibility with Diab.
17451
17452 @item -Xbind-lazy
17453 @opindex Xbind-lazy
17454 Enable lazy binding of function calls. This option is equivalent to
17455 @option{-Wl,-z,now} and is defined for compatibility with Diab.
17456
17457 @item -Xbind-now
17458 @opindex Xbind-now
17459 Disable lazy binding of function calls. This option is the default and
17460 is defined for compatibility with Diab.
17461 @end table
17462
17463 @node x86-64 Options
17464 @subsection x86-64 Options
17465 @cindex x86-64 options
17466
17467 These are listed under @xref{i386 and x86-64 Options}.
17468
17469 @node i386 and x86-64 Windows Options
17470 @subsection i386 and x86-64 Windows Options
17471 @cindex i386 and x86-64 Windows Options
17472
17473 These additional options are available for Windows targets:
17474
17475 @table @gcctabopt
17476 @item -mconsole
17477 @opindex mconsole
17478 This option is available for Cygwin and MinGW targets. It
17479 specifies that a console application is to be generated, by
17480 instructing the linker to set the PE header subsystem type
17481 required for console applications.
17482 This is the default behavior for Cygwin and MinGW targets.
17483
17484 @item -mdll
17485 @opindex mdll
17486 This option is available for Cygwin and MinGW targets. It
17487 specifies that a DLL - a dynamic link library - is to be
17488 generated, enabling the selection of the required runtime
17489 startup object and entry point.
17490
17491 @item -mnop-fun-dllimport
17492 @opindex mnop-fun-dllimport
17493 This option is available for Cygwin and MinGW targets. It
17494 specifies that the dllimport attribute should be ignored.
17495
17496 @item -mthread
17497 @opindex mthread
17498 This option is available for MinGW targets. It specifies
17499 that MinGW-specific thread support is to be used.
17500
17501 @item -municode
17502 @opindex municode
17503 This option is available for mingw-w64 targets. It specifies
17504 that the UNICODE macro is getting pre-defined and that the
17505 unicode capable runtime startup code is chosen.
17506
17507 @item -mwin32
17508 @opindex mwin32
17509 This option is available for Cygwin and MinGW targets. It
17510 specifies that the typical Windows pre-defined macros are to
17511 be set in the pre-processor, but does not influence the choice
17512 of runtime library/startup code.
17513
17514 @item -mwindows
17515 @opindex mwindows
17516 This option is available for Cygwin and MinGW targets. It
17517 specifies that a GUI application is to be generated by
17518 instructing the linker to set the PE header subsystem type
17519 appropriately.
17520
17521 @item -fno-set-stack-executable
17522 @opindex fno-set-stack-executable
17523 This option is available for MinGW targets. It specifies that
17524 the executable flag for stack used by nested functions isn't
17525 set. This is necessary for binaries running in kernel mode of
17526 Windows, as there the user32 API, which is used to set executable
17527 privileges, isn't available.
17528
17529 @item -mpe-aligned-commons
17530 @opindex mpe-aligned-commons
17531 This option is available for Cygwin and MinGW targets. It
17532 specifies that the GNU extension to the PE file format that
17533 permits the correct alignment of COMMON variables should be
17534 used when generating code. It will be enabled by default if
17535 GCC detects that the target assembler found during configuration
17536 supports the feature.
17537 @end table
17538
17539 See also under @ref{i386 and x86-64 Options} for standard options.
17540
17541 @node Xstormy16 Options
17542 @subsection Xstormy16 Options
17543 @cindex Xstormy16 Options
17544
17545 These options are defined for Xstormy16:
17546
17547 @table @gcctabopt
17548 @item -msim
17549 @opindex msim
17550 Choose startup files and linker script suitable for the simulator.
17551 @end table
17552
17553 @node Xtensa Options
17554 @subsection Xtensa Options
17555 @cindex Xtensa Options
17556
17557 These options are supported for Xtensa targets:
17558
17559 @table @gcctabopt
17560 @item -mconst16
17561 @itemx -mno-const16
17562 @opindex mconst16
17563 @opindex mno-const16
17564 Enable or disable use of @code{CONST16} instructions for loading
17565 constant values. The @code{CONST16} instruction is currently not a
17566 standard option from Tensilica. When enabled, @code{CONST16}
17567 instructions are always used in place of the standard @code{L32R}
17568 instructions. The use of @code{CONST16} is enabled by default only if
17569 the @code{L32R} instruction is not available.
17570
17571 @item -mfused-madd
17572 @itemx -mno-fused-madd
17573 @opindex mfused-madd
17574 @opindex mno-fused-madd
17575 Enable or disable use of fused multiply/add and multiply/subtract
17576 instructions in the floating-point option. This has no effect if the
17577 floating-point option is not also enabled. Disabling fused multiply/add
17578 and multiply/subtract instructions forces the compiler to use separate
17579 instructions for the multiply and add/subtract operations. This may be
17580 desirable in some cases where strict IEEE 754-compliant results are
17581 required: the fused multiply add/subtract instructions do not round the
17582 intermediate result, thereby producing results with @emph{more} bits of
17583 precision than specified by the IEEE standard. Disabling fused multiply
17584 add/subtract instructions also ensures that the program output is not
17585 sensitive to the compiler's ability to combine multiply and add/subtract
17586 operations.
17587
17588 @item -mserialize-volatile
17589 @itemx -mno-serialize-volatile
17590 @opindex mserialize-volatile
17591 @opindex mno-serialize-volatile
17592 When this option is enabled, GCC inserts @code{MEMW} instructions before
17593 @code{volatile} memory references to guarantee sequential consistency.
17594 The default is @option{-mserialize-volatile}. Use
17595 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17596
17597 @item -mforce-no-pic
17598 @opindex mforce-no-pic
17599 For targets, like GNU/Linux, where all user-mode Xtensa code must be
17600 position-independent code (PIC), this option disables PIC for compiling
17601 kernel code.
17602
17603 @item -mtext-section-literals
17604 @itemx -mno-text-section-literals
17605 @opindex mtext-section-literals
17606 @opindex mno-text-section-literals
17607 Control the treatment of literal pools. The default is
17608 @option{-mno-text-section-literals}, which places literals in a separate
17609 section in the output file. This allows the literal pool to be placed
17610 in a data RAM/ROM, and it also allows the linker to combine literal
17611 pools from separate object files to remove redundant literals and
17612 improve code size. With @option{-mtext-section-literals}, the literals
17613 are interspersed in the text section in order to keep them as close as
17614 possible to their references. This may be necessary for large assembly
17615 files.
17616
17617 @item -mtarget-align
17618 @itemx -mno-target-align
17619 @opindex mtarget-align
17620 @opindex mno-target-align
17621 When this option is enabled, GCC instructs the assembler to
17622 automatically align instructions to reduce branch penalties at the
17623 expense of some code density. The assembler attempts to widen density
17624 instructions to align branch targets and the instructions following call
17625 instructions. If there are not enough preceding safe density
17626 instructions to align a target, no widening will be performed. The
17627 default is @option{-mtarget-align}. These options do not affect the
17628 treatment of auto-aligned instructions like @code{LOOP}, which the
17629 assembler will always align, either by widening density instructions or
17630 by inserting no-op instructions.
17631
17632 @item -mlongcalls
17633 @itemx -mno-longcalls
17634 @opindex mlongcalls
17635 @opindex mno-longcalls
17636 When this option is enabled, GCC instructs the assembler to translate
17637 direct calls to indirect calls unless it can determine that the target
17638 of a direct call is in the range allowed by the call instruction. This
17639 translation typically occurs for calls to functions in other source
17640 files. Specifically, the assembler translates a direct @code{CALL}
17641 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17642 The default is @option{-mno-longcalls}. This option should be used in
17643 programs where the call target can potentially be out of range. This
17644 option is implemented in the assembler, not the compiler, so the
17645 assembly code generated by GCC will still show direct call
17646 instructions---look at the disassembled object code to see the actual
17647 instructions. Note that the assembler will use an indirect call for
17648 every cross-file call, not just those that really will be out of range.
17649 @end table
17650
17651 @node zSeries Options
17652 @subsection zSeries Options
17653 @cindex zSeries options
17654
17655 These are listed under @xref{S/390 and zSeries Options}.
17656
17657 @node Code Gen Options
17658 @section Options for Code Generation Conventions
17659 @cindex code generation conventions
17660 @cindex options, code generation
17661 @cindex run-time options
17662
17663 These machine-independent options control the interface conventions
17664 used in code generation.
17665
17666 Most of them have both positive and negative forms; the negative form
17667 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
17668 one of the forms is listed---the one which is not the default. You
17669 can figure out the other form by either removing @samp{no-} or adding
17670 it.
17671
17672 @table @gcctabopt
17673 @item -fbounds-check
17674 @opindex fbounds-check
17675 For front-ends that support it, generate additional code to check that
17676 indices used to access arrays are within the declared range. This is
17677 currently only supported by the Java and Fortran front-ends, where
17678 this option defaults to true and false respectively.
17679
17680 @item -ftrapv
17681 @opindex ftrapv
17682 This option generates traps for signed overflow on addition, subtraction,
17683 multiplication operations.
17684
17685 @item -fwrapv
17686 @opindex fwrapv
17687 This option instructs the compiler to assume that signed arithmetic
17688 overflow of addition, subtraction and multiplication wraps around
17689 using twos-complement representation. This flag enables some optimizations
17690 and disables others. This option is enabled by default for the Java
17691 front-end, as required by the Java language specification.
17692
17693 @item -fexceptions
17694 @opindex fexceptions
17695 Enable exception handling. Generates extra code needed to propagate
17696 exceptions. For some targets, this implies GCC will generate frame
17697 unwind information for all functions, which can produce significant data
17698 size overhead, although it does not affect execution. If you do not
17699 specify this option, GCC will enable it by default for languages like
17700 C++ which normally require exception handling, and disable it for
17701 languages like C that do not normally require it. However, you may need
17702 to enable this option when compiling C code that needs to interoperate
17703 properly with exception handlers written in C++. You may also wish to
17704 disable this option if you are compiling older C++ programs that don't
17705 use exception handling.
17706
17707 @item -fnon-call-exceptions
17708 @opindex fnon-call-exceptions
17709 Generate code that allows trapping instructions to throw exceptions.
17710 Note that this requires platform-specific runtime support that does
17711 not exist everywhere. Moreover, it only allows @emph{trapping}
17712 instructions to throw exceptions, i.e.@: memory references or floating
17713 point instructions. It does not allow exceptions to be thrown from
17714 arbitrary signal handlers such as @code{SIGALRM}.
17715
17716 @item -funwind-tables
17717 @opindex funwind-tables
17718 Similar to @option{-fexceptions}, except that it will just generate any needed
17719 static data, but will not affect the generated code in any other way.
17720 You will normally not enable this option; instead, a language processor
17721 that needs this handling would enable it on your behalf.
17722
17723 @item -fasynchronous-unwind-tables
17724 @opindex fasynchronous-unwind-tables
17725 Generate unwind table in dwarf2 format, if supported by target machine. The
17726 table is exact at each instruction boundary, so it can be used for stack
17727 unwinding from asynchronous events (such as debugger or garbage collector).
17728
17729 @item -fpcc-struct-return
17730 @opindex fpcc-struct-return
17731 Return ``short'' @code{struct} and @code{union} values in memory like
17732 longer ones, rather than in registers. This convention is less
17733 efficient, but it has the advantage of allowing intercallability between
17734 GCC-compiled files and files compiled with other compilers, particularly
17735 the Portable C Compiler (pcc).
17736
17737 The precise convention for returning structures in memory depends
17738 on the target configuration macros.
17739
17740 Short structures and unions are those whose size and alignment match
17741 that of some integer type.
17742
17743 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17744 switch is not binary compatible with code compiled with the
17745 @option{-freg-struct-return} switch.
17746 Use it to conform to a non-default application binary interface.
17747
17748 @item -freg-struct-return
17749 @opindex freg-struct-return
17750 Return @code{struct} and @code{union} values in registers when possible.
17751 This is more efficient for small structures than
17752 @option{-fpcc-struct-return}.
17753
17754 If you specify neither @option{-fpcc-struct-return} nor
17755 @option{-freg-struct-return}, GCC defaults to whichever convention is
17756 standard for the target. If there is no standard convention, GCC
17757 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17758 the principal compiler. In those cases, we can choose the standard, and
17759 we chose the more efficient register return alternative.
17760
17761 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17762 switch is not binary compatible with code compiled with the
17763 @option{-fpcc-struct-return} switch.
17764 Use it to conform to a non-default application binary interface.
17765
17766 @item -fshort-enums
17767 @opindex fshort-enums
17768 Allocate to an @code{enum} type only as many bytes as it needs for the
17769 declared range of possible values. Specifically, the @code{enum} type
17770 will be equivalent to the smallest integer type which has enough room.
17771
17772 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17773 code that is not binary compatible with code generated without that switch.
17774 Use it to conform to a non-default application binary interface.
17775
17776 @item -fshort-double
17777 @opindex fshort-double
17778 Use the same size for @code{double} as for @code{float}.
17779
17780 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17781 code that is not binary compatible with code generated without that switch.
17782 Use it to conform to a non-default application binary interface.
17783
17784 @item -fshort-wchar
17785 @opindex fshort-wchar
17786 Override the underlying type for @samp{wchar_t} to be @samp{short
17787 unsigned int} instead of the default for the target. This option is
17788 useful for building programs to run under WINE@.
17789
17790 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17791 code that is not binary compatible with code generated without that switch.
17792 Use it to conform to a non-default application binary interface.
17793
17794 @item -fno-common
17795 @opindex fno-common
17796 In C code, controls the placement of uninitialized global variables.
17797 Unix C compilers have traditionally permitted multiple definitions of
17798 such variables in different compilation units by placing the variables
17799 in a common block.
17800 This is the behavior specified by @option{-fcommon}, and is the default
17801 for GCC on most targets.
17802 On the other hand, this behavior is not required by ISO C, and on some
17803 targets may carry a speed or code size penalty on variable references.
17804 The @option{-fno-common} option specifies that the compiler should place
17805 uninitialized global variables in the data section of the object file,
17806 rather than generating them as common blocks.
17807 This has the effect that if the same variable is declared
17808 (without @code{extern}) in two different compilations,
17809 you will get a multiple-definition error when you link them.
17810 In this case, you must compile with @option{-fcommon} instead.
17811 Compiling with @option{-fno-common} is useful on targets for which
17812 it provides better performance, or if you wish to verify that the
17813 program will work on other systems which always treat uninitialized
17814 variable declarations this way.
17815
17816 @item -fno-ident
17817 @opindex fno-ident
17818 Ignore the @samp{#ident} directive.
17819
17820 @item -finhibit-size-directive
17821 @opindex finhibit-size-directive
17822 Don't output a @code{.size} assembler directive, or anything else that
17823 would cause trouble if the function is split in the middle, and the
17824 two halves are placed at locations far apart in memory. This option is
17825 used when compiling @file{crtstuff.c}; you should not need to use it
17826 for anything else.
17827
17828 @item -fverbose-asm
17829 @opindex fverbose-asm
17830 Put extra commentary information in the generated assembly code to
17831 make it more readable. This option is generally only of use to those
17832 who actually need to read the generated assembly code (perhaps while
17833 debugging the compiler itself).
17834
17835 @option{-fno-verbose-asm}, the default, causes the
17836 extra information to be omitted and is useful when comparing two assembler
17837 files.
17838
17839 @item -frecord-gcc-switches
17840 @opindex frecord-gcc-switches
17841 This switch causes the command line that was used to invoke the
17842 compiler to be recorded into the object file that is being created.
17843 This switch is only implemented on some targets and the exact format
17844 of the recording is target and binary file format dependent, but it
17845 usually takes the form of a section containing ASCII text. This
17846 switch is related to the @option{-fverbose-asm} switch, but that
17847 switch only records information in the assembler output file as
17848 comments, so it never reaches the object file.
17849
17850 @item -fpic
17851 @opindex fpic
17852 @cindex global offset table
17853 @cindex PIC
17854 Generate position-independent code (PIC) suitable for use in a shared
17855 library, if supported for the target machine. Such code accesses all
17856 constant addresses through a global offset table (GOT)@. The dynamic
17857 loader resolves the GOT entries when the program starts (the dynamic
17858 loader is not part of GCC; it is part of the operating system). If
17859 the GOT size for the linked executable exceeds a machine-specific
17860 maximum size, you get an error message from the linker indicating that
17861 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17862 instead. (These maximums are 8k on the SPARC and 32k
17863 on the m68k and RS/6000. The 386 has no such limit.)
17864
17865 Position-independent code requires special support, and therefore works
17866 only on certain machines. For the 386, GCC supports PIC for System V
17867 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
17868 position-independent.
17869
17870 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17871 are defined to 1.
17872
17873 @item -fPIC
17874 @opindex fPIC
17875 If supported for the target machine, emit position-independent code,
17876 suitable for dynamic linking and avoiding any limit on the size of the
17877 global offset table. This option makes a difference on the m68k,
17878 PowerPC and SPARC@.
17879
17880 Position-independent code requires special support, and therefore works
17881 only on certain machines.
17882
17883 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17884 are defined to 2.
17885
17886 @item -fpie
17887 @itemx -fPIE
17888 @opindex fpie
17889 @opindex fPIE
17890 These options are similar to @option{-fpic} and @option{-fPIC}, but
17891 generated position independent code can be only linked into executables.
17892 Usually these options are used when @option{-pie} GCC option will be
17893 used during linking.
17894
17895 @option{-fpie} and @option{-fPIE} both define the macros
17896 @code{__pie__} and @code{__PIE__}. The macros have the value 1
17897 for @option{-fpie} and 2 for @option{-fPIE}.
17898
17899 @item -fno-jump-tables
17900 @opindex fno-jump-tables
17901 Do not use jump tables for switch statements even where it would be
17902 more efficient than other code generation strategies. This option is
17903 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17904 building code which forms part of a dynamic linker and cannot
17905 reference the address of a jump table. On some targets, jump tables
17906 do not require a GOT and this option is not needed.
17907
17908 @item -ffixed-@var{reg}
17909 @opindex ffixed
17910 Treat the register named @var{reg} as a fixed register; generated code
17911 should never refer to it (except perhaps as a stack pointer, frame
17912 pointer or in some other fixed role).
17913
17914 @var{reg} must be the name of a register. The register names accepted
17915 are machine-specific and are defined in the @code{REGISTER_NAMES}
17916 macro in the machine description macro file.
17917
17918 This flag does not have a negative form, because it specifies a
17919 three-way choice.
17920
17921 @item -fcall-used-@var{reg}
17922 @opindex fcall-used
17923 Treat the register named @var{reg} as an allocable register that is
17924 clobbered by function calls. It may be allocated for temporaries or
17925 variables that do not live across a call. Functions compiled this way
17926 will not save and restore the register @var{reg}.
17927
17928 It is an error to used this flag with the frame pointer or stack pointer.
17929 Use of this flag for other registers that have fixed pervasive roles in
17930 the machine's execution model will produce disastrous results.
17931
17932 This flag does not have a negative form, because it specifies a
17933 three-way choice.
17934
17935 @item -fcall-saved-@var{reg}
17936 @opindex fcall-saved
17937 Treat the register named @var{reg} as an allocable register saved by
17938 functions. It may be allocated even for temporaries or variables that
17939 live across a call. Functions compiled this way will save and restore
17940 the register @var{reg} if they use it.
17941
17942 It is an error to used this flag with the frame pointer or stack pointer.
17943 Use of this flag for other registers that have fixed pervasive roles in
17944 the machine's execution model will produce disastrous results.
17945
17946 A different sort of disaster will result from the use of this flag for
17947 a register in which function values may be returned.
17948
17949 This flag does not have a negative form, because it specifies a
17950 three-way choice.
17951
17952 @item -fpack-struct[=@var{n}]
17953 @opindex fpack-struct
17954 Without a value specified, pack all structure members together without
17955 holes. When a value is specified (which must be a small power of two), pack
17956 structure members according to this value, representing the maximum
17957 alignment (that is, objects with default alignment requirements larger than
17958 this will be output potentially unaligned at the next fitting location.
17959
17960 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17961 code that is not binary compatible with code generated without that switch.
17962 Additionally, it makes the code suboptimal.
17963 Use it to conform to a non-default application binary interface.
17964
17965 @item -finstrument-functions
17966 @opindex finstrument-functions
17967 Generate instrumentation calls for entry and exit to functions. Just
17968 after function entry and just before function exit, the following
17969 profiling functions will be called with the address of the current
17970 function and its call site. (On some platforms,
17971 @code{__builtin_return_address} does not work beyond the current
17972 function, so the call site information may not be available to the
17973 profiling functions otherwise.)
17974
17975 @smallexample
17976 void __cyg_profile_func_enter (void *this_fn,
17977 void *call_site);
17978 void __cyg_profile_func_exit (void *this_fn,
17979 void *call_site);
17980 @end smallexample
17981
17982 The first argument is the address of the start of the current function,
17983 which may be looked up exactly in the symbol table.
17984
17985 This instrumentation is also done for functions expanded inline in other
17986 functions. The profiling calls will indicate where, conceptually, the
17987 inline function is entered and exited. This means that addressable
17988 versions of such functions must be available. If all your uses of a
17989 function are expanded inline, this may mean an additional expansion of
17990 code size. If you use @samp{extern inline} in your C code, an
17991 addressable version of such functions must be provided. (This is
17992 normally the case anyways, but if you get lucky and the optimizer always
17993 expands the functions inline, you might have gotten away without
17994 providing static copies.)
17995
17996 A function may be given the attribute @code{no_instrument_function}, in
17997 which case this instrumentation will not be done. This can be used, for
17998 example, for the profiling functions listed above, high-priority
17999 interrupt routines, and any functions from which the profiling functions
18000 cannot safely be called (perhaps signal handlers, if the profiling
18001 routines generate output or allocate memory).
18002
18003 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
18004 @opindex finstrument-functions-exclude-file-list
18005
18006 Set the list of functions that are excluded from instrumentation (see
18007 the description of @code{-finstrument-functions}). If the file that
18008 contains a function definition matches with one of @var{file}, then
18009 that function is not instrumented. The match is done on substrings:
18010 if the @var{file} parameter is a substring of the file name, it is
18011 considered to be a match.
18012
18013 For example:
18014
18015 @smallexample
18016 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
18017 @end smallexample
18018
18019 @noindent
18020 will exclude any inline function defined in files whose pathnames
18021 contain @code{/bits/stl} or @code{include/sys}.
18022
18023 If, for some reason, you want to include letter @code{','} in one of
18024 @var{sym}, write @code{'\,'}. For example,
18025 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
18026 (note the single quote surrounding the option).
18027
18028 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
18029 @opindex finstrument-functions-exclude-function-list
18030
18031 This is similar to @code{-finstrument-functions-exclude-file-list},
18032 but this option sets the list of function names to be excluded from
18033 instrumentation. The function name to be matched is its user-visible
18034 name, such as @code{vector<int> blah(const vector<int> &)}, not the
18035 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}). The
18036 match is done on substrings: if the @var{sym} parameter is a substring
18037 of the function name, it is considered to be a match. For C99 and C++
18038 extended identifiers, the function name must be given in UTF-8, not
18039 using universal character names.
18040
18041 @item -fstack-check
18042 @opindex fstack-check
18043 Generate code to verify that you do not go beyond the boundary of the
18044 stack. You should specify this flag if you are running in an
18045 environment with multiple threads, but only rarely need to specify it in
18046 a single-threaded environment since stack overflow is automatically
18047 detected on nearly all systems if there is only one stack.
18048
18049 Note that this switch does not actually cause checking to be done; the
18050 operating system or the language runtime must do that. The switch causes
18051 generation of code to ensure that they see the stack being extended.
18052
18053 You can additionally specify a string parameter: @code{no} means no
18054 checking, @code{generic} means force the use of old-style checking,
18055 @code{specific} means use the best checking method and is equivalent
18056 to bare @option{-fstack-check}.
18057
18058 Old-style checking is a generic mechanism that requires no specific
18059 target support in the compiler but comes with the following drawbacks:
18060
18061 @enumerate
18062 @item
18063 Modified allocation strategy for large objects: they will always be
18064 allocated dynamically if their size exceeds a fixed threshold.
18065
18066 @item
18067 Fixed limit on the size of the static frame of functions: when it is
18068 topped by a particular function, stack checking is not reliable and
18069 a warning is issued by the compiler.
18070
18071 @item
18072 Inefficiency: because of both the modified allocation strategy and the
18073 generic implementation, the performances of the code are hampered.
18074 @end enumerate
18075
18076 Note that old-style stack checking is also the fallback method for
18077 @code{specific} if no target support has been added in the compiler.
18078
18079 @item -fstack-limit-register=@var{reg}
18080 @itemx -fstack-limit-symbol=@var{sym}
18081 @itemx -fno-stack-limit
18082 @opindex fstack-limit-register
18083 @opindex fstack-limit-symbol
18084 @opindex fno-stack-limit
18085 Generate code to ensure that the stack does not grow beyond a certain value,
18086 either the value of a register or the address of a symbol. If the stack
18087 would grow beyond the value, a signal is raised. For most targets,
18088 the signal is raised before the stack overruns the boundary, so
18089 it is possible to catch the signal without taking special precautions.
18090
18091 For instance, if the stack starts at absolute address @samp{0x80000000}
18092 and grows downwards, you can use the flags
18093 @option{-fstack-limit-symbol=__stack_limit} and
18094 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
18095 of 128KB@. Note that this may only work with the GNU linker.
18096
18097 @item -fsplit-stack
18098 @opindex fsplit-stack
18099 Generate code to automatically split the stack before it overflows.
18100 The resulting program has a discontiguous stack which can only
18101 overflow if the program is unable to allocate any more memory. This
18102 is most useful when running threaded programs, as it is no longer
18103 necessary to calculate a good stack size to use for each thread. This
18104 is currently only implemented for the i386 and x86_64 backends running
18105 GNU/Linux.
18106
18107 When code compiled with @option{-fsplit-stack} calls code compiled
18108 without @option{-fsplit-stack}, there may not be much stack space
18109 available for the latter code to run. If compiling all code,
18110 including library code, with @option{-fsplit-stack} is not an option,
18111 then the linker can fix up these calls so that the code compiled
18112 without @option{-fsplit-stack} always has a large stack. Support for
18113 this is implemented in the gold linker in GNU binutils release 2.21
18114 and later.
18115
18116 @item -fleading-underscore
18117 @opindex fleading-underscore
18118 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
18119 change the way C symbols are represented in the object file. One use
18120 is to help link with legacy assembly code.
18121
18122 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
18123 generate code that is not binary compatible with code generated without that
18124 switch. Use it to conform to a non-default application binary interface.
18125 Not all targets provide complete support for this switch.
18126
18127 @item -ftls-model=@var{model}
18128 @opindex ftls-model
18129 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
18130 The @var{model} argument should be one of @code{global-dynamic},
18131 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
18132
18133 The default without @option{-fpic} is @code{initial-exec}; with
18134 @option{-fpic} the default is @code{global-dynamic}.
18135
18136 @item -fvisibility=@var{default|internal|hidden|protected}
18137 @opindex fvisibility
18138 Set the default ELF image symbol visibility to the specified option---all
18139 symbols will be marked with this unless overridden within the code.
18140 Using this feature can very substantially improve linking and
18141 load times of shared object libraries, produce more optimized
18142 code, provide near-perfect API export and prevent symbol clashes.
18143 It is @strong{strongly} recommended that you use this in any shared objects
18144 you distribute.
18145
18146 Despite the nomenclature, @code{default} always means public; i.e.,
18147 available to be linked against from outside the shared object.
18148 @code{protected} and @code{internal} are pretty useless in real-world
18149 usage so the only other commonly used option will be @code{hidden}.
18150 The default if @option{-fvisibility} isn't specified is
18151 @code{default}, i.e., make every
18152 symbol public---this causes the same behavior as previous versions of
18153 GCC@.
18154
18155 A good explanation of the benefits offered by ensuring ELF
18156 symbols have the correct visibility is given by ``How To Write
18157 Shared Libraries'' by Ulrich Drepper (which can be found at
18158 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
18159 solution made possible by this option to marking things hidden when
18160 the default is public is to make the default hidden and mark things
18161 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
18162 and @code{__attribute__ ((visibility("default")))} instead of
18163 @code{__declspec(dllexport)} you get almost identical semantics with
18164 identical syntax. This is a great boon to those working with
18165 cross-platform projects.
18166
18167 For those adding visibility support to existing code, you may find
18168 @samp{#pragma GCC visibility} of use. This works by you enclosing
18169 the declarations you wish to set visibility for with (for example)
18170 @samp{#pragma GCC visibility push(hidden)} and
18171 @samp{#pragma GCC visibility pop}.
18172 Bear in mind that symbol visibility should be viewed @strong{as
18173 part of the API interface contract} and thus all new code should
18174 always specify visibility when it is not the default; i.e., declarations
18175 only for use within the local DSO should @strong{always} be marked explicitly
18176 as hidden as so to avoid PLT indirection overheads---making this
18177 abundantly clear also aids readability and self-documentation of the code.
18178 Note that due to ISO C++ specification requirements, operator new and
18179 operator delete must always be of default visibility.
18180
18181 Be aware that headers from outside your project, in particular system
18182 headers and headers from any other library you use, may not be
18183 expecting to be compiled with visibility other than the default. You
18184 may need to explicitly say @samp{#pragma GCC visibility push(default)}
18185 before including any such headers.
18186
18187 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
18188 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
18189 no modifications. However, this means that calls to @samp{extern}
18190 functions with no explicit visibility will use the PLT, so it is more
18191 effective to use @samp{__attribute ((visibility))} and/or
18192 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
18193 declarations should be treated as hidden.
18194
18195 Note that @samp{-fvisibility} does affect C++ vague linkage
18196 entities. This means that, for instance, an exception class that will
18197 be thrown between DSOs must be explicitly marked with default
18198 visibility so that the @samp{type_info} nodes will be unified between
18199 the DSOs.
18200
18201 An overview of these techniques, their benefits and how to use them
18202 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
18203
18204 @item -fstrict-volatile-bitfields
18205 @opindex fstrict-volatile-bitfields
18206 This option should be used if accesses to volatile bitfields (or other
18207 structure fields, although the compiler usually honors those types
18208 anyway) should use a single access of the width of the
18209 field's type, aligned to a natural alignment if possible. For
18210 example, targets with memory-mapped peripheral registers might require
18211 all such accesses to be 16 bits wide; with this flag the user could
18212 declare all peripheral bitfields as ``unsigned short'' (assuming short
18213 is 16 bits on these targets) to force GCC to use 16 bit accesses
18214 instead of, perhaps, a more efficient 32 bit access.
18215
18216 If this option is disabled, the compiler will use the most efficient
18217 instruction. In the previous example, that might be a 32-bit load
18218 instruction, even though that will access bytes that do not contain
18219 any portion of the bitfield, or memory-mapped registers unrelated to
18220 the one being updated.
18221
18222 If the target requires strict alignment, and honoring the field
18223 type would require violating this alignment, a warning is issued.
18224 If the field has @code{packed} attribute, the access is done without
18225 honoring the field type. If the field doesn't have @code{packed}
18226 attribute, the access is done honoring the field type. In both cases,
18227 GCC assumes that the user knows something about the target hardware
18228 that it is unaware of.
18229
18230 The default value of this option is determined by the application binary
18231 interface for the target processor.
18232
18233 @end table
18234
18235 @c man end
18236
18237 @node Environment Variables
18238 @section Environment Variables Affecting GCC
18239 @cindex environment variables
18240
18241 @c man begin ENVIRONMENT
18242 This section describes several environment variables that affect how GCC
18243 operates. Some of them work by specifying directories or prefixes to use
18244 when searching for various kinds of files. Some are used to specify other
18245 aspects of the compilation environment.
18246
18247 Note that you can also specify places to search using options such as
18248 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
18249 take precedence over places specified using environment variables, which
18250 in turn take precedence over those specified by the configuration of GCC@.
18251 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
18252 GNU Compiler Collection (GCC) Internals}.
18253
18254 @table @env
18255 @item LANG
18256 @itemx LC_CTYPE
18257 @c @itemx LC_COLLATE
18258 @itemx LC_MESSAGES
18259 @c @itemx LC_MONETARY
18260 @c @itemx LC_NUMERIC
18261 @c @itemx LC_TIME
18262 @itemx LC_ALL
18263 @findex LANG
18264 @findex LC_CTYPE
18265 @c @findex LC_COLLATE
18266 @findex LC_MESSAGES
18267 @c @findex LC_MONETARY
18268 @c @findex LC_NUMERIC
18269 @c @findex LC_TIME
18270 @findex LC_ALL
18271 @cindex locale
18272 These environment variables control the way that GCC uses
18273 localization information that allow GCC to work with different
18274 national conventions. GCC inspects the locale categories
18275 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
18276 so. These locale categories can be set to any value supported by your
18277 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
18278 Kingdom encoded in UTF-8.
18279
18280 The @env{LC_CTYPE} environment variable specifies character
18281 classification. GCC uses it to determine the character boundaries in
18282 a string; this is needed for some multibyte encodings that contain quote
18283 and escape characters that would otherwise be interpreted as a string
18284 end or escape.
18285
18286 The @env{LC_MESSAGES} environment variable specifies the language to
18287 use in diagnostic messages.
18288
18289 If the @env{LC_ALL} environment variable is set, it overrides the value
18290 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
18291 and @env{LC_MESSAGES} default to the value of the @env{LANG}
18292 environment variable. If none of these variables are set, GCC
18293 defaults to traditional C English behavior.
18294
18295 @item TMPDIR
18296 @findex TMPDIR
18297 If @env{TMPDIR} is set, it specifies the directory to use for temporary
18298 files. GCC uses temporary files to hold the output of one stage of
18299 compilation which is to be used as input to the next stage: for example,
18300 the output of the preprocessor, which is the input to the compiler
18301 proper.
18302
18303 @item GCC_EXEC_PREFIX
18304 @findex GCC_EXEC_PREFIX
18305 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
18306 names of the subprograms executed by the compiler. No slash is added
18307 when this prefix is combined with the name of a subprogram, but you can
18308 specify a prefix that ends with a slash if you wish.
18309
18310 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
18311 an appropriate prefix to use based on the pathname it was invoked with.
18312
18313 If GCC cannot find the subprogram using the specified prefix, it
18314 tries looking in the usual places for the subprogram.
18315
18316 The default value of @env{GCC_EXEC_PREFIX} is
18317 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
18318 the installed compiler. In many cases @var{prefix} is the value
18319 of @code{prefix} when you ran the @file{configure} script.
18320
18321 Other prefixes specified with @option{-B} take precedence over this prefix.
18322
18323 This prefix is also used for finding files such as @file{crt0.o} that are
18324 used for linking.
18325
18326 In addition, the prefix is used in an unusual way in finding the
18327 directories to search for header files. For each of the standard
18328 directories whose name normally begins with @samp{/usr/local/lib/gcc}
18329 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
18330 replacing that beginning with the specified prefix to produce an
18331 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
18332 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
18333 These alternate directories are searched first; the standard directories
18334 come next. If a standard directory begins with the configured
18335 @var{prefix} then the value of @var{prefix} is replaced by
18336 @env{GCC_EXEC_PREFIX} when looking for header files.
18337
18338 @item COMPILER_PATH
18339 @findex COMPILER_PATH
18340 The value of @env{COMPILER_PATH} is a colon-separated list of
18341 directories, much like @env{PATH}. GCC tries the directories thus
18342 specified when searching for subprograms, if it can't find the
18343 subprograms using @env{GCC_EXEC_PREFIX}.
18344
18345 @item LIBRARY_PATH
18346 @findex LIBRARY_PATH
18347 The value of @env{LIBRARY_PATH} is a colon-separated list of
18348 directories, much like @env{PATH}. When configured as a native compiler,
18349 GCC tries the directories thus specified when searching for special
18350 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
18351 using GCC also uses these directories when searching for ordinary
18352 libraries for the @option{-l} option (but directories specified with
18353 @option{-L} come first).
18354
18355 @item LANG
18356 @findex LANG
18357 @cindex locale definition
18358 This variable is used to pass locale information to the compiler. One way in
18359 which this information is used is to determine the character set to be used
18360 when character literals, string literals and comments are parsed in C and C++.
18361 When the compiler is configured to allow multibyte characters,
18362 the following values for @env{LANG} are recognized:
18363
18364 @table @samp
18365 @item C-JIS
18366 Recognize JIS characters.
18367 @item C-SJIS
18368 Recognize SJIS characters.
18369 @item C-EUCJP
18370 Recognize EUCJP characters.
18371 @end table
18372
18373 If @env{LANG} is not defined, or if it has some other value, then the
18374 compiler will use mblen and mbtowc as defined by the default locale to
18375 recognize and translate multibyte characters.
18376 @end table
18377
18378 @noindent
18379 Some additional environments variables affect the behavior of the
18380 preprocessor.
18381
18382 @include cppenv.texi
18383
18384 @c man end
18385
18386 @node Precompiled Headers
18387 @section Using Precompiled Headers
18388 @cindex precompiled headers
18389 @cindex speed of compilation
18390
18391 Often large projects have many header files that are included in every
18392 source file. The time the compiler takes to process these header files
18393 over and over again can account for nearly all of the time required to
18394 build the project. To make builds faster, GCC allows users to
18395 `precompile' a header file; then, if builds can use the precompiled
18396 header file they will be much faster.
18397
18398 To create a precompiled header file, simply compile it as you would any
18399 other file, if necessary using the @option{-x} option to make the driver
18400 treat it as a C or C++ header file. You will probably want to use a
18401 tool like @command{make} to keep the precompiled header up-to-date when
18402 the headers it contains change.
18403
18404 A precompiled header file will be searched for when @code{#include} is
18405 seen in the compilation. As it searches for the included file
18406 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
18407 compiler looks for a precompiled header in each directory just before it
18408 looks for the include file in that directory. The name searched for is
18409 the name specified in the @code{#include} with @samp{.gch} appended. If
18410 the precompiled header file can't be used, it is ignored.
18411
18412 For instance, if you have @code{#include "all.h"}, and you have
18413 @file{all.h.gch} in the same directory as @file{all.h}, then the
18414 precompiled header file will be used if possible, and the original
18415 header will be used otherwise.
18416
18417 Alternatively, you might decide to put the precompiled header file in a
18418 directory and use @option{-I} to ensure that directory is searched
18419 before (or instead of) the directory containing the original header.
18420 Then, if you want to check that the precompiled header file is always
18421 used, you can put a file of the same name as the original header in this
18422 directory containing an @code{#error} command.
18423
18424 This also works with @option{-include}. So yet another way to use
18425 precompiled headers, good for projects not designed with precompiled
18426 header files in mind, is to simply take most of the header files used by
18427 a project, include them from another header file, precompile that header
18428 file, and @option{-include} the precompiled header. If the header files
18429 have guards against multiple inclusion, they will be skipped because
18430 they've already been included (in the precompiled header).
18431
18432 If you need to precompile the same header file for different
18433 languages, targets, or compiler options, you can instead make a
18434 @emph{directory} named like @file{all.h.gch}, and put each precompiled
18435 header in the directory, perhaps using @option{-o}. It doesn't matter
18436 what you call the files in the directory, every precompiled header in
18437 the directory will be considered. The first precompiled header
18438 encountered in the directory that is valid for this compilation will
18439 be used; they're searched in no particular order.
18440
18441 There are many other possibilities, limited only by your imagination,
18442 good sense, and the constraints of your build system.
18443
18444 A precompiled header file can be used only when these conditions apply:
18445
18446 @itemize
18447 @item
18448 Only one precompiled header can be used in a particular compilation.
18449
18450 @item
18451 A precompiled header can't be used once the first C token is seen. You
18452 can have preprocessor directives before a precompiled header; you can
18453 even include a precompiled header from inside another header, so long as
18454 there are no C tokens before the @code{#include}.
18455
18456 @item
18457 The precompiled header file must be produced for the same language as
18458 the current compilation. You can't use a C precompiled header for a C++
18459 compilation.
18460
18461 @item
18462 The precompiled header file must have been produced by the same compiler
18463 binary as the current compilation is using.
18464
18465 @item
18466 Any macros defined before the precompiled header is included must
18467 either be defined in the same way as when the precompiled header was
18468 generated, or must not affect the precompiled header, which usually
18469 means that they don't appear in the precompiled header at all.
18470
18471 The @option{-D} option is one way to define a macro before a
18472 precompiled header is included; using a @code{#define} can also do it.
18473 There are also some options that define macros implicitly, like
18474 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
18475 defined this way.
18476
18477 @item If debugging information is output when using the precompiled
18478 header, using @option{-g} or similar, the same kind of debugging information
18479 must have been output when building the precompiled header. However,
18480 a precompiled header built using @option{-g} can be used in a compilation
18481 when no debugging information is being output.
18482
18483 @item The same @option{-m} options must generally be used when building
18484 and using the precompiled header. @xref{Submodel Options},
18485 for any cases where this rule is relaxed.
18486
18487 @item Each of the following options must be the same when building and using
18488 the precompiled header:
18489
18490 @gccoptlist{-fexceptions}
18491
18492 @item
18493 Some other command-line options starting with @option{-f},
18494 @option{-p}, or @option{-O} must be defined in the same way as when
18495 the precompiled header was generated. At present, it's not clear
18496 which options are safe to change and which are not; the safest choice
18497 is to use exactly the same options when generating and using the
18498 precompiled header. The following are known to be safe:
18499
18500 @gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock @gol
18501 -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous @gol
18502 -fsched-verbose=@var{number} -fschedule-insns -fvisibility= @gol
18503 -pedantic-errors}
18504
18505 @end itemize
18506
18507 For all of these except the last, the compiler will automatically
18508 ignore the precompiled header if the conditions aren't met. If you
18509 find an option combination that doesn't work and doesn't cause the
18510 precompiled header to be ignored, please consider filing a bug report,
18511 see @ref{Bugs}.
18512
18513 If you do use differing options when generating and using the
18514 precompiled header, the actual behavior will be a mixture of the
18515 behavior for the options. For instance, if you use @option{-g} to
18516 generate the precompiled header but not when using it, you may or may
18517 not get debugging information for routines in the precompiled header.