Add -da and remove -dm in GCC manual
[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, 2012
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, 2011,
15 2012
16 Free Software Foundation, Inc.
17
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU Free Documentation License, Version 1.3 or
20 any later version published by the Free Software Foundation; with the
21 Invariant Sections being ``GNU General Public License'' and ``Funding
22 Free Software'', the Front-Cover texts being (a) (see below), and with
23 the Back-Cover Texts being (b) (see below). A copy of the license is
24 included in the gfdl(7) man page.
25
26 (a) The FSF's Front-Cover Text is:
27
28 A GNU Manual
29
30 (b) The FSF's Back-Cover Text is:
31
32 You have freedom to copy and modify this GNU Manual, like GNU
33 software. Copies published by the Free Software Foundation raise
34 funds for GNU development.
35 @c man end
36 @c Set file name and title for the man page.
37 @setfilename gcc
38 @settitle GNU project C and C++ compiler
39 @c man begin SYNOPSIS
40 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
41 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
42 [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
43 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
44 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
45 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
46 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
47
48 Only the most useful options are listed here; see below for the
49 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
50 @c man end
51 @c man begin SEEALSO
52 gpl(7), gfdl(7), fsf-funding(7),
53 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
54 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
55 @file{ld}, @file{binutils} and @file{gdb}.
56 @c man end
57 @c man begin BUGS
58 For instructions on reporting bugs, see
59 @w{@value{BUGURL}}.
60 @c man end
61 @c man begin AUTHOR
62 See the Info entry for @command{gcc}, or
63 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
64 for contributors to GCC@.
65 @c man end
66 @end ignore
67
68 @node Invoking GCC
69 @chapter GCC Command Options
70 @cindex GCC command options
71 @cindex command options
72 @cindex options, GCC command
73
74 @c man begin DESCRIPTION
75 When you invoke GCC, it normally does preprocessing, compilation,
76 assembly and linking. The ``overall options'' allow you to stop this
77 process at an intermediate stage. For example, the @option{-c} option
78 says not to run the linker. Then the output consists of object files
79 output by the assembler.
80
81 Other options are passed on to one stage of processing. Some options
82 control the preprocessor and others the compiler itself. Yet other
83 options control the assembler and linker; most of these are not
84 documented here, since you rarely need to use any of them.
85
86 @cindex C compilation options
87 Most of the command-line options that you can use with GCC are useful
88 for C programs; when an option is only useful with another language
89 (usually C++), the explanation says so explicitly. If the description
90 for a particular option does not mention a source language, you can use
91 that option with all supported languages.
92
93 @cindex C++ compilation options
94 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
95 options for compiling C++ programs.
96
97 @cindex grouping options
98 @cindex options, grouping
99 The @command{gcc} program accepts options and file names as operands. Many
100 options have multi-letter names; therefore multiple single-letter options
101 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
102 -v}}.
103
104 @cindex order of options
105 @cindex options, order
106 You can mix options and other arguments. For the most part, the order
107 you use doesn't matter. Order does matter when you use several
108 options of the same kind; for example, if you specify @option{-L} more
109 than once, the directories are searched in the order specified. Also,
110 the placement of the @option{-l} option is significant.
111
112 Many options have long names starting with @samp{-f} or with
113 @samp{-W}---for example,
114 @option{-fmove-loop-invariants}, @option{-Wformat} and so on. Most of
115 these have both positive and negative forms; the negative form of
116 @option{-ffoo} is @option{-fno-foo}. This manual documents
117 only one of these two forms, whichever one is not the default.
118
119 @c man end
120
121 @xref{Option Index}, for an index to GCC's options.
122
123 @menu
124 * Option Summary:: Brief list of all options, without explanations.
125 * Overall Options:: Controlling the kind of output:
126 an executable, object files, assembler files,
127 or preprocessed source.
128 * Invoking G++:: Compiling C++ programs.
129 * C Dialect Options:: Controlling the variant of C language compiled.
130 * C++ Dialect Options:: Variations on C++.
131 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
132 and Objective-C++.
133 * Language Independent Options:: Controlling how diagnostics should be
134 formatted.
135 * Warning Options:: How picky should the compiler be?
136 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
137 * Optimize Options:: How much optimization?
138 * Preprocessor Options:: Controlling header files and macro definitions.
139 Also, getting dependency information for Make.
140 * Assembler Options:: Passing options to the assembler.
141 * Link Options:: Specifying libraries and so on.
142 * Directory Options:: Where to find header files and libraries.
143 Where to find the compiler executable files.
144 * Spec Files:: How to pass switches to sub-processes.
145 * Target Options:: Running a cross-compiler, or an old version of GCC.
146 * Submodel Options:: Specifying minor hardware or convention variations,
147 such as 68010 vs 68020.
148 * Code Gen Options:: Specifying conventions for function calls, data layout
149 and register usage.
150 * Environment Variables:: Env vars that affect GCC.
151 * Precompiled Headers:: Compiling a header once, and using it many times.
152 @end menu
153
154 @c man begin OPTIONS
155
156 @node Option Summary
157 @section Option Summary
158
159 Here is a summary of all the options, grouped by type. Explanations are
160 in the following sections.
161
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c -S -E -o @var{file} -no-canonical-prefixes @gol
166 -pipe -pass-exit-codes @gol
167 -x @var{language} -v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help @gol
168 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg} @gol
169 -fdump-ada-spec@r{[}-slim@r{]} -fdump-go-spec=@var{file}}
170
171 @item C Language Options
172 @xref{C Dialect Options,,Options Controlling C Dialect}.
173 @gccoptlist{-ansi -std=@var{standard} -fgnu89-inline @gol
174 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
175 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
176 -fhosted -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
177 -trigraphs -traditional -traditional-cpp @gol
178 -fallow-single-precision -fcond-mismatch -flax-vector-conversions @gol
179 -fsigned-bitfields -fsigned-char @gol
180 -funsigned-bitfields -funsigned-char}
181
182 @item C++ Language Options
183 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
184 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
185 -fconstexpr-depth=@var{n} -ffriend-injection @gol
186 -fno-elide-constructors @gol
187 -fno-enforce-eh-specs @gol
188 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
189 -fno-implicit-templates @gol
190 -fno-implicit-inline-templates @gol
191 -fno-implement-inlines -fms-extensions @gol
192 -fno-nonansi-builtins -fnothrow-opt -fno-operator-names @gol
193 -fno-optional-diags -fpermissive @gol
194 -fno-pretty-templates @gol
195 -frepo -fno-rtti -fstats -ftemplate-backtrace-limit=@var{n} @gol
196 -ftemplate-depth=@var{n} @gol
197 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
198 -fno-default-inline -fvisibility-inlines-hidden @gol
199 -fvisibility-ms-compat @gol
200 -Wabi -Wconversion-null -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor -Wreorder @gol
203 -Weffc++ -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend -Wold-style-cast @gol
205 -Woverloaded-virtual -Wno-pmf-conversions @gol
206 -Wsign-promo}
207
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -freplace-objc-classes @gol
222 -fzero-link @gol
223 -gen-decls @gol
224 -Wassign-intercept @gol
225 -Wno-protocol -Wselector @gol
226 -Wstrict-selector-match @gol
227 -Wundeclared-selector}
228
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n} @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
233 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
234
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic @gol
238 -pedantic-errors @gol
239 -w -Wextra -Wall -Waddress -Waggregate-return -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align -Wcast-qual @gol
242 -Wchar-subscripts -Wclobbered -Wcomment @gol
243 -Wconversion -Wcoverage-mismatch -Wno-cpp -Wno-deprecated @gol
244 -Wno-deprecated-declarations -Wdisabled-optimization @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body -Wenum-compare @gol
246 -Wno-endif-labels -Werror -Werror=* @gol
247 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
253 -Winit-self -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len} -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar -Wnonnull -Wno-overflow @gol
261 -Woverlength-strings -Wpacked -Wpacked-bitfield-compat -Wpadded @gol
262 -Wparentheses -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type -Wsequence-point -Wshadow @gol
266 -Wsign-compare -Wsign-conversion -Wsizeof-pointer-memaccess @gol
267 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
268 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch -Wswitch-default -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers -Wtrampolines -Wtrigraphs -Wtype-limits -Wundef @gol
273 -Wuninitialized -Wunknown-pragmas -Wno-pragmas @gol
274 -Wunsuffixed-float-constants -Wunused -Wunused-function @gol
275 -Wunused-label -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var -Wwrite-strings -Wzero-as-null-pointer-constant}
280
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
283 -Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs @gol
284 -Wold-style-declaration -Wold-style-definition @gol
285 -Wstrict-prototypes -Wtraditional -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
287
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
323 -ftree-vectorizer-verbose=@var{n} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage -ftest-coverage -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments -fvar-tracking-assignments-toggle @gol
337 -g -g@var{level} -gtoggle -gcoff -gdwarf-@var{version} @gol
338 -ggdb -grecord-gcc-switches -gno-record-gcc-switches @gol
339 -gstabs -gstabs+ -gstrict-dwarf -gno-strict-dwarf @gol
340 -gvms -gxcoff -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
346 -print-multi-directory -print-multi-lib -print-multi-os-directory @gol
347 -print-prog-name=@var{program} -print-search-dirs -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
350
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
355 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
356 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
357 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
358 -fcompare-elim -fcprop-registers -fcrossjumping @gol
359 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
360 -fcx-limited-range @gol
361 -fdata-sections -fdce -fdelayed-branch @gol
362 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
363 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
364 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
365 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
366 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
367 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
368 -fif-conversion2 -findirect-inlining @gol
369 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
370 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
371 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
372 -fira-algorithm=@var{algorithm} @gol
373 -fira-region=@var{region} @gol
374 -fira-loop-pressure -fno-ira-share-save-slots @gol
375 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
376 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
377 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
378 -floop-parallelize-all -flto -flto-compression-level @gol
379 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
380 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
381 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
382 -fno-default-inline @gol
383 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
384 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
385 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
386 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
387 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
388 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
389 -fprefetch-loop-arrays @gol
390 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
391 -fprofile-generate=@var{path} @gol
392 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
393 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
394 -freorder-blocks-and-partition -freorder-functions @gol
395 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
396 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
397 -fsched-spec-load -fsched-spec-load-dangerous @gol
398 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
399 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
400 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
401 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
402 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
403 -fselective-scheduling -fselective-scheduling2 @gol
404 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
405 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
406 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
407 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
408 -fthread-jumps -ftracer -ftree-bit-ccp @gol
409 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
410 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
411 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
412 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
413 -ftree-loop-if-convert-stores -ftree-loop-im @gol
414 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
415 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
416 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
417 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
418 -ftree-switch-conversion -ftree-tail-merge @gol
419 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
420 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
421 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
422 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
423 -fwhole-program -fwpa -fuse-linker-plugin @gol
424 --param @var{name}=@var{value}
425 -O -O0 -O1 -O2 -O3 -Os -Ofast}
426
427 @item Preprocessor Options
428 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
429 @gccoptlist{-A@var{question}=@var{answer} @gol
430 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
431 -C -dD -dI -dM -dN @gol
432 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
433 -idirafter @var{dir} @gol
434 -include @var{file} -imacros @var{file} @gol
435 -iprefix @var{file} -iwithprefix @var{dir} @gol
436 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
437 -imultilib @var{dir} -isysroot @var{dir} @gol
438 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
439 -P -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
440 -remap -trigraphs -undef -U@var{macro} @gol
441 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
442
443 @item Assembler Option
444 @xref{Assembler Options,,Passing Options to the Assembler}.
445 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
446
447 @item Linker Options
448 @xref{Link Options,,Options for Linking}.
449 @gccoptlist{@var{object-file-name} -l@var{library} @gol
450 -nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
451 -s -static -static-libgcc -static-libstdc++ -shared @gol
452 -shared-libgcc -symbolic @gol
453 -T @var{script} -Wl,@var{option} -Xlinker @var{option} @gol
454 -u @var{symbol}}
455
456 @item Directory Options
457 @xref{Directory Options,,Options for Directory Search}.
458 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
459 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
460 --sysroot=@var{dir}}
461
462 @item Machine Dependent Options
463 @xref{Submodel Options,,Hardware Models and Configurations}.
464 @c This list is ordered alphanumerically by subsection name.
465 @c Try and put the significant identifier (CPU or system) first,
466 @c so users have a clue at guessing where the ones they want will be.
467
468 @emph{Adapteva Epiphany Options}
469 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
470 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
471 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
472 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
473 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
474 -msplit-vecmove-early -m1reg-@var{reg}}
475
476 @emph{ARM Options}
477 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
478 -mabi=@var{name} @gol
479 -mapcs-stack-check -mno-apcs-stack-check @gol
480 -mapcs-float -mno-apcs-float @gol
481 -mapcs-reentrant -mno-apcs-reentrant @gol
482 -msched-prolog -mno-sched-prolog @gol
483 -mlittle-endian -mbig-endian -mwords-little-endian @gol
484 -mfloat-abi=@var{name} @gol
485 -mfp16-format=@var{name}
486 -mthumb-interwork -mno-thumb-interwork @gol
487 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
488 -mstructure-size-boundary=@var{n} @gol
489 -mabort-on-noreturn @gol
490 -mlong-calls -mno-long-calls @gol
491 -msingle-pic-base -mno-single-pic-base @gol
492 -mpic-register=@var{reg} @gol
493 -mnop-fun-dllimport @gol
494 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
495 -mpoke-function-name @gol
496 -mthumb -marm @gol
497 -mtpcs-frame -mtpcs-leaf-frame @gol
498 -mcaller-super-interworking -mcallee-super-interworking @gol
499 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
500 -mword-relocations @gol
501 -mfix-cortex-m3-ldrd @gol
502 -munaligned-access}
503
504 @emph{AVR Options}
505 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
506 -mcall-prologues -mint8 -mno-interrupts -mrelax -mshort-calls @gol
507 -mstrict-X -mtiny-stack}
508
509 @emph{Blackfin Options}
510 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
511 -msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
512 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
513 -mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
514 -mno-id-shared-library -mshared-library-id=@var{n} @gol
515 -mleaf-id-shared-library -mno-leaf-id-shared-library @gol
516 -msep-data -mno-sep-data -mlong-calls -mno-long-calls @gol
517 -mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram @gol
518 -micplb}
519
520 @emph{C6X Options}
521 @gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu} @gol
522 -msim -msdata=@var{sdata-type}}
523
524 @emph{CRIS Options}
525 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
526 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
527 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
528 -mstack-align -mdata-align -mconst-align @gol
529 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
530 -melf -maout -melinux -mlinux -sim -sim2 @gol
531 -mmul-bug-workaround -mno-mul-bug-workaround}
532
533 @emph{CR16 Options}
534 @gccoptlist{-mmac @gol
535 -mcr16cplus -mcr16c @gol
536 -msim -mint32 -mbit-ops
537 -mdata-model=@var{model}}
538
539 @emph{Darwin Options}
540 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
541 -arch_only -bind_at_load -bundle -bundle_loader @gol
542 -client_name -compatibility_version -current_version @gol
543 -dead_strip @gol
544 -dependency-file -dylib_file -dylinker_install_name @gol
545 -dynamic -dynamiclib -exported_symbols_list @gol
546 -filelist -flat_namespace -force_cpusubtype_ALL @gol
547 -force_flat_namespace -headerpad_max_install_names @gol
548 -iframework @gol
549 -image_base -init -install_name -keep_private_externs @gol
550 -multi_module -multiply_defined -multiply_defined_unused @gol
551 -noall_load -no_dead_strip_inits_and_terms @gol
552 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
553 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
554 -private_bundle -read_only_relocs -sectalign @gol
555 -sectobjectsymbols -whyload -seg1addr @gol
556 -sectcreate -sectobjectsymbols -sectorder @gol
557 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
558 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
559 -segprot -segs_read_only_addr -segs_read_write_addr @gol
560 -single_module -static -sub_library -sub_umbrella @gol
561 -twolevel_namespace -umbrella -undefined @gol
562 -unexported_symbols_list -weak_reference_mismatches @gol
563 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
564 -mkernel -mone-byte-bool}
565
566 @emph{DEC Alpha Options}
567 @gccoptlist{-mno-fp-regs -msoft-float @gol
568 -mieee -mieee-with-inexact -mieee-conformant @gol
569 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
570 -mtrap-precision=@var{mode} -mbuild-constants @gol
571 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
572 -mbwx -mmax -mfix -mcix @gol
573 -mfloat-vax -mfloat-ieee @gol
574 -mexplicit-relocs -msmall-data -mlarge-data @gol
575 -msmall-text -mlarge-text @gol
576 -mmemory-latency=@var{time}}
577
578 @emph{FR30 Options}
579 @gccoptlist{-msmall-model -mno-lsim}
580
581 @emph{FRV Options}
582 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
583 -mhard-float -msoft-float @gol
584 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
585 -mdouble -mno-double @gol
586 -mmedia -mno-media -mmuladd -mno-muladd @gol
587 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
588 -mlinked-fp -mlong-calls -malign-labels @gol
589 -mlibrary-pic -macc-4 -macc-8 @gol
590 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
591 -moptimize-membar -mno-optimize-membar @gol
592 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
593 -mvliw-branch -mno-vliw-branch @gol
594 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
595 -mno-nested-cond-exec -mtomcat-stats @gol
596 -mTLS -mtls @gol
597 -mcpu=@var{cpu}}
598
599 @emph{GNU/Linux Options}
600 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
601 -tno-android-cc -tno-android-ld}
602
603 @emph{H8/300 Options}
604 @gccoptlist{-mrelax -mh -ms -mn -mexr -mno-exr -mint32 -malign-300}
605
606 @emph{HPPA Options}
607 @gccoptlist{-march=@var{architecture-type} @gol
608 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
609 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
610 -mfixed-range=@var{register-range} @gol
611 -mjump-in-delay -mlinker-opt -mlong-calls @gol
612 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
613 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
614 -mno-jump-in-delay -mno-long-load-store @gol
615 -mno-portable-runtime -mno-soft-float @gol
616 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
617 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
618 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
619 -munix=@var{unix-std} -nolibdld -static -threads}
620
621 @emph{i386 and x86-64 Options}
622 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
623 -mfpmath=@var{unit} @gol
624 -masm=@var{dialect} -mno-fancy-math-387 @gol
625 -mno-fp-ret-in-387 -msoft-float @gol
626 -mno-wide-multiply -mrtd -malign-double @gol
627 -mpreferred-stack-boundary=@var{num} @gol
628 -mincoming-stack-boundary=@var{num} @gol
629 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
630 -mrecip -mrecip=@var{opt} @gol
631 -mvzeroupper @gol
632 -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
633 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
634 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
635 -mbmi2 -mrtm -mlwp -mthreads @gol
636 -mno-align-stringops -minline-all-stringops @gol
637 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
638 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
639 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
640 -mregparm=@var{num} -msseregparm @gol
641 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
642 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
643 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
644 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
645 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
646 -msse2avx -mfentry -m8bit-idiv @gol
647 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
648
649 @emph{i386 and x86-64 Windows Options}
650 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
651 -mnop-fun-dllimport -mthread @gol
652 -municode -mwin32 -mwindows -fno-set-stack-executable}
653
654 @emph{IA-64 Options}
655 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
656 -mvolatile-asm-stop -mregister-names -msdata -mno-sdata @gol
657 -mconstant-gp -mauto-pic -mfused-madd @gol
658 -minline-float-divide-min-latency @gol
659 -minline-float-divide-max-throughput @gol
660 -mno-inline-float-divide @gol
661 -minline-int-divide-min-latency @gol
662 -minline-int-divide-max-throughput @gol
663 -mno-inline-int-divide @gol
664 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
665 -mno-inline-sqrt @gol
666 -mdwarf2-asm -mearly-stop-bits @gol
667 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
668 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
669 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
670 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
671 -msched-spec-ldc -msched-spec-control-ldc @gol
672 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
673 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
674 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
675 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
676
677 @emph{LM32 Options}
678 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
679 -msign-extend-enabled -muser-enabled}
680
681 @emph{M32R/D Options}
682 @gccoptlist{-m32r2 -m32rx -m32r @gol
683 -mdebug @gol
684 -malign-loops -mno-align-loops @gol
685 -missue-rate=@var{number} @gol
686 -mbranch-cost=@var{number} @gol
687 -mmodel=@var{code-size-model-type} @gol
688 -msdata=@var{sdata-type} @gol
689 -mno-flush-func -mflush-func=@var{name} @gol
690 -mno-flush-trap -mflush-trap=@var{number} @gol
691 -G @var{num}}
692
693 @emph{M32C Options}
694 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
695
696 @emph{M680x0 Options}
697 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune}
698 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
699 -m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
700 -mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020 @gol
701 -mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort @gol
702 -mno-short -mhard-float -m68881 -msoft-float -mpcrel @gol
703 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
704 -mshared-library-id=n -mid-shared-library -mno-id-shared-library @gol
705 -mxgot -mno-xgot}
706
707 @emph{MCore Options}
708 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
709 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
710 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
711 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
712 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
713
714 @emph{MeP Options}
715 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
716 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
717 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
718 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
719 -mtiny=@var{n}}
720
721 @emph{MicroBlaze Options}
722 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
723 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
724 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
725 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
726 -mxl-mode-@var{app-model}}
727
728 @emph{MIPS Options}
729 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
730 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 @gol
731 -mips64 -mips64r2 @gol
732 -mips16 -mno-mips16 -mflip-mips16 @gol
733 -minterlink-mips16 -mno-interlink-mips16 @gol
734 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
735 -mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot @gol
736 -mgp32 -mgp64 -mfp32 -mfp64 -mhard-float -msoft-float @gol
737 -mno-float -msingle-float -mdouble-float @gol
738 -mdsp -mno-dsp -mdspr2 -mno-dspr2 @gol
739 -mmcu -mmno-mcu @gol
740 -mfpu=@var{fpu-type} @gol
741 -msmartmips -mno-smartmips @gol
742 -mpaired-single -mno-paired-single -mdmx -mno-mdmx @gol
743 -mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc @gol
744 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
745 -G@var{num} -mlocal-sdata -mno-local-sdata @gol
746 -mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt @gol
747 -membedded-data -mno-embedded-data @gol
748 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
749 -mcode-readable=@var{setting} @gol
750 -msplit-addresses -mno-split-addresses @gol
751 -mexplicit-relocs -mno-explicit-relocs @gol
752 -mcheck-zero-division -mno-check-zero-division @gol
753 -mdivide-traps -mdivide-breaks @gol
754 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
755 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
756 -mfix-24k -mno-fix-24k @gol
757 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
758 -mfix-r10000 -mno-fix-r10000 -mfix-vr4120 -mno-fix-vr4120 @gol
759 -mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1 @gol
760 -mflush-func=@var{func} -mno-flush-func @gol
761 -mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely @gol
762 -mfp-exceptions -mno-fp-exceptions @gol
763 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
764 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
765
766 @emph{MMIX Options}
767 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
768 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
769 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
770 -mno-base-addresses -msingle-exit -mno-single-exit}
771
772 @emph{MN10300 Options}
773 @gccoptlist{-mmult-bug -mno-mult-bug @gol
774 -mno-am33 -mam33 -mam33-2 -mam34 @gol
775 -mtune=@var{cpu-type} @gol
776 -mreturn-pointer-on-d0 @gol
777 -mno-crt0 -mrelax -mliw -msetlb}
778
779 @emph{PDP-11 Options}
780 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
781 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
782 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
783 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
784 -mbranch-expensive -mbranch-cheap @gol
785 -munix-asm -mdec-asm}
786
787 @emph{picoChip Options}
788 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
789 -msymbol-as-address -mno-inefficient-warnings}
790
791 @emph{PowerPC Options}
792 See RS/6000 and PowerPC Options.
793
794 @emph{RL78 Options}
795 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
796
797 @emph{RS/6000 and PowerPC Options}
798 @gccoptlist{-mcpu=@var{cpu-type} @gol
799 -mtune=@var{cpu-type} @gol
800 -mcmodel=@var{code-model} @gol
801 -mpowerpc64 @gol
802 -maltivec -mno-altivec @gol
803 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
804 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
805 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd @gol
806 -mfprnd -mno-fprnd @gol
807 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
808 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
809 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
810 -malign-power -malign-natural @gol
811 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
812 -msingle-float -mdouble-float -msimple-fpu @gol
813 -mstring -mno-string -mupdate -mno-update @gol
814 -mavoid-indexed-addresses -mno-avoid-indexed-addresses @gol
815 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
816 -mstrict-align -mno-strict-align -mrelocatable @gol
817 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
818 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
819 -mdynamic-no-pic -maltivec -mswdiv -msingle-pic-base @gol
820 -mprioritize-restricted-insns=@var{priority} @gol
821 -msched-costly-dep=@var{dependence_type} @gol
822 -minsert-sched-nops=@var{scheme} @gol
823 -mcall-sysv -mcall-netbsd @gol
824 -maix-struct-return -msvr4-struct-return @gol
825 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
826 -mblock-move-inline-limit=@var{num} @gol
827 -misel -mno-isel @gol
828 -misel=yes -misel=no @gol
829 -mspe -mno-spe @gol
830 -mspe=yes -mspe=no @gol
831 -mpaired @gol
832 -mgen-cell-microcode -mwarn-cell-microcode @gol
833 -mvrsave -mno-vrsave @gol
834 -mmulhw -mno-mulhw @gol
835 -mdlmzb -mno-dlmzb @gol
836 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
837 -mprototype -mno-prototype @gol
838 -msim -mmvme -mads -myellowknife -memb -msdata @gol
839 -msdata=@var{opt} -mvxworks -G @var{num} -pthread @gol
840 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
841 -mno-recip-precision @gol
842 -mveclibabi=@var{type} -mfriz -mno-friz @gol
843 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
844 -msave-toc-indirect -mno-save-toc-indirect}
845
846 @emph{RX Options}
847 @gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu@gol
848 -mcpu=@gol
849 -mbig-endian-data -mlittle-endian-data @gol
850 -msmall-data @gol
851 -msim -mno-sim@gol
852 -mas100-syntax -mno-as100-syntax@gol
853 -mrelax@gol
854 -mmax-constant-size=@gol
855 -mint-register=@gol
856 -mpid@gol
857 -msave-acc-in-interrupts}
858
859 @emph{S/390 and zSeries Options}
860 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
861 -mhard-float -msoft-float -mhard-dfp -mno-hard-dfp @gol
862 -mlong-double-64 -mlong-double-128 @gol
863 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
864 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
865 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
866 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
867 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
868
869 @emph{Score Options}
870 @gccoptlist{-meb -mel @gol
871 -mnhwloop @gol
872 -muls @gol
873 -mmac @gol
874 -mscore5 -mscore5u -mscore7 -mscore7d}
875
876 @emph{SH Options}
877 @gccoptlist{-m1 -m2 -m2e @gol
878 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
879 -m3 -m3e @gol
880 -m4-nofpu -m4-single-only -m4-single -m4 @gol
881 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
882 -m5-64media -m5-64media-nofpu @gol
883 -m5-32media -m5-32media-nofpu @gol
884 -m5-compact -m5-compact-nofpu @gol
885 -mb -ml -mdalign -mrelax @gol
886 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
887 -mieee -mno-ieee -mbitops -misize -minline-ic_invalidate -mpadstruct @gol
888 -mspace -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
889 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
890 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
891 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic -mhard-atomic @gol
892 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
893 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
894 -mpretend-cmove -menable-tas}
895
896 @emph{Solaris 2 Options}
897 @gccoptlist{-mimpure-text -mno-impure-text @gol
898 -pthreads -pthread}
899
900 @emph{SPARC Options}
901 @gccoptlist{-mcpu=@var{cpu-type} @gol
902 -mtune=@var{cpu-type} @gol
903 -mcmodel=@var{code-model} @gol
904 -mmemory-model=@var{mem-model} @gol
905 -m32 -m64 -mapp-regs -mno-app-regs @gol
906 -mfaster-structs -mno-faster-structs -mflat -mno-flat @gol
907 -mfpu -mno-fpu -mhard-float -msoft-float @gol
908 -mhard-quad-float -msoft-quad-float @gol
909 -mlittle-endian @gol
910 -mstack-bias -mno-stack-bias @gol
911 -munaligned-doubles -mno-unaligned-doubles @gol
912 -mv8plus -mno-v8plus -mvis -mno-vis @gol
913 -mvis2 -mno-vis2 -mvis3 -mno-vis3 @gol
914 -mfmaf -mno-fmaf -mpopc -mno-popc @gol
915 -mfix-at697f}
916
917 @emph{SPU Options}
918 @gccoptlist{-mwarn-reloc -merror-reloc @gol
919 -msafe-dma -munsafe-dma @gol
920 -mbranch-hints @gol
921 -msmall-mem -mlarge-mem -mstdmain @gol
922 -mfixed-range=@var{register-range} @gol
923 -mea32 -mea64 @gol
924 -maddress-space-conversion -mno-address-space-conversion @gol
925 -mcache-size=@var{cache-size} @gol
926 -matomic-updates -mno-atomic-updates}
927
928 @emph{System V Options}
929 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
930
931 @emph{TILE-Gx Options}
932 @gccoptlist{-mcpu=CPU -m32 -m64}
933
934 @emph{TILEPro Options}
935 @gccoptlist{-mcpu=CPU -m32}
936
937 @emph{V850 Options}
938 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
939 -mprolog-function -mno-prolog-function -mspace @gol
940 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
941 -mapp-regs -mno-app-regs @gol
942 -mdisable-callt -mno-disable-callt @gol
943 -mv850e2v3 @gol
944 -mv850e2 @gol
945 -mv850e1 -mv850es @gol
946 -mv850e @gol
947 -mv850 -mbig-switch}
948
949 @emph{VAX Options}
950 @gccoptlist{-mg -mgnu -munix}
951
952 @emph{VMS Options}
953 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
954 -mpointer-size=@var{size}}
955
956 @emph{VxWorks Options}
957 @gccoptlist{-mrtp -non-static -Bstatic -Bdynamic @gol
958 -Xbind-lazy -Xbind-now}
959
960 @emph{x86-64 Options}
961 See i386 and x86-64 Options.
962
963 @emph{Xstormy16 Options}
964 @gccoptlist{-msim}
965
966 @emph{Xtensa Options}
967 @gccoptlist{-mconst16 -mno-const16 @gol
968 -mfused-madd -mno-fused-madd @gol
969 -mforce-no-pic @gol
970 -mserialize-volatile -mno-serialize-volatile @gol
971 -mtext-section-literals -mno-text-section-literals @gol
972 -mtarget-align -mno-target-align @gol
973 -mlongcalls -mno-longcalls}
974
975 @emph{zSeries Options}
976 See S/390 and zSeries Options.
977
978 @item Code Generation Options
979 @xref{Code Gen Options,,Options for Code Generation Conventions}.
980 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
981 -ffixed-@var{reg} -fexceptions @gol
982 -fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables @gol
983 -fasynchronous-unwind-tables @gol
984 -finhibit-size-directive -finstrument-functions @gol
985 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
986 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
987 -fno-common -fno-ident @gol
988 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
989 -fno-jump-tables @gol
990 -frecord-gcc-switches @gol
991 -freg-struct-return -fshort-enums @gol
992 -fshort-double -fshort-wchar @gol
993 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
994 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
995 -fno-stack-limit -fsplit-stack @gol
996 -fleading-underscore -ftls-model=@var{model} @gol
997 -fstack-reuse=@var{reuse_level} @gol
998 -ftrapv -fwrapv -fbounds-check @gol
999 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1000 @end table
1001
1002 @menu
1003 * Overall Options:: Controlling the kind of output:
1004 an executable, object files, assembler files,
1005 or preprocessed source.
1006 * C Dialect Options:: Controlling the variant of C language compiled.
1007 * C++ Dialect Options:: Variations on C++.
1008 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1009 and Objective-C++.
1010 * Language Independent Options:: Controlling how diagnostics should be
1011 formatted.
1012 * Warning Options:: How picky should the compiler be?
1013 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
1014 * Optimize Options:: How much optimization?
1015 * Preprocessor Options:: Controlling header files and macro definitions.
1016 Also, getting dependency information for Make.
1017 * Assembler Options:: Passing options to the assembler.
1018 * Link Options:: Specifying libraries and so on.
1019 * Directory Options:: Where to find header files and libraries.
1020 Where to find the compiler executable files.
1021 * Spec Files:: How to pass switches to sub-processes.
1022 * Target Options:: Running a cross-compiler, or an old version of GCC.
1023 @end menu
1024
1025 @node Overall Options
1026 @section Options Controlling the Kind of Output
1027
1028 Compilation can involve up to four stages: preprocessing, compilation
1029 proper, assembly and linking, always in that order. GCC is capable of
1030 preprocessing and compiling several files either into several
1031 assembler input files, or into one assembler input file; then each
1032 assembler input file produces an object file, and linking combines all
1033 the object files (those newly compiled, and those specified as input)
1034 into an executable file.
1035
1036 @cindex file name suffix
1037 For any given input file, the file name suffix determines what kind of
1038 compilation is done:
1039
1040 @table @gcctabopt
1041 @item @var{file}.c
1042 C source code that must be preprocessed.
1043
1044 @item @var{file}.i
1045 C source code that should not be preprocessed.
1046
1047 @item @var{file}.ii
1048 C++ source code that should not be preprocessed.
1049
1050 @item @var{file}.m
1051 Objective-C source code. Note that you must link with the @file{libobjc}
1052 library to make an Objective-C program work.
1053
1054 @item @var{file}.mi
1055 Objective-C source code that should not be preprocessed.
1056
1057 @item @var{file}.mm
1058 @itemx @var{file}.M
1059 Objective-C++ source code. Note that you must link with the @file{libobjc}
1060 library to make an Objective-C++ program work. Note that @samp{.M} refers
1061 to a literal capital M@.
1062
1063 @item @var{file}.mii
1064 Objective-C++ source code that should not be preprocessed.
1065
1066 @item @var{file}.h
1067 C, C++, Objective-C or Objective-C++ header file to be turned into a
1068 precompiled header (default), or C, C++ header file to be turned into an
1069 Ada spec (via the @option{-fdump-ada-spec} switch).
1070
1071 @item @var{file}.cc
1072 @itemx @var{file}.cp
1073 @itemx @var{file}.cxx
1074 @itemx @var{file}.cpp
1075 @itemx @var{file}.CPP
1076 @itemx @var{file}.c++
1077 @itemx @var{file}.C
1078 C++ source code that must be preprocessed. Note that in @samp{.cxx},
1079 the last two letters must both be literally @samp{x}. Likewise,
1080 @samp{.C} refers to a literal capital C@.
1081
1082 @item @var{file}.mm
1083 @itemx @var{file}.M
1084 Objective-C++ source code that must be preprocessed.
1085
1086 @item @var{file}.mii
1087 Objective-C++ source code that should not be preprocessed.
1088
1089 @item @var{file}.hh
1090 @itemx @var{file}.H
1091 @itemx @var{file}.hp
1092 @itemx @var{file}.hxx
1093 @itemx @var{file}.hpp
1094 @itemx @var{file}.HPP
1095 @itemx @var{file}.h++
1096 @itemx @var{file}.tcc
1097 C++ header file to be turned into a precompiled header or Ada spec.
1098
1099 @item @var{file}.f
1100 @itemx @var{file}.for
1101 @itemx @var{file}.ftn
1102 Fixed form Fortran source code that should not be preprocessed.
1103
1104 @item @var{file}.F
1105 @itemx @var{file}.FOR
1106 @itemx @var{file}.fpp
1107 @itemx @var{file}.FPP
1108 @itemx @var{file}.FTN
1109 Fixed form Fortran source code that must be preprocessed (with the traditional
1110 preprocessor).
1111
1112 @item @var{file}.f90
1113 @itemx @var{file}.f95
1114 @itemx @var{file}.f03
1115 @itemx @var{file}.f08
1116 Free form Fortran source code that should not be preprocessed.
1117
1118 @item @var{file}.F90
1119 @itemx @var{file}.F95
1120 @itemx @var{file}.F03
1121 @itemx @var{file}.F08
1122 Free form Fortran source code that must be preprocessed (with the
1123 traditional preprocessor).
1124
1125 @item @var{file}.go
1126 Go source code.
1127
1128 @c FIXME: Descriptions of Java file types.
1129 @c @var{file}.java
1130 @c @var{file}.class
1131 @c @var{file}.zip
1132 @c @var{file}.jar
1133
1134 @item @var{file}.ads
1135 Ada source code file that contains a library unit declaration (a
1136 declaration of a package, subprogram, or generic, or a generic
1137 instantiation), or a library unit renaming declaration (a package,
1138 generic, or subprogram renaming declaration). Such files are also
1139 called @dfn{specs}.
1140
1141 @item @var{file}.adb
1142 Ada source code file containing a library unit body (a subprogram or
1143 package body). Such files are also called @dfn{bodies}.
1144
1145 @c GCC also knows about some suffixes for languages not yet included:
1146 @c Pascal:
1147 @c @var{file}.p
1148 @c @var{file}.pas
1149 @c Ratfor:
1150 @c @var{file}.r
1151
1152 @item @var{file}.s
1153 Assembler code.
1154
1155 @item @var{file}.S
1156 @itemx @var{file}.sx
1157 Assembler code that must be preprocessed.
1158
1159 @item @var{other}
1160 An object file to be fed straight into linking.
1161 Any file name with no recognized suffix is treated this way.
1162 @end table
1163
1164 @opindex x
1165 You can specify the input language explicitly with the @option{-x} option:
1166
1167 @table @gcctabopt
1168 @item -x @var{language}
1169 Specify explicitly the @var{language} for the following input files
1170 (rather than letting the compiler choose a default based on the file
1171 name suffix). This option applies to all following input files until
1172 the next @option{-x} option. Possible values for @var{language} are:
1173 @smallexample
1174 c c-header cpp-output
1175 c++ c++-header c++-cpp-output
1176 objective-c objective-c-header objective-c-cpp-output
1177 objective-c++ objective-c++-header objective-c++-cpp-output
1178 assembler assembler-with-cpp
1179 ada
1180 f77 f77-cpp-input f95 f95-cpp-input
1181 go
1182 java
1183 @end smallexample
1184
1185 @item -x none
1186 Turn off any specification of a language, so that subsequent files are
1187 handled according to their file name suffixes (as they are if @option{-x}
1188 has not been used at all).
1189
1190 @item -pass-exit-codes
1191 @opindex pass-exit-codes
1192 Normally the @command{gcc} program exits with the code of 1 if any
1193 phase of the compiler returns a non-success return code. If you specify
1194 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1195 the numerically highest error produced by any phase returning an error
1196 indication. The C, C++, and Fortran front ends return 4 if an internal
1197 compiler error is encountered.
1198 @end table
1199
1200 If you only want some of the stages of compilation, you can use
1201 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1202 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1203 @command{gcc} is to stop. Note that some combinations (for example,
1204 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1205
1206 @table @gcctabopt
1207 @item -c
1208 @opindex c
1209 Compile or assemble the source files, but do not link. The linking
1210 stage simply is not done. The ultimate output is in the form of an
1211 object file for each source file.
1212
1213 By default, the object file name for a source file is made by replacing
1214 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1215
1216 Unrecognized input files, not requiring compilation or assembly, are
1217 ignored.
1218
1219 @item -S
1220 @opindex S
1221 Stop after the stage of compilation proper; do not assemble. The output
1222 is in the form of an assembler code file for each non-assembler input
1223 file specified.
1224
1225 By default, the assembler file name for a source file is made by
1226 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1227
1228 Input files that don't require compilation are ignored.
1229
1230 @item -E
1231 @opindex E
1232 Stop after the preprocessing stage; do not run the compiler proper. The
1233 output is in the form of preprocessed source code, which is sent to the
1234 standard output.
1235
1236 Input files that don't require preprocessing are ignored.
1237
1238 @cindex output file option
1239 @item -o @var{file}
1240 @opindex o
1241 Place output in file @var{file}. This applies regardless to whatever
1242 sort of output is being produced, whether it be an executable file,
1243 an object file, an assembler file or preprocessed C code.
1244
1245 If @option{-o} is not specified, the default is to put an executable
1246 file in @file{a.out}, the object file for
1247 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1248 assembler file in @file{@var{source}.s}, a precompiled header file in
1249 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1250 standard output.
1251
1252 @item -v
1253 @opindex v
1254 Print (on standard error output) the commands executed to run the stages
1255 of compilation. Also print the version number of the compiler driver
1256 program and of the preprocessor and the compiler proper.
1257
1258 @item -###
1259 @opindex ###
1260 Like @option{-v} except the commands are not executed and arguments
1261 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1262 This is useful for shell scripts to capture the driver-generated command lines.
1263
1264 @item -pipe
1265 @opindex pipe
1266 Use pipes rather than temporary files for communication between the
1267 various stages of compilation. This fails to work on some systems where
1268 the assembler is unable to read from a pipe; but the GNU assembler has
1269 no trouble.
1270
1271 @item --help
1272 @opindex help
1273 Print (on the standard output) a description of the command-line options
1274 understood by @command{gcc}. If the @option{-v} option is also specified
1275 then @option{--help} is also passed on to the various processes
1276 invoked by @command{gcc}, so that they can display the command-line options
1277 they accept. If the @option{-Wextra} option has also been specified
1278 (prior to the @option{--help} option), then command-line options that
1279 have no documentation associated with them are also displayed.
1280
1281 @item --target-help
1282 @opindex target-help
1283 Print (on the standard output) a description of target-specific command-line
1284 options for each tool. For some targets extra target-specific
1285 information may also be printed.
1286
1287 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1288 Print (on the standard output) a description of the command-line
1289 options understood by the compiler that fit into all specified classes
1290 and qualifiers. These are the supported classes:
1291
1292 @table @asis
1293 @item @samp{optimizers}
1294 Display all of the optimization options supported by the
1295 compiler.
1296
1297 @item @samp{warnings}
1298 Display all of the options controlling warning messages
1299 produced by the compiler.
1300
1301 @item @samp{target}
1302 Display target-specific options. Unlike the
1303 @option{--target-help} option however, target-specific options of the
1304 linker and assembler are not displayed. This is because those
1305 tools do not currently support the extended @option{--help=} syntax.
1306
1307 @item @samp{params}
1308 Display the values recognized by the @option{--param}
1309 option.
1310
1311 @item @var{language}
1312 Display the options supported for @var{language}, where
1313 @var{language} is the name of one of the languages supported in this
1314 version of GCC@.
1315
1316 @item @samp{common}
1317 Display the options that are common to all languages.
1318 @end table
1319
1320 These are the supported qualifiers:
1321
1322 @table @asis
1323 @item @samp{undocumented}
1324 Display only those options that are undocumented.
1325
1326 @item @samp{joined}
1327 Display options taking an argument that appears after an equal
1328 sign in the same continuous piece of text, such as:
1329 @samp{--help=target}.
1330
1331 @item @samp{separate}
1332 Display options taking an argument that appears as a separate word
1333 following the original option, such as: @samp{-o output-file}.
1334 @end table
1335
1336 Thus for example to display all the undocumented target-specific
1337 switches supported by the compiler the following can be used:
1338
1339 @smallexample
1340 --help=target,undocumented
1341 @end smallexample
1342
1343 The sense of a qualifier can be inverted by prefixing it with the
1344 @samp{^} character, so for example to display all binary warning
1345 options (i.e., ones that are either on or off and that do not take an
1346 argument) that have a description, use:
1347
1348 @smallexample
1349 --help=warnings,^joined,^undocumented
1350 @end smallexample
1351
1352 The argument to @option{--help=} should not consist solely of inverted
1353 qualifiers.
1354
1355 Combining several classes is possible, although this usually
1356 restricts the output by so much that there is nothing to display. One
1357 case where it does work however is when one of the classes is
1358 @var{target}. So for example to display all the target-specific
1359 optimization options the following can be used:
1360
1361 @smallexample
1362 --help=target,optimizers
1363 @end smallexample
1364
1365 The @option{--help=} option can be repeated on the command line. Each
1366 successive use displays its requested class of options, skipping
1367 those that have already been displayed.
1368
1369 If the @option{-Q} option appears on the command line before the
1370 @option{--help=} option, then the descriptive text displayed by
1371 @option{--help=} is changed. Instead of describing the displayed
1372 options, an indication is given as to whether the option is enabled,
1373 disabled or set to a specific value (assuming that the compiler
1374 knows this at the point where the @option{--help=} option is used).
1375
1376 Here is a truncated example from the ARM port of @command{gcc}:
1377
1378 @smallexample
1379 % gcc -Q -mabi=2 --help=target -c
1380 The following options are target specific:
1381 -mabi= 2
1382 -mabort-on-noreturn [disabled]
1383 -mapcs [disabled]
1384 @end smallexample
1385
1386 The output is sensitive to the effects of previous command-line
1387 options, so for example it is possible to find out which optimizations
1388 are enabled at @option{-O2} by using:
1389
1390 @smallexample
1391 -Q -O2 --help=optimizers
1392 @end smallexample
1393
1394 Alternatively you can discover which binary optimizations are enabled
1395 by @option{-O3} by using:
1396
1397 @smallexample
1398 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1399 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1400 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1401 @end smallexample
1402
1403 @item -no-canonical-prefixes
1404 @opindex no-canonical-prefixes
1405 Do not expand any symbolic links, resolve references to @samp{/../}
1406 or @samp{/./}, or make the path absolute when generating a relative
1407 prefix.
1408
1409 @item --version
1410 @opindex version
1411 Display the version number and copyrights of the invoked GCC@.
1412
1413 @item -wrapper
1414 @opindex wrapper
1415 Invoke all subcommands under a wrapper program. The name of the
1416 wrapper program and its parameters are passed as a comma separated
1417 list.
1418
1419 @smallexample
1420 gcc -c t.c -wrapper gdb,--args
1421 @end smallexample
1422
1423 @noindent
1424 This invokes all subprograms of @command{gcc} under
1425 @samp{gdb --args}, thus the invocation of @command{cc1} is
1426 @samp{gdb --args cc1 @dots{}}.
1427
1428 @item -fplugin=@var{name}.so
1429 Load the plugin code in file @var{name}.so, assumed to be a
1430 shared object to be dlopen'd by the compiler. The base name of
1431 the shared object file is used to identify the plugin for the
1432 purposes of argument parsing (See
1433 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1434 Each plugin should define the callback functions specified in the
1435 Plugins API.
1436
1437 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1438 Define an argument called @var{key} with a value of @var{value}
1439 for the plugin called @var{name}.
1440
1441 @item -fdump-ada-spec@r{[}-slim@r{]}
1442 For C and C++ source and include files, generate corresponding Ada
1443 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1444 GNAT User's Guide}, which provides detailed documentation on this feature.
1445
1446 @item -fdump-go-spec=@var{file}
1447 For input files in any language, generate corresponding Go
1448 declarations in @var{file}. This generates Go @code{const},
1449 @code{type}, @code{var}, and @code{func} declarations which may be a
1450 useful way to start writing a Go interface to code written in some
1451 other language.
1452
1453 @include @value{srcdir}/../libiberty/at-file.texi
1454 @end table
1455
1456 @node Invoking G++
1457 @section Compiling C++ Programs
1458
1459 @cindex suffixes for C++ source
1460 @cindex C++ source file suffixes
1461 C++ source files conventionally use one of the suffixes @samp{.C},
1462 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1463 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1464 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1465 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1466 files with these names and compiles them as C++ programs even if you
1467 call the compiler the same way as for compiling C programs (usually
1468 with the name @command{gcc}).
1469
1470 @findex g++
1471 @findex c++
1472 However, the use of @command{gcc} does not add the C++ library.
1473 @command{g++} is a program that calls GCC and treats @samp{.c},
1474 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1475 files unless @option{-x} is used, and automatically specifies linking
1476 against the C++ library. This program is also useful when
1477 precompiling a C header file with a @samp{.h} extension for use in C++
1478 compilations. On many systems, @command{g++} is also installed with
1479 the name @command{c++}.
1480
1481 @cindex invoking @command{g++}
1482 When you compile C++ programs, you may specify many of the same
1483 command-line options that you use for compiling programs in any
1484 language; or command-line options meaningful for C and related
1485 languages; or options that are meaningful only for C++ programs.
1486 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1487 explanations of options for languages related to C@.
1488 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1489 explanations of options that are meaningful only for C++ programs.
1490
1491 @node C Dialect Options
1492 @section Options Controlling C Dialect
1493 @cindex dialect options
1494 @cindex language dialect options
1495 @cindex options, dialect
1496
1497 The following options control the dialect of C (or languages derived
1498 from C, such as C++, Objective-C and Objective-C++) that the compiler
1499 accepts:
1500
1501 @table @gcctabopt
1502 @cindex ANSI support
1503 @cindex ISO support
1504 @item -ansi
1505 @opindex ansi
1506 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1507 equivalent to @option{-std=c++98}.
1508
1509 This turns off certain features of GCC that are incompatible with ISO
1510 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1511 such as the @code{asm} and @code{typeof} keywords, and
1512 predefined macros such as @code{unix} and @code{vax} that identify the
1513 type of system you are using. It also enables the undesirable and
1514 rarely used ISO trigraph feature. For the C compiler,
1515 it disables recognition of C++ style @samp{//} comments as well as
1516 the @code{inline} keyword.
1517
1518 The alternate keywords @code{__asm__}, @code{__extension__},
1519 @code{__inline__} and @code{__typeof__} continue to work despite
1520 @option{-ansi}. You would not want to use them in an ISO C program, of
1521 course, but it is useful to put them in header files that might be included
1522 in compilations done with @option{-ansi}. Alternate predefined macros
1523 such as @code{__unix__} and @code{__vax__} are also available, with or
1524 without @option{-ansi}.
1525
1526 The @option{-ansi} option does not cause non-ISO programs to be
1527 rejected gratuitously. For that, @option{-Wpedantic} is required in
1528 addition to @option{-ansi}. @xref{Warning Options}.
1529
1530 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1531 option is used. Some header files may notice this macro and refrain
1532 from declaring certain functions or defining certain macros that the
1533 ISO standard doesn't call for; this is to avoid interfering with any
1534 programs that might use these names for other things.
1535
1536 Functions that are normally built in but do not have semantics
1537 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1538 functions when @option{-ansi} is used. @xref{Other Builtins,,Other
1539 built-in functions provided by GCC}, for details of the functions
1540 affected.
1541
1542 @item -std=
1543 @opindex std
1544 Determine the language standard. @xref{Standards,,Language Standards
1545 Supported by GCC}, for details of these standard versions. This option
1546 is currently only supported when compiling C or C++.
1547
1548 The compiler can accept several base standards, such as @samp{c90} or
1549 @samp{c++98}, and GNU dialects of those standards, such as
1550 @samp{gnu90} or @samp{gnu++98}. When a base standard is specified, the
1551 compiler accepts all programs following that standard plus those
1552 using GNU extensions that do not contradict it. For example,
1553 @option{-std=c90} turns off certain features of GCC that are
1554 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1555 keywords, but not other GNU extensions that do not have a meaning in
1556 ISO C90, such as omitting the middle term of a @code{?:}
1557 expression. On the other hand, by specifying a GNU dialect of a
1558 standard, all features the compiler support are enabled, even when
1559 those features change the meaning of the base standard and some
1560 strict-conforming programs may be rejected. The particular standard
1561 is used by @option{-Wpedantic} to identify which features are GNU
1562 extensions given that version of the standard. For example
1563 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1564 comments, while @option{-std=gnu99 -Wpedantic} does not.
1565
1566 A value for this option must be provided; possible values are
1567
1568 @table @samp
1569 @item c90
1570 @itemx c89
1571 @itemx iso9899:1990
1572 Support all ISO C90 programs (certain GNU extensions that conflict
1573 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1574
1575 @item iso9899:199409
1576 ISO C90 as modified in amendment 1.
1577
1578 @item c99
1579 @itemx c9x
1580 @itemx iso9899:1999
1581 @itemx iso9899:199x
1582 ISO C99. Note that this standard is not yet fully supported; see
1583 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1584 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1585
1586 @item c11
1587 @itemx c1x
1588 @itemx iso9899:2011
1589 ISO C11, the 2011 revision of the ISO C standard.
1590 Support is incomplete and experimental. The name @samp{c1x} is
1591 deprecated.
1592
1593 @item gnu90
1594 @itemx gnu89
1595 GNU dialect of ISO C90 (including some C99 features). This
1596 is the default for C code.
1597
1598 @item gnu99
1599 @itemx gnu9x
1600 GNU dialect of ISO C99. When ISO C99 is fully implemented in GCC,
1601 this will become the default. The name @samp{gnu9x} is deprecated.
1602
1603 @item gnu11
1604 @item gnu1x
1605 GNU dialect of ISO C11. Support is incomplete and experimental. The
1606 name @samp{gnu1x} is deprecated.
1607
1608 @item c++98
1609 @itemx c++03
1610 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1611 additional defect reports. Same as @option{-ansi} for C++ code.
1612
1613 @item gnu++98
1614 @itemx gnu++03
1615 GNU dialect of @option{-std=c++98}. This is the default for
1616 C++ code.
1617
1618 @item c++11
1619 @itemx c++0x
1620 The 2011 ISO C++ standard plus amendments. Support for C++11 is still
1621 experimental, and may change in incompatible ways in future releases.
1622 The name @samp{c++0x} is deprecated.
1623
1624 @item gnu++11
1625 @itemx gnu++0x
1626 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1627 experimental, and may change in incompatible ways in future releases.
1628 The name @samp{gnu++0x} is deprecated.
1629
1630 @item c++1y
1631 The next revision of the ISO C++ standard, tentatively planned for
1632 2017. Support is highly experimental, and will almost certainly
1633 change in incompatible ways in future releases.
1634
1635 @item gnu++1y
1636 GNU dialect of @option{-std=c++1y}. Support is highly experimental,
1637 and will almost certainly change in incompatible ways in future
1638 releases.
1639 @end table
1640
1641 @item -fgnu89-inline
1642 @opindex fgnu89-inline
1643 The option @option{-fgnu89-inline} tells GCC to use the traditional
1644 GNU semantics for @code{inline} functions when in C99 mode.
1645 @xref{Inline,,An Inline Function is As Fast As a Macro}. This option
1646 is accepted and ignored by GCC versions 4.1.3 up to but not including
1647 4.3. In GCC versions 4.3 and later it changes the behavior of GCC in
1648 C99 mode. Using this option is roughly equivalent to adding the
1649 @code{gnu_inline} function attribute to all inline functions
1650 (@pxref{Function Attributes}).
1651
1652 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1653 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1654 specifies the default behavior). This option was first supported in
1655 GCC 4.3. This option is not supported in @option{-std=c90} or
1656 @option{-std=gnu90} mode.
1657
1658 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1659 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1660 in effect for @code{inline} functions. @xref{Common Predefined
1661 Macros,,,cpp,The C Preprocessor}.
1662
1663 @item -aux-info @var{filename}
1664 @opindex aux-info
1665 Output to the given filename prototyped declarations for all functions
1666 declared and/or defined in a translation unit, including those in header
1667 files. This option is silently ignored in any language other than C@.
1668
1669 Besides declarations, the file indicates, in comments, the origin of
1670 each declaration (source file and line), whether the declaration was
1671 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1672 @samp{O} for old, respectively, in the first character after the line
1673 number and the colon), and whether it came from a declaration or a
1674 definition (@samp{C} or @samp{F}, respectively, in the following
1675 character). In the case of function definitions, a K&R-style list of
1676 arguments followed by their declarations is also provided, inside
1677 comments, after the declaration.
1678
1679 @item -fallow-parameterless-variadic-functions
1680 Accept variadic functions without named parameters.
1681
1682 Although it is possible to define such a function, this is not very
1683 useful as it is not possible to read the arguments. This is only
1684 supported for C as this construct is allowed by C++.
1685
1686 @item -fno-asm
1687 @opindex fno-asm
1688 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1689 keyword, so that code can use these words as identifiers. You can use
1690 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1691 instead. @option{-ansi} implies @option{-fno-asm}.
1692
1693 In C++, this switch only affects the @code{typeof} keyword, since
1694 @code{asm} and @code{inline} are standard keywords. You may want to
1695 use the @option{-fno-gnu-keywords} flag instead, which has the same
1696 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1697 switch only affects the @code{asm} and @code{typeof} keywords, since
1698 @code{inline} is a standard keyword in ISO C99.
1699
1700 @item -fno-builtin
1701 @itemx -fno-builtin-@var{function}
1702 @opindex fno-builtin
1703 @cindex built-in functions
1704 Don't recognize built-in functions that do not begin with
1705 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1706 functions provided by GCC}, for details of the functions affected,
1707 including those which are not built-in functions when @option{-ansi} or
1708 @option{-std} options for strict ISO C conformance are used because they
1709 do not have an ISO standard meaning.
1710
1711 GCC normally generates special code to handle certain built-in functions
1712 more efficiently; for instance, calls to @code{alloca} may become single
1713 instructions which adjust the stack directly, and calls to @code{memcpy}
1714 may become inline copy loops. The resulting code is often both smaller
1715 and faster, but since the function calls no longer appear as such, you
1716 cannot set a breakpoint on those calls, nor can you change the behavior
1717 of the functions by linking with a different library. In addition,
1718 when a function is recognized as a built-in function, GCC may use
1719 information about that function to warn about problems with calls to
1720 that function, or to generate more efficient code, even if the
1721 resulting code still contains calls to that function. For example,
1722 warnings are given with @option{-Wformat} for bad calls to
1723 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1724 known not to modify global memory.
1725
1726 With the @option{-fno-builtin-@var{function}} option
1727 only the built-in function @var{function} is
1728 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1729 function is named that is not built-in in this version of GCC, this
1730 option is ignored. There is no corresponding
1731 @option{-fbuiltin-@var{function}} option; if you wish to enable
1732 built-in functions selectively when using @option{-fno-builtin} or
1733 @option{-ffreestanding}, you may define macros such as:
1734
1735 @smallexample
1736 #define abs(n) __builtin_abs ((n))
1737 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1738 @end smallexample
1739
1740 @item -fhosted
1741 @opindex fhosted
1742 @cindex hosted environment
1743
1744 Assert that compilation takes place in a hosted environment. This implies
1745 @option{-fbuiltin}. A hosted environment is one in which the
1746 entire standard library is available, and in which @code{main} has a return
1747 type of @code{int}. Examples are nearly everything except a kernel.
1748 This is equivalent to @option{-fno-freestanding}.
1749
1750 @item -ffreestanding
1751 @opindex ffreestanding
1752 @cindex hosted environment
1753
1754 Assert that compilation takes place in a freestanding environment. This
1755 implies @option{-fno-builtin}. A freestanding environment
1756 is one in which the standard library may not exist, and program startup may
1757 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1758 This is equivalent to @option{-fno-hosted}.
1759
1760 @xref{Standards,,Language Standards Supported by GCC}, for details of
1761 freestanding and hosted environments.
1762
1763 @item -fopenmp
1764 @opindex fopenmp
1765 @cindex OpenMP parallel
1766 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1767 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
1768 compiler generates parallel code according to the OpenMP Application
1769 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}. This option
1770 implies @option{-pthread}, and thus is only supported on targets that
1771 have support for @option{-pthread}.
1772
1773 @item -fgnu-tm
1774 @opindex fgnu-tm
1775 When the option @option{-fgnu-tm} is specified, the compiler
1776 generates code for the Linux variant of Intel's current Transactional
1777 Memory ABI specification document (Revision 1.1, May 6 2009). This is
1778 an experimental feature whose interface may change in future versions
1779 of GCC, as the official specification changes. Please note that not
1780 all architectures are supported for this feature.
1781
1782 For more information on GCC's support for transactional memory,
1783 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1784 Transactional Memory Library}.
1785
1786 Note that the transactional memory feature is not supported with
1787 non-call exceptions (@option{-fnon-call-exceptions}).
1788
1789 @item -fms-extensions
1790 @opindex fms-extensions
1791 Accept some non-standard constructs used in Microsoft header files.
1792
1793 In C++ code, this allows member names in structures to be similar
1794 to previous types declarations.
1795
1796 @smallexample
1797 typedef int UOW;
1798 struct ABC @{
1799 UOW UOW;
1800 @};
1801 @end smallexample
1802
1803 Some cases of unnamed fields in structures and unions are only
1804 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1805 fields within structs/unions}, for details.
1806
1807 @item -fplan9-extensions
1808 Accept some non-standard constructs used in Plan 9 code.
1809
1810 This enables @option{-fms-extensions}, permits passing pointers to
1811 structures with anonymous fields to functions that expect pointers to
1812 elements of the type of the field, and permits referring to anonymous
1813 fields declared using a typedef. @xref{Unnamed Fields,,Unnamed
1814 struct/union fields within structs/unions}, for details. This is only
1815 supported for C, not C++.
1816
1817 @item -trigraphs
1818 @opindex trigraphs
1819 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1820 options for strict ISO C conformance) implies @option{-trigraphs}.
1821
1822 @cindex traditional C language
1823 @cindex C language, traditional
1824 @item -traditional
1825 @itemx -traditional-cpp
1826 @opindex traditional-cpp
1827 @opindex traditional
1828 Formerly, these options caused GCC to attempt to emulate a pre-standard
1829 C compiler. They are now only supported with the @option{-E} switch.
1830 The preprocessor continues to support a pre-standard mode. See the GNU
1831 CPP manual for details.
1832
1833 @item -fcond-mismatch
1834 @opindex fcond-mismatch
1835 Allow conditional expressions with mismatched types in the second and
1836 third arguments. The value of such an expression is void. This option
1837 is not supported for C++.
1838
1839 @item -flax-vector-conversions
1840 @opindex flax-vector-conversions
1841 Allow implicit conversions between vectors with differing numbers of
1842 elements and/or incompatible element types. This option should not be
1843 used for new code.
1844
1845 @item -funsigned-char
1846 @opindex funsigned-char
1847 Let the type @code{char} be unsigned, like @code{unsigned char}.
1848
1849 Each kind of machine has a default for what @code{char} should
1850 be. It is either like @code{unsigned char} by default or like
1851 @code{signed char} by default.
1852
1853 Ideally, a portable program should always use @code{signed char} or
1854 @code{unsigned char} when it depends on the signedness of an object.
1855 But many programs have been written to use plain @code{char} and
1856 expect it to be signed, or expect it to be unsigned, depending on the
1857 machines they were written for. This option, and its inverse, let you
1858 make such a program work with the opposite default.
1859
1860 The type @code{char} is always a distinct type from each of
1861 @code{signed char} or @code{unsigned char}, even though its behavior
1862 is always just like one of those two.
1863
1864 @item -fsigned-char
1865 @opindex fsigned-char
1866 Let the type @code{char} be signed, like @code{signed char}.
1867
1868 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1869 the negative form of @option{-funsigned-char}. Likewise, the option
1870 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1871
1872 @item -fsigned-bitfields
1873 @itemx -funsigned-bitfields
1874 @itemx -fno-signed-bitfields
1875 @itemx -fno-unsigned-bitfields
1876 @opindex fsigned-bitfields
1877 @opindex funsigned-bitfields
1878 @opindex fno-signed-bitfields
1879 @opindex fno-unsigned-bitfields
1880 These options control whether a bit-field is signed or unsigned, when the
1881 declaration does not use either @code{signed} or @code{unsigned}. By
1882 default, such a bit-field is signed, because this is consistent: the
1883 basic integer types such as @code{int} are signed types.
1884 @end table
1885
1886 @node C++ Dialect Options
1887 @section Options Controlling C++ Dialect
1888
1889 @cindex compiler options, C++
1890 @cindex C++ options, command-line
1891 @cindex options, C++
1892 This section describes the command-line options that are only meaningful
1893 for C++ programs; but you can also use most of the GNU compiler options
1894 regardless of what language your program is in. For example, you
1895 might compile a file @code{firstClass.C} like this:
1896
1897 @smallexample
1898 g++ -g -frepo -O -c firstClass.C
1899 @end smallexample
1900
1901 @noindent
1902 In this example, only @option{-frepo} is an option meant
1903 only for C++ programs; you can use the other options with any
1904 language supported by GCC@.
1905
1906 Here is a list of options that are @emph{only} for compiling C++ programs:
1907
1908 @table @gcctabopt
1909
1910 @item -fabi-version=@var{n}
1911 @opindex fabi-version
1912 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1913 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1914 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1915 the version that conforms most closely to the C++ ABI specification.
1916 Therefore, the ABI obtained using version 0 will change as ABI bugs
1917 are fixed.
1918
1919 The default is version 2.
1920
1921 Version 3 corrects an error in mangling a constant address as a
1922 template argument.
1923
1924 Version 4, which first appeared in G++ 4.5, implements a standard
1925 mangling for vector types.
1926
1927 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1928 attribute const/volatile on function pointer types, decltype of a
1929 plain decl, and use of a function parameter in the declaration of
1930 another parameter.
1931
1932 Version 6, which first appeared in G++ 4.7, corrects the promotion
1933 behavior of C++11 scoped enums and the mangling of template argument
1934 packs, const/static_cast, prefix ++ and --, and a class scope function
1935 used as a template argument.
1936
1937 See also @option{-Wabi}.
1938
1939 @item -fno-access-control
1940 @opindex fno-access-control
1941 Turn off all access checking. This switch is mainly useful for working
1942 around bugs in the access control code.
1943
1944 @item -fcheck-new
1945 @opindex fcheck-new
1946 Check that the pointer returned by @code{operator new} is non-null
1947 before attempting to modify the storage allocated. This check is
1948 normally unnecessary because the C++ standard specifies that
1949 @code{operator new} only returns @code{0} if it is declared
1950 @samp{throw()}, in which case the compiler always checks the
1951 return value even without this option. In all other cases, when
1952 @code{operator new} has a non-empty exception specification, memory
1953 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1954 @samp{new (nothrow)}.
1955
1956 @item -fconstexpr-depth=@var{n}
1957 @opindex fconstexpr-depth
1958 Set the maximum nested evaluation depth for C++11 constexpr functions
1959 to @var{n}. A limit is needed to detect endless recursion during
1960 constant expression evaluation. The minimum specified by the standard
1961 is 512.
1962
1963 @item -fdeduce-init-list
1964 @opindex fdeduce-init-list
1965 Enable deduction of a template type parameter as
1966 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1967
1968 @smallexample
1969 template <class T> auto forward(T t) -> decltype (realfn (t))
1970 @{
1971 return realfn (t);
1972 @}
1973
1974 void f()
1975 @{
1976 forward(@{1,2@}); // call forward<std::initializer_list<int>>
1977 @}
1978 @end smallexample
1979
1980 This deduction was implemented as a possible extension to the
1981 originally proposed semantics for the C++11 standard, but was not part
1982 of the final standard, so it is disabled by default. This option is
1983 deprecated, and may be removed in a future version of G++.
1984
1985 @item -ffriend-injection
1986 @opindex ffriend-injection
1987 Inject friend functions into the enclosing namespace, so that they are
1988 visible outside the scope of the class in which they are declared.
1989 Friend functions were documented to work this way in the old Annotated
1990 C++ Reference Manual, and versions of G++ before 4.1 always worked
1991 that way. However, in ISO C++ a friend function that is not declared
1992 in an enclosing scope can only be found using argument dependent
1993 lookup. This option causes friends to be injected as they were in
1994 earlier releases.
1995
1996 This option is for compatibility, and may be removed in a future
1997 release of G++.
1998
1999 @item -fno-elide-constructors
2000 @opindex fno-elide-constructors
2001 The C++ standard allows an implementation to omit creating a temporary
2002 that is only used to initialize another object of the same type.
2003 Specifying this option disables that optimization, and forces G++ to
2004 call the copy constructor in all cases.
2005
2006 @item -fno-enforce-eh-specs
2007 @opindex fno-enforce-eh-specs
2008 Don't generate code to check for violation of exception specifications
2009 at run time. This option violates the C++ standard, but may be useful
2010 for reducing code size in production builds, much like defining
2011 @samp{NDEBUG}. This does not give user code permission to throw
2012 exceptions in violation of the exception specifications; the compiler
2013 still optimizes based on the specifications, so throwing an
2014 unexpected exception results in undefined behavior at run time.
2015
2016 @item -ffor-scope
2017 @itemx -fno-for-scope
2018 @opindex ffor-scope
2019 @opindex fno-for-scope
2020 If @option{-ffor-scope} is specified, the scope of variables declared in
2021 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2022 as specified by the C++ standard.
2023 If @option{-fno-for-scope} is specified, the scope of variables declared in
2024 a @i{for-init-statement} extends to the end of the enclosing scope,
2025 as was the case in old versions of G++, and other (traditional)
2026 implementations of C++.
2027
2028 The default if neither flag is given to follow the standard,
2029 but to allow and give a warning for old-style code that would
2030 otherwise be invalid, or have different behavior.
2031
2032 @item -fno-gnu-keywords
2033 @opindex fno-gnu-keywords
2034 Do not recognize @code{typeof} as a keyword, so that code can use this
2035 word as an identifier. You can use the keyword @code{__typeof__} instead.
2036 @option{-ansi} implies @option{-fno-gnu-keywords}.
2037
2038 @item -fno-implicit-templates
2039 @opindex fno-implicit-templates
2040 Never emit code for non-inline templates that are instantiated
2041 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2042 @xref{Template Instantiation}, for more information.
2043
2044 @item -fno-implicit-inline-templates
2045 @opindex fno-implicit-inline-templates
2046 Don't emit code for implicit instantiations of inline templates, either.
2047 The default is to handle inlines differently so that compiles with and
2048 without optimization need the same set of explicit instantiations.
2049
2050 @item -fno-implement-inlines
2051 @opindex fno-implement-inlines
2052 To save space, do not emit out-of-line copies of inline functions
2053 controlled by @samp{#pragma implementation}. This causes linker
2054 errors if these functions are not inlined everywhere they are called.
2055
2056 @item -fms-extensions
2057 @opindex fms-extensions
2058 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2059 int and getting a pointer to member function via non-standard syntax.
2060
2061 @item -fno-nonansi-builtins
2062 @opindex fno-nonansi-builtins
2063 Disable built-in declarations of functions that are not mandated by
2064 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
2065 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2066
2067 @item -fnothrow-opt
2068 @opindex fnothrow-opt
2069 Treat a @code{throw()} exception specification as if it were a
2070 @code{noexcept} specification to reduce or eliminate the text size
2071 overhead relative to a function with no exception specification. If
2072 the function has local variables of types with non-trivial
2073 destructors, the exception specification actually makes the
2074 function smaller because the EH cleanups for those variables can be
2075 optimized away. The semantic effect is that an exception thrown out of
2076 a function with such an exception specification results in a call
2077 to @code{terminate} rather than @code{unexpected}.
2078
2079 @item -fno-operator-names
2080 @opindex fno-operator-names
2081 Do not treat the operator name keywords @code{and}, @code{bitand},
2082 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2083 synonyms as keywords.
2084
2085 @item -fno-optional-diags
2086 @opindex fno-optional-diags
2087 Disable diagnostics that the standard says a compiler does not need to
2088 issue. Currently, the only such diagnostic issued by G++ is the one for
2089 a name having multiple meanings within a class.
2090
2091 @item -fpermissive
2092 @opindex fpermissive
2093 Downgrade some diagnostics about nonconformant code from errors to
2094 warnings. Thus, using @option{-fpermissive} allows some
2095 nonconforming code to compile.
2096
2097 @item -fno-pretty-templates
2098 @opindex fno-pretty-templates
2099 When an error message refers to a specialization of a function
2100 template, the compiler normally prints the signature of the
2101 template followed by the template arguments and any typedefs or
2102 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2103 rather than @code{void f(int)}) so that it's clear which template is
2104 involved. When an error message refers to a specialization of a class
2105 template, the compiler omits any template arguments that match
2106 the default template arguments for that template. If either of these
2107 behaviors make it harder to understand the error message rather than
2108 easier, you can use @option{-fno-pretty-templates} to disable them.
2109
2110 @item -frepo
2111 @opindex frepo
2112 Enable automatic template instantiation at link time. This option also
2113 implies @option{-fno-implicit-templates}. @xref{Template
2114 Instantiation}, for more information.
2115
2116 @item -fno-rtti
2117 @opindex fno-rtti
2118 Disable generation of information about every class with virtual
2119 functions for use by the C++ run-time type identification features
2120 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
2121 of the language, you can save some space by using this flag. Note that
2122 exception handling uses the same information, but G++ generates it as
2123 needed. The @samp{dynamic_cast} operator can still be used for casts that
2124 do not require run-time type information, i.e.@: casts to @code{void *} or to
2125 unambiguous base classes.
2126
2127 @item -fstats
2128 @opindex fstats
2129 Emit statistics about front-end processing at the end of the compilation.
2130 This information is generally only useful to the G++ development team.
2131
2132 @item -fstrict-enums
2133 @opindex fstrict-enums
2134 Allow the compiler to optimize using the assumption that a value of
2135 enumerated type can only be one of the values of the enumeration (as
2136 defined in the C++ standard; basically, a value that can be
2137 represented in the minimum number of bits needed to represent all the
2138 enumerators). This assumption may not be valid if the program uses a
2139 cast to convert an arbitrary integer value to the enumerated type.
2140
2141 @item -ftemplate-backtrace-limit=@var{n}
2142 @opindex ftemplate-backtrace-limit
2143 Set the maximum number of template instantiation notes for a single
2144 warning or error to @var{n}. The default value is 10.
2145
2146 @item -ftemplate-depth=@var{n}
2147 @opindex ftemplate-depth
2148 Set the maximum instantiation depth for template classes to @var{n}.
2149 A limit on the template instantiation depth is needed to detect
2150 endless recursions during template class instantiation. ANSI/ISO C++
2151 conforming programs must not rely on a maximum depth greater than 17
2152 (changed to 1024 in C++11). The default value is 900, as the compiler
2153 can run out of stack space before hitting 1024 in some situations.
2154
2155 @item -fno-threadsafe-statics
2156 @opindex fno-threadsafe-statics
2157 Do not emit the extra code to use the routines specified in the C++
2158 ABI for thread-safe initialization of local statics. You can use this
2159 option to reduce code size slightly in code that doesn't need to be
2160 thread-safe.
2161
2162 @item -fuse-cxa-atexit
2163 @opindex fuse-cxa-atexit
2164 Register destructors for objects with static storage duration with the
2165 @code{__cxa_atexit} function rather than the @code{atexit} function.
2166 This option is required for fully standards-compliant handling of static
2167 destructors, but only works if your C library supports
2168 @code{__cxa_atexit}.
2169
2170 @item -fno-use-cxa-get-exception-ptr
2171 @opindex fno-use-cxa-get-exception-ptr
2172 Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
2173 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2174 if the runtime routine is not available.
2175
2176 @item -fvisibility-inlines-hidden
2177 @opindex fvisibility-inlines-hidden
2178 This switch declares that the user does not attempt to compare
2179 pointers to inline functions or methods where the addresses of the two functions
2180 are taken in different shared objects.
2181
2182 The effect of this is that GCC may, effectively, mark inline methods with
2183 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2184 appear in the export table of a DSO and do not require a PLT indirection
2185 when used within the DSO@. Enabling this option can have a dramatic effect
2186 on load and link times of a DSO as it massively reduces the size of the
2187 dynamic export table when the library makes heavy use of templates.
2188
2189 The behavior of this switch is not quite the same as marking the
2190 methods as hidden directly, because it does not affect static variables
2191 local to the function or cause the compiler to deduce that
2192 the function is defined in only one shared object.
2193
2194 You may mark a method as having a visibility explicitly to negate the
2195 effect of the switch for that method. For example, if you do want to
2196 compare pointers to a particular inline method, you might mark it as
2197 having default visibility. Marking the enclosing class with explicit
2198 visibility has no effect.
2199
2200 Explicitly instantiated inline methods are unaffected by this option
2201 as their linkage might otherwise cross a shared library boundary.
2202 @xref{Template Instantiation}.
2203
2204 @item -fvisibility-ms-compat
2205 @opindex fvisibility-ms-compat
2206 This flag attempts to use visibility settings to make GCC's C++
2207 linkage model compatible with that of Microsoft Visual Studio.
2208
2209 The flag makes these changes to GCC's linkage model:
2210
2211 @enumerate
2212 @item
2213 It sets the default visibility to @code{hidden}, like
2214 @option{-fvisibility=hidden}.
2215
2216 @item
2217 Types, but not their members, are not hidden by default.
2218
2219 @item
2220 The One Definition Rule is relaxed for types without explicit
2221 visibility specifications that are defined in more than one
2222 shared object: those declarations are permitted if they are
2223 permitted when this option is not used.
2224 @end enumerate
2225
2226 In new code it is better to use @option{-fvisibility=hidden} and
2227 export those classes that are intended to be externally visible.
2228 Unfortunately it is possible for code to rely, perhaps accidentally,
2229 on the Visual Studio behavior.
2230
2231 Among the consequences of these changes are that static data members
2232 of the same type with the same name but defined in different shared
2233 objects are different, so changing one does not change the other;
2234 and that pointers to function members defined in different shared
2235 objects may not compare equal. When this flag is given, it is a
2236 violation of the ODR to define types with the same name differently.
2237
2238 @item -fno-weak
2239 @opindex fno-weak
2240 Do not use weak symbol support, even if it is provided by the linker.
2241 By default, G++ uses weak symbols if they are available. This
2242 option exists only for testing, and should not be used by end-users;
2243 it results in inferior code and has no benefits. This option may
2244 be removed in a future release of G++.
2245
2246 @item -nostdinc++
2247 @opindex nostdinc++
2248 Do not search for header files in the standard directories specific to
2249 C++, but do still search the other standard directories. (This option
2250 is used when building the C++ library.)
2251 @end table
2252
2253 In addition, these optimization, warning, and code generation options
2254 have meanings only for C++ programs:
2255
2256 @table @gcctabopt
2257 @item -fno-default-inline
2258 @opindex fno-default-inline
2259 Do not assume @samp{inline} for functions defined inside a class scope.
2260 @xref{Optimize Options,,Options That Control Optimization}. Note that these
2261 functions have linkage like inline functions; they just aren't
2262 inlined by default.
2263
2264 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2265 @opindex Wabi
2266 @opindex Wno-abi
2267 Warn when G++ generates code that is probably not compatible with the
2268 vendor-neutral C++ ABI@. Although an effort has been made to warn about
2269 all such cases, there are probably some cases that are not warned about,
2270 even though G++ is generating incompatible code. There may also be
2271 cases where warnings are emitted even though the code that is generated
2272 is compatible.
2273
2274 You should rewrite your code to avoid these warnings if you are
2275 concerned about the fact that code generated by G++ may not be binary
2276 compatible with code generated by other compilers.
2277
2278 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2279
2280 @itemize @bullet
2281
2282 @item
2283 A template with a non-type template parameter of reference type is
2284 mangled incorrectly:
2285 @smallexample
2286 extern int N;
2287 template <int &> struct S @{@};
2288 void n (S<N>) @{2@}
2289 @end smallexample
2290
2291 This is fixed in @option{-fabi-version=3}.
2292
2293 @item
2294 SIMD vector types declared using @code{__attribute ((vector_size))} are
2295 mangled in a non-standard way that does not allow for overloading of
2296 functions taking vectors of different sizes.
2297
2298 The mangling is changed in @option{-fabi-version=4}.
2299 @end itemize
2300
2301 The known incompatibilities in @option{-fabi-version=1} include:
2302
2303 @itemize @bullet
2304
2305 @item
2306 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
2307 pack data into the same byte as a base class. For example:
2308
2309 @smallexample
2310 struct A @{ virtual void f(); int f1 : 1; @};
2311 struct B : public A @{ int f2 : 1; @};
2312 @end smallexample
2313
2314 @noindent
2315 In this case, G++ places @code{B::f2} into the same byte
2316 as@code{A::f1}; other compilers do not. You can avoid this problem
2317 by explicitly padding @code{A} so that its size is a multiple of the
2318 byte size on your platform; that causes G++ and other compilers to
2319 lay out @code{B} identically.
2320
2321 @item
2322 Incorrect handling of tail-padding for virtual bases. G++ does not use
2323 tail padding when laying out virtual bases. For example:
2324
2325 @smallexample
2326 struct A @{ virtual void f(); char c1; @};
2327 struct B @{ B(); char c2; @};
2328 struct C : public A, public virtual B @{@};
2329 @end smallexample
2330
2331 @noindent
2332 In this case, G++ does not place @code{B} into the tail-padding for
2333 @code{A}; other compilers do. You can avoid this problem by
2334 explicitly padding @code{A} so that its size is a multiple of its
2335 alignment (ignoring virtual base classes); that causes G++ and other
2336 compilers to lay out @code{C} identically.
2337
2338 @item
2339 Incorrect handling of bit-fields with declared widths greater than that
2340 of their underlying types, when the bit-fields appear in a union. For
2341 example:
2342
2343 @smallexample
2344 union U @{ int i : 4096; @};
2345 @end smallexample
2346
2347 @noindent
2348 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2349 union too small by the number of bits in an @code{int}.
2350
2351 @item
2352 Empty classes can be placed at incorrect offsets. For example:
2353
2354 @smallexample
2355 struct A @{@};
2356
2357 struct B @{
2358 A a;
2359 virtual void f ();
2360 @};
2361
2362 struct C : public B, public A @{@};
2363 @end smallexample
2364
2365 @noindent
2366 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2367 it should be placed at offset zero. G++ mistakenly believes that the
2368 @code{A} data member of @code{B} is already at offset zero.
2369
2370 @item
2371 Names of template functions whose types involve @code{typename} or
2372 template template parameters can be mangled incorrectly.
2373
2374 @smallexample
2375 template <typename Q>
2376 void f(typename Q::X) @{@}
2377
2378 template <template <typename> class Q>
2379 void f(typename Q<int>::X) @{@}
2380 @end smallexample
2381
2382 @noindent
2383 Instantiations of these templates may be mangled incorrectly.
2384
2385 @end itemize
2386
2387 It also warns about psABI-related changes. The known psABI changes at this
2388 point include:
2389
2390 @itemize @bullet
2391
2392 @item
2393 For SysV/x86-64, unions with @code{long double} members are
2394 passed in memory as specified in psABI. For example:
2395
2396 @smallexample
2397 union U @{
2398 long double ld;
2399 int i;
2400 @};
2401 @end smallexample
2402
2403 @noindent
2404 @code{union U} is always passed in memory.
2405
2406 @end itemize
2407
2408 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2409 @opindex Wctor-dtor-privacy
2410 @opindex Wno-ctor-dtor-privacy
2411 Warn when a class seems unusable because all the constructors or
2412 destructors in that class are private, and it has neither friends nor
2413 public static member functions.
2414
2415 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2416 @opindex Wdelete-non-virtual-dtor
2417 @opindex Wno-delete-non-virtual-dtor
2418 Warn when @samp{delete} is used to destroy an instance of a class that
2419 has virtual functions and non-virtual destructor. It is unsafe to delete
2420 an instance of a derived class through a pointer to a base class if the
2421 base class does not have a virtual destructor. This warning is enabled
2422 by @option{-Wall}.
2423
2424 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2425 @opindex Wliteral-suffix
2426 @opindex Wno-literal-suffix
2427 Warn when a string or character literal is followed by a ud-suffix which does
2428 not begin with an underscore. As a conforming extension, GCC treats such
2429 suffixes as separate preprocessing tokens in order to maintain backwards
2430 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2431 For example:
2432
2433 @smallexample
2434 #define __STDC_FORMAT_MACROS
2435 #include <inttypes.h>
2436 #include <stdio.h>
2437
2438 int main() @{
2439 int64_t i64 = 123;
2440 printf("My int64: %"PRId64"\n", i64);
2441 @}
2442 @end smallexample
2443
2444 In this case, @code{PRId64} is treated as a separate preprocessing token.
2445
2446 This warning is enabled by default.
2447
2448 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2449 @opindex Wnarrowing
2450 @opindex Wno-narrowing
2451 Warn when a narrowing conversion prohibited by C++11 occurs within
2452 @samp{@{ @}}, e.g.
2453
2454 @smallexample
2455 int i = @{ 2.2 @}; // error: narrowing from double to int
2456 @end smallexample
2457
2458 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2459
2460 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2461 required by the standard. Note that this does not affect the meaning
2462 of well-formed code; narrowing conversions are still considered
2463 ill-formed in SFINAE context.
2464
2465 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2466 @opindex Wnoexcept
2467 @opindex Wno-noexcept
2468 Warn when a noexcept-expression evaluates to false because of a call
2469 to a function that does not have a non-throwing exception
2470 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2471 the compiler to never throw an exception.
2472
2473 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2474 @opindex Wnon-virtual-dtor
2475 @opindex Wno-non-virtual-dtor
2476 Warn when a class has virtual functions and an accessible non-virtual
2477 destructor, in which case it is possible but unsafe to delete
2478 an instance of a derived class through a pointer to the base class.
2479 This warning is also enabled if @option{-Weffc++} is specified.
2480
2481 @item -Wreorder @r{(C++ and Objective-C++ only)}
2482 @opindex Wreorder
2483 @opindex Wno-reorder
2484 @cindex reordering, warning
2485 @cindex warning for reordering of member initializers
2486 Warn when the order of member initializers given in the code does not
2487 match the order in which they must be executed. For instance:
2488
2489 @smallexample
2490 struct A @{
2491 int i;
2492 int j;
2493 A(): j (0), i (1) @{ @}
2494 @};
2495 @end smallexample
2496
2497 @noindent
2498 The compiler rearranges the member initializers for @samp{i}
2499 and @samp{j} to match the declaration order of the members, emitting
2500 a warning to that effect. This warning is enabled by @option{-Wall}.
2501 @end table
2502
2503 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2504
2505 @table @gcctabopt
2506 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2507 @opindex Weffc++
2508 @opindex Wno-effc++
2509 Warn about violations of the following style guidelines from Scott Meyers'
2510 @cite{Effective C++, Second Edition} book:
2511
2512 @itemize @bullet
2513 @item
2514 Item 11: Define a copy constructor and an assignment operator for classes
2515 with dynamically allocated memory.
2516
2517 @item
2518 Item 12: Prefer initialization to assignment in constructors.
2519
2520 @item
2521 Item 14: Make destructors virtual in base classes.
2522
2523 @item
2524 Item 15: Have @code{operator=} return a reference to @code{*this}.
2525
2526 @item
2527 Item 23: Don't try to return a reference when you must return an object.
2528
2529 @end itemize
2530
2531 Also warn about violations of the following style guidelines from
2532 Scott Meyers' @cite{More Effective C++} book:
2533
2534 @itemize @bullet
2535 @item
2536 Item 6: Distinguish between prefix and postfix forms of increment and
2537 decrement operators.
2538
2539 @item
2540 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
2541
2542 @end itemize
2543
2544 When selecting this option, be aware that the standard library
2545 headers do not obey all of these guidelines; use @samp{grep -v}
2546 to filter out those warnings.
2547
2548 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2549 @opindex Wstrict-null-sentinel
2550 @opindex Wno-strict-null-sentinel
2551 Warn also about the use of an uncasted @code{NULL} as sentinel. When
2552 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2553 to @code{__null}. Although it is a null pointer constant not a null pointer,
2554 it is guaranteed to be of the same size as a pointer. But this use is
2555 not portable across different compilers.
2556
2557 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2558 @opindex Wno-non-template-friend
2559 @opindex Wnon-template-friend
2560 Disable warnings when non-templatized friend functions are declared
2561 within a template. Since the advent of explicit template specification
2562 support in G++, if the name of the friend is an unqualified-id (i.e.,
2563 @samp{friend foo(int)}), the C++ language specification demands that the
2564 friend declare or define an ordinary, nontemplate function. (Section
2565 14.5.3). Before G++ implemented explicit specification, unqualified-ids
2566 could be interpreted as a particular specialization of a templatized
2567 function. Because this non-conforming behavior is no longer the default
2568 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2569 check existing code for potential trouble spots and is on by default.
2570 This new compiler behavior can be turned off with
2571 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2572 but disables the helpful warning.
2573
2574 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2575 @opindex Wold-style-cast
2576 @opindex Wno-old-style-cast
2577 Warn if an old-style (C-style) cast to a non-void type is used within
2578 a C++ program. The new-style casts (@samp{dynamic_cast},
2579 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2580 less vulnerable to unintended effects and much easier to search for.
2581
2582 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2583 @opindex Woverloaded-virtual
2584 @opindex Wno-overloaded-virtual
2585 @cindex overloaded virtual function, warning
2586 @cindex warning for overloaded virtual function
2587 Warn when a function declaration hides virtual functions from a
2588 base class. For example, in:
2589
2590 @smallexample
2591 struct A @{
2592 virtual void f();
2593 @};
2594
2595 struct B: public A @{
2596 void f(int);
2597 @};
2598 @end smallexample
2599
2600 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2601 like:
2602
2603 @smallexample
2604 B* b;
2605 b->f();
2606 @end smallexample
2607
2608 @noindent
2609 fails to compile.
2610
2611 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2612 @opindex Wno-pmf-conversions
2613 @opindex Wpmf-conversions
2614 Disable the diagnostic for converting a bound pointer to member function
2615 to a plain pointer.
2616
2617 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2618 @opindex Wsign-promo
2619 @opindex Wno-sign-promo
2620 Warn when overload resolution chooses a promotion from unsigned or
2621 enumerated type to a signed type, over a conversion to an unsigned type of
2622 the same size. Previous versions of G++ tried to preserve
2623 unsignedness, but the standard mandates the current behavior.
2624
2625 @smallexample
2626 struct A @{
2627 operator int ();
2628 A& operator = (int);
2629 @};
2630
2631 main ()
2632 @{
2633 A a,b;
2634 a = b;
2635 @}
2636 @end smallexample
2637
2638 @noindent
2639 In this example, G++ synthesizes a default @samp{A& operator =
2640 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2641 @end table
2642
2643 @node Objective-C and Objective-C++ Dialect Options
2644 @section Options Controlling Objective-C and Objective-C++ Dialects
2645
2646 @cindex compiler options, Objective-C and Objective-C++
2647 @cindex Objective-C and Objective-C++ options, command-line
2648 @cindex options, Objective-C and Objective-C++
2649 (NOTE: This manual does not describe the Objective-C and Objective-C++
2650 languages themselves. @xref{Standards,,Language Standards
2651 Supported by GCC}, for references.)
2652
2653 This section describes the command-line options that are only meaningful
2654 for Objective-C and Objective-C++ programs, but you can also use most of
2655 the language-independent GNU compiler options.
2656 For example, you might compile a file @code{some_class.m} like this:
2657
2658 @smallexample
2659 gcc -g -fgnu-runtime -O -c some_class.m
2660 @end smallexample
2661
2662 @noindent
2663 In this example, @option{-fgnu-runtime} is an option meant only for
2664 Objective-C and Objective-C++ programs; you can use the other options with
2665 any language supported by GCC@.
2666
2667 Note that since Objective-C is an extension of the C language, Objective-C
2668 compilations may also use options specific to the C front-end (e.g.,
2669 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
2670 C++-specific options (e.g., @option{-Wabi}).
2671
2672 Here is a list of options that are @emph{only} for compiling Objective-C
2673 and Objective-C++ programs:
2674
2675 @table @gcctabopt
2676 @item -fconstant-string-class=@var{class-name}
2677 @opindex fconstant-string-class
2678 Use @var{class-name} as the name of the class to instantiate for each
2679 literal string specified with the syntax @code{@@"@dots{}"}. The default
2680 class name is @code{NXConstantString} if the GNU runtime is being used, and
2681 @code{NSConstantString} if the NeXT runtime is being used (see below). The
2682 @option{-fconstant-cfstrings} option, if also present, overrides the
2683 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2684 to be laid out as constant CoreFoundation strings.
2685
2686 @item -fgnu-runtime
2687 @opindex fgnu-runtime
2688 Generate object code compatible with the standard GNU Objective-C
2689 runtime. This is the default for most types of systems.
2690
2691 @item -fnext-runtime
2692 @opindex fnext-runtime
2693 Generate output compatible with the NeXT runtime. This is the default
2694 for NeXT-based systems, including Darwin and Mac OS X@. The macro
2695 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2696 used.
2697
2698 @item -fno-nil-receivers
2699 @opindex fno-nil-receivers
2700 Assume that all Objective-C message dispatches (@code{[receiver
2701 message:arg]}) in this translation unit ensure that the receiver is
2702 not @code{nil}. This allows for more efficient entry points in the
2703 runtime to be used. This option is only available in conjunction with
2704 the NeXT runtime and ABI version 0 or 1.
2705
2706 @item -fobjc-abi-version=@var{n}
2707 @opindex fobjc-abi-version
2708 Use version @var{n} of the Objective-C ABI for the selected runtime.
2709 This option is currently supported only for the NeXT runtime. In that
2710 case, Version 0 is the traditional (32-bit) ABI without support for
2711 properties and other Objective-C 2.0 additions. Version 1 is the
2712 traditional (32-bit) ABI with support for properties and other
2713 Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If
2714 nothing is specified, the default is Version 0 on 32-bit target
2715 machines, and Version 2 on 64-bit target machines.
2716
2717 @item -fobjc-call-cxx-cdtors
2718 @opindex fobjc-call-cxx-cdtors
2719 For each Objective-C class, check if any of its instance variables is a
2720 C++ object with a non-trivial default constructor. If so, synthesize a
2721 special @code{- (id) .cxx_construct} instance method which runs
2722 non-trivial default constructors on any such instance variables, in order,
2723 and then return @code{self}. Similarly, check if any instance variable
2724 is a C++ object with a non-trivial destructor, and if so, synthesize a
2725 special @code{- (void) .cxx_destruct} method which runs
2726 all such default destructors, in reverse order.
2727
2728 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2729 methods thusly generated only operate on instance variables
2730 declared in the current Objective-C class, and not those inherited
2731 from superclasses. It is the responsibility of the Objective-C
2732 runtime to invoke all such methods in an object's inheritance
2733 hierarchy. The @code{- (id) .cxx_construct} methods are invoked
2734 by the runtime immediately after a new object instance is allocated;
2735 the @code{- (void) .cxx_destruct} methods are invoked immediately
2736 before the runtime deallocates an object instance.
2737
2738 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2739 support for invoking the @code{- (id) .cxx_construct} and
2740 @code{- (void) .cxx_destruct} methods.
2741
2742 @item -fobjc-direct-dispatch
2743 @opindex fobjc-direct-dispatch
2744 Allow fast jumps to the message dispatcher. On Darwin this is
2745 accomplished via the comm page.
2746
2747 @item -fobjc-exceptions
2748 @opindex fobjc-exceptions
2749 Enable syntactic support for structured exception handling in
2750 Objective-C, similar to what is offered by C++ and Java. This option
2751 is required to use the Objective-C keywords @code{@@try},
2752 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2753 @code{@@synchronized}. This option is available with both the GNU
2754 runtime and the NeXT runtime (but not available in conjunction with
2755 the NeXT runtime on Mac OS X 10.2 and earlier).
2756
2757 @item -fobjc-gc
2758 @opindex fobjc-gc
2759 Enable garbage collection (GC) in Objective-C and Objective-C++
2760 programs. This option is only available with the NeXT runtime; the
2761 GNU runtime has a different garbage collection implementation that
2762 does not require special compiler flags.
2763
2764 @item -fobjc-nilcheck
2765 @opindex fobjc-nilcheck
2766 For the NeXT runtime with version 2 of the ABI, check for a nil
2767 receiver in method invocations before doing the actual method call.
2768 This is the default and can be disabled using
2769 @option{-fno-objc-nilcheck}. Class methods and super calls are never
2770 checked for nil in this way no matter what this flag is set to.
2771 Currently this flag does nothing when the GNU runtime, or an older
2772 version of the NeXT runtime ABI, is used.
2773
2774 @item -fobjc-std=objc1
2775 @opindex fobjc-std
2776 Conform to the language syntax of Objective-C 1.0, the language
2777 recognized by GCC 4.0. This only affects the Objective-C additions to
2778 the C/C++ language; it does not affect conformance to C/C++ standards,
2779 which is controlled by the separate C/C++ dialect option flags. When
2780 this option is used with the Objective-C or Objective-C++ compiler,
2781 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2782 This is useful if you need to make sure that your Objective-C code can
2783 be compiled with older versions of GCC@.
2784
2785 @item -freplace-objc-classes
2786 @opindex freplace-objc-classes
2787 Emit a special marker instructing @command{ld(1)} not to statically link in
2788 the resulting object file, and allow @command{dyld(1)} to load it in at
2789 run time instead. This is used in conjunction with the Fix-and-Continue
2790 debugging mode, where the object file in question may be recompiled and
2791 dynamically reloaded in the course of program execution, without the need
2792 to restart the program itself. Currently, Fix-and-Continue functionality
2793 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2794 and later.
2795
2796 @item -fzero-link
2797 @opindex fzero-link
2798 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2799 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2800 compile time) with static class references that get initialized at load time,
2801 which improves run-time performance. Specifying the @option{-fzero-link} flag
2802 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2803 to be retained. This is useful in Zero-Link debugging mode, since it allows
2804 for individual class implementations to be modified during program execution.
2805 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2806 regardless of command-line options.
2807
2808 @item -gen-decls
2809 @opindex gen-decls
2810 Dump interface declarations for all classes seen in the source file to a
2811 file named @file{@var{sourcename}.decl}.
2812
2813 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2814 @opindex Wassign-intercept
2815 @opindex Wno-assign-intercept
2816 Warn whenever an Objective-C assignment is being intercepted by the
2817 garbage collector.
2818
2819 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2820 @opindex Wno-protocol
2821 @opindex Wprotocol
2822 If a class is declared to implement a protocol, a warning is issued for
2823 every method in the protocol that is not implemented by the class. The
2824 default behavior is to issue a warning for every method not explicitly
2825 implemented in the class, even if a method implementation is inherited
2826 from the superclass. If you use the @option{-Wno-protocol} option, then
2827 methods inherited from the superclass are considered to be implemented,
2828 and no warning is issued for them.
2829
2830 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2831 @opindex Wselector
2832 @opindex Wno-selector
2833 Warn if multiple methods of different types for the same selector are
2834 found during compilation. The check is performed on the list of methods
2835 in the final stage of compilation. Additionally, a check is performed
2836 for each selector appearing in a @code{@@selector(@dots{})}
2837 expression, and a corresponding method for that selector has been found
2838 during compilation. Because these checks scan the method table only at
2839 the end of compilation, these warnings are not produced if the final
2840 stage of compilation is not reached, for example because an error is
2841 found during compilation, or because the @option{-fsyntax-only} option is
2842 being used.
2843
2844 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2845 @opindex Wstrict-selector-match
2846 @opindex Wno-strict-selector-match
2847 Warn if multiple methods with differing argument and/or return types are
2848 found for a given selector when attempting to send a message using this
2849 selector to a receiver of type @code{id} or @code{Class}. When this flag
2850 is off (which is the default behavior), the compiler omits such warnings
2851 if any differences found are confined to types that share the same size
2852 and alignment.
2853
2854 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2855 @opindex Wundeclared-selector
2856 @opindex Wno-undeclared-selector
2857 Warn if a @code{@@selector(@dots{})} expression referring to an
2858 undeclared selector is found. A selector is considered undeclared if no
2859 method with that name has been declared before the
2860 @code{@@selector(@dots{})} expression, either explicitly in an
2861 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2862 an @code{@@implementation} section. This option always performs its
2863 checks as soon as a @code{@@selector(@dots{})} expression is found,
2864 while @option{-Wselector} only performs its checks in the final stage of
2865 compilation. This also enforces the coding style convention
2866 that methods and selectors must be declared before being used.
2867
2868 @item -print-objc-runtime-info
2869 @opindex print-objc-runtime-info
2870 Generate C header describing the largest structure that is passed by
2871 value, if any.
2872
2873 @end table
2874
2875 @node Language Independent Options
2876 @section Options to Control Diagnostic Messages Formatting
2877 @cindex options to control diagnostics formatting
2878 @cindex diagnostic messages
2879 @cindex message formatting
2880
2881 Traditionally, diagnostic messages have been formatted irrespective of
2882 the output device's aspect (e.g.@: its width, @dots{}). You can use the
2883 options described below
2884 to control the formatting algorithm for diagnostic messages,
2885 e.g.@: how many characters per line, how often source location
2886 information should be reported. Note that some language front ends may not
2887 honor these options.
2888
2889 @table @gcctabopt
2890 @item -fmessage-length=@var{n}
2891 @opindex fmessage-length
2892 Try to format error messages so that they fit on lines of about @var{n}
2893 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2894 the front ends supported by GCC@. If @var{n} is zero, then no
2895 line-wrapping is done; each error message appears on a single
2896 line.
2897
2898 @item -fdiagnostics-show-location=once
2899 @opindex fdiagnostics-show-location
2900 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2901 reporter to emit @emph{once} source location information; that is, in
2902 case the message is too long to fit on a single physical line and has to
2903 be wrapped, the source location won't be emitted (as prefix) again,
2904 over and over, in subsequent continuation lines. This is the default
2905 behavior.
2906
2907 @item -fdiagnostics-show-location=every-line
2908 Only meaningful in line-wrapping mode. Instructs the diagnostic
2909 messages reporter to emit the same source location information (as
2910 prefix) for physical lines that result from the process of breaking
2911 a message which is too long to fit on a single line.
2912
2913 @item -fno-diagnostics-show-option
2914 @opindex fno-diagnostics-show-option
2915 @opindex fdiagnostics-show-option
2916 By default, each diagnostic emitted includes text indicating the
2917 command-line option that directly controls the diagnostic (if such an
2918 option is known to the diagnostic machinery). Specifying the
2919 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2920
2921 @item -fno-diagnostics-show-caret
2922 @opindex fno-diagnostics-show-caret
2923 @opindex fdiagnostics-show-caret
2924 By default, each diagnostic emitted includes the original source line
2925 and a caret '^' indicating the column. This option suppresses this
2926 information.
2927
2928 @end table
2929
2930 @node Warning Options
2931 @section Options to Request or Suppress Warnings
2932 @cindex options to control warnings
2933 @cindex warning messages
2934 @cindex messages, warning
2935 @cindex suppressing warnings
2936
2937 Warnings are diagnostic messages that report constructions that
2938 are not inherently erroneous but that are risky or suggest there
2939 may have been an error.
2940
2941 The following language-independent options do not enable specific
2942 warnings but control the kinds of diagnostics produced by GCC@.
2943
2944 @table @gcctabopt
2945 @cindex syntax checking
2946 @item -fsyntax-only
2947 @opindex fsyntax-only
2948 Check the code for syntax errors, but don't do anything beyond that.
2949
2950 @item -fmax-errors=@var{n}
2951 @opindex fmax-errors
2952 Limits the maximum number of error messages to @var{n}, at which point
2953 GCC bails out rather than attempting to continue processing the source
2954 code. If @var{n} is 0 (the default), there is no limit on the number
2955 of error messages produced. If @option{-Wfatal-errors} is also
2956 specified, then @option{-Wfatal-errors} takes precedence over this
2957 option.
2958
2959 @item -w
2960 @opindex w
2961 Inhibit all warning messages.
2962
2963 @item -Werror
2964 @opindex Werror
2965 @opindex Wno-error
2966 Make all warnings into errors.
2967
2968 @item -Werror=
2969 @opindex Werror=
2970 @opindex Wno-error=
2971 Make the specified warning into an error. The specifier for a warning
2972 is appended, for example @option{-Werror=switch} turns the warnings
2973 controlled by @option{-Wswitch} into errors. This switch takes a
2974 negative form, to be used to negate @option{-Werror} for specific
2975 warnings, for example @option{-Wno-error=switch} makes
2976 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2977 is in effect.
2978
2979 The warning message for each controllable warning includes the
2980 option that controls the warning. That option can then be used with
2981 @option{-Werror=} and @option{-Wno-error=} as described above.
2982 (Printing of the option in the warning message can be disabled using the
2983 @option{-fno-diagnostics-show-option} flag.)
2984
2985 Note that specifying @option{-Werror=}@var{foo} automatically implies
2986 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
2987 imply anything.
2988
2989 @item -Wfatal-errors
2990 @opindex Wfatal-errors
2991 @opindex Wno-fatal-errors
2992 This option causes the compiler to abort compilation on the first error
2993 occurred rather than trying to keep going and printing further error
2994 messages.
2995
2996 @end table
2997
2998 You can request many specific warnings with options beginning
2999 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3000 implicit declarations. Each of these specific warning options also
3001 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3002 example, @option{-Wno-implicit}. This manual lists only one of the
3003 two forms, whichever is not the default. For further,
3004 language-specific options also refer to @ref{C++ Dialect Options} and
3005 @ref{Objective-C and Objective-C++ Dialect Options}.
3006
3007 When an unrecognized warning option is requested (e.g.,
3008 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3009 that the option is not recognized. However, if the @option{-Wno-} form
3010 is used, the behavior is slightly different: no diagnostic is
3011 produced for @option{-Wno-unknown-warning} unless other diagnostics
3012 are being produced. This allows the use of new @option{-Wno-} options
3013 with old compilers, but if something goes wrong, the compiler
3014 warns that an unrecognized option is present.
3015
3016 @table @gcctabopt
3017 @item -Wpedantic
3018 @itemx -pedantic
3019 @opindex pedantic
3020 @opindex Wpedantic
3021 Issue all the warnings demanded by strict ISO C and ISO C++;
3022 reject all programs that use forbidden extensions, and some other
3023 programs that do not follow ISO C and ISO C++. For ISO C, follows the
3024 version of the ISO C standard specified by any @option{-std} option used.
3025
3026 Valid ISO C and ISO C++ programs should compile properly with or without
3027 this option (though a rare few require @option{-ansi} or a
3028 @option{-std} option specifying the required version of ISO C)@. However,
3029 without this option, certain GNU extensions and traditional C and C++
3030 features are supported as well. With this option, they are rejected.
3031
3032 @option{-Wpedantic} does not cause warning messages for use of the
3033 alternate keywords whose names begin and end with @samp{__}. Pedantic
3034 warnings are also disabled in the expression that follows
3035 @code{__extension__}. However, only system header files should use
3036 these escape routes; application programs should avoid them.
3037 @xref{Alternate Keywords}.
3038
3039 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3040 C conformance. They soon find that it does not do quite what they want:
3041 it finds some non-ISO practices, but not all---only those for which
3042 ISO C @emph{requires} a diagnostic, and some others for which
3043 diagnostics have been added.
3044
3045 A feature to report any failure to conform to ISO C might be useful in
3046 some instances, but would require considerable additional work and would
3047 be quite different from @option{-Wpedantic}. We don't have plans to
3048 support such a feature in the near future.
3049
3050 Where the standard specified with @option{-std} represents a GNU
3051 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3052 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3053 extended dialect is based. Warnings from @option{-Wpedantic} are given
3054 where they are required by the base standard. (It does not make sense
3055 for such warnings to be given only for features not in the specified GNU
3056 C dialect, since by definition the GNU dialects of C include all
3057 features the compiler supports with the given option, and there would be
3058 nothing to warn about.)
3059
3060 @item -pedantic-errors
3061 @opindex pedantic-errors
3062 Like @option{-Wpedantic}, except that errors are produced rather than
3063 warnings.
3064
3065 @item -Wall
3066 @opindex Wall
3067 @opindex Wno-all
3068 This enables all the warnings about constructions that some users
3069 consider questionable, and that are easy to avoid (or modify to
3070 prevent the warning), even in conjunction with macros. This also
3071 enables some language-specific warnings described in @ref{C++ Dialect
3072 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3073
3074 @option{-Wall} turns on the following warning flags:
3075
3076 @gccoptlist{-Waddress @gol
3077 -Warray-bounds @r{(only with} @option{-O2}@r{)} @gol
3078 -Wc++11-compat @gol
3079 -Wchar-subscripts @gol
3080 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3081 -Wimplicit-int @r{(C and Objective-C only)} @gol
3082 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3083 -Wcomment @gol
3084 -Wformat @gol
3085 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} @gol
3086 -Wmaybe-uninitialized @gol
3087 -Wmissing-braces @r{(only for C/ObjC)} @gol
3088 -Wnonnull @gol
3089 -Wparentheses @gol
3090 -Wpointer-sign @gol
3091 -Wreorder @gol
3092 -Wreturn-type @gol
3093 -Wsequence-point @gol
3094 -Wsign-compare @r{(only in C++)} @gol
3095 -Wstrict-aliasing @gol
3096 -Wstrict-overflow=1 @gol
3097 -Wswitch @gol
3098 -Wtrigraphs @gol
3099 -Wuninitialized @gol
3100 -Wunknown-pragmas @gol
3101 -Wunused-function @gol
3102 -Wunused-label @gol
3103 -Wunused-value @gol
3104 -Wunused-variable @gol
3105 -Wvolatile-register-var @gol
3106 }
3107
3108 Note that some warning flags are not implied by @option{-Wall}. Some of
3109 them warn about constructions that users generally do not consider
3110 questionable, but which occasionally you might wish to check for;
3111 others warn about constructions that are necessary or hard to avoid in
3112 some cases, and there is no simple way to modify the code to suppress
3113 the warning. Some of them are enabled by @option{-Wextra} but many of
3114 them must be enabled individually.
3115
3116 @item -Wextra
3117 @opindex W
3118 @opindex Wextra
3119 @opindex Wno-extra
3120 This enables some extra warning flags that are not enabled by
3121 @option{-Wall}. (This option used to be called @option{-W}. The older
3122 name is still supported, but the newer name is more descriptive.)
3123
3124 @gccoptlist{-Wclobbered @gol
3125 -Wempty-body @gol
3126 -Wignored-qualifiers @gol
3127 -Wmissing-field-initializers @gol
3128 -Wmissing-parameter-type @r{(C only)} @gol
3129 -Wold-style-declaration @r{(C only)} @gol
3130 -Woverride-init @gol
3131 -Wsign-compare @gol
3132 -Wtype-limits @gol
3133 -Wuninitialized @gol
3134 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3135 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3136 }
3137
3138 The option @option{-Wextra} also prints warning messages for the
3139 following cases:
3140
3141 @itemize @bullet
3142
3143 @item
3144 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3145 @samp{>}, or @samp{>=}.
3146
3147 @item
3148 (C++ only) An enumerator and a non-enumerator both appear in a
3149 conditional expression.
3150
3151 @item
3152 (C++ only) Ambiguous virtual bases.
3153
3154 @item
3155 (C++ only) Subscripting an array that has been declared @samp{register}.
3156
3157 @item
3158 (C++ only) Taking the address of a variable that has been declared
3159 @samp{register}.
3160
3161 @item
3162 (C++ only) A base class is not initialized in a derived class' copy
3163 constructor.
3164
3165 @end itemize
3166
3167 @item -Wchar-subscripts
3168 @opindex Wchar-subscripts
3169 @opindex Wno-char-subscripts
3170 Warn if an array subscript has type @code{char}. This is a common cause
3171 of error, as programmers often forget that this type is signed on some
3172 machines.
3173 This warning is enabled by @option{-Wall}.
3174
3175 @item -Wcomment
3176 @opindex Wcomment
3177 @opindex Wno-comment
3178 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3179 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3180 This warning is enabled by @option{-Wall}.
3181
3182 @item -Wno-coverage-mismatch
3183 @opindex Wno-coverage-mismatch
3184 Warn if feedback profiles do not match when using the
3185 @option{-fprofile-use} option.
3186 If a source file is changed between compiling with @option{-fprofile-gen} and
3187 with @option{-fprofile-use}, the files with the profile feedback can fail
3188 to match the source file and GCC cannot use the profile feedback
3189 information. By default, this warning is enabled and is treated as an
3190 error. @option{-Wno-coverage-mismatch} can be used to disable the
3191 warning or @option{-Wno-error=coverage-mismatch} can be used to
3192 disable the error. Disabling the error for this warning can result in
3193 poorly optimized code and is useful only in the
3194 case of very minor changes such as bug fixes to an existing code-base.
3195 Completely disabling the warning is not recommended.
3196
3197 @item -Wno-cpp
3198 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3199
3200 Suppress warning messages emitted by @code{#warning} directives.
3201
3202 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3203 @opindex Wdouble-promotion
3204 @opindex Wno-double-promotion
3205 Give a warning when a value of type @code{float} is implicitly
3206 promoted to @code{double}. CPUs with a 32-bit ``single-precision''
3207 floating-point unit implement @code{float} in hardware, but emulate
3208 @code{double} in software. On such a machine, doing computations
3209 using @code{double} values is much more expensive because of the
3210 overhead required for software emulation.
3211
3212 It is easy to accidentally do computations with @code{double} because
3213 floating-point literals are implicitly of type @code{double}. For
3214 example, in:
3215 @smallexample
3216 @group
3217 float area(float radius)
3218 @{
3219 return 3.14159 * radius * radius;
3220 @}
3221 @end group
3222 @end smallexample
3223 the compiler performs the entire computation with @code{double}
3224 because the floating-point literal is a @code{double}.
3225
3226 @item -Wformat
3227 @opindex Wformat
3228 @opindex Wno-format
3229 @opindex ffreestanding
3230 @opindex fno-builtin
3231 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3232 the arguments supplied have types appropriate to the format string
3233 specified, and that the conversions specified in the format string make
3234 sense. This includes standard functions, and others specified by format
3235 attributes (@pxref{Function Attributes}), in the @code{printf},
3236 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3237 not in the C standard) families (or other target-specific families).
3238 Which functions are checked without format attributes having been
3239 specified depends on the standard version selected, and such checks of
3240 functions without the attribute specified are disabled by
3241 @option{-ffreestanding} or @option{-fno-builtin}.
3242
3243 The formats are checked against the format features supported by GNU
3244 libc version 2.2. These include all ISO C90 and C99 features, as well
3245 as features from the Single Unix Specification and some BSD and GNU
3246 extensions. Other library implementations may not support all these
3247 features; GCC does not support warning about features that go beyond a
3248 particular library's limitations. However, if @option{-Wpedantic} is used
3249 with @option{-Wformat}, warnings are given about format features not
3250 in the selected standard version (but not for @code{strfmon} formats,
3251 since those are not in any version of the C standard). @xref{C Dialect
3252 Options,,Options Controlling C Dialect}.
3253
3254 Since @option{-Wformat} also checks for null format arguments for
3255 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3256
3257 @option{-Wformat} is included in @option{-Wall}. For more control over some
3258 aspects of format checking, the options @option{-Wformat-y2k},
3259 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3260 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3261 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3262
3263 @item -Wformat-y2k
3264 @opindex Wformat-y2k
3265 @opindex Wno-format-y2k
3266 If @option{-Wformat} is specified, also warn about @code{strftime}
3267 formats that may yield only a two-digit year.
3268
3269 @item -Wno-format-contains-nul
3270 @opindex Wno-format-contains-nul
3271 @opindex Wformat-contains-nul
3272 If @option{-Wformat} is specified, do not warn about format strings that
3273 contain NUL bytes.
3274
3275 @item -Wno-format-extra-args
3276 @opindex Wno-format-extra-args
3277 @opindex Wformat-extra-args
3278 If @option{-Wformat} is specified, do not warn about excess arguments to a
3279 @code{printf} or @code{scanf} format function. The C standard specifies
3280 that such arguments are ignored.
3281
3282 Where the unused arguments lie between used arguments that are
3283 specified with @samp{$} operand number specifications, normally
3284 warnings are still given, since the implementation could not know what
3285 type to pass to @code{va_arg} to skip the unused arguments. However,
3286 in the case of @code{scanf} formats, this option suppresses the
3287 warning if the unused arguments are all pointers, since the Single
3288 Unix Specification says that such unused arguments are allowed.
3289
3290 @item -Wno-format-zero-length
3291 @opindex Wno-format-zero-length
3292 @opindex Wformat-zero-length
3293 If @option{-Wformat} is specified, do not warn about zero-length formats.
3294 The C standard specifies that zero-length formats are allowed.
3295
3296 @item -Wformat-nonliteral
3297 @opindex Wformat-nonliteral
3298 @opindex Wno-format-nonliteral
3299 If @option{-Wformat} is specified, also warn if the format string is not a
3300 string literal and so cannot be checked, unless the format function
3301 takes its format arguments as a @code{va_list}.
3302
3303 @item -Wformat-security
3304 @opindex Wformat-security
3305 @opindex Wno-format-security
3306 If @option{-Wformat} is specified, also warn about uses of format
3307 functions that represent possible security problems. At present, this
3308 warns about calls to @code{printf} and @code{scanf} functions where the
3309 format string is not a string literal and there are no format arguments,
3310 as in @code{printf (foo);}. This may be a security hole if the format
3311 string came from untrusted input and contains @samp{%n}. (This is
3312 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3313 in future warnings may be added to @option{-Wformat-security} that are not
3314 included in @option{-Wformat-nonliteral}.)
3315
3316 @item -Wformat=2
3317 @opindex Wformat=2
3318 @opindex Wno-format=2
3319 Enable @option{-Wformat} plus format checks not included in
3320 @option{-Wformat}. Currently equivalent to @option{-Wformat
3321 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3322
3323 @item -Wnonnull
3324 @opindex Wnonnull
3325 @opindex Wno-nonnull
3326 Warn about passing a null pointer for arguments marked as
3327 requiring a non-null value by the @code{nonnull} function attribute.
3328
3329 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
3330 can be disabled with the @option{-Wno-nonnull} option.
3331
3332 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3333 @opindex Winit-self
3334 @opindex Wno-init-self
3335 Warn about uninitialized variables that are initialized with themselves.
3336 Note this option can only be used with the @option{-Wuninitialized} option.
3337
3338 For example, GCC warns about @code{i} being uninitialized in the
3339 following snippet only when @option{-Winit-self} has been specified:
3340 @smallexample
3341 @group
3342 int f()
3343 @{
3344 int i = i;
3345 return i;
3346 @}
3347 @end group
3348 @end smallexample
3349
3350 @item -Wimplicit-int @r{(C and Objective-C only)}
3351 @opindex Wimplicit-int
3352 @opindex Wno-implicit-int
3353 Warn when a declaration does not specify a type.
3354 This warning is enabled by @option{-Wall}.
3355
3356 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3357 @opindex Wimplicit-function-declaration
3358 @opindex Wno-implicit-function-declaration
3359 Give a warning whenever a function is used before being declared. In
3360 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3361 enabled by default and it is made into an error by
3362 @option{-pedantic-errors}. This warning is also enabled by
3363 @option{-Wall}.
3364
3365 @item -Wimplicit @r{(C and Objective-C only)}
3366 @opindex Wimplicit
3367 @opindex Wno-implicit
3368 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3369 This warning is enabled by @option{-Wall}.
3370
3371 @item -Wignored-qualifiers @r{(C and C++ only)}
3372 @opindex Wignored-qualifiers
3373 @opindex Wno-ignored-qualifiers
3374 Warn if the return type of a function has a type qualifier
3375 such as @code{const}. For ISO C such a type qualifier has no effect,
3376 since the value returned by a function is not an lvalue.
3377 For C++, the warning is only emitted for scalar types or @code{void}.
3378 ISO C prohibits qualified @code{void} return types on function
3379 definitions, so such return types always receive a warning
3380 even without this option.
3381
3382 This warning is also enabled by @option{-Wextra}.
3383
3384 @item -Wmain
3385 @opindex Wmain
3386 @opindex Wno-main
3387 Warn if the type of @samp{main} is suspicious. @samp{main} should be
3388 a function with external linkage, returning int, taking either zero
3389 arguments, two, or three arguments of appropriate types. This warning
3390 is enabled by default in C++ and is enabled by either @option{-Wall}
3391 or @option{-Wpedantic}.
3392
3393 @item -Wmissing-braces
3394 @opindex Wmissing-braces
3395 @opindex Wno-missing-braces
3396 Warn if an aggregate or union initializer is not fully bracketed. In
3397 the following example, the initializer for @samp{a} is not fully
3398 bracketed, but that for @samp{b} is fully bracketed. This warning is
3399 enabled by @option{-Wall} in C.
3400
3401 @smallexample
3402 int a[2][2] = @{ 0, 1, 2, 3 @};
3403 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3404 @end smallexample
3405
3406 This warning is enabled by @option{-Wall}.
3407
3408 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3409 @opindex Wmissing-include-dirs
3410 @opindex Wno-missing-include-dirs
3411 Warn if a user-supplied include directory does not exist.
3412
3413 @item -Wparentheses
3414 @opindex Wparentheses
3415 @opindex Wno-parentheses
3416 Warn if parentheses are omitted in certain contexts, such
3417 as when there is an assignment in a context where a truth value
3418 is expected, or when operators are nested whose precedence people
3419 often get confused about.
3420
3421 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3422 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3423 interpretation from that of ordinary mathematical notation.
3424
3425 Also warn about constructions where there may be confusion to which
3426 @code{if} statement an @code{else} branch belongs. Here is an example of
3427 such a case:
3428
3429 @smallexample
3430 @group
3431 @{
3432 if (a)
3433 if (b)
3434 foo ();
3435 else
3436 bar ();
3437 @}
3438 @end group
3439 @end smallexample
3440
3441 In C/C++, every @code{else} branch belongs to the innermost possible
3442 @code{if} statement, which in this example is @code{if (b)}. This is
3443 often not what the programmer expected, as illustrated in the above
3444 example by indentation the programmer chose. When there is the
3445 potential for this confusion, GCC issues a warning when this flag
3446 is specified. To eliminate the warning, add explicit braces around
3447 the innermost @code{if} statement so there is no way the @code{else}
3448 can belong to the enclosing @code{if}. The resulting code
3449 looks like this:
3450
3451 @smallexample
3452 @group
3453 @{
3454 if (a)
3455 @{
3456 if (b)
3457 foo ();
3458 else
3459 bar ();
3460 @}
3461 @}
3462 @end group
3463 @end smallexample
3464
3465 Also warn for dangerous uses of the GNU extension to
3466 @code{?:} with omitted middle operand. When the condition
3467 in the @code{?}: operator is a boolean expression, the omitted value is
3468 always 1. Often programmers expect it to be a value computed
3469 inside the conditional expression instead.
3470
3471 This warning is enabled by @option{-Wall}.
3472
3473 @item -Wsequence-point
3474 @opindex Wsequence-point
3475 @opindex Wno-sequence-point
3476 Warn about code that may have undefined semantics because of violations
3477 of sequence point rules in the C and C++ standards.
3478
3479 The C and C++ standards defines the order in which expressions in a C/C++
3480 program are evaluated in terms of @dfn{sequence points}, which represent
3481 a partial ordering between the execution of parts of the program: those
3482 executed before the sequence point, and those executed after it. These
3483 occur after the evaluation of a full expression (one which is not part
3484 of a larger expression), after the evaluation of the first operand of a
3485 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3486 function is called (but after the evaluation of its arguments and the
3487 expression denoting the called function), and in certain other places.
3488 Other than as expressed by the sequence point rules, the order of
3489 evaluation of subexpressions of an expression is not specified. All
3490 these rules describe only a partial order rather than a total order,
3491 since, for example, if two functions are called within one expression
3492 with no sequence point between them, the order in which the functions
3493 are called is not specified. However, the standards committee have
3494 ruled that function calls do not overlap.
3495
3496 It is not specified when between sequence points modifications to the
3497 values of objects take effect. Programs whose behavior depends on this
3498 have undefined behavior; the C and C++ standards specify that ``Between
3499 the previous and next sequence point an object shall have its stored
3500 value modified at most once by the evaluation of an expression.
3501 Furthermore, the prior value shall be read only to determine the value
3502 to be stored.''. If a program breaks these rules, the results on any
3503 particular implementation are entirely unpredictable.
3504
3505 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3506 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
3507 diagnosed by this option, and it may give an occasional false positive
3508 result, but in general it has been found fairly effective at detecting
3509 this sort of problem in programs.
3510
3511 The standard is worded confusingly, therefore there is some debate
3512 over the precise meaning of the sequence point rules in subtle cases.
3513 Links to discussions of the problem, including proposed formal
3514 definitions, may be found on the GCC readings page, at
3515 @uref{http://gcc.gnu.org/@/readings.html}.
3516
3517 This warning is enabled by @option{-Wall} for C and C++.
3518
3519 @item -Wreturn-type
3520 @opindex Wreturn-type
3521 @opindex Wno-return-type
3522 Warn whenever a function is defined with a return-type that defaults
3523 to @code{int}. Also warn about any @code{return} statement with no
3524 return-value in a function whose return-type is not @code{void}
3525 (falling off the end of the function body is considered returning
3526 without a value), and about a @code{return} statement with an
3527 expression in a function whose return-type is @code{void}.
3528
3529 For C++, a function without return type always produces a diagnostic
3530 message, even when @option{-Wno-return-type} is specified. The only
3531 exceptions are @samp{main} and functions defined in system headers.
3532
3533 This warning is enabled by @option{-Wall}.
3534
3535 @item -Wswitch
3536 @opindex Wswitch
3537 @opindex Wno-switch
3538 Warn whenever a @code{switch} statement has an index of enumerated type
3539 and lacks a @code{case} for one or more of the named codes of that
3540 enumeration. (The presence of a @code{default} label prevents this
3541 warning.) @code{case} labels outside the enumeration range also
3542 provoke warnings when this option is used (even if there is a
3543 @code{default} label).
3544 This warning is enabled by @option{-Wall}.
3545
3546 @item -Wswitch-default
3547 @opindex Wswitch-default
3548 @opindex Wno-switch-default
3549 Warn whenever a @code{switch} statement does not have a @code{default}
3550 case.
3551
3552 @item -Wswitch-enum
3553 @opindex Wswitch-enum
3554 @opindex Wno-switch-enum
3555 Warn whenever a @code{switch} statement has an index of enumerated type
3556 and lacks a @code{case} for one or more of the named codes of that
3557 enumeration. @code{case} labels outside the enumeration range also
3558 provoke warnings when this option is used. The only difference
3559 between @option{-Wswitch} and this option is that this option gives a
3560 warning about an omitted enumeration code even if there is a
3561 @code{default} label.
3562
3563 @item -Wsync-nand @r{(C and C++ only)}
3564 @opindex Wsync-nand
3565 @opindex Wno-sync-nand
3566 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3567 built-in functions are used. These functions changed semantics in GCC 4.4.
3568
3569 @item -Wtrigraphs
3570 @opindex Wtrigraphs
3571 @opindex Wno-trigraphs
3572 Warn if any trigraphs are encountered that might change the meaning of
3573 the program (trigraphs within comments are not warned about).
3574 This warning is enabled by @option{-Wall}.
3575
3576 @item -Wunused-but-set-parameter
3577 @opindex Wunused-but-set-parameter
3578 @opindex Wno-unused-but-set-parameter
3579 Warn whenever a function parameter is assigned to, but otherwise unused
3580 (aside from its declaration).
3581
3582 To suppress this warning use the @samp{unused} attribute
3583 (@pxref{Variable Attributes}).
3584
3585 This warning is also enabled by @option{-Wunused} together with
3586 @option{-Wextra}.
3587
3588 @item -Wunused-but-set-variable
3589 @opindex Wunused-but-set-variable
3590 @opindex Wno-unused-but-set-variable
3591 Warn whenever a local variable is assigned to, but otherwise unused
3592 (aside from its declaration).
3593 This warning is enabled by @option{-Wall}.
3594
3595 To suppress this warning use the @samp{unused} attribute
3596 (@pxref{Variable Attributes}).
3597
3598 This warning is also enabled by @option{-Wunused}, which is enabled
3599 by @option{-Wall}.
3600
3601 @item -Wunused-function
3602 @opindex Wunused-function
3603 @opindex Wno-unused-function
3604 Warn whenever a static function is declared but not defined or a
3605 non-inline static function is unused.
3606 This warning is enabled by @option{-Wall}.
3607
3608 @item -Wunused-label
3609 @opindex Wunused-label
3610 @opindex Wno-unused-label
3611 Warn whenever a label is declared but not used.
3612 This warning is enabled by @option{-Wall}.
3613
3614 To suppress this warning use the @samp{unused} attribute
3615 (@pxref{Variable Attributes}).
3616
3617 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3618 @opindex Wunused-local-typedefs
3619 Warn when a typedef locally defined in a function is not used.
3620 This warning is enabled by @option{-Wall}.
3621
3622 @item -Wunused-parameter
3623 @opindex Wunused-parameter
3624 @opindex Wno-unused-parameter
3625 Warn whenever a function parameter is unused aside from its declaration.
3626
3627 To suppress this warning use the @samp{unused} attribute
3628 (@pxref{Variable Attributes}).
3629
3630 @item -Wno-unused-result
3631 @opindex Wunused-result
3632 @opindex Wno-unused-result
3633 Do not warn if a caller of a function marked with attribute
3634 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3635 its return value. The default is @option{-Wunused-result}.
3636
3637 @item -Wunused-variable
3638 @opindex Wunused-variable
3639 @opindex Wno-unused-variable
3640 Warn whenever a local variable or non-constant static variable is unused
3641 aside from its declaration.
3642 This warning is enabled by @option{-Wall}.
3643
3644 To suppress this warning use the @samp{unused} attribute
3645 (@pxref{Variable Attributes}).
3646
3647 @item -Wunused-value
3648 @opindex Wunused-value
3649 @opindex Wno-unused-value
3650 Warn whenever a statement computes a result that is explicitly not
3651 used. To suppress this warning cast the unused expression to
3652 @samp{void}. This includes an expression-statement or the left-hand
3653 side of a comma expression that contains no side effects. For example,
3654 an expression such as @samp{x[i,j]} causes a warning, while
3655 @samp{x[(void)i,j]} does not.
3656
3657 This warning is enabled by @option{-Wall}.
3658
3659 @item -Wunused
3660 @opindex Wunused
3661 @opindex Wno-unused
3662 All the above @option{-Wunused} options combined.
3663
3664 In order to get a warning about an unused function parameter, you must
3665 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3666 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3667
3668 @item -Wuninitialized
3669 @opindex Wuninitialized
3670 @opindex Wno-uninitialized
3671 Warn if an automatic variable is used without first being initialized
3672 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3673 warn if a non-static reference or non-static @samp{const} member
3674 appears in a class without constructors.
3675
3676 If you want to warn about code that uses the uninitialized value of the
3677 variable in its own initializer, use the @option{-Winit-self} option.
3678
3679 These warnings occur for individual uninitialized or clobbered
3680 elements of structure, union or array variables as well as for
3681 variables that are uninitialized or clobbered as a whole. They do
3682 not occur for variables or elements declared @code{volatile}. Because
3683 these warnings depend on optimization, the exact variables or elements
3684 for which there are warnings depends on the precise optimization
3685 options and version of GCC used.
3686
3687 Note that there may be no warning about a variable that is used only
3688 to compute a value that itself is never used, because such
3689 computations may be deleted by data flow analysis before the warnings
3690 are printed.
3691
3692 @item -Wmaybe-uninitialized
3693 @opindex Wmaybe-uninitialized
3694 @opindex Wno-maybe-uninitialized
3695 For an automatic variable, if there exists a path from the function
3696 entry to a use of the variable that is initialized, but there exist
3697 some other paths for which the variable is not initialized, the compiler
3698 emits a warning if it cannot prove the uninitialized paths are not
3699 executed at run time. These warnings are made optional because GCC is
3700 not smart enough to see all the reasons why the code might be correct
3701 in spite of appearing to have an error. Here is one example of how
3702 this can happen:
3703
3704 @smallexample
3705 @group
3706 @{
3707 int x;
3708 switch (y)
3709 @{
3710 case 1: x = 1;
3711 break;
3712 case 2: x = 4;
3713 break;
3714 case 3: x = 5;
3715 @}
3716 foo (x);
3717 @}
3718 @end group
3719 @end smallexample
3720
3721 @noindent
3722 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3723 always initialized, but GCC doesn't know this. To suppress the
3724 warning, you need to provide a default case with assert(0) or
3725 similar code.
3726
3727 @cindex @code{longjmp} warnings
3728 This option also warns when a non-volatile automatic variable might be
3729 changed by a call to @code{longjmp}. These warnings as well are possible
3730 only in optimizing compilation.
3731
3732 The compiler sees only the calls to @code{setjmp}. It cannot know
3733 where @code{longjmp} will be called; in fact, a signal handler could
3734 call it at any point in the code. As a result, you may get a warning
3735 even when there is in fact no problem because @code{longjmp} cannot
3736 in fact be called at the place that would cause a problem.
3737
3738 Some spurious warnings can be avoided if you declare all the functions
3739 you use that never return as @code{noreturn}. @xref{Function
3740 Attributes}.
3741
3742 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3743
3744 @item -Wunknown-pragmas
3745 @opindex Wunknown-pragmas
3746 @opindex Wno-unknown-pragmas
3747 @cindex warning for unknown pragmas
3748 @cindex unknown pragmas, warning
3749 @cindex pragmas, warning of unknown
3750 Warn when a @code{#pragma} directive is encountered that is not understood by
3751 GCC@. If this command-line option is used, warnings are even issued
3752 for unknown pragmas in system header files. This is not the case if
3753 the warnings are only enabled by the @option{-Wall} command-line option.
3754
3755 @item -Wno-pragmas
3756 @opindex Wno-pragmas
3757 @opindex Wpragmas
3758 Do not warn about misuses of pragmas, such as incorrect parameters,
3759 invalid syntax, or conflicts between pragmas. See also
3760 @option{-Wunknown-pragmas}.
3761
3762 @item -Wstrict-aliasing
3763 @opindex Wstrict-aliasing
3764 @opindex Wno-strict-aliasing
3765 This option is only active when @option{-fstrict-aliasing} is active.
3766 It warns about code that might break the strict aliasing rules that the
3767 compiler is using for optimization. The warning does not catch all
3768 cases, but does attempt to catch the more common pitfalls. It is
3769 included in @option{-Wall}.
3770 It is equivalent to @option{-Wstrict-aliasing=3}
3771
3772 @item -Wstrict-aliasing=n
3773 @opindex Wstrict-aliasing=n
3774 @opindex Wno-strict-aliasing=n
3775 This option is only active when @option{-fstrict-aliasing} is active.
3776 It warns about code that might break the strict aliasing rules that the
3777 compiler is using for optimization.
3778 Higher levels correspond to higher accuracy (fewer false positives).
3779 Higher levels also correspond to more effort, similar to the way @option{-O}
3780 works.
3781 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3782
3783 Level 1: Most aggressive, quick, least accurate.
3784 Possibly useful when higher levels
3785 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3786 false negatives. However, it has many false positives.
3787 Warns for all pointer conversions between possibly incompatible types,
3788 even if never dereferenced. Runs in the front end only.
3789
3790 Level 2: Aggressive, quick, not too precise.
3791 May still have many false positives (not as many as level 1 though),
3792 and few false negatives (but possibly more than level 1).
3793 Unlike level 1, it only warns when an address is taken. Warns about
3794 incomplete types. Runs in the front end only.
3795
3796 Level 3 (default for @option{-Wstrict-aliasing}):
3797 Should have very few false positives and few false
3798 negatives. Slightly slower than levels 1 or 2 when optimization is enabled.
3799 Takes care of the common pun+dereference pattern in the front end:
3800 @code{*(int*)&some_float}.
3801 If optimization is enabled, it also runs in the back end, where it deals
3802 with multiple statement cases using flow-sensitive points-to information.
3803 Only warns when the converted pointer is dereferenced.
3804 Does not warn about incomplete types.
3805
3806 @item -Wstrict-overflow
3807 @itemx -Wstrict-overflow=@var{n}
3808 @opindex Wstrict-overflow
3809 @opindex Wno-strict-overflow
3810 This option is only active when @option{-fstrict-overflow} is active.
3811 It warns about cases where the compiler optimizes based on the
3812 assumption that signed overflow does not occur. Note that it does not
3813 warn about all cases where the code might overflow: it only warns
3814 about cases where the compiler implements some optimization. Thus
3815 this warning depends on the optimization level.
3816
3817 An optimization that assumes that signed overflow does not occur is
3818 perfectly safe if the values of the variables involved are such that
3819 overflow never does, in fact, occur. Therefore this warning can
3820 easily give a false positive: a warning about code that is not
3821 actually a problem. To help focus on important issues, several
3822 warning levels are defined. No warnings are issued for the use of
3823 undefined signed overflow when estimating how many iterations a loop
3824 requires, in particular when determining whether a loop will be
3825 executed at all.
3826
3827 @table @gcctabopt
3828 @item -Wstrict-overflow=1
3829 Warn about cases that are both questionable and easy to avoid. For
3830 example, with @option{-fstrict-overflow}, the compiler simplifies
3831 @code{x + 1 > x} to @code{1}. This level of
3832 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3833 are not, and must be explicitly requested.
3834
3835 @item -Wstrict-overflow=2
3836 Also warn about other cases where a comparison is simplified to a
3837 constant. For example: @code{abs (x) >= 0}. This can only be
3838 simplified when @option{-fstrict-overflow} is in effect, because
3839 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3840 zero. @option{-Wstrict-overflow} (with no level) is the same as
3841 @option{-Wstrict-overflow=2}.
3842
3843 @item -Wstrict-overflow=3
3844 Also warn about other cases where a comparison is simplified. For
3845 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3846
3847 @item -Wstrict-overflow=4
3848 Also warn about other simplifications not covered by the above cases.
3849 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3850
3851 @item -Wstrict-overflow=5
3852 Also warn about cases where the compiler reduces the magnitude of a
3853 constant involved in a comparison. For example: @code{x + 2 > y} is
3854 simplified to @code{x + 1 >= y}. This is reported only at the
3855 highest warning level because this simplification applies to many
3856 comparisons, so this warning level gives a very large number of
3857 false positives.
3858 @end table
3859
3860 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3861 @opindex Wsuggest-attribute=
3862 @opindex Wno-suggest-attribute=
3863 Warn for cases where adding an attribute may be beneficial. The
3864 attributes currently supported are listed below.
3865
3866 @table @gcctabopt
3867 @item -Wsuggest-attribute=pure
3868 @itemx -Wsuggest-attribute=const
3869 @itemx -Wsuggest-attribute=noreturn
3870 @opindex Wsuggest-attribute=pure
3871 @opindex Wno-suggest-attribute=pure
3872 @opindex Wsuggest-attribute=const
3873 @opindex Wno-suggest-attribute=const
3874 @opindex Wsuggest-attribute=noreturn
3875 @opindex Wno-suggest-attribute=noreturn
3876
3877 Warn about functions that might be candidates for attributes
3878 @code{pure}, @code{const} or @code{noreturn}. The compiler only warns for
3879 functions visible in other compilation units or (in the case of @code{pure} and
3880 @code{const}) if it cannot prove that the function returns normally. A function
3881 returns normally if it doesn't contain an infinite loop nor returns abnormally
3882 by throwing, calling @code{abort()} or trapping. This analysis requires option
3883 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3884 higher. Higher optimization levels improve the accuracy of the analysis.
3885
3886 @item -Wsuggest-attribute=format
3887 @itemx -Wmissing-format-attribute
3888 @opindex Wsuggest-attribute=format
3889 @opindex Wmissing-format-attribute
3890 @opindex Wno-suggest-attribute=format
3891 @opindex Wno-missing-format-attribute
3892 @opindex Wformat
3893 @opindex Wno-format
3894
3895 Warn about function pointers that might be candidates for @code{format}
3896 attributes. Note these are only possible candidates, not absolute ones.
3897 GCC guesses that function pointers with @code{format} attributes that
3898 are used in assignment, initialization, parameter passing or return
3899 statements should have a corresponding @code{format} attribute in the
3900 resulting type. I.e.@: the left-hand side of the assignment or
3901 initialization, the type of the parameter variable, or the return type
3902 of the containing function respectively should also have a @code{format}
3903 attribute to avoid the warning.
3904
3905 GCC also warns about function definitions that might be
3906 candidates for @code{format} attributes. Again, these are only
3907 possible candidates. GCC guesses that @code{format} attributes
3908 might be appropriate for any function that calls a function like
3909 @code{vprintf} or @code{vscanf}, but this might not always be the
3910 case, and some functions for which @code{format} attributes are
3911 appropriate may not be detected.
3912 @end table
3913
3914 @item -Warray-bounds
3915 @opindex Wno-array-bounds
3916 @opindex Warray-bounds
3917 This option is only active when @option{-ftree-vrp} is active
3918 (default for @option{-O2} and above). It warns about subscripts to arrays
3919 that are always out of bounds. This warning is enabled by @option{-Wall}.
3920
3921 @item -Wno-div-by-zero
3922 @opindex Wno-div-by-zero
3923 @opindex Wdiv-by-zero
3924 Do not warn about compile-time integer division by zero. Floating-point
3925 division by zero is not warned about, as it can be a legitimate way of
3926 obtaining infinities and NaNs.
3927
3928 @item -Wsystem-headers
3929 @opindex Wsystem-headers
3930 @opindex Wno-system-headers
3931 @cindex warnings from system headers
3932 @cindex system headers, warnings from
3933 Print warning messages for constructs found in system header files.
3934 Warnings from system headers are normally suppressed, on the assumption
3935 that they usually do not indicate real problems and would only make the
3936 compiler output harder to read. Using this command-line option tells
3937 GCC to emit warnings from system headers as if they occurred in user
3938 code. However, note that using @option{-Wall} in conjunction with this
3939 option does @emph{not} warn about unknown pragmas in system
3940 headers---for that, @option{-Wunknown-pragmas} must also be used.
3941
3942 @item -Wtrampolines
3943 @opindex Wtrampolines
3944 @opindex Wno-trampolines
3945 Warn about trampolines generated for pointers to nested functions.
3946
3947 A trampoline is a small piece of data or code that is created at run
3948 time on the stack when the address of a nested function is taken, and
3949 is used to call the nested function indirectly. For some targets, it
3950 is made up of data only and thus requires no special treatment. But,
3951 for most targets, it is made up of code and thus requires the stack
3952 to be made executable in order for the program to work properly.
3953
3954 @item -Wfloat-equal
3955 @opindex Wfloat-equal
3956 @opindex Wno-float-equal
3957 Warn if floating-point values are used in equality comparisons.
3958
3959 The idea behind this is that sometimes it is convenient (for the
3960 programmer) to consider floating-point values as approximations to
3961 infinitely precise real numbers. If you are doing this, then you need
3962 to compute (by analyzing the code, or in some other way) the maximum or
3963 likely maximum error that the computation introduces, and allow for it
3964 when performing comparisons (and when producing output, but that's a
3965 different problem). In particular, instead of testing for equality, you
3966 should check to see whether the two values have ranges that overlap; and
3967 this is done with the relational operators, so equality comparisons are
3968 probably mistaken.
3969
3970 @item -Wtraditional @r{(C and Objective-C only)}
3971 @opindex Wtraditional
3972 @opindex Wno-traditional
3973 Warn about certain constructs that behave differently in traditional and
3974 ISO C@. Also warn about ISO C constructs that have no traditional C
3975 equivalent, and/or problematic constructs that should be avoided.
3976
3977 @itemize @bullet
3978 @item
3979 Macro parameters that appear within string literals in the macro body.
3980 In traditional C macro replacement takes place within string literals,
3981 but does not in ISO C@.
3982
3983 @item
3984 In traditional C, some preprocessor directives did not exist.
3985 Traditional preprocessors only considered a line to be a directive
3986 if the @samp{#} appeared in column 1 on the line. Therefore
3987 @option{-Wtraditional} warns about directives that traditional C
3988 understands but ignores because the @samp{#} does not appear as the
3989 first character on the line. It also suggests you hide directives like
3990 @samp{#pragma} not understood by traditional C by indenting them. Some
3991 traditional implementations do not recognize @samp{#elif}, so this option
3992 suggests avoiding it altogether.
3993
3994 @item
3995 A function-like macro that appears without arguments.
3996
3997 @item
3998 The unary plus operator.
3999
4000 @item
4001 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4002 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
4003 constants.) Note, these suffixes appear in macros defined in the system
4004 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4005 Use of these macros in user code might normally lead to spurious
4006 warnings, however GCC's integrated preprocessor has enough context to
4007 avoid warning in these cases.
4008
4009 @item
4010 A function declared external in one block and then used after the end of
4011 the block.
4012
4013 @item
4014 A @code{switch} statement has an operand of type @code{long}.
4015
4016 @item
4017 A non-@code{static} function declaration follows a @code{static} one.
4018 This construct is not accepted by some traditional C compilers.
4019
4020 @item
4021 The ISO type of an integer constant has a different width or
4022 signedness from its traditional type. This warning is only issued if
4023 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
4024 typically represent bit patterns, are not warned about.
4025
4026 @item
4027 Usage of ISO string concatenation is detected.
4028
4029 @item
4030 Initialization of automatic aggregates.
4031
4032 @item
4033 Identifier conflicts with labels. Traditional C lacks a separate
4034 namespace for labels.
4035
4036 @item
4037 Initialization of unions. If the initializer is zero, the warning is
4038 omitted. This is done under the assumption that the zero initializer in
4039 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4040 initializer warnings and relies on default initialization to zero in the
4041 traditional C case.
4042
4043 @item
4044 Conversions by prototypes between fixed/floating-point values and vice
4045 versa. The absence of these prototypes when compiling with traditional
4046 C causes serious problems. This is a subset of the possible
4047 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4048
4049 @item
4050 Use of ISO C style function definitions. This warning intentionally is
4051 @emph{not} issued for prototype declarations or variadic functions
4052 because these ISO C features appear in your code when using
4053 libiberty's traditional C compatibility macros, @code{PARAMS} and
4054 @code{VPARAMS}. This warning is also bypassed for nested functions
4055 because that feature is already a GCC extension and thus not relevant to
4056 traditional C compatibility.
4057 @end itemize
4058
4059 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4060 @opindex Wtraditional-conversion
4061 @opindex Wno-traditional-conversion
4062 Warn if a prototype causes a type conversion that is different from what
4063 would happen to the same argument in the absence of a prototype. This
4064 includes conversions of fixed point to floating and vice versa, and
4065 conversions changing the width or signedness of a fixed-point argument
4066 except when the same as the default promotion.
4067
4068 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4069 @opindex Wdeclaration-after-statement
4070 @opindex Wno-declaration-after-statement
4071 Warn when a declaration is found after a statement in a block. This
4072 construct, known from C++, was introduced with ISO C99 and is by default
4073 allowed in GCC@. It is not supported by ISO C90 and was not supported by
4074 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
4075
4076 @item -Wundef
4077 @opindex Wundef
4078 @opindex Wno-undef
4079 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4080
4081 @item -Wno-endif-labels
4082 @opindex Wno-endif-labels
4083 @opindex Wendif-labels
4084 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4085
4086 @item -Wshadow
4087 @opindex Wshadow
4088 @opindex Wno-shadow
4089 Warn whenever a local variable or type declaration shadows another variable,
4090 parameter, type, or class member (in C++), or whenever a built-in function
4091 is shadowed. Note that in C++, the compiler warns if a local variable
4092 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4093
4094 @item -Wlarger-than=@var{len}
4095 @opindex Wlarger-than=@var{len}
4096 @opindex Wlarger-than-@var{len}
4097 Warn whenever an object of larger than @var{len} bytes is defined.
4098
4099 @item -Wframe-larger-than=@var{len}
4100 @opindex Wframe-larger-than
4101 Warn if the size of a function frame is larger than @var{len} bytes.
4102 The computation done to determine the stack frame size is approximate
4103 and not conservative.
4104 The actual requirements may be somewhat greater than @var{len}
4105 even if you do not get a warning. In addition, any space allocated
4106 via @code{alloca}, variable-length arrays, or related constructs
4107 is not included by the compiler when determining
4108 whether or not to issue a warning.
4109
4110 @item -Wno-free-nonheap-object
4111 @opindex Wno-free-nonheap-object
4112 @opindex Wfree-nonheap-object
4113 Do not warn when attempting to free an object that was not allocated
4114 on the heap.
4115
4116 @item -Wstack-usage=@var{len}
4117 @opindex Wstack-usage
4118 Warn if the stack usage of a function might be larger than @var{len} bytes.
4119 The computation done to determine the stack usage is conservative.
4120 Any space allocated via @code{alloca}, variable-length arrays, or related
4121 constructs is included by the compiler when determining whether or not to
4122 issue a warning.
4123
4124 The message is in keeping with the output of @option{-fstack-usage}.
4125
4126 @itemize
4127 @item
4128 If the stack usage is fully static but exceeds the specified amount, it's:
4129
4130 @smallexample
4131 warning: stack usage is 1120 bytes
4132 @end smallexample
4133 @item
4134 If the stack usage is (partly) dynamic but bounded, it's:
4135
4136 @smallexample
4137 warning: stack usage might be 1648 bytes
4138 @end smallexample
4139 @item
4140 If the stack usage is (partly) dynamic and not bounded, it's:
4141
4142 @smallexample
4143 warning: stack usage might be unbounded
4144 @end smallexample
4145 @end itemize
4146
4147 @item -Wunsafe-loop-optimizations
4148 @opindex Wunsafe-loop-optimizations
4149 @opindex Wno-unsafe-loop-optimizations
4150 Warn if the loop cannot be optimized because the compiler cannot
4151 assume anything on the bounds of the loop indices. With
4152 @option{-funsafe-loop-optimizations} warn if the compiler makes
4153 such assumptions.
4154
4155 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4156 @opindex Wno-pedantic-ms-format
4157 @opindex Wpedantic-ms-format
4158 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4159 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4160 depending on the MS runtime, when you are using the options @option{-Wformat}
4161 and @option{-Wpedantic} without gnu-extensions.
4162
4163 @item -Wpointer-arith
4164 @opindex Wpointer-arith
4165 @opindex Wno-pointer-arith
4166 Warn about anything that depends on the ``size of'' a function type or
4167 of @code{void}. GNU C assigns these types a size of 1, for
4168 convenience in calculations with @code{void *} pointers and pointers
4169 to functions. In C++, warn also when an arithmetic operation involves
4170 @code{NULL}. This warning is also enabled by @option{-Wpedantic}.
4171
4172 @item -Wtype-limits
4173 @opindex Wtype-limits
4174 @opindex Wno-type-limits
4175 Warn if a comparison is always true or always false due to the limited
4176 range of the data type, but do not warn for constant expressions. For
4177 example, warn if an unsigned variable is compared against zero with
4178 @samp{<} or @samp{>=}. This warning is also enabled by
4179 @option{-Wextra}.
4180
4181 @item -Wbad-function-cast @r{(C and Objective-C only)}
4182 @opindex Wbad-function-cast
4183 @opindex Wno-bad-function-cast
4184 Warn whenever a function call is cast to a non-matching type.
4185 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4186
4187 @item -Wc++-compat @r{(C and Objective-C only)}
4188 Warn about ISO C constructs that are outside of the common subset of
4189 ISO C and ISO C++, e.g.@: request for implicit conversion from
4190 @code{void *} to a pointer to non-@code{void} type.
4191
4192 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4193 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4194 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4195 in ISO C++ 2011. This warning turns on @option{-Wnarrowing} and is
4196 enabled by @option{-Wall}.
4197
4198 @item -Wcast-qual
4199 @opindex Wcast-qual
4200 @opindex Wno-cast-qual
4201 Warn whenever a pointer is cast so as to remove a type qualifier from
4202 the target type. For example, warn if a @code{const char *} is cast
4203 to an ordinary @code{char *}.
4204
4205 Also warn when making a cast that introduces a type qualifier in an
4206 unsafe way. For example, casting @code{char **} to @code{const char **}
4207 is unsafe, as in this example:
4208
4209 @smallexample
4210 /* p is char ** value. */
4211 const char **q = (const char **) p;
4212 /* Assignment of readonly string to const char * is OK. */
4213 *q = "string";
4214 /* Now char** pointer points to read-only memory. */
4215 **p = 'b';
4216 @end smallexample
4217
4218 @item -Wcast-align
4219 @opindex Wcast-align
4220 @opindex Wno-cast-align
4221 Warn whenever a pointer is cast such that the required alignment of the
4222 target is increased. For example, warn if a @code{char *} is cast to
4223 an @code{int *} on machines where integers can only be accessed at
4224 two- or four-byte boundaries.
4225
4226 @item -Wwrite-strings
4227 @opindex Wwrite-strings
4228 @opindex Wno-write-strings
4229 When compiling C, give string constants the type @code{const
4230 char[@var{length}]} so that copying the address of one into a
4231 non-@code{const} @code{char *} pointer produces a warning. These
4232 warnings help you find at compile time code that can try to write
4233 into a string constant, but only if you have been very careful about
4234 using @code{const} in declarations and prototypes. Otherwise, it is
4235 just a nuisance. This is why we did not make @option{-Wall} request
4236 these warnings.
4237
4238 When compiling C++, warn about the deprecated conversion from string
4239 literals to @code{char *}. This warning is enabled by default for C++
4240 programs.
4241
4242 @item -Wclobbered
4243 @opindex Wclobbered
4244 @opindex Wno-clobbered
4245 Warn for variables that might be changed by @samp{longjmp} or
4246 @samp{vfork}. This warning is also enabled by @option{-Wextra}.
4247
4248 @item -Wconversion
4249 @opindex Wconversion
4250 @opindex Wno-conversion
4251 Warn for implicit conversions that may alter a value. This includes
4252 conversions between real and integer, like @code{abs (x)} when
4253 @code{x} is @code{double}; conversions between signed and unsigned,
4254 like @code{unsigned ui = -1}; and conversions to smaller types, like
4255 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4256 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4257 changed by the conversion like in @code{abs (2.0)}. Warnings about
4258 conversions between signed and unsigned integers can be disabled by
4259 using @option{-Wno-sign-conversion}.
4260
4261 For C++, also warn for confusing overload resolution for user-defined
4262 conversions; and conversions that never use a type conversion
4263 operator: conversions to @code{void}, the same type, a base class or a
4264 reference to them. Warnings about conversions between signed and
4265 unsigned integers are disabled by default in C++ unless
4266 @option{-Wsign-conversion} is explicitly enabled.
4267
4268 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4269 @opindex Wconversion-null
4270 @opindex Wno-conversion-null
4271 Do not warn for conversions between @code{NULL} and non-pointer
4272 types. @option{-Wconversion-null} is enabled by default.
4273
4274 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4275 @opindex Wzero-as-null-pointer-constant
4276 @opindex Wno-zero-as-null-pointer-constant
4277 Warn when a literal '0' is used as null pointer constant. This can
4278 be useful to facilitate the conversion to @code{nullptr} in C++11.
4279
4280 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4281 @opindex Wuseless-cast
4282 @opindex Wno-useless-cast
4283 Warn when an expression is casted to its own type.
4284
4285 @item -Wempty-body
4286 @opindex Wempty-body
4287 @opindex Wno-empty-body
4288 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4289 while} statement. This warning is also enabled by @option{-Wextra}.
4290
4291 @item -Wenum-compare
4292 @opindex Wenum-compare
4293 @opindex Wno-enum-compare
4294 Warn about a comparison between values of different enumerated types.
4295 In C++ enumeral mismatches in conditional expressions are also
4296 diagnosed and the warning is enabled by default. In C this warning is
4297 enabled by @option{-Wall}.
4298
4299 @item -Wjump-misses-init @r{(C, Objective-C only)}
4300 @opindex Wjump-misses-init
4301 @opindex Wno-jump-misses-init
4302 Warn if a @code{goto} statement or a @code{switch} statement jumps
4303 forward across the initialization of a variable, or jumps backward to a
4304 label after the variable has been initialized. This only warns about
4305 variables that are initialized when they are declared. This warning is
4306 only supported for C and Objective-C; in C++ this sort of branch is an
4307 error in any case.
4308
4309 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It
4310 can be disabled with the @option{-Wno-jump-misses-init} option.
4311
4312 @item -Wsign-compare
4313 @opindex Wsign-compare
4314 @opindex Wno-sign-compare
4315 @cindex warning for comparison of signed and unsigned values
4316 @cindex comparison of signed and unsigned values, warning
4317 @cindex signed and unsigned values, comparison warning
4318 Warn when a comparison between signed and unsigned values could produce
4319 an incorrect result when the signed value is converted to unsigned.
4320 This warning is also enabled by @option{-Wextra}; to get the other warnings
4321 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4322
4323 @item -Wsign-conversion
4324 @opindex Wsign-conversion
4325 @opindex Wno-sign-conversion
4326 Warn for implicit conversions that may change the sign of an integer
4327 value, like assigning a signed integer expression to an unsigned
4328 integer variable. An explicit cast silences the warning. In C, this
4329 option is enabled also by @option{-Wconversion}.
4330
4331 @item -Wsizeof-pointer-memaccess
4332 @opindex Wsizeof-pointer-memaccess
4333 @opindex Wno-sizeof-pointer-memaccess
4334 Warn for suspicious length parameters to certain string and memory built-in
4335 functions if the argument uses @code{sizeof}. This warning warns e.g.@:
4336 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4337 but a pointer, and suggests a possible fix, or about
4338 @code{memcpy (&foo, ptr, sizeof (&foo));}. This warning is enabled by
4339 @option{-Wall}.
4340
4341 @item -Waddress
4342 @opindex Waddress
4343 @opindex Wno-address
4344 Warn about suspicious uses of memory addresses. These include using
4345 the address of a function in a conditional expression, such as
4346 @code{void func(void); if (func)}, and comparisons against the memory
4347 address of a string literal, such as @code{if (x == "abc")}. Such
4348 uses typically indicate a programmer error: the address of a function
4349 always evaluates to true, so their use in a conditional usually
4350 indicate that the programmer forgot the parentheses in a function
4351 call; and comparisons against string literals result in unspecified
4352 behavior and are not portable in C, so they usually indicate that the
4353 programmer intended to use @code{strcmp}. This warning is enabled by
4354 @option{-Wall}.
4355
4356 @item -Wlogical-op
4357 @opindex Wlogical-op
4358 @opindex Wno-logical-op
4359 Warn about suspicious uses of logical operators in expressions.
4360 This includes using logical operators in contexts where a
4361 bit-wise operator is likely to be expected.
4362
4363 @item -Waggregate-return
4364 @opindex Waggregate-return
4365 @opindex Wno-aggregate-return
4366 Warn if any functions that return structures or unions are defined or
4367 called. (In languages where you can return an array, this also elicits
4368 a warning.)
4369
4370 @item -Wno-attributes
4371 @opindex Wno-attributes
4372 @opindex Wattributes
4373 Do not warn if an unexpected @code{__attribute__} is used, such as
4374 unrecognized attributes, function attributes applied to variables,
4375 etc. This does not stop errors for incorrect use of supported
4376 attributes.
4377
4378 @item -Wno-builtin-macro-redefined
4379 @opindex Wno-builtin-macro-redefined
4380 @opindex Wbuiltin-macro-redefined
4381 Do not warn if certain built-in macros are redefined. This suppresses
4382 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4383 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4384
4385 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4386 @opindex Wstrict-prototypes
4387 @opindex Wno-strict-prototypes
4388 Warn if a function is declared or defined without specifying the
4389 argument types. (An old-style function definition is permitted without
4390 a warning if preceded by a declaration that specifies the argument
4391 types.)
4392
4393 @item -Wold-style-declaration @r{(C and Objective-C only)}
4394 @opindex Wold-style-declaration
4395 @opindex Wno-old-style-declaration
4396 Warn for obsolescent usages, according to the C Standard, in a
4397 declaration. For example, warn if storage-class specifiers like
4398 @code{static} are not the first things in a declaration. This warning
4399 is also enabled by @option{-Wextra}.
4400
4401 @item -Wold-style-definition @r{(C and Objective-C only)}
4402 @opindex Wold-style-definition
4403 @opindex Wno-old-style-definition
4404 Warn if an old-style function definition is used. A warning is given
4405 even if there is a previous prototype.
4406
4407 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4408 @opindex Wmissing-parameter-type
4409 @opindex Wno-missing-parameter-type
4410 A function parameter is declared without a type specifier in K&R-style
4411 functions:
4412
4413 @smallexample
4414 void foo(bar) @{ @}
4415 @end smallexample
4416
4417 This warning is also enabled by @option{-Wextra}.
4418
4419 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4420 @opindex Wmissing-prototypes
4421 @opindex Wno-missing-prototypes
4422 Warn if a global function is defined without a previous prototype
4423 declaration. This warning is issued even if the definition itself
4424 provides a prototype. Use this option to detect global functions
4425 that do not have a matching prototype declaration in a header file.
4426 This option is not valid for C++ because all function declarations
4427 provide prototypes and a non-matching declaration will declare an
4428 overload rather than conflict with an earlier declaration.
4429 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4430
4431 @item -Wmissing-declarations
4432 @opindex Wmissing-declarations
4433 @opindex Wno-missing-declarations
4434 Warn if a global function is defined without a previous declaration.
4435 Do so even if the definition itself provides a prototype.
4436 Use this option to detect global functions that are not declared in
4437 header files. In C, no warnings are issued for functions with previous
4438 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4439 missing prototypes. In C++, no warnings are issued for function templates,
4440 or for inline functions, or for functions in anonymous namespaces.
4441
4442 @item -Wmissing-field-initializers
4443 @opindex Wmissing-field-initializers
4444 @opindex Wno-missing-field-initializers
4445 @opindex W
4446 @opindex Wextra
4447 @opindex Wno-extra
4448 Warn if a structure's initializer has some fields missing. For
4449 example, the following code causes such a warning, because
4450 @code{x.h} is implicitly zero:
4451
4452 @smallexample
4453 struct s @{ int f, g, h; @};
4454 struct s x = @{ 3, 4 @};
4455 @end smallexample
4456
4457 This option does not warn about designated initializers, so the following
4458 modification does not trigger a warning:
4459
4460 @smallexample
4461 struct s @{ int f, g, h; @};
4462 struct s x = @{ .f = 3, .g = 4 @};
4463 @end smallexample
4464
4465 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
4466 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4467
4468 @item -Wno-multichar
4469 @opindex Wno-multichar
4470 @opindex Wmultichar
4471 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4472 Usually they indicate a typo in the user's code, as they have
4473 implementation-defined values, and should not be used in portable code.
4474
4475 @item -Wnormalized=<none|id|nfc|nfkc>
4476 @opindex Wnormalized=
4477 @cindex NFC
4478 @cindex NFKC
4479 @cindex character set, input normalization
4480 In ISO C and ISO C++, two identifiers are different if they are
4481 different sequences of characters. However, sometimes when characters
4482 outside the basic ASCII character set are used, you can have two
4483 different character sequences that look the same. To avoid confusion,
4484 the ISO 10646 standard sets out some @dfn{normalization rules} which
4485 when applied ensure that two sequences that look the same are turned into
4486 the same sequence. GCC can warn you if you are using identifiers that
4487 have not been normalized; this option controls that warning.
4488
4489 There are four levels of warning supported by GCC@. The default is
4490 @option{-Wnormalized=nfc}, which warns about any identifier that is
4491 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
4492 recommended form for most uses.
4493
4494 Unfortunately, there are some characters allowed in identifiers by
4495 ISO C and ISO C++ that, when turned into NFC, are not allowed in
4496 identifiers. That is, there's no way to use these symbols in portable
4497 ISO C or C++ and have all your identifiers in NFC@.
4498 @option{-Wnormalized=id} suppresses the warning for these characters.
4499 It is hoped that future versions of the standards involved will correct
4500 this, which is why this option is not the default.
4501
4502 You can switch the warning off for all characters by writing
4503 @option{-Wnormalized=none}. You should only do this if you
4504 are using some other normalization scheme (like ``D''), because
4505 otherwise you can easily create bugs that are literally impossible to see.
4506
4507 Some characters in ISO 10646 have distinct meanings but look identical
4508 in some fonts or display methodologies, especially once formatting has
4509 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4510 LETTER N'', displays just like a regular @code{n} that has been
4511 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
4512 normalization scheme to convert all these into a standard form as
4513 well, and GCC warns if your code is not in NFKC if you use
4514 @option{-Wnormalized=nfkc}. This warning is comparable to warning
4515 about every identifier that contains the letter O because it might be
4516 confused with the digit 0, and so is not the default, but may be
4517 useful as a local coding convention if the programming environment
4518 cannot be fixed to display these characters distinctly.
4519
4520 @item -Wno-deprecated
4521 @opindex Wno-deprecated
4522 @opindex Wdeprecated
4523 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
4524
4525 @item -Wno-deprecated-declarations
4526 @opindex Wno-deprecated-declarations
4527 @opindex Wdeprecated-declarations
4528 Do not warn about uses of functions (@pxref{Function Attributes}),
4529 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4530 Attributes}) marked as deprecated by using the @code{deprecated}
4531 attribute.
4532
4533 @item -Wno-overflow
4534 @opindex Wno-overflow
4535 @opindex Woverflow
4536 Do not warn about compile-time overflow in constant expressions.
4537
4538 @item -Woverride-init @r{(C and Objective-C only)}
4539 @opindex Woverride-init
4540 @opindex Wno-override-init
4541 @opindex W
4542 @opindex Wextra
4543 @opindex Wno-extra
4544 Warn if an initialized field without side effects is overridden when
4545 using designated initializers (@pxref{Designated Inits, , Designated
4546 Initializers}).
4547
4548 This warning is included in @option{-Wextra}. To get other
4549 @option{-Wextra} warnings without this one, use @option{-Wextra
4550 -Wno-override-init}.
4551
4552 @item -Wpacked
4553 @opindex Wpacked
4554 @opindex Wno-packed
4555 Warn if a structure is given the packed attribute, but the packed
4556 attribute has no effect on the layout or size of the structure.
4557 Such structures may be mis-aligned for little benefit. For
4558 instance, in this code, the variable @code{f.x} in @code{struct bar}
4559 is misaligned even though @code{struct bar} does not itself
4560 have the packed attribute:
4561
4562 @smallexample
4563 @group
4564 struct foo @{
4565 int x;
4566 char a, b, c, d;
4567 @} __attribute__((packed));
4568 struct bar @{
4569 char z;
4570 struct foo f;
4571 @};
4572 @end group
4573 @end smallexample
4574
4575 @item -Wpacked-bitfield-compat
4576 @opindex Wpacked-bitfield-compat
4577 @opindex Wno-packed-bitfield-compat
4578 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4579 on bit-fields of type @code{char}. This has been fixed in GCC 4.4 but
4580 the change can lead to differences in the structure layout. GCC
4581 informs you when the offset of such a field has changed in GCC 4.4.
4582 For example there is no longer a 4-bit padding between field @code{a}
4583 and @code{b} in this structure:
4584
4585 @smallexample
4586 struct foo
4587 @{
4588 char a:4;
4589 char b:8;
4590 @} __attribute__ ((packed));
4591 @end smallexample
4592
4593 This warning is enabled by default. Use
4594 @option{-Wno-packed-bitfield-compat} to disable this warning.
4595
4596 @item -Wpadded
4597 @opindex Wpadded
4598 @opindex Wno-padded
4599 Warn if padding is included in a structure, either to align an element
4600 of the structure or to align the whole structure. Sometimes when this
4601 happens it is possible to rearrange the fields of the structure to
4602 reduce the padding and so make the structure smaller.
4603
4604 @item -Wredundant-decls
4605 @opindex Wredundant-decls
4606 @opindex Wno-redundant-decls
4607 Warn if anything is declared more than once in the same scope, even in
4608 cases where multiple declaration is valid and changes nothing.
4609
4610 @item -Wnested-externs @r{(C and Objective-C only)}
4611 @opindex Wnested-externs
4612 @opindex Wno-nested-externs
4613 Warn if an @code{extern} declaration is encountered within a function.
4614
4615 @item -Winline
4616 @opindex Winline
4617 @opindex Wno-inline
4618 Warn if a function that is declared as inline cannot be inlined.
4619 Even with this option, the compiler does not warn about failures to
4620 inline functions declared in system headers.
4621
4622 The compiler uses a variety of heuristics to determine whether or not
4623 to inline a function. For example, the compiler takes into account
4624 the size of the function being inlined and the amount of inlining
4625 that has already been done in the current function. Therefore,
4626 seemingly insignificant changes in the source program can cause the
4627 warnings produced by @option{-Winline} to appear or disappear.
4628
4629 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4630 @opindex Wno-invalid-offsetof
4631 @opindex Winvalid-offsetof
4632 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4633 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
4634 to a non-POD type is undefined. In existing C++ implementations,
4635 however, @samp{offsetof} typically gives meaningful results even when
4636 applied to certain kinds of non-POD types. (Such as a simple
4637 @samp{struct} that fails to be a POD type only by virtue of having a
4638 constructor.) This flag is for users who are aware that they are
4639 writing nonportable code and who have deliberately chosen to ignore the
4640 warning about it.
4641
4642 The restrictions on @samp{offsetof} may be relaxed in a future version
4643 of the C++ standard.
4644
4645 @item -Wno-int-to-pointer-cast
4646 @opindex Wno-int-to-pointer-cast
4647 @opindex Wint-to-pointer-cast
4648 Suppress warnings from casts to pointer type of an integer of a
4649 different size. In C++, casting to a pointer type of smaller size is
4650 an error. @option{Wint-to-pointer-cast} is enabled by default.
4651
4652
4653 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4654 @opindex Wno-pointer-to-int-cast
4655 @opindex Wpointer-to-int-cast
4656 Suppress warnings from casts from a pointer to an integer type of a
4657 different size.
4658
4659 @item -Winvalid-pch
4660 @opindex Winvalid-pch
4661 @opindex Wno-invalid-pch
4662 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4663 the search path but can't be used.
4664
4665 @item -Wlong-long
4666 @opindex Wlong-long
4667 @opindex Wno-long-long
4668 Warn if @samp{long long} type is used. This is enabled by either
4669 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4670 modes. To inhibit the warning messages, use @option{-Wno-long-long}.
4671
4672 @item -Wvariadic-macros
4673 @opindex Wvariadic-macros
4674 @opindex Wno-variadic-macros
4675 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4676 alternate syntax when in pedantic ISO C99 mode. This is default.
4677 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4678
4679 @item -Wvarargs
4680 @opindex Wvarargs
4681 @opindex Wno-varargs
4682 Warn upon questionable usage of the macros used to handle variable
4683 arguments like @samp{va_start}. This is default. To inhibit the
4684 warning messages, use @option{-Wno-varargs}.
4685
4686 @item -Wvector-operation-performance
4687 @opindex Wvector-operation-performance
4688 @opindex Wno-vector-operation-performance
4689 Warn if vector operation is not implemented via SIMD capabilities of the
4690 architecture. Mainly useful for the performance tuning.
4691 Vector operation can be implemented @code{piecewise}, which means that the
4692 scalar operation is performed on every vector element;
4693 @code{in parallel}, which means that the vector operation is implemented
4694 using scalars of wider type, which normally is more performance efficient;
4695 and @code{as a single scalar}, which means that vector fits into a
4696 scalar type.
4697
4698 @item -Wvla
4699 @opindex Wvla
4700 @opindex Wno-vla
4701 Warn if variable length array is used in the code.
4702 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4703 the variable length array.
4704
4705 @item -Wvolatile-register-var
4706 @opindex Wvolatile-register-var
4707 @opindex Wno-volatile-register-var
4708 Warn if a register variable is declared volatile. The volatile
4709 modifier does not inhibit all optimizations that may eliminate reads
4710 and/or writes to register variables. This warning is enabled by
4711 @option{-Wall}.
4712
4713 @item -Wdisabled-optimization
4714 @opindex Wdisabled-optimization
4715 @opindex Wno-disabled-optimization
4716 Warn if a requested optimization pass is disabled. This warning does
4717 not generally indicate that there is anything wrong with your code; it
4718 merely indicates that GCC's optimizers are unable to handle the code
4719 effectively. Often, the problem is that your code is too big or too
4720 complex; GCC refuses to optimize programs when the optimization
4721 itself is likely to take inordinate amounts of time.
4722
4723 @item -Wpointer-sign @r{(C and Objective-C only)}
4724 @opindex Wpointer-sign
4725 @opindex Wno-pointer-sign
4726 Warn for pointer argument passing or assignment with different signedness.
4727 This option is only supported for C and Objective-C@. It is implied by
4728 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4729 @option{-Wno-pointer-sign}.
4730
4731 @item -Wstack-protector
4732 @opindex Wstack-protector
4733 @opindex Wno-stack-protector
4734 This option is only active when @option{-fstack-protector} is active. It
4735 warns about functions that are not protected against stack smashing.
4736
4737 @item -Wno-mudflap
4738 @opindex Wno-mudflap
4739 Suppress warnings about constructs that cannot be instrumented by
4740 @option{-fmudflap}.
4741
4742 @item -Woverlength-strings
4743 @opindex Woverlength-strings
4744 @opindex Wno-overlength-strings
4745 Warn about string constants that are longer than the ``minimum
4746 maximum'' length specified in the C standard. Modern compilers
4747 generally allow string constants that are much longer than the
4748 standard's minimum limit, but very portable programs should avoid
4749 using longer strings.
4750
4751 The limit applies @emph{after} string constant concatenation, and does
4752 not count the trailing NUL@. In C90, the limit was 509 characters; in
4753 C99, it was raised to 4095. C++98 does not specify a normative
4754 minimum maximum, so we do not diagnose overlength strings in C++@.
4755
4756 This option is implied by @option{-Wpedantic}, and can be disabled with
4757 @option{-Wno-overlength-strings}.
4758
4759 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4760 @opindex Wunsuffixed-float-constants
4761
4762 Issue a warning for any floating constant that does not have
4763 a suffix. When used together with @option{-Wsystem-headers} it
4764 warns about such constants in system header files. This can be useful
4765 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4766 from the decimal floating-point extension to C99.
4767 @end table
4768
4769 @node Debugging Options
4770 @section Options for Debugging Your Program or GCC
4771 @cindex options, debugging
4772 @cindex debugging information options
4773
4774 GCC has various special options that are used for debugging
4775 either your program or GCC:
4776
4777 @table @gcctabopt
4778 @item -g
4779 @opindex g
4780 Produce debugging information in the operating system's native format
4781 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
4782 information.
4783
4784 On most systems that use stabs format, @option{-g} enables use of extra
4785 debugging information that only GDB can use; this extra information
4786 makes debugging work better in GDB but probably makes other debuggers
4787 crash or
4788 refuse to read the program. If you want to control for certain whether
4789 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4790 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4791
4792 GCC allows you to use @option{-g} with
4793 @option{-O}. The shortcuts taken by optimized code may occasionally
4794 produce surprising results: some variables you declared may not exist
4795 at all; flow of control may briefly move where you did not expect it;
4796 some statements may not be executed because they compute constant
4797 results or their values are already at hand; some statements may
4798 execute in different places because they have been moved out of loops.
4799
4800 Nevertheless it proves possible to debug optimized output. This makes
4801 it reasonable to use the optimizer for programs that might have bugs.
4802
4803 The following options are useful when GCC is generated with the
4804 capability for more than one debugging format.
4805
4806 @item -ggdb
4807 @opindex ggdb
4808 Produce debugging information for use by GDB@. This means to use the
4809 most expressive format available (DWARF 2, stabs, or the native format
4810 if neither of those are supported), including GDB extensions if at all
4811 possible.
4812
4813 @item -gpubnames
4814 @opindex gpubnames
4815 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4816
4817 @item -gstabs
4818 @opindex gstabs
4819 Produce debugging information in stabs format (if that is supported),
4820 without GDB extensions. This is the format used by DBX on most BSD
4821 systems. On MIPS, Alpha and System V Release 4 systems this option
4822 produces stabs debugging output that is not understood by DBX or SDB@.
4823 On System V Release 4 systems this option requires the GNU assembler.
4824
4825 @item -feliminate-unused-debug-symbols
4826 @opindex feliminate-unused-debug-symbols
4827 Produce debugging information in stabs format (if that is supported),
4828 for only symbols that are actually used.
4829
4830 @item -femit-class-debug-always
4831 Instead of emitting debugging information for a C++ class in only one
4832 object file, emit it in all object files using the class. This option
4833 should be used only with debuggers that are unable to handle the way GCC
4834 normally emits debugging information for classes because using this
4835 option increases the size of debugging information by as much as a
4836 factor of two.
4837
4838 @item -fdebug-types-section
4839 @opindex fdebug-types-section
4840 @opindex fno-debug-types-section
4841 When using DWARF Version 4 or higher, type DIEs can be put into
4842 their own @code{.debug_types} section instead of making them part of the
4843 @code{.debug_info} section. It is more efficient to put them in a separate
4844 comdat sections since the linker can then remove duplicates.
4845 But not all DWARF consumers support @code{.debug_types} sections yet
4846 and on some objects @code{.debug_types} produces larger instead of smaller
4847 debugging information.
4848
4849 @item -gstabs+
4850 @opindex gstabs+
4851 Produce debugging information in stabs format (if that is supported),
4852 using GNU extensions understood only by the GNU debugger (GDB)@. The
4853 use of these extensions is likely to make other debuggers crash or
4854 refuse to read the program.
4855
4856 @item -gcoff
4857 @opindex gcoff
4858 Produce debugging information in COFF format (if that is supported).
4859 This is the format used by SDB on most System V systems prior to
4860 System V Release 4.
4861
4862 @item -gxcoff
4863 @opindex gxcoff
4864 Produce debugging information in XCOFF format (if that is supported).
4865 This is the format used by the DBX debugger on IBM RS/6000 systems.
4866
4867 @item -gxcoff+
4868 @opindex gxcoff+
4869 Produce debugging information in XCOFF format (if that is supported),
4870 using GNU extensions understood only by the GNU debugger (GDB)@. The
4871 use of these extensions is likely to make other debuggers crash or
4872 refuse to read the program, and may cause assemblers other than the GNU
4873 assembler (GAS) to fail with an error.
4874
4875 @item -gdwarf-@var{version}
4876 @opindex gdwarf-@var{version}
4877 Produce debugging information in DWARF format (if that is supported).
4878 The value of @var{version} may be either 2, 3 or 4; the default version
4879 for most targets is 4.
4880
4881 Note that with DWARF Version 2, some ports require and always
4882 use some non-conflicting DWARF 3 extensions in the unwind tables.
4883
4884 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4885 for maximum benefit.
4886
4887 @item -grecord-gcc-switches
4888 @opindex grecord-gcc-switches
4889 This switch causes the command-line options used to invoke the
4890 compiler that may affect code generation to be appended to the
4891 DW_AT_producer attribute in DWARF debugging information. The options
4892 are concatenated with spaces separating them from each other and from
4893 the compiler version. See also @option{-frecord-gcc-switches} for another
4894 way of storing compiler options into the object file. This is the default.
4895
4896 @item -gno-record-gcc-switches
4897 @opindex gno-record-gcc-switches
4898 Disallow appending command-line options to the DW_AT_producer attribute
4899 in DWARF debugging information.
4900
4901 @item -gstrict-dwarf
4902 @opindex gstrict-dwarf
4903 Disallow using extensions of later DWARF standard version than selected
4904 with @option{-gdwarf-@var{version}}. On most targets using non-conflicting
4905 DWARF extensions from later standard versions is allowed.
4906
4907 @item -gno-strict-dwarf
4908 @opindex gno-strict-dwarf
4909 Allow using extensions of later DWARF standard version than selected with
4910 @option{-gdwarf-@var{version}}.
4911
4912 @item -gvms
4913 @opindex gvms
4914 Produce debugging information in Alpha/VMS debug format (if that is
4915 supported). This is the format used by DEBUG on Alpha/VMS systems.
4916
4917 @item -g@var{level}
4918 @itemx -ggdb@var{level}
4919 @itemx -gstabs@var{level}
4920 @itemx -gcoff@var{level}
4921 @itemx -gxcoff@var{level}
4922 @itemx -gvms@var{level}
4923 Request debugging information and also use @var{level} to specify how
4924 much information. The default level is 2.
4925
4926 Level 0 produces no debug information at all. Thus, @option{-g0} negates
4927 @option{-g}.
4928
4929 Level 1 produces minimal information, enough for making backtraces in
4930 parts of the program that you don't plan to debug. This includes
4931 descriptions of functions and external variables, but no information
4932 about local variables and no line numbers.
4933
4934 Level 3 includes extra information, such as all the macro definitions
4935 present in the program. Some debuggers support macro expansion when
4936 you use @option{-g3}.
4937
4938 @option{-gdwarf-2} does not accept a concatenated debug level, because
4939 GCC used to support an option @option{-gdwarf} that meant to generate
4940 debug information in version 1 of the DWARF format (which is very
4941 different from version 2), and it would have been too confusing. That
4942 debug format is long obsolete, but the option cannot be changed now.
4943 Instead use an additional @option{-g@var{level}} option to change the
4944 debug level for DWARF.
4945
4946 @item -gtoggle
4947 @opindex gtoggle
4948 Turn off generation of debug info, if leaving out this option
4949 generates it, or turn it on at level 2 otherwise. The position of this
4950 argument in the command line does not matter; it takes effect after all
4951 other options are processed, and it does so only once, no matter how
4952 many times it is given. This is mainly intended to be used with
4953 @option{-fcompare-debug}.
4954
4955 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4956 @opindex fdump-final-insns
4957 Dump the final internal representation (RTL) to @var{file}. If the
4958 optional argument is omitted (or if @var{file} is @code{.}), the name
4959 of the dump file is determined by appending @code{.gkd} to the
4960 compilation output file name.
4961
4962 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4963 @opindex fcompare-debug
4964 @opindex fno-compare-debug
4965 If no error occurs during compilation, run the compiler a second time,
4966 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4967 passed to the second compilation. Dump the final internal
4968 representation in both compilations, and print an error if they differ.
4969
4970 If the equal sign is omitted, the default @option{-gtoggle} is used.
4971
4972 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4973 and nonzero, implicitly enables @option{-fcompare-debug}. If
4974 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4975 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4976 is used.
4977
4978 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4979 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4980 of the final representation and the second compilation, preventing even
4981 @env{GCC_COMPARE_DEBUG} from taking effect.
4982
4983 To verify full coverage during @option{-fcompare-debug} testing, set
4984 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4985 which GCC rejects as an invalid option in any actual compilation
4986 (rather than preprocessing, assembly or linking). To get just a
4987 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4988 not overridden} will do.
4989
4990 @item -fcompare-debug-second
4991 @opindex fcompare-debug-second
4992 This option is implicitly passed to the compiler for the second
4993 compilation requested by @option{-fcompare-debug}, along with options to
4994 silence warnings, and omitting other options that would cause
4995 side-effect compiler outputs to files or to the standard output. Dump
4996 files and preserved temporary files are renamed so as to contain the
4997 @code{.gk} additional extension during the second compilation, to avoid
4998 overwriting those generated by the first.
4999
5000 When this option is passed to the compiler driver, it causes the
5001 @emph{first} compilation to be skipped, which makes it useful for little
5002 other than debugging the compiler proper.
5003
5004 @item -feliminate-dwarf2-dups
5005 @opindex feliminate-dwarf2-dups
5006 Compress DWARF 2 debugging information by eliminating duplicated
5007 information about each symbol. This option only makes sense when
5008 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5009
5010 @item -femit-struct-debug-baseonly
5011 Emit debug information for struct-like types
5012 only when the base name of the compilation source file
5013 matches the base name of file in which the struct is defined.
5014
5015 This option substantially reduces the size of debugging information,
5016 but at significant potential loss in type information to the debugger.
5017 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5018 See @option{-femit-struct-debug-detailed} for more detailed control.
5019
5020 This option works only with DWARF 2.
5021
5022 @item -femit-struct-debug-reduced
5023 Emit debug information for struct-like types
5024 only when the base name of the compilation source file
5025 matches the base name of file in which the type is defined,
5026 unless the struct is a template or defined in a system header.
5027
5028 This option significantly reduces the size of debugging information,
5029 with some potential loss in type information to the debugger.
5030 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5031 See @option{-femit-struct-debug-detailed} for more detailed control.
5032
5033 This option works only with DWARF 2.
5034
5035 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5036 Specify the struct-like types
5037 for which the compiler generates debug information.
5038 The intent is to reduce duplicate struct debug information
5039 between different object files within the same program.
5040
5041 This option is a detailed version of
5042 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5043 which serves for most needs.
5044
5045 A specification has the syntax@*
5046 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5047
5048 The optional first word limits the specification to
5049 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5050 A struct type is used directly when it is the type of a variable, member.
5051 Indirect uses arise through pointers to structs.
5052 That is, when use of an incomplete struct is valid, the use is indirect.
5053 An example is
5054 @samp{struct one direct; struct two * indirect;}.
5055
5056 The optional second word limits the specification to
5057 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5058 Generic structs are a bit complicated to explain.
5059 For C++, these are non-explicit specializations of template classes,
5060 or non-template classes within the above.
5061 Other programming languages have generics,
5062 but @option{-femit-struct-debug-detailed} does not yet implement them.
5063
5064 The third word specifies the source files for those
5065 structs for which the compiler should emit debug information.
5066 The values @samp{none} and @samp{any} have the normal meaning.
5067 The value @samp{base} means that
5068 the base of name of the file in which the type declaration appears
5069 must match the base of the name of the main compilation file.
5070 In practice, this means that when compiling @file{foo.c}, debug information
5071 is generated for types declared in that file and @file{foo.h},
5072 but not other header files.
5073 The value @samp{sys} means those types satisfying @samp{base}
5074 or declared in system or compiler headers.
5075
5076 You may need to experiment to determine the best settings for your application.
5077
5078 The default is @option{-femit-struct-debug-detailed=all}.
5079
5080 This option works only with DWARF 2.
5081
5082 @item -fno-merge-debug-strings
5083 @opindex fmerge-debug-strings
5084 @opindex fno-merge-debug-strings
5085 Direct the linker to not merge together strings in the debugging
5086 information that are identical in different object files. Merging is
5087 not supported by all assemblers or linkers. Merging decreases the size
5088 of the debug information in the output file at the cost of increasing
5089 link processing time. Merging is enabled by default.
5090
5091 @item -fdebug-prefix-map=@var{old}=@var{new}
5092 @opindex fdebug-prefix-map
5093 When compiling files in directory @file{@var{old}}, record debugging
5094 information describing them as in @file{@var{new}} instead.
5095
5096 @item -fno-dwarf2-cfi-asm
5097 @opindex fdwarf2-cfi-asm
5098 @opindex fno-dwarf2-cfi-asm
5099 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5100 instead of using GAS @code{.cfi_*} directives.
5101
5102 @cindex @command{prof}
5103 @item -p
5104 @opindex p
5105 Generate extra code to write profile information suitable for the
5106 analysis program @command{prof}. You must use this option when compiling
5107 the source files you want data about, and you must also use it when
5108 linking.
5109
5110 @cindex @command{gprof}
5111 @item -pg
5112 @opindex pg
5113 Generate extra code to write profile information suitable for the
5114 analysis program @command{gprof}. You must use this option when compiling
5115 the source files you want data about, and you must also use it when
5116 linking.
5117
5118 @item -Q
5119 @opindex Q
5120 Makes the compiler print out each function name as it is compiled, and
5121 print some statistics about each pass when it finishes.
5122
5123 @item -ftime-report
5124 @opindex ftime-report
5125 Makes the compiler print some statistics about the time consumed by each
5126 pass when it finishes.
5127
5128 @item -fmem-report
5129 @opindex fmem-report
5130 Makes the compiler print some statistics about permanent memory
5131 allocation when it finishes.
5132
5133 @item -fpre-ipa-mem-report
5134 @opindex fpre-ipa-mem-report
5135 @item -fpost-ipa-mem-report
5136 @opindex fpost-ipa-mem-report
5137 Makes the compiler print some statistics about permanent memory
5138 allocation before or after interprocedural optimization.
5139
5140 @item -fstack-usage
5141 @opindex fstack-usage
5142 Makes the compiler output stack usage information for the program, on a
5143 per-function basis. The filename for the dump is made by appending
5144 @file{.su} to the @var{auxname}. @var{auxname} is generated from the name of
5145 the output file, if explicitly specified and it is not an executable,
5146 otherwise it is the basename of the source file. An entry is made up
5147 of three fields:
5148
5149 @itemize
5150 @item
5151 The name of the function.
5152 @item
5153 A number of bytes.
5154 @item
5155 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5156 @end itemize
5157
5158 The qualifier @code{static} means that the function manipulates the stack
5159 statically: a fixed number of bytes are allocated for the frame on function
5160 entry and released on function exit; no stack adjustments are otherwise made
5161 in the function. The second field is this fixed number of bytes.
5162
5163 The qualifier @code{dynamic} means that the function manipulates the stack
5164 dynamically: in addition to the static allocation described above, stack
5165 adjustments are made in the body of the function, for example to push/pop
5166 arguments around function calls. If the qualifier @code{bounded} is also
5167 present, the amount of these adjustments is bounded at compile time and
5168 the second field is an upper bound of the total amount of stack used by
5169 the function. If it is not present, the amount of these adjustments is
5170 not bounded at compile time and the second field only represents the
5171 bounded part.
5172
5173 @item -fprofile-arcs
5174 @opindex fprofile-arcs
5175 Add code so that program flow @dfn{arcs} are instrumented. During
5176 execution the program records how many times each branch and call is
5177 executed and how many times it is taken or returns. When the compiled
5178 program exits it saves this data to a file called
5179 @file{@var{auxname}.gcda} for each source file. The data may be used for
5180 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5181 test coverage analysis (@option{-ftest-coverage}). Each object file's
5182 @var{auxname} is generated from the name of the output file, if
5183 explicitly specified and it is not the final executable, otherwise it is
5184 the basename of the source file. In both cases any suffix is removed
5185 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5186 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5187 @xref{Cross-profiling}.
5188
5189 @cindex @command{gcov}
5190 @item --coverage
5191 @opindex coverage
5192
5193 This option is used to compile and link code instrumented for coverage
5194 analysis. The option is a synonym for @option{-fprofile-arcs}
5195 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5196 linking). See the documentation for those options for more details.
5197
5198 @itemize
5199
5200 @item
5201 Compile the source files with @option{-fprofile-arcs} plus optimization
5202 and code generation options. For test coverage analysis, use the
5203 additional @option{-ftest-coverage} option. You do not need to profile
5204 every source file in a program.
5205
5206 @item
5207 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5208 (the latter implies the former).
5209
5210 @item
5211 Run the program on a representative workload to generate the arc profile
5212 information. This may be repeated any number of times. You can run
5213 concurrent instances of your program, and provided that the file system
5214 supports locking, the data files will be correctly updated. Also
5215 @code{fork} calls are detected and correctly handled (double counting
5216 will not happen).
5217
5218 @item
5219 For profile-directed optimizations, compile the source files again with
5220 the same optimization and code generation options plus
5221 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5222 Control Optimization}).
5223
5224 @item
5225 For test coverage analysis, use @command{gcov} to produce human readable
5226 information from the @file{.gcno} and @file{.gcda} files. Refer to the
5227 @command{gcov} documentation for further information.
5228
5229 @end itemize
5230
5231 With @option{-fprofile-arcs}, for each function of your program GCC
5232 creates a program flow graph, then finds a spanning tree for the graph.
5233 Only arcs that are not on the spanning tree have to be instrumented: the
5234 compiler adds code to count the number of times that these arcs are
5235 executed. When an arc is the only exit or only entrance to a block, the
5236 instrumentation code can be added to the block; otherwise, a new basic
5237 block must be created to hold the instrumentation code.
5238
5239 @need 2000
5240 @item -ftest-coverage
5241 @opindex ftest-coverage
5242 Produce a notes file that the @command{gcov} code-coverage utility
5243 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5244 show program coverage. Each source file's note file is called
5245 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
5246 above for a description of @var{auxname} and instructions on how to
5247 generate test coverage data. Coverage data matches the source files
5248 more closely if you do not optimize.
5249
5250 @item -fdbg-cnt-list
5251 @opindex fdbg-cnt-list
5252 Print the name and the counter upper bound for all debug counters.
5253
5254
5255 @item -fdbg-cnt=@var{counter-value-list}
5256 @opindex fdbg-cnt
5257 Set the internal debug counter upper bound. @var{counter-value-list}
5258 is a comma-separated list of @var{name}:@var{value} pairs
5259 which sets the upper bound of each debug counter @var{name} to @var{value}.
5260 All debug counters have the initial upper bound of @code{UINT_MAX};
5261 thus @code{dbg_cnt()} returns true always unless the upper bound
5262 is set by this option.
5263 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5264 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5265
5266 @itemx -fenable-@var{kind}-@var{pass}
5267 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5268 @opindex fdisable-
5269 @opindex fenable-
5270
5271 This is a set of options that are used to explicitly disable/enable
5272 optimization passes. These options are intended for use for debugging GCC.
5273 Compiler users should use regular options for enabling/disabling
5274 passes instead.
5275
5276 @table @gcctabopt
5277
5278 @item -fdisable-ipa-@var{pass}
5279 Disable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
5280 statically invoked in the compiler multiple times, the pass name should be
5281 appended with a sequential number starting from 1.
5282
5283 @item -fdisable-rtl-@var{pass}
5284 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5285 Disable RTL pass @var{pass}. @var{pass} is the pass name. If the same pass is
5286 statically invoked in the compiler multiple times, the pass name should be
5287 appended with a sequential number starting from 1. @var{range-list} is a
5288 comma-separated list of function ranges or assembler names. Each range is a number
5289 pair separated by a colon. The range is inclusive in both ends. If the range
5290 is trivial, the number pair can be simplified as a single number. If the
5291 function's cgraph node's @var{uid} falls within one of the specified ranges,
5292 the @var{pass} is disabled for that function. The @var{uid} is shown in the
5293 function header of a dump file, and the pass names can be dumped by using
5294 option @option{-fdump-passes}.
5295
5296 @item -fdisable-tree-@var{pass}
5297 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5298 Disable tree pass @var{pass}. See @option{-fdisable-rtl} for the description of
5299 option arguments.
5300
5301 @item -fenable-ipa-@var{pass}
5302 Enable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
5303 statically invoked in the compiler multiple times, the pass name should be
5304 appended with a sequential number starting from 1.
5305
5306 @item -fenable-rtl-@var{pass}
5307 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5308 Enable RTL pass @var{pass}. See @option{-fdisable-rtl} for option argument
5309 description and examples.
5310
5311 @item -fenable-tree-@var{pass}
5312 @itemx -fenable-tree-@var{pass}=@var{range-list}
5313 Enable tree pass @var{pass}. See @option{-fdisable-rtl} for the description
5314 of option arguments.
5315
5316 @end table
5317
5318 Here are some examples showing uses of these options.
5319
5320 @smallexample
5321
5322 # disable ccp1 for all functions
5323 -fdisable-tree-ccp1
5324 # disable complete unroll for function whose cgraph node uid is 1
5325 -fenable-tree-cunroll=1
5326 # disable gcse2 for functions at the following ranges [1,1],
5327 # [300,400], and [400,1000]
5328 # disable gcse2 for functions foo and foo2
5329 -fdisable-rtl-gcse2=foo,foo2
5330 # disable early inlining
5331 -fdisable-tree-einline
5332 # disable ipa inlining
5333 -fdisable-ipa-inline
5334 # enable tree full unroll
5335 -fenable-tree-unroll
5336
5337 @end smallexample
5338
5339 @item -d@var{letters}
5340 @itemx -fdump-rtl-@var{pass}
5341 @opindex d
5342 Says to make debugging dumps during compilation at times specified by
5343 @var{letters}. This is used for debugging the RTL-based passes of the
5344 compiler. The file names for most of the dumps are made by appending
5345 a pass number and a word to the @var{dumpname}, and the files are
5346 created in the directory of the output file. Note that the pass
5347 number is computed statically as passes get registered into the pass
5348 manager. Thus the numbering is not related to the dynamic order of
5349 execution of passes. In particular, a pass installed by a plugin
5350 could have a number over 200 even if it executed quite early.
5351 @var{dumpname} is generated from the name of the output file, if
5352 explicitly specified and it is not an executable, otherwise it is the
5353 basename of the source file. These switches may have different effects
5354 when @option{-E} is used for preprocessing.
5355
5356 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5357 @option{-d} option @var{letters}. Here are the possible
5358 letters for use in @var{pass} and @var{letters}, and their meanings:
5359
5360 @table @gcctabopt
5361
5362 @item -fdump-rtl-alignments
5363 @opindex fdump-rtl-alignments
5364 Dump after branch alignments have been computed.
5365
5366 @item -fdump-rtl-asmcons
5367 @opindex fdump-rtl-asmcons
5368 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5369
5370 @item -fdump-rtl-auto_inc_dec
5371 @opindex fdump-rtl-auto_inc_dec
5372 Dump after auto-inc-dec discovery. This pass is only run on
5373 architectures that have auto inc or auto dec instructions.
5374
5375 @item -fdump-rtl-barriers
5376 @opindex fdump-rtl-barriers
5377 Dump after cleaning up the barrier instructions.
5378
5379 @item -fdump-rtl-bbpart
5380 @opindex fdump-rtl-bbpart
5381 Dump after partitioning hot and cold basic blocks.
5382
5383 @item -fdump-rtl-bbro
5384 @opindex fdump-rtl-bbro
5385 Dump after block reordering.
5386
5387 @item -fdump-rtl-btl1
5388 @itemx -fdump-rtl-btl2
5389 @opindex fdump-rtl-btl2
5390 @opindex fdump-rtl-btl2
5391 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5392 after the two branch
5393 target load optimization passes.
5394
5395 @item -fdump-rtl-bypass
5396 @opindex fdump-rtl-bypass
5397 Dump after jump bypassing and control flow optimizations.
5398
5399 @item -fdump-rtl-combine
5400 @opindex fdump-rtl-combine
5401 Dump after the RTL instruction combination pass.
5402
5403 @item -fdump-rtl-compgotos
5404 @opindex fdump-rtl-compgotos
5405 Dump after duplicating the computed gotos.
5406
5407 @item -fdump-rtl-ce1
5408 @itemx -fdump-rtl-ce2
5409 @itemx -fdump-rtl-ce3
5410 @opindex fdump-rtl-ce1
5411 @opindex fdump-rtl-ce2
5412 @opindex fdump-rtl-ce3
5413 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5414 @option{-fdump-rtl-ce3} enable dumping after the three
5415 if conversion passes.
5416
5417 @itemx -fdump-rtl-cprop_hardreg
5418 @opindex fdump-rtl-cprop_hardreg
5419 Dump after hard register copy propagation.
5420
5421 @itemx -fdump-rtl-csa
5422 @opindex fdump-rtl-csa
5423 Dump after combining stack adjustments.
5424
5425 @item -fdump-rtl-cse1
5426 @itemx -fdump-rtl-cse2
5427 @opindex fdump-rtl-cse1
5428 @opindex fdump-rtl-cse2
5429 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5430 the two common sub-expression elimination passes.
5431
5432 @itemx -fdump-rtl-dce
5433 @opindex fdump-rtl-dce
5434 Dump after the standalone dead code elimination passes.
5435
5436 @itemx -fdump-rtl-dbr
5437 @opindex fdump-rtl-dbr
5438 Dump after delayed branch scheduling.
5439
5440 @item -fdump-rtl-dce1
5441 @itemx -fdump-rtl-dce2
5442 @opindex fdump-rtl-dce1
5443 @opindex fdump-rtl-dce2
5444 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5445 the two dead store elimination passes.
5446
5447 @item -fdump-rtl-eh
5448 @opindex fdump-rtl-eh
5449 Dump after finalization of EH handling code.
5450
5451 @item -fdump-rtl-eh_ranges
5452 @opindex fdump-rtl-eh_ranges
5453 Dump after conversion of EH handling range regions.
5454
5455 @item -fdump-rtl-expand
5456 @opindex fdump-rtl-expand
5457 Dump after RTL generation.
5458
5459 @item -fdump-rtl-fwprop1
5460 @itemx -fdump-rtl-fwprop2
5461 @opindex fdump-rtl-fwprop1
5462 @opindex fdump-rtl-fwprop2
5463 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5464 dumping after the two forward propagation passes.
5465
5466 @item -fdump-rtl-gcse1
5467 @itemx -fdump-rtl-gcse2
5468 @opindex fdump-rtl-gcse1
5469 @opindex fdump-rtl-gcse2
5470 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5471 after global common subexpression elimination.
5472
5473 @item -fdump-rtl-init-regs
5474 @opindex fdump-rtl-init-regs
5475 Dump after the initialization of the registers.
5476
5477 @item -fdump-rtl-initvals
5478 @opindex fdump-rtl-initvals
5479 Dump after the computation of the initial value sets.
5480
5481 @itemx -fdump-rtl-into_cfglayout
5482 @opindex fdump-rtl-into_cfglayout
5483 Dump after converting to cfglayout mode.
5484
5485 @item -fdump-rtl-ira
5486 @opindex fdump-rtl-ira
5487 Dump after iterated register allocation.
5488
5489 @item -fdump-rtl-jump
5490 @opindex fdump-rtl-jump
5491 Dump after the second jump optimization.
5492
5493 @item -fdump-rtl-loop2
5494 @opindex fdump-rtl-loop2
5495 @option{-fdump-rtl-loop2} enables dumping after the rtl
5496 loop optimization passes.
5497
5498 @item -fdump-rtl-mach
5499 @opindex fdump-rtl-mach
5500 Dump after performing the machine dependent reorganization pass, if that
5501 pass exists.
5502
5503 @item -fdump-rtl-mode_sw
5504 @opindex fdump-rtl-mode_sw
5505 Dump after removing redundant mode switches.
5506
5507 @item -fdump-rtl-rnreg
5508 @opindex fdump-rtl-rnreg
5509 Dump after register renumbering.
5510
5511 @itemx -fdump-rtl-outof_cfglayout
5512 @opindex fdump-rtl-outof_cfglayout
5513 Dump after converting from cfglayout mode.
5514
5515 @item -fdump-rtl-peephole2
5516 @opindex fdump-rtl-peephole2
5517 Dump after the peephole pass.
5518
5519 @item -fdump-rtl-postreload
5520 @opindex fdump-rtl-postreload
5521 Dump after post-reload optimizations.
5522
5523 @itemx -fdump-rtl-pro_and_epilogue
5524 @opindex fdump-rtl-pro_and_epilogue
5525 Dump after generating the function prologues and epilogues.
5526
5527 @item -fdump-rtl-regmove
5528 @opindex fdump-rtl-regmove
5529 Dump after the register move pass.
5530
5531 @item -fdump-rtl-sched1
5532 @itemx -fdump-rtl-sched2
5533 @opindex fdump-rtl-sched1
5534 @opindex fdump-rtl-sched2
5535 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5536 after the basic block scheduling passes.
5537
5538 @item -fdump-rtl-see
5539 @opindex fdump-rtl-see
5540 Dump after sign extension elimination.
5541
5542 @item -fdump-rtl-seqabstr
5543 @opindex fdump-rtl-seqabstr
5544 Dump after common sequence discovery.
5545
5546 @item -fdump-rtl-shorten
5547 @opindex fdump-rtl-shorten
5548 Dump after shortening branches.
5549
5550 @item -fdump-rtl-sibling
5551 @opindex fdump-rtl-sibling
5552 Dump after sibling call optimizations.
5553
5554 @item -fdump-rtl-split1
5555 @itemx -fdump-rtl-split2
5556 @itemx -fdump-rtl-split3
5557 @itemx -fdump-rtl-split4
5558 @itemx -fdump-rtl-split5
5559 @opindex fdump-rtl-split1
5560 @opindex fdump-rtl-split2
5561 @opindex fdump-rtl-split3
5562 @opindex fdump-rtl-split4
5563 @opindex fdump-rtl-split5
5564 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5565 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5566 @option{-fdump-rtl-split5} enable dumping after five rounds of
5567 instruction splitting.
5568
5569 @item -fdump-rtl-sms
5570 @opindex fdump-rtl-sms
5571 Dump after modulo scheduling. This pass is only run on some
5572 architectures.
5573
5574 @item -fdump-rtl-stack
5575 @opindex fdump-rtl-stack
5576 Dump after conversion from GCC's ``flat register file'' registers to the
5577 x87's stack-like registers. This pass is only run on x86 variants.
5578
5579 @item -fdump-rtl-subreg1
5580 @itemx -fdump-rtl-subreg2
5581 @opindex fdump-rtl-subreg1
5582 @opindex fdump-rtl-subreg2
5583 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5584 the two subreg expansion passes.
5585
5586 @item -fdump-rtl-unshare
5587 @opindex fdump-rtl-unshare
5588 Dump after all rtl has been unshared.
5589
5590 @item -fdump-rtl-vartrack
5591 @opindex fdump-rtl-vartrack
5592 Dump after variable tracking.
5593
5594 @item -fdump-rtl-vregs
5595 @opindex fdump-rtl-vregs
5596 Dump after converting virtual registers to hard registers.
5597
5598 @item -fdump-rtl-web
5599 @opindex fdump-rtl-web
5600 Dump after live range splitting.
5601
5602 @item -fdump-rtl-regclass
5603 @itemx -fdump-rtl-subregs_of_mode_init
5604 @itemx -fdump-rtl-subregs_of_mode_finish
5605 @itemx -fdump-rtl-dfinit
5606 @itemx -fdump-rtl-dfinish
5607 @opindex fdump-rtl-regclass
5608 @opindex fdump-rtl-subregs_of_mode_init
5609 @opindex fdump-rtl-subregs_of_mode_finish
5610 @opindex fdump-rtl-dfinit
5611 @opindex fdump-rtl-dfinish
5612 These dumps are defined but always produce empty files.
5613
5614 @item -da
5615 @itemx -fdump-rtl-all
5616 @opindex da
5617 @opindex fdump-rtl-all
5618 Produce all the dumps listed above.
5619
5620 @item -dA
5621 @opindex dA
5622 Annotate the assembler output with miscellaneous debugging information.
5623
5624 @item -dD
5625 @opindex dD
5626 Dump all macro definitions, at the end of preprocessing, in addition to
5627 normal output.
5628
5629 @item -dH
5630 @opindex dH
5631 Produce a core dump whenever an error occurs.
5632
5633 @item -dp
5634 @opindex dp
5635 Annotate the assembler output with a comment indicating which
5636 pattern and alternative is used. The length of each instruction is
5637 also printed.
5638
5639 @item -dP
5640 @opindex dP
5641 Dump the RTL in the assembler output as a comment before each instruction.
5642 Also turns on @option{-dp} annotation.
5643
5644 @item -dv
5645 @opindex dv
5646 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5647 dump a representation of the control flow graph suitable for viewing with VCG
5648 to @file{@var{file}.@var{pass}.vcg}.
5649
5650 @item -dx
5651 @opindex dx
5652 Just generate RTL for a function instead of compiling it. Usually used
5653 with @option{-fdump-rtl-expand}.
5654 @end table
5655
5656 @item -fdump-noaddr
5657 @opindex fdump-noaddr
5658 When doing debugging dumps, suppress address output. This makes it more
5659 feasible to use diff on debugging dumps for compiler invocations with
5660 different compiler binaries and/or different
5661 text / bss / data / heap / stack / dso start locations.
5662
5663 @item -fdump-unnumbered
5664 @opindex fdump-unnumbered
5665 When doing debugging dumps, suppress instruction numbers and address output.
5666 This makes it more feasible to use diff on debugging dumps for compiler
5667 invocations with different options, in particular with and without
5668 @option{-g}.
5669
5670 @item -fdump-unnumbered-links
5671 @opindex fdump-unnumbered-links
5672 When doing debugging dumps (see @option{-d} option above), suppress
5673 instruction numbers for the links to the previous and next instructions
5674 in a sequence.
5675
5676 @item -fdump-translation-unit @r{(C++ only)}
5677 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5678 @opindex fdump-translation-unit
5679 Dump a representation of the tree structure for the entire translation
5680 unit to a file. The file name is made by appending @file{.tu} to the
5681 source file name, and the file is created in the same directory as the
5682 output file. If the @samp{-@var{options}} form is used, @var{options}
5683 controls the details of the dump as described for the
5684 @option{-fdump-tree} options.
5685
5686 @item -fdump-class-hierarchy @r{(C++ only)}
5687 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5688 @opindex fdump-class-hierarchy
5689 Dump a representation of each class's hierarchy and virtual function
5690 table layout to a file. The file name is made by appending
5691 @file{.class} to the source file name, and the file is created in the
5692 same directory as the output file. If the @samp{-@var{options}} form
5693 is used, @var{options} controls the details of the dump as described
5694 for the @option{-fdump-tree} options.
5695
5696 @item -fdump-ipa-@var{switch}
5697 @opindex fdump-ipa
5698 Control the dumping at various stages of inter-procedural analysis
5699 language tree to a file. The file name is generated by appending a
5700 switch specific suffix to the source file name, and the file is created
5701 in the same directory as the output file. The following dumps are
5702 possible:
5703
5704 @table @samp
5705 @item all
5706 Enables all inter-procedural analysis dumps.
5707
5708 @item cgraph
5709 Dumps information about call-graph optimization, unused function removal,
5710 and inlining decisions.
5711
5712 @item inline
5713 Dump after function inlining.
5714
5715 @end table
5716
5717 @item -fdump-passes
5718 @opindex fdump-passes
5719 Dump the list of optimization passes that are turned on and off by
5720 the current command-line options.
5721
5722 @item -fdump-statistics-@var{option}
5723 @opindex fdump-statistics
5724 Enable and control dumping of pass statistics in a separate file. The
5725 file name is generated by appending a suffix ending in
5726 @samp{.statistics} to the source file name, and the file is created in
5727 the same directory as the output file. If the @samp{-@var{option}}
5728 form is used, @samp{-stats} causes counters to be summed over the
5729 whole compilation unit while @samp{-details} dumps every event as
5730 the passes generate them. The default with no option is to sum
5731 counters for each function compiled.
5732
5733 @item -fdump-tree-@var{switch}
5734 @itemx -fdump-tree-@var{switch}-@var{options}
5735 @opindex fdump-tree
5736 Control the dumping at various stages of processing the intermediate
5737 language tree to a file. The file name is generated by appending a
5738 switch specific suffix to the source file name, and the file is
5739 created in the same directory as the output file. If the
5740 @samp{-@var{options}} form is used, @var{options} is a list of
5741 @samp{-} separated options which control the details of the dump. Not
5742 all options are applicable to all dumps; those that are not
5743 meaningful are ignored. The following options are available
5744
5745 @table @samp
5746 @item address
5747 Print the address of each node. Usually this is not meaningful as it
5748 changes according to the environment and source file. Its primary use
5749 is for tying up a dump file with a debug environment.
5750 @item asmname
5751 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5752 in the dump instead of @code{DECL_NAME}. Its primary use is ease of
5753 use working backward from mangled names in the assembly file.
5754 @item slim
5755 Inhibit dumping of members of a scope or body of a function merely
5756 because that scope has been reached. Only dump such items when they
5757 are directly reachable by some other path. When dumping pretty-printed
5758 trees, this option inhibits dumping the bodies of control structures.
5759 @item raw
5760 Print a raw representation of the tree. By default, trees are
5761 pretty-printed into a C-like representation.
5762 @item details
5763 Enable more detailed dumps (not honored by every dump option).
5764 @item stats
5765 Enable dumping various statistics about the pass (not honored by every dump
5766 option).
5767 @item blocks
5768 Enable showing basic block boundaries (disabled in raw dumps).
5769 @item vops
5770 Enable showing virtual operands for every statement.
5771 @item lineno
5772 Enable showing line numbers for statements.
5773 @item uid
5774 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5775 @item verbose
5776 Enable showing the tree dump for each statement.
5777 @item eh
5778 Enable showing the EH region number holding each statement.
5779 @item scev
5780 Enable showing scalar evolution analysis details.
5781 @item all
5782 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5783 and @option{lineno}.
5784 @end table
5785
5786 The following tree dumps are possible:
5787 @table @samp
5788
5789 @item original
5790 @opindex fdump-tree-original
5791 Dump before any tree based optimization, to @file{@var{file}.original}.
5792
5793 @item optimized
5794 @opindex fdump-tree-optimized
5795 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5796
5797 @item gimple
5798 @opindex fdump-tree-gimple
5799 Dump each function before and after the gimplification pass to a file. The
5800 file name is made by appending @file{.gimple} to the source file name.
5801
5802 @item cfg
5803 @opindex fdump-tree-cfg
5804 Dump the control flow graph of each function to a file. The file name is
5805 made by appending @file{.cfg} to the source file name.
5806
5807 @item vcg
5808 @opindex fdump-tree-vcg
5809 Dump the control flow graph of each function to a file in VCG format. The
5810 file name is made by appending @file{.vcg} to the source file name. Note
5811 that if the file contains more than one function, the generated file cannot
5812 be used directly by VCG@. You must cut and paste each function's
5813 graph into its own separate file first.
5814
5815 @item ch
5816 @opindex fdump-tree-ch
5817 Dump each function after copying loop headers. The file name is made by
5818 appending @file{.ch} to the source file name.
5819
5820 @item ssa
5821 @opindex fdump-tree-ssa
5822 Dump SSA related information to a file. The file name is made by appending
5823 @file{.ssa} to the source file name.
5824
5825 @item alias
5826 @opindex fdump-tree-alias
5827 Dump aliasing information for each function. The file name is made by
5828 appending @file{.alias} to the source file name.
5829
5830 @item ccp
5831 @opindex fdump-tree-ccp
5832 Dump each function after CCP@. The file name is made by appending
5833 @file{.ccp} to the source file name.
5834
5835 @item storeccp
5836 @opindex fdump-tree-storeccp
5837 Dump each function after STORE-CCP@. The file name is made by appending
5838 @file{.storeccp} to the source file name.
5839
5840 @item pre
5841 @opindex fdump-tree-pre
5842 Dump trees after partial redundancy elimination. The file name is made
5843 by appending @file{.pre} to the source file name.
5844
5845 @item fre
5846 @opindex fdump-tree-fre
5847 Dump trees after full redundancy elimination. The file name is made
5848 by appending @file{.fre} to the source file name.
5849
5850 @item copyprop
5851 @opindex fdump-tree-copyprop
5852 Dump trees after copy propagation. The file name is made
5853 by appending @file{.copyprop} to the source file name.
5854
5855 @item store_copyprop
5856 @opindex fdump-tree-store_copyprop
5857 Dump trees after store copy-propagation. The file name is made
5858 by appending @file{.store_copyprop} to the source file name.
5859
5860 @item dce
5861 @opindex fdump-tree-dce
5862 Dump each function after dead code elimination. The file name is made by
5863 appending @file{.dce} to the source file name.
5864
5865 @item mudflap
5866 @opindex fdump-tree-mudflap
5867 Dump each function after adding mudflap instrumentation. The file name is
5868 made by appending @file{.mudflap} to the source file name.
5869
5870 @item sra
5871 @opindex fdump-tree-sra
5872 Dump each function after performing scalar replacement of aggregates. The
5873 file name is made by appending @file{.sra} to the source file name.
5874
5875 @item sink
5876 @opindex fdump-tree-sink
5877 Dump each function after performing code sinking. The file name is made
5878 by appending @file{.sink} to the source file name.
5879
5880 @item dom
5881 @opindex fdump-tree-dom
5882 Dump each function after applying dominator tree optimizations. The file
5883 name is made by appending @file{.dom} to the source file name.
5884
5885 @item dse
5886 @opindex fdump-tree-dse
5887 Dump each function after applying dead store elimination. The file
5888 name is made by appending @file{.dse} to the source file name.
5889
5890 @item phiopt
5891 @opindex fdump-tree-phiopt
5892 Dump each function after optimizing PHI nodes into straightline code. The file
5893 name is made by appending @file{.phiopt} to the source file name.
5894
5895 @item forwprop
5896 @opindex fdump-tree-forwprop
5897 Dump each function after forward propagating single use variables. The file
5898 name is made by appending @file{.forwprop} to the source file name.
5899
5900 @item copyrename
5901 @opindex fdump-tree-copyrename
5902 Dump each function after applying the copy rename optimization. The file
5903 name is made by appending @file{.copyrename} to the source file name.
5904
5905 @item nrv
5906 @opindex fdump-tree-nrv
5907 Dump each function after applying the named return value optimization on
5908 generic trees. The file name is made by appending @file{.nrv} to the source
5909 file name.
5910
5911 @item vect
5912 @opindex fdump-tree-vect
5913 Dump each function after applying vectorization of loops. The file name is
5914 made by appending @file{.vect} to the source file name.
5915
5916 @item slp
5917 @opindex fdump-tree-slp
5918 Dump each function after applying vectorization of basic blocks. The file name
5919 is made by appending @file{.slp} to the source file name.
5920
5921 @item vrp
5922 @opindex fdump-tree-vrp
5923 Dump each function after Value Range Propagation (VRP). The file name
5924 is made by appending @file{.vrp} to the source file name.
5925
5926 @item all
5927 @opindex fdump-tree-all
5928 Enable all the available tree dumps with the flags provided in this option.
5929 @end table
5930
5931 @item -ftree-vectorizer-verbose=@var{n}
5932 @opindex ftree-vectorizer-verbose
5933 This option controls the amount of debugging output the vectorizer prints.
5934 This information is written to standard error, unless
5935 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5936 in which case it is output to the usual dump listing file, @file{.vect}.
5937 For @var{n}=0 no diagnostic information is reported.
5938 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5939 and the total number of loops that got vectorized.
5940 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5941 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5942 inner-most, single-bb, single-entry/exit loops. This is the same verbosity
5943 level that @option{-fdump-tree-vect-stats} uses.
5944 Higher verbosity levels mean either more information dumped for each
5945 reported loop, or same amount of information reported for more loops:
5946 if @var{n}=3, vectorizer cost model information is reported.
5947 If @var{n}=4, alignment related information is added to the reports.
5948 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5949 memory access-patterns) is added to the reports.
5950 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5951 that did not pass the first analysis phase (i.e., may not be countable, or
5952 may have complicated control-flow).
5953 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5954 If @var{n}=8, SLP related information is added to the reports.
5955 For @var{n}=9, all the information the vectorizer generates during its
5956 analysis and transformation is reported. This is the same verbosity level
5957 that @option{-fdump-tree-vect-details} uses.
5958
5959 @item -frandom-seed=@var{string}
5960 @opindex frandom-seed
5961 This option provides a seed that GCC uses in place of
5962 random numbers in generating certain symbol names
5963 that have to be different in every compiled file. It is also used to
5964 place unique stamps in coverage data files and the object files that
5965 produce them. You can use the @option{-frandom-seed} option to produce
5966 reproducibly identical object files.
5967
5968 The @var{string} should be different for every file you compile.
5969
5970 @item -fsched-verbose=@var{n}
5971 @opindex fsched-verbose
5972 On targets that use instruction scheduling, this option controls the
5973 amount of debugging output the scheduler prints. This information is
5974 written to standard error, unless @option{-fdump-rtl-sched1} or
5975 @option{-fdump-rtl-sched2} is specified, in which case it is output
5976 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5977 respectively. However for @var{n} greater than nine, the output is
5978 always printed to standard error.
5979
5980 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5981 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5982 For @var{n} greater than one, it also output basic block probabilities,
5983 detailed ready list information and unit/insn info. For @var{n} greater
5984 than two, it includes RTL at abort point, control-flow and regions info.
5985 And for @var{n} over four, @option{-fsched-verbose} also includes
5986 dependence info.
5987
5988 @item -save-temps
5989 @itemx -save-temps=cwd
5990 @opindex save-temps
5991 Store the usual ``temporary'' intermediate files permanently; place them
5992 in the current directory and name them based on the source file. Thus,
5993 compiling @file{foo.c} with @option{-c -save-temps} produces files
5994 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
5995 preprocessed @file{foo.i} output file even though the compiler now
5996 normally uses an integrated preprocessor.
5997
5998 When used in combination with the @option{-x} command-line option,
5999 @option{-save-temps} is sensible enough to avoid over writing an
6000 input source file with the same extension as an intermediate file.
6001 The corresponding intermediate file may be obtained by renaming the
6002 source file before using @option{-save-temps}.
6003
6004 If you invoke GCC in parallel, compiling several different source
6005 files that share a common base name in different subdirectories or the
6006 same source file compiled for multiple output destinations, it is
6007 likely that the different parallel compilers will interfere with each
6008 other, and overwrite the temporary files. For instance:
6009
6010 @smallexample
6011 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6012 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6013 @end smallexample
6014
6015 may result in @file{foo.i} and @file{foo.o} being written to
6016 simultaneously by both compilers.
6017
6018 @item -save-temps=obj
6019 @opindex save-temps=obj
6020 Store the usual ``temporary'' intermediate files permanently. If the
6021 @option{-o} option is used, the temporary files are based on the
6022 object file. If the @option{-o} option is not used, the
6023 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6024
6025 For example:
6026
6027 @smallexample
6028 gcc -save-temps=obj -c foo.c
6029 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6030 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6031 @end smallexample
6032
6033 @noindent
6034 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6035 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6036 @file{dir2/yfoobar.o}.
6037
6038 @item -time@r{[}=@var{file}@r{]}
6039 @opindex time
6040 Report the CPU time taken by each subprocess in the compilation
6041 sequence. For C source files, this is the compiler proper and assembler
6042 (plus the linker if linking is done).
6043
6044 Without the specification of an output file, the output looks like this:
6045
6046 @smallexample
6047 # cc1 0.12 0.01
6048 # as 0.00 0.01
6049 @end smallexample
6050
6051 The first number on each line is the ``user time'', that is time spent
6052 executing the program itself. The second number is ``system time'',
6053 time spent executing operating system routines on behalf of the program.
6054 Both numbers are in seconds.
6055
6056 With the specification of an output file, the output is appended to the
6057 named file, and it looks like this:
6058
6059 @smallexample
6060 0.12 0.01 cc1 @var{options}
6061 0.00 0.01 as @var{options}
6062 @end smallexample
6063
6064 The ``user time'' and the ``system time'' are moved before the program
6065 name, and the options passed to the program are displayed, so that one
6066 can later tell what file was being compiled, and with which options.
6067
6068 @item -fvar-tracking
6069 @opindex fvar-tracking
6070 Run variable tracking pass. It computes where variables are stored at each
6071 position in code. Better debugging information is then generated
6072 (if the debugging information format supports this information).
6073
6074 It is enabled by default when compiling with optimization (@option{-Os},
6075 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6076 the debug info format supports it.
6077
6078 @item -fvar-tracking-assignments
6079 @opindex fvar-tracking-assignments
6080 @opindex fno-var-tracking-assignments
6081 Annotate assignments to user variables early in the compilation and
6082 attempt to carry the annotations over throughout the compilation all the
6083 way to the end, in an attempt to improve debug information while
6084 optimizing. Use of @option{-gdwarf-4} is recommended along with it.
6085
6086 It can be enabled even if var-tracking is disabled, in which case
6087 annotations are created and maintained, but discarded at the end.
6088
6089 @item -fvar-tracking-assignments-toggle
6090 @opindex fvar-tracking-assignments-toggle
6091 @opindex fno-var-tracking-assignments-toggle
6092 Toggle @option{-fvar-tracking-assignments}, in the same way that
6093 @option{-gtoggle} toggles @option{-g}.
6094
6095 @item -print-file-name=@var{library}
6096 @opindex print-file-name
6097 Print the full absolute name of the library file @var{library} that
6098 would be used when linking---and don't do anything else. With this
6099 option, GCC does not compile or link anything; it just prints the
6100 file name.
6101
6102 @item -print-multi-directory
6103 @opindex print-multi-directory
6104 Print the directory name corresponding to the multilib selected by any
6105 other switches present in the command line. This directory is supposed
6106 to exist in @env{GCC_EXEC_PREFIX}.
6107
6108 @item -print-multi-lib
6109 @opindex print-multi-lib
6110 Print the mapping from multilib directory names to compiler switches
6111 that enable them. The directory name is separated from the switches by
6112 @samp{;}, and each switch starts with an @samp{@@} instead of the
6113 @samp{-}, without spaces between multiple switches. This is supposed to
6114 ease shell-processing.
6115
6116 @item -print-multi-os-directory
6117 @opindex print-multi-os-directory
6118 Print the path to OS libraries for the selected
6119 multilib, relative to some @file{lib} subdirectory. If OS libraries are
6120 present in the @file{lib} subdirectory and no multilibs are used, this is
6121 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6122 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6123 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6124 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6125
6126 @item -print-prog-name=@var{program}
6127 @opindex print-prog-name
6128 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6129
6130 @item -print-libgcc-file-name
6131 @opindex print-libgcc-file-name
6132 Same as @option{-print-file-name=libgcc.a}.
6133
6134 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6135 but you do want to link with @file{libgcc.a}. You can do
6136
6137 @smallexample
6138 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6139 @end smallexample
6140
6141 @item -print-search-dirs
6142 @opindex print-search-dirs
6143 Print the name of the configured installation directory and a list of
6144 program and library directories @command{gcc} searches---and don't do anything else.
6145
6146 This is useful when @command{gcc} prints the error message
6147 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6148 To resolve this you either need to put @file{cpp0} and the other compiler
6149 components where @command{gcc} expects to find them, or you can set the environment
6150 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6151 Don't forget the trailing @samp{/}.
6152 @xref{Environment Variables}.
6153
6154 @item -print-sysroot
6155 @opindex print-sysroot
6156 Print the target sysroot directory that is used during
6157 compilation. This is the target sysroot specified either at configure
6158 time or using the @option{--sysroot} option, possibly with an extra
6159 suffix that depends on compilation options. If no target sysroot is
6160 specified, the option prints nothing.
6161
6162 @item -print-sysroot-headers-suffix
6163 @opindex print-sysroot-headers-suffix
6164 Print the suffix added to the target sysroot when searching for
6165 headers, or give an error if the compiler is not configured with such
6166 a suffix---and don't do anything else.
6167
6168 @item -dumpmachine
6169 @opindex dumpmachine
6170 Print the compiler's target machine (for example,
6171 @samp{i686-pc-linux-gnu})---and don't do anything else.
6172
6173 @item -dumpversion
6174 @opindex dumpversion
6175 Print the compiler version (for example, @samp{3.0})---and don't do
6176 anything else.
6177
6178 @item -dumpspecs
6179 @opindex dumpspecs
6180 Print the compiler's built-in specs---and don't do anything else. (This
6181 is used when GCC itself is being built.) @xref{Spec Files}.
6182
6183 @item -feliminate-unused-debug-types
6184 @opindex feliminate-unused-debug-types
6185 Normally, when producing DWARF 2 output, GCC emits debugging
6186 information for all types declared in a compilation
6187 unit, regardless of whether or not they are actually used
6188 in that compilation unit. Sometimes this is useful, such as
6189 if, in the debugger, you want to cast a value to a type that is
6190 not actually used in your program (but is declared). More often,
6191 however, this results in a significant amount of wasted space.
6192 With this option, GCC avoids producing debug symbol output
6193 for types that are nowhere used in the source file being compiled.
6194 @end table
6195
6196 @node Optimize Options
6197 @section Options That Control Optimization
6198 @cindex optimize options
6199 @cindex options, optimization
6200
6201 These options control various sorts of optimizations.
6202
6203 Without any optimization option, the compiler's goal is to reduce the
6204 cost of compilation and to make debugging produce the expected
6205 results. Statements are independent: if you stop the program with a
6206 breakpoint between statements, you can then assign a new value to any
6207 variable or change the program counter to any other statement in the
6208 function and get exactly the results you expect from the source
6209 code.
6210
6211 Turning on optimization flags makes the compiler attempt to improve
6212 the performance and/or code size at the expense of compilation time
6213 and possibly the ability to debug the program.
6214
6215 The compiler performs optimization based on the knowledge it has of the
6216 program. Compiling multiple files at once to a single output file mode allows
6217 the compiler to use information gained from all of the files when compiling
6218 each of them.
6219
6220 Not all optimizations are controlled directly by a flag. Only
6221 optimizations that have a flag are listed in this section.
6222
6223 Most optimizations are only enabled if an @option{-O} level is set on
6224 the command line. Otherwise they are disabled, even if individual
6225 optimization flags are specified.
6226
6227 Depending on the target and how GCC was configured, a slightly different
6228 set of optimizations may be enabled at each @option{-O} level than
6229 those listed here. You can invoke GCC with @option{-Q --help=optimizers}
6230 to find out the exact set of optimizations that are enabled at each level.
6231 @xref{Overall Options}, for examples.
6232
6233 @table @gcctabopt
6234 @item -O
6235 @itemx -O1
6236 @opindex O
6237 @opindex O1
6238 Optimize. Optimizing compilation takes somewhat more time, and a lot
6239 more memory for a large function.
6240
6241 With @option{-O}, the compiler tries to reduce code size and execution
6242 time, without performing any optimizations that take a great deal of
6243 compilation time.
6244
6245 @option{-O} turns on the following optimization flags:
6246 @gccoptlist{
6247 -fauto-inc-dec @gol
6248 -fcompare-elim @gol
6249 -fcprop-registers @gol
6250 -fdce @gol
6251 -fdefer-pop @gol
6252 -fdelayed-branch @gol
6253 -fdse @gol
6254 -fguess-branch-probability @gol
6255 -fif-conversion2 @gol
6256 -fif-conversion @gol
6257 -fipa-pure-const @gol
6258 -fipa-profile @gol
6259 -fipa-reference @gol
6260 -fmerge-constants
6261 -fsplit-wide-types @gol
6262 -ftree-bit-ccp @gol
6263 -ftree-builtin-call-dce @gol
6264 -ftree-ccp @gol
6265 -ftree-ch @gol
6266 -ftree-copyrename @gol
6267 -ftree-dce @gol
6268 -ftree-dominator-opts @gol
6269 -ftree-dse @gol
6270 -ftree-forwprop @gol
6271 -ftree-fre @gol
6272 -ftree-phiprop @gol
6273 -ftree-slsr @gol
6274 -ftree-sra @gol
6275 -ftree-pta @gol
6276 -ftree-ter @gol
6277 -funit-at-a-time}
6278
6279 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6280 where doing so does not interfere with debugging.
6281
6282 @item -O2
6283 @opindex O2
6284 Optimize even more. GCC performs nearly all supported optimizations
6285 that do not involve a space-speed tradeoff.
6286 As compared to @option{-O}, this option increases both compilation time
6287 and the performance of the generated code.
6288
6289 @option{-O2} turns on all optimization flags specified by @option{-O}. It
6290 also turns on the following optimization flags:
6291 @gccoptlist{-fthread-jumps @gol
6292 -falign-functions -falign-jumps @gol
6293 -falign-loops -falign-labels @gol
6294 -fcaller-saves @gol
6295 -fcrossjumping @gol
6296 -fcse-follow-jumps -fcse-skip-blocks @gol
6297 -fdelete-null-pointer-checks @gol
6298 -fdevirtualize @gol
6299 -fexpensive-optimizations @gol
6300 -fgcse -fgcse-lm @gol
6301 -fhoist-adjacent-loads @gol
6302 -finline-small-functions @gol
6303 -findirect-inlining @gol
6304 -fipa-sra @gol
6305 -foptimize-sibling-calls @gol
6306 -fpartial-inlining @gol
6307 -fpeephole2 @gol
6308 -fregmove @gol
6309 -freorder-blocks -freorder-functions @gol
6310 -frerun-cse-after-loop @gol
6311 -fsched-interblock -fsched-spec @gol
6312 -fschedule-insns -fschedule-insns2 @gol
6313 -fstrict-aliasing -fstrict-overflow @gol
6314 -ftree-switch-conversion -ftree-tail-merge @gol
6315 -ftree-pre @gol
6316 -ftree-vrp}
6317
6318 Please note the warning under @option{-fgcse} about
6319 invoking @option{-O2} on programs that use computed gotos.
6320
6321 @item -O3
6322 @opindex O3
6323 Optimize yet more. @option{-O3} turns on all optimizations specified
6324 by @option{-O2} and also turns on the @option{-finline-functions},
6325 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6326 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6327 @option{-fvect-cost-model},
6328 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6329
6330 @item -O0
6331 @opindex O0
6332 Reduce compilation time and make debugging produce the expected
6333 results. This is the default.
6334
6335 @item -Os
6336 @opindex Os
6337 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
6338 do not typically increase code size. It also performs further
6339 optimizations designed to reduce code size.
6340
6341 @option{-Os} disables the following optimization flags:
6342 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
6343 -falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
6344 -fprefetch-loop-arrays -ftree-vect-loop-version}
6345
6346 @item -Ofast
6347 @opindex Ofast
6348 Disregard strict standards compliance. @option{-Ofast} enables all
6349 @option{-O3} optimizations. It also enables optimizations that are not
6350 valid for all standard compliant programs.
6351 It turns on @option{-ffast-math} and the Fortran-specific
6352 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6353
6354 If you use multiple @option{-O} options, with or without level numbers,
6355 the last such option is the one that is effective.
6356 @end table
6357
6358 Options of the form @option{-f@var{flag}} specify machine-independent
6359 flags. Most flags have both positive and negative forms; the negative
6360 form of @option{-ffoo} is @option{-fno-foo}. In the table
6361 below, only one of the forms is listed---the one you typically
6362 use. You can figure out the other form by either removing @samp{no-}
6363 or adding it.
6364
6365 The following options control specific optimizations. They are either
6366 activated by @option{-O} options or are related to ones that are. You
6367 can use the following flags in the rare cases when ``fine-tuning'' of
6368 optimizations to be performed is desired.
6369
6370 @table @gcctabopt
6371 @item -fno-default-inline
6372 @opindex fno-default-inline
6373 Do not make member functions inline by default merely because they are
6374 defined inside the class scope (C++ only). Otherwise, when you specify
6375 @w{@option{-O}}, member functions defined inside class scope are compiled
6376 inline by default; i.e., you don't need to add @samp{inline} in front of
6377 the member function name.
6378
6379 @item -fno-defer-pop
6380 @opindex fno-defer-pop
6381 Always pop the arguments to each function call as soon as that function
6382 returns. For machines that must pop arguments after a function call,
6383 the compiler normally lets arguments accumulate on the stack for several
6384 function calls and pops them all at once.
6385
6386 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6387
6388 @item -fforward-propagate
6389 @opindex fforward-propagate
6390 Perform a forward propagation pass on RTL@. The pass tries to combine two
6391 instructions and checks if the result can be simplified. If loop unrolling
6392 is active, two passes are performed and the second is scheduled after
6393 loop unrolling.
6394
6395 This option is enabled by default at optimization levels @option{-O},
6396 @option{-O2}, @option{-O3}, @option{-Os}.
6397
6398 @item -ffp-contract=@var{style}
6399 @opindex ffp-contract
6400 @option{-ffp-contract=off} disables floating-point expression contraction.
6401 @option{-ffp-contract=fast} enables floating-point expression contraction
6402 such as forming of fused multiply-add operations if the target has
6403 native support for them.
6404 @option{-ffp-contract=on} enables floating-point expression contraction
6405 if allowed by the language standard. This is currently not implemented
6406 and treated equal to @option{-ffp-contract=off}.
6407
6408 The default is @option{-ffp-contract=fast}.
6409
6410 @item -fomit-frame-pointer
6411 @opindex fomit-frame-pointer
6412 Don't keep the frame pointer in a register for functions that
6413 don't need one. This avoids the instructions to save, set up and
6414 restore frame pointers; it also makes an extra register available
6415 in many functions. @strong{It also makes debugging impossible on
6416 some machines.}
6417
6418 On some machines, such as the VAX, this flag has no effect, because
6419 the standard calling sequence automatically handles the frame pointer
6420 and nothing is saved by pretending it doesn't exist. The
6421 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6422 whether a target machine supports this flag. @xref{Registers,,Register
6423 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6424
6425 Starting with GCC version 4.6, the default setting (when not optimizing for
6426 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6427 @option{-fomit-frame-pointer}. The default can be reverted to
6428 @option{-fno-omit-frame-pointer} by configuring GCC with the
6429 @option{--enable-frame-pointer} configure option.
6430
6431 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6432
6433 @item -foptimize-sibling-calls
6434 @opindex foptimize-sibling-calls
6435 Optimize sibling and tail recursive calls.
6436
6437 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6438
6439 @item -fno-inline
6440 @opindex fno-inline
6441 Do not expand any functions inline apart from those marked with
6442 the @code{always_inline} attribute. This is the default when not
6443 optimizing.
6444
6445 Single functions can be exempted from inlining by marking them
6446 with the @code{noinline} attribute.
6447
6448 @item -finline-small-functions
6449 @opindex finline-small-functions
6450 Integrate functions into their callers when their body is smaller than expected
6451 function call code (so overall size of program gets smaller). The compiler
6452 heuristically decides which functions are simple enough to be worth integrating
6453 in this way. This inlining applies to all functions, even those not declared
6454 inline.
6455
6456 Enabled at level @option{-O2}.
6457
6458 @item -findirect-inlining
6459 @opindex findirect-inlining
6460 Inline also indirect calls that are discovered to be known at compile
6461 time thanks to previous inlining. This option has any effect only
6462 when inlining itself is turned on by the @option{-finline-functions}
6463 or @option{-finline-small-functions} options.
6464
6465 Enabled at level @option{-O2}.
6466
6467 @item -finline-functions
6468 @opindex finline-functions
6469 Consider all functions for inlining, even if they are not declared inline.
6470 The compiler heuristically decides which functions are worth integrating
6471 in this way.
6472
6473 If all calls to a given function are integrated, and the function is
6474 declared @code{static}, then the function is normally not output as
6475 assembler code in its own right.
6476
6477 Enabled at level @option{-O3}.
6478
6479 @item -finline-functions-called-once
6480 @opindex finline-functions-called-once
6481 Consider all @code{static} functions called once for inlining into their
6482 caller even if they are not marked @code{inline}. If a call to a given
6483 function is integrated, then the function is not output as assembler code
6484 in its own right.
6485
6486 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6487
6488 @item -fearly-inlining
6489 @opindex fearly-inlining
6490 Inline functions marked by @code{always_inline} and functions whose body seems
6491 smaller than the function call overhead early before doing
6492 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
6493 makes profiling significantly cheaper and usually inlining faster on programs
6494 having large chains of nested wrapper functions.
6495
6496 Enabled by default.
6497
6498 @item -fipa-sra
6499 @opindex fipa-sra
6500 Perform interprocedural scalar replacement of aggregates, removal of
6501 unused parameters and replacement of parameters passed by reference
6502 by parameters passed by value.
6503
6504 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6505
6506 @item -finline-limit=@var{n}
6507 @opindex finline-limit
6508 By default, GCC limits the size of functions that can be inlined. This flag
6509 allows coarse control of this limit. @var{n} is the size of functions that
6510 can be inlined in number of pseudo instructions.
6511
6512 Inlining is actually controlled by a number of parameters, which may be
6513 specified individually by using @option{--param @var{name}=@var{value}}.
6514 The @option{-finline-limit=@var{n}} option sets some of these parameters
6515 as follows:
6516
6517 @table @gcctabopt
6518 @item max-inline-insns-single
6519 is set to @var{n}/2.
6520 @item max-inline-insns-auto
6521 is set to @var{n}/2.
6522 @end table
6523
6524 See below for a documentation of the individual
6525 parameters controlling inlining and for the defaults of these parameters.
6526
6527 @emph{Note:} there may be no value to @option{-finline-limit} that results
6528 in default behavior.
6529
6530 @emph{Note:} pseudo instruction represents, in this particular context, an
6531 abstract measurement of function's size. In no way does it represent a count
6532 of assembly instructions and as such its exact meaning might change from one
6533 release to an another.
6534
6535 @item -fno-keep-inline-dllexport
6536 @opindex -fno-keep-inline-dllexport
6537 This is a more fine-grained version of @option{-fkeep-inline-functions},
6538 which applies only to functions that are declared using the @code{dllexport}
6539 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6540 Functions}.)
6541
6542 @item -fkeep-inline-functions
6543 @opindex fkeep-inline-functions
6544 In C, emit @code{static} functions that are declared @code{inline}
6545 into the object file, even if the function has been inlined into all
6546 of its callers. This switch does not affect functions using the
6547 @code{extern inline} extension in GNU C90@. In C++, emit any and all
6548 inline functions into the object file.
6549
6550 @item -fkeep-static-consts
6551 @opindex fkeep-static-consts
6552 Emit variables declared @code{static const} when optimization isn't turned
6553 on, even if the variables aren't referenced.
6554
6555 GCC enables this option by default. If you want to force the compiler to
6556 check if a variable is referenced, regardless of whether or not
6557 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6558
6559 @item -fmerge-constants
6560 @opindex fmerge-constants
6561 Attempt to merge identical constants (string constants and floating-point
6562 constants) across compilation units.
6563
6564 This option is the default for optimized compilation if the assembler and
6565 linker support it. Use @option{-fno-merge-constants} to inhibit this
6566 behavior.
6567
6568 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6569
6570 @item -fmerge-all-constants
6571 @opindex fmerge-all-constants
6572 Attempt to merge identical constants and identical variables.
6573
6574 This option implies @option{-fmerge-constants}. In addition to
6575 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6576 arrays or initialized constant variables with integral or floating-point
6577 types. Languages like C or C++ require each variable, including multiple
6578 instances of the same variable in recursive calls, to have distinct locations,
6579 so using this option results in non-conforming
6580 behavior.
6581
6582 @item -fmodulo-sched
6583 @opindex fmodulo-sched
6584 Perform swing modulo scheduling immediately before the first scheduling
6585 pass. This pass looks at innermost loops and reorders their
6586 instructions by overlapping different iterations.
6587
6588 @item -fmodulo-sched-allow-regmoves
6589 @opindex fmodulo-sched-allow-regmoves
6590 Perform more aggressive SMS-based modulo scheduling with register moves
6591 allowed. By setting this flag certain anti-dependences edges are
6592 deleted, which triggers the generation of reg-moves based on the
6593 life-range analysis. This option is effective only with
6594 @option{-fmodulo-sched} enabled.
6595
6596 @item -fno-branch-count-reg
6597 @opindex fno-branch-count-reg
6598 Do not use ``decrement and branch'' instructions on a count register,
6599 but instead generate a sequence of instructions that decrement a
6600 register, compare it against zero, then branch based upon the result.
6601 This option is only meaningful on architectures that support such
6602 instructions, which include x86, PowerPC, IA-64 and S/390.
6603
6604 The default is @option{-fbranch-count-reg}.
6605
6606 @item -fno-function-cse
6607 @opindex fno-function-cse
6608 Do not put function addresses in registers; make each instruction that
6609 calls a constant function contain the function's address explicitly.
6610
6611 This option results in less efficient code, but some strange hacks
6612 that alter the assembler output may be confused by the optimizations
6613 performed when this option is not used.
6614
6615 The default is @option{-ffunction-cse}
6616
6617 @item -fno-zero-initialized-in-bss
6618 @opindex fno-zero-initialized-in-bss
6619 If the target supports a BSS section, GCC by default puts variables that
6620 are initialized to zero into BSS@. This can save space in the resulting
6621 code.
6622
6623 This option turns off this behavior because some programs explicitly
6624 rely on variables going to the data section. E.g., so that the
6625 resulting executable can find the beginning of that section and/or make
6626 assumptions based on that.
6627
6628 The default is @option{-fzero-initialized-in-bss}.
6629
6630 @item -fmudflap -fmudflapth -fmudflapir
6631 @opindex fmudflap
6632 @opindex fmudflapth
6633 @opindex fmudflapir
6634 @cindex bounds checking
6635 @cindex mudflap
6636 For front-ends that support it (C and C++), instrument all risky
6637 pointer/array dereferencing operations, some standard library
6638 string/heap functions, and some other associated constructs with
6639 range/validity tests. Modules so instrumented should be immune to
6640 buffer overflows, invalid heap use, and some other classes of C/C++
6641 programming errors. The instrumentation relies on a separate runtime
6642 library (@file{libmudflap}), which is linked into a program if
6643 @option{-fmudflap} is given at link time. Run-time behavior of the
6644 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6645 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
6646 for its options.
6647
6648 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6649 link if your program is multi-threaded. Use @option{-fmudflapir}, in
6650 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6651 instrumentation should ignore pointer reads. This produces less
6652 instrumentation (and therefore faster execution) and still provides
6653 some protection against outright memory corrupting writes, but allows
6654 erroneously read data to propagate within a program.
6655
6656 @item -fthread-jumps
6657 @opindex fthread-jumps
6658 Perform optimizations where we check to see if a jump branches to a
6659 location where another comparison subsumed by the first is found. If
6660 so, the first branch is redirected to either the destination of the
6661 second branch or a point immediately following it, depending on whether
6662 the condition is known to be true or false.
6663
6664 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6665
6666 @item -fsplit-wide-types
6667 @opindex fsplit-wide-types
6668 When using a type that occupies multiple registers, such as @code{long
6669 long} on a 32-bit system, split the registers apart and allocate them
6670 independently. This normally generates better code for those types,
6671 but may make debugging more difficult.
6672
6673 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6674 @option{-Os}.
6675
6676 @item -fcse-follow-jumps
6677 @opindex fcse-follow-jumps
6678 In common subexpression elimination (CSE), scan through jump instructions
6679 when the target of the jump is not reached by any other path. For
6680 example, when CSE encounters an @code{if} statement with an
6681 @code{else} clause, CSE follows the jump when the condition
6682 tested is false.
6683
6684 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6685
6686 @item -fcse-skip-blocks
6687 @opindex fcse-skip-blocks
6688 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6689 follow jumps that conditionally skip over blocks. When CSE
6690 encounters a simple @code{if} statement with no else clause,
6691 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6692 body of the @code{if}.
6693
6694 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6695
6696 @item -frerun-cse-after-loop
6697 @opindex frerun-cse-after-loop
6698 Re-run common subexpression elimination after loop optimizations are
6699 performed.
6700
6701 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6702
6703 @item -fgcse
6704 @opindex fgcse
6705 Perform a global common subexpression elimination pass.
6706 This pass also performs global constant and copy propagation.
6707
6708 @emph{Note:} When compiling a program using computed gotos, a GCC
6709 extension, you may get better run-time performance if you disable
6710 the global common subexpression elimination pass by adding
6711 @option{-fno-gcse} to the command line.
6712
6713 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6714
6715 @item -fgcse-lm
6716 @opindex fgcse-lm
6717 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6718 attempts to move loads that are only killed by stores into themselves. This
6719 allows a loop containing a load/store sequence to be changed to a load outside
6720 the loop, and a copy/store within the loop.
6721
6722 Enabled by default when @option{-fgcse} is enabled.
6723
6724 @item -fgcse-sm
6725 @opindex fgcse-sm
6726 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6727 global common subexpression elimination. This pass attempts to move
6728 stores out of loops. When used in conjunction with @option{-fgcse-lm},
6729 loops containing a load/store sequence can be changed to a load before
6730 the loop and a store after the loop.
6731
6732 Not enabled at any optimization level.
6733
6734 @item -fgcse-las
6735 @opindex fgcse-las
6736 When @option{-fgcse-las} is enabled, the global common subexpression
6737 elimination pass eliminates redundant loads that come after stores to the
6738 same memory location (both partial and full redundancies).
6739
6740 Not enabled at any optimization level.
6741
6742 @item -fgcse-after-reload
6743 @opindex fgcse-after-reload
6744 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6745 pass is performed after reload. The purpose of this pass is to cleanup
6746 redundant spilling.
6747
6748 @item -funsafe-loop-optimizations
6749 @opindex funsafe-loop-optimizations
6750 If given, the loop optimizer assumes that loop indices do not
6751 overflow, and that the loops with nontrivial exit condition are not
6752 infinite. This enables a wider range of loop optimizations even if
6753 the loop optimizer itself cannot prove that these assumptions are valid.
6754 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6755 if it finds this kind of loop.
6756
6757 @item -fcrossjumping
6758 @opindex fcrossjumping
6759 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
6760 resulting code may or may not perform better than without cross-jumping.
6761
6762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6763
6764 @item -fauto-inc-dec
6765 @opindex fauto-inc-dec
6766 Combine increments or decrements of addresses with memory accesses.
6767 This pass is always skipped on architectures that do not have
6768 instructions to support this. Enabled by default at @option{-O} and
6769 higher on architectures that support this.
6770
6771 @item -fdce
6772 @opindex fdce
6773 Perform dead code elimination (DCE) on RTL@.
6774 Enabled by default at @option{-O} and higher.
6775
6776 @item -fdse
6777 @opindex fdse
6778 Perform dead store elimination (DSE) on RTL@.
6779 Enabled by default at @option{-O} and higher.
6780
6781 @item -fif-conversion
6782 @opindex fif-conversion
6783 Attempt to transform conditional jumps into branch-less equivalents. This
6784 include use of conditional moves, min, max, set flags and abs instructions, and
6785 some tricks doable by standard arithmetics. The use of conditional execution
6786 on chips where it is available is controlled by @code{if-conversion2}.
6787
6788 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6789
6790 @item -fif-conversion2
6791 @opindex fif-conversion2
6792 Use conditional execution (where available) to transform conditional jumps into
6793 branch-less equivalents.
6794
6795 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6796
6797 @item -fdelete-null-pointer-checks
6798 @opindex fdelete-null-pointer-checks
6799 Assume that programs cannot safely dereference null pointers, and that
6800 no code or data element resides there. This enables simple constant
6801 folding optimizations at all optimization levels. In addition, other
6802 optimization passes in GCC use this flag to control global dataflow
6803 analyses that eliminate useless checks for null pointers; these assume
6804 that if a pointer is checked after it has already been dereferenced,
6805 it cannot be null.
6806
6807 Note however that in some environments this assumption is not true.
6808 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6809 for programs that depend on that behavior.
6810
6811 Some targets, especially embedded ones, disable this option at all levels.
6812 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6813 @option{-O2}, @option{-O3}, @option{-Os}. Passes that use the information
6814 are enabled independently at different optimization levels.
6815
6816 @item -fdevirtualize
6817 @opindex fdevirtualize
6818 Attempt to convert calls to virtual functions to direct calls. This
6819 is done both within a procedure and interprocedurally as part of
6820 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6821 propagation (@option{-fipa-cp}).
6822 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6823
6824 @item -fexpensive-optimizations
6825 @opindex fexpensive-optimizations
6826 Perform a number of minor optimizations that are relatively expensive.
6827
6828 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6829
6830 @item -free
6831 @opindex free
6832 Attempt to remove redundant extension instructions. This is especially
6833 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6834 registers after writing to their lower 32-bit half.
6835
6836 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6837
6838 @item -foptimize-register-move
6839 @itemx -fregmove
6840 @opindex foptimize-register-move
6841 @opindex fregmove
6842 Attempt to reassign register numbers in move instructions and as
6843 operands of other simple instructions in order to maximize the amount of
6844 register tying. This is especially helpful on machines with two-operand
6845 instructions.
6846
6847 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6848 optimization.
6849
6850 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6851
6852 @item -fira-algorithm=@var{algorithm}
6853 Use the specified coloring algorithm for the integrated register
6854 allocator. The @var{algorithm} argument can be @samp{priority}, which
6855 specifies Chow's priority coloring, or @samp{CB}, which specifies
6856 Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented
6857 for all architectures, but for those targets that do support it, it is
6858 the default because it generates better code.
6859
6860 @item -fira-region=@var{region}
6861 Use specified regions for the integrated register allocator. The
6862 @var{region} argument should be one of the following:
6863
6864 @table @samp
6865
6866 @item all
6867 Use all loops as register allocation regions.
6868 This can give the best results for machines with a small and/or
6869 irregular register set.
6870
6871 @item mixed
6872 Use all loops except for loops with small register pressure
6873 as the regions. This value usually gives
6874 the best results in most cases and for most architectures,
6875 and is enabled by default when compiling with optimization for speed
6876 (@option{-O}, @option{-O2}, @dots{}).
6877
6878 @item one
6879 Use all functions as a single region.
6880 This typically results in the smallest code size, and is enabled by default for
6881 @option{-Os} or @option{-O0}.
6882
6883 @end table
6884
6885 @item -fira-loop-pressure
6886 @opindex fira-loop-pressure
6887 Use IRA to evaluate register pressure in loops for decisions to move
6888 loop invariants. This option usually results in generation
6889 of faster and smaller code on machines with large register files (>= 32
6890 registers), but it can slow the compiler down.
6891
6892 This option is enabled at level @option{-O3} for some targets.
6893
6894 @item -fno-ira-share-save-slots
6895 @opindex fno-ira-share-save-slots
6896 Disable sharing of stack slots used for saving call-used hard
6897 registers living through a call. Each hard register gets a
6898 separate stack slot, and as a result function stack frames are
6899 larger.
6900
6901 @item -fno-ira-share-spill-slots
6902 @opindex fno-ira-share-spill-slots
6903 Disable sharing of stack slots allocated for pseudo-registers. Each
6904 pseudo-register that does not get a hard register gets a separate
6905 stack slot, and as a result function stack frames are larger.
6906
6907 @item -fira-verbose=@var{n}
6908 @opindex fira-verbose
6909 Control the verbosity of the dump file for the integrated register allocator.
6910 The default value is 5. If the value @var{n} is greater or equal to 10,
6911 the dump output is sent to stderr using the same format as @var{n} minus 10.
6912
6913 @item -fdelayed-branch
6914 @opindex fdelayed-branch
6915 If supported for the target machine, attempt to reorder instructions
6916 to exploit instruction slots available after delayed branch
6917 instructions.
6918
6919 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6920
6921 @item -fschedule-insns
6922 @opindex fschedule-insns
6923 If supported for the target machine, attempt to reorder instructions to
6924 eliminate execution stalls due to required data being unavailable. This
6925 helps machines that have slow floating point or memory load instructions
6926 by allowing other instructions to be issued until the result of the load
6927 or floating-point instruction is required.
6928
6929 Enabled at levels @option{-O2}, @option{-O3}.
6930
6931 @item -fschedule-insns2
6932 @opindex fschedule-insns2
6933 Similar to @option{-fschedule-insns}, but requests an additional pass of
6934 instruction scheduling after register allocation has been done. This is
6935 especially useful on machines with a relatively small number of
6936 registers and where memory load instructions take more than one cycle.
6937
6938 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6939
6940 @item -fno-sched-interblock
6941 @opindex fno-sched-interblock
6942 Don't schedule instructions across basic blocks. This is normally
6943 enabled by default when scheduling before register allocation, i.e.@:
6944 with @option{-fschedule-insns} or at @option{-O2} or higher.
6945
6946 @item -fno-sched-spec
6947 @opindex fno-sched-spec
6948 Don't allow speculative motion of non-load instructions. This is normally
6949 enabled by default when scheduling before register allocation, i.e.@:
6950 with @option{-fschedule-insns} or at @option{-O2} or higher.
6951
6952 @item -fsched-pressure
6953 @opindex fsched-pressure
6954 Enable register pressure sensitive insn scheduling before the register
6955 allocation. This only makes sense when scheduling before register
6956 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6957 @option{-O2} or higher. Usage of this option can improve the
6958 generated code and decrease its size by preventing register pressure
6959 increase above the number of available hard registers and as a
6960 consequence register spills in the register allocation.
6961
6962 @item -fsched-spec-load
6963 @opindex fsched-spec-load
6964 Allow speculative motion of some load instructions. This only makes
6965 sense when scheduling before register allocation, i.e.@: with
6966 @option{-fschedule-insns} or at @option{-O2} or higher.
6967
6968 @item -fsched-spec-load-dangerous
6969 @opindex fsched-spec-load-dangerous
6970 Allow speculative motion of more load instructions. This only makes
6971 sense when scheduling before register allocation, i.e.@: with
6972 @option{-fschedule-insns} or at @option{-O2} or higher.
6973
6974 @item -fsched-stalled-insns
6975 @itemx -fsched-stalled-insns=@var{n}
6976 @opindex fsched-stalled-insns
6977 Define how many insns (if any) can be moved prematurely from the queue
6978 of stalled insns into the ready list during the second scheduling pass.
6979 @option{-fno-sched-stalled-insns} means that no insns are moved
6980 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6981 on how many queued insns can be moved prematurely.
6982 @option{-fsched-stalled-insns} without a value is equivalent to
6983 @option{-fsched-stalled-insns=1}.
6984
6985 @item -fsched-stalled-insns-dep
6986 @itemx -fsched-stalled-insns-dep=@var{n}
6987 @opindex fsched-stalled-insns-dep
6988 Define how many insn groups (cycles) are examined for a dependency
6989 on a stalled insn that is a candidate for premature removal from the queue
6990 of stalled insns. This has an effect only during the second scheduling pass,
6991 and only if @option{-fsched-stalled-insns} is used.
6992 @option{-fno-sched-stalled-insns-dep} is equivalent to
6993 @option{-fsched-stalled-insns-dep=0}.
6994 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6995 @option{-fsched-stalled-insns-dep=1}.
6996
6997 @item -fsched2-use-superblocks
6998 @opindex fsched2-use-superblocks
6999 When scheduling after register allocation, do use superblock scheduling
7000 algorithm. Superblock scheduling allows motion across basic block boundaries
7001 resulting on faster schedules. This option is experimental, as not all machine
7002 descriptions used by GCC model the CPU closely enough to avoid unreliable
7003 results from the algorithm.
7004
7005 This only makes sense when scheduling after register allocation, i.e.@: with
7006 @option{-fschedule-insns2} or at @option{-O2} or higher.
7007
7008 @item -fsched-group-heuristic
7009 @opindex fsched-group-heuristic
7010 Enable the group heuristic in the scheduler. This heuristic favors
7011 the instruction that belongs to a schedule group. This is enabled
7012 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7013 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7014
7015 @item -fsched-critical-path-heuristic
7016 @opindex fsched-critical-path-heuristic
7017 Enable the critical-path heuristic in the scheduler. This heuristic favors
7018 instructions on the critical path. This is enabled by default when
7019 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7020 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7021
7022 @item -fsched-spec-insn-heuristic
7023 @opindex fsched-spec-insn-heuristic
7024 Enable the speculative instruction heuristic in the scheduler. This
7025 heuristic favors speculative instructions with greater dependency weakness.
7026 This is enabled by default when scheduling is enabled, i.e.@:
7027 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7028 or at @option{-O2} or higher.
7029
7030 @item -fsched-rank-heuristic
7031 @opindex fsched-rank-heuristic
7032 Enable the rank heuristic in the scheduler. This heuristic favors
7033 the instruction belonging to a basic block with greater size or frequency.
7034 This is enabled by default when scheduling is enabled, i.e.@:
7035 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7036 at @option{-O2} or higher.
7037
7038 @item -fsched-last-insn-heuristic
7039 @opindex fsched-last-insn-heuristic
7040 Enable the last-instruction heuristic in the scheduler. This heuristic
7041 favors the instruction that is less dependent on the last instruction
7042 scheduled. This is enabled by default when scheduling is enabled,
7043 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7044 at @option{-O2} or higher.
7045
7046 @item -fsched-dep-count-heuristic
7047 @opindex fsched-dep-count-heuristic
7048 Enable the dependent-count heuristic in the scheduler. This heuristic
7049 favors the instruction that has more instructions depending on it.
7050 This is enabled by default when scheduling is enabled, i.e.@:
7051 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7052 at @option{-O2} or higher.
7053
7054 @item -freschedule-modulo-scheduled-loops
7055 @opindex freschedule-modulo-scheduled-loops
7056 The modulo scheduling comes before the traditional scheduling. If a loop
7057 is modulo scheduled you may want to prevent the later scheduling passes
7058 from changing its schedule; use this option to control that.
7059
7060 @item -fselective-scheduling
7061 @opindex fselective-scheduling
7062 Schedule instructions using selective scheduling algorithm. Selective
7063 scheduling runs instead of the first scheduler pass.
7064
7065 @item -fselective-scheduling2
7066 @opindex fselective-scheduling2
7067 Schedule instructions using selective scheduling algorithm. Selective
7068 scheduling runs instead of the second scheduler pass.
7069
7070 @item -fsel-sched-pipelining
7071 @opindex fsel-sched-pipelining
7072 Enable software pipelining of innermost loops during selective scheduling.
7073 This option has no effect until one of @option{-fselective-scheduling} or
7074 @option{-fselective-scheduling2} is turned on.
7075
7076 @item -fsel-sched-pipelining-outer-loops
7077 @opindex fsel-sched-pipelining-outer-loops
7078 When pipelining loops during selective scheduling, also pipeline outer loops.
7079 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
7080
7081 @item -fshrink-wrap
7082 @opindex fshrink-wrap
7083 Emit function prologues only before parts of the function that need it,
7084 rather than at the top of the function. This flag is enabled by default at
7085 @option{-O} and higher.
7086
7087 @item -fcaller-saves
7088 @opindex fcaller-saves
7089 Enable allocation of values to registers that are clobbered by
7090 function calls, by emitting extra instructions to save and restore the
7091 registers around such calls. Such allocation is done only when it
7092 seems to result in better code.
7093
7094 This option is always enabled by default on certain machines, usually
7095 those which have no call-preserved registers to use instead.
7096
7097 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7098
7099 @item -fcombine-stack-adjustments
7100 @opindex fcombine-stack-adjustments
7101 Tracks stack adjustments (pushes and pops) and stack memory references
7102 and then tries to find ways to combine them.
7103
7104 Enabled by default at @option{-O1} and higher.
7105
7106 @item -fconserve-stack
7107 @opindex fconserve-stack
7108 Attempt to minimize stack usage. The compiler attempts to use less
7109 stack space, even if that makes the program slower. This option
7110 implies setting the @option{large-stack-frame} parameter to 100
7111 and the @option{large-stack-frame-growth} parameter to 400.
7112
7113 @item -ftree-reassoc
7114 @opindex ftree-reassoc
7115 Perform reassociation on trees. This flag is enabled by default
7116 at @option{-O} and higher.
7117
7118 @item -ftree-pre
7119 @opindex ftree-pre
7120 Perform partial redundancy elimination (PRE) on trees. This flag is
7121 enabled by default at @option{-O2} and @option{-O3}.
7122
7123 @item -ftree-partial-pre
7124 @opindex ftree-partial-pre
7125 Make partial redundancy elimination (PRE) more aggressive. This flag is
7126 enabled by default at @option{-O3}.
7127
7128 @item -ftree-forwprop
7129 @opindex ftree-forwprop
7130 Perform forward propagation on trees. This flag is enabled by default
7131 at @option{-O} and higher.
7132
7133 @item -ftree-fre
7134 @opindex ftree-fre
7135 Perform full redundancy elimination (FRE) on trees. The difference
7136 between FRE and PRE is that FRE only considers expressions
7137 that are computed on all paths leading to the redundant computation.
7138 This analysis is faster than PRE, though it exposes fewer redundancies.
7139 This flag is enabled by default at @option{-O} and higher.
7140
7141 @item -ftree-phiprop
7142 @opindex ftree-phiprop
7143 Perform hoisting of loads from conditional pointers on trees. This
7144 pass is enabled by default at @option{-O} and higher.
7145
7146 @item -fhoist-adjacent-loads
7147 @opindex hoist-adjacent-loads
7148 Speculatively hoist loads from both branches of an if-then-else if the
7149 loads are from adjacent locations in the same structure and the target
7150 architecture has a conditional move instruction. This flag is enabled
7151 by default at @option{-O2} and higher.
7152
7153 @item -ftree-copy-prop
7154 @opindex ftree-copy-prop
7155 Perform copy propagation on trees. This pass eliminates unnecessary
7156 copy operations. This flag is enabled by default at @option{-O} and
7157 higher.
7158
7159 @item -fipa-pure-const
7160 @opindex fipa-pure-const
7161 Discover which functions are pure or constant.
7162 Enabled by default at @option{-O} and higher.
7163
7164 @item -fipa-reference
7165 @opindex fipa-reference
7166 Discover which static variables do not escape cannot escape the
7167 compilation unit.
7168 Enabled by default at @option{-O} and higher.
7169
7170 @item -fipa-pta
7171 @opindex fipa-pta
7172 Perform interprocedural pointer analysis and interprocedural modification
7173 and reference analysis. This option can cause excessive memory and
7174 compile-time usage on large compilation units. It is not enabled by
7175 default at any optimization level.
7176
7177 @item -fipa-profile
7178 @opindex fipa-profile
7179 Perform interprocedural profile propagation. The functions called only from
7180 cold functions are marked as cold. Also functions executed once (such as
7181 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7182 functions and loop less parts of functions executed once are then optimized for
7183 size.
7184 Enabled by default at @option{-O} and higher.
7185
7186 @item -fipa-cp
7187 @opindex fipa-cp
7188 Perform interprocedural constant propagation.
7189 This optimization analyzes the program to determine when values passed
7190 to functions are constants and then optimizes accordingly.
7191 This optimization can substantially increase performance
7192 if the application has constants passed to functions.
7193 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7194
7195 @item -fipa-cp-clone
7196 @opindex fipa-cp-clone
7197 Perform function cloning to make interprocedural constant propagation stronger.
7198 When enabled, interprocedural constant propagation performs function cloning
7199 when externally visible function can be called with constant arguments.
7200 Because this optimization can create multiple copies of functions,
7201 it may significantly increase code size
7202 (see @option{--param ipcp-unit-growth=@var{value}}).
7203 This flag is enabled by default at @option{-O3}.
7204
7205 @item -ftree-sink
7206 @opindex ftree-sink
7207 Perform forward store motion on trees. This flag is
7208 enabled by default at @option{-O} and higher.
7209
7210 @item -ftree-bit-ccp
7211 @opindex ftree-bit-ccp
7212 Perform sparse conditional bit constant propagation on trees and propagate
7213 pointer alignment information.
7214 This pass only operates on local scalar variables and is enabled by default
7215 at @option{-O} and higher. It requires that @option{-ftree-ccp} is enabled.
7216
7217 @item -ftree-ccp
7218 @opindex ftree-ccp
7219 Perform sparse conditional constant propagation (CCP) on trees. This
7220 pass only operates on local scalar variables and is enabled by default
7221 at @option{-O} and higher.
7222
7223 @item -ftree-switch-conversion
7224 Perform conversion of simple initializations in a switch to
7225 initializations from a scalar array. This flag is enabled by default
7226 at @option{-O2} and higher.
7227
7228 @item -ftree-tail-merge
7229 Look for identical code sequences. When found, replace one with a jump to the
7230 other. This optimization is known as tail merging or cross jumping. This flag
7231 is enabled by default at @option{-O2} and higher. The compilation time
7232 in this pass can
7233 be limited using @option{max-tail-merge-comparisons} parameter and
7234 @option{max-tail-merge-iterations} parameter.
7235
7236 @item -ftree-dce
7237 @opindex ftree-dce
7238 Perform dead code elimination (DCE) on trees. This flag is enabled by
7239 default at @option{-O} and higher.
7240
7241 @item -ftree-builtin-call-dce
7242 @opindex ftree-builtin-call-dce
7243 Perform conditional dead code elimination (DCE) for calls to builtin functions
7244 that may set @code{errno} but are otherwise side-effect free. This flag is
7245 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7246 specified.
7247
7248 @item -ftree-dominator-opts
7249 @opindex ftree-dominator-opts
7250 Perform a variety of simple scalar cleanups (constant/copy
7251 propagation, redundancy elimination, range propagation and expression
7252 simplification) based on a dominator tree traversal. This also
7253 performs jump threading (to reduce jumps to jumps). This flag is
7254 enabled by default at @option{-O} and higher.
7255
7256 @item -ftree-dse
7257 @opindex ftree-dse
7258 Perform dead store elimination (DSE) on trees. A dead store is a store into
7259 a memory location that is later overwritten by another store without
7260 any intervening loads. In this case the earlier store can be deleted. This
7261 flag is enabled by default at @option{-O} and higher.
7262
7263 @item -ftree-ch
7264 @opindex ftree-ch
7265 Perform loop header copying on trees. This is beneficial since it increases
7266 effectiveness of code motion optimizations. It also saves one jump. This flag
7267 is enabled by default at @option{-O} and higher. It is not enabled
7268 for @option{-Os}, since it usually increases code size.
7269
7270 @item -ftree-loop-optimize
7271 @opindex ftree-loop-optimize
7272 Perform loop optimizations on trees. This flag is enabled by default
7273 at @option{-O} and higher.
7274
7275 @item -ftree-loop-linear
7276 @opindex ftree-loop-linear
7277 Perform loop interchange transformations on tree. Same as
7278 @option{-floop-interchange}. To use this code transformation, GCC has
7279 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7280 enable the Graphite loop transformation infrastructure.
7281
7282 @item -floop-interchange
7283 @opindex floop-interchange
7284 Perform loop interchange transformations on loops. Interchanging two
7285 nested loops switches the inner and outer loops. For example, given a
7286 loop like:
7287 @smallexample
7288 DO J = 1, M
7289 DO I = 1, N
7290 A(J, I) = A(J, I) * C
7291 ENDDO
7292 ENDDO
7293 @end smallexample
7294 loop interchange transforms the loop as if it were written:
7295 @smallexample
7296 DO I = 1, N
7297 DO J = 1, M
7298 A(J, I) = A(J, I) * C
7299 ENDDO
7300 ENDDO
7301 @end smallexample
7302 which can be beneficial when @code{N} is larger than the caches,
7303 because in Fortran, the elements of an array are stored in memory
7304 contiguously by column, and the original loop iterates over rows,
7305 potentially creating at each access a cache miss. This optimization
7306 applies to all the languages supported by GCC and is not limited to
7307 Fortran. To use this code transformation, GCC has to be configured
7308 with @option{--with-ppl} and @option{--with-cloog} to enable the
7309 Graphite loop transformation infrastructure.
7310
7311 @item -floop-strip-mine
7312 @opindex floop-strip-mine
7313 Perform loop strip mining transformations on loops. Strip mining
7314 splits a loop into two nested loops. The outer loop has strides
7315 equal to the strip size and the inner loop has strides of the
7316 original loop within a strip. The strip length can be changed
7317 using the @option{loop-block-tile-size} parameter. For example,
7318 given a loop like:
7319 @smallexample
7320 DO I = 1, N
7321 A(I) = A(I) + C
7322 ENDDO
7323 @end smallexample
7324 loop strip mining transforms the loop as if it were written:
7325 @smallexample
7326 DO II = 1, N, 51
7327 DO I = II, min (II + 50, N)
7328 A(I) = A(I) + C
7329 ENDDO
7330 ENDDO
7331 @end smallexample
7332 This optimization applies to all the languages supported by GCC and is
7333 not limited to Fortran. To use this code transformation, GCC has to
7334 be configured with @option{--with-ppl} and @option{--with-cloog} to
7335 enable the Graphite loop transformation infrastructure.
7336
7337 @item -floop-block
7338 @opindex floop-block
7339 Perform loop blocking transformations on loops. Blocking strip mines
7340 each loop in the loop nest such that the memory accesses of the
7341 element loops fit inside caches. The strip length can be changed
7342 using the @option{loop-block-tile-size} parameter. For example, given
7343 a loop like:
7344 @smallexample
7345 DO I = 1, N
7346 DO J = 1, M
7347 A(J, I) = B(I) + C(J)
7348 ENDDO
7349 ENDDO
7350 @end smallexample
7351 loop blocking transforms the loop as if it were written:
7352 @smallexample
7353 DO II = 1, N, 51
7354 DO JJ = 1, M, 51
7355 DO I = II, min (II + 50, N)
7356 DO J = JJ, min (JJ + 50, M)
7357 A(J, I) = B(I) + C(J)
7358 ENDDO
7359 ENDDO
7360 ENDDO
7361 ENDDO
7362 @end smallexample
7363 which can be beneficial when @code{M} is larger than the caches,
7364 because the innermost loop iterates over a smaller amount of data
7365 which can be kept in the caches. This optimization applies to all the
7366 languages supported by GCC and is not limited to Fortran. To use this
7367 code transformation, GCC has to be configured with @option{--with-ppl}
7368 and @option{--with-cloog} to enable the Graphite loop transformation
7369 infrastructure.
7370
7371 @item -fgraphite-identity
7372 @opindex fgraphite-identity
7373 Enable the identity transformation for graphite. For every SCoP we generate
7374 the polyhedral representation and transform it back to gimple. Using
7375 @option{-fgraphite-identity} we can check the costs or benefits of the
7376 GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations
7377 are also performed by the code generator CLooG, like index splitting and
7378 dead code elimination in loops.
7379
7380 @item -floop-nest-optimize
7381 @opindex floop-nest-optimize
7382 Enable the ISL based loop nest optimizer. This is a generic loop nest
7383 optimizer based on the Pluto optimization algorithms. It calculates a loop
7384 structure optimized for data-locality and parallelism. This option
7385 is experimental.
7386
7387 @item -floop-parallelize-all
7388 @opindex floop-parallelize-all
7389 Use the Graphite data dependence analysis to identify loops that can
7390 be parallelized. Parallelize all the loops that can be analyzed to
7391 not contain loop carried dependences without checking that it is
7392 profitable to parallelize the loops.
7393
7394 @item -fcheck-data-deps
7395 @opindex fcheck-data-deps
7396 Compare the results of several data dependence analyzers. This option
7397 is used for debugging the data dependence analyzers.
7398
7399 @item -ftree-loop-if-convert
7400 Attempt to transform conditional jumps in the innermost loops to
7401 branch-less equivalents. The intent is to remove control-flow from
7402 the innermost loops in order to improve the ability of the
7403 vectorization pass to handle these loops. This is enabled by default
7404 if vectorization is enabled.
7405
7406 @item -ftree-loop-if-convert-stores
7407 Attempt to also if-convert conditional jumps containing memory writes.
7408 This transformation can be unsafe for multi-threaded programs as it
7409 transforms conditional memory writes into unconditional memory writes.
7410 For example,
7411 @smallexample
7412 for (i = 0; i < N; i++)
7413 if (cond)
7414 A[i] = expr;
7415 @end smallexample
7416 is transformed to
7417 @smallexample
7418 for (i = 0; i < N; i++)
7419 A[i] = cond ? expr : A[i];
7420 @end smallexample
7421 potentially producing data races.
7422
7423 @item -ftree-loop-distribution
7424 Perform loop distribution. This flag can improve cache performance on
7425 big loop bodies and allow further loop optimizations, like
7426 parallelization or vectorization, to take place. For example, the loop
7427 @smallexample
7428 DO I = 1, N
7429 A(I) = B(I) + C
7430 D(I) = E(I) * F
7431 ENDDO
7432 @end smallexample
7433 is transformed to
7434 @smallexample
7435 DO I = 1, N
7436 A(I) = B(I) + C
7437 ENDDO
7438 DO I = 1, N
7439 D(I) = E(I) * F
7440 ENDDO
7441 @end smallexample
7442
7443 @item -ftree-loop-distribute-patterns
7444 Perform loop distribution of patterns that can be code generated with
7445 calls to a library. This flag is enabled by default at @option{-O3}.
7446
7447 This pass distributes the initialization loops and generates a call to
7448 memset zero. For example, the loop
7449 @smallexample
7450 DO I = 1, N
7451 A(I) = 0
7452 B(I) = A(I) + I
7453 ENDDO
7454 @end smallexample
7455 is transformed to
7456 @smallexample
7457 DO I = 1, N
7458 A(I) = 0
7459 ENDDO
7460 DO I = 1, N
7461 B(I) = A(I) + I
7462 ENDDO
7463 @end smallexample
7464 and the initialization loop is transformed into a call to memset zero.
7465
7466 @item -ftree-loop-im
7467 @opindex ftree-loop-im
7468 Perform loop invariant motion on trees. This pass moves only invariants that
7469 are hard to handle at RTL level (function calls, operations that expand to
7470 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
7471 operands of conditions that are invariant out of the loop, so that we can use
7472 just trivial invariantness analysis in loop unswitching. The pass also includes
7473 store motion.
7474
7475 @item -ftree-loop-ivcanon
7476 @opindex ftree-loop-ivcanon
7477 Create a canonical counter for number of iterations in loops for which
7478 determining number of iterations requires complicated analysis. Later
7479 optimizations then may determine the number easily. Useful especially
7480 in connection with unrolling.
7481
7482 @item -fivopts
7483 @opindex fivopts
7484 Perform induction variable optimizations (strength reduction, induction
7485 variable merging and induction variable elimination) on trees.
7486
7487 @item -ftree-parallelize-loops=n
7488 @opindex ftree-parallelize-loops
7489 Parallelize loops, i.e., split their iteration space to run in n threads.
7490 This is only possible for loops whose iterations are independent
7491 and can be arbitrarily reordered. The optimization is only
7492 profitable on multiprocessor machines, for loops that are CPU-intensive,
7493 rather than constrained e.g.@: by memory bandwidth. This option
7494 implies @option{-pthread}, and thus is only supported on targets
7495 that have support for @option{-pthread}.
7496
7497 @item -ftree-pta
7498 @opindex ftree-pta
7499 Perform function-local points-to analysis on trees. This flag is
7500 enabled by default at @option{-O} and higher.
7501
7502 @item -ftree-sra
7503 @opindex ftree-sra
7504 Perform scalar replacement of aggregates. This pass replaces structure
7505 references with scalars to prevent committing structures to memory too
7506 early. This flag is enabled by default at @option{-O} and higher.
7507
7508 @item -ftree-copyrename
7509 @opindex ftree-copyrename
7510 Perform copy renaming on trees. This pass attempts to rename compiler
7511 temporaries to other variables at copy locations, usually resulting in
7512 variable names which more closely resemble the original variables. This flag
7513 is enabled by default at @option{-O} and higher.
7514
7515 @item -ftree-coalesce-inlined-vars
7516 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7517 combine small user-defined variables too, but only if they were inlined
7518 from other functions. It is a more limited form of
7519 @option{-ftree-coalesce-vars}. This may harm debug information of such
7520 inlined variables, but it will keep variables of the inlined-into
7521 function apart from each other, such that they are more likely to
7522 contain the expected values in a debugging session. This was the
7523 default in GCC versions older than 4.7.
7524
7525 @item -ftree-coalesce-vars
7526 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7527 combine small user-defined variables too, instead of just compiler
7528 temporaries. This may severely limit the ability to debug an optimized
7529 program compiled with @option{-fno-var-tracking-assignments}. In the
7530 negated form, this flag prevents SSA coalescing of user variables,
7531 including inlined ones. This option is enabled by default.
7532
7533 @item -ftree-ter
7534 @opindex ftree-ter
7535 Perform temporary expression replacement during the SSA->normal phase. Single
7536 use/single def temporaries are replaced at their use location with their
7537 defining expression. This results in non-GIMPLE code, but gives the expanders
7538 much more complex trees to work on resulting in better RTL generation. This is
7539 enabled by default at @option{-O} and higher.
7540
7541 @item -ftree-slsr
7542 @opindex ftree-slsr
7543 Perform straight-line strength reduction on trees. This recognizes related
7544 expressions involving multiplications and replaces them by less expensive
7545 calculations when possible. This is enabled by default at @option{-O} and
7546 higher.
7547
7548 @item -ftree-vectorize
7549 @opindex ftree-vectorize
7550 Perform loop vectorization on trees. This flag is enabled by default at
7551 @option{-O3}.
7552
7553 @item -ftree-slp-vectorize
7554 @opindex ftree-slp-vectorize
7555 Perform basic block vectorization on trees. This flag is enabled by default at
7556 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7557
7558 @item -ftree-vect-loop-version
7559 @opindex ftree-vect-loop-version
7560 Perform loop versioning when doing loop vectorization on trees. When a loop
7561 appears to be vectorizable except that data alignment or data dependence cannot
7562 be determined at compile time, then vectorized and non-vectorized versions of
7563 the loop are generated along with run-time checks for alignment or dependence
7564 to control which version is executed. This option is enabled by default
7565 except at level @option{-Os} where it is disabled.
7566
7567 @item -fvect-cost-model
7568 @opindex fvect-cost-model
7569 Enable cost model for vectorization. This option is enabled by default at
7570 @option{-O3}.
7571
7572 @item -ftree-vrp
7573 @opindex ftree-vrp
7574 Perform Value Range Propagation on trees. This is similar to the
7575 constant propagation pass, but instead of values, ranges of values are
7576 propagated. This allows the optimizers to remove unnecessary range
7577 checks like array bound checks and null pointer checks. This is
7578 enabled by default at @option{-O2} and higher. Null pointer check
7579 elimination is only done if @option{-fdelete-null-pointer-checks} is
7580 enabled.
7581
7582 @item -ftracer
7583 @opindex ftracer
7584 Perform tail duplication to enlarge superblock size. This transformation
7585 simplifies the control flow of the function allowing other optimizations to do
7586 better job.
7587
7588 @item -funroll-loops
7589 @opindex funroll-loops
7590 Unroll loops whose number of iterations can be determined at compile
7591 time or upon entry to the loop. @option{-funroll-loops} implies
7592 @option{-frerun-cse-after-loop}. This option makes code larger,
7593 and may or may not make it run faster.
7594
7595 @item -funroll-all-loops
7596 @opindex funroll-all-loops
7597 Unroll all loops, even if their number of iterations is uncertain when
7598 the loop is entered. This usually makes programs run more slowly.
7599 @option{-funroll-all-loops} implies the same options as
7600 @option{-funroll-loops},
7601
7602 @item -fsplit-ivs-in-unroller
7603 @opindex fsplit-ivs-in-unroller
7604 Enables expressing of values of induction variables in later iterations
7605 of the unrolled loop using the value in the first iteration. This breaks
7606 long dependency chains, thus improving efficiency of the scheduling passes.
7607
7608 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7609 same effect. However in cases the loop body is more complicated than
7610 a single basic block, this is not reliable. It also does not work at all
7611 on some of the architectures due to restrictions in the CSE pass.
7612
7613 This optimization is enabled by default.
7614
7615 @item -fvariable-expansion-in-unroller
7616 @opindex fvariable-expansion-in-unroller
7617 With this option, the compiler creates multiple copies of some
7618 local variables when unrolling a loop, which can result in superior code.
7619
7620 @item -fpartial-inlining
7621 @opindex fpartial-inlining
7622 Inline parts of functions. This option has any effect only
7623 when inlining itself is turned on by the @option{-finline-functions}
7624 or @option{-finline-small-functions} options.
7625
7626 Enabled at level @option{-O2}.
7627
7628 @item -fpredictive-commoning
7629 @opindex fpredictive-commoning
7630 Perform predictive commoning optimization, i.e., reusing computations
7631 (especially memory loads and stores) performed in previous
7632 iterations of loops.
7633
7634 This option is enabled at level @option{-O3}.
7635
7636 @item -fprefetch-loop-arrays
7637 @opindex fprefetch-loop-arrays
7638 If supported by the target machine, generate instructions to prefetch
7639 memory to improve the performance of loops that access large arrays.
7640
7641 This option may generate better or worse code; results are highly
7642 dependent on the structure of loops within the source code.
7643
7644 Disabled at level @option{-Os}.
7645
7646 @item -fno-peephole
7647 @itemx -fno-peephole2
7648 @opindex fno-peephole
7649 @opindex fno-peephole2
7650 Disable any machine-specific peephole optimizations. The difference
7651 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7652 are implemented in the compiler; some targets use one, some use the
7653 other, a few use both.
7654
7655 @option{-fpeephole} is enabled by default.
7656 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7657
7658 @item -fno-guess-branch-probability
7659 @opindex fno-guess-branch-probability
7660 Do not guess branch probabilities using heuristics.
7661
7662 GCC uses heuristics to guess branch probabilities if they are
7663 not provided by profiling feedback (@option{-fprofile-arcs}). These
7664 heuristics are based on the control flow graph. If some branch probabilities
7665 are specified by @samp{__builtin_expect}, then the heuristics are
7666 used to guess branch probabilities for the rest of the control flow graph,
7667 taking the @samp{__builtin_expect} info into account. The interactions
7668 between the heuristics and @samp{__builtin_expect} can be complex, and in
7669 some cases, it may be useful to disable the heuristics so that the effects
7670 of @samp{__builtin_expect} are easier to understand.
7671
7672 The default is @option{-fguess-branch-probability} at levels
7673 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7674
7675 @item -freorder-blocks
7676 @opindex freorder-blocks
7677 Reorder basic blocks in the compiled function in order to reduce number of
7678 taken branches and improve code locality.
7679
7680 Enabled at levels @option{-O2}, @option{-O3}.
7681
7682 @item -freorder-blocks-and-partition
7683 @opindex freorder-blocks-and-partition
7684 In addition to reordering basic blocks in the compiled function, in order
7685 to reduce number of taken branches, partitions hot and cold basic blocks
7686 into separate sections of the assembly and .o files, to improve
7687 paging and cache locality performance.
7688
7689 This optimization is automatically turned off in the presence of
7690 exception handling, for linkonce sections, for functions with a user-defined
7691 section attribute and on any architecture that does not support named
7692 sections.
7693
7694 @item -freorder-functions
7695 @opindex freorder-functions
7696 Reorder functions in the object file in order to
7697 improve code locality. This is implemented by using special
7698 subsections @code{.text.hot} for most frequently executed functions and
7699 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
7700 the linker so object file format must support named sections and linker must
7701 place them in a reasonable way.
7702
7703 Also profile feedback must be available in to make this option effective. See
7704 @option{-fprofile-arcs} for details.
7705
7706 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7707
7708 @item -fstrict-aliasing
7709 @opindex fstrict-aliasing
7710 Allow the compiler to assume the strictest aliasing rules applicable to
7711 the language being compiled. For C (and C++), this activates
7712 optimizations based on the type of expressions. In particular, an
7713 object of one type is assumed never to reside at the same address as an
7714 object of a different type, unless the types are almost the same. For
7715 example, an @code{unsigned int} can alias an @code{int}, but not a
7716 @code{void*} or a @code{double}. A character type may alias any other
7717 type.
7718
7719 @anchor{Type-punning}Pay special attention to code like this:
7720 @smallexample
7721 union a_union @{
7722 int i;
7723 double d;
7724 @};
7725
7726 int f() @{
7727 union a_union t;
7728 t.d = 3.0;
7729 return t.i;
7730 @}
7731 @end smallexample
7732 The practice of reading from a different union member than the one most
7733 recently written to (called ``type-punning'') is common. Even with
7734 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7735 is accessed through the union type. So, the code above works as
7736 expected. @xref{Structures unions enumerations and bit-fields
7737 implementation}. However, this code might not:
7738 @smallexample
7739 int f() @{
7740 union a_union t;
7741 int* ip;
7742 t.d = 3.0;
7743 ip = &t.i;
7744 return *ip;
7745 @}
7746 @end smallexample
7747
7748 Similarly, access by taking the address, casting the resulting pointer
7749 and dereferencing the result has undefined behavior, even if the cast
7750 uses a union type, e.g.:
7751 @smallexample
7752 int f() @{
7753 double d = 3.0;
7754 return ((union a_union *) &d)->i;
7755 @}
7756 @end smallexample
7757
7758 The @option{-fstrict-aliasing} option is enabled at levels
7759 @option{-O2}, @option{-O3}, @option{-Os}.
7760
7761 @item -fstrict-overflow
7762 @opindex fstrict-overflow
7763 Allow the compiler to assume strict signed overflow rules, depending
7764 on the language being compiled. For C (and C++) this means that
7765 overflow when doing arithmetic with signed numbers is undefined, which
7766 means that the compiler may assume that it does not happen. This
7767 permits various optimizations. For example, the compiler assumes
7768 that an expression like @code{i + 10 > i} is always true for
7769 signed @code{i}. This assumption is only valid if signed overflow is
7770 undefined, as the expression is false if @code{i + 10} overflows when
7771 using twos complement arithmetic. When this option is in effect any
7772 attempt to determine whether an operation on signed numbers
7773 overflows must be written carefully to not actually involve overflow.
7774
7775 This option also allows the compiler to assume strict pointer
7776 semantics: given a pointer to an object, if adding an offset to that
7777 pointer does not produce a pointer to the same object, the addition is
7778 undefined. This permits the compiler to conclude that @code{p + u >
7779 p} is always true for a pointer @code{p} and unsigned integer
7780 @code{u}. This assumption is only valid because pointer wraparound is
7781 undefined, as the expression is false if @code{p + u} overflows using
7782 twos complement arithmetic.
7783
7784 See also the @option{-fwrapv} option. Using @option{-fwrapv} means
7785 that integer signed overflow is fully defined: it wraps. When
7786 @option{-fwrapv} is used, there is no difference between
7787 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7788 integers. With @option{-fwrapv} certain types of overflow are
7789 permitted. For example, if the compiler gets an overflow when doing
7790 arithmetic on constants, the overflowed value can still be used with
7791 @option{-fwrapv}, but not otherwise.
7792
7793 The @option{-fstrict-overflow} option is enabled at levels
7794 @option{-O2}, @option{-O3}, @option{-Os}.
7795
7796 @item -falign-functions
7797 @itemx -falign-functions=@var{n}
7798 @opindex falign-functions
7799 Align the start of functions to the next power-of-two greater than
7800 @var{n}, skipping up to @var{n} bytes. For instance,
7801 @option{-falign-functions=32} aligns functions to the next 32-byte
7802 boundary, but @option{-falign-functions=24} aligns to the next
7803 32-byte boundary only if this can be done by skipping 23 bytes or less.
7804
7805 @option{-fno-align-functions} and @option{-falign-functions=1} are
7806 equivalent and mean that functions are not aligned.
7807
7808 Some assemblers only support this flag when @var{n} is a power of two;
7809 in that case, it is rounded up.
7810
7811 If @var{n} is not specified or is zero, use a machine-dependent default.
7812
7813 Enabled at levels @option{-O2}, @option{-O3}.
7814
7815 @item -falign-labels
7816 @itemx -falign-labels=@var{n}
7817 @opindex falign-labels
7818 Align all branch targets to a power-of-two boundary, skipping up to
7819 @var{n} bytes like @option{-falign-functions}. This option can easily
7820 make code slower, because it must insert dummy operations for when the
7821 branch target is reached in the usual flow of the code.
7822
7823 @option{-fno-align-labels} and @option{-falign-labels=1} are
7824 equivalent and mean that labels are not aligned.
7825
7826 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7827 are greater than this value, then their values are used instead.
7828
7829 If @var{n} is not specified or is zero, use a machine-dependent default
7830 which is very likely to be @samp{1}, meaning no alignment.
7831
7832 Enabled at levels @option{-O2}, @option{-O3}.
7833
7834 @item -falign-loops
7835 @itemx -falign-loops=@var{n}
7836 @opindex falign-loops
7837 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7838 like @option{-falign-functions}. If the loops are
7839 executed many times, this makes up for any execution of the dummy
7840 operations.
7841
7842 @option{-fno-align-loops} and @option{-falign-loops=1} are
7843 equivalent and mean that loops are not aligned.
7844
7845 If @var{n} is not specified or is zero, use a machine-dependent default.
7846
7847 Enabled at levels @option{-O2}, @option{-O3}.
7848
7849 @item -falign-jumps
7850 @itemx -falign-jumps=@var{n}
7851 @opindex falign-jumps
7852 Align branch targets to a power-of-two boundary, for branch targets
7853 where the targets can only be reached by jumping, skipping up to @var{n}
7854 bytes like @option{-falign-functions}. In this case, no dummy operations
7855 need be executed.
7856
7857 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7858 equivalent and mean that loops are not aligned.
7859
7860 If @var{n} is not specified or is zero, use a machine-dependent default.
7861
7862 Enabled at levels @option{-O2}, @option{-O3}.
7863
7864 @item -funit-at-a-time
7865 @opindex funit-at-a-time
7866 This option is left for compatibility reasons. @option{-funit-at-a-time}
7867 has no effect, while @option{-fno-unit-at-a-time} implies
7868 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7869
7870 Enabled by default.
7871
7872 @item -fno-toplevel-reorder
7873 @opindex fno-toplevel-reorder
7874 Do not reorder top-level functions, variables, and @code{asm}
7875 statements. Output them in the same order that they appear in the
7876 input file. When this option is used, unreferenced static variables
7877 are not removed. This option is intended to support existing code
7878 that relies on a particular ordering. For new code, it is better to
7879 use attributes.
7880
7881 Enabled at level @option{-O0}. When disabled explicitly, it also implies
7882 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7883 targets.
7884
7885 @item -fweb
7886 @opindex fweb
7887 Constructs webs as commonly used for register allocation purposes and assign
7888 each web individual pseudo register. This allows the register allocation pass
7889 to operate on pseudos directly, but also strengthens several other optimization
7890 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
7891 however, make debugging impossible, since variables no longer stay in a
7892 ``home register''.
7893
7894 Enabled by default with @option{-funroll-loops}.
7895
7896 @item -fwhole-program
7897 @opindex fwhole-program
7898 Assume that the current compilation unit represents the whole program being
7899 compiled. All public functions and variables with the exception of @code{main}
7900 and those merged by attribute @code{externally_visible} become static functions
7901 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.
7902 While this option is equivalent to proper use of the @code{static} keyword for
7903 programs consisting of a single file, in combination with option
7904 @option{-flto} this flag can be used to
7905 compile many smaller scale programs since the functions and variables become
7906 local for the whole combined compilation unit, not for the single source file
7907 itself.
7908
7909 This option implies @option{-fwhole-file} for Fortran programs.
7910
7911 @item -flto[=@var{n}]
7912 @opindex flto
7913 This option runs the standard link-time optimizer. When invoked
7914 with source code, it generates GIMPLE (one of GCC's internal
7915 representations) and writes it to special ELF sections in the object
7916 file. When the object files are linked together, all the function
7917 bodies are read from these ELF sections and instantiated as if they
7918 had been part of the same translation unit.
7919
7920 To use the link-time optimizer, @option{-flto} needs to be specified at
7921 compile time and during the final link. For example:
7922
7923 @smallexample
7924 gcc -c -O2 -flto foo.c
7925 gcc -c -O2 -flto bar.c
7926 gcc -o myprog -flto -O2 foo.o bar.o
7927 @end smallexample
7928
7929 The first two invocations to GCC save a bytecode representation
7930 of GIMPLE into special ELF sections inside @file{foo.o} and
7931 @file{bar.o}. The final invocation reads the GIMPLE bytecode from
7932 @file{foo.o} and @file{bar.o}, merges the two files into a single
7933 internal image, and compiles the result as usual. Since both
7934 @file{foo.o} and @file{bar.o} are merged into a single image, this
7935 causes all the interprocedural analyses and optimizations in GCC to
7936 work across the two files as if they were a single one. This means,
7937 for example, that the inliner is able to inline functions in
7938 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7939
7940 Another (simpler) way to enable link-time optimization is:
7941
7942 @smallexample
7943 gcc -o myprog -flto -O2 foo.c bar.c
7944 @end smallexample
7945
7946 The above generates bytecode for @file{foo.c} and @file{bar.c},
7947 merges them together into a single GIMPLE representation and optimizes
7948 them as usual to produce @file{myprog}.
7949
7950 The only important thing to keep in mind is that to enable link-time
7951 optimizations the @option{-flto} flag needs to be passed to both the
7952 compile and the link commands.
7953
7954 To make whole program optimization effective, it is necessary to make
7955 certain whole program assumptions. The compiler needs to know
7956 what functions and variables can be accessed by libraries and runtime
7957 outside of the link-time optimized unit. When supported by the linker,
7958 the linker plugin (see @option{-fuse-linker-plugin}) passes information
7959 to the compiler about used and externally visible symbols. When
7960 the linker plugin is not available, @option{-fwhole-program} should be
7961 used to allow the compiler to make these assumptions, which leads
7962 to more aggressive optimization decisions.
7963
7964 Note that when a file is compiled with @option{-flto}, the generated
7965 object file is larger than a regular object file because it
7966 contains GIMPLE bytecodes and the usual final code. This means that
7967 object files with LTO information can be linked as normal object
7968 files; if @option{-flto} is not passed to the linker, no
7969 interprocedural optimizations are applied.
7970
7971 Additionally, the optimization flags used to compile individual files
7972 are not necessarily related to those used at link time. For instance,
7973
7974 @smallexample
7975 gcc -c -O0 -flto foo.c
7976 gcc -c -O0 -flto bar.c
7977 gcc -o myprog -flto -O3 foo.o bar.o
7978 @end smallexample
7979
7980 This produces individual object files with unoptimized assembler
7981 code, but the resulting binary @file{myprog} is optimized at
7982 @option{-O3}. If, instead, the final binary is generated without
7983 @option{-flto}, then @file{myprog} is not optimized.
7984
7985 When producing the final binary with @option{-flto}, GCC only
7986 applies link-time optimizations to those files that contain bytecode.
7987 Therefore, you can mix and match object files and libraries with
7988 GIMPLE bytecodes and final object code. GCC automatically selects
7989 which files to optimize in LTO mode and which files to link without
7990 further processing.
7991
7992 There are some code generation flags preserved by GCC when
7993 generating bytecodes, as they need to be used during the final link
7994 stage. Currently, the following options are saved into the GIMPLE
7995 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7996 @option{-m} target flags.
7997
7998 At link time, these options are read in and reapplied. Note that the
7999 current implementation makes no attempt to recognize conflicting
8000 values for these options. If different files have conflicting option
8001 values (e.g., one file is compiled with @option{-fPIC} and another
8002 isn't), the compiler simply uses the last value read from the
8003 bytecode files. It is recommended, then, that you compile all the files
8004 participating in the same link with the same options.
8005
8006 If LTO encounters objects with C linkage declared with incompatible
8007 types in separate translation units to be linked together (undefined
8008 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8009 issued. The behavior is still undefined at run time.
8010
8011 Another feature of LTO is that it is possible to apply interprocedural
8012 optimizations on files written in different languages. This requires
8013 support in the language front end. Currently, the C, C++ and
8014 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8015 something like this should work:
8016
8017 @smallexample
8018 gcc -c -flto foo.c
8019 g++ -c -flto bar.cc
8020 gfortran -c -flto baz.f90
8021 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8022 @end smallexample
8023
8024 Notice that the final link is done with @command{g++} to get the C++
8025 runtime libraries and @option{-lgfortran} is added to get the Fortran
8026 runtime libraries. In general, when mixing languages in LTO mode, you
8027 should use the same link command options as when mixing languages in a
8028 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8029 all the compile and link commands.
8030
8031 If object files containing GIMPLE bytecode are stored in a library archive, say
8032 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8033 are using a linker with plugin support. To enable this feature, use
8034 the flag @option{-fuse-linker-plugin} at link time:
8035
8036 @smallexample
8037 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8038 @end smallexample
8039
8040 With the linker plugin enabled, the linker extracts the needed
8041 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8042 to make them part of the aggregated GIMPLE image to be optimized.
8043
8044 If you are not using a linker with plugin support and/or do not
8045 enable the linker plugin, then the objects inside @file{libfoo.a}
8046 are extracted and linked as usual, but they do not participate
8047 in the LTO optimization process.
8048
8049 Link-time optimizations do not require the presence of the whole program to
8050 operate. If the program does not require any symbols to be exported, it is
8051 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8052 the interprocedural optimizers to use more aggressive assumptions which may
8053 lead to improved optimization opportunities.
8054 Use of @option{-fwhole-program} is not needed when linker plugin is
8055 active (see @option{-fuse-linker-plugin}).
8056
8057 The current implementation of LTO makes no
8058 attempt to generate bytecode that is portable between different
8059 types of hosts. The bytecode files are versioned and there is a
8060 strict version check, so bytecode files generated in one version of
8061 GCC will not work with an older/newer version of GCC@.
8062
8063 Link-time optimization does not work well with generation of debugging
8064 information. Combining @option{-flto} with
8065 @option{-g} is currently experimental and expected to produce wrong
8066 results.
8067
8068 If you specify the optional @var{n}, the optimization and code
8069 generation done at link time is executed in parallel using @var{n}
8070 parallel jobs by utilizing an installed @command{make} program. The
8071 environment variable @env{MAKE} may be used to override the program
8072 used. The default value for @var{n} is 1.
8073
8074 You can also specify @option{-flto=jobserver} to use GNU make's
8075 job server mode to determine the number of parallel jobs. This
8076 is useful when the Makefile calling GCC is already executing in parallel.
8077 You must prepend a @samp{+} to the command recipe in the parent Makefile
8078 for this to work. This option likely only works if @env{MAKE} is
8079 GNU make.
8080
8081 This option is disabled by default
8082
8083 @item -flto-partition=@var{alg}
8084 @opindex flto-partition
8085 Specify the partitioning algorithm used by the link-time optimizer.
8086 The value is either @code{1to1} to specify a partitioning mirroring
8087 the original source files or @code{balanced} to specify partitioning
8088 into equally sized chunks (whenever possible). Specifying @code{none}
8089 as an algorithm disables partitioning and streaming completely. The
8090 default value is @code{balanced}.
8091
8092 @item -flto-compression-level=@var{n}
8093 This option specifies the level of compression used for intermediate
8094 language written to LTO object files, and is only meaningful in
8095 conjunction with LTO mode (@option{-flto}). Valid
8096 values are 0 (no compression) to 9 (maximum compression). Values
8097 outside this range are clamped to either 0 or 9. If the option is not
8098 given, a default balanced compression setting is used.
8099
8100 @item -flto-report
8101 Prints a report with internal details on the workings of the link-time
8102 optimizer. The contents of this report vary from version to version.
8103 It is meant to be useful to GCC developers when processing object
8104 files in LTO mode (via @option{-flto}).
8105
8106 Disabled by default.
8107
8108 @item -fuse-linker-plugin
8109 Enables the use of a linker plugin during link-time optimization. This
8110 option relies on plugin support in the linker, which is available in gold
8111 or in GNU ld 2.21 or newer.
8112
8113 This option enables the extraction of object files with GIMPLE bytecode out
8114 of library archives. This improves the quality of optimization by exposing
8115 more code to the link-time optimizer. This information specifies what
8116 symbols can be accessed externally (by non-LTO object or during dynamic
8117 linking). Resulting code quality improvements on binaries (and shared
8118 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8119 See @option{-flto} for a description of the effect of this flag and how to
8120 use it.
8121
8122 This option is enabled by default when LTO support in GCC is enabled
8123 and GCC was configured for use with
8124 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8125
8126 @item -ffat-lto-objects
8127 @opindex ffat-lto-objects
8128 Fat LTO objects are object files that contain both the intermediate language
8129 and the object code. This makes them usable for both LTO linking and normal
8130 linking. This option is effective only when compiling with @option{-flto}
8131 and is ignored at link time.
8132
8133 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8134 requires the complete toolchain to be aware of LTO. It requires a linker with
8135 linker plugin support for basic functionality. Additionally,
8136 @command{nm}, @command{ar} and @command{ranlib}
8137 need to support linker plugins to allow a full-featured build environment
8138 (capable of building static libraries etc).
8139
8140 The default is @option{-ffat-lto-objects} but this default is intended to
8141 change in future releases when linker plugin enabled environments become more
8142 common.
8143
8144 @item -fcompare-elim
8145 @opindex fcompare-elim
8146 After register allocation and post-register allocation instruction splitting,
8147 identify arithmetic instructions that compute processor flags similar to a
8148 comparison operation based on that arithmetic. If possible, eliminate the
8149 explicit comparison operation.
8150
8151 This pass only applies to certain targets that cannot explicitly represent
8152 the comparison operation before register allocation is complete.
8153
8154 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8155
8156 @item -fcprop-registers
8157 @opindex fcprop-registers
8158 After register allocation and post-register allocation instruction splitting,
8159 we perform a copy-propagation pass to try to reduce scheduling dependencies
8160 and occasionally eliminate the copy.
8161
8162 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8163
8164 @item -fprofile-correction
8165 @opindex fprofile-correction
8166 Profiles collected using an instrumented binary for multi-threaded programs may
8167 be inconsistent due to missed counter updates. When this option is specified,
8168 GCC uses heuristics to correct or smooth out such inconsistencies. By
8169 default, GCC emits an error message when an inconsistent profile is detected.
8170
8171 @item -fprofile-dir=@var{path}
8172 @opindex fprofile-dir
8173
8174 Set the directory to search for the profile data files in to @var{path}.
8175 This option affects only the profile data generated by
8176 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8177 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8178 and its related options. Both absolute and relative paths can be used.
8179 By default, GCC uses the current directory as @var{path}, thus the
8180 profile data file appears in the same directory as the object file.
8181
8182 @item -fprofile-generate
8183 @itemx -fprofile-generate=@var{path}
8184 @opindex fprofile-generate
8185
8186 Enable options usually used for instrumenting application to produce
8187 profile useful for later recompilation with profile feedback based
8188 optimization. You must use @option{-fprofile-generate} both when
8189 compiling and when linking your program.
8190
8191 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8192
8193 If @var{path} is specified, GCC looks at the @var{path} to find
8194 the profile feedback data files. See @option{-fprofile-dir}.
8195
8196 @item -fprofile-use
8197 @itemx -fprofile-use=@var{path}
8198 @opindex fprofile-use
8199 Enable profile feedback directed optimizations, and optimizations
8200 generally profitable only with profile feedback available.
8201
8202 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8203 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8204
8205 By default, GCC emits an error message if the feedback profiles do not
8206 match the source code. This error can be turned into a warning by using
8207 @option{-Wcoverage-mismatch}. Note this may result in poorly optimized
8208 code.
8209
8210 If @var{path} is specified, GCC looks at the @var{path} to find
8211 the profile feedback data files. See @option{-fprofile-dir}.
8212 @end table
8213
8214 The following options control compiler behavior regarding floating-point
8215 arithmetic. These options trade off between speed and
8216 correctness. All must be specifically enabled.
8217
8218 @table @gcctabopt
8219 @item -ffloat-store
8220 @opindex ffloat-store
8221 Do not store floating-point variables in registers, and inhibit other
8222 options that might change whether a floating-point value is taken from a
8223 register or memory.
8224
8225 @cindex floating-point precision
8226 This option prevents undesirable excess precision on machines such as
8227 the 68000 where the floating registers (of the 68881) keep more
8228 precision than a @code{double} is supposed to have. Similarly for the
8229 x86 architecture. For most programs, the excess precision does only
8230 good, but a few programs rely on the precise definition of IEEE floating
8231 point. Use @option{-ffloat-store} for such programs, after modifying
8232 them to store all pertinent intermediate computations into variables.
8233
8234 @item -fexcess-precision=@var{style}
8235 @opindex fexcess-precision
8236 This option allows further control over excess precision on machines
8237 where floating-point registers have more precision than the IEEE
8238 @code{float} and @code{double} types and the processor does not
8239 support operations rounding to those types. By default,
8240 @option{-fexcess-precision=fast} is in effect; this means that
8241 operations are carried out in the precision of the registers and that
8242 it is unpredictable when rounding to the types specified in the source
8243 code takes place. When compiling C, if
8244 @option{-fexcess-precision=standard} is specified then excess
8245 precision follows the rules specified in ISO C99; in particular,
8246 both casts and assignments cause values to be rounded to their
8247 semantic types (whereas @option{-ffloat-store} only affects
8248 assignments). This option is enabled by default for C if a strict
8249 conformance option such as @option{-std=c99} is used.
8250
8251 @opindex mfpmath
8252 @option{-fexcess-precision=standard} is not implemented for languages
8253 other than C, and has no effect if
8254 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8255 specified. On the x86, it also has no effect if @option{-mfpmath=sse}
8256 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8257 semantics apply without excess precision, and in the latter, rounding
8258 is unpredictable.
8259
8260 @item -ffast-math
8261 @opindex ffast-math
8262 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8263 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8264 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8265
8266 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8267
8268 This option is not turned on by any @option{-O} option besides
8269 @option{-Ofast} since it can result in incorrect output for programs
8270 that depend on an exact implementation of IEEE or ISO rules/specifications
8271 for math functions. It may, however, yield faster code for programs
8272 that do not require the guarantees of these specifications.
8273
8274 @item -fno-math-errno
8275 @opindex fno-math-errno
8276 Do not set @code{errno} after calling math functions that are executed
8277 with a single instruction, e.g., @code{sqrt}. A program that relies on
8278 IEEE exceptions for math error handling may want to use this flag
8279 for speed while maintaining IEEE arithmetic compatibility.
8280
8281 This option is not turned on by any @option{-O} option since
8282 it can result in incorrect output for programs that depend on
8283 an exact implementation of IEEE or ISO rules/specifications for
8284 math functions. It may, however, yield faster code for programs
8285 that do not require the guarantees of these specifications.
8286
8287 The default is @option{-fmath-errno}.
8288
8289 On Darwin systems, the math library never sets @code{errno}. There is
8290 therefore no reason for the compiler to consider the possibility that
8291 it might, and @option{-fno-math-errno} is the default.
8292
8293 @item -funsafe-math-optimizations
8294 @opindex funsafe-math-optimizations
8295
8296 Allow optimizations for floating-point arithmetic that (a) assume
8297 that arguments and results are valid and (b) may violate IEEE or
8298 ANSI standards. When used at link-time, it may include libraries
8299 or startup files that change the default FPU control word or other
8300 similar optimizations.
8301
8302 This option is not turned on by any @option{-O} option since
8303 it can result in incorrect output for programs that depend on
8304 an exact implementation of IEEE or ISO rules/specifications for
8305 math functions. It may, however, yield faster code for programs
8306 that do not require the guarantees of these specifications.
8307 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8308 @option{-fassociative-math} and @option{-freciprocal-math}.
8309
8310 The default is @option{-fno-unsafe-math-optimizations}.
8311
8312 @item -fassociative-math
8313 @opindex fassociative-math
8314
8315 Allow re-association of operands in series of floating-point operations.
8316 This violates the ISO C and C++ language standard by possibly changing
8317 computation result. NOTE: re-ordering may change the sign of zero as
8318 well as ignore NaNs and inhibit or create underflow or overflow (and
8319 thus cannot be used on code that relies on rounding behavior like
8320 @code{(x + 2**52) - 2**52}. May also reorder floating-point comparisons
8321 and thus may not be used when ordered comparisons are required.
8322 This option requires that both @option{-fno-signed-zeros} and
8323 @option{-fno-trapping-math} be in effect. Moreover, it doesn't make
8324 much sense with @option{-frounding-math}. For Fortran the option
8325 is automatically enabled when both @option{-fno-signed-zeros} and
8326 @option{-fno-trapping-math} are in effect.
8327
8328 The default is @option{-fno-associative-math}.
8329
8330 @item -freciprocal-math
8331 @opindex freciprocal-math
8332
8333 Allow the reciprocal of a value to be used instead of dividing by
8334 the value if this enables optimizations. For example @code{x / y}
8335 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8336 is subject to common subexpression elimination. Note that this loses
8337 precision and increases the number of flops operating on the value.
8338
8339 The default is @option{-fno-reciprocal-math}.
8340
8341 @item -ffinite-math-only
8342 @opindex ffinite-math-only
8343 Allow optimizations for floating-point arithmetic that assume
8344 that arguments and results are not NaNs or +-Infs.
8345
8346 This option is not turned on by any @option{-O} option since
8347 it can result in incorrect output for programs that depend on
8348 an exact implementation of IEEE or ISO rules/specifications for
8349 math functions. It may, however, yield faster code for programs
8350 that do not require the guarantees of these specifications.
8351
8352 The default is @option{-fno-finite-math-only}.
8353
8354 @item -fno-signed-zeros
8355 @opindex fno-signed-zeros
8356 Allow optimizations for floating-point arithmetic that ignore the
8357 signedness of zero. IEEE arithmetic specifies the behavior of
8358 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8359 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8360 This option implies that the sign of a zero result isn't significant.
8361
8362 The default is @option{-fsigned-zeros}.
8363
8364 @item -fno-trapping-math
8365 @opindex fno-trapping-math
8366 Compile code assuming that floating-point operations cannot generate
8367 user-visible traps. These traps include division by zero, overflow,
8368 underflow, inexact result and invalid operation. This option requires
8369 that @option{-fno-signaling-nans} be in effect. Setting this option may
8370 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8371
8372 This option should never be turned on by any @option{-O} option since
8373 it can result in incorrect output for programs that depend on
8374 an exact implementation of IEEE or ISO rules/specifications for
8375 math functions.
8376
8377 The default is @option{-ftrapping-math}.
8378
8379 @item -frounding-math
8380 @opindex frounding-math
8381 Disable transformations and optimizations that assume default floating-point
8382 rounding behavior. This is round-to-zero for all floating point
8383 to integer conversions, and round-to-nearest for all other arithmetic
8384 truncations. This option should be specified for programs that change
8385 the FP rounding mode dynamically, or that may be executed with a
8386 non-default rounding mode. This option disables constant folding of
8387 floating-point expressions at compile time (which may be affected by
8388 rounding mode) and arithmetic transformations that are unsafe in the
8389 presence of sign-dependent rounding modes.
8390
8391 The default is @option{-fno-rounding-math}.
8392
8393 This option is experimental and does not currently guarantee to
8394 disable all GCC optimizations that are affected by rounding mode.
8395 Future versions of GCC may provide finer control of this setting
8396 using C99's @code{FENV_ACCESS} pragma. This command-line option
8397 will be used to specify the default state for @code{FENV_ACCESS}.
8398
8399 @item -fsignaling-nans
8400 @opindex fsignaling-nans
8401 Compile code assuming that IEEE signaling NaNs may generate user-visible
8402 traps during floating-point operations. Setting this option disables
8403 optimizations that may change the number of exceptions visible with
8404 signaling NaNs. This option implies @option{-ftrapping-math}.
8405
8406 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8407 be defined.
8408
8409 The default is @option{-fno-signaling-nans}.
8410
8411 This option is experimental and does not currently guarantee to
8412 disable all GCC optimizations that affect signaling NaN behavior.
8413
8414 @item -fsingle-precision-constant
8415 @opindex fsingle-precision-constant
8416 Treat floating-point constants as single precision instead of
8417 implicitly converting them to double-precision constants.
8418
8419 @item -fcx-limited-range
8420 @opindex fcx-limited-range
8421 When enabled, this option states that a range reduction step is not
8422 needed when performing complex division. Also, there is no checking
8423 whether the result of a complex multiplication or division is @code{NaN
8424 + I*NaN}, with an attempt to rescue the situation in that case. The
8425 default is @option{-fno-cx-limited-range}, but is enabled by
8426 @option{-ffast-math}.
8427
8428 This option controls the default setting of the ISO C99
8429 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
8430 all languages.
8431
8432 @item -fcx-fortran-rules
8433 @opindex fcx-fortran-rules
8434 Complex multiplication and division follow Fortran rules. Range
8435 reduction is done as part of complex division, but there is no checking
8436 whether the result of a complex multiplication or division is @code{NaN
8437 + I*NaN}, with an attempt to rescue the situation in that case.
8438
8439 The default is @option{-fno-cx-fortran-rules}.
8440
8441 @end table
8442
8443 The following options control optimizations that may improve
8444 performance, but are not enabled by any @option{-O} options. This
8445 section includes experimental options that may produce broken code.
8446
8447 @table @gcctabopt
8448 @item -fbranch-probabilities
8449 @opindex fbranch-probabilities
8450 After running a program compiled with @option{-fprofile-arcs}
8451 (@pxref{Debugging Options,, Options for Debugging Your Program or
8452 @command{gcc}}), you can compile it a second time using
8453 @option{-fbranch-probabilities}, to improve optimizations based on
8454 the number of times each branch was taken. When the program
8455 compiled with @option{-fprofile-arcs} exits it saves arc execution
8456 counts to a file called @file{@var{sourcename}.gcda} for each source
8457 file. The information in this data file is very dependent on the
8458 structure of the generated code, so you must use the same source code
8459 and the same optimization options for both compilations.
8460
8461 With @option{-fbranch-probabilities}, GCC puts a
8462 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8463 These can be used to improve optimization. Currently, they are only
8464 used in one place: in @file{reorg.c}, instead of guessing which path a
8465 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8466 exactly determine which path is taken more often.
8467
8468 @item -fprofile-values
8469 @opindex fprofile-values
8470 If combined with @option{-fprofile-arcs}, it adds code so that some
8471 data about values of expressions in the program is gathered.
8472
8473 With @option{-fbranch-probabilities}, it reads back the data gathered
8474 from profiling values of expressions for usage in optimizations.
8475
8476 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8477
8478 @item -fvpt
8479 @opindex fvpt
8480 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8481 a code to gather information about values of expressions.
8482
8483 With @option{-fbranch-probabilities}, it reads back the data gathered
8484 and actually performs the optimizations based on them.
8485 Currently the optimizations include specialization of division operation
8486 using the knowledge about the value of the denominator.
8487
8488 @item -frename-registers
8489 @opindex frename-registers
8490 Attempt to avoid false dependencies in scheduled code by making use
8491 of registers left over after register allocation. This optimization
8492 most benefits processors with lots of registers. Depending on the
8493 debug information format adopted by the target, however, it can
8494 make debugging impossible, since variables no longer stay in
8495 a ``home register''.
8496
8497 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8498
8499 @item -ftracer
8500 @opindex ftracer
8501 Perform tail duplication to enlarge superblock size. This transformation
8502 simplifies the control flow of the function allowing other optimizations to do
8503 better job.
8504
8505 Enabled with @option{-fprofile-use}.
8506
8507 @item -funroll-loops
8508 @opindex funroll-loops
8509 Unroll loops whose number of iterations can be determined at compile time or
8510 upon entry to the loop. @option{-funroll-loops} implies
8511 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8512 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8513 small constant number of iterations). This option makes code larger, and may
8514 or may not make it run faster.
8515
8516 Enabled with @option{-fprofile-use}.
8517
8518 @item -funroll-all-loops
8519 @opindex funroll-all-loops
8520 Unroll all loops, even if their number of iterations is uncertain when
8521 the loop is entered. This usually makes programs run more slowly.
8522 @option{-funroll-all-loops} implies the same options as
8523 @option{-funroll-loops}.
8524
8525 @item -fpeel-loops
8526 @opindex fpeel-loops
8527 Peels loops for which there is enough information that they do not
8528 roll much (from profile feedback). It also turns on complete loop peeling
8529 (i.e.@: complete removal of loops with small constant number of iterations).
8530
8531 Enabled with @option{-fprofile-use}.
8532
8533 @item -fmove-loop-invariants
8534 @opindex fmove-loop-invariants
8535 Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
8536 at level @option{-O1}
8537
8538 @item -funswitch-loops
8539 @opindex funswitch-loops
8540 Move branches with loop invariant conditions out of the loop, with duplicates
8541 of the loop on both branches (modified according to result of the condition).
8542
8543 @item -ffunction-sections
8544 @itemx -fdata-sections
8545 @opindex ffunction-sections
8546 @opindex fdata-sections
8547 Place each function or data item into its own section in the output
8548 file if the target supports arbitrary sections. The name of the
8549 function or the name of the data item determines the section's name
8550 in the output file.
8551
8552 Use these options on systems where the linker can perform optimizations
8553 to improve locality of reference in the instruction space. Most systems
8554 using the ELF object format and SPARC processors running Solaris 2 have
8555 linkers with such optimizations. AIX may have these optimizations in
8556 the future.
8557
8558 Only use these options when there are significant benefits from doing
8559 so. When you specify these options, the assembler and linker
8560 create larger object and executable files and are also slower.
8561 You cannot use @code{gprof} on all systems if you
8562 specify this option, and you may have problems with debugging if
8563 you specify both this option and @option{-g}.
8564
8565 @item -fbranch-target-load-optimize
8566 @opindex fbranch-target-load-optimize
8567 Perform branch target register load optimization before prologue / epilogue
8568 threading.
8569 The use of target registers can typically be exposed only during reload,
8570 thus hoisting loads out of loops and doing inter-block scheduling needs
8571 a separate optimization pass.
8572
8573 @item -fbranch-target-load-optimize2
8574 @opindex fbranch-target-load-optimize2
8575 Perform branch target register load optimization after prologue / epilogue
8576 threading.
8577
8578 @item -fbtr-bb-exclusive
8579 @opindex fbtr-bb-exclusive
8580 When performing branch target register load optimization, don't reuse
8581 branch target registers in within any basic block.
8582
8583 @item -fstack-protector
8584 @opindex fstack-protector
8585 Emit extra code to check for buffer overflows, such as stack smashing
8586 attacks. This is done by adding a guard variable to functions with
8587 vulnerable objects. This includes functions that call @code{alloca}, and
8588 functions with buffers larger than 8 bytes. The guards are initialized
8589 when a function is entered and then checked when the function exits.
8590 If a guard check fails, an error message is printed and the program exits.
8591
8592 @item -fstack-protector-all
8593 @opindex fstack-protector-all
8594 Like @option{-fstack-protector} except that all functions are protected.
8595
8596 @item -fsection-anchors
8597 @opindex fsection-anchors
8598 Try to reduce the number of symbolic address calculations by using
8599 shared ``anchor'' symbols to address nearby objects. This transformation
8600 can help to reduce the number of GOT entries and GOT accesses on some
8601 targets.
8602
8603 For example, the implementation of the following function @code{foo}:
8604
8605 @smallexample
8606 static int a, b, c;
8607 int foo (void) @{ return a + b + c; @}
8608 @end smallexample
8609
8610 @noindent
8611 usually calculates the addresses of all three variables, but if you
8612 compile it with @option{-fsection-anchors}, it accesses the variables
8613 from a common anchor point instead. The effect is similar to the
8614 following pseudocode (which isn't valid C):
8615
8616 @smallexample
8617 int foo (void)
8618 @{
8619 register int *xr = &x;
8620 return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8621 @}
8622 @end smallexample
8623
8624 Not all targets support this option.
8625
8626 @item --param @var{name}=@var{value}
8627 @opindex param
8628 In some places, GCC uses various constants to control the amount of
8629 optimization that is done. For example, GCC does not inline functions
8630 that contain more than a certain number of instructions. You can
8631 control some of these constants on the command line using the
8632 @option{--param} option.
8633
8634 The names of specific parameters, and the meaning of the values, are
8635 tied to the internals of the compiler, and are subject to change
8636 without notice in future releases.
8637
8638 In each case, the @var{value} is an integer. The allowable choices for
8639 @var{name} are given in the following table:
8640
8641 @table @gcctabopt
8642 @item predictable-branch-outcome
8643 When branch is predicted to be taken with probability lower than this threshold
8644 (in percent), then it is considered well predictable. The default is 10.
8645
8646 @item max-crossjump-edges
8647 The maximum number of incoming edges to consider for crossjumping.
8648 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8649 the number of edges incoming to each block. Increasing values mean
8650 more aggressive optimization, making the compilation time increase with
8651 probably small improvement in executable size.
8652
8653 @item min-crossjump-insns
8654 The minimum number of instructions that must be matched at the end
8655 of two blocks before crossjumping is performed on them. This
8656 value is ignored in the case where all instructions in the block being
8657 crossjumped from are matched. The default value is 5.
8658
8659 @item max-grow-copy-bb-insns
8660 The maximum code size expansion factor when copying basic blocks
8661 instead of jumping. The expansion is relative to a jump instruction.
8662 The default value is 8.
8663
8664 @item max-goto-duplication-insns
8665 The maximum number of instructions to duplicate to a block that jumps
8666 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
8667 passes, GCC factors computed gotos early in the compilation process,
8668 and unfactors them as late as possible. Only computed jumps at the
8669 end of a basic blocks with no more than max-goto-duplication-insns are
8670 unfactored. The default value is 8.
8671
8672 @item max-delay-slot-insn-search
8673 The maximum number of instructions to consider when looking for an
8674 instruction to fill a delay slot. If more than this arbitrary number of
8675 instructions are searched, the time savings from filling the delay slot
8676 are minimal, so stop searching. Increasing values mean more
8677 aggressive optimization, making the compilation time increase with probably
8678 small improvement in execution time.
8679
8680 @item max-delay-slot-live-search
8681 When trying to fill delay slots, the maximum number of instructions to
8682 consider when searching for a block with valid live register
8683 information. Increasing this arbitrarily chosen value means more
8684 aggressive optimization, increasing the compilation time. This parameter
8685 should be removed when the delay slot code is rewritten to maintain the
8686 control-flow graph.
8687
8688 @item max-gcse-memory
8689 The approximate maximum amount of memory that can be allocated in
8690 order to perform the global common subexpression elimination
8691 optimization. If more memory than specified is required, the
8692 optimization is not done.
8693
8694 @item max-gcse-insertion-ratio
8695 If the ratio of expression insertions to deletions is larger than this value
8696 for any expression, then RTL PRE inserts or removes the expression and thus
8697 leaves partially redundant computations in the instruction stream. The default value is 20.
8698
8699 @item max-pending-list-length
8700 The maximum number of pending dependencies scheduling allows
8701 before flushing the current state and starting over. Large functions
8702 with few branches or calls can create excessively large lists which
8703 needlessly consume memory and resources.
8704
8705 @item max-modulo-backtrack-attempts
8706 The maximum number of backtrack attempts the scheduler should make
8707 when modulo scheduling a loop. Larger values can exponentially increase
8708 compilation time.
8709
8710 @item max-inline-insns-single
8711 Several parameters control the tree inliner used in GCC@.
8712 This number sets the maximum number of instructions (counted in GCC's
8713 internal representation) in a single function that the tree inliner
8714 considers for inlining. This only affects functions declared
8715 inline and methods implemented in a class declaration (C++).
8716 The default value is 400.
8717
8718 @item max-inline-insns-auto
8719 When you use @option{-finline-functions} (included in @option{-O3}),
8720 a lot of functions that would otherwise not be considered for inlining
8721 by the compiler are investigated. To those functions, a different
8722 (more restrictive) limit compared to functions declared inline can
8723 be applied.
8724 The default value is 40.
8725
8726 @item large-function-insns
8727 The limit specifying really large functions. For functions larger than this
8728 limit after inlining, inlining is constrained by
8729 @option{--param large-function-growth}. This parameter is useful primarily
8730 to avoid extreme compilation time caused by non-linear algorithms used by the
8731 back end.
8732 The default value is 2700.
8733
8734 @item large-function-growth
8735 Specifies maximal growth of large function caused by inlining in percents.
8736 The default value is 100 which limits large function growth to 2.0 times
8737 the original size.
8738
8739 @item large-unit-insns
8740 The limit specifying large translation unit. Growth caused by inlining of
8741 units larger than this limit is limited by @option{--param inline-unit-growth}.
8742 For small units this might be too tight (consider unit consisting of function A
8743 that is inline and B that just calls A three time. If B is small relative to
8744 A, the growth of unit is 300\% and yet such inlining is very sane. For very
8745 large units consisting of small inlineable functions however the overall unit
8746 growth limit is needed to avoid exponential explosion of code size. Thus for
8747 smaller units, the size is increased to @option{--param large-unit-insns}
8748 before applying @option{--param inline-unit-growth}. The default is 10000
8749
8750 @item inline-unit-growth
8751 Specifies maximal overall growth of the compilation unit caused by inlining.
8752 The default value is 30 which limits unit growth to 1.3 times the original
8753 size.
8754
8755 @item ipcp-unit-growth
8756 Specifies maximal overall growth of the compilation unit caused by
8757 interprocedural constant propagation. The default value is 10 which limits
8758 unit growth to 1.1 times the original size.
8759
8760 @item large-stack-frame
8761 The limit specifying large stack frames. While inlining the algorithm is trying
8762 to not grow past this limit too much. Default value is 256 bytes.
8763
8764 @item large-stack-frame-growth
8765 Specifies maximal growth of large stack frames caused by inlining in percents.
8766 The default value is 1000 which limits large stack frame growth to 11 times
8767 the original size.
8768
8769 @item max-inline-insns-recursive
8770 @itemx max-inline-insns-recursive-auto
8771 Specifies maximum number of instructions out-of-line copy of self recursive inline
8772 function can grow into by performing recursive inlining.
8773
8774 For functions declared inline @option{--param max-inline-insns-recursive} is
8775 taken into account. For function not declared inline, recursive inlining
8776 happens only when @option{-finline-functions} (included in @option{-O3}) is
8777 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
8778 default value is 450.
8779
8780 @item max-inline-recursive-depth
8781 @itemx max-inline-recursive-depth-auto
8782 Specifies maximum recursion depth used by the recursive inlining.
8783
8784 For functions declared inline @option{--param max-inline-recursive-depth} is
8785 taken into account. For function not declared inline, recursive inlining
8786 happens only when @option{-finline-functions} (included in @option{-O3}) is
8787 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
8788 default value is 8.
8789
8790 @item min-inline-recursive-probability
8791 Recursive inlining is profitable only for function having deep recursion
8792 in average and can hurt for function having little recursion depth by
8793 increasing the prologue size or complexity of function body to other
8794 optimizers.
8795
8796 When profile feedback is available (see @option{-fprofile-generate}) the actual
8797 recursion depth can be guessed from probability that function will recurse via
8798 given call expression. This parameter limits inlining only to call expression
8799 whose probability exceeds given threshold (in percents). The default value is
8800 10.
8801
8802 @item early-inlining-insns
8803 Specify growth that early inliner can make. In effect it increases amount of
8804 inlining for code having large abstraction penalty. The default value is 10.
8805
8806 @item max-early-inliner-iterations
8807 @itemx max-early-inliner-iterations
8808 Limit of iterations of early inliner. This basically bounds number of nested
8809 indirect calls early inliner can resolve. Deeper chains are still handled by
8810 late inlining.
8811
8812 @item comdat-sharing-probability
8813 @itemx comdat-sharing-probability
8814 Probability (in percent) that C++ inline function with comdat visibility
8815 are shared across multiple compilation units. The default value is 20.
8816
8817 @item min-vect-loop-bound
8818 The minimum number of iterations under which a loop is not vectorized
8819 when @option{-ftree-vectorize} is used. The number of iterations after
8820 vectorization needs to be greater than the value specified by this option
8821 to allow vectorization. The default value is 0.
8822
8823 @item gcse-cost-distance-ratio
8824 Scaling factor in calculation of maximum distance an expression
8825 can be moved by GCSE optimizations. This is currently supported only in the
8826 code hoisting pass. The bigger the ratio, the more aggressive code hoisting
8827 is with simple expressions, i.e., the expressions that have cost
8828 less than @option{gcse-unrestricted-cost}. Specifying 0 disables
8829 hoisting of simple expressions. The default value is 10.
8830
8831 @item gcse-unrestricted-cost
8832 Cost, roughly measured as the cost of a single typical machine
8833 instruction, at which GCSE optimizations do not constrain
8834 the distance an expression can travel. This is currently
8835 supported only in the code hoisting pass. The lesser the cost,
8836 the more aggressive code hoisting is. Specifying 0
8837 allows all expressions to travel unrestricted distances.
8838 The default value is 3.
8839
8840 @item max-hoist-depth
8841 The depth of search in the dominator tree for expressions to hoist.
8842 This is used to avoid quadratic behavior in hoisting algorithm.
8843 The value of 0 does not limit on the search, but may slow down compilation
8844 of huge functions. The default value is 30.
8845
8846 @item max-tail-merge-comparisons
8847 The maximum amount of similar bbs to compare a bb with. This is used to
8848 avoid quadratic behavior in tree tail merging. The default value is 10.
8849
8850 @item max-tail-merge-iterations
8851 The maximum amount of iterations of the pass over the function. This is used to
8852 limit compilation time in tree tail merging. The default value is 2.
8853
8854 @item max-unrolled-insns
8855 The maximum number of instructions that a loop should have if that loop
8856 is unrolled, and if the loop is unrolled, it determines how many times
8857 the loop code is unrolled.
8858
8859 @item max-average-unrolled-insns
8860 The maximum number of instructions biased by probabilities of their execution
8861 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8862 it determines how many times the loop code is unrolled.
8863
8864 @item max-unroll-times
8865 The maximum number of unrollings of a single loop.
8866
8867 @item max-peeled-insns
8868 The maximum number of instructions that a loop should have if that loop
8869 is peeled, and if the loop is peeled, it determines how many times
8870 the loop code is peeled.
8871
8872 @item max-peel-times
8873 The maximum number of peelings of a single loop.
8874
8875 @item max-completely-peeled-insns
8876 The maximum number of insns of a completely peeled loop.
8877
8878 @item max-completely-peel-times
8879 The maximum number of iterations of a loop to be suitable for complete peeling.
8880
8881 @item max-completely-peel-loop-nest-depth
8882 The maximum depth of a loop nest suitable for complete peeling.
8883
8884 @item max-unswitch-insns
8885 The maximum number of insns of an unswitched loop.
8886
8887 @item max-unswitch-level
8888 The maximum number of branches unswitched in a single loop.
8889
8890 @item lim-expensive
8891 The minimum cost of an expensive expression in the loop invariant motion.
8892
8893 @item iv-consider-all-candidates-bound
8894 Bound on number of candidates for induction variables below that
8895 all candidates are considered for each use in induction variable
8896 optimizations. Only the most relevant candidates are considered
8897 if there are more candidates, to avoid quadratic time complexity.
8898
8899 @item iv-max-considered-uses
8900 The induction variable optimizations give up on loops that contain more
8901 induction variable uses.
8902
8903 @item iv-always-prune-cand-set-bound
8904 If number of candidates in the set is smaller than this value,
8905 we always try to remove unnecessary ivs from the set during its
8906 optimization when a new iv is added to the set.
8907
8908 @item scev-max-expr-size
8909 Bound on size of expressions used in the scalar evolutions analyzer.
8910 Large expressions slow the analyzer.
8911
8912 @item scev-max-expr-complexity
8913 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8914 Complex expressions slow the analyzer.
8915
8916 @item omega-max-vars
8917 The maximum number of variables in an Omega constraint system.
8918 The default value is 128.
8919
8920 @item omega-max-geqs
8921 The maximum number of inequalities in an Omega constraint system.
8922 The default value is 256.
8923
8924 @item omega-max-eqs
8925 The maximum number of equalities in an Omega constraint system.
8926 The default value is 128.
8927
8928 @item omega-max-wild-cards
8929 The maximum number of wildcard variables that the Omega solver is
8930 able to insert. The default value is 18.
8931
8932 @item omega-hash-table-size
8933 The size of the hash table in the Omega solver. The default value is
8934 550.
8935
8936 @item omega-max-keys
8937 The maximal number of keys used by the Omega solver. The default
8938 value is 500.
8939
8940 @item omega-eliminate-redundant-constraints
8941 When set to 1, use expensive methods to eliminate all redundant
8942 constraints. The default value is 0.
8943
8944 @item vect-max-version-for-alignment-checks
8945 The maximum number of run-time checks that can be performed when
8946 doing loop versioning for alignment in the vectorizer. See option
8947 @option{-ftree-vect-loop-version} for more information.
8948
8949 @item vect-max-version-for-alias-checks
8950 The maximum number of run-time checks that can be performed when
8951 doing loop versioning for alias in the vectorizer. See option
8952 @option{-ftree-vect-loop-version} for more information.
8953
8954 @item max-iterations-to-track
8955
8956 The maximum number of iterations of a loop the brute force algorithm
8957 for analysis of # of iterations of the loop tries to evaluate.
8958
8959 @item hot-bb-count-fraction
8960 Select fraction of the maximal count of repetitions of basic block in program
8961 given basic block needs to have to be considered hot.
8962
8963 @item hot-bb-frequency-fraction
8964 Select fraction of the entry block frequency of executions of basic block in
8965 function given basic block needs to have to be considered hot.
8966
8967 @item max-predicted-iterations
8968 The maximum number of loop iterations we predict statically. This is useful
8969 in cases where a function contains a single loop with known bound and
8970 another loop with unknown bound.
8971 The known number of iterations is predicted correctly, while
8972 the unknown number of iterations average to roughly 10. This means that the
8973 loop without bounds appears artificially cold relative to the other one.
8974
8975 @item align-threshold
8976
8977 Select fraction of the maximal frequency of executions of a basic block in
8978 a function to align the basic block.
8979
8980 @item align-loop-iterations
8981
8982 A loop expected to iterate at least the selected number of iterations is
8983 aligned.
8984
8985 @item tracer-dynamic-coverage
8986 @itemx tracer-dynamic-coverage-feedback
8987
8988 This value is used to limit superblock formation once the given percentage of
8989 executed instructions is covered. This limits unnecessary code size
8990 expansion.
8991
8992 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8993 feedback is available. The real profiles (as opposed to statically estimated
8994 ones) are much less balanced allowing the threshold to be larger value.
8995
8996 @item tracer-max-code-growth
8997 Stop tail duplication once code growth has reached given percentage. This is
8998 a rather artificial limit, as most of the duplicates are eliminated later in
8999 cross jumping, so it may be set to much higher values than is the desired code
9000 growth.
9001
9002 @item tracer-min-branch-ratio
9003
9004 Stop reverse growth when the reverse probability of best edge is less than this
9005 threshold (in percent).
9006
9007 @item tracer-min-branch-ratio
9008 @itemx tracer-min-branch-ratio-feedback
9009
9010 Stop forward growth if the best edge has probability lower than this
9011 threshold.
9012
9013 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9014 compilation for profile feedback and one for compilation without. The value
9015 for compilation with profile feedback needs to be more conservative (higher) in
9016 order to make tracer effective.
9017
9018 @item max-cse-path-length
9019
9020 Maximum number of basic blocks on path that cse considers. The default is 10.
9021
9022 @item max-cse-insns
9023 The maximum instructions CSE process before flushing. The default is 1000.
9024
9025 @item ggc-min-expand
9026
9027 GCC uses a garbage collector to manage its own memory allocation. This
9028 parameter specifies the minimum percentage by which the garbage
9029 collector's heap should be allowed to expand between collections.
9030 Tuning this may improve compilation speed; it has no effect on code
9031 generation.
9032
9033 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9034 RAM >= 1GB@. If @code{getrlimit} is available, the notion of ``RAM'' is
9035 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
9036 GCC is not able to calculate RAM on a particular platform, the lower
9037 bound of 30% is used. Setting this parameter and
9038 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9039 every opportunity. This is extremely slow, but can be useful for
9040 debugging.
9041
9042 @item ggc-min-heapsize
9043
9044 Minimum size of the garbage collector's heap before it begins bothering
9045 to collect garbage. The first collection occurs after the heap expands
9046 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
9047 tuning this may improve compilation speed, and has no effect on code
9048 generation.
9049
9050 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9051 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9052 with a lower bound of 4096 (four megabytes) and an upper bound of
9053 131072 (128 megabytes). If GCC is not able to calculate RAM on a
9054 particular platform, the lower bound is used. Setting this parameter
9055 very large effectively disables garbage collection. Setting this
9056 parameter and @option{ggc-min-expand} to zero causes a full collection
9057 to occur at every opportunity.
9058
9059 @item max-reload-search-insns
9060 The maximum number of instruction reload should look backward for equivalent
9061 register. Increasing values mean more aggressive optimization, making the
9062 compilation time increase with probably slightly better performance.
9063 The default value is 100.
9064
9065 @item max-cselib-memory-locations
9066 The maximum number of memory locations cselib should take into account.
9067 Increasing values mean more aggressive optimization, making the compilation time
9068 increase with probably slightly better performance. The default value is 500.
9069
9070 @item reorder-blocks-duplicate
9071 @itemx reorder-blocks-duplicate-feedback
9072
9073 Used by basic block reordering pass to decide whether to use unconditional
9074 branch or duplicate the code on its destination. Code is duplicated when its
9075 estimated size is smaller than this value multiplied by the estimated size of
9076 unconditional jump in the hot spots of the program.
9077
9078 The @option{reorder-block-duplicate-feedback} is used only when profile
9079 feedback is available and may be set to higher values than
9080 @option{reorder-block-duplicate} since information about the hot spots is more
9081 accurate.
9082
9083 @item max-sched-ready-insns
9084 The maximum number of instructions ready to be issued the scheduler should
9085 consider at any given time during the first scheduling pass. Increasing
9086 values mean more thorough searches, making the compilation time increase
9087 with probably little benefit. The default value is 100.
9088
9089 @item max-sched-region-blocks
9090 The maximum number of blocks in a region to be considered for
9091 interblock scheduling. The default value is 10.
9092
9093 @item max-pipeline-region-blocks
9094 The maximum number of blocks in a region to be considered for
9095 pipelining in the selective scheduler. The default value is 15.
9096
9097 @item max-sched-region-insns
9098 The maximum number of insns in a region to be considered for
9099 interblock scheduling. The default value is 100.
9100
9101 @item max-pipeline-region-insns
9102 The maximum number of insns in a region to be considered for
9103 pipelining in the selective scheduler. The default value is 200.
9104
9105 @item min-spec-prob
9106 The minimum probability (in percents) of reaching a source block
9107 for interblock speculative scheduling. The default value is 40.
9108
9109 @item max-sched-extend-regions-iters
9110 The maximum number of iterations through CFG to extend regions.
9111 A value of 0 (the default) disables region extensions.
9112
9113 @item max-sched-insn-conflict-delay
9114 The maximum conflict delay for an insn to be considered for speculative motion.
9115 The default value is 3.
9116
9117 @item sched-spec-prob-cutoff
9118 The minimal probability of speculation success (in percents), so that
9119 speculative insns are scheduled.
9120 The default value is 40.
9121
9122 @item sched-mem-true-dep-cost
9123 Minimal distance (in CPU cycles) between store and load targeting same
9124 memory locations. The default value is 1.
9125
9126 @item selsched-max-lookahead
9127 The maximum size of the lookahead window of selective scheduling. It is a
9128 depth of search for available instructions.
9129 The default value is 50.
9130
9131 @item selsched-max-sched-times
9132 The maximum number of times that an instruction is scheduled during
9133 selective scheduling. This is the limit on the number of iterations
9134 through which the instruction may be pipelined. The default value is 2.
9135
9136 @item selsched-max-insns-to-rename
9137 The maximum number of best instructions in the ready list that are considered
9138 for renaming in the selective scheduler. The default value is 2.
9139
9140 @item sms-min-sc
9141 The minimum value of stage count that swing modulo scheduler
9142 generates. The default value is 2.
9143
9144 @item max-last-value-rtl
9145 The maximum size measured as number of RTLs that can be recorded in an expression
9146 in combiner for a pseudo register as last known value of that register. The default
9147 is 10000.
9148
9149 @item integer-share-limit
9150 Small integer constants can use a shared data structure, reducing the
9151 compiler's memory usage and increasing its speed. This sets the maximum
9152 value of a shared integer constant. The default value is 256.
9153
9154 @item ssp-buffer-size
9155 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9156 protection when @option{-fstack-protection} is used.
9157
9158 @item max-jump-thread-duplication-stmts
9159 Maximum number of statements allowed in a block that needs to be
9160 duplicated when threading jumps.
9161
9162 @item max-fields-for-field-sensitive
9163 Maximum number of fields in a structure treated in
9164 a field sensitive manner during pointer analysis. The default is zero
9165 for @option{-O0} and @option{-O1},
9166 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9167
9168 @item prefetch-latency
9169 Estimate on average number of instructions that are executed before
9170 prefetch finishes. The distance we prefetch ahead is proportional
9171 to this constant. Increasing this number may also lead to less
9172 streams being prefetched (see @option{simultaneous-prefetches}).
9173
9174 @item simultaneous-prefetches
9175 Maximum number of prefetches that can run at the same time.
9176
9177 @item l1-cache-line-size
9178 The size of cache line in L1 cache, in bytes.
9179
9180 @item l1-cache-size
9181 The size of L1 cache, in kilobytes.
9182
9183 @item l2-cache-size
9184 The size of L2 cache, in kilobytes.
9185
9186 @item min-insn-to-prefetch-ratio
9187 The minimum ratio between the number of instructions and the
9188 number of prefetches to enable prefetching in a loop.
9189
9190 @item prefetch-min-insn-to-mem-ratio
9191 The minimum ratio between the number of instructions and the
9192 number of memory references to enable prefetching in a loop.
9193
9194 @item use-canonical-types
9195 Whether the compiler should use the ``canonical'' type system. By
9196 default, this should always be 1, which uses a more efficient internal
9197 mechanism for comparing types in C++ and Objective-C++. However, if
9198 bugs in the canonical type system are causing compilation failures,
9199 set this value to 0 to disable canonical types.
9200
9201 @item switch-conversion-max-branch-ratio
9202 Switch initialization conversion refuses to create arrays that are
9203 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9204 branches in the switch.
9205
9206 @item max-partial-antic-length
9207 Maximum length of the partial antic set computed during the tree
9208 partial redundancy elimination optimization (@option{-ftree-pre}) when
9209 optimizing at @option{-O3} and above. For some sorts of source code
9210 the enhanced partial redundancy elimination optimization can run away,
9211 consuming all of the memory available on the host machine. This
9212 parameter sets a limit on the length of the sets that are computed,
9213 which prevents the runaway behavior. Setting a value of 0 for
9214 this parameter allows an unlimited set length.
9215
9216 @item sccvn-max-scc-size
9217 Maximum size of a strongly connected component (SCC) during SCCVN
9218 processing. If this limit is hit, SCCVN processing for the whole
9219 function is not done and optimizations depending on it are
9220 disabled. The default maximum SCC size is 10000.
9221
9222 @item sccvn-max-alias-queries-per-access
9223 Maximum number of alias-oracle queries we perform when looking for
9224 redundancies for loads and stores. If this limit is hit the search
9225 is aborted and the load or store is not considered redundant. The
9226 number of queries is algorithmically limited to the number of
9227 stores on all paths from the load to the function entry.
9228 The default maxmimum number of queries is 1000.
9229
9230 @item ira-max-loops-num
9231 IRA uses regional register allocation by default. If a function
9232 contains more loops than the number given by this parameter, only at most
9233 the given number of the most frequently-executed loops form regions
9234 for regional register allocation. The default value of the
9235 parameter is 100.
9236
9237 @item ira-max-conflict-table-size
9238 Although IRA uses a sophisticated algorithm to compress the conflict
9239 table, the table can still require excessive amounts of memory for
9240 huge functions. If the conflict table for a function could be more
9241 than the size in MB given by this parameter, the register allocator
9242 instead uses a faster, simpler, and lower-quality
9243 algorithm that does not require building a pseudo-register conflict table.
9244 The default value of the parameter is 2000.
9245
9246 @item ira-loop-reserved-regs
9247 IRA can be used to evaluate more accurate register pressure in loops
9248 for decisions to move loop invariants (see @option{-O3}). The number
9249 of available registers reserved for some other purposes is given
9250 by this parameter. The default value of the parameter is 2, which is
9251 the minimal number of registers needed by typical instructions.
9252 This value is the best found from numerous experiments.
9253
9254 @item loop-invariant-max-bbs-in-loop
9255 Loop invariant motion can be very expensive, both in compilation time and
9256 in amount of needed compile-time memory, with very large loops. Loops
9257 with more basic blocks than this parameter won't have loop invariant
9258 motion optimization performed on them. The default value of the
9259 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9260
9261 @item loop-max-datarefs-for-datadeps
9262 Building data dapendencies is expensive for very large loops. This
9263 parameter limits the number of data references in loops that are
9264 considered for data dependence analysis. These large loops are no
9265 handled by the optimizations using loop data dependencies.
9266 The default value is 1000.
9267
9268 @item max-vartrack-size
9269 Sets a maximum number of hash table slots to use during variable
9270 tracking dataflow analysis of any function. If this limit is exceeded
9271 with variable tracking at assignments enabled, analysis for that
9272 function is retried without it, after removing all debug insns from
9273 the function. If the limit is exceeded even without debug insns, var
9274 tracking analysis is completely disabled for the function. Setting
9275 the parameter to zero makes it unlimited.
9276
9277 @item max-vartrack-expr-depth
9278 Sets a maximum number of recursion levels when attempting to map
9279 variable names or debug temporaries to value expressions. This trades
9280 compilation time for more complete debug information. If this is set too
9281 low, value expressions that are available and could be represented in
9282 debug information may end up not being used; setting this higher may
9283 enable the compiler to find more complex debug expressions, but compile
9284 time and memory use may grow. The default is 12.
9285
9286 @item min-nondebug-insn-uid
9287 Use uids starting at this parameter for nondebug insns. The range below
9288 the parameter is reserved exclusively for debug insns created by
9289 @option{-fvar-tracking-assignments}, but debug insns may get
9290 (non-overlapping) uids above it if the reserved range is exhausted.
9291
9292 @item ipa-sra-ptr-growth-factor
9293 IPA-SRA replaces a pointer to an aggregate with one or more new
9294 parameters only when their cumulative size is less or equal to
9295 @option{ipa-sra-ptr-growth-factor} times the size of the original
9296 pointer parameter.
9297
9298 @item tm-max-aggregate-size
9299 When making copies of thread-local variables in a transaction, this
9300 parameter specifies the size in bytes after which variables are
9301 saved with the logging functions as opposed to save/restore code
9302 sequence pairs. This option only applies when using
9303 @option{-fgnu-tm}.
9304
9305 @item graphite-max-nb-scop-params
9306 To avoid exponential effects in the Graphite loop transforms, the
9307 number of parameters in a Static Control Part (SCoP) is bounded. The
9308 default value is 10 parameters. A variable whose value is unknown at
9309 compilation time and defined outside a SCoP is a parameter of the SCoP.
9310
9311 @item graphite-max-bbs-per-function
9312 To avoid exponential effects in the detection of SCoPs, the size of
9313 the functions analyzed by Graphite is bounded. The default value is
9314 100 basic blocks.
9315
9316 @item loop-block-tile-size
9317 Loop blocking or strip mining transforms, enabled with
9318 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9319 loop in the loop nest by a given number of iterations. The strip
9320 length can be changed using the @option{loop-block-tile-size}
9321 parameter. The default value is 51 iterations.
9322
9323 @item ipa-cp-value-list-size
9324 IPA-CP attempts to track all possible values and types passed to a function's
9325 parameter in order to propagate them and perform devirtualization.
9326 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9327 stores per one formal parameter of a function.
9328
9329 @item lto-partitions
9330 Specify desired number of partitions produced during WHOPR compilation.
9331 The number of partitions should exceed the number of CPUs used for compilation.
9332 The default value is 32.
9333
9334 @item lto-minpartition
9335 Size of minimal partition for WHOPR (in estimated instructions).
9336 This prevents expenses of splitting very small programs into too many
9337 partitions.
9338
9339 @item cxx-max-namespaces-for-diagnostic-help
9340 The maximum number of namespaces to consult for suggestions when C++
9341 name lookup fails for an identifier. The default is 1000.
9342
9343 @item sink-frequency-threshold
9344 The maximum relative execution frequency (in percents) of the target block
9345 relative to a statement's original block to allow statement sinking of a
9346 statement. Larger numbers result in more aggressive statement sinking.
9347 The default value is 75. A small positive adjustment is applied for
9348 statements with memory operands as those are even more profitable so sink.
9349
9350 @item max-stores-to-sink
9351 The maximum number of conditional stores paires that can be sunk. Set to 0
9352 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9353 (@option{-ftree-loop-if-convert}) is disabled. The default is 2.
9354
9355 @item allow-load-data-races
9356 Allow optimizers to introduce new data races on loads.
9357 Set to 1 to allow, otherwise to 0. This option is enabled by default
9358 unless implicitly set by the @option{-fmemory-model=} option.
9359
9360 @item allow-store-data-races
9361 Allow optimizers to introduce new data races on stores.
9362 Set to 1 to allow, otherwise to 0. This option is enabled by default
9363 unless implicitly set by the @option{-fmemory-model=} option.
9364
9365 @item allow-packed-load-data-races
9366 Allow optimizers to introduce new data races on packed data loads.
9367 Set to 1 to allow, otherwise to 0. This option is enabled by default
9368 unless implicitly set by the @option{-fmemory-model=} option.
9369
9370 @item allow-packed-store-data-races
9371 Allow optimizers to introduce new data races on packed data stores.
9372 Set to 1 to allow, otherwise to 0. This option is enabled by default
9373 unless implicitly set by the @option{-fmemory-model=} option.
9374
9375 @item case-values-threshold
9376 The smallest number of different values for which it is best to use a
9377 jump-table instead of a tree of conditional branches. If the value is
9378 0, use the default for the machine. The default is 0.
9379
9380 @item tree-reassoc-width
9381 Set the maximum number of instructions executed in parallel in
9382 reassociated tree. This parameter overrides target dependent
9383 heuristics used by default if has non zero value.
9384
9385 @item sched-pressure-algorithm
9386 Choose between the two available implementations of
9387 @option{-fsched-pressure}. Algorithm 1 is the original implementation
9388 and is the more likely to prevent instructions from being reordered.
9389 Algorithm 2 was designed to be a compromise between the relatively
9390 conservative approach taken by algorithm 1 and the rather aggressive
9391 approach taken by the default scheduler. It relies more heavily on
9392 having a regular register file and accurate register pressure classes.
9393 See @file{haifa-sched.c} in the GCC sources for more details.
9394
9395 The default choice depends on the target.
9396 @end table
9397 @end table
9398
9399 @node Preprocessor Options
9400 @section Options Controlling the Preprocessor
9401 @cindex preprocessor options
9402 @cindex options, preprocessor
9403
9404 These options control the C preprocessor, which is run on each C source
9405 file before actual compilation.
9406
9407 If you use the @option{-E} option, nothing is done except preprocessing.
9408 Some of these options make sense only together with @option{-E} because
9409 they cause the preprocessor output to be unsuitable for actual
9410 compilation.
9411
9412 @table @gcctabopt
9413 @item -Wp,@var{option}
9414 @opindex Wp
9415 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9416 and pass @var{option} directly through to the preprocessor. If
9417 @var{option} contains commas, it is split into multiple options at the
9418 commas. However, many options are modified, translated or interpreted
9419 by the compiler driver before being passed to the preprocessor, and
9420 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
9421 interface is undocumented and subject to change, so whenever possible
9422 you should avoid using @option{-Wp} and let the driver handle the
9423 options instead.
9424
9425 @item -Xpreprocessor @var{option}
9426 @opindex Xpreprocessor
9427 Pass @var{option} as an option to the preprocessor. You can use this to
9428 supply system-specific preprocessor options that GCC does not know how to
9429 recognize.
9430
9431 If you want to pass an option that takes an argument, you must use
9432 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9433
9434 @item -no-integrated-cpp
9435 @opindex no-integrated-cpp
9436 Perform preprocessing as a separate pass before compilation.
9437 By default, GCC performs preprocessing as an integrated part of
9438 input tokenization and parsing.
9439 If this option is provided, the appropriate language front end
9440 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9441 and Objective-C, respectively) is instead invoked twice,
9442 once for preprocessing only and once for actual compilation
9443 of the preprocessed input.
9444 This option may be useful in conjunction with the @option{-B} or
9445 @option{-wrapper} options to specify an alternate preprocessor or
9446 perform additional processing of the program source between
9447 normal preprocessing and compilation.
9448 @end table
9449
9450 @include cppopts.texi
9451
9452 @node Assembler Options
9453 @section Passing Options to the Assembler
9454
9455 @c prevent bad page break with this line
9456 You can pass options to the assembler.
9457
9458 @table @gcctabopt
9459 @item -Wa,@var{option}
9460 @opindex Wa
9461 Pass @var{option} as an option to the assembler. If @var{option}
9462 contains commas, it is split into multiple options at the commas.
9463
9464 @item -Xassembler @var{option}
9465 @opindex Xassembler
9466 Pass @var{option} as an option to the assembler. You can use this to
9467 supply system-specific assembler options that GCC does not know how to
9468 recognize.
9469
9470 If you want to pass an option that takes an argument, you must use
9471 @option{-Xassembler} twice, once for the option and once for the argument.
9472
9473 @end table
9474
9475 @node Link Options
9476 @section Options for Linking
9477 @cindex link options
9478 @cindex options, linking
9479
9480 These options come into play when the compiler links object files into
9481 an executable output file. They are meaningless if the compiler is
9482 not doing a link step.
9483
9484 @table @gcctabopt
9485 @cindex file names
9486 @item @var{object-file-name}
9487 A file name that does not end in a special recognized suffix is
9488 considered to name an object file or library. (Object files are
9489 distinguished from libraries by the linker according to the file
9490 contents.) If linking is done, these object files are used as input
9491 to the linker.
9492
9493 @item -c
9494 @itemx -S
9495 @itemx -E
9496 @opindex c
9497 @opindex S
9498 @opindex E
9499 If any of these options is used, then the linker is not run, and
9500 object file names should not be used as arguments. @xref{Overall
9501 Options}.
9502
9503 @cindex Libraries
9504 @item -l@var{library}
9505 @itemx -l @var{library}
9506 @opindex l
9507 Search the library named @var{library} when linking. (The second
9508 alternative with the library as a separate argument is only for
9509 POSIX compliance and is not recommended.)
9510
9511 It makes a difference where in the command you write this option; the
9512 linker searches and processes libraries and object files in the order they
9513 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9514 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
9515 to functions in @samp{z}, those functions may not be loaded.
9516
9517 The linker searches a standard list of directories for the library,
9518 which is actually a file named @file{lib@var{library}.a}. The linker
9519 then uses this file as if it had been specified precisely by name.
9520
9521 The directories searched include several standard system directories
9522 plus any that you specify with @option{-L}.
9523
9524 Normally the files found this way are library files---archive files
9525 whose members are object files. The linker handles an archive file by
9526 scanning through it for members which define symbols that have so far
9527 been referenced but not defined. But if the file that is found is an
9528 ordinary object file, it is linked in the usual fashion. The only
9529 difference between using an @option{-l} option and specifying a file name
9530 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9531 and searches several directories.
9532
9533 @item -lobjc
9534 @opindex lobjc
9535 You need this special case of the @option{-l} option in order to
9536 link an Objective-C or Objective-C++ program.
9537
9538 @item -nostartfiles
9539 @opindex nostartfiles
9540 Do not use the standard system startup files when linking.
9541 The standard system libraries are used normally, unless @option{-nostdlib}
9542 or @option{-nodefaultlibs} is used.
9543
9544 @item -nodefaultlibs
9545 @opindex nodefaultlibs
9546 Do not use the standard system libraries when linking.
9547 Only the libraries you specify are passed to the linker, and options
9548 specifying linkage of the system libraries, such as @code{-static-libgcc}
9549 or @code{-shared-libgcc}, are ignored.
9550 The standard startup files are used normally, unless @option{-nostartfiles}
9551 is used. The compiler may generate calls to @code{memcmp},
9552 @code{memset}, @code{memcpy} and @code{memmove}.
9553 These entries are usually resolved by entries in
9554 libc. These entry points should be supplied through some other
9555 mechanism when this option is specified.
9556
9557 @item -nostdlib
9558 @opindex nostdlib
9559 Do not use the standard system startup files or libraries when linking.
9560 No startup files and only the libraries you specify are passed to
9561 the linker, and options specifying linkage of the system libraries, such as
9562 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9563
9564 The compiler may generate calls to @code{memcmp}, @code{memset},
9565 @code{memcpy} and @code{memmove}.
9566 These entries are usually resolved by entries in
9567 libc. These entry points should be supplied through some other
9568 mechanism when this option is specified.
9569
9570 @cindex @option{-lgcc}, use with @option{-nostdlib}
9571 @cindex @option{-nostdlib} and unresolved references
9572 @cindex unresolved references and @option{-nostdlib}
9573 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9574 @cindex @option{-nodefaultlibs} and unresolved references
9575 @cindex unresolved references and @option{-nodefaultlibs}
9576 One of the standard libraries bypassed by @option{-nostdlib} and
9577 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9578 which GCC uses to overcome shortcomings of particular machines, or special
9579 needs for some languages.
9580 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9581 Collection (GCC) Internals},
9582 for more discussion of @file{libgcc.a}.)
9583 In most cases, you need @file{libgcc.a} even when you want to avoid
9584 other standard libraries. In other words, when you specify @option{-nostdlib}
9585 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9586 This ensures that you have no unresolved references to internal GCC
9587 library subroutines.
9588 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9589 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9590 GNU Compiler Collection (GCC) Internals}.)
9591
9592 @item -pie
9593 @opindex pie
9594 Produce a position independent executable on targets that support it.
9595 For predictable results, you must also specify the same set of options
9596 used for compilation (@option{-fpie}, @option{-fPIE},
9597 or model suboptions) when you specify this linker option.
9598
9599 @item -rdynamic
9600 @opindex rdynamic
9601 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9602 that support it. This instructs the linker to add all symbols, not
9603 only used ones, to the dynamic symbol table. This option is needed
9604 for some uses of @code{dlopen} or to allow obtaining backtraces
9605 from within a program.
9606
9607 @item -s
9608 @opindex s
9609 Remove all symbol table and relocation information from the executable.
9610
9611 @item -static
9612 @opindex static
9613 On systems that support dynamic linking, this prevents linking with the shared
9614 libraries. On other systems, this option has no effect.
9615
9616 @item -shared
9617 @opindex shared
9618 Produce a shared object which can then be linked with other objects to
9619 form an executable. Not all systems support this option. For predictable
9620 results, you must also specify the same set of options used for compilation
9621 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9622 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9623 needs to build supplementary stub code for constructors to work. On
9624 multi-libbed systems, @samp{gcc -shared} must select the correct support
9625 libraries to link against. Failing to supply the correct flags may lead
9626 to subtle defects. Supplying them in cases where they are not necessary
9627 is innocuous.}
9628
9629 @item -shared-libgcc
9630 @itemx -static-libgcc
9631 @opindex shared-libgcc
9632 @opindex static-libgcc
9633 On systems that provide @file{libgcc} as a shared library, these options
9634 force the use of either the shared or static version respectively.
9635 If no shared version of @file{libgcc} was built when the compiler was
9636 configured, these options have no effect.
9637
9638 There are several situations in which an application should use the
9639 shared @file{libgcc} instead of the static version. The most common
9640 of these is when the application wishes to throw and catch exceptions
9641 across different shared libraries. In that case, each of the libraries
9642 as well as the application itself should use the shared @file{libgcc}.
9643
9644 Therefore, the G++ and GCJ drivers automatically add
9645 @option{-shared-libgcc} whenever you build a shared library or a main
9646 executable, because C++ and Java programs typically use exceptions, so
9647 this is the right thing to do.
9648
9649 If, instead, you use the GCC driver to create shared libraries, you may
9650 find that they are not always linked with the shared @file{libgcc}.
9651 If GCC finds, at its configuration time, that you have a non-GNU linker
9652 or a GNU linker that does not support option @option{--eh-frame-hdr},
9653 it links the shared version of @file{libgcc} into shared libraries
9654 by default. Otherwise, it takes advantage of the linker and optimizes
9655 away the linking with the shared version of @file{libgcc}, linking with
9656 the static version of libgcc by default. This allows exceptions to
9657 propagate through such shared libraries, without incurring relocation
9658 costs at library load time.
9659
9660 However, if a library or main executable is supposed to throw or catch
9661 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9662 for the languages used in the program, or using the option
9663 @option{-shared-libgcc}, such that it is linked with the shared
9664 @file{libgcc}.
9665
9666 @item -static-libstdc++
9667 When the @command{g++} program is used to link a C++ program, it
9668 normally automatically links against @option{libstdc++}. If
9669 @file{libstdc++} is available as a shared library, and the
9670 @option{-static} option is not used, then this links against the
9671 shared version of @file{libstdc++}. That is normally fine. However, it
9672 is sometimes useful to freeze the version of @file{libstdc++} used by
9673 the program without going all the way to a fully static link. The
9674 @option{-static-libstdc++} option directs the @command{g++} driver to
9675 link @file{libstdc++} statically, without necessarily linking other
9676 libraries statically.
9677
9678 @item -symbolic
9679 @opindex symbolic
9680 Bind references to global symbols when building a shared object. Warn
9681 about any unresolved references (unless overridden by the link editor
9682 option @option{-Xlinker -z -Xlinker defs}). Only a few systems support
9683 this option.
9684
9685 @item -T @var{script}
9686 @opindex T
9687 @cindex linker script
9688 Use @var{script} as the linker script. This option is supported by most
9689 systems using the GNU linker. On some targets, such as bare-board
9690 targets without an operating system, the @option{-T} option may be required
9691 when linking to avoid references to undefined symbols.
9692
9693 @item -Xlinker @var{option}
9694 @opindex Xlinker
9695 Pass @var{option} as an option to the linker. You can use this to
9696 supply system-specific linker options that GCC does not recognize.
9697
9698 If you want to pass an option that takes a separate argument, you must use
9699 @option{-Xlinker} twice, once for the option and once for the argument.
9700 For example, to pass @option{-assert definitions}, you must write
9701 @option{-Xlinker -assert -Xlinker definitions}. It does not work to write
9702 @option{-Xlinker "-assert definitions"}, because this passes the entire
9703 string as a single argument, which is not what the linker expects.
9704
9705 When using the GNU linker, it is usually more convenient to pass
9706 arguments to linker options using the @option{@var{option}=@var{value}}
9707 syntax than as separate arguments. For example, you can specify
9708 @option{-Xlinker -Map=output.map} rather than
9709 @option{-Xlinker -Map -Xlinker output.map}. Other linkers may not support
9710 this syntax for command-line options.
9711
9712 @item -Wl,@var{option}
9713 @opindex Wl
9714 Pass @var{option} as an option to the linker. If @var{option} contains
9715 commas, it is split into multiple options at the commas. You can use this
9716 syntax to pass an argument to the option.
9717 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9718 linker. When using the GNU linker, you can also get the same effect with
9719 @option{-Wl,-Map=output.map}.
9720
9721 @item -u @var{symbol}
9722 @opindex u
9723 Pretend the symbol @var{symbol} is undefined, to force linking of
9724 library modules to define it. You can use @option{-u} multiple times with
9725 different symbols to force loading of additional library modules.
9726 @end table
9727
9728 @node Directory Options
9729 @section Options for Directory Search
9730 @cindex directory options
9731 @cindex options, directory search
9732 @cindex search path
9733
9734 These options specify directories to search for header files, for
9735 libraries and for parts of the compiler:
9736
9737 @table @gcctabopt
9738 @item -I@var{dir}
9739 @opindex I
9740 Add the directory @var{dir} to the head of the list of directories to be
9741 searched for header files. This can be used to override a system header
9742 file, substituting your own version, since these directories are
9743 searched before the system header file directories. However, you should
9744 not use this option to add directories that contain vendor-supplied
9745 system header files (use @option{-isystem} for that). If you use more than
9746 one @option{-I} option, the directories are scanned in left-to-right
9747 order; the standard system directories come after.
9748
9749 If a standard system include directory, or a directory specified with
9750 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9751 option is ignored. The directory is still searched but as a
9752 system directory at its normal position in the system include chain.
9753 This is to ensure that GCC's procedure to fix buggy system headers and
9754 the ordering for the @code{include_next} directive are not inadvertently changed.
9755 If you really need to change the search order for system directories,
9756 use the @option{-nostdinc} and/or @option{-isystem} options.
9757
9758 @item -iplugindir=@var{dir}
9759 Set the directory to search for plugins that are passed
9760 by @option{-fplugin=@var{name}} instead of
9761 @option{-fplugin=@var{path}/@var{name}.so}. This option is not meant
9762 to be used by the user, but only passed by the driver.
9763
9764 @item -iquote@var{dir}
9765 @opindex iquote
9766 Add the directory @var{dir} to the head of the list of directories to
9767 be searched for header files only for the case of @samp{#include
9768 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9769 otherwise just like @option{-I}.
9770
9771 @item -L@var{dir}
9772 @opindex L
9773 Add directory @var{dir} to the list of directories to be searched
9774 for @option{-l}.
9775
9776 @item -B@var{prefix}
9777 @opindex B
9778 This option specifies where to find the executables, libraries,
9779 include files, and data files of the compiler itself.
9780
9781 The compiler driver program runs one or more of the subprograms
9782 @command{cpp}, @command{cc1}, @command{as} and @command{ld}. It tries
9783 @var{prefix} as a prefix for each program it tries to run, both with and
9784 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9785
9786 For each subprogram to be run, the compiler driver first tries the
9787 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
9788 is not specified, the driver tries two standard prefixes,
9789 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
9790 those results in a file name that is found, the unmodified program
9791 name is searched for using the directories specified in your
9792 @env{PATH} environment variable.
9793
9794 The compiler checks to see if the path provided by the @option{-B}
9795 refers to a directory, and if necessary it adds a directory
9796 separator character at the end of the path.
9797
9798 @option{-B} prefixes that effectively specify directory names also apply
9799 to libraries in the linker, because the compiler translates these
9800 options into @option{-L} options for the linker. They also apply to
9801 includes files in the preprocessor, because the compiler translates these
9802 options into @option{-isystem} options for the preprocessor. In this case,
9803 the compiler appends @samp{include} to the prefix.
9804
9805 The runtime support file @file{libgcc.a} can also be searched for using
9806 the @option{-B} prefix, if needed. If it is not found there, the two
9807 standard prefixes above are tried, and that is all. The file is left
9808 out of the link if it is not found by those means.
9809
9810 Another way to specify a prefix much like the @option{-B} prefix is to use
9811 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
9812 Variables}.
9813
9814 As a special kludge, if the path provided by @option{-B} is
9815 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9816 9, then it is replaced by @file{[dir/]include}. This is to help
9817 with boot-strapping the compiler.
9818
9819 @item -specs=@var{file}
9820 @opindex specs
9821 Process @var{file} after the compiler reads in the standard @file{specs}
9822 file, in order to override the defaults which the @command{gcc} driver
9823 program uses when determining what switches to pass to @command{cc1},
9824 @command{cc1plus}, @command{as}, @command{ld}, etc. More than one
9825 @option{-specs=@var{file}} can be specified on the command line, and they
9826 are processed in order, from left to right.
9827
9828 @item --sysroot=@var{dir}
9829 @opindex sysroot
9830 Use @var{dir} as the logical root directory for headers and libraries.
9831 For example, if the compiler normally searches for headers in
9832 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
9833 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9834
9835 If you use both this option and the @option{-isysroot} option, then
9836 the @option{--sysroot} option applies to libraries, but the
9837 @option{-isysroot} option applies to header files.
9838
9839 The GNU linker (beginning with version 2.16) has the necessary support
9840 for this option. If your linker does not support this option, the
9841 header file aspect of @option{--sysroot} still works, but the
9842 library aspect does not.
9843
9844 @item -I-
9845 @opindex I-
9846 This option has been deprecated. Please use @option{-iquote} instead for
9847 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9848 Any directories you specify with @option{-I} options before the @option{-I-}
9849 option are searched only for the case of @samp{#include "@var{file}"};
9850 they are not searched for @samp{#include <@var{file}>}.
9851
9852 If additional directories are specified with @option{-I} options after
9853 the @option{-I-}, these directories are searched for all @samp{#include}
9854 directives. (Ordinarily @emph{all} @option{-I} directories are used
9855 this way.)
9856
9857 In addition, the @option{-I-} option inhibits the use of the current
9858 directory (where the current input file came from) as the first search
9859 directory for @samp{#include "@var{file}"}. There is no way to
9860 override this effect of @option{-I-}. With @option{-I.} you can specify
9861 searching the directory that is current when the compiler is
9862 invoked. That is not exactly the same as what the preprocessor does
9863 by default, but it is often satisfactory.
9864
9865 @option{-I-} does not inhibit the use of the standard system directories
9866 for header files. Thus, @option{-I-} and @option{-nostdinc} are
9867 independent.
9868 @end table
9869
9870 @c man end
9871
9872 @node Spec Files
9873 @section Specifying subprocesses and the switches to pass to them
9874 @cindex Spec Files
9875
9876 @command{gcc} is a driver program. It performs its job by invoking a
9877 sequence of other programs to do the work of compiling, assembling and
9878 linking. GCC interprets its command-line parameters and uses these to
9879 deduce which programs it should invoke, and which command-line options
9880 it ought to place on their command lines. This behavior is controlled
9881 by @dfn{spec strings}. In most cases there is one spec string for each
9882 program that GCC can invoke, but a few programs have multiple spec
9883 strings to control their behavior. The spec strings built into GCC can
9884 be overridden by using the @option{-specs=} command-line switch to specify
9885 a spec file.
9886
9887 @dfn{Spec files} are plaintext files that are used to construct spec
9888 strings. They consist of a sequence of directives separated by blank
9889 lines. The type of directive is determined by the first non-whitespace
9890 character on the line, which can be one of the following:
9891
9892 @table @code
9893 @item %@var{command}
9894 Issues a @var{command} to the spec file processor. The commands that can
9895 appear here are:
9896
9897 @table @code
9898 @item %include <@var{file}>
9899 @cindex @code{%include}
9900 Search for @var{file} and insert its text at the current point in the
9901 specs file.
9902
9903 @item %include_noerr <@var{file}>
9904 @cindex @code{%include_noerr}
9905 Just like @samp{%include}, but do not generate an error message if the include
9906 file cannot be found.
9907
9908 @item %rename @var{old_name} @var{new_name}
9909 @cindex @code{%rename}
9910 Rename the spec string @var{old_name} to @var{new_name}.
9911
9912 @end table
9913
9914 @item *[@var{spec_name}]:
9915 This tells the compiler to create, override or delete the named spec
9916 string. All lines after this directive up to the next directive or
9917 blank line are considered to be the text for the spec string. If this
9918 results in an empty string then the spec is deleted. (Or, if the
9919 spec did not exist, then nothing happens.) Otherwise, if the spec
9920 does not currently exist a new spec is created. If the spec does
9921 exist then its contents are overridden by the text of this
9922 directive, unless the first character of that text is the @samp{+}
9923 character, in which case the text is appended to the spec.
9924
9925 @item [@var{suffix}]:
9926 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
9927 and up to the next directive or blank line are considered to make up the
9928 spec string for the indicated suffix. When the compiler encounters an
9929 input file with the named suffix, it processes the spec string in
9930 order to work out how to compile that file. For example:
9931
9932 @smallexample
9933 .ZZ:
9934 z-compile -input %i
9935 @end smallexample
9936
9937 This says that any input file whose name ends in @samp{.ZZ} should be
9938 passed to the program @samp{z-compile}, which should be invoked with the
9939 command-line switch @option{-input} and with the result of performing the
9940 @samp{%i} substitution. (See below.)
9941
9942 As an alternative to providing a spec string, the text that follows a
9943 suffix directive can be one of the following:
9944
9945 @table @code
9946 @item @@@var{language}
9947 This says that the suffix is an alias for a known @var{language}. This is
9948 similar to using the @option{-x} command-line switch to GCC to specify a
9949 language explicitly. For example:
9950
9951 @smallexample
9952 .ZZ:
9953 @@c++
9954 @end smallexample
9955
9956 Says that .ZZ files are, in fact, C++ source files.
9957
9958 @item #@var{name}
9959 This causes an error messages saying:
9960
9961 @smallexample
9962 @var{name} compiler not installed on this system.
9963 @end smallexample
9964 @end table
9965
9966 GCC already has an extensive list of suffixes built into it.
9967 This directive adds an entry to the end of the list of suffixes, but
9968 since the list is searched from the end backwards, it is effectively
9969 possible to override earlier entries using this technique.
9970
9971 @end table
9972
9973 GCC has the following spec strings built into it. Spec files can
9974 override these strings or create their own. Note that individual
9975 targets can also add their own spec strings to this list.
9976
9977 @smallexample
9978 asm Options to pass to the assembler
9979 asm_final Options to pass to the assembler post-processor
9980 cpp Options to pass to the C preprocessor
9981 cc1 Options to pass to the C compiler
9982 cc1plus Options to pass to the C++ compiler
9983 endfile Object files to include at the end of the link
9984 link Options to pass to the linker
9985 lib Libraries to include on the command line to the linker
9986 libgcc Decides which GCC support library to pass to the linker
9987 linker Sets the name of the linker
9988 predefines Defines to be passed to the C preprocessor
9989 signed_char Defines to pass to CPP to say whether @code{char} is signed
9990 by default
9991 startfile Object files to include at the start of the link
9992 @end smallexample
9993
9994 Here is a small example of a spec file:
9995
9996 @smallexample
9997 %rename lib old_lib
9998
9999 *lib:
10000 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10001 @end smallexample
10002
10003 This example renames the spec called @samp{lib} to @samp{old_lib} and
10004 then overrides the previous definition of @samp{lib} with a new one.
10005 The new definition adds in some extra command-line options before
10006 including the text of the old definition.
10007
10008 @dfn{Spec strings} are a list of command-line options to be passed to their
10009 corresponding program. In addition, the spec strings can contain
10010 @samp{%}-prefixed sequences to substitute variable text or to
10011 conditionally insert text into the command line. Using these constructs
10012 it is possible to generate quite complex command lines.
10013
10014 Here is a table of all defined @samp{%}-sequences for spec
10015 strings. Note that spaces are not generated automatically around the
10016 results of expanding these sequences. Therefore you can concatenate them
10017 together or combine them with constant text in a single argument.
10018
10019 @table @code
10020 @item %%
10021 Substitute one @samp{%} into the program name or argument.
10022
10023 @item %i
10024 Substitute the name of the input file being processed.
10025
10026 @item %b
10027 Substitute the basename of the input file being processed.
10028 This is the substring up to (and not including) the last period
10029 and not including the directory.
10030
10031 @item %B
10032 This is the same as @samp{%b}, but include the file suffix (text after
10033 the last period).
10034
10035 @item %d
10036 Marks the argument containing or following the @samp{%d} as a
10037 temporary file name, so that that file is deleted if GCC exits
10038 successfully. Unlike @samp{%g}, this contributes no text to the
10039 argument.
10040
10041 @item %g@var{suffix}
10042 Substitute a file name that has suffix @var{suffix} and is chosen
10043 once per compilation, and mark the argument in the same way as
10044 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
10045 name is now chosen in a way that is hard to predict even when previously
10046 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10047 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
10048 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10049 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
10050 was simply substituted with a file name chosen once per compilation,
10051 without regard to any appended suffix (which was therefore treated
10052 just like ordinary text), making such attacks more likely to succeed.
10053
10054 @item %u@var{suffix}
10055 Like @samp{%g}, but generates a new temporary file name
10056 each time it appears instead of once per compilation.
10057
10058 @item %U@var{suffix}
10059 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10060 new one if there is no such last file name. In the absence of any
10061 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10062 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10063 involves the generation of two distinct file names, one
10064 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
10065 simply substituted with a file name chosen for the previous @samp{%u},
10066 without regard to any appended suffix.
10067
10068 @item %j@var{suffix}
10069 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10070 writable, and if @option{-save-temps} is not used;
10071 otherwise, substitute the name
10072 of a temporary file, just like @samp{%u}. This temporary file is not
10073 meant for communication between processes, but rather as a junk
10074 disposal mechanism.
10075
10076 @item %|@var{suffix}
10077 @itemx %m@var{suffix}
10078 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
10079 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10080 all. These are the two most common ways to instruct a program that it
10081 should read from standard input or write to standard output. If you
10082 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10083 construct: see for example @file{f/lang-specs.h}.
10084
10085 @item %.@var{SUFFIX}
10086 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10087 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
10088 terminated by the next space or %.
10089
10090 @item %w
10091 Marks the argument containing or following the @samp{%w} as the
10092 designated output file of this compilation. This puts the argument
10093 into the sequence of arguments that @samp{%o} substitutes.
10094
10095 @item %o
10096 Substitutes the names of all the output files, with spaces
10097 automatically placed around them. You should write spaces
10098 around the @samp{%o} as well or the results are undefined.
10099 @samp{%o} is for use in the specs for running the linker.
10100 Input files whose names have no recognized suffix are not compiled
10101 at all, but they are included among the output files, so they are
10102 linked.
10103
10104 @item %O
10105 Substitutes the suffix for object files. Note that this is
10106 handled specially when it immediately follows @samp{%g, %u, or %U},
10107 because of the need for those to form complete file names. The
10108 handling is such that @samp{%O} is treated exactly as if it had already
10109 been substituted, except that @samp{%g, %u, and %U} do not currently
10110 support additional @var{suffix} characters following @samp{%O} as they do
10111 following, for example, @samp{.o}.
10112
10113 @item %p
10114 Substitutes the standard macro predefinitions for the
10115 current target machine. Use this when running @code{cpp}.
10116
10117 @item %P
10118 Like @samp{%p}, but puts @samp{__} before and after the name of each
10119 predefined macro, except for macros that start with @samp{__} or with
10120 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
10121 C@.
10122
10123 @item %I
10124 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10125 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10126 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10127 and @option{-imultilib} as necessary.
10128
10129 @item %s
10130 Current argument is the name of a library or startup file of some sort.
10131 Search for that file in a standard list of directories and substitute
10132 the full name found. The current working directory is included in the
10133 list of directories scanned.
10134
10135 @item %T
10136 Current argument is the name of a linker script. Search for that file
10137 in the current list of directories to scan for libraries. If the file
10138 is located insert a @option{--script} option into the command line
10139 followed by the full path name found. If the file is not found then
10140 generate an error message. Note: the current working directory is not
10141 searched.
10142
10143 @item %e@var{str}
10144 Print @var{str} as an error message. @var{str} is terminated by a newline.
10145 Use this when inconsistent options are detected.
10146
10147 @item %(@var{name})
10148 Substitute the contents of spec string @var{name} at this point.
10149
10150 @item %x@{@var{option}@}
10151 Accumulate an option for @samp{%X}.
10152
10153 @item %X
10154 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10155 spec string.
10156
10157 @item %Y
10158 Output the accumulated assembler options specified by @option{-Wa}.
10159
10160 @item %Z
10161 Output the accumulated preprocessor options specified by @option{-Wp}.
10162
10163 @item %a
10164 Process the @code{asm} spec. This is used to compute the
10165 switches to be passed to the assembler.
10166
10167 @item %A
10168 Process the @code{asm_final} spec. This is a spec string for
10169 passing switches to an assembler post-processor, if such a program is
10170 needed.
10171
10172 @item %l
10173 Process the @code{link} spec. This is the spec for computing the
10174 command line passed to the linker. Typically it makes use of the
10175 @samp{%L %G %S %D and %E} sequences.
10176
10177 @item %D
10178 Dump out a @option{-L} option for each directory that GCC believes might
10179 contain startup files. If the target supports multilibs then the
10180 current multilib directory is prepended to each of these paths.
10181
10182 @item %L
10183 Process the @code{lib} spec. This is a spec string for deciding which
10184 libraries are included on the command line to the linker.
10185
10186 @item %G
10187 Process the @code{libgcc} spec. This is a spec string for deciding
10188 which GCC support library is included on the command line to the linker.
10189
10190 @item %S
10191 Process the @code{startfile} spec. This is a spec for deciding which
10192 object files are the first ones passed to the linker. Typically
10193 this might be a file named @file{crt0.o}.
10194
10195 @item %E
10196 Process the @code{endfile} spec. This is a spec string that specifies
10197 the last object files that are passed to the linker.
10198
10199 @item %C
10200 Process the @code{cpp} spec. This is used to construct the arguments
10201 to be passed to the C preprocessor.
10202
10203 @item %1
10204 Process the @code{cc1} spec. This is used to construct the options to be
10205 passed to the actual C compiler (@samp{cc1}).
10206
10207 @item %2
10208 Process the @code{cc1plus} spec. This is used to construct the options to be
10209 passed to the actual C++ compiler (@samp{cc1plus}).
10210
10211 @item %*
10212 Substitute the variable part of a matched option. See below.
10213 Note that each comma in the substituted string is replaced by
10214 a single space.
10215
10216 @item %<@code{S}
10217 Remove all occurrences of @code{-S} from the command line. Note---this
10218 command is position dependent. @samp{%} commands in the spec string
10219 before this one see @code{-S}, @samp{%} commands in the spec string
10220 after this one do not.
10221
10222 @item %:@var{function}(@var{args})
10223 Call the named function @var{function}, passing it @var{args}.
10224 @var{args} is first processed as a nested spec string, then split
10225 into an argument vector in the usual fashion. The function returns
10226 a string which is processed as if it had appeared literally as part
10227 of the current spec.
10228
10229 The following built-in spec functions are provided:
10230
10231 @table @code
10232 @item @code{getenv}
10233 The @code{getenv} spec function takes two arguments: an environment
10234 variable name and a string. If the environment variable is not
10235 defined, a fatal error is issued. Otherwise, the return value is the
10236 value of the environment variable concatenated with the string. For
10237 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10238
10239 @smallexample
10240 %:getenv(TOPDIR /include)
10241 @end smallexample
10242
10243 expands to @file{/path/to/top/include}.
10244
10245 @item @code{if-exists}
10246 The @code{if-exists} spec function takes one argument, an absolute
10247 pathname to a file. If the file exists, @code{if-exists} returns the
10248 pathname. Here is a small example of its usage:
10249
10250 @smallexample
10251 *startfile:
10252 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10253 @end smallexample
10254
10255 @item @code{if-exists-else}
10256 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10257 spec function, except that it takes two arguments. The first argument is
10258 an absolute pathname to a file. If the file exists, @code{if-exists-else}
10259 returns the pathname. If it does not exist, it returns the second argument.
10260 This way, @code{if-exists-else} can be used to select one file or another,
10261 based on the existence of the first. Here is a small example of its usage:
10262
10263 @smallexample
10264 *startfile:
10265 crt0%O%s %:if-exists(crti%O%s) \
10266 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10267 @end smallexample
10268
10269 @item @code{replace-outfile}
10270 The @code{replace-outfile} spec function takes two arguments. It looks for the
10271 first argument in the outfiles array and replaces it with the second argument. Here
10272 is a small example of its usage:
10273
10274 @smallexample
10275 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10276 @end smallexample
10277
10278 @item @code{remove-outfile}
10279 The @code{remove-outfile} spec function takes one argument. It looks for the
10280 first argument in the outfiles array and removes it. Here is a small example
10281 its usage:
10282
10283 @smallexample
10284 %:remove-outfile(-lm)
10285 @end smallexample
10286
10287 @item @code{pass-through-libs}
10288 The @code{pass-through-libs} spec function takes any number of arguments. It
10289 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10290 assumes are the names of linker input library archive files) and returns a
10291 result containing all the found arguments each prepended by
10292 @option{-plugin-opt=-pass-through=} and joined by spaces. This list is
10293 intended to be passed to the LTO linker plugin.
10294
10295 @smallexample
10296 %:pass-through-libs(%G %L %G)
10297 @end smallexample
10298
10299 @item @code{print-asm-header}
10300 The @code{print-asm-header} function takes no arguments and simply
10301 prints a banner like:
10302
10303 @smallexample
10304 Assembler options
10305 =================
10306
10307 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10308 @end smallexample
10309
10310 It is used to separate compiler options from assembler options
10311 in the @option{--target-help} output.
10312 @end table
10313
10314 @item %@{@code{S}@}
10315 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10316 If that switch is not specified, this substitutes nothing. Note that
10317 the leading dash is omitted when specifying this option, and it is
10318 automatically inserted if the substitution is performed. Thus the spec
10319 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10320 and outputs the command-line option @option{-foo}.
10321
10322 @item %W@{@code{S}@}
10323 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10324 deleted on failure.
10325
10326 @item %@{@code{S}*@}
10327 Substitutes all the switches specified to GCC whose names start
10328 with @code{-S}, but which also take an argument. This is used for
10329 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10330 GCC considers @option{-o foo} as being
10331 one switch whose name starts with @samp{o}. %@{o*@} substitutes this
10332 text, including the space. Thus two arguments are generated.
10333
10334 @item %@{@code{S}*&@code{T}*@}
10335 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10336 (the order of @code{S} and @code{T} in the spec is not significant).
10337 There can be any number of ampersand-separated variables; for each the
10338 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
10339
10340 @item %@{@code{S}:@code{X}@}
10341 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10342
10343 @item %@{!@code{S}:@code{X}@}
10344 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10345
10346 @item %@{@code{S}*:@code{X}@}
10347 Substitutes @code{X} if one or more switches whose names start with
10348 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
10349 once, no matter how many such switches appeared. However, if @code{%*}
10350 appears somewhere in @code{X}, then @code{X} is substituted once
10351 for each matching switch, with the @code{%*} replaced by the part of
10352 that switch matching the @code{*}.
10353
10354 @item %@{.@code{S}:@code{X}@}
10355 Substitutes @code{X}, if processing a file with suffix @code{S}.
10356
10357 @item %@{!.@code{S}:@code{X}@}
10358 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10359
10360 @item %@{,@code{S}:@code{X}@}
10361 Substitutes @code{X}, if processing a file for language @code{S}.
10362
10363 @item %@{!,@code{S}:@code{X}@}
10364 Substitutes @code{X}, if not processing a file for language @code{S}.
10365
10366 @item %@{@code{S}|@code{P}:@code{X}@}
10367 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10368 GCC@. This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10369 @code{*} sequences as well, although they have a stronger binding than
10370 the @samp{|}. If @code{%*} appears in @code{X}, all of the
10371 alternatives must be starred, and only the first matching alternative
10372 is substituted.
10373
10374 For example, a spec string like this:
10375
10376 @smallexample
10377 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10378 @end smallexample
10379
10380 @noindent
10381 outputs the following command-line options from the following input
10382 command-line options:
10383
10384 @smallexample
10385 fred.c -foo -baz
10386 jim.d -bar -boggle
10387 -d fred.c -foo -baz -boggle
10388 -d jim.d -bar -baz -boggle
10389 @end smallexample
10390
10391 @item %@{S:X; T:Y; :D@}
10392
10393 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10394 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
10395 be as many clauses as you need. This may be combined with @code{.},
10396 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10397
10398
10399 @end table
10400
10401 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10402 construct may contain other nested @samp{%} constructs or spaces, or
10403 even newlines. They are processed as usual, as described above.
10404 Trailing white space in @code{X} is ignored. White space may also
10405 appear anywhere on the left side of the colon in these constructs,
10406 except between @code{.} or @code{*} and the corresponding word.
10407
10408 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10409 handled specifically in these constructs. If another value of
10410 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10411 @option{-W} switch is found later in the command line, the earlier
10412 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10413 just one letter, which passes all matching options.
10414
10415 The character @samp{|} at the beginning of the predicate text is used to
10416 indicate that a command should be piped to the following command, but
10417 only if @option{-pipe} is specified.
10418
10419 It is built into GCC which switches take arguments and which do not.
10420 (You might think it would be useful to generalize this to allow each
10421 compiler's spec to say which switches take arguments. But this cannot
10422 be done in a consistent fashion. GCC cannot even decide which input
10423 files have been specified without knowing which switches take arguments,
10424 and it must know which input files to compile in order to tell which
10425 compilers to run).
10426
10427 GCC also knows implicitly that arguments starting in @option{-l} are to be
10428 treated as compiler output files, and passed to the linker in their
10429 proper position among the other output files.
10430
10431 @c man begin OPTIONS
10432
10433 @node Target Options
10434 @section Specifying Target Machine and Compiler Version
10435 @cindex target options
10436 @cindex cross compiling
10437 @cindex specifying machine version
10438 @cindex specifying compiler version and target machine
10439 @cindex compiler version, specifying
10440 @cindex target machine, specifying
10441
10442 The usual way to run GCC is to run the executable called @command{gcc}, or
10443 @command{@var{machine}-gcc} when cross-compiling, or
10444 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10445 one that was installed last.
10446
10447 @node Submodel Options
10448 @section Hardware Models and Configurations
10449 @cindex submodel options
10450 @cindex specifying hardware config
10451 @cindex hardware models and configurations, specifying
10452 @cindex machine dependent options
10453
10454 Each target machine types can have its own
10455 special options, starting with @samp{-m}, to choose among various
10456 hardware models or configurations---for example, 68010 vs 68020,
10457 floating coprocessor or none. A single installed version of the
10458 compiler can compile for any model or configuration, according to the
10459 options specified.
10460
10461 Some configurations of the compiler also support additional special
10462 options, usually for compatibility with other compilers on the same
10463 platform.
10464
10465 @c This list is ordered alphanumerically by subsection name.
10466 @c It should be the same order and spelling as these options are listed
10467 @c in Machine Dependent Options
10468
10469 @menu
10470 * Adapteva Epiphany Options::
10471 * ARM Options::
10472 * AVR Options::
10473 * Blackfin Options::
10474 * C6X Options::
10475 * CRIS Options::
10476 * CR16 Options::
10477 * Darwin Options::
10478 * DEC Alpha Options::
10479 * FR30 Options::
10480 * FRV Options::
10481 * GNU/Linux Options::
10482 * H8/300 Options::
10483 * HPPA Options::
10484 * i386 and x86-64 Options::
10485 * i386 and x86-64 Windows Options::
10486 * IA-64 Options::
10487 * LM32 Options::
10488 * M32C Options::
10489 * M32R/D Options::
10490 * M680x0 Options::
10491 * MCore Options::
10492 * MeP Options::
10493 * MicroBlaze Options::
10494 * MIPS Options::
10495 * MMIX Options::
10496 * MN10300 Options::
10497 * PDP-11 Options::
10498 * picoChip Options::
10499 * PowerPC Options::
10500 * RL78 Options::
10501 * RS/6000 and PowerPC Options::
10502 * RX Options::
10503 * S/390 and zSeries Options::
10504 * Score Options::
10505 * SH Options::
10506 * Solaris 2 Options::
10507 * SPARC Options::
10508 * SPU Options::
10509 * System V Options::
10510 * TILE-Gx Options::
10511 * TILEPro Options::
10512 * V850 Options::
10513 * VAX Options::
10514 * VMS Options::
10515 * VxWorks Options::
10516 * x86-64 Options::
10517 * Xstormy16 Options::
10518 * Xtensa Options::
10519 * zSeries Options::
10520 @end menu
10521
10522 @node Adapteva Epiphany Options
10523 @subsection Adapteva Epiphany Options
10524
10525 These @samp{-m} options are defined for Adapteva Epiphany:
10526
10527 @table @gcctabopt
10528 @item -mhalf-reg-file
10529 @opindex mhalf-reg-file
10530 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10531 That allows code to run on hardware variants that lack these registers.
10532
10533 @item -mprefer-short-insn-regs
10534 @opindex mprefer-short-insn-regs
10535 Preferrentially allocate registers that allow short instruction generation.
10536 This can result in increasesd instruction count, so if this reduces or
10537 increases code size might vary from case to case.
10538
10539 @item -mbranch-cost=@var{num}
10540 @opindex mbranch-cost
10541 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10542 This cost is only a heuristic and is not guaranteed to produce
10543 consistent results across releases.
10544
10545 @item -mcmove
10546 @opindex mcmove
10547 Enable the generation of conditional moves.
10548
10549 @item -mnops=@var{num}
10550 @opindex mnops
10551 Emit @var{num} nops before every other generated instruction.
10552
10553 @item -mno-soft-cmpsf
10554 @opindex mno-soft-cmpsf
10555 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10556 and test the flags. This is faster than a software comparison, but can
10557 get incorrect results in the presence of NaNs, or when two different small
10558 numbers are compared such that their difference is calculated as zero.
10559 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10560 software comparisons.
10561
10562 @item -mstack-offset=@var{num}
10563 @opindex mstack-offset
10564 Set the offset between the top of the stack and the stack pointer.
10565 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10566 can be used by leaf functions without stack allocation.
10567 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10568 Note also that this option changes the ABI, compiling a program with a
10569 different stack offset than the libraries have been compiled with
10570 generally does not work.
10571 This option can be useful if you want to evaluate if a different stack
10572 offset would give you better code, but to actually use a different stack
10573 offset to build working programs, it is recommended to configure the
10574 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10575
10576 @item -mno-round-nearest
10577 @opindex mno-round-nearest
10578 Make the scheduler assume that the rounding mode has been set to
10579 truncating. The default is @option{-mround-nearest}.
10580
10581 @item -mlong-calls
10582 @opindex mlong-calls
10583 If not otherwise specified by an attribute, assume all calls might be beyond
10584 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10585 function address into a register before performing a (otherwise direct) call.
10586 This is the default.
10587
10588 @item -mshort-calls
10589 @opindex short-calls
10590 If not otherwise specified by an attribute, assume all direct calls are
10591 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10592 for direct calls. The default is @option{-mlong-calls}.
10593
10594 @item -msmall16
10595 @opindex msmall16
10596 Assume addresses can be loaded as 16-bit unsigned values. This does not
10597 apply to function addresses for which @option{-mlong-calls} semantics
10598 are in effect.
10599
10600 @item -mfp-mode=@var{mode}
10601 @opindex mfp-mode
10602 Set the prevailing mode of the floating-point unit.
10603 This determines the floating-point mode that is provided and expected
10604 at function call and return time. Making this mode match the mode you
10605 predominantly need at function start can make your programs smaller and
10606 faster by avoiding unnecessary mode switches.
10607
10608 @var{mode} can be set to one the following values:
10609
10610 @table @samp
10611 @item caller
10612 Any mode at function entry is valid, and retained or restored when
10613 the function returns, and when it calls other functions.
10614 This mode is useful for compiling libraries or other compilation units
10615 you might want to incorporate into different programs with different
10616 prevailing FPU modes, and the convenience of being able to use a single
10617 object file outweighs the size and speed overhead for any extra
10618 mode switching that might be needed, compared with what would be needed
10619 with a more specific choice of prevailing FPU mode.
10620
10621 @item truncate
10622 This is the mode used for floating-point calculations with
10623 truncating (i.e.@: round towards zero) rounding mode. That includes
10624 conversion from floating point to integer.
10625
10626 @item round-nearest
10627 This is the mode used for floating-point calculations with
10628 round-to-nearest-or-even rounding mode.
10629
10630 @item int
10631 This is the mode used to perform integer calculations in the FPU, e.g.@:
10632 integer multiply, or integer multiply-and-accumulate.
10633 @end table
10634
10635 The default is @option{-mfp-mode=caller}
10636
10637 @item -mnosplit-lohi
10638 @opindex mnosplit-lohi
10639 @item -mno-postinc
10640 @opindex mno-postinc
10641 @item -mno-postmodify
10642 @opindex mno-postmodify
10643 Code generation tweaks that disable, respectively, splitting of 32-bit
10644 loads, generation of post-increment addresses, and generation of
10645 post-modify addresses. The defaults are @option{msplit-lohi},
10646 @option{-mpost-inc}, and @option{-mpost-modify}.
10647
10648 @item -mnovect-double
10649 @opindex mno-vect-double
10650 Change the preferred SIMD mode to SImode. The default is
10651 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10652
10653 @item -max-vect-align=@var{num}
10654 @opindex max-vect-align
10655 The maximum alignment for SIMD vector mode types.
10656 @var{num} may be 4 or 8. The default is 8.
10657 Note that this is an ABI change, even though many library function
10658 interfaces are unaffected if they don't use SIMD vector modes
10659 in places that affect size and/or alignment of relevant types.
10660
10661 @item -msplit-vecmove-early
10662 @opindex msplit-vecmove-early
10663 Split vector moves into single word moves before reload. In theory this
10664 can give better register allocation, but so far the reverse seems to be
10665 generally the case.
10666
10667 @item -m1reg-@var{reg}
10668 @opindex m1reg-
10669 Specify a register to hold the constant @minus{}1, which makes loading small negative
10670 constants and certain bitmasks faster.
10671 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10672 which specify use of that register as a fixed register,
10673 and @samp{none}, which means that no register is used for this
10674 purpose. The default is @option{-m1reg-none}.
10675
10676 @end table
10677
10678 @node ARM Options
10679 @subsection ARM Options
10680 @cindex ARM options
10681
10682 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10683 architectures:
10684
10685 @table @gcctabopt
10686 @item -mabi=@var{name}
10687 @opindex mabi
10688 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
10689 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10690
10691 @item -mapcs-frame
10692 @opindex mapcs-frame
10693 Generate a stack frame that is compliant with the ARM Procedure Call
10694 Standard for all functions, even if this is not strictly necessary for
10695 correct execution of the code. Specifying @option{-fomit-frame-pointer}
10696 with this option causes the stack frames not to be generated for
10697 leaf functions. The default is @option{-mno-apcs-frame}.
10698
10699 @item -mapcs
10700 @opindex mapcs
10701 This is a synonym for @option{-mapcs-frame}.
10702
10703 @ignore
10704 @c not currently implemented
10705 @item -mapcs-stack-check
10706 @opindex mapcs-stack-check
10707 Generate code to check the amount of stack space available upon entry to
10708 every function (that actually uses some stack space). If there is
10709 insufficient space available then either the function
10710 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
10711 called, depending upon the amount of stack space required. The runtime
10712 system is required to provide these functions. The default is
10713 @option{-mno-apcs-stack-check}, since this produces smaller code.
10714
10715 @c not currently implemented
10716 @item -mapcs-float
10717 @opindex mapcs-float
10718 Pass floating-point arguments using the floating-point registers. This is
10719 one of the variants of the APCS@. This option is recommended if the
10720 target hardware has a floating-point unit or if a lot of floating-point
10721 arithmetic is going to be performed by the code. The default is
10722 @option{-mno-apcs-float}, since integer only code is slightly increased in
10723 size if @option{-mapcs-float} is used.
10724
10725 @c not currently implemented
10726 @item -mapcs-reentrant
10727 @opindex mapcs-reentrant
10728 Generate reentrant, position independent code. The default is
10729 @option{-mno-apcs-reentrant}.
10730 @end ignore
10731
10732 @item -mthumb-interwork
10733 @opindex mthumb-interwork
10734 Generate code that supports calling between the ARM and Thumb
10735 instruction sets. Without this option, on pre-v5 architectures, the
10736 two instruction sets cannot be reliably used inside one program. The
10737 default is @option{-mno-thumb-interwork}, since slightly larger code
10738 is generated when @option{-mthumb-interwork} is specified. In AAPCS
10739 configurations this option is meaningless.
10740
10741 @item -mno-sched-prolog
10742 @opindex mno-sched-prolog
10743 Prevent the reordering of instructions in the function prologue, or the
10744 merging of those instruction with the instructions in the function's
10745 body. This means that all functions start with a recognizable set
10746 of instructions (or in fact one of a choice from a small set of
10747 different function prologues), and this information can be used to
10748 locate the start of functions inside an executable piece of code. The
10749 default is @option{-msched-prolog}.
10750
10751 @item -mfloat-abi=@var{name}
10752 @opindex mfloat-abi
10753 Specifies which floating-point ABI to use. Permissible values
10754 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10755
10756 Specifying @samp{soft} causes GCC to generate output containing
10757 library calls for floating-point operations.
10758 @samp{softfp} allows the generation of code using hardware floating-point
10759 instructions, but still uses the soft-float calling conventions.
10760 @samp{hard} allows generation of floating-point instructions
10761 and uses FPU-specific calling conventions.
10762
10763 The default depends on the specific target configuration. Note that
10764 the hard-float and soft-float ABIs are not link-compatible; you must
10765 compile your entire program with the same ABI, and link with a
10766 compatible set of libraries.
10767
10768 @item -mlittle-endian
10769 @opindex mlittle-endian
10770 Generate code for a processor running in little-endian mode. This is
10771 the default for all standard configurations.
10772
10773 @item -mbig-endian
10774 @opindex mbig-endian
10775 Generate code for a processor running in big-endian mode; the default is
10776 to compile code for a little-endian processor.
10777
10778 @item -mwords-little-endian
10779 @opindex mwords-little-endian
10780 This option only applies when generating code for big-endian processors.
10781 Generate code for a little-endian word order but a big-endian byte
10782 order. That is, a byte order of the form @samp{32107654}. Note: this
10783 option should only be used if you require compatibility with code for
10784 big-endian ARM processors generated by versions of the compiler prior to
10785 2.8. This option is now deprecated.
10786
10787 @item -mcpu=@var{name}
10788 @opindex mcpu
10789 This specifies the name of the target ARM processor. GCC uses this name
10790 to determine what kind of instructions it can emit when generating
10791 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
10792 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10793 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10794 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10795 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10796 @samp{arm720},
10797 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10798 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10799 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10800 @samp{strongarm1110},
10801 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10802 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10803 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10804 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10805 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10806 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10807 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10808 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
10809 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10810 @samp{cortex-m4}, @samp{cortex-m3},
10811 @samp{cortex-m1},
10812 @samp{cortex-m0},
10813 @samp{cortex-m0plus},
10814 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10815 @samp{fa526}, @samp{fa626},
10816 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10817
10818
10819 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10820 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10821 See @option{-mtune} for more information.
10822
10823 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10824 of the build computer. At present, this feature is only supported on
10825 Linux, and not all architectures are recognized. If the auto-detect is
10826 unsuccessful the option has no effect.
10827
10828 @item -mtune=@var{name}
10829 @opindex mtune
10830 This option is very similar to the @option{-mcpu=} option, except that
10831 instead of specifying the actual target processor type, and hence
10832 restricting which instructions can be used, it specifies that GCC should
10833 tune the performance of the code as if the target were of the type
10834 specified in this option, but still choosing the instructions it
10835 generates based on the CPU specified by a @option{-mcpu=} option.
10836 For some ARM implementations better performance can be obtained by using
10837 this option.
10838
10839 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10840 performance for a blend of processors within architecture @var{arch}.
10841 The aim is to generate code that run well on the current most popular
10842 processors, balancing between optimizations that benefit some CPUs in the
10843 range, and avoiding performance pitfalls of other CPUs. The effects of
10844 this option may change in future GCC versions as CPU models come and go.
10845
10846 @option{-mtune=native} causes the compiler to auto-detect the CPU
10847 of the build computer. At present, this feature is only supported on
10848 Linux, and not all architectures are recognized. If the auto-detect is
10849 unsuccessful the option has no effect.
10850
10851 @item -march=@var{name}
10852 @opindex march
10853 This specifies the name of the target ARM architecture. GCC uses this
10854 name to determine what kind of instructions it can emit when generating
10855 assembly code. This option can be used in conjunction with or instead
10856 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
10857 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10858 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10859 @samp{armv6}, @samp{armv6j},
10860 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10861 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10862 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10863
10864 @option{-march=native} causes the compiler to auto-detect the architecture
10865 of the build computer. At present, this feature is only supported on
10866 Linux, and not all architectures are recognized. If the auto-detect is
10867 unsuccessful the option has no effect.
10868
10869 @item -mfpu=@var{name}
10870 @opindex mfpu
10871 This specifies what floating-point hardware (or hardware emulation) is
10872 available on the target. Permissible names are: @samp{vfp}, @samp{vfpv3},
10873 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
10874 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
10875 @samp{vfpv4-d16}, @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10876
10877 If @option{-msoft-float} is specified this specifies the format of
10878 floating-point values.
10879
10880 If the selected floating-point hardware includes the NEON extension
10881 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10882 operations are not generated by GCC's auto-vectorization pass unless
10883 @option{-funsafe-math-optimizations} is also specified. This is
10884 because NEON hardware does not fully implement the IEEE 754 standard for
10885 floating-point arithmetic (in particular denormal values are treated as
10886 zero), so the use of NEON instructions may lead to a loss of precision.
10887
10888 @item -mfp16-format=@var{name}
10889 @opindex mfp16-format
10890 Specify the format of the @code{__fp16} half-precision floating-point type.
10891 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10892 the default is @samp{none}, in which case the @code{__fp16} type is not
10893 defined. @xref{Half-Precision}, for more information.
10894
10895 @item -mstructure-size-boundary=@var{n}
10896 @opindex mstructure-size-boundary
10897 The sizes of all structures and unions are rounded up to a multiple
10898 of the number of bits set by this option. Permissible values are 8, 32
10899 and 64. The default value varies for different toolchains. For the COFF
10900 targeted toolchain the default value is 8. A value of 64 is only allowed
10901 if the underlying ABI supports it.
10902
10903 Specifying the larger number can produce faster, more efficient code, but
10904 can also increase the size of the program. Different values are potentially
10905 incompatible. Code compiled with one value cannot necessarily expect to
10906 work with code or libraries compiled with another value, if they exchange
10907 information using structures or unions.
10908
10909 @item -mabort-on-noreturn
10910 @opindex mabort-on-noreturn
10911 Generate a call to the function @code{abort} at the end of a
10912 @code{noreturn} function. It is executed if the function tries to
10913 return.
10914
10915 @item -mlong-calls
10916 @itemx -mno-long-calls
10917 @opindex mlong-calls
10918 @opindex mno-long-calls
10919 Tells the compiler to perform function calls by first loading the
10920 address of the function into a register and then performing a subroutine
10921 call on this register. This switch is needed if the target function
10922 lies outside of the 64-megabyte addressing range of the offset-based
10923 version of subroutine call instruction.
10924
10925 Even if this switch is enabled, not all function calls are turned
10926 into long calls. The heuristic is that static functions, functions
10927 that have the @samp{short-call} attribute, functions that are inside
10928 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
10929 definitions have already been compiled within the current compilation
10930 unit are not turned into long calls. The exceptions to this rule are
10931 that weak function definitions, functions with the @samp{long-call}
10932 attribute or the @samp{section} attribute, and functions that are within
10933 the scope of a @samp{#pragma long_calls} directive are always
10934 turned into long calls.
10935
10936 This feature is not enabled by default. Specifying
10937 @option{-mno-long-calls} restores the default behavior, as does
10938 placing the function calls within the scope of a @samp{#pragma
10939 long_calls_off} directive. Note these switches have no effect on how
10940 the compiler generates code to handle function calls via function
10941 pointers.
10942
10943 @item -msingle-pic-base
10944 @opindex msingle-pic-base
10945 Treat the register used for PIC addressing as read-only, rather than
10946 loading it in the prologue for each function. The runtime system is
10947 responsible for initializing this register with an appropriate value
10948 before execution begins.
10949
10950 @item -mpic-register=@var{reg}
10951 @opindex mpic-register
10952 Specify the register to be used for PIC addressing. The default is R10
10953 unless stack-checking is enabled, when R9 is used.
10954
10955 @item -mcirrus-fix-invalid-insns
10956 @opindex mcirrus-fix-invalid-insns
10957 @opindex mno-cirrus-fix-invalid-insns
10958 Insert NOPs into the instruction stream to in order to work around
10959 problems with invalid Maverick instruction combinations. This option
10960 is only valid if the @option{-mcpu=ep9312} option has been used to
10961 enable generation of instructions for the Cirrus Maverick floating-point
10962 co-processor. This option is not enabled by default, since the
10963 problem is only present in older Maverick implementations. The default
10964 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10965 switch.
10966
10967 @item -mpoke-function-name
10968 @opindex mpoke-function-name
10969 Write the name of each function into the text section, directly
10970 preceding the function prologue. The generated code is similar to this:
10971
10972 @smallexample
10973 t0
10974 .ascii "arm_poke_function_name", 0
10975 .align
10976 t1
10977 .word 0xff000000 + (t1 - t0)
10978 arm_poke_function_name
10979 mov ip, sp
10980 stmfd sp!, @{fp, ip, lr, pc@}
10981 sub fp, ip, #4
10982 @end smallexample
10983
10984 When performing a stack backtrace, code can inspect the value of
10985 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
10986 location @code{pc - 12} and the top 8 bits are set, then we know that
10987 there is a function name embedded immediately preceding this location
10988 and has length @code{((pc[-3]) & 0xff000000)}.
10989
10990 @item -mthumb
10991 @itemx -marm
10992 @opindex marm
10993 @opindex mthumb
10994
10995 Select between generating code that executes in ARM and Thumb
10996 states. The default for most configurations is to generate code
10997 that executes in ARM state, but the default can be changed by
10998 configuring GCC with the @option{--with-mode=}@var{state}
10999 configure option.
11000
11001 @item -mtpcs-frame
11002 @opindex mtpcs-frame
11003 Generate a stack frame that is compliant with the Thumb Procedure Call
11004 Standard for all non-leaf functions. (A leaf function is one that does
11005 not call any other functions.) The default is @option{-mno-tpcs-frame}.
11006
11007 @item -mtpcs-leaf-frame
11008 @opindex mtpcs-leaf-frame
11009 Generate a stack frame that is compliant with the Thumb Procedure Call
11010 Standard for all leaf functions. (A leaf function is one that does
11011 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
11012
11013 @item -mcallee-super-interworking
11014 @opindex mcallee-super-interworking
11015 Gives all externally visible functions in the file being compiled an ARM
11016 instruction set header which switches to Thumb mode before executing the
11017 rest of the function. This allows these functions to be called from
11018 non-interworking code. This option is not valid in AAPCS configurations
11019 because interworking is enabled by default.
11020
11021 @item -mcaller-super-interworking
11022 @opindex mcaller-super-interworking
11023 Allows calls via function pointers (including virtual functions) to
11024 execute correctly regardless of whether the target code has been
11025 compiled for interworking or not. There is a small overhead in the cost
11026 of executing a function pointer if this option is enabled. This option
11027 is not valid in AAPCS configurations because interworking is enabled
11028 by default.
11029
11030 @item -mtp=@var{name}
11031 @opindex mtp
11032 Specify the access model for the thread local storage pointer. The valid
11033 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11034 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11035 (supported in the arm6k architecture), and @option{auto}, which uses the
11036 best available method for the selected processor. The default setting is
11037 @option{auto}.
11038
11039 @item -mtls-dialect=@var{dialect}
11040 @opindex mtls-dialect
11041 Specify the dialect to use for accessing thread local storage. Two
11042 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}. The
11043 @samp{gnu} dialect selects the original GNU scheme for supporting
11044 local and global dynamic TLS models. The @samp{gnu2} dialect
11045 selects the GNU descriptor scheme, which provides better performance
11046 for shared libraries. The GNU descriptor scheme is compatible with
11047 the original scheme, but does require new assembler, linker and
11048 library support. Initial and local exec TLS models are unaffected by
11049 this option and always use the original scheme.
11050
11051 @item -mword-relocations
11052 @opindex mword-relocations
11053 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11054 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11055 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11056 is specified.
11057
11058 @item -mfix-cortex-m3-ldrd
11059 @opindex mfix-cortex-m3-ldrd
11060 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11061 with overlapping destination and base registers are used. This option avoids
11062 generating these instructions. This option is enabled by default when
11063 @option{-mcpu=cortex-m3} is specified.
11064
11065 @item -munaligned-access
11066 @itemx -mno-unaligned-access
11067 @opindex munaligned-access
11068 @opindex mno-unaligned-access
11069 Enables (or disables) reading and writing of 16- and 32- bit values
11070 from addresses that are not 16- or 32- bit aligned. By default
11071 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11072 architectures, and enabled for all other architectures. If unaligned
11073 access is not enabled then words in packed data structures will be
11074 accessed a byte at a time.
11075
11076 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11077 generated object file to either true or false, depending upon the
11078 setting of this option. If unaligned access is enabled then the
11079 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11080 defined.
11081
11082 @end table
11083
11084 @node AVR Options
11085 @subsection AVR Options
11086 @cindex AVR Options
11087
11088 These options are defined for AVR implementations:
11089
11090 @table @gcctabopt
11091 @item -mmcu=@var{mcu}
11092 @opindex mmcu
11093 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11094
11095 For a complete list of @var{mcu} values that are supported by @command{avr-gcc},
11096 see the compiler output when called with the @option{--help=target}
11097 command line option.
11098 The default for this option is@tie{}@code{avr2}.
11099
11100 GCC supports the following AVR devices and ISAs:
11101
11102 @include avr-mmcu.texi
11103
11104 @item -maccumulate-args
11105 @opindex maccumulate-args
11106 Accumulate outgoing function arguments and acquire/release the needed
11107 stack space for outgoing function arguments once in function
11108 prologue/epilogue. Without this option, outgoing arguments are pushed
11109 before calling a function and popped afterwards.
11110
11111 Popping the arguments after the function call can be expensive on
11112 AVR so that accumulating the stack space might lead to smaller
11113 executables because arguments need not to be removed from the
11114 stack after such a function call.
11115
11116 This option can lead to reduced code size for functions that perform
11117 several calls to functions that get their arguments on the stack like
11118 calls to printf-like functions.
11119
11120 @item -mbranch-cost=@var{cost}
11121 @opindex mbranch-cost
11122 Set the branch costs for conditional branch instructions to
11123 @var{cost}. Reasonable values for @var{cost} are small, non-negative
11124 integers. The default branch cost is 0.
11125
11126 @item -mcall-prologues
11127 @opindex mcall-prologues
11128 Functions prologues/epilogues are expanded as calls to appropriate
11129 subroutines. Code size is smaller.
11130
11131 @item -mint8
11132 @opindex mint8
11133 Assume @code{int} to be 8-bit integer. This affects the sizes of all types: a
11134 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11135 and @code{long long} is 4 bytes. Please note that this option does not
11136 conform to the C standards, but it results in smaller code
11137 size.
11138
11139 @item -mno-interrupts
11140 @opindex mno-interrupts
11141 Generated code is not compatible with hardware interrupts.
11142 Code size is smaller.
11143
11144 @item -mrelax
11145 @opindex mrelax
11146 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11147 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11148 Setting @code{-mrelax} just adds the @code{--relax} option to the
11149 linker command line when the linker is called.
11150
11151 Jump relaxing is performed by the linker because jump offsets are not
11152 known before code is located. Therefore, the assembler code generated by the
11153 compiler is the same, but the instructions in the executable may
11154 differ from instructions in the assembler code.
11155
11156 Relaxing must be turned on if linker stubs are needed, see the
11157 section on @code{EIND} and linker stubs below.
11158
11159 @item -mshort-calls
11160 @opindex mshort-calls
11161 Use @code{RCALL}/@code{RJMP} instructions even on devices with
11162 16@tie{}KiB or more of program memory, i.e.@: on devices that
11163 have the @code{CALL} and @code{JMP} instructions.
11164 See also the @code{-mrelax} command line option.
11165
11166 @item -msp8
11167 @opindex msp8
11168 Treat the stack pointer register as an 8-bit register,
11169 i.e.@: assume the high byte of the stack pointer is zero.
11170 In general, you don't need to set this option by hand.
11171
11172 This option is used internally by the compiler to select and
11173 build multilibs for architectures @code{avr2} and @code{avr25}.
11174 These architectures mix devices with and without @code{SPH}.
11175 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11176 the compiler driver will add or remove this option from the compiler
11177 proper's command line, because the compiler then knows if the device
11178 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11179 register or not.
11180
11181 @item -mstrict-X
11182 @opindex mstrict-X
11183 Use address register @code{X} in a way proposed by the hardware. This means
11184 that @code{X} is only used in indirect, post-increment or
11185 pre-decrement addressing.
11186
11187 Without this option, the @code{X} register may be used in the same way
11188 as @code{Y} or @code{Z} which then is emulated by additional
11189 instructions.
11190 For example, loading a value with @code{X+const} addressing with a
11191 small non-negative @code{const < 64} to a register @var{Rn} is
11192 performed as
11193
11194 @example
11195 adiw r26, const ; X += const
11196 ld @var{Rn}, X ; @var{Rn} = *X
11197 sbiw r26, const ; X -= const
11198 @end example
11199
11200 @item -mtiny-stack
11201 @opindex mtiny-stack
11202 Only change the lower 8@tie{}bits of the stack pointer.
11203 @end table
11204
11205 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11206 @cindex @code{EIND}
11207 Pointers in the implementation are 16@tie{}bits wide.
11208 The address of a function or label is represented as word address so
11209 that indirect jumps and calls can target any code address in the
11210 range of 64@tie{}Ki words.
11211
11212 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11213 bytes of program memory space, there is a special function register called
11214 @code{EIND} that serves as most significant part of the target address
11215 when @code{EICALL} or @code{EIJMP} instructions are used.
11216
11217 Indirect jumps and calls on these devices are handled as follows by
11218 the compiler and are subject to some limitations:
11219
11220 @itemize @bullet
11221
11222 @item
11223 The compiler never sets @code{EIND}.
11224
11225 @item
11226 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11227 instructions or might read @code{EIND} directly in order to emulate an
11228 indirect call/jump by means of a @code{RET} instruction.
11229
11230 @item
11231 The compiler assumes that @code{EIND} never changes during the startup
11232 code or during the application. In particular, @code{EIND} is not
11233 saved/restored in function or interrupt service routine
11234 prologue/epilogue.
11235
11236 @item
11237 For indirect calls to functions and computed goto, the linker
11238 generates @emph{stubs}. Stubs are jump pads sometimes also called
11239 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11240 The stub contains a direct jump to the desired address.
11241
11242 @item
11243 Linker relaxation must be turned on so that the linker will generate
11244 the stubs correctly an all situaltion. See the compiler option
11245 @code{-mrelax} and the linler option @code{--relax}.
11246 There are corner cases where the linker is supposed to generate stubs
11247 but aborts without relaxation and without a helpful error message.
11248
11249 @item
11250 The default linker script is arranged for code with @code{EIND = 0}.
11251 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11252 linker script has to be used in order to place the sections whose
11253 name start with @code{.trampolines} into the segment where @code{EIND}
11254 points to.
11255
11256 @item
11257 The startup code from libgcc never sets @code{EIND}.
11258 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11259 For the impact of AVR-LibC on @code{EIND}, see the
11260 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11261
11262 @item
11263 It is legitimate for user-specific startup code to set up @code{EIND}
11264 early, for example by means of initialization code located in
11265 section @code{.init3}. Such code runs prior to general startup code
11266 that initializes RAM and calls constructors, but after the bit
11267 of startup code from AVR-LibC that sets @code{EIND} to the segment
11268 where the vector table is located.
11269 @example
11270 #include <avr/io.h>
11271
11272 static void
11273 __attribute__((section(".init3"),naked,used,no_instrument_function))
11274 init3_set_eind (void)
11275 @{
11276 __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11277 "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11278 @}
11279 @end example
11280
11281 @noindent
11282 The @code{__trampolines_start} symbol is defined in the linker script.
11283
11284 @item
11285 Stubs are generated automatically by the linker if
11286 the following two conditions are met:
11287 @itemize @minus
11288
11289 @item The address of a label is taken by means of the @code{gs} modifier
11290 (short for @emph{generate stubs}) like so:
11291 @example
11292 LDI r24, lo8(gs(@var{func}))
11293 LDI r25, hi8(gs(@var{func}))
11294 @end example
11295 @item The final location of that label is in a code segment
11296 @emph{outside} the segment where the stubs are located.
11297 @end itemize
11298
11299 @item
11300 The compiler emits such @code{gs} modifiers for code labels in the
11301 following situations:
11302 @itemize @minus
11303 @item Taking address of a function or code label.
11304 @item Computed goto.
11305 @item If prologue-save function is used, see @option{-mcall-prologues}
11306 command-line option.
11307 @item Switch/case dispatch tables. If you do not want such dispatch
11308 tables you can specify the @option{-fno-jump-tables} command-line option.
11309 @item C and C++ constructors/destructors called during startup/shutdown.
11310 @item If the tools hit a @code{gs()} modifier explained above.
11311 @end itemize
11312
11313 @item
11314 Jumping to non-symbolic addresses like so is @emph{not} supported:
11315
11316 @example
11317 int main (void)
11318 @{
11319 /* Call function at word address 0x2 */
11320 return ((int(*)(void)) 0x2)();
11321 @}
11322 @end example
11323
11324 Instead, a stub has to be set up, i.e.@: the function has to be called
11325 through a symbol (@code{func_4} in the example):
11326
11327 @example
11328 int main (void)
11329 @{
11330 extern int func_4 (void);
11331
11332 /* Call function at byte address 0x4 */
11333 return func_4();
11334 @}
11335 @end example
11336
11337 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11338 Alternatively, @code{func_4} can be defined in the linker script.
11339 @end itemize
11340
11341 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11342 @cindex @code{RAMPD}
11343 @cindex @code{RAMPX}
11344 @cindex @code{RAMPY}
11345 @cindex @code{RAMPZ}
11346 Some AVR devices support memories larger than the 64@tie{}KiB range
11347 that can be accessed with 16-bit pointers. To access memory locations
11348 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11349 register is used as high part of the address:
11350 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11351 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11352 register, respectively, to get a wide address. Similarly,
11353 @code{RAMPD} is used together with direct addressing.
11354
11355 @itemize
11356 @item
11357 The startup code initializes the @code{RAMP} special function
11358 registers with zero.
11359
11360 @item
11361 If a @ref{AVR Named Address Spaces,named address space} other than
11362 generic or @code{__flash} is used, then @code{RAMPZ} is set
11363 as needed before the operation.
11364
11365 @item
11366 If the device supports RAM larger than 64@tie{KiB} and the compiler
11367 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11368 is reset to zero after the operation.
11369
11370 @item
11371 If the device comes with a specific @code{RAMP} register, the ISR
11372 prologue/epilogue saves/restores that SFR and initializes it with
11373 zero in case the ISR code might (implicitly) use it.
11374
11375 @item
11376 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11377 If you use inline assembler to read from locations outside the
11378 16-bit address range and change one of the @code{RAMP} registers,
11379 you must reset it to zero after the access.
11380
11381 @end itemize
11382
11383 @subsubsection AVR Built-in Macros
11384
11385 GCC defines several built-in macros so that the user code can test
11386 for the presence or absence of features. Almost any of the following
11387 built-in macros are deduced from device capabilities and thus
11388 triggered by the @code{-mmcu=} command-line option.
11389
11390 For even more AVR-specific built-in macros see
11391 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11392
11393 @table @code
11394
11395 @item __AVR_@var{Device}__
11396 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11397 the device's name. For example, @code{-mmcu=atmega8} defines the
11398 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11399 @code{__AVR_ATtiny261A__}, etc.
11400
11401 The built-in macros' names follow
11402 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11403 the device name as from the AVR user manual. The difference between
11404 @var{Device} in the built-in macro and @var{device} in
11405 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11406
11407 @item __AVR_HAVE_ELPM__
11408 The device has the the @code{ELPM} instruction.
11409
11410 @item __AVR_HAVE_ELPMX__
11411 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11412 R@var{n},Z+} instructions.
11413
11414 @item __AVR_HAVE_MOVW__
11415 The device has the @code{MOVW} instruction to perform 16-bit
11416 register-register moves.
11417
11418 @item __AVR_HAVE_LPMX__
11419 The device has the @code{LPM R@var{n},Z} and
11420 @code{LPM R@var{n},Z+} instructions.
11421
11422 @item __AVR_HAVE_MUL__
11423 The device has a hardware multiplier.
11424
11425 @item __AVR_HAVE_JMP_CALL__
11426 The device has the @code{JMP} and @code{CALL} instructions.
11427 This is the case for devices with at least 16@tie{}KiB of program
11428 memory and if @code{-mshort-calls} is not set.
11429
11430 @item __AVR_HAVE_EIJMP_EICALL__
11431 @item __AVR_3_BYTE_PC__
11432 The device has the @code{EIJMP} and @code{EICALL} instructions.
11433 This is the case for devices with more than 128@tie{}KiB of program memory.
11434 This also means that the program counter
11435 (PC) is 3@tie{}bytes wide.
11436
11437 @item __AVR_2_BYTE_PC__
11438 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11439 with up to 128@tie{}KiB of program memory.
11440
11441 @item __AVR_HAVE_8BIT_SP__
11442 @item __AVR_HAVE_16BIT_SP__
11443 The stack pointer (SP) register is treated as 8-bit respectively
11444 16-bit register by the compiler.
11445 The definition of these macros is affected by @code{-mtiny-stack}.
11446
11447 @item __AVR_HAVE_SPH__
11448 @item __AVR_SP8__
11449 The device has the SPH (high part of stack pointer) special function
11450 register or has an 8-bit stack pointer, respectively.
11451 The definition of these macros is affected by @code{-mmcu=} and
11452 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11453 by @code{-msp8}.
11454
11455 @item __AVR_HAVE_RAMPD__
11456 @item __AVR_HAVE_RAMPX__
11457 @item __AVR_HAVE_RAMPY__
11458 @item __AVR_HAVE_RAMPZ__
11459 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11460 @code{RAMPZ} special function register, respectively.
11461
11462 @item __NO_INTERRUPTS__
11463 This macro reflects the @code{-mno-interrupts} command line option.
11464
11465 @item __AVR_ERRATA_SKIP__
11466 @item __AVR_ERRATA_SKIP_JMP_CALL__
11467 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11468 instructions because of a hardware erratum. Skip instructions are
11469 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11470 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11471 set.
11472
11473 @item __AVR_SFR_OFFSET__=@var{offset}
11474 Instructions that can address I/O special function registers directly
11475 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11476 address as if addressed by an instruction to access RAM like @code{LD}
11477 or @code{STS}. This offset depends on the device architecture and has
11478 to be subtracted from the RAM address in order to get the
11479 respective I/O@tie{}address.
11480
11481 @end table
11482
11483 @node Blackfin Options
11484 @subsection Blackfin Options
11485 @cindex Blackfin Options
11486
11487 @table @gcctabopt
11488 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11489 @opindex mcpu=
11490 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
11491 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11492 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11493 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11494 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11495 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11496 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11497 @samp{bf561}, @samp{bf592}.
11498 The optional @var{sirevision} specifies the silicon revision of the target
11499 Blackfin processor. Any workarounds available for the targeted silicon revision
11500 are enabled. If @var{sirevision} is @samp{none}, no workarounds are enabled.
11501 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11502 are enabled. The @code{__SILICON_REVISION__} macro is defined to two
11503 hexadecimal digits representing the major and minor numbers in the silicon
11504 revision. If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11505 is not defined. If @var{sirevision} is @samp{any}, the
11506 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11507 If this optional @var{sirevision} is not used, GCC assumes the latest known
11508 silicon revision of the targeted Blackfin processor.
11509
11510 Support for @samp{bf561} is incomplete. For @samp{bf561},
11511 Only the processor macro is defined.
11512 Without this option, @samp{bf532} is used as the processor by default.
11513 The corresponding predefined processor macros for @var{cpu} is to
11514 be defined. And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11515 provided by libgloss to be linked in if @option{-msim} is not given.
11516
11517 @item -msim
11518 @opindex msim
11519 Specifies that the program will be run on the simulator. This causes
11520 the simulator BSP provided by libgloss to be linked in. This option
11521 has effect only for @samp{bfin-elf} toolchain.
11522 Certain other options, such as @option{-mid-shared-library} and
11523 @option{-mfdpic}, imply @option{-msim}.
11524
11525 @item -momit-leaf-frame-pointer
11526 @opindex momit-leaf-frame-pointer
11527 Don't keep the frame pointer in a register for leaf functions. This
11528 avoids the instructions to save, set up and restore frame pointers and
11529 makes an extra register available in leaf functions. The option
11530 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11531 which might make debugging harder.
11532
11533 @item -mspecld-anomaly
11534 @opindex mspecld-anomaly
11535 When enabled, the compiler ensures that the generated code does not
11536 contain speculative loads after jump instructions. If this option is used,
11537 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11538
11539 @item -mno-specld-anomaly
11540 @opindex mno-specld-anomaly
11541 Don't generate extra code to prevent speculative loads from occurring.
11542
11543 @item -mcsync-anomaly
11544 @opindex mcsync-anomaly
11545 When enabled, the compiler ensures that the generated code does not
11546 contain CSYNC or SSYNC instructions too soon after conditional branches.
11547 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11548
11549 @item -mno-csync-anomaly
11550 @opindex mno-csync-anomaly
11551 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11552 occurring too soon after a conditional branch.
11553
11554 @item -mlow-64k
11555 @opindex mlow-64k
11556 When enabled, the compiler is free to take advantage of the knowledge that
11557 the entire program fits into the low 64k of memory.
11558
11559 @item -mno-low-64k
11560 @opindex mno-low-64k
11561 Assume that the program is arbitrarily large. This is the default.
11562
11563 @item -mstack-check-l1
11564 @opindex mstack-check-l1
11565 Do stack checking using information placed into L1 scratchpad memory by the
11566 uClinux kernel.
11567
11568 @item -mid-shared-library
11569 @opindex mid-shared-library
11570 Generate code that supports shared libraries via the library ID method.
11571 This allows for execute in place and shared libraries in an environment
11572 without virtual memory management. This option implies @option{-fPIC}.
11573 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11574
11575 @item -mno-id-shared-library
11576 @opindex mno-id-shared-library
11577 Generate code that doesn't assume ID based shared libraries are being used.
11578 This is the default.
11579
11580 @item -mleaf-id-shared-library
11581 @opindex mleaf-id-shared-library
11582 Generate code that supports shared libraries via the library ID method,
11583 but assumes that this library or executable won't link against any other
11584 ID shared libraries. That allows the compiler to use faster code for jumps
11585 and calls.
11586
11587 @item -mno-leaf-id-shared-library
11588 @opindex mno-leaf-id-shared-library
11589 Do not assume that the code being compiled won't link against any ID shared
11590 libraries. Slower code is generated for jump and call insns.
11591
11592 @item -mshared-library-id=n
11593 @opindex mshared-library-id
11594 Specifies the identification number of the ID-based shared library being
11595 compiled. Specifying a value of 0 generates more compact code; specifying
11596 other values forces the allocation of that number to the current
11597 library but is no more space- or time-efficient than omitting this option.
11598
11599 @item -msep-data
11600 @opindex msep-data
11601 Generate code that allows the data segment to be located in a different
11602 area of memory from the text segment. This allows for execute in place in
11603 an environment without virtual memory management by eliminating relocations
11604 against the text section.
11605
11606 @item -mno-sep-data
11607 @opindex mno-sep-data
11608 Generate code that assumes that the data segment follows the text segment.
11609 This is the default.
11610
11611 @item -mlong-calls
11612 @itemx -mno-long-calls
11613 @opindex mlong-calls
11614 @opindex mno-long-calls
11615 Tells the compiler to perform function calls by first loading the
11616 address of the function into a register and then performing a subroutine
11617 call on this register. This switch is needed if the target function
11618 lies outside of the 24-bit addressing range of the offset-based
11619 version of subroutine call instruction.
11620
11621 This feature is not enabled by default. Specifying
11622 @option{-mno-long-calls} restores the default behavior. Note these
11623 switches have no effect on how the compiler generates code to handle
11624 function calls via function pointers.
11625
11626 @item -mfast-fp
11627 @opindex mfast-fp
11628 Link with the fast floating-point library. This library relaxes some of
11629 the IEEE floating-point standard's rules for checking inputs against
11630 Not-a-Number (NAN), in the interest of performance.
11631
11632 @item -minline-plt
11633 @opindex minline-plt
11634 Enable inlining of PLT entries in function calls to functions that are
11635 not known to bind locally. It has no effect without @option{-mfdpic}.
11636
11637 @item -mmulticore
11638 @opindex mmulticore
11639 Build standalone application for multicore Blackfin processor. Proper
11640 start files and link scripts are used to support multicore.
11641 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11642 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11643 @option{-mcorea} or @option{-mcoreb}. If it's used without
11644 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11645 programming model is used. In this model, the main function of Core B
11646 should be named as coreb_main. If it's used with @option{-mcorea} or
11647 @option{-mcoreb}, one application per core programming model is used.
11648 If this option is not used, single core application programming
11649 model is used.
11650
11651 @item -mcorea
11652 @opindex mcorea
11653 Build standalone application for Core A of BF561 when using
11654 one application per core programming model. Proper start files
11655 and link scripts are used to support Core A. This option
11656 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11657
11658 @item -mcoreb
11659 @opindex mcoreb
11660 Build standalone application for Core B of BF561 when using
11661 one application per core programming model. Proper start files
11662 and link scripts are used to support Core B. This option
11663 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11664 should be used instead of main. It must be used with
11665 @option{-mmulticore}.
11666
11667 @item -msdram
11668 @opindex msdram
11669 Build standalone application for SDRAM. Proper start files and
11670 link scripts are used to put the application into SDRAM.
11671 Loader should initialize SDRAM before loading the application
11672 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11673
11674 @item -micplb
11675 @opindex micplb
11676 Assume that ICPLBs are enabled at run time. This has an effect on certain
11677 anomaly workarounds. For Linux targets, the default is to assume ICPLBs
11678 are enabled; for standalone applications the default is off.
11679 @end table
11680
11681 @node C6X Options
11682 @subsection C6X Options
11683 @cindex C6X Options
11684
11685 @table @gcctabopt
11686 @item -march=@var{name}
11687 @opindex march
11688 This specifies the name of the target architecture. GCC uses this
11689 name to determine what kind of instructions it can emit when generating
11690 assembly code. Permissible names are: @samp{c62x},
11691 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11692
11693 @item -mbig-endian
11694 @opindex mbig-endian
11695 Generate code for a big-endian target.
11696
11697 @item -mlittle-endian
11698 @opindex mlittle-endian
11699 Generate code for a little-endian target. This is the default.
11700
11701 @item -msim
11702 @opindex msim
11703 Choose startup files and linker script suitable for the simulator.
11704
11705 @item -msdata=default
11706 @opindex msdata=default
11707 Put small global and static data in the @samp{.neardata} section,
11708 which is pointed to by register @code{B14}. Put small uninitialized
11709 global and static data in the @samp{.bss} section, which is adjacent
11710 to the @samp{.neardata} section. Put small read-only data into the
11711 @samp{.rodata} section. The corresponding sections used for large
11712 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11713
11714 @item -msdata=all
11715 @opindex msdata=all
11716 Put all data, not just small objets, into the sections reserved for
11717 small data, and use addressing relative to the @code{B14} register to
11718 access them.
11719
11720 @item -msdata=none
11721 @opindex msdata=none
11722 Make no use of the sections reserved for small data, and use absolute
11723 addresses to access all data. Put all initialized global and static
11724 data in the @samp{.fardata} section, and all uninitialized data in the
11725 @samp{.far} section. Put all constant data into the @samp{.const}
11726 section.
11727 @end table
11728
11729 @node CRIS Options
11730 @subsection CRIS Options
11731 @cindex CRIS Options
11732
11733 These options are defined specifically for the CRIS ports.
11734
11735 @table @gcctabopt
11736 @item -march=@var{architecture-type}
11737 @itemx -mcpu=@var{architecture-type}
11738 @opindex march
11739 @opindex mcpu
11740 Generate code for the specified architecture. The choices for
11741 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11742 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11743 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11744 @samp{v10}.
11745
11746 @item -mtune=@var{architecture-type}
11747 @opindex mtune
11748 Tune to @var{architecture-type} everything applicable about the generated
11749 code, except for the ABI and the set of available instructions. The
11750 choices for @var{architecture-type} are the same as for
11751 @option{-march=@var{architecture-type}}.
11752
11753 @item -mmax-stack-frame=@var{n}
11754 @opindex mmax-stack-frame
11755 Warn when the stack frame of a function exceeds @var{n} bytes.
11756
11757 @item -metrax4
11758 @itemx -metrax100
11759 @opindex metrax4
11760 @opindex metrax100
11761 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11762 @option{-march=v3} and @option{-march=v8} respectively.
11763
11764 @item -mmul-bug-workaround
11765 @itemx -mno-mul-bug-workaround
11766 @opindex mmul-bug-workaround
11767 @opindex mno-mul-bug-workaround
11768 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11769 models where it applies. This option is active by default.
11770
11771 @item -mpdebug
11772 @opindex mpdebug
11773 Enable CRIS-specific verbose debug-related information in the assembly
11774 code. This option also has the effect to turn off the @samp{#NO_APP}
11775 formatted-code indicator to the assembler at the beginning of the
11776 assembly file.
11777
11778 @item -mcc-init
11779 @opindex mcc-init
11780 Do not use condition-code results from previous instruction; always emit
11781 compare and test instructions before use of condition codes.
11782
11783 @item -mno-side-effects
11784 @opindex mno-side-effects
11785 Do not emit instructions with side-effects in addressing modes other than
11786 post-increment.
11787
11788 @item -mstack-align
11789 @itemx -mno-stack-align
11790 @itemx -mdata-align
11791 @itemx -mno-data-align
11792 @itemx -mconst-align
11793 @itemx -mno-const-align
11794 @opindex mstack-align
11795 @opindex mno-stack-align
11796 @opindex mdata-align
11797 @opindex mno-data-align
11798 @opindex mconst-align
11799 @opindex mno-const-align
11800 These options (no-options) arranges (eliminate arrangements) for the
11801 stack-frame, individual data and constants to be aligned for the maximum
11802 single data access size for the chosen CPU model. The default is to
11803 arrange for 32-bit alignment. ABI details such as structure layout are
11804 not affected by these options.
11805
11806 @item -m32-bit
11807 @itemx -m16-bit
11808 @itemx -m8-bit
11809 @opindex m32-bit
11810 @opindex m16-bit
11811 @opindex m8-bit
11812 Similar to the stack- data- and const-align options above, these options
11813 arrange for stack-frame, writable data and constants to all be 32-bit,
11814 16-bit or 8-bit aligned. The default is 32-bit alignment.
11815
11816 @item -mno-prologue-epilogue
11817 @itemx -mprologue-epilogue
11818 @opindex mno-prologue-epilogue
11819 @opindex mprologue-epilogue
11820 With @option{-mno-prologue-epilogue}, the normal function prologue and
11821 epilogue which set up the stack frame are omitted and no return
11822 instructions or return sequences are generated in the code. Use this
11823 option only together with visual inspection of the compiled code: no
11824 warnings or errors are generated when call-saved registers must be saved,
11825 or storage for local variable needs to be allocated.
11826
11827 @item -mno-gotplt
11828 @itemx -mgotplt
11829 @opindex mno-gotplt
11830 @opindex mgotplt
11831 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11832 instruction sequences that load addresses for functions from the PLT part
11833 of the GOT rather than (traditional on other architectures) calls to the
11834 PLT@. The default is @option{-mgotplt}.
11835
11836 @item -melf
11837 @opindex melf
11838 Legacy no-op option only recognized with the cris-axis-elf and
11839 cris-axis-linux-gnu targets.
11840
11841 @item -mlinux
11842 @opindex mlinux
11843 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11844
11845 @item -sim
11846 @opindex sim
11847 This option, recognized for the cris-axis-elf arranges
11848 to link with input-output functions from a simulator library. Code,
11849 initialized data and zero-initialized data are allocated consecutively.
11850
11851 @item -sim2
11852 @opindex sim2
11853 Like @option{-sim}, but pass linker options to locate initialized data at
11854 0x40000000 and zero-initialized data at 0x80000000.
11855 @end table
11856
11857 @node CR16 Options
11858 @subsection CR16 Options
11859 @cindex CR16 Options
11860
11861 These options are defined specifically for the CR16 ports.
11862
11863 @table @gcctabopt
11864
11865 @item -mmac
11866 @opindex mmac
11867 Enable the use of multiply-accumulate instructions. Disabled by default.
11868
11869 @item -mcr16cplus
11870 @itemx -mcr16c
11871 @opindex mcr16cplus
11872 @opindex mcr16c
11873 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture
11874 is default.
11875
11876 @item -msim
11877 @opindex msim
11878 Links the library libsim.a which is in compatible with simulator. Applicable
11879 to ELF compiler only.
11880
11881 @item -mint32
11882 @opindex mint32
11883 Choose integer type as 32-bit wide.
11884
11885 @item -mbit-ops
11886 @opindex mbit-ops
11887 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
11888
11889 @item -mdata-model=@var{model}
11890 @opindex mdata-model
11891 Choose a data model. The choices for @var{model} are @samp{near},
11892 @samp{far} or @samp{medium}. @samp{medium} is default.
11893 However, @samp{far} is not valid with @option{-mcr16c}, as the
11894 CR16C architecture does not support the far data model.
11895 @end table
11896
11897 @node Darwin Options
11898 @subsection Darwin Options
11899 @cindex Darwin options
11900
11901 These options are defined for all architectures running the Darwin operating
11902 system.
11903
11904 FSF GCC on Darwin does not create ``fat'' object files; it creates
11905 an object file for the single architecture that GCC was built to
11906 target. Apple's GCC on Darwin does create ``fat'' files if multiple
11907 @option{-arch} options are used; it does so by running the compiler or
11908 linker multiple times and joining the results together with
11909 @file{lipo}.
11910
11911 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11912 @samp{i686}) is determined by the flags that specify the ISA
11913 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
11914 @option{-force_cpusubtype_ALL} option can be used to override this.
11915
11916 The Darwin tools vary in their behavior when presented with an ISA
11917 mismatch. The assembler, @file{as}, only permits instructions to
11918 be used that are valid for the subtype of the file it is generating,
11919 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11920 The linker for shared libraries, @file{/usr/bin/libtool}, fails
11921 and prints an error if asked to create a shared library with a less
11922 restrictive subtype than its input files (for instance, trying to put
11923 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
11924 for executables, @command{ld}, quietly gives the executable the most
11925 restrictive subtype of any of its input files.
11926
11927 @table @gcctabopt
11928 @item -F@var{dir}
11929 @opindex F
11930 Add the framework directory @var{dir} to the head of the list of
11931 directories to be searched for header files. These directories are
11932 interleaved with those specified by @option{-I} options and are
11933 scanned in a left-to-right order.
11934
11935 A framework directory is a directory with frameworks in it. A
11936 framework is a directory with a @file{Headers} and/or
11937 @file{PrivateHeaders} directory contained directly in it that ends
11938 in @file{.framework}. The name of a framework is the name of this
11939 directory excluding the @file{.framework}. Headers associated with
11940 the framework are found in one of those two directories, with
11941 @file{Headers} being searched first. A subframework is a framework
11942 directory that is in a framework's @file{Frameworks} directory.
11943 Includes of subframework headers can only appear in a header of a
11944 framework that contains the subframework, or in a sibling subframework
11945 header. Two subframeworks are siblings if they occur in the same
11946 framework. A subframework should not have the same name as a
11947 framework; a warning is issued if this is violated. Currently a
11948 subframework cannot have subframeworks; in the future, the mechanism
11949 may be extended to support this. The standard frameworks can be found
11950 in @file{/System/Library/Frameworks} and
11951 @file{/Library/Frameworks}. An example include looks like
11952 @code{#include <Framework/header.h>}, where @file{Framework} denotes
11953 the name of the framework and @file{header.h} is found in the
11954 @file{PrivateHeaders} or @file{Headers} directory.
11955
11956 @item -iframework@var{dir}
11957 @opindex iframework
11958 Like @option{-F} except the directory is a treated as a system
11959 directory. The main difference between this @option{-iframework} and
11960 @option{-F} is that with @option{-iframework} the compiler does not
11961 warn about constructs contained within header files found via
11962 @var{dir}. This option is valid only for the C family of languages.
11963
11964 @item -gused
11965 @opindex gused
11966 Emit debugging information for symbols that are used. For stabs
11967 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11968 This is by default ON@.
11969
11970 @item -gfull
11971 @opindex gfull
11972 Emit debugging information for all symbols and types.
11973
11974 @item -mmacosx-version-min=@var{version}
11975 The earliest version of MacOS X that this executable will run on
11976 is @var{version}. Typical values of @var{version} include @code{10.1},
11977 @code{10.2}, and @code{10.3.9}.
11978
11979 If the compiler was built to use the system's headers by default,
11980 then the default for this option is the system version on which the
11981 compiler is running, otherwise the default is to make choices that
11982 are compatible with as many systems and code bases as possible.
11983
11984 @item -mkernel
11985 @opindex mkernel
11986 Enable kernel development mode. The @option{-mkernel} option sets
11987 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11988 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11989 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11990 applicable. This mode also sets @option{-mno-altivec},
11991 @option{-msoft-float}, @option{-fno-builtin} and
11992 @option{-mlong-branch} for PowerPC targets.
11993
11994 @item -mone-byte-bool
11995 @opindex mone-byte-bool
11996 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
11997 By default @samp{sizeof(bool)} is @samp{4} when compiling for
11998 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
11999 option has no effect on x86.
12000
12001 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12002 to generate code that is not binary compatible with code generated
12003 without that switch. Using this switch may require recompiling all
12004 other modules in a program, including system libraries. Use this
12005 switch to conform to a non-default data model.
12006
12007 @item -mfix-and-continue
12008 @itemx -ffix-and-continue
12009 @itemx -findirect-data
12010 @opindex mfix-and-continue
12011 @opindex ffix-and-continue
12012 @opindex findirect-data
12013 Generate code suitable for fast turn around development. Needed to
12014 enable GDB to dynamically load @code{.o} files into already running
12015 programs. @option{-findirect-data} and @option{-ffix-and-continue}
12016 are provided for backwards compatibility.
12017
12018 @item -all_load
12019 @opindex all_load
12020 Loads all members of static archive libraries.
12021 See man ld(1) for more information.
12022
12023 @item -arch_errors_fatal
12024 @opindex arch_errors_fatal
12025 Cause the errors having to do with files that have the wrong architecture
12026 to be fatal.
12027
12028 @item -bind_at_load
12029 @opindex bind_at_load
12030 Causes the output file to be marked such that the dynamic linker will
12031 bind all undefined references when the file is loaded or launched.
12032
12033 @item -bundle
12034 @opindex bundle
12035 Produce a Mach-o bundle format file.
12036 See man ld(1) for more information.
12037
12038 @item -bundle_loader @var{executable}
12039 @opindex bundle_loader
12040 This option specifies the @var{executable} that will load the build
12041 output file being linked. See man ld(1) for more information.
12042
12043 @item -dynamiclib
12044 @opindex dynamiclib
12045 When passed this option, GCC produces a dynamic library instead of
12046 an executable when linking, using the Darwin @file{libtool} command.
12047
12048 @item -force_cpusubtype_ALL
12049 @opindex force_cpusubtype_ALL
12050 This causes GCC's output file to have the @var{ALL} subtype, instead of
12051 one controlled by the @option{-mcpu} or @option{-march} option.
12052
12053 @item -allowable_client @var{client_name}
12054 @itemx -client_name
12055 @itemx -compatibility_version
12056 @itemx -current_version
12057 @itemx -dead_strip
12058 @itemx -dependency-file
12059 @itemx -dylib_file
12060 @itemx -dylinker_install_name
12061 @itemx -dynamic
12062 @itemx -exported_symbols_list
12063 @itemx -filelist
12064 @need 800
12065 @itemx -flat_namespace
12066 @itemx -force_flat_namespace
12067 @itemx -headerpad_max_install_names
12068 @itemx -image_base
12069 @itemx -init
12070 @itemx -install_name
12071 @itemx -keep_private_externs
12072 @itemx -multi_module
12073 @itemx -multiply_defined
12074 @itemx -multiply_defined_unused
12075 @need 800
12076 @itemx -noall_load
12077 @itemx -no_dead_strip_inits_and_terms
12078 @itemx -nofixprebinding
12079 @itemx -nomultidefs
12080 @itemx -noprebind
12081 @itemx -noseglinkedit
12082 @itemx -pagezero_size
12083 @itemx -prebind
12084 @itemx -prebind_all_twolevel_modules
12085 @itemx -private_bundle
12086 @need 800
12087 @itemx -read_only_relocs
12088 @itemx -sectalign
12089 @itemx -sectobjectsymbols
12090 @itemx -whyload
12091 @itemx -seg1addr
12092 @itemx -sectcreate
12093 @itemx -sectobjectsymbols
12094 @itemx -sectorder
12095 @itemx -segaddr
12096 @itemx -segs_read_only_addr
12097 @need 800
12098 @itemx -segs_read_write_addr
12099 @itemx -seg_addr_table
12100 @itemx -seg_addr_table_filename
12101 @itemx -seglinkedit
12102 @itemx -segprot
12103 @itemx -segs_read_only_addr
12104 @itemx -segs_read_write_addr
12105 @itemx -single_module
12106 @itemx -static
12107 @itemx -sub_library
12108 @need 800
12109 @itemx -sub_umbrella
12110 @itemx -twolevel_namespace
12111 @itemx -umbrella
12112 @itemx -undefined
12113 @itemx -unexported_symbols_list
12114 @itemx -weak_reference_mismatches
12115 @itemx -whatsloaded
12116 @opindex allowable_client
12117 @opindex client_name
12118 @opindex compatibility_version
12119 @opindex current_version
12120 @opindex dead_strip
12121 @opindex dependency-file
12122 @opindex dylib_file
12123 @opindex dylinker_install_name
12124 @opindex dynamic
12125 @opindex exported_symbols_list
12126 @opindex filelist
12127 @opindex flat_namespace
12128 @opindex force_flat_namespace
12129 @opindex headerpad_max_install_names
12130 @opindex image_base
12131 @opindex init
12132 @opindex install_name
12133 @opindex keep_private_externs
12134 @opindex multi_module
12135 @opindex multiply_defined
12136 @opindex multiply_defined_unused
12137 @opindex noall_load
12138 @opindex no_dead_strip_inits_and_terms
12139 @opindex nofixprebinding
12140 @opindex nomultidefs
12141 @opindex noprebind
12142 @opindex noseglinkedit
12143 @opindex pagezero_size
12144 @opindex prebind
12145 @opindex prebind_all_twolevel_modules
12146 @opindex private_bundle
12147 @opindex read_only_relocs
12148 @opindex sectalign
12149 @opindex sectobjectsymbols
12150 @opindex whyload
12151 @opindex seg1addr
12152 @opindex sectcreate
12153 @opindex sectobjectsymbols
12154 @opindex sectorder
12155 @opindex segaddr
12156 @opindex segs_read_only_addr
12157 @opindex segs_read_write_addr
12158 @opindex seg_addr_table
12159 @opindex seg_addr_table_filename
12160 @opindex seglinkedit
12161 @opindex segprot
12162 @opindex segs_read_only_addr
12163 @opindex segs_read_write_addr
12164 @opindex single_module
12165 @opindex static
12166 @opindex sub_library
12167 @opindex sub_umbrella
12168 @opindex twolevel_namespace
12169 @opindex umbrella
12170 @opindex undefined
12171 @opindex unexported_symbols_list
12172 @opindex weak_reference_mismatches
12173 @opindex whatsloaded
12174 These options are passed to the Darwin linker. The Darwin linker man page
12175 describes them in detail.
12176 @end table
12177
12178 @node DEC Alpha Options
12179 @subsection DEC Alpha Options
12180
12181 These @samp{-m} options are defined for the DEC Alpha implementations:
12182
12183 @table @gcctabopt
12184 @item -mno-soft-float
12185 @itemx -msoft-float
12186 @opindex mno-soft-float
12187 @opindex msoft-float
12188 Use (do not use) the hardware floating-point instructions for
12189 floating-point operations. When @option{-msoft-float} is specified,
12190 functions in @file{libgcc.a} are used to perform floating-point
12191 operations. Unless they are replaced by routines that emulate the
12192 floating-point operations, or compiled in such a way as to call such
12193 emulations routines, these routines issue floating-point
12194 operations. If you are compiling for an Alpha without floating-point
12195 operations, you must ensure that the library is built so as not to call
12196 them.
12197
12198 Note that Alpha implementations without floating-point operations are
12199 required to have floating-point registers.
12200
12201 @item -mfp-reg
12202 @itemx -mno-fp-regs
12203 @opindex mfp-reg
12204 @opindex mno-fp-regs
12205 Generate code that uses (does not use) the floating-point register set.
12206 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
12207 register set is not used, floating-point operands are passed in integer
12208 registers as if they were integers and floating-point results are passed
12209 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
12210 so any function with a floating-point argument or return value called by code
12211 compiled with @option{-mno-fp-regs} must also be compiled with that
12212 option.
12213
12214 A typical use of this option is building a kernel that does not use,
12215 and hence need not save and restore, any floating-point registers.
12216
12217 @item -mieee
12218 @opindex mieee
12219 The Alpha architecture implements floating-point hardware optimized for
12220 maximum performance. It is mostly compliant with the IEEE floating-point
12221 standard. However, for full compliance, software assistance is
12222 required. This option generates code fully IEEE-compliant code
12223 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12224 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12225 defined during compilation. The resulting code is less efficient but is
12226 able to correctly support denormalized numbers and exceptional IEEE
12227 values such as not-a-number and plus/minus infinity. Other Alpha
12228 compilers call this option @option{-ieee_with_no_inexact}.
12229
12230 @item -mieee-with-inexact
12231 @opindex mieee-with-inexact
12232 This is like @option{-mieee} except the generated code also maintains
12233 the IEEE @var{inexact-flag}. Turning on this option causes the
12234 generated code to implement fully-compliant IEEE math. In addition to
12235 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12236 macro. On some Alpha implementations the resulting code may execute
12237 significantly slower than the code generated by default. Since there is
12238 very little code that depends on the @var{inexact-flag}, you should
12239 normally not specify this option. Other Alpha compilers call this
12240 option @option{-ieee_with_inexact}.
12241
12242 @item -mfp-trap-mode=@var{trap-mode}
12243 @opindex mfp-trap-mode
12244 This option controls what floating-point related traps are enabled.
12245 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12246 The trap mode can be set to one of four values:
12247
12248 @table @samp
12249 @item n
12250 This is the default (normal) setting. The only traps that are enabled
12251 are the ones that cannot be disabled in software (e.g., division by zero
12252 trap).
12253
12254 @item u
12255 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12256 as well.
12257
12258 @item su
12259 Like @samp{u}, but the instructions are marked to be safe for software
12260 completion (see Alpha architecture manual for details).
12261
12262 @item sui
12263 Like @samp{su}, but inexact traps are enabled as well.
12264 @end table
12265
12266 @item -mfp-rounding-mode=@var{rounding-mode}
12267 @opindex mfp-rounding-mode
12268 Selects the IEEE rounding mode. Other Alpha compilers call this option
12269 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
12270 of:
12271
12272 @table @samp
12273 @item n
12274 Normal IEEE rounding mode. Floating-point numbers are rounded towards
12275 the nearest machine number or towards the even machine number in case
12276 of a tie.
12277
12278 @item m
12279 Round towards minus infinity.
12280
12281 @item c
12282 Chopped rounding mode. Floating-point numbers are rounded towards zero.
12283
12284 @item d
12285 Dynamic rounding mode. A field in the floating-point control register
12286 (@var{fpcr}, see Alpha architecture reference manual) controls the
12287 rounding mode in effect. The C library initializes this register for
12288 rounding towards plus infinity. Thus, unless your program modifies the
12289 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12290 @end table
12291
12292 @item -mtrap-precision=@var{trap-precision}
12293 @opindex mtrap-precision
12294 In the Alpha architecture, floating-point traps are imprecise. This
12295 means without software assistance it is impossible to recover from a
12296 floating trap and program execution normally needs to be terminated.
12297 GCC can generate code that can assist operating system trap handlers
12298 in determining the exact location that caused a floating-point trap.
12299 Depending on the requirements of an application, different levels of
12300 precisions can be selected:
12301
12302 @table @samp
12303 @item p
12304 Program precision. This option is the default and means a trap handler
12305 can only identify which program caused a floating-point exception.
12306
12307 @item f
12308 Function precision. The trap handler can determine the function that
12309 caused a floating-point exception.
12310
12311 @item i
12312 Instruction precision. The trap handler can determine the exact
12313 instruction that caused a floating-point exception.
12314 @end table
12315
12316 Other Alpha compilers provide the equivalent options called
12317 @option{-scope_safe} and @option{-resumption_safe}.
12318
12319 @item -mieee-conformant
12320 @opindex mieee-conformant
12321 This option marks the generated code as IEEE conformant. You must not
12322 use this option unless you also specify @option{-mtrap-precision=i} and either
12323 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
12324 is to emit the line @samp{.eflag 48} in the function prologue of the
12325 generated assembly file.
12326
12327 @item -mbuild-constants
12328 @opindex mbuild-constants
12329 Normally GCC examines a 32- or 64-bit integer constant to
12330 see if it can construct it from smaller constants in two or three
12331 instructions. If it cannot, it outputs the constant as a literal and
12332 generates code to load it from the data segment at run time.
12333
12334 Use this option to require GCC to construct @emph{all} integer constants
12335 using code, even if it takes more instructions (the maximum is six).
12336
12337 You typically use this option to build a shared library dynamic
12338 loader. Itself a shared library, it must relocate itself in memory
12339 before it can find the variables and constants in its own data segment.
12340
12341 @item -mbwx
12342 @itemx -mno-bwx
12343 @itemx -mcix
12344 @itemx -mno-cix
12345 @itemx -mfix
12346 @itemx -mno-fix
12347 @itemx -mmax
12348 @itemx -mno-max
12349 @opindex mbwx
12350 @opindex mno-bwx
12351 @opindex mcix
12352 @opindex mno-cix
12353 @opindex mfix
12354 @opindex mno-fix
12355 @opindex mmax
12356 @opindex mno-max
12357 Indicate whether GCC should generate code to use the optional BWX,
12358 CIX, FIX and MAX instruction sets. The default is to use the instruction
12359 sets supported by the CPU type specified via @option{-mcpu=} option or that
12360 of the CPU on which GCC was built if none is specified.
12361
12362 @item -mfloat-vax
12363 @itemx -mfloat-ieee
12364 @opindex mfloat-vax
12365 @opindex mfloat-ieee
12366 Generate code that uses (does not use) VAX F and G floating-point
12367 arithmetic instead of IEEE single and double precision.
12368
12369 @item -mexplicit-relocs
12370 @itemx -mno-explicit-relocs
12371 @opindex mexplicit-relocs
12372 @opindex mno-explicit-relocs
12373 Older Alpha assemblers provided no way to generate symbol relocations
12374 except via assembler macros. Use of these macros does not allow
12375 optimal instruction scheduling. GNU binutils as of version 2.12
12376 supports a new syntax that allows the compiler to explicitly mark
12377 which relocations should apply to which instructions. This option
12378 is mostly useful for debugging, as GCC detects the capabilities of
12379 the assembler when it is built and sets the default accordingly.
12380
12381 @item -msmall-data
12382 @itemx -mlarge-data
12383 @opindex msmall-data
12384 @opindex mlarge-data
12385 When @option{-mexplicit-relocs} is in effect, static data is
12386 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
12387 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12388 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12389 16-bit relocations off of the @code{$gp} register. This limits the
12390 size of the small data area to 64KB, but allows the variables to be
12391 directly accessed via a single instruction.
12392
12393 The default is @option{-mlarge-data}. With this option the data area
12394 is limited to just below 2GB@. Programs that require more than 2GB of
12395 data must use @code{malloc} or @code{mmap} to allocate the data in the
12396 heap instead of in the program's data segment.
12397
12398 When generating code for shared libraries, @option{-fpic} implies
12399 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12400
12401 @item -msmall-text
12402 @itemx -mlarge-text
12403 @opindex msmall-text
12404 @opindex mlarge-text
12405 When @option{-msmall-text} is used, the compiler assumes that the
12406 code of the entire program (or shared library) fits in 4MB, and is
12407 thus reachable with a branch instruction. When @option{-msmall-data}
12408 is used, the compiler can assume that all local symbols share the
12409 same @code{$gp} value, and thus reduce the number of instructions
12410 required for a function call from 4 to 1.
12411
12412 The default is @option{-mlarge-text}.
12413
12414 @item -mcpu=@var{cpu_type}
12415 @opindex mcpu
12416 Set the instruction set and instruction scheduling parameters for
12417 machine type @var{cpu_type}. You can specify either the @samp{EV}
12418 style name or the corresponding chip number. GCC supports scheduling
12419 parameters for the EV4, EV5 and EV6 family of processors and
12420 chooses the default values for the instruction set from the processor
12421 you specify. If you do not specify a processor type, GCC defaults
12422 to the processor on which the compiler was built.
12423
12424 Supported values for @var{cpu_type} are
12425
12426 @table @samp
12427 @item ev4
12428 @itemx ev45
12429 @itemx 21064
12430 Schedules as an EV4 and has no instruction set extensions.
12431
12432 @item ev5
12433 @itemx 21164
12434 Schedules as an EV5 and has no instruction set extensions.
12435
12436 @item ev56
12437 @itemx 21164a
12438 Schedules as an EV5 and supports the BWX extension.
12439
12440 @item pca56
12441 @itemx 21164pc
12442 @itemx 21164PC
12443 Schedules as an EV5 and supports the BWX and MAX extensions.
12444
12445 @item ev6
12446 @itemx 21264
12447 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12448
12449 @item ev67
12450 @itemx 21264a
12451 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12452 @end table
12453
12454 Native toolchains also support the value @samp{native},
12455 which selects the best architecture option for the host processor.
12456 @option{-mcpu=native} has no effect if GCC does not recognize
12457 the processor.
12458
12459 @item -mtune=@var{cpu_type}
12460 @opindex mtune
12461 Set only the instruction scheduling parameters for machine type
12462 @var{cpu_type}. The instruction set is not changed.
12463
12464 Native toolchains also support the value @samp{native},
12465 which selects the best architecture option for the host processor.
12466 @option{-mtune=native} has no effect if GCC does not recognize
12467 the processor.
12468
12469 @item -mmemory-latency=@var{time}
12470 @opindex mmemory-latency
12471 Sets the latency the scheduler should assume for typical memory
12472 references as seen by the application. This number is highly
12473 dependent on the memory access patterns used by the application
12474 and the size of the external cache on the machine.
12475
12476 Valid options for @var{time} are
12477
12478 @table @samp
12479 @item @var{number}
12480 A decimal number representing clock cycles.
12481
12482 @item L1
12483 @itemx L2
12484 @itemx L3
12485 @itemx main
12486 The compiler contains estimates of the number of clock cycles for
12487 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12488 (also called Dcache, Scache, and Bcache), as well as to main memory.
12489 Note that L3 is only valid for EV5.
12490
12491 @end table
12492 @end table
12493
12494 @node FR30 Options
12495 @subsection FR30 Options
12496 @cindex FR30 Options
12497
12498 These options are defined specifically for the FR30 port.
12499
12500 @table @gcctabopt
12501
12502 @item -msmall-model
12503 @opindex msmall-model
12504 Use the small address space model. This can produce smaller code, but
12505 it does assume that all symbolic values and addresses fit into a
12506 20-bit range.
12507
12508 @item -mno-lsim
12509 @opindex mno-lsim
12510 Assume that runtime support has been provided and so there is no need
12511 to include the simulator library (@file{libsim.a}) on the linker
12512 command line.
12513
12514 @end table
12515
12516 @node FRV Options
12517 @subsection FRV Options
12518 @cindex FRV Options
12519
12520 @table @gcctabopt
12521 @item -mgpr-32
12522 @opindex mgpr-32
12523
12524 Only use the first 32 general-purpose registers.
12525
12526 @item -mgpr-64
12527 @opindex mgpr-64
12528
12529 Use all 64 general-purpose registers.
12530
12531 @item -mfpr-32
12532 @opindex mfpr-32
12533
12534 Use only the first 32 floating-point registers.
12535
12536 @item -mfpr-64
12537 @opindex mfpr-64
12538
12539 Use all 64 floating-point registers.
12540
12541 @item -mhard-float
12542 @opindex mhard-float
12543
12544 Use hardware instructions for floating-point operations.
12545
12546 @item -msoft-float
12547 @opindex msoft-float
12548
12549 Use library routines for floating-point operations.
12550
12551 @item -malloc-cc
12552 @opindex malloc-cc
12553
12554 Dynamically allocate condition code registers.
12555
12556 @item -mfixed-cc
12557 @opindex mfixed-cc
12558
12559 Do not try to dynamically allocate condition code registers, only
12560 use @code{icc0} and @code{fcc0}.
12561
12562 @item -mdword
12563 @opindex mdword
12564
12565 Change ABI to use double word insns.
12566
12567 @item -mno-dword
12568 @opindex mno-dword
12569
12570 Do not use double word instructions.
12571
12572 @item -mdouble
12573 @opindex mdouble
12574
12575 Use floating-point double instructions.
12576
12577 @item -mno-double
12578 @opindex mno-double
12579
12580 Do not use floating-point double instructions.
12581
12582 @item -mmedia
12583 @opindex mmedia
12584
12585 Use media instructions.
12586
12587 @item -mno-media
12588 @opindex mno-media
12589
12590 Do not use media instructions.
12591
12592 @item -mmuladd
12593 @opindex mmuladd
12594
12595 Use multiply and add/subtract instructions.
12596
12597 @item -mno-muladd
12598 @opindex mno-muladd
12599
12600 Do not use multiply and add/subtract instructions.
12601
12602 @item -mfdpic
12603 @opindex mfdpic
12604
12605 Select the FDPIC ABI, which uses function descriptors to represent
12606 pointers to functions. Without any PIC/PIE-related options, it
12607 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
12608 assumes GOT entries and small data are within a 12-bit range from the
12609 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12610 are computed with 32 bits.
12611 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12612
12613 @item -minline-plt
12614 @opindex minline-plt
12615
12616 Enable inlining of PLT entries in function calls to functions that are
12617 not known to bind locally. It has no effect without @option{-mfdpic}.
12618 It's enabled by default if optimizing for speed and compiling for
12619 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12620 optimization option such as @option{-O3} or above is present in the
12621 command line.
12622
12623 @item -mTLS
12624 @opindex mTLS
12625
12626 Assume a large TLS segment when generating thread-local code.
12627
12628 @item -mtls
12629 @opindex mtls
12630
12631 Do not assume a large TLS segment when generating thread-local code.
12632
12633 @item -mgprel-ro
12634 @opindex mgprel-ro
12635
12636 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12637 that is known to be in read-only sections. It's enabled by default,
12638 except for @option{-fpic} or @option{-fpie}: even though it may help
12639 make the global offset table smaller, it trades 1 instruction for 4.
12640 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12641 one of which may be shared by multiple symbols, and it avoids the need
12642 for a GOT entry for the referenced symbol, so it's more likely to be a
12643 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
12644
12645 @item -multilib-library-pic
12646 @opindex multilib-library-pic
12647
12648 Link with the (library, not FD) pic libraries. It's implied by
12649 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12650 @option{-fpic} without @option{-mfdpic}. You should never have to use
12651 it explicitly.
12652
12653 @item -mlinked-fp
12654 @opindex mlinked-fp
12655
12656 Follow the EABI requirement of always creating a frame pointer whenever
12657 a stack frame is allocated. This option is enabled by default and can
12658 be disabled with @option{-mno-linked-fp}.
12659
12660 @item -mlong-calls
12661 @opindex mlong-calls
12662
12663 Use indirect addressing to call functions outside the current
12664 compilation unit. This allows the functions to be placed anywhere
12665 within the 32-bit address space.
12666
12667 @item -malign-labels
12668 @opindex malign-labels
12669
12670 Try to align labels to an 8-byte boundary by inserting nops into the
12671 previous packet. This option only has an effect when VLIW packing
12672 is enabled. It doesn't create new packets; it merely adds nops to
12673 existing ones.
12674
12675 @item -mlibrary-pic
12676 @opindex mlibrary-pic
12677
12678 Generate position-independent EABI code.
12679
12680 @item -macc-4
12681 @opindex macc-4
12682
12683 Use only the first four media accumulator registers.
12684
12685 @item -macc-8
12686 @opindex macc-8
12687
12688 Use all eight media accumulator registers.
12689
12690 @item -mpack
12691 @opindex mpack
12692
12693 Pack VLIW instructions.
12694
12695 @item -mno-pack
12696 @opindex mno-pack
12697
12698 Do not pack VLIW instructions.
12699
12700 @item -mno-eflags
12701 @opindex mno-eflags
12702
12703 Do not mark ABI switches in e_flags.
12704
12705 @item -mcond-move
12706 @opindex mcond-move
12707
12708 Enable the use of conditional-move instructions (default).
12709
12710 This switch is mainly for debugging the compiler and will likely be removed
12711 in a future version.
12712
12713 @item -mno-cond-move
12714 @opindex mno-cond-move
12715
12716 Disable the use of conditional-move instructions.
12717
12718 This switch is mainly for debugging the compiler and will likely be removed
12719 in a future version.
12720
12721 @item -mscc
12722 @opindex mscc
12723
12724 Enable the use of conditional set instructions (default).
12725
12726 This switch is mainly for debugging the compiler and will likely be removed
12727 in a future version.
12728
12729 @item -mno-scc
12730 @opindex mno-scc
12731
12732 Disable the use of conditional set instructions.
12733
12734 This switch is mainly for debugging the compiler and will likely be removed
12735 in a future version.
12736
12737 @item -mcond-exec
12738 @opindex mcond-exec
12739
12740 Enable the use of conditional execution (default).
12741
12742 This switch is mainly for debugging the compiler and will likely be removed
12743 in a future version.
12744
12745 @item -mno-cond-exec
12746 @opindex mno-cond-exec
12747
12748 Disable the use of conditional execution.
12749
12750 This switch is mainly for debugging the compiler and will likely be removed
12751 in a future version.
12752
12753 @item -mvliw-branch
12754 @opindex mvliw-branch
12755
12756 Run a pass to pack branches into VLIW instructions (default).
12757
12758 This switch is mainly for debugging the compiler and will likely be removed
12759 in a future version.
12760
12761 @item -mno-vliw-branch
12762 @opindex mno-vliw-branch
12763
12764 Do not run a pass to pack branches into VLIW instructions.
12765
12766 This switch is mainly for debugging the compiler and will likely be removed
12767 in a future version.
12768
12769 @item -mmulti-cond-exec
12770 @opindex mmulti-cond-exec
12771
12772 Enable optimization of @code{&&} and @code{||} in conditional execution
12773 (default).
12774
12775 This switch is mainly for debugging the compiler and will likely be removed
12776 in a future version.
12777
12778 @item -mno-multi-cond-exec
12779 @opindex mno-multi-cond-exec
12780
12781 Disable optimization of @code{&&} and @code{||} in conditional execution.
12782
12783 This switch is mainly for debugging the compiler and will likely be removed
12784 in a future version.
12785
12786 @item -mnested-cond-exec
12787 @opindex mnested-cond-exec
12788
12789 Enable nested conditional execution optimizations (default).
12790
12791 This switch is mainly for debugging the compiler and will likely be removed
12792 in a future version.
12793
12794 @item -mno-nested-cond-exec
12795 @opindex mno-nested-cond-exec
12796
12797 Disable nested conditional execution optimizations.
12798
12799 This switch is mainly for debugging the compiler and will likely be removed
12800 in a future version.
12801
12802 @item -moptimize-membar
12803 @opindex moptimize-membar
12804
12805 This switch removes redundant @code{membar} instructions from the
12806 compiler generated code. It is enabled by default.
12807
12808 @item -mno-optimize-membar
12809 @opindex mno-optimize-membar
12810
12811 This switch disables the automatic removal of redundant @code{membar}
12812 instructions from the generated code.
12813
12814 @item -mtomcat-stats
12815 @opindex mtomcat-stats
12816
12817 Cause gas to print out tomcat statistics.
12818
12819 @item -mcpu=@var{cpu}
12820 @opindex mcpu
12821
12822 Select the processor type for which to generate code. Possible values are
12823 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12824 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12825
12826 @end table
12827
12828 @node GNU/Linux Options
12829 @subsection GNU/Linux Options
12830
12831 These @samp{-m} options are defined for GNU/Linux targets:
12832
12833 @table @gcctabopt
12834 @item -mglibc
12835 @opindex mglibc
12836 Use the GNU C library. This is the default except
12837 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12838
12839 @item -muclibc
12840 @opindex muclibc
12841 Use uClibc C library. This is the default on
12842 @samp{*-*-linux-*uclibc*} targets.
12843
12844 @item -mbionic
12845 @opindex mbionic
12846 Use Bionic C library. This is the default on
12847 @samp{*-*-linux-*android*} targets.
12848
12849 @item -mandroid
12850 @opindex mandroid
12851 Compile code compatible with Android platform. This is the default on
12852 @samp{*-*-linux-*android*} targets.
12853
12854 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12855 @option{-fno-exceptions} and @option{-fno-rtti} by default. When linking,
12856 this option makes the GCC driver pass Android-specific options to the linker.
12857 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12858 to be defined.
12859
12860 @item -tno-android-cc
12861 @opindex tno-android-cc
12862 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12863 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12864 @option{-fno-rtti} by default.
12865
12866 @item -tno-android-ld
12867 @opindex tno-android-ld
12868 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12869 linking options to the linker.
12870
12871 @end table
12872
12873 @node H8/300 Options
12874 @subsection H8/300 Options
12875
12876 These @samp{-m} options are defined for the H8/300 implementations:
12877
12878 @table @gcctabopt
12879 @item -mrelax
12880 @opindex mrelax
12881 Shorten some address references at link time, when possible; uses the
12882 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
12883 ld, Using ld}, for a fuller description.
12884
12885 @item -mh
12886 @opindex mh
12887 Generate code for the H8/300H@.
12888
12889 @item -ms
12890 @opindex ms
12891 Generate code for the H8S@.
12892
12893 @item -mn
12894 @opindex mn
12895 Generate code for the H8S and H8/300H in the normal mode. This switch
12896 must be used either with @option{-mh} or @option{-ms}.
12897
12898 @item -ms2600
12899 @opindex ms2600
12900 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
12901
12902 @item -mexr
12903 @opindex mexr
12904 Extended registers are stored on stack before execution of function
12905 with monitor attribute. Default option is @option{-mexr}.
12906 This option is valid only for H8S targets.
12907
12908 @item -mno-exr
12909 @opindex mno-exr
12910 Extended registers are not stored on stack before execution of function
12911 with monitor attribute. Default option is @option{-mno-exr}.
12912 This option is valid only for H8S targets.
12913
12914 @item -mint32
12915 @opindex mint32
12916 Make @code{int} data 32 bits by default.
12917
12918 @item -malign-300
12919 @opindex malign-300
12920 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12921 The default for the H8/300H and H8S is to align longs and floats on
12922 4-byte boundaries.
12923 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
12924 This option has no effect on the H8/300.
12925 @end table
12926
12927 @node HPPA Options
12928 @subsection HPPA Options
12929 @cindex HPPA Options
12930
12931 These @samp{-m} options are defined for the HPPA family of computers:
12932
12933 @table @gcctabopt
12934 @item -march=@var{architecture-type}
12935 @opindex march
12936 Generate code for the specified architecture. The choices for
12937 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12938 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
12939 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12940 architecture option for your machine. Code compiled for lower numbered
12941 architectures runs on higher numbered architectures, but not the
12942 other way around.
12943
12944 @item -mpa-risc-1-0
12945 @itemx -mpa-risc-1-1
12946 @itemx -mpa-risc-2-0
12947 @opindex mpa-risc-1-0
12948 @opindex mpa-risc-1-1
12949 @opindex mpa-risc-2-0
12950 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12951
12952 @item -mbig-switch
12953 @opindex mbig-switch
12954 Generate code suitable for big switch tables. Use this option only if
12955 the assembler/linker complain about out of range branches within a switch
12956 table.
12957
12958 @item -mjump-in-delay
12959 @opindex mjump-in-delay
12960 Fill delay slots of function calls with unconditional jump instructions
12961 by modifying the return pointer for the function call to be the target
12962 of the conditional jump.
12963
12964 @item -mdisable-fpregs
12965 @opindex mdisable-fpregs
12966 Prevent floating-point registers from being used in any manner. This is
12967 necessary for compiling kernels that perform lazy context switching of
12968 floating-point registers. If you use this option and attempt to perform
12969 floating-point operations, the compiler aborts.
12970
12971 @item -mdisable-indexing
12972 @opindex mdisable-indexing
12973 Prevent the compiler from using indexing address modes. This avoids some
12974 rather obscure problems when compiling MIG generated code under MACH@.
12975
12976 @item -mno-space-regs
12977 @opindex mno-space-regs
12978 Generate code that assumes the target has no space registers. This allows
12979 GCC to generate faster indirect calls and use unscaled index address modes.
12980
12981 Such code is suitable for level 0 PA systems and kernels.
12982
12983 @item -mfast-indirect-calls
12984 @opindex mfast-indirect-calls
12985 Generate code that assumes calls never cross space boundaries. This
12986 allows GCC to emit code that performs faster indirect calls.
12987
12988 This option does not work in the presence of shared libraries or nested
12989 functions.
12990
12991 @item -mfixed-range=@var{register-range}
12992 @opindex mfixed-range
12993 Generate code treating the given register range as fixed registers.
12994 A fixed register is one that the register allocator can not use. This is
12995 useful when compiling kernel code. A register range is specified as
12996 two registers separated by a dash. Multiple register ranges can be
12997 specified separated by a comma.
12998
12999 @item -mlong-load-store
13000 @opindex mlong-load-store
13001 Generate 3-instruction load and store sequences as sometimes required by
13002 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
13003 the HP compilers.
13004
13005 @item -mportable-runtime
13006 @opindex mportable-runtime
13007 Use the portable calling conventions proposed by HP for ELF systems.
13008
13009 @item -mgas
13010 @opindex mgas
13011 Enable the use of assembler directives only GAS understands.
13012
13013 @item -mschedule=@var{cpu-type}
13014 @opindex mschedule
13015 Schedule code according to the constraints for the machine type
13016 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
13017 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
13018 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13019 proper scheduling option for your machine. The default scheduling is
13020 @samp{8000}.
13021
13022 @item -mlinker-opt
13023 @opindex mlinker-opt
13024 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
13025 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
13026 linkers in which they give bogus error messages when linking some programs.
13027
13028 @item -msoft-float
13029 @opindex msoft-float
13030 Generate output containing library calls for floating point.
13031 @strong{Warning:} the requisite libraries are not available for all HPPA
13032 targets. Normally the facilities of the machine's usual C compiler are
13033 used, but this cannot be done directly in cross-compilation. You must make
13034 your own arrangements to provide suitable library functions for
13035 cross-compilation.
13036
13037 @option{-msoft-float} changes the calling convention in the output file;
13038 therefore, it is only useful if you compile @emph{all} of a program with
13039 this option. In particular, you need to compile @file{libgcc.a}, the
13040 library that comes with GCC, with @option{-msoft-float} in order for
13041 this to work.
13042
13043 @item -msio
13044 @opindex msio
13045 Generate the predefine, @code{_SIO}, for server IO@. The default is
13046 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
13047 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
13048 options are available under HP-UX and HI-UX@.
13049
13050 @item -mgnu-ld
13051 @opindex mgnu-ld
13052 Use options specific to GNU @command{ld}.
13053 This passes @option{-shared} to @command{ld} when
13054 building a shared library. It is the default when GCC is configured,
13055 explicitly or implicitly, with the GNU linker. This option does not
13056 affect which @command{ld} is called; it only changes what parameters
13057 are passed to that @command{ld}.
13058 The @command{ld} that is called is determined by the
13059 @option{--with-ld} configure option, GCC's program search path, and
13060 finally by the user's @env{PATH}. The linker used by GCC can be printed
13061 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
13062 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13063
13064 @item -mhp-ld
13065 @opindex mhp-ld
13066 Use options specific to HP @command{ld}.
13067 This passes @option{-b} to @command{ld} when building
13068 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13069 links. It is the default when GCC is configured, explicitly or
13070 implicitly, with the HP linker. This option does not affect
13071 which @command{ld} is called; it only changes what parameters are passed to that
13072 @command{ld}.
13073 The @command{ld} that is called is determined by the @option{--with-ld}
13074 configure option, GCC's program search path, and finally by the user's
13075 @env{PATH}. The linker used by GCC can be printed using @samp{which
13076 `gcc -print-prog-name=ld`}. This option is only available on the 64-bit
13077 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13078
13079 @item -mlong-calls
13080 @opindex mno-long-calls
13081 Generate code that uses long call sequences. This ensures that a call
13082 is always able to reach linker generated stubs. The default is to generate
13083 long calls only when the distance from the call site to the beginning
13084 of the function or translation unit, as the case may be, exceeds a
13085 predefined limit set by the branch type being used. The limits for
13086 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13087 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
13088 240,000 bytes.
13089
13090 Distances are measured from the beginning of functions when using the
13091 @option{-ffunction-sections} option, or when using the @option{-mgas}
13092 and @option{-mno-portable-runtime} options together under HP-UX with
13093 the SOM linker.
13094
13095 It is normally not desirable to use this option as it degrades
13096 performance. However, it may be useful in large applications,
13097 particularly when partial linking is used to build the application.
13098
13099 The types of long calls used depends on the capabilities of the
13100 assembler and linker, and the type of code being generated. The
13101 impact on systems that support long absolute calls, and long pic
13102 symbol-difference or pc-relative calls should be relatively small.
13103 However, an indirect call is used on 32-bit ELF systems in pic code
13104 and it is quite long.
13105
13106 @item -munix=@var{unix-std}
13107 @opindex march
13108 Generate compiler predefines and select a startfile for the specified
13109 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
13110 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
13111 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
13112 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
13113 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13114 and later.
13115
13116 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13117 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13118 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13119 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13120 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13121 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13122
13123 It is @emph{important} to note that this option changes the interfaces
13124 for various library routines. It also affects the operational behavior
13125 of the C library. Thus, @emph{extreme} care is needed in using this
13126 option.
13127
13128 Library code that is intended to operate with more than one UNIX
13129 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13130 as appropriate. Most GNU software doesn't provide this capability.
13131
13132 @item -nolibdld
13133 @opindex nolibdld
13134 Suppress the generation of link options to search libdld.sl when the
13135 @option{-static} option is specified on HP-UX 10 and later.
13136
13137 @item -static
13138 @opindex static
13139 The HP-UX implementation of setlocale in libc has a dependency on
13140 libdld.sl. There isn't an archive version of libdld.sl. Thus,
13141 when the @option{-static} option is specified, special link options
13142 are needed to resolve this dependency.
13143
13144 On HP-UX 10 and later, the GCC driver adds the necessary options to
13145 link with libdld.sl when the @option{-static} option is specified.
13146 This causes the resulting binary to be dynamic. On the 64-bit port,
13147 the linkers generate dynamic binaries by default in any case. The
13148 @option{-nolibdld} option can be used to prevent the GCC driver from
13149 adding these link options.
13150
13151 @item -threads
13152 @opindex threads
13153 Add support for multithreading with the @dfn{dce thread} library
13154 under HP-UX@. This option sets flags for both the preprocessor and
13155 linker.
13156 @end table
13157
13158 @node i386 and x86-64 Options
13159 @subsection Intel 386 and AMD x86-64 Options
13160 @cindex i386 Options
13161 @cindex x86-64 Options
13162 @cindex Intel 386 Options
13163 @cindex AMD x86-64 Options
13164
13165 These @samp{-m} options are defined for the i386 and x86-64 family of
13166 computers:
13167
13168 @table @gcctabopt
13169
13170 @item -march=@var{cpu-type}
13171 @opindex march
13172 Generate instructions for the machine type @var{cpu-type}. In contrast to
13173 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code
13174 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13175 to generate code that may not run at all on processors other than the one
13176 indicated. Specifying @option{-march=@var{cpu-type}} implies
13177 @option{-mtune=@var{cpu-type}}.
13178
13179 The choices for @var{cpu-type} are:
13180
13181 @table @samp
13182 @item native
13183 This selects the CPU to generate code for at compilation time by determining
13184 the processor type of the compiling machine. Using @option{-march=native}
13185 enables all instruction subsets supported by the local machine (hence
13186 the result might not run on different machines). Using @option{-mtune=native}
13187 produces code optimized for the local machine under the constraints
13188 of the selected instruction set.
13189
13190 @item i386
13191 Original Intel i386 CPU@.
13192
13193 @item i486
13194 Intel i486 CPU@. (No scheduling is implemented for this chip.)
13195
13196 @item i586
13197 @itemx pentium
13198 Intel Pentium CPU with no MMX support.
13199
13200 @item pentium-mmx
13201 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13202
13203 @item pentiumpro
13204 Intel Pentium Pro CPU@.
13205
13206 @item i686
13207 When used with @option{-march}, the Pentium Pro
13208 instruction set is used, so the code runs on all i686 family chips.
13209 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13210
13211 @item pentium2
13212 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13213 support.
13214
13215 @item pentium3
13216 @itemx pentium3m
13217 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13218 set support.
13219
13220 @item pentium-m
13221 Intel Pentium M; low-power version of Intel Pentium III CPU
13222 with MMX, SSE and SSE2 instruction set support. Used by Centrino notebooks.
13223
13224 @item pentium4
13225 @itemx pentium4m
13226 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13227
13228 @item prescott
13229 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13230 set support.
13231
13232 @item nocona
13233 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13234 SSE2 and SSE3 instruction set support.
13235
13236 @item core2
13237 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13238 instruction set support.
13239
13240 @item corei7
13241 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13242 and SSE4.2 instruction set support.
13243
13244 @item corei7-avx
13245 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13246 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13247
13248 @item core-avx-i
13249 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13250 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13251 set support.
13252
13253 @item atom
13254 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13255 instruction set support.
13256
13257 @item k6
13258 AMD K6 CPU with MMX instruction set support.
13259
13260 @item k6-2
13261 @itemx k6-3
13262 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13263
13264 @item athlon
13265 @itemx athlon-tbird
13266 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13267 support.
13268
13269 @item athlon-4
13270 @itemx athlon-xp
13271 @itemx athlon-mp
13272 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13273 instruction set support.
13274
13275 @item k8
13276 @itemx opteron
13277 @itemx athlon64
13278 @itemx athlon-fx
13279 Processors based on the AMD K8 core with x86-64 instruction set support,
13280 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13281 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13282 instruction set extensions.)
13283
13284 @item k8-sse3
13285 @itemx opteron-sse3
13286 @itemx athlon64-sse3
13287 Improved versions of AMD K8 cores with SSE3 instruction set support.
13288
13289 @item amdfam10
13290 @itemx barcelona
13291 CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This
13292 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13293 instruction set extensions.)
13294
13295 @item bdver1
13296 CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This
13297 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13298 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13299 @item bdver2
13300 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
13301 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13302 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set
13303 extensions.)
13304
13305 @item btver1
13306 CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This
13307 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13308 instruction set extensions.)
13309
13310 @item btver2
13311 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13312 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13313 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13314
13315 @item winchip-c6
13316 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13317 set support.
13318
13319 @item winchip2
13320 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13321 instruction set support.
13322
13323 @item c3
13324 VIA C3 CPU with MMX and 3DNow!@: instruction set support. (No scheduling is
13325 implemented for this chip.)
13326
13327 @item c3-2
13328 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13329 (No scheduling is
13330 implemented for this chip.)
13331
13332 @item geode
13333 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13334 @end table
13335
13336 @item -mtune=@var{cpu-type}
13337 @opindex mtune
13338 Tune to @var{cpu-type} everything applicable about the generated code, except
13339 for the ABI and the set of available instructions.
13340 While picking a specific @var{cpu-type} schedules things appropriately
13341 for that particular chip, the compiler does not generate any code that
13342 cannot run on the default machine type unless you use a
13343 @option{-march=@var{cpu-type}} option.
13344 For example, if GCC is configured for i686-pc-linux-gnu
13345 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13346 but still runs on i686 machines.
13347
13348 The choices for @var{cpu-type} are the same as for @option{-march}.
13349 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13350
13351 @table @samp
13352 @item generic
13353 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13354 If you know the CPU on which your code will run, then you should use
13355 the corresponding @option{-mtune} or @option{-march} option instead of
13356 @option{-mtune=generic}. But, if you do not know exactly what CPU users
13357 of your application will have, then you should use this option.
13358
13359 As new processors are deployed in the marketplace, the behavior of this
13360 option will change. Therefore, if you upgrade to a newer version of
13361 GCC, code generation controlled by this option will change to reflect
13362 the processors
13363 that are most common at the time that version of GCC is released.
13364
13365 There is no @option{-march=generic} option because @option{-march}
13366 indicates the instruction set the compiler can use, and there is no
13367 generic instruction set applicable to all processors. In contrast,
13368 @option{-mtune} indicates the processor (or, in this case, collection of
13369 processors) for which the code is optimized.
13370 @end table
13371
13372 @item -mcpu=@var{cpu-type}
13373 @opindex mcpu
13374 A deprecated synonym for @option{-mtune}.
13375
13376 @item -mfpmath=@var{unit}
13377 @opindex mfpmath
13378 Generate floating-point arithmetic for selected unit @var{unit}. The choices
13379 for @var{unit} are:
13380
13381 @table @samp
13382 @item 387
13383 Use the standard 387 floating-point coprocessor present on the majority of chips and
13384 emulated otherwise. Code compiled with this option runs almost everywhere.
13385 The temporary results are computed in 80-bit precision instead of the precision
13386 specified by the type, resulting in slightly different results compared to most
13387 of other chips. See @option{-ffloat-store} for more detailed description.
13388
13389 This is the default choice for i386 compiler.
13390
13391 @item sse
13392 Use scalar floating-point instructions present in the SSE instruction set.
13393 This instruction set is supported by Pentium III and newer chips,
13394 and in the AMD line
13395 by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE
13396 instruction set supports only single-precision arithmetic, thus the double and
13397 extended-precision arithmetic are still done using 387. A later version, present
13398 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13399 arithmetic too.
13400
13401 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13402 or @option{-msse2} switches to enable SSE extensions and make this option
13403 effective. For the x86-64 compiler, these extensions are enabled by default.
13404
13405 The resulting code should be considerably faster in the majority of cases and avoid
13406 the numerical instability problems of 387 code, but may break some existing
13407 code that expects temporaries to be 80 bits.
13408
13409 This is the default choice for the x86-64 compiler.
13410
13411 @item sse,387
13412 @itemx sse+387
13413 @itemx both
13414 Attempt to utilize both instruction sets at once. This effectively doubles the
13415 amount of available registers, and on chips with separate execution units for
13416 387 and SSE the execution resources too. Use this option with care, as it is
13417 still experimental, because the GCC register allocator does not model separate
13418 functional units well, resulting in unstable performance.
13419 @end table
13420
13421 @item -masm=@var{dialect}
13422 @opindex masm=@var{dialect}
13423 Output assembly instructions using selected @var{dialect}. Supported
13424 choices are @samp{intel} or @samp{att} (the default). Darwin does
13425 not support @samp{intel}.
13426
13427 @item -mieee-fp
13428 @itemx -mno-ieee-fp
13429 @opindex mieee-fp
13430 @opindex mno-ieee-fp
13431 Control whether or not the compiler uses IEEE floating-point
13432 comparisons. These correctly handle the case where the result of a
13433 comparison is unordered.
13434
13435 @item -msoft-float
13436 @opindex msoft-float
13437 Generate output containing library calls for floating point.
13438
13439 @strong{Warning:} the requisite libraries are not part of GCC@.
13440 Normally the facilities of the machine's usual C compiler are used, but
13441 this can't be done directly in cross-compilation. You must make your
13442 own arrangements to provide suitable library functions for
13443 cross-compilation.
13444
13445 On machines where a function returns floating-point results in the 80387
13446 register stack, some floating-point opcodes may be emitted even if
13447 @option{-msoft-float} is used.
13448
13449 @item -mno-fp-ret-in-387
13450 @opindex mno-fp-ret-in-387
13451 Do not use the FPU registers for return values of functions.
13452
13453 The usual calling convention has functions return values of types
13454 @code{float} and @code{double} in an FPU register, even if there
13455 is no FPU@. The idea is that the operating system should emulate
13456 an FPU@.
13457
13458 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13459 in ordinary CPU registers instead.
13460
13461 @item -mno-fancy-math-387
13462 @opindex mno-fancy-math-387
13463 Some 387 emulators do not support the @code{sin}, @code{cos} and
13464 @code{sqrt} instructions for the 387. Specify this option to avoid
13465 generating those instructions. This option is the default on FreeBSD,
13466 OpenBSD and NetBSD@. This option is overridden when @option{-march}
13467 indicates that the target CPU always has an FPU and so the
13468 instruction does not need emulation. These
13469 instructions are not generated unless you also use the
13470 @option{-funsafe-math-optimizations} switch.
13471
13472 @item -malign-double
13473 @itemx -mno-align-double
13474 @opindex malign-double
13475 @opindex mno-align-double
13476 Control whether GCC aligns @code{double}, @code{long double}, and
13477 @code{long long} variables on a two-word boundary or a one-word
13478 boundary. Aligning @code{double} variables on a two-word boundary
13479 produces code that runs somewhat faster on a Pentium at the
13480 expense of more memory.
13481
13482 On x86-64, @option{-malign-double} is enabled by default.
13483
13484 @strong{Warning:} if you use the @option{-malign-double} switch,
13485 structures containing the above types are aligned differently than
13486 the published application binary interface specifications for the 386
13487 and are not binary compatible with structures in code compiled
13488 without that switch.
13489
13490 @item -m96bit-long-double
13491 @itemx -m128bit-long-double
13492 @opindex m96bit-long-double
13493 @opindex m128bit-long-double
13494 These switches control the size of @code{long double} type. The i386
13495 application binary interface specifies the size to be 96 bits,
13496 so @option{-m96bit-long-double} is the default in 32-bit mode.
13497
13498 Modern architectures (Pentium and newer) prefer @code{long double}
13499 to be aligned to an 8- or 16-byte boundary. In arrays or structures
13500 conforming to the ABI, this is not possible. So specifying
13501 @option{-m128bit-long-double} aligns @code{long double}
13502 to a 16-byte boundary by padding the @code{long double} with an additional
13503 32-bit zero.
13504
13505 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13506 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13507
13508 Notice that neither of these options enable any extra precision over the x87
13509 standard of 80 bits for a @code{long double}.
13510
13511 @strong{Warning:} if you override the default value for your target ABI, this
13512 changes the size of
13513 structures and arrays containing @code{long double} variables,
13514 as well as modifying the function calling convention for functions taking
13515 @code{long double}. Hence they are not binary-compatible
13516 with code compiled without that switch.
13517
13518 @item -mlong-double-64
13519 @itemx -mlong-double-80
13520 @opindex mlong-double-64
13521 @opindex mlong-double-80
13522 These switches control the size of @code{long double} type. A size
13523 of 64 bits makes the @code{long double} type equivalent to the @code{double}
13524 type. This is the default for Bionic C library.
13525
13526 @strong{Warning:} if you override the default value for your target ABI, this
13527 changes the size of
13528 structures and arrays containing @code{long double} variables,
13529 as well as modifying the function calling convention for functions taking
13530 @code{long double}. Hence they are not binary-compatible
13531 with code compiled without that switch.
13532
13533 @item -mlarge-data-threshold=@var{threshold}
13534 @opindex mlarge-data-threshold
13535 When @option{-mcmodel=medium} is specified, data objects larger than
13536 @var{threshold} are placed in the large data section. This value must be the
13537 same across all objects linked into the binary, and defaults to 65535.
13538
13539 @item -mrtd
13540 @opindex mrtd
13541 Use a different function-calling convention, in which functions that
13542 take a fixed number of arguments return with the @code{ret @var{num}}
13543 instruction, which pops their arguments while returning. This saves one
13544 instruction in the caller since there is no need to pop the arguments
13545 there.
13546
13547 You can specify that an individual function is called with this calling
13548 sequence with the function attribute @samp{stdcall}. You can also
13549 override the @option{-mrtd} option by using the function attribute
13550 @samp{cdecl}. @xref{Function Attributes}.
13551
13552 @strong{Warning:} this calling convention is incompatible with the one
13553 normally used on Unix, so you cannot use it if you need to call
13554 libraries compiled with the Unix compiler.
13555
13556 Also, you must provide function prototypes for all functions that
13557 take variable numbers of arguments (including @code{printf});
13558 otherwise incorrect code is generated for calls to those
13559 functions.
13560
13561 In addition, seriously incorrect code results if you call a
13562 function with too many arguments. (Normally, extra arguments are
13563 harmlessly ignored.)
13564
13565 @item -mregparm=@var{num}
13566 @opindex mregparm
13567 Control how many registers are used to pass integer arguments. By
13568 default, no registers are used to pass arguments, and at most 3
13569 registers can be used. You can control this behavior for a specific
13570 function by using the function attribute @samp{regparm}.
13571 @xref{Function Attributes}.
13572
13573 @strong{Warning:} if you use this switch, and
13574 @var{num} is nonzero, then you must build all modules with the same
13575 value, including any libraries. This includes the system libraries and
13576 startup modules.
13577
13578 @item -msseregparm
13579 @opindex msseregparm
13580 Use SSE register passing conventions for float and double arguments
13581 and return values. You can control this behavior for a specific
13582 function by using the function attribute @samp{sseregparm}.
13583 @xref{Function Attributes}.
13584
13585 @strong{Warning:} if you use this switch then you must build all
13586 modules with the same value, including any libraries. This includes
13587 the system libraries and startup modules.
13588
13589 @item -mvect8-ret-in-mem
13590 @opindex mvect8-ret-in-mem
13591 Return 8-byte vectors in memory instead of MMX registers. This is the
13592 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13593 Studio compilers until version 12. Later compiler versions (starting
13594 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13595 is the default on Solaris@tie{}10 and later. @emph{Only} use this option if
13596 you need to remain compatible with existing code produced by those
13597 previous compiler versions or older versions of GCC@.
13598
13599 @item -mpc32
13600 @itemx -mpc64
13601 @itemx -mpc80
13602 @opindex mpc32
13603 @opindex mpc64
13604 @opindex mpc80
13605
13606 Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32}
13607 is specified, the significands of results of floating-point operations are
13608 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13609 significands of results of floating-point operations to 53 bits (double
13610 precision) and @option{-mpc80} rounds the significands of results of
13611 floating-point operations to 64 bits (extended double precision), which is
13612 the default. When this option is used, floating-point operations in higher
13613 precisions are not available to the programmer without setting the FPU
13614 control word explicitly.
13615
13616 Setting the rounding of floating-point operations to less than the default
13617 80 bits can speed some programs by 2% or more. Note that some mathematical
13618 libraries assume that extended-precision (80-bit) floating-point operations
13619 are enabled by default; routines in such libraries could suffer significant
13620 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13621 when this option is used to set the precision to less than extended precision.
13622
13623 @item -mstackrealign
13624 @opindex mstackrealign
13625 Realign the stack at entry. On the Intel x86, the @option{-mstackrealign}
13626 option generates an alternate prologue and epilogue that realigns the
13627 run-time stack if necessary. This supports mixing legacy codes that keep
13628 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13629 SSE compatibility. See also the attribute @code{force_align_arg_pointer},
13630 applicable to individual functions.
13631
13632 @item -mpreferred-stack-boundary=@var{num}
13633 @opindex mpreferred-stack-boundary
13634 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13635 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
13636 the default is 4 (16 bytes or 128 bits).
13637
13638 @strong{Warning:} When generating code for the x86-64 architecture with
13639 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
13640 used to keep the stack boundary aligned to 8 byte boundary. Since
13641 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
13642 intended to be used in controlled environment where stack space is
13643 important limitation. This option will lead to wrong code when functions
13644 compiled with 16 byte stack alignment (such as functions from a standard
13645 library) are called with misaligned stack. In this case, SSE
13646 instructions may lead to misaligned memory access traps. In addition,
13647 variable arguments will be handled incorrectly for 16 byte aligned
13648 objects (including x87 long double and __int128), leading to wrong
13649 results. You must build all modules with
13650 @option{-mpreferred-stack-boundary=3}, including any libraries. This
13651 includes the system libraries and startup modules.
13652
13653 @item -mincoming-stack-boundary=@var{num}
13654 @opindex mincoming-stack-boundary
13655 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13656 boundary. If @option{-mincoming-stack-boundary} is not specified,
13657 the one specified by @option{-mpreferred-stack-boundary} is used.
13658
13659 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13660 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13661 suffer significant run time performance penalties. On Pentium III, the
13662 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13663 properly if it is not 16-byte aligned.
13664
13665 To ensure proper alignment of this values on the stack, the stack boundary
13666 must be as aligned as that required by any value stored on the stack.
13667 Further, every function must be generated such that it keeps the stack
13668 aligned. Thus calling a function compiled with a higher preferred
13669 stack boundary from a function compiled with a lower preferred stack
13670 boundary most likely misaligns the stack. It is recommended that
13671 libraries that use callbacks always use the default setting.
13672
13673 This extra alignment does consume extra stack space, and generally
13674 increases code size. Code that is sensitive to stack space usage, such
13675 as embedded systems and operating system kernels, may want to reduce the
13676 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13677
13678 @item -mmmx
13679 @itemx -mno-mmx
13680 @itemx -msse
13681 @itemx -mno-sse
13682 @itemx -msse2
13683 @itemx -mno-sse2
13684 @itemx -msse3
13685 @itemx -mno-sse3
13686 @itemx -mssse3
13687 @itemx -mno-ssse3
13688 @itemx -msse4.1
13689 @need 800
13690 @itemx -mno-sse4.1
13691 @itemx -msse4.2
13692 @itemx -mno-sse4.2
13693 @itemx -msse4
13694 @itemx -mno-sse4
13695 @itemx -mavx
13696 @itemx -mno-avx
13697 @itemx -mavx2
13698 @itemx -mno-avx2
13699 @itemx -maes
13700 @itemx -mno-aes
13701 @itemx -mpclmul
13702 @need 800
13703 @itemx -mno-pclmul
13704 @itemx -mfsgsbase
13705 @itemx -mno-fsgsbase
13706 @itemx -mrdrnd
13707 @itemx -mno-rdrnd
13708 @itemx -mf16c
13709 @itemx -mno-f16c
13710 @itemx -mfma
13711 @itemx -mno-fma
13712 @itemx -msse4a
13713 @itemx -mno-sse4a
13714 @itemx -mfma4
13715 @need 800
13716 @itemx -mno-fma4
13717 @itemx -mxop
13718 @itemx -mno-xop
13719 @itemx -mlwp
13720 @itemx -mno-lwp
13721 @itemx -m3dnow
13722 @itemx -mno-3dnow
13723 @itemx -mpopcnt
13724 @itemx -mno-popcnt
13725 @itemx -mabm
13726 @itemx -mno-abm
13727 @itemx -mbmi
13728 @itemx -mbmi2
13729 @itemx -mno-bmi
13730 @itemx -mno-bmi2
13731 @itemx -mlzcnt
13732 @itemx -mno-lzcnt
13733 @itemx -mrtm
13734 @itemx -mtbm
13735 @itemx -mno-tbm
13736 @opindex mmmx
13737 @opindex mno-mmx
13738 @opindex msse
13739 @opindex mno-sse
13740 @opindex m3dnow
13741 @opindex mno-3dnow
13742 These switches enable or disable the use of instructions in the MMX, SSE,
13743 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13744 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
13745 extended instruction sets.
13746 These extensions are also available as built-in functions: see
13747 @ref{X86 Built-in Functions}, for details of the functions enabled and
13748 disabled by these switches.
13749
13750 To generate SSE/SSE2 instructions automatically from floating-point
13751 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13752
13753 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13754 generates new AVX instructions or AVX equivalence for all SSEx instructions
13755 when needed.
13756
13757 These options enable GCC to use these extended instructions in
13758 generated code, even without @option{-mfpmath=sse}. Applications that
13759 perform run-time CPU detection must compile separate files for each
13760 supported architecture, using the appropriate flags. In particular,
13761 the file containing the CPU detection code should be compiled without
13762 these options.
13763
13764 @item -mcld
13765 @opindex mcld
13766 This option instructs GCC to emit a @code{cld} instruction in the prologue
13767 of functions that use string instructions. String instructions depend on
13768 the DF flag to select between autoincrement or autodecrement mode. While the
13769 ABI specifies the DF flag to be cleared on function entry, some operating
13770 systems violate this specification by not clearing the DF flag in their
13771 exception dispatchers. The exception handler can be invoked with the DF flag
13772 set, which leads to wrong direction mode when string instructions are used.
13773 This option can be enabled by default on 32-bit x86 targets by configuring
13774 GCC with the @option{--enable-cld} configure option. Generation of @code{cld}
13775 instructions can be suppressed with the @option{-mno-cld} compiler option
13776 in this case.
13777
13778 @item -mvzeroupper
13779 @opindex mvzeroupper
13780 This option instructs GCC to emit a @code{vzeroupper} instruction
13781 before a transfer of control flow out of the function to minimize
13782 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
13783 intrinsics.
13784
13785 @item -mcx16
13786 @opindex mcx16
13787 This option enables GCC to generate @code{CMPXCHG16B} instructions.
13788 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
13789 (or oword) data types.
13790 This is useful for high-resolution counters that can be updated
13791 by multiple processors (or cores). This instruction is generated as part of
13792 atomic built-in functions: see @ref{__sync Builtins} or
13793 @ref{__atomic Builtins} for details.
13794
13795 @item -msahf
13796 @opindex msahf
13797 This option enables generation of @code{SAHF} instructions in 64-bit code.
13798 Early Intel Pentium 4 CPUs with Intel 64 support,
13799 prior to the introduction of Pentium 4 G1 step in December 2005,
13800 lacked the @code{LAHF} and @code{SAHF} instructions
13801 which were supported by AMD64.
13802 These are load and store instructions, respectively, for certain status flags.
13803 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
13804 @code{drem}, and @code{remainder} built-in functions;
13805 see @ref{Other Builtins} for details.
13806
13807 @item -mmovbe
13808 @opindex mmovbe
13809 This option enables use of the @code{movbe} instruction to implement
13810 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13811
13812 @item -mcrc32
13813 @opindex mcrc32
13814 This option enables built-in functions @code{__builtin_ia32_crc32qi},
13815 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
13816 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
13817
13818 @item -mrecip
13819 @opindex mrecip
13820 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
13821 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
13822 with an additional Newton-Raphson step
13823 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
13824 (and their vectorized
13825 variants) for single-precision floating-point arguments. These instructions
13826 are generated only when @option{-funsafe-math-optimizations} is enabled
13827 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13828 Note that while the throughput of the sequence is higher than the throughput
13829 of the non-reciprocal instruction, the precision of the sequence can be
13830 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13831
13832 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
13833 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
13834 combination), and doesn't need @option{-mrecip}.
13835
13836 Also note that GCC emits the above sequence with additional Newton-Raphson step
13837 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
13838 already with @option{-ffast-math} (or the above option combination), and
13839 doesn't need @option{-mrecip}.
13840
13841 @item -mrecip=@var{opt}
13842 @opindex mrecip=opt
13843 This option controls which reciprocal estimate instructions
13844 may be used. @var{opt} is a comma-separated list of options, which may
13845 be preceded by a @samp{!} to invert the option:
13846
13847 @table @samp
13848 @item all
13849 Enable all estimate instructions.
13850
13851 @item default
13852 Enable the default instructions, equivalent to @option{-mrecip}.
13853
13854 @item none
13855 Disable all estimate instructions, equivalent to @option{-mno-recip}.
13856
13857 @item div
13858 Enable the approximation for scalar division.
13859
13860 @item vec-div
13861 Enable the approximation for vectorized division.
13862
13863 @item sqrt
13864 Enable the approximation for scalar square root.
13865
13866 @item vec-sqrt
13867 Enable the approximation for vectorized square root.
13868 @end table
13869
13870 So, for example, @option{-mrecip=all,!sqrt} enables
13871 all of the reciprocal approximations, except for square root.
13872
13873 @item -mveclibabi=@var{type}
13874 @opindex mveclibabi
13875 Specifies the ABI type to use for vectorizing intrinsics using an
13876 external library. Supported values for @var{type} are @samp{svml}
13877 for the Intel short
13878 vector math library and @samp{acml} for the AMD math core library.
13879 To use this option, both @option{-ftree-vectorize} and
13880 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML
13881 ABI-compatible library must be specified at link time.
13882
13883 GCC currently emits calls to @code{vmldExp2},
13884 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13885 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13886 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13887 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13888 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13889 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13890 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13891 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13892 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13893 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
13894 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13895 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13896 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13897 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
13898 when @option{-mveclibabi=acml} is used.
13899
13900 @item -mabi=@var{name}
13901 @opindex mabi
13902 Generate code for the specified calling convention. Permissible values
13903 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
13904 @samp{ms} for the Microsoft ABI. The default is to use the Microsoft
13905 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
13906 You can control this behavior for a specific function by
13907 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13908 @xref{Function Attributes}.
13909
13910 @item -mtls-dialect=@var{type}
13911 @opindex mtls-dialect
13912 Generate code to access thread-local storage using the @samp{gnu} or
13913 @samp{gnu2} conventions. @samp{gnu} is the conservative default;
13914 @samp{gnu2} is more efficient, but it may add compile- and run-time
13915 requirements that cannot be satisfied on all systems.
13916
13917 @item -mpush-args
13918 @itemx -mno-push-args
13919 @opindex mpush-args
13920 @opindex mno-push-args
13921 Use PUSH operations to store outgoing parameters. This method is shorter
13922 and usually equally fast as method using SUB/MOV operations and is enabled
13923 by default. In some cases disabling it may improve performance because of
13924 improved scheduling and reduced dependencies.
13925
13926 @item -maccumulate-outgoing-args
13927 @opindex maccumulate-outgoing-args
13928 If enabled, the maximum amount of space required for outgoing arguments is
13929 computed in the function prologue. This is faster on most modern CPUs
13930 because of reduced dependencies, improved scheduling and reduced stack usage
13931 when the preferred stack boundary is not equal to 2. The drawback is a notable
13932 increase in code size. This switch implies @option{-mno-push-args}.
13933
13934 @item -mthreads
13935 @opindex mthreads
13936 Support thread-safe exception handling on MinGW. Programs that rely
13937 on thread-safe exception handling must compile and link all code with the
13938 @option{-mthreads} option. When compiling, @option{-mthreads} defines
13939 @code{-D_MT}; when linking, it links in a special thread helper library
13940 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
13941
13942 @item -mno-align-stringops
13943 @opindex mno-align-stringops
13944 Do not align the destination of inlined string operations. This switch reduces
13945 code size and improves performance in case the destination is already aligned,
13946 but GCC doesn't know about it.
13947
13948 @item -minline-all-stringops
13949 @opindex minline-all-stringops
13950 By default GCC inlines string operations only when the destination is
13951 known to be aligned to least a 4-byte boundary.
13952 This enables more inlining and increases code
13953 size, but may improve performance of code that depends on fast
13954 @code{memcpy}, @code{strlen},
13955 and @code{memset} for short lengths.
13956
13957 @item -minline-stringops-dynamically
13958 @opindex minline-stringops-dynamically
13959 For string operations of unknown size, use run-time checks with
13960 inline code for small blocks and a library call for large blocks.
13961
13962 @item -mstringop-strategy=@var{alg}
13963 @opindex mstringop-strategy=@var{alg}
13964 Override the internal decision heuristic for the particular algorithm to use
13965 for inlining string operations. The allowed values for @var{alg} are:
13966
13967 @table @samp
13968 @item rep_byte
13969 @itemx rep_4byte
13970 @itemx rep_8byte
13971 Expand using i386 @code{rep} prefix of the specified size.
13972
13973 @item byte_loop
13974 @itemx loop
13975 @itemx unrolled_loop
13976 Expand into an inline loop.
13977
13978 @item libcall
13979 Always use a library call.
13980 @end table
13981
13982 @item -momit-leaf-frame-pointer
13983 @opindex momit-leaf-frame-pointer
13984 Don't keep the frame pointer in a register for leaf functions. This
13985 avoids the instructions to save, set up, and restore frame pointers and
13986 makes an extra register available in leaf functions. The option
13987 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
13988 which might make debugging harder.
13989
13990 @item -mtls-direct-seg-refs
13991 @itemx -mno-tls-direct-seg-refs
13992 @opindex mtls-direct-seg-refs
13993 Controls whether TLS variables may be accessed with offsets from the
13994 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13995 or whether the thread base pointer must be added. Whether or not this
13996 is valid depends on the operating system, and whether it maps the
13997 segment to cover the entire TLS area.
13998
13999 For systems that use the GNU C Library, the default is on.
14000
14001 @item -msse2avx
14002 @itemx -mno-sse2avx
14003 @opindex msse2avx
14004 Specify that the assembler should encode SSE instructions with VEX
14005 prefix. The option @option{-mavx} turns this on by default.
14006
14007 @item -mfentry
14008 @itemx -mno-fentry
14009 @opindex mfentry
14010 If profiling is active (@option{-pg}), put the profiling
14011 counter call before the prologue.
14012 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14013 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14014
14015 @item -m8bit-idiv
14016 @itemx -mno-8bit-idiv
14017 @opindex 8bit-idiv
14018 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14019 much faster than 32-bit/64-bit integer divide. This option generates a
14020 run-time check. If both dividend and divisor are within range of 0
14021 to 255, 8-bit unsigned integer divide is used instead of
14022 32-bit/64-bit integer divide.
14023
14024 @item -mavx256-split-unaligned-load
14025 @itemx -mavx256-split-unaligned-store
14026 @opindex avx256-split-unaligned-load
14027 @opindex avx256-split-unaligned-store
14028 Split 32-byte AVX unaligned load and store.
14029
14030 @end table
14031
14032 These @samp{-m} switches are supported in addition to the above
14033 on x86-64 processors in 64-bit environments.
14034
14035 @table @gcctabopt
14036 @item -m32
14037 @itemx -m64
14038 @itemx -mx32
14039 @opindex m32
14040 @opindex m64
14041 @opindex mx32
14042 Generate code for a 32-bit or 64-bit environment.
14043 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14044 to 32 bits, and
14045 generates code that runs on any i386 system.
14046
14047 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14048 types to 64 bits, and generates code for the x86-64 architecture.
14049 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14050 and @option{-mdynamic-no-pic} options.
14051
14052 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14053 to 32 bits, and
14054 generates code for the x86-64 architecture.
14055
14056 @item -mno-red-zone
14057 @opindex mno-red-zone
14058 Do not use a so-called ``red zone'' for x86-64 code. The red zone is mandated
14059 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14060 stack pointer that is not modified by signal or interrupt handlers
14061 and therefore can be used for temporary data without adjusting the stack
14062 pointer. The flag @option{-mno-red-zone} disables this red zone.
14063
14064 @item -mcmodel=small
14065 @opindex mcmodel=small
14066 Generate code for the small code model: the program and its symbols must
14067 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
14068 Programs can be statically or dynamically linked. This is the default
14069 code model.
14070
14071 @item -mcmodel=kernel
14072 @opindex mcmodel=kernel
14073 Generate code for the kernel code model. The kernel runs in the
14074 negative 2 GB of the address space.
14075 This model has to be used for Linux kernel code.
14076
14077 @item -mcmodel=medium
14078 @opindex mcmodel=medium
14079 Generate code for the medium model: the program is linked in the lower 2
14080 GB of the address space. Small symbols are also placed there. Symbols
14081 with sizes larger than @option{-mlarge-data-threshold} are put into
14082 large data or BSS sections and can be located above 2GB. Programs can
14083 be statically or dynamically linked.
14084
14085 @item -mcmodel=large
14086 @opindex mcmodel=large
14087 Generate code for the large model. This model makes no assumptions
14088 about addresses and sizes of sections.
14089
14090 @item -maddress-mode=long
14091 @opindex maddress-mode=long
14092 Generate code for long address mode. This is only supported for 64-bit
14093 and x32 environments. It is the default address mode for 64-bit
14094 environments.
14095
14096 @item -maddress-mode=short
14097 @opindex maddress-mode=short
14098 Generate code for short address mode. This is only supported for 32-bit
14099 and x32 environments. It is the default address mode for 32-bit and
14100 x32 environments.
14101 @end table
14102
14103 @node i386 and x86-64 Windows Options
14104 @subsection i386 and x86-64 Windows Options
14105 @cindex i386 and x86-64 Windows Options
14106
14107 These additional options are available for Microsoft Windows targets:
14108
14109 @table @gcctabopt
14110 @item -mconsole
14111 @opindex mconsole
14112 This option
14113 specifies that a console application is to be generated, by
14114 instructing the linker to set the PE header subsystem type
14115 required for console applications.
14116 This option is available for Cygwin and MinGW targets and is
14117 enabled by default on those targets.
14118
14119 @item -mdll
14120 @opindex mdll
14121 This option is available for Cygwin and MinGW targets. It
14122 specifies that a DLL---a dynamic link library---is to be
14123 generated, enabling the selection of the required runtime
14124 startup object and entry point.
14125
14126 @item -mnop-fun-dllimport
14127 @opindex mnop-fun-dllimport
14128 This option is available for Cygwin and MinGW targets. It
14129 specifies that the @code{dllimport} attribute should be ignored.
14130
14131 @item -mthread
14132 @opindex mthread
14133 This option is available for MinGW targets. It specifies
14134 that MinGW-specific thread support is to be used.
14135
14136 @item -municode
14137 @opindex municode
14138 This option is available for MinGW-w64 targets. It causes
14139 the @code{UNICODE} preprocessor macro to be predefined, and
14140 chooses Unicode-capable runtime startup code.
14141
14142 @item -mwin32
14143 @opindex mwin32
14144 This option is available for Cygwin and MinGW targets. It
14145 specifies that the typical Microsoft Windows predefined macros are to
14146 be set in the pre-processor, but does not influence the choice
14147 of runtime library/startup code.
14148
14149 @item -mwindows
14150 @opindex mwindows
14151 This option is available for Cygwin and MinGW targets. It
14152 specifies that a GUI application is to be generated by
14153 instructing the linker to set the PE header subsystem type
14154 appropriately.
14155
14156 @item -fno-set-stack-executable
14157 @opindex fno-set-stack-executable
14158 This option is available for MinGW targets. It specifies that
14159 the executable flag for the stack used by nested functions isn't
14160 set. This is necessary for binaries running in kernel mode of
14161 Microsoft Windows, as there the User32 API, which is used to set executable
14162 privileges, isn't available.
14163
14164 @item -fwritable-relocated-rdata
14165 @opindex fno-writable-relocated-rdata
14166 This option is available for MinGW and Cygwin targets. It specifies
14167 that relocated-data in read-only section is put into .data
14168 section. This is a necessary for older runtimes not supporting
14169 modification of .rdata sections for pseudo-relocation.
14170
14171 @item -mpe-aligned-commons
14172 @opindex mpe-aligned-commons
14173 This option is available for Cygwin and MinGW targets. It
14174 specifies that the GNU extension to the PE file format that
14175 permits the correct alignment of COMMON variables should be
14176 used when generating code. It is enabled by default if
14177 GCC detects that the target assembler found during configuration
14178 supports the feature.
14179 @end table
14180
14181 See also under @ref{i386 and x86-64 Options} for standard options.
14182
14183 @node IA-64 Options
14184 @subsection IA-64 Options
14185 @cindex IA-64 Options
14186
14187 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14188
14189 @table @gcctabopt
14190 @item -mbig-endian
14191 @opindex mbig-endian
14192 Generate code for a big-endian target. This is the default for HP-UX@.
14193
14194 @item -mlittle-endian
14195 @opindex mlittle-endian
14196 Generate code for a little-endian target. This is the default for AIX5
14197 and GNU/Linux.
14198
14199 @item -mgnu-as
14200 @itemx -mno-gnu-as
14201 @opindex mgnu-as
14202 @opindex mno-gnu-as
14203 Generate (or don't) code for the GNU assembler. This is the default.
14204 @c Also, this is the default if the configure option @option{--with-gnu-as}
14205 @c is used.
14206
14207 @item -mgnu-ld
14208 @itemx -mno-gnu-ld
14209 @opindex mgnu-ld
14210 @opindex mno-gnu-ld
14211 Generate (or don't) code for the GNU linker. This is the default.
14212 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14213 @c is used.
14214
14215 @item -mno-pic
14216 @opindex mno-pic
14217 Generate code that does not use a global pointer register. The result
14218 is not position independent code, and violates the IA-64 ABI@.
14219
14220 @item -mvolatile-asm-stop
14221 @itemx -mno-volatile-asm-stop
14222 @opindex mvolatile-asm-stop
14223 @opindex mno-volatile-asm-stop
14224 Generate (or don't) a stop bit immediately before and after volatile asm
14225 statements.
14226
14227 @item -mregister-names
14228 @itemx -mno-register-names
14229 @opindex mregister-names
14230 @opindex mno-register-names
14231 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14232 the stacked registers. This may make assembler output more readable.
14233
14234 @item -mno-sdata
14235 @itemx -msdata
14236 @opindex mno-sdata
14237 @opindex msdata
14238 Disable (or enable) optimizations that use the small data section. This may
14239 be useful for working around optimizer bugs.
14240
14241 @item -mconstant-gp
14242 @opindex mconstant-gp
14243 Generate code that uses a single constant global pointer value. This is
14244 useful when compiling kernel code.
14245
14246 @item -mauto-pic
14247 @opindex mauto-pic
14248 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
14249 This is useful when compiling firmware code.
14250
14251 @item -minline-float-divide-min-latency
14252 @opindex minline-float-divide-min-latency
14253 Generate code for inline divides of floating-point values
14254 using the minimum latency algorithm.
14255
14256 @item -minline-float-divide-max-throughput
14257 @opindex minline-float-divide-max-throughput
14258 Generate code for inline divides of floating-point values
14259 using the maximum throughput algorithm.
14260
14261 @item -mno-inline-float-divide
14262 @opindex mno-inline-float-divide
14263 Do not generate inline code for divides of floating-point values.
14264
14265 @item -minline-int-divide-min-latency
14266 @opindex minline-int-divide-min-latency
14267 Generate code for inline divides of integer values
14268 using the minimum latency algorithm.
14269
14270 @item -minline-int-divide-max-throughput
14271 @opindex minline-int-divide-max-throughput
14272 Generate code for inline divides of integer values
14273 using the maximum throughput algorithm.
14274
14275 @item -mno-inline-int-divide
14276 @opindex mno-inline-int-divide
14277 Do not generate inline code for divides of integer values.
14278
14279 @item -minline-sqrt-min-latency
14280 @opindex minline-sqrt-min-latency
14281 Generate code for inline square roots
14282 using the minimum latency algorithm.
14283
14284 @item -minline-sqrt-max-throughput
14285 @opindex minline-sqrt-max-throughput
14286 Generate code for inline square roots
14287 using the maximum throughput algorithm.
14288
14289 @item -mno-inline-sqrt
14290 @opindex mno-inline-sqrt
14291 Do not generate inline code for @code{sqrt}.
14292
14293 @item -mfused-madd
14294 @itemx -mno-fused-madd
14295 @opindex mfused-madd
14296 @opindex mno-fused-madd
14297 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14298 instructions. The default is to use these instructions.
14299
14300 @item -mno-dwarf2-asm
14301 @itemx -mdwarf2-asm
14302 @opindex mno-dwarf2-asm
14303 @opindex mdwarf2-asm
14304 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14305 info. This may be useful when not using the GNU assembler.
14306
14307 @item -mearly-stop-bits
14308 @itemx -mno-early-stop-bits
14309 @opindex mearly-stop-bits
14310 @opindex mno-early-stop-bits
14311 Allow stop bits to be placed earlier than immediately preceding the
14312 instruction that triggered the stop bit. This can improve instruction
14313 scheduling, but does not always do so.
14314
14315 @item -mfixed-range=@var{register-range}
14316 @opindex mfixed-range
14317 Generate code treating the given register range as fixed registers.
14318 A fixed register is one that the register allocator cannot use. This is
14319 useful when compiling kernel code. A register range is specified as
14320 two registers separated by a dash. Multiple register ranges can be
14321 specified separated by a comma.
14322
14323 @item -mtls-size=@var{tls-size}
14324 @opindex mtls-size
14325 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
14326 64.
14327
14328 @item -mtune=@var{cpu-type}
14329 @opindex mtune
14330 Tune the instruction scheduling for a particular CPU, Valid values are
14331 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14332 and @samp{mckinley}.
14333
14334 @item -milp32
14335 @itemx -mlp64
14336 @opindex milp32
14337 @opindex mlp64
14338 Generate code for a 32-bit or 64-bit environment.
14339 The 32-bit environment sets int, long and pointer to 32 bits.
14340 The 64-bit environment sets int to 32 bits and long and pointer
14341 to 64 bits. These are HP-UX specific flags.
14342
14343 @item -mno-sched-br-data-spec
14344 @itemx -msched-br-data-spec
14345 @opindex mno-sched-br-data-spec
14346 @opindex msched-br-data-spec
14347 (Dis/En)able data speculative scheduling before reload.
14348 This results in generation of @code{ld.a} instructions and
14349 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14350 The default is 'disable'.
14351
14352 @item -msched-ar-data-spec
14353 @itemx -mno-sched-ar-data-spec
14354 @opindex msched-ar-data-spec
14355 @opindex mno-sched-ar-data-spec
14356 (En/Dis)able data speculative scheduling after reload.
14357 This results in generation of @code{ld.a} instructions and
14358 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14359 The default is 'enable'.
14360
14361 @item -mno-sched-control-spec
14362 @itemx -msched-control-spec
14363 @opindex mno-sched-control-spec
14364 @opindex msched-control-spec
14365 (Dis/En)able control speculative scheduling. This feature is
14366 available only during region scheduling (i.e.@: before reload).
14367 This results in generation of the @code{ld.s} instructions and
14368 the corresponding check instructions @code{chk.s}.
14369 The default is 'disable'.
14370
14371 @item -msched-br-in-data-spec
14372 @itemx -mno-sched-br-in-data-spec
14373 @opindex msched-br-in-data-spec
14374 @opindex mno-sched-br-in-data-spec
14375 (En/Dis)able speculative scheduling of the instructions that
14376 are dependent on the data speculative loads before reload.
14377 This is effective only with @option{-msched-br-data-spec} enabled.
14378 The default is 'enable'.
14379
14380 @item -msched-ar-in-data-spec
14381 @itemx -mno-sched-ar-in-data-spec
14382 @opindex msched-ar-in-data-spec
14383 @opindex mno-sched-ar-in-data-spec
14384 (En/Dis)able speculative scheduling of the instructions that
14385 are dependent on the data speculative loads after reload.
14386 This is effective only with @option{-msched-ar-data-spec} enabled.
14387 The default is 'enable'.
14388
14389 @item -msched-in-control-spec
14390 @itemx -mno-sched-in-control-spec
14391 @opindex msched-in-control-spec
14392 @opindex mno-sched-in-control-spec
14393 (En/Dis)able speculative scheduling of the instructions that
14394 are dependent on the control speculative loads.
14395 This is effective only with @option{-msched-control-spec} enabled.
14396 The default is 'enable'.
14397
14398 @item -mno-sched-prefer-non-data-spec-insns
14399 @itemx -msched-prefer-non-data-spec-insns
14400 @opindex mno-sched-prefer-non-data-spec-insns
14401 @opindex msched-prefer-non-data-spec-insns
14402 If enabled, data-speculative instructions are chosen for schedule
14403 only if there are no other choices at the moment. This makes
14404 the use of the data speculation much more conservative.
14405 The default is 'disable'.
14406
14407 @item -mno-sched-prefer-non-control-spec-insns
14408 @itemx -msched-prefer-non-control-spec-insns
14409 @opindex mno-sched-prefer-non-control-spec-insns
14410 @opindex msched-prefer-non-control-spec-insns
14411 If enabled, control-speculative instructions are chosen for schedule
14412 only if there are no other choices at the moment. This makes
14413 the use of the control speculation much more conservative.
14414 The default is 'disable'.
14415
14416 @item -mno-sched-count-spec-in-critical-path
14417 @itemx -msched-count-spec-in-critical-path
14418 @opindex mno-sched-count-spec-in-critical-path
14419 @opindex msched-count-spec-in-critical-path
14420 If enabled, speculative dependencies are considered during
14421 computation of the instructions priorities. This makes the use of the
14422 speculation a bit more conservative.
14423 The default is 'disable'.
14424
14425 @item -msched-spec-ldc
14426 @opindex msched-spec-ldc
14427 Use a simple data speculation check. This option is on by default.
14428
14429 @item -msched-control-spec-ldc
14430 @opindex msched-spec-ldc
14431 Use a simple check for control speculation. This option is on by default.
14432
14433 @item -msched-stop-bits-after-every-cycle
14434 @opindex msched-stop-bits-after-every-cycle
14435 Place a stop bit after every cycle when scheduling. This option is on
14436 by default.
14437
14438 @item -msched-fp-mem-deps-zero-cost
14439 @opindex msched-fp-mem-deps-zero-cost
14440 Assume that floating-point stores and loads are not likely to cause a conflict
14441 when placed into the same instruction group. This option is disabled by
14442 default.
14443
14444 @item -msel-sched-dont-check-control-spec
14445 @opindex msel-sched-dont-check-control-spec
14446 Generate checks for control speculation in selective scheduling.
14447 This flag is disabled by default.
14448
14449 @item -msched-max-memory-insns=@var{max-insns}
14450 @opindex msched-max-memory-insns
14451 Limit on the number of memory insns per instruction group, giving lower
14452 priority to subsequent memory insns attempting to schedule in the same
14453 instruction group. Frequently useful to prevent cache bank conflicts.
14454 The default value is 1.
14455
14456 @item -msched-max-memory-insns-hard-limit
14457 @opindex msched-max-memory-insns-hard-limit
14458 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14459 disallowing more than that number in an instruction group.
14460 Otherwise, the limit is ``soft'', meaning that non-memory operations
14461 are preferred when the limit is reached, but memory operations may still
14462 be scheduled.
14463
14464 @end table
14465
14466 @node LM32 Options
14467 @subsection LM32 Options
14468 @cindex LM32 options
14469
14470 These @option{-m} options are defined for the Lattice Mico32 architecture:
14471
14472 @table @gcctabopt
14473 @item -mbarrel-shift-enabled
14474 @opindex mbarrel-shift-enabled
14475 Enable barrel-shift instructions.
14476
14477 @item -mdivide-enabled
14478 @opindex mdivide-enabled
14479 Enable divide and modulus instructions.
14480
14481 @item -mmultiply-enabled
14482 @opindex multiply-enabled
14483 Enable multiply instructions.
14484
14485 @item -msign-extend-enabled
14486 @opindex msign-extend-enabled
14487 Enable sign extend instructions.
14488
14489 @item -muser-enabled
14490 @opindex muser-enabled
14491 Enable user-defined instructions.
14492
14493 @end table
14494
14495 @node M32C Options
14496 @subsection M32C Options
14497 @cindex M32C options
14498
14499 @table @gcctabopt
14500 @item -mcpu=@var{name}
14501 @opindex mcpu=
14502 Select the CPU for which code is generated. @var{name} may be one of
14503 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14504 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14505 the M32C/80 series.
14506
14507 @item -msim
14508 @opindex msim
14509 Specifies that the program will be run on the simulator. This causes
14510 an alternate runtime library to be linked in which supports, for
14511 example, file I/O@. You must not use this option when generating
14512 programs that will run on real hardware; you must provide your own
14513 runtime library for whatever I/O functions are needed.
14514
14515 @item -memregs=@var{number}
14516 @opindex memregs=
14517 Specifies the number of memory-based pseudo-registers GCC uses
14518 during code generation. These pseudo-registers are used like real
14519 registers, so there is a tradeoff between GCC's ability to fit the
14520 code into available registers, and the performance penalty of using
14521 memory instead of registers. Note that all modules in a program must
14522 be compiled with the same value for this option. Because of that, you
14523 must not use this option with the default runtime libraries gcc
14524 builds.
14525
14526 @end table
14527
14528 @node M32R/D Options
14529 @subsection M32R/D Options
14530 @cindex M32R/D options
14531
14532 These @option{-m} options are defined for Renesas M32R/D architectures:
14533
14534 @table @gcctabopt
14535 @item -m32r2
14536 @opindex m32r2
14537 Generate code for the M32R/2@.
14538
14539 @item -m32rx
14540 @opindex m32rx
14541 Generate code for the M32R/X@.
14542
14543 @item -m32r
14544 @opindex m32r
14545 Generate code for the M32R@. This is the default.
14546
14547 @item -mmodel=small
14548 @opindex mmodel=small
14549 Assume all objects live in the lower 16MB of memory (so that their addresses
14550 can be loaded with the @code{ld24} instruction), and assume all subroutines
14551 are reachable with the @code{bl} instruction.
14552 This is the default.
14553
14554 The addressability of a particular object can be set with the
14555 @code{model} attribute.
14556
14557 @item -mmodel=medium
14558 @opindex mmodel=medium
14559 Assume objects may be anywhere in the 32-bit address space (the compiler
14560 generates @code{seth/add3} instructions to load their addresses), and
14561 assume all subroutines are reachable with the @code{bl} instruction.
14562
14563 @item -mmodel=large
14564 @opindex mmodel=large
14565 Assume objects may be anywhere in the 32-bit address space (the compiler
14566 generates @code{seth/add3} instructions to load their addresses), and
14567 assume subroutines may not be reachable with the @code{bl} instruction
14568 (the compiler generates the much slower @code{seth/add3/jl}
14569 instruction sequence).
14570
14571 @item -msdata=none
14572 @opindex msdata=none
14573 Disable use of the small data area. Variables are put into
14574 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
14575 @code{section} attribute has been specified).
14576 This is the default.
14577
14578 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14579 Objects may be explicitly put in the small data area with the
14580 @code{section} attribute using one of these sections.
14581
14582 @item -msdata=sdata
14583 @opindex msdata=sdata
14584 Put small global and static data in the small data area, but do not
14585 generate special code to reference them.
14586
14587 @item -msdata=use
14588 @opindex msdata=use
14589 Put small global and static data in the small data area, and generate
14590 special instructions to reference them.
14591
14592 @item -G @var{num}
14593 @opindex G
14594 @cindex smaller data references
14595 Put global and static objects less than or equal to @var{num} bytes
14596 into the small data or bss sections instead of the normal data or bss
14597 sections. The default value of @var{num} is 8.
14598 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14599 for this option to have any effect.
14600
14601 All modules should be compiled with the same @option{-G @var{num}} value.
14602 Compiling with different values of @var{num} may or may not work; if it
14603 doesn't the linker gives an error message---incorrect code is not
14604 generated.
14605
14606 @item -mdebug
14607 @opindex mdebug
14608 Makes the M32R specific code in the compiler display some statistics
14609 that might help in debugging programs.
14610
14611 @item -malign-loops
14612 @opindex malign-loops
14613 Align all loops to a 32-byte boundary.
14614
14615 @item -mno-align-loops
14616 @opindex mno-align-loops
14617 Do not enforce a 32-byte alignment for loops. This is the default.
14618
14619 @item -missue-rate=@var{number}
14620 @opindex missue-rate=@var{number}
14621 Issue @var{number} instructions per cycle. @var{number} can only be 1
14622 or 2.
14623
14624 @item -mbranch-cost=@var{number}
14625 @opindex mbranch-cost=@var{number}
14626 @var{number} can only be 1 or 2. If it is 1 then branches are
14627 preferred over conditional code, if it is 2, then the opposite applies.
14628
14629 @item -mflush-trap=@var{number}
14630 @opindex mflush-trap=@var{number}
14631 Specifies the trap number to use to flush the cache. The default is
14632 12. Valid numbers are between 0 and 15 inclusive.
14633
14634 @item -mno-flush-trap
14635 @opindex mno-flush-trap
14636 Specifies that the cache cannot be flushed by using a trap.
14637
14638 @item -mflush-func=@var{name}
14639 @opindex mflush-func=@var{name}
14640 Specifies the name of the operating system function to call to flush
14641 the cache. The default is @emph{_flush_cache}, but a function call
14642 is only used if a trap is not available.
14643
14644 @item -mno-flush-func
14645 @opindex mno-flush-func
14646 Indicates that there is no OS function for flushing the cache.
14647
14648 @end table
14649
14650 @node M680x0 Options
14651 @subsection M680x0 Options
14652 @cindex M680x0 options
14653
14654 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14655 The default settings depend on which architecture was selected when
14656 the compiler was configured; the defaults for the most common choices
14657 are given below.
14658
14659 @table @gcctabopt
14660 @item -march=@var{arch}
14661 @opindex march
14662 Generate code for a specific M680x0 or ColdFire instruction set
14663 architecture. Permissible values of @var{arch} for M680x0
14664 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14665 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire
14666 architectures are selected according to Freescale's ISA classification
14667 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14668 @samp{isab} and @samp{isac}.
14669
14670 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14671 code for a ColdFire target. The @var{arch} in this macro is one of the
14672 @option{-march} arguments given above.
14673
14674 When used together, @option{-march} and @option{-mtune} select code
14675 that runs on a family of similar processors but that is optimized
14676 for a particular microarchitecture.
14677
14678 @item -mcpu=@var{cpu}
14679 @opindex mcpu
14680 Generate code for a specific M680x0 or ColdFire processor.
14681 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14682 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14683 and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table
14684 below, which also classifies the CPUs into families:
14685
14686 @multitable @columnfractions 0.20 0.80
14687 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14688 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51ag} @samp{51cn} @samp{51em} @samp{51je} @samp{51jf} @samp{51jg} @samp{51jm} @samp{51mm} @samp{51qe} @samp{51qm}
14689 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14690 @item @samp{5206e} @tab @samp{5206e}
14691 @item @samp{5208} @tab @samp{5207} @samp{5208}
14692 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14693 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14694 @item @samp{5216} @tab @samp{5214} @samp{5216}
14695 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14696 @item @samp{5225} @tab @samp{5224} @samp{5225}
14697 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14698 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14699 @item @samp{5249} @tab @samp{5249}
14700 @item @samp{5250} @tab @samp{5250}
14701 @item @samp{5271} @tab @samp{5270} @samp{5271}
14702 @item @samp{5272} @tab @samp{5272}
14703 @item @samp{5275} @tab @samp{5274} @samp{5275}
14704 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14705 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14706 @item @samp{5307} @tab @samp{5307}
14707 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14708 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14709 @item @samp{5407} @tab @samp{5407}
14710 @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}
14711 @end multitable
14712
14713 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14714 @var{arch} is compatible with @var{cpu}. Other combinations of
14715 @option{-mcpu} and @option{-march} are rejected.
14716
14717 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14718 @var{cpu} is selected. It also defines @samp{__mcf_family_@var{family}},
14719 where the value of @var{family} is given by the table above.
14720
14721 @item -mtune=@var{tune}
14722 @opindex mtune
14723 Tune the code for a particular microarchitecture, within the
14724 constraints set by @option{-march} and @option{-mcpu}.
14725 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14726 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14727 and @samp{cpu32}. The ColdFire microarchitectures
14728 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14729
14730 You can also use @option{-mtune=68020-40} for code that needs
14731 to run relatively well on 68020, 68030 and 68040 targets.
14732 @option{-mtune=68020-60} is similar but includes 68060 targets
14733 as well. These two options select the same tuning decisions as
14734 @option{-m68020-40} and @option{-m68020-60} respectively.
14735
14736 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14737 when tuning for 680x0 architecture @var{arch}. It also defines
14738 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14739 option is used. If GCC is tuning for a range of architectures,
14740 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14741 it defines the macros for every architecture in the range.
14742
14743 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
14744 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14745 of the arguments given above.
14746
14747 @item -m68000
14748 @itemx -mc68000
14749 @opindex m68000
14750 @opindex mc68000
14751 Generate output for a 68000. This is the default
14752 when the compiler is configured for 68000-based systems.
14753 It is equivalent to @option{-march=68000}.
14754
14755 Use this option for microcontrollers with a 68000 or EC000 core,
14756 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14757
14758 @item -m68010
14759 @opindex m68010
14760 Generate output for a 68010. This is the default
14761 when the compiler is configured for 68010-based systems.
14762 It is equivalent to @option{-march=68010}.
14763
14764 @item -m68020
14765 @itemx -mc68020
14766 @opindex m68020
14767 @opindex mc68020
14768 Generate output for a 68020. This is the default
14769 when the compiler is configured for 68020-based systems.
14770 It is equivalent to @option{-march=68020}.
14771
14772 @item -m68030
14773 @opindex m68030
14774 Generate output for a 68030. This is the default when the compiler is
14775 configured for 68030-based systems. It is equivalent to
14776 @option{-march=68030}.
14777
14778 @item -m68040
14779 @opindex m68040
14780 Generate output for a 68040. This is the default when the compiler is
14781 configured for 68040-based systems. It is equivalent to
14782 @option{-march=68040}.
14783
14784 This option inhibits the use of 68881/68882 instructions that have to be
14785 emulated by software on the 68040. Use this option if your 68040 does not
14786 have code to emulate those instructions.
14787
14788 @item -m68060
14789 @opindex m68060
14790 Generate output for a 68060. This is the default when the compiler is
14791 configured for 68060-based systems. It is equivalent to
14792 @option{-march=68060}.
14793
14794 This option inhibits the use of 68020 and 68881/68882 instructions that
14795 have to be emulated by software on the 68060. Use this option if your 68060
14796 does not have code to emulate those instructions.
14797
14798 @item -mcpu32
14799 @opindex mcpu32
14800 Generate output for a CPU32. This is the default
14801 when the compiler is configured for CPU32-based systems.
14802 It is equivalent to @option{-march=cpu32}.
14803
14804 Use this option for microcontrollers with a
14805 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14806 68336, 68340, 68341, 68349 and 68360.
14807
14808 @item -m5200
14809 @opindex m5200
14810 Generate output for a 520X ColdFire CPU@. This is the default
14811 when the compiler is configured for 520X-based systems.
14812 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14813 in favor of that option.
14814
14815 Use this option for microcontroller with a 5200 core, including
14816 the MCF5202, MCF5203, MCF5204 and MCF5206.
14817
14818 @item -m5206e
14819 @opindex m5206e
14820 Generate output for a 5206e ColdFire CPU@. The option is now
14821 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14822
14823 @item -m528x
14824 @opindex m528x
14825 Generate output for a member of the ColdFire 528X family.
14826 The option is now deprecated in favor of the equivalent
14827 @option{-mcpu=528x}.
14828
14829 @item -m5307
14830 @opindex m5307
14831 Generate output for a ColdFire 5307 CPU@. The option is now deprecated
14832 in favor of the equivalent @option{-mcpu=5307}.
14833
14834 @item -m5407
14835 @opindex m5407
14836 Generate output for a ColdFire 5407 CPU@. The option is now deprecated
14837 in favor of the equivalent @option{-mcpu=5407}.
14838
14839 @item -mcfv4e
14840 @opindex mcfv4e
14841 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14842 This includes use of hardware floating-point instructions.
14843 The option is equivalent to @option{-mcpu=547x}, and is now
14844 deprecated in favor of that option.
14845
14846 @item -m68020-40
14847 @opindex m68020-40
14848 Generate output for a 68040, without using any of the new instructions.
14849 This results in code that can run relatively efficiently on either a
14850 68020/68881 or a 68030 or a 68040. The generated code does use the
14851 68881 instructions that are emulated on the 68040.
14852
14853 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14854
14855 @item -m68020-60
14856 @opindex m68020-60
14857 Generate output for a 68060, without using any of the new instructions.
14858 This results in code that can run relatively efficiently on either a
14859 68020/68881 or a 68030 or a 68040. The generated code does use the
14860 68881 instructions that are emulated on the 68060.
14861
14862 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14863
14864 @item -mhard-float
14865 @itemx -m68881
14866 @opindex mhard-float
14867 @opindex m68881
14868 Generate floating-point instructions. This is the default for 68020
14869 and above, and for ColdFire devices that have an FPU@. It defines the
14870 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14871 on ColdFire targets.
14872
14873 @item -msoft-float
14874 @opindex msoft-float
14875 Do not generate floating-point instructions; use library calls instead.
14876 This is the default for 68000, 68010, and 68832 targets. It is also
14877 the default for ColdFire devices that have no FPU.
14878
14879 @item -mdiv
14880 @itemx -mno-div
14881 @opindex mdiv
14882 @opindex mno-div
14883 Generate (do not generate) ColdFire hardware divide and remainder
14884 instructions. If @option{-march} is used without @option{-mcpu},
14885 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14886 architectures. Otherwise, the default is taken from the target CPU
14887 (either the default CPU, or the one specified by @option{-mcpu}). For
14888 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14889 @option{-mcpu=5206e}.
14890
14891 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14892
14893 @item -mshort
14894 @opindex mshort
14895 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14896 Additionally, parameters passed on the stack are also aligned to a
14897 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14898
14899 @item -mno-short
14900 @opindex mno-short
14901 Do not consider type @code{int} to be 16 bits wide. This is the default.
14902
14903 @item -mnobitfield
14904 @itemx -mno-bitfield
14905 @opindex mnobitfield
14906 @opindex mno-bitfield
14907 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
14908 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14909
14910 @item -mbitfield
14911 @opindex mbitfield
14912 Do use the bit-field instructions. The @option{-m68020} option implies
14913 @option{-mbitfield}. This is the default if you use a configuration
14914 designed for a 68020.
14915
14916 @item -mrtd
14917 @opindex mrtd
14918 Use a different function-calling convention, in which functions
14919 that take a fixed number of arguments return with the @code{rtd}
14920 instruction, which pops their arguments while returning. This
14921 saves one instruction in the caller since there is no need to pop
14922 the arguments there.
14923
14924 This calling convention is incompatible with the one normally
14925 used on Unix, so you cannot use it if you need to call libraries
14926 compiled with the Unix compiler.
14927
14928 Also, you must provide function prototypes for all functions that
14929 take variable numbers of arguments (including @code{printf});
14930 otherwise incorrect code is generated for calls to those
14931 functions.
14932
14933 In addition, seriously incorrect code results if you call a
14934 function with too many arguments. (Normally, extra arguments are
14935 harmlessly ignored.)
14936
14937 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14938 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14939
14940 @item -mno-rtd
14941 @opindex mno-rtd
14942 Do not use the calling conventions selected by @option{-mrtd}.
14943 This is the default.
14944
14945 @item -malign-int
14946 @itemx -mno-align-int
14947 @opindex malign-int
14948 @opindex mno-align-int
14949 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14950 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14951 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14952 Aligning variables on 32-bit boundaries produces code that runs somewhat
14953 faster on processors with 32-bit busses at the expense of more memory.
14954
14955 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
14956 aligns structures containing the above types differently than
14957 most published application binary interface specifications for the m68k.
14958
14959 @item -mpcrel
14960 @opindex mpcrel
14961 Use the pc-relative addressing mode of the 68000 directly, instead of
14962 using a global offset table. At present, this option implies @option{-fpic},
14963 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
14964 not presently supported with @option{-mpcrel}, though this could be supported for
14965 68020 and higher processors.
14966
14967 @item -mno-strict-align
14968 @itemx -mstrict-align
14969 @opindex mno-strict-align
14970 @opindex mstrict-align
14971 Do not (do) assume that unaligned memory references are handled by
14972 the system.
14973
14974 @item -msep-data
14975 Generate code that allows the data segment to be located in a different
14976 area of memory from the text segment. This allows for execute in place in
14977 an environment without virtual memory management. This option implies
14978 @option{-fPIC}.
14979
14980 @item -mno-sep-data
14981 Generate code that assumes that the data segment follows the text segment.
14982 This is the default.
14983
14984 @item -mid-shared-library
14985 Generate code that supports shared libraries via the library ID method.
14986 This allows for execute in place and shared libraries in an environment
14987 without virtual memory management. This option implies @option{-fPIC}.
14988
14989 @item -mno-id-shared-library
14990 Generate code that doesn't assume ID based shared libraries are being used.
14991 This is the default.
14992
14993 @item -mshared-library-id=n
14994 Specifies the identification number of the ID-based shared library being
14995 compiled. Specifying a value of 0 generates more compact code; specifying
14996 other values forces the allocation of that number to the current
14997 library, but is no more space- or time-efficient than omitting this option.
14998
14999 @item -mxgot
15000 @itemx -mno-xgot
15001 @opindex mxgot
15002 @opindex mno-xgot
15003 When generating position-independent code for ColdFire, generate code
15004 that works if the GOT has more than 8192 entries. This code is
15005 larger and slower than code generated without this option. On M680x0
15006 processors, this option is not needed; @option{-fPIC} suffices.
15007
15008 GCC normally uses a single instruction to load values from the GOT@.
15009 While this is relatively efficient, it only works if the GOT
15010 is smaller than about 64k. Anything larger causes the linker
15011 to report an error such as:
15012
15013 @cindex relocation truncated to fit (ColdFire)
15014 @smallexample
15015 relocation truncated to fit: R_68K_GOT16O foobar
15016 @end smallexample
15017
15018 If this happens, you should recompile your code with @option{-mxgot}.
15019 It should then work with very large GOTs. However, code generated with
15020 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15021 the value of a global symbol.
15022
15023 Note that some linkers, including newer versions of the GNU linker,
15024 can create multiple GOTs and sort GOT entries. If you have such a linker,
15025 you should only need to use @option{-mxgot} when compiling a single
15026 object file that accesses more than 8192 GOT entries. Very few do.
15027
15028 These options have no effect unless GCC is generating
15029 position-independent code.
15030
15031 @end table
15032
15033 @node MCore Options
15034 @subsection MCore Options
15035 @cindex MCore options
15036
15037 These are the @samp{-m} options defined for the Motorola M*Core
15038 processors.
15039
15040 @table @gcctabopt
15041
15042 @item -mhardlit
15043 @itemx -mno-hardlit
15044 @opindex mhardlit
15045 @opindex mno-hardlit
15046 Inline constants into the code stream if it can be done in two
15047 instructions or less.
15048
15049 @item -mdiv
15050 @itemx -mno-div
15051 @opindex mdiv
15052 @opindex mno-div
15053 Use the divide instruction. (Enabled by default).
15054
15055 @item -mrelax-immediate
15056 @itemx -mno-relax-immediate
15057 @opindex mrelax-immediate
15058 @opindex mno-relax-immediate
15059 Allow arbitrary sized immediates in bit operations.
15060
15061 @item -mwide-bitfields
15062 @itemx -mno-wide-bitfields
15063 @opindex mwide-bitfields
15064 @opindex mno-wide-bitfields
15065 Always treat bit-fields as int-sized.
15066
15067 @item -m4byte-functions
15068 @itemx -mno-4byte-functions
15069 @opindex m4byte-functions
15070 @opindex mno-4byte-functions
15071 Force all functions to be aligned to a 4-byte boundary.
15072
15073 @item -mcallgraph-data
15074 @itemx -mno-callgraph-data
15075 @opindex mcallgraph-data
15076 @opindex mno-callgraph-data
15077 Emit callgraph information.
15078
15079 @item -mslow-bytes
15080 @itemx -mno-slow-bytes
15081 @opindex mslow-bytes
15082 @opindex mno-slow-bytes
15083 Prefer word access when reading byte quantities.
15084
15085 @item -mlittle-endian
15086 @itemx -mbig-endian
15087 @opindex mlittle-endian
15088 @opindex mbig-endian
15089 Generate code for a little-endian target.
15090
15091 @item -m210
15092 @itemx -m340
15093 @opindex m210
15094 @opindex m340
15095 Generate code for the 210 processor.
15096
15097 @item -mno-lsim
15098 @opindex mno-lsim
15099 Assume that runtime support has been provided and so omit the
15100 simulator library (@file{libsim.a)} from the linker command line.
15101
15102 @item -mstack-increment=@var{size}
15103 @opindex mstack-increment
15104 Set the maximum amount for a single stack increment operation. Large
15105 values can increase the speed of programs that contain functions
15106 that need a large amount of stack space, but they can also trigger a
15107 segmentation fault if the stack is extended too much. The default
15108 value is 0x1000.
15109
15110 @end table
15111
15112 @node MeP Options
15113 @subsection MeP Options
15114 @cindex MeP options
15115
15116 @table @gcctabopt
15117
15118 @item -mabsdiff
15119 @opindex mabsdiff
15120 Enables the @code{abs} instruction, which is the absolute difference
15121 between two registers.
15122
15123 @item -mall-opts
15124 @opindex mall-opts
15125 Enables all the optional instructions---average, multiply, divide, bit
15126 operations, leading zero, absolute difference, min/max, clip, and
15127 saturation.
15128
15129
15130 @item -maverage
15131 @opindex maverage
15132 Enables the @code{ave} instruction, which computes the average of two
15133 registers.
15134
15135 @item -mbased=@var{n}
15136 @opindex mbased=
15137 Variables of size @var{n} bytes or smaller are placed in the
15138 @code{.based} section by default. Based variables use the @code{$tp}
15139 register as a base register, and there is a 128-byte limit to the
15140 @code{.based} section.
15141
15142 @item -mbitops
15143 @opindex mbitops
15144 Enables the bit operation instructions---bit test (@code{btstm}), set
15145 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15146 test-and-set (@code{tas}).
15147
15148 @item -mc=@var{name}
15149 @opindex mc=
15150 Selects which section constant data is placed in. @var{name} may
15151 be @code{tiny}, @code{near}, or @code{far}.
15152
15153 @item -mclip
15154 @opindex mclip
15155 Enables the @code{clip} instruction. Note that @code{-mclip} is not
15156 useful unless you also provide @code{-mminmax}.
15157
15158 @item -mconfig=@var{name}
15159 @opindex mconfig=
15160 Selects one of the build-in core configurations. Each MeP chip has
15161 one or more modules in it; each module has a core CPU and a variety of
15162 coprocessors, optional instructions, and peripherals. The
15163 @code{MeP-Integrator} tool, not part of GCC, provides these
15164 configurations through this option; using this option is the same as
15165 using all the corresponding command-line options. The default
15166 configuration is @code{default}.
15167
15168 @item -mcop
15169 @opindex mcop
15170 Enables the coprocessor instructions. By default, this is a 32-bit
15171 coprocessor. Note that the coprocessor is normally enabled via the
15172 @code{-mconfig=} option.
15173
15174 @item -mcop32
15175 @opindex mcop32
15176 Enables the 32-bit coprocessor's instructions.
15177
15178 @item -mcop64
15179 @opindex mcop64
15180 Enables the 64-bit coprocessor's instructions.
15181
15182 @item -mivc2
15183 @opindex mivc2
15184 Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor.
15185
15186 @item -mdc
15187 @opindex mdc
15188 Causes constant variables to be placed in the @code{.near} section.
15189
15190 @item -mdiv
15191 @opindex mdiv
15192 Enables the @code{div} and @code{divu} instructions.
15193
15194 @item -meb
15195 @opindex meb
15196 Generate big-endian code.
15197
15198 @item -mel
15199 @opindex mel
15200 Generate little-endian code.
15201
15202 @item -mio-volatile
15203 @opindex mio-volatile
15204 Tells the compiler that any variable marked with the @code{io}
15205 attribute is to be considered volatile.
15206
15207 @item -ml
15208 @opindex ml
15209 Causes variables to be assigned to the @code{.far} section by default.
15210
15211 @item -mleadz
15212 @opindex mleadz
15213 Enables the @code{leadz} (leading zero) instruction.
15214
15215 @item -mm
15216 @opindex mm
15217 Causes variables to be assigned to the @code{.near} section by default.
15218
15219 @item -mminmax
15220 @opindex mminmax
15221 Enables the @code{min} and @code{max} instructions.
15222
15223 @item -mmult
15224 @opindex mmult
15225 Enables the multiplication and multiply-accumulate instructions.
15226
15227 @item -mno-opts
15228 @opindex mno-opts
15229 Disables all the optional instructions enabled by @code{-mall-opts}.
15230
15231 @item -mrepeat
15232 @opindex mrepeat
15233 Enables the @code{repeat} and @code{erepeat} instructions, used for
15234 low-overhead looping.
15235
15236 @item -ms
15237 @opindex ms
15238 Causes all variables to default to the @code{.tiny} section. Note
15239 that there is a 65536-byte limit to this section. Accesses to these
15240 variables use the @code{%gp} base register.
15241
15242 @item -msatur
15243 @opindex msatur
15244 Enables the saturation instructions. Note that the compiler does not
15245 currently generate these itself, but this option is included for
15246 compatibility with other tools, like @code{as}.
15247
15248 @item -msdram
15249 @opindex msdram
15250 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15251
15252 @item -msim
15253 @opindex msim
15254 Link the simulator runtime libraries.
15255
15256 @item -msimnovec
15257 @opindex msimnovec
15258 Link the simulator runtime libraries, excluding built-in support
15259 for reset and exception vectors and tables.
15260
15261 @item -mtf
15262 @opindex mtf
15263 Causes all functions to default to the @code{.far} section. Without
15264 this option, functions default to the @code{.near} section.
15265
15266 @item -mtiny=@var{n}
15267 @opindex mtiny=
15268 Variables that are @var{n} bytes or smaller are allocated to the
15269 @code{.tiny} section. These variables use the @code{$gp} base
15270 register. The default for this option is 4, but note that there's a
15271 65536-byte limit to the @code{.tiny} section.
15272
15273 @end table
15274
15275 @node MicroBlaze Options
15276 @subsection MicroBlaze Options
15277 @cindex MicroBlaze Options
15278
15279 @table @gcctabopt
15280
15281 @item -msoft-float
15282 @opindex msoft-float
15283 Use software emulation for floating point (default).
15284
15285 @item -mhard-float
15286 @opindex mhard-float
15287 Use hardware floating-point instructions.
15288
15289 @item -mmemcpy
15290 @opindex mmemcpy
15291 Do not optimize block moves, use @code{memcpy}.
15292
15293 @item -mno-clearbss
15294 @opindex mno-clearbss
15295 This option is deprecated. Use @option{-fno-zero-initialized-in-bss} instead.
15296
15297 @item -mcpu=@var{cpu-type}
15298 @opindex mcpu=
15299 Use features of and schedule code for given CPU.
15300 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15301 where @var{X} is a major version, @var{YY} is the minor version, and
15302 @var{Z} is compatibility code. Example values are @samp{v3.00.a},
15303 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15304
15305 @item -mxl-soft-mul
15306 @opindex mxl-soft-mul
15307 Use software multiply emulation (default).
15308
15309 @item -mxl-soft-div
15310 @opindex mxl-soft-div
15311 Use software emulation for divides (default).
15312
15313 @item -mxl-barrel-shift
15314 @opindex mxl-barrel-shift
15315 Use the hardware barrel shifter.
15316
15317 @item -mxl-pattern-compare
15318 @opindex mxl-pattern-compare
15319 Use pattern compare instructions.
15320
15321 @item -msmall-divides
15322 @opindex msmall-divides
15323 Use table lookup optimization for small signed integer divisions.
15324
15325 @item -mxl-stack-check
15326 @opindex mxl-stack-check
15327 This option is deprecated. Use @option{-fstack-check} instead.
15328
15329 @item -mxl-gp-opt
15330 @opindex mxl-gp-opt
15331 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15332
15333 @item -mxl-multiply-high
15334 @opindex mxl-multiply-high
15335 Use multiply high instructions for high part of 32x32 multiply.
15336
15337 @item -mxl-float-convert
15338 @opindex mxl-float-convert
15339 Use hardware floating-point conversion instructions.
15340
15341 @item -mxl-float-sqrt
15342 @opindex mxl-float-sqrt
15343 Use hardware floating-point square root instruction.
15344
15345 @item -mxl-mode-@var{app-model}
15346 Select application model @var{app-model}. Valid models are
15347 @table @samp
15348 @item executable
15349 normal executable (default), uses startup code @file{crt0.o}.
15350
15351 @item xmdstub
15352 for use with Xilinx Microprocessor Debugger (XMD) based
15353 software intrusive debug agent called xmdstub. This uses startup file
15354 @file{crt1.o} and sets the start address of the program to be 0x800.
15355
15356 @item bootstrap
15357 for applications that are loaded using a bootloader.
15358 This model uses startup file @file{crt2.o} which does not contain a processor
15359 reset vector handler. This is suitable for transferring control on a
15360 processor reset to the bootloader rather than the application.
15361
15362 @item novectors
15363 for applications that do not require any of the
15364 MicroBlaze vectors. This option may be useful for applications running
15365 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15366 @end table
15367
15368 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15369 @option{-mxl-mode-@var{app-model}}.
15370
15371 @end table
15372
15373 @node MIPS Options
15374 @subsection MIPS Options
15375 @cindex MIPS options
15376
15377 @table @gcctabopt
15378
15379 @item -EB
15380 @opindex EB
15381 Generate big-endian code.
15382
15383 @item -EL
15384 @opindex EL
15385 Generate little-endian code. This is the default for @samp{mips*el-*-*}
15386 configurations.
15387
15388 @item -march=@var{arch}
15389 @opindex march
15390 Generate code that runs on @var{arch}, which can be the name of a
15391 generic MIPS ISA, or the name of a particular processor.
15392 The ISA names are:
15393 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15394 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15395 The processor names are:
15396 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15397 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15398 @samp{5kc}, @samp{5kf},
15399 @samp{20kc},
15400 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15401 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15402 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15403 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15404 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15405 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15406 @samp{m4k},
15407 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15408 @samp{orion},
15409 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15410 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15411 @samp{rm7000}, @samp{rm9000},
15412 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15413 @samp{sb1},
15414 @samp{sr71000},
15415 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15416 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15417 @samp{xlr} and @samp{xlp}.
15418 The special value @samp{from-abi} selects the
15419 most compatible architecture for the selected ABI (that is,
15420 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15421
15422 The native Linux/GNU toolchain also supports the value @samp{native},
15423 which selects the best architecture option for the host processor.
15424 @option{-march=native} has no effect if GCC does not recognize
15425 the processor.
15426
15427 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15428 (for example, @option{-march=r2k}). Prefixes are optional, and
15429 @samp{vr} may be written @samp{r}.
15430
15431 Names of the form @samp{@var{n}f2_1} refer to processors with
15432 FPUs clocked at half the rate of the core, names of the form
15433 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15434 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15435 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15436 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15437 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15438 accepted as synonyms for @samp{@var{n}f1_1}.
15439
15440 GCC defines two macros based on the value of this option. The first
15441 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15442 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
15443 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15444 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15445 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15446
15447 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15448 above. In other words, it has the full prefix and does not
15449 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
15450 the macro names the resolved architecture (either @samp{"mips1"} or
15451 @samp{"mips3"}). It names the default architecture when no
15452 @option{-march} option is given.
15453
15454 @item -mtune=@var{arch}
15455 @opindex mtune
15456 Optimize for @var{arch}. Among other things, this option controls
15457 the way instructions are scheduled, and the perceived cost of arithmetic
15458 operations. The list of @var{arch} values is the same as for
15459 @option{-march}.
15460
15461 When this option is not used, GCC optimizes for the processor
15462 specified by @option{-march}. By using @option{-march} and
15463 @option{-mtune} together, it is possible to generate code that
15464 runs on a family of processors, but optimize the code for one
15465 particular member of that family.
15466
15467 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15468 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15469 @option{-march} ones described above.
15470
15471 @item -mips1
15472 @opindex mips1
15473 Equivalent to @option{-march=mips1}.
15474
15475 @item -mips2
15476 @opindex mips2
15477 Equivalent to @option{-march=mips2}.
15478
15479 @item -mips3
15480 @opindex mips3
15481 Equivalent to @option{-march=mips3}.
15482
15483 @item -mips4
15484 @opindex mips4
15485 Equivalent to @option{-march=mips4}.
15486
15487 @item -mips32
15488 @opindex mips32
15489 Equivalent to @option{-march=mips32}.
15490
15491 @item -mips32r2
15492 @opindex mips32r2
15493 Equivalent to @option{-march=mips32r2}.
15494
15495 @item -mips64
15496 @opindex mips64
15497 Equivalent to @option{-march=mips64}.
15498
15499 @item -mips64r2
15500 @opindex mips64r2
15501 Equivalent to @option{-march=mips64r2}.
15502
15503 @item -mips16
15504 @itemx -mno-mips16
15505 @opindex mips16
15506 @opindex mno-mips16
15507 Generate (do not generate) MIPS16 code. If GCC is targeting a
15508 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15509
15510 MIPS16 code generation can also be controlled on a per-function basis
15511 by means of @code{mips16} and @code{nomips16} attributes.
15512 @xref{Function Attributes}, for more information.
15513
15514 @item -mflip-mips16
15515 @opindex mflip-mips16
15516 Generate MIPS16 code on alternating functions. This option is provided
15517 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15518 not intended for ordinary use in compiling user code.
15519
15520 @item -minterlink-mips16
15521 @itemx -mno-interlink-mips16
15522 @opindex minterlink-mips16
15523 @opindex mno-interlink-mips16
15524 Require (do not require) that non-MIPS16 code be link-compatible with
15525 MIPS16 code.
15526
15527 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15528 it must either use a call or an indirect jump. @option{-minterlink-mips16}
15529 therefore disables direct jumps unless GCC knows that the target of the
15530 jump is not MIPS16.
15531
15532 @item -mabi=32
15533 @itemx -mabi=o64
15534 @itemx -mabi=n32
15535 @itemx -mabi=64
15536 @itemx -mabi=eabi
15537 @opindex mabi=32
15538 @opindex mabi=o64
15539 @opindex mabi=n32
15540 @opindex mabi=64
15541 @opindex mabi=eabi
15542 Generate code for the given ABI@.
15543
15544 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
15545 generates 64-bit code when you select a 64-bit architecture, but you
15546 can use @option{-mgp32} to get 32-bit code instead.
15547
15548 For information about the O64 ABI, see
15549 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15550
15551 GCC supports a variant of the o32 ABI in which floating-point registers
15552 are 64 rather than 32 bits wide. You can select this combination with
15553 @option{-mabi=32} @option{-mfp64}. This ABI relies on the @code{mthc1}
15554 and @code{mfhc1} instructions and is therefore only supported for
15555 MIPS32R2 processors.
15556
15557 The register assignments for arguments and return values remain the
15558 same, but each scalar value is passed in a single 64-bit register
15559 rather than a pair of 32-bit registers. For example, scalar
15560 floating-point values are returned in @samp{$f0} only, not a
15561 @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also
15562 remains the same, but all 64 bits are saved.
15563
15564 @item -mabicalls
15565 @itemx -mno-abicalls
15566 @opindex mabicalls
15567 @opindex mno-abicalls
15568 Generate (do not generate) code that is suitable for SVR4-style
15569 dynamic objects. @option{-mabicalls} is the default for SVR4-based
15570 systems.
15571
15572 @item -mshared
15573 @itemx -mno-shared
15574 Generate (do not generate) code that is fully position-independent,
15575 and that can therefore be linked into shared libraries. This option
15576 only affects @option{-mabicalls}.
15577
15578 All @option{-mabicalls} code has traditionally been position-independent,
15579 regardless of options like @option{-fPIC} and @option{-fpic}. However,
15580 as an extension, the GNU toolchain allows executables to use absolute
15581 accesses for locally-binding symbols. It can also use shorter GP
15582 initialization sequences and generate direct calls to locally-defined
15583 functions. This mode is selected by @option{-mno-shared}.
15584
15585 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15586 objects that can only be linked by the GNU linker. However, the option
15587 does not affect the ABI of the final executable; it only affects the ABI
15588 of relocatable objects. Using @option{-mno-shared} generally makes
15589 executables both smaller and quicker.
15590
15591 @option{-mshared} is the default.
15592
15593 @item -mplt
15594 @itemx -mno-plt
15595 @opindex mplt
15596 @opindex mno-plt
15597 Assume (do not assume) that the static and dynamic linkers
15598 support PLTs and copy relocations. This option only affects
15599 @option{-mno-shared -mabicalls}. For the n64 ABI, this option
15600 has no effect without @option{-msym32}.
15601
15602 You can make @option{-mplt} the default by configuring
15603 GCC with @option{--with-mips-plt}. The default is
15604 @option{-mno-plt} otherwise.
15605
15606 @item -mxgot
15607 @itemx -mno-xgot
15608 @opindex mxgot
15609 @opindex mno-xgot
15610 Lift (do not lift) the usual restrictions on the size of the global
15611 offset table.
15612
15613 GCC normally uses a single instruction to load values from the GOT@.
15614 While this is relatively efficient, it only works if the GOT
15615 is smaller than about 64k. Anything larger causes the linker
15616 to report an error such as:
15617
15618 @cindex relocation truncated to fit (MIPS)
15619 @smallexample
15620 relocation truncated to fit: R_MIPS_GOT16 foobar
15621 @end smallexample
15622
15623 If this happens, you should recompile your code with @option{-mxgot}.
15624 This works with very large GOTs, although the code is also
15625 less efficient, since it takes three instructions to fetch the
15626 value of a global symbol.
15627
15628 Note that some linkers can create multiple GOTs. If you have such a
15629 linker, you should only need to use @option{-mxgot} when a single object
15630 file accesses more than 64k's worth of GOT entries. Very few do.
15631
15632 These options have no effect unless GCC is generating position
15633 independent code.
15634
15635 @item -mgp32
15636 @opindex mgp32
15637 Assume that general-purpose registers are 32 bits wide.
15638
15639 @item -mgp64
15640 @opindex mgp64
15641 Assume that general-purpose registers are 64 bits wide.
15642
15643 @item -mfp32
15644 @opindex mfp32
15645 Assume that floating-point registers are 32 bits wide.
15646
15647 @item -mfp64
15648 @opindex mfp64
15649 Assume that floating-point registers are 64 bits wide.
15650
15651 @item -mhard-float
15652 @opindex mhard-float
15653 Use floating-point coprocessor instructions.
15654
15655 @item -msoft-float
15656 @opindex msoft-float
15657 Do not use floating-point coprocessor instructions. Implement
15658 floating-point calculations using library calls instead.
15659
15660 @item -mno-float
15661 @opindex mno-float
15662 Equivalent to @option{-msoft-float}, but additionally asserts that the
15663 program being compiled does not perform any floating-point operations.
15664 This option is presently supported only by some bare-metal MIPS
15665 configurations, where it may select a special set of libraries
15666 that lack all floating-point support (including, for example, the
15667 floating-point @code{printf} formats).
15668 If code compiled with @code{-mno-float} accidentally contains
15669 floating-point operations, it is likely to suffer a link-time
15670 or run-time failure.
15671
15672 @item -msingle-float
15673 @opindex msingle-float
15674 Assume that the floating-point coprocessor only supports single-precision
15675 operations.
15676
15677 @item -mdouble-float
15678 @opindex mdouble-float
15679 Assume that the floating-point coprocessor supports double-precision
15680 operations. This is the default.
15681
15682 @item -mllsc
15683 @itemx -mno-llsc
15684 @opindex mllsc
15685 @opindex mno-llsc
15686 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15687 implement atomic memory built-in functions. When neither option is
15688 specified, GCC uses the instructions if the target architecture
15689 supports them.
15690
15691 @option{-mllsc} is useful if the runtime environment can emulate the
15692 instructions and @option{-mno-llsc} can be useful when compiling for
15693 nonstandard ISAs. You can make either option the default by
15694 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15695 respectively. @option{--with-llsc} is the default for some
15696 configurations; see the installation documentation for details.
15697
15698 @item -mdsp
15699 @itemx -mno-dsp
15700 @opindex mdsp
15701 @opindex mno-dsp
15702 Use (do not use) revision 1 of the MIPS DSP ASE@.
15703 @xref{MIPS DSP Built-in Functions}. This option defines the
15704 preprocessor macro @samp{__mips_dsp}. It also defines
15705 @samp{__mips_dsp_rev} to 1.
15706
15707 @item -mdspr2
15708 @itemx -mno-dspr2
15709 @opindex mdspr2
15710 @opindex mno-dspr2
15711 Use (do not use) revision 2 of the MIPS DSP ASE@.
15712 @xref{MIPS DSP Built-in Functions}. This option defines the
15713 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15714 It also defines @samp{__mips_dsp_rev} to 2.
15715
15716 @item -msmartmips
15717 @itemx -mno-smartmips
15718 @opindex msmartmips
15719 @opindex mno-smartmips
15720 Use (do not use) the MIPS SmartMIPS ASE.
15721
15722 @item -mpaired-single
15723 @itemx -mno-paired-single
15724 @opindex mpaired-single
15725 @opindex mno-paired-single
15726 Use (do not use) paired-single floating-point instructions.
15727 @xref{MIPS Paired-Single Support}. This option requires
15728 hardware floating-point support to be enabled.
15729
15730 @item -mdmx
15731 @itemx -mno-mdmx
15732 @opindex mdmx
15733 @opindex mno-mdmx
15734 Use (do not use) MIPS Digital Media Extension instructions.
15735 This option can only be used when generating 64-bit code and requires
15736 hardware floating-point support to be enabled.
15737
15738 @item -mips3d
15739 @itemx -mno-mips3d
15740 @opindex mips3d
15741 @opindex mno-mips3d
15742 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
15743 The option @option{-mips3d} implies @option{-mpaired-single}.
15744
15745 @item -mmt
15746 @itemx -mno-mt
15747 @opindex mmt
15748 @opindex mno-mt
15749 Use (do not use) MT Multithreading instructions.
15750
15751 @item -mmcu
15752 @itemx -mno-mcu
15753 @opindex mmcu
15754 @opindex mno-mcu
15755 Use (do not use) the MIPS MCU ASE instructions.
15756
15757 @item -mlong64
15758 @opindex mlong64
15759 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
15760 an explanation of the default and the way that the pointer size is
15761 determined.
15762
15763 @item -mlong32
15764 @opindex mlong32
15765 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15766
15767 The default size of @code{int}s, @code{long}s and pointers depends on
15768 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
15769 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15770 32-bit @code{long}s. Pointers are the same size as @code{long}s,
15771 or the same size as integer registers, whichever is smaller.
15772
15773 @item -msym32
15774 @itemx -mno-sym32
15775 @opindex msym32
15776 @opindex mno-sym32
15777 Assume (do not assume) that all symbols have 32-bit values, regardless
15778 of the selected ABI@. This option is useful in combination with
15779 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15780 to generate shorter and faster references to symbolic addresses.
15781
15782 @item -G @var{num}
15783 @opindex G
15784 Put definitions of externally-visible data in a small data section
15785 if that data is no bigger than @var{num} bytes. GCC can then access
15786 the data more efficiently; see @option{-mgpopt} for details.
15787
15788 The default @option{-G} option depends on the configuration.
15789
15790 @item -mlocal-sdata
15791 @itemx -mno-local-sdata
15792 @opindex mlocal-sdata
15793 @opindex mno-local-sdata
15794 Extend (do not extend) the @option{-G} behavior to local data too,
15795 such as to static variables in C@. @option{-mlocal-sdata} is the
15796 default for all configurations.
15797
15798 If the linker complains that an application is using too much small data,
15799 you might want to try rebuilding the less performance-critical parts with
15800 @option{-mno-local-sdata}. You might also want to build large
15801 libraries with @option{-mno-local-sdata}, so that the libraries leave
15802 more room for the main program.
15803
15804 @item -mextern-sdata
15805 @itemx -mno-extern-sdata
15806 @opindex mextern-sdata
15807 @opindex mno-extern-sdata
15808 Assume (do not assume) that externally-defined data is in
15809 a small data section if the size of that data is within the @option{-G} limit.
15810 @option{-mextern-sdata} is the default for all configurations.
15811
15812 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15813 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15814 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15815 is placed in a small data section. If @var{Var} is defined by another
15816 module, you must either compile that module with a high-enough
15817 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15818 definition. If @var{Var} is common, you must link the application
15819 with a high-enough @option{-G} setting.
15820
15821 The easiest way of satisfying these restrictions is to compile
15822 and link every module with the same @option{-G} option. However,
15823 you may wish to build a library that supports several different
15824 small data limits. You can do this by compiling the library with
15825 the highest supported @option{-G} setting and additionally using
15826 @option{-mno-extern-sdata} to stop the library from making assumptions
15827 about externally-defined data.
15828
15829 @item -mgpopt
15830 @itemx -mno-gpopt
15831 @opindex mgpopt
15832 @opindex mno-gpopt
15833 Use (do not use) GP-relative accesses for symbols that are known to be
15834 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15835 @option{-mextern-sdata}. @option{-mgpopt} is the default for all
15836 configurations.
15837
15838 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15839 might not hold the value of @code{_gp}. For example, if the code is
15840 part of a library that might be used in a boot monitor, programs that
15841 call boot monitor routines pass an unknown value in @code{$gp}.
15842 (In such situations, the boot monitor itself is usually compiled
15843 with @option{-G0}.)
15844
15845 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15846 @option{-mno-extern-sdata}.
15847
15848 @item -membedded-data
15849 @itemx -mno-embedded-data
15850 @opindex membedded-data
15851 @opindex mno-embedded-data
15852 Allocate variables to the read-only data section first if possible, then
15853 next in the small data section if possible, otherwise in data. This gives
15854 slightly slower code than the default, but reduces the amount of RAM required
15855 when executing, and thus may be preferred for some embedded systems.
15856
15857 @item -muninit-const-in-rodata
15858 @itemx -mno-uninit-const-in-rodata
15859 @opindex muninit-const-in-rodata
15860 @opindex mno-uninit-const-in-rodata
15861 Put uninitialized @code{const} variables in the read-only data section.
15862 This option is only meaningful in conjunction with @option{-membedded-data}.
15863
15864 @item -mcode-readable=@var{setting}
15865 @opindex mcode-readable
15866 Specify whether GCC may generate code that reads from executable sections.
15867 There are three possible settings:
15868
15869 @table @gcctabopt
15870 @item -mcode-readable=yes
15871 Instructions may freely access executable sections. This is the
15872 default setting.
15873
15874 @item -mcode-readable=pcrel
15875 MIPS16 PC-relative load instructions can access executable sections,
15876 but other instructions must not do so. This option is useful on 4KSc
15877 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15878 It is also useful on processors that can be configured to have a dual
15879 instruction/data SRAM interface and that, like the M4K, automatically
15880 redirect PC-relative loads to the instruction RAM.
15881
15882 @item -mcode-readable=no
15883 Instructions must not access executable sections. This option can be
15884 useful on targets that are configured to have a dual instruction/data
15885 SRAM interface but that (unlike the M4K) do not automatically redirect
15886 PC-relative loads to the instruction RAM.
15887 @end table
15888
15889 @item -msplit-addresses
15890 @itemx -mno-split-addresses
15891 @opindex msplit-addresses
15892 @opindex mno-split-addresses
15893 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15894 relocation operators. This option has been superseded by
15895 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15896
15897 @item -mexplicit-relocs
15898 @itemx -mno-explicit-relocs
15899 @opindex mexplicit-relocs
15900 @opindex mno-explicit-relocs
15901 Use (do not use) assembler relocation operators when dealing with symbolic
15902 addresses. The alternative, selected by @option{-mno-explicit-relocs},
15903 is to use assembler macros instead.
15904
15905 @option{-mexplicit-relocs} is the default if GCC was configured
15906 to use an assembler that supports relocation operators.
15907
15908 @item -mcheck-zero-division
15909 @itemx -mno-check-zero-division
15910 @opindex mcheck-zero-division
15911 @opindex mno-check-zero-division
15912 Trap (do not trap) on integer division by zero.
15913
15914 The default is @option{-mcheck-zero-division}.
15915
15916 @item -mdivide-traps
15917 @itemx -mdivide-breaks
15918 @opindex mdivide-traps
15919 @opindex mdivide-breaks
15920 MIPS systems check for division by zero by generating either a
15921 conditional trap or a break instruction. Using traps results in
15922 smaller code, but is only supported on MIPS II and later. Also, some
15923 versions of the Linux kernel have a bug that prevents trap from
15924 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
15925 allow conditional traps on architectures that support them and
15926 @option{-mdivide-breaks} to force the use of breaks.
15927
15928 The default is usually @option{-mdivide-traps}, but this can be
15929 overridden at configure time using @option{--with-divide=breaks}.
15930 Divide-by-zero checks can be completely disabled using
15931 @option{-mno-check-zero-division}.
15932
15933 @item -mmemcpy
15934 @itemx -mno-memcpy
15935 @opindex mmemcpy
15936 @opindex mno-memcpy
15937 Force (do not force) the use of @code{memcpy()} for non-trivial block
15938 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
15939 most constant-sized copies.
15940
15941 @item -mlong-calls
15942 @itemx -mno-long-calls
15943 @opindex mlong-calls
15944 @opindex mno-long-calls
15945 Disable (do not disable) use of the @code{jal} instruction. Calling
15946 functions using @code{jal} is more efficient but requires the caller
15947 and callee to be in the same 256 megabyte segment.
15948
15949 This option has no effect on abicalls code. The default is
15950 @option{-mno-long-calls}.
15951
15952 @item -mmad
15953 @itemx -mno-mad
15954 @opindex mmad
15955 @opindex mno-mad
15956 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15957 instructions, as provided by the R4650 ISA@.
15958
15959 @item -mfused-madd
15960 @itemx -mno-fused-madd
15961 @opindex mfused-madd
15962 @opindex mno-fused-madd
15963 Enable (disable) use of the floating-point multiply-accumulate
15964 instructions, when they are available. The default is
15965 @option{-mfused-madd}.
15966
15967 When multiply-accumulate instructions are used, the intermediate
15968 product is calculated to infinite precision and is not subject to
15969 the FCSR Flush to Zero bit. This may be undesirable in some
15970 circumstances.
15971
15972 @item -nocpp
15973 @opindex nocpp
15974 Tell the MIPS assembler to not run its preprocessor over user
15975 assembler files (with a @samp{.s} suffix) when assembling them.
15976
15977 @item -mfix-24k
15978 @item -mno-fix-24k
15979 @opindex mfix-24k
15980 @opindex mno-fix-24k
15981 Work around the 24K E48 (lost data on stores during refill) errata.
15982 The workarounds are implemented by the assembler rather than by GCC@.
15983
15984 @item -mfix-r4000
15985 @itemx -mno-fix-r4000
15986 @opindex mfix-r4000
15987 @opindex mno-fix-r4000
15988 Work around certain R4000 CPU errata:
15989 @itemize @minus
15990 @item
15991 A double-word or a variable shift may give an incorrect result if executed
15992 immediately after starting an integer division.
15993 @item
15994 A double-word or a variable shift may give an incorrect result if executed
15995 while an integer multiplication is in progress.
15996 @item
15997 An integer division may give an incorrect result if started in a delay slot
15998 of a taken branch or a jump.
15999 @end itemize
16000
16001 @item -mfix-r4400
16002 @itemx -mno-fix-r4400
16003 @opindex mfix-r4400
16004 @opindex mno-fix-r4400
16005 Work around certain R4400 CPU errata:
16006 @itemize @minus
16007 @item
16008 A double-word or a variable shift may give an incorrect result if executed
16009 immediately after starting an integer division.
16010 @end itemize
16011
16012 @item -mfix-r10000
16013 @itemx -mno-fix-r10000
16014 @opindex mfix-r10000
16015 @opindex mno-fix-r10000
16016 Work around certain R10000 errata:
16017 @itemize @minus
16018 @item
16019 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16020 prior to 3.0. They may deadlock on revisions 2.6 and earlier.
16021 @end itemize
16022
16023 This option can only be used if the target architecture supports
16024 branch-likely instructions. @option{-mfix-r10000} is the default when
16025 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16026 otherwise.
16027
16028 @item -mfix-vr4120
16029 @itemx -mno-fix-vr4120
16030 @opindex mfix-vr4120
16031 Work around certain VR4120 errata:
16032 @itemize @minus
16033 @item
16034 @code{dmultu} does not always produce the correct result.
16035 @item
16036 @code{div} and @code{ddiv} do not always produce the correct result if one
16037 of the operands is negative.
16038 @end itemize
16039 The workarounds for the division errata rely on special functions in
16040 @file{libgcc.a}. At present, these functions are only provided by
16041 the @code{mips64vr*-elf} configurations.
16042
16043 Other VR4120 errata require a nop to be inserted between certain pairs of
16044 instructions. These errata are handled by the assembler, not by GCC itself.
16045
16046 @item -mfix-vr4130
16047 @opindex mfix-vr4130
16048 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
16049 workarounds are implemented by the assembler rather than by GCC,
16050 although GCC avoids using @code{mflo} and @code{mfhi} if the
16051 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16052 instructions are available instead.
16053
16054 @item -mfix-sb1
16055 @itemx -mno-fix-sb1
16056 @opindex mfix-sb1
16057 Work around certain SB-1 CPU core errata.
16058 (This flag currently works around the SB-1 revision 2
16059 ``F1'' and ``F2'' floating-point errata.)
16060
16061 @item -mr10k-cache-barrier=@var{setting}
16062 @opindex mr10k-cache-barrier
16063 Specify whether GCC should insert cache barriers to avoid the
16064 side-effects of speculation on R10K processors.
16065
16066 In common with many processors, the R10K tries to predict the outcome
16067 of a conditional branch and speculatively executes instructions from
16068 the ``taken'' branch. It later aborts these instructions if the
16069 predicted outcome is wrong. However, on the R10K, even aborted
16070 instructions can have side effects.
16071
16072 This problem only affects kernel stores and, depending on the system,
16073 kernel loads. As an example, a speculatively-executed store may load
16074 the target memory into cache and mark the cache line as dirty, even if
16075 the store itself is later aborted. If a DMA operation writes to the
16076 same area of memory before the ``dirty'' line is flushed, the cached
16077 data overwrites the DMA-ed data. See the R10K processor manual
16078 for a full description, including other potential problems.
16079
16080 One workaround is to insert cache barrier instructions before every memory
16081 access that might be speculatively executed and that might have side
16082 effects even if aborted. @option{-mr10k-cache-barrier=@var{setting}}
16083 controls GCC's implementation of this workaround. It assumes that
16084 aborted accesses to any byte in the following regions does not have
16085 side effects:
16086
16087 @enumerate
16088 @item
16089 the memory occupied by the current function's stack frame;
16090
16091 @item
16092 the memory occupied by an incoming stack argument;
16093
16094 @item
16095 the memory occupied by an object with a link-time-constant address.
16096 @end enumerate
16097
16098 It is the kernel's responsibility to ensure that speculative
16099 accesses to these regions are indeed safe.
16100
16101 If the input program contains a function declaration such as:
16102
16103 @smallexample
16104 void foo (void);
16105 @end smallexample
16106
16107 then the implementation of @code{foo} must allow @code{j foo} and
16108 @code{jal foo} to be executed speculatively. GCC honors this
16109 restriction for functions it compiles itself. It expects non-GCC
16110 functions (such as hand-written assembly code) to do the same.
16111
16112 The option has three forms:
16113
16114 @table @gcctabopt
16115 @item -mr10k-cache-barrier=load-store
16116 Insert a cache barrier before a load or store that might be
16117 speculatively executed and that might have side effects even
16118 if aborted.
16119
16120 @item -mr10k-cache-barrier=store
16121 Insert a cache barrier before a store that might be speculatively
16122 executed and that might have side effects even if aborted.
16123
16124 @item -mr10k-cache-barrier=none
16125 Disable the insertion of cache barriers. This is the default setting.
16126 @end table
16127
16128 @item -mflush-func=@var{func}
16129 @itemx -mno-flush-func
16130 @opindex mflush-func
16131 Specifies the function to call to flush the I and D caches, or to not
16132 call any such function. If called, the function must take the same
16133 arguments as the common @code{_flush_func()}, that is, the address of the
16134 memory range for which the cache is being flushed, the size of the
16135 memory range, and the number 3 (to flush both caches). The default
16136 depends on the target GCC was configured for, but commonly is either
16137 @samp{_flush_func} or @samp{__cpu_flush}.
16138
16139 @item mbranch-cost=@var{num}
16140 @opindex mbranch-cost
16141 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16142 This cost is only a heuristic and is not guaranteed to produce
16143 consistent results across releases. A zero cost redundantly selects
16144 the default, which is based on the @option{-mtune} setting.
16145
16146 @item -mbranch-likely
16147 @itemx -mno-branch-likely
16148 @opindex mbranch-likely
16149 @opindex mno-branch-likely
16150 Enable or disable use of Branch Likely instructions, regardless of the
16151 default for the selected architecture. By default, Branch Likely
16152 instructions may be generated if they are supported by the selected
16153 architecture. An exception is for the MIPS32 and MIPS64 architectures
16154 and processors that implement those architectures; for those, Branch
16155 Likely instructions are not be generated by default because the MIPS32
16156 and MIPS64 architectures specifically deprecate their use.
16157
16158 @item -mfp-exceptions
16159 @itemx -mno-fp-exceptions
16160 @opindex mfp-exceptions
16161 Specifies whether FP exceptions are enabled. This affects how
16162 FP instructions are scheduled for some processors.
16163 The default is that FP exceptions are
16164 enabled.
16165
16166 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16167 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
16168 FP pipe.
16169
16170 @item -mvr4130-align
16171 @itemx -mno-vr4130-align
16172 @opindex mvr4130-align
16173 The VR4130 pipeline is two-way superscalar, but can only issue two
16174 instructions together if the first one is 8-byte aligned. When this
16175 option is enabled, GCC aligns pairs of instructions that it
16176 thinks should execute in parallel.
16177
16178 This option only has an effect when optimizing for the VR4130.
16179 It normally makes code faster, but at the expense of making it bigger.
16180 It is enabled by default at optimization level @option{-O3}.
16181
16182 @item -msynci
16183 @itemx -mno-synci
16184 @opindex msynci
16185 Enable (disable) generation of @code{synci} instructions on
16186 architectures that support it. The @code{synci} instructions (if
16187 enabled) are generated when @code{__builtin___clear_cache()} is
16188 compiled.
16189
16190 This option defaults to @code{-mno-synci}, but the default can be
16191 overridden by configuring with @code{--with-synci}.
16192
16193 When compiling code for single processor systems, it is generally safe
16194 to use @code{synci}. However, on many multi-core (SMP) systems, it
16195 does not invalidate the instruction caches on all cores and may lead
16196 to undefined behavior.
16197
16198 @item -mrelax-pic-calls
16199 @itemx -mno-relax-pic-calls
16200 @opindex mrelax-pic-calls
16201 Try to turn PIC calls that are normally dispatched via register
16202 @code{$25} into direct calls. This is only possible if the linker can
16203 resolve the destination at link-time and if the destination is within
16204 range for a direct call.
16205
16206 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16207 an assembler and a linker that supports the @code{.reloc} assembly
16208 directive and @code{-mexplicit-relocs} is in effect. With
16209 @code{-mno-explicit-relocs}, this optimization can be performed by the
16210 assembler and the linker alone without help from the compiler.
16211
16212 @item -mmcount-ra-address
16213 @itemx -mno-mcount-ra-address
16214 @opindex mmcount-ra-address
16215 @opindex mno-mcount-ra-address
16216 Emit (do not emit) code that allows @code{_mcount} to modify the
16217 calling function's return address. When enabled, this option extends
16218 the usual @code{_mcount} interface with a new @var{ra-address}
16219 parameter, which has type @code{intptr_t *} and is passed in register
16220 @code{$12}. @code{_mcount} can then modify the return address by
16221 doing both of the following:
16222 @itemize
16223 @item
16224 Returning the new address in register @code{$31}.
16225 @item
16226 Storing the new address in @code{*@var{ra-address}},
16227 if @var{ra-address} is nonnull.
16228 @end itemize
16229
16230 The default is @option{-mno-mcount-ra-address}.
16231
16232 @end table
16233
16234 @node MMIX Options
16235 @subsection MMIX Options
16236 @cindex MMIX Options
16237
16238 These options are defined for the MMIX:
16239
16240 @table @gcctabopt
16241 @item -mlibfuncs
16242 @itemx -mno-libfuncs
16243 @opindex mlibfuncs
16244 @opindex mno-libfuncs
16245 Specify that intrinsic library functions are being compiled, passing all
16246 values in registers, no matter the size.
16247
16248 @item -mepsilon
16249 @itemx -mno-epsilon
16250 @opindex mepsilon
16251 @opindex mno-epsilon
16252 Generate floating-point comparison instructions that compare with respect
16253 to the @code{rE} epsilon register.
16254
16255 @item -mabi=mmixware
16256 @itemx -mabi=gnu
16257 @opindex mabi=mmixware
16258 @opindex mabi=gnu
16259 Generate code that passes function parameters and return values that (in
16260 the called function) are seen as registers @code{$0} and up, as opposed to
16261 the GNU ABI which uses global registers @code{$231} and up.
16262
16263 @item -mzero-extend
16264 @itemx -mno-zero-extend
16265 @opindex mzero-extend
16266 @opindex mno-zero-extend
16267 When reading data from memory in sizes shorter than 64 bits, use (do not
16268 use) zero-extending load instructions by default, rather than
16269 sign-extending ones.
16270
16271 @item -mknuthdiv
16272 @itemx -mno-knuthdiv
16273 @opindex mknuthdiv
16274 @opindex mno-knuthdiv
16275 Make the result of a division yielding a remainder have the same sign as
16276 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
16277 remainder follows the sign of the dividend. Both methods are
16278 arithmetically valid, the latter being almost exclusively used.
16279
16280 @item -mtoplevel-symbols
16281 @itemx -mno-toplevel-symbols
16282 @opindex mtoplevel-symbols
16283 @opindex mno-toplevel-symbols
16284 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16285 code can be used with the @code{PREFIX} assembly directive.
16286
16287 @item -melf
16288 @opindex melf
16289 Generate an executable in the ELF format, rather than the default
16290 @samp{mmo} format used by the @command{mmix} simulator.
16291
16292 @item -mbranch-predict
16293 @itemx -mno-branch-predict
16294 @opindex mbranch-predict
16295 @opindex mno-branch-predict
16296 Use (do not use) the probable-branch instructions, when static branch
16297 prediction indicates a probable branch.
16298
16299 @item -mbase-addresses
16300 @itemx -mno-base-addresses
16301 @opindex mbase-addresses
16302 @opindex mno-base-addresses
16303 Generate (do not generate) code that uses @emph{base addresses}. Using a
16304 base address automatically generates a request (handled by the assembler
16305 and the linker) for a constant to be set up in a global register. The
16306 register is used for one or more base address requests within the range 0
16307 to 255 from the value held in the register. The generally leads to short
16308 and fast code, but the number of different data items that can be
16309 addressed is limited. This means that a program that uses lots of static
16310 data may require @option{-mno-base-addresses}.
16311
16312 @item -msingle-exit
16313 @itemx -mno-single-exit
16314 @opindex msingle-exit
16315 @opindex mno-single-exit
16316 Force (do not force) generated code to have a single exit point in each
16317 function.
16318 @end table
16319
16320 @node MN10300 Options
16321 @subsection MN10300 Options
16322 @cindex MN10300 options
16323
16324 These @option{-m} options are defined for Matsushita MN10300 architectures:
16325
16326 @table @gcctabopt
16327 @item -mmult-bug
16328 @opindex mmult-bug
16329 Generate code to avoid bugs in the multiply instructions for the MN10300
16330 processors. This is the default.
16331
16332 @item -mno-mult-bug
16333 @opindex mno-mult-bug
16334 Do not generate code to avoid bugs in the multiply instructions for the
16335 MN10300 processors.
16336
16337 @item -mam33
16338 @opindex mam33
16339 Generate code using features specific to the AM33 processor.
16340
16341 @item -mno-am33
16342 @opindex mno-am33
16343 Do not generate code using features specific to the AM33 processor. This
16344 is the default.
16345
16346 @item -mam33-2
16347 @opindex mam33-2
16348 Generate code using features specific to the AM33/2.0 processor.
16349
16350 @item -mam34
16351 @opindex mam34
16352 Generate code using features specific to the AM34 processor.
16353
16354 @item -mtune=@var{cpu-type}
16355 @opindex mtune
16356 Use the timing characteristics of the indicated CPU type when
16357 scheduling instructions. This does not change the targeted processor
16358 type. The CPU type must be one of @samp{mn10300}, @samp{am33},
16359 @samp{am33-2} or @samp{am34}.
16360
16361 @item -mreturn-pointer-on-d0
16362 @opindex mreturn-pointer-on-d0
16363 When generating a function that returns a pointer, return the pointer
16364 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
16365 only in @code{a0}, and attempts to call such functions without a prototype
16366 result in errors. Note that this option is on by default; use
16367 @option{-mno-return-pointer-on-d0} to disable it.
16368
16369 @item -mno-crt0
16370 @opindex mno-crt0
16371 Do not link in the C run-time initialization object file.
16372
16373 @item -mrelax
16374 @opindex mrelax
16375 Indicate to the linker that it should perform a relaxation optimization pass
16376 to shorten branches, calls and absolute memory addresses. This option only
16377 has an effect when used on the command line for the final link step.
16378
16379 This option makes symbolic debugging impossible.
16380
16381 @item -mliw
16382 @opindex mliw
16383 Allow the compiler to generate @emph{Long Instruction Word}
16384 instructions if the target is the @samp{AM33} or later. This is the
16385 default. This option defines the preprocessor macro @samp{__LIW__}.
16386
16387 @item -mnoliw
16388 @opindex mnoliw
16389 Do not allow the compiler to generate @emph{Long Instruction Word}
16390 instructions. This option defines the preprocessor macro
16391 @samp{__NO_LIW__}.
16392
16393 @item -msetlb
16394 @opindex msetlb
16395 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16396 instructions if the target is the @samp{AM33} or later. This is the
16397 default. This option defines the preprocessor macro @samp{__SETLB__}.
16398
16399 @item -mnosetlb
16400 @opindex mnosetlb
16401 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16402 instructions. This option defines the preprocessor macro
16403 @samp{__NO_SETLB__}.
16404
16405 @end table
16406
16407 @node PDP-11 Options
16408 @subsection PDP-11 Options
16409 @cindex PDP-11 Options
16410
16411 These options are defined for the PDP-11:
16412
16413 @table @gcctabopt
16414 @item -mfpu
16415 @opindex mfpu
16416 Use hardware FPP floating point. This is the default. (FIS floating
16417 point on the PDP-11/40 is not supported.)
16418
16419 @item -msoft-float
16420 @opindex msoft-float
16421 Do not use hardware floating point.
16422
16423 @item -mac0
16424 @opindex mac0
16425 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16426
16427 @item -mno-ac0
16428 @opindex mno-ac0
16429 Return floating-point results in memory. This is the default.
16430
16431 @item -m40
16432 @opindex m40
16433 Generate code for a PDP-11/40.
16434
16435 @item -m45
16436 @opindex m45
16437 Generate code for a PDP-11/45. This is the default.
16438
16439 @item -m10
16440 @opindex m10
16441 Generate code for a PDP-11/10.
16442
16443 @item -mbcopy-builtin
16444 @opindex mbcopy-builtin
16445 Use inline @code{movmemhi} patterns for copying memory. This is the
16446 default.
16447
16448 @item -mbcopy
16449 @opindex mbcopy
16450 Do not use inline @code{movmemhi} patterns for copying memory.
16451
16452 @item -mint16
16453 @itemx -mno-int32
16454 @opindex mint16
16455 @opindex mno-int32
16456 Use 16-bit @code{int}. This is the default.
16457
16458 @item -mint32
16459 @itemx -mno-int16
16460 @opindex mint32
16461 @opindex mno-int16
16462 Use 32-bit @code{int}.
16463
16464 @item -mfloat64
16465 @itemx -mno-float32
16466 @opindex mfloat64
16467 @opindex mno-float32
16468 Use 64-bit @code{float}. This is the default.
16469
16470 @item -mfloat32
16471 @itemx -mno-float64
16472 @opindex mfloat32
16473 @opindex mno-float64
16474 Use 32-bit @code{float}.
16475
16476 @item -mabshi
16477 @opindex mabshi
16478 Use @code{abshi2} pattern. This is the default.
16479
16480 @item -mno-abshi
16481 @opindex mno-abshi
16482 Do not use @code{abshi2} pattern.
16483
16484 @item -mbranch-expensive
16485 @opindex mbranch-expensive
16486 Pretend that branches are expensive. This is for experimenting with
16487 code generation only.
16488
16489 @item -mbranch-cheap
16490 @opindex mbranch-cheap
16491 Do not pretend that branches are expensive. This is the default.
16492
16493 @item -munix-asm
16494 @opindex munix-asm
16495 Use Unix assembler syntax. This is the default when configured for
16496 @samp{pdp11-*-bsd}.
16497
16498 @item -mdec-asm
16499 @opindex mdec-asm
16500 Use DEC assembler syntax. This is the default when configured for any
16501 PDP-11 target other than @samp{pdp11-*-bsd}.
16502 @end table
16503
16504 @node picoChip Options
16505 @subsection picoChip Options
16506 @cindex picoChip options
16507
16508 These @samp{-m} options are defined for picoChip implementations:
16509
16510 @table @gcctabopt
16511
16512 @item -mae=@var{ae_type}
16513 @opindex mcpu
16514 Set the instruction set, register set, and instruction scheduling
16515 parameters for array element type @var{ae_type}. Supported values
16516 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16517
16518 @option{-mae=ANY} selects a completely generic AE type. Code
16519 generated with this option runs on any of the other AE types. The
16520 code is not as efficient as it would be if compiled for a specific
16521 AE type, and some types of operation (e.g., multiplication) do not
16522 work properly on all types of AE.
16523
16524 @option{-mae=MUL} selects a MUL AE type. This is the most useful AE type
16525 for compiled code, and is the default.
16526
16527 @option{-mae=MAC} selects a DSP-style MAC AE. Code compiled with this
16528 option may suffer from poor performance of byte (char) manipulation,
16529 since the DSP AE does not provide hardware support for byte load/stores.
16530
16531 @item -msymbol-as-address
16532 Enable the compiler to directly use a symbol name as an address in a
16533 load/store instruction, without first loading it into a
16534 register. Typically, the use of this option generates larger
16535 programs, which run faster than when the option isn't used. However, the
16536 results vary from program to program, so it is left as a user option,
16537 rather than being permanently enabled.
16538
16539 @item -mno-inefficient-warnings
16540 Disables warnings about the generation of inefficient code. These
16541 warnings can be generated, for example, when compiling code that
16542 performs byte-level memory operations on the MAC AE type. The MAC AE has
16543 no hardware support for byte-level memory operations, so all byte
16544 load/stores must be synthesized from word load/store operations. This is
16545 inefficient and a warning is generated to indicate
16546 that you should rewrite the code to avoid byte operations, or to target
16547 an AE type that has the necessary hardware support. This option disables
16548 these warnings.
16549
16550 @end table
16551
16552 @node PowerPC Options
16553 @subsection PowerPC Options
16554 @cindex PowerPC options
16555
16556 These are listed under @xref{RS/6000 and PowerPC Options}.
16557
16558 @node RL78 Options
16559 @subsection RL78 Options
16560 @cindex RL78 Options
16561
16562 @table @gcctabopt
16563
16564 @item -msim
16565 @opindex msim
16566 Links in additional target libraries to support operation within a
16567 simulator.
16568
16569 @item -mmul=none
16570 @itemx -mmul=g13
16571 @itemx -mmul=rl78
16572 @opindex mmul
16573 Specifies the type of hardware multiplication support to be used. The
16574 default is @code{none}, which uses software multiplication functions.
16575 The @code{g13} option is for the hardware multiply/divide peripheral
16576 only on the RL78/G13 targets. The @code{rl78} option is for the
16577 standard hardware multiplication defined in the RL78 software manual.
16578
16579 @end table
16580
16581 @node RS/6000 and PowerPC Options
16582 @subsection IBM RS/6000 and PowerPC Options
16583 @cindex RS/6000 and PowerPC Options
16584 @cindex IBM RS/6000 and PowerPC Options
16585
16586 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16587 @table @gcctabopt
16588 @item -mpowerpc-gpopt
16589 @itemx -mno-powerpc-gpopt
16590 @itemx -mpowerpc-gfxopt
16591 @itemx -mno-powerpc-gfxopt
16592 @need 800
16593 @itemx -mpowerpc64
16594 @itemx -mno-powerpc64
16595 @itemx -mmfcrf
16596 @itemx -mno-mfcrf
16597 @itemx -mpopcntb
16598 @itemx -mno-popcntb
16599 @itemx -mpopcntd
16600 @itemx -mno-popcntd
16601 @itemx -mfprnd
16602 @itemx -mno-fprnd
16603 @need 800
16604 @itemx -mcmpb
16605 @itemx -mno-cmpb
16606 @itemx -mmfpgpr
16607 @itemx -mno-mfpgpr
16608 @itemx -mhard-dfp
16609 @itemx -mno-hard-dfp
16610 @opindex mpowerpc-gpopt
16611 @opindex mno-powerpc-gpopt
16612 @opindex mpowerpc-gfxopt
16613 @opindex mno-powerpc-gfxopt
16614 @opindex mpowerpc64
16615 @opindex mno-powerpc64
16616 @opindex mmfcrf
16617 @opindex mno-mfcrf
16618 @opindex mpopcntb
16619 @opindex mno-popcntb
16620 @opindex mpopcntd
16621 @opindex mno-popcntd
16622 @opindex mfprnd
16623 @opindex mno-fprnd
16624 @opindex mcmpb
16625 @opindex mno-cmpb
16626 @opindex mmfpgpr
16627 @opindex mno-mfpgpr
16628 @opindex mhard-dfp
16629 @opindex mno-hard-dfp
16630 You use these options to specify which instructions are available on the
16631 processor you are using. The default value of these options is
16632 determined when configuring GCC@. Specifying the
16633 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16634 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
16635 rather than the options listed above.
16636
16637 Specifying @option{-mpowerpc-gpopt} allows
16638 GCC to use the optional PowerPC architecture instructions in the
16639 General Purpose group, including floating-point square root. Specifying
16640 @option{-mpowerpc-gfxopt} allows GCC to
16641 use the optional PowerPC architecture instructions in the Graphics
16642 group, including floating-point select.
16643
16644 The @option{-mmfcrf} option allows GCC to generate the move from
16645 condition register field instruction implemented on the POWER4
16646 processor and other processors that support the PowerPC V2.01
16647 architecture.
16648 The @option{-mpopcntb} option allows GCC to generate the popcount and
16649 double-precision FP reciprocal estimate instruction implemented on the
16650 POWER5 processor and other processors that support the PowerPC V2.02
16651 architecture.
16652 The @option{-mpopcntd} option allows GCC to generate the popcount
16653 instruction implemented on the POWER7 processor and other processors
16654 that support the PowerPC V2.06 architecture.
16655 The @option{-mfprnd} option allows GCC to generate the FP round to
16656 integer instructions implemented on the POWER5+ processor and other
16657 processors that support the PowerPC V2.03 architecture.
16658 The @option{-mcmpb} option allows GCC to generate the compare bytes
16659 instruction implemented on the POWER6 processor and other processors
16660 that support the PowerPC V2.05 architecture.
16661 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16662 general-purpose register instructions implemented on the POWER6X
16663 processor and other processors that support the extended PowerPC V2.05
16664 architecture.
16665 The @option{-mhard-dfp} option allows GCC to generate the decimal
16666 floating-point instructions implemented on some POWER processors.
16667
16668 The @option{-mpowerpc64} option allows GCC to generate the additional
16669 64-bit instructions that are found in the full PowerPC64 architecture
16670 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
16671 @option{-mno-powerpc64}.
16672
16673 @item -mcpu=@var{cpu_type}
16674 @opindex mcpu
16675 Set architecture type, register usage, and
16676 instruction scheduling parameters for machine type @var{cpu_type}.
16677 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16678 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16679 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16680 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16681 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16682 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16683 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
16684 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
16685 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
16686 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{powerpc},
16687 @samp{powerpc64}, and @samp{rs64}.
16688
16689 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
16690 PowerPC and 64-bit PowerPC architecture machine
16691 types, with an appropriate, generic processor model assumed for
16692 scheduling purposes.
16693
16694 The other options specify a specific processor. Code generated under
16695 those options runs best on that processor, and may not run at all on
16696 others.
16697
16698 The @option{-mcpu} options automatically enable or disable the
16699 following options:
16700
16701 @gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple @gol
16702 -mpopcntb -mpopcntd -mpowerpc64 @gol
16703 -mpowerpc-gpopt -mpowerpc-gfxopt -msingle-float -mdouble-float @gol
16704 -msimple-fpu -mstring -mmulhw -mdlmzb -mmfpgpr -mvsx}
16705
16706 The particular options set for any particular CPU varies between
16707 compiler versions, depending on what setting seems to produce optimal
16708 code for that CPU; it doesn't necessarily reflect the actual hardware's
16709 capabilities. If you wish to set an individual option to a particular
16710 value, you may specify it after the @option{-mcpu} option, like
16711 @option{-mcpu=970 -mno-altivec}.
16712
16713 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16714 not enabled or disabled by the @option{-mcpu} option at present because
16715 AIX does not have full support for these options. You may still
16716 enable or disable them individually if you're sure it'll work in your
16717 environment.
16718
16719 @item -mtune=@var{cpu_type}
16720 @opindex mtune
16721 Set the instruction scheduling parameters for machine type
16722 @var{cpu_type}, but do not set the architecture type or register usage,
16723 as @option{-mcpu=@var{cpu_type}} does. The same
16724 values for @var{cpu_type} are used for @option{-mtune} as for
16725 @option{-mcpu}. If both are specified, the code generated uses the
16726 architecture and registers set by @option{-mcpu}, but the
16727 scheduling parameters set by @option{-mtune}.
16728
16729 @item -mcmodel=small
16730 @opindex mcmodel=small
16731 Generate PowerPC64 code for the small model: The TOC is limited to
16732 64k.
16733
16734 @item -mcmodel=medium
16735 @opindex mcmodel=medium
16736 Generate PowerPC64 code for the medium model: The TOC and other static
16737 data may be up to a total of 4G in size.
16738
16739 @item -mcmodel=large
16740 @opindex mcmodel=large
16741 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16742 in size. Other data and code is only limited by the 64-bit address
16743 space.
16744
16745 @item -maltivec
16746 @itemx -mno-altivec
16747 @opindex maltivec
16748 @opindex mno-altivec
16749 Generate code that uses (does not use) AltiVec instructions, and also
16750 enable the use of built-in functions that allow more direct access to
16751 the AltiVec instruction set. You may also need to set
16752 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16753 enhancements.
16754
16755 @item -mvrsave
16756 @itemx -mno-vrsave
16757 @opindex mvrsave
16758 @opindex mno-vrsave
16759 Generate VRSAVE instructions when generating AltiVec code.
16760
16761 @item -mgen-cell-microcode
16762 @opindex mgen-cell-microcode
16763 Generate Cell microcode instructions
16764
16765 @item -mwarn-cell-microcode
16766 @opindex mwarn-cell-microcode
16767 Warning when a Cell microcode instruction is going to emitted. An example
16768 of a Cell microcode instruction is a variable shift.
16769
16770 @item -msecure-plt
16771 @opindex msecure-plt
16772 Generate code that allows @command{ld} and @command{ld.so}
16773 to build executables and shared
16774 libraries with non-executable @code{.plt} and @code{.got} sections.
16775 This is a PowerPC
16776 32-bit SYSV ABI option.
16777
16778 @item -mbss-plt
16779 @opindex mbss-plt
16780 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
16781 fills in, and
16782 requires @code{.plt} and @code{.got}
16783 sections that are both writable and executable.
16784 This is a PowerPC 32-bit SYSV ABI option.
16785
16786 @item -misel
16787 @itemx -mno-isel
16788 @opindex misel
16789 @opindex mno-isel
16790 This switch enables or disables the generation of ISEL instructions.
16791
16792 @item -misel=@var{yes/no}
16793 This switch has been deprecated. Use @option{-misel} and
16794 @option{-mno-isel} instead.
16795
16796 @item -mspe
16797 @itemx -mno-spe
16798 @opindex mspe
16799 @opindex mno-spe
16800 This switch enables or disables the generation of SPE simd
16801 instructions.
16802
16803 @item -mpaired
16804 @itemx -mno-paired
16805 @opindex mpaired
16806 @opindex mno-paired
16807 This switch enables or disables the generation of PAIRED simd
16808 instructions.
16809
16810 @item -mspe=@var{yes/no}
16811 This option has been deprecated. Use @option{-mspe} and
16812 @option{-mno-spe} instead.
16813
16814 @item -mvsx
16815 @itemx -mno-vsx
16816 @opindex mvsx
16817 @opindex mno-vsx
16818 Generate code that uses (does not use) vector/scalar (VSX)
16819 instructions, and also enable the use of built-in functions that allow
16820 more direct access to the VSX instruction set.
16821
16822 @item -mfloat-gprs=@var{yes/single/double/no}
16823 @itemx -mfloat-gprs
16824 @opindex mfloat-gprs
16825 This switch enables or disables the generation of floating-point
16826 operations on the general-purpose registers for architectures that
16827 support it.
16828
16829 The argument @var{yes} or @var{single} enables the use of
16830 single-precision floating-point operations.
16831
16832 The argument @var{double} enables the use of single and
16833 double-precision floating-point operations.
16834
16835 The argument @var{no} disables floating-point operations on the
16836 general-purpose registers.
16837
16838 This option is currently only available on the MPC854x.
16839
16840 @item -m32
16841 @itemx -m64
16842 @opindex m32
16843 @opindex m64
16844 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16845 targets (including GNU/Linux). The 32-bit environment sets int, long
16846 and pointer to 32 bits and generates code that runs on any PowerPC
16847 variant. The 64-bit environment sets int to 32 bits and long and
16848 pointer to 64 bits, and generates code for PowerPC64, as for
16849 @option{-mpowerpc64}.
16850
16851 @item -mfull-toc
16852 @itemx -mno-fp-in-toc
16853 @itemx -mno-sum-in-toc
16854 @itemx -mminimal-toc
16855 @opindex mfull-toc
16856 @opindex mno-fp-in-toc
16857 @opindex mno-sum-in-toc
16858 @opindex mminimal-toc
16859 Modify generation of the TOC (Table Of Contents), which is created for
16860 every executable file. The @option{-mfull-toc} option is selected by
16861 default. In that case, GCC allocates at least one TOC entry for
16862 each unique non-automatic variable reference in your program. GCC
16863 also places floating-point constants in the TOC@. However, only
16864 16,384 entries are available in the TOC@.
16865
16866 If you receive a linker error message that saying you have overflowed
16867 the available TOC space, you can reduce the amount of TOC space used
16868 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16869 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16870 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16871 generate code to calculate the sum of an address and a constant at
16872 run time instead of putting that sum into the TOC@. You may specify one
16873 or both of these options. Each causes GCC to produce very slightly
16874 slower and larger code at the expense of conserving TOC space.
16875
16876 If you still run out of space in the TOC even when you specify both of
16877 these options, specify @option{-mminimal-toc} instead. This option causes
16878 GCC to make only one TOC entry for every file. When you specify this
16879 option, GCC produces code that is slower and larger but which
16880 uses extremely little TOC space. You may wish to use this option
16881 only on files that contain less frequently-executed code.
16882
16883 @item -maix64
16884 @itemx -maix32
16885 @opindex maix64
16886 @opindex maix32
16887 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16888 @code{long} type, and the infrastructure needed to support them.
16889 Specifying @option{-maix64} implies @option{-mpowerpc64},
16890 while @option{-maix32} disables the 64-bit ABI and
16891 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
16892
16893 @item -mxl-compat
16894 @itemx -mno-xl-compat
16895 @opindex mxl-compat
16896 @opindex mno-xl-compat
16897 Produce code that conforms more closely to IBM XL compiler semantics
16898 when using AIX-compatible ABI@. Pass floating-point arguments to
16899 prototyped functions beyond the register save area (RSA) on the stack
16900 in addition to argument FPRs. Do not assume that most significant
16901 double in 128-bit long double value is properly rounded when comparing
16902 values and converting to double. Use XL symbol names for long double
16903 support routines.
16904
16905 The AIX calling convention was extended but not initially documented to
16906 handle an obscure K&R C case of calling a function that takes the
16907 address of its arguments with fewer arguments than declared. IBM XL
16908 compilers access floating-point arguments that do not fit in the
16909 RSA from the stack when a subroutine is compiled without
16910 optimization. Because always storing floating-point arguments on the
16911 stack is inefficient and rarely needed, this option is not enabled by
16912 default and only is necessary when calling subroutines compiled by IBM
16913 XL compilers without optimization.
16914
16915 @item -mpe
16916 @opindex mpe
16917 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
16918 application written to use message passing with special startup code to
16919 enable the application to run. The system must have PE installed in the
16920 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16921 must be overridden with the @option{-specs=} option to specify the
16922 appropriate directory location. The Parallel Environment does not
16923 support threads, so the @option{-mpe} option and the @option{-pthread}
16924 option are incompatible.
16925
16926 @item -malign-natural
16927 @itemx -malign-power
16928 @opindex malign-natural
16929 @opindex malign-power
16930 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16931 @option{-malign-natural} overrides the ABI-defined alignment of larger
16932 types, such as floating-point doubles, on their natural size-based boundary.
16933 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16934 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
16935
16936 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16937 is not supported.
16938
16939 @item -msoft-float
16940 @itemx -mhard-float
16941 @opindex msoft-float
16942 @opindex mhard-float
16943 Generate code that does not use (uses) the floating-point register set.
16944 Software floating-point emulation is provided if you use the
16945 @option{-msoft-float} option, and pass the option to GCC when linking.
16946
16947 @item -msingle-float
16948 @itemx -mdouble-float
16949 @opindex msingle-float
16950 @opindex mdouble-float
16951 Generate code for single- or double-precision floating-point operations.
16952 @option{-mdouble-float} implies @option{-msingle-float}.
16953
16954 @item -msimple-fpu
16955 @opindex msimple-fpu
16956 Do not generate @code{sqrt} and @code{div} instructions for hardware
16957 floating-point unit.
16958
16959 @item -mfpu=@var{name}
16960 @opindex mfpu
16961 Specify type of floating-point unit. Valid values for @var{name} are
16962 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
16963 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
16964 @samp{sp_full} (equivalent to @option{-msingle-float}),
16965 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
16966
16967 @item -mxilinx-fpu
16968 @opindex mxilinx-fpu
16969 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
16970
16971 @item -mmultiple
16972 @itemx -mno-multiple
16973 @opindex mmultiple
16974 @opindex mno-multiple
16975 Generate code that uses (does not use) the load multiple word
16976 instructions and the store multiple word instructions. These
16977 instructions are generated by default on POWER systems, and not
16978 generated on PowerPC systems. Do not use @option{-mmultiple} on little-endian
16979 PowerPC systems, since those instructions do not work when the
16980 processor is in little-endian mode. The exceptions are PPC740 and
16981 PPC750 which permit these instructions in little-endian mode.
16982
16983 @item -mstring
16984 @itemx -mno-string
16985 @opindex mstring
16986 @opindex mno-string
16987 Generate code that uses (does not use) the load string instructions
16988 and the store string word instructions to save multiple registers and
16989 do small block moves. These instructions are generated by default on
16990 POWER systems, and not generated on PowerPC systems. Do not use
16991 @option{-mstring} on little-endian PowerPC systems, since those
16992 instructions do not work when the processor is in little-endian mode.
16993 The exceptions are PPC740 and PPC750 which permit these instructions
16994 in little-endian mode.
16995
16996 @item -mupdate
16997 @itemx -mno-update
16998 @opindex mupdate
16999 @opindex mno-update
17000 Generate code that uses (does not use) the load or store instructions
17001 that update the base register to the address of the calculated memory
17002 location. These instructions are generated by default. If you use
17003 @option{-mno-update}, there is a small window between the time that the
17004 stack pointer is updated and the address of the previous frame is
17005 stored, which means code that walks the stack frame across interrupts or
17006 signals may get corrupted data.
17007
17008 @item -mavoid-indexed-addresses
17009 @itemx -mno-avoid-indexed-addresses
17010 @opindex mavoid-indexed-addresses
17011 @opindex mno-avoid-indexed-addresses
17012 Generate code that tries to avoid (not avoid) the use of indexed load
17013 or store instructions. These instructions can incur a performance
17014 penalty on Power6 processors in certain situations, such as when
17015 stepping through large arrays that cross a 16M boundary. This option
17016 is enabled by default when targeting Power6 and disabled otherwise.
17017
17018 @item -mfused-madd
17019 @itemx -mno-fused-madd
17020 @opindex mfused-madd
17021 @opindex mno-fused-madd
17022 Generate code that uses (does not use) the floating-point multiply and
17023 accumulate instructions. These instructions are generated by default
17024 if hardware floating point is used. The machine-dependent
17025 @option{-mfused-madd} option is now mapped to the machine-independent
17026 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17027 mapped to @option{-ffp-contract=off}.
17028
17029 @item -mmulhw
17030 @itemx -mno-mulhw
17031 @opindex mmulhw
17032 @opindex mno-mulhw
17033 Generate code that uses (does not use) the half-word multiply and
17034 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17035 These instructions are generated by default when targeting those
17036 processors.
17037
17038 @item -mdlmzb
17039 @itemx -mno-dlmzb
17040 @opindex mdlmzb
17041 @opindex mno-dlmzb
17042 Generate code that uses (does not use) the string-search @samp{dlmzb}
17043 instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
17044 generated by default when targeting those processors.
17045
17046 @item -mno-bit-align
17047 @itemx -mbit-align
17048 @opindex mno-bit-align
17049 @opindex mbit-align
17050 On System V.4 and embedded PowerPC systems do not (do) force structures
17051 and unions that contain bit-fields to be aligned to the base type of the
17052 bit-field.
17053
17054 For example, by default a structure containing nothing but 8
17055 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17056 boundary and has a size of 4 bytes. By using @option{-mno-bit-align},
17057 the structure is aligned to a 1-byte boundary and is 1 byte in
17058 size.
17059
17060 @item -mno-strict-align
17061 @itemx -mstrict-align
17062 @opindex mno-strict-align
17063 @opindex mstrict-align
17064 On System V.4 and embedded PowerPC systems do not (do) assume that
17065 unaligned memory references are handled by the system.
17066
17067 @item -mrelocatable
17068 @itemx -mno-relocatable
17069 @opindex mrelocatable
17070 @opindex mno-relocatable
17071 Generate code that allows (does not allow) a static executable to be
17072 relocated to a different address at run time. A simple embedded
17073 PowerPC system loader should relocate the entire contents of
17074 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17075 a table of 32-bit addresses generated by this option. For this to
17076 work, all objects linked together must be compiled with
17077 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17078 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17079
17080 @item -mrelocatable-lib
17081 @itemx -mno-relocatable-lib
17082 @opindex mrelocatable-lib
17083 @opindex mno-relocatable-lib
17084 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17085 @code{.fixup} section to allow static executables to be relocated at
17086 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17087 alignment of @option{-mrelocatable}. Objects compiled with
17088 @option{-mrelocatable-lib} may be linked with objects compiled with
17089 any combination of the @option{-mrelocatable} options.
17090
17091 @item -mno-toc
17092 @itemx -mtoc
17093 @opindex mno-toc
17094 @opindex mtoc
17095 On System V.4 and embedded PowerPC systems do not (do) assume that
17096 register 2 contains a pointer to a global area pointing to the addresses
17097 used in the program.
17098
17099 @item -mlittle
17100 @itemx -mlittle-endian
17101 @opindex mlittle
17102 @opindex mlittle-endian
17103 On System V.4 and embedded PowerPC systems compile code for the
17104 processor in little-endian mode. The @option{-mlittle-endian} option is
17105 the same as @option{-mlittle}.
17106
17107 @item -mbig
17108 @itemx -mbig-endian
17109 @opindex mbig
17110 @opindex mbig-endian
17111 On System V.4 and embedded PowerPC systems compile code for the
17112 processor in big-endian mode. The @option{-mbig-endian} option is
17113 the same as @option{-mbig}.
17114
17115 @item -mdynamic-no-pic
17116 @opindex mdynamic-no-pic
17117 On Darwin and Mac OS X systems, compile code so that it is not
17118 relocatable, but that its external references are relocatable. The
17119 resulting code is suitable for applications, but not shared
17120 libraries.
17121
17122 @item -msingle-pic-base
17123 @opindex msingle-pic-base
17124 Treat the register used for PIC addressing as read-only, rather than
17125 loading it in the prologue for each function. The runtime system is
17126 responsible for initializing this register with an appropriate value
17127 before execution begins.
17128
17129 @item -mprioritize-restricted-insns=@var{priority}
17130 @opindex mprioritize-restricted-insns
17131 This option controls the priority that is assigned to
17132 dispatch-slot restricted instructions during the second scheduling
17133 pass. The argument @var{priority} takes the value @samp{0}, @samp{1},
17134 or @samp{2} to assign no, highest, or second-highest (respectively)
17135 priority to dispatch-slot restricted
17136 instructions.
17137
17138 @item -msched-costly-dep=@var{dependence_type}
17139 @opindex msched-costly-dep
17140 This option controls which dependences are considered costly
17141 by the target during instruction scheduling. The argument
17142 @var{dependence_type} takes one of the following values:
17143
17144 @table @asis
17145 @item @samp{no}
17146 No dependence is costly.
17147
17148 @item @samp{all}
17149 All dependences are costly.
17150
17151 @item @samp{true_store_to_load}
17152 A true dependence from store to load is costly.
17153
17154 @item @samp{store_to_load}
17155 Any dependence from store to load is costly.
17156
17157 @item @var{number}
17158 Any dependence for which the latency is greater than or equal to
17159 @var{number} is costly.
17160 @end table
17161
17162 @item -minsert-sched-nops=@var{scheme}
17163 @opindex minsert-sched-nops
17164 This option controls which NOP insertion scheme is used during
17165 the second scheduling pass. The argument @var{scheme} takes one of the
17166 following values:
17167
17168 @table @asis
17169 @item @samp{no}
17170 Don't insert NOPs.
17171
17172 @item @samp{pad}
17173 Pad with NOPs any dispatch group that has vacant issue slots,
17174 according to the scheduler's grouping.
17175
17176 @item @samp{regroup_exact}
17177 Insert NOPs to force costly dependent insns into
17178 separate groups. Insert exactly as many NOPs as needed to force an insn
17179 to a new group, according to the estimated processor grouping.
17180
17181 @item @var{number}
17182 Insert NOPs to force costly dependent insns into
17183 separate groups. Insert @var{number} NOPs to force an insn to a new group.
17184 @end table
17185
17186 @item -mcall-sysv
17187 @opindex mcall-sysv
17188 On System V.4 and embedded PowerPC systems compile code using calling
17189 conventions that adheres to the March 1995 draft of the System V
17190 Application Binary Interface, PowerPC processor supplement. This is the
17191 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17192
17193 @item -mcall-sysv-eabi
17194 @itemx -mcall-eabi
17195 @opindex mcall-sysv-eabi
17196 @opindex mcall-eabi
17197 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17198
17199 @item -mcall-sysv-noeabi
17200 @opindex mcall-sysv-noeabi
17201 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17202
17203 @item -mcall-aixdesc
17204 @opindex m
17205 On System V.4 and embedded PowerPC systems compile code for the AIX
17206 operating system.
17207
17208 @item -mcall-linux
17209 @opindex mcall-linux
17210 On System V.4 and embedded PowerPC systems compile code for the
17211 Linux-based GNU system.
17212
17213 @item -mcall-freebsd
17214 @opindex mcall-freebsd
17215 On System V.4 and embedded PowerPC systems compile code for the
17216 FreeBSD operating system.
17217
17218 @item -mcall-netbsd
17219 @opindex mcall-netbsd
17220 On System V.4 and embedded PowerPC systems compile code for the
17221 NetBSD operating system.
17222
17223 @item -mcall-openbsd
17224 @opindex mcall-netbsd
17225 On System V.4 and embedded PowerPC systems compile code for the
17226 OpenBSD operating system.
17227
17228 @item -maix-struct-return
17229 @opindex maix-struct-return
17230 Return all structures in memory (as specified by the AIX ABI)@.
17231
17232 @item -msvr4-struct-return
17233 @opindex msvr4-struct-return
17234 Return structures smaller than 8 bytes in registers (as specified by the
17235 SVR4 ABI)@.
17236
17237 @item -mabi=@var{abi-type}
17238 @opindex mabi
17239 Extend the current ABI with a particular extension, or remove such extension.
17240 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17241 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17242
17243 @item -mabi=spe
17244 @opindex mabi=spe
17245 Extend the current ABI with SPE ABI extensions. This does not change
17246 the default ABI, instead it adds the SPE ABI extensions to the current
17247 ABI@.
17248
17249 @item -mabi=no-spe
17250 @opindex mabi=no-spe
17251 Disable Booke SPE ABI extensions for the current ABI@.
17252
17253 @item -mabi=ibmlongdouble
17254 @opindex mabi=ibmlongdouble
17255 Change the current ABI to use IBM extended-precision long double.
17256 This is a PowerPC 32-bit SYSV ABI option.
17257
17258 @item -mabi=ieeelongdouble
17259 @opindex mabi=ieeelongdouble
17260 Change the current ABI to use IEEE extended-precision long double.
17261 This is a PowerPC 32-bit Linux ABI option.
17262
17263 @item -mprototype
17264 @itemx -mno-prototype
17265 @opindex mprototype
17266 @opindex mno-prototype
17267 On System V.4 and embedded PowerPC systems assume that all calls to
17268 variable argument functions are properly prototyped. Otherwise, the
17269 compiler must insert an instruction before every non prototyped call to
17270 set or clear bit 6 of the condition code register (@var{CR}) to
17271 indicate whether floating-point values are passed in the floating-point
17272 registers in case the function takes variable arguments. With
17273 @option{-mprototype}, only calls to prototyped variable argument functions
17274 set or clear the bit.
17275
17276 @item -msim
17277 @opindex msim
17278 On embedded PowerPC systems, assume that the startup module is called
17279 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17280 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}
17281 configurations.
17282
17283 @item -mmvme
17284 @opindex mmvme
17285 On embedded PowerPC systems, assume that the startup module is called
17286 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17287 @file{libc.a}.
17288
17289 @item -mads
17290 @opindex mads
17291 On embedded PowerPC systems, assume that the startup module is called
17292 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17293 @file{libc.a}.
17294
17295 @item -myellowknife
17296 @opindex myellowknife
17297 On embedded PowerPC systems, assume that the startup module is called
17298 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17299 @file{libc.a}.
17300
17301 @item -mvxworks
17302 @opindex mvxworks
17303 On System V.4 and embedded PowerPC systems, specify that you are
17304 compiling for a VxWorks system.
17305
17306 @item -memb
17307 @opindex memb
17308 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17309 header to indicate that @samp{eabi} extended relocations are used.
17310
17311 @item -meabi
17312 @itemx -mno-eabi
17313 @opindex meabi
17314 @opindex mno-eabi
17315 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17316 Embedded Applications Binary Interface (eabi) which is a set of
17317 modifications to the System V.4 specifications. Selecting @option{-meabi}
17318 means that the stack is aligned to an 8-byte boundary, a function
17319 @code{__eabi} is called to from @code{main} to set up the eabi
17320 environment, and the @option{-msdata} option can use both @code{r2} and
17321 @code{r13} to point to two separate small data areas. Selecting
17322 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17323 do not call an initialization function from @code{main}, and the
17324 @option{-msdata} option only uses @code{r13} to point to a single
17325 small data area. The @option{-meabi} option is on by default if you
17326 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17327
17328 @item -msdata=eabi
17329 @opindex msdata=eabi
17330 On System V.4 and embedded PowerPC systems, put small initialized
17331 @code{const} global and static data in the @samp{.sdata2} section, which
17332 is pointed to by register @code{r2}. Put small initialized
17333 non-@code{const} global and static data in the @samp{.sdata} section,
17334 which is pointed to by register @code{r13}. Put small uninitialized
17335 global and static data in the @samp{.sbss} section, which is adjacent to
17336 the @samp{.sdata} section. The @option{-msdata=eabi} option is
17337 incompatible with the @option{-mrelocatable} option. The
17338 @option{-msdata=eabi} option also sets the @option{-memb} option.
17339
17340 @item -msdata=sysv
17341 @opindex msdata=sysv
17342 On System V.4 and embedded PowerPC systems, put small global and static
17343 data in the @samp{.sdata} section, which is pointed to by register
17344 @code{r13}. Put small uninitialized global and static data in the
17345 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17346 The @option{-msdata=sysv} option is incompatible with the
17347 @option{-mrelocatable} option.
17348
17349 @item -msdata=default
17350 @itemx -msdata
17351 @opindex msdata=default
17352 @opindex msdata
17353 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17354 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17355 same as @option{-msdata=sysv}.
17356
17357 @item -msdata=data
17358 @opindex msdata=data
17359 On System V.4 and embedded PowerPC systems, put small global
17360 data in the @samp{.sdata} section. Put small uninitialized global
17361 data in the @samp{.sbss} section. Do not use register @code{r13}
17362 to address small data however. This is the default behavior unless
17363 other @option{-msdata} options are used.
17364
17365 @item -msdata=none
17366 @itemx -mno-sdata
17367 @opindex msdata=none
17368 @opindex mno-sdata
17369 On embedded PowerPC systems, put all initialized global and static data
17370 in the @samp{.data} section, and all uninitialized data in the
17371 @samp{.bss} section.
17372
17373 @item -mblock-move-inline-limit=@var{num}
17374 @opindex mblock-move-inline-limit
17375 Inline all block moves (such as calls to @code{memcpy} or structure
17376 copies) less than or equal to @var{num} bytes. The minimum value for
17377 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17378 targets. The default value is target-specific.
17379
17380 @item -G @var{num}
17381 @opindex G
17382 @cindex smaller data references (PowerPC)
17383 @cindex .sdata/.sdata2 references (PowerPC)
17384 On embedded PowerPC systems, put global and static items less than or
17385 equal to @var{num} bytes into the small data or bss sections instead of
17386 the normal data or bss section. By default, @var{num} is 8. The
17387 @option{-G @var{num}} switch is also passed to the linker.
17388 All modules should be compiled with the same @option{-G @var{num}} value.
17389
17390 @item -mregnames
17391 @itemx -mno-regnames
17392 @opindex mregnames
17393 @opindex mno-regnames
17394 On System V.4 and embedded PowerPC systems do (do not) emit register
17395 names in the assembly language output using symbolic forms.
17396
17397 @item -mlongcall
17398 @itemx -mno-longcall
17399 @opindex mlongcall
17400 @opindex mno-longcall
17401 By default assume that all calls are far away so that a longer more
17402 expensive calling sequence is required. This is required for calls
17403 further than 32 megabytes (33,554,432 bytes) from the current location.
17404 A short call is generated if the compiler knows
17405 the call cannot be that far away. This setting can be overridden by
17406 the @code{shortcall} function attribute, or by @code{#pragma
17407 longcall(0)}.
17408
17409 Some linkers are capable of detecting out-of-range calls and generating
17410 glue code on the fly. On these systems, long calls are unnecessary and
17411 generate slower code. As of this writing, the AIX linker can do this,
17412 as can the GNU linker for PowerPC/64. It is planned to add this feature
17413 to the GNU linker for 32-bit PowerPC systems as well.
17414
17415 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17416 callee, L42}, plus a @dfn{branch island} (glue code). The two target
17417 addresses represent the callee and the branch island. The
17418 Darwin/PPC linker prefers the first address and generates a @code{bl
17419 callee} if the PPC @code{bl} instruction reaches the callee directly;
17420 otherwise, the linker generates @code{bl L42} to call the branch
17421 island. The branch island is appended to the body of the
17422 calling function; it computes the full 32-bit address of the callee
17423 and jumps to it.
17424
17425 On Mach-O (Darwin) systems, this option directs the compiler emit to
17426 the glue for every direct call, and the Darwin linker decides whether
17427 to use or discard it.
17428
17429 In the future, GCC may ignore all longcall specifications
17430 when the linker is known to generate glue.
17431
17432 @item -mtls-markers
17433 @itemx -mno-tls-markers
17434 @opindex mtls-markers
17435 @opindex mno-tls-markers
17436 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17437 specifying the function argument. The relocation allows the linker to
17438 reliably associate function call with argument setup instructions for
17439 TLS optimization, which in turn allows GCC to better schedule the
17440 sequence.
17441
17442 @item -pthread
17443 @opindex pthread
17444 Adds support for multithreading with the @dfn{pthreads} library.
17445 This option sets flags for both the preprocessor and linker.
17446
17447 @item -mrecip
17448 @itemx -mno-recip
17449 @opindex mrecip
17450 This option enables use of the reciprocal estimate and
17451 reciprocal square root estimate instructions with additional
17452 Newton-Raphson steps to increase precision instead of doing a divide or
17453 square root and divide for floating-point arguments. You should use
17454 the @option{-ffast-math} option when using @option{-mrecip} (or at
17455 least @option{-funsafe-math-optimizations},
17456 @option{-finite-math-only}, @option{-freciprocal-math} and
17457 @option{-fno-trapping-math}). Note that while the throughput of the
17458 sequence is generally higher than the throughput of the non-reciprocal
17459 instruction, the precision of the sequence can be decreased by up to 2
17460 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
17461 roots.
17462
17463 @item -mrecip=@var{opt}
17464 @opindex mrecip=opt
17465 This option allows to control which reciprocal estimate instructions
17466 may be used. @var{opt} is a comma separated list of options, which may
17467 be preceded by a @code{!} to invert the option:
17468 @code{all}: enable all estimate instructions,
17469 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17470 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17471 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17472 @code{divf}: enable the single-precision reciprocal approximation instructions;
17473 @code{divd}: enable the double-precision reciprocal approximation instructions;
17474 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17475 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17476 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17477
17478 So, for example, @option{-mrecip=all,!rsqrtd} enables
17479 all of the reciprocal estimate instructions, except for the
17480 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17481 which handle the double-precision reciprocal square root calculations.
17482
17483 @item -mrecip-precision
17484 @itemx -mno-recip-precision
17485 @opindex mrecip-precision
17486 Assume (do not assume) that the reciprocal estimate instructions
17487 provide higher-precision estimates than is mandated by the PowerPC
17488 ABI. Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17489 automatically selects @option{-mrecip-precision}. The double-precision
17490 square root estimate instructions are not generated by
17491 default on low-precision machines, since they do not provide an
17492 estimate that converges after three steps.
17493
17494 @item -mveclibabi=@var{type}
17495 @opindex mveclibabi
17496 Specifies the ABI type to use for vectorizing intrinsics using an
17497 external library. The only type supported at present is @code{mass},
17498 which specifies to use IBM's Mathematical Acceleration Subsystem
17499 (MASS) libraries for vectorizing intrinsics using external libraries.
17500 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17501 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17502 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17503 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17504 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17505 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17506 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17507 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17508 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17509 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17510 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17511 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17512 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17513 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17514 for power7. Both @option{-ftree-vectorize} and
17515 @option{-funsafe-math-optimizations} must also be enabled. The MASS
17516 libraries must be specified at link time.
17517
17518 @item -mfriz
17519 @itemx -mno-friz
17520 @opindex mfriz
17521 Generate (do not generate) the @code{friz} instruction when the
17522 @option{-funsafe-math-optimizations} option is used to optimize
17523 rounding of floating-point values to 64-bit integer and back to floating
17524 point. The @code{friz} instruction does not return the same value if
17525 the floating-point number is too large to fit in an integer.
17526
17527 @item -mpointers-to-nested-functions
17528 @itemx -mno-pointers-to-nested-functions
17529 @opindex mpointers-to-nested-functions
17530 Generate (do not generate) code to load up the static chain register
17531 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17532 systems where a function pointer points to a 3-word descriptor giving
17533 the function address, TOC value to be loaded in register @var{r2}, and
17534 static chain value to be loaded in register @var{r11}. The
17535 @option{-mpointers-to-nested-functions} is on by default. You cannot
17536 call through pointers to nested functions or pointers
17537 to functions compiled in other languages that use the static chain if
17538 you use the @option{-mno-pointers-to-nested-functions}.
17539
17540 @item -msave-toc-indirect
17541 @itemx -mno-save-toc-indirect
17542 @opindex msave-toc-indirect
17543 Generate (do not generate) code to save the TOC value in the reserved
17544 stack location in the function prologue if the function calls through
17545 a pointer on AIX and 64-bit Linux systems. If the TOC value is not
17546 saved in the prologue, it is saved just before the call through the
17547 pointer. The @option{-mno-save-toc-indirect} option is the default.
17548 @end table
17549
17550 @node RX Options
17551 @subsection RX Options
17552 @cindex RX Options
17553
17554 These command-line options are defined for RX targets:
17555
17556 @table @gcctabopt
17557 @item -m64bit-doubles
17558 @itemx -m32bit-doubles
17559 @opindex m64bit-doubles
17560 @opindex m32bit-doubles
17561 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17562 or 32 bits (@option{-m32bit-doubles}) in size. The default is
17563 @option{-m32bit-doubles}. @emph{Note} RX floating-point hardware only
17564 works on 32-bit values, which is why the default is
17565 @option{-m32bit-doubles}.
17566
17567 @item -fpu
17568 @itemx -nofpu
17569 @opindex fpu
17570 @opindex nofpu
17571 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17572 floating-point hardware. The default is enabled for the @var{RX600}
17573 series and disabled for the @var{RX200} series.
17574
17575 Floating-point instructions are only generated for 32-bit floating-point
17576 values, however, so the FPU hardware is not used for doubles if the
17577 @option{-m64bit-doubles} option is used.
17578
17579 @emph{Note} If the @option{-fpu} option is enabled then
17580 @option{-funsafe-math-optimizations} is also enabled automatically.
17581 This is because the RX FPU instructions are themselves unsafe.
17582
17583 @item -mcpu=@var{name}
17584 @opindex -mcpu
17585 Selects the type of RX CPU to be targeted. Currently three types are
17586 supported, the generic @var{RX600} and @var{RX200} series hardware and
17587 the specific @var{RX610} CPU. The default is @var{RX600}.
17588
17589 The only difference between @var{RX600} and @var{RX610} is that the
17590 @var{RX610} does not support the @code{MVTIPL} instruction.
17591
17592 The @var{RX200} series does not have a hardware floating-point unit
17593 and so @option{-nofpu} is enabled by default when this type is
17594 selected.
17595
17596 @item -mbig-endian-data
17597 @itemx -mlittle-endian-data
17598 @opindex mbig-endian-data
17599 @opindex mlittle-endian-data
17600 Store data (but not code) in the big-endian format. The default is
17601 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17602 format.
17603
17604 @item -msmall-data-limit=@var{N}
17605 @opindex msmall-data-limit
17606 Specifies the maximum size in bytes of global and static variables
17607 which can be placed into the small data area. Using the small data
17608 area can lead to smaller and faster code, but the size of area is
17609 limited and it is up to the programmer to ensure that the area does
17610 not overflow. Also when the small data area is used one of the RX's
17611 registers (usually @code{r13}) is reserved for use pointing to this
17612 area, so it is no longer available for use by the compiler. This
17613 could result in slower and/or larger code if variables are pushed onto
17614 the stack instead of being held in this register.
17615
17616 Note, common variables (variables that have not been initialized) and
17617 constants are not placed into the small data area as they are assigned
17618 to other sections in the output executable.
17619
17620 The default value is zero, which disables this feature. Note, this
17621 feature is not enabled by default with higher optimization levels
17622 (@option{-O2} etc) because of the potentially detrimental effects of
17623 reserving a register. It is up to the programmer to experiment and
17624 discover whether this feature is of benefit to their program. See the
17625 description of the @option{-mpid} option for a description of how the
17626 actual register to hold the small data area pointer is chosen.
17627
17628 @item -msim
17629 @itemx -mno-sim
17630 @opindex msim
17631 @opindex mno-sim
17632 Use the simulator runtime. The default is to use the libgloss board
17633 specific runtime.
17634
17635 @item -mas100-syntax
17636 @itemx -mno-as100-syntax
17637 @opindex mas100-syntax
17638 @opindex mno-as100-syntax
17639 When generating assembler output use a syntax that is compatible with
17640 Renesas's AS100 assembler. This syntax can also be handled by the GAS
17641 assembler but it has some restrictions so generating it is not the
17642 default option.
17643
17644 @item -mmax-constant-size=@var{N}
17645 @opindex mmax-constant-size
17646 Specifies the maximum size, in bytes, of a constant that can be used as
17647 an operand in a RX instruction. Although the RX instruction set does
17648 allow constants of up to 4 bytes in length to be used in instructions,
17649 a longer value equates to a longer instruction. Thus in some
17650 circumstances it can be beneficial to restrict the size of constants
17651 that are used in instructions. Constants that are too big are instead
17652 placed into a constant pool and referenced via register indirection.
17653
17654 The value @var{N} can be between 0 and 4. A value of 0 (the default)
17655 or 4 means that constants of any size are allowed.
17656
17657 @item -mrelax
17658 @opindex mrelax
17659 Enable linker relaxation. Linker relaxation is a process whereby the
17660 linker attempts to reduce the size of a program by finding shorter
17661 versions of various instructions. Disabled by default.
17662
17663 @item -mint-register=@var{N}
17664 @opindex mint-register
17665 Specify the number of registers to reserve for fast interrupt handler
17666 functions. The value @var{N} can be between 0 and 4. A value of 1
17667 means that register @code{r13} is reserved for the exclusive use
17668 of fast interrupt handlers. A value of 2 reserves @code{r13} and
17669 @code{r12}. A value of 3 reserves @code{r13}, @code{r12} and
17670 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17671 A value of 0, the default, does not reserve any registers.
17672
17673 @item -msave-acc-in-interrupts
17674 @opindex msave-acc-in-interrupts
17675 Specifies that interrupt handler functions should preserve the
17676 accumulator register. This is only necessary if normal code might use
17677 the accumulator register, for example because it performs 64-bit
17678 multiplications. The default is to ignore the accumulator as this
17679 makes the interrupt handlers faster.
17680
17681 @item -mpid
17682 @itemx -mno-pid
17683 @opindex mpid
17684 @opindex mno-pid
17685 Enables the generation of position independent data. When enabled any
17686 access to constant data is done via an offset from a base address
17687 held in a register. This allows the location of constant data to be
17688 determined at run time without requiring the executable to be
17689 relocated, which is a benefit to embedded applications with tight
17690 memory constraints. Data that can be modified is not affected by this
17691 option.
17692
17693 Note, using this feature reserves a register, usually @code{r13}, for
17694 the constant data base address. This can result in slower and/or
17695 larger code, especially in complicated functions.
17696
17697 The actual register chosen to hold the constant data base address
17698 depends upon whether the @option{-msmall-data-limit} and/or the
17699 @option{-mint-register} command-line options are enabled. Starting
17700 with register @code{r13} and proceeding downwards, registers are
17701 allocated first to satisfy the requirements of @option{-mint-register},
17702 then @option{-mpid} and finally @option{-msmall-data-limit}. Thus it
17703 is possible for the small data area register to be @code{r8} if both
17704 @option{-mint-register=4} and @option{-mpid} are specified on the
17705 command line.
17706
17707 By default this feature is not enabled. The default can be restored
17708 via the @option{-mno-pid} command-line option.
17709
17710 @end table
17711
17712 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
17713 has special significance to the RX port when used with the
17714 @code{interrupt} function attribute. This attribute indicates a
17715 function intended to process fast interrupts. GCC ensures
17716 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17717 and/or @code{r13} and only provided that the normal use of the
17718 corresponding registers have been restricted via the
17719 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
17720 options.
17721
17722 @node S/390 and zSeries Options
17723 @subsection S/390 and zSeries Options
17724 @cindex S/390 and zSeries Options
17725
17726 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17727
17728 @table @gcctabopt
17729 @item -mhard-float
17730 @itemx -msoft-float
17731 @opindex mhard-float
17732 @opindex msoft-float
17733 Use (do not use) the hardware floating-point instructions and registers
17734 for floating-point operations. When @option{-msoft-float} is specified,
17735 functions in @file{libgcc.a} are used to perform floating-point
17736 operations. When @option{-mhard-float} is specified, the compiler
17737 generates IEEE floating-point instructions. This is the default.
17738
17739 @item -mhard-dfp
17740 @itemx -mno-hard-dfp
17741 @opindex mhard-dfp
17742 @opindex mno-hard-dfp
17743 Use (do not use) the hardware decimal-floating-point instructions for
17744 decimal-floating-point operations. When @option{-mno-hard-dfp} is
17745 specified, functions in @file{libgcc.a} are used to perform
17746 decimal-floating-point operations. When @option{-mhard-dfp} is
17747 specified, the compiler generates decimal-floating-point hardware
17748 instructions. This is the default for @option{-march=z9-ec} or higher.
17749
17750 @item -mlong-double-64
17751 @itemx -mlong-double-128
17752 @opindex mlong-double-64
17753 @opindex mlong-double-128
17754 These switches control the size of @code{long double} type. A size
17755 of 64 bits makes the @code{long double} type equivalent to the @code{double}
17756 type. This is the default.
17757
17758 @item -mbackchain
17759 @itemx -mno-backchain
17760 @opindex mbackchain
17761 @opindex mno-backchain
17762 Store (do not store) the address of the caller's frame as backchain pointer
17763 into the callee's stack frame.
17764 A backchain may be needed to allow debugging using tools that do not understand
17765 DWARF 2 call frame information.
17766 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17767 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17768 the backchain is placed into the topmost word of the 96/160 byte register
17769 save area.
17770
17771 In general, code compiled with @option{-mbackchain} is call-compatible with
17772 code compiled with @option{-mmo-backchain}; however, use of the backchain
17773 for debugging purposes usually requires that the whole binary is built with
17774 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
17775 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
17776 to build a linux kernel use @option{-msoft-float}.
17777
17778 The default is to not maintain the backchain.
17779
17780 @item -mpacked-stack
17781 @itemx -mno-packed-stack
17782 @opindex mpacked-stack
17783 @opindex mno-packed-stack
17784 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
17785 specified, the compiler uses the all fields of the 96/160 byte register save
17786 area only for their default purpose; unused fields still take up stack space.
17787 When @option{-mpacked-stack} is specified, register save slots are densely
17788 packed at the top of the register save area; unused space is reused for other
17789 purposes, allowing for more efficient use of the available stack space.
17790 However, when @option{-mbackchain} is also in effect, the topmost word of
17791 the save area is always used to store the backchain, and the return address
17792 register is always saved two words below the backchain.
17793
17794 As long as the stack frame backchain is not used, code generated with
17795 @option{-mpacked-stack} is call-compatible with code generated with
17796 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
17797 S/390 or zSeries generated code that uses the stack frame backchain at run
17798 time, not just for debugging purposes. Such code is not call-compatible
17799 with code compiled with @option{-mpacked-stack}. Also, note that the
17800 combination of @option{-mbackchain},
17801 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
17802 to build a linux kernel use @option{-msoft-float}.
17803
17804 The default is to not use the packed stack layout.
17805
17806 @item -msmall-exec
17807 @itemx -mno-small-exec
17808 @opindex msmall-exec
17809 @opindex mno-small-exec
17810 Generate (or do not generate) code using the @code{bras} instruction
17811 to do subroutine calls.
17812 This only works reliably if the total executable size does not
17813 exceed 64k. The default is to use the @code{basr} instruction instead,
17814 which does not have this limitation.
17815
17816 @item -m64
17817 @itemx -m31
17818 @opindex m64
17819 @opindex m31
17820 When @option{-m31} is specified, generate code compliant to the
17821 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
17822 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
17823 particular to generate 64-bit instructions. For the @samp{s390}
17824 targets, the default is @option{-m31}, while the @samp{s390x}
17825 targets default to @option{-m64}.
17826
17827 @item -mzarch
17828 @itemx -mesa
17829 @opindex mzarch
17830 @opindex mesa
17831 When @option{-mzarch} is specified, generate code using the
17832 instructions available on z/Architecture.
17833 When @option{-mesa} is specified, generate code using the
17834 instructions available on ESA/390. Note that @option{-mesa} is
17835 not possible with @option{-m64}.
17836 When generating code compliant to the GNU/Linux for S/390 ABI,
17837 the default is @option{-mesa}. When generating code compliant
17838 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17839
17840 @item -mmvcle
17841 @itemx -mno-mvcle
17842 @opindex mmvcle
17843 @opindex mno-mvcle
17844 Generate (or do not generate) code using the @code{mvcle} instruction
17845 to perform block moves. When @option{-mno-mvcle} is specified,
17846 use a @code{mvc} loop instead. This is the default unless optimizing for
17847 size.
17848
17849 @item -mdebug
17850 @itemx -mno-debug
17851 @opindex mdebug
17852 @opindex mno-debug
17853 Print (or do not print) additional debug information when compiling.
17854 The default is to not print debug information.
17855
17856 @item -march=@var{cpu-type}
17857 @opindex march
17858 Generate code that runs on @var{cpu-type}, which is the name of a system
17859 representing a certain processor type. Possible values for
17860 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17861 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17862 When generating code using the instructions available on z/Architecture,
17863 the default is @option{-march=z900}. Otherwise, the default is
17864 @option{-march=g5}.
17865
17866 @item -mtune=@var{cpu-type}
17867 @opindex mtune
17868 Tune to @var{cpu-type} everything applicable about the generated code,
17869 except for the ABI and the set of available instructions.
17870 The list of @var{cpu-type} values is the same as for @option{-march}.
17871 The default is the value used for @option{-march}.
17872
17873 @item -mtpf-trace
17874 @itemx -mno-tpf-trace
17875 @opindex mtpf-trace
17876 @opindex mno-tpf-trace
17877 Generate code that adds (does not add) in TPF OS specific branches to trace
17878 routines in the operating system. This option is off by default, even
17879 when compiling for the TPF OS@.
17880
17881 @item -mfused-madd
17882 @itemx -mno-fused-madd
17883 @opindex mfused-madd
17884 @opindex mno-fused-madd
17885 Generate code that uses (does not use) the floating-point multiply and
17886 accumulate instructions. These instructions are generated by default if
17887 hardware floating point is used.
17888
17889 @item -mwarn-framesize=@var{framesize}
17890 @opindex mwarn-framesize
17891 Emit a warning if the current function exceeds the given frame size. Because
17892 this is a compile-time check it doesn't need to be a real problem when the program
17893 runs. It is intended to identify functions that most probably cause
17894 a stack overflow. It is useful to be used in an environment with limited stack
17895 size e.g.@: the linux kernel.
17896
17897 @item -mwarn-dynamicstack
17898 @opindex mwarn-dynamicstack
17899 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
17900 arrays. This is generally a bad idea with a limited stack size.
17901
17902 @item -mstack-guard=@var{stack-guard}
17903 @itemx -mstack-size=@var{stack-size}
17904 @opindex mstack-guard
17905 @opindex mstack-size
17906 If these options are provided the s390 back end emits additional instructions in
17907 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17908 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17909 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17910 the frame size of the compiled function is chosen.
17911 These options are intended to be used to help debugging stack overflow problems.
17912 The additionally emitted code causes only little overhead and hence can also be
17913 used in production like systems without greater performance degradation. The given
17914 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17915 @var{stack-guard} without exceeding 64k.
17916 In order to be efficient the extra code makes the assumption that the stack starts
17917 at an address aligned to the value given by @var{stack-size}.
17918 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17919 @end table
17920
17921 @node Score Options
17922 @subsection Score Options
17923 @cindex Score Options
17924
17925 These options are defined for Score implementations:
17926
17927 @table @gcctabopt
17928 @item -meb
17929 @opindex meb
17930 Compile code for big-endian mode. This is the default.
17931
17932 @item -mel
17933 @opindex mel
17934 Compile code for little-endian mode.
17935
17936 @item -mnhwloop
17937 @opindex mnhwloop
17938 Disable generate bcnz instruction.
17939
17940 @item -muls
17941 @opindex muls
17942 Enable generate unaligned load and store instruction.
17943
17944 @item -mmac
17945 @opindex mmac
17946 Enable the use of multiply-accumulate instructions. Disabled by default.
17947
17948 @item -mscore5
17949 @opindex mscore5
17950 Specify the SCORE5 as the target architecture.
17951
17952 @item -mscore5u
17953 @opindex mscore5u
17954 Specify the SCORE5U of the target architecture.
17955
17956 @item -mscore7
17957 @opindex mscore7
17958 Specify the SCORE7 as the target architecture. This is the default.
17959
17960 @item -mscore7d
17961 @opindex mscore7d
17962 Specify the SCORE7D as the target architecture.
17963 @end table
17964
17965 @node SH Options
17966 @subsection SH Options
17967
17968 These @samp{-m} options are defined for the SH implementations:
17969
17970 @table @gcctabopt
17971 @item -m1
17972 @opindex m1
17973 Generate code for the SH1.
17974
17975 @item -m2
17976 @opindex m2
17977 Generate code for the SH2.
17978
17979 @item -m2e
17980 Generate code for the SH2e.
17981
17982 @item -m2a-nofpu
17983 @opindex m2a-nofpu
17984 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
17985 that the floating-point unit is not used.
17986
17987 @item -m2a-single-only
17988 @opindex m2a-single-only
17989 Generate code for the SH2a-FPU, in such a way that no double-precision
17990 floating-point operations are used.
17991
17992 @item -m2a-single
17993 @opindex m2a-single
17994 Generate code for the SH2a-FPU assuming the floating-point unit is in
17995 single-precision mode by default.
17996
17997 @item -m2a
17998 @opindex m2a
17999 Generate code for the SH2a-FPU assuming the floating-point unit is in
18000 double-precision mode by default.
18001
18002 @item -m3
18003 @opindex m3
18004 Generate code for the SH3.
18005
18006 @item -m3e
18007 @opindex m3e
18008 Generate code for the SH3e.
18009
18010 @item -m4-nofpu
18011 @opindex m4-nofpu
18012 Generate code for the SH4 without a floating-point unit.
18013
18014 @item -m4-single-only
18015 @opindex m4-single-only
18016 Generate code for the SH4 with a floating-point unit that only
18017 supports single-precision arithmetic.
18018
18019 @item -m4-single
18020 @opindex m4-single
18021 Generate code for the SH4 assuming the floating-point unit is in
18022 single-precision mode by default.
18023
18024 @item -m4
18025 @opindex m4
18026 Generate code for the SH4.
18027
18028 @item -m4a-nofpu
18029 @opindex m4a-nofpu
18030 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18031 floating-point unit is not used.
18032
18033 @item -m4a-single-only
18034 @opindex m4a-single-only
18035 Generate code for the SH4a, in such a way that no double-precision
18036 floating-point operations are used.
18037
18038 @item -m4a-single
18039 @opindex m4a-single
18040 Generate code for the SH4a assuming the floating-point unit is in
18041 single-precision mode by default.
18042
18043 @item -m4a
18044 @opindex m4a
18045 Generate code for the SH4a.
18046
18047 @item -m4al
18048 @opindex m4al
18049 Same as @option{-m4a-nofpu}, except that it implicitly passes
18050 @option{-dsp} to the assembler. GCC doesn't generate any DSP
18051 instructions at the moment.
18052
18053 @item -mb
18054 @opindex mb
18055 Compile code for the processor in big-endian mode.
18056
18057 @item -ml
18058 @opindex ml
18059 Compile code for the processor in little-endian mode.
18060
18061 @item -mdalign
18062 @opindex mdalign
18063 Align doubles at 64-bit boundaries. Note that this changes the calling
18064 conventions, and thus some functions from the standard C library do
18065 not work unless you recompile it first with @option{-mdalign}.
18066
18067 @item -mrelax
18068 @opindex mrelax
18069 Shorten some address references at link time, when possible; uses the
18070 linker option @option{-relax}.
18071
18072 @item -mbigtable
18073 @opindex mbigtable
18074 Use 32-bit offsets in @code{switch} tables. The default is to use
18075 16-bit offsets.
18076
18077 @item -mbitops
18078 @opindex mbitops
18079 Enable the use of bit manipulation instructions on SH2A.
18080
18081 @item -mfmovd
18082 @opindex mfmovd
18083 Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for
18084 alignment constraints.
18085
18086 @item -mhitachi
18087 @opindex mhitachi
18088 Comply with the calling conventions defined by Renesas.
18089
18090 @item -mrenesas
18091 @opindex mhitachi
18092 Comply with the calling conventions defined by Renesas.
18093
18094 @item -mno-renesas
18095 @opindex mhitachi
18096 Comply with the calling conventions defined for GCC before the Renesas
18097 conventions were available. This option is the default for all
18098 targets of the SH toolchain.
18099
18100 @item -mnomacsave
18101 @opindex mnomacsave
18102 Mark the @code{MAC} register as call-clobbered, even if
18103 @option{-mhitachi} is given.
18104
18105 @item -mieee
18106 @item -mno-ieee
18107 @opindex mieee
18108 @opindex mnoieee
18109 Control the IEEE compliance of floating-point comparisons, which affects the
18110 handling of cases where the result of a comparison is unordered. By default
18111 @option{-mieee} is implicitly enabled. If @option{-ffinite-math-only} is
18112 enabled @option{-mno-ieee} is implicitly set, which results in faster
18113 floating-point greater-equal and less-equal comparisons. The implcit settings
18114 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18115
18116 @item -minline-ic_invalidate
18117 @opindex minline-ic_invalidate
18118 Inline code to invalidate instruction cache entries after setting up
18119 nested function trampolines.
18120 This option has no effect if @option{-musermode} is in effect and the selected
18121 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18122 instruction.
18123 If the selected code generation option does not allow the use of the @code{icbi}
18124 instruction, and @option{-musermode} is not in effect, the inlined code
18125 manipulates the instruction cache address array directly with an associative
18126 write. This not only requires privileged mode at run time, but it also
18127 fails if the cache line had been mapped via the TLB and has become unmapped.
18128
18129 @item -misize
18130 @opindex misize
18131 Dump instruction size and location in the assembly code.
18132
18133 @item -mpadstruct
18134 @opindex mpadstruct
18135 This option is deprecated. It pads structures to multiple of 4 bytes,
18136 which is incompatible with the SH ABI@.
18137
18138 @item -msoft-atomic
18139 @opindex msoft-atomic
18140 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18141 built-in functions. The generated atomic sequences require support from the
18142 interrupt / exception handling code of the system and are only suitable for
18143 single-core systems. They will not operate correctly on multi-core systems.
18144 This option is enabled by default when the target is @code{sh-*-linux*}.
18145 When the target is SH4A, this option will also partially utilize the hardware
18146 atomic instructions @code{movli.l} and @code{movco.l} to create more
18147 efficient code.
18148 For details on the atomic built-in functions see @ref{__atomic Builtins}.
18149
18150 @item -mhard-atomic
18151 @opindex hard-atomic
18152 Generate hardware atomic sequences for the atomic built-in functions. This
18153 is only available on SH4A and is suitable for multi-core systems. Code
18154 compiled with this option will also be compatible with gUSA aware
18155 interrupt / exception handling systems. In contrast to the
18156 @option{-msoft-atomic} option this will only use the instructions
18157 @code{movli.l} and @code{movco.l} to create atomic sequences.
18158
18159 @item -menable-tas
18160 @opindex menable-tas
18161 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18162 Notice that depending on the particular hardware and software configuration
18163 this can degrade overall performance due to the operand cache line flushes
18164 that are implied by the @code{tas.b} instruction. On multi-core SH4A
18165 processors the @code{tas.b} instruction must be used with caution since it
18166 can result in data corruption for certain cache configurations.
18167
18168 @item -mspace
18169 @opindex mspace
18170 Optimize for space instead of speed. Implied by @option{-Os}.
18171
18172 @item -mprefergot
18173 @opindex mprefergot
18174 When generating position-independent code, emit function calls using
18175 the Global Offset Table instead of the Procedure Linkage Table.
18176
18177 @item -musermode
18178 @opindex musermode
18179 Don't generate privileged mode only code. This option
18180 implies @option{-mno-inline-ic_invalidate}
18181 if the inlined code would not work in user mode.
18182 This is the default when the target is @code{sh-*-linux*}.
18183
18184 @item -multcost=@var{number}
18185 @opindex multcost=@var{number}
18186 Set the cost to assume for a multiply insn.
18187
18188 @item -mdiv=@var{strategy}
18189 @opindex mdiv=@var{strategy}
18190 Set the division strategy to use for SHmedia code. @var{strategy} must be
18191 one of:
18192
18193 @table @samp
18194
18195 @item fp
18196 Performs the operation in floating point. This has a very high latency,
18197 but needs only a few instructions, so it might be a good choice if
18198 your code has enough easily-exploitable ILP to allow the compiler to
18199 schedule the floating-point instructions together with other instructions.
18200 Division by zero causes a floating-point exception.
18201
18202 @item inv
18203 Uses integer operations to calculate the inverse of the divisor,
18204 and then multiplies the dividend with the inverse. This strategy allows
18205 CSE and hoisting of the inverse calculation. Division by zero calculates
18206 an unspecified result, but does not trap.
18207
18208 @item inv:minlat
18209 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18210 have been found, or if the entire operation has been hoisted to the same
18211 place, the last stages of the inverse calculation are intertwined with the
18212 final multiply to reduce the overall latency, at the expense of using a few
18213 more instructions, and thus offering fewer scheduling opportunities with
18214 other code.
18215
18216 @item call
18217 Calls a library function that usually implements the @samp{inv:minlat}
18218 strategy.
18219 This gives high code density for @code{m5-*media-nofpu} compilations.
18220
18221 @item call2
18222 Uses a different entry point of the same library function, where it
18223 assumes that a pointer to a lookup table has already been set up, which
18224 exposes the pointer load to CSE and code hoisting optimizations.
18225
18226 @item inv:call
18227 @itemx inv:call2
18228 @itemx inv:fp
18229 Use the @samp{inv} algorithm for initial
18230 code generation, but if the code stays unoptimized, revert to the @samp{call},
18231 @samp{call2}, or @samp{fp} strategies, respectively. Note that the
18232 potentially-trapping side effect of division by zero is carried by a
18233 separate instruction, so it is possible that all the integer instructions
18234 are hoisted out, but the marker for the side effect stays where it is.
18235 A recombination to floating-point operations or a call is not possible
18236 in that case.
18237
18238 @item inv20u
18239 @itemx inv20l
18240 Variants of the @samp{inv:minlat} strategy. In the case
18241 that the inverse calculation is not separated from the multiply, they speed
18242 up division where the dividend fits into 20 bits (plus sign where applicable)
18243 by inserting a test to skip a number of operations in this case; this test
18244 slows down the case of larger dividends. @samp{inv20u} assumes the case of a such
18245 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18246
18247 @end table
18248
18249 @item -maccumulate-outgoing-args
18250 @opindex maccumulate-outgoing-args
18251 Reserve space once for outgoing arguments in the function prologue rather
18252 than around each call. Generally beneficial for performance and size. Also
18253 needed for unwinding to avoid changing the stack frame around conditional code.
18254
18255 @item -mdivsi3_libfunc=@var{name}
18256 @opindex mdivsi3_libfunc=@var{name}
18257 Set the name of the library function used for 32-bit signed division to
18258 @var{name}.
18259 This only affects the name used in the @samp{call} and @samp{inv:call}
18260 division strategies, and the compiler still expects the same
18261 sets of input/output/clobbered registers as if this option were not present.
18262
18263 @item -mfixed-range=@var{register-range}
18264 @opindex mfixed-range
18265 Generate code treating the given register range as fixed registers.
18266 A fixed register is one that the register allocator can not use. This is
18267 useful when compiling kernel code. A register range is specified as
18268 two registers separated by a dash. Multiple register ranges can be
18269 specified separated by a comma.
18270
18271 @item -mindexed-addressing
18272 @opindex mindexed-addressing
18273 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18274 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18275 semantics for the indexed addressing mode. The architecture allows the
18276 implementation of processors with 64-bit MMU, which the OS could use to
18277 get 32-bit addressing, but since no current hardware implementation supports
18278 this or any other way to make the indexed addressing mode safe to use in
18279 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18280
18281 @item -mgettrcost=@var{number}
18282 @opindex mgettrcost=@var{number}
18283 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18284 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18285
18286 @item -mpt-fixed
18287 @opindex mpt-fixed
18288 Assume @code{pt*} instructions won't trap. This generally generates
18289 better-scheduled code, but is unsafe on current hardware.
18290 The current architecture
18291 definition says that @code{ptabs} and @code{ptrel} trap when the target
18292 anded with 3 is 3.
18293 This has the unintentional effect of making it unsafe to schedule these
18294 instructions before a branch, or hoist them out of a loop. For example,
18295 @code{__do_global_ctors}, a part of @file{libgcc}
18296 that runs constructors at program
18297 startup, calls functions in a list which is delimited by @minus{}1. With the
18298 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18299 That means that all the constructors run a bit more quickly, but when
18300 the loop comes to the end of the list, the program crashes because @code{ptabs}
18301 loads @minus{}1 into a target register.
18302
18303 Since this option is unsafe for any
18304 hardware implementing the current architecture specification, the default
18305 is @option{-mno-pt-fixed}. Unless specified explicitly with
18306 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18307 this deters register allocation from using target registers for storing
18308 ordinary integers.
18309
18310 @item -minvalid-symbols
18311 @opindex minvalid-symbols
18312 Assume symbols might be invalid. Ordinary function symbols generated by
18313 the compiler are always valid to load with
18314 @code{movi}/@code{shori}/@code{ptabs} or
18315 @code{movi}/@code{shori}/@code{ptrel},
18316 but with assembler and/or linker tricks it is possible
18317 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18318 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18319 It prevents cross-basic-block CSE, hoisting and most scheduling
18320 of symbol loads. The default is @option{-mno-invalid-symbols}.
18321
18322 @item -mbranch-cost=@var{num}
18323 @opindex mbranch-cost=@var{num}
18324 Assume @var{num} to be the cost for a branch instruction. Higher numbers
18325 make the compiler try to generate more branch-free code if possible.
18326 If not specified the value is selected depending on the processor type that
18327 is being compiled for.
18328
18329 @item -mzdcbranch
18330 @itemx -mno-zdcbranch
18331 @opindex mzdcbranch
18332 @opindex mno-zdcbranch
18333 Assume (do not assume) that zero displacement conditional branch instructions
18334 @code{bt} and @code{bf} are fast. If @option{-mzdcbranch} is specified, the
18335 compiler will try to prefer zero displacement branch code sequences. This is
18336 enabled by default when generating code for SH4 and SH4A. It can be explicitly
18337 disabled by specifying @option{-mno-zdcbranch}.
18338
18339 @item -mcbranchdi
18340 @opindex mcbranchdi
18341 Enable the @code{cbranchdi4} instruction pattern.
18342
18343 @item -mcmpeqdi
18344 @opindex mcmpeqdi
18345 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18346 is in effect.
18347
18348 @item -mfused-madd
18349 @itemx -mno-fused-madd
18350 @opindex mfused-madd
18351 @opindex mno-fused-madd
18352 Generate code that uses (does not use) the floating-point multiply and
18353 accumulate instructions. These instructions are generated by default
18354 if hardware floating point is used. The machine-dependent
18355 @option{-mfused-madd} option is now mapped to the machine-independent
18356 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18357 mapped to @option{-ffp-contract=off}.
18358
18359 @item -mfsca
18360 @itemx -mno-fsca
18361 @opindex mfsca
18362 @opindex mno-fsca
18363 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18364 and cosine approximations. The option @code{-mfsca} must be used in
18365 combination with @code{-funsafe-math-optimizations}. It is enabled by default
18366 when generating code for SH4A. Using @code{-mno-fsca} disables sine and cosine
18367 approximations even if @code{-funsafe-math-optimizations} is in effect.
18368
18369 @item -mfsrra
18370 @itemx -mno-fsrra
18371 @opindex mfsrra
18372 @opindex mno-fsrra
18373 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18374 reciprocal square root approximations. The option @code{-mfsrra} must be used
18375 in combination with @code{-funsafe-math-optimizations} and
18376 @code{-ffinite-math-only}. It is enabled by default when generating code for
18377 SH4A. Using @code{-mno-fsrra} disables reciprocal square root approximations
18378 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18379 in effect.
18380
18381 @item -mpretend-cmove
18382 @opindex mpretend-cmove
18383 Prefer zero-displacement conditional branches for conditional move instruction
18384 patterns. This can result in faster code on the SH4 processor.
18385
18386 @end table
18387
18388 @node Solaris 2 Options
18389 @subsection Solaris 2 Options
18390 @cindex Solaris 2 options
18391
18392 These @samp{-m} options are supported on Solaris 2:
18393
18394 @table @gcctabopt
18395 @item -mimpure-text
18396 @opindex mimpure-text
18397 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18398 the compiler to not pass @option{-z text} to the linker when linking a
18399 shared object. Using this option, you can link position-dependent
18400 code into a shared object.
18401
18402 @option{-mimpure-text} suppresses the ``relocations remain against
18403 allocatable but non-writable sections'' linker error message.
18404 However, the necessary relocations trigger copy-on-write, and the
18405 shared object is not actually shared across processes. Instead of
18406 using @option{-mimpure-text}, you should compile all source code with
18407 @option{-fpic} or @option{-fPIC}.
18408
18409 @end table
18410
18411 These switches are supported in addition to the above on Solaris 2:
18412
18413 @table @gcctabopt
18414 @item -pthreads
18415 @opindex pthreads
18416 Add support for multithreading using the POSIX threads library. This
18417 option sets flags for both the preprocessor and linker. This option does
18418 not affect the thread safety of object code produced by the compiler or
18419 that of libraries supplied with it.
18420
18421 @item -pthread
18422 @opindex pthread
18423 This is a synonym for @option{-pthreads}.
18424 @end table
18425
18426 @node SPARC Options
18427 @subsection SPARC Options
18428 @cindex SPARC options
18429
18430 These @samp{-m} options are supported on the SPARC:
18431
18432 @table @gcctabopt
18433 @item -mno-app-regs
18434 @itemx -mapp-regs
18435 @opindex mno-app-regs
18436 @opindex mapp-regs
18437 Specify @option{-mapp-regs} to generate output using the global registers
18438 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
18439 is the default.
18440
18441 To be fully SVR4 ABI compliant at the cost of some performance loss,
18442 specify @option{-mno-app-regs}. You should compile libraries and system
18443 software with this option.
18444
18445 @item -mflat
18446 @itemx -mno-flat
18447 @opindex mflat
18448 @opindex mno-flat
18449 With @option{-mflat}, the compiler does not generate save/restore instructions
18450 and uses a ``flat'' or single register window model. This model is compatible
18451 with the regular register window model. The local registers and the input
18452 registers (0--5) are still treated as ``call-saved'' registers and are
18453 saved on the stack as needed.
18454
18455 With @option{-mno-flat} (the default), the compiler generates save/restore
18456 instructions (except for leaf functions). This is the normal operating mode.
18457
18458 @item -mfpu
18459 @itemx -mhard-float
18460 @opindex mfpu
18461 @opindex mhard-float
18462 Generate output containing floating-point instructions. This is the
18463 default.
18464
18465 @item -mno-fpu
18466 @itemx -msoft-float
18467 @opindex mno-fpu
18468 @opindex msoft-float
18469 Generate output containing library calls for floating point.
18470 @strong{Warning:} the requisite libraries are not available for all SPARC
18471 targets. Normally the facilities of the machine's usual C compiler are
18472 used, but this cannot be done directly in cross-compilation. You must make
18473 your own arrangements to provide suitable library functions for
18474 cross-compilation. The embedded targets @samp{sparc-*-aout} and
18475 @samp{sparclite-*-*} do provide software floating-point support.
18476
18477 @option{-msoft-float} changes the calling convention in the output file;
18478 therefore, it is only useful if you compile @emph{all} of a program with
18479 this option. In particular, you need to compile @file{libgcc.a}, the
18480 library that comes with GCC, with @option{-msoft-float} in order for
18481 this to work.
18482
18483 @item -mhard-quad-float
18484 @opindex mhard-quad-float
18485 Generate output containing quad-word (long double) floating-point
18486 instructions.
18487
18488 @item -msoft-quad-float
18489 @opindex msoft-quad-float
18490 Generate output containing library calls for quad-word (long double)
18491 floating-point instructions. The functions called are those specified
18492 in the SPARC ABI@. This is the default.
18493
18494 As of this writing, there are no SPARC implementations that have hardware
18495 support for the quad-word floating-point instructions. They all invoke
18496 a trap handler for one of these instructions, and then the trap handler
18497 emulates the effect of the instruction. Because of the trap handler overhead,
18498 this is much slower than calling the ABI library routines. Thus the
18499 @option{-msoft-quad-float} option is the default.
18500
18501 @item -mno-unaligned-doubles
18502 @itemx -munaligned-doubles
18503 @opindex mno-unaligned-doubles
18504 @opindex munaligned-doubles
18505 Assume that doubles have 8-byte alignment. This is the default.
18506
18507 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18508 alignment only if they are contained in another type, or if they have an
18509 absolute address. Otherwise, it assumes they have 4-byte alignment.
18510 Specifying this option avoids some rare compatibility problems with code
18511 generated by other compilers. It is not the default because it results
18512 in a performance loss, especially for floating-point code.
18513
18514 @item -mno-faster-structs
18515 @itemx -mfaster-structs
18516 @opindex mno-faster-structs
18517 @opindex mfaster-structs
18518 With @option{-mfaster-structs}, the compiler assumes that structures
18519 should have 8-byte alignment. This enables the use of pairs of
18520 @code{ldd} and @code{std} instructions for copies in structure
18521 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18522 However, the use of this changed alignment directly violates the SPARC
18523 ABI@. Thus, it's intended only for use on targets where the developer
18524 acknowledges that their resulting code is not directly in line with
18525 the rules of the ABI@.
18526
18527 @item -mcpu=@var{cpu_type}
18528 @opindex mcpu
18529 Set the instruction set, register set, and instruction scheduling parameters
18530 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
18531 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18532 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18533 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18534 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18535 and @samp{niagara4}.
18536
18537 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18538 which selects the best architecture option for the host processor.
18539 @option{-mcpu=native} has no effect if GCC does not recognize
18540 the processor.
18541
18542 Default instruction scheduling parameters are used for values that select
18543 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
18544 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18545
18546 Here is a list of each supported architecture and their supported
18547 implementations.
18548
18549 @table @asis
18550 @item v7
18551 cypress
18552
18553 @item v8
18554 supersparc, hypersparc, leon
18555
18556 @item sparclite
18557 f930, f934, sparclite86x
18558
18559 @item sparclet
18560 tsc701
18561
18562 @item v9
18563 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18564 @end table
18565
18566 By default (unless configured otherwise), GCC generates code for the V7
18567 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
18568 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18569 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
18570 SPARCStation 1, 2, IPX etc.
18571
18572 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18573 architecture. The only difference from V7 code is that the compiler emits
18574 the integer multiply and integer divide instructions which exist in SPARC-V8
18575 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
18576 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18577 2000 series.
18578
18579 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18580 the SPARC architecture. This adds the integer multiply, integer divide step
18581 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18582 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18583 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
18584 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18585 MB86934 chip, which is the more recent SPARClite with FPU@.
18586
18587 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18588 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
18589 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18590 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
18591 optimizes it for the TEMIC SPARClet chip.
18592
18593 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18594 architecture. This adds 64-bit integer and floating-point move instructions,
18595 3 additional floating-point condition code registers and conditional move
18596 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
18597 optimizes it for the Sun UltraSPARC I/II/IIi chips. With
18598 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18599 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With
18600 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18601 Sun UltraSPARC T1 chips. With @option{-mcpu=niagara2}, the compiler
18602 additionally optimizes it for Sun UltraSPARC T2 chips. With
18603 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18604 UltraSPARC T3 chips. With @option{-mcpu=niagara4}, the compiler
18605 additionally optimizes it for Sun UltraSPARC T4 chips.
18606
18607 @item -mtune=@var{cpu_type}
18608 @opindex mtune
18609 Set the instruction scheduling parameters for machine type
18610 @var{cpu_type}, but do not set the instruction set or register set that the
18611 option @option{-mcpu=@var{cpu_type}} does.
18612
18613 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18614 @option{-mtune=@var{cpu_type}}, but the only useful values are those
18615 that select a particular CPU implementation. Those are @samp{cypress},
18616 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
18617 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
18618 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}. With
18619 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
18620
18621 @item -mv8plus
18622 @itemx -mno-v8plus
18623 @opindex mv8plus
18624 @opindex mno-v8plus
18625 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
18626 difference from the V8 ABI is that the global and out registers are
18627 considered 64 bits wide. This is enabled by default on Solaris in 32-bit
18628 mode for all SPARC-V9 processors.
18629
18630 @item -mvis
18631 @itemx -mno-vis
18632 @opindex mvis
18633 @opindex mno-vis
18634 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
18635 Visual Instruction Set extensions. The default is @option{-mno-vis}.
18636
18637 @item -mvis2
18638 @itemx -mno-vis2
18639 @opindex mvis2
18640 @opindex mno-vis2
18641 With @option{-mvis2}, GCC generates code that takes advantage of
18642 version 2.0 of the UltraSPARC Visual Instruction Set extensions. The
18643 default is @option{-mvis2} when targeting a cpu that supports such
18644 instructions, such as UltraSPARC-III and later. Setting @option{-mvis2}
18645 also sets @option{-mvis}.
18646
18647 @item -mvis3
18648 @itemx -mno-vis3
18649 @opindex mvis3
18650 @opindex mno-vis3
18651 With @option{-mvis3}, GCC generates code that takes advantage of
18652 version 3.0 of the UltraSPARC Visual Instruction Set extensions. The
18653 default is @option{-mvis3} when targeting a cpu that supports such
18654 instructions, such as niagara-3 and later. Setting @option{-mvis3}
18655 also sets @option{-mvis2} and @option{-mvis}.
18656
18657 @item -mpopc
18658 @itemx -mno-popc
18659 @opindex mpopc
18660 @opindex mno-popc
18661 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
18662 population count instruction. The default is @option{-mpopc}
18663 when targeting a cpu that supports such instructions, such as Niagara-2 and
18664 later.
18665
18666 @item -mfmaf
18667 @itemx -mno-fmaf
18668 @opindex mfmaf
18669 @opindex mno-fmaf
18670 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
18671 Fused Multiply-Add Floating-point extensions. The default is @option{-mfmaf}
18672 when targeting a cpu that supports such instructions, such as Niagara-3 and
18673 later.
18674
18675 @item -mfix-at697f
18676 @opindex mfix-at697f
18677 Enable the documented workaround for the single erratum of the Atmel AT697F
18678 processor (which corresponds to erratum #13 of the AT697E processor).
18679 @end table
18680
18681 These @samp{-m} options are supported in addition to the above
18682 on SPARC-V9 processors in 64-bit environments:
18683
18684 @table @gcctabopt
18685 @item -mlittle-endian
18686 @opindex mlittle-endian
18687 Generate code for a processor running in little-endian mode. It is only
18688 available for a few configurations and most notably not on Solaris and Linux.
18689
18690 @item -m32
18691 @itemx -m64
18692 @opindex m32
18693 @opindex m64
18694 Generate code for a 32-bit or 64-bit environment.
18695 The 32-bit environment sets int, long and pointer to 32 bits.
18696 The 64-bit environment sets int to 32 bits and long and pointer
18697 to 64 bits.
18698
18699 @item -mcmodel=@var{which}
18700 @opindex mcmodel
18701 Set the code model to one of
18702
18703 @table @samp
18704 @item medlow
18705 The Medium/Low code model: 64-bit addresses, programs
18706 must be linked in the low 32 bits of memory. Programs can be statically
18707 or dynamically linked.
18708
18709 @item medmid
18710 The Medium/Middle code model: 64-bit addresses, programs
18711 must be linked in the low 44 bits of memory, the text and data segments must
18712 be less than 2GB in size and the data segment must be located within 2GB of
18713 the text segment.
18714
18715 @item medany
18716 The Medium/Anywhere code model: 64-bit addresses, programs
18717 may be linked anywhere in memory, the text and data segments must be less
18718 than 2GB in size and the data segment must be located within 2GB of the
18719 text segment.
18720
18721 @item embmedany
18722 The Medium/Anywhere code model for embedded systems:
18723 64-bit addresses, the text and data segments must be less than 2GB in
18724 size, both starting anywhere in memory (determined at link time). The
18725 global register %g4 points to the base of the data segment. Programs
18726 are statically linked and PIC is not supported.
18727 @end table
18728
18729 @item -mmemory-model=@var{mem-model}
18730 @opindex mmemory-model
18731 Set the memory model in force on the processor to one of
18732
18733 @table @samp
18734 @item default
18735 The default memory model for the processor and operating system.
18736
18737 @item rmo
18738 Relaxed Memory Order
18739
18740 @item pso
18741 Partial Store Order
18742
18743 @item tso
18744 Total Store Order
18745
18746 @item sc
18747 Sequential Consistency
18748 @end table
18749
18750 These memory models are formally defined in Appendix D of the Sparc V9
18751 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18752
18753 @item -mstack-bias
18754 @itemx -mno-stack-bias
18755 @opindex mstack-bias
18756 @opindex mno-stack-bias
18757 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18758 frame pointer if present, are offset by @minus{}2047 which must be added back
18759 when making stack frame references. This is the default in 64-bit mode.
18760 Otherwise, assume no such offset is present.
18761 @end table
18762
18763 @node SPU Options
18764 @subsection SPU Options
18765 @cindex SPU options
18766
18767 These @samp{-m} options are supported on the SPU:
18768
18769 @table @gcctabopt
18770 @item -mwarn-reloc
18771 @itemx -merror-reloc
18772 @opindex mwarn-reloc
18773 @opindex merror-reloc
18774
18775 The loader for SPU does not handle dynamic relocations. By default, GCC
18776 gives an error when it generates code that requires a dynamic
18777 relocation. @option{-mno-error-reloc} disables the error,
18778 @option{-mwarn-reloc} generates a warning instead.
18779
18780 @item -msafe-dma
18781 @itemx -munsafe-dma
18782 @opindex msafe-dma
18783 @opindex munsafe-dma
18784
18785 Instructions that initiate or test completion of DMA must not be
18786 reordered with respect to loads and stores of the memory that is being
18787 accessed.
18788 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
18789 memory accesses, but that can lead to inefficient code in places where the
18790 memory is known to not change. Rather than mark the memory as volatile,
18791 you can use @option{-msafe-dma} to tell the compiler to treat
18792 the DMA instructions as potentially affecting all memory.
18793
18794 @item -mbranch-hints
18795 @opindex mbranch-hints
18796
18797 By default, GCC generates a branch hint instruction to avoid
18798 pipeline stalls for always-taken or probably-taken branches. A hint
18799 is not generated closer than 8 instructions away from its branch.
18800 There is little reason to disable them, except for debugging purposes,
18801 or to make an object a little bit smaller.
18802
18803 @item -msmall-mem
18804 @itemx -mlarge-mem
18805 @opindex msmall-mem
18806 @opindex mlarge-mem
18807
18808 By default, GCC generates code assuming that addresses are never larger
18809 than 18 bits. With @option{-mlarge-mem} code is generated that assumes
18810 a full 32-bit address.
18811
18812 @item -mstdmain
18813 @opindex mstdmain
18814
18815 By default, GCC links against startup code that assumes the SPU-style
18816 main function interface (which has an unconventional parameter list).
18817 With @option{-mstdmain}, GCC links your program against startup
18818 code that assumes a C99-style interface to @code{main}, including a
18819 local copy of @code{argv} strings.
18820
18821 @item -mfixed-range=@var{register-range}
18822 @opindex mfixed-range
18823 Generate code treating the given register range as fixed registers.
18824 A fixed register is one that the register allocator can not use. This is
18825 useful when compiling kernel code. A register range is specified as
18826 two registers separated by a dash. Multiple register ranges can be
18827 specified separated by a comma.
18828
18829 @item -mea32
18830 @itemx -mea64
18831 @opindex mea32
18832 @opindex mea64
18833 Compile code assuming that pointers to the PPU address space accessed
18834 via the @code{__ea} named address space qualifier are either 32 or 64
18835 bits wide. The default is 32 bits. As this is an ABI changing option,
18836 all object code in an executable must be compiled with the same setting.
18837
18838 @item -maddress-space-conversion
18839 @itemx -mno-address-space-conversion
18840 @opindex maddress-space-conversion
18841 @opindex mno-address-space-conversion
18842 Allow/disallow treating the @code{__ea} address space as superset
18843 of the generic address space. This enables explicit type casts
18844 between @code{__ea} and generic pointer as well as implicit
18845 conversions of generic pointers to @code{__ea} pointers. The
18846 default is to allow address space pointer conversions.
18847
18848 @item -mcache-size=@var{cache-size}
18849 @opindex mcache-size
18850 This option controls the version of libgcc that the compiler links to an
18851 executable and selects a software-managed cache for accessing variables
18852 in the @code{__ea} address space with a particular cache size. Possible
18853 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18854 and @samp{128}. The default cache size is 64KB.
18855
18856 @item -matomic-updates
18857 @itemx -mno-atomic-updates
18858 @opindex matomic-updates
18859 @opindex mno-atomic-updates
18860 This option controls the version of libgcc that the compiler links to an
18861 executable and selects whether atomic updates to the software-managed
18862 cache of PPU-side variables are used. If you use atomic updates, changes
18863 to a PPU variable from SPU code using the @code{__ea} named address space
18864 qualifier do not interfere with changes to other PPU variables residing
18865 in the same cache line from PPU code. If you do not use atomic updates,
18866 such interference may occur; however, writing back cache lines is
18867 more efficient. The default behavior is to use atomic updates.
18868
18869 @item -mdual-nops
18870 @itemx -mdual-nops=@var{n}
18871 @opindex mdual-nops
18872 By default, GCC inserts nops to increase dual issue when it expects
18873 it to increase performance. @var{n} can be a value from 0 to 10. A
18874 smaller @var{n} inserts fewer nops. 10 is the default, 0 is the
18875 same as @option{-mno-dual-nops}. Disabled with @option{-Os}.
18876
18877 @item -mhint-max-nops=@var{n}
18878 @opindex mhint-max-nops
18879 Maximum number of nops to insert for a branch hint. A branch hint must
18880 be at least 8 instructions away from the branch it is affecting. GCC
18881 inserts up to @var{n} nops to enforce this, otherwise it does not
18882 generate the branch hint.
18883
18884 @item -mhint-max-distance=@var{n}
18885 @opindex mhint-max-distance
18886 The encoding of the branch hint instruction limits the hint to be within
18887 256 instructions of the branch it is affecting. By default, GCC makes
18888 sure it is within 125.
18889
18890 @item -msafe-hints
18891 @opindex msafe-hints
18892 Work around a hardware bug that causes the SPU to stall indefinitely.
18893 By default, GCC inserts the @code{hbrp} instruction to make sure
18894 this stall won't happen.
18895
18896 @end table
18897
18898 @node System V Options
18899 @subsection Options for System V
18900
18901 These additional options are available on System V Release 4 for
18902 compatibility with other compilers on those systems:
18903
18904 @table @gcctabopt
18905 @item -G
18906 @opindex G
18907 Create a shared object.
18908 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18909
18910 @item -Qy
18911 @opindex Qy
18912 Identify the versions of each tool used by the compiler, in a
18913 @code{.ident} assembler directive in the output.
18914
18915 @item -Qn
18916 @opindex Qn
18917 Refrain from adding @code{.ident} directives to the output file (this is
18918 the default).
18919
18920 @item -YP,@var{dirs}
18921 @opindex YP
18922 Search the directories @var{dirs}, and no others, for libraries
18923 specified with @option{-l}.
18924
18925 @item -Ym,@var{dir}
18926 @opindex Ym
18927 Look in the directory @var{dir} to find the M4 preprocessor.
18928 The assembler uses this option.
18929 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18930 @c the generic assembler that comes with Solaris takes just -Ym.
18931 @end table
18932
18933 @node TILE-Gx Options
18934 @subsection TILE-Gx Options
18935 @cindex TILE-Gx options
18936
18937 These @samp{-m} options are supported on the TILE-Gx:
18938
18939 @table @gcctabopt
18940 @item -mcpu=@var{name}
18941 @opindex mcpu
18942 Selects the type of CPU to be targeted. Currently the only supported
18943 type is @samp{tilegx}.
18944
18945 @item -m32
18946 @itemx -m64
18947 @opindex m32
18948 @opindex m64
18949 Generate code for a 32-bit or 64-bit environment. The 32-bit
18950 environment sets int, long, and pointer to 32 bits. The 64-bit
18951 environment sets int to 32 bits and long and pointer to 64 bits.
18952 @end table
18953
18954 @node TILEPro Options
18955 @subsection TILEPro Options
18956 @cindex TILEPro options
18957
18958 These @samp{-m} options are supported on the TILEPro:
18959
18960 @table @gcctabopt
18961 @item -mcpu=@var{name}
18962 @opindex mcpu
18963 Selects the type of CPU to be targeted. Currently the only supported
18964 type is @samp{tilepro}.
18965
18966 @item -m32
18967 @opindex m32
18968 Generate code for a 32-bit environment, which sets int, long, and
18969 pointer to 32 bits. This is the only supported behavior so the flag
18970 is essentially ignored.
18971 @end table
18972
18973 @node V850 Options
18974 @subsection V850 Options
18975 @cindex V850 Options
18976
18977 These @samp{-m} options are defined for V850 implementations:
18978
18979 @table @gcctabopt
18980 @item -mlong-calls
18981 @itemx -mno-long-calls
18982 @opindex mlong-calls
18983 @opindex mno-long-calls
18984 Treat all calls as being far away (near). If calls are assumed to be
18985 far away, the compiler always loads the function's address into a
18986 register, and calls indirect through the pointer.
18987
18988 @item -mno-ep
18989 @itemx -mep
18990 @opindex mno-ep
18991 @opindex mep
18992 Do not optimize (do optimize) basic blocks that use the same index
18993 pointer 4 or more times to copy pointer into the @code{ep} register, and
18994 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
18995 option is on by default if you optimize.
18996
18997 @item -mno-prolog-function
18998 @itemx -mprolog-function
18999 @opindex mno-prolog-function
19000 @opindex mprolog-function
19001 Do not use (do use) external functions to save and restore registers
19002 at the prologue and epilogue of a function. The external functions
19003 are slower, but use less code space if more than one function saves
19004 the same number of registers. The @option{-mprolog-function} option
19005 is on by default if you optimize.
19006
19007 @item -mspace
19008 @opindex mspace
19009 Try to make the code as small as possible. At present, this just turns
19010 on the @option{-mep} and @option{-mprolog-function} options.
19011
19012 @item -mtda=@var{n}
19013 @opindex mtda
19014 Put static or global variables whose size is @var{n} bytes or less into
19015 the tiny data area that register @code{ep} points to. The tiny data
19016 area can hold up to 256 bytes in total (128 bytes for byte references).
19017
19018 @item -msda=@var{n}
19019 @opindex msda
19020 Put static or global variables whose size is @var{n} bytes or less into
19021 the small data area that register @code{gp} points to. The small data
19022 area can hold up to 64 kilobytes.
19023
19024 @item -mzda=@var{n}
19025 @opindex mzda
19026 Put static or global variables whose size is @var{n} bytes or less into
19027 the first 32 kilobytes of memory.
19028
19029 @item -mv850
19030 @opindex mv850
19031 Specify that the target processor is the V850.
19032
19033 @item -mbig-switch
19034 @opindex mbig-switch
19035 Generate code suitable for big switch tables. Use this option only if
19036 the assembler/linker complain about out of range branches within a switch
19037 table.
19038
19039 @item -mapp-regs
19040 @opindex mapp-regs
19041 This option causes r2 and r5 to be used in the code generated by
19042 the compiler. This setting is the default.
19043
19044 @item -mno-app-regs
19045 @opindex mno-app-regs
19046 This option causes r2 and r5 to be treated as fixed registers.
19047
19048 @item -mv850e2v3
19049 @opindex mv850e2v3
19050 Specify that the target processor is the V850E2V3. The preprocessor
19051 constant @samp{__v850e2v3__} is defined if
19052 this option is used.
19053
19054 @item -mv850e2
19055 @opindex mv850e2
19056 Specify that the target processor is the V850E2. The preprocessor
19057 constant @samp{__v850e2__} is defined if this option is used.
19058
19059 @item -mv850e1
19060 @opindex mv850e1
19061 Specify that the target processor is the V850E1. The preprocessor
19062 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19063 this option is used.
19064
19065 @item -mv850es
19066 @opindex mv850es
19067 Specify that the target processor is the V850ES. This is an alias for
19068 the @option{-mv850e1} option.
19069
19070 @item -mv850e
19071 @opindex mv850e
19072 Specify that the target processor is the V850E@. The preprocessor
19073 constant @samp{__v850e__} is defined if this option is used.
19074
19075 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19076 nor @option{-mv850e2} nor @option{-mv850e2v3}
19077 are defined then a default target processor is chosen and the
19078 relevant @samp{__v850*__} preprocessor constant is defined.
19079
19080 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19081 defined, regardless of which processor variant is the target.
19082
19083 @item -mdisable-callt
19084 @opindex mdisable-callt
19085 This option suppresses generation of the @code{CALLT} instruction for the
19086 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture. The default is
19087 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19088
19089 @end table
19090
19091 @node VAX Options
19092 @subsection VAX Options
19093 @cindex VAX options
19094
19095 These @samp{-m} options are defined for the VAX:
19096
19097 @table @gcctabopt
19098 @item -munix
19099 @opindex munix
19100 Do not output certain jump instructions (@code{aobleq} and so on)
19101 that the Unix assembler for the VAX cannot handle across long
19102 ranges.
19103
19104 @item -mgnu
19105 @opindex mgnu
19106 Do output those jump instructions, on the assumption that the
19107 GNU assembler is being used.
19108
19109 @item -mg
19110 @opindex mg
19111 Output code for G-format floating-point numbers instead of D-format.
19112 @end table
19113
19114 @node VMS Options
19115 @subsection VMS Options
19116
19117 These @samp{-m} options are defined for the VMS implementations:
19118
19119 @table @gcctabopt
19120 @item -mvms-return-codes
19121 @opindex mvms-return-codes
19122 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19123 condition (e.g.@ error) codes.
19124
19125 @item -mdebug-main=@var{prefix}
19126 @opindex mdebug-main=@var{prefix}
19127 Flag the first routine whose name starts with @var{prefix} as the main
19128 routine for the debugger.
19129
19130 @item -mmalloc64
19131 @opindex mmalloc64
19132 Default to 64-bit memory allocation routines.
19133
19134 @item -mpointer-size=@var{size}
19135 @opindex -mpointer-size=@var{size}
19136 Set the default size of pointers. Possible options for @var{size} are
19137 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19138 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19139 The later option disables @code{pragma pointer_size}.
19140 @end table
19141
19142 @node VxWorks Options
19143 @subsection VxWorks Options
19144 @cindex VxWorks Options
19145
19146 The options in this section are defined for all VxWorks targets.
19147 Options specific to the target hardware are listed with the other
19148 options for that target.
19149
19150 @table @gcctabopt
19151 @item -mrtp
19152 @opindex mrtp
19153 GCC can generate code for both VxWorks kernels and real time processes
19154 (RTPs). This option switches from the former to the latter. It also
19155 defines the preprocessor macro @code{__RTP__}.
19156
19157 @item -non-static
19158 @opindex non-static
19159 Link an RTP executable against shared libraries rather than static
19160 libraries. The options @option{-static} and @option{-shared} can
19161 also be used for RTPs (@pxref{Link Options}); @option{-static}
19162 is the default.
19163
19164 @item -Bstatic
19165 @itemx -Bdynamic
19166 @opindex Bstatic
19167 @opindex Bdynamic
19168 These options are passed down to the linker. They are defined for
19169 compatibility with Diab.
19170
19171 @item -Xbind-lazy
19172 @opindex Xbind-lazy
19173 Enable lazy binding of function calls. This option is equivalent to
19174 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19175
19176 @item -Xbind-now
19177 @opindex Xbind-now
19178 Disable lazy binding of function calls. This option is the default and
19179 is defined for compatibility with Diab.
19180 @end table
19181
19182 @node x86-64 Options
19183 @subsection x86-64 Options
19184 @cindex x86-64 options
19185
19186 These are listed under @xref{i386 and x86-64 Options}.
19187
19188 @node Xstormy16 Options
19189 @subsection Xstormy16 Options
19190 @cindex Xstormy16 Options
19191
19192 These options are defined for Xstormy16:
19193
19194 @table @gcctabopt
19195 @item -msim
19196 @opindex msim
19197 Choose startup files and linker script suitable for the simulator.
19198 @end table
19199
19200 @node Xtensa Options
19201 @subsection Xtensa Options
19202 @cindex Xtensa Options
19203
19204 These options are supported for Xtensa targets:
19205
19206 @table @gcctabopt
19207 @item -mconst16
19208 @itemx -mno-const16
19209 @opindex mconst16
19210 @opindex mno-const16
19211 Enable or disable use of @code{CONST16} instructions for loading
19212 constant values. The @code{CONST16} instruction is currently not a
19213 standard option from Tensilica. When enabled, @code{CONST16}
19214 instructions are always used in place of the standard @code{L32R}
19215 instructions. The use of @code{CONST16} is enabled by default only if
19216 the @code{L32R} instruction is not available.
19217
19218 @item -mfused-madd
19219 @itemx -mno-fused-madd
19220 @opindex mfused-madd
19221 @opindex mno-fused-madd
19222 Enable or disable use of fused multiply/add and multiply/subtract
19223 instructions in the floating-point option. This has no effect if the
19224 floating-point option is not also enabled. Disabling fused multiply/add
19225 and multiply/subtract instructions forces the compiler to use separate
19226 instructions for the multiply and add/subtract operations. This may be
19227 desirable in some cases where strict IEEE 754-compliant results are
19228 required: the fused multiply add/subtract instructions do not round the
19229 intermediate result, thereby producing results with @emph{more} bits of
19230 precision than specified by the IEEE standard. Disabling fused multiply
19231 add/subtract instructions also ensures that the program output is not
19232 sensitive to the compiler's ability to combine multiply and add/subtract
19233 operations.
19234
19235 @item -mserialize-volatile
19236 @itemx -mno-serialize-volatile
19237 @opindex mserialize-volatile
19238 @opindex mno-serialize-volatile
19239 When this option is enabled, GCC inserts @code{MEMW} instructions before
19240 @code{volatile} memory references to guarantee sequential consistency.
19241 The default is @option{-mserialize-volatile}. Use
19242 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19243
19244 @item -mforce-no-pic
19245 @opindex mforce-no-pic
19246 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19247 position-independent code (PIC), this option disables PIC for compiling
19248 kernel code.
19249
19250 @item -mtext-section-literals
19251 @itemx -mno-text-section-literals
19252 @opindex mtext-section-literals
19253 @opindex mno-text-section-literals
19254 Control the treatment of literal pools. The default is
19255 @option{-mno-text-section-literals}, which places literals in a separate
19256 section in the output file. This allows the literal pool to be placed
19257 in a data RAM/ROM, and it also allows the linker to combine literal
19258 pools from separate object files to remove redundant literals and
19259 improve code size. With @option{-mtext-section-literals}, the literals
19260 are interspersed in the text section in order to keep them as close as
19261 possible to their references. This may be necessary for large assembly
19262 files.
19263
19264 @item -mtarget-align
19265 @itemx -mno-target-align
19266 @opindex mtarget-align
19267 @opindex mno-target-align
19268 When this option is enabled, GCC instructs the assembler to
19269 automatically align instructions to reduce branch penalties at the
19270 expense of some code density. The assembler attempts to widen density
19271 instructions to align branch targets and the instructions following call
19272 instructions. If there are not enough preceding safe density
19273 instructions to align a target, no widening is performed. The
19274 default is @option{-mtarget-align}. These options do not affect the
19275 treatment of auto-aligned instructions like @code{LOOP}, which the
19276 assembler always aligns, either by widening density instructions or
19277 by inserting NOP instructions.
19278
19279 @item -mlongcalls
19280 @itemx -mno-longcalls
19281 @opindex mlongcalls
19282 @opindex mno-longcalls
19283 When this option is enabled, GCC instructs the assembler to translate
19284 direct calls to indirect calls unless it can determine that the target
19285 of a direct call is in the range allowed by the call instruction. This
19286 translation typically occurs for calls to functions in other source
19287 files. Specifically, the assembler translates a direct @code{CALL}
19288 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19289 The default is @option{-mno-longcalls}. This option should be used in
19290 programs where the call target can potentially be out of range. This
19291 option is implemented in the assembler, not the compiler, so the
19292 assembly code generated by GCC still shows direct call
19293 instructions---look at the disassembled object code to see the actual
19294 instructions. Note that the assembler uses an indirect call for
19295 every cross-file call, not just those that really are out of range.
19296 @end table
19297
19298 @node zSeries Options
19299 @subsection zSeries Options
19300 @cindex zSeries options
19301
19302 These are listed under @xref{S/390 and zSeries Options}.
19303
19304 @node Code Gen Options
19305 @section Options for Code Generation Conventions
19306 @cindex code generation conventions
19307 @cindex options, code generation
19308 @cindex run-time options
19309
19310 These machine-independent options control the interface conventions
19311 used in code generation.
19312
19313 Most of them have both positive and negative forms; the negative form
19314 of @option{-ffoo} is @option{-fno-foo}. In the table below, only
19315 one of the forms is listed---the one that is not the default. You
19316 can figure out the other form by either removing @samp{no-} or adding
19317 it.
19318
19319 @table @gcctabopt
19320 @item -fbounds-check
19321 @opindex fbounds-check
19322 For front ends that support it, generate additional code to check that
19323 indices used to access arrays are within the declared range. This is
19324 currently only supported by the Java and Fortran front ends, where
19325 this option defaults to true and false respectively.
19326
19327 @item -fstack-reuse=@var{reuse-level}
19328 @opindex fstack_reuse
19329 This option controls stack space reuse for user declared local/auto variables
19330 and compiler generated temporaries. @var{reuse_level} can be @samp{all},
19331 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
19332 local variables and temporaries, @samp{named_vars} enables the reuse only for
19333 user defined local variables with names, and @samp{none} disables stack reuse
19334 completely. The default value is @samp{all}. The option is needed when the
19335 program extends the lifetime of a scoped local variable or a compiler generated
19336 temporary beyond the end point defined by the language. When a lifetime of
19337 a variable ends, and if the variable lives in memory, the optimizing compiler
19338 has the freedom to reuse its stack space with other temporaries or scoped
19339 local variables whose live range does not overlap with it. Legacy code extending
19340 local lifetime will likely to break with the stack reuse optimization.
19341
19342 For example,
19343
19344 @smallexample
19345 int *p;
19346 @{
19347 int local1;
19348
19349 p = &local1;
19350 local1 = 10;
19351 ....
19352 @}
19353 @{
19354 int local2;
19355 local2 = 20;
19356 ...
19357 @}
19358
19359 if (*p == 10) // out of scope use of local1
19360 @{
19361
19362 @}
19363 @end smallexample
19364
19365 Another example:
19366 @smallexample
19367
19368 struct A
19369 @{
19370 A(int k) : i(k), j(k) @{ @}
19371 int i;
19372 int j;
19373 @};
19374
19375 A *ap;
19376
19377 void foo(const A& ar)
19378 @{
19379 ap = &ar;
19380 @}
19381
19382 void bar()
19383 @{
19384 foo(A(10)); // temp object's lifetime ends when foo returns
19385
19386 @{
19387 A a(20);
19388 ....
19389 @}
19390 ap->i+= 10; // ap references out of scope temp whose space
19391 // is reused with a. What is the value of ap->i?
19392 @}
19393
19394 @end smallexample
19395
19396 The lifetime of a compiler generated temporary is well defined by the C++
19397 standard. When a lifetime of a temporary ends, and if the temporary lives
19398 in memory, the optimizing compiler has the freedom to reuse its stack
19399 space with other temporaries or scoped local variables whose live range
19400 does not overlap with it. However some of the legacy code relies on
19401 the behavior of older compilers in which temporaries' stack space is
19402 not reused, the aggressive stack reuse can lead to runtime errors. This
19403 option is used to control the temporary stack reuse optimization.
19404
19405 @item -ftrapv
19406 @opindex ftrapv
19407 This option generates traps for signed overflow on addition, subtraction,
19408 multiplication operations.
19409
19410 @item -fwrapv
19411 @opindex fwrapv
19412 This option instructs the compiler to assume that signed arithmetic
19413 overflow of addition, subtraction and multiplication wraps around
19414 using twos-complement representation. This flag enables some optimizations
19415 and disables others. This option is enabled by default for the Java
19416 front end, as required by the Java language specification.
19417
19418 @item -fexceptions
19419 @opindex fexceptions
19420 Enable exception handling. Generates extra code needed to propagate
19421 exceptions. For some targets, this implies GCC generates frame
19422 unwind information for all functions, which can produce significant data
19423 size overhead, although it does not affect execution. If you do not
19424 specify this option, GCC enables it by default for languages like
19425 C++ that normally require exception handling, and disables it for
19426 languages like C that do not normally require it. However, you may need
19427 to enable this option when compiling C code that needs to interoperate
19428 properly with exception handlers written in C++. You may also wish to
19429 disable this option if you are compiling older C++ programs that don't
19430 use exception handling.
19431
19432 @item -fnon-call-exceptions
19433 @opindex fnon-call-exceptions
19434 Generate code that allows trapping instructions to throw exceptions.
19435 Note that this requires platform-specific runtime support that does
19436 not exist everywhere. Moreover, it only allows @emph{trapping}
19437 instructions to throw exceptions, i.e.@: memory references or floating-point
19438 instructions. It does not allow exceptions to be thrown from
19439 arbitrary signal handlers such as @code{SIGALRM}.
19440
19441 @item -fdelete-dead-exceptions
19442 @opindex fdelete-dead-exceptions
19443 Consider that instructions that may throw exceptions but don't otherwise
19444 contribute to the execution of the program can be optimized away.
19445 This option is enabled by default for the Ada front end, as permitted by
19446 the Ada language specification.
19447 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19448
19449 @item -funwind-tables
19450 @opindex funwind-tables
19451 Similar to @option{-fexceptions}, except that it just generates any needed
19452 static data, but does not affect the generated code in any other way.
19453 You normally do not need to enable this option; instead, a language processor
19454 that needs this handling enables it on your behalf.
19455
19456 @item -fasynchronous-unwind-tables
19457 @opindex fasynchronous-unwind-tables
19458 Generate unwind table in DWARF 2 format, if supported by target machine. The
19459 table is exact at each instruction boundary, so it can be used for stack
19460 unwinding from asynchronous events (such as debugger or garbage collector).
19461
19462 @item -fpcc-struct-return
19463 @opindex fpcc-struct-return
19464 Return ``short'' @code{struct} and @code{union} values in memory like
19465 longer ones, rather than in registers. This convention is less
19466 efficient, but it has the advantage of allowing intercallability between
19467 GCC-compiled files and files compiled with other compilers, particularly
19468 the Portable C Compiler (pcc).
19469
19470 The precise convention for returning structures in memory depends
19471 on the target configuration macros.
19472
19473 Short structures and unions are those whose size and alignment match
19474 that of some integer type.
19475
19476 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19477 switch is not binary compatible with code compiled with the
19478 @option{-freg-struct-return} switch.
19479 Use it to conform to a non-default application binary interface.
19480
19481 @item -freg-struct-return
19482 @opindex freg-struct-return
19483 Return @code{struct} and @code{union} values in registers when possible.
19484 This is more efficient for small structures than
19485 @option{-fpcc-struct-return}.
19486
19487 If you specify neither @option{-fpcc-struct-return} nor
19488 @option{-freg-struct-return}, GCC defaults to whichever convention is
19489 standard for the target. If there is no standard convention, GCC
19490 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19491 the principal compiler. In those cases, we can choose the standard, and
19492 we chose the more efficient register return alternative.
19493
19494 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19495 switch is not binary compatible with code compiled with the
19496 @option{-fpcc-struct-return} switch.
19497 Use it to conform to a non-default application binary interface.
19498
19499 @item -fshort-enums
19500 @opindex fshort-enums
19501 Allocate to an @code{enum} type only as many bytes as it needs for the
19502 declared range of possible values. Specifically, the @code{enum} type
19503 is equivalent to the smallest integer type that has enough room.
19504
19505 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19506 code that is not binary compatible with code generated without that switch.
19507 Use it to conform to a non-default application binary interface.
19508
19509 @item -fshort-double
19510 @opindex fshort-double
19511 Use the same size for @code{double} as for @code{float}.
19512
19513 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19514 code that is not binary compatible with code generated without that switch.
19515 Use it to conform to a non-default application binary interface.
19516
19517 @item -fshort-wchar
19518 @opindex fshort-wchar
19519 Override the underlying type for @samp{wchar_t} to be @samp{short
19520 unsigned int} instead of the default for the target. This option is
19521 useful for building programs to run under WINE@.
19522
19523 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19524 code that is not binary compatible with code generated without that switch.
19525 Use it to conform to a non-default application binary interface.
19526
19527 @item -fno-common
19528 @opindex fno-common
19529 In C code, controls the placement of uninitialized global variables.
19530 Unix C compilers have traditionally permitted multiple definitions of
19531 such variables in different compilation units by placing the variables
19532 in a common block.
19533 This is the behavior specified by @option{-fcommon}, and is the default
19534 for GCC on most targets.
19535 On the other hand, this behavior is not required by ISO C, and on some
19536 targets may carry a speed or code size penalty on variable references.
19537 The @option{-fno-common} option specifies that the compiler should place
19538 uninitialized global variables in the data section of the object file,
19539 rather than generating them as common blocks.
19540 This has the effect that if the same variable is declared
19541 (without @code{extern}) in two different compilations,
19542 you get a multiple-definition error when you link them.
19543 In this case, you must compile with @option{-fcommon} instead.
19544 Compiling with @option{-fno-common} is useful on targets for which
19545 it provides better performance, or if you wish to verify that the
19546 program will work on other systems that always treat uninitialized
19547 variable declarations this way.
19548
19549 @item -fno-ident
19550 @opindex fno-ident
19551 Ignore the @samp{#ident} directive.
19552
19553 @item -finhibit-size-directive
19554 @opindex finhibit-size-directive
19555 Don't output a @code{.size} assembler directive, or anything else that
19556 would cause trouble if the function is split in the middle, and the
19557 two halves are placed at locations far apart in memory. This option is
19558 used when compiling @file{crtstuff.c}; you should not need to use it
19559 for anything else.
19560
19561 @item -fverbose-asm
19562 @opindex fverbose-asm
19563 Put extra commentary information in the generated assembly code to
19564 make it more readable. This option is generally only of use to those
19565 who actually need to read the generated assembly code (perhaps while
19566 debugging the compiler itself).
19567
19568 @option{-fno-verbose-asm}, the default, causes the
19569 extra information to be omitted and is useful when comparing two assembler
19570 files.
19571
19572 @item -frecord-gcc-switches
19573 @opindex frecord-gcc-switches
19574 This switch causes the command line used to invoke the
19575 compiler to be recorded into the object file that is being created.
19576 This switch is only implemented on some targets and the exact format
19577 of the recording is target and binary file format dependent, but it
19578 usually takes the form of a section containing ASCII text. This
19579 switch is related to the @option{-fverbose-asm} switch, but that
19580 switch only records information in the assembler output file as
19581 comments, so it never reaches the object file.
19582 See also @option{-grecord-gcc-switches} for another
19583 way of storing compiler options into the object file.
19584
19585 @item -fpic
19586 @opindex fpic
19587 @cindex global offset table
19588 @cindex PIC
19589 Generate position-independent code (PIC) suitable for use in a shared
19590 library, if supported for the target machine. Such code accesses all
19591 constant addresses through a global offset table (GOT)@. The dynamic
19592 loader resolves the GOT entries when the program starts (the dynamic
19593 loader is not part of GCC; it is part of the operating system). If
19594 the GOT size for the linked executable exceeds a machine-specific
19595 maximum size, you get an error message from the linker indicating that
19596 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19597 instead. (These maximums are 8k on the SPARC and 32k
19598 on the m68k and RS/6000. The 386 has no such limit.)
19599
19600 Position-independent code requires special support, and therefore works
19601 only on certain machines. For the 386, GCC supports PIC for System V
19602 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
19603 position-independent.
19604
19605 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19606 are defined to 1.
19607
19608 @item -fPIC
19609 @opindex fPIC
19610 If supported for the target machine, emit position-independent code,
19611 suitable for dynamic linking and avoiding any limit on the size of the
19612 global offset table. This option makes a difference on the m68k,
19613 PowerPC and SPARC@.
19614
19615 Position-independent code requires special support, and therefore works
19616 only on certain machines.
19617
19618 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19619 are defined to 2.
19620
19621 @item -fpie
19622 @itemx -fPIE
19623 @opindex fpie
19624 @opindex fPIE
19625 These options are similar to @option{-fpic} and @option{-fPIC}, but
19626 generated position independent code can be only linked into executables.
19627 Usually these options are used when @option{-pie} GCC option is
19628 used during linking.
19629
19630 @option{-fpie} and @option{-fPIE} both define the macros
19631 @code{__pie__} and @code{__PIE__}. The macros have the value 1
19632 for @option{-fpie} and 2 for @option{-fPIE}.
19633
19634 @item -fno-jump-tables
19635 @opindex fno-jump-tables
19636 Do not use jump tables for switch statements even where it would be
19637 more efficient than other code generation strategies. This option is
19638 of use in conjunction with @option{-fpic} or @option{-fPIC} for
19639 building code that forms part of a dynamic linker and cannot
19640 reference the address of a jump table. On some targets, jump tables
19641 do not require a GOT and this option is not needed.
19642
19643 @item -ffixed-@var{reg}
19644 @opindex ffixed
19645 Treat the register named @var{reg} as a fixed register; generated code
19646 should never refer to it (except perhaps as a stack pointer, frame
19647 pointer or in some other fixed role).
19648
19649 @var{reg} must be the name of a register. The register names accepted
19650 are machine-specific and are defined in the @code{REGISTER_NAMES}
19651 macro in the machine description macro file.
19652
19653 This flag does not have a negative form, because it specifies a
19654 three-way choice.
19655
19656 @item -fcall-used-@var{reg}
19657 @opindex fcall-used
19658 Treat the register named @var{reg} as an allocable register that is
19659 clobbered by function calls. It may be allocated for temporaries or
19660 variables that do not live across a call. Functions compiled this way
19661 do not save and restore the register @var{reg}.
19662
19663 It is an error to use this flag with the frame pointer or stack pointer.
19664 Use of this flag for other registers that have fixed pervasive roles in
19665 the machine's execution model produces disastrous results.
19666
19667 This flag does not have a negative form, because it specifies a
19668 three-way choice.
19669
19670 @item -fcall-saved-@var{reg}
19671 @opindex fcall-saved
19672 Treat the register named @var{reg} as an allocable register saved by
19673 functions. It may be allocated even for temporaries or variables that
19674 live across a call. Functions compiled this way save and restore
19675 the register @var{reg} if they use it.
19676
19677 It is an error to use this flag with the frame pointer or stack pointer.
19678 Use of this flag for other registers that have fixed pervasive roles in
19679 the machine's execution model produces disastrous results.
19680
19681 A different sort of disaster results from the use of this flag for
19682 a register in which function values may be returned.
19683
19684 This flag does not have a negative form, because it specifies a
19685 three-way choice.
19686
19687 @item -fpack-struct[=@var{n}]
19688 @opindex fpack-struct
19689 Without a value specified, pack all structure members together without
19690 holes. When a value is specified (which must be a small power of two), pack
19691 structure members according to this value, representing the maximum
19692 alignment (that is, objects with default alignment requirements larger than
19693 this are output potentially unaligned at the next fitting location.
19694
19695 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
19696 code that is not binary compatible with code generated without that switch.
19697 Additionally, it makes the code suboptimal.
19698 Use it to conform to a non-default application binary interface.
19699
19700 @item -finstrument-functions
19701 @opindex finstrument-functions
19702 Generate instrumentation calls for entry and exit to functions. Just
19703 after function entry and just before function exit, the following
19704 profiling functions are called with the address of the current
19705 function and its call site. (On some platforms,
19706 @code{__builtin_return_address} does not work beyond the current
19707 function, so the call site information may not be available to the
19708 profiling functions otherwise.)
19709
19710 @smallexample
19711 void __cyg_profile_func_enter (void *this_fn,
19712 void *call_site);
19713 void __cyg_profile_func_exit (void *this_fn,
19714 void *call_site);
19715 @end smallexample
19716
19717 The first argument is the address of the start of the current function,
19718 which may be looked up exactly in the symbol table.
19719
19720 This instrumentation is also done for functions expanded inline in other
19721 functions. The profiling calls indicate where, conceptually, the
19722 inline function is entered and exited. This means that addressable
19723 versions of such functions must be available. If all your uses of a
19724 function are expanded inline, this may mean an additional expansion of
19725 code size. If you use @samp{extern inline} in your C code, an
19726 addressable version of such functions must be provided. (This is
19727 normally the case anyway, but if you get lucky and the optimizer always
19728 expands the functions inline, you might have gotten away without
19729 providing static copies.)
19730
19731 A function may be given the attribute @code{no_instrument_function}, in
19732 which case this instrumentation is not done. This can be used, for
19733 example, for the profiling functions listed above, high-priority
19734 interrupt routines, and any functions from which the profiling functions
19735 cannot safely be called (perhaps signal handlers, if the profiling
19736 routines generate output or allocate memory).
19737
19738 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
19739 @opindex finstrument-functions-exclude-file-list
19740
19741 Set the list of functions that are excluded from instrumentation (see
19742 the description of @code{-finstrument-functions}). If the file that
19743 contains a function definition matches with one of @var{file}, then
19744 that function is not instrumented. The match is done on substrings:
19745 if the @var{file} parameter is a substring of the file name, it is
19746 considered to be a match.
19747
19748 For example:
19749
19750 @smallexample
19751 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
19752 @end smallexample
19753
19754 @noindent
19755 excludes any inline function defined in files whose pathnames
19756 contain @code{/bits/stl} or @code{include/sys}.
19757
19758 If, for some reason, you want to include letter @code{','} in one of
19759 @var{sym}, write @code{'\,'}. For example,
19760 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
19761 (note the single quote surrounding the option).
19762
19763 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
19764 @opindex finstrument-functions-exclude-function-list
19765
19766 This is similar to @code{-finstrument-functions-exclude-file-list},
19767 but this option sets the list of function names to be excluded from
19768 instrumentation. The function name to be matched is its user-visible
19769 name, such as @code{vector<int> blah(const vector<int> &)}, not the
19770 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}). The
19771 match is done on substrings: if the @var{sym} parameter is a substring
19772 of the function name, it is considered to be a match. For C99 and C++
19773 extended identifiers, the function name must be given in UTF-8, not
19774 using universal character names.
19775
19776 @item -fstack-check
19777 @opindex fstack-check
19778 Generate code to verify that you do not go beyond the boundary of the
19779 stack. You should specify this flag if you are running in an
19780 environment with multiple threads, but only rarely need to specify it in
19781 a single-threaded environment since stack overflow is automatically
19782 detected on nearly all systems if there is only one stack.
19783
19784 Note that this switch does not actually cause checking to be done; the
19785 operating system or the language runtime must do that. The switch causes
19786 generation of code to ensure that they see the stack being extended.
19787
19788 You can additionally specify a string parameter: @code{no} means no
19789 checking, @code{generic} means force the use of old-style checking,
19790 @code{specific} means use the best checking method and is equivalent
19791 to bare @option{-fstack-check}.
19792
19793 Old-style checking is a generic mechanism that requires no specific
19794 target support in the compiler but comes with the following drawbacks:
19795
19796 @enumerate
19797 @item
19798 Modified allocation strategy for large objects: they are always
19799 allocated dynamically if their size exceeds a fixed threshold.
19800
19801 @item
19802 Fixed limit on the size of the static frame of functions: when it is
19803 topped by a particular function, stack checking is not reliable and
19804 a warning is issued by the compiler.
19805
19806 @item
19807 Inefficiency: because of both the modified allocation strategy and the
19808 generic implementation, the performances of the code are hampered.
19809 @end enumerate
19810
19811 Note that old-style stack checking is also the fallback method for
19812 @code{specific} if no target support has been added in the compiler.
19813
19814 @item -fstack-limit-register=@var{reg}
19815 @itemx -fstack-limit-symbol=@var{sym}
19816 @itemx -fno-stack-limit
19817 @opindex fstack-limit-register
19818 @opindex fstack-limit-symbol
19819 @opindex fno-stack-limit
19820 Generate code to ensure that the stack does not grow beyond a certain value,
19821 either the value of a register or the address of a symbol. If a larger
19822 stack is required, a signal is raised at run time. For most targets,
19823 the signal is raised before the stack overruns the boundary, so
19824 it is possible to catch the signal without taking special precautions.
19825
19826 For instance, if the stack starts at absolute address @samp{0x80000000}
19827 and grows downwards, you can use the flags
19828 @option{-fstack-limit-symbol=__stack_limit} and
19829 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
19830 of 128KB@. Note that this may only work with the GNU linker.
19831
19832 @item -fsplit-stack
19833 @opindex fsplit-stack
19834 Generate code to automatically split the stack before it overflows.
19835 The resulting program has a discontiguous stack which can only
19836 overflow if the program is unable to allocate any more memory. This
19837 is most useful when running threaded programs, as it is no longer
19838 necessary to calculate a good stack size to use for each thread. This
19839 is currently only implemented for the i386 and x86_64 back ends running
19840 GNU/Linux.
19841
19842 When code compiled with @option{-fsplit-stack} calls code compiled
19843 without @option{-fsplit-stack}, there may not be much stack space
19844 available for the latter code to run. If compiling all code,
19845 including library code, with @option{-fsplit-stack} is not an option,
19846 then the linker can fix up these calls so that the code compiled
19847 without @option{-fsplit-stack} always has a large stack. Support for
19848 this is implemented in the gold linker in GNU binutils release 2.21
19849 and later.
19850
19851 @item -fleading-underscore
19852 @opindex fleading-underscore
19853 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19854 change the way C symbols are represented in the object file. One use
19855 is to help link with legacy assembly code.
19856
19857 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19858 generate code that is not binary compatible with code generated without that
19859 switch. Use it to conform to a non-default application binary interface.
19860 Not all targets provide complete support for this switch.
19861
19862 @item -ftls-model=@var{model}
19863 @opindex ftls-model
19864 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19865 The @var{model} argument should be one of @code{global-dynamic},
19866 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19867
19868 The default without @option{-fpic} is @code{initial-exec}; with
19869 @option{-fpic} the default is @code{global-dynamic}.
19870
19871 @item -fvisibility=@var{default|internal|hidden|protected}
19872 @opindex fvisibility
19873 Set the default ELF image symbol visibility to the specified option---all
19874 symbols are marked with this unless overridden within the code.
19875 Using this feature can very substantially improve linking and
19876 load times of shared object libraries, produce more optimized
19877 code, provide near-perfect API export and prevent symbol clashes.
19878 It is @strong{strongly} recommended that you use this in any shared objects
19879 you distribute.
19880
19881 Despite the nomenclature, @code{default} always means public; i.e.,
19882 available to be linked against from outside the shared object.
19883 @code{protected} and @code{internal} are pretty useless in real-world
19884 usage so the only other commonly used option is @code{hidden}.
19885 The default if @option{-fvisibility} isn't specified is
19886 @code{default}, i.e., make every
19887 symbol public---this causes the same behavior as previous versions of
19888 GCC@.
19889
19890 A good explanation of the benefits offered by ensuring ELF
19891 symbols have the correct visibility is given by ``How To Write
19892 Shared Libraries'' by Ulrich Drepper (which can be found at
19893 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19894 solution made possible by this option to marking things hidden when
19895 the default is public is to make the default hidden and mark things
19896 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19897 and @code{__attribute__ ((visibility("default")))} instead of
19898 @code{__declspec(dllexport)} you get almost identical semantics with
19899 identical syntax. This is a great boon to those working with
19900 cross-platform projects.
19901
19902 For those adding visibility support to existing code, you may find
19903 @samp{#pragma GCC visibility} of use. This works by you enclosing
19904 the declarations you wish to set visibility for with (for example)
19905 @samp{#pragma GCC visibility push(hidden)} and
19906 @samp{#pragma GCC visibility pop}.
19907 Bear in mind that symbol visibility should be viewed @strong{as
19908 part of the API interface contract} and thus all new code should
19909 always specify visibility when it is not the default; i.e., declarations
19910 only for use within the local DSO should @strong{always} be marked explicitly
19911 as hidden as so to avoid PLT indirection overheads---making this
19912 abundantly clear also aids readability and self-documentation of the code.
19913 Note that due to ISO C++ specification requirements, @code{operator new} and
19914 @code{operator delete} must always be of default visibility.
19915
19916 Be aware that headers from outside your project, in particular system
19917 headers and headers from any other library you use, may not be
19918 expecting to be compiled with visibility other than the default. You
19919 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19920 before including any such headers.
19921
19922 @samp{extern} declarations are not affected by @option{-fvisibility}, so
19923 a lot of code can be recompiled with @option{-fvisibility=hidden} with
19924 no modifications. However, this means that calls to @code{extern}
19925 functions with no explicit visibility use the PLT, so it is more
19926 effective to use @code{__attribute ((visibility))} and/or
19927 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
19928 declarations should be treated as hidden.
19929
19930 Note that @option{-fvisibility} does affect C++ vague linkage
19931 entities. This means that, for instance, an exception class that is
19932 be thrown between DSOs must be explicitly marked with default
19933 visibility so that the @samp{type_info} nodes are unified between
19934 the DSOs.
19935
19936 An overview of these techniques, their benefits and how to use them
19937 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19938
19939 @item -fstrict-volatile-bitfields
19940 @opindex fstrict-volatile-bitfields
19941 This option should be used if accesses to volatile bit-fields (or other
19942 structure fields, although the compiler usually honors those types
19943 anyway) should use a single access of the width of the
19944 field's type, aligned to a natural alignment if possible. For
19945 example, targets with memory-mapped peripheral registers might require
19946 all such accesses to be 16 bits wide; with this flag the user could
19947 declare all peripheral bit-fields as @code{unsigned short} (assuming short
19948 is 16 bits on these targets) to force GCC to use 16-bit accesses
19949 instead of, perhaps, a more efficient 32-bit access.
19950
19951 If this option is disabled, the compiler uses the most efficient
19952 instruction. In the previous example, that might be a 32-bit load
19953 instruction, even though that accesses bytes that do not contain
19954 any portion of the bit-field, or memory-mapped registers unrelated to
19955 the one being updated.
19956
19957 If the target requires strict alignment, and honoring the field
19958 type would require violating this alignment, a warning is issued.
19959 If the field has @code{packed} attribute, the access is done without
19960 honoring the field type. If the field doesn't have @code{packed}
19961 attribute, the access is done honoring the field type. In both cases,
19962 GCC assumes that the user knows something about the target hardware
19963 that it is unaware of.
19964
19965 The default value of this option is determined by the application binary
19966 interface for the target processor.
19967
19968 @item -fsync-libcalls
19969 @opindex fsync-libcalls
19970 This option controls whether any out-of-line instance of the @code{__sync}
19971 family of functions may be used to implement the C++11 @code{__atomic}
19972 family of functions.
19973
19974 The default value of this option is enabled, thus the only useful form
19975 of the option is @option{-fno-sync-libcalls}. This option is used in
19976 the implementation of the @file{libatomic} runtime library.
19977
19978 @end table
19979
19980 @c man end
19981
19982 @node Environment Variables
19983 @section Environment Variables Affecting GCC
19984 @cindex environment variables
19985
19986 @c man begin ENVIRONMENT
19987 This section describes several environment variables that affect how GCC
19988 operates. Some of them work by specifying directories or prefixes to use
19989 when searching for various kinds of files. Some are used to specify other
19990 aspects of the compilation environment.
19991
19992 Note that you can also specify places to search using options such as
19993 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
19994 take precedence over places specified using environment variables, which
19995 in turn take precedence over those specified by the configuration of GCC@.
19996 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
19997 GNU Compiler Collection (GCC) Internals}.
19998
19999 @table @env
20000 @item LANG
20001 @itemx LC_CTYPE
20002 @c @itemx LC_COLLATE
20003 @itemx LC_MESSAGES
20004 @c @itemx LC_MONETARY
20005 @c @itemx LC_NUMERIC
20006 @c @itemx LC_TIME
20007 @itemx LC_ALL
20008 @findex LANG
20009 @findex LC_CTYPE
20010 @c @findex LC_COLLATE
20011 @findex LC_MESSAGES
20012 @c @findex LC_MONETARY
20013 @c @findex LC_NUMERIC
20014 @c @findex LC_TIME
20015 @findex LC_ALL
20016 @cindex locale
20017 These environment variables control the way that GCC uses
20018 localization information which allows GCC to work with different
20019 national conventions. GCC inspects the locale categories
20020 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20021 so. These locale categories can be set to any value supported by your
20022 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
20023 Kingdom encoded in UTF-8.
20024
20025 The @env{LC_CTYPE} environment variable specifies character
20026 classification. GCC uses it to determine the character boundaries in
20027 a string; this is needed for some multibyte encodings that contain quote
20028 and escape characters that are otherwise interpreted as a string
20029 end or escape.
20030
20031 The @env{LC_MESSAGES} environment variable specifies the language to
20032 use in diagnostic messages.
20033
20034 If the @env{LC_ALL} environment variable is set, it overrides the value
20035 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20036 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20037 environment variable. If none of these variables are set, GCC
20038 defaults to traditional C English behavior.
20039
20040 @item TMPDIR
20041 @findex TMPDIR
20042 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20043 files. GCC uses temporary files to hold the output of one stage of
20044 compilation which is to be used as input to the next stage: for example,
20045 the output of the preprocessor, which is the input to the compiler
20046 proper.
20047
20048 @item GCC_COMPARE_DEBUG
20049 @findex GCC_COMPARE_DEBUG
20050 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20051 @option{-fcompare-debug} to the compiler driver. See the documentation
20052 of this option for more details.
20053
20054 @item GCC_EXEC_PREFIX
20055 @findex GCC_EXEC_PREFIX
20056 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20057 names of the subprograms executed by the compiler. No slash is added
20058 when this prefix is combined with the name of a subprogram, but you can
20059 specify a prefix that ends with a slash if you wish.
20060
20061 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20062 an appropriate prefix to use based on the pathname it is invoked with.
20063
20064 If GCC cannot find the subprogram using the specified prefix, it
20065 tries looking in the usual places for the subprogram.
20066
20067 The default value of @env{GCC_EXEC_PREFIX} is
20068 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20069 the installed compiler. In many cases @var{prefix} is the value
20070 of @code{prefix} when you ran the @file{configure} script.
20071
20072 Other prefixes specified with @option{-B} take precedence over this prefix.
20073
20074 This prefix is also used for finding files such as @file{crt0.o} that are
20075 used for linking.
20076
20077 In addition, the prefix is used in an unusual way in finding the
20078 directories to search for header files. For each of the standard
20079 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20080 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20081 replacing that beginning with the specified prefix to produce an
20082 alternate directory name. Thus, with @option{-Bfoo/}, GCC searches
20083 @file{foo/bar} just before it searches the standard directory
20084 @file{/usr/local/lib/bar}.
20085 If a standard directory begins with the configured
20086 @var{prefix} then the value of @var{prefix} is replaced by
20087 @env{GCC_EXEC_PREFIX} when looking for header files.
20088
20089 @item COMPILER_PATH
20090 @findex COMPILER_PATH
20091 The value of @env{COMPILER_PATH} is a colon-separated list of
20092 directories, much like @env{PATH}. GCC tries the directories thus
20093 specified when searching for subprograms, if it can't find the
20094 subprograms using @env{GCC_EXEC_PREFIX}.
20095
20096 @item LIBRARY_PATH
20097 @findex LIBRARY_PATH
20098 The value of @env{LIBRARY_PATH} is a colon-separated list of
20099 directories, much like @env{PATH}. When configured as a native compiler,
20100 GCC tries the directories thus specified when searching for special
20101 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
20102 using GCC also uses these directories when searching for ordinary
20103 libraries for the @option{-l} option (but directories specified with
20104 @option{-L} come first).
20105
20106 @item LANG
20107 @findex LANG
20108 @cindex locale definition
20109 This variable is used to pass locale information to the compiler. One way in
20110 which this information is used is to determine the character set to be used
20111 when character literals, string literals and comments are parsed in C and C++.
20112 When the compiler is configured to allow multibyte characters,
20113 the following values for @env{LANG} are recognized:
20114
20115 @table @samp
20116 @item C-JIS
20117 Recognize JIS characters.
20118 @item C-SJIS
20119 Recognize SJIS characters.
20120 @item C-EUCJP
20121 Recognize EUCJP characters.
20122 @end table
20123
20124 If @env{LANG} is not defined, or if it has some other value, then the
20125 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20126 recognize and translate multibyte characters.
20127 @end table
20128
20129 @noindent
20130 Some additional environment variables affect the behavior of the
20131 preprocessor.
20132
20133 @include cppenv.texi
20134
20135 @c man end
20136
20137 @node Precompiled Headers
20138 @section Using Precompiled Headers
20139 @cindex precompiled headers
20140 @cindex speed of compilation
20141
20142 Often large projects have many header files that are included in every
20143 source file. The time the compiler takes to process these header files
20144 over and over again can account for nearly all of the time required to
20145 build the project. To make builds faster, GCC allows you to
20146 @dfn{precompile} a header file.
20147
20148 To create a precompiled header file, simply compile it as you would any
20149 other file, if necessary using the @option{-x} option to make the driver
20150 treat it as a C or C++ header file. You may want to use a
20151 tool like @command{make} to keep the precompiled header up-to-date when
20152 the headers it contains change.
20153
20154 A precompiled header file is searched for when @code{#include} is
20155 seen in the compilation. As it searches for the included file
20156 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20157 compiler looks for a precompiled header in each directory just before it
20158 looks for the include file in that directory. The name searched for is
20159 the name specified in the @code{#include} with @samp{.gch} appended. If
20160 the precompiled header file can't be used, it is ignored.
20161
20162 For instance, if you have @code{#include "all.h"}, and you have
20163 @file{all.h.gch} in the same directory as @file{all.h}, then the
20164 precompiled header file is used if possible, and the original
20165 header is used otherwise.
20166
20167 Alternatively, you might decide to put the precompiled header file in a
20168 directory and use @option{-I} to ensure that directory is searched
20169 before (or instead of) the directory containing the original header.
20170 Then, if you want to check that the precompiled header file is always
20171 used, you can put a file of the same name as the original header in this
20172 directory containing an @code{#error} command.
20173
20174 This also works with @option{-include}. So yet another way to use
20175 precompiled headers, good for projects not designed with precompiled
20176 header files in mind, is to simply take most of the header files used by
20177 a project, include them from another header file, precompile that header
20178 file, and @option{-include} the precompiled header. If the header files
20179 have guards against multiple inclusion, they are skipped because
20180 they've already been included (in the precompiled header).
20181
20182 If you need to precompile the same header file for different
20183 languages, targets, or compiler options, you can instead make a
20184 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20185 header in the directory, perhaps using @option{-o}. It doesn't matter
20186 what you call the files in the directory; every precompiled header in
20187 the directory is considered. The first precompiled header
20188 encountered in the directory that is valid for this compilation is
20189 used; they're searched in no particular order.
20190
20191 There are many other possibilities, limited only by your imagination,
20192 good sense, and the constraints of your build system.
20193
20194 A precompiled header file can be used only when these conditions apply:
20195
20196 @itemize
20197 @item
20198 Only one precompiled header can be used in a particular compilation.
20199
20200 @item
20201 A precompiled header can't be used once the first C token is seen. You
20202 can have preprocessor directives before a precompiled header; you cannot
20203 include a precompiled header from inside another header.
20204
20205 @item
20206 The precompiled header file must be produced for the same language as
20207 the current compilation. You can't use a C precompiled header for a C++
20208 compilation.
20209
20210 @item
20211 The precompiled header file must have been produced by the same compiler
20212 binary as the current compilation is using.
20213
20214 @item
20215 Any macros defined before the precompiled header is included must
20216 either be defined in the same way as when the precompiled header was
20217 generated, or must not affect the precompiled header, which usually
20218 means that they don't appear in the precompiled header at all.
20219
20220 The @option{-D} option is one way to define a macro before a
20221 precompiled header is included; using a @code{#define} can also do it.
20222 There are also some options that define macros implicitly, like
20223 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20224 defined this way.
20225
20226 @item If debugging information is output when using the precompiled
20227 header, using @option{-g} or similar, the same kind of debugging information
20228 must have been output when building the precompiled header. However,
20229 a precompiled header built using @option{-g} can be used in a compilation
20230 when no debugging information is being output.
20231
20232 @item The same @option{-m} options must generally be used when building
20233 and using the precompiled header. @xref{Submodel Options},
20234 for any cases where this rule is relaxed.
20235
20236 @item Each of the following options must be the same when building and using
20237 the precompiled header:
20238
20239 @gccoptlist{-fexceptions}
20240
20241 @item
20242 Some other command-line options starting with @option{-f},
20243 @option{-p}, or @option{-O} must be defined in the same way as when
20244 the precompiled header was generated. At present, it's not clear
20245 which options are safe to change and which are not; the safest choice
20246 is to use exactly the same options when generating and using the
20247 precompiled header. The following are known to be safe:
20248
20249 @gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock @gol
20250 -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous @gol
20251 -fsched-verbose=@var{number} -fschedule-insns -fvisibility= @gol
20252 -pedantic-errors}
20253
20254 @end itemize
20255
20256 For all of these except the last, the compiler automatically
20257 ignores the precompiled header if the conditions aren't met. If you
20258 find an option combination that doesn't work and doesn't cause the
20259 precompiled header to be ignored, please consider filing a bug report,
20260 see @ref{Bugs}.
20261
20262 If you do use differing options when generating and using the
20263 precompiled header, the actual behavior is a mixture of the
20264 behavior for the options. For instance, if you use @option{-g} to
20265 generate the precompiled header but not when using it, you may or may
20266 not get debugging information for routines in the precompiled header.