]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/doc/invoke.texi
Commit the vtable verification feature.
[thirdparty/gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988-2013 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
4
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
9
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2013 Free Software Foundation, Inc.
12
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below). A copy of the license is
19 included in the gfdl(7) man page.
20
21 (a) The FSF's Front-Cover Text is:
22
23 A GNU Manual
24
25 (b) The FSF's Back-Cover Text is:
26
27 You have freedom to copy and modify this GNU Manual, like GNU
28 software. Copies published by the Free Software Foundation raise
29 funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37 [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
42
43 Only the most useful options are listed here; see below for the
44 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
62
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
68
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking. The ``overall options'' allow you to stop this
72 process at an intermediate stage. For example, the @option{-c} option
73 says not to run the linker. Then the output consists of object files
74 output by the assembler.
75
76 Other options are passed on to one stage of processing. Some options
77 control the preprocessor and others the compiler itself. Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
80
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly. If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
87
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
91
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands. Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
98
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments. For the most part, the order
102 you use doesn't matter. Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified. Also,
105 the placement of the @option{-l} option is significant.
106
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on. Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}. This manual documents
112 only one of these two forms, whichever one is not the default.
113
114 @c man end
115
116 @xref{Option Index}, for an index to GCC's options.
117
118 @menu
119 * Option Summary:: Brief list of all options, without explanations.
120 * Overall Options:: Controlling the kind of output:
121 an executable, object files, assembler files,
122 or preprocessed source.
123 * Invoking G++:: Compiling C++ programs.
124 * C Dialect Options:: Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127 and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129 formatted.
130 * Warning Options:: How picky should the compiler be?
131 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
132 * Optimize Options:: How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134 Also, getting dependency information for Make.
135 * Assembler Options:: Passing options to the assembler.
136 * Link Options:: Specifying libraries and so on.
137 * Directory Options:: Where to find header files and libraries.
138 Where to find the compiler executable files.
139 * Spec Files:: How to pass switches to sub-processes.
140 * Target Options:: Running a cross-compiler, or an old version of GCC.
141 * Submodel Options:: Specifying minor hardware or convention variations,
142 such as 68010 vs 68020.
143 * Code Gen Options:: Specifying conventions for function calls, data layout
144 and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
148
149 @c man begin OPTIONS
150
151 @node Option Summary
152 @section Option Summary
153
154 Here is a summary of all the options, grouped by type. Explanations are
155 in the following sections.
156
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c -S -E -o @var{file} -no-canonical-prefixes @gol
161 -pipe -pass-exit-codes @gol
162 -x @var{language} -v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg} @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{arg} -fdump-go-spec=@var{file}}
165
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi -std=@var{standard} -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
171 -fhosted -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
172 -trigraphs -traditional -traditional-cpp @gol
173 -fallow-single-precision -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields -fsigned-char @gol
175 -funsigned-bitfields -funsigned-char}
176
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
180 -fconstexpr-depth=@var{n} -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines -fms-extensions @gol
187 -fno-nonansi-builtins -fnothrow-opt -fno-operator-names @gol
188 -fno-optional-diags -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo -fno-rtti -fstats -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
193 -fno-default-inline -fvisibility-inlines-hidden @gol
194 -fvtable-verify=@var{std|preinit|none} @gol
195 -fvtv-counts -fvtv-debug @gol
196 -fvisibility-ms-compat @gol
197 -fext-numeric-literals @gol
198 -Wabi -Wconversion-null -Wctor-dtor-privacy @gol
199 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
200 -Wnoexcept -Wnon-virtual-dtor -Wreorder @gol
201 -Weffc++ -Wstrict-null-sentinel @gol
202 -Wno-non-template-friend -Wold-style-cast @gol
203 -Woverloaded-virtual -Wno-pmf-conversions @gol
204 -Wsign-promo}
205
206 @item Objective-C and Objective-C++ Language Options
207 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
208 Objective-C and Objective-C++ Dialects}.
209 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
210 -fgnu-runtime -fnext-runtime @gol
211 -fno-nil-receivers @gol
212 -fobjc-abi-version=@var{n} @gol
213 -fobjc-call-cxx-cdtors @gol
214 -fobjc-direct-dispatch @gol
215 -fobjc-exceptions @gol
216 -fobjc-gc @gol
217 -fobjc-nilcheck @gol
218 -fobjc-std=objc1 @gol
219 -freplace-objc-classes @gol
220 -fzero-link @gol
221 -gen-decls @gol
222 -Wassign-intercept @gol
223 -Wno-protocol -Wselector @gol
224 -Wstrict-selector-match @gol
225 -Wundeclared-selector}
226
227 @item Language Independent Options
228 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
229 @gccoptlist{-fmessage-length=@var{n} @gol
230 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
231 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]} @gol
232 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
233
234 @item Warning Options
235 @xref{Warning Options,,Options to Request or Suppress Warnings}.
236 @gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic @gol
237 -pedantic-errors @gol
238 -w -Wextra -Wall -Waddress -Waggregate-return @gol
239 -Waggressive-loop-optimizations -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 -Wconditionally-supported @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 -Wno-return-local-addr @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 -fsanitize=@var{style} @gol
292 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
293 -fdisable-ipa-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass_name} @gol
295 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
296 -fdisable-tree-@var{pass_name} @gol
297 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
298 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
299 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
300 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
301 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
302 -fdump-passes @gol
303 -fdump-statistics @gol
304 -fdump-tree-all @gol
305 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-cfg -fdump-tree-alias @gol
308 -fdump-tree-ch @gol
309 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-nrv -fdump-tree-vect @gol
319 -fdump-tree-sink @gol
320 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-vtable-verify @gol
324 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
325 -ftree-vectorizer-verbose=@var{n} @gol
326 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
327 -fdump-final-insns=@var{file} @gol
328 -fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second @gol
329 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
330 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
331 -fenable-@var{kind}-@var{pass} @gol
332 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
333 -fdebug-types-section -fmem-report-wpa @gol
334 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
335 -fopt-info @gol
336 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
337 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
338 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
339 -fstack-usage -ftest-coverage -ftime-report -fvar-tracking @gol
340 -fvar-tracking-assignments -fvar-tracking-assignments-toggle @gol
341 -g -g@var{level} -gtoggle -gcoff -gdwarf-@var{version} @gol
342 -ggdb -grecord-gcc-switches -gno-record-gcc-switches @gol
343 -gstabs -gstabs+ -gstrict-dwarf -gno-strict-dwarf @gol
344 -gvms -gxcoff -gxcoff+ @gol
345 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
346 -fdebug-prefix-map=@var{old}=@var{new} @gol
347 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
348 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
349 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
350 -print-multi-directory -print-multi-lib -print-multi-os-directory @gol
351 -print-prog-name=@var{program} -print-search-dirs -Q @gol
352 -print-sysroot -print-sysroot-headers-suffix @gol
353 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
354
355 @item Optimization Options
356 @xref{Optimize Options,,Options that Control Optimization}.
357 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
358 -falign-jumps[=@var{n}] @gol
359 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
360 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
361 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
362 -fbtr-bb-exclusive -fcaller-saves @gol
363 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
364 -fcompare-elim -fcprop-registers -fcrossjumping @gol
365 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
366 -fcx-limited-range @gol
367 -fdata-sections -fdce -fdelayed-branch @gol
368 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
369 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
370 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
371 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
372 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
373 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
374 -fif-conversion2 -findirect-inlining @gol
375 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
376 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
377 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
378 -fira-algorithm=@var{algorithm} @gol
379 -fira-region=@var{region} -fira-hoist-pressure @gol
380 -fira-loop-pressure -fno-ira-share-save-slots @gol
381 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
382 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
383 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
384 -floop-parallelize-all -flto -flto-compression-level @gol
385 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
386 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
387 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
388 -fno-default-inline @gol
389 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
390 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
391 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
392 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
393 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
394 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
395 -fprefetch-loop-arrays -fprofile-report @gol
396 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
397 -fprofile-generate=@var{path} @gol
398 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
399 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
400 -freorder-blocks-and-partition -freorder-functions @gol
401 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
402 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
403 -fsched-spec-load -fsched-spec-load-dangerous @gol
404 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
405 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
406 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
407 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
408 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
409 -fselective-scheduling -fselective-scheduling2 @gol
410 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
411 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
412 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
413 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
414 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
415 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
416 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
417 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
418 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
419 -ftree-loop-if-convert-stores -ftree-loop-im @gol
420 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
421 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
422 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
423 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
424 -ftree-switch-conversion -ftree-tail-merge @gol
425 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
426 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
427 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
428 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
429 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
430 --param @var{name}=@var{value}
431 -O -O0 -O1 -O2 -O3 -Os -Ofast -Og}
432
433 @item Preprocessor Options
434 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
435 @gccoptlist{-A@var{question}=@var{answer} @gol
436 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
437 -C -dD -dI -dM -dN @gol
438 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
439 -idirafter @var{dir} @gol
440 -include @var{file} -imacros @var{file} @gol
441 -iprefix @var{file} -iwithprefix @var{dir} @gol
442 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
443 -imultilib @var{dir} -isysroot @var{dir} @gol
444 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
445 -P -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
446 -remap -trigraphs -undef -U@var{macro} @gol
447 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
448
449 @item Assembler Option
450 @xref{Assembler Options,,Passing Options to the Assembler}.
451 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
452
453 @item Linker Options
454 @xref{Link Options,,Options for Linking}.
455 @gccoptlist{@var{object-file-name} -l@var{library} @gol
456 -nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
457 -s -static -static-libgcc -static-libstdc++ @gol
458 -static-libasan -static-libtsan @gol
459 -shared -shared-libgcc -symbolic @gol
460 -T @var{script} -Wl,@var{option} -Xlinker @var{option} @gol
461 -u @var{symbol}}
462
463 @item Directory Options
464 @xref{Directory Options,,Options for Directory Search}.
465 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
466 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
467 --sysroot=@var{dir} --no-sysroot-suffix}
468
469 @item Machine Dependent Options
470 @xref{Submodel Options,,Hardware Models and Configurations}.
471 @c This list is ordered alphanumerically by subsection name.
472 @c Try and put the significant identifier (CPU or system) first,
473 @c so users have a clue at guessing where the ones they want will be.
474
475 @emph{AArch64 Options}
476 @gccoptlist{-mabi=@var{name} -mbig-endian -mlittle-endian @gol
477 -mgeneral-regs-only @gol
478 -mcmodel=tiny -mcmodel=small -mcmodel=large @gol
479 -mstrict-align @gol
480 -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
481 -mtls-dialect=desc -mtls-dialect=traditional @gol
482 -march=@var{name} -mcpu=@var{name} -mtune=@var{name}}
483
484 @emph{Adapteva Epiphany Options}
485 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
486 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
487 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
488 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
489 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
490 -msplit-vecmove-early -m1reg-@var{reg}}
491
492 @emph{ARM Options}
493 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
494 -mabi=@var{name} @gol
495 -mapcs-stack-check -mno-apcs-stack-check @gol
496 -mapcs-float -mno-apcs-float @gol
497 -mapcs-reentrant -mno-apcs-reentrant @gol
498 -msched-prolog -mno-sched-prolog @gol
499 -mlittle-endian -mbig-endian -mwords-little-endian @gol
500 -mfloat-abi=@var{name} @gol
501 -mfp16-format=@var{name}
502 -mthumb-interwork -mno-thumb-interwork @gol
503 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
504 -mstructure-size-boundary=@var{n} @gol
505 -mabort-on-noreturn @gol
506 -mlong-calls -mno-long-calls @gol
507 -msingle-pic-base -mno-single-pic-base @gol
508 -mpic-register=@var{reg} @gol
509 -mnop-fun-dllimport @gol
510 -mpoke-function-name @gol
511 -mthumb -marm @gol
512 -mtpcs-frame -mtpcs-leaf-frame @gol
513 -mcaller-super-interworking -mcallee-super-interworking @gol
514 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
515 -mword-relocations @gol
516 -mfix-cortex-m3-ldrd @gol
517 -munaligned-access @gol
518 -mneon-for-64bits @gol
519 -mrestrict-it}
520
521 @emph{AVR Options}
522 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
523 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
524 -mstrict-X -mtiny-stack -Waddr-space-convert}
525
526 @emph{Blackfin Options}
527 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
528 -msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
529 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
530 -mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
531 -mno-id-shared-library -mshared-library-id=@var{n} @gol
532 -mleaf-id-shared-library -mno-leaf-id-shared-library @gol
533 -msep-data -mno-sep-data -mlong-calls -mno-long-calls @gol
534 -mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram @gol
535 -micplb}
536
537 @emph{C6X Options}
538 @gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu} @gol
539 -msim -msdata=@var{sdata-type}}
540
541 @emph{CRIS Options}
542 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
543 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
544 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
545 -mstack-align -mdata-align -mconst-align @gol
546 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
547 -melf -maout -melinux -mlinux -sim -sim2 @gol
548 -mmul-bug-workaround -mno-mul-bug-workaround}
549
550 @emph{CR16 Options}
551 @gccoptlist{-mmac @gol
552 -mcr16cplus -mcr16c @gol
553 -msim -mint32 -mbit-ops
554 -mdata-model=@var{model}}
555
556 @emph{Darwin Options}
557 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
558 -arch_only -bind_at_load -bundle -bundle_loader @gol
559 -client_name -compatibility_version -current_version @gol
560 -dead_strip @gol
561 -dependency-file -dylib_file -dylinker_install_name @gol
562 -dynamic -dynamiclib -exported_symbols_list @gol
563 -filelist -flat_namespace -force_cpusubtype_ALL @gol
564 -force_flat_namespace -headerpad_max_install_names @gol
565 -iframework @gol
566 -image_base -init -install_name -keep_private_externs @gol
567 -multi_module -multiply_defined -multiply_defined_unused @gol
568 -noall_load -no_dead_strip_inits_and_terms @gol
569 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
570 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
571 -private_bundle -read_only_relocs -sectalign @gol
572 -sectobjectsymbols -whyload -seg1addr @gol
573 -sectcreate -sectobjectsymbols -sectorder @gol
574 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
575 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
576 -segprot -segs_read_only_addr -segs_read_write_addr @gol
577 -single_module -static -sub_library -sub_umbrella @gol
578 -twolevel_namespace -umbrella -undefined @gol
579 -unexported_symbols_list -weak_reference_mismatches @gol
580 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
581 -mkernel -mone-byte-bool}
582
583 @emph{DEC Alpha Options}
584 @gccoptlist{-mno-fp-regs -msoft-float @gol
585 -mieee -mieee-with-inexact -mieee-conformant @gol
586 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
587 -mtrap-precision=@var{mode} -mbuild-constants @gol
588 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
589 -mbwx -mmax -mfix -mcix @gol
590 -mfloat-vax -mfloat-ieee @gol
591 -mexplicit-relocs -msmall-data -mlarge-data @gol
592 -msmall-text -mlarge-text @gol
593 -mmemory-latency=@var{time}}
594
595 @emph{FR30 Options}
596 @gccoptlist{-msmall-model -mno-lsim}
597
598 @emph{FRV Options}
599 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
600 -mhard-float -msoft-float @gol
601 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
602 -mdouble -mno-double @gol
603 -mmedia -mno-media -mmuladd -mno-muladd @gol
604 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
605 -mlinked-fp -mlong-calls -malign-labels @gol
606 -mlibrary-pic -macc-4 -macc-8 @gol
607 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
608 -moptimize-membar -mno-optimize-membar @gol
609 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
610 -mvliw-branch -mno-vliw-branch @gol
611 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
612 -mno-nested-cond-exec -mtomcat-stats @gol
613 -mTLS -mtls @gol
614 -mcpu=@var{cpu}}
615
616 @emph{GNU/Linux Options}
617 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
618 -tno-android-cc -tno-android-ld}
619
620 @emph{H8/300 Options}
621 @gccoptlist{-mrelax -mh -ms -mn -mexr -mno-exr -mint32 -malign-300}
622
623 @emph{HPPA Options}
624 @gccoptlist{-march=@var{architecture-type} @gol
625 -mdisable-fpregs -mdisable-indexing @gol
626 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
627 -mfixed-range=@var{register-range} @gol
628 -mjump-in-delay -mlinker-opt -mlong-calls @gol
629 -mlong-load-store -mno-disable-fpregs @gol
630 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
631 -mno-jump-in-delay -mno-long-load-store @gol
632 -mno-portable-runtime -mno-soft-float @gol
633 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
634 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
635 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
636 -munix=@var{unix-std} -nolibdld -static -threads}
637
638 @emph{i386 and x86-64 Options}
639 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
640 -mfpmath=@var{unit} @gol
641 -masm=@var{dialect} -mno-fancy-math-387 @gol
642 -mno-fp-ret-in-387 -msoft-float @gol
643 -mno-wide-multiply -mrtd -malign-double @gol
644 -mpreferred-stack-boundary=@var{num} @gol
645 -mincoming-stack-boundary=@var{num} @gol
646 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
647 -mrecip -mrecip=@var{opt} @gol
648 -mvzeroupper -mprefer-avx128 @gol
649 -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
650 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
651 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
652 -mbmi2 -mrtm -mlwp -mthreads @gol
653 -mno-align-stringops -minline-all-stringops @gol
654 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
655 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
656 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
657 -mregparm=@var{num} -msseregparm @gol
658 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
659 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
660 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
661 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
662 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
663 -msse2avx -mfentry -m8bit-idiv @gol
664 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
665 -mstack-protector-guard=@var{guard}}
666
667 @emph{i386 and x86-64 Windows Options}
668 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
669 -mnop-fun-dllimport -mthread @gol
670 -municode -mwin32 -mwindows -fno-set-stack-executable}
671
672 @emph{IA-64 Options}
673 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
674 -mvolatile-asm-stop -mregister-names -msdata -mno-sdata @gol
675 -mconstant-gp -mauto-pic -mfused-madd @gol
676 -minline-float-divide-min-latency @gol
677 -minline-float-divide-max-throughput @gol
678 -mno-inline-float-divide @gol
679 -minline-int-divide-min-latency @gol
680 -minline-int-divide-max-throughput @gol
681 -mno-inline-int-divide @gol
682 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
683 -mno-inline-sqrt @gol
684 -mdwarf2-asm -mearly-stop-bits @gol
685 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
686 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
687 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
688 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
689 -msched-spec-ldc -msched-spec-control-ldc @gol
690 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
691 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
692 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
693 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
694
695 @emph{LM32 Options}
696 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
697 -msign-extend-enabled -muser-enabled}
698
699 @emph{M32R/D Options}
700 @gccoptlist{-m32r2 -m32rx -m32r @gol
701 -mdebug @gol
702 -malign-loops -mno-align-loops @gol
703 -missue-rate=@var{number} @gol
704 -mbranch-cost=@var{number} @gol
705 -mmodel=@var{code-size-model-type} @gol
706 -msdata=@var{sdata-type} @gol
707 -mno-flush-func -mflush-func=@var{name} @gol
708 -mno-flush-trap -mflush-trap=@var{number} @gol
709 -G @var{num}}
710
711 @emph{M32C Options}
712 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
713
714 @emph{M680x0 Options}
715 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune}
716 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
717 -m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
718 -mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020 @gol
719 -mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort @gol
720 -mno-short -mhard-float -m68881 -msoft-float -mpcrel @gol
721 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
722 -mshared-library-id=n -mid-shared-library -mno-id-shared-library @gol
723 -mxgot -mno-xgot}
724
725 @emph{MCore Options}
726 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
727 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
728 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
729 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
730 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
731
732 @emph{MeP Options}
733 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
734 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
735 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
736 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
737 -mtiny=@var{n}}
738
739 @emph{MicroBlaze Options}
740 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
741 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
742 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
743 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
744 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
745
746 @emph{MIPS Options}
747 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
748 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 @gol
749 -mips64 -mips64r2 @gol
750 -mips16 -mno-mips16 -mflip-mips16 @gol
751 -minterlink-compressed -mno-interlink-compressed @gol
752 -minterlink-mips16 -mno-interlink-mips16 @gol
753 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
754 -mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot @gol
755 -mgp32 -mgp64 -mfp32 -mfp64 -mhard-float -msoft-float @gol
756 -mno-float -msingle-float -mdouble-float @gol
757 -mabs=@var{mode} -mnan=@var{encoding} @gol
758 -mdsp -mno-dsp -mdspr2 -mno-dspr2 @gol
759 -mmcu -mmno-mcu @gol
760 -meva -mno-eva @gol
761 -mmicromips -mno-micromips @gol
762 -mfpu=@var{fpu-type} @gol
763 -msmartmips -mno-smartmips @gol
764 -mpaired-single -mno-paired-single -mdmx -mno-mdmx @gol
765 -mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc @gol
766 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
767 -G@var{num} -mlocal-sdata -mno-local-sdata @gol
768 -mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt @gol
769 -membedded-data -mno-embedded-data @gol
770 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
771 -mcode-readable=@var{setting} @gol
772 -msplit-addresses -mno-split-addresses @gol
773 -mexplicit-relocs -mno-explicit-relocs @gol
774 -mcheck-zero-division -mno-check-zero-division @gol
775 -mdivide-traps -mdivide-breaks @gol
776 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
777 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd -mno-fused-madd -nocpp @gol
778 -mfix-24k -mno-fix-24k @gol
779 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
780 -mfix-r10000 -mno-fix-r10000 -mfix-vr4120 -mno-fix-vr4120 @gol
781 -mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1 @gol
782 -mflush-func=@var{func} -mno-flush-func @gol
783 -mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely @gol
784 -mfp-exceptions -mno-fp-exceptions @gol
785 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
786 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
787
788 @emph{MMIX Options}
789 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
790 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
791 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
792 -mno-base-addresses -msingle-exit -mno-single-exit}
793
794 @emph{MN10300 Options}
795 @gccoptlist{-mmult-bug -mno-mult-bug @gol
796 -mno-am33 -mam33 -mam33-2 -mam34 @gol
797 -mtune=@var{cpu-type} @gol
798 -mreturn-pointer-on-d0 @gol
799 -mno-crt0 -mrelax -mliw -msetlb}
800
801 @emph{Moxie Options}
802 @gccoptlist{-meb -mel -mno-crt0}
803
804 @emph{PDP-11 Options}
805 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
806 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
807 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
808 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
809 -mbranch-expensive -mbranch-cheap @gol
810 -munix-asm -mdec-asm}
811
812 @emph{picoChip Options}
813 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
814 -msymbol-as-address -mno-inefficient-warnings}
815
816 @emph{PowerPC Options}
817 See RS/6000 and PowerPC Options.
818
819 @emph{RL78 Options}
820 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
821
822 @emph{RS/6000 and PowerPC Options}
823 @gccoptlist{-mcpu=@var{cpu-type} @gol
824 -mtune=@var{cpu-type} @gol
825 -mcmodel=@var{code-model} @gol
826 -mpowerpc64 @gol
827 -maltivec -mno-altivec @gol
828 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
829 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
830 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd @gol
831 -mfprnd -mno-fprnd @gol
832 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
833 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
834 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
835 -malign-power -malign-natural @gol
836 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
837 -msingle-float -mdouble-float -msimple-fpu @gol
838 -mstring -mno-string -mupdate -mno-update @gol
839 -mavoid-indexed-addresses -mno-avoid-indexed-addresses @gol
840 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
841 -mstrict-align -mno-strict-align -mrelocatable @gol
842 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
843 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
844 -mdynamic-no-pic -maltivec -mswdiv -msingle-pic-base @gol
845 -mprioritize-restricted-insns=@var{priority} @gol
846 -msched-costly-dep=@var{dependence_type} @gol
847 -minsert-sched-nops=@var{scheme} @gol
848 -mcall-sysv -mcall-netbsd @gol
849 -maix-struct-return -msvr4-struct-return @gol
850 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
851 -mblock-move-inline-limit=@var{num} @gol
852 -misel -mno-isel @gol
853 -misel=yes -misel=no @gol
854 -mspe -mno-spe @gol
855 -mspe=yes -mspe=no @gol
856 -mpaired @gol
857 -mgen-cell-microcode -mwarn-cell-microcode @gol
858 -mvrsave -mno-vrsave @gol
859 -mmulhw -mno-mulhw @gol
860 -mdlmzb -mno-dlmzb @gol
861 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
862 -mprototype -mno-prototype @gol
863 -msim -mmvme -mads -myellowknife -memb -msdata @gol
864 -msdata=@var{opt} -mvxworks -G @var{num} -pthread @gol
865 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
866 -mno-recip-precision @gol
867 -mveclibabi=@var{type} -mfriz -mno-friz @gol
868 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
869 -msave-toc-indirect -mno-save-toc-indirect @gol
870 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
871 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
872 -mquad-memory -mno-quad-memory}
873
874 @emph{RX Options}
875 @gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu@gol
876 -mcpu=@gol
877 -mbig-endian-data -mlittle-endian-data @gol
878 -msmall-data @gol
879 -msim -mno-sim@gol
880 -mas100-syntax -mno-as100-syntax@gol
881 -mrelax@gol
882 -mmax-constant-size=@gol
883 -mint-register=@gol
884 -mpid@gol
885 -mno-warn-multiple-fast-interrupts@gol
886 -msave-acc-in-interrupts}
887
888 @emph{S/390 and zSeries Options}
889 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
890 -mhard-float -msoft-float -mhard-dfp -mno-hard-dfp @gol
891 -mlong-double-64 -mlong-double-128 @gol
892 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
893 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
894 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
895 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
896 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
897
898 @emph{Score Options}
899 @gccoptlist{-meb -mel @gol
900 -mnhwloop @gol
901 -muls @gol
902 -mmac @gol
903 -mscore5 -mscore5u -mscore7 -mscore7d}
904
905 @emph{SH Options}
906 @gccoptlist{-m1 -m2 -m2e @gol
907 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
908 -m3 -m3e @gol
909 -m4-nofpu -m4-single-only -m4-single -m4 @gol
910 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
911 -m5-64media -m5-64media-nofpu @gol
912 -m5-32media -m5-32media-nofpu @gol
913 -m5-compact -m5-compact-nofpu @gol
914 -mb -ml -mdalign -mrelax @gol
915 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
916 -mieee -mno-ieee -mbitops -misize -minline-ic_invalidate -mpadstruct @gol
917 -mspace -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
918 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
919 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
920 -maccumulate-outgoing-args -minvalid-symbols @gol
921 -matomic-model=@var{atomic-model} @gol
922 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
923 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
924 -mpretend-cmove -mtas}
925
926 @emph{Solaris 2 Options}
927 @gccoptlist{-mimpure-text -mno-impure-text @gol
928 -pthreads -pthread}
929
930 @emph{SPARC Options}
931 @gccoptlist{-mcpu=@var{cpu-type} @gol
932 -mtune=@var{cpu-type} @gol
933 -mcmodel=@var{code-model} @gol
934 -mmemory-model=@var{mem-model} @gol
935 -m32 -m64 -mapp-regs -mno-app-regs @gol
936 -mfaster-structs -mno-faster-structs -mflat -mno-flat @gol
937 -mfpu -mno-fpu -mhard-float -msoft-float @gol
938 -mhard-quad-float -msoft-quad-float @gol
939 -mstack-bias -mno-stack-bias @gol
940 -munaligned-doubles -mno-unaligned-doubles @gol
941 -mv8plus -mno-v8plus -mvis -mno-vis @gol
942 -mvis2 -mno-vis2 -mvis3 -mno-vis3 @gol
943 -mcbcond -mno-cbcond @gol
944 -mfmaf -mno-fmaf -mpopc -mno-popc @gol
945 -mfix-at697f -mfix-ut699}
946
947 @emph{SPU Options}
948 @gccoptlist{-mwarn-reloc -merror-reloc @gol
949 -msafe-dma -munsafe-dma @gol
950 -mbranch-hints @gol
951 -msmall-mem -mlarge-mem -mstdmain @gol
952 -mfixed-range=@var{register-range} @gol
953 -mea32 -mea64 @gol
954 -maddress-space-conversion -mno-address-space-conversion @gol
955 -mcache-size=@var{cache-size} @gol
956 -matomic-updates -mno-atomic-updates}
957
958 @emph{System V Options}
959 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
960
961 @emph{TILE-Gx Options}
962 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
963
964 @emph{TILEPro Options}
965 @gccoptlist{-mcpu=@var{cpu} -m32}
966
967 @emph{V850 Options}
968 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
969 -mprolog-function -mno-prolog-function -mspace @gol
970 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
971 -mapp-regs -mno-app-regs @gol
972 -mdisable-callt -mno-disable-callt @gol
973 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
974 -mv850e -mv850 -mv850e3v5 @gol
975 -mloop @gol
976 -mrelax @gol
977 -mlong-jumps @gol
978 -msoft-float @gol
979 -mhard-float @gol
980 -mgcc-abi @gol
981 -mrh850-abi @gol
982 -mbig-switch}
983
984 @emph{VAX Options}
985 @gccoptlist{-mg -mgnu -munix}
986
987 @emph{VMS Options}
988 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
989 -mpointer-size=@var{size}}
990
991 @emph{VxWorks Options}
992 @gccoptlist{-mrtp -non-static -Bstatic -Bdynamic @gol
993 -Xbind-lazy -Xbind-now}
994
995 @emph{x86-64 Options}
996 See i386 and x86-64 Options.
997
998 @emph{Xstormy16 Options}
999 @gccoptlist{-msim}
1000
1001 @emph{Xtensa Options}
1002 @gccoptlist{-mconst16 -mno-const16 @gol
1003 -mfused-madd -mno-fused-madd @gol
1004 -mforce-no-pic @gol
1005 -mserialize-volatile -mno-serialize-volatile @gol
1006 -mtext-section-literals -mno-text-section-literals @gol
1007 -mtarget-align -mno-target-align @gol
1008 -mlongcalls -mno-longcalls}
1009
1010 @emph{zSeries Options}
1011 See S/390 and zSeries Options.
1012
1013 @item Code Generation Options
1014 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1015 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
1016 -ffixed-@var{reg} -fexceptions @gol
1017 -fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables @gol
1018 -fasynchronous-unwind-tables @gol
1019 -finhibit-size-directive -finstrument-functions @gol
1020 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1021 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1022 -fno-common -fno-ident @gol
1023 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
1024 -fno-jump-tables @gol
1025 -frecord-gcc-switches @gol
1026 -freg-struct-return -fshort-enums @gol
1027 -fshort-double -fshort-wchar @gol
1028 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
1029 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
1030 -fno-stack-limit -fsplit-stack @gol
1031 -fleading-underscore -ftls-model=@var{model} @gol
1032 -fstack-reuse=@var{reuse_level} @gol
1033 -ftrapv -fwrapv -fbounds-check @gol
1034 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1035 @end table
1036
1037 @menu
1038 * Overall Options:: Controlling the kind of output:
1039 an executable, object files, assembler files,
1040 or preprocessed source.
1041 * C Dialect Options:: Controlling the variant of C language compiled.
1042 * C++ Dialect Options:: Variations on C++.
1043 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1044 and Objective-C++.
1045 * Language Independent Options:: Controlling how diagnostics should be
1046 formatted.
1047 * Warning Options:: How picky should the compiler be?
1048 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
1049 * Optimize Options:: How much optimization?
1050 * Preprocessor Options:: Controlling header files and macro definitions.
1051 Also, getting dependency information for Make.
1052 * Assembler Options:: Passing options to the assembler.
1053 * Link Options:: Specifying libraries and so on.
1054 * Directory Options:: Where to find header files and libraries.
1055 Where to find the compiler executable files.
1056 * Spec Files:: How to pass switches to sub-processes.
1057 * Target Options:: Running a cross-compiler, or an old version of GCC.
1058 @end menu
1059
1060 @node Overall Options
1061 @section Options Controlling the Kind of Output
1062
1063 Compilation can involve up to four stages: preprocessing, compilation
1064 proper, assembly and linking, always in that order. GCC is capable of
1065 preprocessing and compiling several files either into several
1066 assembler input files, or into one assembler input file; then each
1067 assembler input file produces an object file, and linking combines all
1068 the object files (those newly compiled, and those specified as input)
1069 into an executable file.
1070
1071 @cindex file name suffix
1072 For any given input file, the file name suffix determines what kind of
1073 compilation is done:
1074
1075 @table @gcctabopt
1076 @item @var{file}.c
1077 C source code that must be preprocessed.
1078
1079 @item @var{file}.i
1080 C source code that should not be preprocessed.
1081
1082 @item @var{file}.ii
1083 C++ source code that should not be preprocessed.
1084
1085 @item @var{file}.m
1086 Objective-C source code. Note that you must link with the @file{libobjc}
1087 library to make an Objective-C program work.
1088
1089 @item @var{file}.mi
1090 Objective-C source code that should not be preprocessed.
1091
1092 @item @var{file}.mm
1093 @itemx @var{file}.M
1094 Objective-C++ source code. Note that you must link with the @file{libobjc}
1095 library to make an Objective-C++ program work. Note that @samp{.M} refers
1096 to a literal capital M@.
1097
1098 @item @var{file}.mii
1099 Objective-C++ source code that should not be preprocessed.
1100
1101 @item @var{file}.h
1102 C, C++, Objective-C or Objective-C++ header file to be turned into a
1103 precompiled header (default), or C, C++ header file to be turned into an
1104 Ada spec (via the @option{-fdump-ada-spec} switch).
1105
1106 @item @var{file}.cc
1107 @itemx @var{file}.cp
1108 @itemx @var{file}.cxx
1109 @itemx @var{file}.cpp
1110 @itemx @var{file}.CPP
1111 @itemx @var{file}.c++
1112 @itemx @var{file}.C
1113 C++ source code that must be preprocessed. Note that in @samp{.cxx},
1114 the last two letters must both be literally @samp{x}. Likewise,
1115 @samp{.C} refers to a literal capital C@.
1116
1117 @item @var{file}.mm
1118 @itemx @var{file}.M
1119 Objective-C++ source code that must be preprocessed.
1120
1121 @item @var{file}.mii
1122 Objective-C++ source code that should not be preprocessed.
1123
1124 @item @var{file}.hh
1125 @itemx @var{file}.H
1126 @itemx @var{file}.hp
1127 @itemx @var{file}.hxx
1128 @itemx @var{file}.hpp
1129 @itemx @var{file}.HPP
1130 @itemx @var{file}.h++
1131 @itemx @var{file}.tcc
1132 C++ header file to be turned into a precompiled header or Ada spec.
1133
1134 @item @var{file}.f
1135 @itemx @var{file}.for
1136 @itemx @var{file}.ftn
1137 Fixed form Fortran source code that should not be preprocessed.
1138
1139 @item @var{file}.F
1140 @itemx @var{file}.FOR
1141 @itemx @var{file}.fpp
1142 @itemx @var{file}.FPP
1143 @itemx @var{file}.FTN
1144 Fixed form Fortran source code that must be preprocessed (with the traditional
1145 preprocessor).
1146
1147 @item @var{file}.f90
1148 @itemx @var{file}.f95
1149 @itemx @var{file}.f03
1150 @itemx @var{file}.f08
1151 Free form Fortran source code that should not be preprocessed.
1152
1153 @item @var{file}.F90
1154 @itemx @var{file}.F95
1155 @itemx @var{file}.F03
1156 @itemx @var{file}.F08
1157 Free form Fortran source code that must be preprocessed (with the
1158 traditional preprocessor).
1159
1160 @item @var{file}.go
1161 Go source code.
1162
1163 @c FIXME: Descriptions of Java file types.
1164 @c @var{file}.java
1165 @c @var{file}.class
1166 @c @var{file}.zip
1167 @c @var{file}.jar
1168
1169 @item @var{file}.ads
1170 Ada source code file that contains a library unit declaration (a
1171 declaration of a package, subprogram, or generic, or a generic
1172 instantiation), or a library unit renaming declaration (a package,
1173 generic, or subprogram renaming declaration). Such files are also
1174 called @dfn{specs}.
1175
1176 @item @var{file}.adb
1177 Ada source code file containing a library unit body (a subprogram or
1178 package body). Such files are also called @dfn{bodies}.
1179
1180 @c GCC also knows about some suffixes for languages not yet included:
1181 @c Pascal:
1182 @c @var{file}.p
1183 @c @var{file}.pas
1184 @c Ratfor:
1185 @c @var{file}.r
1186
1187 @item @var{file}.s
1188 Assembler code.
1189
1190 @item @var{file}.S
1191 @itemx @var{file}.sx
1192 Assembler code that must be preprocessed.
1193
1194 @item @var{other}
1195 An object file to be fed straight into linking.
1196 Any file name with no recognized suffix is treated this way.
1197 @end table
1198
1199 @opindex x
1200 You can specify the input language explicitly with the @option{-x} option:
1201
1202 @table @gcctabopt
1203 @item -x @var{language}
1204 Specify explicitly the @var{language} for the following input files
1205 (rather than letting the compiler choose a default based on the file
1206 name suffix). This option applies to all following input files until
1207 the next @option{-x} option. Possible values for @var{language} are:
1208 @smallexample
1209 c c-header cpp-output
1210 c++ c++-header c++-cpp-output
1211 objective-c objective-c-header objective-c-cpp-output
1212 objective-c++ objective-c++-header objective-c++-cpp-output
1213 assembler assembler-with-cpp
1214 ada
1215 f77 f77-cpp-input f95 f95-cpp-input
1216 go
1217 java
1218 @end smallexample
1219
1220 @item -x none
1221 Turn off any specification of a language, so that subsequent files are
1222 handled according to their file name suffixes (as they are if @option{-x}
1223 has not been used at all).
1224
1225 @item -pass-exit-codes
1226 @opindex pass-exit-codes
1227 Normally the @command{gcc} program exits with the code of 1 if any
1228 phase of the compiler returns a non-success return code. If you specify
1229 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1230 the numerically highest error produced by any phase returning an error
1231 indication. The C, C++, and Fortran front ends return 4 if an internal
1232 compiler error is encountered.
1233 @end table
1234
1235 If you only want some of the stages of compilation, you can use
1236 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1237 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1238 @command{gcc} is to stop. Note that some combinations (for example,
1239 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1240
1241 @table @gcctabopt
1242 @item -c
1243 @opindex c
1244 Compile or assemble the source files, but do not link. The linking
1245 stage simply is not done. The ultimate output is in the form of an
1246 object file for each source file.
1247
1248 By default, the object file name for a source file is made by replacing
1249 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1250
1251 Unrecognized input files, not requiring compilation or assembly, are
1252 ignored.
1253
1254 @item -S
1255 @opindex S
1256 Stop after the stage of compilation proper; do not assemble. The output
1257 is in the form of an assembler code file for each non-assembler input
1258 file specified.
1259
1260 By default, the assembler file name for a source file is made by
1261 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1262
1263 Input files that don't require compilation are ignored.
1264
1265 @item -E
1266 @opindex E
1267 Stop after the preprocessing stage; do not run the compiler proper. The
1268 output is in the form of preprocessed source code, which is sent to the
1269 standard output.
1270
1271 Input files that don't require preprocessing are ignored.
1272
1273 @cindex output file option
1274 @item -o @var{file}
1275 @opindex o
1276 Place output in file @var{file}. This applies to whatever
1277 sort of output is being produced, whether it be an executable file,
1278 an object file, an assembler file or preprocessed C code.
1279
1280 If @option{-o} is not specified, the default is to put an executable
1281 file in @file{a.out}, the object file for
1282 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1283 assembler file in @file{@var{source}.s}, a precompiled header file in
1284 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1285 standard output.
1286
1287 @item -v
1288 @opindex v
1289 Print (on standard error output) the commands executed to run the stages
1290 of compilation. Also print the version number of the compiler driver
1291 program and of the preprocessor and the compiler proper.
1292
1293 @item -###
1294 @opindex ###
1295 Like @option{-v} except the commands are not executed and arguments
1296 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1297 This is useful for shell scripts to capture the driver-generated command lines.
1298
1299 @item -pipe
1300 @opindex pipe
1301 Use pipes rather than temporary files for communication between the
1302 various stages of compilation. This fails to work on some systems where
1303 the assembler is unable to read from a pipe; but the GNU assembler has
1304 no trouble.
1305
1306 @item --help
1307 @opindex help
1308 Print (on the standard output) a description of the command-line options
1309 understood by @command{gcc}. If the @option{-v} option is also specified
1310 then @option{--help} is also passed on to the various processes
1311 invoked by @command{gcc}, so that they can display the command-line options
1312 they accept. If the @option{-Wextra} option has also been specified
1313 (prior to the @option{--help} option), then command-line options that
1314 have no documentation associated with them are also displayed.
1315
1316 @item --target-help
1317 @opindex target-help
1318 Print (on the standard output) a description of target-specific command-line
1319 options for each tool. For some targets extra target-specific
1320 information may also be printed.
1321
1322 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1323 Print (on the standard output) a description of the command-line
1324 options understood by the compiler that fit into all specified classes
1325 and qualifiers. These are the supported classes:
1326
1327 @table @asis
1328 @item @samp{optimizers}
1329 Display all of the optimization options supported by the
1330 compiler.
1331
1332 @item @samp{warnings}
1333 Display all of the options controlling warning messages
1334 produced by the compiler.
1335
1336 @item @samp{target}
1337 Display target-specific options. Unlike the
1338 @option{--target-help} option however, target-specific options of the
1339 linker and assembler are not displayed. This is because those
1340 tools do not currently support the extended @option{--help=} syntax.
1341
1342 @item @samp{params}
1343 Display the values recognized by the @option{--param}
1344 option.
1345
1346 @item @var{language}
1347 Display the options supported for @var{language}, where
1348 @var{language} is the name of one of the languages supported in this
1349 version of GCC@.
1350
1351 @item @samp{common}
1352 Display the options that are common to all languages.
1353 @end table
1354
1355 These are the supported qualifiers:
1356
1357 @table @asis
1358 @item @samp{undocumented}
1359 Display only those options that are undocumented.
1360
1361 @item @samp{joined}
1362 Display options taking an argument that appears after an equal
1363 sign in the same continuous piece of text, such as:
1364 @samp{--help=target}.
1365
1366 @item @samp{separate}
1367 Display options taking an argument that appears as a separate word
1368 following the original option, such as: @samp{-o output-file}.
1369 @end table
1370
1371 Thus for example to display all the undocumented target-specific
1372 switches supported by the compiler, use:
1373
1374 @smallexample
1375 --help=target,undocumented
1376 @end smallexample
1377
1378 The sense of a qualifier can be inverted by prefixing it with the
1379 @samp{^} character, so for example to display all binary warning
1380 options (i.e., ones that are either on or off and that do not take an
1381 argument) that have a description, use:
1382
1383 @smallexample
1384 --help=warnings,^joined,^undocumented
1385 @end smallexample
1386
1387 The argument to @option{--help=} should not consist solely of inverted
1388 qualifiers.
1389
1390 Combining several classes is possible, although this usually
1391 restricts the output so much that there is nothing to display. One
1392 case where it does work, however, is when one of the classes is
1393 @var{target}. For example, to display all the target-specific
1394 optimization options, use:
1395
1396 @smallexample
1397 --help=target,optimizers
1398 @end smallexample
1399
1400 The @option{--help=} option can be repeated on the command line. Each
1401 successive use displays its requested class of options, skipping
1402 those that have already been displayed.
1403
1404 If the @option{-Q} option appears on the command line before the
1405 @option{--help=} option, then the descriptive text displayed by
1406 @option{--help=} is changed. Instead of describing the displayed
1407 options, an indication is given as to whether the option is enabled,
1408 disabled or set to a specific value (assuming that the compiler
1409 knows this at the point where the @option{--help=} option is used).
1410
1411 Here is a truncated example from the ARM port of @command{gcc}:
1412
1413 @smallexample
1414 % gcc -Q -mabi=2 --help=target -c
1415 The following options are target specific:
1416 -mabi= 2
1417 -mabort-on-noreturn [disabled]
1418 -mapcs [disabled]
1419 @end smallexample
1420
1421 The output is sensitive to the effects of previous command-line
1422 options, so for example it is possible to find out which optimizations
1423 are enabled at @option{-O2} by using:
1424
1425 @smallexample
1426 -Q -O2 --help=optimizers
1427 @end smallexample
1428
1429 Alternatively you can discover which binary optimizations are enabled
1430 by @option{-O3} by using:
1431
1432 @smallexample
1433 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1434 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1435 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1436 @end smallexample
1437
1438 @item -no-canonical-prefixes
1439 @opindex no-canonical-prefixes
1440 Do not expand any symbolic links, resolve references to @samp{/../}
1441 or @samp{/./}, or make the path absolute when generating a relative
1442 prefix.
1443
1444 @item --version
1445 @opindex version
1446 Display the version number and copyrights of the invoked GCC@.
1447
1448 @item -wrapper
1449 @opindex wrapper
1450 Invoke all subcommands under a wrapper program. The name of the
1451 wrapper program and its parameters are passed as a comma separated
1452 list.
1453
1454 @smallexample
1455 gcc -c t.c -wrapper gdb,--args
1456 @end smallexample
1457
1458 @noindent
1459 This invokes all subprograms of @command{gcc} under
1460 @samp{gdb --args}, thus the invocation of @command{cc1} is
1461 @samp{gdb --args cc1 @dots{}}.
1462
1463 @item -fplugin=@var{name}.so
1464 Load the plugin code in file @var{name}.so, assumed to be a
1465 shared object to be dlopen'd by the compiler. The base name of
1466 the shared object file is used to identify the plugin for the
1467 purposes of argument parsing (See
1468 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1469 Each plugin should define the callback functions specified in the
1470 Plugins API.
1471
1472 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1473 Define an argument called @var{key} with a value of @var{value}
1474 for the plugin called @var{name}.
1475
1476 @item -fdump-ada-spec@r{[}-slim@r{]}
1477 For C and C++ source and include files, generate corresponding Ada
1478 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1479 GNAT User's Guide}, which provides detailed documentation on this feature.
1480
1481 @item -fdump-go-spec=@var{file}
1482 For input files in any language, generate corresponding Go
1483 declarations in @var{file}. This generates Go @code{const},
1484 @code{type}, @code{var}, and @code{func} declarations which may be a
1485 useful way to start writing a Go interface to code written in some
1486 other language.
1487
1488 @include @value{srcdir}/../libiberty/at-file.texi
1489 @end table
1490
1491 @node Invoking G++
1492 @section Compiling C++ Programs
1493
1494 @cindex suffixes for C++ source
1495 @cindex C++ source file suffixes
1496 C++ source files conventionally use one of the suffixes @samp{.C},
1497 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1498 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1499 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1500 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1501 files with these names and compiles them as C++ programs even if you
1502 call the compiler the same way as for compiling C programs (usually
1503 with the name @command{gcc}).
1504
1505 @findex g++
1506 @findex c++
1507 However, the use of @command{gcc} does not add the C++ library.
1508 @command{g++} is a program that calls GCC and automatically specifies linking
1509 against the C++ library. It treats @samp{.c},
1510 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1511 files unless @option{-x} is used. This program is also useful when
1512 precompiling a C header file with a @samp{.h} extension for use in C++
1513 compilations. On many systems, @command{g++} is also installed with
1514 the name @command{c++}.
1515
1516 @cindex invoking @command{g++}
1517 When you compile C++ programs, you may specify many of the same
1518 command-line options that you use for compiling programs in any
1519 language; or command-line options meaningful for C and related
1520 languages; or options that are meaningful only for C++ programs.
1521 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1522 explanations of options for languages related to C@.
1523 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1524 explanations of options that are meaningful only for C++ programs.
1525
1526 @node C Dialect Options
1527 @section Options Controlling C Dialect
1528 @cindex dialect options
1529 @cindex language dialect options
1530 @cindex options, dialect
1531
1532 The following options control the dialect of C (or languages derived
1533 from C, such as C++, Objective-C and Objective-C++) that the compiler
1534 accepts:
1535
1536 @table @gcctabopt
1537 @cindex ANSI support
1538 @cindex ISO support
1539 @item -ansi
1540 @opindex ansi
1541 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1542 equivalent to @option{-std=c++98}.
1543
1544 This turns off certain features of GCC that are incompatible with ISO
1545 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1546 such as the @code{asm} and @code{typeof} keywords, and
1547 predefined macros such as @code{unix} and @code{vax} that identify the
1548 type of system you are using. It also enables the undesirable and
1549 rarely used ISO trigraph feature. For the C compiler,
1550 it disables recognition of C++ style @samp{//} comments as well as
1551 the @code{inline} keyword.
1552
1553 The alternate keywords @code{__asm__}, @code{__extension__},
1554 @code{__inline__} and @code{__typeof__} continue to work despite
1555 @option{-ansi}. You would not want to use them in an ISO C program, of
1556 course, but it is useful to put them in header files that might be included
1557 in compilations done with @option{-ansi}. Alternate predefined macros
1558 such as @code{__unix__} and @code{__vax__} are also available, with or
1559 without @option{-ansi}.
1560
1561 The @option{-ansi} option does not cause non-ISO programs to be
1562 rejected gratuitously. For that, @option{-Wpedantic} is required in
1563 addition to @option{-ansi}. @xref{Warning Options}.
1564
1565 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1566 option is used. Some header files may notice this macro and refrain
1567 from declaring certain functions or defining certain macros that the
1568 ISO standard doesn't call for; this is to avoid interfering with any
1569 programs that might use these names for other things.
1570
1571 Functions that are normally built in but do not have semantics
1572 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1573 functions when @option{-ansi} is used. @xref{Other Builtins,,Other
1574 built-in functions provided by GCC}, for details of the functions
1575 affected.
1576
1577 @item -std=
1578 @opindex std
1579 Determine the language standard. @xref{Standards,,Language Standards
1580 Supported by GCC}, for details of these standard versions. This option
1581 is currently only supported when compiling C or C++.
1582
1583 The compiler can accept several base standards, such as @samp{c90} or
1584 @samp{c++98}, and GNU dialects of those standards, such as
1585 @samp{gnu90} or @samp{gnu++98}. When a base standard is specified, the
1586 compiler accepts all programs following that standard plus those
1587 using GNU extensions that do not contradict it. For example,
1588 @option{-std=c90} turns off certain features of GCC that are
1589 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1590 keywords, but not other GNU extensions that do not have a meaning in
1591 ISO C90, such as omitting the middle term of a @code{?:}
1592 expression. On the other hand, when a GNU dialect of a standard is
1593 specified, all features supported by the compiler are enabled, even when
1594 those features change the meaning of the base standard. As a result, some
1595 strict-conforming programs may be rejected. The particular standard
1596 is used by @option{-Wpedantic} to identify which features are GNU
1597 extensions given that version of the standard. For example
1598 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1599 comments, while @option{-std=gnu99 -Wpedantic} does not.
1600
1601 A value for this option must be provided; possible values are
1602
1603 @table @samp
1604 @item c90
1605 @itemx c89
1606 @itemx iso9899:1990
1607 Support all ISO C90 programs (certain GNU extensions that conflict
1608 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1609
1610 @item iso9899:199409
1611 ISO C90 as modified in amendment 1.
1612
1613 @item c99
1614 @itemx c9x
1615 @itemx iso9899:1999
1616 @itemx iso9899:199x
1617 ISO C99. Note that this standard is not yet fully supported; see
1618 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1619 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1620
1621 @item c11
1622 @itemx c1x
1623 @itemx iso9899:2011
1624 ISO C11, the 2011 revision of the ISO C standard.
1625 Support is incomplete and experimental. The name @samp{c1x} is
1626 deprecated.
1627
1628 @item gnu90
1629 @itemx gnu89
1630 GNU dialect of ISO C90 (including some C99 features). This
1631 is the default for C code.
1632
1633 @item gnu99
1634 @itemx gnu9x
1635 GNU dialect of ISO C99. When ISO C99 is fully implemented in GCC,
1636 this will become the default. The name @samp{gnu9x} is deprecated.
1637
1638 @item gnu11
1639 @itemx gnu1x
1640 GNU dialect of ISO C11. Support is incomplete and experimental. The
1641 name @samp{gnu1x} is deprecated.
1642
1643 @item c++98
1644 @itemx c++03
1645 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1646 additional defect reports. Same as @option{-ansi} for C++ code.
1647
1648 @item gnu++98
1649 @itemx gnu++03
1650 GNU dialect of @option{-std=c++98}. This is the default for
1651 C++ code.
1652
1653 @item c++11
1654 @itemx c++0x
1655 The 2011 ISO C++ standard plus amendments. Support for C++11 is still
1656 experimental, and may change in incompatible ways in future releases.
1657 The name @samp{c++0x} is deprecated.
1658
1659 @item gnu++11
1660 @itemx gnu++0x
1661 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1662 experimental, and may change in incompatible ways in future releases.
1663 The name @samp{gnu++0x} is deprecated.
1664
1665 @item c++1y
1666 The next revision of the ISO C++ standard, tentatively planned for
1667 2014. Support is highly experimental, and will almost certainly
1668 change in incompatible ways in future releases.
1669
1670 @item gnu++1y
1671 GNU dialect of @option{-std=c++1y}. Support is highly experimental,
1672 and will almost certainly change in incompatible ways in future
1673 releases.
1674 @end table
1675
1676 @item -fgnu89-inline
1677 @opindex fgnu89-inline
1678 The option @option{-fgnu89-inline} tells GCC to use the traditional
1679 GNU semantics for @code{inline} functions when in C99 mode.
1680 @xref{Inline,,An Inline Function is As Fast As a Macro}. This option
1681 is accepted and ignored by GCC versions 4.1.3 up to but not including
1682 4.3. In GCC versions 4.3 and later it changes the behavior of GCC in
1683 C99 mode. Using this option is roughly equivalent to adding the
1684 @code{gnu_inline} function attribute to all inline functions
1685 (@pxref{Function Attributes}).
1686
1687 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1688 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1689 specifies the default behavior). This option was first supported in
1690 GCC 4.3. This option is not supported in @option{-std=c90} or
1691 @option{-std=gnu90} mode.
1692
1693 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1694 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1695 in effect for @code{inline} functions. @xref{Common Predefined
1696 Macros,,,cpp,The C Preprocessor}.
1697
1698 @item -aux-info @var{filename}
1699 @opindex aux-info
1700 Output to the given filename prototyped declarations for all functions
1701 declared and/or defined in a translation unit, including those in header
1702 files. This option is silently ignored in any language other than C@.
1703
1704 Besides declarations, the file indicates, in comments, the origin of
1705 each declaration (source file and line), whether the declaration was
1706 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1707 @samp{O} for old, respectively, in the first character after the line
1708 number and the colon), and whether it came from a declaration or a
1709 definition (@samp{C} or @samp{F}, respectively, in the following
1710 character). In the case of function definitions, a K&R-style list of
1711 arguments followed by their declarations is also provided, inside
1712 comments, after the declaration.
1713
1714 @item -fallow-parameterless-variadic-functions
1715 Accept variadic functions without named parameters.
1716
1717 Although it is possible to define such a function, this is not very
1718 useful as it is not possible to read the arguments. This is only
1719 supported for C as this construct is allowed by C++.
1720
1721 @item -fno-asm
1722 @opindex fno-asm
1723 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1724 keyword, so that code can use these words as identifiers. You can use
1725 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1726 instead. @option{-ansi} implies @option{-fno-asm}.
1727
1728 In C++, this switch only affects the @code{typeof} keyword, since
1729 @code{asm} and @code{inline} are standard keywords. You may want to
1730 use the @option{-fno-gnu-keywords} flag instead, which has the same
1731 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1732 switch only affects the @code{asm} and @code{typeof} keywords, since
1733 @code{inline} is a standard keyword in ISO C99.
1734
1735 @item -fno-builtin
1736 @itemx -fno-builtin-@var{function}
1737 @opindex fno-builtin
1738 @cindex built-in functions
1739 Don't recognize built-in functions that do not begin with
1740 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1741 functions provided by GCC}, for details of the functions affected,
1742 including those which are not built-in functions when @option{-ansi} or
1743 @option{-std} options for strict ISO C conformance are used because they
1744 do not have an ISO standard meaning.
1745
1746 GCC normally generates special code to handle certain built-in functions
1747 more efficiently; for instance, calls to @code{alloca} may become single
1748 instructions which adjust the stack directly, and calls to @code{memcpy}
1749 may become inline copy loops. The resulting code is often both smaller
1750 and faster, but since the function calls no longer appear as such, you
1751 cannot set a breakpoint on those calls, nor can you change the behavior
1752 of the functions by linking with a different library. In addition,
1753 when a function is recognized as a built-in function, GCC may use
1754 information about that function to warn about problems with calls to
1755 that function, or to generate more efficient code, even if the
1756 resulting code still contains calls to that function. For example,
1757 warnings are given with @option{-Wformat} for bad calls to
1758 @code{printf} when @code{printf} is built in and @code{strlen} is
1759 known not to modify global memory.
1760
1761 With the @option{-fno-builtin-@var{function}} option
1762 only the built-in function @var{function} is
1763 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1764 function is named that is not built-in in this version of GCC, this
1765 option is ignored. There is no corresponding
1766 @option{-fbuiltin-@var{function}} option; if you wish to enable
1767 built-in functions selectively when using @option{-fno-builtin} or
1768 @option{-ffreestanding}, you may define macros such as:
1769
1770 @smallexample
1771 #define abs(n) __builtin_abs ((n))
1772 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1773 @end smallexample
1774
1775 @item -fhosted
1776 @opindex fhosted
1777 @cindex hosted environment
1778
1779 Assert that compilation targets a hosted environment. This implies
1780 @option{-fbuiltin}. A hosted environment is one in which the
1781 entire standard library is available, and in which @code{main} has a return
1782 type of @code{int}. Examples are nearly everything except a kernel.
1783 This is equivalent to @option{-fno-freestanding}.
1784
1785 @item -ffreestanding
1786 @opindex ffreestanding
1787 @cindex hosted environment
1788
1789 Assert that compilation targets a freestanding environment. This
1790 implies @option{-fno-builtin}. A freestanding environment
1791 is one in which the standard library may not exist, and program startup may
1792 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1793 This is equivalent to @option{-fno-hosted}.
1794
1795 @xref{Standards,,Language Standards Supported by GCC}, for details of
1796 freestanding and hosted environments.
1797
1798 @item -fopenmp
1799 @opindex fopenmp
1800 @cindex OpenMP parallel
1801 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1802 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
1803 compiler generates parallel code according to the OpenMP Application
1804 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}. This option
1805 implies @option{-pthread}, and thus is only supported on targets that
1806 have support for @option{-pthread}.
1807
1808 @item -fcilkplus
1809 @opindex fcilkplus
1810 @cindex Enable Cilk Plus
1811 Enable the usage of Cilk Language extension features for C/C++. When the flag
1812 @option{-fcilkplus} is specified, all the Cilk Plus components are converted
1813 to the appropriate C/C++ code. The present implementation follows ABI version
1814 0.9. There are four major parts to Cilk Plus language
1815 extension: Array Notations, Cilk Keywords, SIMD annotations and elemental
1816 functions. Detailed information about Cilk Plus can be found at
1817 @w{@uref{http://www.cilkplus.org}}.
1818
1819 @item -fgnu-tm
1820 @opindex fgnu-tm
1821 When the option @option{-fgnu-tm} is specified, the compiler
1822 generates code for the Linux variant of Intel's current Transactional
1823 Memory ABI specification document (Revision 1.1, May 6 2009). This is
1824 an experimental feature whose interface may change in future versions
1825 of GCC, as the official specification changes. Please note that not
1826 all architectures are supported for this feature.
1827
1828 For more information on GCC's support for transactional memory,
1829 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1830 Transactional Memory Library}.
1831
1832 Note that the transactional memory feature is not supported with
1833 non-call exceptions (@option{-fnon-call-exceptions}).
1834
1835 @item -fms-extensions
1836 @opindex fms-extensions
1837 Accept some non-standard constructs used in Microsoft header files.
1838
1839 In C++ code, this allows member names in structures to be similar
1840 to previous types declarations.
1841
1842 @smallexample
1843 typedef int UOW;
1844 struct ABC @{
1845 UOW UOW;
1846 @};
1847 @end smallexample
1848
1849 Some cases of unnamed fields in structures and unions are only
1850 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1851 fields within structs/unions}, for details.
1852
1853 @item -fplan9-extensions
1854 Accept some non-standard constructs used in Plan 9 code.
1855
1856 This enables @option{-fms-extensions}, permits passing pointers to
1857 structures with anonymous fields to functions that expect pointers to
1858 elements of the type of the field, and permits referring to anonymous
1859 fields declared using a typedef. @xref{Unnamed Fields,,Unnamed
1860 struct/union fields within structs/unions}, for details. This is only
1861 supported for C, not C++.
1862
1863 @item -trigraphs
1864 @opindex trigraphs
1865 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1866 options for strict ISO C conformance) implies @option{-trigraphs}.
1867
1868 @cindex traditional C language
1869 @cindex C language, traditional
1870 @item -traditional
1871 @itemx -traditional-cpp
1872 @opindex traditional-cpp
1873 @opindex traditional
1874 Formerly, these options caused GCC to attempt to emulate a pre-standard
1875 C compiler. They are now only supported with the @option{-E} switch.
1876 The preprocessor continues to support a pre-standard mode. See the GNU
1877 CPP manual for details.
1878
1879 @item -fcond-mismatch
1880 @opindex fcond-mismatch
1881 Allow conditional expressions with mismatched types in the second and
1882 third arguments. The value of such an expression is void. This option
1883 is not supported for C++.
1884
1885 @item -flax-vector-conversions
1886 @opindex flax-vector-conversions
1887 Allow implicit conversions between vectors with differing numbers of
1888 elements and/or incompatible element types. This option should not be
1889 used for new code.
1890
1891 @item -funsigned-char
1892 @opindex funsigned-char
1893 Let the type @code{char} be unsigned, like @code{unsigned char}.
1894
1895 Each kind of machine has a default for what @code{char} should
1896 be. It is either like @code{unsigned char} by default or like
1897 @code{signed char} by default.
1898
1899 Ideally, a portable program should always use @code{signed char} or
1900 @code{unsigned char} when it depends on the signedness of an object.
1901 But many programs have been written to use plain @code{char} and
1902 expect it to be signed, or expect it to be unsigned, depending on the
1903 machines they were written for. This option, and its inverse, let you
1904 make such a program work with the opposite default.
1905
1906 The type @code{char} is always a distinct type from each of
1907 @code{signed char} or @code{unsigned char}, even though its behavior
1908 is always just like one of those two.
1909
1910 @item -fsigned-char
1911 @opindex fsigned-char
1912 Let the type @code{char} be signed, like @code{signed char}.
1913
1914 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1915 the negative form of @option{-funsigned-char}. Likewise, the option
1916 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1917
1918 @item -fsigned-bitfields
1919 @itemx -funsigned-bitfields
1920 @itemx -fno-signed-bitfields
1921 @itemx -fno-unsigned-bitfields
1922 @opindex fsigned-bitfields
1923 @opindex funsigned-bitfields
1924 @opindex fno-signed-bitfields
1925 @opindex fno-unsigned-bitfields
1926 These options control whether a bit-field is signed or unsigned, when the
1927 declaration does not use either @code{signed} or @code{unsigned}. By
1928 default, such a bit-field is signed, because this is consistent: the
1929 basic integer types such as @code{int} are signed types.
1930 @end table
1931
1932 @node C++ Dialect Options
1933 @section Options Controlling C++ Dialect
1934
1935 @cindex compiler options, C++
1936 @cindex C++ options, command-line
1937 @cindex options, C++
1938 This section describes the command-line options that are only meaningful
1939 for C++ programs. You can also use most of the GNU compiler options
1940 regardless of what language your program is in. For example, you
1941 might compile a file @code{firstClass.C} like this:
1942
1943 @smallexample
1944 g++ -g -frepo -O -c firstClass.C
1945 @end smallexample
1946
1947 @noindent
1948 In this example, only @option{-frepo} is an option meant
1949 only for C++ programs; you can use the other options with any
1950 language supported by GCC@.
1951
1952 Here is a list of options that are @emph{only} for compiling C++ programs:
1953
1954 @table @gcctabopt
1955
1956 @item -fabi-version=@var{n}
1957 @opindex fabi-version
1958 Use version @var{n} of the C++ ABI@. The default is version 2.
1959
1960 Version 0 refers to the version conforming most closely to
1961 the C++ ABI specification. Therefore, the ABI obtained using version 0
1962 will change in different versions of G++ as ABI bugs are fixed.
1963
1964 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
1965
1966 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.
1967
1968 Version 3 corrects an error in mangling a constant address as a
1969 template argument.
1970
1971 Version 4, which first appeared in G++ 4.5, implements a standard
1972 mangling for vector types.
1973
1974 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1975 attribute const/volatile on function pointer types, decltype of a
1976 plain decl, and use of a function parameter in the declaration of
1977 another parameter.
1978
1979 Version 6, which first appeared in G++ 4.7, corrects the promotion
1980 behavior of C++11 scoped enums and the mangling of template argument
1981 packs, const/static_cast, prefix ++ and --, and a class scope function
1982 used as a template argument.
1983
1984 See also @option{-Wabi}.
1985
1986 @item -fno-access-control
1987 @opindex fno-access-control
1988 Turn off all access checking. This switch is mainly useful for working
1989 around bugs in the access control code.
1990
1991 @item -fcheck-new
1992 @opindex fcheck-new
1993 Check that the pointer returned by @code{operator new} is non-null
1994 before attempting to modify the storage allocated. This check is
1995 normally unnecessary because the C++ standard specifies that
1996 @code{operator new} only returns @code{0} if it is declared
1997 @samp{throw()}, in which case the compiler always checks the
1998 return value even without this option. In all other cases, when
1999 @code{operator new} has a non-empty exception specification, memory
2000 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
2001 @samp{new (nothrow)}.
2002
2003 @item -fconstexpr-depth=@var{n}
2004 @opindex fconstexpr-depth
2005 Set the maximum nested evaluation depth for C++11 constexpr functions
2006 to @var{n}. A limit is needed to detect endless recursion during
2007 constant expression evaluation. The minimum specified by the standard
2008 is 512.
2009
2010 @item -fdeduce-init-list
2011 @opindex fdeduce-init-list
2012 Enable deduction of a template type parameter as
2013 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2014
2015 @smallexample
2016 template <class T> auto forward(T t) -> decltype (realfn (t))
2017 @{
2018 return realfn (t);
2019 @}
2020
2021 void f()
2022 @{
2023 forward(@{1,2@}); // call forward<std::initializer_list<int>>
2024 @}
2025 @end smallexample
2026
2027 This deduction was implemented as a possible extension to the
2028 originally proposed semantics for the C++11 standard, but was not part
2029 of the final standard, so it is disabled by default. This option is
2030 deprecated, and may be removed in a future version of G++.
2031
2032 @item -ffriend-injection
2033 @opindex ffriend-injection
2034 Inject friend functions into the enclosing namespace, so that they are
2035 visible outside the scope of the class in which they are declared.
2036 Friend functions were documented to work this way in the old Annotated
2037 C++ Reference Manual, and versions of G++ before 4.1 always worked
2038 that way. However, in ISO C++ a friend function that is not declared
2039 in an enclosing scope can only be found using argument dependent
2040 lookup. This option causes friends to be injected as they were in
2041 earlier releases.
2042
2043 This option is for compatibility, and may be removed in a future
2044 release of G++.
2045
2046 @item -fno-elide-constructors
2047 @opindex fno-elide-constructors
2048 The C++ standard allows an implementation to omit creating a temporary
2049 that is only used to initialize another object of the same type.
2050 Specifying this option disables that optimization, and forces G++ to
2051 call the copy constructor in all cases.
2052
2053 @item -fno-enforce-eh-specs
2054 @opindex fno-enforce-eh-specs
2055 Don't generate code to check for violation of exception specifications
2056 at run time. This option violates the C++ standard, but may be useful
2057 for reducing code size in production builds, much like defining
2058 @samp{NDEBUG}. This does not give user code permission to throw
2059 exceptions in violation of the exception specifications; the compiler
2060 still optimizes based on the specifications, so throwing an
2061 unexpected exception results in undefined behavior at run time.
2062
2063 @item -fextern-tls-init
2064 @itemx -fno-extern-tls-init
2065 @opindex fextern-tls-init
2066 @opindex fno-extern-tls-init
2067 The C++11 and OpenMP standards allow @samp{thread_local} and
2068 @samp{threadprivate} variables to have dynamic (runtime)
2069 initialization. To support this, any use of such a variable goes
2070 through a wrapper function that performs any necessary initialization.
2071 When the use and definition of the variable are in the same
2072 translation unit, this overhead can be optimized away, but when the
2073 use is in a different translation unit there is significant overhead
2074 even if the variable doesn't actually need dynamic initialization. If
2075 the programmer can be sure that no use of the variable in a
2076 non-defining TU needs to trigger dynamic initialization (either
2077 because the variable is statically initialized, or a use of the
2078 variable in the defining TU will be executed before any uses in
2079 another TU), they can avoid this overhead with the
2080 @option{-fno-extern-tls-init} option.
2081
2082 On targets that support symbol aliases, the default is
2083 @option{-fextern-tls-init}. On targets that do not support symbol
2084 aliases, the default is @option{-fno-extern-tls-init}.
2085
2086 @item -ffor-scope
2087 @itemx -fno-for-scope
2088 @opindex ffor-scope
2089 @opindex fno-for-scope
2090 If @option{-ffor-scope} is specified, the scope of variables declared in
2091 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2092 as specified by the C++ standard.
2093 If @option{-fno-for-scope} is specified, the scope of variables declared in
2094 a @i{for-init-statement} extends to the end of the enclosing scope,
2095 as was the case in old versions of G++, and other (traditional)
2096 implementations of C++.
2097
2098 If neither flag is given, the default is to follow the standard,
2099 but to allow and give a warning for old-style code that would
2100 otherwise be invalid, or have different behavior.
2101
2102 @item -fno-gnu-keywords
2103 @opindex fno-gnu-keywords
2104 Do not recognize @code{typeof} as a keyword, so that code can use this
2105 word as an identifier. You can use the keyword @code{__typeof__} instead.
2106 @option{-ansi} implies @option{-fno-gnu-keywords}.
2107
2108 @item -fno-implicit-templates
2109 @opindex fno-implicit-templates
2110 Never emit code for non-inline templates that are instantiated
2111 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2112 @xref{Template Instantiation}, for more information.
2113
2114 @item -fno-implicit-inline-templates
2115 @opindex fno-implicit-inline-templates
2116 Don't emit code for implicit instantiations of inline templates, either.
2117 The default is to handle inlines differently so that compiles with and
2118 without optimization need the same set of explicit instantiations.
2119
2120 @item -fno-implement-inlines
2121 @opindex fno-implement-inlines
2122 To save space, do not emit out-of-line copies of inline functions
2123 controlled by @samp{#pragma implementation}. This causes linker
2124 errors if these functions are not inlined everywhere they are called.
2125
2126 @item -fms-extensions
2127 @opindex fms-extensions
2128 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2129 int and getting a pointer to member function via non-standard syntax.
2130
2131 @item -fno-nonansi-builtins
2132 @opindex fno-nonansi-builtins
2133 Disable built-in declarations of functions that are not mandated by
2134 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
2135 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2136
2137 @item -fnothrow-opt
2138 @opindex fnothrow-opt
2139 Treat a @code{throw()} exception specification as if it were a
2140 @code{noexcept} specification to reduce or eliminate the text size
2141 overhead relative to a function with no exception specification. If
2142 the function has local variables of types with non-trivial
2143 destructors, the exception specification actually makes the
2144 function smaller because the EH cleanups for those variables can be
2145 optimized away. The semantic effect is that an exception thrown out of
2146 a function with such an exception specification results in a call
2147 to @code{terminate} rather than @code{unexpected}.
2148
2149 @item -fno-operator-names
2150 @opindex fno-operator-names
2151 Do not treat the operator name keywords @code{and}, @code{bitand},
2152 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2153 synonyms as keywords.
2154
2155 @item -fno-optional-diags
2156 @opindex fno-optional-diags
2157 Disable diagnostics that the standard says a compiler does not need to
2158 issue. Currently, the only such diagnostic issued by G++ is the one for
2159 a name having multiple meanings within a class.
2160
2161 @item -fpermissive
2162 @opindex fpermissive
2163 Downgrade some diagnostics about nonconformant code from errors to
2164 warnings. Thus, using @option{-fpermissive} allows some
2165 nonconforming code to compile.
2166
2167 @item -fno-pretty-templates
2168 @opindex fno-pretty-templates
2169 When an error message refers to a specialization of a function
2170 template, the compiler normally prints the signature of the
2171 template followed by the template arguments and any typedefs or
2172 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2173 rather than @code{void f(int)}) so that it's clear which template is
2174 involved. When an error message refers to a specialization of a class
2175 template, the compiler omits any template arguments that match
2176 the default template arguments for that template. If either of these
2177 behaviors make it harder to understand the error message rather than
2178 easier, you can use @option{-fno-pretty-templates} to disable them.
2179
2180 @item -frepo
2181 @opindex frepo
2182 Enable automatic template instantiation at link time. This option also
2183 implies @option{-fno-implicit-templates}. @xref{Template
2184 Instantiation}, for more information.
2185
2186 @item -fno-rtti
2187 @opindex fno-rtti
2188 Disable generation of information about every class with virtual
2189 functions for use by the C++ run-time type identification features
2190 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
2191 of the language, you can save some space by using this flag. Note that
2192 exception handling uses the same information, but G++ generates it as
2193 needed. The @samp{dynamic_cast} operator can still be used for casts that
2194 do not require run-time type information, i.e.@: casts to @code{void *} or to
2195 unambiguous base classes.
2196
2197 @item -fstats
2198 @opindex fstats
2199 Emit statistics about front-end processing at the end of the compilation.
2200 This information is generally only useful to the G++ development team.
2201
2202 @item -fstrict-enums
2203 @opindex fstrict-enums
2204 Allow the compiler to optimize using the assumption that a value of
2205 enumerated type can only be one of the values of the enumeration (as
2206 defined in the C++ standard; basically, a value that can be
2207 represented in the minimum number of bits needed to represent all the
2208 enumerators). This assumption may not be valid if the program uses a
2209 cast to convert an arbitrary integer value to the enumerated type.
2210
2211 @item -ftemplate-backtrace-limit=@var{n}
2212 @opindex ftemplate-backtrace-limit
2213 Set the maximum number of template instantiation notes for a single
2214 warning or error to @var{n}. The default value is 10.
2215
2216 @item -ftemplate-depth=@var{n}
2217 @opindex ftemplate-depth
2218 Set the maximum instantiation depth for template classes to @var{n}.
2219 A limit on the template instantiation depth is needed to detect
2220 endless recursions during template class instantiation. ANSI/ISO C++
2221 conforming programs must not rely on a maximum depth greater than 17
2222 (changed to 1024 in C++11). The default value is 900, as the compiler
2223 can run out of stack space before hitting 1024 in some situations.
2224
2225 @item -fno-threadsafe-statics
2226 @opindex fno-threadsafe-statics
2227 Do not emit the extra code to use the routines specified in the C++
2228 ABI for thread-safe initialization of local statics. You can use this
2229 option to reduce code size slightly in code that doesn't need to be
2230 thread-safe.
2231
2232 @item -fuse-cxa-atexit
2233 @opindex fuse-cxa-atexit
2234 Register destructors for objects with static storage duration with the
2235 @code{__cxa_atexit} function rather than the @code{atexit} function.
2236 This option is required for fully standards-compliant handling of static
2237 destructors, but only works if your C library supports
2238 @code{__cxa_atexit}.
2239
2240 @item -fno-use-cxa-get-exception-ptr
2241 @opindex fno-use-cxa-get-exception-ptr
2242 Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
2243 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2244 if the runtime routine is not available.
2245
2246 @item -fvisibility-inlines-hidden
2247 @opindex fvisibility-inlines-hidden
2248 This switch declares that the user does not attempt to compare
2249 pointers to inline functions or methods where the addresses of the two functions
2250 are taken in different shared objects.
2251
2252 The effect of this is that GCC may, effectively, mark inline methods with
2253 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2254 appear in the export table of a DSO and do not require a PLT indirection
2255 when used within the DSO@. Enabling this option can have a dramatic effect
2256 on load and link times of a DSO as it massively reduces the size of the
2257 dynamic export table when the library makes heavy use of templates.
2258
2259 The behavior of this switch is not quite the same as marking the
2260 methods as hidden directly, because it does not affect static variables
2261 local to the function or cause the compiler to deduce that
2262 the function is defined in only one shared object.
2263
2264 You may mark a method as having a visibility explicitly to negate the
2265 effect of the switch for that method. For example, if you do want to
2266 compare pointers to a particular inline method, you might mark it as
2267 having default visibility. Marking the enclosing class with explicit
2268 visibility has no effect.
2269
2270 Explicitly instantiated inline methods are unaffected by this option
2271 as their linkage might otherwise cross a shared library boundary.
2272 @xref{Template Instantiation}.
2273
2274 @item -fvisibility-ms-compat
2275 @opindex fvisibility-ms-compat
2276 This flag attempts to use visibility settings to make GCC's C++
2277 linkage model compatible with that of Microsoft Visual Studio.
2278
2279 The flag makes these changes to GCC's linkage model:
2280
2281 @enumerate
2282 @item
2283 It sets the default visibility to @code{hidden}, like
2284 @option{-fvisibility=hidden}.
2285
2286 @item
2287 Types, but not their members, are not hidden by default.
2288
2289 @item
2290 The One Definition Rule is relaxed for types without explicit
2291 visibility specifications that are defined in more than one
2292 shared object: those declarations are permitted if they are
2293 permitted when this option is not used.
2294 @end enumerate
2295
2296 In new code it is better to use @option{-fvisibility=hidden} and
2297 export those classes that are intended to be externally visible.
2298 Unfortunately it is possible for code to rely, perhaps accidentally,
2299 on the Visual Studio behavior.
2300
2301 Among the consequences of these changes are that static data members
2302 of the same type with the same name but defined in different shared
2303 objects are different, so changing one does not change the other;
2304 and that pointers to function members defined in different shared
2305 objects may not compare equal. When this flag is given, it is a
2306 violation of the ODR to define types with the same name differently.
2307
2308 @item -fvtable-verify=@var{std|preinit|none}
2309 @opindex fvtable-verify
2310 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2311 feature that verifies at runtime, for every virtual call that is made, that
2312 the vtable pointer through which the call is made is valid for the type of
2313 the object, and has not been corrupted or overwritten. If an invalid vtable
2314 pointer is detected (at runtime), an error is reported and execution of the
2315 program is immediately halted.
2316
2317 This option causes runtime data structures to be built, at program start up,
2318 for verifying the vtable pointers. The options @code{std} and @code{preinit}
2319 control the timing of when these data structures are built. In both cases the
2320 data structures are built before execution reaches 'main'. The
2321 @option{-fvtable-verify=std} causes these data structure to be built after the
2322 shared libraries have been loaded and initialized.
2323 @option{-fvtable-verify=preinit} causes them to be built before the shared
2324 libraries have been loaded and initialized.
2325
2326 If this option appears multiple times in the compiler line, with different
2327 values specified, 'none' will take highest priority over both 'std' and
2328 'preinit'; 'preinit' will take priority over 'std'.
2329
2330 @item -fvtv-debug
2331 @opindex (fvtv-debug)
2332 Causes debug versions of the runtime functions for the vtable verification
2333 feature to be called. This assumes the @option{-fvtable-verify=std} or
2334 @option{-fvtable-verify=preinit} has been used. This flag will also cause the
2335 compiler to keep track of which vtable pointers it found for each class, and
2336 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2337 file directory on the user's machine.
2338
2339 Note: This feature APPENDS data to the log file. If you want a fresh log
2340 file, be sure to delete any existing one.
2341
2342 @item -fvtv-counts
2343 @opindex (fvtv-counts)
2344 This is a debugging flag. When used in conjunction with
2345 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2346 causes the compiler to keep track of the total number of virtual calls
2347 it encountered and the number of verifications it inserted. It also
2348 counts the number of calls to certain runtime library functions
2349 that it inserts. This information, for each compilation unit, is written
2350 to a file named ``vtv_count_data.log'', in the dump_file directory on
2351 the user's machine. It also counts the size of the vtable pointer sets
2352 for each class, and writes this information to ``vtv_class_set_sizes.log''
2353 in the same directory.
2354
2355 Note: This feature APPENDS data to the log files. To get a fresh log
2356 files, be sure to delete any existing ones.
2357
2358 @item -fno-weak
2359 @opindex fno-weak
2360 Do not use weak symbol support, even if it is provided by the linker.
2361 By default, G++ uses weak symbols if they are available. This
2362 option exists only for testing, and should not be used by end-users;
2363 it results in inferior code and has no benefits. This option may
2364 be removed in a future release of G++.
2365
2366 @item -nostdinc++
2367 @opindex nostdinc++
2368 Do not search for header files in the standard directories specific to
2369 C++, but do still search the other standard directories. (This option
2370 is used when building the C++ library.)
2371 @end table
2372
2373 In addition, these optimization, warning, and code generation options
2374 have meanings only for C++ programs:
2375
2376 @table @gcctabopt
2377 @item -fno-default-inline
2378 @opindex fno-default-inline
2379 Do not assume @samp{inline} for functions defined inside a class scope.
2380 @xref{Optimize Options,,Options That Control Optimization}. Note that these
2381 functions have linkage like inline functions; they just aren't
2382 inlined by default.
2383
2384 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2385 @opindex Wabi
2386 @opindex Wno-abi
2387 Warn when G++ generates code that is probably not compatible with the
2388 vendor-neutral C++ ABI@. Although an effort has been made to warn about
2389 all such cases, there are probably some cases that are not warned about,
2390 even though G++ is generating incompatible code. There may also be
2391 cases where warnings are emitted even though the code that is generated
2392 is compatible.
2393
2394 You should rewrite your code to avoid these warnings if you are
2395 concerned about the fact that code generated by G++ may not be binary
2396 compatible with code generated by other compilers.
2397
2398 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2399
2400 @itemize @bullet
2401
2402 @item
2403 A template with a non-type template parameter of reference type is
2404 mangled incorrectly:
2405 @smallexample
2406 extern int N;
2407 template <int &> struct S @{@};
2408 void n (S<N>) @{2@}
2409 @end smallexample
2410
2411 This is fixed in @option{-fabi-version=3}.
2412
2413 @item
2414 SIMD vector types declared using @code{__attribute ((vector_size))} are
2415 mangled in a non-standard way that does not allow for overloading of
2416 functions taking vectors of different sizes.
2417
2418 The mangling is changed in @option{-fabi-version=4}.
2419 @end itemize
2420
2421 The known incompatibilities in @option{-fabi-version=1} include:
2422
2423 @itemize @bullet
2424
2425 @item
2426 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
2427 pack data into the same byte as a base class. For example:
2428
2429 @smallexample
2430 struct A @{ virtual void f(); int f1 : 1; @};
2431 struct B : public A @{ int f2 : 1; @};
2432 @end smallexample
2433
2434 @noindent
2435 In this case, G++ places @code{B::f2} into the same byte
2436 as @code{A::f1}; other compilers do not. You can avoid this problem
2437 by explicitly padding @code{A} so that its size is a multiple of the
2438 byte size on your platform; that causes G++ and other compilers to
2439 lay out @code{B} identically.
2440
2441 @item
2442 Incorrect handling of tail-padding for virtual bases. G++ does not use
2443 tail padding when laying out virtual bases. For example:
2444
2445 @smallexample
2446 struct A @{ virtual void f(); char c1; @};
2447 struct B @{ B(); char c2; @};
2448 struct C : public A, public virtual B @{@};
2449 @end smallexample
2450
2451 @noindent
2452 In this case, G++ does not place @code{B} into the tail-padding for
2453 @code{A}; other compilers do. You can avoid this problem by
2454 explicitly padding @code{A} so that its size is a multiple of its
2455 alignment (ignoring virtual base classes); that causes G++ and other
2456 compilers to lay out @code{C} identically.
2457
2458 @item
2459 Incorrect handling of bit-fields with declared widths greater than that
2460 of their underlying types, when the bit-fields appear in a union. For
2461 example:
2462
2463 @smallexample
2464 union U @{ int i : 4096; @};
2465 @end smallexample
2466
2467 @noindent
2468 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2469 union too small by the number of bits in an @code{int}.
2470
2471 @item
2472 Empty classes can be placed at incorrect offsets. For example:
2473
2474 @smallexample
2475 struct A @{@};
2476
2477 struct B @{
2478 A a;
2479 virtual void f ();
2480 @};
2481
2482 struct C : public B, public A @{@};
2483 @end smallexample
2484
2485 @noindent
2486 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2487 it should be placed at offset zero. G++ mistakenly believes that the
2488 @code{A} data member of @code{B} is already at offset zero.
2489
2490 @item
2491 Names of template functions whose types involve @code{typename} or
2492 template template parameters can be mangled incorrectly.
2493
2494 @smallexample
2495 template <typename Q>
2496 void f(typename Q::X) @{@}
2497
2498 template <template <typename> class Q>
2499 void f(typename Q<int>::X) @{@}
2500 @end smallexample
2501
2502 @noindent
2503 Instantiations of these templates may be mangled incorrectly.
2504
2505 @end itemize
2506
2507 It also warns about psABI-related changes. The known psABI changes at this
2508 point include:
2509
2510 @itemize @bullet
2511
2512 @item
2513 For SysV/x86-64, unions with @code{long double} members are
2514 passed in memory as specified in psABI. For example:
2515
2516 @smallexample
2517 union U @{
2518 long double ld;
2519 int i;
2520 @};
2521 @end smallexample
2522
2523 @noindent
2524 @code{union U} is always passed in memory.
2525
2526 @end itemize
2527
2528 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2529 @opindex Wctor-dtor-privacy
2530 @opindex Wno-ctor-dtor-privacy
2531 Warn when a class seems unusable because all the constructors or
2532 destructors in that class are private, and it has neither friends nor
2533 public static member functions. Also warn if there are no non-private
2534 methods, and there's at least one private member function that isn't
2535 a constructor or destructor.
2536
2537 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2538 @opindex Wdelete-non-virtual-dtor
2539 @opindex Wno-delete-non-virtual-dtor
2540 Warn when @samp{delete} is used to destroy an instance of a class that
2541 has virtual functions and non-virtual destructor. It is unsafe to delete
2542 an instance of a derived class through a pointer to a base class if the
2543 base class does not have a virtual destructor. This warning is enabled
2544 by @option{-Wall}.
2545
2546 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2547 @opindex Wliteral-suffix
2548 @opindex Wno-literal-suffix
2549 Warn when a string or character literal is followed by a ud-suffix which does
2550 not begin with an underscore. As a conforming extension, GCC treats such
2551 suffixes as separate preprocessing tokens in order to maintain backwards
2552 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2553 For example:
2554
2555 @smallexample
2556 #define __STDC_FORMAT_MACROS
2557 #include <inttypes.h>
2558 #include <stdio.h>
2559
2560 int main() @{
2561 int64_t i64 = 123;
2562 printf("My int64: %"PRId64"\n", i64);
2563 @}
2564 @end smallexample
2565
2566 In this case, @code{PRId64} is treated as a separate preprocessing token.
2567
2568 This warning is enabled by default.
2569
2570 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2571 @opindex Wnarrowing
2572 @opindex Wno-narrowing
2573 Warn when a narrowing conversion prohibited by C++11 occurs within
2574 @samp{@{ @}}, e.g.
2575
2576 @smallexample
2577 int i = @{ 2.2 @}; // error: narrowing from double to int
2578 @end smallexample
2579
2580 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2581
2582 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2583 required by the standard. Note that this does not affect the meaning
2584 of well-formed code; narrowing conversions are still considered
2585 ill-formed in SFINAE context.
2586
2587 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2588 @opindex Wnoexcept
2589 @opindex Wno-noexcept
2590 Warn when a noexcept-expression evaluates to false because of a call
2591 to a function that does not have a non-throwing exception
2592 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2593 the compiler to never throw an exception.
2594
2595 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2596 @opindex Wnon-virtual-dtor
2597 @opindex Wno-non-virtual-dtor
2598 Warn when a class has virtual functions and an accessible non-virtual
2599 destructor, in which case it is possible but unsafe to delete
2600 an instance of a derived class through a pointer to the base class.
2601 This warning is also enabled if @option{-Weffc++} is specified.
2602
2603 @item -Wreorder @r{(C++ and Objective-C++ only)}
2604 @opindex Wreorder
2605 @opindex Wno-reorder
2606 @cindex reordering, warning
2607 @cindex warning for reordering of member initializers
2608 Warn when the order of member initializers given in the code does not
2609 match the order in which they must be executed. For instance:
2610
2611 @smallexample
2612 struct A @{
2613 int i;
2614 int j;
2615 A(): j (0), i (1) @{ @}
2616 @};
2617 @end smallexample
2618
2619 @noindent
2620 The compiler rearranges the member initializers for @samp{i}
2621 and @samp{j} to match the declaration order of the members, emitting
2622 a warning to that effect. This warning is enabled by @option{-Wall}.
2623
2624 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2625 @opindex fext-numeric-literals
2626 @opindex fno-ext-numeric-literals
2627 Accept imaginary, fixed-point, or machine-defined
2628 literal number suffixes as GNU extensions.
2629 When this option is turned off these suffixes are treated
2630 as C++11 user-defined literal numeric suffixes.
2631 This is on by default for all pre-C++11 dialects and all GNU dialects:
2632 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2633 @option{-std=gnu++1y}.
2634 This option is off by default
2635 for ISO C++11 onwards (@option{-std=c++11}, ...).
2636 @end table
2637
2638 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2639
2640 @table @gcctabopt
2641 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2642 @opindex Weffc++
2643 @opindex Wno-effc++
2644 Warn about violations of the following style guidelines from Scott Meyers'
2645 @cite{Effective C++, Second Edition} book:
2646
2647 @itemize @bullet
2648 @item
2649 Item 11: Define a copy constructor and an assignment operator for classes
2650 with dynamically-allocated memory.
2651
2652 @item
2653 Item 12: Prefer initialization to assignment in constructors.
2654
2655 @item
2656 Item 14: Make destructors virtual in base classes.
2657
2658 @item
2659 Item 15: Have @code{operator=} return a reference to @code{*this}.
2660
2661 @item
2662 Item 23: Don't try to return a reference when you must return an object.
2663
2664 @end itemize
2665
2666 Also warn about violations of the following style guidelines from
2667 Scott Meyers' @cite{More Effective C++} book:
2668
2669 @itemize @bullet
2670 @item
2671 Item 6: Distinguish between prefix and postfix forms of increment and
2672 decrement operators.
2673
2674 @item
2675 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
2676
2677 @end itemize
2678
2679 When selecting this option, be aware that the standard library
2680 headers do not obey all of these guidelines; use @samp{grep -v}
2681 to filter out those warnings.
2682
2683 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2684 @opindex Wstrict-null-sentinel
2685 @opindex Wno-strict-null-sentinel
2686 Warn about the use of an uncasted @code{NULL} as sentinel. When
2687 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2688 to @code{__null}. Although it is a null pointer constant rather than a
2689 null pointer, it is guaranteed to be of the same size as a pointer.
2690 But this use is not portable across different compilers.
2691
2692 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2693 @opindex Wno-non-template-friend
2694 @opindex Wnon-template-friend
2695 Disable warnings when non-templatized friend functions are declared
2696 within a template. Since the advent of explicit template specification
2697 support in G++, if the name of the friend is an unqualified-id (i.e.,
2698 @samp{friend foo(int)}), the C++ language specification demands that the
2699 friend declare or define an ordinary, nontemplate function. (Section
2700 14.5.3). Before G++ implemented explicit specification, unqualified-ids
2701 could be interpreted as a particular specialization of a templatized
2702 function. Because this non-conforming behavior is no longer the default
2703 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2704 check existing code for potential trouble spots and is on by default.
2705 This new compiler behavior can be turned off with
2706 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2707 but disables the helpful warning.
2708
2709 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2710 @opindex Wold-style-cast
2711 @opindex Wno-old-style-cast
2712 Warn if an old-style (C-style) cast to a non-void type is used within
2713 a C++ program. The new-style casts (@samp{dynamic_cast},
2714 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2715 less vulnerable to unintended effects and much easier to search for.
2716
2717 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2718 @opindex Woverloaded-virtual
2719 @opindex Wno-overloaded-virtual
2720 @cindex overloaded virtual function, warning
2721 @cindex warning for overloaded virtual function
2722 Warn when a function declaration hides virtual functions from a
2723 base class. For example, in:
2724
2725 @smallexample
2726 struct A @{
2727 virtual void f();
2728 @};
2729
2730 struct B: public A @{
2731 void f(int);
2732 @};
2733 @end smallexample
2734
2735 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2736 like:
2737
2738 @smallexample
2739 B* b;
2740 b->f();
2741 @end smallexample
2742
2743 @noindent
2744 fails to compile.
2745
2746 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2747 @opindex Wno-pmf-conversions
2748 @opindex Wpmf-conversions
2749 Disable the diagnostic for converting a bound pointer to member function
2750 to a plain pointer.
2751
2752 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2753 @opindex Wsign-promo
2754 @opindex Wno-sign-promo
2755 Warn when overload resolution chooses a promotion from unsigned or
2756 enumerated type to a signed type, over a conversion to an unsigned type of
2757 the same size. Previous versions of G++ tried to preserve
2758 unsignedness, but the standard mandates the current behavior.
2759 @end table
2760
2761 @node Objective-C and Objective-C++ Dialect Options
2762 @section Options Controlling Objective-C and Objective-C++ Dialects
2763
2764 @cindex compiler options, Objective-C and Objective-C++
2765 @cindex Objective-C and Objective-C++ options, command-line
2766 @cindex options, Objective-C and Objective-C++
2767 (NOTE: This manual does not describe the Objective-C and Objective-C++
2768 languages themselves. @xref{Standards,,Language Standards
2769 Supported by GCC}, for references.)
2770
2771 This section describes the command-line options that are only meaningful
2772 for Objective-C and Objective-C++ programs. You can also use most of
2773 the language-independent GNU compiler options.
2774 For example, you might compile a file @code{some_class.m} like this:
2775
2776 @smallexample
2777 gcc -g -fgnu-runtime -O -c some_class.m
2778 @end smallexample
2779
2780 @noindent
2781 In this example, @option{-fgnu-runtime} is an option meant only for
2782 Objective-C and Objective-C++ programs; you can use the other options with
2783 any language supported by GCC@.
2784
2785 Note that since Objective-C is an extension of the C language, Objective-C
2786 compilations may also use options specific to the C front-end (e.g.,
2787 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
2788 C++-specific options (e.g., @option{-Wabi}).
2789
2790 Here is a list of options that are @emph{only} for compiling Objective-C
2791 and Objective-C++ programs:
2792
2793 @table @gcctabopt
2794 @item -fconstant-string-class=@var{class-name}
2795 @opindex fconstant-string-class
2796 Use @var{class-name} as the name of the class to instantiate for each
2797 literal string specified with the syntax @code{@@"@dots{}"}. The default
2798 class name is @code{NXConstantString} if the GNU runtime is being used, and
2799 @code{NSConstantString} if the NeXT runtime is being used (see below). The
2800 @option{-fconstant-cfstrings} option, if also present, overrides the
2801 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2802 to be laid out as constant CoreFoundation strings.
2803
2804 @item -fgnu-runtime
2805 @opindex fgnu-runtime
2806 Generate object code compatible with the standard GNU Objective-C
2807 runtime. This is the default for most types of systems.
2808
2809 @item -fnext-runtime
2810 @opindex fnext-runtime
2811 Generate output compatible with the NeXT runtime. This is the default
2812 for NeXT-based systems, including Darwin and Mac OS X@. The macro
2813 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2814 used.
2815
2816 @item -fno-nil-receivers
2817 @opindex fno-nil-receivers
2818 Assume that all Objective-C message dispatches (@code{[receiver
2819 message:arg]}) in this translation unit ensure that the receiver is
2820 not @code{nil}. This allows for more efficient entry points in the
2821 runtime to be used. This option is only available in conjunction with
2822 the NeXT runtime and ABI version 0 or 1.
2823
2824 @item -fobjc-abi-version=@var{n}
2825 @opindex fobjc-abi-version
2826 Use version @var{n} of the Objective-C ABI for the selected runtime.
2827 This option is currently supported only for the NeXT runtime. In that
2828 case, Version 0 is the traditional (32-bit) ABI without support for
2829 properties and other Objective-C 2.0 additions. Version 1 is the
2830 traditional (32-bit) ABI with support for properties and other
2831 Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If
2832 nothing is specified, the default is Version 0 on 32-bit target
2833 machines, and Version 2 on 64-bit target machines.
2834
2835 @item -fobjc-call-cxx-cdtors
2836 @opindex fobjc-call-cxx-cdtors
2837 For each Objective-C class, check if any of its instance variables is a
2838 C++ object with a non-trivial default constructor. If so, synthesize a
2839 special @code{- (id) .cxx_construct} instance method which runs
2840 non-trivial default constructors on any such instance variables, in order,
2841 and then return @code{self}. Similarly, check if any instance variable
2842 is a C++ object with a non-trivial destructor, and if so, synthesize a
2843 special @code{- (void) .cxx_destruct} method which runs
2844 all such default destructors, in reverse order.
2845
2846 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2847 methods thusly generated only operate on instance variables
2848 declared in the current Objective-C class, and not those inherited
2849 from superclasses. It is the responsibility of the Objective-C
2850 runtime to invoke all such methods in an object's inheritance
2851 hierarchy. The @code{- (id) .cxx_construct} methods are invoked
2852 by the runtime immediately after a new object instance is allocated;
2853 the @code{- (void) .cxx_destruct} methods are invoked immediately
2854 before the runtime deallocates an object instance.
2855
2856 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2857 support for invoking the @code{- (id) .cxx_construct} and
2858 @code{- (void) .cxx_destruct} methods.
2859
2860 @item -fobjc-direct-dispatch
2861 @opindex fobjc-direct-dispatch
2862 Allow fast jumps to the message dispatcher. On Darwin this is
2863 accomplished via the comm page.
2864
2865 @item -fobjc-exceptions
2866 @opindex fobjc-exceptions
2867 Enable syntactic support for structured exception handling in
2868 Objective-C, similar to what is offered by C++ and Java. This option
2869 is required to use the Objective-C keywords @code{@@try},
2870 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2871 @code{@@synchronized}. This option is available with both the GNU
2872 runtime and the NeXT runtime (but not available in conjunction with
2873 the NeXT runtime on Mac OS X 10.2 and earlier).
2874
2875 @item -fobjc-gc
2876 @opindex fobjc-gc
2877 Enable garbage collection (GC) in Objective-C and Objective-C++
2878 programs. This option is only available with the NeXT runtime; the
2879 GNU runtime has a different garbage collection implementation that
2880 does not require special compiler flags.
2881
2882 @item -fobjc-nilcheck
2883 @opindex fobjc-nilcheck
2884 For the NeXT runtime with version 2 of the ABI, check for a nil
2885 receiver in method invocations before doing the actual method call.
2886 This is the default and can be disabled using
2887 @option{-fno-objc-nilcheck}. Class methods and super calls are never
2888 checked for nil in this way no matter what this flag is set to.
2889 Currently this flag does nothing when the GNU runtime, or an older
2890 version of the NeXT runtime ABI, is used.
2891
2892 @item -fobjc-std=objc1
2893 @opindex fobjc-std
2894 Conform to the language syntax of Objective-C 1.0, the language
2895 recognized by GCC 4.0. This only affects the Objective-C additions to
2896 the C/C++ language; it does not affect conformance to C/C++ standards,
2897 which is controlled by the separate C/C++ dialect option flags. When
2898 this option is used with the Objective-C or Objective-C++ compiler,
2899 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2900 This is useful if you need to make sure that your Objective-C code can
2901 be compiled with older versions of GCC@.
2902
2903 @item -freplace-objc-classes
2904 @opindex freplace-objc-classes
2905 Emit a special marker instructing @command{ld(1)} not to statically link in
2906 the resulting object file, and allow @command{dyld(1)} to load it in at
2907 run time instead. This is used in conjunction with the Fix-and-Continue
2908 debugging mode, where the object file in question may be recompiled and
2909 dynamically reloaded in the course of program execution, without the need
2910 to restart the program itself. Currently, Fix-and-Continue functionality
2911 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2912 and later.
2913
2914 @item -fzero-link
2915 @opindex fzero-link
2916 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2917 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2918 compile time) with static class references that get initialized at load time,
2919 which improves run-time performance. Specifying the @option{-fzero-link} flag
2920 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2921 to be retained. This is useful in Zero-Link debugging mode, since it allows
2922 for individual class implementations to be modified during program execution.
2923 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2924 regardless of command-line options.
2925
2926 @item -gen-decls
2927 @opindex gen-decls
2928 Dump interface declarations for all classes seen in the source file to a
2929 file named @file{@var{sourcename}.decl}.
2930
2931 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2932 @opindex Wassign-intercept
2933 @opindex Wno-assign-intercept
2934 Warn whenever an Objective-C assignment is being intercepted by the
2935 garbage collector.
2936
2937 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2938 @opindex Wno-protocol
2939 @opindex Wprotocol
2940 If a class is declared to implement a protocol, a warning is issued for
2941 every method in the protocol that is not implemented by the class. The
2942 default behavior is to issue a warning for every method not explicitly
2943 implemented in the class, even if a method implementation is inherited
2944 from the superclass. If you use the @option{-Wno-protocol} option, then
2945 methods inherited from the superclass are considered to be implemented,
2946 and no warning is issued for them.
2947
2948 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2949 @opindex Wselector
2950 @opindex Wno-selector
2951 Warn if multiple methods of different types for the same selector are
2952 found during compilation. The check is performed on the list of methods
2953 in the final stage of compilation. Additionally, a check is performed
2954 for each selector appearing in a @code{@@selector(@dots{})}
2955 expression, and a corresponding method for that selector has been found
2956 during compilation. Because these checks scan the method table only at
2957 the end of compilation, these warnings are not produced if the final
2958 stage of compilation is not reached, for example because an error is
2959 found during compilation, or because the @option{-fsyntax-only} option is
2960 being used.
2961
2962 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2963 @opindex Wstrict-selector-match
2964 @opindex Wno-strict-selector-match
2965 Warn if multiple methods with differing argument and/or return types are
2966 found for a given selector when attempting to send a message using this
2967 selector to a receiver of type @code{id} or @code{Class}. When this flag
2968 is off (which is the default behavior), the compiler omits such warnings
2969 if any differences found are confined to types that share the same size
2970 and alignment.
2971
2972 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2973 @opindex Wundeclared-selector
2974 @opindex Wno-undeclared-selector
2975 Warn if a @code{@@selector(@dots{})} expression referring to an
2976 undeclared selector is found. A selector is considered undeclared if no
2977 method with that name has been declared before the
2978 @code{@@selector(@dots{})} expression, either explicitly in an
2979 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2980 an @code{@@implementation} section. This option always performs its
2981 checks as soon as a @code{@@selector(@dots{})} expression is found,
2982 while @option{-Wselector} only performs its checks in the final stage of
2983 compilation. This also enforces the coding style convention
2984 that methods and selectors must be declared before being used.
2985
2986 @item -print-objc-runtime-info
2987 @opindex print-objc-runtime-info
2988 Generate C header describing the largest structure that is passed by
2989 value, if any.
2990
2991 @end table
2992
2993 @node Language Independent Options
2994 @section Options to Control Diagnostic Messages Formatting
2995 @cindex options to control diagnostics formatting
2996 @cindex diagnostic messages
2997 @cindex message formatting
2998
2999 Traditionally, diagnostic messages have been formatted irrespective of
3000 the output device's aspect (e.g.@: its width, @dots{}). You can use the
3001 options described below
3002 to control the formatting algorithm for diagnostic messages,
3003 e.g.@: how many characters per line, how often source location
3004 information should be reported. Note that some language front ends may not
3005 honor these options.
3006
3007 @table @gcctabopt
3008 @item -fmessage-length=@var{n}
3009 @opindex fmessage-length
3010 Try to format error messages so that they fit on lines of about @var{n}
3011 characters. The default is 72 characters for @command{g++} and 0 for the rest of
3012 the front ends supported by GCC@. If @var{n} is zero, then no
3013 line-wrapping is done; each error message appears on a single
3014 line.
3015
3016 @item -fdiagnostics-show-location=once
3017 @opindex fdiagnostics-show-location
3018 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
3019 reporter to emit source location information @emph{once}; that is, in
3020 case the message is too long to fit on a single physical line and has to
3021 be wrapped, the source location won't be emitted (as prefix) again,
3022 over and over, in subsequent continuation lines. This is the default
3023 behavior.
3024
3025 @item -fdiagnostics-show-location=every-line
3026 Only meaningful in line-wrapping mode. Instructs the diagnostic
3027 messages reporter to emit the same source location information (as
3028 prefix) for physical lines that result from the process of breaking
3029 a message which is too long to fit on a single line.
3030
3031 @item -fdiagnostics-color[=@var{WHEN}]
3032 @itemx -fno-diagnostics-color
3033 @opindex fdiagnostics-color
3034 @cindex highlight, color, colour
3035 @vindex GCC_COLORS @r{environment variable}
3036 Use color in diagnostics. @var{WHEN} is @samp{never}, @samp{always},
3037 or @samp{auto}. The default is @samp{never} if @env{GCC_COLORS} environment
3038 variable isn't present in the environment, and @samp{auto} otherwise.
3039 @samp{auto} means to use color only when the standard error is a terminal.
3040 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3041 aliases for @option{-fdiagnostics-color=always} and
3042 @option{-fdiagnostics-color=never}, respectively.
3043
3044 The colors are defined by the environment variable @env{GCC_COLORS}.
3045 Its value is a colon-separated list of capabilities and Select Graphic
3046 Rendition (SGR) substrings. SGR commands are interpreted by the
3047 terminal or terminal emulator. (See the section in the documentation
3048 of your text terminal for permitted values and their meanings as
3049 character attributes.) These substring values are integers in decimal
3050 representation and can be concatenated with semicolons.
3051 Common values to concatenate include
3052 @samp{1} for bold,
3053 @samp{4} for underline,
3054 @samp{5} for blink,
3055 @samp{7} for inverse,
3056 @samp{39} for default foreground color,
3057 @samp{30} to @samp{37} for foreground colors,
3058 @samp{90} to @samp{97} for 16-color mode foreground colors,
3059 @samp{38;5;0} to @samp{38;5;255}
3060 for 88-color and 256-color modes foreground colors,
3061 @samp{49} for default background color,
3062 @samp{40} to @samp{47} for background colors,
3063 @samp{100} to @samp{107} for 16-color mode background colors,
3064 and @samp{48;5;0} to @samp{48;5;255}
3065 for 88-color and 256-color modes background colors.
3066
3067 The default @env{GCC_COLORS} is
3068 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3069 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3070 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3071 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3072 string disables colors.
3073 Supported capabilities are as follows.
3074
3075 @table @code
3076 @item error=
3077 @vindex error GCC_COLORS @r{capability}
3078 SGR substring for error: markers.
3079
3080 @item warning=
3081 @vindex warning GCC_COLORS @r{capability}
3082 SGR substring for warning: markers.
3083
3084 @item note=
3085 @vindex note GCC_COLORS @r{capability}
3086 SGR substring for note: markers.
3087
3088 @item caret=
3089 @vindex caret GCC_COLORS @r{capability}
3090 SGR substring for caret line.
3091
3092 @item locus=
3093 @vindex locus GCC_COLORS @r{capability}
3094 SGR substring for location information, @samp{file:line} or
3095 @samp{file:line:column} etc.
3096
3097 @item quote=
3098 @vindex quote GCC_COLORS @r{capability}
3099 SGR substring for information printed within quotes.
3100 @end table
3101
3102 @item -fno-diagnostics-show-option
3103 @opindex fno-diagnostics-show-option
3104 @opindex fdiagnostics-show-option
3105 By default, each diagnostic emitted includes text indicating the
3106 command-line option that directly controls the diagnostic (if such an
3107 option is known to the diagnostic machinery). Specifying the
3108 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3109
3110 @item -fno-diagnostics-show-caret
3111 @opindex fno-diagnostics-show-caret
3112 @opindex fdiagnostics-show-caret
3113 By default, each diagnostic emitted includes the original source line
3114 and a caret '^' indicating the column. This option suppresses this
3115 information.
3116
3117 @end table
3118
3119 @node Warning Options
3120 @section Options to Request or Suppress Warnings
3121 @cindex options to control warnings
3122 @cindex warning messages
3123 @cindex messages, warning
3124 @cindex suppressing warnings
3125
3126 Warnings are diagnostic messages that report constructions that
3127 are not inherently erroneous but that are risky or suggest there
3128 may have been an error.
3129
3130 The following language-independent options do not enable specific
3131 warnings but control the kinds of diagnostics produced by GCC@.
3132
3133 @table @gcctabopt
3134 @cindex syntax checking
3135 @item -fsyntax-only
3136 @opindex fsyntax-only
3137 Check the code for syntax errors, but don't do anything beyond that.
3138
3139 @item -fmax-errors=@var{n}
3140 @opindex fmax-errors
3141 Limits the maximum number of error messages to @var{n}, at which point
3142 GCC bails out rather than attempting to continue processing the source
3143 code. If @var{n} is 0 (the default), there is no limit on the number
3144 of error messages produced. If @option{-Wfatal-errors} is also
3145 specified, then @option{-Wfatal-errors} takes precedence over this
3146 option.
3147
3148 @item -w
3149 @opindex w
3150 Inhibit all warning messages.
3151
3152 @item -Werror
3153 @opindex Werror
3154 @opindex Wno-error
3155 Make all warnings into errors.
3156
3157 @item -Werror=
3158 @opindex Werror=
3159 @opindex Wno-error=
3160 Make the specified warning into an error. The specifier for a warning
3161 is appended; for example @option{-Werror=switch} turns the warnings
3162 controlled by @option{-Wswitch} into errors. This switch takes a
3163 negative form, to be used to negate @option{-Werror} for specific
3164 warnings; for example @option{-Wno-error=switch} makes
3165 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3166 is in effect.
3167
3168 The warning message for each controllable warning includes the
3169 option that controls the warning. That option can then be used with
3170 @option{-Werror=} and @option{-Wno-error=} as described above.
3171 (Printing of the option in the warning message can be disabled using the
3172 @option{-fno-diagnostics-show-option} flag.)
3173
3174 Note that specifying @option{-Werror=}@var{foo} automatically implies
3175 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
3176 imply anything.
3177
3178 @item -Wfatal-errors
3179 @opindex Wfatal-errors
3180 @opindex Wno-fatal-errors
3181 This option causes the compiler to abort compilation on the first error
3182 occurred rather than trying to keep going and printing further error
3183 messages.
3184
3185 @end table
3186
3187 You can request many specific warnings with options beginning with
3188 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3189 implicit declarations. Each of these specific warning options also
3190 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3191 example, @option{-Wno-implicit}. This manual lists only one of the
3192 two forms, whichever is not the default. For further
3193 language-specific options also refer to @ref{C++ Dialect Options} and
3194 @ref{Objective-C and Objective-C++ Dialect Options}.
3195
3196 When an unrecognized warning option is requested (e.g.,
3197 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3198 that the option is not recognized. However, if the @option{-Wno-} form
3199 is used, the behavior is slightly different: no diagnostic is
3200 produced for @option{-Wno-unknown-warning} unless other diagnostics
3201 are being produced. This allows the use of new @option{-Wno-} options
3202 with old compilers, but if something goes wrong, the compiler
3203 warns that an unrecognized option is present.
3204
3205 @table @gcctabopt
3206 @item -Wpedantic
3207 @itemx -pedantic
3208 @opindex pedantic
3209 @opindex Wpedantic
3210 Issue all the warnings demanded by strict ISO C and ISO C++;
3211 reject all programs that use forbidden extensions, and some other
3212 programs that do not follow ISO C and ISO C++. For ISO C, follows the
3213 version of the ISO C standard specified by any @option{-std} option used.
3214
3215 Valid ISO C and ISO C++ programs should compile properly with or without
3216 this option (though a rare few require @option{-ansi} or a
3217 @option{-std} option specifying the required version of ISO C)@. However,
3218 without this option, certain GNU extensions and traditional C and C++
3219 features are supported as well. With this option, they are rejected.
3220
3221 @option{-Wpedantic} does not cause warning messages for use of the
3222 alternate keywords whose names begin and end with @samp{__}. Pedantic
3223 warnings are also disabled in the expression that follows
3224 @code{__extension__}. However, only system header files should use
3225 these escape routes; application programs should avoid them.
3226 @xref{Alternate Keywords}.
3227
3228 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3229 C conformance. They soon find that it does not do quite what they want:
3230 it finds some non-ISO practices, but not all---only those for which
3231 ISO C @emph{requires} a diagnostic, and some others for which
3232 diagnostics have been added.
3233
3234 A feature to report any failure to conform to ISO C might be useful in
3235 some instances, but would require considerable additional work and would
3236 be quite different from @option{-Wpedantic}. We don't have plans to
3237 support such a feature in the near future.
3238
3239 Where the standard specified with @option{-std} represents a GNU
3240 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3241 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3242 extended dialect is based. Warnings from @option{-Wpedantic} are given
3243 where they are required by the base standard. (It does not make sense
3244 for such warnings to be given only for features not in the specified GNU
3245 C dialect, since by definition the GNU dialects of C include all
3246 features the compiler supports with the given option, and there would be
3247 nothing to warn about.)
3248
3249 @item -pedantic-errors
3250 @opindex pedantic-errors
3251 Like @option{-Wpedantic}, except that errors are produced rather than
3252 warnings.
3253
3254 @item -Wall
3255 @opindex Wall
3256 @opindex Wno-all
3257 This enables all the warnings about constructions that some users
3258 consider questionable, and that are easy to avoid (or modify to
3259 prevent the warning), even in conjunction with macros. This also
3260 enables some language-specific warnings described in @ref{C++ Dialect
3261 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3262
3263 @option{-Wall} turns on the following warning flags:
3264
3265 @gccoptlist{-Waddress @gol
3266 -Warray-bounds @r{(only with} @option{-O2}@r{)} @gol
3267 -Wc++11-compat @gol
3268 -Wchar-subscripts @gol
3269 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3270 -Wimplicit-int @r{(C and Objective-C only)} @gol
3271 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3272 -Wcomment @gol
3273 -Wformat @gol
3274 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} @gol
3275 -Wmaybe-uninitialized @gol
3276 -Wmissing-braces @r{(only for C/ObjC)} @gol
3277 -Wnonnull @gol
3278 -Wparentheses @gol
3279 -Wpointer-sign @gol
3280 -Wreorder @gol
3281 -Wreturn-type @gol
3282 -Wsequence-point @gol
3283 -Wsign-compare @r{(only in C++)} @gol
3284 -Wstrict-aliasing @gol
3285 -Wstrict-overflow=1 @gol
3286 -Wswitch @gol
3287 -Wtrigraphs @gol
3288 -Wuninitialized @gol
3289 -Wunknown-pragmas @gol
3290 -Wunused-function @gol
3291 -Wunused-label @gol
3292 -Wunused-value @gol
3293 -Wunused-variable @gol
3294 -Wvolatile-register-var @gol
3295 }
3296
3297 Note that some warning flags are not implied by @option{-Wall}. Some of
3298 them warn about constructions that users generally do not consider
3299 questionable, but which occasionally you might wish to check for;
3300 others warn about constructions that are necessary or hard to avoid in
3301 some cases, and there is no simple way to modify the code to suppress
3302 the warning. Some of them are enabled by @option{-Wextra} but many of
3303 them must be enabled individually.
3304
3305 @item -Wextra
3306 @opindex W
3307 @opindex Wextra
3308 @opindex Wno-extra
3309 This enables some extra warning flags that are not enabled by
3310 @option{-Wall}. (This option used to be called @option{-W}. The older
3311 name is still supported, but the newer name is more descriptive.)
3312
3313 @gccoptlist{-Wclobbered @gol
3314 -Wempty-body @gol
3315 -Wignored-qualifiers @gol
3316 -Wmissing-field-initializers @gol
3317 -Wmissing-parameter-type @r{(C only)} @gol
3318 -Wold-style-declaration @r{(C only)} @gol
3319 -Woverride-init @gol
3320 -Wsign-compare @gol
3321 -Wtype-limits @gol
3322 -Wuninitialized @gol
3323 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3324 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3325 }
3326
3327 The option @option{-Wextra} also prints warning messages for the
3328 following cases:
3329
3330 @itemize @bullet
3331
3332 @item
3333 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3334 @samp{>}, or @samp{>=}.
3335
3336 @item
3337 (C++ only) An enumerator and a non-enumerator both appear in a
3338 conditional expression.
3339
3340 @item
3341 (C++ only) Ambiguous virtual bases.
3342
3343 @item
3344 (C++ only) Subscripting an array that has been declared @samp{register}.
3345
3346 @item
3347 (C++ only) Taking the address of a variable that has been declared
3348 @samp{register}.
3349
3350 @item
3351 (C++ only) A base class is not initialized in a derived class's copy
3352 constructor.
3353
3354 @end itemize
3355
3356 @item -Wchar-subscripts
3357 @opindex Wchar-subscripts
3358 @opindex Wno-char-subscripts
3359 Warn if an array subscript has type @code{char}. This is a common cause
3360 of error, as programmers often forget that this type is signed on some
3361 machines.
3362 This warning is enabled by @option{-Wall}.
3363
3364 @item -Wcomment
3365 @opindex Wcomment
3366 @opindex Wno-comment
3367 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3368 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3369 This warning is enabled by @option{-Wall}.
3370
3371 @item -Wno-coverage-mismatch
3372 @opindex Wno-coverage-mismatch
3373 Warn if feedback profiles do not match when using the
3374 @option{-fprofile-use} option.
3375 If a source file is changed between compiling with @option{-fprofile-gen} and
3376 with @option{-fprofile-use}, the files with the profile feedback can fail
3377 to match the source file and GCC cannot use the profile feedback
3378 information. By default, this warning is enabled and is treated as an
3379 error. @option{-Wno-coverage-mismatch} can be used to disable the
3380 warning or @option{-Wno-error=coverage-mismatch} can be used to
3381 disable the error. Disabling the error for this warning can result in
3382 poorly optimized code and is useful only in the
3383 case of very minor changes such as bug fixes to an existing code-base.
3384 Completely disabling the warning is not recommended.
3385
3386 @item -Wno-cpp
3387 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3388
3389 Suppress warning messages emitted by @code{#warning} directives.
3390
3391 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3392 @opindex Wdouble-promotion
3393 @opindex Wno-double-promotion
3394 Give a warning when a value of type @code{float} is implicitly
3395 promoted to @code{double}. CPUs with a 32-bit ``single-precision''
3396 floating-point unit implement @code{float} in hardware, but emulate
3397 @code{double} in software. On such a machine, doing computations
3398 using @code{double} values is much more expensive because of the
3399 overhead required for software emulation.
3400
3401 It is easy to accidentally do computations with @code{double} because
3402 floating-point literals are implicitly of type @code{double}. For
3403 example, in:
3404 @smallexample
3405 @group
3406 float area(float radius)
3407 @{
3408 return 3.14159 * radius * radius;
3409 @}
3410 @end group
3411 @end smallexample
3412 the compiler performs the entire computation with @code{double}
3413 because the floating-point literal is a @code{double}.
3414
3415 @item -Wformat
3416 @itemx -Wformat=@var{n}
3417 @opindex Wformat
3418 @opindex Wno-format
3419 @opindex ffreestanding
3420 @opindex fno-builtin
3421 @opindex Wformat=
3422 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3423 the arguments supplied have types appropriate to the format string
3424 specified, and that the conversions specified in the format string make
3425 sense. This includes standard functions, and others specified by format
3426 attributes (@pxref{Function Attributes}), in the @code{printf},
3427 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3428 not in the C standard) families (or other target-specific families).
3429 Which functions are checked without format attributes having been
3430 specified depends on the standard version selected, and such checks of
3431 functions without the attribute specified are disabled by
3432 @option{-ffreestanding} or @option{-fno-builtin}.
3433
3434 The formats are checked against the format features supported by GNU
3435 libc version 2.2. These include all ISO C90 and C99 features, as well
3436 as features from the Single Unix Specification and some BSD and GNU
3437 extensions. Other library implementations may not support all these
3438 features; GCC does not support warning about features that go beyond a
3439 particular library's limitations. However, if @option{-Wpedantic} is used
3440 with @option{-Wformat}, warnings are given about format features not
3441 in the selected standard version (but not for @code{strfmon} formats,
3442 since those are not in any version of the C standard). @xref{C Dialect
3443 Options,,Options Controlling C Dialect}.
3444
3445 @table @gcctabopt
3446 @item -Wformat=1
3447 @itemx -Wformat
3448 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3449 @option{-Wno-format} is equivalent to @option{-Wformat=0}. Since
3450 @option{-Wformat} also checks for null format arguments for several
3451 functions, @option{-Wformat} also implies @option{-Wnonnull}. Some
3452 aspects of this level of format checking can be disabled by the
3453 options: @option{-Wno-format-contains-nul},
3454 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3455 @option{-Wformat} is enabled by @option{-Wall}.
3456
3457 @item -Wno-format-contains-nul
3458 @opindex Wno-format-contains-nul
3459 @opindex Wformat-contains-nul
3460 If @option{-Wformat} is specified, do not warn about format strings that
3461 contain NUL bytes.
3462
3463 @item -Wno-format-extra-args
3464 @opindex Wno-format-extra-args
3465 @opindex Wformat-extra-args
3466 If @option{-Wformat} is specified, do not warn about excess arguments to a
3467 @code{printf} or @code{scanf} format function. The C standard specifies
3468 that such arguments are ignored.
3469
3470 Where the unused arguments lie between used arguments that are
3471 specified with @samp{$} operand number specifications, normally
3472 warnings are still given, since the implementation could not know what
3473 type to pass to @code{va_arg} to skip the unused arguments. However,
3474 in the case of @code{scanf} formats, this option suppresses the
3475 warning if the unused arguments are all pointers, since the Single
3476 Unix Specification says that such unused arguments are allowed.
3477
3478 @item -Wno-format-zero-length
3479 @opindex Wno-format-zero-length
3480 @opindex Wformat-zero-length
3481 If @option{-Wformat} is specified, do not warn about zero-length formats.
3482 The C standard specifies that zero-length formats are allowed.
3483
3484
3485 @item -Wformat=2
3486 Enable @option{-Wformat} plus additional format checks. Currently
3487 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3488 -Wformat-y2k}.
3489
3490 @item -Wformat-nonliteral
3491 @opindex Wformat-nonliteral
3492 @opindex Wno-format-nonliteral
3493 If @option{-Wformat} is specified, also warn if the format string is not a
3494 string literal and so cannot be checked, unless the format function
3495 takes its format arguments as a @code{va_list}.
3496
3497 @item -Wformat-security
3498 @opindex Wformat-security
3499 @opindex Wno-format-security
3500 If @option{-Wformat} is specified, also warn about uses of format
3501 functions that represent possible security problems. At present, this
3502 warns about calls to @code{printf} and @code{scanf} functions where the
3503 format string is not a string literal and there are no format arguments,
3504 as in @code{printf (foo);}. This may be a security hole if the format
3505 string came from untrusted input and contains @samp{%n}. (This is
3506 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3507 in future warnings may be added to @option{-Wformat-security} that are not
3508 included in @option{-Wformat-nonliteral}.)
3509
3510 @item -Wformat-y2k
3511 @opindex Wformat-y2k
3512 @opindex Wno-format-y2k
3513 If @option{-Wformat} is specified, also warn about @code{strftime}
3514 formats that may yield only a two-digit year.
3515 @end table
3516
3517 @item -Wnonnull
3518 @opindex Wnonnull
3519 @opindex Wno-nonnull
3520 Warn about passing a null pointer for arguments marked as
3521 requiring a non-null value by the @code{nonnull} function attribute.
3522
3523 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
3524 can be disabled with the @option{-Wno-nonnull} option.
3525
3526 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3527 @opindex Winit-self
3528 @opindex Wno-init-self
3529 Warn about uninitialized variables that are initialized with themselves.
3530 Note this option can only be used with the @option{-Wuninitialized} option.
3531
3532 For example, GCC warns about @code{i} being uninitialized in the
3533 following snippet only when @option{-Winit-self} has been specified:
3534 @smallexample
3535 @group
3536 int f()
3537 @{
3538 int i = i;
3539 return i;
3540 @}
3541 @end group
3542 @end smallexample
3543
3544 This warning is enabled by @option{-Wall} in C++.
3545
3546 @item -Wimplicit-int @r{(C and Objective-C only)}
3547 @opindex Wimplicit-int
3548 @opindex Wno-implicit-int
3549 Warn when a declaration does not specify a type.
3550 This warning is enabled by @option{-Wall}.
3551
3552 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3553 @opindex Wimplicit-function-declaration
3554 @opindex Wno-implicit-function-declaration
3555 Give a warning whenever a function is used before being declared. In
3556 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3557 enabled by default and it is made into an error by
3558 @option{-pedantic-errors}. This warning is also enabled by
3559 @option{-Wall}.
3560
3561 @item -Wimplicit @r{(C and Objective-C only)}
3562 @opindex Wimplicit
3563 @opindex Wno-implicit
3564 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3565 This warning is enabled by @option{-Wall}.
3566
3567 @item -Wignored-qualifiers @r{(C and C++ only)}
3568 @opindex Wignored-qualifiers
3569 @opindex Wno-ignored-qualifiers
3570 Warn if the return type of a function has a type qualifier
3571 such as @code{const}. For ISO C such a type qualifier has no effect,
3572 since the value returned by a function is not an lvalue.
3573 For C++, the warning is only emitted for scalar types or @code{void}.
3574 ISO C prohibits qualified @code{void} return types on function
3575 definitions, so such return types always receive a warning
3576 even without this option.
3577
3578 This warning is also enabled by @option{-Wextra}.
3579
3580 @item -Wmain
3581 @opindex Wmain
3582 @opindex Wno-main
3583 Warn if the type of @samp{main} is suspicious. @samp{main} should be
3584 a function with external linkage, returning int, taking either zero
3585 arguments, two, or three arguments of appropriate types. This warning
3586 is enabled by default in C++ and is enabled by either @option{-Wall}
3587 or @option{-Wpedantic}.
3588
3589 @item -Wmissing-braces
3590 @opindex Wmissing-braces
3591 @opindex Wno-missing-braces
3592 Warn if an aggregate or union initializer is not fully bracketed. In
3593 the following example, the initializer for @samp{a} is not fully
3594 bracketed, but that for @samp{b} is fully bracketed. This warning is
3595 enabled by @option{-Wall} in C.
3596
3597 @smallexample
3598 int a[2][2] = @{ 0, 1, 2, 3 @};
3599 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3600 @end smallexample
3601
3602 This warning is enabled by @option{-Wall}.
3603
3604 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3605 @opindex Wmissing-include-dirs
3606 @opindex Wno-missing-include-dirs
3607 Warn if a user-supplied include directory does not exist.
3608
3609 @item -Wparentheses
3610 @opindex Wparentheses
3611 @opindex Wno-parentheses
3612 Warn if parentheses are omitted in certain contexts, such
3613 as when there is an assignment in a context where a truth value
3614 is expected, or when operators are nested whose precedence people
3615 often get confused about.
3616
3617 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3618 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3619 interpretation from that of ordinary mathematical notation.
3620
3621 Also warn about constructions where there may be confusion to which
3622 @code{if} statement an @code{else} branch belongs. Here is an example of
3623 such a case:
3624
3625 @smallexample
3626 @group
3627 @{
3628 if (a)
3629 if (b)
3630 foo ();
3631 else
3632 bar ();
3633 @}
3634 @end group
3635 @end smallexample
3636
3637 In C/C++, every @code{else} branch belongs to the innermost possible
3638 @code{if} statement, which in this example is @code{if (b)}. This is
3639 often not what the programmer expected, as illustrated in the above
3640 example by indentation the programmer chose. When there is the
3641 potential for this confusion, GCC issues a warning when this flag
3642 is specified. To eliminate the warning, add explicit braces around
3643 the innermost @code{if} statement so there is no way the @code{else}
3644 can belong to the enclosing @code{if}. The resulting code
3645 looks like this:
3646
3647 @smallexample
3648 @group
3649 @{
3650 if (a)
3651 @{
3652 if (b)
3653 foo ();
3654 else
3655 bar ();
3656 @}
3657 @}
3658 @end group
3659 @end smallexample
3660
3661 Also warn for dangerous uses of the GNU extension to
3662 @code{?:} with omitted middle operand. When the condition
3663 in the @code{?}: operator is a boolean expression, the omitted value is
3664 always 1. Often programmers expect it to be a value computed
3665 inside the conditional expression instead.
3666
3667 This warning is enabled by @option{-Wall}.
3668
3669 @item -Wsequence-point
3670 @opindex Wsequence-point
3671 @opindex Wno-sequence-point
3672 Warn about code that may have undefined semantics because of violations
3673 of sequence point rules in the C and C++ standards.
3674
3675 The C and C++ standards define the order in which expressions in a C/C++
3676 program are evaluated in terms of @dfn{sequence points}, which represent
3677 a partial ordering between the execution of parts of the program: those
3678 executed before the sequence point, and those executed after it. These
3679 occur after the evaluation of a full expression (one which is not part
3680 of a larger expression), after the evaluation of the first operand of a
3681 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3682 function is called (but after the evaluation of its arguments and the
3683 expression denoting the called function), and in certain other places.
3684 Other than as expressed by the sequence point rules, the order of
3685 evaluation of subexpressions of an expression is not specified. All
3686 these rules describe only a partial order rather than a total order,
3687 since, for example, if two functions are called within one expression
3688 with no sequence point between them, the order in which the functions
3689 are called is not specified. However, the standards committee have
3690 ruled that function calls do not overlap.
3691
3692 It is not specified when between sequence points modifications to the
3693 values of objects take effect. Programs whose behavior depends on this
3694 have undefined behavior; the C and C++ standards specify that ``Between
3695 the previous and next sequence point an object shall have its stored
3696 value modified at most once by the evaluation of an expression.
3697 Furthermore, the prior value shall be read only to determine the value
3698 to be stored.''. If a program breaks these rules, the results on any
3699 particular implementation are entirely unpredictable.
3700
3701 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3702 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
3703 diagnosed by this option, and it may give an occasional false positive
3704 result, but in general it has been found fairly effective at detecting
3705 this sort of problem in programs.
3706
3707 The standard is worded confusingly, therefore there is some debate
3708 over the precise meaning of the sequence point rules in subtle cases.
3709 Links to discussions of the problem, including proposed formal
3710 definitions, may be found on the GCC readings page, at
3711 @uref{http://gcc.gnu.org/@/readings.html}.
3712
3713 This warning is enabled by @option{-Wall} for C and C++.
3714
3715 @item -Wno-return-local-addr
3716 @opindex Wno-return-local-addr
3717 @opindex Wreturn-local-addr
3718 Do not warn about returning a pointer (or in C++, a reference) to a
3719 variable that goes out of scope after the function returns.
3720
3721 @item -Wreturn-type
3722 @opindex Wreturn-type
3723 @opindex Wno-return-type
3724 Warn whenever a function is defined with a return type that defaults
3725 to @code{int}. Also warn about any @code{return} statement with no
3726 return value in a function whose return type is not @code{void}
3727 (falling off the end of the function body is considered returning
3728 without a value), and about a @code{return} statement with an
3729 expression in a function whose return type is @code{void}.
3730
3731 For C++, a function without return type always produces a diagnostic
3732 message, even when @option{-Wno-return-type} is specified. The only
3733 exceptions are @samp{main} and functions defined in system headers.
3734
3735 This warning is enabled by @option{-Wall}.
3736
3737 @item -Wswitch
3738 @opindex Wswitch
3739 @opindex Wno-switch
3740 Warn whenever a @code{switch} statement has an index of enumerated type
3741 and lacks a @code{case} for one or more of the named codes of that
3742 enumeration. (The presence of a @code{default} label prevents this
3743 warning.) @code{case} labels outside the enumeration range also
3744 provoke warnings when this option is used (even if there is a
3745 @code{default} label).
3746 This warning is enabled by @option{-Wall}.
3747
3748 @item -Wswitch-default
3749 @opindex Wswitch-default
3750 @opindex Wno-switch-default
3751 Warn whenever a @code{switch} statement does not have a @code{default}
3752 case.
3753
3754 @item -Wswitch-enum
3755 @opindex Wswitch-enum
3756 @opindex Wno-switch-enum
3757 Warn whenever a @code{switch} statement has an index of enumerated type
3758 and lacks a @code{case} for one or more of the named codes of that
3759 enumeration. @code{case} labels outside the enumeration range also
3760 provoke warnings when this option is used. The only difference
3761 between @option{-Wswitch} and this option is that this option gives a
3762 warning about an omitted enumeration code even if there is a
3763 @code{default} label.
3764
3765 @item -Wsync-nand @r{(C and C++ only)}
3766 @opindex Wsync-nand
3767 @opindex Wno-sync-nand
3768 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3769 built-in functions are used. These functions changed semantics in GCC 4.4.
3770
3771 @item -Wtrigraphs
3772 @opindex Wtrigraphs
3773 @opindex Wno-trigraphs
3774 Warn if any trigraphs are encountered that might change the meaning of
3775 the program (trigraphs within comments are not warned about).
3776 This warning is enabled by @option{-Wall}.
3777
3778 @item -Wunused-but-set-parameter
3779 @opindex Wunused-but-set-parameter
3780 @opindex Wno-unused-but-set-parameter
3781 Warn whenever a function parameter is assigned to, but otherwise unused
3782 (aside from its declaration).
3783
3784 To suppress this warning use the @samp{unused} attribute
3785 (@pxref{Variable Attributes}).
3786
3787 This warning is also enabled by @option{-Wunused} together with
3788 @option{-Wextra}.
3789
3790 @item -Wunused-but-set-variable
3791 @opindex Wunused-but-set-variable
3792 @opindex Wno-unused-but-set-variable
3793 Warn whenever a local variable is assigned to, but otherwise unused
3794 (aside from its declaration).
3795 This warning is enabled by @option{-Wall}.
3796
3797 To suppress this warning use the @samp{unused} attribute
3798 (@pxref{Variable Attributes}).
3799
3800 This warning is also enabled by @option{-Wunused}, which is enabled
3801 by @option{-Wall}.
3802
3803 @item -Wunused-function
3804 @opindex Wunused-function
3805 @opindex Wno-unused-function
3806 Warn whenever a static function is declared but not defined or a
3807 non-inline static function is unused.
3808 This warning is enabled by @option{-Wall}.
3809
3810 @item -Wunused-label
3811 @opindex Wunused-label
3812 @opindex Wno-unused-label
3813 Warn whenever a label is declared but not used.
3814 This warning is enabled by @option{-Wall}.
3815
3816 To suppress this warning use the @samp{unused} attribute
3817 (@pxref{Variable Attributes}).
3818
3819 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3820 @opindex Wunused-local-typedefs
3821 Warn when a typedef locally defined in a function is not used.
3822 This warning is enabled by @option{-Wall}.
3823
3824 @item -Wunused-parameter
3825 @opindex Wunused-parameter
3826 @opindex Wno-unused-parameter
3827 Warn whenever a function parameter is unused aside from its declaration.
3828
3829 To suppress this warning use the @samp{unused} attribute
3830 (@pxref{Variable Attributes}).
3831
3832 @item -Wno-unused-result
3833 @opindex Wunused-result
3834 @opindex Wno-unused-result
3835 Do not warn if a caller of a function marked with attribute
3836 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3837 its return value. The default is @option{-Wunused-result}.
3838
3839 @item -Wunused-variable
3840 @opindex Wunused-variable
3841 @opindex Wno-unused-variable
3842 Warn whenever a local variable or non-constant static variable is unused
3843 aside from its declaration.
3844 This warning is enabled by @option{-Wall}.
3845
3846 To suppress this warning use the @samp{unused} attribute
3847 (@pxref{Variable Attributes}).
3848
3849 @item -Wunused-value
3850 @opindex Wunused-value
3851 @opindex Wno-unused-value
3852 Warn whenever a statement computes a result that is explicitly not
3853 used. To suppress this warning cast the unused expression to
3854 @samp{void}. This includes an expression-statement or the left-hand
3855 side of a comma expression that contains no side effects. For example,
3856 an expression such as @samp{x[i,j]} causes a warning, while
3857 @samp{x[(void)i,j]} does not.
3858
3859 This warning is enabled by @option{-Wall}.
3860
3861 @item -Wunused
3862 @opindex Wunused
3863 @opindex Wno-unused
3864 All the above @option{-Wunused} options combined.
3865
3866 In order to get a warning about an unused function parameter, you must
3867 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3868 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3869
3870 @item -Wuninitialized
3871 @opindex Wuninitialized
3872 @opindex Wno-uninitialized
3873 Warn if an automatic variable is used without first being initialized
3874 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3875 warn if a non-static reference or non-static @samp{const} member
3876 appears in a class without constructors.
3877
3878 If you want to warn about code that uses the uninitialized value of the
3879 variable in its own initializer, use the @option{-Winit-self} option.
3880
3881 These warnings occur for individual uninitialized or clobbered
3882 elements of structure, union or array variables as well as for
3883 variables that are uninitialized or clobbered as a whole. They do
3884 not occur for variables or elements declared @code{volatile}. Because
3885 these warnings depend on optimization, the exact variables or elements
3886 for which there are warnings depends on the precise optimization
3887 options and version of GCC used.
3888
3889 Note that there may be no warning about a variable that is used only
3890 to compute a value that itself is never used, because such
3891 computations may be deleted by data flow analysis before the warnings
3892 are printed.
3893
3894 @item -Wmaybe-uninitialized
3895 @opindex Wmaybe-uninitialized
3896 @opindex Wno-maybe-uninitialized
3897 For an automatic variable, if there exists a path from the function
3898 entry to a use of the variable that is initialized, but there exist
3899 some other paths for which the variable is not initialized, the compiler
3900 emits a warning if it cannot prove the uninitialized paths are not
3901 executed at run time. These warnings are made optional because GCC is
3902 not smart enough to see all the reasons why the code might be correct
3903 in spite of appearing to have an error. Here is one example of how
3904 this can happen:
3905
3906 @smallexample
3907 @group
3908 @{
3909 int x;
3910 switch (y)
3911 @{
3912 case 1: x = 1;
3913 break;
3914 case 2: x = 4;
3915 break;
3916 case 3: x = 5;
3917 @}
3918 foo (x);
3919 @}
3920 @end group
3921 @end smallexample
3922
3923 @noindent
3924 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3925 always initialized, but GCC doesn't know this. To suppress the
3926 warning, you need to provide a default case with assert(0) or
3927 similar code.
3928
3929 @cindex @code{longjmp} warnings
3930 This option also warns when a non-volatile automatic variable might be
3931 changed by a call to @code{longjmp}. These warnings as well are possible
3932 only in optimizing compilation.
3933
3934 The compiler sees only the calls to @code{setjmp}. It cannot know
3935 where @code{longjmp} will be called; in fact, a signal handler could
3936 call it at any point in the code. As a result, you may get a warning
3937 even when there is in fact no problem because @code{longjmp} cannot
3938 in fact be called at the place that would cause a problem.
3939
3940 Some spurious warnings can be avoided if you declare all the functions
3941 you use that never return as @code{noreturn}. @xref{Function
3942 Attributes}.
3943
3944 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3945
3946 @item -Wunknown-pragmas
3947 @opindex Wunknown-pragmas
3948 @opindex Wno-unknown-pragmas
3949 @cindex warning for unknown pragmas
3950 @cindex unknown pragmas, warning
3951 @cindex pragmas, warning of unknown
3952 Warn when a @code{#pragma} directive is encountered that is not understood by
3953 GCC@. If this command-line option is used, warnings are even issued
3954 for unknown pragmas in system header files. This is not the case if
3955 the warnings are only enabled by the @option{-Wall} command-line option.
3956
3957 @item -Wno-pragmas
3958 @opindex Wno-pragmas
3959 @opindex Wpragmas
3960 Do not warn about misuses of pragmas, such as incorrect parameters,
3961 invalid syntax, or conflicts between pragmas. See also
3962 @option{-Wunknown-pragmas}.
3963
3964 @item -Wstrict-aliasing
3965 @opindex Wstrict-aliasing
3966 @opindex Wno-strict-aliasing
3967 This option is only active when @option{-fstrict-aliasing} is active.
3968 It warns about code that might break the strict aliasing rules that the
3969 compiler is using for optimization. The warning does not catch all
3970 cases, but does attempt to catch the more common pitfalls. It is
3971 included in @option{-Wall}.
3972 It is equivalent to @option{-Wstrict-aliasing=3}
3973
3974 @item -Wstrict-aliasing=n
3975 @opindex Wstrict-aliasing=n
3976 This option is only active when @option{-fstrict-aliasing} is active.
3977 It warns about code that might break the strict aliasing rules that the
3978 compiler is using for optimization.
3979 Higher levels correspond to higher accuracy (fewer false positives).
3980 Higher levels also correspond to more effort, similar to the way @option{-O}
3981 works.
3982 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3983
3984 Level 1: Most aggressive, quick, least accurate.
3985 Possibly useful when higher levels
3986 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3987 false negatives. However, it has many false positives.
3988 Warns for all pointer conversions between possibly incompatible types,
3989 even if never dereferenced. Runs in the front end only.
3990
3991 Level 2: Aggressive, quick, not too precise.
3992 May still have many false positives (not as many as level 1 though),
3993 and few false negatives (but possibly more than level 1).
3994 Unlike level 1, it only warns when an address is taken. Warns about
3995 incomplete types. Runs in the front end only.
3996
3997 Level 3 (default for @option{-Wstrict-aliasing}):
3998 Should have very few false positives and few false
3999 negatives. Slightly slower than levels 1 or 2 when optimization is enabled.
4000 Takes care of the common pun+dereference pattern in the front end:
4001 @code{*(int*)&some_float}.
4002 If optimization is enabled, it also runs in the back end, where it deals
4003 with multiple statement cases using flow-sensitive points-to information.
4004 Only warns when the converted pointer is dereferenced.
4005 Does not warn about incomplete types.
4006
4007 @item -Wstrict-overflow
4008 @itemx -Wstrict-overflow=@var{n}
4009 @opindex Wstrict-overflow
4010 @opindex Wno-strict-overflow
4011 This option is only active when @option{-fstrict-overflow} is active.
4012 It warns about cases where the compiler optimizes based on the
4013 assumption that signed overflow does not occur. Note that it does not
4014 warn about all cases where the code might overflow: it only warns
4015 about cases where the compiler implements some optimization. Thus
4016 this warning depends on the optimization level.
4017
4018 An optimization that assumes that signed overflow does not occur is
4019 perfectly safe if the values of the variables involved are such that
4020 overflow never does, in fact, occur. Therefore this warning can
4021 easily give a false positive: a warning about code that is not
4022 actually a problem. To help focus on important issues, several
4023 warning levels are defined. No warnings are issued for the use of
4024 undefined signed overflow when estimating how many iterations a loop
4025 requires, in particular when determining whether a loop will be
4026 executed at all.
4027
4028 @table @gcctabopt
4029 @item -Wstrict-overflow=1
4030 Warn about cases that are both questionable and easy to avoid. For
4031 example, with @option{-fstrict-overflow}, the compiler simplifies
4032 @code{x + 1 > x} to @code{1}. This level of
4033 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4034 are not, and must be explicitly requested.
4035
4036 @item -Wstrict-overflow=2
4037 Also warn about other cases where a comparison is simplified to a
4038 constant. For example: @code{abs (x) >= 0}. This can only be
4039 simplified when @option{-fstrict-overflow} is in effect, because
4040 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4041 zero. @option{-Wstrict-overflow} (with no level) is the same as
4042 @option{-Wstrict-overflow=2}.
4043
4044 @item -Wstrict-overflow=3
4045 Also warn about other cases where a comparison is simplified. For
4046 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4047
4048 @item -Wstrict-overflow=4
4049 Also warn about other simplifications not covered by the above cases.
4050 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4051
4052 @item -Wstrict-overflow=5
4053 Also warn about cases where the compiler reduces the magnitude of a
4054 constant involved in a comparison. For example: @code{x + 2 > y} is
4055 simplified to @code{x + 1 >= y}. This is reported only at the
4056 highest warning level because this simplification applies to many
4057 comparisons, so this warning level gives a very large number of
4058 false positives.
4059 @end table
4060
4061 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4062 @opindex Wsuggest-attribute=
4063 @opindex Wno-suggest-attribute=
4064 Warn for cases where adding an attribute may be beneficial. The
4065 attributes currently supported are listed below.
4066
4067 @table @gcctabopt
4068 @item -Wsuggest-attribute=pure
4069 @itemx -Wsuggest-attribute=const
4070 @itemx -Wsuggest-attribute=noreturn
4071 @opindex Wsuggest-attribute=pure
4072 @opindex Wno-suggest-attribute=pure
4073 @opindex Wsuggest-attribute=const
4074 @opindex Wno-suggest-attribute=const
4075 @opindex Wsuggest-attribute=noreturn
4076 @opindex Wno-suggest-attribute=noreturn
4077
4078 Warn about functions that might be candidates for attributes
4079 @code{pure}, @code{const} or @code{noreturn}. The compiler only warns for
4080 functions visible in other compilation units or (in the case of @code{pure} and
4081 @code{const}) if it cannot prove that the function returns normally. A function
4082 returns normally if it doesn't contain an infinite loop or return abnormally
4083 by throwing, calling @code{abort()} or trapping. This analysis requires option
4084 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4085 higher. Higher optimization levels improve the accuracy of the analysis.
4086
4087 @item -Wsuggest-attribute=format
4088 @itemx -Wmissing-format-attribute
4089 @opindex Wsuggest-attribute=format
4090 @opindex Wmissing-format-attribute
4091 @opindex Wno-suggest-attribute=format
4092 @opindex Wno-missing-format-attribute
4093 @opindex Wformat
4094 @opindex Wno-format
4095
4096 Warn about function pointers that might be candidates for @code{format}
4097 attributes. Note these are only possible candidates, not absolute ones.
4098 GCC guesses that function pointers with @code{format} attributes that
4099 are used in assignment, initialization, parameter passing or return
4100 statements should have a corresponding @code{format} attribute in the
4101 resulting type. I.e.@: the left-hand side of the assignment or
4102 initialization, the type of the parameter variable, or the return type
4103 of the containing function respectively should also have a @code{format}
4104 attribute to avoid the warning.
4105
4106 GCC also warns about function definitions that might be
4107 candidates for @code{format} attributes. Again, these are only
4108 possible candidates. GCC guesses that @code{format} attributes
4109 might be appropriate for any function that calls a function like
4110 @code{vprintf} or @code{vscanf}, but this might not always be the
4111 case, and some functions for which @code{format} attributes are
4112 appropriate may not be detected.
4113 @end table
4114
4115 @item -Warray-bounds
4116 @opindex Wno-array-bounds
4117 @opindex Warray-bounds
4118 This option is only active when @option{-ftree-vrp} is active
4119 (default for @option{-O2} and above). It warns about subscripts to arrays
4120 that are always out of bounds. This warning is enabled by @option{-Wall}.
4121
4122 @item -Wno-div-by-zero
4123 @opindex Wno-div-by-zero
4124 @opindex Wdiv-by-zero
4125 Do not warn about compile-time integer division by zero. Floating-point
4126 division by zero is not warned about, as it can be a legitimate way of
4127 obtaining infinities and NaNs.
4128
4129 @item -Wsystem-headers
4130 @opindex Wsystem-headers
4131 @opindex Wno-system-headers
4132 @cindex warnings from system headers
4133 @cindex system headers, warnings from
4134 Print warning messages for constructs found in system header files.
4135 Warnings from system headers are normally suppressed, on the assumption
4136 that they usually do not indicate real problems and would only make the
4137 compiler output harder to read. Using this command-line option tells
4138 GCC to emit warnings from system headers as if they occurred in user
4139 code. However, note that using @option{-Wall} in conjunction with this
4140 option does @emph{not} warn about unknown pragmas in system
4141 headers---for that, @option{-Wunknown-pragmas} must also be used.
4142
4143 @item -Wtrampolines
4144 @opindex Wtrampolines
4145 @opindex Wno-trampolines
4146 Warn about trampolines generated for pointers to nested functions.
4147
4148 A trampoline is a small piece of data or code that is created at run
4149 time on the stack when the address of a nested function is taken, and
4150 is used to call the nested function indirectly. For some targets, it
4151 is made up of data only and thus requires no special treatment. But,
4152 for most targets, it is made up of code and thus requires the stack
4153 to be made executable in order for the program to work properly.
4154
4155 @item -Wfloat-equal
4156 @opindex Wfloat-equal
4157 @opindex Wno-float-equal
4158 Warn if floating-point values are used in equality comparisons.
4159
4160 The idea behind this is that sometimes it is convenient (for the
4161 programmer) to consider floating-point values as approximations to
4162 infinitely precise real numbers. If you are doing this, then you need
4163 to compute (by analyzing the code, or in some other way) the maximum or
4164 likely maximum error that the computation introduces, and allow for it
4165 when performing comparisons (and when producing output, but that's a
4166 different problem). In particular, instead of testing for equality, you
4167 should check to see whether the two values have ranges that overlap; and
4168 this is done with the relational operators, so equality comparisons are
4169 probably mistaken.
4170
4171 @item -Wtraditional @r{(C and Objective-C only)}
4172 @opindex Wtraditional
4173 @opindex Wno-traditional
4174 Warn about certain constructs that behave differently in traditional and
4175 ISO C@. Also warn about ISO C constructs that have no traditional C
4176 equivalent, and/or problematic constructs that should be avoided.
4177
4178 @itemize @bullet
4179 @item
4180 Macro parameters that appear within string literals in the macro body.
4181 In traditional C macro replacement takes place within string literals,
4182 but in ISO C it does not.
4183
4184 @item
4185 In traditional C, some preprocessor directives did not exist.
4186 Traditional preprocessors only considered a line to be a directive
4187 if the @samp{#} appeared in column 1 on the line. Therefore
4188 @option{-Wtraditional} warns about directives that traditional C
4189 understands but ignores because the @samp{#} does not appear as the
4190 first character on the line. It also suggests you hide directives like
4191 @samp{#pragma} not understood by traditional C by indenting them. Some
4192 traditional implementations do not recognize @samp{#elif}, so this option
4193 suggests avoiding it altogether.
4194
4195 @item
4196 A function-like macro that appears without arguments.
4197
4198 @item
4199 The unary plus operator.
4200
4201 @item
4202 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4203 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
4204 constants.) Note, these suffixes appear in macros defined in the system
4205 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4206 Use of these macros in user code might normally lead to spurious
4207 warnings, however GCC's integrated preprocessor has enough context to
4208 avoid warning in these cases.
4209
4210 @item
4211 A function declared external in one block and then used after the end of
4212 the block.
4213
4214 @item
4215 A @code{switch} statement has an operand of type @code{long}.
4216
4217 @item
4218 A non-@code{static} function declaration follows a @code{static} one.
4219 This construct is not accepted by some traditional C compilers.
4220
4221 @item
4222 The ISO type of an integer constant has a different width or
4223 signedness from its traditional type. This warning is only issued if
4224 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
4225 typically represent bit patterns, are not warned about.
4226
4227 @item
4228 Usage of ISO string concatenation is detected.
4229
4230 @item
4231 Initialization of automatic aggregates.
4232
4233 @item
4234 Identifier conflicts with labels. Traditional C lacks a separate
4235 namespace for labels.
4236
4237 @item
4238 Initialization of unions. If the initializer is zero, the warning is
4239 omitted. This is done under the assumption that the zero initializer in
4240 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4241 initializer warnings and relies on default initialization to zero in the
4242 traditional C case.
4243
4244 @item
4245 Conversions by prototypes between fixed/floating-point values and vice
4246 versa. The absence of these prototypes when compiling with traditional
4247 C causes serious problems. This is a subset of the possible
4248 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4249
4250 @item
4251 Use of ISO C style function definitions. This warning intentionally is
4252 @emph{not} issued for prototype declarations or variadic functions
4253 because these ISO C features appear in your code when using
4254 libiberty's traditional C compatibility macros, @code{PARAMS} and
4255 @code{VPARAMS}. This warning is also bypassed for nested functions
4256 because that feature is already a GCC extension and thus not relevant to
4257 traditional C compatibility.
4258 @end itemize
4259
4260 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4261 @opindex Wtraditional-conversion
4262 @opindex Wno-traditional-conversion
4263 Warn if a prototype causes a type conversion that is different from what
4264 would happen to the same argument in the absence of a prototype. This
4265 includes conversions of fixed point to floating and vice versa, and
4266 conversions changing the width or signedness of a fixed-point argument
4267 except when the same as the default promotion.
4268
4269 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4270 @opindex Wdeclaration-after-statement
4271 @opindex Wno-declaration-after-statement
4272 Warn when a declaration is found after a statement in a block. This
4273 construct, known from C++, was introduced with ISO C99 and is by default
4274 allowed in GCC@. It is not supported by ISO C90 and was not supported by
4275 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
4276
4277 @item -Wundef
4278 @opindex Wundef
4279 @opindex Wno-undef
4280 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4281
4282 @item -Wno-endif-labels
4283 @opindex Wno-endif-labels
4284 @opindex Wendif-labels
4285 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4286
4287 @item -Wshadow
4288 @opindex Wshadow
4289 @opindex Wno-shadow
4290 Warn whenever a local variable or type declaration shadows another variable,
4291 parameter, type, or class member (in C++), or whenever a built-in function
4292 is shadowed. Note that in C++, the compiler warns if a local variable
4293 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4294
4295 @item -Wlarger-than=@var{len}
4296 @opindex Wlarger-than=@var{len}
4297 @opindex Wlarger-than-@var{len}
4298 Warn whenever an object of larger than @var{len} bytes is defined.
4299
4300 @item -Wframe-larger-than=@var{len}
4301 @opindex Wframe-larger-than
4302 Warn if the size of a function frame is larger than @var{len} bytes.
4303 The computation done to determine the stack frame size is approximate
4304 and not conservative.
4305 The actual requirements may be somewhat greater than @var{len}
4306 even if you do not get a warning. In addition, any space allocated
4307 via @code{alloca}, variable-length arrays, or related constructs
4308 is not included by the compiler when determining
4309 whether or not to issue a warning.
4310
4311 @item -Wno-free-nonheap-object
4312 @opindex Wno-free-nonheap-object
4313 @opindex Wfree-nonheap-object
4314 Do not warn when attempting to free an object that was not allocated
4315 on the heap.
4316
4317 @item -Wstack-usage=@var{len}
4318 @opindex Wstack-usage
4319 Warn if the stack usage of a function might be larger than @var{len} bytes.
4320 The computation done to determine the stack usage is conservative.
4321 Any space allocated via @code{alloca}, variable-length arrays, or related
4322 constructs is included by the compiler when determining whether or not to
4323 issue a warning.
4324
4325 The message is in keeping with the output of @option{-fstack-usage}.
4326
4327 @itemize
4328 @item
4329 If the stack usage is fully static but exceeds the specified amount, it's:
4330
4331 @smallexample
4332 warning: stack usage is 1120 bytes
4333 @end smallexample
4334 @item
4335 If the stack usage is (partly) dynamic but bounded, it's:
4336
4337 @smallexample
4338 warning: stack usage might be 1648 bytes
4339 @end smallexample
4340 @item
4341 If the stack usage is (partly) dynamic and not bounded, it's:
4342
4343 @smallexample
4344 warning: stack usage might be unbounded
4345 @end smallexample
4346 @end itemize
4347
4348 @item -Wunsafe-loop-optimizations
4349 @opindex Wunsafe-loop-optimizations
4350 @opindex Wno-unsafe-loop-optimizations
4351 Warn if the loop cannot be optimized because the compiler cannot
4352 assume anything on the bounds of the loop indices. With
4353 @option{-funsafe-loop-optimizations} warn if the compiler makes
4354 such assumptions.
4355
4356 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4357 @opindex Wno-pedantic-ms-format
4358 @opindex Wpedantic-ms-format
4359 When used in combination with @option{-Wformat}
4360 and @option{-pedantic} without GNU extensions, this option
4361 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4362 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4363 which depend on the MS runtime.
4364
4365 @item -Wpointer-arith
4366 @opindex Wpointer-arith
4367 @opindex Wno-pointer-arith
4368 Warn about anything that depends on the ``size of'' a function type or
4369 of @code{void}. GNU C assigns these types a size of 1, for
4370 convenience in calculations with @code{void *} pointers and pointers
4371 to functions. In C++, warn also when an arithmetic operation involves
4372 @code{NULL}. This warning is also enabled by @option{-Wpedantic}.
4373
4374 @item -Wtype-limits
4375 @opindex Wtype-limits
4376 @opindex Wno-type-limits
4377 Warn if a comparison is always true or always false due to the limited
4378 range of the data type, but do not warn for constant expressions. For
4379 example, warn if an unsigned variable is compared against zero with
4380 @samp{<} or @samp{>=}. This warning is also enabled by
4381 @option{-Wextra}.
4382
4383 @item -Wbad-function-cast @r{(C and Objective-C only)}
4384 @opindex Wbad-function-cast
4385 @opindex Wno-bad-function-cast
4386 Warn whenever a function call is cast to a non-matching type.
4387 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4388
4389 @item -Wc++-compat @r{(C and Objective-C only)}
4390 Warn about ISO C constructs that are outside of the common subset of
4391 ISO C and ISO C++, e.g.@: request for implicit conversion from
4392 @code{void *} to a pointer to non-@code{void} type.
4393
4394 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4395 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4396 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4397 in ISO C++ 2011. This warning turns on @option{-Wnarrowing} and is
4398 enabled by @option{-Wall}.
4399
4400 @item -Wcast-qual
4401 @opindex Wcast-qual
4402 @opindex Wno-cast-qual
4403 Warn whenever a pointer is cast so as to remove a type qualifier from
4404 the target type. For example, warn if a @code{const char *} is cast
4405 to an ordinary @code{char *}.
4406
4407 Also warn when making a cast that introduces a type qualifier in an
4408 unsafe way. For example, casting @code{char **} to @code{const char **}
4409 is unsafe, as in this example:
4410
4411 @smallexample
4412 /* p is char ** value. */
4413 const char **q = (const char **) p;
4414 /* Assignment of readonly string to const char * is OK. */
4415 *q = "string";
4416 /* Now char** pointer points to read-only memory. */
4417 **p = 'b';
4418 @end smallexample
4419
4420 @item -Wcast-align
4421 @opindex Wcast-align
4422 @opindex Wno-cast-align
4423 Warn whenever a pointer is cast such that the required alignment of the
4424 target is increased. For example, warn if a @code{char *} is cast to
4425 an @code{int *} on machines where integers can only be accessed at
4426 two- or four-byte boundaries.
4427
4428 @item -Wwrite-strings
4429 @opindex Wwrite-strings
4430 @opindex Wno-write-strings
4431 When compiling C, give string constants the type @code{const
4432 char[@var{length}]} so that copying the address of one into a
4433 non-@code{const} @code{char *} pointer produces a warning. These
4434 warnings help you find at compile time code that can try to write
4435 into a string constant, but only if you have been very careful about
4436 using @code{const} in declarations and prototypes. Otherwise, it is
4437 just a nuisance. This is why we did not make @option{-Wall} request
4438 these warnings.
4439
4440 When compiling C++, warn about the deprecated conversion from string
4441 literals to @code{char *}. This warning is enabled by default for C++
4442 programs.
4443
4444 @item -Wclobbered
4445 @opindex Wclobbered
4446 @opindex Wno-clobbered
4447 Warn for variables that might be changed by @samp{longjmp} or
4448 @samp{vfork}. This warning is also enabled by @option{-Wextra}.
4449
4450 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4451 @opindex Wconditionally-supported
4452 @opindex Wno-conditionally-supported
4453 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4454
4455 @item -Wconversion
4456 @opindex Wconversion
4457 @opindex Wno-conversion
4458 Warn for implicit conversions that may alter a value. This includes
4459 conversions between real and integer, like @code{abs (x)} when
4460 @code{x} is @code{double}; conversions between signed and unsigned,
4461 like @code{unsigned ui = -1}; and conversions to smaller types, like
4462 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4463 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4464 changed by the conversion like in @code{abs (2.0)}. Warnings about
4465 conversions between signed and unsigned integers can be disabled by
4466 using @option{-Wno-sign-conversion}.
4467
4468 For C++, also warn for confusing overload resolution for user-defined
4469 conversions; and conversions that never use a type conversion
4470 operator: conversions to @code{void}, the same type, a base class or a
4471 reference to them. Warnings about conversions between signed and
4472 unsigned integers are disabled by default in C++ unless
4473 @option{-Wsign-conversion} is explicitly enabled.
4474
4475 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4476 @opindex Wconversion-null
4477 @opindex Wno-conversion-null
4478 Do not warn for conversions between @code{NULL} and non-pointer
4479 types. @option{-Wconversion-null} is enabled by default.
4480
4481 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4482 @opindex Wzero-as-null-pointer-constant
4483 @opindex Wno-zero-as-null-pointer-constant
4484 Warn when a literal '0' is used as null pointer constant. This can
4485 be useful to facilitate the conversion to @code{nullptr} in C++11.
4486
4487 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4488 @opindex Wuseless-cast
4489 @opindex Wno-useless-cast
4490 Warn when an expression is casted to its own type.
4491
4492 @item -Wempty-body
4493 @opindex Wempty-body
4494 @opindex Wno-empty-body
4495 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4496 while} statement. This warning is also enabled by @option{-Wextra}.
4497
4498 @item -Wenum-compare
4499 @opindex Wenum-compare
4500 @opindex Wno-enum-compare
4501 Warn about a comparison between values of different enumerated types.
4502 In C++ enumeral mismatches in conditional expressions are also
4503 diagnosed and the warning is enabled by default. In C this warning is
4504 enabled by @option{-Wall}.
4505
4506 @item -Wjump-misses-init @r{(C, Objective-C only)}
4507 @opindex Wjump-misses-init
4508 @opindex Wno-jump-misses-init
4509 Warn if a @code{goto} statement or a @code{switch} statement jumps
4510 forward across the initialization of a variable, or jumps backward to a
4511 label after the variable has been initialized. This only warns about
4512 variables that are initialized when they are declared. This warning is
4513 only supported for C and Objective-C; in C++ this sort of branch is an
4514 error in any case.
4515
4516 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It
4517 can be disabled with the @option{-Wno-jump-misses-init} option.
4518
4519 @item -Wsign-compare
4520 @opindex Wsign-compare
4521 @opindex Wno-sign-compare
4522 @cindex warning for comparison of signed and unsigned values
4523 @cindex comparison of signed and unsigned values, warning
4524 @cindex signed and unsigned values, comparison warning
4525 Warn when a comparison between signed and unsigned values could produce
4526 an incorrect result when the signed value is converted to unsigned.
4527 This warning is also enabled by @option{-Wextra}; to get the other warnings
4528 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4529
4530 @item -Wsign-conversion
4531 @opindex Wsign-conversion
4532 @opindex Wno-sign-conversion
4533 Warn for implicit conversions that may change the sign of an integer
4534 value, like assigning a signed integer expression to an unsigned
4535 integer variable. An explicit cast silences the warning. In C, this
4536 option is enabled also by @option{-Wconversion}.
4537
4538 @item -Wsizeof-pointer-memaccess
4539 @opindex Wsizeof-pointer-memaccess
4540 @opindex Wno-sizeof-pointer-memaccess
4541 Warn for suspicious length parameters to certain string and memory built-in
4542 functions if the argument uses @code{sizeof}. This warning warns e.g.@:
4543 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4544 but a pointer, and suggests a possible fix, or about
4545 @code{memcpy (&foo, ptr, sizeof (&foo));}. This warning is enabled by
4546 @option{-Wall}.
4547
4548 @item -Waddress
4549 @opindex Waddress
4550 @opindex Wno-address
4551 Warn about suspicious uses of memory addresses. These include using
4552 the address of a function in a conditional expression, such as
4553 @code{void func(void); if (func)}, and comparisons against the memory
4554 address of a string literal, such as @code{if (x == "abc")}. Such
4555 uses typically indicate a programmer error: the address of a function
4556 always evaluates to true, so their use in a conditional usually
4557 indicate that the programmer forgot the parentheses in a function
4558 call; and comparisons against string literals result in unspecified
4559 behavior and are not portable in C, so they usually indicate that the
4560 programmer intended to use @code{strcmp}. This warning is enabled by
4561 @option{-Wall}.
4562
4563 @item -Wlogical-op
4564 @opindex Wlogical-op
4565 @opindex Wno-logical-op
4566 Warn about suspicious uses of logical operators in expressions.
4567 This includes using logical operators in contexts where a
4568 bit-wise operator is likely to be expected.
4569
4570 @item -Waggregate-return
4571 @opindex Waggregate-return
4572 @opindex Wno-aggregate-return
4573 Warn if any functions that return structures or unions are defined or
4574 called. (In languages where you can return an array, this also elicits
4575 a warning.)
4576
4577 @item -Wno-aggressive-loop-optimizations
4578 @opindex Wno-aggressive-loop-optimizations
4579 @opindex Waggressive-loop-optimizations
4580 Warn if in a loop with constant number of iterations the compiler detects
4581 undefined behavior in some statement during one or more of the iterations.
4582
4583 @item -Wno-attributes
4584 @opindex Wno-attributes
4585 @opindex Wattributes
4586 Do not warn if an unexpected @code{__attribute__} is used, such as
4587 unrecognized attributes, function attributes applied to variables,
4588 etc. This does not stop errors for incorrect use of supported
4589 attributes.
4590
4591 @item -Wno-builtin-macro-redefined
4592 @opindex Wno-builtin-macro-redefined
4593 @opindex Wbuiltin-macro-redefined
4594 Do not warn if certain built-in macros are redefined. This suppresses
4595 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4596 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4597
4598 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4599 @opindex Wstrict-prototypes
4600 @opindex Wno-strict-prototypes
4601 Warn if a function is declared or defined without specifying the
4602 argument types. (An old-style function definition is permitted without
4603 a warning if preceded by a declaration that specifies the argument
4604 types.)
4605
4606 @item -Wold-style-declaration @r{(C and Objective-C only)}
4607 @opindex Wold-style-declaration
4608 @opindex Wno-old-style-declaration
4609 Warn for obsolescent usages, according to the C Standard, in a
4610 declaration. For example, warn if storage-class specifiers like
4611 @code{static} are not the first things in a declaration. This warning
4612 is also enabled by @option{-Wextra}.
4613
4614 @item -Wold-style-definition @r{(C and Objective-C only)}
4615 @opindex Wold-style-definition
4616 @opindex Wno-old-style-definition
4617 Warn if an old-style function definition is used. A warning is given
4618 even if there is a previous prototype.
4619
4620 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4621 @opindex Wmissing-parameter-type
4622 @opindex Wno-missing-parameter-type
4623 A function parameter is declared without a type specifier in K&R-style
4624 functions:
4625
4626 @smallexample
4627 void foo(bar) @{ @}
4628 @end smallexample
4629
4630 This warning is also enabled by @option{-Wextra}.
4631
4632 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4633 @opindex Wmissing-prototypes
4634 @opindex Wno-missing-prototypes
4635 Warn if a global function is defined without a previous prototype
4636 declaration. This warning is issued even if the definition itself
4637 provides a prototype. Use this option to detect global functions
4638 that do not have a matching prototype declaration in a header file.
4639 This option is not valid for C++ because all function declarations
4640 provide prototypes and a non-matching declaration will declare an
4641 overload rather than conflict with an earlier declaration.
4642 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4643
4644 @item -Wmissing-declarations
4645 @opindex Wmissing-declarations
4646 @opindex Wno-missing-declarations
4647 Warn if a global function is defined without a previous declaration.
4648 Do so even if the definition itself provides a prototype.
4649 Use this option to detect global functions that are not declared in
4650 header files. In C, no warnings are issued for functions with previous
4651 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4652 missing prototypes. In C++, no warnings are issued for function templates,
4653 or for inline functions, or for functions in anonymous namespaces.
4654
4655 @item -Wmissing-field-initializers
4656 @opindex Wmissing-field-initializers
4657 @opindex Wno-missing-field-initializers
4658 @opindex W
4659 @opindex Wextra
4660 @opindex Wno-extra
4661 Warn if a structure's initializer has some fields missing. For
4662 example, the following code causes such a warning, because
4663 @code{x.h} is implicitly zero:
4664
4665 @smallexample
4666 struct s @{ int f, g, h; @};
4667 struct s x = @{ 3, 4 @};
4668 @end smallexample
4669
4670 This option does not warn about designated initializers, so the following
4671 modification does not trigger a warning:
4672
4673 @smallexample
4674 struct s @{ int f, g, h; @};
4675 struct s x = @{ .f = 3, .g = 4 @};
4676 @end smallexample
4677
4678 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
4679 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4680
4681 @item -Wno-multichar
4682 @opindex Wno-multichar
4683 @opindex Wmultichar
4684 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4685 Usually they indicate a typo in the user's code, as they have
4686 implementation-defined values, and should not be used in portable code.
4687
4688 @item -Wnormalized=<none|id|nfc|nfkc>
4689 @opindex Wnormalized=
4690 @cindex NFC
4691 @cindex NFKC
4692 @cindex character set, input normalization
4693 In ISO C and ISO C++, two identifiers are different if they are
4694 different sequences of characters. However, sometimes when characters
4695 outside the basic ASCII character set are used, you can have two
4696 different character sequences that look the same. To avoid confusion,
4697 the ISO 10646 standard sets out some @dfn{normalization rules} which
4698 when applied ensure that two sequences that look the same are turned into
4699 the same sequence. GCC can warn you if you are using identifiers that
4700 have not been normalized; this option controls that warning.
4701
4702 There are four levels of warning supported by GCC@. The default is
4703 @option{-Wnormalized=nfc}, which warns about any identifier that is
4704 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
4705 recommended form for most uses.
4706
4707 Unfortunately, there are some characters allowed in identifiers by
4708 ISO C and ISO C++ that, when turned into NFC, are not allowed in
4709 identifiers. That is, there's no way to use these symbols in portable
4710 ISO C or C++ and have all your identifiers in NFC@.
4711 @option{-Wnormalized=id} suppresses the warning for these characters.
4712 It is hoped that future versions of the standards involved will correct
4713 this, which is why this option is not the default.
4714
4715 You can switch the warning off for all characters by writing
4716 @option{-Wnormalized=none}. You should only do this if you
4717 are using some other normalization scheme (like ``D''), because
4718 otherwise you can easily create bugs that are literally impossible to see.
4719
4720 Some characters in ISO 10646 have distinct meanings but look identical
4721 in some fonts or display methodologies, especially once formatting has
4722 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4723 LETTER N'', displays just like a regular @code{n} that has been
4724 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
4725 normalization scheme to convert all these into a standard form as
4726 well, and GCC warns if your code is not in NFKC if you use
4727 @option{-Wnormalized=nfkc}. This warning is comparable to warning
4728 about every identifier that contains the letter O because it might be
4729 confused with the digit 0, and so is not the default, but may be
4730 useful as a local coding convention if the programming environment
4731 cannot be fixed to display these characters distinctly.
4732
4733 @item -Wno-deprecated
4734 @opindex Wno-deprecated
4735 @opindex Wdeprecated
4736 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
4737
4738 @item -Wno-deprecated-declarations
4739 @opindex Wno-deprecated-declarations
4740 @opindex Wdeprecated-declarations
4741 Do not warn about uses of functions (@pxref{Function Attributes}),
4742 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4743 Attributes}) marked as deprecated by using the @code{deprecated}
4744 attribute.
4745
4746 @item -Wno-overflow
4747 @opindex Wno-overflow
4748 @opindex Woverflow
4749 Do not warn about compile-time overflow in constant expressions.
4750
4751 @item -Woverride-init @r{(C and Objective-C only)}
4752 @opindex Woverride-init
4753 @opindex Wno-override-init
4754 @opindex W
4755 @opindex Wextra
4756 @opindex Wno-extra
4757 Warn if an initialized field without side effects is overridden when
4758 using designated initializers (@pxref{Designated Inits, , Designated
4759 Initializers}).
4760
4761 This warning is included in @option{-Wextra}. To get other
4762 @option{-Wextra} warnings without this one, use @option{-Wextra
4763 -Wno-override-init}.
4764
4765 @item -Wpacked
4766 @opindex Wpacked
4767 @opindex Wno-packed
4768 Warn if a structure is given the packed attribute, but the packed
4769 attribute has no effect on the layout or size of the structure.
4770 Such structures may be mis-aligned for little benefit. For
4771 instance, in this code, the variable @code{f.x} in @code{struct bar}
4772 is misaligned even though @code{struct bar} does not itself
4773 have the packed attribute:
4774
4775 @smallexample
4776 @group
4777 struct foo @{
4778 int x;
4779 char a, b, c, d;
4780 @} __attribute__((packed));
4781 struct bar @{
4782 char z;
4783 struct foo f;
4784 @};
4785 @end group
4786 @end smallexample
4787
4788 @item -Wpacked-bitfield-compat
4789 @opindex Wpacked-bitfield-compat
4790 @opindex Wno-packed-bitfield-compat
4791 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4792 on bit-fields of type @code{char}. This has been fixed in GCC 4.4 but
4793 the change can lead to differences in the structure layout. GCC
4794 informs you when the offset of such a field has changed in GCC 4.4.
4795 For example there is no longer a 4-bit padding between field @code{a}
4796 and @code{b} in this structure:
4797
4798 @smallexample
4799 struct foo
4800 @{
4801 char a:4;
4802 char b:8;
4803 @} __attribute__ ((packed));
4804 @end smallexample
4805
4806 This warning is enabled by default. Use
4807 @option{-Wno-packed-bitfield-compat} to disable this warning.
4808
4809 @item -Wpadded
4810 @opindex Wpadded
4811 @opindex Wno-padded
4812 Warn if padding is included in a structure, either to align an element
4813 of the structure or to align the whole structure. Sometimes when this
4814 happens it is possible to rearrange the fields of the structure to
4815 reduce the padding and so make the structure smaller.
4816
4817 @item -Wredundant-decls
4818 @opindex Wredundant-decls
4819 @opindex Wno-redundant-decls
4820 Warn if anything is declared more than once in the same scope, even in
4821 cases where multiple declaration is valid and changes nothing.
4822
4823 @item -Wnested-externs @r{(C and Objective-C only)}
4824 @opindex Wnested-externs
4825 @opindex Wno-nested-externs
4826 Warn if an @code{extern} declaration is encountered within a function.
4827
4828 @item -Wno-inherited-variadic-ctor
4829 @opindex Winherited-variadic-ctor
4830 @opindex Wno-inherited-variadic-ctor
4831 Suppress warnings about use of C++11 inheriting constructors when the
4832 base class inherited from has a C variadic constructor; the warning is
4833 on by default because the ellipsis is not inherited.
4834
4835 @item -Winline
4836 @opindex Winline
4837 @opindex Wno-inline
4838 Warn if a function that is declared as inline cannot be inlined.
4839 Even with this option, the compiler does not warn about failures to
4840 inline functions declared in system headers.
4841
4842 The compiler uses a variety of heuristics to determine whether or not
4843 to inline a function. For example, the compiler takes into account
4844 the size of the function being inlined and the amount of inlining
4845 that has already been done in the current function. Therefore,
4846 seemingly insignificant changes in the source program can cause the
4847 warnings produced by @option{-Winline} to appear or disappear.
4848
4849 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4850 @opindex Wno-invalid-offsetof
4851 @opindex Winvalid-offsetof
4852 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4853 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
4854 to a non-POD type is undefined. In existing C++ implementations,
4855 however, @samp{offsetof} typically gives meaningful results even when
4856 applied to certain kinds of non-POD types (such as a simple
4857 @samp{struct} that fails to be a POD type only by virtue of having a
4858 constructor). This flag is for users who are aware that they are
4859 writing nonportable code and who have deliberately chosen to ignore the
4860 warning about it.
4861
4862 The restrictions on @samp{offsetof} may be relaxed in a future version
4863 of the C++ standard.
4864
4865 @item -Wno-int-to-pointer-cast
4866 @opindex Wno-int-to-pointer-cast
4867 @opindex Wint-to-pointer-cast
4868 Suppress warnings from casts to pointer type of an integer of a
4869 different size. In C++, casting to a pointer type of smaller size is
4870 an error. @option{Wint-to-pointer-cast} is enabled by default.
4871
4872
4873 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4874 @opindex Wno-pointer-to-int-cast
4875 @opindex Wpointer-to-int-cast
4876 Suppress warnings from casts from a pointer to an integer type of a
4877 different size.
4878
4879 @item -Winvalid-pch
4880 @opindex Winvalid-pch
4881 @opindex Wno-invalid-pch
4882 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4883 the search path but can't be used.
4884
4885 @item -Wlong-long
4886 @opindex Wlong-long
4887 @opindex Wno-long-long
4888 Warn if @samp{long long} type is used. This is enabled by either
4889 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4890 modes. To inhibit the warning messages, use @option{-Wno-long-long}.
4891
4892 @item -Wvariadic-macros
4893 @opindex Wvariadic-macros
4894 @opindex Wno-variadic-macros
4895 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4896 alternate syntax when in pedantic ISO C99 mode. This is default.
4897 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4898
4899 @item -Wvarargs
4900 @opindex Wvarargs
4901 @opindex Wno-varargs
4902 Warn upon questionable usage of the macros used to handle variable
4903 arguments like @samp{va_start}. This is default. To inhibit the
4904 warning messages, use @option{-Wno-varargs}.
4905
4906 @item -Wvector-operation-performance
4907 @opindex Wvector-operation-performance
4908 @opindex Wno-vector-operation-performance
4909 Warn if vector operation is not implemented via SIMD capabilities of the
4910 architecture. Mainly useful for the performance tuning.
4911 Vector operation can be implemented @code{piecewise}, which means that the
4912 scalar operation is performed on every vector element;
4913 @code{in parallel}, which means that the vector operation is implemented
4914 using scalars of wider type, which normally is more performance efficient;
4915 and @code{as a single scalar}, which means that vector fits into a
4916 scalar type.
4917
4918 @item -Wno-virtual-move-assign
4919 @opindex Wvirtual-move-assign
4920 @opindex Wno-virtual-move-assign
4921 Suppress warnings about inheriting from a virtual base with a
4922 non-trivial C++11 move assignment operator. This is dangerous because
4923 if the virtual base is reachable along more than one path, it will be
4924 moved multiple times, which can mean both objects end up in the
4925 moved-from state. If the move assignment operator is written to avoid
4926 moving from a moved-from object, this warning can be disabled.
4927
4928 @item -Wvla
4929 @opindex Wvla
4930 @opindex Wno-vla
4931 Warn if variable length array is used in the code.
4932 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4933 the variable length array.
4934
4935 @item -Wvolatile-register-var
4936 @opindex Wvolatile-register-var
4937 @opindex Wno-volatile-register-var
4938 Warn if a register variable is declared volatile. The volatile
4939 modifier does not inhibit all optimizations that may eliminate reads
4940 and/or writes to register variables. This warning is enabled by
4941 @option{-Wall}.
4942
4943 @item -Wdisabled-optimization
4944 @opindex Wdisabled-optimization
4945 @opindex Wno-disabled-optimization
4946 Warn if a requested optimization pass is disabled. This warning does
4947 not generally indicate that there is anything wrong with your code; it
4948 merely indicates that GCC's optimizers are unable to handle the code
4949 effectively. Often, the problem is that your code is too big or too
4950 complex; GCC refuses to optimize programs when the optimization
4951 itself is likely to take inordinate amounts of time.
4952
4953 @item -Wpointer-sign @r{(C and Objective-C only)}
4954 @opindex Wpointer-sign
4955 @opindex Wno-pointer-sign
4956 Warn for pointer argument passing or assignment with different signedness.
4957 This option is only supported for C and Objective-C@. It is implied by
4958 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4959 @option{-Wno-pointer-sign}.
4960
4961 @item -Wstack-protector
4962 @opindex Wstack-protector
4963 @opindex Wno-stack-protector
4964 This option is only active when @option{-fstack-protector} is active. It
4965 warns about functions that are not protected against stack smashing.
4966
4967 @item -Wno-mudflap
4968 @opindex Wno-mudflap
4969 Suppress warnings about constructs that cannot be instrumented by
4970 @option{-fmudflap}.
4971
4972 @item -Woverlength-strings
4973 @opindex Woverlength-strings
4974 @opindex Wno-overlength-strings
4975 Warn about string constants that are longer than the ``minimum
4976 maximum'' length specified in the C standard. Modern compilers
4977 generally allow string constants that are much longer than the
4978 standard's minimum limit, but very portable programs should avoid
4979 using longer strings.
4980
4981 The limit applies @emph{after} string constant concatenation, and does
4982 not count the trailing NUL@. In C90, the limit was 509 characters; in
4983 C99, it was raised to 4095. C++98 does not specify a normative
4984 minimum maximum, so we do not diagnose overlength strings in C++@.
4985
4986 This option is implied by @option{-Wpedantic}, and can be disabled with
4987 @option{-Wno-overlength-strings}.
4988
4989 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4990 @opindex Wunsuffixed-float-constants
4991
4992 Issue a warning for any floating constant that does not have
4993 a suffix. When used together with @option{-Wsystem-headers} it
4994 warns about such constants in system header files. This can be useful
4995 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4996 from the decimal floating-point extension to C99.
4997 @end table
4998
4999 @node Debugging Options
5000 @section Options for Debugging Your Program or GCC
5001 @cindex options, debugging
5002 @cindex debugging information options
5003
5004 GCC has various special options that are used for debugging
5005 either your program or GCC:
5006
5007 @table @gcctabopt
5008 @item -g
5009 @opindex g
5010 Produce debugging information in the operating system's native format
5011 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
5012 information.
5013
5014 On most systems that use stabs format, @option{-g} enables use of extra
5015 debugging information that only GDB can use; this extra information
5016 makes debugging work better in GDB but probably makes other debuggers
5017 crash or
5018 refuse to read the program. If you want to control for certain whether
5019 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5020 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5021
5022 GCC allows you to use @option{-g} with
5023 @option{-O}. The shortcuts taken by optimized code may occasionally
5024 produce surprising results: some variables you declared may not exist
5025 at all; flow of control may briefly move where you did not expect it;
5026 some statements may not be executed because they compute constant
5027 results or their values are already at hand; some statements may
5028 execute in different places because they have been moved out of loops.
5029
5030 Nevertheless it proves possible to debug optimized output. This makes
5031 it reasonable to use the optimizer for programs that might have bugs.
5032
5033 The following options are useful when GCC is generated with the
5034 capability for more than one debugging format.
5035
5036 @item -gsplit-dwarf
5037 @opindex gsplit-dwarf
5038 Separate as much dwarf debugging information as possible into a
5039 separate output file with the extension .dwo. This option allows
5040 the build system to avoid linking files with debug information. To
5041 be useful, this option requires a debugger capable of reading .dwo
5042 files.
5043
5044 @item -ggdb
5045 @opindex ggdb
5046 Produce debugging information for use by GDB@. This means to use the
5047 most expressive format available (DWARF 2, stabs, or the native format
5048 if neither of those are supported), including GDB extensions if at all
5049 possible.
5050
5051 @item -gpubnames
5052 @opindex gpubnames
5053 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5054
5055 @item -gstabs
5056 @opindex gstabs
5057 Produce debugging information in stabs format (if that is supported),
5058 without GDB extensions. This is the format used by DBX on most BSD
5059 systems. On MIPS, Alpha and System V Release 4 systems this option
5060 produces stabs debugging output that is not understood by DBX or SDB@.
5061 On System V Release 4 systems this option requires the GNU assembler.
5062
5063 @item -feliminate-unused-debug-symbols
5064 @opindex feliminate-unused-debug-symbols
5065 Produce debugging information in stabs format (if that is supported),
5066 for only symbols that are actually used.
5067
5068 @item -femit-class-debug-always
5069 Instead of emitting debugging information for a C++ class in only one
5070 object file, emit it in all object files using the class. This option
5071 should be used only with debuggers that are unable to handle the way GCC
5072 normally emits debugging information for classes because using this
5073 option increases the size of debugging information by as much as a
5074 factor of two.
5075
5076 @item -fdebug-types-section
5077 @opindex fdebug-types-section
5078 @opindex fno-debug-types-section
5079 When using DWARF Version 4 or higher, type DIEs can be put into
5080 their own @code{.debug_types} section instead of making them part of the
5081 @code{.debug_info} section. It is more efficient to put them in a separate
5082 comdat sections since the linker can then remove duplicates.
5083 But not all DWARF consumers support @code{.debug_types} sections yet
5084 and on some objects @code{.debug_types} produces larger instead of smaller
5085 debugging information.
5086
5087 @item -gstabs+
5088 @opindex gstabs+
5089 Produce debugging information in stabs format (if that is supported),
5090 using GNU extensions understood only by the GNU debugger (GDB)@. The
5091 use of these extensions is likely to make other debuggers crash or
5092 refuse to read the program.
5093
5094 @item -gcoff
5095 @opindex gcoff
5096 Produce debugging information in COFF format (if that is supported).
5097 This is the format used by SDB on most System V systems prior to
5098 System V Release 4.
5099
5100 @item -gxcoff
5101 @opindex gxcoff
5102 Produce debugging information in XCOFF format (if that is supported).
5103 This is the format used by the DBX debugger on IBM RS/6000 systems.
5104
5105 @item -gxcoff+
5106 @opindex gxcoff+
5107 Produce debugging information in XCOFF format (if that is supported),
5108 using GNU extensions understood only by the GNU debugger (GDB)@. The
5109 use of these extensions is likely to make other debuggers crash or
5110 refuse to read the program, and may cause assemblers other than the GNU
5111 assembler (GAS) to fail with an error.
5112
5113 @item -gdwarf-@var{version}
5114 @opindex gdwarf-@var{version}
5115 Produce debugging information in DWARF format (if that is supported).
5116 The value of @var{version} may be either 2, 3 or 4; the default version
5117 for most targets is 4.
5118
5119 Note that with DWARF Version 2, some ports require and always
5120 use some non-conflicting DWARF 3 extensions in the unwind tables.
5121
5122 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5123 for maximum benefit.
5124
5125 @item -grecord-gcc-switches
5126 @opindex grecord-gcc-switches
5127 This switch causes the command-line options used to invoke the
5128 compiler that may affect code generation to be appended to the
5129 DW_AT_producer attribute in DWARF debugging information. The options
5130 are concatenated with spaces separating them from each other and from
5131 the compiler version. See also @option{-frecord-gcc-switches} for another
5132 way of storing compiler options into the object file. This is the default.
5133
5134 @item -gno-record-gcc-switches
5135 @opindex gno-record-gcc-switches
5136 Disallow appending command-line options to the DW_AT_producer attribute
5137 in DWARF debugging information.
5138
5139 @item -gstrict-dwarf
5140 @opindex gstrict-dwarf
5141 Disallow using extensions of later DWARF standard version than selected
5142 with @option{-gdwarf-@var{version}}. On most targets using non-conflicting
5143 DWARF extensions from later standard versions is allowed.
5144
5145 @item -gno-strict-dwarf
5146 @opindex gno-strict-dwarf
5147 Allow using extensions of later DWARF standard version than selected with
5148 @option{-gdwarf-@var{version}}.
5149
5150 @item -gvms
5151 @opindex gvms
5152 Produce debugging information in Alpha/VMS debug format (if that is
5153 supported). This is the format used by DEBUG on Alpha/VMS systems.
5154
5155 @item -g@var{level}
5156 @itemx -ggdb@var{level}
5157 @itemx -gstabs@var{level}
5158 @itemx -gcoff@var{level}
5159 @itemx -gxcoff@var{level}
5160 @itemx -gvms@var{level}
5161 Request debugging information and also use @var{level} to specify how
5162 much information. The default level is 2.
5163
5164 Level 0 produces no debug information at all. Thus, @option{-g0} negates
5165 @option{-g}.
5166
5167 Level 1 produces minimal information, enough for making backtraces in
5168 parts of the program that you don't plan to debug. This includes
5169 descriptions of functions and external variables, but no information
5170 about local variables and no line numbers.
5171
5172 Level 3 includes extra information, such as all the macro definitions
5173 present in the program. Some debuggers support macro expansion when
5174 you use @option{-g3}.
5175
5176 @option{-gdwarf-2} does not accept a concatenated debug level, because
5177 GCC used to support an option @option{-gdwarf} that meant to generate
5178 debug information in version 1 of the DWARF format (which is very
5179 different from version 2), and it would have been too confusing. That
5180 debug format is long obsolete, but the option cannot be changed now.
5181 Instead use an additional @option{-g@var{level}} option to change the
5182 debug level for DWARF.
5183
5184 @item -gtoggle
5185 @opindex gtoggle
5186 Turn off generation of debug info, if leaving out this option
5187 generates it, or turn it on at level 2 otherwise. The position of this
5188 argument in the command line does not matter; it takes effect after all
5189 other options are processed, and it does so only once, no matter how
5190 many times it is given. This is mainly intended to be used with
5191 @option{-fcompare-debug}.
5192
5193 @item -fsanitize=address
5194 Enable AddressSanitizer, a fast memory error detector.
5195 Memory access instructions will be instrumented to detect
5196 out-of-bounds and use-after-free bugs.
5197 See @uref{http://code.google.com/p/address-sanitizer/} for more details.
5198
5199 @item -fsanitize=thread
5200 Enable ThreadSanitizer, a fast data race detector.
5201 Memory access instructions will be instrumented to detect
5202 data race bugs.
5203 See @uref{http://code.google.com/p/data-race-test/wiki/ThreadSanitizer} for more details.
5204
5205 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5206 @opindex fdump-final-insns
5207 Dump the final internal representation (RTL) to @var{file}. If the
5208 optional argument is omitted (or if @var{file} is @code{.}), the name
5209 of the dump file is determined by appending @code{.gkd} to the
5210 compilation output file name.
5211
5212 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5213 @opindex fcompare-debug
5214 @opindex fno-compare-debug
5215 If no error occurs during compilation, run the compiler a second time,
5216 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5217 passed to the second compilation. Dump the final internal
5218 representation in both compilations, and print an error if they differ.
5219
5220 If the equal sign is omitted, the default @option{-gtoggle} is used.
5221
5222 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5223 and nonzero, implicitly enables @option{-fcompare-debug}. If
5224 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5225 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5226 is used.
5227
5228 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5229 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5230 of the final representation and the second compilation, preventing even
5231 @env{GCC_COMPARE_DEBUG} from taking effect.
5232
5233 To verify full coverage during @option{-fcompare-debug} testing, set
5234 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5235 which GCC rejects as an invalid option in any actual compilation
5236 (rather than preprocessing, assembly or linking). To get just a
5237 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5238 not overridden} will do.
5239
5240 @item -fcompare-debug-second
5241 @opindex fcompare-debug-second
5242 This option is implicitly passed to the compiler for the second
5243 compilation requested by @option{-fcompare-debug}, along with options to
5244 silence warnings, and omitting other options that would cause
5245 side-effect compiler outputs to files or to the standard output. Dump
5246 files and preserved temporary files are renamed so as to contain the
5247 @code{.gk} additional extension during the second compilation, to avoid
5248 overwriting those generated by the first.
5249
5250 When this option is passed to the compiler driver, it causes the
5251 @emph{first} compilation to be skipped, which makes it useful for little
5252 other than debugging the compiler proper.
5253
5254 @item -feliminate-dwarf2-dups
5255 @opindex feliminate-dwarf2-dups
5256 Compress DWARF 2 debugging information by eliminating duplicated
5257 information about each symbol. This option only makes sense when
5258 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5259
5260 @item -femit-struct-debug-baseonly
5261 Emit debug information for struct-like types
5262 only when the base name of the compilation source file
5263 matches the base name of file in which the struct is defined.
5264
5265 This option substantially reduces the size of debugging information,
5266 but at significant potential loss in type information to the debugger.
5267 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5268 See @option{-femit-struct-debug-detailed} for more detailed control.
5269
5270 This option works only with DWARF 2.
5271
5272 @item -femit-struct-debug-reduced
5273 Emit debug information for struct-like types
5274 only when the base name of the compilation source file
5275 matches the base name of file in which the type is defined,
5276 unless the struct is a template or defined in a system header.
5277
5278 This option significantly reduces the size of debugging information,
5279 with some potential loss in type information to the debugger.
5280 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5281 See @option{-femit-struct-debug-detailed} for more detailed control.
5282
5283 This option works only with DWARF 2.
5284
5285 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5286 Specify the struct-like types
5287 for which the compiler generates debug information.
5288 The intent is to reduce duplicate struct debug information
5289 between different object files within the same program.
5290
5291 This option is a detailed version of
5292 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5293 which serves for most needs.
5294
5295 A specification has the syntax@*
5296 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5297
5298 The optional first word limits the specification to
5299 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5300 A struct type is used directly when it is the type of a variable, member.
5301 Indirect uses arise through pointers to structs.
5302 That is, when use of an incomplete struct is valid, the use is indirect.
5303 An example is
5304 @samp{struct one direct; struct two * indirect;}.
5305
5306 The optional second word limits the specification to
5307 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5308 Generic structs are a bit complicated to explain.
5309 For C++, these are non-explicit specializations of template classes,
5310 or non-template classes within the above.
5311 Other programming languages have generics,
5312 but @option{-femit-struct-debug-detailed} does not yet implement them.
5313
5314 The third word specifies the source files for those
5315 structs for which the compiler should emit debug information.
5316 The values @samp{none} and @samp{any} have the normal meaning.
5317 The value @samp{base} means that
5318 the base of name of the file in which the type declaration appears
5319 must match the base of the name of the main compilation file.
5320 In practice, this means that when compiling @file{foo.c}, debug information
5321 is generated for types declared in that file and @file{foo.h},
5322 but not other header files.
5323 The value @samp{sys} means those types satisfying @samp{base}
5324 or declared in system or compiler headers.
5325
5326 You may need to experiment to determine the best settings for your application.
5327
5328 The default is @option{-femit-struct-debug-detailed=all}.
5329
5330 This option works only with DWARF 2.
5331
5332 @item -fno-merge-debug-strings
5333 @opindex fmerge-debug-strings
5334 @opindex fno-merge-debug-strings
5335 Direct the linker to not merge together strings in the debugging
5336 information that are identical in different object files. Merging is
5337 not supported by all assemblers or linkers. Merging decreases the size
5338 of the debug information in the output file at the cost of increasing
5339 link processing time. Merging is enabled by default.
5340
5341 @item -fdebug-prefix-map=@var{old}=@var{new}
5342 @opindex fdebug-prefix-map
5343 When compiling files in directory @file{@var{old}}, record debugging
5344 information describing them as in @file{@var{new}} instead.
5345
5346 @item -fno-dwarf2-cfi-asm
5347 @opindex fdwarf2-cfi-asm
5348 @opindex fno-dwarf2-cfi-asm
5349 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5350 instead of using GAS @code{.cfi_*} directives.
5351
5352 @cindex @command{prof}
5353 @item -p
5354 @opindex p
5355 Generate extra code to write profile information suitable for the
5356 analysis program @command{prof}. You must use this option when compiling
5357 the source files you want data about, and you must also use it when
5358 linking.
5359
5360 @cindex @command{gprof}
5361 @item -pg
5362 @opindex pg
5363 Generate extra code to write profile information suitable for the
5364 analysis program @command{gprof}. You must use this option when compiling
5365 the source files you want data about, and you must also use it when
5366 linking.
5367
5368 @item -Q
5369 @opindex Q
5370 Makes the compiler print out each function name as it is compiled, and
5371 print some statistics about each pass when it finishes.
5372
5373 @item -ftime-report
5374 @opindex ftime-report
5375 Makes the compiler print some statistics about the time consumed by each
5376 pass when it finishes.
5377
5378 @item -fmem-report
5379 @opindex fmem-report
5380 Makes the compiler print some statistics about permanent memory
5381 allocation when it finishes.
5382
5383 @item -fmem-report-wpa
5384 @opindex fmem-report-wpa
5385 Makes the compiler print some statistics about permanent memory
5386 allocation for the WPA phase only.
5387
5388 @item -fpre-ipa-mem-report
5389 @opindex fpre-ipa-mem-report
5390 @item -fpost-ipa-mem-report
5391 @opindex fpost-ipa-mem-report
5392 Makes the compiler print some statistics about permanent memory
5393 allocation before or after interprocedural optimization.
5394
5395 @item -fprofile-report
5396 @opindex fprofile-report
5397 Makes the compiler print some statistics about consistency of the
5398 (estimated) profile and effect of individual passes.
5399
5400 @item -fstack-usage
5401 @opindex fstack-usage
5402 Makes the compiler output stack usage information for the program, on a
5403 per-function basis. The filename for the dump is made by appending
5404 @file{.su} to the @var{auxname}. @var{auxname} is generated from the name of
5405 the output file, if explicitly specified and it is not an executable,
5406 otherwise it is the basename of the source file. An entry is made up
5407 of three fields:
5408
5409 @itemize
5410 @item
5411 The name of the function.
5412 @item
5413 A number of bytes.
5414 @item
5415 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5416 @end itemize
5417
5418 The qualifier @code{static} means that the function manipulates the stack
5419 statically: a fixed number of bytes are allocated for the frame on function
5420 entry and released on function exit; no stack adjustments are otherwise made
5421 in the function. The second field is this fixed number of bytes.
5422
5423 The qualifier @code{dynamic} means that the function manipulates the stack
5424 dynamically: in addition to the static allocation described above, stack
5425 adjustments are made in the body of the function, for example to push/pop
5426 arguments around function calls. If the qualifier @code{bounded} is also
5427 present, the amount of these adjustments is bounded at compile time and
5428 the second field is an upper bound of the total amount of stack used by
5429 the function. If it is not present, the amount of these adjustments is
5430 not bounded at compile time and the second field only represents the
5431 bounded part.
5432
5433 @item -fprofile-arcs
5434 @opindex fprofile-arcs
5435 Add code so that program flow @dfn{arcs} are instrumented. During
5436 execution the program records how many times each branch and call is
5437 executed and how many times it is taken or returns. When the compiled
5438 program exits it saves this data to a file called
5439 @file{@var{auxname}.gcda} for each source file. The data may be used for
5440 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5441 test coverage analysis (@option{-ftest-coverage}). Each object file's
5442 @var{auxname} is generated from the name of the output file, if
5443 explicitly specified and it is not the final executable, otherwise it is
5444 the basename of the source file. In both cases any suffix is removed
5445 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5446 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5447 @xref{Cross-profiling}.
5448
5449 @cindex @command{gcov}
5450 @item --coverage
5451 @opindex coverage
5452
5453 This option is used to compile and link code instrumented for coverage
5454 analysis. The option is a synonym for @option{-fprofile-arcs}
5455 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5456 linking). See the documentation for those options for more details.
5457
5458 @itemize
5459
5460 @item
5461 Compile the source files with @option{-fprofile-arcs} plus optimization
5462 and code generation options. For test coverage analysis, use the
5463 additional @option{-ftest-coverage} option. You do not need to profile
5464 every source file in a program.
5465
5466 @item
5467 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5468 (the latter implies the former).
5469
5470 @item
5471 Run the program on a representative workload to generate the arc profile
5472 information. This may be repeated any number of times. You can run
5473 concurrent instances of your program, and provided that the file system
5474 supports locking, the data files will be correctly updated. Also
5475 @code{fork} calls are detected and correctly handled (double counting
5476 will not happen).
5477
5478 @item
5479 For profile-directed optimizations, compile the source files again with
5480 the same optimization and code generation options plus
5481 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5482 Control Optimization}).
5483
5484 @item
5485 For test coverage analysis, use @command{gcov} to produce human readable
5486 information from the @file{.gcno} and @file{.gcda} files. Refer to the
5487 @command{gcov} documentation for further information.
5488
5489 @end itemize
5490
5491 With @option{-fprofile-arcs}, for each function of your program GCC
5492 creates a program flow graph, then finds a spanning tree for the graph.
5493 Only arcs that are not on the spanning tree have to be instrumented: the
5494 compiler adds code to count the number of times that these arcs are
5495 executed. When an arc is the only exit or only entrance to a block, the
5496 instrumentation code can be added to the block; otherwise, a new basic
5497 block must be created to hold the instrumentation code.
5498
5499 @need 2000
5500 @item -ftest-coverage
5501 @opindex ftest-coverage
5502 Produce a notes file that the @command{gcov} code-coverage utility
5503 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5504 show program coverage. Each source file's note file is called
5505 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
5506 above for a description of @var{auxname} and instructions on how to
5507 generate test coverage data. Coverage data matches the source files
5508 more closely if you do not optimize.
5509
5510 @item -fdbg-cnt-list
5511 @opindex fdbg-cnt-list
5512 Print the name and the counter upper bound for all debug counters.
5513
5514
5515 @item -fdbg-cnt=@var{counter-value-list}
5516 @opindex fdbg-cnt
5517 Set the internal debug counter upper bound. @var{counter-value-list}
5518 is a comma-separated list of @var{name}:@var{value} pairs
5519 which sets the upper bound of each debug counter @var{name} to @var{value}.
5520 All debug counters have the initial upper bound of @code{UINT_MAX};
5521 thus @code{dbg_cnt()} returns true always unless the upper bound
5522 is set by this option.
5523 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5524 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5525
5526 @item -fenable-@var{kind}-@var{pass}
5527 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5528 @opindex fdisable-
5529 @opindex fenable-
5530
5531 This is a set of options that are used to explicitly disable/enable
5532 optimization passes. These options are intended for use for debugging GCC.
5533 Compiler users should use regular options for enabling/disabling
5534 passes instead.
5535
5536 @table @gcctabopt
5537
5538 @item -fdisable-ipa-@var{pass}
5539 Disable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
5540 statically invoked in the compiler multiple times, the pass name should be
5541 appended with a sequential number starting from 1.
5542
5543 @item -fdisable-rtl-@var{pass}
5544 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5545 Disable RTL pass @var{pass}. @var{pass} is the pass name. If the same pass is
5546 statically invoked in the compiler multiple times, the pass name should be
5547 appended with a sequential number starting from 1. @var{range-list} is a
5548 comma-separated list of function ranges or assembler names. Each range is a number
5549 pair separated by a colon. The range is inclusive in both ends. If the range
5550 is trivial, the number pair can be simplified as a single number. If the
5551 function's call graph node's @var{uid} falls within one of the specified ranges,
5552 the @var{pass} is disabled for that function. The @var{uid} is shown in the
5553 function header of a dump file, and the pass names can be dumped by using
5554 option @option{-fdump-passes}.
5555
5556 @item -fdisable-tree-@var{pass}
5557 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5558 Disable tree pass @var{pass}. See @option{-fdisable-rtl} for the description of
5559 option arguments.
5560
5561 @item -fenable-ipa-@var{pass}
5562 Enable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
5563 statically invoked in the compiler multiple times, the pass name should be
5564 appended with a sequential number starting from 1.
5565
5566 @item -fenable-rtl-@var{pass}
5567 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5568 Enable RTL pass @var{pass}. See @option{-fdisable-rtl} for option argument
5569 description and examples.
5570
5571 @item -fenable-tree-@var{pass}
5572 @itemx -fenable-tree-@var{pass}=@var{range-list}
5573 Enable tree pass @var{pass}. See @option{-fdisable-rtl} for the description
5574 of option arguments.
5575
5576 @end table
5577
5578 Here are some examples showing uses of these options.
5579
5580 @smallexample
5581
5582 # disable ccp1 for all functions
5583 -fdisable-tree-ccp1
5584 # disable complete unroll for function whose cgraph node uid is 1
5585 -fenable-tree-cunroll=1
5586 # disable gcse2 for functions at the following ranges [1,1],
5587 # [300,400], and [400,1000]
5588 # disable gcse2 for functions foo and foo2
5589 -fdisable-rtl-gcse2=foo,foo2
5590 # disable early inlining
5591 -fdisable-tree-einline
5592 # disable ipa inlining
5593 -fdisable-ipa-inline
5594 # enable tree full unroll
5595 -fenable-tree-unroll
5596
5597 @end smallexample
5598
5599 @item -d@var{letters}
5600 @itemx -fdump-rtl-@var{pass}
5601 @itemx -fdump-rtl-@var{pass}=@var{filename}
5602 @opindex d
5603 Says to make debugging dumps during compilation at times specified by
5604 @var{letters}. This is used for debugging the RTL-based passes of the
5605 compiler. The file names for most of the dumps are made by appending
5606 a pass number and a word to the @var{dumpname}, and the files are
5607 created in the directory of the output file. In case of
5608 @option{=@var{filename}} option, the dump is output on the given file
5609 instead of the pass numbered dump files. Note that the pass number is
5610 computed statically as passes get registered into the pass manager.
5611 Thus the numbering is not related to the dynamic order of execution of
5612 passes. In particular, a pass installed by a plugin could have a
5613 number over 200 even if it executed quite early. @var{dumpname} is
5614 generated from the name of the output file, if explicitly specified
5615 and it is not an executable, otherwise it is the basename of the
5616 source file. These switches may have different effects when
5617 @option{-E} is used for preprocessing.
5618
5619 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5620 @option{-d} option @var{letters}. Here are the possible
5621 letters for use in @var{pass} and @var{letters}, and their meanings:
5622
5623 @table @gcctabopt
5624
5625 @item -fdump-rtl-alignments
5626 @opindex fdump-rtl-alignments
5627 Dump after branch alignments have been computed.
5628
5629 @item -fdump-rtl-asmcons
5630 @opindex fdump-rtl-asmcons
5631 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5632
5633 @item -fdump-rtl-auto_inc_dec
5634 @opindex fdump-rtl-auto_inc_dec
5635 Dump after auto-inc-dec discovery. This pass is only run on
5636 architectures that have auto inc or auto dec instructions.
5637
5638 @item -fdump-rtl-barriers
5639 @opindex fdump-rtl-barriers
5640 Dump after cleaning up the barrier instructions.
5641
5642 @item -fdump-rtl-bbpart
5643 @opindex fdump-rtl-bbpart
5644 Dump after partitioning hot and cold basic blocks.
5645
5646 @item -fdump-rtl-bbro
5647 @opindex fdump-rtl-bbro
5648 Dump after block reordering.
5649
5650 @item -fdump-rtl-btl1
5651 @itemx -fdump-rtl-btl2
5652 @opindex fdump-rtl-btl2
5653 @opindex fdump-rtl-btl2
5654 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5655 after the two branch
5656 target load optimization passes.
5657
5658 @item -fdump-rtl-bypass
5659 @opindex fdump-rtl-bypass
5660 Dump after jump bypassing and control flow optimizations.
5661
5662 @item -fdump-rtl-combine
5663 @opindex fdump-rtl-combine
5664 Dump after the RTL instruction combination pass.
5665
5666 @item -fdump-rtl-compgotos
5667 @opindex fdump-rtl-compgotos
5668 Dump after duplicating the computed gotos.
5669
5670 @item -fdump-rtl-ce1
5671 @itemx -fdump-rtl-ce2
5672 @itemx -fdump-rtl-ce3
5673 @opindex fdump-rtl-ce1
5674 @opindex fdump-rtl-ce2
5675 @opindex fdump-rtl-ce3
5676 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5677 @option{-fdump-rtl-ce3} enable dumping after the three
5678 if conversion passes.
5679
5680 @item -fdump-rtl-cprop_hardreg
5681 @opindex fdump-rtl-cprop_hardreg
5682 Dump after hard register copy propagation.
5683
5684 @item -fdump-rtl-csa
5685 @opindex fdump-rtl-csa
5686 Dump after combining stack adjustments.
5687
5688 @item -fdump-rtl-cse1
5689 @itemx -fdump-rtl-cse2
5690 @opindex fdump-rtl-cse1
5691 @opindex fdump-rtl-cse2
5692 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5693 the two common subexpression elimination passes.
5694
5695 @item -fdump-rtl-dce
5696 @opindex fdump-rtl-dce
5697 Dump after the standalone dead code elimination passes.
5698
5699 @item -fdump-rtl-dbr
5700 @opindex fdump-rtl-dbr
5701 Dump after delayed branch scheduling.
5702
5703 @item -fdump-rtl-dce1
5704 @itemx -fdump-rtl-dce2
5705 @opindex fdump-rtl-dce1
5706 @opindex fdump-rtl-dce2
5707 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5708 the two dead store elimination passes.
5709
5710 @item -fdump-rtl-eh
5711 @opindex fdump-rtl-eh
5712 Dump after finalization of EH handling code.
5713
5714 @item -fdump-rtl-eh_ranges
5715 @opindex fdump-rtl-eh_ranges
5716 Dump after conversion of EH handling range regions.
5717
5718 @item -fdump-rtl-expand
5719 @opindex fdump-rtl-expand
5720 Dump after RTL generation.
5721
5722 @item -fdump-rtl-fwprop1
5723 @itemx -fdump-rtl-fwprop2
5724 @opindex fdump-rtl-fwprop1
5725 @opindex fdump-rtl-fwprop2
5726 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5727 dumping after the two forward propagation passes.
5728
5729 @item -fdump-rtl-gcse1
5730 @itemx -fdump-rtl-gcse2
5731 @opindex fdump-rtl-gcse1
5732 @opindex fdump-rtl-gcse2
5733 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5734 after global common subexpression elimination.
5735
5736 @item -fdump-rtl-init-regs
5737 @opindex fdump-rtl-init-regs
5738 Dump after the initialization of the registers.
5739
5740 @item -fdump-rtl-initvals
5741 @opindex fdump-rtl-initvals
5742 Dump after the computation of the initial value sets.
5743
5744 @item -fdump-rtl-into_cfglayout
5745 @opindex fdump-rtl-into_cfglayout
5746 Dump after converting to cfglayout mode.
5747
5748 @item -fdump-rtl-ira
5749 @opindex fdump-rtl-ira
5750 Dump after iterated register allocation.
5751
5752 @item -fdump-rtl-jump
5753 @opindex fdump-rtl-jump
5754 Dump after the second jump optimization.
5755
5756 @item -fdump-rtl-loop2
5757 @opindex fdump-rtl-loop2
5758 @option{-fdump-rtl-loop2} enables dumping after the rtl
5759 loop optimization passes.
5760
5761 @item -fdump-rtl-mach
5762 @opindex fdump-rtl-mach
5763 Dump after performing the machine dependent reorganization pass, if that
5764 pass exists.
5765
5766 @item -fdump-rtl-mode_sw
5767 @opindex fdump-rtl-mode_sw
5768 Dump after removing redundant mode switches.
5769
5770 @item -fdump-rtl-rnreg
5771 @opindex fdump-rtl-rnreg
5772 Dump after register renumbering.
5773
5774 @item -fdump-rtl-outof_cfglayout
5775 @opindex fdump-rtl-outof_cfglayout
5776 Dump after converting from cfglayout mode.
5777
5778 @item -fdump-rtl-peephole2
5779 @opindex fdump-rtl-peephole2
5780 Dump after the peephole pass.
5781
5782 @item -fdump-rtl-postreload
5783 @opindex fdump-rtl-postreload
5784 Dump after post-reload optimizations.
5785
5786 @item -fdump-rtl-pro_and_epilogue
5787 @opindex fdump-rtl-pro_and_epilogue
5788 Dump after generating the function prologues and epilogues.
5789
5790 @item -fdump-rtl-regmove
5791 @opindex fdump-rtl-regmove
5792 Dump after the register move pass.
5793
5794 @item -fdump-rtl-sched1
5795 @itemx -fdump-rtl-sched2
5796 @opindex fdump-rtl-sched1
5797 @opindex fdump-rtl-sched2
5798 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5799 after the basic block scheduling passes.
5800
5801 @item -fdump-rtl-see
5802 @opindex fdump-rtl-see
5803 Dump after sign extension elimination.
5804
5805 @item -fdump-rtl-seqabstr
5806 @opindex fdump-rtl-seqabstr
5807 Dump after common sequence discovery.
5808
5809 @item -fdump-rtl-shorten
5810 @opindex fdump-rtl-shorten
5811 Dump after shortening branches.
5812
5813 @item -fdump-rtl-sibling
5814 @opindex fdump-rtl-sibling
5815 Dump after sibling call optimizations.
5816
5817 @item -fdump-rtl-split1
5818 @itemx -fdump-rtl-split2
5819 @itemx -fdump-rtl-split3
5820 @itemx -fdump-rtl-split4
5821 @itemx -fdump-rtl-split5
5822 @opindex fdump-rtl-split1
5823 @opindex fdump-rtl-split2
5824 @opindex fdump-rtl-split3
5825 @opindex fdump-rtl-split4
5826 @opindex fdump-rtl-split5
5827 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5828 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5829 @option{-fdump-rtl-split5} enable dumping after five rounds of
5830 instruction splitting.
5831
5832 @item -fdump-rtl-sms
5833 @opindex fdump-rtl-sms
5834 Dump after modulo scheduling. This pass is only run on some
5835 architectures.
5836
5837 @item -fdump-rtl-stack
5838 @opindex fdump-rtl-stack
5839 Dump after conversion from GCC's ``flat register file'' registers to the
5840 x87's stack-like registers. This pass is only run on x86 variants.
5841
5842 @item -fdump-rtl-subreg1
5843 @itemx -fdump-rtl-subreg2
5844 @opindex fdump-rtl-subreg1
5845 @opindex fdump-rtl-subreg2
5846 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5847 the two subreg expansion passes.
5848
5849 @item -fdump-rtl-unshare
5850 @opindex fdump-rtl-unshare
5851 Dump after all rtl has been unshared.
5852
5853 @item -fdump-rtl-vartrack
5854 @opindex fdump-rtl-vartrack
5855 Dump after variable tracking.
5856
5857 @item -fdump-rtl-vregs
5858 @opindex fdump-rtl-vregs
5859 Dump after converting virtual registers to hard registers.
5860
5861 @item -fdump-rtl-web
5862 @opindex fdump-rtl-web
5863 Dump after live range splitting.
5864
5865 @item -fdump-rtl-regclass
5866 @itemx -fdump-rtl-subregs_of_mode_init
5867 @itemx -fdump-rtl-subregs_of_mode_finish
5868 @itemx -fdump-rtl-dfinit
5869 @itemx -fdump-rtl-dfinish
5870 @opindex fdump-rtl-regclass
5871 @opindex fdump-rtl-subregs_of_mode_init
5872 @opindex fdump-rtl-subregs_of_mode_finish
5873 @opindex fdump-rtl-dfinit
5874 @opindex fdump-rtl-dfinish
5875 These dumps are defined but always produce empty files.
5876
5877 @item -da
5878 @itemx -fdump-rtl-all
5879 @opindex da
5880 @opindex fdump-rtl-all
5881 Produce all the dumps listed above.
5882
5883 @item -dA
5884 @opindex dA
5885 Annotate the assembler output with miscellaneous debugging information.
5886
5887 @item -dD
5888 @opindex dD
5889 Dump all macro definitions, at the end of preprocessing, in addition to
5890 normal output.
5891
5892 @item -dH
5893 @opindex dH
5894 Produce a core dump whenever an error occurs.
5895
5896 @item -dp
5897 @opindex dp
5898 Annotate the assembler output with a comment indicating which
5899 pattern and alternative is used. The length of each instruction is
5900 also printed.
5901
5902 @item -dP
5903 @opindex dP
5904 Dump the RTL in the assembler output as a comment before each instruction.
5905 Also turns on @option{-dp} annotation.
5906
5907 @item -dx
5908 @opindex dx
5909 Just generate RTL for a function instead of compiling it. Usually used
5910 with @option{-fdump-rtl-expand}.
5911 @end table
5912
5913 @item -fdump-noaddr
5914 @opindex fdump-noaddr
5915 When doing debugging dumps, suppress address output. This makes it more
5916 feasible to use diff on debugging dumps for compiler invocations with
5917 different compiler binaries and/or different
5918 text / bss / data / heap / stack / dso start locations.
5919
5920 @item -fdump-unnumbered
5921 @opindex fdump-unnumbered
5922 When doing debugging dumps, suppress instruction numbers and address output.
5923 This makes it more feasible to use diff on debugging dumps for compiler
5924 invocations with different options, in particular with and without
5925 @option{-g}.
5926
5927 @item -fdump-unnumbered-links
5928 @opindex fdump-unnumbered-links
5929 When doing debugging dumps (see @option{-d} option above), suppress
5930 instruction numbers for the links to the previous and next instructions
5931 in a sequence.
5932
5933 @item -fdump-translation-unit @r{(C++ only)}
5934 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5935 @opindex fdump-translation-unit
5936 Dump a representation of the tree structure for the entire translation
5937 unit to a file. The file name is made by appending @file{.tu} to the
5938 source file name, and the file is created in the same directory as the
5939 output file. If the @samp{-@var{options}} form is used, @var{options}
5940 controls the details of the dump as described for the
5941 @option{-fdump-tree} options.
5942
5943 @item -fdump-class-hierarchy @r{(C++ only)}
5944 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5945 @opindex fdump-class-hierarchy
5946 Dump a representation of each class's hierarchy and virtual function
5947 table layout to a file. The file name is made by appending
5948 @file{.class} to the source file name, and the file is created in the
5949 same directory as the output file. If the @samp{-@var{options}} form
5950 is used, @var{options} controls the details of the dump as described
5951 for the @option{-fdump-tree} options.
5952
5953 @item -fdump-ipa-@var{switch}
5954 @opindex fdump-ipa
5955 Control the dumping at various stages of inter-procedural analysis
5956 language tree to a file. The file name is generated by appending a
5957 switch specific suffix to the source file name, and the file is created
5958 in the same directory as the output file. The following dumps are
5959 possible:
5960
5961 @table @samp
5962 @item all
5963 Enables all inter-procedural analysis dumps.
5964
5965 @item cgraph
5966 Dumps information about call-graph optimization, unused function removal,
5967 and inlining decisions.
5968
5969 @item inline
5970 Dump after function inlining.
5971
5972 @end table
5973
5974 @item -fdump-passes
5975 @opindex fdump-passes
5976 Dump the list of optimization passes that are turned on and off by
5977 the current command-line options.
5978
5979 @item -fdump-statistics-@var{option}
5980 @opindex fdump-statistics
5981 Enable and control dumping of pass statistics in a separate file. The
5982 file name is generated by appending a suffix ending in
5983 @samp{.statistics} to the source file name, and the file is created in
5984 the same directory as the output file. If the @samp{-@var{option}}
5985 form is used, @samp{-stats} causes counters to be summed over the
5986 whole compilation unit while @samp{-details} dumps every event as
5987 the passes generate them. The default with no option is to sum
5988 counters for each function compiled.
5989
5990 @item -fdump-tree-@var{switch}
5991 @itemx -fdump-tree-@var{switch}-@var{options}
5992 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
5993 @opindex fdump-tree
5994 Control the dumping at various stages of processing the intermediate
5995 language tree to a file. The file name is generated by appending a
5996 switch-specific suffix to the source file name, and the file is
5997 created in the same directory as the output file. In case of
5998 @option{=@var{filename}} option, the dump is output on the given file
5999 instead of the auto named dump files. If the @samp{-@var{options}}
6000 form is used, @var{options} is a list of @samp{-} separated options
6001 which control the details of the dump. Not all options are applicable
6002 to all dumps; those that are not meaningful are ignored. The
6003 following options are available
6004
6005 @table @samp
6006 @item address
6007 Print the address of each node. Usually this is not meaningful as it
6008 changes according to the environment and source file. Its primary use
6009 is for tying up a dump file with a debug environment.
6010 @item asmname
6011 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6012 in the dump instead of @code{DECL_NAME}. Its primary use is ease of
6013 use working backward from mangled names in the assembly file.
6014 @item slim
6015 When dumping front-end intermediate representations, inhibit dumping
6016 of members of a scope or body of a function merely because that scope
6017 has been reached. Only dump such items when they are directly reachable
6018 by some other path.
6019
6020 When dumping pretty-printed trees, this option inhibits dumping the
6021 bodies of control structures.
6022
6023 When dumping RTL, print the RTL in slim (condensed) form instead of
6024 the default LISP-like representation.
6025 @item raw
6026 Print a raw representation of the tree. By default, trees are
6027 pretty-printed into a C-like representation.
6028 @item details
6029 Enable more detailed dumps (not honored by every dump option). Also
6030 include information from the optimization passes.
6031 @item stats
6032 Enable dumping various statistics about the pass (not honored by every dump
6033 option).
6034 @item blocks
6035 Enable showing basic block boundaries (disabled in raw dumps).
6036 @item graph
6037 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6038 dump a representation of the control flow graph suitable for viewing with
6039 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}. Each function in
6040 the file is pretty-printed as a subgraph, so that GraphViz can render them
6041 all in a single plot.
6042
6043 This option currently only works for RTL dumps, and the RTL is always
6044 dumped in slim form.
6045 @item vops
6046 Enable showing virtual operands for every statement.
6047 @item lineno
6048 Enable showing line numbers for statements.
6049 @item uid
6050 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6051 @item verbose
6052 Enable showing the tree dump for each statement.
6053 @item eh
6054 Enable showing the EH region number holding each statement.
6055 @item scev
6056 Enable showing scalar evolution analysis details.
6057 @item optimized
6058 Enable showing optimization information (only available in certain
6059 passes).
6060 @item missed
6061 Enable showing missed optimization information (only available in certain
6062 passes).
6063 @item notes
6064 Enable other detailed optimization information (only available in
6065 certain passes).
6066 @item =@var{filename}
6067 Instead of an auto named dump file, output into the given file
6068 name. The file names @file{stdout} and @file{stderr} are treated
6069 specially and are considered already open standard streams. For
6070 example,
6071
6072 @smallexample
6073 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6074 -fdump-tree-pre=stderr file.c
6075 @end smallexample
6076
6077 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6078 output on to @file{stderr}. If two conflicting dump filenames are
6079 given for the same pass, then the latter option overrides the earlier
6080 one.
6081
6082 @item all
6083 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6084 and @option{lineno}.
6085
6086 @item optall
6087 Turn on all optimization options, i.e., @option{optimized},
6088 @option{missed}, and @option{note}.
6089 @end table
6090
6091 The following tree dumps are possible:
6092 @table @samp
6093
6094 @item original
6095 @opindex fdump-tree-original
6096 Dump before any tree based optimization, to @file{@var{file}.original}.
6097
6098 @item optimized
6099 @opindex fdump-tree-optimized
6100 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6101
6102 @item gimple
6103 @opindex fdump-tree-gimple
6104 Dump each function before and after the gimplification pass to a file. The
6105 file name is made by appending @file{.gimple} to the source file name.
6106
6107 @item cfg
6108 @opindex fdump-tree-cfg
6109 Dump the control flow graph of each function to a file. The file name is
6110 made by appending @file{.cfg} to the source file name.
6111
6112 @item ch
6113 @opindex fdump-tree-ch
6114 Dump each function after copying loop headers. The file name is made by
6115 appending @file{.ch} to the source file name.
6116
6117 @item ssa
6118 @opindex fdump-tree-ssa
6119 Dump SSA related information to a file. The file name is made by appending
6120 @file{.ssa} to the source file name.
6121
6122 @item alias
6123 @opindex fdump-tree-alias
6124 Dump aliasing information for each function. The file name is made by
6125 appending @file{.alias} to the source file name.
6126
6127 @item ccp
6128 @opindex fdump-tree-ccp
6129 Dump each function after CCP@. The file name is made by appending
6130 @file{.ccp} to the source file name.
6131
6132 @item storeccp
6133 @opindex fdump-tree-storeccp
6134 Dump each function after STORE-CCP@. The file name is made by appending
6135 @file{.storeccp} to the source file name.
6136
6137 @item pre
6138 @opindex fdump-tree-pre
6139 Dump trees after partial redundancy elimination. The file name is made
6140 by appending @file{.pre} to the source file name.
6141
6142 @item fre
6143 @opindex fdump-tree-fre
6144 Dump trees after full redundancy elimination. The file name is made
6145 by appending @file{.fre} to the source file name.
6146
6147 @item copyprop
6148 @opindex fdump-tree-copyprop
6149 Dump trees after copy propagation. The file name is made
6150 by appending @file{.copyprop} to the source file name.
6151
6152 @item store_copyprop
6153 @opindex fdump-tree-store_copyprop
6154 Dump trees after store copy-propagation. The file name is made
6155 by appending @file{.store_copyprop} to the source file name.
6156
6157 @item dce
6158 @opindex fdump-tree-dce
6159 Dump each function after dead code elimination. The file name is made by
6160 appending @file{.dce} to the source file name.
6161
6162 @item mudflap
6163 @opindex fdump-tree-mudflap
6164 Dump each function after adding mudflap instrumentation. The file name is
6165 made by appending @file{.mudflap} to the source file name.
6166
6167 @item sra
6168 @opindex fdump-tree-sra
6169 Dump each function after performing scalar replacement of aggregates. The
6170 file name is made by appending @file{.sra} to the source file name.
6171
6172 @item sink
6173 @opindex fdump-tree-sink
6174 Dump each function after performing code sinking. The file name is made
6175 by appending @file{.sink} to the source file name.
6176
6177 @item dom
6178 @opindex fdump-tree-dom
6179 Dump each function after applying dominator tree optimizations. The file
6180 name is made by appending @file{.dom} to the source file name.
6181
6182 @item dse
6183 @opindex fdump-tree-dse
6184 Dump each function after applying dead store elimination. The file
6185 name is made by appending @file{.dse} to the source file name.
6186
6187 @item phiopt
6188 @opindex fdump-tree-phiopt
6189 Dump each function after optimizing PHI nodes into straightline code. The file
6190 name is made by appending @file{.phiopt} to the source file name.
6191
6192 @item forwprop
6193 @opindex fdump-tree-forwprop
6194 Dump each function after forward propagating single use variables. The file
6195 name is made by appending @file{.forwprop} to the source file name.
6196
6197 @item copyrename
6198 @opindex fdump-tree-copyrename
6199 Dump each function after applying the copy rename optimization. The file
6200 name is made by appending @file{.copyrename} to the source file name.
6201
6202 @item nrv
6203 @opindex fdump-tree-nrv
6204 Dump each function after applying the named return value optimization on
6205 generic trees. The file name is made by appending @file{.nrv} to the source
6206 file name.
6207
6208 @item vect
6209 @opindex fdump-tree-vect
6210 Dump each function after applying vectorization of loops. The file name is
6211 made by appending @file{.vect} to the source file name.
6212
6213 @item slp
6214 @opindex fdump-tree-slp
6215 Dump each function after applying vectorization of basic blocks. The file name
6216 is made by appending @file{.slp} to the source file name.
6217
6218 @item vrp
6219 @opindex fdump-tree-vrp
6220 Dump each function after Value Range Propagation (VRP). The file name
6221 is made by appending @file{.vrp} to the source file name.
6222
6223 @item all
6224 @opindex fdump-tree-all
6225 Enable all the available tree dumps with the flags provided in this option.
6226 @end table
6227
6228 @item -fopt-info
6229 @itemx -fopt-info-@var{options}
6230 @itemx -fopt-info-@var{options}=@var{filename}
6231 @opindex fopt-info
6232 Controls optimization dumps from various optimization passes. If the
6233 @samp{-@var{options}} form is used, @var{options} is a list of
6234 @samp{-} separated options to select the dump details and
6235 optimizations. If @var{options} is not specified, it defaults to
6236 @option{optimized} for details and @option{optall} for optimization
6237 groups. If the @var{filename} is not specified, it defaults to
6238 @file{stderr}. Note that the output @var{filename} will be overwritten
6239 in case of multiple translation units. If a combined output from
6240 multiple translation units is desired, @file{stderr} should be used
6241 instead.
6242
6243 The options can be divided into two groups, 1) options describing the
6244 verbosity of the dump, and 2) options describing which optimizations
6245 should be included. The options from both the groups can be freely
6246 mixed as they are non-overlapping. However, in case of any conflicts,
6247 the latter options override the earlier options on the command
6248 line. Though multiple -fopt-info options are accepted, only one of
6249 them can have @option{=filename}. If other filenames are provided then
6250 all but the first one are ignored.
6251
6252 The dump verbosity has the following options
6253
6254 @table @samp
6255 @item optimized
6256 Print information when an optimization is successfully applied. It is
6257 up to a pass to decide which information is relevant. For example, the
6258 vectorizer passes print the source location of loops which got
6259 successfully vectorized.
6260 @item missed
6261 Print information about missed optimizations. Individual passes
6262 control which information to include in the output. For example,
6263
6264 @smallexample
6265 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6266 @end smallexample
6267
6268 will print information about missed optimization opportunities from
6269 vectorization passes on stderr.
6270 @item note
6271 Print verbose information about optimizations, such as certain
6272 transformations, more detailed messages about decisions etc.
6273 @item all
6274 Print detailed optimization information. This includes
6275 @var{optimized}, @var{missed}, and @var{note}.
6276 @end table
6277
6278 The second set of options describes a group of optimizations and may
6279 include one or more of the following.
6280
6281 @table @samp
6282 @item ipa
6283 Enable dumps from all interprocedural optimizations.
6284 @item loop
6285 Enable dumps from all loop optimizations.
6286 @item inline
6287 Enable dumps from all inlining optimizations.
6288 @item vec
6289 Enable dumps from all vectorization optimizations.
6290 @end table
6291
6292 For example,
6293 @smallexample
6294 gcc -O3 -fopt-info-missed=missed.all
6295 @end smallexample
6296
6297 outputs missed optimization report from all the passes into
6298 @file{missed.all}.
6299
6300 As another example,
6301 @smallexample
6302 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6303 @end smallexample
6304
6305 will output information about missed optimizations as well as
6306 optimized locations from all the inlining passes into
6307 @file{inline.txt}.
6308
6309 If the @var{filename} is provided, then the dumps from all the
6310 applicable optimizations are concatenated into the @file{filename}.
6311 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6312 omitted, it defaults to @option{all-optall}, which means dump all
6313 available optimization info from all the passes. In the following
6314 example, all optimization info is output on to @file{stderr}.
6315
6316 @smallexample
6317 gcc -O3 -fopt-info
6318 @end smallexample
6319
6320 Note that @option{-fopt-info-vec-missed} behaves the same as
6321 @option{-fopt-info-missed-vec}.
6322
6323 As another example, consider
6324
6325 @smallexample
6326 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6327 @end smallexample
6328
6329 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6330 in conflict since only one output file is allowed. In this case, only
6331 the first option takes effect and the subsequent options are
6332 ignored. Thus only the @file{vec.miss} is produced which cotaints
6333 dumps from the vectorizer about missed opportunities.
6334
6335 @item -ftree-vectorizer-verbose=@var{n}
6336 @opindex ftree-vectorizer-verbose
6337 This option is deprecated and is implemented in terms of
6338 @option{-fopt-info}. Please use @option{-fopt-info-@var{kind}} form
6339 instead, where @var{kind} is one of the valid opt-info options. It
6340 prints additional optimization information. For @var{n}=0 no
6341 diagnostic information is reported. If @var{n}=1 the vectorizer
6342 reports each loop that got vectorized, and the total number of loops
6343 that got vectorized. If @var{n}=2 the vectorizer reports locations
6344 which could not be vectorized and the reasons for those. For any
6345 higher verbosity levels all the analysis and transformation
6346 information from the vectorizer is reported.
6347
6348 Note that the information output by @option{-ftree-vectorizer-verbose}
6349 option is sent to @file{stderr}. If the equivalent form
6350 @option{-fopt-info-@var{options}=@var{filename}} is used then the
6351 output is sent into @var{filename} instead.
6352
6353 @item -frandom-seed=@var{string}
6354 @opindex frandom-seed
6355 This option provides a seed that GCC uses in place of
6356 random numbers in generating certain symbol names
6357 that have to be different in every compiled file. It is also used to
6358 place unique stamps in coverage data files and the object files that
6359 produce them. You can use the @option{-frandom-seed} option to produce
6360 reproducibly identical object files.
6361
6362 The @var{string} should be different for every file you compile.
6363
6364 @item -fsched-verbose=@var{n}
6365 @opindex fsched-verbose
6366 On targets that use instruction scheduling, this option controls the
6367 amount of debugging output the scheduler prints. This information is
6368 written to standard error, unless @option{-fdump-rtl-sched1} or
6369 @option{-fdump-rtl-sched2} is specified, in which case it is output
6370 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6371 respectively. However for @var{n} greater than nine, the output is
6372 always printed to standard error.
6373
6374 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6375 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6376 For @var{n} greater than one, it also output basic block probabilities,
6377 detailed ready list information and unit/insn info. For @var{n} greater
6378 than two, it includes RTL at abort point, control-flow and regions info.
6379 And for @var{n} over four, @option{-fsched-verbose} also includes
6380 dependence info.
6381
6382 @item -save-temps
6383 @itemx -save-temps=cwd
6384 @opindex save-temps
6385 Store the usual ``temporary'' intermediate files permanently; place them
6386 in the current directory and name them based on the source file. Thus,
6387 compiling @file{foo.c} with @option{-c -save-temps} produces files
6388 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
6389 preprocessed @file{foo.i} output file even though the compiler now
6390 normally uses an integrated preprocessor.
6391
6392 When used in combination with the @option{-x} command-line option,
6393 @option{-save-temps} is sensible enough to avoid over writing an
6394 input source file with the same extension as an intermediate file.
6395 The corresponding intermediate file may be obtained by renaming the
6396 source file before using @option{-save-temps}.
6397
6398 If you invoke GCC in parallel, compiling several different source
6399 files that share a common base name in different subdirectories or the
6400 same source file compiled for multiple output destinations, it is
6401 likely that the different parallel compilers will interfere with each
6402 other, and overwrite the temporary files. For instance:
6403
6404 @smallexample
6405 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6406 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6407 @end smallexample
6408
6409 may result in @file{foo.i} and @file{foo.o} being written to
6410 simultaneously by both compilers.
6411
6412 @item -save-temps=obj
6413 @opindex save-temps=obj
6414 Store the usual ``temporary'' intermediate files permanently. If the
6415 @option{-o} option is used, the temporary files are based on the
6416 object file. If the @option{-o} option is not used, the
6417 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6418
6419 For example:
6420
6421 @smallexample
6422 gcc -save-temps=obj -c foo.c
6423 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6424 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6425 @end smallexample
6426
6427 @noindent
6428 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6429 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6430 @file{dir2/yfoobar.o}.
6431
6432 @item -time@r{[}=@var{file}@r{]}
6433 @opindex time
6434 Report the CPU time taken by each subprocess in the compilation
6435 sequence. For C source files, this is the compiler proper and assembler
6436 (plus the linker if linking is done).
6437
6438 Without the specification of an output file, the output looks like this:
6439
6440 @smallexample
6441 # cc1 0.12 0.01
6442 # as 0.00 0.01
6443 @end smallexample
6444
6445 The first number on each line is the ``user time'', that is time spent
6446 executing the program itself. The second number is ``system time'',
6447 time spent executing operating system routines on behalf of the program.
6448 Both numbers are in seconds.
6449
6450 With the specification of an output file, the output is appended to the
6451 named file, and it looks like this:
6452
6453 @smallexample
6454 0.12 0.01 cc1 @var{options}
6455 0.00 0.01 as @var{options}
6456 @end smallexample
6457
6458 The ``user time'' and the ``system time'' are moved before the program
6459 name, and the options passed to the program are displayed, so that one
6460 can later tell what file was being compiled, and with which options.
6461
6462 @item -fvar-tracking
6463 @opindex fvar-tracking
6464 Run variable tracking pass. It computes where variables are stored at each
6465 position in code. Better debugging information is then generated
6466 (if the debugging information format supports this information).
6467
6468 It is enabled by default when compiling with optimization (@option{-Os},
6469 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6470 the debug info format supports it.
6471
6472 @item -fvar-tracking-assignments
6473 @opindex fvar-tracking-assignments
6474 @opindex fno-var-tracking-assignments
6475 Annotate assignments to user variables early in the compilation and
6476 attempt to carry the annotations over throughout the compilation all the
6477 way to the end, in an attempt to improve debug information while
6478 optimizing. Use of @option{-gdwarf-4} is recommended along with it.
6479
6480 It can be enabled even if var-tracking is disabled, in which case
6481 annotations are created and maintained, but discarded at the end.
6482
6483 @item -fvar-tracking-assignments-toggle
6484 @opindex fvar-tracking-assignments-toggle
6485 @opindex fno-var-tracking-assignments-toggle
6486 Toggle @option{-fvar-tracking-assignments}, in the same way that
6487 @option{-gtoggle} toggles @option{-g}.
6488
6489 @item -print-file-name=@var{library}
6490 @opindex print-file-name
6491 Print the full absolute name of the library file @var{library} that
6492 would be used when linking---and don't do anything else. With this
6493 option, GCC does not compile or link anything; it just prints the
6494 file name.
6495
6496 @item -print-multi-directory
6497 @opindex print-multi-directory
6498 Print the directory name corresponding to the multilib selected by any
6499 other switches present in the command line. This directory is supposed
6500 to exist in @env{GCC_EXEC_PREFIX}.
6501
6502 @item -print-multi-lib
6503 @opindex print-multi-lib
6504 Print the mapping from multilib directory names to compiler switches
6505 that enable them. The directory name is separated from the switches by
6506 @samp{;}, and each switch starts with an @samp{@@} instead of the
6507 @samp{-}, without spaces between multiple switches. This is supposed to
6508 ease shell processing.
6509
6510 @item -print-multi-os-directory
6511 @opindex print-multi-os-directory
6512 Print the path to OS libraries for the selected
6513 multilib, relative to some @file{lib} subdirectory. If OS libraries are
6514 present in the @file{lib} subdirectory and no multilibs are used, this is
6515 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6516 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6517 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6518 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6519
6520 @item -print-multiarch
6521 @opindex print-multiarch
6522 Print the path to OS libraries for the selected multiarch,
6523 relative to some @file{lib} subdirectory.
6524
6525 @item -print-prog-name=@var{program}
6526 @opindex print-prog-name
6527 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6528
6529 @item -print-libgcc-file-name
6530 @opindex print-libgcc-file-name
6531 Same as @option{-print-file-name=libgcc.a}.
6532
6533 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6534 but you do want to link with @file{libgcc.a}. You can do:
6535
6536 @smallexample
6537 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6538 @end smallexample
6539
6540 @item -print-search-dirs
6541 @opindex print-search-dirs
6542 Print the name of the configured installation directory and a list of
6543 program and library directories @command{gcc} searches---and don't do anything else.
6544
6545 This is useful when @command{gcc} prints the error message
6546 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6547 To resolve this you either need to put @file{cpp0} and the other compiler
6548 components where @command{gcc} expects to find them, or you can set the environment
6549 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6550 Don't forget the trailing @samp{/}.
6551 @xref{Environment Variables}.
6552
6553 @item -print-sysroot
6554 @opindex print-sysroot
6555 Print the target sysroot directory that is used during
6556 compilation. This is the target sysroot specified either at configure
6557 time or using the @option{--sysroot} option, possibly with an extra
6558 suffix that depends on compilation options. If no target sysroot is
6559 specified, the option prints nothing.
6560
6561 @item -print-sysroot-headers-suffix
6562 @opindex print-sysroot-headers-suffix
6563 Print the suffix added to the target sysroot when searching for
6564 headers, or give an error if the compiler is not configured with such
6565 a suffix---and don't do anything else.
6566
6567 @item -dumpmachine
6568 @opindex dumpmachine
6569 Print the compiler's target machine (for example,
6570 @samp{i686-pc-linux-gnu})---and don't do anything else.
6571
6572 @item -dumpversion
6573 @opindex dumpversion
6574 Print the compiler version (for example, @samp{3.0})---and don't do
6575 anything else.
6576
6577 @item -dumpspecs
6578 @opindex dumpspecs
6579 Print the compiler's built-in specs---and don't do anything else. (This
6580 is used when GCC itself is being built.) @xref{Spec Files}.
6581
6582 @item -fno-eliminate-unused-debug-types
6583 @opindex feliminate-unused-debug-types
6584 @opindex fno-eliminate-unused-debug-types
6585 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol
6586 output for types that are nowhere used in the source file being compiled.
6587 Sometimes it is useful to have GCC emit debugging
6588 information for all types declared in a compilation
6589 unit, regardless of whether or not they are actually used
6590 in that compilation unit, for example
6591 if, in the debugger, you want to cast a value to a type that is
6592 not actually used in your program (but is declared). More often,
6593 however, this results in a significant amount of wasted space.
6594 @end table
6595
6596 @node Optimize Options
6597 @section Options That Control Optimization
6598 @cindex optimize options
6599 @cindex options, optimization
6600
6601 These options control various sorts of optimizations.
6602
6603 Without any optimization option, the compiler's goal is to reduce the
6604 cost of compilation and to make debugging produce the expected
6605 results. Statements are independent: if you stop the program with a
6606 breakpoint between statements, you can then assign a new value to any
6607 variable or change the program counter to any other statement in the
6608 function and get exactly the results you expect from the source
6609 code.
6610
6611 Turning on optimization flags makes the compiler attempt to improve
6612 the performance and/or code size at the expense of compilation time
6613 and possibly the ability to debug the program.
6614
6615 The compiler performs optimization based on the knowledge it has of the
6616 program. Compiling multiple files at once to a single output file mode allows
6617 the compiler to use information gained from all of the files when compiling
6618 each of them.
6619
6620 Not all optimizations are controlled directly by a flag. Only
6621 optimizations that have a flag are listed in this section.
6622
6623 Most optimizations are only enabled if an @option{-O} level is set on
6624 the command line. Otherwise they are disabled, even if individual
6625 optimization flags are specified.
6626
6627 Depending on the target and how GCC was configured, a slightly different
6628 set of optimizations may be enabled at each @option{-O} level than
6629 those listed here. You can invoke GCC with @option{-Q --help=optimizers}
6630 to find out the exact set of optimizations that are enabled at each level.
6631 @xref{Overall Options}, for examples.
6632
6633 @table @gcctabopt
6634 @item -O
6635 @itemx -O1
6636 @opindex O
6637 @opindex O1
6638 Optimize. Optimizing compilation takes somewhat more time, and a lot
6639 more memory for a large function.
6640
6641 With @option{-O}, the compiler tries to reduce code size and execution
6642 time, without performing any optimizations that take a great deal of
6643 compilation time.
6644
6645 @option{-O} turns on the following optimization flags:
6646 @gccoptlist{
6647 -fauto-inc-dec @gol
6648 -fcompare-elim @gol
6649 -fcprop-registers @gol
6650 -fdce @gol
6651 -fdefer-pop @gol
6652 -fdelayed-branch @gol
6653 -fdse @gol
6654 -fguess-branch-probability @gol
6655 -fif-conversion2 @gol
6656 -fif-conversion @gol
6657 -fipa-pure-const @gol
6658 -fipa-profile @gol
6659 -fipa-reference @gol
6660 -fmerge-constants
6661 -fsplit-wide-types @gol
6662 -ftree-bit-ccp @gol
6663 -ftree-builtin-call-dce @gol
6664 -ftree-ccp @gol
6665 -ftree-ch @gol
6666 -ftree-copyrename @gol
6667 -ftree-dce @gol
6668 -ftree-dominator-opts @gol
6669 -ftree-dse @gol
6670 -ftree-forwprop @gol
6671 -ftree-fre @gol
6672 -ftree-phiprop @gol
6673 -ftree-slsr @gol
6674 -ftree-sra @gol
6675 -ftree-pta @gol
6676 -ftree-ter @gol
6677 -funit-at-a-time}
6678
6679 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6680 where doing so does not interfere with debugging.
6681
6682 @item -O2
6683 @opindex O2
6684 Optimize even more. GCC performs nearly all supported optimizations
6685 that do not involve a space-speed tradeoff.
6686 As compared to @option{-O}, this option increases both compilation time
6687 and the performance of the generated code.
6688
6689 @option{-O2} turns on all optimization flags specified by @option{-O}. It
6690 also turns on the following optimization flags:
6691 @gccoptlist{-fthread-jumps @gol
6692 -falign-functions -falign-jumps @gol
6693 -falign-loops -falign-labels @gol
6694 -fcaller-saves @gol
6695 -fcrossjumping @gol
6696 -fcse-follow-jumps -fcse-skip-blocks @gol
6697 -fdelete-null-pointer-checks @gol
6698 -fdevirtualize @gol
6699 -fexpensive-optimizations @gol
6700 -fgcse -fgcse-lm @gol
6701 -fhoist-adjacent-loads @gol
6702 -finline-small-functions @gol
6703 -findirect-inlining @gol
6704 -fipa-sra @gol
6705 -foptimize-sibling-calls @gol
6706 -fpartial-inlining @gol
6707 -fpeephole2 @gol
6708 -fregmove @gol
6709 -freorder-blocks -freorder-functions @gol
6710 -frerun-cse-after-loop @gol
6711 -fsched-interblock -fsched-spec @gol
6712 -fschedule-insns -fschedule-insns2 @gol
6713 -fstrict-aliasing -fstrict-overflow @gol
6714 -ftree-switch-conversion -ftree-tail-merge @gol
6715 -ftree-pre @gol
6716 -ftree-vrp}
6717
6718 Please note the warning under @option{-fgcse} about
6719 invoking @option{-O2} on programs that use computed gotos.
6720
6721 @item -O3
6722 @opindex O3
6723 Optimize yet more. @option{-O3} turns on all optimizations specified
6724 by @option{-O2} and also turns on the @option{-finline-functions},
6725 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6726 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6727 @option{-fvect-cost-model},
6728 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6729
6730 @item -O0
6731 @opindex O0
6732 Reduce compilation time and make debugging produce the expected
6733 results. This is the default.
6734
6735 @item -Os
6736 @opindex Os
6737 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
6738 do not typically increase code size. It also performs further
6739 optimizations designed to reduce code size.
6740
6741 @option{-Os} disables the following optimization flags:
6742 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
6743 -falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
6744 -fprefetch-loop-arrays -ftree-vect-loop-version}
6745
6746 @item -Ofast
6747 @opindex Ofast
6748 Disregard strict standards compliance. @option{-Ofast} enables all
6749 @option{-O3} optimizations. It also enables optimizations that are not
6750 valid for all standard-compliant programs.
6751 It turns on @option{-ffast-math} and the Fortran-specific
6752 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6753
6754 @item -Og
6755 @opindex Og
6756 Optimize debugging experience. @option{-Og} enables optimizations
6757 that do not interfere with debugging. It should be the optimization
6758 level of choice for the standard edit-compile-debug cycle, offering
6759 a reasonable level of optimization while maintaining fast compilation
6760 and a good debugging experience.
6761
6762 If you use multiple @option{-O} options, with or without level numbers,
6763 the last such option is the one that is effective.
6764 @end table
6765
6766 Options of the form @option{-f@var{flag}} specify machine-independent
6767 flags. Most flags have both positive and negative forms; the negative
6768 form of @option{-ffoo} is @option{-fno-foo}. In the table
6769 below, only one of the forms is listed---the one you typically
6770 use. You can figure out the other form by either removing @samp{no-}
6771 or adding it.
6772
6773 The following options control specific optimizations. They are either
6774 activated by @option{-O} options or are related to ones that are. You
6775 can use the following flags in the rare cases when ``fine-tuning'' of
6776 optimizations to be performed is desired.
6777
6778 @table @gcctabopt
6779 @item -fno-default-inline
6780 @opindex fno-default-inline
6781 Do not make member functions inline by default merely because they are
6782 defined inside the class scope (C++ only). Otherwise, when you specify
6783 @w{@option{-O}}, member functions defined inside class scope are compiled
6784 inline by default; i.e., you don't need to add @samp{inline} in front of
6785 the member function name.
6786
6787 @item -fno-defer-pop
6788 @opindex fno-defer-pop
6789 Always pop the arguments to each function call as soon as that function
6790 returns. For machines that must pop arguments after a function call,
6791 the compiler normally lets arguments accumulate on the stack for several
6792 function calls and pops them all at once.
6793
6794 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6795
6796 @item -fforward-propagate
6797 @opindex fforward-propagate
6798 Perform a forward propagation pass on RTL@. The pass tries to combine two
6799 instructions and checks if the result can be simplified. If loop unrolling
6800 is active, two passes are performed and the second is scheduled after
6801 loop unrolling.
6802
6803 This option is enabled by default at optimization levels @option{-O},
6804 @option{-O2}, @option{-O3}, @option{-Os}.
6805
6806 @item -ffp-contract=@var{style}
6807 @opindex ffp-contract
6808 @option{-ffp-contract=off} disables floating-point expression contraction.
6809 @option{-ffp-contract=fast} enables floating-point expression contraction
6810 such as forming of fused multiply-add operations if the target has
6811 native support for them.
6812 @option{-ffp-contract=on} enables floating-point expression contraction
6813 if allowed by the language standard. This is currently not implemented
6814 and treated equal to @option{-ffp-contract=off}.
6815
6816 The default is @option{-ffp-contract=fast}.
6817
6818 @item -fomit-frame-pointer
6819 @opindex fomit-frame-pointer
6820 Don't keep the frame pointer in a register for functions that
6821 don't need one. This avoids the instructions to save, set up and
6822 restore frame pointers; it also makes an extra register available
6823 in many functions. @strong{It also makes debugging impossible on
6824 some machines.}
6825
6826 On some machines, such as the VAX, this flag has no effect, because
6827 the standard calling sequence automatically handles the frame pointer
6828 and nothing is saved by pretending it doesn't exist. The
6829 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6830 whether a target machine supports this flag. @xref{Registers,,Register
6831 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6832
6833 Starting with GCC version 4.6, the default setting (when not optimizing for
6834 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6835 @option{-fomit-frame-pointer}. The default can be reverted to
6836 @option{-fno-omit-frame-pointer} by configuring GCC with the
6837 @option{--enable-frame-pointer} configure option.
6838
6839 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6840
6841 @item -foptimize-sibling-calls
6842 @opindex foptimize-sibling-calls
6843 Optimize sibling and tail recursive calls.
6844
6845 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6846
6847 @item -fno-inline
6848 @opindex fno-inline
6849 Do not expand any functions inline apart from those marked with
6850 the @code{always_inline} attribute. This is the default when not
6851 optimizing.
6852
6853 Single functions can be exempted from inlining by marking them
6854 with the @code{noinline} attribute.
6855
6856 @item -finline-small-functions
6857 @opindex finline-small-functions
6858 Integrate functions into their callers when their body is smaller than expected
6859 function call code (so overall size of program gets smaller). The compiler
6860 heuristically decides which functions are simple enough to be worth integrating
6861 in this way. This inlining applies to all functions, even those not declared
6862 inline.
6863
6864 Enabled at level @option{-O2}.
6865
6866 @item -findirect-inlining
6867 @opindex findirect-inlining
6868 Inline also indirect calls that are discovered to be known at compile
6869 time thanks to previous inlining. This option has any effect only
6870 when inlining itself is turned on by the @option{-finline-functions}
6871 or @option{-finline-small-functions} options.
6872
6873 Enabled at level @option{-O2}.
6874
6875 @item -finline-functions
6876 @opindex finline-functions
6877 Consider all functions for inlining, even if they are not declared inline.
6878 The compiler heuristically decides which functions are worth integrating
6879 in this way.
6880
6881 If all calls to a given function are integrated, and the function is
6882 declared @code{static}, then the function is normally not output as
6883 assembler code in its own right.
6884
6885 Enabled at level @option{-O3}.
6886
6887 @item -finline-functions-called-once
6888 @opindex finline-functions-called-once
6889 Consider all @code{static} functions called once for inlining into their
6890 caller even if they are not marked @code{inline}. If a call to a given
6891 function is integrated, then the function is not output as assembler code
6892 in its own right.
6893
6894 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6895
6896 @item -fearly-inlining
6897 @opindex fearly-inlining
6898 Inline functions marked by @code{always_inline} and functions whose body seems
6899 smaller than the function call overhead early before doing
6900 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
6901 makes profiling significantly cheaper and usually inlining faster on programs
6902 having large chains of nested wrapper functions.
6903
6904 Enabled by default.
6905
6906 @item -fipa-sra
6907 @opindex fipa-sra
6908 Perform interprocedural scalar replacement of aggregates, removal of
6909 unused parameters and replacement of parameters passed by reference
6910 by parameters passed by value.
6911
6912 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6913
6914 @item -finline-limit=@var{n}
6915 @opindex finline-limit
6916 By default, GCC limits the size of functions that can be inlined. This flag
6917 allows coarse control of this limit. @var{n} is the size of functions that
6918 can be inlined in number of pseudo instructions.
6919
6920 Inlining is actually controlled by a number of parameters, which may be
6921 specified individually by using @option{--param @var{name}=@var{value}}.
6922 The @option{-finline-limit=@var{n}} option sets some of these parameters
6923 as follows:
6924
6925 @table @gcctabopt
6926 @item max-inline-insns-single
6927 is set to @var{n}/2.
6928 @item max-inline-insns-auto
6929 is set to @var{n}/2.
6930 @end table
6931
6932 See below for a documentation of the individual
6933 parameters controlling inlining and for the defaults of these parameters.
6934
6935 @emph{Note:} there may be no value to @option{-finline-limit} that results
6936 in default behavior.
6937
6938 @emph{Note:} pseudo instruction represents, in this particular context, an
6939 abstract measurement of function's size. In no way does it represent a count
6940 of assembly instructions and as such its exact meaning might change from one
6941 release to an another.
6942
6943 @item -fno-keep-inline-dllexport
6944 @opindex -fno-keep-inline-dllexport
6945 This is a more fine-grained version of @option{-fkeep-inline-functions},
6946 which applies only to functions that are declared using the @code{dllexport}
6947 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6948 Functions}.)
6949
6950 @item -fkeep-inline-functions
6951 @opindex fkeep-inline-functions
6952 In C, emit @code{static} functions that are declared @code{inline}
6953 into the object file, even if the function has been inlined into all
6954 of its callers. This switch does not affect functions using the
6955 @code{extern inline} extension in GNU C90@. In C++, emit any and all
6956 inline functions into the object file.
6957
6958 @item -fkeep-static-consts
6959 @opindex fkeep-static-consts
6960 Emit variables declared @code{static const} when optimization isn't turned
6961 on, even if the variables aren't referenced.
6962
6963 GCC enables this option by default. If you want to force the compiler to
6964 check if a variable is referenced, regardless of whether or not
6965 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6966
6967 @item -fmerge-constants
6968 @opindex fmerge-constants
6969 Attempt to merge identical constants (string constants and floating-point
6970 constants) across compilation units.
6971
6972 This option is the default for optimized compilation if the assembler and
6973 linker support it. Use @option{-fno-merge-constants} to inhibit this
6974 behavior.
6975
6976 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6977
6978 @item -fmerge-all-constants
6979 @opindex fmerge-all-constants
6980 Attempt to merge identical constants and identical variables.
6981
6982 This option implies @option{-fmerge-constants}. In addition to
6983 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6984 arrays or initialized constant variables with integral or floating-point
6985 types. Languages like C or C++ require each variable, including multiple
6986 instances of the same variable in recursive calls, to have distinct locations,
6987 so using this option results in non-conforming
6988 behavior.
6989
6990 @item -fmodulo-sched
6991 @opindex fmodulo-sched
6992 Perform swing modulo scheduling immediately before the first scheduling
6993 pass. This pass looks at innermost loops and reorders their
6994 instructions by overlapping different iterations.
6995
6996 @item -fmodulo-sched-allow-regmoves
6997 @opindex fmodulo-sched-allow-regmoves
6998 Perform more aggressive SMS-based modulo scheduling with register moves
6999 allowed. By setting this flag certain anti-dependences edges are
7000 deleted, which triggers the generation of reg-moves based on the
7001 life-range analysis. This option is effective only with
7002 @option{-fmodulo-sched} enabled.
7003
7004 @item -fno-branch-count-reg
7005 @opindex fno-branch-count-reg
7006 Do not use ``decrement and branch'' instructions on a count register,
7007 but instead generate a sequence of instructions that decrement a
7008 register, compare it against zero, then branch based upon the result.
7009 This option is only meaningful on architectures that support such
7010 instructions, which include x86, PowerPC, IA-64 and S/390.
7011
7012 The default is @option{-fbranch-count-reg}.
7013
7014 @item -fno-function-cse
7015 @opindex fno-function-cse
7016 Do not put function addresses in registers; make each instruction that
7017 calls a constant function contain the function's address explicitly.
7018
7019 This option results in less efficient code, but some strange hacks
7020 that alter the assembler output may be confused by the optimizations
7021 performed when this option is not used.
7022
7023 The default is @option{-ffunction-cse}
7024
7025 @item -fno-zero-initialized-in-bss
7026 @opindex fno-zero-initialized-in-bss
7027 If the target supports a BSS section, GCC by default puts variables that
7028 are initialized to zero into BSS@. This can save space in the resulting
7029 code.
7030
7031 This option turns off this behavior because some programs explicitly
7032 rely on variables going to the data section---e.g., so that the
7033 resulting executable can find the beginning of that section and/or make
7034 assumptions based on that.
7035
7036 The default is @option{-fzero-initialized-in-bss}.
7037
7038 @item -fmudflap -fmudflapth -fmudflapir
7039 @opindex fmudflap
7040 @opindex fmudflapth
7041 @opindex fmudflapir
7042 @cindex bounds checking
7043 @cindex mudflap
7044 For front-ends that support it (C and C++), instrument all risky
7045 pointer/array dereferencing operations, some standard library
7046 string/heap functions, and some other associated constructs with
7047 range/validity tests. Modules so instrumented should be immune to
7048 buffer overflows, invalid heap use, and some other classes of C/C++
7049 programming errors. The instrumentation relies on a separate runtime
7050 library (@file{libmudflap}), which is linked into a program if
7051 @option{-fmudflap} is given at link time. Run-time behavior of the
7052 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
7053 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
7054 for its options.
7055
7056 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
7057 link if your program is multi-threaded. Use @option{-fmudflapir}, in
7058 addition to @option{-fmudflap} or @option{-fmudflapth}, if
7059 instrumentation should ignore pointer reads. This produces less
7060 instrumentation (and therefore faster execution) and still provides
7061 some protection against outright memory corrupting writes, but allows
7062 erroneously read data to propagate within a program.
7063
7064 @item -fthread-jumps
7065 @opindex fthread-jumps
7066 Perform optimizations that check to see if a jump branches to a
7067 location where another comparison subsumed by the first is found. If
7068 so, the first branch is redirected to either the destination of the
7069 second branch or a point immediately following it, depending on whether
7070 the condition is known to be true or false.
7071
7072 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7073
7074 @item -fsplit-wide-types
7075 @opindex fsplit-wide-types
7076 When using a type that occupies multiple registers, such as @code{long
7077 long} on a 32-bit system, split the registers apart and allocate them
7078 independently. This normally generates better code for those types,
7079 but may make debugging more difficult.
7080
7081 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7082 @option{-Os}.
7083
7084 @item -fcse-follow-jumps
7085 @opindex fcse-follow-jumps
7086 In common subexpression elimination (CSE), scan through jump instructions
7087 when the target of the jump is not reached by any other path. For
7088 example, when CSE encounters an @code{if} statement with an
7089 @code{else} clause, CSE follows the jump when the condition
7090 tested is false.
7091
7092 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7093
7094 @item -fcse-skip-blocks
7095 @opindex fcse-skip-blocks
7096 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7097 follow jumps that conditionally skip over blocks. When CSE
7098 encounters a simple @code{if} statement with no else clause,
7099 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7100 body of the @code{if}.
7101
7102 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7103
7104 @item -frerun-cse-after-loop
7105 @opindex frerun-cse-after-loop
7106 Re-run common subexpression elimination after loop optimizations are
7107 performed.
7108
7109 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7110
7111 @item -fgcse
7112 @opindex fgcse
7113 Perform a global common subexpression elimination pass.
7114 This pass also performs global constant and copy propagation.
7115
7116 @emph{Note:} When compiling a program using computed gotos, a GCC
7117 extension, you may get better run-time performance if you disable
7118 the global common subexpression elimination pass by adding
7119 @option{-fno-gcse} to the command line.
7120
7121 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7122
7123 @item -fgcse-lm
7124 @opindex fgcse-lm
7125 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7126 attempts to move loads that are only killed by stores into themselves. This
7127 allows a loop containing a load/store sequence to be changed to a load outside
7128 the loop, and a copy/store within the loop.
7129
7130 Enabled by default when @option{-fgcse} is enabled.
7131
7132 @item -fgcse-sm
7133 @opindex fgcse-sm
7134 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7135 global common subexpression elimination. This pass attempts to move
7136 stores out of loops. When used in conjunction with @option{-fgcse-lm},
7137 loops containing a load/store sequence can be changed to a load before
7138 the loop and a store after the loop.
7139
7140 Not enabled at any optimization level.
7141
7142 @item -fgcse-las
7143 @opindex fgcse-las
7144 When @option{-fgcse-las} is enabled, the global common subexpression
7145 elimination pass eliminates redundant loads that come after stores to the
7146 same memory location (both partial and full redundancies).
7147
7148 Not enabled at any optimization level.
7149
7150 @item -fgcse-after-reload
7151 @opindex fgcse-after-reload
7152 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7153 pass is performed after reload. The purpose of this pass is to clean up
7154 redundant spilling.
7155
7156 @item -faggressive-loop-optimizations
7157 @opindex faggressive-loop-optimizations
7158 This option tells the loop optimizer to use language constraints to
7159 derive bounds for the number of iterations of a loop. This assumes that
7160 loop code does not invoke undefined behavior by for example causing signed
7161 integer overflows or out-of-bound array accesses. The bounds for the
7162 number of iterations of a loop are used to guide loop unrolling and peeling
7163 and loop exit test optimizations.
7164 This option is enabled by default.
7165
7166 @item -funsafe-loop-optimizations
7167 @opindex funsafe-loop-optimizations
7168 This option tells the loop optimizer to assume that loop indices do not
7169 overflow, and that loops with nontrivial exit condition are not
7170 infinite. This enables a wider range of loop optimizations even if
7171 the loop optimizer itself cannot prove that these assumptions are valid.
7172 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7173 if it finds this kind of loop.
7174
7175 @item -fcrossjumping
7176 @opindex fcrossjumping
7177 Perform cross-jumping transformation.
7178 This transformation unifies equivalent code and saves code size. The
7179 resulting code may or may not perform better than without cross-jumping.
7180
7181 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7182
7183 @item -fauto-inc-dec
7184 @opindex fauto-inc-dec
7185 Combine increments or decrements of addresses with memory accesses.
7186 This pass is always skipped on architectures that do not have
7187 instructions to support this. Enabled by default at @option{-O} and
7188 higher on architectures that support this.
7189
7190 @item -fdce
7191 @opindex fdce
7192 Perform dead code elimination (DCE) on RTL@.
7193 Enabled by default at @option{-O} and higher.
7194
7195 @item -fdse
7196 @opindex fdse
7197 Perform dead store elimination (DSE) on RTL@.
7198 Enabled by default at @option{-O} and higher.
7199
7200 @item -fif-conversion
7201 @opindex fif-conversion
7202 Attempt to transform conditional jumps into branch-less equivalents. This
7203 includes use of conditional moves, min, max, set flags and abs instructions, and
7204 some tricks doable by standard arithmetics. The use of conditional execution
7205 on chips where it is available is controlled by @code{if-conversion2}.
7206
7207 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7208
7209 @item -fif-conversion2
7210 @opindex fif-conversion2
7211 Use conditional execution (where available) to transform conditional jumps into
7212 branch-less equivalents.
7213
7214 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7215
7216 @item -fdelete-null-pointer-checks
7217 @opindex fdelete-null-pointer-checks
7218 Assume that programs cannot safely dereference null pointers, and that
7219 no code or data element resides there. This enables simple constant
7220 folding optimizations at all optimization levels. In addition, other
7221 optimization passes in GCC use this flag to control global dataflow
7222 analyses that eliminate useless checks for null pointers; these assume
7223 that if a pointer is checked after it has already been dereferenced,
7224 it cannot be null.
7225
7226 Note however that in some environments this assumption is not true.
7227 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7228 for programs that depend on that behavior.
7229
7230 Some targets, especially embedded ones, disable this option at all levels.
7231 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7232 @option{-O2}, @option{-O3}, @option{-Os}. Passes that use the information
7233 are enabled independently at different optimization levels.
7234
7235 @item -fdevirtualize
7236 @opindex fdevirtualize
7237 Attempt to convert calls to virtual functions to direct calls. This
7238 is done both within a procedure and interprocedurally as part of
7239 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7240 propagation (@option{-fipa-cp}).
7241 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7242
7243 @item -fexpensive-optimizations
7244 @opindex fexpensive-optimizations
7245 Perform a number of minor optimizations that are relatively expensive.
7246
7247 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7248
7249 @item -free
7250 @opindex free
7251 Attempt to remove redundant extension instructions. This is especially
7252 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7253 registers after writing to their lower 32-bit half.
7254
7255 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7256
7257 @item -foptimize-register-move
7258 @itemx -fregmove
7259 @opindex foptimize-register-move
7260 @opindex fregmove
7261 Attempt to reassign register numbers in move instructions and as
7262 operands of other simple instructions in order to maximize the amount of
7263 register tying. This is especially helpful on machines with two-operand
7264 instructions.
7265
7266 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
7267 optimization.
7268
7269 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7270
7271 @item -fira-algorithm=@var{algorithm}
7272 Use the specified coloring algorithm for the integrated register
7273 allocator. The @var{algorithm} argument can be @samp{priority}, which
7274 specifies Chow's priority coloring, or @samp{CB}, which specifies
7275 Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented
7276 for all architectures, but for those targets that do support it, it is
7277 the default because it generates better code.
7278
7279 @item -fira-region=@var{region}
7280 Use specified regions for the integrated register allocator. The
7281 @var{region} argument should be one of the following:
7282
7283 @table @samp
7284
7285 @item all
7286 Use all loops as register allocation regions.
7287 This can give the best results for machines with a small and/or
7288 irregular register set.
7289
7290 @item mixed
7291 Use all loops except for loops with small register pressure
7292 as the regions. This value usually gives
7293 the best results in most cases and for most architectures,
7294 and is enabled by default when compiling with optimization for speed
7295 (@option{-O}, @option{-O2}, @dots{}).
7296
7297 @item one
7298 Use all functions as a single region.
7299 This typically results in the smallest code size, and is enabled by default for
7300 @option{-Os} or @option{-O0}.
7301
7302 @end table
7303
7304 @item -fira-hoist-pressure
7305 @opindex fira-hoist-pressure
7306 Use IRA to evaluate register pressure in the code hoisting pass for
7307 decisions to hoist expressions. This option usually results in smaller
7308 code, but it can slow the compiler down.
7309
7310 This option is enabled at level @option{-Os} for all targets.
7311
7312 @item -fira-loop-pressure
7313 @opindex fira-loop-pressure
7314 Use IRA to evaluate register pressure in loops for decisions to move
7315 loop invariants. This option usually results in generation
7316 of faster and smaller code on machines with large register files (>= 32
7317 registers), but it can slow the compiler down.
7318
7319 This option is enabled at level @option{-O3} for some targets.
7320
7321 @item -fno-ira-share-save-slots
7322 @opindex fno-ira-share-save-slots
7323 Disable sharing of stack slots used for saving call-used hard
7324 registers living through a call. Each hard register gets a
7325 separate stack slot, and as a result function stack frames are
7326 larger.
7327
7328 @item -fno-ira-share-spill-slots
7329 @opindex fno-ira-share-spill-slots
7330 Disable sharing of stack slots allocated for pseudo-registers. Each
7331 pseudo-register that does not get a hard register gets a separate
7332 stack slot, and as a result function stack frames are larger.
7333
7334 @item -fira-verbose=@var{n}
7335 @opindex fira-verbose
7336 Control the verbosity of the dump file for the integrated register allocator.
7337 The default value is 5. If the value @var{n} is greater or equal to 10,
7338 the dump output is sent to stderr using the same format as @var{n} minus 10.
7339
7340 @item -fdelayed-branch
7341 @opindex fdelayed-branch
7342 If supported for the target machine, attempt to reorder instructions
7343 to exploit instruction slots available after delayed branch
7344 instructions.
7345
7346 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7347
7348 @item -fschedule-insns
7349 @opindex fschedule-insns
7350 If supported for the target machine, attempt to reorder instructions to
7351 eliminate execution stalls due to required data being unavailable. This
7352 helps machines that have slow floating point or memory load instructions
7353 by allowing other instructions to be issued until the result of the load
7354 or floating-point instruction is required.
7355
7356 Enabled at levels @option{-O2}, @option{-O3}.
7357
7358 @item -fschedule-insns2
7359 @opindex fschedule-insns2
7360 Similar to @option{-fschedule-insns}, but requests an additional pass of
7361 instruction scheduling after register allocation has been done. This is
7362 especially useful on machines with a relatively small number of
7363 registers and where memory load instructions take more than one cycle.
7364
7365 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7366
7367 @item -fno-sched-interblock
7368 @opindex fno-sched-interblock
7369 Don't schedule instructions across basic blocks. This is normally
7370 enabled by default when scheduling before register allocation, i.e.@:
7371 with @option{-fschedule-insns} or at @option{-O2} or higher.
7372
7373 @item -fno-sched-spec
7374 @opindex fno-sched-spec
7375 Don't allow speculative motion of non-load instructions. This is normally
7376 enabled by default when scheduling before register allocation, i.e.@:
7377 with @option{-fschedule-insns} or at @option{-O2} or higher.
7378
7379 @item -fsched-pressure
7380 @opindex fsched-pressure
7381 Enable register pressure sensitive insn scheduling before register
7382 allocation. This only makes sense when scheduling before register
7383 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7384 @option{-O2} or higher. Usage of this option can improve the
7385 generated code and decrease its size by preventing register pressure
7386 increase above the number of available hard registers and subsequent
7387 spills in register allocation.
7388
7389 @item -fsched-spec-load
7390 @opindex fsched-spec-load
7391 Allow speculative motion of some load instructions. This only makes
7392 sense when scheduling before register allocation, i.e.@: with
7393 @option{-fschedule-insns} or at @option{-O2} or higher.
7394
7395 @item -fsched-spec-load-dangerous
7396 @opindex fsched-spec-load-dangerous
7397 Allow speculative motion of more load instructions. This only makes
7398 sense when scheduling before register allocation, i.e.@: with
7399 @option{-fschedule-insns} or at @option{-O2} or higher.
7400
7401 @item -fsched-stalled-insns
7402 @itemx -fsched-stalled-insns=@var{n}
7403 @opindex fsched-stalled-insns
7404 Define how many insns (if any) can be moved prematurely from the queue
7405 of stalled insns into the ready list during the second scheduling pass.
7406 @option{-fno-sched-stalled-insns} means that no insns are moved
7407 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7408 on how many queued insns can be moved prematurely.
7409 @option{-fsched-stalled-insns} without a value is equivalent to
7410 @option{-fsched-stalled-insns=1}.
7411
7412 @item -fsched-stalled-insns-dep
7413 @itemx -fsched-stalled-insns-dep=@var{n}
7414 @opindex fsched-stalled-insns-dep
7415 Define how many insn groups (cycles) are examined for a dependency
7416 on a stalled insn that is a candidate for premature removal from the queue
7417 of stalled insns. This has an effect only during the second scheduling pass,
7418 and only if @option{-fsched-stalled-insns} is used.
7419 @option{-fno-sched-stalled-insns-dep} is equivalent to
7420 @option{-fsched-stalled-insns-dep=0}.
7421 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7422 @option{-fsched-stalled-insns-dep=1}.
7423
7424 @item -fsched2-use-superblocks
7425 @opindex fsched2-use-superblocks
7426 When scheduling after register allocation, use superblock scheduling.
7427 This allows motion across basic block boundaries,
7428 resulting in faster schedules. This option is experimental, as not all machine
7429 descriptions used by GCC model the CPU closely enough to avoid unreliable
7430 results from the algorithm.
7431
7432 This only makes sense when scheduling after register allocation, i.e.@: with
7433 @option{-fschedule-insns2} or at @option{-O2} or higher.
7434
7435 @item -fsched-group-heuristic
7436 @opindex fsched-group-heuristic
7437 Enable the group heuristic in the scheduler. This heuristic favors
7438 the instruction that belongs to a schedule group. This is enabled
7439 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7440 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7441
7442 @item -fsched-critical-path-heuristic
7443 @opindex fsched-critical-path-heuristic
7444 Enable the critical-path heuristic in the scheduler. This heuristic favors
7445 instructions on the critical path. This is enabled by default when
7446 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7447 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7448
7449 @item -fsched-spec-insn-heuristic
7450 @opindex fsched-spec-insn-heuristic
7451 Enable the speculative instruction heuristic in the scheduler. This
7452 heuristic favors speculative instructions with greater dependency weakness.
7453 This is enabled by default when scheduling is enabled, i.e.@:
7454 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7455 or at @option{-O2} or higher.
7456
7457 @item -fsched-rank-heuristic
7458 @opindex fsched-rank-heuristic
7459 Enable the rank heuristic in the scheduler. This heuristic favors
7460 the instruction belonging to a basic block with greater size or frequency.
7461 This is enabled by default when scheduling is enabled, i.e.@:
7462 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7463 at @option{-O2} or higher.
7464
7465 @item -fsched-last-insn-heuristic
7466 @opindex fsched-last-insn-heuristic
7467 Enable the last-instruction heuristic in the scheduler. This heuristic
7468 favors the instruction that is less dependent on the last instruction
7469 scheduled. This is enabled by default when scheduling is enabled,
7470 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7471 at @option{-O2} or higher.
7472
7473 @item -fsched-dep-count-heuristic
7474 @opindex fsched-dep-count-heuristic
7475 Enable the dependent-count heuristic in the scheduler. This heuristic
7476 favors the instruction that has more instructions depending on it.
7477 This is enabled by default when scheduling is enabled, i.e.@:
7478 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7479 at @option{-O2} or higher.
7480
7481 @item -freschedule-modulo-scheduled-loops
7482 @opindex freschedule-modulo-scheduled-loops
7483 Modulo scheduling is performed before traditional scheduling. If a loop
7484 is modulo scheduled, later scheduling passes may change its schedule.
7485 Use this option to control that behavior.
7486
7487 @item -fselective-scheduling
7488 @opindex fselective-scheduling
7489 Schedule instructions using selective scheduling algorithm. Selective
7490 scheduling runs instead of the first scheduler pass.
7491
7492 @item -fselective-scheduling2
7493 @opindex fselective-scheduling2
7494 Schedule instructions using selective scheduling algorithm. Selective
7495 scheduling runs instead of the second scheduler pass.
7496
7497 @item -fsel-sched-pipelining
7498 @opindex fsel-sched-pipelining
7499 Enable software pipelining of innermost loops during selective scheduling.
7500 This option has no effect unless one of @option{-fselective-scheduling} or
7501 @option{-fselective-scheduling2} is turned on.
7502
7503 @item -fsel-sched-pipelining-outer-loops
7504 @opindex fsel-sched-pipelining-outer-loops
7505 When pipelining loops during selective scheduling, also pipeline outer loops.
7506 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7507
7508 @item -fshrink-wrap
7509 @opindex fshrink-wrap
7510 Emit function prologues only before parts of the function that need it,
7511 rather than at the top of the function. This flag is enabled by default at
7512 @option{-O} and higher.
7513
7514 @item -fcaller-saves
7515 @opindex fcaller-saves
7516 Enable allocation of values to registers that are clobbered by
7517 function calls, by emitting extra instructions to save and restore the
7518 registers around such calls. Such allocation is done only when it
7519 seems to result in better code.
7520
7521 This option is always enabled by default on certain machines, usually
7522 those which have no call-preserved registers to use instead.
7523
7524 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7525
7526 @item -fcombine-stack-adjustments
7527 @opindex fcombine-stack-adjustments
7528 Tracks stack adjustments (pushes and pops) and stack memory references
7529 and then tries to find ways to combine them.
7530
7531 Enabled by default at @option{-O1} and higher.
7532
7533 @item -fconserve-stack
7534 @opindex fconserve-stack
7535 Attempt to minimize stack usage. The compiler attempts to use less
7536 stack space, even if that makes the program slower. This option
7537 implies setting the @option{large-stack-frame} parameter to 100
7538 and the @option{large-stack-frame-growth} parameter to 400.
7539
7540 @item -ftree-reassoc
7541 @opindex ftree-reassoc
7542 Perform reassociation on trees. This flag is enabled by default
7543 at @option{-O} and higher.
7544
7545 @item -ftree-pre
7546 @opindex ftree-pre
7547 Perform partial redundancy elimination (PRE) on trees. This flag is
7548 enabled by default at @option{-O2} and @option{-O3}.
7549
7550 @item -ftree-partial-pre
7551 @opindex ftree-partial-pre
7552 Make partial redundancy elimination (PRE) more aggressive. This flag is
7553 enabled by default at @option{-O3}.
7554
7555 @item -ftree-forwprop
7556 @opindex ftree-forwprop
7557 Perform forward propagation on trees. This flag is enabled by default
7558 at @option{-O} and higher.
7559
7560 @item -ftree-fre
7561 @opindex ftree-fre
7562 Perform full redundancy elimination (FRE) on trees. The difference
7563 between FRE and PRE is that FRE only considers expressions
7564 that are computed on all paths leading to the redundant computation.
7565 This analysis is faster than PRE, though it exposes fewer redundancies.
7566 This flag is enabled by default at @option{-O} and higher.
7567
7568 @item -ftree-phiprop
7569 @opindex ftree-phiprop
7570 Perform hoisting of loads from conditional pointers on trees. This
7571 pass is enabled by default at @option{-O} and higher.
7572
7573 @item -fhoist-adjacent-loads
7574 @opindex hoist-adjacent-loads
7575 Speculatively hoist loads from both branches of an if-then-else if the
7576 loads are from adjacent locations in the same structure and the target
7577 architecture has a conditional move instruction. This flag is enabled
7578 by default at @option{-O2} and higher.
7579
7580 @item -ftree-copy-prop
7581 @opindex ftree-copy-prop
7582 Perform copy propagation on trees. This pass eliminates unnecessary
7583 copy operations. This flag is enabled by default at @option{-O} and
7584 higher.
7585
7586 @item -fipa-pure-const
7587 @opindex fipa-pure-const
7588 Discover which functions are pure or constant.
7589 Enabled by default at @option{-O} and higher.
7590
7591 @item -fipa-reference
7592 @opindex fipa-reference
7593 Discover which static variables do not escape the
7594 compilation unit.
7595 Enabled by default at @option{-O} and higher.
7596
7597 @item -fipa-pta
7598 @opindex fipa-pta
7599 Perform interprocedural pointer analysis and interprocedural modification
7600 and reference analysis. This option can cause excessive memory and
7601 compile-time usage on large compilation units. It is not enabled by
7602 default at any optimization level.
7603
7604 @item -fipa-profile
7605 @opindex fipa-profile
7606 Perform interprocedural profile propagation. The functions called only from
7607 cold functions are marked as cold. Also functions executed once (such as
7608 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7609 functions and loop less parts of functions executed once are then optimized for
7610 size.
7611 Enabled by default at @option{-O} and higher.
7612
7613 @item -fipa-cp
7614 @opindex fipa-cp
7615 Perform interprocedural constant propagation.
7616 This optimization analyzes the program to determine when values passed
7617 to functions are constants and then optimizes accordingly.
7618 This optimization can substantially increase performance
7619 if the application has constants passed to functions.
7620 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7621
7622 @item -fipa-cp-clone
7623 @opindex fipa-cp-clone
7624 Perform function cloning to make interprocedural constant propagation stronger.
7625 When enabled, interprocedural constant propagation performs function cloning
7626 when externally visible function can be called with constant arguments.
7627 Because this optimization can create multiple copies of functions,
7628 it may significantly increase code size
7629 (see @option{--param ipcp-unit-growth=@var{value}}).
7630 This flag is enabled by default at @option{-O3}.
7631
7632 @item -ftree-sink
7633 @opindex ftree-sink
7634 Perform forward store motion on trees. This flag is
7635 enabled by default at @option{-O} and higher.
7636
7637 @item -ftree-bit-ccp
7638 @opindex ftree-bit-ccp
7639 Perform sparse conditional bit constant propagation on trees and propagate
7640 pointer alignment information.
7641 This pass only operates on local scalar variables and is enabled by default
7642 at @option{-O} and higher. It requires that @option{-ftree-ccp} is enabled.
7643
7644 @item -ftree-ccp
7645 @opindex ftree-ccp
7646 Perform sparse conditional constant propagation (CCP) on trees. This
7647 pass only operates on local scalar variables and is enabled by default
7648 at @option{-O} and higher.
7649
7650 @item -ftree-switch-conversion
7651 Perform conversion of simple initializations in a switch to
7652 initializations from a scalar array. This flag is enabled by default
7653 at @option{-O2} and higher.
7654
7655 @item -ftree-tail-merge
7656 Look for identical code sequences. When found, replace one with a jump to the
7657 other. This optimization is known as tail merging or cross jumping. This flag
7658 is enabled by default at @option{-O2} and higher. The compilation time
7659 in this pass can
7660 be limited using @option{max-tail-merge-comparisons} parameter and
7661 @option{max-tail-merge-iterations} parameter.
7662
7663 @item -ftree-dce
7664 @opindex ftree-dce
7665 Perform dead code elimination (DCE) on trees. This flag is enabled by
7666 default at @option{-O} and higher.
7667
7668 @item -ftree-builtin-call-dce
7669 @opindex ftree-builtin-call-dce
7670 Perform conditional dead code elimination (DCE) for calls to built-in functions
7671 that may set @code{errno} but are otherwise side-effect free. This flag is
7672 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7673 specified.
7674
7675 @item -ftree-dominator-opts
7676 @opindex ftree-dominator-opts
7677 Perform a variety of simple scalar cleanups (constant/copy
7678 propagation, redundancy elimination, range propagation and expression
7679 simplification) based on a dominator tree traversal. This also
7680 performs jump threading (to reduce jumps to jumps). This flag is
7681 enabled by default at @option{-O} and higher.
7682
7683 @item -ftree-dse
7684 @opindex ftree-dse
7685 Perform dead store elimination (DSE) on trees. A dead store is a store into
7686 a memory location that is later overwritten by another store without
7687 any intervening loads. In this case the earlier store can be deleted. This
7688 flag is enabled by default at @option{-O} and higher.
7689
7690 @item -ftree-ch
7691 @opindex ftree-ch
7692 Perform loop header copying on trees. This is beneficial since it increases
7693 effectiveness of code motion optimizations. It also saves one jump. This flag
7694 is enabled by default at @option{-O} and higher. It is not enabled
7695 for @option{-Os}, since it usually increases code size.
7696
7697 @item -ftree-loop-optimize
7698 @opindex ftree-loop-optimize
7699 Perform loop optimizations on trees. This flag is enabled by default
7700 at @option{-O} and higher.
7701
7702 @item -ftree-loop-linear
7703 @opindex ftree-loop-linear
7704 Perform loop interchange transformations on tree. Same as
7705 @option{-floop-interchange}. To use this code transformation, GCC has
7706 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7707 enable the Graphite loop transformation infrastructure.
7708
7709 @item -floop-interchange
7710 @opindex floop-interchange
7711 Perform loop interchange transformations on loops. Interchanging two
7712 nested loops switches the inner and outer loops. For example, given a
7713 loop like:
7714 @smallexample
7715 DO J = 1, M
7716 DO I = 1, N
7717 A(J, I) = A(J, I) * C
7718 ENDDO
7719 ENDDO
7720 @end smallexample
7721 loop interchange transforms the loop as if it were written:
7722 @smallexample
7723 DO I = 1, N
7724 DO J = 1, M
7725 A(J, I) = A(J, I) * C
7726 ENDDO
7727 ENDDO
7728 @end smallexample
7729 which can be beneficial when @code{N} is larger than the caches,
7730 because in Fortran, the elements of an array are stored in memory
7731 contiguously by column, and the original loop iterates over rows,
7732 potentially creating at each access a cache miss. This optimization
7733 applies to all the languages supported by GCC and is not limited to
7734 Fortran. To use this code transformation, GCC has to be configured
7735 with @option{--with-ppl} and @option{--with-cloog} to enable the
7736 Graphite loop transformation infrastructure.
7737
7738 @item -floop-strip-mine
7739 @opindex floop-strip-mine
7740 Perform loop strip mining transformations on loops. Strip mining
7741 splits a loop into two nested loops. The outer loop has strides
7742 equal to the strip size and the inner loop has strides of the
7743 original loop within a strip. The strip length can be changed
7744 using the @option{loop-block-tile-size} parameter. For example,
7745 given a loop like:
7746 @smallexample
7747 DO I = 1, N
7748 A(I) = A(I) + C
7749 ENDDO
7750 @end smallexample
7751 loop strip mining transforms the loop as if it were written:
7752 @smallexample
7753 DO II = 1, N, 51
7754 DO I = II, min (II + 50, N)
7755 A(I) = A(I) + C
7756 ENDDO
7757 ENDDO
7758 @end smallexample
7759 This optimization applies to all the languages supported by GCC and is
7760 not limited to Fortran. To use this code transformation, GCC has to
7761 be configured with @option{--with-ppl} and @option{--with-cloog} to
7762 enable the Graphite loop transformation infrastructure.
7763
7764 @item -floop-block
7765 @opindex floop-block
7766 Perform loop blocking transformations on loops. Blocking strip mines
7767 each loop in the loop nest such that the memory accesses of the
7768 element loops fit inside caches. The strip length can be changed
7769 using the @option{loop-block-tile-size} parameter. For example, given
7770 a loop like:
7771 @smallexample
7772 DO I = 1, N
7773 DO J = 1, M
7774 A(J, I) = B(I) + C(J)
7775 ENDDO
7776 ENDDO
7777 @end smallexample
7778 loop blocking transforms the loop as if it were written:
7779 @smallexample
7780 DO II = 1, N, 51
7781 DO JJ = 1, M, 51
7782 DO I = II, min (II + 50, N)
7783 DO J = JJ, min (JJ + 50, M)
7784 A(J, I) = B(I) + C(J)
7785 ENDDO
7786 ENDDO
7787 ENDDO
7788 ENDDO
7789 @end smallexample
7790 which can be beneficial when @code{M} is larger than the caches,
7791 because the innermost loop iterates over a smaller amount of data
7792 which can be kept in the caches. This optimization applies to all the
7793 languages supported by GCC and is not limited to Fortran. To use this
7794 code transformation, GCC has to be configured with @option{--with-ppl}
7795 and @option{--with-cloog} to enable the Graphite loop transformation
7796 infrastructure.
7797
7798 @item -fgraphite-identity
7799 @opindex fgraphite-identity
7800 Enable the identity transformation for graphite. For every SCoP we generate
7801 the polyhedral representation and transform it back to gimple. Using
7802 @option{-fgraphite-identity} we can check the costs or benefits of the
7803 GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations
7804 are also performed by the code generator CLooG, like index splitting and
7805 dead code elimination in loops.
7806
7807 @item -floop-nest-optimize
7808 @opindex floop-nest-optimize
7809 Enable the ISL based loop nest optimizer. This is a generic loop nest
7810 optimizer based on the Pluto optimization algorithms. It calculates a loop
7811 structure optimized for data-locality and parallelism. This option
7812 is experimental.
7813
7814 @item -floop-parallelize-all
7815 @opindex floop-parallelize-all
7816 Use the Graphite data dependence analysis to identify loops that can
7817 be parallelized. Parallelize all the loops that can be analyzed to
7818 not contain loop carried dependences without checking that it is
7819 profitable to parallelize the loops.
7820
7821 @item -fcheck-data-deps
7822 @opindex fcheck-data-deps
7823 Compare the results of several data dependence analyzers. This option
7824 is used for debugging the data dependence analyzers.
7825
7826 @item -ftree-loop-if-convert
7827 Attempt to transform conditional jumps in the innermost loops to
7828 branch-less equivalents. The intent is to remove control-flow from
7829 the innermost loops in order to improve the ability of the
7830 vectorization pass to handle these loops. This is enabled by default
7831 if vectorization is enabled.
7832
7833 @item -ftree-loop-if-convert-stores
7834 Attempt to also if-convert conditional jumps containing memory writes.
7835 This transformation can be unsafe for multi-threaded programs as it
7836 transforms conditional memory writes into unconditional memory writes.
7837 For example,
7838 @smallexample
7839 for (i = 0; i < N; i++)
7840 if (cond)
7841 A[i] = expr;
7842 @end smallexample
7843 is transformed to
7844 @smallexample
7845 for (i = 0; i < N; i++)
7846 A[i] = cond ? expr : A[i];
7847 @end smallexample
7848 potentially producing data races.
7849
7850 @item -ftree-loop-distribution
7851 Perform loop distribution. This flag can improve cache performance on
7852 big loop bodies and allow further loop optimizations, like
7853 parallelization or vectorization, to take place. For example, the loop
7854 @smallexample
7855 DO I = 1, N
7856 A(I) = B(I) + C
7857 D(I) = E(I) * F
7858 ENDDO
7859 @end smallexample
7860 is transformed to
7861 @smallexample
7862 DO I = 1, N
7863 A(I) = B(I) + C
7864 ENDDO
7865 DO I = 1, N
7866 D(I) = E(I) * F
7867 ENDDO
7868 @end smallexample
7869
7870 @item -ftree-loop-distribute-patterns
7871 Perform loop distribution of patterns that can be code generated with
7872 calls to a library. This flag is enabled by default at @option{-O3}.
7873
7874 This pass distributes the initialization loops and generates a call to
7875 memset zero. For example, the loop
7876 @smallexample
7877 DO I = 1, N
7878 A(I) = 0
7879 B(I) = A(I) + I
7880 ENDDO
7881 @end smallexample
7882 is transformed to
7883 @smallexample
7884 DO I = 1, N
7885 A(I) = 0
7886 ENDDO
7887 DO I = 1, N
7888 B(I) = A(I) + I
7889 ENDDO
7890 @end smallexample
7891 and the initialization loop is transformed into a call to memset zero.
7892
7893 @item -ftree-loop-im
7894 @opindex ftree-loop-im
7895 Perform loop invariant motion on trees. This pass moves only invariants that
7896 are hard to handle at RTL level (function calls, operations that expand to
7897 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
7898 operands of conditions that are invariant out of the loop, so that we can use
7899 just trivial invariantness analysis in loop unswitching. The pass also includes
7900 store motion.
7901
7902 @item -ftree-loop-ivcanon
7903 @opindex ftree-loop-ivcanon
7904 Create a canonical counter for number of iterations in loops for which
7905 determining number of iterations requires complicated analysis. Later
7906 optimizations then may determine the number easily. Useful especially
7907 in connection with unrolling.
7908
7909 @item -fivopts
7910 @opindex fivopts
7911 Perform induction variable optimizations (strength reduction, induction
7912 variable merging and induction variable elimination) on trees.
7913
7914 @item -ftree-parallelize-loops=n
7915 @opindex ftree-parallelize-loops
7916 Parallelize loops, i.e., split their iteration space to run in n threads.
7917 This is only possible for loops whose iterations are independent
7918 and can be arbitrarily reordered. The optimization is only
7919 profitable on multiprocessor machines, for loops that are CPU-intensive,
7920 rather than constrained e.g.@: by memory bandwidth. This option
7921 implies @option{-pthread}, and thus is only supported on targets
7922 that have support for @option{-pthread}.
7923
7924 @item -ftree-pta
7925 @opindex ftree-pta
7926 Perform function-local points-to analysis on trees. This flag is
7927 enabled by default at @option{-O} and higher.
7928
7929 @item -ftree-sra
7930 @opindex ftree-sra
7931 Perform scalar replacement of aggregates. This pass replaces structure
7932 references with scalars to prevent committing structures to memory too
7933 early. This flag is enabled by default at @option{-O} and higher.
7934
7935 @item -ftree-copyrename
7936 @opindex ftree-copyrename
7937 Perform copy renaming on trees. This pass attempts to rename compiler
7938 temporaries to other variables at copy locations, usually resulting in
7939 variable names which more closely resemble the original variables. This flag
7940 is enabled by default at @option{-O} and higher.
7941
7942 @item -ftree-coalesce-inlined-vars
7943 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7944 combine small user-defined variables too, but only if they were inlined
7945 from other functions. It is a more limited form of
7946 @option{-ftree-coalesce-vars}. This may harm debug information of such
7947 inlined variables, but it will keep variables of the inlined-into
7948 function apart from each other, such that they are more likely to
7949 contain the expected values in a debugging session. This was the
7950 default in GCC versions older than 4.7.
7951
7952 @item -ftree-coalesce-vars
7953 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7954 combine small user-defined variables too, instead of just compiler
7955 temporaries. This may severely limit the ability to debug an optimized
7956 program compiled with @option{-fno-var-tracking-assignments}. In the
7957 negated form, this flag prevents SSA coalescing of user variables,
7958 including inlined ones. This option is enabled by default.
7959
7960 @item -ftree-ter
7961 @opindex ftree-ter
7962 Perform temporary expression replacement during the SSA->normal phase. Single
7963 use/single def temporaries are replaced at their use location with their
7964 defining expression. This results in non-GIMPLE code, but gives the expanders
7965 much more complex trees to work on resulting in better RTL generation. This is
7966 enabled by default at @option{-O} and higher.
7967
7968 @item -ftree-slsr
7969 @opindex ftree-slsr
7970 Perform straight-line strength reduction on trees. This recognizes related
7971 expressions involving multiplications and replaces them by less expensive
7972 calculations when possible. This is enabled by default at @option{-O} and
7973 higher.
7974
7975 @item -ftree-vectorize
7976 @opindex ftree-vectorize
7977 Perform loop vectorization on trees. This flag is enabled by default at
7978 @option{-O3}.
7979
7980 @item -ftree-slp-vectorize
7981 @opindex ftree-slp-vectorize
7982 Perform basic block vectorization on trees. This flag is enabled by default at
7983 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7984
7985 @item -ftree-vect-loop-version
7986 @opindex ftree-vect-loop-version
7987 Perform loop versioning when doing loop vectorization on trees. When a loop
7988 appears to be vectorizable except that data alignment or data dependence cannot
7989 be determined at compile time, then vectorized and non-vectorized versions of
7990 the loop are generated along with run-time checks for alignment or dependence
7991 to control which version is executed. This option is enabled by default
7992 except at level @option{-Os} where it is disabled.
7993
7994 @item -fvect-cost-model
7995 @opindex fvect-cost-model
7996 Enable cost model for vectorization. This option is enabled by default at
7997 @option{-O3}.
7998
7999 @item -ftree-vrp
8000 @opindex ftree-vrp
8001 Perform Value Range Propagation on trees. This is similar to the
8002 constant propagation pass, but instead of values, ranges of values are
8003 propagated. This allows the optimizers to remove unnecessary range
8004 checks like array bound checks and null pointer checks. This is
8005 enabled by default at @option{-O2} and higher. Null pointer check
8006 elimination is only done if @option{-fdelete-null-pointer-checks} is
8007 enabled.
8008
8009 @item -ftracer
8010 @opindex ftracer
8011 Perform tail duplication to enlarge superblock size. This transformation
8012 simplifies the control flow of the function allowing other optimizations to do
8013 a better job.
8014
8015 @item -funroll-loops
8016 @opindex funroll-loops
8017 Unroll loops whose number of iterations can be determined at compile
8018 time or upon entry to the loop. @option{-funroll-loops} implies
8019 @option{-frerun-cse-after-loop}. This option makes code larger,
8020 and may or may not make it run faster.
8021
8022 @item -funroll-all-loops
8023 @opindex funroll-all-loops
8024 Unroll all loops, even if their number of iterations is uncertain when
8025 the loop is entered. This usually makes programs run more slowly.
8026 @option{-funroll-all-loops} implies the same options as
8027 @option{-funroll-loops},
8028
8029 @item -fsplit-ivs-in-unroller
8030 @opindex fsplit-ivs-in-unroller
8031 Enables expression of values of induction variables in later iterations
8032 of the unrolled loop using the value in the first iteration. This breaks
8033 long dependency chains, thus improving efficiency of the scheduling passes.
8034
8035 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8036 same effect. However, that is not reliable in cases where the loop body
8037 is more complicated than a single basic block. It also does not work at all
8038 on some architectures due to restrictions in the CSE pass.
8039
8040 This optimization is enabled by default.
8041
8042 @item -fvariable-expansion-in-unroller
8043 @opindex fvariable-expansion-in-unroller
8044 With this option, the compiler creates multiple copies of some
8045 local variables when unrolling a loop, which can result in superior code.
8046
8047 @item -fpartial-inlining
8048 @opindex fpartial-inlining
8049 Inline parts of functions. This option has any effect only
8050 when inlining itself is turned on by the @option{-finline-functions}
8051 or @option{-finline-small-functions} options.
8052
8053 Enabled at level @option{-O2}.
8054
8055 @item -fpredictive-commoning
8056 @opindex fpredictive-commoning
8057 Perform predictive commoning optimization, i.e., reusing computations
8058 (especially memory loads and stores) performed in previous
8059 iterations of loops.
8060
8061 This option is enabled at level @option{-O3}.
8062
8063 @item -fprefetch-loop-arrays
8064 @opindex fprefetch-loop-arrays
8065 If supported by the target machine, generate instructions to prefetch
8066 memory to improve the performance of loops that access large arrays.
8067
8068 This option may generate better or worse code; results are highly
8069 dependent on the structure of loops within the source code.
8070
8071 Disabled at level @option{-Os}.
8072
8073 @item -fno-peephole
8074 @itemx -fno-peephole2
8075 @opindex fno-peephole
8076 @opindex fno-peephole2
8077 Disable any machine-specific peephole optimizations. The difference
8078 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8079 are implemented in the compiler; some targets use one, some use the
8080 other, a few use both.
8081
8082 @option{-fpeephole} is enabled by default.
8083 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8084
8085 @item -fno-guess-branch-probability
8086 @opindex fno-guess-branch-probability
8087 Do not guess branch probabilities using heuristics.
8088
8089 GCC uses heuristics to guess branch probabilities if they are
8090 not provided by profiling feedback (@option{-fprofile-arcs}). These
8091 heuristics are based on the control flow graph. If some branch probabilities
8092 are specified by @samp{__builtin_expect}, then the heuristics are
8093 used to guess branch probabilities for the rest of the control flow graph,
8094 taking the @samp{__builtin_expect} info into account. The interactions
8095 between the heuristics and @samp{__builtin_expect} can be complex, and in
8096 some cases, it may be useful to disable the heuristics so that the effects
8097 of @samp{__builtin_expect} are easier to understand.
8098
8099 The default is @option{-fguess-branch-probability} at levels
8100 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8101
8102 @item -freorder-blocks
8103 @opindex freorder-blocks
8104 Reorder basic blocks in the compiled function in order to reduce number of
8105 taken branches and improve code locality.
8106
8107 Enabled at levels @option{-O2}, @option{-O3}.
8108
8109 @item -freorder-blocks-and-partition
8110 @opindex freorder-blocks-and-partition
8111 In addition to reordering basic blocks in the compiled function, in order
8112 to reduce number of taken branches, partitions hot and cold basic blocks
8113 into separate sections of the assembly and .o files, to improve
8114 paging and cache locality performance.
8115
8116 This optimization is automatically turned off in the presence of
8117 exception handling, for linkonce sections, for functions with a user-defined
8118 section attribute and on any architecture that does not support named
8119 sections.
8120
8121 @item -freorder-functions
8122 @opindex freorder-functions
8123 Reorder functions in the object file in order to
8124 improve code locality. This is implemented by using special
8125 subsections @code{.text.hot} for most frequently executed functions and
8126 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
8127 the linker so object file format must support named sections and linker must
8128 place them in a reasonable way.
8129
8130 Also profile feedback must be available to make this option effective. See
8131 @option{-fprofile-arcs} for details.
8132
8133 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8134
8135 @item -fstrict-aliasing
8136 @opindex fstrict-aliasing
8137 Allow the compiler to assume the strictest aliasing rules applicable to
8138 the language being compiled. For C (and C++), this activates
8139 optimizations based on the type of expressions. In particular, an
8140 object of one type is assumed never to reside at the same address as an
8141 object of a different type, unless the types are almost the same. For
8142 example, an @code{unsigned int} can alias an @code{int}, but not a
8143 @code{void*} or a @code{double}. A character type may alias any other
8144 type.
8145
8146 @anchor{Type-punning}Pay special attention to code like this:
8147 @smallexample
8148 union a_union @{
8149 int i;
8150 double d;
8151 @};
8152
8153 int f() @{
8154 union a_union t;
8155 t.d = 3.0;
8156 return t.i;
8157 @}
8158 @end smallexample
8159 The practice of reading from a different union member than the one most
8160 recently written to (called ``type-punning'') is common. Even with
8161 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8162 is accessed through the union type. So, the code above works as
8163 expected. @xref{Structures unions enumerations and bit-fields
8164 implementation}. However, this code might not:
8165 @smallexample
8166 int f() @{
8167 union a_union t;
8168 int* ip;
8169 t.d = 3.0;
8170 ip = &t.i;
8171 return *ip;
8172 @}
8173 @end smallexample
8174
8175 Similarly, access by taking the address, casting the resulting pointer
8176 and dereferencing the result has undefined behavior, even if the cast
8177 uses a union type, e.g.:
8178 @smallexample
8179 int f() @{
8180 double d = 3.0;
8181 return ((union a_union *) &d)->i;
8182 @}
8183 @end smallexample
8184
8185 The @option{-fstrict-aliasing} option is enabled at levels
8186 @option{-O2}, @option{-O3}, @option{-Os}.
8187
8188 @item -fstrict-overflow
8189 @opindex fstrict-overflow
8190 Allow the compiler to assume strict signed overflow rules, depending
8191 on the language being compiled. For C (and C++) this means that
8192 overflow when doing arithmetic with signed numbers is undefined, which
8193 means that the compiler may assume that it does not happen. This
8194 permits various optimizations. For example, the compiler assumes
8195 that an expression like @code{i + 10 > i} is always true for
8196 signed @code{i}. This assumption is only valid if signed overflow is
8197 undefined, as the expression is false if @code{i + 10} overflows when
8198 using twos complement arithmetic. When this option is in effect any
8199 attempt to determine whether an operation on signed numbers
8200 overflows must be written carefully to not actually involve overflow.
8201
8202 This option also allows the compiler to assume strict pointer
8203 semantics: given a pointer to an object, if adding an offset to that
8204 pointer does not produce a pointer to the same object, the addition is
8205 undefined. This permits the compiler to conclude that @code{p + u >
8206 p} is always true for a pointer @code{p} and unsigned integer
8207 @code{u}. This assumption is only valid because pointer wraparound is
8208 undefined, as the expression is false if @code{p + u} overflows using
8209 twos complement arithmetic.
8210
8211 See also the @option{-fwrapv} option. Using @option{-fwrapv} means
8212 that integer signed overflow is fully defined: it wraps. When
8213 @option{-fwrapv} is used, there is no difference between
8214 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8215 integers. With @option{-fwrapv} certain types of overflow are
8216 permitted. For example, if the compiler gets an overflow when doing
8217 arithmetic on constants, the overflowed value can still be used with
8218 @option{-fwrapv}, but not otherwise.
8219
8220 The @option{-fstrict-overflow} option is enabled at levels
8221 @option{-O2}, @option{-O3}, @option{-Os}.
8222
8223 @item -falign-functions
8224 @itemx -falign-functions=@var{n}
8225 @opindex falign-functions
8226 Align the start of functions to the next power-of-two greater than
8227 @var{n}, skipping up to @var{n} bytes. For instance,
8228 @option{-falign-functions=32} aligns functions to the next 32-byte
8229 boundary, but @option{-falign-functions=24} aligns to the next
8230 32-byte boundary only if this can be done by skipping 23 bytes or less.
8231
8232 @option{-fno-align-functions} and @option{-falign-functions=1} are
8233 equivalent and mean that functions are not aligned.
8234
8235 Some assemblers only support this flag when @var{n} is a power of two;
8236 in that case, it is rounded up.
8237
8238 If @var{n} is not specified or is zero, use a machine-dependent default.
8239
8240 Enabled at levels @option{-O2}, @option{-O3}.
8241
8242 @item -falign-labels
8243 @itemx -falign-labels=@var{n}
8244 @opindex falign-labels
8245 Align all branch targets to a power-of-two boundary, skipping up to
8246 @var{n} bytes like @option{-falign-functions}. This option can easily
8247 make code slower, because it must insert dummy operations for when the
8248 branch target is reached in the usual flow of the code.
8249
8250 @option{-fno-align-labels} and @option{-falign-labels=1} are
8251 equivalent and mean that labels are not aligned.
8252
8253 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8254 are greater than this value, then their values are used instead.
8255
8256 If @var{n} is not specified or is zero, use a machine-dependent default
8257 which is very likely to be @samp{1}, meaning no alignment.
8258
8259 Enabled at levels @option{-O2}, @option{-O3}.
8260
8261 @item -falign-loops
8262 @itemx -falign-loops=@var{n}
8263 @opindex falign-loops
8264 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8265 like @option{-falign-functions}. If the loops are
8266 executed many times, this makes up for any execution of the dummy
8267 operations.
8268
8269 @option{-fno-align-loops} and @option{-falign-loops=1} are
8270 equivalent and mean that loops are not aligned.
8271
8272 If @var{n} is not specified or is zero, use a machine-dependent default.
8273
8274 Enabled at levels @option{-O2}, @option{-O3}.
8275
8276 @item -falign-jumps
8277 @itemx -falign-jumps=@var{n}
8278 @opindex falign-jumps
8279 Align branch targets to a power-of-two boundary, for branch targets
8280 where the targets can only be reached by jumping, skipping up to @var{n}
8281 bytes like @option{-falign-functions}. In this case, no dummy operations
8282 need be executed.
8283
8284 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8285 equivalent and mean that loops are not aligned.
8286
8287 If @var{n} is not specified or is zero, use a machine-dependent default.
8288
8289 Enabled at levels @option{-O2}, @option{-O3}.
8290
8291 @item -funit-at-a-time
8292 @opindex funit-at-a-time
8293 This option is left for compatibility reasons. @option{-funit-at-a-time}
8294 has no effect, while @option{-fno-unit-at-a-time} implies
8295 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8296
8297 Enabled by default.
8298
8299 @item -fno-toplevel-reorder
8300 @opindex fno-toplevel-reorder
8301 Do not reorder top-level functions, variables, and @code{asm}
8302 statements. Output them in the same order that they appear in the
8303 input file. When this option is used, unreferenced static variables
8304 are not removed. This option is intended to support existing code
8305 that relies on a particular ordering. For new code, it is better to
8306 use attributes.
8307
8308 Enabled at level @option{-O0}. When disabled explicitly, it also implies
8309 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8310 targets.
8311
8312 @item -fweb
8313 @opindex fweb
8314 Constructs webs as commonly used for register allocation purposes and assign
8315 each web individual pseudo register. This allows the register allocation pass
8316 to operate on pseudos directly, but also strengthens several other optimization
8317 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
8318 however, make debugging impossible, since variables no longer stay in a
8319 ``home register''.
8320
8321 Enabled by default with @option{-funroll-loops}.
8322
8323 @item -fwhole-program
8324 @opindex fwhole-program
8325 Assume that the current compilation unit represents the whole program being
8326 compiled. All public functions and variables with the exception of @code{main}
8327 and those merged by attribute @code{externally_visible} become static functions
8328 and in effect are optimized more aggressively by interprocedural optimizers.
8329
8330 This option should not be used in combination with @code{-flto}.
8331 Instead relying on a linker plugin should provide safer and more precise
8332 information.
8333
8334 @item -flto[=@var{n}]
8335 @opindex flto
8336 This option runs the standard link-time optimizer. When invoked
8337 with source code, it generates GIMPLE (one of GCC's internal
8338 representations) and writes it to special ELF sections in the object
8339 file. When the object files are linked together, all the function
8340 bodies are read from these ELF sections and instantiated as if they
8341 had been part of the same translation unit.
8342
8343 To use the link-time optimizer, @option{-flto} needs to be specified at
8344 compile time and during the final link. For example:
8345
8346 @smallexample
8347 gcc -c -O2 -flto foo.c
8348 gcc -c -O2 -flto bar.c
8349 gcc -o myprog -flto -O2 foo.o bar.o
8350 @end smallexample
8351
8352 The first two invocations to GCC save a bytecode representation
8353 of GIMPLE into special ELF sections inside @file{foo.o} and
8354 @file{bar.o}. The final invocation reads the GIMPLE bytecode from
8355 @file{foo.o} and @file{bar.o}, merges the two files into a single
8356 internal image, and compiles the result as usual. Since both
8357 @file{foo.o} and @file{bar.o} are merged into a single image, this
8358 causes all the interprocedural analyses and optimizations in GCC to
8359 work across the two files as if they were a single one. This means,
8360 for example, that the inliner is able to inline functions in
8361 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8362
8363 Another (simpler) way to enable link-time optimization is:
8364
8365 @smallexample
8366 gcc -o myprog -flto -O2 foo.c bar.c
8367 @end smallexample
8368
8369 The above generates bytecode for @file{foo.c} and @file{bar.c},
8370 merges them together into a single GIMPLE representation and optimizes
8371 them as usual to produce @file{myprog}.
8372
8373 The only important thing to keep in mind is that to enable link-time
8374 optimizations the @option{-flto} flag needs to be passed to both the
8375 compile and the link commands.
8376
8377 To make whole program optimization effective, it is necessary to make
8378 certain whole program assumptions. The compiler needs to know
8379 what functions and variables can be accessed by libraries and runtime
8380 outside of the link-time optimized unit. When supported by the linker,
8381 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8382 to the compiler about used and externally visible symbols. When
8383 the linker plugin is not available, @option{-fwhole-program} should be
8384 used to allow the compiler to make these assumptions, which leads
8385 to more aggressive optimization decisions.
8386
8387 Note that when a file is compiled with @option{-flto}, the generated
8388 object file is larger than a regular object file because it
8389 contains GIMPLE bytecodes and the usual final code. This means that
8390 object files with LTO information can be linked as normal object
8391 files; if @option{-flto} is not passed to the linker, no
8392 interprocedural optimizations are applied.
8393
8394 Additionally, the optimization flags used to compile individual files
8395 are not necessarily related to those used at link time. For instance,
8396
8397 @smallexample
8398 gcc -c -O0 -flto foo.c
8399 gcc -c -O0 -flto bar.c
8400 gcc -o myprog -flto -O3 foo.o bar.o
8401 @end smallexample
8402
8403 This produces individual object files with unoptimized assembler
8404 code, but the resulting binary @file{myprog} is optimized at
8405 @option{-O3}. If, instead, the final binary is generated without
8406 @option{-flto}, then @file{myprog} is not optimized.
8407
8408 When producing the final binary with @option{-flto}, GCC only
8409 applies link-time optimizations to those files that contain bytecode.
8410 Therefore, you can mix and match object files and libraries with
8411 GIMPLE bytecodes and final object code. GCC automatically selects
8412 which files to optimize in LTO mode and which files to link without
8413 further processing.
8414
8415 There are some code generation flags preserved by GCC when
8416 generating bytecodes, as they need to be used during the final link
8417 stage. Currently, the following options are saved into the GIMPLE
8418 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8419 @option{-m} target flags.
8420
8421 At link time, these options are read in and reapplied. Note that the
8422 current implementation makes no attempt to recognize conflicting
8423 values for these options. If different files have conflicting option
8424 values (e.g., one file is compiled with @option{-fPIC} and another
8425 isn't), the compiler simply uses the last value read from the
8426 bytecode files. It is recommended, then, that you compile all the files
8427 participating in the same link with the same options.
8428
8429 If LTO encounters objects with C linkage declared with incompatible
8430 types in separate translation units to be linked together (undefined
8431 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8432 issued. The behavior is still undefined at run time.
8433
8434 Another feature of LTO is that it is possible to apply interprocedural
8435 optimizations on files written in different languages. This requires
8436 support in the language front end. Currently, the C, C++ and
8437 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8438 something like this should work:
8439
8440 @smallexample
8441 gcc -c -flto foo.c
8442 g++ -c -flto bar.cc
8443 gfortran -c -flto baz.f90
8444 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8445 @end smallexample
8446
8447 Notice that the final link is done with @command{g++} to get the C++
8448 runtime libraries and @option{-lgfortran} is added to get the Fortran
8449 runtime libraries. In general, when mixing languages in LTO mode, you
8450 should use the same link command options as when mixing languages in a
8451 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8452 all the compile and link commands.
8453
8454 If object files containing GIMPLE bytecode are stored in a library archive, say
8455 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8456 are using a linker with plugin support. To enable this feature, use
8457 the flag @option{-fuse-linker-plugin} at link time:
8458
8459 @smallexample
8460 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8461 @end smallexample
8462
8463 With the linker plugin enabled, the linker extracts the needed
8464 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8465 to make them part of the aggregated GIMPLE image to be optimized.
8466
8467 If you are not using a linker with plugin support and/or do not
8468 enable the linker plugin, then the objects inside @file{libfoo.a}
8469 are extracted and linked as usual, but they do not participate
8470 in the LTO optimization process.
8471
8472 Link-time optimizations do not require the presence of the whole program to
8473 operate. If the program does not require any symbols to be exported, it is
8474 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8475 the interprocedural optimizers to use more aggressive assumptions which may
8476 lead to improved optimization opportunities.
8477 Use of @option{-fwhole-program} is not needed when linker plugin is
8478 active (see @option{-fuse-linker-plugin}).
8479
8480 The current implementation of LTO makes no
8481 attempt to generate bytecode that is portable between different
8482 types of hosts. The bytecode files are versioned and there is a
8483 strict version check, so bytecode files generated in one version of
8484 GCC will not work with an older/newer version of GCC@.
8485
8486 Link-time optimization does not work well with generation of debugging
8487 information. Combining @option{-flto} with
8488 @option{-g} is currently experimental and expected to produce wrong
8489 results.
8490
8491 If you specify the optional @var{n}, the optimization and code
8492 generation done at link time is executed in parallel using @var{n}
8493 parallel jobs by utilizing an installed @command{make} program. The
8494 environment variable @env{MAKE} may be used to override the program
8495 used. The default value for @var{n} is 1.
8496
8497 You can also specify @option{-flto=jobserver} to use GNU make's
8498 job server mode to determine the number of parallel jobs. This
8499 is useful when the Makefile calling GCC is already executing in parallel.
8500 You must prepend a @samp{+} to the command recipe in the parent Makefile
8501 for this to work. This option likely only works if @env{MAKE} is
8502 GNU make.
8503
8504 This option is disabled by default.
8505
8506 @item -flto-partition=@var{alg}
8507 @opindex flto-partition
8508 Specify the partitioning algorithm used by the link-time optimizer.
8509 The value is either @code{1to1} to specify a partitioning mirroring
8510 the original source files or @code{balanced} to specify partitioning
8511 into equally sized chunks (whenever possible) or @code{max} to create
8512 new partition for every symbol where possible. Specifying @code{none}
8513 as an algorithm disables partitioning and streaming completely.
8514 The default value is @code{balanced}. While @code{1to1} can be used
8515 as an workaround for various code ordering issues, the @code{max}
8516 partitioning is intended for internal testing only.
8517
8518 @item -flto-compression-level=@var{n}
8519 This option specifies the level of compression used for intermediate
8520 language written to LTO object files, and is only meaningful in
8521 conjunction with LTO mode (@option{-flto}). Valid
8522 values are 0 (no compression) to 9 (maximum compression). Values
8523 outside this range are clamped to either 0 or 9. If the option is not
8524 given, a default balanced compression setting is used.
8525
8526 @item -flto-report
8527 Prints a report with internal details on the workings of the link-time
8528 optimizer. The contents of this report vary from version to version.
8529 It is meant to be useful to GCC developers when processing object
8530 files in LTO mode (via @option{-flto}).
8531
8532 Disabled by default.
8533
8534 @item -flto-report-wpa
8535 Like @option{-flto-report}, but only print for the WPA phase of Link
8536 Time Optimization.
8537
8538 @item -fuse-linker-plugin
8539 Enables the use of a linker plugin during link-time optimization. This
8540 option relies on plugin support in the linker, which is available in gold
8541 or in GNU ld 2.21 or newer.
8542
8543 This option enables the extraction of object files with GIMPLE bytecode out
8544 of library archives. This improves the quality of optimization by exposing
8545 more code to the link-time optimizer. This information specifies what
8546 symbols can be accessed externally (by non-LTO object or during dynamic
8547 linking). Resulting code quality improvements on binaries (and shared
8548 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8549 See @option{-flto} for a description of the effect of this flag and how to
8550 use it.
8551
8552 This option is enabled by default when LTO support in GCC is enabled
8553 and GCC was configured for use with
8554 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8555
8556 @item -ffat-lto-objects
8557 @opindex ffat-lto-objects
8558 Fat LTO objects are object files that contain both the intermediate language
8559 and the object code. This makes them usable for both LTO linking and normal
8560 linking. This option is effective only when compiling with @option{-flto}
8561 and is ignored at link time.
8562
8563 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8564 requires the complete toolchain to be aware of LTO. It requires a linker with
8565 linker plugin support for basic functionality. Additionally,
8566 @command{nm}, @command{ar} and @command{ranlib}
8567 need to support linker plugins to allow a full-featured build environment
8568 (capable of building static libraries etc). GCC provides the @command{gcc-ar},
8569 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8570 to these tools. With non fat LTO makefiles need to be modified to use them.
8571
8572 The default is @option{-ffat-lto-objects} but this default is intended to
8573 change in future releases when linker plugin enabled environments become more
8574 common.
8575
8576 @item -fcompare-elim
8577 @opindex fcompare-elim
8578 After register allocation and post-register allocation instruction splitting,
8579 identify arithmetic instructions that compute processor flags similar to a
8580 comparison operation based on that arithmetic. If possible, eliminate the
8581 explicit comparison operation.
8582
8583 This pass only applies to certain targets that cannot explicitly represent
8584 the comparison operation before register allocation is complete.
8585
8586 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8587
8588 @item -fuse-ld=bfd
8589 Use the @command{bfd} linker instead of the default linker.
8590
8591 @item -fuse-ld=gold
8592 Use the @command{gold} linker instead of the default linker.
8593
8594 @item -fcprop-registers
8595 @opindex fcprop-registers
8596 After register allocation and post-register allocation instruction splitting,
8597 perform a copy-propagation pass to try to reduce scheduling dependencies
8598 and occasionally eliminate the copy.
8599
8600 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8601
8602 @item -fprofile-correction
8603 @opindex fprofile-correction
8604 Profiles collected using an instrumented binary for multi-threaded programs may
8605 be inconsistent due to missed counter updates. When this option is specified,
8606 GCC uses heuristics to correct or smooth out such inconsistencies. By
8607 default, GCC emits an error message when an inconsistent profile is detected.
8608
8609 @item -fprofile-dir=@var{path}
8610 @opindex fprofile-dir
8611
8612 Set the directory to search for the profile data files in to @var{path}.
8613 This option affects only the profile data generated by
8614 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8615 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8616 and its related options. Both absolute and relative paths can be used.
8617 By default, GCC uses the current directory as @var{path}, thus the
8618 profile data file appears in the same directory as the object file.
8619
8620 @item -fprofile-generate
8621 @itemx -fprofile-generate=@var{path}
8622 @opindex fprofile-generate
8623
8624 Enable options usually used for instrumenting application to produce
8625 profile useful for later recompilation with profile feedback based
8626 optimization. You must use @option{-fprofile-generate} both when
8627 compiling and when linking your program.
8628
8629 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8630
8631 If @var{path} is specified, GCC looks at the @var{path} to find
8632 the profile feedback data files. See @option{-fprofile-dir}.
8633
8634 @item -fprofile-use
8635 @itemx -fprofile-use=@var{path}
8636 @opindex fprofile-use
8637 Enable profile feedback directed optimizations, and optimizations
8638 generally profitable only with profile feedback available.
8639
8640 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8641 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8642 @code{ftree-loop-distribute-patterns}
8643
8644 By default, GCC emits an error message if the feedback profiles do not
8645 match the source code. This error can be turned into a warning by using
8646 @option{-Wcoverage-mismatch}. Note this may result in poorly optimized
8647 code.
8648
8649 If @var{path} is specified, GCC looks at the @var{path} to find
8650 the profile feedback data files. See @option{-fprofile-dir}.
8651 @end table
8652
8653 The following options control compiler behavior regarding floating-point
8654 arithmetic. These options trade off between speed and
8655 correctness. All must be specifically enabled.
8656
8657 @table @gcctabopt
8658 @item -ffloat-store
8659 @opindex ffloat-store
8660 Do not store floating-point variables in registers, and inhibit other
8661 options that might change whether a floating-point value is taken from a
8662 register or memory.
8663
8664 @cindex floating-point precision
8665 This option prevents undesirable excess precision on machines such as
8666 the 68000 where the floating registers (of the 68881) keep more
8667 precision than a @code{double} is supposed to have. Similarly for the
8668 x86 architecture. For most programs, the excess precision does only
8669 good, but a few programs rely on the precise definition of IEEE floating
8670 point. Use @option{-ffloat-store} for such programs, after modifying
8671 them to store all pertinent intermediate computations into variables.
8672
8673 @item -fexcess-precision=@var{style}
8674 @opindex fexcess-precision
8675 This option allows further control over excess precision on machines
8676 where floating-point registers have more precision than the IEEE
8677 @code{float} and @code{double} types and the processor does not
8678 support operations rounding to those types. By default,
8679 @option{-fexcess-precision=fast} is in effect; this means that
8680 operations are carried out in the precision of the registers and that
8681 it is unpredictable when rounding to the types specified in the source
8682 code takes place. When compiling C, if
8683 @option{-fexcess-precision=standard} is specified then excess
8684 precision follows the rules specified in ISO C99; in particular,
8685 both casts and assignments cause values to be rounded to their
8686 semantic types (whereas @option{-ffloat-store} only affects
8687 assignments). This option is enabled by default for C if a strict
8688 conformance option such as @option{-std=c99} is used.
8689
8690 @opindex mfpmath
8691 @option{-fexcess-precision=standard} is not implemented for languages
8692 other than C, and has no effect if
8693 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8694 specified. On the x86, it also has no effect if @option{-mfpmath=sse}
8695 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8696 semantics apply without excess precision, and in the latter, rounding
8697 is unpredictable.
8698
8699 @item -ffast-math
8700 @opindex ffast-math
8701 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8702 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8703 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8704
8705 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8706
8707 This option is not turned on by any @option{-O} option besides
8708 @option{-Ofast} since it can result in incorrect output for programs
8709 that depend on an exact implementation of IEEE or ISO rules/specifications
8710 for math functions. It may, however, yield faster code for programs
8711 that do not require the guarantees of these specifications.
8712
8713 @item -fno-math-errno
8714 @opindex fno-math-errno
8715 Do not set @code{errno} after calling math functions that are executed
8716 with a single instruction, e.g., @code{sqrt}. A program that relies on
8717 IEEE exceptions for math error handling may want to use this flag
8718 for speed while maintaining IEEE arithmetic compatibility.
8719
8720 This option is not turned on by any @option{-O} option since
8721 it can result in incorrect output for programs that depend on
8722 an exact implementation of IEEE or ISO rules/specifications for
8723 math functions. It may, however, yield faster code for programs
8724 that do not require the guarantees of these specifications.
8725
8726 The default is @option{-fmath-errno}.
8727
8728 On Darwin systems, the math library never sets @code{errno}. There is
8729 therefore no reason for the compiler to consider the possibility that
8730 it might, and @option{-fno-math-errno} is the default.
8731
8732 @item -funsafe-math-optimizations
8733 @opindex funsafe-math-optimizations
8734
8735 Allow optimizations for floating-point arithmetic that (a) assume
8736 that arguments and results are valid and (b) may violate IEEE or
8737 ANSI standards. When used at link-time, it may include libraries
8738 or startup files that change the default FPU control word or other
8739 similar optimizations.
8740
8741 This option is not turned on by any @option{-O} option since
8742 it can result in incorrect output for programs that depend on
8743 an exact implementation of IEEE or ISO rules/specifications for
8744 math functions. It may, however, yield faster code for programs
8745 that do not require the guarantees of these specifications.
8746 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8747 @option{-fassociative-math} and @option{-freciprocal-math}.
8748
8749 The default is @option{-fno-unsafe-math-optimizations}.
8750
8751 @item -fassociative-math
8752 @opindex fassociative-math
8753
8754 Allow re-association of operands in series of floating-point operations.
8755 This violates the ISO C and C++ language standard by possibly changing
8756 computation result. NOTE: re-ordering may change the sign of zero as
8757 well as ignore NaNs and inhibit or create underflow or overflow (and
8758 thus cannot be used on code that relies on rounding behavior like
8759 @code{(x + 2**52) - 2**52}. May also reorder floating-point comparisons
8760 and thus may not be used when ordered comparisons are required.
8761 This option requires that both @option{-fno-signed-zeros} and
8762 @option{-fno-trapping-math} be in effect. Moreover, it doesn't make
8763 much sense with @option{-frounding-math}. For Fortran the option
8764 is automatically enabled when both @option{-fno-signed-zeros} and
8765 @option{-fno-trapping-math} are in effect.
8766
8767 The default is @option{-fno-associative-math}.
8768
8769 @item -freciprocal-math
8770 @opindex freciprocal-math
8771
8772 Allow the reciprocal of a value to be used instead of dividing by
8773 the value if this enables optimizations. For example @code{x / y}
8774 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8775 is subject to common subexpression elimination. Note that this loses
8776 precision and increases the number of flops operating on the value.
8777
8778 The default is @option{-fno-reciprocal-math}.
8779
8780 @item -ffinite-math-only
8781 @opindex ffinite-math-only
8782 Allow optimizations for floating-point arithmetic that assume
8783 that arguments and results are not NaNs or +-Infs.
8784
8785 This option is not turned on by any @option{-O} option since
8786 it can result in incorrect output for programs that depend on
8787 an exact implementation of IEEE or ISO rules/specifications for
8788 math functions. It may, however, yield faster code for programs
8789 that do not require the guarantees of these specifications.
8790
8791 The default is @option{-fno-finite-math-only}.
8792
8793 @item -fno-signed-zeros
8794 @opindex fno-signed-zeros
8795 Allow optimizations for floating-point arithmetic that ignore the
8796 signedness of zero. IEEE arithmetic specifies the behavior of
8797 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8798 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8799 This option implies that the sign of a zero result isn't significant.
8800
8801 The default is @option{-fsigned-zeros}.
8802
8803 @item -fno-trapping-math
8804 @opindex fno-trapping-math
8805 Compile code assuming that floating-point operations cannot generate
8806 user-visible traps. These traps include division by zero, overflow,
8807 underflow, inexact result and invalid operation. This option requires
8808 that @option{-fno-signaling-nans} be in effect. Setting this option may
8809 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8810
8811 This option should never be turned on by any @option{-O} option since
8812 it can result in incorrect output for programs that depend on
8813 an exact implementation of IEEE or ISO rules/specifications for
8814 math functions.
8815
8816 The default is @option{-ftrapping-math}.
8817
8818 @item -frounding-math
8819 @opindex frounding-math
8820 Disable transformations and optimizations that assume default floating-point
8821 rounding behavior. This is round-to-zero for all floating point
8822 to integer conversions, and round-to-nearest for all other arithmetic
8823 truncations. This option should be specified for programs that change
8824 the FP rounding mode dynamically, or that may be executed with a
8825 non-default rounding mode. This option disables constant folding of
8826 floating-point expressions at compile time (which may be affected by
8827 rounding mode) and arithmetic transformations that are unsafe in the
8828 presence of sign-dependent rounding modes.
8829
8830 The default is @option{-fno-rounding-math}.
8831
8832 This option is experimental and does not currently guarantee to
8833 disable all GCC optimizations that are affected by rounding mode.
8834 Future versions of GCC may provide finer control of this setting
8835 using C99's @code{FENV_ACCESS} pragma. This command-line option
8836 will be used to specify the default state for @code{FENV_ACCESS}.
8837
8838 @item -fsignaling-nans
8839 @opindex fsignaling-nans
8840 Compile code assuming that IEEE signaling NaNs may generate user-visible
8841 traps during floating-point operations. Setting this option disables
8842 optimizations that may change the number of exceptions visible with
8843 signaling NaNs. This option implies @option{-ftrapping-math}.
8844
8845 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8846 be defined.
8847
8848 The default is @option{-fno-signaling-nans}.
8849
8850 This option is experimental and does not currently guarantee to
8851 disable all GCC optimizations that affect signaling NaN behavior.
8852
8853 @item -fsingle-precision-constant
8854 @opindex fsingle-precision-constant
8855 Treat floating-point constants as single precision instead of
8856 implicitly converting them to double-precision constants.
8857
8858 @item -fcx-limited-range
8859 @opindex fcx-limited-range
8860 When enabled, this option states that a range reduction step is not
8861 needed when performing complex division. Also, there is no checking
8862 whether the result of a complex multiplication or division is @code{NaN
8863 + I*NaN}, with an attempt to rescue the situation in that case. The
8864 default is @option{-fno-cx-limited-range}, but is enabled by
8865 @option{-ffast-math}.
8866
8867 This option controls the default setting of the ISO C99
8868 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
8869 all languages.
8870
8871 @item -fcx-fortran-rules
8872 @opindex fcx-fortran-rules
8873 Complex multiplication and division follow Fortran rules. Range
8874 reduction is done as part of complex division, but there is no checking
8875 whether the result of a complex multiplication or division is @code{NaN
8876 + I*NaN}, with an attempt to rescue the situation in that case.
8877
8878 The default is @option{-fno-cx-fortran-rules}.
8879
8880 @end table
8881
8882 The following options control optimizations that may improve
8883 performance, but are not enabled by any @option{-O} options. This
8884 section includes experimental options that may produce broken code.
8885
8886 @table @gcctabopt
8887 @item -fbranch-probabilities
8888 @opindex fbranch-probabilities
8889 After running a program compiled with @option{-fprofile-arcs}
8890 (@pxref{Debugging Options,, Options for Debugging Your Program or
8891 @command{gcc}}), you can compile it a second time using
8892 @option{-fbranch-probabilities}, to improve optimizations based on
8893 the number of times each branch was taken. When a program
8894 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8895 counts to a file called @file{@var{sourcename}.gcda} for each source
8896 file. The information in this data file is very dependent on the
8897 structure of the generated code, so you must use the same source code
8898 and the same optimization options for both compilations.
8899
8900 With @option{-fbranch-probabilities}, GCC puts a
8901 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8902 These can be used to improve optimization. Currently, they are only
8903 used in one place: in @file{reorg.c}, instead of guessing which path a
8904 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8905 exactly determine which path is taken more often.
8906
8907 @item -fprofile-values
8908 @opindex fprofile-values
8909 If combined with @option{-fprofile-arcs}, it adds code so that some
8910 data about values of expressions in the program is gathered.
8911
8912 With @option{-fbranch-probabilities}, it reads back the data gathered
8913 from profiling values of expressions for usage in optimizations.
8914
8915 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8916
8917 @item -fvpt
8918 @opindex fvpt
8919 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8920 to add code to gather information about values of expressions.
8921
8922 With @option{-fbranch-probabilities}, it reads back the data gathered
8923 and actually performs the optimizations based on them.
8924 Currently the optimizations include specialization of division operations
8925 using the knowledge about the value of the denominator.
8926
8927 @item -frename-registers
8928 @opindex frename-registers
8929 Attempt to avoid false dependencies in scheduled code by making use
8930 of registers left over after register allocation. This optimization
8931 most benefits processors with lots of registers. Depending on the
8932 debug information format adopted by the target, however, it can
8933 make debugging impossible, since variables no longer stay in
8934 a ``home register''.
8935
8936 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8937
8938 @item -ftracer
8939 @opindex ftracer
8940 Perform tail duplication to enlarge superblock size. This transformation
8941 simplifies the control flow of the function allowing other optimizations to do
8942 a better job.
8943
8944 Enabled with @option{-fprofile-use}.
8945
8946 @item -funroll-loops
8947 @opindex funroll-loops
8948 Unroll loops whose number of iterations can be determined at compile time or
8949 upon entry to the loop. @option{-funroll-loops} implies
8950 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8951 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8952 a small constant number of iterations). This option makes code larger, and may
8953 or may not make it run faster.
8954
8955 Enabled with @option{-fprofile-use}.
8956
8957 @item -funroll-all-loops
8958 @opindex funroll-all-loops
8959 Unroll all loops, even if their number of iterations is uncertain when
8960 the loop is entered. This usually makes programs run more slowly.
8961 @option{-funroll-all-loops} implies the same options as
8962 @option{-funroll-loops}.
8963
8964 @item -fpeel-loops
8965 @opindex fpeel-loops
8966 Peels loops for which there is enough information that they do not
8967 roll much (from profile feedback). It also turns on complete loop peeling
8968 (i.e.@: complete removal of loops with small constant number of iterations).
8969
8970 Enabled with @option{-fprofile-use}.
8971
8972 @item -fmove-loop-invariants
8973 @opindex fmove-loop-invariants
8974 Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
8975 at level @option{-O1}
8976
8977 @item -funswitch-loops
8978 @opindex funswitch-loops
8979 Move branches with loop invariant conditions out of the loop, with duplicates
8980 of the loop on both branches (modified according to result of the condition).
8981
8982 @item -ffunction-sections
8983 @itemx -fdata-sections
8984 @opindex ffunction-sections
8985 @opindex fdata-sections
8986 Place each function or data item into its own section in the output
8987 file if the target supports arbitrary sections. The name of the
8988 function or the name of the data item determines the section's name
8989 in the output file.
8990
8991 Use these options on systems where the linker can perform optimizations
8992 to improve locality of reference in the instruction space. Most systems
8993 using the ELF object format and SPARC processors running Solaris 2 have
8994 linkers with such optimizations. AIX may have these optimizations in
8995 the future.
8996
8997 Only use these options when there are significant benefits from doing
8998 so. When you specify these options, the assembler and linker
8999 create larger object and executable files and are also slower.
9000 You cannot use @code{gprof} on all systems if you
9001 specify this option, and you may have problems with debugging if
9002 you specify both this option and @option{-g}.
9003
9004 @item -fbranch-target-load-optimize
9005 @opindex fbranch-target-load-optimize
9006 Perform branch target register load optimization before prologue / epilogue
9007 threading.
9008 The use of target registers can typically be exposed only during reload,
9009 thus hoisting loads out of loops and doing inter-block scheduling needs
9010 a separate optimization pass.
9011
9012 @item -fbranch-target-load-optimize2
9013 @opindex fbranch-target-load-optimize2
9014 Perform branch target register load optimization after prologue / epilogue
9015 threading.
9016
9017 @item -fbtr-bb-exclusive
9018 @opindex fbtr-bb-exclusive
9019 When performing branch target register load optimization, don't reuse
9020 branch target registers within any basic block.
9021
9022 @item -fstack-protector
9023 @opindex fstack-protector
9024 Emit extra code to check for buffer overflows, such as stack smashing
9025 attacks. This is done by adding a guard variable to functions with
9026 vulnerable objects. This includes functions that call @code{alloca}, and
9027 functions with buffers larger than 8 bytes. The guards are initialized
9028 when a function is entered and then checked when the function exits.
9029 If a guard check fails, an error message is printed and the program exits.
9030
9031 @item -fstack-protector-all
9032 @opindex fstack-protector-all
9033 Like @option{-fstack-protector} except that all functions are protected.
9034
9035 @item -fstack-protector-strong
9036 @opindex fstack-protector-strong
9037 Like @option{-fstack-protector} but includes additional functions to
9038 be protected --- those that have local array definitions, or have
9039 references to local frame addresses.
9040
9041 @item -fsection-anchors
9042 @opindex fsection-anchors
9043 Try to reduce the number of symbolic address calculations by using
9044 shared ``anchor'' symbols to address nearby objects. This transformation
9045 can help to reduce the number of GOT entries and GOT accesses on some
9046 targets.
9047
9048 For example, the implementation of the following function @code{foo}:
9049
9050 @smallexample
9051 static int a, b, c;
9052 int foo (void) @{ return a + b + c; @}
9053 @end smallexample
9054
9055 @noindent
9056 usually calculates the addresses of all three variables, but if you
9057 compile it with @option{-fsection-anchors}, it accesses the variables
9058 from a common anchor point instead. The effect is similar to the
9059 following pseudocode (which isn't valid C):
9060
9061 @smallexample
9062 int foo (void)
9063 @{
9064 register int *xr = &x;
9065 return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9066 @}
9067 @end smallexample
9068
9069 Not all targets support this option.
9070
9071 @item --param @var{name}=@var{value}
9072 @opindex param
9073 In some places, GCC uses various constants to control the amount of
9074 optimization that is done. For example, GCC does not inline functions
9075 that contain more than a certain number of instructions. You can
9076 control some of these constants on the command line using the
9077 @option{--param} option.
9078
9079 The names of specific parameters, and the meaning of the values, are
9080 tied to the internals of the compiler, and are subject to change
9081 without notice in future releases.
9082
9083 In each case, the @var{value} is an integer. The allowable choices for
9084 @var{name} are:
9085
9086 @table @gcctabopt
9087 @item predictable-branch-outcome
9088 When branch is predicted to be taken with probability lower than this threshold
9089 (in percent), then it is considered well predictable. The default is 10.
9090
9091 @item max-crossjump-edges
9092 The maximum number of incoming edges to consider for cross-jumping.
9093 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9094 the number of edges incoming to each block. Increasing values mean
9095 more aggressive optimization, making the compilation time increase with
9096 probably small improvement in executable size.
9097
9098 @item min-crossjump-insns
9099 The minimum number of instructions that must be matched at the end
9100 of two blocks before cross-jumping is performed on them. This
9101 value is ignored in the case where all instructions in the block being
9102 cross-jumped from are matched. The default value is 5.
9103
9104 @item max-grow-copy-bb-insns
9105 The maximum code size expansion factor when copying basic blocks
9106 instead of jumping. The expansion is relative to a jump instruction.
9107 The default value is 8.
9108
9109 @item max-goto-duplication-insns
9110 The maximum number of instructions to duplicate to a block that jumps
9111 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
9112 passes, GCC factors computed gotos early in the compilation process,
9113 and unfactors them as late as possible. Only computed jumps at the
9114 end of a basic blocks with no more than max-goto-duplication-insns are
9115 unfactored. The default value is 8.
9116
9117 @item max-delay-slot-insn-search
9118 The maximum number of instructions to consider when looking for an
9119 instruction to fill a delay slot. If more than this arbitrary number of
9120 instructions are searched, the time savings from filling the delay slot
9121 are minimal, so stop searching. Increasing values mean more
9122 aggressive optimization, making the compilation time increase with probably
9123 small improvement in execution time.
9124
9125 @item max-delay-slot-live-search
9126 When trying to fill delay slots, the maximum number of instructions to
9127 consider when searching for a block with valid live register
9128 information. Increasing this arbitrarily chosen value means more
9129 aggressive optimization, increasing the compilation time. This parameter
9130 should be removed when the delay slot code is rewritten to maintain the
9131 control-flow graph.
9132
9133 @item max-gcse-memory
9134 The approximate maximum amount of memory that can be allocated in
9135 order to perform the global common subexpression elimination
9136 optimization. If more memory than specified is required, the
9137 optimization is not done.
9138
9139 @item max-gcse-insertion-ratio
9140 If the ratio of expression insertions to deletions is larger than this value
9141 for any expression, then RTL PRE inserts or removes the expression and thus
9142 leaves partially redundant computations in the instruction stream. The default value is 20.
9143
9144 @item max-pending-list-length
9145 The maximum number of pending dependencies scheduling allows
9146 before flushing the current state and starting over. Large functions
9147 with few branches or calls can create excessively large lists which
9148 needlessly consume memory and resources.
9149
9150 @item max-modulo-backtrack-attempts
9151 The maximum number of backtrack attempts the scheduler should make
9152 when modulo scheduling a loop. Larger values can exponentially increase
9153 compilation time.
9154
9155 @item max-inline-insns-single
9156 Several parameters control the tree inliner used in GCC@.
9157 This number sets the maximum number of instructions (counted in GCC's
9158 internal representation) in a single function that the tree inliner
9159 considers for inlining. This only affects functions declared
9160 inline and methods implemented in a class declaration (C++).
9161 The default value is 400.
9162
9163 @item max-inline-insns-auto
9164 When you use @option{-finline-functions} (included in @option{-O3}),
9165 a lot of functions that would otherwise not be considered for inlining
9166 by the compiler are investigated. To those functions, a different
9167 (more restrictive) limit compared to functions declared inline can
9168 be applied.
9169 The default value is 40.
9170
9171 @item inline-min-speedup
9172 When estimated performance improvement of caller + callee runtime exceeds this
9173 threshold (in precent), the function can be inlined regardless the limit on
9174 @option{--param max-inline-insns-single} and @option{--param
9175 max-inline-insns-auto}.
9176
9177 @item large-function-insns
9178 The limit specifying really large functions. For functions larger than this
9179 limit after inlining, inlining is constrained by
9180 @option{--param large-function-growth}. This parameter is useful primarily
9181 to avoid extreme compilation time caused by non-linear algorithms used by the
9182 back end.
9183 The default value is 2700.
9184
9185 @item large-function-growth
9186 Specifies maximal growth of large function caused by inlining in percents.
9187 The default value is 100 which limits large function growth to 2.0 times
9188 the original size.
9189
9190 @item large-unit-insns
9191 The limit specifying large translation unit. Growth caused by inlining of
9192 units larger than this limit is limited by @option{--param inline-unit-growth}.
9193 For small units this might be too tight.
9194 For example, consider a unit consisting of function A
9195 that is inline and B that just calls A three times. If B is small relative to
9196 A, the growth of unit is 300\% and yet such inlining is very sane. For very
9197 large units consisting of small inlineable functions, however, the overall unit
9198 growth limit is needed to avoid exponential explosion of code size. Thus for
9199 smaller units, the size is increased to @option{--param large-unit-insns}
9200 before applying @option{--param inline-unit-growth}. The default is 10000.
9201
9202 @item inline-unit-growth
9203 Specifies maximal overall growth of the compilation unit caused by inlining.
9204 The default value is 30 which limits unit growth to 1.3 times the original
9205 size.
9206
9207 @item ipcp-unit-growth
9208 Specifies maximal overall growth of the compilation unit caused by
9209 interprocedural constant propagation. The default value is 10 which limits
9210 unit growth to 1.1 times the original size.
9211
9212 @item large-stack-frame
9213 The limit specifying large stack frames. While inlining the algorithm is trying
9214 to not grow past this limit too much. The default value is 256 bytes.
9215
9216 @item large-stack-frame-growth
9217 Specifies maximal growth of large stack frames caused by inlining in percents.
9218 The default value is 1000 which limits large stack frame growth to 11 times
9219 the original size.
9220
9221 @item max-inline-insns-recursive
9222 @itemx max-inline-insns-recursive-auto
9223 Specifies the maximum number of instructions an out-of-line copy of a
9224 self-recursive inline
9225 function can grow into by performing recursive inlining.
9226
9227 For functions declared inline, @option{--param max-inline-insns-recursive} is
9228 taken into account. For functions not declared inline, recursive inlining
9229 happens only when @option{-finline-functions} (included in @option{-O3}) is
9230 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
9231 default value is 450.
9232
9233 @item max-inline-recursive-depth
9234 @itemx max-inline-recursive-depth-auto
9235 Specifies the maximum recursion depth used for recursive inlining.
9236
9237 For functions declared inline, @option{--param max-inline-recursive-depth} is
9238 taken into account. For functions not declared inline, recursive inlining
9239 happens only when @option{-finline-functions} (included in @option{-O3}) is
9240 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
9241 default value is 8.
9242
9243 @item min-inline-recursive-probability
9244 Recursive inlining is profitable only for function having deep recursion
9245 in average and can hurt for function having little recursion depth by
9246 increasing the prologue size or complexity of function body to other
9247 optimizers.
9248
9249 When profile feedback is available (see @option{-fprofile-generate}) the actual
9250 recursion depth can be guessed from probability that function recurses via a
9251 given call expression. This parameter limits inlining only to call expressions
9252 whose probability exceeds the given threshold (in percents).
9253 The default value is 10.
9254
9255 @item early-inlining-insns
9256 Specify growth that the early inliner can make. In effect it increases
9257 the amount of inlining for code having a large abstraction penalty.
9258 The default value is 10.
9259
9260 @item max-early-inliner-iterations
9261 @itemx max-early-inliner-iterations
9262 Limit of iterations of the early inliner. This basically bounds
9263 the number of nested indirect calls the early inliner can resolve.
9264 Deeper chains are still handled by late inlining.
9265
9266 @item comdat-sharing-probability
9267 @itemx comdat-sharing-probability
9268 Probability (in percent) that C++ inline function with comdat visibility
9269 are shared across multiple compilation units. The default value is 20.
9270
9271 @item min-vect-loop-bound
9272 The minimum number of iterations under which loops are not vectorized
9273 when @option{-ftree-vectorize} is used. The number of iterations after
9274 vectorization needs to be greater than the value specified by this option
9275 to allow vectorization. The default value is 0.
9276
9277 @item gcse-cost-distance-ratio
9278 Scaling factor in calculation of maximum distance an expression
9279 can be moved by GCSE optimizations. This is currently supported only in the
9280 code hoisting pass. The bigger the ratio, the more aggressive code hoisting
9281 is with simple expressions, i.e., the expressions that have cost
9282 less than @option{gcse-unrestricted-cost}. Specifying 0 disables
9283 hoisting of simple expressions. The default value is 10.
9284
9285 @item gcse-unrestricted-cost
9286 Cost, roughly measured as the cost of a single typical machine
9287 instruction, at which GCSE optimizations do not constrain
9288 the distance an expression can travel. This is currently
9289 supported only in the code hoisting pass. The lesser the cost,
9290 the more aggressive code hoisting is. Specifying 0
9291 allows all expressions to travel unrestricted distances.
9292 The default value is 3.
9293
9294 @item max-hoist-depth
9295 The depth of search in the dominator tree for expressions to hoist.
9296 This is used to avoid quadratic behavior in hoisting algorithm.
9297 The value of 0 does not limit on the search, but may slow down compilation
9298 of huge functions. The default value is 30.
9299
9300 @item max-tail-merge-comparisons
9301 The maximum amount of similar bbs to compare a bb with. This is used to
9302 avoid quadratic behavior in tree tail merging. The default value is 10.
9303
9304 @item max-tail-merge-iterations
9305 The maximum amount of iterations of the pass over the function. This is used to
9306 limit compilation time in tree tail merging. The default value is 2.
9307
9308 @item max-unrolled-insns
9309 The maximum number of instructions that a loop may have to be unrolled.
9310 If a loop is unrolled, this parameter also determines how many times
9311 the loop code is unrolled.
9312
9313 @item max-average-unrolled-insns
9314 The maximum number of instructions biased by probabilities of their execution
9315 that a loop may have to be unrolled. If a loop is unrolled,
9316 this parameter also determines how many times the loop code is unrolled.
9317
9318 @item max-unroll-times
9319 The maximum number of unrollings of a single loop.
9320
9321 @item max-peeled-insns
9322 The maximum number of instructions that a loop may have to be peeled.
9323 If a loop is peeled, this parameter also determines how many times
9324 the loop code is peeled.
9325
9326 @item max-peel-times
9327 The maximum number of peelings of a single loop.
9328
9329 @item max-peel-branches
9330 The maximum number of branches on the hot path through the peeled sequence.
9331
9332 @item max-completely-peeled-insns
9333 The maximum number of insns of a completely peeled loop.
9334
9335 @item max-completely-peel-times
9336 The maximum number of iterations of a loop to be suitable for complete peeling.
9337
9338 @item max-completely-peel-loop-nest-depth
9339 The maximum depth of a loop nest suitable for complete peeling.
9340
9341 @item max-unswitch-insns
9342 The maximum number of insns of an unswitched loop.
9343
9344 @item max-unswitch-level
9345 The maximum number of branches unswitched in a single loop.
9346
9347 @item lim-expensive
9348 The minimum cost of an expensive expression in the loop invariant motion.
9349
9350 @item iv-consider-all-candidates-bound
9351 Bound on number of candidates for induction variables, below which
9352 all candidates are considered for each use in induction variable
9353 optimizations. If there are more candidates than this,
9354 only the most relevant ones are considered to avoid quadratic time complexity.
9355
9356 @item iv-max-considered-uses
9357 The induction variable optimizations give up on loops that contain more
9358 induction variable uses.
9359
9360 @item iv-always-prune-cand-set-bound
9361 If the number of candidates in the set is smaller than this value,
9362 always try to remove unnecessary ivs from the set
9363 when adding a new one.
9364
9365 @item scev-max-expr-size
9366 Bound on size of expressions used in the scalar evolutions analyzer.
9367 Large expressions slow the analyzer.
9368
9369 @item scev-max-expr-complexity
9370 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9371 Complex expressions slow the analyzer.
9372
9373 @item omega-max-vars
9374 The maximum number of variables in an Omega constraint system.
9375 The default value is 128.
9376
9377 @item omega-max-geqs
9378 The maximum number of inequalities in an Omega constraint system.
9379 The default value is 256.
9380
9381 @item omega-max-eqs
9382 The maximum number of equalities in an Omega constraint system.
9383 The default value is 128.
9384
9385 @item omega-max-wild-cards
9386 The maximum number of wildcard variables that the Omega solver is
9387 able to insert. The default value is 18.
9388
9389 @item omega-hash-table-size
9390 The size of the hash table in the Omega solver. The default value is
9391 550.
9392
9393 @item omega-max-keys
9394 The maximal number of keys used by the Omega solver. The default
9395 value is 500.
9396
9397 @item omega-eliminate-redundant-constraints
9398 When set to 1, use expensive methods to eliminate all redundant
9399 constraints. The default value is 0.
9400
9401 @item vect-max-version-for-alignment-checks
9402 The maximum number of run-time checks that can be performed when
9403 doing loop versioning for alignment in the vectorizer. See option
9404 @option{-ftree-vect-loop-version} for more information.
9405
9406 @item vect-max-version-for-alias-checks
9407 The maximum number of run-time checks that can be performed when
9408 doing loop versioning for alias in the vectorizer. See option
9409 @option{-ftree-vect-loop-version} for more information.
9410
9411 @item max-iterations-to-track
9412 The maximum number of iterations of a loop the brute-force algorithm
9413 for analysis of the number of iterations of the loop tries to evaluate.
9414
9415 @item hot-bb-count-ws-permille
9416 A basic block profile count is considered hot if it contributes to
9417 the given permillage (i.e. 0...1000) of the entire profiled execution.
9418
9419 @item hot-bb-frequency-fraction
9420 Select fraction of the entry block frequency of executions of basic block in
9421 function given basic block needs to have to be considered hot.
9422
9423 @item max-predicted-iterations
9424 The maximum number of loop iterations we predict statically. This is useful
9425 in cases where a function contains a single loop with known bound and
9426 another loop with unknown bound.
9427 The known number of iterations is predicted correctly, while
9428 the unknown number of iterations average to roughly 10. This means that the
9429 loop without bounds appears artificially cold relative to the other one.
9430
9431 @item align-threshold
9432
9433 Select fraction of the maximal frequency of executions of a basic block in
9434 a function to align the basic block.
9435
9436 @item align-loop-iterations
9437
9438 A loop expected to iterate at least the selected number of iterations is
9439 aligned.
9440
9441 @item tracer-dynamic-coverage
9442 @itemx tracer-dynamic-coverage-feedback
9443
9444 This value is used to limit superblock formation once the given percentage of
9445 executed instructions is covered. This limits unnecessary code size
9446 expansion.
9447
9448 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9449 feedback is available. The real profiles (as opposed to statically estimated
9450 ones) are much less balanced allowing the threshold to be larger value.
9451
9452 @item tracer-max-code-growth
9453 Stop tail duplication once code growth has reached given percentage. This is
9454 a rather artificial limit, as most of the duplicates are eliminated later in
9455 cross jumping, so it may be set to much higher values than is the desired code
9456 growth.
9457
9458 @item tracer-min-branch-ratio
9459
9460 Stop reverse growth when the reverse probability of best edge is less than this
9461 threshold (in percent).
9462
9463 @item tracer-min-branch-ratio
9464 @itemx tracer-min-branch-ratio-feedback
9465
9466 Stop forward growth if the best edge has probability lower than this
9467 threshold.
9468
9469 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9470 compilation for profile feedback and one for compilation without. The value
9471 for compilation with profile feedback needs to be more conservative (higher) in
9472 order to make tracer effective.
9473
9474 @item max-cse-path-length
9475
9476 The maximum number of basic blocks on path that CSE considers.
9477 The default is 10.
9478
9479 @item max-cse-insns
9480 The maximum number of instructions CSE processes before flushing.
9481 The default is 1000.
9482
9483 @item ggc-min-expand
9484
9485 GCC uses a garbage collector to manage its own memory allocation. This
9486 parameter specifies the minimum percentage by which the garbage
9487 collector's heap should be allowed to expand between collections.
9488 Tuning this may improve compilation speed; it has no effect on code
9489 generation.
9490
9491 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9492 RAM >= 1GB@. If @code{getrlimit} is available, the notion of ``RAM'' is
9493 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
9494 GCC is not able to calculate RAM on a particular platform, the lower
9495 bound of 30% is used. Setting this parameter and
9496 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9497 every opportunity. This is extremely slow, but can be useful for
9498 debugging.
9499
9500 @item ggc-min-heapsize
9501
9502 Minimum size of the garbage collector's heap before it begins bothering
9503 to collect garbage. The first collection occurs after the heap expands
9504 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
9505 tuning this may improve compilation speed, and has no effect on code
9506 generation.
9507
9508 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9509 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9510 with a lower bound of 4096 (four megabytes) and an upper bound of
9511 131072 (128 megabytes). If GCC is not able to calculate RAM on a
9512 particular platform, the lower bound is used. Setting this parameter
9513 very large effectively disables garbage collection. Setting this
9514 parameter and @option{ggc-min-expand} to zero causes a full collection
9515 to occur at every opportunity.
9516
9517 @item max-reload-search-insns
9518 The maximum number of instruction reload should look backward for equivalent
9519 register. Increasing values mean more aggressive optimization, making the
9520 compilation time increase with probably slightly better performance.
9521 The default value is 100.
9522
9523 @item max-cselib-memory-locations
9524 The maximum number of memory locations cselib should take into account.
9525 Increasing values mean more aggressive optimization, making the compilation time
9526 increase with probably slightly better performance. The default value is 500.
9527
9528 @item reorder-blocks-duplicate
9529 @itemx reorder-blocks-duplicate-feedback
9530
9531 Used by the basic block reordering pass to decide whether to use unconditional
9532 branch or duplicate the code on its destination. Code is duplicated when its
9533 estimated size is smaller than this value multiplied by the estimated size of
9534 unconditional jump in the hot spots of the program.
9535
9536 The @option{reorder-block-duplicate-feedback} is used only when profile
9537 feedback is available. It may be set to higher values than
9538 @option{reorder-block-duplicate} since information about the hot spots is more
9539 accurate.
9540
9541 @item max-sched-ready-insns
9542 The maximum number of instructions ready to be issued the scheduler should
9543 consider at any given time during the first scheduling pass. Increasing
9544 values mean more thorough searches, making the compilation time increase
9545 with probably little benefit. The default value is 100.
9546
9547 @item max-sched-region-blocks
9548 The maximum number of blocks in a region to be considered for
9549 interblock scheduling. The default value is 10.
9550
9551 @item max-pipeline-region-blocks
9552 The maximum number of blocks in a region to be considered for
9553 pipelining in the selective scheduler. The default value is 15.
9554
9555 @item max-sched-region-insns
9556 The maximum number of insns in a region to be considered for
9557 interblock scheduling. The default value is 100.
9558
9559 @item max-pipeline-region-insns
9560 The maximum number of insns in a region to be considered for
9561 pipelining in the selective scheduler. The default value is 200.
9562
9563 @item min-spec-prob
9564 The minimum probability (in percents) of reaching a source block
9565 for interblock speculative scheduling. The default value is 40.
9566
9567 @item max-sched-extend-regions-iters
9568 The maximum number of iterations through CFG to extend regions.
9569 A value of 0 (the default) disables region extensions.
9570
9571 @item max-sched-insn-conflict-delay
9572 The maximum conflict delay for an insn to be considered for speculative motion.
9573 The default value is 3.
9574
9575 @item sched-spec-prob-cutoff
9576 The minimal probability of speculation success (in percents), so that
9577 speculative insns are scheduled.
9578 The default value is 40.
9579
9580 @item sched-spec-state-edge-prob-cutoff
9581 The minimum probability an edge must have for the scheduler to save its
9582 state across it.
9583 The default value is 10.
9584
9585 @item sched-mem-true-dep-cost
9586 Minimal distance (in CPU cycles) between store and load targeting same
9587 memory locations. The default value is 1.
9588
9589 @item selsched-max-lookahead
9590 The maximum size of the lookahead window of selective scheduling. It is a
9591 depth of search for available instructions.
9592 The default value is 50.
9593
9594 @item selsched-max-sched-times
9595 The maximum number of times that an instruction is scheduled during
9596 selective scheduling. This is the limit on the number of iterations
9597 through which the instruction may be pipelined. The default value is 2.
9598
9599 @item selsched-max-insns-to-rename
9600 The maximum number of best instructions in the ready list that are considered
9601 for renaming in the selective scheduler. The default value is 2.
9602
9603 @item sms-min-sc
9604 The minimum value of stage count that swing modulo scheduler
9605 generates. The default value is 2.
9606
9607 @item max-last-value-rtl
9608 The maximum size measured as number of RTLs that can be recorded in an expression
9609 in combiner for a pseudo register as last known value of that register. The default
9610 is 10000.
9611
9612 @item integer-share-limit
9613 Small integer constants can use a shared data structure, reducing the
9614 compiler's memory usage and increasing its speed. This sets the maximum
9615 value of a shared integer constant. The default value is 256.
9616
9617 @item ssp-buffer-size
9618 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9619 protection when @option{-fstack-protection} is used.
9620
9621 @item max-jump-thread-duplication-stmts
9622 Maximum number of statements allowed in a block that needs to be
9623 duplicated when threading jumps.
9624
9625 @item max-fields-for-field-sensitive
9626 Maximum number of fields in a structure treated in
9627 a field sensitive manner during pointer analysis. The default is zero
9628 for @option{-O0} and @option{-O1},
9629 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9630
9631 @item prefetch-latency
9632 Estimate on average number of instructions that are executed before
9633 prefetch finishes. The distance prefetched ahead is proportional
9634 to this constant. Increasing this number may also lead to less
9635 streams being prefetched (see @option{simultaneous-prefetches}).
9636
9637 @item simultaneous-prefetches
9638 Maximum number of prefetches that can run at the same time.
9639
9640 @item l1-cache-line-size
9641 The size of cache line in L1 cache, in bytes.
9642
9643 @item l1-cache-size
9644 The size of L1 cache, in kilobytes.
9645
9646 @item l2-cache-size
9647 The size of L2 cache, in kilobytes.
9648
9649 @item min-insn-to-prefetch-ratio
9650 The minimum ratio between the number of instructions and the
9651 number of prefetches to enable prefetching in a loop.
9652
9653 @item prefetch-min-insn-to-mem-ratio
9654 The minimum ratio between the number of instructions and the
9655 number of memory references to enable prefetching in a loop.
9656
9657 @item use-canonical-types
9658 Whether the compiler should use the ``canonical'' type system. By
9659 default, this should always be 1, which uses a more efficient internal
9660 mechanism for comparing types in C++ and Objective-C++. However, if
9661 bugs in the canonical type system are causing compilation failures,
9662 set this value to 0 to disable canonical types.
9663
9664 @item switch-conversion-max-branch-ratio
9665 Switch initialization conversion refuses to create arrays that are
9666 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9667 branches in the switch.
9668
9669 @item max-partial-antic-length
9670 Maximum length of the partial antic set computed during the tree
9671 partial redundancy elimination optimization (@option{-ftree-pre}) when
9672 optimizing at @option{-O3} and above. For some sorts of source code
9673 the enhanced partial redundancy elimination optimization can run away,
9674 consuming all of the memory available on the host machine. This
9675 parameter sets a limit on the length of the sets that are computed,
9676 which prevents the runaway behavior. Setting a value of 0 for
9677 this parameter allows an unlimited set length.
9678
9679 @item sccvn-max-scc-size
9680 Maximum size of a strongly connected component (SCC) during SCCVN
9681 processing. If this limit is hit, SCCVN processing for the whole
9682 function is not done and optimizations depending on it are
9683 disabled. The default maximum SCC size is 10000.
9684
9685 @item sccvn-max-alias-queries-per-access
9686 Maximum number of alias-oracle queries we perform when looking for
9687 redundancies for loads and stores. If this limit is hit the search
9688 is aborted and the load or store is not considered redundant. The
9689 number of queries is algorithmically limited to the number of
9690 stores on all paths from the load to the function entry.
9691 The default maxmimum number of queries is 1000.
9692
9693 @item ira-max-loops-num
9694 IRA uses regional register allocation by default. If a function
9695 contains more loops than the number given by this parameter, only at most
9696 the given number of the most frequently-executed loops form regions
9697 for regional register allocation. The default value of the
9698 parameter is 100.
9699
9700 @item ira-max-conflict-table-size
9701 Although IRA uses a sophisticated algorithm to compress the conflict
9702 table, the table can still require excessive amounts of memory for
9703 huge functions. If the conflict table for a function could be more
9704 than the size in MB given by this parameter, the register allocator
9705 instead uses a faster, simpler, and lower-quality
9706 algorithm that does not require building a pseudo-register conflict table.
9707 The default value of the parameter is 2000.
9708
9709 @item ira-loop-reserved-regs
9710 IRA can be used to evaluate more accurate register pressure in loops
9711 for decisions to move loop invariants (see @option{-O3}). The number
9712 of available registers reserved for some other purposes is given
9713 by this parameter. The default value of the parameter is 2, which is
9714 the minimal number of registers needed by typical instructions.
9715 This value is the best found from numerous experiments.
9716
9717 @item loop-invariant-max-bbs-in-loop
9718 Loop invariant motion can be very expensive, both in compilation time and
9719 in amount of needed compile-time memory, with very large loops. Loops
9720 with more basic blocks than this parameter won't have loop invariant
9721 motion optimization performed on them. The default value of the
9722 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9723
9724 @item loop-max-datarefs-for-datadeps
9725 Building data dapendencies is expensive for very large loops. This
9726 parameter limits the number of data references in loops that are
9727 considered for data dependence analysis. These large loops are no
9728 handled by the optimizations using loop data dependencies.
9729 The default value is 1000.
9730
9731 @item max-vartrack-size
9732 Sets a maximum number of hash table slots to use during variable
9733 tracking dataflow analysis of any function. If this limit is exceeded
9734 with variable tracking at assignments enabled, analysis for that
9735 function is retried without it, after removing all debug insns from
9736 the function. If the limit is exceeded even without debug insns, var
9737 tracking analysis is completely disabled for the function. Setting
9738 the parameter to zero makes it unlimited.
9739
9740 @item max-vartrack-expr-depth
9741 Sets a maximum number of recursion levels when attempting to map
9742 variable names or debug temporaries to value expressions. This trades
9743 compilation time for more complete debug information. If this is set too
9744 low, value expressions that are available and could be represented in
9745 debug information may end up not being used; setting this higher may
9746 enable the compiler to find more complex debug expressions, but compile
9747 time and memory use may grow. The default is 12.
9748
9749 @item min-nondebug-insn-uid
9750 Use uids starting at this parameter for nondebug insns. The range below
9751 the parameter is reserved exclusively for debug insns created by
9752 @option{-fvar-tracking-assignments}, but debug insns may get
9753 (non-overlapping) uids above it if the reserved range is exhausted.
9754
9755 @item ipa-sra-ptr-growth-factor
9756 IPA-SRA replaces a pointer to an aggregate with one or more new
9757 parameters only when their cumulative size is less or equal to
9758 @option{ipa-sra-ptr-growth-factor} times the size of the original
9759 pointer parameter.
9760
9761 @item tm-max-aggregate-size
9762 When making copies of thread-local variables in a transaction, this
9763 parameter specifies the size in bytes after which variables are
9764 saved with the logging functions as opposed to save/restore code
9765 sequence pairs. This option only applies when using
9766 @option{-fgnu-tm}.
9767
9768 @item graphite-max-nb-scop-params
9769 To avoid exponential effects in the Graphite loop transforms, the
9770 number of parameters in a Static Control Part (SCoP) is bounded. The
9771 default value is 10 parameters. A variable whose value is unknown at
9772 compilation time and defined outside a SCoP is a parameter of the SCoP.
9773
9774 @item graphite-max-bbs-per-function
9775 To avoid exponential effects in the detection of SCoPs, the size of
9776 the functions analyzed by Graphite is bounded. The default value is
9777 100 basic blocks.
9778
9779 @item loop-block-tile-size
9780 Loop blocking or strip mining transforms, enabled with
9781 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9782 loop in the loop nest by a given number of iterations. The strip
9783 length can be changed using the @option{loop-block-tile-size}
9784 parameter. The default value is 51 iterations.
9785
9786 @item ipa-cp-value-list-size
9787 IPA-CP attempts to track all possible values and types passed to a function's
9788 parameter in order to propagate them and perform devirtualization.
9789 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9790 stores per one formal parameter of a function.
9791
9792 @item lto-partitions
9793 Specify desired number of partitions produced during WHOPR compilation.
9794 The number of partitions should exceed the number of CPUs used for compilation.
9795 The default value is 32.
9796
9797 @item lto-minpartition
9798 Size of minimal partition for WHOPR (in estimated instructions).
9799 This prevents expenses of splitting very small programs into too many
9800 partitions.
9801
9802 @item cxx-max-namespaces-for-diagnostic-help
9803 The maximum number of namespaces to consult for suggestions when C++
9804 name lookup fails for an identifier. The default is 1000.
9805
9806 @item sink-frequency-threshold
9807 The maximum relative execution frequency (in percents) of the target block
9808 relative to a statement's original block to allow statement sinking of a
9809 statement. Larger numbers result in more aggressive statement sinking.
9810 The default value is 75. A small positive adjustment is applied for
9811 statements with memory operands as those are even more profitable so sink.
9812
9813 @item max-stores-to-sink
9814 The maximum number of conditional stores paires that can be sunk. Set to 0
9815 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9816 (@option{-ftree-loop-if-convert}) is disabled. The default is 2.
9817
9818 @item allow-load-data-races
9819 Allow optimizers to introduce new data races on loads.
9820 Set to 1 to allow, otherwise to 0. This option is enabled by default
9821 unless implicitly set by the @option{-fmemory-model=} option.
9822
9823 @item allow-store-data-races
9824 Allow optimizers to introduce new data races on stores.
9825 Set to 1 to allow, otherwise to 0. This option is enabled by default
9826 unless implicitly set by the @option{-fmemory-model=} option.
9827
9828 @item allow-packed-load-data-races
9829 Allow optimizers to introduce new data races on packed data loads.
9830 Set to 1 to allow, otherwise to 0. This option is enabled by default
9831 unless implicitly set by the @option{-fmemory-model=} option.
9832
9833 @item allow-packed-store-data-races
9834 Allow optimizers to introduce new data races on packed data stores.
9835 Set to 1 to allow, otherwise to 0. This option is enabled by default
9836 unless implicitly set by the @option{-fmemory-model=} option.
9837
9838 @item case-values-threshold
9839 The smallest number of different values for which it is best to use a
9840 jump-table instead of a tree of conditional branches. If the value is
9841 0, use the default for the machine. The default is 0.
9842
9843 @item tree-reassoc-width
9844 Set the maximum number of instructions executed in parallel in
9845 reassociated tree. This parameter overrides target dependent
9846 heuristics used by default if has non zero value.
9847
9848 @item sched-pressure-algorithm
9849 Choose between the two available implementations of
9850 @option{-fsched-pressure}. Algorithm 1 is the original implementation
9851 and is the more likely to prevent instructions from being reordered.
9852 Algorithm 2 was designed to be a compromise between the relatively
9853 conservative approach taken by algorithm 1 and the rather aggressive
9854 approach taken by the default scheduler. It relies more heavily on
9855 having a regular register file and accurate register pressure classes.
9856 See @file{haifa-sched.c} in the GCC sources for more details.
9857
9858 The default choice depends on the target.
9859
9860 @item max-slsr-cand-scan
9861 Set the maximum number of existing candidates that will be considered when
9862 seeking a basis for a new straight-line strength reduction candidate.
9863
9864 @end table
9865 @end table
9866
9867 @node Preprocessor Options
9868 @section Options Controlling the Preprocessor
9869 @cindex preprocessor options
9870 @cindex options, preprocessor
9871
9872 These options control the C preprocessor, which is run on each C source
9873 file before actual compilation.
9874
9875 If you use the @option{-E} option, nothing is done except preprocessing.
9876 Some of these options make sense only together with @option{-E} because
9877 they cause the preprocessor output to be unsuitable for actual
9878 compilation.
9879
9880 @table @gcctabopt
9881 @item -Wp,@var{option}
9882 @opindex Wp
9883 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9884 and pass @var{option} directly through to the preprocessor. If
9885 @var{option} contains commas, it is split into multiple options at the
9886 commas. However, many options are modified, translated or interpreted
9887 by the compiler driver before being passed to the preprocessor, and
9888 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
9889 interface is undocumented and subject to change, so whenever possible
9890 you should avoid using @option{-Wp} and let the driver handle the
9891 options instead.
9892
9893 @item -Xpreprocessor @var{option}
9894 @opindex Xpreprocessor
9895 Pass @var{option} as an option to the preprocessor. You can use this to
9896 supply system-specific preprocessor options that GCC does not
9897 recognize.
9898
9899 If you want to pass an option that takes an argument, you must use
9900 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9901
9902 @item -no-integrated-cpp
9903 @opindex no-integrated-cpp
9904 Perform preprocessing as a separate pass before compilation.
9905 By default, GCC performs preprocessing as an integrated part of
9906 input tokenization and parsing.
9907 If this option is provided, the appropriate language front end
9908 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9909 and Objective-C, respectively) is instead invoked twice,
9910 once for preprocessing only and once for actual compilation
9911 of the preprocessed input.
9912 This option may be useful in conjunction with the @option{-B} or
9913 @option{-wrapper} options to specify an alternate preprocessor or
9914 perform additional processing of the program source between
9915 normal preprocessing and compilation.
9916 @end table
9917
9918 @include cppopts.texi
9919
9920 @node Assembler Options
9921 @section Passing Options to the Assembler
9922
9923 @c prevent bad page break with this line
9924 You can pass options to the assembler.
9925
9926 @table @gcctabopt
9927 @item -Wa,@var{option}
9928 @opindex Wa
9929 Pass @var{option} as an option to the assembler. If @var{option}
9930 contains commas, it is split into multiple options at the commas.
9931
9932 @item -Xassembler @var{option}
9933 @opindex Xassembler
9934 Pass @var{option} as an option to the assembler. You can use this to
9935 supply system-specific assembler options that GCC does not
9936 recognize.
9937
9938 If you want to pass an option that takes an argument, you must use
9939 @option{-Xassembler} twice, once for the option and once for the argument.
9940
9941 @end table
9942
9943 @node Link Options
9944 @section Options for Linking
9945 @cindex link options
9946 @cindex options, linking
9947
9948 These options come into play when the compiler links object files into
9949 an executable output file. They are meaningless if the compiler is
9950 not doing a link step.
9951
9952 @table @gcctabopt
9953 @cindex file names
9954 @item @var{object-file-name}
9955 A file name that does not end in a special recognized suffix is
9956 considered to name an object file or library. (Object files are
9957 distinguished from libraries by the linker according to the file
9958 contents.) If linking is done, these object files are used as input
9959 to the linker.
9960
9961 @item -c
9962 @itemx -S
9963 @itemx -E
9964 @opindex c
9965 @opindex S
9966 @opindex E
9967 If any of these options is used, then the linker is not run, and
9968 object file names should not be used as arguments. @xref{Overall
9969 Options}.
9970
9971 @cindex Libraries
9972 @item -l@var{library}
9973 @itemx -l @var{library}
9974 @opindex l
9975 Search the library named @var{library} when linking. (The second
9976 alternative with the library as a separate argument is only for
9977 POSIX compliance and is not recommended.)
9978
9979 It makes a difference where in the command you write this option; the
9980 linker searches and processes libraries and object files in the order they
9981 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9982 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
9983 to functions in @samp{z}, those functions may not be loaded.
9984
9985 The linker searches a standard list of directories for the library,
9986 which is actually a file named @file{lib@var{library}.a}. The linker
9987 then uses this file as if it had been specified precisely by name.
9988
9989 The directories searched include several standard system directories
9990 plus any that you specify with @option{-L}.
9991
9992 Normally the files found this way are library files---archive files
9993 whose members are object files. The linker handles an archive file by
9994 scanning through it for members which define symbols that have so far
9995 been referenced but not defined. But if the file that is found is an
9996 ordinary object file, it is linked in the usual fashion. The only
9997 difference between using an @option{-l} option and specifying a file name
9998 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9999 and searches several directories.
10000
10001 @item -lobjc
10002 @opindex lobjc
10003 You need this special case of the @option{-l} option in order to
10004 link an Objective-C or Objective-C++ program.
10005
10006 @item -nostartfiles
10007 @opindex nostartfiles
10008 Do not use the standard system startup files when linking.
10009 The standard system libraries are used normally, unless @option{-nostdlib}
10010 or @option{-nodefaultlibs} is used.
10011
10012 @item -nodefaultlibs
10013 @opindex nodefaultlibs
10014 Do not use the standard system libraries when linking.
10015 Only the libraries you specify are passed to the linker, and options
10016 specifying linkage of the system libraries, such as @code{-static-libgcc}
10017 or @code{-shared-libgcc}, are ignored.
10018 The standard startup files are used normally, unless @option{-nostartfiles}
10019 is used.
10020
10021 The compiler may generate calls to @code{memcmp},
10022 @code{memset}, @code{memcpy} and @code{memmove}.
10023 These entries are usually resolved by entries in
10024 libc. These entry points should be supplied through some other
10025 mechanism when this option is specified.
10026
10027 @item -nostdlib
10028 @opindex nostdlib
10029 Do not use the standard system startup files or libraries when linking.
10030 No startup files and only the libraries you specify are passed to
10031 the linker, and options specifying linkage of the system libraries, such as
10032 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10033
10034 The compiler may generate calls to @code{memcmp}, @code{memset},
10035 @code{memcpy} and @code{memmove}.
10036 These entries are usually resolved by entries in
10037 libc. These entry points should be supplied through some other
10038 mechanism when this option is specified.
10039
10040 @cindex @option{-lgcc}, use with @option{-nostdlib}
10041 @cindex @option{-nostdlib} and unresolved references
10042 @cindex unresolved references and @option{-nostdlib}
10043 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10044 @cindex @option{-nodefaultlibs} and unresolved references
10045 @cindex unresolved references and @option{-nodefaultlibs}
10046 One of the standard libraries bypassed by @option{-nostdlib} and
10047 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10048 which GCC uses to overcome shortcomings of particular machines, or special
10049 needs for some languages.
10050 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10051 Collection (GCC) Internals},
10052 for more discussion of @file{libgcc.a}.)
10053 In most cases, you need @file{libgcc.a} even when you want to avoid
10054 other standard libraries. In other words, when you specify @option{-nostdlib}
10055 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10056 This ensures that you have no unresolved references to internal GCC
10057 library subroutines.
10058 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10059 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10060 GNU Compiler Collection (GCC) Internals}.)
10061
10062 @item -pie
10063 @opindex pie
10064 Produce a position independent executable on targets that support it.
10065 For predictable results, you must also specify the same set of options
10066 used for compilation (@option{-fpie}, @option{-fPIE},
10067 or model suboptions) when you specify this linker option.
10068
10069 @item -rdynamic
10070 @opindex rdynamic
10071 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10072 that support it. This instructs the linker to add all symbols, not
10073 only used ones, to the dynamic symbol table. This option is needed
10074 for some uses of @code{dlopen} or to allow obtaining backtraces
10075 from within a program.
10076
10077 @item -s
10078 @opindex s
10079 Remove all symbol table and relocation information from the executable.
10080
10081 @item -static
10082 @opindex static
10083 On systems that support dynamic linking, this prevents linking with the shared
10084 libraries. On other systems, this option has no effect.
10085
10086 @item -shared
10087 @opindex shared
10088 Produce a shared object which can then be linked with other objects to
10089 form an executable. Not all systems support this option. For predictable
10090 results, you must also specify the same set of options used for compilation
10091 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10092 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10093 needs to build supplementary stub code for constructors to work. On
10094 multi-libbed systems, @samp{gcc -shared} must select the correct support
10095 libraries to link against. Failing to supply the correct flags may lead
10096 to subtle defects. Supplying them in cases where they are not necessary
10097 is innocuous.}
10098
10099 @item -shared-libgcc
10100 @itemx -static-libgcc
10101 @opindex shared-libgcc
10102 @opindex static-libgcc
10103 On systems that provide @file{libgcc} as a shared library, these options
10104 force the use of either the shared or static version, respectively.
10105 If no shared version of @file{libgcc} was built when the compiler was
10106 configured, these options have no effect.
10107
10108 There are several situations in which an application should use the
10109 shared @file{libgcc} instead of the static version. The most common
10110 of these is when the application wishes to throw and catch exceptions
10111 across different shared libraries. In that case, each of the libraries
10112 as well as the application itself should use the shared @file{libgcc}.
10113
10114 Therefore, the G++ and GCJ drivers automatically add
10115 @option{-shared-libgcc} whenever you build a shared library or a main
10116 executable, because C++ and Java programs typically use exceptions, so
10117 this is the right thing to do.
10118
10119 If, instead, you use the GCC driver to create shared libraries, you may
10120 find that they are not always linked with the shared @file{libgcc}.
10121 If GCC finds, at its configuration time, that you have a non-GNU linker
10122 or a GNU linker that does not support option @option{--eh-frame-hdr},
10123 it links the shared version of @file{libgcc} into shared libraries
10124 by default. Otherwise, it takes advantage of the linker and optimizes
10125 away the linking with the shared version of @file{libgcc}, linking with
10126 the static version of libgcc by default. This allows exceptions to
10127 propagate through such shared libraries, without incurring relocation
10128 costs at library load time.
10129
10130 However, if a library or main executable is supposed to throw or catch
10131 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10132 for the languages used in the program, or using the option
10133 @option{-shared-libgcc}, such that it is linked with the shared
10134 @file{libgcc}.
10135
10136 @item -static-libasan
10137 When the @option{-fsanitize=address} option is used to link a program,
10138 the GCC driver automatically links against @option{libasan}. If
10139 @file{libasan} is available as a shared library, and the @option{-static}
10140 option is not used, then this links against the shared version of
10141 @file{libasan}. The @option{-static-libasan} option directs the GCC
10142 driver to link @file{libasan} statically, without necessarily linking
10143 other libraries statically.
10144
10145 @item -static-libtsan
10146 When the @option{-fsanitize=thread} option is used to link a program,
10147 the GCC driver automatically links against @option{libtsan}. If
10148 @file{libtsan} is available as a shared library, and the @option{-static}
10149 option is not used, then this links against the shared version of
10150 @file{libtsan}. The @option{-static-libtsan} option directs the GCC
10151 driver to link @file{libtsan} statically, without necessarily linking
10152 other libraries statically.
10153
10154 @item -static-libstdc++
10155 When the @command{g++} program is used to link a C++ program, it
10156 normally automatically links against @option{libstdc++}. If
10157 @file{libstdc++} is available as a shared library, and the
10158 @option{-static} option is not used, then this links against the
10159 shared version of @file{libstdc++}. That is normally fine. However, it
10160 is sometimes useful to freeze the version of @file{libstdc++} used by
10161 the program without going all the way to a fully static link. The
10162 @option{-static-libstdc++} option directs the @command{g++} driver to
10163 link @file{libstdc++} statically, without necessarily linking other
10164 libraries statically.
10165
10166 @item -symbolic
10167 @opindex symbolic
10168 Bind references to global symbols when building a shared object. Warn
10169 about any unresolved references (unless overridden by the link editor
10170 option @option{-Xlinker -z -Xlinker defs}). Only a few systems support
10171 this option.
10172
10173 @item -T @var{script}
10174 @opindex T
10175 @cindex linker script
10176 Use @var{script} as the linker script. This option is supported by most
10177 systems using the GNU linker. On some targets, such as bare-board
10178 targets without an operating system, the @option{-T} option may be required
10179 when linking to avoid references to undefined symbols.
10180
10181 @item -Xlinker @var{option}
10182 @opindex Xlinker
10183 Pass @var{option} as an option to the linker. You can use this to
10184 supply system-specific linker options that GCC does not recognize.
10185
10186 If you want to pass an option that takes a separate argument, you must use
10187 @option{-Xlinker} twice, once for the option and once for the argument.
10188 For example, to pass @option{-assert definitions}, you must write
10189 @option{-Xlinker -assert -Xlinker definitions}. It does not work to write
10190 @option{-Xlinker "-assert definitions"}, because this passes the entire
10191 string as a single argument, which is not what the linker expects.
10192
10193 When using the GNU linker, it is usually more convenient to pass
10194 arguments to linker options using the @option{@var{option}=@var{value}}
10195 syntax than as separate arguments. For example, you can specify
10196 @option{-Xlinker -Map=output.map} rather than
10197 @option{-Xlinker -Map -Xlinker output.map}. Other linkers may not support
10198 this syntax for command-line options.
10199
10200 @item -Wl,@var{option}
10201 @opindex Wl
10202 Pass @var{option} as an option to the linker. If @var{option} contains
10203 commas, it is split into multiple options at the commas. You can use this
10204 syntax to pass an argument to the option.
10205 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10206 linker. When using the GNU linker, you can also get the same effect with
10207 @option{-Wl,-Map=output.map}.
10208
10209 @item -u @var{symbol}
10210 @opindex u
10211 Pretend the symbol @var{symbol} is undefined, to force linking of
10212 library modules to define it. You can use @option{-u} multiple times with
10213 different symbols to force loading of additional library modules.
10214 @end table
10215
10216 @node Directory Options
10217 @section Options for Directory Search
10218 @cindex directory options
10219 @cindex options, directory search
10220 @cindex search path
10221
10222 These options specify directories to search for header files, for
10223 libraries and for parts of the compiler:
10224
10225 @table @gcctabopt
10226 @item -I@var{dir}
10227 @opindex I
10228 Add the directory @var{dir} to the head of the list of directories to be
10229 searched for header files. This can be used to override a system header
10230 file, substituting your own version, since these directories are
10231 searched before the system header file directories. However, you should
10232 not use this option to add directories that contain vendor-supplied
10233 system header files (use @option{-isystem} for that). If you use more than
10234 one @option{-I} option, the directories are scanned in left-to-right
10235 order; the standard system directories come after.
10236
10237 If a standard system include directory, or a directory specified with
10238 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10239 option is ignored. The directory is still searched but as a
10240 system directory at its normal position in the system include chain.
10241 This is to ensure that GCC's procedure to fix buggy system headers and
10242 the ordering for the @code{include_next} directive are not inadvertently changed.
10243 If you really need to change the search order for system directories,
10244 use the @option{-nostdinc} and/or @option{-isystem} options.
10245
10246 @item -iplugindir=@var{dir}
10247 Set the directory to search for plugins that are passed
10248 by @option{-fplugin=@var{name}} instead of
10249 @option{-fplugin=@var{path}/@var{name}.so}. This option is not meant
10250 to be used by the user, but only passed by the driver.
10251
10252 @item -iquote@var{dir}
10253 @opindex iquote
10254 Add the directory @var{dir} to the head of the list of directories to
10255 be searched for header files only for the case of @samp{#include
10256 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10257 otherwise just like @option{-I}.
10258
10259 @item -L@var{dir}
10260 @opindex L
10261 Add directory @var{dir} to the list of directories to be searched
10262 for @option{-l}.
10263
10264 @item -B@var{prefix}
10265 @opindex B
10266 This option specifies where to find the executables, libraries,
10267 include files, and data files of the compiler itself.
10268
10269 The compiler driver program runs one or more of the subprograms
10270 @command{cpp}, @command{cc1}, @command{as} and @command{ld}. It tries
10271 @var{prefix} as a prefix for each program it tries to run, both with and
10272 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10273
10274 For each subprogram to be run, the compiler driver first tries the
10275 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
10276 is not specified, the driver tries two standard prefixes,
10277 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
10278 those results in a file name that is found, the unmodified program
10279 name is searched for using the directories specified in your
10280 @env{PATH} environment variable.
10281
10282 The compiler checks to see if the path provided by the @option{-B}
10283 refers to a directory, and if necessary it adds a directory
10284 separator character at the end of the path.
10285
10286 @option{-B} prefixes that effectively specify directory names also apply
10287 to libraries in the linker, because the compiler translates these
10288 options into @option{-L} options for the linker. They also apply to
10289 includes files in the preprocessor, because the compiler translates these
10290 options into @option{-isystem} options for the preprocessor. In this case,
10291 the compiler appends @samp{include} to the prefix.
10292
10293 The runtime support file @file{libgcc.a} can also be searched for using
10294 the @option{-B} prefix, if needed. If it is not found there, the two
10295 standard prefixes above are tried, and that is all. The file is left
10296 out of the link if it is not found by those means.
10297
10298 Another way to specify a prefix much like the @option{-B} prefix is to use
10299 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
10300 Variables}.
10301
10302 As a special kludge, if the path provided by @option{-B} is
10303 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10304 9, then it is replaced by @file{[dir/]include}. This is to help
10305 with boot-strapping the compiler.
10306
10307 @item -specs=@var{file}
10308 @opindex specs
10309 Process @var{file} after the compiler reads in the standard @file{specs}
10310 file, in order to override the defaults which the @command{gcc} driver
10311 program uses when determining what switches to pass to @command{cc1},
10312 @command{cc1plus}, @command{as}, @command{ld}, etc. More than one
10313 @option{-specs=@var{file}} can be specified on the command line, and they
10314 are processed in order, from left to right.
10315
10316 @item --sysroot=@var{dir}
10317 @opindex sysroot
10318 Use @var{dir} as the logical root directory for headers and libraries.
10319 For example, if the compiler normally searches for headers in
10320 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10321 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10322
10323 If you use both this option and the @option{-isysroot} option, then
10324 the @option{--sysroot} option applies to libraries, but the
10325 @option{-isysroot} option applies to header files.
10326
10327 The GNU linker (beginning with version 2.16) has the necessary support
10328 for this option. If your linker does not support this option, the
10329 header file aspect of @option{--sysroot} still works, but the
10330 library aspect does not.
10331
10332 @item --no-sysroot-suffix
10333 @opindex no-sysroot-suffix
10334 For some targets, a suffix is added to the root directory specified
10335 with @option{--sysroot}, depending on the other options used, so that
10336 headers may for example be found in
10337 @file{@var{dir}/@var{suffix}/usr/include} instead of
10338 @file{@var{dir}/usr/include}. This option disables the addition of
10339 such a suffix.
10340
10341 @item -I-
10342 @opindex I-
10343 This option has been deprecated. Please use @option{-iquote} instead for
10344 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10345 Any directories you specify with @option{-I} options before the @option{-I-}
10346 option are searched only for the case of @samp{#include "@var{file}"};
10347 they are not searched for @samp{#include <@var{file}>}.
10348
10349 If additional directories are specified with @option{-I} options after
10350 the @option{-I-}, these directories are searched for all @samp{#include}
10351 directives. (Ordinarily @emph{all} @option{-I} directories are used
10352 this way.)
10353
10354 In addition, the @option{-I-} option inhibits the use of the current
10355 directory (where the current input file came from) as the first search
10356 directory for @samp{#include "@var{file}"}. There is no way to
10357 override this effect of @option{-I-}. With @option{-I.} you can specify
10358 searching the directory that is current when the compiler is
10359 invoked. That is not exactly the same as what the preprocessor does
10360 by default, but it is often satisfactory.
10361
10362 @option{-I-} does not inhibit the use of the standard system directories
10363 for header files. Thus, @option{-I-} and @option{-nostdinc} are
10364 independent.
10365 @end table
10366
10367 @c man end
10368
10369 @node Spec Files
10370 @section Specifying subprocesses and the switches to pass to them
10371 @cindex Spec Files
10372
10373 @command{gcc} is a driver program. It performs its job by invoking a
10374 sequence of other programs to do the work of compiling, assembling and
10375 linking. GCC interprets its command-line parameters and uses these to
10376 deduce which programs it should invoke, and which command-line options
10377 it ought to place on their command lines. This behavior is controlled
10378 by @dfn{spec strings}. In most cases there is one spec string for each
10379 program that GCC can invoke, but a few programs have multiple spec
10380 strings to control their behavior. The spec strings built into GCC can
10381 be overridden by using the @option{-specs=} command-line switch to specify
10382 a spec file.
10383
10384 @dfn{Spec files} are plaintext files that are used to construct spec
10385 strings. They consist of a sequence of directives separated by blank
10386 lines. The type of directive is determined by the first non-whitespace
10387 character on the line, which can be one of the following:
10388
10389 @table @code
10390 @item %@var{command}
10391 Issues a @var{command} to the spec file processor. The commands that can
10392 appear here are:
10393
10394 @table @code
10395 @item %include <@var{file}>
10396 @cindex @code{%include}
10397 Search for @var{file} and insert its text at the current point in the
10398 specs file.
10399
10400 @item %include_noerr <@var{file}>
10401 @cindex @code{%include_noerr}
10402 Just like @samp{%include}, but do not generate an error message if the include
10403 file cannot be found.
10404
10405 @item %rename @var{old_name} @var{new_name}
10406 @cindex @code{%rename}
10407 Rename the spec string @var{old_name} to @var{new_name}.
10408
10409 @end table
10410
10411 @item *[@var{spec_name}]:
10412 This tells the compiler to create, override or delete the named spec
10413 string. All lines after this directive up to the next directive or
10414 blank line are considered to be the text for the spec string. If this
10415 results in an empty string then the spec is deleted. (Or, if the
10416 spec did not exist, then nothing happens.) Otherwise, if the spec
10417 does not currently exist a new spec is created. If the spec does
10418 exist then its contents are overridden by the text of this
10419 directive, unless the first character of that text is the @samp{+}
10420 character, in which case the text is appended to the spec.
10421
10422 @item [@var{suffix}]:
10423 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
10424 and up to the next directive or blank line are considered to make up the
10425 spec string for the indicated suffix. When the compiler encounters an
10426 input file with the named suffix, it processes the spec string in
10427 order to work out how to compile that file. For example:
10428
10429 @smallexample
10430 .ZZ:
10431 z-compile -input %i
10432 @end smallexample
10433
10434 This says that any input file whose name ends in @samp{.ZZ} should be
10435 passed to the program @samp{z-compile}, which should be invoked with the
10436 command-line switch @option{-input} and with the result of performing the
10437 @samp{%i} substitution. (See below.)
10438
10439 As an alternative to providing a spec string, the text following a
10440 suffix directive can be one of the following:
10441
10442 @table @code
10443 @item @@@var{language}
10444 This says that the suffix is an alias for a known @var{language}. This is
10445 similar to using the @option{-x} command-line switch to GCC to specify a
10446 language explicitly. For example:
10447
10448 @smallexample
10449 .ZZ:
10450 @@c++
10451 @end smallexample
10452
10453 Says that .ZZ files are, in fact, C++ source files.
10454
10455 @item #@var{name}
10456 This causes an error messages saying:
10457
10458 @smallexample
10459 @var{name} compiler not installed on this system.
10460 @end smallexample
10461 @end table
10462
10463 GCC already has an extensive list of suffixes built into it.
10464 This directive adds an entry to the end of the list of suffixes, but
10465 since the list is searched from the end backwards, it is effectively
10466 possible to override earlier entries using this technique.
10467
10468 @end table
10469
10470 GCC has the following spec strings built into it. Spec files can
10471 override these strings or create their own. Note that individual
10472 targets can also add their own spec strings to this list.
10473
10474 @smallexample
10475 asm Options to pass to the assembler
10476 asm_final Options to pass to the assembler post-processor
10477 cpp Options to pass to the C preprocessor
10478 cc1 Options to pass to the C compiler
10479 cc1plus Options to pass to the C++ compiler
10480 endfile Object files to include at the end of the link
10481 link Options to pass to the linker
10482 lib Libraries to include on the command line to the linker
10483 libgcc Decides which GCC support library to pass to the linker
10484 linker Sets the name of the linker
10485 predefines Defines to be passed to the C preprocessor
10486 signed_char Defines to pass to CPP to say whether @code{char} is signed
10487 by default
10488 startfile Object files to include at the start of the link
10489 @end smallexample
10490
10491 Here is a small example of a spec file:
10492
10493 @smallexample
10494 %rename lib old_lib
10495
10496 *lib:
10497 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10498 @end smallexample
10499
10500 This example renames the spec called @samp{lib} to @samp{old_lib} and
10501 then overrides the previous definition of @samp{lib} with a new one.
10502 The new definition adds in some extra command-line options before
10503 including the text of the old definition.
10504
10505 @dfn{Spec strings} are a list of command-line options to be passed to their
10506 corresponding program. In addition, the spec strings can contain
10507 @samp{%}-prefixed sequences to substitute variable text or to
10508 conditionally insert text into the command line. Using these constructs
10509 it is possible to generate quite complex command lines.
10510
10511 Here is a table of all defined @samp{%}-sequences for spec
10512 strings. Note that spaces are not generated automatically around the
10513 results of expanding these sequences. Therefore you can concatenate them
10514 together or combine them with constant text in a single argument.
10515
10516 @table @code
10517 @item %%
10518 Substitute one @samp{%} into the program name or argument.
10519
10520 @item %i
10521 Substitute the name of the input file being processed.
10522
10523 @item %b
10524 Substitute the basename of the input file being processed.
10525 This is the substring up to (and not including) the last period
10526 and not including the directory.
10527
10528 @item %B
10529 This is the same as @samp{%b}, but include the file suffix (text after
10530 the last period).
10531
10532 @item %d
10533 Marks the argument containing or following the @samp{%d} as a
10534 temporary file name, so that that file is deleted if GCC exits
10535 successfully. Unlike @samp{%g}, this contributes no text to the
10536 argument.
10537
10538 @item %g@var{suffix}
10539 Substitute a file name that has suffix @var{suffix} and is chosen
10540 once per compilation, and mark the argument in the same way as
10541 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
10542 name is now chosen in a way that is hard to predict even when previously
10543 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10544 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
10545 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10546 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
10547 was simply substituted with a file name chosen once per compilation,
10548 without regard to any appended suffix (which was therefore treated
10549 just like ordinary text), making such attacks more likely to succeed.
10550
10551 @item %u@var{suffix}
10552 Like @samp{%g}, but generates a new temporary file name
10553 each time it appears instead of once per compilation.
10554
10555 @item %U@var{suffix}
10556 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10557 new one if there is no such last file name. In the absence of any
10558 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10559 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10560 involves the generation of two distinct file names, one
10561 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
10562 simply substituted with a file name chosen for the previous @samp{%u},
10563 without regard to any appended suffix.
10564
10565 @item %j@var{suffix}
10566 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10567 writable, and if @option{-save-temps} is not used;
10568 otherwise, substitute the name
10569 of a temporary file, just like @samp{%u}. This temporary file is not
10570 meant for communication between processes, but rather as a junk
10571 disposal mechanism.
10572
10573 @item %|@var{suffix}
10574 @itemx %m@var{suffix}
10575 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
10576 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10577 all. These are the two most common ways to instruct a program that it
10578 should read from standard input or write to standard output. If you
10579 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10580 construct: see for example @file{f/lang-specs.h}.
10581
10582 @item %.@var{SUFFIX}
10583 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10584 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
10585 terminated by the next space or %.
10586
10587 @item %w
10588 Marks the argument containing or following the @samp{%w} as the
10589 designated output file of this compilation. This puts the argument
10590 into the sequence of arguments that @samp{%o} substitutes.
10591
10592 @item %o
10593 Substitutes the names of all the output files, with spaces
10594 automatically placed around them. You should write spaces
10595 around the @samp{%o} as well or the results are undefined.
10596 @samp{%o} is for use in the specs for running the linker.
10597 Input files whose names have no recognized suffix are not compiled
10598 at all, but they are included among the output files, so they are
10599 linked.
10600
10601 @item %O
10602 Substitutes the suffix for object files. Note that this is
10603 handled specially when it immediately follows @samp{%g, %u, or %U},
10604 because of the need for those to form complete file names. The
10605 handling is such that @samp{%O} is treated exactly as if it had already
10606 been substituted, except that @samp{%g, %u, and %U} do not currently
10607 support additional @var{suffix} characters following @samp{%O} as they do
10608 following, for example, @samp{.o}.
10609
10610 @item %p
10611 Substitutes the standard macro predefinitions for the
10612 current target machine. Use this when running @code{cpp}.
10613
10614 @item %P
10615 Like @samp{%p}, but puts @samp{__} before and after the name of each
10616 predefined macro, except for macros that start with @samp{__} or with
10617 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
10618 C@.
10619
10620 @item %I
10621 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10622 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10623 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10624 and @option{-imultilib} as necessary.
10625
10626 @item %s
10627 Current argument is the name of a library or startup file of some sort.
10628 Search for that file in a standard list of directories and substitute
10629 the full name found. The current working directory is included in the
10630 list of directories scanned.
10631
10632 @item %T
10633 Current argument is the name of a linker script. Search for that file
10634 in the current list of directories to scan for libraries. If the file
10635 is located insert a @option{--script} option into the command line
10636 followed by the full path name found. If the file is not found then
10637 generate an error message. Note: the current working directory is not
10638 searched.
10639
10640 @item %e@var{str}
10641 Print @var{str} as an error message. @var{str} is terminated by a newline.
10642 Use this when inconsistent options are detected.
10643
10644 @item %(@var{name})
10645 Substitute the contents of spec string @var{name} at this point.
10646
10647 @item %x@{@var{option}@}
10648 Accumulate an option for @samp{%X}.
10649
10650 @item %X
10651 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10652 spec string.
10653
10654 @item %Y
10655 Output the accumulated assembler options specified by @option{-Wa}.
10656
10657 @item %Z
10658 Output the accumulated preprocessor options specified by @option{-Wp}.
10659
10660 @item %a
10661 Process the @code{asm} spec. This is used to compute the
10662 switches to be passed to the assembler.
10663
10664 @item %A
10665 Process the @code{asm_final} spec. This is a spec string for
10666 passing switches to an assembler post-processor, if such a program is
10667 needed.
10668
10669 @item %l
10670 Process the @code{link} spec. This is the spec for computing the
10671 command line passed to the linker. Typically it makes use of the
10672 @samp{%L %G %S %D and %E} sequences.
10673
10674 @item %D
10675 Dump out a @option{-L} option for each directory that GCC believes might
10676 contain startup files. If the target supports multilibs then the
10677 current multilib directory is prepended to each of these paths.
10678
10679 @item %L
10680 Process the @code{lib} spec. This is a spec string for deciding which
10681 libraries are included on the command line to the linker.
10682
10683 @item %G
10684 Process the @code{libgcc} spec. This is a spec string for deciding
10685 which GCC support library is included on the command line to the linker.
10686
10687 @item %S
10688 Process the @code{startfile} spec. This is a spec for deciding which
10689 object files are the first ones passed to the linker. Typically
10690 this might be a file named @file{crt0.o}.
10691
10692 @item %E
10693 Process the @code{endfile} spec. This is a spec string that specifies
10694 the last object files that are passed to the linker.
10695
10696 @item %C
10697 Process the @code{cpp} spec. This is used to construct the arguments
10698 to be passed to the C preprocessor.
10699
10700 @item %1
10701 Process the @code{cc1} spec. This is used to construct the options to be
10702 passed to the actual C compiler (@samp{cc1}).
10703
10704 @item %2
10705 Process the @code{cc1plus} spec. This is used to construct the options to be
10706 passed to the actual C++ compiler (@samp{cc1plus}).
10707
10708 @item %*
10709 Substitute the variable part of a matched option. See below.
10710 Note that each comma in the substituted string is replaced by
10711 a single space.
10712
10713 @item %<@code{S}
10714 Remove all occurrences of @code{-S} from the command line. Note---this
10715 command is position dependent. @samp{%} commands in the spec string
10716 before this one see @code{-S}, @samp{%} commands in the spec string
10717 after this one do not.
10718
10719 @item %:@var{function}(@var{args})
10720 Call the named function @var{function}, passing it @var{args}.
10721 @var{args} is first processed as a nested spec string, then split
10722 into an argument vector in the usual fashion. The function returns
10723 a string which is processed as if it had appeared literally as part
10724 of the current spec.
10725
10726 The following built-in spec functions are provided:
10727
10728 @table @code
10729 @item @code{getenv}
10730 The @code{getenv} spec function takes two arguments: an environment
10731 variable name and a string. If the environment variable is not
10732 defined, a fatal error is issued. Otherwise, the return value is the
10733 value of the environment variable concatenated with the string. For
10734 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10735
10736 @smallexample
10737 %:getenv(TOPDIR /include)
10738 @end smallexample
10739
10740 expands to @file{/path/to/top/include}.
10741
10742 @item @code{if-exists}
10743 The @code{if-exists} spec function takes one argument, an absolute
10744 pathname to a file. If the file exists, @code{if-exists} returns the
10745 pathname. Here is a small example of its usage:
10746
10747 @smallexample
10748 *startfile:
10749 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10750 @end smallexample
10751
10752 @item @code{if-exists-else}
10753 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10754 spec function, except that it takes two arguments. The first argument is
10755 an absolute pathname to a file. If the file exists, @code{if-exists-else}
10756 returns the pathname. If it does not exist, it returns the second argument.
10757 This way, @code{if-exists-else} can be used to select one file or another,
10758 based on the existence of the first. Here is a small example of its usage:
10759
10760 @smallexample
10761 *startfile:
10762 crt0%O%s %:if-exists(crti%O%s) \
10763 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10764 @end smallexample
10765
10766 @item @code{replace-outfile}
10767 The @code{replace-outfile} spec function takes two arguments. It looks for the
10768 first argument in the outfiles array and replaces it with the second argument. Here
10769 is a small example of its usage:
10770
10771 @smallexample
10772 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10773 @end smallexample
10774
10775 @item @code{remove-outfile}
10776 The @code{remove-outfile} spec function takes one argument. It looks for the
10777 first argument in the outfiles array and removes it. Here is a small example
10778 its usage:
10779
10780 @smallexample
10781 %:remove-outfile(-lm)
10782 @end smallexample
10783
10784 @item @code{pass-through-libs}
10785 The @code{pass-through-libs} spec function takes any number of arguments. It
10786 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10787 assumes are the names of linker input library archive files) and returns a
10788 result containing all the found arguments each prepended by
10789 @option{-plugin-opt=-pass-through=} and joined by spaces. This list is
10790 intended to be passed to the LTO linker plugin.
10791
10792 @smallexample
10793 %:pass-through-libs(%G %L %G)
10794 @end smallexample
10795
10796 @item @code{print-asm-header}
10797 The @code{print-asm-header} function takes no arguments and simply
10798 prints a banner like:
10799
10800 @smallexample
10801 Assembler options
10802 =================
10803
10804 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10805 @end smallexample
10806
10807 It is used to separate compiler options from assembler options
10808 in the @option{--target-help} output.
10809 @end table
10810
10811 @item %@{@code{S}@}
10812 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10813 If that switch is not specified, this substitutes nothing. Note that
10814 the leading dash is omitted when specifying this option, and it is
10815 automatically inserted if the substitution is performed. Thus the spec
10816 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10817 and outputs the command-line option @option{-foo}.
10818
10819 @item %W@{@code{S}@}
10820 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10821 deleted on failure.
10822
10823 @item %@{@code{S}*@}
10824 Substitutes all the switches specified to GCC whose names start
10825 with @code{-S}, but which also take an argument. This is used for
10826 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10827 GCC considers @option{-o foo} as being
10828 one switch whose name starts with @samp{o}. %@{o*@} substitutes this
10829 text, including the space. Thus two arguments are generated.
10830
10831 @item %@{@code{S}*&@code{T}*@}
10832 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10833 (the order of @code{S} and @code{T} in the spec is not significant).
10834 There can be any number of ampersand-separated variables; for each the
10835 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
10836
10837 @item %@{@code{S}:@code{X}@}
10838 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10839
10840 @item %@{!@code{S}:@code{X}@}
10841 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10842
10843 @item %@{@code{S}*:@code{X}@}
10844 Substitutes @code{X} if one or more switches whose names start with
10845 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
10846 once, no matter how many such switches appeared. However, if @code{%*}
10847 appears somewhere in @code{X}, then @code{X} is substituted once
10848 for each matching switch, with the @code{%*} replaced by the part of
10849 that switch matching the @code{*}.
10850
10851 @item %@{.@code{S}:@code{X}@}
10852 Substitutes @code{X}, if processing a file with suffix @code{S}.
10853
10854 @item %@{!.@code{S}:@code{X}@}
10855 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10856
10857 @item %@{,@code{S}:@code{X}@}
10858 Substitutes @code{X}, if processing a file for language @code{S}.
10859
10860 @item %@{!,@code{S}:@code{X}@}
10861 Substitutes @code{X}, if not processing a file for language @code{S}.
10862
10863 @item %@{@code{S}|@code{P}:@code{X}@}
10864 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10865 GCC@. This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10866 @code{*} sequences as well, although they have a stronger binding than
10867 the @samp{|}. If @code{%*} appears in @code{X}, all of the
10868 alternatives must be starred, and only the first matching alternative
10869 is substituted.
10870
10871 For example, a spec string like this:
10872
10873 @smallexample
10874 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10875 @end smallexample
10876
10877 @noindent
10878 outputs the following command-line options from the following input
10879 command-line options:
10880
10881 @smallexample
10882 fred.c -foo -baz
10883 jim.d -bar -boggle
10884 -d fred.c -foo -baz -boggle
10885 -d jim.d -bar -baz -boggle
10886 @end smallexample
10887
10888 @item %@{S:X; T:Y; :D@}
10889
10890 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10891 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
10892 be as many clauses as you need. This may be combined with @code{.},
10893 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10894
10895
10896 @end table
10897
10898 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10899 construct may contain other nested @samp{%} constructs or spaces, or
10900 even newlines. They are processed as usual, as described above.
10901 Trailing white space in @code{X} is ignored. White space may also
10902 appear anywhere on the left side of the colon in these constructs,
10903 except between @code{.} or @code{*} and the corresponding word.
10904
10905 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10906 handled specifically in these constructs. If another value of
10907 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10908 @option{-W} switch is found later in the command line, the earlier
10909 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10910 just one letter, which passes all matching options.
10911
10912 The character @samp{|} at the beginning of the predicate text is used to
10913 indicate that a command should be piped to the following command, but
10914 only if @option{-pipe} is specified.
10915
10916 It is built into GCC which switches take arguments and which do not.
10917 (You might think it would be useful to generalize this to allow each
10918 compiler's spec to say which switches take arguments. But this cannot
10919 be done in a consistent fashion. GCC cannot even decide which input
10920 files have been specified without knowing which switches take arguments,
10921 and it must know which input files to compile in order to tell which
10922 compilers to run).
10923
10924 GCC also knows implicitly that arguments starting in @option{-l} are to be
10925 treated as compiler output files, and passed to the linker in their
10926 proper position among the other output files.
10927
10928 @c man begin OPTIONS
10929
10930 @node Target Options
10931 @section Specifying Target Machine and Compiler Version
10932 @cindex target options
10933 @cindex cross compiling
10934 @cindex specifying machine version
10935 @cindex specifying compiler version and target machine
10936 @cindex compiler version, specifying
10937 @cindex target machine, specifying
10938
10939 The usual way to run GCC is to run the executable called @command{gcc}, or
10940 @command{@var{machine}-gcc} when cross-compiling, or
10941 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10942 one that was installed last.
10943
10944 @node Submodel Options
10945 @section Hardware Models and Configurations
10946 @cindex submodel options
10947 @cindex specifying hardware config
10948 @cindex hardware models and configurations, specifying
10949 @cindex machine dependent options
10950
10951 Each target machine types can have its own
10952 special options, starting with @samp{-m}, to choose among various
10953 hardware models or configurations---for example, 68010 vs 68020,
10954 floating coprocessor or none. A single installed version of the
10955 compiler can compile for any model or configuration, according to the
10956 options specified.
10957
10958 Some configurations of the compiler also support additional special
10959 options, usually for compatibility with other compilers on the same
10960 platform.
10961
10962 @c This list is ordered alphanumerically by subsection name.
10963 @c It should be the same order and spelling as these options are listed
10964 @c in Machine Dependent Options
10965
10966 @menu
10967 * AArch64 Options::
10968 * Adapteva Epiphany Options::
10969 * ARM Options::
10970 * AVR Options::
10971 * Blackfin Options::
10972 * C6X Options::
10973 * CRIS Options::
10974 * CR16 Options::
10975 * Darwin Options::
10976 * DEC Alpha Options::
10977 * FR30 Options::
10978 * FRV Options::
10979 * GNU/Linux Options::
10980 * H8/300 Options::
10981 * HPPA Options::
10982 * i386 and x86-64 Options::
10983 * i386 and x86-64 Windows Options::
10984 * IA-64 Options::
10985 * LM32 Options::
10986 * M32C Options::
10987 * M32R/D Options::
10988 * M680x0 Options::
10989 * MCore Options::
10990 * MeP Options::
10991 * MicroBlaze Options::
10992 * MIPS Options::
10993 * MMIX Options::
10994 * MN10300 Options::
10995 * Moxie Options::
10996 * PDP-11 Options::
10997 * picoChip Options::
10998 * PowerPC Options::
10999 * RL78 Options::
11000 * RS/6000 and PowerPC Options::
11001 * RX Options::
11002 * S/390 and zSeries Options::
11003 * Score Options::
11004 * SH Options::
11005 * Solaris 2 Options::
11006 * SPARC Options::
11007 * SPU Options::
11008 * System V Options::
11009 * TILE-Gx Options::
11010 * TILEPro Options::
11011 * V850 Options::
11012 * VAX Options::
11013 * VMS Options::
11014 * VxWorks Options::
11015 * x86-64 Options::
11016 * Xstormy16 Options::
11017 * Xtensa Options::
11018 * zSeries Options::
11019 @end menu
11020
11021 @node AArch64 Options
11022 @subsection AArch64 Options
11023 @cindex AArch64 Options
11024
11025 These options are defined for AArch64 implementations:
11026
11027 @table @gcctabopt
11028
11029 @item -mabi=@var{name}
11030 @opindex mabi
11031 Generate code for the specified data model. Permissible values
11032 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11033 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11034 but long int and pointer are 64-bit.
11035
11036 The default depends on the specific target configuration. Note that
11037 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11038 entire program with the same ABI, and link with a compatible set of libraries.
11039
11040 @item -mbig-endian
11041 @opindex mbig-endian
11042 Generate big-endian code. This is the default when GCC is configured for an
11043 @samp{aarch64_be-*-*} target.
11044
11045 @item -mgeneral-regs-only
11046 @opindex mgeneral-regs-only
11047 Generate code which uses only the general registers.
11048
11049 @item -mlittle-endian
11050 @opindex mlittle-endian
11051 Generate little-endian code. This is the default when GCC is configured for an
11052 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11053
11054 @item -mcmodel=tiny
11055 @opindex mcmodel=tiny
11056 Generate code for the tiny code model. The program and its statically defined
11057 symbols must be within 1GB of each other. Pointers are 64 bits. Programs can
11058 be statically or dynamically linked. This model is not fully implemented and
11059 mostly treated as @samp{small}.
11060
11061 @item -mcmodel=small
11062 @opindex mcmodel=small
11063 Generate code for the small code model. The program and its statically defined
11064 symbols must be within 4GB of each other. Pointers are 64 bits. Programs can
11065 be statically or dynamically linked. This is the default code model.
11066
11067 @item -mcmodel=large
11068 @opindex mcmodel=large
11069 Generate code for the large code model. This makes no assumptions about
11070 addresses and sizes of sections. Pointers are 64 bits. Programs can be
11071 statically linked only.
11072
11073 @item -mstrict-align
11074 @opindex mstrict-align
11075 Do not assume that unaligned memory references will be handled by the system.
11076
11077 @item -momit-leaf-frame-pointer
11078 @itemx -mno-omit-leaf-frame-pointer
11079 @opindex momit-leaf-frame-pointer
11080 @opindex mno-omit-leaf-frame-pointer
11081 Omit or keep the frame pointer in leaf functions. The former behaviour is the
11082 default.
11083
11084 @item -mtls-dialect=desc
11085 @opindex mtls-dialect=desc
11086 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11087 of TLS variables. This is the default.
11088
11089 @item -mtls-dialect=traditional
11090 @opindex mtls-dialect=traditional
11091 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11092 of TLS variables.
11093
11094 @item -march=@var{name}
11095 @opindex march
11096 Specify the name of the target architecture, optionally suffixed by one or
11097 more feature modifiers. This option has the form
11098 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11099 only value for @var{arch} is @samp{armv8-a}. The possible values for
11100 @var{feature} are documented in the sub-section below.
11101
11102 Where conflicting feature modifiers are specified, the right-most feature is
11103 used.
11104
11105 GCC uses this name to determine what kind of instructions it can emit when
11106 generating assembly code. This option can be used in conjunction with or
11107 instead of the @option{-mcpu=} option.
11108
11109 @item -mcpu=@var{name}
11110 @opindex mcpu
11111 Specify the name of the target processor, optionally suffixed by one or more
11112 feature modifiers. This option has the form
11113 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11114 possible values for @var{cpu} are @samp{generic}, @samp{large}. The
11115 possible values for @var{feature} are documented in the sub-section
11116 below.
11117
11118 Where conflicting feature modifiers are specified, the right-most feature is
11119 used.
11120
11121 GCC uses this name to determine what kind of instructions it can emit when
11122 generating assembly code.
11123
11124 @item -mtune=@var{name}
11125 @opindex mtune
11126 Specify the name of the processor to tune the performance for. The code will
11127 be tuned as if the target processor were of the type specified in this option,
11128 but still using instructions compatible with the target processor specified
11129 by a @option{-mcpu=} option. This option cannot be suffixed by feature
11130 modifiers.
11131
11132 @end table
11133
11134 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11135 @cindex @option{-march} feature modifiers
11136 @cindex @option{-mcpu} feature modifiers
11137 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11138 the following:
11139
11140 @table @samp
11141 @item crypto
11142 Enable Crypto extension. This implies Advanced SIMD is enabled.
11143 @item fp
11144 Enable floating-point instructions.
11145 @item simd
11146 Enable Advanced SIMD instructions. This implies floating-point instructions
11147 are enabled. This is the default for all current possible values for options
11148 @option{-march} and @option{-mcpu=}.
11149 @end table
11150
11151 @node Adapteva Epiphany Options
11152 @subsection Adapteva Epiphany Options
11153
11154 These @samp{-m} options are defined for Adapteva Epiphany:
11155
11156 @table @gcctabopt
11157 @item -mhalf-reg-file
11158 @opindex mhalf-reg-file
11159 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11160 That allows code to run on hardware variants that lack these registers.
11161
11162 @item -mprefer-short-insn-regs
11163 @opindex mprefer-short-insn-regs
11164 Preferrentially allocate registers that allow short instruction generation.
11165 This can result in increased instruction count, so this may either reduce or
11166 increase overall code size.
11167
11168 @item -mbranch-cost=@var{num}
11169 @opindex mbranch-cost
11170 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11171 This cost is only a heuristic and is not guaranteed to produce
11172 consistent results across releases.
11173
11174 @item -mcmove
11175 @opindex mcmove
11176 Enable the generation of conditional moves.
11177
11178 @item -mnops=@var{num}
11179 @opindex mnops
11180 Emit @var{num} NOPs before every other generated instruction.
11181
11182 @item -mno-soft-cmpsf
11183 @opindex mno-soft-cmpsf
11184 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11185 and test the flags. This is faster than a software comparison, but can
11186 get incorrect results in the presence of NaNs, or when two different small
11187 numbers are compared such that their difference is calculated as zero.
11188 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11189 software comparisons.
11190
11191 @item -mstack-offset=@var{num}
11192 @opindex mstack-offset
11193 Set the offset between the top of the stack and the stack pointer.
11194 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11195 can be used by leaf functions without stack allocation.
11196 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11197 Note also that this option changes the ABI; compiling a program with a
11198 different stack offset than the libraries have been compiled with
11199 generally does not work.
11200 This option can be useful if you want to evaluate if a different stack
11201 offset would give you better code, but to actually use a different stack
11202 offset to build working programs, it is recommended to configure the
11203 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11204
11205 @item -mno-round-nearest
11206 @opindex mno-round-nearest
11207 Make the scheduler assume that the rounding mode has been set to
11208 truncating. The default is @option{-mround-nearest}.
11209
11210 @item -mlong-calls
11211 @opindex mlong-calls
11212 If not otherwise specified by an attribute, assume all calls might be beyond
11213 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11214 function address into a register before performing a (otherwise direct) call.
11215 This is the default.
11216
11217 @item -mshort-calls
11218 @opindex short-calls
11219 If not otherwise specified by an attribute, assume all direct calls are
11220 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11221 for direct calls. The default is @option{-mlong-calls}.
11222
11223 @item -msmall16
11224 @opindex msmall16
11225 Assume addresses can be loaded as 16-bit unsigned values. This does not
11226 apply to function addresses for which @option{-mlong-calls} semantics
11227 are in effect.
11228
11229 @item -mfp-mode=@var{mode}
11230 @opindex mfp-mode
11231 Set the prevailing mode of the floating-point unit.
11232 This determines the floating-point mode that is provided and expected
11233 at function call and return time. Making this mode match the mode you
11234 predominantly need at function start can make your programs smaller and
11235 faster by avoiding unnecessary mode switches.
11236
11237 @var{mode} can be set to one the following values:
11238
11239 @table @samp
11240 @item caller
11241 Any mode at function entry is valid, and retained or restored when
11242 the function returns, and when it calls other functions.
11243 This mode is useful for compiling libraries or other compilation units
11244 you might want to incorporate into different programs with different
11245 prevailing FPU modes, and the convenience of being able to use a single
11246 object file outweighs the size and speed overhead for any extra
11247 mode switching that might be needed, compared with what would be needed
11248 with a more specific choice of prevailing FPU mode.
11249
11250 @item truncate
11251 This is the mode used for floating-point calculations with
11252 truncating (i.e.@: round towards zero) rounding mode. That includes
11253 conversion from floating point to integer.
11254
11255 @item round-nearest
11256 This is the mode used for floating-point calculations with
11257 round-to-nearest-or-even rounding mode.
11258
11259 @item int
11260 This is the mode used to perform integer calculations in the FPU, e.g.@:
11261 integer multiply, or integer multiply-and-accumulate.
11262 @end table
11263
11264 The default is @option{-mfp-mode=caller}
11265
11266 @item -mnosplit-lohi
11267 @itemx -mno-postinc
11268 @itemx -mno-postmodify
11269 @opindex mnosplit-lohi
11270 @opindex mno-postinc
11271 @opindex mno-postmodify
11272 Code generation tweaks that disable, respectively, splitting of 32-bit
11273 loads, generation of post-increment addresses, and generation of
11274 post-modify addresses. The defaults are @option{msplit-lohi},
11275 @option{-mpost-inc}, and @option{-mpost-modify}.
11276
11277 @item -mnovect-double
11278 @opindex mno-vect-double
11279 Change the preferred SIMD mode to SImode. The default is
11280 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11281
11282 @item -max-vect-align=@var{num}
11283 @opindex max-vect-align
11284 The maximum alignment for SIMD vector mode types.
11285 @var{num} may be 4 or 8. The default is 8.
11286 Note that this is an ABI change, even though many library function
11287 interfaces are unaffected if they don't use SIMD vector modes
11288 in places that affect size and/or alignment of relevant types.
11289
11290 @item -msplit-vecmove-early
11291 @opindex msplit-vecmove-early
11292 Split vector moves into single word moves before reload. In theory this
11293 can give better register allocation, but so far the reverse seems to be
11294 generally the case.
11295
11296 @item -m1reg-@var{reg}
11297 @opindex m1reg-
11298 Specify a register to hold the constant @minus{}1, which makes loading small negative
11299 constants and certain bitmasks faster.
11300 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11301 which specify use of that register as a fixed register,
11302 and @samp{none}, which means that no register is used for this
11303 purpose. The default is @option{-m1reg-none}.
11304
11305 @end table
11306
11307 @node ARM Options
11308 @subsection ARM Options
11309 @cindex ARM options
11310
11311 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
11312 architectures:
11313
11314 @table @gcctabopt
11315 @item -mabi=@var{name}
11316 @opindex mabi
11317 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
11318 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
11319
11320 @item -mapcs-frame
11321 @opindex mapcs-frame
11322 Generate a stack frame that is compliant with the ARM Procedure Call
11323 Standard for all functions, even if this is not strictly necessary for
11324 correct execution of the code. Specifying @option{-fomit-frame-pointer}
11325 with this option causes the stack frames not to be generated for
11326 leaf functions. The default is @option{-mno-apcs-frame}.
11327
11328 @item -mapcs
11329 @opindex mapcs
11330 This is a synonym for @option{-mapcs-frame}.
11331
11332 @ignore
11333 @c not currently implemented
11334 @item -mapcs-stack-check
11335 @opindex mapcs-stack-check
11336 Generate code to check the amount of stack space available upon entry to
11337 every function (that actually uses some stack space). If there is
11338 insufficient space available then either the function
11339 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11340 called, depending upon the amount of stack space required. The runtime
11341 system is required to provide these functions. The default is
11342 @option{-mno-apcs-stack-check}, since this produces smaller code.
11343
11344 @c not currently implemented
11345 @item -mapcs-float
11346 @opindex mapcs-float
11347 Pass floating-point arguments using the floating-point registers. This is
11348 one of the variants of the APCS@. This option is recommended if the
11349 target hardware has a floating-point unit or if a lot of floating-point
11350 arithmetic is going to be performed by the code. The default is
11351 @option{-mno-apcs-float}, since the size of integer-only code is
11352 slightly increased if @option{-mapcs-float} is used.
11353
11354 @c not currently implemented
11355 @item -mapcs-reentrant
11356 @opindex mapcs-reentrant
11357 Generate reentrant, position-independent code. The default is
11358 @option{-mno-apcs-reentrant}.
11359 @end ignore
11360
11361 @item -mthumb-interwork
11362 @opindex mthumb-interwork
11363 Generate code that supports calling between the ARM and Thumb
11364 instruction sets. Without this option, on pre-v5 architectures, the
11365 two instruction sets cannot be reliably used inside one program. The
11366 default is @option{-mno-thumb-interwork}, since slightly larger code
11367 is generated when @option{-mthumb-interwork} is specified. In AAPCS
11368 configurations this option is meaningless.
11369
11370 @item -mno-sched-prolog
11371 @opindex mno-sched-prolog
11372 Prevent the reordering of instructions in the function prologue, or the
11373 merging of those instruction with the instructions in the function's
11374 body. This means that all functions start with a recognizable set
11375 of instructions (or in fact one of a choice from a small set of
11376 different function prologues), and this information can be used to
11377 locate the start of functions inside an executable piece of code. The
11378 default is @option{-msched-prolog}.
11379
11380 @item -mfloat-abi=@var{name}
11381 @opindex mfloat-abi
11382 Specifies which floating-point ABI to use. Permissible values
11383 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11384
11385 Specifying @samp{soft} causes GCC to generate output containing
11386 library calls for floating-point operations.
11387 @samp{softfp} allows the generation of code using hardware floating-point
11388 instructions, but still uses the soft-float calling conventions.
11389 @samp{hard} allows generation of floating-point instructions
11390 and uses FPU-specific calling conventions.
11391
11392 The default depends on the specific target configuration. Note that
11393 the hard-float and soft-float ABIs are not link-compatible; you must
11394 compile your entire program with the same ABI, and link with a
11395 compatible set of libraries.
11396
11397 @item -mlittle-endian
11398 @opindex mlittle-endian
11399 Generate code for a processor running in little-endian mode. This is
11400 the default for all standard configurations.
11401
11402 @item -mbig-endian
11403 @opindex mbig-endian
11404 Generate code for a processor running in big-endian mode; the default is
11405 to compile code for a little-endian processor.
11406
11407 @item -mwords-little-endian
11408 @opindex mwords-little-endian
11409 This option only applies when generating code for big-endian processors.
11410 Generate code for a little-endian word order but a big-endian byte
11411 order. That is, a byte order of the form @samp{32107654}. Note: this
11412 option should only be used if you require compatibility with code for
11413 big-endian ARM processors generated by versions of the compiler prior to
11414 2.8. This option is now deprecated.
11415
11416 @item -mcpu=@var{name}
11417 @opindex mcpu
11418 This specifies the name of the target ARM processor. GCC uses this name
11419 to determine what kind of instructions it can emit when generating
11420 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
11421 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11422 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11423 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11424 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11425 @samp{arm720},
11426 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11427 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11428 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11429 @samp{strongarm1110},
11430 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
11431 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
11432 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
11433 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
11434 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
11435 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
11436 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
11437 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
11438 @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-r4}, @samp{cortex-r4f},
11439 @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m4}, @samp{cortex-m3},
11440 @samp{cortex-m1},
11441 @samp{cortex-m0},
11442 @samp{cortex-m0plus},
11443 @samp{marvell-pj4},
11444 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
11445 @samp{fa526}, @samp{fa626},
11446 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
11447
11448
11449 @option{-mcpu=generic-@var{arch}} is also permissible, and is
11450 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
11451 See @option{-mtune} for more information.
11452
11453 @option{-mcpu=native} causes the compiler to auto-detect the CPU
11454 of the build computer. At present, this feature is only supported on
11455 Linux, and not all architectures are recognized. If the auto-detect is
11456 unsuccessful the option has no effect.
11457
11458 @item -mtune=@var{name}
11459 @opindex mtune
11460 This option is very similar to the @option{-mcpu=} option, except that
11461 instead of specifying the actual target processor type, and hence
11462 restricting which instructions can be used, it specifies that GCC should
11463 tune the performance of the code as if the target were of the type
11464 specified in this option, but still choosing the instructions it
11465 generates based on the CPU specified by a @option{-mcpu=} option.
11466 For some ARM implementations better performance can be obtained by using
11467 this option.
11468
11469 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
11470 performance for a blend of processors within architecture @var{arch}.
11471 The aim is to generate code that run well on the current most popular
11472 processors, balancing between optimizations that benefit some CPUs in the
11473 range, and avoiding performance pitfalls of other CPUs. The effects of
11474 this option may change in future GCC versions as CPU models come and go.
11475
11476 @option{-mtune=native} causes the compiler to auto-detect the CPU
11477 of the build computer. At present, this feature is only supported on
11478 Linux, and not all architectures are recognized. If the auto-detect is
11479 unsuccessful the option has no effect.
11480
11481 @item -march=@var{name}
11482 @opindex march
11483 This specifies the name of the target ARM architecture. GCC uses this
11484 name to determine what kind of instructions it can emit when generating
11485 assembly code. This option can be used in conjunction with or instead
11486 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
11487 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
11488 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
11489 @samp{armv6}, @samp{armv6j},
11490 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
11491 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
11492 @samp{armv8-a},
11493 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
11494
11495 @option{-march=native} causes the compiler to auto-detect the architecture
11496 of the build computer. At present, this feature is only supported on
11497 Linux, and not all architectures are recognized. If the auto-detect is
11498 unsuccessful the option has no effect.
11499
11500 @item -mfpu=@var{name}
11501 @opindex mfpu
11502 This specifies what floating-point hardware (or hardware emulation) is
11503 available on the target. Permissible names are: @samp{vfp}, @samp{vfpv3},
11504 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
11505 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
11506 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
11507 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
11508
11509 If @option{-msoft-float} is specified this specifies the format of
11510 floating-point values.
11511
11512 If the selected floating-point hardware includes the NEON extension
11513 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
11514 operations are not generated by GCC's auto-vectorization pass unless
11515 @option{-funsafe-math-optimizations} is also specified. This is
11516 because NEON hardware does not fully implement the IEEE 754 standard for
11517 floating-point arithmetic (in particular denormal values are treated as
11518 zero), so the use of NEON instructions may lead to a loss of precision.
11519
11520 @item -mfp16-format=@var{name}
11521 @opindex mfp16-format
11522 Specify the format of the @code{__fp16} half-precision floating-point type.
11523 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
11524 the default is @samp{none}, in which case the @code{__fp16} type is not
11525 defined. @xref{Half-Precision}, for more information.
11526
11527 @item -mstructure-size-boundary=@var{n}
11528 @opindex mstructure-size-boundary
11529 The sizes of all structures and unions are rounded up to a multiple
11530 of the number of bits set by this option. Permissible values are 8, 32
11531 and 64. The default value varies for different toolchains. For the COFF
11532 targeted toolchain the default value is 8. A value of 64 is only allowed
11533 if the underlying ABI supports it.
11534
11535 Specifying a larger number can produce faster, more efficient code, but
11536 can also increase the size of the program. Different values are potentially
11537 incompatible. Code compiled with one value cannot necessarily expect to
11538 work with code or libraries compiled with another value, if they exchange
11539 information using structures or unions.
11540
11541 @item -mabort-on-noreturn
11542 @opindex mabort-on-noreturn
11543 Generate a call to the function @code{abort} at the end of a
11544 @code{noreturn} function. It is executed if the function tries to
11545 return.
11546
11547 @item -mlong-calls
11548 @itemx -mno-long-calls
11549 @opindex mlong-calls
11550 @opindex mno-long-calls
11551 Tells the compiler to perform function calls by first loading the
11552 address of the function into a register and then performing a subroutine
11553 call on this register. This switch is needed if the target function
11554 lies outside of the 64-megabyte addressing range of the offset-based
11555 version of subroutine call instruction.
11556
11557 Even if this switch is enabled, not all function calls are turned
11558 into long calls. The heuristic is that static functions, functions
11559 that have the @samp{short-call} attribute, functions that are inside
11560 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
11561 definitions have already been compiled within the current compilation
11562 unit are not turned into long calls. The exceptions to this rule are
11563 that weak function definitions, functions with the @samp{long-call}
11564 attribute or the @samp{section} attribute, and functions that are within
11565 the scope of a @samp{#pragma long_calls} directive are always
11566 turned into long calls.
11567
11568 This feature is not enabled by default. Specifying
11569 @option{-mno-long-calls} restores the default behavior, as does
11570 placing the function calls within the scope of a @samp{#pragma
11571 long_calls_off} directive. Note these switches have no effect on how
11572 the compiler generates code to handle function calls via function
11573 pointers.
11574
11575 @item -msingle-pic-base
11576 @opindex msingle-pic-base
11577 Treat the register used for PIC addressing as read-only, rather than
11578 loading it in the prologue for each function. The runtime system is
11579 responsible for initializing this register with an appropriate value
11580 before execution begins.
11581
11582 @item -mpic-register=@var{reg}
11583 @opindex mpic-register
11584 Specify the register to be used for PIC addressing. The default is R10
11585 unless stack-checking is enabled, when R9 is used.
11586
11587 @item -mpoke-function-name
11588 @opindex mpoke-function-name
11589 Write the name of each function into the text section, directly
11590 preceding the function prologue. The generated code is similar to this:
11591
11592 @smallexample
11593 t0
11594 .ascii "arm_poke_function_name", 0
11595 .align
11596 t1
11597 .word 0xff000000 + (t1 - t0)
11598 arm_poke_function_name
11599 mov ip, sp
11600 stmfd sp!, @{fp, ip, lr, pc@}
11601 sub fp, ip, #4
11602 @end smallexample
11603
11604 When performing a stack backtrace, code can inspect the value of
11605 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
11606 location @code{pc - 12} and the top 8 bits are set, then we know that
11607 there is a function name embedded immediately preceding this location
11608 and has length @code{((pc[-3]) & 0xff000000)}.
11609
11610 @item -mthumb
11611 @itemx -marm
11612 @opindex marm
11613 @opindex mthumb
11614
11615 Select between generating code that executes in ARM and Thumb
11616 states. The default for most configurations is to generate code
11617 that executes in ARM state, but the default can be changed by
11618 configuring GCC with the @option{--with-mode=}@var{state}
11619 configure option.
11620
11621 @item -mtpcs-frame
11622 @opindex mtpcs-frame
11623 Generate a stack frame that is compliant with the Thumb Procedure Call
11624 Standard for all non-leaf functions. (A leaf function is one that does
11625 not call any other functions.) The default is @option{-mno-tpcs-frame}.
11626
11627 @item -mtpcs-leaf-frame
11628 @opindex mtpcs-leaf-frame
11629 Generate a stack frame that is compliant with the Thumb Procedure Call
11630 Standard for all leaf functions. (A leaf function is one that does
11631 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
11632
11633 @item -mcallee-super-interworking
11634 @opindex mcallee-super-interworking
11635 Gives all externally visible functions in the file being compiled an ARM
11636 instruction set header which switches to Thumb mode before executing the
11637 rest of the function. This allows these functions to be called from
11638 non-interworking code. This option is not valid in AAPCS configurations
11639 because interworking is enabled by default.
11640
11641 @item -mcaller-super-interworking
11642 @opindex mcaller-super-interworking
11643 Allows calls via function pointers (including virtual functions) to
11644 execute correctly regardless of whether the target code has been
11645 compiled for interworking or not. There is a small overhead in the cost
11646 of executing a function pointer if this option is enabled. This option
11647 is not valid in AAPCS configurations because interworking is enabled
11648 by default.
11649
11650 @item -mtp=@var{name}
11651 @opindex mtp
11652 Specify the access model for the thread local storage pointer. The valid
11653 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11654 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11655 (supported in the arm6k architecture), and @option{auto}, which uses the
11656 best available method for the selected processor. The default setting is
11657 @option{auto}.
11658
11659 @item -mtls-dialect=@var{dialect}
11660 @opindex mtls-dialect
11661 Specify the dialect to use for accessing thread local storage. Two
11662 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}. The
11663 @samp{gnu} dialect selects the original GNU scheme for supporting
11664 local and global dynamic TLS models. The @samp{gnu2} dialect
11665 selects the GNU descriptor scheme, which provides better performance
11666 for shared libraries. The GNU descriptor scheme is compatible with
11667 the original scheme, but does require new assembler, linker and
11668 library support. Initial and local exec TLS models are unaffected by
11669 this option and always use the original scheme.
11670
11671 @item -mword-relocations
11672 @opindex mword-relocations
11673 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11674 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11675 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11676 is specified.
11677
11678 @item -mfix-cortex-m3-ldrd
11679 @opindex mfix-cortex-m3-ldrd
11680 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11681 with overlapping destination and base registers are used. This option avoids
11682 generating these instructions. This option is enabled by default when
11683 @option{-mcpu=cortex-m3} is specified.
11684
11685 @item -munaligned-access
11686 @itemx -mno-unaligned-access
11687 @opindex munaligned-access
11688 @opindex mno-unaligned-access
11689 Enables (or disables) reading and writing of 16- and 32- bit values
11690 from addresses that are not 16- or 32- bit aligned. By default
11691 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11692 architectures, and enabled for all other architectures. If unaligned
11693 access is not enabled then words in packed data structures will be
11694 accessed a byte at a time.
11695
11696 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11697 generated object file to either true or false, depending upon the
11698 setting of this option. If unaligned access is enabled then the
11699 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11700 defined.
11701
11702 @item -mneon-for-64bits
11703 @opindex mneon-for-64bits
11704 Enables using Neon to handle scalar 64-bits operations. This is
11705 disabled by default since the cost of moving data from core registers
11706 to Neon is high.
11707
11708 @item -mrestrict-it
11709 @opindex mrestrict-it
11710 Restricts generation of IT blocks to conform to the rules of ARMv8.
11711 IT blocks can only contain a single 16-bit instruction from a select
11712 set of instructions. This option is on by default for ARMv8 Thumb mode.
11713 @end table
11714
11715 @node AVR Options
11716 @subsection AVR Options
11717 @cindex AVR Options
11718
11719 These options are defined for AVR implementations:
11720
11721 @table @gcctabopt
11722 @item -mmcu=@var{mcu}
11723 @opindex mmcu
11724 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11725
11726 The default for this option is@tie{}@code{avr2}.
11727
11728 GCC supports the following AVR devices and ISAs:
11729
11730 @include avr-mmcu.texi
11731
11732 @item -maccumulate-args
11733 @opindex maccumulate-args
11734 Accumulate outgoing function arguments and acquire/release the needed
11735 stack space for outgoing function arguments once in function
11736 prologue/epilogue. Without this option, outgoing arguments are pushed
11737 before calling a function and popped afterwards.
11738
11739 Popping the arguments after the function call can be expensive on
11740 AVR so that accumulating the stack space might lead to smaller
11741 executables because arguments need not to be removed from the
11742 stack after such a function call.
11743
11744 This option can lead to reduced code size for functions that perform
11745 several calls to functions that get their arguments on the stack like
11746 calls to printf-like functions.
11747
11748 @item -mbranch-cost=@var{cost}
11749 @opindex mbranch-cost
11750 Set the branch costs for conditional branch instructions to
11751 @var{cost}. Reasonable values for @var{cost} are small, non-negative
11752 integers. The default branch cost is 0.
11753
11754 @item -mcall-prologues
11755 @opindex mcall-prologues
11756 Functions prologues/epilogues are expanded as calls to appropriate
11757 subroutines. Code size is smaller.
11758
11759 @item -mint8
11760 @opindex mint8
11761 Assume @code{int} to be 8-bit integer. This affects the sizes of all types: a
11762 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11763 and @code{long long} is 4 bytes. Please note that this option does not
11764 conform to the C standards, but it results in smaller code
11765 size.
11766
11767 @item -mno-interrupts
11768 @opindex mno-interrupts
11769 Generated code is not compatible with hardware interrupts.
11770 Code size is smaller.
11771
11772 @item -mrelax
11773 @opindex mrelax
11774 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11775 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11776 Setting @code{-mrelax} just adds the @code{--relax} option to the
11777 linker command line when the linker is called.
11778
11779 Jump relaxing is performed by the linker because jump offsets are not
11780 known before code is located. Therefore, the assembler code generated by the
11781 compiler is the same, but the instructions in the executable may
11782 differ from instructions in the assembler code.
11783
11784 Relaxing must be turned on if linker stubs are needed, see the
11785 section on @code{EIND} and linker stubs below.
11786
11787 @item -msp8
11788 @opindex msp8
11789 Treat the stack pointer register as an 8-bit register,
11790 i.e.@: assume the high byte of the stack pointer is zero.
11791 In general, you don't need to set this option by hand.
11792
11793 This option is used internally by the compiler to select and
11794 build multilibs for architectures @code{avr2} and @code{avr25}.
11795 These architectures mix devices with and without @code{SPH}.
11796 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11797 the compiler driver will add or remove this option from the compiler
11798 proper's command line, because the compiler then knows if the device
11799 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11800 register or not.
11801
11802 @item -mstrict-X
11803 @opindex mstrict-X
11804 Use address register @code{X} in a way proposed by the hardware. This means
11805 that @code{X} is only used in indirect, post-increment or
11806 pre-decrement addressing.
11807
11808 Without this option, the @code{X} register may be used in the same way
11809 as @code{Y} or @code{Z} which then is emulated by additional
11810 instructions.
11811 For example, loading a value with @code{X+const} addressing with a
11812 small non-negative @code{const < 64} to a register @var{Rn} is
11813 performed as
11814
11815 @example
11816 adiw r26, const ; X += const
11817 ld @var{Rn}, X ; @var{Rn} = *X
11818 sbiw r26, const ; X -= const
11819 @end example
11820
11821 @item -mtiny-stack
11822 @opindex mtiny-stack
11823 Only change the lower 8@tie{}bits of the stack pointer.
11824
11825 @item -Waddr-space-convert
11826 @opindex Waddr-space-convert
11827 Warn about conversions between address spaces in the case where the
11828 resulting address space is not contained in the incoming address space.
11829 @end table
11830
11831 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11832 @cindex @code{EIND}
11833 Pointers in the implementation are 16@tie{}bits wide.
11834 The address of a function or label is represented as word address so
11835 that indirect jumps and calls can target any code address in the
11836 range of 64@tie{}Ki words.
11837
11838 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11839 bytes of program memory space, there is a special function register called
11840 @code{EIND} that serves as most significant part of the target address
11841 when @code{EICALL} or @code{EIJMP} instructions are used.
11842
11843 Indirect jumps and calls on these devices are handled as follows by
11844 the compiler and are subject to some limitations:
11845
11846 @itemize @bullet
11847
11848 @item
11849 The compiler never sets @code{EIND}.
11850
11851 @item
11852 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11853 instructions or might read @code{EIND} directly in order to emulate an
11854 indirect call/jump by means of a @code{RET} instruction.
11855
11856 @item
11857 The compiler assumes that @code{EIND} never changes during the startup
11858 code or during the application. In particular, @code{EIND} is not
11859 saved/restored in function or interrupt service routine
11860 prologue/epilogue.
11861
11862 @item
11863 For indirect calls to functions and computed goto, the linker
11864 generates @emph{stubs}. Stubs are jump pads sometimes also called
11865 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11866 The stub contains a direct jump to the desired address.
11867
11868 @item
11869 Linker relaxation must be turned on so that the linker will generate
11870 the stubs correctly an all situaltion. See the compiler option
11871 @code{-mrelax} and the linler option @code{--relax}.
11872 There are corner cases where the linker is supposed to generate stubs
11873 but aborts without relaxation and without a helpful error message.
11874
11875 @item
11876 The default linker script is arranged for code with @code{EIND = 0}.
11877 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11878 linker script has to be used in order to place the sections whose
11879 name start with @code{.trampolines} into the segment where @code{EIND}
11880 points to.
11881
11882 @item
11883 The startup code from libgcc never sets @code{EIND}.
11884 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11885 For the impact of AVR-LibC on @code{EIND}, see the
11886 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
11887
11888 @item
11889 It is legitimate for user-specific startup code to set up @code{EIND}
11890 early, for example by means of initialization code located in
11891 section @code{.init3}. Such code runs prior to general startup code
11892 that initializes RAM and calls constructors, but after the bit
11893 of startup code from AVR-LibC that sets @code{EIND} to the segment
11894 where the vector table is located.
11895 @example
11896 #include <avr/io.h>
11897
11898 static void
11899 __attribute__((section(".init3"),naked,used,no_instrument_function))
11900 init3_set_eind (void)
11901 @{
11902 __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11903 "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11904 @}
11905 @end example
11906
11907 @noindent
11908 The @code{__trampolines_start} symbol is defined in the linker script.
11909
11910 @item
11911 Stubs are generated automatically by the linker if
11912 the following two conditions are met:
11913 @itemize @minus
11914
11915 @item The address of a label is taken by means of the @code{gs} modifier
11916 (short for @emph{generate stubs}) like so:
11917 @example
11918 LDI r24, lo8(gs(@var{func}))
11919 LDI r25, hi8(gs(@var{func}))
11920 @end example
11921 @item The final location of that label is in a code segment
11922 @emph{outside} the segment where the stubs are located.
11923 @end itemize
11924
11925 @item
11926 The compiler emits such @code{gs} modifiers for code labels in the
11927 following situations:
11928 @itemize @minus
11929 @item Taking address of a function or code label.
11930 @item Computed goto.
11931 @item If prologue-save function is used, see @option{-mcall-prologues}
11932 command-line option.
11933 @item Switch/case dispatch tables. If you do not want such dispatch
11934 tables you can specify the @option{-fno-jump-tables} command-line option.
11935 @item C and C++ constructors/destructors called during startup/shutdown.
11936 @item If the tools hit a @code{gs()} modifier explained above.
11937 @end itemize
11938
11939 @item
11940 Jumping to non-symbolic addresses like so is @emph{not} supported:
11941
11942 @example
11943 int main (void)
11944 @{
11945 /* Call function at word address 0x2 */
11946 return ((int(*)(void)) 0x2)();
11947 @}
11948 @end example
11949
11950 Instead, a stub has to be set up, i.e.@: the function has to be called
11951 through a symbol (@code{func_4} in the example):
11952
11953 @example
11954 int main (void)
11955 @{
11956 extern int func_4 (void);
11957
11958 /* Call function at byte address 0x4 */
11959 return func_4();
11960 @}
11961 @end example
11962
11963 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11964 Alternatively, @code{func_4} can be defined in the linker script.
11965 @end itemize
11966
11967 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11968 @cindex @code{RAMPD}
11969 @cindex @code{RAMPX}
11970 @cindex @code{RAMPY}
11971 @cindex @code{RAMPZ}
11972 Some AVR devices support memories larger than the 64@tie{}KiB range
11973 that can be accessed with 16-bit pointers. To access memory locations
11974 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11975 register is used as high part of the address:
11976 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11977 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11978 register, respectively, to get a wide address. Similarly,
11979 @code{RAMPD} is used together with direct addressing.
11980
11981 @itemize
11982 @item
11983 The startup code initializes the @code{RAMP} special function
11984 registers with zero.
11985
11986 @item
11987 If a @ref{AVR Named Address Spaces,named address space} other than
11988 generic or @code{__flash} is used, then @code{RAMPZ} is set
11989 as needed before the operation.
11990
11991 @item
11992 If the device supports RAM larger than 64@tie{KiB} and the compiler
11993 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11994 is reset to zero after the operation.
11995
11996 @item
11997 If the device comes with a specific @code{RAMP} register, the ISR
11998 prologue/epilogue saves/restores that SFR and initializes it with
11999 zero in case the ISR code might (implicitly) use it.
12000
12001 @item
12002 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
12003 If you use inline assembler to read from locations outside the
12004 16-bit address range and change one of the @code{RAMP} registers,
12005 you must reset it to zero after the access.
12006
12007 @end itemize
12008
12009 @subsubsection AVR Built-in Macros
12010
12011 GCC defines several built-in macros so that the user code can test
12012 for the presence or absence of features. Almost any of the following
12013 built-in macros are deduced from device capabilities and thus
12014 triggered by the @code{-mmcu=} command-line option.
12015
12016 For even more AVR-specific built-in macros see
12017 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
12018
12019 @table @code
12020
12021 @item __AVR_ARCH__
12022 Build-in macro that resolves to a decimal number that identifies the
12023 architecture and depends on the @code{-mmcu=@var{mcu}} option.
12024 Possible values are:
12025
12026 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
12027 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
12028 @code{105}, @code{106}, @code{107}
12029
12030 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
12031 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
12032 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
12033 @code{avrxmega6}, @code{avrxmega7}, respectively.
12034 If @var{mcu} specifies a device, this built-in macro is set
12035 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
12036 defined to @code{4}.
12037
12038 @item __AVR_@var{Device}__
12039 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
12040 the device's name. For example, @code{-mmcu=atmega8} defines the
12041 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
12042 @code{__AVR_ATtiny261A__}, etc.
12043
12044 The built-in macros' names follow
12045 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
12046 the device name as from the AVR user manual. The difference between
12047 @var{Device} in the built-in macro and @var{device} in
12048 @code{-mmcu=@var{device}} is that the latter is always lowercase.
12049
12050 If @var{device} is not a device but only a core architecture like
12051 @code{avr51}, this macro will not be defined.
12052
12053 @item __AVR_XMEGA__
12054 The device / architecture belongs to the XMEGA family of devices.
12055
12056 @item __AVR_HAVE_ELPM__
12057 The device has the the @code{ELPM} instruction.
12058
12059 @item __AVR_HAVE_ELPMX__
12060 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
12061 R@var{n},Z+} instructions.
12062
12063 @item __AVR_HAVE_MOVW__
12064 The device has the @code{MOVW} instruction to perform 16-bit
12065 register-register moves.
12066
12067 @item __AVR_HAVE_LPMX__
12068 The device has the @code{LPM R@var{n},Z} and
12069 @code{LPM R@var{n},Z+} instructions.
12070
12071 @item __AVR_HAVE_MUL__
12072 The device has a hardware multiplier.
12073
12074 @item __AVR_HAVE_JMP_CALL__
12075 The device has the @code{JMP} and @code{CALL} instructions.
12076 This is the case for devices with at least 16@tie{}KiB of program
12077 memory.
12078
12079 @item __AVR_HAVE_EIJMP_EICALL__
12080 @itemx __AVR_3_BYTE_PC__
12081 The device has the @code{EIJMP} and @code{EICALL} instructions.
12082 This is the case for devices with more than 128@tie{}KiB of program memory.
12083 This also means that the program counter
12084 (PC) is 3@tie{}bytes wide.
12085
12086 @item __AVR_2_BYTE_PC__
12087 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
12088 with up to 128@tie{}KiB of program memory.
12089
12090 @item __AVR_HAVE_8BIT_SP__
12091 @itemx __AVR_HAVE_16BIT_SP__
12092 The stack pointer (SP) register is treated as 8-bit respectively
12093 16-bit register by the compiler.
12094 The definition of these macros is affected by @code{-mtiny-stack}.
12095
12096 @item __AVR_HAVE_SPH__
12097 @itemx __AVR_SP8__
12098 The device has the SPH (high part of stack pointer) special function
12099 register or has an 8-bit stack pointer, respectively.
12100 The definition of these macros is affected by @code{-mmcu=} and
12101 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
12102 by @code{-msp8}.
12103
12104 @item __AVR_HAVE_RAMPD__
12105 @itemx __AVR_HAVE_RAMPX__
12106 @itemx __AVR_HAVE_RAMPY__
12107 @itemx __AVR_HAVE_RAMPZ__
12108 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
12109 @code{RAMPZ} special function register, respectively.
12110
12111 @item __NO_INTERRUPTS__
12112 This macro reflects the @code{-mno-interrupts} command line option.
12113
12114 @item __AVR_ERRATA_SKIP__
12115 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
12116 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
12117 instructions because of a hardware erratum. Skip instructions are
12118 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
12119 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
12120 set.
12121
12122 @item __AVR_SFR_OFFSET__=@var{offset}
12123 Instructions that can address I/O special function registers directly
12124 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
12125 address as if addressed by an instruction to access RAM like @code{LD}
12126 or @code{STS}. This offset depends on the device architecture and has
12127 to be subtracted from the RAM address in order to get the
12128 respective I/O@tie{}address.
12129
12130 @item __WITH_AVRLIBC__
12131 The compiler is configured to be used together with AVR-Libc.
12132 See the @code{--with-avrlibc} configure option.
12133
12134 @end table
12135
12136 @node Blackfin Options
12137 @subsection Blackfin Options
12138 @cindex Blackfin Options
12139
12140 @table @gcctabopt
12141 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
12142 @opindex mcpu=
12143 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
12144 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
12145 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
12146 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
12147 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
12148 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
12149 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
12150 @samp{bf561}, @samp{bf592}.
12151
12152 The optional @var{sirevision} specifies the silicon revision of the target
12153 Blackfin processor. Any workarounds available for the targeted silicon revision
12154 are enabled. If @var{sirevision} is @samp{none}, no workarounds are enabled.
12155 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
12156 are enabled. The @code{__SILICON_REVISION__} macro is defined to two
12157 hexadecimal digits representing the major and minor numbers in the silicon
12158 revision. If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
12159 is not defined. If @var{sirevision} is @samp{any}, the
12160 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
12161 If this optional @var{sirevision} is not used, GCC assumes the latest known
12162 silicon revision of the targeted Blackfin processor.
12163
12164 GCC defines a preprocessor macro for the specified @var{cpu}.
12165 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
12166 provided by libgloss to be linked in if @option{-msim} is not given.
12167
12168 Without this option, @samp{bf532} is used as the processor by default.
12169
12170 Note that support for @samp{bf561} is incomplete. For @samp{bf561},
12171 only the preprocessor macro is defined.
12172
12173 @item -msim
12174 @opindex msim
12175 Specifies that the program will be run on the simulator. This causes
12176 the simulator BSP provided by libgloss to be linked in. This option
12177 has effect only for @samp{bfin-elf} toolchain.
12178 Certain other options, such as @option{-mid-shared-library} and
12179 @option{-mfdpic}, imply @option{-msim}.
12180
12181 @item -momit-leaf-frame-pointer
12182 @opindex momit-leaf-frame-pointer
12183 Don't keep the frame pointer in a register for leaf functions. This
12184 avoids the instructions to save, set up and restore frame pointers and
12185 makes an extra register available in leaf functions. The option
12186 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
12187 which might make debugging harder.
12188
12189 @item -mspecld-anomaly
12190 @opindex mspecld-anomaly
12191 When enabled, the compiler ensures that the generated code does not
12192 contain speculative loads after jump instructions. If this option is used,
12193 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
12194
12195 @item -mno-specld-anomaly
12196 @opindex mno-specld-anomaly
12197 Don't generate extra code to prevent speculative loads from occurring.
12198
12199 @item -mcsync-anomaly
12200 @opindex mcsync-anomaly
12201 When enabled, the compiler ensures that the generated code does not
12202 contain CSYNC or SSYNC instructions too soon after conditional branches.
12203 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
12204
12205 @item -mno-csync-anomaly
12206 @opindex mno-csync-anomaly
12207 Don't generate extra code to prevent CSYNC or SSYNC instructions from
12208 occurring too soon after a conditional branch.
12209
12210 @item -mlow-64k
12211 @opindex mlow-64k
12212 When enabled, the compiler is free to take advantage of the knowledge that
12213 the entire program fits into the low 64k of memory.
12214
12215 @item -mno-low-64k
12216 @opindex mno-low-64k
12217 Assume that the program is arbitrarily large. This is the default.
12218
12219 @item -mstack-check-l1
12220 @opindex mstack-check-l1
12221 Do stack checking using information placed into L1 scratchpad memory by the
12222 uClinux kernel.
12223
12224 @item -mid-shared-library
12225 @opindex mid-shared-library
12226 Generate code that supports shared libraries via the library ID method.
12227 This allows for execute in place and shared libraries in an environment
12228 without virtual memory management. This option implies @option{-fPIC}.
12229 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12230
12231 @item -mno-id-shared-library
12232 @opindex mno-id-shared-library
12233 Generate code that doesn't assume ID-based shared libraries are being used.
12234 This is the default.
12235
12236 @item -mleaf-id-shared-library
12237 @opindex mleaf-id-shared-library
12238 Generate code that supports shared libraries via the library ID method,
12239 but assumes that this library or executable won't link against any other
12240 ID shared libraries. That allows the compiler to use faster code for jumps
12241 and calls.
12242
12243 @item -mno-leaf-id-shared-library
12244 @opindex mno-leaf-id-shared-library
12245 Do not assume that the code being compiled won't link against any ID shared
12246 libraries. Slower code is generated for jump and call insns.
12247
12248 @item -mshared-library-id=n
12249 @opindex mshared-library-id
12250 Specifies the identification number of the ID-based shared library being
12251 compiled. Specifying a value of 0 generates more compact code; specifying
12252 other values forces the allocation of that number to the current
12253 library but is no more space- or time-efficient than omitting this option.
12254
12255 @item -msep-data
12256 @opindex msep-data
12257 Generate code that allows the data segment to be located in a different
12258 area of memory from the text segment. This allows for execute in place in
12259 an environment without virtual memory management by eliminating relocations
12260 against the text section.
12261
12262 @item -mno-sep-data
12263 @opindex mno-sep-data
12264 Generate code that assumes that the data segment follows the text segment.
12265 This is the default.
12266
12267 @item -mlong-calls
12268 @itemx -mno-long-calls
12269 @opindex mlong-calls
12270 @opindex mno-long-calls
12271 Tells the compiler to perform function calls by first loading the
12272 address of the function into a register and then performing a subroutine
12273 call on this register. This switch is needed if the target function
12274 lies outside of the 24-bit addressing range of the offset-based
12275 version of subroutine call instruction.
12276
12277 This feature is not enabled by default. Specifying
12278 @option{-mno-long-calls} restores the default behavior. Note these
12279 switches have no effect on how the compiler generates code to handle
12280 function calls via function pointers.
12281
12282 @item -mfast-fp
12283 @opindex mfast-fp
12284 Link with the fast floating-point library. This library relaxes some of
12285 the IEEE floating-point standard's rules for checking inputs against
12286 Not-a-Number (NAN), in the interest of performance.
12287
12288 @item -minline-plt
12289 @opindex minline-plt
12290 Enable inlining of PLT entries in function calls to functions that are
12291 not known to bind locally. It has no effect without @option{-mfdpic}.
12292
12293 @item -mmulticore
12294 @opindex mmulticore
12295 Build a standalone application for multicore Blackfin processors.
12296 This option causes proper start files and link scripts supporting
12297 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}.
12298 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}.
12299
12300 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
12301 selects the one-application-per-core programming model. Without
12302 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
12303 programming model is used. In this model, the main function of Core B
12304 should be named as @code{coreb_main}.
12305
12306 If this option is not used, the single-core application programming
12307 model is used.
12308
12309 @item -mcorea
12310 @opindex mcorea
12311 Build a standalone application for Core A of BF561 when using
12312 the one-application-per-core programming model. Proper start files
12313 and link scripts are used to support Core A, and the macro
12314 @code{__BFIN_COREA} is defined.
12315 This option can only be used in conjunction with @option{-mmulticore}.
12316
12317 @item -mcoreb
12318 @opindex mcoreb
12319 Build a standalone application for Core B of BF561 when using
12320 the one-application-per-core programming model. Proper start files
12321 and link scripts are used to support Core B, and the macro
12322 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
12323 should be used instead of @code{main}.
12324 This option can only be used in conjunction with @option{-mmulticore}.
12325
12326 @item -msdram
12327 @opindex msdram
12328 Build a standalone application for SDRAM. Proper start files and
12329 link scripts are used to put the application into SDRAM, and the macro
12330 @code{__BFIN_SDRAM} is defined.
12331 The loader should initialize SDRAM before loading the application.
12332
12333 @item -micplb
12334 @opindex micplb
12335 Assume that ICPLBs are enabled at run time. This has an effect on certain
12336 anomaly workarounds. For Linux targets, the default is to assume ICPLBs
12337 are enabled; for standalone applications the default is off.
12338 @end table
12339
12340 @node C6X Options
12341 @subsection C6X Options
12342 @cindex C6X Options
12343
12344 @table @gcctabopt
12345 @item -march=@var{name}
12346 @opindex march
12347 This specifies the name of the target architecture. GCC uses this
12348 name to determine what kind of instructions it can emit when generating
12349 assembly code. Permissible names are: @samp{c62x},
12350 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12351
12352 @item -mbig-endian
12353 @opindex mbig-endian
12354 Generate code for a big-endian target.
12355
12356 @item -mlittle-endian
12357 @opindex mlittle-endian
12358 Generate code for a little-endian target. This is the default.
12359
12360 @item -msim
12361 @opindex msim
12362 Choose startup files and linker script suitable for the simulator.
12363
12364 @item -msdata=default
12365 @opindex msdata=default
12366 Put small global and static data in the @samp{.neardata} section,
12367 which is pointed to by register @code{B14}. Put small uninitialized
12368 global and static data in the @samp{.bss} section, which is adjacent
12369 to the @samp{.neardata} section. Put small read-only data into the
12370 @samp{.rodata} section. The corresponding sections used for large
12371 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12372
12373 @item -msdata=all
12374 @opindex msdata=all
12375 Put all data, not just small objects, into the sections reserved for
12376 small data, and use addressing relative to the @code{B14} register to
12377 access them.
12378
12379 @item -msdata=none
12380 @opindex msdata=none
12381 Make no use of the sections reserved for small data, and use absolute
12382 addresses to access all data. Put all initialized global and static
12383 data in the @samp{.fardata} section, and all uninitialized data in the
12384 @samp{.far} section. Put all constant data into the @samp{.const}
12385 section.
12386 @end table
12387
12388 @node CRIS Options
12389 @subsection CRIS Options
12390 @cindex CRIS Options
12391
12392 These options are defined specifically for the CRIS ports.
12393
12394 @table @gcctabopt
12395 @item -march=@var{architecture-type}
12396 @itemx -mcpu=@var{architecture-type}
12397 @opindex march
12398 @opindex mcpu
12399 Generate code for the specified architecture. The choices for
12400 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12401 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12402 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12403 @samp{v10}.
12404
12405 @item -mtune=@var{architecture-type}
12406 @opindex mtune
12407 Tune to @var{architecture-type} everything applicable about the generated
12408 code, except for the ABI and the set of available instructions. The
12409 choices for @var{architecture-type} are the same as for
12410 @option{-march=@var{architecture-type}}.
12411
12412 @item -mmax-stack-frame=@var{n}
12413 @opindex mmax-stack-frame
12414 Warn when the stack frame of a function exceeds @var{n} bytes.
12415
12416 @item -metrax4
12417 @itemx -metrax100
12418 @opindex metrax4
12419 @opindex metrax100
12420 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12421 @option{-march=v3} and @option{-march=v8} respectively.
12422
12423 @item -mmul-bug-workaround
12424 @itemx -mno-mul-bug-workaround
12425 @opindex mmul-bug-workaround
12426 @opindex mno-mul-bug-workaround
12427 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12428 models where it applies. This option is active by default.
12429
12430 @item -mpdebug
12431 @opindex mpdebug
12432 Enable CRIS-specific verbose debug-related information in the assembly
12433 code. This option also has the effect of turning off the @samp{#NO_APP}
12434 formatted-code indicator to the assembler at the beginning of the
12435 assembly file.
12436
12437 @item -mcc-init
12438 @opindex mcc-init
12439 Do not use condition-code results from previous instruction; always emit
12440 compare and test instructions before use of condition codes.
12441
12442 @item -mno-side-effects
12443 @opindex mno-side-effects
12444 Do not emit instructions with side effects in addressing modes other than
12445 post-increment.
12446
12447 @item -mstack-align
12448 @itemx -mno-stack-align
12449 @itemx -mdata-align
12450 @itemx -mno-data-align
12451 @itemx -mconst-align
12452 @itemx -mno-const-align
12453 @opindex mstack-align
12454 @opindex mno-stack-align
12455 @opindex mdata-align
12456 @opindex mno-data-align
12457 @opindex mconst-align
12458 @opindex mno-const-align
12459 These options (@samp{no-} options) arrange (eliminate arrangements) for the
12460 stack frame, individual data and constants to be aligned for the maximum
12461 single data access size for the chosen CPU model. The default is to
12462 arrange for 32-bit alignment. ABI details such as structure layout are
12463 not affected by these options.
12464
12465 @item -m32-bit
12466 @itemx -m16-bit
12467 @itemx -m8-bit
12468 @opindex m32-bit
12469 @opindex m16-bit
12470 @opindex m8-bit
12471 Similar to the stack- data- and const-align options above, these options
12472 arrange for stack frame, writable data and constants to all be 32-bit,
12473 16-bit or 8-bit aligned. The default is 32-bit alignment.
12474
12475 @item -mno-prologue-epilogue
12476 @itemx -mprologue-epilogue
12477 @opindex mno-prologue-epilogue
12478 @opindex mprologue-epilogue
12479 With @option{-mno-prologue-epilogue}, the normal function prologue and
12480 epilogue which set up the stack frame are omitted and no return
12481 instructions or return sequences are generated in the code. Use this
12482 option only together with visual inspection of the compiled code: no
12483 warnings or errors are generated when call-saved registers must be saved,
12484 or storage for local variables needs to be allocated.
12485
12486 @item -mno-gotplt
12487 @itemx -mgotplt
12488 @opindex mno-gotplt
12489 @opindex mgotplt
12490 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
12491 instruction sequences that load addresses for functions from the PLT part
12492 of the GOT rather than (traditional on other architectures) calls to the
12493 PLT@. The default is @option{-mgotplt}.
12494
12495 @item -melf
12496 @opindex melf
12497 Legacy no-op option only recognized with the cris-axis-elf and
12498 cris-axis-linux-gnu targets.
12499
12500 @item -mlinux
12501 @opindex mlinux
12502 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
12503
12504 @item -sim
12505 @opindex sim
12506 This option, recognized for the cris-axis-elf, arranges
12507 to link with input-output functions from a simulator library. Code,
12508 initialized data and zero-initialized data are allocated consecutively.
12509
12510 @item -sim2
12511 @opindex sim2
12512 Like @option{-sim}, but pass linker options to locate initialized data at
12513 0x40000000 and zero-initialized data at 0x80000000.
12514 @end table
12515
12516 @node CR16 Options
12517 @subsection CR16 Options
12518 @cindex CR16 Options
12519
12520 These options are defined specifically for the CR16 ports.
12521
12522 @table @gcctabopt
12523
12524 @item -mmac
12525 @opindex mmac
12526 Enable the use of multiply-accumulate instructions. Disabled by default.
12527
12528 @item -mcr16cplus
12529 @itemx -mcr16c
12530 @opindex mcr16cplus
12531 @opindex mcr16c
12532 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture
12533 is default.
12534
12535 @item -msim
12536 @opindex msim
12537 Links the library libsim.a which is in compatible with simulator. Applicable
12538 to ELF compiler only.
12539
12540 @item -mint32
12541 @opindex mint32
12542 Choose integer type as 32-bit wide.
12543
12544 @item -mbit-ops
12545 @opindex mbit-ops
12546 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
12547
12548 @item -mdata-model=@var{model}
12549 @opindex mdata-model
12550 Choose a data model. The choices for @var{model} are @samp{near},
12551 @samp{far} or @samp{medium}. @samp{medium} is default.
12552 However, @samp{far} is not valid with @option{-mcr16c}, as the
12553 CR16C architecture does not support the far data model.
12554 @end table
12555
12556 @node Darwin Options
12557 @subsection Darwin Options
12558 @cindex Darwin options
12559
12560 These options are defined for all architectures running the Darwin operating
12561 system.
12562
12563 FSF GCC on Darwin does not create ``fat'' object files; it creates
12564 an object file for the single architecture that GCC was built to
12565 target. Apple's GCC on Darwin does create ``fat'' files if multiple
12566 @option{-arch} options are used; it does so by running the compiler or
12567 linker multiple times and joining the results together with
12568 @file{lipo}.
12569
12570 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
12571 @samp{i686}) is determined by the flags that specify the ISA
12572 that GCC is targeting, like @option{-mcpu} or @option{-march}. The
12573 @option{-force_cpusubtype_ALL} option can be used to override this.
12574
12575 The Darwin tools vary in their behavior when presented with an ISA
12576 mismatch. The assembler, @file{as}, only permits instructions to
12577 be used that are valid for the subtype of the file it is generating,
12578 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
12579 The linker for shared libraries, @file{/usr/bin/libtool}, fails
12580 and prints an error if asked to create a shared library with a less
12581 restrictive subtype than its input files (for instance, trying to put
12582 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
12583 for executables, @command{ld}, quietly gives the executable the most
12584 restrictive subtype of any of its input files.
12585
12586 @table @gcctabopt
12587 @item -F@var{dir}
12588 @opindex F
12589 Add the framework directory @var{dir} to the head of the list of
12590 directories to be searched for header files. These directories are
12591 interleaved with those specified by @option{-I} options and are
12592 scanned in a left-to-right order.
12593
12594 A framework directory is a directory with frameworks in it. A
12595 framework is a directory with a @file{Headers} and/or
12596 @file{PrivateHeaders} directory contained directly in it that ends
12597 in @file{.framework}. The name of a framework is the name of this
12598 directory excluding the @file{.framework}. Headers associated with
12599 the framework are found in one of those two directories, with
12600 @file{Headers} being searched first. A subframework is a framework
12601 directory that is in a framework's @file{Frameworks} directory.
12602 Includes of subframework headers can only appear in a header of a
12603 framework that contains the subframework, or in a sibling subframework
12604 header. Two subframeworks are siblings if they occur in the same
12605 framework. A subframework should not have the same name as a
12606 framework; a warning is issued if this is violated. Currently a
12607 subframework cannot have subframeworks; in the future, the mechanism
12608 may be extended to support this. The standard frameworks can be found
12609 in @file{/System/Library/Frameworks} and
12610 @file{/Library/Frameworks}. An example include looks like
12611 @code{#include <Framework/header.h>}, where @file{Framework} denotes
12612 the name of the framework and @file{header.h} is found in the
12613 @file{PrivateHeaders} or @file{Headers} directory.
12614
12615 @item -iframework@var{dir}
12616 @opindex iframework
12617 Like @option{-F} except the directory is a treated as a system
12618 directory. The main difference between this @option{-iframework} and
12619 @option{-F} is that with @option{-iframework} the compiler does not
12620 warn about constructs contained within header files found via
12621 @var{dir}. This option is valid only for the C family of languages.
12622
12623 @item -gused
12624 @opindex gused
12625 Emit debugging information for symbols that are used. For stabs
12626 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
12627 This is by default ON@.
12628
12629 @item -gfull
12630 @opindex gfull
12631 Emit debugging information for all symbols and types.
12632
12633 @item -mmacosx-version-min=@var{version}
12634 The earliest version of MacOS X that this executable will run on
12635 is @var{version}. Typical values of @var{version} include @code{10.1},
12636 @code{10.2}, and @code{10.3.9}.
12637
12638 If the compiler was built to use the system's headers by default,
12639 then the default for this option is the system version on which the
12640 compiler is running, otherwise the default is to make choices that
12641 are compatible with as many systems and code bases as possible.
12642
12643 @item -mkernel
12644 @opindex mkernel
12645 Enable kernel development mode. The @option{-mkernel} option sets
12646 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
12647 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
12648 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
12649 applicable. This mode also sets @option{-mno-altivec},
12650 @option{-msoft-float}, @option{-fno-builtin} and
12651 @option{-mlong-branch} for PowerPC targets.
12652
12653 @item -mone-byte-bool
12654 @opindex mone-byte-bool
12655 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12656 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12657 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12658 option has no effect on x86.
12659
12660 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12661 to generate code that is not binary compatible with code generated
12662 without that switch. Using this switch may require recompiling all
12663 other modules in a program, including system libraries. Use this
12664 switch to conform to a non-default data model.
12665
12666 @item -mfix-and-continue
12667 @itemx -ffix-and-continue
12668 @itemx -findirect-data
12669 @opindex mfix-and-continue
12670 @opindex ffix-and-continue
12671 @opindex findirect-data
12672 Generate code suitable for fast turnaround development, such as to
12673 allow GDB to dynamically load @code{.o} files into already-running
12674 programs. @option{-findirect-data} and @option{-ffix-and-continue}
12675 are provided for backwards compatibility.
12676
12677 @item -all_load
12678 @opindex all_load
12679 Loads all members of static archive libraries.
12680 See man ld(1) for more information.
12681
12682 @item -arch_errors_fatal
12683 @opindex arch_errors_fatal
12684 Cause the errors having to do with files that have the wrong architecture
12685 to be fatal.
12686
12687 @item -bind_at_load
12688 @opindex bind_at_load
12689 Causes the output file to be marked such that the dynamic linker will
12690 bind all undefined references when the file is loaded or launched.
12691
12692 @item -bundle
12693 @opindex bundle
12694 Produce a Mach-o bundle format file.
12695 See man ld(1) for more information.
12696
12697 @item -bundle_loader @var{executable}
12698 @opindex bundle_loader
12699 This option specifies the @var{executable} that will load the build
12700 output file being linked. See man ld(1) for more information.
12701
12702 @item -dynamiclib
12703 @opindex dynamiclib
12704 When passed this option, GCC produces a dynamic library instead of
12705 an executable when linking, using the Darwin @file{libtool} command.
12706
12707 @item -force_cpusubtype_ALL
12708 @opindex force_cpusubtype_ALL
12709 This causes GCC's output file to have the @var{ALL} subtype, instead of
12710 one controlled by the @option{-mcpu} or @option{-march} option.
12711
12712 @item -allowable_client @var{client_name}
12713 @itemx -client_name
12714 @itemx -compatibility_version
12715 @itemx -current_version
12716 @itemx -dead_strip
12717 @itemx -dependency-file
12718 @itemx -dylib_file
12719 @itemx -dylinker_install_name
12720 @itemx -dynamic
12721 @itemx -exported_symbols_list
12722 @itemx -filelist
12723 @need 800
12724 @itemx -flat_namespace
12725 @itemx -force_flat_namespace
12726 @itemx -headerpad_max_install_names
12727 @itemx -image_base
12728 @itemx -init
12729 @itemx -install_name
12730 @itemx -keep_private_externs
12731 @itemx -multi_module
12732 @itemx -multiply_defined
12733 @itemx -multiply_defined_unused
12734 @need 800
12735 @itemx -noall_load
12736 @itemx -no_dead_strip_inits_and_terms
12737 @itemx -nofixprebinding
12738 @itemx -nomultidefs
12739 @itemx -noprebind
12740 @itemx -noseglinkedit
12741 @itemx -pagezero_size
12742 @itemx -prebind
12743 @itemx -prebind_all_twolevel_modules
12744 @itemx -private_bundle
12745 @need 800
12746 @itemx -read_only_relocs
12747 @itemx -sectalign
12748 @itemx -sectobjectsymbols
12749 @itemx -whyload
12750 @itemx -seg1addr
12751 @itemx -sectcreate
12752 @itemx -sectobjectsymbols
12753 @itemx -sectorder
12754 @itemx -segaddr
12755 @itemx -segs_read_only_addr
12756 @need 800
12757 @itemx -segs_read_write_addr
12758 @itemx -seg_addr_table
12759 @itemx -seg_addr_table_filename
12760 @itemx -seglinkedit
12761 @itemx -segprot
12762 @itemx -segs_read_only_addr
12763 @itemx -segs_read_write_addr
12764 @itemx -single_module
12765 @itemx -static
12766 @itemx -sub_library
12767 @need 800
12768 @itemx -sub_umbrella
12769 @itemx -twolevel_namespace
12770 @itemx -umbrella
12771 @itemx -undefined
12772 @itemx -unexported_symbols_list
12773 @itemx -weak_reference_mismatches
12774 @itemx -whatsloaded
12775 @opindex allowable_client
12776 @opindex client_name
12777 @opindex compatibility_version
12778 @opindex current_version
12779 @opindex dead_strip
12780 @opindex dependency-file
12781 @opindex dylib_file
12782 @opindex dylinker_install_name
12783 @opindex dynamic
12784 @opindex exported_symbols_list
12785 @opindex filelist
12786 @opindex flat_namespace
12787 @opindex force_flat_namespace
12788 @opindex headerpad_max_install_names
12789 @opindex image_base
12790 @opindex init
12791 @opindex install_name
12792 @opindex keep_private_externs
12793 @opindex multi_module
12794 @opindex multiply_defined
12795 @opindex multiply_defined_unused
12796 @opindex noall_load
12797 @opindex no_dead_strip_inits_and_terms
12798 @opindex nofixprebinding
12799 @opindex nomultidefs
12800 @opindex noprebind
12801 @opindex noseglinkedit
12802 @opindex pagezero_size
12803 @opindex prebind
12804 @opindex prebind_all_twolevel_modules
12805 @opindex private_bundle
12806 @opindex read_only_relocs
12807 @opindex sectalign
12808 @opindex sectobjectsymbols
12809 @opindex whyload
12810 @opindex seg1addr
12811 @opindex sectcreate
12812 @opindex sectobjectsymbols
12813 @opindex sectorder
12814 @opindex segaddr
12815 @opindex segs_read_only_addr
12816 @opindex segs_read_write_addr
12817 @opindex seg_addr_table
12818 @opindex seg_addr_table_filename
12819 @opindex seglinkedit
12820 @opindex segprot
12821 @opindex segs_read_only_addr
12822 @opindex segs_read_write_addr
12823 @opindex single_module
12824 @opindex static
12825 @opindex sub_library
12826 @opindex sub_umbrella
12827 @opindex twolevel_namespace
12828 @opindex umbrella
12829 @opindex undefined
12830 @opindex unexported_symbols_list
12831 @opindex weak_reference_mismatches
12832 @opindex whatsloaded
12833 These options are passed to the Darwin linker. The Darwin linker man page
12834 describes them in detail.
12835 @end table
12836
12837 @node DEC Alpha Options
12838 @subsection DEC Alpha Options
12839
12840 These @samp{-m} options are defined for the DEC Alpha implementations:
12841
12842 @table @gcctabopt
12843 @item -mno-soft-float
12844 @itemx -msoft-float
12845 @opindex mno-soft-float
12846 @opindex msoft-float
12847 Use (do not use) the hardware floating-point instructions for
12848 floating-point operations. When @option{-msoft-float} is specified,
12849 functions in @file{libgcc.a} are used to perform floating-point
12850 operations. Unless they are replaced by routines that emulate the
12851 floating-point operations, or compiled in such a way as to call such
12852 emulations routines, these routines issue floating-point
12853 operations. If you are compiling for an Alpha without floating-point
12854 operations, you must ensure that the library is built so as not to call
12855 them.
12856
12857 Note that Alpha implementations without floating-point operations are
12858 required to have floating-point registers.
12859
12860 @item -mfp-reg
12861 @itemx -mno-fp-regs
12862 @opindex mfp-reg
12863 @opindex mno-fp-regs
12864 Generate code that uses (does not use) the floating-point register set.
12865 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
12866 register set is not used, floating-point operands are passed in integer
12867 registers as if they were integers and floating-point results are passed
12868 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
12869 so any function with a floating-point argument or return value called by code
12870 compiled with @option{-mno-fp-regs} must also be compiled with that
12871 option.
12872
12873 A typical use of this option is building a kernel that does not use,
12874 and hence need not save and restore, any floating-point registers.
12875
12876 @item -mieee
12877 @opindex mieee
12878 The Alpha architecture implements floating-point hardware optimized for
12879 maximum performance. It is mostly compliant with the IEEE floating-point
12880 standard. However, for full compliance, software assistance is
12881 required. This option generates code fully IEEE-compliant code
12882 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12883 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12884 defined during compilation. The resulting code is less efficient but is
12885 able to correctly support denormalized numbers and exceptional IEEE
12886 values such as not-a-number and plus/minus infinity. Other Alpha
12887 compilers call this option @option{-ieee_with_no_inexact}.
12888
12889 @item -mieee-with-inexact
12890 @opindex mieee-with-inexact
12891 This is like @option{-mieee} except the generated code also maintains
12892 the IEEE @var{inexact-flag}. Turning on this option causes the
12893 generated code to implement fully-compliant IEEE math. In addition to
12894 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12895 macro. On some Alpha implementations the resulting code may execute
12896 significantly slower than the code generated by default. Since there is
12897 very little code that depends on the @var{inexact-flag}, you should
12898 normally not specify this option. Other Alpha compilers call this
12899 option @option{-ieee_with_inexact}.
12900
12901 @item -mfp-trap-mode=@var{trap-mode}
12902 @opindex mfp-trap-mode
12903 This option controls what floating-point related traps are enabled.
12904 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12905 The trap mode can be set to one of four values:
12906
12907 @table @samp
12908 @item n
12909 This is the default (normal) setting. The only traps that are enabled
12910 are the ones that cannot be disabled in software (e.g., division by zero
12911 trap).
12912
12913 @item u
12914 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12915 as well.
12916
12917 @item su
12918 Like @samp{u}, but the instructions are marked to be safe for software
12919 completion (see Alpha architecture manual for details).
12920
12921 @item sui
12922 Like @samp{su}, but inexact traps are enabled as well.
12923 @end table
12924
12925 @item -mfp-rounding-mode=@var{rounding-mode}
12926 @opindex mfp-rounding-mode
12927 Selects the IEEE rounding mode. Other Alpha compilers call this option
12928 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
12929 of:
12930
12931 @table @samp
12932 @item n
12933 Normal IEEE rounding mode. Floating-point numbers are rounded towards
12934 the nearest machine number or towards the even machine number in case
12935 of a tie.
12936
12937 @item m
12938 Round towards minus infinity.
12939
12940 @item c
12941 Chopped rounding mode. Floating-point numbers are rounded towards zero.
12942
12943 @item d
12944 Dynamic rounding mode. A field in the floating-point control register
12945 (@var{fpcr}, see Alpha architecture reference manual) controls the
12946 rounding mode in effect. The C library initializes this register for
12947 rounding towards plus infinity. Thus, unless your program modifies the
12948 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12949 @end table
12950
12951 @item -mtrap-precision=@var{trap-precision}
12952 @opindex mtrap-precision
12953 In the Alpha architecture, floating-point traps are imprecise. This
12954 means without software assistance it is impossible to recover from a
12955 floating trap and program execution normally needs to be terminated.
12956 GCC can generate code that can assist operating system trap handlers
12957 in determining the exact location that caused a floating-point trap.
12958 Depending on the requirements of an application, different levels of
12959 precisions can be selected:
12960
12961 @table @samp
12962 @item p
12963 Program precision. This option is the default and means a trap handler
12964 can only identify which program caused a floating-point exception.
12965
12966 @item f
12967 Function precision. The trap handler can determine the function that
12968 caused a floating-point exception.
12969
12970 @item i
12971 Instruction precision. The trap handler can determine the exact
12972 instruction that caused a floating-point exception.
12973 @end table
12974
12975 Other Alpha compilers provide the equivalent options called
12976 @option{-scope_safe} and @option{-resumption_safe}.
12977
12978 @item -mieee-conformant
12979 @opindex mieee-conformant
12980 This option marks the generated code as IEEE conformant. You must not
12981 use this option unless you also specify @option{-mtrap-precision=i} and either
12982 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
12983 is to emit the line @samp{.eflag 48} in the function prologue of the
12984 generated assembly file.
12985
12986 @item -mbuild-constants
12987 @opindex mbuild-constants
12988 Normally GCC examines a 32- or 64-bit integer constant to
12989 see if it can construct it from smaller constants in two or three
12990 instructions. If it cannot, it outputs the constant as a literal and
12991 generates code to load it from the data segment at run time.
12992
12993 Use this option to require GCC to construct @emph{all} integer constants
12994 using code, even if it takes more instructions (the maximum is six).
12995
12996 You typically use this option to build a shared library dynamic
12997 loader. Itself a shared library, it must relocate itself in memory
12998 before it can find the variables and constants in its own data segment.
12999
13000 @item -mbwx
13001 @itemx -mno-bwx
13002 @itemx -mcix
13003 @itemx -mno-cix
13004 @itemx -mfix
13005 @itemx -mno-fix
13006 @itemx -mmax
13007 @itemx -mno-max
13008 @opindex mbwx
13009 @opindex mno-bwx
13010 @opindex mcix
13011 @opindex mno-cix
13012 @opindex mfix
13013 @opindex mno-fix
13014 @opindex mmax
13015 @opindex mno-max
13016 Indicate whether GCC should generate code to use the optional BWX,
13017 CIX, FIX and MAX instruction sets. The default is to use the instruction
13018 sets supported by the CPU type specified via @option{-mcpu=} option or that
13019 of the CPU on which GCC was built if none is specified.
13020
13021 @item -mfloat-vax
13022 @itemx -mfloat-ieee
13023 @opindex mfloat-vax
13024 @opindex mfloat-ieee
13025 Generate code that uses (does not use) VAX F and G floating-point
13026 arithmetic instead of IEEE single and double precision.
13027
13028 @item -mexplicit-relocs
13029 @itemx -mno-explicit-relocs
13030 @opindex mexplicit-relocs
13031 @opindex mno-explicit-relocs
13032 Older Alpha assemblers provided no way to generate symbol relocations
13033 except via assembler macros. Use of these macros does not allow
13034 optimal instruction scheduling. GNU binutils as of version 2.12
13035 supports a new syntax that allows the compiler to explicitly mark
13036 which relocations should apply to which instructions. This option
13037 is mostly useful for debugging, as GCC detects the capabilities of
13038 the assembler when it is built and sets the default accordingly.
13039
13040 @item -msmall-data
13041 @itemx -mlarge-data
13042 @opindex msmall-data
13043 @opindex mlarge-data
13044 When @option{-mexplicit-relocs} is in effect, static data is
13045 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
13046 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
13047 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
13048 16-bit relocations off of the @code{$gp} register. This limits the
13049 size of the small data area to 64KB, but allows the variables to be
13050 directly accessed via a single instruction.
13051
13052 The default is @option{-mlarge-data}. With this option the data area
13053 is limited to just below 2GB@. Programs that require more than 2GB of
13054 data must use @code{malloc} or @code{mmap} to allocate the data in the
13055 heap instead of in the program's data segment.
13056
13057 When generating code for shared libraries, @option{-fpic} implies
13058 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
13059
13060 @item -msmall-text
13061 @itemx -mlarge-text
13062 @opindex msmall-text
13063 @opindex mlarge-text
13064 When @option{-msmall-text} is used, the compiler assumes that the
13065 code of the entire program (or shared library) fits in 4MB, and is
13066 thus reachable with a branch instruction. When @option{-msmall-data}
13067 is used, the compiler can assume that all local symbols share the
13068 same @code{$gp} value, and thus reduce the number of instructions
13069 required for a function call from 4 to 1.
13070
13071 The default is @option{-mlarge-text}.
13072
13073 @item -mcpu=@var{cpu_type}
13074 @opindex mcpu
13075 Set the instruction set and instruction scheduling parameters for
13076 machine type @var{cpu_type}. You can specify either the @samp{EV}
13077 style name or the corresponding chip number. GCC supports scheduling
13078 parameters for the EV4, EV5 and EV6 family of processors and
13079 chooses the default values for the instruction set from the processor
13080 you specify. If you do not specify a processor type, GCC defaults
13081 to the processor on which the compiler was built.
13082
13083 Supported values for @var{cpu_type} are
13084
13085 @table @samp
13086 @item ev4
13087 @itemx ev45
13088 @itemx 21064
13089 Schedules as an EV4 and has no instruction set extensions.
13090
13091 @item ev5
13092 @itemx 21164
13093 Schedules as an EV5 and has no instruction set extensions.
13094
13095 @item ev56
13096 @itemx 21164a
13097 Schedules as an EV5 and supports the BWX extension.
13098
13099 @item pca56
13100 @itemx 21164pc
13101 @itemx 21164PC
13102 Schedules as an EV5 and supports the BWX and MAX extensions.
13103
13104 @item ev6
13105 @itemx 21264
13106 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
13107
13108 @item ev67
13109 @itemx 21264a
13110 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
13111 @end table
13112
13113 Native toolchains also support the value @samp{native},
13114 which selects the best architecture option for the host processor.
13115 @option{-mcpu=native} has no effect if GCC does not recognize
13116 the processor.
13117
13118 @item -mtune=@var{cpu_type}
13119 @opindex mtune
13120 Set only the instruction scheduling parameters for machine type
13121 @var{cpu_type}. The instruction set is not changed.
13122
13123 Native toolchains also support the value @samp{native},
13124 which selects the best architecture option for the host processor.
13125 @option{-mtune=native} has no effect if GCC does not recognize
13126 the processor.
13127
13128 @item -mmemory-latency=@var{time}
13129 @opindex mmemory-latency
13130 Sets the latency the scheduler should assume for typical memory
13131 references as seen by the application. This number is highly
13132 dependent on the memory access patterns used by the application
13133 and the size of the external cache on the machine.
13134
13135 Valid options for @var{time} are
13136
13137 @table @samp
13138 @item @var{number}
13139 A decimal number representing clock cycles.
13140
13141 @item L1
13142 @itemx L2
13143 @itemx L3
13144 @itemx main
13145 The compiler contains estimates of the number of clock cycles for
13146 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
13147 (also called Dcache, Scache, and Bcache), as well as to main memory.
13148 Note that L3 is only valid for EV5.
13149
13150 @end table
13151 @end table
13152
13153 @node FR30 Options
13154 @subsection FR30 Options
13155 @cindex FR30 Options
13156
13157 These options are defined specifically for the FR30 port.
13158
13159 @table @gcctabopt
13160
13161 @item -msmall-model
13162 @opindex msmall-model
13163 Use the small address space model. This can produce smaller code, but
13164 it does assume that all symbolic values and addresses fit into a
13165 20-bit range.
13166
13167 @item -mno-lsim
13168 @opindex mno-lsim
13169 Assume that runtime support has been provided and so there is no need
13170 to include the simulator library (@file{libsim.a}) on the linker
13171 command line.
13172
13173 @end table
13174
13175 @node FRV Options
13176 @subsection FRV Options
13177 @cindex FRV Options
13178
13179 @table @gcctabopt
13180 @item -mgpr-32
13181 @opindex mgpr-32
13182
13183 Only use the first 32 general-purpose registers.
13184
13185 @item -mgpr-64
13186 @opindex mgpr-64
13187
13188 Use all 64 general-purpose registers.
13189
13190 @item -mfpr-32
13191 @opindex mfpr-32
13192
13193 Use only the first 32 floating-point registers.
13194
13195 @item -mfpr-64
13196 @opindex mfpr-64
13197
13198 Use all 64 floating-point registers.
13199
13200 @item -mhard-float
13201 @opindex mhard-float
13202
13203 Use hardware instructions for floating-point operations.
13204
13205 @item -msoft-float
13206 @opindex msoft-float
13207
13208 Use library routines for floating-point operations.
13209
13210 @item -malloc-cc
13211 @opindex malloc-cc
13212
13213 Dynamically allocate condition code registers.
13214
13215 @item -mfixed-cc
13216 @opindex mfixed-cc
13217
13218 Do not try to dynamically allocate condition code registers, only
13219 use @code{icc0} and @code{fcc0}.
13220
13221 @item -mdword
13222 @opindex mdword
13223
13224 Change ABI to use double word insns.
13225
13226 @item -mno-dword
13227 @opindex mno-dword
13228
13229 Do not use double word instructions.
13230
13231 @item -mdouble
13232 @opindex mdouble
13233
13234 Use floating-point double instructions.
13235
13236 @item -mno-double
13237 @opindex mno-double
13238
13239 Do not use floating-point double instructions.
13240
13241 @item -mmedia
13242 @opindex mmedia
13243
13244 Use media instructions.
13245
13246 @item -mno-media
13247 @opindex mno-media
13248
13249 Do not use media instructions.
13250
13251 @item -mmuladd
13252 @opindex mmuladd
13253
13254 Use multiply and add/subtract instructions.
13255
13256 @item -mno-muladd
13257 @opindex mno-muladd
13258
13259 Do not use multiply and add/subtract instructions.
13260
13261 @item -mfdpic
13262 @opindex mfdpic
13263
13264 Select the FDPIC ABI, which uses function descriptors to represent
13265 pointers to functions. Without any PIC/PIE-related options, it
13266 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
13267 assumes GOT entries and small data are within a 12-bit range from the
13268 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
13269 are computed with 32 bits.
13270 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13271
13272 @item -minline-plt
13273 @opindex minline-plt
13274
13275 Enable inlining of PLT entries in function calls to functions that are
13276 not known to bind locally. It has no effect without @option{-mfdpic}.
13277 It's enabled by default if optimizing for speed and compiling for
13278 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
13279 optimization option such as @option{-O3} or above is present in the
13280 command line.
13281
13282 @item -mTLS
13283 @opindex mTLS
13284
13285 Assume a large TLS segment when generating thread-local code.
13286
13287 @item -mtls
13288 @opindex mtls
13289
13290 Do not assume a large TLS segment when generating thread-local code.
13291
13292 @item -mgprel-ro
13293 @opindex mgprel-ro
13294
13295 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
13296 that is known to be in read-only sections. It's enabled by default,
13297 except for @option{-fpic} or @option{-fpie}: even though it may help
13298 make the global offset table smaller, it trades 1 instruction for 4.
13299 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
13300 one of which may be shared by multiple symbols, and it avoids the need
13301 for a GOT entry for the referenced symbol, so it's more likely to be a
13302 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
13303
13304 @item -multilib-library-pic
13305 @opindex multilib-library-pic
13306
13307 Link with the (library, not FD) pic libraries. It's implied by
13308 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
13309 @option{-fpic} without @option{-mfdpic}. You should never have to use
13310 it explicitly.
13311
13312 @item -mlinked-fp
13313 @opindex mlinked-fp
13314
13315 Follow the EABI requirement of always creating a frame pointer whenever
13316 a stack frame is allocated. This option is enabled by default and can
13317 be disabled with @option{-mno-linked-fp}.
13318
13319 @item -mlong-calls
13320 @opindex mlong-calls
13321
13322 Use indirect addressing to call functions outside the current
13323 compilation unit. This allows the functions to be placed anywhere
13324 within the 32-bit address space.
13325
13326 @item -malign-labels
13327 @opindex malign-labels
13328
13329 Try to align labels to an 8-byte boundary by inserting NOPs into the
13330 previous packet. This option only has an effect when VLIW packing
13331 is enabled. It doesn't create new packets; it merely adds NOPs to
13332 existing ones.
13333
13334 @item -mlibrary-pic
13335 @opindex mlibrary-pic
13336
13337 Generate position-independent EABI code.
13338
13339 @item -macc-4
13340 @opindex macc-4
13341
13342 Use only the first four media accumulator registers.
13343
13344 @item -macc-8
13345 @opindex macc-8
13346
13347 Use all eight media accumulator registers.
13348
13349 @item -mpack
13350 @opindex mpack
13351
13352 Pack VLIW instructions.
13353
13354 @item -mno-pack
13355 @opindex mno-pack
13356
13357 Do not pack VLIW instructions.
13358
13359 @item -mno-eflags
13360 @opindex mno-eflags
13361
13362 Do not mark ABI switches in e_flags.
13363
13364 @item -mcond-move
13365 @opindex mcond-move
13366
13367 Enable the use of conditional-move instructions (default).
13368
13369 This switch is mainly for debugging the compiler and will likely be removed
13370 in a future version.
13371
13372 @item -mno-cond-move
13373 @opindex mno-cond-move
13374
13375 Disable the use of conditional-move instructions.
13376
13377 This switch is mainly for debugging the compiler and will likely be removed
13378 in a future version.
13379
13380 @item -mscc
13381 @opindex mscc
13382
13383 Enable the use of conditional set instructions (default).
13384
13385 This switch is mainly for debugging the compiler and will likely be removed
13386 in a future version.
13387
13388 @item -mno-scc
13389 @opindex mno-scc
13390
13391 Disable the use of conditional set instructions.
13392
13393 This switch is mainly for debugging the compiler and will likely be removed
13394 in a future version.
13395
13396 @item -mcond-exec
13397 @opindex mcond-exec
13398
13399 Enable the use of conditional execution (default).
13400
13401 This switch is mainly for debugging the compiler and will likely be removed
13402 in a future version.
13403
13404 @item -mno-cond-exec
13405 @opindex mno-cond-exec
13406
13407 Disable the use of conditional execution.
13408
13409 This switch is mainly for debugging the compiler and will likely be removed
13410 in a future version.
13411
13412 @item -mvliw-branch
13413 @opindex mvliw-branch
13414
13415 Run a pass to pack branches into VLIW instructions (default).
13416
13417 This switch is mainly for debugging the compiler and will likely be removed
13418 in a future version.
13419
13420 @item -mno-vliw-branch
13421 @opindex mno-vliw-branch
13422
13423 Do not run a pass to pack branches into VLIW instructions.
13424
13425 This switch is mainly for debugging the compiler and will likely be removed
13426 in a future version.
13427
13428 @item -mmulti-cond-exec
13429 @opindex mmulti-cond-exec
13430
13431 Enable optimization of @code{&&} and @code{||} in conditional execution
13432 (default).
13433
13434 This switch is mainly for debugging the compiler and will likely be removed
13435 in a future version.
13436
13437 @item -mno-multi-cond-exec
13438 @opindex mno-multi-cond-exec
13439
13440 Disable optimization of @code{&&} and @code{||} in conditional execution.
13441
13442 This switch is mainly for debugging the compiler and will likely be removed
13443 in a future version.
13444
13445 @item -mnested-cond-exec
13446 @opindex mnested-cond-exec
13447
13448 Enable nested conditional execution optimizations (default).
13449
13450 This switch is mainly for debugging the compiler and will likely be removed
13451 in a future version.
13452
13453 @item -mno-nested-cond-exec
13454 @opindex mno-nested-cond-exec
13455
13456 Disable nested conditional execution optimizations.
13457
13458 This switch is mainly for debugging the compiler and will likely be removed
13459 in a future version.
13460
13461 @item -moptimize-membar
13462 @opindex moptimize-membar
13463
13464 This switch removes redundant @code{membar} instructions from the
13465 compiler-generated code. It is enabled by default.
13466
13467 @item -mno-optimize-membar
13468 @opindex mno-optimize-membar
13469
13470 This switch disables the automatic removal of redundant @code{membar}
13471 instructions from the generated code.
13472
13473 @item -mtomcat-stats
13474 @opindex mtomcat-stats
13475
13476 Cause gas to print out tomcat statistics.
13477
13478 @item -mcpu=@var{cpu}
13479 @opindex mcpu
13480
13481 Select the processor type for which to generate code. Possible values are
13482 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
13483 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
13484
13485 @end table
13486
13487 @node GNU/Linux Options
13488 @subsection GNU/Linux Options
13489
13490 These @samp{-m} options are defined for GNU/Linux targets:
13491
13492 @table @gcctabopt
13493 @item -mglibc
13494 @opindex mglibc
13495 Use the GNU C library. This is the default except
13496 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
13497
13498 @item -muclibc
13499 @opindex muclibc
13500 Use uClibc C library. This is the default on
13501 @samp{*-*-linux-*uclibc*} targets.
13502
13503 @item -mbionic
13504 @opindex mbionic
13505 Use Bionic C library. This is the default on
13506 @samp{*-*-linux-*android*} targets.
13507
13508 @item -mandroid
13509 @opindex mandroid
13510 Compile code compatible with Android platform. This is the default on
13511 @samp{*-*-linux-*android*} targets.
13512
13513 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
13514 @option{-fno-exceptions} and @option{-fno-rtti} by default. When linking,
13515 this option makes the GCC driver pass Android-specific options to the linker.
13516 Finally, this option causes the preprocessor macro @code{__ANDROID__}
13517 to be defined.
13518
13519 @item -tno-android-cc
13520 @opindex tno-android-cc
13521 Disable compilation effects of @option{-mandroid}, i.e., do not enable
13522 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
13523 @option{-fno-rtti} by default.
13524
13525 @item -tno-android-ld
13526 @opindex tno-android-ld
13527 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
13528 linking options to the linker.
13529
13530 @end table
13531
13532 @node H8/300 Options
13533 @subsection H8/300 Options
13534
13535 These @samp{-m} options are defined for the H8/300 implementations:
13536
13537 @table @gcctabopt
13538 @item -mrelax
13539 @opindex mrelax
13540 Shorten some address references at link time, when possible; uses the
13541 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
13542 ld, Using ld}, for a fuller description.
13543
13544 @item -mh
13545 @opindex mh
13546 Generate code for the H8/300H@.
13547
13548 @item -ms
13549 @opindex ms
13550 Generate code for the H8S@.
13551
13552 @item -mn
13553 @opindex mn
13554 Generate code for the H8S and H8/300H in the normal mode. This switch
13555 must be used either with @option{-mh} or @option{-ms}.
13556
13557 @item -ms2600
13558 @opindex ms2600
13559 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
13560
13561 @item -mexr
13562 @opindex mexr
13563 Extended registers are stored on stack before execution of function
13564 with monitor attribute. Default option is @option{-mexr}.
13565 This option is valid only for H8S targets.
13566
13567 @item -mno-exr
13568 @opindex mno-exr
13569 Extended registers are not stored on stack before execution of function
13570 with monitor attribute. Default option is @option{-mno-exr}.
13571 This option is valid only for H8S targets.
13572
13573 @item -mint32
13574 @opindex mint32
13575 Make @code{int} data 32 bits by default.
13576
13577 @item -malign-300
13578 @opindex malign-300
13579 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
13580 The default for the H8/300H and H8S is to align longs and floats on
13581 4-byte boundaries.
13582 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
13583 This option has no effect on the H8/300.
13584 @end table
13585
13586 @node HPPA Options
13587 @subsection HPPA Options
13588 @cindex HPPA Options
13589
13590 These @samp{-m} options are defined for the HPPA family of computers:
13591
13592 @table @gcctabopt
13593 @item -march=@var{architecture-type}
13594 @opindex march
13595 Generate code for the specified architecture. The choices for
13596 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
13597 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
13598 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
13599 architecture option for your machine. Code compiled for lower numbered
13600 architectures runs on higher numbered architectures, but not the
13601 other way around.
13602
13603 @item -mpa-risc-1-0
13604 @itemx -mpa-risc-1-1
13605 @itemx -mpa-risc-2-0
13606 @opindex mpa-risc-1-0
13607 @opindex mpa-risc-1-1
13608 @opindex mpa-risc-2-0
13609 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
13610
13611 @item -mjump-in-delay
13612 @opindex mjump-in-delay
13613 Fill delay slots of function calls with unconditional jump instructions
13614 by modifying the return pointer for the function call to be the target
13615 of the conditional jump.
13616
13617 @item -mdisable-fpregs
13618 @opindex mdisable-fpregs
13619 Prevent floating-point registers from being used in any manner. This is
13620 necessary for compiling kernels that perform lazy context switching of
13621 floating-point registers. If you use this option and attempt to perform
13622 floating-point operations, the compiler aborts.
13623
13624 @item -mdisable-indexing
13625 @opindex mdisable-indexing
13626 Prevent the compiler from using indexing address modes. This avoids some
13627 rather obscure problems when compiling MIG generated code under MACH@.
13628
13629 @item -mno-space-regs
13630 @opindex mno-space-regs
13631 Generate code that assumes the target has no space registers. This allows
13632 GCC to generate faster indirect calls and use unscaled index address modes.
13633
13634 Such code is suitable for level 0 PA systems and kernels.
13635
13636 @item -mfast-indirect-calls
13637 @opindex mfast-indirect-calls
13638 Generate code that assumes calls never cross space boundaries. This
13639 allows GCC to emit code that performs faster indirect calls.
13640
13641 This option does not work in the presence of shared libraries or nested
13642 functions.
13643
13644 @item -mfixed-range=@var{register-range}
13645 @opindex mfixed-range
13646 Generate code treating the given register range as fixed registers.
13647 A fixed register is one that the register allocator cannot use. This is
13648 useful when compiling kernel code. A register range is specified as
13649 two registers separated by a dash. Multiple register ranges can be
13650 specified separated by a comma.
13651
13652 @item -mlong-load-store
13653 @opindex mlong-load-store
13654 Generate 3-instruction load and store sequences as sometimes required by
13655 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
13656 the HP compilers.
13657
13658 @item -mportable-runtime
13659 @opindex mportable-runtime
13660 Use the portable calling conventions proposed by HP for ELF systems.
13661
13662 @item -mgas
13663 @opindex mgas
13664 Enable the use of assembler directives only GAS understands.
13665
13666 @item -mschedule=@var{cpu-type}
13667 @opindex mschedule
13668 Schedule code according to the constraints for the machine type
13669 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
13670 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
13671 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13672 proper scheduling option for your machine. The default scheduling is
13673 @samp{8000}.
13674
13675 @item -mlinker-opt
13676 @opindex mlinker-opt
13677 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
13678 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
13679 linkers in which they give bogus error messages when linking some programs.
13680
13681 @item -msoft-float
13682 @opindex msoft-float
13683 Generate output containing library calls for floating point.
13684 @strong{Warning:} the requisite libraries are not available for all HPPA
13685 targets. Normally the facilities of the machine's usual C compiler are
13686 used, but this cannot be done directly in cross-compilation. You must make
13687 your own arrangements to provide suitable library functions for
13688 cross-compilation.
13689
13690 @option{-msoft-float} changes the calling convention in the output file;
13691 therefore, it is only useful if you compile @emph{all} of a program with
13692 this option. In particular, you need to compile @file{libgcc.a}, the
13693 library that comes with GCC, with @option{-msoft-float} in order for
13694 this to work.
13695
13696 @item -msio
13697 @opindex msio
13698 Generate the predefine, @code{_SIO}, for server IO@. The default is
13699 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
13700 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
13701 options are available under HP-UX and HI-UX@.
13702
13703 @item -mgnu-ld
13704 @opindex mgnu-ld
13705 Use options specific to GNU @command{ld}.
13706 This passes @option{-shared} to @command{ld} when
13707 building a shared library. It is the default when GCC is configured,
13708 explicitly or implicitly, with the GNU linker. This option does not
13709 affect which @command{ld} is called; it only changes what parameters
13710 are passed to that @command{ld}.
13711 The @command{ld} that is called is determined by the
13712 @option{--with-ld} configure option, GCC's program search path, and
13713 finally by the user's @env{PATH}. The linker used by GCC can be printed
13714 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
13715 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13716
13717 @item -mhp-ld
13718 @opindex mhp-ld
13719 Use options specific to HP @command{ld}.
13720 This passes @option{-b} to @command{ld} when building
13721 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13722 links. It is the default when GCC is configured, explicitly or
13723 implicitly, with the HP linker. This option does not affect
13724 which @command{ld} is called; it only changes what parameters are passed to that
13725 @command{ld}.
13726 The @command{ld} that is called is determined by the @option{--with-ld}
13727 configure option, GCC's program search path, and finally by the user's
13728 @env{PATH}. The linker used by GCC can be printed using @samp{which
13729 `gcc -print-prog-name=ld`}. This option is only available on the 64-bit
13730 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13731
13732 @item -mlong-calls
13733 @opindex mno-long-calls
13734 Generate code that uses long call sequences. This ensures that a call
13735 is always able to reach linker generated stubs. The default is to generate
13736 long calls only when the distance from the call site to the beginning
13737 of the function or translation unit, as the case may be, exceeds a
13738 predefined limit set by the branch type being used. The limits for
13739 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13740 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
13741 240,000 bytes.
13742
13743 Distances are measured from the beginning of functions when using the
13744 @option{-ffunction-sections} option, or when using the @option{-mgas}
13745 and @option{-mno-portable-runtime} options together under HP-UX with
13746 the SOM linker.
13747
13748 It is normally not desirable to use this option as it degrades
13749 performance. However, it may be useful in large applications,
13750 particularly when partial linking is used to build the application.
13751
13752 The types of long calls used depends on the capabilities of the
13753 assembler and linker, and the type of code being generated. The
13754 impact on systems that support long absolute calls, and long pic
13755 symbol-difference or pc-relative calls should be relatively small.
13756 However, an indirect call is used on 32-bit ELF systems in pic code
13757 and it is quite long.
13758
13759 @item -munix=@var{unix-std}
13760 @opindex march
13761 Generate compiler predefines and select a startfile for the specified
13762 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
13763 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
13764 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
13765 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
13766 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13767 and later.
13768
13769 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13770 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13771 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13772 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13773 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13774 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13775
13776 It is @emph{important} to note that this option changes the interfaces
13777 for various library routines. It also affects the operational behavior
13778 of the C library. Thus, @emph{extreme} care is needed in using this
13779 option.
13780
13781 Library code that is intended to operate with more than one UNIX
13782 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13783 as appropriate. Most GNU software doesn't provide this capability.
13784
13785 @item -nolibdld
13786 @opindex nolibdld
13787 Suppress the generation of link options to search libdld.sl when the
13788 @option{-static} option is specified on HP-UX 10 and later.
13789
13790 @item -static
13791 @opindex static
13792 The HP-UX implementation of setlocale in libc has a dependency on
13793 libdld.sl. There isn't an archive version of libdld.sl. Thus,
13794 when the @option{-static} option is specified, special link options
13795 are needed to resolve this dependency.
13796
13797 On HP-UX 10 and later, the GCC driver adds the necessary options to
13798 link with libdld.sl when the @option{-static} option is specified.
13799 This causes the resulting binary to be dynamic. On the 64-bit port,
13800 the linkers generate dynamic binaries by default in any case. The
13801 @option{-nolibdld} option can be used to prevent the GCC driver from
13802 adding these link options.
13803
13804 @item -threads
13805 @opindex threads
13806 Add support for multithreading with the @dfn{dce thread} library
13807 under HP-UX@. This option sets flags for both the preprocessor and
13808 linker.
13809 @end table
13810
13811 @node i386 and x86-64 Options
13812 @subsection Intel 386 and AMD x86-64 Options
13813 @cindex i386 Options
13814 @cindex x86-64 Options
13815 @cindex Intel 386 Options
13816 @cindex AMD x86-64 Options
13817
13818 These @samp{-m} options are defined for the i386 and x86-64 family of
13819 computers:
13820
13821 @table @gcctabopt
13822
13823 @item -march=@var{cpu-type}
13824 @opindex march
13825 Generate instructions for the machine type @var{cpu-type}. In contrast to
13826 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code
13827 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13828 to generate code that may not run at all on processors other than the one
13829 indicated. Specifying @option{-march=@var{cpu-type}} implies
13830 @option{-mtune=@var{cpu-type}}.
13831
13832 The choices for @var{cpu-type} are:
13833
13834 @table @samp
13835 @item native
13836 This selects the CPU to generate code for at compilation time by determining
13837 the processor type of the compiling machine. Using @option{-march=native}
13838 enables all instruction subsets supported by the local machine (hence
13839 the result might not run on different machines). Using @option{-mtune=native}
13840 produces code optimized for the local machine under the constraints
13841 of the selected instruction set.
13842
13843 @item i386
13844 Original Intel i386 CPU@.
13845
13846 @item i486
13847 Intel i486 CPU@. (No scheduling is implemented for this chip.)
13848
13849 @item i586
13850 @itemx pentium
13851 Intel Pentium CPU with no MMX support.
13852
13853 @item pentium-mmx
13854 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13855
13856 @item pentiumpro
13857 Intel Pentium Pro CPU@.
13858
13859 @item i686
13860 When used with @option{-march}, the Pentium Pro
13861 instruction set is used, so the code runs on all i686 family chips.
13862 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13863
13864 @item pentium2
13865 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13866 support.
13867
13868 @item pentium3
13869 @itemx pentium3m
13870 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13871 set support.
13872
13873 @item pentium-m
13874 Intel Pentium M; low-power version of Intel Pentium III CPU
13875 with MMX, SSE and SSE2 instruction set support. Used by Centrino notebooks.
13876
13877 @item pentium4
13878 @itemx pentium4m
13879 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13880
13881 @item prescott
13882 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13883 set support.
13884
13885 @item nocona
13886 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13887 SSE2 and SSE3 instruction set support.
13888
13889 @item core2
13890 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13891 instruction set support.
13892
13893 @item corei7
13894 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13895 and SSE4.2 instruction set support.
13896
13897 @item corei7-avx
13898 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13899 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13900
13901 @item core-avx-i
13902 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13903 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13904 set support.
13905
13906 @item core-avx2
13907 Intel Core CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
13908 SSE4.1, SSE4.2, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2
13909 and F16C instruction set support.
13910
13911 @item atom
13912 Intel Atom CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
13913 instruction set support.
13914
13915 @item slm
13916 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
13917 SSE4.1 and SSE4.2 instruction set support.
13918
13919 @item k6
13920 AMD K6 CPU with MMX instruction set support.
13921
13922 @item k6-2
13923 @itemx k6-3
13924 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13925
13926 @item athlon
13927 @itemx athlon-tbird
13928 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13929 support.
13930
13931 @item athlon-4
13932 @itemx athlon-xp
13933 @itemx athlon-mp
13934 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13935 instruction set support.
13936
13937 @item k8
13938 @itemx opteron
13939 @itemx athlon64
13940 @itemx athlon-fx
13941 Processors based on the AMD K8 core with x86-64 instruction set support,
13942 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13943 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13944 instruction set extensions.)
13945
13946 @item k8-sse3
13947 @itemx opteron-sse3
13948 @itemx athlon64-sse3
13949 Improved versions of AMD K8 cores with SSE3 instruction set support.
13950
13951 @item amdfam10
13952 @itemx barcelona
13953 CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This
13954 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13955 instruction set extensions.)
13956
13957 @item bdver1
13958 CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This
13959 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13960 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13961 @item bdver2
13962 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
13963 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13964 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set
13965 extensions.)
13966 @item bdver3
13967 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
13968 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13969 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set
13970 extensions.
13971
13972 @item btver1
13973 CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This
13974 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13975 instruction set extensions.)
13976
13977 @item btver2
13978 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13979 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13980 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13981
13982 @item winchip-c6
13983 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13984 set support.
13985
13986 @item winchip2
13987 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13988 instruction set support.
13989
13990 @item c3
13991 VIA C3 CPU with MMX and 3DNow!@: instruction set support. (No scheduling is
13992 implemented for this chip.)
13993
13994 @item c3-2
13995 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13996 (No scheduling is
13997 implemented for this chip.)
13998
13999 @item geode
14000 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
14001 @end table
14002
14003 @item -mtune=@var{cpu-type}
14004 @opindex mtune
14005 Tune to @var{cpu-type} everything applicable about the generated code, except
14006 for the ABI and the set of available instructions.
14007 While picking a specific @var{cpu-type} schedules things appropriately
14008 for that particular chip, the compiler does not generate any code that
14009 cannot run on the default machine type unless you use a
14010 @option{-march=@var{cpu-type}} option.
14011 For example, if GCC is configured for i686-pc-linux-gnu
14012 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
14013 but still runs on i686 machines.
14014
14015 The choices for @var{cpu-type} are the same as for @option{-march}.
14016 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
14017
14018 @table @samp
14019 @item generic
14020 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
14021 If you know the CPU on which your code will run, then you should use
14022 the corresponding @option{-mtune} or @option{-march} option instead of
14023 @option{-mtune=generic}. But, if you do not know exactly what CPU users
14024 of your application will have, then you should use this option.
14025
14026 As new processors are deployed in the marketplace, the behavior of this
14027 option will change. Therefore, if you upgrade to a newer version of
14028 GCC, code generation controlled by this option will change to reflect
14029 the processors
14030 that are most common at the time that version of GCC is released.
14031
14032 There is no @option{-march=generic} option because @option{-march}
14033 indicates the instruction set the compiler can use, and there is no
14034 generic instruction set applicable to all processors. In contrast,
14035 @option{-mtune} indicates the processor (or, in this case, collection of
14036 processors) for which the code is optimized.
14037 @end table
14038
14039 @item -mcpu=@var{cpu-type}
14040 @opindex mcpu
14041 A deprecated synonym for @option{-mtune}.
14042
14043 @item -mfpmath=@var{unit}
14044 @opindex mfpmath
14045 Generate floating-point arithmetic for selected unit @var{unit}. The choices
14046 for @var{unit} are:
14047
14048 @table @samp
14049 @item 387
14050 Use the standard 387 floating-point coprocessor present on the majority of chips and
14051 emulated otherwise. Code compiled with this option runs almost everywhere.
14052 The temporary results are computed in 80-bit precision instead of the precision
14053 specified by the type, resulting in slightly different results compared to most
14054 of other chips. See @option{-ffloat-store} for more detailed description.
14055
14056 This is the default choice for i386 compiler.
14057
14058 @item sse
14059 Use scalar floating-point instructions present in the SSE instruction set.
14060 This instruction set is supported by Pentium III and newer chips,
14061 and in the AMD line
14062 by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE
14063 instruction set supports only single-precision arithmetic, thus the double and
14064 extended-precision arithmetic are still done using 387. A later version, present
14065 only in Pentium 4 and AMD x86-64 chips, supports double-precision
14066 arithmetic too.
14067
14068 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
14069 or @option{-msse2} switches to enable SSE extensions and make this option
14070 effective. For the x86-64 compiler, these extensions are enabled by default.
14071
14072 The resulting code should be considerably faster in the majority of cases and avoid
14073 the numerical instability problems of 387 code, but may break some existing
14074 code that expects temporaries to be 80 bits.
14075
14076 This is the default choice for the x86-64 compiler.
14077
14078 @item sse,387
14079 @itemx sse+387
14080 @itemx both
14081 Attempt to utilize both instruction sets at once. This effectively doubles the
14082 amount of available registers, and on chips with separate execution units for
14083 387 and SSE the execution resources too. Use this option with care, as it is
14084 still experimental, because the GCC register allocator does not model separate
14085 functional units well, resulting in unstable performance.
14086 @end table
14087
14088 @item -masm=@var{dialect}
14089 @opindex masm=@var{dialect}
14090 Output assembly instructions using selected @var{dialect}. Supported
14091 choices are @samp{intel} or @samp{att} (the default). Darwin does
14092 not support @samp{intel}.
14093
14094 @item -mieee-fp
14095 @itemx -mno-ieee-fp
14096 @opindex mieee-fp
14097 @opindex mno-ieee-fp
14098 Control whether or not the compiler uses IEEE floating-point
14099 comparisons. These correctly handle the case where the result of a
14100 comparison is unordered.
14101
14102 @item -msoft-float
14103 @opindex msoft-float
14104 Generate output containing library calls for floating point.
14105
14106 @strong{Warning:} the requisite libraries are not part of GCC@.
14107 Normally the facilities of the machine's usual C compiler are used, but
14108 this can't be done directly in cross-compilation. You must make your
14109 own arrangements to provide suitable library functions for
14110 cross-compilation.
14111
14112 On machines where a function returns floating-point results in the 80387
14113 register stack, some floating-point opcodes may be emitted even if
14114 @option{-msoft-float} is used.
14115
14116 @item -mno-fp-ret-in-387
14117 @opindex mno-fp-ret-in-387
14118 Do not use the FPU registers for return values of functions.
14119
14120 The usual calling convention has functions return values of types
14121 @code{float} and @code{double} in an FPU register, even if there
14122 is no FPU@. The idea is that the operating system should emulate
14123 an FPU@.
14124
14125 The option @option{-mno-fp-ret-in-387} causes such values to be returned
14126 in ordinary CPU registers instead.
14127
14128 @item -mno-fancy-math-387
14129 @opindex mno-fancy-math-387
14130 Some 387 emulators do not support the @code{sin}, @code{cos} and
14131 @code{sqrt} instructions for the 387. Specify this option to avoid
14132 generating those instructions. This option is the default on FreeBSD,
14133 OpenBSD and NetBSD@. This option is overridden when @option{-march}
14134 indicates that the target CPU always has an FPU and so the
14135 instruction does not need emulation. These
14136 instructions are not generated unless you also use the
14137 @option{-funsafe-math-optimizations} switch.
14138
14139 @item -malign-double
14140 @itemx -mno-align-double
14141 @opindex malign-double
14142 @opindex mno-align-double
14143 Control whether GCC aligns @code{double}, @code{long double}, and
14144 @code{long long} variables on a two-word boundary or a one-word
14145 boundary. Aligning @code{double} variables on a two-word boundary
14146 produces code that runs somewhat faster on a Pentium at the
14147 expense of more memory.
14148
14149 On x86-64, @option{-malign-double} is enabled by default.
14150
14151 @strong{Warning:} if you use the @option{-malign-double} switch,
14152 structures containing the above types are aligned differently than
14153 the published application binary interface specifications for the 386
14154 and are not binary compatible with structures in code compiled
14155 without that switch.
14156
14157 @item -m96bit-long-double
14158 @itemx -m128bit-long-double
14159 @opindex m96bit-long-double
14160 @opindex m128bit-long-double
14161 These switches control the size of @code{long double} type. The i386
14162 application binary interface specifies the size to be 96 bits,
14163 so @option{-m96bit-long-double} is the default in 32-bit mode.
14164
14165 Modern architectures (Pentium and newer) prefer @code{long double}
14166 to be aligned to an 8- or 16-byte boundary. In arrays or structures
14167 conforming to the ABI, this is not possible. So specifying
14168 @option{-m128bit-long-double} aligns @code{long double}
14169 to a 16-byte boundary by padding the @code{long double} with an additional
14170 32-bit zero.
14171
14172 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
14173 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
14174
14175 Notice that neither of these options enable any extra precision over the x87
14176 standard of 80 bits for a @code{long double}.
14177
14178 @strong{Warning:} if you override the default value for your target ABI, this
14179 changes the size of
14180 structures and arrays containing @code{long double} variables,
14181 as well as modifying the function calling convention for functions taking
14182 @code{long double}. Hence they are not binary-compatible
14183 with code compiled without that switch.
14184
14185 @item -mlong-double-64
14186 @itemx -mlong-double-80
14187 @opindex mlong-double-64
14188 @opindex mlong-double-80
14189 These switches control the size of @code{long double} type. A size
14190 of 64 bits makes the @code{long double} type equivalent to the @code{double}
14191 type. This is the default for Bionic C library.
14192
14193 @strong{Warning:} if you override the default value for your target ABI, this
14194 changes the size of
14195 structures and arrays containing @code{long double} variables,
14196 as well as modifying the function calling convention for functions taking
14197 @code{long double}. Hence they are not binary-compatible
14198 with code compiled without that switch.
14199
14200 @item -mlarge-data-threshold=@var{threshold}
14201 @opindex mlarge-data-threshold
14202 When @option{-mcmodel=medium} is specified, data objects larger than
14203 @var{threshold} are placed in the large data section. This value must be the
14204 same across all objects linked into the binary, and defaults to 65535.
14205
14206 @item -mrtd
14207 @opindex mrtd
14208 Use a different function-calling convention, in which functions that
14209 take a fixed number of arguments return with the @code{ret @var{num}}
14210 instruction, which pops their arguments while returning. This saves one
14211 instruction in the caller since there is no need to pop the arguments
14212 there.
14213
14214 You can specify that an individual function is called with this calling
14215 sequence with the function attribute @samp{stdcall}. You can also
14216 override the @option{-mrtd} option by using the function attribute
14217 @samp{cdecl}. @xref{Function Attributes}.
14218
14219 @strong{Warning:} this calling convention is incompatible with the one
14220 normally used on Unix, so you cannot use it if you need to call
14221 libraries compiled with the Unix compiler.
14222
14223 Also, you must provide function prototypes for all functions that
14224 take variable numbers of arguments (including @code{printf});
14225 otherwise incorrect code is generated for calls to those
14226 functions.
14227
14228 In addition, seriously incorrect code results if you call a
14229 function with too many arguments. (Normally, extra arguments are
14230 harmlessly ignored.)
14231
14232 @item -mregparm=@var{num}
14233 @opindex mregparm
14234 Control how many registers are used to pass integer arguments. By
14235 default, no registers are used to pass arguments, and at most 3
14236 registers can be used. You can control this behavior for a specific
14237 function by using the function attribute @samp{regparm}.
14238 @xref{Function Attributes}.
14239
14240 @strong{Warning:} if you use this switch, and
14241 @var{num} is nonzero, then you must build all modules with the same
14242 value, including any libraries. This includes the system libraries and
14243 startup modules.
14244
14245 @item -msseregparm
14246 @opindex msseregparm
14247 Use SSE register passing conventions for float and double arguments
14248 and return values. You can control this behavior for a specific
14249 function by using the function attribute @samp{sseregparm}.
14250 @xref{Function Attributes}.
14251
14252 @strong{Warning:} if you use this switch then you must build all
14253 modules with the same value, including any libraries. This includes
14254 the system libraries and startup modules.
14255
14256 @item -mvect8-ret-in-mem
14257 @opindex mvect8-ret-in-mem
14258 Return 8-byte vectors in memory instead of MMX registers. This is the
14259 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
14260 Studio compilers until version 12. Later compiler versions (starting
14261 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
14262 is the default on Solaris@tie{}10 and later. @emph{Only} use this option if
14263 you need to remain compatible with existing code produced by those
14264 previous compiler versions or older versions of GCC@.
14265
14266 @item -mpc32
14267 @itemx -mpc64
14268 @itemx -mpc80
14269 @opindex mpc32
14270 @opindex mpc64
14271 @opindex mpc80
14272
14273 Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32}
14274 is specified, the significands of results of floating-point operations are
14275 rounded to 24 bits (single precision); @option{-mpc64} rounds the
14276 significands of results of floating-point operations to 53 bits (double
14277 precision) and @option{-mpc80} rounds the significands of results of
14278 floating-point operations to 64 bits (extended double precision), which is
14279 the default. When this option is used, floating-point operations in higher
14280 precisions are not available to the programmer without setting the FPU
14281 control word explicitly.
14282
14283 Setting the rounding of floating-point operations to less than the default
14284 80 bits can speed some programs by 2% or more. Note that some mathematical
14285 libraries assume that extended-precision (80-bit) floating-point operations
14286 are enabled by default; routines in such libraries could suffer significant
14287 loss of accuracy, typically through so-called ``catastrophic cancellation'',
14288 when this option is used to set the precision to less than extended precision.
14289
14290 @item -mstackrealign
14291 @opindex mstackrealign
14292 Realign the stack at entry. On the Intel x86, the @option{-mstackrealign}
14293 option generates an alternate prologue and epilogue that realigns the
14294 run-time stack if necessary. This supports mixing legacy codes that keep
14295 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
14296 SSE compatibility. See also the attribute @code{force_align_arg_pointer},
14297 applicable to individual functions.
14298
14299 @item -mpreferred-stack-boundary=@var{num}
14300 @opindex mpreferred-stack-boundary
14301 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
14302 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
14303 the default is 4 (16 bytes or 128 bits).
14304
14305 @strong{Warning:} When generating code for the x86-64 architecture with
14306 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
14307 used to keep the stack boundary aligned to 8 byte boundary. Since
14308 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
14309 intended to be used in controlled environment where stack space is
14310 important limitation. This option will lead to wrong code when functions
14311 compiled with 16 byte stack alignment (such as functions from a standard
14312 library) are called with misaligned stack. In this case, SSE
14313 instructions may lead to misaligned memory access traps. In addition,
14314 variable arguments will be handled incorrectly for 16 byte aligned
14315 objects (including x87 long double and __int128), leading to wrong
14316 results. You must build all modules with
14317 @option{-mpreferred-stack-boundary=3}, including any libraries. This
14318 includes the system libraries and startup modules.
14319
14320 @item -mincoming-stack-boundary=@var{num}
14321 @opindex mincoming-stack-boundary
14322 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
14323 boundary. If @option{-mincoming-stack-boundary} is not specified,
14324 the one specified by @option{-mpreferred-stack-boundary} is used.
14325
14326 On Pentium and Pentium Pro, @code{double} and @code{long double} values
14327 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
14328 suffer significant run time performance penalties. On Pentium III, the
14329 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
14330 properly if it is not 16-byte aligned.
14331
14332 To ensure proper alignment of this values on the stack, the stack boundary
14333 must be as aligned as that required by any value stored on the stack.
14334 Further, every function must be generated such that it keeps the stack
14335 aligned. Thus calling a function compiled with a higher preferred
14336 stack boundary from a function compiled with a lower preferred stack
14337 boundary most likely misaligns the stack. It is recommended that
14338 libraries that use callbacks always use the default setting.
14339
14340 This extra alignment does consume extra stack space, and generally
14341 increases code size. Code that is sensitive to stack space usage, such
14342 as embedded systems and operating system kernels, may want to reduce the
14343 preferred alignment to @option{-mpreferred-stack-boundary=2}.
14344
14345 @item -mmmx
14346 @itemx -mno-mmx
14347 @itemx -msse
14348 @itemx -mno-sse
14349 @itemx -msse2
14350 @itemx -mno-sse2
14351 @itemx -msse3
14352 @itemx -mno-sse3
14353 @itemx -mssse3
14354 @itemx -mno-ssse3
14355 @itemx -msse4.1
14356 @need 800
14357 @itemx -mno-sse4.1
14358 @itemx -msse4.2
14359 @itemx -mno-sse4.2
14360 @itemx -msse4
14361 @itemx -mno-sse4
14362 @itemx -mavx
14363 @itemx -mno-avx
14364 @itemx -mavx2
14365 @itemx -mno-avx2
14366 @itemx -maes
14367 @itemx -mno-aes
14368 @itemx -mpclmul
14369 @need 800
14370 @itemx -mno-pclmul
14371 @itemx -mfsgsbase
14372 @itemx -mno-fsgsbase
14373 @itemx -mrdrnd
14374 @itemx -mno-rdrnd
14375 @itemx -mf16c
14376 @itemx -mno-f16c
14377 @itemx -mfma
14378 @itemx -mno-fma
14379 @itemx -msse4a
14380 @itemx -mno-sse4a
14381 @itemx -mfma4
14382 @need 800
14383 @itemx -mno-fma4
14384 @itemx -mxop
14385 @itemx -mno-xop
14386 @itemx -mlwp
14387 @itemx -mno-lwp
14388 @itemx -m3dnow
14389 @itemx -mno-3dnow
14390 @itemx -mpopcnt
14391 @itemx -mno-popcnt
14392 @itemx -mabm
14393 @itemx -mno-abm
14394 @itemx -mbmi
14395 @itemx -mbmi2
14396 @itemx -mno-bmi
14397 @itemx -mno-bmi2
14398 @itemx -mlzcnt
14399 @itemx -mno-lzcnt
14400 @itemx -mrtm
14401 @itemx -mtbm
14402 @itemx -mno-tbm
14403 @opindex mmmx
14404 @opindex mno-mmx
14405 @opindex msse
14406 @opindex mno-sse
14407 @opindex m3dnow
14408 @opindex mno-3dnow
14409 These switches enable or disable the use of instructions in the MMX, SSE,
14410 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
14411 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
14412 extended instruction sets.
14413 These extensions are also available as built-in functions: see
14414 @ref{X86 Built-in Functions}, for details of the functions enabled and
14415 disabled by these switches.
14416
14417 To generate SSE/SSE2 instructions automatically from floating-point
14418 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
14419
14420 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
14421 generates new AVX instructions or AVX equivalence for all SSEx instructions
14422 when needed.
14423
14424 These options enable GCC to use these extended instructions in
14425 generated code, even without @option{-mfpmath=sse}. Applications that
14426 perform run-time CPU detection must compile separate files for each
14427 supported architecture, using the appropriate flags. In particular,
14428 the file containing the CPU detection code should be compiled without
14429 these options.
14430
14431 @item -mcld
14432 @opindex mcld
14433 This option instructs GCC to emit a @code{cld} instruction in the prologue
14434 of functions that use string instructions. String instructions depend on
14435 the DF flag to select between autoincrement or autodecrement mode. While the
14436 ABI specifies the DF flag to be cleared on function entry, some operating
14437 systems violate this specification by not clearing the DF flag in their
14438 exception dispatchers. The exception handler can be invoked with the DF flag
14439 set, which leads to wrong direction mode when string instructions are used.
14440 This option can be enabled by default on 32-bit x86 targets by configuring
14441 GCC with the @option{--enable-cld} configure option. Generation of @code{cld}
14442 instructions can be suppressed with the @option{-mno-cld} compiler option
14443 in this case.
14444
14445 @item -mvzeroupper
14446 @opindex mvzeroupper
14447 This option instructs GCC to emit a @code{vzeroupper} instruction
14448 before a transfer of control flow out of the function to minimize
14449 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
14450 intrinsics.
14451
14452 @item -mprefer-avx128
14453 @opindex mprefer-avx128
14454 This option instructs GCC to use 128-bit AVX instructions instead of
14455 256-bit AVX instructions in the auto-vectorizer.
14456
14457 @item -mcx16
14458 @opindex mcx16
14459 This option enables GCC to generate @code{CMPXCHG16B} instructions.
14460 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
14461 (or oword) data types.
14462 This is useful for high-resolution counters that can be updated
14463 by multiple processors (or cores). This instruction is generated as part of
14464 atomic built-in functions: see @ref{__sync Builtins} or
14465 @ref{__atomic Builtins} for details.
14466
14467 @item -msahf
14468 @opindex msahf
14469 This option enables generation of @code{SAHF} instructions in 64-bit code.
14470 Early Intel Pentium 4 CPUs with Intel 64 support,
14471 prior to the introduction of Pentium 4 G1 step in December 2005,
14472 lacked the @code{LAHF} and @code{SAHF} instructions
14473 which were supported by AMD64.
14474 These are load and store instructions, respectively, for certain status flags.
14475 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
14476 @code{drem}, and @code{remainder} built-in functions;
14477 see @ref{Other Builtins} for details.
14478
14479 @item -mmovbe
14480 @opindex mmovbe
14481 This option enables use of the @code{movbe} instruction to implement
14482 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
14483
14484 @item -mcrc32
14485 @opindex mcrc32
14486 This option enables built-in functions @code{__builtin_ia32_crc32qi},
14487 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
14488 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
14489
14490 @item -mrecip
14491 @opindex mrecip
14492 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
14493 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
14494 with an additional Newton-Raphson step
14495 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
14496 (and their vectorized
14497 variants) for single-precision floating-point arguments. These instructions
14498 are generated only when @option{-funsafe-math-optimizations} is enabled
14499 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
14500 Note that while the throughput of the sequence is higher than the throughput
14501 of the non-reciprocal instruction, the precision of the sequence can be
14502 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
14503
14504 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
14505 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
14506 combination), and doesn't need @option{-mrecip}.
14507
14508 Also note that GCC emits the above sequence with additional Newton-Raphson step
14509 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
14510 already with @option{-ffast-math} (or the above option combination), and
14511 doesn't need @option{-mrecip}.
14512
14513 @item -mrecip=@var{opt}
14514 @opindex mrecip=opt
14515 This option controls which reciprocal estimate instructions
14516 may be used. @var{opt} is a comma-separated list of options, which may
14517 be preceded by a @samp{!} to invert the option:
14518
14519 @table @samp
14520 @item all
14521 Enable all estimate instructions.
14522
14523 @item default
14524 Enable the default instructions, equivalent to @option{-mrecip}.
14525
14526 @item none
14527 Disable all estimate instructions, equivalent to @option{-mno-recip}.
14528
14529 @item div
14530 Enable the approximation for scalar division.
14531
14532 @item vec-div
14533 Enable the approximation for vectorized division.
14534
14535 @item sqrt
14536 Enable the approximation for scalar square root.
14537
14538 @item vec-sqrt
14539 Enable the approximation for vectorized square root.
14540 @end table
14541
14542 So, for example, @option{-mrecip=all,!sqrt} enables
14543 all of the reciprocal approximations, except for square root.
14544
14545 @item -mveclibabi=@var{type}
14546 @opindex mveclibabi
14547 Specifies the ABI type to use for vectorizing intrinsics using an
14548 external library. Supported values for @var{type} are @samp{svml}
14549 for the Intel short
14550 vector math library and @samp{acml} for the AMD math core library.
14551 To use this option, both @option{-ftree-vectorize} and
14552 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML
14553 ABI-compatible library must be specified at link time.
14554
14555 GCC currently emits calls to @code{vmldExp2},
14556 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
14557 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
14558 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
14559 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
14560 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
14561 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
14562 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
14563 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
14564 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
14565 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
14566 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
14567 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
14568 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
14569 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
14570 when @option{-mveclibabi=acml} is used.
14571
14572 @item -mabi=@var{name}
14573 @opindex mabi
14574 Generate code for the specified calling convention. Permissible values
14575 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
14576 @samp{ms} for the Microsoft ABI. The default is to use the Microsoft
14577 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
14578 You can control this behavior for a specific function by
14579 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
14580 @xref{Function Attributes}.
14581
14582 @item -mtls-dialect=@var{type}
14583 @opindex mtls-dialect
14584 Generate code to access thread-local storage using the @samp{gnu} or
14585 @samp{gnu2} conventions. @samp{gnu} is the conservative default;
14586 @samp{gnu2} is more efficient, but it may add compile- and run-time
14587 requirements that cannot be satisfied on all systems.
14588
14589 @item -mpush-args
14590 @itemx -mno-push-args
14591 @opindex mpush-args
14592 @opindex mno-push-args
14593 Use PUSH operations to store outgoing parameters. This method is shorter
14594 and usually equally fast as method using SUB/MOV operations and is enabled
14595 by default. In some cases disabling it may improve performance because of
14596 improved scheduling and reduced dependencies.
14597
14598 @item -maccumulate-outgoing-args
14599 @opindex maccumulate-outgoing-args
14600 If enabled, the maximum amount of space required for outgoing arguments is
14601 computed in the function prologue. This is faster on most modern CPUs
14602 because of reduced dependencies, improved scheduling and reduced stack usage
14603 when the preferred stack boundary is not equal to 2. The drawback is a notable
14604 increase in code size. This switch implies @option{-mno-push-args}.
14605
14606 @item -mthreads
14607 @opindex mthreads
14608 Support thread-safe exception handling on MinGW. Programs that rely
14609 on thread-safe exception handling must compile and link all code with the
14610 @option{-mthreads} option. When compiling, @option{-mthreads} defines
14611 @code{-D_MT}; when linking, it links in a special thread helper library
14612 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
14613
14614 @item -mno-align-stringops
14615 @opindex mno-align-stringops
14616 Do not align the destination of inlined string operations. This switch reduces
14617 code size and improves performance in case the destination is already aligned,
14618 but GCC doesn't know about it.
14619
14620 @item -minline-all-stringops
14621 @opindex minline-all-stringops
14622 By default GCC inlines string operations only when the destination is
14623 known to be aligned to least a 4-byte boundary.
14624 This enables more inlining and increases code
14625 size, but may improve performance of code that depends on fast
14626 @code{memcpy}, @code{strlen},
14627 and @code{memset} for short lengths.
14628
14629 @item -minline-stringops-dynamically
14630 @opindex minline-stringops-dynamically
14631 For string operations of unknown size, use run-time checks with
14632 inline code for small blocks and a library call for large blocks.
14633
14634 @item -mstringop-strategy=@var{alg}
14635 @opindex mstringop-strategy=@var{alg}
14636 Override the internal decision heuristic for the particular algorithm to use
14637 for inlining string operations. The allowed values for @var{alg} are:
14638
14639 @table @samp
14640 @item rep_byte
14641 @itemx rep_4byte
14642 @itemx rep_8byte
14643 Expand using i386 @code{rep} prefix of the specified size.
14644
14645 @item byte_loop
14646 @itemx loop
14647 @itemx unrolled_loop
14648 Expand into an inline loop.
14649
14650 @item libcall
14651 Always use a library call.
14652 @end table
14653
14654 @item -momit-leaf-frame-pointer
14655 @opindex momit-leaf-frame-pointer
14656 Don't keep the frame pointer in a register for leaf functions. This
14657 avoids the instructions to save, set up, and restore frame pointers and
14658 makes an extra register available in leaf functions. The option
14659 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
14660 which might make debugging harder.
14661
14662 @item -mtls-direct-seg-refs
14663 @itemx -mno-tls-direct-seg-refs
14664 @opindex mtls-direct-seg-refs
14665 Controls whether TLS variables may be accessed with offsets from the
14666 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
14667 or whether the thread base pointer must be added. Whether or not this
14668 is valid depends on the operating system, and whether it maps the
14669 segment to cover the entire TLS area.
14670
14671 For systems that use the GNU C Library, the default is on.
14672
14673 @item -msse2avx
14674 @itemx -mno-sse2avx
14675 @opindex msse2avx
14676 Specify that the assembler should encode SSE instructions with VEX
14677 prefix. The option @option{-mavx} turns this on by default.
14678
14679 @item -mfentry
14680 @itemx -mno-fentry
14681 @opindex mfentry
14682 If profiling is active (@option{-pg}), put the profiling
14683 counter call before the prologue.
14684 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14685 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14686
14687 @item -m8bit-idiv
14688 @itemx -mno-8bit-idiv
14689 @opindex 8bit-idiv
14690 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14691 much faster than 32-bit/64-bit integer divide. This option generates a
14692 run-time check. If both dividend and divisor are within range of 0
14693 to 255, 8-bit unsigned integer divide is used instead of
14694 32-bit/64-bit integer divide.
14695
14696 @item -mavx256-split-unaligned-load
14697 @itemx -mavx256-split-unaligned-store
14698 @opindex avx256-split-unaligned-load
14699 @opindex avx256-split-unaligned-store
14700 Split 32-byte AVX unaligned load and store.
14701
14702 @item -mstack-protector-guard=@var{guard}
14703 @opindex mstack-protector-guard=@var{guard}
14704 Generate stack protection code using canary at @var{guard}. Supported
14705 locations are @samp{global} for global canary or @samp{tls} for per-thread
14706 canary in the TLS block (the default). This option has effect only when
14707 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
14708
14709 @end table
14710
14711 These @samp{-m} switches are supported in addition to the above
14712 on x86-64 processors in 64-bit environments.
14713
14714 @table @gcctabopt
14715 @item -m32
14716 @itemx -m64
14717 @itemx -mx32
14718 @opindex m32
14719 @opindex m64
14720 @opindex mx32
14721 Generate code for a 32-bit or 64-bit environment.
14722 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14723 to 32 bits, and
14724 generates code that runs on any i386 system.
14725
14726 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14727 types to 64 bits, and generates code for the x86-64 architecture.
14728 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14729 and @option{-mdynamic-no-pic} options.
14730
14731 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14732 to 32 bits, and
14733 generates code for the x86-64 architecture.
14734
14735 @item -mno-red-zone
14736 @opindex mno-red-zone
14737 Do not use a so-called ``red zone'' for x86-64 code. The red zone is mandated
14738 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14739 stack pointer that is not modified by signal or interrupt handlers
14740 and therefore can be used for temporary data without adjusting the stack
14741 pointer. The flag @option{-mno-red-zone} disables this red zone.
14742
14743 @item -mcmodel=small
14744 @opindex mcmodel=small
14745 Generate code for the small code model: the program and its symbols must
14746 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
14747 Programs can be statically or dynamically linked. This is the default
14748 code model.
14749
14750 @item -mcmodel=kernel
14751 @opindex mcmodel=kernel
14752 Generate code for the kernel code model. The kernel runs in the
14753 negative 2 GB of the address space.
14754 This model has to be used for Linux kernel code.
14755
14756 @item -mcmodel=medium
14757 @opindex mcmodel=medium
14758 Generate code for the medium model: the program is linked in the lower 2
14759 GB of the address space. Small symbols are also placed there. Symbols
14760 with sizes larger than @option{-mlarge-data-threshold} are put into
14761 large data or BSS sections and can be located above 2GB. Programs can
14762 be statically or dynamically linked.
14763
14764 @item -mcmodel=large
14765 @opindex mcmodel=large
14766 Generate code for the large model. This model makes no assumptions
14767 about addresses and sizes of sections.
14768
14769 @item -maddress-mode=long
14770 @opindex maddress-mode=long
14771 Generate code for long address mode. This is only supported for 64-bit
14772 and x32 environments. It is the default address mode for 64-bit
14773 environments.
14774
14775 @item -maddress-mode=short
14776 @opindex maddress-mode=short
14777 Generate code for short address mode. This is only supported for 32-bit
14778 and x32 environments. It is the default address mode for 32-bit and
14779 x32 environments.
14780 @end table
14781
14782 @node i386 and x86-64 Windows Options
14783 @subsection i386 and x86-64 Windows Options
14784 @cindex i386 and x86-64 Windows Options
14785
14786 These additional options are available for Microsoft Windows targets:
14787
14788 @table @gcctabopt
14789 @item -mconsole
14790 @opindex mconsole
14791 This option
14792 specifies that a console application is to be generated, by
14793 instructing the linker to set the PE header subsystem type
14794 required for console applications.
14795 This option is available for Cygwin and MinGW targets and is
14796 enabled by default on those targets.
14797
14798 @item -mdll
14799 @opindex mdll
14800 This option is available for Cygwin and MinGW targets. It
14801 specifies that a DLL---a dynamic link library---is to be
14802 generated, enabling the selection of the required runtime
14803 startup object and entry point.
14804
14805 @item -mnop-fun-dllimport
14806 @opindex mnop-fun-dllimport
14807 This option is available for Cygwin and MinGW targets. It
14808 specifies that the @code{dllimport} attribute should be ignored.
14809
14810 @item -mthread
14811 @opindex mthread
14812 This option is available for MinGW targets. It specifies
14813 that MinGW-specific thread support is to be used.
14814
14815 @item -municode
14816 @opindex municode
14817 This option is available for MinGW-w64 targets. It causes
14818 the @code{UNICODE} preprocessor macro to be predefined, and
14819 chooses Unicode-capable runtime startup code.
14820
14821 @item -mwin32
14822 @opindex mwin32
14823 This option is available for Cygwin and MinGW targets. It
14824 specifies that the typical Microsoft Windows predefined macros are to
14825 be set in the pre-processor, but does not influence the choice
14826 of runtime library/startup code.
14827
14828 @item -mwindows
14829 @opindex mwindows
14830 This option is available for Cygwin and MinGW targets. It
14831 specifies that a GUI application is to be generated by
14832 instructing the linker to set the PE header subsystem type
14833 appropriately.
14834
14835 @item -fno-set-stack-executable
14836 @opindex fno-set-stack-executable
14837 This option is available for MinGW targets. It specifies that
14838 the executable flag for the stack used by nested functions isn't
14839 set. This is necessary for binaries running in kernel mode of
14840 Microsoft Windows, as there the User32 API, which is used to set executable
14841 privileges, isn't available.
14842
14843 @item -fwritable-relocated-rdata
14844 @opindex fno-writable-relocated-rdata
14845 This option is available for MinGW and Cygwin targets. It specifies
14846 that relocated-data in read-only section is put into .data
14847 section. This is a necessary for older runtimes not supporting
14848 modification of .rdata sections for pseudo-relocation.
14849
14850 @item -mpe-aligned-commons
14851 @opindex mpe-aligned-commons
14852 This option is available for Cygwin and MinGW targets. It
14853 specifies that the GNU extension to the PE file format that
14854 permits the correct alignment of COMMON variables should be
14855 used when generating code. It is enabled by default if
14856 GCC detects that the target assembler found during configuration
14857 supports the feature.
14858 @end table
14859
14860 See also under @ref{i386 and x86-64 Options} for standard options.
14861
14862 @node IA-64 Options
14863 @subsection IA-64 Options
14864 @cindex IA-64 Options
14865
14866 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14867
14868 @table @gcctabopt
14869 @item -mbig-endian
14870 @opindex mbig-endian
14871 Generate code for a big-endian target. This is the default for HP-UX@.
14872
14873 @item -mlittle-endian
14874 @opindex mlittle-endian
14875 Generate code for a little-endian target. This is the default for AIX5
14876 and GNU/Linux.
14877
14878 @item -mgnu-as
14879 @itemx -mno-gnu-as
14880 @opindex mgnu-as
14881 @opindex mno-gnu-as
14882 Generate (or don't) code for the GNU assembler. This is the default.
14883 @c Also, this is the default if the configure option @option{--with-gnu-as}
14884 @c is used.
14885
14886 @item -mgnu-ld
14887 @itemx -mno-gnu-ld
14888 @opindex mgnu-ld
14889 @opindex mno-gnu-ld
14890 Generate (or don't) code for the GNU linker. This is the default.
14891 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14892 @c is used.
14893
14894 @item -mno-pic
14895 @opindex mno-pic
14896 Generate code that does not use a global pointer register. The result
14897 is not position independent code, and violates the IA-64 ABI@.
14898
14899 @item -mvolatile-asm-stop
14900 @itemx -mno-volatile-asm-stop
14901 @opindex mvolatile-asm-stop
14902 @opindex mno-volatile-asm-stop
14903 Generate (or don't) a stop bit immediately before and after volatile asm
14904 statements.
14905
14906 @item -mregister-names
14907 @itemx -mno-register-names
14908 @opindex mregister-names
14909 @opindex mno-register-names
14910 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14911 the stacked registers. This may make assembler output more readable.
14912
14913 @item -mno-sdata
14914 @itemx -msdata
14915 @opindex mno-sdata
14916 @opindex msdata
14917 Disable (or enable) optimizations that use the small data section. This may
14918 be useful for working around optimizer bugs.
14919
14920 @item -mconstant-gp
14921 @opindex mconstant-gp
14922 Generate code that uses a single constant global pointer value. This is
14923 useful when compiling kernel code.
14924
14925 @item -mauto-pic
14926 @opindex mauto-pic
14927 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
14928 This is useful when compiling firmware code.
14929
14930 @item -minline-float-divide-min-latency
14931 @opindex minline-float-divide-min-latency
14932 Generate code for inline divides of floating-point values
14933 using the minimum latency algorithm.
14934
14935 @item -minline-float-divide-max-throughput
14936 @opindex minline-float-divide-max-throughput
14937 Generate code for inline divides of floating-point values
14938 using the maximum throughput algorithm.
14939
14940 @item -mno-inline-float-divide
14941 @opindex mno-inline-float-divide
14942 Do not generate inline code for divides of floating-point values.
14943
14944 @item -minline-int-divide-min-latency
14945 @opindex minline-int-divide-min-latency
14946 Generate code for inline divides of integer values
14947 using the minimum latency algorithm.
14948
14949 @item -minline-int-divide-max-throughput
14950 @opindex minline-int-divide-max-throughput
14951 Generate code for inline divides of integer values
14952 using the maximum throughput algorithm.
14953
14954 @item -mno-inline-int-divide
14955 @opindex mno-inline-int-divide
14956 Do not generate inline code for divides of integer values.
14957
14958 @item -minline-sqrt-min-latency
14959 @opindex minline-sqrt-min-latency
14960 Generate code for inline square roots
14961 using the minimum latency algorithm.
14962
14963 @item -minline-sqrt-max-throughput
14964 @opindex minline-sqrt-max-throughput
14965 Generate code for inline square roots
14966 using the maximum throughput algorithm.
14967
14968 @item -mno-inline-sqrt
14969 @opindex mno-inline-sqrt
14970 Do not generate inline code for @code{sqrt}.
14971
14972 @item -mfused-madd
14973 @itemx -mno-fused-madd
14974 @opindex mfused-madd
14975 @opindex mno-fused-madd
14976 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14977 instructions. The default is to use these instructions.
14978
14979 @item -mno-dwarf2-asm
14980 @itemx -mdwarf2-asm
14981 @opindex mno-dwarf2-asm
14982 @opindex mdwarf2-asm
14983 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14984 info. This may be useful when not using the GNU assembler.
14985
14986 @item -mearly-stop-bits
14987 @itemx -mno-early-stop-bits
14988 @opindex mearly-stop-bits
14989 @opindex mno-early-stop-bits
14990 Allow stop bits to be placed earlier than immediately preceding the
14991 instruction that triggered the stop bit. This can improve instruction
14992 scheduling, but does not always do so.
14993
14994 @item -mfixed-range=@var{register-range}
14995 @opindex mfixed-range
14996 Generate code treating the given register range as fixed registers.
14997 A fixed register is one that the register allocator cannot use. This is
14998 useful when compiling kernel code. A register range is specified as
14999 two registers separated by a dash. Multiple register ranges can be
15000 specified separated by a comma.
15001
15002 @item -mtls-size=@var{tls-size}
15003 @opindex mtls-size
15004 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
15005 64.
15006
15007 @item -mtune=@var{cpu-type}
15008 @opindex mtune
15009 Tune the instruction scheduling for a particular CPU, Valid values are
15010 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15011 and @samp{mckinley}.
15012
15013 @item -milp32
15014 @itemx -mlp64
15015 @opindex milp32
15016 @opindex mlp64
15017 Generate code for a 32-bit or 64-bit environment.
15018 The 32-bit environment sets int, long and pointer to 32 bits.
15019 The 64-bit environment sets int to 32 bits and long and pointer
15020 to 64 bits. These are HP-UX specific flags.
15021
15022 @item -mno-sched-br-data-spec
15023 @itemx -msched-br-data-spec
15024 @opindex mno-sched-br-data-spec
15025 @opindex msched-br-data-spec
15026 (Dis/En)able data speculative scheduling before reload.
15027 This results in generation of @code{ld.a} instructions and
15028 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15029 The default is 'disable'.
15030
15031 @item -msched-ar-data-spec
15032 @itemx -mno-sched-ar-data-spec
15033 @opindex msched-ar-data-spec
15034 @opindex mno-sched-ar-data-spec
15035 (En/Dis)able data speculative scheduling after reload.
15036 This results in generation of @code{ld.a} instructions and
15037 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15038 The default is 'enable'.
15039
15040 @item -mno-sched-control-spec
15041 @itemx -msched-control-spec
15042 @opindex mno-sched-control-spec
15043 @opindex msched-control-spec
15044 (Dis/En)able control speculative scheduling. This feature is
15045 available only during region scheduling (i.e.@: before reload).
15046 This results in generation of the @code{ld.s} instructions and
15047 the corresponding check instructions @code{chk.s}.
15048 The default is 'disable'.
15049
15050 @item -msched-br-in-data-spec
15051 @itemx -mno-sched-br-in-data-spec
15052 @opindex msched-br-in-data-spec
15053 @opindex mno-sched-br-in-data-spec
15054 (En/Dis)able speculative scheduling of the instructions that
15055 are dependent on the data speculative loads before reload.
15056 This is effective only with @option{-msched-br-data-spec} enabled.
15057 The default is 'enable'.
15058
15059 @item -msched-ar-in-data-spec
15060 @itemx -mno-sched-ar-in-data-spec
15061 @opindex msched-ar-in-data-spec
15062 @opindex mno-sched-ar-in-data-spec
15063 (En/Dis)able speculative scheduling of the instructions that
15064 are dependent on the data speculative loads after reload.
15065 This is effective only with @option{-msched-ar-data-spec} enabled.
15066 The default is 'enable'.
15067
15068 @item -msched-in-control-spec
15069 @itemx -mno-sched-in-control-spec
15070 @opindex msched-in-control-spec
15071 @opindex mno-sched-in-control-spec
15072 (En/Dis)able speculative scheduling of the instructions that
15073 are dependent on the control speculative loads.
15074 This is effective only with @option{-msched-control-spec} enabled.
15075 The default is 'enable'.
15076
15077 @item -mno-sched-prefer-non-data-spec-insns
15078 @itemx -msched-prefer-non-data-spec-insns
15079 @opindex mno-sched-prefer-non-data-spec-insns
15080 @opindex msched-prefer-non-data-spec-insns
15081 If enabled, data-speculative instructions are chosen for schedule
15082 only if there are no other choices at the moment. This makes
15083 the use of the data speculation much more conservative.
15084 The default is 'disable'.
15085
15086 @item -mno-sched-prefer-non-control-spec-insns
15087 @itemx -msched-prefer-non-control-spec-insns
15088 @opindex mno-sched-prefer-non-control-spec-insns
15089 @opindex msched-prefer-non-control-spec-insns
15090 If enabled, control-speculative instructions are chosen for schedule
15091 only if there are no other choices at the moment. This makes
15092 the use of the control speculation much more conservative.
15093 The default is 'disable'.
15094
15095 @item -mno-sched-count-spec-in-critical-path
15096 @itemx -msched-count-spec-in-critical-path
15097 @opindex mno-sched-count-spec-in-critical-path
15098 @opindex msched-count-spec-in-critical-path
15099 If enabled, speculative dependencies are considered during
15100 computation of the instructions priorities. This makes the use of the
15101 speculation a bit more conservative.
15102 The default is 'disable'.
15103
15104 @item -msched-spec-ldc
15105 @opindex msched-spec-ldc
15106 Use a simple data speculation check. This option is on by default.
15107
15108 @item -msched-control-spec-ldc
15109 @opindex msched-spec-ldc
15110 Use a simple check for control speculation. This option is on by default.
15111
15112 @item -msched-stop-bits-after-every-cycle
15113 @opindex msched-stop-bits-after-every-cycle
15114 Place a stop bit after every cycle when scheduling. This option is on
15115 by default.
15116
15117 @item -msched-fp-mem-deps-zero-cost
15118 @opindex msched-fp-mem-deps-zero-cost
15119 Assume that floating-point stores and loads are not likely to cause a conflict
15120 when placed into the same instruction group. This option is disabled by
15121 default.
15122
15123 @item -msel-sched-dont-check-control-spec
15124 @opindex msel-sched-dont-check-control-spec
15125 Generate checks for control speculation in selective scheduling.
15126 This flag is disabled by default.
15127
15128 @item -msched-max-memory-insns=@var{max-insns}
15129 @opindex msched-max-memory-insns
15130 Limit on the number of memory insns per instruction group, giving lower
15131 priority to subsequent memory insns attempting to schedule in the same
15132 instruction group. Frequently useful to prevent cache bank conflicts.
15133 The default value is 1.
15134
15135 @item -msched-max-memory-insns-hard-limit
15136 @opindex msched-max-memory-insns-hard-limit
15137 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
15138 disallowing more than that number in an instruction group.
15139 Otherwise, the limit is ``soft'', meaning that non-memory operations
15140 are preferred when the limit is reached, but memory operations may still
15141 be scheduled.
15142
15143 @end table
15144
15145 @node LM32 Options
15146 @subsection LM32 Options
15147 @cindex LM32 options
15148
15149 These @option{-m} options are defined for the LatticeMico32 architecture:
15150
15151 @table @gcctabopt
15152 @item -mbarrel-shift-enabled
15153 @opindex mbarrel-shift-enabled
15154 Enable barrel-shift instructions.
15155
15156 @item -mdivide-enabled
15157 @opindex mdivide-enabled
15158 Enable divide and modulus instructions.
15159
15160 @item -mmultiply-enabled
15161 @opindex multiply-enabled
15162 Enable multiply instructions.
15163
15164 @item -msign-extend-enabled
15165 @opindex msign-extend-enabled
15166 Enable sign extend instructions.
15167
15168 @item -muser-enabled
15169 @opindex muser-enabled
15170 Enable user-defined instructions.
15171
15172 @end table
15173
15174 @node M32C Options
15175 @subsection M32C Options
15176 @cindex M32C options
15177
15178 @table @gcctabopt
15179 @item -mcpu=@var{name}
15180 @opindex mcpu=
15181 Select the CPU for which code is generated. @var{name} may be one of
15182 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
15183 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
15184 the M32C/80 series.
15185
15186 @item -msim
15187 @opindex msim
15188 Specifies that the program will be run on the simulator. This causes
15189 an alternate runtime library to be linked in which supports, for
15190 example, file I/O@. You must not use this option when generating
15191 programs that will run on real hardware; you must provide your own
15192 runtime library for whatever I/O functions are needed.
15193
15194 @item -memregs=@var{number}
15195 @opindex memregs=
15196 Specifies the number of memory-based pseudo-registers GCC uses
15197 during code generation. These pseudo-registers are used like real
15198 registers, so there is a tradeoff between GCC's ability to fit the
15199 code into available registers, and the performance penalty of using
15200 memory instead of registers. Note that all modules in a program must
15201 be compiled with the same value for this option. Because of that, you
15202 must not use this option with GCC's default runtime libraries.
15203
15204 @end table
15205
15206 @node M32R/D Options
15207 @subsection M32R/D Options
15208 @cindex M32R/D options
15209
15210 These @option{-m} options are defined for Renesas M32R/D architectures:
15211
15212 @table @gcctabopt
15213 @item -m32r2
15214 @opindex m32r2
15215 Generate code for the M32R/2@.
15216
15217 @item -m32rx
15218 @opindex m32rx
15219 Generate code for the M32R/X@.
15220
15221 @item -m32r
15222 @opindex m32r
15223 Generate code for the M32R@. This is the default.
15224
15225 @item -mmodel=small
15226 @opindex mmodel=small
15227 Assume all objects live in the lower 16MB of memory (so that their addresses
15228 can be loaded with the @code{ld24} instruction), and assume all subroutines
15229 are reachable with the @code{bl} instruction.
15230 This is the default.
15231
15232 The addressability of a particular object can be set with the
15233 @code{model} attribute.
15234
15235 @item -mmodel=medium
15236 @opindex mmodel=medium
15237 Assume objects may be anywhere in the 32-bit address space (the compiler
15238 generates @code{seth/add3} instructions to load their addresses), and
15239 assume all subroutines are reachable with the @code{bl} instruction.
15240
15241 @item -mmodel=large
15242 @opindex mmodel=large
15243 Assume objects may be anywhere in the 32-bit address space (the compiler
15244 generates @code{seth/add3} instructions to load their addresses), and
15245 assume subroutines may not be reachable with the @code{bl} instruction
15246 (the compiler generates the much slower @code{seth/add3/jl}
15247 instruction sequence).
15248
15249 @item -msdata=none
15250 @opindex msdata=none
15251 Disable use of the small data area. Variables are put into
15252 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
15253 @code{section} attribute has been specified).
15254 This is the default.
15255
15256 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
15257 Objects may be explicitly put in the small data area with the
15258 @code{section} attribute using one of these sections.
15259
15260 @item -msdata=sdata
15261 @opindex msdata=sdata
15262 Put small global and static data in the small data area, but do not
15263 generate special code to reference them.
15264
15265 @item -msdata=use
15266 @opindex msdata=use
15267 Put small global and static data in the small data area, and generate
15268 special instructions to reference them.
15269
15270 @item -G @var{num}
15271 @opindex G
15272 @cindex smaller data references
15273 Put global and static objects less than or equal to @var{num} bytes
15274 into the small data or BSS sections instead of the normal data or BSS
15275 sections. The default value of @var{num} is 8.
15276 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
15277 for this option to have any effect.
15278
15279 All modules should be compiled with the same @option{-G @var{num}} value.
15280 Compiling with different values of @var{num} may or may not work; if it
15281 doesn't the linker gives an error message---incorrect code is not
15282 generated.
15283
15284 @item -mdebug
15285 @opindex mdebug
15286 Makes the M32R-specific code in the compiler display some statistics
15287 that might help in debugging programs.
15288
15289 @item -malign-loops
15290 @opindex malign-loops
15291 Align all loops to a 32-byte boundary.
15292
15293 @item -mno-align-loops
15294 @opindex mno-align-loops
15295 Do not enforce a 32-byte alignment for loops. This is the default.
15296
15297 @item -missue-rate=@var{number}
15298 @opindex missue-rate=@var{number}
15299 Issue @var{number} instructions per cycle. @var{number} can only be 1
15300 or 2.
15301
15302 @item -mbranch-cost=@var{number}
15303 @opindex mbranch-cost=@var{number}
15304 @var{number} can only be 1 or 2. If it is 1 then branches are
15305 preferred over conditional code, if it is 2, then the opposite applies.
15306
15307 @item -mflush-trap=@var{number}
15308 @opindex mflush-trap=@var{number}
15309 Specifies the trap number to use to flush the cache. The default is
15310 12. Valid numbers are between 0 and 15 inclusive.
15311
15312 @item -mno-flush-trap
15313 @opindex mno-flush-trap
15314 Specifies that the cache cannot be flushed by using a trap.
15315
15316 @item -mflush-func=@var{name}
15317 @opindex mflush-func=@var{name}
15318 Specifies the name of the operating system function to call to flush
15319 the cache. The default is @emph{_flush_cache}, but a function call
15320 is only used if a trap is not available.
15321
15322 @item -mno-flush-func
15323 @opindex mno-flush-func
15324 Indicates that there is no OS function for flushing the cache.
15325
15326 @end table
15327
15328 @node M680x0 Options
15329 @subsection M680x0 Options
15330 @cindex M680x0 options
15331
15332 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
15333 The default settings depend on which architecture was selected when
15334 the compiler was configured; the defaults for the most common choices
15335 are given below.
15336
15337 @table @gcctabopt
15338 @item -march=@var{arch}
15339 @opindex march
15340 Generate code for a specific M680x0 or ColdFire instruction set
15341 architecture. Permissible values of @var{arch} for M680x0
15342 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
15343 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire
15344 architectures are selected according to Freescale's ISA classification
15345 and the permissible values are: @samp{isaa}, @samp{isaaplus},
15346 @samp{isab} and @samp{isac}.
15347
15348 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
15349 code for a ColdFire target. The @var{arch} in this macro is one of the
15350 @option{-march} arguments given above.
15351
15352 When used together, @option{-march} and @option{-mtune} select code
15353 that runs on a family of similar processors but that is optimized
15354 for a particular microarchitecture.
15355
15356 @item -mcpu=@var{cpu}
15357 @opindex mcpu
15358 Generate code for a specific M680x0 or ColdFire processor.
15359 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
15360 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
15361 and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table
15362 below, which also classifies the CPUs into families:
15363
15364 @multitable @columnfractions 0.20 0.80
15365 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15366 @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}
15367 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15368 @item @samp{5206e} @tab @samp{5206e}
15369 @item @samp{5208} @tab @samp{5207} @samp{5208}
15370 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15371 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
15372 @item @samp{5216} @tab @samp{5214} @samp{5216}
15373 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
15374 @item @samp{5225} @tab @samp{5224} @samp{5225}
15375 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
15376 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
15377 @item @samp{5249} @tab @samp{5249}
15378 @item @samp{5250} @tab @samp{5250}
15379 @item @samp{5271} @tab @samp{5270} @samp{5271}
15380 @item @samp{5272} @tab @samp{5272}
15381 @item @samp{5275} @tab @samp{5274} @samp{5275}
15382 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
15383 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
15384 @item @samp{5307} @tab @samp{5307}
15385 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
15386 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
15387 @item @samp{5407} @tab @samp{5407}
15388 @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}
15389 @end multitable
15390
15391 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
15392 @var{arch} is compatible with @var{cpu}. Other combinations of
15393 @option{-mcpu} and @option{-march} are rejected.
15394
15395 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
15396 @var{cpu} is selected. It also defines @samp{__mcf_family_@var{family}},
15397 where the value of @var{family} is given by the table above.
15398
15399 @item -mtune=@var{tune}
15400 @opindex mtune
15401 Tune the code for a particular microarchitecture within the
15402 constraints set by @option{-march} and @option{-mcpu}.
15403 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
15404 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
15405 and @samp{cpu32}. The ColdFire microarchitectures
15406 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
15407
15408 You can also use @option{-mtune=68020-40} for code that needs
15409 to run relatively well on 68020, 68030 and 68040 targets.
15410 @option{-mtune=68020-60} is similar but includes 68060 targets
15411 as well. These two options select the same tuning decisions as
15412 @option{-m68020-40} and @option{-m68020-60} respectively.
15413
15414 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
15415 when tuning for 680x0 architecture @var{arch}. It also defines
15416 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
15417 option is used. If GCC is tuning for a range of architectures,
15418 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
15419 it defines the macros for every architecture in the range.
15420
15421 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
15422 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
15423 of the arguments given above.
15424
15425 @item -m68000
15426 @itemx -mc68000
15427 @opindex m68000
15428 @opindex mc68000
15429 Generate output for a 68000. This is the default
15430 when the compiler is configured for 68000-based systems.
15431 It is equivalent to @option{-march=68000}.
15432
15433 Use this option for microcontrollers with a 68000 or EC000 core,
15434 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
15435
15436 @item -m68010
15437 @opindex m68010
15438 Generate output for a 68010. This is the default
15439 when the compiler is configured for 68010-based systems.
15440 It is equivalent to @option{-march=68010}.
15441
15442 @item -m68020
15443 @itemx -mc68020
15444 @opindex m68020
15445 @opindex mc68020
15446 Generate output for a 68020. This is the default
15447 when the compiler is configured for 68020-based systems.
15448 It is equivalent to @option{-march=68020}.
15449
15450 @item -m68030
15451 @opindex m68030
15452 Generate output for a 68030. This is the default when the compiler is
15453 configured for 68030-based systems. It is equivalent to
15454 @option{-march=68030}.
15455
15456 @item -m68040
15457 @opindex m68040
15458 Generate output for a 68040. This is the default when the compiler is
15459 configured for 68040-based systems. It is equivalent to
15460 @option{-march=68040}.
15461
15462 This option inhibits the use of 68881/68882 instructions that have to be
15463 emulated by software on the 68040. Use this option if your 68040 does not
15464 have code to emulate those instructions.
15465
15466 @item -m68060
15467 @opindex m68060
15468 Generate output for a 68060. This is the default when the compiler is
15469 configured for 68060-based systems. It is equivalent to
15470 @option{-march=68060}.
15471
15472 This option inhibits the use of 68020 and 68881/68882 instructions that
15473 have to be emulated by software on the 68060. Use this option if your 68060
15474 does not have code to emulate those instructions.
15475
15476 @item -mcpu32
15477 @opindex mcpu32
15478 Generate output for a CPU32. This is the default
15479 when the compiler is configured for CPU32-based systems.
15480 It is equivalent to @option{-march=cpu32}.
15481
15482 Use this option for microcontrollers with a
15483 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
15484 68336, 68340, 68341, 68349 and 68360.
15485
15486 @item -m5200
15487 @opindex m5200
15488 Generate output for a 520X ColdFire CPU@. This is the default
15489 when the compiler is configured for 520X-based systems.
15490 It is equivalent to @option{-mcpu=5206}, and is now deprecated
15491 in favor of that option.
15492
15493 Use this option for microcontroller with a 5200 core, including
15494 the MCF5202, MCF5203, MCF5204 and MCF5206.
15495
15496 @item -m5206e
15497 @opindex m5206e
15498 Generate output for a 5206e ColdFire CPU@. The option is now
15499 deprecated in favor of the equivalent @option{-mcpu=5206e}.
15500
15501 @item -m528x
15502 @opindex m528x
15503 Generate output for a member of the ColdFire 528X family.
15504 The option is now deprecated in favor of the equivalent
15505 @option{-mcpu=528x}.
15506
15507 @item -m5307
15508 @opindex m5307
15509 Generate output for a ColdFire 5307 CPU@. The option is now deprecated
15510 in favor of the equivalent @option{-mcpu=5307}.
15511
15512 @item -m5407
15513 @opindex m5407
15514 Generate output for a ColdFire 5407 CPU@. The option is now deprecated
15515 in favor of the equivalent @option{-mcpu=5407}.
15516
15517 @item -mcfv4e
15518 @opindex mcfv4e
15519 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
15520 This includes use of hardware floating-point instructions.
15521 The option is equivalent to @option{-mcpu=547x}, and is now
15522 deprecated in favor of that option.
15523
15524 @item -m68020-40
15525 @opindex m68020-40
15526 Generate output for a 68040, without using any of the new instructions.
15527 This results in code that can run relatively efficiently on either a
15528 68020/68881 or a 68030 or a 68040. The generated code does use the
15529 68881 instructions that are emulated on the 68040.
15530
15531 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
15532
15533 @item -m68020-60
15534 @opindex m68020-60
15535 Generate output for a 68060, without using any of the new instructions.
15536 This results in code that can run relatively efficiently on either a
15537 68020/68881 or a 68030 or a 68040. The generated code does use the
15538 68881 instructions that are emulated on the 68060.
15539
15540 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
15541
15542 @item -mhard-float
15543 @itemx -m68881
15544 @opindex mhard-float
15545 @opindex m68881
15546 Generate floating-point instructions. This is the default for 68020
15547 and above, and for ColdFire devices that have an FPU@. It defines the
15548 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
15549 on ColdFire targets.
15550
15551 @item -msoft-float
15552 @opindex msoft-float
15553 Do not generate floating-point instructions; use library calls instead.
15554 This is the default for 68000, 68010, and 68832 targets. It is also
15555 the default for ColdFire devices that have no FPU.
15556
15557 @item -mdiv
15558 @itemx -mno-div
15559 @opindex mdiv
15560 @opindex mno-div
15561 Generate (do not generate) ColdFire hardware divide and remainder
15562 instructions. If @option{-march} is used without @option{-mcpu},
15563 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
15564 architectures. Otherwise, the default is taken from the target CPU
15565 (either the default CPU, or the one specified by @option{-mcpu}). For
15566 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
15567 @option{-mcpu=5206e}.
15568
15569 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
15570
15571 @item -mshort
15572 @opindex mshort
15573 Consider type @code{int} to be 16 bits wide, like @code{short int}.
15574 Additionally, parameters passed on the stack are also aligned to a
15575 16-bit boundary even on targets whose API mandates promotion to 32-bit.
15576
15577 @item -mno-short
15578 @opindex mno-short
15579 Do not consider type @code{int} to be 16 bits wide. This is the default.
15580
15581 @item -mnobitfield
15582 @itemx -mno-bitfield
15583 @opindex mnobitfield
15584 @opindex mno-bitfield
15585 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
15586 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
15587
15588 @item -mbitfield
15589 @opindex mbitfield
15590 Do use the bit-field instructions. The @option{-m68020} option implies
15591 @option{-mbitfield}. This is the default if you use a configuration
15592 designed for a 68020.
15593
15594 @item -mrtd
15595 @opindex mrtd
15596 Use a different function-calling convention, in which functions
15597 that take a fixed number of arguments return with the @code{rtd}
15598 instruction, which pops their arguments while returning. This
15599 saves one instruction in the caller since there is no need to pop
15600 the arguments there.
15601
15602 This calling convention is incompatible with the one normally
15603 used on Unix, so you cannot use it if you need to call libraries
15604 compiled with the Unix compiler.
15605
15606 Also, you must provide function prototypes for all functions that
15607 take variable numbers of arguments (including @code{printf});
15608 otherwise incorrect code is generated for calls to those
15609 functions.
15610
15611 In addition, seriously incorrect code results if you call a
15612 function with too many arguments. (Normally, extra arguments are
15613 harmlessly ignored.)
15614
15615 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
15616 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
15617
15618 @item -mno-rtd
15619 @opindex mno-rtd
15620 Do not use the calling conventions selected by @option{-mrtd}.
15621 This is the default.
15622
15623 @item -malign-int
15624 @itemx -mno-align-int
15625 @opindex malign-int
15626 @opindex mno-align-int
15627 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
15628 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
15629 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
15630 Aligning variables on 32-bit boundaries produces code that runs somewhat
15631 faster on processors with 32-bit busses at the expense of more memory.
15632
15633 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
15634 aligns structures containing the above types differently than
15635 most published application binary interface specifications for the m68k.
15636
15637 @item -mpcrel
15638 @opindex mpcrel
15639 Use the pc-relative addressing mode of the 68000 directly, instead of
15640 using a global offset table. At present, this option implies @option{-fpic},
15641 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
15642 not presently supported with @option{-mpcrel}, though this could be supported for
15643 68020 and higher processors.
15644
15645 @item -mno-strict-align
15646 @itemx -mstrict-align
15647 @opindex mno-strict-align
15648 @opindex mstrict-align
15649 Do not (do) assume that unaligned memory references are handled by
15650 the system.
15651
15652 @item -msep-data
15653 Generate code that allows the data segment to be located in a different
15654 area of memory from the text segment. This allows for execute-in-place in
15655 an environment without virtual memory management. This option implies
15656 @option{-fPIC}.
15657
15658 @item -mno-sep-data
15659 Generate code that assumes that the data segment follows the text segment.
15660 This is the default.
15661
15662 @item -mid-shared-library
15663 Generate code that supports shared libraries via the library ID method.
15664 This allows for execute-in-place and shared libraries in an environment
15665 without virtual memory management. This option implies @option{-fPIC}.
15666
15667 @item -mno-id-shared-library
15668 Generate code that doesn't assume ID-based shared libraries are being used.
15669 This is the default.
15670
15671 @item -mshared-library-id=n
15672 Specifies the identification number of the ID-based shared library being
15673 compiled. Specifying a value of 0 generates more compact code; specifying
15674 other values forces the allocation of that number to the current
15675 library, but is no more space- or time-efficient than omitting this option.
15676
15677 @item -mxgot
15678 @itemx -mno-xgot
15679 @opindex mxgot
15680 @opindex mno-xgot
15681 When generating position-independent code for ColdFire, generate code
15682 that works if the GOT has more than 8192 entries. This code is
15683 larger and slower than code generated without this option. On M680x0
15684 processors, this option is not needed; @option{-fPIC} suffices.
15685
15686 GCC normally uses a single instruction to load values from the GOT@.
15687 While this is relatively efficient, it only works if the GOT
15688 is smaller than about 64k. Anything larger causes the linker
15689 to report an error such as:
15690
15691 @cindex relocation truncated to fit (ColdFire)
15692 @smallexample
15693 relocation truncated to fit: R_68K_GOT16O foobar
15694 @end smallexample
15695
15696 If this happens, you should recompile your code with @option{-mxgot}.
15697 It should then work with very large GOTs. However, code generated with
15698 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15699 the value of a global symbol.
15700
15701 Note that some linkers, including newer versions of the GNU linker,
15702 can create multiple GOTs and sort GOT entries. If you have such a linker,
15703 you should only need to use @option{-mxgot} when compiling a single
15704 object file that accesses more than 8192 GOT entries. Very few do.
15705
15706 These options have no effect unless GCC is generating
15707 position-independent code.
15708
15709 @end table
15710
15711 @node MCore Options
15712 @subsection MCore Options
15713 @cindex MCore options
15714
15715 These are the @samp{-m} options defined for the Motorola M*Core
15716 processors.
15717
15718 @table @gcctabopt
15719
15720 @item -mhardlit
15721 @itemx -mno-hardlit
15722 @opindex mhardlit
15723 @opindex mno-hardlit
15724 Inline constants into the code stream if it can be done in two
15725 instructions or less.
15726
15727 @item -mdiv
15728 @itemx -mno-div
15729 @opindex mdiv
15730 @opindex mno-div
15731 Use the divide instruction. (Enabled by default).
15732
15733 @item -mrelax-immediate
15734 @itemx -mno-relax-immediate
15735 @opindex mrelax-immediate
15736 @opindex mno-relax-immediate
15737 Allow arbitrary-sized immediates in bit operations.
15738
15739 @item -mwide-bitfields
15740 @itemx -mno-wide-bitfields
15741 @opindex mwide-bitfields
15742 @opindex mno-wide-bitfields
15743 Always treat bit-fields as @code{int}-sized.
15744
15745 @item -m4byte-functions
15746 @itemx -mno-4byte-functions
15747 @opindex m4byte-functions
15748 @opindex mno-4byte-functions
15749 Force all functions to be aligned to a 4-byte boundary.
15750
15751 @item -mcallgraph-data
15752 @itemx -mno-callgraph-data
15753 @opindex mcallgraph-data
15754 @opindex mno-callgraph-data
15755 Emit callgraph information.
15756
15757 @item -mslow-bytes
15758 @itemx -mno-slow-bytes
15759 @opindex mslow-bytes
15760 @opindex mno-slow-bytes
15761 Prefer word access when reading byte quantities.
15762
15763 @item -mlittle-endian
15764 @itemx -mbig-endian
15765 @opindex mlittle-endian
15766 @opindex mbig-endian
15767 Generate code for a little-endian target.
15768
15769 @item -m210
15770 @itemx -m340
15771 @opindex m210
15772 @opindex m340
15773 Generate code for the 210 processor.
15774
15775 @item -mno-lsim
15776 @opindex mno-lsim
15777 Assume that runtime support has been provided and so omit the
15778 simulator library (@file{libsim.a)} from the linker command line.
15779
15780 @item -mstack-increment=@var{size}
15781 @opindex mstack-increment
15782 Set the maximum amount for a single stack increment operation. Large
15783 values can increase the speed of programs that contain functions
15784 that need a large amount of stack space, but they can also trigger a
15785 segmentation fault if the stack is extended too much. The default
15786 value is 0x1000.
15787
15788 @end table
15789
15790 @node MeP Options
15791 @subsection MeP Options
15792 @cindex MeP options
15793
15794 @table @gcctabopt
15795
15796 @item -mabsdiff
15797 @opindex mabsdiff
15798 Enables the @code{abs} instruction, which is the absolute difference
15799 between two registers.
15800
15801 @item -mall-opts
15802 @opindex mall-opts
15803 Enables all the optional instructions---average, multiply, divide, bit
15804 operations, leading zero, absolute difference, min/max, clip, and
15805 saturation.
15806
15807
15808 @item -maverage
15809 @opindex maverage
15810 Enables the @code{ave} instruction, which computes the average of two
15811 registers.
15812
15813 @item -mbased=@var{n}
15814 @opindex mbased=
15815 Variables of size @var{n} bytes or smaller are placed in the
15816 @code{.based} section by default. Based variables use the @code{$tp}
15817 register as a base register, and there is a 128-byte limit to the
15818 @code{.based} section.
15819
15820 @item -mbitops
15821 @opindex mbitops
15822 Enables the bit operation instructions---bit test (@code{btstm}), set
15823 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15824 test-and-set (@code{tas}).
15825
15826 @item -mc=@var{name}
15827 @opindex mc=
15828 Selects which section constant data is placed in. @var{name} may
15829 be @code{tiny}, @code{near}, or @code{far}.
15830
15831 @item -mclip
15832 @opindex mclip
15833 Enables the @code{clip} instruction. Note that @code{-mclip} is not
15834 useful unless you also provide @code{-mminmax}.
15835
15836 @item -mconfig=@var{name}
15837 @opindex mconfig=
15838 Selects one of the built-in core configurations. Each MeP chip has
15839 one or more modules in it; each module has a core CPU and a variety of
15840 coprocessors, optional instructions, and peripherals. The
15841 @code{MeP-Integrator} tool, not part of GCC, provides these
15842 configurations through this option; using this option is the same as
15843 using all the corresponding command-line options. The default
15844 configuration is @code{default}.
15845
15846 @item -mcop
15847 @opindex mcop
15848 Enables the coprocessor instructions. By default, this is a 32-bit
15849 coprocessor. Note that the coprocessor is normally enabled via the
15850 @code{-mconfig=} option.
15851
15852 @item -mcop32
15853 @opindex mcop32
15854 Enables the 32-bit coprocessor's instructions.
15855
15856 @item -mcop64
15857 @opindex mcop64
15858 Enables the 64-bit coprocessor's instructions.
15859
15860 @item -mivc2
15861 @opindex mivc2
15862 Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor.
15863
15864 @item -mdc
15865 @opindex mdc
15866 Causes constant variables to be placed in the @code{.near} section.
15867
15868 @item -mdiv
15869 @opindex mdiv
15870 Enables the @code{div} and @code{divu} instructions.
15871
15872 @item -meb
15873 @opindex meb
15874 Generate big-endian code.
15875
15876 @item -mel
15877 @opindex mel
15878 Generate little-endian code.
15879
15880 @item -mio-volatile
15881 @opindex mio-volatile
15882 Tells the compiler that any variable marked with the @code{io}
15883 attribute is to be considered volatile.
15884
15885 @item -ml
15886 @opindex ml
15887 Causes variables to be assigned to the @code{.far} section by default.
15888
15889 @item -mleadz
15890 @opindex mleadz
15891 Enables the @code{leadz} (leading zero) instruction.
15892
15893 @item -mm
15894 @opindex mm
15895 Causes variables to be assigned to the @code{.near} section by default.
15896
15897 @item -mminmax
15898 @opindex mminmax
15899 Enables the @code{min} and @code{max} instructions.
15900
15901 @item -mmult
15902 @opindex mmult
15903 Enables the multiplication and multiply-accumulate instructions.
15904
15905 @item -mno-opts
15906 @opindex mno-opts
15907 Disables all the optional instructions enabled by @code{-mall-opts}.
15908
15909 @item -mrepeat
15910 @opindex mrepeat
15911 Enables the @code{repeat} and @code{erepeat} instructions, used for
15912 low-overhead looping.
15913
15914 @item -ms
15915 @opindex ms
15916 Causes all variables to default to the @code{.tiny} section. Note
15917 that there is a 65536-byte limit to this section. Accesses to these
15918 variables use the @code{%gp} base register.
15919
15920 @item -msatur
15921 @opindex msatur
15922 Enables the saturation instructions. Note that the compiler does not
15923 currently generate these itself, but this option is included for
15924 compatibility with other tools, like @code{as}.
15925
15926 @item -msdram
15927 @opindex msdram
15928 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15929
15930 @item -msim
15931 @opindex msim
15932 Link the simulator runtime libraries.
15933
15934 @item -msimnovec
15935 @opindex msimnovec
15936 Link the simulator runtime libraries, excluding built-in support
15937 for reset and exception vectors and tables.
15938
15939 @item -mtf
15940 @opindex mtf
15941 Causes all functions to default to the @code{.far} section. Without
15942 this option, functions default to the @code{.near} section.
15943
15944 @item -mtiny=@var{n}
15945 @opindex mtiny=
15946 Variables that are @var{n} bytes or smaller are allocated to the
15947 @code{.tiny} section. These variables use the @code{$gp} base
15948 register. The default for this option is 4, but note that there's a
15949 65536-byte limit to the @code{.tiny} section.
15950
15951 @end table
15952
15953 @node MicroBlaze Options
15954 @subsection MicroBlaze Options
15955 @cindex MicroBlaze Options
15956
15957 @table @gcctabopt
15958
15959 @item -msoft-float
15960 @opindex msoft-float
15961 Use software emulation for floating point (default).
15962
15963 @item -mhard-float
15964 @opindex mhard-float
15965 Use hardware floating-point instructions.
15966
15967 @item -mmemcpy
15968 @opindex mmemcpy
15969 Do not optimize block moves, use @code{memcpy}.
15970
15971 @item -mno-clearbss
15972 @opindex mno-clearbss
15973 This option is deprecated. Use @option{-fno-zero-initialized-in-bss} instead.
15974
15975 @item -mcpu=@var{cpu-type}
15976 @opindex mcpu=
15977 Use features of, and schedule code for, the given CPU.
15978 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15979 where @var{X} is a major version, @var{YY} is the minor version, and
15980 @var{Z} is compatibility code. Example values are @samp{v3.00.a},
15981 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15982
15983 @item -mxl-soft-mul
15984 @opindex mxl-soft-mul
15985 Use software multiply emulation (default).
15986
15987 @item -mxl-soft-div
15988 @opindex mxl-soft-div
15989 Use software emulation for divides (default).
15990
15991 @item -mxl-barrel-shift
15992 @opindex mxl-barrel-shift
15993 Use the hardware barrel shifter.
15994
15995 @item -mxl-pattern-compare
15996 @opindex mxl-pattern-compare
15997 Use pattern compare instructions.
15998
15999 @item -msmall-divides
16000 @opindex msmall-divides
16001 Use table lookup optimization for small signed integer divisions.
16002
16003 @item -mxl-stack-check
16004 @opindex mxl-stack-check
16005 This option is deprecated. Use @option{-fstack-check} instead.
16006
16007 @item -mxl-gp-opt
16008 @opindex mxl-gp-opt
16009 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16010
16011 @item -mxl-multiply-high
16012 @opindex mxl-multiply-high
16013 Use multiply high instructions for high part of 32x32 multiply.
16014
16015 @item -mxl-float-convert
16016 @opindex mxl-float-convert
16017 Use hardware floating-point conversion instructions.
16018
16019 @item -mxl-float-sqrt
16020 @opindex mxl-float-sqrt
16021 Use hardware floating-point square root instruction.
16022
16023 @item -mbig-endian
16024 @opindex mbig-endian
16025 Generate code for a big-endian target.
16026
16027 @item -mlittle-endian
16028 @opindex mlittle-endian
16029 Generate code for a little-endian target.
16030
16031 @item -mxl-reorder
16032 @opindex mxl-reorder
16033 Use reorder instructions (swap and byte reversed load/store).
16034
16035 @item -mxl-mode-@var{app-model}
16036 Select application model @var{app-model}. Valid models are
16037 @table @samp
16038 @item executable
16039 normal executable (default), uses startup code @file{crt0.o}.
16040
16041 @item xmdstub
16042 for use with Xilinx Microprocessor Debugger (XMD) based
16043 software intrusive debug agent called xmdstub. This uses startup file
16044 @file{crt1.o} and sets the start address of the program to 0x800.
16045
16046 @item bootstrap
16047 for applications that are loaded using a bootloader.
16048 This model uses startup file @file{crt2.o} which does not contain a processor
16049 reset vector handler. This is suitable for transferring control on a
16050 processor reset to the bootloader rather than the application.
16051
16052 @item novectors
16053 for applications that do not require any of the
16054 MicroBlaze vectors. This option may be useful for applications running
16055 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16056 @end table
16057
16058 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16059 @option{-mxl-mode-@var{app-model}}.
16060
16061 @end table
16062
16063 @node MIPS Options
16064 @subsection MIPS Options
16065 @cindex MIPS options
16066
16067 @table @gcctabopt
16068
16069 @item -EB
16070 @opindex EB
16071 Generate big-endian code.
16072
16073 @item -EL
16074 @opindex EL
16075 Generate little-endian code. This is the default for @samp{mips*el-*-*}
16076 configurations.
16077
16078 @item -march=@var{arch}
16079 @opindex march
16080 Generate code that runs on @var{arch}, which can be the name of a
16081 generic MIPS ISA, or the name of a particular processor.
16082 The ISA names are:
16083 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
16084 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
16085 The processor names are:
16086 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
16087 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
16088 @samp{5kc}, @samp{5kf},
16089 @samp{20kc},
16090 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
16091 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
16092 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
16093 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
16094 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
16095 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
16096 @samp{m4k},
16097 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
16098 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
16099 @samp{orion},
16100 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
16101 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
16102 @samp{rm7000}, @samp{rm9000},
16103 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
16104 @samp{sb1},
16105 @samp{sr71000},
16106 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
16107 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
16108 @samp{xlr} and @samp{xlp}.
16109 The special value @samp{from-abi} selects the
16110 most compatible architecture for the selected ABI (that is,
16111 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
16112
16113 The native Linux/GNU toolchain also supports the value @samp{native},
16114 which selects the best architecture option for the host processor.
16115 @option{-march=native} has no effect if GCC does not recognize
16116 the processor.
16117
16118 In processor names, a final @samp{000} can be abbreviated as @samp{k}
16119 (for example, @option{-march=r2k}). Prefixes are optional, and
16120 @samp{vr} may be written @samp{r}.
16121
16122 Names of the form @samp{@var{n}f2_1} refer to processors with
16123 FPUs clocked at half the rate of the core, names of the form
16124 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
16125 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
16126 processors with FPUs clocked a ratio of 3:2 with respect to the core.
16127 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
16128 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
16129 accepted as synonyms for @samp{@var{n}f1_1}.
16130
16131 GCC defines two macros based on the value of this option. The first
16132 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
16133 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
16134 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
16135 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
16136 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
16137
16138 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
16139 above. In other words, it has the full prefix and does not
16140 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
16141 the macro names the resolved architecture (either @samp{"mips1"} or
16142 @samp{"mips3"}). It names the default architecture when no
16143 @option{-march} option is given.
16144
16145 @item -mtune=@var{arch}
16146 @opindex mtune
16147 Optimize for @var{arch}. Among other things, this option controls
16148 the way instructions are scheduled, and the perceived cost of arithmetic
16149 operations. The list of @var{arch} values is the same as for
16150 @option{-march}.
16151
16152 When this option is not used, GCC optimizes for the processor
16153 specified by @option{-march}. By using @option{-march} and
16154 @option{-mtune} together, it is possible to generate code that
16155 runs on a family of processors, but optimize the code for one
16156 particular member of that family.
16157
16158 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
16159 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
16160 @option{-march} ones described above.
16161
16162 @item -mips1
16163 @opindex mips1
16164 Equivalent to @option{-march=mips1}.
16165
16166 @item -mips2
16167 @opindex mips2
16168 Equivalent to @option{-march=mips2}.
16169
16170 @item -mips3
16171 @opindex mips3
16172 Equivalent to @option{-march=mips3}.
16173
16174 @item -mips4
16175 @opindex mips4
16176 Equivalent to @option{-march=mips4}.
16177
16178 @item -mips32
16179 @opindex mips32
16180 Equivalent to @option{-march=mips32}.
16181
16182 @item -mips32r2
16183 @opindex mips32r2
16184 Equivalent to @option{-march=mips32r2}.
16185
16186 @item -mips64
16187 @opindex mips64
16188 Equivalent to @option{-march=mips64}.
16189
16190 @item -mips64r2
16191 @opindex mips64r2
16192 Equivalent to @option{-march=mips64r2}.
16193
16194 @item -mips16
16195 @itemx -mno-mips16
16196 @opindex mips16
16197 @opindex mno-mips16
16198 Generate (do not generate) MIPS16 code. If GCC is targeting a
16199 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
16200
16201 MIPS16 code generation can also be controlled on a per-function basis
16202 by means of @code{mips16} and @code{nomips16} attributes.
16203 @xref{Function Attributes}, for more information.
16204
16205 @item -mflip-mips16
16206 @opindex mflip-mips16
16207 Generate MIPS16 code on alternating functions. This option is provided
16208 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
16209 not intended for ordinary use in compiling user code.
16210
16211 @item -minterlink-compressed
16212 @item -mno-interlink-compressed
16213 @opindex minterlink-compressed
16214 @opindex mno-interlink-compressed
16215 Require (do not require) that code using the standard (uncompressed) MIPS ISA
16216 be link-compatible with MIPS16 and microMIPS code, and vice versa.
16217
16218 For example, code using the standard ISA encoding cannot jump directly
16219 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
16220 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
16221 knows that the target of the jump is not compressed.
16222
16223 @item -minterlink-mips16
16224 @itemx -mno-interlink-mips16
16225 @opindex minterlink-mips16
16226 @opindex mno-interlink-mips16
16227 Aliases of @option{-minterlink-compressed} and
16228 @option{-mno-interlink-compressed}. These options predate the microMIPS ASE
16229 and are retained for backwards compatibility.
16230
16231 @item -mabi=32
16232 @itemx -mabi=o64
16233 @itemx -mabi=n32
16234 @itemx -mabi=64
16235 @itemx -mabi=eabi
16236 @opindex mabi=32
16237 @opindex mabi=o64
16238 @opindex mabi=n32
16239 @opindex mabi=64
16240 @opindex mabi=eabi
16241 Generate code for the given ABI@.
16242
16243 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
16244 generates 64-bit code when you select a 64-bit architecture, but you
16245 can use @option{-mgp32} to get 32-bit code instead.
16246
16247 For information about the O64 ABI, see
16248 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
16249
16250 GCC supports a variant of the o32 ABI in which floating-point registers
16251 are 64 rather than 32 bits wide. You can select this combination with
16252 @option{-mabi=32} @option{-mfp64}. This ABI relies on the @code{mthc1}
16253 and @code{mfhc1} instructions and is therefore only supported for
16254 MIPS32R2 processors.
16255
16256 The register assignments for arguments and return values remain the
16257 same, but each scalar value is passed in a single 64-bit register
16258 rather than a pair of 32-bit registers. For example, scalar
16259 floating-point values are returned in @samp{$f0} only, not a
16260 @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also
16261 remains the same, but all 64 bits are saved.
16262
16263 @item -mabicalls
16264 @itemx -mno-abicalls
16265 @opindex mabicalls
16266 @opindex mno-abicalls
16267 Generate (do not generate) code that is suitable for SVR4-style
16268 dynamic objects. @option{-mabicalls} is the default for SVR4-based
16269 systems.
16270
16271 @item -mshared
16272 @itemx -mno-shared
16273 Generate (do not generate) code that is fully position-independent,
16274 and that can therefore be linked into shared libraries. This option
16275 only affects @option{-mabicalls}.
16276
16277 All @option{-mabicalls} code has traditionally been position-independent,
16278 regardless of options like @option{-fPIC} and @option{-fpic}. However,
16279 as an extension, the GNU toolchain allows executables to use absolute
16280 accesses for locally-binding symbols. It can also use shorter GP
16281 initialization sequences and generate direct calls to locally-defined
16282 functions. This mode is selected by @option{-mno-shared}.
16283
16284 @option{-mno-shared} depends on binutils 2.16 or higher and generates
16285 objects that can only be linked by the GNU linker. However, the option
16286 does not affect the ABI of the final executable; it only affects the ABI
16287 of relocatable objects. Using @option{-mno-shared} generally makes
16288 executables both smaller and quicker.
16289
16290 @option{-mshared} is the default.
16291
16292 @item -mplt
16293 @itemx -mno-plt
16294 @opindex mplt
16295 @opindex mno-plt
16296 Assume (do not assume) that the static and dynamic linkers
16297 support PLTs and copy relocations. This option only affects
16298 @option{-mno-shared -mabicalls}. For the n64 ABI, this option
16299 has no effect without @option{-msym32}.
16300
16301 You can make @option{-mplt} the default by configuring
16302 GCC with @option{--with-mips-plt}. The default is
16303 @option{-mno-plt} otherwise.
16304
16305 @item -mxgot
16306 @itemx -mno-xgot
16307 @opindex mxgot
16308 @opindex mno-xgot
16309 Lift (do not lift) the usual restrictions on the size of the global
16310 offset table.
16311
16312 GCC normally uses a single instruction to load values from the GOT@.
16313 While this is relatively efficient, it only works if the GOT
16314 is smaller than about 64k. Anything larger causes the linker
16315 to report an error such as:
16316
16317 @cindex relocation truncated to fit (MIPS)
16318 @smallexample
16319 relocation truncated to fit: R_MIPS_GOT16 foobar
16320 @end smallexample
16321
16322 If this happens, you should recompile your code with @option{-mxgot}.
16323 This works with very large GOTs, although the code is also
16324 less efficient, since it takes three instructions to fetch the
16325 value of a global symbol.
16326
16327 Note that some linkers can create multiple GOTs. If you have such a
16328 linker, you should only need to use @option{-mxgot} when a single object
16329 file accesses more than 64k's worth of GOT entries. Very few do.
16330
16331 These options have no effect unless GCC is generating position
16332 independent code.
16333
16334 @item -mgp32
16335 @opindex mgp32
16336 Assume that general-purpose registers are 32 bits wide.
16337
16338 @item -mgp64
16339 @opindex mgp64
16340 Assume that general-purpose registers are 64 bits wide.
16341
16342 @item -mfp32
16343 @opindex mfp32
16344 Assume that floating-point registers are 32 bits wide.
16345
16346 @item -mfp64
16347 @opindex mfp64
16348 Assume that floating-point registers are 64 bits wide.
16349
16350 @item -mhard-float
16351 @opindex mhard-float
16352 Use floating-point coprocessor instructions.
16353
16354 @item -msoft-float
16355 @opindex msoft-float
16356 Do not use floating-point coprocessor instructions. Implement
16357 floating-point calculations using library calls instead.
16358
16359 @item -mno-float
16360 @opindex mno-float
16361 Equivalent to @option{-msoft-float}, but additionally asserts that the
16362 program being compiled does not perform any floating-point operations.
16363 This option is presently supported only by some bare-metal MIPS
16364 configurations, where it may select a special set of libraries
16365 that lack all floating-point support (including, for example, the
16366 floating-point @code{printf} formats).
16367 If code compiled with @code{-mno-float} accidentally contains
16368 floating-point operations, it is likely to suffer a link-time
16369 or run-time failure.
16370
16371 @item -msingle-float
16372 @opindex msingle-float
16373 Assume that the floating-point coprocessor only supports single-precision
16374 operations.
16375
16376 @item -mdouble-float
16377 @opindex mdouble-float
16378 Assume that the floating-point coprocessor supports double-precision
16379 operations. This is the default.
16380
16381 @item -mabs=2008
16382 @itemx -mabs=legacy
16383 @opindex mabs=2008
16384 @opindex mabs=legacy
16385 These options control the treatment of the special not-a-number (NaN)
16386 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
16387 @code{neg.@i{fmt}} machine instructions.
16388
16389 By default or when the @option{-mabs=legacy} is used the legacy
16390 treatment is selected. In this case these instructions are considered
16391 arithmetic and avoided where correct operation is required and the
16392 input operand might be a NaN. A longer sequence of instructions that
16393 manipulate the sign bit of floating-point datum manually is used
16394 instead unless the @option{-ffinite-math-only} option has also been
16395 specified.
16396
16397 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment. In
16398 this case these instructions are considered non-arithmetic and therefore
16399 operating correctly in all cases, including in particular where the
16400 input operand is a NaN. These instructions are therefore always used
16401 for the respective operations.
16402
16403 @item -mnan=2008
16404 @itemx -mnan=legacy
16405 @opindex mnan=2008
16406 @opindex mnan=legacy
16407 These options control the encoding of the special not-a-number (NaN)
16408 IEEE 754 floating-point data.
16409
16410 The @option{-mnan=legacy} option selects the legacy encoding. In this
16411 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
16412 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
16413 by the first bit of their trailing significand field being 1.
16414
16415 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding. In
16416 this case qNaNs are denoted by the first bit of their trailing
16417 significand field being 1, whereas sNaNs are denoted by the first bit of
16418 their trailing significand field being 0.
16419
16420 The default is @option{-mnan=legacy} unless GCC has been configured with
16421 @option{--with-nan=2008}.
16422
16423 @item -mllsc
16424 @itemx -mno-llsc
16425 @opindex mllsc
16426 @opindex mno-llsc
16427 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
16428 implement atomic memory built-in functions. When neither option is
16429 specified, GCC uses the instructions if the target architecture
16430 supports them.
16431
16432 @option{-mllsc} is useful if the runtime environment can emulate the
16433 instructions and @option{-mno-llsc} can be useful when compiling for
16434 nonstandard ISAs. You can make either option the default by
16435 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
16436 respectively. @option{--with-llsc} is the default for some
16437 configurations; see the installation documentation for details.
16438
16439 @item -mdsp
16440 @itemx -mno-dsp
16441 @opindex mdsp
16442 @opindex mno-dsp
16443 Use (do not use) revision 1 of the MIPS DSP ASE@.
16444 @xref{MIPS DSP Built-in Functions}. This option defines the
16445 preprocessor macro @samp{__mips_dsp}. It also defines
16446 @samp{__mips_dsp_rev} to 1.
16447
16448 @item -mdspr2
16449 @itemx -mno-dspr2
16450 @opindex mdspr2
16451 @opindex mno-dspr2
16452 Use (do not use) revision 2 of the MIPS DSP ASE@.
16453 @xref{MIPS DSP Built-in Functions}. This option defines the
16454 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
16455 It also defines @samp{__mips_dsp_rev} to 2.
16456
16457 @item -msmartmips
16458 @itemx -mno-smartmips
16459 @opindex msmartmips
16460 @opindex mno-smartmips
16461 Use (do not use) the MIPS SmartMIPS ASE.
16462
16463 @item -mpaired-single
16464 @itemx -mno-paired-single
16465 @opindex mpaired-single
16466 @opindex mno-paired-single
16467 Use (do not use) paired-single floating-point instructions.
16468 @xref{MIPS Paired-Single Support}. This option requires
16469 hardware floating-point support to be enabled.
16470
16471 @item -mdmx
16472 @itemx -mno-mdmx
16473 @opindex mdmx
16474 @opindex mno-mdmx
16475 Use (do not use) MIPS Digital Media Extension instructions.
16476 This option can only be used when generating 64-bit code and requires
16477 hardware floating-point support to be enabled.
16478
16479 @item -mips3d
16480 @itemx -mno-mips3d
16481 @opindex mips3d
16482 @opindex mno-mips3d
16483 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
16484 The option @option{-mips3d} implies @option{-mpaired-single}.
16485
16486 @item -mmicromips
16487 @itemx -mno-micromips
16488 @opindex mmicromips
16489 @opindex mno-mmicromips
16490 Generate (do not generate) microMIPS code.
16491
16492 MicroMIPS code generation can also be controlled on a per-function basis
16493 by means of @code{micromips} and @code{nomicromips} attributes.
16494 @xref{Function Attributes}, for more information.
16495
16496 @item -mmt
16497 @itemx -mno-mt
16498 @opindex mmt
16499 @opindex mno-mt
16500 Use (do not use) MT Multithreading instructions.
16501
16502 @item -mmcu
16503 @itemx -mno-mcu
16504 @opindex mmcu
16505 @opindex mno-mcu
16506 Use (do not use) the MIPS MCU ASE instructions.
16507
16508 @item -meva
16509 @itemx -mno-eva
16510 @opindex meva
16511 @opindex mno-eva
16512 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
16513
16514 @item -mlong64
16515 @opindex mlong64
16516 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
16517 an explanation of the default and the way that the pointer size is
16518 determined.
16519
16520 @item -mlong32
16521 @opindex mlong32
16522 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
16523
16524 The default size of @code{int}s, @code{long}s and pointers depends on
16525 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
16526 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
16527 32-bit @code{long}s. Pointers are the same size as @code{long}s,
16528 or the same size as integer registers, whichever is smaller.
16529
16530 @item -msym32
16531 @itemx -mno-sym32
16532 @opindex msym32
16533 @opindex mno-sym32
16534 Assume (do not assume) that all symbols have 32-bit values, regardless
16535 of the selected ABI@. This option is useful in combination with
16536 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
16537 to generate shorter and faster references to symbolic addresses.
16538
16539 @item -G @var{num}
16540 @opindex G
16541 Put definitions of externally-visible data in a small data section
16542 if that data is no bigger than @var{num} bytes. GCC can then generate
16543 more efficient accesses to the data; see @option{-mgpopt} for details.
16544
16545 The default @option{-G} option depends on the configuration.
16546
16547 @item -mlocal-sdata
16548 @itemx -mno-local-sdata
16549 @opindex mlocal-sdata
16550 @opindex mno-local-sdata
16551 Extend (do not extend) the @option{-G} behavior to local data too,
16552 such as to static variables in C@. @option{-mlocal-sdata} is the
16553 default for all configurations.
16554
16555 If the linker complains that an application is using too much small data,
16556 you might want to try rebuilding the less performance-critical parts with
16557 @option{-mno-local-sdata}. You might also want to build large
16558 libraries with @option{-mno-local-sdata}, so that the libraries leave
16559 more room for the main program.
16560
16561 @item -mextern-sdata
16562 @itemx -mno-extern-sdata
16563 @opindex mextern-sdata
16564 @opindex mno-extern-sdata
16565 Assume (do not assume) that externally-defined data is in
16566 a small data section if the size of that data is within the @option{-G} limit.
16567 @option{-mextern-sdata} is the default for all configurations.
16568
16569 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
16570 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
16571 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
16572 is placed in a small data section. If @var{Var} is defined by another
16573 module, you must either compile that module with a high-enough
16574 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
16575 definition. If @var{Var} is common, you must link the application
16576 with a high-enough @option{-G} setting.
16577
16578 The easiest way of satisfying these restrictions is to compile
16579 and link every module with the same @option{-G} option. However,
16580 you may wish to build a library that supports several different
16581 small data limits. You can do this by compiling the library with
16582 the highest supported @option{-G} setting and additionally using
16583 @option{-mno-extern-sdata} to stop the library from making assumptions
16584 about externally-defined data.
16585
16586 @item -mgpopt
16587 @itemx -mno-gpopt
16588 @opindex mgpopt
16589 @opindex mno-gpopt
16590 Use (do not use) GP-relative accesses for symbols that are known to be
16591 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
16592 @option{-mextern-sdata}. @option{-mgpopt} is the default for all
16593 configurations.
16594
16595 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
16596 might not hold the value of @code{_gp}. For example, if the code is
16597 part of a library that might be used in a boot monitor, programs that
16598 call boot monitor routines pass an unknown value in @code{$gp}.
16599 (In such situations, the boot monitor itself is usually compiled
16600 with @option{-G0}.)
16601
16602 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
16603 @option{-mno-extern-sdata}.
16604
16605 @item -membedded-data
16606 @itemx -mno-embedded-data
16607 @opindex membedded-data
16608 @opindex mno-embedded-data
16609 Allocate variables to the read-only data section first if possible, then
16610 next in the small data section if possible, otherwise in data. This gives
16611 slightly slower code than the default, but reduces the amount of RAM required
16612 when executing, and thus may be preferred for some embedded systems.
16613
16614 @item -muninit-const-in-rodata
16615 @itemx -mno-uninit-const-in-rodata
16616 @opindex muninit-const-in-rodata
16617 @opindex mno-uninit-const-in-rodata
16618 Put uninitialized @code{const} variables in the read-only data section.
16619 This option is only meaningful in conjunction with @option{-membedded-data}.
16620
16621 @item -mcode-readable=@var{setting}
16622 @opindex mcode-readable
16623 Specify whether GCC may generate code that reads from executable sections.
16624 There are three possible settings:
16625
16626 @table @gcctabopt
16627 @item -mcode-readable=yes
16628 Instructions may freely access executable sections. This is the
16629 default setting.
16630
16631 @item -mcode-readable=pcrel
16632 MIPS16 PC-relative load instructions can access executable sections,
16633 but other instructions must not do so. This option is useful on 4KSc
16634 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
16635 It is also useful on processors that can be configured to have a dual
16636 instruction/data SRAM interface and that, like the M4K, automatically
16637 redirect PC-relative loads to the instruction RAM.
16638
16639 @item -mcode-readable=no
16640 Instructions must not access executable sections. This option can be
16641 useful on targets that are configured to have a dual instruction/data
16642 SRAM interface but that (unlike the M4K) do not automatically redirect
16643 PC-relative loads to the instruction RAM.
16644 @end table
16645
16646 @item -msplit-addresses
16647 @itemx -mno-split-addresses
16648 @opindex msplit-addresses
16649 @opindex mno-split-addresses
16650 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
16651 relocation operators. This option has been superseded by
16652 @option{-mexplicit-relocs} but is retained for backwards compatibility.
16653
16654 @item -mexplicit-relocs
16655 @itemx -mno-explicit-relocs
16656 @opindex mexplicit-relocs
16657 @opindex mno-explicit-relocs
16658 Use (do not use) assembler relocation operators when dealing with symbolic
16659 addresses. The alternative, selected by @option{-mno-explicit-relocs},
16660 is to use assembler macros instead.
16661
16662 @option{-mexplicit-relocs} is the default if GCC was configured
16663 to use an assembler that supports relocation operators.
16664
16665 @item -mcheck-zero-division
16666 @itemx -mno-check-zero-division
16667 @opindex mcheck-zero-division
16668 @opindex mno-check-zero-division
16669 Trap (do not trap) on integer division by zero.
16670
16671 The default is @option{-mcheck-zero-division}.
16672
16673 @item -mdivide-traps
16674 @itemx -mdivide-breaks
16675 @opindex mdivide-traps
16676 @opindex mdivide-breaks
16677 MIPS systems check for division by zero by generating either a
16678 conditional trap or a break instruction. Using traps results in
16679 smaller code, but is only supported on MIPS II and later. Also, some
16680 versions of the Linux kernel have a bug that prevents trap from
16681 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
16682 allow conditional traps on architectures that support them and
16683 @option{-mdivide-breaks} to force the use of breaks.
16684
16685 The default is usually @option{-mdivide-traps}, but this can be
16686 overridden at configure time using @option{--with-divide=breaks}.
16687 Divide-by-zero checks can be completely disabled using
16688 @option{-mno-check-zero-division}.
16689
16690 @item -mmemcpy
16691 @itemx -mno-memcpy
16692 @opindex mmemcpy
16693 @opindex mno-memcpy
16694 Force (do not force) the use of @code{memcpy()} for non-trivial block
16695 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
16696 most constant-sized copies.
16697
16698 @item -mlong-calls
16699 @itemx -mno-long-calls
16700 @opindex mlong-calls
16701 @opindex mno-long-calls
16702 Disable (do not disable) use of the @code{jal} instruction. Calling
16703 functions using @code{jal} is more efficient but requires the caller
16704 and callee to be in the same 256 megabyte segment.
16705
16706 This option has no effect on abicalls code. The default is
16707 @option{-mno-long-calls}.
16708
16709 @item -mmad
16710 @itemx -mno-mad
16711 @opindex mmad
16712 @opindex mno-mad
16713 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
16714 instructions, as provided by the R4650 ISA@.
16715
16716 @item -mimadd
16717 @itemx -mno-imadd
16718 @opindex mimadd
16719 @opindex mno-imadd
16720 Enable (disable) use of the @code{madd} and @code{msub} integer
16721 instructions. The default is @option{-mimadd} on architectures
16722 that support @code{madd} and @code{msub} except for the 74k
16723 architecture where it was found to generate slower code.
16724
16725 @item -mfused-madd
16726 @itemx -mno-fused-madd
16727 @opindex mfused-madd
16728 @opindex mno-fused-madd
16729 Enable (disable) use of the floating-point multiply-accumulate
16730 instructions, when they are available. The default is
16731 @option{-mfused-madd}.
16732
16733 On the R8000 CPU when multiply-accumulate instructions are used,
16734 the intermediate product is calculated to infinite precision
16735 and is not subject to the FCSR Flush to Zero bit. This may be
16736 undesirable in some circumstances. On other processors the result
16737 is numerically identical to the equivalent computation using
16738 separate multiply, add, subtract and negate instructions.
16739
16740 @item -nocpp
16741 @opindex nocpp
16742 Tell the MIPS assembler to not run its preprocessor over user
16743 assembler files (with a @samp{.s} suffix) when assembling them.
16744
16745 @item -mfix-24k
16746 @item -mno-fix-24k
16747 @opindex mfix-24k
16748 @opindex mno-fix-24k
16749 Work around the 24K E48 (lost data on stores during refill) errata.
16750 The workarounds are implemented by the assembler rather than by GCC@.
16751
16752 @item -mfix-r4000
16753 @itemx -mno-fix-r4000
16754 @opindex mfix-r4000
16755 @opindex mno-fix-r4000
16756 Work around certain R4000 CPU errata:
16757 @itemize @minus
16758 @item
16759 A double-word or a variable shift may give an incorrect result if executed
16760 immediately after starting an integer division.
16761 @item
16762 A double-word or a variable shift may give an incorrect result if executed
16763 while an integer multiplication is in progress.
16764 @item
16765 An integer division may give an incorrect result if started in a delay slot
16766 of a taken branch or a jump.
16767 @end itemize
16768
16769 @item -mfix-r4400
16770 @itemx -mno-fix-r4400
16771 @opindex mfix-r4400
16772 @opindex mno-fix-r4400
16773 Work around certain R4400 CPU errata:
16774 @itemize @minus
16775 @item
16776 A double-word or a variable shift may give an incorrect result if executed
16777 immediately after starting an integer division.
16778 @end itemize
16779
16780 @item -mfix-r10000
16781 @itemx -mno-fix-r10000
16782 @opindex mfix-r10000
16783 @opindex mno-fix-r10000
16784 Work around certain R10000 errata:
16785 @itemize @minus
16786 @item
16787 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16788 prior to 3.0. They may deadlock on revisions 2.6 and earlier.
16789 @end itemize
16790
16791 This option can only be used if the target architecture supports
16792 branch-likely instructions. @option{-mfix-r10000} is the default when
16793 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16794 otherwise.
16795
16796 @item -mfix-vr4120
16797 @itemx -mno-fix-vr4120
16798 @opindex mfix-vr4120
16799 Work around certain VR4120 errata:
16800 @itemize @minus
16801 @item
16802 @code{dmultu} does not always produce the correct result.
16803 @item
16804 @code{div} and @code{ddiv} do not always produce the correct result if one
16805 of the operands is negative.
16806 @end itemize
16807 The workarounds for the division errata rely on special functions in
16808 @file{libgcc.a}. At present, these functions are only provided by
16809 the @code{mips64vr*-elf} configurations.
16810
16811 Other VR4120 errata require a NOP to be inserted between certain pairs of
16812 instructions. These errata are handled by the assembler, not by GCC itself.
16813
16814 @item -mfix-vr4130
16815 @opindex mfix-vr4130
16816 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
16817 workarounds are implemented by the assembler rather than by GCC,
16818 although GCC avoids using @code{mflo} and @code{mfhi} if the
16819 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16820 instructions are available instead.
16821
16822 @item -mfix-sb1
16823 @itemx -mno-fix-sb1
16824 @opindex mfix-sb1
16825 Work around certain SB-1 CPU core errata.
16826 (This flag currently works around the SB-1 revision 2
16827 ``F1'' and ``F2'' floating-point errata.)
16828
16829 @item -mr10k-cache-barrier=@var{setting}
16830 @opindex mr10k-cache-barrier
16831 Specify whether GCC should insert cache barriers to avoid the
16832 side-effects of speculation on R10K processors.
16833
16834 In common with many processors, the R10K tries to predict the outcome
16835 of a conditional branch and speculatively executes instructions from
16836 the ``taken'' branch. It later aborts these instructions if the
16837 predicted outcome is wrong. However, on the R10K, even aborted
16838 instructions can have side effects.
16839
16840 This problem only affects kernel stores and, depending on the system,
16841 kernel loads. As an example, a speculatively-executed store may load
16842 the target memory into cache and mark the cache line as dirty, even if
16843 the store itself is later aborted. If a DMA operation writes to the
16844 same area of memory before the ``dirty'' line is flushed, the cached
16845 data overwrites the DMA-ed data. See the R10K processor manual
16846 for a full description, including other potential problems.
16847
16848 One workaround is to insert cache barrier instructions before every memory
16849 access that might be speculatively executed and that might have side
16850 effects even if aborted. @option{-mr10k-cache-barrier=@var{setting}}
16851 controls GCC's implementation of this workaround. It assumes that
16852 aborted accesses to any byte in the following regions does not have
16853 side effects:
16854
16855 @enumerate
16856 @item
16857 the memory occupied by the current function's stack frame;
16858
16859 @item
16860 the memory occupied by an incoming stack argument;
16861
16862 @item
16863 the memory occupied by an object with a link-time-constant address.
16864 @end enumerate
16865
16866 It is the kernel's responsibility to ensure that speculative
16867 accesses to these regions are indeed safe.
16868
16869 If the input program contains a function declaration such as:
16870
16871 @smallexample
16872 void foo (void);
16873 @end smallexample
16874
16875 then the implementation of @code{foo} must allow @code{j foo} and
16876 @code{jal foo} to be executed speculatively. GCC honors this
16877 restriction for functions it compiles itself. It expects non-GCC
16878 functions (such as hand-written assembly code) to do the same.
16879
16880 The option has three forms:
16881
16882 @table @gcctabopt
16883 @item -mr10k-cache-barrier=load-store
16884 Insert a cache barrier before a load or store that might be
16885 speculatively executed and that might have side effects even
16886 if aborted.
16887
16888 @item -mr10k-cache-barrier=store
16889 Insert a cache barrier before a store that might be speculatively
16890 executed and that might have side effects even if aborted.
16891
16892 @item -mr10k-cache-barrier=none
16893 Disable the insertion of cache barriers. This is the default setting.
16894 @end table
16895
16896 @item -mflush-func=@var{func}
16897 @itemx -mno-flush-func
16898 @opindex mflush-func
16899 Specifies the function to call to flush the I and D caches, or to not
16900 call any such function. If called, the function must take the same
16901 arguments as the common @code{_flush_func()}, that is, the address of the
16902 memory range for which the cache is being flushed, the size of the
16903 memory range, and the number 3 (to flush both caches). The default
16904 depends on the target GCC was configured for, but commonly is either
16905 @samp{_flush_func} or @samp{__cpu_flush}.
16906
16907 @item mbranch-cost=@var{num}
16908 @opindex mbranch-cost
16909 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16910 This cost is only a heuristic and is not guaranteed to produce
16911 consistent results across releases. A zero cost redundantly selects
16912 the default, which is based on the @option{-mtune} setting.
16913
16914 @item -mbranch-likely
16915 @itemx -mno-branch-likely
16916 @opindex mbranch-likely
16917 @opindex mno-branch-likely
16918 Enable or disable use of Branch Likely instructions, regardless of the
16919 default for the selected architecture. By default, Branch Likely
16920 instructions may be generated if they are supported by the selected
16921 architecture. An exception is for the MIPS32 and MIPS64 architectures
16922 and processors that implement those architectures; for those, Branch
16923 Likely instructions are not be generated by default because the MIPS32
16924 and MIPS64 architectures specifically deprecate their use.
16925
16926 @item -mfp-exceptions
16927 @itemx -mno-fp-exceptions
16928 @opindex mfp-exceptions
16929 Specifies whether FP exceptions are enabled. This affects how
16930 FP instructions are scheduled for some processors.
16931 The default is that FP exceptions are
16932 enabled.
16933
16934 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16935 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
16936 FP pipe.
16937
16938 @item -mvr4130-align
16939 @itemx -mno-vr4130-align
16940 @opindex mvr4130-align
16941 The VR4130 pipeline is two-way superscalar, but can only issue two
16942 instructions together if the first one is 8-byte aligned. When this
16943 option is enabled, GCC aligns pairs of instructions that it
16944 thinks should execute in parallel.
16945
16946 This option only has an effect when optimizing for the VR4130.
16947 It normally makes code faster, but at the expense of making it bigger.
16948 It is enabled by default at optimization level @option{-O3}.
16949
16950 @item -msynci
16951 @itemx -mno-synci
16952 @opindex msynci
16953 Enable (disable) generation of @code{synci} instructions on
16954 architectures that support it. The @code{synci} instructions (if
16955 enabled) are generated when @code{__builtin___clear_cache()} is
16956 compiled.
16957
16958 This option defaults to @code{-mno-synci}, but the default can be
16959 overridden by configuring with @code{--with-synci}.
16960
16961 When compiling code for single processor systems, it is generally safe
16962 to use @code{synci}. However, on many multi-core (SMP) systems, it
16963 does not invalidate the instruction caches on all cores and may lead
16964 to undefined behavior.
16965
16966 @item -mrelax-pic-calls
16967 @itemx -mno-relax-pic-calls
16968 @opindex mrelax-pic-calls
16969 Try to turn PIC calls that are normally dispatched via register
16970 @code{$25} into direct calls. This is only possible if the linker can
16971 resolve the destination at link-time and if the destination is within
16972 range for a direct call.
16973
16974 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16975 an assembler and a linker that support the @code{.reloc} assembly
16976 directive and @code{-mexplicit-relocs} is in effect. With
16977 @code{-mno-explicit-relocs}, this optimization can be performed by the
16978 assembler and the linker alone without help from the compiler.
16979
16980 @item -mmcount-ra-address
16981 @itemx -mno-mcount-ra-address
16982 @opindex mmcount-ra-address
16983 @opindex mno-mcount-ra-address
16984 Emit (do not emit) code that allows @code{_mcount} to modify the
16985 calling function's return address. When enabled, this option extends
16986 the usual @code{_mcount} interface with a new @var{ra-address}
16987 parameter, which has type @code{intptr_t *} and is passed in register
16988 @code{$12}. @code{_mcount} can then modify the return address by
16989 doing both of the following:
16990 @itemize
16991 @item
16992 Returning the new address in register @code{$31}.
16993 @item
16994 Storing the new address in @code{*@var{ra-address}},
16995 if @var{ra-address} is nonnull.
16996 @end itemize
16997
16998 The default is @option{-mno-mcount-ra-address}.
16999
17000 @end table
17001
17002 @node MMIX Options
17003 @subsection MMIX Options
17004 @cindex MMIX Options
17005
17006 These options are defined for the MMIX:
17007
17008 @table @gcctabopt
17009 @item -mlibfuncs
17010 @itemx -mno-libfuncs
17011 @opindex mlibfuncs
17012 @opindex mno-libfuncs
17013 Specify that intrinsic library functions are being compiled, passing all
17014 values in registers, no matter the size.
17015
17016 @item -mepsilon
17017 @itemx -mno-epsilon
17018 @opindex mepsilon
17019 @opindex mno-epsilon
17020 Generate floating-point comparison instructions that compare with respect
17021 to the @code{rE} epsilon register.
17022
17023 @item -mabi=mmixware
17024 @itemx -mabi=gnu
17025 @opindex mabi=mmixware
17026 @opindex mabi=gnu
17027 Generate code that passes function parameters and return values that (in
17028 the called function) are seen as registers @code{$0} and up, as opposed to
17029 the GNU ABI which uses global registers @code{$231} and up.
17030
17031 @item -mzero-extend
17032 @itemx -mno-zero-extend
17033 @opindex mzero-extend
17034 @opindex mno-zero-extend
17035 When reading data from memory in sizes shorter than 64 bits, use (do not
17036 use) zero-extending load instructions by default, rather than
17037 sign-extending ones.
17038
17039 @item -mknuthdiv
17040 @itemx -mno-knuthdiv
17041 @opindex mknuthdiv
17042 @opindex mno-knuthdiv
17043 Make the result of a division yielding a remainder have the same sign as
17044 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
17045 remainder follows the sign of the dividend. Both methods are
17046 arithmetically valid, the latter being almost exclusively used.
17047
17048 @item -mtoplevel-symbols
17049 @itemx -mno-toplevel-symbols
17050 @opindex mtoplevel-symbols
17051 @opindex mno-toplevel-symbols
17052 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
17053 code can be used with the @code{PREFIX} assembly directive.
17054
17055 @item -melf
17056 @opindex melf
17057 Generate an executable in the ELF format, rather than the default
17058 @samp{mmo} format used by the @command{mmix} simulator.
17059
17060 @item -mbranch-predict
17061 @itemx -mno-branch-predict
17062 @opindex mbranch-predict
17063 @opindex mno-branch-predict
17064 Use (do not use) the probable-branch instructions, when static branch
17065 prediction indicates a probable branch.
17066
17067 @item -mbase-addresses
17068 @itemx -mno-base-addresses
17069 @opindex mbase-addresses
17070 @opindex mno-base-addresses
17071 Generate (do not generate) code that uses @emph{base addresses}. Using a
17072 base address automatically generates a request (handled by the assembler
17073 and the linker) for a constant to be set up in a global register. The
17074 register is used for one or more base address requests within the range 0
17075 to 255 from the value held in the register. The generally leads to short
17076 and fast code, but the number of different data items that can be
17077 addressed is limited. This means that a program that uses lots of static
17078 data may require @option{-mno-base-addresses}.
17079
17080 @item -msingle-exit
17081 @itemx -mno-single-exit
17082 @opindex msingle-exit
17083 @opindex mno-single-exit
17084 Force (do not force) generated code to have a single exit point in each
17085 function.
17086 @end table
17087
17088 @node MN10300 Options
17089 @subsection MN10300 Options
17090 @cindex MN10300 options
17091
17092 These @option{-m} options are defined for Matsushita MN10300 architectures:
17093
17094 @table @gcctabopt
17095 @item -mmult-bug
17096 @opindex mmult-bug
17097 Generate code to avoid bugs in the multiply instructions for the MN10300
17098 processors. This is the default.
17099
17100 @item -mno-mult-bug
17101 @opindex mno-mult-bug
17102 Do not generate code to avoid bugs in the multiply instructions for the
17103 MN10300 processors.
17104
17105 @item -mam33
17106 @opindex mam33
17107 Generate code using features specific to the AM33 processor.
17108
17109 @item -mno-am33
17110 @opindex mno-am33
17111 Do not generate code using features specific to the AM33 processor. This
17112 is the default.
17113
17114 @item -mam33-2
17115 @opindex mam33-2
17116 Generate code using features specific to the AM33/2.0 processor.
17117
17118 @item -mam34
17119 @opindex mam34
17120 Generate code using features specific to the AM34 processor.
17121
17122 @item -mtune=@var{cpu-type}
17123 @opindex mtune
17124 Use the timing characteristics of the indicated CPU type when
17125 scheduling instructions. This does not change the targeted processor
17126 type. The CPU type must be one of @samp{mn10300}, @samp{am33},
17127 @samp{am33-2} or @samp{am34}.
17128
17129 @item -mreturn-pointer-on-d0
17130 @opindex mreturn-pointer-on-d0
17131 When generating a function that returns a pointer, return the pointer
17132 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
17133 only in @code{a0}, and attempts to call such functions without a prototype
17134 result in errors. Note that this option is on by default; use
17135 @option{-mno-return-pointer-on-d0} to disable it.
17136
17137 @item -mno-crt0
17138 @opindex mno-crt0
17139 Do not link in the C run-time initialization object file.
17140
17141 @item -mrelax
17142 @opindex mrelax
17143 Indicate to the linker that it should perform a relaxation optimization pass
17144 to shorten branches, calls and absolute memory addresses. This option only
17145 has an effect when used on the command line for the final link step.
17146
17147 This option makes symbolic debugging impossible.
17148
17149 @item -mliw
17150 @opindex mliw
17151 Allow the compiler to generate @emph{Long Instruction Word}
17152 instructions if the target is the @samp{AM33} or later. This is the
17153 default. This option defines the preprocessor macro @samp{__LIW__}.
17154
17155 @item -mnoliw
17156 @opindex mnoliw
17157 Do not allow the compiler to generate @emph{Long Instruction Word}
17158 instructions. This option defines the preprocessor macro
17159 @samp{__NO_LIW__}.
17160
17161 @item -msetlb
17162 @opindex msetlb
17163 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
17164 instructions if the target is the @samp{AM33} or later. This is the
17165 default. This option defines the preprocessor macro @samp{__SETLB__}.
17166
17167 @item -mnosetlb
17168 @opindex mnosetlb
17169 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
17170 instructions. This option defines the preprocessor macro
17171 @samp{__NO_SETLB__}.
17172
17173 @end table
17174
17175 @node Moxie Options
17176 @subsection Moxie Options
17177 @cindex Moxie Options
17178
17179 @table @gcctabopt
17180
17181 @item -meb
17182 @opindex meb
17183 Generate big-endian code. This is the default for @samp{moxie-*-*}
17184 configurations.
17185
17186 @item -mel
17187 @opindex mel
17188 Generate little-endian code.
17189
17190 @item -mno-crt0
17191 @opindex mno-crt0
17192 Do not link in the C run-time initialization object file.
17193
17194 @end table
17195
17196 @node PDP-11 Options
17197 @subsection PDP-11 Options
17198 @cindex PDP-11 Options
17199
17200 These options are defined for the PDP-11:
17201
17202 @table @gcctabopt
17203 @item -mfpu
17204 @opindex mfpu
17205 Use hardware FPP floating point. This is the default. (FIS floating
17206 point on the PDP-11/40 is not supported.)
17207
17208 @item -msoft-float
17209 @opindex msoft-float
17210 Do not use hardware floating point.
17211
17212 @item -mac0
17213 @opindex mac0
17214 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
17215
17216 @item -mno-ac0
17217 @opindex mno-ac0
17218 Return floating-point results in memory. This is the default.
17219
17220 @item -m40
17221 @opindex m40
17222 Generate code for a PDP-11/40.
17223
17224 @item -m45
17225 @opindex m45
17226 Generate code for a PDP-11/45. This is the default.
17227
17228 @item -m10
17229 @opindex m10
17230 Generate code for a PDP-11/10.
17231
17232 @item -mbcopy-builtin
17233 @opindex mbcopy-builtin
17234 Use inline @code{movmemhi} patterns for copying memory. This is the
17235 default.
17236
17237 @item -mbcopy
17238 @opindex mbcopy
17239 Do not use inline @code{movmemhi} patterns for copying memory.
17240
17241 @item -mint16
17242 @itemx -mno-int32
17243 @opindex mint16
17244 @opindex mno-int32
17245 Use 16-bit @code{int}. This is the default.
17246
17247 @item -mint32
17248 @itemx -mno-int16
17249 @opindex mint32
17250 @opindex mno-int16
17251 Use 32-bit @code{int}.
17252
17253 @item -mfloat64
17254 @itemx -mno-float32
17255 @opindex mfloat64
17256 @opindex mno-float32
17257 Use 64-bit @code{float}. This is the default.
17258
17259 @item -mfloat32
17260 @itemx -mno-float64
17261 @opindex mfloat32
17262 @opindex mno-float64
17263 Use 32-bit @code{float}.
17264
17265 @item -mabshi
17266 @opindex mabshi
17267 Use @code{abshi2} pattern. This is the default.
17268
17269 @item -mno-abshi
17270 @opindex mno-abshi
17271 Do not use @code{abshi2} pattern.
17272
17273 @item -mbranch-expensive
17274 @opindex mbranch-expensive
17275 Pretend that branches are expensive. This is for experimenting with
17276 code generation only.
17277
17278 @item -mbranch-cheap
17279 @opindex mbranch-cheap
17280 Do not pretend that branches are expensive. This is the default.
17281
17282 @item -munix-asm
17283 @opindex munix-asm
17284 Use Unix assembler syntax. This is the default when configured for
17285 @samp{pdp11-*-bsd}.
17286
17287 @item -mdec-asm
17288 @opindex mdec-asm
17289 Use DEC assembler syntax. This is the default when configured for any
17290 PDP-11 target other than @samp{pdp11-*-bsd}.
17291 @end table
17292
17293 @node picoChip Options
17294 @subsection picoChip Options
17295 @cindex picoChip options
17296
17297 These @samp{-m} options are defined for picoChip implementations:
17298
17299 @table @gcctabopt
17300
17301 @item -mae=@var{ae_type}
17302 @opindex mcpu
17303 Set the instruction set, register set, and instruction scheduling
17304 parameters for array element type @var{ae_type}. Supported values
17305 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
17306
17307 @option{-mae=ANY} selects a completely generic AE type. Code
17308 generated with this option runs on any of the other AE types. The
17309 code is not as efficient as it would be if compiled for a specific
17310 AE type, and some types of operation (e.g., multiplication) do not
17311 work properly on all types of AE.
17312
17313 @option{-mae=MUL} selects a MUL AE type. This is the most useful AE type
17314 for compiled code, and is the default.
17315
17316 @option{-mae=MAC} selects a DSP-style MAC AE. Code compiled with this
17317 option may suffer from poor performance of byte (char) manipulation,
17318 since the DSP AE does not provide hardware support for byte load/stores.
17319
17320 @item -msymbol-as-address
17321 Enable the compiler to directly use a symbol name as an address in a
17322 load/store instruction, without first loading it into a
17323 register. Typically, the use of this option generates larger
17324 programs, which run faster than when the option isn't used. However, the
17325 results vary from program to program, so it is left as a user option,
17326 rather than being permanently enabled.
17327
17328 @item -mno-inefficient-warnings
17329 Disables warnings about the generation of inefficient code. These
17330 warnings can be generated, for example, when compiling code that
17331 performs byte-level memory operations on the MAC AE type. The MAC AE has
17332 no hardware support for byte-level memory operations, so all byte
17333 load/stores must be synthesized from word load/store operations. This is
17334 inefficient and a warning is generated to indicate
17335 that you should rewrite the code to avoid byte operations, or to target
17336 an AE type that has the necessary hardware support. This option disables
17337 these warnings.
17338
17339 @end table
17340
17341 @node PowerPC Options
17342 @subsection PowerPC Options
17343 @cindex PowerPC options
17344
17345 These are listed under @xref{RS/6000 and PowerPC Options}.
17346
17347 @node RL78 Options
17348 @subsection RL78 Options
17349 @cindex RL78 Options
17350
17351 @table @gcctabopt
17352
17353 @item -msim
17354 @opindex msim
17355 Links in additional target libraries to support operation within a
17356 simulator.
17357
17358 @item -mmul=none
17359 @itemx -mmul=g13
17360 @itemx -mmul=rl78
17361 @opindex mmul
17362 Specifies the type of hardware multiplication support to be used. The
17363 default is @code{none}, which uses software multiplication functions.
17364 The @code{g13} option is for the hardware multiply/divide peripheral
17365 only on the RL78/G13 targets. The @code{rl78} option is for the
17366 standard hardware multiplication defined in the RL78 software manual.
17367
17368 @end table
17369
17370 @node RS/6000 and PowerPC Options
17371 @subsection IBM RS/6000 and PowerPC Options
17372 @cindex RS/6000 and PowerPC Options
17373 @cindex IBM RS/6000 and PowerPC Options
17374
17375 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
17376 @table @gcctabopt
17377 @item -mpowerpc-gpopt
17378 @itemx -mno-powerpc-gpopt
17379 @itemx -mpowerpc-gfxopt
17380 @itemx -mno-powerpc-gfxopt
17381 @need 800
17382 @itemx -mpowerpc64
17383 @itemx -mno-powerpc64
17384 @itemx -mmfcrf
17385 @itemx -mno-mfcrf
17386 @itemx -mpopcntb
17387 @itemx -mno-popcntb
17388 @itemx -mpopcntd
17389 @itemx -mno-popcntd
17390 @itemx -mfprnd
17391 @itemx -mno-fprnd
17392 @need 800
17393 @itemx -mcmpb
17394 @itemx -mno-cmpb
17395 @itemx -mmfpgpr
17396 @itemx -mno-mfpgpr
17397 @itemx -mhard-dfp
17398 @itemx -mno-hard-dfp
17399 @opindex mpowerpc-gpopt
17400 @opindex mno-powerpc-gpopt
17401 @opindex mpowerpc-gfxopt
17402 @opindex mno-powerpc-gfxopt
17403 @opindex mpowerpc64
17404 @opindex mno-powerpc64
17405 @opindex mmfcrf
17406 @opindex mno-mfcrf
17407 @opindex mpopcntb
17408 @opindex mno-popcntb
17409 @opindex mpopcntd
17410 @opindex mno-popcntd
17411 @opindex mfprnd
17412 @opindex mno-fprnd
17413 @opindex mcmpb
17414 @opindex mno-cmpb
17415 @opindex mmfpgpr
17416 @opindex mno-mfpgpr
17417 @opindex mhard-dfp
17418 @opindex mno-hard-dfp
17419 You use these options to specify which instructions are available on the
17420 processor you are using. The default value of these options is
17421 determined when configuring GCC@. Specifying the
17422 @option{-mcpu=@var{cpu_type}} overrides the specification of these
17423 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
17424 rather than the options listed above.
17425
17426 Specifying @option{-mpowerpc-gpopt} allows
17427 GCC to use the optional PowerPC architecture instructions in the
17428 General Purpose group, including floating-point square root. Specifying
17429 @option{-mpowerpc-gfxopt} allows GCC to
17430 use the optional PowerPC architecture instructions in the Graphics
17431 group, including floating-point select.
17432
17433 The @option{-mmfcrf} option allows GCC to generate the move from
17434 condition register field instruction implemented on the POWER4
17435 processor and other processors that support the PowerPC V2.01
17436 architecture.
17437 The @option{-mpopcntb} option allows GCC to generate the popcount and
17438 double-precision FP reciprocal estimate instruction implemented on the
17439 POWER5 processor and other processors that support the PowerPC V2.02
17440 architecture.
17441 The @option{-mpopcntd} option allows GCC to generate the popcount
17442 instruction implemented on the POWER7 processor and other processors
17443 that support the PowerPC V2.06 architecture.
17444 The @option{-mfprnd} option allows GCC to generate the FP round to
17445 integer instructions implemented on the POWER5+ processor and other
17446 processors that support the PowerPC V2.03 architecture.
17447 The @option{-mcmpb} option allows GCC to generate the compare bytes
17448 instruction implemented on the POWER6 processor and other processors
17449 that support the PowerPC V2.05 architecture.
17450 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
17451 general-purpose register instructions implemented on the POWER6X
17452 processor and other processors that support the extended PowerPC V2.05
17453 architecture.
17454 The @option{-mhard-dfp} option allows GCC to generate the decimal
17455 floating-point instructions implemented on some POWER processors.
17456
17457 The @option{-mpowerpc64} option allows GCC to generate the additional
17458 64-bit instructions that are found in the full PowerPC64 architecture
17459 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
17460 @option{-mno-powerpc64}.
17461
17462 @item -mcpu=@var{cpu_type}
17463 @opindex mcpu
17464 Set architecture type, register usage, and
17465 instruction scheduling parameters for machine type @var{cpu_type}.
17466 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
17467 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
17468 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
17469 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
17470 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
17471 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
17472 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
17473 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
17474 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
17475 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
17476 @samp{powerpc64}, and @samp{rs64}.
17477
17478 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
17479 PowerPC and 64-bit PowerPC architecture machine
17480 types, with an appropriate, generic processor model assumed for
17481 scheduling purposes.
17482
17483 The other options specify a specific processor. Code generated under
17484 those options runs best on that processor, and may not run at all on
17485 others.
17486
17487 The @option{-mcpu} options automatically enable or disable the
17488 following options:
17489
17490 @gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple @gol
17491 -mpopcntb -mpopcntd -mpowerpc64 @gol
17492 -mpowerpc-gpopt -mpowerpc-gfxopt -msingle-float -mdouble-float @gol
17493 -msimple-fpu -mstring -mmulhw -mdlmzb -mmfpgpr -mvsx @gol
17494 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector -mquad-memory}
17495
17496 The particular options set for any particular CPU varies between
17497 compiler versions, depending on what setting seems to produce optimal
17498 code for that CPU; it doesn't necessarily reflect the actual hardware's
17499 capabilities. If you wish to set an individual option to a particular
17500 value, you may specify it after the @option{-mcpu} option, like
17501 @option{-mcpu=970 -mno-altivec}.
17502
17503 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
17504 not enabled or disabled by the @option{-mcpu} option at present because
17505 AIX does not have full support for these options. You may still
17506 enable or disable them individually if you're sure it'll work in your
17507 environment.
17508
17509 @item -mtune=@var{cpu_type}
17510 @opindex mtune
17511 Set the instruction scheduling parameters for machine type
17512 @var{cpu_type}, but do not set the architecture type or register usage,
17513 as @option{-mcpu=@var{cpu_type}} does. The same
17514 values for @var{cpu_type} are used for @option{-mtune} as for
17515 @option{-mcpu}. If both are specified, the code generated uses the
17516 architecture and registers set by @option{-mcpu}, but the
17517 scheduling parameters set by @option{-mtune}.
17518
17519 @item -mcmodel=small
17520 @opindex mcmodel=small
17521 Generate PowerPC64 code for the small model: The TOC is limited to
17522 64k.
17523
17524 @item -mcmodel=medium
17525 @opindex mcmodel=medium
17526 Generate PowerPC64 code for the medium model: The TOC and other static
17527 data may be up to a total of 4G in size.
17528
17529 @item -mcmodel=large
17530 @opindex mcmodel=large
17531 Generate PowerPC64 code for the large model: The TOC may be up to 4G
17532 in size. Other data and code is only limited by the 64-bit address
17533 space.
17534
17535 @item -maltivec
17536 @itemx -mno-altivec
17537 @opindex maltivec
17538 @opindex mno-altivec
17539 Generate code that uses (does not use) AltiVec instructions, and also
17540 enable the use of built-in functions that allow more direct access to
17541 the AltiVec instruction set. You may also need to set
17542 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
17543 enhancements.
17544
17545 @item -mvrsave
17546 @itemx -mno-vrsave
17547 @opindex mvrsave
17548 @opindex mno-vrsave
17549 Generate VRSAVE instructions when generating AltiVec code.
17550
17551 @item -mgen-cell-microcode
17552 @opindex mgen-cell-microcode
17553 Generate Cell microcode instructions.
17554
17555 @item -mwarn-cell-microcode
17556 @opindex mwarn-cell-microcode
17557 Warn when a Cell microcode instruction is emitted. An example
17558 of a Cell microcode instruction is a variable shift.
17559
17560 @item -msecure-plt
17561 @opindex msecure-plt
17562 Generate code that allows @command{ld} and @command{ld.so}
17563 to build executables and shared
17564 libraries with non-executable @code{.plt} and @code{.got} sections.
17565 This is a PowerPC
17566 32-bit SYSV ABI option.
17567
17568 @item -mbss-plt
17569 @opindex mbss-plt
17570 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
17571 fills in, and
17572 requires @code{.plt} and @code{.got}
17573 sections that are both writable and executable.
17574 This is a PowerPC 32-bit SYSV ABI option.
17575
17576 @item -misel
17577 @itemx -mno-isel
17578 @opindex misel
17579 @opindex mno-isel
17580 This switch enables or disables the generation of ISEL instructions.
17581
17582 @item -misel=@var{yes/no}
17583 This switch has been deprecated. Use @option{-misel} and
17584 @option{-mno-isel} instead.
17585
17586 @item -mspe
17587 @itemx -mno-spe
17588 @opindex mspe
17589 @opindex mno-spe
17590 This switch enables or disables the generation of SPE simd
17591 instructions.
17592
17593 @item -mpaired
17594 @itemx -mno-paired
17595 @opindex mpaired
17596 @opindex mno-paired
17597 This switch enables or disables the generation of PAIRED simd
17598 instructions.
17599
17600 @item -mspe=@var{yes/no}
17601 This option has been deprecated. Use @option{-mspe} and
17602 @option{-mno-spe} instead.
17603
17604 @item -mvsx
17605 @itemx -mno-vsx
17606 @opindex mvsx
17607 @opindex mno-vsx
17608 Generate code that uses (does not use) vector/scalar (VSX)
17609 instructions, and also enable the use of built-in functions that allow
17610 more direct access to the VSX instruction set.
17611
17612 @item -mcrypto
17613 @itemx -mno-crypto
17614 @opindex mcrypto
17615 @opindex mno-crypto
17616 Enable the use (disable) of the built-in functions that allow direct
17617 access to the cryptographic instructions that were added in version
17618 2.07 of the PowerPC ISA.
17619
17620 @item -mdirect-move
17621 @itemx -mno-direct-move
17622 @opindex mdirect-move
17623 @opindex mno-direct-move
17624 Generate code that uses (does not use) the instructions to move data
17625 between the general purpose registers and the vector/scalar (VSX)
17626 registers that were added in version 2.07 of the PowerPC ISA.
17627
17628 @item -mpower8-fusion
17629 @itemx -mno-power8-fusion
17630 @opindex mpower8-fusion
17631 @opindex mno-power8-fusion
17632 Generate code that keeps (does not keeps) some integer operations
17633 adjacent so that the instructions can be fused together on power8 and
17634 later processors.
17635
17636 @item -mpower8-vector
17637 @itemx -mno-power8-vector
17638 @opindex mpower8-vector
17639 @opindex mno-power8-vector
17640 Generate code that uses (does not use) the vector and scalar
17641 instructions that were added in version 2.07 of the PowerPC ISA. Also
17642 enable the use of built-in functions that allow more direct access to
17643 the vector instructions.
17644
17645 @item -mquad-memory
17646 @itemx -mno-quad-memory
17647 @opindex mquad-memory
17648 @opindex mno-quad-memory
17649 Generate code that uses (does not use) the quad word memory
17650 instructions. The @option{-mquad-memory} option requires use of
17651 64-bit mode.
17652
17653 @item -mfloat-gprs=@var{yes/single/double/no}
17654 @itemx -mfloat-gprs
17655 @opindex mfloat-gprs
17656 This switch enables or disables the generation of floating-point
17657 operations on the general-purpose registers for architectures that
17658 support it.
17659
17660 The argument @var{yes} or @var{single} enables the use of
17661 single-precision floating-point operations.
17662
17663 The argument @var{double} enables the use of single and
17664 double-precision floating-point operations.
17665
17666 The argument @var{no} disables floating-point operations on the
17667 general-purpose registers.
17668
17669 This option is currently only available on the MPC854x.
17670
17671 @item -m32
17672 @itemx -m64
17673 @opindex m32
17674 @opindex m64
17675 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
17676 targets (including GNU/Linux). The 32-bit environment sets int, long
17677 and pointer to 32 bits and generates code that runs on any PowerPC
17678 variant. The 64-bit environment sets int to 32 bits and long and
17679 pointer to 64 bits, and generates code for PowerPC64, as for
17680 @option{-mpowerpc64}.
17681
17682 @item -mfull-toc
17683 @itemx -mno-fp-in-toc
17684 @itemx -mno-sum-in-toc
17685 @itemx -mminimal-toc
17686 @opindex mfull-toc
17687 @opindex mno-fp-in-toc
17688 @opindex mno-sum-in-toc
17689 @opindex mminimal-toc
17690 Modify generation of the TOC (Table Of Contents), which is created for
17691 every executable file. The @option{-mfull-toc} option is selected by
17692 default. In that case, GCC allocates at least one TOC entry for
17693 each unique non-automatic variable reference in your program. GCC
17694 also places floating-point constants in the TOC@. However, only
17695 16,384 entries are available in the TOC@.
17696
17697 If you receive a linker error message that saying you have overflowed
17698 the available TOC space, you can reduce the amount of TOC space used
17699 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
17700 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
17701 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
17702 generate code to calculate the sum of an address and a constant at
17703 run time instead of putting that sum into the TOC@. You may specify one
17704 or both of these options. Each causes GCC to produce very slightly
17705 slower and larger code at the expense of conserving TOC space.
17706
17707 If you still run out of space in the TOC even when you specify both of
17708 these options, specify @option{-mminimal-toc} instead. This option causes
17709 GCC to make only one TOC entry for every file. When you specify this
17710 option, GCC produces code that is slower and larger but which
17711 uses extremely little TOC space. You may wish to use this option
17712 only on files that contain less frequently-executed code.
17713
17714 @item -maix64
17715 @itemx -maix32
17716 @opindex maix64
17717 @opindex maix32
17718 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
17719 @code{long} type, and the infrastructure needed to support them.
17720 Specifying @option{-maix64} implies @option{-mpowerpc64},
17721 while @option{-maix32} disables the 64-bit ABI and
17722 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
17723
17724 @item -mxl-compat
17725 @itemx -mno-xl-compat
17726 @opindex mxl-compat
17727 @opindex mno-xl-compat
17728 Produce code that conforms more closely to IBM XL compiler semantics
17729 when using AIX-compatible ABI@. Pass floating-point arguments to
17730 prototyped functions beyond the register save area (RSA) on the stack
17731 in addition to argument FPRs. Do not assume that most significant
17732 double in 128-bit long double value is properly rounded when comparing
17733 values and converting to double. Use XL symbol names for long double
17734 support routines.
17735
17736 The AIX calling convention was extended but not initially documented to
17737 handle an obscure K&R C case of calling a function that takes the
17738 address of its arguments with fewer arguments than declared. IBM XL
17739 compilers access floating-point arguments that do not fit in the
17740 RSA from the stack when a subroutine is compiled without
17741 optimization. Because always storing floating-point arguments on the
17742 stack is inefficient and rarely needed, this option is not enabled by
17743 default and only is necessary when calling subroutines compiled by IBM
17744 XL compilers without optimization.
17745
17746 @item -mpe
17747 @opindex mpe
17748 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
17749 application written to use message passing with special startup code to
17750 enable the application to run. The system must have PE installed in the
17751 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
17752 must be overridden with the @option{-specs=} option to specify the
17753 appropriate directory location. The Parallel Environment does not
17754 support threads, so the @option{-mpe} option and the @option{-pthread}
17755 option are incompatible.
17756
17757 @item -malign-natural
17758 @itemx -malign-power
17759 @opindex malign-natural
17760 @opindex malign-power
17761 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
17762 @option{-malign-natural} overrides the ABI-defined alignment of larger
17763 types, such as floating-point doubles, on their natural size-based boundary.
17764 The option @option{-malign-power} instructs GCC to follow the ABI-specified
17765 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
17766
17767 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
17768 is not supported.
17769
17770 @item -msoft-float
17771 @itemx -mhard-float
17772 @opindex msoft-float
17773 @opindex mhard-float
17774 Generate code that does not use (uses) the floating-point register set.
17775 Software floating-point emulation is provided if you use the
17776 @option{-msoft-float} option, and pass the option to GCC when linking.
17777
17778 @item -msingle-float
17779 @itemx -mdouble-float
17780 @opindex msingle-float
17781 @opindex mdouble-float
17782 Generate code for single- or double-precision floating-point operations.
17783 @option{-mdouble-float} implies @option{-msingle-float}.
17784
17785 @item -msimple-fpu
17786 @opindex msimple-fpu
17787 Do not generate @code{sqrt} and @code{div} instructions for hardware
17788 floating-point unit.
17789
17790 @item -mfpu=@var{name}
17791 @opindex mfpu
17792 Specify type of floating-point unit. Valid values for @var{name} are
17793 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
17794 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
17795 @samp{sp_full} (equivalent to @option{-msingle-float}),
17796 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
17797
17798 @item -mxilinx-fpu
17799 @opindex mxilinx-fpu
17800 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
17801
17802 @item -mmultiple
17803 @itemx -mno-multiple
17804 @opindex mmultiple
17805 @opindex mno-multiple
17806 Generate code that uses (does not use) the load multiple word
17807 instructions and the store multiple word instructions. These
17808 instructions are generated by default on POWER systems, and not
17809 generated on PowerPC systems. Do not use @option{-mmultiple} on little-endian
17810 PowerPC systems, since those instructions do not work when the
17811 processor is in little-endian mode. The exceptions are PPC740 and
17812 PPC750 which permit these instructions in little-endian mode.
17813
17814 @item -mstring
17815 @itemx -mno-string
17816 @opindex mstring
17817 @opindex mno-string
17818 Generate code that uses (does not use) the load string instructions
17819 and the store string word instructions to save multiple registers and
17820 do small block moves. These instructions are generated by default on
17821 POWER systems, and not generated on PowerPC systems. Do not use
17822 @option{-mstring} on little-endian PowerPC systems, since those
17823 instructions do not work when the processor is in little-endian mode.
17824 The exceptions are PPC740 and PPC750 which permit these instructions
17825 in little-endian mode.
17826
17827 @item -mupdate
17828 @itemx -mno-update
17829 @opindex mupdate
17830 @opindex mno-update
17831 Generate code that uses (does not use) the load or store instructions
17832 that update the base register to the address of the calculated memory
17833 location. These instructions are generated by default. If you use
17834 @option{-mno-update}, there is a small window between the time that the
17835 stack pointer is updated and the address of the previous frame is
17836 stored, which means code that walks the stack frame across interrupts or
17837 signals may get corrupted data.
17838
17839 @item -mavoid-indexed-addresses
17840 @itemx -mno-avoid-indexed-addresses
17841 @opindex mavoid-indexed-addresses
17842 @opindex mno-avoid-indexed-addresses
17843 Generate code that tries to avoid (not avoid) the use of indexed load
17844 or store instructions. These instructions can incur a performance
17845 penalty on Power6 processors in certain situations, such as when
17846 stepping through large arrays that cross a 16M boundary. This option
17847 is enabled by default when targeting Power6 and disabled otherwise.
17848
17849 @item -mfused-madd
17850 @itemx -mno-fused-madd
17851 @opindex mfused-madd
17852 @opindex mno-fused-madd
17853 Generate code that uses (does not use) the floating-point multiply and
17854 accumulate instructions. These instructions are generated by default
17855 if hardware floating point is used. The machine-dependent
17856 @option{-mfused-madd} option is now mapped to the machine-independent
17857 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17858 mapped to @option{-ffp-contract=off}.
17859
17860 @item -mmulhw
17861 @itemx -mno-mulhw
17862 @opindex mmulhw
17863 @opindex mno-mulhw
17864 Generate code that uses (does not use) the half-word multiply and
17865 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17866 These instructions are generated by default when targeting those
17867 processors.
17868
17869 @item -mdlmzb
17870 @itemx -mno-dlmzb
17871 @opindex mdlmzb
17872 @opindex mno-dlmzb
17873 Generate code that uses (does not use) the string-search @samp{dlmzb}
17874 instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
17875 generated by default when targeting those processors.
17876
17877 @item -mno-bit-align
17878 @itemx -mbit-align
17879 @opindex mno-bit-align
17880 @opindex mbit-align
17881 On System V.4 and embedded PowerPC systems do not (do) force structures
17882 and unions that contain bit-fields to be aligned to the base type of the
17883 bit-field.
17884
17885 For example, by default a structure containing nothing but 8
17886 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17887 boundary and has a size of 4 bytes. By using @option{-mno-bit-align},
17888 the structure is aligned to a 1-byte boundary and is 1 byte in
17889 size.
17890
17891 @item -mno-strict-align
17892 @itemx -mstrict-align
17893 @opindex mno-strict-align
17894 @opindex mstrict-align
17895 On System V.4 and embedded PowerPC systems do not (do) assume that
17896 unaligned memory references are handled by the system.
17897
17898 @item -mrelocatable
17899 @itemx -mno-relocatable
17900 @opindex mrelocatable
17901 @opindex mno-relocatable
17902 Generate code that allows (does not allow) a static executable to be
17903 relocated to a different address at run time. A simple embedded
17904 PowerPC system loader should relocate the entire contents of
17905 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17906 a table of 32-bit addresses generated by this option. For this to
17907 work, all objects linked together must be compiled with
17908 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17909 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17910
17911 @item -mrelocatable-lib
17912 @itemx -mno-relocatable-lib
17913 @opindex mrelocatable-lib
17914 @opindex mno-relocatable-lib
17915 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17916 @code{.fixup} section to allow static executables to be relocated at
17917 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17918 alignment of @option{-mrelocatable}. Objects compiled with
17919 @option{-mrelocatable-lib} may be linked with objects compiled with
17920 any combination of the @option{-mrelocatable} options.
17921
17922 @item -mno-toc
17923 @itemx -mtoc
17924 @opindex mno-toc
17925 @opindex mtoc
17926 On System V.4 and embedded PowerPC systems do not (do) assume that
17927 register 2 contains a pointer to a global area pointing to the addresses
17928 used in the program.
17929
17930 @item -mlittle
17931 @itemx -mlittle-endian
17932 @opindex mlittle
17933 @opindex mlittle-endian
17934 On System V.4 and embedded PowerPC systems compile code for the
17935 processor in little-endian mode. The @option{-mlittle-endian} option is
17936 the same as @option{-mlittle}.
17937
17938 @item -mbig
17939 @itemx -mbig-endian
17940 @opindex mbig
17941 @opindex mbig-endian
17942 On System V.4 and embedded PowerPC systems compile code for the
17943 processor in big-endian mode. The @option{-mbig-endian} option is
17944 the same as @option{-mbig}.
17945
17946 @item -mdynamic-no-pic
17947 @opindex mdynamic-no-pic
17948 On Darwin and Mac OS X systems, compile code so that it is not
17949 relocatable, but that its external references are relocatable. The
17950 resulting code is suitable for applications, but not shared
17951 libraries.
17952
17953 @item -msingle-pic-base
17954 @opindex msingle-pic-base
17955 Treat the register used for PIC addressing as read-only, rather than
17956 loading it in the prologue for each function. The runtime system is
17957 responsible for initializing this register with an appropriate value
17958 before execution begins.
17959
17960 @item -mprioritize-restricted-insns=@var{priority}
17961 @opindex mprioritize-restricted-insns
17962 This option controls the priority that is assigned to
17963 dispatch-slot restricted instructions during the second scheduling
17964 pass. The argument @var{priority} takes the value @samp{0}, @samp{1},
17965 or @samp{2} to assign no, highest, or second-highest (respectively)
17966 priority to dispatch-slot restricted
17967 instructions.
17968
17969 @item -msched-costly-dep=@var{dependence_type}
17970 @opindex msched-costly-dep
17971 This option controls which dependences are considered costly
17972 by the target during instruction scheduling. The argument
17973 @var{dependence_type} takes one of the following values:
17974
17975 @table @asis
17976 @item @samp{no}
17977 No dependence is costly.
17978
17979 @item @samp{all}
17980 All dependences are costly.
17981
17982 @item @samp{true_store_to_load}
17983 A true dependence from store to load is costly.
17984
17985 @item @samp{store_to_load}
17986 Any dependence from store to load is costly.
17987
17988 @item @var{number}
17989 Any dependence for which the latency is greater than or equal to
17990 @var{number} is costly.
17991 @end table
17992
17993 @item -minsert-sched-nops=@var{scheme}
17994 @opindex minsert-sched-nops
17995 This option controls which NOP insertion scheme is used during
17996 the second scheduling pass. The argument @var{scheme} takes one of the
17997 following values:
17998
17999 @table @asis
18000 @item @samp{no}
18001 Don't insert NOPs.
18002
18003 @item @samp{pad}
18004 Pad with NOPs any dispatch group that has vacant issue slots,
18005 according to the scheduler's grouping.
18006
18007 @item @samp{regroup_exact}
18008 Insert NOPs to force costly dependent insns into
18009 separate groups. Insert exactly as many NOPs as needed to force an insn
18010 to a new group, according to the estimated processor grouping.
18011
18012 @item @var{number}
18013 Insert NOPs to force costly dependent insns into
18014 separate groups. Insert @var{number} NOPs to force an insn to a new group.
18015 @end table
18016
18017 @item -mcall-sysv
18018 @opindex mcall-sysv
18019 On System V.4 and embedded PowerPC systems compile code using calling
18020 conventions that adhere to the March 1995 draft of the System V
18021 Application Binary Interface, PowerPC processor supplement. This is the
18022 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
18023
18024 @item -mcall-sysv-eabi
18025 @itemx -mcall-eabi
18026 @opindex mcall-sysv-eabi
18027 @opindex mcall-eabi
18028 Specify both @option{-mcall-sysv} and @option{-meabi} options.
18029
18030 @item -mcall-sysv-noeabi
18031 @opindex mcall-sysv-noeabi
18032 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
18033
18034 @item -mcall-aixdesc
18035 @opindex m
18036 On System V.4 and embedded PowerPC systems compile code for the AIX
18037 operating system.
18038
18039 @item -mcall-linux
18040 @opindex mcall-linux
18041 On System V.4 and embedded PowerPC systems compile code for the
18042 Linux-based GNU system.
18043
18044 @item -mcall-freebsd
18045 @opindex mcall-freebsd
18046 On System V.4 and embedded PowerPC systems compile code for the
18047 FreeBSD operating system.
18048
18049 @item -mcall-netbsd
18050 @opindex mcall-netbsd
18051 On System V.4 and embedded PowerPC systems compile code for the
18052 NetBSD operating system.
18053
18054 @item -mcall-openbsd
18055 @opindex mcall-netbsd
18056 On System V.4 and embedded PowerPC systems compile code for the
18057 OpenBSD operating system.
18058
18059 @item -maix-struct-return
18060 @opindex maix-struct-return
18061 Return all structures in memory (as specified by the AIX ABI)@.
18062
18063 @item -msvr4-struct-return
18064 @opindex msvr4-struct-return
18065 Return structures smaller than 8 bytes in registers (as specified by the
18066 SVR4 ABI)@.
18067
18068 @item -mabi=@var{abi-type}
18069 @opindex mabi
18070 Extend the current ABI with a particular extension, or remove such extension.
18071 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
18072 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
18073
18074 @item -mabi=spe
18075 @opindex mabi=spe
18076 Extend the current ABI with SPE ABI extensions. This does not change
18077 the default ABI, instead it adds the SPE ABI extensions to the current
18078 ABI@.
18079
18080 @item -mabi=no-spe
18081 @opindex mabi=no-spe
18082 Disable Book-E SPE ABI extensions for the current ABI@.
18083
18084 @item -mabi=ibmlongdouble
18085 @opindex mabi=ibmlongdouble
18086 Change the current ABI to use IBM extended-precision long double.
18087 This is a PowerPC 32-bit SYSV ABI option.
18088
18089 @item -mabi=ieeelongdouble
18090 @opindex mabi=ieeelongdouble
18091 Change the current ABI to use IEEE extended-precision long double.
18092 This is a PowerPC 32-bit Linux ABI option.
18093
18094 @item -mprototype
18095 @itemx -mno-prototype
18096 @opindex mprototype
18097 @opindex mno-prototype
18098 On System V.4 and embedded PowerPC systems assume that all calls to
18099 variable argument functions are properly prototyped. Otherwise, the
18100 compiler must insert an instruction before every non-prototyped call to
18101 set or clear bit 6 of the condition code register (@var{CR}) to
18102 indicate whether floating-point values are passed in the floating-point
18103 registers in case the function takes variable arguments. With
18104 @option{-mprototype}, only calls to prototyped variable argument functions
18105 set or clear the bit.
18106
18107 @item -msim
18108 @opindex msim
18109 On embedded PowerPC systems, assume that the startup module is called
18110 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
18111 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}
18112 configurations.
18113
18114 @item -mmvme
18115 @opindex mmvme
18116 On embedded PowerPC systems, assume that the startup module is called
18117 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
18118 @file{libc.a}.
18119
18120 @item -mads
18121 @opindex mads
18122 On embedded PowerPC systems, assume that the startup module is called
18123 @file{crt0.o} and the standard C libraries are @file{libads.a} and
18124 @file{libc.a}.
18125
18126 @item -myellowknife
18127 @opindex myellowknife
18128 On embedded PowerPC systems, assume that the startup module is called
18129 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
18130 @file{libc.a}.
18131
18132 @item -mvxworks
18133 @opindex mvxworks
18134 On System V.4 and embedded PowerPC systems, specify that you are
18135 compiling for a VxWorks system.
18136
18137 @item -memb
18138 @opindex memb
18139 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
18140 header to indicate that @samp{eabi} extended relocations are used.
18141
18142 @item -meabi
18143 @itemx -mno-eabi
18144 @opindex meabi
18145 @opindex mno-eabi
18146 On System V.4 and embedded PowerPC systems do (do not) adhere to the
18147 Embedded Applications Binary Interface (EABI), which is a set of
18148 modifications to the System V.4 specifications. Selecting @option{-meabi}
18149 means that the stack is aligned to an 8-byte boundary, a function
18150 @code{__eabi} is called from @code{main} to set up the EABI
18151 environment, and the @option{-msdata} option can use both @code{r2} and
18152 @code{r13} to point to two separate small data areas. Selecting
18153 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
18154 no EABI initialization function is called from @code{main}, and the
18155 @option{-msdata} option only uses @code{r13} to point to a single
18156 small data area. The @option{-meabi} option is on by default if you
18157 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
18158
18159 @item -msdata=eabi
18160 @opindex msdata=eabi
18161 On System V.4 and embedded PowerPC systems, put small initialized
18162 @code{const} global and static data in the @samp{.sdata2} section, which
18163 is pointed to by register @code{r2}. Put small initialized
18164 non-@code{const} global and static data in the @samp{.sdata} section,
18165 which is pointed to by register @code{r13}. Put small uninitialized
18166 global and static data in the @samp{.sbss} section, which is adjacent to
18167 the @samp{.sdata} section. The @option{-msdata=eabi} option is
18168 incompatible with the @option{-mrelocatable} option. The
18169 @option{-msdata=eabi} option also sets the @option{-memb} option.
18170
18171 @item -msdata=sysv
18172 @opindex msdata=sysv
18173 On System V.4 and embedded PowerPC systems, put small global and static
18174 data in the @samp{.sdata} section, which is pointed to by register
18175 @code{r13}. Put small uninitialized global and static data in the
18176 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
18177 The @option{-msdata=sysv} option is incompatible with the
18178 @option{-mrelocatable} option.
18179
18180 @item -msdata=default
18181 @itemx -msdata
18182 @opindex msdata=default
18183 @opindex msdata
18184 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
18185 compile code the same as @option{-msdata=eabi}, otherwise compile code the
18186 same as @option{-msdata=sysv}.
18187
18188 @item -msdata=data
18189 @opindex msdata=data
18190 On System V.4 and embedded PowerPC systems, put small global
18191 data in the @samp{.sdata} section. Put small uninitialized global
18192 data in the @samp{.sbss} section. Do not use register @code{r13}
18193 to address small data however. This is the default behavior unless
18194 other @option{-msdata} options are used.
18195
18196 @item -msdata=none
18197 @itemx -mno-sdata
18198 @opindex msdata=none
18199 @opindex mno-sdata
18200 On embedded PowerPC systems, put all initialized global and static data
18201 in the @samp{.data} section, and all uninitialized data in the
18202 @samp{.bss} section.
18203
18204 @item -mblock-move-inline-limit=@var{num}
18205 @opindex mblock-move-inline-limit
18206 Inline all block moves (such as calls to @code{memcpy} or structure
18207 copies) less than or equal to @var{num} bytes. The minimum value for
18208 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
18209 targets. The default value is target-specific.
18210
18211 @item -G @var{num}
18212 @opindex G
18213 @cindex smaller data references (PowerPC)
18214 @cindex .sdata/.sdata2 references (PowerPC)
18215 On embedded PowerPC systems, put global and static items less than or
18216 equal to @var{num} bytes into the small data or BSS sections instead of
18217 the normal data or BSS section. By default, @var{num} is 8. The
18218 @option{-G @var{num}} switch is also passed to the linker.
18219 All modules should be compiled with the same @option{-G @var{num}} value.
18220
18221 @item -mregnames
18222 @itemx -mno-regnames
18223 @opindex mregnames
18224 @opindex mno-regnames
18225 On System V.4 and embedded PowerPC systems do (do not) emit register
18226 names in the assembly language output using symbolic forms.
18227
18228 @item -mlongcall
18229 @itemx -mno-longcall
18230 @opindex mlongcall
18231 @opindex mno-longcall
18232 By default assume that all calls are far away so that a longer and more
18233 expensive calling sequence is required. This is required for calls
18234 farther than 32 megabytes (33,554,432 bytes) from the current location.
18235 A short call is generated if the compiler knows
18236 the call cannot be that far away. This setting can be overridden by
18237 the @code{shortcall} function attribute, or by @code{#pragma
18238 longcall(0)}.
18239
18240 Some linkers are capable of detecting out-of-range calls and generating
18241 glue code on the fly. On these systems, long calls are unnecessary and
18242 generate slower code. As of this writing, the AIX linker can do this,
18243 as can the GNU linker for PowerPC/64. It is planned to add this feature
18244 to the GNU linker for 32-bit PowerPC systems as well.
18245
18246 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
18247 callee, L42}, plus a @dfn{branch island} (glue code). The two target
18248 addresses represent the callee and the branch island. The
18249 Darwin/PPC linker prefers the first address and generates a @code{bl
18250 callee} if the PPC @code{bl} instruction reaches the callee directly;
18251 otherwise, the linker generates @code{bl L42} to call the branch
18252 island. The branch island is appended to the body of the
18253 calling function; it computes the full 32-bit address of the callee
18254 and jumps to it.
18255
18256 On Mach-O (Darwin) systems, this option directs the compiler emit to
18257 the glue for every direct call, and the Darwin linker decides whether
18258 to use or discard it.
18259
18260 In the future, GCC may ignore all longcall specifications
18261 when the linker is known to generate glue.
18262
18263 @item -mtls-markers
18264 @itemx -mno-tls-markers
18265 @opindex mtls-markers
18266 @opindex mno-tls-markers
18267 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
18268 specifying the function argument. The relocation allows the linker to
18269 reliably associate function call with argument setup instructions for
18270 TLS optimization, which in turn allows GCC to better schedule the
18271 sequence.
18272
18273 @item -pthread
18274 @opindex pthread
18275 Adds support for multithreading with the @dfn{pthreads} library.
18276 This option sets flags for both the preprocessor and linker.
18277
18278 @item -mrecip
18279 @itemx -mno-recip
18280 @opindex mrecip
18281 This option enables use of the reciprocal estimate and
18282 reciprocal square root estimate instructions with additional
18283 Newton-Raphson steps to increase precision instead of doing a divide or
18284 square root and divide for floating-point arguments. You should use
18285 the @option{-ffast-math} option when using @option{-mrecip} (or at
18286 least @option{-funsafe-math-optimizations},
18287 @option{-finite-math-only}, @option{-freciprocal-math} and
18288 @option{-fno-trapping-math}). Note that while the throughput of the
18289 sequence is generally higher than the throughput of the non-reciprocal
18290 instruction, the precision of the sequence can be decreased by up to 2
18291 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
18292 roots.
18293
18294 @item -mrecip=@var{opt}
18295 @opindex mrecip=opt
18296 This option controls which reciprocal estimate instructions
18297 may be used. @var{opt} is a comma-separated list of options, which may
18298 be preceded by a @code{!} to invert the option:
18299 @code{all}: enable all estimate instructions,
18300 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
18301 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
18302 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
18303 @code{divf}: enable the single-precision reciprocal approximation instructions;
18304 @code{divd}: enable the double-precision reciprocal approximation instructions;
18305 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
18306 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
18307 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
18308
18309 So, for example, @option{-mrecip=all,!rsqrtd} enables
18310 all of the reciprocal estimate instructions, except for the
18311 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
18312 which handle the double-precision reciprocal square root calculations.
18313
18314 @item -mrecip-precision
18315 @itemx -mno-recip-precision
18316 @opindex mrecip-precision
18317 Assume (do not assume) that the reciprocal estimate instructions
18318 provide higher-precision estimates than is mandated by the PowerPC
18319 ABI. Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
18320 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
18321 The double-precision square root estimate instructions are not generated by
18322 default on low-precision machines, since they do not provide an
18323 estimate that converges after three steps.
18324
18325 @item -mveclibabi=@var{type}
18326 @opindex mveclibabi
18327 Specifies the ABI type to use for vectorizing intrinsics using an
18328 external library. The only type supported at present is @code{mass},
18329 which specifies to use IBM's Mathematical Acceleration Subsystem
18330 (MASS) libraries for vectorizing intrinsics using external libraries.
18331 GCC currently emits calls to @code{acosd2}, @code{acosf4},
18332 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
18333 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
18334 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
18335 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
18336 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
18337 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
18338 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
18339 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
18340 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
18341 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
18342 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
18343 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
18344 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
18345 for power7. Both @option{-ftree-vectorize} and
18346 @option{-funsafe-math-optimizations} must also be enabled. The MASS
18347 libraries must be specified at link time.
18348
18349 @item -mfriz
18350 @itemx -mno-friz
18351 @opindex mfriz
18352 Generate (do not generate) the @code{friz} instruction when the
18353 @option{-funsafe-math-optimizations} option is used to optimize
18354 rounding of floating-point values to 64-bit integer and back to floating
18355 point. The @code{friz} instruction does not return the same value if
18356 the floating-point number is too large to fit in an integer.
18357
18358 @item -mpointers-to-nested-functions
18359 @itemx -mno-pointers-to-nested-functions
18360 @opindex mpointers-to-nested-functions
18361 Generate (do not generate) code to load up the static chain register
18362 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
18363 systems where a function pointer points to a 3-word descriptor giving
18364 the function address, TOC value to be loaded in register @var{r2}, and
18365 static chain value to be loaded in register @var{r11}. The
18366 @option{-mpointers-to-nested-functions} is on by default. You cannot
18367 call through pointers to nested functions or pointers
18368 to functions compiled in other languages that use the static chain if
18369 you use the @option{-mno-pointers-to-nested-functions}.
18370
18371 @item -msave-toc-indirect
18372 @itemx -mno-save-toc-indirect
18373 @opindex msave-toc-indirect
18374 Generate (do not generate) code to save the TOC value in the reserved
18375 stack location in the function prologue if the function calls through
18376 a pointer on AIX and 64-bit Linux systems. If the TOC value is not
18377 saved in the prologue, it is saved just before the call through the
18378 pointer. The @option{-mno-save-toc-indirect} option is the default.
18379 @end table
18380
18381 @node RX Options
18382 @subsection RX Options
18383 @cindex RX Options
18384
18385 These command-line options are defined for RX targets:
18386
18387 @table @gcctabopt
18388 @item -m64bit-doubles
18389 @itemx -m32bit-doubles
18390 @opindex m64bit-doubles
18391 @opindex m32bit-doubles
18392 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18393 or 32 bits (@option{-m32bit-doubles}) in size. The default is
18394 @option{-m32bit-doubles}. @emph{Note} RX floating-point hardware only
18395 works on 32-bit values, which is why the default is
18396 @option{-m32bit-doubles}.
18397
18398 @item -fpu
18399 @itemx -nofpu
18400 @opindex fpu
18401 @opindex nofpu
18402 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
18403 floating-point hardware. The default is enabled for the @var{RX600}
18404 series and disabled for the @var{RX200} series.
18405
18406 Floating-point instructions are only generated for 32-bit floating-point
18407 values, however, so the FPU hardware is not used for doubles if the
18408 @option{-m64bit-doubles} option is used.
18409
18410 @emph{Note} If the @option{-fpu} option is enabled then
18411 @option{-funsafe-math-optimizations} is also enabled automatically.
18412 This is because the RX FPU instructions are themselves unsafe.
18413
18414 @item -mcpu=@var{name}
18415 @opindex -mcpu
18416 Selects the type of RX CPU to be targeted. Currently three types are
18417 supported, the generic @var{RX600} and @var{RX200} series hardware and
18418 the specific @var{RX610} CPU. The default is @var{RX600}.
18419
18420 The only difference between @var{RX600} and @var{RX610} is that the
18421 @var{RX610} does not support the @code{MVTIPL} instruction.
18422
18423 The @var{RX200} series does not have a hardware floating-point unit
18424 and so @option{-nofpu} is enabled by default when this type is
18425 selected.
18426
18427 @item -mbig-endian-data
18428 @itemx -mlittle-endian-data
18429 @opindex mbig-endian-data
18430 @opindex mlittle-endian-data
18431 Store data (but not code) in the big-endian format. The default is
18432 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
18433 format.
18434
18435 @item -msmall-data-limit=@var{N}
18436 @opindex msmall-data-limit
18437 Specifies the maximum size in bytes of global and static variables
18438 which can be placed into the small data area. Using the small data
18439 area can lead to smaller and faster code, but the size of area is
18440 limited and it is up to the programmer to ensure that the area does
18441 not overflow. Also when the small data area is used one of the RX's
18442 registers (usually @code{r13}) is reserved for use pointing to this
18443 area, so it is no longer available for use by the compiler. This
18444 could result in slower and/or larger code if variables are pushed onto
18445 the stack instead of being held in this register.
18446
18447 Note, common variables (variables that have not been initialized) and
18448 constants are not placed into the small data area as they are assigned
18449 to other sections in the output executable.
18450
18451 The default value is zero, which disables this feature. Note, this
18452 feature is not enabled by default with higher optimization levels
18453 (@option{-O2} etc) because of the potentially detrimental effects of
18454 reserving a register. It is up to the programmer to experiment and
18455 discover whether this feature is of benefit to their program. See the
18456 description of the @option{-mpid} option for a description of how the
18457 actual register to hold the small data area pointer is chosen.
18458
18459 @item -msim
18460 @itemx -mno-sim
18461 @opindex msim
18462 @opindex mno-sim
18463 Use the simulator runtime. The default is to use the libgloss
18464 board-specific runtime.
18465
18466 @item -mas100-syntax
18467 @itemx -mno-as100-syntax
18468 @opindex mas100-syntax
18469 @opindex mno-as100-syntax
18470 When generating assembler output use a syntax that is compatible with
18471 Renesas's AS100 assembler. This syntax can also be handled by the GAS
18472 assembler, but it has some restrictions so it is not generated by default.
18473
18474 @item -mmax-constant-size=@var{N}
18475 @opindex mmax-constant-size
18476 Specifies the maximum size, in bytes, of a constant that can be used as
18477 an operand in a RX instruction. Although the RX instruction set does
18478 allow constants of up to 4 bytes in length to be used in instructions,
18479 a longer value equates to a longer instruction. Thus in some
18480 circumstances it can be beneficial to restrict the size of constants
18481 that are used in instructions. Constants that are too big are instead
18482 placed into a constant pool and referenced via register indirection.
18483
18484 The value @var{N} can be between 0 and 4. A value of 0 (the default)
18485 or 4 means that constants of any size are allowed.
18486
18487 @item -mrelax
18488 @opindex mrelax
18489 Enable linker relaxation. Linker relaxation is a process whereby the
18490 linker attempts to reduce the size of a program by finding shorter
18491 versions of various instructions. Disabled by default.
18492
18493 @item -mint-register=@var{N}
18494 @opindex mint-register
18495 Specify the number of registers to reserve for fast interrupt handler
18496 functions. The value @var{N} can be between 0 and 4. A value of 1
18497 means that register @code{r13} is reserved for the exclusive use
18498 of fast interrupt handlers. A value of 2 reserves @code{r13} and
18499 @code{r12}. A value of 3 reserves @code{r13}, @code{r12} and
18500 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
18501 A value of 0, the default, does not reserve any registers.
18502
18503 @item -msave-acc-in-interrupts
18504 @opindex msave-acc-in-interrupts
18505 Specifies that interrupt handler functions should preserve the
18506 accumulator register. This is only necessary if normal code might use
18507 the accumulator register, for example because it performs 64-bit
18508 multiplications. The default is to ignore the accumulator as this
18509 makes the interrupt handlers faster.
18510
18511 @item -mpid
18512 @itemx -mno-pid
18513 @opindex mpid
18514 @opindex mno-pid
18515 Enables the generation of position independent data. When enabled any
18516 access to constant data is done via an offset from a base address
18517 held in a register. This allows the location of constant data to be
18518 determined at run time without requiring the executable to be
18519 relocated, which is a benefit to embedded applications with tight
18520 memory constraints. Data that can be modified is not affected by this
18521 option.
18522
18523 Note, using this feature reserves a register, usually @code{r13}, for
18524 the constant data base address. This can result in slower and/or
18525 larger code, especially in complicated functions.
18526
18527 The actual register chosen to hold the constant data base address
18528 depends upon whether the @option{-msmall-data-limit} and/or the
18529 @option{-mint-register} command-line options are enabled. Starting
18530 with register @code{r13} and proceeding downwards, registers are
18531 allocated first to satisfy the requirements of @option{-mint-register},
18532 then @option{-mpid} and finally @option{-msmall-data-limit}. Thus it
18533 is possible for the small data area register to be @code{r8} if both
18534 @option{-mint-register=4} and @option{-mpid} are specified on the
18535 command line.
18536
18537 By default this feature is not enabled. The default can be restored
18538 via the @option{-mno-pid} command-line option.
18539
18540 @item -mno-warn-multiple-fast-interrupts
18541 @itemx -mwarn-multiple-fast-interrupts
18542 @opindex mno-warn-multiple-fast-interrupts
18543 @opindex mwarn-multiple-fast-interrupts
18544 Prevents GCC from issuing a warning message if it finds more than one
18545 fast interrupt handler when it is compiling a file. The default is to
18546 issue a warning for each extra fast interrupt handler found, as the RX
18547 only supports one such interrupt.
18548
18549 @end table
18550
18551 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
18552 has special significance to the RX port when used with the
18553 @code{interrupt} function attribute. This attribute indicates a
18554 function intended to process fast interrupts. GCC ensures
18555 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
18556 and/or @code{r13} and only provided that the normal use of the
18557 corresponding registers have been restricted via the
18558 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
18559 options.
18560
18561 @node S/390 and zSeries Options
18562 @subsection S/390 and zSeries Options
18563 @cindex S/390 and zSeries Options
18564
18565 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
18566
18567 @table @gcctabopt
18568 @item -mhard-float
18569 @itemx -msoft-float
18570 @opindex mhard-float
18571 @opindex msoft-float
18572 Use (do not use) the hardware floating-point instructions and registers
18573 for floating-point operations. When @option{-msoft-float} is specified,
18574 functions in @file{libgcc.a} are used to perform floating-point
18575 operations. When @option{-mhard-float} is specified, the compiler
18576 generates IEEE floating-point instructions. This is the default.
18577
18578 @item -mhard-dfp
18579 @itemx -mno-hard-dfp
18580 @opindex mhard-dfp
18581 @opindex mno-hard-dfp
18582 Use (do not use) the hardware decimal-floating-point instructions for
18583 decimal-floating-point operations. When @option{-mno-hard-dfp} is
18584 specified, functions in @file{libgcc.a} are used to perform
18585 decimal-floating-point operations. When @option{-mhard-dfp} is
18586 specified, the compiler generates decimal-floating-point hardware
18587 instructions. This is the default for @option{-march=z9-ec} or higher.
18588
18589 @item -mlong-double-64
18590 @itemx -mlong-double-128
18591 @opindex mlong-double-64
18592 @opindex mlong-double-128
18593 These switches control the size of @code{long double} type. A size
18594 of 64 bits makes the @code{long double} type equivalent to the @code{double}
18595 type. This is the default.
18596
18597 @item -mbackchain
18598 @itemx -mno-backchain
18599 @opindex mbackchain
18600 @opindex mno-backchain
18601 Store (do not store) the address of the caller's frame as backchain pointer
18602 into the callee's stack frame.
18603 A backchain may be needed to allow debugging using tools that do not understand
18604 DWARF 2 call frame information.
18605 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
18606 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
18607 the backchain is placed into the topmost word of the 96/160 byte register
18608 save area.
18609
18610 In general, code compiled with @option{-mbackchain} is call-compatible with
18611 code compiled with @option{-mmo-backchain}; however, use of the backchain
18612 for debugging purposes usually requires that the whole binary is built with
18613 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
18614 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
18615 to build a linux kernel use @option{-msoft-float}.
18616
18617 The default is to not maintain the backchain.
18618
18619 @item -mpacked-stack
18620 @itemx -mno-packed-stack
18621 @opindex mpacked-stack
18622 @opindex mno-packed-stack
18623 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
18624 specified, the compiler uses the all fields of the 96/160 byte register save
18625 area only for their default purpose; unused fields still take up stack space.
18626 When @option{-mpacked-stack} is specified, register save slots are densely
18627 packed at the top of the register save area; unused space is reused for other
18628 purposes, allowing for more efficient use of the available stack space.
18629 However, when @option{-mbackchain} is also in effect, the topmost word of
18630 the save area is always used to store the backchain, and the return address
18631 register is always saved two words below the backchain.
18632
18633 As long as the stack frame backchain is not used, code generated with
18634 @option{-mpacked-stack} is call-compatible with code generated with
18635 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
18636 S/390 or zSeries generated code that uses the stack frame backchain at run
18637 time, not just for debugging purposes. Such code is not call-compatible
18638 with code compiled with @option{-mpacked-stack}. Also, note that the
18639 combination of @option{-mbackchain},
18640 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
18641 to build a linux kernel use @option{-msoft-float}.
18642
18643 The default is to not use the packed stack layout.
18644
18645 @item -msmall-exec
18646 @itemx -mno-small-exec
18647 @opindex msmall-exec
18648 @opindex mno-small-exec
18649 Generate (or do not generate) code using the @code{bras} instruction
18650 to do subroutine calls.
18651 This only works reliably if the total executable size does not
18652 exceed 64k. The default is to use the @code{basr} instruction instead,
18653 which does not have this limitation.
18654
18655 @item -m64
18656 @itemx -m31
18657 @opindex m64
18658 @opindex m31
18659 When @option{-m31} is specified, generate code compliant to the
18660 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
18661 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
18662 particular to generate 64-bit instructions. For the @samp{s390}
18663 targets, the default is @option{-m31}, while the @samp{s390x}
18664 targets default to @option{-m64}.
18665
18666 @item -mzarch
18667 @itemx -mesa
18668 @opindex mzarch
18669 @opindex mesa
18670 When @option{-mzarch} is specified, generate code using the
18671 instructions available on z/Architecture.
18672 When @option{-mesa} is specified, generate code using the
18673 instructions available on ESA/390. Note that @option{-mesa} is
18674 not possible with @option{-m64}.
18675 When generating code compliant to the GNU/Linux for S/390 ABI,
18676 the default is @option{-mesa}. When generating code compliant
18677 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
18678
18679 @item -mmvcle
18680 @itemx -mno-mvcle
18681 @opindex mmvcle
18682 @opindex mno-mvcle
18683 Generate (or do not generate) code using the @code{mvcle} instruction
18684 to perform block moves. When @option{-mno-mvcle} is specified,
18685 use a @code{mvc} loop instead. This is the default unless optimizing for
18686 size.
18687
18688 @item -mdebug
18689 @itemx -mno-debug
18690 @opindex mdebug
18691 @opindex mno-debug
18692 Print (or do not print) additional debug information when compiling.
18693 The default is to not print debug information.
18694
18695 @item -march=@var{cpu-type}
18696 @opindex march
18697 Generate code that runs on @var{cpu-type}, which is the name of a system
18698 representing a certain processor type. Possible values for
18699 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
18700 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
18701 When generating code using the instructions available on z/Architecture,
18702 the default is @option{-march=z900}. Otherwise, the default is
18703 @option{-march=g5}.
18704
18705 @item -mtune=@var{cpu-type}
18706 @opindex mtune
18707 Tune to @var{cpu-type} everything applicable about the generated code,
18708 except for the ABI and the set of available instructions.
18709 The list of @var{cpu-type} values is the same as for @option{-march}.
18710 The default is the value used for @option{-march}.
18711
18712 @item -mtpf-trace
18713 @itemx -mno-tpf-trace
18714 @opindex mtpf-trace
18715 @opindex mno-tpf-trace
18716 Generate code that adds (does not add) in TPF OS specific branches to trace
18717 routines in the operating system. This option is off by default, even
18718 when compiling for the TPF OS@.
18719
18720 @item -mfused-madd
18721 @itemx -mno-fused-madd
18722 @opindex mfused-madd
18723 @opindex mno-fused-madd
18724 Generate code that uses (does not use) the floating-point multiply and
18725 accumulate instructions. These instructions are generated by default if
18726 hardware floating point is used.
18727
18728 @item -mwarn-framesize=@var{framesize}
18729 @opindex mwarn-framesize
18730 Emit a warning if the current function exceeds the given frame size. Because
18731 this is a compile-time check it doesn't need to be a real problem when the program
18732 runs. It is intended to identify functions that most probably cause
18733 a stack overflow. It is useful to be used in an environment with limited stack
18734 size e.g.@: the linux kernel.
18735
18736 @item -mwarn-dynamicstack
18737 @opindex mwarn-dynamicstack
18738 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
18739 arrays. This is generally a bad idea with a limited stack size.
18740
18741 @item -mstack-guard=@var{stack-guard}
18742 @itemx -mstack-size=@var{stack-size}
18743 @opindex mstack-guard
18744 @opindex mstack-size
18745 If these options are provided the S/390 back end emits additional instructions in
18746 the function prologue that trigger a trap if the stack size is @var{stack-guard}
18747 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
18748 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
18749 the frame size of the compiled function is chosen.
18750 These options are intended to be used to help debugging stack overflow problems.
18751 The additionally emitted code causes only little overhead and hence can also be
18752 used in production-like systems without greater performance degradation. The given
18753 values have to be exact powers of 2 and @var{stack-size} has to be greater than
18754 @var{stack-guard} without exceeding 64k.
18755 In order to be efficient the extra code makes the assumption that the stack starts
18756 at an address aligned to the value given by @var{stack-size}.
18757 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
18758 @end table
18759
18760 @node Score Options
18761 @subsection Score Options
18762 @cindex Score Options
18763
18764 These options are defined for Score implementations:
18765
18766 @table @gcctabopt
18767 @item -meb
18768 @opindex meb
18769 Compile code for big-endian mode. This is the default.
18770
18771 @item -mel
18772 @opindex mel
18773 Compile code for little-endian mode.
18774
18775 @item -mnhwloop
18776 @opindex mnhwloop
18777 Disable generation of @code{bcnz} instructions.
18778
18779 @item -muls
18780 @opindex muls
18781 Enable generation of unaligned load and store instructions.
18782
18783 @item -mmac
18784 @opindex mmac
18785 Enable the use of multiply-accumulate instructions. Disabled by default.
18786
18787 @item -mscore5
18788 @opindex mscore5
18789 Specify the SCORE5 as the target architecture.
18790
18791 @item -mscore5u
18792 @opindex mscore5u
18793 Specify the SCORE5U of the target architecture.
18794
18795 @item -mscore7
18796 @opindex mscore7
18797 Specify the SCORE7 as the target architecture. This is the default.
18798
18799 @item -mscore7d
18800 @opindex mscore7d
18801 Specify the SCORE7D as the target architecture.
18802 @end table
18803
18804 @node SH Options
18805 @subsection SH Options
18806
18807 These @samp{-m} options are defined for the SH implementations:
18808
18809 @table @gcctabopt
18810 @item -m1
18811 @opindex m1
18812 Generate code for the SH1.
18813
18814 @item -m2
18815 @opindex m2
18816 Generate code for the SH2.
18817
18818 @item -m2e
18819 Generate code for the SH2e.
18820
18821 @item -m2a-nofpu
18822 @opindex m2a-nofpu
18823 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18824 that the floating-point unit is not used.
18825
18826 @item -m2a-single-only
18827 @opindex m2a-single-only
18828 Generate code for the SH2a-FPU, in such a way that no double-precision
18829 floating-point operations are used.
18830
18831 @item -m2a-single
18832 @opindex m2a-single
18833 Generate code for the SH2a-FPU assuming the floating-point unit is in
18834 single-precision mode by default.
18835
18836 @item -m2a
18837 @opindex m2a
18838 Generate code for the SH2a-FPU assuming the floating-point unit is in
18839 double-precision mode by default.
18840
18841 @item -m3
18842 @opindex m3
18843 Generate code for the SH3.
18844
18845 @item -m3e
18846 @opindex m3e
18847 Generate code for the SH3e.
18848
18849 @item -m4-nofpu
18850 @opindex m4-nofpu
18851 Generate code for the SH4 without a floating-point unit.
18852
18853 @item -m4-single-only
18854 @opindex m4-single-only
18855 Generate code for the SH4 with a floating-point unit that only
18856 supports single-precision arithmetic.
18857
18858 @item -m4-single
18859 @opindex m4-single
18860 Generate code for the SH4 assuming the floating-point unit is in
18861 single-precision mode by default.
18862
18863 @item -m4
18864 @opindex m4
18865 Generate code for the SH4.
18866
18867 @item -m4a-nofpu
18868 @opindex m4a-nofpu
18869 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18870 floating-point unit is not used.
18871
18872 @item -m4a-single-only
18873 @opindex m4a-single-only
18874 Generate code for the SH4a, in such a way that no double-precision
18875 floating-point operations are used.
18876
18877 @item -m4a-single
18878 @opindex m4a-single
18879 Generate code for the SH4a assuming the floating-point unit is in
18880 single-precision mode by default.
18881
18882 @item -m4a
18883 @opindex m4a
18884 Generate code for the SH4a.
18885
18886 @item -m4al
18887 @opindex m4al
18888 Same as @option{-m4a-nofpu}, except that it implicitly passes
18889 @option{-dsp} to the assembler. GCC doesn't generate any DSP
18890 instructions at the moment.
18891
18892 @item -mb
18893 @opindex mb
18894 Compile code for the processor in big-endian mode.
18895
18896 @item -ml
18897 @opindex ml
18898 Compile code for the processor in little-endian mode.
18899
18900 @item -mdalign
18901 @opindex mdalign
18902 Align doubles at 64-bit boundaries. Note that this changes the calling
18903 conventions, and thus some functions from the standard C library do
18904 not work unless you recompile it first with @option{-mdalign}.
18905
18906 @item -mrelax
18907 @opindex mrelax
18908 Shorten some address references at link time, when possible; uses the
18909 linker option @option{-relax}.
18910
18911 @item -mbigtable
18912 @opindex mbigtable
18913 Use 32-bit offsets in @code{switch} tables. The default is to use
18914 16-bit offsets.
18915
18916 @item -mbitops
18917 @opindex mbitops
18918 Enable the use of bit manipulation instructions on SH2A.
18919
18920 @item -mfmovd
18921 @opindex mfmovd
18922 Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for
18923 alignment constraints.
18924
18925 @item -mhitachi
18926 @opindex mhitachi
18927 Comply with the calling conventions defined by Renesas.
18928
18929 @item -mrenesas
18930 @opindex mhitachi
18931 Comply with the calling conventions defined by Renesas.
18932
18933 @item -mno-renesas
18934 @opindex mhitachi
18935 Comply with the calling conventions defined for GCC before the Renesas
18936 conventions were available. This option is the default for all
18937 targets of the SH toolchain.
18938
18939 @item -mnomacsave
18940 @opindex mnomacsave
18941 Mark the @code{MAC} register as call-clobbered, even if
18942 @option{-mhitachi} is given.
18943
18944 @item -mieee
18945 @itemx -mno-ieee
18946 @opindex mieee
18947 @opindex mnoieee
18948 Control the IEEE compliance of floating-point comparisons, which affects the
18949 handling of cases where the result of a comparison is unordered. By default
18950 @option{-mieee} is implicitly enabled. If @option{-ffinite-math-only} is
18951 enabled @option{-mno-ieee} is implicitly set, which results in faster
18952 floating-point greater-equal and less-equal comparisons. The implcit settings
18953 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18954
18955 @item -minline-ic_invalidate
18956 @opindex minline-ic_invalidate
18957 Inline code to invalidate instruction cache entries after setting up
18958 nested function trampolines.
18959 This option has no effect if @option{-musermode} is in effect and the selected
18960 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18961 instruction.
18962 If the selected code generation option does not allow the use of the @code{icbi}
18963 instruction, and @option{-musermode} is not in effect, the inlined code
18964 manipulates the instruction cache address array directly with an associative
18965 write. This not only requires privileged mode at run time, but it also
18966 fails if the cache line had been mapped via the TLB and has become unmapped.
18967
18968 @item -misize
18969 @opindex misize
18970 Dump instruction size and location in the assembly code.
18971
18972 @item -mpadstruct
18973 @opindex mpadstruct
18974 This option is deprecated. It pads structures to multiple of 4 bytes,
18975 which is incompatible with the SH ABI@.
18976
18977 @item -matomic-model=@var{model}
18978 @opindex matomic-model=@var{model}
18979 Sets the model of atomic operations and additional parameters as a comma
18980 separated list. For details on the atomic built-in functions see
18981 @ref{__atomic Builtins}. The following models and parameters are supported:
18982
18983 @table @samp
18984
18985 @item none
18986 Disable compiler generated atomic sequences and emit library calls for atomic
18987 operations. This is the default if the target is not @code{sh-*-linux*}.
18988
18989 @item soft-gusa
18990 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18991 built-in functions. The generated atomic sequences require additional support
18992 from the interrupt/exception handling code of the system and are only suitable
18993 for SH3* and SH4* single-core systems. This option is enabled by default when
18994 the target is @code{sh-*-linux*} and SH3* or SH4*. When the target is SH4A,
18995 this option will also partially utilize the hardware atomic instructions
18996 @code{movli.l} and @code{movco.l} to create more efficient code, unless
18997 @samp{strict} is specified.
18998
18999 @item soft-tcb
19000 Generate software atomic sequences that use a variable in the thread control
19001 block. This is a variation of the gUSA sequences which can also be used on
19002 SH1* and SH2* targets. The generated atomic sequences require additional
19003 support from the interrupt/exception handling code of the system and are only
19004 suitable for single-core systems. When using this model, the @samp{gbr-offset=}
19005 parameter has to be specified as well.
19006
19007 @item soft-imask
19008 Generate software atomic sequences that temporarily disable interrupts by
19009 setting @code{SR.IMASK = 1111}. This model works only when the program runs
19010 in privileged mode and is only suitable for single-core systems. Additional
19011 support from the interrupt/exception handling code of the system is not
19012 required. This model is enabled by default when the target is
19013 @code{sh-*-linux*} and SH1* or SH2*.
19014
19015 @item hard-llcs
19016 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
19017 instructions only. This is only available on SH4A and is suitable for
19018 multi-core systems. Since the hardware instructions support only 32 bit atomic
19019 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
19020 Code compiled with this option will also be compatible with other software
19021 atomic model interrupt/exception handling systems if executed on an SH4A
19022 system. Additional support from the interrupt/exception handling code of the
19023 system is not required for this model.
19024
19025 @item gbr-offset=
19026 This parameter specifies the offset in bytes of the variable in the thread
19027 control block structure that should be used by the generated atomic sequences
19028 when the @samp{soft-tcb} model has been selected. For other models this
19029 parameter is ignored. The specified value must be an integer multiple of four
19030 and in the range 0-1020.
19031
19032 @item strict
19033 This parameter prevents mixed usage of multiple atomic models, even though they
19034 would be compatible, and will make the compiler generate atomic sequences of the
19035 specified model only.
19036
19037 @end table
19038
19039 @item -mtas
19040 @opindex mtas
19041 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
19042 Notice that depending on the particular hardware and software configuration
19043 this can degrade overall performance due to the operand cache line flushes
19044 that are implied by the @code{tas.b} instruction. On multi-core SH4A
19045 processors the @code{tas.b} instruction must be used with caution since it
19046 can result in data corruption for certain cache configurations.
19047
19048 @item -mspace
19049 @opindex mspace
19050 Optimize for space instead of speed. Implied by @option{-Os}.
19051
19052 @item -mprefergot
19053 @opindex mprefergot
19054 When generating position-independent code, emit function calls using
19055 the Global Offset Table instead of the Procedure Linkage Table.
19056
19057 @item -musermode
19058 @opindex musermode
19059 Don't generate privileged mode only code. This option
19060 implies @option{-mno-inline-ic_invalidate}
19061 if the inlined code would not work in user mode.
19062 This is the default when the target is @code{sh-*-linux*}.
19063
19064 @item -multcost=@var{number}
19065 @opindex multcost=@var{number}
19066 Set the cost to assume for a multiply insn.
19067
19068 @item -mdiv=@var{strategy}
19069 @opindex mdiv=@var{strategy}
19070 Set the division strategy to be used for integer division operations.
19071 For SHmedia @var{strategy} can be one of:
19072
19073 @table @samp
19074
19075 @item fp
19076 Performs the operation in floating point. This has a very high latency,
19077 but needs only a few instructions, so it might be a good choice if
19078 your code has enough easily-exploitable ILP to allow the compiler to
19079 schedule the floating-point instructions together with other instructions.
19080 Division by zero causes a floating-point exception.
19081
19082 @item inv
19083 Uses integer operations to calculate the inverse of the divisor,
19084 and then multiplies the dividend with the inverse. This strategy allows
19085 CSE and hoisting of the inverse calculation. Division by zero calculates
19086 an unspecified result, but does not trap.
19087
19088 @item inv:minlat
19089 A variant of @samp{inv} where, if no CSE or hoisting opportunities
19090 have been found, or if the entire operation has been hoisted to the same
19091 place, the last stages of the inverse calculation are intertwined with the
19092 final multiply to reduce the overall latency, at the expense of using a few
19093 more instructions, and thus offering fewer scheduling opportunities with
19094 other code.
19095
19096 @item call
19097 Calls a library function that usually implements the @samp{inv:minlat}
19098 strategy.
19099 This gives high code density for @code{m5-*media-nofpu} compilations.
19100
19101 @item call2
19102 Uses a different entry point of the same library function, where it
19103 assumes that a pointer to a lookup table has already been set up, which
19104 exposes the pointer load to CSE and code hoisting optimizations.
19105
19106 @item inv:call
19107 @itemx inv:call2
19108 @itemx inv:fp
19109 Use the @samp{inv} algorithm for initial
19110 code generation, but if the code stays unoptimized, revert to the @samp{call},
19111 @samp{call2}, or @samp{fp} strategies, respectively. Note that the
19112 potentially-trapping side effect of division by zero is carried by a
19113 separate instruction, so it is possible that all the integer instructions
19114 are hoisted out, but the marker for the side effect stays where it is.
19115 A recombination to floating-point operations or a call is not possible
19116 in that case.
19117
19118 @item inv20u
19119 @itemx inv20l
19120 Variants of the @samp{inv:minlat} strategy. In the case
19121 that the inverse calculation is not separated from the multiply, they speed
19122 up division where the dividend fits into 20 bits (plus sign where applicable)
19123 by inserting a test to skip a number of operations in this case; this test
19124 slows down the case of larger dividends. @samp{inv20u} assumes the case of a such
19125 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
19126
19127 @end table
19128
19129 For targets other than SHmedia @var{strategy} can be one of:
19130
19131 @table @samp
19132
19133 @item call-div1
19134 Calls a library function that uses the single-step division instruction
19135 @code{div1} to perform the operation. Division by zero calculates an
19136 unspecified result and does not trap. This is the default except for SH4,
19137 SH2A and SHcompact.
19138
19139 @item call-fp
19140 Calls a library function that performs the operation in double precision
19141 floating point. Division by zero causes a floating-point exception. This is
19142 the default for SHcompact with FPU. Specifying this for targets that do not
19143 have a double precision FPU will default to @code{call-div1}.
19144
19145 @item call-table
19146 Calls a library function that uses a lookup table for small divisors and
19147 the @code{div1} instruction with case distinction for larger divisors. Division
19148 by zero calculates an unspecified result and does not trap. This is the default
19149 for SH4. Specifying this for targets that do not have dynamic shift
19150 instructions will default to @code{call-div1}.
19151
19152 @end table
19153
19154 When a division strategy has not been specified the default strategy will be
19155 selected based on the current target. For SH2A the default strategy is to
19156 use the @code{divs} and @code{divu} instructions instead of library function
19157 calls.
19158
19159 @item -maccumulate-outgoing-args
19160 @opindex maccumulate-outgoing-args
19161 Reserve space once for outgoing arguments in the function prologue rather
19162 than around each call. Generally beneficial for performance and size. Also
19163 needed for unwinding to avoid changing the stack frame around conditional code.
19164
19165 @item -mdivsi3_libfunc=@var{name}
19166 @opindex mdivsi3_libfunc=@var{name}
19167 Set the name of the library function used for 32-bit signed division to
19168 @var{name}.
19169 This only affects the name used in the @samp{call} and @samp{inv:call}
19170 division strategies, and the compiler still expects the same
19171 sets of input/output/clobbered registers as if this option were not present.
19172
19173 @item -mfixed-range=@var{register-range}
19174 @opindex mfixed-range
19175 Generate code treating the given register range as fixed registers.
19176 A fixed register is one that the register allocator can not use. This is
19177 useful when compiling kernel code. A register range is specified as
19178 two registers separated by a dash. Multiple register ranges can be
19179 specified separated by a comma.
19180
19181 @item -mindexed-addressing
19182 @opindex mindexed-addressing
19183 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
19184 This is only safe if the hardware and/or OS implement 32-bit wrap-around
19185 semantics for the indexed addressing mode. The architecture allows the
19186 implementation of processors with 64-bit MMU, which the OS could use to
19187 get 32-bit addressing, but since no current hardware implementation supports
19188 this or any other way to make the indexed addressing mode safe to use in
19189 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
19190
19191 @item -mgettrcost=@var{number}
19192 @opindex mgettrcost=@var{number}
19193 Set the cost assumed for the @code{gettr} instruction to @var{number}.
19194 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
19195
19196 @item -mpt-fixed
19197 @opindex mpt-fixed
19198 Assume @code{pt*} instructions won't trap. This generally generates
19199 better-scheduled code, but is unsafe on current hardware.
19200 The current architecture
19201 definition says that @code{ptabs} and @code{ptrel} trap when the target
19202 anded with 3 is 3.
19203 This has the unintentional effect of making it unsafe to schedule these
19204 instructions before a branch, or hoist them out of a loop. For example,
19205 @code{__do_global_ctors}, a part of @file{libgcc}
19206 that runs constructors at program
19207 startup, calls functions in a list which is delimited by @minus{}1. With the
19208 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
19209 That means that all the constructors run a bit more quickly, but when
19210 the loop comes to the end of the list, the program crashes because @code{ptabs}
19211 loads @minus{}1 into a target register.
19212
19213 Since this option is unsafe for any
19214 hardware implementing the current architecture specification, the default
19215 is @option{-mno-pt-fixed}. Unless specified explicitly with
19216 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
19217 this deters register allocation from using target registers for storing
19218 ordinary integers.
19219
19220 @item -minvalid-symbols
19221 @opindex minvalid-symbols
19222 Assume symbols might be invalid. Ordinary function symbols generated by
19223 the compiler are always valid to load with
19224 @code{movi}/@code{shori}/@code{ptabs} or
19225 @code{movi}/@code{shori}/@code{ptrel},
19226 but with assembler and/or linker tricks it is possible
19227 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
19228 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
19229 It prevents cross-basic-block CSE, hoisting and most scheduling
19230 of symbol loads. The default is @option{-mno-invalid-symbols}.
19231
19232 @item -mbranch-cost=@var{num}
19233 @opindex mbranch-cost=@var{num}
19234 Assume @var{num} to be the cost for a branch instruction. Higher numbers
19235 make the compiler try to generate more branch-free code if possible.
19236 If not specified the value is selected depending on the processor type that
19237 is being compiled for.
19238
19239 @item -mzdcbranch
19240 @itemx -mno-zdcbranch
19241 @opindex mzdcbranch
19242 @opindex mno-zdcbranch
19243 Assume (do not assume) that zero displacement conditional branch instructions
19244 @code{bt} and @code{bf} are fast. If @option{-mzdcbranch} is specified, the
19245 compiler will try to prefer zero displacement branch code sequences. This is
19246 enabled by default when generating code for SH4 and SH4A. It can be explicitly
19247 disabled by specifying @option{-mno-zdcbranch}.
19248
19249 @item -mcbranchdi
19250 @opindex mcbranchdi
19251 Enable the @code{cbranchdi4} instruction pattern.
19252
19253 @item -mcmpeqdi
19254 @opindex mcmpeqdi
19255 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
19256 is in effect.
19257
19258 @item -mfused-madd
19259 @itemx -mno-fused-madd
19260 @opindex mfused-madd
19261 @opindex mno-fused-madd
19262 Generate code that uses (does not use) the floating-point multiply and
19263 accumulate instructions. These instructions are generated by default
19264 if hardware floating point is used. The machine-dependent
19265 @option{-mfused-madd} option is now mapped to the machine-independent
19266 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19267 mapped to @option{-ffp-contract=off}.
19268
19269 @item -mfsca
19270 @itemx -mno-fsca
19271 @opindex mfsca
19272 @opindex mno-fsca
19273 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
19274 and cosine approximations. The option @code{-mfsca} must be used in
19275 combination with @code{-funsafe-math-optimizations}. It is enabled by default
19276 when generating code for SH4A. Using @code{-mno-fsca} disables sine and cosine
19277 approximations even if @code{-funsafe-math-optimizations} is in effect.
19278
19279 @item -mfsrra
19280 @itemx -mno-fsrra
19281 @opindex mfsrra
19282 @opindex mno-fsrra
19283 Allow or disallow the compiler to emit the @code{fsrra} instruction for
19284 reciprocal square root approximations. The option @code{-mfsrra} must be used
19285 in combination with @code{-funsafe-math-optimizations} and
19286 @code{-ffinite-math-only}. It is enabled by default when generating code for
19287 SH4A. Using @code{-mno-fsrra} disables reciprocal square root approximations
19288 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
19289 in effect.
19290
19291 @item -mpretend-cmove
19292 @opindex mpretend-cmove
19293 Prefer zero-displacement conditional branches for conditional move instruction
19294 patterns. This can result in faster code on the SH4 processor.
19295
19296 @end table
19297
19298 @node Solaris 2 Options
19299 @subsection Solaris 2 Options
19300 @cindex Solaris 2 options
19301
19302 These @samp{-m} options are supported on Solaris 2:
19303
19304 @table @gcctabopt
19305 @item -mimpure-text
19306 @opindex mimpure-text
19307 @option{-mimpure-text}, used in addition to @option{-shared}, tells
19308 the compiler to not pass @option{-z text} to the linker when linking a
19309 shared object. Using this option, you can link position-dependent
19310 code into a shared object.
19311
19312 @option{-mimpure-text} suppresses the ``relocations remain against
19313 allocatable but non-writable sections'' linker error message.
19314 However, the necessary relocations trigger copy-on-write, and the
19315 shared object is not actually shared across processes. Instead of
19316 using @option{-mimpure-text}, you should compile all source code with
19317 @option{-fpic} or @option{-fPIC}.
19318
19319 @end table
19320
19321 These switches are supported in addition to the above on Solaris 2:
19322
19323 @table @gcctabopt
19324 @item -pthreads
19325 @opindex pthreads
19326 Add support for multithreading using the POSIX threads library. This
19327 option sets flags for both the preprocessor and linker. This option does
19328 not affect the thread safety of object code produced by the compiler or
19329 that of libraries supplied with it.
19330
19331 @item -pthread
19332 @opindex pthread
19333 This is a synonym for @option{-pthreads}.
19334 @end table
19335
19336 @node SPARC Options
19337 @subsection SPARC Options
19338 @cindex SPARC options
19339
19340 These @samp{-m} options are supported on the SPARC:
19341
19342 @table @gcctabopt
19343 @item -mno-app-regs
19344 @itemx -mapp-regs
19345 @opindex mno-app-regs
19346 @opindex mapp-regs
19347 Specify @option{-mapp-regs} to generate output using the global registers
19348 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
19349 is the default.
19350
19351 To be fully SVR4 ABI-compliant at the cost of some performance loss,
19352 specify @option{-mno-app-regs}. You should compile libraries and system
19353 software with this option.
19354
19355 @item -mflat
19356 @itemx -mno-flat
19357 @opindex mflat
19358 @opindex mno-flat
19359 With @option{-mflat}, the compiler does not generate save/restore instructions
19360 and uses a ``flat'' or single register window model. This model is compatible
19361 with the regular register window model. The local registers and the input
19362 registers (0--5) are still treated as ``call-saved'' registers and are
19363 saved on the stack as needed.
19364
19365 With @option{-mno-flat} (the default), the compiler generates save/restore
19366 instructions (except for leaf functions). This is the normal operating mode.
19367
19368 @item -mfpu
19369 @itemx -mhard-float
19370 @opindex mfpu
19371 @opindex mhard-float
19372 Generate output containing floating-point instructions. This is the
19373 default.
19374
19375 @item -mno-fpu
19376 @itemx -msoft-float
19377 @opindex mno-fpu
19378 @opindex msoft-float
19379 Generate output containing library calls for floating point.
19380 @strong{Warning:} the requisite libraries are not available for all SPARC
19381 targets. Normally the facilities of the machine's usual C compiler are
19382 used, but this cannot be done directly in cross-compilation. You must make
19383 your own arrangements to provide suitable library functions for
19384 cross-compilation. The embedded targets @samp{sparc-*-aout} and
19385 @samp{sparclite-*-*} do provide software floating-point support.
19386
19387 @option{-msoft-float} changes the calling convention in the output file;
19388 therefore, it is only useful if you compile @emph{all} of a program with
19389 this option. In particular, you need to compile @file{libgcc.a}, the
19390 library that comes with GCC, with @option{-msoft-float} in order for
19391 this to work.
19392
19393 @item -mhard-quad-float
19394 @opindex mhard-quad-float
19395 Generate output containing quad-word (long double) floating-point
19396 instructions.
19397
19398 @item -msoft-quad-float
19399 @opindex msoft-quad-float
19400 Generate output containing library calls for quad-word (long double)
19401 floating-point instructions. The functions called are those specified
19402 in the SPARC ABI@. This is the default.
19403
19404 As of this writing, there are no SPARC implementations that have hardware
19405 support for the quad-word floating-point instructions. They all invoke
19406 a trap handler for one of these instructions, and then the trap handler
19407 emulates the effect of the instruction. Because of the trap handler overhead,
19408 this is much slower than calling the ABI library routines. Thus the
19409 @option{-msoft-quad-float} option is the default.
19410
19411 @item -mno-unaligned-doubles
19412 @itemx -munaligned-doubles
19413 @opindex mno-unaligned-doubles
19414 @opindex munaligned-doubles
19415 Assume that doubles have 8-byte alignment. This is the default.
19416
19417 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
19418 alignment only if they are contained in another type, or if they have an
19419 absolute address. Otherwise, it assumes they have 4-byte alignment.
19420 Specifying this option avoids some rare compatibility problems with code
19421 generated by other compilers. It is not the default because it results
19422 in a performance loss, especially for floating-point code.
19423
19424 @item -mno-faster-structs
19425 @itemx -mfaster-structs
19426 @opindex mno-faster-structs
19427 @opindex mfaster-structs
19428 With @option{-mfaster-structs}, the compiler assumes that structures
19429 should have 8-byte alignment. This enables the use of pairs of
19430 @code{ldd} and @code{std} instructions for copies in structure
19431 assignment, in place of twice as many @code{ld} and @code{st} pairs.
19432 However, the use of this changed alignment directly violates the SPARC
19433 ABI@. Thus, it's intended only for use on targets where the developer
19434 acknowledges that their resulting code is not directly in line with
19435 the rules of the ABI@.
19436
19437 @item -mcpu=@var{cpu_type}
19438 @opindex mcpu
19439 Set the instruction set, register set, and instruction scheduling parameters
19440 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
19441 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
19442 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
19443 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
19444 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
19445 @samp{niagara3} and @samp{niagara4}.
19446
19447 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
19448 which selects the best architecture option for the host processor.
19449 @option{-mcpu=native} has no effect if GCC does not recognize
19450 the processor.
19451
19452 Default instruction scheduling parameters are used for values that select
19453 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
19454 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
19455
19456 Here is a list of each supported architecture and their supported
19457 implementations.
19458
19459 @table @asis
19460 @item v7
19461 cypress
19462
19463 @item v8
19464 supersparc, hypersparc, leon, leon3
19465
19466 @item sparclite
19467 f930, f934, sparclite86x
19468
19469 @item sparclet
19470 tsc701
19471
19472 @item v9
19473 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
19474 @end table
19475
19476 By default (unless configured otherwise), GCC generates code for the V7
19477 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
19478 additionally optimizes it for the Cypress CY7C602 chip, as used in the
19479 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
19480 SPARCStation 1, 2, IPX etc.
19481
19482 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
19483 architecture. The only difference from V7 code is that the compiler emits
19484 the integer multiply and integer divide instructions which exist in SPARC-V8
19485 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
19486 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
19487 2000 series.
19488
19489 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
19490 the SPARC architecture. This adds the integer multiply, integer divide step
19491 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
19492 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
19493 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
19494 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
19495 MB86934 chip, which is the more recent SPARClite with FPU@.
19496
19497 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
19498 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
19499 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
19500 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
19501 optimizes it for the TEMIC SPARClet chip.
19502
19503 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
19504 architecture. This adds 64-bit integer and floating-point move instructions,
19505 3 additional floating-point condition code registers and conditional move
19506 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
19507 optimizes it for the Sun UltraSPARC I/II/IIi chips. With
19508 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
19509 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With
19510 @option{-mcpu=niagara}, the compiler additionally optimizes it for
19511 Sun UltraSPARC T1 chips. With @option{-mcpu=niagara2}, the compiler
19512 additionally optimizes it for Sun UltraSPARC T2 chips. With
19513 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
19514 UltraSPARC T3 chips. With @option{-mcpu=niagara4}, the compiler
19515 additionally optimizes it for Sun UltraSPARC T4 chips.
19516
19517 @item -mtune=@var{cpu_type}
19518 @opindex mtune
19519 Set the instruction scheduling parameters for machine type
19520 @var{cpu_type}, but do not set the instruction set or register set that the
19521 option @option{-mcpu=@var{cpu_type}} does.
19522
19523 The same values for @option{-mcpu=@var{cpu_type}} can be used for
19524 @option{-mtune=@var{cpu_type}}, but the only useful values are those
19525 that select a particular CPU implementation. Those are @samp{cypress},
19526 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
19527 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
19528 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
19529 @samp{niagara4}. With native Solaris and GNU/Linux toolchains, @samp{native}
19530 can also be used.
19531
19532 @item -mv8plus
19533 @itemx -mno-v8plus
19534 @opindex mv8plus
19535 @opindex mno-v8plus
19536 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
19537 difference from the V8 ABI is that the global and out registers are
19538 considered 64 bits wide. This is enabled by default on Solaris in 32-bit
19539 mode for all SPARC-V9 processors.
19540
19541 @item -mvis
19542 @itemx -mno-vis
19543 @opindex mvis
19544 @opindex mno-vis
19545 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
19546 Visual Instruction Set extensions. The default is @option{-mno-vis}.
19547
19548 @item -mvis2
19549 @itemx -mno-vis2
19550 @opindex mvis2
19551 @opindex mno-vis2
19552 With @option{-mvis2}, GCC generates code that takes advantage of
19553 version 2.0 of the UltraSPARC Visual Instruction Set extensions. The
19554 default is @option{-mvis2} when targeting a cpu that supports such
19555 instructions, such as UltraSPARC-III and later. Setting @option{-mvis2}
19556 also sets @option{-mvis}.
19557
19558 @item -mvis3
19559 @itemx -mno-vis3
19560 @opindex mvis3
19561 @opindex mno-vis3
19562 With @option{-mvis3}, GCC generates code that takes advantage of
19563 version 3.0 of the UltraSPARC Visual Instruction Set extensions. The
19564 default is @option{-mvis3} when targeting a cpu that supports such
19565 instructions, such as niagara-3 and later. Setting @option{-mvis3}
19566 also sets @option{-mvis2} and @option{-mvis}.
19567
19568 @item -mcbcond
19569 @itemx -mno-cbcond
19570 @opindex mcbcond
19571 @opindex mno-cbcond
19572 With @option{-mcbcond}, GCC generates code that takes advantage of
19573 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
19574 The default is @option{-mcbcond} when targeting a cpu that supports such
19575 instructions, such as niagara-4 and later.
19576
19577 @item -mpopc
19578 @itemx -mno-popc
19579 @opindex mpopc
19580 @opindex mno-popc
19581 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
19582 population count instruction. The default is @option{-mpopc}
19583 when targeting a cpu that supports such instructions, such as Niagara-2 and
19584 later.
19585
19586 @item -mfmaf
19587 @itemx -mno-fmaf
19588 @opindex mfmaf
19589 @opindex mno-fmaf
19590 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
19591 Fused Multiply-Add Floating-point extensions. The default is @option{-mfmaf}
19592 when targeting a cpu that supports such instructions, such as Niagara-3 and
19593 later.
19594
19595 @item -mfix-at697f
19596 @opindex mfix-at697f
19597 Enable the documented workaround for the single erratum of the Atmel AT697F
19598 processor (which corresponds to erratum #13 of the AT697E processor).
19599
19600 @item -mfix-ut699
19601 @opindex mfix-ut699
19602 Enable the documented workarounds for the floating-point errata and the data
19603 cache nullify errata of the UT699 processor.
19604 @end table
19605
19606 These @samp{-m} options are supported in addition to the above
19607 on SPARC-V9 processors in 64-bit environments:
19608
19609 @table @gcctabopt
19610 @item -m32
19611 @itemx -m64
19612 @opindex m32
19613 @opindex m64
19614 Generate code for a 32-bit or 64-bit environment.
19615 The 32-bit environment sets int, long and pointer to 32 bits.
19616 The 64-bit environment sets int to 32 bits and long and pointer
19617 to 64 bits.
19618
19619 @item -mcmodel=@var{which}
19620 @opindex mcmodel
19621 Set the code model to one of
19622
19623 @table @samp
19624 @item medlow
19625 The Medium/Low code model: 64-bit addresses, programs
19626 must be linked in the low 32 bits of memory. Programs can be statically
19627 or dynamically linked.
19628
19629 @item medmid
19630 The Medium/Middle code model: 64-bit addresses, programs
19631 must be linked in the low 44 bits of memory, the text and data segments must
19632 be less than 2GB in size and the data segment must be located within 2GB of
19633 the text segment.
19634
19635 @item medany
19636 The Medium/Anywhere code model: 64-bit addresses, programs
19637 may be linked anywhere in memory, the text and data segments must be less
19638 than 2GB in size and the data segment must be located within 2GB of the
19639 text segment.
19640
19641 @item embmedany
19642 The Medium/Anywhere code model for embedded systems:
19643 64-bit addresses, the text and data segments must be less than 2GB in
19644 size, both starting anywhere in memory (determined at link time). The
19645 global register %g4 points to the base of the data segment. Programs
19646 are statically linked and PIC is not supported.
19647 @end table
19648
19649 @item -mmemory-model=@var{mem-model}
19650 @opindex mmemory-model
19651 Set the memory model in force on the processor to one of
19652
19653 @table @samp
19654 @item default
19655 The default memory model for the processor and operating system.
19656
19657 @item rmo
19658 Relaxed Memory Order
19659
19660 @item pso
19661 Partial Store Order
19662
19663 @item tso
19664 Total Store Order
19665
19666 @item sc
19667 Sequential Consistency
19668 @end table
19669
19670 These memory models are formally defined in Appendix D of the Sparc V9
19671 architecture manual, as set in the processor's @code{PSTATE.MM} field.
19672
19673 @item -mstack-bias
19674 @itemx -mno-stack-bias
19675 @opindex mstack-bias
19676 @opindex mno-stack-bias
19677 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
19678 frame pointer if present, are offset by @minus{}2047 which must be added back
19679 when making stack frame references. This is the default in 64-bit mode.
19680 Otherwise, assume no such offset is present.
19681 @end table
19682
19683 @node SPU Options
19684 @subsection SPU Options
19685 @cindex SPU options
19686
19687 These @samp{-m} options are supported on the SPU:
19688
19689 @table @gcctabopt
19690 @item -mwarn-reloc
19691 @itemx -merror-reloc
19692 @opindex mwarn-reloc
19693 @opindex merror-reloc
19694
19695 The loader for SPU does not handle dynamic relocations. By default, GCC
19696 gives an error when it generates code that requires a dynamic
19697 relocation. @option{-mno-error-reloc} disables the error,
19698 @option{-mwarn-reloc} generates a warning instead.
19699
19700 @item -msafe-dma
19701 @itemx -munsafe-dma
19702 @opindex msafe-dma
19703 @opindex munsafe-dma
19704
19705 Instructions that initiate or test completion of DMA must not be
19706 reordered with respect to loads and stores of the memory that is being
19707 accessed.
19708 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
19709 memory accesses, but that can lead to inefficient code in places where the
19710 memory is known to not change. Rather than mark the memory as volatile,
19711 you can use @option{-msafe-dma} to tell the compiler to treat
19712 the DMA instructions as potentially affecting all memory.
19713
19714 @item -mbranch-hints
19715 @opindex mbranch-hints
19716
19717 By default, GCC generates a branch hint instruction to avoid
19718 pipeline stalls for always-taken or probably-taken branches. A hint
19719 is not generated closer than 8 instructions away from its branch.
19720 There is little reason to disable them, except for debugging purposes,
19721 or to make an object a little bit smaller.
19722
19723 @item -msmall-mem
19724 @itemx -mlarge-mem
19725 @opindex msmall-mem
19726 @opindex mlarge-mem
19727
19728 By default, GCC generates code assuming that addresses are never larger
19729 than 18 bits. With @option{-mlarge-mem} code is generated that assumes
19730 a full 32-bit address.
19731
19732 @item -mstdmain
19733 @opindex mstdmain
19734
19735 By default, GCC links against startup code that assumes the SPU-style
19736 main function interface (which has an unconventional parameter list).
19737 With @option{-mstdmain}, GCC links your program against startup
19738 code that assumes a C99-style interface to @code{main}, including a
19739 local copy of @code{argv} strings.
19740
19741 @item -mfixed-range=@var{register-range}
19742 @opindex mfixed-range
19743 Generate code treating the given register range as fixed registers.
19744 A fixed register is one that the register allocator cannot use. This is
19745 useful when compiling kernel code. A register range is specified as
19746 two registers separated by a dash. Multiple register ranges can be
19747 specified separated by a comma.
19748
19749 @item -mea32
19750 @itemx -mea64
19751 @opindex mea32
19752 @opindex mea64
19753 Compile code assuming that pointers to the PPU address space accessed
19754 via the @code{__ea} named address space qualifier are either 32 or 64
19755 bits wide. The default is 32 bits. As this is an ABI-changing option,
19756 all object code in an executable must be compiled with the same setting.
19757
19758 @item -maddress-space-conversion
19759 @itemx -mno-address-space-conversion
19760 @opindex maddress-space-conversion
19761 @opindex mno-address-space-conversion
19762 Allow/disallow treating the @code{__ea} address space as superset
19763 of the generic address space. This enables explicit type casts
19764 between @code{__ea} and generic pointer as well as implicit
19765 conversions of generic pointers to @code{__ea} pointers. The
19766 default is to allow address space pointer conversions.
19767
19768 @item -mcache-size=@var{cache-size}
19769 @opindex mcache-size
19770 This option controls the version of libgcc that the compiler links to an
19771 executable and selects a software-managed cache for accessing variables
19772 in the @code{__ea} address space with a particular cache size. Possible
19773 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
19774 and @samp{128}. The default cache size is 64KB.
19775
19776 @item -matomic-updates
19777 @itemx -mno-atomic-updates
19778 @opindex matomic-updates
19779 @opindex mno-atomic-updates
19780 This option controls the version of libgcc that the compiler links to an
19781 executable and selects whether atomic updates to the software-managed
19782 cache of PPU-side variables are used. If you use atomic updates, changes
19783 to a PPU variable from SPU code using the @code{__ea} named address space
19784 qualifier do not interfere with changes to other PPU variables residing
19785 in the same cache line from PPU code. If you do not use atomic updates,
19786 such interference may occur; however, writing back cache lines is
19787 more efficient. The default behavior is to use atomic updates.
19788
19789 @item -mdual-nops
19790 @itemx -mdual-nops=@var{n}
19791 @opindex mdual-nops
19792 By default, GCC inserts nops to increase dual issue when it expects
19793 it to increase performance. @var{n} can be a value from 0 to 10. A
19794 smaller @var{n} inserts fewer nops. 10 is the default, 0 is the
19795 same as @option{-mno-dual-nops}. Disabled with @option{-Os}.
19796
19797 @item -mhint-max-nops=@var{n}
19798 @opindex mhint-max-nops
19799 Maximum number of nops to insert for a branch hint. A branch hint must
19800 be at least 8 instructions away from the branch it is affecting. GCC
19801 inserts up to @var{n} nops to enforce this, otherwise it does not
19802 generate the branch hint.
19803
19804 @item -mhint-max-distance=@var{n}
19805 @opindex mhint-max-distance
19806 The encoding of the branch hint instruction limits the hint to be within
19807 256 instructions of the branch it is affecting. By default, GCC makes
19808 sure it is within 125.
19809
19810 @item -msafe-hints
19811 @opindex msafe-hints
19812 Work around a hardware bug that causes the SPU to stall indefinitely.
19813 By default, GCC inserts the @code{hbrp} instruction to make sure
19814 this stall won't happen.
19815
19816 @end table
19817
19818 @node System V Options
19819 @subsection Options for System V
19820
19821 These additional options are available on System V Release 4 for
19822 compatibility with other compilers on those systems:
19823
19824 @table @gcctabopt
19825 @item -G
19826 @opindex G
19827 Create a shared object.
19828 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
19829
19830 @item -Qy
19831 @opindex Qy
19832 Identify the versions of each tool used by the compiler, in a
19833 @code{.ident} assembler directive in the output.
19834
19835 @item -Qn
19836 @opindex Qn
19837 Refrain from adding @code{.ident} directives to the output file (this is
19838 the default).
19839
19840 @item -YP,@var{dirs}
19841 @opindex YP
19842 Search the directories @var{dirs}, and no others, for libraries
19843 specified with @option{-l}.
19844
19845 @item -Ym,@var{dir}
19846 @opindex Ym
19847 Look in the directory @var{dir} to find the M4 preprocessor.
19848 The assembler uses this option.
19849 @c This is supposed to go with a -Yd for predefined M4 macro files, but
19850 @c the generic assembler that comes with Solaris takes just -Ym.
19851 @end table
19852
19853 @node TILE-Gx Options
19854 @subsection TILE-Gx Options
19855 @cindex TILE-Gx options
19856
19857 These @samp{-m} options are supported on the TILE-Gx:
19858
19859 @table @gcctabopt
19860 @item -mcmodel=small
19861 @opindex mcmodel=small
19862 Generate code for the small model. The distance for direct calls is
19863 limited to 500M in either direction. PC-relative addresses are 32
19864 bits. Absolute addresses support the full address range.
19865
19866 @item -mcmodel=large
19867 @opindex mcmodel=large
19868 Generate code for the large model. There is no limitation on call
19869 distance, pc-relative addresses, or absolute addresses.
19870
19871 @item -mcpu=@var{name}
19872 @opindex mcpu
19873 Selects the type of CPU to be targeted. Currently the only supported
19874 type is @samp{tilegx}.
19875
19876 @item -m32
19877 @itemx -m64
19878 @opindex m32
19879 @opindex m64
19880 Generate code for a 32-bit or 64-bit environment. The 32-bit
19881 environment sets int, long, and pointer to 32 bits. The 64-bit
19882 environment sets int to 32 bits and long and pointer to 64 bits.
19883 @end table
19884
19885 @node TILEPro Options
19886 @subsection TILEPro Options
19887 @cindex TILEPro options
19888
19889 These @samp{-m} options are supported on the TILEPro:
19890
19891 @table @gcctabopt
19892 @item -mcpu=@var{name}
19893 @opindex mcpu
19894 Selects the type of CPU to be targeted. Currently the only supported
19895 type is @samp{tilepro}.
19896
19897 @item -m32
19898 @opindex m32
19899 Generate code for a 32-bit environment, which sets int, long, and
19900 pointer to 32 bits. This is the only supported behavior so the flag
19901 is essentially ignored.
19902 @end table
19903
19904 @node V850 Options
19905 @subsection V850 Options
19906 @cindex V850 Options
19907
19908 These @samp{-m} options are defined for V850 implementations:
19909
19910 @table @gcctabopt
19911 @item -mlong-calls
19912 @itemx -mno-long-calls
19913 @opindex mlong-calls
19914 @opindex mno-long-calls
19915 Treat all calls as being far away (near). If calls are assumed to be
19916 far away, the compiler always loads the function's address into a
19917 register, and calls indirect through the pointer.
19918
19919 @item -mno-ep
19920 @itemx -mep
19921 @opindex mno-ep
19922 @opindex mep
19923 Do not optimize (do optimize) basic blocks that use the same index
19924 pointer 4 or more times to copy pointer into the @code{ep} register, and
19925 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
19926 option is on by default if you optimize.
19927
19928 @item -mno-prolog-function
19929 @itemx -mprolog-function
19930 @opindex mno-prolog-function
19931 @opindex mprolog-function
19932 Do not use (do use) external functions to save and restore registers
19933 at the prologue and epilogue of a function. The external functions
19934 are slower, but use less code space if more than one function saves
19935 the same number of registers. The @option{-mprolog-function} option
19936 is on by default if you optimize.
19937
19938 @item -mspace
19939 @opindex mspace
19940 Try to make the code as small as possible. At present, this just turns
19941 on the @option{-mep} and @option{-mprolog-function} options.
19942
19943 @item -mtda=@var{n}
19944 @opindex mtda
19945 Put static or global variables whose size is @var{n} bytes or less into
19946 the tiny data area that register @code{ep} points to. The tiny data
19947 area can hold up to 256 bytes in total (128 bytes for byte references).
19948
19949 @item -msda=@var{n}
19950 @opindex msda
19951 Put static or global variables whose size is @var{n} bytes or less into
19952 the small data area that register @code{gp} points to. The small data
19953 area can hold up to 64 kilobytes.
19954
19955 @item -mzda=@var{n}
19956 @opindex mzda
19957 Put static or global variables whose size is @var{n} bytes or less into
19958 the first 32 kilobytes of memory.
19959
19960 @item -mv850
19961 @opindex mv850
19962 Specify that the target processor is the V850.
19963
19964 @item -mv850e3v5
19965 @opindex mv850e3v5
19966 Specify that the target processor is the V850E3V5. The preprocessor
19967 constant @samp{__v850e3v5__} is defined if this option is used.
19968
19969 @item -mv850e2v4
19970 @opindex mv850e2v4
19971 Specify that the target processor is the V850E3V5. This is an alias for
19972 the @option{-mv850e3v5} option.
19973
19974 @item -mv850e2v3
19975 @opindex mv850e2v3
19976 Specify that the target processor is the V850E2V3. The preprocessor
19977 constant @samp{__v850e2v3__} is defined if this option is used.
19978
19979 @item -mv850e2
19980 @opindex mv850e2
19981 Specify that the target processor is the V850E2. The preprocessor
19982 constant @samp{__v850e2__} is defined if this option is used.
19983
19984 @item -mv850e1
19985 @opindex mv850e1
19986 Specify that the target processor is the V850E1. The preprocessor
19987 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19988 this option is used.
19989
19990 @item -mv850es
19991 @opindex mv850es
19992 Specify that the target processor is the V850ES. This is an alias for
19993 the @option{-mv850e1} option.
19994
19995 @item -mv850e
19996 @opindex mv850e
19997 Specify that the target processor is the V850E@. The preprocessor
19998 constant @samp{__v850e__} is defined if this option is used.
19999
20000 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
20001 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
20002 are defined then a default target processor is chosen and the
20003 relevant @samp{__v850*__} preprocessor constant is defined.
20004
20005 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
20006 defined, regardless of which processor variant is the target.
20007
20008 @item -mdisable-callt
20009 @itemx -mno-disable-callt
20010 @opindex mdisable-callt
20011 @opindex mno-disable-callt
20012 This option suppresses generation of the @code{CALLT} instruction for the
20013 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
20014 architecture.
20015
20016 This option is enabled by default when the RH850 ABI is
20017 in use (see @option{-mrh850-abi}), and disabled by default when the
20018 GCC ABI is in use. If @code{CALLT} instructions are being generated
20019 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
20020
20021 @item -mrelax
20022 @itemx -mno-relax
20023 @opindex mrelax
20024 @opindex mno-relax
20025 Pass on (or do not pass on) the @option{-mrelax} command line option
20026 to the assembler.
20027
20028 @item -mlong-jumps
20029 @itemx -mno-long-jumps
20030 @opindex mlong-jumps
20031 @opindex mno-long-jumps
20032 Disable (or re-enable) the generation of PC-relative jump instructions.
20033
20034 @item -msoft-float
20035 @itemx -mhard-float
20036 @opindex msoft-float
20037 @opindex mhard-float
20038 Disable (or re-enable) the generation of hardware floating point
20039 instructions. This option is only significant when the target
20040 architecture is @samp{V850E2V3} or higher. If hardware floating point
20041 instructions are being generated then the C preprocessor symbol
20042 @code{__FPU_OK__} will be defined, otherwise the symbol
20043 @code{__NO_FPU__} will be defined.
20044
20045 @item -mloop
20046 @opindex mloop
20047 Enables the use of the e3v5 LOOP instruction. The use of this
20048 instruction is not enabled by default when the e3v5 architecture is
20049 selected because its use is still experimental.
20050
20051 @item -mrh850-abi
20052 @itemx -mghs
20053 @opindex mrh850-abi
20054 @opindex mghs
20055 Enables support for the RH850 version of the V850 ABI. This is the
20056 default. With this version of the ABI the following rules apply:
20057
20058 @itemize
20059 @item
20060 Integer sized structures and unions are returned via a memory pointer
20061 rather than a register.
20062
20063 @item
20064 Large structures and unions (more than 8 bytes in size) are passed by
20065 value.
20066
20067 @item
20068 Functions are aligned to 16-bit boundaries.
20069
20070 @item
20071 The @option{-m8byte-align} command line option is supported.
20072
20073 @item
20074 The @option{-mdisable-callt} command line option is enabled by
20075 default. The @option{-mno-disable-callt} command line option is not
20076 supported.
20077 @end itemize
20078
20079 When this version of the ABI is enabled the C preprocessor symbol
20080 @code{__V850_RH850_ABI__} is defined.
20081
20082 @item -mgcc-abi
20083 @opindex mgcc-abi
20084 Enables support for the old GCC version of the V850 ABI. With this
20085 version of the ABI the following rules apply:
20086
20087 @itemize
20088 @item
20089 Integer sized structures and unions are returned in register @code{r10}.
20090
20091 @item
20092 Large structures and unions (more than 8 bytes in size) are passed by
20093 reference.
20094
20095 @item
20096 Functions are aligned to 32-bit boundaries, unless optimizing for
20097 size.
20098
20099 @item
20100 The @option{-m8byte-align} command line option is not supported.
20101
20102 @item
20103 The @option{-mdisable-callt} command line option is supported but not
20104 enabled by default.
20105 @end itemize
20106
20107 When this version of the ABI is enabled the C preprocessor symbol
20108 @code{__V850_GCC_ABI__} is defined.
20109
20110 @item -m8byte-align
20111 @itemx -mno-8byte-align
20112 @opindex m8byte-align
20113 @opindex mno-8byte-align
20114 Enables support for @code{doubles} and @code{long long} types to be
20115 aligned on 8-byte boundaries. The default is to restrict the
20116 alignment of all objects to at most 4-bytes. When
20117 @option{-m8byte-align} is in effect the C preprocessor symbol
20118 @code{__V850_8BYTE_ALIGN__} will be defined.
20119
20120 @item -mbig-switch
20121 @opindex mbig-switch
20122 Generate code suitable for big switch tables. Use this option only if
20123 the assembler/linker complain about out of range branches within a switch
20124 table.
20125
20126 @item -mapp-regs
20127 @opindex mapp-regs
20128 This option causes r2 and r5 to be used in the code generated by
20129 the compiler. This setting is the default.
20130
20131 @item -mno-app-regs
20132 @opindex mno-app-regs
20133 This option causes r2 and r5 to be treated as fixed registers.
20134
20135 @end table
20136
20137 @node VAX Options
20138 @subsection VAX Options
20139 @cindex VAX options
20140
20141 These @samp{-m} options are defined for the VAX:
20142
20143 @table @gcctabopt
20144 @item -munix
20145 @opindex munix
20146 Do not output certain jump instructions (@code{aobleq} and so on)
20147 that the Unix assembler for the VAX cannot handle across long
20148 ranges.
20149
20150 @item -mgnu
20151 @opindex mgnu
20152 Do output those jump instructions, on the assumption that the
20153 GNU assembler is being used.
20154
20155 @item -mg
20156 @opindex mg
20157 Output code for G-format floating-point numbers instead of D-format.
20158 @end table
20159
20160 @node VMS Options
20161 @subsection VMS Options
20162
20163 These @samp{-m} options are defined for the VMS implementations:
20164
20165 @table @gcctabopt
20166 @item -mvms-return-codes
20167 @opindex mvms-return-codes
20168 Return VMS condition codes from @code{main}. The default is to return POSIX-style
20169 condition (e.g.@ error) codes.
20170
20171 @item -mdebug-main=@var{prefix}
20172 @opindex mdebug-main=@var{prefix}
20173 Flag the first routine whose name starts with @var{prefix} as the main
20174 routine for the debugger.
20175
20176 @item -mmalloc64
20177 @opindex mmalloc64
20178 Default to 64-bit memory allocation routines.
20179
20180 @item -mpointer-size=@var{size}
20181 @opindex -mpointer-size=@var{size}
20182 Set the default size of pointers. Possible options for @var{size} are
20183 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
20184 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
20185 The later option disables @code{pragma pointer_size}.
20186 @end table
20187
20188 @node VxWorks Options
20189 @subsection VxWorks Options
20190 @cindex VxWorks Options
20191
20192 The options in this section are defined for all VxWorks targets.
20193 Options specific to the target hardware are listed with the other
20194 options for that target.
20195
20196 @table @gcctabopt
20197 @item -mrtp
20198 @opindex mrtp
20199 GCC can generate code for both VxWorks kernels and real time processes
20200 (RTPs). This option switches from the former to the latter. It also
20201 defines the preprocessor macro @code{__RTP__}.
20202
20203 @item -non-static
20204 @opindex non-static
20205 Link an RTP executable against shared libraries rather than static
20206 libraries. The options @option{-static} and @option{-shared} can
20207 also be used for RTPs (@pxref{Link Options}); @option{-static}
20208 is the default.
20209
20210 @item -Bstatic
20211 @itemx -Bdynamic
20212 @opindex Bstatic
20213 @opindex Bdynamic
20214 These options are passed down to the linker. They are defined for
20215 compatibility with Diab.
20216
20217 @item -Xbind-lazy
20218 @opindex Xbind-lazy
20219 Enable lazy binding of function calls. This option is equivalent to
20220 @option{-Wl,-z,now} and is defined for compatibility with Diab.
20221
20222 @item -Xbind-now
20223 @opindex Xbind-now
20224 Disable lazy binding of function calls. This option is the default and
20225 is defined for compatibility with Diab.
20226 @end table
20227
20228 @node x86-64 Options
20229 @subsection x86-64 Options
20230 @cindex x86-64 options
20231
20232 These are listed under @xref{i386 and x86-64 Options}.
20233
20234 @node Xstormy16 Options
20235 @subsection Xstormy16 Options
20236 @cindex Xstormy16 Options
20237
20238 These options are defined for Xstormy16:
20239
20240 @table @gcctabopt
20241 @item -msim
20242 @opindex msim
20243 Choose startup files and linker script suitable for the simulator.
20244 @end table
20245
20246 @node Xtensa Options
20247 @subsection Xtensa Options
20248 @cindex Xtensa Options
20249
20250 These options are supported for Xtensa targets:
20251
20252 @table @gcctabopt
20253 @item -mconst16
20254 @itemx -mno-const16
20255 @opindex mconst16
20256 @opindex mno-const16
20257 Enable or disable use of @code{CONST16} instructions for loading
20258 constant values. The @code{CONST16} instruction is currently not a
20259 standard option from Tensilica. When enabled, @code{CONST16}
20260 instructions are always used in place of the standard @code{L32R}
20261 instructions. The use of @code{CONST16} is enabled by default only if
20262 the @code{L32R} instruction is not available.
20263
20264 @item -mfused-madd
20265 @itemx -mno-fused-madd
20266 @opindex mfused-madd
20267 @opindex mno-fused-madd
20268 Enable or disable use of fused multiply/add and multiply/subtract
20269 instructions in the floating-point option. This has no effect if the
20270 floating-point option is not also enabled. Disabling fused multiply/add
20271 and multiply/subtract instructions forces the compiler to use separate
20272 instructions for the multiply and add/subtract operations. This may be
20273 desirable in some cases where strict IEEE 754-compliant results are
20274 required: the fused multiply add/subtract instructions do not round the
20275 intermediate result, thereby producing results with @emph{more} bits of
20276 precision than specified by the IEEE standard. Disabling fused multiply
20277 add/subtract instructions also ensures that the program output is not
20278 sensitive to the compiler's ability to combine multiply and add/subtract
20279 operations.
20280
20281 @item -mserialize-volatile
20282 @itemx -mno-serialize-volatile
20283 @opindex mserialize-volatile
20284 @opindex mno-serialize-volatile
20285 When this option is enabled, GCC inserts @code{MEMW} instructions before
20286 @code{volatile} memory references to guarantee sequential consistency.
20287 The default is @option{-mserialize-volatile}. Use
20288 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
20289
20290 @item -mforce-no-pic
20291 @opindex mforce-no-pic
20292 For targets, like GNU/Linux, where all user-mode Xtensa code must be
20293 position-independent code (PIC), this option disables PIC for compiling
20294 kernel code.
20295
20296 @item -mtext-section-literals
20297 @itemx -mno-text-section-literals
20298 @opindex mtext-section-literals
20299 @opindex mno-text-section-literals
20300 Control the treatment of literal pools. The default is
20301 @option{-mno-text-section-literals}, which places literals in a separate
20302 section in the output file. This allows the literal pool to be placed
20303 in a data RAM/ROM, and it also allows the linker to combine literal
20304 pools from separate object files to remove redundant literals and
20305 improve code size. With @option{-mtext-section-literals}, the literals
20306 are interspersed in the text section in order to keep them as close as
20307 possible to their references. This may be necessary for large assembly
20308 files.
20309
20310 @item -mtarget-align
20311 @itemx -mno-target-align
20312 @opindex mtarget-align
20313 @opindex mno-target-align
20314 When this option is enabled, GCC instructs the assembler to
20315 automatically align instructions to reduce branch penalties at the
20316 expense of some code density. The assembler attempts to widen density
20317 instructions to align branch targets and the instructions following call
20318 instructions. If there are not enough preceding safe density
20319 instructions to align a target, no widening is performed. The
20320 default is @option{-mtarget-align}. These options do not affect the
20321 treatment of auto-aligned instructions like @code{LOOP}, which the
20322 assembler always aligns, either by widening density instructions or
20323 by inserting NOP instructions.
20324
20325 @item -mlongcalls
20326 @itemx -mno-longcalls
20327 @opindex mlongcalls
20328 @opindex mno-longcalls
20329 When this option is enabled, GCC instructs the assembler to translate
20330 direct calls to indirect calls unless it can determine that the target
20331 of a direct call is in the range allowed by the call instruction. This
20332 translation typically occurs for calls to functions in other source
20333 files. Specifically, the assembler translates a direct @code{CALL}
20334 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
20335 The default is @option{-mno-longcalls}. This option should be used in
20336 programs where the call target can potentially be out of range. This
20337 option is implemented in the assembler, not the compiler, so the
20338 assembly code generated by GCC still shows direct call
20339 instructions---look at the disassembled object code to see the actual
20340 instructions. Note that the assembler uses an indirect call for
20341 every cross-file call, not just those that really are out of range.
20342 @end table
20343
20344 @node zSeries Options
20345 @subsection zSeries Options
20346 @cindex zSeries options
20347
20348 These are listed under @xref{S/390 and zSeries Options}.
20349
20350 @node Code Gen Options
20351 @section Options for Code Generation Conventions
20352 @cindex code generation conventions
20353 @cindex options, code generation
20354 @cindex run-time options
20355
20356 These machine-independent options control the interface conventions
20357 used in code generation.
20358
20359 Most of them have both positive and negative forms; the negative form
20360 of @option{-ffoo} is @option{-fno-foo}. In the table below, only
20361 one of the forms is listed---the one that is not the default. You
20362 can figure out the other form by either removing @samp{no-} or adding
20363 it.
20364
20365 @table @gcctabopt
20366 @item -fbounds-check
20367 @opindex fbounds-check
20368 For front ends that support it, generate additional code to check that
20369 indices used to access arrays are within the declared range. This is
20370 currently only supported by the Java and Fortran front ends, where
20371 this option defaults to true and false respectively.
20372
20373 @item -fstack-reuse=@var{reuse-level}
20374 @opindex fstack_reuse
20375 This option controls stack space reuse for user declared local/auto variables
20376 and compiler generated temporaries. @var{reuse_level} can be @samp{all},
20377 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
20378 local variables and temporaries, @samp{named_vars} enables the reuse only for
20379 user defined local variables with names, and @samp{none} disables stack reuse
20380 completely. The default value is @samp{all}. The option is needed when the
20381 program extends the lifetime of a scoped local variable or a compiler generated
20382 temporary beyond the end point defined by the language. When a lifetime of
20383 a variable ends, and if the variable lives in memory, the optimizing compiler
20384 has the freedom to reuse its stack space with other temporaries or scoped
20385 local variables whose live range does not overlap with it. Legacy code extending
20386 local lifetime will likely to break with the stack reuse optimization.
20387
20388 For example,
20389
20390 @smallexample
20391 int *p;
20392 @{
20393 int local1;
20394
20395 p = &local1;
20396 local1 = 10;
20397 ....
20398 @}
20399 @{
20400 int local2;
20401 local2 = 20;
20402 ...
20403 @}
20404
20405 if (*p == 10) // out of scope use of local1
20406 @{
20407
20408 @}
20409 @end smallexample
20410
20411 Another example:
20412 @smallexample
20413
20414 struct A
20415 @{
20416 A(int k) : i(k), j(k) @{ @}
20417 int i;
20418 int j;
20419 @};
20420
20421 A *ap;
20422
20423 void foo(const A& ar)
20424 @{
20425 ap = &ar;
20426 @}
20427
20428 void bar()
20429 @{
20430 foo(A(10)); // temp object's lifetime ends when foo returns
20431
20432 @{
20433 A a(20);
20434 ....
20435 @}
20436 ap->i+= 10; // ap references out of scope temp whose space
20437 // is reused with a. What is the value of ap->i?
20438 @}
20439
20440 @end smallexample
20441
20442 The lifetime of a compiler generated temporary is well defined by the C++
20443 standard. When a lifetime of a temporary ends, and if the temporary lives
20444 in memory, the optimizing compiler has the freedom to reuse its stack
20445 space with other temporaries or scoped local variables whose live range
20446 does not overlap with it. However some of the legacy code relies on
20447 the behavior of older compilers in which temporaries' stack space is
20448 not reused, the aggressive stack reuse can lead to runtime errors. This
20449 option is used to control the temporary stack reuse optimization.
20450
20451 @item -ftrapv
20452 @opindex ftrapv
20453 This option generates traps for signed overflow on addition, subtraction,
20454 multiplication operations.
20455
20456 @item -fwrapv
20457 @opindex fwrapv
20458 This option instructs the compiler to assume that signed arithmetic
20459 overflow of addition, subtraction and multiplication wraps around
20460 using twos-complement representation. This flag enables some optimizations
20461 and disables others. This option is enabled by default for the Java
20462 front end, as required by the Java language specification.
20463
20464 @item -fexceptions
20465 @opindex fexceptions
20466 Enable exception handling. Generates extra code needed to propagate
20467 exceptions. For some targets, this implies GCC generates frame
20468 unwind information for all functions, which can produce significant data
20469 size overhead, although it does not affect execution. If you do not
20470 specify this option, GCC enables it by default for languages like
20471 C++ that normally require exception handling, and disables it for
20472 languages like C that do not normally require it. However, you may need
20473 to enable this option when compiling C code that needs to interoperate
20474 properly with exception handlers written in C++. You may also wish to
20475 disable this option if you are compiling older C++ programs that don't
20476 use exception handling.
20477
20478 @item -fnon-call-exceptions
20479 @opindex fnon-call-exceptions
20480 Generate code that allows trapping instructions to throw exceptions.
20481 Note that this requires platform-specific runtime support that does
20482 not exist everywhere. Moreover, it only allows @emph{trapping}
20483 instructions to throw exceptions, i.e.@: memory references or floating-point
20484 instructions. It does not allow exceptions to be thrown from
20485 arbitrary signal handlers such as @code{SIGALRM}.
20486
20487 @item -fdelete-dead-exceptions
20488 @opindex fdelete-dead-exceptions
20489 Consider that instructions that may throw exceptions but don't otherwise
20490 contribute to the execution of the program can be optimized away.
20491 This option is enabled by default for the Ada front end, as permitted by
20492 the Ada language specification.
20493 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
20494
20495 @item -funwind-tables
20496 @opindex funwind-tables
20497 Similar to @option{-fexceptions}, except that it just generates any needed
20498 static data, but does not affect the generated code in any other way.
20499 You normally do not need to enable this option; instead, a language processor
20500 that needs this handling enables it on your behalf.
20501
20502 @item -fasynchronous-unwind-tables
20503 @opindex fasynchronous-unwind-tables
20504 Generate unwind table in DWARF 2 format, if supported by target machine. The
20505 table is exact at each instruction boundary, so it can be used for stack
20506 unwinding from asynchronous events (such as debugger or garbage collector).
20507
20508 @item -fpcc-struct-return
20509 @opindex fpcc-struct-return
20510 Return ``short'' @code{struct} and @code{union} values in memory like
20511 longer ones, rather than in registers. This convention is less
20512 efficient, but it has the advantage of allowing intercallability between
20513 GCC-compiled files and files compiled with other compilers, particularly
20514 the Portable C Compiler (pcc).
20515
20516 The precise convention for returning structures in memory depends
20517 on the target configuration macros.
20518
20519 Short structures and unions are those whose size and alignment match
20520 that of some integer type.
20521
20522 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
20523 switch is not binary compatible with code compiled with the
20524 @option{-freg-struct-return} switch.
20525 Use it to conform to a non-default application binary interface.
20526
20527 @item -freg-struct-return
20528 @opindex freg-struct-return
20529 Return @code{struct} and @code{union} values in registers when possible.
20530 This is more efficient for small structures than
20531 @option{-fpcc-struct-return}.
20532
20533 If you specify neither @option{-fpcc-struct-return} nor
20534 @option{-freg-struct-return}, GCC defaults to whichever convention is
20535 standard for the target. If there is no standard convention, GCC
20536 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
20537 the principal compiler. In those cases, we can choose the standard, and
20538 we chose the more efficient register return alternative.
20539
20540 @strong{Warning:} code compiled with the @option{-freg-struct-return}
20541 switch is not binary compatible with code compiled with the
20542 @option{-fpcc-struct-return} switch.
20543 Use it to conform to a non-default application binary interface.
20544
20545 @item -fshort-enums
20546 @opindex fshort-enums
20547 Allocate to an @code{enum} type only as many bytes as it needs for the
20548 declared range of possible values. Specifically, the @code{enum} type
20549 is equivalent to the smallest integer type that has enough room.
20550
20551 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
20552 code that is not binary compatible with code generated without that switch.
20553 Use it to conform to a non-default application binary interface.
20554
20555 @item -fshort-double
20556 @opindex fshort-double
20557 Use the same size for @code{double} as for @code{float}.
20558
20559 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
20560 code that is not binary compatible with code generated without that switch.
20561 Use it to conform to a non-default application binary interface.
20562
20563 @item -fshort-wchar
20564 @opindex fshort-wchar
20565 Override the underlying type for @samp{wchar_t} to be @samp{short
20566 unsigned int} instead of the default for the target. This option is
20567 useful for building programs to run under WINE@.
20568
20569 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
20570 code that is not binary compatible with code generated without that switch.
20571 Use it to conform to a non-default application binary interface.
20572
20573 @item -fno-common
20574 @opindex fno-common
20575 In C code, controls the placement of uninitialized global variables.
20576 Unix C compilers have traditionally permitted multiple definitions of
20577 such variables in different compilation units by placing the variables
20578 in a common block.
20579 This is the behavior specified by @option{-fcommon}, and is the default
20580 for GCC on most targets.
20581 On the other hand, this behavior is not required by ISO C, and on some
20582 targets may carry a speed or code size penalty on variable references.
20583 The @option{-fno-common} option specifies that the compiler should place
20584 uninitialized global variables in the data section of the object file,
20585 rather than generating them as common blocks.
20586 This has the effect that if the same variable is declared
20587 (without @code{extern}) in two different compilations,
20588 you get a multiple-definition error when you link them.
20589 In this case, you must compile with @option{-fcommon} instead.
20590 Compiling with @option{-fno-common} is useful on targets for which
20591 it provides better performance, or if you wish to verify that the
20592 program will work on other systems that always treat uninitialized
20593 variable declarations this way.
20594
20595 @item -fno-ident
20596 @opindex fno-ident
20597 Ignore the @samp{#ident} directive.
20598
20599 @item -finhibit-size-directive
20600 @opindex finhibit-size-directive
20601 Don't output a @code{.size} assembler directive, or anything else that
20602 would cause trouble if the function is split in the middle, and the
20603 two halves are placed at locations far apart in memory. This option is
20604 used when compiling @file{crtstuff.c}; you should not need to use it
20605 for anything else.
20606
20607 @item -fverbose-asm
20608 @opindex fverbose-asm
20609 Put extra commentary information in the generated assembly code to
20610 make it more readable. This option is generally only of use to those
20611 who actually need to read the generated assembly code (perhaps while
20612 debugging the compiler itself).
20613
20614 @option{-fno-verbose-asm}, the default, causes the
20615 extra information to be omitted and is useful when comparing two assembler
20616 files.
20617
20618 @item -frecord-gcc-switches
20619 @opindex frecord-gcc-switches
20620 This switch causes the command line used to invoke the
20621 compiler to be recorded into the object file that is being created.
20622 This switch is only implemented on some targets and the exact format
20623 of the recording is target and binary file format dependent, but it
20624 usually takes the form of a section containing ASCII text. This
20625 switch is related to the @option{-fverbose-asm} switch, but that
20626 switch only records information in the assembler output file as
20627 comments, so it never reaches the object file.
20628 See also @option{-grecord-gcc-switches} for another
20629 way of storing compiler options into the object file.
20630
20631 @item -fpic
20632 @opindex fpic
20633 @cindex global offset table
20634 @cindex PIC
20635 Generate position-independent code (PIC) suitable for use in a shared
20636 library, if supported for the target machine. Such code accesses all
20637 constant addresses through a global offset table (GOT)@. The dynamic
20638 loader resolves the GOT entries when the program starts (the dynamic
20639 loader is not part of GCC; it is part of the operating system). If
20640 the GOT size for the linked executable exceeds a machine-specific
20641 maximum size, you get an error message from the linker indicating that
20642 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
20643 instead. (These maximums are 8k on the SPARC and 32k
20644 on the m68k and RS/6000. The 386 has no such limit.)
20645
20646 Position-independent code requires special support, and therefore works
20647 only on certain machines. For the 386, GCC supports PIC for System V
20648 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
20649 position-independent.
20650
20651 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20652 are defined to 1.
20653
20654 @item -fPIC
20655 @opindex fPIC
20656 If supported for the target machine, emit position-independent code,
20657 suitable for dynamic linking and avoiding any limit on the size of the
20658 global offset table. This option makes a difference on the m68k,
20659 PowerPC and SPARC@.
20660
20661 Position-independent code requires special support, and therefore works
20662 only on certain machines.
20663
20664 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20665 are defined to 2.
20666
20667 @item -fpie
20668 @itemx -fPIE
20669 @opindex fpie
20670 @opindex fPIE
20671 These options are similar to @option{-fpic} and @option{-fPIC}, but
20672 generated position independent code can be only linked into executables.
20673 Usually these options are used when @option{-pie} GCC option is
20674 used during linking.
20675
20676 @option{-fpie} and @option{-fPIE} both define the macros
20677 @code{__pie__} and @code{__PIE__}. The macros have the value 1
20678 for @option{-fpie} and 2 for @option{-fPIE}.
20679
20680 @item -fno-jump-tables
20681 @opindex fno-jump-tables
20682 Do not use jump tables for switch statements even where it would be
20683 more efficient than other code generation strategies. This option is
20684 of use in conjunction with @option{-fpic} or @option{-fPIC} for
20685 building code that forms part of a dynamic linker and cannot
20686 reference the address of a jump table. On some targets, jump tables
20687 do not require a GOT and this option is not needed.
20688
20689 @item -ffixed-@var{reg}
20690 @opindex ffixed
20691 Treat the register named @var{reg} as a fixed register; generated code
20692 should never refer to it (except perhaps as a stack pointer, frame
20693 pointer or in some other fixed role).
20694
20695 @var{reg} must be the name of a register. The register names accepted
20696 are machine-specific and are defined in the @code{REGISTER_NAMES}
20697 macro in the machine description macro file.
20698
20699 This flag does not have a negative form, because it specifies a
20700 three-way choice.
20701
20702 @item -fcall-used-@var{reg}
20703 @opindex fcall-used
20704 Treat the register named @var{reg} as an allocable register that is
20705 clobbered by function calls. It may be allocated for temporaries or
20706 variables that do not live across a call. Functions compiled this way
20707 do not save and restore the register @var{reg}.
20708
20709 It is an error to use this flag with the frame pointer or stack pointer.
20710 Use of this flag for other registers that have fixed pervasive roles in
20711 the machine's execution model produces disastrous results.
20712
20713 This flag does not have a negative form, because it specifies a
20714 three-way choice.
20715
20716 @item -fcall-saved-@var{reg}
20717 @opindex fcall-saved
20718 Treat the register named @var{reg} as an allocable register saved by
20719 functions. It may be allocated even for temporaries or variables that
20720 live across a call. Functions compiled this way save and restore
20721 the register @var{reg} if they use it.
20722
20723 It is an error to use this flag with the frame pointer or stack pointer.
20724 Use of this flag for other registers that have fixed pervasive roles in
20725 the machine's execution model produces disastrous results.
20726
20727 A different sort of disaster results from the use of this flag for
20728 a register in which function values may be returned.
20729
20730 This flag does not have a negative form, because it specifies a
20731 three-way choice.
20732
20733 @item -fpack-struct[=@var{n}]
20734 @opindex fpack-struct
20735 Without a value specified, pack all structure members together without
20736 holes. When a value is specified (which must be a small power of two), pack
20737 structure members according to this value, representing the maximum
20738 alignment (that is, objects with default alignment requirements larger than
20739 this are output potentially unaligned at the next fitting location.
20740
20741 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
20742 code that is not binary compatible with code generated without that switch.
20743 Additionally, it makes the code suboptimal.
20744 Use it to conform to a non-default application binary interface.
20745
20746 @item -finstrument-functions
20747 @opindex finstrument-functions
20748 Generate instrumentation calls for entry and exit to functions. Just
20749 after function entry and just before function exit, the following
20750 profiling functions are called with the address of the current
20751 function and its call site. (On some platforms,
20752 @code{__builtin_return_address} does not work beyond the current
20753 function, so the call site information may not be available to the
20754 profiling functions otherwise.)
20755
20756 @smallexample
20757 void __cyg_profile_func_enter (void *this_fn,
20758 void *call_site);
20759 void __cyg_profile_func_exit (void *this_fn,
20760 void *call_site);
20761 @end smallexample
20762
20763 The first argument is the address of the start of the current function,
20764 which may be looked up exactly in the symbol table.
20765
20766 This instrumentation is also done for functions expanded inline in other
20767 functions. The profiling calls indicate where, conceptually, the
20768 inline function is entered and exited. This means that addressable
20769 versions of such functions must be available. If all your uses of a
20770 function are expanded inline, this may mean an additional expansion of
20771 code size. If you use @samp{extern inline} in your C code, an
20772 addressable version of such functions must be provided. (This is
20773 normally the case anyway, but if you get lucky and the optimizer always
20774 expands the functions inline, you might have gotten away without
20775 providing static copies.)
20776
20777 A function may be given the attribute @code{no_instrument_function}, in
20778 which case this instrumentation is not done. This can be used, for
20779 example, for the profiling functions listed above, high-priority
20780 interrupt routines, and any functions from which the profiling functions
20781 cannot safely be called (perhaps signal handlers, if the profiling
20782 routines generate output or allocate memory).
20783
20784 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
20785 @opindex finstrument-functions-exclude-file-list
20786
20787 Set the list of functions that are excluded from instrumentation (see
20788 the description of @code{-finstrument-functions}). If the file that
20789 contains a function definition matches with one of @var{file}, then
20790 that function is not instrumented. The match is done on substrings:
20791 if the @var{file} parameter is a substring of the file name, it is
20792 considered to be a match.
20793
20794 For example:
20795
20796 @smallexample
20797 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
20798 @end smallexample
20799
20800 @noindent
20801 excludes any inline function defined in files whose pathnames
20802 contain @code{/bits/stl} or @code{include/sys}.
20803
20804 If, for some reason, you want to include letter @code{','} in one of
20805 @var{sym}, write @code{'\,'}. For example,
20806 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
20807 (note the single quote surrounding the option).
20808
20809 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
20810 @opindex finstrument-functions-exclude-function-list
20811
20812 This is similar to @code{-finstrument-functions-exclude-file-list},
20813 but this option sets the list of function names to be excluded from
20814 instrumentation. The function name to be matched is its user-visible
20815 name, such as @code{vector<int> blah(const vector<int> &)}, not the
20816 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}). The
20817 match is done on substrings: if the @var{sym} parameter is a substring
20818 of the function name, it is considered to be a match. For C99 and C++
20819 extended identifiers, the function name must be given in UTF-8, not
20820 using universal character names.
20821
20822 @item -fstack-check
20823 @opindex fstack-check
20824 Generate code to verify that you do not go beyond the boundary of the
20825 stack. You should specify this flag if you are running in an
20826 environment with multiple threads, but you only rarely need to specify it in
20827 a single-threaded environment since stack overflow is automatically
20828 detected on nearly all systems if there is only one stack.
20829
20830 Note that this switch does not actually cause checking to be done; the
20831 operating system or the language runtime must do that. The switch causes
20832 generation of code to ensure that they see the stack being extended.
20833
20834 You can additionally specify a string parameter: @code{no} means no
20835 checking, @code{generic} means force the use of old-style checking,
20836 @code{specific} means use the best checking method and is equivalent
20837 to bare @option{-fstack-check}.
20838
20839 Old-style checking is a generic mechanism that requires no specific
20840 target support in the compiler but comes with the following drawbacks:
20841
20842 @enumerate
20843 @item
20844 Modified allocation strategy for large objects: they are always
20845 allocated dynamically if their size exceeds a fixed threshold.
20846
20847 @item
20848 Fixed limit on the size of the static frame of functions: when it is
20849 topped by a particular function, stack checking is not reliable and
20850 a warning is issued by the compiler.
20851
20852 @item
20853 Inefficiency: because of both the modified allocation strategy and the
20854 generic implementation, code performance is hampered.
20855 @end enumerate
20856
20857 Note that old-style stack checking is also the fallback method for
20858 @code{specific} if no target support has been added in the compiler.
20859
20860 @item -fstack-limit-register=@var{reg}
20861 @itemx -fstack-limit-symbol=@var{sym}
20862 @itemx -fno-stack-limit
20863 @opindex fstack-limit-register
20864 @opindex fstack-limit-symbol
20865 @opindex fno-stack-limit
20866 Generate code to ensure that the stack does not grow beyond a certain value,
20867 either the value of a register or the address of a symbol. If a larger
20868 stack is required, a signal is raised at run time. For most targets,
20869 the signal is raised before the stack overruns the boundary, so
20870 it is possible to catch the signal without taking special precautions.
20871
20872 For instance, if the stack starts at absolute address @samp{0x80000000}
20873 and grows downwards, you can use the flags
20874 @option{-fstack-limit-symbol=__stack_limit} and
20875 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
20876 of 128KB@. Note that this may only work with the GNU linker.
20877
20878 @item -fsplit-stack
20879 @opindex fsplit-stack
20880 Generate code to automatically split the stack before it overflows.
20881 The resulting program has a discontiguous stack which can only
20882 overflow if the program is unable to allocate any more memory. This
20883 is most useful when running threaded programs, as it is no longer
20884 necessary to calculate a good stack size to use for each thread. This
20885 is currently only implemented for the i386 and x86_64 back ends running
20886 GNU/Linux.
20887
20888 When code compiled with @option{-fsplit-stack} calls code compiled
20889 without @option{-fsplit-stack}, there may not be much stack space
20890 available for the latter code to run. If compiling all code,
20891 including library code, with @option{-fsplit-stack} is not an option,
20892 then the linker can fix up these calls so that the code compiled
20893 without @option{-fsplit-stack} always has a large stack. Support for
20894 this is implemented in the gold linker in GNU binutils release 2.21
20895 and later.
20896
20897 @item -fleading-underscore
20898 @opindex fleading-underscore
20899 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
20900 change the way C symbols are represented in the object file. One use
20901 is to help link with legacy assembly code.
20902
20903 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
20904 generate code that is not binary compatible with code generated without that
20905 switch. Use it to conform to a non-default application binary interface.
20906 Not all targets provide complete support for this switch.
20907
20908 @item -ftls-model=@var{model}
20909 @opindex ftls-model
20910 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
20911 The @var{model} argument should be one of @code{global-dynamic},
20912 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
20913
20914 The default without @option{-fpic} is @code{initial-exec}; with
20915 @option{-fpic} the default is @code{global-dynamic}.
20916
20917 @item -fvisibility=@var{default|internal|hidden|protected}
20918 @opindex fvisibility
20919 Set the default ELF image symbol visibility to the specified option---all
20920 symbols are marked with this unless overridden within the code.
20921 Using this feature can very substantially improve linking and
20922 load times of shared object libraries, produce more optimized
20923 code, provide near-perfect API export and prevent symbol clashes.
20924 It is @strong{strongly} recommended that you use this in any shared objects
20925 you distribute.
20926
20927 Despite the nomenclature, @code{default} always means public; i.e.,
20928 available to be linked against from outside the shared object.
20929 @code{protected} and @code{internal} are pretty useless in real-world
20930 usage so the only other commonly used option is @code{hidden}.
20931 The default if @option{-fvisibility} isn't specified is
20932 @code{default}, i.e., make every
20933 symbol public---this causes the same behavior as previous versions of
20934 GCC@.
20935
20936 A good explanation of the benefits offered by ensuring ELF
20937 symbols have the correct visibility is given by ``How To Write
20938 Shared Libraries'' by Ulrich Drepper (which can be found at
20939 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
20940 solution made possible by this option to marking things hidden when
20941 the default is public is to make the default hidden and mark things
20942 public. This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
20943 and @code{__attribute__ ((visibility("default")))} instead of
20944 @code{__declspec(dllexport)} you get almost identical semantics with
20945 identical syntax. This is a great boon to those working with
20946 cross-platform projects.
20947
20948 For those adding visibility support to existing code, you may find
20949 @samp{#pragma GCC visibility} of use. This works by you enclosing
20950 the declarations you wish to set visibility for with (for example)
20951 @samp{#pragma GCC visibility push(hidden)} and
20952 @samp{#pragma GCC visibility pop}.
20953 Bear in mind that symbol visibility should be viewed @strong{as
20954 part of the API interface contract} and thus all new code should
20955 always specify visibility when it is not the default; i.e., declarations
20956 only for use within the local DSO should @strong{always} be marked explicitly
20957 as hidden as so to avoid PLT indirection overheads---making this
20958 abundantly clear also aids readability and self-documentation of the code.
20959 Note that due to ISO C++ specification requirements, @code{operator new} and
20960 @code{operator delete} must always be of default visibility.
20961
20962 Be aware that headers from outside your project, in particular system
20963 headers and headers from any other library you use, may not be
20964 expecting to be compiled with visibility other than the default. You
20965 may need to explicitly say @samp{#pragma GCC visibility push(default)}
20966 before including any such headers.
20967
20968 @samp{extern} declarations are not affected by @option{-fvisibility}, so
20969 a lot of code can be recompiled with @option{-fvisibility=hidden} with
20970 no modifications. However, this means that calls to @code{extern}
20971 functions with no explicit visibility use the PLT, so it is more
20972 effective to use @code{__attribute ((visibility))} and/or
20973 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
20974 declarations should be treated as hidden.
20975
20976 Note that @option{-fvisibility} does affect C++ vague linkage
20977 entities. This means that, for instance, an exception class that is
20978 be thrown between DSOs must be explicitly marked with default
20979 visibility so that the @samp{type_info} nodes are unified between
20980 the DSOs.
20981
20982 An overview of these techniques, their benefits and how to use them
20983 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
20984
20985 @item -fstrict-volatile-bitfields
20986 @opindex fstrict-volatile-bitfields
20987 This option should be used if accesses to volatile bit-fields (or other
20988 structure fields, although the compiler usually honors those types
20989 anyway) should use a single access of the width of the
20990 field's type, aligned to a natural alignment if possible. For
20991 example, targets with memory-mapped peripheral registers might require
20992 all such accesses to be 16 bits wide; with this flag you can
20993 declare all peripheral bit-fields as @code{unsigned short} (assuming short
20994 is 16 bits on these targets) to force GCC to use 16-bit accesses
20995 instead of, perhaps, a more efficient 32-bit access.
20996
20997 If this option is disabled, the compiler uses the most efficient
20998 instruction. In the previous example, that might be a 32-bit load
20999 instruction, even though that accesses bytes that do not contain
21000 any portion of the bit-field, or memory-mapped registers unrelated to
21001 the one being updated.
21002
21003 If the target requires strict alignment, and honoring the field
21004 type would require violating this alignment, a warning is issued.
21005 If the field has @code{packed} attribute, the access is done without
21006 honoring the field type. If the field doesn't have @code{packed}
21007 attribute, the access is done honoring the field type. In both cases,
21008 GCC assumes that the user knows something about the target hardware
21009 that it is unaware of.
21010
21011 The default value of this option is determined by the application binary
21012 interface for the target processor.
21013
21014 @item -fsync-libcalls
21015 @opindex fsync-libcalls
21016 This option controls whether any out-of-line instance of the @code{__sync}
21017 family of functions may be used to implement the C++11 @code{__atomic}
21018 family of functions.
21019
21020 The default value of this option is enabled, thus the only useful form
21021 of the option is @option{-fno-sync-libcalls}. This option is used in
21022 the implementation of the @file{libatomic} runtime library.
21023
21024 @end table
21025
21026 @c man end
21027
21028 @node Environment Variables
21029 @section Environment Variables Affecting GCC
21030 @cindex environment variables
21031
21032 @c man begin ENVIRONMENT
21033 This section describes several environment variables that affect how GCC
21034 operates. Some of them work by specifying directories or prefixes to use
21035 when searching for various kinds of files. Some are used to specify other
21036 aspects of the compilation environment.
21037
21038 Note that you can also specify places to search using options such as
21039 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
21040 take precedence over places specified using environment variables, which
21041 in turn take precedence over those specified by the configuration of GCC@.
21042 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
21043 GNU Compiler Collection (GCC) Internals}.
21044
21045 @table @env
21046 @item LANG
21047 @itemx LC_CTYPE
21048 @c @itemx LC_COLLATE
21049 @itemx LC_MESSAGES
21050 @c @itemx LC_MONETARY
21051 @c @itemx LC_NUMERIC
21052 @c @itemx LC_TIME
21053 @itemx LC_ALL
21054 @findex LANG
21055 @findex LC_CTYPE
21056 @c @findex LC_COLLATE
21057 @findex LC_MESSAGES
21058 @c @findex LC_MONETARY
21059 @c @findex LC_NUMERIC
21060 @c @findex LC_TIME
21061 @findex LC_ALL
21062 @cindex locale
21063 These environment variables control the way that GCC uses
21064 localization information which allows GCC to work with different
21065 national conventions. GCC inspects the locale categories
21066 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
21067 so. These locale categories can be set to any value supported by your
21068 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
21069 Kingdom encoded in UTF-8.
21070
21071 The @env{LC_CTYPE} environment variable specifies character
21072 classification. GCC uses it to determine the character boundaries in
21073 a string; this is needed for some multibyte encodings that contain quote
21074 and escape characters that are otherwise interpreted as a string
21075 end or escape.
21076
21077 The @env{LC_MESSAGES} environment variable specifies the language to
21078 use in diagnostic messages.
21079
21080 If the @env{LC_ALL} environment variable is set, it overrides the value
21081 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
21082 and @env{LC_MESSAGES} default to the value of the @env{LANG}
21083 environment variable. If none of these variables are set, GCC
21084 defaults to traditional C English behavior.
21085
21086 @item TMPDIR
21087 @findex TMPDIR
21088 If @env{TMPDIR} is set, it specifies the directory to use for temporary
21089 files. GCC uses temporary files to hold the output of one stage of
21090 compilation which is to be used as input to the next stage: for example,
21091 the output of the preprocessor, which is the input to the compiler
21092 proper.
21093
21094 @item GCC_COMPARE_DEBUG
21095 @findex GCC_COMPARE_DEBUG
21096 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
21097 @option{-fcompare-debug} to the compiler driver. See the documentation
21098 of this option for more details.
21099
21100 @item GCC_EXEC_PREFIX
21101 @findex GCC_EXEC_PREFIX
21102 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
21103 names of the subprograms executed by the compiler. No slash is added
21104 when this prefix is combined with the name of a subprogram, but you can
21105 specify a prefix that ends with a slash if you wish.
21106
21107 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
21108 an appropriate prefix to use based on the pathname it is invoked with.
21109
21110 If GCC cannot find the subprogram using the specified prefix, it
21111 tries looking in the usual places for the subprogram.
21112
21113 The default value of @env{GCC_EXEC_PREFIX} is
21114 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
21115 the installed compiler. In many cases @var{prefix} is the value
21116 of @code{prefix} when you ran the @file{configure} script.
21117
21118 Other prefixes specified with @option{-B} take precedence over this prefix.
21119
21120 This prefix is also used for finding files such as @file{crt0.o} that are
21121 used for linking.
21122
21123 In addition, the prefix is used in an unusual way in finding the
21124 directories to search for header files. For each of the standard
21125 directories whose name normally begins with @samp{/usr/local/lib/gcc}
21126 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
21127 replacing that beginning with the specified prefix to produce an
21128 alternate directory name. Thus, with @option{-Bfoo/}, GCC searches
21129 @file{foo/bar} just before it searches the standard directory
21130 @file{/usr/local/lib/bar}.
21131 If a standard directory begins with the configured
21132 @var{prefix} then the value of @var{prefix} is replaced by
21133 @env{GCC_EXEC_PREFIX} when looking for header files.
21134
21135 @item COMPILER_PATH
21136 @findex COMPILER_PATH
21137 The value of @env{COMPILER_PATH} is a colon-separated list of
21138 directories, much like @env{PATH}. GCC tries the directories thus
21139 specified when searching for subprograms, if it can't find the
21140 subprograms using @env{GCC_EXEC_PREFIX}.
21141
21142 @item LIBRARY_PATH
21143 @findex LIBRARY_PATH
21144 The value of @env{LIBRARY_PATH} is a colon-separated list of
21145 directories, much like @env{PATH}. When configured as a native compiler,
21146 GCC tries the directories thus specified when searching for special
21147 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
21148 using GCC also uses these directories when searching for ordinary
21149 libraries for the @option{-l} option (but directories specified with
21150 @option{-L} come first).
21151
21152 @item LANG
21153 @findex LANG
21154 @cindex locale definition
21155 This variable is used to pass locale information to the compiler. One way in
21156 which this information is used is to determine the character set to be used
21157 when character literals, string literals and comments are parsed in C and C++.
21158 When the compiler is configured to allow multibyte characters,
21159 the following values for @env{LANG} are recognized:
21160
21161 @table @samp
21162 @item C-JIS
21163 Recognize JIS characters.
21164 @item C-SJIS
21165 Recognize SJIS characters.
21166 @item C-EUCJP
21167 Recognize EUCJP characters.
21168 @end table
21169
21170 If @env{LANG} is not defined, or if it has some other value, then the
21171 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
21172 recognize and translate multibyte characters.
21173 @end table
21174
21175 @noindent
21176 Some additional environment variables affect the behavior of the
21177 preprocessor.
21178
21179 @include cppenv.texi
21180
21181 @c man end
21182
21183 @node Precompiled Headers
21184 @section Using Precompiled Headers
21185 @cindex precompiled headers
21186 @cindex speed of compilation
21187
21188 Often large projects have many header files that are included in every
21189 source file. The time the compiler takes to process these header files
21190 over and over again can account for nearly all of the time required to
21191 build the project. To make builds faster, GCC allows you to
21192 @dfn{precompile} a header file.
21193
21194 To create a precompiled header file, simply compile it as you would any
21195 other file, if necessary using the @option{-x} option to make the driver
21196 treat it as a C or C++ header file. You may want to use a
21197 tool like @command{make} to keep the precompiled header up-to-date when
21198 the headers it contains change.
21199
21200 A precompiled header file is searched for when @code{#include} is
21201 seen in the compilation. As it searches for the included file
21202 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
21203 compiler looks for a precompiled header in each directory just before it
21204 looks for the include file in that directory. The name searched for is
21205 the name specified in the @code{#include} with @samp{.gch} appended. If
21206 the precompiled header file can't be used, it is ignored.
21207
21208 For instance, if you have @code{#include "all.h"}, and you have
21209 @file{all.h.gch} in the same directory as @file{all.h}, then the
21210 precompiled header file is used if possible, and the original
21211 header is used otherwise.
21212
21213 Alternatively, you might decide to put the precompiled header file in a
21214 directory and use @option{-I} to ensure that directory is searched
21215 before (or instead of) the directory containing the original header.
21216 Then, if you want to check that the precompiled header file is always
21217 used, you can put a file of the same name as the original header in this
21218 directory containing an @code{#error} command.
21219
21220 This also works with @option{-include}. So yet another way to use
21221 precompiled headers, good for projects not designed with precompiled
21222 header files in mind, is to simply take most of the header files used by
21223 a project, include them from another header file, precompile that header
21224 file, and @option{-include} the precompiled header. If the header files
21225 have guards against multiple inclusion, they are skipped because
21226 they've already been included (in the precompiled header).
21227
21228 If you need to precompile the same header file for different
21229 languages, targets, or compiler options, you can instead make a
21230 @emph{directory} named like @file{all.h.gch}, and put each precompiled
21231 header in the directory, perhaps using @option{-o}. It doesn't matter
21232 what you call the files in the directory; every precompiled header in
21233 the directory is considered. The first precompiled header
21234 encountered in the directory that is valid for this compilation is
21235 used; they're searched in no particular order.
21236
21237 There are many other possibilities, limited only by your imagination,
21238 good sense, and the constraints of your build system.
21239
21240 A precompiled header file can be used only when these conditions apply:
21241
21242 @itemize
21243 @item
21244 Only one precompiled header can be used in a particular compilation.
21245
21246 @item
21247 A precompiled header can't be used once the first C token is seen. You
21248 can have preprocessor directives before a precompiled header; you cannot
21249 include a precompiled header from inside another header.
21250
21251 @item
21252 The precompiled header file must be produced for the same language as
21253 the current compilation. You can't use a C precompiled header for a C++
21254 compilation.
21255
21256 @item
21257 The precompiled header file must have been produced by the same compiler
21258 binary as the current compilation is using.
21259
21260 @item
21261 Any macros defined before the precompiled header is included must
21262 either be defined in the same way as when the precompiled header was
21263 generated, or must not affect the precompiled header, which usually
21264 means that they don't appear in the precompiled header at all.
21265
21266 The @option{-D} option is one way to define a macro before a
21267 precompiled header is included; using a @code{#define} can also do it.
21268 There are also some options that define macros implicitly, like
21269 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
21270 defined this way.
21271
21272 @item If debugging information is output when using the precompiled
21273 header, using @option{-g} or similar, the same kind of debugging information
21274 must have been output when building the precompiled header. However,
21275 a precompiled header built using @option{-g} can be used in a compilation
21276 when no debugging information is being output.
21277
21278 @item The same @option{-m} options must generally be used when building
21279 and using the precompiled header. @xref{Submodel Options},
21280 for any cases where this rule is relaxed.
21281
21282 @item Each of the following options must be the same when building and using
21283 the precompiled header:
21284
21285 @gccoptlist{-fexceptions}
21286
21287 @item
21288 Some other command-line options starting with @option{-f},
21289 @option{-p}, or @option{-O} must be defined in the same way as when
21290 the precompiled header was generated. At present, it's not clear
21291 which options are safe to change and which are not; the safest choice
21292 is to use exactly the same options when generating and using the
21293 precompiled header. The following are known to be safe:
21294
21295 @gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock @gol
21296 -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous @gol
21297 -fsched-verbose=@var{number} -fschedule-insns -fvisibility= @gol
21298 -pedantic-errors}
21299
21300 @end itemize
21301
21302 For all of these except the last, the compiler automatically
21303 ignores the precompiled header if the conditions aren't met. If you
21304 find an option combination that doesn't work and doesn't cause the
21305 precompiled header to be ignored, please consider filing a bug report,
21306 see @ref{Bugs}.
21307
21308 If you do use differing options when generating and using the
21309 precompiled header, the actual behavior is a mixture of the
21310 behavior for the options. For instance, if you use @option{-g} to
21311 generate the precompiled header but not when using it, you may or may
21312 not get debugging information for routines in the precompiled header.